arm64: bpf: Fix branch offset in JIT
[linux/fpc-iii.git] / sound / usb / pcm.c
blob878f1201aad6e828473a2b73905e281096d396c2
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 */
5 #include <linux/init.h>
6 #include <linux/slab.h>
7 #include <linux/bitrev.h>
8 #include <linux/ratelimit.h>
9 #include <linux/usb.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>
17 #include "usbaudio.h"
18 #include "card.h"
19 #include "quirks.h"
20 #include "debug.h"
21 #include "endpoint.h"
22 #include "helper.h"
23 #include "pcm.h"
24 #include "clock.h"
25 #include "power.h"
26 #include "media.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 snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
33 unsigned int rate)
35 int current_frame_number;
36 int frame_diff;
37 int est_delay;
39 if (!subs->last_delay)
40 return 0; /* short path */
42 current_frame_number = usb_get_current_frame_number(subs->dev);
44 * HCD implementations use different widths, use lower 8 bits.
45 * The delay will be managed up to 256ms, which is more than
46 * enough
48 frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
50 /* Approximation based on number of samples per USB frame (ms),
51 some truncation for 44.1 but the estimate is good enough */
52 est_delay = frame_diff * rate / 1000;
53 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
54 est_delay = subs->last_delay - est_delay;
55 else
56 est_delay = subs->last_delay + est_delay;
58 if (est_delay < 0)
59 est_delay = 0;
60 return est_delay;
64 * return the current pcm pointer. just based on the hwptr_done value.
66 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
68 struct snd_usb_substream *subs = substream->runtime->private_data;
69 unsigned int hwptr_done;
71 if (atomic_read(&subs->stream->chip->shutdown))
72 return SNDRV_PCM_POS_XRUN;
73 spin_lock(&subs->lock);
74 hwptr_done = subs->hwptr_done;
75 substream->runtime->delay = snd_usb_pcm_delay(subs,
76 substream->runtime->rate);
77 spin_unlock(&subs->lock);
78 return hwptr_done / (substream->runtime->frame_bits >> 3);
82 * find a matching audio format
84 static struct audioformat *find_format(struct snd_usb_substream *subs)
86 struct audioformat *fp;
87 struct audioformat *found = NULL;
88 int cur_attr = 0, attr;
90 list_for_each_entry(fp, &subs->fmt_list, list) {
91 if (!(fp->formats & pcm_format_to_bits(subs->pcm_format)))
92 continue;
93 if (fp->channels != subs->channels)
94 continue;
95 if (subs->cur_rate < fp->rate_min ||
96 subs->cur_rate > fp->rate_max)
97 continue;
98 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
99 unsigned int i;
100 for (i = 0; i < fp->nr_rates; i++)
101 if (fp->rate_table[i] == subs->cur_rate)
102 break;
103 if (i >= fp->nr_rates)
104 continue;
106 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
107 if (! found) {
108 found = fp;
109 cur_attr = attr;
110 continue;
112 /* avoid async out and adaptive in if the other method
113 * supports the same format.
114 * this is a workaround for the case like
115 * M-audio audiophile USB.
117 if (attr != cur_attr) {
118 if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
119 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
120 (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
121 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
122 continue;
123 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
124 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
125 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
126 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
127 found = fp;
128 cur_attr = attr;
129 continue;
132 /* find the format with the largest max. packet size */
133 if (fp->maxpacksize > found->maxpacksize) {
134 found = fp;
135 cur_attr = attr;
138 return found;
141 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
142 struct usb_host_interface *alts,
143 struct audioformat *fmt)
145 struct usb_device *dev = chip->dev;
146 unsigned int ep;
147 unsigned char data[1];
148 int err;
150 if (get_iface_desc(alts)->bNumEndpoints < 1)
151 return -EINVAL;
152 ep = get_endpoint(alts, 0)->bEndpointAddress;
154 data[0] = 1;
155 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
156 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
157 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
158 data, sizeof(data));
159 if (err < 0) {
160 usb_audio_err(chip, "%d:%d: cannot set enable PITCH\n",
161 iface, ep);
162 return err;
165 return 0;
168 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
169 struct usb_host_interface *alts,
170 struct audioformat *fmt)
172 struct usb_device *dev = chip->dev;
173 unsigned char data[1];
174 int err;
176 data[0] = 1;
177 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
178 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
179 UAC2_EP_CS_PITCH << 8, 0,
180 data, sizeof(data));
181 if (err < 0) {
182 usb_audio_err(chip, "%d:%d: cannot set enable PITCH (v2)\n",
183 iface, fmt->altsetting);
184 return err;
187 return 0;
191 * initialize the pitch control and sample rate
193 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
194 struct usb_host_interface *alts,
195 struct audioformat *fmt)
197 /* if endpoint doesn't have pitch control, bail out */
198 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
199 return 0;
201 switch (fmt->protocol) {
202 case UAC_VERSION_1:
203 default:
204 return init_pitch_v1(chip, iface, alts, fmt);
206 case UAC_VERSION_2:
207 return init_pitch_v2(chip, iface, alts, fmt);
211 static int start_endpoints(struct snd_usb_substream *subs)
213 int err;
215 if (!subs->data_endpoint)
216 return -EINVAL;
218 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
219 struct snd_usb_endpoint *ep = subs->data_endpoint;
221 dev_dbg(&subs->dev->dev, "Starting data EP @%p\n", ep);
223 ep->data_subs = subs;
224 err = snd_usb_endpoint_start(ep);
225 if (err < 0) {
226 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
227 return err;
231 if (subs->sync_endpoint &&
232 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
233 struct snd_usb_endpoint *ep = subs->sync_endpoint;
235 if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
236 subs->data_endpoint->altsetting != subs->sync_endpoint->altsetting) {
237 err = usb_set_interface(subs->dev,
238 subs->sync_endpoint->iface,
239 subs->sync_endpoint->altsetting);
240 if (err < 0) {
241 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
242 dev_err(&subs->dev->dev,
243 "%d:%d: cannot set interface (%d)\n",
244 subs->sync_endpoint->iface,
245 subs->sync_endpoint->altsetting, err);
246 return -EIO;
250 dev_dbg(&subs->dev->dev, "Starting sync EP @%p\n", ep);
252 ep->sync_slave = subs->data_endpoint;
253 err = snd_usb_endpoint_start(ep);
254 if (err < 0) {
255 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
256 return err;
260 return 0;
263 static void stop_endpoints(struct snd_usb_substream *subs, bool wait)
265 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
266 snd_usb_endpoint_stop(subs->sync_endpoint);
268 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
269 snd_usb_endpoint_stop(subs->data_endpoint);
271 if (wait) {
272 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
273 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
277 static int search_roland_implicit_fb(struct usb_device *dev, int ifnum,
278 unsigned int altsetting,
279 struct usb_host_interface **alts,
280 unsigned int *ep)
282 struct usb_interface *iface;
283 struct usb_interface_descriptor *altsd;
284 struct usb_endpoint_descriptor *epd;
286 iface = usb_ifnum_to_if(dev, ifnum);
287 if (!iface || iface->num_altsetting < altsetting + 1)
288 return -ENOENT;
289 *alts = &iface->altsetting[altsetting];
290 altsd = get_iface_desc(*alts);
291 if (altsd->bAlternateSetting != altsetting ||
292 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
293 (altsd->bInterfaceSubClass != 2 &&
294 altsd->bInterfaceProtocol != 2 ) ||
295 altsd->bNumEndpoints < 1)
296 return -ENOENT;
297 epd = get_endpoint(*alts, 0);
298 if (!usb_endpoint_is_isoc_in(epd) ||
299 (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
300 USB_ENDPOINT_USAGE_IMPLICIT_FB)
301 return -ENOENT;
302 *ep = epd->bEndpointAddress;
303 return 0;
306 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk
307 * applies. Returns 1 if a quirk was found.
309 static int set_sync_ep_implicit_fb_quirk(struct snd_usb_substream *subs,
310 struct usb_device *dev,
311 struct usb_interface_descriptor *altsd,
312 unsigned int attr)
314 struct usb_host_interface *alts;
315 struct usb_interface *iface;
316 unsigned int ep;
317 unsigned int ifnum;
319 /* Implicit feedback sync EPs consumers are always playback EPs */
320 if (subs->direction != SNDRV_PCM_STREAM_PLAYBACK)
321 return 0;
323 switch (subs->stream->chip->usb_id) {
324 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
325 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
326 ep = 0x81;
327 ifnum = 3;
328 goto add_sync_ep_from_ifnum;
329 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
330 case USB_ID(0x0763, 0x2081):
331 ep = 0x81;
332 ifnum = 2;
333 goto add_sync_ep_from_ifnum;
334 case USB_ID(0x2466, 0x8003): /* Fractal Audio Axe-Fx II */
335 ep = 0x86;
336 ifnum = 2;
337 goto add_sync_ep_from_ifnum;
338 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx III */
339 ep = 0x81;
340 ifnum = 2;
341 goto add_sync_ep_from_ifnum;
342 case USB_ID(0x1397, 0x0001): /* Behringer UFX1604 */
343 case USB_ID(0x1397, 0x0002): /* Behringer UFX1204 */
344 ep = 0x81;
345 ifnum = 1;
346 goto add_sync_ep_from_ifnum;
347 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II/IIc */
348 /* MicroBook IIc */
349 if (altsd->bInterfaceClass == USB_CLASS_AUDIO)
350 return 0;
352 /* MicroBook II */
353 ep = 0x84;
354 ifnum = 0;
355 goto add_sync_ep_from_ifnum;
356 case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
357 case USB_ID(0x31e9, 0x0001): /* Solid State Logic SSL2 */
358 case USB_ID(0x31e9, 0x0002): /* Solid State Logic SSL2+ */
359 case USB_ID(0x0499, 0x172f): /* Steinberg UR22C */
360 case USB_ID(0x0d9a, 0x00df): /* RTX6001 */
361 ep = 0x81;
362 ifnum = 2;
363 goto add_sync_ep_from_ifnum;
364 case USB_ID(0x0582, 0x01d8): /* BOSS Katana */
365 /* BOSS Katana amplifiers do not need quirks */
366 return 0;
369 if (attr == USB_ENDPOINT_SYNC_ASYNC &&
370 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
371 altsd->bInterfaceProtocol == 2 &&
372 altsd->bNumEndpoints == 1 &&
373 USB_ID_VENDOR(subs->stream->chip->usb_id) == 0x0582 /* Roland */ &&
374 search_roland_implicit_fb(dev, altsd->bInterfaceNumber + 1,
375 altsd->bAlternateSetting,
376 &alts, &ep) >= 0) {
377 goto add_sync_ep;
380 /* No quirk */
381 return 0;
383 add_sync_ep_from_ifnum:
384 iface = usb_ifnum_to_if(dev, ifnum);
386 if (!iface || iface->num_altsetting < 2)
387 return -EINVAL;
389 alts = &iface->altsetting[1];
391 add_sync_ep:
392 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
393 alts, ep, !subs->direction,
394 SND_USB_ENDPOINT_TYPE_DATA);
395 if (!subs->sync_endpoint)
396 return -EINVAL;
398 subs->sync_endpoint->is_implicit_feedback = 1;
400 subs->data_endpoint->sync_master = subs->sync_endpoint;
402 return 1;
405 static int set_sync_endpoint(struct snd_usb_substream *subs,
406 struct audioformat *fmt,
407 struct usb_device *dev,
408 struct usb_host_interface *alts,
409 struct usb_interface_descriptor *altsd)
411 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
412 unsigned int ep, attr;
413 bool implicit_fb;
414 int err;
416 /* we need a sync pipe in async OUT or adaptive IN mode */
417 /* check the number of EP, since some devices have broken
418 * descriptors which fool us. if it has only one EP,
419 * assume it as adaptive-out or sync-in.
421 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
423 if ((is_playback && (attr != USB_ENDPOINT_SYNC_ASYNC)) ||
424 (!is_playback && (attr != USB_ENDPOINT_SYNC_ADAPTIVE))) {
427 * In these modes the notion of sync_endpoint is irrelevant.
428 * Reset pointers to avoid using stale data from previously
429 * used settings, e.g. when configuration and endpoints were
430 * changed
433 subs->sync_endpoint = NULL;
434 subs->data_endpoint->sync_master = NULL;
437 err = set_sync_ep_implicit_fb_quirk(subs, dev, altsd, attr);
438 if (err < 0)
439 return err;
441 /* endpoint set by quirk */
442 if (err > 0)
443 return 0;
445 if (altsd->bNumEndpoints < 2)
446 return 0;
448 if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC ||
449 attr == USB_ENDPOINT_SYNC_ADAPTIVE)) ||
450 (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
451 return 0;
454 * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see
455 * if we don't find a sync endpoint, as on M-Audio Transit. In case of
456 * error fall back to SYNC mode and don't create sync endpoint
459 /* check sync-pipe endpoint */
460 /* ... and check descriptor size before accessing bSynchAddress
461 because there is a version of the SB Audigy 2 NX firmware lacking
462 the audio fields in the endpoint descriptors */
463 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
464 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
465 get_endpoint(alts, 1)->bSynchAddress != 0)) {
466 dev_err(&dev->dev,
467 "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
468 fmt->iface, fmt->altsetting,
469 get_endpoint(alts, 1)->bmAttributes,
470 get_endpoint(alts, 1)->bLength,
471 get_endpoint(alts, 1)->bSynchAddress);
472 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
473 return 0;
474 return -EINVAL;
476 ep = get_endpoint(alts, 1)->bEndpointAddress;
477 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
478 get_endpoint(alts, 0)->bSynchAddress != 0 &&
479 ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
480 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
481 dev_err(&dev->dev,
482 "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
483 fmt->iface, fmt->altsetting,
484 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
485 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
486 return 0;
487 return -EINVAL;
490 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
491 == USB_ENDPOINT_USAGE_IMPLICIT_FB;
493 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
494 alts, ep, !subs->direction,
495 implicit_fb ?
496 SND_USB_ENDPOINT_TYPE_DATA :
497 SND_USB_ENDPOINT_TYPE_SYNC);
499 if (!subs->sync_endpoint) {
500 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
501 return 0;
502 return -EINVAL;
505 subs->sync_endpoint->is_implicit_feedback = implicit_fb;
507 subs->data_endpoint->sync_master = subs->sync_endpoint;
509 return 0;
513 * find a matching format and set up the interface
515 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
517 struct usb_device *dev = subs->dev;
518 struct usb_host_interface *alts;
519 struct usb_interface_descriptor *altsd;
520 struct usb_interface *iface;
521 int err;
523 iface = usb_ifnum_to_if(dev, fmt->iface);
524 if (WARN_ON(!iface))
525 return -EINVAL;
526 alts = usb_altnum_to_altsetting(iface, fmt->altsetting);
527 if (WARN_ON(!alts))
528 return -EINVAL;
529 altsd = get_iface_desc(alts);
531 if (fmt == subs->cur_audiofmt && !subs->need_setup_fmt)
532 return 0;
534 /* close the old interface */
535 if (subs->interface >= 0 && (subs->interface != fmt->iface || subs->need_setup_fmt)) {
536 if (!subs->stream->chip->keep_iface) {
537 err = usb_set_interface(subs->dev, subs->interface, 0);
538 if (err < 0) {
539 dev_err(&dev->dev,
540 "%d:%d: return to setting 0 failed (%d)\n",
541 fmt->iface, fmt->altsetting, err);
542 return -EIO;
545 subs->interface = -1;
546 subs->altset_idx = 0;
549 if (subs->need_setup_fmt)
550 subs->need_setup_fmt = false;
552 /* set interface */
553 if (iface->cur_altsetting != alts) {
554 err = snd_usb_select_mode_quirk(subs, fmt);
555 if (err < 0)
556 return -EIO;
558 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
559 if (err < 0) {
560 dev_err(&dev->dev,
561 "%d:%d: usb_set_interface failed (%d)\n",
562 fmt->iface, fmt->altsetting, err);
563 return -EIO;
565 dev_dbg(&dev->dev, "setting usb interface %d:%d\n",
566 fmt->iface, fmt->altsetting);
567 snd_usb_set_interface_quirk(dev);
570 subs->interface = fmt->iface;
571 subs->altset_idx = fmt->altset_idx;
572 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
573 alts, fmt->endpoint, subs->direction,
574 SND_USB_ENDPOINT_TYPE_DATA);
576 if (!subs->data_endpoint)
577 return -EINVAL;
579 err = set_sync_endpoint(subs, fmt, dev, alts, altsd);
580 if (err < 0)
581 return err;
583 err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt);
584 if (err < 0)
585 return err;
587 subs->cur_audiofmt = fmt;
589 snd_usb_set_format_quirk(subs, fmt);
591 return 0;
595 * Return the score of matching two audioformats.
596 * Veto the audioformat if:
597 * - It has no channels for some reason.
598 * - Requested PCM format is not supported.
599 * - Requested sample rate is not supported.
601 static int match_endpoint_audioformats(struct snd_usb_substream *subs,
602 struct audioformat *fp,
603 struct audioformat *match, int rate,
604 snd_pcm_format_t pcm_format)
606 int i;
607 int score = 0;
609 if (fp->channels < 1) {
610 dev_dbg(&subs->dev->dev,
611 "%s: (fmt @%p) no channels\n", __func__, fp);
612 return 0;
615 if (!(fp->formats & pcm_format_to_bits(pcm_format))) {
616 dev_dbg(&subs->dev->dev,
617 "%s: (fmt @%p) no match for format %d\n", __func__,
618 fp, pcm_format);
619 return 0;
622 for (i = 0; i < fp->nr_rates; i++) {
623 if (fp->rate_table[i] == rate) {
624 score++;
625 break;
628 if (!score) {
629 dev_dbg(&subs->dev->dev,
630 "%s: (fmt @%p) no match for rate %d\n", __func__,
631 fp, rate);
632 return 0;
635 if (fp->channels == match->channels)
636 score++;
638 dev_dbg(&subs->dev->dev,
639 "%s: (fmt @%p) score %d\n", __func__, fp, score);
641 return score;
645 * Configure the sync ep using the rate and pcm format of the data ep.
647 static int configure_sync_endpoint(struct snd_usb_substream *subs)
649 int ret;
650 struct audioformat *fp;
651 struct audioformat *sync_fp = NULL;
652 int cur_score = 0;
653 int sync_period_bytes = subs->period_bytes;
654 struct snd_usb_substream *sync_subs =
655 &subs->stream->substream[subs->direction ^ 1];
657 if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
658 !subs->stream)
659 return snd_usb_endpoint_set_params(subs->sync_endpoint,
660 subs->pcm_format,
661 subs->channels,
662 subs->period_bytes,
663 0, 0,
664 subs->cur_rate,
665 subs->cur_audiofmt,
666 NULL);
668 /* Try to find the best matching audioformat. */
669 list_for_each_entry(fp, &sync_subs->fmt_list, list) {
670 int score = match_endpoint_audioformats(subs,
671 fp, subs->cur_audiofmt,
672 subs->cur_rate, subs->pcm_format);
674 if (score > cur_score) {
675 sync_fp = fp;
676 cur_score = score;
680 if (unlikely(sync_fp == NULL)) {
681 dev_err(&subs->dev->dev,
682 "%s: no valid audioformat for sync ep %x found\n",
683 __func__, sync_subs->ep_num);
684 return -EINVAL;
688 * Recalculate the period bytes if channel number differ between
689 * data and sync ep audioformat.
691 if (sync_fp->channels != subs->channels) {
692 sync_period_bytes = (subs->period_bytes / subs->channels) *
693 sync_fp->channels;
694 dev_dbg(&subs->dev->dev,
695 "%s: adjusted sync ep period bytes (%d -> %d)\n",
696 __func__, subs->period_bytes, sync_period_bytes);
699 ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
700 subs->pcm_format,
701 sync_fp->channels,
702 sync_period_bytes,
703 0, 0,
704 subs->cur_rate,
705 sync_fp,
706 NULL);
708 return ret;
712 * configure endpoint params
714 * called during initial setup and upon resume
716 static int configure_endpoint(struct snd_usb_substream *subs)
718 int ret;
720 /* format changed */
721 stop_endpoints(subs, true);
722 ret = snd_usb_endpoint_set_params(subs->data_endpoint,
723 subs->pcm_format,
724 subs->channels,
725 subs->period_bytes,
726 subs->period_frames,
727 subs->buffer_periods,
728 subs->cur_rate,
729 subs->cur_audiofmt,
730 subs->sync_endpoint);
731 if (ret < 0)
732 return ret;
734 if (subs->sync_endpoint)
735 ret = configure_sync_endpoint(subs);
737 return ret;
740 static int snd_usb_pcm_change_state(struct snd_usb_substream *subs, int state)
742 int ret;
744 if (!subs->str_pd)
745 return 0;
747 ret = snd_usb_power_domain_set(subs->stream->chip, subs->str_pd, state);
748 if (ret < 0) {
749 dev_err(&subs->dev->dev,
750 "Cannot change Power Domain ID: %d to state: %d. Err: %d\n",
751 subs->str_pd->pd_id, state, ret);
752 return ret;
755 return 0;
758 int snd_usb_pcm_suspend(struct snd_usb_stream *as)
760 int ret;
762 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D2);
763 if (ret < 0)
764 return ret;
766 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D2);
767 if (ret < 0)
768 return ret;
770 return 0;
773 int snd_usb_pcm_resume(struct snd_usb_stream *as)
775 int ret;
777 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D1);
778 if (ret < 0)
779 return ret;
781 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D1);
782 if (ret < 0)
783 return ret;
785 return 0;
789 * hw_params callback
791 * allocate a buffer and set the given audio format.
793 * so far we use a physically linear buffer although packetize transfer
794 * doesn't need a continuous area.
795 * if sg buffer is supported on the later version of alsa, we'll follow
796 * that.
798 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
799 struct snd_pcm_hw_params *hw_params)
801 struct snd_usb_substream *subs = substream->runtime->private_data;
802 struct audioformat *fmt;
803 int ret;
805 ret = snd_media_start_pipeline(subs);
806 if (ret)
807 return ret;
809 if (snd_usb_use_vmalloc)
810 ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
811 params_buffer_bytes(hw_params));
812 else
813 ret = snd_pcm_lib_malloc_pages(substream,
814 params_buffer_bytes(hw_params));
815 if (ret < 0)
816 goto stop_pipeline;
818 subs->pcm_format = params_format(hw_params);
819 subs->period_bytes = params_period_bytes(hw_params);
820 subs->period_frames = params_period_size(hw_params);
821 subs->buffer_periods = params_periods(hw_params);
822 subs->channels = params_channels(hw_params);
823 subs->cur_rate = params_rate(hw_params);
825 fmt = find_format(subs);
826 if (!fmt) {
827 dev_dbg(&subs->dev->dev,
828 "cannot set format: format = %#x, rate = %d, channels = %d\n",
829 subs->pcm_format, subs->cur_rate, subs->channels);
830 ret = -EINVAL;
831 goto stop_pipeline;
834 ret = snd_usb_lock_shutdown(subs->stream->chip);
835 if (ret < 0)
836 goto stop_pipeline;
838 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
839 if (ret < 0)
840 goto unlock;
842 ret = set_format(subs, fmt);
843 if (ret < 0)
844 goto unlock;
846 subs->interface = fmt->iface;
847 subs->altset_idx = fmt->altset_idx;
848 subs->need_setup_ep = true;
850 unlock:
851 snd_usb_unlock_shutdown(subs->stream->chip);
852 if (ret < 0)
853 goto stop_pipeline;
854 return ret;
856 stop_pipeline:
857 snd_media_stop_pipeline(subs);
858 return ret;
862 * hw_free callback
864 * reset the audio format and release the buffer
866 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
868 struct snd_usb_substream *subs = substream->runtime->private_data;
870 snd_media_stop_pipeline(subs);
871 subs->cur_audiofmt = NULL;
872 subs->cur_rate = 0;
873 subs->period_bytes = 0;
874 if (!snd_usb_lock_shutdown(subs->stream->chip)) {
875 stop_endpoints(subs, true);
876 snd_usb_endpoint_deactivate(subs->sync_endpoint);
877 snd_usb_endpoint_deactivate(subs->data_endpoint);
878 snd_usb_unlock_shutdown(subs->stream->chip);
881 if (snd_usb_use_vmalloc)
882 return snd_pcm_lib_free_vmalloc_buffer(substream);
883 else
884 return snd_pcm_lib_free_pages(substream);
888 * prepare callback
890 * only a few subtle things...
892 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
894 struct snd_pcm_runtime *runtime = substream->runtime;
895 struct snd_usb_substream *subs = runtime->private_data;
896 struct usb_host_interface *alts;
897 struct usb_interface *iface;
898 int ret;
900 if (! subs->cur_audiofmt) {
901 dev_err(&subs->dev->dev, "no format is specified!\n");
902 return -ENXIO;
905 ret = snd_usb_lock_shutdown(subs->stream->chip);
906 if (ret < 0)
907 return ret;
908 if (snd_BUG_ON(!subs->data_endpoint)) {
909 ret = -EIO;
910 goto unlock;
913 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
914 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
916 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
917 if (ret < 0)
918 goto unlock;
920 ret = set_format(subs, subs->cur_audiofmt);
921 if (ret < 0)
922 goto unlock;
924 if (subs->need_setup_ep) {
926 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
927 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
928 ret = snd_usb_init_sample_rate(subs->stream->chip,
929 subs->cur_audiofmt->iface,
930 alts,
931 subs->cur_audiofmt,
932 subs->cur_rate);
933 if (ret < 0)
934 goto unlock;
936 ret = configure_endpoint(subs);
937 if (ret < 0)
938 goto unlock;
939 subs->need_setup_ep = false;
942 /* some unit conversions in runtime */
943 subs->data_endpoint->maxframesize =
944 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
945 subs->data_endpoint->curframesize =
946 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
948 /* reset the pointer */
949 subs->hwptr_done = 0;
950 subs->transfer_done = 0;
951 subs->last_delay = 0;
952 subs->last_frame_number = 0;
953 runtime->delay = 0;
955 /* for playback, submit the URBs now; otherwise, the first hwptr_done
956 * updates for all URBs would happen at the same time when starting */
957 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
958 ret = start_endpoints(subs);
960 unlock:
961 snd_usb_unlock_shutdown(subs->stream->chip);
962 return ret;
965 static const struct snd_pcm_hardware snd_usb_hardware =
967 .info = SNDRV_PCM_INFO_MMAP |
968 SNDRV_PCM_INFO_MMAP_VALID |
969 SNDRV_PCM_INFO_BATCH |
970 SNDRV_PCM_INFO_INTERLEAVED |
971 SNDRV_PCM_INFO_BLOCK_TRANSFER |
972 SNDRV_PCM_INFO_PAUSE,
973 .buffer_bytes_max = 1024 * 1024,
974 .period_bytes_min = 64,
975 .period_bytes_max = 512 * 1024,
976 .periods_min = 2,
977 .periods_max = 1024,
980 static int hw_check_valid_format(struct snd_usb_substream *subs,
981 struct snd_pcm_hw_params *params,
982 struct audioformat *fp)
984 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
985 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
986 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
987 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
988 struct snd_mask check_fmts;
989 unsigned int ptime;
991 /* check the format */
992 snd_mask_none(&check_fmts);
993 check_fmts.bits[0] = (u32)fp->formats;
994 check_fmts.bits[1] = (u32)(fp->formats >> 32);
995 snd_mask_intersect(&check_fmts, fmts);
996 if (snd_mask_empty(&check_fmts)) {
997 hwc_debug(" > check: no supported format %d\n", fp->format);
998 return 0;
1000 /* check the channels */
1001 if (fp->channels < ct->min || fp->channels > ct->max) {
1002 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1003 return 0;
1005 /* check the rate is within the range */
1006 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1007 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1008 return 0;
1010 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1011 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1012 return 0;
1014 /* check whether the period time is >= the data packet interval */
1015 if (subs->speed != USB_SPEED_FULL) {
1016 ptime = 125 * (1 << fp->datainterval);
1017 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
1018 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
1019 return 0;
1022 return 1;
1025 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1026 struct snd_pcm_hw_rule *rule)
1028 struct snd_usb_substream *subs = rule->private;
1029 struct audioformat *fp;
1030 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1031 unsigned int rmin, rmax;
1032 int changed;
1034 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1035 changed = 0;
1036 rmin = rmax = 0;
1037 list_for_each_entry(fp, &subs->fmt_list, list) {
1038 if (!hw_check_valid_format(subs, params, fp))
1039 continue;
1040 if (changed++) {
1041 if (rmin > fp->rate_min)
1042 rmin = fp->rate_min;
1043 if (rmax < fp->rate_max)
1044 rmax = fp->rate_max;
1045 } else {
1046 rmin = fp->rate_min;
1047 rmax = fp->rate_max;
1051 if (!changed) {
1052 hwc_debug(" --> get empty\n");
1053 it->empty = 1;
1054 return -EINVAL;
1057 changed = 0;
1058 if (it->min < rmin) {
1059 it->min = rmin;
1060 it->openmin = 0;
1061 changed = 1;
1063 if (it->max > rmax) {
1064 it->max = rmax;
1065 it->openmax = 0;
1066 changed = 1;
1068 if (snd_interval_checkempty(it)) {
1069 it->empty = 1;
1070 return -EINVAL;
1072 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1073 return changed;
1077 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1078 struct snd_pcm_hw_rule *rule)
1080 struct snd_usb_substream *subs = rule->private;
1081 struct audioformat *fp;
1082 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1083 unsigned int rmin, rmax;
1084 int changed;
1086 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1087 changed = 0;
1088 rmin = rmax = 0;
1089 list_for_each_entry(fp, &subs->fmt_list, list) {
1090 if (!hw_check_valid_format(subs, params, fp))
1091 continue;
1092 if (changed++) {
1093 if (rmin > fp->channels)
1094 rmin = fp->channels;
1095 if (rmax < fp->channels)
1096 rmax = fp->channels;
1097 } else {
1098 rmin = fp->channels;
1099 rmax = fp->channels;
1103 if (!changed) {
1104 hwc_debug(" --> get empty\n");
1105 it->empty = 1;
1106 return -EINVAL;
1109 changed = 0;
1110 if (it->min < rmin) {
1111 it->min = rmin;
1112 it->openmin = 0;
1113 changed = 1;
1115 if (it->max > rmax) {
1116 it->max = rmax;
1117 it->openmax = 0;
1118 changed = 1;
1120 if (snd_interval_checkempty(it)) {
1121 it->empty = 1;
1122 return -EINVAL;
1124 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1125 return changed;
1128 static int hw_rule_format(struct snd_pcm_hw_params *params,
1129 struct snd_pcm_hw_rule *rule)
1131 struct snd_usb_substream *subs = rule->private;
1132 struct audioformat *fp;
1133 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1134 u64 fbits;
1135 u32 oldbits[2];
1136 int changed;
1138 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1139 fbits = 0;
1140 list_for_each_entry(fp, &subs->fmt_list, list) {
1141 if (!hw_check_valid_format(subs, params, fp))
1142 continue;
1143 fbits |= fp->formats;
1146 oldbits[0] = fmt->bits[0];
1147 oldbits[1] = fmt->bits[1];
1148 fmt->bits[0] &= (u32)fbits;
1149 fmt->bits[1] &= (u32)(fbits >> 32);
1150 if (!fmt->bits[0] && !fmt->bits[1]) {
1151 hwc_debug(" --> get empty\n");
1152 return -EINVAL;
1154 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1155 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1156 return changed;
1159 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
1160 struct snd_pcm_hw_rule *rule)
1162 struct snd_usb_substream *subs = rule->private;
1163 struct audioformat *fp;
1164 struct snd_interval *it;
1165 unsigned char min_datainterval;
1166 unsigned int pmin;
1167 int changed;
1169 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
1170 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
1171 min_datainterval = 0xff;
1172 list_for_each_entry(fp, &subs->fmt_list, list) {
1173 if (!hw_check_valid_format(subs, params, fp))
1174 continue;
1175 min_datainterval = min(min_datainterval, fp->datainterval);
1177 if (min_datainterval == 0xff) {
1178 hwc_debug(" --> get empty\n");
1179 it->empty = 1;
1180 return -EINVAL;
1182 pmin = 125 * (1 << min_datainterval);
1183 changed = 0;
1184 if (it->min < pmin) {
1185 it->min = pmin;
1186 it->openmin = 0;
1187 changed = 1;
1189 if (snd_interval_checkempty(it)) {
1190 it->empty = 1;
1191 return -EINVAL;
1193 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
1194 return changed;
1198 * If the device supports unusual bit rates, does the request meet these?
1200 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1201 struct snd_usb_substream *subs)
1203 struct audioformat *fp;
1204 int *rate_list;
1205 int count = 0, needs_knot = 0;
1206 int err;
1208 kfree(subs->rate_list.list);
1209 subs->rate_list.list = NULL;
1211 list_for_each_entry(fp, &subs->fmt_list, list) {
1212 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1213 return 0;
1214 count += fp->nr_rates;
1215 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1216 needs_knot = 1;
1218 if (!needs_knot)
1219 return 0;
1221 subs->rate_list.list = rate_list =
1222 kmalloc_array(count, sizeof(int), GFP_KERNEL);
1223 if (!subs->rate_list.list)
1224 return -ENOMEM;
1225 subs->rate_list.count = count;
1226 subs->rate_list.mask = 0;
1227 count = 0;
1228 list_for_each_entry(fp, &subs->fmt_list, list) {
1229 int i;
1230 for (i = 0; i < fp->nr_rates; i++)
1231 rate_list[count++] = fp->rate_table[i];
1233 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1234 &subs->rate_list);
1235 if (err < 0)
1236 return err;
1238 return 0;
1243 * set up the runtime hardware information.
1246 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1248 struct audioformat *fp;
1249 unsigned int pt, ptmin;
1250 int param_period_time_if_needed;
1251 int err;
1253 runtime->hw.formats = subs->formats;
1255 runtime->hw.rate_min = 0x7fffffff;
1256 runtime->hw.rate_max = 0;
1257 runtime->hw.channels_min = 256;
1258 runtime->hw.channels_max = 0;
1259 runtime->hw.rates = 0;
1260 ptmin = UINT_MAX;
1261 /* check min/max rates and channels */
1262 list_for_each_entry(fp, &subs->fmt_list, list) {
1263 runtime->hw.rates |= fp->rates;
1264 if (runtime->hw.rate_min > fp->rate_min)
1265 runtime->hw.rate_min = fp->rate_min;
1266 if (runtime->hw.rate_max < fp->rate_max)
1267 runtime->hw.rate_max = fp->rate_max;
1268 if (runtime->hw.channels_min > fp->channels)
1269 runtime->hw.channels_min = fp->channels;
1270 if (runtime->hw.channels_max < fp->channels)
1271 runtime->hw.channels_max = fp->channels;
1272 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1273 /* FIXME: there might be more than one audio formats... */
1274 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1275 fp->frame_size;
1277 pt = 125 * (1 << fp->datainterval);
1278 ptmin = min(ptmin, pt);
1281 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1282 if (subs->speed == USB_SPEED_FULL)
1283 /* full speed devices have fixed data packet interval */
1284 ptmin = 1000;
1285 if (ptmin == 1000)
1286 /* if period time doesn't go below 1 ms, no rules needed */
1287 param_period_time_if_needed = -1;
1289 err = snd_pcm_hw_constraint_minmax(runtime,
1290 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1291 ptmin, UINT_MAX);
1292 if (err < 0)
1293 return err;
1295 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1296 hw_rule_rate, subs,
1297 SNDRV_PCM_HW_PARAM_FORMAT,
1298 SNDRV_PCM_HW_PARAM_CHANNELS,
1299 param_period_time_if_needed,
1300 -1);
1301 if (err < 0)
1302 return err;
1303 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1304 hw_rule_channels, subs,
1305 SNDRV_PCM_HW_PARAM_FORMAT,
1306 SNDRV_PCM_HW_PARAM_RATE,
1307 param_period_time_if_needed,
1308 -1);
1309 if (err < 0)
1310 return err;
1311 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1312 hw_rule_format, subs,
1313 SNDRV_PCM_HW_PARAM_RATE,
1314 SNDRV_PCM_HW_PARAM_CHANNELS,
1315 param_period_time_if_needed,
1316 -1);
1317 if (err < 0)
1318 return err;
1319 if (param_period_time_if_needed >= 0) {
1320 err = snd_pcm_hw_rule_add(runtime, 0,
1321 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1322 hw_rule_period_time, subs,
1323 SNDRV_PCM_HW_PARAM_FORMAT,
1324 SNDRV_PCM_HW_PARAM_CHANNELS,
1325 SNDRV_PCM_HW_PARAM_RATE,
1326 -1);
1327 if (err < 0)
1328 return err;
1330 err = snd_usb_pcm_check_knot(runtime, subs);
1331 if (err < 0)
1332 return err;
1334 return snd_usb_autoresume(subs->stream->chip);
1337 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1339 int direction = substream->stream;
1340 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1341 struct snd_pcm_runtime *runtime = substream->runtime;
1342 struct snd_usb_substream *subs = &as->substream[direction];
1343 int ret;
1345 subs->interface = -1;
1346 subs->altset_idx = 0;
1347 runtime->hw = snd_usb_hardware;
1348 runtime->private_data = subs;
1349 subs->pcm_substream = substream;
1350 /* runtime PM is also done there */
1352 /* initialize DSD/DOP context */
1353 subs->dsd_dop.byte_idx = 0;
1354 subs->dsd_dop.channel = 0;
1355 subs->dsd_dop.marker = 1;
1357 ret = setup_hw_info(runtime, subs);
1358 if (ret == 0) {
1359 ret = snd_media_stream_init(subs, as->pcm, direction);
1360 if (ret)
1361 snd_usb_autosuspend(subs->stream->chip);
1363 return ret;
1366 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1368 int direction = substream->stream;
1369 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1370 struct snd_usb_substream *subs = &as->substream[direction];
1371 int ret;
1373 stop_endpoints(subs, true);
1374 snd_media_stop_pipeline(subs);
1376 if (!as->chip->keep_iface &&
1377 subs->interface >= 0 &&
1378 !snd_usb_lock_shutdown(subs->stream->chip)) {
1379 usb_set_interface(subs->dev, subs->interface, 0);
1380 subs->interface = -1;
1381 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1382 snd_usb_unlock_shutdown(subs->stream->chip);
1383 if (ret < 0)
1384 return ret;
1387 subs->pcm_substream = NULL;
1388 snd_usb_autosuspend(subs->stream->chip);
1390 return 0;
1393 /* Since a URB can handle only a single linear buffer, we must use double
1394 * buffering when the data to be transferred overflows the buffer boundary.
1395 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1396 * for all URBs.
1398 static void retire_capture_urb(struct snd_usb_substream *subs,
1399 struct urb *urb)
1401 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1402 unsigned int stride, frames, bytes, oldptr;
1403 int i, period_elapsed = 0;
1404 unsigned long flags;
1405 unsigned char *cp;
1406 int current_frame_number;
1408 /* read frame number here, update pointer in critical section */
1409 current_frame_number = usb_get_current_frame_number(subs->dev);
1411 stride = runtime->frame_bits >> 3;
1413 for (i = 0; i < urb->number_of_packets; i++) {
1414 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1415 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1416 dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1417 i, urb->iso_frame_desc[i].status);
1418 // continue;
1420 bytes = urb->iso_frame_desc[i].actual_length;
1421 if (subs->stream_offset_adj > 0) {
1422 unsigned int adj = min(subs->stream_offset_adj, bytes);
1423 cp += adj;
1424 bytes -= adj;
1425 subs->stream_offset_adj -= adj;
1427 frames = bytes / stride;
1428 if (!subs->txfr_quirk)
1429 bytes = frames * stride;
1430 if (bytes % (runtime->sample_bits >> 3) != 0) {
1431 int oldbytes = bytes;
1432 bytes = frames * stride;
1433 dev_warn_ratelimited(&subs->dev->dev,
1434 "Corrected urb data len. %d->%d\n",
1435 oldbytes, bytes);
1437 /* update the current pointer */
1438 spin_lock_irqsave(&subs->lock, flags);
1439 oldptr = subs->hwptr_done;
1440 subs->hwptr_done += bytes;
1441 if (subs->hwptr_done >= runtime->buffer_size * stride)
1442 subs->hwptr_done -= runtime->buffer_size * stride;
1443 frames = (bytes + (oldptr % stride)) / stride;
1444 subs->transfer_done += frames;
1445 if (subs->transfer_done >= runtime->period_size) {
1446 subs->transfer_done -= runtime->period_size;
1447 period_elapsed = 1;
1449 /* capture delay is by construction limited to one URB,
1450 * reset delays here
1452 runtime->delay = subs->last_delay = 0;
1454 /* realign last_frame_number */
1455 subs->last_frame_number = current_frame_number;
1456 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1458 spin_unlock_irqrestore(&subs->lock, flags);
1459 /* copy a data chunk */
1460 if (oldptr + bytes > runtime->buffer_size * stride) {
1461 unsigned int bytes1 =
1462 runtime->buffer_size * stride - oldptr;
1463 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1464 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1465 } else {
1466 memcpy(runtime->dma_area + oldptr, cp, bytes);
1470 if (period_elapsed)
1471 snd_pcm_period_elapsed(subs->pcm_substream);
1474 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1475 struct urb *urb, unsigned int bytes)
1477 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1478 unsigned int stride = runtime->frame_bits >> 3;
1479 unsigned int dst_idx = 0;
1480 unsigned int src_idx = subs->hwptr_done;
1481 unsigned int wrap = runtime->buffer_size * stride;
1482 u8 *dst = urb->transfer_buffer;
1483 u8 *src = runtime->dma_area;
1484 u8 marker[] = { 0x05, 0xfa };
1487 * The DSP DOP format defines a way to transport DSD samples over
1488 * normal PCM data endpoints. It requires stuffing of marker bytes
1489 * (0x05 and 0xfa, alternating per sample frame), and then expects
1490 * 2 additional bytes of actual payload. The whole frame is stored
1491 * LSB.
1493 * Hence, for a stereo transport, the buffer layout looks like this,
1494 * where L refers to left channel samples and R to right.
1496 * L1 L2 0x05 R1 R2 0x05 L3 L4 0xfa R3 R4 0xfa
1497 * L5 L6 0x05 R5 R6 0x05 L7 L8 0xfa R7 R8 0xfa
1498 * .....
1502 while (bytes--) {
1503 if (++subs->dsd_dop.byte_idx == 3) {
1504 /* frame boundary? */
1505 dst[dst_idx++] = marker[subs->dsd_dop.marker];
1506 src_idx += 2;
1507 subs->dsd_dop.byte_idx = 0;
1509 if (++subs->dsd_dop.channel % runtime->channels == 0) {
1510 /* alternate the marker */
1511 subs->dsd_dop.marker++;
1512 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1513 subs->dsd_dop.channel = 0;
1515 } else {
1516 /* stuff the DSD payload */
1517 int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1519 if (subs->cur_audiofmt->dsd_bitrev)
1520 dst[dst_idx++] = bitrev8(src[idx]);
1521 else
1522 dst[dst_idx++] = src[idx];
1524 subs->hwptr_done++;
1527 if (subs->hwptr_done >= runtime->buffer_size * stride)
1528 subs->hwptr_done -= runtime->buffer_size * stride;
1531 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1532 int offset, int stride, unsigned int bytes)
1534 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1536 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1537 /* err, the transferred area goes over buffer boundary. */
1538 unsigned int bytes1 =
1539 runtime->buffer_size * stride - subs->hwptr_done;
1540 memcpy(urb->transfer_buffer + offset,
1541 runtime->dma_area + subs->hwptr_done, bytes1);
1542 memcpy(urb->transfer_buffer + offset + bytes1,
1543 runtime->dma_area, bytes - bytes1);
1544 } else {
1545 memcpy(urb->transfer_buffer + offset,
1546 runtime->dma_area + subs->hwptr_done, bytes);
1548 subs->hwptr_done += bytes;
1549 if (subs->hwptr_done >= runtime->buffer_size * stride)
1550 subs->hwptr_done -= runtime->buffer_size * stride;
1553 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1554 struct urb *urb, int stride,
1555 unsigned int bytes)
1557 __le32 packet_length;
1558 int i;
1560 /* Put __le32 length descriptor at start of each packet. */
1561 for (i = 0; i < urb->number_of_packets; i++) {
1562 unsigned int length = urb->iso_frame_desc[i].length;
1563 unsigned int offset = urb->iso_frame_desc[i].offset;
1565 packet_length = cpu_to_le32(length);
1566 offset += i * sizeof(packet_length);
1567 urb->iso_frame_desc[i].offset = offset;
1568 urb->iso_frame_desc[i].length += sizeof(packet_length);
1569 memcpy(urb->transfer_buffer + offset,
1570 &packet_length, sizeof(packet_length));
1571 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1572 stride, length);
1574 /* Adjust transfer size accordingly. */
1575 bytes += urb->number_of_packets * sizeof(packet_length);
1576 return bytes;
1579 static void prepare_playback_urb(struct snd_usb_substream *subs,
1580 struct urb *urb)
1582 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1583 struct snd_usb_endpoint *ep = subs->data_endpoint;
1584 struct snd_urb_ctx *ctx = urb->context;
1585 unsigned int counts, frames, bytes;
1586 int i, stride, period_elapsed = 0;
1587 unsigned long flags;
1589 stride = runtime->frame_bits >> 3;
1591 frames = 0;
1592 urb->number_of_packets = 0;
1593 spin_lock_irqsave(&subs->lock, flags);
1594 subs->frame_limit += ep->max_urb_frames;
1595 for (i = 0; i < ctx->packets; i++) {
1596 if (ctx->packet_size[i])
1597 counts = ctx->packet_size[i];
1598 else
1599 counts = snd_usb_endpoint_next_packet_size(ep);
1601 /* set up descriptor */
1602 urb->iso_frame_desc[i].offset = frames * ep->stride;
1603 urb->iso_frame_desc[i].length = counts * ep->stride;
1604 frames += counts;
1605 urb->number_of_packets++;
1606 subs->transfer_done += counts;
1607 if (subs->transfer_done >= runtime->period_size) {
1608 subs->transfer_done -= runtime->period_size;
1609 subs->frame_limit = 0;
1610 period_elapsed = 1;
1611 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1612 if (subs->transfer_done > 0) {
1613 /* FIXME: fill-max mode is not
1614 * supported yet */
1615 frames -= subs->transfer_done;
1616 counts -= subs->transfer_done;
1617 urb->iso_frame_desc[i].length =
1618 counts * ep->stride;
1619 subs->transfer_done = 0;
1621 i++;
1622 if (i < ctx->packets) {
1623 /* add a transfer delimiter */
1624 urb->iso_frame_desc[i].offset =
1625 frames * ep->stride;
1626 urb->iso_frame_desc[i].length = 0;
1627 urb->number_of_packets++;
1629 break;
1632 /* finish at the period boundary or after enough frames */
1633 if ((period_elapsed ||
1634 subs->transfer_done >= subs->frame_limit) &&
1635 !snd_usb_endpoint_implicit_feedback_sink(ep))
1636 break;
1638 bytes = frames * ep->stride;
1640 if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1641 subs->cur_audiofmt->dsd_dop)) {
1642 fill_playback_urb_dsd_dop(subs, urb, bytes);
1643 } else if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1644 subs->cur_audiofmt->dsd_bitrev)) {
1645 /* bit-reverse the bytes */
1646 u8 *buf = urb->transfer_buffer;
1647 for (i = 0; i < bytes; i++) {
1648 int idx = (subs->hwptr_done + i)
1649 % (runtime->buffer_size * stride);
1650 buf[i] = bitrev8(runtime->dma_area[idx]);
1653 subs->hwptr_done += bytes;
1654 if (subs->hwptr_done >= runtime->buffer_size * stride)
1655 subs->hwptr_done -= runtime->buffer_size * stride;
1656 } else {
1657 /* usual PCM */
1658 if (!subs->tx_length_quirk)
1659 copy_to_urb(subs, urb, 0, stride, bytes);
1660 else
1661 bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1662 /* bytes is now amount of outgoing data */
1665 /* update delay with exact number of samples queued */
1666 runtime->delay = subs->last_delay;
1667 runtime->delay += frames;
1668 subs->last_delay = runtime->delay;
1670 /* realign last_frame_number */
1671 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1672 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1674 if (subs->trigger_tstamp_pending_update) {
1675 /* this is the first actual URB submitted,
1676 * update trigger timestamp to reflect actual start time
1678 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1679 subs->trigger_tstamp_pending_update = false;
1682 spin_unlock_irqrestore(&subs->lock, flags);
1683 urb->transfer_buffer_length = bytes;
1684 if (period_elapsed)
1685 snd_pcm_period_elapsed(subs->pcm_substream);
1689 * process after playback data complete
1690 * - decrease the delay count again
1692 static void retire_playback_urb(struct snd_usb_substream *subs,
1693 struct urb *urb)
1695 unsigned long flags;
1696 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1697 struct snd_usb_endpoint *ep = subs->data_endpoint;
1698 int processed = urb->transfer_buffer_length / ep->stride;
1699 int est_delay;
1701 /* ignore the delay accounting when procssed=0 is given, i.e.
1702 * silent payloads are procssed before handling the actual data
1704 if (!processed)
1705 return;
1707 spin_lock_irqsave(&subs->lock, flags);
1708 if (!subs->last_delay)
1709 goto out; /* short path */
1711 est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1712 /* update delay with exact number of samples played */
1713 if (processed > subs->last_delay)
1714 subs->last_delay = 0;
1715 else
1716 subs->last_delay -= processed;
1717 runtime->delay = subs->last_delay;
1720 * Report when delay estimate is off by more than 2ms.
1721 * The error should be lower than 2ms since the estimate relies
1722 * on two reads of a counter updated every ms.
1724 if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1725 dev_dbg_ratelimited(&subs->dev->dev,
1726 "delay: estimated %d, actual %d\n",
1727 est_delay, subs->last_delay);
1729 if (!subs->running) {
1730 /* update last_frame_number for delay counting here since
1731 * prepare_playback_urb won't be called during pause
1733 subs->last_frame_number =
1734 usb_get_current_frame_number(subs->dev) & 0xff;
1737 out:
1738 spin_unlock_irqrestore(&subs->lock, flags);
1741 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1742 int cmd)
1744 struct snd_usb_substream *subs = substream->runtime->private_data;
1746 switch (cmd) {
1747 case SNDRV_PCM_TRIGGER_START:
1748 subs->trigger_tstamp_pending_update = true;
1749 /* fall through */
1750 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1751 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1752 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1753 subs->running = 1;
1754 return 0;
1755 case SNDRV_PCM_TRIGGER_STOP:
1756 stop_endpoints(subs, false);
1757 subs->running = 0;
1758 return 0;
1759 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1760 subs->data_endpoint->prepare_data_urb = NULL;
1761 /* keep retire_data_urb for delay calculation */
1762 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1763 subs->running = 0;
1764 return 0;
1765 case SNDRV_PCM_TRIGGER_SUSPEND:
1766 if (subs->stream->chip->setup_fmt_after_resume_quirk) {
1767 stop_endpoints(subs, true);
1768 subs->need_setup_fmt = true;
1769 return 0;
1771 break;
1774 return -EINVAL;
1777 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1778 int cmd)
1780 int err;
1781 struct snd_usb_substream *subs = substream->runtime->private_data;
1783 switch (cmd) {
1784 case SNDRV_PCM_TRIGGER_START:
1785 err = start_endpoints(subs);
1786 if (err < 0)
1787 return err;
1789 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1790 subs->running = 1;
1791 return 0;
1792 case SNDRV_PCM_TRIGGER_STOP:
1793 stop_endpoints(subs, false);
1794 subs->data_endpoint->retire_data_urb = NULL;
1795 subs->running = 0;
1796 return 0;
1797 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1798 subs->data_endpoint->retire_data_urb = NULL;
1799 subs->running = 0;
1800 return 0;
1801 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1802 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1803 subs->running = 1;
1804 return 0;
1805 case SNDRV_PCM_TRIGGER_SUSPEND:
1806 if (subs->stream->chip->setup_fmt_after_resume_quirk) {
1807 stop_endpoints(subs, true);
1808 subs->need_setup_fmt = true;
1809 return 0;
1811 break;
1814 return -EINVAL;
1817 static const struct snd_pcm_ops snd_usb_playback_ops = {
1818 .open = snd_usb_pcm_open,
1819 .close = snd_usb_pcm_close,
1820 .ioctl = snd_pcm_lib_ioctl,
1821 .hw_params = snd_usb_hw_params,
1822 .hw_free = snd_usb_hw_free,
1823 .prepare = snd_usb_pcm_prepare,
1824 .trigger = snd_usb_substream_playback_trigger,
1825 .pointer = snd_usb_pcm_pointer,
1826 .page = snd_pcm_lib_get_vmalloc_page,
1829 static const struct snd_pcm_ops snd_usb_capture_ops = {
1830 .open = snd_usb_pcm_open,
1831 .close = snd_usb_pcm_close,
1832 .ioctl = snd_pcm_lib_ioctl,
1833 .hw_params = snd_usb_hw_params,
1834 .hw_free = snd_usb_hw_free,
1835 .prepare = snd_usb_pcm_prepare,
1836 .trigger = snd_usb_substream_capture_trigger,
1837 .pointer = snd_usb_pcm_pointer,
1838 .page = snd_pcm_lib_get_vmalloc_page,
1841 static const struct snd_pcm_ops snd_usb_playback_dev_ops = {
1842 .open = snd_usb_pcm_open,
1843 .close = snd_usb_pcm_close,
1844 .ioctl = snd_pcm_lib_ioctl,
1845 .hw_params = snd_usb_hw_params,
1846 .hw_free = snd_usb_hw_free,
1847 .prepare = snd_usb_pcm_prepare,
1848 .trigger = snd_usb_substream_playback_trigger,
1849 .pointer = snd_usb_pcm_pointer,
1850 .page = snd_pcm_sgbuf_ops_page,
1853 static const struct snd_pcm_ops snd_usb_capture_dev_ops = {
1854 .open = snd_usb_pcm_open,
1855 .close = snd_usb_pcm_close,
1856 .ioctl = snd_pcm_lib_ioctl,
1857 .hw_params = snd_usb_hw_params,
1858 .hw_free = snd_usb_hw_free,
1859 .prepare = snd_usb_pcm_prepare,
1860 .trigger = snd_usb_substream_capture_trigger,
1861 .pointer = snd_usb_pcm_pointer,
1862 .page = snd_pcm_sgbuf_ops_page,
1865 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1867 const struct snd_pcm_ops *ops;
1869 if (snd_usb_use_vmalloc)
1870 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1871 &snd_usb_playback_ops : &snd_usb_capture_ops;
1872 else
1873 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1874 &snd_usb_playback_dev_ops : &snd_usb_capture_dev_ops;
1875 snd_pcm_set_ops(pcm, stream, ops);
1878 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1880 struct snd_pcm *pcm = subs->stream->pcm;
1881 struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1882 struct device *dev = subs->dev->bus->controller;
1884 if (!snd_usb_use_vmalloc)
1885 snd_pcm_lib_preallocate_pages(s, SNDRV_DMA_TYPE_DEV_SG,
1886 dev, 64*1024, 512*1024);