usb4bsd: Adjust header paths in libusbhid, usbhidctl, and public headers.
[dragonfly.git] / sys / bus / u4b / usb_ioctl.h
CommitLineData
12bd3c8b
SW
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#include <sys/ioccom.h>
33
34/* Building "kdump" depends on these includes */
35
3186c89e
SW
36#include <bus/u4b/usb_endian.h>
37#include <bus/u4b/usb.h>
12bd3c8b
SW
38
39#define USB_DEVICE_NAME "usbctl"
40#define USB_DEVICE_DIR "usb"
41#define USB_GENERIC_NAME "ugen"
42#define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */
43
44/* Definition of valid template sysctl values */
45
46enum {
47 USB_TEMP_MSC, /* USB Mass Storage */
48 USB_TEMP_CDCE, /* USB CDC Ethernet */
49 USB_TEMP_MTP, /* Message Transfer Protocol */
50 USB_TEMP_MODEM, /* USB CDC Modem */
51 USB_TEMP_AUDIO, /* USB Audio */
52 USB_TEMP_KBD, /* USB Keyboard */
53 USB_TEMP_MOUSE, /* USB Mouse */
54 USB_TEMP_MAX,
55};
56
57struct usb_read_dir {
58#ifdef COMPAT_32BIT
59 uint64_t urd_data;
60#else
61 void *urd_data;
62#endif
63 uint32_t urd_startentry;
64 uint32_t urd_maxlen;
65};
66
67struct usb_ctl_request {
68#ifdef COMPAT_32BIT
69 uint64_t ucr_data;
70#else
71 void *ucr_data;
72#endif
73 uint16_t ucr_flags;
74 uint16_t ucr_actlen; /* actual length transferred */
75 uint8_t ucr_addr; /* zero - currently not used */
76 struct usb_device_request ucr_request;
77};
78
79struct usb_alt_interface {
80 uint8_t uai_interface_index;
81 uint8_t uai_alt_index;
82};
83
84struct usb_gen_descriptor {
85#ifdef COMPAT_32BIT
86 uint64_t ugd_data;
87#else
88 void *ugd_data;
89#endif
90 uint16_t ugd_lang_id;
91 uint16_t ugd_maxlen;
92 uint16_t ugd_actlen;
93 uint16_t ugd_offset;
94 uint8_t ugd_config_index;
95 uint8_t ugd_string_index;
96 uint8_t ugd_iface_index;
97 uint8_t ugd_altif_index;
98 uint8_t ugd_endpt_index;
99 uint8_t ugd_report_type;
100 uint8_t reserved[8];
101};
102
103struct usb_device_info {
104 uint16_t udi_productNo;
105 uint16_t udi_vendorNo;
106 uint16_t udi_releaseNo;
107 uint16_t udi_power; /* power consumption in mA, 0 if
108 * selfpowered */
109 uint8_t udi_bus;
110 uint8_t udi_addr; /* device address */
111 uint8_t udi_index; /* device index */
112 uint8_t udi_class;
113 uint8_t udi_subclass;
114 uint8_t udi_protocol;
115 uint8_t udi_config_no; /* current config number */
116 uint8_t udi_config_index; /* current config index */
117 uint8_t udi_speed; /* see "USB_SPEED_XXX" */
118 uint8_t udi_mode; /* see "USB_MODE_XXX" */
119 uint8_t udi_nports;
120 uint8_t udi_hubaddr; /* parent HUB address */
121 uint8_t udi_hubindex; /* parent HUB device index */
122 uint8_t udi_hubport; /* parent HUB port */
123 uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */
124 uint8_t udi_suspended; /* set if device is suspended */
125 uint8_t udi_reserved[16]; /* leave space for the future */
126 char udi_product[128];
127 char udi_vendor[128];
128 char udi_serial[64];
129 char udi_release[8];
130};
131
132struct usb_device_stats {
133 uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */
134 uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */
135};
136
137struct usb_fs_start {
138 uint8_t ep_index;
139};
140
141struct usb_fs_stop {
142 uint8_t ep_index;
143};
144
145struct usb_fs_complete {
146 uint8_t ep_index;
147};
148
149/* This structure is used for all endpoint types */
150struct usb_fs_endpoint {
151 /*
152 * NOTE: isochronous USB transfer only use one buffer, but can have
153 * multiple frame lengths !
154 */
155#ifdef COMPAT_32BIT
156 uint64_t ppBuffer;
157 uint64_t pLength;
158#else
159 void **ppBuffer; /* pointer to userland buffers */
160 uint32_t *pLength; /* pointer to frame lengths, updated
161 * to actual length */
162#endif
163 uint32_t nFrames; /* number of frames */
164 uint32_t aFrames; /* actual number of frames */
165 uint16_t flags;
166 /* a single short frame will terminate */
167#define USB_FS_FLAG_SINGLE_SHORT_OK 0x0001
168 /* multiple short frames are allowed */
169#define USB_FS_FLAG_MULTI_SHORT_OK 0x0002
170 /* all frame(s) transmitted are short terminated */
171#define USB_FS_FLAG_FORCE_SHORT 0x0004
172 /* will do a clear-stall before xfer */
173#define USB_FS_FLAG_CLEAR_STALL 0x0008
174 uint16_t timeout; /* in milliseconds */
175 /* isocronous completion time in milliseconds - used for echo cancel */
176 uint16_t isoc_time_complete;
177 /* timeout value for no timeout */
178#define USB_FS_TIMEOUT_NONE 0
179 int status; /* see USB_ERR_XXX */
180};
181
182struct usb_fs_init {
183 /* userland pointer to endpoints structure */
184#ifdef COMPAT_32BIT
185 uint64_t pEndpoints;
186#else
187 struct usb_fs_endpoint *pEndpoints;
188#endif
189 /* maximum number of endpoints */
190 uint8_t ep_index_max;
191};
192
193struct usb_fs_uninit {
194 uint8_t dummy; /* zero */
195};
196
197struct usb_fs_open {
198#define USB_FS_MAX_BUFSIZE (1 << 18)
199 uint32_t max_bufsize;
200#define USB_FS_MAX_FRAMES (1U << 12)
201#define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */
202 uint32_t max_frames; /* read and write */
203 uint16_t max_packet_length; /* read only */
204 uint8_t dev_index; /* currently unused */
205 uint8_t ep_index;
206 uint8_t ep_no; /* bEndpointNumber */
207};
208
209struct usb_fs_close {
210 uint8_t ep_index;
211};
212
213struct usb_fs_clear_stall_sync {
214 uint8_t ep_index;
215};
216
217struct usb_gen_quirk {
218 uint16_t index; /* Quirk Index */
219 uint16_t vid; /* Vendor ID */
220 uint16_t pid; /* Product ID */
221 uint16_t bcdDeviceLow; /* Low Device Revision */
222 uint16_t bcdDeviceHigh; /* High Device Revision */
223 uint16_t reserved[2];
224 /*
225 * String version of quirk including terminating zero. See UQ_XXX in
226 * "usb_quirk.h".
227 */
228 char quirkname[64 - 14];
229};
230
231/* USB controller */
232#define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
233#define USB_SETDEBUG _IOW ('U', 2, int)
234#define USB_DISCOVER _IO ('U', 3)
235#define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
236#define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
237#define USB_DEVICEENUMERATE _IOW ('U', 6, int)
238
239/* Generic HID device */
240#define USB_GET_REPORT_DESC _IOWR('U', 21, struct usb_gen_descriptor)
241#define USB_SET_IMMED _IOW ('U', 22, int)
242#define USB_GET_REPORT _IOWR('U', 23, struct usb_gen_descriptor)
243#define USB_SET_REPORT _IOW ('U', 24, struct usb_gen_descriptor)
244#define USB_GET_REPORT_ID _IOR ('U', 25, int)
245
246/* Generic USB device */
247#define USB_GET_CONFIG _IOR ('U', 100, int)
248#define USB_SET_CONFIG _IOW ('U', 101, int)
249#define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface)
250#define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface)
251#define USB_GET_DEVICE_DESC _IOR ('U', 105, struct usb_device_descriptor)
252#define USB_GET_CONFIG_DESC _IOR ('U', 106, struct usb_config_descriptor)
253#define USB_GET_RX_INTERFACE_DESC _IOR ('U', 107, struct usb_interface_descriptor)
254#define USB_GET_RX_ENDPOINT_DESC _IOR ('U', 108, struct usb_endpoint_descriptor)
255#define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_gen_descriptor)
256#define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_gen_descriptor)
257#define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request)
258#define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info)
259#define USB_SET_RX_SHORT_XFER _IOW ('U', 113, int)
260#define USB_SET_RX_TIMEOUT _IOW ('U', 114, int)
261#define USB_GET_RX_FRAME_SIZE _IOR ('U', 115, int)
262#define USB_GET_RX_BUFFER_SIZE _IOR ('U', 117, int)
263#define USB_SET_RX_BUFFER_SIZE _IOW ('U', 118, int)
264#define USB_SET_RX_STALL_FLAG _IOW ('U', 119, int)
265#define USB_SET_TX_STALL_FLAG _IOW ('U', 120, int)
266#define USB_GET_IFACE_DRIVER _IOWR('U', 121, struct usb_gen_descriptor)
267#define USB_CLAIM_INTERFACE _IOW ('U', 122, int)
268#define USB_RELEASE_INTERFACE _IOW ('U', 123, int)
269#define USB_IFACE_DRIVER_ACTIVE _IOW ('U', 124, int)
270#define USB_IFACE_DRIVER_DETACH _IOW ('U', 125, int)
271#define USB_GET_PLUGTIME _IOR ('U', 126, uint32_t)
272#define USB_READ_DIR _IOW ('U', 127, struct usb_read_dir)
273/* 128 - 135 unused */
274#define USB_SET_TX_FORCE_SHORT _IOW ('U', 136, int)
275#define USB_SET_TX_TIMEOUT _IOW ('U', 137, int)
276#define USB_GET_TX_FRAME_SIZE _IOR ('U', 138, int)
277#define USB_GET_TX_BUFFER_SIZE _IOR ('U', 139, int)
278#define USB_SET_TX_BUFFER_SIZE _IOW ('U', 140, int)
279#define USB_GET_TX_INTERFACE_DESC _IOR ('U', 141, struct usb_interface_descriptor)
280#define USB_GET_TX_ENDPOINT_DESC _IOR ('U', 142, struct usb_endpoint_descriptor)
281#define USB_SET_PORT_ENABLE _IOW ('U', 143, int)
282#define USB_SET_PORT_DISABLE _IOW ('U', 144, int)
283#define USB_SET_POWER_MODE _IOW ('U', 145, int)
284#define USB_GET_POWER_MODE _IOR ('U', 146, int)
285#define USB_SET_TEMPLATE _IOW ('U', 147, int)
286#define USB_GET_TEMPLATE _IOR ('U', 148, int)
287
288/* Modem device */
289#define USB_GET_CM_OVER_DATA _IOR ('U', 180, int)
290#define USB_SET_CM_OVER_DATA _IOW ('U', 181, int)
291
292/* GPIO control */
293#define USB_GET_GPIO _IOR ('U', 182, int)
294#define USB_SET_GPIO _IOW ('U', 183, int)
295
296/* USB file system interface */
297#define USB_FS_START _IOW ('U', 192, struct usb_fs_start)
298#define USB_FS_STOP _IOW ('U', 193, struct usb_fs_stop)
299#define USB_FS_COMPLETE _IOR ('U', 194, struct usb_fs_complete)
300#define USB_FS_INIT _IOW ('U', 195, struct usb_fs_init)
301#define USB_FS_UNINIT _IOW ('U', 196, struct usb_fs_uninit)
302#define USB_FS_OPEN _IOWR('U', 197, struct usb_fs_open)
303#define USB_FS_CLOSE _IOW ('U', 198, struct usb_fs_close)
304#define USB_FS_CLEAR_STALL_SYNC _IOW ('U', 199, struct usb_fs_clear_stall_sync)
305
306/* USB quirk system interface */
307#define USB_DEV_QUIRK_GET _IOWR('Q', 0, struct usb_gen_quirk)
308#define USB_QUIRK_NAME_GET _IOWR('Q', 1, struct usb_gen_quirk)
309#define USB_DEV_QUIRK_ADD _IOW ('Q', 2, struct usb_gen_quirk)
310#define USB_DEV_QUIRK_REMOVE _IOW ('Q', 3, struct usb_gen_quirk)
311
312#endif /* _USB_IOCTL_H_ */