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 /*-------------------------------------------------------------------------*/
33 static int ehci_bus_suspend (struct usb_hcd *hcd)
35 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
39 if (time_before (jiffies, ehci->next_statechange))
42 port = HCS_N_PORTS (ehci->hcs_params);
43 spin_lock_irq (&ehci->lock);
45 /* stop schedules, clean any completed work */
46 if (HC_IS_RUNNING(hcd->state)) {
48 hcd->state = HC_STATE_QUIESCING;
50 ehci->command = ehci_readl(ehci, &ehci->regs->command);
52 ehci->reclaim_ready = 1;
55 /* Unlike other USB host controller types, EHCI doesn't have
56 * any notion of "global" or bus-wide suspend. The driver has
57 * to manually suspend all the active unsuspended ports, and
58 * then manually resume them in the bus_resume() routine.
60 ehci->bus_suspended = 0;
62 u32 __iomem *reg = &ehci->regs->port_status [port];
63 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
66 /* keep track of which ports we suspend */
67 if ((t1 & PORT_PE) && !(t1 & PORT_OWNER) &&
68 !(t1 & PORT_SUSPEND)) {
70 set_bit(port, &ehci->bus_suspended);
73 /* enable remote wakeup on all ports */
74 if (device_may_wakeup(&hcd->self.root_hub->dev))
75 t2 |= PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E;
77 t2 &= ~(PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E);
80 ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
82 ehci_writel(ehci, t2, reg);
86 /* turn off now-idle HC */
87 del_timer_sync (&ehci->watchdog);
89 hcd->state = HC_STATE_SUSPENDED;
91 /* allow remote wakeup */
93 if (!device_may_wakeup(&hcd->self.root_hub->dev))
95 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
96 ehci_readl(ehci, &ehci->regs->intr_enable);
98 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
99 spin_unlock_irq (&ehci->lock);
104 /* caller has locked the root hub, and should reset/reinit on error */
105 static int ehci_bus_resume (struct usb_hcd *hcd)
107 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
111 if (time_before (jiffies, ehci->next_statechange))
113 spin_lock_irq (&ehci->lock);
115 /* Ideally and we've got a real resume here, and no port's power
116 * was lost. (For PCI, that means Vaux was maintained.) But we
117 * could instead be restoring a swsusp snapshot -- so that BIOS was
118 * the last user of the controller, not reset/pm hardware keeping
119 * state we gave to it.
121 temp = ehci_readl(ehci, &ehci->regs->intr_enable);
122 ehci_dbg(ehci, "resume root hub%s\n", temp ? "" : " after power loss");
124 /* at least some APM implementations will try to deliver
125 * IRQs right away, so delay them until we're ready.
127 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
129 /* re-init operational registers */
130 ehci_writel(ehci, 0, &ehci->regs->segment);
131 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
132 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
134 /* restore CMD_RUN, framelist size, and irq threshold */
135 ehci_writel(ehci, ehci->command, &ehci->regs->command);
137 /* manually resume the ports we suspended during bus_suspend() */
138 i = HCS_N_PORTS (ehci->hcs_params);
140 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
141 temp &= ~(PORT_RWC_BITS
142 | PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E);
143 if (test_bit(i, &ehci->bus_suspended) &&
144 (temp & PORT_SUSPEND)) {
145 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
148 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
150 i = HCS_N_PORTS (ehci->hcs_params);
153 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
154 if (test_bit(i, &ehci->bus_suspended) &&
155 (temp & PORT_SUSPEND)) {
156 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
157 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
158 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
161 (void) ehci_readl(ehci, &ehci->regs->command);
163 /* maybe re-activate the schedule(s) */
165 if (ehci->async->qh_next.qh)
167 if (ehci->periodic_sched)
170 ehci->command |= temp;
171 ehci_writel(ehci, ehci->command, &ehci->regs->command);
174 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
175 hcd->state = HC_STATE_RUNNING;
177 /* Now we can safely re-enable irqs */
178 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
180 spin_unlock_irq (&ehci->lock);
186 #define ehci_bus_suspend NULL
187 #define ehci_bus_resume NULL
189 #endif /* CONFIG_PM */
191 /*-------------------------------------------------------------------------*/
193 static int check_reset_complete (
194 struct ehci_hcd *ehci,
196 u32 __iomem *status_reg,
199 if (!(port_status & PORT_CONNECT)) {
200 ehci->reset_done [index] = 0;
204 /* if reset finished and it's still not enabled -- handoff */
205 if (!(port_status & PORT_PE)) {
207 /* with integrated TT, there's nobody to hand it to! */
208 if (ehci_is_TDI(ehci)) {
210 "Failed to enable port %d on root hub TT\n",
215 ehci_dbg (ehci, "port %d full speed --> companion\n",
218 // what happens if HCS_N_CC(params) == 0 ?
219 port_status |= PORT_OWNER;
220 port_status &= ~PORT_RWC_BITS;
221 ehci_writel(ehci, port_status, status_reg);
224 ehci_dbg (ehci, "port %d high speed\n", index + 1);
229 /*-------------------------------------------------------------------------*/
232 /* build "status change" packet (one or two bytes) from HC registers */
235 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
237 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
238 u32 temp, status = 0;
240 int ports, i, retval = 1;
243 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
244 if (!HC_IS_RUNNING(hcd->state))
247 /* init status to no-changes */
249 ports = HCS_N_PORTS (ehci->hcs_params);
255 /* Some boards (mostly VIA?) report bogus overcurrent indications,
256 * causing massive log spam unless we completely ignore them. It
257 * may be relevant that VIA VT8235 controlers, where PORT_POWER is
258 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
259 * PORT_POWER; that's surprising, but maybe within-spec.
262 mask = PORT_CSC | PORT_PEC | PORT_OCC;
264 mask = PORT_CSC | PORT_PEC;
265 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
267 /* no hub change reports (bit 0) for now (power, ...) */
269 /* port N changes (bit N)? */
270 spin_lock_irqsave (&ehci->lock, flags);
271 for (i = 0; i < ports; i++) {
272 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
273 if (temp & PORT_OWNER) {
274 /* don't report this in GetPortStatus */
275 if (temp & PORT_CSC) {
276 temp &= ~PORT_RWC_BITS;
278 ehci_writel(ehci, temp,
279 &ehci->regs->port_status [i]);
283 if (!(temp & PORT_CONNECT))
284 ehci->reset_done [i] = 0;
285 if ((temp & mask) != 0
286 || ((temp & PORT_RESUME) != 0
287 && time_after (jiffies,
288 ehci->reset_done [i]))) {
290 buf [0] |= 1 << (i + 1);
292 buf [1] |= 1 << (i - 7);
296 /* FIXME autosuspend idle root hubs */
297 spin_unlock_irqrestore (&ehci->lock, flags);
298 return status ? retval : 0;
301 /*-------------------------------------------------------------------------*/
304 ehci_hub_descriptor (
305 struct ehci_hcd *ehci,
306 struct usb_hub_descriptor *desc
308 int ports = HCS_N_PORTS (ehci->hcs_params);
311 desc->bDescriptorType = 0x29;
312 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
313 desc->bHubContrCurrent = 0;
315 desc->bNbrPorts = ports;
316 temp = 1 + (ports / 8);
317 desc->bDescLength = 7 + 2 * temp;
319 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
320 memset (&desc->bitmap [0], 0, temp);
321 memset (&desc->bitmap [temp], 0xff, temp);
323 temp = 0x0008; /* per-port overcurrent reporting */
324 if (HCS_PPC (ehci->hcs_params))
325 temp |= 0x0001; /* per-port power control */
327 temp |= 0x0002; /* no power switching */
329 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
330 if (HCS_INDICATOR (ehci->hcs_params))
331 temp |= 0x0080; /* per-port indicators (LEDs) */
333 desc->wHubCharacteristics = (__force __u16)cpu_to_le16 (temp);
336 /*-------------------------------------------------------------------------*/
338 #define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
340 static int ehci_hub_control (
348 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
349 int ports = HCS_N_PORTS (ehci->hcs_params);
350 u32 __iomem *status_reg = &ehci->regs->port_status[wIndex - 1];
357 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
358 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
359 * (track current state ourselves) ... blink for diagnostics,
360 * power, "this is the one", etc. EHCI spec supports this.
363 spin_lock_irqsave (&ehci->lock, flags);
365 case ClearHubFeature:
367 case C_HUB_LOCAL_POWER:
368 case C_HUB_OVER_CURRENT:
369 /* no hub-wide feature/status flags */
375 case ClearPortFeature:
376 if (!wIndex || wIndex > ports)
379 temp = ehci_readl(ehci, status_reg);
380 if (temp & PORT_OWNER)
384 case USB_PORT_FEAT_ENABLE:
385 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
387 case USB_PORT_FEAT_C_ENABLE:
388 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
391 case USB_PORT_FEAT_SUSPEND:
392 if (temp & PORT_RESET)
394 if (ehci->no_selective_suspend)
396 if (temp & PORT_SUSPEND) {
397 if ((temp & PORT_PE) == 0)
399 /* resume signaling for 20 msec */
400 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
401 ehci_writel(ehci, temp | PORT_RESUME,
403 ehci->reset_done [wIndex] = jiffies
404 + msecs_to_jiffies (20);
407 case USB_PORT_FEAT_C_SUSPEND:
408 /* we auto-clear this feature */
410 case USB_PORT_FEAT_POWER:
411 if (HCS_PPC (ehci->hcs_params))
413 temp & ~(PORT_RWC_BITS | PORT_POWER),
416 case USB_PORT_FEAT_C_CONNECTION:
417 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
420 case USB_PORT_FEAT_C_OVER_CURRENT:
421 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
424 case USB_PORT_FEAT_C_RESET:
425 /* GetPortStatus clears reset */
430 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
432 case GetHubDescriptor:
433 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
437 /* no hub-wide feature/status flags */
439 //cpu_to_le32s ((u32 *) buf);
442 if (!wIndex || wIndex > ports)
446 temp = ehci_readl(ehci, status_reg);
450 status |= 1 << USB_PORT_FEAT_C_CONNECTION;
452 status |= 1 << USB_PORT_FEAT_C_ENABLE;
453 if ((temp & PORT_OCC) && !ignore_oc)
454 status |= 1 << USB_PORT_FEAT_C_OVER_CURRENT;
456 /* whoever resumes must GetPortStatus to complete it!! */
457 if ((temp & PORT_RESUME)
458 && time_after (jiffies,
459 ehci->reset_done [wIndex])) {
460 status |= 1 << USB_PORT_FEAT_C_SUSPEND;
461 ehci->reset_done [wIndex] = 0;
463 /* stop resume signaling */
464 temp = ehci_readl(ehci, status_reg);
466 temp & ~(PORT_RWC_BITS | PORT_RESUME),
468 retval = handshake(ehci, status_reg,
469 PORT_RESUME, 0, 2000 /* 2msec */);
471 ehci_err (ehci, "port %d resume error %d\n",
475 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
478 /* whoever resets must GetPortStatus to complete it!! */
479 if ((temp & PORT_RESET)
480 && time_after (jiffies,
481 ehci->reset_done [wIndex])) {
482 status |= 1 << USB_PORT_FEAT_C_RESET;
483 ehci->reset_done [wIndex] = 0;
485 /* force reset to complete */
486 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
488 /* REVISIT: some hardware needs 550+ usec to clear
489 * this bit; seems too long to spin routinely...
491 retval = handshake(ehci, status_reg,
494 ehci_err (ehci, "port %d reset error %d\n",
499 /* see what we found out */
500 temp = check_reset_complete (ehci, wIndex, status_reg,
501 ehci_readl(ehci, status_reg));
504 // don't show wPortStatus if it's owned by a companion hc
505 if (!(temp & PORT_OWNER)) {
506 if (temp & PORT_CONNECT) {
507 status |= 1 << USB_PORT_FEAT_CONNECTION;
508 // status may be from integrated TT
509 status |= ehci_port_speed(ehci, temp);
512 status |= 1 << USB_PORT_FEAT_ENABLE;
513 if (temp & (PORT_SUSPEND|PORT_RESUME))
514 status |= 1 << USB_PORT_FEAT_SUSPEND;
516 status |= 1 << USB_PORT_FEAT_OVER_CURRENT;
517 if (temp & PORT_RESET)
518 status |= 1 << USB_PORT_FEAT_RESET;
519 if (temp & PORT_POWER)
520 status |= 1 << USB_PORT_FEAT_POWER;
523 #ifndef EHCI_VERBOSE_DEBUG
524 if (status & ~0xffff) /* only if wPortChange is interesting */
526 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
527 // we "know" this alignment is good, caller used kmalloc()...
528 *((__le32 *) buf) = cpu_to_le32 (status);
532 case C_HUB_LOCAL_POWER:
533 case C_HUB_OVER_CURRENT:
534 /* no hub-wide feature/status flags */
541 selector = wIndex >> 8;
543 if (!wIndex || wIndex > ports)
546 temp = ehci_readl(ehci, status_reg);
547 if (temp & PORT_OWNER)
550 temp &= ~PORT_RWC_BITS;
552 case USB_PORT_FEAT_SUSPEND:
553 if (ehci->no_selective_suspend)
555 if ((temp & PORT_PE) == 0
556 || (temp & PORT_RESET) != 0)
558 if (device_may_wakeup(&hcd->self.root_hub->dev))
559 temp |= PORT_WAKE_BITS;
560 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
562 case USB_PORT_FEAT_POWER:
563 if (HCS_PPC (ehci->hcs_params))
564 ehci_writel(ehci, temp | PORT_POWER,
567 case USB_PORT_FEAT_RESET:
568 if (temp & PORT_RESUME)
570 /* line status bits may report this as low speed,
571 * which can be fine if this root hub has a
572 * transaction translator built in.
574 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
575 && !ehci_is_TDI(ehci)
576 && PORT_USB11 (temp)) {
578 "port %d low speed --> companion\n",
582 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
587 * caller must wait, then call GetPortStatus
588 * usb 2.0 spec says 50 ms resets on root
590 ehci->reset_done [wIndex] = jiffies
591 + msecs_to_jiffies (50);
593 ehci_writel(ehci, temp, status_reg);
596 /* For downstream facing ports (these): one hub port is put
597 * into test mode according to USB2 11.24.2.13, then the hub
598 * must be reset (which for root hub now means rmmod+modprobe,
599 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
600 * about the EHCI-specific stuff.
602 case USB_PORT_FEAT_TEST:
603 if (!selector || selector > 5)
607 temp |= selector << 16;
608 ehci_writel(ehci, temp, status_reg);
614 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
619 /* "stall" on error */
622 spin_unlock_irqrestore (&ehci->lock, flags);