[deliverable/linux.git] / drivers / usb / musb / ux500.c

/*
 * Copyright (C) 2010 ST-Ericsson AB
 * Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>
 *
 * Based on omap2430.c
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/clk.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/platform_device.h>
#include <linux/usb/musb-ux500.h>

#include "musb_core.h"

static struct musb_hdrc_config ux500_musb_hdrc_config = {
	.multipoint	= true,
	.dyn_fifo	= true,
	.num_eps	= 16,
	.ram_bits	= 16,
};

struct ux500_glue {
	struct device		*dev;
	struct platform_device	*musb;
	struct clk		*clk;
};
#define glue_to_musb(g)	platform_get_drvdata(g->musb)

static void ux500_musb_set_vbus(struct musb *musb, int is_on)
{
	u8            devctl;
	unsigned long timeout = jiffies + msecs_to_jiffies(1000);
	/* HDRC controls CPEN, but beware current surges during device
	 * connect.  They can trigger transient overcurrent conditions
	 * that must be ignored.
	 */

	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);

	if (is_on) {
		if (musb->xceiv->state == OTG_STATE_A_IDLE) {
			/* start the session */
			devctl |= MUSB_DEVCTL_SESSION;
			musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
			/*
			 * Wait for the musb to set as A device to enable the
			 * VBUS
			 */
			while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {

				if (time_after(jiffies, timeout)) {
					dev_err(musb->controller,
					"configured as A device timeout");
					break;
				}
			}

		} else {
			musb->is_active = 1;
			musb->xceiv->otg->default_a = 1;
			musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
			devctl |= MUSB_DEVCTL_SESSION;
			MUSB_HST_MODE(musb);
		}
	} else {
		musb->is_active = 0;

		/* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and jumping
		 * right to B_IDLE...
		 */
		musb->xceiv->otg->default_a = 0;
		devctl &= ~MUSB_DEVCTL_SESSION;
		MUSB_DEV_MODE(musb);
	}
	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);

	/*
	 * Devctl values will be updated after vbus goes below
	 * session_valid. The time taken depends on the capacitance
	 * on VBUS line. The max discharge time can be upto 1 sec
	 * as per the spec. Typically on our platform, it is 200ms
	 */
	if (!is_on)
		mdelay(200);

	dev_dbg(musb->controller, "VBUS %s, devctl %02x\n",
		usb_otg_state_string(musb->xceiv->state),
		musb_readb(musb->mregs, MUSB_DEVCTL));
}

static int musb_otg_notifications(struct notifier_block *nb,
		unsigned long event, void *unused)
{
	struct musb *musb = container_of(nb, struct musb, nb);

	dev_dbg(musb->controller, "musb_otg_notifications %ld %s\n",
			event, usb_otg_state_string(musb->xceiv->state));

	switch (event) {
	case UX500_MUSB_ID:
		dev_dbg(musb->controller, "ID GND\n");
		ux500_musb_set_vbus(musb, 1);
		break;
	case UX500_MUSB_VBUS:
		dev_dbg(musb->controller, "VBUS Connect\n");
		break;
	case UX500_MUSB_NONE:
		dev_dbg(musb->controller, "VBUS Disconnect\n");
		if (is_host_active(musb))
			ux500_musb_set_vbus(musb, 0);
		else
			musb->xceiv->state = OTG_STATE_B_IDLE;
		break;
	default:
		dev_dbg(musb->controller, "ID float\n");
		return NOTIFY_DONE;
	}
	return NOTIFY_OK;
}

static irqreturn_t ux500_musb_interrupt(int irq, void *__hci)
{
	unsigned long   flags;
	irqreturn_t     retval = IRQ_NONE;
	struct musb     *musb = __hci;

	spin_lock_irqsave(&musb->lock, flags);

	musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
	musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
	musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);

	if (musb->int_usb || musb->int_tx || musb->int_rx)
		retval = musb_interrupt(musb);

	spin_unlock_irqrestore(&musb->lock, flags);

	return retval;
}

static int ux500_musb_init(struct musb *musb)
{
	int status;

	musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
	if (IS_ERR_OR_NULL(musb->xceiv)) {
		pr_err("HS USB OTG: no transceiver configured\n");
		return -EPROBE_DEFER;
	}

	musb->nb.notifier_call = musb_otg_notifications;
	status = usb_register_notifier(musb->xceiv, &musb->nb);
	if (status < 0) {
		dev_dbg(musb->controller, "notification register failed\n");
		return status;
	}

	musb->isr = ux500_musb_interrupt;

	return 0;
}

static int ux500_musb_exit(struct musb *musb)
{
	usb_unregister_notifier(musb->xceiv, &musb->nb);

	usb_put_phy(musb->xceiv);

	return 0;
}

static const struct musb_platform_ops ux500_ops = {
	.init		= ux500_musb_init,
	.exit		= ux500_musb_exit,

	.set_vbus	= ux500_musb_set_vbus,
};

static int ux500_probe(struct platform_device *pdev)
{
	struct musb_hdrc_platform_data	*pdata = pdev->dev.platform_data;
	struct platform_device		*musb;
	struct ux500_glue		*glue;
	struct clk			*clk;
	int				ret = -ENOMEM;

	glue = kzalloc(sizeof(*glue), GFP_KERNEL);
	if (!glue) {
		dev_err(&pdev->dev, "failed to allocate glue context\n");
		goto err0;
	}

	musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
	if (!musb) {
		dev_err(&pdev->dev, "failed to allocate musb device\n");
		goto err1;
	}

	clk = clk_get(&pdev->dev, "usb");
	if (IS_ERR(clk)) {
		dev_err(&pdev->dev, "failed to get clock\n");
		ret = PTR_ERR(clk);
		goto err3;
	}

	ret = clk_prepare_enable(clk);
	if (ret) {
		dev_err(&pdev->dev, "failed to enable clock\n");
		goto err4;
	}

	musb->dev.parent		= &pdev->dev;
	musb->dev.dma_mask		= &pdev->dev.coherent_dma_mask;
	musb->dev.coherent_dma_mask	= pdev->dev.coherent_dma_mask;

	glue->dev			= &pdev->dev;
	glue->musb			= musb;
	glue->clk			= clk;

	pdata->platform_ops		= &ux500_ops;
	pdata->config 			= &ux500_musb_hdrc_config;

	platform_set_drvdata(pdev, glue);

	ret = platform_device_add_resources(musb, pdev->resource,
			pdev->num_resources);
	if (ret) {
		dev_err(&pdev->dev, "failed to add resources\n");
		goto err5;
	}

	ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
	if (ret) {
		dev_err(&pdev->dev, "failed to add platform_data\n");
		goto err5;
	}

	ret = platform_device_add(musb);
	if (ret) {
		dev_err(&pdev->dev, "failed to register musb device\n");
		goto err5;
	}

	return 0;

err5:
	clk_disable_unprepare(clk);

err4:
	clk_put(clk);

err3:
	platform_device_put(musb);

err1:
	kfree(glue);

err0:
	return ret;
}

static int ux500_remove(struct platform_device *pdev)
{
	struct ux500_glue	*glue = platform_get_drvdata(pdev);

	platform_device_unregister(glue->musb);
	clk_disable_unprepare(glue->clk);
	clk_put(glue->clk);
	kfree(glue);

	return 0;
}

#ifdef CONFIG_PM
static int ux500_suspend(struct device *dev)
{
	struct ux500_glue	*glue = dev_get_drvdata(dev);
	struct musb		*musb = glue_to_musb(glue);

	usb_phy_set_suspend(musb->xceiv, 1);
	clk_disable_unprepare(glue->clk);

	return 0;
}

static int ux500_resume(struct device *dev)
{
	struct ux500_glue	*glue = dev_get_drvdata(dev);
	struct musb		*musb = glue_to_musb(glue);
	int			ret;

	ret = clk_prepare_enable(glue->clk);
	if (ret) {
		dev_err(dev, "failed to enable clock\n");
		return ret;
	}

	usb_phy_set_suspend(musb->xceiv, 0);

	return 0;
}

static const struct dev_pm_ops ux500_pm_ops = {
	.suspend	= ux500_suspend,
	.resume		= ux500_resume,
};

#define DEV_PM_OPS	(&ux500_pm_ops)
#else
#define DEV_PM_OPS	NULL
#endif

static struct platform_driver ux500_driver = {
	.probe		= ux500_probe,
	.remove		= ux500_remove,
	.driver		= {
		.name	= "musb-ux500",
		.pm	= DEV_PM_OPS,
	},
};

MODULE_DESCRIPTION("UX500 MUSB Glue Layer");
MODULE_AUTHOR("Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>");
MODULE_LICENSE("GPL v2");
module_platform_driver(ux500_driver);
Commit	Line	Data
4bc36fd3 MYK	1	/*
	2	* Copyright (C) 2010 ST-Ericsson AB
	3	* Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>
	4	*
	5	* Based on omap2430.c
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU 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., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	*/
	21
	22	#include <linux/module.h>
	23	#include <linux/kernel.h>
	24	#include <linux/init.h>
	25	#include <linux/clk.h>
ded017ee	26	#include <linux/err.h>
4bc36fd3 MYK	27	#include <linux/io.h>
4bc36fd3 MYK	28	#include <linux/platform_device.h>
af6882be	29	#include <linux/usb/musb-ux500.h>
4bc36fd3 MYK	30
	31	#include "musb_core.h"
	32
a20b1b79 LJ	33	static struct musb_hdrc_config ux500_musb_hdrc_config = {
	34	.multipoint = true,
	35	.dyn_fifo = true,
	36	.num_eps = 16,
	37	.ram_bits = 16,
	38	};
	39
4bc36fd3 MYK	40	struct ux500_glue {
	41	struct device *dev;
	42	struct platform_device *musb;
	43	struct clk *clk;
	44	};
	45	#define glue_to_musb(g) platform_get_drvdata(g->musb)
	46
996a9d26 FB	47	static void ux500_musb_set_vbus(struct musb *musb, int is_on)
	48	{
	49	u8 devctl;
	50	unsigned long timeout = jiffies + msecs_to_jiffies(1000);
	51	/* HDRC controls CPEN, but beware current surges during device
	52	* connect. They can trigger transient overcurrent conditions
	53	* that must be ignored.
	54	*/
	55
	56	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
	57
	58	if (is_on) {
	59	if (musb->xceiv->state == OTG_STATE_A_IDLE) {
	60	/* start the session */
	61	devctl \|= MUSB_DEVCTL_SESSION;
	62	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
	63	/*
	64	* Wait for the musb to set as A device to enable the
	65	* VBUS
	66	*/
	67	while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
	68
	69	if (time_after(jiffies, timeout)) {
	70	dev_err(musb->controller,
	71	"configured as A device timeout");
	72	break;
	73	}
	74	}
	75
	76	} else {
	77	musb->is_active = 1;
	78	musb->xceiv->otg->default_a = 1;
	79	musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
	80	devctl \|= MUSB_DEVCTL_SESSION;
	81	MUSB_HST_MODE(musb);
	82	}
	83	} else {
	84	musb->is_active = 0;
	85
	86	/* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and jumping
	87	* right to B_IDLE...
	88	*/
	89	musb->xceiv->otg->default_a = 0;
	90	devctl &= ~MUSB_DEVCTL_SESSION;
	91	MUSB_DEV_MODE(musb);
	92	}
	93	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
	94
	95	/*
	96	* Devctl values will be updated after vbus goes below
	97	* session_valid. The time taken depends on the capacitance
	98	* on VBUS line. The max discharge time can be upto 1 sec
	99	* as per the spec. Typically on our platform, it is 200ms
	100	*/
	101	if (!is_on)
	102	mdelay(200);
	103
	104	dev_dbg(musb->controller, "VBUS %s, devctl %02x\n",
	105	usb_otg_state_string(musb->xceiv->state),
	106	musb_readb(musb->mregs, MUSB_DEVCTL));
	107	}
	108
0135522c FB	109	static int musb_otg_notifications(struct notifier_block *nb,
	110	unsigned long event, void *unused)
	111	{
	112	struct musb *musb = container_of(nb, struct musb, nb);
	113
	114	dev_dbg(musb->controller, "musb_otg_notifications %ld %s\n",
	115	event, usb_otg_state_string(musb->xceiv->state));
	116
	117	switch (event) {
af6882be	118	case UX500_MUSB_ID:
0135522c FB	119	dev_dbg(musb->controller, "ID GND\n");
	120	ux500_musb_set_vbus(musb, 1);
	121	break;
af6882be	122	case UX500_MUSB_VBUS:
0135522c	123	dev_dbg(musb->controller, "VBUS Connect\n");
0135522c	124	break;
af6882be	125	case UX500_MUSB_NONE:
0135522c FB	126	dev_dbg(musb->controller, "VBUS Disconnect\n");
	127	if (is_host_active(musb))
	128	ux500_musb_set_vbus(musb, 0);
	129	else
	130	musb->xceiv->state = OTG_STATE_B_IDLE;
	131	break;
	132	default:
	133	dev_dbg(musb->controller, "ID float\n");
	134	return NOTIFY_DONE;
	135	}
	136	return NOTIFY_OK;
	137	}
	138
baef653a PDS	139	static irqreturn_t ux500_musb_interrupt(int irq, void *__hci)
	140	{
	141	unsigned long flags;
	142	irqreturn_t retval = IRQ_NONE;
	143	struct musb *musb = __hci;
	144
	145	spin_lock_irqsave(&musb->lock, flags);
	146
	147	musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
	148	musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
	149	musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
	150
	151	if (musb->int_usb \|\| musb->int_tx \|\| musb->int_rx)
	152	retval = musb_interrupt(musb);
	153
	154	spin_unlock_irqrestore(&musb->lock, flags);
	155
	156	return retval;
	157	}
	158
4bc36fd3 MYK	159	static int ux500_musb_init(struct musb *musb)
4bc36fd3 MYK	160	{
0135522c FB	161	int status;
0135522c FB	162
662dca54	163	musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
ded017ee	164	if (IS_ERR_OR_NULL(musb->xceiv)) {
4bc36fd3	165	pr_err("HS USB OTG: no transceiver configured\n");
25736e0c	166	return -EPROBE_DEFER;
4bc36fd3 MYK	167	}
4bc36fd3 MYK	168
0135522c FB	169	musb->nb.notifier_call = musb_otg_notifications;
	170	status = usb_register_notifier(musb->xceiv, &musb->nb);
	171	if (status < 0) {
	172	dev_dbg(musb->controller, "notification register failed\n");
	173	return status;
	174	}
	175
baef653a PDS	176	musb->isr = ux500_musb_interrupt;
baef653a PDS	177
4bc36fd3 MYK	178	return 0;
	179	}
	180
	181	static int ux500_musb_exit(struct musb *musb)
	182	{
0135522c FB	183	usb_unregister_notifier(musb->xceiv, &musb->nb);
0135522c FB	184
721002ec	185	usb_put_phy(musb->xceiv);
4bc36fd3 MYK	186
	187	return 0;
	188	}
	189
	190	static const struct musb_platform_ops ux500_ops = {
	191	.init = ux500_musb_init,
	192	.exit = ux500_musb_exit,
996a9d26 FB	193
996a9d26 FB	194	.set_vbus = ux500_musb_set_vbus,
4bc36fd3 MYK	195	};
4bc36fd3 MYK	196
41ac7b3a	197	static int ux500_probe(struct platform_device *pdev)
4bc36fd3 MYK	198	{
	199	struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
	200	struct platform_device *musb;
	201	struct ux500_glue *glue;
	202	struct clk *clk;
4bc36fd3 MYK	203	int ret = -ENOMEM;
	204
	205	glue = kzalloc(sizeof(*glue), GFP_KERNEL);
	206	if (!glue) {
	207	dev_err(&pdev->dev, "failed to allocate glue context\n");
	208	goto err0;
	209	}
	210
2f771164	211	musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
4bc36fd3 MYK	212	if (!musb) {
4bc36fd3 MYK	213	dev_err(&pdev->dev, "failed to allocate musb device\n");
2f771164	214	goto err1;
4bc36fd3 MYK	215	}
	216
	217	clk = clk_get(&pdev->dev, "usb");
	218	if (IS_ERR(clk)) {
	219	dev_err(&pdev->dev, "failed to get clock\n");
	220	ret = PTR_ERR(clk);
65b3d52d	221	goto err3;
4bc36fd3 MYK	222	}
4bc36fd3 MYK	223
99d17cfa	224	ret = clk_prepare_enable(clk);
4bc36fd3 MYK	225	if (ret) {
4bc36fd3 MYK	226	dev_err(&pdev->dev, "failed to enable clock\n");
65b3d52d	227	goto err4;
4bc36fd3 MYK	228	}
	229
	230	musb->dev.parent = &pdev->dev;
1e6eebb4	231	musb->dev.dma_mask = &pdev->dev.coherent_dma_mask;
87266064	232	musb->dev.coherent_dma_mask = pdev->dev.coherent_dma_mask;
4bc36fd3 MYK	233
	234	glue->dev = &pdev->dev;
	235	glue->musb = musb;
	236	glue->clk = clk;
	237
	238	pdata->platform_ops = &ux500_ops;
a20b1b79	239	pdata->config = &ux500_musb_hdrc_config;
4bc36fd3 MYK	240
	241	platform_set_drvdata(pdev, glue);
	242
	243	ret = platform_device_add_resources(musb, pdev->resource,
	244	pdev->num_resources);
	245	if (ret) {
	246	dev_err(&pdev->dev, "failed to add resources\n");
65b3d52d	247	goto err5;
4bc36fd3 MYK	248	}
	249
	250	ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
	251	if (ret) {
	252	dev_err(&pdev->dev, "failed to add platform_data\n");
65b3d52d	253	goto err5;
4bc36fd3 MYK	254	}
	255
	256	ret = platform_device_add(musb);
	257	if (ret) {
	258	dev_err(&pdev->dev, "failed to register musb device\n");
65b3d52d	259	goto err5;
4bc36fd3 MYK	260	}
	261
	262	return 0;
	263
65b3d52d	264	err5:
99d17cfa	265	clk_disable_unprepare(clk);
4bc36fd3	266
65b3d52d	267	err4:
4bc36fd3 MYK	268	clk_put(clk);
4bc36fd3 MYK	269
65b3d52d	270	err3:
4bc36fd3 MYK	271	platform_device_put(musb);
	272
	273	err1:
	274	kfree(glue);
	275
	276	err0:
	277	return ret;
	278	}
	279
fb4e98ab	280	static int ux500_remove(struct platform_device *pdev)
4bc36fd3 MYK	281	{
	282	struct ux500_glue *glue = platform_get_drvdata(pdev);
	283
4b0de6f3	284	platform_device_unregister(glue->musb);
99d17cfa	285	clk_disable_unprepare(glue->clk);
4bc36fd3 MYK	286	clk_put(glue->clk);
	287	kfree(glue);
	288
	289	return 0;
	290	}
	291
	292	#ifdef CONFIG_PM
	293	static int ux500_suspend(struct device *dev)
	294	{
	295	struct ux500_glue *glue = dev_get_drvdata(dev);
	296	struct musb *musb = glue_to_musb(glue);
	297
b96d3b08	298	usb_phy_set_suspend(musb->xceiv, 1);
99d17cfa	299	clk_disable_unprepare(glue->clk);
4bc36fd3 MYK	300
	301	return 0;
	302	}
	303
	304	static int ux500_resume(struct device *dev)
	305	{
	306	struct ux500_glue *glue = dev_get_drvdata(dev);
	307	struct musb *musb = glue_to_musb(glue);
	308	int ret;
	309
99d17cfa	310	ret = clk_prepare_enable(glue->clk);
4bc36fd3 MYK	311	if (ret) {
	312	dev_err(dev, "failed to enable clock\n");
	313	return ret;
	314	}
	315
b96d3b08	316	usb_phy_set_suspend(musb->xceiv, 0);
4bc36fd3 MYK	317
	318	return 0;
	319	}
	320
	321	static const struct dev_pm_ops ux500_pm_ops = {
	322	.suspend = ux500_suspend,
	323	.resume = ux500_resume,
	324	};
	325
	326	#define DEV_PM_OPS (&ux500_pm_ops)
	327	#else
	328	#define DEV_PM_OPS NULL
	329	#endif
	330
	331	static struct platform_driver ux500_driver = {
e9e8c85e	332	.probe = ux500_probe,
7690417d	333	.remove = ux500_remove,
4bc36fd3 MYK	334	.driver = {
	335	.name = "musb-ux500",
	336	.pm = DEV_PM_OPS,
	337	},
	338	};
	339
	340	MODULE_DESCRIPTION("UX500 MUSB Glue Layer");
	341	MODULE_AUTHOR("Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>");
	342	MODULE_LICENSE("GPL v2");
0e7090a6	343	module_platform_driver(ux500_driver);