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