sys/boot/usb/bsd_kernel.h

   1 /* $FreeBSD$ */
   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 #define __FreeBSD_version 1000000
  32
  33 #include <sys/cdefs.h>
  34 #include <sys/queue.h>
  35 #include <sys/errno.h>
  36
  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)
  40 #define M_USB 0
  41 #define M_USBDEV 0
  42 #define USB_PROC_MAX 3
  43 #define USB_BUS_GIANT_PROC(bus) (usb_process + 2)
  44 #define USB_BUS_NON_GIANT_PROC(bus) (usb_process + 2)
  45 #define USB_BUS_EXPLORE_PROC(bus) (usb_process + 0)
  46 #define USB_BUS_CONTROL_XFER_PROC(bus) (usb_process + 1)
  47 #define SYSCTL_DECL(...)
  48 #define SYSCTL_NODE(name,...) struct { } name __used
  49 #define SYSCTL_INT(...)
  50 #define TUNABLE_INT(...)
  51 #define MALLOC_DECLARE(...)
  52 #define MALLOC_DEFINE(...)
  53 #define EVENTHANDLER_DECLARE(...)
  54 #define EVENTHANDLER_INVOKE(...)
  55 #define KASSERT(...)
  56 #define SCHEDULER_STOPPED(x) (0)
  57 #define PI_SWI(...) (0)
  58 #define UNIQ_NAME(x) x
  59 #define UNIQ_NAME_STR(x) #x
  60 #define DEVCLASS_MAXUNIT 32
  61 #define MOD_LOAD 1
  62 #define MOD_UNLOAD 2
  63 #define DEVMETHOD(what,func) { #what, (void *)&func }
  64 #define DEVMETHOD_END {0,0}
  65 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg)        \
  66   static struct module_data bsd_##name##_##busname##_driver_mod = {     \
  67         evh, arg, #busname, #name, #busname "/" #name,                  \
  68         &driver, &devclass, { 0, 0 } };                                 \
  69 SYSINIT(bsd_##name##_##busname##_driver_mod, SI_SUB_DRIVERS,            \
  70   SI_ORDER_MIDDLE, module_register,                                     \
  71   &bsd_##name##_##busname##_driver_mod)
  72 #define SYSINIT(uniq, subs, order, _func, _data)        \
  73 const struct sysinit UNIQ_NAME(sysinit_##uniq) = {      \
  74         .func = (_func),                                \
  75         .data = __DECONST(void *, _data)                \
  76 };                                                      \
  77 SYSINIT_ENTRY(uniq##_entry, "sysinit", (subs),          \
  78     (order), "const struct sysinit",                    \
  79     UNIQ_NAME_STR(sysinit_##uniq), "SYSINIT")
  80
  81 #define SYSUNINIT(uniq, subs, order, _func, _data)      \
  82 const struct sysinit UNIQ_NAME(sysuninit_##uniq) = {    \
  83         .func = (_func),                                \
  84         .data = __DECONST(void *, _data)                \
  85 };                                                      \
  86 SYSINIT_ENTRY(uniq##_entry, "sysuninit", (subs),        \
  87     (order), "const struct sysuninit",                  \
  88     UNIQ_NAME_STR(sysuninit_##uniq), "SYSUNINIT")
  89 #define MODULE_DEPEND(...)
  90 #define MODULE_VERSION(...)
  91 #define NULL ((void *)0)
  92 #define BUS_SPACE_BARRIER_READ 0x01
  93 #define BUS_SPACE_BARRIER_WRITE 0x02
  94 #define hz 1000
  95 #define PAGE_SIZE 4096
  96 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
  97 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
  98 #define MTX_DEF 0
  99 #define MTX_RECURSE 0
 100 #define SX_DUPOK 0
 101 #define SX_NOWITNESS 0
 102 #define WITNESS_WARN(...)
 103 #define cold 0
 104 #define BUS_PROBE_GENERIC 0
 105 #define CALLOUT_RETURNUNLOCKED 0x1
 106 #define va_list __builtin_va_list
 107 #define va_size(type) __builtin_va_size(type)
 108 #define va_start(ap, last) __builtin_va_start(ap, last)
 109 #define va_end(ap) __builtin_va_end(ap)
 110 #define va_arg(ap, type) __builtin_va_arg((ap), type)
 111 #define DEVICE_ATTACH(dev, ...) \
 112   (((device_attach_t *)(device_get_method(dev, "device_attach")))(dev,## __VA_ARGS__))
 113 #define DEVICE_DETACH(dev, ...) \
 114   (((device_detach_t *)(device_get_method(dev, "device_detach")))(dev,## __VA_ARGS__))
 115 #define DEVICE_PROBE(dev, ...) \
 116   (((device_probe_t *)(device_get_method(dev, "device_probe")))(dev,## __VA_ARGS__))
 117 #define DEVICE_RESUME(dev, ...) \
 118   (((device_resume_t *)(device_get_method(dev, "device_resume")))(dev,## __VA_ARGS__))
 119 #define DEVICE_SHUTDOWN(dev, ...) \
 120   (((device_shutdown_t *)(device_get_method(dev, "device_shutdown")))(dev,## __VA_ARGS__))
 121 #define DEVICE_SUSPEND(dev, ...) \
 122   (((device_suspend_t *)(device_get_method(dev, "device_suspend")))(dev,## __VA_ARGS__))
 123 #define USB_HANDLE_REQUEST(dev, ...) \
 124   (((usb_handle_request_t *)(device_get_method(dev, "usb_handle_request")))(dev,## __VA_ARGS__))
 125 #define USB_TAKE_CONTROLLER(dev, ...) \
 126   (((usb_take_controller_t *)(device_get_method(dev, "usb_take_controller")))(dev,## __VA_ARGS__))
 127
 128 enum {
 129         SI_SUB_DUMMY = 0x0000000,
 130         SI_SUB_LOCK = 0x1B00000,
 131         SI_SUB_KLD = 0x2000000,
 132         SI_SUB_DRIVERS = 0x3100000,
 133         SI_SUB_PSEUDO = 0x7000000,
 134         SI_SUB_KICK_SCHEDULER = 0xa000000,
 135         SI_SUB_RUN_SCHEDULER = 0xfffffff
 136 };
 137
 138 enum {
 139         SI_ORDER_FIRST = 0x0000000,
 140         SI_ORDER_SECOND = 0x0000001,
 141         SI_ORDER_THIRD = 0x0000002,
 142         SI_ORDER_FOURTH = 0x0000003,
 143         SI_ORDER_MIDDLE = 0x1000000,
 144         SI_ORDER_ANY = 0xfffffff        /* last */
 145 };
 146
 147 struct uio;
 148 struct thread;
 149 struct malloc_type;
 150 struct usb_process;
 151
 152 typedef unsigned char uint8_t;
 153 typedef signed char int8_t;
 154
 155 typedef unsigned short uint16_t;
 156 typedef signed short int16_t;
 157
 158 typedef unsigned int uint32_t;
 159 typedef signed int int32_t;
 160
 161 typedef unsigned long long uint64_t;
 162 typedef signed long long int64_t;
 163
 164 typedef unsigned long bus_addr_t;
 165 typedef unsigned long bus_size_t;
 166
 167 typedef unsigned long size_t;
 168 typedef unsigned long u_long;
 169
 170 typedef void *bus_dmamap_t;
 171 typedef void *bus_dma_tag_t;
 172
 173 typedef void *bus_space_tag_t;
 174 typedef uint8_t *bus_space_handle_t;
 175
 176 typedef uint16_t uid_t;
 177 typedef uint16_t gid_t;
 178 typedef uint16_t mode_t;
 179
 180 typedef uint8_t *caddr_t;
 181 typedef unsigned long __uintptr_t;
 182 typedef unsigned long uintptr_t;
 183
 184 /* SYSINIT API */
 185
 186 #include <sysinit.h>
 187
 188 struct sysinit {
 189         void    (*func) (void *arg);
 190         void   *data;
 191 };
 192
 193 /* MUTEX API */
 194
 195 struct mtx {
 196         int     owned;
 197         struct mtx *parent;
 198 };
 199
 200 #define mtx_assert(...) do { } while (0)
 201 void    mtx_init(struct mtx *, const char *, const char *, int);
 202 void    mtx_lock(struct mtx *);
 203 void    mtx_unlock(struct mtx *);
 204 int     mtx_owned(struct mtx *);
 205 void    mtx_destroy(struct mtx *);
 206
 207 extern struct mtx Giant;
 208
 209 /* SX API */
 210
 211 struct sx {
 212         int     owned;
 213 };
 214
 215 #define sx_assert(...) do { } while (0)
 216 #define sx_init(...) sx_init_flags(__VA_ARGS__, 0)
 217 void    sx_init_flags(struct sx *, const char *, int);
 218 void    sx_destroy(struct sx *);
 219 void    sx_xlock(struct sx *);
 220 void    sx_xunlock(struct sx *);
 221 int     sx_xlocked(struct sx *);
 222
 223 /* CONDVAR API */
 224
 225 struct cv {
 226         int     sleeping;
 227 };
 228
 229 void    cv_init(struct cv *, const char *desc);
 230 void    cv_destroy(struct cv *);
 231 void    cv_wait(struct cv *, struct mtx *);
 232 int     cv_timedwait(struct cv *, struct mtx *, int);
 233 void    cv_signal(struct cv *);
 234 void    cv_broadcast(struct cv *);
 235
 236 /* CALLOUT API */
 237
 238 typedef void callout_fn_t (void *);
 239
 240 extern volatile int ticks;
 241
 242 struct callout {
 243         LIST_ENTRY(callout) entry;
 244         callout_fn_t *func;
 245         void   *arg;
 246         struct mtx *mtx;
 247         int     flags;
 248         int     timeout;
 249 };
 250
 251 void    callout_init_mtx(struct callout *, struct mtx *, int);
 252 void    callout_reset(struct callout *, int, callout_fn_t *, void *);
 253 void    callout_stop(struct callout *);
 254 void    callout_drain(struct callout *);
 255 int     callout_pending(struct callout *);
 256 void    callout_process(int timeout);
 257
 258 /* DEVICE API */
 259
 260 struct driver;
 261 struct devclass;
 262 struct device;
 263 struct module;
 264 struct module_data;
 265
 266 typedef struct driver driver_t;
 267 typedef struct devclass *devclass_t;
 268 typedef struct device *device_t;
 269 typedef void (intr_fn_t)(void *arg);
 270
 271 typedef int device_attach_t (device_t dev);
 272 typedef int device_detach_t (device_t dev);
 273 typedef int device_resume_t (device_t dev);
 274 typedef int device_shutdown_t (device_t dev);
 275 typedef int device_probe_t (device_t dev);
 276 typedef int device_suspend_t (device_t dev);
 277
 278 typedef int bus_child_location_str_t (device_t parent, device_t child, char *buf, size_t buflen);
 279 typedef int bus_child_pnpinfo_str_t (device_t parent, device_t child, char *buf, size_t buflen);
 280 typedef void bus_driver_added_t (device_t dev, driver_t *driver);
 281
 282 struct device_method {
 283         const char *desc;
 284         void   *const func;
 285 };
 286
 287 typedef struct device_method device_method_t;
 288
 289 struct device {
 290         TAILQ_HEAD(device_list, device) dev_children;
 291         TAILQ_ENTRY(device) dev_link;
 292
 293         struct device *dev_parent;
 294         const struct module_data *dev_module;
 295         void   *dev_sc;
 296         void   *dev_aux;
 297         intr_fn_t *dev_irq_fn;
 298         void   *dev_irq_arg;
 299
 300         uint16_t dev_unit;
 301
 302         char    dev_nameunit[64];
 303         char    dev_desc[64];
 304
 305         uint8_t dev_res_alloc:1;
 306         uint8_t dev_quiet:1;
 307         uint8_t dev_softc_set:1;
 308         uint8_t dev_softc_alloc:1;
 309         uint8_t dev_attached:1;
 310         uint8_t dev_fixed_class:1;
 311         uint8_t dev_unit_manual:1;
 312 };
 313
 314 struct devclass {
 315         device_t dev_list[DEVCLASS_MAXUNIT];
 316 };
 317
 318 struct driver {
 319         const char *name;
 320         const struct device_method *methods;
 321         uint32_t size;
 322 };
 323
 324 struct module_data {
 325         int     (*callback) (struct module *, int, void *arg);
 326         void   *arg;
 327         const char *bus_name;
 328         const char *mod_name;
 329         const char *long_name;
 330         const struct driver *driver;
 331         struct devclass **devclass_pp;
 332         TAILQ_ENTRY(module_data) entry;
 333 };
 334
 335 device_t device_get_parent(device_t dev);
 336 void   *device_get_method(device_t dev, const char *what);
 337 const char *device_get_name(device_t dev);
 338 const char *device_get_nameunit(device_t dev);
 339
 340 #define device_printf(dev, fmt,...) \
 341         printf("%s: " fmt, device_get_nameunit(dev),## __VA_ARGS__)
 342 device_t device_add_child(device_t dev, const char *name, int unit);
 343 void    device_quiet(device_t dev);
 344 void    device_set_interrupt(device_t dev, intr_fn_t *fn, void *arg);
 345 void    device_run_interrupts(device_t parent);
 346 void    device_set_ivars(device_t dev, void *ivars);
 347 void   *device_get_ivars(device_t dev);
 348 const char *device_get_desc(device_t dev);
 349 int     device_probe_and_attach(device_t dev);
 350 int     device_detach(device_t dev);
 351 void   *device_get_softc(device_t dev);
 352 void    device_set_softc(device_t dev, void *softc);
 353 int     device_delete_child(device_t dev, device_t child);
 354 int     device_delete_children(device_t dev);
 355 int     device_is_attached(device_t dev);
 356 void    device_set_desc(device_t dev, const char *desc);
 357 void    device_set_desc_copy(device_t dev, const char *desc);
 358 int     device_get_unit(device_t dev);
 359 void   *devclass_get_softc(devclass_t dc, int unit);
 360 int     devclass_get_maxunit(devclass_t dc);
 361 device_t devclass_get_device(devclass_t dc, int unit);
 362 devclass_t devclass_find(const char *classname);
 363
 364 #define bus_get_dma_tag(...) (NULL)
 365 int     bus_generic_detach(device_t dev);
 366 int     bus_generic_resume(device_t dev);
 367 int     bus_generic_shutdown(device_t dev);
 368 int     bus_generic_suspend(device_t dev);
 369 int     bus_generic_print_child(device_t dev, device_t child);
 370 void    bus_generic_driver_added(device_t dev, driver_t *driver);
 371
 372 /* BUS SPACE API */
 373
 374 void    bus_space_write_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint8_t data);
 375 void    bus_space_write_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint16_t data);
 376 void    bus_space_write_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, uint32_t data);
 377
 378 uint8_t bus_space_read_1(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
 379 uint16_t bus_space_read_2(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
 380 uint32_t bus_space_read_4(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset);
 381
 382 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);
 383 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);
 384 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);
 385
 386 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);
 387 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);
 388 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);
 389
 390 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);
 391 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);
 392 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);
 393 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);
 394
 395 void    bus_space_barrier(bus_space_tag_t space, bus_space_handle_t handle, bus_size_t offset, bus_size_t length, int flags);
 396
 397 void    module_register(void *);
 398
 399 /* LIB-C */
 400
 401 void   *memset(void *, int, size_t len);
 402 void   *memcpy(void *, const void *, size_t len);
 403 int     printf(const char *,...) __printflike(1, 2);
 404 int     snprintf(char *restrict str, size_t size, const char *restrict format,...) __printflike(3, 4);
 405 size_t  strlen(const char *s);
 406
 407 /* MALLOC API */
 408
 409 #define malloc(s,x,f) usb_malloc(s)
 410 void   *usb_malloc(size_t);
 411
 412 #define free(p,x) usb_free(p)
 413 void    usb_free(void *);
 414
 415 #define strdup(p,x) usb_strdup(p)
 416 char   *usb_strdup(const char *str);
 417
 418 /* ENDIANNESS */
 419
 420 /* Assume little endian */
 421
 422 #define htole64(x) ((uint64_t)(x))
 423 #define le64toh(x) ((uint64_t)(x))
 424
 425 #define htole32(x) ((uint32_t)(x))
 426 #define le32toh(x) ((uint32_t)(x))
 427
 428 #define htole16(x) ((uint16_t)(x))
 429 #define le16toh(x) ((uint16_t)(x))
 430
 431 #define be32toh(x) ((uint32_t)(x))
 432 #define htobe32(x) ((uint32_t)(x))
 433
 434 /* USB */
 435
 436 typedef int usb_handle_request_t (device_t dev, const void *req, void **pptr, uint16_t *plen, uint16_t offset, uint8_t *pstate);
 437 typedef int usb_take_controller_t (device_t dev);
 438
 439 void    usb_idle(void);
 440 void    usb_init(void);
 441 void    usb_uninit(void);
 442
 443 /* set some defaults */
 444
 445 #ifndef USB_POOL_SIZE
 446 #define USB_POOL_SIZE (1024*1024)       /* 1 MByte */
 447 #endif
 448
 449 int     pause(const char *, int);
 450 void    DELAY(unsigned int);
 451
 452 /* OTHER */
 453
 454 struct selinfo {
 455 };
 456
 457 /* SYSTEM STARTUP API */
 458
 459 extern const void *sysinit_data[];
 460 extern const void *sysuninit_data[];
 461
 462 #endif                                  /* _BSD_KERNEL_H_ */