xref: /freebsd/sys/xen/xenbus/xenbus_if.m (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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#
27
28#include <sys/bus.h>
29
30#include <machine/atomic.h>
31
32#include <xen/xen-os.h>
33#include <xen/evtchn.h>
34#include <xen/xenbus/xenbusvar.h>
35
36INTERFACE xenbus;
37
38/**
39 * \brief Callback triggered when the state of the otherend
40 *        of a split device changes.
41 *
42 * \param _dev       NewBus device_t for this XenBus device whose otherend's
43 *                   state has changed..
44 * \param _newstate  The new state of the otherend device.
45 */
46METHOD void otherend_changed {
47	device_t _dev;
48	enum xenbus_state _newstate;
49};
50
51/**
52 * \brief Callback triggered when the XenStore tree of the local end
53 *        of a split device changes.
54 *
55 * \param _dev   NewBus device_t for this XenBus device whose otherend's
56 *               state has changed..
57 * \param _path  The tree relative sub-path to the modified node.  The empty
58 *               string indicates the root of the tree was destroyed.
59 */
60METHOD void localend_changed {
61	device_t _dev;
62	const char * _path;
63} DEFAULT xenbus_localend_changed;
64