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