summaryrefslogtreecommitdiffstats
path: root/ui/common/discover-client.h
blob: 542a275bbc6230095cd93c1122125f2ae7dca085 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#ifndef _DISCOVER_CLIENT_H
#define _DISCOVER_CLIENT_H

#include <types/types.h>
#include <waiter/waiter.h>

struct discover_client;

struct pb_boot_data {
	char *image;
	char *initrd;
	char *dtb;
	char *args;
};

/**
 * struct discover_client_ops - Application supplied client info.
 * @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 boot_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 (*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);
	void (*update_status)(struct boot_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 waitset *waitset,
	const struct discover_client_ops *ops, void *cb_arg);

void discover_client_destroy(struct discover_client *client);

/**
 * Get the number of devices that the discover client has stored. This
 * is the set of devices that have been added and not removed
 *
 * @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
 */
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);

#endif
OpenPOWER on IntegriCloud