blob: b81407518fdf736fceb1e4e3cf80d59bd1889dc5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * (C) Copyright Linus Torvalds 1999
3 * (C) Copyright Johannes Erdfelt 1999-2001
4 * (C) Copyright Andreas Gal 1999
5 * (C) Copyright Gregory P. Smith 1999
6 * (C) Copyright Deti Fliegl 1999
7 * (C) Copyright Randy Dunlap 2000
8 * (C) Copyright David Brownell 2000-2002
Matthias Beyer14557352013-10-05 18:02:07 +02009 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 */
24
Sebastian Andrzej Siewiorb53d6572012-09-07 14:31:45 +020025#include <linux/bcd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/module.h>
27#include <linux/version.h>
28#include <linux/kernel.h>
29#include <linux/slab.h>
30#include <linux/completion.h>
31#include <linux/utsname.h>
32#include <linux/mm.h>
33#include <asm/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/device.h>
35#include <linux/dma-mapping.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010036#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <asm/irq.h>
38#include <asm/byteorder.h>
Magnus Dammb3476672008-01-23 15:58:35 +090039#include <asm/unaligned.h>
Aleksey Gorelov64a21d02006-08-08 17:24:08 -070040#include <linux/platform_device.h>
Alan Stern6b157c92007-03-13 16:37:30 -040041#include <linux/workqueue.h>
Alan Sternda0aa712013-01-25 17:09:42 -050042#include <linux/pm_runtime.h>
Matthias Beyer059239a2013-10-05 23:09:15 +020043#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45#include <linux/usb.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020046#include <linux/usb/hcd.h>
Valentine Barshak103e1272013-12-04 01:42:21 +040047#include <linux/usb/phy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49#include "usb.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*-------------------------------------------------------------------------*/
53
54/*
55 * USB Host Controller Driver framework
56 *
57 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
58 * HCD-specific behaviors/bugs.
59 *
60 * This does error checks, tracks devices and urbs, and delegates to a
61 * "hc_driver" only for code (and data) that really needs to know about
62 * hardware differences. That includes root hub registers, i/o queues,
63 * and so on ... but as little else as possible.
64 *
65 * Shared code includes most of the "root hub" code (these are emulated,
66 * though each HC's hardware works differently) and PCI glue, plus request
67 * tracking overhead. The HCD code should only block on spinlocks or on
68 * hardware handshaking; blocking on software events (such as other kernel
69 * threads releasing resources, or completing actions) is all generic.
70 *
71 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
72 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
73 * only by the hub driver ... and that neither should be seen or used by
74 * usb client device drivers.
75 *
76 * Contributors of ideas or unattributed patches include: David Brownell,
77 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
78 *
79 * HISTORY:
80 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
81 * associated cleanup. "usb_hcd" still != "usb_bus".
82 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
83 */
84
85/*-------------------------------------------------------------------------*/
86
Alan Stern9beeee62008-10-02 11:48:13 -040087/* Keep track of which host controller drivers are loaded */
88unsigned long usb_hcds_loaded;
89EXPORT_SYMBOL_GPL(usb_hcds_loaded);
90
Linus Torvalds1da177e2005-04-16 15:20:36 -070091/* host controllers we manage */
92LIST_HEAD (usb_bus_list);
93EXPORT_SYMBOL_GPL (usb_bus_list);
94
95/* used when allocating bus numbers */
96#define USB_MAXBUS 64
Matthias Beyer059239a2013-10-05 23:09:15 +020097static DECLARE_BITMAP(busmap, USB_MAXBUS);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/* used when updating list of hcds */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100100DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101EXPORT_SYMBOL_GPL (usb_bus_list_lock);
102
103/* used for controlling access to virtual root hubs */
104static DEFINE_SPINLOCK(hcd_root_hub_lock);
105
Alan Stern809a58b2007-07-18 12:14:24 -0400106/* used when updating an endpoint's URB list */
107static DEFINE_SPINLOCK(hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Alan Sterncde217a2008-10-21 15:28:46 -0400109/* used to protect against unlinking URBs after the device is gone */
110static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/* wait queue for synchronous unlinks */
113DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
114
Alan Stern809a58b2007-07-18 12:14:24 -0400115static inline int is_root_hub(struct usb_device *udev)
116{
117 return (udev->parent == NULL);
118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*-------------------------------------------------------------------------*/
121
122/*
123 * Sharable chunks of root hub code.
124 */
125
126/*-------------------------------------------------------------------------*/
Sebastian Andrzej Siewiorb53d6572012-09-07 14:31:45 +0200127#define KERNEL_REL bin2bcd(((LINUX_VERSION_CODE >> 16) & 0x0ff))
128#define KERNEL_VER bin2bcd(((LINUX_VERSION_CODE >> 8) & 0x0ff))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700130/* usb 3.0 root hub device descriptor */
131static const u8 usb3_rh_dev_descriptor[18] = {
132 0x12, /* __u8 bLength; */
133 0x01, /* __u8 bDescriptorType; Device */
134 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
135
136 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
137 0x00, /* __u8 bDeviceSubClass; */
138 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
139 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
140
Paul Bollebfb8bfa2012-05-05 13:16:51 +0200141 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
Alan Sterncd780692010-02-25 13:19:37 -0500142 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700143 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
144
145 0x03, /* __u8 iManufacturer; */
146 0x02, /* __u8 iProduct; */
147 0x01, /* __u8 iSerialNumber; */
148 0x01 /* __u8 bNumConfigurations; */
149};
150
Thomas Pugliese1a81f882013-05-31 14:16:13 -0500151/* usb 2.5 (wireless USB 1.0) root hub device descriptor */
152static const u8 usb25_rh_dev_descriptor[18] = {
153 0x12, /* __u8 bLength; */
154 0x01, /* __u8 bDescriptorType; Device */
155 0x50, 0x02, /* __le16 bcdUSB; v2.5 */
156
157 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
158 0x00, /* __u8 bDeviceSubClass; */
159 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
160 0xFF, /* __u8 bMaxPacketSize0; always 0xFF (WUSB Spec 7.4.1). */
161
162 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
163 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
164 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
165
166 0x03, /* __u8 iManufacturer; */
167 0x02, /* __u8 iProduct; */
168 0x01, /* __u8 iSerialNumber; */
169 0x01 /* __u8 bNumConfigurations; */
170};
171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172/* usb 2.0 root hub device descriptor */
Matthias Beyer14557352013-10-05 18:02:07 +0200173static const u8 usb2_rh_dev_descriptor[18] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 0x12, /* __u8 bLength; */
175 0x01, /* __u8 bDescriptorType; Device */
176 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
177
178 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
179 0x00, /* __u8 bDeviceSubClass; */
Alan Stern7329e212008-04-03 18:02:56 -0400180 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
Alan Stern16f16d12005-10-24 15:41:19 -0400181 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Paul Bollebfb8bfa2012-05-05 13:16:51 +0200183 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
Greg Kroah-Hartman667d6912008-01-28 09:50:12 -0800184 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
186
187 0x03, /* __u8 iManufacturer; */
188 0x02, /* __u8 iProduct; */
189 0x01, /* __u8 iSerialNumber; */
190 0x01 /* __u8 bNumConfigurations; */
191};
192
193/* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
194
195/* usb 1.1 root hub device descriptor */
Matthias Beyer14557352013-10-05 18:02:07 +0200196static const u8 usb11_rh_dev_descriptor[18] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 0x12, /* __u8 bLength; */
198 0x01, /* __u8 bDescriptorType; Device */
199 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
200
201 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
202 0x00, /* __u8 bDeviceSubClass; */
203 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
Alan Stern16f16d12005-10-24 15:41:19 -0400204 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Paul Bollebfb8bfa2012-05-05 13:16:51 +0200206 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation 0x1d6b */
Greg Kroah-Hartman667d6912008-01-28 09:50:12 -0800207 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
209
210 0x03, /* __u8 iManufacturer; */
211 0x02, /* __u8 iProduct; */
212 0x01, /* __u8 iSerialNumber; */
213 0x01 /* __u8 bNumConfigurations; */
214};
215
216
217/*-------------------------------------------------------------------------*/
218
219/* Configuration descriptors for our root hubs */
220
Matthias Beyer14557352013-10-05 18:02:07 +0200221static const u8 fs_rh_config_descriptor[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 /* one configuration */
224 0x09, /* __u8 bLength; */
225 0x02, /* __u8 bDescriptorType; Configuration */
226 0x19, 0x00, /* __le16 wTotalLength; */
227 0x01, /* __u8 bNumInterfaces; (1) */
228 0x01, /* __u8 bConfigurationValue; */
229 0x00, /* __u8 iConfiguration; */
Matthias Beyer14557352013-10-05 18:02:07 +0200230 0xc0, /* __u8 bmAttributes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 Bit 7: must be set,
232 6: Self-powered,
233 5: Remote wakeup,
234 4..0: resvd */
235 0x00, /* __u8 MaxPower; */
Matthias Beyer14557352013-10-05 18:02:07 +0200236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 /* USB 1.1:
238 * USB 2.0, single TT organization (mandatory):
239 * one interface, protocol 0
240 *
241 * USB 2.0, multiple TT organization (optional):
242 * two interfaces, protocols 1 (like single TT)
243 * and 2 (multiple TT mode) ... config is
244 * sometimes settable
245 * NOT IMPLEMENTED
246 */
247
248 /* one interface */
249 0x09, /* __u8 if_bLength; */
250 0x04, /* __u8 if_bDescriptorType; Interface */
251 0x00, /* __u8 if_bInterfaceNumber; */
252 0x00, /* __u8 if_bAlternateSetting; */
253 0x01, /* __u8 if_bNumEndpoints; */
254 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
255 0x00, /* __u8 if_bInterfaceSubClass; */
256 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
257 0x00, /* __u8 if_iInterface; */
Matthias Beyer14557352013-10-05 18:02:07 +0200258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 /* one endpoint (status change endpoint) */
260 0x07, /* __u8 ep_bLength; */
261 0x05, /* __u8 ep_bDescriptorType; Endpoint */
262 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
Matthias Beyer14557352013-10-05 18:02:07 +0200263 0x03, /* __u8 ep_bmAttributes; Interrupt */
264 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
266};
267
Matthias Beyer14557352013-10-05 18:02:07 +0200268static const u8 hs_rh_config_descriptor[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270 /* one configuration */
271 0x09, /* __u8 bLength; */
272 0x02, /* __u8 bDescriptorType; Configuration */
273 0x19, 0x00, /* __le16 wTotalLength; */
274 0x01, /* __u8 bNumInterfaces; (1) */
275 0x01, /* __u8 bConfigurationValue; */
276 0x00, /* __u8 iConfiguration; */
Matthias Beyer14557352013-10-05 18:02:07 +0200277 0xc0, /* __u8 bmAttributes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 Bit 7: must be set,
279 6: Self-powered,
280 5: Remote wakeup,
281 4..0: resvd */
282 0x00, /* __u8 MaxPower; */
Matthias Beyer14557352013-10-05 18:02:07 +0200283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 /* USB 1.1:
285 * USB 2.0, single TT organization (mandatory):
286 * one interface, protocol 0
287 *
288 * USB 2.0, multiple TT organization (optional):
289 * two interfaces, protocols 1 (like single TT)
290 * and 2 (multiple TT mode) ... config is
291 * sometimes settable
292 * NOT IMPLEMENTED
293 */
294
295 /* one interface */
296 0x09, /* __u8 if_bLength; */
297 0x04, /* __u8 if_bDescriptorType; Interface */
298 0x00, /* __u8 if_bInterfaceNumber; */
299 0x00, /* __u8 if_bAlternateSetting; */
300 0x01, /* __u8 if_bNumEndpoints; */
301 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
302 0x00, /* __u8 if_bInterfaceSubClass; */
303 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
304 0x00, /* __u8 if_iInterface; */
Matthias Beyer14557352013-10-05 18:02:07 +0200305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 /* one endpoint (status change endpoint) */
307 0x07, /* __u8 ep_bLength; */
308 0x05, /* __u8 ep_bDescriptorType; Endpoint */
309 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
Matthias Beyer14557352013-10-05 18:02:07 +0200310 0x03, /* __u8 ep_bmAttributes; Interrupt */
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700311 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
312 * see hub.c:hub_configure() for details. */
313 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
315};
316
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700317static const u8 ss_rh_config_descriptor[] = {
318 /* one configuration */
319 0x09, /* __u8 bLength; */
320 0x02, /* __u8 bDescriptorType; Configuration */
Sarah Sharp22c6a352010-09-13 12:01:02 -0700321 0x1f, 0x00, /* __le16 wTotalLength; */
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700322 0x01, /* __u8 bNumInterfaces; (1) */
323 0x01, /* __u8 bConfigurationValue; */
324 0x00, /* __u8 iConfiguration; */
325 0xc0, /* __u8 bmAttributes;
326 Bit 7: must be set,
327 6: Self-powered,
328 5: Remote wakeup,
329 4..0: resvd */
330 0x00, /* __u8 MaxPower; */
331
332 /* one interface */
333 0x09, /* __u8 if_bLength; */
334 0x04, /* __u8 if_bDescriptorType; Interface */
335 0x00, /* __u8 if_bInterfaceNumber; */
336 0x00, /* __u8 if_bAlternateSetting; */
337 0x01, /* __u8 if_bNumEndpoints; */
338 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
339 0x00, /* __u8 if_bInterfaceSubClass; */
340 0x00, /* __u8 if_bInterfaceProtocol; */
341 0x00, /* __u8 if_iInterface; */
342
343 /* one endpoint (status change endpoint) */
344 0x07, /* __u8 ep_bLength; */
345 0x05, /* __u8 ep_bDescriptorType; Endpoint */
346 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
347 0x03, /* __u8 ep_bmAttributes; Interrupt */
348 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
349 * see hub.c:hub_configure() for details. */
350 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
Sarah Sharp22c6a352010-09-13 12:01:02 -0700351 0x0c, /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
352
353 /* one SuperSpeed endpoint companion descriptor */
354 0x06, /* __u8 ss_bLength */
355 0x30, /* __u8 ss_bDescriptorType; SuperSpeed EP Companion */
356 0x00, /* __u8 ss_bMaxBurst; allows 1 TX between ACKs */
357 0x00, /* __u8 ss_bmAttributes; 1 packet per service interval */
358 0x02, 0x00 /* __le16 ss_wBytesPerInterval; 15 bits for max 15 ports */
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700359};
360
Carl-Daniel Hailfingerc4fc2342011-05-31 21:31:08 +0200361/* authorized_default behaviour:
362 * -1 is authorized for all devices except wireless (old behaviour)
363 * 0 is unauthorized for all devices
364 * 1 is authorized for all devices
365 */
366static int authorized_default = -1;
367module_param(authorized_default, int, S_IRUGO|S_IWUSR);
368MODULE_PARM_DESC(authorized_default,
369 "Default USB device authorization: 0 is not authorized, 1 is "
370 "authorized, -1 is authorized except for wireless USB (default, "
371 "old behaviour");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372/*-------------------------------------------------------------------------*/
373
George Spelvin392ca682009-08-24 22:06:41 -0400374/**
375 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
376 * @s: Null-terminated ASCII (actually ISO-8859-1) string
377 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
378 * @len: Length (in bytes; may be odd) of descriptor buffer.
379 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200380 * Return: The number of bytes filled in: 2 + 2*strlen(s) or @len,
381 * whichever is less.
George Spelvin392ca682009-08-24 22:06:41 -0400382 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200383 * Note:
George Spelvin392ca682009-08-24 22:06:41 -0400384 * USB String descriptors can contain at most 126 characters; input
385 * strings longer than that are truncated.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
George Spelvin392ca682009-08-24 22:06:41 -0400387static unsigned
388ascii2desc(char const *s, u8 *buf, unsigned len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389{
George Spelvin392ca682009-08-24 22:06:41 -0400390 unsigned n, t = 2 + 2*strlen(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
George Spelvin392ca682009-08-24 22:06:41 -0400392 if (t > 254)
393 t = 254; /* Longest possible UTF string descriptor */
394 if (len > t)
395 len = t;
396
397 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
398
399 n = len;
400 while (n--) {
401 *buf++ = t;
402 if (!n--)
403 break;
404 *buf++ = t >> 8;
405 t = (unsigned char)*s++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 }
George Spelvin392ca682009-08-24 22:06:41 -0400407 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408}
409
George Spelvin392ca682009-08-24 22:06:41 -0400410/**
411 * rh_string() - provides string descriptors for root hub
412 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 * @hcd: the host controller for this root hub
George Spelvin392ca682009-08-24 22:06:41 -0400414 * @data: buffer for output packet
415 * @len: length of the provided buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 *
417 * Produces either a manufacturer, product or serial number string for the
418 * virtual root hub device.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200419 *
420 * Return: The number of bytes filled in: the length of the descriptor or
George Spelvin392ca682009-08-24 22:06:41 -0400421 * of the provided buffer, whichever is less.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 */
George Spelvin392ca682009-08-24 22:06:41 -0400423static unsigned
424rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
Roel Kluin71d27182009-03-13 12:19:18 +0100425{
George Spelvin392ca682009-08-24 22:06:41 -0400426 char buf[100];
427 char const *s;
428 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Matthias Beyer048cb212013-10-05 18:02:08 +0200430 /* language ids */
George Spelvin392ca682009-08-24 22:06:41 -0400431 switch (id) {
432 case 0:
433 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
434 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
435 if (len > 4)
436 len = 4;
437 memcpy(data, langids, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return len;
George Spelvin392ca682009-08-24 22:06:41 -0400439 case 1:
440 /* Serial number */
441 s = hcd->self.bus_name;
442 break;
443 case 2:
444 /* Product name */
445 s = hcd->product_desc;
446 break;
447 case 3:
448 /* Manufacturer */
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700449 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
450 init_utsname()->release, hcd->driver->description);
George Spelvin392ca682009-08-24 22:06:41 -0400451 s = buf;
452 break;
453 default:
454 /* Can't happen; caller guarantees it */
455 return 0;
Roel Kluin71d27182009-03-13 12:19:18 +0100456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
George Spelvin392ca682009-08-24 22:06:41 -0400458 return ascii2desc(s, data, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459}
460
461
462/* Root hub control transfers execute synchronously */
463static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
464{
465 struct usb_ctrlrequest *cmd;
Matthias Beyer14557352013-10-05 18:02:07 +0200466 u16 typeReq, wValue, wIndex, wLength;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 u8 *ubuf = urb->transfer_buffer;
Roel Kluin71d27182009-03-13 12:19:18 +0100468 unsigned len = 0;
Alan Sterne9df41c2007-08-08 11:48:02 -0400469 int status;
Alan Stern7329e212008-04-03 18:02:56 -0400470 u8 patch_wakeup = 0;
471 u8 patch_protocol = 0;
Sean O. Stalleye57e7802013-08-13 10:36:12 -0700472 u16 tbuf_size;
473 u8 *tbuf = NULL;
474 const u8 *bufp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Alan Stern9439eb92007-08-02 15:05:45 -0400476 might_sleep();
477
Alan Sterne9df41c2007-08-08 11:48:02 -0400478 spin_lock_irq(&hcd_root_hub_lock);
479 status = usb_hcd_link_urb_to_ep(hcd, urb);
480 spin_unlock_irq(&hcd_root_hub_lock);
481 if (status)
482 return status;
Alan Sternb0d9efb2007-08-21 15:39:21 -0400483 urb->hcpriv = hcd; /* Indicate it's queued */
Alan Sterne9df41c2007-08-08 11:48:02 -0400484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
486 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
487 wValue = le16_to_cpu (cmd->wValue);
488 wIndex = le16_to_cpu (cmd->wIndex);
489 wLength = le16_to_cpu (cmd->wLength);
490
491 if (wLength > urb->transfer_buffer_length)
492 goto error;
493
Sean O. Stalleye57e7802013-08-13 10:36:12 -0700494 /*
495 * tbuf should be at least as big as the
496 * USB hub descriptor.
497 */
498 tbuf_size = max_t(u16, sizeof(struct usb_hub_descriptor), wLength);
499 tbuf = kzalloc(tbuf_size, GFP_KERNEL);
500 if (!tbuf)
501 return -ENOMEM;
502
503 bufp = tbuf;
504
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 urb->actual_length = 0;
507 switch (typeReq) {
508
509 /* DEVICE REQUESTS */
510
David Brownellfb669cc2006-01-24 08:40:27 -0800511 /* The root hub's remote wakeup enable bit is implemented using
512 * driver model wakeup flags. If this system supports wakeup
513 * through USB, userspace may change the default "allow wakeup"
514 * policy through sysfs or these calls.
515 *
516 * Most root hubs support wakeup from downstream devices, for
517 * runtime power management (disabling USB clocks and reducing
518 * VBUS power usage). However, not all of them do so; silicon,
519 * board, and BIOS bugs here are not uncommon, so these can't
520 * be treated quite like external hubs.
521 *
522 * Likewise, not all root hubs will pass wakeup events upstream,
523 * to wake up the whole system. So don't assume root hub and
524 * controller capabilities are identical.
525 */
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 case DeviceRequest | USB_REQ_GET_STATUS:
Matthias Beyer14557352013-10-05 18:02:07 +0200528 tbuf[0] = (device_may_wakeup(&hcd->self.root_hub->dev)
David Brownellfb669cc2006-01-24 08:40:27 -0800529 << USB_DEVICE_REMOTE_WAKEUP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 | (1 << USB_DEVICE_SELF_POWERED);
Matthias Beyer14557352013-10-05 18:02:07 +0200531 tbuf[1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 len = 2;
533 break;
534 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
535 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
David Brownellfb669cc2006-01-24 08:40:27 -0800536 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 else
538 goto error;
539 break;
540 case DeviceOutRequest | USB_REQ_SET_FEATURE:
David Brownellfb669cc2006-01-24 08:40:27 -0800541 if (device_can_wakeup(&hcd->self.root_hub->dev)
542 && wValue == USB_DEVICE_REMOTE_WAKEUP)
543 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 else
545 goto error;
546 break;
547 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
Matthias Beyer14557352013-10-05 18:02:07 +0200548 tbuf[0] = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 len = 1;
550 /* FALLTHROUGH */
551 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
552 break;
553 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
554 switch (wValue & 0xff00) {
555 case USB_DT_DEVICE << 8:
Sarah Sharp83de4b22010-12-02 14:45:18 -0800556 switch (hcd->speed) {
Viral Mehta7dd19e62009-05-05 15:54:23 +0530557 case HCD_USB3:
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700558 bufp = usb3_rh_dev_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530559 break;
Thomas Pugliese1a81f882013-05-31 14:16:13 -0500560 case HCD_USB25:
561 bufp = usb25_rh_dev_descriptor;
562 break;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530563 case HCD_USB2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 bufp = usb2_rh_dev_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530565 break;
566 case HCD_USB11:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 bufp = usb11_rh_dev_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530568 break;
569 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 goto error;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530571 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 len = 18;
Alan Stern7329e212008-04-03 18:02:56 -0400573 if (hcd->has_tt)
574 patch_protocol = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 break;
576 case USB_DT_CONFIG << 8:
Sarah Sharp83de4b22010-12-02 14:45:18 -0800577 switch (hcd->speed) {
Viral Mehta7dd19e62009-05-05 15:54:23 +0530578 case HCD_USB3:
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700579 bufp = ss_rh_config_descriptor;
580 len = sizeof ss_rh_config_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530581 break;
Thomas Pugliese1a81f882013-05-31 14:16:13 -0500582 case HCD_USB25:
Viral Mehta7dd19e62009-05-05 15:54:23 +0530583 case HCD_USB2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 bufp = hs_rh_config_descriptor;
585 len = sizeof hs_rh_config_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530586 break;
587 case HCD_USB11:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 bufp = fs_rh_config_descriptor;
589 len = sizeof fs_rh_config_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530590 break;
591 default:
592 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 }
David Brownellfb669cc2006-01-24 08:40:27 -0800594 if (device_can_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 patch_wakeup = 1;
596 break;
597 case USB_DT_STRING << 8:
Roel Kluin71d27182009-03-13 12:19:18 +0100598 if ((wValue & 0xff) < 4)
599 urb->actual_length = rh_string(wValue & 0xff,
600 hcd, ubuf, wLength);
601 else /* unsupported IDs --> "protocol stall" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 break;
Sarah Sharp48e82362011-10-06 11:54:23 -0700604 case USB_DT_BOS << 8:
605 goto nongeneric;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 default:
607 goto error;
608 }
609 break;
610 case DeviceRequest | USB_REQ_GET_INTERFACE:
Matthias Beyer14557352013-10-05 18:02:07 +0200611 tbuf[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 len = 1;
613 /* FALLTHROUGH */
614 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
615 break;
616 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
Matthias Beyer048cb212013-10-05 18:02:08 +0200617 /* wValue == urb->dev->devaddr */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 dev_dbg (hcd->self.controller, "root hub device address %d\n",
619 wValue);
620 break;
621
622 /* INTERFACE REQUESTS (no defined feature/status flags) */
623
624 /* ENDPOINT REQUESTS */
625
626 case EndpointRequest | USB_REQ_GET_STATUS:
Matthias Beyer048cb212013-10-05 18:02:08 +0200627 /* ENDPOINT_HALT flag */
Matthias Beyer14557352013-10-05 18:02:07 +0200628 tbuf[0] = 0;
629 tbuf[1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 len = 2;
631 /* FALLTHROUGH */
632 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
633 case EndpointOutRequest | USB_REQ_SET_FEATURE:
634 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
635 break;
636
637 /* CLASS REQUESTS (and errors) */
638
639 default:
Sarah Sharp48e82362011-10-06 11:54:23 -0700640nongeneric:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 /* non-generic request */
David Brownellb13296c2005-09-27 10:38:54 -0700642 switch (typeReq) {
643 case GetHubStatus:
644 case GetPortStatus:
645 len = 4;
646 break;
647 case GetHubDescriptor:
648 len = sizeof (struct usb_hub_descriptor);
649 break;
Sarah Sharp48e82362011-10-06 11:54:23 -0700650 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
651 /* len is returned by hub_control */
652 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 }
David Brownellb13296c2005-09-27 10:38:54 -0700654 status = hcd->driver->hub_control (hcd,
655 typeReq, wValue, wIndex,
656 tbuf, wLength);
Lan Tianyud2123fd2013-01-21 22:18:00 +0800657
658 if (typeReq == GetHubDescriptor)
659 usb_hub_adjust_deviceremovable(hcd->self.root_hub,
660 (struct usb_hub_descriptor *)tbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 break;
662error:
663 /* "protocol stall" on error */
664 status = -EPIPE;
665 }
666
Sarah Sharp48e82362011-10-06 11:54:23 -0700667 if (status < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 len = 0;
669 if (status != -EPIPE) {
670 dev_dbg (hcd->self.controller,
671 "CTRL: TypeReq=0x%x val=0x%x "
672 "idx=0x%x len=%d ==> %d\n",
673 typeReq, wValue, wIndex,
David Brownellb13296c2005-09-27 10:38:54 -0700674 wLength, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 }
Sarah Sharp48e82362011-10-06 11:54:23 -0700676 } else if (status > 0) {
677 /* hub_control may return the length of data copied. */
678 len = status;
679 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 }
681 if (len) {
682 if (urb->transfer_buffer_length < len)
683 len = urb->transfer_buffer_length;
684 urb->actual_length = len;
Matthias Beyer048cb212013-10-05 18:02:08 +0200685 /* always USB_DIR_IN, toward host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 memcpy (ubuf, bufp, len);
687
688 /* report whether RH hardware supports remote wakeup */
689 if (patch_wakeup &&
690 len > offsetof (struct usb_config_descriptor,
691 bmAttributes))
692 ((struct usb_config_descriptor *)ubuf)->bmAttributes
693 |= USB_CONFIG_ATT_WAKEUP;
Alan Stern7329e212008-04-03 18:02:56 -0400694
695 /* report whether RH hardware has an integrated TT */
696 if (patch_protocol &&
697 len > offsetof(struct usb_device_descriptor,
698 bDeviceProtocol))
699 ((struct usb_device_descriptor *) ubuf)->
Aman Deep7bf01182011-12-08 12:05:22 +0530700 bDeviceProtocol = USB_HUB_PR_HS_SINGLE_TT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 }
702
Sean O. Stalleye57e7802013-08-13 10:36:12 -0700703 kfree(tbuf);
704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 /* any errors get returned through the urb completion */
Alan Stern9439eb92007-08-02 15:05:45 -0400706 spin_lock_irq(&hcd_root_hub_lock);
Alan Sterne9df41c2007-08-08 11:48:02 -0400707 usb_hcd_unlink_urb_from_ep(hcd, urb);
Alan Stern4a000272007-08-24 15:42:24 -0400708 usb_hcd_giveback_urb(hcd, urb, status);
Alan Stern9439eb92007-08-02 15:05:45 -0400709 spin_unlock_irq(&hcd_root_hub_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 return 0;
711}
712
713/*-------------------------------------------------------------------------*/
714
715/*
Alan Sternd5926ae72005-04-21 15:56:37 -0400716 * Root Hub interrupt transfers are polled using a timer if the
717 * driver requests it; otherwise the driver is responsible for
718 * calling usb_hcd_poll_rh_status() when an event occurs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 *
Alan Sternd5926ae72005-04-21 15:56:37 -0400720 * Completions are called in_interrupt(), but they may or may not
721 * be in_irq().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 */
Alan Sternd5926ae72005-04-21 15:56:37 -0400723void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
725 struct urb *urb;
Alan Sternd5926ae72005-04-21 15:56:37 -0400726 int length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 unsigned long flags;
Joe Perchesad361c92009-07-06 13:05:40 -0700728 char buffer[6]; /* Any root hubs with > 31 ports? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Alan Stern6d88e672010-06-09 17:34:17 -0400730 if (unlikely(!hcd->rh_pollable))
Alan Stern1b42ae62007-03-13 11:10:52 -0400731 return;
Alan Sternd5926ae72005-04-21 15:56:37 -0400732 if (!hcd->uses_new_polling && !hcd->status_urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Alan Sternd5926ae72005-04-21 15:56:37 -0400735 length = hcd->driver->hub_status_data(hcd, buffer);
736 if (length > 0) {
737
738 /* try to complete the status urb */
Alan Stern9439eb92007-08-02 15:05:45 -0400739 spin_lock_irqsave(&hcd_root_hub_lock, flags);
Alan Sternd5926ae72005-04-21 15:56:37 -0400740 urb = hcd->status_urb;
741 if (urb) {
Alan Stern541c7d42010-06-22 16:39:10 -0400742 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400743 hcd->status_urb = NULL;
Alan Sterne9df41c2007-08-08 11:48:02 -0400744 urb->actual_length = length;
745 memcpy(urb->transfer_buffer, buffer, length);
Alan Stern9439eb92007-08-02 15:05:45 -0400746
Alan Sterne9df41c2007-08-08 11:48:02 -0400747 usb_hcd_unlink_urb_from_ep(hcd, urb);
Alan Stern4a000272007-08-24 15:42:24 -0400748 usb_hcd_giveback_urb(hcd, urb, 0);
Alan Sterne9df41c2007-08-08 11:48:02 -0400749 } else {
Alan Sternd5926ae72005-04-21 15:56:37 -0400750 length = 0;
Alan Stern541c7d42010-06-22 16:39:10 -0400751 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400752 }
Alan Stern9439eb92007-08-02 15:05:45 -0400753 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
Alan Sternd5926ae72005-04-21 15:56:37 -0400754 }
755
756 /* The USB 2.0 spec says 256 ms. This is close enough and won't
Arjan van de Ven01cd0812007-05-22 12:42:56 -0700757 * exceed that limit if HZ is 100. The math is more clunky than
758 * maybe expected, this is to make sure that all timers for USB devices
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300759 * fire at the same time to give the CPU a break in between */
Alan Stern541c7d42010-06-22 16:39:10 -0400760 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
Alan Sternd5926ae72005-04-21 15:56:37 -0400761 (length == 0 && hcd->status_urb != NULL))
Arjan van de Ven01cd0812007-05-22 12:42:56 -0700762 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
Alan Sternd5926ae72005-04-21 15:56:37 -0400763}
764EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
765
766/* timer callback */
767static void rh_timer_func (unsigned long _hcd)
768{
769 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770}
771
772/*-------------------------------------------------------------------------*/
773
Alan Sternd5926ae72005-04-21 15:56:37 -0400774static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
775{
776 int retval;
777 unsigned long flags;
Roel Kluin71d27182009-03-13 12:19:18 +0100778 unsigned len = 1 + (urb->dev->maxchild / 8);
Alan Sternd5926ae72005-04-21 15:56:37 -0400779
780 spin_lock_irqsave (&hcd_root_hub_lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400781 if (hcd->status_urb || urb->transfer_buffer_length < len) {
Alan Sternd5926ae72005-04-21 15:56:37 -0400782 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
783 retval = -EINVAL;
Alan Sterne9df41c2007-08-08 11:48:02 -0400784 goto done;
Alan Sternd5926ae72005-04-21 15:56:37 -0400785 }
Alan Sterne9df41c2007-08-08 11:48:02 -0400786
787 retval = usb_hcd_link_urb_to_ep(hcd, urb);
788 if (retval)
789 goto done;
790
791 hcd->status_urb = urb;
792 urb->hcpriv = hcd; /* indicate it's queued */
793 if (!hcd->uses_new_polling)
794 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
795
796 /* If a status change has already occurred, report it ASAP */
Alan Stern541c7d42010-06-22 16:39:10 -0400797 else if (HCD_POLL_PENDING(hcd))
Alan Sterne9df41c2007-08-08 11:48:02 -0400798 mod_timer(&hcd->rh_timer, jiffies);
799 retval = 0;
800 done:
Alan Sternd5926ae72005-04-21 15:56:37 -0400801 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
802 return retval;
803}
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
806{
Alan Stern5e60a162007-07-30 17:07:21 -0400807 if (usb_endpoint_xfer_int(&urb->ep->desc))
Alan Sternd5926ae72005-04-21 15:56:37 -0400808 return rh_queue_status (hcd, urb);
Alan Stern5e60a162007-07-30 17:07:21 -0400809 if (usb_endpoint_xfer_control(&urb->ep->desc))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 return rh_call_control (hcd, urb);
Alan Sternd5926ae72005-04-21 15:56:37 -0400811 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812}
813
814/*-------------------------------------------------------------------------*/
815
Alan Stern455b25f2006-08-11 16:01:45 -0400816/* Unlinks of root-hub control URBs are legal, but they don't do anything
817 * since these URBs always execute synchronously.
Alan Sternd5926ae72005-04-21 15:56:37 -0400818 */
Alan Sterne9df41c2007-08-08 11:48:02 -0400819static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820{
Alan Stern455b25f2006-08-11 16:01:45 -0400821 unsigned long flags;
Alan Sterne9df41c2007-08-08 11:48:02 -0400822 int rc;
Alan Stern455b25f2006-08-11 16:01:45 -0400823
Alan Stern9439eb92007-08-02 15:05:45 -0400824 spin_lock_irqsave(&hcd_root_hub_lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400825 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
826 if (rc)
827 goto done;
828
Alan Stern5e60a162007-07-30 17:07:21 -0400829 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
Alan Stern455b25f2006-08-11 16:01:45 -0400830 ; /* Do nothing */
Alan Sternd5926ae72005-04-21 15:56:37 -0400831
832 } else { /* Status URB */
833 if (!hcd->uses_new_polling)
Alan Stern455b25f2006-08-11 16:01:45 -0400834 del_timer (&hcd->rh_timer);
Alan Sternd5926ae72005-04-21 15:56:37 -0400835 if (urb == hcd->status_urb) {
836 hcd->status_urb = NULL;
Alan Sterne9df41c2007-08-08 11:48:02 -0400837 usb_hcd_unlink_urb_from_ep(hcd, urb);
Alan Stern4a000272007-08-24 15:42:24 -0400838 usb_hcd_giveback_urb(hcd, urb, status);
Alan Stern9439eb92007-08-02 15:05:45 -0400839 }
840 }
Alan Sterne9df41c2007-08-08 11:48:02 -0400841 done:
Alan Stern9439eb92007-08-02 15:05:45 -0400842 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400843 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844}
845
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700846
847
848/*
849 * Show & store the current value of authorized_default
850 */
Greg Kroah-Hartmand03f2542013-08-23 16:05:26 -0700851static ssize_t authorized_default_show(struct device *dev,
852 struct device_attribute *attr, char *buf)
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700853{
854 struct usb_device *rh_usb_dev = to_usb_device(dev);
855 struct usb_bus *usb_bus = rh_usb_dev->bus;
856 struct usb_hcd *usb_hcd;
857
858 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
859 return -ENODEV;
860 usb_hcd = bus_to_hcd(usb_bus);
861 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
862}
863
Greg Kroah-Hartmand03f2542013-08-23 16:05:26 -0700864static ssize_t authorized_default_store(struct device *dev,
865 struct device_attribute *attr,
866 const char *buf, size_t size)
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700867{
868 ssize_t result;
869 unsigned val;
870 struct usb_device *rh_usb_dev = to_usb_device(dev);
871 struct usb_bus *usb_bus = rh_usb_dev->bus;
872 struct usb_hcd *usb_hcd;
873
874 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
875 return -ENODEV;
876 usb_hcd = bus_to_hcd(usb_bus);
877 result = sscanf(buf, "%u\n", &val);
878 if (result == 1) {
Matthias Beyer14557352013-10-05 18:02:07 +0200879 usb_hcd->authorized_default = val ? 1 : 0;
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700880 result = size;
Matthias Beyerd1ddb0a2013-10-05 18:02:10 +0200881 } else {
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700882 result = -EINVAL;
Matthias Beyerd1ddb0a2013-10-05 18:02:10 +0200883 }
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700884 return result;
885}
Greg Kroah-Hartmand03f2542013-08-23 16:05:26 -0700886static DEVICE_ATTR_RW(authorized_default);
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700887
888/* Group all the USB bus attributes */
889static struct attribute *usb_bus_attrs[] = {
890 &dev_attr_authorized_default.attr,
891 NULL,
892};
893
894static struct attribute_group usb_bus_attr_group = {
895 .name = NULL, /* we want them in the same directory */
896 .attrs = usb_bus_attrs,
897};
898
899
900
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901/*-------------------------------------------------------------------------*/
902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903/**
904 * usb_bus_init - shared initialization code
905 * @bus: the bus structure being initialized
906 *
907 * This code is used to initialize a usb_bus structure, memory for which is
908 * separately managed.
909 */
910static void usb_bus_init (struct usb_bus *bus)
911{
912 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
913
914 bus->devnum_next = 1;
915
916 bus->root_hub = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 bus->busnum = -1;
918 bus->bandwidth_allocated = 0;
919 bus->bandwidth_int_reqs = 0;
920 bus->bandwidth_isoc_reqs = 0;
Todd E Brandt6fecd4f2014-05-19 10:55:32 -0700921 mutex_init(&bus->usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
923 INIT_LIST_HEAD (&bus->bus_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}
925
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926/*-------------------------------------------------------------------------*/
927
928/**
929 * usb_register_bus - registers the USB host controller with the usb core
930 * @bus: pointer to the bus to register
931 * Context: !in_interrupt()
932 *
933 * Assigns a bus number, and links the controller into usbcore data
934 * structures so that it can be seen by scanning the bus list.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200935 *
936 * Return: 0 if successful. A negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 */
938static int usb_register_bus(struct usb_bus *bus)
939{
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700940 int result = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 int busnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100943 mutex_lock(&usb_bus_list_lock);
Matthias Beyer059239a2013-10-05 23:09:15 +0200944 busnum = find_next_zero_bit(busmap, USB_MAXBUS, 1);
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700945 if (busnum >= USB_MAXBUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700947 goto error_find_busnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 }
Matthias Beyer059239a2013-10-05 23:09:15 +0200949 set_bit(busnum, busmap);
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700950 bus->busnum = busnum;
Tony Jones5a3201b2007-09-11 14:07:31 -0700951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 /* Add it to the local list of buses */
953 list_add (&bus->bus_list, &usb_bus_list);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100954 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -0700956 usb_notify_add_bus(bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700958 dev_info (bus->controller, "new USB bus registered, assigned bus "
959 "number %d\n", bus->busnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 return 0;
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700961
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700962error_find_busnum:
963 mutex_unlock(&usb_bus_list_lock);
964 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965}
966
967/**
968 * usb_deregister_bus - deregisters the USB host controller
969 * @bus: pointer to the bus to deregister
970 * Context: !in_interrupt()
971 *
972 * Recycles the bus number, and unlinks the controller from usbcore data
973 * structures so that it won't be seen by scanning the bus list.
974 */
975static void usb_deregister_bus (struct usb_bus *bus)
976{
977 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
978
979 /*
980 * NOTE: make sure that all the devices are removed by the
981 * controller code, as well as having it call this when cleaning
982 * itself up
983 */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100984 mutex_lock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 list_del (&bus->bus_list);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100986 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -0700988 usb_notify_remove_bus(bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Matthias Beyer059239a2013-10-05 23:09:15 +0200990 clear_bit(bus->busnum, busmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991}
992
993/**
Alan Stern8ec8d202005-04-25 11:25:17 -0400994 * register_root_hub - called by usb_add_hcd() to register a root hub
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 * @hcd: host controller for this root hub
996 *
Alan Stern8ec8d202005-04-25 11:25:17 -0400997 * This function registers the root hub with the USB subsystem. It sets up
David Brownellb1e8f0a2006-01-23 15:25:40 -0800998 * the device properly in the device tree and then calls usb_new_device()
999 * to register the usb device. It also assigns the root hub's USB address
1000 * (always 1).
Yacine Belkadi626f0902013-08-02 20:10:04 +02001001 *
1002 * Return: 0 if successful. A negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 */
David Brownellb1e8f0a2006-01-23 15:25:40 -08001004static int register_root_hub(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005{
1006 struct device *parent_dev = hcd->self.controller;
David Brownellb1e8f0a2006-01-23 15:25:40 -08001007 struct usb_device *usb_dev = hcd->self.root_hub;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 const int devnum = 1;
1009 int retval;
1010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 usb_dev->devnum = devnum;
1012 usb_dev->bus->devnum_next = devnum + 1;
1013 memset (&usb_dev->bus->devmap.devicemap, 0,
1014 sizeof usb_dev->bus->devmap.devicemap);
1015 set_bit (devnum, usb_dev->bus->devmap.devicemap);
1016 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
1017
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01001018 mutex_lock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Harvey Harrison551509d2009-02-11 14:11:36 -08001020 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
1022 if (retval != sizeof usb_dev->descriptor) {
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01001023 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +02001025 dev_name(&usb_dev->dev), retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 return (retval < 0) ? retval : -EMSGSIZE;
1027 }
Sarah Sharp448b6eb2012-05-15 16:58:45 -07001028 if (usb_dev->speed == USB_SPEED_SUPER) {
1029 retval = usb_get_bos_descriptor(usb_dev);
1030 if (retval < 0) {
1031 mutex_unlock(&usb_bus_list_lock);
1032 dev_dbg(parent_dev, "can't read %s bos descriptor %d\n",
1033 dev_name(&usb_dev->dev), retval);
1034 return retval;
1035 }
1036 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 retval = usb_new_device (usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 dev_err (parent_dev, "can't register root hub for %s, %d\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +02001041 dev_name(&usb_dev->dev), retval);
Alan Stern0a231402012-09-26 13:09:53 -04001042 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 spin_lock_irq (&hcd_root_hub_lock);
1044 hcd->rh_registered = 1;
1045 spin_unlock_irq (&hcd_root_hub_lock);
1046
1047 /* Did the HC die before the root hub was registered? */
Alan Stern69fff592011-05-17 17:27:12 -04001048 if (HCD_DEAD(hcd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 usb_hc_died (hcd); /* This time clean up */
1050 }
Alan Stern0a231402012-09-26 13:09:53 -04001051 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
1053 return retval;
1054}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
Alan Sternda0aa712013-01-25 17:09:42 -05001056/*
1057 * usb_hcd_start_port_resume - a root-hub port is sending a resume signal
1058 * @bus: the bus which the root hub belongs to
1059 * @portnum: the port which is being resumed
1060 *
1061 * HCDs should call this function when they know that a resume signal is
1062 * being sent to a root-hub port. The root hub will be prevented from
1063 * going into autosuspend until usb_hcd_end_port_resume() is called.
1064 *
1065 * The bus's private lock must be held by the caller.
1066 */
1067void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum)
1068{
1069 unsigned bit = 1 << portnum;
1070
1071 if (!(bus->resuming_ports & bit)) {
1072 bus->resuming_ports |= bit;
1073 pm_runtime_get_noresume(&bus->root_hub->dev);
1074 }
1075}
1076EXPORT_SYMBOL_GPL(usb_hcd_start_port_resume);
1077
1078/*
1079 * usb_hcd_end_port_resume - a root-hub port has stopped sending a resume signal
1080 * @bus: the bus which the root hub belongs to
1081 * @portnum: the port which is being resumed
1082 *
1083 * HCDs should call this function when they know that a resume signal has
1084 * stopped being sent to a root-hub port. The root hub will be allowed to
1085 * autosuspend again.
1086 *
1087 * The bus's private lock must be held by the caller.
1088 */
1089void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum)
1090{
1091 unsigned bit = 1 << portnum;
1092
1093 if (bus->resuming_ports & bit) {
1094 bus->resuming_ports &= ~bit;
1095 pm_runtime_put_noidle(&bus->root_hub->dev);
1096 }
1097}
1098EXPORT_SYMBOL_GPL(usb_hcd_end_port_resume);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
1100/*-------------------------------------------------------------------------*/
1101
1102/**
1103 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
1104 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1105 * @is_input: true iff the transaction sends data to the host
1106 * @isoc: true for isochronous transactions, false for interrupt ones
1107 * @bytecount: how many bytes in the transaction.
1108 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001109 * Return: Approximate bus time in nanoseconds for a periodic transaction.
1110 *
1111 * Note:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1113 * scheduled in software, this function is only used for such scheduling.
1114 */
1115long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1116{
1117 unsigned long tmp;
1118
1119 switch (speed) {
1120 case USB_SPEED_LOW: /* INTR only */
1121 if (is_input) {
1122 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
Matthias Beyer07010492013-10-05 18:02:09 +02001123 return 64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 } else {
1125 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
Matthias Beyer07010492013-10-05 18:02:09 +02001126 return 64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 }
1128 case USB_SPEED_FULL: /* ISOC or INTR */
1129 if (isoc) {
1130 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
Matthias Beyer07010492013-10-05 18:02:09 +02001131 return ((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 } else {
1133 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
Matthias Beyer07010492013-10-05 18:02:09 +02001134 return 9107L + BW_HOST_DELAY + tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 }
1136 case USB_SPEED_HIGH: /* ISOC or INTR */
Matthias Beyer048cb212013-10-05 18:02:08 +02001137 /* FIXME adjust for input vs output */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 if (isoc)
Dan Streetman498f78e2005-07-29 12:18:28 -07001139 tmp = HS_NSECS_ISO (bytecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 else
Dan Streetman498f78e2005-07-29 12:18:28 -07001141 tmp = HS_NSECS (bytecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 return tmp;
1143 default:
1144 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1145 return -1;
1146 }
1147}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001148EXPORT_SYMBOL_GPL(usb_calc_bus_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
1151/*-------------------------------------------------------------------------*/
1152
1153/*
1154 * Generic HC operations.
1155 */
1156
1157/*-------------------------------------------------------------------------*/
1158
Alan Sterne9df41c2007-08-08 11:48:02 -04001159/**
1160 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1161 * @hcd: host controller to which @urb was submitted
1162 * @urb: URB being submitted
1163 *
1164 * Host controller drivers should call this routine in their enqueue()
1165 * method. The HCD's private spinlock must be held and interrupts must
1166 * be disabled. The actions carried out here are required for URB
1167 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1168 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001169 * Return: 0 for no error, otherwise a negative error code (in which case
Alan Sterne9df41c2007-08-08 11:48:02 -04001170 * the enqueue() method must fail). If no error occurs but enqueue() fails
1171 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1172 * the private spinlock and returning.
1173 */
1174int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
Alan Stern9a9bf402007-08-02 15:06:54 -04001175{
Alan Stern9a9bf402007-08-02 15:06:54 -04001176 int rc = 0;
1177
Alan Sterne9df41c2007-08-08 11:48:02 -04001178 spin_lock(&hcd_urb_list_lock);
Alan Stern9a9bf402007-08-02 15:06:54 -04001179
1180 /* Check that the URB isn't being killed */
Ming Lei49367d82008-12-12 21:38:45 +08001181 if (unlikely(atomic_read(&urb->reject))) {
Alan Stern9a9bf402007-08-02 15:06:54 -04001182 rc = -EPERM;
1183 goto done;
1184 }
1185
1186 if (unlikely(!urb->ep->enabled)) {
1187 rc = -ENOENT;
1188 goto done;
1189 }
1190
Alan Stern6840d252007-09-10 11:34:26 -04001191 if (unlikely(!urb->dev->can_submit)) {
1192 rc = -EHOSTUNREACH;
1193 goto done;
1194 }
1195
Alan Stern9a9bf402007-08-02 15:06:54 -04001196 /*
1197 * Check the host controller's state and add the URB to the
1198 * endpoint's queue.
1199 */
Alan Stern9b375962011-03-07 11:11:52 -05001200 if (HCD_RH_RUNNING(hcd)) {
Alan Sterneb231052007-08-21 15:40:36 -04001201 urb->unlinked = 0;
Alan Stern9a9bf402007-08-02 15:06:54 -04001202 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
Alan Stern9b375962011-03-07 11:11:52 -05001203 } else {
Alan Stern9a9bf402007-08-02 15:06:54 -04001204 rc = -ESHUTDOWN;
1205 goto done;
1206 }
1207 done:
Alan Sterne9df41c2007-08-08 11:48:02 -04001208 spin_unlock(&hcd_urb_list_lock);
Alan Stern9a9bf402007-08-02 15:06:54 -04001209 return rc;
1210}
Alan Sterne9df41c2007-08-08 11:48:02 -04001211EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
Alan Stern9a9bf402007-08-02 15:06:54 -04001212
Alan Sterne9df41c2007-08-08 11:48:02 -04001213/**
1214 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1215 * @hcd: host controller to which @urb was submitted
1216 * @urb: URB being checked for unlinkability
1217 * @status: error code to store in @urb if the unlink succeeds
1218 *
1219 * Host controller drivers should call this routine in their dequeue()
1220 * method. The HCD's private spinlock must be held and interrupts must
1221 * be disabled. The actions carried out here are required for making
1222 * sure than an unlink is valid.
1223 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001224 * Return: 0 for no error, otherwise a negative error code (in which case
Alan Sterne9df41c2007-08-08 11:48:02 -04001225 * the dequeue() method must fail). The possible error codes are:
1226 *
1227 * -EIDRM: @urb was not submitted or has already completed.
1228 * The completion function may not have been called yet.
1229 *
1230 * -EBUSY: @urb has already been unlinked.
1231 */
1232int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
Alan Stern9a9bf402007-08-02 15:06:54 -04001233 int status)
1234{
Alan Stern9a9bf402007-08-02 15:06:54 -04001235 struct list_head *tmp;
Alan Stern9a9bf402007-08-02 15:06:54 -04001236
1237 /* insist the urb is still queued */
1238 list_for_each(tmp, &urb->ep->urb_list) {
1239 if (tmp == &urb->urb_list)
1240 break;
1241 }
Alan Sterne9df41c2007-08-08 11:48:02 -04001242 if (tmp != &urb->urb_list)
1243 return -EIDRM;
Alan Stern9a9bf402007-08-02 15:06:54 -04001244
1245 /* Any status except -EINPROGRESS means something already started to
1246 * unlink this URB from the hardware. So there's no more work to do.
1247 */
Alan Sterneb231052007-08-21 15:40:36 -04001248 if (urb->unlinked)
Alan Sterne9df41c2007-08-08 11:48:02 -04001249 return -EBUSY;
Alan Sterneb231052007-08-21 15:40:36 -04001250 urb->unlinked = status;
Alan Sterne9df41c2007-08-08 11:48:02 -04001251 return 0;
Alan Stern9a9bf402007-08-02 15:06:54 -04001252}
Alan Sterne9df41c2007-08-08 11:48:02 -04001253EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
Alan Stern9a9bf402007-08-02 15:06:54 -04001254
Alan Sterne9df41c2007-08-08 11:48:02 -04001255/**
1256 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1257 * @hcd: host controller to which @urb was submitted
1258 * @urb: URB being unlinked
1259 *
1260 * Host controller drivers should call this routine before calling
1261 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1262 * interrupts must be disabled. The actions carried out here are required
1263 * for URB completion.
1264 */
1265void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 /* clear all state linking urb to this dev (and hcd) */
Alan Sterne9df41c2007-08-08 11:48:02 -04001268 spin_lock(&hcd_urb_list_lock);
Alan Stern9a9bf402007-08-02 15:06:54 -04001269 list_del_init(&urb->urb_list);
Alan Sterne9df41c2007-08-08 11:48:02 -04001270 spin_unlock(&hcd_urb_list_lock);
Pete Zaitcev9f6a93f2007-06-08 13:37:49 -07001271}
Alan Sterne9df41c2007-08-08 11:48:02 -04001272EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Magnus Dammb3476672008-01-23 15:58:35 +09001274/*
1275 * Some usb host controllers can only perform dma using a small SRAM area.
1276 * The usb core itself is however optimized for host controllers that can dma
1277 * using regular system memory - like pci devices doing bus mastering.
1278 *
1279 * To support host controllers with limited dma capabilites we provide dma
1280 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1281 * For this to work properly the host controller code must first use the
1282 * function dma_declare_coherent_memory() to point out which memory area
1283 * that should be used for dma allocations.
1284 *
1285 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1286 * dma using dma_alloc_coherent() which in turn allocates from the memory
1287 * area pointed out with dma_declare_coherent_memory().
1288 *
1289 * So, to summarize...
1290 *
1291 * - We need "local" memory, canonical example being
1292 * a small SRAM on a discrete controller being the
1293 * only memory that the controller can read ...
1294 * (a) "normal" kernel memory is no good, and
1295 * (b) there's not enough to share
1296 *
1297 * - The only *portable* hook for such stuff in the
1298 * DMA framework is dma_declare_coherent_memory()
1299 *
1300 * - So we use that, even though the primary requirement
Rahul Bedarkar025d4432014-01-04 11:24:41 +05301301 * is that the memory be "local" (hence addressable
Magnus Dammb3476672008-01-23 15:58:35 +09001302 * by that device), not "coherent".
1303 *
1304 */
1305
1306static int hcd_alloc_coherent(struct usb_bus *bus,
1307 gfp_t mem_flags, dma_addr_t *dma_handle,
1308 void **vaddr_handle, size_t size,
1309 enum dma_data_direction dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310{
Magnus Dammb3476672008-01-23 15:58:35 +09001311 unsigned char *vaddr;
1312
Andrea Righi4307a282010-06-28 16:56:45 +02001313 if (*vaddr_handle == NULL) {
1314 WARN_ON_ONCE(1);
1315 return -EFAULT;
1316 }
1317
Magnus Dammb3476672008-01-23 15:58:35 +09001318 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1319 mem_flags, dma_handle);
1320 if (!vaddr)
1321 return -ENOMEM;
1322
1323 /*
1324 * Store the virtual address of the buffer at the end
1325 * of the allocated dma buffer. The size of the buffer
1326 * may be uneven so use unaligned functions instead
1327 * of just rounding up. It makes sense to optimize for
1328 * memory footprint over access speed since the amount
1329 * of memory available for dma may be limited.
1330 */
1331 put_unaligned((unsigned long)*vaddr_handle,
1332 (unsigned long *)(vaddr + size));
1333
1334 if (dir == DMA_TO_DEVICE)
1335 memcpy(vaddr, *vaddr_handle, size);
1336
1337 *vaddr_handle = vaddr;
1338 return 0;
1339}
1340
1341static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1342 void **vaddr_handle, size_t size,
1343 enum dma_data_direction dir)
1344{
1345 unsigned char *vaddr = *vaddr_handle;
1346
1347 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1348
1349 if (dir == DMA_FROM_DEVICE)
1350 memcpy(vaddr, *vaddr_handle, size);
1351
1352 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1353
1354 *vaddr_handle = vaddr;
1355 *dma_handle = 0;
1356}
1357
Robert Morellc8cf2032011-01-26 19:06:47 -08001358void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
Alan Sternff9c8952010-04-02 13:27:28 -04001359{
Alan Sternff9c8952010-04-02 13:27:28 -04001360 if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
1361 dma_unmap_single(hcd->self.controller,
1362 urb->setup_dma,
1363 sizeof(struct usb_ctrlrequest),
1364 DMA_TO_DEVICE);
1365 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1366 hcd_free_coherent(urb->dev->bus,
1367 &urb->setup_dma,
1368 (void **) &urb->setup_packet,
1369 sizeof(struct usb_ctrlrequest),
1370 DMA_TO_DEVICE);
1371
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001372 /* Make it safe to call this routine more than once */
1373 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1374}
Robert Morellc8cf2032011-01-26 19:06:47 -08001375EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_setup_for_dma);
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001376
Robert Morell2694a482011-01-26 19:06:48 -08001377static void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1378{
1379 if (hcd->driver->unmap_urb_for_dma)
1380 hcd->driver->unmap_urb_for_dma(hcd, urb);
1381 else
1382 usb_hcd_unmap_urb_for_dma(hcd, urb);
1383}
1384
Robert Morellc8cf2032011-01-26 19:06:47 -08001385void usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001386{
1387 enum dma_data_direction dir;
1388
Robert Morellc8cf2032011-01-26 19:06:47 -08001389 usb_hcd_unmap_urb_setup_for_dma(hcd, urb);
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001390
Alan Sternff9c8952010-04-02 13:27:28 -04001391 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1392 if (urb->transfer_flags & URB_DMA_MAP_SG)
1393 dma_unmap_sg(hcd->self.controller,
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001394 urb->sg,
Alan Sternff9c8952010-04-02 13:27:28 -04001395 urb->num_sgs,
1396 dir);
1397 else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
1398 dma_unmap_page(hcd->self.controller,
1399 urb->transfer_dma,
1400 urb->transfer_buffer_length,
1401 dir);
1402 else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
1403 dma_unmap_single(hcd->self.controller,
1404 urb->transfer_dma,
1405 urb->transfer_buffer_length,
1406 dir);
1407 else if (urb->transfer_flags & URB_MAP_LOCAL)
1408 hcd_free_coherent(urb->dev->bus,
1409 &urb->transfer_dma,
1410 &urb->transfer_buffer,
1411 urb->transfer_buffer_length,
1412 dir);
1413
1414 /* Make it safe to call this routine more than once */
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001415 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
Alan Sternff9c8952010-04-02 13:27:28 -04001416 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1417}
Robert Morellc8cf2032011-01-26 19:06:47 -08001418EXPORT_SYMBOL_GPL(usb_hcd_unmap_urb_for_dma);
Alan Sternff9c8952010-04-02 13:27:28 -04001419
Magnus Dammb3476672008-01-23 15:58:35 +09001420static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1421 gfp_t mem_flags)
1422{
Robert Morell2694a482011-01-26 19:06:48 -08001423 if (hcd->driver->map_urb_for_dma)
1424 return hcd->driver->map_urb_for_dma(hcd, urb, mem_flags);
1425 else
1426 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
1427}
1428
1429int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1430 gfp_t mem_flags)
1431{
Magnus Dammb3476672008-01-23 15:58:35 +09001432 enum dma_data_direction dir;
1433 int ret = 0;
1434
Alan Stern9a9bf402007-08-02 15:06:54 -04001435 /* Map the URB's buffers for DMA access.
1436 * Lower level HCD code should use *_dma exclusively,
Sarah Sharpe04748e2009-04-27 19:59:01 -07001437 * unless it uses pio or talks to another transport,
1438 * or uses the provided scatter gather list for bulk.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 */
Magnus Dammb3476672008-01-23 15:58:35 +09001440
Alan Stern85bcb5e2010-04-30 16:35:37 -04001441 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
Anand Gadiyar07a8cdd2010-11-18 18:54:17 +05301442 if (hcd->self.uses_pio_for_control)
1443 return ret;
Larry Finger85e034f2009-11-05 10:37:03 -06001444 if (hcd->self.uses_dma) {
Magnus Dammb3476672008-01-23 15:58:35 +09001445 urb->setup_dma = dma_map_single(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 hcd->self.controller,
1447 urb->setup_packet,
Magnus Dammb3476672008-01-23 15:58:35 +09001448 sizeof(struct usb_ctrlrequest),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 DMA_TO_DEVICE);
Larry Finger85e034f2009-11-05 10:37:03 -06001450 if (dma_mapping_error(hcd->self.controller,
1451 urb->setup_dma))
1452 return -EAGAIN;
Alan Sternff9c8952010-04-02 13:27:28 -04001453 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
Ming Leif537da62010-05-12 23:38:12 +08001454 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
Magnus Dammb3476672008-01-23 15:58:35 +09001455 ret = hcd_alloc_coherent(
1456 urb->dev->bus, mem_flags,
1457 &urb->setup_dma,
1458 (void **)&urb->setup_packet,
1459 sizeof(struct usb_ctrlrequest),
1460 DMA_TO_DEVICE);
Alan Sternff9c8952010-04-02 13:27:28 -04001461 if (ret)
1462 return ret;
1463 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
Ming Leif537da62010-05-12 23:38:12 +08001464 }
Magnus Dammb3476672008-01-23 15:58:35 +09001465 }
1466
1467 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
Alan Sternff9c8952010-04-02 13:27:28 -04001468 if (urb->transfer_buffer_length != 0
Magnus Dammb3476672008-01-23 15:58:35 +09001469 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
Larry Finger85e034f2009-11-05 10:37:03 -06001470 if (hcd->self.uses_dma) {
Alan Sternff9c8952010-04-02 13:27:28 -04001471 if (urb->num_sgs) {
Hans de Goedefe2072c2012-07-09 15:57:00 +02001472 int n;
1473
1474 /* We don't support sg for isoc transfers ! */
1475 if (usb_endpoint_xfer_isoc(&urb->ep->desc)) {
1476 WARN_ON(1);
1477 return -EINVAL;
1478 }
1479
1480 n = dma_map_sg(
Alan Sternff9c8952010-04-02 13:27:28 -04001481 hcd->self.controller,
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001482 urb->sg,
Alan Sternff9c8952010-04-02 13:27:28 -04001483 urb->num_sgs,
1484 dir);
1485 if (n <= 0)
1486 ret = -EAGAIN;
1487 else
1488 urb->transfer_flags |= URB_DMA_MAP_SG;
Clemens Ladischbc677d52011-12-03 23:41:31 +01001489 urb->num_mapped_sgs = n;
1490 if (n != urb->num_sgs)
Alan Sternff9c8952010-04-02 13:27:28 -04001491 urb->transfer_flags |=
1492 URB_DMA_SG_COMBINED;
Alan Sternff9c8952010-04-02 13:27:28 -04001493 } else if (urb->sg) {
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001494 struct scatterlist *sg = urb->sg;
Alan Sternff9c8952010-04-02 13:27:28 -04001495 urb->transfer_dma = dma_map_page(
1496 hcd->self.controller,
1497 sg_page(sg),
1498 sg->offset,
1499 urb->transfer_buffer_length,
1500 dir);
1501 if (dma_mapping_error(hcd->self.controller,
Larry Finger85e034f2009-11-05 10:37:03 -06001502 urb->transfer_dma))
Alan Sternff9c8952010-04-02 13:27:28 -04001503 ret = -EAGAIN;
1504 else
1505 urb->transfer_flags |= URB_DMA_MAP_PAGE;
Dan Williams29d2fef2014-05-08 19:25:56 +03001506 } else if (is_vmalloc_addr(urb->transfer_buffer)) {
1507 WARN_ONCE(1, "transfer buffer not dma capable\n");
1508 ret = -EAGAIN;
Alan Sternff9c8952010-04-02 13:27:28 -04001509 } else {
1510 urb->transfer_dma = dma_map_single(
1511 hcd->self.controller,
1512 urb->transfer_buffer,
1513 urb->transfer_buffer_length,
1514 dir);
1515 if (dma_mapping_error(hcd->self.controller,
1516 urb->transfer_dma))
1517 ret = -EAGAIN;
1518 else
1519 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1520 }
Larry Finger85e034f2009-11-05 10:37:03 -06001521 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
Magnus Dammb3476672008-01-23 15:58:35 +09001522 ret = hcd_alloc_coherent(
1523 urb->dev->bus, mem_flags,
1524 &urb->transfer_dma,
1525 &urb->transfer_buffer,
1526 urb->transfer_buffer_length,
1527 dir);
Alan Sternff9c8952010-04-02 13:27:28 -04001528 if (ret == 0)
1529 urb->transfer_flags |= URB_MAP_LOCAL;
Magnus Dammb3476672008-01-23 15:58:35 +09001530 }
Alan Sternff9c8952010-04-02 13:27:28 -04001531 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1532 URB_SETUP_MAP_LOCAL)))
Robert Morellc8cf2032011-01-26 19:06:47 -08001533 usb_hcd_unmap_urb_for_dma(hcd, urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 }
Magnus Dammb3476672008-01-23 15:58:35 +09001535 return ret;
Alan Stern9a9bf402007-08-02 15:06:54 -04001536}
Robert Morell2694a482011-01-26 19:06:48 -08001537EXPORT_SYMBOL_GPL(usb_hcd_map_urb_for_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
Alan Stern9a9bf402007-08-02 15:06:54 -04001539/*-------------------------------------------------------------------------*/
1540
1541/* may be called in any context with a valid urb->dev usecount
1542 * caller surrenders "ownership" of urb
1543 * expects usb_submit_urb() to have sanity checked and conditioned all
1544 * inputs in the urb
1545 */
1546int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1547{
1548 int status;
1549 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1550
1551 /* increment urb's reference count as part of giving it to the HCD
1552 * (which will control it). HCD guarantees that it either returns
1553 * an error or calls giveback(), but not both.
1554 */
1555 usb_get_urb(urb);
1556 atomic_inc(&urb->use_count);
Sarah Sharp4d59d8a2007-10-03 14:56:03 -07001557 atomic_inc(&urb->dev->urbnum);
Alan Stern9a9bf402007-08-02 15:06:54 -04001558 usbmon_urb_submit(&hcd->self, urb);
1559
1560 /* NOTE requirements on root-hub callers (usbfs and the hub
1561 * driver, for now): URBs' urb->transfer_buffer must be
1562 * valid and usb_buffer_{sync,unmap}() not be needed, since
1563 * they could clobber root hub response data. Also, control
1564 * URBs must be submitted in process context with interrupts
1565 * enabled.
1566 */
Alan Sternff9c8952010-04-02 13:27:28 -04001567
1568 if (is_root_hub(urb->dev)) {
1569 status = rh_urb_enqueue(hcd, urb);
1570 } else {
1571 status = map_urb_for_dma(hcd, urb, mem_flags);
1572 if (likely(status == 0)) {
1573 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1574 if (unlikely(status))
Robert Morell2694a482011-01-26 19:06:48 -08001575 unmap_urb_for_dma(hcd, urb);
Alan Sternff9c8952010-04-02 13:27:28 -04001576 }
Magnus Dammb3476672008-01-23 15:58:35 +09001577 }
1578
Alan Stern9a9bf402007-08-02 15:06:54 -04001579 if (unlikely(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 usbmon_urb_submit_error(&hcd->self, urb, status);
Alan Sternb0d9efb2007-08-21 15:39:21 -04001581 urb->hcpriv = NULL;
Alan Stern9a9bf402007-08-02 15:06:54 -04001582 INIT_LIST_HEAD(&urb->urb_list);
1583 atomic_dec(&urb->use_count);
Sarah Sharp4d59d8a2007-10-03 14:56:03 -07001584 atomic_dec(&urb->dev->urbnum);
Ming Lei49367d82008-12-12 21:38:45 +08001585 if (atomic_read(&urb->reject))
Alan Stern9a9bf402007-08-02 15:06:54 -04001586 wake_up(&usb_kill_urb_queue);
1587 usb_put_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 }
1589 return status;
1590}
1591
1592/*-------------------------------------------------------------------------*/
1593
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594/* this makes the hcd giveback() the urb more quickly, by kicking it
1595 * off hardware queues (which may take a while) and returning it as
1596 * soon as practical. we've already set up the urb's return status,
1597 * but we can't know if the callback completed already.
1598 */
Alan Sterne9df41c2007-08-08 11:48:02 -04001599static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600{
1601 int value;
1602
Alan Stern809a58b2007-07-18 12:14:24 -04001603 if (is_root_hub(urb->dev))
Alan Sterne9df41c2007-08-08 11:48:02 -04001604 value = usb_rh_urb_dequeue(hcd, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 else {
1606
1607 /* The only reason an HCD might fail this call is if
1608 * it has not yet fully queued the urb to begin with.
1609 * Such failures should be harmless. */
Alan Sterne9df41c2007-08-08 11:48:02 -04001610 value = hcd->driver->urb_dequeue(hcd, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 return value;
1613}
1614
1615/*
1616 * called in any context
1617 *
1618 * caller guarantees urb won't be recycled till both unlink()
1619 * and the urb's completion function return
1620 */
Alan Sterna6d2bb92006-08-30 11:27:36 -04001621int usb_hcd_unlink_urb (struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
Alan Stern9a9bf402007-08-02 15:06:54 -04001623 struct usb_hcd *hcd;
Alan Sterncde217a2008-10-21 15:28:46 -04001624 int retval = -EIDRM;
1625 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Alan Sterncde217a2008-10-21 15:28:46 -04001627 /* Prevent the device and bus from going away while
1628 * the unlink is carried out. If they are already gone
1629 * then urb->use_count must be 0, since disconnected
1630 * devices can't have any active URBs.
1631 */
1632 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1633 if (atomic_read(&urb->use_count) > 0) {
1634 retval = 0;
1635 usb_get_dev(urb->dev);
1636 }
1637 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1638 if (retval == 0) {
1639 hcd = bus_to_hcd(urb->dev->bus);
1640 retval = unlink1(hcd, urb, status);
1641 usb_put_dev(urb->dev);
1642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 if (retval == 0)
1645 retval = -EINPROGRESS;
Alan Sterne9df41c2007-08-08 11:48:02 -04001646 else if (retval != -EIDRM && retval != -EBUSY)
Alan Stern9a9bf402007-08-02 15:06:54 -04001647 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1648 urb, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 return retval;
1650}
1651
1652/*-------------------------------------------------------------------------*/
1653
Ming Lei94dfd7e2013-07-03 22:53:07 +08001654static void __usb_hcd_giveback_urb(struct urb *urb)
1655{
1656 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
Hans de Goede6ec41472013-10-09 17:01:41 +02001657 struct usb_anchor *anchor = urb->anchor;
Ming Lei94dfd7e2013-07-03 22:53:07 +08001658 int status = urb->unlinked;
1659 unsigned long flags;
1660
1661 urb->hcpriv = NULL;
1662 if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
1663 urb->actual_length < urb->transfer_buffer_length &&
1664 !status))
1665 status = -EREMOTEIO;
1666
1667 unmap_urb_for_dma(hcd, urb);
1668 usbmon_urb_complete(&hcd->self, urb, status);
Hans de Goede6ec41472013-10-09 17:01:41 +02001669 usb_anchor_suspend_wakeups(anchor);
Ming Lei94dfd7e2013-07-03 22:53:07 +08001670 usb_unanchor_urb(urb);
1671
1672 /* pass ownership to the completion handler */
1673 urb->status = status;
1674
1675 /*
1676 * We disable local IRQs here avoid possible deadlock because
1677 * drivers may call spin_lock() to hold lock which might be
1678 * acquired in one hard interrupt handler.
1679 *
1680 * The local_irq_save()/local_irq_restore() around complete()
1681 * will be removed if current USB drivers have been cleaned up
1682 * and no one may trigger the above deadlock situation when
1683 * running complete() in tasklet.
1684 */
1685 local_irq_save(flags);
1686 urb->complete(urb);
1687 local_irq_restore(flags);
1688
Hans de Goede6ec41472013-10-09 17:01:41 +02001689 usb_anchor_resume_wakeups(anchor);
Ming Lei94dfd7e2013-07-03 22:53:07 +08001690 atomic_dec(&urb->use_count);
1691 if (unlikely(atomic_read(&urb->reject)))
1692 wake_up(&usb_kill_urb_queue);
1693 usb_put_urb(urb);
1694}
1695
1696static void usb_giveback_urb_bh(unsigned long param)
1697{
1698 struct giveback_urb_bh *bh = (struct giveback_urb_bh *)param;
1699 struct list_head local_list;
1700
1701 spin_lock_irq(&bh->lock);
1702 bh->running = true;
1703 restart:
1704 list_replace_init(&bh->head, &local_list);
1705 spin_unlock_irq(&bh->lock);
1706
1707 while (!list_empty(&local_list)) {
1708 struct urb *urb;
1709
1710 urb = list_entry(local_list.next, struct urb, urb_list);
1711 list_del_init(&urb->urb_list);
Alan Sternc7ccde62013-09-03 13:58:43 -04001712 bh->completing_ep = urb->ep;
Ming Lei94dfd7e2013-07-03 22:53:07 +08001713 __usb_hcd_giveback_urb(urb);
Alan Sternc7ccde62013-09-03 13:58:43 -04001714 bh->completing_ep = NULL;
Ming Lei94dfd7e2013-07-03 22:53:07 +08001715 }
1716
1717 /* check if there are new URBs to giveback */
1718 spin_lock_irq(&bh->lock);
1719 if (!list_empty(&bh->head))
1720 goto restart;
1721 bh->running = false;
1722 spin_unlock_irq(&bh->lock);
1723}
1724
Alan Stern32aca562007-07-18 12:08:02 -04001725/**
1726 * usb_hcd_giveback_urb - return URB from HCD to device driver
1727 * @hcd: host controller returning the URB
1728 * @urb: urb being returned to the USB device driver.
Alan Stern4a000272007-08-24 15:42:24 -04001729 * @status: completion status code for the URB.
Alan Stern32aca562007-07-18 12:08:02 -04001730 * Context: in_interrupt()
1731 *
1732 * This hands the URB from HCD to its USB device driver, using its
1733 * completion function. The HCD has freed all per-urb resources
1734 * (and is done using urb->hcpriv). It also released all HCD locks;
1735 * the device driver won't cause problems if it frees, modifies,
1736 * or resubmits this URB.
Alan Sterneb231052007-08-21 15:40:36 -04001737 *
Alan Stern4a000272007-08-24 15:42:24 -04001738 * If @urb was unlinked, the value of @status will be overridden by
Alan Sterneb231052007-08-21 15:40:36 -04001739 * @urb->unlinked. Erroneous short transfers are detected in case
1740 * the HCD hasn't checked for them.
Alan Stern32aca562007-07-18 12:08:02 -04001741 */
Alan Stern4a000272007-08-24 15:42:24 -04001742void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
Alan Stern32aca562007-07-18 12:08:02 -04001743{
Ming Lei94dfd7e2013-07-03 22:53:07 +08001744 struct giveback_urb_bh *bh;
1745 bool running, high_prio_bh;
Alan Stern32aca562007-07-18 12:08:02 -04001746
Ming Lei94dfd7e2013-07-03 22:53:07 +08001747 /* pass status to tasklet via unlinked */
1748 if (likely(!urb->unlinked))
1749 urb->unlinked = status;
Alan Stern1f5a3d02007-08-22 13:06:53 -04001750
Ming Lei94dfd7e2013-07-03 22:53:07 +08001751 if (!hcd_giveback_urb_in_bh(hcd) && !is_root_hub(urb->dev)) {
1752 __usb_hcd_giveback_urb(urb);
1753 return;
1754 }
1755
1756 if (usb_pipeisoc(urb->pipe) || usb_pipeint(urb->pipe)) {
1757 bh = &hcd->high_prio_bh;
1758 high_prio_bh = true;
1759 } else {
1760 bh = &hcd->low_prio_bh;
1761 high_prio_bh = false;
1762 }
1763
1764 spin_lock(&bh->lock);
1765 list_add_tail(&urb->urb_list, &bh->head);
1766 running = bh->running;
1767 spin_unlock(&bh->lock);
1768
1769 if (running)
1770 ;
1771 else if (high_prio_bh)
1772 tasklet_hi_schedule(&bh->bh);
1773 else
1774 tasklet_schedule(&bh->bh);
Alan Stern32aca562007-07-18 12:08:02 -04001775}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001776EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
Alan Stern32aca562007-07-18 12:08:02 -04001777
1778/*-------------------------------------------------------------------------*/
1779
Alan Stern95cf82f2007-09-10 11:33:05 -04001780/* Cancel all URBs pending on this endpoint and wait for the endpoint's
1781 * queue to drain completely. The caller must first insure that no more
1782 * URBs can be submitted for this endpoint.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 */
Alan Stern95cf82f2007-09-10 11:33:05 -04001784void usb_hcd_flush_endpoint(struct usb_device *udev,
Alan Sterna6d2bb92006-08-30 11:27:36 -04001785 struct usb_host_endpoint *ep)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786{
1787 struct usb_hcd *hcd;
1788 struct urb *urb;
1789
Alan Stern95cf82f2007-09-10 11:33:05 -04001790 if (!ep)
1791 return;
Alan Stern9a9bf402007-08-02 15:06:54 -04001792 might_sleep();
Alan Stern17200582006-08-30 11:32:52 -04001793 hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Alan Stern95cf82f2007-09-10 11:33:05 -04001795 /* No more submits can occur */
Alan Stern9a9bf402007-08-02 15:06:54 -04001796 spin_lock_irq(&hcd_urb_list_lock);
Alan Sternddc1fd62007-11-21 15:13:10 -08001797rescan:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 list_for_each_entry (urb, &ep->urb_list, urb_list) {
Alan Stern5e60a162007-07-30 17:07:21 -04001799 int is_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
Alan Sterneb231052007-08-21 15:40:36 -04001801 if (urb->unlinked)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 continue;
1803 usb_get_urb (urb);
Alan Stern5e60a162007-07-30 17:07:21 -04001804 is_in = usb_urb_dir_in(urb);
Alan Stern809a58b2007-07-18 12:14:24 -04001805 spin_unlock(&hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Alan Sterne9df41c2007-08-08 11:48:02 -04001807 /* kick hcd */
1808 unlink1(hcd, urb, -ESHUTDOWN);
1809 dev_dbg (hcd->self.controller,
1810 "shutdown urb %p ep%d%s%s\n",
1811 urb, usb_endpoint_num(&ep->desc),
1812 is_in ? "in" : "out",
1813 ({ char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
Alan Sterne9df41c2007-08-08 11:48:02 -04001815 switch (usb_endpoint_type(&ep->desc)) {
1816 case USB_ENDPOINT_XFER_CONTROL:
1817 s = ""; break;
1818 case USB_ENDPOINT_XFER_BULK:
1819 s = "-bulk"; break;
1820 case USB_ENDPOINT_XFER_INT:
1821 s = "-intr"; break;
1822 default:
Matthias Beyer14557352013-10-05 18:02:07 +02001823 s = "-iso"; break;
Alan Sterne9df41c2007-08-08 11:48:02 -04001824 };
1825 s;
1826 }));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 usb_put_urb (urb);
1828
1829 /* list contents may have changed */
Alan Sternddc1fd62007-11-21 15:13:10 -08001830 spin_lock(&hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 goto rescan;
1832 }
Alan Stern9a9bf402007-08-02 15:06:54 -04001833 spin_unlock_irq(&hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834
Alan Stern95cf82f2007-09-10 11:33:05 -04001835 /* Wait until the endpoint queue is completely empty */
Alan Stern455b25f2006-08-11 16:01:45 -04001836 while (!list_empty (&ep->urb_list)) {
Alan Stern809a58b2007-07-18 12:14:24 -04001837 spin_lock_irq(&hcd_urb_list_lock);
Alan Stern455b25f2006-08-11 16:01:45 -04001838
1839 /* The list may have changed while we acquired the spinlock */
1840 urb = NULL;
1841 if (!list_empty (&ep->urb_list)) {
1842 urb = list_entry (ep->urb_list.prev, struct urb,
1843 urb_list);
1844 usb_get_urb (urb);
1845 }
Alan Stern809a58b2007-07-18 12:14:24 -04001846 spin_unlock_irq(&hcd_urb_list_lock);
Alan Stern455b25f2006-08-11 16:01:45 -04001847
1848 if (urb) {
1849 usb_kill_urb (urb);
1850 usb_put_urb (urb);
1851 }
1852 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853}
1854
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001855/**
Randy Dunlap70445ae2009-12-13 10:17:16 -08001856 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1857 * the bus bandwidth
1858 * @udev: target &usb_device
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001859 * @new_config: new configuration to install
1860 * @cur_alt: the current alternate interface setting
1861 * @new_alt: alternate interface setting that is being installed
1862 *
1863 * To change configurations, pass in the new configuration in new_config,
1864 * and pass NULL for cur_alt and new_alt.
1865 *
1866 * To reset a device's configuration (put the device in the ADDRESSED state),
1867 * pass in NULL for new_config, cur_alt, and new_alt.
1868 *
1869 * To change alternate interface settings, pass in NULL for new_config,
1870 * pass in the current alternate interface setting in cur_alt,
1871 * and pass in the new alternate interface setting in new_alt.
1872 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001873 * Return: An error if the requested bandwidth change exceeds the
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001874 * bus bandwidth or host controller internal resources.
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001875 */
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001876int usb_hcd_alloc_bandwidth(struct usb_device *udev,
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001877 struct usb_host_config *new_config,
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001878 struct usb_host_interface *cur_alt,
1879 struct usb_host_interface *new_alt)
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001880{
1881 int num_intfs, i, j;
H Hartley Sweeten576a3622009-11-17 14:53:41 -08001882 struct usb_host_interface *alt = NULL;
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001883 int ret = 0;
1884 struct usb_hcd *hcd;
1885 struct usb_host_endpoint *ep;
1886
1887 hcd = bus_to_hcd(udev->bus);
1888 if (!hcd->driver->check_bandwidth)
1889 return 0;
1890
1891 /* Configuration is being removed - set configuration 0 */
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001892 if (!new_config && !cur_alt) {
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001893 for (i = 1; i < 16; ++i) {
1894 ep = udev->ep_out[i];
1895 if (ep)
1896 hcd->driver->drop_endpoint(hcd, udev, ep);
1897 ep = udev->ep_in[i];
1898 if (ep)
1899 hcd->driver->drop_endpoint(hcd, udev, ep);
1900 }
1901 hcd->driver->check_bandwidth(hcd, udev);
1902 return 0;
1903 }
1904 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1905 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1906 * of the bus. There will always be bandwidth for endpoint 0, so it's
1907 * ok to exclude it.
1908 */
1909 if (new_config) {
1910 num_intfs = new_config->desc.bNumInterfaces;
1911 /* Remove endpoints (except endpoint 0, which is always on the
1912 * schedule) from the old config from the schedule
1913 */
1914 for (i = 1; i < 16; ++i) {
1915 ep = udev->ep_out[i];
1916 if (ep) {
1917 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1918 if (ret < 0)
1919 goto reset;
1920 }
1921 ep = udev->ep_in[i];
1922 if (ep) {
1923 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1924 if (ret < 0)
1925 goto reset;
1926 }
1927 }
1928 for (i = 0; i < num_intfs; ++i) {
Sarah Sharpd837e212010-01-05 14:33:29 -08001929 struct usb_host_interface *first_alt;
1930 int iface_num;
1931
1932 first_alt = &new_config->intf_cache[i]->altsetting[0];
1933 iface_num = first_alt->desc.bInterfaceNumber;
Sarah Sharp91017f92009-12-03 09:44:34 -08001934 /* Set up endpoints for alternate interface setting 0 */
Sarah Sharpd837e212010-01-05 14:33:29 -08001935 alt = usb_find_alt_setting(new_config, iface_num, 0);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001936 if (!alt)
1937 /* No alt setting 0? Pick the first setting. */
Sarah Sharpd837e212010-01-05 14:33:29 -08001938 alt = first_alt;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001939
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001940 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1941 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1942 if (ret < 0)
1943 goto reset;
1944 }
1945 }
1946 }
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001947 if (cur_alt && new_alt) {
Sarah Sharp04a723e2010-01-06 10:16:51 -08001948 struct usb_interface *iface = usb_ifnum_to_if(udev,
1949 cur_alt->desc.bInterfaceNumber);
1950
Sarah Sharp8a9af4f2011-08-09 16:31:54 -07001951 if (!iface)
1952 return -EINVAL;
Sarah Sharp04a723e2010-01-06 10:16:51 -08001953 if (iface->resetting_device) {
1954 /*
1955 * The USB core just reset the device, so the xHCI host
1956 * and the device will think alt setting 0 is installed.
1957 * However, the USB core will pass in the alternate
1958 * setting installed before the reset as cur_alt. Dig
1959 * out the alternate setting 0 structure, or the first
1960 * alternate setting if a broken device doesn't have alt
1961 * setting 0.
1962 */
1963 cur_alt = usb_altnum_to_altsetting(iface, 0);
1964 if (!cur_alt)
1965 cur_alt = &iface->altsetting[0];
1966 }
1967
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001968 /* Drop all the endpoints in the current alt setting */
1969 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1970 ret = hcd->driver->drop_endpoint(hcd, udev,
1971 &cur_alt->endpoint[i]);
1972 if (ret < 0)
1973 goto reset;
1974 }
1975 /* Add all the endpoints in the new alt setting */
1976 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1977 ret = hcd->driver->add_endpoint(hcd, udev,
1978 &new_alt->endpoint[i]);
1979 if (ret < 0)
1980 goto reset;
1981 }
1982 }
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001983 ret = hcd->driver->check_bandwidth(hcd, udev);
1984reset:
1985 if (ret < 0)
1986 hcd->driver->reset_bandwidth(hcd, udev);
1987 return ret;
1988}
1989
Alan Stern95cf82f2007-09-10 11:33:05 -04001990/* Disables the endpoint: synchronizes with the hcd to make sure all
1991 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1992 * have been called previously. Use for set_configuration, set_interface,
1993 * driver removal, physical disconnect.
1994 *
1995 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1996 * type, maxpacket size, toggle, halt status, and scheduling.
1997 */
1998void usb_hcd_disable_endpoint(struct usb_device *udev,
1999 struct usb_host_endpoint *ep)
2000{
2001 struct usb_hcd *hcd;
2002
2003 might_sleep();
2004 hcd = bus_to_hcd(udev->bus);
2005 if (hcd->driver->endpoint_disable)
2006 hcd->driver->endpoint_disable(hcd, ep);
2007}
2008
David Vrabel3444b262009-04-08 17:36:28 +00002009/**
2010 * usb_hcd_reset_endpoint - reset host endpoint state
2011 * @udev: USB device.
2012 * @ep: the endpoint to reset.
2013 *
2014 * Resets any host endpoint state such as the toggle bit, sequence
2015 * number and current window.
2016 */
2017void usb_hcd_reset_endpoint(struct usb_device *udev,
2018 struct usb_host_endpoint *ep)
2019{
2020 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2021
2022 if (hcd->driver->endpoint_reset)
2023 hcd->driver->endpoint_reset(hcd, ep);
2024 else {
2025 int epnum = usb_endpoint_num(&ep->desc);
2026 int is_out = usb_endpoint_dir_out(&ep->desc);
2027 int is_control = usb_endpoint_xfer_control(&ep->desc);
2028
2029 usb_settoggle(udev, epnum, is_out, 0);
2030 if (is_control)
2031 usb_settoggle(udev, epnum, !is_out, 0);
2032 }
2033}
2034
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002035/**
2036 * usb_alloc_streams - allocate bulk endpoint stream IDs.
2037 * @interface: alternate setting that includes all endpoints.
2038 * @eps: array of endpoints that need streams.
2039 * @num_eps: number of endpoints in the array.
2040 * @num_streams: number of streams to allocate.
2041 * @mem_flags: flags hcd should use to allocate memory.
2042 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02002043 * Sets up a group of bulk endpoints to have @num_streams stream IDs available.
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002044 * Drivers may queue multiple transfers to different stream IDs, which may
2045 * complete in a different order than they were queued.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002046 *
2047 * Return: On success, the number of allocated streams. On failure, a negative
2048 * error code.
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002049 */
2050int usb_alloc_streams(struct usb_interface *interface,
2051 struct usb_host_endpoint **eps, unsigned int num_eps,
2052 unsigned int num_streams, gfp_t mem_flags)
2053{
2054 struct usb_hcd *hcd;
2055 struct usb_device *dev;
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002056 int i, ret;
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002057
2058 dev = interface_to_usbdev(interface);
2059 hcd = bus_to_hcd(dev->bus);
2060 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
2061 return -EINVAL;
2062 if (dev->speed != USB_SPEED_SUPER)
2063 return -EINVAL;
2064
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002065 for (i = 0; i < num_eps; i++) {
2066 /* Streams only apply to bulk endpoints. */
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002067 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
2068 return -EINVAL;
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002069 /* Re-alloc is not allowed */
2070 if (eps[i]->streams)
2071 return -EINVAL;
2072 }
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002073
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002074 ret = hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002075 num_streams, mem_flags);
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002076 if (ret < 0)
2077 return ret;
2078
2079 for (i = 0; i < num_eps; i++)
2080 eps[i]->streams = ret;
2081
2082 return ret;
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002083}
2084EXPORT_SYMBOL_GPL(usb_alloc_streams);
2085
2086/**
2087 * usb_free_streams - free bulk endpoint stream IDs.
2088 * @interface: alternate setting that includes all endpoints.
2089 * @eps: array of endpoints to remove streams from.
2090 * @num_eps: number of endpoints in the array.
2091 * @mem_flags: flags hcd should use to allocate memory.
2092 *
2093 * Reverts a group of bulk endpoints back to not using stream IDs.
2094 * Can fail if we are given bad arguments, or HCD is broken.
Hans de Goede6c74dad2013-08-30 14:03:59 +02002095 *
Hans de Goede12d4bbc2013-10-09 17:19:23 +02002096 * Return: 0 on success. On failure, a negative error code.
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002097 */
Hans de Goede6c74dad2013-08-30 14:03:59 +02002098int usb_free_streams(struct usb_interface *interface,
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002099 struct usb_host_endpoint **eps, unsigned int num_eps,
2100 gfp_t mem_flags)
2101{
2102 struct usb_hcd *hcd;
2103 struct usb_device *dev;
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002104 int i, ret;
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002105
2106 dev = interface_to_usbdev(interface);
2107 hcd = bus_to_hcd(dev->bus);
2108 if (dev->speed != USB_SPEED_SUPER)
Hans de Goede6c74dad2013-08-30 14:03:59 +02002109 return -EINVAL;
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002110
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002111 /* Double-free is not allowed */
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002112 for (i = 0; i < num_eps; i++)
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002113 if (!eps[i] || !eps[i]->streams)
Hans de Goede6c74dad2013-08-30 14:03:59 +02002114 return -EINVAL;
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002115
Hans de Goede8d4f70b2013-10-09 17:19:25 +02002116 ret = hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
2117 if (ret < 0)
2118 return ret;
2119
2120 for (i = 0; i < num_eps; i++)
2121 eps[i]->streams = 0;
2122
2123 return ret;
Sarah Sharpeab1caf2010-04-05 10:55:58 -07002124}
2125EXPORT_SYMBOL_GPL(usb_free_streams);
2126
Alan Sterncde217a2008-10-21 15:28:46 -04002127/* Protect against drivers that try to unlink URBs after the device
2128 * is gone, by waiting until all unlinks for @udev are finished.
2129 * Since we don't currently track URBs by device, simply wait until
2130 * nothing is running in the locked region of usb_hcd_unlink_urb().
2131 */
2132void usb_hcd_synchronize_unlinks(struct usb_device *udev)
2133{
2134 spin_lock_irq(&hcd_urb_unlink_lock);
2135 spin_unlock_irq(&hcd_urb_unlink_lock);
2136}
2137
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138/*-------------------------------------------------------------------------*/
2139
Alan Stern32aca562007-07-18 12:08:02 -04002140/* called in any context */
2141int usb_hcd_get_frame_number (struct usb_device *udev)
2142{
2143 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2144
Alan Stern9b375962011-03-07 11:11:52 -05002145 if (!HCD_RH_RUNNING(hcd))
Alan Stern32aca562007-07-18 12:08:02 -04002146 return -ESHUTDOWN;
2147 return hcd->driver->get_frame_number (hcd);
2148}
2149
2150/*-------------------------------------------------------------------------*/
2151
David Brownell92936772005-09-22 22:32:11 -07002152#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
Alan Stern65bfd292008-11-25 16:39:18 -05002154int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155{
Alan Stern686314c2007-05-30 15:34:36 -04002156 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
2157 int status;
2158 int old_state = hcd->state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159
Alan Stern30b1a7a2011-09-27 21:54:22 +02002160 dev_dbg(&rhdev->dev, "bus %ssuspend, wakeup %d\n",
2161 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2162 rhdev->do_remote_wakeup);
Alan Stern9b375962011-03-07 11:11:52 -05002163 if (HCD_DEAD(hcd)) {
2164 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "suspend");
2165 return 0;
2166 }
2167
Alan Stern686314c2007-05-30 15:34:36 -04002168 if (!hcd->driver->bus_suspend) {
2169 status = -ENOENT;
2170 } else {
Alan Stern9b375962011-03-07 11:11:52 -05002171 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
Alan Stern686314c2007-05-30 15:34:36 -04002172 hcd->state = HC_STATE_QUIESCING;
2173 status = hcd->driver->bus_suspend(hcd);
2174 }
2175 if (status == 0) {
2176 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
David Brownell92936772005-09-22 22:32:11 -07002177 hcd->state = HC_STATE_SUSPENDED;
Alan Stern879d38e2012-04-03 15:24:18 -04002178
2179 /* Did we race with a root-hub wakeup event? */
2180 if (rhdev->do_remote_wakeup) {
2181 char buffer[6];
2182
2183 status = hcd->driver->hub_status_data(hcd, buffer);
2184 if (status != 0) {
2185 dev_dbg(&rhdev->dev, "suspend raced with wakeup event\n");
2186 hcd_bus_resume(rhdev, PMSG_AUTO_RESUME);
2187 status = -EBUSY;
2188 }
2189 }
Alan Stern686314c2007-05-30 15:34:36 -04002190 } else {
Alan Stern9b375962011-03-07 11:11:52 -05002191 spin_lock_irq(&hcd_root_hub_lock);
2192 if (!HCD_DEAD(hcd)) {
2193 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2194 hcd->state = old_state;
2195 }
2196 spin_unlock_irq(&hcd_root_hub_lock);
Alan Stern686314c2007-05-30 15:34:36 -04002197 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
David Brownell92936772005-09-22 22:32:11 -07002198 "suspend", status);
Alan Stern686314c2007-05-30 15:34:36 -04002199 }
David Brownell92936772005-09-22 22:32:11 -07002200 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201}
2202
Alan Stern65bfd292008-11-25 16:39:18 -05002203int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204{
Alan Stern686314c2007-05-30 15:34:36 -04002205 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
2206 int status;
Alan Sterncfa59da2007-06-21 16:25:35 -04002207 int old_state = hcd->state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208
Alan Stern30b1a7a2011-09-27 21:54:22 +02002209 dev_dbg(&rhdev->dev, "usb %sresume\n",
2210 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
Alan Stern9b375962011-03-07 11:11:52 -05002211 if (HCD_DEAD(hcd)) {
2212 dev_dbg(&rhdev->dev, "skipped %s of dead bus\n", "resume");
2213 return 0;
2214 }
Alan Stern0c0382e2005-10-13 17:08:02 -04002215 if (!hcd->driver->bus_resume)
David Brownell92936772005-09-22 22:32:11 -07002216 return -ENOENT;
Alan Stern9b375962011-03-07 11:11:52 -05002217 if (HCD_RH_RUNNING(hcd))
David Brownell979d5192005-09-22 22:32:24 -07002218 return 0;
Alan Stern686314c2007-05-30 15:34:36 -04002219
David Brownell92936772005-09-22 22:32:11 -07002220 hcd->state = HC_STATE_RESUMING;
Alan Stern686314c2007-05-30 15:34:36 -04002221 status = hcd->driver->bus_resume(hcd);
Alan Sternbf3d7d42011-02-02 13:59:33 -05002222 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
Alan Stern686314c2007-05-30 15:34:36 -04002223 if (status == 0) {
Alan Sternbfd1e912012-10-19 11:03:39 -04002224 struct usb_device *udev;
2225 int port1;
2226
Alan Stern9b375962011-03-07 11:11:52 -05002227 spin_lock_irq(&hcd_root_hub_lock);
2228 if (!HCD_DEAD(hcd)) {
2229 usb_set_device_state(rhdev, rhdev->actconfig
2230 ? USB_STATE_CONFIGURED
2231 : USB_STATE_ADDRESS);
2232 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2233 hcd->state = HC_STATE_RUNNING;
2234 }
2235 spin_unlock_irq(&hcd_root_hub_lock);
Alan Sternbfd1e912012-10-19 11:03:39 -04002236
2237 /*
2238 * Check whether any of the enabled ports on the root hub are
2239 * unsuspended. If they are then a TRSMRCY delay is needed
2240 * (this is what the USB-2 spec calls a "global resume").
2241 * Otherwise we can skip the delay.
2242 */
2243 usb_hub_for_each_child(rhdev, port1, udev) {
2244 if (udev->state != USB_STATE_NOTATTACHED &&
2245 !udev->port_is_suspended) {
2246 usleep_range(10000, 11000); /* TRSMRCY */
2247 break;
2248 }
2249 }
Alan Stern686314c2007-05-30 15:34:36 -04002250 } else {
Alan Sterncfa59da2007-06-21 16:25:35 -04002251 hcd->state = old_state;
Alan Stern686314c2007-05-30 15:34:36 -04002252 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
David Brownell92936772005-09-22 22:32:11 -07002253 "resume", status);
Alan Sterncfa59da2007-06-21 16:25:35 -04002254 if (status != -ESHUTDOWN)
2255 usb_hc_died(hcd);
David Brownell92936772005-09-22 22:32:11 -07002256 }
2257 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258}
2259
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002260#endif /* CONFIG_PM */
2261
Alan Stern84ebc102013-03-27 16:14:46 -04002262#ifdef CONFIG_PM_RUNTIME
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002263
Alan Stern6b157c92007-03-13 16:37:30 -04002264/* Workqueue routine for root-hub remote wakeup */
2265static void hcd_resume_work(struct work_struct *work)
2266{
2267 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
2268 struct usb_device *udev = hcd->self.root_hub;
2269
2270 usb_lock_device(udev);
Alan Stern0534d462010-01-08 12:56:30 -05002271 usb_remote_wakeup(udev);
Alan Stern6b157c92007-03-13 16:37:30 -04002272 usb_unlock_device(udev);
2273}
2274
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275/**
Matthias Beyer14557352013-10-05 18:02:07 +02002276 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 * @hcd: host controller for this root hub
2278 *
2279 * The USB host controller calls this function when its root hub is
2280 * suspended (with the remote wakeup feature enabled) and a remote
Alan Stern6b157c92007-03-13 16:37:30 -04002281 * wakeup request is received. The routine submits a workqueue request
2282 * to resume the root hub (that is, manage its downstream ports again).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 */
2284void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2285{
2286 unsigned long flags;
2287
2288 spin_lock_irqsave (&hcd_root_hub_lock, flags);
Alan Sternff2f0782010-06-25 14:02:35 -04002289 if (hcd->rh_registered) {
2290 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002291 queue_work(pm_wq, &hcd->wakeup_work);
Alan Sternff2f0782010-06-25 14:02:35 -04002292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2294}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2296
Alan Stern84ebc102013-03-27 16:14:46 -04002297#endif /* CONFIG_PM_RUNTIME */
David Brownell92936772005-09-22 22:32:11 -07002298
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299/*-------------------------------------------------------------------------*/
2300
2301#ifdef CONFIG_USB_OTG
2302
2303/**
2304 * usb_bus_start_enum - start immediate enumeration (for OTG)
2305 * @bus: the bus (must use hcd framework)
2306 * @port_num: 1-based number of port; usually bus->otg_port
2307 * Context: in_interrupt()
2308 *
2309 * Starts enumeration, with an immediate reset followed later by
2310 * khubd identifying and possibly configuring the device.
2311 * This is needed by OTG controller drivers, where it helps meet
2312 * HNP protocol timing requirements for starting a port reset.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002313 *
2314 * Return: 0 if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 */
2316int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2317{
2318 struct usb_hcd *hcd;
2319 int status = -EOPNOTSUPP;
2320
2321 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2322 * boards with root hubs hooked up to internal devices (instead of
2323 * just the OTG port) may need more attention to resetting...
2324 */
2325 hcd = container_of (bus, struct usb_hcd, self);
2326 if (port_num && hcd->driver->start_port_reset)
2327 status = hcd->driver->start_port_reset(hcd, port_num);
2328
2329 /* run khubd shortly after (first) root port reset finishes;
2330 * it may issue others, until at least 50 msecs have passed.
2331 */
2332 if (status == 0)
2333 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2334 return status;
2335}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002336EXPORT_SYMBOL_GPL(usb_bus_start_enum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
2338#endif
2339
2340/*-------------------------------------------------------------------------*/
2341
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2344 * @irq: the IRQ being raised
2345 * @__hcd: pointer to the HCD whose IRQ is being signaled
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 *
2347 * If the controller isn't HALTed, calls the driver's irq handler.
2348 * Checks whether the controller is now dead.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002349 *
2350 * Return: %IRQ_HANDLED if the IRQ was handled. %IRQ_NONE otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 */
David Howells7d12e782006-10-05 14:55:46 +01002352irqreturn_t usb_hcd_irq (int irq, void *__hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353{
2354 struct usb_hcd *hcd = __hcd;
Stefan Beckerde854222008-07-01 19:19:22 +03002355 irqreturn_t rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356
Alan Stern968b8222011-11-03 12:03:38 -04002357 if (unlikely(HCD_DEAD(hcd) || !HCD_HW_ACCESSIBLE(hcd)))
Stefan Beckerde854222008-07-01 19:19:22 +03002358 rc = IRQ_NONE;
Alan Stern968b8222011-11-03 12:03:38 -04002359 else if (hcd->driver->irq(hcd) == IRQ_NONE)
Stefan Beckerde854222008-07-01 19:19:22 +03002360 rc = IRQ_NONE;
Alan Stern968b8222011-11-03 12:03:38 -04002361 else
Stefan Beckerde854222008-07-01 19:19:22 +03002362 rc = IRQ_HANDLED;
Stefan Beckerde854222008-07-01 19:19:22 +03002363
Stefan Beckerde854222008-07-01 19:19:22 +03002364 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365}
Dong Nguyen43b86af2010-07-21 16:56:08 -07002366EXPORT_SYMBOL_GPL(usb_hcd_irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367
2368/*-------------------------------------------------------------------------*/
2369
2370/**
2371 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2372 * @hcd: pointer to the HCD representing the controller
2373 *
2374 * This is called by bus glue to report a USB host controller that died
2375 * while operations may still have been pending. It's called automatically
Sarah Sharpc5635432010-10-28 15:40:26 -07002376 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2377 *
2378 * Only call this function with the primary HCD.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 */
2380void usb_hc_died (struct usb_hcd *hcd)
2381{
2382 unsigned long flags;
2383
2384 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2385
2386 spin_lock_irqsave (&hcd_root_hub_lock, flags);
Alan Stern9b375962011-03-07 11:11:52 -05002387 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2388 set_bit(HCD_FLAG_DEAD, &hcd->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 if (hcd->rh_registered) {
Alan Stern541c7d42010-06-22 16:39:10 -04002390 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391
2392 /* make khubd clean up old urbs and devices */
2393 usb_set_device_state (hcd->self.root_hub,
2394 USB_STATE_NOTATTACHED);
2395 usb_kick_khubd (hcd->self.root_hub);
2396 }
Sarah Sharpc5635432010-10-28 15:40:26 -07002397 if (usb_hcd_is_primary_hcd(hcd) && hcd->shared_hcd) {
2398 hcd = hcd->shared_hcd;
2399 if (hcd->rh_registered) {
2400 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
2401
2402 /* make khubd clean up old urbs and devices */
2403 usb_set_device_state(hcd->self.root_hub,
2404 USB_STATE_NOTATTACHED);
2405 usb_kick_khubd(hcd->self.root_hub);
2406 }
2407 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
Sarah Sharpc5635432010-10-28 15:40:26 -07002409 /* Make sure that the other roothub is also deallocated. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410}
2411EXPORT_SYMBOL_GPL (usb_hc_died);
2412
2413/*-------------------------------------------------------------------------*/
2414
Ming Lei94dfd7e2013-07-03 22:53:07 +08002415static void init_giveback_urb_bh(struct giveback_urb_bh *bh)
2416{
2417
2418 spin_lock_init(&bh->lock);
2419 INIT_LIST_HEAD(&bh->head);
2420 tasklet_init(&bh->bh, usb_giveback_urb_bh, (unsigned long)bh);
2421}
2422
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423/**
Sarah Sharpc5635432010-10-28 15:40:26 -07002424 * usb_create_shared_hcd - create and initialize an HCD structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 * @driver: HC driver that will use this hcd
2426 * @dev: device for this HC, stored in hcd->self.controller
2427 * @bus_name: value to store in hcd->self.bus_name
Sarah Sharpc5635432010-10-28 15:40:26 -07002428 * @primary_hcd: a pointer to the usb_hcd structure that is sharing the
2429 * PCI device. Only allocate certain resources for the primary HCD
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 * Context: !in_interrupt()
2431 *
2432 * Allocate a struct usb_hcd, with extra space at the end for the
2433 * HC driver's private data. Initialize the generic members of the
2434 * hcd structure.
2435 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02002436 * Return: On success, a pointer to the created and initialized HCD structure.
2437 * On failure (e.g. if memory is unavailable), %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 */
Sarah Sharpc5635432010-10-28 15:40:26 -07002439struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
2440 struct device *dev, const char *bus_name,
2441 struct usb_hcd *primary_hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442{
2443 struct usb_hcd *hcd;
2444
Pekka Enberg7b842b62005-09-06 15:18:34 -07002445 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 if (!hcd) {
2447 dev_dbg (dev, "hcd alloc failed\n");
2448 return NULL;
2449 }
Sarah Sharpc5635432010-10-28 15:40:26 -07002450 if (primary_hcd == NULL) {
2451 hcd->bandwidth_mutex = kmalloc(sizeof(*hcd->bandwidth_mutex),
2452 GFP_KERNEL);
2453 if (!hcd->bandwidth_mutex) {
2454 kfree(hcd);
2455 dev_dbg(dev, "hcd bandwidth mutex alloc failed\n");
2456 return NULL;
2457 }
2458 mutex_init(hcd->bandwidth_mutex);
2459 dev_set_drvdata(dev, hcd);
2460 } else {
Dan Williamsd8521af2014-05-20 18:08:28 -07002461 mutex_lock(&usb_port_peer_mutex);
Sarah Sharpc5635432010-10-28 15:40:26 -07002462 hcd->bandwidth_mutex = primary_hcd->bandwidth_mutex;
2463 hcd->primary_hcd = primary_hcd;
2464 primary_hcd->primary_hcd = primary_hcd;
2465 hcd->shared_hcd = primary_hcd;
2466 primary_hcd->shared_hcd = hcd;
Dan Williamsd8521af2014-05-20 18:08:28 -07002467 mutex_unlock(&usb_port_peer_mutex);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07002468 }
Sarah Sharpd673bfc2010-10-15 08:55:24 -07002469
Alan Stern17200582006-08-30 11:32:52 -04002470 kref_init(&hcd->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471
2472 usb_bus_init(&hcd->self);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 hcd->self.controller = dev;
2474 hcd->self.bus_name = bus_name;
Alan Sterndd990f12006-08-30 11:29:56 -04002475 hcd->self.uses_dma = (dev->dma_mask != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476
2477 init_timer(&hcd->rh_timer);
Alan Sternd5926ae72005-04-21 15:56:37 -04002478 hcd->rh_timer.function = rh_timer_func;
2479 hcd->rh_timer.data = (unsigned long) hcd;
Alan Stern84ebc102013-03-27 16:14:46 -04002480#ifdef CONFIG_PM_RUNTIME
Alan Stern6b157c92007-03-13 16:37:30 -04002481 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2482#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483
2484 hcd->driver = driver;
Sarah Sharp83de4b22010-12-02 14:45:18 -08002485 hcd->speed = driver->flags & HCD_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2487 "USB Host Controller";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 return hcd;
2489}
Sarah Sharpc5635432010-10-28 15:40:26 -07002490EXPORT_SYMBOL_GPL(usb_create_shared_hcd);
2491
2492/**
2493 * usb_create_hcd - create and initialize an HCD structure
2494 * @driver: HC driver that will use this hcd
2495 * @dev: device for this HC, stored in hcd->self.controller
2496 * @bus_name: value to store in hcd->self.bus_name
2497 * Context: !in_interrupt()
2498 *
2499 * Allocate a struct usb_hcd, with extra space at the end for the
2500 * HC driver's private data. Initialize the generic members of the
2501 * hcd structure.
2502 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02002503 * Return: On success, a pointer to the created and initialized HCD
2504 * structure. On failure (e.g. if memory is unavailable), %NULL.
Sarah Sharpc5635432010-10-28 15:40:26 -07002505 */
2506struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
2507 struct device *dev, const char *bus_name)
2508{
2509 return usb_create_shared_hcd(driver, dev, bus_name, NULL);
2510}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002511EXPORT_SYMBOL_GPL(usb_create_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512
Sarah Sharpc5635432010-10-28 15:40:26 -07002513/*
2514 * Roothubs that share one PCI device must also share the bandwidth mutex.
2515 * Don't deallocate the bandwidth_mutex until the last shared usb_hcd is
2516 * deallocated.
2517 *
2518 * Make sure to only deallocate the bandwidth_mutex when the primary HCD is
Dan Williamsd8521af2014-05-20 18:08:28 -07002519 * freed. When hcd_release() is called for either hcd in a peer set
2520 * invalidate the peer's ->shared_hcd and ->primary_hcd pointers to
2521 * block new peering attempts
Sarah Sharpc5635432010-10-28 15:40:26 -07002522 */
Dan Williamsd8521af2014-05-20 18:08:28 -07002523static void hcd_release(struct kref *kref)
Alan Stern17200582006-08-30 11:32:52 -04002524{
2525 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2526
Dan Williamsd8521af2014-05-20 18:08:28 -07002527 mutex_lock(&usb_port_peer_mutex);
Sarah Sharpc5635432010-10-28 15:40:26 -07002528 if (usb_hcd_is_primary_hcd(hcd))
2529 kfree(hcd->bandwidth_mutex);
Dan Williamsd8521af2014-05-20 18:08:28 -07002530 if (hcd->shared_hcd) {
2531 struct usb_hcd *peer = hcd->shared_hcd;
2532
2533 peer->shared_hcd = NULL;
2534 if (peer->primary_hcd == hcd)
2535 peer->primary_hcd = NULL;
2536 }
2537 mutex_unlock(&usb_port_peer_mutex);
Alan Stern17200582006-08-30 11:32:52 -04002538 kfree(hcd);
2539}
2540
2541struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2542{
2543 if (hcd)
2544 kref_get (&hcd->kref);
2545 return hcd;
2546}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002547EXPORT_SYMBOL_GPL(usb_get_hcd);
Alan Stern17200582006-08-30 11:32:52 -04002548
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549void usb_put_hcd (struct usb_hcd *hcd)
2550{
Alan Stern17200582006-08-30 11:32:52 -04002551 if (hcd)
2552 kref_put (&hcd->kref, hcd_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002554EXPORT_SYMBOL_GPL(usb_put_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555
Sarah Sharpc5635432010-10-28 15:40:26 -07002556int usb_hcd_is_primary_hcd(struct usb_hcd *hcd)
2557{
2558 if (!hcd->primary_hcd)
2559 return 1;
2560 return hcd == hcd->primary_hcd;
2561}
2562EXPORT_SYMBOL_GPL(usb_hcd_is_primary_hcd);
2563
Lan Tianyu3f5eb142013-03-19 16:48:12 +08002564int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1)
2565{
2566 if (!hcd->driver->find_raw_port_number)
2567 return port1;
2568
2569 return hcd->driver->find_raw_port_number(hcd, port1);
2570}
2571
Sarah Sharp23e0d102010-10-21 11:14:54 -07002572static int usb_hcd_request_irqs(struct usb_hcd *hcd,
2573 unsigned int irqnum, unsigned long irqflags)
2574{
2575 int retval;
2576
2577 if (hcd->driver->irq) {
Greg Kroah-Hartmane592c5d2012-11-13 10:52:52 -08002578
Sarah Sharp23e0d102010-10-21 11:14:54 -07002579 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2580 hcd->driver->description, hcd->self.busnum);
2581 retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2582 hcd->irq_descr, hcd);
2583 if (retval != 0) {
2584 dev_err(hcd->self.controller,
2585 "request interrupt %d failed\n",
2586 irqnum);
2587 return retval;
2588 }
2589 hcd->irq = irqnum;
2590 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
2591 (hcd->driver->flags & HCD_MEMORY) ?
2592 "io mem" : "io base",
2593 (unsigned long long)hcd->rsrc_start);
2594 } else {
Felipe Balbicd704692012-02-29 16:46:23 +02002595 hcd->irq = 0;
Sarah Sharp23e0d102010-10-21 11:14:54 -07002596 if (hcd->rsrc_start)
2597 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2598 (hcd->driver->flags & HCD_MEMORY) ?
2599 "io mem" : "io base",
2600 (unsigned long long)hcd->rsrc_start);
2601 }
2602 return 0;
2603}
2604
Dan Williamsd8521af2014-05-20 18:08:28 -07002605/*
2606 * Before we free this root hub, flush in-flight peering attempts
2607 * and disable peer lookups
2608 */
2609static void usb_put_invalidate_rhdev(struct usb_hcd *hcd)
2610{
2611 struct usb_device *rhdev;
2612
2613 mutex_lock(&usb_port_peer_mutex);
2614 rhdev = hcd->self.root_hub;
2615 hcd->self.root_hub = NULL;
2616 mutex_unlock(&usb_port_peer_mutex);
2617 usb_put_dev(rhdev);
2618}
2619
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620/**
2621 * usb_add_hcd - finish generic HCD structure initialization and register
2622 * @hcd: the usb_hcd structure to initialize
2623 * @irqnum: Interrupt line to allocate
2624 * @irqflags: Interrupt type flags
2625 *
2626 * Finish the remaining parts of generic HCD initialization: allocate the
2627 * buffers of consistent memory, register the bus, request the IRQ line,
2628 * and call the driver's reset() and start() routines.
2629 */
2630int usb_add_hcd(struct usb_hcd *hcd,
2631 unsigned int irqnum, unsigned long irqflags)
2632{
Alan Stern8ec8d202005-04-25 11:25:17 -04002633 int retval;
2634 struct usb_device *rhdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Valentine Barshak1ae57992013-12-04 01:42:22 +04002636 if (IS_ENABLED(CONFIG_USB_PHY) && !hcd->phy) {
2637 struct usb_phy *phy = usb_get_phy_dev(hcd->self.controller, 0);
2638
2639 if (IS_ERR(phy)) {
2640 retval = PTR_ERR(phy);
2641 if (retval == -EPROBE_DEFER)
2642 return retval;
2643 } else {
2644 retval = usb_phy_init(phy);
2645 if (retval) {
2646 usb_put_phy(phy);
2647 return retval;
2648 }
2649 hcd->phy = phy;
2650 hcd->remove_phy = 1;
2651 }
2652 }
2653
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2655
Carl-Daniel Hailfingerc4fc2342011-05-31 21:31:08 +02002656 /* Keep old behaviour if authorized_default is not in [0, 1]. */
2657 if (authorized_default < 0 || authorized_default > 1)
Matthias Beyer14557352013-10-05 18:02:07 +02002658 hcd->authorized_default = hcd->wireless ? 0 : 1;
Carl-Daniel Hailfingerc4fc2342011-05-31 21:31:08 +02002659 else
2660 hcd->authorized_default = authorized_default;
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +11002661 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2662
David Brownellb1e8f0a2006-01-23 15:25:40 -08002663 /* HC is in reset state, but accessible. Now do the one-time init,
2664 * bottom up so that hcds can customize the root hubs before khubd
2665 * starts talking to them. (Note, bus id is assigned early too.)
2666 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 if ((retval = hcd_buffer_create(hcd)) != 0) {
2668 dev_dbg(hcd->self.controller, "pool alloc failed\n");
Valentine Barshak103e1272013-12-04 01:42:21 +04002669 goto err_remove_phy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670 }
2671
2672 if ((retval = usb_register_bus(&hcd->self)) < 0)
Alan Stern8ec8d202005-04-25 11:25:17 -04002673 goto err_register_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674
David Brownellb1e8f0a2006-01-23 15:25:40 -08002675 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
2676 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2677 retval = -ENOMEM;
2678 goto err_allocate_root_hub;
2679 }
Dan Williamsd8521af2014-05-20 18:08:28 -07002680 mutex_lock(&usb_port_peer_mutex);
Alan Stern6d88e672010-06-09 17:34:17 -04002681 hcd->self.root_hub = rhdev;
Dan Williamsd8521af2014-05-20 18:08:28 -07002682 mutex_unlock(&usb_port_peer_mutex);
Sarah Sharp6b403b02009-04-27 19:54:10 -07002683
Sarah Sharp83de4b22010-12-02 14:45:18 -08002684 switch (hcd->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -07002685 case HCD_USB11:
2686 rhdev->speed = USB_SPEED_FULL;
2687 break;
2688 case HCD_USB2:
2689 rhdev->speed = USB_SPEED_HIGH;
2690 break;
Thomas Pugliese1a81f882013-05-31 14:16:13 -05002691 case HCD_USB25:
2692 rhdev->speed = USB_SPEED_WIRELESS;
2693 break;
Sarah Sharp6b403b02009-04-27 19:54:10 -07002694 case HCD_USB3:
2695 rhdev->speed = USB_SPEED_SUPER;
2696 break;
2697 default:
Sebastian Andrzej Siewior1d15ee42011-04-14 11:22:32 +02002698 retval = -EINVAL;
Alan Stern96e077a2010-06-09 17:34:05 -04002699 goto err_set_rh_speed;
Sarah Sharp6b403b02009-04-27 19:54:10 -07002700 }
David Brownellb1e8f0a2006-01-23 15:25:40 -08002701
David Brownelldb4cefa2006-05-01 22:07:13 -07002702 /* wakeup flag init defaults to "everything works" for root hubs,
2703 * but drivers can override it in reset() if needed, along with
2704 * recording the overall controller's system wakeup capability.
2705 */
Alan Sterna6eeeb92011-09-26 11:23:38 -04002706 device_set_wakeup_capable(&rhdev->dev, 1);
David Brownelldb4cefa2006-05-01 22:07:13 -07002707
Alan Stern9b375962011-03-07 11:11:52 -05002708 /* HCD_FLAG_RH_RUNNING doesn't matter until the root hub is
2709 * registered. But since the controller can die at any time,
2710 * let's initialize the flag before touching the hardware.
2711 */
2712 set_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
2713
David Brownellb1e8f0a2006-01-23 15:25:40 -08002714 /* "reset" is misnamed; its role is now one-time init. the controller
2715 * should already have been reset (and boot firmware kicked off etc).
2716 */
2717 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
Mark Brownc10750b2013-08-07 22:32:40 +01002718 dev_err(hcd->self.controller, "can't setup: %d\n", retval);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002719 goto err_hcd_driver_setup;
2720 }
Alan Stern6d88e672010-06-09 17:34:17 -04002721 hcd->rh_pollable = 1;
David Brownellb1e8f0a2006-01-23 15:25:40 -08002722
David Brownellfb669cc2006-01-24 08:40:27 -08002723 /* NOTE: root hub and controller capabilities may not be the same */
2724 if (device_can_wakeup(hcd->self.controller)
2725 && device_can_wakeup(&hcd->self.root_hub->dev))
David Brownellb1e8f0a2006-01-23 15:25:40 -08002726 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
David Brownellb1e8f0a2006-01-23 15:25:40 -08002727
Ming Lei94dfd7e2013-07-03 22:53:07 +08002728 /* initialize tasklets */
2729 init_giveback_urb_bh(&hcd->high_prio_bh);
2730 init_giveback_urb_bh(&hcd->low_prio_bh);
2731
Sarah Sharp68d07f62012-02-13 16:25:57 -08002732 /* enable irqs just before we start the controller,
2733 * if the BIOS provides legacy PCI irqs.
2734 */
2735 if (usb_hcd_is_primary_hcd(hcd) && irqnum) {
Sarah Sharpc5635432010-10-28 15:40:26 -07002736 retval = usb_hcd_request_irqs(hcd, irqnum, irqflags);
2737 if (retval)
2738 goto err_request_irq;
2739 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740
Sarah Sharp48140302011-03-11 13:46:17 -08002741 hcd->state = HC_STATE_RUNNING;
Sarah Sharpabc4f9b2010-12-01 09:22:05 -08002742 retval = hcd->driver->start(hcd);
2743 if (retval < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744 dev_err(hcd->self.controller, "startup error %d\n", retval);
Alan Stern8ec8d202005-04-25 11:25:17 -04002745 goto err_hcd_driver_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746 }
2747
David Brownellb1e8f0a2006-01-23 15:25:40 -08002748 /* starting here, usbcore will pay attention to this root hub */
David Brownellb1e8f0a2006-01-23 15:25:40 -08002749 if ((retval = register_root_hub(hcd)) != 0)
Alan Stern8ec8d202005-04-25 11:25:17 -04002750 goto err_register_root_hub;
2751
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002752 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2753 if (retval < 0) {
2754 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2755 retval);
2756 goto error_create_attr_group;
2757 }
Alan Stern541c7d42010-06-22 16:39:10 -04002758 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
Alan Sternd5926ae72005-04-21 15:56:37 -04002759 usb_hcd_poll_rh_status(hcd);
Alan Sterna6eeeb92011-09-26 11:23:38 -04002760
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 return retval;
2762
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002763error_create_attr_group:
Alan Stern9b375962011-03-07 11:11:52 -05002764 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
Alan Stern96e077a2010-06-09 17:34:05 -04002765 if (HC_IS_RUNNING(hcd->state))
2766 hcd->state = HC_STATE_QUIESCING;
2767 spin_lock_irq(&hcd_root_hub_lock);
2768 hcd->rh_registered = 0;
2769 spin_unlock_irq(&hcd_root_hub_lock);
2770
Alan Stern84ebc102013-03-27 16:14:46 -04002771#ifdef CONFIG_PM_RUNTIME
Alan Stern96e077a2010-06-09 17:34:05 -04002772 cancel_work_sync(&hcd->wakeup_work);
2773#endif
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002774 mutex_lock(&usb_bus_list_lock);
Alan Stern6d88e672010-06-09 17:34:17 -04002775 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002776 mutex_unlock(&usb_bus_list_lock);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002777err_register_root_hub:
Alan Stern6d88e672010-06-09 17:34:17 -04002778 hcd->rh_pollable = 0;
Alan Stern541c7d42010-06-22 16:39:10 -04002779 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern6d88e672010-06-09 17:34:17 -04002780 del_timer_sync(&hcd->rh_timer);
Alan Stern8ec8d202005-04-25 11:25:17 -04002781 hcd->driver->stop(hcd);
Alan Stern96e077a2010-06-09 17:34:05 -04002782 hcd->state = HC_STATE_HALT;
Alan Stern541c7d42010-06-22 16:39:10 -04002783 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern96e077a2010-06-09 17:34:05 -04002784 del_timer_sync(&hcd->rh_timer);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002785err_hcd_driver_start:
Felipe Balbicd704692012-02-29 16:46:23 +02002786 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 free_irq(irqnum, hcd);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002788err_request_irq:
2789err_hcd_driver_setup:
Alan Stern96e077a2010-06-09 17:34:05 -04002790err_set_rh_speed:
Dan Williamsd8521af2014-05-20 18:08:28 -07002791 usb_put_invalidate_rhdev(hcd);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002792err_allocate_root_hub:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 usb_deregister_bus(&hcd->self);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002794err_register_bus:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 hcd_buffer_destroy(hcd);
Valentine Barshak103e1272013-12-04 01:42:21 +04002796err_remove_phy:
2797 if (hcd->remove_phy && hcd->phy) {
2798 usb_phy_shutdown(hcd->phy);
2799 usb_put_phy(hcd->phy);
2800 hcd->phy = NULL;
2801 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 return retval;
Matthias Beyer14557352013-10-05 18:02:07 +02002803}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002804EXPORT_SYMBOL_GPL(usb_add_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805
2806/**
2807 * usb_remove_hcd - shutdown processing for generic HCDs
2808 * @hcd: the usb_hcd structure to remove
2809 * Context: !in_interrupt()
2810 *
2811 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2812 * invoking the HCD's stop() method.
2813 */
2814void usb_remove_hcd(struct usb_hcd *hcd)
2815{
Alan Stern6d88e672010-06-09 17:34:17 -04002816 struct usb_device *rhdev = hcd->self.root_hub;
2817
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2819
Alan Stern6d88e672010-06-09 17:34:17 -04002820 usb_get_dev(rhdev);
2821 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
Alan Stern96e077a2010-06-09 17:34:05 -04002822
Alan Stern9b375962011-03-07 11:11:52 -05002823 clear_bit(HCD_FLAG_RH_RUNNING, &hcd->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 if (HC_IS_RUNNING (hcd->state))
2825 hcd->state = HC_STATE_QUIESCING;
2826
2827 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2828 spin_lock_irq (&hcd_root_hub_lock);
2829 hcd->rh_registered = 0;
2830 spin_unlock_irq (&hcd_root_hub_lock);
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002831
Alan Stern84ebc102013-03-27 16:14:46 -04002832#ifdef CONFIG_PM_RUNTIME
Alan Sternd5d4db72007-05-29 16:34:52 -04002833 cancel_work_sync(&hcd->wakeup_work);
Alan Stern6b157c92007-03-13 16:37:30 -04002834#endif
2835
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002836 mutex_lock(&usb_bus_list_lock);
Alan Stern6d88e672010-06-09 17:34:17 -04002837 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002838 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839
Ming Lei94dfd7e2013-07-03 22:53:07 +08002840 /*
2841 * tasklet_kill() isn't needed here because:
2842 * - driver's disconnect() called from usb_disconnect() should
2843 * make sure its URBs are completed during the disconnect()
2844 * callback
2845 *
2846 * - it is too late to run complete() here since driver may have
2847 * been removed already now
2848 */
2849
Alan Stern6d88e672010-06-09 17:34:17 -04002850 /* Prevent any more root-hub status calls from the timer.
2851 * The HCD might still restart the timer (if a port status change
2852 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2853 * the hub_status_data() callback.
2854 */
2855 hcd->rh_pollable = 0;
Alan Stern541c7d42010-06-22 16:39:10 -04002856 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern6d88e672010-06-09 17:34:17 -04002857 del_timer_sync(&hcd->rh_timer);
2858
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859 hcd->driver->stop(hcd);
2860 hcd->state = HC_STATE_HALT;
2861
Alan Stern6d88e672010-06-09 17:34:17 -04002862 /* In case the HCD restarted the timer, stop it again. */
Alan Stern541c7d42010-06-22 16:39:10 -04002863 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern1b42ae62007-03-13 11:10:52 -04002864 del_timer_sync(&hcd->rh_timer);
2865
Sarah Sharpc5635432010-10-28 15:40:26 -07002866 if (usb_hcd_is_primary_hcd(hcd)) {
Felipe Balbicd704692012-02-29 16:46:23 +02002867 if (hcd->irq > 0)
Sarah Sharpc5635432010-10-28 15:40:26 -07002868 free_irq(hcd->irq, hcd);
2869 }
Alan Stern6d88e672010-06-09 17:34:17 -04002870
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 usb_deregister_bus(&hcd->self);
2872 hcd_buffer_destroy(hcd);
Valentine Barshak103e1272013-12-04 01:42:21 +04002873 if (hcd->remove_phy && hcd->phy) {
2874 usb_phy_shutdown(hcd->phy);
2875 usb_put_phy(hcd->phy);
2876 hcd->phy = NULL;
2877 }
Dan Williamsd8521af2014-05-20 18:08:28 -07002878
2879 usb_put_invalidate_rhdev(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002881EXPORT_SYMBOL_GPL(usb_remove_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882
Aleksey Gorelov64a21d02006-08-08 17:24:08 -07002883void
Matthias Beyer842c1962013-10-05 18:02:06 +02002884usb_hcd_platform_shutdown(struct platform_device *dev)
Aleksey Gorelov64a21d02006-08-08 17:24:08 -07002885{
2886 struct usb_hcd *hcd = platform_get_drvdata(dev);
2887
2888 if (hcd->driver->shutdown)
2889 hcd->driver->shutdown(hcd);
2890}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002891EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -07002892
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893/*-------------------------------------------------------------------------*/
2894
Pete Zaitcevf150fa12008-11-13 21:31:21 -07002895#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002896
2897struct usb_mon_operations *mon_ops;
2898
2899/*
2900 * The registration is unlocked.
2901 * We do it this way because we do not want to lock in hot paths.
2902 *
2903 * Notice that the code is minimally error-proof. Because usbmon needs
2904 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2905 */
Matthias Beyer14557352013-10-05 18:02:07 +02002906
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907int usb_mon_register (struct usb_mon_operations *ops)
2908{
2909
2910 if (mon_ops)
2911 return -EBUSY;
2912
2913 mon_ops = ops;
2914 mb();
2915 return 0;
2916}
2917EXPORT_SYMBOL_GPL (usb_mon_register);
2918
2919void usb_mon_deregister (void)
2920{
2921
2922 if (mon_ops == NULL) {
2923 printk(KERN_ERR "USB: monitor was not registered\n");
2924 return;
2925 }
2926 mon_ops = NULL;
2927 mb();
2928}
2929EXPORT_SYMBOL_GPL (usb_mon_deregister);
2930
Pete Zaitcevf150fa12008-11-13 21:31:21 -07002931#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */