lib/pb-protocol: Add serialise & deserialise for struct config
[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         PB_PROTOCOL_ACTION_CANCEL_DEFAULT       = 0x7,
22         PB_PROTOCOL_ACTION_SYSTEM_INFO          = 0x8,
23         PB_PROTOCOL_ACTION_CONFIG               = 0x9,
24 };
25
26 struct pb_protocol_message {
27         uint32_t action;
28         uint32_t payload_len;
29         char     payload[];
30 };
31
32 void pb_protocol_dump_device(const struct device *dev, const char *text,
33         FILE *stream);
34 int pb_protocol_device_len(const struct device *dev);
35 int pb_protocol_boot_option_len(const struct boot_option *opt);
36 int pb_protocol_boot_len(const struct boot_command *boot);
37 int pb_protocol_boot_status_len(const struct boot_status *status);
38 int pb_protocol_system_info_len(const struct system_info *sysinfo);
39 int pb_protocol_config_len(const struct config *config);
40 int pb_protocol_device_cmp(const struct device *a, const struct device *b);
41
42 int pb_protocol_boot_option_cmp(const struct boot_option *a,
43         const struct boot_option *b);
44
45 int pb_protocol_serialise_string(char *pos, const char *str);
46 char *pb_protocol_deserialise_string(void *ctx,
47                 const struct pb_protocol_message *message);
48
49 int pb_protocol_serialise_device(const struct device *dev,
50                 char *buf, int buf_len);
51 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
52                 char *buf, int buf_len);
53 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
54                 char *buf, int buf_len);
55 int pb_protocol_serialise_boot_status(const struct boot_status *status,
56                 char *buf, int buf_len);
57 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
58                 char *buf, int buf_len);
59 int pb_protocol_serialise_config(const struct config *config,
60                 char *buf, int buf_len);
61
62 int pb_protocol_write_message(int fd, struct pb_protocol_message *message);
63
64 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
65                 enum pb_protocol_action action, int payload_len);
66
67 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd);
68
69 int pb_protocol_deserialise_device(struct device *dev,
70                 const struct pb_protocol_message *message);
71
72 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
73                 const struct pb_protocol_message *message);
74
75 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
76                 const struct pb_protocol_message *message);
77
78 int pb_protocol_deserialise_boot_status(struct boot_status *status,
79                 const struct pb_protocol_message *message);
80
81 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
82                 const struct pb_protocol_message *message);
83
84 int pb_protocol_deserialise_config(struct config *config,
85                 const struct pb_protocol_message *message);
86 #endif /* _PB_PROTOCOL_H */