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#ifndef _XEN_XENBUS_H
35#define _XEN_XENBUS_H
36
37#include <linux/device.h>
38#include <linux/notifier.h>
39#include <linux/mutex.h>
40#include <linux/completion.h>
41#include <linux/init.h>
42#include <linux/slab.h>
43#include <xen/interface/xen.h>
44#include <xen/interface/grant_table.h>
45#include <xen/interface/io/xenbus.h>
46#include <xen/interface/io/xs_wire.h>
47
48
49struct xenbus_watch
50{
51 struct list_head list;
52
53
54 const char *node;
55
56
57 void (*callback)(struct xenbus_watch *,
58 const char **vec, unsigned int len);
59};
60
61
62
63struct xenbus_device {
64 const char *devicetype;
65 const char *nodename;
66 const char *otherend;
67 int otherend_id;
68 struct xenbus_watch otherend_watch;
69 struct device dev;
70 enum xenbus_state state;
71 struct completion down;
72};
73
74static inline struct xenbus_device *to_xenbus_device(struct device *dev)
75{
76 return container_of(dev, struct xenbus_device, dev);
77}
78
79struct xenbus_device_id
80{
81
82 char devicetype[32];
83};
84
85
86struct xenbus_driver {
87 char *name;
88 struct module *owner;
89 const struct xenbus_device_id *ids;
90 int (*probe)(struct xenbus_device *dev,
91 const struct xenbus_device_id *id);
92 void (*otherend_changed)(struct xenbus_device *dev,
93 enum xenbus_state backend_state);
94 int (*remove)(struct xenbus_device *dev);
95 int (*suspend)(struct xenbus_device *dev);
96 int (*resume)(struct xenbus_device *dev);
97 int (*uevent)(struct xenbus_device *, struct kobj_uevent_env *);
98 struct device_driver driver;
99 int (*read_otherend_details)(struct xenbus_device *dev);
100 int (*is_ready)(struct xenbus_device *dev);
101};
102
103static inline struct xenbus_driver *to_xenbus_driver(struct device_driver *drv)
104{
105 return container_of(drv, struct xenbus_driver, driver);
106}
107
108int __must_check __xenbus_register_frontend(struct xenbus_driver *drv,
109 struct module *owner,
110 const char *mod_name);
111
112static inline int __must_check
113xenbus_register_frontend(struct xenbus_driver *drv)
114{
115 WARN_ON(drv->owner != THIS_MODULE);
116 return __xenbus_register_frontend(drv, THIS_MODULE, KBUILD_MODNAME);
117}
118
119int __must_check __xenbus_register_backend(struct xenbus_driver *drv,
120 struct module *owner,
121 const char *mod_name);
122static inline int __must_check
123xenbus_register_backend(struct xenbus_driver *drv)
124{
125 WARN_ON(drv->owner != THIS_MODULE);
126 return __xenbus_register_backend(drv, THIS_MODULE, KBUILD_MODNAME);
127}
128
129void xenbus_unregister_driver(struct xenbus_driver *drv);
130
131struct xenbus_transaction
132{
133 u32 id;
134};
135
136
137#define XBT_NIL ((struct xenbus_transaction) { 0 })
138
139char **xenbus_directory(struct xenbus_transaction t,
140 const char *dir, const char *node, unsigned int *num);
141void *xenbus_read(struct xenbus_transaction t,
142 const char *dir, const char *node, unsigned int *len);
143int xenbus_write(struct xenbus_transaction t,
144 const char *dir, const char *node, const char *string);
145int xenbus_mkdir(struct xenbus_transaction t,
146 const char *dir, const char *node);
147int xenbus_exists(struct xenbus_transaction t,
148 const char *dir, const char *node);
149int xenbus_rm(struct xenbus_transaction t, const char *dir, const char *node);
150int xenbus_transaction_start(struct xenbus_transaction *t);
151int xenbus_transaction_end(struct xenbus_transaction t, int abort);
152
153
154int xenbus_scanf(struct xenbus_transaction t,
155 const char *dir, const char *node, const char *fmt, ...)
156 __attribute__((format(scanf, 4, 5)));
157
158
159int xenbus_printf(struct xenbus_transaction t,
160 const char *dir, const char *node, const char *fmt, ...)
161 __attribute__((format(printf, 4, 5)));
162
163
164
165int xenbus_gather(struct xenbus_transaction t, const char *dir, ...);
166
167
168extern int xenstored_ready;
169int register_xenstore_notifier(struct notifier_block *nb);
170void unregister_xenstore_notifier(struct notifier_block *nb);
171
172int register_xenbus_watch(struct xenbus_watch *watch);
173void unregister_xenbus_watch(struct xenbus_watch *watch);
174void xs_suspend(void);
175void xs_resume(void);
176void xs_suspend_cancel(void);
177
178
179void *xenbus_dev_request_and_reply(struct xsd_sockmsg *msg);
180
181struct work_struct;
182
183
184void xenbus_suspend(void);
185void xenbus_resume(void);
186void xenbus_probe(struct work_struct *);
187void xenbus_suspend_cancel(void);
188
189#define XENBUS_IS_ERR_READ(str) ({ \
190 if (!IS_ERR(str) && strlen(str) == 0) { \
191 kfree(str); \
192 str = ERR_PTR(-ERANGE); \
193 } \
194 IS_ERR(str); \
195})
196
197#define XENBUS_EXIST_ERR(err) ((err) == -ENOENT || (err) == -ERANGE)
198
199int xenbus_watch_path(struct xenbus_device *dev, const char *path,
200 struct xenbus_watch *watch,
201 void (*callback)(struct xenbus_watch *,
202 const char **, unsigned int));
203int xenbus_watch_pathfmt(struct xenbus_device *dev, struct xenbus_watch *watch,
204 void (*callback)(struct xenbus_watch *,
205 const char **, unsigned int),
206 const char *pathfmt, ...)
207 __attribute__ ((format (printf, 4, 5)));
208
209int xenbus_switch_state(struct xenbus_device *dev, enum xenbus_state new_state);
210int xenbus_grant_ring(struct xenbus_device *dev, unsigned long ring_mfn);
211int xenbus_map_ring_valloc(struct xenbus_device *dev,
212 int gnt_ref, void **vaddr);
213int xenbus_map_ring(struct xenbus_device *dev, int gnt_ref,
214 grant_handle_t *handle, void *vaddr);
215
216int xenbus_unmap_ring_vfree(struct xenbus_device *dev, void *vaddr);
217int xenbus_unmap_ring(struct xenbus_device *dev,
218 grant_handle_t handle, void *vaddr);
219
220int xenbus_alloc_evtchn(struct xenbus_device *dev, int *port);
221int xenbus_bind_evtchn(struct xenbus_device *dev, int remote_port, int *port);
222int xenbus_free_evtchn(struct xenbus_device *dev, int port);
223
224enum xenbus_state xenbus_read_driver_state(const char *path);
225
226__attribute__((format(printf, 3, 4)))
227void xenbus_dev_error(struct xenbus_device *dev, int err, const char *fmt, ...);
228__attribute__((format(printf, 3, 4)))
229void xenbus_dev_fatal(struct xenbus_device *dev, int err, const char *fmt, ...);
230
231const char *xenbus_strstate(enum xenbus_state state);
232int xenbus_dev_is_online(struct xenbus_device *dev);
233int xenbus_frontend_closed(struct xenbus_device *dev);
234
235#endif
236