[v7,1/2] phy: Add new Exynos5 USB 3.0 PHY driver

Commit Message

Vivek Gautam April 28, 2014, 6:17 a.m. UTC

Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
The new driver uses the generic PHY framework and will interact
with DWC3 controller present on Exynos5 series of SoCs.
Thereby, removing old phy-samsung-usb3 driver and related code
used untill now which was based on usb/phy framework.

Signed-off-by: Vivek Gautam <[e-mail]>
---

Changes from v6:
 - Addressed review comments:
   -- Sorted config entries in Kconfig and Makefile
   -- Made #define to_usbdrd_phy(inst) to a static inline routine.
   -- Restructured exynos5_rate_to_clk() as suggested.
   -- Amended 'val' field for regmap_update_bits() in the routine
      exynos5_usbdrd_phy_isol().
   -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
   -- Removed check for 'match' entry in probe().

 .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
 drivers/phy/Kconfig                                |   11 +
 drivers/phy/Makefile                               |    1 +
 drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
 4 files changed, 679 insertions(+)
 create mode 100644 drivers/phy/phy-exynos5-usbdrd.c

Comments

Vivek Gautam April 30, 2014, 3:24 a.m. UTC | #1

Hi Kishon, Tomasz,


On Mon, Apr 28, 2014 at 11:47 AM, Vivek Gautam <[e-mail]> wrote:
> Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
> The new driver uses the generic PHY framework and will interact
> with DWC3 controller present on Exynos5 series of SoCs.
> Thereby, removing old phy-samsung-usb3 driver and related code
> used untill now which was based on usb/phy framework.
>
> Signed-off-by: Vivek Gautam <[e-mail]>
> ---

Does this patch looks Ok now ?
Actually we plan to get this in for 3.16, so if things are good we can
get a go ahead for this :-)

>
> Changes from v6:
>  - Addressed review comments:
>    -- Sorted config entries in Kconfig and Makefile
>    -- Made #define to_usbdrd_phy(inst) to a static inline routine.
>    -- Restructured exynos5_rate_to_clk() as suggested.
>    -- Amended 'val' field for regmap_update_bits() in the routine
>       exynos5_usbdrd_phy_isol().
>    -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
>    -- Removed check for 'match' entry in probe().
>
>  .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
>  drivers/phy/Kconfig                                |   11 +
>  drivers/phy/Makefile                               |    1 +
>  drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
>  4 files changed, 679 insertions(+)
>  create mode 100644 drivers/phy/phy-exynos5-usbdrd.c
>
> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
> index b422e38..51efe4c 100644
> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
> @@ -114,3 +114,43 @@ Example:
>                 compatible = "samsung,exynos-sataphy-i2c";
>                 reg = <0x38>;
>         };
> +
> +Samsung Exynos5 SoC series USB DRD PHY controller
> +--------------------------------------------------
> +
> +Required properties:
> +- compatible : Should be set to one of the following supported values:
> +       - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
> +       - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
> +- reg : Register offset and length of USB DRD PHY register set;
> +- clocks: Clock IDs array as required by the controller
> +- clock-names: names of clocks correseponding to IDs in the clock property;
> +              Required clocks:
> +       - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
> +              used for register access.
> +       - ref: PHY's reference clock (usually crystal clock), used for
> +              PHY operations, associated by phy name. It is used to
> +              determine bit values for clock settings register.
> +              For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
> +                     control pmu registers for power isolation.
> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
> +                     base.
> +- #phy-cells : from the generic PHY bindings, must be 1;
> +
> +For "samsung,exynos5250-usbdrd-phy" and "samsung,exynos5420-usbdrd-phy"
> +compatible PHYs, the second cell in the PHY specifier identifies the
> +PHY id, which is interpreted as follows:
> +  0 - UTMI+ type phy,
> +  1 - PIPE3 type phy,
> +
> +Example:
> +       usb3_phy: usbphy@12100000 {
> +               compatible = "samsung,exynos5250-usbdrd-phy";
> +               reg = <0x12100000 0x100>;
> +               clocks = <&clock 286>, <&clock 1>;
> +               clock-names = "phy", "ref";
> +               samsung,pmu-syscon = <&pmu_system_controller>;
> +               samsung,pmu-offset = <0x704>;
> +               #phy-cells = <1>;
> +       };
> diff --git a/drivers/phy/Kconfig b/drivers/phy/Kconfig
> index 3bb05f1..daa1707 100644
> --- a/drivers/phy/Kconfig
> +++ b/drivers/phy/Kconfig
> @@ -159,6 +159,17 @@ config PHY_EXYNOS5250_USB2
>           particular SoC is compiled in the driver. In case of Exynos 5250 four
>           phys are available - device, host, HSIC0 and HSIC.
>
> +config PHY_EXYNOS5_USBDRD
> +       tristate "Exynos5 SoC series USB DRD PHY driver"
> +       depends on ARCH_EXYNOS5 && OF
> +       depends on HAS_IOMEM
> +       select GENERIC_PHY
> +       select MFD_SYSCON
> +       help
> +         Enable USB DRD PHY support for Exynos 5 SoC series.
> +         This driver provides PHY interface for USB 3.0 DRD controller
> +         present on Exynos5 SoC series.
> +
>  config PHY_XGENE
>         tristate "APM X-Gene 15Gbps PHY support"
>         depends on HAS_IOMEM && OF && (ARM64 || COMPILE_TEST)
> diff --git a/drivers/phy/Makefile b/drivers/phy/Makefile
> index 2faf78e..333ba98 100644
> --- a/drivers/phy/Makefile
> +++ b/drivers/phy/Makefile
> @@ -17,4 +17,5 @@ obj-$(CONFIG_PHY_SAMSUNG_USB2)                += phy-samsung-usb2.o
>  obj-$(CONFIG_PHY_EXYNOS4210_USB2)      += phy-exynos4210-usb2.o
>  obj-$(CONFIG_PHY_EXYNOS4X12_USB2)      += phy-exynos4x12-usb2.o
>  obj-$(CONFIG_PHY_EXYNOS5250_USB2)      += phy-exynos5250-usb2.o
> +obj-$(CONFIG_PHY_EXYNOS5_USBDRD)       += phy-exynos5-usbdrd.o
>  obj-$(CONFIG_PHY_XGENE)                        += phy-xgene.o
> diff --git a/drivers/phy/phy-exynos5-usbdrd.c b/drivers/phy/phy-exynos5-usbdrd.c
> new file mode 100644
> index 0000000..bc381e3
> --- /dev/null
> +++ b/drivers/phy/phy-exynos5-usbdrd.c
> @@ -0,0 +1,627 @@
> +/*
> + * Samsung EXYNOS5 SoC series USB DRD PHY driver
> + *
> + * Phy provider for USB 3.0 DRD controller on Exynos5 SoC series
> + *
> + * Copyright (C) 2014 Samsung Electronics Co., Ltd.
> + * Author: Vivek Gautam <[e-mail]>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + */
> +
> +#include <linux/clk.h>
> +#include <linux/delay.h>
> +#include <linux/io.h>
> +#include <linux/kernel.h>
> +#include <linux/module.h>
> +#include <linux/of.h>
> +#include <linux/of_address.h>
> +#include <linux/phy/phy.h>
> +#include <linux/platform_device.h>
> +#include <linux/mutex.h>
> +#include <linux/mfd/syscon.h>
> +#include <linux/regmap.h>
> +
> +/* Exynos USB PHY registers */
> +#define EXYNOS5_FSEL_9MHZ6             0x0
> +#define EXYNOS5_FSEL_10MHZ             0x1
> +#define EXYNOS5_FSEL_12MHZ             0x2
> +#define EXYNOS5_FSEL_19MHZ2            0x3
> +#define EXYNOS5_FSEL_20MHZ             0x4
> +#define EXYNOS5_FSEL_24MHZ             0x5
> +#define EXYNOS5_FSEL_50MHZ             0x7
> +
> +/* EXYNOS5: USB 3.0 DRD PHY registers */
> +#define EXYNOS5_DRD_LINKSYSTEM                 0x04
> +
> +#define LINKSYSTEM_FLADJ_MASK                  (0x3f << 1)
> +#define LINKSYSTEM_FLADJ(_x)                   ((_x) << 1)
> +#define LINKSYSTEM_XHCI_VERSION_CONTROL                BIT(27)
> +
> +#define EXYNOS5_DRD_PHYUTMI                    0x08
> +
> +#define PHYUTMI_OTGDISABLE                     BIT(6)
> +#define PHYUTMI_FORCESUSPEND                   BIT(1)
> +#define PHYUTMI_FORCESLEEP                     BIT(0)
> +
> +#define EXYNOS5_DRD_PHYPIPE                    0x0c
> +
> +#define EXYNOS5_DRD_PHYCLKRST                  0x10
> +
> +#define PHYCLKRST_EN_UTMISUSPEND               BIT(31)
> +
> +#define PHYCLKRST_SSC_REFCLKSEL_MASK           (0xff << 23)
> +#define PHYCLKRST_SSC_REFCLKSEL(_x)            ((_x) << 23)
> +
> +#define PHYCLKRST_SSC_RANGE_MASK               (0x03 << 21)
> +#define PHYCLKRST_SSC_RANGE(_x)                        ((_x) << 21)
> +
> +#define PHYCLKRST_SSC_EN                       BIT(20)
> +#define PHYCLKRST_REF_SSP_EN                   BIT(19)
> +#define PHYCLKRST_REF_CLKDIV2                  BIT(18)
> +
> +#define PHYCLKRST_MPLL_MULTIPLIER_MASK         (0x7f << 11)
> +#define PHYCLKRST_MPLL_MULTIPLIER_100MHZ_REF   (0x19 << 11)
> +#define PHYCLKRST_MPLL_MULTIPLIER_50M_REF      (0x32 << 11)
> +#define PHYCLKRST_MPLL_MULTIPLIER_24MHZ_REF    (0x68 << 11)
> +#define PHYCLKRST_MPLL_MULTIPLIER_20MHZ_REF    (0x7d << 11)
> +#define PHYCLKRST_MPLL_MULTIPLIER_19200KHZ_REF (0x02 << 11)
> +
> +#define PHYCLKRST_FSEL_UTMI_MASK               (0x7 << 5)
> +#define PHYCLKRST_FSEL_PIPE_MASK               (0x7 << 8)
> +#define PHYCLKRST_FSEL(_x)                     ((_x) << 5)
> +#define PHYCLKRST_FSEL_PAD_100MHZ              (0x27 << 5)
> +#define PHYCLKRST_FSEL_PAD_24MHZ               (0x2a << 5)
> +#define PHYCLKRST_FSEL_PAD_20MHZ               (0x31 << 5)
> +#define PHYCLKRST_FSEL_PAD_19_2MHZ             (0x38 << 5)
> +
> +#define PHYCLKRST_RETENABLEN                   BIT(4)
> +
> +#define PHYCLKRST_REFCLKSEL_MASK               (0x03 << 2)
> +#define PHYCLKRST_REFCLKSEL_PAD_REFCLK         (0x2 << 2)
> +#define PHYCLKRST_REFCLKSEL_EXT_REFCLK         (0x3 << 2)
> +
> +#define PHYCLKRST_PORTRESET                    BIT(1)
> +#define PHYCLKRST_COMMONONN                    BIT(0)
> +
> +#define EXYNOS5_DRD_PHYREG0                    0x14
> +#define EXYNOS5_DRD_PHYREG1                    0x18
> +
> +#define EXYNOS5_DRD_PHYPARAM0                  0x1c
> +
> +#define PHYPARAM0_REF_USE_PAD                  BIT(31)
> +#define PHYPARAM0_REF_LOSLEVEL_MASK            (0x1f << 26)
> +#define PHYPARAM0_REF_LOSLEVEL                 (0x9 << 26)
> +
> +#define EXYNOS5_DRD_PHYPARAM1                  0x20
> +
> +#define PHYPARAM1_PCS_TXDEEMPH_MASK            (0x1f << 0)
> +#define PHYPARAM1_PCS_TXDEEMPH                 (0x1c)
> +
> +#define EXYNOS5_DRD_PHYTERM                    0x24
> +
> +#define EXYNOS5_DRD_PHYTEST                    0x28
> +
> +#define PHYTEST_POWERDOWN_SSP                  BIT(3)
> +#define PHYTEST_POWERDOWN_HSP                  BIT(2)
> +
> +#define EXYNOS5_DRD_PHYADP                     0x2c
> +
> +#define EXYNOS5_DRD_PHYUTMICLKSEL              0x30
> +
> +#define PHYUTMICLKSEL_UTMI_CLKSEL              BIT(2)
> +
> +#define EXYNOS5_DRD_PHYRESUME                  0x34
> +#define EXYNOS5_DRD_LINKPORT                   0x44
> +
> +/* Power isolation defined in power management unit */
> +#define EXYNOS5_USBDRD_PMU_ISOL                        BIT(0)
> +
> +#define KHZ    1000
> +#define MHZ    (KHZ * KHZ)
> +
> +enum exynos5_usbdrd_phy_id {
> +       EXYNOS5_DRDPHY_UTMI,
> +       EXYNOS5_DRDPHY_PIPE3,
> +       EXYNOS5_DRDPHYS_NUM,
> +};
> +
> +struct phy_usb_instance;
> +struct exynos5_usbdrd_phy;
> +
> +struct usbdrd_phy_config {
> +       u32 id;
> +       void (*phy_isol)(struct phy_usb_instance *inst, u32 on);
> +       void (*phy_init)(struct exynos5_usbdrd_phy *phy_drd);
> +       unsigned int (*set_refclk)(struct phy_usb_instance *inst);
> +};
> +
> +struct exynos5_usbdrd_phy_drvdata {
> +       const struct usbdrd_phy_config *phy_cfg;
> +};
> +
> +/**
> + * struct exynos5_usbdrd_phy - driver data for USB 3.0 PHY
> + * @dev: pointer to device instance of this platform device
> + * @reg_phy: usb phy controller register memory base
> + * @clk: phy clock for register access
> + * @drv_data: pointer to SoC level driver data structure
> + * @phys[]: array for 'EXYNOS5_DRDPHYS_NUM' number of PHY
> + *         instances each with its 'phy' and 'phy_cfg'.
> + * @extrefclk: frequency select settings when using 'separate
> + *            reference clocks' for SS and HS operations
> + * @ref_clk: reference clock to PHY block from which PHY's
> + *          operational clocks are derived
> + * @ref_rate: rate of above reference clock
> + */
> +struct exynos5_usbdrd_phy {
> +       struct device *dev;
> +       void __iomem *reg_phy;
> +       struct clk *clk;
> +       const struct exynos5_usbdrd_phy_drvdata *drv_data;
> +       struct phy_usb_instance {
> +               struct phy *phy;
> +               u32 index;
> +               struct regmap *reg_pmu;
> +               u32 pmu_offset;
> +               const struct usbdrd_phy_config *phy_cfg;
> +       } phys[EXYNOS5_DRDPHYS_NUM];
> +       u32 extrefclk;
> +       struct clk *ref_clk;
> +};
> +
> +static inline
> +struct exynos5_usbdrd_phy *to_usbdrd_phy(struct phy_usb_instance *inst)
> +{
> +       return container_of((inst), struct exynos5_usbdrd_phy,
> +                           phys[(inst)->index]);
> +}
> +
> +/*
> + * exynos5_rate_to_clk() converts the supplied clock rate to the value that
> + * can be written to the phy register.
> + */
> +static unsigned int exynos5_rate_to_clk(unsigned long rate, u32 *reg)
> +{
> +       /* EXYNOS5_FSEL_MASK */
> +
> +       switch (rate) {
> +       case 9600 * KHZ:
> +               *reg = EXYNOS5_FSEL_9MHZ6;
> +               break;
> +       case 10 * MHZ:
> +               *reg = EXYNOS5_FSEL_10MHZ;
> +               break;
> +       case 12 * MHZ:
> +               *reg = EXYNOS5_FSEL_12MHZ;
> +               break;
> +       case 19200 * KHZ:
> +               *reg = EXYNOS5_FSEL_19MHZ2;
> +               break;
> +       case 20 * MHZ:
> +               *reg = EXYNOS5_FSEL_20MHZ;
> +               break;
> +       case 24 * MHZ:
> +               *reg = EXYNOS5_FSEL_24MHZ;
> +               break;
> +       case 50 * MHZ:
> +               *reg = EXYNOS5_FSEL_50MHZ;
> +               break;
> +       default:
> +               return -EINVAL;
> +       }
> +
> +       return 0;
> +}
> +
> +static void exynos5_usbdrd_phy_isol(struct phy_usb_instance *inst,
> +                                               unsigned int on)
> +{
> +       unsigned int val;
> +
> +       if (!inst->reg_pmu)
> +               return;
> +
> +       val = on ? 0 : EXYNOS5_USBDRD_PMU_ISOL;
> +
> +       regmap_update_bits(inst->reg_pmu, inst->pmu_offset,
> +                          EXYNOS5_USBDRD_PMU_ISOL, val);
> +}
> +
> +/*
> + * Sets the pipe3 phy's clk as EXTREFCLK (XXTI) which is internal clock
> + * from clock core. Further sets multiplier values and spread spectrum
> + * clock settings for SuperSpeed operations.
> + */
> +static unsigned int
> +exynos5_usbdrd_pipe3_set_refclk(struct phy_usb_instance *inst)
> +{
> +       static u32 reg;
> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
> +
> +       /* restore any previous reference clock settings */
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
> +
> +       /* Use EXTREFCLK as ref clock */
> +       reg &= ~PHYCLKRST_REFCLKSEL_MASK;
> +       reg |=  PHYCLKRST_REFCLKSEL_EXT_REFCLK;
> +
> +       /* FSEL settings corresponding to reference clock */
> +       reg &= ~PHYCLKRST_FSEL_PIPE_MASK |
> +               PHYCLKRST_MPLL_MULTIPLIER_MASK |
> +               PHYCLKRST_SSC_REFCLKSEL_MASK;
> +       switch (phy_drd->extrefclk) {
> +       case EXYNOS5_FSEL_50MHZ:
> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_50M_REF |
> +                       PHYCLKRST_SSC_REFCLKSEL(0x00));
> +               break;
> +       case EXYNOS5_FSEL_24MHZ:
> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_24MHZ_REF |
> +                       PHYCLKRST_SSC_REFCLKSEL(0x88));
> +               break;
> +       case EXYNOS5_FSEL_20MHZ:
> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_20MHZ_REF |
> +                       PHYCLKRST_SSC_REFCLKSEL(0x00));
> +               break;
> +       case EXYNOS5_FSEL_19MHZ2:
> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_19200KHZ_REF |
> +                       PHYCLKRST_SSC_REFCLKSEL(0x88));
> +               break;
> +       default:
> +               dev_dbg(phy_drd->dev, "unsupported ref clk\n");
> +               break;
> +       }
> +
> +       return reg;
> +}
> +
> +/*
> + * Sets the utmi phy's clk as EXTREFCLK (XXTI) which is internal clock
> + * from clock core. Further sets the FSEL values for HighSpeed operations.
> + */
> +static unsigned int
> +exynos5_usbdrd_utmi_set_refclk(struct phy_usb_instance *inst)
> +{
> +       static u32 reg;
> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
> +
> +       /* restore any previous reference clock settings */
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
> +
> +       reg &= ~PHYCLKRST_REFCLKSEL_MASK;
> +       reg |=  PHYCLKRST_REFCLKSEL_EXT_REFCLK;
> +
> +       reg &= ~PHYCLKRST_FSEL_UTMI_MASK |
> +               PHYCLKRST_MPLL_MULTIPLIER_MASK |
> +               PHYCLKRST_SSC_REFCLKSEL_MASK;
> +       reg |= PHYCLKRST_FSEL(phy_drd->extrefclk);
> +
> +       return reg;
> +}
> +
> +static void exynos5_usbdrd_pipe3_init(struct exynos5_usbdrd_phy *phy_drd)
> +{
> +       u32 reg;
> +
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
> +       /* Set Tx De-Emphasis level */
> +       reg &= ~PHYPARAM1_PCS_TXDEEMPH_MASK;
> +       reg |=  PHYPARAM1_PCS_TXDEEMPH;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
> +
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
> +       reg &= ~PHYTEST_POWERDOWN_SSP;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
> +}
> +
> +static void exynos5_usbdrd_utmi_init(struct exynos5_usbdrd_phy *phy_drd)
> +{
> +       u32 reg;
> +
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
> +       /* Set Loss-of-Signal Detector sensitivity */
> +       reg &= ~PHYPARAM0_REF_LOSLEVEL_MASK;
> +       reg |=  PHYPARAM0_REF_LOSLEVEL;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
> +
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
> +       /* Set Tx De-Emphasis level */
> +       reg &= ~PHYPARAM1_PCS_TXDEEMPH_MASK;
> +       reg |=  PHYPARAM1_PCS_TXDEEMPH;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
> +
> +       /* UTMI Power Control */
> +       writel(PHYUTMI_OTGDISABLE, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMI);
> +
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
> +       reg &= ~PHYTEST_POWERDOWN_HSP;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
> +}
> +
> +static int exynos5_usbdrd_phy_init(struct phy *phy)
> +{
> +       int ret;
> +       u32 reg;
> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
> +
> +       ret = clk_prepare_enable(phy_drd->clk);
> +       if (ret)
> +               return ret;
> +
> +       /* Reset USB 3.0 PHY */
> +       writel(0x0, phy_drd->reg_phy + EXYNOS5_DRD_PHYREG0);
> +       writel(0x0, phy_drd->reg_phy + EXYNOS5_DRD_PHYRESUME);
> +
> +       /*
> +        * Setting the Frame length Adj value[6:1] to default 0x20
> +        * See xHCI 1.0 spec, 5.2.4
> +        */
> +       reg =   LINKSYSTEM_XHCI_VERSION_CONTROL |
> +               LINKSYSTEM_FLADJ(0x20);
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_LINKSYSTEM);
> +
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
> +       /* Select PHY CLK source */
> +       reg &= ~PHYPARAM0_REF_USE_PAD;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
> +
> +       /* This bit must be set for both HS and SS operations */
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMICLKSEL);
> +       reg |= PHYUTMICLKSEL_UTMI_CLKSEL;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMICLKSEL);
> +
> +       /* UTMI or PIPE3 specific init */
> +       inst->phy_cfg->phy_init(phy_drd);
> +
> +       /* reference clock settings */
> +       reg = inst->phy_cfg->set_refclk(inst);
> +
> +               /* Digital power supply in normal operating mode */
> +       reg |=  PHYCLKRST_RETENABLEN |
> +               /* Enable ref clock for SS function */
> +               PHYCLKRST_REF_SSP_EN |
> +               /* Enable spread spectrum */
> +               PHYCLKRST_SSC_EN |
> +               /* Power down HS Bias and PLL blocks in suspend mode */
> +               PHYCLKRST_COMMONONN |
> +               /* Reset the port */
> +               PHYCLKRST_PORTRESET;
> +
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
> +
> +       udelay(10);
> +
> +       reg &= ~PHYCLKRST_PORTRESET;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
> +
> +       clk_disable_unprepare(phy_drd->clk);
> +
> +       return 0;
> +}
> +
> +static int exynos5_usbdrd_phy_exit(struct phy *phy)
> +{
> +       int ret;
> +       u32 reg;
> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
> +
> +       ret = clk_prepare_enable(phy_drd->clk);
> +       if (ret)
> +               return ret;
> +
> +       reg =   PHYUTMI_OTGDISABLE |
> +               PHYUTMI_FORCESUSPEND |
> +               PHYUTMI_FORCESLEEP;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMI);
> +
> +       /* Resetting the PHYCLKRST enable bits to reduce leakage current */
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
> +       reg &= ~(PHYCLKRST_REF_SSP_EN |
> +                PHYCLKRST_SSC_EN |
> +                PHYCLKRST_COMMONONN);
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
> +
> +       /* Control PHYTEST to remove leakage current */
> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
> +       reg |=  PHYTEST_POWERDOWN_SSP |
> +               PHYTEST_POWERDOWN_HSP;
> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
> +
> +       clk_disable_unprepare(phy_drd->clk);
> +
> +       return 0;
> +}
> +
> +static int exynos5_usbdrd_phy_power_on(struct phy *phy)
> +{
> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
> +
> +       dev_dbg(phy_drd->dev, "Request to power_on usbdrd_phy phy\n");
> +
> +       clk_prepare_enable(phy_drd->ref_clk);
> +
> +       /* Power-on PHY*/
> +       inst->phy_cfg->phy_isol(inst, 0);
> +
> +       return 0;
> +}
> +
> +static int exynos5_usbdrd_phy_power_off(struct phy *phy)
> +{
> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
> +
> +       dev_dbg(phy_drd->dev, "Request to power_off usbdrd_phy phy\n");
> +
> +       /* Power-off the PHY */
> +       inst->phy_cfg->phy_isol(inst, 1);
> +
> +       clk_disable_unprepare(phy_drd->ref_clk);
> +
> +       return 0;
> +}
> +
> +static struct phy *exynos5_usbdrd_phy_xlate(struct device *dev,
> +                                       struct of_phandle_args *args)
> +{
> +       struct exynos5_usbdrd_phy *phy_drd = dev_get_drvdata(dev);
> +
> +       if (WARN_ON(args->args[0] > EXYNOS5_DRDPHYS_NUM))
> +               return ERR_PTR(-ENODEV);
> +
> +       return phy_drd->phys[args->args[0]].phy;
> +}
> +
> +static struct phy_ops exynos5_usbdrd_phy_ops = {
> +       .init           = exynos5_usbdrd_phy_init,
> +       .exit           = exynos5_usbdrd_phy_exit,
> +       .power_on       = exynos5_usbdrd_phy_power_on,
> +       .power_off      = exynos5_usbdrd_phy_power_off,
> +       .owner          = THIS_MODULE,
> +};
> +
> +const struct usbdrd_phy_config exynos5_usbdrd_phy_cfg[] = {
> +       {
> +               .id             = EXYNOS5_DRDPHY_UTMI,
> +               .phy_isol       = exynos5_usbdrd_phy_isol,
> +               .phy_init       = exynos5_usbdrd_utmi_init,
> +               .set_refclk     = exynos5_usbdrd_utmi_set_refclk,
> +       },
> +       {
> +               .id             = EXYNOS5_DRDPHY_PIPE3,
> +               .phy_isol       = exynos5_usbdrd_phy_isol,
> +               .phy_init       = exynos5_usbdrd_pipe3_init,
> +               .set_refclk     = exynos5_usbdrd_pipe3_set_refclk,
> +       },
> +};
> +
> +const struct exynos5_usbdrd_phy_drvdata exynos5420_usbdrd_phy = {
> +       .phy_cfg                = exynos5_usbdrd_phy_cfg,
> +};
> +
> +const struct exynos5_usbdrd_phy_drvdata exynos5250_usbdrd_phy = {
> +       .phy_cfg                = exynos5_usbdrd_phy_cfg,
> +};
> +
> +static const struct of_device_id exynos5_usbdrd_phy_of_match[] = {
> +       {
> +               .compatible = "samsung,exynos5250-usbdrd-phy",
> +               .data = &exynos5250_usbdrd_phy
> +       }, {
> +               .compatible = "samsung,exynos5420-usbdrd-phy",
> +               .data = &exynos5420_usbdrd_phy
> +       },
> +       { },
> +};
> +
> +static int exynos5_usbdrd_phy_probe(struct platform_device *pdev)
> +{
> +       struct device *dev = &pdev->dev;
> +       struct device_node *node = dev->of_node;
> +       struct exynos5_usbdrd_phy *phy_drd;
> +       struct phy_provider *phy_provider;
> +       struct resource *res;
> +       const struct of_device_id *match;
> +       const struct exynos5_usbdrd_phy_drvdata *drv_data;
> +       struct regmap *reg_pmu;
> +       u32 pmu_offset;
> +       unsigned long ref_rate;
> +       int i, ret;
> +
> +       phy_drd = devm_kzalloc(dev, sizeof(*phy_drd), GFP_KERNEL);
> +       if (!phy_drd)
> +               return -ENOMEM;
> +
> +       dev_set_drvdata(dev, phy_drd);
> +       phy_drd->dev = dev;
> +
> +       res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> +       phy_drd->reg_phy = devm_ioremap_resource(dev, res);
> +       if (IS_ERR(phy_drd->reg_phy))
> +               return PTR_ERR(phy_drd->reg_phy);
> +
> +       match = of_match_node(exynos5_usbdrd_phy_of_match, pdev->dev.of_node);
> +
> +       drv_data = match->data;
> +       phy_drd->drv_data = drv_data;
> +
> +       phy_drd->clk = devm_clk_get(dev, "phy");
> +       if (IS_ERR(phy_drd->clk)) {
> +               dev_err(dev, "Failed to get clock of phy controller\n");
> +               return PTR_ERR(phy_drd->clk);
> +       }
> +
> +       phy_drd->ref_clk = devm_clk_get(dev, "ref");
> +       if (IS_ERR(phy_drd->ref_clk)) {
> +               dev_err(dev, "Failed to get reference clock of usbdrd phy\n");
> +               return PTR_ERR(phy_drd->ref_clk);
> +       }
> +       ref_rate = clk_get_rate(phy_drd->ref_clk);
> +
> +       ret = exynos5_rate_to_clk(ref_rate, &phy_drd->extrefclk);
> +       if (ret) {
> +               dev_err(phy_drd->dev, "Clock rate (%ld) not supported\n",
> +                       ref_rate);
> +               return ret;
> +       }
> +
> +       reg_pmu = syscon_regmap_lookup_by_phandle(dev->of_node,
> +                                                  "samsung,pmu-syscon");
> +       if (IS_ERR(reg_pmu)) {
> +               dev_err(dev, "Failed to map PMU register (via syscon)\n");
> +               return PTR_ERR(reg_pmu);
> +       }
> +
> +       ret = of_property_read_u32(node, "samsung,pmu-offset", &pmu_offset);
> +       if (ret) {
> +               dev_err(dev, "Missing pmu-offset for phy isolation\n");
> +               return ret;
> +       }
> +
> +       dev_vdbg(dev, "Creating usbdrd_phy phy\n");
> +
> +       for (i = 0; i < EXYNOS5_DRDPHYS_NUM; i++) {
> +               struct phy *phy = devm_phy_create(dev, &exynos5_usbdrd_phy_ops,
> +                                                 NULL);
> +               if (IS_ERR(phy)) {
> +                       dev_err(dev, "Failed to create usbdrd_phy phy\n");
> +                       return PTR_ERR(phy);
> +               }
> +
> +               phy_drd->phys[i].phy = phy;
> +               phy_drd->phys[i].index = i;
> +               phy_drd->phys[i].reg_pmu = reg_pmu;
> +               phy_drd->phys[i].pmu_offset = pmu_offset;
> +               phy_drd->phys[i].phy_cfg = &drv_data->phy_cfg[i];
> +               phy_set_drvdata(phy, &phy_drd->phys[i]);
> +       }
> +
> +       phy_provider = devm_of_phy_provider_register(dev,
> +                                                    exynos5_usbdrd_phy_xlate);
> +       if (IS_ERR(phy_provider)) {
> +               dev_err(phy_drd->dev, "Failed to register phy provider\n");
> +               return PTR_ERR(phy_provider);
> +       }
> +
> +       return 0;
> +}
> +
> +static struct platform_driver exynos5_usb3drd_phy = {
> +       .probe  = exynos5_usbdrd_phy_probe,
> +       .driver = {
> +               .of_match_table = exynos5_usbdrd_phy_of_match,
> +               .name           = "exynos5_usb3drd_phy",
> +               .owner          = THIS_MODULE,
> +       }
> +};
> +
> +module_platform_driver(exynos5_usb3drd_phy);
> +MODULE_DESCRIPTION("Samsung EXYNOS5 SoCs USB 3.0 DRD controller PHY driver");
> +MODULE_AUTHOR("Vivek Gautam <[e-mail]>");
> +MODULE_LICENSE("GPL v2");
> +MODULE_ALIAS("platform:exynos5_usb3drd_phy");
> --
> 1.7.10.4
>

Kishon Vijay Abraham I May 6, 2014, 1:49 p.m. UTC | #2

On Wednesday 30 April 2014 08:54 AM, Vivek Gautam wrote:
> Hi Kishon, Tomasz,
> 
> 
> On Mon, Apr 28, 2014 at 11:47 AM, Vivek Gautam <[e-mail]> wrote:
>> Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
>> The new driver uses the generic PHY framework and will interact
>> with DWC3 controller present on Exynos5 series of SoCs.
>> Thereby, removing old phy-samsung-usb3 driver and related code
>> used untill now which was based on usb/phy framework.
>>
>> Signed-off-by: Vivek Gautam <[e-mail]>
>> ---
> 
> Does this patch looks Ok now ?

fine by me. Tomasz, if you are OK with this patch pls give you Acked by.

Cheers
Kishon

> Actually we plan to get this in for 3.16, so if things are good we can
> get a go ahead for this :-)
> 
>>
>> Changes from v6:
>>  - Addressed review comments:
>>    -- Sorted config entries in Kconfig and Makefile
>>    -- Made #define to_usbdrd_phy(inst) to a static inline routine.
>>    -- Restructured exynos5_rate_to_clk() as suggested.
>>    -- Amended 'val' field for regmap_update_bits() in the routine
>>       exynos5_usbdrd_phy_isol().
>>    -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
>>    -- Removed check for 'match' entry in probe().
>>
>>  .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
>>  drivers/phy/Kconfig                                |   11 +
>>  drivers/phy/Makefile                               |    1 +
>>  drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
>>  4 files changed, 679 insertions(+)
>>  create mode 100644 drivers/phy/phy-exynos5-usbdrd.c
>>
>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>> index b422e38..51efe4c 100644
>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>> @@ -114,3 +114,43 @@ Example:
>>                 compatible = "samsung,exynos-sataphy-i2c";
>>                 reg = <0x38>;
>>         };
>> +
>> +Samsung Exynos5 SoC series USB DRD PHY controller
>> +--------------------------------------------------
>> +
>> +Required properties:
>> +- compatible : Should be set to one of the following supported values:
>> +       - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>> +       - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>> +- reg : Register offset and length of USB DRD PHY register set;
>> +- clocks: Clock IDs array as required by the controller
>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>> +              Required clocks:
>> +       - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>> +              used for register access.
>> +       - ref: PHY's reference clock (usually crystal clock), used for
>> +              PHY operations, associated by phy name. It is used to
>> +              determine bit values for clock settings register.
>> +              For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>> +                     control pmu registers for power isolation.
>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>> +                     base.
>> +- #phy-cells : from the generic PHY bindings, must be 1;
>> +
>> +For "samsung,exynos5250-usbdrd-phy" and "samsung,exynos5420-usbdrd-phy"
>> +compatible PHYs, the second cell in the PHY specifier identifies the
>> +PHY id, which is interpreted as follows:
>> +  0 - UTMI+ type phy,
>> +  1 - PIPE3 type phy,
>> +
>> +Example:
>> +       usb3_phy: usbphy@12100000 {
>> +               compatible = "samsung,exynos5250-usbdrd-phy";
>> +               reg = <0x12100000 0x100>;
>> +               clocks = <&clock 286>, <&clock 1>;
>> +               clock-names = "phy", "ref";
>> +               samsung,pmu-syscon = <&pmu_system_controller>;
>> +               samsung,pmu-offset = <0x704>;
>> +               #phy-cells = <1>;
>> +       };
>> diff --git a/drivers/phy/Kconfig b/drivers/phy/Kconfig
>> index 3bb05f1..daa1707 100644
>> --- a/drivers/phy/Kconfig
>> +++ b/drivers/phy/Kconfig
>> @@ -159,6 +159,17 @@ config PHY_EXYNOS5250_USB2
>>           particular SoC is compiled in the driver. In case of Exynos 5250 four
>>           phys are available - device, host, HSIC0 and HSIC.
>>
>> +config PHY_EXYNOS5_USBDRD
>> +       tristate "Exynos5 SoC series USB DRD PHY driver"
>> +       depends on ARCH_EXYNOS5 && OF
>> +       depends on HAS_IOMEM
>> +       select GENERIC_PHY
>> +       select MFD_SYSCON
>> +       help
>> +         Enable USB DRD PHY support for Exynos 5 SoC series.
>> +         This driver provides PHY interface for USB 3.0 DRD controller
>> +         present on Exynos5 SoC series.
>> +
>>  config PHY_XGENE
>>         tristate "APM X-Gene 15Gbps PHY support"
>>         depends on HAS_IOMEM && OF && (ARM64 || COMPILE_TEST)
>> diff --git a/drivers/phy/Makefile b/drivers/phy/Makefile
>> index 2faf78e..333ba98 100644
>> --- a/drivers/phy/Makefile
>> +++ b/drivers/phy/Makefile
>> @@ -17,4 +17,5 @@ obj-$(CONFIG_PHY_SAMSUNG_USB2)                += phy-samsung-usb2.o
>>  obj-$(CONFIG_PHY_EXYNOS4210_USB2)      += phy-exynos4210-usb2.o
>>  obj-$(CONFIG_PHY_EXYNOS4X12_USB2)      += phy-exynos4x12-usb2.o
>>  obj-$(CONFIG_PHY_EXYNOS5250_USB2)      += phy-exynos5250-usb2.o
>> +obj-$(CONFIG_PHY_EXYNOS5_USBDRD)       += phy-exynos5-usbdrd.o
>>  obj-$(CONFIG_PHY_XGENE)                        += phy-xgene.o
>> diff --git a/drivers/phy/phy-exynos5-usbdrd.c b/drivers/phy/phy-exynos5-usbdrd.c
>> new file mode 100644
>> index 0000000..bc381e3
>> --- /dev/null
>> +++ b/drivers/phy/phy-exynos5-usbdrd.c
>> @@ -0,0 +1,627 @@
>> +/*
>> + * Samsung EXYNOS5 SoC series USB DRD PHY driver
>> + *
>> + * Phy provider for USB 3.0 DRD controller on Exynos5 SoC series
>> + *
>> + * Copyright (C) 2014 Samsung Electronics Co., Ltd.
>> + * Author: Vivek Gautam <[e-mail]>
>> + *
>> + * This program is free software; you can redistribute it and/or modify
>> + * it under the terms of the GNU General Public License version 2 as
>> + * published by the Free Software Foundation.
>> + */
>> +
>> +#include <linux/clk.h>
>> +#include <linux/delay.h>
>> +#include <linux/io.h>
>> +#include <linux/kernel.h>
>> +#include <linux/module.h>
>> +#include <linux/of.h>
>> +#include <linux/of_address.h>
>> +#include <linux/phy/phy.h>
>> +#include <linux/platform_device.h>
>> +#include <linux/mutex.h>
>> +#include <linux/mfd/syscon.h>
>> +#include <linux/regmap.h>
>> +
>> +/* Exynos USB PHY registers */
>> +#define EXYNOS5_FSEL_9MHZ6             0x0
>> +#define EXYNOS5_FSEL_10MHZ             0x1
>> +#define EXYNOS5_FSEL_12MHZ             0x2
>> +#define EXYNOS5_FSEL_19MHZ2            0x3
>> +#define EXYNOS5_FSEL_20MHZ             0x4
>> +#define EXYNOS5_FSEL_24MHZ             0x5
>> +#define EXYNOS5_FSEL_50MHZ             0x7
>> +
>> +/* EXYNOS5: USB 3.0 DRD PHY registers */
>> +#define EXYNOS5_DRD_LINKSYSTEM                 0x04
>> +
>> +#define LINKSYSTEM_FLADJ_MASK                  (0x3f << 1)
>> +#define LINKSYSTEM_FLADJ(_x)                   ((_x) << 1)
>> +#define LINKSYSTEM_XHCI_VERSION_CONTROL                BIT(27)
>> +
>> +#define EXYNOS5_DRD_PHYUTMI                    0x08
>> +
>> +#define PHYUTMI_OTGDISABLE                     BIT(6)
>> +#define PHYUTMI_FORCESUSPEND                   BIT(1)
>> +#define PHYUTMI_FORCESLEEP                     BIT(0)
>> +
>> +#define EXYNOS5_DRD_PHYPIPE                    0x0c
>> +
>> +#define EXYNOS5_DRD_PHYCLKRST                  0x10
>> +
>> +#define PHYCLKRST_EN_UTMISUSPEND               BIT(31)
>> +
>> +#define PHYCLKRST_SSC_REFCLKSEL_MASK           (0xff << 23)
>> +#define PHYCLKRST_SSC_REFCLKSEL(_x)            ((_x) << 23)
>> +
>> +#define PHYCLKRST_SSC_RANGE_MASK               (0x03 << 21)
>> +#define PHYCLKRST_SSC_RANGE(_x)                        ((_x) << 21)
>> +
>> +#define PHYCLKRST_SSC_EN                       BIT(20)
>> +#define PHYCLKRST_REF_SSP_EN                   BIT(19)
>> +#define PHYCLKRST_REF_CLKDIV2                  BIT(18)
>> +
>> +#define PHYCLKRST_MPLL_MULTIPLIER_MASK         (0x7f << 11)
>> +#define PHYCLKRST_MPLL_MULTIPLIER_100MHZ_REF   (0x19 << 11)
>> +#define PHYCLKRST_MPLL_MULTIPLIER_50M_REF      (0x32 << 11)
>> +#define PHYCLKRST_MPLL_MULTIPLIER_24MHZ_REF    (0x68 << 11)
>> +#define PHYCLKRST_MPLL_MULTIPLIER_20MHZ_REF    (0x7d << 11)
>> +#define PHYCLKRST_MPLL_MULTIPLIER_19200KHZ_REF (0x02 << 11)
>> +
>> +#define PHYCLKRST_FSEL_UTMI_MASK               (0x7 << 5)
>> +#define PHYCLKRST_FSEL_PIPE_MASK               (0x7 << 8)
>> +#define PHYCLKRST_FSEL(_x)                     ((_x) << 5)
>> +#define PHYCLKRST_FSEL_PAD_100MHZ              (0x27 << 5)
>> +#define PHYCLKRST_FSEL_PAD_24MHZ               (0x2a << 5)
>> +#define PHYCLKRST_FSEL_PAD_20MHZ               (0x31 << 5)
>> +#define PHYCLKRST_FSEL_PAD_19_2MHZ             (0x38 << 5)
>> +
>> +#define PHYCLKRST_RETENABLEN                   BIT(4)
>> +
>> +#define PHYCLKRST_REFCLKSEL_MASK               (0x03 << 2)
>> +#define PHYCLKRST_REFCLKSEL_PAD_REFCLK         (0x2 << 2)
>> +#define PHYCLKRST_REFCLKSEL_EXT_REFCLK         (0x3 << 2)
>> +
>> +#define PHYCLKRST_PORTRESET                    BIT(1)
>> +#define PHYCLKRST_COMMONONN                    BIT(0)
>> +
>> +#define EXYNOS5_DRD_PHYREG0                    0x14
>> +#define EXYNOS5_DRD_PHYREG1                    0x18
>> +
>> +#define EXYNOS5_DRD_PHYPARAM0                  0x1c
>> +
>> +#define PHYPARAM0_REF_USE_PAD                  BIT(31)
>> +#define PHYPARAM0_REF_LOSLEVEL_MASK            (0x1f << 26)
>> +#define PHYPARAM0_REF_LOSLEVEL                 (0x9 << 26)
>> +
>> +#define EXYNOS5_DRD_PHYPARAM1                  0x20
>> +
>> +#define PHYPARAM1_PCS_TXDEEMPH_MASK            (0x1f << 0)
>> +#define PHYPARAM1_PCS_TXDEEMPH                 (0x1c)
>> +
>> +#define EXYNOS5_DRD_PHYTERM                    0x24
>> +
>> +#define EXYNOS5_DRD_PHYTEST                    0x28
>> +
>> +#define PHYTEST_POWERDOWN_SSP                  BIT(3)
>> +#define PHYTEST_POWERDOWN_HSP                  BIT(2)
>> +
>> +#define EXYNOS5_DRD_PHYADP                     0x2c
>> +
>> +#define EXYNOS5_DRD_PHYUTMICLKSEL              0x30
>> +
>> +#define PHYUTMICLKSEL_UTMI_CLKSEL              BIT(2)
>> +
>> +#define EXYNOS5_DRD_PHYRESUME                  0x34
>> +#define EXYNOS5_DRD_LINKPORT                   0x44
>> +
>> +/* Power isolation defined in power management unit */
>> +#define EXYNOS5_USBDRD_PMU_ISOL                        BIT(0)
>> +
>> +#define KHZ    1000
>> +#define MHZ    (KHZ * KHZ)
>> +
>> +enum exynos5_usbdrd_phy_id {
>> +       EXYNOS5_DRDPHY_UTMI,
>> +       EXYNOS5_DRDPHY_PIPE3,
>> +       EXYNOS5_DRDPHYS_NUM,
>> +};
>> +
>> +struct phy_usb_instance;
>> +struct exynos5_usbdrd_phy;
>> +
>> +struct usbdrd_phy_config {
>> +       u32 id;
>> +       void (*phy_isol)(struct phy_usb_instance *inst, u32 on);
>> +       void (*phy_init)(struct exynos5_usbdrd_phy *phy_drd);
>> +       unsigned int (*set_refclk)(struct phy_usb_instance *inst);
>> +};
>> +
>> +struct exynos5_usbdrd_phy_drvdata {
>> +       const struct usbdrd_phy_config *phy_cfg;
>> +};
>> +
>> +/**
>> + * struct exynos5_usbdrd_phy - driver data for USB 3.0 PHY
>> + * @dev: pointer to device instance of this platform device
>> + * @reg_phy: usb phy controller register memory base
>> + * @clk: phy clock for register access
>> + * @drv_data: pointer to SoC level driver data structure
>> + * @phys[]: array for 'EXYNOS5_DRDPHYS_NUM' number of PHY
>> + *         instances each with its 'phy' and 'phy_cfg'.
>> + * @extrefclk: frequency select settings when using 'separate
>> + *            reference clocks' for SS and HS operations
>> + * @ref_clk: reference clock to PHY block from which PHY's
>> + *          operational clocks are derived
>> + * @ref_rate: rate of above reference clock
>> + */
>> +struct exynos5_usbdrd_phy {
>> +       struct device *dev;
>> +       void __iomem *reg_phy;
>> +       struct clk *clk;
>> +       const struct exynos5_usbdrd_phy_drvdata *drv_data;
>> +       struct phy_usb_instance {
>> +               struct phy *phy;
>> +               u32 index;
>> +               struct regmap *reg_pmu;
>> +               u32 pmu_offset;
>> +               const struct usbdrd_phy_config *phy_cfg;
>> +       } phys[EXYNOS5_DRDPHYS_NUM];
>> +       u32 extrefclk;
>> +       struct clk *ref_clk;
>> +};
>> +
>> +static inline
>> +struct exynos5_usbdrd_phy *to_usbdrd_phy(struct phy_usb_instance *inst)
>> +{
>> +       return container_of((inst), struct exynos5_usbdrd_phy,
>> +                           phys[(inst)->index]);
>> +}
>> +
>> +/*
>> + * exynos5_rate_to_clk() converts the supplied clock rate to the value that
>> + * can be written to the phy register.
>> + */
>> +static unsigned int exynos5_rate_to_clk(unsigned long rate, u32 *reg)
>> +{
>> +       /* EXYNOS5_FSEL_MASK */
>> +
>> +       switch (rate) {
>> +       case 9600 * KHZ:
>> +               *reg = EXYNOS5_FSEL_9MHZ6;
>> +               break;
>> +       case 10 * MHZ:
>> +               *reg = EXYNOS5_FSEL_10MHZ;
>> +               break;
>> +       case 12 * MHZ:
>> +               *reg = EXYNOS5_FSEL_12MHZ;
>> +               break;
>> +       case 19200 * KHZ:
>> +               *reg = EXYNOS5_FSEL_19MHZ2;
>> +               break;
>> +       case 20 * MHZ:
>> +               *reg = EXYNOS5_FSEL_20MHZ;
>> +               break;
>> +       case 24 * MHZ:
>> +               *reg = EXYNOS5_FSEL_24MHZ;
>> +               break;
>> +       case 50 * MHZ:
>> +               *reg = EXYNOS5_FSEL_50MHZ;
>> +               break;
>> +       default:
>> +               return -EINVAL;
>> +       }
>> +
>> +       return 0;
>> +}
>> +
>> +static void exynos5_usbdrd_phy_isol(struct phy_usb_instance *inst,
>> +                                               unsigned int on)
>> +{
>> +       unsigned int val;
>> +
>> +       if (!inst->reg_pmu)
>> +               return;
>> +
>> +       val = on ? 0 : EXYNOS5_USBDRD_PMU_ISOL;
>> +
>> +       regmap_update_bits(inst->reg_pmu, inst->pmu_offset,
>> +                          EXYNOS5_USBDRD_PMU_ISOL, val);
>> +}
>> +
>> +/*
>> + * Sets the pipe3 phy's clk as EXTREFCLK (XXTI) which is internal clock
>> + * from clock core. Further sets multiplier values and spread spectrum
>> + * clock settings for SuperSpeed operations.
>> + */
>> +static unsigned int
>> +exynos5_usbdrd_pipe3_set_refclk(struct phy_usb_instance *inst)
>> +{
>> +       static u32 reg;
>> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
>> +
>> +       /* restore any previous reference clock settings */
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
>> +
>> +       /* Use EXTREFCLK as ref clock */
>> +       reg &= ~PHYCLKRST_REFCLKSEL_MASK;
>> +       reg |=  PHYCLKRST_REFCLKSEL_EXT_REFCLK;
>> +
>> +       /* FSEL settings corresponding to reference clock */
>> +       reg &= ~PHYCLKRST_FSEL_PIPE_MASK |
>> +               PHYCLKRST_MPLL_MULTIPLIER_MASK |
>> +               PHYCLKRST_SSC_REFCLKSEL_MASK;
>> +       switch (phy_drd->extrefclk) {
>> +       case EXYNOS5_FSEL_50MHZ:
>> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_50M_REF |
>> +                       PHYCLKRST_SSC_REFCLKSEL(0x00));
>> +               break;
>> +       case EXYNOS5_FSEL_24MHZ:
>> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_24MHZ_REF |
>> +                       PHYCLKRST_SSC_REFCLKSEL(0x88));
>> +               break;
>> +       case EXYNOS5_FSEL_20MHZ:
>> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_20MHZ_REF |
>> +                       PHYCLKRST_SSC_REFCLKSEL(0x00));
>> +               break;
>> +       case EXYNOS5_FSEL_19MHZ2:
>> +               reg |= (PHYCLKRST_MPLL_MULTIPLIER_19200KHZ_REF |
>> +                       PHYCLKRST_SSC_REFCLKSEL(0x88));
>> +               break;
>> +       default:
>> +               dev_dbg(phy_drd->dev, "unsupported ref clk\n");
>> +               break;
>> +       }
>> +
>> +       return reg;
>> +}
>> +
>> +/*
>> + * Sets the utmi phy's clk as EXTREFCLK (XXTI) which is internal clock
>> + * from clock core. Further sets the FSEL values for HighSpeed operations.
>> + */
>> +static unsigned int
>> +exynos5_usbdrd_utmi_set_refclk(struct phy_usb_instance *inst)
>> +{
>> +       static u32 reg;
>> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
>> +
>> +       /* restore any previous reference clock settings */
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
>> +
>> +       reg &= ~PHYCLKRST_REFCLKSEL_MASK;
>> +       reg |=  PHYCLKRST_REFCLKSEL_EXT_REFCLK;
>> +
>> +       reg &= ~PHYCLKRST_FSEL_UTMI_MASK |
>> +               PHYCLKRST_MPLL_MULTIPLIER_MASK |
>> +               PHYCLKRST_SSC_REFCLKSEL_MASK;
>> +       reg |= PHYCLKRST_FSEL(phy_drd->extrefclk);
>> +
>> +       return reg;
>> +}
>> +
>> +static void exynos5_usbdrd_pipe3_init(struct exynos5_usbdrd_phy *phy_drd)
>> +{
>> +       u32 reg;
>> +
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
>> +       /* Set Tx De-Emphasis level */
>> +       reg &= ~PHYPARAM1_PCS_TXDEEMPH_MASK;
>> +       reg |=  PHYPARAM1_PCS_TXDEEMPH;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
>> +
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
>> +       reg &= ~PHYTEST_POWERDOWN_SSP;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
>> +}
>> +
>> +static void exynos5_usbdrd_utmi_init(struct exynos5_usbdrd_phy *phy_drd)
>> +{
>> +       u32 reg;
>> +
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
>> +       /* Set Loss-of-Signal Detector sensitivity */
>> +       reg &= ~PHYPARAM0_REF_LOSLEVEL_MASK;
>> +       reg |=  PHYPARAM0_REF_LOSLEVEL;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
>> +
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
>> +       /* Set Tx De-Emphasis level */
>> +       reg &= ~PHYPARAM1_PCS_TXDEEMPH_MASK;
>> +       reg |=  PHYPARAM1_PCS_TXDEEMPH;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
>> +
>> +       /* UTMI Power Control */
>> +       writel(PHYUTMI_OTGDISABLE, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMI);
>> +
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
>> +       reg &= ~PHYTEST_POWERDOWN_HSP;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
>> +}
>> +
>> +static int exynos5_usbdrd_phy_init(struct phy *phy)
>> +{
>> +       int ret;
>> +       u32 reg;
>> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
>> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
>> +
>> +       ret = clk_prepare_enable(phy_drd->clk);
>> +       if (ret)
>> +               return ret;
>> +
>> +       /* Reset USB 3.0 PHY */
>> +       writel(0x0, phy_drd->reg_phy + EXYNOS5_DRD_PHYREG0);
>> +       writel(0x0, phy_drd->reg_phy + EXYNOS5_DRD_PHYRESUME);
>> +
>> +       /*
>> +        * Setting the Frame length Adj value[6:1] to default 0x20
>> +        * See xHCI 1.0 spec, 5.2.4
>> +        */
>> +       reg =   LINKSYSTEM_XHCI_VERSION_CONTROL |
>> +               LINKSYSTEM_FLADJ(0x20);
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_LINKSYSTEM);
>> +
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
>> +       /* Select PHY CLK source */
>> +       reg &= ~PHYPARAM0_REF_USE_PAD;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
>> +
>> +       /* This bit must be set for both HS and SS operations */
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMICLKSEL);
>> +       reg |= PHYUTMICLKSEL_UTMI_CLKSEL;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMICLKSEL);
>> +
>> +       /* UTMI or PIPE3 specific init */
>> +       inst->phy_cfg->phy_init(phy_drd);
>> +
>> +       /* reference clock settings */
>> +       reg = inst->phy_cfg->set_refclk(inst);
>> +
>> +               /* Digital power supply in normal operating mode */
>> +       reg |=  PHYCLKRST_RETENABLEN |
>> +               /* Enable ref clock for SS function */
>> +               PHYCLKRST_REF_SSP_EN |
>> +               /* Enable spread spectrum */
>> +               PHYCLKRST_SSC_EN |
>> +               /* Power down HS Bias and PLL blocks in suspend mode */
>> +               PHYCLKRST_COMMONONN |
>> +               /* Reset the port */
>> +               PHYCLKRST_PORTRESET;
>> +
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
>> +
>> +       udelay(10);
>> +
>> +       reg &= ~PHYCLKRST_PORTRESET;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
>> +
>> +       clk_disable_unprepare(phy_drd->clk);
>> +
>> +       return 0;
>> +}
>> +
>> +static int exynos5_usbdrd_phy_exit(struct phy *phy)
>> +{
>> +       int ret;
>> +       u32 reg;
>> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
>> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
>> +
>> +       ret = clk_prepare_enable(phy_drd->clk);
>> +       if (ret)
>> +               return ret;
>> +
>> +       reg =   PHYUTMI_OTGDISABLE |
>> +               PHYUTMI_FORCESUSPEND |
>> +               PHYUTMI_FORCESLEEP;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMI);
>> +
>> +       /* Resetting the PHYCLKRST enable bits to reduce leakage current */
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
>> +       reg &= ~(PHYCLKRST_REF_SSP_EN |
>> +                PHYCLKRST_SSC_EN |
>> +                PHYCLKRST_COMMONONN);
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
>> +
>> +       /* Control PHYTEST to remove leakage current */
>> +       reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
>> +       reg |=  PHYTEST_POWERDOWN_SSP |
>> +               PHYTEST_POWERDOWN_HSP;
>> +       writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
>> +
>> +       clk_disable_unprepare(phy_drd->clk);
>> +
>> +       return 0;
>> +}
>> +
>> +static int exynos5_usbdrd_phy_power_on(struct phy *phy)
>> +{
>> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
>> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
>> +
>> +       dev_dbg(phy_drd->dev, "Request to power_on usbdrd_phy phy\n");
>> +
>> +       clk_prepare_enable(phy_drd->ref_clk);
>> +
>> +       /* Power-on PHY*/
>> +       inst->phy_cfg->phy_isol(inst, 0);
>> +
>> +       return 0;
>> +}
>> +
>> +static int exynos5_usbdrd_phy_power_off(struct phy *phy)
>> +{
>> +       struct phy_usb_instance *inst = phy_get_drvdata(phy);
>> +       struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
>> +
>> +       dev_dbg(phy_drd->dev, "Request to power_off usbdrd_phy phy\n");
>> +
>> +       /* Power-off the PHY */
>> +       inst->phy_cfg->phy_isol(inst, 1);
>> +
>> +       clk_disable_unprepare(phy_drd->ref_clk);
>> +
>> +       return 0;
>> +}
>> +
>> +static struct phy *exynos5_usbdrd_phy_xlate(struct device *dev,
>> +                                       struct of_phandle_args *args)
>> +{
>> +       struct exynos5_usbdrd_phy *phy_drd = dev_get_drvdata(dev);
>> +
>> +       if (WARN_ON(args->args[0] > EXYNOS5_DRDPHYS_NUM))
>> +               return ERR_PTR(-ENODEV);
>> +
>> +       return phy_drd->phys[args->args[0]].phy;
>> +}
>> +
>> +static struct phy_ops exynos5_usbdrd_phy_ops = {
>> +       .init           = exynos5_usbdrd_phy_init,
>> +       .exit           = exynos5_usbdrd_phy_exit,
>> +       .power_on       = exynos5_usbdrd_phy_power_on,
>> +       .power_off      = exynos5_usbdrd_phy_power_off,
>> +       .owner          = THIS_MODULE,
>> +};
>> +
>> +const struct usbdrd_phy_config exynos5_usbdrd_phy_cfg[] = {
>> +       {
>> +               .id             = EXYNOS5_DRDPHY_UTMI,
>> +               .phy_isol       = exynos5_usbdrd_phy_isol,
>> +               .phy_init       = exynos5_usbdrd_utmi_init,
>> +               .set_refclk     = exynos5_usbdrd_utmi_set_refclk,
>> +       },
>> +       {
>> +               .id             = EXYNOS5_DRDPHY_PIPE3,
>> +               .phy_isol       = exynos5_usbdrd_phy_isol,
>> +               .phy_init       = exynos5_usbdrd_pipe3_init,
>> +               .set_refclk     = exynos5_usbdrd_pipe3_set_refclk,
>> +       },
>> +};
>> +
>> +const struct exynos5_usbdrd_phy_drvdata exynos5420_usbdrd_phy = {
>> +       .phy_cfg                = exynos5_usbdrd_phy_cfg,
>> +};
>> +
>> +const struct exynos5_usbdrd_phy_drvdata exynos5250_usbdrd_phy = {
>> +       .phy_cfg                = exynos5_usbdrd_phy_cfg,
>> +};
>> +
>> +static const struct of_device_id exynos5_usbdrd_phy_of_match[] = {
>> +       {
>> +               .compatible = "samsung,exynos5250-usbdrd-phy",
>> +               .data = &exynos5250_usbdrd_phy
>> +       }, {
>> +               .compatible = "samsung,exynos5420-usbdrd-phy",
>> +               .data = &exynos5420_usbdrd_phy
>> +       },
>> +       { },
>> +};
>> +
>> +static int exynos5_usbdrd_phy_probe(struct platform_device *pdev)
>> +{
>> +       struct device *dev = &pdev->dev;
>> +       struct device_node *node = dev->of_node;
>> +       struct exynos5_usbdrd_phy *phy_drd;
>> +       struct phy_provider *phy_provider;
>> +       struct resource *res;
>> +       const struct of_device_id *match;
>> +       const struct exynos5_usbdrd_phy_drvdata *drv_data;
>> +       struct regmap *reg_pmu;
>> +       u32 pmu_offset;
>> +       unsigned long ref_rate;
>> +       int i, ret;
>> +
>> +       phy_drd = devm_kzalloc(dev, sizeof(*phy_drd), GFP_KERNEL);
>> +       if (!phy_drd)
>> +               return -ENOMEM;
>> +
>> +       dev_set_drvdata(dev, phy_drd);
>> +       phy_drd->dev = dev;
>> +
>> +       res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
>> +       phy_drd->reg_phy = devm_ioremap_resource(dev, res);
>> +       if (IS_ERR(phy_drd->reg_phy))
>> +               return PTR_ERR(phy_drd->reg_phy);
>> +
>> +       match = of_match_node(exynos5_usbdrd_phy_of_match, pdev->dev.of_node);
>> +
>> +       drv_data = match->data;
>> +       phy_drd->drv_data = drv_data;
>> +
>> +       phy_drd->clk = devm_clk_get(dev, "phy");
>> +       if (IS_ERR(phy_drd->clk)) {
>> +               dev_err(dev, "Failed to get clock of phy controller\n");
>> +               return PTR_ERR(phy_drd->clk);
>> +       }
>> +
>> +       phy_drd->ref_clk = devm_clk_get(dev, "ref");
>> +       if (IS_ERR(phy_drd->ref_clk)) {
>> +               dev_err(dev, "Failed to get reference clock of usbdrd phy\n");
>> +               return PTR_ERR(phy_drd->ref_clk);
>> +       }
>> +       ref_rate = clk_get_rate(phy_drd->ref_clk);
>> +
>> +       ret = exynos5_rate_to_clk(ref_rate, &phy_drd->extrefclk);
>> +       if (ret) {
>> +               dev_err(phy_drd->dev, "Clock rate (%ld) not supported\n",
>> +                       ref_rate);
>> +               return ret;
>> +       }
>> +
>> +       reg_pmu = syscon_regmap_lookup_by_phandle(dev->of_node,
>> +                                                  "samsung,pmu-syscon");
>> +       if (IS_ERR(reg_pmu)) {
>> +               dev_err(dev, "Failed to map PMU register (via syscon)\n");
>> +               return PTR_ERR(reg_pmu);
>> +       }
>> +
>> +       ret = of_property_read_u32(node, "samsung,pmu-offset", &pmu_offset);
>> +       if (ret) {
>> +               dev_err(dev, "Missing pmu-offset for phy isolation\n");
>> +               return ret;
>> +       }
>> +
>> +       dev_vdbg(dev, "Creating usbdrd_phy phy\n");
>> +
>> +       for (i = 0; i < EXYNOS5_DRDPHYS_NUM; i++) {
>> +               struct phy *phy = devm_phy_create(dev, &exynos5_usbdrd_phy_ops,
>> +                                                 NULL);
>> +               if (IS_ERR(phy)) {
>> +                       dev_err(dev, "Failed to create usbdrd_phy phy\n");
>> +                       return PTR_ERR(phy);
>> +               }
>> +
>> +               phy_drd->phys[i].phy = phy;
>> +               phy_drd->phys[i].index = i;
>> +               phy_drd->phys[i].reg_pmu = reg_pmu;
>> +               phy_drd->phys[i].pmu_offset = pmu_offset;
>> +               phy_drd->phys[i].phy_cfg = &drv_data->phy_cfg[i];
>> +               phy_set_drvdata(phy, &phy_drd->phys[i]);
>> +       }
>> +
>> +       phy_provider = devm_of_phy_provider_register(dev,
>> +                                                    exynos5_usbdrd_phy_xlate);
>> +       if (IS_ERR(phy_provider)) {
>> +               dev_err(phy_drd->dev, "Failed to register phy provider\n");
>> +               return PTR_ERR(phy_provider);
>> +       }
>> +
>> +       return 0;
>> +}
>> +
>> +static struct platform_driver exynos5_usb3drd_phy = {
>> +       .probe  = exynos5_usbdrd_phy_probe,
>> +       .driver = {
>> +               .of_match_table = exynos5_usbdrd_phy_of_match,
>> +               .name           = "exynos5_usb3drd_phy",
>> +               .owner          = THIS_MODULE,
>> +       }
>> +};
>> +
>> +module_platform_driver(exynos5_usb3drd_phy);
>> +MODULE_DESCRIPTION("Samsung EXYNOS5 SoCs USB 3.0 DRD controller PHY driver");
>> +MODULE_AUTHOR("Vivek Gautam <[e-mail]>");
>> +MODULE_LICENSE("GPL v2");
>> +MODULE_ALIAS("platform:exynos5_usb3drd_phy");
>> --
>> 1.7.10.4
>>
> 
> 
>

Sylwester Nawrocki/Kernel \(PLT\) /SRPOL/Staff Engineer/Samsung Electronics May 6, 2014, 2:27 p.m. UTC | #3

On 28/04/14 08:17, Vivek Gautam wrote:
> Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
> The new driver uses the generic PHY framework and will interact
> with DWC3 controller present on Exynos5 series of SoCs.
> Thereby, removing old phy-samsung-usb3 driver and related code
> used untill now which was based on usb/phy framework.
> 
> Signed-off-by: Vivek Gautam <[e-mail]>
> ---
> 
> Changes from v6:
>  - Addressed review comments:
>    -- Sorted config entries in Kconfig and Makefile
>    -- Made #define to_usbdrd_phy(inst) to a static inline routine.
>    -- Restructured exynos5_rate_to_clk() as suggested.
>    -- Amended 'val' field for regmap_update_bits() in the routine
>       exynos5_usbdrd_phy_isol().
>    -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
>    -- Removed check for 'match' entry in probe().
> 
>  .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
>  drivers/phy/Kconfig                                |   11 +
>  drivers/phy/Makefile                               |    1 +
>  drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
>  4 files changed, 679 insertions(+)
>  create mode 100644 drivers/phy/phy-exynos5-usbdrd.c
> 
> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
> index b422e38..51efe4c 100644
> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
> @@ -114,3 +114,43 @@ Example:
>  		compatible = "samsung,exynos-sataphy-i2c";
>  		reg = <0x38>;
>  	};
> +
> +Samsung Exynos5 SoC series USB DRD PHY controller
> +--------------------------------------------------
> +
> +Required properties:
> +- compatible : Should be set to one of the following supported values:
> +	- "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
> +	- "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
> +- reg : Register offset and length of USB DRD PHY register set;
> +- clocks: Clock IDs array as required by the controller
> +- clock-names: names of clocks correseponding to IDs in the clock property;
> +	       Required clocks:
> +	- phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
> +	       used for register access.
> +	- ref: PHY's reference clock (usually crystal clock), used for
> +	       PHY operations, associated by phy name. It is used to
> +	       determine bit values for clock settings register.
> +	       For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
> +		      control pmu registers for power isolation.
> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
> +		      base.

It doesn't seem right to have register offset encoded in the device tree
like this. I think it'd be more appropriate to associate such an offset
with the compatible string's value in the driver.

Also it might be sensible to create a new header file in include/linux/mfd/
syscon/ for Exynos5 SoCs and put any required PMU offset definitions there. 
Instead having them scattered and possibly duplicated in various drivers.

> +- #phy-cells : from the generic PHY bindings, must be 1;
> +
> +For "samsung,exynos5250-usbdrd-phy" and "samsung,exynos5420-usbdrd-phy"
> +compatible PHYs, the second cell in the PHY specifier identifies the
> +PHY id, which is interpreted as follows:
> +  0 - UTMI+ type phy,
> +  1 - PIPE3 type phy,
> +
> +Example:
> +	usb3_phy: usbphy@12100000 {
> +		compatible = "samsung,exynos5250-usbdrd-phy";
> +		reg = <0x12100000 0x100>;
> +		clocks = <&clock 286>, <&clock 1>;
> +		clock-names = "phy", "ref";
> +		samsung,pmu-syscon = <&pmu_system_controller>;
> +		samsung,pmu-offset = <0x704>;
> +		#phy-cells = <1>;
> +	};
[...]
> +struct usbdrd_phy_config {

Isn't name of this data structure too generic ? 
Perhaps rename it to exynos_usbdrd_phy_config ?

> +	u32 id;
> +	void (*phy_isol)(struct phy_usb_instance *inst, u32 on);
> +	void (*phy_init)(struct exynos5_usbdrd_phy *phy_drd);
> +	unsigned int (*set_refclk)(struct phy_usb_instance *inst);
> +};
> +
> +struct exynos5_usbdrd_phy_drvdata {
> +	const struct usbdrd_phy_config *phy_cfg;
> +};
> +
[...]
> +const struct exynos5_usbdrd_phy_drvdata exynos5420_usbdrd_phy = {
> +	.phy_cfg		= exynos5_usbdrd_phy_cfg,
> +};
> +
> +const struct exynos5_usbdrd_phy_drvdata exynos5250_usbdrd_phy = {
> +	.phy_cfg		= exynos5_usbdrd_phy_cfg,
> +};
> +
> +static const struct of_device_id exynos5_usbdrd_phy_of_match[] = {
> +	{
> +		.compatible = "samsung,exynos5250-usbdrd-phy",
> +		.data = &exynos5250_usbdrd_phy
> +	}, {
> +		.compatible = "samsung,exynos5420-usbdrd-phy",
> +		.data = &exynos5420_usbdrd_phy
> +	},
> +	{ },
> +};
> +
> +static int exynos5_usbdrd_phy_probe(struct platform_device *pdev)
> +{
[...]
> +	reg_pmu = syscon_regmap_lookup_by_phandle(dev->of_node,
> +						   "samsung,pmu-syscon");
> +	if (IS_ERR(reg_pmu)) {
> +		dev_err(dev, "Failed to map PMU register (via syscon)\n");

nit: Maybe change it to: "Failed to lookup PMU regmap\n" ?

> +		return PTR_ERR(reg_pmu);
> +	}
> +
> +	ret = of_property_read_u32(node, "samsung,pmu-offset", &pmu_offset);
> +	if (ret) {
> +		dev_err(dev, "Missing pmu-offset for phy isolation\n");
> +		return ret;
> +	}

Otherwise the patch looks good.

--
Thanks,
Sylwester

Vivek Gautam May 8, 2014, 6:05 a.m. UTC | #4

Hi Sylwester,


On Tue, May 6, 2014 at 7:57 PM, Sylwester Nawrocki
<[e-mail]> wrote:
> On 28/04/14 08:17, Vivek Gautam wrote:
>> Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
>> The new driver uses the generic PHY framework and will interact
>> with DWC3 controller present on Exynos5 series of SoCs.
>> Thereby, removing old phy-samsung-usb3 driver and related code
>> used untill now which was based on usb/phy framework.
>>
>> Signed-off-by: Vivek Gautam <[e-mail]>
>> ---
>>
>> Changes from v6:
>>  - Addressed review comments:
>>    -- Sorted config entries in Kconfig and Makefile
>>    -- Made #define to_usbdrd_phy(inst) to a static inline routine.
>>    -- Restructured exynos5_rate_to_clk() as suggested.
>>    -- Amended 'val' field for regmap_update_bits() in the routine
>>       exynos5_usbdrd_phy_isol().
>>    -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
>>    -- Removed check for 'match' entry in probe().
>>
>>  .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
>>  drivers/phy/Kconfig                                |   11 +
>>  drivers/phy/Makefile                               |    1 +
>>  drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
>>  4 files changed, 679 insertions(+)
>>  create mode 100644 drivers/phy/phy-exynos5-usbdrd.c
>>
>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>> index b422e38..51efe4c 100644
>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>> @@ -114,3 +114,43 @@ Example:
>>               compatible = "samsung,exynos-sataphy-i2c";
>>               reg = <0x38>;
>>       };
>> +
>> +Samsung Exynos5 SoC series USB DRD PHY controller
>> +--------------------------------------------------
>> +
>> +Required properties:
>> +- compatible : Should be set to one of the following supported values:
>> +     - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>> +     - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>> +- reg : Register offset and length of USB DRD PHY register set;
>> +- clocks: Clock IDs array as required by the controller
>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>> +            Required clocks:
>> +     - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>> +            used for register access.
>> +     - ref: PHY's reference clock (usually crystal clock), used for
>> +            PHY operations, associated by phy name. It is used to
>> +            determine bit values for clock settings register.
>> +            For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>> +                   control pmu registers for power isolation.
>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>> +                   base.
>
> It doesn't seem right to have register offset encoded in the device tree
> like this. I think it'd be more appropriate to associate such an offset
> with the compatible string's value in the driver.

Ok, it makes more sense.
Just out of curiosity, what difference would this make ?

>
> Also it might be sensible to create a new header file in include/linux/mfd/
> syscon/ for Exynos5 SoCs and put any required PMU offset definitions there.
> Instead having them scattered and possibly duplicated in various drivers.
>
>> +- #phy-cells : from the generic PHY bindings, must be 1;
>> +
>> +For "samsung,exynos5250-usbdrd-phy" and "samsung,exynos5420-usbdrd-phy"
>> +compatible PHYs, the second cell in the PHY specifier identifies the
>> +PHY id, which is interpreted as follows:
>> +  0 - UTMI+ type phy,
>> +  1 - PIPE3 type phy,
>> +
>> +Example:
>> +     usb3_phy: usbphy@12100000 {
>> +             compatible = "samsung,exynos5250-usbdrd-phy";
>> +             reg = <0x12100000 0x100>;
>> +             clocks = <&clock 286>, <&clock 1>;
>> +             clock-names = "phy", "ref";
>> +             samsung,pmu-syscon = <&pmu_system_controller>;
>> +             samsung,pmu-offset = <0x704>;
>> +             #phy-cells = <1>;
>> +     };
> [...]
>> +struct usbdrd_phy_config {
>
> Isn't name of this data structure too generic ?
> Perhaps rename it to exynos_usbdrd_phy_config ?

Sure, will change this name, and thereby change the names of its instances.

>
>> +     u32 id;
>> +     void (*phy_isol)(struct phy_usb_instance *inst, u32 on);
>> +     void (*phy_init)(struct exynos5_usbdrd_phy *phy_drd);
>> +     unsigned int (*set_refclk)(struct phy_usb_instance *inst);
>> +};
>> +
>> +struct exynos5_usbdrd_phy_drvdata {
>> +     const struct usbdrd_phy_config *phy_cfg;
>> +};
>> +
> [...]
>> +const struct exynos5_usbdrd_phy_drvdata exynos5420_usbdrd_phy = {
>> +     .phy_cfg                = exynos5_usbdrd_phy_cfg,
>> +};
>> +
>> +const struct exynos5_usbdrd_phy_drvdata exynos5250_usbdrd_phy = {
>> +     .phy_cfg                = exynos5_usbdrd_phy_cfg,
>> +};
>> +
>> +static const struct of_device_id exynos5_usbdrd_phy_of_match[] = {
>> +     {
>> +             .compatible = "samsung,exynos5250-usbdrd-phy",
>> +             .data = &exynos5250_usbdrd_phy
>> +     }, {
>> +             .compatible = "samsung,exynos5420-usbdrd-phy",
>> +             .data = &exynos5420_usbdrd_phy
>> +     },
>> +     { },
>> +};
>> +
>> +static int exynos5_usbdrd_phy_probe(struct platform_device *pdev)
>> +{
> [...]
>> +     reg_pmu = syscon_regmap_lookup_by_phandle(dev->of_node,
>> +                                                "samsung,pmu-syscon");
>> +     if (IS_ERR(reg_pmu)) {
>> +             dev_err(dev, "Failed to map PMU register (via syscon)\n");
>
> nit: Maybe change it to: "Failed to lookup PMU regmap\n" ?

Sure, will change this.

>
>> +             return PTR_ERR(reg_pmu);
>> +     }
>> +
>> +     ret = of_property_read_u32(node, "samsung,pmu-offset", &pmu_offset);
>> +     if (ret) {
>> +             dev_err(dev, "Missing pmu-offset for phy isolation\n");
>> +             return ret;
>> +     }
>
> Otherwise the patch looks good.

Thanks for the review.

Vivek Gautam May 8, 2014, 9:03 a.m. UTC | #5

On Thu, May 8, 2014 at 11:35 AM, Vivek Gautam <[e-mail]> wrote:
> Hi Sylwester,
>
>
> On Tue, May 6, 2014 at 7:57 PM, Sylwester Nawrocki
> <[e-mail]> wrote:
>> On 28/04/14 08:17, Vivek Gautam wrote:
>>> Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
>>> The new driver uses the generic PHY framework and will interact
>>> with DWC3 controller present on Exynos5 series of SoCs.
>>> Thereby, removing old phy-samsung-usb3 driver and related code
>>> used untill now which was based on usb/phy framework.
>>>
>>> Signed-off-by: Vivek Gautam <[e-mail]>
>>> ---
>>>
>>> Changes from v6:
>>>  - Addressed review comments:
>>>    -- Sorted config entries in Kconfig and Makefile
>>>    -- Made #define to_usbdrd_phy(inst) to a static inline routine.
>>>    -- Restructured exynos5_rate_to_clk() as suggested.
>>>    -- Amended 'val' field for regmap_update_bits() in the routine
>>>       exynos5_usbdrd_phy_isol().
>>>    -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
>>>    -- Removed check for 'match' entry in probe().
>>>
>>>  .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
>>>  drivers/phy/Kconfig                                |   11 +
>>>  drivers/phy/Makefile                               |    1 +
>>>  drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
>>>  4 files changed, 679 insertions(+)
>>>  create mode 100644 drivers/phy/phy-exynos5-usbdrd.c
>>>
>>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>> index b422e38..51efe4c 100644
>>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>> @@ -114,3 +114,43 @@ Example:
>>>               compatible = "samsung,exynos-sataphy-i2c";
>>>               reg = <0x38>;
>>>       };
>>> +
>>> +Samsung Exynos5 SoC series USB DRD PHY controller
>>> +--------------------------------------------------
>>> +
>>> +Required properties:
>>> +- compatible : Should be set to one of the following supported values:
>>> +     - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>>> +     - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>>> +- reg : Register offset and length of USB DRD PHY register set;
>>> +- clocks: Clock IDs array as required by the controller
>>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>>> +            Required clocks:
>>> +     - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>>> +            used for register access.
>>> +     - ref: PHY's reference clock (usually crystal clock), used for
>>> +            PHY operations, associated by phy name. It is used to
>>> +            determine bit values for clock settings register.
>>> +            For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>>> +                   control pmu registers for power isolation.
>>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>>> +                   base.
>>
>> It doesn't seem right to have register offset encoded in the device tree
>> like this. I think it'd be more appropriate to associate such an offset
>> with the compatible string's value in the driver.
>
> Ok, it makes more sense.
> Just out of curiosity, what difference would this make ?

Moreover, in case of Exynos5420 (and may be in future SoCs), where we
have 2 USB DRD PHY controllers,
we will need to have a way around to deal with two separate offsets in
the driver for one compatible string.

Getting the offsets from DT seems a cleaner way to handle this case of
multi controllers.

[snip]

Tomasz Figa May 9, 2014, 9:36 a.m. UTC | #6

[CCing DT maintainers]

On 08.05.2014 11:03, Vivek Gautam wrote:
> On Thu, May 8, 2014 at 11:35 AM, Vivek Gautam <[e-mail]> wrote:
>> Hi Sylwester,
>>
>>
>> On Tue, May 6, 2014 at 7:57 PM, Sylwester Nawrocki
>> <[e-mail]> wrote:
>>> On 28/04/14 08:17, Vivek Gautam wrote:
>>>> Add a new driver for the USB 3.0 PHY on Exynos5 series of SoCs.
>>>> The new driver uses the generic PHY framework and will interact
>>>> with DWC3 controller present on Exynos5 series of SoCs.
>>>> Thereby, removing old phy-samsung-usb3 driver and related code
>>>> used untill now which was based on usb/phy framework.
>>>>
>>>> Signed-off-by: Vivek Gautam <[e-mail]>
>>>> ---
>>>>
>>>> Changes from v6:
>>>>  - Addressed review comments:
>>>>    -- Sorted config entries in Kconfig and Makefile
>>>>    -- Made #define to_usbdrd_phy(inst) to a static inline routine.
>>>>    -- Restructured exynos5_rate_to_clk() as suggested.
>>>>    -- Amended 'val' field for regmap_update_bits() in the routine
>>>>       exynos5_usbdrd_phy_isol().
>>>>    -- Removed sentinel entry from exynos5_usbdrd_phy_cfg[] struct.
>>>>    -- Removed check for 'match' entry in probe().
>>>>
>>>>  .../devicetree/bindings/phy/samsung-phy.txt        |   40 ++
>>>>  drivers/phy/Kconfig                                |   11 +
>>>>  drivers/phy/Makefile                               |    1 +
>>>>  drivers/phy/phy-exynos5-usbdrd.c                   |  627 ++++++++++++++++++++
>>>>  4 files changed, 679 insertions(+)
>>>>  create mode 100644 drivers/phy/phy-exynos5-usbdrd.c
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>> index b422e38..51efe4c 100644
>>>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>> @@ -114,3 +114,43 @@ Example:
>>>>               compatible = "samsung,exynos-sataphy-i2c";
>>>>               reg = <0x38>;
>>>>       };
>>>> +
>>>> +Samsung Exynos5 SoC series USB DRD PHY controller
>>>> +--------------------------------------------------
>>>> +
>>>> +Required properties:
>>>> +- compatible : Should be set to one of the following supported values:
>>>> +     - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>>>> +     - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>>>> +- reg : Register offset and length of USB DRD PHY register set;
>>>> +- clocks: Clock IDs array as required by the controller
>>>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>>>> +            Required clocks:
>>>> +     - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>>>> +            used for register access.
>>>> +     - ref: PHY's reference clock (usually crystal clock), used for
>>>> +            PHY operations, associated by phy name. It is used to
>>>> +            determine bit values for clock settings register.
>>>> +            For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>>>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>>>> +                   control pmu registers for power isolation.
>>>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>>>> +                   base.
>>>
>>> It doesn't seem right to have register offset encoded in the device tree
>>> like this. I think it'd be more appropriate to associate such an offset
>>> with the compatible string's value in the driver.
>>
>> Ok, it makes more sense.
>> Just out of curiosity, what difference would this make ?
> 
> Moreover, in case of Exynos5420 (and may be in future SoCs), where we
> have 2 USB DRD PHY controllers,
> we will need to have a way around to deal with two separate offsets in
> the driver for one compatible string.
> 
> Getting the offsets from DT seems a cleaner way to handle this case of
> multi controllers.

Mark, Rob, what is your opinion on this?

Best regards,
Tomasz

Sylwester Nawrocki/Kernel \(PLT\) /SRPOL/Staff Engineer/Samsung Electronics May 9, 2014, 10:13 a.m. UTC | #7

Hi Vivek,

On 08/05/14 11:03, Vivek Gautam wrote:
>>>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>> >>> index b422e38..51efe4c 100644
>>>> >>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>> >>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>> >>> @@ -114,3 +114,43 @@ Example:
>>>> >>>               compatible = "samsung,exynos-sataphy-i2c";
>>>> >>>               reg = <0x38>;
>>>> >>>       };
>>>> >>> +
>>>> >>> +Samsung Exynos5 SoC series USB DRD PHY controller
>>>> >>> +--------------------------------------------------
>>>> >>> +
>>>> >>> +Required properties:
>>>> >>> +- compatible : Should be set to one of the following supported values:
>>>> >>> +     - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>>>> >>> +     - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>>>> >>> +- reg : Register offset and length of USB DRD PHY register set;
>>>> >>> +- clocks: Clock IDs array as required by the controller
>>>> >>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>>>> >>> +            Required clocks:
>>>> >>> +     - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>>>> >>> +            used for register access.
>>>> >>> +     - ref: PHY's reference clock (usually crystal clock), used for
>>>> >>> +            PHY operations, associated by phy name. It is used to
>>>> >>> +            determine bit values for clock settings register.
>>>> >>> +            For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>>>> >>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>>>> >>> +                   control pmu registers for power isolation.
>>>> >>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>>>> >>> +                   base.
>>> >>
>>> >> It doesn't seem right to have register offset encoded in the device tree
>>> >> like this. I think it'd be more appropriate to associate such an offset
>>> >> with the compatible string's value in the driver.
>> >
>> > Ok, it makes more sense.
>> > Just out of curiosity, what difference would this make ?
>
> Moreover, in case of Exynos5420 (and may be in future SoCs), where we
> have 2 USB DRD PHY controllers,
> we will need to have a way around to deal with two separate offsets in
> the driver for one compatible string.

It could be handled by creating a list of offsets per compatible string and
then adding some way to identify the PHY device instance. So I believe that's
not a big issue. Now you'd be encoding a list of registers offsets in the
device tree, without encoding bit layout of each register. It's unlikely that
each instance would have different bits layout, but describing individual 
registers in DT I thought is something that we're not supposed to do.
 
> Getting the offsets from DT seems a cleaner way to handle this case of
> multi controllers.

I think it's easier from the driver POV, but isn't it violating the device
tree rules ?
Anyway. I'm just pointing this minor issue in the binding as it appears
to me. The final word of course belongs to a DT binding maintainer.

Regards,

Vivek Gautam May 9, 2014, 10:51 a.m. UTC | #8

Hi Sylwester,


On Fri, May 9, 2014 at 3:43 PM, Sylwester Nawrocki
<[e-mail]> wrote:
> Hi Vivek,
>
> On 08/05/14 11:03, Vivek Gautam wrote:
>>>>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>>> >>> index b422e38..51efe4c 100644
>>>>> >>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>>> >>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>>> >>> @@ -114,3 +114,43 @@ Example:
>>>>> >>>               compatible = "samsung,exynos-sataphy-i2c";
>>>>> >>>               reg = <0x38>;
>>>>> >>>       };
>>>>> >>> +
>>>>> >>> +Samsung Exynos5 SoC series USB DRD PHY controller
>>>>> >>> +--------------------------------------------------
>>>>> >>> +
>>>>> >>> +Required properties:
>>>>> >>> +- compatible : Should be set to one of the following supported values:
>>>>> >>> +     - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>>>>> >>> +     - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>>>>> >>> +- reg : Register offset and length of USB DRD PHY register set;
>>>>> >>> +- clocks: Clock IDs array as required by the controller
>>>>> >>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>>>>> >>> +            Required clocks:
>>>>> >>> +     - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>>>>> >>> +            used for register access.
>>>>> >>> +     - ref: PHY's reference clock (usually crystal clock), used for
>>>>> >>> +            PHY operations, associated by phy name. It is used to
>>>>> >>> +            determine bit values for clock settings register.
>>>>> >>> +            For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>>>>> >>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>>>>> >>> +                   control pmu registers for power isolation.
>>>>> >>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>>>>> >>> +                   base.
>>>> >>
>>>> >> It doesn't seem right to have register offset encoded in the device tree
>>>> >> like this. I think it'd be more appropriate to associate such an offset
>>>> >> with the compatible string's value in the driver.
>>> >
>>> > Ok, it makes more sense.
>>> > Just out of curiosity, what difference would this make ?
>>
>> Moreover, in case of Exynos5420 (and may be in future SoCs), where we
>> have 2 USB DRD PHY controllers,
>> we will need to have a way around to deal with two separate offsets in
>> the driver for one compatible string.
>
> It could be handled by creating a list of offsets per compatible string and
> then adding some way to identify the PHY device instance. So I believe that's
> not a big issue.

True, we had tried to make use of 'aliases' for multiple controllers
on Exynos5420,
in earlier version V3 of this patch, to handle the pmu-register
offsets in _somewhat_ similar fashion. [1]
But then we had to drop that as per the suggestions in the mailing list.

> Now you'd be encoding a list of registers offsets in the
> device tree, without encoding bit layout of each register. It's unlikely that
> each instance would have different bits layout, but describing individual
> registers in DT I thought is something that we're not supposed to do.

Ok, so this is information to me, i was not very much aware of this.
Thanks for explaining it here.

>
>> Getting the offsets from DT seems a cleaner way to handle this case of
>> multi controllers.
>
> I think it's easier from the driver POV, but isn't it violating the device
> tree rules ?
> Anyway. I'm just pointing this minor issue in the binding as it appears
> to me. The final word of course belongs to a DT binding maintainer.

Thanks Sylwester, for pointing this out here.
Meantime, please let me know if the approach using aliases is one
possible solution for this or not ?


[1] [PATCH v3] phy: Add new Exynos5 USB 3.0 PHY driver
     https://lkml.org/lkml/2014/1/21/46

Vivek Gautam May 9, 2014, 1:55 p.m. UTC | #9

On Fri, May 9, 2014 at 4:21 PM, Vivek Gautam <[e-mail]> wrote:
> Hi Sylwester,
>
>
> On Fri, May 9, 2014 at 3:43 PM, Sylwester Nawrocki
> <[e-mail]> wrote:
>> Hi Vivek,
>>
>> On 08/05/14 11:03, Vivek Gautam wrote:
>>>>>> diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>>>> >>> index b422e38..51efe4c 100644
>>>>>> >>> --- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>>>> >>> +++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
>>>>>> >>> @@ -114,3 +114,43 @@ Example:
>>>>>> >>>               compatible = "samsung,exynos-sataphy-i2c";
>>>>>> >>>               reg = <0x38>;
>>>>>> >>>       };
>>>>>> >>> +
>>>>>> >>> +Samsung Exynos5 SoC series USB DRD PHY controller
>>>>>> >>> +--------------------------------------------------
>>>>>> >>> +
>>>>>> >>> +Required properties:
>>>>>> >>> +- compatible : Should be set to one of the following supported values:
>>>>>> >>> +     - "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
>>>>>> >>> +     - "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
>>>>>> >>> +- reg : Register offset and length of USB DRD PHY register set;
>>>>>> >>> +- clocks: Clock IDs array as required by the controller
>>>>>> >>> +- clock-names: names of clocks correseponding to IDs in the clock property;
>>>>>> >>> +            Required clocks:
>>>>>> >>> +     - phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
>>>>>> >>> +            used for register access.
>>>>>> >>> +     - ref: PHY's reference clock (usually crystal clock), used for
>>>>>> >>> +            PHY operations, associated by phy name. It is used to
>>>>>> >>> +            determine bit values for clock settings register.
>>>>>> >>> +            For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
>>>>>> >>> +- samsung,pmu-syscon: phandle for PMU system controller interface, used to
>>>>>> >>> +                   control pmu registers for power isolation.
>>>>>> >>> +- samsung,pmu-offset: phy power control register offset to pmu-system-controller
>>>>>> >>> +                   base.
>>>>> >>
>>>>> >> It doesn't seem right to have register offset encoded in the device tree
>>>>> >> like this. I think it'd be more appropriate to associate such an offset
>>>>> >> with the compatible string's value in the driver.
>>>> >
>>>> > Ok, it makes more sense.
>>>> > Just out of curiosity, what difference would this make ?
>>>
>>> Moreover, in case of Exynos5420 (and may be in future SoCs), where we
>>> have 2 USB DRD PHY controllers,
>>> we will need to have a way around to deal with two separate offsets in
>>> the driver for one compatible string.
>>
>> It could be handled by creating a list of offsets per compatible string and
>> then adding some way to identify the PHY device instance. So I believe that's
>> not a big issue.
>
> True, we had tried to make use of 'aliases' for multiple controllers
> on Exynos5420,
> in earlier version V3 of this patch, to handle the pmu-register
> offsets in _somewhat_ similar fashion. [1]
> But then we had to drop that as per the suggestions in the mailing list.
>
>> Now you'd be encoding a list of registers offsets in the
>> device tree, without encoding bit layout of each register. It's unlikely that
>> each instance would have different bits layout, but describing individual
>> registers in DT I thought is something that we're not supposed to do.
>
> Ok, so this is information to me, i was not very much aware of this.
> Thanks for explaining it here.
>
>>
>>> Getting the offsets from DT seems a cleaner way to handle this case of
>>> multi controllers.
>>
>> I think it's easier from the driver POV, but isn't it violating the device
>> tree rules ?
>> Anyway. I'm just pointing this minor issue in the binding as it appears
>> to me. The final word of course belongs to a DT binding maintainer.
>
> Thanks Sylwester, for pointing this out here.
> Meantime, please let me know if the approach using aliases is one
> possible solution for this or not ?

I shall be sending v8 patch series for this, in order to use 'aliases'
in the driver
to get the distinction between pmu-offsets.
So, v8 will give an alternative approach for getting pmu-offsets using
macro definitions from a header file.

Mark and Rob can suggest us which can be a better approach.

>
>
> [1] [PATCH v3] phy: Add new Exynos5 USB 3.0 PHY driver
>      https://lkml.org/lkml/2014/1/21/46

Patch

diff --git a/Documentation/devicetree/bindings/phy/samsung-phy.txt b/Documentation/devicetree/bindings/phy/samsung-phy.txt
index b422e38..51efe4c 100644
--- a/Documentation/devicetree/bindings/phy/samsung-phy.txt
+++ b/Documentation/devicetree/bindings/phy/samsung-phy.txt
@@ -114,3 +114,43 @@  Example:
 		compatible = "samsung,exynos-sataphy-i2c";
 		reg = <0x38>;
 	};
+
+Samsung Exynos5 SoC series USB DRD PHY controller
+--------------------------------------------------
+
+Required properties:
+- compatible : Should be set to one of the following supported values:
+	- "samsung,exynos5250-usbdrd-phy" - for exynos5250 SoC,
+	- "samsung,exynos5420-usbdrd-phy" - for exynos5420 SoC.
+- reg : Register offset and length of USB DRD PHY register set;
+- clocks: Clock IDs array as required by the controller
+- clock-names: names of clocks correseponding to IDs in the clock property;
+	       Required clocks:
+	- phy: main PHY clock (same as USB DRD controller i.e. DWC3 IP clock),
+	       used for register access.
+	- ref: PHY's reference clock (usually crystal clock), used for
+	       PHY operations, associated by phy name. It is used to
+	       determine bit values for clock settings register.
+	       For Exynos5420 this is given as 'sclk_usbphy30' in CMU.
+- samsung,pmu-syscon: phandle for PMU system controller interface, used to
+		      control pmu registers for power isolation.
+- samsung,pmu-offset: phy power control register offset to pmu-system-controller
+		      base.
+- #phy-cells : from the generic PHY bindings, must be 1;
+
+For "samsung,exynos5250-usbdrd-phy" and "samsung,exynos5420-usbdrd-phy"
+compatible PHYs, the second cell in the PHY specifier identifies the
+PHY id, which is interpreted as follows:
+  0 - UTMI+ type phy,
+  1 - PIPE3 type phy,
+
+Example:
+	usb3_phy: usbphy@12100000 {
+		compatible = "samsung,exynos5250-usbdrd-phy";
+		reg = <0x12100000 0x100>;
+		clocks = <&clock 286>, <&clock 1>;
+		clock-names = "phy", "ref";
+		samsung,pmu-syscon = <&pmu_system_controller>;
+		samsung,pmu-offset = <0x704>;
+		#phy-cells = <1>;
+	};
diff --git a/drivers/phy/Kconfig b/drivers/phy/Kconfig
index 3bb05f1..daa1707 100644
--- a/drivers/phy/Kconfig
+++ b/drivers/phy/Kconfig
@@ -159,6 +159,17 @@  config PHY_EXYNOS5250_USB2
 	  particular SoC is compiled in the driver. In case of Exynos 5250 four
 	  phys are available - device, host, HSIC0 and HSIC.
 
+config PHY_EXYNOS5_USBDRD
+	tristate "Exynos5 SoC series USB DRD PHY driver"
+	depends on ARCH_EXYNOS5 && OF
+	depends on HAS_IOMEM
+	select GENERIC_PHY
+	select MFD_SYSCON
+	help
+	  Enable USB DRD PHY support for Exynos 5 SoC series.
+	  This driver provides PHY interface for USB 3.0 DRD controller
+	  present on Exynos5 SoC series.
+
 config PHY_XGENE
 	tristate "APM X-Gene 15Gbps PHY support"
 	depends on HAS_IOMEM && OF && (ARM64 || COMPILE_TEST)
diff --git a/drivers/phy/Makefile b/drivers/phy/Makefile
index 2faf78e..333ba98 100644
--- a/drivers/phy/Makefile
+++ b/drivers/phy/Makefile
@@ -17,4 +17,5 @@  obj-$(CONFIG_PHY_SAMSUNG_USB2)		+= phy-samsung-usb2.o
 obj-$(CONFIG_PHY_EXYNOS4210_USB2)	+= phy-exynos4210-usb2.o
 obj-$(CONFIG_PHY_EXYNOS4X12_USB2)	+= phy-exynos4x12-usb2.o
 obj-$(CONFIG_PHY_EXYNOS5250_USB2)	+= phy-exynos5250-usb2.o
+obj-$(CONFIG_PHY_EXYNOS5_USBDRD)	+= phy-exynos5-usbdrd.o
 obj-$(CONFIG_PHY_XGENE)			+= phy-xgene.o
diff --git a/drivers/phy/phy-exynos5-usbdrd.c b/drivers/phy/phy-exynos5-usbdrd.c
new file mode 100644
index 0000000..bc381e3
--- /dev/null
+++ b/drivers/phy/phy-exynos5-usbdrd.c
@@ -0,0 +1,627 @@ 
+/*
+ * Samsung EXYNOS5 SoC series USB DRD PHY driver
+ *
+ * Phy provider for USB 3.0 DRD controller on Exynos5 SoC series
+ *
+ * Copyright (C) 2014 Samsung Electronics Co., Ltd.
+ * Author: Vivek Gautam <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#include <linux/clk.h>
+#include <linux/delay.h>
+#include <linux/io.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_address.h>
+#include <linux/phy/phy.h>
+#include <linux/platform_device.h>
+#include <linux/mutex.h>
+#include <linux/mfd/syscon.h>
+#include <linux/regmap.h>
+
+/* Exynos USB PHY registers */
+#define EXYNOS5_FSEL_9MHZ6		0x0
+#define EXYNOS5_FSEL_10MHZ		0x1
+#define EXYNOS5_FSEL_12MHZ		0x2
+#define EXYNOS5_FSEL_19MHZ2		0x3
+#define EXYNOS5_FSEL_20MHZ		0x4
+#define EXYNOS5_FSEL_24MHZ		0x5
+#define EXYNOS5_FSEL_50MHZ		0x7
+
+/* EXYNOS5: USB 3.0 DRD PHY registers */
+#define EXYNOS5_DRD_LINKSYSTEM			0x04
+
+#define LINKSYSTEM_FLADJ_MASK			(0x3f << 1)
+#define LINKSYSTEM_FLADJ(_x)			((_x) << 1)
+#define LINKSYSTEM_XHCI_VERSION_CONTROL		BIT(27)
+
+#define EXYNOS5_DRD_PHYUTMI			0x08
+
+#define PHYUTMI_OTGDISABLE			BIT(6)
+#define PHYUTMI_FORCESUSPEND			BIT(1)
+#define PHYUTMI_FORCESLEEP			BIT(0)
+
+#define EXYNOS5_DRD_PHYPIPE			0x0c
+
+#define EXYNOS5_DRD_PHYCLKRST			0x10
+
+#define PHYCLKRST_EN_UTMISUSPEND		BIT(31)
+
+#define PHYCLKRST_SSC_REFCLKSEL_MASK		(0xff << 23)
+#define PHYCLKRST_SSC_REFCLKSEL(_x)		((_x) << 23)
+
+#define PHYCLKRST_SSC_RANGE_MASK		(0x03 << 21)
+#define PHYCLKRST_SSC_RANGE(_x)			((_x) << 21)
+
+#define PHYCLKRST_SSC_EN			BIT(20)
+#define PHYCLKRST_REF_SSP_EN			BIT(19)
+#define PHYCLKRST_REF_CLKDIV2			BIT(18)
+
+#define PHYCLKRST_MPLL_MULTIPLIER_MASK		(0x7f << 11)
+#define PHYCLKRST_MPLL_MULTIPLIER_100MHZ_REF	(0x19 << 11)
+#define PHYCLKRST_MPLL_MULTIPLIER_50M_REF	(0x32 << 11)
+#define PHYCLKRST_MPLL_MULTIPLIER_24MHZ_REF	(0x68 << 11)
+#define PHYCLKRST_MPLL_MULTIPLIER_20MHZ_REF	(0x7d << 11)
+#define PHYCLKRST_MPLL_MULTIPLIER_19200KHZ_REF	(0x02 << 11)
+
+#define PHYCLKRST_FSEL_UTMI_MASK		(0x7 << 5)
+#define PHYCLKRST_FSEL_PIPE_MASK		(0x7 << 8)
+#define PHYCLKRST_FSEL(_x)			((_x) << 5)
+#define PHYCLKRST_FSEL_PAD_100MHZ		(0x27 << 5)
+#define PHYCLKRST_FSEL_PAD_24MHZ		(0x2a << 5)
+#define PHYCLKRST_FSEL_PAD_20MHZ		(0x31 << 5)
+#define PHYCLKRST_FSEL_PAD_19_2MHZ		(0x38 << 5)
+
+#define PHYCLKRST_RETENABLEN			BIT(4)
+
+#define PHYCLKRST_REFCLKSEL_MASK		(0x03 << 2)
+#define PHYCLKRST_REFCLKSEL_PAD_REFCLK		(0x2 << 2)
+#define PHYCLKRST_REFCLKSEL_EXT_REFCLK		(0x3 << 2)
+
+#define PHYCLKRST_PORTRESET			BIT(1)
+#define PHYCLKRST_COMMONONN			BIT(0)
+
+#define EXYNOS5_DRD_PHYREG0			0x14
+#define EXYNOS5_DRD_PHYREG1			0x18
+
+#define EXYNOS5_DRD_PHYPARAM0			0x1c
+
+#define PHYPARAM0_REF_USE_PAD			BIT(31)
+#define PHYPARAM0_REF_LOSLEVEL_MASK		(0x1f << 26)
+#define PHYPARAM0_REF_LOSLEVEL			(0x9 << 26)
+
+#define EXYNOS5_DRD_PHYPARAM1			0x20
+
+#define PHYPARAM1_PCS_TXDEEMPH_MASK		(0x1f << 0)
+#define PHYPARAM1_PCS_TXDEEMPH			(0x1c)
+
+#define EXYNOS5_DRD_PHYTERM			0x24
+
+#define EXYNOS5_DRD_PHYTEST			0x28
+
+#define PHYTEST_POWERDOWN_SSP			BIT(3)
+#define PHYTEST_POWERDOWN_HSP			BIT(2)
+
+#define EXYNOS5_DRD_PHYADP			0x2c
+
+#define EXYNOS5_DRD_PHYUTMICLKSEL		0x30
+
+#define PHYUTMICLKSEL_UTMI_CLKSEL		BIT(2)
+
+#define EXYNOS5_DRD_PHYRESUME			0x34
+#define EXYNOS5_DRD_LINKPORT			0x44
+
+/* Power isolation defined in power management unit */
+#define EXYNOS5_USBDRD_PMU_ISOL			BIT(0)
+
+#define KHZ	1000
+#define MHZ	(KHZ * KHZ)
+
+enum exynos5_usbdrd_phy_id {
+	EXYNOS5_DRDPHY_UTMI,
+	EXYNOS5_DRDPHY_PIPE3,
+	EXYNOS5_DRDPHYS_NUM,
+};
+
+struct phy_usb_instance;
+struct exynos5_usbdrd_phy;
+
+struct usbdrd_phy_config {
+	u32 id;
+	void (*phy_isol)(struct phy_usb_instance *inst, u32 on);
+	void (*phy_init)(struct exynos5_usbdrd_phy *phy_drd);
+	unsigned int (*set_refclk)(struct phy_usb_instance *inst);
+};
+
+struct exynos5_usbdrd_phy_drvdata {
+	const struct usbdrd_phy_config *phy_cfg;
+};
+
+/**
+ * struct exynos5_usbdrd_phy - driver data for USB 3.0 PHY
+ * @dev: pointer to device instance of this platform device
+ * @reg_phy: usb phy controller register memory base
+ * @clk: phy clock for register access
+ * @drv_data: pointer to SoC level driver data structure
+ * @phys[]: array for 'EXYNOS5_DRDPHYS_NUM' number of PHY
+ *	    instances each with its 'phy' and 'phy_cfg'.
+ * @extrefclk: frequency select settings when using 'separate
+ *	       reference clocks' for SS and HS operations
+ * @ref_clk: reference clock to PHY block from which PHY's
+ *	     operational clocks are derived
+ * @ref_rate: rate of above reference clock
+ */
+struct exynos5_usbdrd_phy {
+	struct device *dev;
+	void __iomem *reg_phy;
+	struct clk *clk;
+	const struct exynos5_usbdrd_phy_drvdata *drv_data;
+	struct phy_usb_instance {
+		struct phy *phy;
+		u32 index;
+		struct regmap *reg_pmu;
+		u32 pmu_offset;
+		const struct usbdrd_phy_config *phy_cfg;
+	} phys[EXYNOS5_DRDPHYS_NUM];
+	u32 extrefclk;
+	struct clk *ref_clk;
+};
+
+static inline
+struct exynos5_usbdrd_phy *to_usbdrd_phy(struct phy_usb_instance *inst)
+{
+	return container_of((inst), struct exynos5_usbdrd_phy,
+			    phys[(inst)->index]);
+}
+
+/*
+ * exynos5_rate_to_clk() converts the supplied clock rate to the value that
+ * can be written to the phy register.
+ */
+static unsigned int exynos5_rate_to_clk(unsigned long rate, u32 *reg)
+{
+	/* EXYNOS5_FSEL_MASK */
+
+	switch (rate) {
+	case 9600 * KHZ:
+		*reg = EXYNOS5_FSEL_9MHZ6;
+		break;
+	case 10 * MHZ:
+		*reg = EXYNOS5_FSEL_10MHZ;
+		break;
+	case 12 * MHZ:
+		*reg = EXYNOS5_FSEL_12MHZ;
+		break;
+	case 19200 * KHZ:
+		*reg = EXYNOS5_FSEL_19MHZ2;
+		break;
+	case 20 * MHZ:
+		*reg = EXYNOS5_FSEL_20MHZ;
+		break;
+	case 24 * MHZ:
+		*reg = EXYNOS5_FSEL_24MHZ;
+		break;
+	case 50 * MHZ:
+		*reg = EXYNOS5_FSEL_50MHZ;
+		break;
+	default:
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static void exynos5_usbdrd_phy_isol(struct phy_usb_instance *inst,
+						unsigned int on)
+{
+	unsigned int val;
+
+	if (!inst->reg_pmu)
+		return;
+
+	val = on ? 0 : EXYNOS5_USBDRD_PMU_ISOL;
+
+	regmap_update_bits(inst->reg_pmu, inst->pmu_offset,
+			   EXYNOS5_USBDRD_PMU_ISOL, val);
+}
+
+/*
+ * Sets the pipe3 phy's clk as EXTREFCLK (XXTI) which is internal clock
+ * from clock core. Further sets multiplier values and spread spectrum
+ * clock settings for SuperSpeed operations.
+ */
+static unsigned int
+exynos5_usbdrd_pipe3_set_refclk(struct phy_usb_instance *inst)
+{
+	static u32 reg;
+	struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
+
+	/* restore any previous reference clock settings */
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
+
+	/* Use EXTREFCLK as ref clock */
+	reg &= ~PHYCLKRST_REFCLKSEL_MASK;
+	reg |=	PHYCLKRST_REFCLKSEL_EXT_REFCLK;
+
+	/* FSEL settings corresponding to reference clock */
+	reg &= ~PHYCLKRST_FSEL_PIPE_MASK |
+		PHYCLKRST_MPLL_MULTIPLIER_MASK |
+		PHYCLKRST_SSC_REFCLKSEL_MASK;
+	switch (phy_drd->extrefclk) {
+	case EXYNOS5_FSEL_50MHZ:
+		reg |= (PHYCLKRST_MPLL_MULTIPLIER_50M_REF |
+			PHYCLKRST_SSC_REFCLKSEL(0x00));
+		break;
+	case EXYNOS5_FSEL_24MHZ:
+		reg |= (PHYCLKRST_MPLL_MULTIPLIER_24MHZ_REF |
+			PHYCLKRST_SSC_REFCLKSEL(0x88));
+		break;
+	case EXYNOS5_FSEL_20MHZ:
+		reg |= (PHYCLKRST_MPLL_MULTIPLIER_20MHZ_REF |
+			PHYCLKRST_SSC_REFCLKSEL(0x00));
+		break;
+	case EXYNOS5_FSEL_19MHZ2:
+		reg |= (PHYCLKRST_MPLL_MULTIPLIER_19200KHZ_REF |
+			PHYCLKRST_SSC_REFCLKSEL(0x88));
+		break;
+	default:
+		dev_dbg(phy_drd->dev, "unsupported ref clk\n");
+		break;
+	}
+
+	return reg;
+}
+
+/*
+ * Sets the utmi phy's clk as EXTREFCLK (XXTI) which is internal clock
+ * from clock core. Further sets the FSEL values for HighSpeed operations.
+ */
+static unsigned int
+exynos5_usbdrd_utmi_set_refclk(struct phy_usb_instance *inst)
+{
+	static u32 reg;
+	struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
+
+	/* restore any previous reference clock settings */
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
+
+	reg &= ~PHYCLKRST_REFCLKSEL_MASK;
+	reg |=	PHYCLKRST_REFCLKSEL_EXT_REFCLK;
+
+	reg &= ~PHYCLKRST_FSEL_UTMI_MASK |
+		PHYCLKRST_MPLL_MULTIPLIER_MASK |
+		PHYCLKRST_SSC_REFCLKSEL_MASK;
+	reg |= PHYCLKRST_FSEL(phy_drd->extrefclk);
+
+	return reg;
+}
+
+static void exynos5_usbdrd_pipe3_init(struct exynos5_usbdrd_phy *phy_drd)
+{
+	u32 reg;
+
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
+	/* Set Tx De-Emphasis level */
+	reg &= ~PHYPARAM1_PCS_TXDEEMPH_MASK;
+	reg |=	PHYPARAM1_PCS_TXDEEMPH;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
+
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
+	reg &= ~PHYTEST_POWERDOWN_SSP;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
+}
+
+static void exynos5_usbdrd_utmi_init(struct exynos5_usbdrd_phy *phy_drd)
+{
+	u32 reg;
+
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
+	/* Set Loss-of-Signal Detector sensitivity */
+	reg &= ~PHYPARAM0_REF_LOSLEVEL_MASK;
+	reg |=	PHYPARAM0_REF_LOSLEVEL;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
+
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
+	/* Set Tx De-Emphasis level */
+	reg &= ~PHYPARAM1_PCS_TXDEEMPH_MASK;
+	reg |=	PHYPARAM1_PCS_TXDEEMPH;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM1);
+
+	/* UTMI Power Control */
+	writel(PHYUTMI_OTGDISABLE, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMI);
+
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
+	reg &= ~PHYTEST_POWERDOWN_HSP;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
+}
+
+static int exynos5_usbdrd_phy_init(struct phy *phy)
+{
+	int ret;
+	u32 reg;
+	struct phy_usb_instance *inst = phy_get_drvdata(phy);
+	struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
+
+	ret = clk_prepare_enable(phy_drd->clk);
+	if (ret)
+		return ret;
+
+	/* Reset USB 3.0 PHY */
+	writel(0x0, phy_drd->reg_phy + EXYNOS5_DRD_PHYREG0);
+	writel(0x0, phy_drd->reg_phy + EXYNOS5_DRD_PHYRESUME);
+
+	/*
+	 * Setting the Frame length Adj value[6:1] to default 0x20
+	 * See xHCI 1.0 spec, 5.2.4
+	 */
+	reg =	LINKSYSTEM_XHCI_VERSION_CONTROL |
+		LINKSYSTEM_FLADJ(0x20);
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_LINKSYSTEM);
+
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
+	/* Select PHY CLK source */
+	reg &= ~PHYPARAM0_REF_USE_PAD;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYPARAM0);
+
+	/* This bit must be set for both HS and SS operations */
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMICLKSEL);
+	reg |= PHYUTMICLKSEL_UTMI_CLKSEL;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMICLKSEL);
+
+	/* UTMI or PIPE3 specific init */
+	inst->phy_cfg->phy_init(phy_drd);
+
+	/* reference clock settings */
+	reg = inst->phy_cfg->set_refclk(inst);
+
+		/* Digital power supply in normal operating mode */
+	reg |=	PHYCLKRST_RETENABLEN |
+		/* Enable ref clock for SS function */
+		PHYCLKRST_REF_SSP_EN |
+		/* Enable spread spectrum */
+		PHYCLKRST_SSC_EN |
+		/* Power down HS Bias and PLL blocks in suspend mode */
+		PHYCLKRST_COMMONONN |
+		/* Reset the port */
+		PHYCLKRST_PORTRESET;
+
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
+
+	udelay(10);
+
+	reg &= ~PHYCLKRST_PORTRESET;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
+
+	clk_disable_unprepare(phy_drd->clk);
+
+	return 0;
+}
+
+static int exynos5_usbdrd_phy_exit(struct phy *phy)
+{
+	int ret;
+	u32 reg;
+	struct phy_usb_instance *inst = phy_get_drvdata(phy);
+	struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
+
+	ret = clk_prepare_enable(phy_drd->clk);
+	if (ret)
+		return ret;
+
+	reg =	PHYUTMI_OTGDISABLE |
+		PHYUTMI_FORCESUSPEND |
+		PHYUTMI_FORCESLEEP;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYUTMI);
+
+	/* Resetting the PHYCLKRST enable bits to reduce leakage current */
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
+	reg &= ~(PHYCLKRST_REF_SSP_EN |
+		 PHYCLKRST_SSC_EN |
+		 PHYCLKRST_COMMONONN);
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYCLKRST);
+
+	/* Control PHYTEST to remove leakage current */
+	reg = readl(phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
+	reg |=	PHYTEST_POWERDOWN_SSP |
+		PHYTEST_POWERDOWN_HSP;
+	writel(reg, phy_drd->reg_phy + EXYNOS5_DRD_PHYTEST);
+
+	clk_disable_unprepare(phy_drd->clk);
+
+	return 0;
+}
+
+static int exynos5_usbdrd_phy_power_on(struct phy *phy)
+{
+	struct phy_usb_instance *inst = phy_get_drvdata(phy);
+	struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
+
+	dev_dbg(phy_drd->dev, "Request to power_on usbdrd_phy phy\n");
+
+	clk_prepare_enable(phy_drd->ref_clk);
+
+	/* Power-on PHY*/
+	inst->phy_cfg->phy_isol(inst, 0);
+
+	return 0;
+}
+
+static int exynos5_usbdrd_phy_power_off(struct phy *phy)
+{
+	struct phy_usb_instance *inst = phy_get_drvdata(phy);
+	struct exynos5_usbdrd_phy *phy_drd = to_usbdrd_phy(inst);
+
+	dev_dbg(phy_drd->dev, "Request to power_off usbdrd_phy phy\n");
+
+	/* Power-off the PHY */
+	inst->phy_cfg->phy_isol(inst, 1);
+
+	clk_disable_unprepare(phy_drd->ref_clk);
+
+	return 0;
+}
+
+static struct phy *exynos5_usbdrd_phy_xlate(struct device *dev,
+					struct of_phandle_args *args)
+{
+	struct exynos5_usbdrd_phy *phy_drd = dev_get_drvdata(dev);
+
+	if (WARN_ON(args->args[0] > EXYNOS5_DRDPHYS_NUM))
+		return ERR_PTR(-ENODEV);
+
+	return phy_drd->phys[args->args[0]].phy;
+}
+
+static struct phy_ops exynos5_usbdrd_phy_ops = {
+	.init		= exynos5_usbdrd_phy_init,
+	.exit		= exynos5_usbdrd_phy_exit,
+	.power_on	= exynos5_usbdrd_phy_power_on,
+	.power_off	= exynos5_usbdrd_phy_power_off,
+	.owner		= THIS_MODULE,
+};
+
+const struct usbdrd_phy_config exynos5_usbdrd_phy_cfg[] = {
+	{
+		.id		= EXYNOS5_DRDPHY_UTMI,
+		.phy_isol	= exynos5_usbdrd_phy_isol,
+		.phy_init	= exynos5_usbdrd_utmi_init,
+		.set_refclk	= exynos5_usbdrd_utmi_set_refclk,
+	},
+	{
+		.id		= EXYNOS5_DRDPHY_PIPE3,
+		.phy_isol	= exynos5_usbdrd_phy_isol,
+		.phy_init	= exynos5_usbdrd_pipe3_init,
+		.set_refclk	= exynos5_usbdrd_pipe3_set_refclk,
+	},
+};
+
+const struct exynos5_usbdrd_phy_drvdata exynos5420_usbdrd_phy = {
+	.phy_cfg		= exynos5_usbdrd_phy_cfg,
+};
+
+const struct exynos5_usbdrd_phy_drvdata exynos5250_usbdrd_phy = {
+	.phy_cfg		= exynos5_usbdrd_phy_cfg,
+};
+
+static const struct of_device_id exynos5_usbdrd_phy_of_match[] = {
+	{
+		.compatible = "samsung,exynos5250-usbdrd-phy",
+		.data = &exynos5250_usbdrd_phy
+	}, {
+		.compatible = "samsung,exynos5420-usbdrd-phy",
+		.data = &exynos5420_usbdrd_phy
+	},
+	{ },
+};
+
+static int exynos5_usbdrd_phy_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct device_node *node = dev->of_node;
+	struct exynos5_usbdrd_phy *phy_drd;
+	struct phy_provider *phy_provider;
+	struct resource *res;
+	const struct of_device_id *match;
+	const struct exynos5_usbdrd_phy_drvdata *drv_data;
+	struct regmap *reg_pmu;
+	u32 pmu_offset;
+	unsigned long ref_rate;
+	int i, ret;
+
+	phy_drd = devm_kzalloc(dev, sizeof(*phy_drd), GFP_KERNEL);
+	if (!phy_drd)
+		return -ENOMEM;
+
+	dev_set_drvdata(dev, phy_drd);
+	phy_drd->dev = dev;
+
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	phy_drd->reg_phy = devm_ioremap_resource(dev, res);
+	if (IS_ERR(phy_drd->reg_phy))
+		return PTR_ERR(phy_drd->reg_phy);
+
+	match = of_match_node(exynos5_usbdrd_phy_of_match, pdev->dev.of_node);
+
+	drv_data = match->data;
+	phy_drd->drv_data = drv_data;
+
+	phy_drd->clk = devm_clk_get(dev, "phy");
+	if (IS_ERR(phy_drd->clk)) {
+		dev_err(dev, "Failed to get clock of phy controller\n");
+		return PTR_ERR(phy_drd->clk);
+	}
+
+	phy_drd->ref_clk = devm_clk_get(dev, "ref");
+	if (IS_ERR(phy_drd->ref_clk)) {
+		dev_err(dev, "Failed to get reference clock of usbdrd phy\n");
+		return PTR_ERR(phy_drd->ref_clk);
+	}
+	ref_rate = clk_get_rate(phy_drd->ref_clk);
+
+	ret = exynos5_rate_to_clk(ref_rate, &phy_drd->extrefclk);
+	if (ret) {
+		dev_err(phy_drd->dev, "Clock rate (%ld) not supported\n",
+			ref_rate);
+		return ret;
+	}
+
+	reg_pmu = syscon_regmap_lookup_by_phandle(dev->of_node,
+						   "samsung,pmu-syscon");
+	if (IS_ERR(reg_pmu)) {
+		dev_err(dev, "Failed to map PMU register (via syscon)\n");
+		return PTR_ERR(reg_pmu);
+	}
+
+	ret = of_property_read_u32(node, "samsung,pmu-offset", &pmu_offset);
+	if (ret) {
+		dev_err(dev, "Missing pmu-offset for phy isolation\n");
+		return ret;
+	}
+
+	dev_vdbg(dev, "Creating usbdrd_phy phy\n");
+
+	for (i = 0; i < EXYNOS5_DRDPHYS_NUM; i++) {
+		struct phy *phy = devm_phy_create(dev, &exynos5_usbdrd_phy_ops,
+						  NULL);
+		if (IS_ERR(phy)) {
+			dev_err(dev, "Failed to create usbdrd_phy phy\n");
+			return PTR_ERR(phy);
+		}
+
+		phy_drd->phys[i].phy = phy;
+		phy_drd->phys[i].index = i;
+		phy_drd->phys[i].reg_pmu = reg_pmu;
+		phy_drd->phys[i].pmu_offset = pmu_offset;
+		phy_drd->phys[i].phy_cfg = &drv_data->phy_cfg[i];
+		phy_set_drvdata(phy, &phy_drd->phys[i]);
+	}
+
+	phy_provider = devm_of_phy_provider_register(dev,
+						     exynos5_usbdrd_phy_xlate);
+	if (IS_ERR(phy_provider)) {
+		dev_err(phy_drd->dev, "Failed to register phy provider\n");
+		return PTR_ERR(phy_provider);
+	}
+
+	return 0;
+}
+
+static struct platform_driver exynos5_usb3drd_phy = {
+	.probe	= exynos5_usbdrd_phy_probe,
+	.driver = {
+		.of_match_table	= exynos5_usbdrd_phy_of_match,
+		.name		= "exynos5_usb3drd_phy",
+		.owner		= THIS_MODULE,
+	}
+};
+
+module_platform_driver(exynos5_usb3drd_phy);
+MODULE_DESCRIPTION("Samsung EXYNOS5 SoCs USB 3.0 DRD controller PHY driver");
+MODULE_AUTHOR("Vivek Gautam <[e-mail]>");
+MODULE_LICENSE("GPL v2");
+MODULE_ALIAS("platform:exynos5_usb3drd_phy");