xref: /freebsd/sys/xen/xenbus/xenbus_if.m (revision e7fec5c320c1d52fdc932880f311c9b03fc43a5b) 
1#-
2# Copyright (c) 2008 Doug Rabson
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26# $FreeBSD$
27#
28
29#include <sys/bus.h>
30
31#include <machine/atomic.h>
32
33#include <xen/xen-os.h>
34#include <xen/evtchn.h>
35#include <xen/xenbus/xenbusvar.h>
36
37INTERFACE xenbus;
38
39/**
40 * \brief Callback triggered when the state of the otherend
41 *        of a split device changes.
42 *
43 * \param _dev       NewBus device_t for this XenBus device whose otherend's
44 *                   state has changed..
45 * \param _newstate  The new state of the otherend device.
46 */
47METHOD void otherend_changed {
48	device_t _dev;
49	enum xenbus_state _newstate;
50};
51
52/**
53 * \brief Callback triggered when the XenStore tree of the local end
54 *        of a split device changes.
55 *
56 * \param _dev   NewBus device_t for this XenBus device whose otherend's
57 *               state has changed..
58 * \param _path  The tree relative sub-path to the modified node.  The empty
59 *               string indicates the root of the tree was destroyed.
60 */
61METHOD void localend_changed {
62	device_t _dev;
63	const char * _path;
64} DEFAULT xenbus_localend_changed;
65