1 /*
2  * Copyright (C) 2001-2004 by David Brownell
3  *
4  * 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 
31 #define	PORT_WAKE_BITS	(PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
32 
33 #ifdef	CONFIG_PM
34 
35 static int ehci_hub_control(
36 	struct usb_hcd	*hcd,
37 	u16		typeReq,
38 	u16		wValue,
39 	u16		wIndex,
40 	char		*buf,
41 	u16		wLength
42 );
43 
44 /* After a power loss, ports that were owned by the companion must be
45  * reset so that the companion can still own them.
46  */
ehci_handover_companion_ports(struct ehci_hcd * ehci)47 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
48 {
49 	u32 __iomem	*reg;
50 	u32		status;
51 	int		port;
52 	__le32		buf;
53 	struct usb_hcd	*hcd = ehci_to_hcd(ehci);
54 
55 	if (!ehci->owned_ports)
56 		return;
57 
58 	/* Give the connections some time to appear */
59 	msleep(20);
60 
61 	port = HCS_N_PORTS(ehci->hcs_params);
62 	while (port--) {
63 		if (test_bit(port, &ehci->owned_ports)) {
64 			reg = &ehci->regs->port_status[port];
65 			status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
66 
67 			/* Port already owned by companion? */
68 			if (status & PORT_OWNER)
69 				clear_bit(port, &ehci->owned_ports);
70 			else if (test_bit(port, &ehci->companion_ports))
71 				ehci_writel(ehci, status & ~PORT_PE, reg);
72 			else
73 				ehci_hub_control(hcd, SetPortFeature,
74 						USB_PORT_FEAT_RESET, port + 1,
75 						NULL, 0);
76 		}
77 	}
78 
79 	if (!ehci->owned_ports)
80 		return;
81 	msleep(90);		/* Wait for resets to complete */
82 
83 	port = HCS_N_PORTS(ehci->hcs_params);
84 	while (port--) {
85 		if (test_bit(port, &ehci->owned_ports)) {
86 			ehci_hub_control(hcd, GetPortStatus,
87 					0, port + 1,
88 					(char *) &buf, sizeof(buf));
89 
90 			/* The companion should now own the port,
91 			 * but if something went wrong the port must not
92 			 * remain enabled.
93 			 */
94 			reg = &ehci->regs->port_status[port];
95 			status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
96 			if (status & PORT_OWNER)
97 				ehci_writel(ehci, status | PORT_CSC, reg);
98 			else {
99 				ehci_dbg(ehci, "failed handover port %d: %x\n",
100 						port + 1, status);
101 				ehci_writel(ehci, status & ~PORT_PE, reg);
102 			}
103 		}
104 	}
105 
106 	ehci->owned_ports = 0;
107 }
108 
ehci_port_change(struct ehci_hcd * ehci)109 static int ehci_port_change(struct ehci_hcd *ehci)
110 {
111 	int i = HCS_N_PORTS(ehci->hcs_params);
112 
113 	/* First check if the controller indicates a change event */
114 
115 	if (ehci_readl(ehci, &ehci->regs->status) & STS_PCD)
116 		return 1;
117 
118 	/*
119 	 * Not all controllers appear to update this while going from D3 to D0,
120 	 * so check the individual port status registers as well
121 	 */
122 
123 	while (i--)
124 		if (ehci_readl(ehci, &ehci->regs->port_status[i]) & PORT_CSC)
125 			return 1;
126 
127 	return 0;
128 }
129 
ehci_adjust_port_wakeup_flags(struct ehci_hcd * ehci,bool suspending,bool do_wakeup)130 static void ehci_adjust_port_wakeup_flags(struct ehci_hcd *ehci,
131 		bool suspending, bool do_wakeup)
132 {
133 	int		port;
134 	u32		temp;
135 	unsigned long	flags;
136 
137 	/* If remote wakeup is enabled for the root hub but disabled
138 	 * for the controller, we must adjust all the port wakeup flags
139 	 * when the controller is suspended or resumed.  In all other
140 	 * cases they don't need to be changed.
141 	 */
142 	if (!ehci_to_hcd(ehci)->self.root_hub->do_remote_wakeup || do_wakeup)
143 		return;
144 
145 	spin_lock_irqsave(&ehci->lock, flags);
146 
147 	/* clear phy low-power mode before changing wakeup flags */
148 	if (ehci->has_hostpc) {
149 		port = HCS_N_PORTS(ehci->hcs_params);
150 		while (port--) {
151 			u32 __iomem	*hostpc_reg;
152 
153 			hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
154 					+ HOSTPC0 + 4 * port);
155 			temp = ehci_readl(ehci, hostpc_reg);
156 			ehci_writel(ehci, temp & ~HOSTPC_PHCD, hostpc_reg);
157 		}
158 		spin_unlock_irqrestore(&ehci->lock, flags);
159 		msleep(5);
160 		spin_lock_irqsave(&ehci->lock, flags);
161 	}
162 
163 	port = HCS_N_PORTS(ehci->hcs_params);
164 	while (port--) {
165 		u32 __iomem	*reg = &ehci->regs->port_status[port];
166 		u32		t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
167 		u32		t2 = t1 & ~PORT_WAKE_BITS;
168 
169 		/* If we are suspending the controller, clear the flags.
170 		 * If we are resuming the controller, set the wakeup flags.
171 		 */
172 		if (!suspending) {
173 			if (t1 & PORT_CONNECT)
174 				t2 |= PORT_WKOC_E | PORT_WKDISC_E;
175 			else
176 				t2 |= PORT_WKOC_E | PORT_WKCONN_E;
177 		}
178 		ehci_vdbg(ehci, "port %d, %08x -> %08x\n",
179 				port + 1, t1, t2);
180 		ehci_writel(ehci, t2, reg);
181 	}
182 
183 	/* enter phy low-power mode again */
184 	if (ehci->has_hostpc) {
185 		port = HCS_N_PORTS(ehci->hcs_params);
186 		while (port--) {
187 			u32 __iomem	*hostpc_reg;
188 
189 			hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
190 					+ HOSTPC0 + 4 * port);
191 			temp = ehci_readl(ehci, hostpc_reg);
192 			ehci_writel(ehci, temp | HOSTPC_PHCD, hostpc_reg);
193 		}
194 	}
195 
196 	/* Does the root hub have a port wakeup pending? */
197 	if (!suspending && ehci_port_change(ehci))
198 		usb_hcd_resume_root_hub(ehci_to_hcd(ehci));
199 
200 	spin_unlock_irqrestore(&ehci->lock, flags);
201 }
202 
ehci_bus_suspend(struct usb_hcd * hcd)203 static int ehci_bus_suspend (struct usb_hcd *hcd)
204 {
205 	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
206 	int			port;
207 	int			mask;
208 	int			changed;
209 
210 	ehci_dbg(ehci, "suspend root hub\n");
211 
212 	if (time_before (jiffies, ehci->next_statechange))
213 		msleep(5);
214 	del_timer_sync(&ehci->watchdog);
215 	del_timer_sync(&ehci->iaa_watchdog);
216 
217 	spin_lock_irq (&ehci->lock);
218 
219 	/* Once the controller is stopped, port resumes that are already
220 	 * in progress won't complete.  Hence if remote wakeup is enabled
221 	 * for the root hub and any ports are in the middle of a resume or
222 	 * remote wakeup, we must fail the suspend.
223 	 */
224 	if (hcd->self.root_hub->do_remote_wakeup) {
225 		port = HCS_N_PORTS(ehci->hcs_params);
226 		while (port--) {
227 			if (ehci->reset_done[port] != 0) {
228 				spin_unlock_irq(&ehci->lock);
229 				ehci_dbg(ehci, "suspend failed because "
230 						"port %d is resuming\n",
231 						port + 1);
232 				return -EBUSY;
233 			}
234 		}
235 	}
236 
237 	/* stop schedules, clean any completed work */
238 	if (HC_IS_RUNNING(hcd->state)) {
239 		ehci_quiesce (ehci);
240 		hcd->state = HC_STATE_QUIESCING;
241 	}
242 	ehci->command = ehci_readl(ehci, &ehci->regs->command);
243 	ehci_work(ehci);
244 
245 	/* Unlike other USB host controller types, EHCI doesn't have
246 	 * any notion of "global" or bus-wide suspend.  The driver has
247 	 * to manually suspend all the active unsuspended ports, and
248 	 * then manually resume them in the bus_resume() routine.
249 	 */
250 	ehci->bus_suspended = 0;
251 	ehci->owned_ports = 0;
252 	changed = 0;
253 	port = HCS_N_PORTS(ehci->hcs_params);
254 	while (port--) {
255 		u32 __iomem	*reg = &ehci->regs->port_status [port];
256 		u32		t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
257 		u32		t2 = t1 & ~PORT_WAKE_BITS;
258 
259 		/* keep track of which ports we suspend */
260 		if (t1 & PORT_OWNER)
261 			set_bit(port, &ehci->owned_ports);
262 		else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
263 			t2 |= PORT_SUSPEND;
264 			set_bit(port, &ehci->bus_suspended);
265 		}
266 
267 		/* enable remote wakeup on all ports, if told to do so */
268 		if (hcd->self.root_hub->do_remote_wakeup) {
269 			/* only enable appropriate wake bits, otherwise the
270 			 * hardware can not go phy low power mode. If a race
271 			 * condition happens here(connection change during bits
272 			 * set), the port change detection will finally fix it.
273 			 */
274 			if (t1 & PORT_CONNECT)
275 				t2 |= PORT_WKOC_E | PORT_WKDISC_E;
276 			else
277 				t2 |= PORT_WKOC_E | PORT_WKCONN_E;
278 		}
279 
280 		if (t1 != t2) {
281 			ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
282 				port + 1, t1, t2);
283 			ehci_writel(ehci, t2, reg);
284 			changed = 1;
285 		}
286 	}
287 
288 	if (changed && ehci->has_hostpc) {
289 		spin_unlock_irq(&ehci->lock);
290 		msleep(5);	/* 5 ms for HCD to enter low-power mode */
291 		spin_lock_irq(&ehci->lock);
292 
293 		port = HCS_N_PORTS(ehci->hcs_params);
294 		while (port--) {
295 			u32 __iomem	*hostpc_reg;
296 			u32		t3;
297 
298 			hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
299 					+ HOSTPC0 + 4 * port);
300 			t3 = ehci_readl(ehci, hostpc_reg);
301 			ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
302 			t3 = ehci_readl(ehci, hostpc_reg);
303 			ehci_dbg(ehci, "Port %d phy low-power mode %s\n",
304 					port, (t3 & HOSTPC_PHCD) ?
305 					"succeeded" : "failed");
306 		}
307 	}
308 
309 	/* Apparently some devices need a >= 1-uframe delay here */
310 	if (ehci->bus_suspended)
311 		udelay(150);
312 
313 	/* turn off now-idle HC */
314 	ehci_halt (ehci);
315 	hcd->state = HC_STATE_SUSPENDED;
316 
317 	if (ehci->reclaim)
318 		end_unlink_async(ehci);
319 
320 	/* allow remote wakeup */
321 	mask = INTR_MASK;
322 	if (!hcd->self.root_hub->do_remote_wakeup)
323 		mask &= ~STS_PCD;
324 	ehci_writel(ehci, mask, &ehci->regs->intr_enable);
325 	ehci_readl(ehci, &ehci->regs->intr_enable);
326 
327 	ehci->next_statechange = jiffies + msecs_to_jiffies(10);
328 	spin_unlock_irq (&ehci->lock);
329 
330 	/* ehci_work() may have re-enabled the watchdog timer, which we do not
331 	 * want, and so we must delete any pending watchdog timer events.
332 	 */
333 	del_timer_sync(&ehci->watchdog);
334 	return 0;
335 }
336 
337 
338 /* caller has locked the root hub, and should reset/reinit on error */
ehci_bus_resume(struct usb_hcd * hcd)339 static int ehci_bus_resume (struct usb_hcd *hcd)
340 {
341 	struct ehci_hcd		*ehci = hcd_to_ehci (hcd);
342 	u32			temp;
343 	u32			power_okay;
344 	int			i;
345 	u8			resume_needed = 0;
346 
347 	if (time_before (jiffies, ehci->next_statechange))
348 		msleep(5);
349 	spin_lock_irq (&ehci->lock);
350 	if (!HCD_HW_ACCESSIBLE(hcd)) {
351 		spin_unlock_irq(&ehci->lock);
352 		return -ESHUTDOWN;
353 	}
354 
355 	if (unlikely(ehci->debug)) {
356 		if (!dbgp_reset_prep())
357 			ehci->debug = NULL;
358 		else
359 			dbgp_external_startup();
360 	}
361 
362 	/* Ideally and we've got a real resume here, and no port's power
363 	 * was lost.  (For PCI, that means Vaux was maintained.)  But we
364 	 * could instead be restoring a swsusp snapshot -- so that BIOS was
365 	 * the last user of the controller, not reset/pm hardware keeping
366 	 * state we gave to it.
367 	 */
368 	power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
369 	ehci_dbg(ehci, "resume root hub%s\n",
370 			power_okay ? "" : " after power loss");
371 
372 	/* at least some APM implementations will try to deliver
373 	 * IRQs right away, so delay them until we're ready.
374 	 */
375 	ehci_writel(ehci, 0, &ehci->regs->intr_enable);
376 
377 	/* re-init operational registers */
378 	ehci_writel(ehci, 0, &ehci->regs->segment);
379 	ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
380 	ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
381 
382 	/* restore CMD_RUN, framelist size, and irq threshold */
383 	ehci_writel(ehci, ehci->command, &ehci->regs->command);
384 
385 	/* Some controller/firmware combinations need a delay during which
386 	 * they set up the port statuses.  See Bugzilla #8190. */
387 	spin_unlock_irq(&ehci->lock);
388 	msleep(8);
389 	spin_lock_irq(&ehci->lock);
390 
391 	/* clear phy low-power mode before resume */
392 	if (ehci->bus_suspended && ehci->has_hostpc) {
393 		i = HCS_N_PORTS(ehci->hcs_params);
394 		while (i--) {
395 			if (test_bit(i, &ehci->bus_suspended)) {
396 				u32 __iomem	*hostpc_reg;
397 
398 				hostpc_reg = (u32 __iomem *)((u8 *) ehci->regs
399 						+ HOSTPC0 + 4 * i);
400 				temp = ehci_readl(ehci, hostpc_reg);
401 				ehci_writel(ehci, temp & ~HOSTPC_PHCD,
402 						hostpc_reg);
403 			}
404 		}
405 		spin_unlock_irq(&ehci->lock);
406 		msleep(5);
407 		spin_lock_irq(&ehci->lock);
408 	}
409 
410 	/* manually resume the ports we suspended during bus_suspend() */
411 	i = HCS_N_PORTS (ehci->hcs_params);
412 	while (i--) {
413 		temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
414 		temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
415 		if (test_bit(i, &ehci->bus_suspended) &&
416 				(temp & PORT_SUSPEND)) {
417 			temp |= PORT_RESUME;
418 			resume_needed = 1;
419 		}
420 		ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
421 	}
422 
423 	/* msleep for 20ms only if code is trying to resume port */
424 	if (resume_needed) {
425 		spin_unlock_irq(&ehci->lock);
426 		msleep(20);
427 		spin_lock_irq(&ehci->lock);
428 	}
429 
430 	i = HCS_N_PORTS (ehci->hcs_params);
431 	while (i--) {
432 		temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
433 		if (test_bit(i, &ehci->bus_suspended) &&
434 				(temp & PORT_SUSPEND)) {
435 			temp &= ~(PORT_RWC_BITS | PORT_RESUME);
436 			ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
437 			ehci_vdbg (ehci, "resumed port %d\n", i + 1);
438 		}
439 	}
440 	(void) ehci_readl(ehci, &ehci->regs->command);
441 
442 	/* maybe re-activate the schedule(s) */
443 	temp = 0;
444 	if (ehci->async->qh_next.qh)
445 		temp |= CMD_ASE;
446 	if (ehci->periodic_sched)
447 		temp |= CMD_PSE;
448 	if (temp) {
449 		ehci->command |= temp;
450 		ehci_writel(ehci, ehci->command, &ehci->regs->command);
451 	}
452 
453 	ehci->next_statechange = jiffies + msecs_to_jiffies(5);
454 	hcd->state = HC_STATE_RUNNING;
455 
456 	/* Now we can safely re-enable irqs */
457 	ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
458 
459 	spin_unlock_irq (&ehci->lock);
460 	ehci_handover_companion_ports(ehci);
461 	return 0;
462 }
463 
464 #else
465 
466 #define ehci_bus_suspend	NULL
467 #define ehci_bus_resume		NULL
468 
469 #endif	/* CONFIG_PM */
470 
471 /*-------------------------------------------------------------------------*/
472 
473 /* Display the ports dedicated to the companion controller */
show_companion(struct device * dev,struct device_attribute * attr,char * buf)474 static ssize_t show_companion(struct device *dev,
475 			      struct device_attribute *attr,
476 			      char *buf)
477 {
478 	struct ehci_hcd		*ehci;
479 	int			nports, index, n;
480 	int			count = PAGE_SIZE;
481 	char			*ptr = buf;
482 
483 	ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
484 	nports = HCS_N_PORTS(ehci->hcs_params);
485 
486 	for (index = 0; index < nports; ++index) {
487 		if (test_bit(index, &ehci->companion_ports)) {
488 			n = scnprintf(ptr, count, "%d\n", index + 1);
489 			ptr += n;
490 			count -= n;
491 		}
492 	}
493 	return ptr - buf;
494 }
495 
496 /*
497  * Sets the owner of a port
498  */
set_owner(struct ehci_hcd * ehci,int portnum,int new_owner)499 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
500 {
501 	u32 __iomem		*status_reg;
502 	u32			port_status;
503 	int 			try;
504 
505 	status_reg = &ehci->regs->port_status[portnum];
506 
507 	/*
508 	 * The controller won't set the OWNER bit if the port is
509 	 * enabled, so this loop will sometimes require at least two
510 	 * iterations: one to disable the port and one to set OWNER.
511 	 */
512 	for (try = 4; try > 0; --try) {
513 		spin_lock_irq(&ehci->lock);
514 		port_status = ehci_readl(ehci, status_reg);
515 		if ((port_status & PORT_OWNER) == new_owner
516 				|| (port_status & (PORT_OWNER | PORT_CONNECT))
517 					== 0)
518 			try = 0;
519 		else {
520 			port_status ^= PORT_OWNER;
521 			port_status &= ~(PORT_PE | PORT_RWC_BITS);
522 			ehci_writel(ehci, port_status, status_reg);
523 		}
524 		spin_unlock_irq(&ehci->lock);
525 		if (try > 1)
526 			msleep(5);
527 	}
528 }
529 
530 /*
531  * Dedicate or undedicate a port to the companion controller.
532  * Syntax is "[-]portnum", where a leading '-' sign means
533  * return control of the port to the EHCI controller.
534  */
store_companion(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)535 static ssize_t store_companion(struct device *dev,
536 			       struct device_attribute *attr,
537 			       const char *buf, size_t count)
538 {
539 	struct ehci_hcd		*ehci;
540 	int			portnum, new_owner;
541 
542 	ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
543 	new_owner = PORT_OWNER;		/* Owned by companion */
544 	if (sscanf(buf, "%d", &portnum) != 1)
545 		return -EINVAL;
546 	if (portnum < 0) {
547 		portnum = - portnum;
548 		new_owner = 0;		/* Owned by EHCI */
549 	}
550 	if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
551 		return -ENOENT;
552 	portnum--;
553 	if (new_owner)
554 		set_bit(portnum, &ehci->companion_ports);
555 	else
556 		clear_bit(portnum, &ehci->companion_ports);
557 	set_owner(ehci, portnum, new_owner);
558 	return count;
559 }
560 static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
561 
create_companion_file(struct ehci_hcd * ehci)562 static inline int create_companion_file(struct ehci_hcd *ehci)
563 {
564 	int	i = 0;
565 
566 	/* with integrated TT there is no companion! */
567 	if (!ehci_is_TDI(ehci))
568 		i = device_create_file(ehci_to_hcd(ehci)->self.controller,
569 				       &dev_attr_companion);
570 	return i;
571 }
572 
remove_companion_file(struct ehci_hcd * ehci)573 static inline void remove_companion_file(struct ehci_hcd *ehci)
574 {
575 	/* with integrated TT there is no companion! */
576 	if (!ehci_is_TDI(ehci))
577 		device_remove_file(ehci_to_hcd(ehci)->self.controller,
578 				   &dev_attr_companion);
579 }
580 
581 
582 /*-------------------------------------------------------------------------*/
583 
check_reset_complete(struct ehci_hcd * ehci,int index,u32 __iomem * status_reg,int port_status)584 static int check_reset_complete (
585 	struct ehci_hcd	*ehci,
586 	int		index,
587 	u32 __iomem	*status_reg,
588 	int		port_status
589 ) {
590 	if (!(port_status & PORT_CONNECT))
591 		return port_status;
592 
593 	/* if reset finished and it's still not enabled -- handoff */
594 	if (!(port_status & PORT_PE)) {
595 
596 		/* with integrated TT, there's nobody to hand it to! */
597 		if (ehci_is_TDI(ehci)) {
598 			ehci_dbg (ehci,
599 				"Failed to enable port %d on root hub TT\n",
600 				index+1);
601 			return port_status;
602 		}
603 
604 		ehci_dbg (ehci, "port %d full speed --> companion\n",
605 			index + 1);
606 
607 		// what happens if HCS_N_CC(params) == 0 ?
608 		port_status |= PORT_OWNER;
609 		port_status &= ~PORT_RWC_BITS;
610 		ehci_writel(ehci, port_status, status_reg);
611 
612 		/* ensure 440EPX ohci controller state is operational */
613 		if (ehci->has_amcc_usb23)
614 			set_ohci_hcfs(ehci, 1);
615 	} else {
616 		ehci_dbg (ehci, "port %d high speed\n", index + 1);
617 		/* ensure 440EPx ohci controller state is suspended */
618 		if (ehci->has_amcc_usb23)
619 			set_ohci_hcfs(ehci, 0);
620 	}
621 
622 	return port_status;
623 }
624 
625 /*-------------------------------------------------------------------------*/
626 
627 
628 /* build "status change" packet (one or two bytes) from HC registers */
629 
630 static int
ehci_hub_status_data(struct usb_hcd * hcd,char * buf)631 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
632 {
633 	struct ehci_hcd	*ehci = hcd_to_ehci (hcd);
634 	u32		temp, status = 0;
635 	u32		mask;
636 	int		ports, i, retval = 1;
637 	unsigned long	flags;
638 	u32		ppcd = 0;
639 
640 	/* if !USB_SUSPEND, root hub timers won't get shut down ... */
641 	if (!HC_IS_RUNNING(hcd->state))
642 		return 0;
643 
644 	/* init status to no-changes */
645 	buf [0] = 0;
646 	ports = HCS_N_PORTS (ehci->hcs_params);
647 	if (ports > 7) {
648 		buf [1] = 0;
649 		retval++;
650 	}
651 
652 	/* Some boards (mostly VIA?) report bogus overcurrent indications,
653 	 * causing massive log spam unless we completely ignore them.  It
654 	 * may be relevant that VIA VT8235 controllers, where PORT_POWER is
655 	 * always set, seem to clear PORT_OCC and PORT_CSC when writing to
656 	 * PORT_POWER; that's surprising, but maybe within-spec.
657 	 */
658 	if (!ignore_oc)
659 		mask = PORT_CSC | PORT_PEC | PORT_OCC;
660 	else
661 		mask = PORT_CSC | PORT_PEC;
662 	// PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
663 
664 	/* no hub change reports (bit 0) for now (power, ...) */
665 
666 	/* port N changes (bit N)? */
667 	spin_lock_irqsave (&ehci->lock, flags);
668 
669 	/* get per-port change detect bits */
670 	if (ehci->has_ppcd)
671 		ppcd = ehci_readl(ehci, &ehci->regs->status) >> 16;
672 
673 	for (i = 0; i < ports; i++) {
674 		/* leverage per-port change bits feature */
675 		if (ehci->has_ppcd && !(ppcd & (1 << i)))
676 			continue;
677 		temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
678 
679 		/*
680 		 * Return status information even for ports with OWNER set.
681 		 * Otherwise khubd wouldn't see the disconnect event when a
682 		 * high-speed device is switched over to the companion
683 		 * controller by the user.
684 		 */
685 
686 		if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
687 				|| (ehci->reset_done[i] && time_after_eq(
688 					jiffies, ehci->reset_done[i]))) {
689 			if (i < 7)
690 			    buf [0] |= 1 << (i + 1);
691 			else
692 			    buf [1] |= 1 << (i - 7);
693 			status = STS_PCD;
694 		}
695 	}
696 	/* FIXME autosuspend idle root hubs */
697 	spin_unlock_irqrestore (&ehci->lock, flags);
698 	return status ? retval : 0;
699 }
700 
701 /*-------------------------------------------------------------------------*/
702 
703 static void
ehci_hub_descriptor(struct ehci_hcd * ehci,struct usb_hub_descriptor * desc)704 ehci_hub_descriptor (
705 	struct ehci_hcd			*ehci,
706 	struct usb_hub_descriptor	*desc
707 ) {
708 	int		ports = HCS_N_PORTS (ehci->hcs_params);
709 	u16		temp;
710 
711 	desc->bDescriptorType = 0x29;
712 	desc->bPwrOn2PwrGood = 10;	/* ehci 1.0, 2.3.9 says 20ms max */
713 	desc->bHubContrCurrent = 0;
714 
715 	desc->bNbrPorts = ports;
716 	temp = 1 + (ports / 8);
717 	desc->bDescLength = 7 + 2 * temp;
718 
719 	/* two bitmaps:  ports removable, and usb 1.0 legacy PortPwrCtrlMask */
720 	memset(&desc->u.hs.DeviceRemovable[0], 0, temp);
721 	memset(&desc->u.hs.DeviceRemovable[temp], 0xff, temp);
722 
723 	temp = 0x0008;			/* per-port overcurrent reporting */
724 	if (HCS_PPC (ehci->hcs_params))
725 		temp |= 0x0001;		/* per-port power control */
726 	else
727 		temp |= 0x0002;		/* no power switching */
728 #if 0
729 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
730 	if (HCS_INDICATOR (ehci->hcs_params))
731 		temp |= 0x0080;		/* per-port indicators (LEDs) */
732 #endif
733 	desc->wHubCharacteristics = cpu_to_le16(temp);
734 }
735 
736 /*-------------------------------------------------------------------------*/
737 
ehci_hub_control(struct usb_hcd * hcd,u16 typeReq,u16 wValue,u16 wIndex,char * buf,u16 wLength)738 static int ehci_hub_control (
739 	struct usb_hcd	*hcd,
740 	u16		typeReq,
741 	u16		wValue,
742 	u16		wIndex,
743 	char		*buf,
744 	u16		wLength
745 ) {
746 	struct ehci_hcd	*ehci = hcd_to_ehci (hcd);
747 	int		ports = HCS_N_PORTS (ehci->hcs_params);
748 	u32 __iomem	*status_reg = &ehci->regs->port_status[
749 				(wIndex & 0xff) - 1];
750 	u32 __iomem	*hostpc_reg = NULL;
751 	u32		temp, temp1, status;
752 	unsigned long	flags;
753 	int		retval = 0;
754 	unsigned	selector;
755 
756 	/*
757 	 * FIXME:  support SetPortFeatures USB_PORT_FEAT_INDICATOR.
758 	 * HCS_INDICATOR may say we can change LEDs to off/amber/green.
759 	 * (track current state ourselves) ... blink for diagnostics,
760 	 * power, "this is the one", etc.  EHCI spec supports this.
761 	 */
762 
763 	if (ehci->has_hostpc)
764 		hostpc_reg = (u32 __iomem *)((u8 *)ehci->regs
765 				+ HOSTPC0 + 4 * ((wIndex & 0xff) - 1));
766 	spin_lock_irqsave (&ehci->lock, flags);
767 	switch (typeReq) {
768 	case ClearHubFeature:
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 ClearPortFeature:
779 		if (!wIndex || wIndex > ports)
780 			goto error;
781 		wIndex--;
782 		temp = ehci_readl(ehci, status_reg);
783 
784 		/*
785 		 * Even if OWNER is set, so the port is owned by the
786 		 * companion controller, khubd needs to be able to clear
787 		 * the port-change status bits (especially
788 		 * USB_PORT_STAT_C_CONNECTION).
789 		 */
790 
791 		switch (wValue) {
792 		case USB_PORT_FEAT_ENABLE:
793 			ehci_writel(ehci, temp & ~PORT_PE, status_reg);
794 			break;
795 		case USB_PORT_FEAT_C_ENABLE:
796 			ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
797 					status_reg);
798 			break;
799 		case USB_PORT_FEAT_SUSPEND:
800 			if (temp & PORT_RESET)
801 				goto error;
802 			if (ehci->no_selective_suspend)
803 				break;
804 			if (!(temp & PORT_SUSPEND))
805 				break;
806 			if ((temp & PORT_PE) == 0)
807 				goto error;
808 
809 			/* clear phy low-power mode before resume */
810 			if (hostpc_reg) {
811 				temp1 = ehci_readl(ehci, hostpc_reg);
812 				ehci_writel(ehci, temp1 & ~HOSTPC_PHCD,
813 						hostpc_reg);
814 				spin_unlock_irqrestore(&ehci->lock, flags);
815 				msleep(5);/* wait to leave low-power mode */
816 				spin_lock_irqsave(&ehci->lock, flags);
817 			}
818 			/* resume signaling for 20 msec */
819 			temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
820 			ehci_writel(ehci, temp | PORT_RESUME, status_reg);
821 			ehci->reset_done[wIndex] = jiffies
822 					+ msecs_to_jiffies(20);
823 			break;
824 		case USB_PORT_FEAT_C_SUSPEND:
825 			clear_bit(wIndex, &ehci->port_c_suspend);
826 			break;
827 		case USB_PORT_FEAT_POWER:
828 			if (HCS_PPC (ehci->hcs_params))
829 				ehci_writel(ehci,
830 					  temp & ~(PORT_RWC_BITS | PORT_POWER),
831 					  status_reg);
832 			break;
833 		case USB_PORT_FEAT_C_CONNECTION:
834 			if (ehci->has_lpm) {
835 				/* clear PORTSC bits on disconnect */
836 				temp &= ~PORT_LPM;
837 				temp &= ~PORT_DEV_ADDR;
838 			}
839 			ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
840 					status_reg);
841 			break;
842 		case USB_PORT_FEAT_C_OVER_CURRENT:
843 			ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
844 					status_reg);
845 			break;
846 		case USB_PORT_FEAT_C_RESET:
847 			/* GetPortStatus clears reset */
848 			break;
849 		default:
850 			goto error;
851 		}
852 		ehci_readl(ehci, &ehci->regs->command);	/* unblock posted write */
853 		break;
854 	case GetHubDescriptor:
855 		ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
856 			buf);
857 		break;
858 	case GetHubStatus:
859 		/* no hub-wide feature/status flags */
860 		memset (buf, 0, 4);
861 		//cpu_to_le32s ((u32 *) buf);
862 		break;
863 	case GetPortStatus:
864 		if (!wIndex || wIndex > ports)
865 			goto error;
866 		wIndex--;
867 		status = 0;
868 		temp = ehci_readl(ehci, status_reg);
869 
870 		// wPortChange bits
871 		if (temp & PORT_CSC)
872 			status |= USB_PORT_STAT_C_CONNECTION << 16;
873 		if (temp & PORT_PEC)
874 			status |= USB_PORT_STAT_C_ENABLE << 16;
875 
876 		if ((temp & PORT_OCC) && !ignore_oc){
877 			status |= USB_PORT_STAT_C_OVERCURRENT << 16;
878 
879 			/*
880 			 * Hubs should disable port power on over-current.
881 			 * However, not all EHCI implementations do this
882 			 * automatically, even if they _do_ support per-port
883 			 * power switching; they're allowed to just limit the
884 			 * current.  khubd will turn the power back on.
885 			 */
886 			if (HCS_PPC (ehci->hcs_params)){
887 				ehci_writel(ehci,
888 					temp & ~(PORT_RWC_BITS | PORT_POWER),
889 					status_reg);
890 			}
891 		}
892 
893 		/* whoever resumes must GetPortStatus to complete it!! */
894 		if (temp & PORT_RESUME) {
895 
896 			/* Remote Wakeup received? */
897 			if (!ehci->reset_done[wIndex]) {
898 				/* resume signaling for 20 msec */
899 				ehci->reset_done[wIndex] = jiffies
900 						+ msecs_to_jiffies(20);
901 				/* check the port again */
902 				mod_timer(&ehci_to_hcd(ehci)->rh_timer,
903 						ehci->reset_done[wIndex]);
904 			}
905 
906 			/* resume completed? */
907 			else if (time_after_eq(jiffies,
908 					ehci->reset_done[wIndex])) {
909 				clear_bit(wIndex, &ehci->suspended_ports);
910 				set_bit(wIndex, &ehci->port_c_suspend);
911 				ehci->reset_done[wIndex] = 0;
912 
913 				/* stop resume signaling */
914 				temp = ehci_readl(ehci, status_reg);
915 				ehci_writel(ehci,
916 					temp & ~(PORT_RWC_BITS | PORT_RESUME),
917 					status_reg);
918 				retval = handshake(ehci, status_reg,
919 					   PORT_RESUME, 0, 2000 /* 2msec */);
920 				if (retval != 0) {
921 					ehci_err(ehci,
922 						"port %d resume error %d\n",
923 						wIndex + 1, retval);
924 					goto error;
925 				}
926 				temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
927 			}
928 		}
929 
930 		/* whoever resets must GetPortStatus to complete it!! */
931 		if ((temp & PORT_RESET)
932 				&& time_after_eq(jiffies,
933 					ehci->reset_done[wIndex])) {
934 			status |= USB_PORT_STAT_C_RESET << 16;
935 			ehci->reset_done [wIndex] = 0;
936 
937 			/* force reset to complete */
938 			ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
939 					status_reg);
940 			/* REVISIT:  some hardware needs 550+ usec to clear
941 			 * this bit; seems too long to spin routinely...
942 			 */
943 			retval = handshake(ehci, status_reg,
944 					PORT_RESET, 0, 1000);
945 			if (retval != 0) {
946 				ehci_err (ehci, "port %d reset error %d\n",
947 					wIndex + 1, retval);
948 				goto error;
949 			}
950 
951 			/* see what we found out */
952 			temp = check_reset_complete (ehci, wIndex, status_reg,
953 					ehci_readl(ehci, status_reg));
954 		}
955 
956 		if (!(temp & (PORT_RESUME|PORT_RESET)))
957 			ehci->reset_done[wIndex] = 0;
958 
959 		/* transfer dedicated ports to the companion hc */
960 		if ((temp & PORT_CONNECT) &&
961 				test_bit(wIndex, &ehci->companion_ports)) {
962 			temp &= ~PORT_RWC_BITS;
963 			temp |= PORT_OWNER;
964 			ehci_writel(ehci, temp, status_reg);
965 			ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
966 			temp = ehci_readl(ehci, status_reg);
967 		}
968 
969 		/*
970 		 * Even if OWNER is set, there's no harm letting khubd
971 		 * see the wPortStatus values (they should all be 0 except
972 		 * for PORT_POWER anyway).
973 		 */
974 
975 		if (temp & PORT_CONNECT) {
976 			status |= USB_PORT_STAT_CONNECTION;
977 			// status may be from integrated TT
978 			if (ehci->has_hostpc) {
979 				temp1 = ehci_readl(ehci, hostpc_reg);
980 				status |= ehci_port_speed(ehci, temp1);
981 			} else
982 				status |= ehci_port_speed(ehci, temp);
983 		}
984 		if (temp & PORT_PE)
985 			status |= USB_PORT_STAT_ENABLE;
986 
987 		/* maybe the port was unsuspended without our knowledge */
988 		if (temp & (PORT_SUSPEND|PORT_RESUME)) {
989 			status |= USB_PORT_STAT_SUSPEND;
990 		} else if (test_bit(wIndex, &ehci->suspended_ports)) {
991 			clear_bit(wIndex, &ehci->suspended_ports);
992 			ehci->reset_done[wIndex] = 0;
993 			if (temp & PORT_PE)
994 				set_bit(wIndex, &ehci->port_c_suspend);
995 		}
996 
997 		if (temp & PORT_OC)
998 			status |= USB_PORT_STAT_OVERCURRENT;
999 		if (temp & PORT_RESET)
1000 			status |= USB_PORT_STAT_RESET;
1001 		if (temp & PORT_POWER)
1002 			status |= USB_PORT_STAT_POWER;
1003 		if (test_bit(wIndex, &ehci->port_c_suspend))
1004 			status |= USB_PORT_STAT_C_SUSPEND << 16;
1005 
1006 #ifndef	VERBOSE_DEBUG
1007 	if (status & ~0xffff)	/* only if wPortChange is interesting */
1008 #endif
1009 		dbg_port (ehci, "GetStatus", wIndex + 1, temp);
1010 		put_unaligned_le32(status, buf);
1011 		break;
1012 	case SetHubFeature:
1013 		switch (wValue) {
1014 		case C_HUB_LOCAL_POWER:
1015 		case C_HUB_OVER_CURRENT:
1016 			/* no hub-wide feature/status flags */
1017 			break;
1018 		default:
1019 			goto error;
1020 		}
1021 		break;
1022 	case SetPortFeature:
1023 		selector = wIndex >> 8;
1024 		wIndex &= 0xff;
1025 		if (unlikely(ehci->debug)) {
1026 			/* If the debug port is active any port
1027 			 * feature requests should get denied */
1028 			if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
1029 			    (readl(&ehci->debug->control) & DBGP_ENABLED)) {
1030 				retval = -ENODEV;
1031 				goto error_exit;
1032 			}
1033 		}
1034 		if (!wIndex || wIndex > ports)
1035 			goto error;
1036 		wIndex--;
1037 		temp = ehci_readl(ehci, status_reg);
1038 		if (temp & PORT_OWNER)
1039 			break;
1040 
1041 		temp &= ~PORT_RWC_BITS;
1042 		switch (wValue) {
1043 		case USB_PORT_FEAT_SUSPEND:
1044 			if (ehci->no_selective_suspend)
1045 				break;
1046 			if ((temp & PORT_PE) == 0
1047 					|| (temp & PORT_RESET) != 0)
1048 				goto error;
1049 
1050 			/* After above check the port must be connected.
1051 			 * Set appropriate bit thus could put phy into low power
1052 			 * mode if we have hostpc feature
1053 			 */
1054 			temp &= ~PORT_WKCONN_E;
1055 			temp |= PORT_WKDISC_E | PORT_WKOC_E;
1056 			ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
1057 			if (hostpc_reg) {
1058 				spin_unlock_irqrestore(&ehci->lock, flags);
1059 				msleep(5);/* 5ms for HCD enter low pwr mode */
1060 				spin_lock_irqsave(&ehci->lock, flags);
1061 				temp1 = ehci_readl(ehci, hostpc_reg);
1062 				ehci_writel(ehci, temp1 | HOSTPC_PHCD,
1063 					hostpc_reg);
1064 				temp1 = ehci_readl(ehci, hostpc_reg);
1065 				ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
1066 					wIndex, (temp1 & HOSTPC_PHCD) ?
1067 					"succeeded" : "failed");
1068 			}
1069 			set_bit(wIndex, &ehci->suspended_ports);
1070 			break;
1071 		case USB_PORT_FEAT_POWER:
1072 			if (HCS_PPC (ehci->hcs_params))
1073 				ehci_writel(ehci, temp | PORT_POWER,
1074 						status_reg);
1075 			break;
1076 		case USB_PORT_FEAT_RESET:
1077 			if (temp & PORT_RESUME)
1078 				goto error;
1079 			/* line status bits may report this as low speed,
1080 			 * which can be fine if this root hub has a
1081 			 * transaction translator built in.
1082 			 */
1083 			if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
1084 					&& !ehci_is_TDI(ehci)
1085 					&& PORT_USB11 (temp)) {
1086 				ehci_dbg (ehci,
1087 					"port %d low speed --> companion\n",
1088 					wIndex + 1);
1089 				temp |= PORT_OWNER;
1090 			} else {
1091 				ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
1092 				temp |= PORT_RESET;
1093 				temp &= ~PORT_PE;
1094 
1095 				/*
1096 				 * caller must wait, then call GetPortStatus
1097 				 * usb 2.0 spec says 50 ms resets on root
1098 				 */
1099 				ehci->reset_done [wIndex] = jiffies
1100 						+ msecs_to_jiffies (50);
1101 			}
1102 			ehci_writel(ehci, temp, status_reg);
1103 			break;
1104 
1105 		/* For downstream facing ports (these):  one hub port is put
1106 		 * into test mode according to USB2 11.24.2.13, then the hub
1107 		 * must be reset (which for root hub now means rmmod+modprobe,
1108 		 * or else system reboot).  See EHCI 2.3.9 and 4.14 for info
1109 		 * about the EHCI-specific stuff.
1110 		 */
1111 		case USB_PORT_FEAT_TEST:
1112 			if (!selector || selector > 5)
1113 				goto error;
1114 			ehci_quiesce(ehci);
1115 			ehci_halt(ehci);
1116 			temp |= selector << 16;
1117 			ehci_writel(ehci, temp, status_reg);
1118 			break;
1119 
1120 		default:
1121 			goto error;
1122 		}
1123 		ehci_readl(ehci, &ehci->regs->command);	/* unblock posted writes */
1124 		break;
1125 
1126 	default:
1127 error:
1128 		/* "stall" on error */
1129 		retval = -EPIPE;
1130 	}
1131 error_exit:
1132 	spin_unlock_irqrestore (&ehci->lock, flags);
1133 	return retval;
1134 }
1135 
ehci_relinquish_port(struct usb_hcd * hcd,int portnum)1136 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
1137 {
1138 	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
1139 
1140 	if (ehci_is_TDI(ehci))
1141 		return;
1142 	set_owner(ehci, --portnum, PORT_OWNER);
1143 }
1144 
ehci_port_handed_over(struct usb_hcd * hcd,int portnum)1145 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
1146 {
1147 	struct ehci_hcd		*ehci = hcd_to_ehci(hcd);
1148 	u32 __iomem		*reg;
1149 
1150 	if (ehci_is_TDI(ehci))
1151 		return 0;
1152 	reg = &ehci->regs->port_status[portnum - 1];
1153 	return ehci_readl(ehci, reg) & PORT_OWNER;
1154 }
1155