2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/ratelimit.h>
20 #include <linux/usb.h>
21 #include <linux/usb/audio.h>
22 #include <linux/usb/audio-v2.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
38 #define SUBSTREAM_FLAG_DATA_EP_STARTED 0
39 #define SUBSTREAM_FLAG_SYNC_EP_STARTED 1
41 /* return the estimated delay based on USB frame counters */
42 snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
45 int current_frame_number;
49 if (!subs->last_delay)
50 return 0; /* short path */
52 current_frame_number = usb_get_current_frame_number(subs->dev);
54 * HCD implementations use different widths, use lower 8 bits.
55 * The delay will be managed up to 256ms, which is more than
58 frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
60 /* Approximation based on number of samples per USB frame (ms),
61 some truncation for 44.1 but the estimate is good enough */
62 est_delay = frame_diff * rate / 1000;
63 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
64 est_delay = subs->last_delay - est_delay;
66 est_delay = subs->last_delay + est_delay;
74 * return the current pcm pointer. just based on the hwptr_done value.
76 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
78 struct snd_usb_substream *subs;
79 unsigned int hwptr_done;
81 subs = (struct snd_usb_substream *)substream->runtime->private_data;
82 if (subs->stream->chip->shutdown)
83 return SNDRV_PCM_POS_XRUN;
84 spin_lock(&subs->lock);
85 hwptr_done = subs->hwptr_done;
86 substream->runtime->delay = snd_usb_pcm_delay(subs,
87 substream->runtime->rate);
88 spin_unlock(&subs->lock);
89 return hwptr_done / (substream->runtime->frame_bits >> 3);
93 * find a matching audio format
95 static struct audioformat *find_format(struct snd_usb_substream *subs)
97 struct audioformat *fp;
98 struct audioformat *found = NULL;
99 int cur_attr = 0, attr;
101 list_for_each_entry(fp, &subs->fmt_list, list) {
102 if (!(fp->formats & (1uLL << subs->pcm_format)))
104 if (fp->channels != subs->channels)
106 if (subs->cur_rate < fp->rate_min ||
107 subs->cur_rate > fp->rate_max)
109 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
111 for (i = 0; i < fp->nr_rates; i++)
112 if (fp->rate_table[i] == subs->cur_rate)
114 if (i >= fp->nr_rates)
117 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
123 /* avoid async out and adaptive in if the other method
124 * supports the same format.
125 * this is a workaround for the case like
126 * M-audio audiophile USB.
128 if (attr != cur_attr) {
129 if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
130 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
131 (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
132 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
134 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
135 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
136 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
137 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
143 /* find the format with the largest max. packet size */
144 if (fp->maxpacksize > found->maxpacksize) {
152 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
153 struct usb_host_interface *alts,
154 struct audioformat *fmt)
156 struct usb_device *dev = chip->dev;
158 unsigned char data[1];
161 ep = get_endpoint(alts, 0)->bEndpointAddress;
164 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
165 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
166 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
167 data, sizeof(data))) < 0) {
168 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
169 dev->devnum, iface, ep);
176 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
177 struct usb_host_interface *alts,
178 struct audioformat *fmt)
180 struct usb_device *dev = chip->dev;
181 unsigned char data[1];
185 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
186 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
187 UAC2_EP_CS_PITCH << 8, 0,
188 data, sizeof(data))) < 0) {
189 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH (v2)\n",
190 dev->devnum, iface, fmt->altsetting);
198 * initialize the pitch control and sample rate
200 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
201 struct usb_host_interface *alts,
202 struct audioformat *fmt)
204 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
206 /* if endpoint doesn't have pitch control, bail out */
207 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
210 switch (altsd->bInterfaceProtocol) {
213 return init_pitch_v1(chip, iface, alts, fmt);
216 return init_pitch_v2(chip, iface, alts, fmt);
220 static int start_endpoints(struct snd_usb_substream *subs, bool can_sleep)
224 if (!subs->data_endpoint)
227 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
228 struct snd_usb_endpoint *ep = subs->data_endpoint;
230 snd_printdd(KERN_DEBUG "Starting data EP @%p\n", ep);
232 ep->data_subs = subs;
233 err = snd_usb_endpoint_start(ep, can_sleep);
235 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
240 if (subs->sync_endpoint &&
241 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
242 struct snd_usb_endpoint *ep = subs->sync_endpoint;
244 if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
245 subs->data_endpoint->alt_idx != subs->sync_endpoint->alt_idx) {
246 err = usb_set_interface(subs->dev,
247 subs->sync_endpoint->iface,
248 subs->sync_endpoint->alt_idx);
251 "%d:%d:%d: cannot set interface (%d)\n",
253 subs->sync_endpoint->iface,
254 subs->sync_endpoint->alt_idx, err);
259 snd_printdd(KERN_DEBUG "Starting sync EP @%p\n", ep);
261 ep->sync_slave = subs->data_endpoint;
262 err = snd_usb_endpoint_start(ep, can_sleep);
264 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
272 static void stop_endpoints(struct snd_usb_substream *subs, bool wait)
274 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
275 snd_usb_endpoint_stop(subs->sync_endpoint);
277 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
278 snd_usb_endpoint_stop(subs->data_endpoint);
281 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
282 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
286 static int deactivate_endpoints(struct snd_usb_substream *subs)
290 reta = snd_usb_endpoint_deactivate(subs->sync_endpoint);
291 retb = snd_usb_endpoint_deactivate(subs->data_endpoint);
303 * find a matching format and set up the interface
305 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
307 struct usb_device *dev = subs->dev;
308 struct usb_host_interface *alts;
309 struct usb_interface_descriptor *altsd;
310 struct usb_interface *iface;
311 unsigned int ep, attr;
312 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
313 int err, implicit_fb = 0;
315 iface = usb_ifnum_to_if(dev, fmt->iface);
318 alts = &iface->altsetting[fmt->altset_idx];
319 altsd = get_iface_desc(alts);
320 if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
323 if (fmt == subs->cur_audiofmt)
326 /* close the old interface */
327 if (subs->interface >= 0 && subs->interface != fmt->iface) {
328 err = usb_set_interface(subs->dev, subs->interface, 0);
330 snd_printk(KERN_ERR "%d:%d:%d: return to setting 0 failed (%d)\n",
331 dev->devnum, fmt->iface, fmt->altsetting, err);
334 subs->interface = -1;
335 subs->altset_idx = 0;
339 if (subs->interface != fmt->iface ||
340 subs->altset_idx != fmt->altset_idx) {
341 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
343 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed (%d)\n",
344 dev->devnum, fmt->iface, fmt->altsetting, err);
347 snd_printdd(KERN_INFO "setting usb interface %d:%d\n",
348 fmt->iface, fmt->altsetting);
349 subs->interface = fmt->iface;
350 subs->altset_idx = fmt->altset_idx;
353 * "Playback Design" products need a 50ms delay after setting the
356 if (le16_to_cpu(dev->descriptor.idVendor) == 0x23ba)
360 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
361 alts, fmt->endpoint, subs->direction,
362 SND_USB_ENDPOINT_TYPE_DATA);
363 if (!subs->data_endpoint)
366 /* we need a sync pipe in async OUT or adaptive IN mode */
367 /* check the number of EP, since some devices have broken
368 * descriptors which fool us. if it has only one EP,
369 * assume it as adaptive-out or sync-in.
371 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
373 switch (subs->stream->chip->usb_id) {
374 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
375 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
379 iface = usb_ifnum_to_if(dev, 3);
381 if (!iface || iface->num_altsetting == 0)
384 alts = &iface->altsetting[1];
388 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
389 case USB_ID(0x0763, 0x2081):
393 iface = usb_ifnum_to_if(dev, 2);
395 if (!iface || iface->num_altsetting == 0)
398 alts = &iface->altsetting[1];
403 if (((is_playback && attr == USB_ENDPOINT_SYNC_ASYNC) ||
404 (!is_playback && attr == USB_ENDPOINT_SYNC_ADAPTIVE)) &&
405 altsd->bNumEndpoints >= 2) {
406 /* check sync-pipe endpoint */
407 /* ... and check descriptor size before accessing bSynchAddress
408 because there is a version of the SB Audigy 2 NX firmware lacking
409 the audio fields in the endpoint descriptors */
410 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
411 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
412 get_endpoint(alts, 1)->bSynchAddress != 0 &&
414 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
415 dev->devnum, fmt->iface, fmt->altsetting,
416 get_endpoint(alts, 1)->bmAttributes,
417 get_endpoint(alts, 1)->bLength,
418 get_endpoint(alts, 1)->bSynchAddress);
421 ep = get_endpoint(alts, 1)->bEndpointAddress;
423 get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
424 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
425 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
426 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
427 dev->devnum, fmt->iface, fmt->altsetting,
428 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
432 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
433 == USB_ENDPOINT_USAGE_IMPLICIT_FB;
436 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
437 alts, ep, !subs->direction,
439 SND_USB_ENDPOINT_TYPE_DATA :
440 SND_USB_ENDPOINT_TYPE_SYNC);
441 if (!subs->sync_endpoint)
444 subs->data_endpoint->sync_master = subs->sync_endpoint;
447 if ((err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt)) < 0)
450 subs->cur_audiofmt = fmt;
452 snd_usb_set_format_quirk(subs, fmt);
456 "setting done: format = %d, rate = %d..%d, channels = %d\n",
457 fmt->format, fmt->rate_min, fmt->rate_max, fmt->channels);
459 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
460 subs->datapipe, subs->syncpipe);
467 * Return the score of matching two audioformats.
468 * Veto the audioformat if:
469 * - It has no channels for some reason.
470 * - Requested PCM format is not supported.
471 * - Requested sample rate is not supported.
473 static int match_endpoint_audioformats(struct audioformat *fp,
474 struct audioformat *match, int rate,
475 snd_pcm_format_t pcm_format)
480 if (fp->channels < 1) {
481 snd_printdd("%s: (fmt @%p) no channels\n", __func__, fp);
485 if (!(fp->formats & (1ULL << pcm_format))) {
486 snd_printdd("%s: (fmt @%p) no match for format %d\n", __func__,
491 for (i = 0; i < fp->nr_rates; i++) {
492 if (fp->rate_table[i] == rate) {
498 snd_printdd("%s: (fmt @%p) no match for rate %d\n", __func__,
503 if (fp->channels == match->channels)
506 snd_printdd("%s: (fmt @%p) score %d\n", __func__, fp, score);
512 * Configure the sync ep using the rate and pcm format of the data ep.
514 static int configure_sync_endpoint(struct snd_usb_substream *subs)
517 struct audioformat *fp;
518 struct audioformat *sync_fp = NULL;
520 int sync_period_bytes = subs->period_bytes;
521 struct snd_usb_substream *sync_subs =
522 &subs->stream->substream[subs->direction ^ 1];
524 if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
526 return snd_usb_endpoint_set_params(subs->sync_endpoint,
534 /* Try to find the best matching audioformat. */
535 list_for_each_entry(fp, &sync_subs->fmt_list, list) {
536 int score = match_endpoint_audioformats(fp, subs->cur_audiofmt,
537 subs->cur_rate, subs->pcm_format);
539 if (score > cur_score) {
545 if (unlikely(sync_fp == NULL)) {
546 snd_printk(KERN_ERR "%s: no valid audioformat for sync ep %x found\n",
547 __func__, sync_subs->ep_num);
552 * Recalculate the period bytes if channel number differ between
553 * data and sync ep audioformat.
555 if (sync_fp->channels != subs->channels) {
556 sync_period_bytes = (subs->period_bytes / subs->channels) *
558 snd_printdd("%s: adjusted sync ep period bytes (%d -> %d)\n",
559 __func__, subs->period_bytes, sync_period_bytes);
562 ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
574 * configure endpoint params
576 * called during initial setup and upon resume
578 static int configure_endpoint(struct snd_usb_substream *subs)
583 stop_endpoints(subs, true);
584 ret = snd_usb_endpoint_set_params(subs->data_endpoint,
590 subs->sync_endpoint);
594 if (subs->sync_endpoint)
595 ret = configure_sync_endpoint(subs);
603 * allocate a buffer and set the given audio format.
605 * so far we use a physically linear buffer although packetize transfer
606 * doesn't need a continuous area.
607 * if sg buffer is supported on the later version of alsa, we'll follow
610 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
611 struct snd_pcm_hw_params *hw_params)
613 struct snd_usb_substream *subs = substream->runtime->private_data;
614 struct audioformat *fmt;
617 ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
618 params_buffer_bytes(hw_params));
622 subs->pcm_format = params_format(hw_params);
623 subs->period_bytes = params_period_bytes(hw_params);
624 subs->channels = params_channels(hw_params);
625 subs->cur_rate = params_rate(hw_params);
627 fmt = find_format(subs);
629 snd_printd(KERN_DEBUG "cannot set format: format = %#x, rate = %d, channels = %d\n",
630 subs->pcm_format, subs->cur_rate, subs->channels);
634 down_read(&subs->stream->chip->shutdown_rwsem);
635 if (subs->stream->chip->shutdown)
638 ret = set_format(subs, fmt);
639 up_read(&subs->stream->chip->shutdown_rwsem);
643 subs->interface = fmt->iface;
644 subs->altset_idx = fmt->altset_idx;
645 subs->need_setup_ep = true;
653 * reset the audio format and release the buffer
655 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
657 struct snd_usb_substream *subs = substream->runtime->private_data;
659 subs->cur_audiofmt = NULL;
661 subs->period_bytes = 0;
662 down_read(&subs->stream->chip->shutdown_rwsem);
663 if (!subs->stream->chip->shutdown) {
664 stop_endpoints(subs, true);
665 deactivate_endpoints(subs);
667 up_read(&subs->stream->chip->shutdown_rwsem);
668 return snd_pcm_lib_free_vmalloc_buffer(substream);
674 * only a few subtle things...
676 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
678 struct snd_pcm_runtime *runtime = substream->runtime;
679 struct snd_usb_substream *subs = runtime->private_data;
680 struct usb_host_interface *alts;
681 struct usb_interface *iface;
684 if (! subs->cur_audiofmt) {
685 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
689 down_read(&subs->stream->chip->shutdown_rwsem);
690 if (subs->stream->chip->shutdown) {
694 if (snd_BUG_ON(!subs->data_endpoint)) {
699 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
700 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
702 ret = set_format(subs, subs->cur_audiofmt);
706 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
707 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
708 ret = snd_usb_init_sample_rate(subs->stream->chip,
709 subs->cur_audiofmt->iface,
716 if (subs->need_setup_ep) {
717 ret = configure_endpoint(subs);
720 subs->need_setup_ep = false;
723 /* some unit conversions in runtime */
724 subs->data_endpoint->maxframesize =
725 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
726 subs->data_endpoint->curframesize =
727 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
729 /* reset the pointer */
730 subs->hwptr_done = 0;
731 subs->transfer_done = 0;
732 subs->last_delay = 0;
733 subs->last_frame_number = 0;
736 /* for playback, submit the URBs now; otherwise, the first hwptr_done
737 * updates for all URBs would happen at the same time when starting */
738 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
739 ret = start_endpoints(subs, true);
742 up_read(&subs->stream->chip->shutdown_rwsem);
746 static struct snd_pcm_hardware snd_usb_hardware =
748 .info = SNDRV_PCM_INFO_MMAP |
749 SNDRV_PCM_INFO_MMAP_VALID |
750 SNDRV_PCM_INFO_BATCH |
751 SNDRV_PCM_INFO_INTERLEAVED |
752 SNDRV_PCM_INFO_BLOCK_TRANSFER |
753 SNDRV_PCM_INFO_PAUSE,
754 .buffer_bytes_max = 1024 * 1024,
755 .period_bytes_min = 64,
756 .period_bytes_max = 512 * 1024,
761 static int hw_check_valid_format(struct snd_usb_substream *subs,
762 struct snd_pcm_hw_params *params,
763 struct audioformat *fp)
765 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
766 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
767 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
768 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
769 struct snd_mask check_fmts;
772 /* check the format */
773 snd_mask_none(&check_fmts);
774 check_fmts.bits[0] = (u32)fp->formats;
775 check_fmts.bits[1] = (u32)(fp->formats >> 32);
776 snd_mask_intersect(&check_fmts, fmts);
777 if (snd_mask_empty(&check_fmts)) {
778 hwc_debug(" > check: no supported format %d\n", fp->format);
781 /* check the channels */
782 if (fp->channels < ct->min || fp->channels > ct->max) {
783 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
786 /* check the rate is within the range */
787 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
788 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
791 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
792 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
795 /* check whether the period time is >= the data packet interval */
796 if (subs->speed != USB_SPEED_FULL) {
797 ptime = 125 * (1 << fp->datainterval);
798 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
799 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
806 static int hw_rule_rate(struct snd_pcm_hw_params *params,
807 struct snd_pcm_hw_rule *rule)
809 struct snd_usb_substream *subs = rule->private;
810 struct audioformat *fp;
811 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
812 unsigned int rmin, rmax;
815 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
818 list_for_each_entry(fp, &subs->fmt_list, list) {
819 if (!hw_check_valid_format(subs, params, fp))
822 if (rmin > fp->rate_min)
824 if (rmax < fp->rate_max)
833 hwc_debug(" --> get empty\n");
839 if (it->min < rmin) {
844 if (it->max > rmax) {
849 if (snd_interval_checkempty(it)) {
853 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
858 static int hw_rule_channels(struct snd_pcm_hw_params *params,
859 struct snd_pcm_hw_rule *rule)
861 struct snd_usb_substream *subs = rule->private;
862 struct audioformat *fp;
863 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
864 unsigned int rmin, rmax;
867 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
870 list_for_each_entry(fp, &subs->fmt_list, list) {
871 if (!hw_check_valid_format(subs, params, fp))
874 if (rmin > fp->channels)
876 if (rmax < fp->channels)
885 hwc_debug(" --> get empty\n");
891 if (it->min < rmin) {
896 if (it->max > rmax) {
901 if (snd_interval_checkempty(it)) {
905 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
909 static int hw_rule_format(struct snd_pcm_hw_params *params,
910 struct snd_pcm_hw_rule *rule)
912 struct snd_usb_substream *subs = rule->private;
913 struct audioformat *fp;
914 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
919 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
921 list_for_each_entry(fp, &subs->fmt_list, list) {
922 if (!hw_check_valid_format(subs, params, fp))
924 fbits |= fp->formats;
927 oldbits[0] = fmt->bits[0];
928 oldbits[1] = fmt->bits[1];
929 fmt->bits[0] &= (u32)fbits;
930 fmt->bits[1] &= (u32)(fbits >> 32);
931 if (!fmt->bits[0] && !fmt->bits[1]) {
932 hwc_debug(" --> get empty\n");
935 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
936 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
940 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
941 struct snd_pcm_hw_rule *rule)
943 struct snd_usb_substream *subs = rule->private;
944 struct audioformat *fp;
945 struct snd_interval *it;
946 unsigned char min_datainterval;
950 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
951 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
952 min_datainterval = 0xff;
953 list_for_each_entry(fp, &subs->fmt_list, list) {
954 if (!hw_check_valid_format(subs, params, fp))
956 min_datainterval = min(min_datainterval, fp->datainterval);
958 if (min_datainterval == 0xff) {
959 hwc_debug(" --> get empty\n");
963 pmin = 125 * (1 << min_datainterval);
965 if (it->min < pmin) {
970 if (snd_interval_checkempty(it)) {
974 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
979 * If the device supports unusual bit rates, does the request meet these?
981 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
982 struct snd_usb_substream *subs)
984 struct audioformat *fp;
986 int count = 0, needs_knot = 0;
989 kfree(subs->rate_list.list);
990 subs->rate_list.list = NULL;
992 list_for_each_entry(fp, &subs->fmt_list, list) {
993 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
995 count += fp->nr_rates;
996 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1002 subs->rate_list.list = rate_list =
1003 kmalloc(sizeof(int) * count, GFP_KERNEL);
1004 if (!subs->rate_list.list)
1006 subs->rate_list.count = count;
1007 subs->rate_list.mask = 0;
1009 list_for_each_entry(fp, &subs->fmt_list, list) {
1011 for (i = 0; i < fp->nr_rates; i++)
1012 rate_list[count++] = fp->rate_table[i];
1014 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1024 * set up the runtime hardware information.
1027 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1029 struct audioformat *fp;
1030 unsigned int pt, ptmin;
1031 int param_period_time_if_needed;
1034 runtime->hw.formats = subs->formats;
1036 runtime->hw.rate_min = 0x7fffffff;
1037 runtime->hw.rate_max = 0;
1038 runtime->hw.channels_min = 256;
1039 runtime->hw.channels_max = 0;
1040 runtime->hw.rates = 0;
1042 /* check min/max rates and channels */
1043 list_for_each_entry(fp, &subs->fmt_list, list) {
1044 runtime->hw.rates |= fp->rates;
1045 if (runtime->hw.rate_min > fp->rate_min)
1046 runtime->hw.rate_min = fp->rate_min;
1047 if (runtime->hw.rate_max < fp->rate_max)
1048 runtime->hw.rate_max = fp->rate_max;
1049 if (runtime->hw.channels_min > fp->channels)
1050 runtime->hw.channels_min = fp->channels;
1051 if (runtime->hw.channels_max < fp->channels)
1052 runtime->hw.channels_max = fp->channels;
1053 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1054 /* FIXME: there might be more than one audio formats... */
1055 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1058 pt = 125 * (1 << fp->datainterval);
1059 ptmin = min(ptmin, pt);
1061 err = snd_usb_autoresume(subs->stream->chip);
1065 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1066 if (subs->speed == USB_SPEED_FULL)
1067 /* full speed devices have fixed data packet interval */
1070 /* if period time doesn't go below 1 ms, no rules needed */
1071 param_period_time_if_needed = -1;
1072 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1075 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1077 SNDRV_PCM_HW_PARAM_FORMAT,
1078 SNDRV_PCM_HW_PARAM_CHANNELS,
1079 param_period_time_if_needed,
1082 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1083 hw_rule_channels, subs,
1084 SNDRV_PCM_HW_PARAM_FORMAT,
1085 SNDRV_PCM_HW_PARAM_RATE,
1086 param_period_time_if_needed,
1089 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1090 hw_rule_format, subs,
1091 SNDRV_PCM_HW_PARAM_RATE,
1092 SNDRV_PCM_HW_PARAM_CHANNELS,
1093 param_period_time_if_needed,
1096 if (param_period_time_if_needed >= 0) {
1097 err = snd_pcm_hw_rule_add(runtime, 0,
1098 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1099 hw_rule_period_time, subs,
1100 SNDRV_PCM_HW_PARAM_FORMAT,
1101 SNDRV_PCM_HW_PARAM_CHANNELS,
1102 SNDRV_PCM_HW_PARAM_RATE,
1107 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1112 snd_usb_autosuspend(subs->stream->chip);
1116 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
1118 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1119 struct snd_pcm_runtime *runtime = substream->runtime;
1120 struct snd_usb_substream *subs = &as->substream[direction];
1122 subs->interface = -1;
1123 subs->altset_idx = 0;
1124 runtime->hw = snd_usb_hardware;
1125 runtime->private_data = subs;
1126 subs->pcm_substream = substream;
1127 /* runtime PM is also done there */
1128 return setup_hw_info(runtime, subs);
1131 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1133 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1134 struct snd_usb_substream *subs = &as->substream[direction];
1136 stop_endpoints(subs, true);
1138 if (!as->chip->shutdown && subs->interface >= 0) {
1139 usb_set_interface(subs->dev, subs->interface, 0);
1140 subs->interface = -1;
1143 subs->pcm_substream = NULL;
1144 snd_usb_autosuspend(subs->stream->chip);
1149 /* Since a URB can handle only a single linear buffer, we must use double
1150 * buffering when the data to be transferred overflows the buffer boundary.
1151 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1154 static void retire_capture_urb(struct snd_usb_substream *subs,
1157 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1158 unsigned int stride, frames, bytes, oldptr;
1159 int i, period_elapsed = 0;
1160 unsigned long flags;
1162 int current_frame_number;
1164 /* read frame number here, update pointer in critical section */
1165 current_frame_number = usb_get_current_frame_number(subs->dev);
1167 stride = runtime->frame_bits >> 3;
1169 for (i = 0; i < urb->number_of_packets; i++) {
1170 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
1171 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1172 snd_printdd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
1175 bytes = urb->iso_frame_desc[i].actual_length;
1176 frames = bytes / stride;
1177 if (!subs->txfr_quirk)
1178 bytes = frames * stride;
1179 if (bytes % (runtime->sample_bits >> 3) != 0) {
1180 int oldbytes = bytes;
1181 bytes = frames * stride;
1182 snd_printdd(KERN_ERR "Corrected urb data len. %d->%d\n",
1185 /* update the current pointer */
1186 spin_lock_irqsave(&subs->lock, flags);
1187 oldptr = subs->hwptr_done;
1188 subs->hwptr_done += bytes;
1189 if (subs->hwptr_done >= runtime->buffer_size * stride)
1190 subs->hwptr_done -= runtime->buffer_size * stride;
1191 frames = (bytes + (oldptr % stride)) / stride;
1192 subs->transfer_done += frames;
1193 if (subs->transfer_done >= runtime->period_size) {
1194 subs->transfer_done -= runtime->period_size;
1197 /* capture delay is by construction limited to one URB,
1200 runtime->delay = subs->last_delay = 0;
1202 /* realign last_frame_number */
1203 subs->last_frame_number = current_frame_number;
1204 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1206 spin_unlock_irqrestore(&subs->lock, flags);
1207 /* copy a data chunk */
1208 if (oldptr + bytes > runtime->buffer_size * stride) {
1209 unsigned int bytes1 =
1210 runtime->buffer_size * stride - oldptr;
1211 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1212 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1214 memcpy(runtime->dma_area + oldptr, cp, bytes);
1219 snd_pcm_period_elapsed(subs->pcm_substream);
1222 static void prepare_playback_urb(struct snd_usb_substream *subs,
1225 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1226 struct snd_usb_endpoint *ep = subs->data_endpoint;
1227 struct snd_urb_ctx *ctx = urb->context;
1228 unsigned int counts, frames, bytes;
1229 int i, stride, period_elapsed = 0;
1230 unsigned long flags;
1232 stride = runtime->frame_bits >> 3;
1235 urb->number_of_packets = 0;
1236 spin_lock_irqsave(&subs->lock, flags);
1237 for (i = 0; i < ctx->packets; i++) {
1238 if (ctx->packet_size[i])
1239 counts = ctx->packet_size[i];
1241 counts = snd_usb_endpoint_next_packet_size(ep);
1243 /* set up descriptor */
1244 urb->iso_frame_desc[i].offset = frames * stride;
1245 urb->iso_frame_desc[i].length = counts * stride;
1247 urb->number_of_packets++;
1248 subs->transfer_done += counts;
1249 if (subs->transfer_done >= runtime->period_size) {
1250 subs->transfer_done -= runtime->period_size;
1252 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1253 if (subs->transfer_done > 0) {
1254 /* FIXME: fill-max mode is not
1256 frames -= subs->transfer_done;
1257 counts -= subs->transfer_done;
1258 urb->iso_frame_desc[i].length =
1260 subs->transfer_done = 0;
1263 if (i < ctx->packets) {
1264 /* add a transfer delimiter */
1265 urb->iso_frame_desc[i].offset =
1267 urb->iso_frame_desc[i].length = 0;
1268 urb->number_of_packets++;
1273 if (period_elapsed &&
1274 !snd_usb_endpoint_implicit_feedback_sink(subs->data_endpoint)) /* finish at the period boundary */
1277 bytes = frames * stride;
1278 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1279 /* err, the transferred area goes over buffer boundary. */
1280 unsigned int bytes1 =
1281 runtime->buffer_size * stride - subs->hwptr_done;
1282 memcpy(urb->transfer_buffer,
1283 runtime->dma_area + subs->hwptr_done, bytes1);
1284 memcpy(urb->transfer_buffer + bytes1,
1285 runtime->dma_area, bytes - bytes1);
1287 memcpy(urb->transfer_buffer,
1288 runtime->dma_area + subs->hwptr_done, bytes);
1290 subs->hwptr_done += bytes;
1291 if (subs->hwptr_done >= runtime->buffer_size * stride)
1292 subs->hwptr_done -= runtime->buffer_size * stride;
1294 /* update delay with exact number of samples queued */
1295 runtime->delay = subs->last_delay;
1296 runtime->delay += frames;
1297 subs->last_delay = runtime->delay;
1299 /* realign last_frame_number */
1300 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1301 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1303 spin_unlock_irqrestore(&subs->lock, flags);
1304 urb->transfer_buffer_length = bytes;
1306 snd_pcm_period_elapsed(subs->pcm_substream);
1310 * process after playback data complete
1311 * - decrease the delay count again
1313 static void retire_playback_urb(struct snd_usb_substream *subs,
1316 unsigned long flags;
1317 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1318 int stride = runtime->frame_bits >> 3;
1319 int processed = urb->transfer_buffer_length / stride;
1322 /* ignore the delay accounting when procssed=0 is given, i.e.
1323 * silent payloads are procssed before handling the actual data
1328 spin_lock_irqsave(&subs->lock, flags);
1329 if (!subs->last_delay)
1330 goto out; /* short path */
1332 est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1333 /* update delay with exact number of samples played */
1334 if (processed > subs->last_delay)
1335 subs->last_delay = 0;
1337 subs->last_delay -= processed;
1338 runtime->delay = subs->last_delay;
1341 * Report when delay estimate is off by more than 2ms.
1342 * The error should be lower than 2ms since the estimate relies
1343 * on two reads of a counter updated every ms.
1345 if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1346 snd_printk(KERN_DEBUG "delay: estimated %d, actual %d\n",
1347 est_delay, subs->last_delay);
1349 if (!subs->running) {
1350 /* update last_frame_number for delay counting here since
1351 * prepare_playback_urb won't be called during pause
1353 subs->last_frame_number =
1354 usb_get_current_frame_number(subs->dev) & 0xff;
1358 spin_unlock_irqrestore(&subs->lock, flags);
1361 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1363 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1366 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1368 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1371 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1373 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1376 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1378 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1381 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1384 struct snd_usb_substream *subs = substream->runtime->private_data;
1387 case SNDRV_PCM_TRIGGER_START:
1388 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1389 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1390 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1393 case SNDRV_PCM_TRIGGER_STOP:
1394 stop_endpoints(subs, false);
1397 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1398 subs->data_endpoint->prepare_data_urb = NULL;
1399 /* keep retire_data_urb for delay calculation */
1400 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1408 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1412 struct snd_usb_substream *subs = substream->runtime->private_data;
1415 case SNDRV_PCM_TRIGGER_START:
1416 err = start_endpoints(subs, false);
1420 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1423 case SNDRV_PCM_TRIGGER_STOP:
1424 stop_endpoints(subs, false);
1427 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1428 subs->data_endpoint->retire_data_urb = NULL;
1431 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1432 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1440 static struct snd_pcm_ops snd_usb_playback_ops = {
1441 .open = snd_usb_playback_open,
1442 .close = snd_usb_playback_close,
1443 .ioctl = snd_pcm_lib_ioctl,
1444 .hw_params = snd_usb_hw_params,
1445 .hw_free = snd_usb_hw_free,
1446 .prepare = snd_usb_pcm_prepare,
1447 .trigger = snd_usb_substream_playback_trigger,
1448 .pointer = snd_usb_pcm_pointer,
1449 .page = snd_pcm_lib_get_vmalloc_page,
1450 .mmap = snd_pcm_lib_mmap_vmalloc,
1453 static struct snd_pcm_ops snd_usb_capture_ops = {
1454 .open = snd_usb_capture_open,
1455 .close = snd_usb_capture_close,
1456 .ioctl = snd_pcm_lib_ioctl,
1457 .hw_params = snd_usb_hw_params,
1458 .hw_free = snd_usb_hw_free,
1459 .prepare = snd_usb_pcm_prepare,
1460 .trigger = snd_usb_substream_capture_trigger,
1461 .pointer = snd_usb_pcm_pointer,
1462 .page = snd_pcm_lib_get_vmalloc_page,
1463 .mmap = snd_pcm_lib_mmap_vmalloc,
1466 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1468 snd_pcm_set_ops(pcm, stream,
1469 stream == SNDRV_PCM_STREAM_PLAYBACK ?
1470 &snd_usb_playback_ops : &snd_usb_capture_ops);