usb_core.h revision 188411
1/* $FreeBSD: head/sys/dev/usb2/core/usb2_core.h 188411 2009-02-09 21:56:33Z thompsa $ */ 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 29 * kernel. 30 */ 31 32#ifndef _USB2_CORE_H_ 33#define _USB2_CORE_H_ 34 35/* Default USB configuration */ 36 37#ifndef USB_NO_POLL 38#define USB_NO_POLL 0 39#endif 40 41#ifndef USB_USE_CONDVAR 42#define USB_USE_CONDVAR 0 43#endif 44 45#ifndef USB_TD_GET_PROC 46#define USB_TD_GET_PROC(td) (td)->td_proc 47#endif 48 49#ifndef USB_PROC_GET_GID 50#define USB_PROC_GET_GID(td) (td)->p_pgid 51#endif 52 53#ifndef USB_VNOPS_FO_CLOSE 54#define USB_VNOPS_FO_CLOSE(fp, td, perr) do { \ 55 (td)->td_fpop = (fp); \ 56 *(perr) = vnops.fo_close(fp, td); \ 57 (td)->td_fpop = NULL; \ 58} while (0) 59#endif 60 61#ifndef USB_VNOPS_FO_STAT 62#define USB_VNOPS_FO_STAT(fp, sb, cred, td) \ 63 vnops.fo_stat(fp, sb, cred, td) 64#endif 65 66#ifndef USB_VNOPS_FO_TRUNCATE 67#define USB_VNOPS_FO_TRUNCATE(fp, length, cred, td) \ 68 vnops.fo_truncate(fp, length, cred, td) 69#endif 70 71/* Include files */ 72 73#include <sys/stdint.h> 74#include <sys/stddef.h> 75#include <sys/param.h> 76#include <sys/queue.h> 77#include <sys/types.h> 78#include <sys/systm.h> 79#include <sys/kernel.h> 80#include <sys/bus.h> 81#include <sys/linker_set.h> 82#include <sys/module.h> 83#include <sys/lock.h> 84#include <sys/mutex.h> 85#include <sys/condvar.h> 86#include <sys/sysctl.h> 87#include <sys/sx.h> 88#include <sys/unistd.h> 89#include <sys/callout.h> 90#include <sys/malloc.h> 91#include <sys/priv.h> 92 93#include <dev/usb2/include/usb2_mfunc.h> 94#include <dev/usb2/include/usb2_revision.h> 95 96#include "usb2_if.h" 97#include "opt_usb.h" 98#include "opt_bus.h" 99 100#define USB_STACK_VERSION 2000 /* 2.0 */ 101 102#define USB_HOST_ALIGN 8 /* bytes, must be power of two */ 103 104#define USB_ISOC_TIME_MAX 128 /* ms */ 105#define USB_FS_ISOC_UFRAME_MAX 4 /* exclusive unit */ 106 107#if (USB_FS_ISOC_UFRAME_MAX > 6) 108#error "USB_FS_ISOC_UFRAME_MAX cannot be set higher than 6" 109#endif 110 111#define USB_MAX_FS_ISOC_FRAMES_PER_XFER (120) /* units */ 112#define USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120) /* units */ 113 114#define USB_MAX_IPACKET 8 /* maximum size of the initial USB 115 * data packet */ 116#ifndef USB_VERBOSE 117#define USB_VERBOSE 1 118#endif 119 120#define USB_HUB_MAX_DEPTH 5 121 122/* USB transfer states */ 123 124#define USB_ST_SETUP 0 125#define USB_ST_TRANSFERRED 1 126#define USB_ST_ERROR 2 127 128/* 129 * The following macro will return the current state of an USB 130 * transfer like defined by the "USB_ST_XXX" enums. 131 */ 132#define USB_GET_STATE(xfer) ((xfer)->usb2_state) 133 134/* 135 * The following macro will tell if an USB transfer is currently 136 * receiving or transferring data. 137 */ 138#define USB_GET_DATA_ISREAD(xfer) (((xfer)->flags_int.usb2_mode == \ 139 USB_MODE_DEVICE) ? ((xfer->endpoint & UE_DIR_IN) ? 0 : 1) : \ 140 ((xfer->endpoint & UE_DIR_IN) ? 1 : 0)) 141 142/* 143 * The following macros are used used to convert milliseconds into 144 * HZ. We use 1024 instead of 1000 milliseconds per second to save a 145 * full division. 146 */ 147#define USB_MS_HZ 1024 148 149#define USB_MS_TO_TICKS(ms) \ 150 (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ) 151 152/* macros */ 153 154#define usb2_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f) 155#define usb2_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d) 156#define usb2_callout_stop(c) callout_stop(&(c)->co) 157#define usb2_callout_drain(c) callout_drain(&(c)->co) 158#define usb2_callout_pending(c) callout_pending(&(c)->co) 159 160#define USB_BUS_LOCK(_b) mtx_lock(&(_b)->bus_mtx) 161#define USB_BUS_UNLOCK(_b) mtx_unlock(&(_b)->bus_mtx) 162#define USB_BUS_LOCK_ASSERT(_b, _t) mtx_assert(&(_b)->bus_mtx, _t) 163#define USB_XFER_LOCK(_x) mtx_lock((_x)->xroot->xfer_mtx) 164#define USB_XFER_UNLOCK(_x) mtx_unlock((_x)->xroot->xfer_mtx) 165#define USB_XFER_LOCK_ASSERT(_x, _t) mtx_assert((_x)->xroot->xfer_mtx, _t) 166/* structure prototypes */ 167 168struct file; 169struct usb2_bus; 170struct usb2_device; 171struct usb2_page; 172struct usb2_page_cache; 173struct usb2_xfer; 174struct usb2_xfer_root; 175 176/* typedefs */ 177 178typedef uint8_t usb2_error_t; 179 180typedef void (usb2_callback_t)(struct usb2_xfer *); 181 182/* structures */ 183 184/* 185 * This structure contains permissions. 186 */ 187 188struct usb2_perm { 189 uint32_t uid; 190 uint32_t gid; 191 uint16_t mode; 192}; 193 194/* 195 * Common queue structure for USB transfers. 196 */ 197struct usb2_xfer_queue { 198 TAILQ_HEAD(, usb2_xfer) head; 199 struct usb2_xfer *curr; /* current USB transfer processed */ 200 void (*command) (struct usb2_xfer_queue *pq); 201 uint8_t recurse_1:1; 202 uint8_t recurse_2:1; 203}; 204 205/* 206 * The following is a wrapper for the callout structure to ease 207 * porting the code to other platforms. 208 */ 209struct usb2_callout { 210 struct callout co; 211}; 212 213/* 214 * The following structure defines a set of USB transfer flags. 215 */ 216struct usb2_xfer_flags { 217 uint8_t force_short_xfer:1; /* force a short transmit transfer 218 * last */ 219 uint8_t short_xfer_ok:1; /* allow short receive transfers */ 220 uint8_t short_frames_ok:1; /* allow short frames */ 221 uint8_t pipe_bof:1; /* block pipe on failure */ 222 uint8_t proxy_buffer:1; /* makes buffer size a factor of 223 * "max_frame_size" */ 224 uint8_t ext_buffer:1; /* uses external DMA buffer */ 225 uint8_t manual_status:1; /* non automatic status stage on 226 * control transfers */ 227 uint8_t no_pipe_ok:1; /* set if "USB_ERR_NO_PIPE" error can 228 * be ignored */ 229 uint8_t stall_pipe:1; /* set if the endpoint belonging to 230 * this USB transfer should be stalled 231 * before starting this transfer! */ 232}; 233 234/* 235 * The following structure defines a set of internal USB transfer 236 * flags. 237 */ 238struct usb2_xfer_flags_int { 239 uint16_t control_rem; /* remainder in bytes */ 240 241 uint8_t open:1; /* set if USB pipe has been opened */ 242 uint8_t transferring:1; /* set if an USB transfer is in 243 * progress */ 244 uint8_t did_dma_delay:1; /* set if we waited for HW DMA */ 245 uint8_t did_close:1; /* set if we closed the USB transfer */ 246 uint8_t draining:1; /* set if we are draining an USB 247 * transfer */ 248 uint8_t started:1; /* keeps track of started or stopped */ 249 uint8_t bandwidth_reclaimed:1; 250 uint8_t control_xfr:1; /* set if control transfer */ 251 uint8_t control_hdr:1; /* set if control header should be 252 * sent */ 253 uint8_t control_act:1; /* set if control transfer is active */ 254 255 uint8_t short_frames_ok:1; /* filtered version */ 256 uint8_t short_xfer_ok:1; /* filtered version */ 257 uint8_t bdma_enable:1; /* filtered version (only set if 258 * hardware supports DMA) */ 259 uint8_t bdma_no_post_sync:1; /* set if the USB callback wrapper 260 * should not do the BUS-DMA post sync 261 * operation */ 262 uint8_t bdma_setup:1; /* set if BUS-DMA has been setup */ 263 uint8_t isochronous_xfr:1; /* set if isochronous transfer */ 264 uint8_t usb2_mode:1; /* shadow copy of "udev->usb2_mode" */ 265 uint8_t curr_dma_set:1; /* used by USB HC/DC driver */ 266 uint8_t can_cancel_immed:1; /* set if USB transfer can be 267 * cancelled immediately */ 268}; 269 270/* 271 * The following structure defines the symmetric part of an USB config 272 * structure. 273 */ 274struct usb2_config_sub { 275 usb2_callback_t *callback; /* USB transfer callback */ 276 uint32_t bufsize; /* total pipe buffer size in bytes */ 277 uint32_t frames; /* maximum number of USB frames */ 278 uint16_t interval; /* interval in milliseconds */ 279#define USB_DEFAULT_INTERVAL 0 280 uint16_t timeout; /* transfer timeout in milliseconds */ 281 struct usb2_xfer_flags flags; /* transfer flags */ 282}; 283 284/* 285 * The following structure define an USB configuration, that basically 286 * is used when setting up an USB transfer. 287 */ 288struct usb2_config { 289 struct usb2_config_sub mh; /* parameters for USB_MODE_HOST */ 290 struct usb2_config_sub md; /* parameters for USB_MODE_DEVICE */ 291 uint8_t type; /* pipe type */ 292 uint8_t endpoint; /* pipe number */ 293 uint8_t direction; /* pipe direction */ 294 uint8_t ep_index; /* pipe index match to use */ 295 uint8_t if_index; /* "ifaces" index to use */ 296}; 297 298/* 299 * The following structure defines an USB transfer. 300 */ 301struct usb2_xfer { 302 struct usb2_callout timeout_handle; 303 TAILQ_ENTRY(usb2_xfer) wait_entry; /* used at various places */ 304 305 struct usb2_page_cache *buf_fixup; /* fixup buffer(s) */ 306 struct usb2_xfer_queue *wait_queue; /* pointer to queue that we 307 * are waiting on */ 308 struct usb2_page *dma_page_ptr; 309 struct usb2_pipe *pipe; /* our USB pipe */ 310 struct usb2_xfer_root *xroot; /* used by HC driver */ 311 void *qh_start[2]; /* used by HC driver */ 312 void *td_start[2]; /* used by HC driver */ 313 void *td_transfer_first; /* used by HC driver */ 314 void *td_transfer_last; /* used by HC driver */ 315 void *td_transfer_cache; /* used by HC driver */ 316 void *priv_sc; /* device driver data pointer 1 */ 317 void *priv_fifo; /* device driver data pointer 2 */ 318 void *local_buffer; 319 uint32_t *frlengths; 320 struct usb2_page_cache *frbuffers; 321 usb2_callback_t *callback; 322 323 uint32_t max_usb2_frame_size; 324 uint32_t max_data_length; 325 uint32_t sumlen; /* sum of all lengths in bytes */ 326 uint32_t actlen; /* actual length in bytes */ 327 uint32_t timeout; /* milliseconds */ 328#define USB_NO_TIMEOUT 0 329#define USB_DEFAULT_TIMEOUT 5000 /* 5000 ms = 5 seconds */ 330 331 uint32_t max_frame_count; /* initial value of "nframes" after 332 * setup */ 333 uint32_t nframes; /* number of USB frames to transfer */ 334 uint32_t aframes; /* actual number of USB frames 335 * transferred */ 336 337 uint16_t max_packet_size; 338 uint16_t max_frame_size; 339 uint16_t qh_pos; 340 uint16_t isoc_time_complete; /* in ms */ 341 uint16_t interval; /* milliseconds */ 342 343 uint8_t address; /* physical USB address */ 344 uint8_t endpoint; /* physical USB endpoint */ 345 uint8_t max_packet_count; 346 uint8_t usb2_smask; 347 uint8_t usb2_cmask; 348 uint8_t usb2_uframe; 349 uint8_t usb2_state; 350 351 usb2_error_t error; 352 353 struct usb2_xfer_flags flags; 354 struct usb2_xfer_flags_int flags_int; 355}; 356 357/* 358 * The following structure keeps information that is used to match 359 * against an array of "usb2_device_id" elements. 360 */ 361struct usb2_lookup_info { 362 uint16_t idVendor; 363 uint16_t idProduct; 364 uint16_t bcdDevice; 365 uint8_t bDeviceClass; 366 uint8_t bDeviceSubClass; 367 uint8_t bDeviceProtocol; 368 uint8_t bInterfaceClass; 369 uint8_t bInterfaceSubClass; 370 uint8_t bInterfaceProtocol; 371 uint8_t bIfaceIndex; 372 uint8_t bIfaceNum; 373 uint8_t bConfigIndex; 374 uint8_t bConfigNum; 375}; 376 377/* Structure used by probe and attach */ 378 379struct usb2_attach_arg { 380 struct usb2_lookup_info info; 381 device_t temp_dev; /* for internal use */ 382 const void *driver_info; /* for internal use */ 383 struct usb2_device *device; /* current device */ 384 struct usb2_interface *iface; /* current interface */ 385 uint8_t usb2_mode; /* see USB_MODE_XXX */ 386 uint8_t port; 387 uint8_t use_generic; /* hint for generic drivers */ 388}; 389 390/* Structure used when referring an USB device */ 391 392struct usb2_location { 393 struct usb2_bus *bus; 394 struct usb2_device *udev; 395 struct usb2_interface *iface; 396 struct usb2_fifo *rxfifo; 397 struct usb2_fifo *txfifo; 398 uint32_t devloc; /* original devloc */ 399 uint16_t bus_index; /* bus index */ 400 uint8_t dev_index; /* device index */ 401 uint8_t iface_index; /* interface index */ 402 uint8_t fifo_index; /* FIFO index */ 403 uint8_t is_read; /* set if location has read access */ 404 uint8_t is_write; /* set if location has write access */ 405 uint8_t is_uref; /* set if USB refcount decr. needed */ 406 uint8_t is_usbfs; /* set if USB-FS is active */ 407}; 408 409/* external variables */ 410 411MALLOC_DECLARE(M_USB); 412MALLOC_DECLARE(M_USBDEV); 413MALLOC_DECLARE(M_USBHC); 414 415extern struct mtx usb2_ref_lock; 416 417/* typedefs */ 418 419typedef struct malloc_type *usb2_malloc_type; 420 421/* prototypes */ 422 423const char *usb2_errstr(usb2_error_t error); 424struct usb2_config_descriptor *usb2_get_config_descriptor( 425 struct usb2_device *udev); 426struct usb2_device_descriptor *usb2_get_device_descriptor( 427 struct usb2_device *udev); 428struct usb2_interface *usb2_get_iface(struct usb2_device *udev, 429 uint8_t iface_index); 430struct usb2_interface_descriptor *usb2_get_interface_descriptor( 431 struct usb2_interface *iface); 432uint8_t usb2_clear_stall_callback(struct usb2_xfer *xfer1, 433 struct usb2_xfer *xfer2); 434uint8_t usb2_get_interface_altindex(struct usb2_interface *iface); 435usb2_error_t usb2_set_alt_interface_index(struct usb2_device *udev, 436 uint8_t iface_index, uint8_t alt_index); 437uint8_t usb2_get_mode(struct usb2_device *udev); 438uint8_t usb2_get_speed(struct usb2_device *udev); 439uint32_t usb2_get_isoc_fps(struct usb2_device *udev); 440usb2_error_t usb2_transfer_setup(struct usb2_device *udev, 441 const uint8_t *ifaces, struct usb2_xfer **pxfer, 442 const struct usb2_config *setup_start, uint16_t n_setup, 443 void *priv_sc, struct mtx *priv_mtx); 444void usb2_set_frame_data(struct usb2_xfer *xfer, void *ptr, 445 uint32_t frindex); 446void usb2_set_frame_offset(struct usb2_xfer *xfer, uint32_t offset, 447 uint32_t frindex); 448void usb2_start_hardware(struct usb2_xfer *xfer); 449void usb2_transfer_clear_stall(struct usb2_xfer *xfer); 450void usb2_transfer_drain(struct usb2_xfer *xfer); 451void usb2_transfer_set_stall(struct usb2_xfer *xfer); 452void usb2_transfer_start(struct usb2_xfer *xfer); 453void usb2_transfer_stop(struct usb2_xfer *xfer); 454void usb2_transfer_unsetup(struct usb2_xfer **pxfer, uint16_t n_setup); 455usb2_error_t usb2_ref_device(struct file *fp, struct usb2_location *ploc, 456 uint32_t devloc); 457void usb2_unref_device(struct usb2_location *ploc); 458void usb2_set_parent_iface(struct usb2_device *udev, uint8_t iface_index, 459 uint8_t parent_index); 460void usb2_set_iface_perm(struct usb2_device *udev, uint8_t iface_index, 461 uint32_t uid, uint32_t gid, uint16_t mode); 462uint8_t usb2_get_bus_index(struct usb2_device *udev); 463uint8_t usb2_get_device_index(struct usb2_device *udev); 464void usb2_set_power_mode(struct usb2_device *udev, uint8_t power_mode); 465 466#endif /* _USB2_CORE_H_ */ 467