usb: dwc2: Fix the write to W1C fields in HPRT register
PATCH v3 1/1 usb: dwc2: Fix the write to W1C fields in HPRT register
From: Teik Heng Chong <[email protected]>
Fix the write to the HPRT register which treat W1C fields
as if they were mere RW. This leads to unintended clearing of such fields
This bug was found during the testing on Simics model. Referring to specification DesignWare Cores USB 2.0 Hi-Speed On-The-Go (OTG) Databook (3.30a)"5.3.4.8 Host Port Control and Status Register (HPRT)", the HPRT.PrtPwr is cleared by this mistake. In the Linux driver (contrary to U-Boot), HPRT is always read using dwc2_read_hprt0 helper function which clears W1C bits. So after write back those bits are zeroes.
---
V2->V3
- update commit message
--- drivers/usb/host/dwc2.c | 34 ++++++++-------------------------- drivers/usb/host/dwc2.h | 4 ++++ 2 files changed, 12 insertions(+), 26 deletions(-)
drivers/usb/host/dwc2.c +8 -26
@@ -315,9 +315,7 @@ static void dwc_otg_core_host_init(struct udevice *dev,/* Turn on the vbus power. */ if (readl (®s->gintsts) &DWC2_GINTSTS_CURMODE_HOST ) { - hprt0 =readl (®s->hprt0); - hprt0 &= ~(DWC2_HPRT0_PRTENA |DWC2_HPRT0_PRTCONNDET ); - hprt0 &= ~(DWC2_HPRT0_PRTENCHNG |DWC2_HPRT0_PRTOVRCURRCHNG ); + hprt0 =readl (®s->hprt0) & ~DWC2_HPRT0_W1C_MASK ;if (!(hprt0 &DWC2_HPRT0_PRTPWR )) { hprt0 |=DWC2_HPRT0_PRTPWR ;writel (hprt0, ®s->hprt0);
@@ -748,7 +746,7 @@ static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,case (USB_REQ_CLEAR_FEATURE <<8 ) |USB_RECIP_OTHER |USB_TYPE_CLASS :switch (wValue) {case USB_PORT_FEAT_C_CONNECTION : -setbits_le32 (®s->hprt0,DWC2_HPRT0_PRTCONNDET ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTCONNDET );break ; }break ;
@@ -759,21 +757,13 @@ static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,break ;case USB_PORT_FEAT_RESET : -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST );mdelay (50 ); -clrbits_le32 (®s->hprt0,DWC2_HPRT0_PRTRST ); +clrbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK |DWC2_HPRT0_PRTRST );break ;case USB_PORT_FEAT_POWER : -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST );break ;case USB_PORT_FEAT_ENABLE :
@@ -1213,14 +1203,9 @@ static int dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)dwc_otg_core_host_init (dev, regs); } -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET |DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST );mdelay (50 ); -clrbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA |DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG |DWC2_HPRT0_PRTOVRCURRCHNG | -DWC2_HPRT0_PRTRST ); +clrbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK |DWC2_HPRT0_PRTRST );for (i =0 ; i <MAX_DEVICE ; i++) {for (j =0 ; j <MAX_ENDPOINT ; j++) {
@@ -1246,10 +1231,7 @@ static int dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)static void dwc2_uninit_common (struct dwc2_core_regs *regs) {/* Put everything in reset. */ -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET |DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST ); }#if !CONFIG_IS_ENABLED (DM_USB )
drivers/usb/host/dwc2.h +4 -0
@@ -543,6 +543,10 @@ struct dwc2_core_regs {#define DWC2_HPRT0_PRTSPD_LOW (2 << 17)#define DWC2_HPRT0_PRTSPD_MASK (0x3 << 17)#define DWC2_HPRT0_PRTSPD_OFFSET 17 +#define DWC2_HPRT0_W1C_MASK (DWC2_HPRT0_PRTCONNDET | \ + DWC2_HPRT0_PRTENA | \ + DWC2_HPRT0_PRTENCHNG | \ + DWC2_HPRT0_PRTOVRCURRCHNG)#define DWC2_HAINT_CH0 (1 << 0)#define DWC2_HAINT_CH0_OFFSET 0#define DWC2_HAINT_CH1 (1 << 1)
Signature · 1 line
2.25.1
Marek Vasut
AppliedQuoted 106 lines · On 6/21/23 05:13, [email protected] wrote:
From: Teik Heng Chong <[email protected]>
Fix the write to the HPRT register which treat W1C fields
as if they were mere RW. This leads to unintended clearing of such fieldsThis bug was found during the testing on Simics model. Referring to specification DesignWare Cores USB 2.0 Hi-Speed On-The-Go (OTG) Databook (3.30a)"5.3.4.8 Host Port Control and Status Register (HPRT)", the HPRT.PrtPwr is cleared by this mistake. In the Linux driver (contrary to U-Boot), HPRT is always read using
dwc2_read_hprt0helper function which clears W1C bits. So after write back those bits are zeroes.Signed-off-by Teik Heng Chong <[email protected]>---
V2->V3
- update commit message--- drivers/usb/host/dwc2.c | 34 ++++++++-------------------------- drivers/usb/host/dwc2.h | 4 ++++ 2 files changed, 12 insertions(+), 26 deletions(-)drivers/usb/host/dwc2.c +8
-26@@ -315,9 +315,7 @@ static void dwc_otg_core_host_init(struct udevice *dev,/* Turn on the vbus power. */ if (readl (®s->gintsts) &DWC2_GINTSTS_CURMODE_HOST ) { - hprt0 =readl (®s->hprt0); - hprt0 &= ~(DWC2_HPRT0_PRTENA |DWC2_HPRT0_PRTCONNDET ); - hprt0 &= ~(DWC2_HPRT0_PRTENCHNG |DWC2_HPRT0_PRTOVRCURRCHNG ); + hprt0 =readl (®s->hprt0) & ~DWC2_HPRT0_W1C_MASK ;if (!(hprt0 &DWC2_HPRT0_PRTPWR )) { hprt0 |=DWC2_HPRT0_PRTPWR ;writel (hprt0, ®s->hprt0);@@ -748,7 +746,7 @@ static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,case (USB_REQ_CLEAR_FEATURE <<8 ) |USB_RECIP_OTHER |USB_TYPE_CLASS :switch (wValue) {case USB_PORT_FEAT_C_CONNECTION : -setbits_le32 (®s->hprt0,DWC2_HPRT0_PRTCONNDET ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTCONNDET );break ; }break ;@@ -759,21 +757,13 @@ static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,break ;case USB_PORT_FEAT_RESET : -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST );mdelay (50 ); -clrbits_le32 (®s->hprt0,DWC2_HPRT0_PRTRST ); +clrbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK |DWC2_HPRT0_PRTRST );break ;case USB_PORT_FEAT_POWER : -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST );break ;case USB_PORT_FEAT_ENABLE :@@ -1213,14 +1203,9 @@ static int dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)dwc_otg_core_host_init (dev, regs); } -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET |DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST );mdelay (50 ); -clrbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA |DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG |DWC2_HPRT0_PRTOVRCURRCHNG | -DWC2_HPRT0_PRTRST ); +clrbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK |DWC2_HPRT0_PRTRST );for (i =0 ; i <MAX_DEVICE ; i++) {for (j =0 ; j <MAX_ENDPOINT ; j++) {@@ -1246,10 +1231,7 @@ static int dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)static void dwc2_uninit_common (struct dwc2_core_regs *regs) {/* Put everything in reset. */ -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET |DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK ,DWC2_HPRT0_PRTRST ); }#if !CONFIG_IS_ENABLED (DM_USB )drivers/usb/host/dwc2.h +0
-0
drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 552
Quoted 10 lines
drivers/usb/host/dwc2.h +4
-0@@ -543,6 +543,10 @@ struct dwc2_core_regs {#define DWC2_HPRT0_PRTSPD_LOW (2 << 17)#define DWC2_HPRT0_PRTSPD_MASK (0x3 << 17)#define DWC2_HPRT0_PRTSPD_OFFSET 17 +#define DWC2_HPRT0_W1C_MASK (DWC2_HPRT0_PRTCONNDET | \ + DWC2_HPRT0_PRTENA | \ + DWC2_HPRT0_PRTENCHNG | \ + DWC2_HPRT0_PRTOVRCURRCHNG)#define DWC2_HAINT_CH0 (1 << 0)#define DWC2_HAINT_CH0_OFFSET 0#define DWC2_HAINT_CH1 (1 << 1)
Applied to usb/master, thanks.
Quoted 157 lines
-----Original Message-----
From: Marek Vasut <[email protected]>
Sent: Wednesday, 21 June, 2023 7:16 PM
To: Chong, Teik Heng <[email protected]>; [email protected]
Cc: Jagan Teki <[email protected]>; Vignesh R <[email protected]>; Simon <[email protected]>; Kris <[email protected]>; Chee, Tien Fong <[email protected]>; Hea, Kok Kiang <[email protected]>; Lokanathan, Raaj <[email protected]>; Maniyam, Dinesh <[email protected]>; Ng, Boon Khai <[email protected]>; Yuslaimi, Alif Zakuan <[email protected]>; Zamri, Muhammad Hazim Izzat <[email protected]>; Lim, Jit Loon <[email protected]>; Tang, Sieu Mun <[email protected]>
Subject: Re: [PATCH v3 1/1] usb: dwc2: Fix the write to W1C fields in HPRT registerQuoted 11 lines · On 6/21/23 05:13, [email protected] wrote:
From: Teik Heng Chong <[email protected]>
Fix the write to the HPRT register which treat W1C fields as if they were mere RW. This leads to unintended clearing of such fields
This bug was found during the testing on Simics model. Referring to specification DesignWare Cores USB 2.0 Hi-Speed On-The-Go (OTG) Databook (3.30a)"5.3.4.8 Host Port Control and Status Register (HPRT)", the HPRT.PrtPwr is cleared by this mistake. In the Linux driver (contrary to U-Boot), HPRT is always read using
dwc2_read_hprt0helper function which clears W1C bits. So after write back those bits arezeroes.
Quoted 17 lines
Signed-off-by Teik Heng Chong <[email protected]>---
V2->V3
- update commit message--- drivers/usb/host/dwc2.c | 34 ++++++++-------------------------- drivers/usb/host/dwc2.h | 4 ++++ 2 files changed, 12 insertions(+), 26 deletions(-)drivers/usb/host/dwc2.c index renamed from drivers/usb/host/dwc2.c +0
-0
23060fc369..9818f9be94100644drivers/usb/host/dwc2.c static void dwc_otg_core_host_init(struct udevice · line 320
Quoted 6 lines
drivers/usb/host/dwc2.c +0
-2@@ -315,9 +315,7 @@ static void dwc_otg_core_host_init(struct udevice *dev,/* Turn on the vbus power. */ if (readl(®s->gintsts) & DWC2_GINTSTS_CURMODE_HOST) { - hprt0 =readl (®s->hprt0); - hprt0 &= ~(DWC2_HPRT0_PRTENA |
DWC2_HPRT0_PRTCONNDET);drivers/usb/host/dwc2.c static void dwc_otg_core_host_init(struct udevice · line 321
Quoted 1 line
drivers/usb/host/dwc2.c +0
-1- hprt0 &= ~(DWC2_HPRT0_PRTENCHNG |
DWC2_HPRT0_PRTOVRCURRCHNG);drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct
Quoted 5 lines
drivers/usb/host/dwc2.c +1
-0+ hprt0 =readl (®s->hprt0) & ~DWC2_HPRT0_W1C_MASK ;if (!(hprt0 &DWC2_HPRT0_PRTPWR )) { hprt0 |=DWC2_HPRT0_PRTPWR ;writel(hprt0, ®s->hprt0);drivers/usb/host/dwc2.c +0
-0@@ -748,7 +746,7 @@ static int dwc_otg_submit_rh_msg_out(struct
dwc2_priv*priv,drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct · line 746
Quoted 1 line
drivers/usb/host/dwc2.c +0
-0case (USB_REQ_CLEAR_FEATURE << 8) | USB_RECIP_OTHER |
USB_TYPE_CLASS:drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,
Quoted 3 lines
drivers/usb/host/dwc2.c +0
-1switch (wValue) {case USB_PORT_FEAT_C_CONNECTION : - setbits_le32(®s->hprt0,
DWC2_HPRT0_PRTCONNDET);drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct · line 749
Quoted 1 line
drivers/usb/host/dwc2.c +1
-0+ clrsetbits_le32(®s->hprt0,
DWC2_HPRT0_W1C_MASK,drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct
Quoted 5 lines
drivers/usb/host/dwc2.c +1
-0+DWC2_HPRT0_PRTCONNDET);break ; }break ;@@ -759,21 +757,13 @@ static int dwc_otg_submit_rh_msg_out(struct
dwc2_priv*priv,drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,
Quoted 9 lines
drivers/usb/host/dwc2.c +1
-5break ;case USB_PORT_FEAT_RESET : -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); + clrsetbits_le32(®s->hprt0,
DWC2_HPRT0_W1C_MASK,Quoted 4 lines
drivers/usb/host/dwc2.c +2
-1+DWC2_HPRT0_PRTRST);mdelay (50 ); -clrbits_le32 (®s->hprt0,DWC2_HPRT0_PRTRST ); + clrbits_le32(®s->hprt0, DWC2_HPRT0_W1C_MASK |drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,
Quoted 10 lines
drivers/usb/host/dwc2.c +2
-5+DWC2_HPRT0_PRTRST);break ;case USB_PORT_FEAT_POWER : -clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_PRTENA | -DWC2_HPRT0_PRTCONNDET | -DWC2_HPRT0_PRTENCHNG | -DWC2_HPRT0_PRTOVRCURRCHNG , -DWC2_HPRT0_PRTRST ); + clrsetbits_le32(®s->hprt0,
DWC2_HPRT0_W1C_MASK,drivers/usb/host/dwc2.c static int dwc2_init_common(struct udevice *dev,
Quoted 5 lines
drivers/usb/host/dwc2.c +1
-0+DWC2_HPRT0_PRTRST);break ;case USB_PORT_FEAT_ENABLE :@@ -1213,14 +1203,9 @@ static int dwc2_init_common(struct udevice *dev,struct
dwc2_priv*priv)drivers/usb/host/dwc2.c static int dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)
Quoted 5 lines
drivers/usb/host/dwc2.c +0
-2dwc_otg_core_host_init (dev, regs); } - clrsetbits_le32(®s->hprt0, DWC2_HPRT0_PRTENA | - DWC2_HPRT0_PRTCONNDET |
DWC2_HPRT0_PRTENCHNG|drivers/usb/host/dwc2.c static int dwc_otg_submit_rh_msg_out(struct dwc2_priv *priv,
Quoted 6 lines
drivers/usb/host/dwc2.c +2
-3-DWC2_HPRT0_PRTOVRCURRCHNG , - DWC2_HPRT0_PRTRST); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK , +DWC2_HPRT0_PRTRST );mdelay (50 ); - clrbits_le32(®s->hprt0, DWC2_HPRT0_PRTENA |
DWC2_HPRT0_PRTCONNDET|drivers/usb/host/dwc2.c static int dwc2_init_common(struct udevice *dev, · line 1222
Quoted 1 line
drivers/usb/host/dwc2.c +0
-1- DWC2_HPRT0_PRTENCHNG |
DWC2_HPRT0_PRTOVRCURRCHNG|drivers/usb/host/dwc2.c static int dwc2_init_common(struct udevice *dev, · line 1209
Quoted 2 lines
drivers/usb/host/dwc2.c +1
-1- DWC2_HPRT0_PRTRST); + clrbits_le32(®s->hprt0, DWC2_HPRT0_W1C_MASK |
DWC2_HPRT0_PRTRST);drivers/usb/host/dwc2.c static int dwc2_init_common(struct udevice *dev, · line 1211
Quoted 3 lines
drivers/usb/host/dwc2.c +0
-0for (i =0 ; i <MAX_DEVICE ; i++) { for (j = 0; j < MAX_ENDPOINT; j++) { @@ -1246,10 +1231,7 @@static
drivers/usb/host/dwc2.c
Quoted 6 lines
int
dwc2_init_common(struct udevice *dev, struct dwc2_priv *priv)
static voiddwc2_uninit_common(struct dwc2_core_regs *regs){
/* Put everything in reset. */drivers/usb/host/dwc2.c +0
-2- clrsetbits_le32(®s->hprt0, DWC2_HPRT0_PRTENA | - DWC2_HPRT0_PRTCONNDET |
DWC2_HPRT0_PRTENCHNG|Quoted 12 lines
drivers/usb/host/dwc2.c +2
-2-DWC2_HPRT0_PRTOVRCURRCHNG , - DWC2_HPRT0_PRTRST); +clrsetbits_le32 (®s->hprt0,DWC2_HPRT0_W1C_MASK , +DWC2_HPRT0_PRTRST ); }#if !CONFIG_IS_ENABLED (DM_USB )drivers/usb/host/dwc2.h index renamed from drivers/usb/host/dwc2.h +0
-0
a6f562fe60..6f022e33a1100644drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 544
Quoted 2 lines
drivers/usb/host/dwc2.h +0
-0@@ -543,6 +543,10 @@ struct dwc2_core_regs {#define DWC2_HPRT0_PRTSPD_LOW (2 << 17)#define DWC2_HPRT0_PRTSPD_MASK (0x3<< 17)
drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 546
Quoted 2 lines
drivers/usb/host/dwc2.h +1
-0#define DWC2_HPRT0_PRTSPD_OFFSET 17 +#define DWC2_HPRT0_W1C_MASK (DWC2_HPRT0_PRTCONNDET | \drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 547
Quoted 1 line
drivers/usb/host/dwc2.h +1
-0+DWC2_HPRT0_PRTENA | \drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 548
Quoted 1 line
drivers/usb/host/dwc2.h +1
-0+
Quoted 8 lines
DWC2_HPRT0_PRTENCHNG | \drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 549
Quoted 1 line
drivers/usb/host/dwc2.h +1
-0+
DWC2_HPRT0_PRTOVRCURRCHNG)drivers/usb/host/dwc2.h struct dwc2_core_regs { · line 552
Quoted 3 lines
drivers/usb/host/dwc2.h +0
-0#define DWC2_HAINT_CH0 (1 << 0)#define DWC2_HAINT_CH0_OFFSET 0#define DWC2_HAINT_CH1 (1 << 1)Applied to usb/master, thanks.
Thank you.