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