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