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
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 /*-------------------------------------------------------------------------*/
31 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
35 static int ehci_hub_control(
44 /* After a power loss, ports that were owned by the companion must be
45 * reset so that the companion can still own them.
47 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
53 struct usb_hcd *hcd = ehci_to_hcd(ehci);
55 if (!ehci->owned_ports)
58 /* Give the connections some time to appear */
61 port = HCS_N_PORTS(ehci->hcs_params);
63 if (test_bit(port, &ehci->owned_ports)) {
64 reg = &ehci->regs->port_status[port];
65 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
67 /* Port already owned by companion? */
68 if (status & PORT_OWNER)
69 clear_bit(port, &ehci->owned_ports);
70 else if (test_bit(port, &ehci->companion_ports))
71 ehci_writel(ehci, status & ~PORT_PE, reg);
73 ehci_hub_control(hcd, SetPortFeature,
74 USB_PORT_FEAT_RESET, port + 1,
79 if (!ehci->owned_ports)
81 msleep(90); /* Wait for resets to complete */
83 port = HCS_N_PORTS(ehci->hcs_params);
85 if (test_bit(port, &ehci->owned_ports)) {
86 ehci_hub_control(hcd, GetPortStatus,
88 (char *) &buf, sizeof(buf));
90 /* The companion should now own the port,
91 * but if something went wrong the port must not
94 reg = &ehci->regs->port_status[port];
95 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
96 if (status & PORT_OWNER)
97 ehci_writel(ehci, status | PORT_CSC, reg);
99 ehci_dbg(ehci, "failed handover port %d: %x\n",
101 ehci_writel(ehci, status & ~PORT_PE, reg);
106 ehci->owned_ports = 0;
109 static void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
110 bool suspending, bool do_wakeup)
116 /* If remote wakeup is enabled for the root hub but disabled
117 * for the controller, we must adjust all the port wakeup flags
118 * when the controller is suspended or resumed. In all other
119 * cases they don't need to be changed.
121 if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
124 spin_lock_irqsave(&ehci->lock, flags);
126 /* clear phy low-power mode before changing wakeup flags */
127 if (ehci->has_hostpc) {
128 port = HCS_N_PORTS(ehci->hcs_params);
130 u32 __iomem *hostpc_reg;
132 hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
133 + HOSTPC0 + 4 * port);
134 temp = ehci_readl(ehci, hostpc_reg);
135 ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
137 spin_unlock_irqrestore(&ehci->lock, flags);
139 spin_lock_irqsave(&ehci->lock, flags);
142 port = HCS_N_PORTS(ehci->hcs_params);
144 u32 __iomem *reg = &ehci->regs->port_status[port];
145 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
146 u32 t2 = t1 & ~PORT_WAKE_BITS;
148 /* If we are suspending the controller, clear the flags.
149 * If we are resuming the controller, set the wakeup flags.
152 if (t1 & PORT_CONNECT)
153 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
155 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
157 ehci_vdbg(ehci, "port %d, %08x -> %08x\n",
159 ehci_writel(ehci, t2, reg);
162 /* enter phy low-power mode again */
163 if (ehci->has_hostpc) {
164 port = HCS_N_PORTS(ehci->hcs_params);
166 u32 __iomem *hostpc_reg;
168 hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
169 + HOSTPC0 + 4 * port);
170 temp = ehci_readl(ehci, hostpc_reg);
171 ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
175 /* Does the root hub have a port wakeup pending? */
176 if (!suspending && (ehci_readl(ehci, &ehci->regs->status) & STS_PCD))
177 usb_hcd_resume_root_hub(ehci_to_hcd(ehci));
179 spin_unlock_irqrestore(&ehci->lock, flags);
182 static int ehci_bus_suspend (struct usb_hcd *hcd)
184 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
189 ehci_dbg(ehci, "suspend root hub\n");
191 if (time_before (jiffies, ehci->next_statechange))
193 del_timer_sync(&ehci->watchdog);
194 del_timer_sync(&ehci->iaa_watchdog);
196 spin_lock_irq (&ehci->lock);
198 /* Once the controller is stopped, port resumes that are already
199 * in progress won't complete. Hence if remote wakeup is enabled
200 * for the root hub and any ports are in the middle of a resume or
201 * remote wakeup, we must fail the suspend.
203 if (hcd->self.root_hub->do_remote_wakeup) {
204 port = HCS_N_PORTS(ehci->hcs_params);
206 if (ehci->reset_done[port] != 0) {
207 spin_unlock_irq(&ehci->lock);
208 ehci_dbg(ehci, "suspend failed because "
209 "port %d is resuming\n",
216 /* stop schedules, clean any completed work */
217 if (HC_IS_RUNNING(hcd->state)) {
219 hcd->state = HC_STATE_QUIESCING;
221 ehci->command = ehci_readl(ehci, &ehci->regs->command);
224 /* Unlike other USB host controller types, EHCI doesn't have
225 * any notion of "global" or bus-wide suspend. The driver has
226 * to manually suspend all the active unsuspended ports, and
227 * then manually resume them in the bus_resume() routine.
229 ehci->bus_suspended = 0;
230 ehci->owned_ports = 0;
232 port = HCS_N_PORTS(ehci->hcs_params);
234 u32 __iomem *reg = &ehci->regs->port_status [port];
235 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
236 u32 t2 = t1 & ~PORT_WAKE_BITS;
238 /* keep track of which ports we suspend */
240 set_bit(port, &ehci->owned_ports);
241 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
243 set_bit(port, &ehci->bus_suspended);
246 /* enable remote wakeup on all ports, if told to do so */
247 if (hcd->self.root_hub->do_remote_wakeup) {
248 /* only enable appropriate wake bits, otherwise the
249 * hardware can not go phy low power mode. If a race
250 * condition happens here(connection change during bits
251 * set), the port change detection will finally fix it.
253 if (t1 & PORT_CONNECT)
254 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
256 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
260 ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
262 ehci_writel(ehci, t2, reg);
267 if (changed && ehci->has_hostpc) {
268 spin_unlock_irq(&ehci->lock);
269 msleep(5); /* 5 ms for HCD to enter low-power mode */
270 spin_lock_irq(&ehci->lock);
272 port = HCS_N_PORTS(ehci->hcs_params);
274 u32 __iomem *hostpc_reg;
277 hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
278 + HOSTPC0 + 4 * port);
279 t3 = ehci_readl(ehci, hostpc_reg);
280 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
281 t3 = ehci_readl(ehci, hostpc_reg);
282 ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
283 port, (t3 & HOSTPC_PHCD) ?
284 "succeeded" : "failed");
288 /* Apparently some devices need a >= 1-uframe delay here */
289 if (ehci->bus_suspended)
292 /* turn off now-idle HC */
294 hcd->state = HC_STATE_SUSPENDED;
297 end_unlink_async(ehci);
299 /* allow remote wakeup */
301 if (!hcd->self.root_hub->do_remote_wakeup)
303 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
304 ehci_readl(ehci, &ehci->regs->intr_enable);
306 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
307 spin_unlock_irq (&ehci->lock);
309 /* ehci_work() may have re-enabled the watchdog timer, which we do not
310 * want, and so we must delete any pending watchdog timer events.
312 del_timer_sync(&ehci->watchdog);
317 /* caller has locked the root hub, and should reset/reinit on error */
318 static int ehci_bus_resume (struct usb_hcd *hcd)
320 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
324 u8 resume_needed = 0;
326 if (time_before (jiffies, ehci->next_statechange))
328 spin_lock_irq (&ehci->lock);
329 if (!HCD_HW_ACCESSIBLE(hcd)) {
330 spin_unlock_irq(&ehci->lock);
334 if (unlikely(ehci->debug)) {
335 if (!dbgp_reset_prep())
338 dbgp_external_startup();
341 /* Ideally and we've got a real resume here, and no port's power
342 * was lost. (For PCI, that means Vaux was maintained.) But we
343 * could instead be restoring a swsusp snapshot -- so that BIOS was
344 * the last user of the controller, not reset/pm hardware keeping
345 * state we gave to it.
347 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
348 ehci_dbg(ehci, "resume root hub%s\n",
349 power_okay ? "" : " after power loss");
351 /* at least some APM implementations will try to deliver
352 * IRQs right away, so delay them until we're ready.
354 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
356 /* re-init operational registers */
357 ehci_writel(ehci, 0, &ehci->regs->segment);
358 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
359 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
361 /* restore CMD_RUN, framelist size, and irq threshold */
362 ehci_writel(ehci, ehci->command, &ehci->regs->command);
364 /* Some controller/firmware combinations need a delay during which
365 * they set up the port statuses. See Bugzilla #8190. */
366 spin_unlock_irq(&ehci->lock);
368 spin_lock_irq(&ehci->lock);
370 /* clear phy low-power mode before resume */
371 if (ehci->bus_suspended && ehci->has_hostpc) {
372 i = HCS_N_PORTS(ehci->hcs_params);
374 if (test_bit(i, &ehci->bus_suspended)) {
375 u32 __iomem *hostpc_reg;
377 hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
379 temp = ehci_readl(ehci, hostpc_reg);
380 ehci_writel(ehci, temp & ~HOSTPC_PHCD,
384 spin_unlock_irq(&ehci->lock);
386 spin_lock_irq(&ehci->lock);
389 /* manually resume the ports we suspended during bus_suspend() */
390 i = HCS_N_PORTS (ehci->hcs_params);
392 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
393 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
394 if (test_bit(i, &ehci->bus_suspended) &&
395 (temp & PORT_SUSPEND)) {
399 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
402 /* msleep for 20ms only if code is trying to resume port */
404 spin_unlock_irq(&ehci->lock);
406 spin_lock_irq(&ehci->lock);
409 i = HCS_N_PORTS (ehci->hcs_params);
411 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
412 if (test_bit(i, &ehci->bus_suspended) &&
413 (temp & PORT_SUSPEND)) {
414 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
415 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
416 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
419 (void) ehci_readl(ehci, &ehci->regs->command);
421 /* maybe re-activate the schedule(s) */
423 if (ehci->async->qh_next.qh)
425 if (ehci->periodic_sched)
428 ehci->command |= temp;
429 ehci_writel(ehci, ehci->command, &ehci->regs->command);
432 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
433 hcd->state = HC_STATE_RUNNING;
435 /* Now we can safely re-enable irqs */
436 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
438 spin_unlock_irq (&ehci->lock);
439 ehci_handover_companion_ports(ehci);
445 #define ehci_bus_suspend NULL
446 #define ehci_bus_resume NULL
448 #endif /* CONFIG_PM */
450 /*-------------------------------------------------------------------------*/
452 /* Display the ports dedicated to the companion controller */
453 static ssize_t show_companion(struct device *dev,
454 struct device_attribute *attr,
457 struct ehci_hcd *ehci;
458 int nports, index, n;
459 int count = PAGE_SIZE;
462 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
463 nports = HCS_N_PORTS(ehci->hcs_params);
465 for (index = 0; index < nports; ++index) {
466 if (test_bit(index, &ehci->companion_ports)) {
467 n = scnprintf(ptr, count, "%d\n", index + 1);
476 * Sets the owner of a port
478 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
480 u32 __iomem *status_reg;
484 status_reg = &ehci->regs->port_status[portnum];
487 * The controller won't set the OWNER bit if the port is
488 * enabled, so this loop will sometimes require at least two
489 * iterations: one to disable the port and one to set OWNER.
491 for (try = 4; try > 0; --try) {
492 spin_lock_irq(&ehci->lock);
493 port_status = ehci_readl(ehci, status_reg);
494 if ((port_status & PORT_OWNER) == new_owner
495 || (port_status & (PORT_OWNER | PORT_CONNECT))
499 port_status ^= PORT_OWNER;
500 port_status &= ~(PORT_PE | PORT_RWC_BITS);
501 ehci_writel(ehci, port_status, status_reg);
503 spin_unlock_irq(&ehci->lock);
510 * Dedicate or undedicate a port to the companion controller.
511 * Syntax is "[-]portnum", where a leading '-' sign means
512 * return control of the port to the EHCI controller.
514 static ssize_t store_companion(struct device *dev,
515 struct device_attribute *attr,
516 const char *buf, size_t count)
518 struct ehci_hcd *ehci;
519 int portnum, new_owner;
521 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
522 new_owner = PORT_OWNER; /* Owned by companion */
523 if (sscanf(buf, "%d", &portnum) != 1)
527 new_owner = 0; /* Owned by EHCI */
529 if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
533 set_bit(portnum, &ehci->companion_ports);
535 clear_bit(portnum, &ehci->companion_ports);
536 set_owner(ehci, portnum, new_owner);
539 static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
541 static inline void create_companion_file(struct ehci_hcd *ehci)
545 /* with integrated TT there is no companion! */
546 if (!ehci_is_TDI(ehci))
547 i = device_create_file(ehci_to_hcd(ehci)->self.controller,
548 &dev_attr_companion);
551 static inline void remove_companion_file(struct ehci_hcd *ehci)
553 /* with integrated TT there is no companion! */
554 if (!ehci_is_TDI(ehci))
555 device_remove_file(ehci_to_hcd(ehci)->self.controller,
556 &dev_attr_companion);
560 /*-------------------------------------------------------------------------*/
562 static int check_reset_complete (
563 struct ehci_hcd *ehci,
565 u32 __iomem *status_reg,
568 if (!(port_status & PORT_CONNECT))
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)) {
577 "Failed to enable port %d on root hub TT\n",
582 ehci_dbg (ehci, "port %d full speed --> companion\n",
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);
594 ehci_dbg (ehci, "port %d high speed\n", index + 1);
595 /* ensure 440EPx ohci controller state is suspended */
596 if (ehci->has_amcc_usb23)
597 set_ohci_hcfs(ehci, 0);
603 /*-------------------------------------------------------------------------*/
606 /* build "status change" packet (one or two bytes) from HC registers */
609 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
611 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
612 u32 temp, status = 0;
614 int ports, i, retval = 1;
618 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
619 if (!HC_IS_RUNNING(hcd->state))
622 /* init status to no-changes */
624 ports = HCS_N_PORTS (ehci->hcs_params);
630 /* Some boards (mostly VIA?) report bogus overcurrent indications,
631 * causing massive log spam unless we completely ignore them. It
632 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
633 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
634 * PORT_POWER; that's surprising, but maybe within-spec.
637 mask = PORT_CSC | PORT_PEC | PORT_OCC;
639 mask = PORT_CSC | PORT_PEC;
640 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
642 /* no hub change reports (bit 0) for now (power, ...) */
644 /* port N changes (bit N)? */
645 spin_lock_irqsave (&ehci->lock, flags);
647 /* get per-port change detect bits */
649 ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
651 for (i = 0; i < ports; i++) {
652 /* leverage per-port change bits feature */
653 if (ehci->has_ppcd && !(ppcd & (1 << i)))
655 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
658 * Return status information even for ports with OWNER set.
659 * Otherwise khubd wouldn't see the disconnect event when a
660 * high-speed device is switched over to the companion
661 * controller by the user.
664 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
665 || (ehci->reset_done[i] && time_after_eq(
666 jiffies, ehci->reset_done[i]))) {
668 buf [0] |= 1 << (i + 1);
670 buf [1] |= 1 << (i - 7);
674 /* FIXME autosuspend idle root hubs */
675 spin_unlock_irqrestore (&ehci->lock, flags);
676 return status ? retval : 0;
679 /*-------------------------------------------------------------------------*/
682 ehci_hub_descriptor (
683 struct ehci_hcd *ehci,
684 struct usb_hub_descriptor *desc
686 int ports = HCS_N_PORTS (ehci->hcs_params);
689 desc->bDescriptorType = 0x29;
690 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
691 desc->bHubContrCurrent = 0;
693 desc->bNbrPorts = ports;
694 temp = 1 + (ports / 8);
695 desc->bDescLength = 7 + 2 * temp;
697 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
698 memset (&desc->bitmap [0], 0, temp);
699 memset (&desc->bitmap [temp], 0xff, temp);
701 temp = 0x0008; /* per-port overcurrent reporting */
702 if (HCS_PPC (ehci->hcs_params))
703 temp |= 0x0001; /* per-port power control */
705 temp |= 0x0002; /* no power switching */
707 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
708 if (HCS_INDICATOR (ehci->hcs_params))
709 temp |= 0x0080; /* per-port indicators (LEDs) */
711 desc->wHubCharacteristics = cpu_to_le16(temp);
714 /*-------------------------------------------------------------------------*/
715 #ifdef CONFIG_HOST_COMPLIANT_TEST
717 struct completion done;
721 static void ehci_test_api_blocking_completion(struct urb *urb)
723 struct api_context *ctx = urb->context;
724 printk("ehci_test_api_blocking_completion\n");
725 ctx->status = urb->status;
726 complete(&ctx->done);
730 static int single_step_get_descriptor( struct usb_hcd *hcd, u8 port)
732 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
733 struct list_head qtd_list;
734 struct list_head test_list;
735 struct usb_device *udev;
736 struct ehci_qtd *qtd;
738 struct usb_ctrlrequest setup_packet;
739 char data_buffer[USB_DT_DEVICE_SIZE];
742 ehci_info (ehci, "Testing SINGLE_STEP_GET_DEV_DESC\n");
744 udev = hcd->self.root_hub;
746 ehci_err (ehci, "EHSET: root_hub pointer is NULL\n");
751 if (udev->children[port] != NULL) {
752 udev = udev->children[port];
755 urb = usb_alloc_urb(0, GFP_ATOMIC);
762 setup_packet.bRequestType = USB_DIR_IN;
763 setup_packet.bRequest = USB_REQ_GET_DESCRIPTOR;
764 setup_packet.wValue = (USB_DT_DEVICE << 8);
765 setup_packet.wIndex = 0;
766 setup_packet.wLength = USB_DT_DEVICE_SIZE;
768 INIT_LIST_HEAD (&qtd_list);
769 INIT_LIST_HEAD (&test_list);
772 urb->pipe = usb_rcvctrlpipe(udev, 0);
773 urb->hcpriv= udev->ep0.hcpriv;
774 urb->setup_packet = (char *)&setup_packet;
775 urb->transfer_buffer = data_buffer;
776 urb->transfer_flags = URB_HCD_DRIVER_TEST;
777 urb->ep = udev->ep_in[usb_pipeendpoint(urb->pipe)];
783 urb->setup_dma = dma_map_single(
784 hcd->self.controller,
786 sizeof(struct usb_ctrlrequest),
789 urb->transfer_dma = dma_map_single (
790 hcd->self.controller,
791 urb->transfer_buffer,
792 urb->transfer_buffer_length,
795 if (!urb->setup_dma || !urb->transfer_dma) {
796 ehci_err (ehci, "dma_map_single Failed"
802 if (!qh_urb_transaction (ehci, urb, &qtd_list,
804 ehci_err (ehci, "qh_urb_transaction "
810 qtd = container_of (qtd_list.next,
811 struct ehci_qtd, qtd_list);
812 list_del_init (&qtd->qtd_list);
813 list_add (&qtd->qtd_list, &test_list);
814 qtd = container_of (qtd_list.next,
815 struct ehci_qtd, qtd_list);
816 list_del_init (&qtd->qtd_list);
817 ehci_qtd_free (ehci, qtd);
819 set_current_state(TASK_UNINTERRUPTIBLE);
820 schedule_timeout(msecs_to_jiffies(15000));
822 ehci_info (ehci, "Sending SETUP PHASE\n");
823 if (submit_async (ehci, urb,
824 &test_list, GFP_ATOMIC)) {
825 ehci_err (ehci, "Failed to queue up "
834 static int single_step_set_feature( struct usb_hcd *hcd, u8 port)
836 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
837 struct usb_device *udev;
838 struct list_head qtd_list;
839 struct list_head setup_list;
840 struct list_head data_list;
841 struct ehci_qtd *qtd;
843 struct usb_ctrlrequest setup_packet;
844 char data_buffer[USB_DT_DEVICE_SIZE];
847 ehci_info (ehci, "Testing SINGLE_STEP_SET_FEATURE\n");
849 udev = hcd->self.root_hub;
851 ehci_err (ehci, "EHSET: root_hub pointer is NULL\n");
856 if (udev->children[port] != NULL) {
857 udev = udev->children[port];
860 urb = usb_alloc_urb(0, GFP_ATOMIC);
865 setup_packet.bRequestType = USB_DIR_IN;
866 setup_packet.bRequest = USB_REQ_GET_DESCRIPTOR;
867 setup_packet.wValue = (USB_DT_DEVICE << 8);
868 setup_packet.wIndex = 0;
869 setup_packet.wLength = USB_DT_DEVICE_SIZE;
871 INIT_LIST_HEAD (&qtd_list);
872 INIT_LIST_HEAD (&setup_list);
873 INIT_LIST_HEAD (&data_list);
875 urb->transfer_buffer_length = USB_DT_DEVICE_SIZE;
877 urb->pipe = usb_rcvctrlpipe(udev, 0);
878 urb->hcpriv = udev->ep0.hcpriv;
879 urb->setup_packet = (char *)&setup_packet;
880 urb->transfer_buffer = data_buffer;
881 urb->transfer_flags = URB_HCD_DRIVER_TEST;
882 urb->ep = udev->ep_in[usb_pipeendpoint(urb->pipe)];
888 urb->setup_dma = dma_map_single( hcd->self.controller,
890 sizeof (struct usb_ctrlrequest),
893 urb->transfer_dma = dma_map_single (hcd->self.controller,
894 urb->transfer_buffer,
895 sizeof (struct usb_ctrlrequest),
898 if (!urb->setup_dma || !urb->transfer_dma) {
899 ehci_err (ehci, "dma_map_single Failed\n");
904 if (!qh_urb_transaction (ehci, urb, &qtd_list, GFP_ATOMIC)) {
905 ehci_err (ehci, "qh_urb_transaction Failed\n");
910 qtd = container_of (qtd_list.next, struct ehci_qtd, qtd_list);
911 list_del_init (&qtd->qtd_list);
912 list_add (&qtd->qtd_list, &setup_list);
913 qtd = container_of (qtd_list.next, struct ehci_qtd, qtd_list);
914 list_del_init (&qtd->qtd_list);
915 list_add (&qtd->qtd_list, &data_list);
916 qtd = container_of (qtd_list.next, struct ehci_qtd, qtd_list);
917 list_del_init (&qtd->qtd_list);
918 ehci_qtd_free (ehci, qtd);
920 ehci_info (ehci, "Sending SETUP PHASE\n");
921 if (submit_async (ehci, urb, &setup_list, GFP_ATOMIC)) {
922 ehci_err (ehci, "Failed to queue up qtds\n");
927 set_current_state(TASK_UNINTERRUPTIBLE);
928 schedule_timeout(msecs_to_jiffies(15000));
930 urb->actual_length = 0;
932 ehci_info (ehci, "Sending DATA PHASE\n");
933 if (submit_async (ehci, urb, &data_list, GFP_ATOMIC))
935 ehci_err (ehci, "Failed to queue up qtds\n");
943 static int ehci_port_test(struct usb_hcd *hcd, u8 selector, u8 port,
946 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
948 u32 __iomem *status_reg = &ehci->regs->port_status[port];
951 temp = ehci_readl(ehci, status_reg);
953 ehci_info (ehci, "status_reg BEFORE write regs = 0x%x\n",temp);
955 case USB_PORT_TEST_J:
956 spin_unlock_irqrestore (&ehci->lock, flags);
957 ehci_info (ehci, "Testing J State\n");
959 if(hcd->driver->bus_suspend)
960 hcd->driver->bus_suspend(hcd);
962 spin_lock_irqsave (&ehci->lock, flags);
963 ehci_writel(ehci, temp|PORT_TEST_J,status_reg);
966 case USB_PORT_TEST_K:
967 spin_unlock_irqrestore (&ehci->lock, flags);
968 ehci_info (ehci, "Testing K State\n");
970 if(hcd->driver->bus_suspend)
971 hcd->driver->bus_suspend(hcd);
973 spin_lock_irqsave (&ehci->lock, flags);
974 ehci_writel(ehci, temp|PORT_TEST_K,status_reg);
977 case USB_PORT_TEST_SE0_NAK:
978 spin_unlock_irqrestore (&ehci->lock, flags);
979 ehci_info (ehci, "Testing SE0_NAK\n");
981 if(hcd->driver->bus_suspend)
982 hcd->driver->bus_suspend(hcd);
984 spin_lock_irqsave (&ehci->lock, flags);
985 ehci_writel(ehci, temp|PORT_TEST_SE0_NAK,status_reg);
988 case USB_PORT_TEST_PACKET:
989 ehci_info (ehci, "Sending Test Packets\n");
990 ehci_writel(ehci, temp|PORT_TEST_PACKET,status_reg);
993 case USB_PORT_TEST_FORCE_ENABLE:
994 ehci_info (ehci, "Testing FORCE_ENABLE\n");
995 ehci_writel(ehci, temp|PORT_TEST_FORCE_ENABLE,status_reg);
998 case (EHSET_HS_HOST_PORT_SUSPEND_RESUME & 0xFF):
999 spin_unlock_irqrestore (&ehci->lock, flags);
1000 ehci_info (ehci, "Testing SUSPEND RESUME\n");
1001 set_current_state(TASK_UNINTERRUPTIBLE);
1002 schedule_timeout(msecs_to_jiffies(15000));
1003 ehci_info (ehci, "Suspend Root Hub\n");
1004 temp = ehci_readl(ehci, status_reg);
1005 ehci_info(ehci, "[Before -> Suspend Status Reg : 0x%x\n",temp);
1006 if(hcd->driver->bus_suspend)
1007 hcd->driver->bus_suspend(hcd);
1008 temp = ehci_readl(ehci, status_reg);
1009 ehci_info(ehci, "[After -> Suspend Status Reg : 0x%x\n",temp);
1010 set_current_state(TASK_UNINTERRUPTIBLE);
1011 schedule_timeout(msecs_to_jiffies(15000));
1012 ehci_info (ehci, "Resume Root Hub\n");
1013 if(hcd->driver->bus_resume)
1014 hcd->driver->bus_resume(hcd);
1016 spin_lock_irqsave (&ehci->lock, flags);
1019 case (EHSET_SINGLE_STEP_GET_DEV_DESC&0xFF):
1020 spin_unlock_irqrestore (&ehci->lock, flags);
1021 retval = single_step_get_descriptor(hcd, port);
1023 ehci_err (ehci, "EHSET: get descriptor test fail\n");
1024 spin_lock_irqsave (&ehci->lock, flags);
1027 spin_lock_irqsave (&ehci->lock, flags);
1030 case (EHSET_SINGLE_STEP_SET_FEATURE & 0xFF):
1031 spin_unlock_irqrestore (&ehci->lock, flags);
1032 retval = single_step_set_feature(hcd, port);
1034 ehci_err (ehci, "EHSET: set feature test fail\n");
1035 spin_lock_irqsave (&ehci->lock, flags);
1038 spin_lock_irqsave (&ehci->lock, flags);
1041 ehci_err (ehci, "EHSET: Unknown test %x\n",
1046 temp = ehci_readl(ehci, status_reg);
1047 ehci_info (ehci, "status_reg AFTER write regs = 0x%x\n",temp);
1048 ehci_err(ehci, "EHSET test done. retval = 0x%x\n", retval);
1052 ehci_err (ehci, "EHSET test error. retval = 0x%x\n",retval);
1057 #endif /* CONFIG_HOST_COMPLIANT_TEST */
1059 static int ehci_hub_control (
1060 struct usb_hcd *hcd,
1067 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
1068 int ports = HCS_N_PORTS (ehci->hcs_params);
1069 u32 __iomem *status_reg = &ehci->regs->port_status[
1070 (wIndex & 0xff) - 1];
1071 u32 __iomem *hostpc_reg = NULL;
1072 u32 temp, temp1, status;
1073 unsigned long flags;
1078 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
1079 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
1080 * (track current state ourselves) ... blink for diagnostics,
1081 * power, "this is the one", etc. EHCI spec supports this.
1084 if (ehci->has_hostpc)
1085 hostpc_reg = (u32 __iomem *)((u8 *)ehci->regs
1086 + HOSTPC0 + 4 * ((wIndex & 0xff) - 1));
1087 spin_lock_irqsave (&ehci->lock, flags);
1089 case ClearHubFeature:
1091 case C_HUB_LOCAL_POWER:
1092 case C_HUB_OVER_CURRENT:
1093 /* no hub-wide feature/status flags */
1099 case ClearPortFeature:
1100 if (!wIndex || wIndex > ports)
1103 temp = ehci_readl(ehci, status_reg);
1106 * Even if OWNER is set, so the port is owned by the
1107 * companion controller, khubd needs to be able to clear
1108 * the port-change status bits (especially
1109 * USB_PORT_STAT_C_CONNECTION).
1113 case USB_PORT_FEAT_ENABLE:
1114 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
1116 case USB_PORT_FEAT_C_ENABLE:
1117 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
1120 case USB_PORT_FEAT_SUSPEND:
1121 if (temp & PORT_RESET)
1123 if (ehci->no_selective_suspend)
1125 if (!(temp & PORT_SUSPEND))
1127 if ((temp & PORT_PE) == 0)
1130 /* clear phy low-power mode before resume */
1132 temp1 = ehci_readl(ehci, hostpc_reg);
1133 ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
1135 spin_unlock_irqrestore(&ehci->lock, flags);
1136 msleep(5);/* wait to leave low-power mode */
1137 spin_lock_irqsave(&ehci->lock, flags);
1139 /* resume signaling for 20 msec */
1140 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
1141 ehci_writel(ehci, temp | PORT_RESUME, status_reg);
1142 ehci->reset_done[wIndex] = jiffies
1143 + msecs_to_jiffies(20);
1145 case USB_PORT_FEAT_C_SUSPEND:
1146 clear_bit(wIndex, &ehci->port_c_suspend);
1148 case USB_PORT_FEAT_POWER:
1149 if (HCS_PPC (ehci->hcs_params))
1151 temp & ~(PORT_RWC_BITS | PORT_POWER),
1154 case USB_PORT_FEAT_C_CONNECTION:
1155 if (ehci->has_lpm) {
1156 /* clear PORTSC bits on disconnect */
1158 temp &= ~PORT_DEV_ADDR;
1160 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
1163 case USB_PORT_FEAT_C_OVER_CURRENT:
1164 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
1167 case USB_PORT_FEAT_C_RESET:
1168 /* GetPortStatus clears reset */
1173 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
1175 case GetHubDescriptor:
1176 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
1180 /* no hub-wide feature/status flags */
1182 //cpu_to_le32s ((u32 *) buf);
1185 if (!wIndex || wIndex > ports)
1189 temp = ehci_readl(ehci, status_reg);
1192 if (temp & PORT_CSC)
1193 status |= USB_PORT_STAT_C_CONNECTION << 16;
1194 if (temp & PORT_PEC)
1195 status |= USB_PORT_STAT_C_ENABLE << 16;
1197 if ((temp & PORT_OCC) && !ignore_oc){
1198 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1201 * Hubs should disable port power on over-current.
1202 * However, not all EHCI implementations do this
1203 * automatically, even if they _do_ support per-port
1204 * power switching; they're allowed to just limit the
1205 * current. khubd will turn the power back on.
1207 if (HCS_PPC (ehci->hcs_params)){
1209 temp & ~(PORT_RWC_BITS | PORT_POWER),
1214 /* whoever resumes must GetPortStatus to complete it!! */
1215 if (temp & PORT_RESUME) {
1217 /* Remote Wakeup received? */
1218 if (!ehci->reset_done[wIndex]) {
1219 /* resume signaling for 20 msec */
1220 ehci->reset_done[wIndex] = jiffies
1221 + msecs_to_jiffies(20);
1222 /* check the port again */
1223 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
1224 ehci->reset_done[wIndex]);
1227 /* resume completed? */
1228 else if (time_after_eq(jiffies,
1229 ehci->reset_done[wIndex])) {
1230 clear_bit(wIndex, &ehci->suspended_ports);
1231 set_bit(wIndex, &ehci->port_c_suspend);
1232 ehci->reset_done[wIndex] = 0;
1234 /* stop resume signaling */
1235 temp = ehci_readl(ehci, status_reg);
1237 temp & ~(PORT_RWC_BITS | PORT_RESUME),
1239 retval = handshake(ehci, status_reg,
1240 PORT_RESUME, 0, 2000 /* 2msec */);
1243 "port %d resume error %d\n",
1244 wIndex + 1, retval);
1247 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
1251 /* whoever resets must GetPortStatus to complete it!! */
1252 if ((temp & PORT_RESET)
1253 && time_after_eq(jiffies,
1254 ehci->reset_done[wIndex])) {
1255 status |= USB_PORT_STAT_C_RESET << 16;
1256 ehci->reset_done [wIndex] = 0;
1258 /* force reset to complete */
1259 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
1261 /* REVISIT: some hardware needs 550+ usec to clear
1262 * this bit; seems too long to spin routinely...
1264 retval = handshake(ehci, status_reg,
1265 PORT_RESET, 0, 1000);
1267 ehci_err (ehci, "port %d reset error %d\n",
1268 wIndex + 1, retval);
1272 /* see what we found out */
1273 temp = check_reset_complete (ehci, wIndex, status_reg,
1274 ehci_readl(ehci, status_reg));
1277 if (!(temp & (PORT_RESUME|PORT_RESET)))
1278 ehci->reset_done[wIndex] = 0;
1280 /* transfer dedicated ports to the companion hc */
1281 if ((temp & PORT_CONNECT) &&
1282 test_bit(wIndex, &ehci->companion_ports)) {
1283 temp &= ~PORT_RWC_BITS;
1285 ehci_writel(ehci, temp, status_reg);
1286 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
1287 temp = ehci_readl(ehci, status_reg);
1291 * Even if OWNER is set, there's no harm letting khubd
1292 * see the wPortStatus values (they should all be 0 except
1293 * for PORT_POWER anyway).
1296 if (temp & PORT_CONNECT) {
1297 status |= USB_PORT_STAT_CONNECTION;
1298 // status may be from integrated TT
1299 if (ehci->has_hostpc) {
1300 temp1 = ehci_readl(ehci, hostpc_reg);
1301 status |= ehci_port_speed(ehci, temp1);
1303 status |= ehci_port_speed(ehci, temp);
1306 status |= USB_PORT_STAT_ENABLE;
1308 /* maybe the port was unsuspended without our knowledge */
1309 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
1310 status |= USB_PORT_STAT_SUSPEND;
1311 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
1312 clear_bit(wIndex, &ehci->suspended_ports);
1313 ehci->reset_done[wIndex] = 0;
1315 set_bit(wIndex, &ehci->port_c_suspend);
1319 status |= USB_PORT_STAT_OVERCURRENT;
1320 if (temp & PORT_RESET)
1321 status |= USB_PORT_STAT_RESET;
1322 if (temp & PORT_POWER)
1323 status |= USB_PORT_STAT_POWER;
1324 if (test_bit(wIndex, &ehci->port_c_suspend))
1325 status |= USB_PORT_STAT_C_SUSPEND << 16;
1327 #ifndef VERBOSE_DEBUG
1328 if (status & ~0xffff) /* only if wPortChange is interesting */
1330 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
1331 put_unaligned_le32(status, buf);
1335 case C_HUB_LOCAL_POWER:
1336 case C_HUB_OVER_CURRENT:
1337 /* no hub-wide feature/status flags */
1343 case SetPortFeature:
1344 selector = wIndex >> 8;
1346 if (unlikely(ehci->debug)) {
1347 /* If the debug port is active any port
1348 * feature requests should get denied */
1349 if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1350 (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1355 if (!wIndex || wIndex > ports)
1358 temp = ehci_readl(ehci, status_reg);
1359 if (temp & PORT_OWNER)
1362 temp &= ~PORT_RWC_BITS;
1364 case USB_PORT_FEAT_SUSPEND:
1365 if (ehci->no_selective_suspend)
1367 if ((temp & PORT_PE) == 0
1368 || (temp & PORT_RESET) != 0)
1371 /* After above check the port must be connected.
1372 * Set appropriate bit thus could put phy into low power
1373 * mode if we have hostpc feature
1375 temp &= ~PORT_WKCONN_E;
1376 temp |= PORT_WKDISC_E | PORT_WKOC_E;
1377 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1379 spin_unlock_irqrestore(&ehci->lock, flags);
1380 msleep(5);/* 5ms for HCD enter low pwr mode */
1381 spin_lock_irqsave(&ehci->lock, flags);
1382 temp1 = ehci_readl(ehci, hostpc_reg);
1383 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1385 temp1 = ehci_readl(ehci, hostpc_reg);
1386 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1387 wIndex, (temp1 & HOSTPC_PHCD) ?
1388 "succeeded" : "failed");
1390 set_bit(wIndex, &ehci->suspended_ports);
1392 case USB_PORT_FEAT_POWER:
1393 if (HCS_PPC (ehci->hcs_params))
1394 ehci_writel(ehci, temp | PORT_POWER,
1397 case USB_PORT_FEAT_RESET:
1398 if (temp & PORT_RESUME)
1400 /* line status bits may report this as low speed,
1401 * which can be fine if this root hub has a
1402 * transaction translator built in.
1404 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1405 && !ehci_is_TDI(ehci)
1406 && PORT_USB11 (temp)) {
1408 "port %d low speed --> companion\n",
1412 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
1417 * caller must wait, then call GetPortStatus
1418 * usb 2.0 spec says 50 ms resets on root
1420 ehci->reset_done [wIndex] = jiffies
1421 + msecs_to_jiffies (50);
1423 ehci_writel(ehci, temp, status_reg);
1426 /* For downstream facing ports (these): one hub port is put
1427 * into test mode according to USB2 11.24.2.13, then the hub
1428 * must be reset (which for root hub now means rmmod+modprobe,
1429 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
1430 * about the EHCI-specific stuff.
1432 #ifdef CONFIG_HOST_COMPLIANT_TEST
1433 case USB_PORT_FEAT_TEST:
1434 ehci_info (ehci, "TEST MODE !!!!!!!! selector == 0x%x \n",selector);
1436 ehci_info (ehci, "running EHCI test %x on port %x\n",
1439 retval = ehci_port_test(hcd, selector & 0xFF, wIndex, flags);
1441 ehci_info (ehci, "EHCI test Fail!!\n");
1448 temp |= selector << 16;
1449 ehci_writel(ehci, temp, status_reg);
1455 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
1460 /* "stall" on error */
1464 spin_unlock_irqrestore (&ehci->lock, flags);
1468 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1470 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1472 if (ehci_is_TDI(ehci))
1474 set_owner(ehci, --portnum, PORT_OWNER);
1477 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1479 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
1482 if (ehci_is_TDI(ehci))
1484 reg = &ehci->regs->port_status[portnum - 1];
1485 return ehci_readl(ehci, reg) & PORT_OWNER;