]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/bus_if.m
MFC 307012,307013,307262
[FreeBSD/FreeBSD.git] / sys / kern / bus_if.m
1 #-
2 # Copyright (c) 1998-2004 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/types.h>
30 #include <sys/systm.h>
31 #include <sys/bus.h>
32
33 /**
34  * @defgroup BUS bus - KObj methods for drivers of devices with children
35  * @brief A set of methods required device drivers that support
36  * child devices.
37  * @{
38  */
39 INTERFACE bus;
40
41 #
42 # Default implementations of some methods.
43 #
44 CODE {
45         static struct resource *
46         null_alloc_resource(device_t dev, device_t child,
47             int type, int *rid, rman_res_t start, rman_res_t end,
48             rman_res_t count, u_int flags)
49         {
50             return (0);
51         }
52
53         static int
54         null_remap_intr(device_t bus, device_t dev, u_int irq)
55         {
56
57                 if (dev != NULL)
58                         return (BUS_REMAP_INTR(dev, NULL, irq));
59                 return (ENXIO);
60         }
61
62         static device_t
63         null_add_child(device_t bus, int order, const char *name,
64             int unit)
65         {
66
67                 panic("bus_add_child is not implemented");
68         }
69 };
70
71 /**
72  * @brief Print a description of a child device
73  *
74  * This is called from system code which prints out a description of a
75  * device. It should describe the attachment that the child has with
76  * the parent. For instance the TurboLaser bus prints which node the
77  * device is attached to. See bus_generic_print_child() for more 
78  * information.
79  *
80  * @param _dev          the device whose child is being printed
81  * @param _child        the child device to describe
82  *
83  * @returns             the number of characters output.
84  */
85 METHOD int print_child {
86         device_t _dev;
87         device_t _child;
88 } DEFAULT bus_generic_print_child;
89
90 /**
91  * @brief Print a notification about an unprobed child device.
92  *
93  * Called for each child device that did not succeed in probing for a
94  * driver.
95  *
96  * @param _dev          the device whose child was being probed
97  * @param _child        the child device which failed to probe
98  */   
99 METHOD void probe_nomatch {
100         device_t _dev;
101         device_t _child;
102 };
103
104 /**
105  * @brief Read the value of a bus-specific attribute of a device
106  *
107  * This method, along with BUS_WRITE_IVAR() manages a bus-specific set
108  * of instance variables of a child device.  The intention is that
109  * each different type of bus defines a set of appropriate instance
110  * variables (such as ports and irqs for ISA bus etc.)
111  *
112  * This information could be given to the child device as a struct but
113  * that makes it hard for a bus to add or remove variables without
114  * forcing an edit and recompile for all drivers which may not be
115  * possible for vendor supplied binary drivers.
116  *
117  * This method copies the value of an instance variable to the
118  * location specified by @p *_result.
119  * 
120  * @param _dev          the device whose child was being examined
121  * @param _child        the child device whose instance variable is
122  *                      being read
123  * @param _index        the instance variable to read
124  * @param _result       a location to receive the instance variable
125  *                      value
126  * 
127  * @retval 0            success
128  * @retval ENOENT       no such instance variable is supported by @p
129  *                      _dev 
130  */
131 METHOD int read_ivar {
132         device_t _dev;
133         device_t _child;
134         int _index;
135         uintptr_t *_result;
136 };
137
138 /**
139  * @brief Write the value of a bus-specific attribute of a device
140  * 
141  * This method sets the value of an instance variable to @p _value.
142  * 
143  * @param _dev          the device whose child was being updated
144  * @param _child        the child device whose instance variable is
145  *                      being written
146  * @param _index        the instance variable to write
147  * @param _value        the value to write to that instance variable
148  * 
149  * @retval 0            success
150  * @retval ENOENT       no such instance variable is supported by @p
151  *                      _dev 
152  * @retval EINVAL       the instance variable was recognised but
153  *                      contains a read-only value
154  */
155 METHOD int write_ivar {
156         device_t _dev;
157         device_t _child;
158         int _indx;
159         uintptr_t _value;
160 };
161
162 /**
163  * @brief Notify a bus that a child was deleted
164  *
165  * Called at the beginning of device_delete_child() to allow the parent
166  * to teardown any bus-specific state for the child.
167  * 
168  * @param _dev          the device whose child is being deleted
169  * @param _child        the child device which is being deleted
170  */
171 METHOD void child_deleted {
172         device_t _dev;
173         device_t _child;
174 };
175
176 /**
177  * @brief Notify a bus that a child was detached
178  *
179  * Called after the child's DEVICE_DETACH() method to allow the parent
180  * to reclaim any resources allocated on behalf of the child.
181  * 
182  * @param _dev          the device whose child changed state
183  * @param _child        the child device which changed state
184  */
185 METHOD void child_detached {
186         device_t _dev;
187         device_t _child;
188 };
189
190 /**
191  * @brief Notify a bus that a new driver was added
192  * 
193  * Called when a new driver is added to the devclass which owns this
194  * bus. The generic implementation of this method attempts to probe and
195  * attach any un-matched children of the bus.
196  * 
197  * @param _dev          the device whose devclass had a new driver
198  *                      added to it
199  * @param _driver       the new driver which was added
200  */
201 METHOD void driver_added {
202         device_t _dev;
203         driver_t *_driver;
204 } DEFAULT bus_generic_driver_added;
205
206 /**
207  * @brief Create a new child device
208  *
209  * For busses which use use drivers supporting DEVICE_IDENTIFY() to
210  * enumerate their devices, this method is used to create new
211  * device instances. The new device will be added after the last
212  * existing child with the same order. Implementations of bus_add_child
213  * call device_add_child_ordered to add the child and often add
214  * a suitable ivar to the device specific to that bus.
215  * 
216  * @param _dev          the bus device which will be the parent of the
217  *                      new child device
218  * @param _order        a value which is used to partially sort the
219  *                      children of @p _dev - devices created using
220  *                      lower values of @p _order appear first in @p
221  *                      _dev's list of children
222  * @param _name         devclass name for new device or @c NULL if not
223  *                      specified
224  * @param _unit         unit number for new device or @c -1 if not
225  *                      specified
226  */
227 METHOD device_t add_child {
228         device_t _dev;
229         u_int _order;
230         const char *_name;
231         int _unit;
232 } DEFAULT null_add_child;
233
234 /**
235  * @brief Rescan the bus
236  *
237  * This method is called by a parent bridge or devctl to trigger a bus
238  * rescan.  The rescan should delete devices no longer present and
239  * enumerate devices that have newly arrived.
240  *
241  * @param _dev          the bus device
242  */
243 METHOD int rescan {
244         device_t _dev;
245 }
246
247 /**
248  * @brief Allocate a system resource
249  *
250  * This method is called by child devices of a bus to allocate resources.
251  * The types are defined in <machine/resource.h>; the meaning of the
252  * resource-ID field varies from bus to bus (but @p *rid == 0 is always
253  * valid if the resource type is). If a resource was allocated and the
254  * caller did not use the RF_ACTIVE to specify that it should be
255  * activated immediately, the caller is responsible for calling
256  * BUS_ACTIVATE_RESOURCE() when it actually uses the resource.
257  *
258  * @param _dev          the parent device of @p _child
259  * @param _child        the device which is requesting an allocation
260  * @param _type         the type of resource to allocate
261  * @param _rid          a pointer to the resource identifier
262  * @param _start        hint at the start of the resource range - pass
263  *                      @c 0 for any start address
264  * @param _end          hint at the end of the resource range - pass
265  *                      @c ~0 for any end address
266  * @param _count        hint at the size of range required - pass @c 1
267  *                      for any size
268  * @param _flags        any extra flags to control the resource
269  *                      allocation - see @c RF_XXX flags in
270  *                      <sys/rman.h> for details
271  * 
272  * @returns             the resource which was allocated or @c NULL if no
273  *                      resource could be allocated
274  */
275 METHOD struct resource * alloc_resource {
276         device_t        _dev;
277         device_t        _child;
278         int             _type;
279         int            *_rid;
280         rman_res_t      _start;
281         rman_res_t      _end;
282         rman_res_t      _count;
283         u_int           _flags;
284 } DEFAULT null_alloc_resource;
285
286 /**
287  * @brief Activate a resource
288  *
289  * Activate a resource previously allocated with
290  * BUS_ALLOC_RESOURCE().  This may enable decoding of this resource in a
291  * device for instance.  It will also establish a mapping for the resource
292  * unless RF_UNMAPPED was set when allocating the resource.
293  *
294  * @param _dev          the parent device of @p _child
295  * @param _child        the device which allocated the resource
296  * @param _type         the type of resource
297  * @param _rid          the resource identifier
298  * @param _r            the resource to activate
299  */
300 METHOD int activate_resource {
301         device_t        _dev;
302         device_t        _child;
303         int             _type;
304         int             _rid;
305         struct resource *_r;
306 };
307
308
309 /**
310  * @brief Map a resource
311  *
312  * Allocate a mapping for a range of an active resource.  The mapping
313  * is described by a struct resource_map object.  This may for instance
314  * map a memory region into the kernel's virtual address space.
315  *
316  * @param _dev          the parent device of @p _child
317  * @param _child        the device which allocated the resource
318  * @param _type         the type of resource
319  * @param _r            the resource to map
320  * @param _args         optional attributes of the mapping
321  * @param _map          the mapping
322  */
323 METHOD int map_resource {
324         device_t        _dev;
325         device_t        _child;
326         int             _type;
327         struct resource *_r;
328         struct resource_map_request *_args;
329         struct resource_map *_map;
330 } DEFAULT bus_generic_map_resource;
331
332
333 /**
334  * @brief Unmap a resource
335  *
336  * Release a mapping previously allocated with
337  * BUS_MAP_RESOURCE(). This may for instance unmap a memory region
338  * from the kernel's virtual address space.
339  *
340  * @param _dev          the parent device of @p _child
341  * @param _child        the device which allocated the resource
342  * @param _type         the type of resource
343  * @param _r            the resource
344  * @param _map          the mapping to release
345  */
346 METHOD int unmap_resource {
347         device_t        _dev;
348         device_t        _child;
349         int             _type;
350         struct resource *_r;
351         struct resource_map *_map;
352 } DEFAULT bus_generic_unmap_resource;
353
354
355 /**
356  * @brief Deactivate a resource
357  *
358  * Deactivate a resource previously allocated with
359  * BUS_ALLOC_RESOURCE(). 
360  *
361  * @param _dev          the parent device of @p _child
362  * @param _child        the device which allocated the resource
363  * @param _type         the type of resource
364  * @param _rid          the resource identifier
365  * @param _r            the resource to deactivate
366  */
367 METHOD int deactivate_resource {
368         device_t        _dev;
369         device_t        _child;
370         int             _type;
371         int             _rid;
372         struct resource *_r;
373 };
374
375 /**
376  * @brief Adjust a resource
377  *
378  * Adjust the start and/or end of a resource allocated by
379  * BUS_ALLOC_RESOURCE.  At least part of the new address range must overlap
380  * with the existing address range.  If the successful, the resource's range
381  * will be adjusted to [start, end] on return.
382  *
383  * @param _dev          the parent device of @p _child
384  * @param _child        the device which allocated the resource
385  * @param _type         the type of resource
386  * @param _res          the resource to adjust
387  * @param _start        the new starting address of the resource range
388  * @param _end          the new ending address of the resource range
389  */
390 METHOD int adjust_resource {
391         device_t        _dev;
392         device_t        _child;
393         int             _type;
394         struct resource *_res;
395         rman_res_t      _start;
396         rman_res_t      _end;
397 };
398
399 /**
400  * @brief Release a resource
401  *
402  * Free a resource allocated by the BUS_ALLOC_RESOURCE.  The @p _rid
403  * value must be the same as the one returned by BUS_ALLOC_RESOURCE()
404  * (which is not necessarily the same as the one the client passed).
405  *
406  * @param _dev          the parent device of @p _child
407  * @param _child        the device which allocated the resource
408  * @param _type         the type of resource
409  * @param _rid          the resource identifier
410  * @param _r            the resource to release
411  */
412 METHOD int release_resource {
413         device_t        _dev;
414         device_t        _child;
415         int             _type;
416         int             _rid;
417         struct resource *_res;
418 };
419
420 /**
421  * @brief Map an interrupt
422  *
423  * This method is used to get an interrupt mapping data according to provided
424  * hints. The hints could be modified afterwards, but only if mapping data was
425  * allocated. This method is intended to be called before BUS_ALLOC_RESOURCE().
426  *
427  * @param _dev          the parent device of @p _child
428  * @param _child        the device which is requesting an allocation
429  * @param _rid          a pointer to the resource identifier
430  * @param _start        a pointer to the hint at the start of the resource
431  *                      range - pass @c 0 for any start address
432  * @param _end          a pointer to the hint at the end of the resource
433  *                      range - pass @c ~0 for any end address
434  * @param _count        a pointer to the hint at the size of resource
435  *                      range required - pass @c 1 for any size
436  * @param _imd          a pointer to the interrupt mapping data which was
437  *                      allocated
438  */
439 METHOD int map_intr {
440         device_t        _dev;
441         device_t        _child;
442         int             *_rid;
443         rman_res_t      *_start;
444         rman_res_t      *_end;
445         rman_res_t      *_count;
446         struct intr_map_data **_imd;
447 } DEFAULT bus_generic_map_intr;
448
449 /**
450  * @brief Install an interrupt handler
451  *
452  * This method is used to associate an interrupt handler function with
453  * an irq resource. When the interrupt triggers, the function @p _intr
454  * will be called with the value of @p _arg as its single
455  * argument. The value returned in @p *_cookiep is used to cancel the
456  * interrupt handler - the caller should save this value to use in a
457  * future call to BUS_TEARDOWN_INTR().
458  * 
459  * @param _dev          the parent device of @p _child
460  * @param _child        the device which allocated the resource
461  * @param _irq          the resource representing the interrupt
462  * @param _flags        a set of bits from enum intr_type specifying
463  *                      the class of interrupt
464  * @param _intr         the function to call when the interrupt
465  *                      triggers
466  * @param _arg          a value to use as the single argument in calls
467  *                      to @p _intr
468  * @param _cookiep      a pointer to a location to receive a cookie
469  *                      value that may be used to remove the interrupt
470  *                      handler
471  */
472 METHOD int setup_intr {
473         device_t        _dev;
474         device_t        _child;
475         struct resource *_irq;
476         int             _flags;
477         driver_filter_t *_filter;
478         driver_intr_t   *_intr;
479         void            *_arg;
480         void            **_cookiep;
481 };
482
483 /**
484  * @brief Uninstall an interrupt handler
485  *
486  * This method is used to disassociate an interrupt handler function
487  * with an irq resource. The value of @p _cookie must be the value
488  * returned from a previous call to BUS_SETUP_INTR().
489  * 
490  * @param _dev          the parent device of @p _child
491  * @param _child        the device which allocated the resource
492  * @param _irq          the resource representing the interrupt
493  * @param _cookie       the cookie value returned when the interrupt
494  *                      was originally registered
495  */
496 METHOD int teardown_intr {
497         device_t        _dev;
498         device_t        _child;
499         struct resource *_irq;
500         void            *_cookie;
501 };
502
503 /**
504  * @brief Define a resource which can be allocated with
505  * BUS_ALLOC_RESOURCE().
506  *
507  * This method is used by some busses (typically ISA) to allow a
508  * driver to describe a resource range that it would like to
509  * allocate. The resource defined by @p _type and @p _rid is defined
510  * to start at @p _start and to include @p _count indices in its
511  * range.
512  * 
513  * @param _dev          the parent device of @p _child
514  * @param _child        the device which owns the resource
515  * @param _type         the type of resource
516  * @param _rid          the resource identifier
517  * @param _start        the start of the resource range
518  * @param _count        the size of the resource range
519  */
520 METHOD int set_resource {
521         device_t        _dev;
522         device_t        _child;
523         int             _type;
524         int             _rid;
525         rman_res_t      _start;
526         rman_res_t      _count;
527 };
528
529 /**
530  * @brief Describe a resource
531  *
532  * This method allows a driver to examine the range used for a given
533  * resource without actually allocating it.
534  * 
535  * @param _dev          the parent device of @p _child
536  * @param _child        the device which owns the resource
537  * @param _type         the type of resource
538  * @param _rid          the resource identifier
539  * @param _start        the address of a location to receive the start
540  *                      index of the resource range
541  * @param _count        the address of a location to receive the size
542  *                      of the resource range
543  */
544 METHOD int get_resource {
545         device_t        _dev;
546         device_t        _child;
547         int             _type;
548         int             _rid;
549         rman_res_t      *_startp;
550         rman_res_t      *_countp;
551 };
552
553 /**
554  * @brief Delete a resource.
555  * 
556  * Use this to delete a resource (possibly one previously added with
557  * BUS_SET_RESOURCE()).
558  * 
559  * @param _dev          the parent device of @p _child
560  * @param _child        the device which owns the resource
561  * @param _type         the type of resource
562  * @param _rid          the resource identifier
563  */
564 METHOD void delete_resource {
565         device_t        _dev;
566         device_t        _child;
567         int             _type;
568         int             _rid;
569 };
570
571 /**
572  * @brief Return a struct resource_list.
573  *
574  * Used by drivers which use bus_generic_rl_alloc_resource() etc. to
575  * implement their resource handling. It should return the resource
576  * list of the given child device.
577  * 
578  * @param _dev          the parent device of @p _child
579  * @param _child        the device which owns the resource list
580  */
581 METHOD struct resource_list * get_resource_list {
582         device_t        _dev;
583         device_t        _child;
584 } DEFAULT bus_generic_get_resource_list;
585
586 /**
587  * @brief Is the hardware described by @p _child still attached to the
588  * system?
589  *
590  * This method should return 0 if the device is not present.  It
591  * should return -1 if it is present.  Any errors in determining
592  * should be returned as a normal errno value.  Client drivers are to
593  * assume that the device is present, even if there is an error
594  * determining if it is there.  Busses are to try to avoid returning
595  * errors, but newcard will return an error if the device fails to
596  * implement this method.
597  * 
598  * @param _dev          the parent device of @p _child
599  * @param _child        the device which is being examined
600  */
601 METHOD int child_present {
602         device_t        _dev;
603         device_t        _child;
604 } DEFAULT bus_generic_child_present;
605
606 /**
607  * @brief Returns the pnp info for this device.
608  *
609  * Return it as a string.  If the storage is insufficient for the
610  * string, then return EOVERFLOW.
611  *
612  * The string must be formatted as a space-separated list of
613  * name=value pairs.  Names may only contain alphanumeric characters,
614  * underscores ('_') and hyphens ('-').  Values can contain any
615  * non-whitespace characters.  Values containing whitespace can be
616  * quoted with double quotes ('"').  Double quotes and backslashes in
617  * quoted values can be escaped with backslashes ('\').
618  * 
619  * @param _dev          the parent device of @p _child
620  * @param _child        the device which is being examined
621  * @param _buf          the address of a buffer to receive the pnp
622  *                      string
623  * @param _buflen       the size of the buffer pointed to by @p _buf
624  */
625 METHOD int child_pnpinfo_str {
626         device_t        _dev;
627         device_t        _child;
628         char            *_buf;
629         size_t          _buflen;
630 };
631
632 /**
633  * @brief Returns the location for this device.
634  *
635  * Return it as a string.  If the storage is insufficient for the
636  * string, then return EOVERFLOW.
637  *
638  * The string must be formatted as a space-separated list of
639  * name=value pairs.  Names may only contain alphanumeric characters,
640  * underscores ('_') and hyphens ('-').  Values can contain any
641  * non-whitespace characters.  Values containing whitespace can be
642  * quoted with double quotes ('"').  Double quotes and backslashes in
643  * quoted values can be escaped with backslashes ('\').
644  *
645  * @param _dev          the parent device of @p _child
646  * @param _child        the device which is being examined
647  * @param _buf          the address of a buffer to receive the location
648  *                      string
649  * @param _buflen       the size of the buffer pointed to by @p _buf
650  */
651 METHOD int child_location_str {
652         device_t        _dev;
653         device_t        _child;
654         char            *_buf;
655         size_t          _buflen;
656 };
657
658 /**
659  * @brief Allow drivers to request that an interrupt be bound to a specific
660  * CPU.
661  * 
662  * @param _dev          the parent device of @p _child
663  * @param _child        the device which allocated the resource
664  * @param _irq          the resource representing the interrupt
665  * @param _cpu          the CPU to bind the interrupt to
666  */
667 METHOD int bind_intr {
668         device_t        _dev;
669         device_t        _child;
670         struct resource *_irq;
671         int             _cpu;
672 } DEFAULT bus_generic_bind_intr;
673
674 /**
675  * @brief Allow (bus) drivers to specify the trigger mode and polarity
676  * of the specified interrupt.
677  * 
678  * @param _dev          the bus device
679  * @param _irq          the interrupt number to modify
680  * @param _trig         the trigger mode required
681  * @param _pol          the interrupt polarity required
682  */
683 METHOD int config_intr {
684         device_t        _dev;
685         int             _irq;
686         enum intr_trigger _trig;
687         enum intr_polarity _pol;
688 } DEFAULT bus_generic_config_intr;
689
690 /**
691  * @brief Allow drivers to associate a description with an active
692  * interrupt handler.
693  *
694  * @param _dev          the parent device of @p _child
695  * @param _child        the device which allocated the resource
696  * @param _irq          the resource representing the interrupt
697  * @param _cookie       the cookie value returned when the interrupt
698  *                      was originally registered
699  * @param _descr        the description to associate with the interrupt
700  */
701 METHOD int describe_intr {
702         device_t        _dev;
703         device_t        _child;
704         struct resource *_irq;
705         void            *_cookie;
706         const char      *_descr;
707 } DEFAULT bus_generic_describe_intr;
708
709 /**
710  * @brief Notify a (bus) driver about a child that the hints mechanism
711  * believes it has discovered.
712  *
713  * The bus is responsible for then adding the child in the right order
714  * and discovering other things about the child.  The bus driver is
715  * free to ignore this hint, to do special things, etc.  It is all up
716  * to the bus driver to interpret.
717  *
718  * This method is only called in response to the parent bus asking for
719  * hinted devices to be enumerated.
720  *
721  * @param _dev          the bus device
722  * @param _dname        the name of the device w/o unit numbers
723  * @param _dunit        the unit number of the device
724  */
725 METHOD void hinted_child {
726         device_t        _dev;
727         const char      *_dname;
728         int             _dunit;
729 };
730
731 /**
732  * @brief Returns bus_dma_tag_t for use w/ devices on the bus.
733  *
734  * @param _dev          the parent device of @p _child
735  * @param _child        the device to which the tag will belong
736  */
737 METHOD bus_dma_tag_t get_dma_tag {
738         device_t        _dev;
739         device_t        _child;
740 } DEFAULT bus_generic_get_dma_tag;
741
742 /**
743  * @brief Returns bus_space_tag_t for use w/ devices on the bus.
744  *
745  * @param _dev          the parent device of @p _child
746  * @param _child        the device to which the tag will belong
747  */
748 METHOD bus_space_tag_t get_bus_tag {
749         device_t        _dev;
750         device_t        _child;
751 } DEFAULT bus_generic_get_bus_tag;
752
753 /**
754  * @brief Allow the bus to determine the unit number of a device.
755  *
756  * @param _dev          the parent device of @p _child
757  * @param _child        the device whose unit is to be wired
758  * @param _name         the name of the device's new devclass
759  * @param _unitp        a pointer to the device's new unit value
760  */
761 METHOD void hint_device_unit {
762         device_t        _dev;
763         device_t        _child;
764         const char      *_name;
765         int             *_unitp;
766 };
767
768 /**
769  * @brief Notify a bus that the bus pass level has been changed
770  *
771  * @param _dev          the bus device
772  */
773 METHOD void new_pass {
774         device_t        _dev;
775 } DEFAULT bus_generic_new_pass;
776
777 /**
778  * @brief Notify a bus that specified child's IRQ should be remapped.
779  *
780  * @param _dev          the bus device
781  * @param _child        the child device
782  * @param _irq          the irq number
783  */
784 METHOD int remap_intr {
785         device_t        _dev;
786         device_t        _child;
787         u_int           _irq;
788 } DEFAULT null_remap_intr;
789
790 /**
791  * @brief Suspend a given child
792  *
793  * @param _dev          the parent device of @p _child
794  * @param _child        the device to suspend
795  */
796 METHOD int suspend_child {
797         device_t        _dev;
798         device_t        _child;
799 } DEFAULT bus_generic_suspend_child;
800
801 /**
802  * @brief Resume a given child
803  *
804  * @param _dev          the parent device of @p _child
805  * @param _child        the device to resume
806  */
807 METHOD int resume_child {
808         device_t        _dev;
809         device_t        _child;
810 } DEFAULT bus_generic_resume_child;
811
812 /**
813  * @brief Get the VM domain handle for the given bus and child.
814  *
815  * @param _dev          the bus device
816  * @param _child        the child device
817  * @param _domain       a pointer to the bus's domain handle identifier
818  */
819 METHOD int get_domain {
820         device_t        _dev;
821         device_t        _child;
822         int             *_domain;
823 } DEFAULT bus_generic_get_domain;
824
825 /**
826  * @brief Request a set of CPUs
827  *
828  * @param _dev          the bus device
829  * @param _child        the child device
830  * @param _op           type of CPUs to request
831  * @param _setsize      the size of the set passed in _cpuset
832  * @param _cpuset       a pointer to a cpuset to receive the requested
833  *                      set of CPUs
834  */
835 METHOD int get_cpus {
836         device_t        _dev;
837         device_t        _child;
838         enum cpu_sets   _op;
839         size_t          _setsize;
840         cpuset_t        *_cpuset;
841 } DEFAULT bus_generic_get_cpus;