1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2008 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 /* 28 * Including this file is mandatory for all USB related c-files in the kernel. 29 */ 30 31 #ifndef _USB2_CORE_H_ 32 #define _USB2_CORE_H_ 33 34 #define USB_STACK_VERSION 2000 /* 2.0 */ 35 36 /* Allow defines in "opt_usb.h" to override configuration */ 37 38 #include "opt_usb.h" 39 #include "opt_bus.h" 40 41 /* Default USB configuration */ 42 43 /* 44 * The following macro defines if the code shall use cv_xxx() instead 45 * of msleep() and wakeup(). 46 */ 47 #ifndef USB_HAVE_CONDVAR 48 #define USB_HAVE_CONDVAR 0 49 #endif 50 51 /* 52 * The following macro defines if the code shall support 53 * /dev/usb/x.y.z. 54 */ 55 #ifndef USB_HAVE_UGEN 56 #define USB_HAVE_UGEN 1 57 #endif 58 59 /* 60 * The following macro defines if the code shall support BUS-DMA. 61 */ 62 #ifndef USB_HAVE_BUSDMA 63 #define USB_HAVE_BUSDMA 1 64 #endif 65 66 /* 67 * The following macro defines if the code shall support the Linux 68 * compatibility layer. 69 */ 70 #ifndef USB_HAVE_COMPAT_LINUX 71 #define USB_HAVE_COMPAT_LINUX 1 72 #endif 73 74 /* 75 * The following macro defines if the code shall support 76 * userland data transfer via copyin() and copyout() 77 */ 78 #ifndef USB_HAVE_USER_IO 79 #define USB_HAVE_USER_IO 1 80 #endif 81 82 /* 83 * The following macro defines if the code shall support copy in via 84 * bsd-mbufs to USB. 85 */ 86 #ifndef USB_HAVE_MBUF 87 #define USB_HAVE_MBUF 1 88 #endif 89 90 /* 91 * The following macro defines if the code shall compile a table 92 * describing USB vendor and product IDs. 93 */ 94 #ifndef USB_VERBOSE 95 #define USB_VERBOSE 1 96 #endif 97 98 /* 99 * The following macro defines if USB debugging support shall be 100 * compiled for the USB core and all drivers. 101 */ 102 #ifndef USB_DEBUG 103 #define USB_DEBUG 1 104 #endif 105 106 /* 107 * The following macro defines if USB transaction translator support 108 * shall be supported for the USB HUB and USB controller drivers. 109 */ 110 #ifndef USB_HAVE_TT_SUPPORT 111 #define USB_HAVE_TT_SUPPORT 1 112 #endif 113 114 /* 115 * The following macro defines if the USB power daemon shall 116 * be supported in the USB core. 117 */ 118 #ifndef USB_HAVE_POWERD 119 #define USB_HAVE_POWERD 1 120 #endif 121 122 /* 123 * The following macro defines if the USB autoinstall detection shall 124 * be supported in the USB core. 125 */ 126 #ifndef USB_HAVE_MSCTEST 127 #define USB_HAVE_MSCTEST 1 128 #endif 129 130 #ifndef USB_TD_GET_PROC 131 #define USB_TD_GET_PROC(td) (td)->td_proc 132 #endif 133 134 #ifndef USB_PROC_GET_GID 135 #define USB_PROC_GET_GID(td) (td)->p_pgid 136 #endif 137 138 /* Include files */ 139 140 #include <sys/stdint.h> 141 #include <sys/stddef.h> 142 #include <sys/param.h> 143 #include <sys/queue.h> 144 #include <sys/types.h> 145 #include <sys/systm.h> 146 #include <sys/kernel.h> 147 #include <sys/bus.h> 148 #include <sys/linker_set.h> 149 #include <sys/module.h> 150 #include <sys/lock.h> 151 #include <sys/mutex.h> 152 #include <sys/condvar.h> 153 #include <sys/sysctl.h> 154 #include <sys/sx.h> 155 #include <sys/unistd.h> 156 #include <sys/callout.h> 157 #include <sys/malloc.h> 158 #include <sys/priv.h> 159 160 #include <dev/usb/usb_defs.h> 161 #include <dev/usb/usb_revision.h> 162 163 #include "usb_if.h" 164 165 #ifndef USB_HOST_ALIGN 166 #define USB_HOST_ALIGN 8 /* bytes, must be power of two */ 167 #endif 168 169 #ifndef USB_FS_ISOC_UFRAME_MAX 170 #define USB_FS_ISOC_UFRAME_MAX 4 /* exclusive unit */ 171 #endif 172 173 #if (USB_FS_ISOC_UFRAME_MAX > 6) 174 #error "USB_FS_ISOC_UFRAME_MAX cannot be set higher than 6" 175 #endif 176 177 #ifndef USB_BUS_MAX 178 #define USB_BUS_MAX 256 /* units */ 179 #endif 180 181 #ifndef USB_MAX_DEVICES 182 #define USB_MAX_DEVICES 128 /* units */ 183 #endif 184 185 #if (USB_MAX_DEVICES < USB_MIN_DEVICES) 186 #error "Minimum number of devices is greater than maximum number of devices." 187 #endif 188 189 #ifndef USB_IFACE_MAX 190 #define USB_IFACE_MAX 32 /* units */ 191 #endif 192 193 #ifndef USB_FIFO_MAX 194 #define USB_FIFO_MAX 128 /* units */ 195 #endif 196 197 #if (USB_FIFO_MAX & 1) 198 #error "Number of FIFOs must be odd." 199 #endif 200 201 #define USB_MAX_FS_ISOC_FRAMES_PER_XFER (120) /* units */ 202 #define USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120) /* units */ 203 204 #ifndef USB_HUB_MAX_DEPTH 205 #define USB_HUB_MAX_DEPTH 5 206 #endif 207 208 #ifndef USB_EP0_BUFSIZE 209 #define USB_EP0_BUFSIZE 1024 /* bytes */ 210 #endif 211 212 /* USB transfer states */ 213 214 #define USB_ST_SETUP 0 215 #define USB_ST_TRANSFERRED 1 216 #define USB_ST_ERROR 2 217 218 /* USB handle request states */ 219 #define USB_HR_NOT_COMPLETE 0 220 #define USB_HR_COMPLETE_OK 1 221 #define USB_HR_COMPLETE_ERR 2 222 223 /* 224 * The following macro will return the current state of an USB 225 * transfer like defined by the "USB_ST_XXX" enums. 226 */ 227 #define USB_GET_STATE(xfer) ((xfer)->usb2_state) 228 229 /* 230 * The following macro will tell if an USB transfer is currently 231 * receiving or transferring data. 232 */ 233 #define USB_GET_DATA_ISREAD(xfer) ((xfer)->flags_int.usb_mode == \ 234 USB_MODE_DEVICE ? (((xfer)->endpointno & UE_DIR_IN) ? 0 : 1) : \ 235 (((xfer)->endpointno & UE_DIR_IN) ? 1 : 0)) 236 237 /* 238 * The following macros are used used to convert milliseconds into 239 * HZ. We use 1024 instead of 1000 milliseconds per second to save a 240 * full division. 241 */ 242 #define USB_MS_HZ 1024 243 244 #define USB_MS_TO_TICKS(ms) \ 245 (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ) 246 247 /* macros */ 248 249 #define usb2_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f) 250 #define usb2_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d) 251 #define usb2_callout_stop(c) callout_stop(&(c)->co) 252 #define usb2_callout_drain(c) callout_drain(&(c)->co) 253 #define usb2_callout_pending(c) callout_pending(&(c)->co) 254 255 #define USB_BUS_LOCK(_b) mtx_lock(&(_b)->bus_mtx) 256 #define USB_BUS_UNLOCK(_b) mtx_unlock(&(_b)->bus_mtx) 257 #define USB_BUS_LOCK_ASSERT(_b, _t) mtx_assert(&(_b)->bus_mtx, _t) 258 #define USB_XFER_LOCK(_x) mtx_lock((_x)->xroot->xfer_mtx) 259 #define USB_XFER_UNLOCK(_x) mtx_unlock((_x)->xroot->xfer_mtx) 260 #define USB_XFER_LOCK_ASSERT(_x, _t) mtx_assert((_x)->xroot->xfer_mtx, _t) 261 /* structure prototypes */ 262 263 struct file; 264 struct usb_bus; 265 struct usb_device; 266 struct usb_device_request; 267 struct usb_page; 268 struct usb_page_cache; 269 struct usb_xfer; 270 struct usb_xfer_root; 271 272 /* typedefs */ 273 274 typedef void (usb_callback_t)(struct usb_xfer *); 275 276 #ifndef USB_HAVE_USB_ERROR_T 277 typedef uint8_t usb_error_t; /* see "USB_ERR_XXX" */ 278 #endif 279 280 #ifndef USB_HAVE_TIMEOUT_T 281 typedef uint32_t usb_timeout_t; /* milliseconds */ 282 #endif 283 284 #ifndef USB_HAVE_FRLENGTH_T 285 typedef uint32_t usb_frlength_t; /* bytes */ 286 #endif 287 288 #ifndef USB_HAVE_FRCOUNT_T 289 typedef uint32_t usb_frcount_t; /* units */ 290 #endif 291 292 #ifndef USB_HAVE_SIZE_T 293 typedef uint32_t usb_size_t; /* bytes */ 294 #endif 295 296 #ifndef USB_HAVE_TICKS_T 297 typedef uint32_t usb_ticks_t; /* system defined */ 298 #endif 299 300 #ifndef USB_HAVE_POWER_MASK_T 301 typedef uint16_t usb_power_mask_t; /* see "USB_HW_POWER_XXX" */ 302 #endif 303 304 typedef usb_error_t (usb_handle_req_t)(struct usb_device *, 305 struct usb_device_request *, const void **, uint16_t *); 306 307 /* structures */ 308 309 /* 310 * Common queue structure for USB transfers. 311 */ 312 struct usb_xfer_queue { 313 TAILQ_HEAD(, usb_xfer) head; 314 struct usb_xfer *curr; /* current USB transfer processed */ 315 void (*command) (struct usb_xfer_queue *pq); 316 uint8_t recurse_1:1; 317 uint8_t recurse_2:1; 318 }; 319 320 /* 321 * The following is a wrapper for the callout structure to ease 322 * porting the code to other platforms. 323 */ 324 struct usb_callout { 325 struct callout co; 326 }; 327 328 /* 329 * The following structure defines a set of USB transfer flags. 330 */ 331 struct usb_xfer_flags { 332 uint8_t force_short_xfer:1; /* force a short transmit transfer 333 * last */ 334 uint8_t short_xfer_ok:1; /* allow short receive transfers */ 335 uint8_t short_frames_ok:1; /* allow short frames */ 336 uint8_t pipe_bof:1; /* block pipe on failure */ 337 uint8_t proxy_buffer:1; /* makes buffer size a factor of 338 * "max_frame_size" */ 339 uint8_t ext_buffer:1; /* uses external DMA buffer */ 340 uint8_t manual_status:1; /* non automatic status stage on 341 * control transfers */ 342 uint8_t no_pipe_ok:1; /* set if "USB_ERR_NO_PIPE" error can 343 * be ignored */ 344 uint8_t stall_pipe:1; /* set if the endpoint belonging to 345 * this USB transfer should be stalled 346 * before starting this transfer! */ 347 }; 348 349 /* 350 * The following structure defines a set of internal USB transfer 351 * flags. 352 */ 353 struct usb_xfer_flags_int { 354 355 enum usb_hc_mode usb_mode; /* shadow copy of "udev->usb_mode" */ 356 uint16_t control_rem; /* remainder in bytes */ 357 358 uint8_t open:1; /* set if USB pipe has been opened */ 359 uint8_t transferring:1; /* set if an USB transfer is in 360 * progress */ 361 uint8_t did_dma_delay:1; /* set if we waited for HW DMA */ 362 uint8_t did_close:1; /* set if we closed the USB transfer */ 363 uint8_t draining:1; /* set if we are draining an USB 364 * transfer */ 365 uint8_t started:1; /* keeps track of started or stopped */ 366 uint8_t bandwidth_reclaimed:1; 367 uint8_t control_xfr:1; /* set if control transfer */ 368 uint8_t control_hdr:1; /* set if control header should be 369 * sent */ 370 uint8_t control_act:1; /* set if control transfer is active */ 371 uint8_t control_stall:1; /* set if control transfer should be stalled */ 372 373 uint8_t short_frames_ok:1; /* filtered version */ 374 uint8_t short_xfer_ok:1; /* filtered version */ 375 #if USB_HAVE_BUSDMA 376 uint8_t bdma_enable:1; /* filtered version (only set if 377 * hardware supports DMA) */ 378 uint8_t bdma_no_post_sync:1; /* set if the USB callback wrapper 379 * should not do the BUS-DMA post sync 380 * operation */ 381 uint8_t bdma_setup:1; /* set if BUS-DMA has been setup */ 382 #endif 383 uint8_t isochronous_xfr:1; /* set if isochronous transfer */ 384 uint8_t curr_dma_set:1; /* used by USB HC/DC driver */ 385 uint8_t can_cancel_immed:1; /* set if USB transfer can be 386 * cancelled immediately */ 387 }; 388 389 /* 390 * The following structure define an USB configuration, that basically 391 * is used when setting up an USB transfer. 392 */ 393 struct usb_config { 394 usb_callback_t *callback; /* USB transfer callback */ 395 usb_frlength_t bufsize; /* total pipe buffer size in bytes */ 396 usb_frcount_t frames; /* maximum number of USB frames */ 397 usb_timeout_t interval; /* interval in milliseconds */ 398 #define USB_DEFAULT_INTERVAL 0 399 usb_timeout_t timeout; /* transfer timeout in milliseconds */ 400 struct usb_xfer_flags flags; /* transfer flags */ 401 enum usb_hc_mode usb_mode; /* host or device mode */ 402 uint8_t type; /* pipe type */ 403 uint8_t endpoint; /* pipe number */ 404 uint8_t direction; /* pipe direction */ 405 uint8_t ep_index; /* pipe index match to use */ 406 uint8_t if_index; /* "ifaces" index to use */ 407 }; 408 409 /* 410 * The following structure defines an USB transfer. 411 */ 412 struct usb_xfer { 413 struct usb_callout timeout_handle; 414 TAILQ_ENTRY(usb_xfer) wait_entry; /* used at various places */ 415 416 struct usb_page_cache *buf_fixup; /* fixup buffer(s) */ 417 struct usb_xfer_queue *wait_queue; /* pointer to queue that we 418 * are waiting on */ 419 struct usb_page *dma_page_ptr; 420 struct usb_endpoint *endpoint; /* our USB endpoint */ 421 struct usb_xfer_root *xroot; /* used by HC driver */ 422 void *qh_start[2]; /* used by HC driver */ 423 void *td_start[2]; /* used by HC driver */ 424 void *td_transfer_first; /* used by HC driver */ 425 void *td_transfer_last; /* used by HC driver */ 426 void *td_transfer_cache; /* used by HC driver */ 427 void *priv_sc; /* device driver data pointer 1 */ 428 void *priv_fifo; /* device driver data pointer 2 */ 429 void *local_buffer; 430 usb_frlength_t *frlengths; 431 struct usb_page_cache *frbuffers; 432 usb_callback_t *callback; 433 434 usb_frlength_t max_hc_frame_size; 435 usb_frlength_t max_data_length; 436 usb_frlength_t sumlen; /* sum of all lengths in bytes */ 437 usb_frlength_t actlen; /* actual length in bytes */ 438 usb_timeout_t timeout; /* milliseconds */ 439 #define USB_NO_TIMEOUT 0 440 #define USB_DEFAULT_TIMEOUT 5000 /* 5000 ms = 5 seconds */ 441 442 usb_frcount_t max_frame_count; /* initial value of "nframes" after 443 * setup */ 444 usb_frcount_t nframes; /* number of USB frames to transfer */ 445 usb_frcount_t aframes; /* actual number of USB frames 446 * transferred */ 447 448 uint16_t max_packet_size; 449 uint16_t max_frame_size; 450 uint16_t qh_pos; 451 uint16_t isoc_time_complete; /* in ms */ 452 usb_timeout_t interval; /* milliseconds */ 453 454 uint8_t address; /* physical USB address */ 455 uint8_t endpointno; /* physical USB endpoint */ 456 uint8_t max_packet_count; 457 uint8_t usb2_smask; 458 uint8_t usb2_cmask; 459 uint8_t usb2_uframe; 460 uint8_t usb2_state; 461 462 usb_error_t error; 463 464 struct usb_xfer_flags flags; 465 struct usb_xfer_flags_int flags_int; 466 }; 467 468 /* 469 * The following structure keeps information that is used to match 470 * against an array of "usb_device_id" elements. 471 */ 472 struct usb_lookup_info { 473 uint16_t idVendor; 474 uint16_t idProduct; 475 uint16_t bcdDevice; 476 uint8_t bDeviceClass; 477 uint8_t bDeviceSubClass; 478 uint8_t bDeviceProtocol; 479 uint8_t bInterfaceClass; 480 uint8_t bInterfaceSubClass; 481 uint8_t bInterfaceProtocol; 482 uint8_t bIfaceIndex; 483 uint8_t bIfaceNum; 484 uint8_t bConfigIndex; 485 uint8_t bConfigNum; 486 }; 487 488 /* Structure used by probe and attach */ 489 490 struct usb_attach_arg { 491 struct usb_lookup_info info; 492 device_t temp_dev; /* for internal use */ 493 unsigned long driver_info; /* for internal use */ 494 void *driver_ivar; 495 struct usb_device *device; /* current device */ 496 struct usb_interface *iface; /* current interface */ 497 enum usb_hc_mode usb_mode; /* host or device mode */ 498 uint8_t port; 499 uint8_t use_generic; /* hint for generic drivers */ 500 }; 501 502 /* external variables */ 503 504 MALLOC_DECLARE(M_USB); 505 MALLOC_DECLARE(M_USBDEV); 506 MALLOC_DECLARE(M_USBHC); 507 508 extern struct mtx usb2_ref_lock; 509 510 /* prototypes */ 511 512 const char *usb2_errstr(usb_error_t error); 513 const char *usb2_statestr(enum usb_dev_state state); 514 struct usb_config_descriptor *usb2_get_config_descriptor( 515 struct usb_device *udev); 516 struct usb_device_descriptor *usb2_get_device_descriptor( 517 struct usb_device *udev); 518 struct usb_interface *usb2_get_iface(struct usb_device *udev, 519 uint8_t iface_index); 520 struct usb_interface_descriptor *usb2_get_interface_descriptor( 521 struct usb_interface *iface); 522 uint8_t usb2_clear_stall_callback(struct usb_xfer *xfer1, 523 struct usb_xfer *xfer2); 524 uint8_t usb2_get_interface_altindex(struct usb_interface *iface); 525 usb_error_t usb2_set_alt_interface_index(struct usb_device *udev, 526 uint8_t iface_index, uint8_t alt_index); 527 enum usb_hc_mode usb2_get_mode(struct usb_device *udev); 528 enum usb_dev_speed usb2_get_speed(struct usb_device *udev); 529 uint32_t usb2_get_isoc_fps(struct usb_device *udev); 530 usb_error_t usb2_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 mtx *priv_mtx); 534 void usb2_set_frame_data(struct usb_xfer *xfer, void *ptr, 535 usb_frcount_t frindex); 536 void usb2_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset, 537 usb_frcount_t frindex); 538 void usb2_start_hardware(struct usb_xfer *xfer); 539 void usb2_transfer_clear_stall(struct usb_xfer *xfer); 540 void usb2_transfer_drain(struct usb_xfer *xfer); 541 void usb2_transfer_set_stall(struct usb_xfer *xfer); 542 uint8_t usb2_transfer_pending(struct usb_xfer *xfer); 543 void usb2_transfer_start(struct usb_xfer *xfer); 544 void usb2_transfer_stop(struct usb_xfer *xfer); 545 void usb2_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup); 546 void usb2_set_parent_iface(struct usb_device *udev, uint8_t iface_index, 547 uint8_t parent_index); 548 uint8_t usb2_get_bus_index(struct usb_device *udev); 549 uint8_t usb2_get_device_index(struct usb_device *udev); 550 void usb2_set_power_mode(struct usb_device *udev, uint8_t power_mode); 551 uint8_t usb2_device_attached(struct usb_device *udev); 552 553 #endif /* _USB2_CORE_H_ */ 554