blob: efffef64f59daf68ecc80d571921cbb10f8a566e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Brownelld49d4312005-05-07 13:21:50 -07002 * Copyright (C) 2001-2004 by David Brownell
David Brownell53bd6a62006-08-30 14:50:06 -07003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * 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.
8 *
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.
13 *
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.
17 */
18
19/* this file is part of ehci-hcd.c */
20
21/*-------------------------------------------------------------------------*/
22
23/*
24 * EHCI Root Hub ... the nonsharable stuff
25 *
26 * Registers don't need cpu_to_le32, that happens transparently
27 */
28
29/*-------------------------------------------------------------------------*/
30
Alan Stern58a97ff2008-04-14 12:17:10 -040031#define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
32
Alan Sternaff6d182008-04-18 11:11:26 -040033#ifdef CONFIG_PM
34
Alan Stern383975d2007-05-04 11:52:40 -040035static int ehci_hub_control(
36 struct usb_hcd *hcd,
37 u16 typeReq,
38 u16 wValue,
39 u16 wIndex,
40 char *buf,
41 u16 wLength
42);
43
44/* After a power loss, ports that were owned by the companion must be
45 * reset so that the companion can still own them.
46 */
47static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
48{
49 u32 __iomem *reg;
50 u32 status;
51 int port;
52 __le32 buf;
53 struct usb_hcd *hcd = ehci_to_hcd(ehci);
54
55 if (!ehci->owned_ports)
56 return;
57
58 /* Give the connections some time to appear */
59 msleep(20);
60
61 port = HCS_N_PORTS(ehci->hcs_params);
62 while (port--) {
63 if (test_bit(port, &ehci->owned_ports)) {
64 reg = &ehci->regs->port_status[port];
Alan Stern3c519b82007-05-04 11:55:31 -040065 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
Alan Stern383975d2007-05-04 11:52:40 -040066
67 /* Port already owned by companion? */
68 if (status & PORT_OWNER)
69 clear_bit(port, &ehci->owned_ports);
Alan Stern3c519b82007-05-04 11:55:31 -040070 else if (test_bit(port, &ehci->companion_ports))
71 ehci_writel(ehci, status & ~PORT_PE, reg);
Alan Stern383975d2007-05-04 11:52:40 -040072 else
73 ehci_hub_control(hcd, SetPortFeature,
74 USB_PORT_FEAT_RESET, port + 1,
75 NULL, 0);
76 }
77 }
78
79 if (!ehci->owned_ports)
80 return;
81 msleep(90); /* Wait for resets to complete */
82
83 port = HCS_N_PORTS(ehci->hcs_params);
84 while (port--) {
85 if (test_bit(port, &ehci->owned_ports)) {
86 ehci_hub_control(hcd, GetPortStatus,
87 0, port + 1,
88 (char *) &buf, sizeof(buf));
89
90 /* The companion should now own the port,
91 * but if something went wrong the port must not
92 * remain enabled.
93 */
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);
98 else {
99 ehci_dbg(ehci, "failed handover port %d: %x\n",
100 port + 1, status);
101 ehci_writel(ehci, status & ~PORT_PE, reg);
102 }
103 }
104 }
105
106 ehci->owned_ports = 0;
107}
108
Alan Stern0c0382e2005-10-13 17:08:02 -0400109static int ehci_bus_suspend (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
111 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
112 int port;
Alan Stern8c033562006-11-09 14:42:16 -0500113 int mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Alan Stern8c774fe2007-02-01 16:09:59 -0500115 ehci_dbg(ehci, "suspend root hub\n");
116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 if (time_before (jiffies, ehci->next_statechange))
118 msleep(5);
Alan Sternf8fa7572008-01-10 16:43:15 -0500119 del_timer_sync(&ehci->watchdog);
120 del_timer_sync(&ehci->iaa_watchdog);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122 port = HCS_N_PORTS (ehci->hcs_params);
123 spin_lock_irq (&ehci->lock);
124
125 /* stop schedules, clean any completed work */
126 if (HC_IS_RUNNING(hcd->state)) {
127 ehci_quiesce (ehci);
128 hcd->state = HC_STATE_QUIESCING;
129 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100130 ehci->command = ehci_readl(ehci, &ehci->regs->command);
David Howells7d12e782006-10-05 14:55:46 +0100131 ehci_work(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Alan Stern8c033562006-11-09 14:42:16 -0500133 /* Unlike other USB host controller types, EHCI doesn't have
134 * any notion of "global" or bus-wide suspend. The driver has
135 * to manually suspend all the active unsuspended ports, and
136 * then manually resume them in the bus_resume() routine.
137 */
138 ehci->bus_suspended = 0;
Alan Stern383975d2007-05-04 11:52:40 -0400139 ehci->owned_ports = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 while (port--) {
141 u32 __iomem *reg = &ehci->regs->port_status [port];
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100142 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 u32 t2 = t1;
144
Alan Stern8c033562006-11-09 14:42:16 -0500145 /* keep track of which ports we suspend */
Alan Stern383975d2007-05-04 11:52:40 -0400146 if (t1 & PORT_OWNER)
147 set_bit(port, &ehci->owned_ports);
148 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 t2 |= PORT_SUSPEND;
Alan Stern8c033562006-11-09 14:42:16 -0500150 set_bit(port, &ehci->bus_suspended);
151 }
152
153 /* enable remote wakeup on all ports */
Alan Stern58a97ff2008-04-14 12:17:10 -0400154 if (hcd->self.root_hub->do_remote_wakeup)
155 t2 |= PORT_WAKE_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 else
Alan Stern58a97ff2008-04-14 12:17:10 -0400157 t2 &= ~PORT_WAKE_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159 if (t1 != t2) {
160 ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
161 port + 1, t1, t2);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100162 ehci_writel(ehci, t2, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 }
164 }
165
Alan Sterncd930c92008-01-10 11:14:53 -0500166 /* Apparently some devices need a >= 1-uframe delay here */
167 if (ehci->bus_suspended)
168 udelay(150);
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 /* turn off now-idle HC */
171 ehci_halt (ehci);
172 hcd->state = HC_STATE_SUSPENDED;
173
David Brownellcdc647a2008-04-02 13:40:20 -0700174 if (ehci->reclaim)
175 end_unlink_async(ehci);
176
Alan Stern8c033562006-11-09 14:42:16 -0500177 /* allow remote wakeup */
178 mask = INTR_MASK;
Alan Stern58a97ff2008-04-14 12:17:10 -0400179 if (!hcd->self.root_hub->do_remote_wakeup)
Alan Stern8c033562006-11-09 14:42:16 -0500180 mask &= ~STS_PCD;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100181 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
182 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
185 spin_unlock_irq (&ehci->lock);
186 return 0;
187}
188
189
190/* caller has locked the root hub, and should reset/reinit on error */
Alan Stern0c0382e2005-10-13 17:08:02 -0400191static int ehci_bus_resume (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192{
193 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
194 u32 temp;
Alan Stern383975d2007-05-04 11:52:40 -0400195 u32 power_okay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 if (time_before (jiffies, ehci->next_statechange))
199 msleep(5);
200 spin_lock_irq (&ehci->lock);
Alan Sterncfa59da2007-06-21 16:25:35 -0400201 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
202 spin_unlock_irq(&ehci->lock);
203 return -ESHUTDOWN;
204 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
David Brownellf03c17f2005-11-23 15:45:28 -0800206 /* Ideally and we've got a real resume here, and no port's power
207 * was lost. (For PCI, that means Vaux was maintained.) But we
208 * could instead be restoring a swsusp snapshot -- so that BIOS was
209 * the last user of the controller, not reset/pm hardware keeping
210 * state we gave to it.
211 */
Alan Stern383975d2007-05-04 11:52:40 -0400212 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
213 ehci_dbg(ehci, "resume root hub%s\n",
214 power_okay ? "" : " after power loss");
David Brownellf03c17f2005-11-23 15:45:28 -0800215
Alan Stern8c033562006-11-09 14:42:16 -0500216 /* at least some APM implementations will try to deliver
217 * IRQs right away, so delay them until we're ready.
218 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100219 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500220
221 /* re-init operational registers */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100222 ehci_writel(ehci, 0, &ehci->regs->segment);
223 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
224 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226 /* restore CMD_RUN, framelist size, and irq threshold */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100227 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Alan Sterne198a312007-03-15 15:54:30 -0400229 /* Some controller/firmware combinations need a delay during which
230 * they set up the port statuses. See Bugzilla #8190. */
231 mdelay(8);
232
Alan Stern8c033562006-11-09 14:42:16 -0500233 /* manually resume the ports we suspended during bus_suspend() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 i = HCS_N_PORTS (ehci->hcs_params);
235 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100236 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern58a97ff2008-04-14 12:17:10 -0400237 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
Alan Stern8c033562006-11-09 14:42:16 -0500238 if (test_bit(i, &ehci->bus_suspended) &&
239 (temp & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
241 temp |= PORT_RESUME;
242 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100243 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 }
245 i = HCS_N_PORTS (ehci->hcs_params);
246 mdelay (20);
247 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100248 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500249 if (test_bit(i, &ehci->bus_suspended) &&
250 (temp & PORT_SUSPEND)) {
251 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100252 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500253 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
254 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100256 (void) ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258 /* maybe re-activate the schedule(s) */
259 temp = 0;
260 if (ehci->async->qh_next.qh)
261 temp |= CMD_ASE;
262 if (ehci->periodic_sched)
263 temp |= CMD_PSE;
264 if (temp) {
265 ehci->command |= temp;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100266 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 }
268
269 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
270 hcd->state = HC_STATE_RUNNING;
271
272 /* Now we can safely re-enable irqs */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100273 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275 spin_unlock_irq (&ehci->lock);
Alan Stern3bb1af52008-03-03 15:15:36 -0500276 ehci_handover_companion_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 return 0;
278}
279
280#else
281
Alan Stern0c0382e2005-10-13 17:08:02 -0400282#define ehci_bus_suspend NULL
283#define ehci_bus_resume NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285#endif /* CONFIG_PM */
286
287/*-------------------------------------------------------------------------*/
288
Alan Stern57e06c12007-01-16 11:59:45 -0500289/* Display the ports dedicated to the companion controller */
Tony Jones5a3201b2007-09-11 14:07:31 -0700290static ssize_t show_companion(struct device *dev,
291 struct device_attribute *attr,
292 char *buf)
Alan Stern57e06c12007-01-16 11:59:45 -0500293{
294 struct ehci_hcd *ehci;
295 int nports, index, n;
296 int count = PAGE_SIZE;
297 char *ptr = buf;
298
Tony Jones5a3201b2007-09-11 14:07:31 -0700299 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
Alan Stern57e06c12007-01-16 11:59:45 -0500300 nports = HCS_N_PORTS(ehci->hcs_params);
301
302 for (index = 0; index < nports; ++index) {
303 if (test_bit(index, &ehci->companion_ports)) {
304 n = scnprintf(ptr, count, "%d\n", index + 1);
305 ptr += n;
306 count -= n;
307 }
308 }
309 return ptr - buf;
310}
311
312/*
Balaji Rao90da0962007-11-22 01:58:14 +0530313 * Sets the owner of a port
Alan Stern57e06c12007-01-16 11:59:45 -0500314 */
Balaji Rao90da0962007-11-22 01:58:14 +0530315static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
Alan Stern57e06c12007-01-16 11:59:45 -0500316{
Alan Stern57e06c12007-01-16 11:59:45 -0500317 u32 __iomem *status_reg;
318 u32 port_status;
Balaji Rao90da0962007-11-22 01:58:14 +0530319 int try;
Alan Stern57e06c12007-01-16 11:59:45 -0500320
Balaji Rao90da0962007-11-22 01:58:14 +0530321 status_reg = &ehci->regs->port_status[portnum];
Alan Stern57e06c12007-01-16 11:59:45 -0500322
323 /*
324 * The controller won't set the OWNER bit if the port is
325 * enabled, so this loop will sometimes require at least two
326 * iterations: one to disable the port and one to set OWNER.
327 */
Alan Stern57e06c12007-01-16 11:59:45 -0500328 for (try = 4; try > 0; --try) {
329 spin_lock_irq(&ehci->lock);
330 port_status = ehci_readl(ehci, status_reg);
331 if ((port_status & PORT_OWNER) == new_owner
332 || (port_status & (PORT_OWNER | PORT_CONNECT))
333 == 0)
334 try = 0;
335 else {
336 port_status ^= PORT_OWNER;
337 port_status &= ~(PORT_PE | PORT_RWC_BITS);
338 ehci_writel(ehci, port_status, status_reg);
339 }
340 spin_unlock_irq(&ehci->lock);
341 if (try > 1)
342 msleep(5);
343 }
Balaji Rao90da0962007-11-22 01:58:14 +0530344}
345
346/*
347 * Dedicate or undedicate a port to the companion controller.
348 * Syntax is "[-]portnum", where a leading '-' sign means
349 * return control of the port to the EHCI controller.
350 */
351static ssize_t store_companion(struct device *dev,
352 struct device_attribute *attr,
353 const char *buf, size_t count)
354{
355 struct ehci_hcd *ehci;
356 int portnum, new_owner;
357
358 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
359 new_owner = PORT_OWNER; /* Owned by companion */
360 if (sscanf(buf, "%d", &portnum) != 1)
361 return -EINVAL;
362 if (portnum < 0) {
363 portnum = - portnum;
364 new_owner = 0; /* Owned by EHCI */
365 }
366 if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
367 return -ENOENT;
368 portnum--;
369 if (new_owner)
370 set_bit(portnum, &ehci->companion_ports);
371 else
372 clear_bit(portnum, &ehci->companion_ports);
373 set_owner(ehci, portnum, new_owner);
Alan Stern57e06c12007-01-16 11:59:45 -0500374 return count;
375}
Tony Jones5a3201b2007-09-11 14:07:31 -0700376static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500377
378static inline void create_companion_file(struct ehci_hcd *ehci)
379{
380 int i;
381
382 /* with integrated TT there is no companion! */
383 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700384 i = device_create_file(ehci_to_hcd(ehci)->self.dev,
385 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500386}
387
388static inline void remove_companion_file(struct ehci_hcd *ehci)
389{
390 /* with integrated TT there is no companion! */
391 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700392 device_remove_file(ehci_to_hcd(ehci)->self.dev,
393 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500394}
395
396
397/*-------------------------------------------------------------------------*/
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399static int check_reset_complete (
400 struct ehci_hcd *ehci,
401 int index,
Alan Sterne6316562007-01-16 11:58:00 -0500402 u32 __iomem *status_reg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 int port_status
404) {
David Brownellcd4cdc92008-01-24 12:39:43 -0800405 if (!(port_status & PORT_CONNECT))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 return port_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408 /* if reset finished and it's still not enabled -- handoff */
409 if (!(port_status & PORT_PE)) {
410
411 /* with integrated TT, there's nobody to hand it to! */
412 if (ehci_is_TDI(ehci)) {
413 ehci_dbg (ehci,
414 "Failed to enable port %d on root hub TT\n",
415 index+1);
416 return port_status;
417 }
418
419 ehci_dbg (ehci, "port %d full speed --> companion\n",
420 index + 1);
421
422 // what happens if HCS_N_CC(params) == 0 ?
423 port_status |= PORT_OWNER;
David Brownell10f65242005-08-31 10:55:38 -0700424 port_status &= ~PORT_RWC_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500425 ehci_writel(ehci, port_status, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427 } else
428 ehci_dbg (ehci, "port %d high speed\n", index + 1);
429
430 return port_status;
431}
432
433/*-------------------------------------------------------------------------*/
434
435
436/* build "status change" packet (one or two bytes) from HC registers */
437
438static int
439ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
440{
441 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
442 u32 temp, status = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800443 u32 mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 int ports, i, retval = 1;
445 unsigned long flags;
446
447 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
448 if (!HC_IS_RUNNING(hcd->state))
449 return 0;
450
451 /* init status to no-changes */
452 buf [0] = 0;
453 ports = HCS_N_PORTS (ehci->hcs_params);
454 if (ports > 7) {
455 buf [1] = 0;
456 retval++;
457 }
David Brownell53bd6a62006-08-30 14:50:06 -0700458
David Brownell93f1a472006-11-16 23:34:58 -0800459 /* Some boards (mostly VIA?) report bogus overcurrent indications,
460 * causing massive log spam unless we completely ignore them. It
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200461 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
David Brownell93f1a472006-11-16 23:34:58 -0800462 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
463 * PORT_POWER; that's surprising, but maybe within-spec.
464 */
465 if (!ignore_oc)
466 mask = PORT_CSC | PORT_PEC | PORT_OCC;
467 else
468 mask = PORT_CSC | PORT_PEC;
469 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 /* no hub change reports (bit 0) for now (power, ...) */
472
473 /* port N changes (bit N)? */
474 spin_lock_irqsave (&ehci->lock, flags);
475 for (i = 0; i < ports; i++) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100476 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern625b5c92007-01-16 11:58:47 -0500477
478 /*
479 * Return status information even for ports with OWNER set.
480 * Otherwise khubd wouldn't see the disconnect event when a
481 * high-speed device is switched over to the companion
482 * controller by the user.
483 */
484
David Brownell93f1a472006-11-16 23:34:58 -0800485 if ((temp & mask) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 || ((temp & PORT_RESUME) != 0
Alan Stern629e4427a2007-01-22 16:08:53 -0500487 && time_after_eq(jiffies,
488 ehci->reset_done[i]))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 if (i < 7)
490 buf [0] |= 1 << (i + 1);
491 else
492 buf [1] |= 1 << (i - 7);
493 status = STS_PCD;
494 }
495 }
496 /* FIXME autosuspend idle root hubs */
497 spin_unlock_irqrestore (&ehci->lock, flags);
498 return status ? retval : 0;
499}
500
501/*-------------------------------------------------------------------------*/
502
503static void
504ehci_hub_descriptor (
505 struct ehci_hcd *ehci,
506 struct usb_hub_descriptor *desc
507) {
508 int ports = HCS_N_PORTS (ehci->hcs_params);
509 u16 temp;
510
511 desc->bDescriptorType = 0x29;
512 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
513 desc->bHubContrCurrent = 0;
514
515 desc->bNbrPorts = ports;
516 temp = 1 + (ports / 8);
517 desc->bDescLength = 7 + 2 * temp;
518
519 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
520 memset (&desc->bitmap [0], 0, temp);
521 memset (&desc->bitmap [temp], 0xff, temp);
522
523 temp = 0x0008; /* per-port overcurrent reporting */
524 if (HCS_PPC (ehci->hcs_params))
525 temp |= 0x0001; /* per-port power control */
David Brownell56c1e262005-04-09 09:00:29 -0700526 else
527 temp |= 0x0002; /* no power switching */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528#if 0
529// re-enable when we support USB_PORT_FEAT_INDICATOR below.
530 if (HCS_INDICATOR (ehci->hcs_params))
531 temp |= 0x0080; /* per-port indicators (LEDs) */
532#endif
533 desc->wHubCharacteristics = (__force __u16)cpu_to_le16 (temp);
534}
535
536/*-------------------------------------------------------------------------*/
537
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538static int ehci_hub_control (
539 struct usb_hcd *hcd,
540 u16 typeReq,
541 u16 wValue,
542 u16 wIndex,
543 char *buf,
544 u16 wLength
545) {
546 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
547 int ports = HCS_N_PORTS (ehci->hcs_params);
Alan Stern383975d2007-05-04 11:52:40 -0400548 u32 __iomem *status_reg = &ehci->regs->port_status[
549 (wIndex & 0xff) - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 u32 temp, status;
551 unsigned long flags;
552 int retval = 0;
David Brownellf0d7f272006-11-16 23:56:15 -0800553 unsigned selector;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
555 /*
556 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
557 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
558 * (track current state ourselves) ... blink for diagnostics,
559 * power, "this is the one", etc. EHCI spec supports this.
560 */
561
562 spin_lock_irqsave (&ehci->lock, flags);
563 switch (typeReq) {
564 case ClearHubFeature:
565 switch (wValue) {
566 case C_HUB_LOCAL_POWER:
567 case C_HUB_OVER_CURRENT:
568 /* no hub-wide feature/status flags */
569 break;
570 default:
571 goto error;
572 }
573 break;
574 case ClearPortFeature:
575 if (!wIndex || wIndex > ports)
576 goto error;
577 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500578 temp = ehci_readl(ehci, status_reg);
Alan Stern625b5c92007-01-16 11:58:47 -0500579
580 /*
581 * Even if OWNER is set, so the port is owned by the
582 * companion controller, khubd needs to be able to clear
583 * the port-change status bits (especially
584 * USB_PORT_FEAT_C_CONNECTION).
585 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
587 switch (wValue) {
588 case USB_PORT_FEAT_ENABLE:
Alan Sterne6316562007-01-16 11:58:00 -0500589 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 break;
591 case USB_PORT_FEAT_C_ENABLE:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100592 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
Alan Sterne6316562007-01-16 11:58:00 -0500593 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 break;
595 case USB_PORT_FEAT_SUSPEND:
596 if (temp & PORT_RESET)
597 goto error;
David Brownellf8aeb3b2006-01-20 13:55:14 -0800598 if (ehci->no_selective_suspend)
599 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 if (temp & PORT_SUSPEND) {
601 if ((temp & PORT_PE) == 0)
602 goto error;
603 /* resume signaling for 20 msec */
David Brownell10f65242005-08-31 10:55:38 -0700604 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100605 ehci_writel(ehci, temp | PORT_RESUME,
Alan Sterne6316562007-01-16 11:58:00 -0500606 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 ehci->reset_done [wIndex] = jiffies
608 + msecs_to_jiffies (20);
609 }
610 break;
611 case USB_PORT_FEAT_C_SUSPEND:
612 /* we auto-clear this feature */
613 break;
614 case USB_PORT_FEAT_POWER:
615 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100616 ehci_writel(ehci,
617 temp & ~(PORT_RWC_BITS | PORT_POWER),
Alan Sterne6316562007-01-16 11:58:00 -0500618 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 break;
620 case USB_PORT_FEAT_C_CONNECTION:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100621 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
Alan Sterne6316562007-01-16 11:58:00 -0500622 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 break;
624 case USB_PORT_FEAT_C_OVER_CURRENT:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100625 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
Alan Sterne6316562007-01-16 11:58:00 -0500626 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 break;
628 case USB_PORT_FEAT_C_RESET:
629 /* GetPortStatus clears reset */
630 break;
631 default:
632 goto error;
633 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100634 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 break;
636 case GetHubDescriptor:
637 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
638 buf);
639 break;
640 case GetHubStatus:
641 /* no hub-wide feature/status flags */
642 memset (buf, 0, 4);
643 //cpu_to_le32s ((u32 *) buf);
644 break;
645 case GetPortStatus:
646 if (!wIndex || wIndex > ports)
647 goto error;
648 wIndex--;
649 status = 0;
Alan Sterne6316562007-01-16 11:58:00 -0500650 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 // wPortChange bits
653 if (temp & PORT_CSC)
654 status |= 1 << USB_PORT_FEAT_C_CONNECTION;
655 if (temp & PORT_PEC)
656 status |= 1 << USB_PORT_FEAT_C_ENABLE;
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700657
658 if ((temp & PORT_OCC) && !ignore_oc){
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 status |= 1 << USB_PORT_FEAT_C_OVER_CURRENT;
660
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700661 /*
662 * Hubs should disable port power on over-current.
663 * However, not all EHCI implementations do this
664 * automatically, even if they _do_ support per-port
665 * power switching; they're allowed to just limit the
666 * current. khubd will turn the power back on.
667 */
668 if (HCS_PPC (ehci->hcs_params)){
669 ehci_writel(ehci,
670 temp & ~(PORT_RWC_BITS | PORT_POWER),
671 status_reg);
672 }
673 }
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 /* whoever resumes must GetPortStatus to complete it!! */
Alan Stern629e4427a2007-01-22 16:08:53 -0500676 if (temp & PORT_RESUME) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Alan Stern629e4427a2007-01-22 16:08:53 -0500678 /* Remote Wakeup received? */
679 if (!ehci->reset_done[wIndex]) {
680 /* resume signaling for 20 msec */
681 ehci->reset_done[wIndex] = jiffies
682 + msecs_to_jiffies(20);
683 /* check the port again */
684 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
685 ehci->reset_done[wIndex]);
686 }
687
688 /* resume completed? */
689 else if (time_after_eq(jiffies,
690 ehci->reset_done[wIndex])) {
691 status |= 1 << USB_PORT_FEAT_C_SUSPEND;
692 ehci->reset_done[wIndex] = 0;
693
694 /* stop resume signaling */
695 temp = ehci_readl(ehci, status_reg);
696 ehci_writel(ehci,
Alan Sterne6316562007-01-16 11:58:00 -0500697 temp & ~(PORT_RWC_BITS | PORT_RESUME),
698 status_reg);
Alan Stern629e4427a2007-01-22 16:08:53 -0500699 retval = handshake(ehci, status_reg,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100700 PORT_RESUME, 0, 2000 /* 2msec */);
Alan Stern629e4427a2007-01-22 16:08:53 -0500701 if (retval != 0) {
702 ehci_err(ehci,
703 "port %d resume error %d\n",
704 wIndex + 1, retval);
705 goto error;
706 }
707 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 }
710
711 /* whoever resets must GetPortStatus to complete it!! */
712 if ((temp & PORT_RESET)
Alan Stern629e4427a2007-01-22 16:08:53 -0500713 && time_after_eq(jiffies,
714 ehci->reset_done[wIndex])) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 status |= 1 << USB_PORT_FEAT_C_RESET;
716 ehci->reset_done [wIndex] = 0;
717
718 /* force reset to complete */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100719 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
Alan Sterne6316562007-01-16 11:58:00 -0500720 status_reg);
David Brownellc22fa3a2005-06-13 07:15:28 -0700721 /* REVISIT: some hardware needs 550+ usec to clear
722 * this bit; seems too long to spin routinely...
723 */
Alan Sterne6316562007-01-16 11:58:00 -0500724 retval = handshake(ehci, status_reg,
David Brownellc22fa3a2005-06-13 07:15:28 -0700725 PORT_RESET, 0, 750);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 if (retval != 0) {
727 ehci_err (ehci, "port %d reset error %d\n",
728 wIndex + 1, retval);
729 goto error;
730 }
731
732 /* see what we found out */
Alan Sterne6316562007-01-16 11:58:00 -0500733 temp = check_reset_complete (ehci, wIndex, status_reg,
734 ehci_readl(ehci, status_reg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 }
736
Alan Stern57e06c12007-01-16 11:59:45 -0500737 /* transfer dedicated ports to the companion hc */
738 if ((temp & PORT_CONNECT) &&
739 test_bit(wIndex, &ehci->companion_ports)) {
740 temp &= ~PORT_RWC_BITS;
741 temp |= PORT_OWNER;
742 ehci_writel(ehci, temp, status_reg);
743 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
744 temp = ehci_readl(ehci, status_reg);
745 }
746
Alan Stern625b5c92007-01-16 11:58:47 -0500747 /*
748 * Even if OWNER is set, there's no harm letting khubd
749 * see the wPortStatus values (they should all be 0 except
750 * for PORT_POWER anyway).
751 */
752
753 if (temp & PORT_CONNECT) {
754 status |= 1 << USB_PORT_FEAT_CONNECTION;
755 // status may be from integrated TT
756 status |= ehci_port_speed(ehci, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 }
Alan Stern625b5c92007-01-16 11:58:47 -0500758 if (temp & PORT_PE)
759 status |= 1 << USB_PORT_FEAT_ENABLE;
760 if (temp & (PORT_SUSPEND|PORT_RESUME))
761 status |= 1 << USB_PORT_FEAT_SUSPEND;
762 if (temp & PORT_OC)
763 status |= 1 << USB_PORT_FEAT_OVER_CURRENT;
764 if (temp & PORT_RESET)
765 status |= 1 << USB_PORT_FEAT_RESET;
766 if (temp & PORT_POWER)
767 status |= 1 << USB_PORT_FEAT_POWER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
David Brownell9776afc2008-02-01 11:42:05 -0800769#ifndef VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (status & ~0xffff) /* only if wPortChange is interesting */
771#endif
772 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
Max Dmitrichenko64543652007-03-06 02:45:01 +0300773 put_unaligned(cpu_to_le32 (status), (__le32 *) buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 break;
775 case SetHubFeature:
776 switch (wValue) {
777 case C_HUB_LOCAL_POWER:
778 case C_HUB_OVER_CURRENT:
779 /* no hub-wide feature/status flags */
780 break;
781 default:
782 goto error;
783 }
784 break;
785 case SetPortFeature:
David Brownellf0d7f272006-11-16 23:56:15 -0800786 selector = wIndex >> 8;
787 wIndex &= 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 if (!wIndex || wIndex > ports)
789 goto error;
790 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500791 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 if (temp & PORT_OWNER)
793 break;
794
David Brownell10f65242005-08-31 10:55:38 -0700795 temp &= ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 switch (wValue) {
797 case USB_PORT_FEAT_SUSPEND:
David Brownellf8aeb3b2006-01-20 13:55:14 -0800798 if (ehci->no_selective_suspend)
799 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 if ((temp & PORT_PE) == 0
801 || (temp & PORT_RESET) != 0)
802 goto error;
Alan Sterne6316562007-01-16 11:58:00 -0500803 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 break;
805 case USB_PORT_FEAT_POWER:
806 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100807 ehci_writel(ehci, temp | PORT_POWER,
Alan Sterne6316562007-01-16 11:58:00 -0500808 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 break;
810 case USB_PORT_FEAT_RESET:
811 if (temp & PORT_RESUME)
812 goto error;
813 /* line status bits may report this as low speed,
814 * which can be fine if this root hub has a
815 * transaction translator built in.
816 */
817 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
818 && !ehci_is_TDI(ehci)
819 && PORT_USB11 (temp)) {
820 ehci_dbg (ehci,
821 "port %d low speed --> companion\n",
822 wIndex + 1);
823 temp |= PORT_OWNER;
824 } else {
825 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
826 temp |= PORT_RESET;
827 temp &= ~PORT_PE;
828
829 /*
830 * caller must wait, then call GetPortStatus
831 * usb 2.0 spec says 50 ms resets on root
832 */
833 ehci->reset_done [wIndex] = jiffies
834 + msecs_to_jiffies (50);
835 }
Alan Sterne6316562007-01-16 11:58:00 -0500836 ehci_writel(ehci, temp, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 break;
David Brownellf0d7f272006-11-16 23:56:15 -0800838
839 /* For downstream facing ports (these): one hub port is put
840 * into test mode according to USB2 11.24.2.13, then the hub
841 * must be reset (which for root hub now means rmmod+modprobe,
842 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
843 * about the EHCI-specific stuff.
844 */
845 case USB_PORT_FEAT_TEST:
846 if (!selector || selector > 5)
847 goto error;
848 ehci_quiesce(ehci);
849 ehci_halt(ehci);
850 temp |= selector << 16;
Alan Sterne6316562007-01-16 11:58:00 -0500851 ehci_writel(ehci, temp, status_reg);
David Brownellf0d7f272006-11-16 23:56:15 -0800852 break;
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 default:
855 goto error;
856 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100857 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 break;
859
860 default:
861error:
862 /* "stall" on error */
863 retval = -EPIPE;
864 }
865 spin_unlock_irqrestore (&ehci->lock, flags);
866 return retval;
867}
Balaji Rao90da0962007-11-22 01:58:14 +0530868
869static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
870{
871 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
872
873 if (ehci_is_TDI(ehci))
874 return;
875 set_owner(ehci, --portnum, PORT_OWNER);
876}
877