1 /* $FreeBSD: releng/11.2/sys/dev/usb/usb_ioctl.h 331722 2018-03-29 02:50:57Z eadler $ */
2 /*-
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
5 * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #ifndef _USB_IOCTL_H_
30 #define _USB_IOCTL_H_
31
32 #ifndef USB_GLOBAL_INCLUDE_FILE
33 #include <sys/ioccom.h>
34 #include <sys/cdefs.h>
35
36 /* Building "kdump" depends on these includes */
37
38 #include <dev/usb/usb_endian.h>
39 #include <dev/usb/usb.h>
40 #endif
41
42 #define USB_DEVICE_NAME "usbctl"
43 #define USB_DEVICE_DIR "usb"
44 #define USB_GENERIC_NAME "ugen"
45 #define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */
46
47 /*
48 * Align IOCTL structures to hide differences when running 32-bit
49 * programs under 64-bit kernels:
50 */
51 #ifdef COMPAT_32BIT
52 #define USB_IOCTL_STRUCT_ALIGN(n) __aligned(n)
53 #else
54 #define USB_IOCTL_STRUCT_ALIGN(n)
55 #endif
56
57 /* Definition of valid template sysctl values */
58
59 enum {
60 USB_TEMP_MSC, /* USB Mass Storage */
61 USB_TEMP_CDCE, /* USB CDC Ethernet */
62 USB_TEMP_MTP, /* Message Transfer Protocol */
63 USB_TEMP_MODEM, /* USB CDC Modem */
64 USB_TEMP_AUDIO, /* USB Audio */
65 USB_TEMP_KBD, /* USB Keyboard */
66 USB_TEMP_MOUSE, /* USB Mouse */
67 USB_TEMP_PHONE, /* USB Phone */
68 USB_TEMP_SERIALNET, /* USB CDC Ethernet and Modem */
69 USB_TEMP_MIDI, /* USB MIDI */
70 USB_TEMP_MAX,
71 };
72
73 struct usb_read_dir {
74 #ifdef COMPAT_32BIT
75 uint64_t urd_data;
76 #else
77 void *urd_data;
78 #endif
79 uint32_t urd_startentry;
80 uint32_t urd_maxlen;
81 } USB_IOCTL_STRUCT_ALIGN(8);
82
83 struct usb_ctl_request {
84 #ifdef COMPAT_32BIT
85 uint64_t ucr_data;
86 #else
87 void *ucr_data;
88 #endif
89 uint16_t ucr_flags;
90 uint16_t ucr_actlen; /* actual length transferred */
91 uint8_t ucr_addr; /* zero - currently not used */
92 struct usb_device_request ucr_request;
93 } USB_IOCTL_STRUCT_ALIGN(8);
94
95 struct usb_alt_interface {
96 uint8_t uai_interface_index;
97 uint8_t uai_alt_index;
98 } USB_IOCTL_STRUCT_ALIGN(1);
99
100 struct usb_gen_descriptor {
101 #ifdef COMPAT_32BIT
102 uint64_t ugd_data;
103 #else
104 void *ugd_data;
105 #endif
106 uint16_t ugd_lang_id;
107 uint16_t ugd_maxlen;
108 uint16_t ugd_actlen;
109 uint16_t ugd_offset;
110 uint8_t ugd_config_index;
111 uint8_t ugd_string_index;
112 uint8_t ugd_iface_index;
113 uint8_t ugd_altif_index;
114 uint8_t ugd_endpt_index;
115 uint8_t ugd_report_type;
116 uint8_t reserved[8];
117 } USB_IOCTL_STRUCT_ALIGN(8);
118
119 struct usb_device_info {
120 uint16_t udi_productNo;
121 uint16_t udi_vendorNo;
122 uint16_t udi_releaseNo;
123 uint16_t udi_power; /* power consumption in mA, 0 if
124 * selfpowered */
125 uint8_t udi_bus;
126 uint8_t udi_addr; /* device address */
127 uint8_t udi_index; /* device index */
128 uint8_t udi_class;
129 uint8_t udi_subclass;
130 uint8_t udi_protocol;
131 uint8_t udi_config_no; /* current config number */
132 uint8_t udi_config_index; /* current config index */
133 uint8_t udi_speed; /* see "USB_SPEED_XXX" */
134 uint8_t udi_mode; /* see "USB_MODE_XXX" */
135 uint8_t udi_nports;
136 uint8_t udi_hubaddr; /* parent HUB address */
137 uint8_t udi_hubindex; /* parent HUB device index */
138 uint8_t udi_hubport; /* parent HUB port */
139 uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */
140 uint8_t udi_suspended; /* set if device is suspended */
141 uint8_t udi_reserved[16]; /* leave space for the future */
142 char udi_product[128];
143 char udi_vendor[128];
144 char udi_serial[64];
145 char udi_release[8];
146 } USB_IOCTL_STRUCT_ALIGN(2);
147
148 #define USB_DEVICE_PORT_PATH_MAX 32
149
150 struct usb_device_port_path {
151 uint8_t udp_bus; /* which bus we are on */
152 uint8_t udp_index; /* which device index */
153 uint8_t udp_port_level; /* how many levels: 0, 1, 2 ... */
154 uint8_t udp_port_no[USB_DEVICE_PORT_PATH_MAX];
155 } USB_IOCTL_STRUCT_ALIGN(1);
156
157 struct usb_device_stats {
158 uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */
159 uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */
160 } USB_IOCTL_STRUCT_ALIGN(4);
161
162 struct usb_fs_start {
163 uint8_t ep_index;
164 } USB_IOCTL_STRUCT_ALIGN(1);
165
166 struct usb_fs_stop {
167 uint8_t ep_index;
168 } USB_IOCTL_STRUCT_ALIGN(1);
169
170 struct usb_fs_complete {
171 uint8_t ep_index;
172 } USB_IOCTL_STRUCT_ALIGN(1);
173
174 /* This structure is used for all endpoint types */
175 struct usb_fs_endpoint {
176 /*
177 * NOTE: isochronous USB transfer only use one buffer, but can have
178 * multiple frame lengths !
179 */
180 #ifdef COMPAT_32BIT
181 uint64_t ppBuffer;
182 uint64_t pLength;
183 #else
184 void **ppBuffer; /* pointer to userland buffers */
185 uint32_t *pLength; /* pointer to frame lengths, updated
186 * to actual length */
187 #endif
188 uint32_t nFrames; /* number of frames */
189 uint32_t aFrames; /* actual number of frames */
190 uint16_t flags;
191 /* a single short frame will terminate */
192 #define USB_FS_FLAG_SINGLE_SHORT_OK 0x0001
193 /* multiple short frames are allowed */
194 #define USB_FS_FLAG_MULTI_SHORT_OK 0x0002
195 /* all frame(s) transmitted are short terminated */
196 #define USB_FS_FLAG_FORCE_SHORT 0x0004
197 /* will do a clear-stall before xfer */
198 #define USB_FS_FLAG_CLEAR_STALL 0x0008
199 uint16_t timeout; /* in milliseconds */
200 /* isocronous completion time in milliseconds - used for echo cancel */
201 uint16_t isoc_time_complete;
202 /* timeout value for no timeout */
203 #define USB_FS_TIMEOUT_NONE 0
204 int status; /* see USB_ERR_XXX */
205 } USB_IOCTL_STRUCT_ALIGN(8);
206
207 struct usb_fs_init {
208 /* userland pointer to endpoints structure */
209 #ifdef COMPAT_32BIT
210 uint64_t pEndpoints;
211 #else
212 struct usb_fs_endpoint *pEndpoints;
213 #endif
214 /* maximum number of endpoints */
215 uint8_t ep_index_max;
216 } USB_IOCTL_STRUCT_ALIGN(8);
217
218 struct usb_fs_uninit {
219 uint8_t dummy; /* zero */
220 } USB_IOCTL_STRUCT_ALIGN(1);
221
222 struct usb_fs_open {
223 #define USB_FS_MAX_BUFSIZE (1 << 18)
224 uint32_t max_bufsize;
225 #define USB_FS_MAX_FRAMES (1U << 12)
226 #define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */
227 uint32_t max_frames; /* read and write */
228 uint16_t max_packet_length; /* read only */
229 uint8_t dev_index; /* currently unused */
230 uint8_t ep_index;
231 uint8_t ep_no; /* bEndpointNumber */
232 } USB_IOCTL_STRUCT_ALIGN(4);
233
234 struct usb_fs_open_stream {
235 struct usb_fs_open fs_open;
236 uint16_t stream_id; /* stream ID */
237 } USB_IOCTL_STRUCT_ALIGN(4);
238
239 struct usb_fs_close {
240 uint8_t ep_index;
241 } USB_IOCTL_STRUCT_ALIGN(1);
242
243 struct usb_fs_clear_stall_sync {
244 uint8_t ep_index;
245 } USB_IOCTL_STRUCT_ALIGN(1);
246
247 struct usb_gen_quirk {
248 uint16_t index; /* Quirk Index */
249 uint16_t vid; /* Vendor ID */
250 uint16_t pid; /* Product ID */
251 uint16_t bcdDeviceLow; /* Low Device Revision */
252 uint16_t bcdDeviceHigh; /* High Device Revision */
253 uint16_t reserved[2];
254 /*
255 * String version of quirk including terminating zero. See
256 * UQ_XXX in "usb_quirk.h".
257 */
258 char quirkname[64 - 14];
259 } USB_IOCTL_STRUCT_ALIGN(2);
260
261 /* USB controller */
262 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
263 #define USB_SETDEBUG _IOW ('U', 2, int)
264 #define USB_DISCOVER _IO ('U', 3)
265 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
266 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
267 #define USB_DEVICEENUMERATE _IOW ('U', 6, int)
268
269 /* Generic HID device */
270 #define USB_GET_REPORT_DESC _IOWR('U', 21, struct usb_gen_descriptor)
271 #define USB_SET_IMMED _IOW ('U', 22, int)
272 #define USB_GET_REPORT _IOWR('U', 23, struct usb_gen_descriptor)
273 #define USB_SET_REPORT _IOW ('U', 24, struct usb_gen_descriptor)
274 #define USB_GET_REPORT_ID _IOR ('U', 25, int)
275
276 /* Generic USB device */
277 #define USB_GET_CONFIG _IOR ('U', 100, int)
278 #define USB_SET_CONFIG _IOW ('U', 101, int)
279 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface)
280 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface)
281 #define USB_GET_DEVICE_DESC _IOR ('U', 105, struct usb_device_descriptor)
282 #define USB_GET_CONFIG_DESC _IOR ('U', 106, struct usb_config_descriptor)
283 #define USB_GET_RX_INTERFACE_DESC _IOR ('U', 107, struct usb_interface_descriptor)
284 #define USB_GET_RX_ENDPOINT_DESC _IOR ('U', 108, struct usb_endpoint_descriptor)
285 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_gen_descriptor)
286 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_gen_descriptor)
287 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request)
288 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info)
289 #define USB_SET_RX_SHORT_XFER _IOW ('U', 113, int)
290 #define USB_SET_RX_TIMEOUT _IOW ('U', 114, int)
291 #define USB_GET_RX_FRAME_SIZE _IOR ('U', 115, int)
292 #define USB_GET_RX_BUFFER_SIZE _IOR ('U', 117, int)
293 #define USB_SET_RX_BUFFER_SIZE _IOW ('U', 118, int)
294 #define USB_SET_RX_STALL_FLAG _IOW ('U', 119, int)
295 #define USB_SET_TX_STALL_FLAG _IOW ('U', 120, int)
296 #define USB_GET_IFACE_DRIVER _IOWR('U', 121, struct usb_gen_descriptor)
297 #define USB_CLAIM_INTERFACE _IOW ('U', 122, int)
298 #define USB_RELEASE_INTERFACE _IOW ('U', 123, int)
299 #define USB_IFACE_DRIVER_ACTIVE _IOW ('U', 124, int)
300 #define USB_IFACE_DRIVER_DETACH _IOW ('U', 125, int)
301 #define USB_GET_PLUGTIME _IOR ('U', 126, uint32_t)
302 #define USB_READ_DIR _IOW ('U', 127, struct usb_read_dir)
303 /* 128 - 133 unused */
304 #define USB_GET_DEV_PORT_PATH _IOR ('U', 134, struct usb_device_port_path)
305 #define USB_GET_POWER_USAGE _IOR ('U', 135, int)
306 #define USB_SET_TX_FORCE_SHORT _IOW ('U', 136, int)
307 #define USB_SET_TX_TIMEOUT _IOW ('U', 137, int)
308 #define USB_GET_TX_FRAME_SIZE _IOR ('U', 138, int)
309 #define USB_GET_TX_BUFFER_SIZE _IOR ('U', 139, int)
310 #define USB_SET_TX_BUFFER_SIZE _IOW ('U', 140, int)
311 #define USB_GET_TX_INTERFACE_DESC _IOR ('U', 141, struct usb_interface_descriptor)
312 #define USB_GET_TX_ENDPOINT_DESC _IOR ('U', 142, struct usb_endpoint_descriptor)
313 #define USB_SET_PORT_ENABLE _IOW ('U', 143, int)
314 #define USB_SET_PORT_DISABLE _IOW ('U', 144, int)
315 #define USB_SET_POWER_MODE _IOW ('U', 145, int)
316 #define USB_GET_POWER_MODE _IOR ('U', 146, int)
317 #define USB_SET_TEMPLATE _IOW ('U', 147, int)
318 #define USB_GET_TEMPLATE _IOR ('U', 148, int)
319
320 /* Modem device */
321 #define USB_GET_CM_OVER_DATA _IOR ('U', 180, int)
322 #define USB_SET_CM_OVER_DATA _IOW ('U', 181, int)
323
324 /* GPIO control */
325 #define USB_GET_GPIO _IOR ('U', 182, int)
326 #define USB_SET_GPIO _IOW ('U', 183, int)
327
328 /* USB file system interface */
329 #define USB_FS_START _IOW ('U', 192, struct usb_fs_start)
330 #define USB_FS_STOP _IOW ('U', 193, struct usb_fs_stop)
331 #define USB_FS_COMPLETE _IOR ('U', 194, struct usb_fs_complete)
332 #define USB_FS_INIT _IOW ('U', 195, struct usb_fs_init)
333 #define USB_FS_UNINIT _IOW ('U', 196, struct usb_fs_uninit)
334 #define USB_FS_OPEN _IOWR('U', 197, struct usb_fs_open)
335 #define USB_FS_CLOSE _IOW ('U', 198, struct usb_fs_close)
336 #define USB_FS_CLEAR_STALL_SYNC _IOW ('U', 199, struct usb_fs_clear_stall_sync)
337 #define USB_FS_OPEN_STREAM _IOWR('U', 200, struct usb_fs_open_stream)
338
339 /* USB quirk system interface */
340 #define USB_DEV_QUIRK_GET _IOWR('Q', 0, struct usb_gen_quirk)
341 #define USB_QUIRK_NAME_GET _IOWR('Q', 1, struct usb_gen_quirk)
342 #define USB_DEV_QUIRK_ADD _IOW ('Q', 2, struct usb_gen_quirk)
343 #define USB_DEV_QUIRK_REMOVE _IOW ('Q', 3, struct usb_gen_quirk)
344
345 #endif /* _USB_IOCTL_H_ */
Cache object: 9622ba10f3f66aa71dec1a50a176afb6
|