1/* $FreeBSD: head/sys/dev/usb/usb_ioctl.h 250201 2013-05-03 07:44:58Z hselasky $ */
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:
--- 16 unchanged lines hidden (view full) ---
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
35/* Building "kdump" depends on these includes */
36
37#include <dev/usb/usb_endian.h>
38#include <dev/usb/usb.h>
39#endif
40
41#define USB_DEVICE_NAME "usbctl"
42#define USB_DEVICE_DIR "usb"
43#define USB_GENERIC_NAME "ugen"
44#define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */
45
46/* Definition of valid template sysctl values */
47
48enum {
49 USB_TEMP_MSC, /* USB Mass Storage */
50 USB_TEMP_CDCE, /* USB CDC Ethernet */
51 USB_TEMP_MTP, /* Message Transfer Protocol */
52 USB_TEMP_MODEM, /* USB CDC Modem */
53 USB_TEMP_AUDIO, /* USB Audio */
--- 5 unchanged lines hidden (view full) ---
59struct usb_read_dir {
60#ifdef COMPAT_32BIT
61 uint64_t urd_data;
62#else
63 void *urd_data;
64#endif
65 uint32_t urd_startentry;
66 uint32_t urd_maxlen;
67};
68
69struct usb_ctl_request {
70#ifdef COMPAT_32BIT
71 uint64_t ucr_data;
72#else
73 void *ucr_data;
74#endif
75 uint16_t ucr_flags;
76 uint16_t ucr_actlen; /* actual length transferred */
77 uint8_t ucr_addr; /* zero - currently not used */
78 struct usb_device_request ucr_request;
79};
80
81struct usb_alt_interface {
82 uint8_t uai_interface_index;
83 uint8_t uai_alt_index;
84};
85
86struct usb_gen_descriptor {
87#ifdef COMPAT_32BIT
88 uint64_t ugd_data;
89#else
90 void *ugd_data;
91#endif
92 uint16_t ugd_lang_id;
93 uint16_t ugd_maxlen;
94 uint16_t ugd_actlen;
95 uint16_t ugd_offset;
96 uint8_t ugd_config_index;
97 uint8_t ugd_string_index;
98 uint8_t ugd_iface_index;
99 uint8_t ugd_altif_index;
100 uint8_t ugd_endpt_index;
101 uint8_t ugd_report_type;
102 uint8_t reserved[8];
103};
104
105struct usb_device_info {
106 uint16_t udi_productNo;
107 uint16_t udi_vendorNo;
108 uint16_t udi_releaseNo;
109 uint16_t udi_power; /* power consumption in mA, 0 if
110 * selfpowered */
111 uint8_t udi_bus;
--- 12 unchanged lines hidden (view full) ---
124 uint8_t udi_hubport; /* parent HUB port */
125 uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */
126 uint8_t udi_suspended; /* set if device is suspended */
127 uint8_t udi_reserved[16]; /* leave space for the future */
128 char udi_product[128];
129 char udi_vendor[128];
130 char udi_serial[64];
131 char udi_release[8];
132};
133
134#define USB_DEVICE_PORT_PATH_MAX 32
135
136struct usb_device_port_path {
137 uint8_t udp_bus; /* which bus we are on */
138 uint8_t udp_index; /* which device index */
139 uint8_t udp_port_level; /* how many levels: 0, 1, 2 ... */
140 uint8_t udp_port_no[USB_DEVICE_PORT_PATH_MAX];
141};
142
143struct usb_device_stats {
144 uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */
145 uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */
146};
147
148struct usb_fs_start {
149 uint8_t ep_index;
150};
151
152struct usb_fs_stop {
153 uint8_t ep_index;
154};
155
156struct usb_fs_complete {
157 uint8_t ep_index;
158};
159
160/* This structure is used for all endpoint types */
161struct usb_fs_endpoint {
162 /*
163 * NOTE: isochronous USB transfer only use one buffer, but can have
164 * multiple frame lengths !
165 */
166#ifdef COMPAT_32BIT
--- 16 unchanged lines hidden (view full) ---
183 /* will do a clear-stall before xfer */
184#define USB_FS_FLAG_CLEAR_STALL 0x0008
185 uint16_t timeout; /* in milliseconds */
186 /* isocronous completion time in milliseconds - used for echo cancel */
187 uint16_t isoc_time_complete;
188 /* timeout value for no timeout */
189#define USB_FS_TIMEOUT_NONE 0
190 int status; /* see USB_ERR_XXX */
191};
192
193struct usb_fs_init {
194 /* userland pointer to endpoints structure */
195#ifdef COMPAT_32BIT
196 uint64_t pEndpoints;
197#else
198 struct usb_fs_endpoint *pEndpoints;
199#endif
200 /* maximum number of endpoints */
201 uint8_t ep_index_max;
202};
203
204struct usb_fs_uninit {
205 uint8_t dummy; /* zero */
206};
207
208struct usb_fs_open {
209#define USB_FS_MAX_BUFSIZE (1 << 18)
210 uint32_t max_bufsize;
211#define USB_FS_MAX_FRAMES (1U << 12)
212#define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */
213 uint32_t max_frames; /* read and write */
214 uint16_t max_packet_length; /* read only */
215 uint8_t dev_index; /* currently unused */
216 uint8_t ep_index;
217 uint8_t ep_no; /* bEndpointNumber */
218};
219
220struct usb_fs_open_stream {
221 struct usb_fs_open fs_open;
222 uint16_t stream_id;
223};
224
225struct usb_fs_close {
226 uint8_t ep_index;
227};
228
229struct usb_fs_clear_stall_sync {
230 uint8_t ep_index;
231};
232
233struct usb_gen_quirk {
234 uint16_t index; /* Quirk Index */
235 uint16_t vid; /* Vendor ID */
236 uint16_t pid; /* Product ID */
237 uint16_t bcdDeviceLow; /* Low Device Revision */
238 uint16_t bcdDeviceHigh; /* High Device Revision */
239 uint16_t reserved[2];
240 /*
241 * String version of quirk including terminating zero. See UQ_XXX in
242 * "usb_quirk.h".
243 */
244 char quirkname[64 - 14];
245};
246
247/* USB controller */
248#define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
249#define USB_SETDEBUG _IOW ('U', 2, int)
250#define USB_DISCOVER _IO ('U', 3)
251#define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
252#define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
253#define USB_DEVICEENUMERATE _IOW ('U', 6, int)
--- 78 unchanged lines hidden ---
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:
--- 16 unchanged lines hidden (view full) ---
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
35/* Building "kdump" depends on these includes */
36
37#include <dev/usb/usb_endian.h>
38#include <dev/usb/usb.h>
39#endif
40
41#define USB_DEVICE_NAME "usbctl"
42#define USB_DEVICE_DIR "usb"
43#define USB_GENERIC_NAME "ugen"
44#define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */
45
46/* Definition of valid template sysctl values */
47
48enum {
49 USB_TEMP_MSC, /* USB Mass Storage */
50 USB_TEMP_CDCE, /* USB CDC Ethernet */
51 USB_TEMP_MTP, /* Message Transfer Protocol */
52 USB_TEMP_MODEM, /* USB CDC Modem */
53 USB_TEMP_AUDIO, /* USB Audio */
--- 5 unchanged lines hidden (view full) ---
59struct usb_read_dir {
60#ifdef COMPAT_32BIT
61 uint64_t urd_data;
62#else
63 void *urd_data;
64#endif
65 uint32_t urd_startentry;
66 uint32_t urd_maxlen;
67};
68
69struct usb_ctl_request {
70#ifdef COMPAT_32BIT
71 uint64_t ucr_data;
72#else
73 void *ucr_data;
74#endif
75 uint16_t ucr_flags;
76 uint16_t ucr_actlen; /* actual length transferred */
77 uint8_t ucr_addr; /* zero - currently not used */
78 struct usb_device_request ucr_request;
79};
80
81struct usb_alt_interface {
82 uint8_t uai_interface_index;
83 uint8_t uai_alt_index;
84};
85
86struct usb_gen_descriptor {
87#ifdef COMPAT_32BIT
88 uint64_t ugd_data;
89#else
90 void *ugd_data;
91#endif
92 uint16_t ugd_lang_id;
93 uint16_t ugd_maxlen;
94 uint16_t ugd_actlen;
95 uint16_t ugd_offset;
96 uint8_t ugd_config_index;
97 uint8_t ugd_string_index;
98 uint8_t ugd_iface_index;
99 uint8_t ugd_altif_index;
100 uint8_t ugd_endpt_index;
101 uint8_t ugd_report_type;
102 uint8_t reserved[8];
103};
104
105struct usb_device_info {
106 uint16_t udi_productNo;
107 uint16_t udi_vendorNo;
108 uint16_t udi_releaseNo;
109 uint16_t udi_power; /* power consumption in mA, 0 if
110 * selfpowered */
111 uint8_t udi_bus;
--- 12 unchanged lines hidden (view full) ---
124 uint8_t udi_hubport; /* parent HUB port */
125 uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */
126 uint8_t udi_suspended; /* set if device is suspended */
127 uint8_t udi_reserved[16]; /* leave space for the future */
128 char udi_product[128];
129 char udi_vendor[128];
130 char udi_serial[64];
131 char udi_release[8];
132};
133
134#define USB_DEVICE_PORT_PATH_MAX 32
135
136struct usb_device_port_path {
137 uint8_t udp_bus; /* which bus we are on */
138 uint8_t udp_index; /* which device index */
139 uint8_t udp_port_level; /* how many levels: 0, 1, 2 ... */
140 uint8_t udp_port_no[USB_DEVICE_PORT_PATH_MAX];
141};
142
143struct usb_device_stats {
144 uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */
145 uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */
146};
147
148struct usb_fs_start {
149 uint8_t ep_index;
150};
151
152struct usb_fs_stop {
153 uint8_t ep_index;
154};
155
156struct usb_fs_complete {
157 uint8_t ep_index;
158};
159
160/* This structure is used for all endpoint types */
161struct usb_fs_endpoint {
162 /*
163 * NOTE: isochronous USB transfer only use one buffer, but can have
164 * multiple frame lengths !
165 */
166#ifdef COMPAT_32BIT
--- 16 unchanged lines hidden (view full) ---
183 /* will do a clear-stall before xfer */
184#define USB_FS_FLAG_CLEAR_STALL 0x0008
185 uint16_t timeout; /* in milliseconds */
186 /* isocronous completion time in milliseconds - used for echo cancel */
187 uint16_t isoc_time_complete;
188 /* timeout value for no timeout */
189#define USB_FS_TIMEOUT_NONE 0
190 int status; /* see USB_ERR_XXX */
191};
192
193struct usb_fs_init {
194 /* userland pointer to endpoints structure */
195#ifdef COMPAT_32BIT
196 uint64_t pEndpoints;
197#else
198 struct usb_fs_endpoint *pEndpoints;
199#endif
200 /* maximum number of endpoints */
201 uint8_t ep_index_max;
202};
203
204struct usb_fs_uninit {
205 uint8_t dummy; /* zero */
206};
207
208struct usb_fs_open {
209#define USB_FS_MAX_BUFSIZE (1 << 18)
210 uint32_t max_bufsize;
211#define USB_FS_MAX_FRAMES (1U << 12)
212#define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */
213 uint32_t max_frames; /* read and write */
214 uint16_t max_packet_length; /* read only */
215 uint8_t dev_index; /* currently unused */
216 uint8_t ep_index;
217 uint8_t ep_no; /* bEndpointNumber */
218};
219
220struct usb_fs_open_stream {
221 struct usb_fs_open fs_open;
222 uint16_t stream_id;
223};
224
225struct usb_fs_close {
226 uint8_t ep_index;
227};
228
229struct usb_fs_clear_stall_sync {
230 uint8_t ep_index;
231};
232
233struct usb_gen_quirk {
234 uint16_t index; /* Quirk Index */
235 uint16_t vid; /* Vendor ID */
236 uint16_t pid; /* Product ID */
237 uint16_t bcdDeviceLow; /* Low Device Revision */
238 uint16_t bcdDeviceHigh; /* High Device Revision */
239 uint16_t reserved[2];
240 /*
241 * String version of quirk including terminating zero. See UQ_XXX in
242 * "usb_quirk.h".
243 */
244 char quirkname[64 - 14];
245};
246
247/* USB controller */
248#define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
249#define USB_SETDEBUG _IOW ('U', 2, int)
250#define USB_DISCOVER _IO ('U', 3)
251#define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
252#define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
253#define USB_DEVICEENUMERATE _IOW ('U', 6, int)
--- 78 unchanged lines hidden ---