[deliverable/linux.git] / drivers / phy / phy-ti-pipe3.c

/*
 * phy-ti-pipe3 - PIPE3 PHY driver.
 *
 * Copyright (C) 2013 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/phy/phy.h>
#include <linux/of.h>
#include <linux/clk.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/pm_runtime.h>
#include <linux/delay.h>
#include <linux/phy/omap_control_phy.h>
#include <linux/of_platform.h>

#define	PLL_STATUS		0x00000004
#define	PLL_GO			0x00000008
#define	PLL_CONFIGURATION1	0x0000000C
#define	PLL_CONFIGURATION2	0x00000010
#define	PLL_CONFIGURATION3	0x00000014
#define	PLL_CONFIGURATION4	0x00000020

#define	PLL_REGM_MASK		0x001FFE00
#define	PLL_REGM_SHIFT		0x9
#define	PLL_REGM_F_MASK		0x0003FFFF
#define	PLL_REGM_F_SHIFT	0x0
#define	PLL_REGN_MASK		0x000001FE
#define	PLL_REGN_SHIFT		0x1
#define	PLL_SELFREQDCO_MASK	0x0000000E
#define	PLL_SELFREQDCO_SHIFT	0x1
#define	PLL_SD_MASK		0x0003FC00
#define	PLL_SD_SHIFT		10
#define	SET_PLL_GO		0x1
#define PLL_LDOPWDN		BIT(15)
#define PLL_TICOPWDN		BIT(16)
#define	PLL_LOCK		0x2
#define	PLL_IDLE		0x1

/*
 * This is an Empirical value that works, need to confirm the actual
 * value required for the PIPE3PHY_PLL_CONFIGURATION2.PLL_IDLE status
 * to be correctly reflected in the PIPE3PHY_PLL_STATUS register.
 */
#define PLL_IDLE_TIME	100	/* in milliseconds */
#define PLL_LOCK_TIME	100	/* in milliseconds */

struct pipe3_dpll_params {
	u16	m;
	u8	n;
	u8	freq:3;
	u8	sd;
	u32	mf;
};

struct pipe3_dpll_map {
	unsigned long rate;
	struct pipe3_dpll_params params;
};

struct ti_pipe3 {
	void __iomem		*pll_ctrl_base;
	struct device		*dev;
	struct device		*control_dev;
	struct clk		*wkupclk;
	struct clk		*sys_clk;
	struct clk		*refclk;
	struct clk		*div_clk;
	struct pipe3_dpll_map	*dpll_map;
	u8			id;
};

static struct pipe3_dpll_map dpll_map_usb[] = {
	{12000000, {1250, 5, 4, 20, 0} },	/* 12 MHz */
	{16800000, {3125, 20, 4, 20, 0} },	/* 16.8 MHz */
	{19200000, {1172, 8, 4, 20, 65537} },	/* 19.2 MHz */
	{20000000, {1000, 7, 4, 10, 0} },	/* 20 MHz */
	{26000000, {1250, 12, 4, 20, 0} },	/* 26 MHz */
	{38400000, {3125, 47, 4, 20, 92843} },	/* 38.4 MHz */
	{ },					/* Terminator */
};

static struct pipe3_dpll_map dpll_map_sata[] = {
	{12000000, {1000, 7, 4, 6, 0} },	/* 12 MHz */
	{16800000, {714, 7, 4, 6, 0} },		/* 16.8 MHz */
	{19200000, {625, 7, 4, 6, 0} },		/* 19.2 MHz */
	{20000000, {600, 7, 4, 6, 0} },		/* 20 MHz */
	{26000000, {461, 7, 4, 6, 0} },		/* 26 MHz */
	{38400000, {312, 7, 4, 6, 0} },		/* 38.4 MHz */
	{ },					/* Terminator */
};

static inline u32 ti_pipe3_readl(void __iomem *addr, unsigned offset)
{
	return __raw_readl(addr + offset);
}

static inline void ti_pipe3_writel(void __iomem *addr, unsigned offset,
	u32 data)
{
	__raw_writel(data, addr + offset);
}

static struct pipe3_dpll_params *ti_pipe3_get_dpll_params(struct ti_pipe3 *phy)
{
	unsigned long rate;
	struct pipe3_dpll_map *dpll_map = phy->dpll_map;

	rate = clk_get_rate(phy->sys_clk);

	for (; dpll_map->rate; dpll_map++) {
		if (rate == dpll_map->rate)
			return &dpll_map->params;
	}

	dev_err(phy->dev, "No DPLL configuration for %lu Hz SYS CLK\n", rate);

	return NULL;
}

static int ti_pipe3_power_off(struct phy *x)
{
	struct ti_pipe3 *phy = phy_get_drvdata(x);

	omap_control_phy_power(phy->control_dev, 0);

	return 0;
}

static int ti_pipe3_power_on(struct phy *x)
{
	struct ti_pipe3 *phy = phy_get_drvdata(x);

	omap_control_phy_power(phy->control_dev, 1);

	return 0;
}

static int ti_pipe3_dpll_wait_lock(struct ti_pipe3 *phy)
{
	u32		val;
	unsigned long	timeout;

	timeout = jiffies + msecs_to_jiffies(PLL_LOCK_TIME);
	do {
		cpu_relax();
		val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_STATUS);
		if (val & PLL_LOCK)
			break;
	} while (!time_after(jiffies, timeout));

	if (!(val & PLL_LOCK)) {
		dev_err(phy->dev, "DPLL failed to lock\n");
		return -EBUSY;
	}

	return 0;
}

static int ti_pipe3_dpll_program(struct ti_pipe3 *phy)
{
	u32			val;
	struct pipe3_dpll_params *dpll_params;

	dpll_params = ti_pipe3_get_dpll_params(phy);
	if (!dpll_params)
		return -EINVAL;

	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION1);
	val &= ~PLL_REGN_MASK;
	val |= dpll_params->n << PLL_REGN_SHIFT;
	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION1, val);

	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION2);
	val &= ~PLL_SELFREQDCO_MASK;
	val |= dpll_params->freq << PLL_SELFREQDCO_SHIFT;
	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION2, val);

	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION1);
	val &= ~PLL_REGM_MASK;
	val |= dpll_params->m << PLL_REGM_SHIFT;
	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION1, val);

	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION4);
	val &= ~PLL_REGM_F_MASK;
	val |= dpll_params->mf << PLL_REGM_F_SHIFT;
	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION4, val);

	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION3);
	val &= ~PLL_SD_MASK;
	val |= dpll_params->sd << PLL_SD_SHIFT;
	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION3, val);

	ti_pipe3_writel(phy->pll_ctrl_base, PLL_GO, SET_PLL_GO);

	return ti_pipe3_dpll_wait_lock(phy);
}

static int ti_pipe3_init(struct phy *x)
{
	struct ti_pipe3 *phy = phy_get_drvdata(x);
	u32 val;
	int ret = 0;

	if (of_device_is_compatible(phy->dev->of_node, "ti,phy-pipe3-pcie"))
		return 0;

	/* Bring it out of IDLE if it is IDLE */
	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION2);
	if (val & PLL_IDLE) {
		val &= ~PLL_IDLE;
		ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION2, val);
		ret = ti_pipe3_dpll_wait_lock(phy);
	}

	/* Program the DPLL only if not locked */
	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_STATUS);
	if (!(val & PLL_LOCK))
		if (ti_pipe3_dpll_program(phy))
			return -EINVAL;

	return ret;
}

static int ti_pipe3_exit(struct phy *x)
{
	struct ti_pipe3 *phy = phy_get_drvdata(x);
	u32 val;
	unsigned long timeout;

	/* SATA DPLL can't be powered down due to Errata i783 and PCIe
	 * does not have internal DPLL
	 */
	if (of_device_is_compatible(phy->dev->of_node, "ti,phy-pipe3-sata") ||
	    of_device_is_compatible(phy->dev->of_node, "ti,phy-pipe3-pcie"))
		return 0;

	/* Put DPLL in IDLE mode */
	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION2);
	val |= PLL_IDLE;
	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION2, val);

	/* wait for LDO and Oscillator to power down */
	timeout = jiffies + msecs_to_jiffies(PLL_IDLE_TIME);
	do {
		cpu_relax();
		val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_STATUS);
		if ((val & PLL_TICOPWDN) && (val & PLL_LDOPWDN))
			break;
	} while (!time_after(jiffies, timeout));

	if (!(val & PLL_TICOPWDN) || !(val & PLL_LDOPWDN)) {
		dev_err(phy->dev, "Failed to power down: PLL_STATUS 0x%x\n",
			val);
		return -EBUSY;
	}

	return 0;
}
static struct phy_ops ops = {
	.init		= ti_pipe3_init,
	.exit		= ti_pipe3_exit,
	.power_on	= ti_pipe3_power_on,
	.power_off	= ti_pipe3_power_off,
	.owner		= THIS_MODULE,
};

#ifdef CONFIG_OF
static const struct of_device_id ti_pipe3_id_table[];
#endif

static int ti_pipe3_probe(struct platform_device *pdev)
{
	struct ti_pipe3 *phy;
	struct phy *generic_phy;
	struct phy_provider *phy_provider;
	struct resource *res;
	struct device_node *node = pdev->dev.of_node;
	struct device_node *control_node;
	struct platform_device *control_pdev;
	const struct of_device_id *match;
	struct clk *clk;

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

	if (!of_device_is_compatible(node, "ti,phy-pipe3-pcie")) {
		match = of_match_device(of_match_ptr(ti_pipe3_id_table),
					&pdev->dev);
		if (!match)
			return -EINVAL;

		phy->dpll_map = (struct pipe3_dpll_map *)match->data;
		if (!phy->dpll_map) {
			dev_err(&pdev->dev, "no DPLL data\n");
			return -EINVAL;
		}

		res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
						   "pll_ctrl");
		phy->pll_ctrl_base = devm_ioremap_resource(&pdev->dev, res);
		if (IS_ERR(phy->pll_ctrl_base))
			return PTR_ERR(phy->pll_ctrl_base);

		phy->sys_clk = devm_clk_get(phy->dev, "sysclk");
		if (IS_ERR(phy->sys_clk)) {
			dev_err(&pdev->dev, "unable to get sysclk\n");
			return -EINVAL;
		}
	}

	if (!of_device_is_compatible(node, "ti,phy-pipe3-sata")) {
		phy->wkupclk = devm_clk_get(phy->dev, "wkupclk");
		if (IS_ERR(phy->wkupclk)) {
			dev_err(&pdev->dev, "unable to get wkupclk\n");
			return PTR_ERR(phy->wkupclk);
		}

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

	if (of_device_is_compatible(node, "ti,phy-pipe3-pcie")) {
		if (of_property_read_u8(node, "id", &phy->id) < 0)
			phy->id = 1;

		clk = devm_clk_get(phy->dev, "dpll_ref");
		if (IS_ERR(clk)) {
			dev_err(&pdev->dev, "unable to get dpll ref clk\n");
			return PTR_ERR(clk);
		}
		clk_set_rate(clk, 1500000000);

		clk = devm_clk_get(phy->dev, "dpll_ref_m2");
		if (IS_ERR(clk)) {
			dev_err(&pdev->dev, "unable to get dpll ref m2 clk\n");
			return PTR_ERR(clk);
		}
		clk_set_rate(clk, 100000000);

		clk = devm_clk_get(phy->dev, "phy-div");
		if (IS_ERR(clk)) {
			dev_err(&pdev->dev, "unable to get phy-div clk\n");
			return PTR_ERR(clk);
		}
		clk_set_rate(clk, 100000000);

		phy->div_clk = devm_clk_get(phy->dev, "div-clk");
		if (IS_ERR(phy->div_clk)) {
			dev_err(&pdev->dev, "unable to get div-clk\n");
			return PTR_ERR(phy->div_clk);
		}
	} else {
		phy->div_clk = ERR_PTR(-ENODEV);
	}

	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;

	omap_control_phy_power(phy->control_dev, 0);

	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);

	pm_runtime_get(&pdev->dev);

	return 0;
}

static int ti_pipe3_remove(struct platform_device *pdev)
{
	if (!pm_runtime_suspended(&pdev->dev))
		pm_runtime_put(&pdev->dev);
	pm_runtime_disable(&pdev->dev);

	return 0;
}

#ifdef CONFIG_PM_RUNTIME

static int ti_pipe3_runtime_suspend(struct device *dev)
{
	struct ti_pipe3	*phy = dev_get_drvdata(dev);

	if (!IS_ERR(phy->wkupclk))
		clk_disable_unprepare(phy->wkupclk);
	if (!IS_ERR(phy->refclk))
		clk_disable_unprepare(phy->refclk);
	if (!IS_ERR(phy->div_clk))
		clk_disable_unprepare(phy->div_clk);

	return 0;
}

static int ti_pipe3_runtime_resume(struct device *dev)
{
	u32 ret = 0;
	struct ti_pipe3	*phy = dev_get_drvdata(dev);

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

	if (!IS_ERR(phy->wkupclk)) {
		ret = clk_prepare_enable(phy->wkupclk);
		if (ret) {
			dev_err(phy->dev, "Failed to enable wkupclk %d\n", ret);
			goto err2;
		}
	}

	if (!IS_ERR(phy->div_clk)) {
		ret = clk_prepare_enable(phy->div_clk);
		if (ret) {
			dev_err(phy->dev, "Failed to enable div_clk %d\n", ret);
			goto err3;
		}
	}
	return 0;

err3:
	if (!IS_ERR(phy->wkupclk))
		clk_disable_unprepare(phy->wkupclk);

err2:
	if (!IS_ERR(phy->refclk))
		clk_disable_unprepare(phy->refclk);

err1:
	return ret;
}

static const struct dev_pm_ops ti_pipe3_pm_ops = {
	SET_RUNTIME_PM_OPS(ti_pipe3_runtime_suspend,
			   ti_pipe3_runtime_resume, NULL)
};

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

#ifdef CONFIG_OF
static const struct of_device_id ti_pipe3_id_table[] = {
	{
		.compatible = "ti,phy-usb3",
		.data = dpll_map_usb,
	},
	{
		.compatible = "ti,omap-usb3",
		.data = dpll_map_usb,
	},
	{
		.compatible = "ti,phy-pipe3-sata",
		.data = dpll_map_sata,
	},
	{
		.compatible = "ti,phy-pipe3-pcie",
	},
	{}
};
MODULE_DEVICE_TABLE(of, ti_pipe3_id_table);
#endif

static struct platform_driver ti_pipe3_driver = {
	.probe		= ti_pipe3_probe,
	.remove		= ti_pipe3_remove,
	.driver		= {
		.name	= "ti-pipe3",
		.owner	= THIS_MODULE,
		.pm	= DEV_PM_OPS,
		.of_match_table = of_match_ptr(ti_pipe3_id_table),
	},
};

module_platform_driver(ti_pipe3_driver);

MODULE_ALIAS("platform: ti_pipe3");
MODULE_AUTHOR("Texas Instruments Inc.");
MODULE_DESCRIPTION("TI PIPE3 phy driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
57f6ce07	1	/*
a70143bb	2	* phy-ti-pipe3 - PIPE3 PHY driver.
57f6ce07 KVA	3	*
	4	* Copyright (C) 2013 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>
a70143bb	22	#include <linux/phy/phy.h>
57f6ce07 KVA	23	#include <linux/of.h>
	24	#include <linux/clk.h>
	25	#include <linux/err.h>
a70143bb	26	#include <linux/io.h>
57f6ce07 KVA	27	#include <linux/pm_runtime.h>
57f6ce07 KVA	28	#include <linux/delay.h>
14da699b	29	#include <linux/phy/omap_control_phy.h>
918ee0d2	30	#include <linux/of_platform.h>
57f6ce07	31
57f6ce07 KVA	32	#define PLL_STATUS 0x00000004
	33	#define PLL_GO 0x00000008
	34	#define PLL_CONFIGURATION1 0x0000000C
	35	#define PLL_CONFIGURATION2 0x00000010
	36	#define PLL_CONFIGURATION3 0x00000014
	37	#define PLL_CONFIGURATION4 0x00000020
	38
	39	#define PLL_REGM_MASK 0x001FFE00
	40	#define PLL_REGM_SHIFT 0x9
	41	#define PLL_REGM_F_MASK 0x0003FFFF
	42	#define PLL_REGM_F_SHIFT 0x0
	43	#define PLL_REGN_MASK 0x000001FE
	44	#define PLL_REGN_SHIFT 0x1
	45	#define PLL_SELFREQDCO_MASK 0x0000000E
	46	#define PLL_SELFREQDCO_SHIFT 0x1
	47	#define PLL_SD_MASK 0x0003FC00
1562864f	48	#define PLL_SD_SHIFT 10
57f6ce07	49	#define SET_PLL_GO 0x1
629138db RQ	50	#define PLL_LDOPWDN BIT(15)
629138db RQ	51	#define PLL_TICOPWDN BIT(16)
57f6ce07 KVA	52	#define PLL_LOCK 0x2
	53	#define PLL_IDLE 0x1
	54
	55	/*
	56	* This is an Empirical value that works, need to confirm the actual
a70143bb KVA	57	* value required for the PIPE3PHY_PLL_CONFIGURATION2.PLL_IDLE status
a70143bb KVA	58	* to be correctly reflected in the PIPE3PHY_PLL_STATUS register.
57f6ce07	59	*/
629138db RQ	60	#define PLL_IDLE_TIME 100 /* in milliseconds */
629138db RQ	61	#define PLL_LOCK_TIME 100 /* in milliseconds */
57f6ce07	62
a70143bb KVA	63	struct pipe3_dpll_params {
	64	u16 m;
	65	u8 n;
	66	u8 freq:3;
	67	u8 sd;
	68	u32 mf;
	69	};
	70
61f54674 RQ	71	struct pipe3_dpll_map {
	72	unsigned long rate;
	73	struct pipe3_dpll_params params;
	74	};
	75
a70143bb KVA	76	struct ti_pipe3 {
	77	void __iomem *pll_ctrl_base;
	78	struct device *dev;
	79	struct device *control_dev;
	80	struct clk *wkupclk;
	81	struct clk *sys_clk;
1562864f	82	struct clk *refclk;
99bbd48c	83	struct clk *div_clk;
61f54674	84	struct pipe3_dpll_map *dpll_map;
99bbd48c	85	u8 id;
a70143bb KVA	86	};
a70143bb KVA	87
61f54674	88	static struct pipe3_dpll_map dpll_map_usb[] = {
519c6013 RQ	89	{12000000, {1250, 5, 4, 20, 0} }, /* 12 MHz */
	90	{16800000, {3125, 20, 4, 20, 0} }, /* 16.8 MHz */
	91	{19200000, {1172, 8, 4, 20, 65537} }, /* 19.2 MHz */
	92	{20000000, {1000, 7, 4, 10, 0} }, /* 20 MHz */
	93	{26000000, {1250, 12, 4, 20, 0} }, /* 26 MHz */
	94	{38400000, {3125, 47, 4, 20, 92843} }, /* 38.4 MHz */
61f54674 RQ	95	{ }, /* Terminator */
	96	};
	97
	98	static struct pipe3_dpll_map dpll_map_sata[] = {
	99	{12000000, {1000, 7, 4, 6, 0} }, /* 12 MHz */
	100	{16800000, {714, 7, 4, 6, 0} }, /* 16.8 MHz */
	101	{19200000, {625, 7, 4, 6, 0} }, /* 19.2 MHz */
	102	{20000000, {600, 7, 4, 6, 0} }, /* 20 MHz */
	103	{26000000, {461, 7, 4, 6, 0} }, /* 26 MHz */
	104	{38400000, {312, 7, 4, 6, 0} }, /* 38.4 MHz */
	105	{ }, /* Terminator */
57f6ce07 KVA	106	};
57f6ce07 KVA	107
a70143bb KVA	108	static inline u32 ti_pipe3_readl(void __iomem *addr, unsigned offset)
	109	{
	110	return __raw_readl(addr + offset);
	111	}
	112
	113	static inline void ti_pipe3_writel(void __iomem *addr, unsigned offset,
	114	u32 data)
	115	{
	116	__raw_writel(data, addr + offset);
	117	}
	118
61f54674	119	static struct pipe3_dpll_params ti_pipe3_get_dpll_params(struct ti_pipe3 phy)
519c6013	120	{
61f54674 RQ	121	unsigned long rate;
61f54674 RQ	122	struct pipe3_dpll_map *dpll_map = phy->dpll_map;
519c6013	123
61f54674 RQ	124	rate = clk_get_rate(phy->sys_clk);
	125
	126	for (; dpll_map->rate; dpll_map++) {
	127	if (rate == dpll_map->rate)
	128	return &dpll_map->params;
519c6013 RQ	129	}
519c6013 RQ	130
61f54674 RQ	131	dev_err(phy->dev, "No DPLL configuration for %lu Hz SYS CLK\n", rate);
61f54674 RQ	132
1b97be8c	133	return NULL;
519c6013 RQ	134	}
519c6013 RQ	135
a70143bb KVA	136	static int ti_pipe3_power_off(struct phy *x)
	137	{
	138	struct ti_pipe3 *phy = phy_get_drvdata(x);
a70143bb	139
14da699b	140	omap_control_phy_power(phy->control_dev, 0);
a70143bb KVA	141
	142	return 0;
	143	}
	144
	145	static int ti_pipe3_power_on(struct phy *x)
57f6ce07	146	{
a70143bb	147	struct ti_pipe3 *phy = phy_get_drvdata(x);
57f6ce07	148
629138db	149	omap_control_phy_power(phy->control_dev, 1);
57f6ce07 KVA	150
	151	return 0;
	152	}
	153
629138db	154	static int ti_pipe3_dpll_wait_lock(struct ti_pipe3 *phy)
57f6ce07 KVA	155	{
	156	u32 val;
	157	unsigned long timeout;
	158
629138db	159	timeout = jiffies + msecs_to_jiffies(PLL_LOCK_TIME);
57f6ce07	160	do {
629138db	161	cpu_relax();
a70143bb	162	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_STATUS);
57f6ce07 KVA	163	if (val & PLL_LOCK)
57f6ce07 KVA	164	break;
629138db RQ	165	} while (!time_after(jiffies, timeout));
	166
	167	if (!(val & PLL_LOCK)) {
	168	dev_err(phy->dev, "DPLL failed to lock\n");
	169	return -EBUSY;
	170	}
	171
	172	return 0;
57f6ce07 KVA	173	}
57f6ce07 KVA	174
629138db	175	static int ti_pipe3_dpll_program(struct ti_pipe3 *phy)
57f6ce07 KVA	176	{
57f6ce07 KVA	177	u32 val;
a70143bb	178	struct pipe3_dpll_params *dpll_params;
57f6ce07	179
61f54674 RQ	180	dpll_params = ti_pipe3_get_dpll_params(phy);
61f54674 RQ	181	if (!dpll_params)
57f6ce07	182	return -EINVAL;
57f6ce07	183
a70143bb	184	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION1);
57f6ce07	185	val &= ~PLL_REGN_MASK;
519c6013	186	val \|= dpll_params->n << PLL_REGN_SHIFT;
a70143bb	187	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION1, val);
57f6ce07	188
a70143bb	189	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION2);
57f6ce07	190	val &= ~PLL_SELFREQDCO_MASK;
519c6013	191	val \|= dpll_params->freq << PLL_SELFREQDCO_SHIFT;
a70143bb	192	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION2, val);
57f6ce07	193
a70143bb	194	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION1);
57f6ce07	195	val &= ~PLL_REGM_MASK;
519c6013	196	val \|= dpll_params->m << PLL_REGM_SHIFT;
a70143bb	197	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION1, val);
57f6ce07	198
a70143bb	199	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION4);
57f6ce07	200	val &= ~PLL_REGM_F_MASK;
519c6013	201	val \|= dpll_params->mf << PLL_REGM_F_SHIFT;
a70143bb	202	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION4, val);
57f6ce07	203
a70143bb	204	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION3);
57f6ce07	205	val &= ~PLL_SD_MASK;
519c6013	206	val \|= dpll_params->sd << PLL_SD_SHIFT;
a70143bb	207	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION3, val);
57f6ce07	208
629138db	209	ti_pipe3_writel(phy->pll_ctrl_base, PLL_GO, SET_PLL_GO);
57f6ce07	210
629138db	211	return ti_pipe3_dpll_wait_lock(phy);
57f6ce07 KVA	212	}
57f6ce07 KVA	213
a70143bb	214	static int ti_pipe3_init(struct phy *x)
57f6ce07	215	{
a70143bb	216	struct ti_pipe3 *phy = phy_get_drvdata(x);
629138db RQ	217	u32 val;
629138db RQ	218	int ret = 0;
519c6013	219
99bbd48c KVA	220	if (of_device_is_compatible(phy->dev->of_node, "ti,phy-pipe3-pcie"))
	221	return 0;
	222
629138db RQ	223	/* Bring it out of IDLE if it is IDLE */
	224	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION2);
	225	if (val & PLL_IDLE) {
	226	val &= ~PLL_IDLE;
	227	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION2, val);
	228	ret = ti_pipe3_dpll_wait_lock(phy);
	229	}
57f6ce07	230
629138db RQ	231	/* Program the DPLL only if not locked */
	232	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_STATUS);
	233	if (!(val & PLL_LOCK))
	234	if (ti_pipe3_dpll_program(phy))
	235	return -EINVAL;
57f6ce07	236
629138db	237	return ret;
57f6ce07 KVA	238	}
57f6ce07 KVA	239
629138db RQ	240	static int ti_pipe3_exit(struct phy *x)
	241	{
	242	struct ti_pipe3 *phy = phy_get_drvdata(x);
	243	u32 val;
	244	unsigned long timeout;
	245
99bbd48c KVA	246	/* SATA DPLL can't be powered down due to Errata i783 and PCIe
	247	* does not have internal DPLL
	248	*/
	249	if (of_device_is_compatible(phy->dev->of_node, "ti,phy-pipe3-sata") \|\|
	250	of_device_is_compatible(phy->dev->of_node, "ti,phy-pipe3-pcie"))
56042e4e RQ	251	return 0;
56042e4e RQ	252
629138db RQ	253	/* Put DPLL in IDLE mode */
	254	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_CONFIGURATION2);
	255	val \|= PLL_IDLE;
	256	ti_pipe3_writel(phy->pll_ctrl_base, PLL_CONFIGURATION2, val);
	257
	258	/* wait for LDO and Oscillator to power down */
	259	timeout = jiffies + msecs_to_jiffies(PLL_IDLE_TIME);
	260	do {
	261	cpu_relax();
	262	val = ti_pipe3_readl(phy->pll_ctrl_base, PLL_STATUS);
	263	if ((val & PLL_TICOPWDN) && (val & PLL_LDOPWDN))
	264	break;
	265	} while (!time_after(jiffies, timeout));
	266
	267	if (!(val & PLL_TICOPWDN) \|\| !(val & PLL_LDOPWDN)) {
	268	dev_err(phy->dev, "Failed to power down: PLL_STATUS 0x%x\n",
	269	val);
	270	return -EBUSY;
	271	}
	272
	273	return 0;
	274	}
a70143bb KVA	275	static struct phy_ops ops = {
a70143bb KVA	276	.init = ti_pipe3_init,
629138db	277	.exit = ti_pipe3_exit,
a70143bb KVA	278	.power_on = ti_pipe3_power_on,
	279	.power_off = ti_pipe3_power_off,
	280	.owner = THIS_MODULE,
	281	};
	282
61f54674 RQ	283	#ifdef CONFIG_OF
	284	static const struct of_device_id ti_pipe3_id_table[];
	285	#endif
	286
a70143bb	287	static int ti_pipe3_probe(struct platform_device *pdev)
57f6ce07	288	{
a70143bb KVA	289	struct ti_pipe3 *phy;
	290	struct phy *generic_phy;
	291	struct phy_provider *phy_provider;
918ee0d2 RQ	292	struct resource *res;
	293	struct device_node *node = pdev->dev.of_node;
	294	struct device_node *control_node;
	295	struct platform_device *control_pdev;
61f54674	296	const struct of_device_id *match;
99bbd48c	297	struct clk *clk;
57f6ce07 KVA	298
	299	phy = devm_kzalloc(&pdev->dev, sizeof(*phy), GFP_KERNEL);
	300	if (!phy) {
a70143bb	301	dev_err(&pdev->dev, "unable to alloc mem for TI PIPE3 PHY\n");
57f6ce07 KVA	302	return -ENOMEM;
57f6ce07 KVA	303	}
99bbd48c	304	phy->dev = &pdev->dev;
57f6ce07	305
99bbd48c KVA	306	if (!of_device_is_compatible(node, "ti,phy-pipe3-pcie")) {
	307	match = of_match_device(of_match_ptr(ti_pipe3_id_table),
	308	&pdev->dev);
	309	if (!match)
	310	return -EINVAL;
61f54674	311
99bbd48c KVA	312	phy->dpll_map = (struct pipe3_dpll_map *)match->data;
	313	if (!phy->dpll_map) {
	314	dev_err(&pdev->dev, "no DPLL data\n");
	315	return -EINVAL;
	316	}
57f6ce07	317
99bbd48c KVA	318	res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
	319	"pll_ctrl");
	320	phy->pll_ctrl_base = devm_ioremap_resource(&pdev->dev, res);
	321	if (IS_ERR(phy->pll_ctrl_base))
	322	return PTR_ERR(phy->pll_ctrl_base);
57f6ce07	323
99bbd48c KVA	324	phy->sys_clk = devm_clk_get(phy->dev, "sysclk");
	325	if (IS_ERR(phy->sys_clk)) {
	326	dev_err(&pdev->dev, "unable to get sysclk\n");
	327	return -EINVAL;
	328	}
	329	}
9c7f0443	330
99bbd48c	331	if (!of_device_is_compatible(node, "ti,phy-pipe3-sata")) {
9c7f0443 RQ	332	phy->wkupclk = devm_clk_get(phy->dev, "wkupclk");
	333	if (IS_ERR(phy->wkupclk)) {
	334	dev_err(&pdev->dev, "unable to get wkupclk\n");
	335	return PTR_ERR(phy->wkupclk);
	336	}
	337
	338	phy->refclk = devm_clk_get(phy->dev, "refclk");
	339	if (IS_ERR(phy->refclk)) {
	340	dev_err(&pdev->dev, "unable to get refclk\n");
	341	return PTR_ERR(phy->refclk);
	342	}
	343	} else {
	344	phy->wkupclk = ERR_PTR(-ENODEV);
	345	phy->refclk = ERR_PTR(-ENODEV);
57f6ce07	346	}
57f6ce07	347
99bbd48c KVA	348	if (of_device_is_compatible(node, "ti,phy-pipe3-pcie")) {
	349	if (of_property_read_u8(node, "id", &phy->id) < 0)
	350	phy->id = 1;
	351
	352	clk = devm_clk_get(phy->dev, "dpll_ref");
	353	if (IS_ERR(clk)) {
	354	dev_err(&pdev->dev, "unable to get dpll ref clk\n");
	355	return PTR_ERR(clk);
	356	}
	357	clk_set_rate(clk, 1500000000);
	358
	359	clk = devm_clk_get(phy->dev, "dpll_ref_m2");
	360	if (IS_ERR(clk)) {
	361	dev_err(&pdev->dev, "unable to get dpll ref m2 clk\n");
	362	return PTR_ERR(clk);
	363	}
	364	clk_set_rate(clk, 100000000);
	365
	366	clk = devm_clk_get(phy->dev, "phy-div");
	367	if (IS_ERR(clk)) {
	368	dev_err(&pdev->dev, "unable to get phy-div clk\n");
	369	return PTR_ERR(clk);
	370	}
	371	clk_set_rate(clk, 100000000);
	372
	373	phy->div_clk = devm_clk_get(phy->dev, "div-clk");
	374	if (IS_ERR(phy->div_clk)) {
	375	dev_err(&pdev->dev, "unable to get div-clk\n");
	376	return PTR_ERR(phy->div_clk);
	377	}
	378	} else {
	379	phy->div_clk = ERR_PTR(-ENODEV);
57f6ce07 KVA	380	}
57f6ce07 KVA	381
918ee0d2 RQ	382	control_node = of_parse_phandle(node, "ctrl-module", 0);
	383	if (!control_node) {
	384	dev_err(&pdev->dev, "Failed to get control device phandle\n");
	385	return -EINVAL;
57f6ce07	386	}
a70143bb	387
918ee0d2 RQ	388	control_pdev = of_find_device_by_node(control_node);
	389	if (!control_pdev) {
	390	dev_err(&pdev->dev, "Failed to get control device\n");
	391	return -EINVAL;
	392	}
	393
	394	phy->control_dev = &control_pdev->dev;
57f6ce07	395
14da699b	396	omap_control_phy_power(phy->control_dev, 0);
57f6ce07 KVA	397
57f6ce07 KVA	398	platform_set_drvdata(pdev, phy);
57f6ce07	399	pm_runtime_enable(phy->dev);
a70143bb KVA	400
	401	generic_phy = devm_phy_create(phy->dev, &ops, NULL);
	402	if (IS_ERR(generic_phy))
	403	return PTR_ERR(generic_phy);
	404
	405	phy_set_drvdata(generic_phy, phy);
	406	phy_provider = devm_of_phy_provider_register(phy->dev,
	407	of_phy_simple_xlate);
	408	if (IS_ERR(phy_provider))
	409	return PTR_ERR(phy_provider);
	410
57f6ce07 KVA	411	pm_runtime_get(&pdev->dev);
	412
	413	return 0;
	414	}
	415
a70143bb	416	static int ti_pipe3_remove(struct platform_device *pdev)
57f6ce07	417	{
57f6ce07 KVA	418	if (!pm_runtime_suspended(&pdev->dev))
	419	pm_runtime_put(&pdev->dev);
	420	pm_runtime_disable(&pdev->dev);
	421
	422	return 0;
	423	}
	424
	425	#ifdef CONFIG_PM_RUNTIME
	426
a70143bb	427	static int ti_pipe3_runtime_suspend(struct device *dev)
57f6ce07	428	{
a70143bb	429	struct ti_pipe3 *phy = dev_get_drvdata(dev);
57f6ce07	430
1562864f RQ	431	if (!IS_ERR(phy->wkupclk))
	432	clk_disable_unprepare(phy->wkupclk);
	433	if (!IS_ERR(phy->refclk))
	434	clk_disable_unprepare(phy->refclk);
99bbd48c KVA	435	if (!IS_ERR(phy->div_clk))
99bbd48c KVA	436	clk_disable_unprepare(phy->div_clk);
57f6ce07 KVA	437
	438	return 0;
	439	}
	440
a70143bb	441	static int ti_pipe3_runtime_resume(struct device *dev)
57f6ce07 KVA	442	{
57f6ce07 KVA	443	u32 ret = 0;
a70143bb	444	struct ti_pipe3 *phy = dev_get_drvdata(dev);
57f6ce07	445
1562864f RQ	446	if (!IS_ERR(phy->refclk)) {
	447	ret = clk_prepare_enable(phy->refclk);
	448	if (ret) {
	449	dev_err(phy->dev, "Failed to enable refclk %d\n", ret);
	450	goto err1;
	451	}
57f6ce07 KVA	452	}
57f6ce07 KVA	453
1562864f RQ	454	if (!IS_ERR(phy->wkupclk)) {
	455	ret = clk_prepare_enable(phy->wkupclk);
	456	if (ret) {
	457	dev_err(phy->dev, "Failed to enable wkupclk %d\n", ret);
	458	goto err2;
	459	}
57f6ce07 KVA	460	}
57f6ce07 KVA	461
99bbd48c KVA	462	if (!IS_ERR(phy->div_clk)) {
	463	ret = clk_prepare_enable(phy->div_clk);
	464	if (ret) {
	465	dev_err(phy->dev, "Failed to enable div_clk %d\n", ret);
	466	goto err3;
	467	}
	468	}
57f6ce07 KVA	469	return 0;
57f6ce07 KVA	470
99bbd48c KVA	471	err3:
	472	if (!IS_ERR(phy->wkupclk))
	473	clk_disable_unprepare(phy->wkupclk);
	474
57f6ce07	475	err2:
1562864f RQ	476	if (!IS_ERR(phy->refclk))
1562864f RQ	477	clk_disable_unprepare(phy->refclk);
57f6ce07 KVA	478
	479	err1:
	480	return ret;
	481	}
	482
a70143bb KVA	483	static const struct dev_pm_ops ti_pipe3_pm_ops = {
	484	SET_RUNTIME_PM_OPS(ti_pipe3_runtime_suspend,
	485	ti_pipe3_runtime_resume, NULL)
57f6ce07 KVA	486	};
57f6ce07 KVA	487
a70143bb	488	#define DEV_PM_OPS (&ti_pipe3_pm_ops)
57f6ce07 KVA	489	#else
	490	#define DEV_PM_OPS NULL
	491	#endif
	492
	493	#ifdef CONFIG_OF
a70143bb	494	static const struct of_device_id ti_pipe3_id_table[] = {
61f54674 RQ	495	{
	496	.compatible = "ti,phy-usb3",
	497	.data = dpll_map_usb,
	498	},
	499	{
	500	.compatible = "ti,omap-usb3",
	501	.data = dpll_map_usb,
	502	},
	503	{
	504	.compatible = "ti,phy-pipe3-sata",
	505	.data = dpll_map_sata,
	506	},
99bbd48c KVA	507	{
	508	.compatible = "ti,phy-pipe3-pcie",
	509	},
57f6ce07 KVA	510	{}
57f6ce07 KVA	511	};
a70143bb	512	MODULE_DEVICE_TABLE(of, ti_pipe3_id_table);
57f6ce07 KVA	513	#endif
57f6ce07 KVA	514
a70143bb KVA	515	static struct platform_driver ti_pipe3_driver = {
	516	.probe = ti_pipe3_probe,
	517	.remove = ti_pipe3_remove,
57f6ce07	518	.driver = {
a70143bb	519	.name = "ti-pipe3",
57f6ce07 KVA	520	.owner = THIS_MODULE,
57f6ce07 KVA	521	.pm = DEV_PM_OPS,
a70143bb	522	.of_match_table = of_match_ptr(ti_pipe3_id_table),
57f6ce07 KVA	523	},
	524	};
	525
a70143bb	526	module_platform_driver(ti_pipe3_driver);
57f6ce07	527
a70143bb	528	MODULE_ALIAS("platform: ti_pipe3");
57f6ce07	529	MODULE_AUTHOR("Texas Instruments Inc.");
a70143bb	530	MODULE_DESCRIPTION("TI PIPE3 phy driver");
57f6ce07	531	MODULE_LICENSE("GPL v2");