usb: host: dwc2: use driver model for PHY and CLOCK
v5 cover usb: host: dwc2: use driver model for PHY and CLOCK
In this serie I update the DWC2 host driver to use the device tree information and the associated PHY and CLOCK drivers when they are availables.
The V5 is a minor update after review and rebased on latest master of
http://patchwork.ozlabs.org/project/uboot/list/?series=159185
I test the V4 of this serie on stm32mp157c-ev1 board, with PHY and CLK support.
The U-CLASS are provided by:
- PHY by USBPHYC driver = ./drivers/phy/phy-stm32-usbphyc.c
- CLOCK by RCC clock driver = drivers/clk/clk_stm32mp1.c
- RESET by RCC reset driver = drivers/reset/stm32-reset.c
And I activate the configuration
+CONFIG_USB_DWC2=y
PS: it is not the default configuration to avoid conflict with gadget
driver
To solve a binding issue, I also deactivate the gadget support:
by default only one driver is bound to the usbotg_hs node with "snps,dwc2" compatible, and today it is the device one (the first in the driver list).
I also need to deactivate hnp-srp support with:
&usbotg_hs {
/* need to disable ONLY for HOST support */
hnp-srp-disable;
};WARNING: OTG with device or host support is not correctly handle by DWC2
driver (see example for dynamic OTG role in DWC3 driver).
The tests executed on the stm32mp157c-ev1 target:
STM32MP> usb start
starting USB...
Bus usb-otg at 49000000: USB DWC2
Bus usbh-ehci at 5800d000: USB EHCI 1.00
scanning bus usb-otg at 49000000 for devices... 2 USB Device(s) found scanning bus usbh-ehci at 5800d000 for devices... 3 USB Device(s) found
scanning usb for storage devices... 2 Storage Device(s) found
STM32MP> usb tree
USB device tree:
1 Hub (480 Mb/s, 0mA)
| U-Boot Root Hub
|
+-2 Mass Storage (480 Mb/s, 300mA)
Verbatim STORE N GO 070731C8ACD7EE97
1 Hub (480 Mb/s, 0mA)
| u-boot EHCI Host Controller
|
+-2 Hub (480 Mb/s, 2mA)
STM32MP> ls usb 0
<DIR> 4096 .
<DIR> 4096 ..
<DIR> 16384 lost+found
<DIR> 4096 record
1490212 xipImage
21058006 vmlinuxSTM32MP> load usb 0 0xC0000000 vmlinux
21058006 bytes read in 10851 ms (1.9 MiB/s)
Changes in v5:
- use ERR_PTR in clk_get_parent()
- force bulk->count = 0 in clk_get_bulk to avoid issue for next call of clk_enable_bulk / clk_enable_bulk
- update commit message
- inverse logic for -ENOENT test on generic_phy_get_by_index result
- Add some comments
Changes in v4:
- Add stub for all functions using 'struct clk' or 'struct clk_bulk' after remarks on v3
Changes in v3:
- Add stub for clk_disable_bulk
Changes in v2:
- update dev_err
- update commit message
- change dev_err to dev_dbg for PHY function call
- treat dwc2_shutdown_phy error
- add clk_disable_bulk in dwc2_usb_remove
Patrick Delaunay (5):
dm: clk: add stub when CONFIG_CLK is deactivated
usb: host: dwc2: add phy support
usb: host: dwc2: add clk support
usb: host: dwc2: force reset assert
usb: host: dwc2: add trace to have clean usb start
drivers/usb/host/dwc2.c | 100 +++++++++++++++++++++++++++++++++++++- include/clk.h | 104 +++++++++++++++++++++++++++++++++++----- 2 files changed, 190 insertions(+), 14 deletions(-)
Signature · 1 line
2.17.1
PATCH v5 1/5 dm: clk: add stub when CONFIG_CLK is deactivated
Add stub for functions clk_...() when CONFIG_CLK is deactivated.
This patch avoids compilation issues for driver using these API without protection (#if CONFIG_IS_ENABLED(CLK))
For example, before this patch we have undefined reference to `clk_disable_bulk') for code:
clk_disable_bulk(&priv->clks); clk_release_bulk(&priv->clks);
The bulk stub set and test bulk->count to avoid error for the sequence:
clk_get_bulk(dev, &priv->bulk); .... if (clk_enable(&priv>bulk)) return -EIO;
---
Changes in v5:
- use ERR_PTR in clk_get_parent()
- force bulk->count = 0 in clk_get_bulk to avoid issue for next call of clk_enable_bulk / clk_enable_bulk
- update commit message
Changes in v4:
- Add stub for all functions using 'struct clk' or 'struct clk_bulk' after remarks on v3
Changes in v3:
- Add stub for clk_disable_bulk
Changes in v2: None
include/clk.h | 104 +++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 91 insertions(+), 13 deletions(-)
include/clk.h +91 -13
@@ -9,6 +9,7 @@#define _CLK_H_#include <dm/ofnode.h> +#include <linux/err.h> #include <linux/errno.h> #include <linux/types.h>
@@ -249,6 +250,8 @@ static inline int clk_get_by_index(struct udevice *dev, int index,static inline int clk_get_bulk (struct udevice *dev,struct clk_bulk *bulk) { +if (bulk) + bulk->count =0 ;return -ENOSYS ; }
@@ -312,6 +315,7 @@ static inline int clk_release_bulk(struct clk_bulk *bulk)return clk_release_all (bulk->clks, bulk->count); } +#if CONFIG_IS_ENABLED (CLK )/** * clk_request - Request a clock by provider-specific ID. *
@@ -433,19 +437,6 @@ int clk_disable_bulk(struct clk_bulk *bulk);*/ bool clk_is_match (const struct clk *p,const struct clk *q); -int soc_clk_dump (void ); - -/** -* clk_valid() - check if clk is valid -* -* @clk: the clock to check -* @return true if valid, or false -*/ -static inline bool clk_valid (struct clk *clk) -{ -return clk && !!clk->dev; -} -/** * clk_get_by_id() - Get the clock by its ID *
@@ -465,6 +456,93 @@ int clk_get_by_id(ulong id, struct clk **clkp);* @return true on binded, or false on no */ bool clk_dev_binded (struct clk *clk); + +#else /* CONFIG_IS_ENABLED(CLK) */ + +static inline int clk_request (struct udevice *dev,struct clk *clk) +{ +return -ENOSYS ; +} + +static inline int clk_free (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline ulong clk_get_rate (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline struct clk *clk_get_parent (struct clk *clk) +{ +return ERR_PTR (-ENOSYS ); +} + +static inline long long clk_get_parent_rate (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline ulong clk_set_rate (struct clk *clk,ulong rate) +{ +return -ENOSYS ; +} + +static inline int clk_set_parent (struct clk *clk,struct clk *parent) +{ +return -ENOSYS ; +} + +static inline int clk_enable (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline int clk_enable_bulk (struct clk_bulk *bulk) +{ +return bulk && bulk->count ==0 ?0 : -ENOSYS ; +} + +static inline int clk_disable (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline int clk_disable_bulk (struct clk_bulk *bulk) +{ +return bulk && bulk->count ==0 ?0 : -ENOSYS ; +} + +static inline bool clk_is_match (const struct clk *p,const struct clk *q) +{ +return false; +} + +static inline int clk_get_by_id (ulong id,struct clk **clkp) +{ +return -ENOSYS ; +} + +static inline bool clk_dev_binded (struct clk *clk) +{ +return false; +} +#endif /* CONFIG_IS_ENABLED(CLK) */ + +/** +* clk_valid() - check if clk is valid +* +* @clk: the clock to check +* @return true if valid, or false +*/ +static inline bool clk_valid (struct clk *clk) +{ +return clk && !!clk->dev; +} + +int soc_clk_dump (void ); +#endif #define clk_prepare_enable (clk) clk_enable(clk)
Signature · 1 line
2.17.1
PATCH v5 1/5 dm: clk: add stub when CONFIG_CLK is deactivated
Quoted 18 lines · Patrick Delaunay
Add stub for functions clk_...() when
CONFIG_CLKis deactivated.This patch avoids compilation issues for driver using these API without protection (#if
CONFIG_IS_ENABLED(CLK))For example, before this patch we have undefined reference to `clk_disable_bulk') for code:
clk_disable_bulk(&priv->clks);clk_release_bulk(&priv->clks);The bulk stub set and test
bulk->countto avoid error for the sequence:clk_get_bulk(dev, &priv->bulk); .... if (clk_enable(&priv>bulk)) return -EIO;
Quoted 7 lines
Signed-off-by Patrick Delaunay <[email protected]>---
Changes in v5:
- useERR_PTRinclk_get_parent()
- forcebulk->count= 0 inclk_get_bulkto avoid issue for next call ofclk_enable_bulk/clk_enable_bulk
I wonder if this is correct. I think it only produces additional code. If you always set bulk->count to 0, the enable code will never fail.
However, the enable function should never be executed as enable returns an error. I can imagine the *disable* function could be called, but the return value of this function is currently only handled in clk_sandbox_test.c...
Wouldn't it work to just remove all checks for bulk->count and let *all* redefined functions return a constant (success or failure)? That would help to keep the code small.
Looking at linux, clock disable functions have *no* return value that needs to be checked, clock enable functions return success when compiled without clock support.
Regards,
Simon
Quoted 160 lines
- update commit message
Changes in v4:
- Add stub for all functions using 'struct clk' or 'structclk_bulk' after remarks on v3Changes in v3:
- Add stub forclk_disable_bulkChanges in v2: None
include/clk.h | 104 +++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 91 insertions(+), 13 deletions(-)include/clk.h +91
-14@@ -9,6 +9,7 @@#define _CLK_H_#include <dm/ofnode.h> +#include <linux/err.h> #include <linux/errno.h> #include <linux/types.h> @@ -249,6 +250,8 @@ static inline int clk_get_by_index(struct udevice *dev, int index,static inline int clk_get_bulk (struct udevice *dev,struct clk_bulk *bulk) { +if (bulk) + bulk->count =0 ;return -ENOSYS ; }@@ -312,6 +315,7 @@ static inline int clk_release_bulk(struct clk_bulk *bulk)return clk_release_all (bulk->clks, bulk->count); } +#if CONFIG_IS_ENABLED (CLK )/** * clk_request - Request a clock by provider-specific ID. * @@ -433,19 +437,6 @@ int clk_disable_bulk(struct clk_bulk *bulk);*/ bool clk_is_match (const struct clk *p,const struct clk *q); -int soc_clk_dump (void ); - -/** -* clk_valid() - check if clk is valid -* -* @clk: the clock to check -* @return true if valid, or false -*/ -static inline bool clk_valid (struct clk *clk) -{ -return clk && !!clk->dev; -} -/** * clk_get_by_id() - Get the clock by its ID * @@ -465,6 +456,93 @@ int clk_get_by_id(ulong id, struct clk **clkp);* @return true on binded, or false on no */ bool clk_dev_binded (struct clk *clk); + +#else /* CONFIG_IS_ENABLED(CLK) */ + +static inline int clk_request (struct udevice *dev,struct clk *clk) +{ +return -ENOSYS ; +} + +static inline int clk_free (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline ulong clk_get_rate (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline struct clk *clk_get_parent (struct clk *clk) +{ +return ERR_PTR (-ENOSYS ); +} + +static inline long long clk_get_parent_rate (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline ulong clk_set_rate (struct clk *clk,ulong rate) +{ +return -ENOSYS ; +} + +static inline int clk_set_parent (struct clk *clk,struct clk *parent) +{ +return -ENOSYS ; +} + +static inline int clk_enable (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline int clk_enable_bulk (struct clk_bulk *bulk) +{ +return bulk && bulk->count ==0 ?0 : -ENOSYS ; +} + +static inline int clk_disable (struct clk *clk) +{ +return -ENOSYS ; +} + +static inline int clk_disable_bulk (struct clk_bulk *bulk) +{ +return bulk && bulk->count ==0 ?0 : -ENOSYS ; +} + +static inline bool clk_is_match (const struct clk *p,const struct clk *q) +{ +return false; +} + +static inline int clk_get_by_id (ulong id,struct clk **clkp) +{ +return -ENOSYS ; +} + +static inline bool clk_dev_binded (struct clk *clk) +{ +return false; +} +#endif /* CONFIG_IS_ENABLED(CLK) */ + +/** +* clk_valid() - check if clk is valid +* +* @clk: the clock to check +* @return true if valid, or false +*/ +static inline bool clk_valid (struct clk *clk) +{ +return clk && !!clk->dev; +} + +int soc_clk_dump (void ); +#endif #define clk_prepare_enable (clk) clk_enable(clk) --2.17.1
PATCH v5 1/5 dm: clk: add stub when CONFIG_CLK is deactivated
Hi Simon,
Quoted 34 lines
From: Simon Goldschmidt <[email protected]>
Sent: vendredi 6 mars 2020 12:28Quoted 18 lines · Patrick Delaunay
Add stub for functions clk_...() when
CONFIG_CLKis deactivated.This patch avoids compilation issues for driver using these API without protection (#if
CONFIG_IS_ENABLED(CLK))For example, before this patch we have undefined reference to `clk_disable_bulk') for code:
clk_disable_bulk(&priv->clks);clk_release_bulk(&priv->clks);The bulk stub set and test
bulk->countto avoid error for the sequence:clk_get_bulk(dev, &priv->bulk); .... if (clk_enable(&priv>bulk)) return -EIO;Quoted 7 lines
Signed-off-by Patrick Delaunay <[email protected]>---
Changes in v5:
- useERR_PTRinclk_get_parent()
- forcebulk->count= 0 inclk_get_bulkto avoid issue for next call ofclk_enable_bulk/clk_enable_bulkI wonder if this is correct. I think it only produces additional code. If you always set
bulk->countto 0, the enable code will never fail.
Quoted 7 lines
However, the enable function should never be executed as enable returns an error. I can imagine the *disable* function could be called, but the return value of this function is currently only handled in
clk_sandbox_test.c...Wouldn't it work to just remove all checks for
bulk->countand let *all* redefined functions return a constant (success or failure)? That would help to keep the code small.
I wasn't sure if each stub should raise error or success.
When I code the stub the first time I found one example for API usage without protection which can cause issue in drivers/net/ftgmac100.c
ftgmac100_ofdata_to_platdata
=> clk_get_bulk(dev, &priv->clks);
ftgmac100_probe(struct udevice *dev)
=> clk_enable_bulk(&priv->clks);
An other example : drivers/power/domain/meson-ee-pwrc.c
meson_ee_pwrc_probe => clk_get_bulk(dev, &priv->clks); meson_ee_pwrc_on => clk_enable_bulk(&priv->clks);
And same in drivers/power/domain/meson-gx-pwrc-vpu.c
But finally after deeper check today, these driver can't handle the proposed clk stubs (error during probe for clk_get_bulk).
So I agree that I complexify the clk stub only for over protection.
Quoted 3 lines
Looking at linux, clock disable functions have *no* return value that needs to be checked, clock enable functions return success when compiled without clock support.
I also check the stub for reset function in "./include/reset.h"
- reset_free
- reset_assert
- reset_deassert
- reset_deassert_bulk
- reset_assert_bulk
All these reset stub functions return 0
So to be coherent I will update the patch to return success for clk_free, clk_enable, clk_disable, clk_disable_bulk and clk_enable_bulk.
And other functions return error -ENOSYS: request / get_rate / set_rate
Quoted 3 lines
Regards,
Simon
Regards
Patrick
PATCH v5 2/5 usb: host: dwc2: add phy support
In reply to Patrick DelaunayUse generic phy to initialize the PHY associated to the DWC2 device and available in the device tree.
This patch don't added dependency because when CONFIG_PHY is not activated, the generic PHY function are stubbed.
---
Changes in v5:
- inverse logic for -ENOENT test on generic_phy_get_by_index result
- Add some comments
Changes in v4: None
Changes in v3: None
Changes in v2:
- update dev_err
- update commit message
- change dev_err to dev_dbg for PHY function call
- treat dwc2_shutdown_phy error
drivers/usb/host/dwc2.c | 66 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+)
drivers/usb/host/dwc2.c +66 -0
@@ -8,6 +8,7 @@#include <cpu_func.h> #include <dm.h> #include <errno.h> +#include <generic-phy.h> #include <usb.h> #include <malloc.h> #include <memalign.h>
@@ -37,6 +38,7 @@ struct dwc2_priv {#ifdef CONFIG_DM_REGULATOR struct udevice *vbus_supply;#endif +struct phy phy;#else uint8_t *aligned_buffer;uint8_t *status_buffer;
@@ -1322,13 +1324,71 @@ static int dwc2_usb_ofdata_to_platdata(struct udevice *dev)return 0 ; } +static int dwc2_setup_phy (struct udevice *dev) +{ +struct dwc2_priv *priv =dev_get_priv (dev); +int ret; + + ret =generic_phy_get_by_index (dev,0 , &priv->phy); +if (ret) { +if (ret == -ENOENT ) +return 0 ;/* no PHY, nothing to do */ +dev_err (dev,"Failed to get USB PHY: %d.\n" , ret); +return ret; + } + + ret =generic_phy_init (&priv->phy); +if (ret) { +dev_dbg (dev,"Failed to init USB PHY: %d.\n" , ret); +return ret; + } + + ret =generic_phy_power_on (&priv->phy); +if (ret) { +dev_dbg (dev,"Failed to power on USB PHY: %d.\n" , ret); +generic_phy_exit (&priv->phy); +return ret; + } + +return 0 ; +} + +static int dwc2_shutdown_phy (struct udevice *dev) +{ +struct dwc2_priv *priv =dev_get_priv (dev); +int ret; + +/* PHY is not valid when generic_phy_get_by_index() = -ENOENT */ +if (!generic_phy_valid (&priv->phy)) +return 0 ;/* no PHY, nothing to do */ + + ret =generic_phy_power_off (&priv->phy); +if (ret) { +dev_dbg (dev,"Failed to power off USB PHY: %d.\n" , ret); +return ret; + } + + ret =generic_phy_exit (&priv->phy); +if (ret) { +dev_dbg (dev,"Failed to power off USB PHY: %d.\n" , ret); +return ret; + } + +return 0 ; +} +static int dwc2_usb_probe (struct udevice *dev) {struct dwc2_priv *priv =dev_get_priv (dev);struct usb_bus_priv *bus_priv =dev_get_uclass_priv (dev); +int ret; bus_priv->desc_before_addr = true; + ret =dwc2_setup_phy (dev); +if (ret) +return ret; +return dwc2_init_common (dev, priv); }
@@ -1341,6 +1401,12 @@ static int dwc2_usb_remove(struct udevice *dev)if (ret)return ret; + ret =dwc2_shutdown_phy (dev); +if (ret) { +dev_dbg (dev,"Failed to shutdown USB PHY: %d.\n" , ret); +return ret; + } +dwc2_uninit_common (priv->regs);reset_release_bulk (&priv->resets);
Signature · 1 line
2.17.1
PATCH v5 3/5 usb: host: dwc2: add clk support
In reply to Patrick DelaunayAdd support for clock with driver model.
This patch don't added dependency because when CONFIG_CLK is not activated the clk function are stubbed.
---
Changes in v5: None
Changes in v4: None
Changes in v3: None
Changes in v2: None
drivers/usb/host/dwc2.c | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-)
drivers/usb/host/dwc2.c +29 -1
@@ -5,14 +5,15 @@*/ #include <common.h> +#include <clk.h> #include <cpu_func.h> #include <dm.h> #include <errno.h> #include <generic-phy.h> -#include <usb.h> #include <malloc.h> #include <memalign.h> #include <phys2bus.h> +#include <usb.h> #include <usbroothubdes.h> #include <wait_bit.h> #include <asm/io.h>
@@ -39,6 +40,7 @@ struct dwc2_priv {struct udevice *vbus_supply;#endif struct phy phy; +struct clk_bulk clks;#else uint8_t *aligned_buffer;uint8_t *status_buffer;
@@ -1377,6 +1379,26 @@ static int dwc2_shutdown_phy(struct udevice *dev)return 0 ; } +static int dwc2_clk_init (struct udevice *dev) +{ +struct dwc2_priv *priv =dev_get_priv (dev); +int ret; + + ret =clk_get_bulk (dev, &priv->clks); +if (ret == -ENOSYS || ret == -ENOENT ) +return 0 ; +if (ret) +return ret; + + ret =clk_enable_bulk (&priv->clks); +if (ret) { +clk_release_bulk (&priv->clks); +return ret; + } + +return 0 ; +} +static int dwc2_usb_probe (struct udevice *dev) {struct dwc2_priv *priv =dev_get_priv (dev);
@@ -1385,6 +1407,10 @@ static int dwc2_usb_probe(struct udevice *dev) bus_priv->desc_before_addr = true; + ret =dwc2_clk_init (dev); +if (ret) +return ret; + ret =dwc2_setup_phy (dev);if (ret)return ret;
@@ -1410,6 +1436,8 @@ static int dwc2_usb_remove(struct udevice *dev)dwc2_uninit_common (priv->regs);reset_release_bulk (&priv->resets); +clk_disable_bulk (&priv->clks); +clk_release_bulk (&priv->clks);return 0 ; }
Signature · 1 line
2.17.1
PATCH v5 4/5 usb: host: dwc2: force reset assert
In reply to Patrick DelaunayAssert reset before deassert in dwc2_reset;
this patch solve issues when the DWC2 registers are already initialized with value incompatible with host mode.
Force a hardware reset of the IP reset all the DWC2 registers at default value, the host driver start with a clean state (Core Soft reset doen in dwc_otg_core_reset is not enought
to reset all register).
The error can occurs in U-Boot when DWC2 device gadget driver force device mode (called by ums or dfu command, before to execute the usb start command).
---
Changes in v5: None
Changes in v4: None
Changes in v3: None
Changes in v2:
- add clk_disable_bulk in dwc2_usb_remove
drivers/usb/host/dwc2.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/usb/host/dwc2.c +2 -0
@@ -1151,6 +1151,8 @@ static int dwc2_reset(struct udevice *dev)return ret; } +/* force reset to clear all IP register */ +reset_assert_bulk (&priv->resets); ret =reset_deassert_bulk (&priv->resets);if (ret) {reset_release_bulk (&priv->resets);
Signature · 1 line
2.17.1
PATCH v5 5/5 usb: host: dwc2: add trace to have clean usb start
In reply to Patrick DelaunaySolve issue for the display of "usb start" command on stm32mp1 because one carriage return is missing in DWC2 probe.
Before the patch:
STM32MP> usb start
starting USB...
Bus usb-otg at 49000000: Bus usbh-ehci at 5800d000: USB EHCI 1.00
after the patch:
STM32MP> usb start
starting USB...
Bus usb-otg at 49000000: USB DWC2
Bus usbh-ehci at 5800d000: USB EHCI 1.00
---
Changes in v5: None
Changes in v4: None
Changes in v3: None
Changes in v2: None
drivers/usb/host/dwc2.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/usb/host/dwc2.c +2 -0
@@ -1219,6 +1219,8 @@ static int dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)if (readl (®s->gintsts) &DWC2_GINTSTS_CURMODE_HOST )mdelay (1000 ); +printf ("USB DWC2\n" ); +return 0 ; }
Signature · 1 line
2.17.1