usb: gadget: fix ptr_ret.cocci warnings
[linux-2.6-block.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 38#include <linux/errno.h>
550a7375
FB
39#include <linux/time.h>
40#include <linux/timer.h>
41
42#include <asm/unaligned.h>
43
44#include "musb_core.h"
45
8ed1fb79
DM
46void musb_host_finish_resume(struct work_struct *work)
47{
48 struct musb *musb;
49 unsigned long flags;
50 u8 power;
51
fa6997d3 52 musb = container_of(work, struct musb, finish_resume_work.work);
8ed1fb79
DM
53
54 spin_lock_irqsave(&musb->lock, flags);
55
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",
59 power);
60 musb_writeb(musb->mregs, MUSB_POWER, power);
61
62 /*
63 * ISSUE: DaVinci (RTL 1.300) disconnects after
64 * resume of high speed peripherals (but not full
65 * speed ones).
66 */
67 musb->is_active = 1;
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->state = OTG_STATE_A_HOST;
73
74 spin_unlock_irqrestore(&musb->lock, flags);
75}
76
94f72136 77void musb_port_suspend(struct musb *musb, bool do_suspend)
550a7375 78{
d445b6da 79 struct usb_otg *otg = musb->xceiv->otg;
550a7375
FB
80 u8 power;
81 void __iomem *mbase = musb->mregs;
82
83 if (!is_host_active(musb))
84 return;
85
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.
90 */
91 power = musb_readb(mbase, MUSB_POWER);
92 if (do_suspend) {
93 int retries = 10000;
94
95 power &= ~MUSB_POWER_RESUME;
96 power |= MUSB_POWER_SUSPENDM;
97 musb_writeb(mbase, MUSB_POWER, power);
98
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);
103 if (retries-- < 1)
104 break;
105 }
106
5c8a86e1 107 dev_dbg(musb->controller, "Root port suspended, power %02x\n", power);
550a7375
FB
108
109 musb->port1_status |= USB_PORT_STAT_SUSPEND;
84e250ff 110 switch (musb->xceiv->state) {
550a7375 111 case OTG_STATE_A_HOST:
84e250ff 112 musb->xceiv->state = OTG_STATE_A_SUSPEND;
032ec49f 113 musb->is_active = otg->host->b_hnp_enable;
ab983f2a
DB
114 if (musb->is_active)
115 mod_timer(&musb->otg_timer, jiffies
116 + msecs_to_jiffies(
117 OTG_TIME_A_AIDL_BDIS));
550a7375
FB
118 musb_platform_try_idle(musb, 0);
119 break;
550a7375 120 case OTG_STATE_B_HOST:
84e250ff 121 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
032ec49f 122 musb->is_active = otg->host->b_hnp_enable;
550a7375
FB
123 musb_platform_try_idle(musb, 0);
124 break;
550a7375 125 default:
5c8a86e1 126 dev_dbg(musb->controller, "bogus rh suspend? %s\n",
42c0bf1c 127 usb_otg_state_string(musb->xceiv->state));
550a7375
FB
128 }
129 } else if (power & MUSB_POWER_SUSPENDM) {
130 power &= ~MUSB_POWER_SUSPENDM;
131 power |= MUSB_POWER_RESUME;
132 musb_writeb(mbase, MUSB_POWER, power);
133
5c8a86e1 134 dev_dbg(musb->controller, "Root port resuming, power %02x\n", power);
550a7375
FB
135
136 /* later, GetPortStatus will stop RESUME signaling */
137 musb->port1_status |= MUSB_PORT_STAT_RESUME;
f2dece44
DM
138 schedule_delayed_work(&musb->finish_resume_work,
139 msecs_to_jiffies(20));
550a7375
FB
140 }
141}
142
869c5978 143void musb_port_reset(struct musb *musb, bool do_reset)
550a7375
FB
144{
145 u8 power;
146 void __iomem *mbase = musb->mregs;
147
84e250ff 148 if (musb->xceiv->state == OTG_STATE_B_IDLE) {
5c8a86e1 149 dev_dbg(musb->controller, "HNP: Returning from HNP; no hub reset from b_idle\n");
550a7375
FB
150 musb->port1_status &= ~USB_PORT_STAT_RESET;
151 return;
152 }
550a7375
FB
153
154 if (!is_host_active(musb))
155 return;
156
157 /* NOTE: caller guarantees it will turn off the reset when
158 * the appropriate amount of time has passed
159 */
160 power = musb_readb(mbase, MUSB_POWER);
161 if (do_reset) {
550a7375
FB
162 /*
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
167 * detected".
168 */
169 if (power & MUSB_POWER_RESUME) {
73926db3
DM
170 long remain = (unsigned long) musb->rh_timer - jiffies;
171
172 if (musb->rh_timer > 0 && remain > 0) {
173 /* take into account the minimum delay after resume */
174 schedule_delayed_work(
f2dece44 175 &musb->deassert_reset_work, remain);
73926db3
DM
176 return;
177 }
178
550a7375 179 musb_writeb(mbase, MUSB_POWER,
73926db3
DM
180 power & ~MUSB_POWER_RESUME);
181
182 /* Give the core 1 ms to clear MUSB_POWER_RESUME */
f2dece44
DM
183 schedule_delayed_work(&musb->deassert_reset_work,
184 msecs_to_jiffies(1));
73926db3 185 return;
550a7375
FB
186 }
187
550a7375
FB
188 power &= 0xf0;
189 musb_writeb(mbase, MUSB_POWER,
190 power | MUSB_POWER_RESET);
191
192 musb->port1_status |= USB_PORT_STAT_RESET;
193 musb->port1_status &= ~USB_PORT_STAT_ENABLE;
f2dece44
DM
194 schedule_delayed_work(&musb->deassert_reset_work,
195 msecs_to_jiffies(50));
550a7375 196 } else {
5c8a86e1 197 dev_dbg(musb->controller, "root port reset stopped\n");
550a7375
FB
198 musb_writeb(mbase, MUSB_POWER,
199 power & ~MUSB_POWER_RESET);
200
550a7375
FB
201 power = musb_readb(mbase, MUSB_POWER);
202 if (power & MUSB_POWER_HSMODE) {
5c8a86e1 203 dev_dbg(musb->controller, "high-speed device connected\n");
550a7375
FB
204 musb->port1_status |= USB_PORT_STAT_HIGH_SPEED;
205 }
206
207 musb->port1_status &= ~USB_PORT_STAT_RESET;
208 musb->port1_status |= USB_PORT_STAT_ENABLE
209 | (USB_PORT_STAT_C_RESET << 16)
210 | (USB_PORT_STAT_C_ENABLE << 16);
8b125df5 211 usb_hcd_poll_rh_status(musb->hcd);
550a7375
FB
212
213 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
214 }
215}
216
217void musb_root_disconnect(struct musb *musb)
218{
d445b6da
HK
219 struct usb_otg *otg = musb->xceiv->otg;
220
749da5f8
AS
221 musb->port1_status = USB_PORT_STAT_POWER
222 | (USB_PORT_STAT_C_CONNECTION << 16);
550a7375 223
8b125df5 224 usb_hcd_poll_rh_status(musb->hcd);
550a7375
FB
225 musb->is_active = 0;
226
84e250ff 227 switch (musb->xceiv->state) {
550a7375 228 case OTG_STATE_A_SUSPEND:
032ec49f 229 if (otg->host->b_hnp_enable) {
1de00dae
DB
230 musb->xceiv->state = OTG_STATE_A_PERIPHERAL;
231 musb->g.is_a_peripheral = 1;
232 break;
233 }
1de00dae
DB
234 /* FALLTHROUGH */
235 case OTG_STATE_A_HOST:
84e250ff 236 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
550a7375
FB
237 musb->is_active = 0;
238 break;
239 case OTG_STATE_A_WAIT_VFALL:
84e250ff 240 musb->xceiv->state = OTG_STATE_B_IDLE;
550a7375
FB
241 break;
242 default:
5c8a86e1 243 dev_dbg(musb->controller, "host disconnect (%s)\n",
42c0bf1c 244 usb_otg_state_string(musb->xceiv->state));
550a7375
FB
245 }
246}
247
248
249/*---------------------------------------------------------------------*/
250
251/* Caller may or may not hold musb->lock */
252int musb_hub_status_data(struct usb_hcd *hcd, char *buf)
253{
254 struct musb *musb = hcd_to_musb(hcd);
255 int retval = 0;
256
257 /* called in_irq() via usb_hcd_poll_rh_status() */
258 if (musb->port1_status & 0xffff0000) {
259 *buf = 0x02;
260 retval = 1;
261 }
262 return retval;
263}
264
ae44df2e
SAS
265static int musb_has_gadget(struct musb *musb)
266{
267 /*
268 * In host-only mode we start a connection right away. In OTG mode
269 * we have to wait until we loaded a gadget. We don't really need a
270 * gadget if we operate as a host but we should not start a session
271 * as a device without a gadget or else we explode.
272 */
273#ifdef CONFIG_USB_MUSB_HOST
274 return 1;
275#else
276 if (musb->port_mode == MUSB_PORT_MODE_HOST)
277 return 1;
278 return musb->g.dev.driver != NULL;
279#endif
280}
281
550a7375
FB
282int musb_hub_control(
283 struct usb_hcd *hcd,
284 u16 typeReq,
285 u16 wValue,
286 u16 wIndex,
287 char *buf,
288 u16 wLength)
289{
290 struct musb *musb = hcd_to_musb(hcd);
291 u32 temp;
292 int retval = 0;
293 unsigned long flags;
294
295 spin_lock_irqsave(&musb->lock, flags);
296
541c7d43 297 if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) {
550a7375
FB
298 spin_unlock_irqrestore(&musb->lock, flags);
299 return -ESHUTDOWN;
300 }
301
302 /* hub features: always zero, setting is a NOP
303 * port features: reported, sometimes updated when host is active
304 * no indicators
305 */
306 switch (typeReq) {
307 case ClearHubFeature:
308 case SetHubFeature:
309 switch (wValue) {
310 case C_HUB_OVER_CURRENT:
311 case C_HUB_LOCAL_POWER:
312 break;
313 default:
314 goto error;
315 }
316 break;
317 case ClearPortFeature:
318 if ((wIndex & 0xff) != 1)
319 goto error;
320
321 switch (wValue) {
322 case USB_PORT_FEAT_ENABLE:
323 break;
324 case USB_PORT_FEAT_SUSPEND:
325 musb_port_suspend(musb, false);
326 break;
327 case USB_PORT_FEAT_POWER:
032ec49f 328 if (!hcd->self.is_b_host)
743411b3 329 musb_platform_set_vbus(musb, 0);
550a7375
FB
330 break;
331 case USB_PORT_FEAT_C_CONNECTION:
332 case USB_PORT_FEAT_C_ENABLE:
333 case USB_PORT_FEAT_C_OVER_CURRENT:
334 case USB_PORT_FEAT_C_RESET:
335 case USB_PORT_FEAT_C_SUSPEND:
336 break;
337 default:
338 goto error;
339 }
5c8a86e1 340 dev_dbg(musb->controller, "clear feature %d\n", wValue);
550a7375
FB
341 musb->port1_status &= ~(1 << wValue);
342 break;
343 case GetHubDescriptor:
344 {
345 struct usb_hub_descriptor *desc = (void *)buf;
346
347 desc->bDescLength = 9;
348 desc->bDescriptorType = 0x29;
349 desc->bNbrPorts = 1;
551509d2 350 desc->wHubCharacteristics = cpu_to_le16(
550a7375
FB
351 0x0001 /* per-port power switching */
352 | 0x0010 /* no overcurrent reporting */
353 );
354 desc->bPwrOn2PwrGood = 5; /* msec/2 */
355 desc->bHubContrCurrent = 0;
356
357 /* workaround bogus struct definition */
dbe79bbe
JY
358 desc->u.hs.DeviceRemovable[0] = 0x02; /* port 1 */
359 desc->u.hs.DeviceRemovable[1] = 0xff;
550a7375
FB
360 }
361 break;
362 case GetHubStatus:
363 temp = 0;
364 *(__le32 *) buf = cpu_to_le32(temp);
365 break;
366 case GetPortStatus:
367 if (wIndex != 1)
368 goto error;
369
550a7375
FB
370 put_unaligned(cpu_to_le32(musb->port1_status
371 & ~MUSB_PORT_STAT_RESUME),
372 (__le32 *) buf);
373
374 /* port change status is more interesting */
5c8a86e1 375 dev_dbg(musb->controller, "port status %08x\n",
550a7375
FB
376 musb->port1_status);
377 break;
378 case SetPortFeature:
379 if ((wIndex & 0xff) != 1)
380 goto error;
381
382 switch (wValue) {
383 case USB_PORT_FEAT_POWER:
384 /* NOTE: this controller has a strange state machine
385 * that involves "requesting sessions" according to
386 * magic side effects from incompletely-described
387 * rules about startup...
388 *
389 * This call is what really starts the host mode; be
390 * very careful about side effects if you reorder any
391 * initialization logic, e.g. for OTG, or change any
392 * logic relating to VBUS power-up.
393 */
ae44df2e 394 if (!hcd->self.is_b_host && musb_has_gadget(musb))
550a7375
FB
395 musb_start(musb);
396 break;
397 case USB_PORT_FEAT_RESET:
398 musb_port_reset(musb, true);
399 break;
400 case USB_PORT_FEAT_SUSPEND:
401 musb_port_suspend(musb, true);
402 break;
403 case USB_PORT_FEAT_TEST:
404 if (unlikely(is_host_active(musb)))
405 goto error;
406
407 wIndex >>= 8;
408 switch (wIndex) {
409 case 1:
410 pr_debug("TEST_J\n");
411 temp = MUSB_TEST_J;
412 break;
413 case 2:
414 pr_debug("TEST_K\n");
415 temp = MUSB_TEST_K;
416 break;
417 case 3:
418 pr_debug("TEST_SE0_NAK\n");
419 temp = MUSB_TEST_SE0_NAK;
420 break;
421 case 4:
422 pr_debug("TEST_PACKET\n");
423 temp = MUSB_TEST_PACKET;
424 musb_load_testpacket(musb);
425 break;
426 case 5:
427 pr_debug("TEST_FORCE_ENABLE\n");
428 temp = MUSB_TEST_FORCE_HOST
429 | MUSB_TEST_FORCE_HS;
430
431 musb_writeb(musb->mregs, MUSB_DEVCTL,
432 MUSB_DEVCTL_SESSION);
433 break;
434 case 6:
435 pr_debug("TEST_FIFO_ACCESS\n");
436 temp = MUSB_TEST_FIFO_ACCESS;
437 break;
438 default:
439 goto error;
440 }
441 musb_writeb(musb->mregs, MUSB_TESTMODE, temp);
442 break;
443 default:
444 goto error;
445 }
5c8a86e1 446 dev_dbg(musb->controller, "set feature %d\n", wValue);
550a7375
FB
447 musb->port1_status |= 1 << wValue;
448 break;
449
450 default:
451error:
452 /* "protocol stall" on error */
453 retval = -EPIPE;
454 }
455 spin_unlock_irqrestore(&musb->lock, flags);
456 return retval;
457}