usb_ioctl.h revision 277129
1184610Salfred/* $FreeBSD: head/sys/dev/usb/usb_ioctl.h 277129 2015-01-13 14:03:56Z br $ */ 2184610Salfred/*- 3184610Salfred * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4184610Salfred * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved. 5184610Salfred * Copyright (c) 1998 Lennart Augustsson. All rights reserved. 6184610Salfred * 7184610Salfred * Redistribution and use in source and binary forms, with or without 8184610Salfred * modification, are permitted provided that the following conditions 9184610Salfred * are met: 10184610Salfred * 1. Redistributions of source code must retain the above copyright 11184610Salfred * notice, this list of conditions and the following disclaimer. 12184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 13184610Salfred * notice, this list of conditions and the following disclaimer in the 14184610Salfred * documentation and/or other materials provided with the distribution. 15184610Salfred * 16184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26184610Salfred * SUCH DAMAGE. 27184610Salfred */ 28184610Salfred 29194230Sthompsa#ifndef _USB_IOCTL_H_ 30194230Sthompsa#define _USB_IOCTL_H_ 31184610Salfred 32246122Shselasky#ifndef USB_GLOBAL_INCLUDE_FILE 33184610Salfred#include <sys/ioccom.h> 34254243Shselasky#include <sys/cdefs.h> 35184610Salfred 36185087Salfred/* Building "kdump" depends on these includes */ 37185087Salfred 38188942Sthompsa#include <dev/usb/usb_endian.h> 39188942Sthompsa#include <dev/usb/usb.h> 40246122Shselasky#endif 41185087Salfred 42189110Sthompsa#define USB_DEVICE_NAME "usbctl" 43189110Sthompsa#define USB_DEVICE_DIR "usb" 44184610Salfred#define USB_GENERIC_NAME "ugen" 45223467Shselasky#define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */ 46184610Salfred 47254243Shselasky/* 48254243Shselasky * Align IOCTL structures to hide differences when running 32-bit 49254243Shselasky * programs under 64-bit kernels: 50254243Shselasky */ 51254243Shselasky#ifdef COMPAT_32BIT 52254243Shselasky#define USB_IOCTL_STRUCT_ALIGN(n) __aligned(n) 53254243Shselasky#else 54254243Shselasky#define USB_IOCTL_STRUCT_ALIGN(n) 55254243Shselasky#endif 56254243Shselasky 57223467Shselasky/* Definition of valid template sysctl values */ 58223467Shselasky 59223467Shselaskyenum { 60223467Shselasky USB_TEMP_MSC, /* USB Mass Storage */ 61223467Shselasky USB_TEMP_CDCE, /* USB CDC Ethernet */ 62223467Shselasky USB_TEMP_MTP, /* Message Transfer Protocol */ 63223467Shselasky USB_TEMP_MODEM, /* USB CDC Modem */ 64223467Shselasky USB_TEMP_AUDIO, /* USB Audio */ 65223467Shselasky USB_TEMP_KBD, /* USB Keyboard */ 66223467Shselasky USB_TEMP_MOUSE, /* USB Mouse */ 67269567Shselasky USB_TEMP_PHONE, /* USB Phone */ 68277129Sbr USB_TEMP_SERIALNET, /* USB CDC Ethernet and Modem */ 69223467Shselasky USB_TEMP_MAX, 70223467Shselasky}; 71223467Shselasky 72192984Sthompsastruct usb_read_dir { 73213852Shselasky#ifdef COMPAT_32BIT 74213852Shselasky uint64_t urd_data; 75213852Shselasky#else 76184610Salfred void *urd_data; 77213852Shselasky#endif 78184610Salfred uint32_t urd_startentry; 79184610Salfred uint32_t urd_maxlen; 80254243Shselasky} USB_IOCTL_STRUCT_ALIGN(8); 81184610Salfred 82192984Sthompsastruct usb_ctl_request { 83213852Shselasky#ifdef COMPAT_32BIT 84213852Shselasky uint64_t ucr_data; 85213852Shselasky#else 86184610Salfred void *ucr_data; 87213852Shselasky#endif 88184610Salfred uint16_t ucr_flags; 89184610Salfred uint16_t ucr_actlen; /* actual length transferred */ 90184610Salfred uint8_t ucr_addr; /* zero - currently not used */ 91192984Sthompsa struct usb_device_request ucr_request; 92254243Shselasky} USB_IOCTL_STRUCT_ALIGN(8); 93184610Salfred 94192984Sthompsastruct usb_alt_interface { 95184610Salfred uint8_t uai_interface_index; 96184610Salfred uint8_t uai_alt_index; 97254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 98184610Salfred 99192984Sthompsastruct usb_gen_descriptor { 100213852Shselasky#ifdef COMPAT_32BIT 101213852Shselasky uint64_t ugd_data; 102213852Shselasky#else 103184610Salfred void *ugd_data; 104213852Shselasky#endif 105184610Salfred uint16_t ugd_lang_id; 106184610Salfred uint16_t ugd_maxlen; 107184610Salfred uint16_t ugd_actlen; 108184610Salfred uint16_t ugd_offset; 109184610Salfred uint8_t ugd_config_index; 110184610Salfred uint8_t ugd_string_index; 111184610Salfred uint8_t ugd_iface_index; 112184610Salfred uint8_t ugd_altif_index; 113184610Salfred uint8_t ugd_endpt_index; 114184610Salfred uint8_t ugd_report_type; 115184610Salfred uint8_t reserved[8]; 116254243Shselasky} USB_IOCTL_STRUCT_ALIGN(8); 117184610Salfred 118192984Sthompsastruct usb_device_info { 119184610Salfred uint16_t udi_productNo; 120184610Salfred uint16_t udi_vendorNo; 121184610Salfred uint16_t udi_releaseNo; 122184610Salfred uint16_t udi_power; /* power consumption in mA, 0 if 123184610Salfred * selfpowered */ 124184610Salfred uint8_t udi_bus; 125184610Salfred uint8_t udi_addr; /* device address */ 126184610Salfred uint8_t udi_index; /* device index */ 127184610Salfred uint8_t udi_class; 128184610Salfred uint8_t udi_subclass; 129184610Salfred uint8_t udi_protocol; 130184610Salfred uint8_t udi_config_no; /* current config number */ 131184610Salfred uint8_t udi_config_index; /* current config index */ 132184610Salfred uint8_t udi_speed; /* see "USB_SPEED_XXX" */ 133184610Salfred uint8_t udi_mode; /* see "USB_MODE_XXX" */ 134184610Salfred uint8_t udi_nports; 135184610Salfred uint8_t udi_hubaddr; /* parent HUB address */ 136184610Salfred uint8_t udi_hubindex; /* parent HUB device index */ 137184610Salfred uint8_t udi_hubport; /* parent HUB port */ 138184610Salfred uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */ 139184610Salfred uint8_t udi_suspended; /* set if device is suspended */ 140184610Salfred uint8_t udi_reserved[16]; /* leave space for the future */ 141184610Salfred char udi_product[128]; 142184610Salfred char udi_vendor[128]; 143184610Salfred char udi_serial[64]; 144184610Salfred char udi_release[8]; 145254243Shselasky} USB_IOCTL_STRUCT_ALIGN(2); 146184610Salfred 147250201Shselasky#define USB_DEVICE_PORT_PATH_MAX 32 148250201Shselasky 149250201Shselaskystruct usb_device_port_path { 150250201Shselasky uint8_t udp_bus; /* which bus we are on */ 151250201Shselasky uint8_t udp_index; /* which device index */ 152250201Shselasky uint8_t udp_port_level; /* how many levels: 0, 1, 2 ... */ 153250201Shselasky uint8_t udp_port_no[USB_DEVICE_PORT_PATH_MAX]; 154254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 155250201Shselasky 156192984Sthompsastruct usb_device_stats { 157184610Salfred uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */ 158184610Salfred uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */ 159254243Shselasky} USB_IOCTL_STRUCT_ALIGN(4); 160184610Salfred 161192984Sthompsastruct usb_fs_start { 162184610Salfred uint8_t ep_index; 163254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 164184610Salfred 165192984Sthompsastruct usb_fs_stop { 166184610Salfred uint8_t ep_index; 167254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 168184610Salfred 169192984Sthompsastruct usb_fs_complete { 170184610Salfred uint8_t ep_index; 171254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 172184610Salfred 173184610Salfred/* This structure is used for all endpoint types */ 174192984Sthompsastruct usb_fs_endpoint { 175184610Salfred /* 176184610Salfred * NOTE: isochronous USB transfer only use one buffer, but can have 177184610Salfred * multiple frame lengths ! 178184610Salfred */ 179213852Shselasky#ifdef COMPAT_32BIT 180213852Shselasky uint64_t ppBuffer; 181213852Shselasky uint64_t pLength; 182213852Shselasky#else 183184610Salfred void **ppBuffer; /* pointer to userland buffers */ 184184610Salfred uint32_t *pLength; /* pointer to frame lengths, updated 185184610Salfred * to actual length */ 186213852Shselasky#endif 187184610Salfred uint32_t nFrames; /* number of frames */ 188184610Salfred uint32_t aFrames; /* actual number of frames */ 189184610Salfred uint16_t flags; 190184610Salfred /* a single short frame will terminate */ 191184610Salfred#define USB_FS_FLAG_SINGLE_SHORT_OK 0x0001 192184610Salfred /* multiple short frames are allowed */ 193184610Salfred#define USB_FS_FLAG_MULTI_SHORT_OK 0x0002 194184610Salfred /* all frame(s) transmitted are short terminated */ 195184610Salfred#define USB_FS_FLAG_FORCE_SHORT 0x0004 196184610Salfred /* will do a clear-stall before xfer */ 197184610Salfred#define USB_FS_FLAG_CLEAR_STALL 0x0008 198184610Salfred uint16_t timeout; /* in milliseconds */ 199184610Salfred /* isocronous completion time in milliseconds - used for echo cancel */ 200184610Salfred uint16_t isoc_time_complete; 201184610Salfred /* timeout value for no timeout */ 202184610Salfred#define USB_FS_TIMEOUT_NONE 0 203194677Sthompsa int status; /* see USB_ERR_XXX */ 204254243Shselasky} USB_IOCTL_STRUCT_ALIGN(8); 205184610Salfred 206192984Sthompsastruct usb_fs_init { 207184610Salfred /* userland pointer to endpoints structure */ 208213852Shselasky#ifdef COMPAT_32BIT 209213852Shselasky uint64_t pEndpoints; 210213852Shselasky#else 211192984Sthompsa struct usb_fs_endpoint *pEndpoints; 212213852Shselasky#endif 213184610Salfred /* maximum number of endpoints */ 214184610Salfred uint8_t ep_index_max; 215254243Shselasky} USB_IOCTL_STRUCT_ALIGN(8); 216184610Salfred 217192984Sthompsastruct usb_fs_uninit { 218184610Salfred uint8_t dummy; /* zero */ 219254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 220184610Salfred 221192984Sthompsastruct usb_fs_open { 222184610Salfred#define USB_FS_MAX_BUFSIZE (1 << 18) 223184610Salfred uint32_t max_bufsize; 224219100Shselasky#define USB_FS_MAX_FRAMES (1U << 12) 225219100Shselasky#define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */ 226219100Shselasky uint32_t max_frames; /* read and write */ 227184610Salfred uint16_t max_packet_length; /* read only */ 228184610Salfred uint8_t dev_index; /* currently unused */ 229184610Salfred uint8_t ep_index; 230184610Salfred uint8_t ep_no; /* bEndpointNumber */ 231254243Shselasky} USB_IOCTL_STRUCT_ALIGN(4); 232184610Salfred 233239238Shselaskystruct usb_fs_open_stream { 234239214Shselasky struct usb_fs_open fs_open; 235254243Shselasky uint16_t stream_id; /* stream ID */ 236254243Shselasky} USB_IOCTL_STRUCT_ALIGN(4); 237239214Shselasky 238192984Sthompsastruct usb_fs_close { 239184610Salfred uint8_t ep_index; 240254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 241184610Salfred 242192984Sthompsastruct usb_fs_clear_stall_sync { 243184610Salfred uint8_t ep_index; 244254243Shselasky} USB_IOCTL_STRUCT_ALIGN(1); 245184610Salfred 246192984Sthompsastruct usb_gen_quirk { 247184610Salfred uint16_t index; /* Quirk Index */ 248184610Salfred uint16_t vid; /* Vendor ID */ 249184610Salfred uint16_t pid; /* Product ID */ 250184610Salfred uint16_t bcdDeviceLow; /* Low Device Revision */ 251184610Salfred uint16_t bcdDeviceHigh; /* High Device Revision */ 252184610Salfred uint16_t reserved[2]; 253184610Salfred /* 254254243Shselasky * String version of quirk including terminating zero. See 255254243Shselasky * UQ_XXX in "usb_quirk.h". 256184610Salfred */ 257184610Salfred char quirkname[64 - 14]; 258254243Shselasky} USB_IOCTL_STRUCT_ALIGN(2); 259184610Salfred 260184610Salfred/* USB controller */ 261192984Sthompsa#define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 262184610Salfred#define USB_SETDEBUG _IOW ('U', 2, int) 263184610Salfred#define USB_DISCOVER _IO ('U', 3) 264192984Sthompsa#define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 265192984Sthompsa#define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 266184610Salfred#define USB_DEVICEENUMERATE _IOW ('U', 6, int) 267184610Salfred 268184610Salfred/* Generic HID device */ 269192984Sthompsa#define USB_GET_REPORT_DESC _IOWR('U', 21, struct usb_gen_descriptor) 270184610Salfred#define USB_SET_IMMED _IOW ('U', 22, int) 271192984Sthompsa#define USB_GET_REPORT _IOWR('U', 23, struct usb_gen_descriptor) 272192984Sthompsa#define USB_SET_REPORT _IOW ('U', 24, struct usb_gen_descriptor) 273184610Salfred#define USB_GET_REPORT_ID _IOR ('U', 25, int) 274184610Salfred 275184610Salfred/* Generic USB device */ 276184610Salfred#define USB_GET_CONFIG _IOR ('U', 100, int) 277184610Salfred#define USB_SET_CONFIG _IOW ('U', 101, int) 278192984Sthompsa#define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 279192984Sthompsa#define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 280192984Sthompsa#define USB_GET_DEVICE_DESC _IOR ('U', 105, struct usb_device_descriptor) 281192984Sthompsa#define USB_GET_CONFIG_DESC _IOR ('U', 106, struct usb_config_descriptor) 282192984Sthompsa#define USB_GET_RX_INTERFACE_DESC _IOR ('U', 107, struct usb_interface_descriptor) 283192984Sthompsa#define USB_GET_RX_ENDPOINT_DESC _IOR ('U', 108, struct usb_endpoint_descriptor) 284192984Sthompsa#define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_gen_descriptor) 285192984Sthompsa#define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_gen_descriptor) 286192984Sthompsa#define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 287192984Sthompsa#define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 288184610Salfred#define USB_SET_RX_SHORT_XFER _IOW ('U', 113, int) 289184610Salfred#define USB_SET_RX_TIMEOUT _IOW ('U', 114, int) 290184610Salfred#define USB_GET_RX_FRAME_SIZE _IOR ('U', 115, int) 291184610Salfred#define USB_GET_RX_BUFFER_SIZE _IOR ('U', 117, int) 292184610Salfred#define USB_SET_RX_BUFFER_SIZE _IOW ('U', 118, int) 293184610Salfred#define USB_SET_RX_STALL_FLAG _IOW ('U', 119, int) 294184610Salfred#define USB_SET_TX_STALL_FLAG _IOW ('U', 120, int) 295192984Sthompsa#define USB_GET_IFACE_DRIVER _IOWR('U', 121, struct usb_gen_descriptor) 296184610Salfred#define USB_CLAIM_INTERFACE _IOW ('U', 122, int) 297184610Salfred#define USB_RELEASE_INTERFACE _IOW ('U', 123, int) 298184610Salfred#define USB_IFACE_DRIVER_ACTIVE _IOW ('U', 124, int) 299184610Salfred#define USB_IFACE_DRIVER_DETACH _IOW ('U', 125, int) 300184610Salfred#define USB_GET_PLUGTIME _IOR ('U', 126, uint32_t) 301192984Sthompsa#define USB_READ_DIR _IOW ('U', 127, struct usb_read_dir) 302250201Shselasky/* 128 - 133 unused */ 303250201Shselasky#define USB_GET_DEV_PORT_PATH _IOR ('U', 134, struct usb_device_port_path) 304246789Shselasky#define USB_GET_POWER_USAGE _IOR ('U', 135, int) 305184610Salfred#define USB_SET_TX_FORCE_SHORT _IOW ('U', 136, int) 306184610Salfred#define USB_SET_TX_TIMEOUT _IOW ('U', 137, int) 307184610Salfred#define USB_GET_TX_FRAME_SIZE _IOR ('U', 138, int) 308184610Salfred#define USB_GET_TX_BUFFER_SIZE _IOR ('U', 139, int) 309184610Salfred#define USB_SET_TX_BUFFER_SIZE _IOW ('U', 140, int) 310192984Sthompsa#define USB_GET_TX_INTERFACE_DESC _IOR ('U', 141, struct usb_interface_descriptor) 311192984Sthompsa#define USB_GET_TX_ENDPOINT_DESC _IOR ('U', 142, struct usb_endpoint_descriptor) 312184610Salfred#define USB_SET_PORT_ENABLE _IOW ('U', 143, int) 313184610Salfred#define USB_SET_PORT_DISABLE _IOW ('U', 144, int) 314184610Salfred#define USB_SET_POWER_MODE _IOW ('U', 145, int) 315184610Salfred#define USB_GET_POWER_MODE _IOR ('U', 146, int) 316188987Sthompsa#define USB_SET_TEMPLATE _IOW ('U', 147, int) 317188987Sthompsa#define USB_GET_TEMPLATE _IOR ('U', 148, int) 318184610Salfred 319184610Salfred/* Modem device */ 320184610Salfred#define USB_GET_CM_OVER_DATA _IOR ('U', 180, int) 321184610Salfred#define USB_SET_CM_OVER_DATA _IOW ('U', 181, int) 322184610Salfred 323227463Shselasky/* GPIO control */ 324227463Shselasky#define USB_GET_GPIO _IOR ('U', 182, int) 325227463Shselasky#define USB_SET_GPIO _IOW ('U', 183, int) 326227463Shselasky 327184610Salfred/* USB file system interface */ 328192984Sthompsa#define USB_FS_START _IOW ('U', 192, struct usb_fs_start) 329192984Sthompsa#define USB_FS_STOP _IOW ('U', 193, struct usb_fs_stop) 330192984Sthompsa#define USB_FS_COMPLETE _IOR ('U', 194, struct usb_fs_complete) 331192984Sthompsa#define USB_FS_INIT _IOW ('U', 195, struct usb_fs_init) 332192984Sthompsa#define USB_FS_UNINIT _IOW ('U', 196, struct usb_fs_uninit) 333192984Sthompsa#define USB_FS_OPEN _IOWR('U', 197, struct usb_fs_open) 334192984Sthompsa#define USB_FS_CLOSE _IOW ('U', 198, struct usb_fs_close) 335192984Sthompsa#define USB_FS_CLEAR_STALL_SYNC _IOW ('U', 199, struct usb_fs_clear_stall_sync) 336239238Shselasky#define USB_FS_OPEN_STREAM _IOWR('U', 200, struct usb_fs_open_stream) 337184610Salfred 338184610Salfred/* USB quirk system interface */ 339192984Sthompsa#define USB_DEV_QUIRK_GET _IOWR('Q', 0, struct usb_gen_quirk) 340192984Sthompsa#define USB_QUIRK_NAME_GET _IOWR('Q', 1, struct usb_gen_quirk) 341192984Sthompsa#define USB_DEV_QUIRK_ADD _IOW ('Q', 2, struct usb_gen_quirk) 342192984Sthompsa#define USB_DEV_QUIRK_REMOVE _IOW ('Q', 3, struct usb_gen_quirk) 343184610Salfred 344194230Sthompsa#endif /* _USB_IOCTL_H_ */ 345