]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/sys/bus.h
x86: Speed up clock calibration
[FreeBSD/FreeBSD.git] / sys / sys / bus.h
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1997,1998,2003 Doug Rabson
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30
31 #ifndef _SYS_BUS_H_
32 #define _SYS_BUS_H_
33
34 #include <machine/_limits.h>
35 #include <machine/_bus.h>
36 #include <sys/_bus_dma.h>
37 #include <sys/ioccom.h>
38
39 /**
40  * @defgroup NEWBUS newbus - a generic framework for managing devices
41  * @{
42  */
43
44 /**
45  * @brief Interface information structure.
46  */
47 struct u_businfo {
48         int     ub_version;             /**< @brief interface version */
49 #define BUS_USER_VERSION        2
50         int     ub_generation;          /**< @brief generation count */
51 };
52
53 /**
54  * @brief State of the device.
55  */
56 typedef enum device_state {
57         DS_NOTPRESENT = 10,             /**< @brief not probed or probe failed */
58         DS_ALIVE = 20,                  /**< @brief probe succeeded */
59         DS_ATTACHING = 25,              /**< @brief currently attaching */
60         DS_ATTACHED = 30,               /**< @brief attach method called */
61         DS_BUSY = 40                    /**< @brief device is open */
62 } device_state_t;
63
64 /**
65  * @brief Device information exported to userspace.
66  * The strings are placed one after the other, separated by NUL characters.
67  * Fields should be added after the last one and order maintained for compatibility
68  */
69 #define BUS_USER_BUFFER         (3*1024)
70 struct u_device {
71         uintptr_t       dv_handle;
72         uintptr_t       dv_parent;
73         uint32_t        dv_devflags;            /**< @brief API Flags for device */
74         uint16_t        dv_flags;               /**< @brief flags for dev state */
75         device_state_t  dv_state;               /**< @brief State of attachment */
76         char            dv_fields[BUS_USER_BUFFER]; /**< @brief NUL terminated fields */
77         /* name (name of the device in tree) */
78         /* desc (driver description) */
79         /* drivername (Name of driver without unit number) */
80         /* pnpinfo (Plug and play information from bus) */
81         /* location (Location of device on parent */
82         /* NUL */
83 };
84
85 /* Flags exported via dv_flags. */
86 #define DF_ENABLED      0x01            /* device should be probed/attached */
87 #define DF_FIXEDCLASS   0x02            /* devclass specified at create time */
88 #define DF_WILDCARD     0x04            /* unit was originally wildcard */
89 #define DF_DESCMALLOCED 0x08            /* description was malloced */
90 #define DF_QUIET        0x10            /* don't print verbose attach message */
91 #define DF_DONENOMATCH  0x20            /* don't execute DEVICE_NOMATCH again */
92 #define DF_EXTERNALSOFTC 0x40           /* softc not allocated by us */
93 #define DF_SUSPENDED    0x100           /* Device is suspended. */
94 #define DF_QUIET_CHILDREN 0x200         /* Default to quiet for all my children */
95 #define DF_ATTACHED_ONCE 0x400          /* Has been attached at least once */
96 #define DF_NEEDNOMATCH  0x800           /* Has a pending NOMATCH event */
97
98 /**
99  * @brief Device request structure used for ioctl's.
100  *
101  * Used for ioctl's on /dev/devctl2.  All device ioctl's
102  * must have parameter definitions which begin with dr_name.
103  */
104 struct devreq_buffer {
105         void    *buffer;
106         size_t  length;
107 };
108
109 struct devreq {
110         char            dr_name[128];
111         int             dr_flags;               /* request-specific flags */
112         union {
113                 struct devreq_buffer dru_buffer;
114                 void    *dru_data;
115         } dr_dru;
116 #define dr_buffer       dr_dru.dru_buffer       /* variable-sized buffer */
117 #define dr_data         dr_dru.dru_data         /* fixed-size buffer */
118 };
119
120 #define DEV_ATTACH      _IOW('D', 1, struct devreq)
121 #define DEV_DETACH      _IOW('D', 2, struct devreq)
122 #define DEV_ENABLE      _IOW('D', 3, struct devreq)
123 #define DEV_DISABLE     _IOW('D', 4, struct devreq)
124 #define DEV_SUSPEND     _IOW('D', 5, struct devreq)
125 #define DEV_RESUME      _IOW('D', 6, struct devreq)
126 #define DEV_SET_DRIVER  _IOW('D', 7, struct devreq)
127 #define DEV_CLEAR_DRIVER _IOW('D', 8, struct devreq)
128 #define DEV_RESCAN      _IOW('D', 9, struct devreq)
129 #define DEV_DELETE      _IOW('D', 10, struct devreq)
130 #define DEV_FREEZE      _IOW('D', 11, struct devreq)
131 #define DEV_THAW        _IOW('D', 12, struct devreq)
132 #define DEV_RESET       _IOW('D', 13, struct devreq)
133
134 /* Flags for DEV_DETACH and DEV_DISABLE. */
135 #define DEVF_FORCE_DETACH       0x0000001
136
137 /* Flags for DEV_SET_DRIVER. */
138 #define DEVF_SET_DRIVER_DETACH  0x0000001       /* Detach existing driver. */
139
140 /* Flags for DEV_CLEAR_DRIVER. */
141 #define DEVF_CLEAR_DRIVER_DETACH 0x0000001      /* Detach existing driver. */
142
143 /* Flags for DEV_DELETE. */
144 #define DEVF_FORCE_DELETE       0x0000001
145
146 /* Flags for DEV_RESET */
147 #define DEVF_RESET_DETACH       0x0000001       /* Detach drivers vs suspend
148                                                    device */
149
150 #ifdef _KERNEL
151
152 #include <sys/_eventhandler.h>
153 #include <sys/kobj.h>
154 #include <sys/systm.h>
155 #include <sys/devctl.h>
156
157 /**
158  * Device name parsers.  Hook to allow device enumerators to map
159  * scheme-specific names to a device.
160  */
161 typedef void (*dev_lookup_fn)(void *arg, const char *name,
162     device_t *result);
163 EVENTHANDLER_DECLARE(dev_lookup, dev_lookup_fn);
164
165 /**
166  * @brief A device driver (included mainly for compatibility with
167  * FreeBSD 4.x).
168  */
169 typedef struct kobj_class       driver_t;
170
171 /**
172  * @brief A device class
173  *
174  * The devclass object has two main functions in the system. The first
175  * is to manage the allocation of unit numbers for device instances
176  * and the second is to hold the list of device drivers for a
177  * particular bus type. Each devclass has a name and there cannot be
178  * two devclasses with the same name. This ensures that unique unit
179  * numbers are allocated to device instances.
180  *
181  * Drivers that support several different bus attachments (e.g. isa,
182  * pci, pccard) should all use the same devclass to ensure that unit
183  * numbers do not conflict.
184  *
185  * Each devclass may also have a parent devclass. This is used when
186  * searching for device drivers to allow a form of inheritance. When
187  * matching drivers with devices, first the driver list of the parent
188  * device's devclass is searched. If no driver is found in that list,
189  * the search continues in the parent devclass (if any).
190  */
191 typedef struct devclass         *devclass_t;
192
193 /**
194  * @brief A device method
195  */
196 #define device_method_t         kobj_method_t
197
198 /**
199  * @brief Driver interrupt filter return values
200  *
201  * If a driver provides an interrupt filter routine it must return an
202  * integer consisting of oring together zero or more of the following
203  * flags:
204  *
205  *      FILTER_STRAY    - this device did not trigger the interrupt
206  *      FILTER_HANDLED  - the interrupt has been fully handled and can be EOId
207  *      FILTER_SCHEDULE_THREAD - the threaded interrupt handler should be
208  *                        scheduled to execute
209  *
210  * If the driver does not provide a filter, then the interrupt code will
211  * act is if the filter had returned FILTER_SCHEDULE_THREAD.  Note that it
212  * is illegal to specify any other flag with FILTER_STRAY and that it is
213  * illegal to not specify either of FILTER_HANDLED or FILTER_SCHEDULE_THREAD
214  * if FILTER_STRAY is not specified.
215  */
216 #define FILTER_STRAY            0x01
217 #define FILTER_HANDLED          0x02
218 #define FILTER_SCHEDULE_THREAD  0x04
219
220 /**
221  * @brief Driver interrupt service routines
222  *
223  * The filter routine is run in primary interrupt context and may not
224  * block or use regular mutexes.  It may only use spin mutexes for
225  * synchronization.  The filter may either completely handle the
226  * interrupt or it may perform some of the work and defer more
227  * expensive work to the regular interrupt handler.  If a filter
228  * routine is not registered by the driver, then the regular interrupt
229  * handler is always used to handle interrupts from this device.
230  *
231  * The regular interrupt handler executes in its own thread context
232  * and may use regular mutexes.  However, it is prohibited from
233  * sleeping on a sleep queue.
234  */
235 typedef int driver_filter_t(void*);
236 typedef void driver_intr_t(void*);
237
238 /**
239  * @brief Interrupt type bits.
240  * 
241  * These flags are used both by newbus interrupt
242  * registration (nexus.c) and also in struct intrec, which defines
243  * interrupt properties.
244  *
245  * XXX We should probably revisit this and remove the vestiges of the
246  * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
247  * confuse things by renaming them (Grog, 18 July 2000).
248  *
249  * Buses which do interrupt remapping will want to change their type
250  * to reflect what sort of devices are underneath.
251  */
252 enum intr_type {
253         INTR_TYPE_TTY = 1,
254         INTR_TYPE_BIO = 2,
255         INTR_TYPE_NET = 4,
256         INTR_TYPE_CAM = 8,
257         INTR_TYPE_MISC = 16,
258         INTR_TYPE_CLK = 32,
259         INTR_TYPE_AV = 64,
260         INTR_EXCL = 256,                /* exclusive interrupt */
261         INTR_MPSAFE = 512,              /* this interrupt is SMP safe */
262         INTR_ENTROPY = 1024,            /* this interrupt provides entropy */
263         INTR_MD1 = 4096,                /* flag reserved for MD use */
264         INTR_MD2 = 8192,                /* flag reserved for MD use */
265         INTR_MD3 = 16384,               /* flag reserved for MD use */
266         INTR_MD4 = 32768                /* flag reserved for MD use */
267 };
268
269 enum intr_trigger {
270         INTR_TRIGGER_INVALID = -1,
271         INTR_TRIGGER_CONFORM = 0,
272         INTR_TRIGGER_EDGE = 1,
273         INTR_TRIGGER_LEVEL = 2
274 };
275
276 enum intr_polarity {
277         INTR_POLARITY_CONFORM = 0,
278         INTR_POLARITY_HIGH = 1,
279         INTR_POLARITY_LOW = 2
280 };
281
282 /**
283  * CPU sets supported by bus_get_cpus().  Note that not all sets may be
284  * supported for a given device.  If a request is not supported by a
285  * device (or its parents), then bus_get_cpus() will fail with EINVAL.
286  */
287 enum cpu_sets {
288         LOCAL_CPUS = 0,
289         INTR_CPUS
290 };
291
292 typedef int (*devop_t)(void);
293
294 /**
295  * @brief This structure is deprecated.
296  *
297  * Use the kobj(9) macro DEFINE_CLASS to
298  * declare classes which implement device drivers.
299  */
300 struct driver {
301         KOBJ_CLASS_FIELDS;
302 };
303
304 /**
305  * @brief A resource mapping.
306  */
307 struct resource_map {
308         bus_space_tag_t r_bustag;
309         bus_space_handle_t r_bushandle;
310         bus_size_t r_size;
311         void    *r_vaddr;
312 };
313
314 /**
315  * @brief Optional properties of a resource mapping request.
316  */
317 struct resource_map_request {
318         size_t  size;
319         rman_res_t offset;
320         rman_res_t length;
321         vm_memattr_t memattr;
322 };
323
324 void    resource_init_map_request_impl(struct resource_map_request *_args,
325             size_t _sz);
326 #define resource_init_map_request(rmr)                                  \
327         resource_init_map_request_impl((rmr), sizeof(*(rmr)))
328
329 /*
330  * Definitions for drivers which need to keep simple lists of resources
331  * for their child devices.
332  */
333 struct  resource;
334
335 /**
336  * @brief An entry for a single resource in a resource list.
337  */
338 struct resource_list_entry {
339         STAILQ_ENTRY(resource_list_entry) link;
340         int     type;                   /**< @brief type argument to alloc_resource */
341         int     rid;                    /**< @brief resource identifier */
342         int     flags;                  /**< @brief resource flags */
343         struct  resource *res;          /**< @brief the real resource when allocated */
344         rman_res_t      start;          /**< @brief start of resource range */
345         rman_res_t      end;            /**< @brief end of resource range */
346         rman_res_t      count;                  /**< @brief count within range */
347 };
348 STAILQ_HEAD(resource_list, resource_list_entry);
349
350 #define RLE_RESERVED            0x0001  /* Reserved by the parent bus. */
351 #define RLE_ALLOCATED           0x0002  /* Reserved resource is allocated. */
352 #define RLE_PREFETCH            0x0004  /* Resource is a prefetch range. */
353
354 void    resource_list_init(struct resource_list *rl);
355 void    resource_list_free(struct resource_list *rl);
356 struct resource_list_entry *
357         resource_list_add(struct resource_list *rl,
358                           int type, int rid,
359                           rman_res_t start, rman_res_t end, rman_res_t count);
360 int     resource_list_add_next(struct resource_list *rl,
361                           int type,
362                           rman_res_t start, rman_res_t end, rman_res_t count);
363 int     resource_list_busy(struct resource_list *rl,
364                            int type, int rid);
365 int     resource_list_reserved(struct resource_list *rl, int type, int rid);
366 struct resource_list_entry*
367         resource_list_find(struct resource_list *rl,
368                            int type, int rid);
369 void    resource_list_delete(struct resource_list *rl,
370                              int type, int rid);
371 struct resource *
372         resource_list_alloc(struct resource_list *rl,
373                             device_t bus, device_t child,
374                             int type, int *rid,
375                             rman_res_t start, rman_res_t end,
376                             rman_res_t count, u_int flags);
377 int     resource_list_release(struct resource_list *rl,
378                               device_t bus, device_t child,
379                               int type, int rid, struct resource *res);
380 int     resource_list_release_active(struct resource_list *rl,
381                                      device_t bus, device_t child,
382                                      int type);
383 struct resource *
384         resource_list_reserve(struct resource_list *rl,
385                               device_t bus, device_t child,
386                               int type, int *rid,
387                               rman_res_t start, rman_res_t end,
388                               rman_res_t count, u_int flags);
389 int     resource_list_unreserve(struct resource_list *rl,
390                                 device_t bus, device_t child,
391                                 int type, int rid);
392 void    resource_list_purge(struct resource_list *rl);
393 int     resource_list_print_type(struct resource_list *rl,
394                                  const char *name, int type,
395                                  const char *format);
396
397 /*
398  * The root bus, to which all top-level buses are attached.
399  */
400 extern device_t root_bus;
401 extern devclass_t root_devclass;
402 void    root_bus_configure(void);
403
404 /*
405  * Useful functions for implementing buses.
406  */
407
408 struct _cpuset;
409
410 int     bus_generic_activate_resource(device_t dev, device_t child, int type,
411                                       int rid, struct resource *r);
412 device_t
413         bus_generic_add_child(device_t dev, u_int order, const char *name,
414                               int unit);
415 int     bus_generic_adjust_resource(device_t bus, device_t child, int type,
416                                     struct resource *r, rman_res_t start,
417                                     rman_res_t end);
418 struct resource *
419         bus_generic_alloc_resource(device_t bus, device_t child, int type,
420                                    int *rid, rman_res_t start, rman_res_t end,
421                                    rman_res_t count, u_int flags);
422 int     bus_generic_translate_resource(device_t dev, int type, rman_res_t start,
423                               rman_res_t *newstart);
424 int     bus_generic_attach(device_t dev);
425 int     bus_generic_bind_intr(device_t dev, device_t child,
426                               struct resource *irq, int cpu);
427 int     bus_generic_child_present(device_t dev, device_t child);
428 int     bus_generic_config_intr(device_t, int, enum intr_trigger,
429                                 enum intr_polarity);
430 int     bus_generic_describe_intr(device_t dev, device_t child,
431                                   struct resource *irq, void *cookie,
432                                   const char *descr);
433 int     bus_generic_deactivate_resource(device_t dev, device_t child, int type,
434                                         int rid, struct resource *r);
435 int     bus_generic_detach(device_t dev);
436 void    bus_generic_driver_added(device_t dev, driver_t *driver);
437 int     bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
438                              size_t setsize, struct _cpuset *cpuset);
439 bus_dma_tag_t
440         bus_generic_get_dma_tag(device_t dev, device_t child);
441 bus_space_tag_t
442         bus_generic_get_bus_tag(device_t dev, device_t child);
443 int     bus_generic_get_domain(device_t dev, device_t child, int *domain);
444 struct resource_list *
445         bus_generic_get_resource_list (device_t, device_t);
446 int     bus_generic_map_resource(device_t dev, device_t child, int type,
447                                  struct resource *r,
448                                  struct resource_map_request *args,
449                                  struct resource_map *map);
450 void    bus_generic_new_pass(device_t dev);
451 int     bus_print_child_header(device_t dev, device_t child);
452 int     bus_print_child_domain(device_t dev, device_t child);
453 int     bus_print_child_footer(device_t dev, device_t child);
454 int     bus_generic_print_child(device_t dev, device_t child);
455 int     bus_generic_probe(device_t dev);
456 int     bus_generic_read_ivar(device_t dev, device_t child, int which,
457                               uintptr_t *result);
458 int     bus_generic_release_resource(device_t bus, device_t child,
459                                      int type, int rid, struct resource *r);
460 int     bus_generic_resume(device_t dev);
461 int     bus_generic_resume_child(device_t dev, device_t child);
462 int     bus_generic_setup_intr(device_t dev, device_t child,
463                                struct resource *irq, int flags,
464                                driver_filter_t *filter, driver_intr_t *intr, 
465                                void *arg, void **cookiep);
466
467 struct resource *
468         bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
469                                        rman_res_t, rman_res_t, rman_res_t, u_int);
470 void    bus_generic_rl_delete_resource (device_t, device_t, int, int);
471 int     bus_generic_rl_get_resource (device_t, device_t, int, int, rman_res_t *,
472                                      rman_res_t *);
473 int     bus_generic_rl_set_resource (device_t, device_t, int, int, rman_res_t,
474                                      rman_res_t);
475 int     bus_generic_rl_release_resource (device_t, device_t, int, int,
476                                          struct resource *);
477
478 int     bus_generic_shutdown(device_t dev);
479 int     bus_generic_suspend(device_t dev);
480 int     bus_generic_suspend_child(device_t dev, device_t child);
481 int     bus_generic_teardown_intr(device_t dev, device_t child,
482                                   struct resource *irq, void *cookie);
483 int     bus_generic_suspend_intr(device_t dev, device_t child,
484                                   struct resource *irq);
485 int     bus_generic_resume_intr(device_t dev, device_t child,
486                                   struct resource *irq);
487 int     bus_generic_unmap_resource(device_t dev, device_t child, int type,
488                                    struct resource *r,
489                                    struct resource_map *map);
490 int     bus_generic_write_ivar(device_t dev, device_t child, int which,
491                                uintptr_t value);
492 int     bus_helper_reset_post(device_t dev, int flags);
493 int     bus_helper_reset_prepare(device_t dev, int flags);
494 int     bus_null_rescan(device_t dev);
495
496 /*
497  * Wrapper functions for the BUS_*_RESOURCE methods to make client code
498  * a little simpler.
499  */
500
501 struct resource_spec {
502         int     type;
503         int     rid;
504         int     flags;
505 };
506 #define RESOURCE_SPEC_END       {-1, 0, 0}
507
508 int     bus_alloc_resources(device_t dev, struct resource_spec *rs,
509                             struct resource **res);
510 void    bus_release_resources(device_t dev, const struct resource_spec *rs,
511                               struct resource **res);
512
513 int     bus_adjust_resource(device_t child, int type, struct resource *r,
514                             rman_res_t start, rman_res_t end);
515 struct  resource *bus_alloc_resource(device_t dev, int type, int *rid,
516                                      rman_res_t start, rman_res_t end,
517                                      rman_res_t count, u_int flags);
518 int     bus_activate_resource(device_t dev, int type, int rid,
519                               struct resource *r);
520 int     bus_deactivate_resource(device_t dev, int type, int rid,
521                                 struct resource *r);
522 int     bus_map_resource(device_t dev, int type, struct resource *r,
523                          struct resource_map_request *args,
524                          struct resource_map *map);
525 int     bus_unmap_resource(device_t dev, int type, struct resource *r,
526                            struct resource_map *map);
527 int     bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize,
528                      struct _cpuset *cpuset);
529 bus_dma_tag_t bus_get_dma_tag(device_t dev);
530 bus_space_tag_t bus_get_bus_tag(device_t dev);
531 int     bus_get_domain(device_t dev, int *domain);
532 int     bus_release_resource(device_t dev, int type, int rid,
533                              struct resource *r);
534 int     bus_free_resource(device_t dev, int type, struct resource *r);
535 int     bus_setup_intr(device_t dev, struct resource *r, int flags,
536                        driver_filter_t filter, driver_intr_t handler, 
537                        void *arg, void **cookiep);
538 int     bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
539 int     bus_suspend_intr(device_t dev, struct resource *r);
540 int     bus_resume_intr(device_t dev, struct resource *r);
541 int     bus_bind_intr(device_t dev, struct resource *r, int cpu);
542 int     bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
543                           const char *fmt, ...) __printflike(4, 5);
544 int     bus_set_resource(device_t dev, int type, int rid,
545                          rman_res_t start, rman_res_t count);
546 int     bus_get_resource(device_t dev, int type, int rid,
547                          rman_res_t *startp, rman_res_t *countp);
548 rman_res_t      bus_get_resource_start(device_t dev, int type, int rid);
549 rman_res_t      bus_get_resource_count(device_t dev, int type, int rid);
550 void    bus_delete_resource(device_t dev, int type, int rid);
551 int     bus_child_present(device_t child);
552 int     bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
553 int     bus_child_location_str(device_t child, char *buf, size_t buflen);
554 void    bus_enumerate_hinted_children(device_t bus);
555 int     bus_delayed_attach_children(device_t bus);
556
557 static __inline struct resource *
558 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
559 {
560         return (bus_alloc_resource(dev, type, rid, 0, ~0, 1, flags));
561 }
562
563 static __inline struct resource *
564 bus_alloc_resource_anywhere(device_t dev, int type, int *rid,
565     rman_res_t count, u_int flags)
566 {
567         return (bus_alloc_resource(dev, type, rid, 0, ~0, count, flags));
568 }
569
570 /*
571  * Access functions for device.
572  */
573 device_t        device_add_child(device_t dev, const char *name, int unit);
574 device_t        device_add_child_ordered(device_t dev, u_int order,
575                                          const char *name, int unit);
576 void    device_busy(device_t dev);
577 int     device_delete_child(device_t dev, device_t child);
578 int     device_delete_children(device_t dev);
579 int     device_attach(device_t dev);
580 int     device_detach(device_t dev);
581 void    device_disable(device_t dev);
582 void    device_enable(device_t dev);
583 device_t        device_find_child(device_t dev, const char *classname,
584                                   int unit);
585 const char      *device_get_desc(device_t dev);
586 devclass_t      device_get_devclass(device_t dev);
587 driver_t        *device_get_driver(device_t dev);
588 u_int32_t       device_get_flags(device_t dev);
589 device_t        device_get_parent(device_t dev);
590 int     device_get_children(device_t dev, device_t **listp, int *countp);
591 void    *device_get_ivars(device_t dev);
592 void    device_set_ivars(device_t dev, void *ivars);
593 const   char *device_get_name(device_t dev);
594 const   char *device_get_nameunit(device_t dev);
595 void    *device_get_softc(device_t dev);
596 device_state_t  device_get_state(device_t dev);
597 int     device_get_unit(device_t dev);
598 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
599 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
600 int     device_has_quiet_children(device_t dev);
601 int     device_is_alive(device_t dev);  /* did probe succeed? */
602 int     device_is_attached(device_t dev);       /* did attach succeed? */
603 int     device_is_enabled(device_t dev);
604 int     device_is_suspended(device_t dev);
605 int     device_is_quiet(device_t dev);
606 device_t device_lookup_by_name(const char *name);
607 int     device_print_prettyname(device_t dev);
608 int     device_printf(device_t dev, const char *, ...) __printflike(2, 3);
609 int     device_probe(device_t dev);
610 int     device_probe_and_attach(device_t dev);
611 int     device_probe_child(device_t bus, device_t dev);
612 int     device_quiesce(device_t dev);
613 void    device_quiet(device_t dev);
614 void    device_quiet_children(device_t dev);
615 void    device_set_desc(device_t dev, const char* desc);
616 void    device_set_desc_copy(device_t dev, const char* desc);
617 int     device_set_devclass(device_t dev, const char *classname);
618 int     device_set_devclass_fixed(device_t dev, const char *classname);
619 bool    device_is_devclass_fixed(device_t dev);
620 int     device_set_driver(device_t dev, driver_t *driver);
621 void    device_set_flags(device_t dev, u_int32_t flags);
622 void    device_set_softc(device_t dev, void *softc);
623 void    device_free_softc(void *softc);
624 void    device_claim_softc(device_t dev);
625 int     device_set_unit(device_t dev, int unit);        /* XXX DONT USE XXX */
626 int     device_shutdown(device_t dev);
627 void    device_unbusy(device_t dev);
628 void    device_verbose(device_t dev);
629
630 /*
631  * Access functions for devclass.
632  */
633 int             devclass_add_driver(devclass_t dc, driver_t *driver,
634                                     int pass, devclass_t *dcp);
635 devclass_t      devclass_create(const char *classname);
636 int             devclass_delete_driver(devclass_t busclass, driver_t *driver);
637 devclass_t      devclass_find(const char *classname);
638 const char      *devclass_get_name(devclass_t dc);
639 device_t        devclass_get_device(devclass_t dc, int unit);
640 void    *devclass_get_softc(devclass_t dc, int unit);
641 int     devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
642 int     devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
643 int     devclass_get_count(devclass_t dc);
644 int     devclass_get_maxunit(devclass_t dc);
645 int     devclass_find_free_unit(devclass_t dc, int unit);
646 void    devclass_set_parent(devclass_t dc, devclass_t pdc);
647 devclass_t      devclass_get_parent(devclass_t dc);
648 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
649 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
650
651 /*
652  * Access functions for device resources.
653  */
654 int     resource_int_value(const char *name, int unit, const char *resname,
655                            int *result);
656 int     resource_long_value(const char *name, int unit, const char *resname,
657                             long *result);
658 int     resource_string_value(const char *name, int unit, const char *resname,
659                               const char **result);
660 int     resource_disabled(const char *name, int unit);
661 int     resource_find_match(int *anchor, const char **name, int *unit,
662                             const char *resname, const char *value);
663 int     resource_find_dev(int *anchor, const char *name, int *unit,
664                           const char *resname, const char *value);
665 int     resource_unset_value(const char *name, int unit, const char *resname);
666
667 /*
668  * Functions for maintaining and checking consistency of
669  * bus information exported to userspace.
670  */
671 int     bus_data_generation_check(int generation);
672 void    bus_data_generation_update(void);
673
674 /**
675  * Some convenience defines for probe routines to return.  These are just
676  * suggested values, and there's nothing magical about them.
677  * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
678  * possible other driver may exist (typically legacy drivers who don't follow
679  * all the rules, or special needs drivers).  BUS_PROBE_VENDOR is the
680  * suggested value that vendor supplied drivers use.  This is for source or
681  * binary drivers that are not yet integrated into the FreeBSD tree.  Its use
682  * in the base OS is prohibited.  BUS_PROBE_DEFAULT is the normal return value
683  * for drivers to use.  It is intended that nearly all of the drivers in the
684  * tree should return this value.  BUS_PROBE_LOW_PRIORITY are for drivers that
685  * have special requirements like when there are two drivers that support
686  * overlapping series of hardware devices.  In this case the one that supports
687  * the older part of the line would return this value, while the one that
688  * supports the newer ones would return BUS_PROBE_DEFAULT.  BUS_PROBE_GENERIC
689  * is for drivers that wish to have a generic form and a specialized form,
690  * like is done with the pci bus and the acpi pci bus.  BUS_PROBE_HOOVER is
691  * for those buses that implement a generic device placeholder for devices on
692  * the bus that have no more specific driver for them (aka ugen).
693  * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
694  * for a device node, but accepts only devices that its parent has told it
695  * use this driver.
696  */
697 #define BUS_PROBE_SPECIFIC      0       /* Only I can use this device */
698 #define BUS_PROBE_VENDOR        (-10)   /* Vendor supplied driver */
699 #define BUS_PROBE_DEFAULT       (-20)   /* Base OS default driver */
700 #define BUS_PROBE_LOW_PRIORITY  (-40)   /* Older, less desirable drivers */
701 #define BUS_PROBE_GENERIC       (-100)  /* generic driver for dev */
702 #define BUS_PROBE_HOOVER        (-1000000) /* Driver for any dev on bus */
703 #define BUS_PROBE_NOWILDCARD    (-2000000000) /* No wildcard device matches */
704
705 /**
706  * During boot, the device tree is scanned multiple times.  Each scan,
707  * or pass, drivers may be attached to devices.  Each driver
708  * attachment is assigned a pass number.  Drivers may only probe and
709  * attach to devices if their pass number is less than or equal to the
710  * current system-wide pass number.  The default pass is the last pass
711  * and is used by most drivers.  Drivers needed by the scheduler are
712  * probed in earlier passes.
713  */
714 #define BUS_PASS_ROOT           0       /* Used to attach root0. */
715 #define BUS_PASS_BUS            10      /* Buses and bridges. */
716 #define BUS_PASS_CPU            20      /* CPU devices. */
717 #define BUS_PASS_RESOURCE       30      /* Resource discovery. */
718 #define BUS_PASS_INTERRUPT      40      /* Interrupt controllers. */
719 #define BUS_PASS_TIMER          50      /* Timers and clocks. */
720 #define BUS_PASS_SCHEDULER      60      /* Start scheduler. */
721 #define BUS_PASS_SUPPORTDEV     100000  /* Drivers which support DEFAULT drivers. */
722 #define BUS_PASS_DEFAULT        __INT_MAX /* Everything else. */
723
724 #define BUS_PASS_ORDER_FIRST    0
725 #define BUS_PASS_ORDER_EARLY    2
726 #define BUS_PASS_ORDER_MIDDLE   5
727 #define BUS_PASS_ORDER_LATE     7
728 #define BUS_PASS_ORDER_LAST     9
729
730 extern int bus_current_pass;
731
732 void    bus_set_pass(int pass);
733
734 /**
735  * Shorthands for constructing method tables.
736  */
737 #define DEVMETHOD       KOBJMETHOD
738 #define DEVMETHOD_END   KOBJMETHOD_END
739
740 /*
741  * Some common device interfaces.
742  */
743 #include "device_if.h"
744 #include "bus_if.h"
745
746 struct  module;
747
748 int     driver_module_handler(struct module *, int, void *);
749
750 /**
751  * Module support for automatically adding drivers to buses.
752  */
753 struct driver_module_data {
754         int             (*dmd_chainevh)(struct module *, int, void *);
755         void            *dmd_chainarg;
756         const char      *dmd_busname;
757         kobj_class_t    dmd_driver;
758         devclass_t      *dmd_devclass;
759         int             dmd_pass;
760 };
761
762 #define EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass,    \
763     evh, arg, order, pass)                                              \
764                                                                         \
765 static struct driver_module_data name##_##busname##_driver_mod = {      \
766         evh, arg,                                                       \
767         #busname,                                                       \
768         (kobj_class_t) &driver,                                         \
769         &devclass,                                                      \
770         pass                                                            \
771 };                                                                      \
772                                                                         \
773 static moduledata_t name##_##busname##_mod = {                          \
774         #busname "/" #name,                                             \
775         driver_module_handler,                                          \
776         &name##_##busname##_driver_mod                                  \
777 };                                                                      \
778 DECLARE_MODULE(name##_##busname, name##_##busname##_mod,                \
779                SI_SUB_DRIVERS, order)
780
781 #define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \
782         EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass,    \
783             evh, arg, SI_ORDER_MIDDLE, pass)
784
785 #define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\
786     order)                                                              \
787         EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass,    \
788             evh, arg, order, BUS_PASS_DEFAULT)
789
790 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg)        \
791         EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg,  \
792             BUS_PASS_DEFAULT)
793
794 /**
795  * Generic ivar accessor generation macros for bus drivers
796  */
797 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type)                    \
798                                                                         \
799 static __inline type varp ## _get_ ## var(device_t dev)                 \
800 {                                                                       \
801         uintptr_t v;                                                    \
802         int e __diagused;                                               \
803         e = BUS_READ_IVAR(device_get_parent(dev), dev,                  \
804             ivarp ## _IVAR_ ## ivar, &v);                               \
805         KASSERT(e == 0, ("%s failed for %s on bus %s, error = %d",      \
806             __func__, device_get_nameunit(dev),                         \
807             device_get_nameunit(device_get_parent(dev)), e));           \
808         return ((type) v);                                              \
809 }                                                                       \
810                                                                         \
811 static __inline void varp ## _set_ ## var(device_t dev, type t)         \
812 {                                                                       \
813         uintptr_t v = (uintptr_t) t;                                    \
814         int e __diagused;                                               \
815         e = BUS_WRITE_IVAR(device_get_parent(dev), dev,                 \
816             ivarp ## _IVAR_ ## ivar, v);                                \
817         KASSERT(e == 0, ("%s failed for %s on bus %s, error = %d",      \
818             __func__, device_get_nameunit(dev),                         \
819             device_get_nameunit(device_get_parent(dev)), e));           \
820 }
821
822 /**
823  * Shorthand macros, taking resource argument
824  * Generated with sys/tools/bus_macro.sh
825  */
826
827 #define bus_barrier(r, o, l, f) \
828         bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
829 #define bus_poke_1(r, o, v) \
830         bus_space_poke_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
831 #define bus_peek_1(r, o, vp) \
832         bus_space_peek_1((r)->r_bustag, (r)->r_bushandle, (o), (vp))
833 #define bus_read_1(r, o) \
834         bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
835 #define bus_read_multi_1(r, o, d, c) \
836         bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
837 #define bus_read_region_1(r, o, d, c) \
838         bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
839 #define bus_set_multi_1(r, o, v, c) \
840         bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
841 #define bus_set_region_1(r, o, v, c) \
842         bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
843 #define bus_write_1(r, o, v) \
844         bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
845 #define bus_write_multi_1(r, o, d, c) \
846         bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
847 #define bus_write_region_1(r, o, d, c) \
848         bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
849 #define bus_read_stream_1(r, o) \
850         bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
851 #define bus_read_multi_stream_1(r, o, d, c) \
852         bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
853 #define bus_read_region_stream_1(r, o, d, c) \
854         bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
855 #define bus_set_multi_stream_1(r, o, v, c) \
856         bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
857 #define bus_set_region_stream_1(r, o, v, c) \
858         bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
859 #define bus_write_stream_1(r, o, v) \
860         bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
861 #define bus_write_multi_stream_1(r, o, d, c) \
862         bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
863 #define bus_write_region_stream_1(r, o, d, c) \
864         bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
865 #define bus_poke_2(r, o, v) \
866         bus_space_poke_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
867 #define bus_peek_2(r, o, vp) \
868         bus_space_peek_2((r)->r_bustag, (r)->r_bushandle, (o), (vp))
869 #define bus_read_2(r, o) \
870         bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
871 #define bus_read_multi_2(r, o, d, c) \
872         bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
873 #define bus_read_region_2(r, o, d, c) \
874         bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
875 #define bus_set_multi_2(r, o, v, c) \
876         bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
877 #define bus_set_region_2(r, o, v, c) \
878         bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
879 #define bus_write_2(r, o, v) \
880         bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
881 #define bus_write_multi_2(r, o, d, c) \
882         bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
883 #define bus_write_region_2(r, o, d, c) \
884         bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
885 #define bus_read_stream_2(r, o) \
886         bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
887 #define bus_read_multi_stream_2(r, o, d, c) \
888         bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
889 #define bus_read_region_stream_2(r, o, d, c) \
890         bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
891 #define bus_set_multi_stream_2(r, o, v, c) \
892         bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
893 #define bus_set_region_stream_2(r, o, v, c) \
894         bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
895 #define bus_write_stream_2(r, o, v) \
896         bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
897 #define bus_write_multi_stream_2(r, o, d, c) \
898         bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
899 #define bus_write_region_stream_2(r, o, d, c) \
900         bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
901 #define bus_poke_4(r, o, v) \
902         bus_space_poke_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
903 #define bus_peek_4(r, o, vp) \
904         bus_space_peek_4((r)->r_bustag, (r)->r_bushandle, (o), (vp))
905 #define bus_read_4(r, o) \
906         bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
907 #define bus_read_multi_4(r, o, d, c) \
908         bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
909 #define bus_read_region_4(r, o, d, c) \
910         bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
911 #define bus_set_multi_4(r, o, v, c) \
912         bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
913 #define bus_set_region_4(r, o, v, c) \
914         bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
915 #define bus_write_4(r, o, v) \
916         bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
917 #define bus_write_multi_4(r, o, d, c) \
918         bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
919 #define bus_write_region_4(r, o, d, c) \
920         bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
921 #define bus_read_stream_4(r, o) \
922         bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
923 #define bus_read_multi_stream_4(r, o, d, c) \
924         bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
925 #define bus_read_region_stream_4(r, o, d, c) \
926         bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
927 #define bus_set_multi_stream_4(r, o, v, c) \
928         bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
929 #define bus_set_region_stream_4(r, o, v, c) \
930         bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
931 #define bus_write_stream_4(r, o, v) \
932         bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
933 #define bus_write_multi_stream_4(r, o, d, c) \
934         bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
935 #define bus_write_region_stream_4(r, o, d, c) \
936         bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
937 #define bus_poke_8(r, o, v) \
938         bus_space_poke_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
939 #define bus_peek_8(r, o, vp) \
940         bus_space_peek_8((r)->r_bustag, (r)->r_bushandle, (o), (vp))
941 #define bus_read_8(r, o) \
942         bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
943 #define bus_read_multi_8(r, o, d, c) \
944         bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
945 #define bus_read_region_8(r, o, d, c) \
946         bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
947 #define bus_set_multi_8(r, o, v, c) \
948         bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
949 #define bus_set_region_8(r, o, v, c) \
950         bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
951 #define bus_write_8(r, o, v) \
952         bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
953 #define bus_write_multi_8(r, o, d, c) \
954         bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
955 #define bus_write_region_8(r, o, d, c) \
956         bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
957 #define bus_read_stream_8(r, o) \
958         bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
959 #define bus_read_multi_stream_8(r, o, d, c) \
960         bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
961 #define bus_read_region_stream_8(r, o, d, c) \
962         bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
963 #define bus_set_multi_stream_8(r, o, v, c) \
964         bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
965 #define bus_set_region_stream_8(r, o, v, c) \
966         bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
967 #define bus_write_stream_8(r, o, v) \
968         bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
969 #define bus_write_multi_stream_8(r, o, d, c) \
970         bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
971 #define bus_write_region_stream_8(r, o, d, c) \
972         bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
973 #endif /* _KERNEL */
974
975 #endif /* !_SYS_BUS_H_ */