protocol: Add definition and serialisation for temporary autoboot
[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         PB_PROTOCOL_ACTION_REINIT               = 0xa,
25         PB_PROTOCOL_ACTION_ADD_URL              = 0xb,
26         PB_PROTOCOL_ACTION_PLUGIN_OPTION_ADD    = 0xc,
27         PB_PROTOCOL_ACTION_PLUGINS_REMOVE       = 0xd,
28         PB_PROTOCOL_ACTION_PLUGIN_INSTALL       = 0xe,
29         PB_PROTOCOL_ACTION_TEMP_AUTOBOOT        = 0xf,
30 };
31
32 struct pb_protocol_message {
33         uint32_t action;
34         uint32_t payload_len;
35         char     payload[];
36 };
37
38 void pb_protocol_dump_device(const struct device *dev, const char *text,
39         FILE *stream);
40 int pb_protocol_device_len(const struct device *dev);
41 int pb_protocol_boot_option_len(const struct boot_option *opt);
42 int pb_protocol_boot_len(const struct boot_command *boot);
43 int pb_protocol_boot_status_len(const struct status *status);
44 int pb_protocol_system_info_len(const struct system_info *sysinfo);
45 int pb_protocol_config_len(const struct config *config);
46 int pb_protocol_url_len(const char *url);
47 int pb_protocol_plugin_option_len(const struct plugin_option *opt);
48 int pb_protocol_temp_autoboot_len(const struct autoboot_option *opt);
49 int pb_protocol_device_cmp(const struct device *a, const struct device *b);
50
51 int pb_protocol_boot_option_cmp(const struct boot_option *a,
52         const struct boot_option *b);
53
54 int pb_protocol_serialise_string(char *pos, const char *str);
55 char *pb_protocol_deserialise_string(void *ctx,
56                 const struct pb_protocol_message *message);
57
58 int pb_protocol_serialise_device(const struct device *dev,
59                 char *buf, int buf_len);
60 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
61                 char *buf, int buf_len);
62 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
63                 char *buf, int buf_len);
64 int pb_protocol_serialise_boot_status(const struct status *status,
65                 char *buf, int buf_len);
66 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
67                 char *buf, int buf_len);
68 int pb_protocol_serialise_config(const struct config *config,
69                 char *buf, int buf_len);
70 int pb_protocol_serialise_url(const char *url, char *buf, int buf_len);
71 int pb_protocol_serialise_plugin_option(const struct plugin_option *opt,
72                 char *buf, int buf_len);
73 int pb_protocol_serialise_temp_autoboot(const struct autoboot_option *opt,
74                 char *buf, int buf_len);
75
76 int pb_protocol_write_message(int fd, struct pb_protocol_message *message);
77
78 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
79                 enum pb_protocol_action action, int payload_len);
80
81 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd);
82
83 int pb_protocol_deserialise_device(struct device *dev,
84                 const struct pb_protocol_message *message);
85
86 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
87                 const struct pb_protocol_message *message);
88
89 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
90                 const struct pb_protocol_message *message);
91
92 int pb_protocol_deserialise_boot_status(struct status *status,
93                 const struct pb_protocol_message *message);
94
95 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
96                 const struct pb_protocol_message *message);
97
98 int pb_protocol_deserialise_config(struct config *config,
99                 const struct pb_protocol_message *message);
100
101 int pb_protocol_deserialise_plugin_option(struct plugin_option *opt,
102                 const struct pb_protocol_message *message);
103 int pb_protocol_deserialise_temp_autoboot(struct autoboot_option *opt,
104                 const struct pb_protocol_message *message);
105 #endif /* _PB_PROTOCOL_H */