1/* $FreeBSD: stable/11/stand/kshim/bsd_kernel.h 329183 2018-02-12 20:51:28Z kevans $ */
2/*-
3 * Copyright (c) 2011 Hans Petter Selasky. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#ifndef _BSD_KERNEL_H_
28#define	_BSD_KERNEL_H_
29
30#define	_KERNEL
31#undef __FreeBSD_version
32#define	__FreeBSD_version 1100000
33
34#include <sys/cdefs.h>
35#include <sys/queue.h>
36#include <sys/errno.h>
37
38#define	howmany(x, y)	(((x)+((y)-1))/(y))
39#define	nitems(x)	(sizeof((x)) / sizeof((x)[0]))
40#define	isalpha(x) (((x) >= 'a' && (x) <= 'z') || ((x) >= 'A' && (x) <= 'Z'))
41#define	isdigit(x) ((x) >= '0' && (x) <= '9')
42#define	panic(...) do { printf("USB PANIC: " __VA_ARGS__); while (1) ; } while (0)
43#define	rebooting 0
44#define	M_USB 0
45#define	M_USBDEV 0
46#define	USB_PROC_MAX 3
47#define	USB_BUS_GIANT_PROC(bus) (usb_process + 2)
48#define	USB_BUS_NON_GIANT_BULK_PROC(bus) (usb_process + 2)
49#define	USB_BUS_NON_GIANT_ISOC_PROC(bus) (usb_process + 2)
50#define	USB_BUS_EXPLORE_PROC(bus) (usb_process + 0)
51#define	USB_BUS_CONTROL_XFER_PROC(bus) (usb_process + 1)
52#define	SYSCTL_DECL(...)
53struct sysctl_ctx_list {
54};
55struct sysctl_req {
56	void		*newptr;
57};
58#define	SYSCTL_HANDLER_ARGS void *oidp, void *arg1,	\
59	uint32_t arg2, struct sysctl_req *req
60#define	SYSCTL_NODE(name,...) struct { } name __used
61#define	SYSCTL_INT(...)
62#define	SYSCTL_UINT(...)
63#define	SYSCTL_PROC(...)
64#define	SYSCTL_ADD_NODE(...) NULL
65#define	SYSCTL_ADD_U16(...) NULL
66#define	SYSCTL_ADD_PROC(...) NULL
67#define	sysctl_handle_int(...) EOPNOTSUPP
68#define	sysctl_handle_string(...) EOPNOTSUPP
69#define	sysctl_ctx_init(ctx) do { (void)(ctx); } while (0)
70#define	sysctl_ctx_free(ctx) do { (void)(ctx); } while (0)
71#define	TUNABLE_INT(...)
72#define	MALLOC_DECLARE(...)
73#define	MALLOC_DEFINE(...)
74#define	EVENTHANDLER_DECLARE(...)
75#define	EVENTHANDLER_INVOKE(...)
76#define	KASSERT(...)
77#define	SCHEDULER_STOPPED(x) (0)
78#define	PI_SWI(...) (0)
79#define	UNIQ_NAME(x) x
80#define	UNIQ_NAME_STR(x) #x
81#define	DEVCLASS_MAXUNIT 32
82#define	MOD_LOAD 1
83#define	MOD_UNLOAD 2
84#define	DEVMETHOD(what,func) { #what, (void *)&func }
85#define	DEVMETHOD_END {0,0}
86#define	EARLY_DRIVER_MODULE(a, b, c, d, e, f, g)	DRIVER_MODULE(a, b, c, d, e, f)
87#define	DRIVER_MODULE(name, busname, driver, devclass, evh, arg)	\
88  static struct module_data bsd_##name##_##busname##_driver_mod = {	\
89	evh, arg, #busname, #name, #busname "/" #name,			\
90	&driver, &devclass, { 0, 0 } };					\
91SYSINIT(bsd_##name##_##busname##_driver_mod, SI_SUB_DRIVERS,		\
92  SI_ORDER_MIDDLE, module_register,					\
93  &bsd_##name##_##busname##_driver_mod)
94#define	SYSINIT(uniq, subs, order, _func, _data)	\
95const struct sysinit UNIQ_NAME(sysinit_##uniq) = {	\
96	.func = (_func),				\
97	.data = __DECONST(void *, _data)		\
98};							\
99SYSINIT_ENTRY(uniq##_entry, "sysinit", (subs),		\
100    (order), "const struct sysinit",			\
101    UNIQ_NAME_STR(sysinit_##uniq), "SYSINIT")
102
103#define	SYSUNINIT(uniq, subs, order, _func, _data)	\
104const struct sysinit UNIQ_NAME(sysuninit_##uniq) = {	\
105	.func = (_func),				\
106	.data = __DECONST(void *, _data)		\
107};							\
108SYSINIT_ENTRY(uniq##_entry, "sysuninit", (subs),	\
109    (order), "const struct sysuninit",			\
110    UNIQ_NAME_STR(sysuninit_##uniq), "SYSUNINIT")
111#define	MODULE_DEPEND(...)
112#define	MODULE_VERSION(...)
113#define	NULL ((void *)0)
114#define	BUS_SPACE_BARRIER_READ 0x01
115#define	BUS_SPACE_BARRIER_WRITE 0x02
116#define	hz 1000
117#undef PAGE_SIZE
118#define	PAGE_SIZE 4096
119#undef MIN
120#define	MIN(a,b) (((a) < (b)) ? (a) : (b))
121#undef MAX
122#define	MAX(a,b) (((a) > (b)) ? (a) : (b))
123#define	MTX_DEF 0
124#define	MTX_SPIN 0
125#define	MTX_RECURSE 0
126#define	SX_DUPOK 0
127#define	SX_NOWITNESS 0
128#define	WITNESS_WARN(...)
129#define	cold 0
130#define	BUS_PROBE_GENERIC 0
131#define	BUS_PROBE_DEFAULT (-20)
132#define	CALLOUT_RETURNUNLOCKED 0x1
133#undef ffs
134#define	ffs(x) __builtin_ffs(x)
135#undef va_list
136#define	va_list __builtin_va_list
137#undef va_size
138#define	va_size(type) __builtin_va_size(type)
139#undef va_start
140#define	va_start(ap, last) __builtin_va_start(ap, last)
141#undef va_end
142#define	va_end(ap) __builtin_va_end(ap)
143#undef va_arg
144#define	va_arg(ap, type) __builtin_va_arg((ap), type)
145#define	DEVICE_ATTACH(dev, ...) \
146  (((device_attach_t *)(device_get_method(dev, "device_attach")))(dev,## __VA_ARGS__))
147#define	DEVICE_DETACH(dev, ...) \
148  (((device_detach_t *)(device_get_method(dev, "device_detach")))(dev,## __VA_ARGS__))
149#define	DEVICE_PROBE(dev, ...) \
150  (((device_probe_t *)(device_get_method(dev, "device_probe")))(dev,## __VA_ARGS__))
151#define	DEVICE_RESUME(dev, ...) \
152  (((device_resume_t *)(device_get_method(dev, "device_resume")))(dev,## __VA_ARGS__))
153#define	DEVICE_SHUTDOWN(dev, ...) \
154  (((device_shutdown_t *)(device_get_method(dev, "device_shutdown")))(dev,## __VA_ARGS__))
155#define	DEVICE_SUSPEND(dev, ...) \
156  (((device_suspend_t *)(device_get_method(dev, "device_suspend")))(dev,## __VA_ARGS__))
157#define	USB_HANDLE_REQUEST(dev, ...) \
158  (((usb_handle_request_t *)(device_get_method(dev, "usb_handle_request")))(dev,## __VA_ARGS__))
159#define	USB_TAKE_CONTROLLER(dev, ...) \
160  (((usb_take_controller_t *)(device_get_method(dev, "usb_take_controller")))(dev,## __VA_ARGS__))
161#define	GPIO_PIN_SET(dev, ...) \
162  (((gpio_pin_set_t *)(device_get_method(dev, "gpio_pin_set")))(dev,## __VA_ARGS__))
163#define	GPIO_PIN_SETFLAGS(dev, ...) \
164  (((gpio_pin_setflags_t *)(device_get_method(dev, "gpio_pin_setflags")))(dev,## __VA_ARGS__))
165
166enum {
167	SI_SUB_DUMMY = 0x0000000,
168	SI_SUB_LOCK = 0x1B00000,
169	SI_SUB_KLD = 0x2000000,
170	SI_SUB_DRIVERS = 0x3100000,
171	SI_SUB_PSEUDO = 0x7000000,
172	SI_SUB_KICK_SCHEDULER = 0xa000000,
173	SI_SUB_RUN_SCHEDULER = 0xfffffff
174};
175
176enum {
177	SI_ORDER_FIRST = 0x0000000,
178	SI_ORDER_SECOND = 0x0000001,
179	SI_ORDER_THIRD = 0x0000002,
180	SI_ORDER_FOURTH = 0x0000003,
181	SI_ORDER_MIDDLE = 0x1000000,
182	SI_ORDER_ANY = 0xfffffff	/* last */
183};
184
185struct uio;
186struct thread;
187struct malloc_type;
188struct usb_process;
189
190#ifndef INT32_MAX
191#define	INT32_MAX 0x7fffffff
192#endif
193
194#ifndef HAVE_STANDARD_DEFS
195#define	_UINT8_T_DECLARED
196typedef unsigned char uint8_t;
197#define	_INT8_T_DECLARED
198typedef signed char int8_t;
199#define	_UINT16_T_DECLARED
200typedef unsigned short uint16_t;
201#define	_INT16_T_DECLARED
202typedef signed short int16_t;
203#define	_UINT32_T_DECLARED
204typedef unsigned int uint32_t;
205#define	_INT32_T_DECLARED
206typedef signed int int32_t;
207#define	_UINT64_T_DECLARED
208typedef unsigned long long uint64_t;
209#define	_INT16_T_DECLARED
210typedef signed long long int64_t;
211
212typedef uint16_t uid_t;
213typedef uint16_t gid_t;
214typedef uint16_t mode_t;
215
216typedef uint8_t *caddr_t;
217#define	_UINTPTR_T_DECLARED
218typedef unsigned long uintptr_t;
219
220#define	_SIZE_T_DECLARED
221typedef unsigned long size_t;
222typedef unsigned long u_long;
223#endif
224
225typedef unsigned long bus_addr_t;
226typedef unsigned long bus_size_t;
227
228typedef struct bus_dma_segment {
229	bus_addr_t	ds_addr;	/* DMA address */
230	bus_size_t	ds_len;		/* length of transfer */
231} bus_dma_segment_t;
232
233struct bus_dma_tag {
234	uint32_t	alignment;
235	uint32_t	maxsize;
236};
237
238typedef void *bus_dmamap_t;
239typedef struct bus_dma_tag *bus_dma_tag_t;
240
241typedef enum {
242	BUS_DMA_LOCK	= 0x01,
243	BUS_DMA_UNLOCK	= 0x02,
244} bus_dma_lock_op_t;
245
246typedef void *bus_space_tag_t;
247typedef uint8_t *bus_space_handle_t;
248typedef int bus_dma_filter_t(void *, bus_addr_t);
249typedef void bus_dma_lock_t(void *, bus_dma_lock_op_t);
250
251typedef uint32_t bool;
252
253/* SYSINIT API */
254
255#include <sysinit.h>
256
257struct sysinit {
258	void    (*func) (void *arg);
259	void   *data;
260};
261
262/* MUTEX API */
263
264struct mtx {
265	int	owned;
266	struct mtx *parent;
267};
268
269#define	mtx_assert(...) do { } while (0)
270void	mtx_init(struct mtx *, const char *, const char *, int);
271void	mtx_lock(struct mtx *);
272void	mtx_unlock(struct mtx *);
273#define	mtx_lock_spin(x) mtx_lock(x)
274#define	mtx_unlock_spin(x) mtx_unlock(x)
275int	mtx_owned(struct mtx *);
276void	mtx_destroy(struct mtx *);
277
278extern struct mtx Giant;
279
280/* SX API */
281
282struct sx {
283	int	owned;
284};
285
286#define	sx_assert(...) do { } while (0)
287#define	sx_init(...) sx_init_flags(__VA_ARGS__, 0)
288void	sx_init_flags(struct sx *, const char *, int);
289void	sx_destroy(struct sx *);
290void	sx_xlock(struct sx *);
291void	sx_xunlock(struct sx *);
292int	sx_xlocked(struct sx *);
293
294/* CONDVAR API */
295
296struct cv {
297	int	sleeping;
298};
299
300void	cv_init(struct cv *, const char *desc);
301void	cv_destroy(struct cv *);
302void	cv_wait(struct cv *, struct mtx *);
303int	cv_timedwait(struct cv *, struct mtx *, int);
304void	cv_signal(struct cv *);
305void	cv_broadcast(struct cv *);
306
307/* CALLOUT API */
308
309typedef void callout_fn_t (void *);
310
311extern volatile int ticks;
312
313struct callout {
314	LIST_ENTRY(callout) entry;
315	callout_fn_t *c_func;
316	void   *c_arg;
317	struct mtx *mtx;
318	int	flags;
319	int	timeout;
320};
321
322void	callout_init_mtx(struct callout *, struct mtx *, int);
323void	callout_reset(struct callout *, int, callout_fn_t *, void *);
324void	callout_stop(struct callout *);
325void	callout_drain(struct callout *);
326int	callout_pending(struct callout *);
327void	callout_process(int timeout);
328
329/* DEVICE API */
330
331struct driver;
332struct devclass;
333struct device;
334struct module;
335struct module_data;
336
337typedef struct driver driver_t;
338typedef struct devclass *devclass_t;
339typedef struct device *device_t;
340typedef void (driver_intr_t)(void *arg);
341typedef int (driver_filter_t)(void *arg);
342#define	FILTER_STRAY		0x01
343#define	FILTER_HANDLED		0x02
344#define	FILTER_SCHEDULE_THREAD	0x04
345
346typedef int device_attach_t (device_t dev);
347typedef int device_detach_t (device_t dev);
348typedef int device_resume_t (device_t dev);
349typedef int device_shutdown_t (device_t dev);
350typedef int device_probe_t (device_t dev);
351typedef int device_suspend_t (device_t dev);
352typedef int gpio_pin_set_t (device_t dev, uint32_t, unsigned int);
353typedef int gpio_pin_setflags_t (device_t dev, uint32_t, uint32_t);
354
355typedef int bus_child_location_str_t (device_t parent, device_t child, char *buf, size_t buflen);
356typedef int bus_child_pnpinfo_str_t (device_t parent, device_t child, char *buf, size_t buflen);
357typedef void bus_driver_added_t (device_t dev, driver_t *driver);
358
359struct device_method {
360	const char *desc;
361	void   *const func;
362};
363
364typedef struct device_method device_method_t;
365
366struct device {
367	TAILQ_HEAD(device_list, device) dev_children;
368	TAILQ_ENTRY(device) dev_link;
369
370	struct device *dev_parent;
371	const struct module_data *dev_module;
372	void   *dev_sc;
373	void   *dev_aux;
374	driver_filter_t *dev_irq_filter;
375	driver_intr_t *dev_irq_fn;
376	void   *dev_irq_arg;
377
378	uint16_t dev_unit;
379
380	char	dev_nameunit[64];
381	char	dev_desc[64];
382
383	uint8_t	dev_res_alloc:1;
384	uint8_t	dev_quiet:1;
385	uint8_t	dev_softc_set:1;
386	uint8_t	dev_softc_alloc:1;
387	uint8_t	dev_attached:1;
388	uint8_t	dev_fixed_class:1;
389	uint8_t	dev_unit_manual:1;
390};
391
392struct devclass {
393	device_t dev_list[DEVCLASS_MAXUNIT];
394};
395
396struct driver {
397	const char *name;
398	const struct device_method *methods;
399	uint32_t size;
400};
401
402struct module_data {
403	int     (*callback) (struct module *, int, void *arg);
404	void   *arg;
405	const char *bus_name;
406	const char *mod_name;
407	const char *long_name;
408	const struct driver *driver;
409	struct devclass **devclass_pp;
410	TAILQ_ENTRY(module_data) entry;
411};
412
413device_t device_get_parent(device_t dev);
414void   *device_get_method(device_t dev, const char *what);
415const char *device_get_name(device_t dev);
416const char *device_get_nameunit(device_t dev);
417
418#define	device_printf(dev, fmt,...) \
419	printf("%s: " fmt, device_get_nameunit(dev),## __VA_ARGS__)
420device_t device_add_child(device_t dev, const char *name, int unit);
421void	device_quiet(device_t dev);
422void	device_set_interrupt(device_t dev, driver_filter_t *, driver_intr_t *, void *);
423void	device_run_interrupts(device_t parent);
424void	device_set_ivars(device_t dev, void *ivars);
425void   *device_get_ivars(device_t dev);
426const char *device_get_desc(device_t dev);
427int	device_probe_and_attach(device_t dev);
428int	device_detach(device_t dev);
429void   *device_get_softc(device_t dev);
430void	device_set_softc(device_t dev, void *softc);
431int	device_delete_child(device_t dev, device_t child);
432int	device_delete_children(device_t dev);
433int	device_is_attached(device_t dev);
434void	device_set_desc(device_t dev, const char *desc);
435void	device_set_desc_copy(device_t dev, const char *desc);
436int	device_get_unit(device_t dev);
437void   *devclass_get_softc(devclass_t dc, int unit);
438int	devclass_get_maxunit(devclass_t dc);
439device_t devclass_get_device(devclass_t dc, int unit);
440devclass_t devclass_find(const char *classname);
441
442#define	bus_get_dma_tag(...) (NULL)
443int	bus_generic_detach(device_t dev);
444int	bus_generic_resume(device_t dev);
445int	bus_generic_shutdown(device_t dev);
446int	bus_generic_suspend(device_t dev);
447int	bus_generic_print_child(device_t dev, device_t child);
448void	bus_generic_driver_added(device_t dev, driver_t *driver);
449int	bus_space_subregion(bus_space_tag_t t, bus_space_handle_t bsh,
450    bus_size_t offset, bus_size_t size, bus_space_handle_t *nbshp);
451
452/* BUS SPACE API */
453
454void	bus_space_write_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint8_t data);
455void	bus_space_write_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint16_t data);
456void	bus_space_write_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint32_t data);
457
458uint8_t	bus_space_read_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
459uint16_t bus_space_read_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
460uint32_t bus_space_read_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
461
462void	bus_space_read_multi_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint8_t *datap, bus_size_t count);
463void	bus_space_read_multi_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint16_t *datap, bus_size_t count);
464void	bus_space_read_multi_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint32_t *datap, bus_size_t count);
465
466void	bus_space_write_multi_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint8_t *datap, bus_size_t count);
467void	bus_space_write_multi_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint16_t *datap, bus_size_t count);
468void	bus_space_write_multi_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint32_t *datap, bus_size_t count);
469
470void	bus_space_read_region_1(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, uint8_t *datap, bus_size_t count);
471void	bus_space_write_region_1(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, uint8_t *datap, bus_size_t count);
472void	bus_space_read_region_4(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, uint32_t *datap, bus_size_t count);
473void	bus_space_write_region_4(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, uint32_t *datap, bus_size_t count);
474
475void	bus_space_barrier(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, bus_size_t length, int flags);
476
477void	module_register(void *);
478
479/* LIB-C */
480
481void   *memset(void *, int, size_t len);
482void   *memcpy(void *, const void *, size_t len);
483int	printf(const char *,...) __printflike(1, 2);
484int	snprintf(char *restrict str, size_t size, const char *restrict format,...) __printflike(3, 4);
485size_t	strlen(const char *s);
486
487/* MALLOC API */
488
489#undef malloc
490#define	malloc(s,x,f) usb_malloc(s)
491void   *usb_malloc(size_t);
492
493#undef free
494#define	free(p,x) usb_free(p)
495void	usb_free(void *);
496
497#define	strdup(p,x) usb_strdup(p)
498char   *usb_strdup(const char *str);
499
500/* ENDIANNESS */
501
502#ifndef HAVE_ENDIAN_DEFS
503
504/* Assume little endian */
505
506#define	htole64(x) ((uint64_t)(x))
507#define	le64toh(x) ((uint64_t)(x))
508
509#define	htole32(x) ((uint32_t)(x))
510#define	le32toh(x) ((uint32_t)(x))
511
512#define	htole16(x) ((uint16_t)(x))
513#define	le16toh(x) ((uint16_t)(x))
514
515#define	be32toh(x) ((uint32_t)(x))
516#define	htobe32(x) ((uint32_t)(x))
517
518#else
519#include <sys/endian.h>
520#endif
521
522/* USB */
523
524typedef int usb_handle_request_t (device_t dev, const void *req, void **pptr, uint16_t *plen, uint16_t offset, uint8_t *pstate);
525typedef int usb_take_controller_t (device_t dev);
526
527void	usb_idle(void);
528void	usb_init(void);
529void	usb_uninit(void);
530
531/* set some defaults */
532
533#ifndef USB_POOL_SIZE
534#define	USB_POOL_SIZE (1024*1024)	/* 1 MByte */
535#endif
536
537int	pause(const char *, int);
538void	DELAY(unsigned int);
539
540/* OTHER */
541
542struct selinfo {
543};
544
545/* SYSTEM STARTUP API */
546
547extern const void *sysinit_data[];
548extern const void *sysuninit_data[];
549
550/* Resources */
551
552enum intr_type {
553	INTR_TYPE_TTY = 1,
554	INTR_TYPE_BIO = 2,
555	INTR_TYPE_NET = 4,
556	INTR_TYPE_CAM = 8,
557	INTR_TYPE_MISC = 16,
558	INTR_TYPE_CLK = 32,
559	INTR_TYPE_AV = 64,
560	INTR_EXCL = 256,		/* exclusive interrupt */
561	INTR_MPSAFE = 512,		/* this interrupt is SMP safe */
562	INTR_ENTROPY = 1024,		/* this interrupt provides entropy */
563	INTR_MD1 = 4096,		/* flag reserved for MD use */
564	INTR_MD2 = 8192,		/* flag reserved for MD use */
565	INTR_MD3 = 16384,		/* flag reserved for MD use */
566	INTR_MD4 = 32768		/* flag reserved for MD use */
567};
568
569struct resource_i {
570	u_long		r_start;	/* index of the first entry in this resource */
571	u_long		r_end;		/* index of the last entry (inclusive) */
572};
573
574struct resource {
575	struct resource_i	*__r_i;
576	bus_space_tag_t		r_bustag; /* bus_space tag */
577	bus_space_handle_t	r_bushandle;	/* bus_space handle */
578};
579
580struct resource_spec {
581	int	type;
582	int	rid;
583	int	flags;
584};
585
586#define	SYS_RES_IRQ	1	/* interrupt lines */
587#define	SYS_RES_DRQ	2	/* isa dma lines */
588#define	SYS_RES_MEMORY	3	/* i/o memory */
589#define	SYS_RES_IOPORT	4	/* i/o ports */
590
591#define	RF_ALLOCATED	0x0001	/* resource has been reserved */
592#define	RF_ACTIVE	0x0002	/* resource allocation has been activated */
593#define	RF_SHAREABLE	0x0004	/* resource permits contemporaneous sharing */
594#define	RF_SPARE1	0x0008
595#define	RF_SPARE2	0x0010
596#define	RF_FIRSTSHARE	0x0020	/* first in sharing list */
597#define	RF_PREFETCHABLE	0x0040	/* resource is prefetchable */
598#define	RF_OPTIONAL	0x0080	/* for bus_alloc_resources() */
599
600int bus_alloc_resources(device_t, struct resource_spec *, struct resource **);
601int bus_release_resource(device_t, int, int, struct resource *);
602void bus_release_resources(device_t, const struct resource_spec *,
603    struct resource **);
604struct resource *bus_alloc_resource_any(device_t, int, int *, unsigned int);
605int bus_generic_attach(device_t);
606bus_space_tag_t rman_get_bustag(struct resource *);
607bus_space_handle_t rman_get_bushandle(struct resource *);
608u_long rman_get_size(struct resource *);
609int bus_setup_intr(device_t, struct resource *, int, driver_filter_t,
610    driver_intr_t, void *, void **);
611int bus_teardown_intr(device_t, struct resource *, void *);
612int ofw_bus_status_okay(device_t);
613int ofw_bus_is_compatible(device_t, char *);
614
615extern int (*bus_alloc_resource_any_cb)(struct resource *res, device_t dev,
616    int type, int *rid, unsigned int flags);
617extern int (*ofw_bus_status_ok_cb)(device_t dev);
618extern int (*ofw_bus_is_compatible_cb)(device_t dev, char *name);
619
620#ifndef strlcpy
621#define	strlcpy(d,s,n) snprintf((d),(n),"%s",(s))
622#endif
623
624/* Should be defined in user application since it is machine-dependent */
625extern int delay(unsigned int);
626
627/* BUS dma */
628#define	BUS_SPACE_MAXADDR_24BIT	0xFFFFFF
629#define	BUS_SPACE_MAXADDR_32BIT	0xFFFFFFFF
630#define	BUS_SPACE_MAXADDR	0xFFFFFFFF
631#define	BUS_SPACE_MAXSIZE_24BIT	0xFFFFFF
632#define	BUS_SPACE_MAXSIZE_32BIT	0xFFFFFFFF
633#define	BUS_SPACE_MAXSIZE	0xFFFFFFFF
634
635#define	BUS_DMA_WAITOK		0x00	/* safe to sleep (pseudo-flag) */
636#define	BUS_DMA_NOWAIT		0x01	/* not safe to sleep */
637#define	BUS_DMA_ALLOCNOW	0x02	/* perform resource allocation now */
638#define	BUS_DMA_COHERENT	0x04	/* hint: map memory in a coherent way */
639#define	BUS_DMA_ZERO		0x08	/* allocate zero'ed memory */
640#define	BUS_DMA_BUS1		0x10	/* placeholders for bus functions... */
641#define	BUS_DMA_BUS2		0x20
642#define	BUS_DMA_BUS3		0x40
643#define	BUS_DMA_BUS4		0x80
644
645typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
646
647int
648bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
649		   bus_size_t boundary, bus_addr_t lowaddr,
650		   bus_addr_t highaddr, bus_dma_filter_t *filter,
651		   void *filterarg, bus_size_t maxsize, int nsegments,
652		   bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
653		   void *lockfuncarg, bus_dma_tag_t *dmat);
654
655int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
656    bus_dmamap_t *mapp);
657void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
658int bus_dma_tag_destroy(bus_dma_tag_t dmat);
659
660#endif					/* _BSD_KERNEL_H_ */
661