1 // SPDX-License-Identifier: GPL-2.0-or-later
5 #include <linux/init.h>
6 #include <linux/slab.h>
7 #include <linux/bitrev.h>
8 #include <linux/ratelimit.h>
10 #include <linux/usb/audio.h>
11 #include <linux/usb/audio-v2.h>
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/pcm_params.h>
28 #define SUBSTREAM_FLAG_DATA_EP_STARTED 0
29 #define SUBSTREAM_FLAG_SYNC_EP_STARTED 1
31 /* return the estimated delay based on USB frame counters */
32 static snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
33 struct snd_pcm_runtime *runtime)
35 unsigned int current_frame_number;
36 unsigned int frame_diff;
40 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
41 queued = bytes_to_frames(runtime, subs->inflight_bytes);
44 } else if (!subs->running) {
48 current_frame_number = usb_get_current_frame_number(subs->dev);
50 * HCD implementations use different widths, use lower 8 bits.
51 * The delay will be managed up to 256ms, which is more than
54 frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
56 /* Approximation based on number of samples per USB frame (ms),
57 some truncation for 44.1 but the estimate is good enough */
58 est_delay = frame_diff * runtime->rate / 1000;
60 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
61 est_delay = queued - est_delay;
70 * return the current pcm pointer. just based on the hwptr_done value.
72 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
74 struct snd_pcm_runtime *runtime = substream->runtime;
75 struct snd_usb_substream *subs = runtime->private_data;
76 unsigned int hwptr_done;
78 if (atomic_read(&subs->stream->chip->shutdown))
79 return SNDRV_PCM_POS_XRUN;
80 spin_lock(&subs->lock);
81 hwptr_done = subs->hwptr_done;
82 runtime->delay = snd_usb_pcm_delay(subs, runtime);
83 spin_unlock(&subs->lock);
84 return bytes_to_frames(runtime, hwptr_done);
88 * find a matching audio format
90 static const struct audioformat *
91 find_format(struct list_head *fmt_list_head, snd_pcm_format_t format,
92 unsigned int rate, unsigned int channels, bool strict_match,
93 struct snd_usb_substream *subs)
95 const struct audioformat *fp;
96 const struct audioformat *found = NULL;
97 int cur_attr = 0, attr;
99 list_for_each_entry(fp, fmt_list_head, list) {
101 if (!(fp->formats & pcm_format_to_bits(format)))
103 if (fp->channels != channels)
106 if (rate < fp->rate_min || rate > fp->rate_max)
108 if (!(fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
110 for (i = 0; i < fp->nr_rates; i++)
111 if (fp->rate_table[i] == rate)
113 if (i >= fp->nr_rates)
116 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
122 /* avoid async out and adaptive in if the other method
123 * supports the same format.
124 * this is a workaround for the case like
125 * M-audio audiophile USB.
127 if (subs && attr != cur_attr) {
128 if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
129 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
130 (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
131 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
133 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
134 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
135 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
136 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
142 /* find the format with the largest max. packet size */
143 if (fp->maxpacksize > found->maxpacksize) {
151 static const struct audioformat *
152 find_substream_format(struct snd_usb_substream *subs,
153 const struct snd_pcm_hw_params *params)
155 return find_format(&subs->fmt_list, params_format(params),
156 params_rate(params), params_channels(params),
160 static int init_pitch_v1(struct snd_usb_audio *chip, int ep)
162 struct usb_device *dev = chip->dev;
163 unsigned char data[1];
167 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
168 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
169 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
174 static int init_pitch_v2(struct snd_usb_audio *chip, int ep)
176 struct usb_device *dev = chip->dev;
177 unsigned char data[1];
181 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
182 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
183 UAC2_EP_CS_PITCH << 8, 0,
189 * initialize the pitch control and sample rate
191 int snd_usb_init_pitch(struct snd_usb_audio *chip,
192 const struct audioformat *fmt)
196 /* if endpoint doesn't have pitch control, bail out */
197 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
200 usb_audio_dbg(chip, "enable PITCH for EP 0x%x\n", fmt->endpoint);
202 switch (fmt->protocol) {
204 err = init_pitch_v1(chip, fmt->endpoint);
207 err = init_pitch_v2(chip, fmt->endpoint);
214 usb_audio_err(chip, "failed to enable PITCH for EP 0x%x\n",
222 static bool stop_endpoints(struct snd_usb_substream *subs, bool keep_pending)
226 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
227 snd_usb_endpoint_stop(subs->sync_endpoint, keep_pending);
230 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
231 snd_usb_endpoint_stop(subs->data_endpoint, keep_pending);
237 static int start_endpoints(struct snd_usb_substream *subs)
241 if (!subs->data_endpoint)
244 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
245 err = snd_usb_endpoint_start(subs->data_endpoint);
247 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
252 if (subs->sync_endpoint &&
253 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
254 err = snd_usb_endpoint_start(subs->sync_endpoint);
256 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
264 stop_endpoints(subs, false);
268 static void sync_pending_stops(struct snd_usb_substream *subs)
270 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
271 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
274 /* PCM sync_stop callback */
275 static int snd_usb_pcm_sync_stop(struct snd_pcm_substream *substream)
277 struct snd_usb_substream *subs = substream->runtime->private_data;
279 sync_pending_stops(subs);
283 /* Set up sync endpoint */
284 int snd_usb_audioformat_set_sync_ep(struct snd_usb_audio *chip,
285 struct audioformat *fmt)
287 struct usb_device *dev = chip->dev;
288 struct usb_host_interface *alts;
289 struct usb_interface_descriptor *altsd;
290 unsigned int ep, attr, sync_attr;
294 alts = snd_usb_get_host_interface(chip, fmt->iface, fmt->altsetting);
297 altsd = get_iface_desc(alts);
299 err = snd_usb_parse_implicit_fb_quirk(chip, fmt, alts);
301 return 0; /* matched */
304 * Generic sync EP handling
307 if (altsd->bNumEndpoints < 2)
310 is_playback = !(get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
311 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
312 if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC ||
313 attr == USB_ENDPOINT_SYNC_ADAPTIVE)) ||
314 (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
317 sync_attr = get_endpoint(alts, 1)->bmAttributes;
320 * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see
321 * if we don't find a sync endpoint, as on M-Audio Transit. In case of
322 * error fall back to SYNC mode and don't create sync endpoint
325 /* check sync-pipe endpoint */
326 /* ... and check descriptor size before accessing bSynchAddress
327 because there is a version of the SB Audigy 2 NX firmware lacking
328 the audio fields in the endpoint descriptors */
329 if ((sync_attr & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
330 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
331 get_endpoint(alts, 1)->bSynchAddress != 0)) {
333 "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
334 fmt->iface, fmt->altsetting,
335 get_endpoint(alts, 1)->bmAttributes,
336 get_endpoint(alts, 1)->bLength,
337 get_endpoint(alts, 1)->bSynchAddress);
338 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
342 ep = get_endpoint(alts, 1)->bEndpointAddress;
343 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
344 get_endpoint(alts, 0)->bSynchAddress != 0 &&
345 ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
346 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
348 "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
349 fmt->iface, fmt->altsetting,
350 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
351 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
357 fmt->sync_iface = altsd->bInterfaceNumber;
358 fmt->sync_altsetting = altsd->bAlternateSetting;
359 fmt->sync_ep_idx = 1;
360 if ((sync_attr & USB_ENDPOINT_USAGE_MASK) == USB_ENDPOINT_USAGE_IMPLICIT_FB)
361 fmt->implicit_fb = 1;
363 dev_dbg(&dev->dev, "%d:%d: found sync_ep=0x%x, iface=%d, alt=%d, implicit_fb=%d\n",
364 fmt->iface, fmt->altsetting, fmt->sync_ep, fmt->sync_iface,
365 fmt->sync_altsetting, fmt->implicit_fb);
370 static int snd_usb_pcm_change_state(struct snd_usb_substream *subs, int state)
377 ret = snd_usb_power_domain_set(subs->stream->chip, subs->str_pd, state);
379 dev_err(&subs->dev->dev,
380 "Cannot change Power Domain ID: %d to state: %d. Err: %d\n",
381 subs->str_pd->pd_id, state, ret);
388 int snd_usb_pcm_suspend(struct snd_usb_stream *as)
392 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D2);
396 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D2);
403 int snd_usb_pcm_resume(struct snd_usb_stream *as)
407 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D1);
411 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D1);
418 static void close_endpoints(struct snd_usb_audio *chip,
419 struct snd_usb_substream *subs)
421 if (subs->data_endpoint) {
422 snd_usb_endpoint_set_sync(chip, subs->data_endpoint, NULL);
423 snd_usb_endpoint_close(chip, subs->data_endpoint);
424 subs->data_endpoint = NULL;
427 if (subs->sync_endpoint) {
428 snd_usb_endpoint_close(chip, subs->sync_endpoint);
429 subs->sync_endpoint = NULL;
433 static int configure_endpoints(struct snd_usb_audio *chip,
434 struct snd_usb_substream *subs)
438 if (subs->data_endpoint->need_setup) {
439 /* stop any running stream beforehand */
440 if (stop_endpoints(subs, false))
441 sync_pending_stops(subs);
442 err = snd_usb_endpoint_configure(chip, subs->data_endpoint);
445 snd_usb_set_format_quirk(subs, subs->cur_audiofmt);
448 if (subs->sync_endpoint) {
449 err = snd_usb_endpoint_configure(chip, subs->sync_endpoint);
460 * allocate a buffer and set the given audio format.
462 * so far we use a physically linear buffer although packetize transfer
463 * doesn't need a continuous area.
464 * if sg buffer is supported on the later version of alsa, we'll follow
467 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
468 struct snd_pcm_hw_params *hw_params)
470 struct snd_usb_substream *subs = substream->runtime->private_data;
471 struct snd_usb_audio *chip = subs->stream->chip;
472 const struct audioformat *fmt;
473 const struct audioformat *sync_fmt;
476 ret = snd_media_start_pipeline(subs);
480 fmt = find_substream_format(subs, hw_params);
483 "cannot find format: format=%s, rate=%d, channels=%d\n",
484 snd_pcm_format_name(params_format(hw_params)),
485 params_rate(hw_params), params_channels(hw_params));
490 if (fmt->implicit_fb) {
491 sync_fmt = snd_usb_find_implicit_fb_sync_format(chip, fmt,
496 "cannot find sync format: ep=0x%x, iface=%d:%d, format=%s, rate=%d, channels=%d\n",
497 fmt->sync_ep, fmt->sync_iface,
498 fmt->sync_altsetting,
499 snd_pcm_format_name(params_format(hw_params)),
500 params_rate(hw_params), params_channels(hw_params));
508 ret = snd_usb_lock_shutdown(chip);
512 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
516 if (subs->data_endpoint) {
517 if (snd_usb_endpoint_compatible(chip, subs->data_endpoint,
520 close_endpoints(chip, subs);
523 subs->data_endpoint = snd_usb_endpoint_open(chip, fmt, hw_params, false);
524 if (!subs->data_endpoint) {
530 subs->sync_endpoint = snd_usb_endpoint_open(chip, sync_fmt,
533 if (!subs->sync_endpoint) {
538 snd_usb_endpoint_set_sync(chip, subs->data_endpoint,
539 subs->sync_endpoint);
542 mutex_lock(&chip->mutex);
543 subs->cur_audiofmt = fmt;
544 mutex_unlock(&chip->mutex);
546 ret = configure_endpoints(chip, subs);
550 close_endpoints(chip, subs);
552 snd_usb_unlock_shutdown(chip);
555 snd_media_stop_pipeline(subs);
563 * reset the audio format and release the buffer
565 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
567 struct snd_usb_substream *subs = substream->runtime->private_data;
568 struct snd_usb_audio *chip = subs->stream->chip;
570 snd_media_stop_pipeline(subs);
571 mutex_lock(&chip->mutex);
572 subs->cur_audiofmt = NULL;
573 mutex_unlock(&chip->mutex);
574 if (!snd_usb_lock_shutdown(chip)) {
575 if (stop_endpoints(subs, false))
576 sync_pending_stops(subs);
577 close_endpoints(chip, subs);
578 snd_usb_unlock_shutdown(chip);
584 /* free-wheeling mode? (e.g. dmix) */
585 static int in_free_wheeling_mode(struct snd_pcm_runtime *runtime)
587 return runtime->stop_threshold > runtime->buffer_size;
590 /* check whether early start is needed for playback stream */
591 static int lowlatency_playback_available(struct snd_pcm_runtime *runtime,
592 struct snd_usb_substream *subs)
594 struct snd_usb_audio *chip = subs->stream->chip;
596 if (subs->direction == SNDRV_PCM_STREAM_CAPTURE)
598 /* disabled via module option? */
599 if (!chip->lowlatency)
601 if (in_free_wheeling_mode(runtime))
603 /* implicit feedback mode has own operation mode */
604 if (snd_usb_endpoint_implicit_feedback_sink(subs->data_endpoint))
612 * only a few subtle things...
614 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
616 struct snd_pcm_runtime *runtime = substream->runtime;
617 struct snd_usb_substream *subs = runtime->private_data;
618 struct snd_usb_audio *chip = subs->stream->chip;
621 ret = snd_usb_lock_shutdown(chip);
624 if (snd_BUG_ON(!subs->data_endpoint)) {
629 ret = configure_endpoints(chip, subs);
633 /* reset the pointer */
634 subs->buffer_bytes = frames_to_bytes(runtime, runtime->buffer_size);
635 subs->inflight_bytes = 0;
636 subs->hwptr_done = 0;
637 subs->transfer_done = 0;
638 subs->last_frame_number = 0;
639 subs->period_elapsed_pending = 0;
642 subs->lowlatency_playback = lowlatency_playback_available(runtime, subs);
643 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
644 !subs->lowlatency_playback)
645 ret = start_endpoints(subs);
648 snd_usb_unlock_shutdown(chip);
656 #ifdef HW_CONST_DEBUG
657 #define hwc_debug(fmt, args...) pr_debug(fmt, ##args)
659 #define hwc_debug(fmt, args...) do { } while(0)
662 #define MAX_BUFFER_BYTES (4 * 1024 * 1024)
663 #define MAX_PERIOD_BYTES (512 * 1024)
665 static const struct snd_pcm_hardware snd_usb_hardware =
667 .info = SNDRV_PCM_INFO_MMAP |
668 SNDRV_PCM_INFO_MMAP_VALID |
669 SNDRV_PCM_INFO_BATCH |
670 SNDRV_PCM_INFO_INTERLEAVED |
671 SNDRV_PCM_INFO_BLOCK_TRANSFER |
672 SNDRV_PCM_INFO_PAUSE,
675 .buffer_bytes_max = MAX_BUFFER_BYTES,
676 .period_bytes_min = 64,
677 .period_bytes_max = MAX_PERIOD_BYTES,
682 static int hw_check_valid_format(struct snd_usb_substream *subs,
683 struct snd_pcm_hw_params *params,
684 const struct audioformat *fp)
686 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
687 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
688 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
689 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
690 struct snd_mask check_fmts;
693 /* check the format */
694 snd_mask_none(&check_fmts);
695 check_fmts.bits[0] = (u32)fp->formats;
696 check_fmts.bits[1] = (u32)(fp->formats >> 32);
697 snd_mask_intersect(&check_fmts, fmts);
698 if (snd_mask_empty(&check_fmts)) {
699 hwc_debug(" > check: no supported format 0x%llx\n", fp->formats);
702 /* check the channels */
703 if (fp->channels < ct->min || fp->channels > ct->max) {
704 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
707 /* check the rate is within the range */
708 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
709 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
712 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
713 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
716 /* check whether the period time is >= the data packet interval */
717 if (subs->speed != USB_SPEED_FULL) {
718 ptime = 125 * (1 << fp->datainterval);
719 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
720 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
727 static int apply_hw_params_minmax(struct snd_interval *it, unsigned int rmin,
733 hwc_debug(" --> get empty\n");
739 if (it->min < rmin) {
744 if (it->max > rmax) {
749 if (snd_interval_checkempty(it)) {
753 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
757 static int hw_rule_rate(struct snd_pcm_hw_params *params,
758 struct snd_pcm_hw_rule *rule)
760 struct snd_usb_substream *subs = rule->private;
761 struct snd_usb_audio *chip = subs->stream->chip;
762 const struct audioformat *fp;
763 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
764 unsigned int rmin, rmax, r;
767 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
770 list_for_each_entry(fp, &subs->fmt_list, list) {
771 if (!hw_check_valid_format(subs, params, fp))
773 r = snd_usb_endpoint_get_clock_rate(chip, fp->clock);
775 if (!snd_interval_test(it, r))
781 if (fp->rate_table && fp->nr_rates) {
782 for (i = 0; i < fp->nr_rates; i++) {
783 r = fp->rate_table[i];
784 if (!snd_interval_test(it, r))
790 rmin = min(rmin, fp->rate_min);
791 rmax = max(rmax, fp->rate_max);
795 return apply_hw_params_minmax(it, rmin, rmax);
799 static int hw_rule_channels(struct snd_pcm_hw_params *params,
800 struct snd_pcm_hw_rule *rule)
802 struct snd_usb_substream *subs = rule->private;
803 const struct audioformat *fp;
804 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
805 unsigned int rmin, rmax;
807 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
810 list_for_each_entry(fp, &subs->fmt_list, list) {
811 if (!hw_check_valid_format(subs, params, fp))
813 rmin = min(rmin, fp->channels);
814 rmax = max(rmax, fp->channels);
817 return apply_hw_params_minmax(it, rmin, rmax);
820 static int apply_hw_params_format_bits(struct snd_mask *fmt, u64 fbits)
825 oldbits[0] = fmt->bits[0];
826 oldbits[1] = fmt->bits[1];
827 fmt->bits[0] &= (u32)fbits;
828 fmt->bits[1] &= (u32)(fbits >> 32);
829 if (!fmt->bits[0] && !fmt->bits[1]) {
830 hwc_debug(" --> get empty\n");
833 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
834 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
838 static int hw_rule_format(struct snd_pcm_hw_params *params,
839 struct snd_pcm_hw_rule *rule)
841 struct snd_usb_substream *subs = rule->private;
842 const struct audioformat *fp;
843 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
846 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
848 list_for_each_entry(fp, &subs->fmt_list, list) {
849 if (!hw_check_valid_format(subs, params, fp))
851 fbits |= fp->formats;
853 return apply_hw_params_format_bits(fmt, fbits);
856 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
857 struct snd_pcm_hw_rule *rule)
859 struct snd_usb_substream *subs = rule->private;
860 const struct audioformat *fp;
861 struct snd_interval *it;
862 unsigned char min_datainterval;
865 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
866 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
867 min_datainterval = 0xff;
868 list_for_each_entry(fp, &subs->fmt_list, list) {
869 if (!hw_check_valid_format(subs, params, fp))
871 min_datainterval = min(min_datainterval, fp->datainterval);
873 if (min_datainterval == 0xff) {
874 hwc_debug(" --> get empty\n");
878 pmin = 125 * (1 << min_datainterval);
880 return apply_hw_params_minmax(it, pmin, UINT_MAX);
883 /* get the EP or the sync EP for implicit fb when it's already set up */
884 static const struct snd_usb_endpoint *
885 get_sync_ep_from_substream(struct snd_usb_substream *subs)
887 struct snd_usb_audio *chip = subs->stream->chip;
888 const struct audioformat *fp;
889 const struct snd_usb_endpoint *ep;
891 list_for_each_entry(fp, &subs->fmt_list, list) {
892 ep = snd_usb_get_endpoint(chip, fp->endpoint);
893 if (ep && ep->cur_audiofmt) {
894 /* if EP is already opened solely for this substream,
895 * we still allow us to change the parameter; otherwise
896 * this substream has to follow the existing parameter
898 if (ep->cur_audiofmt != subs->cur_audiofmt || ep->opened > 1)
901 if (!fp->implicit_fb)
903 /* for the implicit fb, check the sync ep as well */
904 ep = snd_usb_get_endpoint(chip, fp->sync_ep);
905 if (ep && ep->cur_audiofmt)
911 /* additional hw constraints for implicit feedback mode */
912 static int hw_rule_format_implicit_fb(struct snd_pcm_hw_params *params,
913 struct snd_pcm_hw_rule *rule)
915 struct snd_usb_substream *subs = rule->private;
916 const struct snd_usb_endpoint *ep;
917 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
919 ep = get_sync_ep_from_substream(subs);
923 hwc_debug("applying %s\n", __func__);
924 return apply_hw_params_format_bits(fmt, pcm_format_to_bits(ep->cur_format));
927 static int hw_rule_rate_implicit_fb(struct snd_pcm_hw_params *params,
928 struct snd_pcm_hw_rule *rule)
930 struct snd_usb_substream *subs = rule->private;
931 const struct snd_usb_endpoint *ep;
932 struct snd_interval *it;
934 ep = get_sync_ep_from_substream(subs);
938 hwc_debug("applying %s\n", __func__);
939 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
940 return apply_hw_params_minmax(it, ep->cur_rate, ep->cur_rate);
943 static int hw_rule_period_size_implicit_fb(struct snd_pcm_hw_params *params,
944 struct snd_pcm_hw_rule *rule)
946 struct snd_usb_substream *subs = rule->private;
947 const struct snd_usb_endpoint *ep;
948 struct snd_interval *it;
950 ep = get_sync_ep_from_substream(subs);
954 hwc_debug("applying %s\n", __func__);
955 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
956 return apply_hw_params_minmax(it, ep->cur_period_frames,
957 ep->cur_period_frames);
960 static int hw_rule_periods_implicit_fb(struct snd_pcm_hw_params *params,
961 struct snd_pcm_hw_rule *rule)
963 struct snd_usb_substream *subs = rule->private;
964 const struct snd_usb_endpoint *ep;
965 struct snd_interval *it;
967 ep = get_sync_ep_from_substream(subs);
971 hwc_debug("applying %s\n", __func__);
972 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIODS);
973 return apply_hw_params_minmax(it, ep->cur_buffer_periods,
974 ep->cur_buffer_periods);
977 /* get the adjusted max buffer (or period) bytes that can fit with the
978 * paired format for implicit fb
981 get_adjusted_max_bytes(struct snd_usb_substream *subs,
982 struct snd_usb_substream *pair,
983 struct snd_pcm_hw_params *params,
984 unsigned int max_bytes,
987 const struct audioformat *fp, *pp;
988 unsigned int rmax = 0, r;
990 list_for_each_entry(fp, &subs->fmt_list, list) {
991 if (!fp->implicit_fb)
994 !hw_check_valid_format(subs, params, fp))
996 list_for_each_entry(pp, &pair->fmt_list, list) {
997 if (pp->iface != fp->sync_iface ||
998 pp->altsetting != fp->sync_altsetting ||
999 pp->ep_idx != fp->sync_ep_idx)
1002 !hw_check_valid_format(pair, params, pp))
1004 if (!reverse_map && pp->channels > fp->channels)
1005 r = max_bytes * fp->channels / pp->channels;
1006 else if (reverse_map && pp->channels < fp->channels)
1007 r = max_bytes * pp->channels / fp->channels;
1010 rmax = max(rmax, r);
1017 /* Reduce the period or buffer bytes depending on the paired substream;
1018 * when a paired configuration for implicit fb has a higher number of channels,
1019 * we need to reduce the max size accordingly, otherwise it may become unusable
1021 static int hw_rule_bytes_implicit_fb(struct snd_pcm_hw_params *params,
1022 struct snd_pcm_hw_rule *rule)
1024 struct snd_usb_substream *subs = rule->private;
1025 struct snd_usb_substream *pair;
1026 struct snd_interval *it;
1027 unsigned int max_bytes;
1030 pair = &subs->stream->substream[!subs->direction];
1034 if (rule->var == SNDRV_PCM_HW_PARAM_PERIOD_BYTES)
1035 max_bytes = MAX_PERIOD_BYTES;
1037 max_bytes = MAX_BUFFER_BYTES;
1039 rmax = get_adjusted_max_bytes(subs, pair, params, max_bytes, false);
1041 rmax = get_adjusted_max_bytes(pair, subs, params, max_bytes, true);
1045 it = hw_param_interval(params, rule->var);
1046 return apply_hw_params_minmax(it, 0, rmax);
1050 * set up the runtime hardware information.
1053 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1055 const struct audioformat *fp;
1056 unsigned int pt, ptmin;
1057 int param_period_time_if_needed = -1;
1060 runtime->hw.formats = subs->formats;
1062 runtime->hw.rate_min = 0x7fffffff;
1063 runtime->hw.rate_max = 0;
1064 runtime->hw.channels_min = 256;
1065 runtime->hw.channels_max = 0;
1066 runtime->hw.rates = 0;
1068 /* check min/max rates and channels */
1069 list_for_each_entry(fp, &subs->fmt_list, list) {
1070 runtime->hw.rates |= fp->rates;
1071 if (runtime->hw.rate_min > fp->rate_min)
1072 runtime->hw.rate_min = fp->rate_min;
1073 if (runtime->hw.rate_max < fp->rate_max)
1074 runtime->hw.rate_max = fp->rate_max;
1075 if (runtime->hw.channels_min > fp->channels)
1076 runtime->hw.channels_min = fp->channels;
1077 if (runtime->hw.channels_max < fp->channels)
1078 runtime->hw.channels_max = fp->channels;
1079 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1080 /* FIXME: there might be more than one audio formats... */
1081 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1084 pt = 125 * (1 << fp->datainterval);
1085 ptmin = min(ptmin, pt);
1088 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1089 if (subs->speed == USB_SPEED_FULL)
1090 /* full speed devices have fixed data packet interval */
1093 /* if period time doesn't go below 1 ms, no rules needed */
1094 param_period_time_if_needed = -1;
1096 err = snd_pcm_hw_constraint_minmax(runtime,
1097 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1102 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1104 SNDRV_PCM_HW_PARAM_RATE,
1105 SNDRV_PCM_HW_PARAM_FORMAT,
1106 SNDRV_PCM_HW_PARAM_CHANNELS,
1107 param_period_time_if_needed,
1112 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1113 hw_rule_channels, subs,
1114 SNDRV_PCM_HW_PARAM_CHANNELS,
1115 SNDRV_PCM_HW_PARAM_FORMAT,
1116 SNDRV_PCM_HW_PARAM_RATE,
1117 param_period_time_if_needed,
1121 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1122 hw_rule_format, subs,
1123 SNDRV_PCM_HW_PARAM_FORMAT,
1124 SNDRV_PCM_HW_PARAM_RATE,
1125 SNDRV_PCM_HW_PARAM_CHANNELS,
1126 param_period_time_if_needed,
1130 if (param_period_time_if_needed >= 0) {
1131 err = snd_pcm_hw_rule_add(runtime, 0,
1132 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1133 hw_rule_period_time, subs,
1134 SNDRV_PCM_HW_PARAM_FORMAT,
1135 SNDRV_PCM_HW_PARAM_CHANNELS,
1136 SNDRV_PCM_HW_PARAM_RATE,
1142 /* additional hw constraints for implicit fb */
1143 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1144 hw_rule_format_implicit_fb, subs,
1145 SNDRV_PCM_HW_PARAM_FORMAT, -1);
1148 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1149 hw_rule_rate_implicit_fb, subs,
1150 SNDRV_PCM_HW_PARAM_RATE, -1);
1153 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
1154 hw_rule_period_size_implicit_fb, subs,
1155 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
1158 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
1159 hw_rule_periods_implicit_fb, subs,
1160 SNDRV_PCM_HW_PARAM_PERIODS, -1);
1163 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
1164 hw_rule_bytes_implicit_fb, subs,
1165 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
1168 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
1169 hw_rule_bytes_implicit_fb, subs,
1170 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, -1);
1174 list_for_each_entry(fp, &subs->fmt_list, list) {
1175 if (fp->implicit_fb) {
1176 runtime->hw.info |= SNDRV_PCM_INFO_JOINT_DUPLEX;
1184 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1186 int direction = substream->stream;
1187 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1188 struct snd_pcm_runtime *runtime = substream->runtime;
1189 struct snd_usb_substream *subs = &as->substream[direction];
1192 runtime->hw = snd_usb_hardware;
1193 /* need an explicit sync to catch applptr update in low-latency mode */
1194 if (direction == SNDRV_PCM_STREAM_PLAYBACK &&
1195 as->chip->lowlatency)
1196 runtime->hw.info |= SNDRV_PCM_INFO_SYNC_APPLPTR;
1197 runtime->private_data = subs;
1198 subs->pcm_substream = substream;
1199 /* runtime PM is also done there */
1201 /* initialize DSD/DOP context */
1202 subs->dsd_dop.byte_idx = 0;
1203 subs->dsd_dop.channel = 0;
1204 subs->dsd_dop.marker = 1;
1206 ret = setup_hw_info(runtime, subs);
1209 ret = snd_usb_autoresume(subs->stream->chip);
1212 ret = snd_media_stream_init(subs, as->pcm, direction);
1214 snd_usb_autosuspend(subs->stream->chip);
1218 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1220 int direction = substream->stream;
1221 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1222 struct snd_usb_substream *subs = &as->substream[direction];
1225 snd_media_stop_pipeline(subs);
1227 if (!snd_usb_lock_shutdown(subs->stream->chip)) {
1228 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1229 snd_usb_unlock_shutdown(subs->stream->chip);
1234 subs->pcm_substream = NULL;
1235 snd_usb_autosuspend(subs->stream->chip);
1240 /* Since a URB can handle only a single linear buffer, we must use double
1241 * buffering when the data to be transferred overflows the buffer boundary.
1242 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1245 static void retire_capture_urb(struct snd_usb_substream *subs,
1248 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1249 unsigned int stride, frames, bytes, oldptr;
1250 int i, period_elapsed = 0;
1251 unsigned long flags;
1253 int current_frame_number;
1255 /* read frame number here, update pointer in critical section */
1256 current_frame_number = usb_get_current_frame_number(subs->dev);
1258 stride = runtime->frame_bits >> 3;
1260 for (i = 0; i < urb->number_of_packets; i++) {
1261 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1262 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1263 dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1264 i, urb->iso_frame_desc[i].status);
1267 bytes = urb->iso_frame_desc[i].actual_length;
1268 if (subs->stream_offset_adj > 0) {
1269 unsigned int adj = min(subs->stream_offset_adj, bytes);
1272 subs->stream_offset_adj -= adj;
1274 frames = bytes / stride;
1275 if (!subs->txfr_quirk)
1276 bytes = frames * stride;
1277 if (bytes % (runtime->sample_bits >> 3) != 0) {
1278 int oldbytes = bytes;
1279 bytes = frames * stride;
1280 dev_warn_ratelimited(&subs->dev->dev,
1281 "Corrected urb data len. %d->%d\n",
1284 /* update the current pointer */
1285 spin_lock_irqsave(&subs->lock, flags);
1286 oldptr = subs->hwptr_done;
1287 subs->hwptr_done += bytes;
1288 if (subs->hwptr_done >= subs->buffer_bytes)
1289 subs->hwptr_done -= subs->buffer_bytes;
1290 frames = (bytes + (oldptr % stride)) / stride;
1291 subs->transfer_done += frames;
1292 if (subs->transfer_done >= runtime->period_size) {
1293 subs->transfer_done -= runtime->period_size;
1297 /* realign last_frame_number */
1298 subs->last_frame_number = current_frame_number;
1300 spin_unlock_irqrestore(&subs->lock, flags);
1301 /* copy a data chunk */
1302 if (oldptr + bytes > subs->buffer_bytes) {
1303 unsigned int bytes1 = subs->buffer_bytes - oldptr;
1305 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1306 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1308 memcpy(runtime->dma_area + oldptr, cp, bytes);
1313 snd_pcm_period_elapsed(subs->pcm_substream);
1316 static void urb_ctx_queue_advance(struct snd_usb_substream *subs,
1317 struct urb *urb, unsigned int bytes)
1319 struct snd_urb_ctx *ctx = urb->context;
1321 ctx->queued += bytes;
1322 subs->inflight_bytes += bytes;
1323 subs->hwptr_done += bytes;
1324 if (subs->hwptr_done >= subs->buffer_bytes)
1325 subs->hwptr_done -= subs->buffer_bytes;
1328 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1329 struct urb *urb, unsigned int bytes)
1331 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1332 unsigned int dst_idx = 0;
1333 unsigned int src_idx = subs->hwptr_done;
1334 unsigned int wrap = subs->buffer_bytes;
1335 u8 *dst = urb->transfer_buffer;
1336 u8 *src = runtime->dma_area;
1337 u8 marker[] = { 0x05, 0xfa };
1338 unsigned int queued = 0;
1341 * The DSP DOP format defines a way to transport DSD samples over
1342 * normal PCM data endpoints. It requires stuffing of marker bytes
1343 * (0x05 and 0xfa, alternating per sample frame), and then expects
1344 * 2 additional bytes of actual payload. The whole frame is stored
1347 * Hence, for a stereo transport, the buffer layout looks like this,
1348 * where L refers to left channel samples and R to right.
1350 * L1 L2 0x05 R1 R2 0x05 L3 L4 0xfa R3 R4 0xfa
1351 * L5 L6 0x05 R5 R6 0x05 L7 L8 0xfa R7 R8 0xfa
1357 if (++subs->dsd_dop.byte_idx == 3) {
1358 /* frame boundary? */
1359 dst[dst_idx++] = marker[subs->dsd_dop.marker];
1361 subs->dsd_dop.byte_idx = 0;
1363 if (++subs->dsd_dop.channel % runtime->channels == 0) {
1364 /* alternate the marker */
1365 subs->dsd_dop.marker++;
1366 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1367 subs->dsd_dop.channel = 0;
1370 /* stuff the DSD payload */
1371 int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1373 if (subs->cur_audiofmt->dsd_bitrev)
1374 dst[dst_idx++] = bitrev8(src[idx]);
1376 dst[dst_idx++] = src[idx];
1381 urb_ctx_queue_advance(subs, urb, queued);
1384 /* copy bit-reversed bytes onto transfer buffer */
1385 static void fill_playback_urb_dsd_bitrev(struct snd_usb_substream *subs,
1386 struct urb *urb, unsigned int bytes)
1388 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1389 const u8 *src = runtime->dma_area;
1390 u8 *buf = urb->transfer_buffer;
1391 int i, ofs = subs->hwptr_done;
1393 for (i = 0; i < bytes; i++) {
1394 *buf++ = bitrev8(src[ofs]);
1395 if (++ofs >= subs->buffer_bytes)
1399 urb_ctx_queue_advance(subs, urb, bytes);
1402 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1403 int offset, int stride, unsigned int bytes)
1405 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1407 if (subs->hwptr_done + bytes > subs->buffer_bytes) {
1408 /* err, the transferred area goes over buffer boundary. */
1409 unsigned int bytes1 = subs->buffer_bytes - subs->hwptr_done;
1411 memcpy(urb->transfer_buffer + offset,
1412 runtime->dma_area + subs->hwptr_done, bytes1);
1413 memcpy(urb->transfer_buffer + offset + bytes1,
1414 runtime->dma_area, bytes - bytes1);
1416 memcpy(urb->transfer_buffer + offset,
1417 runtime->dma_area + subs->hwptr_done, bytes);
1420 urb_ctx_queue_advance(subs, urb, bytes);
1423 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1424 struct urb *urb, int stride,
1427 __le32 packet_length;
1430 /* Put __le32 length descriptor at start of each packet. */
1431 for (i = 0; i < urb->number_of_packets; i++) {
1432 unsigned int length = urb->iso_frame_desc[i].length;
1433 unsigned int offset = urb->iso_frame_desc[i].offset;
1435 packet_length = cpu_to_le32(length);
1436 offset += i * sizeof(packet_length);
1437 urb->iso_frame_desc[i].offset = offset;
1438 urb->iso_frame_desc[i].length += sizeof(packet_length);
1439 memcpy(urb->transfer_buffer + offset,
1440 &packet_length, sizeof(packet_length));
1441 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1444 /* Adjust transfer size accordingly. */
1445 bytes += urb->number_of_packets * sizeof(packet_length);
1449 static int prepare_playback_urb(struct snd_usb_substream *subs,
1451 bool in_stream_lock)
1453 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1454 struct snd_usb_endpoint *ep = subs->data_endpoint;
1455 struct snd_urb_ctx *ctx = urb->context;
1456 unsigned int frames, bytes;
1458 unsigned int transfer_done, frame_limit, avail = 0;
1459 int i, stride, period_elapsed = 0;
1460 unsigned long flags;
1463 stride = ep->stride;
1467 urb->number_of_packets = 0;
1469 spin_lock_irqsave(&subs->lock, flags);
1470 frame_limit = subs->frame_limit + ep->max_urb_frames;
1471 transfer_done = subs->transfer_done;
1473 if (subs->lowlatency_playback &&
1474 runtime->status->state != SNDRV_PCM_STATE_DRAINING) {
1475 unsigned int hwptr = subs->hwptr_done / stride;
1477 /* calculate the byte offset-in-buffer of the appl_ptr */
1478 avail = (runtime->control->appl_ptr - runtime->hw_ptr_base)
1479 % runtime->buffer_size;
1481 avail += runtime->buffer_size;
1485 for (i = 0; i < ctx->packets; i++) {
1486 counts = snd_usb_endpoint_next_packet_size(ep, ctx, i, avail);
1489 /* set up descriptor */
1490 urb->iso_frame_desc[i].offset = frames * stride;
1491 urb->iso_frame_desc[i].length = counts * stride;
1494 urb->number_of_packets++;
1495 transfer_done += counts;
1496 if (transfer_done >= runtime->period_size) {
1497 transfer_done -= runtime->period_size;
1500 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1501 if (transfer_done > 0) {
1502 /* FIXME: fill-max mode is not
1504 frames -= transfer_done;
1505 counts -= transfer_done;
1506 urb->iso_frame_desc[i].length =
1511 if (i < ctx->packets) {
1512 /* add a transfer delimiter */
1513 urb->iso_frame_desc[i].offset =
1515 urb->iso_frame_desc[i].length = 0;
1516 urb->number_of_packets++;
1521 /* finish at the period boundary or after enough frames */
1522 if ((period_elapsed || transfer_done >= frame_limit) &&
1523 !snd_usb_endpoint_implicit_feedback_sink(ep))
1532 bytes = frames * stride;
1533 subs->transfer_done = transfer_done;
1534 subs->frame_limit = frame_limit;
1535 if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1536 subs->cur_audiofmt->dsd_dop)) {
1537 fill_playback_urb_dsd_dop(subs, urb, bytes);
1538 } else if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1539 subs->cur_audiofmt->dsd_bitrev)) {
1540 fill_playback_urb_dsd_bitrev(subs, urb, bytes);
1543 if (!subs->tx_length_quirk)
1544 copy_to_urb(subs, urb, 0, stride, bytes);
1546 bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1547 /* bytes is now amount of outgoing data */
1550 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1552 if (subs->trigger_tstamp_pending_update) {
1553 /* this is the first actual URB submitted,
1554 * update trigger timestamp to reflect actual start time
1556 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1557 subs->trigger_tstamp_pending_update = false;
1560 if (period_elapsed && !subs->running && subs->lowlatency_playback) {
1561 subs->period_elapsed_pending = 1;
1566 spin_unlock_irqrestore(&subs->lock, flags);
1569 urb->transfer_buffer_length = bytes;
1570 if (period_elapsed) {
1572 snd_pcm_period_elapsed_under_stream_lock(subs->pcm_substream);
1574 snd_pcm_period_elapsed(subs->pcm_substream);
1580 * process after playback data complete
1581 * - decrease the delay count again
1583 static void retire_playback_urb(struct snd_usb_substream *subs,
1586 unsigned long flags;
1587 struct snd_urb_ctx *ctx = urb->context;
1588 bool period_elapsed = false;
1590 spin_lock_irqsave(&subs->lock, flags);
1592 if (subs->inflight_bytes >= ctx->queued)
1593 subs->inflight_bytes -= ctx->queued;
1595 subs->inflight_bytes = 0;
1598 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1599 if (subs->running) {
1600 period_elapsed = subs->period_elapsed_pending;
1601 subs->period_elapsed_pending = 0;
1603 spin_unlock_irqrestore(&subs->lock, flags);
1605 snd_pcm_period_elapsed(subs->pcm_substream);
1608 /* PCM ack callback for the playback stream;
1609 * this plays a role only when the stream is running in low-latency mode.
1611 static int snd_usb_pcm_playback_ack(struct snd_pcm_substream *substream)
1613 struct snd_usb_substream *subs = substream->runtime->private_data;
1614 struct snd_usb_endpoint *ep;
1616 if (!subs->lowlatency_playback || !subs->running)
1618 ep = subs->data_endpoint;
1621 /* When no more in-flight URBs available, try to process the pending
1624 if (!ep->active_mask)
1625 snd_usb_queue_pending_output_urbs(ep, true);
1629 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1632 struct snd_usb_substream *subs = substream->runtime->private_data;
1636 case SNDRV_PCM_TRIGGER_START:
1637 subs->trigger_tstamp_pending_update = true;
1639 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1640 snd_usb_endpoint_set_callback(subs->data_endpoint,
1641 prepare_playback_urb,
1642 retire_playback_urb,
1644 if (subs->lowlatency_playback &&
1645 cmd == SNDRV_PCM_TRIGGER_START) {
1646 if (in_free_wheeling_mode(substream->runtime))
1647 subs->lowlatency_playback = false;
1648 err = start_endpoints(subs);
1650 snd_usb_endpoint_set_callback(subs->data_endpoint,
1656 dev_dbg(&subs->dev->dev, "%d:%d Start Playback PCM\n",
1657 subs->cur_audiofmt->iface,
1658 subs->cur_audiofmt->altsetting);
1660 case SNDRV_PCM_TRIGGER_SUSPEND:
1661 case SNDRV_PCM_TRIGGER_STOP:
1662 stop_endpoints(subs, substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING);
1663 snd_usb_endpoint_set_callback(subs->data_endpoint,
1666 dev_dbg(&subs->dev->dev, "%d:%d Stop Playback PCM\n",
1667 subs->cur_audiofmt->iface,
1668 subs->cur_audiofmt->altsetting);
1670 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1671 /* keep retire_data_urb for delay calculation */
1672 snd_usb_endpoint_set_callback(subs->data_endpoint,
1674 retire_playback_urb,
1677 dev_dbg(&subs->dev->dev, "%d:%d Pause Playback PCM\n",
1678 subs->cur_audiofmt->iface,
1679 subs->cur_audiofmt->altsetting);
1686 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1690 struct snd_usb_substream *subs = substream->runtime->private_data;
1693 case SNDRV_PCM_TRIGGER_START:
1694 err = start_endpoints(subs);
1698 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1699 snd_usb_endpoint_set_callback(subs->data_endpoint,
1700 NULL, retire_capture_urb,
1702 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1704 dev_dbg(&subs->dev->dev, "%d:%d Start Capture PCM\n",
1705 subs->cur_audiofmt->iface,
1706 subs->cur_audiofmt->altsetting);
1708 case SNDRV_PCM_TRIGGER_SUSPEND:
1709 case SNDRV_PCM_TRIGGER_STOP:
1710 stop_endpoints(subs, false);
1712 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1713 snd_usb_endpoint_set_callback(subs->data_endpoint,
1716 dev_dbg(&subs->dev->dev, "%d:%d Stop Capture PCM\n",
1717 subs->cur_audiofmt->iface,
1718 subs->cur_audiofmt->altsetting);
1725 static const struct snd_pcm_ops snd_usb_playback_ops = {
1726 .open = snd_usb_pcm_open,
1727 .close = snd_usb_pcm_close,
1728 .hw_params = snd_usb_hw_params,
1729 .hw_free = snd_usb_hw_free,
1730 .prepare = snd_usb_pcm_prepare,
1731 .trigger = snd_usb_substream_playback_trigger,
1732 .sync_stop = snd_usb_pcm_sync_stop,
1733 .pointer = snd_usb_pcm_pointer,
1734 .ack = snd_usb_pcm_playback_ack,
1737 static const struct snd_pcm_ops snd_usb_capture_ops = {
1738 .open = snd_usb_pcm_open,
1739 .close = snd_usb_pcm_close,
1740 .hw_params = snd_usb_hw_params,
1741 .hw_free = snd_usb_hw_free,
1742 .prepare = snd_usb_pcm_prepare,
1743 .trigger = snd_usb_substream_capture_trigger,
1744 .sync_stop = snd_usb_pcm_sync_stop,
1745 .pointer = snd_usb_pcm_pointer,
1748 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1750 const struct snd_pcm_ops *ops;
1752 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1753 &snd_usb_playback_ops : &snd_usb_capture_ops;
1754 snd_pcm_set_ops(pcm, stream, ops);
1757 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1759 struct snd_pcm *pcm = subs->stream->pcm;
1760 struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1761 struct device *dev = subs->dev->bus->sysdev;
1763 if (snd_usb_use_vmalloc)
1764 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_VMALLOC,
1767 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_DEV_SG,
1768 dev, 64*1024, 512*1024);