blob: 93720bdc9efd4a9ff2e4f0d01023f2432edd1f51 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB hub driver.
3 *
4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
8 *
9 */
10
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/kernel.h>
12#include <linux/errno.h>
13#include <linux/module.h>
14#include <linux/moduleparam.h>
15#include <linux/completion.h>
16#include <linux/sched.h>
17#include <linux/list.h>
18#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/ioctl.h>
20#include <linux/usb.h>
21#include <linux/usbdevice_fs.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020022#include <linux/usb/hcd.h>
Phil Dibowitz93362a82010-07-22 00:05:01 +020023#include <linux/usb/quirks.h>
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070024#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010025#include <linux/mutex.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080026#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <asm/uaccess.h>
29#include <asm/byteorder.h>
30
31#include "usb.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -080033/* if we are in debug mode, always announce new devices */
34#ifdef DEBUG
35#ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36#define CONFIG_USB_ANNOUNCE_NEW_DEVICES
37#endif
38#endif
39
Alan Stern1bb5f662006-11-06 11:56:13 -050040struct usb_hub {
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
Alan Sterne8054852007-05-04 11:55:11 -040043 struct kref kref;
Alan Stern1bb5f662006-11-06 11:56:13 -050044 struct urb *urb; /* for interrupt polling pipe */
45
46 /* buffer for urb ... with extra space in case of babble */
47 char (*buffer)[8];
Alan Stern1bb5f662006-11-06 11:56:13 -050048 union {
49 struct usb_hub_status hub;
50 struct usb_port_status port;
51 } *status; /* buffer for status reports */
Alan Sterndb90e7a2007-02-05 09:56:15 -050052 struct mutex status_mutex; /* for the status buffer */
Alan Stern1bb5f662006-11-06 11:56:13 -050053
54 int error; /* last reported error */
55 int nerrors; /* track consecutive errors */
56
57 struct list_head event_list; /* hubs w/data or errs ready */
58 unsigned long event_bits[1]; /* status change bitmask */
59 unsigned long change_bits[1]; /* ports with logical connect
60 status change */
61 unsigned long busy_bits[1]; /* ports being reset or
62 resumed */
Alan Stern253e0572009-10-27 15:20:13 -040063 unsigned long removed_bits[1]; /* ports with a "removed"
64 device present */
Alan Stern1bb5f662006-11-06 11:56:13 -050065#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66#error event_bits[] is too short!
67#endif
68
69 struct usb_hub_descriptor *descriptor; /* class descriptor */
70 struct usb_tt tt; /* Transaction Translator */
71
72 unsigned mA_per_port; /* current for each child */
73
74 unsigned limited_power:1;
75 unsigned quiescing:1;
Alan Sterne8054852007-05-04 11:55:11 -040076 unsigned disconnected:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050077
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
David Howells6d5aefb2006-12-05 19:36:26 +000080 struct delayed_work leds;
Alan Stern8520f382008-09-22 14:44:26 -040081 struct delayed_work init_work;
Alan Stern7cbe5dc2009-06-29 10:56:54 -040082 void **port_owners;
Alan Stern1bb5f662006-11-06 11:56:13 -050083};
84
John Youndbe79bb2001-09-17 00:00:00 -070085static inline int hub_is_superspeed(struct usb_device *hdev)
86{
87 return (hdev->descriptor.bDeviceProtocol == 3);
88}
Alan Stern1bb5f662006-11-06 11:56:13 -050089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050091 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
93static DEFINE_SPINLOCK(device_state_lock);
94
95/* khubd's worklist and its lock */
96static DEFINE_SPINLOCK(hub_event_lock);
97static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
98
99/* Wakes up khubd */
100static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
101
akpm@osdl.org9c8d6172005-06-20 14:29:58 -0700102static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/* cycle leds on hubs that aren't blinking for attention */
105static int blinkenlights = 0;
106module_param (blinkenlights, bool, S_IRUGO);
107MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
108
109/*
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +0200110 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
111 * 10 seconds to send reply for the initial 64-byte descriptor request.
112 */
113/* define initial 64-byte descriptor request timeout in milliseconds */
114static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
115module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
Wu Fengguangb9cef6c2008-12-15 15:32:01 +0800116MODULE_PARM_DESC(initial_descriptor_timeout,
117 "initial 64-byte descriptor request timeout in milliseconds "
118 "(default 5000 - 5.0 seconds)");
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +0200119
120/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 * As of 2.6.10 we introduce a new USB device initialization scheme which
122 * closely resembles the way Windows works. Hopefully it will be compatible
123 * with a wider range of devices than the old scheme. However some previously
124 * working devices may start giving rise to "device not accepting address"
125 * errors; if that happens the user can try the old scheme by adjusting the
126 * following module parameters.
127 *
128 * For maximum flexibility there are two boolean parameters to control the
129 * hub driver's behavior. On the first initialization attempt, if the
130 * "old_scheme_first" parameter is set then the old scheme will be used,
131 * otherwise the new scheme is used. If that fails and "use_both_schemes"
132 * is set, then the driver will make another attempt, using the other scheme.
133 */
134static int old_scheme_first = 0;
135module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
136MODULE_PARM_DESC(old_scheme_first,
137 "start with the old device initialization scheme");
138
139static int use_both_schemes = 1;
140module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
141MODULE_PARM_DESC(use_both_schemes,
142 "try the other device initialization scheme if the "
143 "first one fails");
144
Alan Stern32fe0192007-10-10 16:27:07 -0400145/* Mutual exclusion for EHCI CF initialization. This interferes with
146 * port reset on some companion controllers.
147 */
148DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
149EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
150
Alan Stern948fea32008-04-28 11:07:07 -0400151#define HUB_DEBOUNCE_TIMEOUT 1500
152#define HUB_DEBOUNCE_STEP 25
153#define HUB_DEBOUNCE_STABLE 100
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Ming Lei742120c2008-06-18 22:00:29 +0800156static int usb_reset_and_verify_device(struct usb_device *udev);
157
Sarah Sharp131dec32010-12-06 21:00:19 -0800158static inline char *portspeed(struct usb_hub *hub, int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
Sarah Sharp131dec32010-12-06 21:00:19 -0800160 if (hub_is_superspeed(hub->hdev))
161 return "5.0 Gb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500162 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 return "480 Mb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500164 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 return "1.5 Mb/s";
166 else
167 return "12 Mb/s";
168}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170/* Note that hdev or one of its children must be locked! */
Alan Stern251180842009-07-22 14:41:18 -0400171static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Alan Stern251180842009-07-22 14:41:18 -0400173 if (!hdev || !hdev->actconfig)
174 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 return usb_get_intfdata(hdev->actconfig->interface[0]);
176}
177
178/* USB 2.0 spec Section 11.24.4.5 */
John Youndbe79bb2001-09-17 00:00:00 -0700179static int get_hub_descriptor(struct usb_device *hdev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180{
John Youndbe79bb2001-09-17 00:00:00 -0700181 int i, ret, size;
182 unsigned dtype;
183
184 if (hub_is_superspeed(hdev)) {
185 dtype = USB_DT_SS_HUB;
186 size = USB_DT_SS_HUB_SIZE;
187 } else {
188 dtype = USB_DT_HUB;
189 size = sizeof(struct usb_hub_descriptor);
190 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 for (i = 0; i < 3; i++) {
193 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
194 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
John Youndbe79bb2001-09-17 00:00:00 -0700195 dtype << 8, 0, data, size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 USB_CTRL_GET_TIMEOUT);
197 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
198 return ret;
199 }
200 return -EINVAL;
201}
202
203/*
204 * USB 2.0 spec Section 11.24.2.1
205 */
206static int clear_hub_feature(struct usb_device *hdev, int feature)
207{
208 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
209 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
210}
211
212/*
213 * USB 2.0 spec Section 11.24.2.2
214 */
215static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
216{
217 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
218 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
219 NULL, 0, 1000);
220}
221
222/*
223 * USB 2.0 spec Section 11.24.2.13
224 */
225static int set_port_feature(struct usb_device *hdev, int port1, int feature)
226{
227 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
228 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
229 NULL, 0, 1000);
230}
231
232/*
233 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
234 * for info about using port indicators
235 */
236static void set_port_led(
237 struct usb_hub *hub,
238 int port1,
239 int selector
240)
241{
242 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
243 USB_PORT_FEAT_INDICATOR);
244 if (status < 0)
245 dev_dbg (hub->intfdev,
246 "port %d indicator %s status %d\n",
247 port1,
248 ({ char *s; switch (selector) {
249 case HUB_LED_AMBER: s = "amber"; break;
250 case HUB_LED_GREEN: s = "green"; break;
251 case HUB_LED_OFF: s = "off"; break;
252 case HUB_LED_AUTO: s = "auto"; break;
253 default: s = "??"; break;
254 }; s; }),
255 status);
256}
257
258#define LED_CYCLE_PERIOD ((2*HZ)/3)
259
David Howellsc4028952006-11-22 14:57:56 +0000260static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
David Howellsc4028952006-11-22 14:57:56 +0000262 struct usb_hub *hub =
263 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 struct usb_device *hdev = hub->hdev;
265 unsigned i;
266 unsigned changed = 0;
267 int cursor = -1;
268
269 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
270 return;
271
272 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
273 unsigned selector, mode;
274
275 /* 30%-50% duty cycle */
276
277 switch (hub->indicator[i]) {
278 /* cycle marker */
279 case INDICATOR_CYCLE:
280 cursor = i;
281 selector = HUB_LED_AUTO;
282 mode = INDICATOR_AUTO;
283 break;
284 /* blinking green = sw attention */
285 case INDICATOR_GREEN_BLINK:
286 selector = HUB_LED_GREEN;
287 mode = INDICATOR_GREEN_BLINK_OFF;
288 break;
289 case INDICATOR_GREEN_BLINK_OFF:
290 selector = HUB_LED_OFF;
291 mode = INDICATOR_GREEN_BLINK;
292 break;
293 /* blinking amber = hw attention */
294 case INDICATOR_AMBER_BLINK:
295 selector = HUB_LED_AMBER;
296 mode = INDICATOR_AMBER_BLINK_OFF;
297 break;
298 case INDICATOR_AMBER_BLINK_OFF:
299 selector = HUB_LED_OFF;
300 mode = INDICATOR_AMBER_BLINK;
301 break;
302 /* blink green/amber = reserved */
303 case INDICATOR_ALT_BLINK:
304 selector = HUB_LED_GREEN;
305 mode = INDICATOR_ALT_BLINK_OFF;
306 break;
307 case INDICATOR_ALT_BLINK_OFF:
308 selector = HUB_LED_AMBER;
309 mode = INDICATOR_ALT_BLINK;
310 break;
311 default:
312 continue;
313 }
314 if (selector != HUB_LED_AUTO)
315 changed = 1;
316 set_port_led(hub, i + 1, selector);
317 hub->indicator[i] = mode;
318 }
319 if (!changed && blinkenlights) {
320 cursor++;
321 cursor %= hub->descriptor->bNbrPorts;
322 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
323 hub->indicator[cursor] = INDICATOR_CYCLE;
324 changed++;
325 }
326 if (changed)
327 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
328}
329
330/* use a short timeout for hub/port status fetches */
331#define USB_STS_TIMEOUT 1000
332#define USB_STS_RETRIES 5
333
334/*
335 * USB 2.0 spec Section 11.24.2.6
336 */
337static int get_hub_status(struct usb_device *hdev,
338 struct usb_hub_status *data)
339{
340 int i, status = -ETIMEDOUT;
341
342 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
343 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
344 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
345 data, sizeof(*data), USB_STS_TIMEOUT);
346 }
347 return status;
348}
349
350/*
351 * USB 2.0 spec Section 11.24.2.7
352 */
353static int get_port_status(struct usb_device *hdev, int port1,
354 struct usb_port_status *data)
355{
356 int i, status = -ETIMEDOUT;
357
358 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
359 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
360 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
361 data, sizeof(*data), USB_STS_TIMEOUT);
362 }
363 return status;
364}
365
Alan Stern3eb14912008-03-03 15:15:43 -0500366static int hub_port_status(struct usb_hub *hub, int port1,
367 u16 *status, u16 *change)
368{
369 int ret;
370
371 mutex_lock(&hub->status_mutex);
372 ret = get_port_status(hub->hdev, port1, &hub->status->port);
373 if (ret < 4) {
374 dev_err(hub->intfdev,
375 "%s failed (err = %d)\n", __func__, ret);
376 if (ret >= 0)
377 ret = -EIO;
378 } else {
379 *status = le16_to_cpu(hub->status->port.wPortStatus);
380 *change = le16_to_cpu(hub->status->port.wPortChange);
John Youndbe79bb2001-09-17 00:00:00 -0700381
382 if ((hub->hdev->parent != NULL) &&
383 hub_is_superspeed(hub->hdev)) {
384 /* Translate the USB 3 port status */
385 u16 tmp = *status & USB_SS_PORT_STAT_MASK;
386 if (*status & USB_SS_PORT_STAT_POWER)
387 tmp |= USB_PORT_STAT_POWER;
John Youndbe79bb2001-09-17 00:00:00 -0700388 *status = tmp;
389 }
390
Alan Stern3eb14912008-03-03 15:15:43 -0500391 ret = 0;
392 }
393 mutex_unlock(&hub->status_mutex);
394 return ret;
395}
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397static void kick_khubd(struct usb_hub *hub)
398{
399 unsigned long flags;
400
401 spin_lock_irqsave(&hub_event_lock, flags);
Roel Kluin2e2c5ee2007-10-26 23:54:35 +0200402 if (!hub->disconnected && list_empty(&hub->event_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 list_add_tail(&hub->event_list, &hub_event_list);
Alan Stern8e4ceb32009-12-07 13:01:37 -0500404
405 /* Suppress autosuspend until khubd runs */
406 usb_autopm_get_interface_no_resume(
407 to_usb_interface(hub->intfdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 wake_up(&khubd_wait);
409 }
410 spin_unlock_irqrestore(&hub_event_lock, flags);
411}
412
413void usb_kick_khubd(struct usb_device *hdev)
414{
Alan Stern251180842009-07-22 14:41:18 -0400415 struct usb_hub *hub = hdev_to_hub(hdev);
416
417 if (hub)
418 kick_khubd(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420
421
422/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100423static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200425 struct usb_hub *hub = urb->context;
Alan Sterne0152682007-08-24 15:42:52 -0400426 int status = urb->status;
Roel Kluin71d27182009-03-13 12:19:18 +0100427 unsigned i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 unsigned long bits;
429
Alan Sterne0152682007-08-24 15:42:52 -0400430 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 case -ENOENT: /* synchronous unlink */
432 case -ECONNRESET: /* async unlink */
433 case -ESHUTDOWN: /* hardware going away */
434 return;
435
436 default: /* presumably an error */
437 /* Cause a hub reset after 10 consecutive errors */
Alan Sterne0152682007-08-24 15:42:52 -0400438 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 if ((++hub->nerrors < 10) || hub->error)
440 goto resubmit;
Alan Sterne0152682007-08-24 15:42:52 -0400441 hub->error = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 /* let khubd handle things */
445 case 0: /* we got data: port status changed */
446 bits = 0;
447 for (i = 0; i < urb->actual_length; ++i)
448 bits |= ((unsigned long) ((*hub->buffer)[i]))
449 << (i*8);
450 hub->event_bits[0] = bits;
451 break;
452 }
453
454 hub->nerrors = 0;
455
456 /* Something happened, let khubd figure it out */
457 kick_khubd(hub);
458
459resubmit:
460 if (hub->quiescing)
461 return;
462
463 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
464 && status != -ENODEV && status != -EPERM)
465 dev_err (hub->intfdev, "resubmit --> %d\n", status);
466}
467
468/* USB 2.0 spec Section 11.24.2.3 */
469static inline int
470hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
471{
Alan Sternc2f65952009-11-18 11:37:15 -0500472 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
474 tt, NULL, 0, 1000);
475}
476
477/*
478 * enumeration blocks khubd for a long time. we use keventd instead, since
479 * long blocking there is the exception, not the rule. accordingly, HCDs
480 * talking to TTs must queue control transfers (not just bulk and iso), so
481 * both can talk to the same hub concurrently.
482 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400483static void hub_tt_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
David Howellsc4028952006-11-22 14:57:56 +0000485 struct usb_hub *hub =
Alan Sterncb88a1b2009-06-29 10:43:32 -0400486 container_of(work, struct usb_hub, tt.clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 unsigned long flags;
Mark Lord55e5fdf2007-05-14 19:48:02 -0400488 int limit = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 spin_lock_irqsave (&hub->tt.lock, flags);
Mark Lord55e5fdf2007-05-14 19:48:02 -0400491 while (--limit && !list_empty (&hub->tt.clear_list)) {
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400492 struct list_head *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 struct usb_tt_clear *clear;
494 struct usb_device *hdev = hub->hdev;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400495 const struct hc_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 int status;
497
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400498 next = hub->tt.clear_list.next;
499 clear = list_entry (next, struct usb_tt_clear, clear_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 list_del (&clear->clear_list);
501
502 /* drop lock so HCD can concurrently report other TT errors */
503 spin_unlock_irqrestore (&hub->tt.lock, flags);
504 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 if (status)
506 dev_err (&hdev->dev,
507 "clear tt %d (%04x) error %d\n",
508 clear->tt, clear->devinfo, status);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400509
510 /* Tell the HCD, even if the operation failed */
511 drv = clear->hcd->driver;
512 if (drv->clear_tt_buffer_complete)
513 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
514
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700515 kfree(clear);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400516 spin_lock_irqsave(&hub->tt.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 }
518 spin_unlock_irqrestore (&hub->tt.lock, flags);
519}
520
521/**
Alan Sterncb88a1b2009-06-29 10:43:32 -0400522 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
523 * @urb: an URB associated with the failed or incomplete split transaction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 *
525 * High speed HCDs use this to tell the hub driver that some split control or
526 * bulk transaction failed in a way that requires clearing internal state of
527 * a transaction translator. This is normally detected (and reported) from
528 * interrupt context.
529 *
530 * It may not be possible for that hub to handle additional full (or low)
531 * speed transactions until that state is fully cleared out.
532 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400533int usb_hub_clear_tt_buffer(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534{
Alan Sterncb88a1b2009-06-29 10:43:32 -0400535 struct usb_device *udev = urb->dev;
536 int pipe = urb->pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 struct usb_tt *tt = udev->tt;
538 unsigned long flags;
539 struct usb_tt_clear *clear;
540
541 /* we've got to cope with an arbitrary number of pending TT clears,
542 * since each TT has "at least two" buffers that can need it (and
543 * there can be many TTs per hub). even if they're uncommon.
544 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800545 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
547 /* FIXME recover somehow ... RESET_TT? */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400548 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 }
550
551 /* info that CLEAR_TT_BUFFER needs */
552 clear->tt = tt->multi ? udev->ttport : 1;
553 clear->devinfo = usb_pipeendpoint (pipe);
554 clear->devinfo |= udev->devnum << 4;
555 clear->devinfo |= usb_pipecontrol (pipe)
556 ? (USB_ENDPOINT_XFER_CONTROL << 11)
557 : (USB_ENDPOINT_XFER_BULK << 11);
558 if (usb_pipein (pipe))
559 clear->devinfo |= 1 << 15;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400560
561 /* info for completion callback */
562 clear->hcd = bus_to_hcd(udev->bus);
563 clear->ep = urb->ep;
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 /* tell keventd to clear state for this TT */
566 spin_lock_irqsave (&tt->lock, flags);
567 list_add_tail (&clear->clear_list, &tt->clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400568 schedule_work(&tt->clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 spin_unlock_irqrestore (&tt->lock, flags);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400570 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
Alan Sterncb88a1b2009-06-29 10:43:32 -0400572EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Alan Stern8520f382008-09-22 14:44:26 -0400574/* If do_delay is false, return the number of milliseconds the caller
575 * needs to delay.
576 */
577static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
579 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700580 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern8520f382008-09-22 14:44:26 -0400581 unsigned delay;
Alan Stern4489a572006-04-27 15:54:22 -0400582 u16 wHubCharacteristics =
583 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Alan Stern4489a572006-04-27 15:54:22 -0400585 /* Enable power on each port. Some hubs have reserved values
586 * of LPSM (> 2) in their descriptors, even though they are
587 * USB 2.0 hubs. Some hubs do not implement port-power switching
588 * but only emulate it. In all cases, the ports won't work
589 * unless we send these messages to the hub.
590 */
591 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400593 else
594 dev_dbg(hub->intfdev, "trying to enable port power on "
595 "non-switchable hub\n");
596 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
597 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
David Brownellb7896962005-08-31 10:41:44 -0700599 /* Wait at least 100 msec for power to become stable */
Alan Stern8520f382008-09-22 14:44:26 -0400600 delay = max(pgood_delay, (unsigned) 100);
601 if (do_delay)
602 msleep(delay);
603 return delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604}
605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606static int hub_hub_status(struct usb_hub *hub,
607 u16 *status, u16 *change)
608{
609 int ret;
610
Alan Sterndb90e7a2007-02-05 09:56:15 -0500611 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 ret = get_hub_status(hub->hdev, &hub->status->hub);
613 if (ret < 0)
614 dev_err (hub->intfdev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800615 "%s failed (err = %d)\n", __func__, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 else {
617 *status = le16_to_cpu(hub->status->hub.wHubStatus);
618 *change = le16_to_cpu(hub->status->hub.wHubChange);
619 ret = 0;
620 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500621 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return ret;
623}
624
Alan Stern8b28c752005-08-10 17:04:13 -0400625static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
626{
627 struct usb_device *hdev = hub->hdev;
Alan Stern0458d5b2007-05-04 11:52:20 -0400628 int ret = 0;
Alan Stern8b28c752005-08-10 17:04:13 -0400629
Alan Stern0458d5b2007-05-04 11:52:20 -0400630 if (hdev->children[port1-1] && set_state)
Alan Stern8b28c752005-08-10 17:04:13 -0400631 usb_set_device_state(hdev->children[port1-1],
632 USB_STATE_NOTATTACHED);
John Youndbe79bb2001-09-17 00:00:00 -0700633 if (!hub->error && !hub_is_superspeed(hub->hdev))
Alan Stern0458d5b2007-05-04 11:52:20 -0400634 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
Alan Stern8b28c752005-08-10 17:04:13 -0400635 if (ret)
636 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
Alan Stern0458d5b2007-05-04 11:52:20 -0400637 port1, ret);
Alan Stern8b28c752005-08-10 17:04:13 -0400638 return ret;
639}
640
Alan Stern0458d5b2007-05-04 11:52:20 -0400641/*
Justin P. Mattock6d42fcd2011-02-26 20:33:56 -0800642 * Disable a port and mark a logical connect-change event, so that some
Alan Stern0458d5b2007-05-04 11:52:20 -0400643 * time later khubd will disconnect() any existing usb_device on the port
644 * and will re-enumerate if there actually is a device attached.
645 */
646static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
647{
648 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
649 hub_port_disable(hub, port1, 1);
650
651 /* FIXME let caller ask to power down the port:
652 * - some devices won't enumerate without a VBUS power cycle
653 * - SRP saves power that way
654 * - ... new call, TBD ...
655 * That's easy if this hub can switch power per-port, and
656 * khubd reactivates the port later (timer, SRP, etc).
657 * Powerdown must be optional, because of reset/DFU.
658 */
659
660 set_bit(port1, hub->change_bits);
661 kick_khubd(hub);
662}
663
Alan Stern253e0572009-10-27 15:20:13 -0400664/**
665 * usb_remove_device - disable a device's port on its parent hub
666 * @udev: device to be disabled and removed
667 * Context: @udev locked, must be able to sleep.
668 *
669 * After @udev's port has been disabled, khubd is notified and it will
670 * see that the device has been disconnected. When the device is
671 * physically unplugged and something is plugged in, the events will
672 * be received and processed normally.
673 */
674int usb_remove_device(struct usb_device *udev)
675{
676 struct usb_hub *hub;
677 struct usb_interface *intf;
678
679 if (!udev->parent) /* Can't remove a root hub */
680 return -EINVAL;
681 hub = hdev_to_hub(udev->parent);
682 intf = to_usb_interface(hub->intfdev);
683
684 usb_autopm_get_interface(intf);
685 set_bit(udev->portnum, hub->removed_bits);
686 hub_port_logical_disconnect(hub, udev->portnum);
687 usb_autopm_put_interface(intf);
688 return 0;
689}
690
Alan Stern6ee0b272008-04-28 11:06:42 -0400691enum hub_activation_type {
Alan Stern8e4ceb32009-12-07 13:01:37 -0500692 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
Alan Stern8520f382008-09-22 14:44:26 -0400693 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
Alan Stern6ee0b272008-04-28 11:06:42 -0400694};
Alan Stern5e6effa2008-03-03 15:15:51 -0500695
Alan Stern8520f382008-09-22 14:44:26 -0400696static void hub_init_func2(struct work_struct *ws);
697static void hub_init_func3(struct work_struct *ws);
698
Alan Sternf2835212008-04-28 11:07:17 -0400699static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
Alan Stern5e6effa2008-03-03 15:15:51 -0500700{
701 struct usb_device *hdev = hub->hdev;
Sarah Sharp653a39d2010-12-23 11:12:42 -0800702 struct usb_hcd *hcd;
703 int ret;
Alan Stern5e6effa2008-03-03 15:15:51 -0500704 int port1;
Alan Sternf2835212008-04-28 11:07:17 -0400705 int status;
Alan Stern948fea32008-04-28 11:07:07 -0400706 bool need_debounce_delay = false;
Alan Stern8520f382008-09-22 14:44:26 -0400707 unsigned delay;
708
709 /* Continue a partial initialization */
710 if (type == HUB_INIT2)
711 goto init2;
712 if (type == HUB_INIT3)
713 goto init3;
Alan Stern5e6effa2008-03-03 15:15:51 -0500714
Alan Sternf2835212008-04-28 11:07:17 -0400715 /* After a resume, port power should still be on.
716 * For any other type of activation, turn it on.
717 */
Alan Stern8520f382008-09-22 14:44:26 -0400718 if (type != HUB_RESUME) {
719
720 /* Speed up system boot by using a delayed_work for the
721 * hub's initial power-up delays. This is pretty awkward
722 * and the implementation looks like a home-brewed sort of
723 * setjmp/longjmp, but it saves at least 100 ms for each
724 * root hub (assuming usbcore is compiled into the kernel
725 * rather than as a module). It adds up.
726 *
727 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
728 * because for those activation types the ports have to be
729 * operational when we return. In theory this could be done
730 * for HUB_POST_RESET, but it's easier not to.
731 */
732 if (type == HUB_INIT) {
733 delay = hub_power_on(hub, false);
734 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
735 schedule_delayed_work(&hub->init_work,
736 msecs_to_jiffies(delay));
Alan Stern61fbeba2008-10-27 12:07:44 -0400737
738 /* Suppress autosuspend until init is done */
Alan Stern8e4ceb32009-12-07 13:01:37 -0500739 usb_autopm_get_interface_no_resume(
740 to_usb_interface(hub->intfdev));
Alan Stern8520f382008-09-22 14:44:26 -0400741 return; /* Continues at init2: below */
Sarah Sharp653a39d2010-12-23 11:12:42 -0800742 } else if (type == HUB_RESET_RESUME) {
743 /* The internal host controller state for the hub device
744 * may be gone after a host power loss on system resume.
745 * Update the device's info so the HW knows it's a hub.
746 */
747 hcd = bus_to_hcd(hdev->bus);
748 if (hcd->driver->update_hub_device) {
749 ret = hcd->driver->update_hub_device(hcd, hdev,
750 &hub->tt, GFP_NOIO);
751 if (ret < 0) {
752 dev_err(hub->intfdev, "Host not "
753 "accepting hub info "
754 "update.\n");
755 dev_err(hub->intfdev, "LS/FS devices "
756 "and hubs may not work "
757 "under this hub\n.");
758 }
759 }
760 hub_power_on(hub, true);
Alan Stern8520f382008-09-22 14:44:26 -0400761 } else {
762 hub_power_on(hub, true);
763 }
764 }
765 init2:
Alan Sternf2835212008-04-28 11:07:17 -0400766
Alan Stern6ee0b272008-04-28 11:06:42 -0400767 /* Check each port and set hub->change_bits to let khubd know
768 * which ports need attention.
Alan Stern5e6effa2008-03-03 15:15:51 -0500769 */
770 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
771 struct usb_device *udev = hdev->children[port1-1];
Alan Stern5e6effa2008-03-03 15:15:51 -0500772 u16 portstatus, portchange;
773
Alan Stern6ee0b272008-04-28 11:06:42 -0400774 portstatus = portchange = 0;
775 status = hub_port_status(hub, port1, &portstatus, &portchange);
776 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
777 dev_dbg(hub->intfdev,
778 "port %d: status %04x change %04x\n",
779 port1, portstatus, portchange);
Alan Stern5e6effa2008-03-03 15:15:51 -0500780
Alan Stern6ee0b272008-04-28 11:06:42 -0400781 /* After anything other than HUB_RESUME (i.e., initialization
782 * or any sort of reset), every port should be disabled.
783 * Unconnected ports should likewise be disabled (paranoia),
784 * and so should ports for which we have no usb_device.
Alan Stern5e6effa2008-03-03 15:15:51 -0500785 */
Alan Stern6ee0b272008-04-28 11:06:42 -0400786 if ((portstatus & USB_PORT_STAT_ENABLE) && (
787 type != HUB_RESUME ||
788 !(portstatus & USB_PORT_STAT_CONNECTION) ||
789 !udev ||
790 udev->state == USB_STATE_NOTATTACHED)) {
Andiry Xu9f0a6cd2010-05-07 18:09:27 +0800791 /*
792 * USB3 protocol ports will automatically transition
793 * to Enabled state when detect an USB3.0 device attach.
794 * Do not disable USB3 protocol ports.
Andiry Xu9f0a6cd2010-05-07 18:09:27 +0800795 */
Sarah Sharp131dec32010-12-06 21:00:19 -0800796 if (!hub_is_superspeed(hdev)) {
Andiry Xu9f0a6cd2010-05-07 18:09:27 +0800797 clear_port_feature(hdev, port1,
798 USB_PORT_FEAT_ENABLE);
799 portstatus &= ~USB_PORT_STAT_ENABLE;
Sarah Sharp85f0ff42010-10-14 07:22:54 -0700800 } else {
801 /* Pretend that power was lost for USB3 devs */
802 portstatus &= ~USB_PORT_STAT_ENABLE;
Andiry Xu9f0a6cd2010-05-07 18:09:27 +0800803 }
Alan Stern6ee0b272008-04-28 11:06:42 -0400804 }
805
Alan Stern948fea32008-04-28 11:07:07 -0400806 /* Clear status-change flags; we'll debounce later */
807 if (portchange & USB_PORT_STAT_C_CONNECTION) {
808 need_debounce_delay = true;
809 clear_port_feature(hub->hdev, port1,
810 USB_PORT_FEAT_C_CONNECTION);
811 }
812 if (portchange & USB_PORT_STAT_C_ENABLE) {
813 need_debounce_delay = true;
814 clear_port_feature(hub->hdev, port1,
815 USB_PORT_FEAT_C_ENABLE);
816 }
John Youndbe79bb2001-09-17 00:00:00 -0700817 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
818 need_debounce_delay = true;
819 clear_port_feature(hub->hdev, port1,
820 USB_PORT_FEAT_C_PORT_LINK_STATE);
821 }
Alan Stern948fea32008-04-28 11:07:07 -0400822
Alan Stern253e0572009-10-27 15:20:13 -0400823 /* We can forget about a "removed" device when there's a
824 * physical disconnect or the connect status changes.
825 */
826 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
827 (portchange & USB_PORT_STAT_C_CONNECTION))
828 clear_bit(port1, hub->removed_bits);
829
Alan Stern6ee0b272008-04-28 11:06:42 -0400830 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
831 /* Tell khubd to disconnect the device or
832 * check for a new connection
833 */
834 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
835 set_bit(port1, hub->change_bits);
836
837 } else if (portstatus & USB_PORT_STAT_ENABLE) {
838 /* The power session apparently survived the resume.
839 * If there was an overcurrent or suspend change
840 * (i.e., remote wakeup request), have khubd
841 * take care of it.
842 */
843 if (portchange)
844 set_bit(port1, hub->change_bits);
845
846 } else if (udev->persist_enabled) {
Alan Stern6ee0b272008-04-28 11:06:42 -0400847#ifdef CONFIG_PM
Alan Stern5e6effa2008-03-03 15:15:51 -0500848 udev->reset_resume = 1;
Alan Stern6ee0b272008-04-28 11:06:42 -0400849#endif
Alan Stern8808f002008-04-28 11:06:55 -0400850 set_bit(port1, hub->change_bits);
851
Alan Stern6ee0b272008-04-28 11:06:42 -0400852 } else {
853 /* The power session is gone; tell khubd */
854 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
855 set_bit(port1, hub->change_bits);
Alan Stern5e6effa2008-03-03 15:15:51 -0500856 }
Alan Stern5e6effa2008-03-03 15:15:51 -0500857 }
858
Alan Stern948fea32008-04-28 11:07:07 -0400859 /* If no port-status-change flags were set, we don't need any
860 * debouncing. If flags were set we can try to debounce the
861 * ports all at once right now, instead of letting khubd do them
862 * one at a time later on.
863 *
864 * If any port-status changes do occur during this delay, khubd
865 * will see them later and handle them normally.
866 */
Alan Stern8520f382008-09-22 14:44:26 -0400867 if (need_debounce_delay) {
868 delay = HUB_DEBOUNCE_STABLE;
Alan Sternf2835212008-04-28 11:07:17 -0400869
Alan Stern8520f382008-09-22 14:44:26 -0400870 /* Don't do a long sleep inside a workqueue routine */
871 if (type == HUB_INIT2) {
872 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
873 schedule_delayed_work(&hub->init_work,
874 msecs_to_jiffies(delay));
875 return; /* Continues at init3: below */
876 } else {
877 msleep(delay);
878 }
879 }
880 init3:
Alan Sternf2835212008-04-28 11:07:17 -0400881 hub->quiescing = 0;
882
883 status = usb_submit_urb(hub->urb, GFP_NOIO);
884 if (status < 0)
885 dev_err(hub->intfdev, "activate --> %d\n", status);
886 if (hub->has_indicators && blinkenlights)
887 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
888
889 /* Scan all ports that need attention */
890 kick_khubd(hub);
Alan Stern8e4ceb32009-12-07 13:01:37 -0500891
892 /* Allow autosuspend if it was suppressed */
893 if (type <= HUB_INIT3)
894 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
Alan Stern5e6effa2008-03-03 15:15:51 -0500895}
896
Alan Stern8520f382008-09-22 14:44:26 -0400897/* Implement the continuations for the delays above */
898static void hub_init_func2(struct work_struct *ws)
899{
900 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
901
902 hub_activate(hub, HUB_INIT2);
903}
904
905static void hub_init_func3(struct work_struct *ws)
906{
907 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
908
909 hub_activate(hub, HUB_INIT3);
910}
911
Alan Stern43303542008-04-28 11:07:31 -0400912enum hub_quiescing_type {
913 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
914};
915
916static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
917{
918 struct usb_device *hdev = hub->hdev;
919 int i;
920
Alan Stern8520f382008-09-22 14:44:26 -0400921 cancel_delayed_work_sync(&hub->init_work);
922
Alan Stern43303542008-04-28 11:07:31 -0400923 /* khubd and related activity won't re-trigger */
924 hub->quiescing = 1;
925
926 if (type != HUB_SUSPEND) {
927 /* Disconnect all the children */
928 for (i = 0; i < hdev->maxchild; ++i) {
929 if (hdev->children[i])
930 usb_disconnect(&hdev->children[i]);
931 }
932 }
933
934 /* Stop khubd and related activity */
935 usb_kill_urb(hub->urb);
936 if (hub->has_indicators)
937 cancel_delayed_work_sync(&hub->leds);
938 if (hub->tt.hub)
Alan Sterncb88a1b2009-06-29 10:43:32 -0400939 cancel_work_sync(&hub->tt.clear_work);
Alan Stern43303542008-04-28 11:07:31 -0400940}
941
Alan Stern3eb14912008-03-03 15:15:43 -0500942/* caller has locked the hub device */
943static int hub_pre_reset(struct usb_interface *intf)
944{
945 struct usb_hub *hub = usb_get_intfdata(intf);
946
Alan Stern43303542008-04-28 11:07:31 -0400947 hub_quiesce(hub, HUB_PRE_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -0400948 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -0500949}
950
951/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -0400952static int hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500953{
Alan Stern7de18d82006-06-01 13:37:24 -0400954 struct usb_hub *hub = usb_get_intfdata(intf);
955
Alan Sternf2835212008-04-28 11:07:17 -0400956 hub_activate(hub, HUB_POST_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -0400957 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -0500958}
959
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960static int hub_configure(struct usb_hub *hub,
961 struct usb_endpoint_descriptor *endpoint)
962{
Sarah Sharpb356b7c2009-09-04 10:53:24 -0700963 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 struct usb_device *hdev = hub->hdev;
965 struct device *hub_dev = hub->intfdev;
966 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700967 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 unsigned int pipe;
969 int maxp, ret;
Alan Stern7cbe5dc2009-06-29 10:56:54 -0400970 char *message = "out of memory";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
Alan Sternd697cdd2009-10-27 15:18:46 -0400972 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 if (!hub->buffer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 ret = -ENOMEM;
975 goto fail;
976 }
977
978 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
979 if (!hub->status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 ret = -ENOMEM;
981 goto fail;
982 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500983 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
985 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
986 if (!hub->descriptor) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 ret = -ENOMEM;
988 goto fail;
989 }
990
John Youndbe79bb2001-09-17 00:00:00 -0700991 if (hub_is_superspeed(hdev) && (hdev->parent != NULL)) {
992 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
993 HUB_SET_DEPTH, USB_RT_HUB,
994 hdev->level - 1, 0, NULL, 0,
995 USB_CTRL_SET_TIMEOUT);
996
997 if (ret < 0) {
998 message = "can't set hub depth";
999 goto fail;
1000 }
1001 }
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 /* Request the entire hub descriptor.
1004 * hub->descriptor can handle USB_MAXCHILDREN ports,
1005 * but the hub can/will return fewer bytes here.
1006 */
John Youndbe79bb2001-09-17 00:00:00 -07001007 ret = get_hub_descriptor(hdev, hub->descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 if (ret < 0) {
1009 message = "can't read hub descriptor";
1010 goto fail;
1011 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1012 message = "hub has too many ports!";
1013 ret = -ENODEV;
1014 goto fail;
1015 }
1016
1017 hdev->maxchild = hub->descriptor->bNbrPorts;
1018 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1019 (hdev->maxchild == 1) ? "" : "s");
1020
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001021 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1022 if (!hub->port_owners) {
1023 ret = -ENOMEM;
1024 goto fail;
1025 }
1026
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001027 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
John Youndbe79bb2001-09-17 00:00:00 -07001029 /* FIXME for USB 3.0, skip for now */
1030 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1031 !(hub_is_superspeed(hdev))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 int i;
1033 char portstr [USB_MAXCHILDREN + 1];
1034
1035 for (i = 0; i < hdev->maxchild; i++)
John Youndbe79bb2001-09-17 00:00:00 -07001036 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1038 ? 'F' : 'R';
1039 portstr[hdev->maxchild] = 0;
1040 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1041 } else
1042 dev_dbg(hub_dev, "standalone hub\n");
1043
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001044 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 case 0x00:
1046 dev_dbg(hub_dev, "ganged power switching\n");
1047 break;
1048 case 0x01:
1049 dev_dbg(hub_dev, "individual port power switching\n");
1050 break;
1051 case 0x02:
1052 case 0x03:
1053 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1054 break;
1055 }
1056
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001057 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 case 0x00:
1059 dev_dbg(hub_dev, "global over-current protection\n");
1060 break;
1061 case 0x08:
1062 dev_dbg(hub_dev, "individual port over-current protection\n");
1063 break;
1064 case 0x10:
1065 case 0x18:
1066 dev_dbg(hub_dev, "no over-current protection\n");
1067 break;
1068 }
1069
1070 spin_lock_init (&hub->tt.lock);
1071 INIT_LIST_HEAD (&hub->tt.clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -04001072 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 switch (hdev->descriptor.bDeviceProtocol) {
1074 case 0:
1075 break;
1076 case 1:
1077 dev_dbg(hub_dev, "Single TT\n");
1078 hub->tt.hub = hdev;
1079 break;
1080 case 2:
1081 ret = usb_set_interface(hdev, 0, 1);
1082 if (ret == 0) {
1083 dev_dbg(hub_dev, "TT per port\n");
1084 hub->tt.multi = 1;
1085 } else
1086 dev_err(hub_dev, "Using single TT (err %d)\n",
1087 ret);
1088 hub->tt.hub = hdev;
1089 break;
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -07001090 case 3:
1091 /* USB 3.0 hubs don't have a TT */
1092 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 default:
1094 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1095 hdev->descriptor.bDeviceProtocol);
1096 break;
1097 }
1098
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001099 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001100 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001101 case HUB_TTTT_8_BITS:
1102 if (hdev->descriptor.bDeviceProtocol != 0) {
1103 hub->tt.think_time = 666;
1104 dev_dbg(hub_dev, "TT requires at most %d "
1105 "FS bit times (%d ns)\n",
1106 8, hub->tt.think_time);
1107 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001109 case HUB_TTTT_16_BITS:
1110 hub->tt.think_time = 666 * 2;
1111 dev_dbg(hub_dev, "TT requires at most %d "
1112 "FS bit times (%d ns)\n",
1113 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001115 case HUB_TTTT_24_BITS:
1116 hub->tt.think_time = 666 * 3;
1117 dev_dbg(hub_dev, "TT requires at most %d "
1118 "FS bit times (%d ns)\n",
1119 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001121 case HUB_TTTT_32_BITS:
1122 hub->tt.think_time = 666 * 4;
1123 dev_dbg(hub_dev, "TT requires at most %d "
1124 "FS bit times (%d ns)\n",
1125 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 break;
1127 }
1128
1129 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001130 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 hub->has_indicators = 1;
1132 dev_dbg(hub_dev, "Port indicators are supported\n");
1133 }
1134
1135 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1136 hub->descriptor->bPwrOn2PwrGood * 2);
1137
1138 /* power budgeting mostly matters with bus-powered hubs,
1139 * and battery-powered root hubs (may provide just 8 mA).
1140 */
1141 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001142 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 message = "can't get hub status";
1144 goto fail;
1145 }
Alan Stern7d35b922005-04-25 11:18:32 -04001146 le16_to_cpus(&hubstatus);
1147 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -05001148 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1149 hub->mA_per_port = 500;
1150 else {
1151 hub->mA_per_port = hdev->bus_mA;
1152 hub->limited_power = 1;
1153 }
Alan Stern7d35b922005-04-25 11:18:32 -04001154 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1156 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -05001157 hub->limited_power = 1;
1158 if (hdev->maxchild > 0) {
1159 int remaining = hdev->bus_mA -
1160 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161
Alan Stern55c52712005-11-23 12:03:12 -05001162 if (remaining < hdev->maxchild * 100)
1163 dev_warn(hub_dev,
1164 "insufficient power available "
1165 "to use all downstream ports\n");
1166 hub->mA_per_port = 100; /* 7.2.1.1 */
1167 }
1168 } else { /* Self-powered external hub */
1169 /* FIXME: What about battery-powered external hubs that
1170 * provide less current per port? */
1171 hub->mA_per_port = 500;
1172 }
1173 if (hub->mA_per_port < 500)
1174 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1175 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001177 /* Update the HCD's internal representation of this hub before khubd
1178 * starts getting port status changes for devices under the hub.
1179 */
1180 hcd = bus_to_hcd(hdev->bus);
1181 if (hcd->driver->update_hub_device) {
1182 ret = hcd->driver->update_hub_device(hcd, hdev,
1183 &hub->tt, GFP_KERNEL);
1184 if (ret < 0) {
1185 message = "can't update HCD hub info";
1186 goto fail;
1187 }
1188 }
1189
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1191 if (ret < 0) {
1192 message = "can't get hub status";
1193 goto fail;
1194 }
1195
1196 /* local power status reports aren't always correct */
1197 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1198 dev_dbg(hub_dev, "local power source is %s\n",
1199 (hubstatus & HUB_STATUS_LOCAL_POWER)
1200 ? "lost (inactive)" : "good");
1201
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001202 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 dev_dbg(hub_dev, "%sover-current condition exists\n",
1204 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1205
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -07001206 /* set up the interrupt endpoint
1207 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1208 * bytes as USB2.0[11.12.3] says because some hubs are known
1209 * to send more data (and thus cause overflow). For root hubs,
1210 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1211 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1213 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1214
1215 if (maxp > sizeof(*hub->buffer))
1216 maxp = sizeof(*hub->buffer);
1217
1218 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1219 if (!hub->urb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 ret = -ENOMEM;
1221 goto fail;
1222 }
1223
1224 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1225 hub, endpoint->bInterval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
1227 /* maybe cycle the hub leds */
1228 if (hub->has_indicators && blinkenlights)
1229 hub->indicator [0] = INDICATOR_CYCLE;
1230
Alan Sternf2835212008-04-28 11:07:17 -04001231 hub_activate(hub, HUB_INIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 return 0;
1233
1234fail:
1235 dev_err (hub_dev, "config failed, %s (err %d)\n",
1236 message, ret);
1237 /* hub_disconnect() frees urb and descriptor */
1238 return ret;
1239}
1240
Alan Sterne8054852007-05-04 11:55:11 -04001241static void hub_release(struct kref *kref)
1242{
1243 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1244
1245 usb_put_intf(to_usb_interface(hub->intfdev));
1246 kfree(hub);
1247}
1248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249static unsigned highspeed_hubs;
1250
1251static void hub_disconnect(struct usb_interface *intf)
1252{
1253 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Sterne8054852007-05-04 11:55:11 -04001254
1255 /* Take the hub off the event list and don't let it be added again */
1256 spin_lock_irq(&hub_event_lock);
Alan Stern8e4ceb32009-12-07 13:01:37 -05001257 if (!list_empty(&hub->event_list)) {
1258 list_del_init(&hub->event_list);
1259 usb_autopm_put_interface_no_suspend(intf);
1260 }
Alan Sterne8054852007-05-04 11:55:11 -04001261 hub->disconnected = 1;
1262 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
Alan Stern7de18d82006-06-01 13:37:24 -04001264 /* Disconnect all children and quiesce the hub */
1265 hub->error = 0;
Alan Stern43303542008-04-28 11:07:31 -04001266 hub_quiesce(hub, HUB_DISCONNECT);
Alan Stern7de18d82006-06-01 13:37:24 -04001267
Alan Stern8b28c752005-08-10 17:04:13 -04001268 usb_set_intfdata (intf, NULL);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001269 hub->hdev->maxchild = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
Alan Sterne8054852007-05-04 11:55:11 -04001271 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 highspeed_hubs--;
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 usb_free_urb(hub->urb);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001275 kfree(hub->port_owners);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001276 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001277 kfree(hub->status);
Alan Sternd697cdd2009-10-27 15:18:46 -04001278 kfree(hub->buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
Alan Sterne8054852007-05-04 11:55:11 -04001280 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281}
1282
1283static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1284{
1285 struct usb_host_interface *desc;
1286 struct usb_endpoint_descriptor *endpoint;
1287 struct usb_device *hdev;
1288 struct usb_hub *hub;
1289
1290 desc = intf->cur_altsetting;
1291 hdev = interface_to_usbdev(intf);
1292
Sarah Sharp0c9ffe02010-12-30 13:27:36 -08001293 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1294 * different from USB 2.0/1.1 device suspend, and unfortunately we
1295 * don't support it yet. So leave autosuspend disabled for USB 3.0
1296 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1297 * since that isn't a "real" hub.
1298 */
1299 if (!hub_is_superspeed(hdev) || !hdev->parent)
1300 usb_enable_autosuspend(hdev);
Alan Stern088f7fe2010-01-08 12:56:54 -05001301
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001302 if (hdev->level == MAX_TOPO_LEVEL) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001303 dev_err(&intf->dev,
1304 "Unsupported bus topology: hub nested too deep\n");
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001305 return -E2BIG;
1306 }
1307
David Brownell89ccbdc2006-04-02 10:18:09 -08001308#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1309 if (hdev->parent) {
1310 dev_warn(&intf->dev, "ignoring external hub\n");
1311 return -ENODEV;
1312 }
1313#endif
1314
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 /* Some hubs have a subclass of 1, which AFAICT according to the */
1316 /* specs is not defined, but it works */
1317 if ((desc->desc.bInterfaceSubClass != 0) &&
1318 (desc->desc.bInterfaceSubClass != 1)) {
1319descriptor_error:
1320 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1321 return -EIO;
1322 }
1323
1324 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1325 if (desc->desc.bNumEndpoints != 1)
1326 goto descriptor_error;
1327
1328 endpoint = &desc->endpoint[0].desc;
1329
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -07001330 /* If it's not an interrupt in endpoint, we'd better punt! */
1331 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 goto descriptor_error;
1333
1334 /* We found a hub */
1335 dev_info (&intf->dev, "USB hub found\n");
1336
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001337 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 if (!hub) {
1339 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1340 return -ENOMEM;
1341 }
1342
Alan Sterne8054852007-05-04 11:55:11 -04001343 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 INIT_LIST_HEAD(&hub->event_list);
1345 hub->intfdev = &intf->dev;
1346 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +00001347 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Stern8520f382008-09-22 14:44:26 -04001348 INIT_DELAYED_WORK(&hub->init_work, NULL);
Alan Sterne8054852007-05-04 11:55:11 -04001349 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
1351 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -05001352 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
1354 if (hdev->speed == USB_SPEED_HIGH)
1355 highspeed_hubs++;
1356
1357 if (hub_configure(hub, endpoint) >= 0)
1358 return 0;
1359
1360 hub_disconnect (intf);
1361 return -ENODEV;
1362}
1363
Andi Kleenc532b292010-06-01 23:04:41 +02001364/* No BKL needed */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365static int
1366hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1367{
1368 struct usb_device *hdev = interface_to_usbdev (intf);
1369
1370 /* assert ifno == 0 (part of hub spec) */
1371 switch (code) {
1372 case USBDEVFS_HUB_PORTINFO: {
1373 struct usbdevfs_hub_portinfo *info = user_data;
1374 int i;
1375
1376 spin_lock_irq(&device_state_lock);
1377 if (hdev->devnum <= 0)
1378 info->nports = 0;
1379 else {
1380 info->nports = hdev->maxchild;
1381 for (i = 0; i < info->nports; i++) {
1382 if (hdev->children[i] == NULL)
1383 info->port[i] = 0;
1384 else
1385 info->port[i] =
1386 hdev->children[i]->devnum;
1387 }
1388 }
1389 spin_unlock_irq(&device_state_lock);
1390
1391 return info->nports + 1;
1392 }
1393
1394 default:
1395 return -ENOSYS;
1396 }
1397}
1398
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001399/*
1400 * Allow user programs to claim ports on a hub. When a device is attached
1401 * to one of these "claimed" ports, the program will "own" the device.
1402 */
1403static int find_port_owner(struct usb_device *hdev, unsigned port1,
1404 void ***ppowner)
1405{
1406 if (hdev->state == USB_STATE_NOTATTACHED)
1407 return -ENODEV;
1408 if (port1 == 0 || port1 > hdev->maxchild)
1409 return -EINVAL;
1410
1411 /* This assumes that devices not managed by the hub driver
1412 * will always have maxchild equal to 0.
1413 */
1414 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1415 return 0;
1416}
1417
1418/* In the following three functions, the caller must hold hdev's lock */
1419int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1420{
1421 int rc;
1422 void **powner;
1423
1424 rc = find_port_owner(hdev, port1, &powner);
1425 if (rc)
1426 return rc;
1427 if (*powner)
1428 return -EBUSY;
1429 *powner = owner;
1430 return rc;
1431}
1432
1433int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1434{
1435 int rc;
1436 void **powner;
1437
1438 rc = find_port_owner(hdev, port1, &powner);
1439 if (rc)
1440 return rc;
1441 if (*powner != owner)
1442 return -ENOENT;
1443 *powner = NULL;
1444 return rc;
1445}
1446
1447void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1448{
1449 int n;
1450 void **powner;
1451
1452 n = find_port_owner(hdev, 1, &powner);
1453 if (n == 0) {
1454 for (; n < hdev->maxchild; (++n, ++powner)) {
1455 if (*powner == owner)
1456 *powner = NULL;
1457 }
1458 }
1459}
1460
1461/* The caller must hold udev's lock */
1462bool usb_device_is_owned(struct usb_device *udev)
1463{
1464 struct usb_hub *hub;
1465
1466 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1467 return false;
1468 hub = hdev_to_hub(udev->parent);
1469 return !!hub->port_owners[udev->portnum - 1];
1470}
1471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1474{
1475 int i;
1476
1477 for (i = 0; i < udev->maxchild; ++i) {
1478 if (udev->children[i])
1479 recursively_mark_NOTATTACHED(udev->children[i]);
1480 }
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001481 if (udev->state == USB_STATE_SUSPENDED)
Sarah Sharp15123002007-12-21 16:54:15 -08001482 udev->active_duration -= jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 udev->state = USB_STATE_NOTATTACHED;
1484}
1485
1486/**
1487 * usb_set_device_state - change a device's current state (usbcore, hcds)
1488 * @udev: pointer to device whose state should be changed
1489 * @new_state: new state value to be stored
1490 *
1491 * udev->state is _not_ fully protected by the device lock. Although
1492 * most transitions are made only while holding the lock, the state can
1493 * can change to USB_STATE_NOTATTACHED at almost any time. This
1494 * is so that devices can be marked as disconnected as soon as possible,
1495 * without having to wait for any semaphores to be released. As a result,
1496 * all changes to any device's state must be protected by the
1497 * device_state_lock spinlock.
1498 *
1499 * Once a device has been added to the device tree, all changes to its state
1500 * should be made using this routine. The state should _not_ be set directly.
1501 *
1502 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1503 * Otherwise udev->state is set to new_state, and if new_state is
1504 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1505 * to USB_STATE_NOTATTACHED.
1506 */
1507void usb_set_device_state(struct usb_device *udev,
1508 enum usb_device_state new_state)
1509{
1510 unsigned long flags;
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001511 int wakeup = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
1513 spin_lock_irqsave(&device_state_lock, flags);
1514 if (udev->state == USB_STATE_NOTATTACHED)
1515 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001516 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001517
1518 /* root hub wakeup capabilities are managed out-of-band
1519 * and may involve silicon errata ... ignore them here.
1520 */
1521 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001522 if (udev->state == USB_STATE_SUSPENDED
1523 || new_state == USB_STATE_SUSPENDED)
1524 ; /* No change to wakeup settings */
1525 else if (new_state == USB_STATE_CONFIGURED)
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001526 wakeup = udev->actconfig->desc.bmAttributes
1527 & USB_CONFIG_ATT_WAKEUP;
Alan Stern645daaa2006-08-30 15:47:02 -04001528 else
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001529 wakeup = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001530 }
Sarah Sharp15123002007-12-21 16:54:15 -08001531 if (udev->state == USB_STATE_SUSPENDED &&
1532 new_state != USB_STATE_SUSPENDED)
1533 udev->active_duration -= jiffies;
1534 else if (new_state == USB_STATE_SUSPENDED &&
1535 udev->state != USB_STATE_SUSPENDED)
1536 udev->active_duration += jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -04001537 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001538 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 recursively_mark_NOTATTACHED(udev);
1540 spin_unlock_irqrestore(&device_state_lock, flags);
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001541 if (wakeup >= 0)
1542 device_set_wakeup_capable(&udev->dev, wakeup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543}
David Vrabel6da9c992009-02-18 14:43:47 +00001544EXPORT_SYMBOL_GPL(usb_set_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001546/*
Alan Stern3b29b682011-02-22 09:53:41 -05001547 * Choose a device number.
1548 *
1549 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1550 * USB-2.0 buses they are also used as device addresses, however on
1551 * USB-3.0 buses the address is assigned by the controller hardware
1552 * and it usually is not the same as the device number.
1553 *
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001554 * WUSB devices are simple: they have no hubs behind, so the mapping
1555 * device <-> virtual port number becomes 1:1. Why? to simplify the
1556 * life of the device connection logic in
1557 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1558 * handshake we need to assign a temporary address in the unauthorized
1559 * space. For simplicity we use the first virtual port number found to
1560 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1561 * and that becomes it's address [X < 128] or its unauthorized address
1562 * [X | 0x80].
1563 *
1564 * We add 1 as an offset to the one-based USB-stack port number
1565 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1566 * 0 is reserved by USB for default address; (b) Linux's USB stack
1567 * uses always #1 for the root hub of the controller. So USB stack's
1568 * port #1, which is wusb virtual-port #0 has address #2.
Sarah Sharpc6515272009-04-27 19:57:26 -07001569 *
1570 * Devices connected under xHCI are not as simple. The host controller
1571 * supports virtualization, so the hardware assigns device addresses and
1572 * the HCD must setup data structures before issuing a set address
1573 * command to the hardware.
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001574 */
Alan Stern3b29b682011-02-22 09:53:41 -05001575static void choose_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576{
1577 int devnum;
1578 struct usb_bus *bus = udev->bus;
1579
1580 /* If khubd ever becomes multithreaded, this will need a lock */
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001581 if (udev->wusb) {
1582 devnum = udev->portnum + 1;
1583 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1584 } else {
1585 /* Try to allocate the next devnum beginning at
1586 * bus->devnum_next. */
1587 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1588 bus->devnum_next);
1589 if (devnum >= 128)
1590 devnum = find_next_zero_bit(bus->devmap.devicemap,
1591 128, 1);
1592 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 if (devnum < 128) {
1595 set_bit(devnum, bus->devmap.devicemap);
1596 udev->devnum = devnum;
1597 }
1598}
1599
Alan Stern3b29b682011-02-22 09:53:41 -05001600static void release_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601{
1602 if (udev->devnum > 0) {
1603 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1604 udev->devnum = -1;
1605 }
1606}
1607
Alan Stern3b29b682011-02-22 09:53:41 -05001608static void update_devnum(struct usb_device *udev, int devnum)
David Vrabel4953d142008-04-08 13:24:46 -07001609{
1610 /* The address for a WUSB device is managed by wusbcore. */
1611 if (!udev->wusb)
1612 udev->devnum = devnum;
1613}
1614
Herbert Xuf7410ce2010-01-10 20:15:03 +11001615static void hub_free_dev(struct usb_device *udev)
1616{
1617 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1618
1619 /* Root hubs aren't real devices, so don't free HCD resources */
1620 if (hcd->driver->free_dev && udev->parent)
1621 hcd->driver->free_dev(hcd, udev);
1622}
1623
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624/**
1625 * usb_disconnect - disconnect a device (usbcore-internal)
1626 * @pdev: pointer to device being disconnected
1627 * Context: !in_interrupt ()
1628 *
1629 * Something got disconnected. Get rid of it and all of its children.
1630 *
1631 * If *pdev is a normal device then the parent hub must already be locked.
1632 * If *pdev is a root hub then this routine will acquire the
1633 * usb_bus_list_lock on behalf of the caller.
1634 *
1635 * Only hub drivers (including virtual root hub drivers for host
1636 * controllers) should ever call this.
1637 *
1638 * This call is synchronous, and may not be used in an interrupt context.
1639 */
1640void usb_disconnect(struct usb_device **pdev)
1641{
1642 struct usb_device *udev = *pdev;
1643 int i;
1644
1645 if (!udev) {
Harvey Harrison441b62c2008-03-03 16:08:34 -08001646 pr_debug ("%s nodev\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 return;
1648 }
1649
1650 /* mark the device as inactive, so any further urb submissions for
1651 * this device (and any of its children) will fail immediately.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001652 * this quiesces everything except pending urbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 */
1654 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern3b29b682011-02-22 09:53:41 -05001655 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1656 udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001658 usb_lock_device(udev);
1659
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 /* Free up all the children before we remove this device */
1661 for (i = 0; i < USB_MAXCHILDREN; i++) {
1662 if (udev->children[i])
1663 usb_disconnect(&udev->children[i]);
1664 }
1665
1666 /* deallocate hcd/hardware state ... nuking all pending urbs and
1667 * cleaning up all state associated with the current configuration
1668 * so that the hardware is now fully quiesced.
1669 */
Alan Stern782da722006-07-01 22:09:35 -04001670 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 usb_disable_device(udev, 0);
Alan Sterncde217a2008-10-21 15:28:46 -04001672 usb_hcd_synchronize_unlinks(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
Alan Stern3b23dd62008-12-05 14:10:34 -05001674 usb_remove_ep_devs(&udev->ep0);
Alan Stern782da722006-07-01 22:09:35 -04001675 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001676
Alan Stern782da722006-07-01 22:09:35 -04001677 /* Unregister the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05001678 * for de-configuring the device and invoking the remove-device
1679 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04001680 */
1681 device_del(&udev->dev);
1682
1683 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 * (or root_hub) pointer.
1685 */
Alan Stern3b29b682011-02-22 09:53:41 -05001686 release_devnum(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
1688 /* Avoid races with recursively_mark_NOTATTACHED() */
1689 spin_lock_irq(&device_state_lock);
1690 *pdev = NULL;
1691 spin_unlock_irq(&device_state_lock);
1692
Herbert Xuf7410ce2010-01-10 20:15:03 +11001693 hub_free_dev(udev);
1694
Alan Stern782da722006-07-01 22:09:35 -04001695 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696}
1697
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001698#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699static void show_string(struct usb_device *udev, char *id, char *string)
1700{
1701 if (!string)
1702 return;
1703 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1704}
1705
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001706static void announce_device(struct usb_device *udev)
1707{
1708 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1709 le16_to_cpu(udev->descriptor.idVendor),
1710 le16_to_cpu(udev->descriptor.idProduct));
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001711 dev_info(&udev->dev,
1712 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001713 udev->descriptor.iManufacturer,
1714 udev->descriptor.iProduct,
1715 udev->descriptor.iSerialNumber);
1716 show_string(udev, "Product", udev->product);
1717 show_string(udev, "Manufacturer", udev->manufacturer);
1718 show_string(udev, "SerialNumber", udev->serial);
1719}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720#else
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001721static inline void announce_device(struct usb_device *udev) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722#endif
1723
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724#ifdef CONFIG_USB_OTG
1725#include "otg_whitelist.h"
1726#endif
1727
Oliver Neukum3ede7602007-01-11 14:35:50 +01001728/**
Alan Stern8d8558d2009-12-08 15:50:41 -05001729 * usb_enumerate_device_otg - FIXME (usbcore-internal)
Oliver Neukum3ede7602007-01-11 14:35:50 +01001730 * @udev: newly addressed device (in ADDRESS state)
1731 *
Alan Stern8d8558d2009-12-08 15:50:41 -05001732 * Finish enumeration for On-The-Go devices
Oliver Neukum3ede7602007-01-11 14:35:50 +01001733 */
Alan Stern8d8558d2009-12-08 15:50:41 -05001734static int usb_enumerate_device_otg(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735{
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001736 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738#ifdef CONFIG_USB_OTG
1739 /*
1740 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1741 * to wake us after we've powered off VBUS; and HNP, switching roles
1742 * "host" to "peripheral". The OTG descriptor helps figure this out.
1743 */
1744 if (!udev->bus->is_b_host
1745 && udev->config
1746 && udev->parent == udev->bus->root_hub) {
Felipe Balbi2eb50522009-12-04 15:47:43 +02001747 struct usb_otg_descriptor *desc = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 struct usb_bus *bus = udev->bus;
1749
1750 /* descriptor may appear anywhere in config */
1751 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1752 le16_to_cpu(udev->config[0].desc.wTotalLength),
1753 USB_DT_OTG, (void **) &desc) == 0) {
1754 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001755 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001756
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 dev_info(&udev->dev,
1758 "Dual-Role OTG device on %sHNP port\n",
1759 (port1 == bus->otg_port)
1760 ? "" : "non-");
1761
1762 /* enable HNP before suspend, it's simpler */
1763 if (port1 == bus->otg_port)
1764 bus->b_hnp_enable = 1;
1765 err = usb_control_msg(udev,
1766 usb_sndctrlpipe(udev, 0),
1767 USB_REQ_SET_FEATURE, 0,
1768 bus->b_hnp_enable
1769 ? USB_DEVICE_B_HNP_ENABLE
1770 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1771 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1772 if (err < 0) {
1773 /* OTG MESSAGE: report errors here,
1774 * customize to match your product.
1775 */
1776 dev_info(&udev->dev,
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001777 "can't set HNP mode: %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 err);
1779 bus->b_hnp_enable = 0;
1780 }
1781 }
1782 }
1783 }
1784
1785 if (!is_targeted(udev)) {
1786
1787 /* Maybe it can talk to us, though we can't talk to it.
1788 * (Includes HNP test device.)
1789 */
1790 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell634a84f2009-01-15 13:51:28 -08001791 err = usb_port_suspend(udev, PMSG_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 if (err < 0)
1793 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1794 }
Vikram Panditaffcdc182007-05-25 21:31:07 -07001795 err = -ENOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 goto fail;
1797 }
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001798fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799#endif
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001800 return err;
1801}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001803
1804/**
Alan Stern8d8558d2009-12-08 15:50:41 -05001805 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001806 * @udev: newly addressed device (in ADDRESS state)
1807 *
1808 * This is only called by usb_new_device() and usb_authorize_device()
1809 * and FIXME -- all comments that apply to them apply here wrt to
1810 * environment.
1811 *
1812 * If the device is WUSB and not authorized, we don't attempt to read
1813 * the string descriptors, as they will be errored out by the device
1814 * until it has been authorized.
1815 */
Alan Stern8d8558d2009-12-08 15:50:41 -05001816static int usb_enumerate_device(struct usb_device *udev)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001817{
1818 int err;
1819
1820 if (udev->config == NULL) {
1821 err = usb_get_configuration(udev);
1822 if (err < 0) {
1823 dev_err(&udev->dev, "can't read configurations, error %d\n",
1824 err);
1825 goto fail;
1826 }
1827 }
1828 if (udev->wusb == 1 && udev->authorized == 0) {
1829 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1830 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1831 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1832 }
1833 else {
1834 /* read the standard strings and cache them if present */
1835 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1836 udev->manufacturer = usb_cache_string(udev,
1837 udev->descriptor.iManufacturer);
1838 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1839 }
Alan Stern8d8558d2009-12-08 15:50:41 -05001840 err = usb_enumerate_device_otg(udev);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001841fail:
1842 return err;
1843}
1844
1845
1846/**
1847 * usb_new_device - perform initial device setup (usbcore-internal)
1848 * @udev: newly addressed device (in ADDRESS state)
1849 *
Alan Stern8d8558d2009-12-08 15:50:41 -05001850 * This is called with devices which have been detected but not fully
1851 * enumerated. The device descriptor is available, but not descriptors
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001852 * for any device configuration. The caller must have locked either
1853 * the parent hub (if udev is a normal device) or else the
1854 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1855 * udev has already been installed, but udev is not yet visible through
1856 * sysfs or other filesystem code.
1857 *
1858 * It will return if the device is configured properly or not. Zero if
1859 * the interface was registered with the driver core; else a negative
1860 * errno value.
1861 *
1862 * This call is synchronous, and may not be used in an interrupt context.
1863 *
1864 * Only the hub driver or root-hub registrar should ever call this.
1865 */
1866int usb_new_device(struct usb_device *udev)
1867{
1868 int err;
1869
Dan Streetman16985402010-01-06 09:56:53 -05001870 if (udev->parent) {
Dan Streetman16985402010-01-06 09:56:53 -05001871 /* Initialize non-root-hub device wakeup to disabled;
1872 * device (un)configuration controls wakeup capable
1873 * sysfs power/wakeup controls wakeup enabled/disabled
1874 */
1875 device_init_wakeup(&udev->dev, 0);
Dan Streetman16985402010-01-06 09:56:53 -05001876 }
1877
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001878 /* Tell the runtime-PM framework the device is active */
1879 pm_runtime_set_active(&udev->dev);
Alan Sternc08512c2010-11-15 15:57:58 -05001880 pm_runtime_get_noresume(&udev->dev);
Alan Sternfcc4a012010-11-15 15:57:51 -05001881 pm_runtime_use_autosuspend(&udev->dev);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001882 pm_runtime_enable(&udev->dev);
1883
Alan Sternc08512c2010-11-15 15:57:58 -05001884 /* By default, forbid autosuspend for all devices. It will be
1885 * allowed for hubs during binding.
1886 */
1887 usb_disable_autosuspend(udev);
1888
Alan Stern8d8558d2009-12-08 15:50:41 -05001889 err = usb_enumerate_device(udev); /* Read descriptors */
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001890 if (err < 0)
1891 goto fail;
Sarah Sharpc6515272009-04-27 19:57:26 -07001892 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1893 udev->devnum, udev->bus->busnum,
1894 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001895 /* export the usbdev device-node for libusb */
1896 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1897 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1898
Alan Stern6cd13202008-11-13 15:08:30 -05001899 /* Tell the world! */
1900 announce_device(udev);
Alan Stern195af2c2007-07-16 15:28:19 -04001901
Rafael J. Wysocki927bc912010-02-08 19:18:16 +01001902 device_enable_async_suspend(&udev->dev);
Alan Stern782da722006-07-01 22:09:35 -04001903 /* Register the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05001904 * for configuring the device and invoking the add-device
1905 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04001906 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001907 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 if (err) {
1909 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1910 goto fail;
1911 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001912
Alan Stern3b23dd62008-12-05 14:10:34 -05001913 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
Alan Sternc08512c2010-11-15 15:57:58 -05001914 usb_mark_last_busy(udev);
1915 pm_runtime_put_sync_autosuspend(&udev->dev);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001916 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
1918fail:
1919 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001920 pm_runtime_disable(&udev->dev);
1921 pm_runtime_set_suspended(&udev->dev);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001922 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923}
1924
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001925
1926/**
Randy Dunlapfd39c862007-10-15 17:30:02 -07001927 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1928 * @usb_dev: USB device
1929 *
1930 * Move the USB device to a very basic state where interfaces are disabled
1931 * and the device is in fact unconfigured and unusable.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001932 *
1933 * We share a lock (that we have) with device_del(), so we need to
1934 * defer its call.
1935 */
1936int usb_deauthorize_device(struct usb_device *usb_dev)
1937{
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001938 usb_lock_device(usb_dev);
1939 if (usb_dev->authorized == 0)
1940 goto out_unauthorized;
Alan Sternda307122009-12-08 15:54:44 -05001941
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001942 usb_dev->authorized = 0;
1943 usb_set_configuration(usb_dev, -1);
Alan Sternda307122009-12-08 15:54:44 -05001944
1945 kfree(usb_dev->product);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001946 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
Alan Sternda307122009-12-08 15:54:44 -05001947 kfree(usb_dev->manufacturer);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001948 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
Alan Sternda307122009-12-08 15:54:44 -05001949 kfree(usb_dev->serial);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001950 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
Alan Sternda307122009-12-08 15:54:44 -05001951
1952 usb_destroy_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001953 usb_dev->descriptor.bNumConfigurations = 0;
Alan Sternda307122009-12-08 15:54:44 -05001954
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001955out_unauthorized:
1956 usb_unlock_device(usb_dev);
1957 return 0;
1958}
1959
1960
1961int usb_authorize_device(struct usb_device *usb_dev)
1962{
1963 int result = 0, c;
Alan Sternda307122009-12-08 15:54:44 -05001964
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001965 usb_lock_device(usb_dev);
1966 if (usb_dev->authorized == 1)
1967 goto out_authorized;
Alan Sternda307122009-12-08 15:54:44 -05001968
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001969 result = usb_autoresume_device(usb_dev);
1970 if (result < 0) {
1971 dev_err(&usb_dev->dev,
1972 "can't autoresume for authorization: %d\n", result);
1973 goto error_autoresume;
1974 }
1975 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1976 if (result < 0) {
1977 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1978 "authorization: %d\n", result);
1979 goto error_device_descriptor;
1980 }
Alan Sternda307122009-12-08 15:54:44 -05001981
1982 kfree(usb_dev->product);
1983 usb_dev->product = NULL;
1984 kfree(usb_dev->manufacturer);
1985 usb_dev->manufacturer = NULL;
1986 kfree(usb_dev->serial);
1987 usb_dev->serial = NULL;
1988
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001989 usb_dev->authorized = 1;
Alan Stern8d8558d2009-12-08 15:50:41 -05001990 result = usb_enumerate_device(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001991 if (result < 0)
Alan Stern8d8558d2009-12-08 15:50:41 -05001992 goto error_enumerate;
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001993 /* Choose and set the configuration. This registers the interfaces
1994 * with the driver core and lets interface drivers bind to them.
1995 */
Greg Kroah-Hartmanb5ea0602007-08-02 22:44:27 -06001996 c = usb_choose_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001997 if (c >= 0) {
1998 result = usb_set_configuration(usb_dev, c);
1999 if (result) {
2000 dev_err(&usb_dev->dev,
2001 "can't set config #%d, error %d\n", c, result);
2002 /* This need not be fatal. The user can try to
2003 * set other configurations. */
2004 }
2005 }
2006 dev_info(&usb_dev->dev, "authorized to connect\n");
Alan Sternda307122009-12-08 15:54:44 -05002007
Alan Stern8d8558d2009-12-08 15:50:41 -05002008error_enumerate:
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002009error_device_descriptor:
Alan Sternda307122009-12-08 15:54:44 -05002010 usb_autosuspend_device(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002011error_autoresume:
2012out_authorized:
2013 usb_unlock_device(usb_dev); // complements locktree
2014 return result;
2015}
2016
2017
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002018/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2019static unsigned hub_is_wusb(struct usb_hub *hub)
2020{
2021 struct usb_hcd *hcd;
2022 if (hub->hdev->parent != NULL) /* not a root hub? */
2023 return 0;
2024 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2025 return hcd->wireless;
2026}
2027
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029#define PORT_RESET_TRIES 5
2030#define SET_ADDRESS_TRIES 2
2031#define GET_DESCRIPTOR_TRIES 2
2032#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2033#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2034
2035#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2036#define HUB_SHORT_RESET_TIME 10
2037#define HUB_LONG_RESET_TIME 200
2038#define HUB_RESET_TIMEOUT 500
2039
2040static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2041 struct usb_device *udev, unsigned int delay)
2042{
2043 int delay_time, ret;
2044 u16 portstatus;
2045 u16 portchange;
2046
2047 for (delay_time = 0;
2048 delay_time < HUB_RESET_TIMEOUT;
2049 delay_time += delay) {
2050 /* wait to give the device a chance to reset */
2051 msleep(delay);
2052
2053 /* read and decode port status */
2054 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2055 if (ret < 0)
2056 return ret;
2057
2058 /* Device went away? */
2059 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2060 return -ENOTCONN;
2061
Alan Sterndd4dd192007-05-04 11:55:54 -04002062 /* bomb out completely if the connection bounced */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 if ((portchange & USB_PORT_STAT_C_CONNECTION))
Alan Sterndd4dd192007-05-04 11:55:54 -04002064 return -ENOTCONN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066 /* if we`ve finished resetting, then break out of the loop */
2067 if (!(portstatus & USB_PORT_STAT_RESET) &&
2068 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002069 if (hub_is_wusb(hub))
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -08002070 udev->speed = USB_SPEED_WIRELESS;
Sarah Sharp131dec32010-12-06 21:00:19 -08002071 else if (hub_is_superspeed(hub->hdev))
Sarah Sharp809cd1c2010-07-09 17:08:48 +02002072 udev->speed = USB_SPEED_SUPER;
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002073 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 udev->speed = USB_SPEED_HIGH;
2075 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2076 udev->speed = USB_SPEED_LOW;
2077 else
2078 udev->speed = USB_SPEED_FULL;
2079 return 0;
2080 }
2081
2082 /* switch to the long delay after two short delay failures */
2083 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2084 delay = HUB_LONG_RESET_TIME;
2085
2086 dev_dbg (hub->intfdev,
2087 "port %d not reset yet, waiting %dms\n",
2088 port1, delay);
2089 }
2090
2091 return -EBUSY;
2092}
2093
2094static int hub_port_reset(struct usb_hub *hub, int port1,
2095 struct usb_device *udev, unsigned int delay)
2096{
2097 int i, status;
Sarah Sharpa5f0efa2009-12-09 15:59:17 -08002098 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
Sarah Sharpa5f0efa2009-12-09 15:59:17 -08002100 hcd = bus_to_hcd(udev->bus);
Alan Stern32fe0192007-10-10 16:27:07 -04002101 /* Block EHCI CF initialization during the port reset.
2102 * Some companion controllers don't like it when they mix.
2103 */
2104 down_read(&ehci_cf_port_reset_rwsem);
2105
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 /* Reset the port */
2107 for (i = 0; i < PORT_RESET_TRIES; i++) {
2108 status = set_port_feature(hub->hdev,
2109 port1, USB_PORT_FEAT_RESET);
2110 if (status)
2111 dev_err(hub->intfdev,
2112 "cannot reset port %d (err = %d)\n",
2113 port1, status);
2114 else {
2115 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07002116 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 dev_dbg(hub->intfdev,
2118 "port_wait_reset: err = %d\n",
2119 status);
2120 }
2121
2122 /* return on disconnect or reset */
2123 switch (status) {
2124 case 0:
David Brownellb7896962005-08-31 10:41:44 -07002125 /* TRSTRCY = 10 ms; plus some extra */
2126 msleep(10 + 40);
Alan Stern3b29b682011-02-22 09:53:41 -05002127 update_devnum(udev, 0);
Sarah Sharpa5f0efa2009-12-09 15:59:17 -08002128 if (hcd->driver->reset_device) {
2129 status = hcd->driver->reset_device(hcd, udev);
2130 if (status < 0) {
2131 dev_err(&udev->dev, "Cannot reset "
2132 "HCD device state\n");
2133 break;
2134 }
2135 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 /* FALL THROUGH */
2137 case -ENOTCONN:
2138 case -ENODEV:
2139 clear_port_feature(hub->hdev,
2140 port1, USB_PORT_FEAT_C_RESET);
2141 /* FIXME need disconnect() for NOTATTACHED device */
2142 usb_set_device_state(udev, status
2143 ? USB_STATE_NOTATTACHED
2144 : USB_STATE_DEFAULT);
Alan Stern32fe0192007-10-10 16:27:07 -04002145 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 }
2147
2148 dev_dbg (hub->intfdev,
2149 "port %d not enabled, trying reset again...\n",
2150 port1);
2151 delay = HUB_LONG_RESET_TIME;
2152 }
2153
2154 dev_err (hub->intfdev,
2155 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2156 port1);
2157
Alan Stern32fe0192007-10-10 16:27:07 -04002158 done:
2159 up_read(&ehci_cf_port_reset_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 return status;
2161}
2162
Alan Sternd388dab2006-07-01 22:14:24 -04002163#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164
Alan Sternb01b03f2008-04-28 11:06:11 -04002165#define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2166 USB_PORT_STAT_SUSPEND)
2167#define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2168
2169/* Determine whether the device on a port is ready for a normal resume,
2170 * is ready for a reset-resume, or should be disconnected.
2171 */
2172static int check_port_resume_type(struct usb_device *udev,
2173 struct usb_hub *hub, int port1,
2174 int status, unsigned portchange, unsigned portstatus)
2175{
2176 /* Is the device still present? */
2177 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2178 if (status >= 0)
2179 status = -ENODEV;
2180 }
2181
Alan Stern86c57ed2008-06-30 11:14:43 -04002182 /* Can't do a normal resume if the port isn't enabled,
2183 * so try a reset-resume instead.
2184 */
2185 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2186 if (udev->persist_enabled)
2187 udev->reset_resume = 1;
2188 else
2189 status = -ENODEV;
2190 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002191
2192 if (status) {
2193 dev_dbg(hub->intfdev,
2194 "port %d status %04x.%04x after resume, %d\n",
2195 port1, portchange, portstatus, status);
2196 } else if (udev->reset_resume) {
2197
2198 /* Late port handoff can set status-change bits */
2199 if (portchange & USB_PORT_STAT_C_CONNECTION)
2200 clear_port_feature(hub->hdev, port1,
2201 USB_PORT_FEAT_C_CONNECTION);
2202 if (portchange & USB_PORT_STAT_C_ENABLE)
2203 clear_port_feature(hub->hdev, port1,
2204 USB_PORT_FEAT_C_ENABLE);
2205 }
2206
2207 return status;
2208}
2209
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210#ifdef CONFIG_USB_SUSPEND
2211
2212/*
Alan Stern140d8f62006-07-01 22:07:21 -04002213 * usb_port_suspend - suspend a usb device's upstream port
Alan Stern624d6c02007-05-30 15:35:16 -04002214 * @udev: device that's no longer in active use, not a root hub
David Brownell5edbfb72005-09-22 22:45:26 -07002215 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 *
2217 * Suspends a USB device that isn't in active use, conserving power.
2218 * Devices may wake out of a suspend, if anything important happens,
2219 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04002220 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 * to disconnect devices while they are suspended.
2222 *
David Brownell390a8c32005-09-13 19:57:27 -07002223 * This only affects the USB hardware for a device; its interfaces
2224 * (and, for hubs, child devices) must already have been suspended.
2225 *
Alan Stern624d6c02007-05-30 15:35:16 -04002226 * Selective port suspend reduces power; most suspended devices draw
2227 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2228 * All devices below the suspended port are also suspended.
2229 *
2230 * Devices leave suspend state when the host wakes them up. Some devices
2231 * also support "remote wakeup", where the device can activate the USB
2232 * tree above them to deliver data, such as a keypress or packet. In
2233 * some cases, this wakes the USB host.
2234 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 * Suspending OTG devices may trigger HNP, if that's been enabled
2236 * between a pair of dual-role devices. That will change roles, such
2237 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2238 *
Alan Stern4956ecc2007-05-30 16:51:28 -04002239 * Devices on USB hub ports have only one "suspend" state, corresponding
2240 * to ACPI D2, "may cause the device to lose some context".
2241 * State transitions include:
2242 *
2243 * - suspend, resume ... when the VBUS power link stays live
2244 * - suspend, disconnect ... VBUS lost
2245 *
2246 * Once VBUS drop breaks the circuit, the port it's using has to go through
2247 * normal re-enumeration procedures, starting with enabling VBUS power.
2248 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2249 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2250 * timer, no SRP, no requests through sysfs.
2251 *
2252 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2253 * the root hub for their bus goes into global suspend ... so we don't
2254 * (falsely) update the device power state to say it suspended.
2255 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 * Returns 0 on success, else negative errno.
2257 */
Alan Stern65bfd292008-11-25 16:39:18 -05002258int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259{
Alan Stern624d6c02007-05-30 15:35:16 -04002260 struct usb_hub *hub = hdev_to_hub(udev->parent);
2261 int port1 = udev->portnum;
2262 int status;
Alan Stern4956ecc2007-05-30 16:51:28 -04002263
Alan Stern624d6c02007-05-30 15:35:16 -04002264 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2265
2266 /* enable remote wakeup when appropriate; this lets the device
2267 * wake up the upstream hub (including maybe the root hub).
2268 *
2269 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2270 * we don't explicitly enable it here.
2271 */
2272 if (udev->do_remote_wakeup) {
2273 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2274 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2275 USB_DEVICE_REMOTE_WAKEUP, 0,
2276 NULL, 0,
2277 USB_CTRL_SET_TIMEOUT);
Oliver Neukum0c487202009-10-19 13:19:41 +02002278 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04002279 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2280 status);
Oliver Neukum0c487202009-10-19 13:19:41 +02002281 /* bail if autosuspend is requested */
2282 if (msg.event & PM_EVENT_AUTO)
2283 return status;
2284 }
Alan Stern624d6c02007-05-30 15:35:16 -04002285 }
2286
2287 /* see 7.1.7.6 */
Andiry Xua8f08d82011-03-31 14:56:50 +08002288 /* Clear PORT_POWER if it's a USB3.0 device connected to USB 3.0
2289 * external hub.
2290 * FIXME: this is a temporary workaround to make the system able
2291 * to suspend/resume.
2292 */
2293 if ((hub->hdev->parent != NULL) && hub_is_superspeed(hub->hdev))
2294 status = clear_port_feature(hub->hdev, port1,
2295 USB_PORT_FEAT_POWER);
2296 else
2297 status = set_port_feature(hub->hdev, port1,
2298 USB_PORT_FEAT_SUSPEND);
Alan Stern624d6c02007-05-30 15:35:16 -04002299 if (status) {
2300 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2301 port1, status);
2302 /* paranoia: "should not happen" */
Oliver Neukum0c487202009-10-19 13:19:41 +02002303 if (udev->do_remote_wakeup)
2304 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
Alan Stern624d6c02007-05-30 15:35:16 -04002305 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2306 USB_DEVICE_REMOTE_WAKEUP, 0,
2307 NULL, 0,
2308 USB_CTRL_SET_TIMEOUT);
2309 } else {
2310 /* device has up to 10 msec to fully suspend */
2311 dev_dbg(&udev->dev, "usb %ssuspend\n",
Alan Stern65bfd292008-11-25 16:39:18 -05002312 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
Alan Stern624d6c02007-05-30 15:35:16 -04002313 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2314 msleep(10);
2315 }
Alan Sternc08512c2010-11-15 15:57:58 -05002316 usb_mark_last_busy(hub->hdev);
Alan Stern4956ecc2007-05-30 16:51:28 -04002317 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318}
David Brownellf3f32532005-09-22 22:37:29 -07002319
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320/*
David Brownell390a8c32005-09-13 19:57:27 -07002321 * If the USB "suspend" state is in use (rather than "global suspend"),
2322 * many devices will be individually taken out of suspend state using
Alan Stern54515fe2007-05-30 15:38:58 -04002323 * special "resume" signaling. This routine kicks in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 * hardware resume signaling is finished, either because of selective
2325 * resume (by host) or remote wakeup (by device) ... now see what changed
2326 * in the tree that's rooted at this device.
Alan Stern54515fe2007-05-30 15:38:58 -04002327 *
2328 * If @udev->reset_resume is set then the device is reset before the
2329 * status check is done.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 */
Alan Stern140d8f62006-07-01 22:07:21 -04002331static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332{
Alan Stern54515fe2007-05-30 15:38:58 -04002333 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 u16 devstatus;
2335
2336 /* caller owns the udev device lock */
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002337 dev_dbg(&udev->dev, "%s\n",
2338 udev->reset_resume ? "finish reset-resume" : "finish resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339
2340 /* usb ch9 identifies four variants of SUSPENDED, based on what
2341 * state the device resumes to. Linux currently won't see the
2342 * first two on the host side; they'd be inside hub_port_init()
2343 * during many timeouts, but khubd can't suspend until later.
2344 */
2345 usb_set_device_state(udev, udev->actconfig
2346 ? USB_STATE_CONFIGURED
2347 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348
Alan Stern54515fe2007-05-30 15:38:58 -04002349 /* 10.5.4.5 says not to reset a suspended port if the attached
2350 * device is enabled for remote wakeup. Hence the reset
2351 * operation is carried out here, after the port has been
2352 * resumed.
2353 */
2354 if (udev->reset_resume)
Alan Stern86c57ed2008-06-30 11:14:43 -04002355 retry_reset_resume:
Ming Lei742120c2008-06-18 22:00:29 +08002356 status = usb_reset_and_verify_device(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04002357
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 /* 10.5.4.5 says be sure devices in the tree are still there.
2359 * For now let's assume the device didn't go crazy on resume,
2360 * and device drivers will know about any resume quirks.
2361 */
Alan Stern54515fe2007-05-30 15:38:58 -04002362 if (status == 0) {
Alan Stern46dede42007-08-14 10:56:10 -04002363 devstatus = 0;
Alan Stern54515fe2007-05-30 15:38:58 -04002364 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2365 if (status >= 0)
Alan Stern46dede42007-08-14 10:56:10 -04002366 status = (status > 0 ? 0 : -ENODEV);
Alan Stern86c57ed2008-06-30 11:14:43 -04002367
2368 /* If a normal resume failed, try doing a reset-resume */
2369 if (status && !udev->reset_resume && udev->persist_enabled) {
2370 dev_dbg(&udev->dev, "retry with reset-resume\n");
2371 udev->reset_resume = 1;
2372 goto retry_reset_resume;
2373 }
Alan Stern54515fe2007-05-30 15:38:58 -04002374 }
Alan Sternb40b7a92006-06-19 15:12:38 -04002375
Alan Stern624d6c02007-05-30 15:35:16 -04002376 if (status) {
2377 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2378 status);
2379 } else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380 le16_to_cpus(&devstatus);
Alan Stern686314c2007-05-30 15:34:36 -04002381 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 status = usb_control_msg(udev,
2383 usb_sndctrlpipe(udev, 0),
2384 USB_REQ_CLEAR_FEATURE,
2385 USB_RECIP_DEVICE,
2386 USB_DEVICE_REMOTE_WAKEUP, 0,
2387 NULL, 0,
2388 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04002389 if (status)
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002390 dev_dbg(&udev->dev,
2391 "disable remote wakeup, status %d\n",
2392 status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05002393 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 }
2396 return status;
2397}
2398
Alan Stern624d6c02007-05-30 15:35:16 -04002399/*
2400 * usb_port_resume - re-activate a suspended usb device's upstream port
2401 * @udev: device to re-activate, not a root hub
2402 * Context: must be able to sleep; device not locked; pm locks held
2403 *
2404 * This will re-activate the suspended device, increasing power usage
2405 * while letting drivers communicate again with its endpoints.
2406 * USB resume explicitly guarantees that the power session between
2407 * the host and the device is the same as it was when the device
2408 * suspended.
2409 *
Alan Sternfeccc302008-03-03 15:15:59 -05002410 * If @udev->reset_resume is set then this routine won't check that the
2411 * port is still enabled. Furthermore, finish_port_resume() above will
Alan Stern54515fe2007-05-30 15:38:58 -04002412 * reset @udev. The end result is that a broken power session can be
2413 * recovered and @udev will appear to persist across a loss of VBUS power.
2414 *
2415 * For example, if a host controller doesn't maintain VBUS suspend current
2416 * during a system sleep or is reset when the system wakes up, all the USB
2417 * power sessions below it will be broken. This is especially troublesome
2418 * for mass-storage devices containing mounted filesystems, since the
2419 * device will appear to have disconnected and all the memory mappings
2420 * to it will be lost. Using the USB_PERSIST facility, the device can be
2421 * made to appear as if it had not disconnected.
2422 *
Ming Lei742120c2008-06-18 22:00:29 +08002423 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
Alan Sternfeccc302008-03-03 15:15:59 -05002424 * every effort to insure that the same device is present after the
Alan Stern54515fe2007-05-30 15:38:58 -04002425 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2426 * quite possible for a device to remain unaltered but its media to be
2427 * changed. If the user replaces a flash memory card while the system is
2428 * asleep, he will have only himself to blame when the filesystem on the
2429 * new card is corrupted and the system crashes.
2430 *
Alan Stern624d6c02007-05-30 15:35:16 -04002431 * Returns 0 on success, else negative errno.
2432 */
Alan Stern65bfd292008-11-25 16:39:18 -05002433int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434{
Alan Stern624d6c02007-05-30 15:35:16 -04002435 struct usb_hub *hub = hdev_to_hub(udev->parent);
2436 int port1 = udev->portnum;
2437 int status;
2438 u16 portchange, portstatus;
Alan Sternd25450c2006-11-20 11:14:30 -05002439
2440 /* Skip the initial Clear-Suspend step for a remote wakeup */
2441 status = hub_port_status(hub, port1, &portstatus, &portchange);
2442 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2443 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444
2445 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2446
Alan Sternd5cbad42006-08-11 16:52:39 -04002447 set_bit(port1, hub->busy_bits);
2448
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 /* see 7.1.7.7; affects power usage, but not budgeting */
2450 status = clear_port_feature(hub->hdev,
2451 port1, USB_PORT_FEAT_SUSPEND);
2452 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04002453 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2454 port1, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 /* drive resume for at least 20 msec */
Alan Stern686314c2007-05-30 15:34:36 -04002457 dev_dbg(&udev->dev, "usb %sresume\n",
Alan Stern65bfd292008-11-25 16:39:18 -05002458 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 msleep(25);
2460
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2462 * stop resume signaling. Then finish the resume
2463 * sequence.
2464 */
Alan Sternd25450c2006-11-20 11:14:30 -05002465 status = hub_port_status(hub, port1, &portstatus, &portchange);
Alan Stern54515fe2007-05-30 15:38:58 -04002466
Alan Sternb01b03f2008-04-28 11:06:11 -04002467 /* TRSMRCY = 10 msec */
2468 msleep(10);
2469 }
Alan Stern54515fe2007-05-30 15:38:58 -04002470
Alan Sternb01b03f2008-04-28 11:06:11 -04002471 SuspendCleared:
2472 if (status == 0) {
2473 if (portchange & USB_PORT_STAT_C_SUSPEND)
2474 clear_port_feature(hub->hdev, port1,
2475 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477
Alan Sternd5cbad42006-08-11 16:52:39 -04002478 clear_bit(port1, hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04002479
Alan Sternb01b03f2008-04-28 11:06:11 -04002480 status = check_port_resume_type(udev,
2481 hub, port1, status, portchange, portstatus);
Alan Stern54515fe2007-05-30 15:38:58 -04002482 if (status == 0)
2483 status = finish_port_resume(udev);
2484 if (status < 0) {
2485 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2486 hub_port_logical_disconnect(hub, port1);
2487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 return status;
2489}
2490
Alan Stern8808f002008-04-28 11:06:55 -04002491/* caller has locked udev */
Alan Stern0534d462010-01-08 12:56:30 -05002492int usb_remote_wakeup(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493{
2494 int status = 0;
2495
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04002497 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002498 status = usb_autoresume_device(udev);
2499 if (status == 0) {
2500 /* Let the drivers do their thing, then... */
2501 usb_autosuspend_device(udev);
2502 }
Alan Sternd25450c2006-11-20 11:14:30 -05002503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 return status;
2505}
2506
Alan Sternd388dab2006-07-01 22:14:24 -04002507#else /* CONFIG_USB_SUSPEND */
2508
2509/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2510
Alan Stern65bfd292008-11-25 16:39:18 -05002511int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Alan Sternd388dab2006-07-01 22:14:24 -04002512{
2513 return 0;
2514}
2515
Alan Sternb01b03f2008-04-28 11:06:11 -04002516/* However we may need to do a reset-resume */
2517
Alan Stern65bfd292008-11-25 16:39:18 -05002518int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Alan Sternd388dab2006-07-01 22:14:24 -04002519{
Alan Sternb01b03f2008-04-28 11:06:11 -04002520 struct usb_hub *hub = hdev_to_hub(udev->parent);
2521 int port1 = udev->portnum;
2522 int status;
2523 u16 portchange, portstatus;
Alan Stern54515fe2007-05-30 15:38:58 -04002524
Alan Sternb01b03f2008-04-28 11:06:11 -04002525 status = hub_port_status(hub, port1, &portstatus, &portchange);
2526 status = check_port_resume_type(udev,
2527 hub, port1, status, portchange, portstatus);
2528
2529 if (status) {
2530 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2531 hub_port_logical_disconnect(hub, port1);
2532 } else if (udev->reset_resume) {
Alan Stern54515fe2007-05-30 15:38:58 -04002533 dev_dbg(&udev->dev, "reset-resume\n");
Ming Lei742120c2008-06-18 22:00:29 +08002534 status = usb_reset_and_verify_device(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04002535 }
2536 return status;
Alan Sternd388dab2006-07-01 22:14:24 -04002537}
2538
Alan Sternd388dab2006-07-01 22:14:24 -04002539#endif
2540
David Brownelldb690872005-09-13 19:56:33 -07002541static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542{
2543 struct usb_hub *hub = usb_get_intfdata (intf);
2544 struct usb_device *hdev = hub->hdev;
2545 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546
David Brownellc9f89fa2005-09-13 19:57:04 -07002547 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2549 struct usb_device *udev;
2550
2551 udev = hdev->children [port1-1];
Alan Stern6840d252007-09-10 11:34:26 -04002552 if (udev && udev->can_submit) {
Alan Stern65bfd292008-11-25 16:39:18 -05002553 if (!(msg.event & PM_EVENT_AUTO))
Alan Stern645daaa2006-08-30 15:47:02 -04002554 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2555 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07002556 return -EBUSY;
2557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 }
2559
Harvey Harrison441b62c2008-03-03 16:08:34 -08002560 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Stern40f122f2006-11-09 14:44:33 -05002561
David Brownellc9f89fa2005-09-13 19:57:04 -07002562 /* stop khubd and related activity */
Alan Stern43303542008-04-28 11:07:31 -04002563 hub_quiesce(hub, HUB_SUSPEND);
Alan Sternb6f64362007-05-04 11:51:54 -04002564 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565}
2566
2567static int hub_resume(struct usb_interface *intf)
2568{
Alan Stern5e6effa2008-03-03 15:15:51 -05002569 struct usb_hub *hub = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570
Alan Stern5e6effa2008-03-03 15:15:51 -05002571 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04002572 hub_activate(hub, HUB_RESUME);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 return 0;
2574}
2575
Alan Sternb41a60e2007-05-30 15:39:33 -04002576static int hub_reset_resume(struct usb_interface *intf)
Alan Sternf07600c2007-05-30 15:38:16 -04002577{
Alan Sternb41a60e2007-05-30 15:39:33 -04002578 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04002579
Alan Stern5e6effa2008-03-03 15:15:51 -05002580 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04002581 hub_activate(hub, HUB_RESET_RESUME);
Alan Sternf07600c2007-05-30 15:38:16 -04002582 return 0;
2583}
2584
Alan Stern54515fe2007-05-30 15:38:58 -04002585/**
2586 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2587 * @rhdev: struct usb_device for the root hub
2588 *
2589 * The USB host controller driver calls this function when its root hub
2590 * is resumed and Vbus power has been interrupted or the controller
Alan Sternfeccc302008-03-03 15:15:59 -05002591 * has been reset. The routine marks @rhdev as having lost power.
2592 * When the hub driver is resumed it will take notice and carry out
2593 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2594 * the others will be disconnected.
Alan Stern54515fe2007-05-30 15:38:58 -04002595 */
2596void usb_root_hub_lost_power(struct usb_device *rhdev)
2597{
2598 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2599 rhdev->reset_resume = 1;
2600}
2601EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2602
Alan Sternd388dab2006-07-01 22:14:24 -04002603#else /* CONFIG_PM */
2604
Alan Sternf07600c2007-05-30 15:38:16 -04002605#define hub_suspend NULL
2606#define hub_resume NULL
2607#define hub_reset_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04002608#endif
2609
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610
2611/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2612 *
2613 * Between connect detection and reset signaling there must be a delay
2614 * of 100ms at least for debounce and power-settling. The corresponding
2615 * timer shall restart whenever the downstream port detects a disconnect.
2616 *
2617 * Apparently there are some bluetooth and irda-dongles and a number of
2618 * low-speed devices for which this debounce period may last over a second.
2619 * Not covered by the spec - but easy to deal with.
2620 *
2621 * This implementation uses a 1500ms total debounce timeout; if the
2622 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2623 * every 25ms for transient disconnects. When the port status has been
2624 * unchanged for 100ms it returns the port status.
2625 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626static int hub_port_debounce(struct usb_hub *hub, int port1)
2627{
2628 int ret;
2629 int total_time, stable_time = 0;
2630 u16 portchange, portstatus;
2631 unsigned connection = 0xffff;
2632
2633 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2634 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2635 if (ret < 0)
2636 return ret;
2637
2638 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2639 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2640 stable_time += HUB_DEBOUNCE_STEP;
2641 if (stable_time >= HUB_DEBOUNCE_STABLE)
2642 break;
2643 } else {
2644 stable_time = 0;
2645 connection = portstatus & USB_PORT_STAT_CONNECTION;
2646 }
2647
2648 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2649 clear_port_feature(hub->hdev, port1,
2650 USB_PORT_FEAT_C_CONNECTION);
2651 }
2652
2653 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2654 break;
2655 msleep(HUB_DEBOUNCE_STEP);
2656 }
2657
2658 dev_dbg (hub->intfdev,
2659 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2660 port1, total_time, stable_time, portstatus);
2661
2662 if (stable_time < HUB_DEBOUNCE_STABLE)
2663 return -ETIMEDOUT;
2664 return portstatus;
2665}
2666
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002667void usb_ep0_reinit(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668{
Alan Sternddeac4e72009-01-15 17:03:33 -05002669 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2670 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
Alan Stern2caf7fc2008-12-31 11:31:33 -05002671 usb_enable_endpoint(udev, &udev->ep0, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672}
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002673EXPORT_SYMBOL_GPL(usb_ep0_reinit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674
2675#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2676#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2677
Alan Stern4326ed02007-07-30 17:08:43 -04002678static int hub_set_address(struct usb_device *udev, int devnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679{
2680 int retval;
Sarah Sharpc6515272009-04-27 19:57:26 -07002681 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682
Sarah Sharpc6515272009-04-27 19:57:26 -07002683 /*
2684 * The host controller will choose the device address,
2685 * instead of the core having chosen it earlier
2686 */
2687 if (!hcd->driver->address_device && devnum <= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002688 return -EINVAL;
2689 if (udev->state == USB_STATE_ADDRESS)
2690 return 0;
2691 if (udev->state != USB_STATE_DEFAULT)
2692 return -EINVAL;
Andiry Xuc8d4af82010-10-14 07:22:51 -07002693 if (hcd->driver->address_device)
Sarah Sharpc6515272009-04-27 19:57:26 -07002694 retval = hcd->driver->address_device(hcd, udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07002695 else
Sarah Sharpc6515272009-04-27 19:57:26 -07002696 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2697 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2698 NULL, 0, USB_CTRL_SET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 if (retval == 0) {
Alan Stern3b29b682011-02-22 09:53:41 -05002700 update_devnum(udev, devnum);
David Vrabel4953d142008-04-08 13:24:46 -07002701 /* Device now using proper address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 usb_set_device_state(udev, USB_STATE_ADDRESS);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002703 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704 }
2705 return retval;
2706}
2707
2708/* Reset device, (re)assign address, get device descriptor.
2709 * Device connection must be stable, no more debouncing needed.
2710 * Returns device in USB_STATE_ADDRESS, except on error.
2711 *
2712 * If this is called for an already-existing device (as part of
Ming Lei742120c2008-06-18 22:00:29 +08002713 * usb_reset_and_verify_device), the caller must own the device lock. For a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714 * newly detected device that is not accessible through any global
2715 * pointers, it's not necessary to lock the device.
2716 */
2717static int
2718hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2719 int retry_counter)
2720{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002721 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
2723 struct usb_device *hdev = hub->hdev;
Sarah Sharpe7b77172009-04-27 19:54:26 -07002724 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 int i, j, retval;
2726 unsigned delay = HUB_SHORT_RESET_TIME;
2727 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002728 char *speed, *type;
Alan Stern4326ed02007-07-30 17:08:43 -04002729 int devnum = udev->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730
2731 /* root hub ports have a slightly longer reset period
2732 * (from USB 2.0 spec, section 7.1.7.5)
2733 */
2734 if (!hdev->parent) {
2735 delay = HUB_ROOT_RESET_TIME;
2736 if (port1 == hdev->bus->otg_port)
2737 hdev->bus->b_hnp_enable = 0;
2738 }
2739
2740 /* Some low speed devices have problems with the quick delay, so */
2741 /* be a bit pessimistic with those devices. RHbug #23670 */
2742 if (oldspeed == USB_SPEED_LOW)
2743 delay = HUB_LONG_RESET_TIME;
2744
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002745 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746
Luben Tuikov07194ab2011-02-11 11:33:10 -08002747 /* Reset the device; full speed may morph to high speed */
2748 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2749 retval = hub_port_reset(hub, port1, udev, delay);
2750 if (retval < 0) /* error or disconnect */
2751 goto fail;
2752 /* success, speed is known */
2753
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754 retval = -ENODEV;
2755
2756 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2757 dev_dbg(&udev->dev, "device reset changed speed!\n");
2758 goto fail;
2759 }
2760 oldspeed = udev->speed;
Alan Stern4326ed02007-07-30 17:08:43 -04002761
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2763 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002764 * For Wireless USB devices, ep0 max packet is always 512 (tho
2765 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 */
2767 switch (udev->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -07002768 case USB_SPEED_SUPER:
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -08002769 case USB_SPEED_WIRELESS: /* fixed at 512 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002770 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002771 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 case USB_SPEED_HIGH: /* fixed at 64 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002773 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774 break;
2775 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2776 /* to determine the ep0 maxpacket size, try to read
2777 * the device descriptor to get bMaxPacketSize0 and
2778 * then correct our initial guess.
2779 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002780 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 break;
2782 case USB_SPEED_LOW: /* fixed at 8 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002783 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 break;
2785 default:
2786 goto fail;
2787 }
2788
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002789 type = "";
2790 switch (udev->speed) {
2791 case USB_SPEED_LOW: speed = "low"; break;
2792 case USB_SPEED_FULL: speed = "full"; break;
2793 case USB_SPEED_HIGH: speed = "high"; break;
Sarah Sharp6b403b02009-04-27 19:54:10 -07002794 case USB_SPEED_SUPER:
2795 speed = "super";
2796 break;
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -08002797 case USB_SPEED_WIRELESS:
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002798 speed = "variable";
2799 type = "Wireless ";
2800 break;
2801 default: speed = "?"; break;
2802 }
Sarah Sharpc6515272009-04-27 19:57:26 -07002803 if (udev->speed != USB_SPEED_SUPER)
2804 dev_info(&udev->dev,
Alan Stern3b29b682011-02-22 09:53:41 -05002805 "%s %s speed %sUSB device number %d using %s\n",
Sarah Sharpc6515272009-04-27 19:57:26 -07002806 (udev->config) ? "reset" : "new", speed, type,
Alan Stern3b29b682011-02-22 09:53:41 -05002807 devnum, udev->bus->controller->driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808
2809 /* Set up TT records, if needed */
2810 if (hdev->tt) {
2811 udev->tt = hdev->tt;
2812 udev->ttport = hdev->ttport;
2813 } else if (udev->speed != USB_SPEED_HIGH
2814 && hdev->speed == USB_SPEED_HIGH) {
Alan Sternd199c962011-01-31 10:56:37 -05002815 if (!hub->tt.hub) {
2816 dev_err(&udev->dev, "parent hub has no TT\n");
2817 retval = -EINVAL;
2818 goto fail;
2819 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 udev->tt = &hub->tt;
2821 udev->ttport = port1;
2822 }
2823
2824 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2825 * Because device hardware and firmware is sometimes buggy in
2826 * this area, and this is how Linux has done it for ages.
2827 * Change it cautiously.
2828 *
2829 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2830 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2831 * so it may help with some non-standards-compliant devices.
2832 * Otherwise we start with SET_ADDRESS and then try to read the
2833 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2834 * value.
2835 */
2836 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
Sarah Sharpc6515272009-04-27 19:57:26 -07002837 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838 struct usb_device_descriptor *buf;
2839 int r = 0;
2840
2841#define GET_DESCRIPTOR_BUFSIZE 64
2842 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2843 if (!buf) {
2844 retval = -ENOMEM;
2845 continue;
2846 }
2847
Alan Sternb89ee192007-05-11 10:19:04 -04002848 /* Retry on all errors; some devices are flakey.
2849 * 255 is for WUSB devices, we actually need to use
2850 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851 */
2852 for (j = 0; j < 3; ++j) {
2853 buf->bMaxPacketSize0 = 0;
2854 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2855 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2856 USB_DT_DEVICE << 8, 0,
2857 buf, GET_DESCRIPTOR_BUFSIZE,
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +02002858 initial_descriptor_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002860 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861 if (buf->bDescriptorType ==
2862 USB_DT_DEVICE) {
2863 r = 0;
2864 break;
2865 }
2866 /* FALL THROUGH */
2867 default:
2868 if (r == 0)
2869 r = -EPROTO;
2870 break;
2871 }
2872 if (r == 0)
2873 break;
2874 }
2875 udev->descriptor.bMaxPacketSize0 =
2876 buf->bMaxPacketSize0;
2877 kfree(buf);
2878
2879 retval = hub_port_reset(hub, port1, udev, delay);
2880 if (retval < 0) /* error or disconnect */
2881 goto fail;
2882 if (oldspeed != udev->speed) {
2883 dev_dbg(&udev->dev,
2884 "device reset changed speed!\n");
2885 retval = -ENODEV;
2886 goto fail;
2887 }
2888 if (r) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002889 dev_err(&udev->dev,
2890 "device descriptor read/64, error %d\n",
2891 r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892 retval = -EMSGSIZE;
2893 continue;
2894 }
2895#undef GET_DESCRIPTOR_BUFSIZE
2896 }
2897
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002898 /*
2899 * If device is WUSB, we already assigned an
2900 * unauthorized address in the Connect Ack sequence;
2901 * authorization will assign the final address.
2902 */
Sarah Sharpc6515272009-04-27 19:57:26 -07002903 if (udev->wusb == 0) {
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002904 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2905 retval = hub_set_address(udev, devnum);
2906 if (retval >= 0)
2907 break;
2908 msleep(200);
2909 }
2910 if (retval < 0) {
2911 dev_err(&udev->dev,
2912 "device not accepting address %d, error %d\n",
2913 devnum, retval);
2914 goto fail;
2915 }
Sarah Sharpc6515272009-04-27 19:57:26 -07002916 if (udev->speed == USB_SPEED_SUPER) {
2917 devnum = udev->devnum;
2918 dev_info(&udev->dev,
Alan Stern3b29b682011-02-22 09:53:41 -05002919 "%s SuperSpeed USB device number %d using %s\n",
Sarah Sharpc6515272009-04-27 19:57:26 -07002920 (udev->config) ? "reset" : "new",
Alan Stern3b29b682011-02-22 09:53:41 -05002921 devnum, udev->bus->controller->driver->name);
Sarah Sharpc6515272009-04-27 19:57:26 -07002922 }
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002923
2924 /* cope with hardware quirkiness:
2925 * - let SET_ADDRESS settle, some device hardware wants it
2926 * - read ep0 maxpacket even for high and low speed,
2927 */
2928 msleep(10);
Sarah Sharpc6515272009-04-27 19:57:26 -07002929 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930 break;
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002931 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932
2933 retval = usb_get_device_descriptor(udev, 8);
2934 if (retval < 8) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002935 dev_err(&udev->dev,
2936 "device descriptor read/8, error %d\n",
2937 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938 if (retval >= 0)
2939 retval = -EMSGSIZE;
2940 } else {
2941 retval = 0;
2942 break;
2943 }
2944 }
2945 if (retval)
2946 goto fail;
2947
Sarah Sharp6b403b02009-04-27 19:54:10 -07002948 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2949 udev->speed == USB_SPEED_SUPER)
2950 i = 512;
2951 else
2952 i = udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
Alan Stern56626a72010-10-14 15:25:21 -04002954 if (udev->speed == USB_SPEED_LOW ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955 !(i == 8 || i == 16 || i == 32 || i == 64)) {
Alan Stern56626a72010-10-14 15:25:21 -04002956 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957 retval = -EMSGSIZE;
2958 goto fail;
2959 }
Alan Stern56626a72010-10-14 15:25:21 -04002960 if (udev->speed == USB_SPEED_FULL)
2961 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2962 else
2963 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002965 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966 }
2967
2968 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2969 if (retval < (signed)sizeof(udev->descriptor)) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002970 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2971 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972 if (retval >= 0)
2973 retval = -ENOMSG;
2974 goto fail;
2975 }
2976
2977 retval = 0;
Alek Du48f24972010-06-04 15:47:55 +08002978 /* notify HCD that we have a device connected and addressed */
2979 if (hcd->driver->update_device)
2980 hcd->driver->update_device(hcd, udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981fail:
Alan Stern4326ed02007-07-30 17:08:43 -04002982 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983 hub_port_disable(hub, port1, 0);
Alan Stern3b29b682011-02-22 09:53:41 -05002984 update_devnum(udev, devnum); /* for disconnect processing */
Alan Stern4326ed02007-07-30 17:08:43 -04002985 }
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002986 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987 return retval;
2988}
2989
2990static void
2991check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2992{
2993 struct usb_qualifier_descriptor *qual;
2994 int status;
2995
Christoph Lametere94b1762006-12-06 20:33:17 -08002996 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997 if (qual == NULL)
2998 return;
2999
3000 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3001 qual, sizeof *qual);
3002 if (status == sizeof *qual) {
3003 dev_info(&udev->dev, "not running at top speed; "
3004 "connect to a high speed hub\n");
3005 /* hub LEDs are probably harder to miss than syslog */
3006 if (hub->has_indicators) {
3007 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00003008 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009 }
3010 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07003011 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012}
3013
3014static unsigned
3015hub_power_remaining (struct usb_hub *hub)
3016{
3017 struct usb_device *hdev = hub->hdev;
3018 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05003019 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020
Alan Stern55c52712005-11-23 12:03:12 -05003021 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022 return 0;
3023
Alan Stern55c52712005-11-23 12:03:12 -05003024 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3025 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3026 struct usb_device *udev = hdev->children[port1 - 1];
3027 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028
3029 if (!udev)
3030 continue;
3031
Alan Stern55c52712005-11-23 12:03:12 -05003032 /* Unconfigured devices may not use more than 100mA,
3033 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003034 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05003035 delta = udev->actconfig->desc.bMaxPower * 2;
3036 else if (port1 != udev->bus->otg_port || hdev->parent)
3037 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038 else
Alan Stern55c52712005-11-23 12:03:12 -05003039 delta = 8;
3040 if (delta > hub->mA_per_port)
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08003041 dev_warn(&udev->dev,
3042 "%dmA is over %umA budget for port %d!\n",
3043 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044 remaining -= delta;
3045 }
3046 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05003047 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3048 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049 remaining = 0;
3050 }
3051 return remaining;
3052}
3053
3054/* Handle physical or logical connection change events.
3055 * This routine is called when:
3056 * a port connection-change occurs;
3057 * a port enable-change occurs (often caused by EMI);
Ming Lei742120c2008-06-18 22:00:29 +08003058 * usb_reset_and_verify_device() encounters changed descriptors (as from
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059 * a firmware download)
3060 * caller already locked the hub
3061 */
3062static void hub_port_connect_change(struct usb_hub *hub, int port1,
3063 u16 portstatus, u16 portchange)
3064{
3065 struct usb_device *hdev = hub->hdev;
3066 struct device *hub_dev = hub->intfdev;
Balaji Rao90da0962007-11-22 01:58:14 +05303067 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Alan Stern24618b02008-04-28 11:06:28 -04003068 unsigned wHubCharacteristics =
3069 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Alan Stern8808f002008-04-28 11:06:55 -04003070 struct usb_device *udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071 int status, i;
Alan Stern24618b02008-04-28 11:06:28 -04003072
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073 dev_dbg (hub_dev,
3074 "port %d, status %04x, change %04x, %s\n",
Sarah Sharp131dec32010-12-06 21:00:19 -08003075 port1, portstatus, portchange, portspeed(hub, portstatus));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076
3077 if (hub->has_indicators) {
3078 set_port_led(hub, port1, HUB_LED_AUTO);
3079 hub->indicator[port1-1] = INDICATOR_AUTO;
3080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081
3082#ifdef CONFIG_USB_OTG
3083 /* during HNP, don't repeat the debounce */
3084 if (hdev->bus->is_b_host)
Alan Stern24618b02008-04-28 11:06:28 -04003085 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3086 USB_PORT_STAT_C_ENABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087#endif
3088
Alan Stern8808f002008-04-28 11:06:55 -04003089 /* Try to resuscitate an existing device */
3090 udev = hdev->children[port1-1];
3091 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3092 udev->state != USB_STATE_NOTATTACHED) {
Alan Stern8808f002008-04-28 11:06:55 -04003093 usb_lock_device(udev);
3094 if (portstatus & USB_PORT_STAT_ENABLE) {
3095 status = 0; /* Nothing to do */
Alan Stern8808f002008-04-28 11:06:55 -04003096
3097#ifdef CONFIG_USB_SUSPEND
Alan Stern5257d972008-09-22 14:43:08 -04003098 } else if (udev->state == USB_STATE_SUSPENDED &&
3099 udev->persist_enabled) {
Alan Stern8808f002008-04-28 11:06:55 -04003100 /* For a suspended device, treat this as a
3101 * remote wakeup event.
3102 */
Alan Stern0534d462010-01-08 12:56:30 -05003103 status = usb_remote_wakeup(udev);
Alan Stern8808f002008-04-28 11:06:55 -04003104#endif
3105
3106 } else {
Alan Stern5257d972008-09-22 14:43:08 -04003107 status = -ENODEV; /* Don't resuscitate */
Alan Stern8808f002008-04-28 11:06:55 -04003108 }
3109 usb_unlock_device(udev);
3110
3111 if (status == 0) {
3112 clear_bit(port1, hub->change_bits);
3113 return;
3114 }
3115 }
3116
Alan Stern24618b02008-04-28 11:06:28 -04003117 /* Disconnect any existing devices under this port */
Alan Stern8808f002008-04-28 11:06:55 -04003118 if (udev)
Alan Stern24618b02008-04-28 11:06:28 -04003119 usb_disconnect(&hdev->children[port1-1]);
3120 clear_bit(port1, hub->change_bits);
3121
Alan Stern253e0572009-10-27 15:20:13 -04003122 /* We can forget about a "removed" device when there's a physical
3123 * disconnect or the connect status changes.
3124 */
3125 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3126 (portchange & USB_PORT_STAT_C_CONNECTION))
3127 clear_bit(port1, hub->removed_bits);
3128
Alan Stern5257d972008-09-22 14:43:08 -04003129 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3130 USB_PORT_STAT_C_ENABLE)) {
3131 status = hub_port_debounce(hub, port1);
3132 if (status < 0) {
3133 if (printk_ratelimit())
3134 dev_err(hub_dev, "connect-debounce failed, "
3135 "port %d disabled\n", port1);
3136 portstatus &= ~USB_PORT_STAT_CONNECTION;
3137 } else {
3138 portstatus = status;
3139 }
3140 }
3141
Alan Stern253e0572009-10-27 15:20:13 -04003142 /* Return now if debouncing failed or nothing is connected or
3143 * the device was "removed".
3144 */
3145 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3146 test_bit(port1, hub->removed_bits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003147
3148 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07003149 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Alan Stern749da5f2010-03-04 17:05:08 -05003150 && !(portstatus & USB_PORT_STAT_POWER))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003151 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
Alan Stern5257d972008-09-22 14:43:08 -04003152
Linus Torvalds1da177e2005-04-16 15:20:36 -07003153 if (portstatus & USB_PORT_STAT_ENABLE)
3154 goto done;
3155 return;
3156 }
3157
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158 for (i = 0; i < SET_CONFIG_TRIES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159
3160 /* reallocate for each attempt, since references
3161 * to the previous one can escape in various ways
3162 */
3163 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3164 if (!udev) {
3165 dev_err (hub_dev,
3166 "couldn't allocate port %d usb_device\n",
3167 port1);
3168 goto done;
3169 }
3170
3171 usb_set_device_state(udev, USB_STATE_POWERED);
Alan Stern55c52712005-11-23 12:03:12 -05003172 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04003173 udev->level = hdev->level + 1;
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07003174 udev->wusb = hub_is_wusb(hub);
Alan Stern55c52712005-11-23 12:03:12 -05003175
Sarah Sharp131dec32010-12-06 21:00:19 -08003176 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3177 if (hub_is_superspeed(hub->hdev))
Sarah Sharpe7b77172009-04-27 19:54:26 -07003178 udev->speed = USB_SPEED_SUPER;
3179 else
3180 udev->speed = USB_SPEED_UNKNOWN;
3181
Alan Stern3b29b682011-02-22 09:53:41 -05003182 choose_devnum(udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07003183 if (udev->devnum <= 0) {
3184 status = -ENOTCONN; /* Don't retry */
3185 goto loop;
Sarah Sharpc6515272009-04-27 19:57:26 -07003186 }
3187
Sarah Sharpe7b77172009-04-27 19:54:26 -07003188 /* reset (non-USB 3.0 devices) and get descriptor */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003189 status = hub_port_init(hub, udev, port1, i);
3190 if (status < 0)
3191 goto loop;
3192
Phil Dibowitz93362a82010-07-22 00:05:01 +02003193 usb_detect_quirks(udev);
3194 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3195 msleep(1000);
3196
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197 /* consecutive bus-powered hubs aren't reliable; they can
3198 * violate the voltage drop budget. if the new child has
3199 * a "powered" LED, users should notice we didn't enable it
3200 * (without reading syslog), even without per-port LEDs
3201 * on the parent.
3202 */
3203 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05003204 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205 u16 devstat;
3206
3207 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3208 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05003209 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 dev_dbg(&udev->dev, "get status %d ?\n", status);
3211 goto loop_disable;
3212 }
Alan Stern55c52712005-11-23 12:03:12 -05003213 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003214 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3215 dev_err(&udev->dev,
3216 "can't connect bus-powered hub "
3217 "to this port\n");
3218 if (hub->has_indicators) {
3219 hub->indicator[port1-1] =
3220 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00003221 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222 }
3223 status = -ENOTCONN; /* Don't retry */
3224 goto loop_disable;
3225 }
3226 }
3227
3228 /* check for devices running slower than they could */
3229 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3230 && udev->speed == USB_SPEED_FULL
3231 && highspeed_hubs != 0)
3232 check_highspeed (hub, udev, port1);
3233
3234 /* Store the parent's children[] pointer. At this point
3235 * udev becomes globally accessible, although presumably
3236 * no one will look at it until hdev is unlocked.
3237 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238 status = 0;
3239
3240 /* We mustn't add new devices if the parent hub has
3241 * been disconnected; we would race with the
3242 * recursively_mark_NOTATTACHED() routine.
3243 */
3244 spin_lock_irq(&device_state_lock);
3245 if (hdev->state == USB_STATE_NOTATTACHED)
3246 status = -ENOTCONN;
3247 else
3248 hdev->children[port1-1] = udev;
3249 spin_unlock_irq(&device_state_lock);
3250
3251 /* Run it through the hoops (find a driver, etc) */
3252 if (!status) {
3253 status = usb_new_device(udev);
3254 if (status) {
3255 spin_lock_irq(&device_state_lock);
3256 hdev->children[port1-1] = NULL;
3257 spin_unlock_irq(&device_state_lock);
3258 }
3259 }
3260
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 if (status)
3262 goto loop_disable;
3263
3264 status = hub_power_remaining(hub);
3265 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05003266 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003267
3268 return;
3269
3270loop_disable:
3271 hub_port_disable(hub, port1, 1);
3272loop:
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003273 usb_ep0_reinit(udev);
Alan Stern3b29b682011-02-22 09:53:41 -05003274 release_devnum(udev);
Herbert Xuf7410ce2010-01-10 20:15:03 +11003275 hub_free_dev(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07003277 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278 break;
3279 }
Alan Stern3a311552008-05-20 16:58:29 -04003280 if (hub->hdev->parent ||
3281 !hcd->driver->port_handed_over ||
3282 !(hcd->driver->port_handed_over)(hcd, port1))
3283 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3284 port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003285
3286done:
3287 hub_port_disable(hub, port1, 1);
Balaji Rao90da0962007-11-22 01:58:14 +05303288 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3289 hcd->driver->relinquish_port(hcd, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290}
3291
3292static void hub_events(void)
3293{
3294 struct list_head *tmp;
3295 struct usb_device *hdev;
3296 struct usb_interface *intf;
3297 struct usb_hub *hub;
3298 struct device *hub_dev;
3299 u16 hubstatus;
3300 u16 hubchange;
3301 u16 portstatus;
3302 u16 portchange;
3303 int i, ret;
3304 int connect_change;
3305
3306 /*
3307 * We restart the list every time to avoid a deadlock with
3308 * deleting hubs downstream from this one. This should be
3309 * safe since we delete the hub from the event list.
3310 * Not the most efficient, but avoids deadlocks.
3311 */
3312 while (1) {
3313
3314 /* Grab the first entry at the beginning of the list */
3315 spin_lock_irq(&hub_event_lock);
3316 if (list_empty(&hub_event_list)) {
3317 spin_unlock_irq(&hub_event_lock);
3318 break;
3319 }
3320
3321 tmp = hub_event_list.next;
3322 list_del_init(tmp);
3323
3324 hub = list_entry(tmp, struct usb_hub, event_list);
Alan Sterne8054852007-05-04 11:55:11 -04003325 kref_get(&hub->kref);
3326 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327
Alan Sterne8054852007-05-04 11:55:11 -04003328 hdev = hub->hdev;
3329 hub_dev = hub->intfdev;
3330 intf = to_usb_interface(hub_dev);
Alan Stern40f122f2006-11-09 14:44:33 -05003331 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07003332 hdev->state, hub->descriptor
3333 ? hub->descriptor->bNbrPorts
3334 : 0,
3335 /* NOTE: expects max 15 ports... */
3336 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05003337 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339 /* Lock the device, then check to see if we were
3340 * disconnected while waiting for the lock to succeed. */
Alan Stern06b84e82007-05-04 11:54:50 -04003341 usb_lock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04003342 if (unlikely(hub->disconnected))
Alan Stern9bbdf1e2010-01-08 12:57:28 -05003343 goto loop_disconnected;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003344
3345 /* If the hub has died, clean up after it */
3346 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04003347 hub->error = -ENODEV;
Alan Stern43303542008-04-28 11:07:31 -04003348 hub_quiesce(hub, HUB_DISCONNECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349 goto loop;
3350 }
3351
Alan Stern40f122f2006-11-09 14:44:33 -05003352 /* Autoresume */
3353 ret = usb_autopm_get_interface(intf);
3354 if (ret) {
3355 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003356 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05003357 }
3358
3359 /* If this is an inactive hub, do nothing */
3360 if (hub->quiescing)
3361 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003362
3363 if (hub->error) {
3364 dev_dbg (hub_dev, "resetting for error %d\n",
3365 hub->error);
3366
Ming Lei742120c2008-06-18 22:00:29 +08003367 ret = usb_reset_device(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368 if (ret) {
3369 dev_dbg (hub_dev,
3370 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05003371 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372 }
3373
3374 hub->nerrors = 0;
3375 hub->error = 0;
3376 }
3377
3378 /* deal with port status changes */
3379 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3380 if (test_bit(i, hub->busy_bits))
3381 continue;
3382 connect_change = test_bit(i, hub->change_bits);
3383 if (!test_and_clear_bit(i, hub->event_bits) &&
Alan Stern6ee0b272008-04-28 11:06:42 -04003384 !connect_change)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003385 continue;
3386
3387 ret = hub_port_status(hub, i,
3388 &portstatus, &portchange);
3389 if (ret < 0)
3390 continue;
3391
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3393 clear_port_feature(hdev, i,
3394 USB_PORT_FEAT_C_CONNECTION);
3395 connect_change = 1;
3396 }
3397
3398 if (portchange & USB_PORT_STAT_C_ENABLE) {
3399 if (!connect_change)
3400 dev_dbg (hub_dev,
3401 "port %d enable change, "
3402 "status %08x\n",
3403 i, portstatus);
3404 clear_port_feature(hdev, i,
3405 USB_PORT_FEAT_C_ENABLE);
3406
3407 /*
3408 * EM interference sometimes causes badly
3409 * shielded USB devices to be shutdown by
3410 * the hub, this hack enables them again.
3411 * Works at least with mouse driver.
3412 */
3413 if (!(portstatus & USB_PORT_STAT_ENABLE)
3414 && !connect_change
3415 && hdev->children[i-1]) {
3416 dev_err (hub_dev,
3417 "port %i "
3418 "disabled by hub (EMI?), "
3419 "re-enabling...\n",
3420 i);
3421 connect_change = 1;
3422 }
3423 }
3424
3425 if (portchange & USB_PORT_STAT_C_SUSPEND) {
Alan Stern8808f002008-04-28 11:06:55 -04003426 struct usb_device *udev;
3427
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 clear_port_feature(hdev, i,
3429 USB_PORT_FEAT_C_SUSPEND);
Alan Stern8808f002008-04-28 11:06:55 -04003430 udev = hdev->children[i-1];
3431 if (udev) {
Alan Stern49d0f072010-01-08 11:18:38 -05003432 /* TRSMRCY = 10 msec */
3433 msleep(10);
3434
Alan Stern8808f002008-04-28 11:06:55 -04003435 usb_lock_device(udev);
Alan Stern0534d462010-01-08 12:56:30 -05003436 ret = usb_remote_wakeup(hdev->
Linus Torvalds1da177e2005-04-16 15:20:36 -07003437 children[i-1]);
Alan Stern8808f002008-04-28 11:06:55 -04003438 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003439 if (ret < 0)
3440 connect_change = 1;
3441 } else {
3442 ret = -ENODEV;
3443 hub_port_disable(hub, i, 1);
3444 }
3445 dev_dbg (hub_dev,
3446 "resume on port %d, status %d\n",
3447 i, ret);
3448 }
3449
3450 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
Paul Bolle752d57a2011-03-11 18:03:52 +01003451 u16 status = 0;
3452 u16 unused;
3453
3454 dev_dbg(hub_dev, "over-current change on port "
3455 "%d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456 clear_port_feature(hdev, i,
3457 USB_PORT_FEAT_C_OVER_CURRENT);
Paul Bolle752d57a2011-03-11 18:03:52 +01003458 msleep(100); /* Cool down */
Alan Stern8520f382008-09-22 14:44:26 -04003459 hub_power_on(hub, true);
Paul Bolle752d57a2011-03-11 18:03:52 +01003460 hub_port_status(hub, i, &status, &unused);
3461 if (status & USB_PORT_STAT_OVERCURRENT)
3462 dev_err(hub_dev, "over-current "
3463 "condition on port %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003464 }
3465
3466 if (portchange & USB_PORT_STAT_C_RESET) {
3467 dev_dbg (hub_dev,
3468 "reset change on port %d\n",
3469 i);
3470 clear_port_feature(hdev, i,
3471 USB_PORT_FEAT_C_RESET);
3472 }
Sarah Sharpc7061572010-12-06 15:08:20 -08003473 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3474 hub_is_superspeed(hub->hdev)) {
3475 dev_dbg(hub_dev,
3476 "warm reset change on port %d\n",
3477 i);
3478 clear_port_feature(hdev, i,
3479 USB_PORT_FEAT_C_BH_PORT_RESET);
3480 }
John Youndbe79bb2001-09-17 00:00:00 -07003481 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3482 clear_port_feature(hub->hdev, i,
3483 USB_PORT_FEAT_C_PORT_LINK_STATE);
3484 }
3485 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3486 dev_warn(hub_dev,
3487 "config error on port %d\n",
3488 i);
3489 clear_port_feature(hub->hdev, i,
3490 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3491 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492
3493 if (connect_change)
3494 hub_port_connect_change(hub, i,
3495 portstatus, portchange);
3496 } /* end for i */
3497
3498 /* deal with hub status changes */
3499 if (test_and_clear_bit(0, hub->event_bits) == 0)
3500 ; /* do nothing */
3501 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3502 dev_err (hub_dev, "get_hub_status failed\n");
3503 else {
3504 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3505 dev_dbg (hub_dev, "power change\n");
3506 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05003507 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3508 /* FIXME: Is this always true? */
Alan Stern55c52712005-11-23 12:03:12 -05003509 hub->limited_power = 1;
jidong xiao403fae72007-09-14 00:08:51 +08003510 else
3511 hub->limited_power = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 }
3513 if (hubchange & HUB_CHANGE_OVERCURRENT) {
Paul Bolle752d57a2011-03-11 18:03:52 +01003514 u16 status = 0;
3515 u16 unused;
3516
3517 dev_dbg(hub_dev, "over-current change\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
Paul Bolle752d57a2011-03-11 18:03:52 +01003519 msleep(500); /* Cool down */
Alan Stern8520f382008-09-22 14:44:26 -04003520 hub_power_on(hub, true);
Paul Bolle752d57a2011-03-11 18:03:52 +01003521 hub_hub_status(hub, &status, &unused);
3522 if (status & HUB_STATUS_OVERCURRENT)
3523 dev_err(hub_dev, "over-current "
3524 "condition\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525 }
3526 }
3527
Alan Stern8e4ceb32009-12-07 13:01:37 -05003528 loop_autopm:
3529 /* Balance the usb_autopm_get_interface() above */
3530 usb_autopm_put_interface_no_suspend(intf);
3531 loop:
3532 /* Balance the usb_autopm_get_interface_no_resume() in
3533 * kick_khubd() and allow autosuspend.
3534 */
3535 usb_autopm_put_interface(intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05003536 loop_disconnected:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537 usb_unlock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04003538 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003539
3540 } /* end while (1) */
3541}
3542
3543static int hub_thread(void *__unused)
3544{
Alan Stern3bb1af52008-03-03 15:15:36 -05003545 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3546 * port handover. Otherwise it might see that a full-speed device
3547 * was gone before the EHCI controller had handed its port over to
3548 * the companion full-speed controller.
3549 */
Rafael J. Wysocki83144182007-07-17 04:03:35 -07003550 set_freezable();
Alan Stern3bb1af52008-03-03 15:15:36 -05003551
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552 do {
3553 hub_events();
Rafael J. Wysockie42837b2007-10-18 03:04:45 -07003554 wait_event_freezable(khubd_wait,
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003555 !list_empty(&hub_event_list) ||
3556 kthread_should_stop());
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003557 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003558
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003559 pr_debug("%s: khubd exiting\n", usbcore_name);
3560 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561}
3562
Németh Márton1e927d92010-01-10 15:34:53 +01003563static const struct usb_device_id hub_id_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003564 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3565 .bDeviceClass = USB_CLASS_HUB},
3566 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3567 .bInterfaceClass = USB_CLASS_HUB},
3568 { } /* Terminating entry */
3569};
3570
3571MODULE_DEVICE_TABLE (usb, hub_id_table);
3572
3573static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574 .name = "hub",
3575 .probe = hub_probe,
3576 .disconnect = hub_disconnect,
3577 .suspend = hub_suspend,
3578 .resume = hub_resume,
Alan Sternf07600c2007-05-30 15:38:16 -04003579 .reset_resume = hub_reset_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04003580 .pre_reset = hub_pre_reset,
3581 .post_reset = hub_post_reset,
Andi Kleenc532b292010-06-01 23:04:41 +02003582 .unlocked_ioctl = hub_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05003584 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585};
3586
3587int usb_hub_init(void)
3588{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589 if (usb_register(&hub_driver) < 0) {
3590 printk(KERN_ERR "%s: can't register hub driver\n",
3591 usbcore_name);
3592 return -1;
3593 }
3594
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003595 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3596 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598
3599 /* Fall through if kernel_thread failed */
3600 usb_deregister(&hub_driver);
3601 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3602
3603 return -1;
3604}
3605
3606void usb_hub_cleanup(void)
3607{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003608 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003609
3610 /*
3611 * Hub resources are freed for us by usb_deregister. It calls
3612 * usb_driver_purge on every device which in turn calls that
3613 * devices disconnect function if it is using this driver.
3614 * The hub_disconnect function takes care of releasing the
3615 * individual hub resources. -greg
3616 */
3617 usb_deregister(&hub_driver);
3618} /* usb_hub_cleanup() */
3619
Alan Sterneb764c42008-03-03 15:16:04 -05003620static int descriptors_changed(struct usb_device *udev,
3621 struct usb_device_descriptor *old_device_descriptor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622{
Alan Sterneb764c42008-03-03 15:16:04 -05003623 int changed = 0;
3624 unsigned index;
3625 unsigned serial_len = 0;
3626 unsigned len;
3627 unsigned old_length;
3628 int length;
3629 char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630
Alan Sterneb764c42008-03-03 15:16:04 -05003631 if (memcmp(&udev->descriptor, old_device_descriptor,
3632 sizeof(*old_device_descriptor)) != 0)
3633 return 1;
3634
3635 /* Since the idVendor, idProduct, and bcdDevice values in the
3636 * device descriptor haven't changed, we will assume the
3637 * Manufacturer and Product strings haven't changed either.
3638 * But the SerialNumber string could be different (e.g., a
3639 * different flash card of the same brand).
3640 */
3641 if (udev->serial)
3642 serial_len = strlen(udev->serial) + 1;
3643
3644 len = serial_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003645 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05003646 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3647 len = max(len, old_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648 }
Alan Sterneb764c42008-03-03 15:16:04 -05003649
Oliver Neukum0cc1a512008-01-10 10:31:48 +01003650 buf = kmalloc(len, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651 if (buf == NULL) {
3652 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3653 /* assume the worst */
3654 return 1;
3655 }
3656 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05003657 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003658 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3659 old_length);
Alan Sterneb764c42008-03-03 15:16:04 -05003660 if (length != old_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003661 dev_dbg(&udev->dev, "config index %d, error %d\n",
3662 index, length);
Alan Sterneb764c42008-03-03 15:16:04 -05003663 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003664 break;
3665 }
3666 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3667 != 0) {
3668 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
Alan Sterneb764c42008-03-03 15:16:04 -05003669 index,
3670 ((struct usb_config_descriptor *) buf)->
3671 bConfigurationValue);
3672 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003673 break;
3674 }
3675 }
Alan Sterneb764c42008-03-03 15:16:04 -05003676
3677 if (!changed && serial_len) {
3678 length = usb_string(udev, udev->descriptor.iSerialNumber,
3679 buf, serial_len);
3680 if (length + 1 != serial_len) {
3681 dev_dbg(&udev->dev, "serial string error %d\n",
3682 length);
3683 changed = 1;
3684 } else if (memcmp(buf, udev->serial, length) != 0) {
3685 dev_dbg(&udev->dev, "serial string changed\n");
3686 changed = 1;
3687 }
3688 }
3689
Linus Torvalds1da177e2005-04-16 15:20:36 -07003690 kfree(buf);
Alan Sterneb764c42008-03-03 15:16:04 -05003691 return changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003692}
3693
3694/**
Ming Lei742120c2008-06-18 22:00:29 +08003695 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003696 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3697 *
Alan Stern79efa092006-06-01 13:33:42 -04003698 * WARNING - don't use this routine to reset a composite device
3699 * (one with multiple interfaces owned by separate drivers)!
Ming Lei742120c2008-06-18 22:00:29 +08003700 * Use usb_reset_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003701 *
3702 * Do a port reset, reassign the device's address, and establish its
3703 * former operating configuration. If the reset fails, or the device's
3704 * descriptors change from their values before the reset, or the original
3705 * configuration and altsettings cannot be restored, a flag will be set
3706 * telling khubd to pretend the device has been disconnected and then
3707 * re-connected. All drivers will be unbound, and the device will be
3708 * re-enumerated and probed all over again.
3709 *
3710 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3711 * flagged for logical disconnection, or some other negative error code
3712 * if the reset wasn't even attempted.
3713 *
3714 * The caller must own the device lock. For example, it's safe to use
3715 * this from a driver probe() routine after downloading new firmware.
3716 * For calls that might not occur during probe(), drivers should lock
3717 * the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04003718 *
3719 * Locking exception: This routine may also be called from within an
3720 * autoresume handler. Such usage won't conflict with other tasks
3721 * holding the device lock because these tasks should always call
3722 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003723 */
Ming Lei742120c2008-06-18 22:00:29 +08003724static int usb_reset_and_verify_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003725{
3726 struct usb_device *parent_hdev = udev->parent;
3727 struct usb_hub *parent_hub;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08003728 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003729 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05003730 int i, ret = 0;
3731 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003732
3733 if (udev->state == USB_STATE_NOTATTACHED ||
3734 udev->state == USB_STATE_SUSPENDED) {
3735 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3736 udev->state);
3737 return -EINVAL;
3738 }
3739
3740 if (!parent_hdev) {
Wolfram Sang4bec9912010-08-29 18:17:14 +02003741 /* this requires hcd-specific logic; see ohci_restart() */
Harvey Harrison441b62c2008-03-03 16:08:34 -08003742 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003743 return -EISDIR;
3744 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003745 parent_hub = hdev_to_hub(parent_hdev);
3746
Linus Torvalds1da177e2005-04-16 15:20:36 -07003747 set_bit(port1, parent_hub->busy_bits);
3748 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3749
3750 /* ep0 maxpacket size may change; let the HCD know about it.
3751 * Other endpoints will be handled by re-enumeration. */
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003752 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003753 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04003754 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003755 break;
3756 }
3757 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04003758
Linus Torvalds1da177e2005-04-16 15:20:36 -07003759 if (ret < 0)
3760 goto re_enumerate;
3761
3762 /* Device might have changed firmware (DFU or similar) */
Alan Sterneb764c42008-03-03 15:16:04 -05003763 if (descriptors_changed(udev, &descriptor)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003764 dev_info(&udev->dev, "device firmware changed\n");
3765 udev->descriptor = descriptor; /* for disconnect() calls */
3766 goto re_enumerate;
3767 }
Alan Stern4fe03872009-02-26 10:21:02 -05003768
3769 /* Restore the device's previous configuration */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003770 if (!udev->actconfig)
3771 goto done;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08003772
Sarah Sharpd673bfc2010-10-15 08:55:24 -07003773 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08003774 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3775 if (ret < 0) {
3776 dev_warn(&udev->dev,
3777 "Busted HC? Not enough HCD resources for "
3778 "old configuration.\n");
Sarah Sharpd673bfc2010-10-15 08:55:24 -07003779 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08003780 goto re_enumerate;
3781 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003782 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3783 USB_REQ_SET_CONFIGURATION, 0,
3784 udev->actconfig->desc.bConfigurationValue, 0,
3785 NULL, 0, USB_CTRL_SET_TIMEOUT);
3786 if (ret < 0) {
3787 dev_err(&udev->dev,
3788 "can't restore configuration #%d (error=%d)\n",
3789 udev->actconfig->desc.bConfigurationValue, ret);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07003790 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003791 goto re_enumerate;
3792 }
Sarah Sharpd673bfc2010-10-15 08:55:24 -07003793 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003794 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3795
Alan Stern4fe03872009-02-26 10:21:02 -05003796 /* Put interfaces back into the same altsettings as before.
3797 * Don't bother to send the Set-Interface request for interfaces
3798 * that were already in altsetting 0; besides being unnecessary,
3799 * many devices can't handle it. Instead just reset the host-side
3800 * endpoint state.
3801 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003802 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
Sarah Sharp3f0479e2009-12-03 09:44:36 -08003803 struct usb_host_config *config = udev->actconfig;
3804 struct usb_interface *intf = config->interface[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003805 struct usb_interface_descriptor *desc;
3806
Linus Torvalds1da177e2005-04-16 15:20:36 -07003807 desc = &intf->cur_altsetting->desc;
Alan Stern4fe03872009-02-26 10:21:02 -05003808 if (desc->bAlternateSetting == 0) {
3809 usb_disable_interface(udev, intf, true);
3810 usb_enable_interface(udev, intf, true);
3811 ret = 0;
3812 } else {
Sarah Sharp04a723e2010-01-06 10:16:51 -08003813 /* Let the bandwidth allocation function know that this
3814 * device has been reset, and it will have to use
3815 * alternate setting 0 as the current alternate setting.
Sarah Sharp3f0479e2009-12-03 09:44:36 -08003816 */
Sarah Sharp04a723e2010-01-06 10:16:51 -08003817 intf->resetting_device = 1;
Alan Stern4fe03872009-02-26 10:21:02 -05003818 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3819 desc->bAlternateSetting);
Sarah Sharp04a723e2010-01-06 10:16:51 -08003820 intf->resetting_device = 0;
Alan Stern4fe03872009-02-26 10:21:02 -05003821 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003822 if (ret < 0) {
3823 dev_err(&udev->dev, "failed to restore interface %d "
3824 "altsetting %d (error=%d)\n",
3825 desc->bInterfaceNumber,
3826 desc->bAlternateSetting,
3827 ret);
3828 goto re_enumerate;
3829 }
3830 }
3831
3832done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003833 return 0;
3834
3835re_enumerate:
3836 hub_port_logical_disconnect(parent_hub, port1);
3837 return -ENODEV;
3838}
Alan Stern79efa092006-06-01 13:33:42 -04003839
3840/**
Ming Lei742120c2008-06-18 22:00:29 +08003841 * usb_reset_device - warn interface drivers and perform a USB port reset
Alan Stern79efa092006-06-01 13:33:42 -04003842 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
Alan Stern79efa092006-06-01 13:33:42 -04003843 *
3844 * Warns all drivers bound to registered interfaces (using their pre_reset
3845 * method), performs the port reset, and then lets the drivers know that
3846 * the reset is over (using their post_reset method).
3847 *
Ming Lei742120c2008-06-18 22:00:29 +08003848 * Return value is the same as for usb_reset_and_verify_device().
Alan Stern79efa092006-06-01 13:33:42 -04003849 *
3850 * The caller must own the device lock. For example, it's safe to use
3851 * this from a driver probe() routine after downloading new firmware.
3852 * For calls that might not occur during probe(), drivers should lock
3853 * the device using usb_lock_device_for_reset().
Alan Stern78d9a482008-06-23 16:00:40 -04003854 *
3855 * If an interface is currently being probed or disconnected, we assume
3856 * its driver knows how to handle resets. For all other interfaces,
3857 * if the driver doesn't have pre_reset and post_reset methods then
3858 * we attempt to unbind it and rebind afterward.
Alan Stern79efa092006-06-01 13:33:42 -04003859 */
Ming Lei742120c2008-06-18 22:00:29 +08003860int usb_reset_device(struct usb_device *udev)
Alan Stern79efa092006-06-01 13:33:42 -04003861{
3862 int ret;
Alan Stern852c4b42007-12-03 15:44:29 -05003863 int i;
Alan Stern79efa092006-06-01 13:33:42 -04003864 struct usb_host_config *config = udev->actconfig;
3865
3866 if (udev->state == USB_STATE_NOTATTACHED ||
3867 udev->state == USB_STATE_SUSPENDED) {
3868 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3869 udev->state);
3870 return -EINVAL;
3871 }
3872
Alan Stern645daaa2006-08-30 15:47:02 -04003873 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003874 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003875
Alan Stern79efa092006-06-01 13:33:42 -04003876 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04003877 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
Alan Stern852c4b42007-12-03 15:44:29 -05003878 struct usb_interface *cintf = config->interface[i];
3879 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04003880 int unbind = 0;
Alan Stern852c4b42007-12-03 15:44:29 -05003881
3882 if (cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04003883 drv = to_usb_driver(cintf->dev.driver);
Alan Stern78d9a482008-06-23 16:00:40 -04003884 if (drv->pre_reset && drv->post_reset)
3885 unbind = (drv->pre_reset)(cintf);
3886 else if (cintf->condition ==
3887 USB_INTERFACE_BOUND)
3888 unbind = 1;
3889 if (unbind)
3890 usb_forced_unbind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04003891 }
3892 }
3893 }
3894
Ming Lei742120c2008-06-18 22:00:29 +08003895 ret = usb_reset_and_verify_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003896
3897 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04003898 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
Alan Stern852c4b42007-12-03 15:44:29 -05003899 struct usb_interface *cintf = config->interface[i];
3900 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04003901 int rebind = cintf->needs_binding;
Alan Stern852c4b42007-12-03 15:44:29 -05003902
Alan Stern78d9a482008-06-23 16:00:40 -04003903 if (!rebind && cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04003904 drv = to_usb_driver(cintf->dev.driver);
3905 if (drv->post_reset)
Alan Stern78d9a482008-06-23 16:00:40 -04003906 rebind = (drv->post_reset)(cintf);
3907 else if (cintf->condition ==
3908 USB_INTERFACE_BOUND)
3909 rebind = 1;
Alan Stern79efa092006-06-01 13:33:42 -04003910 }
Alan Stern6c640942008-10-21 15:40:03 -04003911 if (ret == 0 && rebind)
Alan Stern78d9a482008-06-23 16:00:40 -04003912 usb_rebind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04003913 }
3914 }
3915
Alan Stern94fcda12006-11-20 11:38:46 -05003916 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003917 return ret;
3918}
Ming Lei742120c2008-06-18 22:00:29 +08003919EXPORT_SYMBOL_GPL(usb_reset_device);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08003920
3921
3922/**
3923 * usb_queue_reset_device - Reset a USB device from an atomic context
3924 * @iface: USB interface belonging to the device to reset
3925 *
3926 * This function can be used to reset a USB device from an atomic
3927 * context, where usb_reset_device() won't work (as it blocks).
3928 *
3929 * Doing a reset via this method is functionally equivalent to calling
3930 * usb_reset_device(), except for the fact that it is delayed to a
3931 * workqueue. This means that any drivers bound to other interfaces
3932 * might be unbound, as well as users from usbfs in user space.
3933 *
3934 * Corner cases:
3935 *
3936 * - Scheduling two resets at the same time from two different drivers
3937 * attached to two different interfaces of the same device is
3938 * possible; depending on how the driver attached to each interface
3939 * handles ->pre_reset(), the second reset might happen or not.
3940 *
3941 * - If a driver is unbound and it had a pending reset, the reset will
3942 * be cancelled.
3943 *
3944 * - This function can be called during .probe() or .disconnect()
3945 * times. On return from .disconnect(), any pending resets will be
3946 * cancelled.
3947 *
3948 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3949 * does its own.
3950 *
3951 * NOTE: We don't do any reference count tracking because it is not
3952 * needed. The lifecycle of the work_struct is tied to the
3953 * usb_interface. Before destroying the interface we cancel the
3954 * work_struct, so the fact that work_struct is queued and or
3955 * running means the interface (and thus, the device) exist and
3956 * are referenced.
3957 */
3958void usb_queue_reset_device(struct usb_interface *iface)
3959{
3960 schedule_work(&iface->reset_ws);
3961}
3962EXPORT_SYMBOL_GPL(usb_queue_reset_device);