blob: 7919a411d5f954be8d5111fb1961fdeaf61db9b9 [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
175 /* turn off now-idle HC */
176 ehci_halt (ehci);
177 hcd->state = HC_STATE_SUSPENDED;
178
Alan Stern8c033562006-11-09 14:42:16 -0500179 /* allow remote wakeup */
180 mask = INTR_MASK;
181 if (!device_may_wakeup(&hcd->self.root_hub->dev))
182 mask &= ~STS_PCD;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100183 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
184 ehci_readl(ehci, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 ehci->next_statechange = jiffies + msecs_to_jiffies(10);
187 spin_unlock_irq (&ehci->lock);
188 return 0;
189}
190
191
192/* caller has locked the root hub, and should reset/reinit on error */
Alan Stern0c0382e2005-10-13 17:08:02 -0400193static int ehci_bus_resume (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
195 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
196 u32 temp;
Alan Stern383975d2007-05-04 11:52:40 -0400197 u32 power_okay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 if (time_before (jiffies, ehci->next_statechange))
201 msleep(5);
202 spin_lock_irq (&ehci->lock);
Alan Sterncfa59da2007-06-21 16:25:35 -0400203 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
204 spin_unlock_irq(&ehci->lock);
205 return -ESHUTDOWN;
206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
David Brownellf03c17f2005-11-23 15:45:28 -0800208 /* Ideally and we've got a real resume here, and no port's power
209 * was lost. (For PCI, that means Vaux was maintained.) But we
210 * could instead be restoring a swsusp snapshot -- so that BIOS was
211 * the last user of the controller, not reset/pm hardware keeping
212 * state we gave to it.
213 */
Alan Stern383975d2007-05-04 11:52:40 -0400214 power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
215 ehci_dbg(ehci, "resume root hub%s\n",
216 power_okay ? "" : " after power loss");
David Brownellf03c17f2005-11-23 15:45:28 -0800217
Alan Stern8c033562006-11-09 14:42:16 -0500218 /* at least some APM implementations will try to deliver
219 * IRQs right away, so delay them until we're ready.
220 */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100221 ehci_writel(ehci, 0, &ehci->regs->intr_enable);
Alan Stern8c033562006-11-09 14:42:16 -0500222
223 /* re-init operational registers */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100224 ehci_writel(ehci, 0, &ehci->regs->segment);
225 ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
226 ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
228 /* restore CMD_RUN, framelist size, and irq threshold */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100229 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Alan Sterne198a312007-03-15 15:54:30 -0400231 /* Some controller/firmware combinations need a delay during which
232 * they set up the port statuses. See Bugzilla #8190. */
233 mdelay(8);
234
Alan Stern8c033562006-11-09 14:42:16 -0500235 /* manually resume the ports we suspended during bus_suspend() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 i = HCS_N_PORTS (ehci->hcs_params);
237 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100238 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
David Brownell10f65242005-08-31 10:55:38 -0700239 temp &= ~(PORT_RWC_BITS
240 | PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E);
Alan Stern8c033562006-11-09 14:42:16 -0500241 if (test_bit(i, &ehci->bus_suspended) &&
242 (temp & PORT_SUSPEND)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
244 temp |= PORT_RESUME;
245 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100246 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 }
248 i = HCS_N_PORTS (ehci->hcs_params);
249 mdelay (20);
250 while (i--) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100251 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500252 if (test_bit(i, &ehci->bus_suspended) &&
253 (temp & PORT_SUSPEND)) {
254 temp &= ~(PORT_RWC_BITS | PORT_RESUME);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100255 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
Alan Stern8c033562006-11-09 14:42:16 -0500256 ehci_vdbg (ehci, "resumed port %d\n", i + 1);
257 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100259 (void) ehci_readl(ehci, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 /* maybe re-activate the schedule(s) */
262 temp = 0;
263 if (ehci->async->qh_next.qh)
264 temp |= CMD_ASE;
265 if (ehci->periodic_sched)
266 temp |= CMD_PSE;
267 if (temp) {
268 ehci->command |= temp;
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100269 ehci_writel(ehci, ehci->command, &ehci->regs->command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 }
271
272 ehci->next_statechange = jiffies + msecs_to_jiffies(5);
273 hcd->state = HC_STATE_RUNNING;
274
275 /* Now we can safely re-enable irqs */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100276 ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
278 spin_unlock_irq (&ehci->lock);
Alan Stern383975d2007-05-04 11:52:40 -0400279
280 if (!power_okay)
281 ehci_handover_companion_ports(ehci);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 return 0;
283}
284
285#else
286
Alan Stern0c0382e2005-10-13 17:08:02 -0400287#define ehci_bus_suspend NULL
288#define ehci_bus_resume NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290#endif /* CONFIG_PM */
291
292/*-------------------------------------------------------------------------*/
293
Alan Stern57e06c12007-01-16 11:59:45 -0500294/* Display the ports dedicated to the companion controller */
Tony Jones5a3201b2007-09-11 14:07:31 -0700295static ssize_t show_companion(struct device *dev,
296 struct device_attribute *attr,
297 char *buf)
Alan Stern57e06c12007-01-16 11:59:45 -0500298{
299 struct ehci_hcd *ehci;
300 int nports, index, n;
301 int count = PAGE_SIZE;
302 char *ptr = buf;
303
Tony Jones5a3201b2007-09-11 14:07:31 -0700304 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
Alan Stern57e06c12007-01-16 11:59:45 -0500305 nports = HCS_N_PORTS(ehci->hcs_params);
306
307 for (index = 0; index < nports; ++index) {
308 if (test_bit(index, &ehci->companion_ports)) {
309 n = scnprintf(ptr, count, "%d\n", index + 1);
310 ptr += n;
311 count -= n;
312 }
313 }
314 return ptr - buf;
315}
316
317/*
Balaji Rao90da0962007-11-22 01:58:14 +0530318 * Sets the owner of a port
Alan Stern57e06c12007-01-16 11:59:45 -0500319 */
Balaji Rao90da0962007-11-22 01:58:14 +0530320static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
Alan Stern57e06c12007-01-16 11:59:45 -0500321{
Alan Stern57e06c12007-01-16 11:59:45 -0500322 u32 __iomem *status_reg;
323 u32 port_status;
Balaji Rao90da0962007-11-22 01:58:14 +0530324 int try;
Alan Stern57e06c12007-01-16 11:59:45 -0500325
Balaji Rao90da0962007-11-22 01:58:14 +0530326 status_reg = &ehci->regs->port_status[portnum];
Alan Stern57e06c12007-01-16 11:59:45 -0500327
328 /*
329 * The controller won't set the OWNER bit if the port is
330 * enabled, so this loop will sometimes require at least two
331 * iterations: one to disable the port and one to set OWNER.
332 */
Alan Stern57e06c12007-01-16 11:59:45 -0500333 for (try = 4; try > 0; --try) {
334 spin_lock_irq(&ehci->lock);
335 port_status = ehci_readl(ehci, status_reg);
336 if ((port_status & PORT_OWNER) == new_owner
337 || (port_status & (PORT_OWNER | PORT_CONNECT))
338 == 0)
339 try = 0;
340 else {
341 port_status ^= PORT_OWNER;
342 port_status &= ~(PORT_PE | PORT_RWC_BITS);
343 ehci_writel(ehci, port_status, status_reg);
344 }
345 spin_unlock_irq(&ehci->lock);
346 if (try > 1)
347 msleep(5);
348 }
Balaji Rao90da0962007-11-22 01:58:14 +0530349}
350
351/*
352 * Dedicate or undedicate a port to the companion controller.
353 * Syntax is "[-]portnum", where a leading '-' sign means
354 * return control of the port to the EHCI controller.
355 */
356static ssize_t store_companion(struct device *dev,
357 struct device_attribute *attr,
358 const char *buf, size_t count)
359{
360 struct ehci_hcd *ehci;
361 int portnum, new_owner;
362
363 ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
364 new_owner = PORT_OWNER; /* Owned by companion */
365 if (sscanf(buf, "%d", &portnum) != 1)
366 return -EINVAL;
367 if (portnum < 0) {
368 portnum = - portnum;
369 new_owner = 0; /* Owned by EHCI */
370 }
371 if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
372 return -ENOENT;
373 portnum--;
374 if (new_owner)
375 set_bit(portnum, &ehci->companion_ports);
376 else
377 clear_bit(portnum, &ehci->companion_ports);
378 set_owner(ehci, portnum, new_owner);
Alan Stern57e06c12007-01-16 11:59:45 -0500379 return count;
380}
Tony Jones5a3201b2007-09-11 14:07:31 -0700381static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500382
383static inline void create_companion_file(struct ehci_hcd *ehci)
384{
385 int i;
386
387 /* with integrated TT there is no companion! */
388 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700389 i = device_create_file(ehci_to_hcd(ehci)->self.dev,
390 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500391}
392
393static inline void remove_companion_file(struct ehci_hcd *ehci)
394{
395 /* with integrated TT there is no companion! */
396 if (!ehci_is_TDI(ehci))
Tony Jones5a3201b2007-09-11 14:07:31 -0700397 device_remove_file(ehci_to_hcd(ehci)->self.dev,
398 &dev_attr_companion);
Alan Stern57e06c12007-01-16 11:59:45 -0500399}
400
401
402/*-------------------------------------------------------------------------*/
403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404static int check_reset_complete (
405 struct ehci_hcd *ehci,
406 int index,
Alan Sterne6316562007-01-16 11:58:00 -0500407 u32 __iomem *status_reg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 int port_status
409) {
410 if (!(port_status & PORT_CONNECT)) {
411 ehci->reset_done [index] = 0;
412 return port_status;
413 }
414
415 /* if reset finished and it's still not enabled -- handoff */
416 if (!(port_status & PORT_PE)) {
417
418 /* with integrated TT, there's nobody to hand it to! */
419 if (ehci_is_TDI(ehci)) {
420 ehci_dbg (ehci,
421 "Failed to enable port %d on root hub TT\n",
422 index+1);
423 return port_status;
424 }
425
426 ehci_dbg (ehci, "port %d full speed --> companion\n",
427 index + 1);
428
429 // what happens if HCS_N_CC(params) == 0 ?
430 port_status |= PORT_OWNER;
David Brownell10f65242005-08-31 10:55:38 -0700431 port_status &= ~PORT_RWC_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500432 ehci_writel(ehci, port_status, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434 } else
435 ehci_dbg (ehci, "port %d high speed\n", index + 1);
436
437 return port_status;
438}
439
440/*-------------------------------------------------------------------------*/
441
442
443/* build "status change" packet (one or two bytes) from HC registers */
444
445static int
446ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
447{
448 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
449 u32 temp, status = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800450 u32 mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 int ports, i, retval = 1;
452 unsigned long flags;
453
454 /* if !USB_SUSPEND, root hub timers won't get shut down ... */
455 if (!HC_IS_RUNNING(hcd->state))
456 return 0;
457
458 /* init status to no-changes */
459 buf [0] = 0;
460 ports = HCS_N_PORTS (ehci->hcs_params);
461 if (ports > 7) {
462 buf [1] = 0;
463 retval++;
464 }
David Brownell53bd6a62006-08-30 14:50:06 -0700465
David Brownell93f1a472006-11-16 23:34:58 -0800466 /* Some boards (mostly VIA?) report bogus overcurrent indications,
467 * causing massive log spam unless we completely ignore them. It
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200468 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
David Brownell93f1a472006-11-16 23:34:58 -0800469 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
470 * PORT_POWER; that's surprising, but maybe within-spec.
471 */
472 if (!ignore_oc)
473 mask = PORT_CSC | PORT_PEC | PORT_OCC;
474 else
475 mask = PORT_CSC | PORT_PEC;
476 // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 /* no hub change reports (bit 0) for now (power, ...) */
479
480 /* port N changes (bit N)? */
481 spin_lock_irqsave (&ehci->lock, flags);
482 for (i = 0; i < ports; i++) {
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100483 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
Alan Stern625b5c92007-01-16 11:58:47 -0500484
485 /*
486 * Return status information even for ports with OWNER set.
487 * Otherwise khubd wouldn't see the disconnect event when a
488 * high-speed device is switched over to the companion
489 * controller by the user.
490 */
491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 if (!(temp & PORT_CONNECT))
493 ehci->reset_done [i] = 0;
David Brownell93f1a472006-11-16 23:34:58 -0800494 if ((temp & mask) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 || ((temp & PORT_RESUME) != 0
Alan Stern629e4422007-01-22 16:08:53 -0500496 && time_after_eq(jiffies,
497 ehci->reset_done[i]))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 if (i < 7)
499 buf [0] |= 1 << (i + 1);
500 else
501 buf [1] |= 1 << (i - 7);
502 status = STS_PCD;
503 }
504 }
505 /* FIXME autosuspend idle root hubs */
506 spin_unlock_irqrestore (&ehci->lock, flags);
507 return status ? retval : 0;
508}
509
510/*-------------------------------------------------------------------------*/
511
512static void
513ehci_hub_descriptor (
514 struct ehci_hcd *ehci,
515 struct usb_hub_descriptor *desc
516) {
517 int ports = HCS_N_PORTS (ehci->hcs_params);
518 u16 temp;
519
520 desc->bDescriptorType = 0x29;
521 desc->bPwrOn2PwrGood = 10; /* ehci 1.0, 2.3.9 says 20ms max */
522 desc->bHubContrCurrent = 0;
523
524 desc->bNbrPorts = ports;
525 temp = 1 + (ports / 8);
526 desc->bDescLength = 7 + 2 * temp;
527
528 /* two bitmaps: ports removable, and usb 1.0 legacy PortPwrCtrlMask */
529 memset (&desc->bitmap [0], 0, temp);
530 memset (&desc->bitmap [temp], 0xff, temp);
531
532 temp = 0x0008; /* per-port overcurrent reporting */
533 if (HCS_PPC (ehci->hcs_params))
534 temp |= 0x0001; /* per-port power control */
David Brownell56c1e262005-04-09 09:00:29 -0700535 else
536 temp |= 0x0002; /* no power switching */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537#if 0
538// re-enable when we support USB_PORT_FEAT_INDICATOR below.
539 if (HCS_INDICATOR (ehci->hcs_params))
540 temp |= 0x0080; /* per-port indicators (LEDs) */
541#endif
542 desc->wHubCharacteristics = (__force __u16)cpu_to_le16 (temp);
543}
544
545/*-------------------------------------------------------------------------*/
546
David Brownell53bd6a62006-08-30 14:50:06 -0700547#define PORT_WAKE_BITS (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549static int ehci_hub_control (
550 struct usb_hcd *hcd,
551 u16 typeReq,
552 u16 wValue,
553 u16 wIndex,
554 char *buf,
555 u16 wLength
556) {
557 struct ehci_hcd *ehci = hcd_to_ehci (hcd);
558 int ports = HCS_N_PORTS (ehci->hcs_params);
Alan Stern383975d2007-05-04 11:52:40 -0400559 u32 __iomem *status_reg = &ehci->regs->port_status[
560 (wIndex & 0xff) - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 u32 temp, status;
562 unsigned long flags;
563 int retval = 0;
David Brownellf0d7f272006-11-16 23:56:15 -0800564 unsigned selector;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566 /*
567 * FIXME: support SetPortFeatures USB_PORT_FEAT_INDICATOR.
568 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
569 * (track current state ourselves) ... blink for diagnostics,
570 * power, "this is the one", etc. EHCI spec supports this.
571 */
572
573 spin_lock_irqsave (&ehci->lock, flags);
574 switch (typeReq) {
575 case ClearHubFeature:
576 switch (wValue) {
577 case C_HUB_LOCAL_POWER:
578 case C_HUB_OVER_CURRENT:
579 /* no hub-wide feature/status flags */
580 break;
581 default:
582 goto error;
583 }
584 break;
585 case ClearPortFeature:
586 if (!wIndex || wIndex > ports)
587 goto error;
588 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500589 temp = ehci_readl(ehci, status_reg);
Alan Stern625b5c92007-01-16 11:58:47 -0500590
591 /*
592 * Even if OWNER is set, so the port is owned by the
593 * companion controller, khubd needs to be able to clear
594 * the port-change status bits (especially
595 * USB_PORT_FEAT_C_CONNECTION).
596 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598 switch (wValue) {
599 case USB_PORT_FEAT_ENABLE:
Alan Sterne6316562007-01-16 11:58:00 -0500600 ehci_writel(ehci, temp & ~PORT_PE, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 break;
602 case USB_PORT_FEAT_C_ENABLE:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100603 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
Alan Sterne6316562007-01-16 11:58:00 -0500604 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 break;
606 case USB_PORT_FEAT_SUSPEND:
607 if (temp & PORT_RESET)
608 goto error;
David Brownellf8aeb3b2006-01-20 13:55:14 -0800609 if (ehci->no_selective_suspend)
610 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 if (temp & PORT_SUSPEND) {
612 if ((temp & PORT_PE) == 0)
613 goto error;
614 /* resume signaling for 20 msec */
David Brownell10f65242005-08-31 10:55:38 -0700615 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100616 ehci_writel(ehci, temp | PORT_RESUME,
Alan Sterne6316562007-01-16 11:58:00 -0500617 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 ehci->reset_done [wIndex] = jiffies
619 + msecs_to_jiffies (20);
620 }
621 break;
622 case USB_PORT_FEAT_C_SUSPEND:
623 /* we auto-clear this feature */
624 break;
625 case USB_PORT_FEAT_POWER:
626 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100627 ehci_writel(ehci,
628 temp & ~(PORT_RWC_BITS | PORT_POWER),
Alan Sterne6316562007-01-16 11:58:00 -0500629 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 break;
631 case USB_PORT_FEAT_C_CONNECTION:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100632 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
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_OVER_CURRENT:
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100636 ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
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_RESET:
640 /* GetPortStatus clears reset */
641 break;
642 default:
643 goto error;
644 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100645 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 break;
647 case GetHubDescriptor:
648 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
649 buf);
650 break;
651 case GetHubStatus:
652 /* no hub-wide feature/status flags */
653 memset (buf, 0, 4);
654 //cpu_to_le32s ((u32 *) buf);
655 break;
656 case GetPortStatus:
657 if (!wIndex || wIndex > ports)
658 goto error;
659 wIndex--;
660 status = 0;
Alan Sterne6316562007-01-16 11:58:00 -0500661 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
663 // wPortChange bits
664 if (temp & PORT_CSC)
665 status |= 1 << USB_PORT_FEAT_C_CONNECTION;
666 if (temp & PORT_PEC)
667 status |= 1 << USB_PORT_FEAT_C_ENABLE;
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700668
669 if ((temp & PORT_OCC) && !ignore_oc){
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 status |= 1 << USB_PORT_FEAT_C_OVER_CURRENT;
671
Christian Engelmayer756aa6b2007-05-30 11:04:48 -0700672 /*
673 * Hubs should disable port power on over-current.
674 * However, not all EHCI implementations do this
675 * automatically, even if they _do_ support per-port
676 * power switching; they're allowed to just limit the
677 * current. khubd will turn the power back on.
678 */
679 if (HCS_PPC (ehci->hcs_params)){
680 ehci_writel(ehci,
681 temp & ~(PORT_RWC_BITS | PORT_POWER),
682 status_reg);
683 }
684 }
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 /* whoever resumes must GetPortStatus to complete it!! */
Alan Stern629e4422007-01-22 16:08:53 -0500687 if (temp & PORT_RESUME) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Alan Stern629e4422007-01-22 16:08:53 -0500689 /* Remote Wakeup received? */
690 if (!ehci->reset_done[wIndex]) {
691 /* resume signaling for 20 msec */
692 ehci->reset_done[wIndex] = jiffies
693 + msecs_to_jiffies(20);
694 /* check the port again */
695 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
696 ehci->reset_done[wIndex]);
697 }
698
699 /* resume completed? */
700 else if (time_after_eq(jiffies,
701 ehci->reset_done[wIndex])) {
702 status |= 1 << USB_PORT_FEAT_C_SUSPEND;
703 ehci->reset_done[wIndex] = 0;
704
705 /* stop resume signaling */
706 temp = ehci_readl(ehci, status_reg);
707 ehci_writel(ehci,
Alan Sterne6316562007-01-16 11:58:00 -0500708 temp & ~(PORT_RWC_BITS | PORT_RESUME),
709 status_reg);
Alan Stern629e4422007-01-22 16:08:53 -0500710 retval = handshake(ehci, status_reg,
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100711 PORT_RESUME, 0, 2000 /* 2msec */);
Alan Stern629e4422007-01-22 16:08:53 -0500712 if (retval != 0) {
713 ehci_err(ehci,
714 "port %d resume error %d\n",
715 wIndex + 1, retval);
716 goto error;
717 }
718 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
721
722 /* whoever resets must GetPortStatus to complete it!! */
723 if ((temp & PORT_RESET)
Alan Stern629e4422007-01-22 16:08:53 -0500724 && time_after_eq(jiffies,
725 ehci->reset_done[wIndex])) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 status |= 1 << USB_PORT_FEAT_C_RESET;
727 ehci->reset_done [wIndex] = 0;
728
729 /* force reset to complete */
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100730 ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
Alan Sterne6316562007-01-16 11:58:00 -0500731 status_reg);
David Brownellc22fa3a2005-06-13 07:15:28 -0700732 /* REVISIT: some hardware needs 550+ usec to clear
733 * this bit; seems too long to spin routinely...
734 */
Alan Sterne6316562007-01-16 11:58:00 -0500735 retval = handshake(ehci, status_reg,
David Brownellc22fa3a2005-06-13 07:15:28 -0700736 PORT_RESET, 0, 750);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (retval != 0) {
738 ehci_err (ehci, "port %d reset error %d\n",
739 wIndex + 1, retval);
740 goto error;
741 }
742
743 /* see what we found out */
Alan Sterne6316562007-01-16 11:58:00 -0500744 temp = check_reset_complete (ehci, wIndex, status_reg,
745 ehci_readl(ehci, status_reg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 }
747
Alan Stern57e06c12007-01-16 11:59:45 -0500748 /* transfer dedicated ports to the companion hc */
749 if ((temp & PORT_CONNECT) &&
750 test_bit(wIndex, &ehci->companion_ports)) {
751 temp &= ~PORT_RWC_BITS;
752 temp |= PORT_OWNER;
753 ehci_writel(ehci, temp, status_reg);
754 ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
755 temp = ehci_readl(ehci, status_reg);
756 }
757
Alan Stern625b5c92007-01-16 11:58:47 -0500758 /*
759 * Even if OWNER is set, there's no harm letting khubd
760 * see the wPortStatus values (they should all be 0 except
761 * for PORT_POWER anyway).
762 */
763
764 if (temp & PORT_CONNECT) {
765 status |= 1 << USB_PORT_FEAT_CONNECTION;
766 // status may be from integrated TT
767 status |= ehci_port_speed(ehci, temp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 }
Alan Stern625b5c92007-01-16 11:58:47 -0500769 if (temp & PORT_PE)
770 status |= 1 << USB_PORT_FEAT_ENABLE;
771 if (temp & (PORT_SUSPEND|PORT_RESUME))
772 status |= 1 << USB_PORT_FEAT_SUSPEND;
773 if (temp & PORT_OC)
774 status |= 1 << USB_PORT_FEAT_OVER_CURRENT;
775 if (temp & PORT_RESET)
776 status |= 1 << USB_PORT_FEAT_RESET;
777 if (temp & PORT_POWER)
778 status |= 1 << USB_PORT_FEAT_POWER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
780#ifndef EHCI_VERBOSE_DEBUG
781 if (status & ~0xffff) /* only if wPortChange is interesting */
782#endif
783 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
Max Dmitrichenko64543652007-03-06 02:45:01 +0300784 put_unaligned(cpu_to_le32 (status), (__le32 *) buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 break;
786 case SetHubFeature:
787 switch (wValue) {
788 case C_HUB_LOCAL_POWER:
789 case C_HUB_OVER_CURRENT:
790 /* no hub-wide feature/status flags */
791 break;
792 default:
793 goto error;
794 }
795 break;
796 case SetPortFeature:
David Brownellf0d7f272006-11-16 23:56:15 -0800797 selector = wIndex >> 8;
798 wIndex &= 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 if (!wIndex || wIndex > ports)
800 goto error;
801 wIndex--;
Alan Sterne6316562007-01-16 11:58:00 -0500802 temp = ehci_readl(ehci, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 if (temp & PORT_OWNER)
804 break;
805
David Brownell10f65242005-08-31 10:55:38 -0700806 temp &= ~PORT_RWC_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 switch (wValue) {
808 case USB_PORT_FEAT_SUSPEND:
David Brownellf8aeb3b2006-01-20 13:55:14 -0800809 if (ehci->no_selective_suspend)
810 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 if ((temp & PORT_PE) == 0
812 || (temp & PORT_RESET) != 0)
813 goto error;
David Brownell2c1c3c42005-11-07 15:24:46 -0800814 if (device_may_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 temp |= PORT_WAKE_BITS;
Alan Sterne6316562007-01-16 11:58:00 -0500816 ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 break;
818 case USB_PORT_FEAT_POWER:
819 if (HCS_PPC (ehci->hcs_params))
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100820 ehci_writel(ehci, temp | PORT_POWER,
Alan Sterne6316562007-01-16 11:58:00 -0500821 status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 break;
823 case USB_PORT_FEAT_RESET:
824 if (temp & PORT_RESUME)
825 goto error;
826 /* line status bits may report this as low speed,
827 * which can be fine if this root hub has a
828 * transaction translator built in.
829 */
830 if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
831 && !ehci_is_TDI(ehci)
832 && PORT_USB11 (temp)) {
833 ehci_dbg (ehci,
834 "port %d low speed --> companion\n",
835 wIndex + 1);
836 temp |= PORT_OWNER;
837 } else {
838 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
839 temp |= PORT_RESET;
840 temp &= ~PORT_PE;
841
842 /*
843 * caller must wait, then call GetPortStatus
844 * usb 2.0 spec says 50 ms resets on root
845 */
846 ehci->reset_done [wIndex] = jiffies
847 + msecs_to_jiffies (50);
848 }
Alan Sterne6316562007-01-16 11:58:00 -0500849 ehci_writel(ehci, temp, status_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 break;
David Brownellf0d7f272006-11-16 23:56:15 -0800851
852 /* For downstream facing ports (these): one hub port is put
853 * into test mode according to USB2 11.24.2.13, then the hub
854 * must be reset (which for root hub now means rmmod+modprobe,
855 * or else system reboot). See EHCI 2.3.9 and 4.14 for info
856 * about the EHCI-specific stuff.
857 */
858 case USB_PORT_FEAT_TEST:
859 if (!selector || selector > 5)
860 goto error;
861 ehci_quiesce(ehci);
862 ehci_halt(ehci);
863 temp |= selector << 16;
Alan Sterne6316562007-01-16 11:58:00 -0500864 ehci_writel(ehci, temp, status_reg);
David Brownellf0d7f272006-11-16 23:56:15 -0800865 break;
866
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 default:
868 goto error;
869 }
Benjamin Herrenschmidt083522d2006-12-15 06:54:08 +1100870 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 break;
872
873 default:
874error:
875 /* "stall" on error */
876 retval = -EPIPE;
877 }
878 spin_unlock_irqrestore (&ehci->lock, flags);
879 return retval;
880}
Balaji Rao90da0962007-11-22 01:58:14 +0530881
882static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
883{
884 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
885
886 if (ehci_is_TDI(ehci))
887 return;
888 set_owner(ehci, --portnum, PORT_OWNER);
889}
890