blob: 1ad7a65728265e239b876b6bd2ac45e4516e8968 [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 Stern383975d2007-05-04 11:52:40 -040031#ifdef CONFIG_USB_PERSIST
32
33static int ehci_hub_control(
34 struct usb_hcd *hcd,
35 u16 typeReq,
36 u16 wValue,
37 u16 wIndex,
38 char *buf,
39 u16 wLength
40);
41
42/* After a power loss, ports that were owned by the companion must be
43 * reset so that the companion can still own them.
44 */
45static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
46{
47 u32 __iomem *reg;
48 u32 status;
49 int port;
50 __le32 buf;
51 struct usb_hcd *hcd = ehci_to_hcd(ehci);
52
53 if (!ehci->owned_ports)
54 return;
55
56 /* Give the connections some time to appear */
57 msleep(20);
58
59 port = HCS_N_PORTS(ehci->hcs_params);
60 while (port--) {
61 if (test_bit(port, &ehci->owned_ports)) {
62 reg = &ehci->regs->port_status[port];
Alan Stern3c519b82007-05-04 11:55:31 -040063 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
Alan Stern383975d2007-05-04 11:52:40 -040064
65 /* Port already owned by companion? */
66 if (status & PORT_OWNER)
67 clear_bit(port, &ehci->owned_ports);
Alan Stern3c519b82007-05-04 11:55:31 -040068 else if (test_bit(port, &ehci->companion_ports))
69 ehci_writel(ehci, status & ~PORT_PE, reg);
Alan Stern383975d2007-05-04 11:52:40 -040070 else
71 ehci_hub_control(hcd, SetPortFeature,
72 USB_PORT_FEAT_RESET, port + 1,
73 NULL, 0);
74 }
75 }
76
77 if (!ehci->owned_ports)
78 return;
79 msleep(90); /* Wait for resets to complete */
80
81 port = HCS_N_PORTS(ehci->hcs_params);
82 while (port--) {
83 if (test_bit(port, &ehci->owned_ports)) {
84 ehci_hub_control(hcd, GetPortStatus,
85 0, port + 1,
86 (char *) &buf, sizeof(buf));
87
88 /* The companion should now own the port,
89 * but if something went wrong the port must not
90 * remain enabled.
91 */
92 reg = &ehci->regs->port_status[port];
93 status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
94 if (status & PORT_OWNER)
95 ehci_writel(ehci, status | PORT_CSC, reg);
96 else {
97 ehci_dbg(ehci, "failed handover port %d: %x\n",
98 port + 1, status);
99 ehci_writel(ehci, status & ~PORT_PE, reg);
100 }
101 }
102 }
103
104 ehci->owned_ports = 0;
105}
106
107#else /* CONFIG_USB_PERSIST */
108
109static inline void ehci_handover_companion_ports(struct ehci_hcd *ehci)
110{ }
111
112#endif
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114#ifdef CONFIG_PM
115
Alan Stern0c0382e2005-10-13 17:08:02 -0400116static int ehci_bus_suspend (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117{
118 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
119 int port;
Alan Stern8c033562006-11-09 14:42:16 -0500120 int mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Alan Stern8c774fe2007-02-01 16:09:59 -0500122 ehci_dbg(ehci, "suspend root hub\n");
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 if (time_before (jiffies, ehci->next_statechange))
125 msleep(5);
126
127 port = HCS_N_PORTS (ehci->hcs_params);
128 spin_lock_irq (&ehci->lock);
129
130 /* stop schedules, clean any completed work */
131 if (HC_IS_RUNNING(hcd->state)) {
132 ehci_quiesce (ehci);
133 hcd->state = HC_STATE_QUIESCING;
134 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100135 ehci->command = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 if (ehci->reclaim)
Greg Kroah-Hartman64f89792006-10-17 13:57:18 -0700137 ehci->reclaim_ready = 1;
David Howells7d12e782006-10-05 14:55:46 +0100138 ehci_work(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Alan Stern8c033562006-11-09 14:42:16 -0500140 /* Unlike other USB host controller types, EHCI doesn't have
141 * any notion of "global" or bus-wide suspend. The driver has
142 * to manually suspend all the active unsuspended ports, and
143 * then manually resume them in the bus_resume() routine.
144 */
145 ehci->bus_suspended = 0;
Alan Stern383975d2007-05-04 11:52:40 -0400146 ehci->owned_ports = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 while (port--) {
148 u32 __iomem *reg = &ehci->regs->port_status [port];
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100149 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 u32 t2 = t1;
151
Alan Stern8c033562006-11-09 14:42:16 -0500152 /* keep track of which ports we suspend */
Alan Stern383975d2007-05-04 11:52:40 -0400153 if (t1 & PORT_OWNER)
154 set_bit(port, &ehci->owned_ports);
155 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 t2 |= PORT_SUSPEND;
Alan Stern8c033562006-11-09 14:42:16 -0500157 set_bit(port, &ehci->bus_suspended);
158 }
159
160 /* enable remote wakeup on all ports */
David Brownell2c1c3c42005-11-07 15:24:46 -0800161 if (device_may_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 t2 |= PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E;
163 else
164 t2 &= ~(PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E);
165
166 if (t1 != t2) {
167 ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
168 port + 1, t1, t2);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100169 ehci_writel(ehci, t2, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 }
171 }
172
173 /* turn off now-idle HC */
David Brownell4756ae52005-05-09 17:23:51 -0700174 del_timer_sync (&ehci->watchdog);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 ehci_halt (ehci);
176 hcd->state = HC_STATE_SUSPENDED;
177
Alan Stern8c033562006-11-09 14:42:16 -0500178 /* allow remote wakeup */
179 mask = INTR_MASK;
180 if (!device_may_wakeup(&hcd->self.root_hub->dev))
181 mask &= ~STS_PCD;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100182 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
183 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
186 spin_unlock_irq (&ehci->lock);
187 return 0;
188}
189
190
191/* caller has locked the root hub, and should reset/reinit on error */
Alan Stern0c0382e2005-10-13 17:08:02 -0400192static int ehci_bus_resume (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
195 u32 temp;
Alan Stern383975d2007-05-04 11:52:40 -0400196 u32 power_okay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199 if (time_before (jiffies, ehci->next_statechange))
200 msleep(5);
201 spin_lock_irq (&ehci->lock);
Alan Sterncfa59da2007-06-21 16:25:35 -0400202 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
203 spin_unlock_irq(&ehci->lock);
204 return -ESHUTDOWN;
205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
David Brownellf03c17f2005-11-23 15:45:28 -0800207 /* Ideally and we've got a real resume here, and no port's power
208 * was lost. (For PCI, that means Vaux was maintained.) But we
209 * could instead be restoring a swsusp snapshot -- so that BIOS was
210 * the last user of the controller, not reset/pm hardware keeping
211 * state we gave to it.
212 */
Alan Stern383975d2007-05-04 11:52:40 -0400213 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
214 ehci_dbg(ehci, "resume root hub%s\n",
215 power_okay ? "" : " after power loss");
David Brownellf03c17f2005-11-23 15:45:28 -0800216
Alan Stern8c033562006-11-09 14:42:16 -0500217 /* at least some APM implementations will try to deliver
218 * IRQs right away, so delay them until we're ready.
219 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100220 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500221
222 /* re-init operational registers */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100223 ehci_writel(ehci, 0, &ehci->regs->segment);
224 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
225 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227 /* restore CMD_RUN, framelist size, and irq threshold */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100228 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Alan Sterne198a312007-03-15 15:54:30 -0400230 /* Some controller/firmware combinations need a delay during which
231 * they set up the port statuses. See Bugzilla #8190. */
232 mdelay(8);
233
Alan Stern8c033562006-11-09 14:42:16 -0500234 /* manually resume the ports we suspended during bus_suspend() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 i = HCS_N_PORTS (ehci->hcs_params);
236 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100237 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
David Brownell10f65242005-08-31 10:55:38 -0700238 temp &= ~(PORT_RWC_BITS
239 | PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E);
Alan Stern8c033562006-11-09 14:42:16 -0500240 if (test_bit(i, &ehci->bus_suspended) &&
241 (temp & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
243 temp |= PORT_RESUME;
244 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100245 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 }
247 i = HCS_N_PORTS (ehci->hcs_params);
248 mdelay (20);
249 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100250 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500251 if (test_bit(i, &ehci->bus_suspended) &&
252 (temp & PORT_SUSPEND)) {
253 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100254 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500255 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
256 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100258 (void) ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
260 /* maybe re-activate the schedule(s) */
261 temp = 0;
262 if (ehci->async->qh_next.qh)
263 temp |= CMD_ASE;
264 if (ehci->periodic_sched)
265 temp |= CMD_PSE;
266 if (temp) {
267 ehci->command |= temp;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100268 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 }
270
271 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
272 hcd->state = HC_STATE_RUNNING;
273
274 /* Now we can safely re-enable irqs */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100275 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277 spin_unlock_irq (&ehci->lock);
Alan Stern383975d2007-05-04 11:52:40 -0400278
279 if (!power_okay)
280 ehci_handover_companion_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 return 0;
282}
283
284#else
285
Alan Stern0c0382e2005-10-13 17:08:02 -0400286#define ehci_bus_suspend NULL
287#define ehci_bus_resume NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289#endif /* CONFIG_PM */
290
291/*-------------------------------------------------------------------------*/
292
Alan Stern57e06c12007-01-16 11:59:45 -0500293/* Display the ports dedicated to the companion controller */
Tony Jones5a3201b2007-09-11 14:07:31 -0700294static ssize_t show_companion(struct device *dev,
295 struct device_attribute *attr,
296 char *buf)
Alan Stern57e06c12007-01-16 11:59:45 -0500297{
298 struct ehci_hcd *ehci;
299 int nports, index, n;
300 int count = PAGE_SIZE;
301 char *ptr = buf;
302
Tony Jones5a3201b2007-09-11 14:07:31 -0700303 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
Alan Stern57e06c12007-01-16 11:59:45 -0500304 nports = HCS_N_PORTS(ehci->hcs_params);
305
306 for (index = 0; index < nports; ++index) {
307 if (test_bit(index, &ehci->companion_ports)) {
308 n = scnprintf(ptr, count, "%d\n", index + 1);
309 ptr += n;
310 count -= n;
311 }
312 }
313 return ptr - buf;
314}
315
316/*
317 * Dedicate or undedicate a port to the companion controller.
318 * Syntax is "[-]portnum", where a leading '-' sign means
319 * return control of the port to the EHCI controller.
320 */
Tony Jones5a3201b2007-09-11 14:07:31 -0700321static ssize_t store_companion(struct device *dev,
322 struct device_attribute *attr,
323 const char *buf, size_t count)
Alan Stern57e06c12007-01-16 11:59:45 -0500324{
325 struct ehci_hcd *ehci;
326 int portnum, new_owner, try;
327 u32 __iomem *status_reg;
328 u32 port_status;
329
Tony Jones5a3201b2007-09-11 14:07:31 -0700330 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
Alan Stern57e06c12007-01-16 11:59:45 -0500331 new_owner = PORT_OWNER; /* Owned by companion */
332 if (sscanf(buf, "%d", &portnum) != 1)
333 return -EINVAL;
334 if (portnum < 0) {
335 portnum = - portnum;
336 new_owner = 0; /* Owned by EHCI */
337 }
338 if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
339 return -ENOENT;
340 status_reg = &ehci->regs->port_status[--portnum];
341 if (new_owner)
342 set_bit(portnum, &ehci->companion_ports);
343 else
344 clear_bit(portnum, &ehci->companion_ports);
345
346 /*
347 * The controller won't set the OWNER bit if the port is
348 * enabled, so this loop will sometimes require at least two
349 * iterations: one to disable the port and one to set OWNER.
350 */
351
352 for (try = 4; try > 0; --try) {
353 spin_lock_irq(&ehci->lock);
354 port_status = ehci_readl(ehci, status_reg);
355 if ((port_status & PORT_OWNER) == new_owner
356 || (port_status & (PORT_OWNER | PORT_CONNECT))
357 == 0)
358 try = 0;
359 else {
360 port_status ^= PORT_OWNER;
361 port_status &= ~(PORT_PE | PORT_RWC_BITS);
362 ehci_writel(ehci, port_status, status_reg);
363 }
364 spin_unlock_irq(&ehci->lock);
365 if (try > 1)
366 msleep(5);
367 }
368 return count;
369}
Tony Jones5a3201b2007-09-11 14:07:31 -0700370static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500371
372static inline void create_companion_file(struct ehci_hcd *ehci)
373{
374 int i;
375
376 /* with integrated TT there is no companion! */
377 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700378 i = device_create_file(ehci_to_hcd(ehci)->self.dev,
379 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500380}
381
382static inline void remove_companion_file(struct ehci_hcd *ehci)
383{
384 /* with integrated TT there is no companion! */
385 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700386 device_remove_file(ehci_to_hcd(ehci)->self.dev,
387 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500388}
389
390
391/*-------------------------------------------------------------------------*/
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393static int check_reset_complete (
394 struct ehci_hcd *ehci,
395 int index,
Alan Sterne6316562007-01-16 11:58:00 -0500396 u32 __iomem *status_reg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 int port_status
398) {
399 if (!(port_status & PORT_CONNECT)) {
400 ehci->reset_done [index] = 0;
401 return port_status;
402 }
403
404 /* if reset finished and it's still not enabled -- handoff */
405 if (!(port_status & PORT_PE)) {
406
407 /* with integrated TT, there's nobody to hand it to! */
408 if (ehci_is_TDI(ehci)) {
409 ehci_dbg (ehci,
410 "Failed to enable port %d on root hub TT\n",
411 index+1);
412 return port_status;
413 }
414
415 ehci_dbg (ehci, "port %d full speed --> companion\n",
416 index + 1);
417
418 // what happens if HCS_N_CC(params) == 0 ?
419 port_status |= PORT_OWNER;
David Brownell10f65242005-08-31 10:55:38 -0700420 port_status &= ~PORT_RWC_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500421 ehci_writel(ehci, port_status, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423 } else
424 ehci_dbg (ehci, "port %d high speed\n", index + 1);
425
426 return port_status;
427}
428
429/*-------------------------------------------------------------------------*/
430
431
432/* build "status change" packet (one or two bytes) from HC registers */
433
434static int
435ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
436{
437 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
438 u32 temp, status = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800439 u32 mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 int ports, i, retval = 1;
441 unsigned long flags;
442
443 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
444 if (!HC_IS_RUNNING(hcd->state))
445 return 0;
446
447 /* init status to no-changes */
448 buf [0] = 0;
449 ports = HCS_N_PORTS (ehci->hcs_params);
450 if (ports > 7) {
451 buf [1] = 0;
452 retval++;
453 }
David Brownell53bd6a62006-08-30 14:50:06 -0700454
David Brownell93f1a472006-11-16 23:34:58 -0800455 /* Some boards (mostly VIA?) report bogus overcurrent indications,
456 * causing massive log spam unless we completely ignore them. It
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200457 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
David Brownell93f1a472006-11-16 23:34:58 -0800458 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
459 * PORT_POWER; that's surprising, but maybe within-spec.
460 */
461 if (!ignore_oc)
462 mask = PORT_CSC | PORT_PEC | PORT_OCC;
463 else
464 mask = PORT_CSC | PORT_PEC;
465 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
466
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 /* no hub change reports (bit 0) for now (power, ...) */
468
469 /* port N changes (bit N)? */
470 spin_lock_irqsave (&ehci->lock, flags);
471 for (i = 0; i < ports; i++) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100472 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern625b5c92007-01-16 11:58:47 -0500473
474 /*
475 * Return status information even for ports with OWNER set.
476 * Otherwise khubd wouldn't see the disconnect event when a
477 * high-speed device is switched over to the companion
478 * controller by the user.
479 */
480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 if (!(temp & PORT_CONNECT))
482 ehci->reset_done [i] = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800483 if ((temp & mask) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 || ((temp & PORT_RESUME) != 0
Alan Stern629e4427a2007-01-22 16:08:53 -0500485 && time_after_eq(jiffies,
486 ehci->reset_done[i]))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 if (i < 7)
488 buf [0] |= 1 << (i + 1);
489 else
490 buf [1] |= 1 << (i - 7);
491 status = STS_PCD;
492 }
493 }
494 /* FIXME autosuspend idle root hubs */
495 spin_unlock_irqrestore (&ehci->lock, flags);
496 return status ? retval : 0;
497}
498
499/*-------------------------------------------------------------------------*/
500
501static void
502ehci_hub_descriptor (
503 struct ehci_hcd *ehci,
504 struct usb_hub_descriptor *desc
505) {
506 int ports = HCS_N_PORTS (ehci->hcs_params);
507 u16 temp;
508
509 desc->bDescriptorType = 0x29;
510 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
511 desc->bHubContrCurrent = 0;
512
513 desc->bNbrPorts = ports;
514 temp = 1 + (ports / 8);
515 desc->bDescLength = 7 + 2 * temp;
516
517 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
518 memset (&desc->bitmap [0], 0, temp);
519 memset (&desc->bitmap [temp], 0xff, temp);
520
521 temp = 0x0008; /* per-port overcurrent reporting */
522 if (HCS_PPC (ehci->hcs_params))
523 temp |= 0x0001; /* per-port power control */
David Brownell56c1e262005-04-09 09:00:29 -0700524 else
525 temp |= 0x0002; /* no power switching */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526#if 0
527// re-enable when we support USB_PORT_FEAT_INDICATOR below.
528 if (HCS_INDICATOR (ehci->hcs_params))
529 temp |= 0x0080; /* per-port indicators (LEDs) */
530#endif
531 desc->wHubCharacteristics = (__force __u16)cpu_to_le16 (temp);
532}
533
534/*-------------------------------------------------------------------------*/
535
David Brownell53bd6a62006-08-30 14:50:06 -0700536#define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
538static 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
769#ifndef EHCI_VERBOSE_DEBUG
770 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;
David Brownell2c1c3c42005-11-07 15:24:46 -0800803 if (device_may_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 temp |= PORT_WAKE_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500805 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 break;
807 case USB_PORT_FEAT_POWER:
808 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100809 ehci_writel(ehci, temp | PORT_POWER,
Alan Sterne6316562007-01-16 11:58:00 -0500810 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 break;
812 case USB_PORT_FEAT_RESET:
813 if (temp & PORT_RESUME)
814 goto error;
815 /* line status bits may report this as low speed,
816 * which can be fine if this root hub has a
817 * transaction translator built in.
818 */
819 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
820 && !ehci_is_TDI(ehci)
821 && PORT_USB11 (temp)) {
822 ehci_dbg (ehci,
823 "port %d low speed --> companion\n",
824 wIndex + 1);
825 temp |= PORT_OWNER;
826 } else {
827 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
828 temp |= PORT_RESET;
829 temp &= ~PORT_PE;
830
831 /*
832 * caller must wait, then call GetPortStatus
833 * usb 2.0 spec says 50 ms resets on root
834 */
835 ehci->reset_done [wIndex] = jiffies
836 + msecs_to_jiffies (50);
837 }
Alan Sterne6316562007-01-16 11:58:00 -0500838 ehci_writel(ehci, temp, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 break;
David Brownellf0d7f272006-11-16 23:56:15 -0800840
841 /* For downstream facing ports (these): one hub port is put
842 * into test mode according to USB2 11.24.2.13, then the hub
843 * must be reset (which for root hub now means rmmod+modprobe,
844 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
845 * about the EHCI-specific stuff.
846 */
847 case USB_PORT_FEAT_TEST:
848 if (!selector || selector > 5)
849 goto error;
850 ehci_quiesce(ehci);
851 ehci_halt(ehci);
852 temp |= selector << 16;
Alan Sterne6316562007-01-16 11:58:00 -0500853 ehci_writel(ehci, temp, status_reg);
David Brownellf0d7f272006-11-16 23:56:15 -0800854 break;
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 default:
857 goto error;
858 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100859 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 break;
861
862 default:
863error:
864 /* "stall" on error */
865 retval = -EPIPE;
866 }
867 spin_unlock_irqrestore (&ehci->lock, flags);
868 return retval;
869}