2 # Copyright (c) 2001, 2003 by Thomas Moestl <tmm@FreeBSD.org>
3 # Copyright (c) 2004, 2005 by Marius Strobl <marius@FreeBSD.org>
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
9 # 1. Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # 2. Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in the
13 # documentation and/or other materials provided with the distribution.
15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 # IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
19 # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
24 # USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 # Interface for retrieving the package handle and a subset, namely
29 # 'compatible', 'device_type', 'model' and 'name', of the standard
30 # properties of a device on an Open Firmware assisted bus for use
31 # in device drivers. The rest of the standard properties, 'address',
32 # 'interrupts', 'reg' and 'status', are not covered by this interface
33 # as they are expected to be only of interest in the respective bus
38 #include <dev/ofw/openfirm.h>
43 struct ofw_bus_devinfo {
54 static ofw_bus_get_devinfo_t ofw_bus_default_get_devinfo;
55 static ofw_bus_get_compat_t ofw_bus_default_get_compat;
56 static ofw_bus_get_model_t ofw_bus_default_get_model;
57 static ofw_bus_get_name_t ofw_bus_default_get_name;
58 static ofw_bus_get_node_t ofw_bus_default_get_node;
59 static ofw_bus_get_type_t ofw_bus_default_get_type;
60 static ofw_bus_map_intr_t ofw_bus_default_map_intr;
62 static const struct ofw_bus_devinfo *
63 ofw_bus_default_get_devinfo(device_t bus, device_t dev)
70 ofw_bus_default_get_compat(device_t bus, device_t dev)
77 ofw_bus_default_get_model(device_t bus, device_t dev)
84 ofw_bus_default_get_name(device_t bus, device_t dev)
91 ofw_bus_default_get_node(device_t bus, device_t dev)
98 ofw_bus_default_get_type(device_t bus, device_t dev)
105 ofw_bus_default_map_intr(device_t bus, device_t dev, phandle_t iparent,
106 int icells, pcell_t *interrupt)
108 /* Propagate up the bus hierarchy until someone handles it. */
109 if (device_get_parent(bus) != NULL)
110 return OFW_BUS_MAP_INTR(device_get_parent(bus), dev,
111 iparent, icells, interrupt);
113 /* If that fails, then assume a one-domain system */
114 return (interrupt[0]);
118 # Get the ofw_bus_devinfo struct for the device dev on the bus. Used for bus
119 # drivers which use the generic methods in ofw_bus_subr.c to implement the
120 # reset of this interface. The default method will return NULL, which means
121 # there is no such struct associated with the device.
122 METHOD const struct ofw_bus_devinfo * get_devinfo {
125 } DEFAULT ofw_bus_default_get_devinfo;
127 # Get the alternate firmware name for the device dev on the bus. The default
128 # method will return NULL, which means the device doesn't have such a property.
129 METHOD const char * get_compat {
132 } DEFAULT ofw_bus_default_get_compat;
134 # Get the firmware model name for the device dev on the bus. The default method
135 # will return NULL, which means the device doesn't have such a property.
136 METHOD const char * get_model {
139 } DEFAULT ofw_bus_default_get_model;
141 # Get the firmware name for the device dev on the bus. The default method will
142 # return NULL, which means the device doesn't have such a property.
143 METHOD const char * get_name {
146 } DEFAULT ofw_bus_default_get_name;
148 # Get the firmware node for the device dev on the bus. The default method will
149 # return -1, which signals that there is no such node.
150 METHOD phandle_t get_node {
153 } DEFAULT ofw_bus_default_get_node;
155 # Get the firmware device type for the device dev on the bus. The default
156 # method will return NULL, which means the device doesn't have such a property.
157 METHOD const char * get_type {
160 } DEFAULT ofw_bus_default_get_type;
162 # Map an (interrupt parent, IRQ) pair to a unique system-wide interrupt number.
163 # If the interrupt encoding includes a sense field, the interrupt sense will
164 # also be configured.
165 METHOD int map_intr {
171 } DEFAULT ofw_bus_default_map_intr;