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