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