Remove no longer needed catman periodic via 'make upgrade'.
[dragonfly.git] / sys / sys / bus.h
CommitLineData
984263bc
MD
1/*-
2 * Copyright (c) 1997,1998 Doug Rabson
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
07d2fd35 26 * $FreeBSD: src/sys/sys/bus.h,v 1.30.2.5 2004/03/17 17:54:25 njl Exp $
984263bc
MD
27 */
28
29#ifndef _SYS_BUS_H_
30#define _SYS_BUS_H_
31
7490f18b 32#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
984263bc 33
1bd40720
MD
34#ifndef _SYS_TYPES_H_
35#include <sys/types.h>
36#endif
37#ifndef _SYS_QUEUE_H_
984263bc 38#include <sys/queue.h>
1bd40720
MD
39#endif
40#ifndef _SYS_KOBJ_H_
80eff43d 41#include <sys/kobj.h>
1bd40720 42#endif
7490f18b 43#ifdef _KERNEL
e9cb6d99 44#include <sys/serialize.h>
7490f18b 45#endif
1f7ab7c9
MD
46#ifndef _SYS_BUS_DMA_H_
47#include <sys/bus_dma.h>
48#endif
49#ifndef _SYS_BUS_RESOURCE_H_
50#include <sys/bus_resource.h>
51#endif
984263bc
MD
52
53/*
54 * Forward declarations
55 */
11b27f9d 56typedef struct bsd_device *device_t;
e1bc6fbb 57typedef struct kobj_class driver_t;
984263bc 58typedef struct devclass *devclass_t;
80eff43d 59#define device_method_t kobj_method_t
984263bc 60
4d28e78f 61typedef int driver_filter_t(void*);
984263bc
MD
62typedef void driver_intr_t(void*);
63
0010e23a
HT
64/*
65 * Interface information structure.
66 */
67struct u_businfo {
68 int ub_version; /* interface version */
69#define BUS_USER_VERSION 1
70 int ub_generation; /* generation count */
71};
72
73/*
74 * State of the device.
75 */
76typedef enum device_state {
77 DS_NOTPRESENT, /* not probed or probe failed */
78 DS_ALIVE, /* probe succeeded */
79 DS_INPROGRESS, /* attach in progress */
80 DS_ATTACHED, /* attach method called */
81 DS_BUSY /* device is open */
82} device_state_t;
83
84/*
85 * Device information exported to userspace.
86 */
87struct u_device {
88 uintptr_t dv_handle;
89 uintptr_t dv_parent;
90
91 char dv_name[32]; /* Name of device in tree. */
92 char dv_desc[32]; /* Driver description */
93 char dv_drivername[32]; /* Driver name */
94 char dv_pnpinfo[128]; /* Plug and play info */
95 char dv_location[128]; /* Where is the device? */
96 uint32_t dv_devflags; /* API Flags for device */
97 uint16_t dv_flags; /* flags for dev date */
98 device_state_t dv_state; /* State of attachment */
99 /* XXX more driver info? */
100};
101
984263bc 102/*
ee61f228
MD
103 * Interrupt features mask. Note that DragonFly no longer implements
104 * INTR_TYPE_* flags.
f8a09be1
MD
105 *
106 * NOTE: INTR_FAST is no longer supported, all device interrupts are threaded
107 * now. Only clock interrupts are 'fast'.
984263bc 108 */
6ad84740 109#define INTR_HIFREQ 0x0040 /* high frequency interrupt */
f8a09be1 110#define INTR_CLOCK 0x0080 /* (was INTR_FAST) */
ee61f228
MD
111#define INTR_EXCL 0x0100
112#define INTR_MPSAFE 0x0200
8b3ec75a 113#define INTR_NOENTROPY 0x0400
477d3c1c 114#define INTR_NOPOLL 0x0800 /* interrupt cannot be polled (e.g. ata) */
bbe77fc3 115
e126caf1
MD
116enum intr_trigger {
117 INTR_TRIGGER_CONFORM = 0,
118 INTR_TRIGGER_EDGE = 1,
119 INTR_TRIGGER_LEVEL = 2
120};
121
122enum intr_polarity {
123 INTR_POLARITY_CONFORM = 0,
124 INTR_POLARITY_HIGH = 1,
125 INTR_POLARITY_LOW = 2
984263bc 126};
984263bc
MD
127
128typedef int (*devop_t)(void);
129
984263bc
MD
130/*
131 * Definitions for drivers which need to keep simple lists of resources
132 * for their child devices.
133 */
134struct resource;
135
136struct resource_list_entry {
137 SLIST_ENTRY(resource_list_entry) link;
138 int type; /* type argument to alloc_resource */
139 int rid; /* resource identifier */
140 struct resource *res; /* the real resource when allocated */
141 u_long start; /* start of resource range */
142 u_long end; /* end of resource range */
143 u_long count; /* count within range */
1b000e91 144 int cpuid; /* owner cpuid */
984263bc
MD
145};
146SLIST_HEAD(resource_list, resource_list_entry);
147
7490f18b
SS
148#endif /* _KERNEL || _KERNEL_STRUCTURES */
149#ifdef _KERNEL
150
4ecd5d4d
SZ
151const char *intr_str_polarity(enum intr_polarity);
152const char *intr_str_trigger(enum intr_trigger);
153
71fc104f
HT
154/**
155 * devctl hooks. Typically one should use the devctl_notify
156 * hook to send the message. However, devctl_queue_data is also
157 * included in case devctl_notify isn't sufficiently general.
158 */
159boolean_t devctl_process_running(void);
160void devctl_notify(const char *__system, const char *__subsystem,
161 const char *__type, const char *__data);
162void devctl_queue_data(char *__data);
163
984263bc
MD
164/*
165 * Initialise a resource list.
166 */
167void resource_list_init(struct resource_list *rl);
168
169/*
170 * Reclaim memory used by a resource list.
171 */
172void resource_list_free(struct resource_list *rl);
173
174/*
175 * Add a resource entry or modify an existing entry if one exists with
176 * the same type and rid.
177 */
1b000e91
SZ
178void resource_list_add(struct resource_list *rl, int type, int rid,
179 u_long start, u_long end, u_long count, int cpuid);
984263bc
MD
180
181/*
182 * Find a resource entry by type and rid.
183 */
184struct resource_list_entry*
185 resource_list_find(struct resource_list *rl,
186 int type, int rid);
187
188/*
189 * Delete a resource entry.
190 */
191void resource_list_delete(struct resource_list *rl,
192 int type, int rid);
193
194/*
195 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
196 * and passing the allocation up to the parent of bus. This assumes
197 * that the first entry of device_get_ivars(child) is a struct
198 * resource_list. This also handles 'passthrough' allocations where a
199 * child is a remote descendant of bus by passing the allocation up to
200 * the parent of bus.
201 */
202struct resource *
203 resource_list_alloc(struct resource_list *rl,
204 device_t bus, device_t child,
205 int type, int *rid,
206 u_long start, u_long end,
93fad519 207 u_long count, u_int flags, int cpuid);
984263bc
MD
208
209/*
210 * Implement BUS_RELEASE_RESOURCE.
211 */
212int resource_list_release(struct resource_list *rl,
213 device_t bus, device_t child,
214 int type, int rid, struct resource *res);
215
216/*
217 * Print all resources of a specified type, for use in bus_print_child.
218 * The name is printed if at least one resource of the given type is available.
219 * The format ist used to print resource start and end.
220 */
221int resource_list_print_type(struct resource_list *rl,
222 const char *name, int type,
223 const char *format);
224
225/*
226 * The root bus, to which all top-level busses are attached.
227 */
228extern device_t root_bus;
984263bc
MD
229void root_bus_configure(void);
230
231/*
232 * Useful functions for implementing busses.
233 */
234
235int bus_generic_activate_resource(device_t dev, device_t child, int type,
236 int rid, struct resource *r);
e126caf1
MD
237struct resource *
238 bus_generic_alloc_resource(device_t bus, device_t child,
239 int type, int *rid,
240 u_long start, u_long end,
4f7fe8c7 241 u_long count, u_int flags, int cpuid);
e126caf1
MD
242struct resource_list *
243 bus_generic_get_resource_list (device_t, device_t);
244
05065648 245int bus_generic_config_intr(device_t, device_t, int, enum intr_trigger,
e126caf1 246 enum intr_polarity);
984263bc 247int bus_generic_attach(device_t dev);
5025fc65 248int bus_generic_attach_gpri(device_t dev, u_int gpri);
22457186 249int bus_generic_child_present(device_t dev, device_t child);
984263bc
MD
250int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
251 int rid, struct resource *r);
252int bus_generic_detach(device_t dev);
e9cb6d99 253int bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
984263bc 254void bus_generic_driver_added(device_t dev, driver_t *driver);
9bddf981
FT
255bus_dma_tag_t
256 bus_generic_get_dma_tag(device_t dev, device_t child);
67a2436e 257void bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
984263bc
MD
258int bus_print_child_header(device_t dev, device_t child);
259int bus_print_child_footer(device_t dev, device_t child);
260int bus_generic_print_child(device_t dev, device_t child);
39b5d600
MD
261int bus_generic_identify(driver_t *driver, device_t parent);
262int bus_generic_identify_sameunit(driver_t *driver, device_t parent);
984263bc 263int bus_generic_probe(device_t dev);
39b5d600 264int bus_generic_probe_hack(device_t dev);
2581072f 265device_t bus_generic_add_child(device_t, device_t, int, const char *, int);
984263bc
MD
266int bus_generic_read_ivar(device_t dev, device_t child, int which,
267 uintptr_t *result);
268int bus_generic_release_resource(device_t bus, device_t child,
269 int type, int rid, struct resource *r);
2581072f
MD
270int bus_generic_get_resource(device_t dev, device_t child, int type,
271 int rid, u_long *startp, u_long *countp);
b47b3275
SZ
272int bus_generic_set_resource(device_t dev, device_t child,
273 int type, int rid, u_long start, u_long count, int cpuid);
2581072f
MD
274void bus_generic_delete_resource(device_t dev, device_t child,
275 int type, int rid);
984263bc
MD
276int bus_generic_resume(device_t dev);
277int bus_generic_setup_intr(device_t dev, device_t child,
0e6f0e28
SZ
278 struct resource *irq, int flags, driver_intr_t *intr, void *arg,
279 void **cookiep, lwkt_serialize_t serializer, const char *desc);
984263bc
MD
280int bus_generic_shutdown(device_t dev);
281int bus_generic_suspend(device_t dev);
282int bus_generic_teardown_intr(device_t dev, device_t child,
283 struct resource *irq, void *cookie);
284int bus_generic_write_ivar(device_t dev, device_t child, int which,
285 uintptr_t value);
286
e126caf1
MD
287struct resource *
288 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
4f7fe8c7 289 u_long, u_long, u_long, u_int, int);
e126caf1
MD
290void bus_generic_rl_delete_resource (device_t, device_t, int, int);
291int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
292 u_long *);
293int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
b47b3275 294 u_long, int);
e126caf1
MD
295int bus_generic_rl_release_resource (device_t, device_t, int, int,
296 struct resource *);
297
984263bc
MD
298/*
299 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
300 * a little simpler.
301 */
43167546
HT
302struct resource_spec {
303 int type;
304 int rid;
305 int flags;
306};
307
308int bus_alloc_resources(device_t dev, struct resource_spec *rs,
309 struct resource **res);
310void bus_release_resources(device_t dev, const struct resource_spec *rs,
311 struct resource **res);
312
984263bc
MD
313struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
314 u_long start, u_long end, u_long count,
315 u_int flags);
32f2b89d
SZ
316struct resource *bus_alloc_legacy_irq_resource(device_t dev, int *rid,
317 u_long irq, u_int flags);
984263bc
MD
318int bus_activate_resource(device_t dev, int type, int rid,
319 struct resource *r);
320int bus_deactivate_resource(device_t dev, int type, int rid,
321 struct resource *r);
9bddf981 322bus_dma_tag_t bus_get_dma_tag(device_t dev);
e9cb6d99 323int bus_disable_intr(device_t dev, void *cookie);
67a2436e 324void bus_enable_intr(device_t dev, void *cookie);
984263bc
MD
325int bus_release_resource(device_t dev, int type, int rid,
326 struct resource *r);
327int bus_setup_intr(device_t dev, struct resource *r, int flags,
e9cb6d99
MD
328 driver_intr_t handler, void *arg,
329 void **cookiep, lwkt_serialize_t serializer);
0e6f0e28
SZ
330int bus_setup_intr_descr(device_t dev, struct resource *r, int flags,
331 driver_intr_t handler, void *arg, void **cookiep,
332 lwkt_serialize_t serializer, const char *desc);
984263bc
MD
333int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
334int bus_set_resource(device_t dev, int type, int rid,
b47b3275 335 u_long start, u_long count, int cpuid);
984263bc
MD
336int bus_get_resource(device_t dev, int type, int rid,
337 u_long *startp, u_long *countp);
338u_long bus_get_resource_start(device_t dev, int type, int rid);
339u_long bus_get_resource_count(device_t dev, int type, int rid);
340void bus_delete_resource(device_t dev, int type, int rid);
cac6f3da
JS
341int bus_child_present(device_t child);
342int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
343int bus_child_location_str(device_t child, char *buf, size_t buflen);
984263bc 344
07d2fd35
HP
345static __inline struct resource *
346bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
347{
348 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
349}
350
984263bc
MD
351/*
352 * Access functions for device.
353 */
354device_t device_add_child(device_t dev, const char *name, int unit);
355device_t device_add_child_ordered(device_t dev, int order,
356 const char *name, int unit);
357void device_busy(device_t dev);
358int device_delete_child(device_t dev, device_t child);
65b6868b 359int device_delete_children(device_t dev);
984263bc
MD
360int device_detach(device_t dev);
361void device_disable(device_t dev);
362void device_enable(device_t dev);
363device_t device_find_child(device_t dev, const char *classname,
364 int unit);
365const char *device_get_desc(device_t dev);
366devclass_t device_get_devclass(device_t dev);
367driver_t *device_get_driver(device_t dev);
368u_int32_t device_get_flags(device_t dev);
369device_t device_get_parent(device_t dev);
370int device_get_children(device_t dev, device_t **listp, int *countp);
371void *device_get_ivars(device_t dev);
372void device_set_ivars(device_t dev, void *ivars);
373const char *device_get_name(device_t dev);
374const char *device_get_nameunit(device_t dev);
375void *device_get_softc(device_t dev);
376device_state_t device_get_state(device_t dev);
377int device_get_unit(device_t dev);
8e4d1376
FT
378struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
379struct sysctl_oid *device_get_sysctl_tree(device_t dev);
984263bc 380int device_is_alive(device_t dev); /* did probe succeed? */
2140e77f 381int device_is_attached(device_t dev); /* did attach succeed? */
984263bc
MD
382int device_is_enabled(device_t dev);
383int device_is_quiet(device_t dev);
384int device_print_prettyname(device_t dev);
385int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
386int device_probe_and_attach(device_t dev);
5025fc65 387int device_probe_and_attach_gpri(device_t dev, u_int gpri);
bab94315 388int device_probe_child(device_t dev, device_t child);
5025fc65 389int device_probe_child_gpri(device_t dev, device_t child, u_int gpri);
984263bc
MD
390void device_quiet(device_t dev);
391void device_set_desc(device_t dev, const char* desc);
392void device_set_desc_copy(device_t dev, const char* desc);
393int device_set_devclass(device_t dev, const char *classname);
394int device_set_driver(device_t dev, driver_t *driver);
395void device_set_flags(device_t dev, u_int32_t flags);
396void device_set_softc(device_t dev, void *softc);
dbcd0c9b 397void device_set_async_attach(device_t dev, int enable);
984263bc
MD
398int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
399int device_shutdown(device_t dev);
400void device_unbusy(device_t dev);
401void device_verbose(device_t dev);
d8abea90 402int device_getenv_int(device_t dev, const char *knob, int def);
a8b5df14
SZ
403void device_getenv_string(device_t dev, const char *knob,
404 char * __restrict data, int dlen, const char * __restrict def);
984263bc
MD
405
406/*
407 * Access functions for devclass.
408 */
91a0c258
JS
409int devclass_add_driver(devclass_t dc, kobj_class_t driver);
410int devclass_delete_driver(devclass_t dc, kobj_class_t driver);
984263bc
MD
411devclass_t devclass_create(const char *classname);
412devclass_t devclass_find(const char *classname);
2581072f 413device_t devclass_find_unit(const char *classname, int unit);
91a0c258 414kobj_class_t devclass_find_driver(devclass_t dc, const char *classname);
984263bc
MD
415const char *devclass_get_name(devclass_t dc);
416device_t devclass_get_device(devclass_t dc, int unit);
417void *devclass_get_softc(devclass_t dc, int unit);
418int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
5ebadb2c 419int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
7d58d14b 420int devclass_get_count(devclass_t dc);
984263bc 421int devclass_get_maxunit(devclass_t dc);
91a0c258
JS
422void devclass_set_parent(devclass_t dc, devclass_t pdc);
423devclass_t devclass_get_parent(devclass_t dc);
984263bc
MD
424
425/*
426 * Access functions for device resources.
427 */
428
429int resource_int_value(const char *name, int unit, const char *resname,
430 int *result);
431int resource_long_value(const char *name, int unit, const char *resname,
432 long *result);
433int resource_string_value(const char *name, int unit, const char *resname,
30a6375a 434 const char **result);
e126caf1 435int resource_disabled(const char *name, int unit);
984263bc
MD
436int resource_query_string(int i, const char *resname, const char *value);
437char *resource_query_name(int i);
438int resource_query_unit(int i);
439int resource_locate(int i, const char *resname);
440int resource_set_int(const char *name, int unit, const char *resname,
441 int value);
442int resource_set_long(const char *name, int unit, const char *resname,
443 long value);
444int resource_set_string(const char *name, int unit, const char *resname,
445 const char *value);
446int resource_count(void);
447
0010e23a
HT
448/*
449 * Functions for maintaining and checking consistency of
450 * bus information exported to userspace.
451 */
452int bus_data_generation_check(int generation);
453void bus_data_generation_update(void);
454
558a398b
SS
455/**
456 * Some convenience defines for probe routines to return. These are just
457 * suggested values, and there's nothing magical about them.
458 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
459 * possible other driver may exist (typically legacy drivers who don't fallow
460 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
461 * suggested value that vendor supplied drivers use. This is for source or
462 * binary drivers that are not yet integrated into the FreeBSD tree. Its use
463 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
464 * for drivers to use. It is intended that nearly all of the drivers in the
465 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
466 * have special requirements like when there are two drivers that support
467 * overlapping series of hardware devices. In this case the one that supports
468 * the older part of the line would return this value, while the one that
469 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
470 * is for drivers that wish to have a generic form and a specialized form,
471 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
472 * for those busses that implement a generic device place-holder for devices on
473 * the bus that have no more specific driver for them (aka ugen).
474 */
475#define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
122df98f 476#if 0 /* notyet */
558a398b
SS
477#define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
478#define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
479#define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
480#define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
481#define BUS_PROBE_HOOVER (-500) /* Generic dev for all devs on bus */
482#else
483#define BUS_PROBE_VENDOR 0
484#define BUS_PROBE_DEFAULT 0
485#define BUS_PROBE_LOW_PRIORITY 0
486#define BUS_PROBE_GENERIC 0
487#define BUS_PROBE_HOOVER 0
488#endif
489
984263bc 490/*
cd7b4f7d 491 * Shorthand for constructing method tables.
984263bc 492 */
80eff43d 493#define DEVMETHOD KOBJMETHOD
174a55ec 494#define DEVMETHOD_END KOBJMETHOD_END
984263bc
MD
495
496/*
497 * Some common device interfaces.
498 */
499#include "device_if.h"
500#include "bus_if.h"
501
502struct module;
503
504int driver_module_handler(struct module *, int, void *);
505
506/*
507 * Module support for automatically adding drivers to busses.
508 */
509struct driver_module_data {
510 int (*dmd_chainevh)(struct module *, int, void *);
511 void *dmd_chainarg;
512 const char *dmd_busname;
91a0c258 513 kobj_class_t dmd_driver;
984263bc
MD
514 devclass_t *dmd_devclass;
515};
516
ccd2b1c7
JH
517#define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\
518 order) \
984263bc 519 \
984263bc
MD
520static struct driver_module_data name##_##busname##_driver_mod = { \
521 evh, arg, \
522 #busname, \
91a0c258 523 (kobj_class_t) &driver, \
984263bc
MD
524 &devclass \
525}; \
526 \
527static moduledata_t name##_##busname##_mod = { \
528 #busname "/" #name, \
529 driver_module_handler, \
530 &name##_##busname##_driver_mod \
531}; \
532DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
ccd2b1c7 533 SI_SUB_DRIVERS, order)
984263bc 534
ccd2b1c7
JH
535#define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
536 DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\
537 SI_ORDER_MIDDLE)
4d28e78f
SZ
538/**
539 * Generic ivar accessor generation macros for bus drivers
540 */
55c60d8c
SZ
541#define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
542 \
543static __inline type varp ## _get_ ## var(device_t dev) \
544{ \
545 uintptr_t v; \
546 BUS_READ_IVAR(device_get_parent(dev), dev, \
547 ivarp ## _IVAR_ ## ivar, &v); \
548 return ((type) v); \
549} \
550 \
551static __inline void varp ## _set_ ## var(device_t dev, type t) \
552{ \
553 uintptr_t v = (uintptr_t) t; \
554 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
555 ivarp ## _IVAR_ ## ivar, v); \
4d28e78f
SZ
556}
557
89ffa1cf
SS
558/**
559 * Shorthand macros, taking resource argument
560 */
561
562#define bus_barrier(r, o, l, f) \
563 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
564#define bus_read_1(r, o) \
565 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
566#define bus_read_multi_1(r, o, d, c) \
567 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
568#define bus_read_region_1(r, o, d, c) \
569 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
570#define bus_set_multi_1(r, o, v, c) \
571 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
572#define bus_set_region_1(r, o, v, c) \
573 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
574#define bus_write_1(r, o, v) \
575 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
576#define bus_write_multi_1(r, o, d, c) \
577 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
578#define bus_write_region_1(r, o, d, c) \
579 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
580#define bus_read_stream_1(r, o) \
581 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
582#define bus_read_multi_stream_1(r, o, d, c) \
583 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
584#define bus_read_region_stream_1(r, o, d, c) \
585 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
586#define bus_set_multi_stream_1(r, o, v, c) \
587 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
588#define bus_set_region_stream_1(r, o, v, c) \
589 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
590#define bus_write_stream_1(r, o, v) \
591 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
592#define bus_write_multi_stream_1(r, o, d, c) \
593 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
594#define bus_write_region_stream_1(r, o, d, c) \
595 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
596#define bus_read_2(r, o) \
597 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
598#define bus_read_multi_2(r, o, d, c) \
599 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
600#define bus_read_region_2(r, o, d, c) \
601 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
602#define bus_set_multi_2(r, o, v, c) \
603 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
604#define bus_set_region_2(r, o, v, c) \
605 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
606#define bus_write_2(r, o, v) \
607 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
608#define bus_write_multi_2(r, o, d, c) \
609 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
610#define bus_write_region_2(r, o, d, c) \
611 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
612#define bus_read_stream_2(r, o) \
613 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
614#define bus_read_multi_stream_2(r, o, d, c) \
615 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
616#define bus_read_region_stream_2(r, o, d, c) \
617 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
618#define bus_set_multi_stream_2(r, o, v, c) \
619 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
620#define bus_set_region_stream_2(r, o, v, c) \
621 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
622#define bus_write_stream_2(r, o, v) \
623 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
624#define bus_write_multi_stream_2(r, o, d, c) \
625 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
626#define bus_write_region_stream_2(r, o, d, c) \
627 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
628#define bus_read_4(r, o) \
629 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
630#define bus_read_multi_4(r, o, d, c) \
631 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
632#define bus_read_region_4(r, o, d, c) \
633 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
634#define bus_set_multi_4(r, o, v, c) \
635 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
636#define bus_set_region_4(r, o, v, c) \
637 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
638#define bus_write_4(r, o, v) \
639 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
640#define bus_write_multi_4(r, o, d, c) \
641 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
642#define bus_write_region_4(r, o, d, c) \
643 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
644#define bus_read_stream_4(r, o) \
645 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
646#define bus_read_multi_stream_4(r, o, d, c) \
647 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
648#define bus_read_region_stream_4(r, o, d, c) \
649 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
650#define bus_set_multi_stream_4(r, o, v, c) \
651 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
652#define bus_set_region_stream_4(r, o, v, c) \
653 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
654#define bus_write_stream_4(r, o, v) \
655 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
656#define bus_write_multi_stream_4(r, o, d, c) \
657 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
658#define bus_write_region_stream_4(r, o, d, c) \
659 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
660#define bus_read_8(r, o) \
661 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
662#define bus_read_multi_8(r, o, d, c) \
663 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
664#define bus_read_region_8(r, o, d, c) \
665 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
666#define bus_set_multi_8(r, o, v, c) \
667 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
668#define bus_set_region_8(r, o, v, c) \
669 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
670#define bus_write_8(r, o, v) \
671 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
672#define bus_write_multi_8(r, o, d, c) \
673 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
674#define bus_write_region_8(r, o, d, c) \
675 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
676#define bus_read_stream_8(r, o) \
677 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
678#define bus_read_multi_stream_8(r, o, d, c) \
679 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
680#define bus_read_region_stream_8(r, o, d, c) \
681 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
682#define bus_set_multi_stream_8(r, o, v, c) \
683 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
684#define bus_set_region_stream_8(r, o, v, c) \
685 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
686#define bus_write_stream_8(r, o, v) \
687 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
688#define bus_write_multi_stream_8(r, o, d, c) \
689 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
690#define bus_write_region_stream_8(r, o, d, c) \
691 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
984263bc
MD
692#endif /* _KERNEL */
693
694#endif /* !_SYS_BUS_H_ */