ed1f504c4e59904ecbcd9d8ac5685b7b7b757e44
[petitboot] / ui / common / discover-client.h
1 #ifndef _DISCOVER_CLIENT_H
2 #define _DISCOVER_CLIENT_H
3
4 #include <types/types.h>
5 #include <waiter/waiter.h>
6
7 struct discover_client;
8
9 struct pb_boot_data {
10         char *image;
11         char *initrd;
12         char *dtb;
13         char *args;
14 };
15
16 /**
17  * struct discover_client_ops - Application supplied client info.
18  * @device_add: PB_PROTOCOL_ACTION_ADD event callback.
19  * @device_remove: PB_PROTOCOL_ACTION_REMOVE event callback.
20  * @cb_arg: Client managed convenience variable passed to callbacks.
21  */
22
23 struct discover_client_ops {
24         int (*device_add)(struct device *device, void *arg);
25         int (*boot_option_add)(struct device *dev, struct boot_option *option,
26                         void *arg);
27         void (*device_remove)(struct device *device, void *arg);
28         void (*update_status)(struct boot_status *status, void *arg);
29         void *cb_arg;
30 };
31
32 struct discover_client *discover_client_init(struct waitset *waitset,
33         const struct discover_client_ops *ops, void *cb_arg);
34
35 void discover_client_destroy(struct discover_client *client);
36
37 /**
38  * Get the number of devices that the discover client has stored. This
39  * is the set of devices that have been added and not removed
40  *
41  * @param client The discover client
42  * @return       The number of devices that have been added.
43  */
44 int discover_client_device_count(struct discover_client *client);
45
46 /**
47  * Get the device at a specific index.
48  * @param client A pointer to the discover client
49  * @param index  The index of the device to retrieve
50  * @return       The device at the specified index, or NULL if none exists
51  */
52 struct device *discover_client_get_device(struct discover_client *client,
53                 int index);
54
55 /* Tell the discover server to boot an image
56  * @param client A pointer to the discover client
57  * @param boot_command The command to boot
58  */
59 int discover_client_boot(struct discover_client *client,
60                 const struct device *device,
61                 const struct boot_option *boot_option,
62                 const struct pb_boot_data *data);
63
64 /* Tell the discover server to cancel the default boot option, if any
65  */
66 int discover_client_cancel_default(struct discover_client *client);
67 #endif