usb: dwc3: keystone: drop dma_mask configuration
[linux/fpc-iii.git] / drivers / usb / host / ehci-hub.c
blobf82bc5cded08574056810db070a080dc9d1009b7
1 /*
2 * Copyright (C) 2001-2004 by David Brownell
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 /* this file is part of ehci-hcd.c */
21 /*-------------------------------------------------------------------------*/
24 * EHCI Root Hub ... the nonsharable stuff
26 * Registers don't need cpu_to_le32, that happens transparently
29 /*-------------------------------------------------------------------------*/
30 #include <linux/usb/otg.h>
32 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
34 #ifdef CONFIG_PM
36 static int persist_enabled_on_companion(struct usb_device *udev, void *unused)
38 return !udev->maxchild && udev->persist_enabled &&
39 udev->bus->root_hub->speed < USB_SPEED_HIGH;
42 /* After a power loss, ports that were owned by the companion must be
43 * reset so that the companion can still own them.
45 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
47 u32 __iomem *reg;
48 u32 status;
49 int port;
50 __le32 buf;
51 struct usb_hcd *hcd = ehci_to_hcd(ehci);
53 if (!ehci->owned_ports)
54 return;
57 * USB 1.1 devices are mostly HIDs, which don't need to persist across
58 * suspends. If we ensure that none of our companion's devices have
59 * persist_enabled (by looking through all USB 1.1 buses in the system),
60 * we can skip this and avoid slowing resume down. Devices without
61 * persist will just get reenumerated shortly after resume anyway.
63 if (!usb_for_each_dev(NULL, persist_enabled_on_companion))
64 return;
66 /* Make sure the ports are powered */
67 port = HCS_N_PORTS(ehci->hcs_params);
68 while (port--) {
69 if (test_bit(port, &ehci->owned_ports)) {
70 reg = &ehci->regs->port_status[port];
71 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
72 if (!(status & PORT_POWER)) {
73 status |= PORT_POWER;
74 ehci_writel(ehci, status, reg);
79 /* Give the connections some time to appear */
80 msleep(20);
82 spin_lock_irq(&ehci->lock);
83 port = HCS_N_PORTS(ehci->hcs_params);
84 while (port--) {
85 if (test_bit(port, &ehci->owned_ports)) {
86 reg = &ehci->regs->port_status[port];
87 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
89 /* Port already owned by companion? */
90 if (status & PORT_OWNER)
91 clear_bit(port, &ehci->owned_ports);
92 else if (test_bit(port, &ehci->companion_ports))
93 ehci_writel(ehci, status & ~PORT_PE, reg);
94 else {
95 spin_unlock_irq(&ehci->lock);
96 ehci_hub_control(hcd, SetPortFeature,
97 USB_PORT_FEAT_RESET, port + 1,
98 NULL, 0);
99 spin_lock_irq(&ehci->lock);
103 spin_unlock_irq(&ehci->lock);
105 if (!ehci->owned_ports)
106 return;
107 msleep(90); /* Wait for resets to complete */
109 spin_lock_irq(&ehci->lock);
110 port = HCS_N_PORTS(ehci->hcs_params);
111 while (port--) {
112 if (test_bit(port, &ehci->owned_ports)) {
113 spin_unlock_irq(&ehci->lock);
114 ehci_hub_control(hcd, GetPortStatus,
115 0, port + 1,
116 (char *) &buf, sizeof(buf));
117 spin_lock_irq(&ehci->lock);
119 /* The companion should now own the port,
120 * but if something went wrong the port must not
121 * remain enabled.
123 reg = &ehci->regs->port_status[port];
124 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
125 if (status & PORT_OWNER)
126 ehci_writel(ehci, status | PORT_CSC, reg);
127 else {
128 ehci_dbg(ehci, "failed handover port %d: %x\n",
129 port + 1, status);
130 ehci_writel(ehci, status & ~PORT_PE, reg);
135 ehci->owned_ports = 0;
136 spin_unlock_irq(&ehci->lock);
139 static int ehci_port_change(struct ehci_hcd *ehci)
141 int i = HCS_N_PORTS(ehci->hcs_params);
143 /* First check if the controller indicates a change event */
145 if (ehci_readl(ehci, &ehci->regs->status) & STS_PCD)
146 return 1;
149 * Not all controllers appear to update this while going from D3 to D0,
150 * so check the individual port status registers as well
153 while (i--)
154 if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
155 return 1;
157 return 0;
160 static void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
161 bool suspending, bool do_wakeup)
163 int port;
164 u32 temp;
166 /* If remote wakeup is enabled for the root hub but disabled
167 * for the controller, we must adjust all the port wakeup flags
168 * when the controller is suspended or resumed. In all other
169 * cases they don't need to be changed.
171 if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
172 return;
174 spin_lock_irq(&ehci->lock);
176 /* clear phy low-power mode before changing wakeup flags */
177 if (ehci->has_tdi_phy_lpm) {
178 port = HCS_N_PORTS(ehci->hcs_params);
179 while (port--) {
180 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
182 temp = ehci_readl(ehci, hostpc_reg);
183 ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
185 spin_unlock_irq(&ehci->lock);
186 msleep(5);
187 spin_lock_irq(&ehci->lock);
190 port = HCS_N_PORTS(ehci->hcs_params);
191 while (port--) {
192 u32 __iomem *reg = &ehci->regs->port_status[port];
193 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
194 u32 t2 = t1 & ~PORT_WAKE_BITS;
196 /* If we are suspending the controller, clear the flags.
197 * If we are resuming the controller, set the wakeup flags.
199 if (!suspending) {
200 if (t1 & PORT_CONNECT)
201 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
202 else
203 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
205 ehci_writel(ehci, t2, reg);
208 /* enter phy low-power mode again */
209 if (ehci->has_tdi_phy_lpm) {
210 port = HCS_N_PORTS(ehci->hcs_params);
211 while (port--) {
212 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
214 temp = ehci_readl(ehci, hostpc_reg);
215 ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
219 /* Does the root hub have a port wakeup pending? */
220 if (!suspending && ehci_port_change(ehci))
221 usb_hcd_resume_root_hub(ehci_to_hcd(ehci));
223 spin_unlock_irq(&ehci->lock);
226 static int ehci_bus_suspend (struct usb_hcd *hcd)
228 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
229 int port;
230 int mask;
231 int changed;
232 bool fs_idle_delay;
234 ehci_dbg(ehci, "suspend root hub\n");
236 if (time_before (jiffies, ehci->next_statechange))
237 msleep(5);
239 /* stop the schedules */
240 ehci_quiesce(ehci);
242 spin_lock_irq (&ehci->lock);
243 if (ehci->rh_state < EHCI_RH_RUNNING)
244 goto done;
246 /* Once the controller is stopped, port resumes that are already
247 * in progress won't complete. Hence if remote wakeup is enabled
248 * for the root hub and any ports are in the middle of a resume or
249 * remote wakeup, we must fail the suspend.
251 if (hcd->self.root_hub->do_remote_wakeup) {
252 if (ehci->resuming_ports) {
253 spin_unlock_irq(&ehci->lock);
254 ehci_dbg(ehci, "suspend failed because a port is resuming\n");
255 return -EBUSY;
259 /* Unlike other USB host controller types, EHCI doesn't have
260 * any notion of "global" or bus-wide suspend. The driver has
261 * to manually suspend all the active unsuspended ports, and
262 * then manually resume them in the bus_resume() routine.
264 ehci->bus_suspended = 0;
265 ehci->owned_ports = 0;
266 changed = 0;
267 fs_idle_delay = false;
268 port = HCS_N_PORTS(ehci->hcs_params);
269 while (port--) {
270 u32 __iomem *reg = &ehci->regs->port_status [port];
271 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
272 u32 t2 = t1 & ~PORT_WAKE_BITS;
274 /* keep track of which ports we suspend */
275 if (t1 & PORT_OWNER)
276 set_bit(port, &ehci->owned_ports);
277 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
278 t2 |= PORT_SUSPEND;
279 set_bit(port, &ehci->bus_suspended);
282 /* enable remote wakeup on all ports, if told to do so */
283 if (hcd->self.root_hub->do_remote_wakeup) {
284 /* only enable appropriate wake bits, otherwise the
285 * hardware can not go phy low power mode. If a race
286 * condition happens here(connection change during bits
287 * set), the port change detection will finally fix it.
289 if (t1 & PORT_CONNECT)
290 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
291 else
292 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
295 if (t1 != t2) {
297 * On some controllers, Wake-On-Disconnect will
298 * generate false wakeup signals until the bus
299 * switches over to full-speed idle. For their
300 * sake, add a delay if we need one.
302 if ((t2 & PORT_WKDISC_E) &&
303 ehci_port_speed(ehci, t2) ==
304 USB_PORT_STAT_HIGH_SPEED)
305 fs_idle_delay = true;
306 ehci_writel(ehci, t2, reg);
307 changed = 1;
310 spin_unlock_irq(&ehci->lock);
312 if ((changed && ehci->has_tdi_phy_lpm) || fs_idle_delay) {
314 * Wait for HCD to enter low-power mode or for the bus
315 * to switch to full-speed idle.
317 usleep_range(5000, 5500);
320 if (changed && ehci->has_tdi_phy_lpm) {
321 spin_lock_irq(&ehci->lock);
322 port = HCS_N_PORTS(ehci->hcs_params);
323 while (port--) {
324 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[port];
325 u32 t3;
327 t3 = ehci_readl(ehci, hostpc_reg);
328 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
329 t3 = ehci_readl(ehci, hostpc_reg);
330 ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
331 port, (t3 & HOSTPC_PHCD) ?
332 "succeeded" : "failed");
334 spin_unlock_irq(&ehci->lock);
337 /* Apparently some devices need a >= 1-uframe delay here */
338 if (ehci->bus_suspended)
339 udelay(150);
341 /* turn off now-idle HC */
342 ehci_halt (ehci);
344 spin_lock_irq(&ehci->lock);
345 if (ehci->enabled_hrtimer_events & BIT(EHCI_HRTIMER_POLL_DEAD))
346 ehci_handle_controller_death(ehci);
347 if (ehci->rh_state != EHCI_RH_RUNNING)
348 goto done;
349 ehci->rh_state = EHCI_RH_SUSPENDED;
351 end_unlink_async(ehci);
352 unlink_empty_async_suspended(ehci);
353 ehci_handle_start_intr_unlinks(ehci);
354 ehci_handle_intr_unlinks(ehci);
355 end_free_itds(ehci);
357 /* allow remote wakeup */
358 mask = INTR_MASK;
359 if (!hcd->self.root_hub->do_remote_wakeup)
360 mask &= ~STS_PCD;
361 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
362 ehci_readl(ehci, &ehci->regs->intr_enable);
364 done:
365 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
366 ehci->enabled_hrtimer_events = 0;
367 ehci->next_hrtimer_event = EHCI_HRTIMER_NO_EVENT;
368 spin_unlock_irq (&ehci->lock);
370 hrtimer_cancel(&ehci->hrtimer);
371 return 0;
375 /* caller has locked the root hub, and should reset/reinit on error */
376 static int ehci_bus_resume (struct usb_hcd *hcd)
378 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
379 u32 temp;
380 u32 power_okay;
381 int i;
382 unsigned long resume_needed = 0;
384 if (time_before (jiffies, ehci->next_statechange))
385 msleep(5);
386 spin_lock_irq (&ehci->lock);
387 if (!HCD_HW_ACCESSIBLE(hcd) || ehci->shutdown)
388 goto shutdown;
390 if (unlikely(ehci->debug)) {
391 if (!dbgp_reset_prep(hcd))
392 ehci->debug = NULL;
393 else
394 dbgp_external_startup(hcd);
397 /* Ideally and we've got a real resume here, and no port's power
398 * was lost. (For PCI, that means Vaux was maintained.) But we
399 * could instead be restoring a swsusp snapshot -- so that BIOS was
400 * the last user of the controller, not reset/pm hardware keeping
401 * state we gave to it.
403 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
404 ehci_dbg(ehci, "resume root hub%s\n",
405 power_okay ? "" : " after power loss");
407 /* at least some APM implementations will try to deliver
408 * IRQs right away, so delay them until we're ready.
410 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
412 /* re-init operational registers */
413 ehci_writel(ehci, 0, &ehci->regs->segment);
414 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
415 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
417 /* restore CMD_RUN, framelist size, and irq threshold */
418 ehci->command |= CMD_RUN;
419 ehci_writel(ehci, ehci->command, &ehci->regs->command);
420 ehci->rh_state = EHCI_RH_RUNNING;
423 * According to Bugzilla #8190, the port status for some controllers
424 * will be wrong without a delay. At their wrong status, the port
425 * is enabled, but not suspended neither resumed.
427 i = HCS_N_PORTS(ehci->hcs_params);
428 while (i--) {
429 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
430 if ((temp & PORT_PE) &&
431 !(temp & (PORT_SUSPEND | PORT_RESUME))) {
432 ehci_dbg(ehci, "Port status(0x%x) is wrong\n", temp);
433 spin_unlock_irq(&ehci->lock);
434 msleep(8);
435 spin_lock_irq(&ehci->lock);
436 break;
440 if (ehci->shutdown)
441 goto shutdown;
443 /* clear phy low-power mode before resume */
444 if (ehci->bus_suspended && ehci->has_tdi_phy_lpm) {
445 i = HCS_N_PORTS(ehci->hcs_params);
446 while (i--) {
447 if (test_bit(i, &ehci->bus_suspended)) {
448 u32 __iomem *hostpc_reg =
449 &ehci->regs->hostpc[i];
451 temp = ehci_readl(ehci, hostpc_reg);
452 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
453 hostpc_reg);
456 spin_unlock_irq(&ehci->lock);
457 msleep(5);
458 spin_lock_irq(&ehci->lock);
459 if (ehci->shutdown)
460 goto shutdown;
463 /* manually resume the ports we suspended during bus_suspend() */
464 i = HCS_N_PORTS (ehci->hcs_params);
465 while (i--) {
466 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
467 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
468 if (test_bit(i, &ehci->bus_suspended) &&
469 (temp & PORT_SUSPEND)) {
470 temp |= PORT_RESUME;
471 set_bit(i, &resume_needed);
473 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
477 * msleep for USB_RESUME_TIMEOUT ms only if code is trying to resume
478 * port
480 if (resume_needed) {
481 spin_unlock_irq(&ehci->lock);
482 msleep(USB_RESUME_TIMEOUT);
483 spin_lock_irq(&ehci->lock);
484 if (ehci->shutdown)
485 goto shutdown;
488 i = HCS_N_PORTS (ehci->hcs_params);
489 while (i--) {
490 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
491 if (test_bit(i, &resume_needed)) {
492 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
493 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
497 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
498 spin_unlock_irq(&ehci->lock);
500 ehci_handover_companion_ports(ehci);
502 /* Now we can safely re-enable irqs */
503 spin_lock_irq(&ehci->lock);
504 if (ehci->shutdown)
505 goto shutdown;
506 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
507 (void) ehci_readl(ehci, &ehci->regs->intr_enable);
508 spin_unlock_irq(&ehci->lock);
510 return 0;
512 shutdown:
513 spin_unlock_irq(&ehci->lock);
514 return -ESHUTDOWN;
517 #else
519 #define ehci_bus_suspend NULL
520 #define ehci_bus_resume NULL
522 #endif /* CONFIG_PM */
524 /*-------------------------------------------------------------------------*/
527 * Sets the owner of a port
529 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
531 u32 __iomem *status_reg;
532 u32 port_status;
533 int try;
535 status_reg = &ehci->regs->port_status[portnum];
538 * The controller won't set the OWNER bit if the port is
539 * enabled, so this loop will sometimes require at least two
540 * iterations: one to disable the port and one to set OWNER.
542 for (try = 4; try > 0; --try) {
543 spin_lock_irq(&ehci->lock);
544 port_status = ehci_readl(ehci, status_reg);
545 if ((port_status & PORT_OWNER) == new_owner
546 || (port_status & (PORT_OWNER | PORT_CONNECT))
547 == 0)
548 try = 0;
549 else {
550 port_status ^= PORT_OWNER;
551 port_status &= ~(PORT_PE | PORT_RWC_BITS);
552 ehci_writel(ehci, port_status, status_reg);
554 spin_unlock_irq(&ehci->lock);
555 if (try > 1)
556 msleep(5);
560 /*-------------------------------------------------------------------------*/
562 static int check_reset_complete (
563 struct ehci_hcd *ehci,
564 int index,
565 u32 __iomem *status_reg,
566 int port_status
568 if (!(port_status & PORT_CONNECT))
569 return port_status;
571 /* if reset finished and it's still not enabled -- handoff */
572 if (!(port_status & PORT_PE)) {
574 /* with integrated TT, there's nobody to hand it to! */
575 if (ehci_is_TDI(ehci)) {
576 ehci_dbg (ehci,
577 "Failed to enable port %d on root hub TT\n",
578 index+1);
579 return port_status;
582 ehci_dbg (ehci, "port %d full speed --> companion\n",
583 index + 1);
585 // what happens if HCS_N_CC(params) == 0 ?
586 port_status |= PORT_OWNER;
587 port_status &= ~PORT_RWC_BITS;
588 ehci_writel(ehci, port_status, status_reg);
590 /* ensure 440EPX ohci controller state is operational */
591 if (ehci->has_amcc_usb23)
592 set_ohci_hcfs(ehci, 1);
593 } else {
594 ehci_dbg(ehci, "port %d reset complete, port enabled\n",
595 index + 1);
596 /* ensure 440EPx ohci controller state is suspended */
597 if (ehci->has_amcc_usb23)
598 set_ohci_hcfs(ehci, 0);
601 return port_status;
604 /*-------------------------------------------------------------------------*/
607 /* build "status change" packet (one or two bytes) from HC registers */
609 static int
610 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
612 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
613 u32 temp, status;
614 u32 mask;
615 int ports, i, retval = 1;
616 unsigned long flags;
617 u32 ppcd = ~0;
619 /* init status to no-changes */
620 buf [0] = 0;
621 ports = HCS_N_PORTS (ehci->hcs_params);
622 if (ports > 7) {
623 buf [1] = 0;
624 retval++;
627 /* Inform the core about resumes-in-progress by returning
628 * a non-zero value even if there are no status changes.
630 status = ehci->resuming_ports;
632 /* Some boards (mostly VIA?) report bogus overcurrent indications,
633 * causing massive log spam unless we completely ignore them. It
634 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
635 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
636 * PORT_POWER; that's surprising, but maybe within-spec.
638 if (!ignore_oc)
639 mask = PORT_CSC | PORT_PEC | PORT_OCC;
640 else
641 mask = PORT_CSC | PORT_PEC;
642 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
644 /* no hub change reports (bit 0) for now (power, ...) */
646 /* port N changes (bit N)? */
647 spin_lock_irqsave (&ehci->lock, flags);
649 /* get per-port change detect bits */
650 if (ehci->has_ppcd)
651 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
653 for (i = 0; i < ports; i++) {
654 /* leverage per-port change bits feature */
655 if (ppcd & (1 << i))
656 temp = ehci_readl(ehci, &ehci->regs->port_status[i]);
657 else
658 temp = 0;
661 * Return status information even for ports with OWNER set.
662 * Otherwise khubd wouldn't see the disconnect event when a
663 * high-speed device is switched over to the companion
664 * controller by the user.
667 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
668 || (ehci->reset_done[i] && time_after_eq(
669 jiffies, ehci->reset_done[i]))) {
670 if (i < 7)
671 buf [0] |= 1 << (i + 1);
672 else
673 buf [1] |= 1 << (i - 7);
674 status = STS_PCD;
678 /* If a resume is in progress, make sure it can finish */
679 if (ehci->resuming_ports)
680 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(25));
682 spin_unlock_irqrestore (&ehci->lock, flags);
683 return status ? retval : 0;
686 /*-------------------------------------------------------------------------*/
688 static void
689 ehci_hub_descriptor (
690 struct ehci_hcd *ehci,
691 struct usb_hub_descriptor *desc
693 int ports = HCS_N_PORTS (ehci->hcs_params);
694 u16 temp;
696 desc->bDescriptorType = 0x29;
697 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
698 desc->bHubContrCurrent = 0;
700 desc->bNbrPorts = ports;
701 temp = 1 + (ports / 8);
702 desc->bDescLength = 7 + 2 * temp;
704 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
705 memset(&desc->u.hs.DeviceRemovable[0], 0, temp);
706 memset(&desc->u.hs.DeviceRemovable[temp], 0xff, temp);
708 temp = 0x0008; /* per-port overcurrent reporting */
709 if (HCS_PPC (ehci->hcs_params))
710 temp |= 0x0001; /* per-port power control */
711 else
712 temp |= 0x0002; /* no power switching */
713 #if 0
714 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
715 if (HCS_INDICATOR (ehci->hcs_params))
716 temp |= 0x0080; /* per-port indicators (LEDs) */
717 #endif
718 desc->wHubCharacteristics = cpu_to_le16(temp);
721 /*-------------------------------------------------------------------------*/
722 #ifdef CONFIG_USB_HCD_TEST_MODE
724 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
726 static void usb_ehset_completion(struct urb *urb)
728 struct completion *done = urb->context;
730 complete(done);
732 static int submit_single_step_set_feature(
733 struct usb_hcd *hcd,
734 struct urb *urb,
735 int is_setup
739 * Allocate and initialize a control URB. This request will be used by the
740 * EHSET SINGLE_STEP_SET_FEATURE test in which the DATA and STATUS stages
741 * of the GetDescriptor request are sent 15 seconds after the SETUP stage.
742 * Return NULL if failed.
744 static struct urb *request_single_step_set_feature_urb(
745 struct usb_device *udev,
746 void *dr,
747 void *buf,
748 struct completion *done
750 struct urb *urb;
751 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
752 struct usb_host_endpoint *ep;
754 urb = usb_alloc_urb(0, GFP_KERNEL);
755 if (!urb)
756 return NULL;
758 urb->pipe = usb_rcvctrlpipe(udev, 0);
759 ep = (usb_pipein(urb->pipe) ? udev->ep_in : udev->ep_out)
760 [usb_pipeendpoint(urb->pipe)];
761 if (!ep) {
762 usb_free_urb(urb);
763 return NULL;
766 urb->ep = ep;
767 urb->dev = udev;
768 urb->setup_packet = (void *)dr;
769 urb->transfer_buffer = buf;
770 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
771 urb->complete = usb_ehset_completion;
772 urb->status = -EINPROGRESS;
773 urb->actual_length = 0;
774 urb->transfer_flags = URB_DIR_IN;
775 usb_get_urb(urb);
776 atomic_inc(&urb->use_count);
777 atomic_inc(&urb->dev->urbnum);
778 urb->setup_dma = dma_map_single(
779 hcd->self.controller,
780 urb->setup_packet,
781 sizeof(struct usb_ctrlrequest),
782 DMA_TO_DEVICE);
783 urb->transfer_dma = dma_map_single(
784 hcd->self.controller,
785 urb->transfer_buffer,
786 urb->transfer_buffer_length,
787 DMA_FROM_DEVICE);
788 urb->context = done;
789 return urb;
792 static int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
794 int retval = -ENOMEM;
795 struct usb_ctrlrequest *dr;
796 struct urb *urb;
797 struct usb_device *udev;
798 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
799 struct usb_device_descriptor *buf;
800 DECLARE_COMPLETION_ONSTACK(done);
802 /* Obtain udev of the rhub's child port */
803 udev = usb_hub_find_child(hcd->self.root_hub, port);
804 if (!udev) {
805 ehci_err(ehci, "No device attached to the RootHub\n");
806 return -ENODEV;
808 buf = kmalloc(USB_DT_DEVICE_SIZE, GFP_KERNEL);
809 if (!buf)
810 return -ENOMEM;
812 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
813 if (!dr) {
814 kfree(buf);
815 return -ENOMEM;
818 /* Fill Setup packet for GetDescriptor */
819 dr->bRequestType = USB_DIR_IN;
820 dr->bRequest = USB_REQ_GET_DESCRIPTOR;
821 dr->wValue = cpu_to_le16(USB_DT_DEVICE << 8);
822 dr->wIndex = 0;
823 dr->wLength = cpu_to_le16(USB_DT_DEVICE_SIZE);
824 urb = request_single_step_set_feature_urb(udev, dr, buf, &done);
825 if (!urb)
826 goto cleanup;
828 /* Submit just the SETUP stage */
829 retval = submit_single_step_set_feature(hcd, urb, 1);
830 if (retval)
831 goto out1;
832 if (!wait_for_completion_timeout(&done, msecs_to_jiffies(2000))) {
833 usb_kill_urb(urb);
834 retval = -ETIMEDOUT;
835 ehci_err(ehci, "%s SETUP stage timed out on ep0\n", __func__);
836 goto out1;
838 msleep(15 * 1000);
840 /* Complete remaining DATA and STATUS stages using the same URB */
841 urb->status = -EINPROGRESS;
842 usb_get_urb(urb);
843 atomic_inc(&urb->use_count);
844 atomic_inc(&urb->dev->urbnum);
845 retval = submit_single_step_set_feature(hcd, urb, 0);
846 if (!retval && !wait_for_completion_timeout(&done,
847 msecs_to_jiffies(2000))) {
848 usb_kill_urb(urb);
849 retval = -ETIMEDOUT;
850 ehci_err(ehci, "%s IN stage timed out on ep0\n", __func__);
852 out1:
853 usb_free_urb(urb);
854 cleanup:
855 kfree(dr);
856 kfree(buf);
857 return retval;
859 #endif /* CONFIG_USB_HCD_TEST_MODE */
860 /*-------------------------------------------------------------------------*/
862 int ehci_hub_control(
863 struct usb_hcd *hcd,
864 u16 typeReq,
865 u16 wValue,
866 u16 wIndex,
867 char *buf,
868 u16 wLength
870 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
871 int ports = HCS_N_PORTS (ehci->hcs_params);
872 u32 __iomem *status_reg = &ehci->regs->port_status[
873 (wIndex & 0xff) - 1];
874 u32 __iomem *hostpc_reg = &ehci->regs->hostpc[(wIndex & 0xff) - 1];
875 u32 temp, temp1, status;
876 unsigned long flags;
877 int retval = 0;
878 unsigned selector;
881 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
882 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
883 * (track current state ourselves) ... blink for diagnostics,
884 * power, "this is the one", etc. EHCI spec supports this.
887 spin_lock_irqsave (&ehci->lock, flags);
888 switch (typeReq) {
889 case ClearHubFeature:
890 switch (wValue) {
891 case C_HUB_LOCAL_POWER:
892 case C_HUB_OVER_CURRENT:
893 /* no hub-wide feature/status flags */
894 break;
895 default:
896 goto error;
898 break;
899 case ClearPortFeature:
900 if (!wIndex || wIndex > ports)
901 goto error;
902 wIndex--;
903 temp = ehci_readl(ehci, status_reg);
904 temp &= ~PORT_RWC_BITS;
907 * Even if OWNER is set, so the port is owned by the
908 * companion controller, khubd needs to be able to clear
909 * the port-change status bits (especially
910 * USB_PORT_STAT_C_CONNECTION).
913 switch (wValue) {
914 case USB_PORT_FEAT_ENABLE:
915 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
916 break;
917 case USB_PORT_FEAT_C_ENABLE:
918 ehci_writel(ehci, temp | PORT_PEC, status_reg);
919 break;
920 case USB_PORT_FEAT_SUSPEND:
921 if (temp & PORT_RESET)
922 goto error;
923 if (ehci->no_selective_suspend)
924 break;
925 #ifdef CONFIG_USB_OTG
926 if ((hcd->self.otg_port == (wIndex + 1))
927 && hcd->self.b_hnp_enable) {
928 otg_start_hnp(hcd->phy->otg);
929 break;
931 #endif
932 if (!(temp & PORT_SUSPEND))
933 break;
934 if ((temp & PORT_PE) == 0)
935 goto error;
937 /* clear phy low-power mode before resume */
938 if (ehci->has_tdi_phy_lpm) {
939 temp1 = ehci_readl(ehci, hostpc_reg);
940 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
941 hostpc_reg);
942 spin_unlock_irqrestore(&ehci->lock, flags);
943 msleep(5);/* wait to leave low-power mode */
944 spin_lock_irqsave(&ehci->lock, flags);
946 /* resume signaling for 20 msec */
947 temp &= ~PORT_WAKE_BITS;
948 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
949 ehci->reset_done[wIndex] = jiffies
950 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
951 set_bit(wIndex, &ehci->resuming_ports);
952 usb_hcd_start_port_resume(&hcd->self, wIndex);
953 break;
954 case USB_PORT_FEAT_C_SUSPEND:
955 clear_bit(wIndex, &ehci->port_c_suspend);
956 break;
957 case USB_PORT_FEAT_POWER:
958 if (HCS_PPC (ehci->hcs_params))
959 ehci_writel(ehci, temp & ~PORT_POWER,
960 status_reg);
961 break;
962 case USB_PORT_FEAT_C_CONNECTION:
963 ehci_writel(ehci, temp | PORT_CSC, status_reg);
964 break;
965 case USB_PORT_FEAT_C_OVER_CURRENT:
966 ehci_writel(ehci, temp | PORT_OCC, status_reg);
967 break;
968 case USB_PORT_FEAT_C_RESET:
969 /* GetPortStatus clears reset */
970 break;
971 default:
972 goto error;
974 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
975 break;
976 case GetHubDescriptor:
977 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
978 buf);
979 break;
980 case GetHubStatus:
981 /* no hub-wide feature/status flags */
982 memset (buf, 0, 4);
983 //cpu_to_le32s ((u32 *) buf);
984 break;
985 case GetPortStatus:
986 if (!wIndex || wIndex > ports)
987 goto error;
988 wIndex--;
989 status = 0;
990 temp = ehci_readl(ehci, status_reg);
992 // wPortChange bits
993 if (temp & PORT_CSC)
994 status |= USB_PORT_STAT_C_CONNECTION << 16;
995 if (temp & PORT_PEC)
996 status |= USB_PORT_STAT_C_ENABLE << 16;
998 if ((temp & PORT_OCC) && !ignore_oc){
999 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1002 * Hubs should disable port power on over-current.
1003 * However, not all EHCI implementations do this
1004 * automatically, even if they _do_ support per-port
1005 * power switching; they're allowed to just limit the
1006 * current. khubd will turn the power back on.
1008 if (((temp & PORT_OC) || (ehci->need_oc_pp_cycle))
1009 && HCS_PPC(ehci->hcs_params)) {
1010 ehci_writel(ehci,
1011 temp & ~(PORT_RWC_BITS | PORT_POWER),
1012 status_reg);
1013 temp = ehci_readl(ehci, status_reg);
1017 /* no reset or resume pending */
1018 if (!ehci->reset_done[wIndex]) {
1020 /* Remote Wakeup received? */
1021 if (temp & PORT_RESUME) {
1022 /* resume signaling for 20 msec */
1023 ehci->reset_done[wIndex] = jiffies
1024 + msecs_to_jiffies(20);
1025 usb_hcd_start_port_resume(&hcd->self, wIndex);
1026 set_bit(wIndex, &ehci->resuming_ports);
1027 /* check the port again */
1028 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
1029 ehci->reset_done[wIndex]);
1032 /* reset or resume not yet complete */
1033 } else if (!time_after_eq(jiffies, ehci->reset_done[wIndex])) {
1034 ; /* wait until it is complete */
1036 /* resume completed */
1037 } else if (test_bit(wIndex, &ehci->resuming_ports)) {
1038 clear_bit(wIndex, &ehci->suspended_ports);
1039 set_bit(wIndex, &ehci->port_c_suspend);
1040 ehci->reset_done[wIndex] = 0;
1041 usb_hcd_end_port_resume(&hcd->self, wIndex);
1043 /* stop resume signaling */
1044 temp &= ~(PORT_RWC_BITS | PORT_SUSPEND | PORT_RESUME);
1045 ehci_writel(ehci, temp, status_reg);
1046 clear_bit(wIndex, &ehci->resuming_ports);
1047 retval = ehci_handshake(ehci, status_reg,
1048 PORT_RESUME, 0, 2000 /* 2msec */);
1049 if (retval != 0) {
1050 ehci_err(ehci, "port %d resume error %d\n",
1051 wIndex + 1, retval);
1052 goto error;
1054 temp = ehci_readl(ehci, status_reg);
1056 /* whoever resets must GetPortStatus to complete it!! */
1057 } else {
1058 status |= USB_PORT_STAT_C_RESET << 16;
1059 ehci->reset_done [wIndex] = 0;
1061 /* force reset to complete */
1062 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
1063 status_reg);
1064 /* REVISIT: some hardware needs 550+ usec to clear
1065 * this bit; seems too long to spin routinely...
1067 retval = ehci_handshake(ehci, status_reg,
1068 PORT_RESET, 0, 1000);
1069 if (retval != 0) {
1070 ehci_err (ehci, "port %d reset error %d\n",
1071 wIndex + 1, retval);
1072 goto error;
1075 /* see what we found out */
1076 temp = check_reset_complete (ehci, wIndex, status_reg,
1077 ehci_readl(ehci, status_reg));
1080 /* transfer dedicated ports to the companion hc */
1081 if ((temp & PORT_CONNECT) &&
1082 test_bit(wIndex, &ehci->companion_ports)) {
1083 temp &= ~PORT_RWC_BITS;
1084 temp |= PORT_OWNER;
1085 ehci_writel(ehci, temp, status_reg);
1086 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
1087 temp = ehci_readl(ehci, status_reg);
1091 * Even if OWNER is set, there's no harm letting khubd
1092 * see the wPortStatus values (they should all be 0 except
1093 * for PORT_POWER anyway).
1096 if (temp & PORT_CONNECT) {
1097 status |= USB_PORT_STAT_CONNECTION;
1098 // status may be from integrated TT
1099 if (ehci->has_hostpc) {
1100 temp1 = ehci_readl(ehci, hostpc_reg);
1101 status |= ehci_port_speed(ehci, temp1);
1102 } else
1103 status |= ehci_port_speed(ehci, temp);
1105 if (temp & PORT_PE)
1106 status |= USB_PORT_STAT_ENABLE;
1108 /* maybe the port was unsuspended without our knowledge */
1109 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
1110 status |= USB_PORT_STAT_SUSPEND;
1111 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
1112 clear_bit(wIndex, &ehci->suspended_ports);
1113 clear_bit(wIndex, &ehci->resuming_ports);
1114 ehci->reset_done[wIndex] = 0;
1115 if (temp & PORT_PE)
1116 set_bit(wIndex, &ehci->port_c_suspend);
1117 usb_hcd_end_port_resume(&hcd->self, wIndex);
1120 if (temp & PORT_OC)
1121 status |= USB_PORT_STAT_OVERCURRENT;
1122 if (temp & PORT_RESET)
1123 status |= USB_PORT_STAT_RESET;
1124 if (temp & PORT_POWER)
1125 status |= USB_PORT_STAT_POWER;
1126 if (test_bit(wIndex, &ehci->port_c_suspend))
1127 status |= USB_PORT_STAT_C_SUSPEND << 16;
1129 if (status & ~0xffff) /* only if wPortChange is interesting */
1130 dbg_port(ehci, "GetStatus", wIndex + 1, temp);
1131 put_unaligned_le32(status, buf);
1132 break;
1133 case SetHubFeature:
1134 switch (wValue) {
1135 case C_HUB_LOCAL_POWER:
1136 case C_HUB_OVER_CURRENT:
1137 /* no hub-wide feature/status flags */
1138 break;
1139 default:
1140 goto error;
1142 break;
1143 case SetPortFeature:
1144 selector = wIndex >> 8;
1145 wIndex &= 0xff;
1146 if (unlikely(ehci->debug)) {
1147 /* If the debug port is active any port
1148 * feature requests should get denied */
1149 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1150 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1151 retval = -ENODEV;
1152 goto error_exit;
1155 if (!wIndex || wIndex > ports)
1156 goto error;
1157 wIndex--;
1158 temp = ehci_readl(ehci, status_reg);
1159 if (temp & PORT_OWNER)
1160 break;
1162 temp &= ~PORT_RWC_BITS;
1163 switch (wValue) {
1164 case USB_PORT_FEAT_SUSPEND:
1165 if (ehci->no_selective_suspend)
1166 break;
1167 if ((temp & PORT_PE) == 0
1168 || (temp & PORT_RESET) != 0)
1169 goto error;
1171 /* After above check the port must be connected.
1172 * Set appropriate bit thus could put phy into low power
1173 * mode if we have tdi_phy_lpm feature
1175 temp &= ~PORT_WKCONN_E;
1176 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1177 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1178 if (ehci->has_tdi_phy_lpm) {
1179 spin_unlock_irqrestore(&ehci->lock, flags);
1180 msleep(5);/* 5ms for HCD enter low pwr mode */
1181 spin_lock_irqsave(&ehci->lock, flags);
1182 temp1 = ehci_readl(ehci, hostpc_reg);
1183 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1184 hostpc_reg);
1185 temp1 = ehci_readl(ehci, hostpc_reg);
1186 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1187 wIndex, (temp1 & HOSTPC_PHCD) ?
1188 "succeeded" : "failed");
1190 set_bit(wIndex, &ehci->suspended_ports);
1191 break;
1192 case USB_PORT_FEAT_POWER:
1193 if (HCS_PPC (ehci->hcs_params))
1194 ehci_writel(ehci, temp | PORT_POWER,
1195 status_reg);
1196 break;
1197 case USB_PORT_FEAT_RESET:
1198 if (temp & (PORT_SUSPEND|PORT_RESUME))
1199 goto error;
1200 /* line status bits may report this as low speed,
1201 * which can be fine if this root hub has a
1202 * transaction translator built in.
1204 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1205 && !ehci_is_TDI(ehci)
1206 && PORT_USB11 (temp)) {
1207 ehci_dbg (ehci,
1208 "port %d low speed --> companion\n",
1209 wIndex + 1);
1210 temp |= PORT_OWNER;
1211 } else {
1212 temp |= PORT_RESET;
1213 temp &= ~PORT_PE;
1216 * caller must wait, then call GetPortStatus
1217 * usb 2.0 spec says 50 ms resets on root
1219 ehci->reset_done [wIndex] = jiffies
1220 + msecs_to_jiffies (50);
1223 * Force full-speed connect for FSL high-speed
1224 * erratum; disable HS Chirp by setting PFSC bit
1226 if (ehci_has_fsl_hs_errata(ehci))
1227 temp |= (1 << PORTSC_FSL_PFSC);
1229 ehci_writel(ehci, temp, status_reg);
1230 break;
1232 /* For downstream facing ports (these): one hub port is put
1233 * into test mode according to USB2 11.24.2.13, then the hub
1234 * must be reset (which for root hub now means rmmod+modprobe,
1235 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1236 * about the EHCI-specific stuff.
1238 case USB_PORT_FEAT_TEST:
1239 #ifdef CONFIG_USB_HCD_TEST_MODE
1240 if (selector == EHSET_TEST_SINGLE_STEP_SET_FEATURE) {
1241 spin_unlock_irqrestore(&ehci->lock, flags);
1242 retval = ehset_single_step_set_feature(hcd,
1243 wIndex + 1);
1244 spin_lock_irqsave(&ehci->lock, flags);
1245 break;
1247 #endif
1248 if (!selector || selector > 5)
1249 goto error;
1250 spin_unlock_irqrestore(&ehci->lock, flags);
1251 ehci_quiesce(ehci);
1252 spin_lock_irqsave(&ehci->lock, flags);
1254 /* Put all enabled ports into suspend */
1255 while (ports--) {
1256 u32 __iomem *sreg =
1257 &ehci->regs->port_status[ports];
1259 temp = ehci_readl(ehci, sreg) & ~PORT_RWC_BITS;
1260 if (temp & PORT_PE)
1261 ehci_writel(ehci, temp | PORT_SUSPEND,
1262 sreg);
1265 spin_unlock_irqrestore(&ehci->lock, flags);
1266 ehci_halt(ehci);
1267 spin_lock_irqsave(&ehci->lock, flags);
1269 temp = ehci_readl(ehci, status_reg);
1270 temp |= selector << 16;
1271 ehci_writel(ehci, temp, status_reg);
1272 break;
1274 default:
1275 goto error;
1277 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1278 break;
1280 default:
1281 error:
1282 /* "stall" on error */
1283 retval = -EPIPE;
1285 error_exit:
1286 spin_unlock_irqrestore (&ehci->lock, flags);
1287 return retval;
1289 EXPORT_SYMBOL_GPL(ehci_hub_control);
1291 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1293 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1295 if (ehci_is_TDI(ehci))
1296 return;
1297 set_owner(ehci, --portnum, PORT_OWNER);
1300 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1302 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1303 u32 __iomem *reg;
1305 if (ehci_is_TDI(ehci))
1306 return 0;
1307 reg = &ehci->regs->port_status[portnum - 1];
1308 return ehci_readl(ehci, reg) & PORT_OWNER;