Xilinx ZynqMP USB fixes
v2 cover Xilinx ZynqMP USB fixes
Some fixes related to the DWC3 USB driver and Xilinx ZynqMP DWC3 wrapper driver to allow ZynqMP USB to work properly when the hardware is configured in USB 2.0-only mode.
Changes since v1:
-added DT binding documentation for new attribute
-kerneldoc formatting and reworded comments
Robert Hancock (5):
usb: dwc3: xilinx: Fix PIPE clock selection for USB2.0 mode
usb: dwc3: xilinx: Fix error handling when getting USB3 PHY
dt-bindings: usb: dwc3: add reference clock period fractional
adjustment
usb: dwc3: add reference clock FLADJ configuration
arm64: dts: zynqmp: Add DWC3 USB reference clock period configuration
.../devicetree/bindings/usb/snps,dwc3.yaml | 12 +++++++ arch/arm64/boot/dts/xilinx/zynqmp.dtsi | 4 +++ drivers/usb/dwc3/core.c | 35 +++++++++++++++++++ drivers/usb/dwc3/core.h | 3 ++ drivers/usb/dwc3/dwc3-xilinx.c | 17 +++++---- 5 files changed, 64 insertions(+), 7 deletions(-)
Signature · 1 line
2.31.1
PATCH v2 1/5 usb: dwc3: xilinx: Fix PIPE clock selection for USB2.0 mode
It appears that the PIPE clock should not be selected when only USB 2.0 is being used in the design and no USB 3.0 reference clock is used. Fix to set the correct value depending on whether a USB3 PHY is present.
--- drivers/usb/dwc3/dwc3-xilinx.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
drivers/usb/dwc3/dwc3-xilinx.c +5 -2
@@ -167,8 +167,11 @@ static int dwc3_xlnx_init_zynqmp(struct dwc3_xlnx *priv_data)/* Set PIPE Power Present signal in FPD Power Present Register*/ writel (FPD_POWER_PRSNT_OPTION , priv_data->regs +XLNX_USB_FPD_POWER_PRSNT ); -/* Set the PIPE Clock Select bit in FPD PIPE Clock register */ -writel (PIPE_CLK_SELECT , priv_data->regs +XLNX_USB_FPD_PIPE_CLK ); +/* Set the PIPE Clock Select bit in FPD PIPE Clock register if a USB3 +* PHY is in use, deselect otherwise +*/ +writel (usb3_phy ?PIPE_CLK_SELECT :PIPE_CLK_DESELECT , + priv_data->regs +XLNX_USB_FPD_PIPE_CLK ); ret =reset_control_deassert (crst);if (ret <0 ) {
Signature · 1 line
2.31.1
PATCH v2 2/5 usb: dwc3: xilinx: Fix error handling when getting USB3 PHY
In reply to Robert HancockThe code that looked up the USB3 PHY was ignoring all errors other than EPROBE_DEFER in an attempt to handle the PHY not being present. Fix and simplify the code by using devm_phy_optional_get and dev_err_probe so that a missing PHY is not treated as an error and unexpected errors are handled properly.
--- drivers/usb/dwc3/dwc3-xilinx.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/usb/dwc3/dwc3-xilinx.c +5 -5
@@ -102,12 +102,12 @@ static int dwc3_xlnx_init_zynqmp(struct dwc3_xlnx *priv_data)int ret;u32 reg; - usb3_phy =devm_phy_get (dev,"usb3-phy" ); -if (PTR_ERR (usb3_phy) == -EPROBE_DEFER ) { - ret = -EPROBE_DEFER ; + usb3_phy =devm_phy_optional_get (dev,"usb3-phy" ); +if (IS_ERR (usb3_phy)) { + ret =PTR_ERR (usb3_phy); +dev_err_probe (dev, ret, +"failed to get USB3 PHY\n" ); goto err; - }else if (IS_ERR (usb3_phy)) { - usb3_phy =NULL ; } crst =devm_reset_control_get_exclusive (dev,"usb_crst" );
Signature · 1 line
2.31.1
PATCH v2 3/5 dt-bindings: usb: dwc3: add reference clock period fractional adjustment
In reply to Robert HancockDocument the new snps,ref-clock-fladj property which can be used to set the fractional portion of the reference clock period.
--- Documentation/devicetree/bindings/usb/snps,dwc3.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+)
Documentation/devicetree/bindings/usb/snps,dwc3.yaml +12 -0
@@ -260,6 +260,18 @@ properties: minimum: 1 maximum: 0x3ff + snps,ref-clock-fladj: + description: + Value for GFLADJ_REFCLK_FLADJ field of GFLADJ register for the + fractional portion of the reference clock period in nanoseconds, + when the hardware set default does not match the actual + clock. Calculated via + ((125000/ref_clk_period_integer)-(125000/ref_clk_period)) * ref_clk_period + where ref_clk_period_integer is the period specified in GUCTL_REFCLKPER and + ref_clk_period is the period including fractional value. + minimum: 0 + maximum: 124999 + snps,rx-thr-num-pkt-prd: description: Periodic ESS RX packet threshold count (host mode only). Set this and
Signature · 1 line
2.31.1
PATCH v2 4/5 usb: dwc3: add reference clock FLADJ configuration
In reply to Robert HancockPreviously a device tree property was added to allow overriding the reference clock period parameter if the default value used was incorrect. However, there is another register field, GFLADJ_REFCLK_FLADJ, which reflects the fractional nanosecond portion of the reference clock period. Add a snps,ref-clock-fladj property to allow configuring this as well.
On the Xilinx ZynqMP platform, the reference clock appears to always be 20 MHz, giving a clock period of 50 ns. However, the default value of GFLADJ_REFCLK_FLADJ was 1008 rather than 0 as it should have been, which prevented many USB devices from functioning properly. The psu_init code run by the Xilinx first-stage boot loader sets this value to 0, however when the controller is reset by the dwc3-xilinx layer, the incorrect default value is restored. This configuration property allows ensuring that the correct value is always used.
--- drivers/usb/dwc3/core.c | 35 +++++++++++++++++++++++++++++++++++ drivers/usb/dwc3/core.h | 3 +++ 2 files changed, 38 insertions(+)
drivers/usb/dwc3/core.c +35 -0
@@ -359,6 +359,37 @@ static void dwc3_ref_clk_period(struct dwc3 *dwc) } +/** +* dwc3_ref_clk_fladj - Reference clock period adjustment configuration +* GFLADJ_REFCLK_FLADJ should be set based on the fractional portion of the +* reference clock period, where the integer portion is set in GUCTL_REFCLKPER. +* Calculated as: ((125000/ref_clk_period_integer)-(125000/ref_clk_period)) * ref_clk_period +* where ref_clk_period_integer is the period specified in GUCTL_REFCLKPER and +* ref_clk_period is the period including fractional value. +* This value can be specified in the device tree if the default value is incorrect. +* Note that 0 is a valid value. +* +* @dwc3: Pointer to our controller context structure +*/ +static void dwc3_ref_clk_fladj (struct dwc3 *dwc) +{ +u32 reg; +u32 reg_new; + + if (DWC3_VER_IS_PRIOR(DWC3, 250A)) +return ; + +if (!dwc->ref_clk_fladj_set) +return ; + + reg =dwc3_readl (dwc->regs,DWC3_GFLADJ ); + reg_new = reg & ~DWC3_GFLADJ_REFCLK_FLADJ_MASK ; + reg_new |=FIELD_PREP (DWC3_GFLADJ_REFCLK_FLADJ_MASK , dwc->ref_clk_fladj); +if (reg_new != reg) +dwc3_writel (dwc->regs,DWC3_GFLADJ , reg_new); +} + +/** * dwc3_free_one_event_buffer - Frees one event buffer * @dwc: Pointer to our controller context structure
@@ -1033,6 +1064,7 @@ static int dwc3_core_init(struct dwc3 *dwc)/* Adjust Reference Clock Period */ dwc3_ref_clk_period (dwc); +dwc3_ref_clk_fladj (dwc);dwc3_set_incr_burst_type (dwc);
@@ -1418,6 +1450,9 @@ static void dwc3_get_properties(struct dwc3 *dwc) &dwc->fladj);device_property_read_u32 (dev,"snps,ref-clock-period-ns" , &dwc->ref_clk_per); +if (!device_property_read_u32 (dev,"snps,ref-clock-fladj" , + &dwc->ref_clk_fladj)) + dwc->ref_clk_fladj_set = true; dwc->dis_metastability_quirk =device_property_read_bool (dev,"snps,dis_metastability_quirk" );
drivers/usb/dwc3/core.h +3 -0
@@ -388,6 +388,7 @@/* Global Frame Length Adjustment Register */ #define DWC3_GFLADJ_30MHZ_SDBND_SEL BIT(7)#define DWC3_GFLADJ_30MHZ_MASK 0x3f +#define DWC3_GFLADJ_REFCLK_FLADJ_MASK 0x3fff00/* Global User Control Register*/ #define DWC3_GUCTL_REFCLKPER_MASK 0xffc00000
@@ -1166,6 +1167,8 @@ struct dwc3 {u32 fladj;u32 ref_clk_per; +bool ref_clk_fladj_set; +u32 ref_clk_fladj;u32 irq_gadget;u32 otg_irq;u32 current_otg_role;
Signature · 1 line
2.31.1
Re: [PATCH v2 4/5] usb: dwc3: add reference clock FLADJ configuration
Quoted 29 lines · Robert Hancock
Previously a device tree property was added to allow overriding the reference clock period parameter if the default value used was incorrect. However, there is another register field,
GFLADJ_REFCLK_FLADJ, which reflects the fractional nanosecond portion of the reference clock period. Add a snps,ref-clock-fladj property to allow configuring this as well.On the Xilinx ZynqMP platform, the reference clock appears to always be 20 MHz, giving a clock period of 50 ns. However, the default value of
GFLADJ_REFCLK_FLADJwas 1008 rather than 0 as it should have been, which prevented many USB devices from functioning properly. Thepsu_initcode run by the Xilinx first-stage boot loader sets this value to 0, however when the controller is reset by the dwc3-xilinx layer, the incorrect default value is restored. This configuration property allows ensuring that the correct value is always used.Signed-off-by Robert Hancock <[email protected]>--- drivers/usb/dwc3/core.c | 35 +++++++++++++++++++++++++++++++++++ drivers/usb/dwc3/core.h | 3 +++ 2 files changed, 38 insertions(+)drivers/usb/dwc3/core.c +0
-0@@ -359,6 +359,37 @@ static void dwc3_ref_clk_period(struct dwc3 *dwc) }
drivers/usb/dwc3/core.c static void dwc3_ref_clk_period(struct dwc3 *dwc) · line 370
Quoted 10 lines
drivers/usb/dwc3/core.c +9
-0+/** +* dwc3_ref_clk_fladj - Reference clock period adjustment configuration +* GFLADJ_REFCLK_FLADJ should be set based on the fractional portion of the +* reference clock period, where the integer portion is set in GUCTL_REFCLKPER. +* Calculated as: ((125000/ref_clk_period_integer)-(125000/ref_clk_period)) * ref_clk_period +* where ref_clk_period_integer is the period specified in GUCTL_REFCLKPER and +* ref_clk_period is the period including fractional value. +* This value can be specified in the device tree if the default value is incorrect. +* Note that 0 is a valid value.
Minor nit. Can you follow the kernel-doc format for brief/long description
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
Quoted 56 lines
drivers/usb/dwc3/core.c +26
-0+* +* @dwc3: Pointer to our controller context structure +*/ +static void dwc3_ref_clk_fladj (struct dwc3 *dwc) +{ +u32 reg; +u32 reg_new; + + if (DWC3_VER_IS_PRIOR(DWC3, 250A)) +return ; + +if (!dwc->ref_clk_fladj_set) +return ; + + reg =dwc3_readl (dwc->regs,DWC3_GFLADJ ); + reg_new = reg & ~DWC3_GFLADJ_REFCLK_FLADJ_MASK ; + reg_new |=FIELD_PREP (DWC3_GFLADJ_REFCLK_FLADJ_MASK , dwc->ref_clk_fladj); +if (reg_new != reg) +dwc3_writel (dwc->regs,DWC3_GFLADJ , reg_new); +} + +/** * dwc3_free_one_event_buffer - Frees one event buffer * @dwc: Pointer to our controller context structure @@ -1033,6 +1064,7 @@ static int dwc3_core_init(struct dwc3 *dwc)/* Adjust Reference Clock Period */ dwc3_ref_clk_period (dwc); +dwc3_ref_clk_fladj (dwc);dwc3_set_incr_burst_type (dwc);@@ -1418,6 +1450,9 @@ static void dwc3_get_properties(struct dwc3 *dwc) &dwc->fladj);device_property_read_u32 (dev,"snps,ref-clock-period-ns" , &dwc->ref_clk_per); +if (!device_property_read_u32 (dev,"snps,ref-clock-fladj" , + &dwc->ref_clk_fladj)) + dwc->ref_clk_fladj_set = true; dwc->dis_metastability_quirk =device_property_read_bool (dev,"snps,dis_metastability_quirk" );drivers/usb/dwc3/core.h +1
-0@@ -388,6 +388,7 @@/* Global Frame Length Adjustment Register */ #define DWC3_GFLADJ_30MHZ_SDBND_SEL BIT(7)#define DWC3_GFLADJ_30MHZ_MASK 0x3f +#define DWC3_GFLADJ_REFCLK_FLADJ_MASK 0x3fff00/* Global User Control Register*/ #define DWC3_GUCTL_REFCLKPER_MASK 0xffc00000
drivers/usb/dwc3/core.h struct dwc3 { · line 1171
Quoted 5 lines
drivers/usb/dwc3/core.h +2
-0@@ -1166,6 +1167,8 @@ struct dwc3 {u32 fladj;u32 ref_clk_per; +bool ref_clk_fladj_set; +u32 ref_clk_fladj;
Can you also document these new struct members.
drivers/usb/dwc3/core.h struct dwc3 { · line 1174
Quoted 3 lines
drivers/usb/dwc3/core.h +0
-0u32 irq_gadget;u32 otg_irq;u32 current_otg_role;
For this patch:
Thanks!
Thinh
PATCH v2 5/5 arm64: dts: zynqmp: Add DWC3 USB reference clock period configuration
In reply to Robert HancockSet the reference clock period and FLADJ fields in the DWC3 USB driver to 50ns with no fractional portion to match the ZynqMP configuration.
--- arch/arm64/boot/dts/xilinx/zynqmp.dtsi | 4 ++++ 1 file changed, 4 insertions(+)
arch/arm64/boot/dts/xilinx/zynqmp.dtsi +4 -0
@@ -828,6 +828,8 @@ dwc3_0: usb@fe200000 { #stream-id-cells = <1>; iommus = <&smmu 0x860>; snps,quirk-frame-length-adjustment = <0x20>; + snps,ref-clock-period-ns = <50>; + snps,ref-clock-fladj = <0>; /* dma-coherent; */ }; };
@@ -855,6 +857,8 @@ dwc3_1: usb@fe300000 { #stream-id-cells = <1>; iommus = <&smmu 0x861>; snps,quirk-frame-length-adjustment = <0x20>; + snps,ref-clock-period-ns = <50>; + snps,ref-clock-fladj = <0>; /* dma-coherent; */ }; };
Signature · 1 line
2.31.1