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