2 * MUSB OTG driver virtual root hub support
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
25 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <linux/module.h>
36 #include <linux/kernel.h>
37 #include <linux/sched.h>
38 #include <linux/errno.h>
39 #include <linux/time.h>
40 #include <linux/timer.h>
42 #include <asm/unaligned.h>
44 #include "musb_core.h"
46 void musb_host_finish_resume(struct work_struct *work)
52 musb = container_of(work, struct musb, finish_resume_work.work);
54 spin_lock_irqsave(&musb->lock, flags);
56 power = musb_readb(musb->mregs, MUSB_POWER);
57 power &= ~MUSB_POWER_RESUME;
58 dev_dbg(musb->controller, "root port resume stopped, power %02x\n",
60 musb_writeb(musb->mregs, MUSB_POWER, power);
63 * ISSUE: DaVinci (RTL 1.300) disconnects after
64 * resume of high speed peripherals (but not full
68 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND | MUSB_PORT_STAT_RESUME);
69 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
70 usb_hcd_poll_rh_status(musb->hcd);
71 /* NOTE: it might really be A_WAIT_BCON ... */
72 musb->xceiv->otg->state = OTG_STATE_A_HOST;
74 spin_unlock_irqrestore(&musb->lock, flags);
77 void musb_port_suspend(struct musb *musb, bool do_suspend)
79 struct usb_otg *otg = musb->xceiv->otg;
81 void __iomem *mbase = musb->mregs;
83 if (!is_host_active(musb))
86 /* NOTE: this doesn't necessarily put PHY into low power mode,
87 * turning off its clock; that's a function of PHY integration and
88 * MUSB_POWER_ENSUSPEND. PHY may need a clock (sigh) to detect
89 * SE0 changing to connect (J) or wakeup (K) states.
91 power = musb_readb(mbase, MUSB_POWER);
95 power &= ~MUSB_POWER_RESUME;
96 power |= MUSB_POWER_SUSPENDM;
97 musb_writeb(mbase, MUSB_POWER, power);
99 /* Needed for OPT A tests */
100 power = musb_readb(mbase, MUSB_POWER);
101 while (power & MUSB_POWER_SUSPENDM) {
102 power = musb_readb(mbase, MUSB_POWER);
107 dev_dbg(musb->controller, "Root port suspended, power %02x\n", power);
109 musb->port1_status |= USB_PORT_STAT_SUSPEND;
110 switch (musb->xceiv->otg->state) {
111 case OTG_STATE_A_HOST:
112 musb->xceiv->otg->state = OTG_STATE_A_SUSPEND;
113 musb->is_active = otg->host->b_hnp_enable;
115 mod_timer(&musb->otg_timer, jiffies
117 OTG_TIME_A_AIDL_BDIS));
118 musb_platform_try_idle(musb, 0);
120 case OTG_STATE_B_HOST:
121 musb->xceiv->otg->state = OTG_STATE_B_WAIT_ACON;
122 musb->is_active = otg->host->b_hnp_enable;
123 musb_platform_try_idle(musb, 0);
126 dev_dbg(musb->controller, "bogus rh suspend? %s\n",
127 usb_otg_state_string(musb->xceiv->otg->state));
129 } else if (power & MUSB_POWER_SUSPENDM) {
130 power &= ~MUSB_POWER_SUSPENDM;
131 power |= MUSB_POWER_RESUME;
132 musb_writeb(mbase, MUSB_POWER, power);
134 dev_dbg(musb->controller, "Root port resuming, power %02x\n", power);
136 /* later, GetPortStatus will stop RESUME signaling */
137 musb->port1_status |= MUSB_PORT_STAT_RESUME;
138 schedule_delayed_work(&musb->finish_resume_work,
139 msecs_to_jiffies(USB_RESUME_TIMEOUT));
143 void musb_port_reset(struct musb *musb, bool do_reset)
146 void __iomem *mbase = musb->mregs;
148 if (musb->xceiv->otg->state == OTG_STATE_B_IDLE) {
149 dev_dbg(musb->controller, "HNP: Returning from HNP; no hub reset from b_idle\n");
150 musb->port1_status &= ~USB_PORT_STAT_RESET;
154 if (!is_host_active(musb))
157 /* NOTE: caller guarantees it will turn off the reset when
158 * the appropriate amount of time has passed
160 power = musb_readb(mbase, MUSB_POWER);
163 * If RESUME is set, we must make sure it stays minimum 20 ms.
164 * Then we must clear RESUME and wait a bit to let musb start
165 * generating SOFs. If we don't do this, OPT HS A 6.8 tests
166 * fail with "Error! Did not receive an SOF before suspend
169 if (power & MUSB_POWER_RESUME) {
170 long remain = (unsigned long) musb->rh_timer - jiffies;
172 if (musb->rh_timer > 0 && remain > 0) {
173 /* take into account the minimum delay after resume */
174 schedule_delayed_work(
175 &musb->deassert_reset_work, remain);
179 musb_writeb(mbase, MUSB_POWER,
180 power & ~MUSB_POWER_RESUME);
182 /* Give the core 1 ms to clear MUSB_POWER_RESUME */
183 schedule_delayed_work(&musb->deassert_reset_work,
184 msecs_to_jiffies(1));
189 musb_writeb(mbase, MUSB_POWER,
190 power | MUSB_POWER_RESET);
192 musb->port1_status |= USB_PORT_STAT_RESET;
193 musb->port1_status &= ~USB_PORT_STAT_ENABLE;
194 schedule_delayed_work(&musb->deassert_reset_work,
195 msecs_to_jiffies(50));
197 dev_dbg(musb->controller, "root port reset stopped\n");
198 musb_platform_pre_root_reset_end(musb);
199 musb_writeb(mbase, MUSB_POWER,
200 power & ~MUSB_POWER_RESET);
201 musb_platform_post_root_reset_end(musb);
203 power = musb_readb(mbase, MUSB_POWER);
204 if (power & MUSB_POWER_HSMODE) {
205 dev_dbg(musb->controller, "high-speed device connected\n");
206 musb->port1_status |= USB_PORT_STAT_HIGH_SPEED;
209 musb->port1_status &= ~USB_PORT_STAT_RESET;
210 musb->port1_status |= USB_PORT_STAT_ENABLE
211 | (USB_PORT_STAT_C_RESET << 16)
212 | (USB_PORT_STAT_C_ENABLE << 16);
213 usb_hcd_poll_rh_status(musb->hcd);
215 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
219 void musb_root_disconnect(struct musb *musb)
221 struct usb_otg *otg = musb->xceiv->otg;
223 musb->port1_status = USB_PORT_STAT_POWER
224 | (USB_PORT_STAT_C_CONNECTION << 16);
226 usb_hcd_poll_rh_status(musb->hcd);
229 switch (musb->xceiv->otg->state) {
230 case OTG_STATE_A_SUSPEND:
231 if (otg->host->b_hnp_enable) {
232 musb->xceiv->otg->state = OTG_STATE_A_PERIPHERAL;
233 musb->g.is_a_peripheral = 1;
237 case OTG_STATE_A_HOST:
238 musb->xceiv->otg->state = OTG_STATE_A_WAIT_BCON;
241 case OTG_STATE_A_WAIT_VFALL:
242 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
245 dev_dbg(musb->controller, "host disconnect (%s)\n",
246 usb_otg_state_string(musb->xceiv->otg->state));
251 /*---------------------------------------------------------------------*/
253 /* Caller may or may not hold musb->lock */
254 int musb_hub_status_data(struct usb_hcd *hcd, char *buf)
256 struct musb *musb = hcd_to_musb(hcd);
259 /* called in_irq() via usb_hcd_poll_rh_status() */
260 if (musb->port1_status & 0xffff0000) {
267 static int musb_has_gadget(struct musb *musb)
270 * In host-only mode we start a connection right away. In OTG mode
271 * we have to wait until we loaded a gadget. We don't really need a
272 * gadget if we operate as a host but we should not start a session
273 * as a device without a gadget or else we explode.
275 #ifdef CONFIG_USB_MUSB_HOST
278 if (musb->port_mode == MUSB_PORT_MODE_HOST)
280 return musb->g.dev.driver != NULL;
284 int musb_hub_control(
292 struct musb *musb = hcd_to_musb(hcd);
297 spin_lock_irqsave(&musb->lock, flags);
299 if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) {
300 spin_unlock_irqrestore(&musb->lock, flags);
304 /* hub features: always zero, setting is a NOP
305 * port features: reported, sometimes updated when host is active
309 case ClearHubFeature:
312 case C_HUB_OVER_CURRENT:
313 case C_HUB_LOCAL_POWER:
319 case ClearPortFeature:
320 if ((wIndex & 0xff) != 1)
324 case USB_PORT_FEAT_ENABLE:
326 case USB_PORT_FEAT_SUSPEND:
327 musb_port_suspend(musb, false);
329 case USB_PORT_FEAT_POWER:
330 if (!hcd->self.is_b_host)
331 musb_platform_set_vbus(musb, 0);
333 case USB_PORT_FEAT_C_CONNECTION:
334 case USB_PORT_FEAT_C_ENABLE:
335 case USB_PORT_FEAT_C_OVER_CURRENT:
336 case USB_PORT_FEAT_C_RESET:
337 case USB_PORT_FEAT_C_SUSPEND:
342 dev_dbg(musb->controller, "clear feature %d\n", wValue);
343 musb->port1_status &= ~(1 << wValue);
345 case GetHubDescriptor:
347 struct usb_hub_descriptor *desc = (void *)buf;
349 desc->bDescLength = 9;
350 desc->bDescriptorType = USB_DT_HUB;
352 desc->wHubCharacteristics = cpu_to_le16(
353 HUB_CHAR_INDV_PORT_LPSM /* per-port power switching */
354 | HUB_CHAR_NO_OCPM /* no overcurrent reporting */
356 desc->bPwrOn2PwrGood = 5; /* msec/2 */
357 desc->bHubContrCurrent = 0;
359 /* workaround bogus struct definition */
360 desc->u.hs.DeviceRemovable[0] = 0x02; /* port 1 */
361 desc->u.hs.DeviceRemovable[1] = 0xff;
366 *(__le32 *) buf = cpu_to_le32(temp);
372 put_unaligned(cpu_to_le32(musb->port1_status
373 & ~MUSB_PORT_STAT_RESUME),
376 /* port change status is more interesting */
377 dev_dbg(musb->controller, "port status %08x\n",
381 if ((wIndex & 0xff) != 1)
385 case USB_PORT_FEAT_POWER:
386 /* NOTE: this controller has a strange state machine
387 * that involves "requesting sessions" according to
388 * magic side effects from incompletely-described
389 * rules about startup...
391 * This call is what really starts the host mode; be
392 * very careful about side effects if you reorder any
393 * initialization logic, e.g. for OTG, or change any
394 * logic relating to VBUS power-up.
396 if (!hcd->self.is_b_host && musb_has_gadget(musb))
399 case USB_PORT_FEAT_RESET:
400 musb_port_reset(musb, true);
402 case USB_PORT_FEAT_SUSPEND:
403 musb_port_suspend(musb, true);
405 case USB_PORT_FEAT_TEST:
406 if (unlikely(is_host_active(musb)))
412 pr_debug("TEST_J\n");
416 pr_debug("TEST_K\n");
420 pr_debug("TEST_SE0_NAK\n");
421 temp = MUSB_TEST_SE0_NAK;
424 pr_debug("TEST_PACKET\n");
425 temp = MUSB_TEST_PACKET;
426 musb_load_testpacket(musb);
429 pr_debug("TEST_FORCE_ENABLE\n");
430 temp = MUSB_TEST_FORCE_HOST
431 | MUSB_TEST_FORCE_HS;
433 musb_writeb(musb->mregs, MUSB_DEVCTL,
434 MUSB_DEVCTL_SESSION);
437 pr_debug("TEST_FIFO_ACCESS\n");
438 temp = MUSB_TEST_FIFO_ACCESS;
443 musb_writeb(musb->mregs, MUSB_TESTMODE, temp);
448 dev_dbg(musb->controller, "set feature %d\n", wValue);
449 musb->port1_status |= 1 << wValue;
454 /* "protocol stall" on error */
457 spin_unlock_irqrestore(&musb->lock, flags);