]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/bus_if.m
Revert bus_get_cpus() for now.
[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 for instance map a memory region
291  * into the kernel's virtual address space.
292  *
293  * @param _dev          the parent device of @p _child
294  * @param _child        the device which allocated the resource
295  * @param _type         the type of resource
296  * @param _rid          the resource identifier
297  * @param _r            the resource to activate
298  */
299 METHOD int activate_resource {
300         device_t        _dev;
301         device_t        _child;
302         int             _type;
303         int             _rid;
304         struct resource *_r;
305 };
306
307 /**
308  * @brief Deactivate a resource
309  *
310  * Deactivate a resource previously allocated with
311  * BUS_ALLOC_RESOURCE(). This may for instance unmap a memory region
312  * from the kernel's virtual address space.
313  *
314  * @param _dev          the parent device of @p _child
315  * @param _child        the device which allocated the resource
316  * @param _type         the type of resource
317  * @param _rid          the resource identifier
318  * @param _r            the resource to deactivate
319  */
320 METHOD int deactivate_resource {
321         device_t        _dev;
322         device_t        _child;
323         int             _type;
324         int             _rid;
325         struct resource *_r;
326 };
327
328 /**
329  * @brief Adjust a resource
330  *
331  * Adjust the start and/or end of a resource allocated by
332  * BUS_ALLOC_RESOURCE.  At least part of the new address range must overlap
333  * with the existing address range.  If the successful, the resource's range
334  * will be adjusted to [start, end] on return.
335  *
336  * @param _dev          the parent device of @p _child
337  * @param _child        the device which allocated the resource
338  * @param _type         the type of resource
339  * @param _res          the resource to adjust
340  * @param _start        the new starting address of the resource range
341  * @param _end          the new ending address of the resource range
342  */
343 METHOD int adjust_resource {
344         device_t        _dev;
345         device_t        _child;
346         int             _type;
347         struct resource *_res;
348         rman_res_t      _start;
349         rman_res_t      _end;
350 };
351
352 /**
353  * @brief Release a resource
354  *
355  * Free a resource allocated by the BUS_ALLOC_RESOURCE.  The @p _rid
356  * value must be the same as the one returned by BUS_ALLOC_RESOURCE()
357  * (which is not necessarily the same as the one the client passed).
358  *
359  * @param _dev          the parent device of @p _child
360  * @param _child        the device which allocated the resource
361  * @param _type         the type of resource
362  * @param _rid          the resource identifier
363  * @param _r            the resource to release
364  */
365 METHOD int release_resource {
366         device_t        _dev;
367         device_t        _child;
368         int             _type;
369         int             _rid;
370         struct resource *_res;
371 };
372
373 /**
374  * @brief Install an interrupt handler
375  *
376  * This method is used to associate an interrupt handler function with
377  * an irq resource. When the interrupt triggers, the function @p _intr
378  * will be called with the value of @p _arg as its single
379  * argument. The value returned in @p *_cookiep is used to cancel the
380  * interrupt handler - the caller should save this value to use in a
381  * future call to BUS_TEARDOWN_INTR().
382  * 
383  * @param _dev          the parent device of @p _child
384  * @param _child        the device which allocated the resource
385  * @param _irq          the resource representing the interrupt
386  * @param _flags        a set of bits from enum intr_type specifying
387  *                      the class of interrupt
388  * @param _intr         the function to call when the interrupt
389  *                      triggers
390  * @param _arg          a value to use as the single argument in calls
391  *                      to @p _intr
392  * @param _cookiep      a pointer to a location to receive a cookie
393  *                      value that may be used to remove the interrupt
394  *                      handler
395  */
396 METHOD int setup_intr {
397         device_t        _dev;
398         device_t        _child;
399         struct resource *_irq;
400         int             _flags;
401         driver_filter_t *_filter;
402         driver_intr_t   *_intr;
403         void            *_arg;
404         void            **_cookiep;
405 };
406
407 /**
408  * @brief Uninstall an interrupt handler
409  *
410  * This method is used to disassociate an interrupt handler function
411  * with an irq resource. The value of @p _cookie must be the value
412  * returned from a previous call to BUS_SETUP_INTR().
413  * 
414  * @param _dev          the parent device of @p _child
415  * @param _child        the device which allocated the resource
416  * @param _irq          the resource representing the interrupt
417  * @param _cookie       the cookie value returned when the interrupt
418  *                      was originally registered
419  */
420 METHOD int teardown_intr {
421         device_t        _dev;
422         device_t        _child;
423         struct resource *_irq;
424         void            *_cookie;
425 };
426
427 /**
428  * @brief Define a resource which can be allocated with
429  * BUS_ALLOC_RESOURCE().
430  *
431  * This method is used by some busses (typically ISA) to allow a
432  * driver to describe a resource range that it would like to
433  * allocate. The resource defined by @p _type and @p _rid is defined
434  * to start at @p _start and to include @p _count indices in its
435  * range.
436  * 
437  * @param _dev          the parent device of @p _child
438  * @param _child        the device which owns the resource
439  * @param _type         the type of resource
440  * @param _rid          the resource identifier
441  * @param _start        the start of the resource range
442  * @param _count        the size of the resource range
443  */
444 METHOD int set_resource {
445         device_t        _dev;
446         device_t        _child;
447         int             _type;
448         int             _rid;
449         rman_res_t      _start;
450         rman_res_t      _count;
451 };
452
453 /**
454  * @brief Describe a resource
455  *
456  * This method allows a driver to examine the range used for a given
457  * resource without actually allocating it.
458  * 
459  * @param _dev          the parent device of @p _child
460  * @param _child        the device which owns the resource
461  * @param _type         the type of resource
462  * @param _rid          the resource identifier
463  * @param _start        the address of a location to receive the start
464  *                      index of the resource range
465  * @param _count        the address of a location to receive the size
466  *                      of the resource range
467  */
468 METHOD int get_resource {
469         device_t        _dev;
470         device_t        _child;
471         int             _type;
472         int             _rid;
473         rman_res_t      *_startp;
474         rman_res_t      *_countp;
475 };
476
477 /**
478  * @brief Delete a resource.
479  * 
480  * Use this to delete a resource (possibly one previously added with
481  * BUS_SET_RESOURCE()).
482  * 
483  * @param _dev          the parent device of @p _child
484  * @param _child        the device which owns the resource
485  * @param _type         the type of resource
486  * @param _rid          the resource identifier
487  */
488 METHOD void delete_resource {
489         device_t        _dev;
490         device_t        _child;
491         int             _type;
492         int             _rid;
493 };
494
495 /**
496  * @brief Return a struct resource_list.
497  *
498  * Used by drivers which use bus_generic_rl_alloc_resource() etc. to
499  * implement their resource handling. It should return the resource
500  * list of the given child device.
501  * 
502  * @param _dev          the parent device of @p _child
503  * @param _child        the device which owns the resource list
504  */
505 METHOD struct resource_list * get_resource_list {
506         device_t        _dev;
507         device_t        _child;
508 } DEFAULT bus_generic_get_resource_list;
509
510 /**
511  * @brief Is the hardware described by @p _child still attached to the
512  * system?
513  *
514  * This method should return 0 if the device is not present.  It
515  * should return -1 if it is present.  Any errors in determining
516  * should be returned as a normal errno value.  Client drivers are to
517  * assume that the device is present, even if there is an error
518  * determining if it is there.  Busses are to try to avoid returning
519  * errors, but newcard will return an error if the device fails to
520  * implement this method.
521  * 
522  * @param _dev          the parent device of @p _child
523  * @param _child        the device which is being examined
524  */
525 METHOD int child_present {
526         device_t        _dev;
527         device_t        _child;
528 } DEFAULT bus_generic_child_present;
529
530 /**
531  * @brief Returns the pnp info for this device.
532  *
533  * Return it as a string.  If the string is insufficient for the
534  * storage, then return EOVERFLOW.
535  * 
536  * @param _dev          the parent device of @p _child
537  * @param _child        the device which is being examined
538  * @param _buf          the address of a buffer to receive the pnp
539  *                      string
540  * @param _buflen       the size of the buffer pointed to by @p _buf
541  */
542 METHOD int child_pnpinfo_str {
543         device_t        _dev;
544         device_t        _child;
545         char            *_buf;
546         size_t          _buflen;
547 };
548
549 /**
550  * @brief Returns the location for this device.
551  *
552  * Return it as a string.  If the string is insufficient for the
553  * storage, then return EOVERFLOW.
554  * 
555  * @param _dev          the parent device of @p _child
556  * @param _child        the device which is being examined
557  * @param _buf          the address of a buffer to receive the location
558  *                      string
559  * @param _buflen       the size of the buffer pointed to by @p _buf
560  */
561 METHOD int child_location_str {
562         device_t        _dev;
563         device_t        _child;
564         char            *_buf;
565         size_t          _buflen;
566 };
567
568 /**
569  * @brief Allow drivers to request that an interrupt be bound to a specific
570  * CPU.
571  * 
572  * @param _dev          the parent device of @p _child
573  * @param _child        the device which allocated the resource
574  * @param _irq          the resource representing the interrupt
575  * @param _cpu          the CPU to bind the interrupt to
576  */
577 METHOD int bind_intr {
578         device_t        _dev;
579         device_t        _child;
580         struct resource *_irq;
581         int             _cpu;
582 } DEFAULT bus_generic_bind_intr;
583
584 /**
585  * @brief Allow (bus) drivers to specify the trigger mode and polarity
586  * of the specified interrupt.
587  * 
588  * @param _dev          the bus device
589  * @param _irq          the interrupt number to modify
590  * @param _trig         the trigger mode required
591  * @param _pol          the interrupt polarity required
592  */
593 METHOD int config_intr {
594         device_t        _dev;
595         int             _irq;
596         enum intr_trigger _trig;
597         enum intr_polarity _pol;
598 } DEFAULT bus_generic_config_intr;
599
600 /**
601  * @brief Allow drivers to associate a description with an active
602  * interrupt handler.
603  *
604  * @param _dev          the parent device of @p _child
605  * @param _child        the device which allocated the resource
606  * @param _irq          the resource representing the interrupt
607  * @param _cookie       the cookie value returned when the interrupt
608  *                      was originally registered
609  * @param _descr        the description to associate with the interrupt
610  */
611 METHOD int describe_intr {
612         device_t        _dev;
613         device_t        _child;
614         struct resource *_irq;
615         void            *_cookie;
616         const char      *_descr;
617 } DEFAULT bus_generic_describe_intr;
618
619 /**
620  * @brief Notify a (bus) driver about a child that the hints mechanism
621  * believes it has discovered.
622  *
623  * The bus is responsible for then adding the child in the right order
624  * and discovering other things about the child.  The bus driver is
625  * free to ignore this hint, to do special things, etc.  It is all up
626  * to the bus driver to interpret.
627  *
628  * This method is only called in response to the parent bus asking for
629  * hinted devices to be enumerated.
630  *
631  * @param _dev          the bus device
632  * @param _dname        the name of the device w/o unit numbers
633  * @param _dunit        the unit number of the device
634  */
635 METHOD void hinted_child {
636         device_t        _dev;
637         const char      *_dname;
638         int             _dunit;
639 };
640
641 /**
642  * @brief Returns bus_dma_tag_t for use w/ devices on the bus.
643  *
644  * @param _dev          the parent device of @p _child
645  * @param _child        the device to which the tag will belong
646  */
647 METHOD bus_dma_tag_t get_dma_tag {
648         device_t        _dev;
649         device_t        _child;
650 } DEFAULT bus_generic_get_dma_tag;
651
652 /**
653  * @brief Returns bus_space_tag_t for use w/ devices on the bus.
654  *
655  * @param _dev          the parent device of @p _child
656  * @param _child        the device to which the tag will belong
657  */
658 METHOD bus_space_tag_t get_bus_tag {
659         device_t        _dev;
660         device_t        _child;
661 } DEFAULT bus_generic_get_bus_tag;
662
663 /**
664  * @brief Allow the bus to determine the unit number of a device.
665  *
666  * @param _dev          the parent device of @p _child
667  * @param _child        the device whose unit is to be wired
668  * @param _name         the name of the device's new devclass
669  * @param _unitp        a pointer to the device's new unit value
670  */
671 METHOD void hint_device_unit {
672         device_t        _dev;
673         device_t        _child;
674         const char      *_name;
675         int             *_unitp;
676 };
677
678 /**
679  * @brief Notify a bus that the bus pass level has been changed
680  *
681  * @param _dev          the bus device
682  */
683 METHOD void new_pass {
684         device_t        _dev;
685 } DEFAULT bus_generic_new_pass;
686
687 /**
688  * @brief Notify a bus that specified child's IRQ should be remapped.
689  *
690  * @param _dev          the bus device
691  * @param _child        the child device
692  * @param _irq          the irq number
693  */
694 METHOD int remap_intr {
695         device_t        _dev;
696         device_t        _child;
697         u_int           _irq;
698 } DEFAULT null_remap_intr;
699
700 /**
701  * @brief Suspend a given child
702  *
703  * @param _dev          the parent device of @p _child
704  * @param _child        the device to suspend
705  */
706 METHOD int suspend_child {
707         device_t        _dev;
708         device_t        _child;
709 } DEFAULT bus_generic_suspend_child;
710
711 /**
712  * @brief Resume a given child
713  *
714  * @param _dev          the parent device of @p _child
715  * @param _child        the device to resume
716  */
717 METHOD int resume_child {
718         device_t        _dev;
719         device_t        _child;
720 } DEFAULT bus_generic_resume_child;
721
722 /**
723  * @brief Get the VM domain handle for the given bus and child.
724  *
725  * @param _dev          the bus device
726  * @param _child        the child device
727  * @param _domain       a pointer to the bus's domain handle identifier
728  */
729 METHOD int get_domain {
730         device_t        _dev;
731         device_t        _child;
732         int             *_domain;
733 } DEFAULT bus_generic_get_domain;