1# 2# Copyright (c) 1998 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: src/sys/kern/bus_if.m,v 1.16 1999/10/12 21:35:50 dfr Exp $ 27# $DragonFly: src/sys/kern/bus_if.m,v 1.8 2005/10/30 04:41:15 dillon Exp $ 28# 29 30#include <sys/bus.h> 31 32INTERFACE bus; 33 34# 35# Default implementations of some methods. 36# 37CODE { 38 static struct resource * 39 null_alloc_resource(device_t dev, device_t child, 40 int type, int *rid, 41 u_long start, u_long end, 42 u_long count, u_int flags) 43 { 44 return 0; 45 } 46}; 47 48# 49# This is called from system code which prints out a description of a 50# device. It should describe the attachment that the child has with 51# the parent. For instance the TurboLaser bus prints which node the 52# device is attached to. See bus_generic_print_child.9 for more 53# information. 54# This method returns the number of characters output. 55# 56METHOD int print_child { 57 device_t dev; 58 device_t child; 59} DEFAULT bus_generic_print_child; 60 61# 62# Called for each child device that 63# did not succeed in probing for a 64# driver. 65# 66METHOD void probe_nomatch { 67 device_t dev; 68 device_t child; 69}; 70 71# 72# These two methods manage a bus specific set of instance variables of 73# a child device. The intention is that each different type of bus 74# defines a set of appropriate instance variables (such as ports and 75# irqs for ISA bus etc.) 76# 77# This information could be given to the child device as a struct but 78# that makes it hard for a bus to add or remove variables without 79# forcing an edit and recompile for all drivers which may not be 80# possible for vendor supplied binary drivers. 81 82# 83# Read an instance variable. Return 0 on success. 84# 85METHOD int read_ivar { 86 device_t dev; 87 device_t child; 88 int index; 89 uintptr_t *result; 90}; 91 92# 93# Write an instance variable. Return 0 on success. 94# 95METHOD int write_ivar { 96 device_t dev; 97 device_t child; 98 int index; 99 uintptr_t value; 100}; 101 102# 103# Called after the child's DEVICE_DETACH method to allow the parent 104# to reclaim any resources allocated on behalf of the child. 105# 106METHOD void child_detached { 107 device_t dev; 108 device_t child; 109}; 110 111# 112# Called when a new driver is added to the devclass which owns this 113# bus. The generic implementation of this method attempts to probe and 114# attach any un-matched children of the bus. 115# 116METHOD void driver_added { 117 device_t dev; 118 driver_t *driver; 119} DEFAULT bus_generic_driver_added; 120 121# 122# For busses which use use drivers supporting DEVICE_IDENTIFY to 123# enumerate their devices, these methods are used to create new 124# device instances. If place is non-NULL, the new device will be 125# added after the last existing child with the same order. 126# 127# bus is an entity which may iterate up through the bus heirarchy 128# while parent is the parent device under which the child should be 129# added. 130# 131METHOD device_t add_child { 132 device_t bus; 133 device_t parent; 134 int order; 135 const char *name; 136 int unit; 137}; 138 139# 140# Allocate a system resource attached to `dev' on behalf of `child'. 141# The types are defined in <machine/resource.h>; the meaning of the 142# resource-ID field varies from bus to bus (but *rid == 0 is always 143# valid if the resource type is). start and end reflect the allowable 144# range, and should be passed as `0UL' and `~0UL', respectively, if 145# the client has no range restriction. count is the number of consecutive 146# indices in the resource required. flags is a set of sharing flags 147# as defined in <sys/rman.h>. 148# 149# Returns a resource or a null pointer on failure. The caller is 150# responsible for calling rman_activate_resource() when it actually 151# uses the resource. 152# 153METHOD struct resource * alloc_resource { 154 device_t dev; 155 device_t child; 156 int type; 157 int *rid; 158 u_long start; 159 u_long end; 160 u_long count; 161 u_int flags; 162} DEFAULT null_alloc_resource; 163 164METHOD int activate_resource { 165 device_t dev; 166 device_t child; 167 int type; 168 int rid; 169 struct resource *r; 170}; 171 172METHOD int deactivate_resource { 173 device_t dev; 174 device_t child; 175 int type; 176 int rid; 177 struct resource *r; 178}; 179 180# 181# Free a resource allocated by the preceding method. The `rid' value 182# must be the same as the one returned by BUS_ALLOC_RESOURCE (which 183# is not necessarily the same as the one the client passed). 184# 185METHOD int release_resource { 186 device_t dev; 187 device_t child; 188 int type; 189 int rid; 190 struct resource *res; 191}; 192 193METHOD int setup_intr { 194 device_t dev; 195 device_t child; 196 struct resource *irq; 197 int flags; 198 driver_intr_t *intr; 199 void *arg; 200 void **cookiep; 201 lwkt_serialize_t serializer; 202}; 203 204METHOD int teardown_intr { 205 device_t dev; 206 device_t child; 207 struct resource *irq; 208 void *cookie; 209}; 210 211# Enable or disable an interrupt. The device is generally expected to do 212# the physical enablement and disablement. The bus code must flag the 213# condition so it does not call the handler from a scheduled interrupt thread, 214# since the hard interrupt might be disabled after the interrupt thread 215# has been scheduled but before it runs. 216# 217# The disable function returns an indication as to whether the handler 218# is currently running (i.e. the disablement is racing the execution of 219# the interrupt handler). 0 is returned if it isn't, non-zero if it is. 220# 221# The disablement function does NOT interlock against a running handler, it 222# simply prevents future handler calls from being made. 223# 224METHOD void enable_intr { 225 device_t dev; 226 device_t child; 227 void *cookie; 228} DEFAULT bus_generic_enable_intr; 229 230METHOD int disable_intr { 231 device_t dev; 232 device_t child; 233 void *cookie; 234} DEFAULT bus_generic_disable_intr; 235 236# 237# Set the range used for a particular resource. Return EINVAL if 238# the type or rid are out of range. 239# 240METHOD int set_resource { 241 device_t dev; 242 device_t child; 243 int type; 244 int rid; 245 u_long start; 246 u_long count; 247}; 248 249# 250# Get the range for a resource. Return ENOENT if the type or rid are 251# out of range or have not been set. 252# 253METHOD int get_resource { 254 device_t dev; 255 device_t child; 256 int type; 257 int rid; 258 u_long *startp; 259 u_long *countp; 260}; 261 262# 263# Delete a resource. 264# 265METHOD void delete_resource { 266 device_t dev; 267 device_t child; 268 int type; 269 int rid; 270}; 271 272# 273# Return a struct resource_list. 274# 275METHOD struct resource_list * get_resource_list { 276 device_t _dev; 277 device_t _child; 278} DEFAULT bus_generic_get_resource_list; 279 280# 281# Is the hardware described by _child still attached to the system? 282# 283# This method should return 0 if the device is not present. It should 284# return -1 if it is present. Any errors in determining should be 285# returned as a normal errno value. Client drivers are to assume that 286# the device is present, even if there is an error determining if it is 287# there. Busses are to try to avoid returning errors, but newcard will return 288# an error if the device fails to implement this method. 289# 290METHOD int child_present { 291 device_t _dev; 292 device_t _child; 293} DEFAULT bus_generic_child_present; 294 295# 296# Returns the pnp info for this device. Return it as a string. If the 297# string is insufficient for the storage, then return EOVERFLOW. 298# 299METHOD int child_pnpinfo_str { 300 device_t _dev; 301 device_t _child; 302 char *_buf; 303 size_t _buflen; 304}; 305 306# 307# Returns the location for this device. Return it as a string. If the 308# string is insufficient for the storage, then return EOVERFLOW. 309# 310METHOD int child_location_str { 311 device_t _dev; 312 device_t _child; 313 char *_buf; 314 size_t _buflen; 315}; 316 317# 318# Allow (bus) drivers to specify the trigger mode and polarity of the 319# specified interrupt. 320# 321METHOD int config_intr { 322 device_t _dev; 323 int _irq; 324 enum intr_trigger _trig; 325 enum intr_polarity _pol; 326} DEFAULT bus_generic_config_intr; 327 328