sys/bus/u4b/usbdi.h

   1 /*-
   2  * Copyright (c) 2009 Andrew Thompson
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  *
  24  * $FreeBSD$
  25  */
  26 #ifndef _USB_USBDI_H_
  27 #define _USB_USBDI_H_
  28
  29 struct usb_fifo;
  30 struct usb_xfer;
  31 struct usb_device;
  32 struct usb_attach_arg;
  33 struct usb_interface;
  34 struct usb_endpoint;
  35 struct usb_page_cache;
  36 struct usb_page_search;
  37 struct usb_process;
  38 struct usb_proc_msg;
  39 struct usb_mbuf;
  40 struct usb_fs_privdata;
  41 struct mbuf;
  42
  43 typedef enum {  /* keep in sync with usb_errstr_table */
  44         USB_ERR_NORMAL_COMPLETION = 0,
  45         USB_ERR_PENDING_REQUESTS,       /* 1 */
  46         USB_ERR_NOT_STARTED,            /* 2 */
  47         USB_ERR_INVAL,                  /* 3 */
  48         USB_ERR_NOMEM,                  /* 4 */
  49         USB_ERR_CANCELLED,              /* 5 */
  50         USB_ERR_BAD_ADDRESS,            /* 6 */
  51         USB_ERR_BAD_BUFSIZE,            /* 7 */
  52         USB_ERR_BAD_FLAG,               /* 8 */
  53         USB_ERR_NO_CALLBACK,            /* 9 */
  54         USB_ERR_IN_USE,                 /* 10 */
  55         USB_ERR_NO_ADDR,                /* 11 */
  56         USB_ERR_NO_PIPE,                /* 12 */
  57         USB_ERR_ZERO_NFRAMES,           /* 13 */
  58         USB_ERR_ZERO_MAXP,              /* 14 */
  59         USB_ERR_SET_ADDR_FAILED,        /* 15 */
  60         USB_ERR_NO_POWER,               /* 16 */
  61         USB_ERR_TOO_DEEP,               /* 17 */
  62         USB_ERR_IOERROR,                /* 18 */
  63         USB_ERR_NOT_CONFIGURED,         /* 19 */
  64         USB_ERR_TIMEOUT,                /* 20 */
  65         USB_ERR_SHORT_XFER,             /* 21 */
  66         USB_ERR_STALLED,                /* 22 */
  67         USB_ERR_INTERRUPTED,            /* 23 */
  68         USB_ERR_DMA_LOAD_FAILED,        /* 24 */
  69         USB_ERR_BAD_CONTEXT,            /* 25 */
  70         USB_ERR_NO_ROOT_HUB,            /* 26 */
  71         USB_ERR_NO_INTR_THREAD,         /* 27 */
  72         USB_ERR_NOT_LOCKED,             /* 28 */
  73         USB_ERR_MAX
  74 } usb_error_t;
  75
  76 /*
  77  * Flags for transfers
  78  */
  79 #define USB_FORCE_SHORT_XFER    0x0001  /* force a short transmit last */
  80 #define USB_SHORT_XFER_OK       0x0004  /* allow short reads */
  81 #define USB_DELAY_STATUS_STAGE  0x0010  /* insert delay before STATUS stage */
  82 #define USB_USER_DATA_PTR       0x0020  /* internal flag */
  83 #define USB_MULTI_SHORT_OK      0x0040  /* allow multiple short frames */
  84 #define USB_MANUAL_STATUS       0x0080  /* manual ctrl status */
  85
  86 #define USB_NO_TIMEOUT 0
  87 #define USB_DEFAULT_TIMEOUT 5000        /* 5000 ms = 5 seconds */
  88
  89 #if defined(_KERNEL)
  90 /* typedefs */
  91
  92 typedef void (usb_callback_t)(struct usb_xfer *, usb_error_t);
  93 typedef void (usb_proc_callback_t)(struct usb_proc_msg *);
  94 typedef usb_error_t (usb_handle_req_t)(struct usb_device *,
  95     struct usb_device_request *, const void **, uint16_t *);
  96
  97 typedef int (usb_fifo_open_t)(struct usb_fifo *fifo, int fflags);
  98 typedef void (usb_fifo_close_t)(struct usb_fifo *fifo, int fflags);
  99 typedef int (usb_fifo_ioctl_t)(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags);
 100 typedef void (usb_fifo_cmd_t)(struct usb_fifo *fifo);
 101 typedef void (usb_fifo_filter_t)(struct usb_fifo *fifo, struct usb_mbuf *m);
 102
 103
 104 /* USB events */
 105 #include <sys/eventhandler.h>
 106 typedef void (*usb_dev_configured_t)(void *, struct usb_device *,
 107     struct usb_attach_arg *);
 108 EVENTHANDLER_DECLARE(usb_dev_configured, usb_dev_configured_t);
 109
 110 /*
 111  * The following macros are used used to convert milliseconds into
 112  * HZ. We use 1024 instead of 1000 milliseconds per second to save a
 113  * full division.
 114  */
 115 #define USB_MS_HZ 1024
 116
 117 #define USB_MS_TO_TICKS(ms) \
 118   (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ)
 119
 120 /*
 121  * Common queue structure for USB transfers.
 122  */
 123 struct usb_xfer_queue {
 124         TAILQ_HEAD(, usb_xfer) head;
 125         struct usb_xfer *curr;          /* current USB transfer processed */
 126         void    (*command) (struct usb_xfer_queue *pq);
 127         uint8_t recurse_1:1;
 128         uint8_t recurse_2:1;
 129 };
 130
 131 /*
 132  * The following structure defines an USB endpoint
 133  * USB endpoint.
 134  */
 135 struct usb_endpoint {
 136         /* queue of USB transfers */
 137         struct usb_xfer_queue endpoint_q[USB_MAX_EP_STREAMS];
 138
 139         struct usb_endpoint_descriptor *edesc;
 140         struct usb_endpoint_ss_comp_descriptor *ecomp;
 141         const struct usb_pipe_methods *methods; /* set by HC driver */
 142
 143         uint16_t isoc_next;
 144
 145         uint8_t toggle_next:1;          /* next data toggle value */
 146         uint8_t is_stalled:1;           /* set if endpoint is stalled */
 147         uint8_t is_synced:1;            /* set if we a synchronised */
 148         uint8_t unused:5;
 149         uint8_t iface_index;            /* not used by "default endpoint" */
 150
 151         uint8_t refcount_alloc;         /* allocation refcount */
 152         uint8_t refcount_bw;            /* bandwidth refcount */
 153 #define USB_EP_REF_MAX 0x3f
 154
 155         /* High-Speed resource allocation (valid if "refcount_bw" > 0) */
 156
 157         uint8_t usb_smask;              /* USB start mask */
 158         uint8_t usb_cmask;              /* USB complete mask */
 159         uint8_t usb_uframe;             /* USB microframe */
 160
 161         /* USB endpoint mode, see USB_EP_MODE_XXX */
 162
 163         uint8_t ep_mode;
 164 };
 165
 166 /*
 167  * The following structure defines an USB interface.
 168  */
 169 struct usb_interface {
 170         struct usb_interface_descriptor *idesc;
 171         device_t subdev;
 172         uint8_t alt_index;
 173         uint8_t parent_iface_index;
 174
 175         /* Linux compat */
 176         struct usb_host_interface *altsetting;
 177         struct usb_host_interface *cur_altsetting;
 178         struct usb_device *linux_udev;
 179         void   *bsd_priv_sc;            /* device specific information */
 180         char   *pnpinfo;                /* additional PnP-info for this interface */
 181         uint8_t num_altsetting;         /* number of alternate settings */
 182         uint8_t bsd_iface_index;
 183 };
 184
 185 /*
 186  * The following structure defines a set of USB transfer flags.
 187  */
 188 struct usb_xfer_flags {
 189         uint8_t force_short_xfer:1;     /* force a short transmit transfer
 190                                          * last */
 191         uint8_t short_xfer_ok:1;        /* allow short receive transfers */
 192         uint8_t short_frames_ok:1;      /* allow short frames */
 193         uint8_t pipe_bof:1;             /* block pipe on failure */
 194         uint8_t proxy_buffer:1;         /* makes buffer size a factor of
 195                                          * "max_frame_size" */
 196         uint8_t ext_buffer:1;           /* uses external DMA buffer */
 197         uint8_t manual_status:1;        /* non automatic status stage on
 198                                          * control transfers */
 199         uint8_t no_pipe_ok:1;           /* set if "USB_ERR_NO_PIPE" error can
 200                                          * be ignored */
 201         uint8_t stall_pipe:1;           /* set if the endpoint belonging to
 202                                          * this USB transfer should be stalled
 203                                          * before starting this transfer! */
 204         uint8_t pre_scale_frames:1;     /* "usb_config->frames" is
 205                                          * assumed to give the
 206                                          * buffering time in
 207                                          * milliseconds and is
 208                                          * converted into the nearest
 209                                          * number of frames when the
 210                                          * USB transfer is setup. This
 211                                          * option only has effect for
 212                                          * ISOCHRONOUS transfers.
 213                                          */
 214 };
 215
 216 /*
 217  * The following structure define an USB configuration, that basically
 218  * is used when setting up an USB transfer.
 219  */
 220 struct usb_config {
 221         usb_callback_t *callback;       /* USB transfer callback */
 222         usb_frlength_t bufsize; /* total pipe buffer size in bytes */
 223         usb_frcount_t frames;           /* maximum number of USB frames */
 224         usb_timeout_t interval; /* interval in milliseconds */
 225 #define USB_DEFAULT_INTERVAL    0
 226         usb_timeout_t timeout;          /* transfer timeout in milliseconds */
 227         struct usb_xfer_flags flags;    /* transfer flags */
 228         usb_stream_t stream_id;         /* USB3.0 specific */
 229         enum usb_hc_mode usb_mode;      /* host or device mode */
 230         uint8_t type;                   /* pipe type */
 231         uint8_t endpoint;               /* pipe number */
 232         uint8_t direction;              /* pipe direction */
 233         uint8_t ep_index;               /* pipe index match to use */
 234         uint8_t if_index;               /* "ifaces" index to use */
 235 };
 236
 237 /*
 238  * Use these macro when defining USB device ID arrays if you want to
 239  * have your driver module automatically loaded in host, device or
 240  * both modes respectivly:
 241  */
 242 #if USB_HAVE_ID_SECTION
 243 #define STRUCT_USB_HOST_ID \
 244     struct usb_device_id __section("usb_host_id")
 245 #define STRUCT_USB_DEVICE_ID \
 246     struct usb_device_id __section("usb_device_id")
 247 #define STRUCT_USB_DUAL_ID \
 248     struct usb_device_id __section("usb_dual_id")
 249 #else
 250 #define STRUCT_USB_HOST_ID \
 251     struct usb_device_id
 252 #define STRUCT_USB_DEVICE_ID \
 253     struct usb_device_id
 254 #define STRUCT_USB_DUAL_ID \
 255     struct usb_device_id
 256 #endif                  /* USB_HAVE_ID_SECTION */
 257
 258 /*
 259  * The following structure is used when looking up an USB driver for
 260  * an USB device. It is inspired by the Linux structure called
 261  * "usb_device_id".
 262  */
 263 struct usb_device_id {
 264
 265         /* Hook for driver specific information */
 266         unsigned long driver_info;
 267
 268         /* Used for product specific matches; the BCD range is inclusive */
 269         uint16_t idVendor;
 270         uint16_t idProduct;
 271         uint16_t bcdDevice_lo;
 272         uint16_t bcdDevice_hi;
 273
 274         /* Used for device class matches */
 275         uint8_t bDeviceClass;
 276         uint8_t bDeviceSubClass;
 277         uint8_t bDeviceProtocol;
 278
 279         /* Used for interface class matches */
 280         uint8_t bInterfaceClass;
 281         uint8_t bInterfaceSubClass;
 282         uint8_t bInterfaceProtocol;
 283
 284         /* Select which fields to match against */
 285         uint8_t match_flag_vendor:1;
 286         uint8_t match_flag_product:1;
 287         uint8_t match_flag_dev_lo:1;
 288         uint8_t match_flag_dev_hi:1;
 289
 290         uint8_t match_flag_dev_class:1;
 291         uint8_t match_flag_dev_subclass:1;
 292         uint8_t match_flag_dev_protocol:1;
 293         uint8_t match_flag_int_class:1;
 294
 295         uint8_t match_flag_int_subclass:1;
 296         uint8_t match_flag_int_protocol:1;
 297         uint8_t match_flag_unused:6;
 298
 299 #if USB_HAVE_COMPAT_LINUX
 300         /* which fields to match against */
 301         uint16_t match_flags;
 302 #define USB_DEVICE_ID_MATCH_VENDOR              0x0001
 303 #define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
 304 #define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
 305 #define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
 306 #define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
 307 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
 308 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
 309 #define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
 310 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
 311 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
 312 #endif
 313 } __aligned(32);
 314
 315 /* check that the size of the structure above is correct */
 316 extern char usb_device_id_assert[(sizeof(struct usb_device_id) == 32) ? 1 : -1];
 317
 318 #define USB_VENDOR(vend)                        \
 319   .match_flag_vendor = 1, .idVendor = (vend)
 320
 321 #define USB_PRODUCT(prod)                       \
 322   .match_flag_product = 1, .idProduct = (prod)
 323
 324 #define USB_VP(vend,prod)                       \
 325   USB_VENDOR(vend), USB_PRODUCT(prod)
 326
 327 #define USB_VPI(vend,prod,info)                 \
 328   USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
 329
 330 #define USB_DEV_BCD_GTEQ(lo)    /* greater than or equal */ \
 331   .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
 332
 333 #define USB_DEV_BCD_LTEQ(hi)    /* less than or equal */ \
 334   .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
 335
 336 #define USB_DEV_CLASS(dc)                       \
 337   .match_flag_dev_class = 1, .bDeviceClass = (dc)
 338
 339 #define USB_DEV_SUBCLASS(dsc)                   \
 340   .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
 341
 342 #define USB_DEV_PROTOCOL(dp)                    \
 343   .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
 344
 345 #define USB_IFACE_CLASS(ic)                     \
 346   .match_flag_int_class = 1, .bInterfaceClass = (ic)
 347
 348 #define USB_IFACE_SUBCLASS(isc)                 \
 349   .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
 350
 351 #define USB_IFACE_PROTOCOL(ip)                  \
 352   .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
 353
 354 #define USB_IF_CSI(class,subclass,info)                 \
 355   USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
 356
 357 #define USB_DRIVER_INFO(n)                      \
 358   .driver_info = (n)
 359
 360 #define USB_GET_DRIVER_INFO(did)                \
 361   (did)->driver_info
 362
 363 /*
 364  * The following structure keeps information that is used to match
 365  * against an array of "usb_device_id" elements.
 366  */
 367 struct usbd_lookup_info {
 368         uint16_t idVendor;
 369         uint16_t idProduct;
 370         uint16_t bcdDevice;
 371         uint8_t bDeviceClass;
 372         uint8_t bDeviceSubClass;
 373         uint8_t bDeviceProtocol;
 374         uint8_t bInterfaceClass;
 375         uint8_t bInterfaceSubClass;
 376         uint8_t bInterfaceProtocol;
 377         uint8_t bIfaceIndex;
 378         uint8_t bIfaceNum;
 379         uint8_t bConfigIndex;
 380         uint8_t bConfigNum;
 381 };
 382
 383 /* Structure used by probe and attach */
 384
 385 struct usb_attach_arg {
 386         struct usbd_lookup_info info;
 387         device_t temp_dev;              /* for internal use */
 388         unsigned long driver_info;      /* for internal use */
 389         void *driver_ivar;
 390         struct usb_device *device;      /* current device */
 391         struct usb_interface *iface;    /* current interface */
 392         enum usb_hc_mode usb_mode;      /* host or device mode */
 393         uint8_t port;
 394         uint8_t dev_state;
 395 #define UAA_DEV_READY           0
 396 #define UAA_DEV_DISABLED        1
 397 #define UAA_DEV_EJECTING        2
 398 };
 399
 400 /*
 401  * The following is a wrapper for the callout structure to ease
 402  * porting the code to other platforms.
 403  */
 404 struct usb_callout {
 405         struct callout co;
 406         struct lock *uco_lock;
 407         void (*uco_func)(void *);
 408         void *uco_arg;
 409         int uco_flags;
 410 };
 411
 412 void usb_callout_timeout_wrapper(void *arg);
 413 void usb_callout_init_mtx_dfly(struct usb_callout *uco, struct lock *lock,
 414          int flags);
 415 void usb_callout_reset_dfly(struct usb_callout *uco, int ticks,
 416          timeout_t *func, void *arg);
 417
 418 #define usb_callout_init_mtx(c,m,f) usb_callout_init_mtx_dfly(c, m, f)
 419 #define usb_callout_reset(c,t,f,d) usb_callout_reset_dfly(c, t, f, d)
 420 #define usb_callout_stop(c) callout_stop(&(c)->co)
 421 #define usb_callout_drain(c) callout_stop_sync(&(c)->co)
 422 #define usb_callout_pending(c) callout_pending(&(c)->co)
 423
 424 /* USB transfer states */
 425
 426 #define USB_ST_SETUP       0
 427 #define USB_ST_TRANSFERRED 1
 428 #define USB_ST_ERROR       2
 429
 430 /* USB handle request states */
 431 #define USB_HR_NOT_COMPLETE     0
 432 #define USB_HR_COMPLETE_OK      1
 433 #define USB_HR_COMPLETE_ERR     2
 434
 435 /*
 436  * The following macro will return the current state of an USB
 437  * transfer like defined by the "USB_ST_XXX" enums.
 438  */
 439 #define USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
 440
 441 /*
 442  * The following structure defines the USB process message header.
 443  */
 444 struct usb_proc_msg {
 445         TAILQ_ENTRY(usb_proc_msg) pm_qentry;
 446         usb_proc_callback_t *pm_callback;
 447         usb_size_t pm_num;
 448 };
 449
 450 #define USB_FIFO_TX 0
 451 #define USB_FIFO_RX 1
 452
 453 /*
 454  * Locking note for the following functions.  All the
 455  * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
 456  * locked. The others are called unlocked.
 457  */
 458 struct usb_fifo_methods {
 459         usb_fifo_open_t *f_open;
 460         usb_fifo_close_t *f_close;
 461         usb_fifo_ioctl_t *f_ioctl;
 462         /*
 463          * NOTE: The post-ioctl callback is called after the USB reference
 464          * gets locked in the IOCTL handler:
 465          */
 466         usb_fifo_ioctl_t *f_ioctl_post;
 467         usb_fifo_cmd_t *f_start_read;
 468         usb_fifo_cmd_t *f_stop_read;
 469         usb_fifo_cmd_t *f_start_write;
 470         usb_fifo_cmd_t *f_stop_write;
 471         usb_fifo_filter_t *f_filter_read;
 472         usb_fifo_filter_t *f_filter_write;
 473         const char *basename[4];
 474         const char *postfix[4];
 475 };
 476
 477 struct usb_fifo_sc {
 478         struct usb_fifo *fp[2];
 479         struct usb_fs_privdata *dev;
 480 };
 481
 482 const char *usbd_errstr(usb_error_t error);
 483 void *usbd_find_descriptor(struct usb_device *udev, void *id,
 484     uint8_t iface_index, uint8_t type, uint8_t type_mask,
 485     uint8_t subtype, uint8_t subtype_mask);
 486 struct usb_config_descriptor *usbd_get_config_descriptor(
 487         struct usb_device *udev);
 488 struct usb_device_descriptor *usbd_get_device_descriptor(
 489         struct usb_device *udev);
 490 struct usb_interface *usbd_get_iface(struct usb_device *udev,
 491     uint8_t iface_index);
 492 struct usb_interface_descriptor *usbd_get_interface_descriptor(
 493         struct usb_interface *iface);
 494 struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
 495     const struct usb_config *setup);
 496 struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
 497 usb_error_t     usbd_interface_count(struct usb_device *udev, uint8_t *count);
 498 enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
 499 enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
 500 void device_set_usb_desc(device_t dev);
 501 void usb_pause_mtx(struct lock *lock, int _ticks);
 502 void usb_pause_ls(struct lock *lock, struct lwkt_serialize *slz, int _ticks);
 503 usb_error_t usbd_set_pnpinfo(struct usb_device *udev,
 504     uint8_t iface_index, const char *pnpinfo);
 505 usb_error_t usbd_add_dynamic_quirk(struct usb_device *udev,
 506     uint16_t quirk);
 507 usb_error_t usbd_set_endpoint_mode(struct usb_device *udev,
 508     struct usb_endpoint *ep, uint8_t ep_mode);
 509 uint8_t usbd_get_endpoint_mode(struct usb_device *udev,
 510                         struct usb_endpoint *ep);
 511
 512 const struct usb_device_id *usbd_lookup_id_by_info(
 513             const struct usb_device_id *id, usb_size_t sizeof_id,
 514             const struct usbd_lookup_info *info);
 515 int     usbd_lookup_id_by_uaa(const struct usb_device_id *id,
 516             usb_size_t sizeof_id, struct usb_attach_arg *uaa);
 517
 518 usb_error_t usbd_do_request_flags(struct usb_device *udev, struct lock *lock,
 519                     struct usb_device_request *req, void *data, uint16_t flags,
 520                     uint16_t *actlen, usb_timeout_t timeout);
 521 #define usbd_do_request(u,m,r,d) \
 522   usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
 523
 524 uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1,
 525             struct usb_xfer *xfer2);
 526 uint8_t usbd_get_interface_altindex(struct usb_interface *iface);
 527 usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
 528             uint8_t iface_index, uint8_t alt_index);
 529 uint32_t usbd_get_isoc_fps(struct usb_device *udev);
 530 usb_error_t usbd_transfer_setup(struct usb_device *udev,
 531             const uint8_t *ifaces, struct usb_xfer **pxfer,
 532             const struct usb_config *setup_start, uint16_t n_setup,
 533             void *priv_sc, struct lock *priv_lock);
 534 void    usbd_transfer_submit(struct usb_xfer *xfer);
 535 void    usbd_transfer_clear_stall(struct usb_xfer *xfer);
 536 void    usbd_transfer_drain(struct usb_xfer *xfer);
 537 uint8_t usbd_transfer_pending(struct usb_xfer *xfer);
 538 void    usbd_transfer_start(struct usb_xfer *xfer);
 539 void    usbd_transfer_stop(struct usb_xfer *xfer);
 540 void    usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
 541 void    usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
 542 void    usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
 543             uint8_t parent_index);
 544 uint8_t usbd_get_bus_index(struct usb_device *udev);
 545 uint8_t usbd_get_device_index(struct usb_device *udev);
 546 void    usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
 547 uint8_t usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode);
 548 uint8_t usbd_device_attached(struct usb_device *udev);
 549
 550 usb_frlength_t
 551         usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex);
 552 void    usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
 553             int *aframes, int *nframes);
 554 struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *, usb_frcount_t);
 555 void    *usbd_xfer_get_frame_buffer(struct usb_xfer *, usb_frcount_t);
 556 void    *usbd_xfer_softc(struct usb_xfer *xfer);
 557 void    *usbd_xfer_get_priv(struct usb_xfer *xfer);
 558 void    usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
 559 void    usbd_xfer_set_interval(struct usb_xfer *xfer, int);
 560 uint8_t usbd_xfer_state(struct usb_xfer *xfer);
 561 void    usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
 562             void *ptr, usb_frlength_t len);
 563 void    usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
 564             void **ptr, int *len);
 565 void    usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
 566             usb_frcount_t frindex);
 567 usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
 568 usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
 569 usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
 570 uint8_t usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
 571 usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
 572             usb_frcount_t frindex);
 573 void    usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
 574             usb_frlength_t len);
 575 void    usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
 576 void    usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
 577 void    usbd_xfer_set_stall(struct usb_xfer *xfer);
 578 int     usbd_xfer_is_stalled(struct usb_xfer *xfer);
 579 void    usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
 580 void    usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
 581 uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
 582
 583 void    usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
 584             const void *ptr, usb_frlength_t len);
 585 int     usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
 586             const void *ptr, usb_frlength_t len);
 587 void    usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
 588             void *ptr, usb_frlength_t len);
 589 int     usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
 590             void *ptr, usb_frlength_t len);
 591 void    usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
 592             struct usb_page_search *res);
 593 void    usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
 594             struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
 595 void    usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
 596             usb_frlength_t len);
 597 void    usbd_start_re_enumerate(struct usb_device *udev);
 598
 599 int     usb_fifo_attach(struct usb_device *udev, void *priv_sc,
 600             struct lock *priv_lock, struct usb_fifo_methods *pm,
 601             struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
 602             uint8_t iface_index, uid_t uid, gid_t gid, int mode);
 603 void    usb_fifo_detach(struct usb_fifo_sc *f_sc);
 604 int     usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
 605             uint16_t nbuf);
 606 void    usb_fifo_free_buffer(struct usb_fifo *f);
 607 uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
 608 void    usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
 609             usb_frlength_t offset, usb_frlength_t len, uint8_t what);
 610 void    usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
 611             usb_size_t len, uint8_t what);
 612 uint8_t usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
 613 void    usb_fifo_put_data_error(struct usb_fifo *fifo);
 614 uint8_t usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
 615             usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
 616             uint8_t what);
 617 uint8_t usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
 618             usb_size_t len, usb_size_t *actlen, uint8_t what);
 619 uint8_t usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
 620             usb_size_t *plen);
 621 void    usb_fifo_reset(struct usb_fifo *f);
 622 void    usb_fifo_wakeup(struct usb_fifo *f);
 623 void    usb_fifo_get_data_error(struct usb_fifo *fifo);
 624 void    *usb_fifo_softc(struct usb_fifo *fifo);
 625 void    usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
 626 void    usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
 627 void    usb_fifo_free(struct usb_fifo *f);
 628 #endif /* _KERNEL */
 629 #endif /* _USB_USBDI_H_ */