ixgbe: fix RAR entry counting for generic and fdb_add()
[linux-2.6/cjktty.git] / sound / usb / pcm.c
bloba1298f379428280045bf661f89e5fa59bb0acb48
1 /*
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>
28 #include "usbaudio.h"
29 #include "card.h"
30 #include "quirks.h"
31 #include "debug.h"
32 #include "endpoint.h"
33 #include "helper.h"
34 #include "pcm.h"
35 #include "clock.h"
36 #include "power.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,
43 unsigned int rate)
45 int current_frame_number;
46 int frame_diff;
47 int est_delay;
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
53 * enough
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);
60 if (est_delay < 0)
61 est_delay = 0;
62 return est_delay;
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 spin_lock(&subs->lock);
75 hwptr_done = subs->hwptr_done;
76 substream->runtime->delay = snd_usb_pcm_delay(subs,
77 substream->runtime->rate);
78 spin_unlock(&subs->lock);
79 return hwptr_done / (substream->runtime->frame_bits >> 3);
83 * find a matching audio format
85 static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
86 unsigned int rate, unsigned int channels)
88 struct list_head *p;
89 struct audioformat *found = NULL;
90 int cur_attr = 0, attr;
92 list_for_each(p, &subs->fmt_list) {
93 struct audioformat *fp;
94 fp = list_entry(p, struct audioformat, list);
95 if (!(fp->formats & (1uLL << format)))
96 continue;
97 if (fp->channels != channels)
98 continue;
99 if (rate < fp->rate_min || rate > fp->rate_max)
100 continue;
101 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
102 unsigned int i;
103 for (i = 0; i < fp->nr_rates; i++)
104 if (fp->rate_table[i] == rate)
105 break;
106 if (i >= fp->nr_rates)
107 continue;
109 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
110 if (! found) {
111 found = fp;
112 cur_attr = attr;
113 continue;
115 /* avoid async out and adaptive in if the other method
116 * supports the same format.
117 * this is a workaround for the case like
118 * M-audio audiophile USB.
120 if (attr != cur_attr) {
121 if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
122 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
123 (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
124 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
125 continue;
126 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
127 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
128 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
129 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
130 found = fp;
131 cur_attr = attr;
132 continue;
135 /* find the format with the largest max. packet size */
136 if (fp->maxpacksize > found->maxpacksize) {
137 found = fp;
138 cur_attr = attr;
141 return found;
144 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
145 struct usb_host_interface *alts,
146 struct audioformat *fmt)
148 struct usb_device *dev = chip->dev;
149 unsigned int ep;
150 unsigned char data[1];
151 int err;
153 ep = get_endpoint(alts, 0)->bEndpointAddress;
155 data[0] = 1;
156 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
157 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
158 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
159 data, sizeof(data))) < 0) {
160 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
161 dev->devnum, iface, ep);
162 return err;
165 return 0;
168 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
169 struct usb_host_interface *alts,
170 struct audioformat *fmt)
172 struct usb_device *dev = chip->dev;
173 unsigned char data[1];
174 unsigned int ep;
175 int err;
177 ep = get_endpoint(alts, 0)->bEndpointAddress;
179 data[0] = 1;
180 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
181 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
182 UAC2_EP_CS_PITCH << 8, 0,
183 data, sizeof(data))) < 0) {
184 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH (v2)\n",
185 dev->devnum, iface, fmt->altsetting);
186 return err;
189 return 0;
193 * initialize the pitch control and sample rate
195 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
196 struct usb_host_interface *alts,
197 struct audioformat *fmt)
199 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
201 /* if endpoint doesn't have pitch control, bail out */
202 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
203 return 0;
205 switch (altsd->bInterfaceProtocol) {
206 case UAC_VERSION_1:
207 default:
208 return init_pitch_v1(chip, iface, alts, fmt);
210 case UAC_VERSION_2:
211 return init_pitch_v2(chip, iface, alts, fmt);
215 static int start_endpoints(struct snd_usb_substream *subs)
217 int err;
219 if (!subs->data_endpoint)
220 return -EINVAL;
222 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
223 struct snd_usb_endpoint *ep = subs->data_endpoint;
225 snd_printdd(KERN_DEBUG "Starting data EP @%p\n", ep);
227 ep->data_subs = subs;
228 err = snd_usb_endpoint_start(ep);
229 if (err < 0) {
230 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
231 return err;
235 if (subs->sync_endpoint &&
236 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
237 struct snd_usb_endpoint *ep = subs->sync_endpoint;
239 snd_printdd(KERN_DEBUG "Starting sync EP @%p\n", ep);
241 ep->sync_slave = subs->data_endpoint;
242 err = snd_usb_endpoint_start(ep);
243 if (err < 0) {
244 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
245 return err;
249 return 0;
252 static void stop_endpoints(struct snd_usb_substream *subs,
253 int force, int can_sleep, int wait)
255 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
256 snd_usb_endpoint_stop(subs->sync_endpoint,
257 force, can_sleep, wait);
259 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
260 snd_usb_endpoint_stop(subs->data_endpoint,
261 force, can_sleep, wait);
264 static int deactivate_endpoints(struct snd_usb_substream *subs)
266 int reta, retb;
268 reta = snd_usb_endpoint_deactivate(subs->sync_endpoint);
269 retb = snd_usb_endpoint_deactivate(subs->data_endpoint);
271 if (reta < 0)
272 return reta;
274 if (retb < 0)
275 return retb;
277 return 0;
281 * find a matching format and set up the interface
283 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
285 struct usb_device *dev = subs->dev;
286 struct usb_host_interface *alts;
287 struct usb_interface_descriptor *altsd;
288 struct usb_interface *iface;
289 unsigned int ep, attr;
290 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
291 int err, implicit_fb = 0;
293 iface = usb_ifnum_to_if(dev, fmt->iface);
294 if (WARN_ON(!iface))
295 return -EINVAL;
296 alts = &iface->altsetting[fmt->altset_idx];
297 altsd = get_iface_desc(alts);
298 if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
299 return -EINVAL;
301 if (fmt == subs->cur_audiofmt)
302 return 0;
304 /* close the old interface */
305 if (subs->interface >= 0 && subs->interface != fmt->iface) {
306 err = usb_set_interface(subs->dev, subs->interface, 0);
307 if (err < 0) {
308 snd_printk(KERN_ERR "%d:%d:%d: return to setting 0 failed (%d)\n",
309 dev->devnum, fmt->iface, fmt->altsetting, err);
310 return -EIO;
312 subs->interface = -1;
313 subs->altset_idx = 0;
316 /* set interface */
317 if (subs->interface != fmt->iface ||
318 subs->altset_idx != fmt->altset_idx) {
319 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
320 if (err < 0) {
321 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed (%d)\n",
322 dev->devnum, fmt->iface, fmt->altsetting, err);
323 return -EIO;
325 snd_printdd(KERN_INFO "setting usb interface %d:%d\n",
326 fmt->iface, fmt->altsetting);
327 subs->interface = fmt->iface;
328 subs->altset_idx = fmt->altset_idx;
331 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
332 alts, fmt->endpoint, subs->direction,
333 SND_USB_ENDPOINT_TYPE_DATA);
334 if (!subs->data_endpoint)
335 return -EINVAL;
337 /* we need a sync pipe in async OUT or adaptive IN mode */
338 /* check the number of EP, since some devices have broken
339 * descriptors which fool us. if it has only one EP,
340 * assume it as adaptive-out or sync-in.
342 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
344 switch (subs->stream->chip->usb_id) {
345 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
346 case USB_ID(0x0763, 0x2081):
347 if (is_playback) {
348 implicit_fb = 1;
349 ep = 0x81;
350 iface = usb_ifnum_to_if(dev, 2);
352 if (!iface || iface->num_altsetting == 0)
353 return -EINVAL;
355 alts = &iface->altsetting[1];
356 goto add_sync_ep;
360 if (((is_playback && attr == USB_ENDPOINT_SYNC_ASYNC) ||
361 (!is_playback && attr == USB_ENDPOINT_SYNC_ADAPTIVE)) &&
362 altsd->bNumEndpoints >= 2) {
363 /* check sync-pipe endpoint */
364 /* ... and check descriptor size before accessing bSynchAddress
365 because there is a version of the SB Audigy 2 NX firmware lacking
366 the audio fields in the endpoint descriptors */
367 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
368 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
369 get_endpoint(alts, 1)->bSynchAddress != 0 &&
370 !implicit_fb)) {
371 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
372 dev->devnum, fmt->iface, fmt->altsetting,
373 get_endpoint(alts, 1)->bmAttributes,
374 get_endpoint(alts, 1)->bLength,
375 get_endpoint(alts, 1)->bSynchAddress);
376 return -EINVAL;
378 ep = get_endpoint(alts, 1)->bEndpointAddress;
379 if (!implicit_fb &&
380 get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
381 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
382 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
383 snd_printk(KERN_ERR "%d:%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
384 dev->devnum, fmt->iface, fmt->altsetting,
385 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
386 return -EINVAL;
389 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
390 == USB_ENDPOINT_USAGE_IMPLICIT_FB;
392 add_sync_ep:
393 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
394 alts, ep, !subs->direction,
395 implicit_fb ?
396 SND_USB_ENDPOINT_TYPE_DATA :
397 SND_USB_ENDPOINT_TYPE_SYNC);
398 if (!subs->sync_endpoint)
399 return -EINVAL;
401 subs->data_endpoint->sync_master = subs->sync_endpoint;
404 if ((err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt)) < 0)
405 return err;
407 subs->cur_audiofmt = fmt;
409 snd_usb_set_format_quirk(subs, fmt);
411 #if 0
412 printk(KERN_DEBUG
413 "setting done: format = %d, rate = %d..%d, channels = %d\n",
414 fmt->format, fmt->rate_min, fmt->rate_max, fmt->channels);
415 printk(KERN_DEBUG
416 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
417 subs->datapipe, subs->syncpipe);
418 #endif
420 return 0;
424 * hw_params callback
426 * allocate a buffer and set the given audio format.
428 * so far we use a physically linear buffer although packetize transfer
429 * doesn't need a continuous area.
430 * if sg buffer is supported on the later version of alsa, we'll follow
431 * that.
433 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
434 struct snd_pcm_hw_params *hw_params)
436 struct snd_usb_substream *subs = substream->runtime->private_data;
437 struct audioformat *fmt;
438 unsigned int channels, rate, format;
439 int ret, changed;
441 ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
442 params_buffer_bytes(hw_params));
443 if (ret < 0)
444 return ret;
446 format = params_format(hw_params);
447 rate = params_rate(hw_params);
448 channels = params_channels(hw_params);
449 fmt = find_format(subs, format, rate, channels);
450 if (!fmt) {
451 snd_printd(KERN_DEBUG "cannot set format: format = %#x, rate = %d, channels = %d\n",
452 format, rate, channels);
453 return -EINVAL;
456 changed = subs->cur_audiofmt != fmt ||
457 subs->period_bytes != params_period_bytes(hw_params) ||
458 subs->cur_rate != rate;
459 if ((ret = set_format(subs, fmt)) < 0)
460 return ret;
462 if (subs->cur_rate != rate) {
463 struct usb_host_interface *alts;
464 struct usb_interface *iface;
465 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
466 alts = &iface->altsetting[fmt->altset_idx];
467 ret = snd_usb_init_sample_rate(subs->stream->chip, fmt->iface, alts, fmt, rate);
468 if (ret < 0)
469 return ret;
470 subs->cur_rate = rate;
473 if (changed) {
474 mutex_lock(&subs->stream->chip->shutdown_mutex);
475 /* format changed */
476 stop_endpoints(subs, 0, 0, 0);
477 ret = snd_usb_endpoint_set_params(subs->data_endpoint, hw_params, fmt,
478 subs->sync_endpoint);
479 if (ret < 0)
480 goto unlock;
482 if (subs->sync_endpoint)
483 ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
484 hw_params, fmt, NULL);
485 unlock:
486 mutex_unlock(&subs->stream->chip->shutdown_mutex);
489 if (ret == 0) {
490 subs->interface = fmt->iface;
491 subs->altset_idx = fmt->altset_idx;
494 return ret;
498 * hw_free callback
500 * reset the audio format and release the buffer
502 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
504 struct snd_usb_substream *subs = substream->runtime->private_data;
506 subs->cur_audiofmt = NULL;
507 subs->cur_rate = 0;
508 subs->period_bytes = 0;
509 mutex_lock(&subs->stream->chip->shutdown_mutex);
510 stop_endpoints(subs, 0, 1, 1);
511 deactivate_endpoints(subs);
512 mutex_unlock(&subs->stream->chip->shutdown_mutex);
513 return snd_pcm_lib_free_vmalloc_buffer(substream);
517 * prepare callback
519 * only a few subtle things...
521 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
523 struct snd_pcm_runtime *runtime = substream->runtime;
524 struct snd_usb_substream *subs = runtime->private_data;
526 if (! subs->cur_audiofmt) {
527 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
528 return -ENXIO;
531 if (snd_BUG_ON(!subs->data_endpoint))
532 return -EIO;
534 /* some unit conversions in runtime */
535 subs->data_endpoint->maxframesize =
536 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
537 subs->data_endpoint->curframesize =
538 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
540 /* reset the pointer */
541 subs->hwptr_done = 0;
542 subs->transfer_done = 0;
543 subs->last_delay = 0;
544 subs->last_frame_number = 0;
545 runtime->delay = 0;
547 /* for playback, submit the URBs now; otherwise, the first hwptr_done
548 * updates for all URBs would happen at the same time when starting */
549 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
550 return start_endpoints(subs);
552 return 0;
555 static struct snd_pcm_hardware snd_usb_hardware =
557 .info = SNDRV_PCM_INFO_MMAP |
558 SNDRV_PCM_INFO_MMAP_VALID |
559 SNDRV_PCM_INFO_BATCH |
560 SNDRV_PCM_INFO_INTERLEAVED |
561 SNDRV_PCM_INFO_BLOCK_TRANSFER |
562 SNDRV_PCM_INFO_PAUSE,
563 .buffer_bytes_max = 1024 * 1024,
564 .period_bytes_min = 64,
565 .period_bytes_max = 512 * 1024,
566 .periods_min = 2,
567 .periods_max = 1024,
570 static int hw_check_valid_format(struct snd_usb_substream *subs,
571 struct snd_pcm_hw_params *params,
572 struct audioformat *fp)
574 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
575 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
576 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
577 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
578 struct snd_mask check_fmts;
579 unsigned int ptime;
581 /* check the format */
582 snd_mask_none(&check_fmts);
583 check_fmts.bits[0] = (u32)fp->formats;
584 check_fmts.bits[1] = (u32)(fp->formats >> 32);
585 snd_mask_intersect(&check_fmts, fmts);
586 if (snd_mask_empty(&check_fmts)) {
587 hwc_debug(" > check: no supported format %d\n", fp->format);
588 return 0;
590 /* check the channels */
591 if (fp->channels < ct->min || fp->channels > ct->max) {
592 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
593 return 0;
595 /* check the rate is within the range */
596 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
597 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
598 return 0;
600 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
601 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
602 return 0;
604 /* check whether the period time is >= the data packet interval */
605 if (snd_usb_get_speed(subs->dev) != USB_SPEED_FULL) {
606 ptime = 125 * (1 << fp->datainterval);
607 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
608 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
609 return 0;
612 return 1;
615 static int hw_rule_rate(struct snd_pcm_hw_params *params,
616 struct snd_pcm_hw_rule *rule)
618 struct snd_usb_substream *subs = rule->private;
619 struct list_head *p;
620 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
621 unsigned int rmin, rmax;
622 int changed;
624 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
625 changed = 0;
626 rmin = rmax = 0;
627 list_for_each(p, &subs->fmt_list) {
628 struct audioformat *fp;
629 fp = list_entry(p, struct audioformat, list);
630 if (!hw_check_valid_format(subs, params, fp))
631 continue;
632 if (changed++) {
633 if (rmin > fp->rate_min)
634 rmin = fp->rate_min;
635 if (rmax < fp->rate_max)
636 rmax = fp->rate_max;
637 } else {
638 rmin = fp->rate_min;
639 rmax = fp->rate_max;
643 if (!changed) {
644 hwc_debug(" --> get empty\n");
645 it->empty = 1;
646 return -EINVAL;
649 changed = 0;
650 if (it->min < rmin) {
651 it->min = rmin;
652 it->openmin = 0;
653 changed = 1;
655 if (it->max > rmax) {
656 it->max = rmax;
657 it->openmax = 0;
658 changed = 1;
660 if (snd_interval_checkempty(it)) {
661 it->empty = 1;
662 return -EINVAL;
664 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
665 return changed;
669 static int hw_rule_channels(struct snd_pcm_hw_params *params,
670 struct snd_pcm_hw_rule *rule)
672 struct snd_usb_substream *subs = rule->private;
673 struct list_head *p;
674 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
675 unsigned int rmin, rmax;
676 int changed;
678 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
679 changed = 0;
680 rmin = rmax = 0;
681 list_for_each(p, &subs->fmt_list) {
682 struct audioformat *fp;
683 fp = list_entry(p, struct audioformat, list);
684 if (!hw_check_valid_format(subs, params, fp))
685 continue;
686 if (changed++) {
687 if (rmin > fp->channels)
688 rmin = fp->channels;
689 if (rmax < fp->channels)
690 rmax = fp->channels;
691 } else {
692 rmin = fp->channels;
693 rmax = fp->channels;
697 if (!changed) {
698 hwc_debug(" --> get empty\n");
699 it->empty = 1;
700 return -EINVAL;
703 changed = 0;
704 if (it->min < rmin) {
705 it->min = rmin;
706 it->openmin = 0;
707 changed = 1;
709 if (it->max > rmax) {
710 it->max = rmax;
711 it->openmax = 0;
712 changed = 1;
714 if (snd_interval_checkempty(it)) {
715 it->empty = 1;
716 return -EINVAL;
718 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
719 return changed;
722 static int hw_rule_format(struct snd_pcm_hw_params *params,
723 struct snd_pcm_hw_rule *rule)
725 struct snd_usb_substream *subs = rule->private;
726 struct list_head *p;
727 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
728 u64 fbits;
729 u32 oldbits[2];
730 int changed;
732 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
733 fbits = 0;
734 list_for_each(p, &subs->fmt_list) {
735 struct audioformat *fp;
736 fp = list_entry(p, struct audioformat, list);
737 if (!hw_check_valid_format(subs, params, fp))
738 continue;
739 fbits |= fp->formats;
742 oldbits[0] = fmt->bits[0];
743 oldbits[1] = fmt->bits[1];
744 fmt->bits[0] &= (u32)fbits;
745 fmt->bits[1] &= (u32)(fbits >> 32);
746 if (!fmt->bits[0] && !fmt->bits[1]) {
747 hwc_debug(" --> get empty\n");
748 return -EINVAL;
750 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
751 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
752 return changed;
755 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
756 struct snd_pcm_hw_rule *rule)
758 struct snd_usb_substream *subs = rule->private;
759 struct audioformat *fp;
760 struct snd_interval *it;
761 unsigned char min_datainterval;
762 unsigned int pmin;
763 int changed;
765 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
766 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
767 min_datainterval = 0xff;
768 list_for_each_entry(fp, &subs->fmt_list, list) {
769 if (!hw_check_valid_format(subs, params, fp))
770 continue;
771 min_datainterval = min(min_datainterval, fp->datainterval);
773 if (min_datainterval == 0xff) {
774 hwc_debug(" --> get empty\n");
775 it->empty = 1;
776 return -EINVAL;
778 pmin = 125 * (1 << min_datainterval);
779 changed = 0;
780 if (it->min < pmin) {
781 it->min = pmin;
782 it->openmin = 0;
783 changed = 1;
785 if (snd_interval_checkempty(it)) {
786 it->empty = 1;
787 return -EINVAL;
789 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
790 return changed;
794 * If the device supports unusual bit rates, does the request meet these?
796 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
797 struct snd_usb_substream *subs)
799 struct audioformat *fp;
800 int *rate_list;
801 int count = 0, needs_knot = 0;
802 int err;
804 kfree(subs->rate_list.list);
805 subs->rate_list.list = NULL;
807 list_for_each_entry(fp, &subs->fmt_list, list) {
808 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
809 return 0;
810 count += fp->nr_rates;
811 if (fp->rates & SNDRV_PCM_RATE_KNOT)
812 needs_knot = 1;
814 if (!needs_knot)
815 return 0;
817 subs->rate_list.list = rate_list =
818 kmalloc(sizeof(int) * count, GFP_KERNEL);
819 if (!subs->rate_list.list)
820 return -ENOMEM;
821 subs->rate_list.count = count;
822 subs->rate_list.mask = 0;
823 count = 0;
824 list_for_each_entry(fp, &subs->fmt_list, list) {
825 int i;
826 for (i = 0; i < fp->nr_rates; i++)
827 rate_list[count++] = fp->rate_table[i];
829 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
830 &subs->rate_list);
831 if (err < 0)
832 return err;
834 return 0;
839 * set up the runtime hardware information.
842 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
844 struct list_head *p;
845 unsigned int pt, ptmin;
846 int param_period_time_if_needed;
847 int err;
849 runtime->hw.formats = subs->formats;
851 runtime->hw.rate_min = 0x7fffffff;
852 runtime->hw.rate_max = 0;
853 runtime->hw.channels_min = 256;
854 runtime->hw.channels_max = 0;
855 runtime->hw.rates = 0;
856 ptmin = UINT_MAX;
857 /* check min/max rates and channels */
858 list_for_each(p, &subs->fmt_list) {
859 struct audioformat *fp;
860 fp = list_entry(p, struct audioformat, list);
861 runtime->hw.rates |= fp->rates;
862 if (runtime->hw.rate_min > fp->rate_min)
863 runtime->hw.rate_min = fp->rate_min;
864 if (runtime->hw.rate_max < fp->rate_max)
865 runtime->hw.rate_max = fp->rate_max;
866 if (runtime->hw.channels_min > fp->channels)
867 runtime->hw.channels_min = fp->channels;
868 if (runtime->hw.channels_max < fp->channels)
869 runtime->hw.channels_max = fp->channels;
870 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
871 /* FIXME: there might be more than one audio formats... */
872 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
873 fp->frame_size;
875 pt = 125 * (1 << fp->datainterval);
876 ptmin = min(ptmin, pt);
878 err = snd_usb_autoresume(subs->stream->chip);
879 if (err < 0)
880 return err;
882 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
883 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
884 /* full speed devices have fixed data packet interval */
885 ptmin = 1000;
886 if (ptmin == 1000)
887 /* if period time doesn't go below 1 ms, no rules needed */
888 param_period_time_if_needed = -1;
889 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
890 ptmin, UINT_MAX);
892 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
893 hw_rule_rate, subs,
894 SNDRV_PCM_HW_PARAM_FORMAT,
895 SNDRV_PCM_HW_PARAM_CHANNELS,
896 param_period_time_if_needed,
897 -1)) < 0)
898 goto rep_err;
899 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
900 hw_rule_channels, subs,
901 SNDRV_PCM_HW_PARAM_FORMAT,
902 SNDRV_PCM_HW_PARAM_RATE,
903 param_period_time_if_needed,
904 -1)) < 0)
905 goto rep_err;
906 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
907 hw_rule_format, subs,
908 SNDRV_PCM_HW_PARAM_RATE,
909 SNDRV_PCM_HW_PARAM_CHANNELS,
910 param_period_time_if_needed,
911 -1)) < 0)
912 goto rep_err;
913 if (param_period_time_if_needed >= 0) {
914 err = snd_pcm_hw_rule_add(runtime, 0,
915 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
916 hw_rule_period_time, subs,
917 SNDRV_PCM_HW_PARAM_FORMAT,
918 SNDRV_PCM_HW_PARAM_CHANNELS,
919 SNDRV_PCM_HW_PARAM_RATE,
920 -1);
921 if (err < 0)
922 goto rep_err;
924 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
925 goto rep_err;
926 return 0;
928 rep_err:
929 snd_usb_autosuspend(subs->stream->chip);
930 return err;
933 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
935 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
936 struct snd_pcm_runtime *runtime = substream->runtime;
937 struct snd_usb_substream *subs = &as->substream[direction];
939 subs->interface = -1;
940 subs->altset_idx = 0;
941 runtime->hw = snd_usb_hardware;
942 runtime->private_data = subs;
943 subs->pcm_substream = substream;
944 /* runtime PM is also done there */
945 return setup_hw_info(runtime, subs);
948 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
950 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
951 struct snd_usb_substream *subs = &as->substream[direction];
953 stop_endpoints(subs, 0, 0, 0);
955 if (!as->chip->shutdown && subs->interface >= 0) {
956 usb_set_interface(subs->dev, subs->interface, 0);
957 subs->interface = -1;
960 subs->pcm_substream = NULL;
961 snd_usb_autosuspend(subs->stream->chip);
963 return 0;
966 /* Since a URB can handle only a single linear buffer, we must use double
967 * buffering when the data to be transferred overflows the buffer boundary.
968 * To avoid inconsistencies when updating hwptr_done, we use double buffering
969 * for all URBs.
971 static void retire_capture_urb(struct snd_usb_substream *subs,
972 struct urb *urb)
974 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
975 unsigned int stride, frames, bytes, oldptr;
976 int i, period_elapsed = 0;
977 unsigned long flags;
978 unsigned char *cp;
980 stride = runtime->frame_bits >> 3;
982 for (i = 0; i < urb->number_of_packets; i++) {
983 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
984 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
985 snd_printdd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
986 // continue;
988 bytes = urb->iso_frame_desc[i].actual_length;
989 frames = bytes / stride;
990 if (!subs->txfr_quirk)
991 bytes = frames * stride;
992 if (bytes % (runtime->sample_bits >> 3) != 0) {
993 #ifdef CONFIG_SND_DEBUG_VERBOSE
994 int oldbytes = bytes;
995 #endif
996 bytes = frames * stride;
997 snd_printdd(KERN_ERR "Corrected urb data len. %d->%d\n",
998 oldbytes, bytes);
1000 /* update the current pointer */
1001 spin_lock_irqsave(&subs->lock, flags);
1002 oldptr = subs->hwptr_done;
1003 subs->hwptr_done += bytes;
1004 if (subs->hwptr_done >= runtime->buffer_size * stride)
1005 subs->hwptr_done -= runtime->buffer_size * stride;
1006 frames = (bytes + (oldptr % stride)) / stride;
1007 subs->transfer_done += frames;
1008 if (subs->transfer_done >= runtime->period_size) {
1009 subs->transfer_done -= runtime->period_size;
1010 period_elapsed = 1;
1012 spin_unlock_irqrestore(&subs->lock, flags);
1013 /* copy a data chunk */
1014 if (oldptr + bytes > runtime->buffer_size * stride) {
1015 unsigned int bytes1 =
1016 runtime->buffer_size * stride - oldptr;
1017 memcpy(runtime->dma_area + oldptr, cp, bytes1);
1018 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1019 } else {
1020 memcpy(runtime->dma_area + oldptr, cp, bytes);
1024 if (period_elapsed)
1025 snd_pcm_period_elapsed(subs->pcm_substream);
1028 static void prepare_playback_urb(struct snd_usb_substream *subs,
1029 struct urb *urb)
1031 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1032 struct snd_urb_ctx *ctx = urb->context;
1033 unsigned int counts, frames, bytes;
1034 int i, stride, period_elapsed = 0;
1035 unsigned long flags;
1037 stride = runtime->frame_bits >> 3;
1039 frames = 0;
1040 urb->number_of_packets = 0;
1041 spin_lock_irqsave(&subs->lock, flags);
1042 for (i = 0; i < ctx->packets; i++) {
1043 counts = ctx->packet_size[i];
1044 /* set up descriptor */
1045 urb->iso_frame_desc[i].offset = frames * stride;
1046 urb->iso_frame_desc[i].length = counts * stride;
1047 frames += counts;
1048 urb->number_of_packets++;
1049 subs->transfer_done += counts;
1050 if (subs->transfer_done >= runtime->period_size) {
1051 subs->transfer_done -= runtime->period_size;
1052 period_elapsed = 1;
1053 if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1054 if (subs->transfer_done > 0) {
1055 /* FIXME: fill-max mode is not
1056 * supported yet */
1057 frames -= subs->transfer_done;
1058 counts -= subs->transfer_done;
1059 urb->iso_frame_desc[i].length =
1060 counts * stride;
1061 subs->transfer_done = 0;
1063 i++;
1064 if (i < ctx->packets) {
1065 /* add a transfer delimiter */
1066 urb->iso_frame_desc[i].offset =
1067 frames * stride;
1068 urb->iso_frame_desc[i].length = 0;
1069 urb->number_of_packets++;
1071 break;
1074 if (period_elapsed &&
1075 !snd_usb_endpoint_implict_feedback_sink(subs->data_endpoint)) /* finish at the period boundary */
1076 break;
1078 bytes = frames * stride;
1079 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1080 /* err, the transferred area goes over buffer boundary. */
1081 unsigned int bytes1 =
1082 runtime->buffer_size * stride - subs->hwptr_done;
1083 memcpy(urb->transfer_buffer,
1084 runtime->dma_area + subs->hwptr_done, bytes1);
1085 memcpy(urb->transfer_buffer + bytes1,
1086 runtime->dma_area, bytes - bytes1);
1087 } else {
1088 memcpy(urb->transfer_buffer,
1089 runtime->dma_area + subs->hwptr_done, bytes);
1091 subs->hwptr_done += bytes;
1092 if (subs->hwptr_done >= runtime->buffer_size * stride)
1093 subs->hwptr_done -= runtime->buffer_size * stride;
1094 runtime->delay += frames;
1095 spin_unlock_irqrestore(&subs->lock, flags);
1096 urb->transfer_buffer_length = bytes;
1097 if (period_elapsed)
1098 snd_pcm_period_elapsed(subs->pcm_substream);
1102 * process after playback data complete
1103 * - decrease the delay count again
1105 static void retire_playback_urb(struct snd_usb_substream *subs,
1106 struct urb *urb)
1108 unsigned long flags;
1109 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1110 int stride = runtime->frame_bits >> 3;
1111 int processed = urb->transfer_buffer_length / stride;
1113 spin_lock_irqsave(&subs->lock, flags);
1114 if (processed > runtime->delay)
1115 runtime->delay = 0;
1116 else
1117 runtime->delay -= processed;
1118 spin_unlock_irqrestore(&subs->lock, flags);
1121 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1123 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1126 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1128 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1131 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1133 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1136 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1138 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1141 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1142 int cmd)
1144 struct snd_usb_substream *subs = substream->runtime->private_data;
1146 switch (cmd) {
1147 case SNDRV_PCM_TRIGGER_START:
1148 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1149 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1150 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1151 subs->running = 1;
1152 return 0;
1153 case SNDRV_PCM_TRIGGER_STOP:
1154 stop_endpoints(subs, 0, 0, 0);
1155 subs->running = 0;
1156 return 0;
1157 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1158 subs->data_endpoint->prepare_data_urb = NULL;
1159 subs->data_endpoint->retire_data_urb = NULL;
1160 subs->running = 0;
1161 return 0;
1164 return -EINVAL;
1167 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1168 int cmd)
1170 int err;
1171 struct snd_usb_substream *subs = substream->runtime->private_data;
1173 switch (cmd) {
1174 case SNDRV_PCM_TRIGGER_START:
1175 err = start_endpoints(subs);
1176 if (err < 0)
1177 return err;
1179 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1180 subs->running = 1;
1181 return 0;
1182 case SNDRV_PCM_TRIGGER_STOP:
1183 stop_endpoints(subs, 0, 0, 0);
1184 subs->running = 0;
1185 return 0;
1186 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1187 subs->data_endpoint->retire_data_urb = NULL;
1188 subs->running = 0;
1189 return 0;
1190 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1191 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1192 subs->running = 1;
1193 return 0;
1196 return -EINVAL;
1199 static struct snd_pcm_ops snd_usb_playback_ops = {
1200 .open = snd_usb_playback_open,
1201 .close = snd_usb_playback_close,
1202 .ioctl = snd_pcm_lib_ioctl,
1203 .hw_params = snd_usb_hw_params,
1204 .hw_free = snd_usb_hw_free,
1205 .prepare = snd_usb_pcm_prepare,
1206 .trigger = snd_usb_substream_playback_trigger,
1207 .pointer = snd_usb_pcm_pointer,
1208 .page = snd_pcm_lib_get_vmalloc_page,
1209 .mmap = snd_pcm_lib_mmap_vmalloc,
1212 static struct snd_pcm_ops snd_usb_capture_ops = {
1213 .open = snd_usb_capture_open,
1214 .close = snd_usb_capture_close,
1215 .ioctl = snd_pcm_lib_ioctl,
1216 .hw_params = snd_usb_hw_params,
1217 .hw_free = snd_usb_hw_free,
1218 .prepare = snd_usb_pcm_prepare,
1219 .trigger = snd_usb_substream_capture_trigger,
1220 .pointer = snd_usb_pcm_pointer,
1221 .page = snd_pcm_lib_get_vmalloc_page,
1222 .mmap = snd_pcm_lib_mmap_vmalloc,
1225 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1227 snd_pcm_set_ops(pcm, stream,
1228 stream == SNDRV_PCM_STREAM_PLAYBACK ?
1229 &snd_usb_playback_ops : &snd_usb_capture_ops);