lib: Add boot_status type & protocol definitions
[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_DEVICE_ADD           = 0x1,
16         PB_PROTOCOL_ACTION_BOOT_OPTION_ADD      = 0x2,
17         PB_PROTOCOL_ACTION_DEVICE_REMOVE        = 0x3,
18 /*      PB_PROTOCOL_ACTION_BOOT_OPTION_REMOVE   = 0x4, */
19         PB_PROTOCOL_ACTION_BOOT                 = 0x5,
20         PB_PROTOCOL_ACTION_STATUS               = 0x6,
21 };
22
23 struct pb_protocol_message {
24         uint32_t action;
25         uint32_t payload_len;
26         char     payload[];
27 };
28
29 void pb_protocol_dump_device(const struct device *dev, const char *text,
30         FILE *stream);
31 int pb_protocol_device_len(const struct device *dev);
32 int pb_protocol_boot_option_len(const struct boot_option *opt);
33 int pb_protocol_boot_len(const struct boot_command *boot);
34 int pb_protocol_device_cmp(const struct device *a, const struct device *b);
35
36 int pb_protocol_boot_option_cmp(const struct boot_option *a,
37         const struct boot_option *b);
38
39 int pb_protocol_serialise_string(char *pos, const char *str);
40 char *pb_protocol_deserialise_string(void *ctx,
41                 const struct pb_protocol_message *message);
42
43 int pb_protocol_serialise_device(const struct device *dev,
44                 char *buf, int buf_len);
45 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
46                 char *buf, int buf_len);
47 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
48                 char *buf, int buf_len);
49
50 int pb_protocol_write_message(int fd, struct pb_protocol_message *message);
51
52 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
53                 enum pb_protocol_action action, int payload_len);
54
55 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd);
56
57 int pb_protocol_deserialise_device(struct device *dev,
58                 const struct pb_protocol_message *message);
59
60 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
61                 const struct pb_protocol_message *message);
62
63 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
64                 const struct pb_protocol_message *message);
65
66 #endif /* _PB_PROTOCOL_H */