1 // SPDX-License-Identifier: GPL-2.0-or-later
5 #include <linux/init.h>
6 #include <linux/slab.h>
7 #include <linux/bitrev.h>
8 #include <linux/ratelimit.h>
10 #include <linux/usb/audio.h>
11 #include <linux/usb/audio-v2.h>
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/pcm_params.h>
28 #define SUBSTREAM_FLAG_DATA_EP_STARTED 0
29 #define SUBSTREAM_FLAG_SYNC_EP_STARTED 1
31 /* return the estimated delay based on USB frame counters */
32 snd_pcm_uframes_t
snd_usb_pcm_delay(struct snd_usb_substream
*subs
,
35 int current_frame_number
;
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
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
;
56 est_delay
= subs
->last_delay
+ 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
)))
93 if (fp
->channels
!= subs
->channels
)
95 if (subs
->cur_rate
< fp
->rate_min
||
96 subs
->cur_rate
> fp
->rate_max
)
98 if (! (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)) {
100 for (i
= 0; i
< fp
->nr_rates
; i
++)
101 if (fp
->rate_table
[i
] == subs
->cur_rate
)
103 if (i
>= fp
->nr_rates
)
106 attr
= fp
->ep_attr
& USB_ENDPOINT_SYNCTYPE
;
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
))
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
)) {
132 /* find the format with the largest max. packet size */
133 if (fp
->maxpacksize
> found
->maxpacksize
) {
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
;
147 unsigned char data
[1];
150 if (get_iface_desc(alts
)->bNumEndpoints
< 1)
152 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
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
,
160 usb_audio_err(chip
, "%d:%d: cannot set enable PITCH\n",
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];
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,
182 usb_audio_err(chip
, "%d:%d: cannot set enable PITCH (v2)\n",
183 iface
, fmt
->altsetting
);
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
))
201 switch (fmt
->protocol
) {
204 return init_pitch_v1(chip
, iface
, alts
, fmt
);
207 return init_pitch_v2(chip
, iface
, alts
, fmt
);
211 static int start_endpoints(struct snd_usb_substream
*subs
)
215 if (!subs
->data_endpoint
)
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
);
226 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED
, &subs
->flags
);
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
);
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
);
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
);
255 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED
, &subs
->flags
);
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
);
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
,
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)
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)
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
)
302 *ep
= epd
->bEndpointAddress
;
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
,
314 struct usb_host_interface
*alts
;
315 struct usb_interface
*iface
;
319 /* Implicit feedback sync EPs consumers are always playback EPs */
320 if (subs
->direction
!= SNDRV_PCM_STREAM_PLAYBACK
)
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 */
328 goto add_sync_ep_from_ifnum
;
329 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
330 case USB_ID(0x0763, 0x2081):
333 goto add_sync_ep_from_ifnum
;
334 case USB_ID(0x2466, 0x8003): /* Fractal Audio Axe-Fx II */
337 goto add_sync_ep_from_ifnum
;
338 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx III */
341 goto add_sync_ep_from_ifnum
;
342 case USB_ID(0x1397, 0x0001): /* Behringer UFX1604 */
343 case USB_ID(0x1397, 0x0002): /* Behringer UFX1204 */
346 goto add_sync_ep_from_ifnum
;
347 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II/IIc */
349 if (altsd
->bInterfaceClass
== USB_CLASS_AUDIO
)
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 */
363 goto add_sync_ep_from_ifnum
;
364 case USB_ID(0x0582, 0x01d8): /* BOSS Katana */
365 /* BOSS Katana amplifiers do not need quirks */
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
,
383 add_sync_ep_from_ifnum
:
384 iface
= usb_ifnum_to_if(dev
, ifnum
);
386 if (!iface
|| iface
->num_altsetting
< 2)
389 alts
= &iface
->altsetting
[1];
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
)
398 subs
->sync_endpoint
->is_implicit_feedback
= 1;
400 subs
->data_endpoint
->sync_master
= subs
->sync_endpoint
;
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
;
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
433 subs
->sync_endpoint
= NULL
;
434 subs
->data_endpoint
->sync_master
= NULL
;
437 err
= set_sync_ep_implicit_fb_quirk(subs
, dev
, altsd
, attr
);
441 /* endpoint set by quirk */
445 if (altsd
->bNumEndpoints
< 2)
448 if ((is_playback
&& (attr
== USB_ENDPOINT_SYNC_SYNC
||
449 attr
== USB_ENDPOINT_SYNC_ADAPTIVE
)) ||
450 (!is_playback
&& attr
!= USB_ENDPOINT_SYNC_ADAPTIVE
))
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)) {
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
)
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
)))) {
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
)
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
,
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
)
505 subs
->sync_endpoint
->is_implicit_feedback
= implicit_fb
;
507 subs
->data_endpoint
->sync_master
= subs
->sync_endpoint
;
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
;
523 iface
= usb_ifnum_to_if(dev
, fmt
->iface
);
526 alts
= usb_altnum_to_altsetting(iface
, fmt
->altsetting
);
529 altsd
= get_iface_desc(alts
);
531 if (fmt
== subs
->cur_audiofmt
&& !subs
->need_setup_fmt
)
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);
540 "%d:%d: return to setting 0 failed (%d)\n",
541 fmt
->iface
, fmt
->altsetting
, err
);
545 subs
->interface
= -1;
546 subs
->altset_idx
= 0;
549 if (subs
->need_setup_fmt
)
550 subs
->need_setup_fmt
= false;
553 if (iface
->cur_altsetting
!= alts
) {
554 err
= snd_usb_select_mode_quirk(subs
, fmt
);
558 err
= usb_set_interface(dev
, fmt
->iface
, fmt
->altsetting
);
561 "%d:%d: usb_set_interface failed (%d)\n",
562 fmt
->iface
, fmt
->altsetting
, err
);
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
)
579 err
= set_sync_endpoint(subs
, fmt
, dev
, alts
, altsd
);
583 err
= snd_usb_init_pitch(subs
->stream
->chip
, fmt
->iface
, alts
, fmt
);
587 subs
->cur_audiofmt
= fmt
;
589 snd_usb_set_format_quirk(subs
, fmt
);
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
)
609 if (fp
->channels
< 1) {
610 dev_dbg(&subs
->dev
->dev
,
611 "%s: (fmt @%p) no channels\n", __func__
, fp
);
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__
,
622 for (i
= 0; i
< fp
->nr_rates
; i
++) {
623 if (fp
->rate_table
[i
] == rate
) {
629 dev_dbg(&subs
->dev
->dev
,
630 "%s: (fmt @%p) no match for rate %d\n", __func__
,
635 if (fp
->channels
== match
->channels
)
638 dev_dbg(&subs
->dev
->dev
,
639 "%s: (fmt @%p) score %d\n", __func__
, fp
, 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
)
650 struct audioformat
*fp
;
651 struct audioformat
*sync_fp
= NULL
;
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
||
659 return snd_usb_endpoint_set_params(subs
->sync_endpoint
,
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
) {
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
);
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
) *
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
,
712 * configure endpoint params
714 * called during initial setup and upon resume
716 static int configure_endpoint(struct snd_usb_substream
*subs
)
721 stop_endpoints(subs
, true);
722 ret
= snd_usb_endpoint_set_params(subs
->data_endpoint
,
727 subs
->buffer_periods
,
730 subs
->sync_endpoint
);
734 if (subs
->sync_endpoint
)
735 ret
= configure_sync_endpoint(subs
);
740 static int snd_usb_pcm_change_state(struct snd_usb_substream
*subs
, int state
)
747 ret
= snd_usb_power_domain_set(subs
->stream
->chip
, subs
->str_pd
, state
);
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
);
758 int snd_usb_pcm_suspend(struct snd_usb_stream
*as
)
762 ret
= snd_usb_pcm_change_state(&as
->substream
[0], UAC3_PD_STATE_D2
);
766 ret
= snd_usb_pcm_change_state(&as
->substream
[1], UAC3_PD_STATE_D2
);
773 int snd_usb_pcm_resume(struct snd_usb_stream
*as
)
777 ret
= snd_usb_pcm_change_state(&as
->substream
[0], UAC3_PD_STATE_D1
);
781 ret
= snd_usb_pcm_change_state(&as
->substream
[1], UAC3_PD_STATE_D1
);
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
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
;
805 ret
= snd_media_start_pipeline(subs
);
809 if (snd_usb_use_vmalloc
)
810 ret
= snd_pcm_lib_alloc_vmalloc_buffer(substream
,
811 params_buffer_bytes(hw_params
));
813 ret
= snd_pcm_lib_malloc_pages(substream
,
814 params_buffer_bytes(hw_params
));
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
);
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
);
834 ret
= snd_usb_lock_shutdown(subs
->stream
->chip
);
838 ret
= snd_usb_pcm_change_state(subs
, UAC3_PD_STATE_D0
);
842 ret
= set_format(subs
, fmt
);
846 subs
->interface
= fmt
->iface
;
847 subs
->altset_idx
= fmt
->altset_idx
;
848 subs
->need_setup_ep
= true;
851 snd_usb_unlock_shutdown(subs
->stream
->chip
);
857 snd_media_stop_pipeline(subs
);
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
;
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
);
884 return snd_pcm_lib_free_pages(substream
);
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
;
900 if (! subs
->cur_audiofmt
) {
901 dev_err(&subs
->dev
->dev
, "no format is specified!\n");
905 ret
= snd_usb_lock_shutdown(subs
->stream
->chip
);
908 if (snd_BUG_ON(!subs
->data_endpoint
)) {
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
);
920 ret
= set_format(subs
, subs
->cur_audiofmt
);
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
,
936 ret
= configure_endpoint(subs
);
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;
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
);
961 snd_usb_unlock_shutdown(subs
->stream
->chip
);
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,
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
;
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
);
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
);
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
);
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
);
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
);
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
;
1034 hwc_debug("hw_rule_rate: (%d,%d)\n", it
->min
, it
->max
);
1037 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1038 if (!hw_check_valid_format(subs
, params
, fp
))
1041 if (rmin
> fp
->rate_min
)
1042 rmin
= fp
->rate_min
;
1043 if (rmax
< fp
->rate_max
)
1044 rmax
= fp
->rate_max
;
1046 rmin
= fp
->rate_min
;
1047 rmax
= fp
->rate_max
;
1052 hwc_debug(" --> get empty\n");
1058 if (it
->min
< rmin
) {
1063 if (it
->max
> rmax
) {
1068 if (snd_interval_checkempty(it
)) {
1072 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, 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
;
1086 hwc_debug("hw_rule_channels: (%d,%d)\n", it
->min
, it
->max
);
1089 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1090 if (!hw_check_valid_format(subs
, params
, fp
))
1093 if (rmin
> fp
->channels
)
1094 rmin
= fp
->channels
;
1095 if (rmax
< fp
->channels
)
1096 rmax
= fp
->channels
;
1098 rmin
= fp
->channels
;
1099 rmax
= fp
->channels
;
1104 hwc_debug(" --> get empty\n");
1110 if (it
->min
< rmin
) {
1115 if (it
->max
> rmax
) {
1120 if (snd_interval_checkempty(it
)) {
1124 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, 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
);
1138 hwc_debug("hw_rule_format: %x:%x\n", fmt
->bits
[0], fmt
->bits
[1]);
1140 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1141 if (!hw_check_valid_format(subs
, params
, fp
))
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");
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
);
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
;
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
))
1175 min_datainterval
= min(min_datainterval
, fp
->datainterval
);
1177 if (min_datainterval
== 0xff) {
1178 hwc_debug(" --> get empty\n");
1182 pmin
= 125 * (1 << min_datainterval
);
1184 if (it
->min
< pmin
) {
1189 if (snd_interval_checkempty(it
)) {
1193 hwc_debug(" --> (%u,%u) (changed = %d)\n", it
->min
, it
->max
, 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
;
1205 int count
= 0, needs_knot
= 0;
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
)
1214 count
+= fp
->nr_rates
;
1215 if (fp
->rates
& SNDRV_PCM_RATE_KNOT
)
1221 subs
->rate_list
.list
= rate_list
=
1222 kmalloc_array(count
, sizeof(int), GFP_KERNEL
);
1223 if (!subs
->rate_list
.list
)
1225 subs
->rate_list
.count
= count
;
1226 subs
->rate_list
.mask
= 0;
1228 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
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
,
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
;
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;
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
=
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 */
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
,
1295 err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1297 SNDRV_PCM_HW_PARAM_FORMAT
,
1298 SNDRV_PCM_HW_PARAM_CHANNELS
,
1299 param_period_time_if_needed
,
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
,
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
,
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
,
1330 err
= snd_usb_pcm_check_knot(runtime
, subs
);
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
];
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
);
1359 ret
= snd_media_stream_init(subs
, as
->pcm
, direction
);
1361 snd_usb_autosuspend(subs
->stream
->chip
);
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
];
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
);
1387 subs
->pcm_substream
= NULL
;
1388 snd_usb_autosuspend(subs
->stream
->chip
);
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
1398 static void retire_capture_urb(struct snd_usb_substream
*subs
,
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
;
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
);
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
);
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",
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
;
1449 /* capture delay is by construction limited to one URB,
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
);
1466 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes
);
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
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
1503 if (++subs
->dsd_dop
.byte_idx
== 3) {
1504 /* frame boundary? */
1505 dst
[dst_idx
++] = marker
[subs
->dsd_dop
.marker
];
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;
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
]);
1522 dst
[dst_idx
++] = src
[idx
];
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
);
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
,
1557 __le32 packet_length
;
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
),
1574 /* Adjust transfer size accordingly. */
1575 bytes
+= urb
->number_of_packets
* sizeof(packet_length
);
1579 static void prepare_playback_urb(struct snd_usb_substream
*subs
,
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;
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
];
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
;
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;
1611 if (subs
->fmt_type
== UAC_FORMAT_TYPE_II
) {
1612 if (subs
->transfer_done
> 0) {
1613 /* FIXME: fill-max mode is not
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;
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
++;
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
))
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
;
1658 if (!subs
->tx_length_quirk
)
1659 copy_to_urb(subs
, urb
, 0, stride
, bytes
);
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
;
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
,
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
;
1701 /* ignore the delay accounting when procssed=0 is given, i.e.
1702 * silent payloads are procssed before handling the actual data
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;
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;
1738 spin_unlock_irqrestore(&subs
->lock
, flags
);
1741 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream
*substream
,
1744 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1747 case SNDRV_PCM_TRIGGER_START
:
1748 subs
->trigger_tstamp_pending_update
= true;
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
;
1755 case SNDRV_PCM_TRIGGER_STOP
:
1756 stop_endpoints(subs
, false);
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
;
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;
1777 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream
*substream
,
1781 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1784 case SNDRV_PCM_TRIGGER_START
:
1785 err
= start_endpoints(subs
);
1789 subs
->data_endpoint
->retire_data_urb
= retire_capture_urb
;
1792 case SNDRV_PCM_TRIGGER_STOP
:
1793 stop_endpoints(subs
, false);
1794 subs
->data_endpoint
->retire_data_urb
= NULL
;
1797 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
1798 subs
->data_endpoint
->retire_data_urb
= NULL
;
1801 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
1802 subs
->data_endpoint
->retire_data_urb
= retire_capture_urb
;
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;
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
;
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);