2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997,1998,2003 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
34 #include <machine/_limits.h>
35 #include <machine/_bus.h>
36 #include <sys/_bus_dma.h>
37 #include <sys/ioccom.h>
40 * @defgroup NEWBUS newbus - a generic framework for managing devices
45 * @brief Interface information structure.
48 int ub_version; /**< @brief interface version */
49 #define BUS_USER_VERSION 1
50 int ub_generation; /**< @brief generation count */
54 * @brief State of the device.
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 */
65 * @brief Device information exported to userspace.
71 char dv_name[32]; /**< @brief Name of device in tree. */
72 char dv_desc[32]; /**< @brief Driver description */
73 char dv_drivername[32]; /**< @brief Driver name */
74 char dv_pnpinfo[128]; /**< @brief Plug and play info */
75 char dv_location[128]; /**< @brief Where is the device? */
76 uint32_t dv_devflags; /**< @brief API Flags for device */
77 uint16_t dv_flags; /**< @brief flags for dev state */
78 device_state_t dv_state; /**< @brief State of attachment */
79 /* XXX more driver info? */
82 /* Flags exported via dv_flags. */
83 #define DF_ENABLED 0x01 /* device should be probed/attached */
84 #define DF_FIXEDCLASS 0x02 /* devclass specified at create time */
85 #define DF_WILDCARD 0x04 /* unit was originally wildcard */
86 #define DF_DESCMALLOCED 0x08 /* description was malloced */
87 #define DF_QUIET 0x10 /* don't print verbose attach message */
88 #define DF_DONENOMATCH 0x20 /* don't execute DEVICE_NOMATCH again */
89 #define DF_EXTERNALSOFTC 0x40 /* softc not allocated by us */
90 #define DF_REBID 0x80 /* Can rebid after attach */
91 #define DF_SUSPENDED 0x100 /* Device is suspended. */
94 * @brief Device request structure used for ioctl's.
96 * Used for ioctl's on /dev/devctl2. All device ioctl's
97 * must have parameter definitions which begin with dr_name.
99 struct devreq_buffer {
106 int dr_flags; /* request-specific flags */
108 struct devreq_buffer dru_buffer;
111 #define dr_buffer dr_dru.dru_buffer /* variable-sized buffer */
112 #define dr_data dr_dru.dru_data /* fixed-size buffer */
115 #define DEV_ATTACH _IOW('D', 1, struct devreq)
116 #define DEV_DETACH _IOW('D', 2, struct devreq)
117 #define DEV_ENABLE _IOW('D', 3, struct devreq)
118 #define DEV_DISABLE _IOW('D', 4, struct devreq)
119 #define DEV_SUSPEND _IOW('D', 5, struct devreq)
120 #define DEV_RESUME _IOW('D', 6, struct devreq)
121 #define DEV_SET_DRIVER _IOW('D', 7, struct devreq)
122 #define DEV_CLEAR_DRIVER _IOW('D', 8, struct devreq)
123 #define DEV_RESCAN _IOW('D', 9, struct devreq)
124 #define DEV_DELETE _IOW('D', 10, struct devreq)
126 /* Flags for DEV_DETACH and DEV_DISABLE. */
127 #define DEVF_FORCE_DETACH 0x0000001
129 /* Flags for DEV_SET_DRIVER. */
130 #define DEVF_SET_DRIVER_DETACH 0x0000001 /* Detach existing driver. */
132 /* Flags for DEV_CLEAR_DRIVER. */
133 #define DEVF_CLEAR_DRIVER_DETACH 0x0000001 /* Detach existing driver. */
135 /* Flags for DEV_DELETE. */
136 #define DEVF_FORCE_DELETE 0x0000001
140 #include <sys/eventhandler.h>
141 #include <sys/kobj.h>
144 * devctl hooks. Typically one should use the devctl_notify
145 * hook to send the message. However, devctl_queue_data is also
146 * included in case devctl_notify isn't sufficiently general.
148 boolean_t devctl_process_running(void);
149 void devctl_notify_f(const char *__system, const char *__subsystem,
150 const char *__type, const char *__data, int __flags);
151 void devctl_notify(const char *__system, const char *__subsystem,
152 const char *__type, const char *__data);
153 void devctl_queue_data_f(char *__data, int __flags);
154 void devctl_queue_data(char *__data);
155 void devctl_safe_quote(char *__dst, const char *__src, size_t len);
158 * Device name parsers. Hook to allow device enumerators to map
159 * scheme-specific names to a device.
161 typedef void (*dev_lookup_fn)(void *arg, const char *name,
163 EVENTHANDLER_DECLARE(dev_lookup, dev_lookup_fn);
166 * @brief A device driver (included mainly for compatibility with
169 typedef struct kobj_class driver_t;
172 * @brief A device class
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.
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.
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).
191 typedef struct devclass *devclass_t;
194 * @brief A device method
196 #define device_method_t kobj_method_t
199 * @brief Driver interrupt filter return values
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
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
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.
216 #define FILTER_STRAY 0x01
217 #define FILTER_HANDLED 0x02
218 #define FILTER_SCHEDULE_THREAD 0x04
221 * @brief Driver interrupt service routines
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.
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.
235 typedef int driver_filter_t(void*);
236 typedef void driver_intr_t(void*);
239 * @brief Interrupt type bits.
241 * These flags are used both by newbus interrupt
242 * registration (nexus.c) and also in struct intrec, which defines
243 * interrupt properties.
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).
249 * Buses which do interrupt remapping will want to change their type
250 * to reflect what sort of devices are underneath.
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 */
270 INTR_TRIGGER_INVALID = -1,
271 INTR_TRIGGER_CONFORM = 0,
272 INTR_TRIGGER_EDGE = 1,
273 INTR_TRIGGER_LEVEL = 2
277 INTR_POLARITY_CONFORM = 0,
278 INTR_POLARITY_HIGH = 1,
279 INTR_POLARITY_LOW = 2
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.
292 typedef int (*devop_t)(void);
295 * @brief This structure is deprecated.
297 * Use the kobj(9) macro DEFINE_CLASS to
298 * declare classes which implement device drivers.
305 * @brief A resource mapping.
307 struct resource_map {
308 bus_space_tag_t r_bustag;
309 bus_space_handle_t r_bushandle;
315 * @brief Optional properties of a resource mapping request.
317 struct resource_map_request {
321 vm_memattr_t memattr;
324 void resource_init_map_request_impl(struct resource_map_request *_args,
326 #define resource_init_map_request(rmr) \
327 resource_init_map_request_impl((rmr), sizeof(*(rmr)))
330 * Definitions for drivers which need to keep simple lists of resources
331 * for their child devices.
336 * @brief An entry for a single resource in a resource list.
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 */
348 STAILQ_HEAD(resource_list, resource_list_entry);
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. */
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,
359 rman_res_t start, rman_res_t end, rman_res_t count);
360 int resource_list_add_next(struct resource_list *rl,
362 rman_res_t start, rman_res_t end, rman_res_t count);
363 int resource_list_busy(struct resource_list *rl,
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,
369 void resource_list_delete(struct resource_list *rl,
372 resource_list_alloc(struct resource_list *rl,
373 device_t bus, device_t child,
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,
384 resource_list_reserve(struct resource_list *rl,
385 device_t bus, device_t child,
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,
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,
398 * The root bus, to which all top-level buses are attached.
400 extern device_t root_bus;
401 extern devclass_t root_devclass;
402 void root_bus_configure(void);
405 * Useful functions for implementing buses.
408 int bus_generic_activate_resource(device_t dev, device_t child, int type,
409 int rid, struct resource *r);
411 bus_generic_add_child(device_t dev, u_int order, const char *name,
413 int bus_generic_adjust_resource(device_t bus, device_t child, int type,
414 struct resource *r, rman_res_t start,
417 bus_generic_alloc_resource(device_t bus, device_t child, int type,
418 int *rid, rman_res_t start, rman_res_t end,
419 rman_res_t count, u_int flags);
420 int bus_generic_attach(device_t dev);
421 int bus_generic_bind_intr(device_t dev, device_t child,
422 struct resource *irq, int cpu);
423 int bus_generic_child_present(device_t dev, device_t child);
424 int bus_generic_config_intr(device_t, int, enum intr_trigger,
426 int bus_generic_describe_intr(device_t dev, device_t child,
427 struct resource *irq, void *cookie,
429 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
430 int rid, struct resource *r);
431 int bus_generic_detach(device_t dev);
432 void bus_generic_driver_added(device_t dev, driver_t *driver);
433 int bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
434 size_t setsize, struct _cpuset *cpuset);
436 bus_generic_get_dma_tag(device_t dev, device_t child);
438 bus_generic_get_bus_tag(device_t dev, device_t child);
439 int bus_generic_get_domain(device_t dev, device_t child, int *domain);
440 struct resource_list *
441 bus_generic_get_resource_list (device_t, device_t);
442 int bus_generic_map_resource(device_t dev, device_t child, int type,
444 struct resource_map_request *args,
445 struct resource_map *map);
446 void bus_generic_new_pass(device_t dev);
447 int bus_print_child_header(device_t dev, device_t child);
448 int bus_print_child_domain(device_t dev, device_t child);
449 int bus_print_child_footer(device_t dev, device_t child);
450 int bus_generic_print_child(device_t dev, device_t child);
451 int bus_generic_probe(device_t dev);
452 int bus_generic_read_ivar(device_t dev, device_t child, int which,
454 int bus_generic_release_resource(device_t bus, device_t child,
455 int type, int rid, struct resource *r);
456 int bus_generic_resume(device_t dev);
457 int bus_generic_resume_child(device_t dev, device_t child);
458 int bus_generic_setup_intr(device_t dev, device_t child,
459 struct resource *irq, int flags,
460 driver_filter_t *filter, driver_intr_t *intr,
461 void *arg, void **cookiep);
464 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
465 rman_res_t, rman_res_t, rman_res_t, u_int);
466 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
467 int bus_generic_rl_get_resource (device_t, device_t, int, int, rman_res_t *,
469 int bus_generic_rl_set_resource (device_t, device_t, int, int, rman_res_t,
471 int bus_generic_rl_release_resource (device_t, device_t, int, int,
474 int bus_generic_shutdown(device_t dev);
475 int bus_generic_suspend(device_t dev);
476 int bus_generic_suspend_child(device_t dev, device_t child);
477 int bus_generic_teardown_intr(device_t dev, device_t child,
478 struct resource *irq, void *cookie);
479 int bus_generic_unmap_resource(device_t dev, device_t child, int type,
481 struct resource_map *map);
482 int bus_generic_write_ivar(device_t dev, device_t child, int which,
484 int bus_null_rescan(device_t dev);
487 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
491 struct resource_spec {
496 #define RESOURCE_SPEC_END {-1, 0, 0}
498 int bus_alloc_resources(device_t dev, struct resource_spec *rs,
499 struct resource **res);
500 void bus_release_resources(device_t dev, const struct resource_spec *rs,
501 struct resource **res);
503 int bus_adjust_resource(device_t child, int type, struct resource *r,
504 rman_res_t start, rman_res_t end);
505 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
506 rman_res_t start, rman_res_t end,
507 rman_res_t count, u_int flags);
508 int bus_activate_resource(device_t dev, int type, int rid,
510 int bus_deactivate_resource(device_t dev, int type, int rid,
512 int bus_map_resource(device_t dev, int type, struct resource *r,
513 struct resource_map_request *args,
514 struct resource_map *map);
515 int bus_unmap_resource(device_t dev, int type, struct resource *r,
516 struct resource_map *map);
517 int bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize,
518 struct _cpuset *cpuset);
519 bus_dma_tag_t bus_get_dma_tag(device_t dev);
520 bus_space_tag_t bus_get_bus_tag(device_t dev);
521 int bus_get_domain(device_t dev, int *domain);
522 int bus_release_resource(device_t dev, int type, int rid,
524 int bus_free_resource(device_t dev, int type, struct resource *r);
525 int bus_setup_intr(device_t dev, struct resource *r, int flags,
526 driver_filter_t filter, driver_intr_t handler,
527 void *arg, void **cookiep);
528 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
529 int bus_bind_intr(device_t dev, struct resource *r, int cpu);
530 int bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
531 const char *fmt, ...) __printflike(4, 5);
532 int bus_set_resource(device_t dev, int type, int rid,
533 rman_res_t start, rman_res_t count);
534 int bus_get_resource(device_t dev, int type, int rid,
535 rman_res_t *startp, rman_res_t *countp);
536 rman_res_t bus_get_resource_start(device_t dev, int type, int rid);
537 rman_res_t bus_get_resource_count(device_t dev, int type, int rid);
538 void bus_delete_resource(device_t dev, int type, int rid);
539 int bus_child_present(device_t child);
540 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
541 int bus_child_location_str(device_t child, char *buf, size_t buflen);
542 void bus_enumerate_hinted_children(device_t bus);
544 static __inline struct resource *
545 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
547 return (bus_alloc_resource(dev, type, rid, 0, ~0, 1, flags));
550 static __inline struct resource *
551 bus_alloc_resource_anywhere(device_t dev, int type, int *rid,
552 rman_res_t count, u_int flags)
554 return (bus_alloc_resource(dev, type, rid, 0, ~0, count, flags));
558 * Access functions for device.
560 device_t device_add_child(device_t dev, const char *name, int unit);
561 device_t device_add_child_ordered(device_t dev, u_int order,
562 const char *name, int unit);
563 void device_busy(device_t dev);
564 int device_delete_child(device_t dev, device_t child);
565 int device_delete_children(device_t dev);
566 int device_attach(device_t dev);
567 int device_detach(device_t dev);
568 void device_disable(device_t dev);
569 void device_enable(device_t dev);
570 device_t device_find_child(device_t dev, const char *classname,
572 const char *device_get_desc(device_t dev);
573 devclass_t device_get_devclass(device_t dev);
574 driver_t *device_get_driver(device_t dev);
575 u_int32_t device_get_flags(device_t dev);
576 device_t device_get_parent(device_t dev);
577 int device_get_children(device_t dev, device_t **listp, int *countp);
578 void *device_get_ivars(device_t dev);
579 void device_set_ivars(device_t dev, void *ivars);
580 const char *device_get_name(device_t dev);
581 const char *device_get_nameunit(device_t dev);
582 void *device_get_softc(device_t dev);
583 device_state_t device_get_state(device_t dev);
584 int device_get_unit(device_t dev);
585 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
586 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
587 int device_is_alive(device_t dev); /* did probe succeed? */
588 int device_is_attached(device_t dev); /* did attach succeed? */
589 int device_is_enabled(device_t dev);
590 int device_is_suspended(device_t dev);
591 int device_is_quiet(device_t dev);
592 device_t device_lookup_by_name(const char *name);
593 int device_print_prettyname(device_t dev);
594 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
595 int device_probe(device_t dev);
596 int device_probe_and_attach(device_t dev);
597 int device_probe_child(device_t bus, device_t dev);
598 int device_quiesce(device_t dev);
599 void device_quiet(device_t dev);
600 void device_set_desc(device_t dev, const char* desc);
601 void device_set_desc_copy(device_t dev, const char* desc);
602 int device_set_devclass(device_t dev, const char *classname);
603 int device_set_devclass_fixed(device_t dev, const char *classname);
604 int device_set_driver(device_t dev, driver_t *driver);
605 void device_set_flags(device_t dev, u_int32_t flags);
606 void device_set_softc(device_t dev, void *softc);
607 void device_free_softc(void *softc);
608 void device_claim_softc(device_t dev);
609 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
610 int device_shutdown(device_t dev);
611 void device_unbusy(device_t dev);
612 void device_verbose(device_t dev);
615 * Access functions for devclass.
617 int devclass_add_driver(devclass_t dc, driver_t *driver,
618 int pass, devclass_t *dcp);
619 devclass_t devclass_create(const char *classname);
620 int devclass_delete_driver(devclass_t busclass, driver_t *driver);
621 devclass_t devclass_find(const char *classname);
622 const char *devclass_get_name(devclass_t dc);
623 device_t devclass_get_device(devclass_t dc, int unit);
624 void *devclass_get_softc(devclass_t dc, int unit);
625 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
626 int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
627 int devclass_get_count(devclass_t dc);
628 int devclass_get_maxunit(devclass_t dc);
629 int devclass_find_free_unit(devclass_t dc, int unit);
630 void devclass_set_parent(devclass_t dc, devclass_t pdc);
631 devclass_t devclass_get_parent(devclass_t dc);
632 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
633 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
636 * Access functions for device resources.
638 int resource_int_value(const char *name, int unit, const char *resname,
640 int resource_long_value(const char *name, int unit, const char *resname,
642 int resource_string_value(const char *name, int unit, const char *resname,
643 const char **result);
644 int resource_disabled(const char *name, int unit);
645 int resource_find_match(int *anchor, const char **name, int *unit,
646 const char *resname, const char *value);
647 int resource_find_dev(int *anchor, const char *name, int *unit,
648 const char *resname, const char *value);
649 int resource_unset_value(const char *name, int unit, const char *resname);
652 * Functions for maintaining and checking consistency of
653 * bus information exported to userspace.
655 int bus_data_generation_check(int generation);
656 void bus_data_generation_update(void);
659 * Some convenience defines for probe routines to return. These are just
660 * suggested values, and there's nothing magical about them.
661 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
662 * possible other driver may exist (typically legacy drivers who don't follow
663 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
664 * suggested value that vendor supplied drivers use. This is for source or
665 * binary drivers that are not yet integrated into the FreeBSD tree. Its use
666 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
667 * for drivers to use. It is intended that nearly all of the drivers in the
668 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
669 * have special requirements like when there are two drivers that support
670 * overlapping series of hardware devices. In this case the one that supports
671 * the older part of the line would return this value, while the one that
672 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
673 * is for drivers that wish to have a generic form and a specialized form,
674 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
675 * for those buses that implement a generic device placeholder for devices on
676 * the bus that have no more specific driver for them (aka ugen).
677 * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
678 * for a device node, but accepts only devices that its parent has told it
681 #define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
682 #define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
683 #define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
684 #define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
685 #define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
686 #define BUS_PROBE_HOOVER (-1000000) /* Driver for any dev on bus */
687 #define BUS_PROBE_NOWILDCARD (-2000000000) /* No wildcard device matches */
690 * During boot, the device tree is scanned multiple times. Each scan,
691 * or pass, drivers may be attached to devices. Each driver
692 * attachment is assigned a pass number. Drivers may only probe and
693 * attach to devices if their pass number is less than or equal to the
694 * current system-wide pass number. The default pass is the last pass
695 * and is used by most drivers. Drivers needed by the scheduler are
696 * probed in earlier passes.
698 #define BUS_PASS_ROOT 0 /* Used to attach root0. */
699 #define BUS_PASS_BUS 10 /* Buses and bridges. */
700 #define BUS_PASS_CPU 20 /* CPU devices. */
701 #define BUS_PASS_RESOURCE 30 /* Resource discovery. */
702 #define BUS_PASS_INTERRUPT 40 /* Interrupt controllers. */
703 #define BUS_PASS_TIMER 50 /* Timers and clocks. */
704 #define BUS_PASS_SCHEDULER 60 /* Start scheduler. */
705 #define BUS_PASS_SUPPORTDEV 100000 /* Drivers which support DEFAULT drivers. */
706 #define BUS_PASS_DEFAULT __INT_MAX /* Everything else. */
708 #define BUS_PASS_ORDER_FIRST 0
709 #define BUS_PASS_ORDER_EARLY 2
710 #define BUS_PASS_ORDER_MIDDLE 5
711 #define BUS_PASS_ORDER_LATE 7
712 #define BUS_PASS_ORDER_LAST 9
714 extern int bus_current_pass;
716 void bus_set_pass(int pass);
719 * Shorthands for constructing method tables.
721 #define DEVMETHOD KOBJMETHOD
722 #define DEVMETHOD_END KOBJMETHOD_END
725 * Some common device interfaces.
727 #include "device_if.h"
732 int driver_module_handler(struct module *, int, void *);
735 * Module support for automatically adding drivers to buses.
737 struct driver_module_data {
738 int (*dmd_chainevh)(struct module *, int, void *);
740 const char *dmd_busname;
741 kobj_class_t dmd_driver;
742 devclass_t *dmd_devclass;
746 #define EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
747 evh, arg, order, pass) \
749 static struct driver_module_data name##_##busname##_driver_mod = { \
752 (kobj_class_t) &driver, \
757 static moduledata_t name##_##busname##_mod = { \
758 #busname "/" #name, \
759 driver_module_handler, \
760 &name##_##busname##_driver_mod \
762 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
763 SI_SUB_DRIVERS, order)
765 #define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \
766 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
767 evh, arg, SI_ORDER_MIDDLE, pass)
769 #define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\
771 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
772 evh, arg, order, BUS_PASS_DEFAULT)
774 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
775 EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, \
779 * Generic ivar accessor generation macros for bus drivers
781 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
783 static __inline type varp ## _get_ ## var(device_t dev) \
786 BUS_READ_IVAR(device_get_parent(dev), dev, \
787 ivarp ## _IVAR_ ## ivar, &v); \
791 static __inline void varp ## _set_ ## var(device_t dev, type t) \
793 uintptr_t v = (uintptr_t) t; \
794 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
795 ivarp ## _IVAR_ ## ivar, v); \
799 * Shorthand macros, taking resource argument
800 * Generated with sys/tools/bus_macro.sh
803 #define bus_barrier(r, o, l, f) \
804 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
805 #define bus_read_1(r, o) \
806 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
807 #define bus_read_multi_1(r, o, d, c) \
808 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
809 #define bus_read_region_1(r, o, d, c) \
810 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
811 #define bus_set_multi_1(r, o, v, c) \
812 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
813 #define bus_set_region_1(r, o, v, c) \
814 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
815 #define bus_write_1(r, o, v) \
816 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
817 #define bus_write_multi_1(r, o, d, c) \
818 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
819 #define bus_write_region_1(r, o, d, c) \
820 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
821 #define bus_read_stream_1(r, o) \
822 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
823 #define bus_read_multi_stream_1(r, o, d, c) \
824 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
825 #define bus_read_region_stream_1(r, o, d, c) \
826 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
827 #define bus_set_multi_stream_1(r, o, v, c) \
828 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
829 #define bus_set_region_stream_1(r, o, v, c) \
830 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
831 #define bus_write_stream_1(r, o, v) \
832 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
833 #define bus_write_multi_stream_1(r, o, d, c) \
834 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
835 #define bus_write_region_stream_1(r, o, d, c) \
836 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
837 #define bus_read_2(r, o) \
838 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
839 #define bus_read_multi_2(r, o, d, c) \
840 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
841 #define bus_read_region_2(r, o, d, c) \
842 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
843 #define bus_set_multi_2(r, o, v, c) \
844 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
845 #define bus_set_region_2(r, o, v, c) \
846 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
847 #define bus_write_2(r, o, v) \
848 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
849 #define bus_write_multi_2(r, o, d, c) \
850 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
851 #define bus_write_region_2(r, o, d, c) \
852 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
853 #define bus_read_stream_2(r, o) \
854 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
855 #define bus_read_multi_stream_2(r, o, d, c) \
856 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
857 #define bus_read_region_stream_2(r, o, d, c) \
858 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
859 #define bus_set_multi_stream_2(r, o, v, c) \
860 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
861 #define bus_set_region_stream_2(r, o, v, c) \
862 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
863 #define bus_write_stream_2(r, o, v) \
864 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
865 #define bus_write_multi_stream_2(r, o, d, c) \
866 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
867 #define bus_write_region_stream_2(r, o, d, c) \
868 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
869 #define bus_read_4(r, o) \
870 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
871 #define bus_read_multi_4(r, o, d, c) \
872 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
873 #define bus_read_region_4(r, o, d, c) \
874 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
875 #define bus_set_multi_4(r, o, v, c) \
876 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
877 #define bus_set_region_4(r, o, v, c) \
878 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
879 #define bus_write_4(r, o, v) \
880 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
881 #define bus_write_multi_4(r, o, d, c) \
882 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
883 #define bus_write_region_4(r, o, d, c) \
884 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
885 #define bus_read_stream_4(r, o) \
886 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
887 #define bus_read_multi_stream_4(r, o, d, c) \
888 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
889 #define bus_read_region_stream_4(r, o, d, c) \
890 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
891 #define bus_set_multi_stream_4(r, o, v, c) \
892 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
893 #define bus_set_region_stream_4(r, o, v, c) \
894 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
895 #define bus_write_stream_4(r, o, v) \
896 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
897 #define bus_write_multi_stream_4(r, o, d, c) \
898 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
899 #define bus_write_region_stream_4(r, o, d, c) \
900 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
901 #define bus_read_8(r, o) \
902 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
903 #define bus_read_multi_8(r, o, d, c) \
904 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
905 #define bus_read_region_8(r, o, d, c) \
906 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
907 #define bus_set_multi_8(r, o, v, c) \
908 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
909 #define bus_set_region_8(r, o, v, c) \
910 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
911 #define bus_write_8(r, o, v) \
912 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
913 #define bus_write_multi_8(r, o, d, c) \
914 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
915 #define bus_write_region_8(r, o, d, c) \
916 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
917 #define bus_read_stream_8(r, o) \
918 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
919 #define bus_read_multi_stream_8(r, o, d, c) \
920 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
921 #define bus_read_region_stream_8(r, o, d, c) \
922 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
923 #define bus_set_multi_stream_8(r, o, v, c) \
924 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
925 #define bus_set_region_stream_8(r, o, v, c) \
926 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
927 #define bus_write_stream_8(r, o, v) \
928 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
929 #define bus_write_multi_stream_8(r, o, d, c) \
930 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
931 #define bus_write_region_stream_8(r, o, d, c) \
932 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
935 #endif /* !_SYS_BUS_H_ */