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 current_frame_number = usb_get_current_frame_number(subs->dev);
51 * HCD implementations use different widths, use lower 8 bits.
52 * The delay will be managed up to 256ms, which is more than
55 frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
57 /* Approximation based on number of samples per USB frame (ms),
58 some truncation for 44.1 but the estimate is good enough */
59 est_delay = subs->last_delay - (frame_diff * rate / 1000);
66 * return the current pcm pointer. just based on the hwptr_done value.
68 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
70 struct snd_usb_substream *subs;
71 unsigned int hwptr_done;
73 subs = (struct snd_usb_substream *)substream->runtime->private_data;
74 if (subs->stream->chip->shutdown)
75 return SNDRV_PCM_POS_XRUN;
76 spin_lock(&subs->lock);
77 hwptr_done = subs->hwptr_done;
78 substream->runtime->delay = snd_usb_pcm_delay(subs,
79 substream->runtime->rate);
80 spin_unlock(&subs->lock);
81 return hwptr_done / (substream->runtime->frame_bits >> 3);
85 * find a matching audio format
87 static struct audioformat *find_format(struct snd_usb_substream *subs)
90 struct audioformat *found = NULL;
91 int cur_attr = 0, attr;
93 list_for_each(p, &subs->fmt_list) {
94 struct audioformat *fp;
95 fp = list_entry(p, struct audioformat, list);
96 if (!(fp->formats & (1uLL << subs->pcm_format)))
98 if (fp->channels != subs->channels)
100 if (subs->cur_rate < fp->rate_min ||
101 subs->cur_rate > fp->rate_max)
103 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
105 for (i = 0; i < fp->nr_rates; i++)
106 if (fp->rate_table[i] == subs->cur_rate)
108 if (i >= fp->nr_rates)
111 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
117 /* avoid async out and adaptive in if the other method
118 * supports the same format.
119 * this is a workaround for the case like
120 * M-audio audiophile USB.
122 if (attr != cur_attr) {
123 if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
124 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
125 (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
126 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
128 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
129 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
130 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
131 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
137 /* find the format with the largest max. packet size */
138 if (fp->maxpacksize > found->maxpacksize) {
146 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
147 struct usb_host_interface *alts,
148 struct audioformat *fmt)
150 struct usb_device *dev = chip->dev;
152 unsigned char data[1];
155 ep = get_endpoint(alts, 0)->bEndpointAddress;
158 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
159 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
160 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
161 data, sizeof(data))) < 0) {
162 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
163 dev->devnum, iface, ep);
170 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
171 struct usb_host_interface *alts,
172 struct audioformat *fmt)
174 struct usb_device *dev = chip->dev;
175 unsigned char data[1];
179 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
180 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
181 UAC2_EP_CS_PITCH << 8, 0,
182 data, sizeof(data))) < 0) {
183 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH (v2)\n",
184 dev->devnum, iface, fmt->altsetting);
192 * initialize the pitch control and sample rate
194 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
195 struct usb_host_interface *alts,
196 struct audioformat *fmt)
198 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
200 /* if endpoint doesn't have pitch control, bail out */
201 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
204 switch (altsd->bInterfaceProtocol) {
207 return init_pitch_v1(chip, iface, alts, fmt);
210 return init_pitch_v2(chip, iface, alts, fmt);
214 static int start_endpoints(struct snd_usb_substream *subs, int can_sleep)
218 if (!subs->data_endpoint)
221 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
222 struct snd_usb_endpoint *ep = subs->data_endpoint;
224 snd_printdd(KERN_DEBUG "Starting data EP @%p\n", ep);
226 ep->data_subs = subs;
227 err = snd_usb_endpoint_start(ep, can_sleep);
229 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
234 if (subs->sync_endpoint &&
235 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
236 struct snd_usb_endpoint *ep = subs->sync_endpoint;
238 if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
239 subs->data_endpoint->alt_idx != subs->sync_endpoint->alt_idx) {
240 err = usb_set_interface(subs->dev,
241 subs->sync_endpoint->iface,
242 subs->sync_endpoint->alt_idx);
245 "%d:%d:%d: cannot set interface (%d)\n",
247 subs->sync_endpoint->iface,
248 subs->sync_endpoint->alt_idx, err);
253 snd_printdd(KERN_DEBUG "Starting sync EP @%p\n", ep);
255 ep->sync_slave = subs->data_endpoint;
256 err = snd_usb_endpoint_start(ep, can_sleep);
258 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
266 static void stop_endpoints(struct snd_usb_substream *subs,
267 int force, int can_sleep, int wait)
269 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
270 snd_usb_endpoint_stop(subs->sync_endpoint,
271 force, can_sleep, wait);
273 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
274 snd_usb_endpoint_stop(subs->data_endpoint,
275 force, can_sleep, wait);
278 static int deactivate_endpoints(struct snd_usb_substream *subs)
282 reta = snd_usb_endpoint_deactivate(subs->sync_endpoint);
283 retb = snd_usb_endpoint_deactivate(subs->data_endpoint);
295 * find a matching format and set up the interface
297 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
299 struct usb_device *dev = subs->dev;
300 struct usb_host_interface *alts;
301 struct usb_interface_descriptor *altsd;
302 struct usb_interface *iface;
303 unsigned int ep, attr;
304 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
305 int err, implicit_fb = 0;
307 iface = usb_ifnum_to_if(dev, fmt->iface);
310 alts = &iface->altsetting[fmt->altset_idx];
311 altsd = get_iface_desc(alts);
312 if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
315 if (fmt == subs->cur_audiofmt)
318 /* close the old interface */
319 if (subs->interface >= 0 && subs->interface != fmt->iface) {
320 err = usb_set_interface(subs->dev, subs->interface, 0);
322 snd_printk(KERN_ERR "%d:%d:%d: return to setting 0 failed (%d)\n",
323 dev->devnum, fmt->iface, fmt->altsetting, err);
326 subs->interface = -1;
327 subs->altset_idx = 0;
331 if (subs->interface != fmt->iface ||
332 subs->altset_idx != fmt->altset_idx) {
333 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
335 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed (%d)\n",
336 dev->devnum, fmt->iface, fmt->altsetting, err);
339 snd_printdd(KERN_INFO "setting usb interface %d:%d\n",
340 fmt->iface, fmt->altsetting);
341 subs->interface = fmt->iface;
342 subs->altset_idx = fmt->altset_idx;
345 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
346 alts, fmt->endpoint, subs->direction,
347 SND_USB_ENDPOINT_TYPE_DATA);
348 if (!subs->data_endpoint)
351 /* we need a sync pipe in async OUT or adaptive IN mode */
352 /* check the number of EP, since some devices have broken
353 * descriptors which fool us. if it has only one EP,
354 * assume it as adaptive-out or sync-in.
356 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
358 switch (subs->stream->chip->usb_id) {
359 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
360 case USB_ID(0x0763, 0x2081):
364 iface = usb_ifnum_to_if(dev, 2);
366 if (!iface || iface->num_altsetting == 0)
369 alts = &iface->altsetting[1];
374 if (((is_playback && attr == USB_ENDPOINT_SYNC_ASYNC) ||
375 (!is_playback && attr == USB_ENDPOINT_SYNC_ADAPTIVE)) &&
376 altsd->bNumEndpoints >= 2) {
377 /* check sync-pipe endpoint */
378 /* ... and check descriptor size before accessing bSynchAddress
379 because there is a version of the SB Audigy 2 NX firmware lacking
380 the audio fields in the endpoint descriptors */
381 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
382 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
383 get_endpoint(alts, 1)->bSynchAddress != 0 &&
385 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
386 dev->devnum, fmt->iface, fmt->altsetting,
387 get_endpoint(alts, 1)->bmAttributes,
388 get_endpoint(alts, 1)->bLength,
389 get_endpoint(alts, 1)->bSynchAddress);
392 ep = get_endpoint(alts, 1)->bEndpointAddress;
394 get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
395 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
396 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
397 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
398 dev->devnum, fmt->iface, fmt->altsetting,
399 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
403 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
404 == USB_ENDPOINT_USAGE_IMPLICIT_FB;
407 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
408 alts, ep, !subs->direction,
410 SND_USB_ENDPOINT_TYPE_DATA :
411 SND_USB_ENDPOINT_TYPE_SYNC);
412 if (!subs->sync_endpoint)
415 subs->data_endpoint->sync_master = subs->sync_endpoint;
418 if ((err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt)) < 0)
421 subs->cur_audiofmt = fmt;
423 snd_usb_set_format_quirk(subs, fmt);
427 "setting done: format = %d, rate = %d..%d, channels = %d\n",
428 fmt->format, fmt->rate_min, fmt->rate_max, fmt->channels);
430 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
431 subs->datapipe, subs->syncpipe);
438 * configure endpoint params
440 * called during initial setup and upon resume
442 static int configure_endpoint(struct snd_usb_substream *subs)
447 stop_endpoints(subs, 0, 0, 0);
448 ret = snd_usb_endpoint_set_params(subs->data_endpoint,
454 subs->sync_endpoint);
458 if (subs->sync_endpoint)
459 ret = snd_usb_endpoint_set_params(subs->data_endpoint,
472 * allocate a buffer and set the given audio format.
474 * so far we use a physically linear buffer although packetize transfer
475 * doesn't need a continuous area.
476 * if sg buffer is supported on the later version of alsa, we'll follow
479 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
480 struct snd_pcm_hw_params *hw_params)
482 struct snd_usb_substream *subs = substream->runtime->private_data;
483 struct audioformat *fmt;
486 ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
487 params_buffer_bytes(hw_params));
491 subs->pcm_format = params_format(hw_params);
492 subs->period_bytes = params_period_bytes(hw_params);
493 subs->channels = params_channels(hw_params);
494 subs->cur_rate = params_rate(hw_params);
496 fmt = find_format(subs);
498 snd_printd(KERN_DEBUG "cannot set format: format = %#x, rate = %d, channels = %d\n",
499 subs->pcm_format, subs->cur_rate, subs->channels);
503 down_read(&subs->stream->chip->shutdown_rwsem);
504 if (subs->stream->chip->shutdown)
507 ret = set_format(subs, fmt);
508 up_read(&subs->stream->chip->shutdown_rwsem);
512 subs->interface = fmt->iface;
513 subs->altset_idx = fmt->altset_idx;
514 subs->need_setup_ep = true;
522 * reset the audio format and release the buffer
524 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
526 struct snd_usb_substream *subs = substream->runtime->private_data;
528 subs->cur_audiofmt = NULL;
530 subs->period_bytes = 0;
531 down_read(&subs->stream->chip->shutdown_rwsem);
532 if (!subs->stream->chip->shutdown) {
533 stop_endpoints(subs, 0, 1, 1);
534 deactivate_endpoints(subs);
536 up_read(&subs->stream->chip->shutdown_rwsem);
537 return snd_pcm_lib_free_vmalloc_buffer(substream);
543 * only a few subtle things...
545 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
547 struct snd_pcm_runtime *runtime = substream->runtime;
548 struct snd_usb_substream *subs = runtime->private_data;
549 struct usb_host_interface *alts;
550 struct usb_interface *iface;
553 if (! subs->cur_audiofmt) {
554 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
558 down_read(&subs->stream->chip->shutdown_rwsem);
559 if (subs->stream->chip->shutdown) {
563 if (snd_BUG_ON(!subs->data_endpoint)) {
568 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
569 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
571 ret = set_format(subs, subs->cur_audiofmt);
575 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
576 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
577 ret = snd_usb_init_sample_rate(subs->stream->chip,
578 subs->cur_audiofmt->iface,
585 if (subs->need_setup_ep) {
586 ret = configure_endpoint(subs);
589 subs->need_setup_ep = false;
592 /* some unit conversions in runtime */
593 subs->data_endpoint->maxframesize =
594 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
595 subs->data_endpoint->curframesize =
596 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
598 /* reset the pointer */
599 subs->hwptr_done = 0;
600 subs->transfer_done = 0;
601 subs->last_delay = 0;
602 subs->last_frame_number = 0;
605 /* for playback, submit the URBs now; otherwise, the first hwptr_done
606 * updates for all URBs would happen at the same time when starting */
607 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
608 ret = start_endpoints(subs, 1);
611 up_read(&subs->stream->chip->shutdown_rwsem);
615 static struct snd_pcm_hardware snd_usb_hardware =
617 .info = SNDRV_PCM_INFO_MMAP |
618 SNDRV_PCM_INFO_MMAP_VALID |
619 SNDRV_PCM_INFO_BATCH |
620 SNDRV_PCM_INFO_INTERLEAVED |
621 SNDRV_PCM_INFO_BLOCK_TRANSFER |
622 SNDRV_PCM_INFO_PAUSE,
623 .buffer_bytes_max = 1024 * 1024,
624 .period_bytes_min = 64,
625 .period_bytes_max = 512 * 1024,
630 static int hw_check_valid_format(struct snd_usb_substream *subs,
631 struct snd_pcm_hw_params *params,
632 struct audioformat *fp)
634 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
635 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
636 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
637 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
638 struct snd_mask check_fmts;
641 /* check the format */
642 snd_mask_none(&check_fmts);
643 check_fmts.bits[0] = (u32)fp->formats;
644 check_fmts.bits[1] = (u32)(fp->formats >> 32);
645 snd_mask_intersect(&check_fmts, fmts);
646 if (snd_mask_empty(&check_fmts)) {
647 hwc_debug(" > check: no supported format %d\n", fp->format);
650 /* check the channels */
651 if (fp->channels < ct->min || fp->channels > ct->max) {
652 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
655 /* check the rate is within the range */
656 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
657 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
660 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
661 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
664 /* check whether the period time is >= the data packet interval */
665 if (subs->speed != USB_SPEED_FULL) {
666 ptime = 125 * (1 << fp->datainterval);
667 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
668 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
675 static int hw_rule_rate(struct snd_pcm_hw_params *params,
676 struct snd_pcm_hw_rule *rule)
678 struct snd_usb_substream *subs = rule->private;
680 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
681 unsigned int rmin, rmax;
684 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
687 list_for_each(p, &subs->fmt_list) {
688 struct audioformat *fp;
689 fp = list_entry(p, struct audioformat, list);
690 if (!hw_check_valid_format(subs, params, fp))
693 if (rmin > fp->rate_min)
695 if (rmax < fp->rate_max)
704 hwc_debug(" --> get empty\n");
710 if (it->min < rmin) {
715 if (it->max > rmax) {
720 if (snd_interval_checkempty(it)) {
724 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
729 static int hw_rule_channels(struct snd_pcm_hw_params *params,
730 struct snd_pcm_hw_rule *rule)
732 struct snd_usb_substream *subs = rule->private;
734 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
735 unsigned int rmin, rmax;
738 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
741 list_for_each(p, &subs->fmt_list) {
742 struct audioformat *fp;
743 fp = list_entry(p, struct audioformat, list);
744 if (!hw_check_valid_format(subs, params, fp))
747 if (rmin > fp->channels)
749 if (rmax < fp->channels)
758 hwc_debug(" --> get empty\n");
764 if (it->min < rmin) {
769 if (it->max > rmax) {
774 if (snd_interval_checkempty(it)) {
778 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
782 static int hw_rule_format(struct snd_pcm_hw_params *params,
783 struct snd_pcm_hw_rule *rule)
785 struct snd_usb_substream *subs = rule->private;
787 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
792 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
794 list_for_each(p, &subs->fmt_list) {
795 struct audioformat *fp;
796 fp = list_entry(p, struct audioformat, list);
797 if (!hw_check_valid_format(subs, params, fp))
799 fbits |= fp->formats;
802 oldbits[0] = fmt->bits[0];
803 oldbits[1] = fmt->bits[1];
804 fmt->bits[0] &= (u32)fbits;
805 fmt->bits[1] &= (u32)(fbits >> 32);
806 if (!fmt->bits[0] && !fmt->bits[1]) {
807 hwc_debug(" --> get empty\n");
810 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
811 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
815 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
816 struct snd_pcm_hw_rule *rule)
818 struct snd_usb_substream *subs = rule->private;
819 struct audioformat *fp;
820 struct snd_interval *it;
821 unsigned char min_datainterval;
825 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
826 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
827 min_datainterval = 0xff;
828 list_for_each_entry(fp, &subs->fmt_list, list) {
829 if (!hw_check_valid_format(subs, params, fp))
831 min_datainterval = min(min_datainterval, fp->datainterval);
833 if (min_datainterval == 0xff) {
834 hwc_debug(" --> get empty\n");
838 pmin = 125 * (1 << min_datainterval);
840 if (it->min < pmin) {
845 if (snd_interval_checkempty(it)) {
849 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
854 * If the device supports unusual bit rates, does the request meet these?
856 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
857 struct snd_usb_substream *subs)
859 struct audioformat *fp;
861 int count = 0, needs_knot = 0;
864 kfree(subs->rate_list.list);
865 subs->rate_list.list = NULL;
867 list_for_each_entry(fp, &subs->fmt_list, list) {
868 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
870 count += fp->nr_rates;
871 if (fp->rates & SNDRV_PCM_RATE_KNOT)
877 subs->rate_list.list = rate_list =
878 kmalloc(sizeof(int) * count, GFP_KERNEL);
879 if (!subs->rate_list.list)
881 subs->rate_list.count = count;
882 subs->rate_list.mask = 0;
884 list_for_each_entry(fp, &subs->fmt_list, list) {
886 for (i = 0; i < fp->nr_rates; i++)
887 rate_list[count++] = fp->rate_table[i];
889 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
899 * set up the runtime hardware information.
902 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
905 unsigned int pt, ptmin;
906 int param_period_time_if_needed;
909 runtime->hw.formats = subs->formats;
911 runtime->hw.rate_min = 0x7fffffff;
912 runtime->hw.rate_max = 0;
913 runtime->hw.channels_min = 256;
914 runtime->hw.channels_max = 0;
915 runtime->hw.rates = 0;
917 /* check min/max rates and channels */
918 list_for_each(p, &subs->fmt_list) {
919 struct audioformat *fp;
920 fp = list_entry(p, struct audioformat, list);
921 runtime->hw.rates |= fp->rates;
922 if (runtime->hw.rate_min > fp->rate_min)
923 runtime->hw.rate_min = fp->rate_min;
924 if (runtime->hw.rate_max < fp->rate_max)
925 runtime->hw.rate_max = fp->rate_max;
926 if (runtime->hw.channels_min > fp->channels)
927 runtime->hw.channels_min = fp->channels;
928 if (runtime->hw.channels_max < fp->channels)
929 runtime->hw.channels_max = fp->channels;
930 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
931 /* FIXME: there might be more than one audio formats... */
932 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
935 pt = 125 * (1 << fp->datainterval);
936 ptmin = min(ptmin, pt);
938 err = snd_usb_autoresume(subs->stream->chip);
942 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
943 if (subs->speed == USB_SPEED_FULL)
944 /* full speed devices have fixed data packet interval */
947 /* if period time doesn't go below 1 ms, no rules needed */
948 param_period_time_if_needed = -1;
949 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
952 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
954 SNDRV_PCM_HW_PARAM_FORMAT,
955 SNDRV_PCM_HW_PARAM_CHANNELS,
956 param_period_time_if_needed,
959 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
960 hw_rule_channels, subs,
961 SNDRV_PCM_HW_PARAM_FORMAT,
962 SNDRV_PCM_HW_PARAM_RATE,
963 param_period_time_if_needed,
966 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
967 hw_rule_format, subs,
968 SNDRV_PCM_HW_PARAM_RATE,
969 SNDRV_PCM_HW_PARAM_CHANNELS,
970 param_period_time_if_needed,
973 if (param_period_time_if_needed >= 0) {
974 err = snd_pcm_hw_rule_add(runtime, 0,
975 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
976 hw_rule_period_time, subs,
977 SNDRV_PCM_HW_PARAM_FORMAT,
978 SNDRV_PCM_HW_PARAM_CHANNELS,
979 SNDRV_PCM_HW_PARAM_RATE,
984 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
989 snd_usb_autosuspend(subs->stream->chip);
993 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
995 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
996 struct snd_pcm_runtime *runtime = substream->runtime;
997 struct snd_usb_substream *subs = &as->substream[direction];
999 subs->interface = -1;
1000 subs->altset_idx = 0;
1001 runtime->hw = snd_usb_hardware;
1002 runtime->private_data = subs;
1003 subs->pcm_substream = substream;
1004 /* runtime PM is also done there */
1005 return setup_hw_info(runtime, subs);
1008 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1010 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1011 struct snd_usb_substream *subs = &as->substream[direction];
1013 stop_endpoints(subs, 0, 0, 0);
1015 if (!as->chip->shutdown && subs->interface >= 0) {
1016 usb_set_interface(subs->dev, subs->interface, 0);
1017 subs->interface = -1;
1020 subs->pcm_substream = NULL;
1021 snd_usb_autosuspend(subs->stream->chip);
1026 /* Since a URB can handle only a single linear buffer, we must use double
1027 * buffering when the data to be transferred overflows the buffer boundary.
1028 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1031 static void retire_capture_urb(struct snd_usb_substream *subs,
1034 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1035 unsigned int stride, frames, bytes, oldptr;
1036 int i, period_elapsed = 0;
1037 unsigned long flags;
1040 stride = runtime->frame_bits >> 3;
1042 for (i = 0; i < urb->number_of_packets; i++) {
1043 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
1044 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1045 snd_printdd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
1048 bytes = urb->iso_frame_desc[i].actual_length;
1049 frames = bytes / stride;
1050 if (!subs->txfr_quirk)
1051 bytes = frames * stride;
1052 if (bytes % (runtime->sample_bits >> 3) != 0) {
1053 #ifdef CONFIG_SND_DEBUG_VERBOSE
1054 int oldbytes = bytes;
1056 bytes = frames * stride;
1057 snd_printdd(KERN_ERR "Corrected urb data len. %d->%d\n",
1060 /* update the current pointer */
1061 spin_lock_irqsave(&subs->lock, flags);
1062 oldptr = subs->hwptr_done;
1063 subs->hwptr_done += bytes;
1064 if (subs->hwptr_done >= runtime->buffer_size * stride)
1065 subs->hwptr_done -= runtime->buffer_size * stride;
1066 frames = (bytes + (oldptr % stride)) / stride;
1067 subs->transfer_done += frames;
1068 if (subs->transfer_done >= runtime->period_size) {
1069 subs->transfer_done -= runtime->period_size;
1072 spin_unlock_irqrestore(&subs->lock, flags);
1073 /* copy a data chunk */
1074 if (oldptr + bytes > runtime->buffer_size * stride) {
1075 unsigned int bytes1 =
1076 runtime->buffer_size * stride - oldptr;
1077 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1078 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1080 memcpy(runtime->dma_area + oldptr, cp, bytes);
1085 snd_pcm_period_elapsed(subs->pcm_substream);
1088 static void prepare_playback_urb(struct snd_usb_substream *subs,
1091 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1092 struct snd_usb_endpoint *ep = subs->data_endpoint;
1093 struct snd_urb_ctx *ctx = urb->context;
1094 unsigned int counts, frames, bytes;
1095 int i, stride, period_elapsed = 0;
1096 unsigned long flags;
1098 stride = runtime->frame_bits >> 3;
1101 urb->number_of_packets = 0;
1102 spin_lock_irqsave(&subs->lock, flags);
1103 for (i = 0; i < ctx->packets; i++) {
1104 if (ctx->packet_size[i])
1105 counts = ctx->packet_size[i];
1107 counts = snd_usb_endpoint_next_packet_size(ep);
1109 /* set up descriptor */
1110 urb->iso_frame_desc[i].offset = frames * stride;
1111 urb->iso_frame_desc[i].length = counts * stride;
1113 urb->number_of_packets++;
1114 subs->transfer_done += counts;
1115 if (subs->transfer_done >= runtime->period_size) {
1116 subs->transfer_done -= runtime->period_size;
1118 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1119 if (subs->transfer_done > 0) {
1120 /* FIXME: fill-max mode is not
1122 frames -= subs->transfer_done;
1123 counts -= subs->transfer_done;
1124 urb->iso_frame_desc[i].length =
1126 subs->transfer_done = 0;
1129 if (i < ctx->packets) {
1130 /* add a transfer delimiter */
1131 urb->iso_frame_desc[i].offset =
1133 urb->iso_frame_desc[i].length = 0;
1134 urb->number_of_packets++;
1139 if (period_elapsed &&
1140 !snd_usb_endpoint_implict_feedback_sink(subs->data_endpoint)) /* finish at the period boundary */
1143 bytes = frames * stride;
1144 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1145 /* err, the transferred area goes over buffer boundary. */
1146 unsigned int bytes1 =
1147 runtime->buffer_size * stride - subs->hwptr_done;
1148 memcpy(urb->transfer_buffer,
1149 runtime->dma_area + subs->hwptr_done, bytes1);
1150 memcpy(urb->transfer_buffer + bytes1,
1151 runtime->dma_area, bytes - bytes1);
1153 memcpy(urb->transfer_buffer,
1154 runtime->dma_area + subs->hwptr_done, bytes);
1156 subs->hwptr_done += bytes;
1157 if (subs->hwptr_done >= runtime->buffer_size * stride)
1158 subs->hwptr_done -= runtime->buffer_size * stride;
1160 /* update delay with exact number of samples queued */
1161 runtime->delay = subs->last_delay;
1162 runtime->delay += frames;
1163 subs->last_delay = runtime->delay;
1165 /* realign last_frame_number */
1166 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1167 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1169 spin_unlock_irqrestore(&subs->lock, flags);
1170 urb->transfer_buffer_length = bytes;
1172 snd_pcm_period_elapsed(subs->pcm_substream);
1176 * process after playback data complete
1177 * - decrease the delay count again
1179 static void retire_playback_urb(struct snd_usb_substream *subs,
1182 unsigned long flags;
1183 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1184 int stride = runtime->frame_bits >> 3;
1185 int processed = urb->transfer_buffer_length / stride;
1188 /* ignore the delay accounting when procssed=0 is given, i.e.
1189 * silent payloads are procssed before handling the actual data
1194 spin_lock_irqsave(&subs->lock, flags);
1195 est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1196 /* update delay with exact number of samples played */
1197 if (processed > subs->last_delay)
1198 subs->last_delay = 0;
1200 subs->last_delay -= processed;
1201 runtime->delay = subs->last_delay;
1204 * Report when delay estimate is off by more than 2ms.
1205 * The error should be lower than 2ms since the estimate relies
1206 * on two reads of a counter updated every ms.
1208 if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1209 snd_printk(KERN_DEBUG "delay: estimated %d, actual %d\n",
1210 est_delay, subs->last_delay);
1212 spin_unlock_irqrestore(&subs->lock, flags);
1215 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1217 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1220 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1222 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1225 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1227 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1230 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1232 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1235 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1238 struct snd_usb_substream *subs = substream->runtime->private_data;
1241 case SNDRV_PCM_TRIGGER_START:
1242 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1243 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1244 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1247 case SNDRV_PCM_TRIGGER_STOP:
1248 stop_endpoints(subs, 0, 0, 0);
1251 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1252 subs->data_endpoint->prepare_data_urb = NULL;
1253 subs->data_endpoint->retire_data_urb = NULL;
1261 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1265 struct snd_usb_substream *subs = substream->runtime->private_data;
1268 case SNDRV_PCM_TRIGGER_START:
1269 err = start_endpoints(subs, 0);
1273 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1276 case SNDRV_PCM_TRIGGER_STOP:
1277 stop_endpoints(subs, 0, 0, 0);
1280 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1281 subs->data_endpoint->retire_data_urb = NULL;
1284 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1285 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1293 static struct snd_pcm_ops snd_usb_playback_ops = {
1294 .open = snd_usb_playback_open,
1295 .close = snd_usb_playback_close,
1296 .ioctl = snd_pcm_lib_ioctl,
1297 .hw_params = snd_usb_hw_params,
1298 .hw_free = snd_usb_hw_free,
1299 .prepare = snd_usb_pcm_prepare,
1300 .trigger = snd_usb_substream_playback_trigger,
1301 .pointer = snd_usb_pcm_pointer,
1302 .page = snd_pcm_lib_get_vmalloc_page,
1303 .mmap = snd_pcm_lib_mmap_vmalloc,
1306 static struct snd_pcm_ops snd_usb_capture_ops = {
1307 .open = snd_usb_capture_open,
1308 .close = snd_usb_capture_close,
1309 .ioctl = snd_pcm_lib_ioctl,
1310 .hw_params = snd_usb_hw_params,
1311 .hw_free = snd_usb_hw_free,
1312 .prepare = snd_usb_pcm_prepare,
1313 .trigger = snd_usb_substream_capture_trigger,
1314 .pointer = snd_usb_pcm_pointer,
1315 .page = snd_pcm_lib_get_vmalloc_page,
1316 .mmap = snd_pcm_lib_mmap_vmalloc,
1319 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1321 snd_pcm_set_ops(pcm, stream,
1322 stream == SNDRV_PCM_STREAM_PLAYBACK ?
1323 &snd_usb_playback_ops : &snd_usb_capture_ops);