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 2
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 */
64 * @brief Device proprty types.
66 * Those are used by bus logic to encode requested properties,
67 * e.g. in DT all properties are stored as BE and need to be converted
70 typedef enum device_property_type {
72 DEVICE_PROP_BUFFER = 1,
73 DEVICE_PROP_UINT32 = 2,
74 DEVICE_PROP_UINT64 = 3,
75 } device_property_type_t;
78 * @brief Device information exported to userspace.
79 * The strings are placed one after the other, separated by NUL characters.
80 * Fields should be added after the last one and order maintained for compatibility
82 #define BUS_USER_BUFFER (3*1024)
86 uint32_t dv_devflags; /**< @brief API Flags for device */
87 uint16_t dv_flags; /**< @brief flags for dev state */
88 device_state_t dv_state; /**< @brief State of attachment */
89 char dv_fields[BUS_USER_BUFFER]; /**< @brief NUL terminated fields */
90 /* name (name of the device in tree) */
91 /* desc (driver description) */
92 /* drivername (Name of driver without unit number) */
93 /* pnpinfo (Plug and play information from bus) */
94 /* location (Location of device on parent */
98 /* Flags exported via dv_flags. */
99 #define DF_ENABLED 0x01 /* device should be probed/attached */
100 #define DF_FIXEDCLASS 0x02 /* devclass specified at create time */
101 #define DF_WILDCARD 0x04 /* unit was originally wildcard */
102 #define DF_DESCMALLOCED 0x08 /* description was malloced */
103 #define DF_QUIET 0x10 /* don't print verbose attach message */
104 #define DF_DONENOMATCH 0x20 /* don't execute DEVICE_NOMATCH again */
105 #define DF_EXTERNALSOFTC 0x40 /* softc not allocated by us */
106 #define DF_SUSPENDED 0x100 /* Device is suspended. */
107 #define DF_QUIET_CHILDREN 0x200 /* Default to quiet for all my children */
108 #define DF_ATTACHED_ONCE 0x400 /* Has been attached at least once */
109 #define DF_NEEDNOMATCH 0x800 /* Has a pending NOMATCH event */
112 * @brief Device request structure used for ioctl's.
114 * Used for ioctl's on /dev/devctl2. All device ioctl's
115 * must have parameter definitions which begin with dr_name.
117 struct devreq_buffer {
124 int dr_flags; /* request-specific flags */
126 struct devreq_buffer dru_buffer;
129 #define dr_buffer dr_dru.dru_buffer /* variable-sized buffer */
130 #define dr_data dr_dru.dru_data /* fixed-size buffer */
133 #define DEV_ATTACH _IOW('D', 1, struct devreq)
134 #define DEV_DETACH _IOW('D', 2, struct devreq)
135 #define DEV_ENABLE _IOW('D', 3, struct devreq)
136 #define DEV_DISABLE _IOW('D', 4, struct devreq)
137 #define DEV_SUSPEND _IOW('D', 5, struct devreq)
138 #define DEV_RESUME _IOW('D', 6, struct devreq)
139 #define DEV_SET_DRIVER _IOW('D', 7, struct devreq)
140 #define DEV_CLEAR_DRIVER _IOW('D', 8, struct devreq)
141 #define DEV_RESCAN _IOW('D', 9, struct devreq)
142 #define DEV_DELETE _IOW('D', 10, struct devreq)
143 #define DEV_FREEZE _IOW('D', 11, struct devreq)
144 #define DEV_THAW _IOW('D', 12, struct devreq)
145 #define DEV_RESET _IOW('D', 13, struct devreq)
146 #define DEV_GET_PATH _IOWR('D', 14, struct devreq)
148 /* Flags for DEV_DETACH and DEV_DISABLE. */
149 #define DEVF_FORCE_DETACH 0x0000001
151 /* Flags for DEV_SET_DRIVER. */
152 #define DEVF_SET_DRIVER_DETACH 0x0000001 /* Detach existing driver. */
154 /* Flags for DEV_CLEAR_DRIVER. */
155 #define DEVF_CLEAR_DRIVER_DETACH 0x0000001 /* Detach existing driver. */
157 /* Flags for DEV_DELETE. */
158 #define DEVF_FORCE_DELETE 0x0000001
160 /* Flags for DEV_RESET */
161 #define DEVF_RESET_DETACH 0x0000001 /* Detach drivers vs suspend
166 #include <sys/_eventhandler.h>
167 #include <sys/kobj.h>
168 #include <sys/systm.h>
169 #include <sys/devctl.h>
172 * Device name parsers. Hook to allow device enumerators to map
173 * scheme-specific names to a device.
175 typedef void (*dev_lookup_fn)(void *arg, const char *name,
177 EVENTHANDLER_DECLARE(dev_lookup, dev_lookup_fn);
180 * @brief A device driver.
182 * Provides an abstraction layer for driver dispatch.
184 typedef struct kobj_class driver_t;
187 * @brief A device class
189 * The devclass object has two main functions in the system. The first
190 * is to manage the allocation of unit numbers for device instances
191 * and the second is to hold the list of device drivers for a
192 * particular bus type. Each devclass has a name and there cannot be
193 * two devclasses with the same name. This ensures that unique unit
194 * numbers are allocated to device instances.
196 * Drivers that support several different bus attachments (e.g. isa,
197 * pci, pccard) should all use the same devclass to ensure that unit
198 * numbers do not conflict.
200 * Each devclass may also have a parent devclass. This is used when
201 * searching for device drivers to allow a form of inheritance. When
202 * matching drivers with devices, first the driver list of the parent
203 * device's devclass is searched. If no driver is found in that list,
204 * the search continues in the parent devclass (if any).
206 typedef struct devclass *devclass_t;
209 * @brief A device method
211 #define device_method_t kobj_method_t
214 * @brief Driver interrupt filter return values
216 * If a driver provides an interrupt filter routine it must return an
217 * integer consisting of oring together zero or more of the following
220 * FILTER_STRAY - this device did not trigger the interrupt
221 * FILTER_HANDLED - the interrupt has been fully handled and can be EOId
222 * FILTER_SCHEDULE_THREAD - the threaded interrupt handler should be
223 * scheduled to execute
225 * If the driver does not provide a filter, then the interrupt code will
226 * act is if the filter had returned FILTER_SCHEDULE_THREAD. Note that it
227 * is illegal to specify any other flag with FILTER_STRAY and that it is
228 * illegal to not specify either of FILTER_HANDLED or FILTER_SCHEDULE_THREAD
229 * if FILTER_STRAY is not specified.
231 #define FILTER_STRAY 0x01
232 #define FILTER_HANDLED 0x02
233 #define FILTER_SCHEDULE_THREAD 0x04
236 * @brief Driver interrupt service routines
238 * The filter routine is run in primary interrupt context and may not
239 * block or use regular mutexes. It may only use spin mutexes for
240 * synchronization. The filter may either completely handle the
241 * interrupt or it may perform some of the work and defer more
242 * expensive work to the regular interrupt handler. If a filter
243 * routine is not registered by the driver, then the regular interrupt
244 * handler is always used to handle interrupts from this device.
246 * The regular interrupt handler executes in its own thread context
247 * and may use regular mutexes. However, it is prohibited from
248 * sleeping on a sleep queue.
250 typedef int driver_filter_t(void*);
251 typedef void driver_intr_t(void*);
254 * @brief Interrupt type bits.
256 * These flags are used both by newbus interrupt
257 * registration (nexus.c) and also in struct intrec, which defines
258 * interrupt properties.
260 * XXX We should probably revisit this and remove the vestiges of the
261 * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
262 * confuse things by renaming them (Grog, 18 July 2000).
264 * Buses which do interrupt remapping will want to change their type
265 * to reflect what sort of devices are underneath.
275 INTR_EXCL = 256, /* exclusive interrupt */
276 INTR_MPSAFE = 512, /* this interrupt is SMP safe */
277 INTR_ENTROPY = 1024, /* this interrupt provides entropy */
278 INTR_MD1 = 4096, /* flag reserved for MD use */
279 INTR_MD2 = 8192, /* flag reserved for MD use */
280 INTR_MD3 = 16384, /* flag reserved for MD use */
281 INTR_MD4 = 32768 /* flag reserved for MD use */
285 INTR_TRIGGER_INVALID = -1,
286 INTR_TRIGGER_CONFORM = 0,
287 INTR_TRIGGER_EDGE = 1,
288 INTR_TRIGGER_LEVEL = 2
292 INTR_POLARITY_CONFORM = 0,
293 INTR_POLARITY_HIGH = 1,
294 INTR_POLARITY_LOW = 2
298 * CPU sets supported by bus_get_cpus(). Note that not all sets may be
299 * supported for a given device. If a request is not supported by a
300 * device (or its parents), then bus_get_cpus() will fail with EINVAL.
307 typedef int (*devop_t)(void);
310 * @brief This structure is deprecated.
312 * Use the kobj(9) macro DEFINE_CLASS to
313 * declare classes which implement device drivers.
320 * @brief A resource mapping.
322 struct resource_map {
323 bus_space_tag_t r_bustag;
324 bus_space_handle_t r_bushandle;
330 * @brief Optional properties of a resource mapping request.
332 struct resource_map_request {
336 vm_memattr_t memattr;
339 void resource_init_map_request_impl(struct resource_map_request *_args,
341 #define resource_init_map_request(rmr) \
342 resource_init_map_request_impl((rmr), sizeof(*(rmr)))
345 * Definitions for drivers which need to keep simple lists of resources
346 * for their child devices.
351 * @brief An entry for a single resource in a resource list.
353 struct resource_list_entry {
354 STAILQ_ENTRY(resource_list_entry) link;
355 int type; /**< @brief type argument to alloc_resource */
356 int rid; /**< @brief resource identifier */
357 int flags; /**< @brief resource flags */
358 struct resource *res; /**< @brief the real resource when allocated */
359 rman_res_t start; /**< @brief start of resource range */
360 rman_res_t end; /**< @brief end of resource range */
361 rman_res_t count; /**< @brief count within range */
363 STAILQ_HEAD(resource_list, resource_list_entry);
365 #define RLE_RESERVED 0x0001 /* Reserved by the parent bus. */
366 #define RLE_ALLOCATED 0x0002 /* Reserved resource is allocated. */
367 #define RLE_PREFETCH 0x0004 /* Resource is a prefetch range. */
369 void resource_list_init(struct resource_list *rl);
370 void resource_list_free(struct resource_list *rl);
371 struct resource_list_entry *
372 resource_list_add(struct resource_list *rl,
374 rman_res_t start, rman_res_t end, rman_res_t count);
375 int resource_list_add_next(struct resource_list *rl,
377 rman_res_t start, rman_res_t end, rman_res_t count);
378 int resource_list_busy(struct resource_list *rl,
380 int resource_list_reserved(struct resource_list *rl, int type, int rid);
381 struct resource_list_entry*
382 resource_list_find(struct resource_list *rl,
384 void resource_list_delete(struct resource_list *rl,
387 resource_list_alloc(struct resource_list *rl,
388 device_t bus, device_t child,
390 rman_res_t start, rman_res_t end,
391 rman_res_t count, u_int flags);
392 int resource_list_release(struct resource_list *rl,
393 device_t bus, device_t child,
394 int type, int rid, struct resource *res);
395 int resource_list_release_active(struct resource_list *rl,
396 device_t bus, device_t child,
399 resource_list_reserve(struct resource_list *rl,
400 device_t bus, device_t child,
402 rman_res_t start, rman_res_t end,
403 rman_res_t count, u_int flags);
404 int resource_list_unreserve(struct resource_list *rl,
405 device_t bus, device_t child,
407 void resource_list_purge(struct resource_list *rl);
408 int resource_list_print_type(struct resource_list *rl,
409 const char *name, int type,
413 * The root bus, to which all top-level buses are attached.
415 extern device_t root_bus;
416 extern devclass_t root_devclass;
417 void root_bus_configure(void);
420 * Useful functions for implementing buses.
425 int bus_generic_activate_resource(device_t dev, device_t child, int type,
426 int rid, struct resource *r);
428 bus_generic_add_child(device_t dev, u_int order, const char *name,
430 int bus_generic_adjust_resource(device_t bus, device_t child, int type,
431 struct resource *r, rman_res_t start,
434 bus_generic_alloc_resource(device_t bus, device_t child, int type,
435 int *rid, rman_res_t start, rman_res_t end,
436 rman_res_t count, u_int flags);
437 int bus_generic_translate_resource(device_t dev, int type, rman_res_t start,
438 rman_res_t *newstart);
439 int bus_generic_attach(device_t dev);
440 int bus_generic_bind_intr(device_t dev, device_t child,
441 struct resource *irq, int cpu);
442 int bus_generic_child_location(device_t dev, device_t child, struct sbuf *sb);
443 int bus_generic_child_pnpinfo(device_t dev, device_t child, struct sbuf *sb);
444 int bus_generic_child_present(device_t dev, device_t child);
445 int bus_generic_config_intr(device_t, int, enum intr_trigger,
447 int bus_generic_describe_intr(device_t dev, device_t child,
448 struct resource *irq, void *cookie,
450 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
451 int rid, struct resource *r);
452 int bus_generic_detach(device_t dev);
453 void bus_generic_driver_added(device_t dev, driver_t *driver);
454 int bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
455 size_t setsize, struct _cpuset *cpuset);
457 bus_generic_get_dma_tag(device_t dev, device_t child);
459 bus_generic_get_bus_tag(device_t dev, device_t child);
460 int bus_generic_get_domain(device_t dev, device_t child, int *domain);
461 ssize_t bus_generic_get_property(device_t dev, device_t child,
462 const char *propname, void *propvalue,
463 size_t size, device_property_type_t type);
464 struct resource_list *
465 bus_generic_get_resource_list(device_t, device_t);
466 int bus_generic_map_resource(device_t dev, device_t child, int type,
468 struct resource_map_request *args,
469 struct resource_map *map);
470 void bus_generic_new_pass(device_t dev);
471 int bus_print_child_header(device_t dev, device_t child);
472 int bus_print_child_domain(device_t dev, device_t child);
473 int bus_print_child_footer(device_t dev, device_t child);
474 int bus_generic_print_child(device_t dev, device_t child);
475 int bus_generic_probe(device_t dev);
476 int bus_generic_read_ivar(device_t dev, device_t child, int which,
478 int bus_generic_release_resource(device_t bus, device_t child,
479 int type, int rid, struct resource *r);
480 int bus_generic_resume(device_t dev);
481 int bus_generic_resume_child(device_t dev, device_t child);
482 int bus_generic_setup_intr(device_t dev, device_t child,
483 struct resource *irq, int flags,
484 driver_filter_t *filter, driver_intr_t *intr,
485 void *arg, void **cookiep);
488 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
489 rman_res_t, rman_res_t, rman_res_t, u_int);
490 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
491 int bus_generic_rl_get_resource (device_t, device_t, int, int, rman_res_t *,
493 int bus_generic_rl_set_resource (device_t, device_t, int, int, rman_res_t,
495 int bus_generic_rl_release_resource (device_t, device_t, int, int,
498 int bus_generic_shutdown(device_t dev);
499 int bus_generic_suspend(device_t dev);
500 int bus_generic_suspend_child(device_t dev, device_t child);
501 int bus_generic_teardown_intr(device_t dev, device_t child,
502 struct resource *irq, void *cookie);
503 int bus_generic_suspend_intr(device_t dev, device_t child,
504 struct resource *irq);
505 int bus_generic_resume_intr(device_t dev, device_t child,
506 struct resource *irq);
507 int bus_generic_unmap_resource(device_t dev, device_t child, int type,
509 struct resource_map *map);
510 int bus_generic_write_ivar(device_t dev, device_t child, int which,
512 int bus_generic_get_device_path(device_t bus, device_t child, const char *locator,
514 int bus_helper_reset_post(device_t dev, int flags);
515 int bus_helper_reset_prepare(device_t dev, int flags);
516 int bus_null_rescan(device_t dev);
519 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
523 struct resource_spec {
528 #define RESOURCE_SPEC_END {-1, 0, 0}
530 int bus_alloc_resources(device_t dev, struct resource_spec *rs,
531 struct resource **res);
532 void bus_release_resources(device_t dev, const struct resource_spec *rs,
533 struct resource **res);
535 int bus_adjust_resource(device_t child, int type, struct resource *r,
536 rman_res_t start, rman_res_t end);
537 int bus_translate_resource(device_t child, int type, rman_res_t start,
538 rman_res_t *newstart);
539 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
540 rman_res_t start, rman_res_t end,
541 rman_res_t count, u_int flags);
542 int bus_activate_resource(device_t dev, int type, int rid,
544 int bus_deactivate_resource(device_t dev, int type, int rid,
546 int bus_map_resource(device_t dev, int type, struct resource *r,
547 struct resource_map_request *args,
548 struct resource_map *map);
549 int bus_unmap_resource(device_t dev, int type, struct resource *r,
550 struct resource_map *map);
551 int bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize,
552 struct _cpuset *cpuset);
553 bus_dma_tag_t bus_get_dma_tag(device_t dev);
554 bus_space_tag_t bus_get_bus_tag(device_t dev);
555 int bus_get_domain(device_t dev, int *domain);
556 int bus_release_resource(device_t dev, int type, int rid,
558 int bus_free_resource(device_t dev, int type, struct resource *r);
559 int bus_setup_intr(device_t dev, struct resource *r, int flags,
560 driver_filter_t filter, driver_intr_t handler,
561 void *arg, void **cookiep);
562 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
563 int bus_suspend_intr(device_t dev, struct resource *r);
564 int bus_resume_intr(device_t dev, struct resource *r);
565 int bus_bind_intr(device_t dev, struct resource *r, int cpu);
566 int bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
567 const char *fmt, ...) __printflike(4, 5);
568 int bus_set_resource(device_t dev, int type, int rid,
569 rman_res_t start, rman_res_t count);
570 int bus_get_resource(device_t dev, int type, int rid,
571 rman_res_t *startp, rman_res_t *countp);
572 rman_res_t bus_get_resource_start(device_t dev, int type, int rid);
573 rman_res_t bus_get_resource_count(device_t dev, int type, int rid);
574 void bus_delete_resource(device_t dev, int type, int rid);
575 int bus_child_present(device_t child);
576 int bus_child_pnpinfo(device_t child, struct sbuf *sb);
577 int bus_child_location(device_t child, struct sbuf *sb);
578 void bus_enumerate_hinted_children(device_t bus);
579 int bus_delayed_attach_children(device_t bus);
581 static __inline struct resource *
582 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
584 return (bus_alloc_resource(dev, type, rid, 0, ~0, 1, flags));
587 static __inline struct resource *
588 bus_alloc_resource_anywhere(device_t dev, int type, int *rid,
589 rman_res_t count, u_int flags)
591 return (bus_alloc_resource(dev, type, rid, 0, ~0, count, flags));
595 * Access functions for device.
597 device_t device_add_child(device_t dev, const char *name, int unit);
598 device_t device_add_child_ordered(device_t dev, u_int order,
599 const char *name, int unit);
600 void device_busy(device_t dev);
601 int device_delete_child(device_t dev, device_t child);
602 int device_delete_children(device_t dev);
603 int device_attach(device_t dev);
604 int device_detach(device_t dev);
605 void device_disable(device_t dev);
606 void device_enable(device_t dev);
607 device_t device_find_child(device_t dev, const char *classname,
609 const char *device_get_desc(device_t dev);
610 devclass_t device_get_devclass(device_t dev);
611 driver_t *device_get_driver(device_t dev);
612 u_int32_t device_get_flags(device_t dev);
613 device_t device_get_parent(device_t dev);
614 int device_get_children(device_t dev, device_t **listp, int *countp);
615 void *device_get_ivars(device_t dev);
616 void device_set_ivars(device_t dev, void *ivars);
617 const char *device_get_name(device_t dev);
618 const char *device_get_nameunit(device_t dev);
619 void *device_get_softc(device_t dev);
620 device_state_t device_get_state(device_t dev);
621 int device_get_unit(device_t dev);
622 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
623 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
624 int device_has_quiet_children(device_t dev);
625 int device_is_alive(device_t dev); /* did probe succeed? */
626 int device_is_attached(device_t dev); /* did attach succeed? */
627 int device_is_enabled(device_t dev);
628 int device_is_suspended(device_t dev);
629 int device_is_quiet(device_t dev);
630 device_t device_lookup_by_name(const char *name);
631 int device_print_prettyname(device_t dev);
632 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
633 int device_log(device_t dev, int pri, const char *, ...) __printflike(3, 4);
634 int device_probe(device_t dev);
635 int device_probe_and_attach(device_t dev);
636 int device_probe_child(device_t bus, device_t dev);
637 int device_quiesce(device_t dev);
638 void device_quiet(device_t dev);
639 void device_quiet_children(device_t dev);
640 void device_set_desc(device_t dev, const char* desc);
641 void device_set_desc_copy(device_t dev, const char* desc);
642 int device_set_devclass(device_t dev, const char *classname);
643 int device_set_devclass_fixed(device_t dev, const char *classname);
644 bool device_is_devclass_fixed(device_t dev);
645 int device_set_driver(device_t dev, driver_t *driver);
646 void device_set_flags(device_t dev, u_int32_t flags);
647 void device_set_softc(device_t dev, void *softc);
648 void device_free_softc(void *softc);
649 void device_claim_softc(device_t dev);
650 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
651 int device_shutdown(device_t dev);
652 void device_unbusy(device_t dev);
653 void device_verbose(device_t dev);
654 ssize_t device_get_property(device_t dev, const char *prop, void *val,
655 size_t sz, device_property_type_t type);
656 bool device_has_property(device_t dev, const char *prop);
659 * Access functions for devclass.
661 int devclass_add_driver(devclass_t dc, driver_t *driver,
662 int pass, devclass_t *dcp);
663 devclass_t devclass_create(const char *classname);
664 int devclass_delete_driver(devclass_t busclass, driver_t *driver);
665 devclass_t devclass_find(const char *classname);
666 const char *devclass_get_name(devclass_t dc);
667 device_t devclass_get_device(devclass_t dc, int unit);
668 void *devclass_get_softc(devclass_t dc, int unit);
669 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
670 int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
671 int devclass_get_count(devclass_t dc);
672 int devclass_get_maxunit(devclass_t dc);
673 int devclass_find_free_unit(devclass_t dc, int unit);
674 void devclass_set_parent(devclass_t dc, devclass_t pdc);
675 devclass_t devclass_get_parent(devclass_t dc);
676 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
677 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
680 * Access functions for device resources.
682 int resource_int_value(const char *name, int unit, const char *resname,
684 int resource_long_value(const char *name, int unit, const char *resname,
686 int resource_string_value(const char *name, int unit, const char *resname,
687 const char **result);
688 int resource_disabled(const char *name, int unit);
689 int resource_find_match(int *anchor, const char **name, int *unit,
690 const char *resname, const char *value);
691 int resource_find_dev(int *anchor, const char *name, int *unit,
692 const char *resname, const char *value);
693 int resource_unset_value(const char *name, int unit, const char *resname);
696 * Functions for maintaining and checking consistency of
697 * bus information exported to userspace.
699 int bus_data_generation_check(int generation);
700 void bus_data_generation_update(void);
703 * Some convenience defines for probe routines to return. These are just
704 * suggested values, and there's nothing magical about them.
705 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
706 * possible other driver may exist (typically legacy drivers who don't follow
707 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
708 * suggested value that vendor supplied drivers use. This is for source or
709 * binary drivers that are not yet integrated into the FreeBSD tree. Its use
710 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
711 * for drivers to use. It is intended that nearly all of the drivers in the
712 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
713 * have special requirements like when there are two drivers that support
714 * overlapping series of hardware devices. In this case the one that supports
715 * the older part of the line would return this value, while the one that
716 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
717 * is for drivers that wish to have a generic form and a specialized form,
718 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
719 * for those buses that implement a generic device placeholder for devices on
720 * the bus that have no more specific driver for them (aka ugen).
721 * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
722 * for a device node, but accepts only devices that its parent has told it
725 #define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
726 #define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
727 #define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
728 #define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
729 #define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
730 #define BUS_PROBE_HOOVER (-1000000) /* Driver for any dev on bus */
731 #define BUS_PROBE_NOWILDCARD (-2000000000) /* No wildcard device matches */
734 * During boot, the device tree is scanned multiple times. Each scan,
735 * or pass, drivers may be attached to devices. Each driver
736 * attachment is assigned a pass number. Drivers may only probe and
737 * attach to devices if their pass number is less than or equal to the
738 * current system-wide pass number. The default pass is the last pass
739 * and is used by most drivers. Drivers needed by the scheduler are
740 * probed in earlier passes.
742 #define BUS_PASS_ROOT 0 /* Used to attach root0. */
743 #define BUS_PASS_BUS 10 /* Buses and bridges. */
744 #define BUS_PASS_CPU 20 /* CPU devices. */
745 #define BUS_PASS_RESOURCE 30 /* Resource discovery. */
746 #define BUS_PASS_INTERRUPT 40 /* Interrupt controllers. */
747 #define BUS_PASS_TIMER 50 /* Timers and clocks. */
748 #define BUS_PASS_SCHEDULER 60 /* Start scheduler. */
749 #define BUS_PASS_SUPPORTDEV 100000 /* Drivers which support DEFAULT drivers. */
750 #define BUS_PASS_DEFAULT __INT_MAX /* Everything else. */
752 #define BUS_PASS_ORDER_FIRST 0
753 #define BUS_PASS_ORDER_EARLY 2
754 #define BUS_PASS_ORDER_MIDDLE 5
755 #define BUS_PASS_ORDER_LATE 7
756 #define BUS_PASS_ORDER_LAST 9
758 #define BUS_LOCATOR_ACPI "ACPI"
759 #define BUS_LOCATOR_FREEBSD "FreeBSD"
760 #define BUS_LOCATOR_UEFI "UEFI"
762 extern int bus_current_pass;
764 void bus_set_pass(int pass);
767 * Routines to lock / unlock the newbus lock.
768 * Must be taken out to interact with newbus.
770 void bus_topo_lock(void);
771 void bus_topo_unlock(void);
772 struct mtx * bus_topo_mtx(void);
773 void bus_topo_assert(void);
776 * Shorthands for constructing method tables.
778 #define DEVMETHOD KOBJMETHOD
779 #define DEVMETHOD_END KOBJMETHOD_END
782 * Some common device interfaces.
784 #include "device_if.h"
789 int driver_module_handler(struct module *, int, void *);
792 * Module support for automatically adding drivers to buses.
794 struct driver_module_data {
795 int (*dmd_chainevh)(struct module *, int, void *);
797 const char *dmd_busname;
798 kobj_class_t dmd_driver;
799 devclass_t *dmd_devclass;
803 #define _DRIVER_MODULE_MACRO(_1, _2, _3, _4, _5, _6, _7, _8, NAME, ...) \
806 #define _EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
807 evh, arg, order, pass) \
809 static struct driver_module_data name##_##busname##_driver_mod = { \
812 (kobj_class_t) &driver, \
817 static moduledata_t name##_##busname##_mod = { \
818 #busname "/" #name, \
819 driver_module_handler, \
820 &name##_##busname##_driver_mod \
822 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
823 SI_SUB_DRIVERS, order)
825 #define EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg, \
827 _EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, NULL, evh, \
830 #define EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass, \
831 evh, arg, order, pass) \
832 _EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, &devclass, \
833 evh, arg, order, pass)
835 #define EARLY_DRIVER_MODULE_ORDERED(...) \
836 _DRIVER_MODULE_MACRO(__VA_ARGS__, EARLY_DRIVER_MODULE_ORDERED8, \
837 EARLY_DRIVER_MODULE_ORDERED7)(__VA_ARGS__)
839 #define EARLY_DRIVER_MODULE7(name, busname, driver, devclass, evh, arg, pass) \
840 EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass, \
841 evh, arg, SI_ORDER_MIDDLE, pass)
843 #define EARLY_DRIVER_MODULE6(name, busname, driver, evh, arg, pass) \
844 EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg, \
845 SI_ORDER_MIDDLE, pass)
847 #define EARLY_DRIVER_MODULE(...) \
848 _DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, \
849 EARLY_DRIVER_MODULE7, EARLY_DRIVER_MODULE6)(__VA_ARGS__)
851 #define DRIVER_MODULE_ORDERED7(name, busname, driver, devclass, evh, arg,\
853 EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass, \
854 evh, arg, order, BUS_PASS_DEFAULT)
856 #define DRIVER_MODULE_ORDERED6(name, busname, driver, evh, arg, order) \
857 EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg, \
858 order, BUS_PASS_DEFAULT)
860 #define DRIVER_MODULE_ORDERED(...) \
861 _DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, \
862 DRIVER_MODULE_ORDERED7, DRIVER_MODULE_ORDERED6)(__VA_ARGS__)
864 #define DRIVER_MODULE6(name, busname, driver, devclass, evh, arg) \
865 EARLY_DRIVER_MODULE7(name, busname, driver, devclass, evh, arg, \
868 #define DRIVER_MODULE5(name, busname, driver, evh, arg) \
869 EARLY_DRIVER_MODULE6(name, busname, driver, evh, arg, \
872 #define DRIVER_MODULE(...) \
873 _DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, INVALID, \
874 DRIVER_MODULE6, DRIVER_MODULE5)(__VA_ARGS__)
877 * Generic ivar accessor generation macros for bus drivers
879 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
881 static __inline type varp ## _get_ ## var(device_t dev) \
885 e = BUS_READ_IVAR(device_get_parent(dev), dev, \
886 ivarp ## _IVAR_ ## ivar, &v); \
887 KASSERT(e == 0, ("%s failed for %s on bus %s, error = %d", \
888 __func__, device_get_nameunit(dev), \
889 device_get_nameunit(device_get_parent(dev)), e)); \
893 static __inline void varp ## _set_ ## var(device_t dev, type t) \
895 uintptr_t v = (uintptr_t) t; \
897 e = BUS_WRITE_IVAR(device_get_parent(dev), dev, \
898 ivarp ## _IVAR_ ## ivar, v); \
899 KASSERT(e == 0, ("%s failed for %s on bus %s, error = %d", \
900 __func__, device_get_nameunit(dev), \
901 device_get_nameunit(device_get_parent(dev)), e)); \
904 struct device_location_cache;
905 typedef struct device_location_cache device_location_cache_t;
906 device_location_cache_t *dev_wired_cache_init(void);
907 void dev_wired_cache_fini(device_location_cache_t *dcp);
908 bool dev_wired_cache_match(device_location_cache_t *dcp, device_t dev, const char *at);
912 * Shorthand macros, taking resource argument
913 * Generated with sys/tools/bus_macro.sh
916 #define bus_barrier(r, o, l, f) \
917 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
918 #define bus_poke_1(r, o, v) \
919 bus_space_poke_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
920 #define bus_peek_1(r, o, vp) \
921 bus_space_peek_1((r)->r_bustag, (r)->r_bushandle, (o), (vp))
922 #define bus_read_1(r, o) \
923 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
924 #define bus_read_multi_1(r, o, d, c) \
925 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
926 #define bus_read_region_1(r, o, d, c) \
927 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
928 #define bus_set_multi_1(r, o, v, c) \
929 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
930 #define bus_set_region_1(r, o, v, c) \
931 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
932 #define bus_write_1(r, o, v) \
933 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
934 #define bus_write_multi_1(r, o, d, c) \
935 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
936 #define bus_write_region_1(r, o, d, c) \
937 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
938 #define bus_read_stream_1(r, o) \
939 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
940 #define bus_read_multi_stream_1(r, o, d, c) \
941 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
942 #define bus_read_region_stream_1(r, o, d, c) \
943 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
944 #define bus_set_multi_stream_1(r, o, v, c) \
945 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
946 #define bus_set_region_stream_1(r, o, v, c) \
947 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
948 #define bus_write_stream_1(r, o, v) \
949 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
950 #define bus_write_multi_stream_1(r, o, d, c) \
951 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
952 #define bus_write_region_stream_1(r, o, d, c) \
953 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
954 #define bus_poke_2(r, o, v) \
955 bus_space_poke_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
956 #define bus_peek_2(r, o, vp) \
957 bus_space_peek_2((r)->r_bustag, (r)->r_bushandle, (o), (vp))
958 #define bus_read_2(r, o) \
959 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
960 #define bus_read_multi_2(r, o, d, c) \
961 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
962 #define bus_read_region_2(r, o, d, c) \
963 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
964 #define bus_set_multi_2(r, o, v, c) \
965 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
966 #define bus_set_region_2(r, o, v, c) \
967 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
968 #define bus_write_2(r, o, v) \
969 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
970 #define bus_write_multi_2(r, o, d, c) \
971 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
972 #define bus_write_region_2(r, o, d, c) \
973 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
974 #define bus_read_stream_2(r, o) \
975 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
976 #define bus_read_multi_stream_2(r, o, d, c) \
977 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
978 #define bus_read_region_stream_2(r, o, d, c) \
979 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
980 #define bus_set_multi_stream_2(r, o, v, c) \
981 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
982 #define bus_set_region_stream_2(r, o, v, c) \
983 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
984 #define bus_write_stream_2(r, o, v) \
985 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
986 #define bus_write_multi_stream_2(r, o, d, c) \
987 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
988 #define bus_write_region_stream_2(r, o, d, c) \
989 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
990 #define bus_poke_4(r, o, v) \
991 bus_space_poke_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
992 #define bus_peek_4(r, o, vp) \
993 bus_space_peek_4((r)->r_bustag, (r)->r_bushandle, (o), (vp))
994 #define bus_read_4(r, o) \
995 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
996 #define bus_read_multi_4(r, o, d, c) \
997 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
998 #define bus_read_region_4(r, o, d, c) \
999 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1000 #define bus_set_multi_4(r, o, v, c) \
1001 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1002 #define bus_set_region_4(r, o, v, c) \
1003 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1004 #define bus_write_4(r, o, v) \
1005 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
1006 #define bus_write_multi_4(r, o, d, c) \
1007 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1008 #define bus_write_region_4(r, o, d, c) \
1009 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1010 #define bus_read_stream_4(r, o) \
1011 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
1012 #define bus_read_multi_stream_4(r, o, d, c) \
1013 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1014 #define bus_read_region_stream_4(r, o, d, c) \
1015 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1016 #define bus_set_multi_stream_4(r, o, v, c) \
1017 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1018 #define bus_set_region_stream_4(r, o, v, c) \
1019 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1020 #define bus_write_stream_4(r, o, v) \
1021 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
1022 #define bus_write_multi_stream_4(r, o, d, c) \
1023 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1024 #define bus_write_region_stream_4(r, o, d, c) \
1025 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1026 #define bus_poke_8(r, o, v) \
1027 bus_space_poke_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
1028 #define bus_peek_8(r, o, vp) \
1029 bus_space_peek_8((r)->r_bustag, (r)->r_bushandle, (o), (vp))
1030 #define bus_read_8(r, o) \
1031 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
1032 #define bus_read_multi_8(r, o, d, c) \
1033 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1034 #define bus_read_region_8(r, o, d, c) \
1035 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1036 #define bus_set_multi_8(r, o, v, c) \
1037 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1038 #define bus_set_region_8(r, o, v, c) \
1039 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1040 #define bus_write_8(r, o, v) \
1041 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
1042 #define bus_write_multi_8(r, o, d, c) \
1043 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1044 #define bus_write_region_8(r, o, d, c) \
1045 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1046 #define bus_read_stream_8(r, o) \
1047 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
1048 #define bus_read_multi_stream_8(r, o, d, c) \
1049 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1050 #define bus_read_region_stream_8(r, o, d, c) \
1051 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1052 #define bus_set_multi_stream_8(r, o, v, c) \
1053 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1054 #define bus_set_region_stream_8(r, o, v, c) \
1055 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1056 #define bus_write_stream_8(r, o, v) \
1057 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
1058 #define bus_write_multi_stream_8(r, o, d, c) \
1059 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1060 #define bus_write_region_stream_8(r, o, d, c) \
1061 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1062 #endif /* _KERNEL */
1064 #endif /* !_SYS_BUS_H_ */