blob: ccd88ae011c63e924d1edd22f80d692595ee85a7 [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);
Alan Sternf8fa7572008-01-10 16:43:15 -0500126 del_timer_sync(&ehci->watchdog);
127 del_timer_sync(&ehci->iaa_watchdog);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 port = HCS_N_PORTS (ehci->hcs_params);
130 spin_lock_irq (&ehci->lock);
131
132 /* stop schedules, clean any completed work */
133 if (HC_IS_RUNNING(hcd->state)) {
134 ehci_quiesce (ehci);
135 hcd->state = HC_STATE_QUIESCING;
136 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100137 ehci->command = ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 if (ehci->reclaim)
Alan Stern07d29b62007-12-11 16:05:30 -0500139 end_unlink_async(ehci);
David Howells7d12e782006-10-05 14:55:46 +0100140 ehci_work(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Alan Stern8c033562006-11-09 14:42:16 -0500142 /* Unlike other USB host controller types, EHCI doesn't have
143 * any notion of "global" or bus-wide suspend. The driver has
144 * to manually suspend all the active unsuspended ports, and
145 * then manually resume them in the bus_resume() routine.
146 */
147 ehci->bus_suspended = 0;
Alan Stern383975d2007-05-04 11:52:40 -0400148 ehci->owned_ports = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 while (port--) {
150 u32 __iomem *reg = &ehci->regs->port_status [port];
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100151 u32 t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 u32 t2 = t1;
153
Alan Stern8c033562006-11-09 14:42:16 -0500154 /* keep track of which ports we suspend */
Alan Stern383975d2007-05-04 11:52:40 -0400155 if (t1 & PORT_OWNER)
156 set_bit(port, &ehci->owned_ports);
157 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 t2 |= PORT_SUSPEND;
Alan Stern8c033562006-11-09 14:42:16 -0500159 set_bit(port, &ehci->bus_suspended);
160 }
161
162 /* enable remote wakeup on all ports */
David Brownell2c1c3c42005-11-07 15:24:46 -0800163 if (device_may_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 t2 |= PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E;
165 else
166 t2 &= ~(PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E);
167
168 if (t1 != t2) {
169 ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
170 port + 1, t1, t2);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100171 ehci_writel(ehci, t2, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 }
173 }
174
Alan Sterncd930c92008-01-10 11:14:53 -0500175 /* Apparently some devices need a >= 1-uframe delay here */
176 if (ehci->bus_suspended)
177 udelay(150);
178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 /* turn off now-idle HC */
180 ehci_halt (ehci);
181 hcd->state = HC_STATE_SUSPENDED;
182
Alan Stern8c033562006-11-09 14:42:16 -0500183 /* allow remote wakeup */
184 mask = INTR_MASK;
185 if (!device_may_wakeup(&hcd->self.root_hub->dev))
186 mask &= ~STS_PCD;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100187 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
188 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
191 spin_unlock_irq (&ehci->lock);
192 return 0;
193}
194
195
196/* caller has locked the root hub, and should reset/reinit on error */
Alan Stern0c0382e2005-10-13 17:08:02 -0400197static int ehci_bus_resume (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
199 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
200 u32 temp;
Alan Stern383975d2007-05-04 11:52:40 -0400201 u32 power_okay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204 if (time_before (jiffies, ehci->next_statechange))
205 msleep(5);
206 spin_lock_irq (&ehci->lock);
Alan Sterncfa59da2007-06-21 16:25:35 -0400207 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
208 spin_unlock_irq(&ehci->lock);
209 return -ESHUTDOWN;
210 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
David Brownellf03c17f2005-11-23 15:45:28 -0800212 /* Ideally and we've got a real resume here, and no port's power
213 * was lost. (For PCI, that means Vaux was maintained.) But we
214 * could instead be restoring a swsusp snapshot -- so that BIOS was
215 * the last user of the controller, not reset/pm hardware keeping
216 * state we gave to it.
217 */
Alan Stern383975d2007-05-04 11:52:40 -0400218 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
219 ehci_dbg(ehci, "resume root hub%s\n",
220 power_okay ? "" : " after power loss");
David Brownellf03c17f2005-11-23 15:45:28 -0800221
Alan Stern8c033562006-11-09 14:42:16 -0500222 /* at least some APM implementations will try to deliver
223 * IRQs right away, so delay them until we're ready.
224 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100225 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500226
227 /* re-init operational registers */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100228 ehci_writel(ehci, 0, &ehci->regs->segment);
229 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
230 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 /* restore CMD_RUN, framelist size, and irq threshold */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100233 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Alan Sterne198a312007-03-15 15:54:30 -0400235 /* Some controller/firmware combinations need a delay during which
236 * they set up the port statuses. See Bugzilla #8190. */
237 mdelay(8);
238
Alan Stern8c033562006-11-09 14:42:16 -0500239 /* manually resume the ports we suspended during bus_suspend() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 i = HCS_N_PORTS (ehci->hcs_params);
241 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100242 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
David Brownell10f65242005-08-31 10:55:38 -0700243 temp &= ~(PORT_RWC_BITS
244 | PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E);
Alan Stern8c033562006-11-09 14:42:16 -0500245 if (test_bit(i, &ehci->bus_suspended) &&
246 (temp & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
248 temp |= PORT_RESUME;
249 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100250 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 }
252 i = HCS_N_PORTS (ehci->hcs_params);
253 mdelay (20);
254 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100255 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500256 if (test_bit(i, &ehci->bus_suspended) &&
257 (temp & PORT_SUSPEND)) {
258 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100259 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500260 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
261 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100263 (void) ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
265 /* maybe re-activate the schedule(s) */
266 temp = 0;
267 if (ehci->async->qh_next.qh)
268 temp |= CMD_ASE;
269 if (ehci->periodic_sched)
270 temp |= CMD_PSE;
271 if (temp) {
272 ehci->command |= temp;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100273 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 }
275
276 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
277 hcd->state = HC_STATE_RUNNING;
278
279 /* Now we can safely re-enable irqs */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100280 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282 spin_unlock_irq (&ehci->lock);
Alan Stern383975d2007-05-04 11:52:40 -0400283
284 if (!power_okay)
285 ehci_handover_companion_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return 0;
287}
288
289#else
290
Alan Stern0c0382e2005-10-13 17:08:02 -0400291#define ehci_bus_suspend NULL
292#define ehci_bus_resume NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294#endif /* CONFIG_PM */
295
296/*-------------------------------------------------------------------------*/
297
Alan Stern57e06c12007-01-16 11:59:45 -0500298/* Display the ports dedicated to the companion controller */
Tony Jones5a3201b2007-09-11 14:07:31 -0700299static ssize_t show_companion(struct device *dev,
300 struct device_attribute *attr,
301 char *buf)
Alan Stern57e06c12007-01-16 11:59:45 -0500302{
303 struct ehci_hcd *ehci;
304 int nports, index, n;
305 int count = PAGE_SIZE;
306 char *ptr = buf;
307
Tony Jones5a3201b2007-09-11 14:07:31 -0700308 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
Alan Stern57e06c12007-01-16 11:59:45 -0500309 nports = HCS_N_PORTS(ehci->hcs_params);
310
311 for (index = 0; index < nports; ++index) {
312 if (test_bit(index, &ehci->companion_ports)) {
313 n = scnprintf(ptr, count, "%d\n", index + 1);
314 ptr += n;
315 count -= n;
316 }
317 }
318 return ptr - buf;
319}
320
321/*
Balaji Rao90da0962007-11-22 01:58:14 +0530322 * Sets the owner of a port
Alan Stern57e06c12007-01-16 11:59:45 -0500323 */
Balaji Rao90da0962007-11-22 01:58:14 +0530324static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
Alan Stern57e06c12007-01-16 11:59:45 -0500325{
Alan Stern57e06c12007-01-16 11:59:45 -0500326 u32 __iomem *status_reg;
327 u32 port_status;
Balaji Rao90da0962007-11-22 01:58:14 +0530328 int try;
Alan Stern57e06c12007-01-16 11:59:45 -0500329
Balaji Rao90da0962007-11-22 01:58:14 +0530330 status_reg = &ehci->regs->port_status[portnum];
Alan Stern57e06c12007-01-16 11:59:45 -0500331
332 /*
333 * The controller won't set the OWNER bit if the port is
334 * enabled, so this loop will sometimes require at least two
335 * iterations: one to disable the port and one to set OWNER.
336 */
Alan Stern57e06c12007-01-16 11:59:45 -0500337 for (try = 4; try > 0; --try) {
338 spin_lock_irq(&ehci->lock);
339 port_status = ehci_readl(ehci, status_reg);
340 if ((port_status & PORT_OWNER) == new_owner
341 || (port_status & (PORT_OWNER | PORT_CONNECT))
342 == 0)
343 try = 0;
344 else {
345 port_status ^= PORT_OWNER;
346 port_status &= ~(PORT_PE | PORT_RWC_BITS);
347 ehci_writel(ehci, port_status, status_reg);
348 }
349 spin_unlock_irq(&ehci->lock);
350 if (try > 1)
351 msleep(5);
352 }
Balaji Rao90da0962007-11-22 01:58:14 +0530353}
354
355/*
356 * Dedicate or undedicate a port to the companion controller.
357 * Syntax is "[-]portnum", where a leading '-' sign means
358 * return control of the port to the EHCI controller.
359 */
360static ssize_t store_companion(struct device *dev,
361 struct device_attribute *attr,
362 const char *buf, size_t count)
363{
364 struct ehci_hcd *ehci;
365 int portnum, new_owner;
366
367 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
368 new_owner = PORT_OWNER; /* Owned by companion */
369 if (sscanf(buf, "%d", &portnum) != 1)
370 return -EINVAL;
371 if (portnum < 0) {
372 portnum = - portnum;
373 new_owner = 0; /* Owned by EHCI */
374 }
375 if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
376 return -ENOENT;
377 portnum--;
378 if (new_owner)
379 set_bit(portnum, &ehci->companion_ports);
380 else
381 clear_bit(portnum, &ehci->companion_ports);
382 set_owner(ehci, portnum, new_owner);
Alan Stern57e06c12007-01-16 11:59:45 -0500383 return count;
384}
Tony Jones5a3201b2007-09-11 14:07:31 -0700385static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500386
387static inline void create_companion_file(struct ehci_hcd *ehci)
388{
389 int i;
390
391 /* with integrated TT there is no companion! */
392 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700393 i = device_create_file(ehci_to_hcd(ehci)->self.dev,
394 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500395}
396
397static inline void remove_companion_file(struct ehci_hcd *ehci)
398{
399 /* with integrated TT there is no companion! */
400 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700401 device_remove_file(ehci_to_hcd(ehci)->self.dev,
402 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500403}
404
405
406/*-------------------------------------------------------------------------*/
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408static int check_reset_complete (
409 struct ehci_hcd *ehci,
410 int index,
Alan Sterne6316562007-01-16 11:58:00 -0500411 u32 __iomem *status_reg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 int port_status
413) {
414 if (!(port_status & PORT_CONNECT)) {
415 ehci->reset_done [index] = 0;
416 return port_status;
417 }
418
419 /* if reset finished and it's still not enabled -- handoff */
420 if (!(port_status & PORT_PE)) {
421
422 /* with integrated TT, there's nobody to hand it to! */
423 if (ehci_is_TDI(ehci)) {
424 ehci_dbg (ehci,
425 "Failed to enable port %d on root hub TT\n",
426 index+1);
427 return port_status;
428 }
429
430 ehci_dbg (ehci, "port %d full speed --> companion\n",
431 index + 1);
432
433 // what happens if HCS_N_CC(params) == 0 ?
434 port_status |= PORT_OWNER;
David Brownell10f65242005-08-31 10:55:38 -0700435 port_status &= ~PORT_RWC_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500436 ehci_writel(ehci, port_status, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438 } else
439 ehci_dbg (ehci, "port %d high speed\n", index + 1);
440
441 return port_status;
442}
443
444/*-------------------------------------------------------------------------*/
445
446
447/* build "status change" packet (one or two bytes) from HC registers */
448
449static int
450ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
451{
452 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
453 u32 temp, status = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800454 u32 mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 int ports, i, retval = 1;
456 unsigned long flags;
457
458 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
459 if (!HC_IS_RUNNING(hcd->state))
460 return 0;
461
462 /* init status to no-changes */
463 buf [0] = 0;
464 ports = HCS_N_PORTS (ehci->hcs_params);
465 if (ports > 7) {
466 buf [1] = 0;
467 retval++;
468 }
David Brownell53bd6a62006-08-30 14:50:06 -0700469
David Brownell93f1a472006-11-16 23:34:58 -0800470 /* Some boards (mostly VIA?) report bogus overcurrent indications,
471 * causing massive log spam unless we completely ignore them. It
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200472 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
David Brownell93f1a472006-11-16 23:34:58 -0800473 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
474 * PORT_POWER; that's surprising, but maybe within-spec.
475 */
476 if (!ignore_oc)
477 mask = PORT_CSC | PORT_PEC | PORT_OCC;
478 else
479 mask = PORT_CSC | PORT_PEC;
480 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 /* no hub change reports (bit 0) for now (power, ...) */
483
484 /* port N changes (bit N)? */
485 spin_lock_irqsave (&ehci->lock, flags);
486 for (i = 0; i < ports; i++) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100487 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern625b5c92007-01-16 11:58:47 -0500488
489 /*
490 * Return status information even for ports with OWNER set.
491 * Otherwise khubd wouldn't see the disconnect event when a
492 * high-speed device is switched over to the companion
493 * controller by the user.
494 */
495
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 if (!(temp & PORT_CONNECT))
497 ehci->reset_done [i] = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800498 if ((temp & mask) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 || ((temp & PORT_RESUME) != 0
Alan Stern629e4422007-01-22 16:08:53 -0500500 && time_after_eq(jiffies,
501 ehci->reset_done[i]))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 if (i < 7)
503 buf [0] |= 1 << (i + 1);
504 else
505 buf [1] |= 1 << (i - 7);
506 status = STS_PCD;
507 }
508 }
509 /* FIXME autosuspend idle root hubs */
510 spin_unlock_irqrestore (&ehci->lock, flags);
511 return status ? retval : 0;
512}
513
514/*-------------------------------------------------------------------------*/
515
516static void
517ehci_hub_descriptor (
518 struct ehci_hcd *ehci,
519 struct usb_hub_descriptor *desc
520) {
521 int ports = HCS_N_PORTS (ehci->hcs_params);
522 u16 temp;
523
524 desc->bDescriptorType = 0x29;
525 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
526 desc->bHubContrCurrent = 0;
527
528 desc->bNbrPorts = ports;
529 temp = 1 + (ports / 8);
530 desc->bDescLength = 7 + 2 * temp;
531
532 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
533 memset (&desc->bitmap [0], 0, temp);
534 memset (&desc->bitmap [temp], 0xff, temp);
535
536 temp = 0x0008; /* per-port overcurrent reporting */
537 if (HCS_PPC (ehci->hcs_params))
538 temp |= 0x0001; /* per-port power control */
David Brownell56c1e262005-04-09 09:00:29 -0700539 else
540 temp |= 0x0002; /* no power switching */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541#if 0
542// re-enable when we support USB_PORT_FEAT_INDICATOR below.
543 if (HCS_INDICATOR (ehci->hcs_params))
544 temp |= 0x0080; /* per-port indicators (LEDs) */
545#endif
546 desc->wHubCharacteristics = (__force __u16)cpu_to_le16 (temp);
547}
548
549/*-------------------------------------------------------------------------*/
550
David Brownell53bd6a62006-08-30 14:50:06 -0700551#define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553static int ehci_hub_control (
554 struct usb_hcd *hcd,
555 u16 typeReq,
556 u16 wValue,
557 u16 wIndex,
558 char *buf,
559 u16 wLength
560) {
561 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
562 int ports = HCS_N_PORTS (ehci->hcs_params);
Alan Stern383975d2007-05-04 11:52:40 -0400563 u32 __iomem *status_reg = &ehci->regs->port_status[
564 (wIndex & 0xff) - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 u32 temp, status;
566 unsigned long flags;
567 int retval = 0;
David Brownellf0d7f272006-11-16 23:56:15 -0800568 unsigned selector;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
570 /*
571 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
572 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
573 * (track current state ourselves) ... blink for diagnostics,
574 * power, "this is the one", etc. EHCI spec supports this.
575 */
576
577 spin_lock_irqsave (&ehci->lock, flags);
578 switch (typeReq) {
579 case ClearHubFeature:
580 switch (wValue) {
581 case C_HUB_LOCAL_POWER:
582 case C_HUB_OVER_CURRENT:
583 /* no hub-wide feature/status flags */
584 break;
585 default:
586 goto error;
587 }
588 break;
589 case ClearPortFeature:
590 if (!wIndex || wIndex > ports)
591 goto error;
592 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500593 temp = ehci_readl(ehci, status_reg);
Alan Stern625b5c92007-01-16 11:58:47 -0500594
595 /*
596 * Even if OWNER is set, so the port is owned by the
597 * companion controller, khubd needs to be able to clear
598 * the port-change status bits (especially
599 * USB_PORT_FEAT_C_CONNECTION).
600 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602 switch (wValue) {
603 case USB_PORT_FEAT_ENABLE:
Alan Sterne6316562007-01-16 11:58:00 -0500604 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 break;
606 case USB_PORT_FEAT_C_ENABLE:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100607 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
Alan Sterne6316562007-01-16 11:58:00 -0500608 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 break;
610 case USB_PORT_FEAT_SUSPEND:
611 if (temp & PORT_RESET)
612 goto error;
David Brownellf8aeb3b2006-01-20 13:55:14 -0800613 if (ehci->no_selective_suspend)
614 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 if (temp & PORT_SUSPEND) {
616 if ((temp & PORT_PE) == 0)
617 goto error;
618 /* resume signaling for 20 msec */
David Brownell10f65242005-08-31 10:55:38 -0700619 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100620 ehci_writel(ehci, temp | PORT_RESUME,
Alan Sterne6316562007-01-16 11:58:00 -0500621 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 ehci->reset_done [wIndex] = jiffies
623 + msecs_to_jiffies (20);
624 }
625 break;
626 case USB_PORT_FEAT_C_SUSPEND:
627 /* we auto-clear this feature */
628 break;
629 case USB_PORT_FEAT_POWER:
630 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100631 ehci_writel(ehci,
632 temp & ~(PORT_RWC_BITS | PORT_POWER),
Alan Sterne6316562007-01-16 11:58:00 -0500633 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 break;
635 case USB_PORT_FEAT_C_CONNECTION:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100636 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
Alan Sterne6316562007-01-16 11:58:00 -0500637 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 break;
639 case USB_PORT_FEAT_C_OVER_CURRENT:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100640 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
Alan Sterne6316562007-01-16 11:58:00 -0500641 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 break;
643 case USB_PORT_FEAT_C_RESET:
644 /* GetPortStatus clears reset */
645 break;
646 default:
647 goto error;
648 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100649 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 break;
651 case GetHubDescriptor:
652 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
653 buf);
654 break;
655 case GetHubStatus:
656 /* no hub-wide feature/status flags */
657 memset (buf, 0, 4);
658 //cpu_to_le32s ((u32 *) buf);
659 break;
660 case GetPortStatus:
661 if (!wIndex || wIndex > ports)
662 goto error;
663 wIndex--;
664 status = 0;
Alan Sterne6316562007-01-16 11:58:00 -0500665 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
667 // wPortChange bits
668 if (temp & PORT_CSC)
669 status |= 1 << USB_PORT_FEAT_C_CONNECTION;
670 if (temp & PORT_PEC)
671 status |= 1 << USB_PORT_FEAT_C_ENABLE;
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700672
673 if ((temp & PORT_OCC) && !ignore_oc){
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 status |= 1 << USB_PORT_FEAT_C_OVER_CURRENT;
675
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700676 /*
677 * Hubs should disable port power on over-current.
678 * However, not all EHCI implementations do this
679 * automatically, even if they _do_ support per-port
680 * power switching; they're allowed to just limit the
681 * current. khubd will turn the power back on.
682 */
683 if (HCS_PPC (ehci->hcs_params)){
684 ehci_writel(ehci,
685 temp & ~(PORT_RWC_BITS | PORT_POWER),
686 status_reg);
687 }
688 }
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 /* whoever resumes must GetPortStatus to complete it!! */
Alan Stern629e4422007-01-22 16:08:53 -0500691 if (temp & PORT_RESUME) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Alan Stern629e4422007-01-22 16:08:53 -0500693 /* Remote Wakeup received? */
694 if (!ehci->reset_done[wIndex]) {
695 /* resume signaling for 20 msec */
696 ehci->reset_done[wIndex] = jiffies
697 + msecs_to_jiffies(20);
698 /* check the port again */
699 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
700 ehci->reset_done[wIndex]);
701 }
702
703 /* resume completed? */
704 else if (time_after_eq(jiffies,
705 ehci->reset_done[wIndex])) {
706 status |= 1 << USB_PORT_FEAT_C_SUSPEND;
707 ehci->reset_done[wIndex] = 0;
708
709 /* stop resume signaling */
710 temp = ehci_readl(ehci, status_reg);
711 ehci_writel(ehci,
Alan Sterne6316562007-01-16 11:58:00 -0500712 temp & ~(PORT_RWC_BITS | PORT_RESUME),
713 status_reg);
Alan Stern629e4422007-01-22 16:08:53 -0500714 retval = handshake(ehci, status_reg,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100715 PORT_RESUME, 0, 2000 /* 2msec */);
Alan Stern629e4422007-01-22 16:08:53 -0500716 if (retval != 0) {
717 ehci_err(ehci,
718 "port %d resume error %d\n",
719 wIndex + 1, retval);
720 goto error;
721 }
722 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 }
725
726 /* whoever resets must GetPortStatus to complete it!! */
727 if ((temp & PORT_RESET)
Alan Stern629e4422007-01-22 16:08:53 -0500728 && time_after_eq(jiffies,
729 ehci->reset_done[wIndex])) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 status |= 1 << USB_PORT_FEAT_C_RESET;
731 ehci->reset_done [wIndex] = 0;
732
733 /* force reset to complete */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100734 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
Alan Sterne6316562007-01-16 11:58:00 -0500735 status_reg);
David Brownellc22fa3a2005-06-13 07:15:28 -0700736 /* REVISIT: some hardware needs 550+ usec to clear
737 * this bit; seems too long to spin routinely...
738 */
Alan Sterne6316562007-01-16 11:58:00 -0500739 retval = handshake(ehci, status_reg,
David Brownellc22fa3a2005-06-13 07:15:28 -0700740 PORT_RESET, 0, 750);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 if (retval != 0) {
742 ehci_err (ehci, "port %d reset error %d\n",
743 wIndex + 1, retval);
744 goto error;
745 }
746
747 /* see what we found out */
Alan Sterne6316562007-01-16 11:58:00 -0500748 temp = check_reset_complete (ehci, wIndex, status_reg,
749 ehci_readl(ehci, status_reg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
751
Alan Stern57e06c12007-01-16 11:59:45 -0500752 /* transfer dedicated ports to the companion hc */
753 if ((temp & PORT_CONNECT) &&
754 test_bit(wIndex, &ehci->companion_ports)) {
755 temp &= ~PORT_RWC_BITS;
756 temp |= PORT_OWNER;
757 ehci_writel(ehci, temp, status_reg);
758 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
759 temp = ehci_readl(ehci, status_reg);
760 }
761
Alan Stern625b5c92007-01-16 11:58:47 -0500762 /*
763 * Even if OWNER is set, there's no harm letting khubd
764 * see the wPortStatus values (they should all be 0 except
765 * for PORT_POWER anyway).
766 */
767
768 if (temp & PORT_CONNECT) {
769 status |= 1 << USB_PORT_FEAT_CONNECTION;
770 // status may be from integrated TT
771 status |= ehci_port_speed(ehci, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 }
Alan Stern625b5c92007-01-16 11:58:47 -0500773 if (temp & PORT_PE)
774 status |= 1 << USB_PORT_FEAT_ENABLE;
775 if (temp & (PORT_SUSPEND|PORT_RESUME))
776 status |= 1 << USB_PORT_FEAT_SUSPEND;
777 if (temp & PORT_OC)
778 status |= 1 << USB_PORT_FEAT_OVER_CURRENT;
779 if (temp & PORT_RESET)
780 status |= 1 << USB_PORT_FEAT_RESET;
781 if (temp & PORT_POWER)
782 status |= 1 << USB_PORT_FEAT_POWER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
784#ifndef EHCI_VERBOSE_DEBUG
785 if (status & ~0xffff) /* only if wPortChange is interesting */
786#endif
787 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
Max Dmitrichenko64543652007-03-06 02:45:01 +0300788 put_unaligned(cpu_to_le32 (status), (__le32 *) buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 break;
790 case SetHubFeature:
791 switch (wValue) {
792 case C_HUB_LOCAL_POWER:
793 case C_HUB_OVER_CURRENT:
794 /* no hub-wide feature/status flags */
795 break;
796 default:
797 goto error;
798 }
799 break;
800 case SetPortFeature:
David Brownellf0d7f272006-11-16 23:56:15 -0800801 selector = wIndex >> 8;
802 wIndex &= 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 if (!wIndex || wIndex > ports)
804 goto error;
805 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500806 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 if (temp & PORT_OWNER)
808 break;
809
David Brownell10f65242005-08-31 10:55:38 -0700810 temp &= ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 switch (wValue) {
812 case USB_PORT_FEAT_SUSPEND:
David Brownellf8aeb3b2006-01-20 13:55:14 -0800813 if (ehci->no_selective_suspend)
814 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 if ((temp & PORT_PE) == 0
816 || (temp & PORT_RESET) != 0)
817 goto error;
David Brownell2c1c3c42005-11-07 15:24:46 -0800818 if (device_may_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 temp |= PORT_WAKE_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500820 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 break;
822 case USB_PORT_FEAT_POWER:
823 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100824 ehci_writel(ehci, temp | PORT_POWER,
Alan Sterne6316562007-01-16 11:58:00 -0500825 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 break;
827 case USB_PORT_FEAT_RESET:
828 if (temp & PORT_RESUME)
829 goto error;
830 /* line status bits may report this as low speed,
831 * which can be fine if this root hub has a
832 * transaction translator built in.
833 */
834 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
835 && !ehci_is_TDI(ehci)
836 && PORT_USB11 (temp)) {
837 ehci_dbg (ehci,
838 "port %d low speed --> companion\n",
839 wIndex + 1);
840 temp |= PORT_OWNER;
841 } else {
842 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
843 temp |= PORT_RESET;
844 temp &= ~PORT_PE;
845
846 /*
847 * caller must wait, then call GetPortStatus
848 * usb 2.0 spec says 50 ms resets on root
849 */
850 ehci->reset_done [wIndex] = jiffies
851 + msecs_to_jiffies (50);
852 }
Alan Sterne6316562007-01-16 11:58:00 -0500853 ehci_writel(ehci, temp, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 break;
David Brownellf0d7f272006-11-16 23:56:15 -0800855
856 /* For downstream facing ports (these): one hub port is put
857 * into test mode according to USB2 11.24.2.13, then the hub
858 * must be reset (which for root hub now means rmmod+modprobe,
859 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
860 * about the EHCI-specific stuff.
861 */
862 case USB_PORT_FEAT_TEST:
863 if (!selector || selector > 5)
864 goto error;
865 ehci_quiesce(ehci);
866 ehci_halt(ehci);
867 temp |= selector << 16;
Alan Sterne6316562007-01-16 11:58:00 -0500868 ehci_writel(ehci, temp, status_reg);
David Brownellf0d7f272006-11-16 23:56:15 -0800869 break;
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 default:
872 goto error;
873 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100874 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 break;
876
877 default:
878error:
879 /* "stall" on error */
880 retval = -EPIPE;
881 }
882 spin_unlock_irqrestore (&ehci->lock, flags);
883 return retval;
884}
Balaji Rao90da0962007-11-22 01:58:14 +0530885
886static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
887{
888 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
889
890 if (ehci_is_TDI(ehci))
891 return;
892 set_owner(ehci, --portnum, PORT_OWNER);
893}
894