3 * Copyright (c) 2011 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #ifndef _BSD_KERNEL_H_
28 #define _BSD_KERNEL_H_
31 #define __FreeBSD_version 1000000
33 #include <sys/cdefs.h>
34 #include <sys/queue.h>
35 #include <sys/errno.h>
37 #define isalpha(x) (((x) >= 'a' && (x) <= 'z') || ((x) >= 'A' && (x) <= 'Z'))
38 #define isdigit(x) ((x) >= '0' && (x) <= '9')
39 #define panic(...) do { printf("USB PANIC: " __VA_ARGS__); while (1) ; } while (0)
43 #define USB_PROC_MAX 3
44 #define USB_BUS_GIANT_PROC(bus) (usb_process + 2)
45 #define USB_BUS_NON_GIANT_PROC(bus) (usb_process + 2)
46 #define USB_BUS_EXPLORE_PROC(bus) (usb_process + 0)
47 #define USB_BUS_CONTROL_XFER_PROC(bus) (usb_process + 1)
48 #define SYSCTL_DECL(...)
49 #define SYSCTL_NODE(name,...) struct { } name __used
50 #define SYSCTL_INT(...)
51 #define TUNABLE_INT(...)
52 #define MALLOC_DECLARE(...)
53 #define MALLOC_DEFINE(...)
54 #define EVENTHANDLER_DECLARE(...)
55 #define EVENTHANDLER_INVOKE(...)
57 #define SCHEDULER_STOPPED(x) (0)
58 #define PI_SWI(...) (0)
59 #define UNIQ_NAME(x) x
60 #define UNIQ_NAME_STR(x) #x
61 #define DEVCLASS_MAXUNIT 32
64 #define DEVMETHOD(what,func) { #what, (void *)&func }
65 #define DEVMETHOD_END {0,0}
66 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
67 static struct module_data bsd_##name##_##busname##_driver_mod = { \
68 evh, arg, #busname, #name, #busname "/" #name, \
69 &driver, &devclass, { 0, 0 } }; \
70 SYSINIT(bsd_##name##_##busname##_driver_mod, SI_SUB_DRIVERS, \
71 SI_ORDER_MIDDLE, module_register, \
72 &bsd_##name##_##busname##_driver_mod)
73 #define SYSINIT(uniq, subs, order, _func, _data) \
74 const struct sysinit UNIQ_NAME(sysinit_##uniq) = { \
76 .data = __DECONST(void *, _data) \
78 SYSINIT_ENTRY(uniq##_entry, "sysinit", (subs), \
79 (order), "const struct sysinit", \
80 UNIQ_NAME_STR(sysinit_##uniq), "SYSINIT")
82 #define SYSUNINIT(uniq, subs, order, _func, _data) \
83 const struct sysinit UNIQ_NAME(sysuninit_##uniq) = { \
85 .data = __DECONST(void *, _data) \
87 SYSINIT_ENTRY(uniq##_entry, "sysuninit", (subs), \
88 (order), "const struct sysuninit", \
89 UNIQ_NAME_STR(sysuninit_##uniq), "SYSUNINIT")
90 #define MODULE_DEPEND(...)
91 #define MODULE_VERSION(...)
92 #define NULL ((void *)0)
93 #define BUS_SPACE_BARRIER_READ 0x01
94 #define BUS_SPACE_BARRIER_WRITE 0x02
96 #define PAGE_SIZE 4096
97 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
98 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
101 #define MTX_RECURSE 0
103 #define SX_NOWITNESS 0
104 #define WITNESS_WARN(...)
106 #define BUS_PROBE_GENERIC 0
107 #define CALLOUT_RETURNUNLOCKED 0x1
108 #define va_list __builtin_va_list
109 #define va_size(type) __builtin_va_size(type)
110 #define va_start(ap, last) __builtin_va_start(ap, last)
111 #define va_end(ap) __builtin_va_end(ap)
112 #define va_arg(ap, type) __builtin_va_arg((ap), type)
113 #define DEVICE_ATTACH(dev, ...) \
114 (((device_attach_t *)(device_get_method(dev, "device_attach")))(dev,## __VA_ARGS__))
115 #define DEVICE_DETACH(dev, ...) \
116 (((device_detach_t *)(device_get_method(dev, "device_detach")))(dev,## __VA_ARGS__))
117 #define DEVICE_PROBE(dev, ...) \
118 (((device_probe_t *)(device_get_method(dev, "device_probe")))(dev,## __VA_ARGS__))
119 #define DEVICE_RESUME(dev, ...) \
120 (((device_resume_t *)(device_get_method(dev, "device_resume")))(dev,## __VA_ARGS__))
121 #define DEVICE_SHUTDOWN(dev, ...) \
122 (((device_shutdown_t *)(device_get_method(dev, "device_shutdown")))(dev,## __VA_ARGS__))
123 #define DEVICE_SUSPEND(dev, ...) \
124 (((device_suspend_t *)(device_get_method(dev, "device_suspend")))(dev,## __VA_ARGS__))
125 #define USB_HANDLE_REQUEST(dev, ...) \
126 (((usb_handle_request_t *)(device_get_method(dev, "usb_handle_request")))(dev,## __VA_ARGS__))
127 #define USB_TAKE_CONTROLLER(dev, ...) \
128 (((usb_take_controller_t *)(device_get_method(dev, "usb_take_controller")))(dev,## __VA_ARGS__))
131 SI_SUB_DUMMY = 0x0000000,
132 SI_SUB_LOCK = 0x1B00000,
133 SI_SUB_KLD = 0x2000000,
134 SI_SUB_DRIVERS = 0x3100000,
135 SI_SUB_PSEUDO = 0x7000000,
136 SI_SUB_KICK_SCHEDULER = 0xa000000,
137 SI_SUB_RUN_SCHEDULER = 0xfffffff
141 SI_ORDER_FIRST = 0x0000000,
142 SI_ORDER_SECOND = 0x0000001,
143 SI_ORDER_THIRD = 0x0000002,
144 SI_ORDER_FOURTH = 0x0000003,
145 SI_ORDER_MIDDLE = 0x1000000,
146 SI_ORDER_ANY = 0xfffffff /* last */
154 typedef unsigned char uint8_t;
155 typedef signed char int8_t;
157 typedef unsigned short uint16_t;
158 typedef signed short int16_t;
160 typedef unsigned int uint32_t;
161 typedef signed int int32_t;
163 typedef unsigned long long uint64_t;
164 typedef signed long long int64_t;
166 typedef unsigned long bus_addr_t;
167 typedef unsigned long bus_size_t;
169 typedef unsigned long size_t;
170 typedef unsigned long u_long;
172 typedef void *bus_dmamap_t;
173 typedef void *bus_dma_tag_t;
175 typedef void *bus_space_tag_t;
176 typedef uint8_t *bus_space_handle_t;
178 typedef uint16_t uid_t;
179 typedef uint16_t gid_t;
180 typedef uint16_t mode_t;
182 typedef uint8_t *caddr_t;
183 typedef unsigned long __uintptr_t;
184 typedef unsigned long uintptr_t;
191 void (*func) (void *arg);
202 #define mtx_assert(...) do { } while (0)
203 void mtx_init(struct mtx *, const char *, const char *, int);
204 void mtx_lock(struct mtx *);
205 void mtx_unlock(struct mtx *);
206 #define mtx_lock_spin(x) mtx_lock(x)
207 #define mtx_unlock_spin(x) mtx_unlock(x)
208 int mtx_owned(struct mtx *);
209 void mtx_destroy(struct mtx *);
211 extern struct mtx Giant;
219 #define sx_assert(...) do { } while (0)
220 #define sx_init(...) sx_init_flags(__VA_ARGS__, 0)
221 void sx_init_flags(struct sx *, const char *, int);
222 void sx_destroy(struct sx *);
223 void sx_xlock(struct sx *);
224 void sx_xunlock(struct sx *);
225 int sx_xlocked(struct sx *);
233 void cv_init(struct cv *, const char *desc);
234 void cv_destroy(struct cv *);
235 void cv_wait(struct cv *, struct mtx *);
236 int cv_timedwait(struct cv *, struct mtx *, int);
237 void cv_signal(struct cv *);
238 void cv_broadcast(struct cv *);
242 typedef void callout_fn_t (void *);
244 extern volatile int ticks;
247 LIST_ENTRY(callout) entry;
255 void callout_init_mtx(struct callout *, struct mtx *, int);
256 void callout_reset(struct callout *, int, callout_fn_t *, void *);
257 void callout_stop(struct callout *);
258 void callout_drain(struct callout *);
259 int callout_pending(struct callout *);
260 void callout_process(int timeout);
270 typedef struct driver driver_t;
271 typedef struct devclass *devclass_t;
272 typedef struct device *device_t;
273 typedef void (driver_intr_t)(void *arg);
274 typedef int (driver_filter_t)(void *arg);
275 #define FILTER_STRAY 0x01
276 #define FILTER_HANDLED 0x02
277 #define FILTER_SCHEDULE_THREAD 0x04
279 typedef int device_attach_t (device_t dev);
280 typedef int device_detach_t (device_t dev);
281 typedef int device_resume_t (device_t dev);
282 typedef int device_shutdown_t (device_t dev);
283 typedef int device_probe_t (device_t dev);
284 typedef int device_suspend_t (device_t dev);
286 typedef int bus_child_location_str_t (device_t parent, device_t child, char *buf, size_t buflen);
287 typedef int bus_child_pnpinfo_str_t (device_t parent, device_t child, char *buf, size_t buflen);
288 typedef void bus_driver_added_t (device_t dev, driver_t *driver);
290 struct device_method {
295 typedef struct device_method device_method_t;
298 TAILQ_HEAD(device_list, device) dev_children;
299 TAILQ_ENTRY(device) dev_link;
301 struct device *dev_parent;
302 const struct module_data *dev_module;
305 driver_filter_t *dev_irq_filter;
306 driver_intr_t *dev_irq_fn;
311 char dev_nameunit[64];
314 uint8_t dev_res_alloc:1;
316 uint8_t dev_softc_set:1;
317 uint8_t dev_softc_alloc:1;
318 uint8_t dev_attached:1;
319 uint8_t dev_fixed_class:1;
320 uint8_t dev_unit_manual:1;
324 device_t dev_list[DEVCLASS_MAXUNIT];
329 const struct device_method *methods;
334 int (*callback) (struct module *, int, void *arg);
336 const char *bus_name;
337 const char *mod_name;
338 const char *long_name;
339 const struct driver *driver;
340 struct devclass **devclass_pp;
341 TAILQ_ENTRY(module_data) entry;
344 device_t device_get_parent(device_t dev);
345 void *device_get_method(device_t dev, const char *what);
346 const char *device_get_name(device_t dev);
347 const char *device_get_nameunit(device_t dev);
349 #define device_printf(dev, fmt,...) \
350 printf("%s: " fmt, device_get_nameunit(dev),## __VA_ARGS__)
351 device_t device_add_child(device_t dev, const char *name, int unit);
352 void device_quiet(device_t dev);
353 void device_set_interrupt(device_t dev, driver_filter_t *, driver_intr_t *, void *);
354 void device_run_interrupts(device_t parent);
355 void device_set_ivars(device_t dev, void *ivars);
356 void *device_get_ivars(device_t dev);
357 const char *device_get_desc(device_t dev);
358 int device_probe_and_attach(device_t dev);
359 int device_detach(device_t dev);
360 void *device_get_softc(device_t dev);
361 void device_set_softc(device_t dev, void *softc);
362 int device_delete_child(device_t dev, device_t child);
363 int device_delete_children(device_t dev);
364 int device_is_attached(device_t dev);
365 void device_set_desc(device_t dev, const char *desc);
366 void device_set_desc_copy(device_t dev, const char *desc);
367 int device_get_unit(device_t dev);
368 void *devclass_get_softc(devclass_t dc, int unit);
369 int devclass_get_maxunit(devclass_t dc);
370 device_t devclass_get_device(devclass_t dc, int unit);
371 devclass_t devclass_find(const char *classname);
373 #define bus_get_dma_tag(...) (NULL)
374 int bus_generic_detach(device_t dev);
375 int bus_generic_resume(device_t dev);
376 int bus_generic_shutdown(device_t dev);
377 int bus_generic_suspend(device_t dev);
378 int bus_generic_print_child(device_t dev, device_t child);
379 void bus_generic_driver_added(device_t dev, driver_t *driver);
383 void bus_space_write_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint8_t data);
384 void bus_space_write_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint16_t data);
385 void bus_space_write_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint32_t data);
387 uint8_t bus_space_read_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
388 uint16_t bus_space_read_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
389 uint32_t bus_space_read_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
391 void 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);
392 void 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);
393 void 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);
395 void 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);
396 void 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);
397 void 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);
399 void 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);
400 void 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);
401 void 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);
402 void 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);
404 void bus_space_barrier(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, bus_size_t length, int flags);
406 void module_register(void *);
410 void *memset(void *, int, size_t len);
411 void *memcpy(void *, const void *, size_t len);
412 int printf(const char *,...) __printflike(1, 2);
413 int snprintf(char *restrict str, size_t size, const char *restrict format,...) __printflike(3, 4);
414 size_t strlen(const char *s);
418 #define malloc(s,x,f) usb_malloc(s)
419 void *usb_malloc(size_t);
421 #define free(p,x) usb_free(p)
422 void usb_free(void *);
424 #define strdup(p,x) usb_strdup(p)
425 char *usb_strdup(const char *str);
429 /* Assume little endian */
431 #define htole64(x) ((uint64_t)(x))
432 #define le64toh(x) ((uint64_t)(x))
434 #define htole32(x) ((uint32_t)(x))
435 #define le32toh(x) ((uint32_t)(x))
437 #define htole16(x) ((uint16_t)(x))
438 #define le16toh(x) ((uint16_t)(x))
440 #define be32toh(x) ((uint32_t)(x))
441 #define htobe32(x) ((uint32_t)(x))
445 typedef int usb_handle_request_t (device_t dev, const void *req, void **pptr, uint16_t *plen, uint16_t offset, uint8_t *pstate);
446 typedef int usb_take_controller_t (device_t dev);
450 void usb_uninit(void);
452 /* set some defaults */
454 #ifndef USB_POOL_SIZE
455 #define USB_POOL_SIZE (1024*1024) /* 1 MByte */
458 int pause(const char *, int);
459 void DELAY(unsigned int);
466 /* SYSTEM STARTUP API */
468 extern const void *sysinit_data[];
469 extern const void *sysuninit_data[];
471 #endif /* _BSD_KERNEL_H_ */