[mirror_ubuntu-zesty-kernel.git] / include / xen / xenbus.h

/******************************************************************************
 * xenbus.h
 *
 * Talks to Xen Store to figure out what devices we have.
 *
 * Copyright (C) 2005 Rusty Russell, IBM Corporation
 * Copyright (C) 2005 XenSource Ltd.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation; or, when distributed
 * separately from the Linux kernel or incorporated into other
 * software packages, subject to the following license:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this source file (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef _XEN_XENBUS_H
#define _XEN_XENBUS_H

#include <linux/device.h>
#include <linux/notifier.h>
#include <linux/mutex.h>
#include <linux/export.h>
#include <linux/completion.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <xen/interface/xen.h>
#include <xen/interface/grant_table.h>
#include <xen/interface/io/xenbus.h>
#include <xen/interface/io/xs_wire.h>

#define XENBUS_MAX_RING_GRANT_ORDER 4
#define XENBUS_MAX_RING_GRANTS      (1U << XENBUS_MAX_RING_GRANT_ORDER)
#define INVALID_GRANT_HANDLE       (~0U)

/* Register callback to watch this node. */
struct xenbus_watch
{
	struct list_head list;

	/* Path being watched. */
	const char *node;

	/* Callback (executed in a process context with no locks held). */
	void (*callback)(struct xenbus_watch *,
			 const char **vec, unsigned int len);
};


/* A xenbus device. */
struct xenbus_device {
	const char *devicetype;
	const char *nodename;
	const char *otherend;
	int otherend_id;
	struct xenbus_watch otherend_watch;
	struct device dev;
	enum xenbus_state state;
	struct completion down;
	struct work_struct work;
};

static inline struct xenbus_device *to_xenbus_device(struct device *dev)
{
	return container_of(dev, struct xenbus_device, dev);
}

struct xenbus_device_id
{
	/* .../device/<device_type>/<identifier> */
	char devicetype[32]; 	/* General class of device. */
};

/* A xenbus driver. */
struct xenbus_driver {
	const char *name;       /* defaults to ids[0].devicetype */
	const struct xenbus_device_id *ids;
	int (*probe)(struct xenbus_device *dev,
		     const struct xenbus_device_id *id);
	void (*otherend_changed)(struct xenbus_device *dev,
				 enum xenbus_state backend_state);
	int (*remove)(struct xenbus_device *dev);
	int (*suspend)(struct xenbus_device *dev);
	int (*resume)(struct xenbus_device *dev);
	int (*uevent)(struct xenbus_device *, struct kobj_uevent_env *);
	struct device_driver driver;
	int (*read_otherend_details)(struct xenbus_device *dev);
	int (*is_ready)(struct xenbus_device *dev);
};

static inline struct xenbus_driver *to_xenbus_driver(struct device_driver *drv)
{
	return container_of(drv, struct xenbus_driver, driver);
}

int __must_check __xenbus_register_frontend(struct xenbus_driver *drv,
					    struct module *owner,
					    const char *mod_name);
int __must_check __xenbus_register_backend(struct xenbus_driver *drv,
					   struct module *owner,
					   const char *mod_name);

#define xenbus_register_frontend(drv) \
	__xenbus_register_frontend(drv, THIS_MODULE, KBUILD_MODNAME)
#define xenbus_register_backend(drv) \
	__xenbus_register_backend(drv, THIS_MODULE, KBUILD_MODNAME)

void xenbus_unregister_driver(struct xenbus_driver *drv);

struct xenbus_transaction
{
	u32 id;
};

/* Nil transaction ID. */
#define XBT_NIL ((struct xenbus_transaction) { 0 })

char **xenbus_directory(struct xenbus_transaction t,
			const char *dir, const char *node, unsigned int *num);
void *xenbus_read(struct xenbus_transaction t,
		  const char *dir, const char *node, unsigned int *len);
int xenbus_write(struct xenbus_transaction t,
		 const char *dir, const char *node, const char *string);
int xenbus_mkdir(struct xenbus_transaction t,
		 const char *dir, const char *node);
int xenbus_exists(struct xenbus_transaction t,
		  const char *dir, const char *node);
int xenbus_rm(struct xenbus_transaction t, const char *dir, const char *node);
int xenbus_transaction_start(struct xenbus_transaction *t);
int xenbus_transaction_end(struct xenbus_transaction t, int abort);

/* Single read and scanf: returns -errno or num scanned if > 0. */
__scanf(4, 5)
int xenbus_scanf(struct xenbus_transaction t,
		 const char *dir, const char *node, const char *fmt, ...);

/* Read an (optional) unsigned value. */
unsigned int xenbus_read_unsigned(const char *dir, const char *node,
				  unsigned int default_val);

/* Single printf and write: returns -errno or 0. */
__printf(4, 5)
int xenbus_printf(struct xenbus_transaction t,
		  const char *dir, const char *node, const char *fmt, ...);

/* Generic read function: NULL-terminated triples of name,
 * sprintf-style type string, and pointer. Returns 0 or errno.*/
int xenbus_gather(struct xenbus_transaction t, const char *dir, ...);

/* notifer routines for when the xenstore comes up */
extern int xenstored_ready;
int register_xenstore_notifier(struct notifier_block *nb);
void unregister_xenstore_notifier(struct notifier_block *nb);

int register_xenbus_watch(struct xenbus_watch *watch);
void unregister_xenbus_watch(struct xenbus_watch *watch);
void xs_suspend(void);
void xs_resume(void);
void xs_suspend_cancel(void);

/* Used by xenbus_dev to borrow kernel's store connection. */
void *xenbus_dev_request_and_reply(struct xsd_sockmsg *msg);

struct work_struct;

/* Prepare for domain suspend: then resume or cancel the suspend. */
void xenbus_suspend(void);
void xenbus_resume(void);
void xenbus_probe(struct work_struct *);
void xenbus_suspend_cancel(void);

#define XENBUS_IS_ERR_READ(str) ({			\
	if (!IS_ERR(str) && strlen(str) == 0) {		\
		kfree(str);				\
		str = ERR_PTR(-ERANGE);			\
	}						\
	IS_ERR(str);					\
})

#define XENBUS_EXIST_ERR(err) ((err) == -ENOENT || (err) == -ERANGE)

int xenbus_watch_path(struct xenbus_device *dev, const char *path,
		      struct xenbus_watch *watch,
		      void (*callback)(struct xenbus_watch *,
				       const char **, unsigned int));
__printf(4, 5)
int xenbus_watch_pathfmt(struct xenbus_device *dev, struct xenbus_watch *watch,
			 void (*callback)(struct xenbus_watch *,
					  const char **, unsigned int),
			 const char *pathfmt, ...);

int xenbus_switch_state(struct xenbus_device *dev, enum xenbus_state new_state);
int xenbus_grant_ring(struct xenbus_device *dev, void *vaddr,
		      unsigned int nr_pages, grant_ref_t *grefs);
int xenbus_map_ring_valloc(struct xenbus_device *dev, grant_ref_t *gnt_refs,
			   unsigned int nr_grefs, void **vaddr);
int xenbus_map_ring(struct xenbus_device *dev,
		    grant_ref_t *gnt_refs, unsigned int nr_grefs,
		    grant_handle_t *handles, unsigned long *vaddrs,
		    bool *leaked);

int xenbus_unmap_ring_vfree(struct xenbus_device *dev, void *vaddr);
int xenbus_unmap_ring(struct xenbus_device *dev,
		      grant_handle_t *handles, unsigned int nr_handles,
		      unsigned long *vaddrs);

int xenbus_alloc_evtchn(struct xenbus_device *dev, int *port);
int xenbus_free_evtchn(struct xenbus_device *dev, int port);

enum xenbus_state xenbus_read_driver_state(const char *path);

__printf(3, 4)
void xenbus_dev_error(struct xenbus_device *dev, int err, const char *fmt, ...);
__printf(3, 4)
void xenbus_dev_fatal(struct xenbus_device *dev, int err, const char *fmt, ...);

const char *xenbus_strstate(enum xenbus_state state);
int xenbus_dev_is_online(struct xenbus_device *dev);
int xenbus_frontend_closed(struct xenbus_device *dev);

#endif /* _XEN_XENBUS_H */
Commit	Line	Data
4bac07c9 JF	1	/******************************************************************************
	2	* xenbus.h
	3	*
	4	* Talks to Xen Store to figure out what devices we have.
	5	*
	6	* Copyright (C) 2005 Rusty Russell, IBM Corporation
	7	* Copyright (C) 2005 XenSource Ltd.
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License version 2
	11	* as published by the Free Software Foundation; or, when distributed
	12	* separately from the Linux kernel or incorporated into other
	13	* software packages, subject to the following license:
	14	*
	15	* Permission is hereby granted, free of charge, to any person obtaining a copy
	16	* of this source file (the "Software"), to deal in the Software without
	17	* restriction, including without limitation the rights to use, copy, modify,
	18	* merge, publish, distribute, sublicense, and/or sell copies of the Software,
	19	* and to permit persons to whom the Software is furnished to do so, subject to
	20	* the following conditions:
	21	*
	22	* The above copyright notice and this permission notice shall be included in
	23	* all copies or substantial portions of the Software.
	24	*
	25	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	26	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	27	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	28	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	29	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	30	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
	31	* IN THE SOFTWARE.
	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>
63c9744b	40	#include <linux/export.h>
4bac07c9 JF	41	#include <linux/completion.h>
4bac07c9 JF	42	#include <linux/init.h>
5a0e3ad6	43	#include <linux/slab.h>
4bac07c9 JF	44	#include <xen/interface/xen.h>
	45	#include <xen/interface/grant_table.h>
	46	#include <xen/interface/io/xenbus.h>
	47	#include <xen/interface/io/xs_wire.h>
	48
9cce2914 JG	49	#define XENBUS_MAX_RING_GRANT_ORDER 4
9cce2914 JG	50	#define XENBUS_MAX_RING_GRANTS (1U << XENBUS_MAX_RING_GRANT_ORDER)
ccc9d90a WL	51	#define INVALID_GRANT_HANDLE (~0U)
ccc9d90a WL	52
4bac07c9 JF	53	/* Register callback to watch this node. */
	54	struct xenbus_watch
	55	{
	56	struct list_head list;
	57
	58	/* Path being watched. */
	59	const char *node;
	60
	61	/* Callback (executed in a process context with no locks held). */
	62	void (callback)(struct xenbus_watch ,
	63	const char **vec, unsigned int len);
	64	};
	65
	66
	67	/* A xenbus device. */
	68	struct xenbus_device {
	69	const char *devicetype;
	70	const char *nodename;
	71	const char *otherend;
	72	int otherend_id;
	73	struct xenbus_watch otherend_watch;
	74	struct device dev;
	75	enum xenbus_state state;
	76	struct completion down;
2abb2746	77	struct work_struct work;
4bac07c9 JF	78	};
	79
	80	static inline struct xenbus_device to_xenbus_device(struct device dev)
	81	{
	82	return container_of(dev, struct xenbus_device, dev);
	83	}
	84
	85	struct xenbus_device_id
	86	{
	87	/* .../device/<device_type>/<identifier> */
	88	char devicetype[32]; /* General class of device. */
	89	};
	90
	91	/* A xenbus driver. */
	92	struct xenbus_driver {
95afae48	93	const char name; / defaults to ids[0].devicetype */
4bac07c9 JF	94	const struct xenbus_device_id *ids;
	95	int (probe)(struct xenbus_device dev,
	96	const struct xenbus_device_id *id);
	97	void (otherend_changed)(struct xenbus_device dev,
	98	enum xenbus_state backend_state);
	99	int (remove)(struct xenbus_device dev);
c7853aea	100	int (suspend)(struct xenbus_device dev);
4bac07c9	101	int (resume)(struct xenbus_device dev);
df660251	102	int (uevent)(struct xenbus_device , struct kobj_uevent_env *);
4bac07c9 JF	103	struct device_driver driver;
4bac07c9 JF	104	int (read_otherend_details)(struct xenbus_device dev);
1d78d705	105	int (is_ready)(struct xenbus_device dev);
4bac07c9 JF	106	};
4bac07c9 JF	107
73db144b	108	static inline struct xenbus_driver to_xenbus_driver(struct device_driver drv)
4bac07c9	109	{
73db144b	110	return container_of(drv, struct xenbus_driver, driver);
4bac07c9 JF	111	}
4bac07c9 JF	112
95afae48 DV	113	int __must_check __xenbus_register_frontend(struct xenbus_driver *drv,
	114	struct module *owner,
	115	const char *mod_name);
	116	int __must_check __xenbus_register_backend(struct xenbus_driver *drv,
	117	struct module *owner,
	118	const char *mod_name);
	119
	120	#define xenbus_register_frontend(drv) \
604b91fe	121	__xenbus_register_frontend(drv, THIS_MODULE, KBUILD_MODNAME)
95afae48	122	#define xenbus_register_backend(drv) \
604b91fe	123	__xenbus_register_backend(drv, THIS_MODULE, KBUILD_MODNAME)
4bac07c9 JF	124
	125	void xenbus_unregister_driver(struct xenbus_driver *drv);
	126
	127	struct xenbus_transaction
	128	{
	129	u32 id;
	130	};
	131
	132	/* Nil transaction ID. */
	133	#define XBT_NIL ((struct xenbus_transaction) { 0 })
	134
4bac07c9 JF	135	char **xenbus_directory(struct xenbus_transaction t,
	136	const char dir, const char node, unsigned int *num);
	137	void *xenbus_read(struct xenbus_transaction t,
	138	const char dir, const char node, unsigned int *len);
	139	int xenbus_write(struct xenbus_transaction t,
	140	const char dir, const char node, const char *string);
	141	int xenbus_mkdir(struct xenbus_transaction t,
	142	const char dir, const char node);
	143	int xenbus_exists(struct xenbus_transaction t,
	144	const char dir, const char node);
	145	int xenbus_rm(struct xenbus_transaction t, const char dir, const char node);
	146	int xenbus_transaction_start(struct xenbus_transaction *t);
	147	int xenbus_transaction_end(struct xenbus_transaction t, int abort);
	148
	149	/* Single read and scanf: returns -errno or num scanned if > 0. */
6061d949	150	__scanf(4, 5)
4bac07c9	151	int xenbus_scanf(struct xenbus_transaction t,
6061d949	152	const char dir, const char node, const char *fmt, ...);
4bac07c9	153
9c53a179 JG	154	/* Read an (optional) unsigned value. */
	155	unsigned int xenbus_read_unsigned(const char dir, const char node,
	156	unsigned int default_val);
	157
4bac07c9	158	/* Single printf and write: returns -errno or 0. */
b9075fa9	159	__printf(4, 5)
4bac07c9	160	int xenbus_printf(struct xenbus_transaction t,
b9075fa9	161	const char dir, const char node, const char *fmt, ...);
4bac07c9 JF	162
	163	/* Generic read function: NULL-terminated triples of name,
	164	* sprintf-style type string, and pointer. Returns 0 or errno.*/
	165	int xenbus_gather(struct xenbus_transaction t, const char *dir, ...);
	166
	167	/* notifer routines for when the xenstore comes up */
	168	extern int xenstored_ready;
	169	int register_xenstore_notifier(struct notifier_block *nb);
	170	void unregister_xenstore_notifier(struct notifier_block *nb);
	171
	172	int register_xenbus_watch(struct xenbus_watch *watch);
	173	void unregister_xenbus_watch(struct xenbus_watch *watch);
	174	void xs_suspend(void);
	175	void xs_resume(void);
	176	void xs_suspend_cancel(void);
	177
	178	/* Used by xenbus_dev to borrow kernel's store connection. */
	179	void xenbus_dev_request_and_reply(struct xsd_sockmsg msg);
	180
	181	struct work_struct;
	182
	183	/* Prepare for domain suspend: then resume or cancel the suspend. */
	184	void xenbus_suspend(void);
	185	void xenbus_resume(void);
	186	void xenbus_probe(struct work_struct *);
	187	void 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
	199	int 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));
b9075fa9	203	__printf(4, 5)
4bac07c9 JF	204	int xenbus_watch_pathfmt(struct xenbus_device dev, struct xenbus_watch watch,
	205	void (callback)(struct xenbus_watch ,
	206	const char **, unsigned int),
b9075fa9	207	const char *pathfmt, ...);
4bac07c9 JF	208
4bac07c9 JF	209	int xenbus_switch_state(struct xenbus_device *dev, enum xenbus_state new_state);
ccc9d90a WL	210	int xenbus_grant_ring(struct xenbus_device dev, void vaddr,
	211	unsigned int nr_pages, grant_ref_t *grefs);
	212	int xenbus_map_ring_valloc(struct xenbus_device dev, grant_ref_t gnt_refs,
	213	unsigned int nr_grefs, void **vaddr);
	214	int xenbus_map_ring(struct xenbus_device *dev,
	215	grant_ref_t *gnt_refs, unsigned int nr_grefs,
	216	grant_handle_t handles, unsigned long vaddrs,
	217	bool *leaked);
4bac07c9 JF	218
	219	int xenbus_unmap_ring_vfree(struct xenbus_device dev, void vaddr);
	220	int xenbus_unmap_ring(struct xenbus_device *dev,
ccc9d90a WL	221	grant_handle_t *handles, unsigned int nr_handles,
ccc9d90a WL	222	unsigned long *vaddrs);
4bac07c9 JF	223
4bac07c9 JF	224	int xenbus_alloc_evtchn(struct xenbus_device dev, int port);
4bac07c9 JF	225	int xenbus_free_evtchn(struct xenbus_device *dev, int port);
	226
	227	enum xenbus_state xenbus_read_driver_state(const char *path);
	228
b9075fa9	229	__printf(3, 4)
4bac07c9	230	void xenbus_dev_error(struct xenbus_device dev, int err, const char fmt, ...);
b9075fa9	231	__printf(3, 4)
4bac07c9 JF	232	void xenbus_dev_fatal(struct xenbus_device dev, int err, const char fmt, ...);
	233
	234	const char *xenbus_strstate(enum xenbus_state state);
	235	int xenbus_dev_is_online(struct xenbus_device *dev);
	236	int xenbus_frontend_closed(struct xenbus_device *dev);
	237
	238	#endif /* _XEN_XENBUS_H */