xref: /freebsd/sys/dev/usb/usb_ioctl.h (revision 2b15cb3d0922bd70ea592f0da9b4a5b167f4d53f)
1 /* $FreeBSD$ */
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_MAX,
70 };
71 
72 struct usb_read_dir {
73 #ifdef COMPAT_32BIT
74 	uint64_t urd_data;
75 #else
76 	void   *urd_data;
77 #endif
78 	uint32_t urd_startentry;
79 	uint32_t urd_maxlen;
80 } USB_IOCTL_STRUCT_ALIGN(8);
81 
82 struct usb_ctl_request {
83 #ifdef COMPAT_32BIT
84 	uint64_t ucr_data;
85 #else
86 	void   *ucr_data;
87 #endif
88 	uint16_t ucr_flags;
89 	uint16_t ucr_actlen;		/* actual length transferred */
90 	uint8_t	ucr_addr;		/* zero - currently not used */
91 	struct usb_device_request ucr_request;
92 } USB_IOCTL_STRUCT_ALIGN(8);
93 
94 struct usb_alt_interface {
95 	uint8_t	uai_interface_index;
96 	uint8_t	uai_alt_index;
97 } USB_IOCTL_STRUCT_ALIGN(1);
98 
99 struct usb_gen_descriptor {
100 #ifdef COMPAT_32BIT
101 	uint64_t ugd_data;
102 #else
103 	void   *ugd_data;
104 #endif
105 	uint16_t ugd_lang_id;
106 	uint16_t ugd_maxlen;
107 	uint16_t ugd_actlen;
108 	uint16_t ugd_offset;
109 	uint8_t	ugd_config_index;
110 	uint8_t	ugd_string_index;
111 	uint8_t	ugd_iface_index;
112 	uint8_t	ugd_altif_index;
113 	uint8_t	ugd_endpt_index;
114 	uint8_t	ugd_report_type;
115 	uint8_t	reserved[8];
116 } USB_IOCTL_STRUCT_ALIGN(8);
117 
118 struct usb_device_info {
119 	uint16_t udi_productNo;
120 	uint16_t udi_vendorNo;
121 	uint16_t udi_releaseNo;
122 	uint16_t udi_power;		/* power consumption in mA, 0 if
123 					 * selfpowered */
124 	uint8_t	udi_bus;
125 	uint8_t	udi_addr;		/* device address */
126 	uint8_t	udi_index;		/* device index */
127 	uint8_t	udi_class;
128 	uint8_t	udi_subclass;
129 	uint8_t	udi_protocol;
130 	uint8_t	udi_config_no;		/* current config number */
131 	uint8_t	udi_config_index;	/* current config index */
132 	uint8_t	udi_speed;		/* see "USB_SPEED_XXX" */
133 	uint8_t	udi_mode;		/* see "USB_MODE_XXX" */
134 	uint8_t	udi_nports;
135 	uint8_t	udi_hubaddr;		/* parent HUB address */
136 	uint8_t	udi_hubindex;		/* parent HUB device index */
137 	uint8_t	udi_hubport;		/* parent HUB port */
138 	uint8_t	udi_power_mode;		/* see "USB_POWER_MODE_XXX" */
139 	uint8_t	udi_suspended;		/* set if device is suspended */
140 	uint8_t	udi_reserved[16];	/* leave space for the future */
141 	char	udi_product[128];
142 	char	udi_vendor[128];
143 	char	udi_serial[64];
144 	char	udi_release[8];
145 } USB_IOCTL_STRUCT_ALIGN(2);
146 
147 #define	USB_DEVICE_PORT_PATH_MAX 32
148 
149 struct usb_device_port_path {
150 	uint8_t udp_bus;		/* which bus we are on */
151 	uint8_t udp_index;		/* which device index */
152 	uint8_t udp_port_level;		/* how many levels: 0, 1, 2 ... */
153 	uint8_t udp_port_no[USB_DEVICE_PORT_PATH_MAX];
154 } USB_IOCTL_STRUCT_ALIGN(1);
155 
156 struct usb_device_stats {
157 	uint32_t uds_requests_ok[4];	/* Indexed by transfer type UE_XXX */
158 	uint32_t uds_requests_fail[4];	/* Indexed by transfer type UE_XXX */
159 } USB_IOCTL_STRUCT_ALIGN(4);
160 
161 struct usb_fs_start {
162 	uint8_t	ep_index;
163 } USB_IOCTL_STRUCT_ALIGN(1);
164 
165 struct usb_fs_stop {
166 	uint8_t	ep_index;
167 } USB_IOCTL_STRUCT_ALIGN(1);
168 
169 struct usb_fs_complete {
170 	uint8_t	ep_index;
171 } USB_IOCTL_STRUCT_ALIGN(1);
172 
173 /* This structure is used for all endpoint types */
174 struct usb_fs_endpoint {
175 	/*
176 	 * NOTE: isochronous USB transfer only use one buffer, but can have
177 	 * multiple frame lengths !
178 	 */
179 #ifdef COMPAT_32BIT
180 	uint64_t ppBuffer;
181 	uint64_t pLength;
182 #else
183 	void  **ppBuffer;		/* pointer to userland buffers */
184 	uint32_t *pLength;		/* pointer to frame lengths, updated
185 					 * to actual length */
186 #endif
187 	uint32_t nFrames;		/* number of frames */
188 	uint32_t aFrames;		/* actual number of frames */
189 	uint16_t flags;
190 	/* a single short frame will terminate */
191 #define	USB_FS_FLAG_SINGLE_SHORT_OK 0x0001
192 	/* multiple short frames are allowed */
193 #define	USB_FS_FLAG_MULTI_SHORT_OK 0x0002
194 	/* all frame(s) transmitted are short terminated */
195 #define	USB_FS_FLAG_FORCE_SHORT 0x0004
196 	/* will do a clear-stall before xfer */
197 #define	USB_FS_FLAG_CLEAR_STALL 0x0008
198 	uint16_t timeout;		/* in milliseconds */
199 	/* isocronous completion time in milliseconds - used for echo cancel */
200 	uint16_t isoc_time_complete;
201 	/* timeout value for no timeout */
202 #define	USB_FS_TIMEOUT_NONE 0
203 	int	status;			/* see USB_ERR_XXX */
204 } USB_IOCTL_STRUCT_ALIGN(8);
205 
206 struct usb_fs_init {
207 	/* userland pointer to endpoints structure */
208 #ifdef COMPAT_32BIT
209 	uint64_t pEndpoints;
210 #else
211 	struct usb_fs_endpoint *pEndpoints;
212 #endif
213 	/* maximum number of endpoints */
214 	uint8_t	ep_index_max;
215 } USB_IOCTL_STRUCT_ALIGN(8);
216 
217 struct usb_fs_uninit {
218 	uint8_t	dummy;			/* zero */
219 } USB_IOCTL_STRUCT_ALIGN(1);
220 
221 struct usb_fs_open {
222 #define	USB_FS_MAX_BUFSIZE (1 << 18)
223 	uint32_t max_bufsize;
224 #define	USB_FS_MAX_FRAMES		(1U << 12)
225 #define	USB_FS_MAX_FRAMES_PRE_SCALE	(1U << 31)	/* for ISOCHRONOUS transfers */
226 	uint32_t max_frames;		/* read and write */
227 	uint16_t max_packet_length;	/* read only */
228 	uint8_t	dev_index;		/* currently unused */
229 	uint8_t	ep_index;
230 	uint8_t	ep_no;			/* bEndpointNumber */
231 } USB_IOCTL_STRUCT_ALIGN(4);
232 
233 struct usb_fs_open_stream {
234 	struct usb_fs_open fs_open;
235 	uint16_t stream_id;		/* stream ID */
236 } USB_IOCTL_STRUCT_ALIGN(4);
237 
238 struct usb_fs_close {
239 	uint8_t	ep_index;
240 } USB_IOCTL_STRUCT_ALIGN(1);
241 
242 struct usb_fs_clear_stall_sync {
243 	uint8_t	ep_index;
244 } USB_IOCTL_STRUCT_ALIGN(1);
245 
246 struct usb_gen_quirk {
247 	uint16_t index;			/* Quirk Index */
248 	uint16_t vid;			/* Vendor ID */
249 	uint16_t pid;			/* Product ID */
250 	uint16_t bcdDeviceLow;		/* Low Device Revision */
251 	uint16_t bcdDeviceHigh;		/* High Device Revision */
252 	uint16_t reserved[2];
253 	/*
254 	 * String version of quirk including terminating zero. See
255 	 * UQ_XXX in "usb_quirk.h".
256 	 */
257 	char	quirkname[64 - 14];
258 } USB_IOCTL_STRUCT_ALIGN(2);
259 
260 /* USB controller */
261 #define	USB_REQUEST		_IOWR('U', 1, struct usb_ctl_request)
262 #define	USB_SETDEBUG		_IOW ('U', 2, int)
263 #define	USB_DISCOVER		_IO  ('U', 3)
264 #define	USB_DEVICEINFO		_IOWR('U', 4, struct usb_device_info)
265 #define	USB_DEVICESTATS		_IOR ('U', 5, struct usb_device_stats)
266 #define	USB_DEVICEENUMERATE	_IOW ('U', 6, int)
267 
268 /* Generic HID device */
269 #define	USB_GET_REPORT_DESC	_IOWR('U', 21, struct usb_gen_descriptor)
270 #define	USB_SET_IMMED		_IOW ('U', 22, int)
271 #define	USB_GET_REPORT		_IOWR('U', 23, struct usb_gen_descriptor)
272 #define	USB_SET_REPORT		_IOW ('U', 24, struct usb_gen_descriptor)
273 #define	USB_GET_REPORT_ID	_IOR ('U', 25, int)
274 
275 /* Generic USB device */
276 #define	USB_GET_CONFIG		_IOR ('U', 100, int)
277 #define	USB_SET_CONFIG		_IOW ('U', 101, int)
278 #define	USB_GET_ALTINTERFACE	_IOWR('U', 102, struct usb_alt_interface)
279 #define	USB_SET_ALTINTERFACE	_IOWR('U', 103, struct usb_alt_interface)
280 #define	USB_GET_DEVICE_DESC	_IOR ('U', 105, struct usb_device_descriptor)
281 #define	USB_GET_CONFIG_DESC	_IOR ('U', 106, struct usb_config_descriptor)
282 #define	USB_GET_RX_INTERFACE_DESC _IOR ('U', 107, struct usb_interface_descriptor)
283 #define	USB_GET_RX_ENDPOINT_DESC _IOR ('U', 108, struct usb_endpoint_descriptor)
284 #define	USB_GET_FULL_DESC	_IOWR('U', 109, struct usb_gen_descriptor)
285 #define	USB_GET_STRING_DESC	_IOWR('U', 110, struct usb_gen_descriptor)
286 #define	USB_DO_REQUEST		_IOWR('U', 111, struct usb_ctl_request)
287 #define	USB_GET_DEVICEINFO	_IOR ('U', 112, struct usb_device_info)
288 #define	USB_SET_RX_SHORT_XFER	_IOW ('U', 113, int)
289 #define	USB_SET_RX_TIMEOUT	_IOW ('U', 114, int)
290 #define	USB_GET_RX_FRAME_SIZE	_IOR ('U', 115, int)
291 #define	USB_GET_RX_BUFFER_SIZE	_IOR ('U', 117, int)
292 #define	USB_SET_RX_BUFFER_SIZE	_IOW ('U', 118, int)
293 #define	USB_SET_RX_STALL_FLAG	_IOW ('U', 119, int)
294 #define	USB_SET_TX_STALL_FLAG	_IOW ('U', 120, int)
295 #define	USB_GET_IFACE_DRIVER	_IOWR('U', 121, struct usb_gen_descriptor)
296 #define	USB_CLAIM_INTERFACE	_IOW ('U', 122, int)
297 #define	USB_RELEASE_INTERFACE	_IOW ('U', 123, int)
298 #define	USB_IFACE_DRIVER_ACTIVE	_IOW ('U', 124, int)
299 #define	USB_IFACE_DRIVER_DETACH	_IOW ('U', 125, int)
300 #define	USB_GET_PLUGTIME	_IOR ('U', 126, uint32_t)
301 #define	USB_READ_DIR		_IOW ('U', 127, struct usb_read_dir)
302 /* 128 - 133 unused */
303 #define	USB_GET_DEV_PORT_PATH	_IOR ('U', 134, struct usb_device_port_path)
304 #define	USB_GET_POWER_USAGE	_IOR ('U', 135, int)
305 #define	USB_SET_TX_FORCE_SHORT	_IOW ('U', 136, int)
306 #define	USB_SET_TX_TIMEOUT	_IOW ('U', 137, int)
307 #define	USB_GET_TX_FRAME_SIZE	_IOR ('U', 138, int)
308 #define	USB_GET_TX_BUFFER_SIZE	_IOR ('U', 139, int)
309 #define	USB_SET_TX_BUFFER_SIZE	_IOW ('U', 140, int)
310 #define	USB_GET_TX_INTERFACE_DESC _IOR ('U', 141, struct usb_interface_descriptor)
311 #define	USB_GET_TX_ENDPOINT_DESC _IOR ('U', 142, struct usb_endpoint_descriptor)
312 #define	USB_SET_PORT_ENABLE	_IOW ('U', 143, int)
313 #define	USB_SET_PORT_DISABLE	_IOW ('U', 144, int)
314 #define	USB_SET_POWER_MODE	_IOW ('U', 145, int)
315 #define	USB_GET_POWER_MODE	_IOR ('U', 146, int)
316 #define	USB_SET_TEMPLATE	_IOW ('U', 147, int)
317 #define	USB_GET_TEMPLATE	_IOR ('U', 148, int)
318 
319 /* Modem device */
320 #define	USB_GET_CM_OVER_DATA	_IOR ('U', 180, int)
321 #define	USB_SET_CM_OVER_DATA	_IOW ('U', 181, int)
322 
323 /* GPIO control */
324 #define	USB_GET_GPIO		_IOR ('U', 182, int)
325 #define	USB_SET_GPIO		_IOW ('U', 183, int)
326 
327 /* USB file system interface */
328 #define	USB_FS_START		_IOW ('U', 192, struct usb_fs_start)
329 #define	USB_FS_STOP		_IOW ('U', 193, struct usb_fs_stop)
330 #define	USB_FS_COMPLETE		_IOR ('U', 194, struct usb_fs_complete)
331 #define	USB_FS_INIT		_IOW ('U', 195, struct usb_fs_init)
332 #define	USB_FS_UNINIT		_IOW ('U', 196, struct usb_fs_uninit)
333 #define	USB_FS_OPEN		_IOWR('U', 197, struct usb_fs_open)
334 #define	USB_FS_CLOSE		_IOW ('U', 198, struct usb_fs_close)
335 #define	USB_FS_CLEAR_STALL_SYNC _IOW ('U', 199, struct usb_fs_clear_stall_sync)
336 #define	USB_FS_OPEN_STREAM	_IOWR('U', 200, struct usb_fs_open_stream)
337 
338 /* USB quirk system interface */
339 #define	USB_DEV_QUIRK_GET	_IOWR('Q', 0, struct usb_gen_quirk)
340 #define	USB_QUIRK_NAME_GET	_IOWR('Q', 1, struct usb_gen_quirk)
341 #define	USB_DEV_QUIRK_ADD	_IOW ('Q', 2, struct usb_gen_quirk)
342 #define	USB_DEV_QUIRK_REMOVE	_IOW ('Q', 3, struct usb_gen_quirk)
343 
344 #endif					/* _USB_IOCTL_H_ */
345