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 #undef __FreeBSD_version
32 #define __FreeBSD_version 1100000
34 #include <sys/cdefs.h>
35 #include <sys/queue.h>
36 #include <sys/errno.h>
38 #define isalpha(x) (((x) >= 'a' && (x) <= 'z') || ((x) >= 'A' && (x) <= 'Z'))
39 #define isdigit(x) ((x) >= '0' && (x) <= '9')
40 #define panic(...) do { printf("USB PANIC: " __VA_ARGS__); while (1) ; } while (0)
44 #define USB_PROC_MAX 3
45 #define USB_BUS_GIANT_PROC(bus) (usb_process + 2)
46 #define USB_BUS_NON_GIANT_BULK_PROC(bus) (usb_process + 2)
47 #define USB_BUS_NON_GIANT_ISOC_PROC(bus) (usb_process + 2)
48 #define USB_BUS_EXPLORE_PROC(bus) (usb_process + 0)
49 #define USB_BUS_CONTROL_XFER_PROC(bus) (usb_process + 1)
50 #define SYSCTL_DECL(...)
51 #define SYSCTL_NODE(name,...) struct { } name __used
52 #define SYSCTL_INT(...)
53 #define TUNABLE_INT(...)
54 #define MALLOC_DECLARE(...)
55 #define MALLOC_DEFINE(...)
56 #define EVENTHANDLER_DECLARE(...)
57 #define EVENTHANDLER_INVOKE(...)
59 #define SCHEDULER_STOPPED(x) (0)
60 #define PI_SWI(...) (0)
61 #define UNIQ_NAME(x) x
62 #define UNIQ_NAME_STR(x) #x
63 #define DEVCLASS_MAXUNIT 32
66 #define DEVMETHOD(what,func) { #what, (void *)&func }
67 #define DEVMETHOD_END {0,0}
68 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
69 static struct module_data bsd_##name##_##busname##_driver_mod = { \
70 evh, arg, #busname, #name, #busname "/" #name, \
71 &driver, &devclass, { 0, 0 } }; \
72 SYSINIT(bsd_##name##_##busname##_driver_mod, SI_SUB_DRIVERS, \
73 SI_ORDER_MIDDLE, module_register, \
74 &bsd_##name##_##busname##_driver_mod)
75 #define SYSINIT(uniq, subs, order, _func, _data) \
76 const struct sysinit UNIQ_NAME(sysinit_##uniq) = { \
78 .data = __DECONST(void *, _data) \
80 SYSINIT_ENTRY(uniq##_entry, "sysinit", (subs), \
81 (order), "const struct sysinit", \
82 UNIQ_NAME_STR(sysinit_##uniq), "SYSINIT")
84 #define SYSUNINIT(uniq, subs, order, _func, _data) \
85 const struct sysinit UNIQ_NAME(sysuninit_##uniq) = { \
87 .data = __DECONST(void *, _data) \
89 SYSINIT_ENTRY(uniq##_entry, "sysuninit", (subs), \
90 (order), "const struct sysuninit", \
91 UNIQ_NAME_STR(sysuninit_##uniq), "SYSUNINIT")
92 #define MODULE_DEPEND(...)
93 #define MODULE_VERSION(...)
94 #define NULL ((void *)0)
95 #define BUS_SPACE_BARRIER_READ 0x01
96 #define BUS_SPACE_BARRIER_WRITE 0x02
99 #define PAGE_SIZE 4096
101 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
103 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
106 #define MTX_RECURSE 0
108 #define SX_NOWITNESS 0
109 #define WITNESS_WARN(...)
111 #define BUS_PROBE_GENERIC 0
112 #define CALLOUT_RETURNUNLOCKED 0x1
114 #define ffs(x) __builtin_ffs(x)
116 #define va_list __builtin_va_list
118 #define va_size(type) __builtin_va_size(type)
120 #define va_start(ap, last) __builtin_va_start(ap, last)
122 #define va_end(ap) __builtin_va_end(ap)
124 #define va_arg(ap, type) __builtin_va_arg((ap), type)
125 #define DEVICE_ATTACH(dev, ...) \
126 (((device_attach_t *)(device_get_method(dev, "device_attach")))(dev,## __VA_ARGS__))
127 #define DEVICE_DETACH(dev, ...) \
128 (((device_detach_t *)(device_get_method(dev, "device_detach")))(dev,## __VA_ARGS__))
129 #define DEVICE_PROBE(dev, ...) \
130 (((device_probe_t *)(device_get_method(dev, "device_probe")))(dev,## __VA_ARGS__))
131 #define DEVICE_RESUME(dev, ...) \
132 (((device_resume_t *)(device_get_method(dev, "device_resume")))(dev,## __VA_ARGS__))
133 #define DEVICE_SHUTDOWN(dev, ...) \
134 (((device_shutdown_t *)(device_get_method(dev, "device_shutdown")))(dev,## __VA_ARGS__))
135 #define DEVICE_SUSPEND(dev, ...) \
136 (((device_suspend_t *)(device_get_method(dev, "device_suspend")))(dev,## __VA_ARGS__))
137 #define USB_HANDLE_REQUEST(dev, ...) \
138 (((usb_handle_request_t *)(device_get_method(dev, "usb_handle_request")))(dev,## __VA_ARGS__))
139 #define USB_TAKE_CONTROLLER(dev, ...) \
140 (((usb_take_controller_t *)(device_get_method(dev, "usb_take_controller")))(dev,## __VA_ARGS__))
143 SI_SUB_DUMMY = 0x0000000,
144 SI_SUB_LOCK = 0x1B00000,
145 SI_SUB_KLD = 0x2000000,
146 SI_SUB_DRIVERS = 0x3100000,
147 SI_SUB_PSEUDO = 0x7000000,
148 SI_SUB_KICK_SCHEDULER = 0xa000000,
149 SI_SUB_RUN_SCHEDULER = 0xfffffff
153 SI_ORDER_FIRST = 0x0000000,
154 SI_ORDER_SECOND = 0x0000001,
155 SI_ORDER_THIRD = 0x0000002,
156 SI_ORDER_FOURTH = 0x0000003,
157 SI_ORDER_MIDDLE = 0x1000000,
158 SI_ORDER_ANY = 0xfffffff /* last */
166 #ifndef HAVE_STANDARD_DEFS
167 #define _UINT8_T_DECLARED
168 typedef unsigned char uint8_t;
169 #define _INT8_T_DECLARED
170 typedef signed char int8_t;
171 #define _UINT16_T_DECLARED
172 typedef unsigned short uint16_t;
173 #define _INT16_T_DECLARED
174 typedef signed short int16_t;
175 #define _UINT32_T_DECLARED
176 typedef unsigned int uint32_t;
177 #define _INT32_T_DECLARED
178 typedef signed int int32_t;
179 #define _UINT64_T_DECLARED
180 typedef unsigned long long uint64_t;
181 #define _INT16_T_DECLARED
182 typedef signed long long int64_t;
184 typedef uint16_t uid_t;
185 typedef uint16_t gid_t;
186 typedef uint16_t mode_t;
188 typedef uint8_t *caddr_t;
189 #define _UINTPTR_T_DECLARED
190 typedef unsigned long uintptr_t;
192 #define _SIZE_T_DECLARED
193 typedef unsigned long size_t;
194 typedef unsigned long u_long;
197 typedef unsigned long bus_addr_t;
198 typedef unsigned long bus_size_t;
200 typedef void *bus_dmamap_t;
201 typedef void *bus_dma_tag_t;
203 typedef void *bus_space_tag_t;
204 typedef uint8_t *bus_space_handle_t;
211 void (*func) (void *arg);
222 #define mtx_assert(...) do { } while (0)
223 void mtx_init(struct mtx *, const char *, const char *, int);
224 void mtx_lock(struct mtx *);
225 void mtx_unlock(struct mtx *);
226 #define mtx_lock_spin(x) mtx_lock(x)
227 #define mtx_unlock_spin(x) mtx_unlock(x)
228 int mtx_owned(struct mtx *);
229 void mtx_destroy(struct mtx *);
231 extern struct mtx Giant;
239 #define sx_assert(...) do { } while (0)
240 #define sx_init(...) sx_init_flags(__VA_ARGS__, 0)
241 void sx_init_flags(struct sx *, const char *, int);
242 void sx_destroy(struct sx *);
243 void sx_xlock(struct sx *);
244 void sx_xunlock(struct sx *);
245 int sx_xlocked(struct sx *);
253 void cv_init(struct cv *, const char *desc);
254 void cv_destroy(struct cv *);
255 void cv_wait(struct cv *, struct mtx *);
256 int cv_timedwait(struct cv *, struct mtx *, int);
257 void cv_signal(struct cv *);
258 void cv_broadcast(struct cv *);
262 typedef void callout_fn_t (void *);
264 extern volatile int ticks;
267 LIST_ENTRY(callout) entry;
275 void callout_init_mtx(struct callout *, struct mtx *, int);
276 void callout_reset(struct callout *, int, callout_fn_t *, void *);
277 void callout_stop(struct callout *);
278 void callout_drain(struct callout *);
279 int callout_pending(struct callout *);
280 void callout_process(int timeout);
290 typedef struct driver driver_t;
291 typedef struct devclass *devclass_t;
292 typedef struct device *device_t;
293 typedef void (driver_intr_t)(void *arg);
294 typedef int (driver_filter_t)(void *arg);
295 #define FILTER_STRAY 0x01
296 #define FILTER_HANDLED 0x02
297 #define FILTER_SCHEDULE_THREAD 0x04
299 typedef int device_attach_t (device_t dev);
300 typedef int device_detach_t (device_t dev);
301 typedef int device_resume_t (device_t dev);
302 typedef int device_shutdown_t (device_t dev);
303 typedef int device_probe_t (device_t dev);
304 typedef int device_suspend_t (device_t dev);
306 typedef int bus_child_location_str_t (device_t parent, device_t child, char *buf, size_t buflen);
307 typedef int bus_child_pnpinfo_str_t (device_t parent, device_t child, char *buf, size_t buflen);
308 typedef void bus_driver_added_t (device_t dev, driver_t *driver);
310 struct device_method {
315 typedef struct device_method device_method_t;
318 TAILQ_HEAD(device_list, device) dev_children;
319 TAILQ_ENTRY(device) dev_link;
321 struct device *dev_parent;
322 const struct module_data *dev_module;
325 driver_filter_t *dev_irq_filter;
326 driver_intr_t *dev_irq_fn;
331 char dev_nameunit[64];
334 uint8_t dev_res_alloc:1;
336 uint8_t dev_softc_set:1;
337 uint8_t dev_softc_alloc:1;
338 uint8_t dev_attached:1;
339 uint8_t dev_fixed_class:1;
340 uint8_t dev_unit_manual:1;
344 device_t dev_list[DEVCLASS_MAXUNIT];
349 const struct device_method *methods;
354 int (*callback) (struct module *, int, void *arg);
356 const char *bus_name;
357 const char *mod_name;
358 const char *long_name;
359 const struct driver *driver;
360 struct devclass **devclass_pp;
361 TAILQ_ENTRY(module_data) entry;
364 device_t device_get_parent(device_t dev);
365 void *device_get_method(device_t dev, const char *what);
366 const char *device_get_name(device_t dev);
367 const char *device_get_nameunit(device_t dev);
369 #define device_printf(dev, fmt,...) \
370 printf("%s: " fmt, device_get_nameunit(dev),## __VA_ARGS__)
371 device_t device_add_child(device_t dev, const char *name, int unit);
372 void device_quiet(device_t dev);
373 void device_set_interrupt(device_t dev, driver_filter_t *, driver_intr_t *, void *);
374 void device_run_interrupts(device_t parent);
375 void device_set_ivars(device_t dev, void *ivars);
376 void *device_get_ivars(device_t dev);
377 const char *device_get_desc(device_t dev);
378 int device_probe_and_attach(device_t dev);
379 int device_detach(device_t dev);
380 void *device_get_softc(device_t dev);
381 void device_set_softc(device_t dev, void *softc);
382 int device_delete_child(device_t dev, device_t child);
383 int device_delete_children(device_t dev);
384 int device_is_attached(device_t dev);
385 void device_set_desc(device_t dev, const char *desc);
386 void device_set_desc_copy(device_t dev, const char *desc);
387 int device_get_unit(device_t dev);
388 void *devclass_get_softc(devclass_t dc, int unit);
389 int devclass_get_maxunit(devclass_t dc);
390 device_t devclass_get_device(devclass_t dc, int unit);
391 devclass_t devclass_find(const char *classname);
393 #define bus_get_dma_tag(...) (NULL)
394 int bus_generic_detach(device_t dev);
395 int bus_generic_resume(device_t dev);
396 int bus_generic_shutdown(device_t dev);
397 int bus_generic_suspend(device_t dev);
398 int bus_generic_print_child(device_t dev, device_t child);
399 void bus_generic_driver_added(device_t dev, driver_t *driver);
403 void bus_space_write_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint8_t data);
404 void bus_space_write_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint16_t data);
405 void bus_space_write_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint32_t data);
407 uint8_t bus_space_read_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
408 uint16_t bus_space_read_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
409 uint32_t bus_space_read_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
411 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);
412 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);
413 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);
415 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);
416 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);
417 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);
419 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);
420 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);
421 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);
422 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);
424 void bus_space_barrier(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, bus_size_t length, int flags);
426 void module_register(void *);
430 void *memset(void *, int, size_t len);
431 void *memcpy(void *, const void *, size_t len);
432 int printf(const char *,...) __printflike(1, 2);
433 int snprintf(char *restrict str, size_t size, const char *restrict format,...) __printflike(3, 4);
434 size_t strlen(const char *s);
439 #define malloc(s,x,f) usb_malloc(s)
440 void *usb_malloc(size_t);
443 #define free(p,x) usb_free(p)
444 void usb_free(void *);
446 #define strdup(p,x) usb_strdup(p)
447 char *usb_strdup(const char *str);
451 #ifndef HAVE_ENDIAN_DEFS
453 /* Assume little endian */
455 #define htole64(x) ((uint64_t)(x))
456 #define le64toh(x) ((uint64_t)(x))
458 #define htole32(x) ((uint32_t)(x))
459 #define le32toh(x) ((uint32_t)(x))
461 #define htole16(x) ((uint16_t)(x))
462 #define le16toh(x) ((uint16_t)(x))
464 #define be32toh(x) ((uint32_t)(x))
465 #define htobe32(x) ((uint32_t)(x))
468 #include <sys/endian.h>
473 typedef int usb_handle_request_t (device_t dev, const void *req, void **pptr, uint16_t *plen, uint16_t offset, uint8_t *pstate);
474 typedef int usb_take_controller_t (device_t dev);
478 void usb_uninit(void);
480 /* set some defaults */
482 #ifndef USB_POOL_SIZE
483 #define USB_POOL_SIZE (1024*1024) /* 1 MByte */
486 int pause(const char *, int);
487 void DELAY(unsigned int);
494 /* SYSTEM STARTUP API */
496 extern const void *sysinit_data[];
497 extern const void *sysuninit_data[];
499 #endif /* _BSD_KERNEL_H_ */