Linux Audio

Check our new training course

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