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 #ifdef CONFIG_USB_PERSIST
39 /* if we are in debug mode, always announce new devices */
41 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
47 struct device
*intfdev
; /* the "interface" device */
48 struct usb_device
*hdev
;
50 struct urb
*urb
; /* for interrupt polling pipe */
52 /* buffer for urb ... with extra space in case of babble */
54 dma_addr_t buffer_dma
; /* DMA address for buffer */
56 struct usb_hub_status hub
;
57 struct usb_port_status port
;
58 } *status
; /* buffer for status reports */
59 struct mutex status_mutex
; /* for the status buffer */
61 int error
; /* last reported error */
62 int nerrors
; /* track consecutive errors */
64 struct list_head event_list
; /* hubs w/data or errs ready */
65 unsigned long event_bits
[1]; /* status change bitmask */
66 unsigned long change_bits
[1]; /* ports with logical connect
68 unsigned long busy_bits
[1]; /* ports being reset or
70 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
71 #error event_bits[] is too short!
74 struct usb_hub_descriptor
*descriptor
; /* class descriptor */
75 struct usb_tt tt
; /* Transaction Translator */
77 unsigned mA_per_port
; /* current for each child */
79 unsigned limited_power
:1;
81 unsigned activating
:1;
82 unsigned disconnected
:1;
84 unsigned has_indicators
:1;
85 u8 indicator
[USB_MAXCHILDREN
];
86 struct delayed_work leds
;
90 /* Protect struct usb_device->state and ->children members
91 * Note: Both are also protected by ->dev.sem, except that ->state can
92 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
93 static DEFINE_SPINLOCK(device_state_lock
);
95 /* khubd's worklist and its lock */
96 static DEFINE_SPINLOCK(hub_event_lock
);
97 static LIST_HEAD(hub_event_list
); /* List of hubs needing servicing */
100 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait
);
102 static struct task_struct
*khubd_task
;
104 /* cycle leds on hubs that aren't blinking for attention */
105 static int blinkenlights
= 0;
106 module_param (blinkenlights
, bool, S_IRUGO
);
107 MODULE_PARM_DESC (blinkenlights
, "true to cycle leds on hubs");
110 * As of 2.6.10 we introduce a new USB device initialization scheme which
111 * closely resembles the way Windows works. Hopefully it will be compatible
112 * with a wider range of devices than the old scheme. However some previously
113 * working devices may start giving rise to "device not accepting address"
114 * errors; if that happens the user can try the old scheme by adjusting the
115 * following module parameters.
117 * For maximum flexibility there are two boolean parameters to control the
118 * hub driver's behavior. On the first initialization attempt, if the
119 * "old_scheme_first" parameter is set then the old scheme will be used,
120 * otherwise the new scheme is used. If that fails and "use_both_schemes"
121 * is set, then the driver will make another attempt, using the other scheme.
123 static int old_scheme_first
= 0;
124 module_param(old_scheme_first
, bool, S_IRUGO
| S_IWUSR
);
125 MODULE_PARM_DESC(old_scheme_first
,
126 "start with the old device initialization scheme");
128 static int use_both_schemes
= 1;
129 module_param(use_both_schemes
, bool, S_IRUGO
| S_IWUSR
);
130 MODULE_PARM_DESC(use_both_schemes
,
131 "try the other device initialization scheme if the "
134 /* Mutual exclusion for EHCI CF initialization. This interferes with
135 * port reset on some companion controllers.
137 DECLARE_RWSEM(ehci_cf_port_reset_rwsem
);
138 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem
);
141 static inline char *portspeed(int portstatus
)
143 if (portstatus
& (1 << USB_PORT_FEAT_HIGHSPEED
))
145 else if (portstatus
& (1 << USB_PORT_FEAT_LOWSPEED
))
151 /* Note that hdev or one of its children must be locked! */
152 static inline struct usb_hub
*hdev_to_hub(struct usb_device
*hdev
)
154 return usb_get_intfdata(hdev
->actconfig
->interface
[0]);
157 /* USB 2.0 spec Section 11.24.4.5 */
158 static int get_hub_descriptor(struct usb_device
*hdev
, void *data
, int size
)
162 for (i
= 0; i
< 3; i
++) {
163 ret
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
164 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
| USB_RT_HUB
,
165 USB_DT_HUB
<< 8, 0, data
, size
,
166 USB_CTRL_GET_TIMEOUT
);
167 if (ret
>= (USB_DT_HUB_NONVAR_SIZE
+ 2))
174 * USB 2.0 spec Section 11.24.2.1
176 static int clear_hub_feature(struct usb_device
*hdev
, int feature
)
178 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
179 USB_REQ_CLEAR_FEATURE
, USB_RT_HUB
, feature
, 0, NULL
, 0, 1000);
183 * USB 2.0 spec Section 11.24.2.2
185 static int clear_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
187 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
188 USB_REQ_CLEAR_FEATURE
, USB_RT_PORT
, feature
, port1
,
193 * USB 2.0 spec Section 11.24.2.13
195 static int set_port_feature(struct usb_device
*hdev
, int port1
, int feature
)
197 return usb_control_msg(hdev
, usb_sndctrlpipe(hdev
, 0),
198 USB_REQ_SET_FEATURE
, USB_RT_PORT
, feature
, port1
,
203 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
204 * for info about using port indicators
206 static void set_port_led(
212 int status
= set_port_feature(hub
->hdev
, (selector
<< 8) | port1
,
213 USB_PORT_FEAT_INDICATOR
);
215 dev_dbg (hub
->intfdev
,
216 "port %d indicator %s status %d\n",
218 ({ char *s
; switch (selector
) {
219 case HUB_LED_AMBER
: s
= "amber"; break;
220 case HUB_LED_GREEN
: s
= "green"; break;
221 case HUB_LED_OFF
: s
= "off"; break;
222 case HUB_LED_AUTO
: s
= "auto"; break;
223 default: s
= "??"; break;
228 #define LED_CYCLE_PERIOD ((2*HZ)/3)
230 static void led_work (struct work_struct
*work
)
232 struct usb_hub
*hub
=
233 container_of(work
, struct usb_hub
, leds
.work
);
234 struct usb_device
*hdev
= hub
->hdev
;
236 unsigned changed
= 0;
239 if (hdev
->state
!= USB_STATE_CONFIGURED
|| hub
->quiescing
)
242 for (i
= 0; i
< hub
->descriptor
->bNbrPorts
; i
++) {
243 unsigned selector
, mode
;
245 /* 30%-50% duty cycle */
247 switch (hub
->indicator
[i
]) {
249 case INDICATOR_CYCLE
:
251 selector
= HUB_LED_AUTO
;
252 mode
= INDICATOR_AUTO
;
254 /* blinking green = sw attention */
255 case INDICATOR_GREEN_BLINK
:
256 selector
= HUB_LED_GREEN
;
257 mode
= INDICATOR_GREEN_BLINK_OFF
;
259 case INDICATOR_GREEN_BLINK_OFF
:
260 selector
= HUB_LED_OFF
;
261 mode
= INDICATOR_GREEN_BLINK
;
263 /* blinking amber = hw attention */
264 case INDICATOR_AMBER_BLINK
:
265 selector
= HUB_LED_AMBER
;
266 mode
= INDICATOR_AMBER_BLINK_OFF
;
268 case INDICATOR_AMBER_BLINK_OFF
:
269 selector
= HUB_LED_OFF
;
270 mode
= INDICATOR_AMBER_BLINK
;
272 /* blink green/amber = reserved */
273 case INDICATOR_ALT_BLINK
:
274 selector
= HUB_LED_GREEN
;
275 mode
= INDICATOR_ALT_BLINK_OFF
;
277 case INDICATOR_ALT_BLINK_OFF
:
278 selector
= HUB_LED_AMBER
;
279 mode
= INDICATOR_ALT_BLINK
;
284 if (selector
!= HUB_LED_AUTO
)
286 set_port_led(hub
, i
+ 1, selector
);
287 hub
->indicator
[i
] = mode
;
289 if (!changed
&& blinkenlights
) {
291 cursor
%= hub
->descriptor
->bNbrPorts
;
292 set_port_led(hub
, cursor
+ 1, HUB_LED_GREEN
);
293 hub
->indicator
[cursor
] = INDICATOR_CYCLE
;
297 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
300 /* use a short timeout for hub/port status fetches */
301 #define USB_STS_TIMEOUT 1000
302 #define USB_STS_RETRIES 5
305 * USB 2.0 spec Section 11.24.2.6
307 static int get_hub_status(struct usb_device
*hdev
,
308 struct usb_hub_status
*data
)
310 int i
, status
= -ETIMEDOUT
;
312 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
313 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
314 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_HUB
, 0, 0,
315 data
, sizeof(*data
), USB_STS_TIMEOUT
);
321 * USB 2.0 spec Section 11.24.2.7
323 static int get_port_status(struct usb_device
*hdev
, int port1
,
324 struct usb_port_status
*data
)
326 int i
, status
= -ETIMEDOUT
;
328 for (i
= 0; i
< USB_STS_RETRIES
&& status
== -ETIMEDOUT
; i
++) {
329 status
= usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
330 USB_REQ_GET_STATUS
, USB_DIR_IN
| USB_RT_PORT
, 0, port1
,
331 data
, sizeof(*data
), USB_STS_TIMEOUT
);
336 static int hub_port_status(struct usb_hub
*hub
, int port1
,
337 u16
*status
, u16
*change
)
341 mutex_lock(&hub
->status_mutex
);
342 ret
= get_port_status(hub
->hdev
, port1
, &hub
->status
->port
);
344 dev_err(hub
->intfdev
,
345 "%s failed (err = %d)\n", __func__
, ret
);
349 *status
= le16_to_cpu(hub
->status
->port
.wPortStatus
);
350 *change
= le16_to_cpu(hub
->status
->port
.wPortChange
);
353 mutex_unlock(&hub
->status_mutex
);
357 static void kick_khubd(struct usb_hub
*hub
)
361 /* Suppress autosuspend until khubd runs */
362 to_usb_interface(hub
->intfdev
)->pm_usage_cnt
= 1;
364 spin_lock_irqsave(&hub_event_lock
, flags
);
365 if (!hub
->disconnected
&& list_empty(&hub
->event_list
)) {
366 list_add_tail(&hub
->event_list
, &hub_event_list
);
367 wake_up(&khubd_wait
);
369 spin_unlock_irqrestore(&hub_event_lock
, flags
);
372 void usb_kick_khubd(struct usb_device
*hdev
)
374 /* FIXME: What if hdev isn't bound to the hub driver? */
375 kick_khubd(hdev_to_hub(hdev
));
379 /* completion function, fires on port status changes and various faults */
380 static void hub_irq(struct urb
*urb
)
382 struct usb_hub
*hub
= urb
->context
;
383 int status
= urb
->status
;
388 case -ENOENT
: /* synchronous unlink */
389 case -ECONNRESET
: /* async unlink */
390 case -ESHUTDOWN
: /* hardware going away */
393 default: /* presumably an error */
394 /* Cause a hub reset after 10 consecutive errors */
395 dev_dbg (hub
->intfdev
, "transfer --> %d\n", status
);
396 if ((++hub
->nerrors
< 10) || hub
->error
)
401 /* let khubd handle things */
402 case 0: /* we got data: port status changed */
404 for (i
= 0; i
< urb
->actual_length
; ++i
)
405 bits
|= ((unsigned long) ((*hub
->buffer
)[i
]))
407 hub
->event_bits
[0] = bits
;
413 /* Something happened, let khubd figure it out */
420 if ((status
= usb_submit_urb (hub
->urb
, GFP_ATOMIC
)) != 0
421 && status
!= -ENODEV
&& status
!= -EPERM
)
422 dev_err (hub
->intfdev
, "resubmit --> %d\n", status
);
425 /* USB 2.0 spec Section 11.24.2.3 */
427 hub_clear_tt_buffer (struct usb_device
*hdev
, u16 devinfo
, u16 tt
)
429 return usb_control_msg(hdev
, usb_rcvctrlpipe(hdev
, 0),
430 HUB_CLEAR_TT_BUFFER
, USB_RT_PORT
, devinfo
,
435 * enumeration blocks khubd for a long time. we use keventd instead, since
436 * long blocking there is the exception, not the rule. accordingly, HCDs
437 * talking to TTs must queue control transfers (not just bulk and iso), so
438 * both can talk to the same hub concurrently.
440 static void hub_tt_kevent (struct work_struct
*work
)
442 struct usb_hub
*hub
=
443 container_of(work
, struct usb_hub
, tt
.kevent
);
447 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
448 while (--limit
&& !list_empty (&hub
->tt
.clear_list
)) {
449 struct list_head
*temp
;
450 struct usb_tt_clear
*clear
;
451 struct usb_device
*hdev
= hub
->hdev
;
454 temp
= hub
->tt
.clear_list
.next
;
455 clear
= list_entry (temp
, struct usb_tt_clear
, clear_list
);
456 list_del (&clear
->clear_list
);
458 /* drop lock so HCD can concurrently report other TT errors */
459 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
460 status
= hub_clear_tt_buffer (hdev
, clear
->devinfo
, clear
->tt
);
461 spin_lock_irqsave (&hub
->tt
.lock
, flags
);
465 "clear tt %d (%04x) error %d\n",
466 clear
->tt
, clear
->devinfo
, status
);
469 spin_unlock_irqrestore (&hub
->tt
.lock
, flags
);
473 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
474 * @udev: the device whose split transaction failed
475 * @pipe: identifies the endpoint of the failed transaction
477 * High speed HCDs use this to tell the hub driver that some split control or
478 * bulk transaction failed in a way that requires clearing internal state of
479 * a transaction translator. This is normally detected (and reported) from
482 * It may not be possible for that hub to handle additional full (or low)
483 * speed transactions until that state is fully cleared out.
485 void usb_hub_tt_clear_buffer (struct usb_device
*udev
, int pipe
)
487 struct usb_tt
*tt
= udev
->tt
;
489 struct usb_tt_clear
*clear
;
491 /* we've got to cope with an arbitrary number of pending TT clears,
492 * since each TT has "at least two" buffers that can need it (and
493 * there can be many TTs per hub). even if they're uncommon.
495 if ((clear
= kmalloc (sizeof *clear
, GFP_ATOMIC
)) == NULL
) {
496 dev_err (&udev
->dev
, "can't save CLEAR_TT_BUFFER state\n");
497 /* FIXME recover somehow ... RESET_TT? */
501 /* info that CLEAR_TT_BUFFER needs */
502 clear
->tt
= tt
->multi
? udev
->ttport
: 1;
503 clear
->devinfo
= usb_pipeendpoint (pipe
);
504 clear
->devinfo
|= udev
->devnum
<< 4;
505 clear
->devinfo
|= usb_pipecontrol (pipe
)
506 ? (USB_ENDPOINT_XFER_CONTROL
<< 11)
507 : (USB_ENDPOINT_XFER_BULK
<< 11);
508 if (usb_pipein (pipe
))
509 clear
->devinfo
|= 1 << 15;
511 /* tell keventd to clear state for this TT */
512 spin_lock_irqsave (&tt
->lock
, flags
);
513 list_add_tail (&clear
->clear_list
, &tt
->clear_list
);
514 schedule_work (&tt
->kevent
);
515 spin_unlock_irqrestore (&tt
->lock
, flags
);
517 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer
);
519 static void hub_power_on(struct usb_hub
*hub
)
522 unsigned pgood_delay
= hub
->descriptor
->bPwrOn2PwrGood
* 2;
523 u16 wHubCharacteristics
=
524 le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
526 /* Enable power on each port. Some hubs have reserved values
527 * of LPSM (> 2) in their descriptors, even though they are
528 * USB 2.0 hubs. Some hubs do not implement port-power switching
529 * but only emulate it. In all cases, the ports won't work
530 * unless we send these messages to the hub.
532 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2)
533 dev_dbg(hub
->intfdev
, "enabling power on all ports\n");
535 dev_dbg(hub
->intfdev
, "trying to enable port power on "
536 "non-switchable hub\n");
537 for (port1
= 1; port1
<= hub
->descriptor
->bNbrPorts
; port1
++)
538 set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_POWER
);
540 /* Wait at least 100 msec for power to become stable */
541 msleep(max(pgood_delay
, (unsigned) 100));
544 static void hub_quiesce(struct usb_hub
*hub
)
546 /* (nonblocking) khubd and related activity won't re-trigger */
550 /* (blocking) stop khubd and related activity */
551 usb_kill_urb(hub
->urb
);
552 if (hub
->has_indicators
)
553 cancel_delayed_work_sync(&hub
->leds
);
555 cancel_work_sync(&hub
->tt
.kevent
);
558 static void hub_activate(struct usb_hub
*hub
)
565 status
= usb_submit_urb(hub
->urb
, GFP_NOIO
);
567 dev_err(hub
->intfdev
, "activate --> %d\n", status
);
568 if (hub
->has_indicators
&& blinkenlights
)
569 schedule_delayed_work(&hub
->leds
, LED_CYCLE_PERIOD
);
571 /* scan all ports ASAP */
575 static int hub_hub_status(struct usb_hub
*hub
,
576 u16
*status
, u16
*change
)
580 mutex_lock(&hub
->status_mutex
);
581 ret
= get_hub_status(hub
->hdev
, &hub
->status
->hub
);
583 dev_err (hub
->intfdev
,
584 "%s failed (err = %d)\n", __FUNCTION__
, ret
);
586 *status
= le16_to_cpu(hub
->status
->hub
.wHubStatus
);
587 *change
= le16_to_cpu(hub
->status
->hub
.wHubChange
);
590 mutex_unlock(&hub
->status_mutex
);
594 static int hub_port_disable(struct usb_hub
*hub
, int port1
, int set_state
)
596 struct usb_device
*hdev
= hub
->hdev
;
599 if (hdev
->children
[port1
-1] && set_state
)
600 usb_set_device_state(hdev
->children
[port1
-1],
601 USB_STATE_NOTATTACHED
);
603 ret
= clear_port_feature(hdev
, port1
, USB_PORT_FEAT_ENABLE
);
605 dev_err(hub
->intfdev
, "cannot disable port %d (err = %d)\n",
611 * Disable a port and mark a logical connnect-change event, so that some
612 * time later khubd will disconnect() any existing usb_device on the port
613 * and will re-enumerate if there actually is a device attached.
615 static void hub_port_logical_disconnect(struct usb_hub
*hub
, int port1
)
617 dev_dbg(hub
->intfdev
, "logical disconnect on port %d\n", port1
);
618 hub_port_disable(hub
, port1
, 1);
620 /* FIXME let caller ask to power down the port:
621 * - some devices won't enumerate without a VBUS power cycle
622 * - SRP saves power that way
623 * - ... new call, TBD ...
624 * That's easy if this hub can switch power per-port, and
625 * khubd reactivates the port later (timer, SRP, etc).
626 * Powerdown must be optional, because of reset/DFU.
629 set_bit(port1
, hub
->change_bits
);
633 /* caller has locked the hub device */
634 static void hub_stop(struct usb_hub
*hub
)
636 struct usb_device
*hdev
= hub
->hdev
;
639 /* Disconnect all the children */
640 for (i
= 0; i
< hdev
->maxchild
; ++i
) {
641 if (hdev
->children
[i
])
642 usb_disconnect(&hdev
->children
[i
]);
649 #define HUB_RESET_RESUME 3
653 static void hub_restart(struct usb_hub
*hub
, int type
)
655 struct usb_device
*hdev
= hub
->hdev
;
658 /* Check each of the children to see if they require
659 * USB-PERSIST handling or disconnection. Also check
660 * each unoccupied port to make sure it is still disabled.
662 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
663 struct usb_device
*udev
= hdev
->children
[port1
-1];
665 u16 portstatus
, portchange
;
667 if (!udev
|| udev
->state
== USB_STATE_NOTATTACHED
) {
668 if (type
!= HUB_RESET
) {
669 status
= hub_port_status(hub
, port1
,
670 &portstatus
, &portchange
);
671 if (status
== 0 && (portstatus
&
672 USB_PORT_STAT_ENABLE
))
673 clear_port_feature(hdev
, port1
,
674 USB_PORT_FEAT_ENABLE
);
679 /* Was the power session lost while we were suspended? */
681 case HUB_RESET_RESUME
:
683 portchange
= USB_PORT_STAT_C_CONNECTION
;
688 status
= hub_port_status(hub
, port1
,
689 &portstatus
, &portchange
);
693 /* For "USB_PERSIST"-enabled children we must
694 * mark the child device for reset-resume and
695 * turn off the various status changes to prevent
696 * khubd from disconnecting it later.
698 if (USB_PERSIST
&& udev
->persist_enabled
&& status
== 0 &&
699 !(portstatus
& USB_PORT_STAT_ENABLE
)) {
700 if (portchange
& USB_PORT_STAT_C_ENABLE
)
701 clear_port_feature(hub
->hdev
, port1
,
702 USB_PORT_FEAT_C_ENABLE
);
703 if (portchange
& USB_PORT_STAT_C_CONNECTION
)
704 clear_port_feature(hub
->hdev
, port1
,
705 USB_PORT_FEAT_C_CONNECTION
);
706 udev
->reset_resume
= 1;
709 /* Otherwise for a reset_resume we must disconnect the child,
710 * but as we may not lock the child device here
711 * we have to do a "logical" disconnect.
713 else if (type
== HUB_RESET_RESUME
)
714 hub_port_logical_disconnect(hub
, port1
);
720 #endif /* CONFIG_PM */
722 /* caller has locked the hub device */
723 static int hub_pre_reset(struct usb_interface
*intf
)
725 struct usb_hub
*hub
= usb_get_intfdata(intf
);
731 /* caller has locked the hub device */
732 static int hub_post_reset(struct usb_interface
*intf
)
734 struct usb_hub
*hub
= usb_get_intfdata(intf
);
741 static int hub_configure(struct usb_hub
*hub
,
742 struct usb_endpoint_descriptor
*endpoint
)
744 struct usb_device
*hdev
= hub
->hdev
;
745 struct device
*hub_dev
= hub
->intfdev
;
746 u16 hubstatus
, hubchange
;
747 u16 wHubCharacteristics
;
752 hub
->buffer
= usb_buffer_alloc(hdev
, sizeof(*hub
->buffer
), GFP_KERNEL
,
755 message
= "can't allocate hub irq buffer";
760 hub
->status
= kmalloc(sizeof(*hub
->status
), GFP_KERNEL
);
762 message
= "can't kmalloc hub status buffer";
766 mutex_init(&hub
->status_mutex
);
768 hub
->descriptor
= kmalloc(sizeof(*hub
->descriptor
), GFP_KERNEL
);
769 if (!hub
->descriptor
) {
770 message
= "can't kmalloc hub descriptor";
775 /* Request the entire hub descriptor.
776 * hub->descriptor can handle USB_MAXCHILDREN ports,
777 * but the hub can/will return fewer bytes here.
779 ret
= get_hub_descriptor(hdev
, hub
->descriptor
,
780 sizeof(*hub
->descriptor
));
782 message
= "can't read hub descriptor";
784 } else if (hub
->descriptor
->bNbrPorts
> USB_MAXCHILDREN
) {
785 message
= "hub has too many ports!";
790 hdev
->maxchild
= hub
->descriptor
->bNbrPorts
;
791 dev_info (hub_dev
, "%d port%s detected\n", hdev
->maxchild
,
792 (hdev
->maxchild
== 1) ? "" : "s");
794 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
796 if (wHubCharacteristics
& HUB_CHAR_COMPOUND
) {
798 char portstr
[USB_MAXCHILDREN
+ 1];
800 for (i
= 0; i
< hdev
->maxchild
; i
++)
801 portstr
[i
] = hub
->descriptor
->DeviceRemovable
802 [((i
+ 1) / 8)] & (1 << ((i
+ 1) % 8))
804 portstr
[hdev
->maxchild
] = 0;
805 dev_dbg(hub_dev
, "compound device; port removable status: %s\n", portstr
);
807 dev_dbg(hub_dev
, "standalone hub\n");
809 switch (wHubCharacteristics
& HUB_CHAR_LPSM
) {
811 dev_dbg(hub_dev
, "ganged power switching\n");
814 dev_dbg(hub_dev
, "individual port power switching\n");
818 dev_dbg(hub_dev
, "no power switching (usb 1.0)\n");
822 switch (wHubCharacteristics
& HUB_CHAR_OCPM
) {
824 dev_dbg(hub_dev
, "global over-current protection\n");
827 dev_dbg(hub_dev
, "individual port over-current protection\n");
831 dev_dbg(hub_dev
, "no over-current protection\n");
835 spin_lock_init (&hub
->tt
.lock
);
836 INIT_LIST_HEAD (&hub
->tt
.clear_list
);
837 INIT_WORK (&hub
->tt
.kevent
, hub_tt_kevent
);
838 switch (hdev
->descriptor
.bDeviceProtocol
) {
842 dev_dbg(hub_dev
, "Single TT\n");
846 ret
= usb_set_interface(hdev
, 0, 1);
848 dev_dbg(hub_dev
, "TT per port\n");
851 dev_err(hub_dev
, "Using single TT (err %d)\n",
856 dev_dbg(hub_dev
, "Unrecognized hub protocol %d\n",
857 hdev
->descriptor
.bDeviceProtocol
);
861 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
862 switch (wHubCharacteristics
& HUB_CHAR_TTTT
) {
863 case HUB_TTTT_8_BITS
:
864 if (hdev
->descriptor
.bDeviceProtocol
!= 0) {
865 hub
->tt
.think_time
= 666;
866 dev_dbg(hub_dev
, "TT requires at most %d "
867 "FS bit times (%d ns)\n",
868 8, hub
->tt
.think_time
);
871 case HUB_TTTT_16_BITS
:
872 hub
->tt
.think_time
= 666 * 2;
873 dev_dbg(hub_dev
, "TT requires at most %d "
874 "FS bit times (%d ns)\n",
875 16, hub
->tt
.think_time
);
877 case HUB_TTTT_24_BITS
:
878 hub
->tt
.think_time
= 666 * 3;
879 dev_dbg(hub_dev
, "TT requires at most %d "
880 "FS bit times (%d ns)\n",
881 24, hub
->tt
.think_time
);
883 case HUB_TTTT_32_BITS
:
884 hub
->tt
.think_time
= 666 * 4;
885 dev_dbg(hub_dev
, "TT requires at most %d "
886 "FS bit times (%d ns)\n",
887 32, hub
->tt
.think_time
);
891 /* probe() zeroes hub->indicator[] */
892 if (wHubCharacteristics
& HUB_CHAR_PORTIND
) {
893 hub
->has_indicators
= 1;
894 dev_dbg(hub_dev
, "Port indicators are supported\n");
897 dev_dbg(hub_dev
, "power on to power good time: %dms\n",
898 hub
->descriptor
->bPwrOn2PwrGood
* 2);
900 /* power budgeting mostly matters with bus-powered hubs,
901 * and battery-powered root hubs (may provide just 8 mA).
903 ret
= usb_get_status(hdev
, USB_RECIP_DEVICE
, 0, &hubstatus
);
905 message
= "can't get hub status";
908 le16_to_cpus(&hubstatus
);
909 if (hdev
== hdev
->bus
->root_hub
) {
910 if (hdev
->bus_mA
== 0 || hdev
->bus_mA
>= 500)
911 hub
->mA_per_port
= 500;
913 hub
->mA_per_port
= hdev
->bus_mA
;
914 hub
->limited_power
= 1;
916 } else if ((hubstatus
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
917 dev_dbg(hub_dev
, "hub controller current requirement: %dmA\n",
918 hub
->descriptor
->bHubContrCurrent
);
919 hub
->limited_power
= 1;
920 if (hdev
->maxchild
> 0) {
921 int remaining
= hdev
->bus_mA
-
922 hub
->descriptor
->bHubContrCurrent
;
924 if (remaining
< hdev
->maxchild
* 100)
926 "insufficient power available "
927 "to use all downstream ports\n");
928 hub
->mA_per_port
= 100; /* 7.2.1.1 */
930 } else { /* Self-powered external hub */
931 /* FIXME: What about battery-powered external hubs that
932 * provide less current per port? */
933 hub
->mA_per_port
= 500;
935 if (hub
->mA_per_port
< 500)
936 dev_dbg(hub_dev
, "%umA bus power budget for each child\n",
939 ret
= hub_hub_status(hub
, &hubstatus
, &hubchange
);
941 message
= "can't get hub status";
945 /* local power status reports aren't always correct */
946 if (hdev
->actconfig
->desc
.bmAttributes
& USB_CONFIG_ATT_SELFPOWER
)
947 dev_dbg(hub_dev
, "local power source is %s\n",
948 (hubstatus
& HUB_STATUS_LOCAL_POWER
)
949 ? "lost (inactive)" : "good");
951 if ((wHubCharacteristics
& HUB_CHAR_OCPM
) == 0)
952 dev_dbg(hub_dev
, "%sover-current condition exists\n",
953 (hubstatus
& HUB_STATUS_OVERCURRENT
) ? "" : "no ");
955 /* set up the interrupt endpoint
956 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
957 * bytes as USB2.0[11.12.3] says because some hubs are known
958 * to send more data (and thus cause overflow). For root hubs,
959 * maxpktsize is defined in hcd.c's fake endpoint descriptors
960 * to be big enough for at least USB_MAXCHILDREN ports. */
961 pipe
= usb_rcvintpipe(hdev
, endpoint
->bEndpointAddress
);
962 maxp
= usb_maxpacket(hdev
, pipe
, usb_pipeout(pipe
));
964 if (maxp
> sizeof(*hub
->buffer
))
965 maxp
= sizeof(*hub
->buffer
);
967 hub
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
969 message
= "couldn't allocate interrupt urb";
974 usb_fill_int_urb(hub
->urb
, hdev
, pipe
, *hub
->buffer
, maxp
, hub_irq
,
975 hub
, endpoint
->bInterval
);
976 hub
->urb
->transfer_dma
= hub
->buffer_dma
;
977 hub
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
979 /* maybe cycle the hub leds */
980 if (hub
->has_indicators
&& blinkenlights
)
981 hub
->indicator
[0] = INDICATOR_CYCLE
;
988 dev_err (hub_dev
, "config failed, %s (err %d)\n",
990 /* hub_disconnect() frees urb and descriptor */
994 static void hub_release(struct kref
*kref
)
996 struct usb_hub
*hub
= container_of(kref
, struct usb_hub
, kref
);
998 usb_put_intf(to_usb_interface(hub
->intfdev
));
1002 static unsigned highspeed_hubs
;
1004 static void hub_disconnect(struct usb_interface
*intf
)
1006 struct usb_hub
*hub
= usb_get_intfdata (intf
);
1008 /* Take the hub off the event list and don't let it be added again */
1009 spin_lock_irq(&hub_event_lock
);
1010 list_del_init(&hub
->event_list
);
1011 hub
->disconnected
= 1;
1012 spin_unlock_irq(&hub_event_lock
);
1014 /* Disconnect all children and quiesce the hub */
1018 usb_set_intfdata (intf
, NULL
);
1020 if (hub
->hdev
->speed
== USB_SPEED_HIGH
)
1023 usb_free_urb(hub
->urb
);
1024 kfree(hub
->descriptor
);
1026 usb_buffer_free(hub
->hdev
, sizeof(*hub
->buffer
), hub
->buffer
,
1029 kref_put(&hub
->kref
, hub_release
);
1032 static int hub_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1034 struct usb_host_interface
*desc
;
1035 struct usb_endpoint_descriptor
*endpoint
;
1036 struct usb_device
*hdev
;
1037 struct usb_hub
*hub
;
1039 desc
= intf
->cur_altsetting
;
1040 hdev
= interface_to_usbdev(intf
);
1042 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1044 dev_warn(&intf
->dev
, "ignoring external hub\n");
1049 /* Some hubs have a subclass of 1, which AFAICT according to the */
1050 /* specs is not defined, but it works */
1051 if ((desc
->desc
.bInterfaceSubClass
!= 0) &&
1052 (desc
->desc
.bInterfaceSubClass
!= 1)) {
1054 dev_err (&intf
->dev
, "bad descriptor, ignoring hub\n");
1058 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1059 if (desc
->desc
.bNumEndpoints
!= 1)
1060 goto descriptor_error
;
1062 endpoint
= &desc
->endpoint
[0].desc
;
1064 /* If it's not an interrupt in endpoint, we'd better punt! */
1065 if (!usb_endpoint_is_int_in(endpoint
))
1066 goto descriptor_error
;
1068 /* We found a hub */
1069 dev_info (&intf
->dev
, "USB hub found\n");
1071 hub
= kzalloc(sizeof(*hub
), GFP_KERNEL
);
1073 dev_dbg (&intf
->dev
, "couldn't kmalloc hub struct\n");
1077 kref_init(&hub
->kref
);
1078 INIT_LIST_HEAD(&hub
->event_list
);
1079 hub
->intfdev
= &intf
->dev
;
1081 INIT_DELAYED_WORK(&hub
->leds
, led_work
);
1084 usb_set_intfdata (intf
, hub
);
1085 intf
->needs_remote_wakeup
= 1;
1087 if (hdev
->speed
== USB_SPEED_HIGH
)
1090 if (hub_configure(hub
, endpoint
) >= 0)
1093 hub_disconnect (intf
);
1098 hub_ioctl(struct usb_interface
*intf
, unsigned int code
, void *user_data
)
1100 struct usb_device
*hdev
= interface_to_usbdev (intf
);
1102 /* assert ifno == 0 (part of hub spec) */
1104 case USBDEVFS_HUB_PORTINFO
: {
1105 struct usbdevfs_hub_portinfo
*info
= user_data
;
1108 spin_lock_irq(&device_state_lock
);
1109 if (hdev
->devnum
<= 0)
1112 info
->nports
= hdev
->maxchild
;
1113 for (i
= 0; i
< info
->nports
; i
++) {
1114 if (hdev
->children
[i
] == NULL
)
1118 hdev
->children
[i
]->devnum
;
1121 spin_unlock_irq(&device_state_lock
);
1123 return info
->nports
+ 1;
1132 static void recursively_mark_NOTATTACHED(struct usb_device
*udev
)
1136 for (i
= 0; i
< udev
->maxchild
; ++i
) {
1137 if (udev
->children
[i
])
1138 recursively_mark_NOTATTACHED(udev
->children
[i
]);
1140 if (udev
->state
== USB_STATE_SUSPENDED
) {
1141 udev
->discon_suspended
= 1;
1142 udev
->active_duration
-= jiffies
;
1144 udev
->state
= USB_STATE_NOTATTACHED
;
1148 * usb_set_device_state - change a device's current state (usbcore, hcds)
1149 * @udev: pointer to device whose state should be changed
1150 * @new_state: new state value to be stored
1152 * udev->state is _not_ fully protected by the device lock. Although
1153 * most transitions are made only while holding the lock, the state can
1154 * can change to USB_STATE_NOTATTACHED at almost any time. This
1155 * is so that devices can be marked as disconnected as soon as possible,
1156 * without having to wait for any semaphores to be released. As a result,
1157 * all changes to any device's state must be protected by the
1158 * device_state_lock spinlock.
1160 * Once a device has been added to the device tree, all changes to its state
1161 * should be made using this routine. The state should _not_ be set directly.
1163 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1164 * Otherwise udev->state is set to new_state, and if new_state is
1165 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1166 * to USB_STATE_NOTATTACHED.
1168 void usb_set_device_state(struct usb_device
*udev
,
1169 enum usb_device_state new_state
)
1171 unsigned long flags
;
1173 spin_lock_irqsave(&device_state_lock
, flags
);
1174 if (udev
->state
== USB_STATE_NOTATTACHED
)
1176 else if (new_state
!= USB_STATE_NOTATTACHED
) {
1178 /* root hub wakeup capabilities are managed out-of-band
1179 * and may involve silicon errata ... ignore them here.
1182 if (udev
->state
== USB_STATE_SUSPENDED
1183 || new_state
== USB_STATE_SUSPENDED
)
1184 ; /* No change to wakeup settings */
1185 else if (new_state
== USB_STATE_CONFIGURED
)
1186 device_init_wakeup(&udev
->dev
,
1187 (udev
->actconfig
->desc
.bmAttributes
1188 & USB_CONFIG_ATT_WAKEUP
));
1190 device_init_wakeup(&udev
->dev
, 0);
1192 if (udev
->state
== USB_STATE_SUSPENDED
&&
1193 new_state
!= USB_STATE_SUSPENDED
)
1194 udev
->active_duration
-= jiffies
;
1195 else if (new_state
== USB_STATE_SUSPENDED
&&
1196 udev
->state
!= USB_STATE_SUSPENDED
)
1197 udev
->active_duration
+= jiffies
;
1198 udev
->state
= new_state
;
1200 recursively_mark_NOTATTACHED(udev
);
1201 spin_unlock_irqrestore(&device_state_lock
, flags
);
1204 static void choose_address(struct usb_device
*udev
)
1207 struct usb_bus
*bus
= udev
->bus
;
1209 /* If khubd ever becomes multithreaded, this will need a lock */
1211 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1212 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128,
1215 devnum
= find_next_zero_bit(bus
->devmap
.devicemap
, 128, 1);
1217 bus
->devnum_next
= ( devnum
>= 127 ? 1 : devnum
+ 1);
1220 set_bit(devnum
, bus
->devmap
.devicemap
);
1221 udev
->devnum
= devnum
;
1225 static void release_address(struct usb_device
*udev
)
1227 if (udev
->devnum
> 0) {
1228 clear_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1233 #ifdef CONFIG_USB_SUSPEND
1235 static void usb_stop_pm(struct usb_device
*udev
)
1237 /* Synchronize with the ksuspend thread to prevent any more
1238 * autosuspend requests from being submitted, and decrement
1239 * the parent's count of unsuspended children.
1242 if (udev
->parent
&& !udev
->discon_suspended
)
1243 usb_autosuspend_device(udev
->parent
);
1244 usb_pm_unlock(udev
);
1246 /* Stop any autosuspend requests already submitted */
1247 cancel_rearming_delayed_work(&udev
->autosuspend
);
1252 static inline void usb_stop_pm(struct usb_device
*udev
)
1258 * usb_disconnect - disconnect a device (usbcore-internal)
1259 * @pdev: pointer to device being disconnected
1260 * Context: !in_interrupt ()
1262 * Something got disconnected. Get rid of it and all of its children.
1264 * If *pdev is a normal device then the parent hub must already be locked.
1265 * If *pdev is a root hub then this routine will acquire the
1266 * usb_bus_list_lock on behalf of the caller.
1268 * Only hub drivers (including virtual root hub drivers for host
1269 * controllers) should ever call this.
1271 * This call is synchronous, and may not be used in an interrupt context.
1273 void usb_disconnect(struct usb_device
**pdev
)
1275 struct usb_device
*udev
= *pdev
;
1279 pr_debug ("%s nodev\n", __FUNCTION__
);
1283 /* mark the device as inactive, so any further urb submissions for
1284 * this device (and any of its children) will fail immediately.
1285 * this quiesces everyting except pending urbs.
1287 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1288 dev_info (&udev
->dev
, "USB disconnect, address %d\n", udev
->devnum
);
1290 usb_lock_device(udev
);
1292 /* Free up all the children before we remove this device */
1293 for (i
= 0; i
< USB_MAXCHILDREN
; i
++) {
1294 if (udev
->children
[i
])
1295 usb_disconnect(&udev
->children
[i
]);
1298 /* deallocate hcd/hardware state ... nuking all pending urbs and
1299 * cleaning up all state associated with the current configuration
1300 * so that the hardware is now fully quiesced.
1302 dev_dbg (&udev
->dev
, "unregistering device\n");
1303 usb_disable_device(udev
, 0);
1305 usb_unlock_device(udev
);
1307 /* Unregister the device. The device driver is responsible
1308 * for removing the device files from usbfs and sysfs and for
1309 * de-configuring the device.
1311 device_del(&udev
->dev
);
1313 /* Free the device number and delete the parent's children[]
1314 * (or root_hub) pointer.
1316 release_address(udev
);
1318 /* Avoid races with recursively_mark_NOTATTACHED() */
1319 spin_lock_irq(&device_state_lock
);
1321 spin_unlock_irq(&device_state_lock
);
1325 put_device(&udev
->dev
);
1328 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1329 static void show_string(struct usb_device
*udev
, char *id
, char *string
)
1333 dev_printk(KERN_INFO
, &udev
->dev
, "%s: %s\n", id
, string
);
1336 static void announce_device(struct usb_device
*udev
)
1338 dev_info(&udev
->dev
, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1339 le16_to_cpu(udev
->descriptor
.idVendor
),
1340 le16_to_cpu(udev
->descriptor
.idProduct
));
1341 dev_info(&udev
->dev
, "New USB device strings: Mfr=%d, Product=%d, "
1342 "SerialNumber=%d\n",
1343 udev
->descriptor
.iManufacturer
,
1344 udev
->descriptor
.iProduct
,
1345 udev
->descriptor
.iSerialNumber
);
1346 show_string(udev
, "Product", udev
->product
);
1347 show_string(udev
, "Manufacturer", udev
->manufacturer
);
1348 show_string(udev
, "SerialNumber", udev
->serial
);
1351 static inline void announce_device(struct usb_device
*udev
) { }
1354 #ifdef CONFIG_USB_OTG
1355 #include "otg_whitelist.h"
1359 * usb_configure_device_otg - FIXME (usbcore-internal)
1360 * @udev: newly addressed device (in ADDRESS state)
1362 * Do configuration for On-The-Go devices
1364 static int usb_configure_device_otg(struct usb_device
*udev
)
1368 #ifdef CONFIG_USB_OTG
1370 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1371 * to wake us after we've powered off VBUS; and HNP, switching roles
1372 * "host" to "peripheral". The OTG descriptor helps figure this out.
1374 if (!udev
->bus
->is_b_host
1376 && udev
->parent
== udev
->bus
->root_hub
) {
1377 struct usb_otg_descriptor
*desc
= 0;
1378 struct usb_bus
*bus
= udev
->bus
;
1380 /* descriptor may appear anywhere in config */
1381 if (__usb_get_extra_descriptor (udev
->rawdescriptors
[0],
1382 le16_to_cpu(udev
->config
[0].desc
.wTotalLength
),
1383 USB_DT_OTG
, (void **) &desc
) == 0) {
1384 if (desc
->bmAttributes
& USB_OTG_HNP
) {
1385 unsigned port1
= udev
->portnum
;
1387 dev_info(&udev
->dev
,
1388 "Dual-Role OTG device on %sHNP port\n",
1389 (port1
== bus
->otg_port
)
1392 /* enable HNP before suspend, it's simpler */
1393 if (port1
== bus
->otg_port
)
1394 bus
->b_hnp_enable
= 1;
1395 err
= usb_control_msg(udev
,
1396 usb_sndctrlpipe(udev
, 0),
1397 USB_REQ_SET_FEATURE
, 0,
1399 ? USB_DEVICE_B_HNP_ENABLE
1400 : USB_DEVICE_A_ALT_HNP_SUPPORT
,
1401 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1403 /* OTG MESSAGE: report errors here,
1404 * customize to match your product.
1406 dev_info(&udev
->dev
,
1407 "can't set HNP mode; %d\n",
1409 bus
->b_hnp_enable
= 0;
1415 if (!is_targeted(udev
)) {
1417 /* Maybe it can talk to us, though we can't talk to it.
1418 * (Includes HNP test device.)
1420 if (udev
->bus
->b_hnp_enable
|| udev
->bus
->is_b_host
) {
1421 err
= usb_port_suspend(udev
);
1423 dev_dbg(&udev
->dev
, "HNP fail, %d\n", err
);
1435 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1436 * @udev: newly addressed device (in ADDRESS state)
1438 * This is only called by usb_new_device() and usb_authorize_device()
1439 * and FIXME -- all comments that apply to them apply here wrt to
1442 * If the device is WUSB and not authorized, we don't attempt to read
1443 * the string descriptors, as they will be errored out by the device
1444 * until it has been authorized.
1446 static int usb_configure_device(struct usb_device
*udev
)
1450 if (udev
->config
== NULL
) {
1451 err
= usb_get_configuration(udev
);
1453 dev_err(&udev
->dev
, "can't read configurations, error %d\n",
1458 if (udev
->wusb
== 1 && udev
->authorized
== 0) {
1459 udev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1460 udev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1461 udev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1464 /* read the standard strings and cache them if present */
1465 udev
->product
= usb_cache_string(udev
, udev
->descriptor
.iProduct
);
1466 udev
->manufacturer
= usb_cache_string(udev
,
1467 udev
->descriptor
.iManufacturer
);
1468 udev
->serial
= usb_cache_string(udev
, udev
->descriptor
.iSerialNumber
);
1470 err
= usb_configure_device_otg(udev
);
1477 * usb_new_device - perform initial device setup (usbcore-internal)
1478 * @udev: newly addressed device (in ADDRESS state)
1480 * This is called with devices which have been enumerated, but not yet
1481 * configured. The device descriptor is available, but not descriptors
1482 * for any device configuration. The caller must have locked either
1483 * the parent hub (if udev is a normal device) or else the
1484 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1485 * udev has already been installed, but udev is not yet visible through
1486 * sysfs or other filesystem code.
1488 * It will return if the device is configured properly or not. Zero if
1489 * the interface was registered with the driver core; else a negative
1492 * This call is synchronous, and may not be used in an interrupt context.
1494 * Only the hub driver or root-hub registrar should ever call this.
1496 int usb_new_device(struct usb_device
*udev
)
1500 usb_detect_quirks(udev
); /* Determine quirks */
1501 err
= usb_configure_device(udev
); /* detect & probe dev/intfs */
1504 /* export the usbdev device-node for libusb */
1505 udev
->dev
.devt
= MKDEV(USB_DEVICE_MAJOR
,
1506 (((udev
->bus
->busnum
-1) * 128) + (udev
->devnum
-1)));
1508 /* Increment the parent's count of unsuspended children */
1510 usb_autoresume_device(udev
->parent
);
1512 /* Register the device. The device driver is responsible
1513 * for adding the device files to sysfs and for configuring
1516 err
= device_add(&udev
->dev
);
1518 dev_err(&udev
->dev
, "can't device_add, error %d\n", err
);
1522 /* Tell the world! */
1523 announce_device(udev
);
1527 usb_set_device_state(udev
, USB_STATE_NOTATTACHED
);
1533 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1534 * @usb_dev: USB device
1536 * Move the USB device to a very basic state where interfaces are disabled
1537 * and the device is in fact unconfigured and unusable.
1539 * We share a lock (that we have) with device_del(), so we need to
1542 int usb_deauthorize_device(struct usb_device
*usb_dev
)
1545 usb_lock_device(usb_dev
);
1546 if (usb_dev
->authorized
== 0)
1547 goto out_unauthorized
;
1548 usb_dev
->authorized
= 0;
1549 usb_set_configuration(usb_dev
, -1);
1550 usb_dev
->product
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1551 usb_dev
->manufacturer
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1552 usb_dev
->serial
= kstrdup("n/a (unauthorized)", GFP_KERNEL
);
1553 kfree(usb_dev
->config
);
1554 usb_dev
->config
= NULL
;
1555 for (cnt
= 0; cnt
< usb_dev
->descriptor
.bNumConfigurations
; cnt
++)
1556 kfree(usb_dev
->rawdescriptors
[cnt
]);
1557 usb_dev
->descriptor
.bNumConfigurations
= 0;
1558 kfree(usb_dev
->rawdescriptors
);
1560 usb_unlock_device(usb_dev
);
1565 int usb_authorize_device(struct usb_device
*usb_dev
)
1568 usb_lock_device(usb_dev
);
1569 if (usb_dev
->authorized
== 1)
1570 goto out_authorized
;
1571 kfree(usb_dev
->product
);
1572 usb_dev
->product
= NULL
;
1573 kfree(usb_dev
->manufacturer
);
1574 usb_dev
->manufacturer
= NULL
;
1575 kfree(usb_dev
->serial
);
1576 usb_dev
->serial
= NULL
;
1577 result
= usb_autoresume_device(usb_dev
);
1579 dev_err(&usb_dev
->dev
,
1580 "can't autoresume for authorization: %d\n", result
);
1581 goto error_autoresume
;
1583 result
= usb_get_device_descriptor(usb_dev
, sizeof(usb_dev
->descriptor
));
1585 dev_err(&usb_dev
->dev
, "can't re-read device descriptor for "
1586 "authorization: %d\n", result
);
1587 goto error_device_descriptor
;
1589 usb_dev
->authorized
= 1;
1590 result
= usb_configure_device(usb_dev
);
1592 goto error_configure
;
1593 /* Choose and set the configuration. This registers the interfaces
1594 * with the driver core and lets interface drivers bind to them.
1596 c
= usb_choose_configuration(usb_dev
);
1598 result
= usb_set_configuration(usb_dev
, c
);
1600 dev_err(&usb_dev
->dev
,
1601 "can't set config #%d, error %d\n", c
, result
);
1602 /* This need not be fatal. The user can try to
1603 * set other configurations. */
1606 dev_info(&usb_dev
->dev
, "authorized to connect\n");
1608 error_device_descriptor
:
1611 usb_unlock_device(usb_dev
); // complements locktree
1616 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1617 static unsigned hub_is_wusb(struct usb_hub
*hub
)
1619 struct usb_hcd
*hcd
;
1620 if (hub
->hdev
->parent
!= NULL
) /* not a root hub? */
1622 hcd
= container_of(hub
->hdev
->bus
, struct usb_hcd
, self
);
1623 return hcd
->wireless
;
1627 #define PORT_RESET_TRIES 5
1628 #define SET_ADDRESS_TRIES 2
1629 #define GET_DESCRIPTOR_TRIES 2
1630 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1631 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1633 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1634 #define HUB_SHORT_RESET_TIME 10
1635 #define HUB_LONG_RESET_TIME 200
1636 #define HUB_RESET_TIMEOUT 500
1638 static int hub_port_wait_reset(struct usb_hub
*hub
, int port1
,
1639 struct usb_device
*udev
, unsigned int delay
)
1641 int delay_time
, ret
;
1645 for (delay_time
= 0;
1646 delay_time
< HUB_RESET_TIMEOUT
;
1647 delay_time
+= delay
) {
1648 /* wait to give the device a chance to reset */
1651 /* read and decode port status */
1652 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1656 /* Device went away? */
1657 if (!(portstatus
& USB_PORT_STAT_CONNECTION
))
1660 /* bomb out completely if the connection bounced */
1661 if ((portchange
& USB_PORT_STAT_C_CONNECTION
))
1664 /* if we`ve finished resetting, then break out of the loop */
1665 if (!(portstatus
& USB_PORT_STAT_RESET
) &&
1666 (portstatus
& USB_PORT_STAT_ENABLE
)) {
1667 if (hub_is_wusb(hub
))
1668 udev
->speed
= USB_SPEED_VARIABLE
;
1669 else if (portstatus
& USB_PORT_STAT_HIGH_SPEED
)
1670 udev
->speed
= USB_SPEED_HIGH
;
1671 else if (portstatus
& USB_PORT_STAT_LOW_SPEED
)
1672 udev
->speed
= USB_SPEED_LOW
;
1674 udev
->speed
= USB_SPEED_FULL
;
1678 /* switch to the long delay after two short delay failures */
1679 if (delay_time
>= 2 * HUB_SHORT_RESET_TIME
)
1680 delay
= HUB_LONG_RESET_TIME
;
1682 dev_dbg (hub
->intfdev
,
1683 "port %d not reset yet, waiting %dms\n",
1690 static int hub_port_reset(struct usb_hub
*hub
, int port1
,
1691 struct usb_device
*udev
, unsigned int delay
)
1695 /* Block EHCI CF initialization during the port reset.
1696 * Some companion controllers don't like it when they mix.
1698 down_read(&ehci_cf_port_reset_rwsem
);
1700 /* Reset the port */
1701 for (i
= 0; i
< PORT_RESET_TRIES
; i
++) {
1702 status
= set_port_feature(hub
->hdev
,
1703 port1
, USB_PORT_FEAT_RESET
);
1705 dev_err(hub
->intfdev
,
1706 "cannot reset port %d (err = %d)\n",
1709 status
= hub_port_wait_reset(hub
, port1
, udev
, delay
);
1710 if (status
&& status
!= -ENOTCONN
)
1711 dev_dbg(hub
->intfdev
,
1712 "port_wait_reset: err = %d\n",
1716 /* return on disconnect or reset */
1719 /* TRSTRCY = 10 ms; plus some extra */
1721 udev
->devnum
= 0; /* Device now at address 0 */
1725 clear_port_feature(hub
->hdev
,
1726 port1
, USB_PORT_FEAT_C_RESET
);
1727 /* FIXME need disconnect() for NOTATTACHED device */
1728 usb_set_device_state(udev
, status
1729 ? USB_STATE_NOTATTACHED
1730 : USB_STATE_DEFAULT
);
1734 dev_dbg (hub
->intfdev
,
1735 "port %d not enabled, trying reset again...\n",
1737 delay
= HUB_LONG_RESET_TIME
;
1740 dev_err (hub
->intfdev
,
1741 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1745 up_read(&ehci_cf_port_reset_rwsem
);
1751 #ifdef CONFIG_USB_SUSPEND
1754 * usb_port_suspend - suspend a usb device's upstream port
1755 * @udev: device that's no longer in active use, not a root hub
1756 * Context: must be able to sleep; device not locked; pm locks held
1758 * Suspends a USB device that isn't in active use, conserving power.
1759 * Devices may wake out of a suspend, if anything important happens,
1760 * using the remote wakeup mechanism. They may also be taken out of
1761 * suspend by the host, using usb_port_resume(). It's also routine
1762 * to disconnect devices while they are suspended.
1764 * This only affects the USB hardware for a device; its interfaces
1765 * (and, for hubs, child devices) must already have been suspended.
1767 * Selective port suspend reduces power; most suspended devices draw
1768 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1769 * All devices below the suspended port are also suspended.
1771 * Devices leave suspend state when the host wakes them up. Some devices
1772 * also support "remote wakeup", where the device can activate the USB
1773 * tree above them to deliver data, such as a keypress or packet. In
1774 * some cases, this wakes the USB host.
1776 * Suspending OTG devices may trigger HNP, if that's been enabled
1777 * between a pair of dual-role devices. That will change roles, such
1778 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1780 * Devices on USB hub ports have only one "suspend" state, corresponding
1781 * to ACPI D2, "may cause the device to lose some context".
1782 * State transitions include:
1784 * - suspend, resume ... when the VBUS power link stays live
1785 * - suspend, disconnect ... VBUS lost
1787 * Once VBUS drop breaks the circuit, the port it's using has to go through
1788 * normal re-enumeration procedures, starting with enabling VBUS power.
1789 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1790 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1791 * timer, no SRP, no requests through sysfs.
1793 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1794 * the root hub for their bus goes into global suspend ... so we don't
1795 * (falsely) update the device power state to say it suspended.
1797 * Returns 0 on success, else negative errno.
1799 int usb_port_suspend(struct usb_device
*udev
)
1801 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1802 int port1
= udev
->portnum
;
1805 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1807 /* enable remote wakeup when appropriate; this lets the device
1808 * wake up the upstream hub (including maybe the root hub).
1810 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1811 * we don't explicitly enable it here.
1813 if (udev
->do_remote_wakeup
) {
1814 status
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1815 USB_REQ_SET_FEATURE
, USB_RECIP_DEVICE
,
1816 USB_DEVICE_REMOTE_WAKEUP
, 0,
1818 USB_CTRL_SET_TIMEOUT
);
1820 dev_dbg(&udev
->dev
, "won't remote wakeup, status %d\n",
1825 status
= set_port_feature(hub
->hdev
, port1
, USB_PORT_FEAT_SUSPEND
);
1827 dev_dbg(hub
->intfdev
, "can't suspend port %d, status %d\n",
1829 /* paranoia: "should not happen" */
1830 (void) usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1831 USB_REQ_CLEAR_FEATURE
, USB_RECIP_DEVICE
,
1832 USB_DEVICE_REMOTE_WAKEUP
, 0,
1834 USB_CTRL_SET_TIMEOUT
);
1836 /* device has up to 10 msec to fully suspend */
1837 dev_dbg(&udev
->dev
, "usb %ssuspend\n",
1838 udev
->auto_pm
? "auto-" : "");
1839 usb_set_device_state(udev
, USB_STATE_SUSPENDED
);
1846 * If the USB "suspend" state is in use (rather than "global suspend"),
1847 * many devices will be individually taken out of suspend state using
1848 * special "resume" signaling. This routine kicks in shortly after
1849 * hardware resume signaling is finished, either because of selective
1850 * resume (by host) or remote wakeup (by device) ... now see what changed
1851 * in the tree that's rooted at this device.
1853 * If @udev->reset_resume is set then the device is reset before the
1854 * status check is done.
1856 static int finish_port_resume(struct usb_device
*udev
)
1861 /* caller owns the udev device lock */
1862 dev_dbg(&udev
->dev
, "finish %sresume\n",
1863 udev
->reset_resume
? "reset-" : "");
1865 /* usb ch9 identifies four variants of SUSPENDED, based on what
1866 * state the device resumes to. Linux currently won't see the
1867 * first two on the host side; they'd be inside hub_port_init()
1868 * during many timeouts, but khubd can't suspend until later.
1870 usb_set_device_state(udev
, udev
->actconfig
1871 ? USB_STATE_CONFIGURED
1872 : USB_STATE_ADDRESS
);
1874 /* 10.5.4.5 says not to reset a suspended port if the attached
1875 * device is enabled for remote wakeup. Hence the reset
1876 * operation is carried out here, after the port has been
1879 if (udev
->reset_resume
)
1880 status
= usb_reset_device(udev
);
1882 /* 10.5.4.5 says be sure devices in the tree are still there.
1883 * For now let's assume the device didn't go crazy on resume,
1884 * and device drivers will know about any resume quirks.
1888 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, &devstatus
);
1890 status
= (status
> 0 ? 0 : -ENODEV
);
1894 dev_dbg(&udev
->dev
, "gone after usb resume? status %d\n",
1896 } else if (udev
->actconfig
) {
1897 le16_to_cpus(&devstatus
);
1898 if (devstatus
& (1 << USB_DEVICE_REMOTE_WAKEUP
)) {
1899 status
= usb_control_msg(udev
,
1900 usb_sndctrlpipe(udev
, 0),
1901 USB_REQ_CLEAR_FEATURE
,
1903 USB_DEVICE_REMOTE_WAKEUP
, 0,
1905 USB_CTRL_SET_TIMEOUT
);
1907 dev_dbg(&udev
->dev
, "disable remote "
1908 "wakeup, status %d\n", status
);
1916 * usb_port_resume - re-activate a suspended usb device's upstream port
1917 * @udev: device to re-activate, not a root hub
1918 * Context: must be able to sleep; device not locked; pm locks held
1920 * This will re-activate the suspended device, increasing power usage
1921 * while letting drivers communicate again with its endpoints.
1922 * USB resume explicitly guarantees that the power session between
1923 * the host and the device is the same as it was when the device
1926 * If CONFIG_USB_PERSIST and @udev->reset_resume are both set then this
1927 * routine won't check that the port is still enabled. Furthermore,
1928 * if @udev->reset_resume is set then finish_port_resume() above will
1929 * reset @udev. The end result is that a broken power session can be
1930 * recovered and @udev will appear to persist across a loss of VBUS power.
1932 * For example, if a host controller doesn't maintain VBUS suspend current
1933 * during a system sleep or is reset when the system wakes up, all the USB
1934 * power sessions below it will be broken. This is especially troublesome
1935 * for mass-storage devices containing mounted filesystems, since the
1936 * device will appear to have disconnected and all the memory mappings
1937 * to it will be lost. Using the USB_PERSIST facility, the device can be
1938 * made to appear as if it had not disconnected.
1940 * This facility is inherently dangerous. Although usb_reset_device()
1941 * makes every effort to insure that the same device is present after the
1942 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
1943 * quite possible for a device to remain unaltered but its media to be
1944 * changed. If the user replaces a flash memory card while the system is
1945 * asleep, he will have only himself to blame when the filesystem on the
1946 * new card is corrupted and the system crashes.
1948 * Returns 0 on success, else negative errno.
1950 int usb_port_resume(struct usb_device
*udev
)
1952 struct usb_hub
*hub
= hdev_to_hub(udev
->parent
);
1953 int port1
= udev
->portnum
;
1955 u16 portchange
, portstatus
;
1956 unsigned mask_flags
, want_flags
;
1958 /* Skip the initial Clear-Suspend step for a remote wakeup */
1959 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1960 if (status
== 0 && !(portstatus
& USB_PORT_STAT_SUSPEND
))
1961 goto SuspendCleared
;
1963 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1965 set_bit(port1
, hub
->busy_bits
);
1967 /* see 7.1.7.7; affects power usage, but not budgeting */
1968 status
= clear_port_feature(hub
->hdev
,
1969 port1
, USB_PORT_FEAT_SUSPEND
);
1971 dev_dbg(hub
->intfdev
, "can't resume port %d, status %d\n",
1974 /* drive resume for at least 20 msec */
1975 dev_dbg(&udev
->dev
, "usb %sresume\n",
1976 udev
->auto_pm
? "auto-" : "");
1979 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1980 * stop resume signaling. Then finish the resume
1983 status
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
1986 if (USB_PERSIST
&& udev
->reset_resume
)
1987 want_flags
= USB_PORT_STAT_POWER
1988 | USB_PORT_STAT_CONNECTION
;
1990 want_flags
= USB_PORT_STAT_POWER
1991 | USB_PORT_STAT_CONNECTION
1992 | USB_PORT_STAT_ENABLE
;
1993 mask_flags
= want_flags
| USB_PORT_STAT_SUSPEND
;
1995 if (status
< 0 || (portstatus
& mask_flags
) != want_flags
) {
1996 dev_dbg(hub
->intfdev
,
1997 "port %d status %04x.%04x after resume, %d\n",
1998 port1
, portchange
, portstatus
, status
);
2002 if (portchange
& USB_PORT_STAT_C_SUSPEND
)
2003 clear_port_feature(hub
->hdev
, port1
,
2004 USB_PORT_FEAT_C_SUSPEND
);
2005 /* TRSMRCY = 10 msec */
2010 clear_bit(port1
, hub
->busy_bits
);
2011 if (!hub
->hdev
->parent
&& !hub
->busy_bits
[0])
2012 usb_enable_root_hub_irq(hub
->hdev
->bus
);
2015 status
= finish_port_resume(udev
);
2017 dev_dbg(&udev
->dev
, "can't resume, status %d\n", status
);
2018 hub_port_logical_disconnect(hub
, port1
);
2023 static int remote_wakeup(struct usb_device
*udev
)
2027 usb_lock_device(udev
);
2028 if (udev
->state
== USB_STATE_SUSPENDED
) {
2029 dev_dbg(&udev
->dev
, "usb %sresume\n", "wakeup-");
2030 usb_mark_last_busy(udev
);
2031 status
= usb_external_resume_device(udev
);
2033 usb_unlock_device(udev
);
2037 #else /* CONFIG_USB_SUSPEND */
2039 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2041 int usb_port_suspend(struct usb_device
*udev
)
2046 int usb_port_resume(struct usb_device
*udev
)
2050 /* However we may need to do a reset-resume */
2051 if (udev
->reset_resume
) {
2052 dev_dbg(&udev
->dev
, "reset-resume\n");
2053 status
= usb_reset_device(udev
);
2058 static inline int remote_wakeup(struct usb_device
*udev
)
2065 static int hub_suspend(struct usb_interface
*intf
, pm_message_t msg
)
2067 struct usb_hub
*hub
= usb_get_intfdata (intf
);
2068 struct usb_device
*hdev
= hub
->hdev
;
2071 /* fail if children aren't already suspended */
2072 for (port1
= 1; port1
<= hdev
->maxchild
; port1
++) {
2073 struct usb_device
*udev
;
2075 udev
= hdev
->children
[port1
-1];
2076 if (udev
&& udev
->can_submit
) {
2078 dev_dbg(&intf
->dev
, "port %d nyet suspended\n",
2084 dev_dbg(&intf
->dev
, "%s\n", __FUNCTION__
);
2086 /* stop khubd and related activity */
2091 static int hub_resume(struct usb_interface
*intf
)
2093 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2095 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2096 hub_restart(hub
, HUB_RESUME
);
2100 static int hub_reset_resume(struct usb_interface
*intf
)
2102 struct usb_hub
*hub
= usb_get_intfdata(intf
);
2104 dev_dbg(&intf
->dev
, "%s\n", __func__
);
2106 hub_restart(hub
, HUB_RESET_RESUME
);
2111 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2112 * @rhdev: struct usb_device for the root hub
2114 * The USB host controller driver calls this function when its root hub
2115 * is resumed and Vbus power has been interrupted or the controller
2116 * has been reset. The routine marks @rhdev as having lost power. When
2117 * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
2118 * is enabled then it will carry out power-session recovery, otherwise
2119 * it will disconnect all the child devices.
2121 void usb_root_hub_lost_power(struct usb_device
*rhdev
)
2123 dev_warn(&rhdev
->dev
, "root hub lost power or was reset\n");
2124 rhdev
->reset_resume
= 1;
2126 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power
);
2128 #else /* CONFIG_PM */
2130 static inline int remote_wakeup(struct usb_device
*udev
)
2135 #define hub_suspend NULL
2136 #define hub_resume NULL
2137 #define hub_reset_resume NULL
2141 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2143 * Between connect detection and reset signaling there must be a delay
2144 * of 100ms at least for debounce and power-settling. The corresponding
2145 * timer shall restart whenever the downstream port detects a disconnect.
2147 * Apparently there are some bluetooth and irda-dongles and a number of
2148 * low-speed devices for which this debounce period may last over a second.
2149 * Not covered by the spec - but easy to deal with.
2151 * This implementation uses a 1500ms total debounce timeout; if the
2152 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2153 * every 25ms for transient disconnects. When the port status has been
2154 * unchanged for 100ms it returns the port status.
2157 #define HUB_DEBOUNCE_TIMEOUT 1500
2158 #define HUB_DEBOUNCE_STEP 25
2159 #define HUB_DEBOUNCE_STABLE 100
2161 static int hub_port_debounce(struct usb_hub
*hub
, int port1
)
2164 int total_time
, stable_time
= 0;
2165 u16 portchange
, portstatus
;
2166 unsigned connection
= 0xffff;
2168 for (total_time
= 0; ; total_time
+= HUB_DEBOUNCE_STEP
) {
2169 ret
= hub_port_status(hub
, port1
, &portstatus
, &portchange
);
2173 if (!(portchange
& USB_PORT_STAT_C_CONNECTION
) &&
2174 (portstatus
& USB_PORT_STAT_CONNECTION
) == connection
) {
2175 stable_time
+= HUB_DEBOUNCE_STEP
;
2176 if (stable_time
>= HUB_DEBOUNCE_STABLE
)
2180 connection
= portstatus
& USB_PORT_STAT_CONNECTION
;
2183 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2184 clear_port_feature(hub
->hdev
, port1
,
2185 USB_PORT_FEAT_C_CONNECTION
);
2188 if (total_time
>= HUB_DEBOUNCE_TIMEOUT
)
2190 msleep(HUB_DEBOUNCE_STEP
);
2193 dev_dbg (hub
->intfdev
,
2194 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2195 port1
, total_time
, stable_time
, portstatus
);
2197 if (stable_time
< HUB_DEBOUNCE_STABLE
)
2202 static void ep0_reinit(struct usb_device
*udev
)
2204 usb_disable_endpoint(udev
, 0 + USB_DIR_IN
);
2205 usb_disable_endpoint(udev
, 0 + USB_DIR_OUT
);
2206 usb_enable_endpoint(udev
, &udev
->ep0
);
2209 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2210 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2212 static int hub_set_address(struct usb_device
*udev
, int devnum
)
2218 if (udev
->state
== USB_STATE_ADDRESS
)
2220 if (udev
->state
!= USB_STATE_DEFAULT
)
2222 retval
= usb_control_msg(udev
, usb_sndaddr0pipe(),
2223 USB_REQ_SET_ADDRESS
, 0, devnum
, 0,
2224 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
2226 udev
->devnum
= devnum
; /* Device now using proper address */
2227 usb_set_device_state(udev
, USB_STATE_ADDRESS
);
2233 /* Reset device, (re)assign address, get device descriptor.
2234 * Device connection must be stable, no more debouncing needed.
2235 * Returns device in USB_STATE_ADDRESS, except on error.
2237 * If this is called for an already-existing device (as part of
2238 * usb_reset_device), the caller must own the device lock. For a
2239 * newly detected device that is not accessible through any global
2240 * pointers, it's not necessary to lock the device.
2243 hub_port_init (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
,
2246 static DEFINE_MUTEX(usb_address0_mutex
);
2248 struct usb_device
*hdev
= hub
->hdev
;
2250 unsigned delay
= HUB_SHORT_RESET_TIME
;
2251 enum usb_device_speed oldspeed
= udev
->speed
;
2253 int devnum
= udev
->devnum
;
2255 /* root hub ports have a slightly longer reset period
2256 * (from USB 2.0 spec, section 7.1.7.5)
2258 if (!hdev
->parent
) {
2259 delay
= HUB_ROOT_RESET_TIME
;
2260 if (port1
== hdev
->bus
->otg_port
)
2261 hdev
->bus
->b_hnp_enable
= 0;
2264 /* Some low speed devices have problems with the quick delay, so */
2265 /* be a bit pessimistic with those devices. RHbug #23670 */
2266 if (oldspeed
== USB_SPEED_LOW
)
2267 delay
= HUB_LONG_RESET_TIME
;
2269 mutex_lock(&usb_address0_mutex
);
2271 /* Reset the device; full speed may morph to high speed */
2272 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2273 if (retval
< 0) /* error or disconnect */
2275 /* success, speed is known */
2278 if (oldspeed
!= USB_SPEED_UNKNOWN
&& oldspeed
!= udev
->speed
) {
2279 dev_dbg(&udev
->dev
, "device reset changed speed!\n");
2282 oldspeed
= udev
->speed
;
2284 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2285 * it's fixed size except for full speed devices.
2286 * For Wireless USB devices, ep0 max packet is always 512 (tho
2287 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2289 switch (udev
->speed
) {
2290 case USB_SPEED_VARIABLE
: /* fixed at 512 */
2291 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(512);
2293 case USB_SPEED_HIGH
: /* fixed at 64 */
2294 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2296 case USB_SPEED_FULL
: /* 8, 16, 32, or 64 */
2297 /* to determine the ep0 maxpacket size, try to read
2298 * the device descriptor to get bMaxPacketSize0 and
2299 * then correct our initial guess.
2301 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(64);
2303 case USB_SPEED_LOW
: /* fixed at 8 */
2304 udev
->ep0
.desc
.wMaxPacketSize
= __constant_cpu_to_le16(8);
2311 switch (udev
->speed
) {
2312 case USB_SPEED_LOW
: speed
= "low"; break;
2313 case USB_SPEED_FULL
: speed
= "full"; break;
2314 case USB_SPEED_HIGH
: speed
= "high"; break;
2315 case USB_SPEED_VARIABLE
:
2319 default: speed
= "?"; break;
2321 dev_info (&udev
->dev
,
2322 "%s %s speed %sUSB device using %s and address %d\n",
2323 (udev
->config
) ? "reset" : "new", speed
, type
,
2324 udev
->bus
->controller
->driver
->name
, devnum
);
2326 /* Set up TT records, if needed */
2328 udev
->tt
= hdev
->tt
;
2329 udev
->ttport
= hdev
->ttport
;
2330 } else if (udev
->speed
!= USB_SPEED_HIGH
2331 && hdev
->speed
== USB_SPEED_HIGH
) {
2332 udev
->tt
= &hub
->tt
;
2333 udev
->ttport
= port1
;
2336 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2337 * Because device hardware and firmware is sometimes buggy in
2338 * this area, and this is how Linux has done it for ages.
2339 * Change it cautiously.
2341 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2342 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2343 * so it may help with some non-standards-compliant devices.
2344 * Otherwise we start with SET_ADDRESS and then try to read the
2345 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2348 for (i
= 0; i
< GET_DESCRIPTOR_TRIES
; (++i
, msleep(100))) {
2349 if (USE_NEW_SCHEME(retry_counter
)) {
2350 struct usb_device_descriptor
*buf
;
2353 #define GET_DESCRIPTOR_BUFSIZE 64
2354 buf
= kmalloc(GET_DESCRIPTOR_BUFSIZE
, GFP_NOIO
);
2360 /* Retry on all errors; some devices are flakey.
2361 * 255 is for WUSB devices, we actually need to use
2362 * 512 (WUSB1.0[4.8.1]).
2364 for (j
= 0; j
< 3; ++j
) {
2365 buf
->bMaxPacketSize0
= 0;
2366 r
= usb_control_msg(udev
, usb_rcvaddr0pipe(),
2367 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
2368 USB_DT_DEVICE
<< 8, 0,
2369 buf
, GET_DESCRIPTOR_BUFSIZE
,
2370 USB_CTRL_GET_TIMEOUT
);
2371 switch (buf
->bMaxPacketSize0
) {
2372 case 8: case 16: case 32: case 64: case 255:
2373 if (buf
->bDescriptorType
==
2387 udev
->descriptor
.bMaxPacketSize0
=
2388 buf
->bMaxPacketSize0
;
2391 retval
= hub_port_reset(hub
, port1
, udev
, delay
);
2392 if (retval
< 0) /* error or disconnect */
2394 if (oldspeed
!= udev
->speed
) {
2396 "device reset changed speed!\n");
2401 dev_err(&udev
->dev
, "device descriptor "
2402 "read/%s, error %d\n",
2407 #undef GET_DESCRIPTOR_BUFSIZE
2410 for (j
= 0; j
< SET_ADDRESS_TRIES
; ++j
) {
2411 retval
= hub_set_address(udev
, devnum
);
2418 "device not accepting address %d, error %d\n",
2423 /* cope with hardware quirkiness:
2424 * - let SET_ADDRESS settle, some device hardware wants it
2425 * - read ep0 maxpacket even for high and low speed,
2428 if (USE_NEW_SCHEME(retry_counter
))
2431 retval
= usb_get_device_descriptor(udev
, 8);
2433 dev_err(&udev
->dev
, "device descriptor "
2434 "read/%s, error %d\n",
2446 i
= udev
->descriptor
.bMaxPacketSize0
== 0xff?
2447 512 : udev
->descriptor
.bMaxPacketSize0
;
2448 if (le16_to_cpu(udev
->ep0
.desc
.wMaxPacketSize
) != i
) {
2449 if (udev
->speed
!= USB_SPEED_FULL
||
2450 !(i
== 8 || i
== 16 || i
== 32 || i
== 64)) {
2451 dev_err(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2455 dev_dbg(&udev
->dev
, "ep0 maxpacket = %d\n", i
);
2456 udev
->ep0
.desc
.wMaxPacketSize
= cpu_to_le16(i
);
2460 retval
= usb_get_device_descriptor(udev
, USB_DT_DEVICE_SIZE
);
2461 if (retval
< (signed)sizeof(udev
->descriptor
)) {
2462 dev_err(&udev
->dev
, "device descriptor read/%s, error %d\n",
2473 hub_port_disable(hub
, port1
, 0);
2474 udev
->devnum
= devnum
; /* for disconnect processing */
2476 mutex_unlock(&usb_address0_mutex
);
2481 check_highspeed (struct usb_hub
*hub
, struct usb_device
*udev
, int port1
)
2483 struct usb_qualifier_descriptor
*qual
;
2486 qual
= kmalloc (sizeof *qual
, GFP_KERNEL
);
2490 status
= usb_get_descriptor (udev
, USB_DT_DEVICE_QUALIFIER
, 0,
2491 qual
, sizeof *qual
);
2492 if (status
== sizeof *qual
) {
2493 dev_info(&udev
->dev
, "not running at top speed; "
2494 "connect to a high speed hub\n");
2495 /* hub LEDs are probably harder to miss than syslog */
2496 if (hub
->has_indicators
) {
2497 hub
->indicator
[port1
-1] = INDICATOR_GREEN_BLINK
;
2498 schedule_delayed_work (&hub
->leds
, 0);
2505 hub_power_remaining (struct usb_hub
*hub
)
2507 struct usb_device
*hdev
= hub
->hdev
;
2511 if (!hub
->limited_power
)
2514 remaining
= hdev
->bus_mA
- hub
->descriptor
->bHubContrCurrent
;
2515 for (port1
= 1; port1
<= hdev
->maxchild
; ++port1
) {
2516 struct usb_device
*udev
= hdev
->children
[port1
- 1];
2522 /* Unconfigured devices may not use more than 100mA,
2523 * or 8mA for OTG ports */
2524 if (udev
->actconfig
)
2525 delta
= udev
->actconfig
->desc
.bMaxPower
* 2;
2526 else if (port1
!= udev
->bus
->otg_port
|| hdev
->parent
)
2530 if (delta
> hub
->mA_per_port
)
2531 dev_warn(&udev
->dev
, "%dmA is over %umA budget "
2533 delta
, hub
->mA_per_port
, port1
);
2536 if (remaining
< 0) {
2537 dev_warn(hub
->intfdev
, "%dmA over power budget!\n",
2544 /* Handle physical or logical connection change events.
2545 * This routine is called when:
2546 * a port connection-change occurs;
2547 * a port enable-change occurs (often caused by EMI);
2548 * usb_reset_device() encounters changed descriptors (as from
2549 * a firmware download)
2550 * caller already locked the hub
2552 static void hub_port_connect_change(struct usb_hub
*hub
, int port1
,
2553 u16 portstatus
, u16 portchange
)
2555 struct usb_device
*hdev
= hub
->hdev
;
2556 struct device
*hub_dev
= hub
->intfdev
;
2557 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
2558 u16 wHubCharacteristics
= le16_to_cpu(hub
->descriptor
->wHubCharacteristics
);
2562 "port %d, status %04x, change %04x, %s\n",
2563 port1
, portstatus
, portchange
, portspeed (portstatus
));
2565 if (hub
->has_indicators
) {
2566 set_port_led(hub
, port1
, HUB_LED_AUTO
);
2567 hub
->indicator
[port1
-1] = INDICATOR_AUTO
;
2570 /* Disconnect any existing devices under this port */
2571 if (hdev
->children
[port1
-1])
2572 usb_disconnect(&hdev
->children
[port1
-1]);
2573 clear_bit(port1
, hub
->change_bits
);
2575 #ifdef CONFIG_USB_OTG
2576 /* during HNP, don't repeat the debounce */
2577 if (hdev
->bus
->is_b_host
)
2578 portchange
&= ~USB_PORT_STAT_C_CONNECTION
;
2581 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2582 status
= hub_port_debounce(hub
, port1
);
2584 if (printk_ratelimit())
2585 dev_err (hub_dev
, "connect-debounce failed, "
2586 "port %d disabled\n", port1
);
2589 portstatus
= status
;
2592 /* Return now if nothing is connected */
2593 if (!(portstatus
& USB_PORT_STAT_CONNECTION
)) {
2595 /* maybe switch power back on (e.g. root hub was reset) */
2596 if ((wHubCharacteristics
& HUB_CHAR_LPSM
) < 2
2597 && !(portstatus
& (1 << USB_PORT_FEAT_POWER
)))
2598 set_port_feature(hdev
, port1
, USB_PORT_FEAT_POWER
);
2600 if (portstatus
& USB_PORT_STAT_ENABLE
)
2605 for (i
= 0; i
< SET_CONFIG_TRIES
; i
++) {
2606 struct usb_device
*udev
;
2608 /* reallocate for each attempt, since references
2609 * to the previous one can escape in various ways
2611 udev
= usb_alloc_dev(hdev
, hdev
->bus
, port1
);
2614 "couldn't allocate port %d usb_device\n",
2619 usb_set_device_state(udev
, USB_STATE_POWERED
);
2620 udev
->speed
= USB_SPEED_UNKNOWN
;
2621 udev
->bus_mA
= hub
->mA_per_port
;
2622 udev
->level
= hdev
->level
+ 1;
2624 /* set the address */
2625 choose_address(udev
);
2626 if (udev
->devnum
<= 0) {
2627 status
= -ENOTCONN
; /* Don't retry */
2631 /* reset and get descriptor */
2632 status
= hub_port_init(hub
, udev
, port1
, i
);
2636 /* consecutive bus-powered hubs aren't reliable; they can
2637 * violate the voltage drop budget. if the new child has
2638 * a "powered" LED, users should notice we didn't enable it
2639 * (without reading syslog), even without per-port LEDs
2642 if (udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
2643 && udev
->bus_mA
<= 100) {
2646 status
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0,
2649 dev_dbg(&udev
->dev
, "get status %d ?\n", status
);
2652 le16_to_cpus(&devstat
);
2653 if ((devstat
& (1 << USB_DEVICE_SELF_POWERED
)) == 0) {
2655 "can't connect bus-powered hub "
2657 if (hub
->has_indicators
) {
2658 hub
->indicator
[port1
-1] =
2659 INDICATOR_AMBER_BLINK
;
2660 schedule_delayed_work (&hub
->leds
, 0);
2662 status
= -ENOTCONN
; /* Don't retry */
2667 /* check for devices running slower than they could */
2668 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0200
2669 && udev
->speed
== USB_SPEED_FULL
2670 && highspeed_hubs
!= 0)
2671 check_highspeed (hub
, udev
, port1
);
2673 /* Store the parent's children[] pointer. At this point
2674 * udev becomes globally accessible, although presumably
2675 * no one will look at it until hdev is unlocked.
2679 /* We mustn't add new devices if the parent hub has
2680 * been disconnected; we would race with the
2681 * recursively_mark_NOTATTACHED() routine.
2683 spin_lock_irq(&device_state_lock
);
2684 if (hdev
->state
== USB_STATE_NOTATTACHED
)
2687 hdev
->children
[port1
-1] = udev
;
2688 spin_unlock_irq(&device_state_lock
);
2690 /* Run it through the hoops (find a driver, etc) */
2692 status
= usb_new_device(udev
);
2694 spin_lock_irq(&device_state_lock
);
2695 hdev
->children
[port1
-1] = NULL
;
2696 spin_unlock_irq(&device_state_lock
);
2703 status
= hub_power_remaining(hub
);
2705 dev_dbg(hub_dev
, "%dmA power budget left\n", status
);
2710 hub_port_disable(hub
, port1
, 1);
2713 release_address(udev
);
2715 if ((status
== -ENOTCONN
) || (status
== -ENOTSUPP
))
2720 hub_port_disable(hub
, port1
, 1);
2721 if (hcd
->driver
->relinquish_port
&& !hub
->hdev
->parent
)
2722 hcd
->driver
->relinquish_port(hcd
, port1
);
2725 static void hub_events(void)
2727 struct list_head
*tmp
;
2728 struct usb_device
*hdev
;
2729 struct usb_interface
*intf
;
2730 struct usb_hub
*hub
;
2731 struct device
*hub_dev
;
2740 * We restart the list every time to avoid a deadlock with
2741 * deleting hubs downstream from this one. This should be
2742 * safe since we delete the hub from the event list.
2743 * Not the most efficient, but avoids deadlocks.
2747 /* Grab the first entry at the beginning of the list */
2748 spin_lock_irq(&hub_event_lock
);
2749 if (list_empty(&hub_event_list
)) {
2750 spin_unlock_irq(&hub_event_lock
);
2754 tmp
= hub_event_list
.next
;
2757 hub
= list_entry(tmp
, struct usb_hub
, event_list
);
2758 kref_get(&hub
->kref
);
2759 spin_unlock_irq(&hub_event_lock
);
2762 hub_dev
= hub
->intfdev
;
2763 intf
= to_usb_interface(hub_dev
);
2764 dev_dbg(hub_dev
, "state %d ports %d chg %04x evt %04x\n",
2765 hdev
->state
, hub
->descriptor
2766 ? hub
->descriptor
->bNbrPorts
2768 /* NOTE: expects max 15 ports... */
2769 (u16
) hub
->change_bits
[0],
2770 (u16
) hub
->event_bits
[0]);
2772 /* Lock the device, then check to see if we were
2773 * disconnected while waiting for the lock to succeed. */
2774 usb_lock_device(hdev
);
2775 if (unlikely(hub
->disconnected
))
2778 /* If the hub has died, clean up after it */
2779 if (hdev
->state
== USB_STATE_NOTATTACHED
) {
2780 hub
->error
= -ENODEV
;
2786 ret
= usb_autopm_get_interface(intf
);
2788 dev_dbg(hub_dev
, "Can't autoresume: %d\n", ret
);
2792 /* If this is an inactive hub, do nothing */
2797 dev_dbg (hub_dev
, "resetting for error %d\n",
2800 ret
= usb_reset_composite_device(hdev
, intf
);
2803 "error resetting hub: %d\n", ret
);
2811 /* deal with port status changes */
2812 for (i
= 1; i
<= hub
->descriptor
->bNbrPorts
; i
++) {
2813 if (test_bit(i
, hub
->busy_bits
))
2815 connect_change
= test_bit(i
, hub
->change_bits
);
2816 if (!test_and_clear_bit(i
, hub
->event_bits
) &&
2817 !connect_change
&& !hub
->activating
)
2820 ret
= hub_port_status(hub
, i
,
2821 &portstatus
, &portchange
);
2825 if (hub
->activating
&& !hdev
->children
[i
-1] &&
2827 USB_PORT_STAT_CONNECTION
))
2830 if (portchange
& USB_PORT_STAT_C_CONNECTION
) {
2831 clear_port_feature(hdev
, i
,
2832 USB_PORT_FEAT_C_CONNECTION
);
2836 if (portchange
& USB_PORT_STAT_C_ENABLE
) {
2837 if (!connect_change
)
2839 "port %d enable change, "
2842 clear_port_feature(hdev
, i
,
2843 USB_PORT_FEAT_C_ENABLE
);
2846 * EM interference sometimes causes badly
2847 * shielded USB devices to be shutdown by
2848 * the hub, this hack enables them again.
2849 * Works at least with mouse driver.
2851 if (!(portstatus
& USB_PORT_STAT_ENABLE
)
2853 && hdev
->children
[i
-1]) {
2856 "disabled by hub (EMI?), "
2863 if (portchange
& USB_PORT_STAT_C_SUSPEND
) {
2864 clear_port_feature(hdev
, i
,
2865 USB_PORT_FEAT_C_SUSPEND
);
2866 if (hdev
->children
[i
-1]) {
2867 ret
= remote_wakeup(hdev
->
2873 hub_port_disable(hub
, i
, 1);
2876 "resume on port %d, status %d\n",
2880 if (portchange
& USB_PORT_STAT_C_OVERCURRENT
) {
2882 "over-current change on port %d\n",
2884 clear_port_feature(hdev
, i
,
2885 USB_PORT_FEAT_C_OVER_CURRENT
);
2889 if (portchange
& USB_PORT_STAT_C_RESET
) {
2891 "reset change on port %d\n",
2893 clear_port_feature(hdev
, i
,
2894 USB_PORT_FEAT_C_RESET
);
2898 hub_port_connect_change(hub
, i
,
2899 portstatus
, portchange
);
2902 /* deal with hub status changes */
2903 if (test_and_clear_bit(0, hub
->event_bits
) == 0)
2905 else if (hub_hub_status(hub
, &hubstatus
, &hubchange
) < 0)
2906 dev_err (hub_dev
, "get_hub_status failed\n");
2908 if (hubchange
& HUB_CHANGE_LOCAL_POWER
) {
2909 dev_dbg (hub_dev
, "power change\n");
2910 clear_hub_feature(hdev
, C_HUB_LOCAL_POWER
);
2911 if (hubstatus
& HUB_STATUS_LOCAL_POWER
)
2912 /* FIXME: Is this always true? */
2913 hub
->limited_power
= 1;
2915 hub
->limited_power
= 0;
2917 if (hubchange
& HUB_CHANGE_OVERCURRENT
) {
2918 dev_dbg (hub_dev
, "overcurrent change\n");
2919 msleep(500); /* Cool down */
2920 clear_hub_feature(hdev
, C_HUB_OVER_CURRENT
);
2925 hub
->activating
= 0;
2927 /* If this is a root hub, tell the HCD it's okay to
2928 * re-enable port-change interrupts now. */
2929 if (!hdev
->parent
&& !hub
->busy_bits
[0])
2930 usb_enable_root_hub_irq(hdev
->bus
);
2933 /* Allow autosuspend if we're not going to run again */
2934 if (list_empty(&hub
->event_list
))
2935 usb_autopm_enable(intf
);
2937 usb_unlock_device(hdev
);
2938 kref_put(&hub
->kref
, hub_release
);
2940 } /* end while (1) */
2943 static int hub_thread(void *__unused
)
2945 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
2946 * port handover. Otherwise it might see that a full-speed device
2947 * was gone before the EHCI controller had handed its port over to
2948 * the companion full-speed controller.
2954 wait_event_freezable(khubd_wait
,
2955 !list_empty(&hub_event_list
) ||
2956 kthread_should_stop());
2957 } while (!kthread_should_stop() || !list_empty(&hub_event_list
));
2959 pr_debug("%s: khubd exiting\n", usbcore_name
);
2963 static struct usb_device_id hub_id_table
[] = {
2964 { .match_flags
= USB_DEVICE_ID_MATCH_DEV_CLASS
,
2965 .bDeviceClass
= USB_CLASS_HUB
},
2966 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
2967 .bInterfaceClass
= USB_CLASS_HUB
},
2968 { } /* Terminating entry */
2971 MODULE_DEVICE_TABLE (usb
, hub_id_table
);
2973 static struct usb_driver hub_driver
= {
2976 .disconnect
= hub_disconnect
,
2977 .suspend
= hub_suspend
,
2978 .resume
= hub_resume
,
2979 .reset_resume
= hub_reset_resume
,
2980 .pre_reset
= hub_pre_reset
,
2981 .post_reset
= hub_post_reset
,
2983 .id_table
= hub_id_table
,
2984 .supports_autosuspend
= 1,
2987 int usb_hub_init(void)
2989 if (usb_register(&hub_driver
) < 0) {
2990 printk(KERN_ERR
"%s: can't register hub driver\n",
2995 khubd_task
= kthread_run(hub_thread
, NULL
, "khubd");
2996 if (!IS_ERR(khubd_task
))
2999 /* Fall through if kernel_thread failed */
3000 usb_deregister(&hub_driver
);
3001 printk(KERN_ERR
"%s: can't start khubd\n", usbcore_name
);
3006 void usb_hub_cleanup(void)
3008 kthread_stop(khubd_task
);
3011 * Hub resources are freed for us by usb_deregister. It calls
3012 * usb_driver_purge on every device which in turn calls that
3013 * devices disconnect function if it is using this driver.
3014 * The hub_disconnect function takes care of releasing the
3015 * individual hub resources. -greg
3017 usb_deregister(&hub_driver
);
3018 } /* usb_hub_cleanup() */
3020 static int config_descriptors_changed(struct usb_device
*udev
)
3024 struct usb_config_descriptor
*buf
;
3026 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3027 if (len
< le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
))
3028 len
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3030 buf
= kmalloc(len
, GFP_NOIO
);
3032 dev_err(&udev
->dev
, "no mem to re-read configs after reset\n");
3033 /* assume the worst */
3036 for (index
= 0; index
< udev
->descriptor
.bNumConfigurations
; index
++) {
3038 int old_length
= le16_to_cpu(udev
->config
[index
].desc
.wTotalLength
);
3040 length
= usb_get_descriptor(udev
, USB_DT_CONFIG
, index
, buf
,
3042 if (length
< old_length
) {
3043 dev_dbg(&udev
->dev
, "config index %d, error %d\n",
3047 if (memcmp (buf
, udev
->rawdescriptors
[index
], old_length
)
3049 dev_dbg(&udev
->dev
, "config index %d changed (#%d)\n",
3050 index
, buf
->bConfigurationValue
);
3055 return index
!= udev
->descriptor
.bNumConfigurations
;
3059 * usb_reset_device - perform a USB port reset to reinitialize a device
3060 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3062 * WARNING - don't use this routine to reset a composite device
3063 * (one with multiple interfaces owned by separate drivers)!
3064 * Use usb_reset_composite_device() instead.
3066 * Do a port reset, reassign the device's address, and establish its
3067 * former operating configuration. If the reset fails, or the device's
3068 * descriptors change from their values before the reset, or the original
3069 * configuration and altsettings cannot be restored, a flag will be set
3070 * telling khubd to pretend the device has been disconnected and then
3071 * re-connected. All drivers will be unbound, and the device will be
3072 * re-enumerated and probed all over again.
3074 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3075 * flagged for logical disconnection, or some other negative error code
3076 * if the reset wasn't even attempted.
3078 * The caller must own the device lock. For example, it's safe to use
3079 * this from a driver probe() routine after downloading new firmware.
3080 * For calls that might not occur during probe(), drivers should lock
3081 * the device using usb_lock_device_for_reset().
3083 * Locking exception: This routine may also be called from within an
3084 * autoresume handler. Such usage won't conflict with other tasks
3085 * holding the device lock because these tasks should always call
3086 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3088 int usb_reset_device(struct usb_device
*udev
)
3090 struct usb_device
*parent_hdev
= udev
->parent
;
3091 struct usb_hub
*parent_hub
;
3092 struct usb_device_descriptor descriptor
= udev
->descriptor
;
3094 int port1
= udev
->portnum
;
3096 if (udev
->state
== USB_STATE_NOTATTACHED
||
3097 udev
->state
== USB_STATE_SUSPENDED
) {
3098 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3104 /* this requires hcd-specific logic; see OHCI hc_restart() */
3105 dev_dbg(&udev
->dev
, "%s for root hub!\n", __FUNCTION__
);
3108 parent_hub
= hdev_to_hub(parent_hdev
);
3110 set_bit(port1
, parent_hub
->busy_bits
);
3111 for (i
= 0; i
< SET_CONFIG_TRIES
; ++i
) {
3113 /* ep0 maxpacket size may change; let the HCD know about it.
3114 * Other endpoints will be handled by re-enumeration. */
3116 ret
= hub_port_init(parent_hub
, udev
, port1
, i
);
3117 if (ret
>= 0 || ret
== -ENOTCONN
|| ret
== -ENODEV
)
3120 clear_bit(port1
, parent_hub
->busy_bits
);
3121 if (!parent_hdev
->parent
&& !parent_hub
->busy_bits
[0])
3122 usb_enable_root_hub_irq(parent_hdev
->bus
);
3127 /* Device might have changed firmware (DFU or similar) */
3128 if (memcmp(&udev
->descriptor
, &descriptor
, sizeof descriptor
)
3129 || config_descriptors_changed (udev
)) {
3130 dev_info(&udev
->dev
, "device firmware changed\n");
3131 udev
->descriptor
= descriptor
; /* for disconnect() calls */
3135 if (!udev
->actconfig
)
3138 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
3139 USB_REQ_SET_CONFIGURATION
, 0,
3140 udev
->actconfig
->desc
.bConfigurationValue
, 0,
3141 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
3144 "can't restore configuration #%d (error=%d)\n",
3145 udev
->actconfig
->desc
.bConfigurationValue
, ret
);
3148 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
3150 for (i
= 0; i
< udev
->actconfig
->desc
.bNumInterfaces
; i
++) {
3151 struct usb_interface
*intf
= udev
->actconfig
->interface
[i
];
3152 struct usb_interface_descriptor
*desc
;
3154 /* set_interface resets host side toggle even
3155 * for altsetting zero. the interface may have no driver.
3157 desc
= &intf
->cur_altsetting
->desc
;
3158 ret
= usb_set_interface(udev
, desc
->bInterfaceNumber
,
3159 desc
->bAlternateSetting
);
3161 dev_err(&udev
->dev
, "failed to restore interface %d "
3162 "altsetting %d (error=%d)\n",
3163 desc
->bInterfaceNumber
,
3164 desc
->bAlternateSetting
,
3174 hub_port_logical_disconnect(parent_hub
, port1
);
3177 EXPORT_SYMBOL_GPL(usb_reset_device
);
3180 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3181 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3182 * @iface: interface bound to the driver making the request (optional)
3184 * Warns all drivers bound to registered interfaces (using their pre_reset
3185 * method), performs the port reset, and then lets the drivers know that
3186 * the reset is over (using their post_reset method).
3188 * Return value is the same as for usb_reset_device().
3190 * The caller must own the device lock. For example, it's safe to use
3191 * this from a driver probe() routine after downloading new firmware.
3192 * For calls that might not occur during probe(), drivers should lock
3193 * the device using usb_lock_device_for_reset().
3195 int usb_reset_composite_device(struct usb_device
*udev
,
3196 struct usb_interface
*iface
)
3200 struct usb_host_config
*config
= udev
->actconfig
;
3202 if (udev
->state
== USB_STATE_NOTATTACHED
||
3203 udev
->state
== USB_STATE_SUSPENDED
) {
3204 dev_dbg(&udev
->dev
, "device reset not allowed in state %d\n",
3209 /* Prevent autosuspend during the reset */
3210 usb_autoresume_device(udev
);
3212 if (iface
&& iface
->condition
!= USB_INTERFACE_BINDING
)
3216 for (i
= 0; i
< config
->desc
.bNumInterfaces
; ++i
) {
3217 struct usb_interface
*cintf
= config
->interface
[i
];
3218 struct usb_driver
*drv
;
3220 if (cintf
->dev
.driver
) {
3221 drv
= to_usb_driver(cintf
->dev
.driver
);
3223 (drv
->pre_reset
)(cintf
);
3224 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
3229 ret
= usb_reset_device(udev
);
3232 for (i
= config
->desc
.bNumInterfaces
- 1; i
>= 0; --i
) {
3233 struct usb_interface
*cintf
= config
->interface
[i
];
3234 struct usb_driver
*drv
;
3236 if (cintf
->dev
.driver
) {
3237 drv
= to_usb_driver(cintf
->dev
.driver
);
3238 if (drv
->post_reset
)
3239 (drv
->post_reset
)(cintf
);
3240 /* FIXME: Unbind if post_reset returns an error or isn't defined */
3245 usb_autosuspend_device(udev
);
3248 EXPORT_SYMBOL_GPL(usb_reset_composite_device
);