usb: musb: call musb_start() only once in OTG mode
[deliverable/linux.git] / drivers / usb / musb / musb_virthub.c
CommitLineData
550a7375
FB
1/*
2 * MUSB OTG driver virtual root hub support
3 *
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
7 *
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.
11 *
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.
16 *
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
20 * 02110-1301 USA
21 *
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.
32 *
33 */
34
35#include <linux/module.h>
36#include <linux/kernel.h>
37#include <linux/sched.h>
550a7375
FB
38#include <linux/errno.h>
39#include <linux/init.h>
40#include <linux/time.h>
41#include <linux/timer.h>
42
43#include <asm/unaligned.h>
44
45#include "musb_core.h"
46
69ae2a70
DM
47/*
48* Program the HDRC to start (enable interrupts, dma, etc.).
49*/
50static void musb_start(struct musb *musb)
51{
52 void __iomem *regs = musb->mregs;
53 u8 devctl = musb_readb(regs, MUSB_DEVCTL);
54
55 dev_dbg(musb->controller, "<== devctl %02x\n", devctl);
56
57 /* Set INT enable registers, enable interrupts */
58 musb->intrtxe = musb->epmask;
59 musb_writew(regs, MUSB_INTRTXE, musb->intrtxe);
60 musb->intrrxe = musb->epmask & 0xfffe;
61 musb_writew(regs, MUSB_INTRRXE, musb->intrrxe);
62 musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
63
64 musb_writeb(regs, MUSB_TESTMODE, 0);
65
66 /* put into basic highspeed mode and start session */
67 musb_writeb(regs, MUSB_POWER, MUSB_POWER_ISOUPDATE
68 | MUSB_POWER_HSENAB
69 /* ENSUSPEND wedges tusb */
70 /* | MUSB_POWER_ENSUSPEND */
71 );
72
73 musb->is_active = 0;
74 devctl = musb_readb(regs, MUSB_DEVCTL);
75 devctl &= ~MUSB_DEVCTL_SESSION;
76
77 /* session started after:
78 * (a) ID-grounded irq, host mode;
79 * (b) vbus present/connect IRQ, peripheral mode;
80 * (c) peripheral initiates, using SRP
81 */
6c5f6a6f
DM
82 if (musb->port_mode != MUSB_PORT_MODE_HOST &&
83 (devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS) {
69ae2a70
DM
84 musb->is_active = 1;
85 } else {
86 devctl |= MUSB_DEVCTL_SESSION;
87 }
88
89 musb_platform_enable(musb);
90 musb_writeb(regs, MUSB_DEVCTL, devctl);
91}
550a7375
FB
92
93static void musb_port_suspend(struct musb *musb, bool do_suspend)
94{
d445b6da 95 struct usb_otg *otg = musb->xceiv->otg;
550a7375
FB
96 u8 power;
97 void __iomem *mbase = musb->mregs;
98
99 if (!is_host_active(musb))
100 return;
101
102 /* NOTE: this doesn't necessarily put PHY into low power mode,
103 * turning off its clock; that's a function of PHY integration and
104 * MUSB_POWER_ENSUSPEND. PHY may need a clock (sigh) to detect
105 * SE0 changing to connect (J) or wakeup (K) states.
106 */
107 power = musb_readb(mbase, MUSB_POWER);
108 if (do_suspend) {
109 int retries = 10000;
110
111 power &= ~MUSB_POWER_RESUME;
112 power |= MUSB_POWER_SUSPENDM;
113 musb_writeb(mbase, MUSB_POWER, power);
114
115 /* Needed for OPT A tests */
116 power = musb_readb(mbase, MUSB_POWER);
117 while (power & MUSB_POWER_SUSPENDM) {
118 power = musb_readb(mbase, MUSB_POWER);
119 if (retries-- < 1)
120 break;
121 }
122
5c8a86e1 123 dev_dbg(musb->controller, "Root port suspended, power %02x\n", power);
550a7375
FB
124
125 musb->port1_status |= USB_PORT_STAT_SUSPEND;
84e250ff 126 switch (musb->xceiv->state) {
550a7375 127 case OTG_STATE_A_HOST:
84e250ff 128 musb->xceiv->state = OTG_STATE_A_SUSPEND;
032ec49f 129 musb->is_active = otg->host->b_hnp_enable;
ab983f2a
DB
130 if (musb->is_active)
131 mod_timer(&musb->otg_timer, jiffies
132 + msecs_to_jiffies(
133 OTG_TIME_A_AIDL_BDIS));
550a7375
FB
134 musb_platform_try_idle(musb, 0);
135 break;
550a7375 136 case OTG_STATE_B_HOST:
84e250ff 137 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
032ec49f 138 musb->is_active = otg->host->b_hnp_enable;
550a7375
FB
139 musb_platform_try_idle(musb, 0);
140 break;
550a7375 141 default:
5c8a86e1 142 dev_dbg(musb->controller, "bogus rh suspend? %s\n",
42c0bf1c 143 usb_otg_state_string(musb->xceiv->state));
550a7375
FB
144 }
145 } else if (power & MUSB_POWER_SUSPENDM) {
146 power &= ~MUSB_POWER_SUSPENDM;
147 power |= MUSB_POWER_RESUME;
148 musb_writeb(mbase, MUSB_POWER, power);
149
5c8a86e1 150 dev_dbg(musb->controller, "Root port resuming, power %02x\n", power);
550a7375
FB
151
152 /* later, GetPortStatus will stop RESUME signaling */
153 musb->port1_status |= MUSB_PORT_STAT_RESUME;
154 musb->rh_timer = jiffies + msecs_to_jiffies(20);
155 }
156}
157
158static void musb_port_reset(struct musb *musb, bool do_reset)
159{
160 u8 power;
161 void __iomem *mbase = musb->mregs;
162
84e250ff 163 if (musb->xceiv->state == OTG_STATE_B_IDLE) {
5c8a86e1 164 dev_dbg(musb->controller, "HNP: Returning from HNP; no hub reset from b_idle\n");
550a7375
FB
165 musb->port1_status &= ~USB_PORT_STAT_RESET;
166 return;
167 }
550a7375
FB
168
169 if (!is_host_active(musb))
170 return;
171
172 /* NOTE: caller guarantees it will turn off the reset when
173 * the appropriate amount of time has passed
174 */
175 power = musb_readb(mbase, MUSB_POWER);
176 if (do_reset) {
177
178 /*
179 * If RESUME is set, we must make sure it stays minimum 20 ms.
180 * Then we must clear RESUME and wait a bit to let musb start
181 * generating SOFs. If we don't do this, OPT HS A 6.8 tests
182 * fail with "Error! Did not receive an SOF before suspend
183 * detected".
184 */
185 if (power & MUSB_POWER_RESUME) {
186 while (time_before(jiffies, musb->rh_timer))
187 msleep(1);
188 musb_writeb(mbase, MUSB_POWER,
189 power & ~MUSB_POWER_RESUME);
190 msleep(1);
191 }
192
550a7375
FB
193 power &= 0xf0;
194 musb_writeb(mbase, MUSB_POWER,
195 power | MUSB_POWER_RESET);
196
197 musb->port1_status |= USB_PORT_STAT_RESET;
198 musb->port1_status &= ~USB_PORT_STAT_ENABLE;
199 musb->rh_timer = jiffies + msecs_to_jiffies(50);
200 } else {
5c8a86e1 201 dev_dbg(musb->controller, "root port reset stopped\n");
550a7375
FB
202 musb_writeb(mbase, MUSB_POWER,
203 power & ~MUSB_POWER_RESET);
204
550a7375
FB
205 power = musb_readb(mbase, MUSB_POWER);
206 if (power & MUSB_POWER_HSMODE) {
5c8a86e1 207 dev_dbg(musb->controller, "high-speed device connected\n");
550a7375
FB
208 musb->port1_status |= USB_PORT_STAT_HIGH_SPEED;
209 }
210
211 musb->port1_status &= ~USB_PORT_STAT_RESET;
212 musb->port1_status |= USB_PORT_STAT_ENABLE
213 | (USB_PORT_STAT_C_RESET << 16)
214 | (USB_PORT_STAT_C_ENABLE << 16);
8b125df5 215 usb_hcd_poll_rh_status(musb->hcd);
550a7375
FB
216
217 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
218 }
219}
220
221void musb_root_disconnect(struct musb *musb)
222{
d445b6da
HK
223 struct usb_otg *otg = musb->xceiv->otg;
224
749da5f8
AS
225 musb->port1_status = USB_PORT_STAT_POWER
226 | (USB_PORT_STAT_C_CONNECTION << 16);
550a7375 227
8b125df5 228 usb_hcd_poll_rh_status(musb->hcd);
550a7375
FB
229 musb->is_active = 0;
230
84e250ff 231 switch (musb->xceiv->state) {
550a7375 232 case OTG_STATE_A_SUSPEND:
032ec49f 233 if (otg->host->b_hnp_enable) {
1de00dae
DB
234 musb->xceiv->state = OTG_STATE_A_PERIPHERAL;
235 musb->g.is_a_peripheral = 1;
236 break;
237 }
1de00dae
DB
238 /* FALLTHROUGH */
239 case OTG_STATE_A_HOST:
84e250ff 240 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
550a7375
FB
241 musb->is_active = 0;
242 break;
243 case OTG_STATE_A_WAIT_VFALL:
84e250ff 244 musb->xceiv->state = OTG_STATE_B_IDLE;
550a7375
FB
245 break;
246 default:
5c8a86e1 247 dev_dbg(musb->controller, "host disconnect (%s)\n",
42c0bf1c 248 usb_otg_state_string(musb->xceiv->state));
550a7375
FB
249 }
250}
251
252
253/*---------------------------------------------------------------------*/
254
255/* Caller may or may not hold musb->lock */
256int musb_hub_status_data(struct usb_hcd *hcd, char *buf)
257{
258 struct musb *musb = hcd_to_musb(hcd);
259 int retval = 0;
260
261 /* called in_irq() via usb_hcd_poll_rh_status() */
262 if (musb->port1_status & 0xffff0000) {
263 *buf = 0x02;
264 retval = 1;
265 }
266 return retval;
267}
268
ae44df2e
SAS
269static int musb_has_gadget(struct musb *musb)
270{
271 /*
272 * In host-only mode we start a connection right away. In OTG mode
273 * we have to wait until we loaded a gadget. We don't really need a
274 * gadget if we operate as a host but we should not start a session
275 * as a device without a gadget or else we explode.
276 */
277#ifdef CONFIG_USB_MUSB_HOST
278 return 1;
279#else
280 if (musb->port_mode == MUSB_PORT_MODE_HOST)
281 return 1;
282 return musb->g.dev.driver != NULL;
283#endif
284}
285
550a7375
FB
286int musb_hub_control(
287 struct usb_hcd *hcd,
288 u16 typeReq,
289 u16 wValue,
290 u16 wIndex,
291 char *buf,
292 u16 wLength)
293{
294 struct musb *musb = hcd_to_musb(hcd);
295 u32 temp;
296 int retval = 0;
297 unsigned long flags;
298
299 spin_lock_irqsave(&musb->lock, flags);
300
541c7d43 301 if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) {
550a7375
FB
302 spin_unlock_irqrestore(&musb->lock, flags);
303 return -ESHUTDOWN;
304 }
305
306 /* hub features: always zero, setting is a NOP
307 * port features: reported, sometimes updated when host is active
308 * no indicators
309 */
310 switch (typeReq) {
311 case ClearHubFeature:
312 case SetHubFeature:
313 switch (wValue) {
314 case C_HUB_OVER_CURRENT:
315 case C_HUB_LOCAL_POWER:
316 break;
317 default:
318 goto error;
319 }
320 break;
321 case ClearPortFeature:
322 if ((wIndex & 0xff) != 1)
323 goto error;
324
325 switch (wValue) {
326 case USB_PORT_FEAT_ENABLE:
327 break;
328 case USB_PORT_FEAT_SUSPEND:
329 musb_port_suspend(musb, false);
330 break;
331 case USB_PORT_FEAT_POWER:
032ec49f 332 if (!hcd->self.is_b_host)
743411b3 333 musb_platform_set_vbus(musb, 0);
550a7375
FB
334 break;
335 case USB_PORT_FEAT_C_CONNECTION:
336 case USB_PORT_FEAT_C_ENABLE:
337 case USB_PORT_FEAT_C_OVER_CURRENT:
338 case USB_PORT_FEAT_C_RESET:
339 case USB_PORT_FEAT_C_SUSPEND:
340 break;
341 default:
342 goto error;
343 }
5c8a86e1 344 dev_dbg(musb->controller, "clear feature %d\n", wValue);
550a7375
FB
345 musb->port1_status &= ~(1 << wValue);
346 break;
347 case GetHubDescriptor:
348 {
349 struct usb_hub_descriptor *desc = (void *)buf;
350
351 desc->bDescLength = 9;
352 desc->bDescriptorType = 0x29;
353 desc->bNbrPorts = 1;
551509d2 354 desc->wHubCharacteristics = cpu_to_le16(
550a7375
FB
355 0x0001 /* per-port power switching */
356 | 0x0010 /* no overcurrent reporting */
357 );
358 desc->bPwrOn2PwrGood = 5; /* msec/2 */
359 desc->bHubContrCurrent = 0;
360
361 /* workaround bogus struct definition */
dbe79bbe
JY
362 desc->u.hs.DeviceRemovable[0] = 0x02; /* port 1 */
363 desc->u.hs.DeviceRemovable[1] = 0xff;
550a7375
FB
364 }
365 break;
366 case GetHubStatus:
367 temp = 0;
368 *(__le32 *) buf = cpu_to_le32(temp);
369 break;
370 case GetPortStatus:
371 if (wIndex != 1)
372 goto error;
373
374 /* finish RESET signaling? */
375 if ((musb->port1_status & USB_PORT_STAT_RESET)
376 && time_after_eq(jiffies, musb->rh_timer))
377 musb_port_reset(musb, false);
378
379 /* finish RESUME signaling? */
380 if ((musb->port1_status & MUSB_PORT_STAT_RESUME)
381 && time_after_eq(jiffies, musb->rh_timer)) {
382 u8 power;
383
384 power = musb_readb(musb->mregs, MUSB_POWER);
385 power &= ~MUSB_POWER_RESUME;
5c8a86e1 386 dev_dbg(musb->controller, "root port resume stopped, power %02x\n",
550a7375
FB
387 power);
388 musb_writeb(musb->mregs, MUSB_POWER, power);
389
390 /* ISSUE: DaVinci (RTL 1.300) disconnects after
391 * resume of high speed peripherals (but not full
392 * speed ones).
393 */
394
395 musb->is_active = 1;
396 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
397 | MUSB_PORT_STAT_RESUME);
398 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
8b125df5 399 usb_hcd_poll_rh_status(musb->hcd);
550a7375 400 /* NOTE: it might really be A_WAIT_BCON ... */
84e250ff 401 musb->xceiv->state = OTG_STATE_A_HOST;
550a7375
FB
402 }
403
404 put_unaligned(cpu_to_le32(musb->port1_status
405 & ~MUSB_PORT_STAT_RESUME),
406 (__le32 *) buf);
407
408 /* port change status is more interesting */
5c8a86e1 409 dev_dbg(musb->controller, "port status %08x\n",
550a7375
FB
410 musb->port1_status);
411 break;
412 case SetPortFeature:
413 if ((wIndex & 0xff) != 1)
414 goto error;
415
416 switch (wValue) {
417 case USB_PORT_FEAT_POWER:
418 /* NOTE: this controller has a strange state machine
419 * that involves "requesting sessions" according to
420 * magic side effects from incompletely-described
421 * rules about startup...
422 *
423 * This call is what really starts the host mode; be
424 * very careful about side effects if you reorder any
425 * initialization logic, e.g. for OTG, or change any
426 * logic relating to VBUS power-up.
427 */
ae44df2e 428 if (!hcd->self.is_b_host && musb_has_gadget(musb))
550a7375
FB
429 musb_start(musb);
430 break;
431 case USB_PORT_FEAT_RESET:
432 musb_port_reset(musb, true);
433 break;
434 case USB_PORT_FEAT_SUSPEND:
435 musb_port_suspend(musb, true);
436 break;
437 case USB_PORT_FEAT_TEST:
438 if (unlikely(is_host_active(musb)))
439 goto error;
440
441 wIndex >>= 8;
442 switch (wIndex) {
443 case 1:
444 pr_debug("TEST_J\n");
445 temp = MUSB_TEST_J;
446 break;
447 case 2:
448 pr_debug("TEST_K\n");
449 temp = MUSB_TEST_K;
450 break;
451 case 3:
452 pr_debug("TEST_SE0_NAK\n");
453 temp = MUSB_TEST_SE0_NAK;
454 break;
455 case 4:
456 pr_debug("TEST_PACKET\n");
457 temp = MUSB_TEST_PACKET;
458 musb_load_testpacket(musb);
459 break;
460 case 5:
461 pr_debug("TEST_FORCE_ENABLE\n");
462 temp = MUSB_TEST_FORCE_HOST
463 | MUSB_TEST_FORCE_HS;
464
465 musb_writeb(musb->mregs, MUSB_DEVCTL,
466 MUSB_DEVCTL_SESSION);
467 break;
468 case 6:
469 pr_debug("TEST_FIFO_ACCESS\n");
470 temp = MUSB_TEST_FIFO_ACCESS;
471 break;
472 default:
473 goto error;
474 }
475 musb_writeb(musb->mregs, MUSB_TESTMODE, temp);
476 break;
477 default:
478 goto error;
479 }
5c8a86e1 480 dev_dbg(musb->controller, "set feature %d\n", wValue);
550a7375
FB
481 musb->port1_status |= 1 << wValue;
482 break;
483
484 default:
485error:
486 /* "protocol stall" on error */
487 retval = -EPIPE;
488 }
489 spin_unlock_irqrestore(&musb->lock, flags);
490 return retval;
491}
This page took 0.434224 seconds and 5 git commands to generate.