Subject: [PATCH 2/4] Phy: Add a PHY driver for Marvell MVEBU SATA PHY.

From: [email-masked] (Kishon Vijay Abraham I)
Date: Thu, 19 Dec 2013 16:10:38 +0530

Hi,

On Wednesday 18 December 2013 01:51 AM, Andrew Lunn wrote:
> Kirkwood and Dove can turn the SATA phy on and off. Add a PHY driver
> to control this.
> 
> Signed-off-by: Andrew Lunn <[email-masked]>
> ---
> v1->v2:
> Use #defines instead of magic values
> select GENERIC_PHY in Kconfig.
> ---
>  drivers/phy/Kconfig          |   6 ++
>  drivers/phy/Makefile         |   1 +
>  drivers/phy/phy-mvebu-sata.c | 137 +++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 144 insertions(+)
>  create mode 100644 drivers/phy/phy-mvebu-sata.c
> 
> diff --git a/drivers/phy/Kconfig b/drivers/phy/Kconfig
> index a344f3d52361..7464d31fcbd1 100644
> --- a/drivers/phy/Kconfig
> +++ b/drivers/phy/Kconfig
> @@ -21,6 +21,12 @@ config PHY_EXYNOS_MIPI_VIDEO
>  	  Support for MIPI CSI-2 and MIPI DSI DPHY found on Samsung S5P
>  	  and EXYNOS SoCs.
>  
> +config PHY_MVEBU_SATA
> +	def_bool y
> +	depends on ARCH_KIRKWOOD || ARCH_DOVE
> +	depends on OF
> +	select GENERIC_PHY
> +
>  config OMAP_USB2
>  	tristate "OMAP USB2 PHY Driver"
>  	depends on ARCH_OMAP2PLUS
> diff --git a/drivers/phy/Makefile b/drivers/phy/Makefile
> index d0caae9cfb83..4e4adc96f753 100644
> --- a/drivers/phy/Makefile
> +++ b/drivers/phy/Makefile
> @@ -5,5 +5,6 @@
>  obj-$(CONFIG_GENERIC_PHY)		+= phy-core.o
>  obj-$(CONFIG_PHY_EXYNOS_DP_VIDEO)	+= phy-exynos-dp-video.o
>  obj-$(CONFIG_PHY_EXYNOS_MIPI_VIDEO)	+= phy-exynos-mipi-video.o
> +obj-$(CONFIG_PHY_MVEBU_SATA)		+= phy-mvebu-sata.o
>  obj-$(CONFIG_OMAP_USB2)			+= phy-omap-usb2.o
>  obj-$(CONFIG_TWL4030_USB)		+= phy-twl4030-usb.o
> diff --git a/drivers/phy/phy-mvebu-sata.c b/drivers/phy/phy-mvebu-sata.c
> new file mode 100644
> index 000000000000..d43786f62437
> --- /dev/null
> +++ b/drivers/phy/phy-mvebu-sata.c
> @@ -0,0 +1,137 @@
> +/*
> + *	phy-mvebu-sata.c: SATA Phy driver for the Marvell mvebu SoCs.
> + *
> + *	Copyright (C) 2013 Andrew Lunn <[email-masked]>
> + *
> + *	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.
> + */
> +
> +#include <linux/kernel.h>
> +#include <linux/module.h>
> +#include <linux/clk.h>
> +#include <linux/phy/phy.h>
> +#include <linux/io.h>
> +#include <linux/platform_device.h>
> +
> +struct priv {
> +	struct clk	*clk;
> +	void __iomem	*base;
> +};
> +
> +#define SATA_PHY_MODE_2	0x0330
> +#define  MODE_2_FORCE_PU_TX	BIT(0)
> +#define  MODE_2_FORCE_PU_RX	BIT(1)
> +#define  MODE_2_PU_PLL		BIT(2)
> +#define  MODE_2_PU_IVREF	BIT(3)
> +#define SATA_IF_CTRL	0x0050
> +#define  CTRL_PHY_SHUTDOWN	BIT(9)
> +
> +static int phy_mvebu_sata_power_on(struct phy *phy)
> +{
> +	struct priv *priv = phy_get_drvdata(phy);
> +	u32 reg;
> +
> +	clk_prepare_enable(priv->clk);
> +
> +	/* Enable PLL and IVREF */
> +	reg = readl(priv->base + SATA_PHY_MODE_2);
> +	reg |= (MODE_2_FORCE_PU_TX | MODE_2_FORCE_PU_RX |
> +		MODE_2_PU_PLL | MODE_2_PU_IVREF);
> +	writel(reg , priv->base + SATA_PHY_MODE_2);
> +
> +	/* Enable PHY */
> +	reg = readl(priv->base + SATA_IF_CTRL);
> +	reg &= ~CTRL_PHY_SHUTDOWN;
> +	writel(reg, priv->base + SATA_IF_CTRL);
> +
> +	clk_disable_unprepare(priv->clk);
> +
> +	return 0;
> +}
> +
> +static int phy_mvebu_sata_power_off(struct phy *phy)
> +{
> +	struct priv *priv = phy_get_drvdata(phy);
> +	u32 reg;
> +
> +	clk_prepare_enable(priv->clk);
> +
> +	/* Disable PLL and IVREF */
> +	reg = readl(priv->base + SATA_PHY_MODE_2);
> +	reg &= ~(MODE_2_FORCE_PU_TX | MODE_2_FORCE_PU_RX |
> +		 MODE_2_PU_PLL | MODE_2_PU_IVREF);
> +	writel(reg, priv->base + SATA_PHY_MODE_2);
> +
> +	/* Disable PHY */
> +	reg = readl(priv->base + SATA_IF_CTRL);
> +	reg |= CTRL_PHY_SHUTDOWN;
> +	writel(reg, priv->base + SATA_IF_CTRL);
> +
> +	clk_disable_unprepare(priv->clk);
> +
> +	return 0;
> +}
> +
> +static struct phy_ops phy_mvebu_sata_ops = {
> +	.power_on	= phy_mvebu_sata_power_on,
> +	.power_off	= phy_mvebu_sata_power_off,
> +	.owner		= THIS_MODULE,
> +};
> +
> +static int phy_mvebu_sata_probe(struct platform_device *pdev)
> +{
> +	struct phy_provider *phy_provider;
> +	struct resource *res;
> +	struct priv *priv;
> +	struct phy *phy;
> +
> +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
> +
> +	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> +	priv->base = devm_ioremap_resource(&pdev->dev, res);
> +	if (IS_ERR(priv->base))
> +		return PTR_ERR(priv->base);
> +
> +	priv->clk = devm_clk_get(&pdev->dev, "sata");
> +	if (IS_ERR(priv->clk))
> +		return PTR_ERR(priv->clk);
> +
> +	phy_provider = devm_of_phy_provider_register(&pdev->dev,
> +						     of_phy_simple_xlate);
> +	if (IS_ERR(phy_provider))
> +		return PTR_ERR(phy_provider);
> +
> +	phy = devm_phy_create(&pdev->dev, &phy_mvebu_sata_ops, NULL);
> +	if (IS_ERR(phy))
> +		return PTR_ERR(phy);
> +
> +	phy_set_drvdata(phy, priv);

recently Felipe found a bug and phy_provider should be registered as the last
step. If you can fix that up, I can queue it.

Thanks
Kishon
> +
> +	/* The boot loader may of left it on. Turn it off. */
> +	phy_mvebu_sata_power_off(phy);
> +
> +	return 0;
> +}
> +
> +static const struct of_device_id phy_mvebu_sata_of_match[] = {
> +	{ .compatible = "marvell,mvebu-sata-phy" },
> +	{ },
> +};
> +MODULE_DEVICE_TABLE(of, phy_mvebu_sata_of_match);
> +
> +static struct platform_driver phy_mvebu_sata_driver = {
> +	.probe	= phy_mvebu_sata_probe,
> +	.driver = {
> +		.name	= "phy-mvebu-sata",
> +		.owner	= THIS_MODULE,
> +		.of_match_table	= phy_mvebu_sata_of_match,
> +	}
> +};
> +module_platform_driver(phy_mvebu_sata_driver);
> +
> +MODULE_AUTHOR("Andrew Lunn <[email-masked]>");
> +MODULE_DESCRIPTION("Marvell MVEBU SATA PHY driver");
> +MODULE_LICENSE("GPL v2");
>