On Mon, Feb 14, 2022 at 04:32:41PM +0800, Vincent Shih wrote:
> Add driver for ehci in Sunplus SP7021
The binding looked odd with 0 and 1 in the compatible strings. That's
rarely to never correct, so I looked here to see how it is used.
>
> Signed-off-by: Vincent Shih <vincent.sunplus@xxxxxxxxx>
> ---
> MAINTAINERS | 6 +
> drivers/usb/host/Kconfig | 11 +
> drivers/usb/host/Makefile | 1 +
> drivers/usb/host/ehci-sunplus.c | 527 ++++++++++++++++++++++++++++++++++++++++
> 4 files changed, 545 insertions(+)
> create mode 100644 drivers/usb/host/ehci-sunplus.c
> diff --git a/drivers/usb/host/ehci-sunplus.c b/drivers/usb/host/ehci-sunplus.c
> new file mode 100644
> index 0000000..007923a
> --- /dev/null
> +++ b/drivers/usb/host/ehci-sunplus.c
> @@ -0,0 +1,527 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +/*
> + * The EHCI driver for Sunplus SP7021
> + *
> + * Copyright (C) 2019 Sunplus Technology Inc., All rights reserved.
> + */
> +
> +#include <linux/bitfield.h>
> +#include <linux/clk.h>
> +#include <linux/delay.h>
> +#include <linux/io.h>
> +#include <linux/module.h>
> +#include <linux/nvmem-consumer.h>
> +#include <linux/of.h>
> +#include <linux/of_platform.h>
> +#include <linux/platform_device.h>
> +#include <linux/usb.h>
> +#include <linux/usb/ehci_pdriver.h>
> +#include <linux/usb/hcd.h>
> +
> +#include "ehci.h"
> +
> +#define RF_MASK_V(mask, val) (((mask) << 16) | (val))
> +#define RF_MASK_V_CLR(mask) (((mask) << 16) | 0)
> +
> +#define USB_PORT0_ID 0
> +#define USB_PORT1_ID 1
> +#define USB_PORT_NUM 2
> +
> +#define MASK_BITS 0xffff
> +
> +#define OTP_DISC_LEVEL_DEFAULT 0xd
> +#define OTP_DISC_LEVEL_BITS 0x5
> +
> +// GROUP 140/150 UPHY0/UPHY1
> +#define CONFIG1 0x4
> +#define J_HS_TX_PWRSAV BIT(5)
> +#define CONFIG3 0xc
> +#define J_FORCE_DISC_ON BIT(5)
> +#define J_DEBUG_CTRL_ADDR_MACRO BIT(0)
> +#define CONFIG7 0x1c
> +#define J_DISC 0X1f
> +#define CONFIG9 0x24
> +#define J_ECO_PATH BIT(6)
> +#define CONFIG16 0x40
> +#define J_TBCWAIT_MASK GENMASK(6, 5)
> +#define J_TBCWAIT_1P1_MS FIELD_PREP(J_TBCWAIT_MASK, 0)
> +#define J_TVDM_SRC_DIS_MASK GENMASK(4, 3)
> +#define J_TVDM_SRC_DIS_8P2_MS FIELD_PREP(J_TVDM_SRC_DIS_MASK, 3)
> +#define J_TVDM_SRC_EN_MASK GENMASK(2, 1)
> +#define J_TVDM_SRC_EN_1P6_MS FIELD_PREP(J_TVDM_SRC_EN_MASK, 0)
> +#define J_BC_EN BIT(0)
> +#define CONFIG17 0x44
> +#define IBG_TRIM0_MASK GENMASK(7, 5)
> +#define IBG_TRIM0_SSLVHT FIELD_PREP(IBG_TRIM0_MASK, 4)
> +#define J_VDATREE_TRIM_MASK GENMASK(4, 1)
> +#define J_VDATREE_TRIM_DEFAULT FIELD_PREP(J_VDATREE_TRIM_MASK, 9)
> +#define CONFIG23 0x5c
> +#define PROB_MASK GENMASK(5, 3)
> +#define PROB FIELD_PREP(PROB_MASK, 7)
> +
> +// GROUP 0 MOON 0
> +#define HARDWARE_RESET_CONTROL2 0x5c
> +#define UPHY1_RESET BIT(14)
> +#define UPHY0_RESET BIT(13)
> +#define USBC1_RESET BIT(11)
> +#define USBC0_RESET BIT(10)
> +
> +// GROUP 4 MOON 4
> +#define USBC_CONTROL 0x44
> +#define MO1_USBC1_USB0_SEL BIT(13)
> +#define MO1_USBC1_USB0_CTRL BIT(12)
> +#define MO1_USBC0_USB0_SEL BIT(5)
> +#define MO1_USBC0_USB0_CTRL BIT(4)
> +#define UPHY0_CONTROL0 0x48
> +#define UPHY0_CONTROL1 0x4c
> +#define UPHY0_CONTROL2 0x50
> +#define MO1_UPHY0_RX_CLK_SEL BIT(6)
> +#define UPHY0_CONTROL3 0x54
> +#define MO1_UPHY0_PLL_POWER_OFF_SEL BIT(7)
> +#define MO1_UPHY0_PLL_POWER_OFF BIT(3)
> +#define UPHY1_CONTROL0 0x58
> +#define UPHY1_CONTROL1 0x5c
> +#define UPHY1_CONTROL2 0x60
> +#define MO1_UPHY1_RX_CLK_SEL BIT(6)
> +#define UPHY1_CONTROL3 0x64
> +#define MO1_UPHY1_PLL_POWER_OFF_SEL BIT(7)
> +#define MO1_UPHY1_PLL_POWER_OFF BIT(3)
> +
> +#define hcd_to_sp_ehci_priv(h) \
> + ((struct sp_ehci_priv *)hcd_to_ehci(h)->priv)
> +
> +struct sp_ehci_priv {
> + struct resource *uphy_res_mem[USB_PORT_NUM];
> + struct resource *moon0_res_mem;
> + struct resource *moon4_res_mem;
> + struct clk *uphy_clk[USB_PORT_NUM];
> + struct clk *ehci_clk[USB_PORT_NUM];
> + void __iomem *uphy_regs[USB_PORT_NUM];
> + void __iomem *moon0_regs;
> + void __iomem *moon4_regs;
> +};
> +
> +static int ehci_sunplus_reset(struct usb_hcd *hcd)
> +{
> + struct platform_device *pdev = to_platform_device(hcd->self.controller);
> + struct usb_ehci_pdata *pdata = pdev->dev.platform_data;
> + struct ehci_hcd *ehci = hcd_to_ehci(hcd);
> + int retval;
> +
> + hcd->has_tt = pdata->has_tt;
> + ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
> + ehci->big_endian_desc = pdata->big_endian_desc;
> + ehci->big_endian_mmio = pdata->big_endian_mmio;
> +
> + ehci->caps = hcd->regs + pdata->caps_offset;
> + retval = ehci_setup(hcd);
> +
> + return retval;
> +}
> +
> +static struct hc_driver __read_mostly ehci_sunplus_driver;
> +
> +static const struct ehci_driver_overrides ehci_sunplus_overrides __initconst = {
> + .reset = ehci_sunplus_reset,
> + .extra_priv_size = sizeof(struct sp_ehci_priv),
> +};
> +
> +static int uphy0_init(struct platform_device *pdev, struct sp_ehci_priv *sp_priv)
> +{
> + struct nvmem_cell *cell;
> + char *disc_name = "disc_vol";
> + ssize_t otp_l = 0;
> + char *otp_v;
> + int port = pdev->id - 1;
> + u32 val, set, pll_pwr_on, pll_pwr_off;
> +
> + /* Default value modification */
> + writel(RF_MASK_V(MASK_BITS, 0x4002), sp_priv->moon4_regs + UPHY0_CONTROL0);
> + writel(RF_MASK_V(MASK_BITS, 0x8747), sp_priv->moon4_regs + UPHY0_CONTROL1);
> +
> + /* PLL power off/on twice */
> + pll_pwr_off = (readl(sp_priv->moon4_regs + UPHY0_CONTROL3) & ~MASK_BITS)
> + | MO1_UPHY0_PLL_POWER_OFF_SEL | MO1_UPHY0_PLL_POWER_OFF;
> + pll_pwr_on = (readl(sp_priv->moon4_regs + UPHY0_CONTROL3) & ~MASK_BITS)
> + | MO1_UPHY0_PLL_POWER_OFF_SEL;
> +
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_off), sp_priv->moon4_regs + UPHY0_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_on), sp_priv->moon4_regs + UPHY0_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_off), sp_priv->moon4_regs + UPHY0_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_on), sp_priv->moon4_regs + UPHY0_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, 0x0), sp_priv->moon4_regs + UPHY0_CONTROL3);
> +
> + /* reset UPHY0 */
> + writel(RF_MASK_V(UPHY0_RESET, UPHY0_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> + writel(RF_MASK_V_CLR(UPHY0_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> + mdelay(1);
> +
> + /* board uphy 0 internal register modification for tid certification */
> + cell = nvmem_cell_get(&pdev->dev, disc_name);
> + if (IS_ERR_OR_NULL(cell)) {
> + if (PTR_ERR(cell) == -EPROBE_DEFER)
> + return -EPROBE_DEFER;
> + }
> +
> + otp_v = nvmem_cell_read(cell, &otp_l);
> + nvmem_cell_put(cell);
> +
> + if (otp_v)
> + set = ((*otp_v >> OTP_DISC_LEVEL_BITS) |
> + (*(otp_v + 1) << (sizeof(char) * 8 - OTP_DISC_LEVEL_BITS))) & J_DISC;
> +
> + if (!otp_v || set == 0)
> + set = OTP_DISC_LEVEL_DEFAULT;
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG7);
> + val = (val & ~J_DISC) | set;
> + writel(val, sp_priv->uphy_regs[port] + CONFIG7);
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG9);
> + val &= ~(J_ECO_PATH);
> + writel(val, sp_priv->uphy_regs[port] + CONFIG9);
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG1);
> + val &= ~(J_HS_TX_PWRSAV);
> + writel(val, sp_priv->uphy_regs[port] + CONFIG1);
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG23);
> + val = (val & ~PROB) | PROB;
> + writel(val, sp_priv->uphy_regs[port] + CONFIG23);
> +
> + /* USBC 0 reset */
> + writel(RF_MASK_V(USBC0_RESET, USBC0_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> + writel(RF_MASK_V_CLR(USBC0_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> +
> + /* port 0 uphy clk fix */
> + writel(RF_MASK_V(MO1_UPHY0_RX_CLK_SEL, MO1_UPHY0_RX_CLK_SEL),
> + sp_priv->moon4_regs + UPHY0_CONTROL2);
> +
> + /* switch to host */
> + writel(RF_MASK_V(MO1_USBC0_USB0_SEL | MO1_USBC0_USB0_CTRL,
> + MO1_USBC0_USB0_SEL | MO1_USBC0_USB0_CTRL),
> + sp_priv->moon4_regs + USBC_CONTROL);
> +
> + /* battery charger */
> + writel(J_TBCWAIT_1P1_MS | J_TVDM_SRC_DIS_8P2_MS | J_TVDM_SRC_EN_1P6_MS | J_BC_EN,
> + sp_priv->uphy_regs[port] + CONFIG16);
> + writel(IBG_TRIM0_SSLVHT | J_VDATREE_TRIM_DEFAULT, sp_priv->uphy_regs[port] + CONFIG17);
> + writel(J_FORCE_DISC_ON | J_DEBUG_CTRL_ADDR_MACRO, sp_priv->uphy_regs[port] + CONFIG3);
> +
> + return 0;
> +}
> +
> +static int uphy1_init(struct platform_device *pdev, struct sp_ehci_priv *sp_priv)
> +{
> + struct nvmem_cell *cell;
> + char *disc_name = "disc_vol";
> + ssize_t otp_l = 0;
> + char *otp_v;
> + int port = pdev->id - 1;
> + u32 val, set, pll_pwr_on, pll_pwr_off;
> +
> + /* Default value modification */
> + writel(RF_MASK_V(MASK_BITS, 0x4002), sp_priv->moon4_regs + UPHY0_CONTROL0);
> + writel(RF_MASK_V(MASK_BITS, 0x8747), sp_priv->moon4_regs + UPHY0_CONTROL1);
> +
> + /* PLL power off/on twice */
> + pll_pwr_off = (readl(sp_priv->moon4_regs + UPHY1_CONTROL3) & ~MASK_BITS)
> + | MO1_UPHY1_PLL_POWER_OFF_SEL | MO1_UPHY1_PLL_POWER_OFF;
> + pll_pwr_on = (readl(sp_priv->moon4_regs + UPHY1_CONTROL3) & ~MASK_BITS)
> + | MO1_UPHY1_PLL_POWER_OFF_SEL;
> +
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_off), sp_priv->moon4_regs + UPHY1_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_on), sp_priv->moon4_regs + UPHY1_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_off), sp_priv->moon4_regs + UPHY1_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, pll_pwr_on), sp_priv->moon4_regs + UPHY1_CONTROL3);
> + mdelay(1);
> + writel(RF_MASK_V(MASK_BITS, 0x0), sp_priv->moon4_regs + UPHY1_CONTROL3);
> +
> + /* reset UPHY1 */
> + writel(RF_MASK_V(UPHY1_RESET, UPHY1_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> + writel(RF_MASK_V_CLR(UPHY1_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> + mdelay(1);
> +
> + /* board uphy 1 internal register modification for tid certification */
> + cell = nvmem_cell_get(&pdev->dev, disc_name);
> + if (IS_ERR_OR_NULL(cell)) {
> + if (PTR_ERR(cell) == -EPROBE_DEFER)
> + return -EPROBE_DEFER;
> + }
> +
> + otp_v = nvmem_cell_read(cell, &otp_l);
> + nvmem_cell_put(cell);
> +
> + if (otp_v)
> + set = ((*otp_v >> OTP_DISC_LEVEL_BITS) |
> + (*(otp_v + 1) << (sizeof(char) * 8 - OTP_DISC_LEVEL_BITS))) & J_DISC;
> +
> + if (!otp_v || set == 0)
> + set = OTP_DISC_LEVEL_DEFAULT;
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG7);
> + val = (val & ~J_DISC) | set;
> + writel(val, sp_priv->uphy_regs[port] + CONFIG7);
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG9);
> + val &= ~(J_ECO_PATH);
> + writel(val, sp_priv->uphy_regs[port] + CONFIG9);
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG1);
> + val &= ~(J_HS_TX_PWRSAV);
> + writel(val, sp_priv->uphy_regs[port] + CONFIG1);
> +
> + val = readl(sp_priv->uphy_regs[port] + CONFIG23);
> + val = (val & ~PROB) | PROB;
> + writel(val, sp_priv->uphy_regs[port] + CONFIG23);
> +
> + /* USBC 1 reset */
> + writel(RF_MASK_V(USBC1_RESET, USBC1_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> + writel(RF_MASK_V_CLR(USBC1_RESET), sp_priv->moon0_regs + HARDWARE_RESET_CONTROL2);
> +
> + /* port 1 uphy clk fix */
> + writel(RF_MASK_V(MO1_UPHY1_RX_CLK_SEL, MO1_UPHY1_RX_CLK_SEL),
> + sp_priv->moon4_regs + UPHY1_CONTROL2);
> +
> + /* switch to host */
> + writel(RF_MASK_V(MO1_USBC1_USB0_SEL | MO1_USBC1_USB0_CTRL,
> + MO1_USBC1_USB0_SEL | MO1_USBC1_USB0_CTRL),
> + sp_priv->moon4_regs + USBC_CONTROL);
> +
> + /* battery charger */
> + writel(J_TBCWAIT_1P1_MS | J_TVDM_SRC_DIS_8P2_MS | J_TVDM_SRC_EN_1P6_MS | J_BC_EN,
> + sp_priv->uphy_regs[port] + CONFIG16);
> + writel(IBG_TRIM0_SSLVHT | J_VDATREE_TRIM_DEFAULT, sp_priv->uphy_regs[port] + CONFIG17);
> + writel(J_FORCE_DISC_ON | J_DEBUG_CTRL_ADDR_MACRO, sp_priv->uphy_regs[port] + CONFIG3);
> +
> + return 0;
> +}
> +
> +static struct usb_ehci_pdata usb_ehci_pdata = {
> +};
> +
> +static int ehci_sunplus_probe(struct platform_device *pdev)
> +{
> + struct device *dev = &pdev->dev;
> + struct sp_ehci_priv *sp_priv;
> + struct resource *res_mem;
> + struct usb_hcd *hcd;
> + int port, irq, err;
> +
> + if (usb_disabled())
> + return -ENODEV;
> +
> + if (of_device_is_compatible(pdev->dev.of_node, "sunplus,sp7021-usb-ehci0"))
> + pdev->id = 1;
> + else if (of_device_is_compatible(pdev->dev.of_node, "sunplus,sp7021-usb-ehci1"))
> + pdev->id = 2;
I don't think drivers are free to set 'id'. It's already been set long
before probe happens. Different compatibles is not how you distinguish
different instances of the same block. It seems that perhaps you should
be using the phy binding to handle the difference in uphy registers.
That seems to be the only difference.
> +
> + port = pdev->id - 1;
> + pdev->dev.platform_data = &usb_ehci_pdata;
Drivers don't set platform_data either. Plus there is no point here
since every instance gets the same data.
> +
> + /* initialize hcd */
> + hcd = usb_create_hcd(&ehci_sunplus_driver, dev, dev_name(dev));
> + if (!hcd)
> + return -ENOMEM;
> +
> + platform_set_drvdata(pdev, hcd);
> + sp_priv = hcd_to_sp_ehci_priv(hcd);
> +
> + /* initialize uphy0/uphy1 */
> + sp_priv->uphy_res_mem[port] = platform_get_resource(pdev, IORESOURCE_MEM, 1);
> + sp_priv->uphy_regs[port] = ioremap(sp_priv->uphy_res_mem[port]->start,
> + resource_size(sp_priv->uphy_res_mem[port]));
sp_priv is per instance, and there's only 1 port for each instance. So
why do you have an array here?
> +
> + if (IS_ERR(sp_priv->uphy_regs[port]))
> + return PTR_ERR(sp_priv->uphy_regs[port]);
> +
> + sp_priv->moon0_res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 2);
> + sp_priv->moon0_regs = devm_ioremap(dev, sp_priv->moon0_res_mem->start,
> + resource_size(sp_priv->moon0_res_mem));
> + if (IS_ERR(sp_priv->moon0_regs))
> + return PTR_ERR(sp_priv->moon0_regs);
> +
> + sp_priv->moon4_res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 3);
> + sp_priv->moon4_regs = devm_ioremap(dev, sp_priv->moon4_res_mem->start,
> + resource_size(sp_priv->moon4_res_mem));
> + if (IS_ERR(sp_priv->moon4_regs))
> + return PTR_ERR(sp_priv->moon4_regs);
> +
> + if (port == USB_PORT0_ID)
> + sp_priv->uphy_clk[USB_PORT0_ID] = devm_clk_get(dev, "USB2_UPHY0");
> + else if (port == USB_PORT1_ID)
> + sp_priv->uphy_clk[USB_PORT1_ID] = devm_clk_get(dev, "USB2_UPHY1");
This looks wrong too. There's only 1 clock per instance and the name
should be the same.
The clock for the phy goes with the phy node.
> +
> + if (IS_ERR(sp_priv->uphy_clk[port])) {
> + err = PTR_ERR(sp_priv->uphy_clk[port]);
> + goto err_put_hcd;
> + }
> +
> + err = clk_prepare_enable(sp_priv->uphy_clk[port]);
> + if (err)
> + goto err_put_hcd;
> +
> + if (port == USB_PORT0_ID)
> + err = uphy0_init(pdev, sp_priv);
> + else if (port == USB_PORT1_ID)
> + err = uphy1_init(pdev, sp_priv);
> +
> + if (err == -EPROBE_DEFER)
> + goto err_uphy_clk;
> +
> + /* ehci */
> + res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> + hcd->regs = devm_ioremap_resource(dev, res_mem);
> + if (IS_ERR(hcd->regs)) {
> + err = PTR_ERR(hcd->regs);
> + goto err_uphy_clk;
> + }
> +
> + hcd->rsrc_start = res_mem->start;
> + hcd->rsrc_len = resource_size(res_mem);
> +
> + irq = platform_get_irq(pdev, 0);
> + if (irq < 0) {
> + err = irq;
> + goto err_uphy_clk;
> + }
> + dev_dbg(&pdev->dev, "ehci_id:%d,irq:%d\n", port, irq);
> +
> + if (port == USB_PORT0_ID)
> + sp_priv->ehci_clk[port] = devm_clk_get(dev, "USB2_USBC0");
> + else if (port == USB_PORT1_ID)
> + sp_priv->ehci_clk[port] = devm_clk_get(dev, "USB2_USBC1");
This looks wrong too. There's only 1 clock per instance and the name
should be the same.
> +
> + if (IS_ERR(sp_priv->ehci_clk[port])) {
> + err = PTR_ERR(sp_priv->ehci_clk[port]);
> + goto err_uphy_clk;
> + }
> +
> + err = clk_prepare_enable(sp_priv->ehci_clk[port]);
> + if (err)
> + goto err_uphy_clk;
> +
> + err = usb_add_hcd(hcd, irq, IRQF_SHARED);
> + if (err)
> + goto err_ehci_clk;
> +
> + dev_dbg(dev, "hcd_irq:%d,%d\n", hcd->irq, irq);
> +
> + return err;
> +
> +err_ehci_clk:
> + clk_disable_unprepare(sp_priv->ehci_clk[port]);
> +err_uphy_clk:
> + clk_disable_unprepare(sp_priv->uphy_clk[port]);
> +err_put_hcd:
> + usb_put_hcd(hcd);
> +
> + return err;
> +}
