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>
38#include <linux/errno.h>
39#include <linux/time.h>
40#include <linux/timer.h>
41
42#include <asm/unaligned.h>
43
44#include "musb_core.h"
45
46void musb_host_finish_resume(struct work_struct *work)
47{
48	struct musb *musb;
49	unsigned long flags;
50	u8 power;
51
52	musb = container_of(work, struct musb, finish_resume_work.work);
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->otg->state = OTG_STATE_A_HOST;
73
74	spin_unlock_irqrestore(&musb->lock, flags);
75}
76
77void musb_port_suspend(struct musb *musb, bool do_suspend)
78{
79	struct usb_otg	*otg = musb->xceiv->otg;
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
107		dev_dbg(musb->controller, "Root port suspended, power %02x\n", power);
108
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;
114			if (musb->is_active)
115				mod_timer(&musb->otg_timer, jiffies
116					+ msecs_to_jiffies(
117						OTG_TIME_A_AIDL_BDIS));
118			musb_platform_try_idle(musb, 0);
119			break;
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);
124			break;
125		default:
126			dev_dbg(musb->controller, "bogus rh suspend? %s\n",
127				usb_otg_state_string(musb->xceiv->otg->state));
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
134		dev_dbg(musb->controller, "Root port resuming, power %02x\n", power);
135
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));
140	}
141}
142
143void musb_port_reset(struct musb *musb, bool do_reset)
144{
145	u8		power;
146	void __iomem	*mbase = musb->mregs;
147
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;
151		return;
152	}
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) {
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) {
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(
175					&musb->deassert_reset_work, remain);
176				return;
177			}
178
179			musb_writeb(mbase, MUSB_POWER,
180				    power & ~MUSB_POWER_RESUME);
181
182			/* Give the core 1 ms to clear MUSB_POWER_RESUME */
183			schedule_delayed_work(&musb->deassert_reset_work,
184					      msecs_to_jiffies(1));
185			return;
186		}
187
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;
194		schedule_delayed_work(&musb->deassert_reset_work,
195				      msecs_to_jiffies(50));
196	} else {
197		dev_dbg(musb->controller, "root port reset stopped\n");
198		musb_writeb(mbase, MUSB_POWER,
199				power & ~MUSB_POWER_RESET);
200
201		power = musb_readb(mbase, MUSB_POWER);
202		if (power & MUSB_POWER_HSMODE) {
203			dev_dbg(musb->controller, "high-speed device connected\n");
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);
211		usb_hcd_poll_rh_status(musb->hcd);
212
213		musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
214	}
215}
216
217void musb_root_disconnect(struct musb *musb)
218{
219	struct usb_otg	*otg = musb->xceiv->otg;
220
221	musb->port1_status = USB_PORT_STAT_POWER
222			| (USB_PORT_STAT_C_CONNECTION << 16);
223
224	usb_hcd_poll_rh_status(musb->hcd);
225	musb->is_active = 0;
226
227	switch (musb->xceiv->otg->state) {
228	case OTG_STATE_A_SUSPEND:
229		if (otg->host->b_hnp_enable) {
230			musb->xceiv->otg->state = OTG_STATE_A_PERIPHERAL;
231			musb->g.is_a_peripheral = 1;
232			break;
233		}
234		/* FALLTHROUGH */
235	case OTG_STATE_A_HOST:
236		musb->xceiv->otg->state = OTG_STATE_A_WAIT_BCON;
237		musb->is_active = 0;
238		break;
239	case OTG_STATE_A_WAIT_VFALL:
240		musb->xceiv->otg->state = OTG_STATE_B_IDLE;
241		break;
242	default:
243		dev_dbg(musb->controller, "host disconnect (%s)\n",
244			usb_otg_state_string(musb->xceiv->otg->state));
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
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	return musb->port_mode == MUSB_PORT_MODE_HOST;
277#endif
278}
279
280int musb_hub_control(
281	struct usb_hcd	*hcd,
282	u16		typeReq,
283	u16		wValue,
284	u16		wIndex,
285	char		*buf,
286	u16		wLength)
287{
288	struct musb	*musb = hcd_to_musb(hcd);
289	u32		temp;
290	int		retval = 0;
291	unsigned long	flags;
292
293	spin_lock_irqsave(&musb->lock, flags);
294
295	if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) {
296		spin_unlock_irqrestore(&musb->lock, flags);
297		return -ESHUTDOWN;
298	}
299
300	/* hub features:  always zero, setting is a NOP
301	 * port features: reported, sometimes updated when host is active
302	 * no indicators
303	 */
304	switch (typeReq) {
305	case ClearHubFeature:
306	case SetHubFeature:
307		switch (wValue) {
308		case C_HUB_OVER_CURRENT:
309		case C_HUB_LOCAL_POWER:
310			break;
311		default:
312			goto error;
313		}
314		break;
315	case ClearPortFeature:
316		if ((wIndex & 0xff) != 1)
317			goto error;
318
319		switch (wValue) {
320		case USB_PORT_FEAT_ENABLE:
321			break;
322		case USB_PORT_FEAT_SUSPEND:
323			musb_port_suspend(musb, false);
324			break;
325		case USB_PORT_FEAT_POWER:
326			if (!hcd->self.is_b_host)
327				musb_platform_set_vbus(musb, 0);
328			break;
329		case USB_PORT_FEAT_C_CONNECTION:
330		case USB_PORT_FEAT_C_ENABLE:
331		case USB_PORT_FEAT_C_OVER_CURRENT:
332		case USB_PORT_FEAT_C_RESET:
333		case USB_PORT_FEAT_C_SUSPEND:
334			break;
335		default:
336			goto error;
337		}
338		dev_dbg(musb->controller, "clear feature %d\n", wValue);
339		musb->port1_status &= ~(1 << wValue);
340		break;
341	case GetHubDescriptor:
342		{
343		struct usb_hub_descriptor *desc = (void *)buf;
344
345		desc->bDescLength = 9;
346		desc->bDescriptorType = USB_DT_HUB;
347		desc->bNbrPorts = 1;
348		desc->wHubCharacteristics = cpu_to_le16(
349			HUB_CHAR_INDV_PORT_LPSM /* per-port power switching */
350			| HUB_CHAR_NO_OCPM	/* no overcurrent reporting */
351			);
352		desc->bPwrOn2PwrGood = 5;	/* msec/2 */
353		desc->bHubContrCurrent = 0;
354
355		/* workaround bogus struct definition */
356		desc->u.hs.DeviceRemovable[0] = 0x02;	/* port 1 */
357		desc->u.hs.DeviceRemovable[1] = 0xff;
358		}
359		break;
360	case GetHubStatus:
361		temp = 0;
362		*(__le32 *) buf = cpu_to_le32(temp);
363		break;
364	case GetPortStatus:
365		if (wIndex != 1)
366			goto error;
367
368		put_unaligned(cpu_to_le32(musb->port1_status
369					& ~MUSB_PORT_STAT_RESUME),
370				(__le32 *) buf);
371
372		/* port change status is more interesting */
373		dev_dbg(musb->controller, "port status %08x\n",
374				musb->port1_status);
375		break;
376	case SetPortFeature:
377		if ((wIndex & 0xff) != 1)
378			goto error;
379
380		switch (wValue) {
381		case USB_PORT_FEAT_POWER:
382			/* NOTE: this controller has a strange state machine
383			 * that involves "requesting sessions" according to
384			 * magic side effects from incompletely-described
385			 * rules about startup...
386			 *
387			 * This call is what really starts the host mode; be
388			 * very careful about side effects if you reorder any
389			 * initialization logic, e.g. for OTG, or change any
390			 * logic relating to VBUS power-up.
391			 */
392			if (!hcd->self.is_b_host && musb_has_gadget(musb))
393				musb_start(musb);
394			break;
395		case USB_PORT_FEAT_RESET:
396			musb_port_reset(musb, true);
397			break;
398		case USB_PORT_FEAT_SUSPEND:
399			musb_port_suspend(musb, true);
400			break;
401		case USB_PORT_FEAT_TEST:
402			if (unlikely(is_host_active(musb)))
403				goto error;
404
405			wIndex >>= 8;
406			switch (wIndex) {
407			case 1:
408				pr_debug("TEST_J\n");
409				temp = MUSB_TEST_J;
410				break;
411			case 2:
412				pr_debug("TEST_K\n");
413				temp = MUSB_TEST_K;
414				break;
415			case 3:
416				pr_debug("TEST_SE0_NAK\n");
417				temp = MUSB_TEST_SE0_NAK;
418				break;
419			case 4:
420				pr_debug("TEST_PACKET\n");
421				temp = MUSB_TEST_PACKET;
422				musb_load_testpacket(musb);
423				break;
424			case 5:
425				pr_debug("TEST_FORCE_ENABLE\n");
426				temp = MUSB_TEST_FORCE_HOST
427					| MUSB_TEST_FORCE_HS;
428
429				musb_writeb(musb->mregs, MUSB_DEVCTL,
430						MUSB_DEVCTL_SESSION);
431				break;
432			case 6:
433				pr_debug("TEST_FIFO_ACCESS\n");
434				temp = MUSB_TEST_FIFO_ACCESS;
435				break;
436			default:
437				goto error;
438			}
439			musb_writeb(musb->mregs, MUSB_TESTMODE, temp);
440			break;
441		default:
442			goto error;
443		}
444		dev_dbg(musb->controller, "set feature %d\n", wValue);
445		musb->port1_status |= 1 << wValue;
446		break;
447
448	default:
449error:
450		/* "protocol stall" on error */
451		retval = -EPIPE;
452	}
453	spin_unlock_irqrestore(&musb->lock, flags);
454	return retval;
455}
456