[PATCH v1 0/4] usb: ehci: Conversion of ehci-mxs driver to support DM (i.MX28)

This patch series focuses on converting ehci-mxs driver to support DM and work with i.MX28 (SoC). The XEA board has been used to test the proposed code with USB pen drive.
Lukasz Majewski (4): usb: Modify Kconfig of the USB_EHCI_MXS to use this driver with imx28 usb: ehci: Refactor the ehci_mxs_toggle_clock function to be reused with DM usb: ehci: Move common mxs code to separate functions (ehci_hcd_{stop|start}) usb: ehci: dm: Convert i.MX28 ehci code to driver model
drivers/usb/host/Kconfig | 7 +- drivers/usb/host/ehci-mxs.c | 328 ++++++++++++++++++++++++++++-------- 2 files changed, 266 insertions(+), 69 deletions(-)

The ehci-mxs driver can be also used with imx28 SoC, not only imx23.
Signed-off-by: Lukasz Majewski lukma@denx.de ---
drivers/usb/host/Kconfig | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig index ccecb5a3b08..7743c962cfa 100644 --- a/drivers/usb/host/Kconfig +++ b/drivers/usb/host/Kconfig @@ -180,12 +180,13 @@ config USB_EHCI_MX7 Enables support for the on-chip EHCI controller on i.MX7 SoCs.
config USB_EHCI_MXS - bool "Support for i.MX23 EHCI USB controller" - depends on ARCH_MX23 + bool "Support for i.MX23/i.MX28 EHCI USB controller" + depends on ARCH_MX23 || ARCH_MX28 default y select USB_EHCI_IS_TDI help - Enables support for the on-chip EHCI controller on i.MX23 SoCs. + Enables support for the on-chip EHCI controller on i.MX23 and + i.MX28 SoCs.
config USB_EHCI_OMAP bool "Support for OMAP3+ on-chip EHCI USB controller"

This function is going to be reused with the CONFIG_DM_USB enabled in the imx28 mxs USB ehci driver.
No functional changes introduced.
Signed-off-by: Lukasz Majewski lukma@denx.de ---
drivers/usb/host/ehci-mxs.c | 42 ++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/drivers/usb/host/ehci-mxs.c b/drivers/usb/host/ehci-mxs.c index 824c620e638..a9d5d58970a 100644 --- a/drivers/usb/host/ehci-mxs.c +++ b/drivers/usb/host/ehci-mxs.c @@ -29,6 +29,27 @@ struct ehci_mxs_port { uint32_t gate_bits; };
+static int ehci_mxs_toggle_clock(const struct ehci_mxs_port *port, int enable) +{ + struct mxs_register_32 *digctl_ctrl = + (struct mxs_register_32 *)HW_DIGCTL_CTRL; + int pll_offset, dig_offset; + + if (enable) { + pll_offset = offsetof(struct mxs_register_32, reg_set); + dig_offset = offsetof(struct mxs_register_32, reg_clr); + writel(port->gate_bits, (u32)&digctl_ctrl->reg + dig_offset); + writel(port->pll_en_bits, (u32)port->pll + pll_offset); + } else { + pll_offset = offsetof(struct mxs_register_32, reg_clr); + dig_offset = offsetof(struct mxs_register_32, reg_set); + writel(port->pll_dis_bits, (u32)port->pll + pll_offset); + writel(port->gate_bits, (u32)&digctl_ctrl->reg + dig_offset); + } + + return 0; +} + static const struct ehci_mxs_port mxs_port[] = { #ifdef CONFIG_EHCI_MXS_PORT0 { @@ -56,27 +77,6 @@ static const struct ehci_mxs_port mxs_port[] = { #endif };
-static int ehci_mxs_toggle_clock(const struct ehci_mxs_port *port, int enable) -{ - struct mxs_register_32 *digctl_ctrl = - (struct mxs_register_32 *)HW_DIGCTL_CTRL; - int pll_offset, dig_offset; - - if (enable) { - pll_offset = offsetof(struct mxs_register_32, reg_set); - dig_offset = offsetof(struct mxs_register_32, reg_clr); - writel(port->gate_bits, (u32)&digctl_ctrl->reg + dig_offset); - writel(port->pll_en_bits, (u32)port->pll + pll_offset); - } else { - pll_offset = offsetof(struct mxs_register_32, reg_clr); - dig_offset = offsetof(struct mxs_register_32, reg_set); - writel(port->pll_dis_bits, (u32)port->pll + pll_offset); - writel(port->gate_bits, (u32)&digctl_ctrl->reg + dig_offset); - } - - return 0; -} - int __weak board_ehci_hcd_init(int port) { return 0;

Those functions will be re-used when the ehci MXS driver (for imx28) will be converted to also support CONFIG_DM_USB.
No functional changes introduced - only cosmetic changes (u32 type) and alignment to pass checkpatch.
Signed-off-by: Lukasz Majewski lukma@denx.de ---
drivers/usb/host/ehci-mxs.c | 112 ++++++++++++++++++++---------------- 1 file changed, 62 insertions(+), 50 deletions(-)
diff --git a/drivers/usb/host/ehci-mxs.c b/drivers/usb/host/ehci-mxs.c index a9d5d58970a..aa32af1f3aa 100644 --- a/drivers/usb/host/ehci-mxs.c +++ b/drivers/usb/host/ehci-mxs.c @@ -50,6 +50,66 @@ static int ehci_mxs_toggle_clock(const struct ehci_mxs_port *port, int enable) return 0; }
+static int __ehci_hcd_init(struct ehci_mxs_port *port, enum usb_init_type init, + struct ehci_hccr **hccr, struct ehci_hcor **hcor) +{ + u32 usb_base, cap_base; + int ret; + + /* Reset the PHY block */ + writel(USBPHY_CTRL_SFTRST, &port->phy_regs->hw_usbphy_ctrl_set); + udelay(10); + writel(USBPHY_CTRL_SFTRST | USBPHY_CTRL_CLKGATE, + &port->phy_regs->hw_usbphy_ctrl_clr); + + /* Enable USB clock */ + ret = ehci_mxs_toggle_clock(port, 1); + if (ret) + return ret; + + /* Start USB PHY */ + writel(0, &port->phy_regs->hw_usbphy_pwd); + + /* Enable UTMI+ Level 2 and Level 3 compatibility */ + writel(USBPHY_CTRL_ENUTMILEVEL3 | USBPHY_CTRL_ENUTMILEVEL2 | 1, + &port->phy_regs->hw_usbphy_ctrl_set); + + usb_base = port->usb_regs + 0x100; + *hccr = (struct ehci_hccr *)usb_base; + + cap_base = ehci_readl(&(*hccr)->cr_capbase); + *hcor = (struct ehci_hcor *)(usb_base + HC_LENGTH(cap_base)); + + return 0; +} + +static int __ehci_hcd_stop(struct ehci_mxs_port *port) +{ + u32 usb_base, cap_base, tmp; + struct ehci_hccr *hccr; + struct ehci_hcor *hcor; + + /* Stop the USB port */ + usb_base = port->usb_regs + 0x100; + hccr = (struct ehci_hccr *)usb_base; + cap_base = ehci_readl(&hccr->cr_capbase); + hcor = (struct ehci_hcor *)(usb_base + HC_LENGTH(cap_base)); + + tmp = ehci_readl(&hcor->or_usbcmd); + tmp &= ~CMD_RUN; + ehci_writel(&hcor->or_usbcmd, tmp); + + /* Disable the PHY */ + tmp = USBPHY_PWD_RXPWDRX | USBPHY_PWD_RXPWDDIFF | + USBPHY_PWD_RXPWD1PT1 | USBPHY_PWD_RXPWDENV | + USBPHY_PWD_TXPWDV2I | USBPHY_PWD_TXPWDIBIAS | + USBPHY_PWD_TXPWDFS; + writel(tmp, &port->phy_regs->hw_usbphy_pwd); + + /* Disable USB clock */ + return ehci_mxs_toggle_clock(port, 0); +} + static const struct ehci_mxs_port mxs_port[] = { #ifdef CONFIG_EHCI_MXS_PORT0 { @@ -92,7 +152,6 @@ int ehci_hcd_init(int index, enum usb_init_type init, {
int ret; - uint32_t usb_base, cap_base; const struct ehci_mxs_port *port;
if ((index < 0) || (index >= ARRAY_SIZE(mxs_port))) { @@ -105,40 +164,12 @@ int ehci_hcd_init(int index, enum usb_init_type init, return ret;
port = &mxs_port[index]; - - /* Reset the PHY block */ - writel(USBPHY_CTRL_SFTRST, &port->phy_regs->hw_usbphy_ctrl_set); - udelay(10); - writel(USBPHY_CTRL_SFTRST | USBPHY_CTRL_CLKGATE, - &port->phy_regs->hw_usbphy_ctrl_clr); - - /* Enable USB clock */ - ret = ehci_mxs_toggle_clock(port, 1); - if (ret) - return ret; - - /* Start USB PHY */ - writel(0, &port->phy_regs->hw_usbphy_pwd); - - /* Enable UTMI+ Level 2 and Level 3 compatibility */ - writel(USBPHY_CTRL_ENUTMILEVEL3 | USBPHY_CTRL_ENUTMILEVEL2 | 1, - &port->phy_regs->hw_usbphy_ctrl_set); - - usb_base = port->usb_regs + 0x100; - *hccr = (struct ehci_hccr *)usb_base; - - cap_base = ehci_readl(&(*hccr)->cr_capbase); - *hcor = (struct ehci_hcor *)(usb_base + HC_LENGTH(cap_base)); - - return 0; + return __ehci_hcd_init(port, init, hccr, hcor); }
int ehci_hcd_stop(int index) { int ret; - uint32_t usb_base, cap_base, tmp; - struct ehci_hccr *hccr; - struct ehci_hcor *hcor; const struct ehci_mxs_port *port;
if ((index < 0) || (index >= ARRAY_SIZE(mxs_port))) { @@ -148,26 +179,7 @@ int ehci_hcd_stop(int index)
port = &mxs_port[index];
- /* Stop the USB port */ - usb_base = port->usb_regs + 0x100; - hccr = (struct ehci_hccr *)usb_base; - cap_base = ehci_readl(&hccr->cr_capbase); - hcor = (struct ehci_hcor *)(usb_base + HC_LENGTH(cap_base)); - - tmp = ehci_readl(&hcor->or_usbcmd); - tmp &= ~CMD_RUN; - ehci_writel(&hcor->or_usbcmd, tmp); - - /* Disable the PHY */ - tmp = USBPHY_PWD_RXPWDRX | USBPHY_PWD_RXPWDDIFF | - USBPHY_PWD_RXPWD1PT1 | USBPHY_PWD_RXPWDENV | - USBPHY_PWD_TXPWDV2I | USBPHY_PWD_TXPWDIBIAS | - USBPHY_PWD_TXPWDFS; - writel(tmp, &port->phy_regs->hw_usbphy_pwd); - - /* Disable USB clock */ - ret = ehci_mxs_toggle_clock(port, 0); - + ret = __ehci_hcd_stop(port); board_ehci_hcd_exit(index);
return ret;

This commit converts i.MX28's EHCI USB host driver to driver model (DM_USB). It is a straightforward conversion (to reuse as much code as possible), based on ehci-mx5.c code.
Signed-off-by: Lukasz Majewski lukma@denx.de
---
drivers/usb/host/ehci-mxs.c | 184 ++++++++++++++++++++++++++++++++++++ 1 file changed, 184 insertions(+)
diff --git a/drivers/usb/host/ehci-mxs.c b/drivers/usb/host/ehci-mxs.c index aa32af1f3aa..9a614955fc1 100644 --- a/drivers/usb/host/ehci-mxs.c +++ b/drivers/usb/host/ehci-mxs.c @@ -11,6 +11,8 @@ #include <asm/arch/imx-regs.h> #include <errno.h> #include <linux/delay.h> +#include <dm.h> +#include <power/regulator.h>
#include "ehci.h"
@@ -110,6 +112,7 @@ static int __ehci_hcd_stop(struct ehci_mxs_port *port) return ehci_mxs_toggle_clock(port, 0); }
+#if !CONFIG_IS_ENABLED(DM_USB) static const struct ehci_mxs_port mxs_port[] = { #ifdef CONFIG_EHCI_MXS_PORT0 { @@ -184,3 +187,184 @@ int ehci_hcd_stop(int index)
return ret; } +#else /* CONFIG_IS_ENABLED(DM_USB) */ +struct ehci_mxs_priv_data { + struct ehci_ctrl ctrl; + struct usb_ehci *ehci; + struct udevice *vbus_supply; + struct ehci_mxs_port port; + enum usb_init_type init_type; +}; + +/* + * Below defines correspond to imx28 clk Linux (v5.15.y) + * clock driver to provide proper offset for PHY[01] + * devices. + */ +#define CLK_USB_PHY0 62 +#define CLK_USB_PHY1 63 +#define PLL0CTRL0(base) ((base) + 0x0000) +#define PLL1CTRL0(base) ((base) + 0x0020) + +static int ehci_usb_ofdata_to_platdata(struct udevice *dev) +{ + struct ehci_mxs_priv_data *priv = dev_get_priv(dev); + struct usb_plat *plat = dev_get_plat(dev); + struct ehci_mxs_port *port = &priv->port; + u32 phandle, phy_reg, clk_reg, clk_id; + ofnode phy_node, clk_node; + const char *mode; + int ret; + + mode = ofnode_read_string(dev->node_, "dr_mode"); + if (mode) { + if (strcmp(mode, "peripheral") == 0) + plat->init_type = USB_INIT_DEVICE; + else if (strcmp(mode, "host") == 0) + plat->init_type = USB_INIT_HOST; + else + return -EINVAL; + } + + /* Read base address of the USB IP block */ + ret = ofnode_read_u32(dev->node_, "reg", &port->usb_regs); + if (ret) + return ret; + + /* Read base address of the USB PHY IP block */ + ret = ofnode_read_u32(dev->node_, "fsl,usbphy", &phandle); + if (ret) + return ret; + + phy_node = ofnode_get_by_phandle(phandle); + if (!ofnode_valid(phy_node)) + return -ENODEV; + + ret = ofnode_read_u32(phy_node, "reg", &phy_reg); + if (ret) + return ret; + + port->phy_regs = (struct mxs_usbphy_regs *)phy_reg; + + /* Read base address of the CLK IP block and proper ID */ + ret = ofnode_read_u32_index(phy_node, "clocks", 0, &phandle); + if (ret) + return ret; + + ret = ofnode_read_u32_index(phy_node, "clocks", 1, &clk_id); + if (ret) + return ret; + + clk_node = ofnode_get_by_phandle(phandle); + if (!ofnode_valid(clk_node)) + return -ENODEV; + + ret = ofnode_read_u32(clk_node, "reg", &clk_reg); + if (ret) + return ret; + + port->pll = (struct mxs_register_32 *)clk_reg; + + /* Provide proper offset for USB PHY clocks */ + if (clk_id == CLK_USB_PHY0) + port->pll = PLL0CTRL0(port->pll); + + if (clk_id == CLK_USB_PHY1) + port->pll = PLL1CTRL0(port->pll); + + debug("%s: pll_reg: 0x%p clk_id: %d\n", __func__, port->pll, clk_id); + /* + * On the imx28 the values provided by CLKCTRL_PLL0* defines to are the + * same as ones for CLKCTRL_PLL1*. As a result the former can be used + * for both ports - i.e. (usb[01]). + */ + port->pll_en_bits = CLKCTRL_PLL0CTRL0_EN_USB_CLKS | + CLKCTRL_PLL0CTRL0_POWER; + port->pll_dis_bits = CLKCTRL_PLL0CTRL0_EN_USB_CLKS; + port->gate_bits = HW_DIGCTL_CTRL_USB0_CLKGATE; + + return 0; +} + +static int ehci_usb_probe(struct udevice *dev) +{ + struct usb_plat *plat = dev_get_plat(dev); + struct usb_ehci *ehci = dev_read_addr_ptr(dev); + struct ehci_mxs_priv_data *priv = dev_get_priv(dev); + struct ehci_mxs_port *port = &priv->port; + enum usb_init_type type = plat->init_type; + struct ehci_hccr *hccr; + struct ehci_hcor *hcor; + int ret; + + priv->ehci = ehci; + priv->init_type = type; + + debug("%s: USB type: %s reg: 0x%x phy_reg 0x%p\n", __func__, + type == USB_INIT_HOST ? "HOST" : "DEVICE", port->usb_regs, + (uint32_t *)port->phy_regs); + +#if CONFIG_IS_ENABLED(DM_REGULATOR) + ret = device_get_supply_regulator(dev, "vbus-supply", + &priv->vbus_supply); + if (ret) + debug("%s: No vbus supply\n", dev->name); + + if (!ret && priv->vbus_supply) { + ret = regulator_set_enable(priv->vbus_supply, + (type == USB_INIT_DEVICE) ? + false : true); + if (ret) { + puts("Error enabling VBUS supply\n"); + return ret; + } + } +#endif + ret = __ehci_hcd_init(port, type, &hccr, &hcor); + if (ret) + return ret; + + mdelay(10); + return ehci_register(dev, hccr, hcor, NULL, 0, priv->init_type); +} + +static int ehci_usb_remove(struct udevice *dev) +{ + struct ehci_mxs_priv_data *priv = dev_get_priv(dev); + struct ehci_mxs_port *port = &priv->port; + int ret; + + ret = ehci_deregister(dev); + if (ret) + return ret; + +#if CONFIG_IS_ENABLED(DM_REGULATOR) + if (priv->vbus_supply) { + ret = regulator_set_enable(priv->vbus_supply, false); + if (ret) { + puts("Error disabling VBUS supply\n"); + return ret; + } + } +#endif + return __ehci_hcd_stop(port); +} + +static const struct udevice_id mxs_usb_ids[] = { + { .compatible = "fsl,imx28-usb" }, + { } +}; + +U_BOOT_DRIVER(usb_mxs) = { + .name = "ehci_mxs", + .id = UCLASS_USB, + .of_match = mxs_usb_ids, + .of_to_plat = ehci_usb_ofdata_to_platdata, + .probe = ehci_usb_probe, + .remove = ehci_usb_remove, + .ops = &ehci_usb_ops, + .plat_auto = sizeof(struct usb_plat), + .priv_auto = sizeof(struct ehci_mxs_priv_data), + .flags = DM_FLAG_ALLOC_PRIV_DMA, +}; +#endif /* !CONFIG_IS_ENABLED(DM_USB) */
participants (1)
-
Lukasz Majewski