xref: /freebsd-13-stable/sys/sys/bus.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1997,1998,2003 Doug Rabson
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _SYS_BUS_H_
30 #define _SYS_BUS_H_
31 
32 #include <machine/_limits.h>
33 #include <machine/_bus.h>
34 #include <sys/_bus_dma.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	2
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 proprty types.
64  *
65  * Those are used by bus logic to encode requested properties,
66  * e.g. in DT all properties are stored as BE and need to be converted
67  * to host endianness.
68  */
69 typedef enum device_property_type {
70 	DEVICE_PROP_ANY = 0,
71 	DEVICE_PROP_BUFFER = 1,
72 	DEVICE_PROP_UINT32 = 2,
73 	DEVICE_PROP_UINT64 = 3,
74 	DEVICE_PROP_HANDLE = 4,
75 } device_property_type_t;
76 
77 /**
78  * @brief Device information exported to userspace.
79  * The strings are placed one after the other, separated by NUL characters.
80  * Fields should be added after the last one and order maintained for compatibility
81  */
82 #define BUS_USER_BUFFER		(3*1024)
83 struct u_device {
84 	uintptr_t	dv_handle;
85 	uintptr_t	dv_parent;
86 	uint32_t	dv_devflags;		/**< @brief API Flags for device */
87 	uint16_t	dv_flags;		/**< @brief flags for dev state */
88 	device_state_t	dv_state;		/**< @brief State of attachment */
89 	char		dv_fields[BUS_USER_BUFFER]; /**< @brief NUL terminated fields */
90 	/* name (name of the device in tree) */
91 	/* desc (driver description) */
92 	/* drivername (Name of driver without unit number) */
93 	/* pnpinfo (Plug and play information from bus) */
94 	/* location (Location of device on parent */
95 	/* NUL */
96 };
97 
98 /* Flags exported via dv_flags. */
99 #define	DF_ENABLED	0x01		/* device should be probed/attached */
100 #define	DF_FIXEDCLASS	0x02		/* devclass specified at create time */
101 #define	DF_WILDCARD	0x04		/* unit was originally wildcard */
102 #define	DF_DESCMALLOCED	0x08		/* description was malloced */
103 #define	DF_QUIET	0x10		/* don't print verbose attach message */
104 #define	DF_DONENOMATCH	0x20		/* don't execute DEVICE_NOMATCH again */
105 #define	DF_EXTERNALSOFTC 0x40		/* softc not allocated by us */
106 #define	DF_SUSPENDED	0x100		/* Device is suspended. */
107 #define	DF_QUIET_CHILDREN 0x200		/* Default to quiet for all my children */
108 #define	DF_ATTACHED_ONCE 0x400		/* Has been attached at least once */
109 #define	DF_NEEDNOMATCH	0x800		/* Has a pending NOMATCH event */
110 
111 /**
112  * @brief Device request structure used for ioctl's.
113  *
114  * Used for ioctl's on /dev/devctl2.  All device ioctl's
115  * must have parameter definitions which begin with dr_name.
116  */
117 struct devreq_buffer {
118 	void	*buffer;
119 	size_t	length;
120 };
121 
122 struct devreq {
123 	char		dr_name[128];
124 	int		dr_flags;		/* request-specific flags */
125 	union {
126 		struct devreq_buffer dru_buffer;
127 		void	*dru_data;
128 	} dr_dru;
129 #define	dr_buffer	dr_dru.dru_buffer	/* variable-sized buffer */
130 #define	dr_data		dr_dru.dru_data		/* fixed-size buffer */
131 };
132 
133 #define	DEV_ATTACH	_IOW('D', 1, struct devreq)
134 #define	DEV_DETACH	_IOW('D', 2, struct devreq)
135 #define	DEV_ENABLE	_IOW('D', 3, struct devreq)
136 #define	DEV_DISABLE	_IOW('D', 4, struct devreq)
137 #define	DEV_SUSPEND	_IOW('D', 5, struct devreq)
138 #define	DEV_RESUME	_IOW('D', 6, struct devreq)
139 #define	DEV_SET_DRIVER	_IOW('D', 7, struct devreq)
140 #define	DEV_CLEAR_DRIVER _IOW('D', 8, struct devreq)
141 #define	DEV_RESCAN	_IOW('D', 9, struct devreq)
142 #define	DEV_DELETE	_IOW('D', 10, struct devreq)
143 #define	DEV_FREEZE	_IOW('D', 11, struct devreq)
144 #define	DEV_THAW	_IOW('D', 12, struct devreq)
145 #define	DEV_RESET	_IOW('D', 13, struct devreq)
146 
147 /* Flags for DEV_DETACH and DEV_DISABLE. */
148 #define	DEVF_FORCE_DETACH	0x0000001
149 
150 /* Flags for DEV_SET_DRIVER. */
151 #define	DEVF_SET_DRIVER_DETACH	0x0000001	/* Detach existing driver. */
152 
153 /* Flags for DEV_CLEAR_DRIVER. */
154 #define	DEVF_CLEAR_DRIVER_DETACH 0x0000001	/* Detach existing driver. */
155 
156 /* Flags for DEV_DELETE. */
157 #define	DEVF_FORCE_DELETE	0x0000001
158 
159 /* Flags for DEV_RESET */
160 #define	DEVF_RESET_DETACH	0x0000001	/* Detach drivers vs suspend
161 						   device */
162 
163 #ifdef _KERNEL
164 
165 #include <sys/_eventhandler.h>
166 #include <sys/kobj.h>
167 #include <sys/systm.h>
168 #include <sys/devctl.h>
169 
170 /**
171  * Device name parsers.  Hook to allow device enumerators to map
172  * scheme-specific names to a device.
173  */
174 typedef void (*dev_lookup_fn)(void *arg, const char *name,
175     device_t *result);
176 EVENTHANDLER_DECLARE(dev_lookup, dev_lookup_fn);
177 
178 /**
179  * @brief A device driver (included mainly for compatibility with
180  * FreeBSD 4.x).
181  */
182 typedef struct kobj_class	driver_t;
183 
184 /**
185  * @brief A device class
186  *
187  * The devclass object has two main functions in the system. The first
188  * is to manage the allocation of unit numbers for device instances
189  * and the second is to hold the list of device drivers for a
190  * particular bus type. Each devclass has a name and there cannot be
191  * two devclasses with the same name. This ensures that unique unit
192  * numbers are allocated to device instances.
193  *
194  * Drivers that support several different bus attachments (e.g. isa,
195  * pci, pccard) should all use the same devclass to ensure that unit
196  * numbers do not conflict.
197  *
198  * Each devclass may also have a parent devclass. This is used when
199  * searching for device drivers to allow a form of inheritance. When
200  * matching drivers with devices, first the driver list of the parent
201  * device's devclass is searched. If no driver is found in that list,
202  * the search continues in the parent devclass (if any).
203  */
204 typedef struct devclass		*devclass_t;
205 
206 /**
207  * @brief A device method
208  */
209 #define device_method_t		kobj_method_t
210 
211 /**
212  * @brief Driver interrupt filter return values
213  *
214  * If a driver provides an interrupt filter routine it must return an
215  * integer consisting of oring together zero or more of the following
216  * flags:
217  *
218  *	FILTER_STRAY	- this device did not trigger the interrupt
219  *	FILTER_HANDLED	- the interrupt has been fully handled and can be EOId
220  *	FILTER_SCHEDULE_THREAD - the threaded interrupt handler should be
221  *			  scheduled to execute
222  *
223  * If the driver does not provide a filter, then the interrupt code will
224  * act is if the filter had returned FILTER_SCHEDULE_THREAD.  Note that it
225  * is illegal to specify any other flag with FILTER_STRAY and that it is
226  * illegal to not specify either of FILTER_HANDLED or FILTER_SCHEDULE_THREAD
227  * if FILTER_STRAY is not specified.
228  */
229 #define	FILTER_STRAY		0x01
230 #define	FILTER_HANDLED		0x02
231 #define	FILTER_SCHEDULE_THREAD	0x04
232 
233 /**
234  * @brief Driver interrupt service routines
235  *
236  * The filter routine is run in primary interrupt context and may not
237  * block or use regular mutexes.  It may only use spin mutexes for
238  * synchronization.  The filter may either completely handle the
239  * interrupt or it may perform some of the work and defer more
240  * expensive work to the regular interrupt handler.  If a filter
241  * routine is not registered by the driver, then the regular interrupt
242  * handler is always used to handle interrupts from this device.
243  *
244  * The regular interrupt handler executes in its own thread context
245  * and may use regular mutexes.  However, it is prohibited from
246  * sleeping on a sleep queue.
247  */
248 typedef int driver_filter_t(void*);
249 typedef void driver_intr_t(void*);
250 
251 /**
252  * @brief Interrupt type bits.
253  *
254  * These flags may be passed by drivers to bus_setup_intr(9) when
255  * registering a new interrupt handler. The field is overloaded to
256  * specify both the interrupt's type and any special properties.
257  *
258  * The INTR_TYPE* bits will be passed to intr_priority(9) to determine the
259  * scheduling priority of the handler's ithread. For the specific priority
260  * values assigned to each type, see sys/priority.h.
261  *
262  * Buses may choose to modify or augment these flags as appropriate,
263  * e.g. nexus may apply INTR_EXCL.
264  */
265 enum intr_type {
266 	INTR_TYPE_TTY = 1,
267 	INTR_TYPE_BIO = 2,
268 	INTR_TYPE_NET = 4,
269 	INTR_TYPE_CAM = 8,
270 	INTR_TYPE_MISC = 16,
271 	INTR_TYPE_CLK = 32,
272 	INTR_TYPE_AV = 64,
273 	INTR_EXCL = 256,		/* exclusive interrupt */
274 	INTR_MPSAFE = 512,		/* this interrupt is SMP safe */
275 	INTR_ENTROPY = 1024,		/* this interrupt provides entropy */
276 	INTR_MD1 = 4096,		/* flag reserved for MD use */
277 	INTR_MD2 = 8192,		/* flag reserved for MD use */
278 	INTR_MD3 = 16384,		/* flag reserved for MD use */
279 	INTR_MD4 = 32768		/* flag reserved for MD use */
280 };
281 
282 enum intr_trigger {
283 	INTR_TRIGGER_INVALID = -1,
284 	INTR_TRIGGER_CONFORM = 0,
285 	INTR_TRIGGER_EDGE = 1,
286 	INTR_TRIGGER_LEVEL = 2
287 };
288 
289 enum intr_polarity {
290 	INTR_POLARITY_CONFORM = 0,
291 	INTR_POLARITY_HIGH = 1,
292 	INTR_POLARITY_LOW = 2
293 };
294 
295 /**
296  * CPU sets supported by bus_get_cpus().  Note that not all sets may be
297  * supported for a given device.  If a request is not supported by a
298  * device (or its parents), then bus_get_cpus() will fail with EINVAL.
299  */
300 enum cpu_sets {
301 	LOCAL_CPUS = 0,
302 	INTR_CPUS
303 };
304 
305 typedef int (*devop_t)(void);
306 
307 /**
308  * @brief This structure is deprecated.
309  *
310  * Use the kobj(9) macro DEFINE_CLASS to
311  * declare classes which implement device drivers.
312  */
313 struct driver {
314 	KOBJ_CLASS_FIELDS;
315 };
316 
317 /**
318  * @brief A resource mapping.
319  */
320 struct resource_map {
321 	bus_space_tag_t r_bustag;
322 	bus_space_handle_t r_bushandle;
323 	bus_size_t r_size;
324 	void	*r_vaddr;
325 };
326 
327 /**
328  * @brief Optional properties of a resource mapping request.
329  */
330 struct resource_map_request {
331 	size_t	size;
332 	rman_res_t offset;
333 	rman_res_t length;
334 	vm_memattr_t memattr;
335 };
336 
337 void	resource_init_map_request_impl(struct resource_map_request *_args,
338 	    size_t _sz);
339 #define	resource_init_map_request(rmr) 					\
340 	resource_init_map_request_impl((rmr), sizeof(*(rmr)))
341 
342 /*
343  * Definitions for drivers which need to keep simple lists of resources
344  * for their child devices.
345  */
346 struct	resource;
347 
348 /**
349  * @brief An entry for a single resource in a resource list.
350  */
351 struct resource_list_entry {
352 	STAILQ_ENTRY(resource_list_entry) link;
353 	int	type;			/**< @brief type argument to alloc_resource */
354 	int	rid;			/**< @brief resource identifier */
355 	int	flags;			/**< @brief resource flags */
356 	struct	resource *res;		/**< @brief the real resource when allocated */
357 	rman_res_t	start;		/**< @brief start of resource range */
358 	rman_res_t	end;		/**< @brief end of resource range */
359 	rman_res_t	count;			/**< @brief count within range */
360 };
361 STAILQ_HEAD(resource_list, resource_list_entry);
362 
363 #define	RLE_RESERVED		0x0001	/* Reserved by the parent bus. */
364 #define	RLE_ALLOCATED		0x0002	/* Reserved resource is allocated. */
365 #define	RLE_PREFETCH		0x0004	/* Resource is a prefetch range. */
366 
367 void	resource_list_init(struct resource_list *rl);
368 void	resource_list_free(struct resource_list *rl);
369 struct resource_list_entry *
370 	resource_list_add(struct resource_list *rl,
371 			  int type, int rid,
372 			  rman_res_t start, rman_res_t end, rman_res_t count);
373 int	resource_list_add_next(struct resource_list *rl,
374 			  int type,
375 			  rman_res_t start, rman_res_t end, rman_res_t count);
376 int	resource_list_busy(struct resource_list *rl,
377 			   int type, int rid);
378 int	resource_list_reserved(struct resource_list *rl, int type, int rid);
379 struct resource_list_entry*
380 	resource_list_find(struct resource_list *rl,
381 			   int type, int rid);
382 void	resource_list_delete(struct resource_list *rl,
383 			     int type, int rid);
384 struct resource *
385 	resource_list_alloc(struct resource_list *rl,
386 			    device_t bus, device_t child,
387 			    int type, int *rid,
388 			    rman_res_t start, rman_res_t end,
389 			    rman_res_t count, u_int flags);
390 int	resource_list_release(struct resource_list *rl,
391 			      device_t bus, device_t child,
392 			      int type, int rid, struct resource *res);
393 int	resource_list_release_active(struct resource_list *rl,
394 				     device_t bus, device_t child,
395 				     int type);
396 struct resource *
397 	resource_list_reserve(struct resource_list *rl,
398 			      device_t bus, device_t child,
399 			      int type, int *rid,
400 			      rman_res_t start, rman_res_t end,
401 			      rman_res_t count, u_int flags);
402 int	resource_list_unreserve(struct resource_list *rl,
403 				device_t bus, device_t child,
404 				int type, int rid);
405 void	resource_list_purge(struct resource_list *rl);
406 int	resource_list_print_type(struct resource_list *rl,
407 				 const char *name, int type,
408 				 const char *format);
409 
410 /*
411  * The root bus, to which all top-level buses are attached.
412  */
413 extern device_t root_bus;
414 extern devclass_t root_devclass;
415 void	root_bus_configure(void);
416 
417 /*
418  * Useful functions for implementing buses.
419  */
420 
421 struct _cpuset;
422 
423 int	bus_generic_activate_resource(device_t dev, device_t child, int type,
424 				      int rid, struct resource *r);
425 device_t
426 	bus_generic_add_child(device_t dev, u_int order, const char *name,
427 			      int unit);
428 int	bus_generic_adjust_resource(device_t bus, device_t child, int type,
429 				    struct resource *r, rman_res_t start,
430 				    rman_res_t end);
431 struct resource *
432 	bus_generic_alloc_resource(device_t bus, device_t child, int type,
433 				   int *rid, rman_res_t start, rman_res_t end,
434 				   rman_res_t count, u_int flags);
435 int	bus_generic_translate_resource(device_t dev, int type, rman_res_t start,
436 			      rman_res_t *newstart);
437 int	bus_generic_attach(device_t dev);
438 int	bus_generic_bind_intr(device_t dev, device_t child,
439 			      struct resource *irq, int cpu);
440 int	bus_generic_child_present(device_t dev, device_t child);
441 int	bus_generic_config_intr(device_t, int, enum intr_trigger,
442 				enum intr_polarity);
443 int	bus_generic_describe_intr(device_t dev, device_t child,
444 				  struct resource *irq, void *cookie,
445 				  const char *descr);
446 int	bus_generic_deactivate_resource(device_t dev, device_t child, int type,
447 					int rid, struct resource *r);
448 int	bus_generic_detach(device_t dev);
449 void	bus_generic_driver_added(device_t dev, driver_t *driver);
450 int	bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op,
451 			     size_t setsize, struct _cpuset *cpuset);
452 bus_dma_tag_t
453 	bus_generic_get_dma_tag(device_t dev, device_t child);
454 bus_space_tag_t
455 	bus_generic_get_bus_tag(device_t dev, device_t child);
456 int	bus_generic_get_domain(device_t dev, device_t child, int *domain);
457 ssize_t	bus_generic_get_property(device_t dev, device_t child,
458 				 const char *propname, void *propvalue,
459 				 size_t size, device_property_type_t type);
460 struct resource_list *
461 	bus_generic_get_resource_list (device_t, device_t);
462 int	bus_generic_map_resource(device_t dev, device_t child, int type,
463 				 struct resource *r,
464 				 struct resource_map_request *args,
465 				 struct resource_map *map);
466 void	bus_generic_new_pass(device_t dev);
467 int	bus_print_child_header(device_t dev, device_t child);
468 int	bus_print_child_domain(device_t dev, device_t child);
469 int	bus_print_child_footer(device_t dev, device_t child);
470 int	bus_generic_print_child(device_t dev, device_t child);
471 int	bus_generic_probe(device_t dev);
472 int	bus_generic_read_ivar(device_t dev, device_t child, int which,
473 			      uintptr_t *result);
474 int	bus_generic_release_resource(device_t bus, device_t child,
475 				     int type, int rid, struct resource *r);
476 int	bus_generic_resume(device_t dev);
477 int	bus_generic_resume_child(device_t dev, device_t child);
478 int	bus_generic_setup_intr(device_t dev, device_t child,
479 			       struct resource *irq, int flags,
480 			       driver_filter_t *filter, driver_intr_t *intr,
481 			       void *arg, void **cookiep);
482 
483 struct resource *
484 	bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
485 				       rman_res_t, rman_res_t, rman_res_t, u_int);
486 void	bus_generic_rl_delete_resource (device_t, device_t, int, int);
487 int	bus_generic_rl_get_resource (device_t, device_t, int, int, rman_res_t *,
488 				     rman_res_t *);
489 int	bus_generic_rl_set_resource (device_t, device_t, int, int, rman_res_t,
490 				     rman_res_t);
491 int	bus_generic_rl_release_resource (device_t, device_t, int, int,
492 					 struct resource *);
493 
494 int	bus_generic_shutdown(device_t dev);
495 int	bus_generic_suspend(device_t dev);
496 int	bus_generic_suspend_child(device_t dev, device_t child);
497 int	bus_generic_teardown_intr(device_t dev, device_t child,
498 				  struct resource *irq, void *cookie);
499 int	bus_generic_suspend_intr(device_t dev, device_t child,
500 				  struct resource *irq);
501 int	bus_generic_resume_intr(device_t dev, device_t child,
502 				  struct resource *irq);
503 int	bus_generic_unmap_resource(device_t dev, device_t child, int type,
504 				   struct resource *r,
505 				   struct resource_map *map);
506 int	bus_generic_write_ivar(device_t dev, device_t child, int which,
507 			       uintptr_t value);
508 int	bus_helper_reset_post(device_t dev, int flags);
509 int	bus_helper_reset_prepare(device_t dev, int flags);
510 int	bus_null_rescan(device_t dev);
511 
512 /*
513  * Wrapper functions for the BUS_*_RESOURCE methods to make client code
514  * a little simpler.
515  */
516 
517 struct resource_spec {
518 	int	type;
519 	int	rid;
520 	int	flags;
521 };
522 #define	RESOURCE_SPEC_END	{-1, 0, 0}
523 
524 int	bus_alloc_resources(device_t dev, struct resource_spec *rs,
525 			    struct resource **res);
526 void	bus_release_resources(device_t dev, const struct resource_spec *rs,
527 			      struct resource **res);
528 
529 int	bus_adjust_resource(device_t child, int type, struct resource *r,
530 			    rman_res_t start, rman_res_t end);
531 struct	resource *bus_alloc_resource(device_t dev, int type, int *rid,
532 				     rman_res_t start, rman_res_t end,
533 				     rman_res_t count, u_int flags);
534 int	bus_activate_resource(device_t dev, int type, int rid,
535 			      struct resource *r);
536 int	bus_deactivate_resource(device_t dev, int type, int rid,
537 				struct resource *r);
538 int	bus_map_resource(device_t dev, int type, struct resource *r,
539 			 struct resource_map_request *args,
540 			 struct resource_map *map);
541 int	bus_unmap_resource(device_t dev, int type, struct resource *r,
542 			   struct resource_map *map);
543 int	bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize,
544 		     struct _cpuset *cpuset);
545 bus_dma_tag_t bus_get_dma_tag(device_t dev);
546 bus_space_tag_t bus_get_bus_tag(device_t dev);
547 int	bus_get_domain(device_t dev, int *domain);
548 int	bus_release_resource(device_t dev, int type, int rid,
549 			     struct resource *r);
550 int	bus_free_resource(device_t dev, int type, struct resource *r);
551 int	bus_setup_intr(device_t dev, struct resource *r, int flags,
552 		       driver_filter_t filter, driver_intr_t handler,
553 		       void *arg, void **cookiep);
554 int	bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
555 int	bus_suspend_intr(device_t dev, struct resource *r);
556 int	bus_resume_intr(device_t dev, struct resource *r);
557 int	bus_bind_intr(device_t dev, struct resource *r, int cpu);
558 int	bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
559 			  const char *fmt, ...) __printflike(4, 5);
560 int	bus_set_resource(device_t dev, int type, int rid,
561 			 rman_res_t start, rman_res_t count);
562 int	bus_get_resource(device_t dev, int type, int rid,
563 			 rman_res_t *startp, rman_res_t *countp);
564 rman_res_t	bus_get_resource_start(device_t dev, int type, int rid);
565 rman_res_t	bus_get_resource_count(device_t dev, int type, int rid);
566 void	bus_delete_resource(device_t dev, int type, int rid);
567 int	bus_child_present(device_t child);
568 int	bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
569 int	bus_child_location_str(device_t child, char *buf, size_t buflen);
570 void	bus_enumerate_hinted_children(device_t bus);
571 int	bus_delayed_attach_children(device_t bus);
572 
573 static __inline struct resource *
bus_alloc_resource_any(device_t dev,int type,int * rid,u_int flags)574 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
575 {
576 	return (bus_alloc_resource(dev, type, rid, 0, ~0, 1, flags));
577 }
578 
579 static __inline struct resource *
bus_alloc_resource_anywhere(device_t dev,int type,int * rid,rman_res_t count,u_int flags)580 bus_alloc_resource_anywhere(device_t dev, int type, int *rid,
581     rman_res_t count, u_int flags)
582 {
583 	return (bus_alloc_resource(dev, type, rid, 0, ~0, count, flags));
584 }
585 
586 /*
587  * Access functions for device.
588  */
589 device_t	device_add_child(device_t dev, const char *name, int unit);
590 device_t	device_add_child_ordered(device_t dev, u_int order,
591 					 const char *name, int unit);
592 void	device_busy(device_t dev);
593 int	device_delete_child(device_t dev, device_t child);
594 int	device_delete_children(device_t dev);
595 int	device_attach(device_t dev);
596 int	device_detach(device_t dev);
597 void	device_disable(device_t dev);
598 void	device_enable(device_t dev);
599 device_t	device_find_child(device_t dev, const char *classname,
600 				  int unit);
601 const char	*device_get_desc(device_t dev);
602 devclass_t	device_get_devclass(device_t dev);
603 driver_t	*device_get_driver(device_t dev);
604 u_int32_t	device_get_flags(device_t dev);
605 device_t	device_get_parent(device_t dev);
606 int	device_get_children(device_t dev, device_t **listp, int *countp);
607 void	*device_get_ivars(device_t dev);
608 void	device_set_ivars(device_t dev, void *ivars);
609 const	char *device_get_name(device_t dev);
610 const	char *device_get_nameunit(device_t dev);
611 void	*device_get_softc(device_t dev);
612 device_state_t	device_get_state(device_t dev);
613 int	device_get_unit(device_t dev);
614 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
615 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
616 int	device_has_quiet_children(device_t dev);
617 int	device_is_alive(device_t dev);	/* did probe succeed? */
618 int	device_is_attached(device_t dev);	/* did attach succeed? */
619 int	device_is_enabled(device_t dev);
620 int	device_is_suspended(device_t dev);
621 int	device_is_quiet(device_t dev);
622 device_t device_lookup_by_name(const char *name);
623 int	device_print_prettyname(device_t dev);
624 int	device_printf(device_t dev, const char *, ...) __printflike(2, 3);
625 int	device_log(device_t dev, int pri, const char *, ...) __printflike(3, 4);
626 int	device_probe(device_t dev);
627 int	device_probe_and_attach(device_t dev);
628 int	device_probe_child(device_t bus, device_t dev);
629 int	device_quiesce(device_t dev);
630 void	device_quiet(device_t dev);
631 void	device_quiet_children(device_t dev);
632 void	device_set_desc(device_t dev, const char* desc);
633 void	device_set_desc_copy(device_t dev, const char* desc);
634 int	device_set_devclass(device_t dev, const char *classname);
635 int	device_set_devclass_fixed(device_t dev, const char *classname);
636 bool	device_is_devclass_fixed(device_t dev);
637 int	device_set_driver(device_t dev, driver_t *driver);
638 void	device_set_flags(device_t dev, u_int32_t flags);
639 void	device_set_softc(device_t dev, void *softc);
640 void	device_free_softc(void *softc);
641 void	device_claim_softc(device_t dev);
642 int	device_set_unit(device_t dev, int unit);	/* XXX DONT USE XXX */
643 int	device_shutdown(device_t dev);
644 void	device_unbusy(device_t dev);
645 void	device_verbose(device_t dev);
646 ssize_t	device_get_property(device_t dev, const char *prop, void *val,
647     size_t sz, device_property_type_t type);
648 bool device_has_property(device_t dev, const char *prop);
649 
650 /*
651  * Access functions for devclass.
652  */
653 int		devclass_add_driver(devclass_t dc, driver_t *driver,
654 				    int pass, devclass_t *dcp);
655 devclass_t	devclass_create(const char *classname);
656 int		devclass_delete_driver(devclass_t busclass, driver_t *driver);
657 devclass_t	devclass_find(const char *classname);
658 const char	*devclass_get_name(devclass_t dc);
659 device_t	devclass_get_device(devclass_t dc, int unit);
660 void	*devclass_get_softc(devclass_t dc, int unit);
661 int	devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
662 int	devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
663 int	devclass_get_count(devclass_t dc);
664 int	devclass_get_maxunit(devclass_t dc);
665 int	devclass_find_free_unit(devclass_t dc, int unit);
666 void	devclass_set_parent(devclass_t dc, devclass_t pdc);
667 devclass_t	devclass_get_parent(devclass_t dc);
668 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
669 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
670 
671 /*
672  * Access functions for device resources.
673  */
674 int	resource_int_value(const char *name, int unit, const char *resname,
675 			   int *result);
676 int	resource_long_value(const char *name, int unit, const char *resname,
677 			    long *result);
678 int	resource_string_value(const char *name, int unit, const char *resname,
679 			      const char **result);
680 int	resource_disabled(const char *name, int unit);
681 int	resource_find_match(int *anchor, const char **name, int *unit,
682 			    const char *resname, const char *value);
683 int	resource_find_dev(int *anchor, const char *name, int *unit,
684 			  const char *resname, const char *value);
685 int	resource_unset_value(const char *name, int unit, const char *resname);
686 
687 /*
688  * Functions for maintaining and checking consistency of
689  * bus information exported to userspace.
690  */
691 int	bus_data_generation_check(int generation);
692 void	bus_data_generation_update(void);
693 
694 /**
695  * Some convenience defines for probe routines to return.  These are just
696  * suggested values, and there's nothing magical about them.
697  * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
698  * possible other driver may exist (typically legacy drivers who don't follow
699  * all the rules, or special needs drivers).  BUS_PROBE_VENDOR is the
700  * suggested value that vendor supplied drivers use.  This is for source or
701  * binary drivers that are not yet integrated into the FreeBSD tree.  Its use
702  * in the base OS is prohibited.  BUS_PROBE_DEFAULT is the normal return value
703  * for drivers to use.  It is intended that nearly all of the drivers in the
704  * tree should return this value.  BUS_PROBE_LOW_PRIORITY are for drivers that
705  * have special requirements like when there are two drivers that support
706  * overlapping series of hardware devices.  In this case the one that supports
707  * the older part of the line would return this value, while the one that
708  * supports the newer ones would return BUS_PROBE_DEFAULT.  BUS_PROBE_GENERIC
709  * is for drivers that wish to have a generic form and a specialized form,
710  * like is done with the pci bus and the acpi pci bus.  BUS_PROBE_HOOVER is
711  * for those buses that implement a generic device placeholder for devices on
712  * the bus that have no more specific driver for them (aka ugen).
713  * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
714  * for a device node, but accepts only devices that its parent has told it
715  * use this driver.
716  */
717 #define BUS_PROBE_SPECIFIC	0	/* Only I can use this device */
718 #define BUS_PROBE_VENDOR	(-10)	/* Vendor supplied driver */
719 #define BUS_PROBE_DEFAULT	(-20)	/* Base OS default driver */
720 #define BUS_PROBE_LOW_PRIORITY	(-40)	/* Older, less desirable drivers */
721 #define BUS_PROBE_GENERIC	(-100)	/* generic driver for dev */
722 #define BUS_PROBE_HOOVER	(-1000000) /* Driver for any dev on bus */
723 #define BUS_PROBE_NOWILDCARD	(-2000000000) /* No wildcard device matches */
724 
725 /**
726  * During boot, the device tree is scanned multiple times.  Each scan,
727  * or pass, drivers may be attached to devices.  Each driver
728  * attachment is assigned a pass number.  Drivers may only probe and
729  * attach to devices if their pass number is less than or equal to the
730  * current system-wide pass number.  The default pass is the last pass
731  * and is used by most drivers.  Drivers needed by the scheduler are
732  * probed in earlier passes.
733  */
734 #define	BUS_PASS_ROOT		0	/* Used to attach root0. */
735 #define	BUS_PASS_BUS		10	/* Buses and bridges. */
736 #define	BUS_PASS_CPU		20	/* CPU devices. */
737 #define	BUS_PASS_RESOURCE	30	/* Resource discovery. */
738 #define	BUS_PASS_INTERRUPT	40	/* Interrupt controllers. */
739 #define	BUS_PASS_TIMER		50	/* Timers and clocks. */
740 #define	BUS_PASS_SCHEDULER	60	/* Start scheduler. */
741 #define	BUS_PASS_SUPPORTDEV	100000	/* Drivers which support DEFAULT drivers. */
742 #define	BUS_PASS_DEFAULT	__INT_MAX /* Everything else. */
743 
744 #define	BUS_PASS_ORDER_FIRST	0
745 #define	BUS_PASS_ORDER_EARLY	2
746 #define	BUS_PASS_ORDER_MIDDLE	5
747 #define	BUS_PASS_ORDER_LATE	7
748 #define	BUS_PASS_ORDER_LAST	9
749 
750 extern int bus_current_pass;
751 
752 void	bus_set_pass(int pass);
753 
754 /**
755  * Routines to lock / unlock the newbus lock.
756  * Must be taken out to interact with newbus.
757  */
758 void bus_topo_lock(void);
759 void bus_topo_unlock(void);
760 struct mtx * bus_topo_mtx(void);
761 
762 /**
763  * Shorthands for constructing method tables.
764  */
765 #define	DEVMETHOD	KOBJMETHOD
766 #define	DEVMETHOD_END	KOBJMETHOD_END
767 
768 /*
769  * Some common device interfaces.
770  */
771 #include "device_if.h"
772 #include "bus_if.h"
773 
774 struct	module;
775 
776 int	driver_module_handler(struct module *, int, void *);
777 
778 /**
779  * Module support for automatically adding drivers to buses.
780  */
781 struct driver_module_data {
782 	int		(*dmd_chainevh)(struct module *, int, void *);
783 	void		*dmd_chainarg;
784 	const char	*dmd_busname;
785 	kobj_class_t	dmd_driver;
786 	devclass_t	*dmd_devclass;
787 	int		dmd_pass;
788 };
789 
790 #define	_DRIVER_MODULE_MACRO(_1, _2, _3, _4, _5, _6, _7, _8, NAME, ...)	\
791 	NAME
792 
793 #define	_EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass,	\
794     evh, arg, order, pass)						\
795 								\
796 static struct driver_module_data name##_##busname##_driver_mod = {	\
797 	evh, arg,							\
798 	#busname,							\
799 	(kobj_class_t) &driver,						\
800 	devclass,							\
801 	pass								\
802 };									\
803 									\
804 static moduledata_t name##_##busname##_mod = {				\
805 	#busname "/" #name,						\
806 	driver_module_handler,						\
807 	&name##_##busname##_driver_mod					\
808 };									\
809 DECLARE_MODULE(name##_##busname, name##_##busname##_mod,		\
810 	       SI_SUB_DRIVERS, order)
811 
812 #define	EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg,	\
813     order, pass)							\
814 	_EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, NULL, evh,	\
815 	    arg, order, pass)
816 
817 #define	EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass,	\
818     evh, arg, order, pass)						\
819 	_EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, &devclass,	\
820 	    evh, arg, order, pass)
821 
822 #define	EARLY_DRIVER_MODULE_ORDERED(...)				\
823 	_DRIVER_MODULE_MACRO(__VA_ARGS__, EARLY_DRIVER_MODULE_ORDERED8,	\
824 	    EARLY_DRIVER_MODULE_ORDERED7)(__VA_ARGS__)
825 
826 #define	EARLY_DRIVER_MODULE7(name, busname, driver, devclass, evh, arg, pass) \
827 	EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass,	\
828 	    evh, arg, SI_ORDER_MIDDLE, pass)
829 
830 #define	EARLY_DRIVER_MODULE6(name, busname, driver, evh, arg, pass)	\
831 	EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg,	\
832 	    SI_ORDER_MIDDLE, pass)
833 
834 #define	EARLY_DRIVER_MODULE(...)					\
835 	_DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID,			\
836 	    EARLY_DRIVER_MODULE7, EARLY_DRIVER_MODULE6)(__VA_ARGS__)
837 
838 #define	DRIVER_MODULE_ORDERED7(name, busname, driver, devclass, evh, arg,\
839     order)								\
840 	EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass,	\
841 	    evh, arg, order, BUS_PASS_DEFAULT)
842 
843 #define	DRIVER_MODULE_ORDERED6(name, busname, driver, evh, arg, order)	\
844 	EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg,	\
845 	    order, BUS_PASS_DEFAULT)
846 
847 #define	DRIVER_MODULE_ORDERED(...)					\
848 	_DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID,			\
849 	    DRIVER_MODULE_ORDERED7, DRIVER_MODULE_ORDERED6)(__VA_ARGS__)
850 
851 #define	DRIVER_MODULE6(name, busname, driver, devclass, evh, arg)	\
852 	EARLY_DRIVER_MODULE7(name, busname, driver, devclass, evh, arg,	\
853 	    BUS_PASS_DEFAULT)
854 
855 #define	DRIVER_MODULE5(name, busname, driver, evh, arg)			\
856 	EARLY_DRIVER_MODULE6(name, busname, driver, evh, arg,		\
857 	    BUS_PASS_DEFAULT)
858 
859 #define	DRIVER_MODULE(...)						\
860 	_DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, INVALID,		\
861 	    DRIVER_MODULE6, DRIVER_MODULE5)(__VA_ARGS__)
862 
863 /**
864  * Generic ivar accessor generation macros for bus drivers
865  */
866 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type)			\
867 									\
868 static __inline type varp ## _get_ ## var(device_t dev)			\
869 {									\
870 	uintptr_t v;							\
871 	int e __diagused;						\
872 	e = BUS_READ_IVAR(device_get_parent(dev), dev,			\
873 	    ivarp ## _IVAR_ ## ivar, &v);				\
874 	KASSERT(e == 0, ("%s failed for %s on bus %s, error = %d",	\
875 	    __func__, device_get_nameunit(dev),				\
876 	    device_get_nameunit(device_get_parent(dev)), e));		\
877 	return ((type) v);						\
878 }									\
879 									\
880 static __inline void varp ## _set_ ## var(device_t dev, type t)		\
881 {									\
882 	uintptr_t v = (uintptr_t) t;					\
883 	int e __diagused;						\
884 	e = BUS_WRITE_IVAR(device_get_parent(dev), dev,			\
885 	    ivarp ## _IVAR_ ## ivar, v);				\
886 	KASSERT(e == 0, ("%s failed for %s on bus %s, error = %d",	\
887 	    __func__, device_get_nameunit(dev),				\
888 	    device_get_nameunit(device_get_parent(dev)), e));		\
889 }
890 
891 /**
892  * Shorthand macros, taking resource argument
893  * Generated with sys/tools/bus_macro.sh
894  */
895 
896 #define bus_barrier(r, o, l, f) \
897 	bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
898 #define bus_poke_1(r, o, v) \
899 	bus_space_poke_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
900 #define bus_peek_1(r, o, vp) \
901 	bus_space_peek_1((r)->r_bustag, (r)->r_bushandle, (o), (vp))
902 #define bus_read_1(r, o) \
903 	bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
904 #define bus_read_multi_1(r, o, d, c) \
905 	bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
906 #define bus_read_region_1(r, o, d, c) \
907 	bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
908 #define bus_set_multi_1(r, o, v, c) \
909 	bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
910 #define bus_set_region_1(r, o, v, c) \
911 	bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
912 #define bus_write_1(r, o, v) \
913 	bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
914 #define bus_write_multi_1(r, o, d, c) \
915 	bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
916 #define bus_write_region_1(r, o, d, c) \
917 	bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
918 #define bus_read_stream_1(r, o) \
919 	bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
920 #define bus_read_multi_stream_1(r, o, d, c) \
921 	bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
922 #define bus_read_region_stream_1(r, o, d, c) \
923 	bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
924 #define bus_set_multi_stream_1(r, o, v, c) \
925 	bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
926 #define bus_set_region_stream_1(r, o, v, c) \
927 	bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
928 #define bus_write_stream_1(r, o, v) \
929 	bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
930 #define bus_write_multi_stream_1(r, o, d, c) \
931 	bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
932 #define bus_write_region_stream_1(r, o, d, c) \
933 	bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
934 #define bus_poke_2(r, o, v) \
935 	bus_space_poke_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
936 #define bus_peek_2(r, o, vp) \
937 	bus_space_peek_2((r)->r_bustag, (r)->r_bushandle, (o), (vp))
938 #define bus_read_2(r, o) \
939 	bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
940 #define bus_read_multi_2(r, o, d, c) \
941 	bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
942 #define bus_read_region_2(r, o, d, c) \
943 	bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
944 #define bus_set_multi_2(r, o, v, c) \
945 	bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
946 #define bus_set_region_2(r, o, v, c) \
947 	bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
948 #define bus_write_2(r, o, v) \
949 	bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
950 #define bus_write_multi_2(r, o, d, c) \
951 	bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
952 #define bus_write_region_2(r, o, d, c) \
953 	bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
954 #define bus_read_stream_2(r, o) \
955 	bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
956 #define bus_read_multi_stream_2(r, o, d, c) \
957 	bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
958 #define bus_read_region_stream_2(r, o, d, c) \
959 	bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
960 #define bus_set_multi_stream_2(r, o, v, c) \
961 	bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
962 #define bus_set_region_stream_2(r, o, v, c) \
963 	bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
964 #define bus_write_stream_2(r, o, v) \
965 	bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
966 #define bus_write_multi_stream_2(r, o, d, c) \
967 	bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
968 #define bus_write_region_stream_2(r, o, d, c) \
969 	bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
970 #define bus_poke_4(r, o, v) \
971 	bus_space_poke_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
972 #define bus_peek_4(r, o, vp) \
973 	bus_space_peek_4((r)->r_bustag, (r)->r_bushandle, (o), (vp))
974 #define bus_read_4(r, o) \
975 	bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
976 #define bus_read_multi_4(r, o, d, c) \
977 	bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
978 #define bus_read_region_4(r, o, d, c) \
979 	bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
980 #define bus_set_multi_4(r, o, v, c) \
981 	bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
982 #define bus_set_region_4(r, o, v, c) \
983 	bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
984 #define bus_write_4(r, o, v) \
985 	bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
986 #define bus_write_multi_4(r, o, d, c) \
987 	bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
988 #define bus_write_region_4(r, o, d, c) \
989 	bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
990 #define bus_read_stream_4(r, o) \
991 	bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
992 #define bus_read_multi_stream_4(r, o, d, c) \
993 	bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
994 #define bus_read_region_stream_4(r, o, d, c) \
995 	bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
996 #define bus_set_multi_stream_4(r, o, v, c) \
997 	bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
998 #define bus_set_region_stream_4(r, o, v, c) \
999 	bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1000 #define bus_write_stream_4(r, o, v) \
1001 	bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
1002 #define bus_write_multi_stream_4(r, o, d, c) \
1003 	bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1004 #define bus_write_region_stream_4(r, o, d, c) \
1005 	bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1006 #define bus_poke_8(r, o, v) \
1007 	bus_space_poke_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
1008 #define bus_peek_8(r, o, vp) \
1009 	bus_space_peek_8((r)->r_bustag, (r)->r_bushandle, (o), (vp))
1010 #define bus_read_8(r, o) \
1011 	bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
1012 #define bus_read_multi_8(r, o, d, c) \
1013 	bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1014 #define bus_read_region_8(r, o, d, c) \
1015 	bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1016 #define bus_set_multi_8(r, o, v, c) \
1017 	bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1018 #define bus_set_region_8(r, o, v, c) \
1019 	bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1020 #define bus_write_8(r, o, v) \
1021 	bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
1022 #define bus_write_multi_8(r, o, d, c) \
1023 	bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1024 #define bus_write_region_8(r, o, d, c) \
1025 	bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1026 #define bus_read_stream_8(r, o) \
1027 	bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
1028 #define bus_read_multi_stream_8(r, o, d, c) \
1029 	bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1030 #define bus_read_region_stream_8(r, o, d, c) \
1031 	bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1032 #define bus_set_multi_stream_8(r, o, v, c) \
1033 	bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1034 #define bus_set_region_stream_8(r, o, v, c) \
1035 	bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
1036 #define bus_write_stream_8(r, o, v) \
1037 	bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
1038 #define bus_write_multi_stream_8(r, o, d, c) \
1039 	bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1040 #define bus_write_region_stream_8(r, o, d, c) \
1041 	bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
1042 #endif /* _KERNEL */
1043 
1044 #endif /* !_SYS_BUS_H_ */
1045