ui/ncurses: Reset console options on boot

[petitboot] / ui / common / discover-client.h

diff --git a/ui/common/discover-client.h b/ui/common/discover-client.h
index bc2294aa20b84d557558a25335bca1a9abaf9eb7..2a2ea288f4c9842049da09318bf8213b39a8d808 100644 (file)
--- a/ui/common/discover-client.h
+++ b/ui/common/discover-client.h
@@ -1,36 +1,109 @@
 #ifndef _DISCOVER_CLIENT_H
 #define _DISCOVER_CLIENT_H
 
-#include <pb-protocol/pb-protocol.h>
+#include <types/types.h>
+#include <waiter/waiter.h>
 
 struct discover_client;
 
+struct pb_boot_data {
+       char *image;
+       char *initrd;
+       char *dtb;
+       char *args;
+       char *args_sig_file;
+};
+
+struct pb_plugin_data {
+       char *plugin_file;
+       struct plugin_option *opt;
+};
+
 /**
  * struct discover_client_ops - Application supplied client info.
- * @add_device: PB_PROTOCOL_ACTION_ADD event callback.
- * @remove_device: PB_PROTOCOL_ACTION_REMOVE event callback.
+ * @device_add: PB_PROTOCOL_ACTION_ADD event callback.
+ * @device_remove: PB_PROTOCOL_ACTION_REMOVE event callback.
  * @cb_arg: Client managed convenience variable passed to callbacks.
+ *
+ * The discover client holds talloc references to the devices (and the
+ * devices' boot options), so callbacks may store boot options and devices
+ * as long as the client remains allocated.
+ *
+ * The status and system_info structs are allocated by the client,
+ * and will be free()ed after the callback is invoked. If the callback
+ * stores these structures for usage beyond the duration of the callback,
+ * it must talloc_steal() them.
  */
 
 struct discover_client_ops {
-       int (*add_device)(struct device *device, void *arg);
-       void (*remove_device)(char *dev_id, void *arg);
+       int (*device_add)(struct device *device, void *arg);
+       int (*boot_option_add)(struct device *dev, struct boot_option *option,
+                       void *arg);
+       void (*device_remove)(struct device *device, void *arg);
+       int (*plugin_option_add)(struct plugin_option *option, void *arg);
+       int (*plugins_remove)(void *arg);
+       void (*update_status)(struct status *status, void *arg);
+       void (*update_sysinfo)(struct system_info *sysinfo, void *arg);
+       void (*update_config)(struct config *sysinfo, void *arg);
        void *cb_arg;
 };
 
-struct discover_client *discover_client_init(struct discover_client_ops *ops);
-
-int discover_client_get_fd(struct discover_client *client);
+struct discover_client *discover_client_init(struct waitset *waitset,
+       const struct discover_client_ops *ops, void *cb_arg);
 
 void discover_client_destroy(struct discover_client *client);
 
 /**
- * Process data from the server.
+ * Get the number of devices that the discover client has stored. This
+ * is the set of devices that have been added and not removed
  *
- * Will read from the client socket, and call add_device on any discovered
- * devices.
- * 
+ * @param client The discover client
+ * @return      The number of devices that have been added.
+ */
+int discover_client_device_count(struct discover_client *client);
+
+/**
+ * Get the device at a specific index.
+ * @param client A pointer to the discover client
+ * @param index  The index of the device to retrieve
+ * @return      The device at the specified index, or NULL if none exists
  */
-int discover_client_process(struct discover_client *client);
+struct device *discover_client_get_device(struct discover_client *client,
+               int index);
+
+/* Tell the discover server to boot an image
+ * @param client A pointer to the discover client
+ * @param boot_command The command to boot
+ */
+int discover_client_boot(struct discover_client *client,
+               const struct device *device,
+               const struct boot_option *boot_option,
+               const struct pb_boot_data *data);
+
+/* Tell the discover server to cancel the default boot option, if any
+ */
+int discover_client_cancel_default(struct discover_client *client);
+
+/* Tell the discover server to reinitialise */
+int discover_client_send_reinit(struct discover_client *client);
+
+/* Send new configuration data to the discover server */
+int discover_client_send_config(struct discover_client *client,
+               struct config *config);
+
+/* Re-enumerate the collected devices & boot options, calling ops->device_add
+ * and ops->boot_option_add on each.
+ */
+void discover_client_enumerate(struct discover_client *client);
+
+/* Send url to config to the discover server */
+int discover_client_send_url(struct discover_client *client, char *url);
+/* Send plugin file path to discover server to install */
+int discover_client_send_plugin_install(struct discover_client *client,
+               char *file);
+
+/* send a temporary autoboot override */
+int discover_client_send_temp_autoboot(struct discover_client *client,
+               const struct autoboot_option *opt);
 
 #endif