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)
11 #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>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/kthread.h>
23 #include <linux/mutex.h>
24 #include <linux/freezer.h>
26 #include <asm/uaccess.h>
27 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
41 struct device
*intfdev
; /* the "interface" device */
42 struct usb_device
*hdev
;
44 struct urb
*urb
; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
48 dma_addr_t buffer_dma
; /* DMA address for buffer */
50 struct usb_hub_status hub
;
51 struct usb_port_status port
;
52 } *status
; /* buffer for status reports */
53 struct mutex status_mutex
; /* for the status buffer */
55 int error
; /* last reported error */
56 int nerrors
; /* track consecutive errors */
58 struct list_head event_list
; /* hubs w/data or errs ready */
59 unsigned long event_bits
[1]; /* status change bitmask */
60 unsigned long change_bits
[1]; /* ports with logical connect
62 unsigned long busy_bits
[1]; /* ports being reset or
64 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
65 #error event_bits[] is too short!
68 struct usb_hub_descriptor
*descriptor
; /* class descriptor */
69 struct usb_tt tt
; /* Transaction Translator */
71 unsigned mA_per_port
; /* current for each child */
73 unsigned limited_power
:1;
75 unsigned activating
:1;
76 unsigned disconnected
:1;
78 unsigned has_indicators
:1;
79 u8 indicator
[USB_MAXCHILDREN
];
80 struct delayed_work leds
;
84 /* Protect struct usb_device->state and ->children members
85 * Note: Both are also protected by ->dev.sem, except that ->state can
86 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
87 static DEFINE_SPINLOCK(device_state_lock
);
89 /* khubd's worklist and its lock */
90 static DEFINE_SPINLOCK(hub_event_lock
);
91 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
94 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
96 static struct task_struct
*khubd_task
;
98 /* cycle leds on hubs that aren't blinking for attention */
99 static int blinkenlights
= 0;
100 module_param (blinkenlights
, bool, S_IRUGO
);
101 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
104 * As of 2.6.10 we introduce a new USB device initialization scheme which
105 * closely resembles the way Windows works. Hopefully it will be compatible
106 * with a wider range of devices than the old scheme. However some previously
107 * working devices may start giving rise to "device not accepting address"
108 * errors; if that happens the user can try the old scheme by adjusting the
109 * following module parameters.
111 * For maximum flexibility there are two boolean parameters to control the
112 * hub driver's behavior. On the first initialization attempt, if the
113 * "old_scheme_first" parameter is set then the old scheme will be used,
114 * otherwise the new scheme is used. If that fails and "use_both_schemes"
115 * is set, then the driver will make another attempt, using the other scheme.
117 static int old_scheme_first
= 0;
118 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
119 MODULE_PARM_DESC(old_scheme_first
,
120 "start with the old device initialization scheme");
122 static int use_both_schemes
= 1;
123 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
124 MODULE_PARM_DESC(use_both_schemes
,
125 "try the other device initialization scheme if the "
128 /* Mutual exclusion for EHCI CF initialization. This interferes with
129 * port reset on some companion controllers.
131 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
132 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
135 static inline char *portspeed(int portstatus
)
137 if (portstatus
& (1 << USB_PORT_FEAT_HIGHSPEED
))
139 else if (portstatus
& (1 << USB_PORT_FEAT_LOWSPEED
))
145 /* Note that hdev or one of its children must be locked! */
146 static inline struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
148 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
151 /* USB 2.0 spec Section 11.24.4.5 */
152 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
, int size
)
156 for (i
= 0; i
< 3; i
++) {
157 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
158 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
159 USB_DT_HUB
<< 8, 0, data
, size
,
160 USB_CTRL_GET_TIMEOUT
);
161 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
168 * USB 2.0 spec Section 11.24.2.1
170 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
172 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
173 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
177 * USB 2.0 spec Section 11.24.2.2
179 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
181 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
182 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
187 * USB 2.0 spec Section 11.24.2.13
189 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
191 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
192 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
197 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
198 * for info about using port indicators
200 static void set_port_led(
206 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
207 USB_PORT_FEAT_INDICATOR
);
209 dev_dbg (hub
->intfdev
,
210 "port %d indicator %s status %d\n",
212 ({ char *s
; switch (selector
) {
213 case HUB_LED_AMBER
: s
= "amber"; break;
214 case HUB_LED_GREEN
: s
= "green"; break;
215 case HUB_LED_OFF
: s
= "off"; break;
216 case HUB_LED_AUTO
: s
= "auto"; break;
217 default: s
= "??"; break;
222 #define LED_CYCLE_PERIOD ((2*HZ)/3)
224 static void led_work (struct work_struct
*work
)
226 struct usb_hub
*hub
=
227 container_of(work
, struct usb_hub
, leds
.work
);
228 struct usb_device
*hdev
= hub
->hdev
;
230 unsigned changed
= 0;
233 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
236 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
237 unsigned selector
, mode
;
239 /* 30%-50% duty cycle */
241 switch (hub
->indicator
[i
]) {
243 case INDICATOR_CYCLE
:
245 selector
= HUB_LED_AUTO
;
246 mode
= INDICATOR_AUTO
;
248 /* blinking green = sw attention */
249 case INDICATOR_GREEN_BLINK
:
250 selector
= HUB_LED_GREEN
;
251 mode
= INDICATOR_GREEN_BLINK_OFF
;
253 case INDICATOR_GREEN_BLINK_OFF
:
254 selector
= HUB_LED_OFF
;
255 mode
= INDICATOR_GREEN_BLINK
;
257 /* blinking amber = hw attention */
258 case INDICATOR_AMBER_BLINK
:
259 selector
= HUB_LED_AMBER
;
260 mode
= INDICATOR_AMBER_BLINK_OFF
;
262 case INDICATOR_AMBER_BLINK_OFF
:
263 selector
= HUB_LED_OFF
;
264 mode
= INDICATOR_AMBER_BLINK
;
266 /* blink green/amber = reserved */
267 case INDICATOR_ALT_BLINK
:
268 selector
= HUB_LED_GREEN
;
269 mode
= INDICATOR_ALT_BLINK_OFF
;
271 case INDICATOR_ALT_BLINK_OFF
:
272 selector
= HUB_LED_AMBER
;
273 mode
= INDICATOR_ALT_BLINK
;
278 if (selector
!= HUB_LED_AUTO
)
280 set_port_led(hub
, i
+ 1, selector
);
281 hub
->indicator
[i
] = mode
;
283 if (!changed
&& blinkenlights
) {
285 cursor
%= hub
->descriptor
->bNbrPorts
;
286 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
287 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
291 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
294 /* use a short timeout for hub/port status fetches */
295 #define USB_STS_TIMEOUT 1000
296 #define USB_STS_RETRIES 5
299 * USB 2.0 spec Section 11.24.2.6
301 static int get_hub_status(struct usb_device
*hdev
,
302 struct usb_hub_status
*data
)
304 int i
, status
= -ETIMEDOUT
;
306 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
307 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
308 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
309 data
, sizeof(*data
), USB_STS_TIMEOUT
);
315 * USB 2.0 spec Section 11.24.2.7
317 static int get_port_status(struct usb_device
*hdev
, int port1
,
318 struct usb_port_status
*data
)
320 int i
, status
= -ETIMEDOUT
;
322 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
323 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
324 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
325 data
, sizeof(*data
), USB_STS_TIMEOUT
);
330 static int hub_port_status(struct usb_hub
*hub
, int port1
,
331 u16
*status
, u16
*change
)
335 mutex_lock(&hub
->status_mutex
);
336 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
338 dev_err(hub
->intfdev
,
339 "%s failed (err = %d)\n", __func__
, ret
);
343 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
344 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
347 mutex_unlock(&hub
->status_mutex
);
351 static void kick_khubd(struct usb_hub
*hub
)
355 /* Suppress autosuspend until khubd runs */
356 to_usb_interface(hub
->intfdev
)->pm_usage_cnt
= 1;
358 spin_lock_irqsave(&hub_event_lock
, flags
);
359 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
360 list_add_tail(&hub
->event_list
, &hub_event_list
);
361 wake_up(&khubd_wait
);
363 spin_unlock_irqrestore(&hub_event_lock
, flags
);
366 void usb_kick_khubd(struct usb_device
*hdev
)
368 /* FIXME: What if hdev isn't bound to the hub driver? */
369 kick_khubd(hdev_to_hub(hdev
));
373 /* completion function, fires on port status changes and various faults */
374 static void hub_irq(struct urb
*urb
)
376 struct usb_hub
*hub
= urb
->context
;
377 int status
= urb
->status
;
382 case -ENOENT
: /* synchronous unlink */
383 case -ECONNRESET
: /* async unlink */
384 case -ESHUTDOWN
: /* hardware going away */
387 default: /* presumably an error */
388 /* Cause a hub reset after 10 consecutive errors */
389 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
390 if ((++hub
->nerrors
< 10) || hub
->error
)
395 /* let khubd handle things */
396 case 0: /* we got data: port status changed */
398 for (i
= 0; i
< urb
->actual_length
; ++i
)
399 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
401 hub
->event_bits
[0] = bits
;
407 /* Something happened, let khubd figure it out */
414 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
415 && status
!= -ENODEV
&& status
!= -EPERM
)
416 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
419 /* USB 2.0 spec Section 11.24.2.3 */
421 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
423 return usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
424 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
429 * enumeration blocks khubd for a long time. we use keventd instead, since
430 * long blocking there is the exception, not the rule. accordingly, HCDs
431 * talking to TTs must queue control transfers (not just bulk and iso), so
432 * both can talk to the same hub concurrently.
434 static void hub_tt_kevent (struct work_struct
*work
)
436 struct usb_hub
*hub
=
437 container_of(work
, struct usb_hub
, tt
.kevent
);
441 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
442 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
443 struct list_head
*temp
;
444 struct usb_tt_clear
*clear
;
445 struct usb_device
*hdev
= hub
->hdev
;
448 temp
= hub
->tt
.clear_list
.next
;
449 clear
= list_entry (temp
, struct usb_tt_clear
, clear_list
);
450 list_del (&clear
->clear_list
);
452 /* drop lock so HCD can concurrently report other TT errors */
453 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
454 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
455 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
459 "clear tt %d (%04x) error %d\n",
460 clear
->tt
, clear
->devinfo
, status
);
463 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
467 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
468 * @udev: the device whose split transaction failed
469 * @pipe: identifies the endpoint of the failed transaction
471 * High speed HCDs use this to tell the hub driver that some split control or
472 * bulk transaction failed in a way that requires clearing internal state of
473 * a transaction translator. This is normally detected (and reported) from
476 * It may not be possible for that hub to handle additional full (or low)
477 * speed transactions until that state is fully cleared out.
479 void usb_hub_tt_clear_buffer (struct usb_device
*udev
, int pipe
)
481 struct usb_tt
*tt
= udev
->tt
;
483 struct usb_tt_clear
*clear
;
485 /* we've got to cope with an arbitrary number of pending TT clears,
486 * since each TT has "at least two" buffers that can need it (and
487 * there can be many TTs per hub). even if they're uncommon.
489 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
490 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
491 /* FIXME recover somehow ... RESET_TT? */
495 /* info that CLEAR_TT_BUFFER needs */
496 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
497 clear
->devinfo
= usb_pipeendpoint (pipe
);
498 clear
->devinfo
|= udev
->devnum
<< 4;
499 clear
->devinfo
|= usb_pipecontrol (pipe
)
500 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
501 : (USB_ENDPOINT_XFER_BULK
<< 11);
502 if (usb_pipein (pipe
))
503 clear
->devinfo
|= 1 << 15;
505 /* tell keventd to clear state for this TT */
506 spin_lock_irqsave (&tt
->lock
, flags
);
507 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
508 schedule_work (&tt
->kevent
);
509 spin_unlock_irqrestore (&tt
->lock
, flags
);
511 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer
);
513 static void hub_power_on(struct usb_hub
*hub
)
516 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
517 u16 wHubCharacteristics
=
518 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
520 /* Enable power on each port. Some hubs have reserved values
521 * of LPSM (> 2) in their descriptors, even though they are
522 * USB 2.0 hubs. Some hubs do not implement port-power switching
523 * but only emulate it. In all cases, the ports won't work
524 * unless we send these messages to the hub.
526 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
527 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
529 dev_dbg(hub
->intfdev
, "trying to enable port power on "
530 "non-switchable hub\n");
531 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
532 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
534 /* Wait at least 100 msec for power to become stable */
535 msleep(max(pgood_delay
, (unsigned) 100));
538 static void hub_quiesce(struct usb_hub
*hub
)
540 /* (nonblocking) khubd and related activity won't re-trigger */
544 /* (blocking) stop khubd and related activity */
545 usb_kill_urb(hub
->urb
);
546 if (hub
->has_indicators
)
547 cancel_delayed_work_sync(&hub
->leds
);
549 cancel_work_sync(&hub
->tt
.kevent
);
552 static void hub_activate(struct usb_hub
*hub
)
559 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
561 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
562 if (hub
->has_indicators
&& blinkenlights
)
563 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
565 /* scan all ports ASAP */
569 static int hub_hub_status(struct usb_hub
*hub
,
570 u16
*status
, u16
*change
)
574 mutex_lock(&hub
->status_mutex
);
575 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
577 dev_err (hub
->intfdev
,
578 "%s failed (err = %d)\n", __FUNCTION__
, ret
);
580 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
581 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
584 mutex_unlock(&hub
->status_mutex
);
588 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
590 struct usb_device
*hdev
= hub
->hdev
;
593 if (hdev
->children
[port1
-1] && set_state
)
594 usb_set_device_state(hdev
->children
[port1
-1],
595 USB_STATE_NOTATTACHED
);
597 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
599 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
605 * Disable a port and mark a logical connnect-change event, so that some
606 * time later khubd will disconnect() any existing usb_device on the port
607 * and will re-enumerate if there actually is a device attached.
609 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
611 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
612 hub_port_disable(hub
, port1
, 1);
614 /* FIXME let caller ask to power down the port:
615 * - some devices won't enumerate without a VBUS power cycle
616 * - SRP saves power that way
617 * - ... new call, TBD ...
618 * That's easy if this hub can switch power per-port, and
619 * khubd reactivates the port later (timer, SRP, etc).
620 * Powerdown must be optional, because of reset/DFU.
623 set_bit(port1
, hub
->change_bits
);
627 /* caller has locked the hub device */
628 static void hub_stop(struct usb_hub
*hub
)
630 struct usb_device
*hdev
= hub
->hdev
;
633 /* Disconnect all the children */
634 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
635 if (hdev
->children
[i
])
636 usb_disconnect(&hdev
->children
[i
]);
643 #define HUB_RESET_RESUME 3
647 static void hub_restart(struct usb_hub
*hub
, int type
)
649 struct usb_device
*hdev
= hub
->hdev
;
652 /* Check each of the children to see if they require
653 * USB-PERSIST handling or disconnection. Also check
654 * each unoccupied port to make sure it is still disabled.
656 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
657 struct usb_device
*udev
= hdev
->children
[port1
-1];
659 u16 portstatus
, portchange
;
661 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
662 if (type
!= HUB_RESET
) {
663 status
= hub_port_status(hub
, port1
,
664 &portstatus
, &portchange
);
665 if (status
== 0 && (portstatus
&
666 USB_PORT_STAT_ENABLE
))
667 clear_port_feature(hdev
, port1
,
668 USB_PORT_FEAT_ENABLE
);
673 /* Was the power session lost while we were suspended? */
675 case HUB_RESET_RESUME
:
677 portchange
= USB_PORT_STAT_C_CONNECTION
;
682 status
= hub_port_status(hub
, port1
,
683 &portstatus
, &portchange
);
687 /* For "USB_PERSIST"-enabled children we must
688 * mark the child device for reset-resume and
689 * turn off the various status changes to prevent
690 * khubd from disconnecting it later.
692 if (udev
->persist_enabled
&& status
== 0 &&
693 !(portstatus
& USB_PORT_STAT_ENABLE
)) {
694 if (portchange
& USB_PORT_STAT_C_ENABLE
)
695 clear_port_feature(hub
->hdev
, port1
,
696 USB_PORT_FEAT_C_ENABLE
);
697 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
698 clear_port_feature(hub
->hdev
, port1
,
699 USB_PORT_FEAT_C_CONNECTION
);
700 udev
->reset_resume
= 1;
703 /* Otherwise for a reset_resume we must disconnect the child,
704 * but as we may not lock the child device here
705 * we have to do a "logical" disconnect.
707 else if (type
== HUB_RESET_RESUME
)
708 hub_port_logical_disconnect(hub
, port1
);
714 #endif /* CONFIG_PM */
716 /* caller has locked the hub device */
717 static int hub_pre_reset(struct usb_interface
*intf
)
719 struct usb_hub
*hub
= usb_get_intfdata(intf
);
725 /* caller has locked the hub device */
726 static int hub_post_reset(struct usb_interface
*intf
)
728 struct usb_hub
*hub
= usb_get_intfdata(intf
);
735 static int hub_configure(struct usb_hub
*hub
,
736 struct usb_endpoint_descriptor
*endpoint
)
738 struct usb_device
*hdev
= hub
->hdev
;
739 struct device
*hub_dev
= hub
->intfdev
;
740 u16 hubstatus
, hubchange
;
741 u16 wHubCharacteristics
;
746 hub
->buffer
= usb_buffer_alloc(hdev
, sizeof(*hub
->buffer
), GFP_KERNEL
,
749 message
= "can't allocate hub irq buffer";
754 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
756 message
= "can't kmalloc hub status buffer";
760 mutex_init(&hub
->status_mutex
);
762 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
763 if (!hub
->descriptor
) {
764 message
= "can't kmalloc hub descriptor";
769 /* Request the entire hub descriptor.
770 * hub->descriptor can handle USB_MAXCHILDREN ports,
771 * but the hub can/will return fewer bytes here.
773 ret
= get_hub_descriptor(hdev
, hub
->descriptor
,
774 sizeof(*hub
->descriptor
));
776 message
= "can't read hub descriptor";
778 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
779 message
= "hub has too many ports!";
784 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
785 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
786 (hdev
->maxchild
== 1) ? "" : "s");
788 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
790 if (wHubCharacteristics
& HUB_CHAR_COMPOUND
) {
792 char portstr
[USB_MAXCHILDREN
+ 1];
794 for (i
= 0; i
< hdev
->maxchild
; i
++)
795 portstr
[i
] = hub
->descriptor
->DeviceRemovable
796 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
798 portstr
[hdev
->maxchild
] = 0;
799 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
801 dev_dbg(hub_dev
, "standalone hub\n");
803 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
805 dev_dbg(hub_dev
, "ganged power switching\n");
808 dev_dbg(hub_dev
, "individual port power switching\n");
812 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
816 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
818 dev_dbg(hub_dev
, "global over-current protection\n");
821 dev_dbg(hub_dev
, "individual port over-current protection\n");
825 dev_dbg(hub_dev
, "no over-current protection\n");
829 spin_lock_init (&hub
->tt
.lock
);
830 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
831 INIT_WORK (&hub
->tt
.kevent
, hub_tt_kevent
);
832 switch (hdev
->descriptor
.bDeviceProtocol
) {
836 dev_dbg(hub_dev
, "Single TT\n");
840 ret
= usb_set_interface(hdev
, 0, 1);
842 dev_dbg(hub_dev
, "TT per port\n");
845 dev_err(hub_dev
, "Using single TT (err %d)\n",
850 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
851 hdev
->descriptor
.bDeviceProtocol
);
855 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
856 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
857 case HUB_TTTT_8_BITS
:
858 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
859 hub
->tt
.think_time
= 666;
860 dev_dbg(hub_dev
, "TT requires at most %d "
861 "FS bit times (%d ns)\n",
862 8, hub
->tt
.think_time
);
865 case HUB_TTTT_16_BITS
:
866 hub
->tt
.think_time
= 666 * 2;
867 dev_dbg(hub_dev
, "TT requires at most %d "
868 "FS bit times (%d ns)\n",
869 16, hub
->tt
.think_time
);
871 case HUB_TTTT_24_BITS
:
872 hub
->tt
.think_time
= 666 * 3;
873 dev_dbg(hub_dev
, "TT requires at most %d "
874 "FS bit times (%d ns)\n",
875 24, hub
->tt
.think_time
);
877 case HUB_TTTT_32_BITS
:
878 hub
->tt
.think_time
= 666 * 4;
879 dev_dbg(hub_dev
, "TT requires at most %d "
880 "FS bit times (%d ns)\n",
881 32, hub
->tt
.think_time
);
885 /* probe() zeroes hub->indicator[] */
886 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
887 hub
->has_indicators
= 1;
888 dev_dbg(hub_dev
, "Port indicators are supported\n");
891 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
892 hub
->descriptor
->bPwrOn2PwrGood
* 2);
894 /* power budgeting mostly matters with bus-powered hubs,
895 * and battery-powered root hubs (may provide just 8 mA).
897 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
899 message
= "can't get hub status";
902 le16_to_cpus(&hubstatus
);
903 if (hdev
== hdev
->bus
->root_hub
) {
904 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
905 hub
->mA_per_port
= 500;
907 hub
->mA_per_port
= hdev
->bus_mA
;
908 hub
->limited_power
= 1;
910 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
911 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
912 hub
->descriptor
->bHubContrCurrent
);
913 hub
->limited_power
= 1;
914 if (hdev
->maxchild
> 0) {
915 int remaining
= hdev
->bus_mA
-
916 hub
->descriptor
->bHubContrCurrent
;
918 if (remaining
< hdev
->maxchild
* 100)
920 "insufficient power available "
921 "to use all downstream ports\n");
922 hub
->mA_per_port
= 100; /* 7.2.1.1 */
924 } else { /* Self-powered external hub */
925 /* FIXME: What about battery-powered external hubs that
926 * provide less current per port? */
927 hub
->mA_per_port
= 500;
929 if (hub
->mA_per_port
< 500)
930 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
933 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
935 message
= "can't get hub status";
939 /* local power status reports aren't always correct */
940 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
941 dev_dbg(hub_dev
, "local power source is %s\n",
942 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
943 ? "lost (inactive)" : "good");
945 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
946 dev_dbg(hub_dev
, "%sover-current condition exists\n",
947 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
949 /* set up the interrupt endpoint
950 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
951 * bytes as USB2.0[11.12.3] says because some hubs are known
952 * to send more data (and thus cause overflow). For root hubs,
953 * maxpktsize is defined in hcd.c's fake endpoint descriptors
954 * to be big enough for at least USB_MAXCHILDREN ports. */
955 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
956 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
958 if (maxp
> sizeof(*hub
->buffer
))
959 maxp
= sizeof(*hub
->buffer
);
961 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
963 message
= "couldn't allocate interrupt urb";
968 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
969 hub
, endpoint
->bInterval
);
970 hub
->urb
->transfer_dma
= hub
->buffer_dma
;
971 hub
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
973 /* maybe cycle the hub leds */
974 if (hub
->has_indicators
&& blinkenlights
)
975 hub
->indicator
[0] = INDICATOR_CYCLE
;
982 dev_err (hub_dev
, "config failed, %s (err %d)\n",
984 /* hub_disconnect() frees urb and descriptor */
988 static void hub_release(struct kref
*kref
)
990 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
992 usb_put_intf(to_usb_interface(hub
->intfdev
));
996 static unsigned highspeed_hubs
;
998 static void hub_disconnect(struct usb_interface
*intf
)
1000 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1002 /* Take the hub off the event list and don't let it be added again */
1003 spin_lock_irq(&hub_event_lock
);
1004 list_del_init(&hub
->event_list
);
1005 hub
->disconnected
= 1;
1006 spin_unlock_irq(&hub_event_lock
);
1008 /* Disconnect all children and quiesce the hub */
1012 usb_set_intfdata (intf
, NULL
);
1014 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1017 usb_free_urb(hub
->urb
);
1018 kfree(hub
->descriptor
);
1020 usb_buffer_free(hub
->hdev
, sizeof(*hub
->buffer
), hub
->buffer
,
1023 kref_put(&hub
->kref
, hub_release
);
1026 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1028 struct usb_host_interface
*desc
;
1029 struct usb_endpoint_descriptor
*endpoint
;
1030 struct usb_device
*hdev
;
1031 struct usb_hub
*hub
;
1033 desc
= intf
->cur_altsetting
;
1034 hdev
= interface_to_usbdev(intf
);
1036 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1038 dev_warn(&intf
->dev
, "ignoring external hub\n");
1043 /* Some hubs have a subclass of 1, which AFAICT according to the */
1044 /* specs is not defined, but it works */
1045 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1046 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1048 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1052 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1053 if (desc
->desc
.bNumEndpoints
!= 1)
1054 goto descriptor_error
;
1056 endpoint
= &desc
->endpoint
[0].desc
;
1058 /* If it's not an interrupt in endpoint, we'd better punt! */
1059 if (!usb_endpoint_is_int_in(endpoint
))
1060 goto descriptor_error
;
1062 /* We found a hub */
1063 dev_info (&intf
->dev
, "USB hub found\n");
1065 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1067 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1071 kref_init(&hub
->kref
);
1072 INIT_LIST_HEAD(&hub
->event_list
);
1073 hub
->intfdev
= &intf
->dev
;
1075 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1078 usb_set_intfdata (intf
, hub
);
1079 intf
->needs_remote_wakeup
= 1;
1081 if (hdev
->speed
== USB_SPEED_HIGH
)
1084 if (hub_configure(hub
, endpoint
) >= 0)
1087 hub_disconnect (intf
);
1092 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1094 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1096 /* assert ifno == 0 (part of hub spec) */
1098 case USBDEVFS_HUB_PORTINFO
: {
1099 struct usbdevfs_hub_portinfo
*info
= user_data
;
1102 spin_lock_irq(&device_state_lock
);
1103 if (hdev
->devnum
<= 0)
1106 info
->nports
= hdev
->maxchild
;
1107 for (i
= 0; i
< info
->nports
; i
++) {
1108 if (hdev
->children
[i
] == NULL
)
1112 hdev
->children
[i
]->devnum
;
1115 spin_unlock_irq(&device_state_lock
);
1117 return info
->nports
+ 1;
1126 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1130 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1131 if (udev
->children
[i
])
1132 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1134 if (udev
->state
== USB_STATE_SUSPENDED
) {
1135 udev
->discon_suspended
= 1;
1136 udev
->active_duration
-= jiffies
;
1138 udev
->state
= USB_STATE_NOTATTACHED
;
1142 * usb_set_device_state - change a device's current state (usbcore, hcds)
1143 * @udev: pointer to device whose state should be changed
1144 * @new_state: new state value to be stored
1146 * udev->state is _not_ fully protected by the device lock. Although
1147 * most transitions are made only while holding the lock, the state can
1148 * can change to USB_STATE_NOTATTACHED at almost any time. This
1149 * is so that devices can be marked as disconnected as soon as possible,
1150 * without having to wait for any semaphores to be released. As a result,
1151 * all changes to any device's state must be protected by the
1152 * device_state_lock spinlock.
1154 * Once a device has been added to the device tree, all changes to its state
1155 * should be made using this routine. The state should _not_ be set directly.
1157 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1158 * Otherwise udev->state is set to new_state, and if new_state is
1159 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1160 * to USB_STATE_NOTATTACHED.
1162 void usb_set_device_state(struct usb_device
*udev
,
1163 enum usb_device_state new_state
)
1165 unsigned long flags
;
1167 spin_lock_irqsave(&device_state_lock
, flags
);
1168 if (udev
->state
== USB_STATE_NOTATTACHED
)
1170 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1172 /* root hub wakeup capabilities are managed out-of-band
1173 * and may involve silicon errata ... ignore them here.
1176 if (udev
->state
== USB_STATE_SUSPENDED
1177 || new_state
== USB_STATE_SUSPENDED
)
1178 ; /* No change to wakeup settings */
1179 else if (new_state
== USB_STATE_CONFIGURED
)
1180 device_init_wakeup(&udev
->dev
,
1181 (udev
->actconfig
->desc
.bmAttributes
1182 & USB_CONFIG_ATT_WAKEUP
));
1184 device_init_wakeup(&udev
->dev
, 0);
1186 if (udev
->state
== USB_STATE_SUSPENDED
&&
1187 new_state
!= USB_STATE_SUSPENDED
)
1188 udev
->active_duration
-= jiffies
;
1189 else if (new_state
== USB_STATE_SUSPENDED
&&
1190 udev
->state
!= USB_STATE_SUSPENDED
)
1191 udev
->active_duration
+= jiffies
;
1192 udev
->state
= new_state
;
1194 recursively_mark_NOTATTACHED(udev
);
1195 spin_unlock_irqrestore(&device_state_lock
, flags
);
1198 static void choose_address(struct usb_device
*udev
)
1201 struct usb_bus
*bus
= udev
->bus
;
1203 /* If khubd ever becomes multithreaded, this will need a lock */
1205 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1206 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1209 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128, 1);
1211 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1214 set_bit(devnum
, bus
->devmap
.devicemap
);
1215 udev
->devnum
= devnum
;
1219 static void release_address(struct usb_device
*udev
)
1221 if (udev
->devnum
> 0) {
1222 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1227 #ifdef CONFIG_USB_SUSPEND
1229 static void usb_stop_pm(struct usb_device
*udev
)
1231 /* Synchronize with the ksuspend thread to prevent any more
1232 * autosuspend requests from being submitted, and decrement
1233 * the parent's count of unsuspended children.
1236 if (udev
->parent
&& !udev
->discon_suspended
)
1237 usb_autosuspend_device(udev
->parent
);
1238 usb_pm_unlock(udev
);
1240 /* Stop any autosuspend requests already submitted */
1241 cancel_rearming_delayed_work(&udev
->autosuspend
);
1246 static inline void usb_stop_pm(struct usb_device
*udev
)
1252 * usb_disconnect - disconnect a device (usbcore-internal)
1253 * @pdev: pointer to device being disconnected
1254 * Context: !in_interrupt ()
1256 * Something got disconnected. Get rid of it and all of its children.
1258 * If *pdev is a normal device then the parent hub must already be locked.
1259 * If *pdev is a root hub then this routine will acquire the
1260 * usb_bus_list_lock on behalf of the caller.
1262 * Only hub drivers (including virtual root hub drivers for host
1263 * controllers) should ever call this.
1265 * This call is synchronous, and may not be used in an interrupt context.
1267 void usb_disconnect(struct usb_device
**pdev
)
1269 struct usb_device
*udev
= *pdev
;
1273 pr_debug ("%s nodev\n", __FUNCTION__
);
1277 /* mark the device as inactive, so any further urb submissions for
1278 * this device (and any of its children) will fail immediately.
1279 * this quiesces everyting except pending urbs.
1281 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1282 dev_info (&udev
->dev
, "USB disconnect, address %d\n", udev
->devnum
);
1284 usb_lock_device(udev
);
1286 /* Free up all the children before we remove this device */
1287 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1288 if (udev
->children
[i
])
1289 usb_disconnect(&udev
->children
[i
]);
1292 /* deallocate hcd/hardware state ... nuking all pending urbs and
1293 * cleaning up all state associated with the current configuration
1294 * so that the hardware is now fully quiesced.
1296 dev_dbg (&udev
->dev
, "unregistering device\n");
1297 usb_disable_device(udev
, 0);
1299 usb_unlock_device(udev
);
1301 /* Unregister the device. The device driver is responsible
1302 * for removing the device files from usbfs and sysfs and for
1303 * de-configuring the device.
1305 device_del(&udev
->dev
);
1307 /* Free the device number and delete the parent's children[]
1308 * (or root_hub) pointer.
1310 release_address(udev
);
1312 /* Avoid races with recursively_mark_NOTATTACHED() */
1313 spin_lock_irq(&device_state_lock
);
1315 spin_unlock_irq(&device_state_lock
);
1319 put_device(&udev
->dev
);
1322 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1323 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1327 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1330 static void announce_device(struct usb_device
*udev
)
1332 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1333 le16_to_cpu(udev
->descriptor
.idVendor
),
1334 le16_to_cpu(udev
->descriptor
.idProduct
));
1335 dev_info(&udev
->dev
, "New USB device strings: Mfr=%d, Product=%d, "
1336 "SerialNumber=%d\n",
1337 udev
->descriptor
.iManufacturer
,
1338 udev
->descriptor
.iProduct
,
1339 udev
->descriptor
.iSerialNumber
);
1340 show_string(udev
, "Product", udev
->product
);
1341 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1342 show_string(udev
, "SerialNumber", udev
->serial
);
1345 static inline void announce_device(struct usb_device
*udev
) { }
1348 #ifdef CONFIG_USB_OTG
1349 #include "otg_whitelist.h"
1353 * usb_configure_device_otg - FIXME (usbcore-internal)
1354 * @udev: newly addressed device (in ADDRESS state)
1356 * Do configuration for On-The-Go devices
1358 static int usb_configure_device_otg(struct usb_device
*udev
)
1362 #ifdef CONFIG_USB_OTG
1364 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1365 * to wake us after we've powered off VBUS; and HNP, switching roles
1366 * "host" to "peripheral". The OTG descriptor helps figure this out.
1368 if (!udev
->bus
->is_b_host
1370 && udev
->parent
== udev
->bus
->root_hub
) {
1371 struct usb_otg_descriptor
*desc
= 0;
1372 struct usb_bus
*bus
= udev
->bus
;
1374 /* descriptor may appear anywhere in config */
1375 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1376 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1377 USB_DT_OTG
, (void **) &desc
) == 0) {
1378 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1379 unsigned port1
= udev
->portnum
;
1381 dev_info(&udev
->dev
,
1382 "Dual-Role OTG device on %sHNP port\n",
1383 (port1
== bus
->otg_port
)
1386 /* enable HNP before suspend, it's simpler */
1387 if (port1
== bus
->otg_port
)
1388 bus
->b_hnp_enable
= 1;
1389 err
= usb_control_msg(udev
,
1390 usb_sndctrlpipe(udev
, 0),
1391 USB_REQ_SET_FEATURE
, 0,
1393 ? USB_DEVICE_B_HNP_ENABLE
1394 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1395 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1397 /* OTG MESSAGE: report errors here,
1398 * customize to match your product.
1400 dev_info(&udev
->dev
,
1401 "can't set HNP mode; %d\n",
1403 bus
->b_hnp_enable
= 0;
1409 if (!is_targeted(udev
)) {
1411 /* Maybe it can talk to us, though we can't talk to it.
1412 * (Includes HNP test device.)
1414 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1415 err
= usb_port_suspend(udev
);
1417 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1429 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1430 * @udev: newly addressed device (in ADDRESS state)
1432 * This is only called by usb_new_device() and usb_authorize_device()
1433 * and FIXME -- all comments that apply to them apply here wrt to
1436 * If the device is WUSB and not authorized, we don't attempt to read
1437 * the string descriptors, as they will be errored out by the device
1438 * until it has been authorized.
1440 static int usb_configure_device(struct usb_device
*udev
)
1444 if (udev
->config
== NULL
) {
1445 err
= usb_get_configuration(udev
);
1447 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1452 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1453 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1454 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1455 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1458 /* read the standard strings and cache them if present */
1459 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1460 udev
->manufacturer
= usb_cache_string(udev
,
1461 udev
->descriptor
.iManufacturer
);
1462 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1464 err
= usb_configure_device_otg(udev
);
1471 * usb_new_device - perform initial device setup (usbcore-internal)
1472 * @udev: newly addressed device (in ADDRESS state)
1474 * This is called with devices which have been enumerated, but not yet
1475 * configured. The device descriptor is available, but not descriptors
1476 * for any device configuration. The caller must have locked either
1477 * the parent hub (if udev is a normal device) or else the
1478 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1479 * udev has already been installed, but udev is not yet visible through
1480 * sysfs or other filesystem code.
1482 * It will return if the device is configured properly or not. Zero if
1483 * the interface was registered with the driver core; else a negative
1486 * This call is synchronous, and may not be used in an interrupt context.
1488 * Only the hub driver or root-hub registrar should ever call this.
1490 int usb_new_device(struct usb_device
*udev
)
1494 usb_detect_quirks(udev
); /* Determine quirks */
1495 err
= usb_configure_device(udev
); /* detect & probe dev/intfs */
1498 /* export the usbdev device-node for libusb */
1499 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1500 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1502 /* Increment the parent's count of unsuspended children */
1504 usb_autoresume_device(udev
->parent
);
1506 /* Register the device. The device driver is responsible
1507 * for adding the device files to sysfs and for configuring
1510 err
= device_add(&udev
->dev
);
1512 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1516 /* Tell the world! */
1517 announce_device(udev
);
1521 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1527 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1528 * @usb_dev: USB device
1530 * Move the USB device to a very basic state where interfaces are disabled
1531 * and the device is in fact unconfigured and unusable.
1533 * We share a lock (that we have) with device_del(), so we need to
1536 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1539 usb_lock_device(usb_dev
);
1540 if (usb_dev
->authorized
== 0)
1541 goto out_unauthorized
;
1542 usb_dev
->authorized
= 0;
1543 usb_set_configuration(usb_dev
, -1);
1544 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1545 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1546 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1547 kfree(usb_dev
->config
);
1548 usb_dev
->config
= NULL
;
1549 for (cnt
= 0; cnt
< usb_dev
->descriptor
.bNumConfigurations
; cnt
++)
1550 kfree(usb_dev
->rawdescriptors
[cnt
]);
1551 usb_dev
->descriptor
.bNumConfigurations
= 0;
1552 kfree(usb_dev
->rawdescriptors
);
1554 usb_unlock_device(usb_dev
);
1559 int usb_authorize_device(struct usb_device
*usb_dev
)
1562 usb_lock_device(usb_dev
);
1563 if (usb_dev
->authorized
== 1)
1564 goto out_authorized
;
1565 kfree(usb_dev
->product
);
1566 usb_dev
->product
= NULL
;
1567 kfree(usb_dev
->manufacturer
);
1568 usb_dev
->manufacturer
= NULL
;
1569 kfree(usb_dev
->serial
);
1570 usb_dev
->serial
= NULL
;
1571 result
= usb_autoresume_device(usb_dev
);
1573 dev_err(&usb_dev
->dev
,
1574 "can't autoresume for authorization: %d\n", result
);
1575 goto error_autoresume
;
1577 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1579 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1580 "authorization: %d\n", result
);
1581 goto error_device_descriptor
;
1583 usb_dev
->authorized
= 1;
1584 result
= usb_configure_device(usb_dev
);
1586 goto error_configure
;
1587 /* Choose and set the configuration. This registers the interfaces
1588 * with the driver core and lets interface drivers bind to them.
1590 c
= usb_choose_configuration(usb_dev
);
1592 result
= usb_set_configuration(usb_dev
, c
);
1594 dev_err(&usb_dev
->dev
,
1595 "can't set config #%d, error %d\n", c
, result
);
1596 /* This need not be fatal. The user can try to
1597 * set other configurations. */
1600 dev_info(&usb_dev
->dev
, "authorized to connect\n");
1602 error_device_descriptor
:
1605 usb_unlock_device(usb_dev
); // complements locktree
1610 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1611 static unsigned hub_is_wusb(struct usb_hub
*hub
)
1613 struct usb_hcd
*hcd
;
1614 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
1616 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
1617 return hcd
->wireless
;
1621 #define PORT_RESET_TRIES 5
1622 #define SET_ADDRESS_TRIES 2
1623 #define GET_DESCRIPTOR_TRIES 2
1624 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1625 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1627 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1628 #define HUB_SHORT_RESET_TIME 10
1629 #define HUB_LONG_RESET_TIME 200
1630 #define HUB_RESET_TIMEOUT 500
1632 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1633 struct usb_device
*udev
, unsigned int delay
)
1635 int delay_time
, ret
;
1639 for (delay_time
= 0;
1640 delay_time
< HUB_RESET_TIMEOUT
;
1641 delay_time
+= delay
) {
1642 /* wait to give the device a chance to reset */
1645 /* read and decode port status */
1646 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1650 /* Device went away? */
1651 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1654 /* bomb out completely if the connection bounced */
1655 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1658 /* if we`ve finished resetting, then break out of the loop */
1659 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1660 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1661 if (hub_is_wusb(hub
))
1662 udev
->speed
= USB_SPEED_VARIABLE
;
1663 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1664 udev
->speed
= USB_SPEED_HIGH
;
1665 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1666 udev
->speed
= USB_SPEED_LOW
;
1668 udev
->speed
= USB_SPEED_FULL
;
1672 /* switch to the long delay after two short delay failures */
1673 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1674 delay
= HUB_LONG_RESET_TIME
;
1676 dev_dbg (hub
->intfdev
,
1677 "port %d not reset yet, waiting %dms\n",
1684 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1685 struct usb_device
*udev
, unsigned int delay
)
1689 /* Block EHCI CF initialization during the port reset.
1690 * Some companion controllers don't like it when they mix.
1692 down_read(&ehci_cf_port_reset_rwsem
);
1694 /* Reset the port */
1695 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1696 status
= set_port_feature(hub
->hdev
,
1697 port1
, USB_PORT_FEAT_RESET
);
1699 dev_err(hub
->intfdev
,
1700 "cannot reset port %d (err = %d)\n",
1703 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1704 if (status
&& status
!= -ENOTCONN
)
1705 dev_dbg(hub
->intfdev
,
1706 "port_wait_reset: err = %d\n",
1710 /* return on disconnect or reset */
1713 /* TRSTRCY = 10 ms; plus some extra */
1715 udev
->devnum
= 0; /* Device now at address 0 */
1719 clear_port_feature(hub
->hdev
,
1720 port1
, USB_PORT_FEAT_C_RESET
);
1721 /* FIXME need disconnect() for NOTATTACHED device */
1722 usb_set_device_state(udev
, status
1723 ? USB_STATE_NOTATTACHED
1724 : USB_STATE_DEFAULT
);
1728 dev_dbg (hub
->intfdev
,
1729 "port %d not enabled, trying reset again...\n",
1731 delay
= HUB_LONG_RESET_TIME
;
1734 dev_err (hub
->intfdev
,
1735 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1739 up_read(&ehci_cf_port_reset_rwsem
);
1745 #ifdef CONFIG_USB_SUSPEND
1748 * usb_port_suspend - suspend a usb device's upstream port
1749 * @udev: device that's no longer in active use, not a root hub
1750 * Context: must be able to sleep; device not locked; pm locks held
1752 * Suspends a USB device that isn't in active use, conserving power.
1753 * Devices may wake out of a suspend, if anything important happens,
1754 * using the remote wakeup mechanism. They may also be taken out of
1755 * suspend by the host, using usb_port_resume(). It's also routine
1756 * to disconnect devices while they are suspended.
1758 * This only affects the USB hardware for a device; its interfaces
1759 * (and, for hubs, child devices) must already have been suspended.
1761 * Selective port suspend reduces power; most suspended devices draw
1762 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1763 * All devices below the suspended port are also suspended.
1765 * Devices leave suspend state when the host wakes them up. Some devices
1766 * also support "remote wakeup", where the device can activate the USB
1767 * tree above them to deliver data, such as a keypress or packet. In
1768 * some cases, this wakes the USB host.
1770 * Suspending OTG devices may trigger HNP, if that's been enabled
1771 * between a pair of dual-role devices. That will change roles, such
1772 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1774 * Devices on USB hub ports have only one "suspend" state, corresponding
1775 * to ACPI D2, "may cause the device to lose some context".
1776 * State transitions include:
1778 * - suspend, resume ... when the VBUS power link stays live
1779 * - suspend, disconnect ... VBUS lost
1781 * Once VBUS drop breaks the circuit, the port it's using has to go through
1782 * normal re-enumeration procedures, starting with enabling VBUS power.
1783 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1784 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1785 * timer, no SRP, no requests through sysfs.
1787 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1788 * the root hub for their bus goes into global suspend ... so we don't
1789 * (falsely) update the device power state to say it suspended.
1791 * Returns 0 on success, else negative errno.
1793 int usb_port_suspend(struct usb_device
*udev
)
1795 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1796 int port1
= udev
->portnum
;
1799 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1801 /* enable remote wakeup when appropriate; this lets the device
1802 * wake up the upstream hub (including maybe the root hub).
1804 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1805 * we don't explicitly enable it here.
1807 if (udev
->do_remote_wakeup
) {
1808 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1809 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
1810 USB_DEVICE_REMOTE_WAKEUP
, 0,
1812 USB_CTRL_SET_TIMEOUT
);
1814 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
1819 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
1821 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
1823 /* paranoia: "should not happen" */
1824 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1825 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
1826 USB_DEVICE_REMOTE_WAKEUP
, 0,
1828 USB_CTRL_SET_TIMEOUT
);
1830 /* device has up to 10 msec to fully suspend */
1831 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
1832 udev
->auto_pm
? "auto-" : "");
1833 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
1840 * If the USB "suspend" state is in use (rather than "global suspend"),
1841 * many devices will be individually taken out of suspend state using
1842 * special "resume" signaling. This routine kicks in shortly after
1843 * hardware resume signaling is finished, either because of selective
1844 * resume (by host) or remote wakeup (by device) ... now see what changed
1845 * in the tree that's rooted at this device.
1847 * If @udev->reset_resume is set then the device is reset before the
1848 * status check is done.
1850 static int finish_port_resume(struct usb_device
*udev
)
1855 /* caller owns the udev device lock */
1856 dev_dbg(&udev
->dev
, "finish %sresume\n",
1857 udev
->reset_resume
? "reset-" : "");
1859 /* usb ch9 identifies four variants of SUSPENDED, based on what
1860 * state the device resumes to. Linux currently won't see the
1861 * first two on the host side; they'd be inside hub_port_init()
1862 * during many timeouts, but khubd can't suspend until later.
1864 usb_set_device_state(udev
, udev
->actconfig
1865 ? USB_STATE_CONFIGURED
1866 : USB_STATE_ADDRESS
);
1868 /* 10.5.4.5 says not to reset a suspended port if the attached
1869 * device is enabled for remote wakeup. Hence the reset
1870 * operation is carried out here, after the port has been
1873 if (udev
->reset_resume
)
1874 status
= usb_reset_device(udev
);
1876 /* 10.5.4.5 says be sure devices in the tree are still there.
1877 * For now let's assume the device didn't go crazy on resume,
1878 * and device drivers will know about any resume quirks.
1882 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
1884 status
= (status
> 0 ? 0 : -ENODEV
);
1888 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
1890 } else if (udev
->actconfig
) {
1891 le16_to_cpus(&devstatus
);
1892 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
1893 status
= usb_control_msg(udev
,
1894 usb_sndctrlpipe(udev
, 0),
1895 USB_REQ_CLEAR_FEATURE
,
1897 USB_DEVICE_REMOTE_WAKEUP
, 0,
1899 USB_CTRL_SET_TIMEOUT
);
1901 dev_dbg(&udev
->dev
, "disable remote "
1902 "wakeup, status %d\n", status
);
1910 * usb_port_resume - re-activate a suspended usb device's upstream port
1911 * @udev: device to re-activate, not a root hub
1912 * Context: must be able to sleep; device not locked; pm locks held
1914 * This will re-activate the suspended device, increasing power usage
1915 * while letting drivers communicate again with its endpoints.
1916 * USB resume explicitly guarantees that the power session between
1917 * the host and the device is the same as it was when the device
1920 * If @udev->reset_resume is set then this routine won't check that the
1921 * port is still enabled. Furthermore, finish_port_resume() above will
1922 * reset @udev. The end result is that a broken power session can be
1923 * recovered and @udev will appear to persist across a loss of VBUS power.
1925 * For example, if a host controller doesn't maintain VBUS suspend current
1926 * during a system sleep or is reset when the system wakes up, all the USB
1927 * power sessions below it will be broken. This is especially troublesome
1928 * for mass-storage devices containing mounted filesystems, since the
1929 * device will appear to have disconnected and all the memory mappings
1930 * to it will be lost. Using the USB_PERSIST facility, the device can be
1931 * made to appear as if it had not disconnected.
1933 * This facility can be dangerous. Although usb_reset_device() makes
1934 * every effort to insure that the same device is present after the
1935 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
1936 * quite possible for a device to remain unaltered but its media to be
1937 * changed. If the user replaces a flash memory card while the system is
1938 * asleep, he will have only himself to blame when the filesystem on the
1939 * new card is corrupted and the system crashes.
1941 * Returns 0 on success, else negative errno.
1943 int usb_port_resume(struct usb_device
*udev
)
1945 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1946 int port1
= udev
->portnum
;
1948 u16 portchange
, portstatus
;
1949 unsigned mask_flags
, want_flags
;
1951 /* Skip the initial Clear-Suspend step for a remote wakeup */
1952 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1953 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
1954 goto SuspendCleared
;
1956 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1958 set_bit(port1
, hub
->busy_bits
);
1960 /* see 7.1.7.7; affects power usage, but not budgeting */
1961 status
= clear_port_feature(hub
->hdev
,
1962 port1
, USB_PORT_FEAT_SUSPEND
);
1964 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
1967 /* drive resume for at least 20 msec */
1968 dev_dbg(&udev
->dev
, "usb %sresume\n",
1969 udev
->auto_pm
? "auto-" : "");
1972 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1973 * stop resume signaling. Then finish the resume
1976 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1979 if (udev
->reset_resume
)
1980 want_flags
= USB_PORT_STAT_POWER
1981 | USB_PORT_STAT_CONNECTION
;
1983 want_flags
= USB_PORT_STAT_POWER
1984 | USB_PORT_STAT_CONNECTION
1985 | USB_PORT_STAT_ENABLE
;
1986 mask_flags
= want_flags
| USB_PORT_STAT_SUSPEND
;
1988 if (status
< 0 || (portstatus
& mask_flags
) != want_flags
) {
1989 dev_dbg(hub
->intfdev
,
1990 "port %d status %04x.%04x after resume, %d\n",
1991 port1
, portchange
, portstatus
, status
);
1995 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
1996 clear_port_feature(hub
->hdev
, port1
,
1997 USB_PORT_FEAT_C_SUSPEND
);
1998 /* TRSMRCY = 10 msec */
2003 clear_bit(port1
, hub
->busy_bits
);
2004 if (!hub
->hdev
->parent
&& !hub
->busy_bits
[0])
2005 usb_enable_root_hub_irq(hub
->hdev
->bus
);
2008 status
= finish_port_resume(udev
);
2010 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2011 hub_port_logical_disconnect(hub
, port1
);
2016 static int remote_wakeup(struct usb_device
*udev
)
2020 usb_lock_device(udev
);
2021 if (udev
->state
== USB_STATE_SUSPENDED
) {
2022 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2023 usb_mark_last_busy(udev
);
2024 status
= usb_external_resume_device(udev
);
2026 usb_unlock_device(udev
);
2030 #else /* CONFIG_USB_SUSPEND */
2032 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2034 int usb_port_suspend(struct usb_device
*udev
)
2039 int usb_port_resume(struct usb_device
*udev
)
2043 /* However we may need to do a reset-resume */
2044 if (udev
->reset_resume
) {
2045 dev_dbg(&udev
->dev
, "reset-resume\n");
2046 status
= usb_reset_device(udev
);
2051 static inline int remote_wakeup(struct usb_device
*udev
)
2058 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2060 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2061 struct usb_device
*hdev
= hub
->hdev
;
2064 /* fail if children aren't already suspended */
2065 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2066 struct usb_device
*udev
;
2068 udev
= hdev
->children
[port1
-1];
2069 if (udev
&& udev
->can_submit
) {
2071 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2077 dev_dbg(&intf
->dev
, "%s\n", __FUNCTION__
);
2079 /* stop khubd and related activity */
2084 static int hub_resume(struct usb_interface
*intf
)
2086 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2088 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2089 hub_restart(hub
, HUB_RESUME
);
2093 static int hub_reset_resume(struct usb_interface
*intf
)
2095 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2097 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2099 hub_restart(hub
, HUB_RESET_RESUME
);
2104 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2105 * @rhdev: struct usb_device for the root hub
2107 * The USB host controller driver calls this function when its root hub
2108 * is resumed and Vbus power has been interrupted or the controller
2109 * has been reset. The routine marks @rhdev as having lost power.
2110 * When the hub driver is resumed it will take notice and carry out
2111 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2112 * the others will be disconnected.
2114 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2116 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2117 rhdev
->reset_resume
= 1;
2119 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2121 #else /* CONFIG_PM */
2123 static inline int remote_wakeup(struct usb_device
*udev
)
2128 #define hub_suspend NULL
2129 #define hub_resume NULL
2130 #define hub_reset_resume NULL
2134 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2136 * Between connect detection and reset signaling there must be a delay
2137 * of 100ms at least for debounce and power-settling. The corresponding
2138 * timer shall restart whenever the downstream port detects a disconnect.
2140 * Apparently there are some bluetooth and irda-dongles and a number of
2141 * low-speed devices for which this debounce period may last over a second.
2142 * Not covered by the spec - but easy to deal with.
2144 * This implementation uses a 1500ms total debounce timeout; if the
2145 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2146 * every 25ms for transient disconnects. When the port status has been
2147 * unchanged for 100ms it returns the port status.
2150 #define HUB_DEBOUNCE_TIMEOUT 1500
2151 #define HUB_DEBOUNCE_STEP 25
2152 #define HUB_DEBOUNCE_STABLE 100
2154 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2157 int total_time
, stable_time
= 0;
2158 u16 portchange
, portstatus
;
2159 unsigned connection
= 0xffff;
2161 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2162 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2166 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2167 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2168 stable_time
+= HUB_DEBOUNCE_STEP
;
2169 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2173 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2176 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2177 clear_port_feature(hub
->hdev
, port1
,
2178 USB_PORT_FEAT_C_CONNECTION
);
2181 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2183 msleep(HUB_DEBOUNCE_STEP
);
2186 dev_dbg (hub
->intfdev
,
2187 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2188 port1
, total_time
, stable_time
, portstatus
);
2190 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2195 static void ep0_reinit(struct usb_device
*udev
)
2197 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
);
2198 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
);
2199 usb_enable_endpoint(udev
, &udev
->ep0
);
2202 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2203 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2205 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2211 if (udev
->state
== USB_STATE_ADDRESS
)
2213 if (udev
->state
!= USB_STATE_DEFAULT
)
2215 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2216 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2217 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2219 udev
->devnum
= devnum
; /* Device now using proper address */
2220 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2226 /* Reset device, (re)assign address, get device descriptor.
2227 * Device connection must be stable, no more debouncing needed.
2228 * Returns device in USB_STATE_ADDRESS, except on error.
2230 * If this is called for an already-existing device (as part of
2231 * usb_reset_device), the caller must own the device lock. For a
2232 * newly detected device that is not accessible through any global
2233 * pointers, it's not necessary to lock the device.
2236 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2239 static DEFINE_MUTEX(usb_address0_mutex
);
2241 struct usb_device
*hdev
= hub
->hdev
;
2243 unsigned delay
= HUB_SHORT_RESET_TIME
;
2244 enum usb_device_speed oldspeed
= udev
->speed
;
2246 int devnum
= udev
->devnum
;
2248 /* root hub ports have a slightly longer reset period
2249 * (from USB 2.0 spec, section 7.1.7.5)
2251 if (!hdev
->parent
) {
2252 delay
= HUB_ROOT_RESET_TIME
;
2253 if (port1
== hdev
->bus
->otg_port
)
2254 hdev
->bus
->b_hnp_enable
= 0;
2257 /* Some low speed devices have problems with the quick delay, so */
2258 /* be a bit pessimistic with those devices. RHbug #23670 */
2259 if (oldspeed
== USB_SPEED_LOW
)
2260 delay
= HUB_LONG_RESET_TIME
;
2262 mutex_lock(&usb_address0_mutex
);
2264 /* Reset the device; full speed may morph to high speed */
2265 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2266 if (retval
< 0) /* error or disconnect */
2268 /* success, speed is known */
2271 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2272 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2275 oldspeed
= udev
->speed
;
2277 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2278 * it's fixed size except for full speed devices.
2279 * For Wireless USB devices, ep0 max packet is always 512 (tho
2280 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2282 switch (udev
->speed
) {
2283 case USB_SPEED_VARIABLE
: /* fixed at 512 */
2284 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(512);
2286 case USB_SPEED_HIGH
: /* fixed at 64 */
2287 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2289 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2290 /* to determine the ep0 maxpacket size, try to read
2291 * the device descriptor to get bMaxPacketSize0 and
2292 * then correct our initial guess.
2294 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2296 case USB_SPEED_LOW
: /* fixed at 8 */
2297 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2304 switch (udev
->speed
) {
2305 case USB_SPEED_LOW
: speed
= "low"; break;
2306 case USB_SPEED_FULL
: speed
= "full"; break;
2307 case USB_SPEED_HIGH
: speed
= "high"; break;
2308 case USB_SPEED_VARIABLE
:
2312 default: speed
= "?"; break;
2314 dev_info (&udev
->dev
,
2315 "%s %s speed %sUSB device using %s and address %d\n",
2316 (udev
->config
) ? "reset" : "new", speed
, type
,
2317 udev
->bus
->controller
->driver
->name
, devnum
);
2319 /* Set up TT records, if needed */
2321 udev
->tt
= hdev
->tt
;
2322 udev
->ttport
= hdev
->ttport
;
2323 } else if (udev
->speed
!= USB_SPEED_HIGH
2324 && hdev
->speed
== USB_SPEED_HIGH
) {
2325 udev
->tt
= &hub
->tt
;
2326 udev
->ttport
= port1
;
2329 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2330 * Because device hardware and firmware is sometimes buggy in
2331 * this area, and this is how Linux has done it for ages.
2332 * Change it cautiously.
2334 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2335 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2336 * so it may help with some non-standards-compliant devices.
2337 * Otherwise we start with SET_ADDRESS and then try to read the
2338 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2341 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2342 if (USE_NEW_SCHEME(retry_counter
)) {
2343 struct usb_device_descriptor
*buf
;
2346 #define GET_DESCRIPTOR_BUFSIZE 64
2347 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2353 /* Retry on all errors; some devices are flakey.
2354 * 255 is for WUSB devices, we actually need to use
2355 * 512 (WUSB1.0[4.8.1]).
2357 for (j
= 0; j
< 3; ++j
) {
2358 buf
->bMaxPacketSize0
= 0;
2359 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2360 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2361 USB_DT_DEVICE
<< 8, 0,
2362 buf
, GET_DESCRIPTOR_BUFSIZE
,
2363 USB_CTRL_GET_TIMEOUT
);
2364 switch (buf
->bMaxPacketSize0
) {
2365 case 8: case 16: case 32: case 64: case 255:
2366 if (buf
->bDescriptorType
==
2380 udev
->descriptor
.bMaxPacketSize0
=
2381 buf
->bMaxPacketSize0
;
2384 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2385 if (retval
< 0) /* error or disconnect */
2387 if (oldspeed
!= udev
->speed
) {
2389 "device reset changed speed!\n");
2394 dev_err(&udev
->dev
, "device descriptor "
2395 "read/%s, error %d\n",
2400 #undef GET_DESCRIPTOR_BUFSIZE
2403 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2404 retval
= hub_set_address(udev
, devnum
);
2411 "device not accepting address %d, error %d\n",
2416 /* cope with hardware quirkiness:
2417 * - let SET_ADDRESS settle, some device hardware wants it
2418 * - read ep0 maxpacket even for high and low speed,
2421 if (USE_NEW_SCHEME(retry_counter
))
2424 retval
= usb_get_device_descriptor(udev
, 8);
2426 dev_err(&udev
->dev
, "device descriptor "
2427 "read/%s, error %d\n",
2439 i
= udev
->descriptor
.bMaxPacketSize0
== 0xff?
2440 512 : udev
->descriptor
.bMaxPacketSize0
;
2441 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2442 if (udev
->speed
!= USB_SPEED_FULL
||
2443 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2444 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2448 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2449 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2453 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2454 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2455 dev_err(&udev
->dev
, "device descriptor read/%s, error %d\n",
2466 hub_port_disable(hub
, port1
, 0);
2467 udev
->devnum
= devnum
; /* for disconnect processing */
2469 mutex_unlock(&usb_address0_mutex
);
2474 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2476 struct usb_qualifier_descriptor
*qual
;
2479 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
2483 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2484 qual
, sizeof *qual
);
2485 if (status
== sizeof *qual
) {
2486 dev_info(&udev
->dev
, "not running at top speed; "
2487 "connect to a high speed hub\n");
2488 /* hub LEDs are probably harder to miss than syslog */
2489 if (hub
->has_indicators
) {
2490 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2491 schedule_delayed_work (&hub
->leds
, 0);
2498 hub_power_remaining (struct usb_hub
*hub
)
2500 struct usb_device
*hdev
= hub
->hdev
;
2504 if (!hub
->limited_power
)
2507 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2508 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2509 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2515 /* Unconfigured devices may not use more than 100mA,
2516 * or 8mA for OTG ports */
2517 if (udev
->actconfig
)
2518 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2519 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2523 if (delta
> hub
->mA_per_port
)
2524 dev_warn(&udev
->dev
, "%dmA is over %umA budget "
2526 delta
, hub
->mA_per_port
, port1
);
2529 if (remaining
< 0) {
2530 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2537 /* Handle physical or logical connection change events.
2538 * This routine is called when:
2539 * a port connection-change occurs;
2540 * a port enable-change occurs (often caused by EMI);
2541 * usb_reset_device() encounters changed descriptors (as from
2542 * a firmware download)
2543 * caller already locked the hub
2545 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2546 u16 portstatus
, u16 portchange
)
2548 struct usb_device
*hdev
= hub
->hdev
;
2549 struct device
*hub_dev
= hub
->intfdev
;
2550 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2551 u16 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2555 "port %d, status %04x, change %04x, %s\n",
2556 port1
, portstatus
, portchange
, portspeed (portstatus
));
2558 if (hub
->has_indicators
) {
2559 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2560 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2563 /* Disconnect any existing devices under this port */
2564 if (hdev
->children
[port1
-1])
2565 usb_disconnect(&hdev
->children
[port1
-1]);
2566 clear_bit(port1
, hub
->change_bits
);
2568 #ifdef CONFIG_USB_OTG
2569 /* during HNP, don't repeat the debounce */
2570 if (hdev
->bus
->is_b_host
)
2571 portchange
&= ~USB_PORT_STAT_C_CONNECTION
;
2574 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2575 status
= hub_port_debounce(hub
, port1
);
2577 if (printk_ratelimit())
2578 dev_err (hub_dev
, "connect-debounce failed, "
2579 "port %d disabled\n", port1
);
2582 portstatus
= status
;
2585 /* Return now if nothing is connected */
2586 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2588 /* maybe switch power back on (e.g. root hub was reset) */
2589 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2590 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2591 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2593 if (portstatus
& USB_PORT_STAT_ENABLE
)
2598 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2599 struct usb_device
*udev
;
2601 /* reallocate for each attempt, since references
2602 * to the previous one can escape in various ways
2604 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2607 "couldn't allocate port %d usb_device\n",
2612 usb_set_device_state(udev
, USB_STATE_POWERED
);
2613 udev
->speed
= USB_SPEED_UNKNOWN
;
2614 udev
->bus_mA
= hub
->mA_per_port
;
2615 udev
->level
= hdev
->level
+ 1;
2617 /* set the address */
2618 choose_address(udev
);
2619 if (udev
->devnum
<= 0) {
2620 status
= -ENOTCONN
; /* Don't retry */
2624 /* reset and get descriptor */
2625 status
= hub_port_init(hub
, udev
, port1
, i
);
2629 /* consecutive bus-powered hubs aren't reliable; they can
2630 * violate the voltage drop budget. if the new child has
2631 * a "powered" LED, users should notice we didn't enable it
2632 * (without reading syslog), even without per-port LEDs
2635 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2636 && udev
->bus_mA
<= 100) {
2639 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2642 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2645 le16_to_cpus(&devstat
);
2646 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2648 "can't connect bus-powered hub "
2650 if (hub
->has_indicators
) {
2651 hub
->indicator
[port1
-1] =
2652 INDICATOR_AMBER_BLINK
;
2653 schedule_delayed_work (&hub
->leds
, 0);
2655 status
= -ENOTCONN
; /* Don't retry */
2660 /* check for devices running slower than they could */
2661 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2662 && udev
->speed
== USB_SPEED_FULL
2663 && highspeed_hubs
!= 0)
2664 check_highspeed (hub
, udev
, port1
);
2666 /* Store the parent's children[] pointer. At this point
2667 * udev becomes globally accessible, although presumably
2668 * no one will look at it until hdev is unlocked.
2672 /* We mustn't add new devices if the parent hub has
2673 * been disconnected; we would race with the
2674 * recursively_mark_NOTATTACHED() routine.
2676 spin_lock_irq(&device_state_lock
);
2677 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2680 hdev
->children
[port1
-1] = udev
;
2681 spin_unlock_irq(&device_state_lock
);
2683 /* Run it through the hoops (find a driver, etc) */
2685 status
= usb_new_device(udev
);
2687 spin_lock_irq(&device_state_lock
);
2688 hdev
->children
[port1
-1] = NULL
;
2689 spin_unlock_irq(&device_state_lock
);
2696 status
= hub_power_remaining(hub
);
2698 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2703 hub_port_disable(hub
, port1
, 1);
2706 release_address(udev
);
2708 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
2713 hub_port_disable(hub
, port1
, 1);
2714 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
2715 hcd
->driver
->relinquish_port(hcd
, port1
);
2718 static void hub_events(void)
2720 struct list_head
*tmp
;
2721 struct usb_device
*hdev
;
2722 struct usb_interface
*intf
;
2723 struct usb_hub
*hub
;
2724 struct device
*hub_dev
;
2733 * We restart the list every time to avoid a deadlock with
2734 * deleting hubs downstream from this one. This should be
2735 * safe since we delete the hub from the event list.
2736 * Not the most efficient, but avoids deadlocks.
2740 /* Grab the first entry at the beginning of the list */
2741 spin_lock_irq(&hub_event_lock
);
2742 if (list_empty(&hub_event_list
)) {
2743 spin_unlock_irq(&hub_event_lock
);
2747 tmp
= hub_event_list
.next
;
2750 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
2751 kref_get(&hub
->kref
);
2752 spin_unlock_irq(&hub_event_lock
);
2755 hub_dev
= hub
->intfdev
;
2756 intf
= to_usb_interface(hub_dev
);
2757 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
2758 hdev
->state
, hub
->descriptor
2759 ? hub
->descriptor
->bNbrPorts
2761 /* NOTE: expects max 15 ports... */
2762 (u16
) hub
->change_bits
[0],
2763 (u16
) hub
->event_bits
[0]);
2765 /* Lock the device, then check to see if we were
2766 * disconnected while waiting for the lock to succeed. */
2767 usb_lock_device(hdev
);
2768 if (unlikely(hub
->disconnected
))
2771 /* If the hub has died, clean up after it */
2772 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
2773 hub
->error
= -ENODEV
;
2779 ret
= usb_autopm_get_interface(intf
);
2781 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
2785 /* If this is an inactive hub, do nothing */
2790 dev_dbg (hub_dev
, "resetting for error %d\n",
2793 ret
= usb_reset_composite_device(hdev
, intf
);
2796 "error resetting hub: %d\n", ret
);
2804 /* deal with port status changes */
2805 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
2806 if (test_bit(i
, hub
->busy_bits
))
2808 connect_change
= test_bit(i
, hub
->change_bits
);
2809 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
2810 !connect_change
&& !hub
->activating
)
2813 ret
= hub_port_status(hub
, i
,
2814 &portstatus
, &portchange
);
2818 if (hub
->activating
&& !hdev
->children
[i
-1] &&
2820 USB_PORT_STAT_CONNECTION
))
2823 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2824 clear_port_feature(hdev
, i
,
2825 USB_PORT_FEAT_C_CONNECTION
);
2829 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
2830 if (!connect_change
)
2832 "port %d enable change, "
2835 clear_port_feature(hdev
, i
,
2836 USB_PORT_FEAT_C_ENABLE
);
2839 * EM interference sometimes causes badly
2840 * shielded USB devices to be shutdown by
2841 * the hub, this hack enables them again.
2842 * Works at least with mouse driver.
2844 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
2846 && hdev
->children
[i
-1]) {
2849 "disabled by hub (EMI?), "
2856 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
2857 clear_port_feature(hdev
, i
,
2858 USB_PORT_FEAT_C_SUSPEND
);
2859 if (hdev
->children
[i
-1]) {
2860 ret
= remote_wakeup(hdev
->
2866 hub_port_disable(hub
, i
, 1);
2869 "resume on port %d, status %d\n",
2873 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
2875 "over-current change on port %d\n",
2877 clear_port_feature(hdev
, i
,
2878 USB_PORT_FEAT_C_OVER_CURRENT
);
2882 if (portchange
& USB_PORT_STAT_C_RESET
) {
2884 "reset change on port %d\n",
2886 clear_port_feature(hdev
, i
,
2887 USB_PORT_FEAT_C_RESET
);
2891 hub_port_connect_change(hub
, i
,
2892 portstatus
, portchange
);
2895 /* deal with hub status changes */
2896 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
2898 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
2899 dev_err (hub_dev
, "get_hub_status failed\n");
2901 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
2902 dev_dbg (hub_dev
, "power change\n");
2903 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
2904 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
2905 /* FIXME: Is this always true? */
2906 hub
->limited_power
= 1;
2908 hub
->limited_power
= 0;
2910 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
2911 dev_dbg (hub_dev
, "overcurrent change\n");
2912 msleep(500); /* Cool down */
2913 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
2918 hub
->activating
= 0;
2920 /* If this is a root hub, tell the HCD it's okay to
2921 * re-enable port-change interrupts now. */
2922 if (!hdev
->parent
&& !hub
->busy_bits
[0])
2923 usb_enable_root_hub_irq(hdev
->bus
);
2926 /* Allow autosuspend if we're not going to run again */
2927 if (list_empty(&hub
->event_list
))
2928 usb_autopm_enable(intf
);
2930 usb_unlock_device(hdev
);
2931 kref_put(&hub
->kref
, hub_release
);
2933 } /* end while (1) */
2936 static int hub_thread(void *__unused
)
2938 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
2939 * port handover. Otherwise it might see that a full-speed device
2940 * was gone before the EHCI controller had handed its port over to
2941 * the companion full-speed controller.
2947 wait_event_freezable(khubd_wait
,
2948 !list_empty(&hub_event_list
) ||
2949 kthread_should_stop());
2950 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
2952 pr_debug("%s: khubd exiting\n", usbcore_name
);
2956 static struct usb_device_id hub_id_table
[] = {
2957 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
2958 .bDeviceClass
= USB_CLASS_HUB
},
2959 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
2960 .bInterfaceClass
= USB_CLASS_HUB
},
2961 { } /* Terminating entry */
2964 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
2966 static struct usb_driver hub_driver
= {
2969 .disconnect
= hub_disconnect
,
2970 .suspend
= hub_suspend
,
2971 .resume
= hub_resume
,
2972 .reset_resume
= hub_reset_resume
,
2973 .pre_reset
= hub_pre_reset
,
2974 .post_reset
= hub_post_reset
,
2976 .id_table
= hub_id_table
,
2977 .supports_autosuspend
= 1,
2980 int usb_hub_init(void)
2982 if (usb_register(&hub_driver
) < 0) {
2983 printk(KERN_ERR
"%s: can't register hub driver\n",
2988 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
2989 if (!IS_ERR(khubd_task
))
2992 /* Fall through if kernel_thread failed */
2993 usb_deregister(&hub_driver
);
2994 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
2999 void usb_hub_cleanup(void)
3001 kthread_stop(khubd_task
);
3004 * Hub resources are freed for us by usb_deregister. It calls
3005 * usb_driver_purge on every device which in turn calls that
3006 * devices disconnect function if it is using this driver.
3007 * The hub_disconnect function takes care of releasing the
3008 * individual hub resources. -greg
3010 usb_deregister(&hub_driver
);
3011 } /* usb_hub_cleanup() */
3013 static int descriptors_changed(struct usb_device
*udev
,
3014 struct usb_device_descriptor
*old_device_descriptor
)
3018 unsigned serial_len
= 0;
3020 unsigned old_length
;
3024 if (memcmp(&udev
->descriptor
, old_device_descriptor
,
3025 sizeof(*old_device_descriptor
)) != 0)
3028 /* Since the idVendor, idProduct, and bcdDevice values in the
3029 * device descriptor haven't changed, we will assume the
3030 * Manufacturer and Product strings haven't changed either.
3031 * But the SerialNumber string could be different (e.g., a
3032 * different flash card of the same brand).
3035 serial_len
= strlen(udev
->serial
) + 1;
3038 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3039 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3040 len
= max(len
, old_length
);
3043 buf
= kmalloc(len
, GFP_NOIO
);
3045 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3046 /* assume the worst */
3049 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3050 old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3051 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3053 if (length
!= old_length
) {
3054 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3059 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3061 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3063 ((struct usb_config_descriptor
*) buf
)->
3064 bConfigurationValue
);
3070 if (!changed
&& serial_len
) {
3071 length
= usb_string(udev
, udev
->descriptor
.iSerialNumber
,
3073 if (length
+ 1 != serial_len
) {
3074 dev_dbg(&udev
->dev
, "serial string error %d\n",
3077 } else if (memcmp(buf
, udev
->serial
, length
) != 0) {
3078 dev_dbg(&udev
->dev
, "serial string changed\n");
3088 * usb_reset_device - perform a USB port reset to reinitialize a device
3089 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3091 * WARNING - don't use this routine to reset a composite device
3092 * (one with multiple interfaces owned by separate drivers)!
3093 * Use usb_reset_composite_device() instead.
3095 * Do a port reset, reassign the device's address, and establish its
3096 * former operating configuration. If the reset fails, or the device's
3097 * descriptors change from their values before the reset, or the original
3098 * configuration and altsettings cannot be restored, a flag will be set
3099 * telling khubd to pretend the device has been disconnected and then
3100 * re-connected. All drivers will be unbound, and the device will be
3101 * re-enumerated and probed all over again.
3103 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3104 * flagged for logical disconnection, or some other negative error code
3105 * if the reset wasn't even attempted.
3107 * The caller must own the device lock. For example, it's safe to use
3108 * this from a driver probe() routine after downloading new firmware.
3109 * For calls that might not occur during probe(), drivers should lock
3110 * the device using usb_lock_device_for_reset().
3112 * Locking exception: This routine may also be called from within an
3113 * autoresume handler. Such usage won't conflict with other tasks
3114 * holding the device lock because these tasks should always call
3115 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3117 int usb_reset_device(struct usb_device
*udev
)
3119 struct usb_device
*parent_hdev
= udev
->parent
;
3120 struct usb_hub
*parent_hub
;
3121 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3123 int port1
= udev
->portnum
;
3125 if (udev
->state
== USB_STATE_NOTATTACHED
||
3126 udev
->state
== USB_STATE_SUSPENDED
) {
3127 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3133 /* this requires hcd-specific logic; see OHCI hc_restart() */
3134 dev_dbg(&udev
->dev
, "%s for root hub!\n", __FUNCTION__
);
3137 parent_hub
= hdev_to_hub(parent_hdev
);
3139 set_bit(port1
, parent_hub
->busy_bits
);
3140 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3142 /* ep0 maxpacket size may change; let the HCD know about it.
3143 * Other endpoints will be handled by re-enumeration. */
3145 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3146 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3149 clear_bit(port1
, parent_hub
->busy_bits
);
3150 if (!parent_hdev
->parent
&& !parent_hub
->busy_bits
[0])
3151 usb_enable_root_hub_irq(parent_hdev
->bus
);
3156 /* Device might have changed firmware (DFU or similar) */
3157 if (descriptors_changed(udev
, &descriptor
)) {
3158 dev_info(&udev
->dev
, "device firmware changed\n");
3159 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3163 if (!udev
->actconfig
)
3166 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3167 USB_REQ_SET_CONFIGURATION
, 0,
3168 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3169 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3172 "can't restore configuration #%d (error=%d)\n",
3173 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3176 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3178 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3179 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3180 struct usb_interface_descriptor
*desc
;
3182 /* set_interface resets host side toggle even
3183 * for altsetting zero. the interface may have no driver.
3185 desc
= &intf
->cur_altsetting
->desc
;
3186 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3187 desc
->bAlternateSetting
);
3189 dev_err(&udev
->dev
, "failed to restore interface %d "
3190 "altsetting %d (error=%d)\n",
3191 desc
->bInterfaceNumber
,
3192 desc
->bAlternateSetting
,
3202 hub_port_logical_disconnect(parent_hub
, port1
);
3205 EXPORT_SYMBOL_GPL(usb_reset_device
);
3208 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3209 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3210 * @iface: interface bound to the driver making the request (optional)
3212 * Warns all drivers bound to registered interfaces (using their pre_reset
3213 * method), performs the port reset, and then lets the drivers know that
3214 * the reset is over (using their post_reset method).
3216 * Return value is the same as for usb_reset_device().
3218 * The caller must own the device lock. For example, it's safe to use
3219 * this from a driver probe() routine after downloading new firmware.
3220 * For calls that might not occur during probe(), drivers should lock
3221 * the device using usb_lock_device_for_reset().
3223 int usb_reset_composite_device(struct usb_device
*udev
,
3224 struct usb_interface
*iface
)
3228 struct usb_host_config
*config
= udev
->actconfig
;
3230 if (udev
->state
== USB_STATE_NOTATTACHED
||
3231 udev
->state
== USB_STATE_SUSPENDED
) {
3232 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3237 /* Prevent autosuspend during the reset */
3238 usb_autoresume_device(udev
);
3240 if (iface
&& iface
->condition
!= USB_INTERFACE_BINDING
)
3244 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3245 struct usb_interface
*cintf
= config
->interface
[i
];
3246 struct usb_driver
*drv
;
3248 if (cintf
->dev
.driver
) {
3249 drv
= to_usb_driver(cintf
->dev
.driver
);
3251 (drv
->pre_reset
)(cintf
);
3252 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
3257 ret
= usb_reset_device(udev
);
3260 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3261 struct usb_interface
*cintf
= config
->interface
[i
];
3262 struct usb_driver
*drv
;
3264 if (cintf
->dev
.driver
) {
3265 drv
= to_usb_driver(cintf
->dev
.driver
);
3266 if (drv
->post_reset
)
3267 (drv
->post_reset
)(cintf
);
3268 /* FIXME: Unbind if post_reset returns an error or isn't defined */
3273 usb_autosuspend_device(udev
);
3276 EXPORT_SYMBOL_GPL(usb_reset_composite_device
);