diff mbox

[v2,1/2] usb: dwc2: host: Fix missing device insertions

Message ID 87y4dxltzi.fsf@saruman.tx.rr.com
State New
Headers show

Commit Message

Felipe Balbi Nov. 16, 2015, 5:44 p.m. UTC
Hi,

(replying here for the context of why I think this is NOT the smallest
patch possible for the -rc)

Douglas Anderson <dianders@chromium.org> writes:
> If you've got your interrupt signals bouncing a bit as you insert your

> USB device, you might end up in a state when the device is connected but

> the driver doesn't know it.

>

> Specifically, the observed order is:

>  1. hardware sees connect

>  2. hardware sees disconnect

>  3. hardware sees connect

>  4. dwc2_port_intr() - clears connect interrupt

>  5. dwc2_handle_common_intr() - calls dwc2_hcd_disconnect()

>

> Now you'll be stuck with the cable plugged in and no further interrupts

> coming in but the driver will think we're disconnected.

>

> We'll fix this by checking for the missing connect interrupt and

> re-connecting after the disconnect is posted.  We don't skip the

> disconnect because if there is a transitory disconnect we really want to

> de-enumerate and re-enumerate.

>

> Signed-off-by: Douglas Anderson <dianders@chromium.org>

> ---

> Changes in v2:

> - Don't reconnect when called from _dwc2_hcd_stop() (John Youn)

>

>  drivers/usb/dwc2/core.h      |  6 ++++--

>  drivers/usb/dwc2/core_intr.c |  4 ++--

>  drivers/usb/dwc2/hcd.c       | 40 ++++++++++++++++++++++++++++++++++++++--

>  drivers/usb/dwc2/hcd_intr.c  |  6 +-----

>  4 files changed, 45 insertions(+), 11 deletions(-)

>

> diff --git a/drivers/usb/dwc2/core.h b/drivers/usb/dwc2/core.h

> index a66d3cb62b65..daa1c342cdac 100644

> --- a/drivers/usb/dwc2/core.h

> +++ b/drivers/usb/dwc2/core.h

> @@ -1154,12 +1154,14 @@ static inline int dwc2_hsotg_set_test_mode(struct dwc2_hsotg *hsotg,

>  

>  #if IS_ENABLED(CONFIG_USB_DWC2_HOST) || IS_ENABLED(CONFIG_USB_DWC2_DUAL_ROLE)

>  extern int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg);

> -extern void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg);

> +extern void dwc2_hcd_connect(struct dwc2_hsotg *hsotg);

> +extern void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force);


this 'force' parameter is new and looks unnecessary for the -rc.

>  extern void dwc2_hcd_start(struct dwc2_hsotg *hsotg);

>  #else

>  static inline int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg)

>  { return 0; }

> -static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg) {}

> +static inline void dwc2_hcd_connect(struct dwc2_hsotg *hsotg) {}

> +static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force) {}

>  static inline void dwc2_hcd_start(struct dwc2_hsotg *hsotg) {}

>  static inline void dwc2_hcd_remove(struct dwc2_hsotg *hsotg) {}

>  static inline int dwc2_hcd_init(struct dwc2_hsotg *hsotg, int irq)

> diff --git a/drivers/usb/dwc2/core_intr.c b/drivers/usb/dwc2/core_intr.c

> index 27daa42788b1..61601d16e233 100644

> --- a/drivers/usb/dwc2/core_intr.c

> +++ b/drivers/usb/dwc2/core_intr.c

> @@ -239,7 +239,7 @@ static void dwc2_handle_otg_intr(struct dwc2_hsotg *hsotg)

>  			dev_dbg(hsotg->dev, "a_suspend->a_peripheral (%d)\n",

>  				hsotg->op_state);

>  			spin_unlock(&hsotg->lock);

> -			dwc2_hcd_disconnect(hsotg);

> +			dwc2_hcd_disconnect(hsotg, false);


because force is unnecessary (it seems to be just an optimization to
me), this change is unnecessary.

>  			spin_lock(&hsotg->lock);

>  			hsotg->op_state = OTG_STATE_A_PERIPHERAL;

>  		} else {

> @@ -401,7 +401,7 @@ static void dwc2_handle_disconnect_intr(struct dwc2_hsotg *hsotg)

>  		dwc2_op_state_str(hsotg));

>  

>  	if (hsotg->op_state == OTG_STATE_A_HOST)

> -		dwc2_hcd_disconnect(hsotg);

> +		dwc2_hcd_disconnect(hsotg, false);



and so is this.

>  	dwc2_writel(GINTSTS_DISCONNINT, hsotg->regs + GINTSTS);

>  }

> diff --git a/drivers/usb/dwc2/hcd.c b/drivers/usb/dwc2/hcd.c

> index e79baf73c234..e208eac7ff57 100644

> --- a/drivers/usb/dwc2/hcd.c

> +++ b/drivers/usb/dwc2/hcd.c

> @@ -268,15 +268,33 @@ static void dwc2_hcd_cleanup_channels(struct dwc2_hsotg *hsotg)

>  }

>  

>  /**

> + * dwc2_hcd_connect() - Handles connect of the HCD

> + *

> + * @hsotg: Pointer to struct dwc2_hsotg

> + *

> + * Must be called with interrupt disabled and spinlock held

> + */

> +void dwc2_hcd_connect(struct dwc2_hsotg *hsotg)

> +{

> +	if (hsotg->lx_state != DWC2_L0)

> +		usb_hcd_resume_root_hub(hsotg->priv);

> +

> +	hsotg->flags.b.port_connect_status_change = 1;

> +	hsotg->flags.b.port_connect_status = 1;

> +}


you make no mention of why this is needed. This is basically a refactor,
not a fix.

> +/**

>   * dwc2_hcd_disconnect() - Handles disconnect of the HCD

>   *

>   * @hsotg: Pointer to struct dwc2_hsotg

> + * @force: If true, we won't try to reconnect even if we see device connected.

>   *

>   * Must be called with interrupt disabled and spinlock held

>   */

> -void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)

> +void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force)


as mentioned before, unnecessary 'force' parameter.

> @@ -315,6 +333,24 @@ void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)

>  		dwc2_hcd_cleanup_channels(hsotg);

>  

>  	dwc2_host_disconnect(hsotg);

> +

> +	/*

> +	 * Add an extra check here to see if we're actually connected but

> +	 * we don't have a detection interrupt pending.  This can happen if:

> +	 *   1. hardware sees connect

> +	 *   2. hardware sees disconnect

> +	 *   3. hardware sees connect

> +	 *   4. dwc2_port_intr() - clears connect interrupt

> +	 *   5. dwc2_handle_common_intr() - calls here

> +	 *

> +	 * Without the extra check here we will end calling disconnect

> +	 * and won't get any future interrupts to handle the connect.

> +	 */

> +	if (!force) {

> +		hprt0 = dwc2_readl(hsotg->regs + HPRT0);

> +		if (!(hprt0 & HPRT0_CONNDET) && (hprt0 & HPRT0_CONNSTS))

> +			dwc2_hcd_connect(hsotg);


what's inside this 'force' branch is what you really need to fix the
problem, right ? It seems like for the -rc cycle, all you need is:


This has some code duplication and it'll *always* check for CONNDET |
CONNSTS, but that's okay for the -rc. Follow-up patches (for v4.5 merge
window) can refactor the code duplication and introduce 'force'
parameter.

> @@ -2365,7 +2401,7 @@ static void _dwc2_hcd_stop(struct usb_hcd *hcd)

>  

>  	spin_lock_irqsave(&hsotg->lock, flags);

>  	/* Ensure hcd is disconnected */

> -	dwc2_hcd_disconnect(hsotg);

> +	dwc2_hcd_disconnect(hsotg, true);


unnecessary change.

>  	dwc2_hcd_stop(hsotg);

>  	hsotg->lx_state = DWC2_L3;

>  	hcd->state = HC_STATE_HALT;

> diff --git a/drivers/usb/dwc2/hcd_intr.c b/drivers/usb/dwc2/hcd_intr.c

> index bda0b21b850f..03504ac2fecc 100644

> --- a/drivers/usb/dwc2/hcd_intr.c

> +++ b/drivers/usb/dwc2/hcd_intr.c

> @@ -350,11 +350,7 @@ static void dwc2_port_intr(struct dwc2_hsotg *hsotg)

>  		dev_vdbg(hsotg->dev,

>  			 "--Port Interrupt HPRT0=0x%08x Port Connect Detected--\n",

>  			 hprt0);

> -		if (hsotg->lx_state != DWC2_L0)

> -			usb_hcd_resume_root_hub(hsotg->priv);

> -

> -		hsotg->flags.b.port_connect_status_change = 1;

> -		hsotg->flags.b.port_connect_status = 1;

> +		dwc2_hcd_connect(hsotg);


unnecessary change.

Do you agree  or do you think 'force' is really necessary for this fix ?

-- 
balbi

Comments

Felipe Balbi Nov. 16, 2015, 6:22 p.m. UTC | #1
Hi,

Doug Anderson <dianders@chromium.org> writes:
> Felipe,

>

> On Mon, Nov 16, 2015 at 9:44 AM, Felipe Balbi <balbi@ti.com> wrote:

>>>  extern void dwc2_hcd_start(struct dwc2_hsotg *hsotg);

>>>  #else

>>>  static inline int dwc2_hcd_get_frame_number(struct dwc2_hsotg *hsotg)

>>>  { return 0; }

>>> -static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg) {}

>>> +static inline void dwc2_hcd_connect(struct dwc2_hsotg *hsotg) {}

>>> +static inline void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg, bool force) {}

>>>  static inline void dwc2_hcd_start(struct dwc2_hsotg *hsotg) {}

>>>  static inline void dwc2_hcd_remove(struct dwc2_hsotg *hsotg) {}

>>>  static inline int dwc2_hcd_init(struct dwc2_hsotg *hsotg, int irq)

>>> diff --git a/drivers/usb/dwc2/core_intr.c b/drivers/usb/dwc2/core_intr.c

>>> index 27daa42788b1..61601d16e233 100644

>>> --- a/drivers/usb/dwc2/core_intr.c

>>> +++ b/drivers/usb/dwc2/core_intr.c

>>> @@ -239,7 +239,7 @@ static void dwc2_handle_otg_intr(struct dwc2_hsotg *hsotg)

>>>                       dev_dbg(hsotg->dev, "a_suspend->a_peripheral (%d)\n",

>>>                               hsotg->op_state);

>>>                       spin_unlock(&hsotg->lock);

>>> -                     dwc2_hcd_disconnect(hsotg);

>>> +                     dwc2_hcd_disconnect(hsotg, false);

>>

>> because force is unnecessary (it seems to be just an optimization to

>> me), this change is unnecessary.

>

> I added "force" in v2 of the patch in response to John's feedback to

> v1.  He pointed out that when you unload the module when you have a

> device connected that my v1 patch would not properly disconnect the

> device (or, rather, it would disconnect it and then reconnect it).

>

> That's why _dwc2_hcd_stop() calls dwc2_hcd_disconnect() with a force

> of "true".


There's no mention of this in commit log. It would be great to add a:

"while at that, also make sure that we don't try to detect a device on
module unload because of foo bar baz as pointed out by John Youn".

Or something along these lines.

>>>  /**

>>> + * dwc2_hcd_connect() - Handles connect of the HCD

>>> + *

>>> + * @hsotg: Pointer to struct dwc2_hsotg

>>> + *

>>> + * Must be called with interrupt disabled and spinlock held

>>> + */

>>> +void dwc2_hcd_connect(struct dwc2_hsotg *hsotg)

>>> +{

>>> +     if (hsotg->lx_state != DWC2_L0)

>>> +             usb_hcd_resume_root_hub(hsotg->priv);

>>> +

>>> +     hsotg->flags.b.port_connect_status_change = 1;

>>> +     hsotg->flags.b.port_connect_status = 1;

>>> +}

>>

>> you make no mention of why this is needed. This is basically a refactor,

>> not a fix.

>

> This new function is called from two places now, isn't it?

>

> Basically this is a little bit of code that used to be directly in

> dwc2_port_intr().  I still want it there, but I also want to call the

> same bit of code after a disconnect if I detect that the device has

> been inserted again.


I got that :-) But it's not mentioned in commit and it's apparently
unnecessary for fixing the bug :-) Another "we're also adding a new
hsotg_disconnect() function by means of refactoring to avoid code
duplication" would've been enough.

>>> @@ -315,6 +333,24 @@ void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)

>>>               dwc2_hcd_cleanup_channels(hsotg);

>>>

>>>       dwc2_host_disconnect(hsotg);

>>> +

>>> +     /*

>>> +      * Add an extra check here to see if we're actually connected but

>>> +      * we don't have a detection interrupt pending.  This can happen if:

>>> +      *   1. hardware sees connect

>>> +      *   2. hardware sees disconnect

>>> +      *   3. hardware sees connect

>>> +      *   4. dwc2_port_intr() - clears connect interrupt

>>> +      *   5. dwc2_handle_common_intr() - calls here

>>> +      *

>>> +      * Without the extra check here we will end calling disconnect

>>> +      * and won't get any future interrupts to handle the connect.

>>> +      */

>>> +     if (!force) {

>>> +             hprt0 = dwc2_readl(hsotg->regs + HPRT0);

>>> +             if (!(hprt0 & HPRT0_CONNDET) && (hprt0 & HPRT0_CONNSTS))

>>> +                     dwc2_hcd_connect(hsotg);

>>

>> what's inside this 'force' branch is what you really need to fix the

>> problem, right ? It seems like for the -rc cycle, all you need is:

>>

>> diff --git a/drivers/usb/dwc2/hcd.c b/drivers/usb/dwc2/hcd.c

>> index 571c21727ff9..967d1e686efe 100644

>> --- a/drivers/usb/dwc2/hcd.c

>> +++ b/drivers/usb/dwc2/hcd.c

>> @@ -276,6 +276,7 @@ static void dwc2_hcd_cleanup_channels(struct dwc2_hsotg *hsotg)

>>   */

>>  void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)

>>  {

>> +       u32 hprt0;

>>         u32 intr;

>>

>>         /* Set status flags for the hub driver */

>> @@ -315,6 +316,15 @@ void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)

>>                 dwc2_hcd_cleanup_channels(hsotg);

>>

>>         dwc2_host_disconnect(hsotg);

>> +

>> +       hprt0 = dwc2_readl(hsotg->regs + HPRT0);

>> +       if (!(hprt0 & (HPRT0_CONNDET | HPRT0_CONNSTS))) {

>> +               if (hsotg->lx_state != DWC2_L0)

>> +                       usb_hcd_resume_roothub(hsotg->priv);

>> +

>> +               hsotg->flags.b.port_connect_status_change = 1;

>> +               hsotg->flags.b.port_connect_status = 1;

>> +       }

>

> I'd really rather not add the duplication unless you insist.  To me it

> makes it clearer to include the (small) refactor in the same patch.

>

> If the refactor makes this change too big for an RC, then it's OK with

> me to just skip this for the RC.  It's not fixing a regression or

> anything.  I have no requirements to have this land in 4.4.  It fixes

> a bug and I thought that the fix was pretty small and safe (despite

> having a diffstat that's bigger than the bare minimum).  I will leave

> it to your judgement.


let's at least modify commit log to make all these extra changes clear
that they are needed because of reason (a) or (b) or whatever. If you
just send a patch doing much more than it apparently should without no
mention as to why it was done this way, I can't know for sure those
changes are needed; next thing you know, Greg refuses to apply my pull
request because the change is too large :-)

We don't want that to happen :-)

>>> diff --git a/drivers/usb/dwc2/hcd_intr.c b/drivers/usb/dwc2/hcd_intr.c

>>> index bda0b21b850f..03504ac2fecc 100644

>>> --- a/drivers/usb/dwc2/hcd_intr.c

>>> +++ b/drivers/usb/dwc2/hcd_intr.c

>>> @@ -350,11 +350,7 @@ static void dwc2_port_intr(struct dwc2_hsotg *hsotg)

>>>               dev_vdbg(hsotg->dev,

>>>                        "--Port Interrupt HPRT0=0x%08x Port Connect Detected--\n",

>>>                        hprt0);

>>> -             if (hsotg->lx_state != DWC2_L0)

>>> -                     usb_hcd_resume_root_hub(hsotg->priv);

>>> -

>>> -             hsotg->flags.b.port_connect_status_change = 1;

>>> -             hsotg->flags.b.port_connect_status = 1;

>>> +             dwc2_hcd_connect(hsotg);

>>

>> unnecessary change.

>>

>> Do you agree  or do you think 'force' is really necessary for this fix ?

>

> As per above, John thought it was a good idea to really make the

> disconnect happen upon module unload.  If you disagree then we could

> probably just totally remove the "dwc2_hcd_disconnect(hsotg);" from

> the _dwc2_hcd_stop() function.


see above.

thanks

-- 
balbi
Felipe Balbi Nov. 16, 2015, 7:09 p.m. UTC | #2
hi,

Doug Anderson <dianders@chromium.org> writes:
> Felipe,

>

> On Mon, Nov 16, 2015 at 10:22 AM, Felipe Balbi <balbi@ti.com> wrote:

>>> I added "force" in v2 of the patch in response to John's feedback to

>>> v1.  He pointed out that when you unload the module when you have a

>>> device connected that my v1 patch would not properly disconnect the

>>> device (or, rather, it would disconnect it and then reconnect it).

>>>

>>> That's why _dwc2_hcd_stop() calls dwc2_hcd_disconnect() with a force

>>> of "true".

>>

>> There's no mention of this in commit log. It would be great to add a:

>>

>> "while at that, also make sure that we don't try to detect a device on

>> module unload because of foo bar baz as pointed out by John Youn".

>>

>> Or something along these lines.

>

> ...well, except that it's not new behavior.  In other words:

>

> * Without my patch at all: we don't try to detect a device on module unload.

>

> * With my v1 patch: we (incorrectly) did try to detect a device on

> module unload.

>

> * With my v2 patch: we're back to not trying to detect a device on

> module unload.

>

> In other words: my v2 patch (correctly) doesn't change the behavior on

> module unload.  That's why I didn't mention it in the commit message.

> It's in the "v2" changelog though.

>

>

> I'll try to come up with something for the commit message though.  See

> below for new proposed commit message.

>

>

>>>> you make no mention of why this is needed. This is basically a refactor,

>>>> not a fix.

>>>

>>> This new function is called from two places now, isn't it?

>>>

>>> Basically this is a little bit of code that used to be directly in

>>> dwc2_port_intr().  I still want it there, but I also want to call the

>>> same bit of code after a disconnect if I detect that the device has

>>> been inserted again.

>>

>> I got that :-) But it's not mentioned in commit and it's apparently

>> unnecessary for fixing the bug :-) Another "we're also adding a new

>> hsotg_disconnect() function by means of refactoring to avoid code

>> duplication" would've been enough.

>

> OK, sure.

>

>

>>> I'd really rather not add the duplication unless you insist.  To me it

>>> makes it clearer to include the (small) refactor in the same patch.

>>>

>>> If the refactor makes this change too big for an RC, then it's OK with

>>> me to just skip this for the RC.  It's not fixing a regression or

>>> anything.  I have no requirements to have this land in 4.4.  It fixes

>>> a bug and I thought that the fix was pretty small and safe (despite

>>> having a diffstat that's bigger than the bare minimum).  I will leave

>>> it to your judgement.

>>

>> let's at least modify commit log to make all these extra changes clear

>> that they are needed because of reason (a) or (b) or whatever. If you

>> just send a patch doing much more than it apparently should without no

>> mention as to why it was done this way, I can't know for sure those

>> changes are needed; next thing you know, Greg refuses to apply my pull

>> request because the change is too large :-)

>>

>> We don't want that to happen :-)

>

> Totally understand.  It's your butt on the line for the pull request

> to Greg, so definitely want to make sure you're comfortable with

> anything you pass on.  As always I definitely appreciate your reviews

> and your time.

>

>

> How about if we just add a "Notes" to the end of the patch

> description.  I can repost a patch or you can feel free to change the

> description as per below (just let me know).  ...so in total:

>

> ---

>

> usb: dwc2: host: Fix missing device insertions

>

> If you've got your interrupt signals bouncing a bit as you insert your

> USB device, you might end up in a state when the device is connected but

> the driver doesn't know it.

>

> Specifically, the observed order is:

>  1. hardware sees connect

>  2. hardware sees disconnect

>  3. hardware sees connect

>  4. dwc2_port_intr() - clears connect interrupt

>  5. dwc2_handle_common_intr() - calls dwc2_hcd_disconnect()

>

> Now you'll be stuck with the cable plugged in and no further interrupts

> coming in but the driver will think we're disconnected.

>

> We'll fix this by checking for the missing connect interrupt and

> re-connecting after the disconnect is posted.  We don't skip the

> disconnect because if there is a transitory disconnect we really want to

> de-enumerate and re-enumerate.

>

> Notes:

>

> 1. As part of this change we add a "force" parameter to

>    dwc2_hcd_disconnect() so that when we're unloading the module we

>    avoid the new behavior.  The need for this was pointed out by John

>    Youn.

> 2. The bit of code needed at the end of dwc2_hcd_disconnect() is

>    exactly the same bit of code from dwc2_port_intr().  To avoid

>    duplication, we refactor that code out into a new function

>    dwc2_hcd_connect().


this should be enough, thanks for being so responsive

-- 
balbi
diff mbox

Patch

diff --git a/drivers/usb/dwc2/hcd.c b/drivers/usb/dwc2/hcd.c
index 571c21727ff9..967d1e686efe 100644
--- a/drivers/usb/dwc2/hcd.c
+++ b/drivers/usb/dwc2/hcd.c
@@ -276,6 +276,7 @@  static void dwc2_hcd_cleanup_channels(struct dwc2_hsotg *hsotg)
  */
 void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)
 {
+	u32 hprt0;
 	u32 intr;
 
 	/* Set status flags for the hub driver */
@@ -315,6 +316,15 @@  void dwc2_hcd_disconnect(struct dwc2_hsotg *hsotg)
 		dwc2_hcd_cleanup_channels(hsotg);
 
 	dwc2_host_disconnect(hsotg);
+
+	hprt0 = dwc2_readl(hsotg->regs + HPRT0);
+	if (!(hprt0 & (HPRT0_CONNDET | HPRT0_CONNSTS))) {
+		if (hsotg->lx_state != DWC2_L0)
+			usb_hcd_resume_roothub(hsotg->priv);
+
+		hsotg->flags.b.port_connect_status_change = 1;
+		hsotg->flags.b.port_connect_status = 1;
+	}
 }
 
 /**