Skip to contentSkip to conversation

Allow suspend/resume with USB audio.

PATCH Superseded Dylan Reid 2 participants 6 messages Sep 18, 2012 Sound

lore
Share & tools
lore

Dylan Reid

author
#0 lore raw

v2 cover Allow suspend/resume with USB audio.

Problem being addressed:
shell one$ aplay -Dhw:<usbcard> file.wav
shell two$ echo mem > /sys/power/state
After resume, aplay attempts resume, then restart, then after a timeout gets a write error and no audio will be played until it is restarted.

During suspend/resume, if the USB port remains powered the audio device will still be present upon resume. The interface and endpoint have to be reconfigured however. These patches move the configuration from hw_params to prepare causing re-configuration during resume.

Is this the right way to fix this? Or is there an easier way I am missing?

Thanks for looking.

v2: fix unused variable warnings.

Dylan Reid (3):
ALSA: usb-audio: set period_bytes in substream.
ALSA: usb-audio: Don't require hw_params in endpoint.
ALSA: usb-audio: Move configuration to prepare.

 sound/usb/card.h     |   2 +
 sound/usb/endpoint.c |  29 +++++++-----
 sound/usb/endpoint.h |   5 ++-
 sound/usb/pcm.c      | 121 +++++++++++++++++++++++++++++++--------------------
 4 files changed, 97 insertions(+), 60 deletions(-)
Signature · 1 line
1.7.12.146.g16d26b1
author
#1 lore raw

PATCH v2 1/4 ALSA: usb-audio: set period_bytes in substream.

Set the peiod_bytes member of snd_usb_substream. It was no longer being set, but will be needed to resume properly in a future commit.

Change-Id I4cf4681f16f8a71d26c586520afed9e8c27433b2
---
 sound/usb/pcm.c | 2 ++
 1 file changed, 2 insertions(+)
sound/usb/pcm.c +2 -0
index f782ce1..786f7a0 100644
@@ -486,6 +486,8 @@ static int snd_usb_hw_params(struct snd_pcm_substream *substream,
 	}
 
 	if (changed) {
+		subs->period_bytes = params_period_bytes(hw_params);
+
 		mutex_lock(&subs->stream->chip->shutdown_mutex);
 		/* format changed */
 		stop_endpoints(subs, 0, 0, 0);
Signature · 1 line
1.7.12.146.g16d26b1
author
#2 lore raw

PATCH v2 2/4 ALSA: usb-audio: Don't require hw_params in endpoint.

In reply to Dylan Reid

Change the interface to configure an endpoint so that it doesn't require a hw_params struct. This will allow it to be called from prepare instead of hw_params, configuring it after system resume.

Change-Id I9cded1644d3f6fee3c5707adffca4ef18c0befd7
---
 sound/usb/endpoint.c | 31 ++++++++++++++++++-------------
 sound/usb/endpoint.h |  5 ++++-
 sound/usb/pcm.c      | 16 +++++++++++++---
 3 files changed, 35 insertions(+), 17 deletions(-)
sound/usb/endpoint.c +18 -13
index a83a18d..152bfd4 100644
@@ -567,20 +567,19 @@ static void release_urbs(struct snd_usb_endpoint *ep, int force)
  * configure a data endpoint
  */
 static int data_ep_set_params(struct snd_usb_endpoint *ep,
-			      struct snd_pcm_hw_params *hw_params,
+			      snd_pcm_format_t pcm_format,
+			      unsigned int channels,
+			      unsigned int period_bytes,
 			      struct audioformat *fmt,
 			      struct snd_usb_endpoint *sync_ep)
 {
 	unsigned int maxsize, i, urb_packs, total_packs, packs_per_ms;
-	int period_bytes = params_period_bytes(hw_params);
-	int format = params_format(hw_params);
 	int is_playback = usb_pipeout(ep->pipe);
-	int frame_bits = snd_pcm_format_physical_width(params_format(hw_params)) *
-							params_channels(hw_params);
+	int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
 
 	ep->datainterval = fmt->datainterval;
 	ep->stride = frame_bits >> 3;
-	ep->silence_value = format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
+	ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
 
 	/* calculate max. frequency */
 	if (ep->maxpacksize) {
@@ -693,7 +692,6 @@ out_of_memory:
  * configure a sync endpoint
  */
 static int sync_ep_set_params(struct snd_usb_endpoint *ep,
-			      struct snd_pcm_hw_params *hw_params,
 			      struct audioformat *fmt)
 {
 	int i;
@@ -736,7 +734,10 @@ out_of_memory:
  * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
  *
  * @ep: the snd_usb_endpoint to configure
- * @hw_params: the hardware parameters
+ * @pcm_format: the audio fomat.
+ * @channels: the number of audio channels.
+ * @period_bytes: the number of bytes in one alsa period.
+ * @rate: the frame rate.
  * @fmt: the USB audio format information
  * @sync_ep: the sync endpoint to use, if any
  *
@@ -745,7 +746,10 @@ out_of_memory:
  * An endpoint that is already running can not be reconfigured.
  */
 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
-				struct snd_pcm_hw_params *hw_params,
+				snd_pcm_format_t pcm_format,
+				unsigned int channels,
+				unsigned int period_bytes,
+				unsigned int rate,
 				struct audioformat *fmt,
 				struct snd_usb_endpoint *sync_ep)
 {
@@ -765,9 +769,9 @@ int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
 	ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
 
 	if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
-		ep->freqn = get_usb_full_speed_rate(params_rate(hw_params));
+		ep->freqn = get_usb_full_speed_rate(rate);
 	else
-		ep->freqn = get_usb_high_speed_rate(params_rate(hw_params));
+		ep->freqn = get_usb_high_speed_rate(rate);
 
 	/* calculate the frequency in 16.16 format */
 	ep->freqm = ep->freqn;
@@ -777,10 +781,11 @@ int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
 
 	switch (ep->type) {
 	case  SND_USB_ENDPOINT_TYPE_DATA:
-		err = data_ep_set_params(ep, hw_params, fmt, sync_ep);
+		err = data_ep_set_params(ep, pcm_format, channels,
+					 period_bytes, fmt, sync_ep);
 		break;
 	case  SND_USB_ENDPOINT_TYPE_SYNC:
-		err = sync_ep_set_params(ep, hw_params, fmt);
+		err = sync_ep_set_params(ep, fmt);
 		break;
 	default:
 		err = -EINVAL;
sound/usb/endpoint.h +4 -1
index cbbbdf2..6376ccf 100644
@@ -9,7 +9,10 @@ struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
 					      int ep_num, int direction, int type);
 
 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
-				struct snd_pcm_hw_params *hw_params,
+				snd_pcm_format_t pcm_format,
+				unsigned int channels,
+				unsigned int period_bytes,
+				unsigned int rate,
 				struct audioformat *fmt,
 				struct snd_usb_endpoint *sync_ep);
 
sound/usb/pcm.c +13 -3
index 786f7a0..62ab4fd 100644
@@ -491,14 +491,24 @@ static int snd_usb_hw_params(struct snd_pcm_substream *substream,
 		mutex_lock(&subs->stream->chip->shutdown_mutex);
 		/* format changed */
 		stop_endpoints(subs, 0, 0, 0);
-		ret = snd_usb_endpoint_set_params(subs->data_endpoint, hw_params, fmt,
+		ret = snd_usb_endpoint_set_params(subs->data_endpoint,
+						  format,
+						  channels,
+						  subs->period_bytes,
+						  rate,
+						  fmt,
 						  subs->sync_endpoint);
 		if (ret < 0)
 			goto unlock;
 
 		if (subs->sync_endpoint)
-			ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
-							  hw_params, fmt, NULL);
+			ret = snd_usb_endpoint_set_params(subs->data_endpoint,
+							  format,
+							  channels,
+							  subs->period_bytes,
+							  rate,
+							  fmt,
+							  NULL);
 unlock:
 		mutex_unlock(&subs->stream->chip->shutdown_mutex);
 	}
Signature · 1 line
1.7.12.146.g16d26b1
author
#3 lore raw

PATCH v2 3/4 ALSA: usb-audio: Move configuration to prepare.

In reply to Dylan Reid

Move interface and endpoint configuration from hw_params to prepare callback. During system suspend/resume when the USB device power isn't cycled the interface and endpoint configuration need to be set before audio playback can continue. Resume involves another call to prepare but not to hw_params, moving it here allows a playing stream to continue after resume.

Change-Id I6a34251c1245352ff2b9f004d781afcb3bf7cda2
---
 sound/usb/card.h |   2 +
 sound/usb/pcm.c  | 134 ++++++++++++++++++++++++++++++-------------------------
 2 files changed, 76 insertions(+), 60 deletions(-)
sound/usb/card.h +2 -0
index 23b6f23..6cc883c 100644
@@ -107,6 +107,8 @@ struct snd_usb_substream {
 	int interface;	/* current interface */
 	int endpoint;	/* assigned endpoint */
 	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
+	snd_pcm_format_t pcm_format;	/* current audio format (for hw_params callback) */
+	unsigned int channels;		/* current number of channels (for hw_params callback) */
 	unsigned int cur_rate;		/* current rate (for hw_params callback) */
 	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
 	unsigned int altset_idx;     /* USB data format: index of alternate setting */
sound/usb/pcm.c +74 -60

191 lines not on this page · raw message

Signature · 1 line
1.7.12.146.g16d26b1
#4 lore raw
In reply to Dylan Reid

At Tue, 18 Sep 2012 09:49:45 -0700,

Quoted 12 lines · Dylan Reid

Problem being addressed:
shell one$ aplay -Dhw:<usbcard> file.wav
shell two$ echo mem > /sys/power/state
After resume, aplay attempts resume, then restart, then after a timeout gets a write error and no audio will be played until it is restarted.

During suspend/resume, if the USB port remains powered the audio device will still be present upon resume. The interface and endpoint have to be reconfigured however. These patches move the configuration from hw_params to prepare causing re-configuration during resume.

Quoted 6 lines

Is this the right way to fix this? Or is there an easier way I am missing?

Thanks for looking.

v2: fix unused variable warnings.

I think the patches are OK. If no big objection comes up, I'm going to apply it tomorrow.

Meanwhile I found a problem in my patch. The re-setup might be needed if the app changes hw_params again. So, the flag has to be set in hw_params callback instead. The revised patch is below.

thanks,

Takashi

===

From: Takashi Iwai <[email protected]>
Subject: [PATCH v2] ALSA: usb-audio: Avoid unnecessary EP setups in prepare

The recent fix for USB suspend breakage moved the code to set up EP from hw_params to prepare, but it means also the EP setup might be called multiple times unnecessarily because the prepare callback can be called multiple times without starting the stream (e.g. OSS emulation).

This patch adds a new flag to struct snd_usb_substream indicating whether the setup of EP is required, and do it only when necessary, i.e. right after hw_params or suspend.

---
v1->v2: set the flag in hw_params callback

 sound/usb/card.c |  2 ++
 sound/usb/card.h |  1 +
 sound/usb/pcm.c  | 10 +++++++---
 3 files changed, 10 insertions(+), 3 deletions(-)
sound/usb/card.c +2 -0
index 4a469f0..561bb74 100644
@@ -646,6 +646,8 @@ static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
 			list_for_each(p, &chip->pcm_list) {
 				as = list_entry(p, struct snd_usb_stream, list);
 				snd_pcm_suspend_all(as->pcm);
+				as->substream[0].need_setup_ep =
+					as->substream[1].need_setup_ep = true;
 			}
  		}
 	} else {
sound/usb/card.h +1 -0
index 6cc883c..afa4f9e 100644
@@ -125,6 +125,7 @@ struct snd_usb_substream {
 	struct snd_usb_endpoint *data_endpoint;
 	struct snd_usb_endpoint *sync_endpoint;
 	unsigned long flags;
+	bool need_setup_ep;		/* (re)configure EP at prepare? */
 
 	u64 formats;			/* format bitmasks (all or'ed) */
 	unsigned int num_formats;		/* number of supported audio formats (list) */
sound/usb/pcm.c +7 -3
index ae783d4..55e19e1 100644
@@ -510,6 +510,7 @@ static int snd_usb_hw_params(struct snd_pcm_substream *substream,
 
 	subs->interface = fmt->iface;
 	subs->altset_idx = fmt->altset_idx;
+	subs->need_setup_ep = true;
 
 	return 0;
 }
@@ -568,9 +569,12 @@ static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
 	if (ret < 0)
 		return ret;
 
-	ret = configure_endpoint(subs);
-	if (ret < 0)
-		return ret;
+	if (subs->need_setup_ep) {
+		ret = configure_endpoint(subs);
+		if (ret < 0)
+			return ret;
+		subs->need_setup_ep = false;
+	}
 
 	/* some unit conversions in runtime */
 	subs->data_endpoint->maxframesize =
Signature · 1 line
1.7.11.5
author
#5 lore raw
Quoted 19 lines · Takashi Iwai

At Tue, 18 Sep 2012 09:49:45 -0700,

Quoted 17 lines · Dylan Reid

Problem being addressed:
shell one$ aplay -Dhw:<usbcard> file.wav
shell two$ echo mem > /sys/power/state
After resume, aplay attempts resume, then restart, then after a timeout gets a write error and no audio will be played until it is restarted.

During suspend/resume, if the USB port remains powered the audio device will still be present upon resume. The interface and endpoint have to be reconfigured however. These patches move the configuration from hw_params to prepare causing re-configuration during resume.

Is this the right way to fix this? Or is there an easier way I am missing?

Thanks for looking.

Quoted 8 lines
Quoted 1 line

v2: fix unused variable warnings.

I think the patches are OK. If no big objection comes up, I'm going to apply it tomorrow.

Meanwhile I found a problem in my patch. The re-setup might be needed if the app changes hw_params again. So, the flag has to be set in hw_params callback instead. The revised patch is below.

Good catch. I wrote a quick test that plays something, calls drain, calls hw_params to a different rate, then start and plays again. It failed with the old patch and works with the new one.

Thanks,

Dylan

Quoted 86 lines

thanks,

Takashi

===

From: Takashi Iwai <[email protected]>
Subject: [PATCH v2] ALSA: usb-audio: Avoid unnecessary EP setups in prepare

The recent fix for USB suspend breakage moved the code to set up EP from hw_params to prepare, but it means also the EP setup might be called multiple times unnecessarily because the prepare callback can be called multiple times without starting the stream (e.g. OSS emulation).

This patch adds a new flag to struct snd_usb_substream indicating whether the setup of EP is required, and do it only when necessary, i.e. right after hw_params or suspend.

---
v1->v2: set the flag in hw_params callback

 sound/usb/card.c |  2 ++
 sound/usb/card.h |  1 +
 sound/usb/pcm.c  | 10 +++++++---
 3 files changed, 10 insertions(+), 3 deletions(-)
sound/usb/card.c +2 -0
index 4a469f0..561bb74 100644
@@ -646,6 +646,8 @@ static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
                        list_for_each(p, &chip->pcm_list) {
                                as = list_entry(p, struct snd_usb_stream, list);
                                snd_pcm_suspend_all(as->pcm);
+                               as->substream[0].need_setup_ep =
+                                       as->substream[1].need_setup_ep = true;
                        }
                }
        } else {
sound/usb/card.h +1 -0
index 6cc883c..afa4f9e 100644
@@ -125,6 +125,7 @@ struct snd_usb_substream {
        struct snd_usb_endpoint *data_endpoint;
        struct snd_usb_endpoint *sync_endpoint;
        unsigned long flags;
+       bool need_setup_ep;             /* (re)configure EP at prepare? */
 
        u64 formats;                    /* format bitmasks (all or'ed) */
        unsigned int num_formats;               /* number of supported audio formats (list) */
sound/usb/pcm.c +7 -4
index ae783d4..55e19e1 100644
@@ -510,6 +510,7 @@ static int snd_usb_hw_params(struct snd_pcm_substream *substream,
 
        subs->interface = fmt->iface;
        subs->altset_idx = fmt->altset_idx;
+       subs->need_setup_ep = true;
 
        return 0;
 }
@@ -568,9 +569,12 @@ static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
        if (ret < 0)
                return ret;
 
-       ret = configure_endpoint(subs);
-       if (ret < 0)
-               return ret;
+       if (subs->need_setup_ep) {
+               ret = configure_endpoint(subs);
+               if (ret < 0)
+                       return ret;
+               subs->need_setup_ep = false;
+       }
 
        /* some unit conversions in runtime */
        subs->data_endpoint->maxframesize =
--

1.7.11.5