Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / xen / include / xen3-public / io / xenbus.h
blobe88fb0dfad3e88d584c1386aafd917373a446893
1 /* $NetBSD: xenbus.h,v 1.5 2007/10/17 19:58:32 garbled Exp $ */
2 /*****************************************************************************
3 * xenbus.h
5 * Xenbus protocol details.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to
9 * deal in the Software without restriction, including without limitation the
10 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11 * sell copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 * DEALINGS IN THE SOFTWARE.
25 * Copyright (C) 2005 XenSource Ltd.
28 #ifndef _XEN_PUBLIC_IO_XENBUS_H
29 #define _XEN_PUBLIC_IO_XENBUS_H
32 * The state of either end of the Xenbus, i.e. the current communication
33 * status of initialisation across the bus. States here imply nothing about
34 * the state of the connection between the driver and the kernel's device
35 * layers.
37 enum xenbus_state {
38 XenbusStateUnknown = 0,
40 XenbusStateInitialising = 1,
43 * InitWait: Finished early initialisation but waiting for information
44 * from the peer or hotplug scripts.
46 XenbusStateInitWait = 2,
49 * Initialised: Waiting for a connection from the peer.
51 XenbusStateInitialised = 3,
53 XenbusStateConnected = 4,
56 * Closing: The device is being closed due to an error or an unplug event.
58 XenbusStateClosing = 5,
60 XenbusStateClosed = 6,
63 * Reconfiguring: The device is being reconfigured.
65 XenbusStateReconfiguring = 7,
67 XenbusStateReconfigured = 8
69 typedef enum xenbus_state XenbusState;
71 #endif /* _XEN_PUBLIC_IO_XENBUS_H */
74 * Local variables:
75 * mode: C
76 * c-set-style: "BSD"
77 * c-basic-offset: 4
78 * tab-width: 4
79 * indent-tabs-mode: nil
80 * End: