mbox series

[v10,0/5] Add function suspend/resume and remote wakeup support

Message ID 1678908551-27666-1-git-send-email-quic_eserrao@quicinc.com
Headers show
Series Add function suspend/resume and remote wakeup support | expand

Message

Elson Roy Serrao March 15, 2023, 7:29 p.m. UTC 
Changes in v10
 - Modified the return value to 0 in ecm_get_status() so that device responds
   with both remote wakeup armed and remote wakeup capable bit reset to 0.
 - Return negative errno if wakeup is not supported when func suspend feature
   selector is sent by the host.

Changes in v9
 - Added bmAtrributes wakeup bit check for arming the function for function
   remote wakeup and also in get_status api

Changes in v8
 - Added else case to return error value while setting remote wakeup feature
   selector so that device will respond with a protocl stall

Changes in v7
 - Added a check to set device remote wakeup feature selector in ep0.c based on whether
   the device is configured for remote wakeup.
 - Commit message and usb_func_wakeup documentation changes.

Changes in v6
 - Combined usb_gadget_func_wakeup API with usb_func_wakeup API in composite layer
   so that there is only 1 API for triggering function remote wakeup for better error
   handling. Since function suspend is something specific to usb functions, better to
   keep the related APIs in composite layer and above. Also documented the usage and
   applicability of the usb_func_wakeup API.

Changes in v5
 - Add wakeup_armed check in patch2 in the link status change event handler
   so that resume gets triggeed only in the remote wakeup context.
 - Costmetic changes in patch3 and patch4

Changes in v4
 - Moved the wakeup bit check to bind function for warning the user at an early
   stage itself.
 - Added the remote wakeup configured check to gadget_wakeup() and func_wakeup()
   routines so that wakeup can be triggered only if user has configured it.
 - Cosmetic changes with respect to renaming the variables to reflect the operation
   better.

Changes in v3
 - Modified rw_capable flag to reflect the gadgets capability for wakeup
   signalling.
 - Added a check to configure wakeup bit in bmAttributes only if gadget
   is capable of triggering wakeup.
 - Implemented a gadget op for composite layer to inform UDC whether device
   is configured for remote wakeup.
 - Added a check in __usb_gadget_wakeup() API to trigger wakeup only if the
   device is configured for it.
 - Cosmetic changes in dwc3_gadget_func_wakeup() API.

Changes in v2
 - Added a flag to indicate whether the device is remote wakeup capable.
 - Added an async parameter to _dwc3_gadget_wakeup() API and few cosmetic
   changes.
 - Added flags to reflect the state of  function suspend and function remote
   wakeup to usb_function struct rather than function specific struct (f_ecm).
 - Changed the dwc3_gadget_func__wakeup() API to run synchronously by first
   checking the link state and then sending the device notification. Also
   added debug log for DEVICE_NOTIFICATION generic cmd.
 - Added changes to arm the device for remotewakeup/function remotewakeup
   only if device is capable.

An usb device can initate a remote wakeup and bring the link out of
suspend as dictated by the DEVICE_REMOTE_WAKEUP feature selector.
To achieve this an interface can invoke gadget_wakeup op and wait for the
device to come out of LPM. But the current polling based implementation
fails if the host takes a long time to drive the resume signaling specially
in high speed capable devices. Switching to an interrupt based approach is
more robust and efficient. This can be leveraged by enabling link status
change events and triggering a gadget resume when the link comes to active
state.

If the device is enhanced super-speed capable, individual interfaces can
also be put into suspend state. An interface can be in function suspend
state even when the device is not in suspend state. Function suspend state
is retained throughout the device suspend entry and exit process.
A function can be put to function suspend through FUNCTION_SUSPEND feature
selector sent by the host. This setup packet also decides whether that
function is capable of initiating a function remote wakeup. When the
function sends a wakeup notification to the host the link must be first
brought to a non-U0 state and then this notification is sent.

This change adds the infrastructure needed to support the above
functionalities.

Elson Roy Serrao (5):
  usb: gadget: Properly configure the device for remote wakeup
  usb: dwc3: Add remote wakeup handling
  usb: gadget: Add function wakeup support
  usb: dwc3: Add function suspend and function wakeup support
  usb: gadget: f_ecm: Add suspend/resume and remote wakeup support

 drivers/usb/dwc3/core.h               |   5 ++
 drivers/usb/dwc3/debug.h              |   2 +
 drivers/usb/dwc3/ep0.c                |  19 +++---
 drivers/usb/dwc3/gadget.c             | 118 ++++++++++++++++++++++++++++++++--
 drivers/usb/gadget/composite.c        |  58 +++++++++++++++++
 drivers/usb/gadget/configfs.c         |   3 +
 drivers/usb/gadget/function/f_ecm.c   |  77 ++++++++++++++++++++++
 drivers/usb/gadget/function/u_ether.c |  63 ++++++++++++++++++
 drivers/usb/gadget/function/u_ether.h |   4 ++
 drivers/usb/gadget/udc/core.c         |  27 ++++++++
 drivers/usb/gadget/udc/trace.h        |   5 ++
 include/linux/usb/composite.h         |   8 +++
 include/linux/usb/gadget.h            |   9 +++
 13 files changed, 384 insertions(+), 14 deletions(-)

Comments

Thinh Nguyen March 15, 2023, 9:15 p.m. UTC | #1 
On Wed, Mar 15, 2023, Thinh Nguyen wrote:
> On Wed, Mar 15, 2023, Elson Roy Serrao wrote:
> > When host sends a suspend notification to the device, handle
> > the suspend callbacks in the function driver. Enhanced super
> > speed devices can support function suspend feature to put the
> > function in suspend state. Handle function suspend callback.
> > 
> > Depending on the remote wakeup capability the device can either
> > trigger a remote wakeup or wait for the host initiated resume to
> > start data transfer again.
> > 
> > Signed-off-by: Elson Roy Serrao <quic_eserrao@quicinc.com>
> > ---
> >  drivers/usb/gadget/function/f_ecm.c   | 77 +++++++++++++++++++++++++++++++++++
> >  drivers/usb/gadget/function/u_ether.c | 63 ++++++++++++++++++++++++++++
> >  drivers/usb/gadget/function/u_ether.h |  4 ++
> >  3 files changed, 144 insertions(+)
> > 
> > diff --git a/drivers/usb/gadget/function/f_ecm.c b/drivers/usb/gadget/function/f_ecm.c
> > index a7ab30e..fea07ab 100644
> > --- a/drivers/usb/gadget/function/f_ecm.c
> > +++ b/drivers/usb/gadget/function/f_ecm.c
> > @@ -633,6 +633,8 @@ static void ecm_disable(struct usb_function *f)
> >  
> >  	usb_ep_disable(ecm->notify);
> >  	ecm->notify->desc = NULL;
> > +	f->func_suspended = false;
> > +	f->func_wakeup_armed = false;
> >  }
> >  
> >  /*-------------------------------------------------------------------------*/
> > @@ -885,6 +887,77 @@ static struct usb_function_instance *ecm_alloc_inst(void)
> >  	return &opts->func_inst;
> >  }
> >  
> > +static void ecm_suspend(struct usb_function *f)
> > +{
> > +	struct f_ecm *ecm = func_to_ecm(f);
> > +	struct usb_composite_dev *cdev = ecm->port.func.config->cdev;
> > +
> > +	if (f->func_suspended) {
> > +		DBG(cdev, "Function already suspended\n");
> > +		return;
> > +	}
> > +
> > +	DBG(cdev, "ECM Suspend\n");
> > +
> > +	gether_suspend(&ecm->port);
> > +}
> > +
> > +static void ecm_resume(struct usb_function *f)
> > +{
> > +	struct f_ecm *ecm = func_to_ecm(f);
> > +	struct usb_composite_dev *cdev = ecm->port.func.config->cdev;
> > +
> > +	/*
> > +	 * If the function is in USB3 Function Suspend state, resume is
> > +	 * canceled. In this case resume is done by a Function Resume request.
> > +	 */
> > +	if (f->func_suspended)
> > +		return;
> > +
> > +	DBG(cdev, "ECM Resume\n");
> > +
> > +	gether_resume(&ecm->port);
> > +}
> > +
> > +static int ecm_get_status(struct usb_function *f)
> > +{
> > +	struct usb_configuration *c = f->config;
> > +
> > +	/* D0 and D1 bit set to 0 if device is not wakeup capable */
> > +	if (!(USB_CONFIG_ATT_WAKEUP & c->bmAttributes))
> > +		return 0;
> > +
> > +	return (f->func_wakeup_armed ? USB_INTRF_STAT_FUNC_RW : 0) |
> > +		USB_INTRF_STAT_FUNC_RW_CAP;
> > +}
> > +
> > +static int ecm_func_suspend(struct usb_function *f, u8 options)
> > +{
> > +	struct usb_configuration *c = f->config;
> > +
> > +	DBG(c->cdev, "func susp %u cmd\n", options);
> > +
> > +	/* Respond with negative errno if request is not supported */
> > +	if (!(USB_CONFIG_ATT_WAKEUP & c->bmAttributes))
> > +		return -EINVAL;
> 
> We only need to return early if the host tries to enable remote wake
> while the device isn't capable of it:
> 
> 	wakeup_sel = !!(options & (USB_INTRF_FUNC_SUSPEND_RW >> 8));
> 	if (wakeup_sel && !(USB_CONFIG_ATT_WAKEUP & c->bmAttributes))
> 		return -EINVAL;
> 
> 	f->func_wakeup_armed = wakeup_sel;
> 

Also, I notice that we can't differentiate between ClearFeature() and
SetFeature() in f->func_suspend(). Perhaps we should handle arming the
remote wakeup in the composite layer so we can set/clear the remote
wake. It's common across multiple devices. It's probably better to be
there.

Thanks,
Thinh
Thinh Nguyen March 15, 2023, 11:01 p.m. UTC | #2 
On Wed, Mar 15, 2023, Elson Serrao wrote:
> 
> On 3/15/2023 2:15 PM, Thinh Nguyen wrote:
> > On Wed, Mar 15, 2023, Thinh Nguyen wrote:
> > > On Wed, Mar 15, 2023, Elson Roy Serrao wrote:
> > > > When host sends a suspend notification to the device, handle
> > > > the suspend callbacks in the function driver. Enhanced super
> > > > speed devices can support function suspend feature to put the
> > > > function in suspend state. Handle function suspend callback.
> > > > 
> > > > Depending on the remote wakeup capability the device can either
> > > > trigger a remote wakeup or wait for the host initiated resume to
> > > > start data transfer again.
> > > > 
> > > > Signed-off-by: Elson Roy Serrao <quic_eserrao@quicinc.com>
> > > > ---
> > > >   drivers/usb/gadget/function/f_ecm.c   | 77 +++++++++++++++++++++++++++++++++++
> > > >   drivers/usb/gadget/function/u_ether.c | 63 ++++++++++++++++++++++++++++
> > > >   drivers/usb/gadget/function/u_ether.h |  4 ++
> > > >   3 files changed, 144 insertions(+)
> > > > 
> > > > diff --git a/drivers/usb/gadget/function/f_ecm.c b/drivers/usb/gadget/function/f_ecm.c
> > > > index a7ab30e..fea07ab 100644
> > > > --- a/drivers/usb/gadget/function/f_ecm.c
> > > > +++ b/drivers/usb/gadget/function/f_ecm.c
> > > > @@ -633,6 +633,8 @@ static void ecm_disable(struct usb_function *f)
> > > >   	usb_ep_disable(ecm->notify);
> > > >   	ecm->notify->desc = NULL;
> > > > +	f->func_suspended = false;
> > > > +	f->func_wakeup_armed = false;
> > > >   }
> > > >   /*-------------------------------------------------------------------------*/
> > > > @@ -885,6 +887,77 @@ static struct usb_function_instance *ecm_alloc_inst(void)
> > > >   	return &opts->func_inst;
> > > >   }
> > > > +static void ecm_suspend(struct usb_function *f)
> > > > +{
> > > > +	struct f_ecm *ecm = func_to_ecm(f);
> > > > +	struct usb_composite_dev *cdev = ecm->port.func.config->cdev;
> > > > +
> > > > +	if (f->func_suspended) {
> > > > +		DBG(cdev, "Function already suspended\n");
> > > > +		return;
> > > > +	}
> > > > +
> > > > +	DBG(cdev, "ECM Suspend\n");
> > > > +
> > > > +	gether_suspend(&ecm->port);
> > > > +}
> > > > +
> > > > +static void ecm_resume(struct usb_function *f)
> > > > +{
> > > > +	struct f_ecm *ecm = func_to_ecm(f);
> > > > +	struct usb_composite_dev *cdev = ecm->port.func.config->cdev;
> > > > +
> > > > +	/*
> > > > +	 * If the function is in USB3 Function Suspend state, resume is
> > > > +	 * canceled. In this case resume is done by a Function Resume request.
> > > > +	 */
> > > > +	if (f->func_suspended)
> > > > +		return;
> > > > +
> > > > +	DBG(cdev, "ECM Resume\n");
> > > > +
> > > > +	gether_resume(&ecm->port);
> > > > +}
> > > > +
> > > > +static int ecm_get_status(struct usb_function *f)
> > > > +{
> > > > +	struct usb_configuration *c = f->config;
> > > > +
> > > > +	/* D0 and D1 bit set to 0 if device is not wakeup capable */
> > > > +	if (!(USB_CONFIG_ATT_WAKEUP & c->bmAttributes))
> > > > +		return 0;
> > > > +
> > > > +	return (f->func_wakeup_armed ? USB_INTRF_STAT_FUNC_RW : 0) |
> > > > +		USB_INTRF_STAT_FUNC_RW_CAP;
> > > > +}
> > > > +
> > > > +static int ecm_func_suspend(struct usb_function *f, u8 options)
> > > > +{
> > > > +	struct usb_configuration *c = f->config;
> > > > +
> > > > +	DBG(c->cdev, "func susp %u cmd\n", options);
> > > > +
> > > > +	/* Respond with negative errno if request is not supported */
> > > > +	if (!(USB_CONFIG_ATT_WAKEUP & c->bmAttributes))
> > > > +		return -EINVAL;
> > > 
> > > We only need to return early if the host tries to enable remote wake
> > > while the device isn't capable of it:
> > > 
> > > 	wakeup_sel = !!(options & (USB_INTRF_FUNC_SUSPEND_RW >> 8));
> > > 	if (wakeup_sel && !(USB_CONFIG_ATT_WAKEUP & c->bmAttributes))
> > > 		return -EINVAL;
> > > 
> > > 	f->func_wakeup_armed = wakeup_sel;
> > > 
> > 
> > Also, I notice that we can't differentiate between ClearFeature() and
> > SetFeature() in f->func_suspend(). Perhaps we should handle arming the
> > remote wakeup in the composite layer so we can set/clear the remote
> > wake. It's common across multiple devices. It's probably better to be
> > there.
> > 
> > Thanks,
> > Thinh
> 
> Yeah agree with that. We check for function_wakeup_armed flag before sending
> remote wakeup in composite.c. So it makes more sense
> to set/reset this flag in composite.c itself. I will make that change
> and upload v12 along with fixing 'value = 0' removal that we discussed
> earlier. Please let me know if that is fine
> 

Since we don't go through the func_suspend() anymore, let's keep it as
is for now. If you're in composite.c, then you can skip doing
func_suspend() if remote_wake is not supported when host requested.

Thanks,
Thinh