1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_USB_H 2 #ifndef __LINUX_USB_H
3 #define __LINUX_USB_H 3 #define __LINUX_USB_H
4 4
5 #include <linux/mod_devicetable.h> 5 #include <linux/mod_devicetable.h>
6 #include <linux/usb/ch9.h> 6 #include <linux/usb/ch9.h>
7 7
8 #define USB_MAJOR 180 8 #define USB_MAJOR 180
9 #define USB_DEVICE_MAJOR 189 9 #define USB_DEVICE_MAJOR 189
10 10
11 11
12 #ifdef __KERNEL__ 12 #ifdef __KERNEL__
13 13
14 #include <linux/errno.h> /* for -ENODEV 14 #include <linux/errno.h> /* for -ENODEV */
15 #include <linux/delay.h> /* for mdelay( 15 #include <linux/delay.h> /* for mdelay() */
16 #include <linux/interrupt.h> /* for in_inte 16 #include <linux/interrupt.h> /* for in_interrupt() */
17 #include <linux/list.h> /* for struct 17 #include <linux/list.h> /* for struct list_head */
18 #include <linux/kref.h> /* for struct 18 #include <linux/kref.h> /* for struct kref */
19 #include <linux/device.h> /* for struct 19 #include <linux/device.h> /* for struct device */
20 #include <linux/fs.h> /* for struct 20 #include <linux/fs.h> /* for struct file_operations */
21 #include <linux/completion.h> /* for struct 21 #include <linux/completion.h> /* for struct completion */
22 #include <linux/sched.h> /* for current 22 #include <linux/sched.h> /* for current && schedule_timeout */
23 #include <linux/mutex.h> /* for struct 23 #include <linux/mutex.h> /* for struct mutex */
24 #include <linux/pm_runtime.h> /* for runtime 24 #include <linux/pm_runtime.h> /* for runtime PM */
25 25
26 struct usb_device; 26 struct usb_device;
27 struct usb_driver; 27 struct usb_driver;
28 28
29 /*-------------------------------------------- 29 /*-------------------------------------------------------------------------*/
30 30
31 /* 31 /*
32 * Host-side wrappers for standard USB descrip 32 * Host-side wrappers for standard USB descriptors ... these are parsed
33 * from the data provided by devices. Parsing 33 * from the data provided by devices. Parsing turns them from a flat
34 * sequence of descriptors into a hierarchy: 34 * sequence of descriptors into a hierarchy:
35 * 35 *
36 * - devices have one (usually) or more confi 36 * - devices have one (usually) or more configs;
37 * - configs have one (often) or more interfa 37 * - configs have one (often) or more interfaces;
38 * - interfaces have one (usually) or more se 38 * - interfaces have one (usually) or more settings;
39 * - each interface setting has zero or (usua 39 * - each interface setting has zero or (usually) more endpoints.
40 * - a SuperSpeed endpoint has a companion de 40 * - a SuperSpeed endpoint has a companion descriptor
41 * 41 *
42 * And there might be other descriptors mixed 42 * And there might be other descriptors mixed in with those.
43 * 43 *
44 * Devices may also have class-specific or ven 44 * Devices may also have class-specific or vendor-specific descriptors.
45 */ 45 */
46 46
47 struct ep_device; 47 struct ep_device;
48 48
49 /** 49 /**
50 * struct usb_host_endpoint - host-side endpoi 50 * struct usb_host_endpoint - host-side endpoint descriptor and queue
51 * @desc: descriptor for this endpoint, wMaxPa 51 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
52 * @ss_ep_comp: SuperSpeed companion descripto 52 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
53 * @ssp_isoc_ep_comp: SuperSpeedPlus isoc comp 53 * @ssp_isoc_ep_comp: SuperSpeedPlus isoc companion descriptor for this endpoint
54 * @urb_list: urbs queued to this endpoint; ma 54 * @urb_list: urbs queued to this endpoint; maintained by usbcore
55 * @hcpriv: for use by HCD; typically holds ha 55 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
56 * with one or more transfer descriptors 56 * with one or more transfer descriptors (TDs) per urb
57 * @ep_dev: ep_device for sysfs info 57 * @ep_dev: ep_device for sysfs info
58 * @extra: descriptors following this endpoint 58 * @extra: descriptors following this endpoint in the configuration
59 * @extralen: how many bytes of "extra" are va 59 * @extralen: how many bytes of "extra" are valid
60 * @enabled: URBs may be submitted to this end 60 * @enabled: URBs may be submitted to this endpoint
61 * @streams: number of USB-3 streams allocated 61 * @streams: number of USB-3 streams allocated on the endpoint
62 * 62 *
63 * USB requests are always queued to a given e 63 * USB requests are always queued to a given endpoint, identified by a
64 * descriptor within an active interface in a 64 * descriptor within an active interface in a given USB configuration.
65 */ 65 */
66 struct usb_host_endpoint { 66 struct usb_host_endpoint {
67 struct usb_endpoint_descriptor 67 struct usb_endpoint_descriptor desc;
68 struct usb_ss_ep_comp_descriptor 68 struct usb_ss_ep_comp_descriptor ss_ep_comp;
69 struct usb_ssp_isoc_ep_comp_descriptor 69 struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp;
70 struct list_head urb_li 70 struct list_head urb_list;
71 void *hcpri 71 void *hcpriv;
72 struct ep_device *ep_de 72 struct ep_device *ep_dev; /* For sysfs info */
73 73
74 unsigned char *extra; /* Extra descr 74 unsigned char *extra; /* Extra descriptors */
75 int extralen; 75 int extralen;
76 int enabled; 76 int enabled;
77 int streams; 77 int streams;
78 }; 78 };
79 79
80 /* host-side wrapper for one interface setting 80 /* host-side wrapper for one interface setting's parsed descriptors */
81 struct usb_host_interface { 81 struct usb_host_interface {
82 struct usb_interface_descriptor desc; 82 struct usb_interface_descriptor desc;
83 83
84 int extralen; 84 int extralen;
85 unsigned char *extra; /* Extra descr 85 unsigned char *extra; /* Extra descriptors */
86 86
87 /* array of desc.bNumEndpoints endpoin 87 /* array of desc.bNumEndpoints endpoints associated with this
88 * interface setting. these will be i 88 * interface setting. these will be in no particular order.
89 */ 89 */
90 struct usb_host_endpoint *endpoint; 90 struct usb_host_endpoint *endpoint;
91 91
92 char *string; /* iInterface 92 char *string; /* iInterface string, if present */
93 }; 93 };
94 94
95 enum usb_interface_condition { 95 enum usb_interface_condition {
96 USB_INTERFACE_UNBOUND = 0, 96 USB_INTERFACE_UNBOUND = 0,
97 USB_INTERFACE_BINDING, 97 USB_INTERFACE_BINDING,
98 USB_INTERFACE_BOUND, 98 USB_INTERFACE_BOUND,
99 USB_INTERFACE_UNBINDING, 99 USB_INTERFACE_UNBINDING,
100 }; 100 };
101 101
102 int __must_check 102 int __must_check
103 usb_find_common_endpoints(struct usb_host_inte 103 usb_find_common_endpoints(struct usb_host_interface *alt,
104 struct usb_endpoint_descriptor 104 struct usb_endpoint_descriptor **bulk_in,
105 struct usb_endpoint_descriptor 105 struct usb_endpoint_descriptor **bulk_out,
106 struct usb_endpoint_descriptor 106 struct usb_endpoint_descriptor **int_in,
107 struct usb_endpoint_descriptor 107 struct usb_endpoint_descriptor **int_out);
108 108
109 int __must_check 109 int __must_check
110 usb_find_common_endpoints_reverse(struct usb_h 110 usb_find_common_endpoints_reverse(struct usb_host_interface *alt,
111 struct usb_endpoint_descriptor 111 struct usb_endpoint_descriptor **bulk_in,
112 struct usb_endpoint_descriptor 112 struct usb_endpoint_descriptor **bulk_out,
113 struct usb_endpoint_descriptor 113 struct usb_endpoint_descriptor **int_in,
114 struct usb_endpoint_descriptor 114 struct usb_endpoint_descriptor **int_out);
115 115
116 static inline int __must_check 116 static inline int __must_check
117 usb_find_bulk_in_endpoint(struct usb_host_inte 117 usb_find_bulk_in_endpoint(struct usb_host_interface *alt,
118 struct usb_endpoint_descriptor 118 struct usb_endpoint_descriptor **bulk_in)
119 { 119 {
120 return usb_find_common_endpoints(alt, 120 return usb_find_common_endpoints(alt, bulk_in, NULL, NULL, NULL);
121 } 121 }
122 122
123 static inline int __must_check 123 static inline int __must_check
124 usb_find_bulk_out_endpoint(struct usb_host_int 124 usb_find_bulk_out_endpoint(struct usb_host_interface *alt,
125 struct usb_endpoint_descriptor 125 struct usb_endpoint_descriptor **bulk_out)
126 { 126 {
127 return usb_find_common_endpoints(alt, 127 return usb_find_common_endpoints(alt, NULL, bulk_out, NULL, NULL);
128 } 128 }
129 129
130 static inline int __must_check 130 static inline int __must_check
131 usb_find_int_in_endpoint(struct usb_host_inter 131 usb_find_int_in_endpoint(struct usb_host_interface *alt,
132 struct usb_endpoint_descriptor 132 struct usb_endpoint_descriptor **int_in)
133 { 133 {
134 return usb_find_common_endpoints(alt, 134 return usb_find_common_endpoints(alt, NULL, NULL, int_in, NULL);
135 } 135 }
136 136
137 static inline int __must_check 137 static inline int __must_check
138 usb_find_int_out_endpoint(struct usb_host_inte 138 usb_find_int_out_endpoint(struct usb_host_interface *alt,
139 struct usb_endpoint_descriptor 139 struct usb_endpoint_descriptor **int_out)
140 { 140 {
141 return usb_find_common_endpoints(alt, 141 return usb_find_common_endpoints(alt, NULL, NULL, NULL, int_out);
142 } 142 }
143 143
144 static inline int __must_check 144 static inline int __must_check
145 usb_find_last_bulk_in_endpoint(struct usb_host 145 usb_find_last_bulk_in_endpoint(struct usb_host_interface *alt,
146 struct usb_endpoint_descriptor 146 struct usb_endpoint_descriptor **bulk_in)
147 { 147 {
148 return usb_find_common_endpoints_rever 148 return usb_find_common_endpoints_reverse(alt, bulk_in, NULL, NULL, NULL);
149 } 149 }
150 150
151 static inline int __must_check 151 static inline int __must_check
152 usb_find_last_bulk_out_endpoint(struct usb_hos 152 usb_find_last_bulk_out_endpoint(struct usb_host_interface *alt,
153 struct usb_endpoint_descriptor 153 struct usb_endpoint_descriptor **bulk_out)
154 { 154 {
155 return usb_find_common_endpoints_rever 155 return usb_find_common_endpoints_reverse(alt, NULL, bulk_out, NULL, NULL);
156 } 156 }
157 157
158 static inline int __must_check 158 static inline int __must_check
159 usb_find_last_int_in_endpoint(struct usb_host_ 159 usb_find_last_int_in_endpoint(struct usb_host_interface *alt,
160 struct usb_endpoint_descriptor 160 struct usb_endpoint_descriptor **int_in)
161 { 161 {
162 return usb_find_common_endpoints_rever 162 return usb_find_common_endpoints_reverse(alt, NULL, NULL, int_in, NULL);
163 } 163 }
164 164
165 static inline int __must_check 165 static inline int __must_check
166 usb_find_last_int_out_endpoint(struct usb_host 166 usb_find_last_int_out_endpoint(struct usb_host_interface *alt,
167 struct usb_endpoint_descriptor 167 struct usb_endpoint_descriptor **int_out)
168 { 168 {
169 return usb_find_common_endpoints_rever 169 return usb_find_common_endpoints_reverse(alt, NULL, NULL, NULL, int_out);
170 } 170 }
171 171
172 enum usb_wireless_status { 172 enum usb_wireless_status {
173 USB_WIRELESS_STATUS_NA = 0, 173 USB_WIRELESS_STATUS_NA = 0,
174 USB_WIRELESS_STATUS_DISCONNECTED, 174 USB_WIRELESS_STATUS_DISCONNECTED,
175 USB_WIRELESS_STATUS_CONNECTED, 175 USB_WIRELESS_STATUS_CONNECTED,
176 }; 176 };
177 177
178 /** 178 /**
179 * struct usb_interface - what usb device driv 179 * struct usb_interface - what usb device drivers talk to
180 * @altsetting: array of interface structures, 180 * @altsetting: array of interface structures, one for each alternate
181 * setting that may be selected. Each on 181 * setting that may be selected. Each one includes a set of
182 * endpoint configurations. They will be 182 * endpoint configurations. They will be in no particular order.
183 * @cur_altsetting: the current altsetting. 183 * @cur_altsetting: the current altsetting.
184 * @num_altsetting: number of altsettings defi 184 * @num_altsetting: number of altsettings defined.
185 * @intf_assoc: interface association descript 185 * @intf_assoc: interface association descriptor
186 * @minor: the minor number assigned to this i 186 * @minor: the minor number assigned to this interface, if this
187 * interface is bound to a driver that us 187 * interface is bound to a driver that uses the USB major number.
188 * If this interface does not use the USB 188 * If this interface does not use the USB major, this field should
189 * be unused. The driver should set this 189 * be unused. The driver should set this value in the probe()
190 * function of the driver, after it has b 190 * function of the driver, after it has been assigned a minor
191 * number from the USB core by calling us 191 * number from the USB core by calling usb_register_dev().
192 * @condition: binding state of the interface: 192 * @condition: binding state of the interface: not bound, binding
193 * (in probe()), bound to a driver, or un 193 * (in probe()), bound to a driver, or unbinding (in disconnect())
194 * @sysfs_files_created: sysfs attributes exis 194 * @sysfs_files_created: sysfs attributes exist
195 * @ep_devs_created: endpoint child pseudo-dev 195 * @ep_devs_created: endpoint child pseudo-devices exist
196 * @unregistering: flag set when the interface 196 * @unregistering: flag set when the interface is being unregistered
197 * @needs_remote_wakeup: flag set when the dri 197 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
198 * capability during autosuspend. 198 * capability during autosuspend.
199 * @needs_altsetting0: flag set when a set-int 199 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
200 * has been deferred. 200 * has been deferred.
201 * @needs_binding: flag set when the driver sh 201 * @needs_binding: flag set when the driver should be re-probed or unbound
202 * following a reset or suspend operation 202 * following a reset or suspend operation it doesn't support.
203 * @authorized: This allows to (de)authorize i 203 * @authorized: This allows to (de)authorize individual interfaces instead
204 * a whole device in contrast to the devi 204 * a whole device in contrast to the device authorization.
205 * @wireless_status: if the USB device uses a 205 * @wireless_status: if the USB device uses a receiver/emitter combo, whether
206 * the emitter is connected. 206 * the emitter is connected.
207 * @wireless_status_work: Used for scheduling 207 * @wireless_status_work: Used for scheduling wireless status changes
208 * from atomic context. 208 * from atomic context.
209 * @dev: driver model's view of this device 209 * @dev: driver model's view of this device
210 * @usb_dev: if an interface is bound to the U 210 * @usb_dev: if an interface is bound to the USB major, this will point
211 * to the sysfs representation for that d 211 * to the sysfs representation for that device.
212 * @reset_ws: Used for scheduling resets from 212 * @reset_ws: Used for scheduling resets from atomic context.
213 * @resetting_device: USB core reset the devic 213 * @resetting_device: USB core reset the device, so use alt setting 0 as
214 * current; needs bandwidth alloc after r 214 * current; needs bandwidth alloc after reset.
215 * 215 *
216 * USB device drivers attach to interfaces on 216 * USB device drivers attach to interfaces on a physical device. Each
217 * interface encapsulates a single high level 217 * interface encapsulates a single high level function, such as feeding
218 * an audio stream to a speaker or reporting a 218 * an audio stream to a speaker or reporting a change in a volume control.
219 * Many USB devices only have one interface. 219 * Many USB devices only have one interface. The protocol used to talk to
220 * an interface's endpoints can be defined in 220 * an interface's endpoints can be defined in a usb "class" specification,
221 * or by a product's vendor. The (default) co 221 * or by a product's vendor. The (default) control endpoint is part of
222 * every interface, but is never listed among 222 * every interface, but is never listed among the interface's descriptors.
223 * 223 *
224 * The driver that is bound to the interface c 224 * The driver that is bound to the interface can use standard driver model
225 * calls such as dev_get_drvdata() on the dev 225 * calls such as dev_get_drvdata() on the dev member of this structure.
226 * 226 *
227 * Each interface may have alternate settings. 227 * Each interface may have alternate settings. The initial configuration
228 * of a device sets altsetting 0, but the devi 228 * of a device sets altsetting 0, but the device driver can change
229 * that setting using usb_set_interface(). Al 229 * that setting using usb_set_interface(). Alternate settings are often
230 * used to control the use of periodic endpoin 230 * used to control the use of periodic endpoints, such as by having
231 * different endpoints use different amounts o 231 * different endpoints use different amounts of reserved USB bandwidth.
232 * All standards-conformant USB devices that u 232 * All standards-conformant USB devices that use isochronous endpoints
233 * will use them in non-default settings. 233 * will use them in non-default settings.
234 * 234 *
235 * The USB specification says that alternate s 235 * The USB specification says that alternate setting numbers must run from
236 * 0 to one less than the total number of alte 236 * 0 to one less than the total number of alternate settings. But some
237 * devices manage to mess this up, and the str 237 * devices manage to mess this up, and the structures aren't necessarily
238 * stored in numerical order anyhow. Use usb_ 238 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
239 * look up an alternate setting in the altsett 239 * look up an alternate setting in the altsetting array based on its number.
240 */ 240 */
241 struct usb_interface { 241 struct usb_interface {
242 /* array of alternate settings for thi 242 /* array of alternate settings for this interface,
243 * stored in no particular order */ 243 * stored in no particular order */
244 struct usb_host_interface *altsetting; 244 struct usb_host_interface *altsetting;
245 245
246 struct usb_host_interface *cur_altsett 246 struct usb_host_interface *cur_altsetting; /* the currently
247 * act 247 * active alternate setting */
248 unsigned num_altsetting; /* num 248 unsigned num_altsetting; /* number of alternate settings */
249 249
250 /* If there is an interface associatio 250 /* If there is an interface association descriptor then it will list
251 * the associated interfaces */ 251 * the associated interfaces */
252 struct usb_interface_assoc_descriptor 252 struct usb_interface_assoc_descriptor *intf_assoc;
253 253
254 int minor; /* min 254 int minor; /* minor number this interface is
255 * bou 255 * bound to */
256 enum usb_interface_condition condition 256 enum usb_interface_condition condition; /* state of binding */
257 unsigned sysfs_files_created:1; /* the 257 unsigned sysfs_files_created:1; /* the sysfs attributes exist */
258 unsigned ep_devs_created:1; /* end 258 unsigned ep_devs_created:1; /* endpoint "devices" exist */
259 unsigned unregistering:1; /* unr 259 unsigned unregistering:1; /* unregistration is in progress */
260 unsigned needs_remote_wakeup:1; /* dri 260 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
261 unsigned needs_altsetting0:1; /* swi 261 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
262 unsigned needs_binding:1; /* nee 262 unsigned needs_binding:1; /* needs delayed unbind/rebind */
263 unsigned resetting_device:1; /* tru 263 unsigned resetting_device:1; /* true: bandwidth alloc after reset */
264 unsigned authorized:1; /* use 264 unsigned authorized:1; /* used for interface authorization */
265 enum usb_wireless_status wireless_stat 265 enum usb_wireless_status wireless_status;
266 struct work_struct wireless_status_wor 266 struct work_struct wireless_status_work;
267 267
268 struct device dev; /* int 268 struct device dev; /* interface specific device info */
269 struct device *usb_dev; 269 struct device *usb_dev;
270 struct work_struct reset_ws; /* for 270 struct work_struct reset_ws; /* for resets in atomic context */
271 }; 271 };
272 272
273 #define to_usb_interface(__dev) container_of_c 273 #define to_usb_interface(__dev) container_of_const(__dev, struct usb_interface, dev)
274 274
275 static inline void *usb_get_intfdata(struct us 275 static inline void *usb_get_intfdata(struct usb_interface *intf)
276 { 276 {
277 return dev_get_drvdata(&intf->dev); 277 return dev_get_drvdata(&intf->dev);
278 } 278 }
279 279
280 /** 280 /**
281 * usb_set_intfdata() - associate driver-speci 281 * usb_set_intfdata() - associate driver-specific data with an interface
282 * @intf: USB interface 282 * @intf: USB interface
283 * @data: driver data 283 * @data: driver data
284 * 284 *
285 * Drivers can use this function in their prob 285 * Drivers can use this function in their probe() callbacks to associate
286 * driver-specific data with an interface. 286 * driver-specific data with an interface.
287 * 287 *
288 * Note that there is generally no need to cle 288 * Note that there is generally no need to clear the driver-data pointer even
289 * if some drivers do so for historical or imp 289 * if some drivers do so for historical or implementation-specific reasons.
290 */ 290 */
291 static inline void usb_set_intfdata(struct usb 291 static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
292 { 292 {
293 dev_set_drvdata(&intf->dev, data); 293 dev_set_drvdata(&intf->dev, data);
294 } 294 }
295 295
296 struct usb_interface *usb_get_intf(struct usb_ 296 struct usb_interface *usb_get_intf(struct usb_interface *intf);
297 void usb_put_intf(struct usb_interface *intf); 297 void usb_put_intf(struct usb_interface *intf);
298 298
299 /* Hard limit */ 299 /* Hard limit */
300 #define USB_MAXENDPOINTS 30 300 #define USB_MAXENDPOINTS 30
301 /* this maximum is arbitrary */ 301 /* this maximum is arbitrary */
302 #define USB_MAXINTERFACES 32 302 #define USB_MAXINTERFACES 32
303 #define USB_MAXIADS (USB_MAXINTERF 303 #define USB_MAXIADS (USB_MAXINTERFACES/2)
304 304
305 bool usb_check_bulk_endpoints( 305 bool usb_check_bulk_endpoints(
306 const struct usb_interface *in 306 const struct usb_interface *intf, const u8 *ep_addrs);
307 bool usb_check_int_endpoints( 307 bool usb_check_int_endpoints(
308 const struct usb_interface *in 308 const struct usb_interface *intf, const u8 *ep_addrs);
309 309
310 /* 310 /*
311 * USB Resume Timer: Every Host controller dri 311 * USB Resume Timer: Every Host controller driver should drive the resume
312 * signalling on the bus for the amount of tim 312 * signalling on the bus for the amount of time defined by this macro.
313 * 313 *
314 * That way we will have a 'stable' behavior a 314 * That way we will have a 'stable' behavior among all HCDs supported by Linux.
315 * 315 *
316 * Note that the USB Specification states we s 316 * Note that the USB Specification states we should drive resume for *at least*
317 * 20 ms, but it doesn't give an upper bound. 317 * 20 ms, but it doesn't give an upper bound. This creates two possible
318 * situations which we want to avoid: 318 * situations which we want to avoid:
319 * 319 *
320 * (a) sometimes an msleep(20) might expire sl 320 * (a) sometimes an msleep(20) might expire slightly before 20 ms, which causes
321 * us to fail USB Electrical Tests, thus faili 321 * us to fail USB Electrical Tests, thus failing Certification
322 * 322 *
323 * (b) Some (many) devices actually need more 323 * (b) Some (many) devices actually need more than 20 ms of resume signalling,
324 * and while we can argue that's against the U 324 * and while we can argue that's against the USB Specification, we don't have
325 * control over which devices a certification 325 * control over which devices a certification laboratory will be using for
326 * certification. If CertLab uses a device whi 326 * certification. If CertLab uses a device which was tested against Windows and
327 * that happens to have relaxed resume signall 327 * that happens to have relaxed resume signalling rules, we might fall into
328 * situations where we fail interoperability a 328 * situations where we fail interoperability and electrical tests.
329 * 329 *
330 * In order to avoid both conditions, we're us 330 * In order to avoid both conditions, we're using a 40 ms resume timeout, which
331 * should cope with both LPJ calibration error 331 * should cope with both LPJ calibration errors and devices not following every
332 * detail of the USB Specification. 332 * detail of the USB Specification.
333 */ 333 */
334 #define USB_RESUME_TIMEOUT 40 /* ms */ 334 #define USB_RESUME_TIMEOUT 40 /* ms */
335 335
336 /** 336 /**
337 * struct usb_interface_cache - long-term repr 337 * struct usb_interface_cache - long-term representation of a device interface
338 * @num_altsetting: number of altsettings defi 338 * @num_altsetting: number of altsettings defined.
339 * @ref: reference counter. 339 * @ref: reference counter.
340 * @altsetting: variable-length array of inter 340 * @altsetting: variable-length array of interface structures, one for
341 * each alternate setting that may be sel 341 * each alternate setting that may be selected. Each one includes a
342 * set of endpoint configurations. They 342 * set of endpoint configurations. They will be in no particular order.
343 * 343 *
344 * These structures persist for the lifetime o 344 * These structures persist for the lifetime of a usb_device, unlike
345 * struct usb_interface (which persists only a 345 * struct usb_interface (which persists only as long as its configuration
346 * is installed). The altsetting arrays can b 346 * is installed). The altsetting arrays can be accessed through these
347 * structures at any time, permitting comparis 347 * structures at any time, permitting comparison of configurations and
348 * providing support for the /sys/kernel/debug 348 * providing support for the /sys/kernel/debug/usb/devices pseudo-file.
349 */ 349 */
350 struct usb_interface_cache { 350 struct usb_interface_cache {
351 unsigned num_altsetting; /* num 351 unsigned num_altsetting; /* number of alternate settings */
352 struct kref ref; /* ref 352 struct kref ref; /* reference counter */
353 353
354 /* variable-length array of alternate 354 /* variable-length array of alternate settings for this interface,
355 * stored in no particular order */ 355 * stored in no particular order */
356 struct usb_host_interface altsetting[] 356 struct usb_host_interface altsetting[];
357 }; 357 };
358 #define ref_to_usb_interface_cache(r) \ 358 #define ref_to_usb_interface_cache(r) \
359 container_of(r, struct usb_int 359 container_of(r, struct usb_interface_cache, ref)
360 #define altsetting_to_usb_interface_cache(a) \ 360 #define altsetting_to_usb_interface_cache(a) \
361 container_of(a, struct usb_int 361 container_of(a, struct usb_interface_cache, altsetting[0])
362 362
363 /** 363 /**
364 * struct usb_host_config - representation of 364 * struct usb_host_config - representation of a device's configuration
365 * @desc: the device's configuration descripto 365 * @desc: the device's configuration descriptor.
366 * @string: pointer to the cached version of t 366 * @string: pointer to the cached version of the iConfiguration string, if
367 * present for this configuration. 367 * present for this configuration.
368 * @intf_assoc: list of any interface associat 368 * @intf_assoc: list of any interface association descriptors in this config
369 * @interface: array of pointers to usb_interf 369 * @interface: array of pointers to usb_interface structures, one for each
370 * interface in the configuration. The n 370 * interface in the configuration. The number of interfaces is stored
371 * in desc.bNumInterfaces. These pointer 371 * in desc.bNumInterfaces. These pointers are valid only while the
372 * configuration is active. 372 * configuration is active.
373 * @intf_cache: array of pointers to usb_inter 373 * @intf_cache: array of pointers to usb_interface_cache structures, one
374 * for each interface in the configuratio 374 * for each interface in the configuration. These structures exist
375 * for the entire life of the device. 375 * for the entire life of the device.
376 * @extra: pointer to buffer containing all ex 376 * @extra: pointer to buffer containing all extra descriptors associated
377 * with this configuration (those precedi 377 * with this configuration (those preceding the first interface
378 * descriptor). 378 * descriptor).
379 * @extralen: length of the extra descriptors 379 * @extralen: length of the extra descriptors buffer.
380 * 380 *
381 * USB devices may have multiple configuration 381 * USB devices may have multiple configurations, but only one can be active
382 * at any time. Each encapsulates a different 382 * at any time. Each encapsulates a different operational environment;
383 * for example, a dual-speed device would have 383 * for example, a dual-speed device would have separate configurations for
384 * full-speed and high-speed operation. The n 384 * full-speed and high-speed operation. The number of configurations
385 * available is stored in the device descripto 385 * available is stored in the device descriptor as bNumConfigurations.
386 * 386 *
387 * A configuration can contain multiple interf 387 * A configuration can contain multiple interfaces. Each corresponds to
388 * a different function of the USB device, and 388 * a different function of the USB device, and all are available whenever
389 * the configuration is active. The USB stand 389 * the configuration is active. The USB standard says that interfaces
390 * are supposed to be numbered from 0 to desc. 390 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
391 * of devices get this wrong. In addition, th 391 * of devices get this wrong. In addition, the interface array is not
392 * guaranteed to be sorted in numerical order. 392 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
393 * look up an interface entry based on its num 393 * look up an interface entry based on its number.
394 * 394 *
395 * Device drivers should not attempt to activa 395 * Device drivers should not attempt to activate configurations. The choice
396 * of which configuration to install is a poli 396 * of which configuration to install is a policy decision based on such
397 * considerations as available power, function 397 * considerations as available power, functionality provided, and the user's
398 * desires (expressed through userspace tools) 398 * desires (expressed through userspace tools). However, drivers can call
399 * usb_reset_configuration() to reinitialize t 399 * usb_reset_configuration() to reinitialize the current configuration and
400 * all its interfaces. 400 * all its interfaces.
401 */ 401 */
402 struct usb_host_config { 402 struct usb_host_config {
403 struct usb_config_descriptor desc; 403 struct usb_config_descriptor desc;
404 404
405 char *string; /* iConfigurat 405 char *string; /* iConfiguration string, if present */
406 406
407 /* List of any Interface Association D 407 /* List of any Interface Association Descriptors in this
408 * configuration. */ 408 * configuration. */
409 struct usb_interface_assoc_descriptor 409 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];
410 410
411 /* the interfaces associated with this 411 /* the interfaces associated with this configuration,
412 * stored in no particular order */ 412 * stored in no particular order */
413 struct usb_interface *interface[USB_MA 413 struct usb_interface *interface[USB_MAXINTERFACES];
414 414
415 /* Interface information available eve 415 /* Interface information available even when this is not the
416 * active configuration */ 416 * active configuration */
417 struct usb_interface_cache *intf_cache 417 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
418 418
419 unsigned char *extra; /* Extra descr 419 unsigned char *extra; /* Extra descriptors */
420 int extralen; 420 int extralen;
421 }; 421 };
422 422
423 /* USB2.0 and USB3.0 device BOS descriptor set 423 /* USB2.0 and USB3.0 device BOS descriptor set */
424 struct usb_host_bos { 424 struct usb_host_bos {
425 struct usb_bos_descriptor *desc; 425 struct usb_bos_descriptor *desc;
426 426
427 struct usb_ext_cap_descriptor *ext_c 427 struct usb_ext_cap_descriptor *ext_cap;
428 struct usb_ss_cap_descriptor *ss_ca 428 struct usb_ss_cap_descriptor *ss_cap;
429 struct usb_ssp_cap_descriptor *ssp_c 429 struct usb_ssp_cap_descriptor *ssp_cap;
430 struct usb_ss_container_id_descriptor 430 struct usb_ss_container_id_descriptor *ss_id;
431 struct usb_ptm_cap_descriptor *ptm_c 431 struct usb_ptm_cap_descriptor *ptm_cap;
432 }; 432 };
433 433
434 int __usb_get_extra_descriptor(char *buffer, u 434 int __usb_get_extra_descriptor(char *buffer, unsigned size,
435 unsigned char type, void **ptr, size_t 435 unsigned char type, void **ptr, size_t min);
436 #define usb_get_extra_descriptor(ifpoint, type 436 #define usb_get_extra_descriptor(ifpoint, type, ptr) \
437 __usb_get_extr 437 __usb_get_extra_descriptor((ifpoint)->extra, \
438 (ifpoint)->ext 438 (ifpoint)->extralen, \
439 type, (void ** 439 type, (void **)ptr, sizeof(**(ptr)))
440 440
441 /* ------------------------------------------- 441 /* ----------------------------------------------------------------------- */
442 442
443 /* 443 /*
444 * Allocated per bus (tree of devices) we have 444 * Allocated per bus (tree of devices) we have:
445 */ 445 */
446 struct usb_bus { 446 struct usb_bus {
447 struct device *controller; /* hos 447 struct device *controller; /* host side hardware */
448 struct device *sysdev; /* as 448 struct device *sysdev; /* as seen from firmware or bus */
449 int busnum; /* Bus 449 int busnum; /* Bus number (in order of reg) */
450 const char *bus_name; /* sta 450 const char *bus_name; /* stable id (PCI slot_name etc) */
451 u8 uses_pio_for_control; /* 451 u8 uses_pio_for_control; /*
452 * Doe 452 * Does the host controller use PIO
453 * for 453 * for control transfers?
454 */ 454 */
455 u8 otg_port; /* 0, 455 u8 otg_port; /* 0, or number of OTG/HNP port */
456 unsigned is_b_host:1; /* tru 456 unsigned is_b_host:1; /* true during some HNP roleswitches */
457 unsigned b_hnp_enable:1; /* OTG 457 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
458 unsigned no_stop_on_short:1; /* 458 unsigned no_stop_on_short:1; /*
459 * Qui 459 * Quirk: some controllers don't stop
460 * the 460 * the ep queue on a short transfer
461 * wit 461 * with the URB_SHORT_NOT_OK flag set.
462 */ 462 */
463 unsigned no_sg_constraint:1; /* no 463 unsigned no_sg_constraint:1; /* no sg constraint */
464 unsigned sg_tablesize; /* 0 o 464 unsigned sg_tablesize; /* 0 or largest number of sg list entries */
465 465
466 int devnum_next; /* Nex 466 int devnum_next; /* Next open device number in
467 * rou 467 * round-robin allocation */
468 struct mutex devnum_next_mutex; /* dev 468 struct mutex devnum_next_mutex; /* devnum_next mutex */
469 469
470 DECLARE_BITMAP(devmap, 128); /* USB 470 DECLARE_BITMAP(devmap, 128); /* USB device number allocation bitmap */
471 struct usb_device *root_hub; /* Roo 471 struct usb_device *root_hub; /* Root hub */
472 struct usb_bus *hs_companion; /* Com 472 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */
473 473
474 int bandwidth_allocated; /* on 474 int bandwidth_allocated; /* on this bus: how much of the time
475 * res 475 * reserved for periodic (intr/iso)
476 * req 476 * requests is used, on average?
477 * Uni 477 * Units: microseconds/frame.
478 * Lim 478 * Limits: Full/low speed reserve 90%,
479 * whi 479 * while high speed reserves 80%.
480 */ 480 */
481 int bandwidth_int_reqs; /* num 481 int bandwidth_int_reqs; /* number of Interrupt requests */
482 int bandwidth_isoc_reqs; /* num 482 int bandwidth_isoc_reqs; /* number of Isoc. requests */
483 483
484 unsigned resuming_ports; /* bit 484 unsigned resuming_ports; /* bit array: resuming root-hub ports */
485 485
486 #if defined(CONFIG_USB_MON) || defined(CONFIG_ 486 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
487 struct mon_bus *mon_bus; /* non 487 struct mon_bus *mon_bus; /* non-null when associated */
488 int monitored; /* non 488 int monitored; /* non-zero when monitored */
489 #endif 489 #endif
490 }; 490 };
491 491
492 struct usb_dev_state; 492 struct usb_dev_state;
493 493
494 /* ------------------------------------------- 494 /* ----------------------------------------------------------------------- */
495 495
496 struct usb_tt; 496 struct usb_tt;
497 497
498 enum usb_link_tunnel_mode { <<
499 USB_LINK_UNKNOWN = 0, <<
500 USB_LINK_NATIVE, <<
501 USB_LINK_TUNNELED, <<
502 }; <<
503 <<
504 enum usb_port_connect_type { 498 enum usb_port_connect_type {
505 USB_PORT_CONNECT_TYPE_UNKNOWN = 0, 499 USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
506 USB_PORT_CONNECT_TYPE_HOT_PLUG, 500 USB_PORT_CONNECT_TYPE_HOT_PLUG,
507 USB_PORT_CONNECT_TYPE_HARD_WIRED, 501 USB_PORT_CONNECT_TYPE_HARD_WIRED,
508 USB_PORT_NOT_USED, 502 USB_PORT_NOT_USED,
509 }; 503 };
510 504
511 /* 505 /*
512 * USB port quirks. 506 * USB port quirks.
513 */ 507 */
514 508
515 /* For the given port, prefer the old (faster) 509 /* For the given port, prefer the old (faster) enumeration scheme. */
516 #define USB_PORT_QUIRK_OLD_SCHEME BIT(0) 510 #define USB_PORT_QUIRK_OLD_SCHEME BIT(0)
517 511
518 /* Decrease TRSTRCY to 10ms during device enum 512 /* Decrease TRSTRCY to 10ms during device enumeration. */
519 #define USB_PORT_QUIRK_FAST_ENUM BIT(1) 513 #define USB_PORT_QUIRK_FAST_ENUM BIT(1)
520 514
521 /* 515 /*
522 * USB 2.0 Link Power Management (LPM) paramet 516 * USB 2.0 Link Power Management (LPM) parameters.
523 */ 517 */
524 struct usb2_lpm_parameters { 518 struct usb2_lpm_parameters {
525 /* Best effort service latency indicat 519 /* Best effort service latency indicate how long the host will drive
526 * resume on an exit from L1. 520 * resume on an exit from L1.
527 */ 521 */
528 unsigned int besl; 522 unsigned int besl;
529 523
530 /* Timeout value in microseconds for t 524 /* Timeout value in microseconds for the L1 inactivity (LPM) timer.
531 * When the timer counts to zero, the 525 * When the timer counts to zero, the parent hub will initiate a LPM
532 * transition to L1. 526 * transition to L1.
533 */ 527 */
534 int timeout; 528 int timeout;
535 }; 529 };
536 530
537 /* 531 /*
538 * USB 3.0 Link Power Management (LPM) paramet 532 * USB 3.0 Link Power Management (LPM) parameters.
539 * 533 *
540 * PEL and SEL are USB 3.0 Link PM latencies f 534 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
541 * MEL is the USB 3.0 Link PM latency for host 535 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
542 * All three are stored in nanoseconds. 536 * All three are stored in nanoseconds.
543 */ 537 */
544 struct usb3_lpm_parameters { 538 struct usb3_lpm_parameters {
545 /* 539 /*
546 * Maximum exit latency (MEL) for the 540 * Maximum exit latency (MEL) for the host to send a packet to the
547 * device (either a Ping for isoc endp 541 * device (either a Ping for isoc endpoints, or a data packet for
548 * interrupt endpoints), the hubs to d 542 * interrupt endpoints), the hubs to decode the packet, and for all hubs
549 * in the path to transition the links 543 * in the path to transition the links to U0.
550 */ 544 */
551 unsigned int mel; 545 unsigned int mel;
552 /* 546 /*
553 * Maximum exit latency for a device-i 547 * Maximum exit latency for a device-initiated LPM transition to bring
554 * all links into U0. Abbreviated as 548 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB
555 * 3.0 spec, with no explanation of wh 549 * 3.0 spec, with no explanation of what "P" stands for. "Path"?
556 */ 550 */
557 unsigned int pel; 551 unsigned int pel;
558 552
559 /* 553 /*
560 * The System Exit Latency (SEL) inclu 554 * The System Exit Latency (SEL) includes PEL, and three other
561 * latencies. After a device initiate 555 * latencies. After a device initiates a U0 transition, it will take
562 * some time from when the device send 556 * some time from when the device sends the ERDY to when it will finally
563 * receive the data packet. Basically 557 * receive the data packet. Basically, SEL should be the worse-case
564 * latency from when a device starts i 558 * latency from when a device starts initiating a U0 transition to when
565 * it will get data. 559 * it will get data.
566 */ 560 */
567 unsigned int sel; 561 unsigned int sel;
568 /* 562 /*
569 * The idle timeout value that is curr 563 * The idle timeout value that is currently programmed into the parent
570 * hub for this device. When the time 564 * hub for this device. When the timer counts to zero, the parent hub
571 * will initiate an LPM transition to 565 * will initiate an LPM transition to either U1 or U2.
572 */ 566 */
573 int timeout; 567 int timeout;
574 }; 568 };
575 569
576 /** 570 /**
577 * struct usb_device - kernel's representation 571 * struct usb_device - kernel's representation of a USB device
578 * @devnum: device number; address on a USB bu 572 * @devnum: device number; address on a USB bus
579 * @devpath: device ID string for use in messa 573 * @devpath: device ID string for use in messages (e.g., /port/...)
580 * @route: tree topology hex string for use wi 574 * @route: tree topology hex string for use with xHCI
581 * @state: device state: configured, not attac 575 * @state: device state: configured, not attached, etc.
582 * @speed: device speed: high/full/low (or err 576 * @speed: device speed: high/full/low (or error)
583 * @rx_lanes: number of rx lanes in use, USB 3 577 * @rx_lanes: number of rx lanes in use, USB 3.2 adds dual-lane support
584 * @tx_lanes: number of tx lanes in use, USB 3 578 * @tx_lanes: number of tx lanes in use, USB 3.2 adds dual-lane support
585 * @ssp_rate: SuperSpeed Plus phy signaling ra 579 * @ssp_rate: SuperSpeed Plus phy signaling rate and lane count
586 * @tt: Transaction Translator info; used with 580 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
587 * @ttport: device port on that tt hub 581 * @ttport: device port on that tt hub
588 * @toggle: one bit for each endpoint, with ([ 582 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
589 * @parent: our hub, unless we're the root 583 * @parent: our hub, unless we're the root
590 * @bus: bus we're part of 584 * @bus: bus we're part of
591 * @ep0: endpoint 0 data (default control pipe 585 * @ep0: endpoint 0 data (default control pipe)
592 * @dev: generic device interface 586 * @dev: generic device interface
593 * @descriptor: USB device descriptor 587 * @descriptor: USB device descriptor
594 * @bos: USB device BOS descriptor set 588 * @bos: USB device BOS descriptor set
595 * @config: all of the device's configs 589 * @config: all of the device's configs
596 * @actconfig: the active configuration 590 * @actconfig: the active configuration
597 * @ep_in: array of IN endpoints 591 * @ep_in: array of IN endpoints
598 * @ep_out: array of OUT endpoints 592 * @ep_out: array of OUT endpoints
599 * @rawdescriptors: raw descriptors for each c 593 * @rawdescriptors: raw descriptors for each config
600 * @bus_mA: Current available from the bus 594 * @bus_mA: Current available from the bus
601 * @portnum: parent port number (origin 1) 595 * @portnum: parent port number (origin 1)
602 * @level: number of USB hub ancestors 596 * @level: number of USB hub ancestors
603 * @devaddr: device address, XHCI: assigned by 597 * @devaddr: device address, XHCI: assigned by HW, others: same as devnum
604 * @can_submit: URBs may be submitted 598 * @can_submit: URBs may be submitted
605 * @persist_enabled: USB_PERSIST enabled for 599 * @persist_enabled: USB_PERSIST enabled for this device
606 * @reset_in_progress: the device is being res 600 * @reset_in_progress: the device is being reset
607 * @have_langid: whether string_langid is vali 601 * @have_langid: whether string_langid is valid
608 * @authorized: policy has said we can use it; 602 * @authorized: policy has said we can use it;
609 * (user space) policy determines if we a 603 * (user space) policy determines if we authorize this device to be
610 * used or not. By default, wired USB dev 604 * used or not. By default, wired USB devices are authorized.
611 * WUSB devices are not, until we authori 605 * WUSB devices are not, until we authorize them from user space.
612 * FIXME -- complete doc 606 * FIXME -- complete doc
613 * @authenticated: Crypto authentication passe 607 * @authenticated: Crypto authentication passed
614 * @tunnel_mode: Connection native or tunneled <<
615 * @lpm_capable: device supports LPM 608 * @lpm_capable: device supports LPM
616 * @lpm_devinit_allow: Allow USB3 device initi 609 * @lpm_devinit_allow: Allow USB3 device initiated LPM, exit latency is in range
617 * @usb2_hw_lpm_capable: device can perform US 610 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
618 * @usb2_hw_lpm_besl_capable: device can perfo 611 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
619 * @usb2_hw_lpm_enabled: USB2 hardware LPM is 612 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled
620 * @usb2_hw_lpm_allowed: Userspace allows USB 613 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled
621 * @usb3_lpm_u1_enabled: USB3 hardware U1 LPM 614 * @usb3_lpm_u1_enabled: USB3 hardware U1 LPM enabled
622 * @usb3_lpm_u2_enabled: USB3 hardware U2 LPM 615 * @usb3_lpm_u2_enabled: USB3 hardware U2 LPM enabled
623 * @string_langid: language ID for strings 616 * @string_langid: language ID for strings
624 * @product: iProduct string, if present (stat 617 * @product: iProduct string, if present (static)
625 * @manufacturer: iManufacturer string, if pre 618 * @manufacturer: iManufacturer string, if present (static)
626 * @serial: iSerialNumber string, if present ( 619 * @serial: iSerialNumber string, if present (static)
627 * @filelist: usbfs files that are open to thi 620 * @filelist: usbfs files that are open to this device
628 * @maxchild: number of ports if hub 621 * @maxchild: number of ports if hub
629 * @quirks: quirks of the whole device 622 * @quirks: quirks of the whole device
630 * @urbnum: number of URBs submitted for the w 623 * @urbnum: number of URBs submitted for the whole device
631 * @active_duration: total time device is not 624 * @active_duration: total time device is not suspended
632 * @connect_time: time device was first connec 625 * @connect_time: time device was first connected
633 * @do_remote_wakeup: remote wakeup should be 626 * @do_remote_wakeup: remote wakeup should be enabled
634 * @reset_resume: needs reset instead of resum 627 * @reset_resume: needs reset instead of resume
635 * @port_is_suspended: the upstream port is su 628 * @port_is_suspended: the upstream port is suspended (L2 or U3)
636 * @slot_id: Slot ID assigned by xHCI 629 * @slot_id: Slot ID assigned by xHCI
637 * @l1_params: best effor service latency for 630 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
638 * @u1_params: exit latencies for USB3 U1 LPM 631 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
639 * @u2_params: exit latencies for USB3 U2 LPM 632 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
640 * @lpm_disable_count: Ref count used by usb_d 633 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
641 * to keep track of the number of functio 634 * to keep track of the number of functions that require USB 3.0 Link Power
642 * Management to be disabled for this usb 635 * Management to be disabled for this usb_device. This count should only
643 * be manipulated by those functions, wit 636 * be manipulated by those functions, with the bandwidth_mutex is held.
644 * @hub_delay: cached value consisting of: 637 * @hub_delay: cached value consisting of:
645 * parent->hub_delay + wHubDelay + tTPTra 638 * parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns)
646 * Will be used as wValue for SetIsochDel 639 * Will be used as wValue for SetIsochDelay requests.
647 * @use_generic_driver: ask driver core to rep 640 * @use_generic_driver: ask driver core to reprobe using the generic driver.
648 * 641 *
649 * Notes: 642 * Notes:
650 * Usbcore drivers should not set usbdev->stat 643 * Usbcore drivers should not set usbdev->state directly. Instead use
651 * usb_set_device_state(). 644 * usb_set_device_state().
652 */ 645 */
653 struct usb_device { 646 struct usb_device {
654 int devnum; 647 int devnum;
655 char devpath[16]; 648 char devpath[16];
656 u32 route; 649 u32 route;
657 enum usb_device_state state; 650 enum usb_device_state state;
658 enum usb_device_speed speed; 651 enum usb_device_speed speed;
659 unsigned int rx_lanes; 652 unsigned int rx_lanes;
660 unsigned int tx_lanes; 653 unsigned int tx_lanes;
661 enum usb_ssp_rate ssp_rate; 654 enum usb_ssp_rate ssp_rate;
662 655
663 struct usb_tt *tt; 656 struct usb_tt *tt;
664 int ttport; 657 int ttport;
665 658
666 unsigned int toggle[2]; 659 unsigned int toggle[2];
667 660
668 struct usb_device *parent; 661 struct usb_device *parent;
669 struct usb_bus *bus; 662 struct usb_bus *bus;
670 struct usb_host_endpoint ep0; 663 struct usb_host_endpoint ep0;
671 664
672 struct device dev; 665 struct device dev;
673 666
674 struct usb_device_descriptor descripto 667 struct usb_device_descriptor descriptor;
675 struct usb_host_bos *bos; 668 struct usb_host_bos *bos;
676 struct usb_host_config *config; 669 struct usb_host_config *config;
677 670
678 struct usb_host_config *actconfig; 671 struct usb_host_config *actconfig;
679 struct usb_host_endpoint *ep_in[16]; 672 struct usb_host_endpoint *ep_in[16];
680 struct usb_host_endpoint *ep_out[16]; 673 struct usb_host_endpoint *ep_out[16];
681 674
682 char **rawdescriptors; 675 char **rawdescriptors;
683 676
684 unsigned short bus_mA; 677 unsigned short bus_mA;
685 u8 portnum; 678 u8 portnum;
686 u8 level; 679 u8 level;
687 u8 devaddr; 680 u8 devaddr;
688 681
689 unsigned can_submit:1; 682 unsigned can_submit:1;
690 unsigned persist_enabled:1; 683 unsigned persist_enabled:1;
691 unsigned reset_in_progress:1; 684 unsigned reset_in_progress:1;
692 unsigned have_langid:1; 685 unsigned have_langid:1;
693 unsigned authorized:1; 686 unsigned authorized:1;
694 unsigned authenticated:1; 687 unsigned authenticated:1;
695 unsigned lpm_capable:1; 688 unsigned lpm_capable:1;
696 unsigned lpm_devinit_allow:1; 689 unsigned lpm_devinit_allow:1;
697 unsigned usb2_hw_lpm_capable:1; 690 unsigned usb2_hw_lpm_capable:1;
698 unsigned usb2_hw_lpm_besl_capable:1; 691 unsigned usb2_hw_lpm_besl_capable:1;
699 unsigned usb2_hw_lpm_enabled:1; 692 unsigned usb2_hw_lpm_enabled:1;
700 unsigned usb2_hw_lpm_allowed:1; 693 unsigned usb2_hw_lpm_allowed:1;
701 unsigned usb3_lpm_u1_enabled:1; 694 unsigned usb3_lpm_u1_enabled:1;
702 unsigned usb3_lpm_u2_enabled:1; 695 unsigned usb3_lpm_u2_enabled:1;
703 int string_langid; 696 int string_langid;
704 697
705 /* static strings from the device */ 698 /* static strings from the device */
706 char *product; 699 char *product;
707 char *manufacturer; 700 char *manufacturer;
708 char *serial; 701 char *serial;
709 702
710 struct list_head filelist; 703 struct list_head filelist;
711 704
712 int maxchild; 705 int maxchild;
713 706
714 u32 quirks; 707 u32 quirks;
715 atomic_t urbnum; 708 atomic_t urbnum;
716 709
717 unsigned long active_duration; 710 unsigned long active_duration;
718 711
719 unsigned long connect_time; 712 unsigned long connect_time;
720 713
721 unsigned do_remote_wakeup:1; 714 unsigned do_remote_wakeup:1;
722 unsigned reset_resume:1; 715 unsigned reset_resume:1;
723 unsigned port_is_suspended:1; 716 unsigned port_is_suspended:1;
724 enum usb_link_tunnel_mode tunnel_mode; <<
725 717
726 int slot_id; 718 int slot_id;
727 struct usb2_lpm_parameters l1_params; 719 struct usb2_lpm_parameters l1_params;
728 struct usb3_lpm_parameters u1_params; 720 struct usb3_lpm_parameters u1_params;
729 struct usb3_lpm_parameters u2_params; 721 struct usb3_lpm_parameters u2_params;
730 unsigned lpm_disable_count; 722 unsigned lpm_disable_count;
731 723
732 u16 hub_delay; 724 u16 hub_delay;
733 unsigned use_generic_driver:1; 725 unsigned use_generic_driver:1;
734 }; 726 };
735 727
736 #define to_usb_device(__dev) container_of_c 728 #define to_usb_device(__dev) container_of_const(__dev, struct usb_device, dev)
737 729
738 static inline struct usb_device *__intf_to_usb 730 static inline struct usb_device *__intf_to_usbdev(struct usb_interface *intf)
739 { 731 {
740 return to_usb_device(intf->dev.parent) 732 return to_usb_device(intf->dev.parent);
741 } 733 }
742 static inline const struct usb_device *__intf_ 734 static inline const struct usb_device *__intf_to_usbdev_const(const struct usb_interface *intf)
743 { 735 {
744 return to_usb_device((const struct dev 736 return to_usb_device((const struct device *)intf->dev.parent);
745 } 737 }
746 738
747 #define interface_to_usbdev(intf) 739 #define interface_to_usbdev(intf) \
748 _Generic((intf), 740 _Generic((intf), \
749 const struct usb_interface *: 741 const struct usb_interface *: __intf_to_usbdev_const, \
750 struct usb_interface *: __int 742 struct usb_interface *: __intf_to_usbdev)(intf)
751 743
752 extern struct usb_device *usb_get_dev(struct u 744 extern struct usb_device *usb_get_dev(struct usb_device *dev);
753 extern void usb_put_dev(struct usb_device *dev 745 extern void usb_put_dev(struct usb_device *dev);
754 extern struct usb_device *usb_hub_find_child(s 746 extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
755 int port1); 747 int port1);
756 748
757 /** 749 /**
758 * usb_hub_for_each_child - iterate over all c 750 * usb_hub_for_each_child - iterate over all child devices on the hub
759 * @hdev: USB device belonging to the usb hub 751 * @hdev: USB device belonging to the usb hub
760 * @port1: portnum associated with child devic 752 * @port1: portnum associated with child device
761 * @child: child device pointer 753 * @child: child device pointer
762 */ 754 */
763 #define usb_hub_for_each_child(hdev, port1, ch 755 #define usb_hub_for_each_child(hdev, port1, child) \
764 for (port1 = 1, child = usb_hub_find_c 756 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \
765 port1 <= hdev->maxchil 757 port1 <= hdev->maxchild; \
766 child = usb_hub_find_c 758 child = usb_hub_find_child(hdev, ++port1)) \
767 if (!child) continue; else 759 if (!child) continue; else
768 760
769 /* USB device locking */ 761 /* USB device locking */
770 #define usb_lock_device(udev) 762 #define usb_lock_device(udev) device_lock(&(udev)->dev)
771 #define usb_unlock_device(udev) 763 #define usb_unlock_device(udev) device_unlock(&(udev)->dev)
772 #define usb_lock_device_interruptible(udev) 764 #define usb_lock_device_interruptible(udev) device_lock_interruptible(&(udev)->dev)
773 #define usb_trylock_device(udev) 765 #define usb_trylock_device(udev) device_trylock(&(udev)->dev)
774 extern int usb_lock_device_for_reset(struct us 766 extern int usb_lock_device_for_reset(struct usb_device *udev,
775 const str 767 const struct usb_interface *iface);
776 768
777 /* USB port reset for device reinitialization 769 /* USB port reset for device reinitialization */
778 extern int usb_reset_device(struct usb_device 770 extern int usb_reset_device(struct usb_device *dev);
779 extern void usb_queue_reset_device(struct usb_ 771 extern void usb_queue_reset_device(struct usb_interface *dev);
780 772
781 extern struct device *usb_intf_get_dma_device( 773 extern struct device *usb_intf_get_dma_device(struct usb_interface *intf);
782 774
783 #ifdef CONFIG_ACPI 775 #ifdef CONFIG_ACPI
784 extern int usb_acpi_set_power_state(struct usb 776 extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
785 bool enable); 777 bool enable);
786 extern bool usb_acpi_power_manageable(struct u 778 extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
787 extern int usb_acpi_port_lpm_incapable(struct 779 extern int usb_acpi_port_lpm_incapable(struct usb_device *hdev, int index);
788 #else 780 #else
789 static inline int usb_acpi_set_power_state(str 781 static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
790 bool enable) { return 0; } 782 bool enable) { return 0; }
791 static inline bool usb_acpi_power_manageable(s 783 static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
792 { return true; } 784 { return true; }
793 static inline int usb_acpi_port_lpm_incapable( 785 static inline int usb_acpi_port_lpm_incapable(struct usb_device *hdev, int index)
794 { return 0; } 786 { return 0; }
795 #endif 787 #endif
796 788
797 /* USB autosuspend and autoresume */ 789 /* USB autosuspend and autoresume */
798 #ifdef CONFIG_PM 790 #ifdef CONFIG_PM
799 extern void usb_enable_autosuspend(struct usb_ 791 extern void usb_enable_autosuspend(struct usb_device *udev);
800 extern void usb_disable_autosuspend(struct usb 792 extern void usb_disable_autosuspend(struct usb_device *udev);
801 793
802 extern int usb_autopm_get_interface(struct usb 794 extern int usb_autopm_get_interface(struct usb_interface *intf);
803 extern void usb_autopm_put_interface(struct us 795 extern void usb_autopm_put_interface(struct usb_interface *intf);
804 extern int usb_autopm_get_interface_async(stru 796 extern int usb_autopm_get_interface_async(struct usb_interface *intf);
805 extern void usb_autopm_put_interface_async(str 797 extern void usb_autopm_put_interface_async(struct usb_interface *intf);
806 extern void usb_autopm_get_interface_no_resume 798 extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
807 extern void usb_autopm_put_interface_no_suspen 799 extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
808 800
809 static inline void usb_mark_last_busy(struct u 801 static inline void usb_mark_last_busy(struct usb_device *udev)
810 { 802 {
811 pm_runtime_mark_last_busy(&udev->dev); 803 pm_runtime_mark_last_busy(&udev->dev);
812 } 804 }
813 805
814 #else 806 #else
815 807
816 static inline int usb_enable_autosuspend(struc 808 static inline int usb_enable_autosuspend(struct usb_device *udev)
817 { return 0; } 809 { return 0; }
818 static inline int usb_disable_autosuspend(stru 810 static inline int usb_disable_autosuspend(struct usb_device *udev)
819 { return 0; } 811 { return 0; }
820 812
821 static inline int usb_autopm_get_interface(str 813 static inline int usb_autopm_get_interface(struct usb_interface *intf)
822 { return 0; } 814 { return 0; }
823 static inline int usb_autopm_get_interface_asy 815 static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
824 { return 0; } 816 { return 0; }
825 817
826 static inline void usb_autopm_put_interface(st 818 static inline void usb_autopm_put_interface(struct usb_interface *intf)
827 { } 819 { }
828 static inline void usb_autopm_put_interface_as 820 static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
829 { } 821 { }
830 static inline void usb_autopm_get_interface_no 822 static inline void usb_autopm_get_interface_no_resume(
831 struct usb_interface *intf) 823 struct usb_interface *intf)
832 { } 824 { }
833 static inline void usb_autopm_put_interface_no 825 static inline void usb_autopm_put_interface_no_suspend(
834 struct usb_interface *intf) 826 struct usb_interface *intf)
835 { } 827 { }
836 static inline void usb_mark_last_busy(struct u 828 static inline void usb_mark_last_busy(struct usb_device *udev)
837 { } 829 { }
838 #endif 830 #endif
839 831
840 extern int usb_disable_lpm(struct usb_device * 832 extern int usb_disable_lpm(struct usb_device *udev);
841 extern void usb_enable_lpm(struct usb_device * 833 extern void usb_enable_lpm(struct usb_device *udev);
842 /* Same as above, but these functions lock/unl 834 /* Same as above, but these functions lock/unlock the bandwidth_mutex. */
843 extern int usb_unlocked_disable_lpm(struct usb 835 extern int usb_unlocked_disable_lpm(struct usb_device *udev);
844 extern void usb_unlocked_enable_lpm(struct usb 836 extern void usb_unlocked_enable_lpm(struct usb_device *udev);
845 837
846 extern int usb_disable_ltm(struct usb_device * 838 extern int usb_disable_ltm(struct usb_device *udev);
847 extern void usb_enable_ltm(struct usb_device * 839 extern void usb_enable_ltm(struct usb_device *udev);
848 840
849 static inline bool usb_device_supports_ltm(str 841 static inline bool usb_device_supports_ltm(struct usb_device *udev)
850 { 842 {
851 if (udev->speed < USB_SPEED_SUPER || ! 843 if (udev->speed < USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
852 return false; 844 return false;
853 return udev->bos->ss_cap->bmAttributes 845 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
854 } 846 }
855 847
856 static inline bool usb_device_no_sg_constraint 848 static inline bool usb_device_no_sg_constraint(struct usb_device *udev)
857 { 849 {
858 return udev && udev->bus && udev->bus- 850 return udev && udev->bus && udev->bus->no_sg_constraint;
859 } 851 }
860 852
861 853
862 /*-------------------------------------------- 854 /*-------------------------------------------------------------------------*/
863 855
864 /* for drivers using iso endpoints */ 856 /* for drivers using iso endpoints */
865 extern int usb_get_current_frame_number(struct 857 extern int usb_get_current_frame_number(struct usb_device *usb_dev);
866 858
867 /* Sets up a group of bulk endpoints to suppor 859 /* Sets up a group of bulk endpoints to support multiple stream IDs. */
868 extern int usb_alloc_streams(struct usb_interf 860 extern int usb_alloc_streams(struct usb_interface *interface,
869 struct usb_host_endpoint **eps 861 struct usb_host_endpoint **eps, unsigned int num_eps,
870 unsigned int num_streams, gfp_ 862 unsigned int num_streams, gfp_t mem_flags);
871 863
872 /* Reverts a group of bulk endpoints back to n 864 /* Reverts a group of bulk endpoints back to not using stream IDs. */
873 extern int usb_free_streams(struct usb_interfa 865 extern int usb_free_streams(struct usb_interface *interface,
874 struct usb_host_endpoint **eps 866 struct usb_host_endpoint **eps, unsigned int num_eps,
875 gfp_t mem_flags); 867 gfp_t mem_flags);
876 868
877 /* used these for multi-interface device regis 869 /* used these for multi-interface device registration */
878 extern int usb_driver_claim_interface(struct u 870 extern int usb_driver_claim_interface(struct usb_driver *driver,
879 struct usb_interface * 871 struct usb_interface *iface, void *data);
880 872
881 /** 873 /**
882 * usb_interface_claimed - returns true iff an 874 * usb_interface_claimed - returns true iff an interface is claimed
883 * @iface: the interface being checked 875 * @iface: the interface being checked
884 * 876 *
885 * Return: %true (nonzero) iff the interface i 877 * Return: %true (nonzero) iff the interface is claimed, else %false
886 * (zero). 878 * (zero).
887 * 879 *
888 * Note: 880 * Note:
889 * Callers must own the driver model's usb bus 881 * Callers must own the driver model's usb bus readlock. So driver
890 * probe() entries don't need extra locking, b 882 * probe() entries don't need extra locking, but other call contexts
891 * may need to explicitly claim that lock. 883 * may need to explicitly claim that lock.
892 * 884 *
893 */ 885 */
894 static inline int usb_interface_claimed(struct 886 static inline int usb_interface_claimed(struct usb_interface *iface)
895 { 887 {
896 return (iface->dev.driver != NULL); 888 return (iface->dev.driver != NULL);
897 } 889 }
898 890
899 extern void usb_driver_release_interface(struc 891 extern void usb_driver_release_interface(struct usb_driver *driver,
900 struct usb_interface * 892 struct usb_interface *iface);
901 893
902 int usb_set_wireless_status(struct usb_interfa 894 int usb_set_wireless_status(struct usb_interface *iface,
903 enum usb_wireless_stat 895 enum usb_wireless_status status);
904 896
905 const struct usb_device_id *usb_match_id(struc 897 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
906 const 898 const struct usb_device_id *id);
907 extern int usb_match_one_id(struct usb_interfa 899 extern int usb_match_one_id(struct usb_interface *interface,
908 const struct usb_d 900 const struct usb_device_id *id);
909 901
910 extern int usb_for_each_dev(void *data, int (* 902 extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
911 extern struct usb_interface *usb_find_interfac 903 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
912 int minor); 904 int minor);
913 extern struct usb_interface *usb_ifnum_to_if(c 905 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
914 unsigned ifnum); 906 unsigned ifnum);
915 extern struct usb_host_interface *usb_altnum_t 907 extern struct usb_host_interface *usb_altnum_to_altsetting(
916 const struct usb_interface *in 908 const struct usb_interface *intf, unsigned int altnum);
917 extern struct usb_host_interface *usb_find_alt 909 extern struct usb_host_interface *usb_find_alt_setting(
918 struct usb_host_config *config 910 struct usb_host_config *config,
919 unsigned int iface_num, 911 unsigned int iface_num,
920 unsigned int alt_num); 912 unsigned int alt_num);
921 913
922 /* port claiming functions */ 914 /* port claiming functions */
923 int usb_hub_claim_port(struct usb_device *hdev 915 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
924 struct usb_dev_state *owner); 916 struct usb_dev_state *owner);
925 int usb_hub_release_port(struct usb_device *hd 917 int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
926 struct usb_dev_state *owner); 918 struct usb_dev_state *owner);
927 919
928 /** 920 /**
929 * usb_make_path - returns stable device path 921 * usb_make_path - returns stable device path in the usb tree
930 * @dev: the device whose path is being constr 922 * @dev: the device whose path is being constructed
931 * @buf: where to put the string 923 * @buf: where to put the string
932 * @size: how big is "buf"? 924 * @size: how big is "buf"?
933 * 925 *
934 * Return: Length of the string (> 0) or negat 926 * Return: Length of the string (> 0) or negative if size was too small.
935 * 927 *
936 * Note: 928 * Note:
937 * This identifier is intended to be "stable", 929 * This identifier is intended to be "stable", reflecting physical paths in
938 * hardware such as physical bus addresses for 930 * hardware such as physical bus addresses for host controllers or ports on
939 * USB hubs. That makes it stay the same unti 931 * USB hubs. That makes it stay the same until systems are physically
940 * reconfigured, by re-cabling a tree of USB d 932 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
941 * controllers. Adding and removing devices, 933 * controllers. Adding and removing devices, including virtual root hubs
942 * in host controller driver modules, does not 934 * in host controller driver modules, does not change these path identifiers;
943 * neither does rebooting or re-enumerating. 935 * neither does rebooting or re-enumerating. These are more useful identifiers
944 * than changeable ("unstable") ones like bus 936 * than changeable ("unstable") ones like bus numbers or device addresses.
945 * 937 *
946 * With a partial exception for devices connec 938 * With a partial exception for devices connected to USB 2.0 root hubs, these
947 * identifiers are also predictable. So long 939 * identifiers are also predictable. So long as the device tree isn't changed,
948 * plugging any USB device into a given hub po 940 * plugging any USB device into a given hub port always gives it the same path.
949 * Because of the use of "companion" controlle 941 * Because of the use of "companion" controllers, devices connected to ports on
950 * USB 2.0 root hubs (EHCI host controllers) w 942 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
951 * high speed, and a different one if they are 943 * high speed, and a different one if they are full or low speed.
952 */ 944 */
953 static inline int usb_make_path(struct usb_dev 945 static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
954 { 946 {
955 int actual; 947 int actual;
956 actual = snprintf(buf, size, "usb-%s-% 948 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
957 dev->devpath); 949 dev->devpath);
958 return (actual >= (int)size) ? -1 : ac 950 return (actual >= (int)size) ? -1 : actual;
959 } 951 }
960 952
961 /*-------------------------------------------- 953 /*-------------------------------------------------------------------------*/
962 954
963 #define USB_DEVICE_ID_MATCH_DEVICE \ 955 #define USB_DEVICE_ID_MATCH_DEVICE \
964 (USB_DEVICE_ID_MATCH_VENDOR | 956 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
965 #define USB_DEVICE_ID_MATCH_DEV_RANGE \ 957 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
966 (USB_DEVICE_ID_MATCH_DEV_LO | 958 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
967 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION 959 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
968 (USB_DEVICE_ID_MATCH_DEVICE | 960 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
969 #define USB_DEVICE_ID_MATCH_DEV_INFO \ 961 #define USB_DEVICE_ID_MATCH_DEV_INFO \
970 (USB_DEVICE_ID_MATCH_DEV_CLASS 962 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
971 USB_DEVICE_ID_MATCH_DEV_SUBCLA 963 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
972 USB_DEVICE_ID_MATCH_DEV_PROTOC 964 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
973 #define USB_DEVICE_ID_MATCH_INT_INFO \ 965 #define USB_DEVICE_ID_MATCH_INT_INFO \
974 (USB_DEVICE_ID_MATCH_INT_CLASS 966 (USB_DEVICE_ID_MATCH_INT_CLASS | \
975 USB_DEVICE_ID_MATCH_INT_SUBCLA 967 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
976 USB_DEVICE_ID_MATCH_INT_PROTOC 968 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
977 969
978 /** 970 /**
979 * USB_DEVICE - macro used to describe a speci 971 * USB_DEVICE - macro used to describe a specific usb device
980 * @vend: the 16 bit USB Vendor ID 972 * @vend: the 16 bit USB Vendor ID
981 * @prod: the 16 bit USB Product ID 973 * @prod: the 16 bit USB Product ID
982 * 974 *
983 * This macro is used to create a struct usb_d 975 * This macro is used to create a struct usb_device_id that matches a
984 * specific device. 976 * specific device.
985 */ 977 */
986 #define USB_DEVICE(vend, prod) \ 978 #define USB_DEVICE(vend, prod) \
987 .match_flags = USB_DEVICE_ID_MATCH_DEV 979 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
988 .idVendor = (vend), \ 980 .idVendor = (vend), \
989 .idProduct = (prod) 981 .idProduct = (prod)
990 /** 982 /**
991 * USB_DEVICE_VER - describe a specific usb de 983 * USB_DEVICE_VER - describe a specific usb device with a version range
992 * @vend: the 16 bit USB Vendor ID 984 * @vend: the 16 bit USB Vendor ID
993 * @prod: the 16 bit USB Product ID 985 * @prod: the 16 bit USB Product ID
994 * @lo: the bcdDevice_lo value 986 * @lo: the bcdDevice_lo value
995 * @hi: the bcdDevice_hi value 987 * @hi: the bcdDevice_hi value
996 * 988 *
997 * This macro is used to create a struct usb_d 989 * This macro is used to create a struct usb_device_id that matches a
998 * specific device, with a version range. 990 * specific device, with a version range.
999 */ 991 */
1000 #define USB_DEVICE_VER(vend, prod, lo, hi) \ 992 #define USB_DEVICE_VER(vend, prod, lo, hi) \
1001 .match_flags = USB_DEVICE_ID_MATCH_DE 993 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
1002 .idVendor = (vend), \ 994 .idVendor = (vend), \
1003 .idProduct = (prod), \ 995 .idProduct = (prod), \
1004 .bcdDevice_lo = (lo), \ 996 .bcdDevice_lo = (lo), \
1005 .bcdDevice_hi = (hi) 997 .bcdDevice_hi = (hi)
1006 998
1007 /** 999 /**
1008 * USB_DEVICE_INTERFACE_CLASS - describe a us 1000 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
1009 * @vend: the 16 bit USB Vendor ID 1001 * @vend: the 16 bit USB Vendor ID
1010 * @prod: the 16 bit USB Product ID 1002 * @prod: the 16 bit USB Product ID
1011 * @cl: bInterfaceClass value 1003 * @cl: bInterfaceClass value
1012 * 1004 *
1013 * This macro is used to create a struct usb_ 1005 * This macro is used to create a struct usb_device_id that matches a
1014 * specific interface class of devices. 1006 * specific interface class of devices.
1015 */ 1007 */
1016 #define USB_DEVICE_INTERFACE_CLASS(vend, prod 1008 #define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
1017 .match_flags = USB_DEVICE_ID_MATCH_DE 1009 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
1018 USB_DEVICE_ID_MATCH_IN 1010 USB_DEVICE_ID_MATCH_INT_CLASS, \
1019 .idVendor = (vend), \ 1011 .idVendor = (vend), \
1020 .idProduct = (prod), \ 1012 .idProduct = (prod), \
1021 .bInterfaceClass = (cl) 1013 .bInterfaceClass = (cl)
1022 1014
1023 /** 1015 /**
1024 * USB_DEVICE_INTERFACE_PROTOCOL - describe a 1016 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
1025 * @vend: the 16 bit USB Vendor ID 1017 * @vend: the 16 bit USB Vendor ID
1026 * @prod: the 16 bit USB Product ID 1018 * @prod: the 16 bit USB Product ID
1027 * @pr: bInterfaceProtocol value 1019 * @pr: bInterfaceProtocol value
1028 * 1020 *
1029 * This macro is used to create a struct usb_ 1021 * This macro is used to create a struct usb_device_id that matches a
1030 * specific interface protocol of devices. 1022 * specific interface protocol of devices.
1031 */ 1023 */
1032 #define USB_DEVICE_INTERFACE_PROTOCOL(vend, p 1024 #define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
1033 .match_flags = USB_DEVICE_ID_MATCH_DE 1025 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
1034 USB_DEVICE_ID_MATCH_IN 1026 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
1035 .idVendor = (vend), \ 1027 .idVendor = (vend), \
1036 .idProduct = (prod), \ 1028 .idProduct = (prod), \
1037 .bInterfaceProtocol = (pr) 1029 .bInterfaceProtocol = (pr)
1038 1030
1039 /** 1031 /**
1040 * USB_DEVICE_INTERFACE_NUMBER - describe a u 1032 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
1041 * @vend: the 16 bit USB Vendor ID 1033 * @vend: the 16 bit USB Vendor ID
1042 * @prod: the 16 bit USB Product ID 1034 * @prod: the 16 bit USB Product ID
1043 * @num: bInterfaceNumber value 1035 * @num: bInterfaceNumber value
1044 * 1036 *
1045 * This macro is used to create a struct usb_ 1037 * This macro is used to create a struct usb_device_id that matches a
1046 * specific interface number of devices. 1038 * specific interface number of devices.
1047 */ 1039 */
1048 #define USB_DEVICE_INTERFACE_NUMBER(vend, pro 1040 #define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
1049 .match_flags = USB_DEVICE_ID_MATCH_DE 1041 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
1050 USB_DEVICE_ID_MATCH_IN 1042 USB_DEVICE_ID_MATCH_INT_NUMBER, \
1051 .idVendor = (vend), \ 1043 .idVendor = (vend), \
1052 .idProduct = (prod), \ 1044 .idProduct = (prod), \
1053 .bInterfaceNumber = (num) 1045 .bInterfaceNumber = (num)
1054 1046
1055 /** 1047 /**
1056 * USB_DEVICE_INFO - macro used to describe a 1048 * USB_DEVICE_INFO - macro used to describe a class of usb devices
1057 * @cl: bDeviceClass value 1049 * @cl: bDeviceClass value
1058 * @sc: bDeviceSubClass value 1050 * @sc: bDeviceSubClass value
1059 * @pr: bDeviceProtocol value 1051 * @pr: bDeviceProtocol value
1060 * 1052 *
1061 * This macro is used to create a struct usb_ 1053 * This macro is used to create a struct usb_device_id that matches a
1062 * specific class of devices. 1054 * specific class of devices.
1063 */ 1055 */
1064 #define USB_DEVICE_INFO(cl, sc, pr) \ 1056 #define USB_DEVICE_INFO(cl, sc, pr) \
1065 .match_flags = USB_DEVICE_ID_MATCH_DE 1057 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
1066 .bDeviceClass = (cl), \ 1058 .bDeviceClass = (cl), \
1067 .bDeviceSubClass = (sc), \ 1059 .bDeviceSubClass = (sc), \
1068 .bDeviceProtocol = (pr) 1060 .bDeviceProtocol = (pr)
1069 1061
1070 /** 1062 /**
1071 * USB_INTERFACE_INFO - macro used to describ 1063 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
1072 * @cl: bInterfaceClass value 1064 * @cl: bInterfaceClass value
1073 * @sc: bInterfaceSubClass value 1065 * @sc: bInterfaceSubClass value
1074 * @pr: bInterfaceProtocol value 1066 * @pr: bInterfaceProtocol value
1075 * 1067 *
1076 * This macro is used to create a struct usb_ 1068 * This macro is used to create a struct usb_device_id that matches a
1077 * specific class of interfaces. 1069 * specific class of interfaces.
1078 */ 1070 */
1079 #define USB_INTERFACE_INFO(cl, sc, pr) \ 1071 #define USB_INTERFACE_INFO(cl, sc, pr) \
1080 .match_flags = USB_DEVICE_ID_MATCH_IN 1072 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
1081 .bInterfaceClass = (cl), \ 1073 .bInterfaceClass = (cl), \
1082 .bInterfaceSubClass = (sc), \ 1074 .bInterfaceSubClass = (sc), \
1083 .bInterfaceProtocol = (pr) 1075 .bInterfaceProtocol = (pr)
1084 1076
1085 /** 1077 /**
1086 * USB_DEVICE_AND_INTERFACE_INFO - describe a 1078 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
1087 * @vend: the 16 bit USB Vendor ID 1079 * @vend: the 16 bit USB Vendor ID
1088 * @prod: the 16 bit USB Product ID 1080 * @prod: the 16 bit USB Product ID
1089 * @cl: bInterfaceClass value 1081 * @cl: bInterfaceClass value
1090 * @sc: bInterfaceSubClass value 1082 * @sc: bInterfaceSubClass value
1091 * @pr: bInterfaceProtocol value 1083 * @pr: bInterfaceProtocol value
1092 * 1084 *
1093 * This macro is used to create a struct usb_ 1085 * This macro is used to create a struct usb_device_id that matches a
1094 * specific device with a specific class of i 1086 * specific device with a specific class of interfaces.
1095 * 1087 *
1096 * This is especially useful when explicitly 1088 * This is especially useful when explicitly matching devices that have
1097 * vendor specific bDeviceClass values, but s 1089 * vendor specific bDeviceClass values, but standards-compliant interfaces.
1098 */ 1090 */
1099 #define USB_DEVICE_AND_INTERFACE_INFO(vend, p 1091 #define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
1100 .match_flags = USB_DEVICE_ID_MATCH_IN 1092 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
1101 | USB_DEVICE_ID_MATCH_DEVICE, 1093 | USB_DEVICE_ID_MATCH_DEVICE, \
1102 .idVendor = (vend), \ 1094 .idVendor = (vend), \
1103 .idProduct = (prod), \ 1095 .idProduct = (prod), \
1104 .bInterfaceClass = (cl), \ 1096 .bInterfaceClass = (cl), \
1105 .bInterfaceSubClass = (sc), \ 1097 .bInterfaceSubClass = (sc), \
1106 .bInterfaceProtocol = (pr) 1098 .bInterfaceProtocol = (pr)
1107 1099
1108 /** 1100 /**
1109 * USB_VENDOR_AND_INTERFACE_INFO - describe a 1101 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
1110 * @vend: the 16 bit USB Vendor ID 1102 * @vend: the 16 bit USB Vendor ID
1111 * @cl: bInterfaceClass value 1103 * @cl: bInterfaceClass value
1112 * @sc: bInterfaceSubClass value 1104 * @sc: bInterfaceSubClass value
1113 * @pr: bInterfaceProtocol value 1105 * @pr: bInterfaceProtocol value
1114 * 1106 *
1115 * This macro is used to create a struct usb_ 1107 * This macro is used to create a struct usb_device_id that matches a
1116 * specific vendor with a specific class of i 1108 * specific vendor with a specific class of interfaces.
1117 * 1109 *
1118 * This is especially useful when explicitly 1110 * This is especially useful when explicitly matching devices that have
1119 * vendor specific bDeviceClass values, but s 1111 * vendor specific bDeviceClass values, but standards-compliant interfaces.
1120 */ 1112 */
1121 #define USB_VENDOR_AND_INTERFACE_INFO(vend, c 1113 #define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
1122 .match_flags = USB_DEVICE_ID_MATCH_IN 1114 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
1123 | USB_DEVICE_ID_MATCH_VENDOR, 1115 | USB_DEVICE_ID_MATCH_VENDOR, \
1124 .idVendor = (vend), \ 1116 .idVendor = (vend), \
1125 .bInterfaceClass = (cl), \ 1117 .bInterfaceClass = (cl), \
1126 .bInterfaceSubClass = (sc), \ 1118 .bInterfaceSubClass = (sc), \
1127 .bInterfaceProtocol = (pr) 1119 .bInterfaceProtocol = (pr)
1128 1120
1129 /* ------------------------------------------ 1121 /* ----------------------------------------------------------------------- */
1130 1122
1131 /* Stuff for dynamic usb ids */ 1123 /* Stuff for dynamic usb ids */
1132 struct usb_dynids { 1124 struct usb_dynids {
1133 spinlock_t lock; 1125 spinlock_t lock;
1134 struct list_head list; 1126 struct list_head list;
1135 }; 1127 };
1136 1128
1137 struct usb_dynid { 1129 struct usb_dynid {
1138 struct list_head node; 1130 struct list_head node;
1139 struct usb_device_id id; 1131 struct usb_device_id id;
1140 }; 1132 };
1141 1133
1142 extern ssize_t usb_store_new_id(struct usb_dy 1134 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
1143 const struct 1135 const struct usb_device_id *id_table,
1144 struct device 1136 struct device_driver *driver,
1145 const char *b 1137 const char *buf, size_t count);
1146 1138
1147 extern ssize_t usb_show_dynids(struct usb_dyn 1139 extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);
1148 1140
1149 /** 1141 /**
1150 * struct usb_driver - identifies USB interfa 1142 * struct usb_driver - identifies USB interface driver to usbcore
1151 * @name: The driver name should be unique am 1143 * @name: The driver name should be unique among USB drivers,
1152 * and should normally be the same as th 1144 * and should normally be the same as the module name.
1153 * @probe: Called to see if the driver is wil 1145 * @probe: Called to see if the driver is willing to manage a particular
1154 * interface on a device. If it is, pro 1146 * interface on a device. If it is, probe returns zero and uses
1155 * usb_set_intfdata() to associate drive 1147 * usb_set_intfdata() to associate driver-specific data with the
1156 * interface. It may also use usb_set_i 1148 * interface. It may also use usb_set_interface() to specify the
1157 * appropriate altsetting. If unwilling 1149 * appropriate altsetting. If unwilling to manage the interface,
1158 * return -ENODEV, if genuine IO errors 1150 * return -ENODEV, if genuine IO errors occurred, an appropriate
1159 * negative errno value. 1151 * negative errno value.
1160 * @disconnect: Called when the interface is 1152 * @disconnect: Called when the interface is no longer accessible, usually
1161 * because its device has been (or is be 1153 * because its device has been (or is being) disconnected or the
1162 * driver module is being unloaded. 1154 * driver module is being unloaded.
1163 * @unlocked_ioctl: Used for drivers that wan 1155 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
1164 * the "usbfs" filesystem. This lets de 1156 * the "usbfs" filesystem. This lets devices provide ways to
1165 * expose information to user space rega 1157 * expose information to user space regardless of where they
1166 * do (or don't) show up otherwise in th 1158 * do (or don't) show up otherwise in the filesystem.
1167 * @suspend: Called when the device is going 1159 * @suspend: Called when the device is going to be suspended by the
1168 * system either from system sleep or ru 1160 * system either from system sleep or runtime suspend context. The
1169 * return value will be ignored in syste 1161 * return value will be ignored in system sleep context, so do NOT
1170 * try to continue using the device if s 1162 * try to continue using the device if suspend fails in this case.
1171 * Instead, let the resume or reset-resu 1163 * Instead, let the resume or reset-resume routine recover from
1172 * the failure. 1164 * the failure.
1173 * @resume: Called when the device is being r 1165 * @resume: Called when the device is being resumed by the system.
1174 * @reset_resume: Called when the suspended d 1166 * @reset_resume: Called when the suspended device has been reset instead
1175 * of being resumed. 1167 * of being resumed.
1176 * @pre_reset: Called by usb_reset_device() w 1168 * @pre_reset: Called by usb_reset_device() when the device is about to be
1177 * reset. This routine must not return 1169 * reset. This routine must not return until the driver has no active
1178 * URBs for the device, and no more URBs 1170 * URBs for the device, and no more URBs may be submitted until the
1179 * post_reset method is called. 1171 * post_reset method is called.
1180 * @post_reset: Called by usb_reset_device() 1172 * @post_reset: Called by usb_reset_device() after the device
1181 * has been reset 1173 * has been reset
1182 * @shutdown: Called at shut-down time to qui <<
1183 * @id_table: USB drivers use ID table to sup 1174 * @id_table: USB drivers use ID table to support hotplugging.
1184 * Export this with MODULE_DEVICE_TABLE( 1175 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
1185 * or your driver's probe function will 1176 * or your driver's probe function will never get called.
1186 * @dev_groups: Attributes attached to the de 1177 * @dev_groups: Attributes attached to the device that will be created once it
1187 * is bound to the driver. 1178 * is bound to the driver.
1188 * @dynids: used internally to hold the list 1179 * @dynids: used internally to hold the list of dynamically added device
1189 * ids for this driver. 1180 * ids for this driver.
1190 * @driver: The driver-model core driver stru 1181 * @driver: The driver-model core driver structure.
1191 * @no_dynamic_id: if set to 1, the USB core 1182 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
1192 * added to this driver by preventing th 1183 * added to this driver by preventing the sysfs file from being created.
1193 * @supports_autosuspend: if set to 0, the US 1184 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1194 * for interfaces bound to this driver. 1185 * for interfaces bound to this driver.
1195 * @soft_unbind: if set to 1, the USB core wi 1186 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
1196 * endpoints before calling the driver's 1187 * endpoints before calling the driver's disconnect method.
1197 * @disable_hub_initiated_lpm: if set to 1, t 1188 * @disable_hub_initiated_lpm: if set to 1, the USB core will not allow hubs
1198 * to initiate lower power link state tr 1189 * to initiate lower power link state transitions when an idle timeout
1199 * occurs. Device-initiated USB 3.0 lin 1190 * occurs. Device-initiated USB 3.0 link PM will still be allowed.
1200 * 1191 *
1201 * USB interface drivers must provide a name, 1192 * USB interface drivers must provide a name, probe() and disconnect()
1202 * methods, and an id_table. Other driver fi 1193 * methods, and an id_table. Other driver fields are optional.
1203 * 1194 *
1204 * The id_table is used in hotplugging. It h 1195 * The id_table is used in hotplugging. It holds a set of descriptors,
1205 * and specialized data may be associated wit 1196 * and specialized data may be associated with each entry. That table
1206 * is used by both user and kernel mode hotpl 1197 * is used by both user and kernel mode hotplugging support.
1207 * 1198 *
1208 * The probe() and disconnect() methods are c 1199 * The probe() and disconnect() methods are called in a context where
1209 * they can sleep, but they should avoid abus 1200 * they can sleep, but they should avoid abusing the privilege. Most
1210 * work to connect to a device should be done 1201 * work to connect to a device should be done when the device is opened,
1211 * and undone at the last close. The disconn 1202 * and undone at the last close. The disconnect code needs to address
1212 * concurrency issues with respect to open() 1203 * concurrency issues with respect to open() and close() methods, as
1213 * well as forcing all pending I/O requests t 1204 * well as forcing all pending I/O requests to complete (by unlinking
1214 * them as necessary, and blocking until the 1205 * them as necessary, and blocking until the unlinks complete).
1215 */ 1206 */
1216 struct usb_driver { 1207 struct usb_driver {
1217 const char *name; 1208 const char *name;
1218 1209
1219 int (*probe) (struct usb_interface *i 1210 int (*probe) (struct usb_interface *intf,
1220 const struct usb_device 1211 const struct usb_device_id *id);
1221 1212
1222 void (*disconnect) (struct usb_interf 1213 void (*disconnect) (struct usb_interface *intf);
1223 1214
1224 int (*unlocked_ioctl) (struct usb_int 1215 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
1225 void *buf); 1216 void *buf);
1226 1217
1227 int (*suspend) (struct usb_interface 1218 int (*suspend) (struct usb_interface *intf, pm_message_t message);
1228 int (*resume) (struct usb_interface * 1219 int (*resume) (struct usb_interface *intf);
1229 int (*reset_resume)(struct usb_interf 1220 int (*reset_resume)(struct usb_interface *intf);
1230 1221
1231 int (*pre_reset)(struct usb_interface 1222 int (*pre_reset)(struct usb_interface *intf);
1232 int (*post_reset)(struct usb_interfac 1223 int (*post_reset)(struct usb_interface *intf);
1233 <<
1234 void (*shutdown)(struct usb_interface <<
1235 1224
1236 const struct usb_device_id *id_table; 1225 const struct usb_device_id *id_table;
1237 const struct attribute_group **dev_gr 1226 const struct attribute_group **dev_groups;
1238 1227
1239 struct usb_dynids dynids; 1228 struct usb_dynids dynids;
1240 struct device_driver driver; 1229 struct device_driver driver;
1241 unsigned int no_dynamic_id:1; 1230 unsigned int no_dynamic_id:1;
1242 unsigned int supports_autosuspend:1; 1231 unsigned int supports_autosuspend:1;
1243 unsigned int disable_hub_initiated_lp 1232 unsigned int disable_hub_initiated_lpm:1;
1244 unsigned int soft_unbind:1; 1233 unsigned int soft_unbind:1;
1245 }; 1234 };
1246 #define to_usb_driver(d) container_of(d, stru 1235 #define to_usb_driver(d) container_of(d, struct usb_driver, driver)
1247 1236
1248 /** 1237 /**
1249 * struct usb_device_driver - identifies USB 1238 * struct usb_device_driver - identifies USB device driver to usbcore
1250 * @name: The driver name should be unique am 1239 * @name: The driver name should be unique among USB drivers,
1251 * and should normally be the same as th 1240 * and should normally be the same as the module name.
1252 * @match: If set, used for better device/dri 1241 * @match: If set, used for better device/driver matching.
1253 * @probe: Called to see if the driver is wil 1242 * @probe: Called to see if the driver is willing to manage a particular
1254 * device. If it is, probe returns zero 1243 * device. If it is, probe returns zero and uses dev_set_drvdata()
1255 * to associate driver-specific data wit 1244 * to associate driver-specific data with the device. If unwilling
1256 * to manage the device, return a negati 1245 * to manage the device, return a negative errno value.
1257 * @disconnect: Called when the device is no 1246 * @disconnect: Called when the device is no longer accessible, usually
1258 * because it has been (or is being) dis 1247 * because it has been (or is being) disconnected or the driver's
1259 * module is being unloaded. 1248 * module is being unloaded.
1260 * @suspend: Called when the device is going 1249 * @suspend: Called when the device is going to be suspended by the system.
1261 * @resume: Called when the device is being r 1250 * @resume: Called when the device is being resumed by the system.
1262 * @choose_configuration: If non-NULL, called 1251 * @choose_configuration: If non-NULL, called instead of the default
1263 * usb_choose_configuration(). If this r 1252 * usb_choose_configuration(). If this returns an error then we'll go
1264 * on to call the normal usb_choose_conf 1253 * on to call the normal usb_choose_configuration().
1265 * @dev_groups: Attributes attached to the de 1254 * @dev_groups: Attributes attached to the device that will be created once it
1266 * is bound to the driver. 1255 * is bound to the driver.
1267 * @driver: The driver-model core driver stru 1256 * @driver: The driver-model core driver structure.
1268 * @id_table: used with @match() to select be 1257 * @id_table: used with @match() to select better matching driver at
1269 * probe() time. 1258 * probe() time.
1270 * @supports_autosuspend: if set to 0, the US 1259 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1271 * for devices bound to this driver. 1260 * for devices bound to this driver.
1272 * @generic_subclass: if set to 1, the generi 1261 * @generic_subclass: if set to 1, the generic USB driver's probe, disconnect,
1273 * resume and suspend functions will be 1262 * resume and suspend functions will be called in addition to the driver's
1274 * own, so this part of the setup does n 1263 * own, so this part of the setup does not need to be replicated.
1275 * 1264 *
1276 * USB drivers must provide all the fields li 1265 * USB drivers must provide all the fields listed above except driver,
1277 * match, and id_table. 1266 * match, and id_table.
1278 */ 1267 */
1279 struct usb_device_driver { 1268 struct usb_device_driver {
1280 const char *name; 1269 const char *name;
1281 1270
1282 bool (*match) (struct usb_device *ude 1271 bool (*match) (struct usb_device *udev);
1283 int (*probe) (struct usb_device *udev 1272 int (*probe) (struct usb_device *udev);
1284 void (*disconnect) (struct usb_device 1273 void (*disconnect) (struct usb_device *udev);
1285 1274
1286 int (*suspend) (struct usb_device *ud 1275 int (*suspend) (struct usb_device *udev, pm_message_t message);
1287 int (*resume) (struct usb_device *ude 1276 int (*resume) (struct usb_device *udev, pm_message_t message);
1288 1277
1289 int (*choose_configuration) (struct u 1278 int (*choose_configuration) (struct usb_device *udev);
1290 1279
1291 const struct attribute_group **dev_gr 1280 const struct attribute_group **dev_groups;
1292 struct device_driver driver; 1281 struct device_driver driver;
1293 const struct usb_device_id *id_table; 1282 const struct usb_device_id *id_table;
1294 unsigned int supports_autosuspend:1; 1283 unsigned int supports_autosuspend:1;
1295 unsigned int generic_subclass:1; 1284 unsigned int generic_subclass:1;
1296 }; 1285 };
1297 #define to_usb_device_driver(d) container_of( 1286 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1298 driver) 1287 driver)
1299 1288
1300 /** 1289 /**
1301 * struct usb_class_driver - identifies a USB 1290 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
1302 * @name: the usb class device name for this 1291 * @name: the usb class device name for this driver. Will show up in sysfs.
1303 * @devnode: Callback to provide a naming hin 1292 * @devnode: Callback to provide a naming hint for a possible
1304 * device node to create. 1293 * device node to create.
1305 * @fops: pointer to the struct file_operatio 1294 * @fops: pointer to the struct file_operations of this driver.
1306 * @minor_base: the start of the minor range 1295 * @minor_base: the start of the minor range for this driver.
1307 * 1296 *
1308 * This structure is used for the usb_registe 1297 * This structure is used for the usb_register_dev() and
1309 * usb_deregister_dev() functions, to consoli 1298 * usb_deregister_dev() functions, to consolidate a number of the
1310 * parameters used for them. 1299 * parameters used for them.
1311 */ 1300 */
1312 struct usb_class_driver { 1301 struct usb_class_driver {
1313 char *name; 1302 char *name;
1314 char *(*devnode)(const struct device 1303 char *(*devnode)(const struct device *dev, umode_t *mode);
1315 const struct file_operations *fops; 1304 const struct file_operations *fops;
1316 int minor_base; 1305 int minor_base;
1317 }; 1306 };
1318 1307
1319 /* 1308 /*
1320 * use these in module_init()/module_exit() 1309 * use these in module_init()/module_exit()
1321 * and don't forget MODULE_DEVICE_TABLE(usb, 1310 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1322 */ 1311 */
1323 extern int usb_register_driver(struct usb_dri 1312 extern int usb_register_driver(struct usb_driver *, struct module *,
1324 const char *); 1313 const char *);
1325 1314
1326 /* use a define to avoid include chaining to 1315 /* use a define to avoid include chaining to get THIS_MODULE & friends */
1327 #define usb_register(driver) \ 1316 #define usb_register(driver) \
1328 usb_register_driver(driver, THIS_MODU 1317 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1329 1318
1330 extern void usb_deregister(struct usb_driver 1319 extern void usb_deregister(struct usb_driver *);
1331 1320
1332 /** 1321 /**
1333 * module_usb_driver() - Helper macro for reg 1322 * module_usb_driver() - Helper macro for registering a USB driver
1334 * @__usb_driver: usb_driver struct 1323 * @__usb_driver: usb_driver struct
1335 * 1324 *
1336 * Helper macro for USB drivers which do not 1325 * Helper macro for USB drivers which do not do anything special in module
1337 * init/exit. This eliminates a lot of boiler 1326 * init/exit. This eliminates a lot of boilerplate. Each module may only
1338 * use this macro once, and calling it replac 1327 * use this macro once, and calling it replaces module_init() and module_exit()
1339 */ 1328 */
1340 #define module_usb_driver(__usb_driver) \ 1329 #define module_usb_driver(__usb_driver) \
1341 module_driver(__usb_driver, usb_regis 1330 module_driver(__usb_driver, usb_register, \
1342 usb_deregister) 1331 usb_deregister)
1343 1332
1344 extern int usb_register_device_driver(struct 1333 extern int usb_register_device_driver(struct usb_device_driver *,
1345 struct module *); 1334 struct module *);
1346 extern void usb_deregister_device_driver(stru 1335 extern void usb_deregister_device_driver(struct usb_device_driver *);
1347 1336
1348 extern int usb_register_dev(struct usb_interf 1337 extern int usb_register_dev(struct usb_interface *intf,
1349 struct usb_class_ 1338 struct usb_class_driver *class_driver);
1350 extern void usb_deregister_dev(struct usb_int 1339 extern void usb_deregister_dev(struct usb_interface *intf,
1351 struct usb_cla 1340 struct usb_class_driver *class_driver);
1352 1341
1353 extern int usb_disabled(void); 1342 extern int usb_disabled(void);
1354 1343
1355 /* ------------------------------------------ 1344 /* ----------------------------------------------------------------------- */
1356 1345
1357 /* 1346 /*
1358 * URB support, for asynchronous request comp 1347 * URB support, for asynchronous request completions
1359 */ 1348 */
1360 1349
1361 /* 1350 /*
1362 * urb->transfer_flags: 1351 * urb->transfer_flags:
1363 * 1352 *
1364 * Note: URB_DIR_IN/OUT is automatically set 1353 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1365 */ 1354 */
1366 #define URB_SHORT_NOT_OK 0x0001 /* re 1355 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1367 #define URB_ISO_ASAP 0x0002 /* is 1356 #define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired
1368 * sl 1357 * slot in the schedule */
1369 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* ur 1358 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1370 #define URB_ZERO_PACKET 0x0040 /* Fi 1359 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1371 #define URB_NO_INTERRUPT 0x0080 /* HI 1360 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1372 * ne 1361 * needed */
1373 #define URB_FREE_BUFFER 0x0100 /* Fr 1362 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1374 1363
1375 /* The following flags are used internally by 1364 /* The following flags are used internally by usbcore and HCDs */
1376 #define URB_DIR_IN 0x0200 /* Tr 1365 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1377 #define URB_DIR_OUT 0 1366 #define URB_DIR_OUT 0
1378 #define URB_DIR_MASK URB_DIR_IN 1367 #define URB_DIR_MASK URB_DIR_IN
1379 1368
1380 #define URB_DMA_MAP_SINGLE 0x00010000 1369 #define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */
1381 #define URB_DMA_MAP_PAGE 0x00020000 1370 #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */
1382 #define URB_DMA_MAP_SG 0x00040000 1371 #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */
1383 #define URB_MAP_LOCAL 0x00080000 1372 #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */
1384 #define URB_SETUP_MAP_SINGLE 0x00100000 1373 #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */
1385 #define URB_SETUP_MAP_LOCAL 0x00200000 1374 #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */
1386 #define URB_DMA_SG_COMBINED 0x00400000 1375 #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */
1387 #define URB_ALIGNED_TEMP_BUFFER 0x00800000 1376 #define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */
1388 1377
1389 struct usb_iso_packet_descriptor { 1378 struct usb_iso_packet_descriptor {
1390 unsigned int offset; 1379 unsigned int offset;
1391 unsigned int length; /* ex 1380 unsigned int length; /* expected length */
1392 unsigned int actual_length; 1381 unsigned int actual_length;
1393 int status; 1382 int status;
1394 }; 1383 };
1395 1384
1396 struct urb; 1385 struct urb;
1397 1386
1398 struct usb_anchor { 1387 struct usb_anchor {
1399 struct list_head urb_list; 1388 struct list_head urb_list;
1400 wait_queue_head_t wait; 1389 wait_queue_head_t wait;
1401 spinlock_t lock; 1390 spinlock_t lock;
1402 atomic_t suspend_wakeups; 1391 atomic_t suspend_wakeups;
1403 unsigned int poisoned:1; 1392 unsigned int poisoned:1;
1404 }; 1393 };
1405 1394
1406 static inline void init_usb_anchor(struct usb 1395 static inline void init_usb_anchor(struct usb_anchor *anchor)
1407 { 1396 {
1408 memset(anchor, 0, sizeof(*anchor)); 1397 memset(anchor, 0, sizeof(*anchor));
1409 INIT_LIST_HEAD(&anchor->urb_list); 1398 INIT_LIST_HEAD(&anchor->urb_list);
1410 init_waitqueue_head(&anchor->wait); 1399 init_waitqueue_head(&anchor->wait);
1411 spin_lock_init(&anchor->lock); 1400 spin_lock_init(&anchor->lock);
1412 } 1401 }
1413 1402
1414 typedef void (*usb_complete_t)(struct urb *); 1403 typedef void (*usb_complete_t)(struct urb *);
1415 1404
1416 /** 1405 /**
1417 * struct urb - USB Request Block 1406 * struct urb - USB Request Block
1418 * @urb_list: For use by current owner of the 1407 * @urb_list: For use by current owner of the URB.
1419 * @anchor_list: membership in the list of an 1408 * @anchor_list: membership in the list of an anchor
1420 * @anchor: to anchor URBs to a common moorin 1409 * @anchor: to anchor URBs to a common mooring
1421 * @ep: Points to the endpoint's data structu 1410 * @ep: Points to the endpoint's data structure. Will eventually
1422 * replace @pipe. 1411 * replace @pipe.
1423 * @pipe: Holds endpoint number, direction, t 1412 * @pipe: Holds endpoint number, direction, type, and more.
1424 * Create these values with the eight ma 1413 * Create these values with the eight macros available;
1425 * usb_{snd,rcv}TYPEpipe(dev,endpoint), 1414 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1426 * (control), "bulk", "int" (interrupt), 1415 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1427 * For example usb_sndbulkpipe() or usb_ 1416 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1428 * numbers range from zero to fifteen. 1417 * numbers range from zero to fifteen. Note that "in" endpoint two
1429 * is a different endpoint (and pipe) fr 1418 * is a different endpoint (and pipe) from "out" endpoint two.
1430 * The current configuration controls th 1419 * The current configuration controls the existence, type, and
1431 * maximum packet size of any given endp 1420 * maximum packet size of any given endpoint.
1432 * @stream_id: the endpoint's stream ID for b 1421 * @stream_id: the endpoint's stream ID for bulk streams
1433 * @dev: Identifies the USB device to perform 1422 * @dev: Identifies the USB device to perform the request.
1434 * @status: This is read in non-iso completio 1423 * @status: This is read in non-iso completion functions to get the
1435 * status of the particular request. IS 1424 * status of the particular request. ISO requests only use it
1436 * to tell whether the URB was unlinked; 1425 * to tell whether the URB was unlinked; detailed status for
1437 * each frame is in the fields of the is 1426 * each frame is in the fields of the iso_frame-desc.
1438 * @transfer_flags: A variety of flags may be 1427 * @transfer_flags: A variety of flags may be used to affect how URB
1439 * submission, unlinking, or operation a 1428 * submission, unlinking, or operation are handled. Different
1440 * kinds of URB can use different flags. 1429 * kinds of URB can use different flags.
1441 * @transfer_buffer: This identifies the buf 1430 * @transfer_buffer: This identifies the buffer to (or from) which the I/O
1442 * request will be performed unless URB_ 1431 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
1443 * (however, do not leave garbage in tra 1432 * (however, do not leave garbage in transfer_buffer even then).
1444 * This buffer must be suitable for DMA; 1433 * This buffer must be suitable for DMA; allocate it with
1445 * kmalloc() or equivalent. For transfe 1434 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1446 * of this buffer will be modified. Thi 1435 * of this buffer will be modified. This buffer is used for the data
1447 * stage of control transfers. 1436 * stage of control transfers.
1448 * @transfer_dma: When transfer_flags include 1437 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1449 * the device driver is saying that it p 1438 * the device driver is saying that it provided this DMA address,
1450 * which the host controller driver shou 1439 * which the host controller driver should use in preference to the
1451 * transfer_buffer. 1440 * transfer_buffer.
1452 * @sg: scatter gather buffer list, the buffe 1441 * @sg: scatter gather buffer list, the buffer size of each element in
1453 * the list (except the last) must be di 1442 * the list (except the last) must be divisible by the endpoint's
1454 * max packet size if no_sg_constraint i 1443 * max packet size if no_sg_constraint isn't set in 'struct usb_bus'
1455 * @num_mapped_sgs: (internal) number of mapp 1444 * @num_mapped_sgs: (internal) number of mapped sg entries
1456 * @num_sgs: number of entries in the sg list 1445 * @num_sgs: number of entries in the sg list
1457 * @transfer_buffer_length: How big is transf 1446 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1458 * be broken up into chunks according to 1447 * be broken up into chunks according to the current maximum packet
1459 * size for the endpoint, which is a fun 1448 * size for the endpoint, which is a function of the configuration
1460 * and is encoded in the pipe. When the 1449 * and is encoded in the pipe. When the length is zero, neither
1461 * transfer_buffer nor transfer_dma is u 1450 * transfer_buffer nor transfer_dma is used.
1462 * @actual_length: This is read in non-iso co 1451 * @actual_length: This is read in non-iso completion functions, and
1463 * it tells how many bytes (out of trans 1452 * it tells how many bytes (out of transfer_buffer_length) were
1464 * transferred. It will normally be the 1453 * transferred. It will normally be the same as requested, unless
1465 * either an error was reported or a sho 1454 * either an error was reported or a short read was performed.
1466 * The URB_SHORT_NOT_OK transfer flag ma 1455 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1467 * short reads be reported as errors. 1456 * short reads be reported as errors.
1468 * @setup_packet: Only used for control trans 1457 * @setup_packet: Only used for control transfers, this points to eight bytes
1469 * of setup data. Control transfers alw 1458 * of setup data. Control transfers always start by sending this data
1470 * to the device. Then transfer_buffer 1459 * to the device. Then transfer_buffer is read or written, if needed.
1471 * @setup_dma: DMA pointer for the setup pack 1460 * @setup_dma: DMA pointer for the setup packet. The caller must not use
1472 * this field; setup_packet must point t 1461 * this field; setup_packet must point to a valid buffer.
1473 * @start_frame: Returns the initial frame fo 1462 * @start_frame: Returns the initial frame for isochronous transfers.
1474 * @number_of_packets: Lists the number of IS 1463 * @number_of_packets: Lists the number of ISO transfer buffers.
1475 * @interval: Specifies the polling interval 1464 * @interval: Specifies the polling interval for interrupt or isochronous
1476 * transfers. The units are frames (mil 1465 * transfers. The units are frames (milliseconds) for full and low
1477 * speed devices, and microframes (1/8 m 1466 * speed devices, and microframes (1/8 millisecond) for highspeed
1478 * and SuperSpeed devices. 1467 * and SuperSpeed devices.
1479 * @error_count: Returns the number of ISO tr 1468 * @error_count: Returns the number of ISO transfers that reported errors.
1480 * @context: For use in completion functions. 1469 * @context: For use in completion functions. This normally points to
1481 * request-specific driver context. 1470 * request-specific driver context.
1482 * @complete: Completion handler. This URB is 1471 * @complete: Completion handler. This URB is passed as the parameter to the
1483 * completion function. The completion 1472 * completion function. The completion function may then do what
1484 * it likes with the URB, including resu 1473 * it likes with the URB, including resubmitting or freeing it.
1485 * @iso_frame_desc: Used to provide arrays of 1474 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1486 * collect the transfer status for each 1475 * collect the transfer status for each buffer.
1487 * 1476 *
1488 * This structure identifies USB transfer req 1477 * This structure identifies USB transfer requests. URBs must be allocated by
1489 * calling usb_alloc_urb() and freed with a c 1478 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1490 * Initialization may be done using various u 1479 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1491 * are submitted using usb_submit_urb(), and 1480 * are submitted using usb_submit_urb(), and pending requests may be canceled
1492 * using usb_unlink_urb() or usb_kill_urb(). 1481 * using usb_unlink_urb() or usb_kill_urb().
1493 * 1482 *
1494 * Data Transfer Buffers: 1483 * Data Transfer Buffers:
1495 * 1484 *
1496 * Normally drivers provide I/O buffers alloc 1485 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1497 * taken from the general page pool. That is 1486 * taken from the general page pool. That is provided by transfer_buffer
1498 * (control requests also use setup_packet), 1487 * (control requests also use setup_packet), and host controller drivers
1499 * perform a dma mapping (and unmapping) for 1488 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1500 * mapping operations can be expensive on som 1489 * mapping operations can be expensive on some platforms (perhaps using a dma
1501 * bounce buffer or talking to an IOMMU), 1490 * bounce buffer or talking to an IOMMU),
1502 * although they're cheap on commodity x86 an 1491 * although they're cheap on commodity x86 and ppc hardware.
1503 * 1492 *
1504 * Alternatively, drivers may pass the URB_NO 1493 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
1505 * which tells the host controller driver tha 1494 * which tells the host controller driver that no such mapping is needed for
1506 * the transfer_buffer since 1495 * the transfer_buffer since
1507 * the device driver is DMA-aware. For examp 1496 * the device driver is DMA-aware. For example, a device driver might
1508 * allocate a DMA buffer with usb_alloc_coher 1497 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
1509 * When this transfer flag is provided, host 1498 * When this transfer flag is provided, host controller drivers will
1510 * attempt to use the dma address found in th 1499 * attempt to use the dma address found in the transfer_dma
1511 * field rather than determining a dma addres 1500 * field rather than determining a dma address themselves.
1512 * 1501 *
1513 * Note that transfer_buffer must still be se 1502 * Note that transfer_buffer must still be set if the controller
1514 * does not support DMA (as indicated by hcd_ 1503 * does not support DMA (as indicated by hcd_uses_dma()) and when talking
1515 * to root hub. If you have to transfer betwe 1504 * to root hub. If you have to transfer between highmem zone and the device
1516 * on such controller, create a bounce buffer 1505 * on such controller, create a bounce buffer or bail out with an error.
1517 * If transfer_buffer cannot be set (is in hi 1506 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
1518 * capable, assign NULL to it, so that usbmon 1507 * capable, assign NULL to it, so that usbmon knows not to use the value.
1519 * The setup_packet must always be set, so it 1508 * The setup_packet must always be set, so it cannot be located in highmem.
1520 * 1509 *
1521 * Initialization: 1510 * Initialization:
1522 * 1511 *
1523 * All URBs submitted must initialize the dev 1512 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1524 * zero), and complete fields. All URBs must 1513 * zero), and complete fields. All URBs must also initialize
1525 * transfer_buffer and transfer_buffer_length 1514 * transfer_buffer and transfer_buffer_length. They may provide the
1526 * URB_SHORT_NOT_OK transfer flag, indicating 1515 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1527 * to be treated as errors; that flag is inva 1516 * to be treated as errors; that flag is invalid for write requests.
1528 * 1517 *
1529 * Bulk URBs may 1518 * Bulk URBs may
1530 * use the URB_ZERO_PACKET transfer flag, ind 1519 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1531 * should always terminate with a short packe 1520 * should always terminate with a short packet, even if it means adding an
1532 * extra zero length packet. 1521 * extra zero length packet.
1533 * 1522 *
1534 * Control URBs must provide a valid pointer 1523 * Control URBs must provide a valid pointer in the setup_packet field.
1535 * Unlike the transfer_buffer, the setup_pack 1524 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
1536 * beforehand. 1525 * beforehand.
1537 * 1526 *
1538 * Interrupt URBs must provide an interval, s 1527 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1539 * or, for highspeed devices, 125 microsecond 1528 * or, for highspeed devices, 125 microsecond units)
1540 * to poll for transfers. After the URB has 1529 * to poll for transfers. After the URB has been submitted, the interval
1541 * field reflects how the transfer was actual 1530 * field reflects how the transfer was actually scheduled.
1542 * The polling interval may be more frequent 1531 * The polling interval may be more frequent than requested.
1543 * For example, some controllers have a maxim 1532 * For example, some controllers have a maximum interval of 32 milliseconds,
1544 * while others support intervals of up to 10 1533 * while others support intervals of up to 1024 milliseconds.
1545 * Isochronous URBs also have transfer interv 1534 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1546 * endpoints, as well as high speed interrupt 1535 * endpoints, as well as high speed interrupt endpoints, the encoding of
1547 * the transfer interval in the endpoint desc 1536 * the transfer interval in the endpoint descriptor is logarithmic.
1548 * Device drivers must convert that value to 1537 * Device drivers must convert that value to linear units themselves.)
1549 * 1538 *
1550 * If an isochronous endpoint queue isn't alr 1539 * If an isochronous endpoint queue isn't already running, the host
1551 * controller will schedule a new URB to star 1540 * controller will schedule a new URB to start as soon as bandwidth
1552 * utilization allows. If the queue is runni 1541 * utilization allows. If the queue is running then a new URB will be
1553 * scheduled to start in the first transfer s 1542 * scheduled to start in the first transfer slot following the end of the
1554 * preceding URB, if that slot has not alread 1543 * preceding URB, if that slot has not already expired. If the slot has
1555 * expired (which can happen when IRQ deliver 1544 * expired (which can happen when IRQ delivery is delayed for a long time),
1556 * the scheduling behavior depends on the URB 1545 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag
1557 * is clear then the URB will be scheduled to 1546 * is clear then the URB will be scheduled to start in the expired slot,
1558 * implying that some of its packets will not 1547 * implying that some of its packets will not be transferred; if the flag
1559 * is set then the URB will be scheduled in t 1548 * is set then the URB will be scheduled in the first unexpired slot,
1560 * breaking the queue's synchronization. Upo 1549 * breaking the queue's synchronization. Upon URB completion, the
1561 * start_frame field will be set to the (micr 1550 * start_frame field will be set to the (micro)frame number in which the
1562 * transfer was scheduled. Ranges for frame 1551 * transfer was scheduled. Ranges for frame counter values are HC-specific
1563 * and can go from as low as 256 to as high a 1552 * and can go from as low as 256 to as high as 65536 frames.
1564 * 1553 *
1565 * Isochronous URBs have a different data tra 1554 * Isochronous URBs have a different data transfer model, in part because
1566 * the quality of service is only "best effor 1555 * the quality of service is only "best effort". Callers provide specially
1567 * allocated URBs, with number_of_packets wor 1556 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1568 * at the end. Each such packet is an indivi 1557 * at the end. Each such packet is an individual ISO transfer. Isochronous
1569 * URBs are normally queued, submitted by dri 1558 * URBs are normally queued, submitted by drivers to arrange that
1570 * transfers are at least double buffered, an 1559 * transfers are at least double buffered, and then explicitly resubmitted
1571 * in completion handlers, so 1560 * in completion handlers, so
1572 * that data (such as audio or video) streams 1561 * that data (such as audio or video) streams at as constant a rate as the
1573 * host controller scheduler can support. 1562 * host controller scheduler can support.
1574 * 1563 *
1575 * Completion Callbacks: 1564 * Completion Callbacks:
1576 * 1565 *
1577 * The completion callback is made in_interru 1566 * The completion callback is made in_interrupt(), and one of the first
1578 * things that a completion handler should do 1567 * things that a completion handler should do is check the status field.
1579 * The status field is provided for all URBs. 1568 * The status field is provided for all URBs. It is used to report
1580 * unlinked URBs, and status for all non-ISO 1569 * unlinked URBs, and status for all non-ISO transfers. It should not
1581 * be examined before the URB is returned to 1570 * be examined before the URB is returned to the completion handler.
1582 * 1571 *
1583 * The context field is normally used to link 1572 * The context field is normally used to link URBs back to the relevant
1584 * driver or request state. 1573 * driver or request state.
1585 * 1574 *
1586 * When the completion callback is invoked fo 1575 * When the completion callback is invoked for non-isochronous URBs, the
1587 * actual_length field tells how many bytes w 1576 * actual_length field tells how many bytes were transferred. This field
1588 * is updated even when the URB terminated wi 1577 * is updated even when the URB terminated with an error or was unlinked.
1589 * 1578 *
1590 * ISO transfer status is reported in the sta 1579 * ISO transfer status is reported in the status and actual_length fields
1591 * of the iso_frame_desc array, and the numbe 1580 * of the iso_frame_desc array, and the number of errors is reported in
1592 * error_count. Completion callbacks for ISO 1581 * error_count. Completion callbacks for ISO transfers will normally
1593 * (re)submit URBs to ensure a constant trans 1582 * (re)submit URBs to ensure a constant transfer rate.
1594 * 1583 *
1595 * Note that even fields marked "public" shou 1584 * Note that even fields marked "public" should not be touched by the driver
1596 * when the urb is owned by the hcd, that is, 1585 * when the urb is owned by the hcd, that is, since the call to
1597 * usb_submit_urb() till the entry into the c 1586 * usb_submit_urb() till the entry into the completion routine.
1598 */ 1587 */
1599 struct urb { 1588 struct urb {
1600 /* private: usb core and host control 1589 /* private: usb core and host controller only fields in the urb */
1601 struct kref kref; /* re 1590 struct kref kref; /* reference count of the URB */
1602 int unlinked; /* un 1591 int unlinked; /* unlink error code */
1603 void *hcpriv; /* pr 1592 void *hcpriv; /* private data for host controller */
1604 atomic_t use_count; /* co 1593 atomic_t use_count; /* concurrent submissions counter */
1605 atomic_t reject; /* su 1594 atomic_t reject; /* submissions will fail */
1606 1595
1607 /* public: documented fields in the u 1596 /* public: documented fields in the urb that can be used by drivers */
1608 struct list_head urb_list; /* li 1597 struct list_head urb_list; /* list head for use by the urb's
1609 * cu 1598 * current owner */
1610 struct list_head anchor_list; /* th 1599 struct list_head anchor_list; /* the URB may be anchored */
1611 struct usb_anchor *anchor; 1600 struct usb_anchor *anchor;
1612 struct usb_device *dev; /* (i 1601 struct usb_device *dev; /* (in) pointer to associated device */
1613 struct usb_host_endpoint *ep; /* (i 1602 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */
1614 unsigned int pipe; /* (i 1603 unsigned int pipe; /* (in) pipe information */
1615 unsigned int stream_id; /* (i 1604 unsigned int stream_id; /* (in) stream ID */
1616 int status; /* (r 1605 int status; /* (return) non-ISO status */
1617 unsigned int transfer_flags; /* (i 1606 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1618 void *transfer_buffer; /* (i 1607 void *transfer_buffer; /* (in) associated data buffer */
1619 dma_addr_t transfer_dma; /* (i 1608 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1620 struct scatterlist *sg; /* (i 1609 struct scatterlist *sg; /* (in) scatter gather buffer list */
1621 int num_mapped_sgs; /* (i 1610 int num_mapped_sgs; /* (internal) mapped sg entries */
1622 int num_sgs; /* (i 1611 int num_sgs; /* (in) number of entries in the sg list */
1623 u32 transfer_buffer_length; /* (i 1612 u32 transfer_buffer_length; /* (in) data buffer length */
1624 u32 actual_length; /* (r 1613 u32 actual_length; /* (return) actual transfer length */
1625 unsigned char *setup_packet; /* (i 1614 unsigned char *setup_packet; /* (in) setup packet (control only) */
1626 dma_addr_t setup_dma; /* (i 1615 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1627 int start_frame; /* (m 1616 int start_frame; /* (modify) start frame (ISO) */
1628 int number_of_packets; /* (i 1617 int number_of_packets; /* (in) number of ISO packets */
1629 int interval; /* (m 1618 int interval; /* (modify) transfer interval
1630 * (I 1619 * (INT/ISO) */
1631 int error_count; /* (r 1620 int error_count; /* (return) number of ISO errors */
1632 void *context; /* (i 1621 void *context; /* (in) context for completion */
1633 usb_complete_t complete; /* (i 1622 usb_complete_t complete; /* (in) completion routine */
1634 struct usb_iso_packet_descriptor iso_ 1623 struct usb_iso_packet_descriptor iso_frame_desc[];
1635 /* (i 1624 /* (in) ISO ONLY */
1636 }; 1625 };
1637 1626
1638 /* ------------------------------------------ 1627 /* ----------------------------------------------------------------------- */
1639 1628
1640 /** 1629 /**
1641 * usb_fill_control_urb - initializes a contr 1630 * usb_fill_control_urb - initializes a control urb
1642 * @urb: pointer to the urb to initialize. 1631 * @urb: pointer to the urb to initialize.
1643 * @dev: pointer to the struct usb_device for 1632 * @dev: pointer to the struct usb_device for this urb.
1644 * @pipe: the endpoint pipe 1633 * @pipe: the endpoint pipe
1645 * @setup_packet: pointer to the setup_packet 1634 * @setup_packet: pointer to the setup_packet buffer. The buffer must be
1646 * suitable for DMA. 1635 * suitable for DMA.
1647 * @transfer_buffer: pointer to the transfer 1636 * @transfer_buffer: pointer to the transfer buffer. The buffer must be
1648 * suitable for DMA. 1637 * suitable for DMA.
1649 * @buffer_length: length of the transfer buf 1638 * @buffer_length: length of the transfer buffer
1650 * @complete_fn: pointer to the usb_complete_ 1639 * @complete_fn: pointer to the usb_complete_t function
1651 * @context: what to set the urb context to. 1640 * @context: what to set the urb context to.
1652 * 1641 *
1653 * Initializes a control urb with the proper 1642 * Initializes a control urb with the proper information needed to submit
1654 * it to a device. 1643 * it to a device.
1655 * 1644 *
1656 * The transfer buffer and the setup_packet b 1645 * The transfer buffer and the setup_packet buffer will most likely be filled
1657 * or read via DMA. The simplest way to get a 1646 * or read via DMA. The simplest way to get a buffer that can be DMAed to is
1658 * allocating it via kmalloc() or equivalent, 1647 * allocating it via kmalloc() or equivalent, even for very small buffers.
1659 * If the buffers are embedded in a bigger st 1648 * If the buffers are embedded in a bigger structure, there is a risk that
1660 * the buffer itself, the previous fields and 1649 * the buffer itself, the previous fields and/or the next fields are corrupted
1661 * due to cache incoherencies; or slowed down 1650 * due to cache incoherencies; or slowed down if they are evicted from the
1662 * cache. For more information, check &struct 1651 * cache. For more information, check &struct urb.
1663 * 1652 *
1664 */ 1653 */
1665 static inline void usb_fill_control_urb(struc 1654 static inline void usb_fill_control_urb(struct urb *urb,
1666 struc 1655 struct usb_device *dev,
1667 unsig 1656 unsigned int pipe,
1668 unsig 1657 unsigned char *setup_packet,
1669 void 1658 void *transfer_buffer,
1670 int b 1659 int buffer_length,
1671 usb_c 1660 usb_complete_t complete_fn,
1672 void 1661 void *context)
1673 { 1662 {
1674 urb->dev = dev; 1663 urb->dev = dev;
1675 urb->pipe = pipe; 1664 urb->pipe = pipe;
1676 urb->setup_packet = setup_packet; 1665 urb->setup_packet = setup_packet;
1677 urb->transfer_buffer = transfer_buffe 1666 urb->transfer_buffer = transfer_buffer;
1678 urb->transfer_buffer_length = buffer_ 1667 urb->transfer_buffer_length = buffer_length;
1679 urb->complete = complete_fn; 1668 urb->complete = complete_fn;
1680 urb->context = context; 1669 urb->context = context;
1681 } 1670 }
1682 1671
1683 /** 1672 /**
1684 * usb_fill_bulk_urb - macro to help initiali 1673 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1685 * @urb: pointer to the urb to initialize. 1674 * @urb: pointer to the urb to initialize.
1686 * @dev: pointer to the struct usb_device for 1675 * @dev: pointer to the struct usb_device for this urb.
1687 * @pipe: the endpoint pipe 1676 * @pipe: the endpoint pipe
1688 * @transfer_buffer: pointer to the transfer 1677 * @transfer_buffer: pointer to the transfer buffer. The buffer must be
1689 * suitable for DMA. 1678 * suitable for DMA.
1690 * @buffer_length: length of the transfer buf 1679 * @buffer_length: length of the transfer buffer
1691 * @complete_fn: pointer to the usb_complete_ 1680 * @complete_fn: pointer to the usb_complete_t function
1692 * @context: what to set the urb context to. 1681 * @context: what to set the urb context to.
1693 * 1682 *
1694 * Initializes a bulk urb with the proper inf 1683 * Initializes a bulk urb with the proper information needed to submit it
1695 * to a device. 1684 * to a device.
1696 * 1685 *
1697 * Refer to usb_fill_control_urb() for a desc 1686 * Refer to usb_fill_control_urb() for a description of the requirements for
1698 * transfer_buffer. 1687 * transfer_buffer.
1699 */ 1688 */
1700 static inline void usb_fill_bulk_urb(struct u 1689 static inline void usb_fill_bulk_urb(struct urb *urb,
1701 struct u 1690 struct usb_device *dev,
1702 unsigned 1691 unsigned int pipe,
1703 void *tr 1692 void *transfer_buffer,
1704 int buff 1693 int buffer_length,
1705 usb_comp 1694 usb_complete_t complete_fn,
1706 void *co 1695 void *context)
1707 { 1696 {
1708 urb->dev = dev; 1697 urb->dev = dev;
1709 urb->pipe = pipe; 1698 urb->pipe = pipe;
1710 urb->transfer_buffer = transfer_buffe 1699 urb->transfer_buffer = transfer_buffer;
1711 urb->transfer_buffer_length = buffer_ 1700 urb->transfer_buffer_length = buffer_length;
1712 urb->complete = complete_fn; 1701 urb->complete = complete_fn;
1713 urb->context = context; 1702 urb->context = context;
1714 } 1703 }
1715 1704
1716 /** 1705 /**
1717 * usb_fill_int_urb - macro to help initializ 1706 * usb_fill_int_urb - macro to help initialize a interrupt urb
1718 * @urb: pointer to the urb to initialize. 1707 * @urb: pointer to the urb to initialize.
1719 * @dev: pointer to the struct usb_device for 1708 * @dev: pointer to the struct usb_device for this urb.
1720 * @pipe: the endpoint pipe 1709 * @pipe: the endpoint pipe
1721 * @transfer_buffer: pointer to the transfer 1710 * @transfer_buffer: pointer to the transfer buffer. The buffer must be
1722 * suitable for DMA. 1711 * suitable for DMA.
1723 * @buffer_length: length of the transfer buf 1712 * @buffer_length: length of the transfer buffer
1724 * @complete_fn: pointer to the usb_complete_ 1713 * @complete_fn: pointer to the usb_complete_t function
1725 * @context: what to set the urb context to. 1714 * @context: what to set the urb context to.
1726 * @interval: what to set the urb interval to 1715 * @interval: what to set the urb interval to, encoded like
1727 * the endpoint descriptor's bInterval v 1716 * the endpoint descriptor's bInterval value.
1728 * 1717 *
1729 * Initializes a interrupt urb with the prope 1718 * Initializes a interrupt urb with the proper information needed to submit
1730 * it to a device. 1719 * it to a device.
1731 * 1720 *
1732 * Refer to usb_fill_control_urb() for a desc 1721 * Refer to usb_fill_control_urb() for a description of the requirements for
1733 * transfer_buffer. 1722 * transfer_buffer.
1734 * 1723 *
1735 * Note that High Speed and SuperSpeed(+) int 1724 * Note that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic
1736 * encoding of the endpoint interval, and exp 1725 * encoding of the endpoint interval, and express polling intervals in
1737 * microframes (eight per millisecond) rather 1726 * microframes (eight per millisecond) rather than in frames (one per
1738 * millisecond). 1727 * millisecond).
1739 */ 1728 */
1740 static inline void usb_fill_int_urb(struct ur 1729 static inline void usb_fill_int_urb(struct urb *urb,
1741 struct us 1730 struct usb_device *dev,
1742 unsigned 1731 unsigned int pipe,
1743 void *tra 1732 void *transfer_buffer,
1744 int buffe 1733 int buffer_length,
1745 usb_compl 1734 usb_complete_t complete_fn,
1746 void *con 1735 void *context,
1747 int inter 1736 int interval)
1748 { 1737 {
1749 urb->dev = dev; 1738 urb->dev = dev;
1750 urb->pipe = pipe; 1739 urb->pipe = pipe;
1751 urb->transfer_buffer = transfer_buffe 1740 urb->transfer_buffer = transfer_buffer;
1752 urb->transfer_buffer_length = buffer_ 1741 urb->transfer_buffer_length = buffer_length;
1753 urb->complete = complete_fn; 1742 urb->complete = complete_fn;
1754 urb->context = context; 1743 urb->context = context;
1755 1744
1756 if (dev->speed == USB_SPEED_HIGH || d 1745 if (dev->speed == USB_SPEED_HIGH || dev->speed >= USB_SPEED_SUPER) {
1757 /* make sure interval is with 1746 /* make sure interval is within allowed range */
1758 interval = clamp(interval, 1, 1747 interval = clamp(interval, 1, 16);
1759 1748
1760 urb->interval = 1 << (interva 1749 urb->interval = 1 << (interval - 1);
1761 } else { 1750 } else {
1762 urb->interval = interval; 1751 urb->interval = interval;
1763 } 1752 }
1764 1753
1765 urb->start_frame = -1; 1754 urb->start_frame = -1;
1766 } 1755 }
1767 1756
1768 extern void usb_init_urb(struct urb *urb); 1757 extern void usb_init_urb(struct urb *urb);
1769 extern struct urb *usb_alloc_urb(int iso_pack 1758 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1770 extern void usb_free_urb(struct urb *urb); 1759 extern void usb_free_urb(struct urb *urb);
1771 #define usb_put_urb usb_free_urb 1760 #define usb_put_urb usb_free_urb
1772 extern struct urb *usb_get_urb(struct urb *ur 1761 extern struct urb *usb_get_urb(struct urb *urb);
1773 extern int usb_submit_urb(struct urb *urb, gf 1762 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1774 extern int usb_unlink_urb(struct urb *urb); 1763 extern int usb_unlink_urb(struct urb *urb);
1775 extern void usb_kill_urb(struct urb *urb); 1764 extern void usb_kill_urb(struct urb *urb);
1776 extern void usb_poison_urb(struct urb *urb); 1765 extern void usb_poison_urb(struct urb *urb);
1777 extern void usb_unpoison_urb(struct urb *urb) 1766 extern void usb_unpoison_urb(struct urb *urb);
1778 extern void usb_block_urb(struct urb *urb); 1767 extern void usb_block_urb(struct urb *urb);
1779 extern void usb_kill_anchored_urbs(struct usb 1768 extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1780 extern void usb_poison_anchored_urbs(struct u 1769 extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1781 extern void usb_unpoison_anchored_urbs(struct 1770 extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1782 extern void usb_unlink_anchored_urbs(struct u 1771 extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
1783 extern void usb_anchor_suspend_wakeups(struct 1772 extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor);
1784 extern void usb_anchor_resume_wakeups(struct 1773 extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor);
1785 extern void usb_anchor_urb(struct urb *urb, s 1774 extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1786 extern void usb_unanchor_urb(struct urb *urb) 1775 extern void usb_unanchor_urb(struct urb *urb);
1787 extern int usb_wait_anchor_empty_timeout(stru 1776 extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1788 unsi 1777 unsigned int timeout);
1789 extern struct urb *usb_get_from_anchor(struct 1778 extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
1790 extern void usb_scuttle_anchored_urbs(struct 1779 extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
1791 extern int usb_anchor_empty(struct usb_anchor 1780 extern int usb_anchor_empty(struct usb_anchor *anchor);
1792 1781
1793 #define usb_unblock_urb usb_unpoison_urb 1782 #define usb_unblock_urb usb_unpoison_urb
1794 1783
1795 /** 1784 /**
1796 * usb_urb_dir_in - check if an URB describes 1785 * usb_urb_dir_in - check if an URB describes an IN transfer
1797 * @urb: URB to be checked 1786 * @urb: URB to be checked
1798 * 1787 *
1799 * Return: 1 if @urb describes an IN transfer 1788 * Return: 1 if @urb describes an IN transfer (device-to-host),
1800 * otherwise 0. 1789 * otherwise 0.
1801 */ 1790 */
1802 static inline int usb_urb_dir_in(struct urb * 1791 static inline int usb_urb_dir_in(struct urb *urb)
1803 { 1792 {
1804 return (urb->transfer_flags & URB_DIR 1793 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1805 } 1794 }
1806 1795
1807 /** 1796 /**
1808 * usb_urb_dir_out - check if an URB describe 1797 * usb_urb_dir_out - check if an URB describes an OUT transfer
1809 * @urb: URB to be checked 1798 * @urb: URB to be checked
1810 * 1799 *
1811 * Return: 1 if @urb describes an OUT transfe 1800 * Return: 1 if @urb describes an OUT transfer (host-to-device),
1812 * otherwise 0. 1801 * otherwise 0.
1813 */ 1802 */
1814 static inline int usb_urb_dir_out(struct urb 1803 static inline int usb_urb_dir_out(struct urb *urb)
1815 { 1804 {
1816 return (urb->transfer_flags & URB_DIR 1805 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
1817 } 1806 }
1818 1807
1819 int usb_pipe_type_check(struct usb_device *de 1808 int usb_pipe_type_check(struct usb_device *dev, unsigned int pipe);
1820 int usb_urb_ep_type_check(const struct urb *u 1809 int usb_urb_ep_type_check(const struct urb *urb);
1821 1810
1822 void *usb_alloc_coherent(struct usb_device *d 1811 void *usb_alloc_coherent(struct usb_device *dev, size_t size,
1823 gfp_t mem_flags, dma_addr_t *dma); 1812 gfp_t mem_flags, dma_addr_t *dma);
1824 void usb_free_coherent(struct usb_device *dev 1813 void usb_free_coherent(struct usb_device *dev, size_t size,
1825 void *addr, dma_addr_t dma); 1814 void *addr, dma_addr_t dma);
1826 1815
1827 /*------------------------------------------- 1816 /*-------------------------------------------------------------------*
1828 * SYNCHRONOUS CALL S 1817 * SYNCHRONOUS CALL SUPPORT *
1829 *------------------------------------------- 1818 *-------------------------------------------------------------------*/
1830 1819
1831 extern int usb_control_msg(struct usb_device 1820 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1832 __u8 request, __u8 requesttype, __u16 1821 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1833 void *data, __u16 size, int timeout); 1822 void *data, __u16 size, int timeout);
1834 extern int usb_interrupt_msg(struct usb_devic 1823 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1835 void *data, int len, int *actual_leng 1824 void *data, int len, int *actual_length, int timeout);
1836 extern int usb_bulk_msg(struct usb_device *us 1825 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1837 void *data, int len, int *actual_leng 1826 void *data, int len, int *actual_length,
1838 int timeout); 1827 int timeout);
1839 1828
1840 /* wrappers around usb_control_msg() for the 1829 /* wrappers around usb_control_msg() for the most common standard requests */
1841 int usb_control_msg_send(struct usb_device *d 1830 int usb_control_msg_send(struct usb_device *dev, __u8 endpoint, __u8 request,
1842 __u8 requesttype, __ 1831 __u8 requesttype, __u16 value, __u16 index,
1843 const void *data, __ 1832 const void *data, __u16 size, int timeout,
1844 gfp_t memflags); 1833 gfp_t memflags);
1845 int usb_control_msg_recv(struct usb_device *d 1834 int usb_control_msg_recv(struct usb_device *dev, __u8 endpoint, __u8 request,
1846 __u8 requesttype, __ 1835 __u8 requesttype, __u16 value, __u16 index,
1847 void *data, __u16 si 1836 void *data, __u16 size, int timeout,
1848 gfp_t memflags); 1837 gfp_t memflags);
1849 extern int usb_get_descriptor(struct usb_devi 1838 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1850 unsigned char descindex, void *buf, i 1839 unsigned char descindex, void *buf, int size);
1851 extern int usb_get_status(struct usb_device * 1840 extern int usb_get_status(struct usb_device *dev,
1852 int recip, int type, int target, void 1841 int recip, int type, int target, void *data);
1853 1842
1854 static inline int usb_get_std_status(struct u 1843 static inline int usb_get_std_status(struct usb_device *dev,
1855 int recip, int target, void *data) 1844 int recip, int target, void *data)
1856 { 1845 {
1857 return usb_get_status(dev, recip, USB 1846 return usb_get_status(dev, recip, USB_STATUS_TYPE_STANDARD, target,
1858 data); 1847 data);
1859 } 1848 }
1860 1849
1861 static inline int usb_get_ptm_status(struct u 1850 static inline int usb_get_ptm_status(struct usb_device *dev, void *data)
1862 { 1851 {
1863 return usb_get_status(dev, USB_RECIP_ 1852 return usb_get_status(dev, USB_RECIP_DEVICE, USB_STATUS_TYPE_PTM,
1864 0, data); 1853 0, data);
1865 } 1854 }
1866 1855
1867 extern int usb_string(struct usb_device *dev, 1856 extern int usb_string(struct usb_device *dev, int index,
1868 char *buf, size_t size); 1857 char *buf, size_t size);
1869 extern char *usb_cache_string(struct usb_devi 1858 extern char *usb_cache_string(struct usb_device *udev, int index);
1870 1859
1871 /* wrappers that also update important state 1860 /* wrappers that also update important state inside usbcore */
1872 extern int usb_clear_halt(struct usb_device * 1861 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1873 extern int usb_reset_configuration(struct usb 1862 extern int usb_reset_configuration(struct usb_device *dev);
1874 extern int usb_set_interface(struct usb_devic 1863 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1875 extern void usb_reset_endpoint(struct usb_dev 1864 extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
1876 1865
1877 /* this request isn't really synchronous, but 1866 /* this request isn't really synchronous, but it belongs with the others */
1878 extern int usb_driver_set_configuration(struc 1867 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1879 1868
1880 /* choose and set configuration for device */ 1869 /* choose and set configuration for device */
1881 extern int usb_choose_configuration(struct us 1870 extern int usb_choose_configuration(struct usb_device *udev);
1882 extern int usb_set_configuration(struct usb_d 1871 extern int usb_set_configuration(struct usb_device *dev, int configuration);
1883 1872
1884 /* 1873 /*
1885 * timeouts, in milliseconds, used for sendin 1874 * timeouts, in milliseconds, used for sending/receiving control messages
1886 * they typically complete within a few frame 1875 * they typically complete within a few frames (msec) after they're issued
1887 * USB identifies 5 second timeouts, maybe mo 1876 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1888 * slow devices (like some MGE Ellipse UPSes) 1877 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1889 */ 1878 */
1890 #define USB_CTRL_GET_TIMEOUT 5000 1879 #define USB_CTRL_GET_TIMEOUT 5000
1891 #define USB_CTRL_SET_TIMEOUT 5000 1880 #define USB_CTRL_SET_TIMEOUT 5000
1892 1881
1893 1882
1894 /** 1883 /**
1895 * struct usb_sg_request - support for scatte 1884 * struct usb_sg_request - support for scatter/gather I/O
1896 * @status: zero indicates success, else nega 1885 * @status: zero indicates success, else negative errno
1897 * @bytes: counts bytes transferred. 1886 * @bytes: counts bytes transferred.
1898 * 1887 *
1899 * These requests are initialized using usb_s 1888 * These requests are initialized using usb_sg_init(), and then are used
1900 * as request handles passed to usb_sg_wait() 1889 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1901 * members of the request object aren't for d 1890 * members of the request object aren't for driver access.
1902 * 1891 *
1903 * The status and bytecount values are valid 1892 * The status and bytecount values are valid only after usb_sg_wait()
1904 * returns. If the status is zero, then the 1893 * returns. If the status is zero, then the bytecount matches the total
1905 * from the request. 1894 * from the request.
1906 * 1895 *
1907 * After an error completion, drivers may nee 1896 * After an error completion, drivers may need to clear a halt condition
1908 * on the endpoint. 1897 * on the endpoint.
1909 */ 1898 */
1910 struct usb_sg_request { 1899 struct usb_sg_request {
1911 int status; 1900 int status;
1912 size_t bytes; 1901 size_t bytes;
1913 1902
1914 /* private: 1903 /* private:
1915 * members below are private to usbco 1904 * members below are private to usbcore,
1916 * and are not provided for driver ac 1905 * and are not provided for driver access!
1917 */ 1906 */
1918 spinlock_t lock; 1907 spinlock_t lock;
1919 1908
1920 struct usb_device *dev; 1909 struct usb_device *dev;
1921 int pipe; 1910 int pipe;
1922 1911
1923 int entries; 1912 int entries;
1924 struct urb **urbs; 1913 struct urb **urbs;
1925 1914
1926 int count; 1915 int count;
1927 struct completion complete; 1916 struct completion complete;
1928 }; 1917 };
1929 1918
1930 int usb_sg_init( 1919 int usb_sg_init(
1931 struct usb_sg_request *io, 1920 struct usb_sg_request *io,
1932 struct usb_device *dev, 1921 struct usb_device *dev,
1933 unsigned pipe, 1922 unsigned pipe,
1934 unsigned period, 1923 unsigned period,
1935 struct scatterlist *sg, 1924 struct scatterlist *sg,
1936 int nents, 1925 int nents,
1937 size_t length, 1926 size_t length,
1938 gfp_t mem_flags 1927 gfp_t mem_flags
1939 ); 1928 );
1940 void usb_sg_cancel(struct usb_sg_request *io) 1929 void usb_sg_cancel(struct usb_sg_request *io);
1941 void usb_sg_wait(struct usb_sg_request *io); 1930 void usb_sg_wait(struct usb_sg_request *io);
1942 1931
1943 1932
1944 /* ------------------------------------------ 1933 /* ----------------------------------------------------------------------- */
1945 1934
1946 /* 1935 /*
1947 * For various legacy reasons, Linux has a sm 1936 * For various legacy reasons, Linux has a small cookie that's paired with
1948 * a struct usb_device to identify an endpoin 1937 * a struct usb_device to identify an endpoint queue. Queue characteristics
1949 * are defined by the endpoint's descriptor. 1938 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1950 * an unsigned int encoded as: 1939 * an unsigned int encoded as:
1951 * 1940 *
1952 * - direction: bit 7 (0 = 1941 * - direction: bit 7 (0 = Host-to-Device [Out],
1953 * 1 = 1942 * 1 = Device-to-Host [In] ...
1954 * like 1943 * like endpoint bEndpointAddress)
1955 * - device address: bits 8-14 ... b 1944 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1956 * - endpoint: bits 15-18 ... b 1945 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1957 * - pipe type: bits 30-31 (00 = 1946 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1958 * 10 = 1947 * 10 = control, 11 = bulk)
1959 * 1948 *
1960 * Given the device address and endpoint desc 1949 * Given the device address and endpoint descriptor, pipes are redundant.
1961 */ 1950 */
1962 1951
1963 /* NOTE: these are not the standard USB_ENDP 1952 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1964 /* (yet ... they're the values used by usbfs) 1953 /* (yet ... they're the values used by usbfs) */
1965 #define PIPE_ISOCHRONOUS 0 1954 #define PIPE_ISOCHRONOUS 0
1966 #define PIPE_INTERRUPT 1 1955 #define PIPE_INTERRUPT 1
1967 #define PIPE_CONTROL 2 1956 #define PIPE_CONTROL 2
1968 #define PIPE_BULK 3 1957 #define PIPE_BULK 3
1969 1958
1970 #define usb_pipein(pipe) ((pipe) & USB 1959 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1971 #define usb_pipeout(pipe) (!usb_pipein( 1960 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1972 1961
1973 #define usb_pipedevice(pipe) (((pipe) >> 8 1962 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1974 #define usb_pipeendpoint(pipe) (((pipe) >> 1 1963 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1975 1964
1976 #define usb_pipetype(pipe) (((pipe) >> 3 1965 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1977 #define usb_pipeisoc(pipe) (usb_pipetype 1966 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1978 #define usb_pipeint(pipe) (usb_pipetype 1967 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1979 #define usb_pipecontrol(pipe) (usb_pipetype 1968 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1980 #define usb_pipebulk(pipe) (usb_pipetype 1969 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1981 1970
1982 static inline unsigned int __create_pipe(stru 1971 static inline unsigned int __create_pipe(struct usb_device *dev,
1983 unsigned int endpoint) 1972 unsigned int endpoint)
1984 { 1973 {
1985 return (dev->devnum << 8) | (endpoint 1974 return (dev->devnum << 8) | (endpoint << 15);
1986 } 1975 }
1987 1976
1988 /* Create various pipes... */ 1977 /* Create various pipes... */
1989 #define usb_sndctrlpipe(dev, endpoint) \ 1978 #define usb_sndctrlpipe(dev, endpoint) \
1990 ((PIPE_CONTROL << 30) | __create_pipe 1979 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1991 #define usb_rcvctrlpipe(dev, endpoint) \ 1980 #define usb_rcvctrlpipe(dev, endpoint) \
1992 ((PIPE_CONTROL << 30) | __create_pipe 1981 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1993 #define usb_sndisocpipe(dev, endpoint) \ 1982 #define usb_sndisocpipe(dev, endpoint) \
1994 ((PIPE_ISOCHRONOUS << 30) | __create_ 1983 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1995 #define usb_rcvisocpipe(dev, endpoint) \ 1984 #define usb_rcvisocpipe(dev, endpoint) \
1996 ((PIPE_ISOCHRONOUS << 30) | __create_ 1985 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1997 #define usb_sndbulkpipe(dev, endpoint) \ 1986 #define usb_sndbulkpipe(dev, endpoint) \
1998 ((PIPE_BULK << 30) | __create_pipe(de 1987 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1999 #define usb_rcvbulkpipe(dev, endpoint) \ 1988 #define usb_rcvbulkpipe(dev, endpoint) \
2000 ((PIPE_BULK << 30) | __create_pipe(de 1989 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
2001 #define usb_sndintpipe(dev, endpoint) \ 1990 #define usb_sndintpipe(dev, endpoint) \
2002 ((PIPE_INTERRUPT << 30) | __create_pi 1991 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
2003 #define usb_rcvintpipe(dev, endpoint) \ 1992 #define usb_rcvintpipe(dev, endpoint) \
2004 ((PIPE_INTERRUPT << 30) | __create_pi 1993 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
2005 1994
2006 static inline struct usb_host_endpoint * 1995 static inline struct usb_host_endpoint *
2007 usb_pipe_endpoint(struct usb_device *dev, uns 1996 usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
2008 { 1997 {
2009 struct usb_host_endpoint **eps; 1998 struct usb_host_endpoint **eps;
2010 eps = usb_pipein(pipe) ? dev->ep_in : 1999 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
2011 return eps[usb_pipeendpoint(pipe)]; 2000 return eps[usb_pipeendpoint(pipe)];
2012 } 2001 }
2013 2002
2014 static inline u16 usb_maxpacket(struct usb_de 2003 static inline u16 usb_maxpacket(struct usb_device *udev, int pipe)
2015 { 2004 {
2016 struct usb_host_endpoint *ep = usb_pi 2005 struct usb_host_endpoint *ep = usb_pipe_endpoint(udev, pipe);
2017 2006
2018 if (!ep) 2007 if (!ep)
2019 return 0; 2008 return 0;
2020 2009
2021 /* NOTE: only 0x07ff bits are for pa 2010 /* NOTE: only 0x07ff bits are for packet size... */
2022 return usb_endpoint_maxp(&ep->desc); 2011 return usb_endpoint_maxp(&ep->desc);
2023 } 2012 }
2024 2013
2025 /* translate USB error codes to codes user sp 2014 /* translate USB error codes to codes user space understands */
2026 static inline int usb_translate_errors(int er 2015 static inline int usb_translate_errors(int error_code)
2027 { 2016 {
2028 switch (error_code) { 2017 switch (error_code) {
2029 case 0: 2018 case 0:
2030 case -ENOMEM: 2019 case -ENOMEM:
2031 case -ENODEV: 2020 case -ENODEV:
2032 case -EOPNOTSUPP: 2021 case -EOPNOTSUPP:
2033 return error_code; 2022 return error_code;
2034 default: 2023 default:
2035 return -EIO; 2024 return -EIO;
2036 } 2025 }
2037 } 2026 }
2038 2027
2039 /* Events from the usb core */ 2028 /* Events from the usb core */
2040 #define USB_DEVICE_ADD 0x0001 2029 #define USB_DEVICE_ADD 0x0001
2041 #define USB_DEVICE_REMOVE 0x0002 2030 #define USB_DEVICE_REMOVE 0x0002
2042 #define USB_BUS_ADD 0x0003 2031 #define USB_BUS_ADD 0x0003
2043 #define USB_BUS_REMOVE 0x0004 2032 #define USB_BUS_REMOVE 0x0004
2044 extern void usb_register_notify(struct notifi 2033 extern void usb_register_notify(struct notifier_block *nb);
2045 extern void usb_unregister_notify(struct noti 2034 extern void usb_unregister_notify(struct notifier_block *nb);
2046 2035
2047 /* debugfs stuff */ 2036 /* debugfs stuff */
2048 extern struct dentry *usb_debug_root; 2037 extern struct dentry *usb_debug_root;
2049 2038
2050 /* LED triggers */ 2039 /* LED triggers */
2051 enum usb_led_event { 2040 enum usb_led_event {
2052 USB_LED_EVENT_HOST = 0, 2041 USB_LED_EVENT_HOST = 0,
2053 USB_LED_EVENT_GADGET = 1, 2042 USB_LED_EVENT_GADGET = 1,
2054 }; 2043 };
2055 2044
2056 #ifdef CONFIG_USB_LED_TRIG 2045 #ifdef CONFIG_USB_LED_TRIG
2057 extern void usb_led_activity(enum usb_led_eve 2046 extern void usb_led_activity(enum usb_led_event ev);
2058 #else 2047 #else
2059 static inline void usb_led_activity(enum usb_ 2048 static inline void usb_led_activity(enum usb_led_event ev) {}
2060 #endif 2049 #endif
2061 2050
2062 #endif /* __KERNEL__ */ 2051 #endif /* __KERNEL__ */
2063 2052
2064 #endif 2053 #endif
2065 2054
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.