[deliverable/linux.git] / drivers / usb / phy / phy-generic.c

/*
 * drivers/usb/otg/nop-usb-xceiv.c
 *
 * NOP USB transceiver for all USB transceiver which are either built-in
 * into USB IP or which are mostly autonomous.
 *
 * Copyright (C) 2009 Texas Instruments Inc
 * Author: Ajay Kumar Gupta <ajay.gupta@ti.com>
 *
 * 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.
 *
 * Current status:
 *	This provides a "nop" transceiver for PHYs which are
 *	autonomous such as isp1504, isp1707, etc.
 */

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/dma-mapping.h>
#include <linux/usb/otg.h>
#include <linux/usb/usb_phy_gen_xceiv.h>
#include <linux/slab.h>
#include <linux/clk.h>
#include <linux/regulator/consumer.h>
#include <linux/of.h>

#include "phy-generic.h"

static struct platform_device *pd;

void usb_nop_xceiv_register(void)
{
	if (pd)
		return;
	pd = platform_device_register_simple("usb_phy_gen_xceiv", -1, NULL, 0);
	if (!pd) {
		pr_err("Unable to register generic usb transceiver\n");
		return;
	}
}
EXPORT_SYMBOL(usb_nop_xceiv_register);

void usb_nop_xceiv_unregister(void)
{
	platform_device_unregister(pd);
	pd = NULL;
}
EXPORT_SYMBOL(usb_nop_xceiv_unregister);

static int nop_set_suspend(struct usb_phy *x, int suspend)
{
	return 0;
}

int usb_gen_phy_init(struct usb_phy *phy)
{
	struct usb_phy_gen_xceiv *nop = dev_get_drvdata(phy->dev);

	if (!IS_ERR(nop->vcc)) {
		if (regulator_enable(nop->vcc))
			dev_err(phy->dev, "Failed to enable power\n");
	}

	if (!IS_ERR(nop->clk))
		clk_enable(nop->clk);

	if (!IS_ERR(nop->reset)) {
		/* De-assert RESET */
		if (regulator_enable(nop->reset))
			dev_err(phy->dev, "Failed to de-assert reset\n");
	}

	return 0;
}
EXPORT_SYMBOL_GPL(usb_gen_phy_init);

void usb_gen_phy_shutdown(struct usb_phy *phy)
{
	struct usb_phy_gen_xceiv *nop = dev_get_drvdata(phy->dev);

	if (!IS_ERR(nop->reset)) {
		/* Assert RESET */
		if (regulator_disable(nop->reset))
			dev_err(phy->dev, "Failed to assert reset\n");
	}

	if (!IS_ERR(nop->clk))
		clk_disable(nop->clk);

	if (!IS_ERR(nop->vcc)) {
		if (regulator_disable(nop->vcc))
			dev_err(phy->dev, "Failed to disable power\n");
	}
}
EXPORT_SYMBOL_GPL(usb_gen_phy_shutdown);

static int nop_set_peripheral(struct usb_otg *otg, struct usb_gadget *gadget)
{
	if (!otg)
		return -ENODEV;

	if (!gadget) {
		otg->gadget = NULL;
		return -ENODEV;
	}

	otg->gadget = gadget;
	otg->phy->state = OTG_STATE_B_IDLE;
	return 0;
}

static int nop_set_host(struct usb_otg *otg, struct usb_bus *host)
{
	if (!otg)
		return -ENODEV;

	if (!host) {
		otg->host = NULL;
		return -ENODEV;
	}

	otg->host = host;
	return 0;
}

int usb_phy_gen_create_phy(struct device *dev, struct usb_phy_gen_xceiv *nop,
		enum usb_phy_type type, u32 clk_rate, bool needs_vcc,
		bool needs_reset)
{
	int err;

	nop->phy.otg = devm_kzalloc(dev, sizeof(*nop->phy.otg),
			GFP_KERNEL);
	if (!nop->phy.otg)
		return -ENOMEM;

	nop->clk = devm_clk_get(dev, "main_clk");
	if (IS_ERR(nop->clk)) {
		dev_dbg(dev, "Can't get phy clock: %ld\n",
					PTR_ERR(nop->clk));
	}

	if (!IS_ERR(nop->clk) && clk_rate) {
		err = clk_set_rate(nop->clk, clk_rate);
		if (err) {
			dev_err(dev, "Error setting clock rate\n");
			return err;
		}
	}

	if (!IS_ERR(nop->clk)) {
		err = clk_prepare(nop->clk);
		if (err) {
			dev_err(dev, "Error preparing clock\n");
			return err;
		}
	}

	nop->vcc = devm_regulator_get(dev, "vcc");
	if (IS_ERR(nop->vcc)) {
		dev_dbg(dev, "Error getting vcc regulator: %ld\n",
					PTR_ERR(nop->vcc));
		if (needs_vcc)
			return -EPROBE_DEFER;
	}

	nop->reset = devm_regulator_get(dev, "reset");
	if (IS_ERR(nop->reset)) {
		dev_dbg(dev, "Error getting reset regulator: %ld\n",
					PTR_ERR(nop->reset));
		if (needs_reset)
			return -EPROBE_DEFER;
	}

	nop->dev		= dev;
	nop->phy.dev		= nop->dev;
	nop->phy.label		= "nop-xceiv";
	nop->phy.set_suspend	= nop_set_suspend;
	nop->phy.state		= OTG_STATE_UNDEFINED;
	nop->phy.type		= type;

	nop->phy.otg->phy		= &nop->phy;
	nop->phy.otg->set_host		= nop_set_host;
	nop->phy.otg->set_peripheral	= nop_set_peripheral;

	ATOMIC_INIT_NOTIFIER_HEAD(&nop->phy.notifier);
	return 0;
}
EXPORT_SYMBOL_GPL(usb_phy_gen_create_phy);

void usb_phy_gen_cleanup_phy(struct usb_phy_gen_xceiv *nop)
{
	if (!IS_ERR(nop->clk))
		clk_unprepare(nop->clk);
}
EXPORT_SYMBOL_GPL(usb_phy_gen_cleanup_phy);

static int usb_phy_gen_xceiv_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct usb_phy_gen_xceiv_platform_data *pdata =
			dev_get_platdata(&pdev->dev);
	struct usb_phy_gen_xceiv	*nop;
	enum usb_phy_type	type = USB_PHY_TYPE_USB2;
	int err;
	u32 clk_rate = 0;
	bool needs_vcc = false;
	bool needs_reset = false;

	if (dev->of_node) {
		struct device_node *node = dev->of_node;

		if (of_property_read_u32(node, "clock-frequency", &clk_rate))
			clk_rate = 0;

		needs_vcc = of_property_read_bool(node, "vcc-supply");
		needs_reset = of_property_read_bool(node, "reset-supply");

	} else if (pdata) {
		type = pdata->type;
		clk_rate = pdata->clk_rate;
		needs_vcc = pdata->needs_vcc;
		needs_reset = pdata->needs_reset;
	}

	nop = devm_kzalloc(dev, sizeof(*nop), GFP_KERNEL);
	if (!nop)
		return -ENOMEM;


	err = usb_phy_gen_create_phy(dev, nop, type, clk_rate, needs_vcc,
			needs_reset);
	if (err)
		return err;

	nop->phy.init		= usb_gen_phy_init;
	nop->phy.shutdown	= usb_gen_phy_shutdown;

	err = usb_add_phy_dev(&nop->phy);
	if (err) {
		dev_err(&pdev->dev, "can't register transceiver, err: %d\n",
			err);
		goto err_add;
	}

	platform_set_drvdata(pdev, nop);

	return 0;

err_add:
	usb_phy_gen_cleanup_phy(nop);
	return err;
}

static int usb_phy_gen_xceiv_remove(struct platform_device *pdev)
{
	struct usb_phy_gen_xceiv *nop = platform_get_drvdata(pdev);

	usb_phy_gen_cleanup_phy(nop);
	usb_remove_phy(&nop->phy);

	return 0;
}

static const struct of_device_id nop_xceiv_dt_ids[] = {
	{ .compatible = "usb-nop-xceiv" },
	{ }
};

MODULE_DEVICE_TABLE(of, nop_xceiv_dt_ids);

static struct platform_driver usb_phy_gen_xceiv_driver = {
	.probe		= usb_phy_gen_xceiv_probe,
	.remove		= usb_phy_gen_xceiv_remove,
	.driver		= {
		.name	= "usb_phy_gen_xceiv",
		.owner	= THIS_MODULE,
		.of_match_table = nop_xceiv_dt_ids,
	},
};

static int __init usb_phy_gen_xceiv_init(void)
{
	return platform_driver_register(&usb_phy_gen_xceiv_driver);
}
subsys_initcall(usb_phy_gen_xceiv_init);

static void __exit usb_phy_gen_xceiv_exit(void)
{
	platform_driver_unregister(&usb_phy_gen_xceiv_driver);
}
module_exit(usb_phy_gen_xceiv_exit);

MODULE_ALIAS("platform:usb_phy_gen_xceiv");
MODULE_AUTHOR("Texas Instruments Inc");
MODULE_DESCRIPTION("NOP USB Transceiver driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
f6d92a05 AKG	1	/*
	2	* drivers/usb/otg/nop-usb-xceiv.c
	3	*
	4	* NOP USB transceiver for all USB transceiver which are either built-in
	5	* into USB IP or which are mostly autonomous.
	6	*
	7	* Copyright (C) 2009 Texas Instruments Inc
	8	* Author: Ajay Kumar Gupta <ajay.gupta@ti.com>
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	23	*
	24	* Current status:
cc835e32 DB	25	* This provides a "nop" transceiver for PHYs which are
cc835e32 DB	26	* autonomous such as isp1504, isp1707, etc.
f6d92a05 AKG	27	*/
	28
	29	#include <linux/module.h>
	30	#include <linux/platform_device.h>
	31	#include <linux/dma-mapping.h>
	32	#include <linux/usb/otg.h>
3fa4d734	33	#include <linux/usb/usb_phy_gen_xceiv.h>
5a0e3ad6	34	#include <linux/slab.h>
2319fb88	35	#include <linux/clk.h>
58f735fe	36	#include <linux/regulator/consumer.h>
0eba3879	37	#include <linux/of.h>
f6d92a05	38
53b6fc28	39	#include "phy-generic.h"
f6d92a05	40
cc835e32	41	static struct platform_device *pd;
f6d92a05 AKG	42
	43	void usb_nop_xceiv_register(void)
	44	{
cc835e32 DB	45	if (pd)
cc835e32 DB	46	return;
3fa4d734	47	pd = platform_device_register_simple("usb_phy_gen_xceiv", -1, NULL, 0);
cc835e32	48	if (!pd) {
3fa4d734	49	pr_err("Unable to register generic usb transceiver\n");
f6d92a05 AKG	50	return;
	51	}
	52	}
cc835e32	53	EXPORT_SYMBOL(usb_nop_xceiv_register);
f6d92a05 AKG	54
	55	void usb_nop_xceiv_unregister(void)
	56	{
cc835e32	57	platform_device_unregister(pd);
dc7520c1	58	pd = NULL;
f6d92a05	59	}
cc835e32	60	EXPORT_SYMBOL(usb_nop_xceiv_unregister);
f6d92a05	61
86753811	62	static int nop_set_suspend(struct usb_phy *x, int suspend)
f6d92a05 AKG	63	{
	64	return 0;
	65	}
	66
53b6fc28	67	int usb_gen_phy_init(struct usb_phy *phy)
2319fb88	68	{
3fa4d734	69	struct usb_phy_gen_xceiv *nop = dev_get_drvdata(phy->dev);
2319fb88	70
58f735fe RQ	71	if (!IS_ERR(nop->vcc)) {
	72	if (regulator_enable(nop->vcc))
	73	dev_err(phy->dev, "Failed to enable power\n");
	74	}
	75
2319fb88 RQ	76	if (!IS_ERR(nop->clk))
	77	clk_enable(nop->clk);
	78
ad63ebfc RQ	79	if (!IS_ERR(nop->reset)) {
	80	/* De-assert RESET */
	81	if (regulator_enable(nop->reset))
	82	dev_err(phy->dev, "Failed to de-assert reset\n");
	83	}
	84
2319fb88 RQ	85	return 0;
2319fb88 RQ	86	}
53b6fc28	87	EXPORT_SYMBOL_GPL(usb_gen_phy_init);
2319fb88	88
53b6fc28	89	void usb_gen_phy_shutdown(struct usb_phy *phy)
2319fb88	90	{
3fa4d734	91	struct usb_phy_gen_xceiv *nop = dev_get_drvdata(phy->dev);
2319fb88	92
ad63ebfc RQ	93	if (!IS_ERR(nop->reset)) {
	94	/* Assert RESET */
	95	if (regulator_disable(nop->reset))
	96	dev_err(phy->dev, "Failed to assert reset\n");
	97	}
	98
2319fb88 RQ	99	if (!IS_ERR(nop->clk))
2319fb88 RQ	100	clk_disable(nop->clk);
58f735fe RQ	101
	102	if (!IS_ERR(nop->vcc)) {
	103	if (regulator_disable(nop->vcc))
	104	dev_err(phy->dev, "Failed to disable power\n");
	105	}
2319fb88	106	}
53b6fc28	107	EXPORT_SYMBOL_GPL(usb_gen_phy_shutdown);
2319fb88	108
41adf109	109	static int nop_set_peripheral(struct usb_otg otg, struct usb_gadget gadget)
f6d92a05	110	{
41adf109	111	if (!otg)
f6d92a05 AKG	112	return -ENODEV;
f6d92a05 AKG	113
f6d92a05	114	if (!gadget) {
41adf109	115	otg->gadget = NULL;
f6d92a05 AKG	116	return -ENODEV;
	117	}
	118
41adf109 HK	119	otg->gadget = gadget;
41adf109 HK	120	otg->phy->state = OTG_STATE_B_IDLE;
f6d92a05 AKG	121	return 0;
	122	}
	123
41adf109	124	static int nop_set_host(struct usb_otg otg, struct usb_bus host)
f6d92a05	125	{
41adf109	126	if (!otg)
f6d92a05 AKG	127	return -ENODEV;
f6d92a05 AKG	128
f6d92a05	129	if (!host) {
41adf109	130	otg->host = NULL;
f6d92a05 AKG	131	return -ENODEV;
	132	}
	133
41adf109	134	otg->host = host;
f6d92a05 AKG	135	return 0;
	136	}
	137
53b6fc28 SAS	138	int usb_phy_gen_create_phy(struct device dev, struct usb_phy_gen_xceiv nop,
	139	enum usb_phy_type type, u32 clk_rate, bool needs_vcc,
	140	bool needs_reset)
f6d92a05	141	{
f6d92a05 AKG	142	int err;
f6d92a05 AKG	143
53b6fc28 SAS	144	nop->phy.otg = devm_kzalloc(dev, sizeof(*nop->phy.otg),
53b6fc28 SAS	145	GFP_KERNEL);
e4d7dc66	146	if (!nop->phy.otg)
41adf109	147	return -ENOMEM;
41adf109	148
53b6fc28	149	nop->clk = devm_clk_get(dev, "main_clk");
2319fb88	150	if (IS_ERR(nop->clk)) {
53b6fc28	151	dev_dbg(dev, "Can't get phy clock: %ld\n",
2319fb88 RQ	152	PTR_ERR(nop->clk));
	153	}
	154
0eba3879 RQ	155	if (!IS_ERR(nop->clk) && clk_rate) {
0eba3879 RQ	156	err = clk_set_rate(nop->clk, clk_rate);
2319fb88	157	if (err) {
53b6fc28	158	dev_err(dev, "Error setting clock rate\n");
2319fb88 RQ	159	return err;
	160	}
	161	}
	162
	163	if (!IS_ERR(nop->clk)) {
	164	err = clk_prepare(nop->clk);
	165	if (err) {
53b6fc28	166	dev_err(dev, "Error preparing clock\n");
2319fb88 RQ	167	return err;
	168	}
	169	}
	170
53b6fc28	171	nop->vcc = devm_regulator_get(dev, "vcc");
58f735fe	172	if (IS_ERR(nop->vcc)) {
53b6fc28	173	dev_dbg(dev, "Error getting vcc regulator: %ld\n",
58f735fe	174	PTR_ERR(nop->vcc));
b54b5f56 RQ	175	if (needs_vcc)
b54b5f56 RQ	176	return -EPROBE_DEFER;
58f735fe RQ	177	}
58f735fe RQ	178
53b6fc28	179	nop->reset = devm_regulator_get(dev, "reset");
ad63ebfc	180	if (IS_ERR(nop->reset)) {
53b6fc28	181	dev_dbg(dev, "Error getting reset regulator: %ld\n",
ad63ebfc	182	PTR_ERR(nop->reset));
b54b5f56 RQ	183	if (needs_reset)
b54b5f56 RQ	184	return -EPROBE_DEFER;
ad63ebfc RQ	185	}
ad63ebfc RQ	186
53b6fc28	187	nop->dev = dev;
41adf109 HK	188	nop->phy.dev = nop->dev;
	189	nop->phy.label = "nop-xceiv";
	190	nop->phy.set_suspend = nop_set_suspend;
	191	nop->phy.state = OTG_STATE_UNDEFINED;
90f4232f	192	nop->phy.type = type;
41adf109 HK	193
	194	nop->phy.otg->phy = &nop->phy;
	195	nop->phy.otg->set_host = nop_set_host;
	196	nop->phy.otg->set_peripheral = nop_set_peripheral;
	197
53b6fc28 SAS	198	ATOMIC_INIT_NOTIFIER_HEAD(&nop->phy.notifier);
	199	return 0;
	200	}
	201	EXPORT_SYMBOL_GPL(usb_phy_gen_create_phy);
	202
	203	void usb_phy_gen_cleanup_phy(struct usb_phy_gen_xceiv *nop)
	204	{
	205	if (!IS_ERR(nop->clk))
	206	clk_unprepare(nop->clk);
	207	}
	208	EXPORT_SYMBOL_GPL(usb_phy_gen_cleanup_phy);
	209
	210	static int usb_phy_gen_xceiv_probe(struct platform_device *pdev)
	211	{
	212	struct device *dev = &pdev->dev;
	213	struct usb_phy_gen_xceiv_platform_data *pdata =
	214	dev_get_platdata(&pdev->dev);
	215	struct usb_phy_gen_xceiv *nop;
	216	enum usb_phy_type type = USB_PHY_TYPE_USB2;
	217	int err;
	218	u32 clk_rate = 0;
	219	bool needs_vcc = false;
	220	bool needs_reset = false;
	221
	222	if (dev->of_node) {
	223	struct device_node *node = dev->of_node;
	224
	225	if (of_property_read_u32(node, "clock-frequency", &clk_rate))
	226	clk_rate = 0;
	227
	228	needs_vcc = of_property_read_bool(node, "vcc-supply");
	229	needs_reset = of_property_read_bool(node, "reset-supply");
	230
	231	} else if (pdata) {
	232	type = pdata->type;
	233	clk_rate = pdata->clk_rate;
	234	needs_vcc = pdata->needs_vcc;
	235	needs_reset = pdata->needs_reset;
	236	}
	237
	238	nop = devm_kzalloc(dev, sizeof(*nop), GFP_KERNEL);
	239	if (!nop)
	240	return -ENOMEM;
	241
	242
	243	err = usb_phy_gen_create_phy(dev, nop, type, clk_rate, needs_vcc,
	244	needs_reset);
	245	if (err)
	246	return err;
	247
	248	nop->phy.init = usb_gen_phy_init;
	249	nop->phy.shutdown = usb_gen_phy_shutdown;
	250
90f4232f	251	err = usb_add_phy_dev(&nop->phy);
f6d92a05 AKG	252	if (err) {
	253	dev_err(&pdev->dev, "can't register transceiver, err: %d\n",
	254	err);
2319fb88	255	goto err_add;
f6d92a05 AKG	256	}
	257
	258	platform_set_drvdata(pdev, nop);
	259
	260	return 0;
2319fb88 RQ	261
2319fb88 RQ	262	err_add:
53b6fc28	263	usb_phy_gen_cleanup_phy(nop);
2319fb88	264	return err;
f6d92a05 AKG	265	}
f6d92a05 AKG	266
3fa4d734	267	static int usb_phy_gen_xceiv_remove(struct platform_device *pdev)
f6d92a05	268	{
3fa4d734	269	struct usb_phy_gen_xceiv *nop = platform_get_drvdata(pdev);
f6d92a05	270
53b6fc28	271	usb_phy_gen_cleanup_phy(nop);
662dca54	272	usb_remove_phy(&nop->phy);
f6d92a05	273
f6d92a05 AKG	274	return 0;
	275	}
	276
0eba3879 RQ	277	static const struct of_device_id nop_xceiv_dt_ids[] = {
	278	{ .compatible = "usb-nop-xceiv" },
	279	{ }
	280	};
	281
	282	MODULE_DEVICE_TABLE(of, nop_xceiv_dt_ids);
	283
3fa4d734 SAS	284	static struct platform_driver usb_phy_gen_xceiv_driver = {
	285	.probe = usb_phy_gen_xceiv_probe,
	286	.remove = usb_phy_gen_xceiv_remove,
f6d92a05	287	.driver = {
3fa4d734	288	.name = "usb_phy_gen_xceiv",
f6d92a05	289	.owner = THIS_MODULE,
5462b0db	290	.of_match_table = nop_xceiv_dt_ids,
f6d92a05 AKG	291	},
	292	};
	293
3fa4d734	294	static int __init usb_phy_gen_xceiv_init(void)
f6d92a05	295	{
3fa4d734	296	return platform_driver_register(&usb_phy_gen_xceiv_driver);
f6d92a05	297	}
3fa4d734	298	subsys_initcall(usb_phy_gen_xceiv_init);
f6d92a05	299
3fa4d734	300	static void __exit usb_phy_gen_xceiv_exit(void)
f6d92a05	301	{
3fa4d734	302	platform_driver_unregister(&usb_phy_gen_xceiv_driver);
f6d92a05	303	}
3fa4d734	304	module_exit(usb_phy_gen_xceiv_exit);
f6d92a05	305
3fa4d734	306	MODULE_ALIAS("platform:usb_phy_gen_xceiv");
f6d92a05 AKG	307	MODULE_AUTHOR("Texas Instruments Inc");
	308	MODULE_DESCRIPTION("NOP USB Transceiver driver");
	309	MODULE_LICENSE("GPL");