1 /******************************************************************************
2 * Talks to Xen Store to figure out what devices we have.
4 * Copyright (C) 2009, 2010 Spectra Logic Corporation
5 * Copyright (C) 2008 Doug Rabson
6 * Copyright (C) 2005 Rusty Russell, IBM Corporation
7 * Copyright (C) 2005 Mike Wray, Hewlett-Packard
8 * Copyright (C) 2005 XenSource Ltd
10 * This file may be distributed separately from the Linux kernel, or
11 * incorporated into other software packages, subject to the following license:
13 * Permission is hereby granted, free of charge, to any person obtaining a copy
14 * of this source file (the "Software"), to deal in the Software without
15 * restriction, including without limitation the rights to use, copy, modify,
16 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
17 * and to permit persons to whom the Software is furnished to do so, subject to
18 * the following conditions:
20 * The above copyright notice and this permission notice shall be included in
21 * all copies or substantial portions of the Software.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
33 * \file xenbusb_front.c
35 * XenBus management of the NewBus bus containing the frontend instances of
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
43 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
48 #include <sys/sysctl.h>
49 #include <sys/syslog.h>
50 #include <sys/systm.h>
52 #include <sys/taskqueue.h>
54 #include <machine/stdarg.h>
56 #include <xen/xen-os.h>
57 #include <xen/gnttab.h>
58 #include <xen/xenbus/xenbusvar.h>
59 #include <xen/xenbus/xenbusb.h>
62 /*------------------ Private Device Attachment Functions --------------------*/
64 * \brief Probe for the existance of the XenBus front bus.
66 * \param dev NewBus device_t for this XenBus front bus instance.
68 * \return Always returns 0 indicating success.
71 xenbusb_front_probe(device_t dev)
73 device_set_desc(dev, "Xen Frontend Devices");
79 * \brief Attach the XenBus front bus.
81 * \param dev NewBus device_t for this XenBus front bus instance.
83 * \return On success, 0. Otherwise an errno value indicating the
87 xenbusb_front_attach(device_t dev)
89 return (xenbusb_attach(dev, "device", /*id_components*/1));
93 * \brief Enumerate all devices of the given type on this bus.
95 * \param dev NewBus device_t for this XenBus front bus instance.
96 * \param type String indicating the device sub-tree (e.g. "vfb", "vif")
99 * \return On success, 0. Otherwise an errno value indicating the
102 * Devices that are found are entered into the NewBus hierarchy via
103 * xenbusb_add_device(). xenbusb_add_device() ignores duplicate detects
104 * and ignores duplicate devices, so it can be called unconditionally
105 * for any device found in the XenStore.
108 xenbusb_front_enumerate_type(device_t dev, const char *type)
110 struct xenbusb_softc *xbs;
112 unsigned int i, count;
115 xbs = device_get_softc(dev);
116 error = xs_directory(XST_NIL, xbs->xbs_node, type, &count, &dir);
119 for (i = 0; i < count; i++)
120 xenbusb_add_device(dev, type, dir[i]);
122 free(dir, M_XENSTORE);
128 * \brief Determine and store the XenStore path for the other end of
129 * a split device whose local end is represented by ivars.
131 * If successful, the xd_otherend_path field of the child's instance
132 * variables will be updated.
134 * \param dev NewBus device_t for this XenBus front bus instance.
135 * \param ivars Instance variables from the XenBus child device for
136 * which to perform this function.
138 * \return On success, 0. Otherwise an errno value indicating the
142 xenbusb_front_get_otherend_node(device_t dev, struct xenbus_device_ivars *ivars)
147 if (ivars->xd_otherend_path != NULL) {
148 free(ivars->xd_otherend_path, M_XENBUS);
149 ivars->xd_otherend_path = NULL;
152 error = xs_gather(XST_NIL, ivars->xd_node,
153 "backend-id", "%i", &ivars->xd_otherend_id,
154 "backend", NULL, &otherend_path,
158 ivars->xd_otherend_path = strdup(otherend_path, M_XENBUS);
159 ivars->xd_otherend_path_len = strlen(otherend_path);
160 free(otherend_path, M_XENSTORE);
165 /*-------------------- Private Device Attachment Data -----------------------*/
166 static device_method_t xenbusb_front_methods[] = {
167 /* Device interface */
168 DEVMETHOD(device_identify, xenbusb_identify),
169 DEVMETHOD(device_probe, xenbusb_front_probe),
170 DEVMETHOD(device_attach, xenbusb_front_attach),
171 DEVMETHOD(device_detach, bus_generic_detach),
172 DEVMETHOD(device_shutdown, bus_generic_shutdown),
173 DEVMETHOD(device_suspend, bus_generic_suspend),
174 DEVMETHOD(device_resume, xenbusb_resume),
177 DEVMETHOD(bus_print_child, xenbusb_print_child),
178 DEVMETHOD(bus_read_ivar, xenbusb_read_ivar),
179 DEVMETHOD(bus_write_ivar, xenbusb_write_ivar),
180 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
181 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
182 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
183 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
185 /* XenBus Bus Interface */
186 DEVMETHOD(xenbusb_enumerate_type, xenbusb_front_enumerate_type),
187 DEVMETHOD(xenbusb_get_otherend_node, xenbusb_front_get_otherend_node),
191 DEFINE_CLASS_0(xenbusb_front, xenbusb_front_driver, xenbusb_front_methods,
192 sizeof(struct xenbusb_softc));
193 devclass_t xenbusb_front_devclass;
195 DRIVER_MODULE(xenbusb_front, xenstore, xenbusb_front_driver,
196 xenbusb_front_devclass, 0, 0);