Add boot command structure to petitboot protocol description
[petitboot] / lib / pb-protocol / pb-protocol.h
1 #ifndef _PB_PROTOCOL_H
2 #define _PB_PROTOCOL_H
3
4 #include <stdint.h>
5 #include <stdio.h>
6
7 #include <list/list.h>
8 #include <types/types.h>
9
10 #define PB_SOCKET_PATH "/tmp/petitboot.ui"
11
12 #define PB_PROTOCOL_MAX_PAYLOAD_SIZE (64 * 1024)
13
14 enum pb_protocol_action {
15         PB_PROTOCOL_ACTION_ADD          = 0x1,
16         PB_PROTOCOL_ACTION_REMOVE       = 0x2,
17         PB_PROTOCOL_ACTION_BOOT         = 0x3,
18 };
19
20 struct pb_protocol_message {
21         uint32_t action;
22         uint32_t payload_len;
23         char     payload[];
24 };
25
26 void pb_protocol_dump_device(const struct device *dev, const char *text,
27         FILE *stream);
28 int pb_protocol_device_len(const struct device *dev);
29 int pb_protocol_device_cmp(const struct device *a, const struct device *b);
30
31 int pb_protocol_boot_option_cmp(const struct boot_option *a,
32         const struct boot_option *b);
33
34 int pb_protocol_serialise_string(char *pos, const char *str);
35 char *pb_protocol_deserialise_string(void *ctx,
36                 const struct pb_protocol_message *message);
37
38 int pb_protocol_serialise_device(const struct device *dev, char *buf, int buf_len);
39
40 int pb_protocol_write_message(int fd, struct pb_protocol_message *message);
41
42 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
43                 enum pb_protocol_action action, int payload_len);
44
45 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd);
46
47 struct device *pb_protocol_deserialise_device(void *ctx,
48                 const struct pb_protocol_message *message);
49
50 #endif /* _PB_PROTOCOL_H */