blob: 71aeca019e880075368393c7c7f0d75dd3118cae [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);
202
David Brownellf03c17f2005-11-23 15:45:28 -0800203 /* Ideally and we've got a real resume here, and no port's power
204 * was lost. (For PCI, that means Vaux was maintained.) But we
205 * could instead be restoring a swsusp snapshot -- so that BIOS was
206 * the last user of the controller, not reset/pm hardware keeping
207 * state we gave to it.
208 */
Alan Stern383975d2007-05-04 11:52:40 -0400209 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
210 ehci_dbg(ehci, "resume root hub%s\n",
211 power_okay ? "" : " after power loss");
David Brownellf03c17f2005-11-23 15:45:28 -0800212
Alan Stern8c033562006-11-09 14:42:16 -0500213 /* at least some APM implementations will try to deliver
214 * IRQs right away, so delay them until we're ready.
215 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100216 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500217
218 /* re-init operational registers */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100219 ehci_writel(ehci, 0, &ehci->regs->segment);
220 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
221 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 /* restore CMD_RUN, framelist size, and irq threshold */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100224 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Alan Sterne198a312007-03-15 15:54:30 -0400226 /* Some controller/firmware combinations need a delay during which
227 * they set up the port statuses. See Bugzilla #8190. */
228 mdelay(8);
229
Alan Stern8c033562006-11-09 14:42:16 -0500230 /* manually resume the ports we suspended during bus_suspend() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 i = HCS_N_PORTS (ehci->hcs_params);
232 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100233 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
David Brownell10f65242005-08-31 10:55:38 -0700234 temp &= ~(PORT_RWC_BITS
235 | PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E);
Alan Stern8c033562006-11-09 14:42:16 -0500236 if (test_bit(i, &ehci->bus_suspended) &&
237 (temp & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
239 temp |= PORT_RESUME;
240 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100241 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 }
243 i = HCS_N_PORTS (ehci->hcs_params);
244 mdelay (20);
245 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100246 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500247 if (test_bit(i, &ehci->bus_suspended) &&
248 (temp & PORT_SUSPEND)) {
249 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100250 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500251 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
252 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100254 (void) ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 /* maybe re-activate the schedule(s) */
257 temp = 0;
258 if (ehci->async->qh_next.qh)
259 temp |= CMD_ASE;
260 if (ehci->periodic_sched)
261 temp |= CMD_PSE;
262 if (temp) {
263 ehci->command |= temp;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100264 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 }
266
267 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
268 hcd->state = HC_STATE_RUNNING;
269
270 /* Now we can safely re-enable irqs */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100271 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273 spin_unlock_irq (&ehci->lock);
Alan Stern383975d2007-05-04 11:52:40 -0400274
275 if (!power_okay)
276 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 */
290static ssize_t show_companion(struct class_device *class_dev, char *buf)
291{
292 struct ehci_hcd *ehci;
293 int nports, index, n;
294 int count = PAGE_SIZE;
295 char *ptr = buf;
296
297 ehci = hcd_to_ehci(bus_to_hcd(class_get_devdata(class_dev)));
298 nports = HCS_N_PORTS(ehci->hcs_params);
299
300 for (index = 0; index < nports; ++index) {
301 if (test_bit(index, &ehci->companion_ports)) {
302 n = scnprintf(ptr, count, "%d\n", index + 1);
303 ptr += n;
304 count -= n;
305 }
306 }
307 return ptr - buf;
308}
309
310/*
311 * Dedicate or undedicate a port to the companion controller.
312 * Syntax is "[-]portnum", where a leading '-' sign means
313 * return control of the port to the EHCI controller.
314 */
315static ssize_t store_companion(struct class_device *class_dev,
316 const char *buf, size_t count)
317{
318 struct ehci_hcd *ehci;
319 int portnum, new_owner, try;
320 u32 __iomem *status_reg;
321 u32 port_status;
322
323 ehci = hcd_to_ehci(bus_to_hcd(class_get_devdata(class_dev)));
324 new_owner = PORT_OWNER; /* Owned by companion */
325 if (sscanf(buf, "%d", &portnum) != 1)
326 return -EINVAL;
327 if (portnum < 0) {
328 portnum = - portnum;
329 new_owner = 0; /* Owned by EHCI */
330 }
331 if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
332 return -ENOENT;
333 status_reg = &ehci->regs->port_status[--portnum];
334 if (new_owner)
335 set_bit(portnum, &ehci->companion_ports);
336 else
337 clear_bit(portnum, &ehci->companion_ports);
338
339 /*
340 * The controller won't set the OWNER bit if the port is
341 * enabled, so this loop will sometimes require at least two
342 * iterations: one to disable the port and one to set OWNER.
343 */
344
345 for (try = 4; try > 0; --try) {
346 spin_lock_irq(&ehci->lock);
347 port_status = ehci_readl(ehci, status_reg);
348 if ((port_status & PORT_OWNER) == new_owner
349 || (port_status & (PORT_OWNER | PORT_CONNECT))
350 == 0)
351 try = 0;
352 else {
353 port_status ^= PORT_OWNER;
354 port_status &= ~(PORT_PE | PORT_RWC_BITS);
355 ehci_writel(ehci, port_status, status_reg);
356 }
357 spin_unlock_irq(&ehci->lock);
358 if (try > 1)
359 msleep(5);
360 }
361 return count;
362}
363static CLASS_DEVICE_ATTR(companion, 0644, show_companion, store_companion);
364
365static inline void create_companion_file(struct ehci_hcd *ehci)
366{
367 int i;
368
369 /* with integrated TT there is no companion! */
370 if (!ehci_is_TDI(ehci))
371 i = class_device_create_file(ehci_to_hcd(ehci)->self.class_dev,
372 &class_device_attr_companion);
373}
374
375static inline void remove_companion_file(struct ehci_hcd *ehci)
376{
377 /* with integrated TT there is no companion! */
378 if (!ehci_is_TDI(ehci))
379 class_device_remove_file(ehci_to_hcd(ehci)->self.class_dev,
380 &class_device_attr_companion);
381}
382
383
384/*-------------------------------------------------------------------------*/
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386static int check_reset_complete (
387 struct ehci_hcd *ehci,
388 int index,
Alan Sterne6316562007-01-16 11:58:00 -0500389 u32 __iomem *status_reg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 int port_status
391) {
392 if (!(port_status & PORT_CONNECT)) {
393 ehci->reset_done [index] = 0;
394 return port_status;
395 }
396
397 /* if reset finished and it's still not enabled -- handoff */
398 if (!(port_status & PORT_PE)) {
399
400 /* with integrated TT, there's nobody to hand it to! */
401 if (ehci_is_TDI(ehci)) {
402 ehci_dbg (ehci,
403 "Failed to enable port %d on root hub TT\n",
404 index+1);
405 return port_status;
406 }
407
408 ehci_dbg (ehci, "port %d full speed --> companion\n",
409 index + 1);
410
411 // what happens if HCS_N_CC(params) == 0 ?
412 port_status |= PORT_OWNER;
David Brownell10f65242005-08-31 10:55:38 -0700413 port_status &= ~PORT_RWC_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500414 ehci_writel(ehci, port_status, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416 } else
417 ehci_dbg (ehci, "port %d high speed\n", index + 1);
418
419 return port_status;
420}
421
422/*-------------------------------------------------------------------------*/
423
424
425/* build "status change" packet (one or two bytes) from HC registers */
426
427static int
428ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
429{
430 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
431 u32 temp, status = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800432 u32 mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 int ports, i, retval = 1;
434 unsigned long flags;
435
436 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
437 if (!HC_IS_RUNNING(hcd->state))
438 return 0;
439
440 /* init status to no-changes */
441 buf [0] = 0;
442 ports = HCS_N_PORTS (ehci->hcs_params);
443 if (ports > 7) {
444 buf [1] = 0;
445 retval++;
446 }
David Brownell53bd6a62006-08-30 14:50:06 -0700447
David Brownell93f1a472006-11-16 23:34:58 -0800448 /* Some boards (mostly VIA?) report bogus overcurrent indications,
449 * causing massive log spam unless we completely ignore them. It
450 * may be relevant that VIA VT8235 controlers, where PORT_POWER is
451 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
452 * PORT_POWER; that's surprising, but maybe within-spec.
453 */
454 if (!ignore_oc)
455 mask = PORT_CSC | PORT_PEC | PORT_OCC;
456 else
457 mask = PORT_CSC | PORT_PEC;
458 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 /* no hub change reports (bit 0) for now (power, ...) */
461
462 /* port N changes (bit N)? */
463 spin_lock_irqsave (&ehci->lock, flags);
464 for (i = 0; i < ports; i++) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100465 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern625b5c92007-01-16 11:58:47 -0500466
467 /*
468 * Return status information even for ports with OWNER set.
469 * Otherwise khubd wouldn't see the disconnect event when a
470 * high-speed device is switched over to the companion
471 * controller by the user.
472 */
473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 if (!(temp & PORT_CONNECT))
475 ehci->reset_done [i] = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800476 if ((temp & mask) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 || ((temp & PORT_RESUME) != 0
Alan Stern629e4422007-01-22 16:08:53 -0500478 && time_after_eq(jiffies,
479 ehci->reset_done[i]))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (i < 7)
481 buf [0] |= 1 << (i + 1);
482 else
483 buf [1] |= 1 << (i - 7);
484 status = STS_PCD;
485 }
486 }
487 /* FIXME autosuspend idle root hubs */
488 spin_unlock_irqrestore (&ehci->lock, flags);
489 return status ? retval : 0;
490}
491
492/*-------------------------------------------------------------------------*/
493
494static void
495ehci_hub_descriptor (
496 struct ehci_hcd *ehci,
497 struct usb_hub_descriptor *desc
498) {
499 int ports = HCS_N_PORTS (ehci->hcs_params);
500 u16 temp;
501
502 desc->bDescriptorType = 0x29;
503 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
504 desc->bHubContrCurrent = 0;
505
506 desc->bNbrPorts = ports;
507 temp = 1 + (ports / 8);
508 desc->bDescLength = 7 + 2 * temp;
509
510 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
511 memset (&desc->bitmap [0], 0, temp);
512 memset (&desc->bitmap [temp], 0xff, temp);
513
514 temp = 0x0008; /* per-port overcurrent reporting */
515 if (HCS_PPC (ehci->hcs_params))
516 temp |= 0x0001; /* per-port power control */
David Brownell56c1e262005-04-09 09:00:29 -0700517 else
518 temp |= 0x0002; /* no power switching */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519#if 0
520// re-enable when we support USB_PORT_FEAT_INDICATOR below.
521 if (HCS_INDICATOR (ehci->hcs_params))
522 temp |= 0x0080; /* per-port indicators (LEDs) */
523#endif
524 desc->wHubCharacteristics = (__force __u16)cpu_to_le16 (temp);
525}
526
527/*-------------------------------------------------------------------------*/
528
David Brownell53bd6a62006-08-30 14:50:06 -0700529#define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
531static int ehci_hub_control (
532 struct usb_hcd *hcd,
533 u16 typeReq,
534 u16 wValue,
535 u16 wIndex,
536 char *buf,
537 u16 wLength
538) {
539 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
540 int ports = HCS_N_PORTS (ehci->hcs_params);
Alan Stern383975d2007-05-04 11:52:40 -0400541 u32 __iomem *status_reg = &ehci->regs->port_status[
542 (wIndex & 0xff) - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 u32 temp, status;
544 unsigned long flags;
545 int retval = 0;
David Brownellf0d7f272006-11-16 23:56:15 -0800546 unsigned selector;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
548 /*
549 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
550 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
551 * (track current state ourselves) ... blink for diagnostics,
552 * power, "this is the one", etc. EHCI spec supports this.
553 */
554
555 spin_lock_irqsave (&ehci->lock, flags);
556 switch (typeReq) {
557 case ClearHubFeature:
558 switch (wValue) {
559 case C_HUB_LOCAL_POWER:
560 case C_HUB_OVER_CURRENT:
561 /* no hub-wide feature/status flags */
562 break;
563 default:
564 goto error;
565 }
566 break;
567 case ClearPortFeature:
568 if (!wIndex || wIndex > ports)
569 goto error;
570 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500571 temp = ehci_readl(ehci, status_reg);
Alan Stern625b5c92007-01-16 11:58:47 -0500572
573 /*
574 * Even if OWNER is set, so the port is owned by the
575 * companion controller, khubd needs to be able to clear
576 * the port-change status bits (especially
577 * USB_PORT_FEAT_C_CONNECTION).
578 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580 switch (wValue) {
581 case USB_PORT_FEAT_ENABLE:
Alan Sterne6316562007-01-16 11:58:00 -0500582 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 break;
584 case USB_PORT_FEAT_C_ENABLE:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100585 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
Alan Sterne6316562007-01-16 11:58:00 -0500586 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 break;
588 case USB_PORT_FEAT_SUSPEND:
589 if (temp & PORT_RESET)
590 goto error;
David Brownellf8aeb3b2006-01-20 13:55:14 -0800591 if (ehci->no_selective_suspend)
592 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 if (temp & PORT_SUSPEND) {
594 if ((temp & PORT_PE) == 0)
595 goto error;
596 /* resume signaling for 20 msec */
David Brownell10f65242005-08-31 10:55:38 -0700597 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100598 ehci_writel(ehci, temp | PORT_RESUME,
Alan Sterne6316562007-01-16 11:58:00 -0500599 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 ehci->reset_done [wIndex] = jiffies
601 + msecs_to_jiffies (20);
602 }
603 break;
604 case USB_PORT_FEAT_C_SUSPEND:
605 /* we auto-clear this feature */
606 break;
607 case USB_PORT_FEAT_POWER:
608 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100609 ehci_writel(ehci,
610 temp & ~(PORT_RWC_BITS | PORT_POWER),
Alan Sterne6316562007-01-16 11:58:00 -0500611 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 break;
613 case USB_PORT_FEAT_C_CONNECTION:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100614 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
Alan Sterne6316562007-01-16 11:58:00 -0500615 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 break;
617 case USB_PORT_FEAT_C_OVER_CURRENT:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100618 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
Alan Sterne6316562007-01-16 11:58:00 -0500619 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 break;
621 case USB_PORT_FEAT_C_RESET:
622 /* GetPortStatus clears reset */
623 break;
624 default:
625 goto error;
626 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100627 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 break;
629 case GetHubDescriptor:
630 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
631 buf);
632 break;
633 case GetHubStatus:
634 /* no hub-wide feature/status flags */
635 memset (buf, 0, 4);
636 //cpu_to_le32s ((u32 *) buf);
637 break;
638 case GetPortStatus:
639 if (!wIndex || wIndex > ports)
640 goto error;
641 wIndex--;
642 status = 0;
Alan Sterne6316562007-01-16 11:58:00 -0500643 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
645 // wPortChange bits
646 if (temp & PORT_CSC)
647 status |= 1 << USB_PORT_FEAT_C_CONNECTION;
648 if (temp & PORT_PEC)
649 status |= 1 << USB_PORT_FEAT_C_ENABLE;
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700650
651 if ((temp & PORT_OCC) && !ignore_oc){
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 status |= 1 << USB_PORT_FEAT_C_OVER_CURRENT;
653
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700654 /*
655 * Hubs should disable port power on over-current.
656 * However, not all EHCI implementations do this
657 * automatically, even if they _do_ support per-port
658 * power switching; they're allowed to just limit the
659 * current. khubd will turn the power back on.
660 */
661 if (HCS_PPC (ehci->hcs_params)){
662 ehci_writel(ehci,
663 temp & ~(PORT_RWC_BITS | PORT_POWER),
664 status_reg);
665 }
666 }
667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 /* whoever resumes must GetPortStatus to complete it!! */
Alan Stern629e4422007-01-22 16:08:53 -0500669 if (temp & PORT_RESUME) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
Alan Stern629e4422007-01-22 16:08:53 -0500671 /* Remote Wakeup received? */
672 if (!ehci->reset_done[wIndex]) {
673 /* resume signaling for 20 msec */
674 ehci->reset_done[wIndex] = jiffies
675 + msecs_to_jiffies(20);
676 /* check the port again */
677 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
678 ehci->reset_done[wIndex]);
679 }
680
681 /* resume completed? */
682 else if (time_after_eq(jiffies,
683 ehci->reset_done[wIndex])) {
684 status |= 1 << USB_PORT_FEAT_C_SUSPEND;
685 ehci->reset_done[wIndex] = 0;
686
687 /* stop resume signaling */
688 temp = ehci_readl(ehci, status_reg);
689 ehci_writel(ehci,
Alan Sterne6316562007-01-16 11:58:00 -0500690 temp & ~(PORT_RWC_BITS | PORT_RESUME),
691 status_reg);
Alan Stern629e4422007-01-22 16:08:53 -0500692 retval = handshake(ehci, status_reg,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100693 PORT_RESUME, 0, 2000 /* 2msec */);
Alan Stern629e4422007-01-22 16:08:53 -0500694 if (retval != 0) {
695 ehci_err(ehci,
696 "port %d resume error %d\n",
697 wIndex + 1, retval);
698 goto error;
699 }
700 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 }
703
704 /* whoever resets must GetPortStatus to complete it!! */
705 if ((temp & PORT_RESET)
Alan Stern629e4422007-01-22 16:08:53 -0500706 && time_after_eq(jiffies,
707 ehci->reset_done[wIndex])) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 status |= 1 << USB_PORT_FEAT_C_RESET;
709 ehci->reset_done [wIndex] = 0;
710
711 /* force reset to complete */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100712 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
Alan Sterne6316562007-01-16 11:58:00 -0500713 status_reg);
David Brownellc22fa3a2005-06-13 07:15:28 -0700714 /* REVISIT: some hardware needs 550+ usec to clear
715 * this bit; seems too long to spin routinely...
716 */
Alan Sterne6316562007-01-16 11:58:00 -0500717 retval = handshake(ehci, status_reg,
David Brownellc22fa3a2005-06-13 07:15:28 -0700718 PORT_RESET, 0, 750);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 if (retval != 0) {
720 ehci_err (ehci, "port %d reset error %d\n",
721 wIndex + 1, retval);
722 goto error;
723 }
724
725 /* see what we found out */
Alan Sterne6316562007-01-16 11:58:00 -0500726 temp = check_reset_complete (ehci, wIndex, status_reg,
727 ehci_readl(ehci, status_reg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 }
729
Alan Stern57e06c12007-01-16 11:59:45 -0500730 /* transfer dedicated ports to the companion hc */
731 if ((temp & PORT_CONNECT) &&
732 test_bit(wIndex, &ehci->companion_ports)) {
733 temp &= ~PORT_RWC_BITS;
734 temp |= PORT_OWNER;
735 ehci_writel(ehci, temp, status_reg);
736 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
737 temp = ehci_readl(ehci, status_reg);
738 }
739
Alan Stern625b5c92007-01-16 11:58:47 -0500740 /*
741 * Even if OWNER is set, there's no harm letting khubd
742 * see the wPortStatus values (they should all be 0 except
743 * for PORT_POWER anyway).
744 */
745
746 if (temp & PORT_CONNECT) {
747 status |= 1 << USB_PORT_FEAT_CONNECTION;
748 // status may be from integrated TT
749 status |= ehci_port_speed(ehci, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
Alan Stern625b5c92007-01-16 11:58:47 -0500751 if (temp & PORT_PE)
752 status |= 1 << USB_PORT_FEAT_ENABLE;
753 if (temp & (PORT_SUSPEND|PORT_RESUME))
754 status |= 1 << USB_PORT_FEAT_SUSPEND;
755 if (temp & PORT_OC)
756 status |= 1 << USB_PORT_FEAT_OVER_CURRENT;
757 if (temp & PORT_RESET)
758 status |= 1 << USB_PORT_FEAT_RESET;
759 if (temp & PORT_POWER)
760 status |= 1 << USB_PORT_FEAT_POWER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762#ifndef EHCI_VERBOSE_DEBUG
763 if (status & ~0xffff) /* only if wPortChange is interesting */
764#endif
765 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
Max Dmitrichenko64543652007-03-06 02:45:01 +0300766 put_unaligned(cpu_to_le32 (status), (__le32 *) buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 break;
768 case SetHubFeature:
769 switch (wValue) {
770 case C_HUB_LOCAL_POWER:
771 case C_HUB_OVER_CURRENT:
772 /* no hub-wide feature/status flags */
773 break;
774 default:
775 goto error;
776 }
777 break;
778 case SetPortFeature:
David Brownellf0d7f272006-11-16 23:56:15 -0800779 selector = wIndex >> 8;
780 wIndex &= 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 if (!wIndex || wIndex > ports)
782 goto error;
783 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500784 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 if (temp & PORT_OWNER)
786 break;
787
David Brownell10f65242005-08-31 10:55:38 -0700788 temp &= ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 switch (wValue) {
790 case USB_PORT_FEAT_SUSPEND:
David Brownellf8aeb3b2006-01-20 13:55:14 -0800791 if (ehci->no_selective_suspend)
792 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 if ((temp & PORT_PE) == 0
794 || (temp & PORT_RESET) != 0)
795 goto error;
David Brownell2c1c3c42005-11-07 15:24:46 -0800796 if (device_may_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 temp |= PORT_WAKE_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500798 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 break;
800 case USB_PORT_FEAT_POWER:
801 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100802 ehci_writel(ehci, temp | PORT_POWER,
Alan Sterne6316562007-01-16 11:58:00 -0500803 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 break;
805 case USB_PORT_FEAT_RESET:
806 if (temp & PORT_RESUME)
807 goto error;
808 /* line status bits may report this as low speed,
809 * which can be fine if this root hub has a
810 * transaction translator built in.
811 */
812 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
813 && !ehci_is_TDI(ehci)
814 && PORT_USB11 (temp)) {
815 ehci_dbg (ehci,
816 "port %d low speed --> companion\n",
817 wIndex + 1);
818 temp |= PORT_OWNER;
819 } else {
820 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
821 temp |= PORT_RESET;
822 temp &= ~PORT_PE;
823
824 /*
825 * caller must wait, then call GetPortStatus
826 * usb 2.0 spec says 50 ms resets on root
827 */
828 ehci->reset_done [wIndex] = jiffies
829 + msecs_to_jiffies (50);
830 }
Alan Sterne6316562007-01-16 11:58:00 -0500831 ehci_writel(ehci, temp, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 break;
David Brownellf0d7f272006-11-16 23:56:15 -0800833
834 /* For downstream facing ports (these): one hub port is put
835 * into test mode according to USB2 11.24.2.13, then the hub
836 * must be reset (which for root hub now means rmmod+modprobe,
837 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
838 * about the EHCI-specific stuff.
839 */
840 case USB_PORT_FEAT_TEST:
841 if (!selector || selector > 5)
842 goto error;
843 ehci_quiesce(ehci);
844 ehci_halt(ehci);
845 temp |= selector << 16;
Alan Sterne6316562007-01-16 11:58:00 -0500846 ehci_writel(ehci, temp, status_reg);
David Brownellf0d7f272006-11-16 23:56:15 -0800847 break;
848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 default:
850 goto error;
851 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100852 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 break;
854
855 default:
856error:
857 /* "stall" on error */
858 retval = -EPIPE;
859 }
860 spin_unlock_irqrestore (&ehci->lock, flags);
861 return retval;
862}