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)
98 struct audioformat *found = NULL;
99 int cur_attr = 0, attr;
101 list_for_each(p, &subs->fmt_list) {
102 struct audioformat *fp;
103 fp = list_entry(p, struct audioformat, list);
104 if (!(fp->formats & (1uLL << subs->pcm_format)))
106 if (fp->channels != subs->channels)
108 if (subs->cur_rate < fp->rate_min ||
109 subs->cur_rate > fp->rate_max)
111 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
113 for (i = 0; i < fp->nr_rates; i++)
114 if (fp->rate_table[i] == subs->cur_rate)
116 if (i >= fp->nr_rates)
119 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
125 /* avoid async out and adaptive in if the other method
126 * supports the same format.
127 * this is a workaround for the case like
128 * M-audio audiophile USB.
130 if (attr != cur_attr) {
131 if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
132 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
133 (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
134 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
136 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
137 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
138 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
139 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
145 /* find the format with the largest max. packet size */
146 if (fp->maxpacksize > found->maxpacksize) {
154 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
155 struct usb_host_interface *alts,
156 struct audioformat *fmt)
158 struct usb_device *dev = chip->dev;
160 unsigned char data[1];
163 ep = get_endpoint(alts, 0)->bEndpointAddress;
166 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
167 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
168 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
169 data, sizeof(data))) < 0) {
170 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
171 dev->devnum, iface, ep);
178 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
179 struct usb_host_interface *alts,
180 struct audioformat *fmt)
182 struct usb_device *dev = chip->dev;
183 unsigned char data[1];
187 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
188 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
189 UAC2_EP_CS_PITCH << 8, 0,
190 data, sizeof(data))) < 0) {
191 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH (v2)\n",
192 dev->devnum, iface, fmt->altsetting);
200 * initialize the pitch control and sample rate
202 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
203 struct usb_host_interface *alts,
204 struct audioformat *fmt)
206 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
208 /* if endpoint doesn't have pitch control, bail out */
209 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
212 switch (altsd->bInterfaceProtocol) {
215 return init_pitch_v1(chip, iface, alts, fmt);
218 return init_pitch_v2(chip, iface, alts, fmt);
222 static int start_endpoints(struct snd_usb_substream *subs, bool can_sleep)
226 if (!subs->data_endpoint)
229 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
230 struct snd_usb_endpoint *ep = subs->data_endpoint;
232 snd_printdd(KERN_DEBUG "Starting data EP @%p\n", ep);
234 ep->data_subs = subs;
235 err = snd_usb_endpoint_start(ep, can_sleep);
237 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
242 if (subs->sync_endpoint &&
243 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
244 struct snd_usb_endpoint *ep = subs->sync_endpoint;
246 if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
247 subs->data_endpoint->alt_idx != subs->sync_endpoint->alt_idx) {
248 err = usb_set_interface(subs->dev,
249 subs->sync_endpoint->iface,
250 subs->sync_endpoint->alt_idx);
253 "%d:%d:%d: cannot set interface (%d)\n",
255 subs->sync_endpoint->iface,
256 subs->sync_endpoint->alt_idx, err);
261 snd_printdd(KERN_DEBUG "Starting sync EP @%p\n", ep);
263 ep->sync_slave = subs->data_endpoint;
264 err = snd_usb_endpoint_start(ep, can_sleep);
266 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
274 static void stop_endpoints(struct snd_usb_substream *subs, bool wait)
276 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
277 snd_usb_endpoint_stop(subs->sync_endpoint);
279 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
280 snd_usb_endpoint_stop(subs->data_endpoint);
283 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
284 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
288 static int deactivate_endpoints(struct snd_usb_substream *subs)
292 reta = snd_usb_endpoint_deactivate(subs->sync_endpoint);
293 retb = snd_usb_endpoint_deactivate(subs->data_endpoint);
305 * find a matching format and set up the interface
307 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
309 struct usb_device *dev = subs->dev;
310 struct usb_host_interface *alts;
311 struct usb_interface_descriptor *altsd;
312 struct usb_interface *iface;
313 unsigned int ep, attr;
314 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
315 int err, implicit_fb = 0;
317 iface = usb_ifnum_to_if(dev, fmt->iface);
320 alts = &iface->altsetting[fmt->altset_idx];
321 altsd = get_iface_desc(alts);
322 if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
325 if (fmt == subs->cur_audiofmt)
328 /* close the old interface */
329 if (subs->interface >= 0 && subs->interface != fmt->iface) {
330 err = usb_set_interface(subs->dev, subs->interface, 0);
332 snd_printk(KERN_ERR "%d:%d:%d: return to setting 0 failed (%d)\n",
333 dev->devnum, fmt->iface, fmt->altsetting, err);
336 subs->interface = -1;
337 subs->altset_idx = 0;
341 if (subs->interface != fmt->iface ||
342 subs->altset_idx != fmt->altset_idx) {
343 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
345 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed (%d)\n",
346 dev->devnum, fmt->iface, fmt->altsetting, err);
349 snd_printdd(KERN_INFO "setting usb interface %d:%d\n",
350 fmt->iface, fmt->altsetting);
351 subs->interface = fmt->iface;
352 subs->altset_idx = fmt->altset_idx;
355 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
356 alts, fmt->endpoint, subs->direction,
357 SND_USB_ENDPOINT_TYPE_DATA);
358 if (!subs->data_endpoint)
361 /* we need a sync pipe in async OUT or adaptive IN mode */
362 /* check the number of EP, since some devices have broken
363 * descriptors which fool us. if it has only one EP,
364 * assume it as adaptive-out or sync-in.
366 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
368 switch (subs->stream->chip->usb_id) {
369 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
370 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
374 iface = usb_ifnum_to_if(dev, 3);
376 if (!iface || iface->num_altsetting == 0)
379 alts = &iface->altsetting[1];
383 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
384 case USB_ID(0x0763, 0x2081):
388 iface = usb_ifnum_to_if(dev, 2);
390 if (!iface || iface->num_altsetting == 0)
393 alts = &iface->altsetting[1];
398 if (((is_playback && attr == USB_ENDPOINT_SYNC_ASYNC) ||
399 (!is_playback && attr == USB_ENDPOINT_SYNC_ADAPTIVE)) &&
400 altsd->bNumEndpoints >= 2) {
401 /* check sync-pipe endpoint */
402 /* ... and check descriptor size before accessing bSynchAddress
403 because there is a version of the SB Audigy 2 NX firmware lacking
404 the audio fields in the endpoint descriptors */
405 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
406 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
407 get_endpoint(alts, 1)->bSynchAddress != 0 &&
409 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
410 dev->devnum, fmt->iface, fmt->altsetting,
411 get_endpoint(alts, 1)->bmAttributes,
412 get_endpoint(alts, 1)->bLength,
413 get_endpoint(alts, 1)->bSynchAddress);
416 ep = get_endpoint(alts, 1)->bEndpointAddress;
418 get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
419 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
420 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
421 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
422 dev->devnum, fmt->iface, fmt->altsetting,
423 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
427 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
428 == USB_ENDPOINT_USAGE_IMPLICIT_FB;
431 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
432 alts, ep, !subs->direction,
434 SND_USB_ENDPOINT_TYPE_DATA :
435 SND_USB_ENDPOINT_TYPE_SYNC);
436 if (!subs->sync_endpoint)
439 subs->data_endpoint->sync_master = subs->sync_endpoint;
442 if ((err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt)) < 0)
445 subs->cur_audiofmt = fmt;
447 snd_usb_set_format_quirk(subs, fmt);
451 "setting done: format = %d, rate = %d..%d, channels = %d\n",
452 fmt->format, fmt->rate_min, fmt->rate_max, fmt->channels);
454 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
455 subs->datapipe, subs->syncpipe);
462 * Return the score of matching two audioformats.
463 * Veto the audioformat if:
464 * - It has no channels for some reason.
465 * - Requested PCM format is not supported.
466 * - Requested sample rate is not supported.
468 static int match_endpoint_audioformats(struct audioformat *fp,
469 struct audioformat *match, int rate,
470 snd_pcm_format_t pcm_format)
475 if (fp->channels < 1) {
476 snd_printdd("%s: (fmt @%p) no channels\n", __func__, fp);
480 if (!(fp->formats & (1ULL << pcm_format))) {
481 snd_printdd("%s: (fmt @%p) no match for format %d\n", __func__,
486 for (i = 0; i < fp->nr_rates; i++) {
487 if (fp->rate_table[i] == rate) {
493 snd_printdd("%s: (fmt @%p) no match for rate %d\n", __func__,
498 if (fp->channels == match->channels)
501 snd_printdd("%s: (fmt @%p) score %d\n", __func__, fp, score);
507 * Configure the sync ep using the rate and pcm format of the data ep.
509 static int configure_sync_endpoint(struct snd_usb_substream *subs)
512 struct audioformat *fp;
513 struct audioformat *sync_fp = NULL;
515 int sync_period_bytes = subs->period_bytes;
516 struct snd_usb_substream *sync_subs =
517 &subs->stream->substream[subs->direction ^ 1];
519 if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
521 return snd_usb_endpoint_set_params(subs->sync_endpoint,
529 /* Try to find the best matching audioformat. */
530 list_for_each_entry(fp, &sync_subs->fmt_list, list) {
531 int score = match_endpoint_audioformats(fp, subs->cur_audiofmt,
532 subs->cur_rate, subs->pcm_format);
534 if (score > cur_score) {
540 if (unlikely(sync_fp == NULL)) {
541 snd_printk(KERN_ERR "%s: no valid audioformat for sync ep %x found\n",
542 __func__, sync_subs->ep_num);
547 * Recalculate the period bytes if channel number differ between
548 * data and sync ep audioformat.
550 if (sync_fp->channels != subs->channels) {
551 sync_period_bytes = (subs->period_bytes / subs->channels) *
553 snd_printdd("%s: adjusted sync ep period bytes (%d -> %d)\n",
554 __func__, subs->period_bytes, sync_period_bytes);
557 ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
569 * configure endpoint params
571 * called during initial setup and upon resume
573 static int configure_endpoint(struct snd_usb_substream *subs)
578 stop_endpoints(subs, true);
579 ret = snd_usb_endpoint_set_params(subs->data_endpoint,
585 subs->sync_endpoint);
589 if (subs->sync_endpoint)
590 ret = configure_sync_endpoint(subs);
598 * allocate a buffer and set the given audio format.
600 * so far we use a physically linear buffer although packetize transfer
601 * doesn't need a continuous area.
602 * if sg buffer is supported on the later version of alsa, we'll follow
605 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
606 struct snd_pcm_hw_params *hw_params)
608 struct snd_usb_substream *subs = substream->runtime->private_data;
609 struct audioformat *fmt;
612 ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
613 params_buffer_bytes(hw_params));
617 subs->pcm_format = params_format(hw_params);
618 subs->period_bytes = params_period_bytes(hw_params);
619 subs->channels = params_channels(hw_params);
620 subs->cur_rate = params_rate(hw_params);
622 fmt = find_format(subs);
624 snd_printd(KERN_DEBUG "cannot set format: format = %#x, rate = %d, channels = %d\n",
625 subs->pcm_format, subs->cur_rate, subs->channels);
629 down_read(&subs->stream->chip->shutdown_rwsem);
630 if (subs->stream->chip->shutdown)
633 ret = set_format(subs, fmt);
634 up_read(&subs->stream->chip->shutdown_rwsem);
638 subs->interface = fmt->iface;
639 subs->altset_idx = fmt->altset_idx;
640 subs->need_setup_ep = true;
648 * reset the audio format and release the buffer
650 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
652 struct snd_usb_substream *subs = substream->runtime->private_data;
654 subs->cur_audiofmt = NULL;
656 subs->period_bytes = 0;
657 down_read(&subs->stream->chip->shutdown_rwsem);
658 if (!subs->stream->chip->shutdown) {
659 stop_endpoints(subs, true);
660 deactivate_endpoints(subs);
662 up_read(&subs->stream->chip->shutdown_rwsem);
663 return snd_pcm_lib_free_vmalloc_buffer(substream);
669 * only a few subtle things...
671 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
673 struct snd_pcm_runtime *runtime = substream->runtime;
674 struct snd_usb_substream *subs = runtime->private_data;
675 struct usb_host_interface *alts;
676 struct usb_interface *iface;
679 if (! subs->cur_audiofmt) {
680 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
684 down_read(&subs->stream->chip->shutdown_rwsem);
685 if (subs->stream->chip->shutdown) {
689 if (snd_BUG_ON(!subs->data_endpoint)) {
694 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
695 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
697 ret = set_format(subs, subs->cur_audiofmt);
701 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
702 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
703 ret = snd_usb_init_sample_rate(subs->stream->chip,
704 subs->cur_audiofmt->iface,
711 if (subs->need_setup_ep) {
712 ret = configure_endpoint(subs);
715 subs->need_setup_ep = false;
718 /* some unit conversions in runtime */
719 subs->data_endpoint->maxframesize =
720 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
721 subs->data_endpoint->curframesize =
722 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
724 /* reset the pointer */
725 subs->hwptr_done = 0;
726 subs->transfer_done = 0;
727 subs->last_delay = 0;
728 subs->last_frame_number = 0;
731 /* for playback, submit the URBs now; otherwise, the first hwptr_done
732 * updates for all URBs would happen at the same time when starting */
733 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
734 ret = start_endpoints(subs, true);
737 up_read(&subs->stream->chip->shutdown_rwsem);
741 static struct snd_pcm_hardware snd_usb_hardware =
743 .info = SNDRV_PCM_INFO_MMAP |
744 SNDRV_PCM_INFO_MMAP_VALID |
745 SNDRV_PCM_INFO_BATCH |
746 SNDRV_PCM_INFO_INTERLEAVED |
747 SNDRV_PCM_INFO_BLOCK_TRANSFER |
748 SNDRV_PCM_INFO_PAUSE,
749 .buffer_bytes_max = 1024 * 1024,
750 .period_bytes_min = 64,
751 .period_bytes_max = 512 * 1024,
756 static int hw_check_valid_format(struct snd_usb_substream *subs,
757 struct snd_pcm_hw_params *params,
758 struct audioformat *fp)
760 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
761 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
762 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
763 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
764 struct snd_mask check_fmts;
767 /* check the format */
768 snd_mask_none(&check_fmts);
769 check_fmts.bits[0] = (u32)fp->formats;
770 check_fmts.bits[1] = (u32)(fp->formats >> 32);
771 snd_mask_intersect(&check_fmts, fmts);
772 if (snd_mask_empty(&check_fmts)) {
773 hwc_debug(" > check: no supported format %d\n", fp->format);
776 /* check the channels */
777 if (fp->channels < ct->min || fp->channels > ct->max) {
778 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
781 /* check the rate is within the range */
782 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
783 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
786 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
787 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
790 /* check whether the period time is >= the data packet interval */
791 if (subs->speed != USB_SPEED_FULL) {
792 ptime = 125 * (1 << fp->datainterval);
793 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
794 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
801 static int hw_rule_rate(struct snd_pcm_hw_params *params,
802 struct snd_pcm_hw_rule *rule)
804 struct snd_usb_substream *subs = rule->private;
806 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
807 unsigned int rmin, rmax;
810 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
813 list_for_each(p, &subs->fmt_list) {
814 struct audioformat *fp;
815 fp = list_entry(p, struct audioformat, list);
816 if (!hw_check_valid_format(subs, params, fp))
819 if (rmin > fp->rate_min)
821 if (rmax < fp->rate_max)
830 hwc_debug(" --> get empty\n");
836 if (it->min < rmin) {
841 if (it->max > rmax) {
846 if (snd_interval_checkempty(it)) {
850 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
855 static int hw_rule_channels(struct snd_pcm_hw_params *params,
856 struct snd_pcm_hw_rule *rule)
858 struct snd_usb_substream *subs = rule->private;
860 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
861 unsigned int rmin, rmax;
864 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
867 list_for_each(p, &subs->fmt_list) {
868 struct audioformat *fp;
869 fp = list_entry(p, struct audioformat, list);
870 if (!hw_check_valid_format(subs, params, fp))
873 if (rmin > fp->channels)
875 if (rmax < fp->channels)
884 hwc_debug(" --> get empty\n");
890 if (it->min < rmin) {
895 if (it->max > rmax) {
900 if (snd_interval_checkempty(it)) {
904 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
908 static int hw_rule_format(struct snd_pcm_hw_params *params,
909 struct snd_pcm_hw_rule *rule)
911 struct snd_usb_substream *subs = rule->private;
913 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
918 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
920 list_for_each(p, &subs->fmt_list) {
921 struct audioformat *fp;
922 fp = list_entry(p, struct audioformat, list);
923 if (!hw_check_valid_format(subs, params, fp))
925 fbits |= fp->formats;
928 oldbits[0] = fmt->bits[0];
929 oldbits[1] = fmt->bits[1];
930 fmt->bits[0] &= (u32)fbits;
931 fmt->bits[1] &= (u32)(fbits >> 32);
932 if (!fmt->bits[0] && !fmt->bits[1]) {
933 hwc_debug(" --> get empty\n");
936 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
937 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
941 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
942 struct snd_pcm_hw_rule *rule)
944 struct snd_usb_substream *subs = rule->private;
945 struct audioformat *fp;
946 struct snd_interval *it;
947 unsigned char min_datainterval;
951 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
952 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
953 min_datainterval = 0xff;
954 list_for_each_entry(fp, &subs->fmt_list, list) {
955 if (!hw_check_valid_format(subs, params, fp))
957 min_datainterval = min(min_datainterval, fp->datainterval);
959 if (min_datainterval == 0xff) {
960 hwc_debug(" --> get empty\n");
964 pmin = 125 * (1 << min_datainterval);
966 if (it->min < pmin) {
971 if (snd_interval_checkempty(it)) {
975 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
980 * If the device supports unusual bit rates, does the request meet these?
982 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
983 struct snd_usb_substream *subs)
985 struct audioformat *fp;
987 int count = 0, needs_knot = 0;
990 kfree(subs->rate_list.list);
991 subs->rate_list.list = NULL;
993 list_for_each_entry(fp, &subs->fmt_list, list) {
994 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
996 count += fp->nr_rates;
997 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1003 subs->rate_list.list = rate_list =
1004 kmalloc(sizeof(int) * count, GFP_KERNEL);
1005 if (!subs->rate_list.list)
1007 subs->rate_list.count = count;
1008 subs->rate_list.mask = 0;
1010 list_for_each_entry(fp, &subs->fmt_list, list) {
1012 for (i = 0; i < fp->nr_rates; i++)
1013 rate_list[count++] = fp->rate_table[i];
1015 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1025 * set up the runtime hardware information.
1028 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1030 struct list_head *p;
1031 unsigned int pt, ptmin;
1032 int param_period_time_if_needed;
1035 runtime->hw.formats = subs->formats;
1037 runtime->hw.rate_min = 0x7fffffff;
1038 runtime->hw.rate_max = 0;
1039 runtime->hw.channels_min = 256;
1040 runtime->hw.channels_max = 0;
1041 runtime->hw.rates = 0;
1043 /* check min/max rates and channels */
1044 list_for_each(p, &subs->fmt_list) {
1045 struct audioformat *fp;
1046 fp = list_entry(p, struct audioformat, list);
1047 runtime->hw.rates |= fp->rates;
1048 if (runtime->hw.rate_min > fp->rate_min)
1049 runtime->hw.rate_min = fp->rate_min;
1050 if (runtime->hw.rate_max < fp->rate_max)
1051 runtime->hw.rate_max = fp->rate_max;
1052 if (runtime->hw.channels_min > fp->channels)
1053 runtime->hw.channels_min = fp->channels;
1054 if (runtime->hw.channels_max < fp->channels)
1055 runtime->hw.channels_max = fp->channels;
1056 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1057 /* FIXME: there might be more than one audio formats... */
1058 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1061 pt = 125 * (1 << fp->datainterval);
1062 ptmin = min(ptmin, pt);
1064 err = snd_usb_autoresume(subs->stream->chip);
1068 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1069 if (subs->speed == USB_SPEED_FULL)
1070 /* full speed devices have fixed data packet interval */
1073 /* if period time doesn't go below 1 ms, no rules needed */
1074 param_period_time_if_needed = -1;
1075 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1078 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1080 SNDRV_PCM_HW_PARAM_FORMAT,
1081 SNDRV_PCM_HW_PARAM_CHANNELS,
1082 param_period_time_if_needed,
1085 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1086 hw_rule_channels, subs,
1087 SNDRV_PCM_HW_PARAM_FORMAT,
1088 SNDRV_PCM_HW_PARAM_RATE,
1089 param_period_time_if_needed,
1092 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1093 hw_rule_format, subs,
1094 SNDRV_PCM_HW_PARAM_RATE,
1095 SNDRV_PCM_HW_PARAM_CHANNELS,
1096 param_period_time_if_needed,
1099 if (param_period_time_if_needed >= 0) {
1100 err = snd_pcm_hw_rule_add(runtime, 0,
1101 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1102 hw_rule_period_time, subs,
1103 SNDRV_PCM_HW_PARAM_FORMAT,
1104 SNDRV_PCM_HW_PARAM_CHANNELS,
1105 SNDRV_PCM_HW_PARAM_RATE,
1110 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1115 snd_usb_autosuspend(subs->stream->chip);
1119 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
1121 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1122 struct snd_pcm_runtime *runtime = substream->runtime;
1123 struct snd_usb_substream *subs = &as->substream[direction];
1125 subs->interface = -1;
1126 subs->altset_idx = 0;
1127 runtime->hw = snd_usb_hardware;
1128 runtime->private_data = subs;
1129 subs->pcm_substream = substream;
1130 /* runtime PM is also done there */
1131 return setup_hw_info(runtime, subs);
1134 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1136 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1137 struct snd_usb_substream *subs = &as->substream[direction];
1139 stop_endpoints(subs, true);
1141 if (!as->chip->shutdown && subs->interface >= 0) {
1142 usb_set_interface(subs->dev, subs->interface, 0);
1143 subs->interface = -1;
1146 subs->pcm_substream = NULL;
1147 snd_usb_autosuspend(subs->stream->chip);
1152 /* Since a URB can handle only a single linear buffer, we must use double
1153 * buffering when the data to be transferred overflows the buffer boundary.
1154 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1157 static void retire_capture_urb(struct snd_usb_substream *subs,
1160 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1161 unsigned int stride, frames, bytes, oldptr;
1162 int i, period_elapsed = 0;
1163 unsigned long flags;
1165 int current_frame_number;
1167 /* read frame number here, update pointer in critical section */
1168 current_frame_number = usb_get_current_frame_number(subs->dev);
1170 stride = runtime->frame_bits >> 3;
1172 for (i = 0; i < urb->number_of_packets; i++) {
1173 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
1174 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1175 snd_printdd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
1178 bytes = urb->iso_frame_desc[i].actual_length;
1179 frames = bytes / stride;
1180 if (!subs->txfr_quirk)
1181 bytes = frames * stride;
1182 if (bytes % (runtime->sample_bits >> 3) != 0) {
1183 int oldbytes = bytes;
1184 bytes = frames * stride;
1185 snd_printdd(KERN_ERR "Corrected urb data len. %d->%d\n",
1188 /* update the current pointer */
1189 spin_lock_irqsave(&subs->lock, flags);
1190 oldptr = subs->hwptr_done;
1191 subs->hwptr_done += bytes;
1192 if (subs->hwptr_done >= runtime->buffer_size * stride)
1193 subs->hwptr_done -= runtime->buffer_size * stride;
1194 frames = (bytes + (oldptr % stride)) / stride;
1195 subs->transfer_done += frames;
1196 if (subs->transfer_done >= runtime->period_size) {
1197 subs->transfer_done -= runtime->period_size;
1200 /* capture delay is by construction limited to one URB,
1203 runtime->delay = subs->last_delay = 0;
1205 /* realign last_frame_number */
1206 subs->last_frame_number = current_frame_number;
1207 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1209 spin_unlock_irqrestore(&subs->lock, flags);
1210 /* copy a data chunk */
1211 if (oldptr + bytes > runtime->buffer_size * stride) {
1212 unsigned int bytes1 =
1213 runtime->buffer_size * stride - oldptr;
1214 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1215 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1217 memcpy(runtime->dma_area + oldptr, cp, bytes);
1222 snd_pcm_period_elapsed(subs->pcm_substream);
1225 static void prepare_playback_urb(struct snd_usb_substream *subs,
1228 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1229 struct snd_usb_endpoint *ep = subs->data_endpoint;
1230 struct snd_urb_ctx *ctx = urb->context;
1231 unsigned int counts, frames, bytes;
1232 int i, stride, period_elapsed = 0;
1233 unsigned long flags;
1235 stride = runtime->frame_bits >> 3;
1238 urb->number_of_packets = 0;
1239 spin_lock_irqsave(&subs->lock, flags);
1240 for (i = 0; i < ctx->packets; i++) {
1241 if (ctx->packet_size[i])
1242 counts = ctx->packet_size[i];
1244 counts = snd_usb_endpoint_next_packet_size(ep);
1246 /* set up descriptor */
1247 urb->iso_frame_desc[i].offset = frames * stride;
1248 urb->iso_frame_desc[i].length = counts * stride;
1250 urb->number_of_packets++;
1251 subs->transfer_done += counts;
1252 if (subs->transfer_done >= runtime->period_size) {
1253 subs->transfer_done -= runtime->period_size;
1255 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1256 if (subs->transfer_done > 0) {
1257 /* FIXME: fill-max mode is not
1259 frames -= subs->transfer_done;
1260 counts -= subs->transfer_done;
1261 urb->iso_frame_desc[i].length =
1263 subs->transfer_done = 0;
1266 if (i < ctx->packets) {
1267 /* add a transfer delimiter */
1268 urb->iso_frame_desc[i].offset =
1270 urb->iso_frame_desc[i].length = 0;
1271 urb->number_of_packets++;
1276 if (period_elapsed &&
1277 !snd_usb_endpoint_implict_feedback_sink(subs->data_endpoint)) /* finish at the period boundary */
1280 bytes = frames * stride;
1281 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1282 /* err, the transferred area goes over buffer boundary. */
1283 unsigned int bytes1 =
1284 runtime->buffer_size * stride - subs->hwptr_done;
1285 memcpy(urb->transfer_buffer,
1286 runtime->dma_area + subs->hwptr_done, bytes1);
1287 memcpy(urb->transfer_buffer + bytes1,
1288 runtime->dma_area, bytes - bytes1);
1290 memcpy(urb->transfer_buffer,
1291 runtime->dma_area + subs->hwptr_done, bytes);
1293 subs->hwptr_done += bytes;
1294 if (subs->hwptr_done >= runtime->buffer_size * stride)
1295 subs->hwptr_done -= runtime->buffer_size * stride;
1297 /* update delay with exact number of samples queued */
1298 runtime->delay = subs->last_delay;
1299 runtime->delay += frames;
1300 subs->last_delay = runtime->delay;
1302 /* realign last_frame_number */
1303 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1304 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1306 spin_unlock_irqrestore(&subs->lock, flags);
1307 urb->transfer_buffer_length = bytes;
1309 snd_pcm_period_elapsed(subs->pcm_substream);
1313 * process after playback data complete
1314 * - decrease the delay count again
1316 static void retire_playback_urb(struct snd_usb_substream *subs,
1319 unsigned long flags;
1320 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1321 int stride = runtime->frame_bits >> 3;
1322 int processed = urb->transfer_buffer_length / stride;
1325 /* ignore the delay accounting when procssed=0 is given, i.e.
1326 * silent payloads are procssed before handling the actual data
1331 spin_lock_irqsave(&subs->lock, flags);
1332 if (!subs->last_delay)
1333 goto out; /* short path */
1335 est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1336 /* update delay with exact number of samples played */
1337 if (processed > subs->last_delay)
1338 subs->last_delay = 0;
1340 subs->last_delay -= processed;
1341 runtime->delay = subs->last_delay;
1344 * Report when delay estimate is off by more than 2ms.
1345 * The error should be lower than 2ms since the estimate relies
1346 * on two reads of a counter updated every ms.
1348 if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1349 snd_printk(KERN_DEBUG "delay: estimated %d, actual %d\n",
1350 est_delay, subs->last_delay);
1352 if (!subs->running) {
1353 /* update last_frame_number for delay counting here since
1354 * prepare_playback_urb won't be called during pause
1356 subs->last_frame_number =
1357 usb_get_current_frame_number(subs->dev) & 0xff;
1361 spin_unlock_irqrestore(&subs->lock, flags);
1364 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1366 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1369 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1371 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1374 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1376 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1379 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1381 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1384 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1387 struct snd_usb_substream *subs = substream->runtime->private_data;
1390 case SNDRV_PCM_TRIGGER_START:
1391 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1392 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1393 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1396 case SNDRV_PCM_TRIGGER_STOP:
1397 stop_endpoints(subs, false);
1400 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1401 subs->data_endpoint->prepare_data_urb = NULL;
1402 /* keep retire_data_urb for delay calculation */
1403 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1411 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1415 struct snd_usb_substream *subs = substream->runtime->private_data;
1418 case SNDRV_PCM_TRIGGER_START:
1419 err = start_endpoints(subs, false);
1423 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1426 case SNDRV_PCM_TRIGGER_STOP:
1427 stop_endpoints(subs, false);
1430 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1431 subs->data_endpoint->retire_data_urb = NULL;
1434 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1435 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1443 static struct snd_pcm_ops snd_usb_playback_ops = {
1444 .open = snd_usb_playback_open,
1445 .close = snd_usb_playback_close,
1446 .ioctl = snd_pcm_lib_ioctl,
1447 .hw_params = snd_usb_hw_params,
1448 .hw_free = snd_usb_hw_free,
1449 .prepare = snd_usb_pcm_prepare,
1450 .trigger = snd_usb_substream_playback_trigger,
1451 .pointer = snd_usb_pcm_pointer,
1452 .page = snd_pcm_lib_get_vmalloc_page,
1453 .mmap = snd_pcm_lib_mmap_vmalloc,
1456 static struct snd_pcm_ops snd_usb_capture_ops = {
1457 .open = snd_usb_capture_open,
1458 .close = snd_usb_capture_close,
1459 .ioctl = snd_pcm_lib_ioctl,
1460 .hw_params = snd_usb_hw_params,
1461 .hw_free = snd_usb_hw_free,
1462 .prepare = snd_usb_pcm_prepare,
1463 .trigger = snd_usb_substream_capture_trigger,
1464 .pointer = snd_usb_pcm_pointer,
1465 .page = snd_pcm_lib_get_vmalloc_page,
1466 .mmap = snd_pcm_lib_mmap_vmalloc,
1469 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1471 snd_pcm_set_ops(pcm, stream,
1472 stream == SNDRV_PCM_STREAM_PLAYBACK ?
1473 &snd_usb_playback_ops : &snd_usb_capture_ops);