[linux-block.git] / drivers / phy / phy-omap-usb2.c

/*
 * omap-usb2.c - USB PHY, talking to musb controller in OMAP.
 *
 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.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.
 *
 * Author: Kishon Vijay Abraham I <kishon@ti.com>
 *
 * 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.
 *
 */

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/of.h>
#include <linux/io.h>
#include <linux/usb/omap_usb.h>
#include <linux/usb/phy_companion.h>
#include <linux/clk.h>
#include <linux/err.h>
#include <linux/pm_runtime.h>
#include <linux/delay.h>
#include <linux/usb/omap_control_usb.h>
#include <linux/phy/phy.h>
#include <linux/of_platform.h>

/**
 * omap_usb2_set_comparator - links the comparator present in the sytem with
 *	this phy
 * @comparator - the companion phy(comparator) for this phy
 *
 * The phy companion driver should call this API passing the phy_companion
 * filled with set_vbus and start_srp to be used by usb phy.
 *
 * For use by phy companion driver
 */
int omap_usb2_set_comparator(struct phy_companion *comparator)
{
	struct omap_usb	*phy;
	struct usb_phy	*x = usb_get_phy(USB_PHY_TYPE_USB2);

	if (IS_ERR(x))
		return -ENODEV;

	phy = phy_to_omapusb(x);
	phy->comparator = comparator;
	return 0;
}
EXPORT_SYMBOL_GPL(omap_usb2_set_comparator);

static int omap_usb_set_vbus(struct usb_otg *otg, bool enabled)
{
	struct omap_usb *phy = phy_to_omapusb(otg->phy);

	if (!phy->comparator)
		return -ENODEV;

	return phy->comparator->set_vbus(phy->comparator, enabled);
}

static int omap_usb_start_srp(struct usb_otg *otg)
{
	struct omap_usb *phy = phy_to_omapusb(otg->phy);

	if (!phy->comparator)
		return -ENODEV;

	return phy->comparator->start_srp(phy->comparator);
}

static int omap_usb_set_host(struct usb_otg *otg, struct usb_bus *host)
{
	struct usb_phy	*phy = otg->phy;

	otg->host = host;
	if (!host)
		phy->state = OTG_STATE_UNDEFINED;

	return 0;
}

static int omap_usb_set_peripheral(struct usb_otg *otg,
		struct usb_gadget *gadget)
{
	struct usb_phy	*phy = otg->phy;

	otg->gadget = gadget;
	if (!gadget)
		phy->state = OTG_STATE_UNDEFINED;

	return 0;
}

static int omap_usb2_suspend(struct usb_phy *x, int suspend)
{
	struct omap_usb *phy = phy_to_omapusb(x);
	int ret;

	if (suspend && !phy->is_suspended) {
		omap_control_usb_phy_power(phy->control_dev, 0);
		pm_runtime_put_sync(phy->dev);
		phy->is_suspended = 1;
	} else if (!suspend && phy->is_suspended) {
		ret = pm_runtime_get_sync(phy->dev);
		if (ret < 0) {
			dev_err(phy->dev, "get_sync failed with err %d\n", ret);
			return ret;
		}
		omap_control_usb_phy_power(phy->control_dev, 1);
		phy->is_suspended = 0;
	}

	return 0;
}

static int omap_usb_power_off(struct phy *x)
{
	struct omap_usb *phy = phy_get_drvdata(x);

	omap_control_usb_phy_power(phy->control_dev, 0);

	return 0;
}

static int omap_usb_power_on(struct phy *x)
{
	struct omap_usb *phy = phy_get_drvdata(x);

	omap_control_usb_phy_power(phy->control_dev, 1);

	return 0;
}

static struct phy_ops ops = {
	.power_on	= omap_usb_power_on,
	.power_off	= omap_usb_power_off,
	.owner		= THIS_MODULE,
};

static int omap_usb2_probe(struct platform_device *pdev)
{
	struct omap_usb	*phy;
	struct phy *generic_phy;
	struct phy_provider *phy_provider;
	struct usb_otg *otg;
	struct device_node *node = pdev->dev.of_node;
	struct device_node *control_node;
	struct platform_device *control_pdev;

	if (!node)
		return -EINVAL;

	phy = devm_kzalloc(&pdev->dev, sizeof(*phy), GFP_KERNEL);
	if (!phy) {
		dev_err(&pdev->dev, "unable to allocate memory for USB2 PHY\n");
		return -ENOMEM;
	}

	otg = devm_kzalloc(&pdev->dev, sizeof(*otg), GFP_KERNEL);
	if (!otg) {
		dev_err(&pdev->dev, "unable to allocate memory for USB OTG\n");
		return -ENOMEM;
	}

	phy->dev		= &pdev->dev;

	phy->phy.dev		= phy->dev;
	phy->phy.label		= "omap-usb2";
	phy->phy.set_suspend	= omap_usb2_suspend;
	phy->phy.otg		= otg;
	phy->phy.type		= USB_PHY_TYPE_USB2;

	control_node = of_parse_phandle(node, "ctrl-module", 0);
	if (!control_node) {
		dev_err(&pdev->dev, "Failed to get control device phandle\n");
		return -EINVAL;
	}

	control_pdev = of_find_device_by_node(control_node);
	if (!control_pdev) {
		dev_err(&pdev->dev, "Failed to get control device\n");
		return -EINVAL;
	}

	phy->control_dev = &control_pdev->dev;

	phy->is_suspended	= 1;
	omap_control_usb_phy_power(phy->control_dev, 0);

	otg->set_host		= omap_usb_set_host;
	otg->set_peripheral	= omap_usb_set_peripheral;
	otg->set_vbus		= omap_usb_set_vbus;
	otg->start_srp		= omap_usb_start_srp;
	otg->phy		= &phy->phy;

	platform_set_drvdata(pdev, phy);
	pm_runtime_enable(phy->dev);

	generic_phy = devm_phy_create(phy->dev, &ops, NULL);
	if (IS_ERR(generic_phy))
		return PTR_ERR(generic_phy);

	phy_set_drvdata(generic_phy, phy);

	phy_provider = devm_of_phy_provider_register(phy->dev,
			of_phy_simple_xlate);
	if (IS_ERR(phy_provider))
		return PTR_ERR(phy_provider);

	phy->wkupclk = devm_clk_get(phy->dev, "usb_phy_cm_clk32k");
	if (IS_ERR(phy->wkupclk)) {
		dev_err(&pdev->dev, "unable to get usb_phy_cm_clk32k\n");
		return PTR_ERR(phy->wkupclk);
	}
	clk_prepare(phy->wkupclk);

	phy->optclk = devm_clk_get(phy->dev, "usb_otg_ss_refclk960m");
	if (IS_ERR(phy->optclk))
		dev_vdbg(&pdev->dev, "unable to get refclk960m\n");
	else
		clk_prepare(phy->optclk);

	usb_add_phy_dev(&phy->phy);

	return 0;
}

static int omap_usb2_remove(struct platform_device *pdev)
{
	struct omap_usb	*phy = platform_get_drvdata(pdev);

	clk_unprepare(phy->wkupclk);
	if (!IS_ERR(phy->optclk))
		clk_unprepare(phy->optclk);
	usb_remove_phy(&phy->phy);

	return 0;
}

#ifdef CONFIG_PM_RUNTIME

static int omap_usb2_runtime_suspend(struct device *dev)
{
	struct platform_device	*pdev = to_platform_device(dev);
	struct omap_usb	*phy = platform_get_drvdata(pdev);

	clk_disable(phy->wkupclk);
	if (!IS_ERR(phy->optclk))
		clk_disable(phy->optclk);

	return 0;
}

static int omap_usb2_runtime_resume(struct device *dev)
{
	struct platform_device	*pdev = to_platform_device(dev);
	struct omap_usb	*phy = platform_get_drvdata(pdev);
	int ret;

	ret = clk_enable(phy->wkupclk);
	if (ret < 0) {
		dev_err(phy->dev, "Failed to enable wkupclk %d\n", ret);
		goto err0;
	}

	if (!IS_ERR(phy->optclk)) {
		ret = clk_enable(phy->optclk);
		if (ret < 0) {
			dev_err(phy->dev, "Failed to enable optclk %d\n", ret);
			goto err1;
		}
	}

	return 0;

err1:
	clk_disable(phy->wkupclk);

err0:
	return ret;
}

static const struct dev_pm_ops omap_usb2_pm_ops = {
	SET_RUNTIME_PM_OPS(omap_usb2_runtime_suspend, omap_usb2_runtime_resume,
		NULL)
};

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

#ifdef CONFIG_OF
static const struct of_device_id omap_usb2_id_table[] = {
	{ .compatible = "ti,omap-usb2" },
	{}
};
MODULE_DEVICE_TABLE(of, omap_usb2_id_table);
#endif

static struct platform_driver omap_usb2_driver = {
	.probe		= omap_usb2_probe,
	.remove		= omap_usb2_remove,
	.driver		= {
		.name	= "omap-usb2",
		.owner	= THIS_MODULE,
		.pm	= DEV_PM_OPS,
		.of_match_table = of_match_ptr(omap_usb2_id_table),
	},
};

module_platform_driver(omap_usb2_driver);

MODULE_ALIAS("platform: omap_usb2");
MODULE_AUTHOR("Texas Instruments Inc.");
MODULE_DESCRIPTION("OMAP USB2 phy driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
657b306a KVA	1	/*
	2	* omap-usb2.c - USB PHY, talking to musb controller in OMAP.
	3	*
	4	* Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; either version 2 of the License, or
	8	* (at your option) any later version.
	9	*
	10	* Author: Kishon Vijay Abraham I <kishon@ti.com>
	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	*/
	18
	19	#include <linux/module.h>
	20	#include <linux/platform_device.h>
	21	#include <linux/slab.h>
	22	#include <linux/of.h>
	23	#include <linux/io.h>
	24	#include <linux/usb/omap_usb.h>
	25	#include <linux/usb/phy_companion.h>
	26	#include <linux/clk.h>
	27	#include <linux/err.h>
	28	#include <linux/pm_runtime.h>
	29	#include <linux/delay.h>
ca784be3	30	#include <linux/usb/omap_control_usb.h>
5d93d1e7	31	#include <linux/phy/phy.h>
478b6c74	32	#include <linux/of_platform.h>
657b306a KVA	33
	34	/**
	35	* omap_usb2_set_comparator - links the comparator present in the sytem with
	36	* this phy
	37	* @comparator - the companion phy(comparator) for this phy
	38	*
	39	* The phy companion driver should call this API passing the phy_companion
	40	* filled with set_vbus and start_srp to be used by usb phy.
	41	*
	42	* For use by phy companion driver
	43	*/
	44	int omap_usb2_set_comparator(struct phy_companion *comparator)
	45	{
	46	struct omap_usb *phy;
	47	struct usb_phy *x = usb_get_phy(USB_PHY_TYPE_USB2);
	48
	49	if (IS_ERR(x))
	50	return -ENODEV;
	51
	52	phy = phy_to_omapusb(x);
	53	phy->comparator = comparator;
	54	return 0;
	55	}
	56	EXPORT_SYMBOL_GPL(omap_usb2_set_comparator);
	57
657b306a KVA	58	static int omap_usb_set_vbus(struct usb_otg *otg, bool enabled)
	59	{
	60	struct omap_usb *phy = phy_to_omapusb(otg->phy);
	61
	62	if (!phy->comparator)
	63	return -ENODEV;
	64
	65	return phy->comparator->set_vbus(phy->comparator, enabled);
	66	}
	67
	68	static int omap_usb_start_srp(struct usb_otg *otg)
	69	{
	70	struct omap_usb *phy = phy_to_omapusb(otg->phy);
	71
	72	if (!phy->comparator)
	73	return -ENODEV;
	74
	75	return phy->comparator->start_srp(phy->comparator);
	76	}
	77
	78	static int omap_usb_set_host(struct usb_otg otg, struct usb_bus host)
	79	{
	80	struct usb_phy *phy = otg->phy;
	81
	82	otg->host = host;
	83	if (!host)
	84	phy->state = OTG_STATE_UNDEFINED;
	85
	86	return 0;
	87	}
	88
	89	static int omap_usb_set_peripheral(struct usb_otg *otg,
	90	struct usb_gadget *gadget)
	91	{
	92	struct usb_phy *phy = otg->phy;
	93
	94	otg->gadget = gadget;
	95	if (!gadget)
	96	phy->state = OTG_STATE_UNDEFINED;
	97
	98	return 0;
	99	}
	100
	101	static int omap_usb2_suspend(struct usb_phy *x, int suspend)
	102	{
657b306a	103	struct omap_usb *phy = phy_to_omapusb(x);
0f827684	104	int ret;
657b306a KVA	105
657b306a KVA	106	if (suspend && !phy->is_suspended) {
ca784be3	107	omap_control_usb_phy_power(phy->control_dev, 0);
657b306a KVA	108	pm_runtime_put_sync(phy->dev);
	109	phy->is_suspended = 1;
	110	} else if (!suspend && phy->is_suspended) {
	111	ret = pm_runtime_get_sync(phy->dev);
	112	if (ret < 0) {
0f827684	113	dev_err(phy->dev, "get_sync failed with err %d\n", ret);
657b306a KVA	114	return ret;
657b306a KVA	115	}
ca784be3	116	omap_control_usb_phy_power(phy->control_dev, 1);
657b306a KVA	117	phy->is_suspended = 0;
	118	}
	119
	120	return 0;
	121	}
	122
5d93d1e7 KVA	123	static int omap_usb_power_off(struct phy *x)
	124	{
	125	struct omap_usb *phy = phy_get_drvdata(x);
	126
	127	omap_control_usb_phy_power(phy->control_dev, 0);
	128
	129	return 0;
	130	}
	131
	132	static int omap_usb_power_on(struct phy *x)
	133	{
	134	struct omap_usb *phy = phy_get_drvdata(x);
	135
	136	omap_control_usb_phy_power(phy->control_dev, 1);
	137
	138	return 0;
	139	}
	140
	141	static struct phy_ops ops = {
	142	.power_on = omap_usb_power_on,
	143	.power_off = omap_usb_power_off,
	144	.owner = THIS_MODULE,
	145	};
	146
41ac7b3a	147	static int omap_usb2_probe(struct platform_device *pdev)
657b306a	148	{
478b6c74 RQ	149	struct omap_usb *phy;
	150	struct phy *generic_phy;
	151	struct phy_provider *phy_provider;
	152	struct usb_otg *otg;
	153	struct device_node *node = pdev->dev.of_node;
	154	struct device_node *control_node;
	155	struct platform_device *control_pdev;
	156
	157	if (!node)
	158	return -EINVAL;
657b306a KVA	159
	160	phy = devm_kzalloc(&pdev->dev, sizeof(*phy), GFP_KERNEL);
	161	if (!phy) {
	162	dev_err(&pdev->dev, "unable to allocate memory for USB2 PHY\n");
	163	return -ENOMEM;
	164	}
	165
	166	otg = devm_kzalloc(&pdev->dev, sizeof(*otg), GFP_KERNEL);
	167	if (!otg) {
	168	dev_err(&pdev->dev, "unable to allocate memory for USB OTG\n");
	169	return -ENOMEM;
	170	}
	171
	172	phy->dev = &pdev->dev;
	173
	174	phy->phy.dev = phy->dev;
	175	phy->phy.label = "omap-usb2";
	176	phy->phy.set_suspend = omap_usb2_suspend;
	177	phy->phy.otg = otg;
c11747f6	178	phy->phy.type = USB_PHY_TYPE_USB2;
657b306a	179
478b6c74 RQ	180	control_node = of_parse_phandle(node, "ctrl-module", 0);
	181	if (!control_node) {
	182	dev_err(&pdev->dev, "Failed to get control device phandle\n");
	183	return -EINVAL;
657b306a KVA	184	}
657b306a KVA	185
478b6c74 RQ	186	control_pdev = of_find_device_by_node(control_node);
	187	if (!control_pdev) {
	188	dev_err(&pdev->dev, "Failed to get control device\n");
	189	return -EINVAL;
	190	}
	191
	192	phy->control_dev = &control_pdev->dev;
	193
657b306a	194	phy->is_suspended = 1;
ca784be3	195	omap_control_usb_phy_power(phy->control_dev, 0);
657b306a KVA	196
	197	otg->set_host = omap_usb_set_host;
	198	otg->set_peripheral = omap_usb_set_peripheral;
	199	otg->set_vbus = omap_usb_set_vbus;
	200	otg->start_srp = omap_usb_start_srp;
	201	otg->phy = &phy->phy;
	202
5d93d1e7 KVA	203	platform_set_drvdata(pdev, phy);
	204	pm_runtime_enable(phy->dev);
	205
	206	generic_phy = devm_phy_create(phy->dev, &ops, NULL);
	207	if (IS_ERR(generic_phy))
	208	return PTR_ERR(generic_phy);
	209
	210	phy_set_drvdata(generic_phy, phy);
	211
64fe1891 KVA	212	phy_provider = devm_of_phy_provider_register(phy->dev,
	213	of_phy_simple_xlate);
	214	if (IS_ERR(phy_provider))
	215	return PTR_ERR(phy_provider);
	216
657b306a KVA	217	phy->wkupclk = devm_clk_get(phy->dev, "usb_phy_cm_clk32k");
	218	if (IS_ERR(phy->wkupclk)) {
	219	dev_err(&pdev->dev, "unable to get usb_phy_cm_clk32k\n");
	220	return PTR_ERR(phy->wkupclk);
	221	}
	222	clk_prepare(phy->wkupclk);
	223
0c4c8bbb KVA	224	phy->optclk = devm_clk_get(phy->dev, "usb_otg_ss_refclk960m");
	225	if (IS_ERR(phy->optclk))
	226	dev_vdbg(&pdev->dev, "unable to get refclk960m\n");
	227	else
	228	clk_prepare(phy->optclk);
	229
c11747f6	230	usb_add_phy_dev(&phy->phy);
657b306a	231
657b306a KVA	232	return 0;
	233	}
	234
fb4e98ab	235	static int omap_usb2_remove(struct platform_device *pdev)
657b306a KVA	236	{
	237	struct omap_usb *phy = platform_get_drvdata(pdev);
	238
	239	clk_unprepare(phy->wkupclk);
0c4c8bbb KVA	240	if (!IS_ERR(phy->optclk))
0c4c8bbb KVA	241	clk_unprepare(phy->optclk);
657b306a KVA	242	usb_remove_phy(&phy->phy);
	243
	244	return 0;
	245	}
	246
	247	#ifdef CONFIG_PM_RUNTIME
	248
	249	static int omap_usb2_runtime_suspend(struct device *dev)
	250	{
	251	struct platform_device *pdev = to_platform_device(dev);
	252	struct omap_usb *phy = platform_get_drvdata(pdev);
	253
	254	clk_disable(phy->wkupclk);
0c4c8bbb KVA	255	if (!IS_ERR(phy->optclk))
0c4c8bbb KVA	256	clk_disable(phy->optclk);
657b306a KVA	257
	258	return 0;
	259	}
	260
	261	static int omap_usb2_runtime_resume(struct device *dev)
	262	{
657b306a KVA	263	struct platform_device *pdev = to_platform_device(dev);
657b306a KVA	264	struct omap_usb *phy = platform_get_drvdata(pdev);
0f827684	265	int ret;
657b306a KVA	266
657b306a KVA	267	ret = clk_enable(phy->wkupclk);
0c4c8bbb	268	if (ret < 0) {
657b306a	269	dev_err(phy->dev, "Failed to enable wkupclk %d\n", ret);
0c4c8bbb KVA	270	goto err0;
	271	}
	272
	273	if (!IS_ERR(phy->optclk)) {
	274	ret = clk_enable(phy->optclk);
	275	if (ret < 0) {
	276	dev_err(phy->dev, "Failed to enable optclk %d\n", ret);
	277	goto err1;
	278	}
	279	}
	280
	281	return 0;
	282
	283	err1:
	284	clk_disable(phy->wkupclk);
657b306a	285
0c4c8bbb	286	err0:
657b306a KVA	287	return ret;
	288	}
	289
	290	static const struct dev_pm_ops omap_usb2_pm_ops = {
	291	SET_RUNTIME_PM_OPS(omap_usb2_runtime_suspend, omap_usb2_runtime_resume,
	292	NULL)
	293	};
	294
	295	#define DEV_PM_OPS (&omap_usb2_pm_ops)
	296	#else
	297	#define DEV_PM_OPS NULL
	298	#endif
	299
	300	#ifdef CONFIG_OF
	301	static const struct of_device_id omap_usb2_id_table[] = {
	302	{ .compatible = "ti,omap-usb2" },
	303	{}
	304	};
	305	MODULE_DEVICE_TABLE(of, omap_usb2_id_table);
	306	#endif
	307
	308	static struct platform_driver omap_usb2_driver = {
	309	.probe = omap_usb2_probe,
7690417d	310	.remove = omap_usb2_remove,
657b306a KVA	311	.driver = {
	312	.name = "omap-usb2",
	313	.owner = THIS_MODULE,
	314	.pm = DEV_PM_OPS,
	315	.of_match_table = of_match_ptr(omap_usb2_id_table),
	316	},
	317	};
	318
	319	module_platform_driver(omap_usb2_driver);
	320
	321	MODULE_ALIAS("platform: omap_usb2");
	322	MODULE_AUTHOR("Texas Instruments Inc.");
	323	MODULE_DESCRIPTION("OMAP USB2 phy driver");
	324	MODULE_LICENSE("GPL v2");