]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - sound/usb/pcm.c
projects / mirror_ubuntu-jammy-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ALSA: usb-audio: Add implicit feedback quirk for SSL2
[mirror_ubuntu-jammy-kernel.git] / sound / usb / pcm.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 */
4
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>
12
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/pcm_params.h>
16
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"
27
28 #define SUBSTREAM_FLAG_DATA_EP_STARTED 0
29 #define SUBSTREAM_FLAG_SYNC_EP_STARTED 1
30
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)
34 {
35 int current_frame_number;
36 int frame_diff;
37 int est_delay;
38
39 if (!subs->last_delay)
40 return 0; /* short path */
41
42 current_frame_number = usb_get_current_frame_number(subs->dev);
43 /*
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
47 */
48 frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
49
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;
57
58 if (est_delay < 0)
59 est_delay = 0;
60 return est_delay;
61 }
62
63 /*
64 * return the current pcm pointer. just based on the hwptr_done value.
65 */
66 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
67 {
68 struct snd_usb_substream *subs = substream->runtime->private_data;
69 unsigned int hwptr_done;
70
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);
79 }
80
81 /*
82 * find a matching audio format
83 */
84 static struct audioformat *find_format(struct snd_usb_substream *subs)
85 {
86 struct audioformat *fp;
87 struct audioformat *found = NULL;
88 int cur_attr = 0, attr;
89
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;
105 }
106 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
107 if (! found) {
108 found = fp;
109 cur_attr = attr;
110 continue;
111 }
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.
116 */
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;
130 }
131 }
132 /* find the format with the largest max. packet size */
133 if (fp->maxpacksize > found->maxpacksize) {
134 found = fp;
135 cur_attr = attr;
136 }
137 }
138 return found;
139 }
140
141 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
142 struct usb_host_interface *alts,
143 struct audioformat *fmt)
144 {
145 struct usb_device *dev = chip->dev;
146 unsigned int ep;
147 unsigned char data[1];
148 int err;
149
150 if (get_iface_desc(alts)->bNumEndpoints < 1)
151 return -EINVAL;
152 ep = get_endpoint(alts, 0)->bEndpointAddress;
153
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;
163 }
164
165 return 0;
166 }
167
168 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
169 struct usb_host_interface *alts,
170 struct audioformat *fmt)
171 {
172 struct usb_device *dev = chip->dev;
173 unsigned char data[1];
174 int err;
175
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;
185 }
186
187 return 0;
188 }
189
190 /*
191 * initialize the pitch control and sample rate
192 */
193 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
194 struct usb_host_interface *alts,
195 struct audioformat *fmt)
196 {
197 /* if endpoint doesn't have pitch control, bail out */
198 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
199 return 0;
200
201 switch (fmt->protocol) {
202 case UAC_VERSION_1:
203 default:
204 return init_pitch_v1(chip, iface, alts, fmt);
205
206 case UAC_VERSION_2:
207 return init_pitch_v2(chip, iface, alts, fmt);
208 }
209 }
210
211 static int start_endpoints(struct snd_usb_substream *subs)
212 {
213 int err;
214
215 if (!subs->data_endpoint)
216 return -EINVAL;
217
218 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
219 struct snd_usb_endpoint *ep = subs->data_endpoint;
220
221 dev_dbg(&subs->dev->dev, "Starting data EP @%p\n", ep);
222
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;
228 }
229 }
230
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;
234
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;
247 }
248 }
249
250 dev_dbg(&subs->dev->dev, "Starting sync EP @%p\n", ep);
251
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;
257 }
258 }
259
260 return 0;
261 }
262
263 static void sync_pending_stops(struct snd_usb_substream *subs)
264 {
265 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
266 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
267 }
268
269 static void stop_endpoints(struct snd_usb_substream *subs)
270 {
271 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
272 snd_usb_endpoint_stop(subs->sync_endpoint);
273
274 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
275 snd_usb_endpoint_stop(subs->data_endpoint);
276 }
277
278 /* PCM sync_stop callback */
279 static int snd_usb_pcm_sync_stop(struct snd_pcm_substream *substream)
280 {
281 struct snd_usb_substream *subs = substream->runtime->private_data;
282
283 if (!snd_usb_lock_shutdown(subs->stream->chip)) {
284 sync_pending_stops(subs);
285 snd_usb_unlock_shutdown(subs->stream->chip);
286 }
287 return 0;
288 }
289
290 static int search_roland_implicit_fb(struct usb_device *dev, int ifnum,
291 unsigned int altsetting,
292 struct usb_host_interface **alts,
293 unsigned int *ep)
294 {
295 struct usb_interface *iface;
296 struct usb_interface_descriptor *altsd;
297 struct usb_endpoint_descriptor *epd;
298
299 iface = usb_ifnum_to_if(dev, ifnum);
300 if (!iface || iface->num_altsetting < altsetting + 1)
301 return -ENOENT;
302 *alts = &iface->altsetting[altsetting];
303 altsd = get_iface_desc(*alts);
304 if (altsd->bAlternateSetting != altsetting ||
305 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
306 (altsd->bInterfaceSubClass != 2 &&
307 altsd->bInterfaceProtocol != 2 ) ||
308 altsd->bNumEndpoints < 1)
309 return -ENOENT;
310 epd = get_endpoint(*alts, 0);
311 if (!usb_endpoint_is_isoc_in(epd) ||
312 (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
313 USB_ENDPOINT_USAGE_IMPLICIT_FB)
314 return -ENOENT;
315 *ep = epd->bEndpointAddress;
316 return 0;
317 }
318
319 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk
320 * applies. Returns 1 if a quirk was found.
321 */
322 static int set_sync_ep_implicit_fb_quirk(struct snd_usb_substream *subs,
323 struct usb_device *dev,
324 struct usb_interface_descriptor *altsd,
325 unsigned int attr)
326 {
327 struct usb_host_interface *alts;
328 struct usb_interface *iface;
329 unsigned int ep;
330 unsigned int ifnum;
331
332 /* Implicit feedback sync EPs consumers are always playback EPs */
333 if (subs->direction != SNDRV_PCM_STREAM_PLAYBACK)
334 return 0;
335
336 switch (subs->stream->chip->usb_id) {
337 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
338 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
339 ep = 0x81;
340 ifnum = 3;
341 goto add_sync_ep_from_ifnum;
342 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
343 case USB_ID(0x0763, 0x2081):
344 ep = 0x81;
345 ifnum = 2;
346 goto add_sync_ep_from_ifnum;
347 case USB_ID(0x2466, 0x8003): /* Fractal Audio Axe-Fx II */
348 ep = 0x86;
349 ifnum = 2;
350 goto add_sync_ep_from_ifnum;
351 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx III */
352 ep = 0x81;
353 ifnum = 2;
354 goto add_sync_ep_from_ifnum;
355 case USB_ID(0x1397, 0x0001): /* Behringer UFX1604 */
356 case USB_ID(0x1397, 0x0002): /* Behringer UFX1204 */
357 ep = 0x81;
358 ifnum = 1;
359 goto add_sync_ep_from_ifnum;
360 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II/IIc */
361 /* MicroBook IIc */
362 if (altsd->bInterfaceClass == USB_CLASS_AUDIO)
363 return 0;
364
365 /* MicroBook II */
366 ep = 0x84;
367 ifnum = 0;
368 goto add_sync_ep_from_ifnum;
369 case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
370 case USB_ID(0x31e9, 0x0001): /* Solid State Logic SSL2 */
371 case USB_ID(0x31e9, 0x0002): /* Solid State Logic SSL2+ */
372 case USB_ID(0x0d9a, 0x00df): /* RTX6001 */
373 ep = 0x81;
374 ifnum = 2;
375 goto add_sync_ep_from_ifnum;
376 case USB_ID(0x2b73, 0x000a): /* Pioneer DJ DJM-900NXS2 */
377 ep = 0x82;
378 ifnum = 0;
379 goto add_sync_ep_from_ifnum;
380 case USB_ID(0x0582, 0x01d8): /* BOSS Katana */
381 /* BOSS Katana amplifiers do not need quirks */
382 return 0;
383 }
384
385 if (attr == USB_ENDPOINT_SYNC_ASYNC &&
386 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
387 altsd->bInterfaceProtocol == 2 &&
388 altsd->bNumEndpoints == 1 &&
389 USB_ID_VENDOR(subs->stream->chip->usb_id) == 0x0582 /* Roland */ &&
390 search_roland_implicit_fb(dev, altsd->bInterfaceNumber + 1,
391 altsd->bAlternateSetting,
392 &alts, &ep) >= 0) {
393 goto add_sync_ep;
394 }
395
396 /* No quirk */
397 return 0;
398
399 add_sync_ep_from_ifnum:
400 iface = usb_ifnum_to_if(dev, ifnum);
401
402 if (!iface || iface->num_altsetting < 2)
403 return -EINVAL;
404
405 alts = &iface->altsetting[1];
406
407 add_sync_ep:
408 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
409 alts, ep, !subs->direction,
410 SND_USB_ENDPOINT_TYPE_DATA);
411 if (!subs->sync_endpoint)
412 return -EINVAL;
413
414 subs->sync_endpoint->is_implicit_feedback = 1;
415
416 subs->data_endpoint->sync_master = subs->sync_endpoint;
417
418 return 1;
419 }
420
421 static int set_sync_endpoint(struct snd_usb_substream *subs,
422 struct audioformat *fmt,
423 struct usb_device *dev,
424 struct usb_host_interface *alts,
425 struct usb_interface_descriptor *altsd)
426 {
427 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
428 unsigned int ep, attr;
429 bool implicit_fb;
430 int err;
431
432 /* we need a sync pipe in async OUT or adaptive IN mode */
433 /* check the number of EP, since some devices have broken
434 * descriptors which fool us. if it has only one EP,
435 * assume it as adaptive-out or sync-in.
436 */
437 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
438
439 if ((is_playback && (attr != USB_ENDPOINT_SYNC_ASYNC)) ||
440 (!is_playback && (attr != USB_ENDPOINT_SYNC_ADAPTIVE))) {
441
442 /*
443 * In these modes the notion of sync_endpoint is irrelevant.
444 * Reset pointers to avoid using stale data from previously
445 * used settings, e.g. when configuration and endpoints were
446 * changed
447 */
448
449 subs->sync_endpoint = NULL;
450 subs->data_endpoint->sync_master = NULL;
451 }
452
453 err = set_sync_ep_implicit_fb_quirk(subs, dev, altsd, attr);
454 if (err < 0)
455 return err;
456
457 /* endpoint set by quirk */
458 if (err > 0)
459 return 0;
460
461 if (altsd->bNumEndpoints < 2)
462 return 0;
463
464 if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC ||
465 attr == USB_ENDPOINT_SYNC_ADAPTIVE)) ||
466 (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
467 return 0;
468
469 /*
470 * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see
471 * if we don't find a sync endpoint, as on M-Audio Transit. In case of
472 * error fall back to SYNC mode and don't create sync endpoint
473 */
474
475 /* check sync-pipe endpoint */
476 /* ... and check descriptor size before accessing bSynchAddress
477 because there is a version of the SB Audigy 2 NX firmware lacking
478 the audio fields in the endpoint descriptors */
479 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
480 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
481 get_endpoint(alts, 1)->bSynchAddress != 0)) {
482 dev_err(&dev->dev,
483 "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
484 fmt->iface, fmt->altsetting,
485 get_endpoint(alts, 1)->bmAttributes,
486 get_endpoint(alts, 1)->bLength,
487 get_endpoint(alts, 1)->bSynchAddress);
488 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
489 return 0;
490 return -EINVAL;
491 }
492 ep = get_endpoint(alts, 1)->bEndpointAddress;
493 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
494 get_endpoint(alts, 0)->bSynchAddress != 0 &&
495 ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
496 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
497 dev_err(&dev->dev,
498 "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
499 fmt->iface, fmt->altsetting,
500 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
501 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
502 return 0;
503 return -EINVAL;
504 }
505
506 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
507 == USB_ENDPOINT_USAGE_IMPLICIT_FB;
508
509 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
510 alts, ep, !subs->direction,
511 implicit_fb ?
512 SND_USB_ENDPOINT_TYPE_DATA :
513 SND_USB_ENDPOINT_TYPE_SYNC);
514
515 if (!subs->sync_endpoint) {
516 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
517 return 0;
518 return -EINVAL;
519 }
520
521 subs->sync_endpoint->is_implicit_feedback = implicit_fb;
522
523 subs->data_endpoint->sync_master = subs->sync_endpoint;
524
525 return 0;
526 }
527
528 /*
529 * find a matching format and set up the interface
530 */
531 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
532 {
533 struct usb_device *dev = subs->dev;
534 struct usb_host_interface *alts;
535 struct usb_interface_descriptor *altsd;
536 struct usb_interface *iface;
537 int err;
538
539 iface = usb_ifnum_to_if(dev, fmt->iface);
540 if (WARN_ON(!iface))
541 return -EINVAL;
542 alts = usb_altnum_to_altsetting(iface, fmt->altsetting);
543 if (WARN_ON(!alts))
544 return -EINVAL;
545 altsd = get_iface_desc(alts);
546
547 if (fmt == subs->cur_audiofmt && !subs->need_setup_fmt)
548 return 0;
549
550 /* close the old interface */
551 if (subs->interface >= 0 && (subs->interface != fmt->iface || subs->need_setup_fmt)) {
552 if (!subs->stream->chip->keep_iface) {
553 err = usb_set_interface(subs->dev, subs->interface, 0);
554 if (err < 0) {
555 dev_err(&dev->dev,
556 "%d:%d: return to setting 0 failed (%d)\n",
557 fmt->iface, fmt->altsetting, err);
558 return -EIO;
559 }
560 }
561 subs->interface = -1;
562 subs->altset_idx = 0;
563 }
564
565 if (subs->need_setup_fmt)
566 subs->need_setup_fmt = false;
567
568 /* set interface */
569 if (iface->cur_altsetting != alts) {
570 err = snd_usb_select_mode_quirk(subs, fmt);
571 if (err < 0)
572 return -EIO;
573
574 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
575 if (err < 0) {
576 dev_err(&dev->dev,
577 "%d:%d: usb_set_interface failed (%d)\n",
578 fmt->iface, fmt->altsetting, err);
579 return -EIO;
580 }
581 dev_dbg(&dev->dev, "setting usb interface %d:%d\n",
582 fmt->iface, fmt->altsetting);
583 snd_usb_set_interface_quirk(dev);
584 }
585
586 subs->interface = fmt->iface;
587 subs->altset_idx = fmt->altset_idx;
588 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
589 alts, fmt->endpoint, subs->direction,
590 SND_USB_ENDPOINT_TYPE_DATA);
591
592 if (!subs->data_endpoint)
593 return -EINVAL;
594
595 err = set_sync_endpoint(subs, fmt, dev, alts, altsd);
596 if (err < 0)
597 return err;
598
599 err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt);
600 if (err < 0)
601 return err;
602
603 subs->cur_audiofmt = fmt;
604
605 snd_usb_set_format_quirk(subs, fmt);
606
607 return 0;
608 }
609
610 /*
611 * Return the score of matching two audioformats.
612 * Veto the audioformat if:
613 * - It has no channels for some reason.
614 * - Requested PCM format is not supported.
615 * - Requested sample rate is not supported.
616 */
617 static int match_endpoint_audioformats(struct snd_usb_substream *subs,
618 struct audioformat *fp,
619 struct audioformat *match, int rate,
620 snd_pcm_format_t pcm_format)
621 {
622 int i;
623 int score = 0;
624
625 if (fp->channels < 1) {
626 dev_dbg(&subs->dev->dev,
627 "%s: (fmt @%p) no channels\n", __func__, fp);
628 return 0;
629 }
630
631 if (!(fp->formats & pcm_format_to_bits(pcm_format))) {
632 dev_dbg(&subs->dev->dev,
633 "%s: (fmt @%p) no match for format %d\n", __func__,
634 fp, pcm_format);
635 return 0;
636 }
637
638 for (i = 0; i < fp->nr_rates; i++) {
639 if (fp->rate_table[i] == rate) {
640 score++;
641 break;
642 }
643 }
644 if (!score) {
645 dev_dbg(&subs->dev->dev,
646 "%s: (fmt @%p) no match for rate %d\n", __func__,
647 fp, rate);
648 return 0;
649 }
650
651 if (fp->channels == match->channels)
652 score++;
653
654 dev_dbg(&subs->dev->dev,
655 "%s: (fmt @%p) score %d\n", __func__, fp, score);
656
657 return score;
658 }
659
660 /*
661 * Configure the sync ep using the rate and pcm format of the data ep.
662 */
663 static int configure_sync_endpoint(struct snd_usb_substream *subs)
664 {
665 int ret;
666 struct audioformat *fp;
667 struct audioformat *sync_fp = NULL;
668 int cur_score = 0;
669 int sync_period_bytes = subs->period_bytes;
670 struct snd_usb_substream *sync_subs =
671 &subs->stream->substream[subs->direction ^ 1];
672
673 if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
674 !subs->stream)
675 return snd_usb_endpoint_set_params(subs->sync_endpoint,
676 subs->pcm_format,
677 subs->channels,
678 subs->period_bytes,
679 0, 0,
680 subs->cur_rate,
681 subs->cur_audiofmt,
682 NULL);
683
684 /* Try to find the best matching audioformat. */
685 list_for_each_entry(fp, &sync_subs->fmt_list, list) {
686 int score = match_endpoint_audioformats(subs,
687 fp, subs->cur_audiofmt,
688 subs->cur_rate, subs->pcm_format);
689
690 if (score > cur_score) {
691 sync_fp = fp;
692 cur_score = score;
693 }
694 }
695
696 if (unlikely(sync_fp == NULL)) {
697 dev_err(&subs->dev->dev,
698 "%s: no valid audioformat for sync ep %x found\n",
699 __func__, sync_subs->ep_num);
700 return -EINVAL;
701 }
702
703 /*
704 * Recalculate the period bytes if channel number differ between
705 * data and sync ep audioformat.
706 */
707 if (sync_fp->channels != subs->channels) {
708 sync_period_bytes = (subs->period_bytes / subs->channels) *
709 sync_fp->channels;
710 dev_dbg(&subs->dev->dev,
711 "%s: adjusted sync ep period bytes (%d -> %d)\n",
712 __func__, subs->period_bytes, sync_period_bytes);
713 }
714
715 ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
716 subs->pcm_format,
717 sync_fp->channels,
718 sync_period_bytes,
719 0, 0,
720 subs->cur_rate,
721 sync_fp,
722 NULL);
723
724 return ret;
725 }
726
727 /*
728 * configure endpoint params
729 *
730 * called during initial setup and upon resume
731 */
732 static int configure_endpoint(struct snd_usb_substream *subs)
733 {
734 int ret;
735
736 /* format changed */
737 stop_endpoints(subs);
738 sync_pending_stops(subs);
739 ret = snd_usb_endpoint_set_params(subs->data_endpoint,
740 subs->pcm_format,
741 subs->channels,
742 subs->period_bytes,
743 subs->period_frames,
744 subs->buffer_periods,
745 subs->cur_rate,
746 subs->cur_audiofmt,
747 subs->sync_endpoint);
748 if (ret < 0)
749 return ret;
750
751 if (subs->sync_endpoint)
752 ret = configure_sync_endpoint(subs);
753
754 return ret;
755 }
756
757 static int snd_usb_pcm_change_state(struct snd_usb_substream *subs, int state)
758 {
759 int ret;
760
761 if (!subs->str_pd)
762 return 0;
763
764 ret = snd_usb_power_domain_set(subs->stream->chip, subs->str_pd, state);
765 if (ret < 0) {
766 dev_err(&subs->dev->dev,
767 "Cannot change Power Domain ID: %d to state: %d. Err: %d\n",
768 subs->str_pd->pd_id, state, ret);
769 return ret;
770 }
771
772 return 0;
773 }
774
775 int snd_usb_pcm_suspend(struct snd_usb_stream *as)
776 {
777 int ret;
778
779 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D2);
780 if (ret < 0)
781 return ret;
782
783 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D2);
784 if (ret < 0)
785 return ret;
786
787 return 0;
788 }
789
790 int snd_usb_pcm_resume(struct snd_usb_stream *as)
791 {
792 int ret;
793
794 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D1);
795 if (ret < 0)
796 return ret;
797
798 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D1);
799 if (ret < 0)
800 return ret;
801
802 return 0;
803 }
804
805 /*
806 * hw_params callback
807 *
808 * allocate a buffer and set the given audio format.
809 *
810 * so far we use a physically linear buffer although packetize transfer
811 * doesn't need a continuous area.
812 * if sg buffer is supported on the later version of alsa, we'll follow
813 * that.
814 */
815 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
816 struct snd_pcm_hw_params *hw_params)
817 {
818 struct snd_usb_substream *subs = substream->runtime->private_data;
819 struct audioformat *fmt;
820 int ret;
821
822 ret = snd_media_start_pipeline(subs);
823 if (ret)
824 return ret;
825
826 subs->pcm_format = params_format(hw_params);
827 subs->period_bytes = params_period_bytes(hw_params);
828 subs->period_frames = params_period_size(hw_params);
829 subs->buffer_periods = params_periods(hw_params);
830 subs->channels = params_channels(hw_params);
831 subs->cur_rate = params_rate(hw_params);
832
833 fmt = find_format(subs);
834 if (!fmt) {
835 dev_dbg(&subs->dev->dev,
836 "cannot set format: format = %#x, rate = %d, channels = %d\n",
837 subs->pcm_format, subs->cur_rate, subs->channels);
838 ret = -EINVAL;
839 goto stop_pipeline;
840 }
841
842 ret = snd_usb_lock_shutdown(subs->stream->chip);
843 if (ret < 0)
844 goto stop_pipeline;
845
846 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
847 if (ret < 0)
848 goto unlock;
849
850 ret = set_format(subs, fmt);
851 if (ret < 0)
852 goto unlock;
853
854 subs->interface = fmt->iface;
855 subs->altset_idx = fmt->altset_idx;
856 subs->need_setup_ep = true;
857
858 unlock:
859 snd_usb_unlock_shutdown(subs->stream->chip);
860 if (ret < 0)
861 goto stop_pipeline;
862 return ret;
863
864 stop_pipeline:
865 snd_media_stop_pipeline(subs);
866 return ret;
867 }
868
869 /*
870 * hw_free callback
871 *
872 * reset the audio format and release the buffer
873 */
874 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
875 {
876 struct snd_usb_substream *subs = substream->runtime->private_data;
877
878 snd_media_stop_pipeline(subs);
879 subs->cur_audiofmt = NULL;
880 subs->cur_rate = 0;
881 subs->period_bytes = 0;
882 if (!snd_usb_lock_shutdown(subs->stream->chip)) {
883 stop_endpoints(subs);
884 sync_pending_stops(subs);
885 snd_usb_endpoint_deactivate(subs->sync_endpoint);
886 snd_usb_endpoint_deactivate(subs->data_endpoint);
887 snd_usb_unlock_shutdown(subs->stream->chip);
888 }
889
890 return 0;
891 }
892
893 /*
894 * prepare callback
895 *
896 * only a few subtle things...
897 */
898 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
899 {
900 struct snd_pcm_runtime *runtime = substream->runtime;
901 struct snd_usb_substream *subs = runtime->private_data;
902 struct usb_host_interface *alts;
903 struct usb_interface *iface;
904 int ret;
905
906 if (! subs->cur_audiofmt) {
907 dev_err(&subs->dev->dev, "no format is specified!\n");
908 return -ENXIO;
909 }
910
911 ret = snd_usb_lock_shutdown(subs->stream->chip);
912 if (ret < 0)
913 return ret;
914 if (snd_BUG_ON(!subs->data_endpoint)) {
915 ret = -EIO;
916 goto unlock;
917 }
918
919 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
920 if (ret < 0)
921 goto unlock;
922
923 ret = set_format(subs, subs->cur_audiofmt);
924 if (ret < 0)
925 goto unlock;
926
927 if (subs->need_setup_ep) {
928
929 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
930 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
931 ret = snd_usb_init_sample_rate(subs->stream->chip,
932 subs->cur_audiofmt->iface,
933 alts,
934 subs->cur_audiofmt,
935 subs->cur_rate);
936 if (ret < 0)
937 goto unlock;
938
939 ret = configure_endpoint(subs);
940 if (ret < 0)
941 goto unlock;
942 subs->need_setup_ep = false;
943 }
944
945 /* some unit conversions in runtime */
946 subs->data_endpoint->maxframesize =
947 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
948 subs->data_endpoint->curframesize =
949 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
950
951 /* reset the pointer */
952 subs->hwptr_done = 0;
953 subs->transfer_done = 0;
954 subs->last_delay = 0;
955 subs->last_frame_number = 0;
956 runtime->delay = 0;
957
958 /* for playback, submit the URBs now; otherwise, the first hwptr_done
959 * updates for all URBs would happen at the same time when starting */
960 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
961 ret = start_endpoints(subs);
962
963 unlock:
964 snd_usb_unlock_shutdown(subs->stream->chip);
965 return ret;
966 }
967
968 static const struct snd_pcm_hardware snd_usb_hardware =
969 {
970 .info = SNDRV_PCM_INFO_MMAP |
971 SNDRV_PCM_INFO_MMAP_VALID |
972 SNDRV_PCM_INFO_BATCH |
973 SNDRV_PCM_INFO_INTERLEAVED |
974 SNDRV_PCM_INFO_BLOCK_TRANSFER |
975 SNDRV_PCM_INFO_PAUSE,
976 .buffer_bytes_max = 1024 * 1024,
977 .period_bytes_min = 64,
978 .period_bytes_max = 512 * 1024,
979 .periods_min = 2,
980 .periods_max = 1024,
981 };
982
983 static int hw_check_valid_format(struct snd_usb_substream *subs,
984 struct snd_pcm_hw_params *params,
985 struct audioformat *fp)
986 {
987 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
988 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
989 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
990 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
991 struct snd_mask check_fmts;
992 unsigned int ptime;
993
994 /* check the format */
995 snd_mask_none(&check_fmts);
996 check_fmts.bits[0] = (u32)fp->formats;
997 check_fmts.bits[1] = (u32)(fp->formats >> 32);
998 snd_mask_intersect(&check_fmts, fmts);
999 if (snd_mask_empty(&check_fmts)) {
1000 hwc_debug(" > check: no supported format %d\n", fp->format);
1001 return 0;
1002 }
1003 /* check the channels */
1004 if (fp->channels < ct->min || fp->channels > ct->max) {
1005 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1006 return 0;
1007 }
1008 /* check the rate is within the range */
1009 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1010 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1011 return 0;
1012 }
1013 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1014 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1015 return 0;
1016 }
1017 /* check whether the period time is >= the data packet interval */
1018 if (subs->speed != USB_SPEED_FULL) {
1019 ptime = 125 * (1 << fp->datainterval);
1020 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
1021 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
1022 return 0;
1023 }
1024 }
1025 return 1;
1026 }
1027
1028 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1029 struct snd_pcm_hw_rule *rule)
1030 {
1031 struct snd_usb_substream *subs = rule->private;
1032 struct audioformat *fp;
1033 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1034 unsigned int rmin, rmax;
1035 int changed;
1036
1037 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1038 changed = 0;
1039 rmin = rmax = 0;
1040 list_for_each_entry(fp, &subs->fmt_list, list) {
1041 if (!hw_check_valid_format(subs, params, fp))
1042 continue;
1043 if (changed++) {
1044 if (rmin > fp->rate_min)
1045 rmin = fp->rate_min;
1046 if (rmax < fp->rate_max)
1047 rmax = fp->rate_max;
1048 } else {
1049 rmin = fp->rate_min;
1050 rmax = fp->rate_max;
1051 }
1052 }
1053
1054 if (!changed) {
1055 hwc_debug(" --> get empty\n");
1056 it->empty = 1;
1057 return -EINVAL;
1058 }
1059
1060 changed = 0;
1061 if (it->min < rmin) {
1062 it->min = rmin;
1063 it->openmin = 0;
1064 changed = 1;
1065 }
1066 if (it->max > rmax) {
1067 it->max = rmax;
1068 it->openmax = 0;
1069 changed = 1;
1070 }
1071 if (snd_interval_checkempty(it)) {
1072 it->empty = 1;
1073 return -EINVAL;
1074 }
1075 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1076 return changed;
1077 }
1078
1079
1080 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1081 struct snd_pcm_hw_rule *rule)
1082 {
1083 struct snd_usb_substream *subs = rule->private;
1084 struct audioformat *fp;
1085 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1086 unsigned int rmin, rmax;
1087 int changed;
1088
1089 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1090 changed = 0;
1091 rmin = rmax = 0;
1092 list_for_each_entry(fp, &subs->fmt_list, list) {
1093 if (!hw_check_valid_format(subs, params, fp))
1094 continue;
1095 if (changed++) {
1096 if (rmin > fp->channels)
1097 rmin = fp->channels;
1098 if (rmax < fp->channels)
1099 rmax = fp->channels;
1100 } else {
1101 rmin = fp->channels;
1102 rmax = fp->channels;
1103 }
1104 }
1105
1106 if (!changed) {
1107 hwc_debug(" --> get empty\n");
1108 it->empty = 1;
1109 return -EINVAL;
1110 }
1111
1112 changed = 0;
1113 if (it->min < rmin) {
1114 it->min = rmin;
1115 it->openmin = 0;
1116 changed = 1;
1117 }
1118 if (it->max > rmax) {
1119 it->max = rmax;
1120 it->openmax = 0;
1121 changed = 1;
1122 }
1123 if (snd_interval_checkempty(it)) {
1124 it->empty = 1;
1125 return -EINVAL;
1126 }
1127 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1128 return changed;
1129 }
1130
1131 static int hw_rule_format(struct snd_pcm_hw_params *params,
1132 struct snd_pcm_hw_rule *rule)
1133 {
1134 struct snd_usb_substream *subs = rule->private;
1135 struct audioformat *fp;
1136 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1137 u64 fbits;
1138 u32 oldbits[2];
1139 int changed;
1140
1141 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1142 fbits = 0;
1143 list_for_each_entry(fp, &subs->fmt_list, list) {
1144 if (!hw_check_valid_format(subs, params, fp))
1145 continue;
1146 fbits |= fp->formats;
1147 }
1148
1149 oldbits[0] = fmt->bits[0];
1150 oldbits[1] = fmt->bits[1];
1151 fmt->bits[0] &= (u32)fbits;
1152 fmt->bits[1] &= (u32)(fbits >> 32);
1153 if (!fmt->bits[0] && !fmt->bits[1]) {
1154 hwc_debug(" --> get empty\n");
1155 return -EINVAL;
1156 }
1157 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1158 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1159 return changed;
1160 }
1161
1162 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
1163 struct snd_pcm_hw_rule *rule)
1164 {
1165 struct snd_usb_substream *subs = rule->private;
1166 struct audioformat *fp;
1167 struct snd_interval *it;
1168 unsigned char min_datainterval;
1169 unsigned int pmin;
1170 int changed;
1171
1172 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
1173 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
1174 min_datainterval = 0xff;
1175 list_for_each_entry(fp, &subs->fmt_list, list) {
1176 if (!hw_check_valid_format(subs, params, fp))
1177 continue;
1178 min_datainterval = min(min_datainterval, fp->datainterval);
1179 }
1180 if (min_datainterval == 0xff) {
1181 hwc_debug(" --> get empty\n");
1182 it->empty = 1;
1183 return -EINVAL;
1184 }
1185 pmin = 125 * (1 << min_datainterval);
1186 changed = 0;
1187 if (it->min < pmin) {
1188 it->min = pmin;
1189 it->openmin = 0;
1190 changed = 1;
1191 }
1192 if (snd_interval_checkempty(it)) {
1193 it->empty = 1;
1194 return -EINVAL;
1195 }
1196 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
1197 return changed;
1198 }
1199
1200 /*
1201 * If the device supports unusual bit rates, does the request meet these?
1202 */
1203 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1204 struct snd_usb_substream *subs)
1205 {
1206 struct audioformat *fp;
1207 int *rate_list;
1208 int count = 0, needs_knot = 0;
1209 int err;
1210
1211 kfree(subs->rate_list.list);
1212 subs->rate_list.list = NULL;
1213
1214 list_for_each_entry(fp, &subs->fmt_list, list) {
1215 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1216 return 0;
1217 count += fp->nr_rates;
1218 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1219 needs_knot = 1;
1220 }
1221 if (!needs_knot)
1222 return 0;
1223
1224 subs->rate_list.list = rate_list =
1225 kmalloc_array(count, sizeof(int), GFP_KERNEL);
1226 if (!subs->rate_list.list)
1227 return -ENOMEM;
1228 subs->rate_list.count = count;
1229 subs->rate_list.mask = 0;
1230 count = 0;
1231 list_for_each_entry(fp, &subs->fmt_list, list) {
1232 int i;
1233 for (i = 0; i < fp->nr_rates; i++)
1234 rate_list[count++] = fp->rate_table[i];
1235 }
1236 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1237 &subs->rate_list);
1238 if (err < 0)
1239 return err;
1240
1241 return 0;
1242 }
1243
1244
1245 /*
1246 * set up the runtime hardware information.
1247 */
1248
1249 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1250 {
1251 struct audioformat *fp;
1252 unsigned int pt, ptmin;
1253 int param_period_time_if_needed;
1254 int err;
1255
1256 runtime->hw.formats = subs->formats;
1257
1258 runtime->hw.rate_min = 0x7fffffff;
1259 runtime->hw.rate_max = 0;
1260 runtime->hw.channels_min = 256;
1261 runtime->hw.channels_max = 0;
1262 runtime->hw.rates = 0;
1263 ptmin = UINT_MAX;
1264 /* check min/max rates and channels */
1265 list_for_each_entry(fp, &subs->fmt_list, list) {
1266 runtime->hw.rates |= fp->rates;
1267 if (runtime->hw.rate_min > fp->rate_min)
1268 runtime->hw.rate_min = fp->rate_min;
1269 if (runtime->hw.rate_max < fp->rate_max)
1270 runtime->hw.rate_max = fp->rate_max;
1271 if (runtime->hw.channels_min > fp->channels)
1272 runtime->hw.channels_min = fp->channels;
1273 if (runtime->hw.channels_max < fp->channels)
1274 runtime->hw.channels_max = fp->channels;
1275 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1276 /* FIXME: there might be more than one audio formats... */
1277 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1278 fp->frame_size;
1279 }
1280 pt = 125 * (1 << fp->datainterval);
1281 ptmin = min(ptmin, pt);
1282 }
1283
1284 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1285 if (subs->speed == USB_SPEED_FULL)
1286 /* full speed devices have fixed data packet interval */
1287 ptmin = 1000;
1288 if (ptmin == 1000)
1289 /* if period time doesn't go below 1 ms, no rules needed */
1290 param_period_time_if_needed = -1;
1291
1292 err = snd_pcm_hw_constraint_minmax(runtime,
1293 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1294 ptmin, UINT_MAX);
1295 if (err < 0)
1296 return err;
1297
1298 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1299 hw_rule_rate, subs,
1300 SNDRV_PCM_HW_PARAM_FORMAT,
1301 SNDRV_PCM_HW_PARAM_CHANNELS,
1302 param_period_time_if_needed,
1303 -1);
1304 if (err < 0)
1305 return err;
1306 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1307 hw_rule_channels, subs,
1308 SNDRV_PCM_HW_PARAM_FORMAT,
1309 SNDRV_PCM_HW_PARAM_RATE,
1310 param_period_time_if_needed,
1311 -1);
1312 if (err < 0)
1313 return err;
1314 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1315 hw_rule_format, subs,
1316 SNDRV_PCM_HW_PARAM_RATE,
1317 SNDRV_PCM_HW_PARAM_CHANNELS,
1318 param_period_time_if_needed,
1319 -1);
1320 if (err < 0)
1321 return err;
1322 if (param_period_time_if_needed >= 0) {
1323 err = snd_pcm_hw_rule_add(runtime, 0,
1324 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1325 hw_rule_period_time, subs,
1326 SNDRV_PCM_HW_PARAM_FORMAT,
1327 SNDRV_PCM_HW_PARAM_CHANNELS,
1328 SNDRV_PCM_HW_PARAM_RATE,
1329 -1);
1330 if (err < 0)
1331 return err;
1332 }
1333 err = snd_usb_pcm_check_knot(runtime, subs);
1334 if (err < 0)
1335 return err;
1336
1337 return snd_usb_autoresume(subs->stream->chip);
1338 }
1339
1340 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1341 {
1342 int direction = substream->stream;
1343 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1344 struct snd_pcm_runtime *runtime = substream->runtime;
1345 struct snd_usb_substream *subs = &as->substream[direction];
1346 int ret;
1347
1348 subs->interface = -1;
1349 subs->altset_idx = 0;
1350 runtime->hw = snd_usb_hardware;
1351 runtime->private_data = subs;
1352 subs->pcm_substream = substream;
1353 /* runtime PM is also done there */
1354
1355 /* initialize DSD/DOP context */
1356 subs->dsd_dop.byte_idx = 0;
1357 subs->dsd_dop.channel = 0;
1358 subs->dsd_dop.marker = 1;
1359
1360 ret = setup_hw_info(runtime, subs);
1361 if (ret == 0) {
1362 ret = snd_media_stream_init(subs, as->pcm, direction);
1363 if (ret)
1364 snd_usb_autosuspend(subs->stream->chip);
1365 }
1366 return ret;
1367 }
1368
1369 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1370 {
1371 int direction = substream->stream;
1372 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1373 struct snd_usb_substream *subs = &as->substream[direction];
1374 int ret;
1375
1376 snd_media_stop_pipeline(subs);
1377
1378 if (!as->chip->keep_iface &&
1379 subs->interface >= 0 &&
1380 !snd_usb_lock_shutdown(subs->stream->chip)) {
1381 usb_set_interface(subs->dev, subs->interface, 0);
1382 subs->interface = -1;
1383 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1384 snd_usb_unlock_shutdown(subs->stream->chip);
1385 if (ret < 0)
1386 return ret;
1387 }
1388
1389 subs->pcm_substream = NULL;
1390 snd_usb_autosuspend(subs->stream->chip);
1391
1392 return 0;
1393 }
1394
1395 /* Since a URB can handle only a single linear buffer, we must use double
1396 * buffering when the data to be transferred overflows the buffer boundary.
1397 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1398 * for all URBs.
1399 */
1400 static void retire_capture_urb(struct snd_usb_substream *subs,
1401 struct urb *urb)
1402 {
1403 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1404 unsigned int stride, frames, bytes, oldptr;
1405 int i, period_elapsed = 0;
1406 unsigned long flags;
1407 unsigned char *cp;
1408 int current_frame_number;
1409
1410 /* read frame number here, update pointer in critical section */
1411 current_frame_number = usb_get_current_frame_number(subs->dev);
1412
1413 stride = runtime->frame_bits >> 3;
1414
1415 for (i = 0; i < urb->number_of_packets; i++) {
1416 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1417 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1418 dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1419 i, urb->iso_frame_desc[i].status);
1420 // continue;
1421 }
1422 bytes = urb->iso_frame_desc[i].actual_length;
1423 frames = bytes / stride;
1424 if (!subs->txfr_quirk)
1425 bytes = frames * stride;
1426 if (bytes % (runtime->sample_bits >> 3) != 0) {
1427 int oldbytes = bytes;
1428 bytes = frames * stride;
1429 dev_warn_ratelimited(&subs->dev->dev,
1430 "Corrected urb data len. %d->%d\n",
1431 oldbytes, bytes);
1432 }
1433 /* update the current pointer */
1434 spin_lock_irqsave(&subs->lock, flags);
1435 oldptr = subs->hwptr_done;
1436 subs->hwptr_done += bytes;
1437 if (subs->hwptr_done >= runtime->buffer_size * stride)
1438 subs->hwptr_done -= runtime->buffer_size * stride;
1439 frames = (bytes + (oldptr % stride)) / stride;
1440 subs->transfer_done += frames;
1441 if (subs->transfer_done >= runtime->period_size) {
1442 subs->transfer_done -= runtime->period_size;
1443 period_elapsed = 1;
1444 }
1445 /* capture delay is by construction limited to one URB,
1446 * reset delays here
1447 */
1448 runtime->delay = subs->last_delay = 0;
1449
1450 /* realign last_frame_number */
1451 subs->last_frame_number = current_frame_number;
1452 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1453
1454 spin_unlock_irqrestore(&subs->lock, flags);
1455 /* copy a data chunk */
1456 if (oldptr + bytes > runtime->buffer_size * stride) {
1457 unsigned int bytes1 =
1458 runtime->buffer_size * stride - oldptr;
1459 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1460 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1461 } else {
1462 memcpy(runtime->dma_area + oldptr, cp, bytes);
1463 }
1464 }
1465
1466 if (period_elapsed)
1467 snd_pcm_period_elapsed(subs->pcm_substream);
1468 }
1469
1470 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1471 struct urb *urb, unsigned int bytes)
1472 {
1473 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1474 unsigned int stride = runtime->frame_bits >> 3;
1475 unsigned int dst_idx = 0;
1476 unsigned int src_idx = subs->hwptr_done;
1477 unsigned int wrap = runtime->buffer_size * stride;
1478 u8 *dst = urb->transfer_buffer;
1479 u8 *src = runtime->dma_area;
1480 u8 marker[] = { 0x05, 0xfa };
1481
1482 /*
1483 * The DSP DOP format defines a way to transport DSD samples over
1484 * normal PCM data endpoints. It requires stuffing of marker bytes
1485 * (0x05 and 0xfa, alternating per sample frame), and then expects
1486 * 2 additional bytes of actual payload. The whole frame is stored
1487 * LSB.
1488 *
1489 * Hence, for a stereo transport, the buffer layout looks like this,
1490 * where L refers to left channel samples and R to right.
1491 *
1492 * L1 L2 0x05 R1 R2 0x05 L3 L4 0xfa R3 R4 0xfa
1493 * L5 L6 0x05 R5 R6 0x05 L7 L8 0xfa R7 R8 0xfa
1494 * .....
1495 *
1496 */
1497
1498 while (bytes--) {
1499 if (++subs->dsd_dop.byte_idx == 3) {
1500 /* frame boundary? */
1501 dst[dst_idx++] = marker[subs->dsd_dop.marker];
1502 src_idx += 2;
1503 subs->dsd_dop.byte_idx = 0;
1504
1505 if (++subs->dsd_dop.channel % runtime->channels == 0) {
1506 /* alternate the marker */
1507 subs->dsd_dop.marker++;
1508 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1509 subs->dsd_dop.channel = 0;
1510 }
1511 } else {
1512 /* stuff the DSD payload */
1513 int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1514
1515 if (subs->cur_audiofmt->dsd_bitrev)
1516 dst[dst_idx++] = bitrev8(src[idx]);
1517 else
1518 dst[dst_idx++] = src[idx];
1519
1520 subs->hwptr_done++;
1521 }
1522 }
1523 if (subs->hwptr_done >= runtime->buffer_size * stride)
1524 subs->hwptr_done -= runtime->buffer_size * stride;
1525 }
1526
1527 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1528 int offset, int stride, unsigned int bytes)
1529 {
1530 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1531
1532 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1533 /* err, the transferred area goes over buffer boundary. */
1534 unsigned int bytes1 =
1535 runtime->buffer_size * stride - subs->hwptr_done;
1536 memcpy(urb->transfer_buffer + offset,
1537 runtime->dma_area + subs->hwptr_done, bytes1);
1538 memcpy(urb->transfer_buffer + offset + bytes1,
1539 runtime->dma_area, bytes - bytes1);
1540 } else {
1541 memcpy(urb->transfer_buffer + offset,
1542 runtime->dma_area + subs->hwptr_done, bytes);
1543 }
1544 subs->hwptr_done += bytes;
1545 if (subs->hwptr_done >= runtime->buffer_size * stride)
1546 subs->hwptr_done -= runtime->buffer_size * stride;
1547 }
1548
1549 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1550 struct urb *urb, int stride,
1551 unsigned int bytes)
1552 {
1553 __le32 packet_length;
1554 int i;
1555
1556 /* Put __le32 length descriptor at start of each packet. */
1557 for (i = 0; i < urb->number_of_packets; i++) {
1558 unsigned int length = urb->iso_frame_desc[i].length;
1559 unsigned int offset = urb->iso_frame_desc[i].offset;
1560
1561 packet_length = cpu_to_le32(length);
1562 offset += i * sizeof(packet_length);
1563 urb->iso_frame_desc[i].offset = offset;
1564 urb->iso_frame_desc[i].length += sizeof(packet_length);
1565 memcpy(urb->transfer_buffer + offset,
1566 &packet_length, sizeof(packet_length));
1567 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1568 stride, length);
1569 }
1570 /* Adjust transfer size accordingly. */
1571 bytes += urb->number_of_packets * sizeof(packet_length);
1572 return bytes;
1573 }
1574
1575 static void prepare_playback_urb(struct snd_usb_substream *subs,
1576 struct urb *urb)
1577 {
1578 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1579 struct snd_usb_endpoint *ep = subs->data_endpoint;
1580 struct snd_urb_ctx *ctx = urb->context;
1581 unsigned int counts, frames, bytes;
1582 int i, stride, period_elapsed = 0;
1583 unsigned long flags;
1584
1585 stride = runtime->frame_bits >> 3;
1586
1587 frames = 0;
1588 urb->number_of_packets = 0;
1589 spin_lock_irqsave(&subs->lock, flags);
1590 subs->frame_limit += ep->max_urb_frames;
1591 for (i = 0; i < ctx->packets; i++) {
1592 if (ctx->packet_size[i])
1593 counts = ctx->packet_size[i];
1594 else if (ep->sync_master)
1595 counts = snd_usb_endpoint_slave_next_packet_size(ep);
1596 else
1597 counts = snd_usb_endpoint_next_packet_size(ep);
1598
1599 /* set up descriptor */
1600 urb->iso_frame_desc[i].offset = frames * ep->stride;
1601 urb->iso_frame_desc[i].length = counts * ep->stride;
1602 frames += counts;
1603 urb->number_of_packets++;
1604 subs->transfer_done += counts;
1605 if (subs->transfer_done >= runtime->period_size) {
1606 subs->transfer_done -= runtime->period_size;
1607 subs->frame_limit = 0;
1608 period_elapsed = 1;
1609 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1610 if (subs->transfer_done > 0) {
1611 /* FIXME: fill-max mode is not
1612 * supported yet */
1613 frames -= subs->transfer_done;
1614 counts -= subs->transfer_done;
1615 urb->iso_frame_desc[i].length =
1616 counts * ep->stride;
1617 subs->transfer_done = 0;
1618 }
1619 i++;
1620 if (i < ctx->packets) {
1621 /* add a transfer delimiter */
1622 urb->iso_frame_desc[i].offset =
1623 frames * ep->stride;
1624 urb->iso_frame_desc[i].length = 0;
1625 urb->number_of_packets++;
1626 }
1627 break;
1628 }
1629 }
1630 /* finish at the period boundary or after enough frames */
1631 if ((period_elapsed ||
1632 subs->transfer_done >= subs->frame_limit) &&
1633 !snd_usb_endpoint_implicit_feedback_sink(ep))
1634 break;
1635 }
1636 bytes = frames * ep->stride;
1637
1638 if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1639 subs->cur_audiofmt->dsd_dop)) {
1640 fill_playback_urb_dsd_dop(subs, urb, bytes);
1641 } else if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1642 subs->cur_audiofmt->dsd_bitrev)) {
1643 /* bit-reverse the bytes */
1644 u8 *buf = urb->transfer_buffer;
1645 for (i = 0; i < bytes; i++) {
1646 int idx = (subs->hwptr_done + i)
1647 % (runtime->buffer_size * stride);
1648 buf[i] = bitrev8(runtime->dma_area[idx]);
1649 }
1650
1651 subs->hwptr_done += bytes;
1652 if (subs->hwptr_done >= runtime->buffer_size * stride)
1653 subs->hwptr_done -= runtime->buffer_size * stride;
1654 } else {
1655 /* usual PCM */
1656 if (!subs->tx_length_quirk)
1657 copy_to_urb(subs, urb, 0, stride, bytes);
1658 else
1659 bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1660 /* bytes is now amount of outgoing data */
1661 }
1662
1663 /* update delay with exact number of samples queued */
1664 runtime->delay = subs->last_delay;
1665 runtime->delay += frames;
1666 subs->last_delay = runtime->delay;
1667
1668 /* realign last_frame_number */
1669 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1670 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1671
1672 if (subs->trigger_tstamp_pending_update) {
1673 /* this is the first actual URB submitted,
1674 * update trigger timestamp to reflect actual start time
1675 */
1676 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1677 subs->trigger_tstamp_pending_update = false;
1678 }
1679
1680 spin_unlock_irqrestore(&subs->lock, flags);
1681 urb->transfer_buffer_length = bytes;
1682 if (period_elapsed)
1683 snd_pcm_period_elapsed(subs->pcm_substream);
1684 }
1685
1686 /*
1687 * process after playback data complete
1688 * - decrease the delay count again
1689 */
1690 static void retire_playback_urb(struct snd_usb_substream *subs,
1691 struct urb *urb)
1692 {
1693 unsigned long flags;
1694 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1695 struct snd_usb_endpoint *ep = subs->data_endpoint;
1696 int processed = urb->transfer_buffer_length / ep->stride;
1697 int est_delay;
1698
1699 /* ignore the delay accounting when procssed=0 is given, i.e.
1700 * silent payloads are procssed before handling the actual data
1701 */
1702 if (!processed)
1703 return;
1704
1705 spin_lock_irqsave(&subs->lock, flags);
1706 if (!subs->last_delay)
1707 goto out; /* short path */
1708
1709 est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1710 /* update delay with exact number of samples played */
1711 if (processed > subs->last_delay)
1712 subs->last_delay = 0;
1713 else
1714 subs->last_delay -= processed;
1715 runtime->delay = subs->last_delay;
1716
1717 /*
1718 * Report when delay estimate is off by more than 2ms.
1719 * The error should be lower than 2ms since the estimate relies
1720 * on two reads of a counter updated every ms.
1721 */
1722 if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1723 dev_dbg_ratelimited(&subs->dev->dev,
1724 "delay: estimated %d, actual %d\n",
1725 est_delay, subs->last_delay);
1726
1727 if (!subs->running) {
1728 /* update last_frame_number for delay counting here since
1729 * prepare_playback_urb won't be called during pause
1730 */
1731 subs->last_frame_number =
1732 usb_get_current_frame_number(subs->dev) & 0xff;
1733 }
1734
1735 out:
1736 spin_unlock_irqrestore(&subs->lock, flags);
1737 }
1738
1739 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1740 int cmd)
1741 {
1742 struct snd_usb_substream *subs = substream->runtime->private_data;
1743
1744 switch (cmd) {
1745 case SNDRV_PCM_TRIGGER_START:
1746 subs->trigger_tstamp_pending_update = true;
1747 /* fall through */
1748 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1749 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1750 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1751 subs->running = 1;
1752 return 0;
1753 case SNDRV_PCM_TRIGGER_STOP:
1754 stop_endpoints(subs);
1755 subs->running = 0;
1756 return 0;
1757 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1758 subs->data_endpoint->prepare_data_urb = NULL;
1759 /* keep retire_data_urb for delay calculation */
1760 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1761 subs->running = 0;
1762 return 0;
1763 case SNDRV_PCM_TRIGGER_SUSPEND:
1764 if (subs->stream->chip->setup_fmt_after_resume_quirk) {
1765 stop_endpoints(subs);
1766 subs->need_setup_fmt = true;
1767 return 0;
1768 }
1769 break;
1770 }
1771
1772 return -EINVAL;
1773 }
1774
1775 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1776 int cmd)
1777 {
1778 int err;
1779 struct snd_usb_substream *subs = substream->runtime->private_data;
1780
1781 switch (cmd) {
1782 case SNDRV_PCM_TRIGGER_START:
1783 err = start_endpoints(subs);
1784 if (err < 0)
1785 return err;
1786
1787 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1788 subs->running = 1;
1789 return 0;
1790 case SNDRV_PCM_TRIGGER_STOP:
1791 stop_endpoints(subs);
1792 subs->data_endpoint->retire_data_urb = NULL;
1793 subs->running = 0;
1794 return 0;
1795 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1796 subs->data_endpoint->retire_data_urb = NULL;
1797 subs->running = 0;
1798 return 0;
1799 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1800 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1801 subs->running = 1;
1802 return 0;
1803 case SNDRV_PCM_TRIGGER_SUSPEND:
1804 if (subs->stream->chip->setup_fmt_after_resume_quirk) {
1805 stop_endpoints(subs);
1806 subs->need_setup_fmt = true;
1807 return 0;
1808 }
1809 break;
1810 }
1811
1812 return -EINVAL;
1813 }
1814
1815 static const struct snd_pcm_ops snd_usb_playback_ops = {
1816 .open = snd_usb_pcm_open,
1817 .close = snd_usb_pcm_close,
1818 .hw_params = snd_usb_hw_params,
1819 .hw_free = snd_usb_hw_free,
1820 .prepare = snd_usb_pcm_prepare,
1821 .trigger = snd_usb_substream_playback_trigger,
1822 .sync_stop = snd_usb_pcm_sync_stop,
1823 .pointer = snd_usb_pcm_pointer,
1824 };
1825
1826 static const struct snd_pcm_ops snd_usb_capture_ops = {
1827 .open = snd_usb_pcm_open,
1828 .close = snd_usb_pcm_close,
1829 .hw_params = snd_usb_hw_params,
1830 .hw_free = snd_usb_hw_free,
1831 .prepare = snd_usb_pcm_prepare,
1832 .trigger = snd_usb_substream_capture_trigger,
1833 .sync_stop = snd_usb_pcm_sync_stop,
1834 .pointer = snd_usb_pcm_pointer,
1835 };
1836
1837 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1838 {
1839 const struct snd_pcm_ops *ops;
1840
1841 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1842 &snd_usb_playback_ops : &snd_usb_capture_ops;
1843 snd_pcm_set_ops(pcm, stream, ops);
1844 }
1845
1846 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1847 {
1848 struct snd_pcm *pcm = subs->stream->pcm;
1849 struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1850 struct device *dev = subs->dev->bus->controller;
1851
1852 if (snd_usb_use_vmalloc)
1853 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_VMALLOC,
1854 NULL, 0, 0);
1855 else
1856 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_DEV_SG,
1857 dev, 64*1024, 512*1024);
1858 }
Ubuntu Jammy Linux kernel mirror