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
, unsigned int format
,
88 unsigned int rate
, unsigned int channels
)
91 struct audioformat
*found
= NULL
;
92 int cur_attr
= 0, attr
;
94 list_for_each(p
, &subs
->fmt_list
) {
95 struct audioformat
*fp
;
96 fp
= list_entry(p
, struct audioformat
, list
);
97 if (!(fp
->formats
& (1uLL << format
)))
99 if (fp
->channels
!= channels
)
101 if (rate
< fp
->rate_min
|| 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
] == 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 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
182 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC2_CS_CUR
,
183 USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
184 UAC2_EP_CS_PITCH
<< 8, 0,
185 data
, sizeof(data
))) < 0) {
186 snd_printk(KERN_ERR
"%d:%d:%d: cannot set enable PITCH (v2)\n",
187 dev
->devnum
, iface
, fmt
->altsetting
);
195 * initialize the pitch control and sample rate
197 int snd_usb_init_pitch(struct snd_usb_audio
*chip
, int iface
,
198 struct usb_host_interface
*alts
,
199 struct audioformat
*fmt
)
201 struct usb_interface_descriptor
*altsd
= get_iface_desc(alts
);
203 /* if endpoint doesn't have pitch control, bail out */
204 if (!(fmt
->attributes
& UAC_EP_CS_ATTR_PITCH_CONTROL
))
207 switch (altsd
->bInterfaceProtocol
) {
210 return init_pitch_v1(chip
, iface
, alts
, fmt
);
213 return init_pitch_v2(chip
, iface
, alts
, fmt
);
217 static int start_endpoints(struct snd_usb_substream
*subs
, int can_sleep
)
221 if (!subs
->data_endpoint
)
224 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED
, &subs
->flags
)) {
225 struct snd_usb_endpoint
*ep
= subs
->data_endpoint
;
227 snd_printdd(KERN_DEBUG
"Starting data EP @%p\n", ep
);
229 ep
->data_subs
= subs
;
230 err
= snd_usb_endpoint_start(ep
, can_sleep
);
232 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED
, &subs
->flags
);
237 if (subs
->sync_endpoint
&&
238 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED
, &subs
->flags
)) {
239 struct snd_usb_endpoint
*ep
= subs
->sync_endpoint
;
241 if (subs
->data_endpoint
->iface
!= subs
->sync_endpoint
->iface
||
242 subs
->data_endpoint
->alt_idx
!= subs
->sync_endpoint
->alt_idx
) {
243 err
= usb_set_interface(subs
->dev
,
244 subs
->sync_endpoint
->iface
,
245 subs
->sync_endpoint
->alt_idx
);
248 "%d:%d:%d: cannot set interface (%d)\n",
250 subs
->sync_endpoint
->iface
,
251 subs
->sync_endpoint
->alt_idx
, err
);
256 snd_printdd(KERN_DEBUG
"Starting sync EP @%p\n", ep
);
258 ep
->sync_slave
= subs
->data_endpoint
;
259 err
= snd_usb_endpoint_start(ep
, can_sleep
);
261 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED
, &subs
->flags
);
269 static void stop_endpoints(struct snd_usb_substream
*subs
,
270 int force
, int can_sleep
, int wait
)
272 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED
, &subs
->flags
))
273 snd_usb_endpoint_stop(subs
->sync_endpoint
,
274 force
, can_sleep
, wait
);
276 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED
, &subs
->flags
))
277 snd_usb_endpoint_stop(subs
->data_endpoint
,
278 force
, can_sleep
, wait
);
281 static int deactivate_endpoints(struct snd_usb_substream
*subs
)
285 reta
= snd_usb_endpoint_deactivate(subs
->sync_endpoint
);
286 retb
= snd_usb_endpoint_deactivate(subs
->data_endpoint
);
298 * find a matching format and set up the interface
300 static int set_format(struct snd_usb_substream
*subs
, struct audioformat
*fmt
)
302 struct usb_device
*dev
= subs
->dev
;
303 struct usb_host_interface
*alts
;
304 struct usb_interface_descriptor
*altsd
;
305 struct usb_interface
*iface
;
306 unsigned int ep
, attr
;
307 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
308 int err
, implicit_fb
= 0;
310 iface
= usb_ifnum_to_if(dev
, fmt
->iface
);
313 alts
= &iface
->altsetting
[fmt
->altset_idx
];
314 altsd
= get_iface_desc(alts
);
315 if (WARN_ON(altsd
->bAlternateSetting
!= fmt
->altsetting
))
318 if (fmt
== subs
->cur_audiofmt
)
321 /* close the old interface */
322 if (subs
->interface
>= 0 && subs
->interface
!= fmt
->iface
) {
323 err
= usb_set_interface(subs
->dev
, subs
->interface
, 0);
325 snd_printk(KERN_ERR
"%d:%d:%d: return to setting 0 failed (%d)\n",
326 dev
->devnum
, fmt
->iface
, fmt
->altsetting
, err
);
329 subs
->interface
= -1;
330 subs
->altset_idx
= 0;
334 if (subs
->interface
!= fmt
->iface
||
335 subs
->altset_idx
!= fmt
->altset_idx
) {
336 err
= usb_set_interface(dev
, fmt
->iface
, fmt
->altsetting
);
338 snd_printk(KERN_ERR
"%d:%d:%d: usb_set_interface failed (%d)\n",
339 dev
->devnum
, fmt
->iface
, fmt
->altsetting
, err
);
342 snd_printdd(KERN_INFO
"setting usb interface %d:%d\n",
343 fmt
->iface
, fmt
->altsetting
);
344 subs
->interface
= fmt
->iface
;
345 subs
->altset_idx
= fmt
->altset_idx
;
348 subs
->data_endpoint
= snd_usb_add_endpoint(subs
->stream
->chip
,
349 alts
, fmt
->endpoint
, subs
->direction
,
350 SND_USB_ENDPOINT_TYPE_DATA
);
351 if (!subs
->data_endpoint
)
354 /* we need a sync pipe in async OUT or adaptive IN mode */
355 /* check the number of EP, since some devices have broken
356 * descriptors which fool us. if it has only one EP,
357 * assume it as adaptive-out or sync-in.
359 attr
= fmt
->ep_attr
& USB_ENDPOINT_SYNCTYPE
;
361 switch (subs
->stream
->chip
->usb_id
) {
362 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
363 case USB_ID(0x0763, 0x2081):
367 iface
= usb_ifnum_to_if(dev
, 2);
369 if (!iface
|| iface
->num_altsetting
== 0)
372 alts
= &iface
->altsetting
[1];
377 if (((is_playback
&& attr
== USB_ENDPOINT_SYNC_ASYNC
) ||
378 (!is_playback
&& attr
== USB_ENDPOINT_SYNC_ADAPTIVE
)) &&
379 altsd
->bNumEndpoints
>= 2) {
380 /* check sync-pipe endpoint */
381 /* ... and check descriptor size before accessing bSynchAddress
382 because there is a version of the SB Audigy 2 NX firmware lacking
383 the audio fields in the endpoint descriptors */
384 if ((get_endpoint(alts
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != 0x01 ||
385 (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
386 get_endpoint(alts
, 1)->bSynchAddress
!= 0 &&
388 snd_printk(KERN_ERR
"%d:%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
389 dev
->devnum
, fmt
->iface
, fmt
->altsetting
,
390 get_endpoint(alts
, 1)->bmAttributes
,
391 get_endpoint(alts
, 1)->bLength
,
392 get_endpoint(alts
, 1)->bSynchAddress
);
395 ep
= get_endpoint(alts
, 1)->bEndpointAddress
;
397 get_endpoint(alts
, 0)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
398 (( is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
| USB_DIR_IN
)) ||
399 (!is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
& ~USB_DIR_IN
)))) {
400 snd_printk(KERN_ERR
"%d:%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
401 dev
->devnum
, fmt
->iface
, fmt
->altsetting
,
402 is_playback
, ep
, get_endpoint(alts
, 0)->bSynchAddress
);
406 implicit_fb
= (get_endpoint(alts
, 1)->bmAttributes
& USB_ENDPOINT_USAGE_MASK
)
407 == USB_ENDPOINT_USAGE_IMPLICIT_FB
;
410 subs
->sync_endpoint
= snd_usb_add_endpoint(subs
->stream
->chip
,
411 alts
, ep
, !subs
->direction
,
413 SND_USB_ENDPOINT_TYPE_DATA
:
414 SND_USB_ENDPOINT_TYPE_SYNC
);
415 if (!subs
->sync_endpoint
)
418 subs
->data_endpoint
->sync_master
= subs
->sync_endpoint
;
421 if ((err
= snd_usb_init_pitch(subs
->stream
->chip
, fmt
->iface
, alts
, fmt
)) < 0)
424 subs
->cur_audiofmt
= fmt
;
426 snd_usb_set_format_quirk(subs
, fmt
);
430 "setting done: format = %d, rate = %d..%d, channels = %d\n",
431 fmt
->format
, fmt
->rate_min
, fmt
->rate_max
, fmt
->channels
);
433 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
434 subs
->datapipe
, subs
->syncpipe
);
443 * allocate a buffer and set the given audio format.
445 * so far we use a physically linear buffer although packetize transfer
446 * doesn't need a continuous area.
447 * if sg buffer is supported on the later version of alsa, we'll follow
450 static int snd_usb_hw_params(struct snd_pcm_substream
*substream
,
451 struct snd_pcm_hw_params
*hw_params
)
453 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
454 struct audioformat
*fmt
;
455 unsigned int channels
, rate
, format
;
458 ret
= snd_pcm_lib_alloc_vmalloc_buffer(substream
,
459 params_buffer_bytes(hw_params
));
463 format
= params_format(hw_params
);
464 rate
= params_rate(hw_params
);
465 channels
= params_channels(hw_params
);
466 fmt
= find_format(subs
, format
, rate
, channels
);
468 snd_printd(KERN_DEBUG
"cannot set format: format = %#x, rate = %d, channels = %d\n",
469 format
, rate
, channels
);
473 changed
= subs
->cur_audiofmt
!= fmt
||
474 subs
->period_bytes
!= params_period_bytes(hw_params
) ||
475 subs
->cur_rate
!= rate
;
477 down_read(&subs
->stream
->chip
->shutdown_rwsem
);
478 if (subs
->stream
->chip
->shutdown
) {
482 if ((ret
= set_format(subs
, fmt
)) < 0)
485 if (subs
->cur_rate
!= rate
) {
486 struct usb_host_interface
*alts
;
487 struct usb_interface
*iface
;
488 iface
= usb_ifnum_to_if(subs
->dev
, fmt
->iface
);
489 alts
= &iface
->altsetting
[fmt
->altset_idx
];
490 ret
= snd_usb_init_sample_rate(subs
->stream
->chip
, fmt
->iface
, alts
, fmt
, rate
);
493 subs
->cur_rate
= rate
;
498 stop_endpoints(subs
, 0, 0, 0);
499 ret
= snd_usb_endpoint_set_params(subs
->data_endpoint
, hw_params
, fmt
,
500 subs
->sync_endpoint
);
504 if (subs
->sync_endpoint
)
505 ret
= snd_usb_endpoint_set_params(subs
->sync_endpoint
,
506 hw_params
, fmt
, NULL
);
510 subs
->interface
= fmt
->iface
;
511 subs
->altset_idx
= fmt
->altset_idx
;
515 up_read(&subs
->stream
->chip
->shutdown_rwsem
);
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
;
551 if (! subs
->cur_audiofmt
) {
552 snd_printk(KERN_ERR
"usbaudio: no format is specified!\n");
556 down_read(&subs
->stream
->chip
->shutdown_rwsem
);
557 if (subs
->stream
->chip
->shutdown
) {
561 if (snd_BUG_ON(!subs
->data_endpoint
)) {
566 /* some unit conversions in runtime */
567 subs
->data_endpoint
->maxframesize
=
568 bytes_to_frames(runtime
, subs
->data_endpoint
->maxpacksize
);
569 subs
->data_endpoint
->curframesize
=
570 bytes_to_frames(runtime
, subs
->data_endpoint
->curpacksize
);
572 /* reset the pointer */
573 subs
->hwptr_done
= 0;
574 subs
->transfer_done
= 0;
575 subs
->last_delay
= 0;
576 subs
->last_frame_number
= 0;
579 /* for playback, submit the URBs now; otherwise, the first hwptr_done
580 * updates for all URBs would happen at the same time when starting */
581 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
)
582 ret
= start_endpoints(subs
, 1);
585 up_read(&subs
->stream
->chip
->shutdown_rwsem
);
589 static struct snd_pcm_hardware snd_usb_hardware
=
591 .info
= SNDRV_PCM_INFO_MMAP
|
592 SNDRV_PCM_INFO_MMAP_VALID
|
593 SNDRV_PCM_INFO_BATCH
|
594 SNDRV_PCM_INFO_INTERLEAVED
|
595 SNDRV_PCM_INFO_BLOCK_TRANSFER
|
596 SNDRV_PCM_INFO_PAUSE
,
597 .buffer_bytes_max
= 1024 * 1024,
598 .period_bytes_min
= 64,
599 .period_bytes_max
= 512 * 1024,
604 static int hw_check_valid_format(struct snd_usb_substream
*subs
,
605 struct snd_pcm_hw_params
*params
,
606 struct audioformat
*fp
)
608 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
609 struct snd_interval
*ct
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
610 struct snd_mask
*fmts
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
611 struct snd_interval
*pt
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
);
612 struct snd_mask check_fmts
;
615 /* check the format */
616 snd_mask_none(&check_fmts
);
617 check_fmts
.bits
[0] = (u32
)fp
->formats
;
618 check_fmts
.bits
[1] = (u32
)(fp
->formats
>> 32);
619 snd_mask_intersect(&check_fmts
, fmts
);
620 if (snd_mask_empty(&check_fmts
)) {
621 hwc_debug(" > check: no supported format %d\n", fp
->format
);
624 /* check the channels */
625 if (fp
->channels
< ct
->min
|| fp
->channels
> ct
->max
) {
626 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp
->channels
, ct
->min
, ct
->max
);
629 /* check the rate is within the range */
630 if (fp
->rate_min
> it
->max
|| (fp
->rate_min
== it
->max
&& it
->openmax
)) {
631 hwc_debug(" > check: rate_min %d > max %d\n", fp
->rate_min
, it
->max
);
634 if (fp
->rate_max
< it
->min
|| (fp
->rate_max
== it
->min
&& it
->openmin
)) {
635 hwc_debug(" > check: rate_max %d < min %d\n", fp
->rate_max
, it
->min
);
638 /* check whether the period time is >= the data packet interval */
639 if (subs
->speed
!= USB_SPEED_FULL
) {
640 ptime
= 125 * (1 << fp
->datainterval
);
641 if (ptime
> pt
->max
|| (ptime
== pt
->max
&& pt
->openmax
)) {
642 hwc_debug(" > check: ptime %u > max %u\n", ptime
, pt
->max
);
649 static int hw_rule_rate(struct snd_pcm_hw_params
*params
,
650 struct snd_pcm_hw_rule
*rule
)
652 struct snd_usb_substream
*subs
= rule
->private;
654 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
655 unsigned int rmin
, rmax
;
658 hwc_debug("hw_rule_rate: (%d,%d)\n", it
->min
, it
->max
);
661 list_for_each(p
, &subs
->fmt_list
) {
662 struct audioformat
*fp
;
663 fp
= list_entry(p
, struct audioformat
, list
);
664 if (!hw_check_valid_format(subs
, params
, fp
))
667 if (rmin
> fp
->rate_min
)
669 if (rmax
< fp
->rate_max
)
678 hwc_debug(" --> get empty\n");
684 if (it
->min
< rmin
) {
689 if (it
->max
> rmax
) {
694 if (snd_interval_checkempty(it
)) {
698 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
703 static int hw_rule_channels(struct snd_pcm_hw_params
*params
,
704 struct snd_pcm_hw_rule
*rule
)
706 struct snd_usb_substream
*subs
= rule
->private;
708 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
709 unsigned int rmin
, rmax
;
712 hwc_debug("hw_rule_channels: (%d,%d)\n", it
->min
, it
->max
);
715 list_for_each(p
, &subs
->fmt_list
) {
716 struct audioformat
*fp
;
717 fp
= list_entry(p
, struct audioformat
, list
);
718 if (!hw_check_valid_format(subs
, params
, fp
))
721 if (rmin
> fp
->channels
)
723 if (rmax
< fp
->channels
)
732 hwc_debug(" --> get empty\n");
738 if (it
->min
< rmin
) {
743 if (it
->max
> rmax
) {
748 if (snd_interval_checkempty(it
)) {
752 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
756 static int hw_rule_format(struct snd_pcm_hw_params
*params
,
757 struct snd_pcm_hw_rule
*rule
)
759 struct snd_usb_substream
*subs
= rule
->private;
761 struct snd_mask
*fmt
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
766 hwc_debug("hw_rule_format: %x:%x\n", fmt
->bits
[0], fmt
->bits
[1]);
768 list_for_each(p
, &subs
->fmt_list
) {
769 struct audioformat
*fp
;
770 fp
= list_entry(p
, struct audioformat
, list
);
771 if (!hw_check_valid_format(subs
, params
, fp
))
773 fbits
|= fp
->formats
;
776 oldbits
[0] = fmt
->bits
[0];
777 oldbits
[1] = fmt
->bits
[1];
778 fmt
->bits
[0] &= (u32
)fbits
;
779 fmt
->bits
[1] &= (u32
)(fbits
>> 32);
780 if (!fmt
->bits
[0] && !fmt
->bits
[1]) {
781 hwc_debug(" --> get empty\n");
784 changed
= (oldbits
[0] != fmt
->bits
[0] || oldbits
[1] != fmt
->bits
[1]);
785 hwc_debug(" --> %x:%x (changed = %d)\n", fmt
->bits
[0], fmt
->bits
[1], changed
);
789 static int hw_rule_period_time(struct snd_pcm_hw_params
*params
,
790 struct snd_pcm_hw_rule
*rule
)
792 struct snd_usb_substream
*subs
= rule
->private;
793 struct audioformat
*fp
;
794 struct snd_interval
*it
;
795 unsigned char min_datainterval
;
799 it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
);
800 hwc_debug("hw_rule_period_time: (%u,%u)\n", it
->min
, it
->max
);
801 min_datainterval
= 0xff;
802 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
803 if (!hw_check_valid_format(subs
, params
, fp
))
805 min_datainterval
= min(min_datainterval
, fp
->datainterval
);
807 if (min_datainterval
== 0xff) {
808 hwc_debug(" --> get empty\n");
812 pmin
= 125 * (1 << min_datainterval
);
814 if (it
->min
< pmin
) {
819 if (snd_interval_checkempty(it
)) {
823 hwc_debug(" --> (%u,%u) (changed = %d)\n", it
->min
, it
->max
, changed
);
828 * If the device supports unusual bit rates, does the request meet these?
830 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime
*runtime
,
831 struct snd_usb_substream
*subs
)
833 struct audioformat
*fp
;
835 int count
= 0, needs_knot
= 0;
838 kfree(subs
->rate_list
.list
);
839 subs
->rate_list
.list
= NULL
;
841 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
842 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
844 count
+= fp
->nr_rates
;
845 if (fp
->rates
& SNDRV_PCM_RATE_KNOT
)
851 subs
->rate_list
.list
= rate_list
=
852 kmalloc(sizeof(int) * count
, GFP_KERNEL
);
853 if (!subs
->rate_list
.list
)
855 subs
->rate_list
.count
= count
;
856 subs
->rate_list
.mask
= 0;
858 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
860 for (i
= 0; i
< fp
->nr_rates
; i
++)
861 rate_list
[count
++] = fp
->rate_table
[i
];
863 err
= snd_pcm_hw_constraint_list(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
873 * set up the runtime hardware information.
876 static int setup_hw_info(struct snd_pcm_runtime
*runtime
, struct snd_usb_substream
*subs
)
879 unsigned int pt
, ptmin
;
880 int param_period_time_if_needed
;
883 runtime
->hw
.formats
= subs
->formats
;
885 runtime
->hw
.rate_min
= 0x7fffffff;
886 runtime
->hw
.rate_max
= 0;
887 runtime
->hw
.channels_min
= 256;
888 runtime
->hw
.channels_max
= 0;
889 runtime
->hw
.rates
= 0;
891 /* check min/max rates and channels */
892 list_for_each(p
, &subs
->fmt_list
) {
893 struct audioformat
*fp
;
894 fp
= list_entry(p
, struct audioformat
, list
);
895 runtime
->hw
.rates
|= fp
->rates
;
896 if (runtime
->hw
.rate_min
> fp
->rate_min
)
897 runtime
->hw
.rate_min
= fp
->rate_min
;
898 if (runtime
->hw
.rate_max
< fp
->rate_max
)
899 runtime
->hw
.rate_max
= fp
->rate_max
;
900 if (runtime
->hw
.channels_min
> fp
->channels
)
901 runtime
->hw
.channels_min
= fp
->channels
;
902 if (runtime
->hw
.channels_max
< fp
->channels
)
903 runtime
->hw
.channels_max
= fp
->channels
;
904 if (fp
->fmt_type
== UAC_FORMAT_TYPE_II
&& fp
->frame_size
> 0) {
905 /* FIXME: there might be more than one audio formats... */
906 runtime
->hw
.period_bytes_min
= runtime
->hw
.period_bytes_max
=
909 pt
= 125 * (1 << fp
->datainterval
);
910 ptmin
= min(ptmin
, pt
);
912 err
= snd_usb_autoresume(subs
->stream
->chip
);
916 param_period_time_if_needed
= SNDRV_PCM_HW_PARAM_PERIOD_TIME
;
917 if (subs
->speed
== USB_SPEED_FULL
)
918 /* full speed devices have fixed data packet interval */
921 /* if period time doesn't go below 1 ms, no rules needed */
922 param_period_time_if_needed
= -1;
923 snd_pcm_hw_constraint_minmax(runtime
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
926 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
928 SNDRV_PCM_HW_PARAM_FORMAT
,
929 SNDRV_PCM_HW_PARAM_CHANNELS
,
930 param_period_time_if_needed
,
933 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_CHANNELS
,
934 hw_rule_channels
, subs
,
935 SNDRV_PCM_HW_PARAM_FORMAT
,
936 SNDRV_PCM_HW_PARAM_RATE
,
937 param_period_time_if_needed
,
940 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_FORMAT
,
941 hw_rule_format
, subs
,
942 SNDRV_PCM_HW_PARAM_RATE
,
943 SNDRV_PCM_HW_PARAM_CHANNELS
,
944 param_period_time_if_needed
,
947 if (param_period_time_if_needed
>= 0) {
948 err
= snd_pcm_hw_rule_add(runtime
, 0,
949 SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
950 hw_rule_period_time
, subs
,
951 SNDRV_PCM_HW_PARAM_FORMAT
,
952 SNDRV_PCM_HW_PARAM_CHANNELS
,
953 SNDRV_PCM_HW_PARAM_RATE
,
958 if ((err
= snd_usb_pcm_check_knot(runtime
, subs
)) < 0)
963 snd_usb_autosuspend(subs
->stream
->chip
);
967 static int snd_usb_pcm_open(struct snd_pcm_substream
*substream
, int direction
)
969 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
970 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
971 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
973 subs
->interface
= -1;
974 subs
->altset_idx
= 0;
975 runtime
->hw
= snd_usb_hardware
;
976 runtime
->private_data
= subs
;
977 subs
->pcm_substream
= substream
;
978 /* runtime PM is also done there */
979 return setup_hw_info(runtime
, subs
);
982 static int snd_usb_pcm_close(struct snd_pcm_substream
*substream
, int direction
)
984 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
985 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
987 stop_endpoints(subs
, 0, 0, 0);
989 if (!as
->chip
->shutdown
&& subs
->interface
>= 0) {
990 usb_set_interface(subs
->dev
, subs
->interface
, 0);
991 subs
->interface
= -1;
994 subs
->pcm_substream
= NULL
;
995 snd_usb_autosuspend(subs
->stream
->chip
);
1000 /* Since a URB can handle only a single linear buffer, we must use double
1001 * buffering when the data to be transferred overflows the buffer boundary.
1002 * To avoid inconsistencies when updating hwptr_done, we use double buffering
1005 static void retire_capture_urb(struct snd_usb_substream
*subs
,
1008 struct snd_pcm_runtime
*runtime
= subs
->pcm_substream
->runtime
;
1009 unsigned int stride
, frames
, bytes
, oldptr
;
1010 int i
, period_elapsed
= 0;
1011 unsigned long flags
;
1014 stride
= runtime
->frame_bits
>> 3;
1016 for (i
= 0; i
< urb
->number_of_packets
; i
++) {
1017 cp
= (unsigned char *)urb
->transfer_buffer
+ urb
->iso_frame_desc
[i
].offset
;
1018 if (urb
->iso_frame_desc
[i
].status
&& printk_ratelimit()) {
1019 snd_printdd(KERN_ERR
"frame %d active: %d\n", i
, urb
->iso_frame_desc
[i
].status
);
1022 bytes
= urb
->iso_frame_desc
[i
].actual_length
;
1023 frames
= bytes
/ stride
;
1024 if (!subs
->txfr_quirk
)
1025 bytes
= frames
* stride
;
1026 if (bytes
% (runtime
->sample_bits
>> 3) != 0) {
1027 #ifdef CONFIG_SND_DEBUG_VERBOSE
1028 int oldbytes
= bytes
;
1030 bytes
= frames
* stride
;
1031 snd_printdd(KERN_ERR
"Corrected urb data len. %d->%d\n",
1034 /* update the current pointer */
1035 spin_lock_irqsave(&subs
->lock
, flags
);
1036 oldptr
= subs
->hwptr_done
;
1037 subs
->hwptr_done
+= bytes
;
1038 if (subs
->hwptr_done
>= runtime
->buffer_size
* stride
)
1039 subs
->hwptr_done
-= runtime
->buffer_size
* stride
;
1040 frames
= (bytes
+ (oldptr
% stride
)) / stride
;
1041 subs
->transfer_done
+= frames
;
1042 if (subs
->transfer_done
>= runtime
->period_size
) {
1043 subs
->transfer_done
-= runtime
->period_size
;
1046 spin_unlock_irqrestore(&subs
->lock
, flags
);
1047 /* copy a data chunk */
1048 if (oldptr
+ bytes
> runtime
->buffer_size
* stride
) {
1049 unsigned int bytes1
=
1050 runtime
->buffer_size
* stride
- oldptr
;
1051 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes1
);
1052 memcpy(runtime
->dma_area
, cp
+ bytes1
, bytes
- bytes1
);
1054 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes
);
1059 snd_pcm_period_elapsed(subs
->pcm_substream
);
1062 static void prepare_playback_urb(struct snd_usb_substream
*subs
,
1065 struct snd_pcm_runtime
*runtime
= subs
->pcm_substream
->runtime
;
1066 struct snd_usb_endpoint
*ep
= subs
->data_endpoint
;
1067 struct snd_urb_ctx
*ctx
= urb
->context
;
1068 unsigned int counts
, frames
, bytes
;
1069 int i
, stride
, period_elapsed
= 0;
1070 unsigned long flags
;
1072 stride
= runtime
->frame_bits
>> 3;
1075 urb
->number_of_packets
= 0;
1076 spin_lock_irqsave(&subs
->lock
, flags
);
1077 for (i
= 0; i
< ctx
->packets
; i
++) {
1078 if (ctx
->packet_size
[i
])
1079 counts
= ctx
->packet_size
[i
];
1081 counts
= snd_usb_endpoint_next_packet_size(ep
);
1083 /* set up descriptor */
1084 urb
->iso_frame_desc
[i
].offset
= frames
* stride
;
1085 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
1087 urb
->number_of_packets
++;
1088 subs
->transfer_done
+= counts
;
1089 if (subs
->transfer_done
>= runtime
->period_size
) {
1090 subs
->transfer_done
-= runtime
->period_size
;
1092 if (subs
->fmt_type
== UAC_FORMAT_TYPE_II
) {
1093 if (subs
->transfer_done
> 0) {
1094 /* FIXME: fill-max mode is not
1096 frames
-= subs
->transfer_done
;
1097 counts
-= subs
->transfer_done
;
1098 urb
->iso_frame_desc
[i
].length
=
1100 subs
->transfer_done
= 0;
1103 if (i
< ctx
->packets
) {
1104 /* add a transfer delimiter */
1105 urb
->iso_frame_desc
[i
].offset
=
1107 urb
->iso_frame_desc
[i
].length
= 0;
1108 urb
->number_of_packets
++;
1113 if (period_elapsed
&&
1114 !snd_usb_endpoint_implict_feedback_sink(subs
->data_endpoint
)) /* finish at the period boundary */
1117 bytes
= frames
* stride
;
1118 if (subs
->hwptr_done
+ bytes
> runtime
->buffer_size
* stride
) {
1119 /* err, the transferred area goes over buffer boundary. */
1120 unsigned int bytes1
=
1121 runtime
->buffer_size
* stride
- subs
->hwptr_done
;
1122 memcpy(urb
->transfer_buffer
,
1123 runtime
->dma_area
+ subs
->hwptr_done
, bytes1
);
1124 memcpy(urb
->transfer_buffer
+ bytes1
,
1125 runtime
->dma_area
, bytes
- bytes1
);
1127 memcpy(urb
->transfer_buffer
,
1128 runtime
->dma_area
+ subs
->hwptr_done
, bytes
);
1130 subs
->hwptr_done
+= bytes
;
1131 if (subs
->hwptr_done
>= runtime
->buffer_size
* stride
)
1132 subs
->hwptr_done
-= runtime
->buffer_size
* stride
;
1134 /* update delay with exact number of samples queued */
1135 runtime
->delay
= subs
->last_delay
;
1136 runtime
->delay
+= frames
;
1137 subs
->last_delay
= runtime
->delay
;
1139 /* realign last_frame_number */
1140 subs
->last_frame_number
= usb_get_current_frame_number(subs
->dev
);
1141 subs
->last_frame_number
&= 0xFF; /* keep 8 LSBs */
1143 spin_unlock_irqrestore(&subs
->lock
, flags
);
1144 urb
->transfer_buffer_length
= bytes
;
1146 snd_pcm_period_elapsed(subs
->pcm_substream
);
1150 * process after playback data complete
1151 * - decrease the delay count again
1153 static void retire_playback_urb(struct snd_usb_substream
*subs
,
1156 unsigned long flags
;
1157 struct snd_pcm_runtime
*runtime
= subs
->pcm_substream
->runtime
;
1158 int stride
= runtime
->frame_bits
>> 3;
1159 int processed
= urb
->transfer_buffer_length
/ stride
;
1162 /* ignore the delay accounting when procssed=0 is given, i.e.
1163 * silent payloads are procssed before handling the actual data
1168 spin_lock_irqsave(&subs
->lock
, flags
);
1169 est_delay
= snd_usb_pcm_delay(subs
, runtime
->rate
);
1170 /* update delay with exact number of samples played */
1171 if (processed
> subs
->last_delay
)
1172 subs
->last_delay
= 0;
1174 subs
->last_delay
-= processed
;
1175 runtime
->delay
= subs
->last_delay
;
1178 * Report when delay estimate is off by more than 2ms.
1179 * The error should be lower than 2ms since the estimate relies
1180 * on two reads of a counter updated every ms.
1182 if (abs(est_delay
- subs
->last_delay
) * 1000 > runtime
->rate
* 2)
1183 snd_printk(KERN_DEBUG
"delay: estimated %d, actual %d\n",
1184 est_delay
, subs
->last_delay
);
1186 spin_unlock_irqrestore(&subs
->lock
, flags
);
1189 static int snd_usb_playback_open(struct snd_pcm_substream
*substream
)
1191 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1194 static int snd_usb_playback_close(struct snd_pcm_substream
*substream
)
1196 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1199 static int snd_usb_capture_open(struct snd_pcm_substream
*substream
)
1201 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1204 static int snd_usb_capture_close(struct snd_pcm_substream
*substream
)
1206 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1209 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream
*substream
,
1212 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1215 case SNDRV_PCM_TRIGGER_START
:
1216 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
1217 subs
->data_endpoint
->prepare_data_urb
= prepare_playback_urb
;
1218 subs
->data_endpoint
->retire_data_urb
= retire_playback_urb
;
1221 case SNDRV_PCM_TRIGGER_STOP
:
1222 stop_endpoints(subs
, 0, 0, 0);
1225 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
1226 subs
->data_endpoint
->prepare_data_urb
= NULL
;
1227 subs
->data_endpoint
->retire_data_urb
= NULL
;
1235 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream
*substream
,
1239 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1242 case SNDRV_PCM_TRIGGER_START
:
1243 err
= start_endpoints(subs
, 0);
1247 subs
->data_endpoint
->retire_data_urb
= retire_capture_urb
;
1250 case SNDRV_PCM_TRIGGER_STOP
:
1251 stop_endpoints(subs
, 0, 0, 0);
1254 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
1255 subs
->data_endpoint
->retire_data_urb
= NULL
;
1258 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
1259 subs
->data_endpoint
->retire_data_urb
= retire_capture_urb
;
1267 static struct snd_pcm_ops snd_usb_playback_ops
= {
1268 .open
= snd_usb_playback_open
,
1269 .close
= snd_usb_playback_close
,
1270 .ioctl
= snd_pcm_lib_ioctl
,
1271 .hw_params
= snd_usb_hw_params
,
1272 .hw_free
= snd_usb_hw_free
,
1273 .prepare
= snd_usb_pcm_prepare
,
1274 .trigger
= snd_usb_substream_playback_trigger
,
1275 .pointer
= snd_usb_pcm_pointer
,
1276 .page
= snd_pcm_lib_get_vmalloc_page
,
1277 .mmap
= snd_pcm_lib_mmap_vmalloc
,
1280 static struct snd_pcm_ops snd_usb_capture_ops
= {
1281 .open
= snd_usb_capture_open
,
1282 .close
= snd_usb_capture_close
,
1283 .ioctl
= snd_pcm_lib_ioctl
,
1284 .hw_params
= snd_usb_hw_params
,
1285 .hw_free
= snd_usb_hw_free
,
1286 .prepare
= snd_usb_pcm_prepare
,
1287 .trigger
= snd_usb_substream_capture_trigger
,
1288 .pointer
= snd_usb_pcm_pointer
,
1289 .page
= snd_pcm_lib_get_vmalloc_page
,
1290 .mmap
= snd_pcm_lib_mmap_vmalloc
,
1293 void snd_usb_set_pcm_ops(struct snd_pcm
*pcm
, int stream
)
1295 snd_pcm_set_ops(pcm
, stream
,
1296 stream
== SNDRV_PCM_STREAM_PLAYBACK
?
1297 &snd_usb_playback_ops
: &snd_usb_capture_ops
);