2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * - async unlink should be used for avoiding the sleep inside lock.
31 * 2.4.22 usb-uhci seems buggy for async unlinking and results in
32 * oops. in such a cse, pass async_unlink=0 option.
33 * - the linked URBs would be preferred but not used so far because of
34 * the instability of unlinking.
35 * - type II is not supported properly. there is no device which supports
36 * this type *correctly*. SB extigy looks as if it supports, but it's
37 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
41 #include <linux/bitops.h>
42 #include <linux/init.h>
43 #include <linux/list.h>
44 #include <linux/slab.h>
45 #include <linux/string.h>
46 #include <linux/usb.h>
47 #include <linux/moduleparam.h>
48 #include <linux/mutex.h>
49 #include <linux/usb/audio.h>
50 #include <linux/usb/ch9.h>
52 #include <sound/core.h>
53 #include <sound/info.h>
54 #include <sound/pcm.h>
55 #include <sound/pcm_params.h>
56 #include <sound/initval.h>
61 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
62 MODULE_DESCRIPTION("USB Audio");
63 MODULE_LICENSE("GPL");
64 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
67 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
68 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
69 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
70 /* Vendor/product IDs for this card */
71 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
72 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
73 static int nrpacks
= 8; /* max. number of packets per urb */
74 static int async_unlink
= 1;
75 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card*/
76 static int ignore_ctl_error
;
78 module_param_array(index
, int, NULL
, 0444);
79 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
80 module_param_array(id
, charp
, NULL
, 0444);
81 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
82 module_param_array(enable
, bool, NULL
, 0444);
83 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
84 module_param_array(vid
, int, NULL
, 0444);
85 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
86 module_param_array(pid
, int, NULL
, 0444);
87 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
88 module_param(nrpacks
, int, 0644);
89 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
90 module_param(async_unlink
, bool, 0444);
91 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
92 module_param_array(device_setup
, int, NULL
, 0444);
93 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
94 module_param(ignore_ctl_error
, bool, 0444);
95 MODULE_PARM_DESC(ignore_ctl_error
,
96 "Ignore errors from USB controller for mixer interfaces.");
99 * debug the h/w constraints
101 /* #define HW_CONST_DEBUG */
109 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
111 #define SYNC_URBS 4 /* always four urbs for sync */
112 #define MAX_QUEUE 24 /* try not to exceed this queue length, in ms */
115 struct list_head list
;
116 snd_pcm_format_t format
; /* format type */
117 unsigned int channels
; /* # channels */
118 unsigned int fmt_type
; /* USB audio format type (1-3) */
119 unsigned int frame_size
; /* samples per frame for non-audio */
120 int iface
; /* interface number */
121 unsigned char altsetting
; /* corresponding alternate setting */
122 unsigned char altset_idx
; /* array index of altenate setting */
123 unsigned char attributes
; /* corresponding attributes of cs endpoint */
124 unsigned char endpoint
; /* endpoint */
125 unsigned char ep_attr
; /* endpoint attributes */
126 unsigned char datainterval
; /* log_2 of data packet interval */
127 unsigned int maxpacksize
; /* max. packet size */
128 unsigned int rates
; /* rate bitmasks */
129 unsigned int rate_min
, rate_max
; /* min/max rates */
130 unsigned int nr_rates
; /* number of rate table entries */
131 unsigned int *rate_table
; /* rate table */
134 struct snd_usb_substream
;
138 unsigned int buffer_size
; /* size of data buffer, if data URB */
139 struct snd_usb_substream
*subs
;
140 int index
; /* index for urb array */
141 int packets
; /* number of packets per urb */
145 int (*prepare
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
146 int (*retire
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
147 int (*prepare_sync
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
148 int (*retire_sync
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
151 struct snd_usb_substream
{
152 struct snd_usb_stream
*stream
;
153 struct usb_device
*dev
;
154 struct snd_pcm_substream
*pcm_substream
;
155 int direction
; /* playback or capture */
156 int interface
; /* current interface */
157 int endpoint
; /* assigned endpoint */
158 struct audioformat
*cur_audiofmt
; /* current audioformat pointer (for hw_params callback) */
159 unsigned int cur_rate
; /* current rate (for hw_params callback) */
160 unsigned int period_bytes
; /* current period bytes (for hw_params callback) */
161 unsigned int format
; /* USB data format */
162 unsigned int datapipe
; /* the data i/o pipe */
163 unsigned int syncpipe
; /* 1 - async out or adaptive in */
164 unsigned int datainterval
; /* log_2 of data packet interval */
165 unsigned int syncinterval
; /* P for adaptive mode, 0 otherwise */
166 unsigned int freqn
; /* nominal sampling rate in fs/fps in Q16.16 format */
167 unsigned int freqm
; /* momentary sampling rate in fs/fps in Q16.16 format */
168 unsigned int freqmax
; /* maximum sampling rate, used for buffer management */
169 unsigned int phase
; /* phase accumulator */
170 unsigned int maxpacksize
; /* max packet size in bytes */
171 unsigned int maxframesize
; /* max packet size in frames */
172 unsigned int curpacksize
; /* current packet size in bytes (for capture) */
173 unsigned int curframesize
; /* current packet size in frames (for capture) */
174 unsigned int fill_max
: 1; /* fill max packet size always */
175 unsigned int txfr_quirk
:1; /* allow sub-frame alignment */
176 unsigned int fmt_type
; /* USB audio format type (1-3) */
178 unsigned int running
: 1; /* running status */
180 unsigned int hwptr_done
; /* processed byte position in the buffer */
181 unsigned int transfer_done
; /* processed frames since last period update */
182 unsigned long active_mask
; /* bitmask of active urbs */
183 unsigned long unlink_mask
; /* bitmask of unlinked urbs */
185 unsigned int nurbs
; /* # urbs */
186 struct snd_urb_ctx dataurb
[MAX_URBS
]; /* data urb table */
187 struct snd_urb_ctx syncurb
[SYNC_URBS
]; /* sync urb table */
188 char *syncbuf
; /* sync buffer for all sync URBs */
189 dma_addr_t sync_dma
; /* DMA address of syncbuf */
191 u64 formats
; /* format bitmasks (all or'ed) */
192 unsigned int num_formats
; /* number of supported audio formats (list) */
193 struct list_head fmt_list
; /* format list */
194 struct snd_pcm_hw_constraint_list rate_list
; /* limited rates */
197 struct snd_urb_ops ops
; /* callbacks (must be filled at init) */
201 struct snd_usb_stream
{
202 struct snd_usb_audio
*chip
;
205 unsigned int fmt_type
; /* USB audio format type (1-3) */
206 struct snd_usb_substream substream
[2];
207 struct list_head list
;
212 * we keep the snd_usb_audio_t instances by ourselves for merging
213 * the all interfaces on the same card as one sound device.
216 static DEFINE_MUTEX(register_mutex
);
217 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
221 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
222 * this will overflow at approx 524 kHz
224 static inline unsigned get_usb_full_speed_rate(unsigned int rate
)
226 return ((rate
<< 13) + 62) / 125;
230 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
231 * this will overflow at approx 4 MHz
233 static inline unsigned get_usb_high_speed_rate(unsigned int rate
)
235 return ((rate
<< 10) + 62) / 125;
238 /* convert our full speed USB rate into sampling rate in Hz */
239 static inline unsigned get_full_speed_hz(unsigned int usb_rate
)
241 return (usb_rate
* 125 + (1 << 12)) >> 13;
244 /* convert our high speed USB rate into sampling rate in Hz */
245 static inline unsigned get_high_speed_hz(unsigned int usb_rate
)
247 return (usb_rate
* 125 + (1 << 9)) >> 10;
252 * prepare urb for full speed capture sync pipe
254 * fill the length and offset of each urb descriptor.
255 * the fixed 10.14 frequency is passed through the pipe.
257 static int prepare_capture_sync_urb(struct snd_usb_substream
*subs
,
258 struct snd_pcm_runtime
*runtime
,
261 unsigned char *cp
= urb
->transfer_buffer
;
262 struct snd_urb_ctx
*ctx
= urb
->context
;
264 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
265 urb
->iso_frame_desc
[0].length
= 3;
266 urb
->iso_frame_desc
[0].offset
= 0;
267 cp
[0] = subs
->freqn
>> 2;
268 cp
[1] = subs
->freqn
>> 10;
269 cp
[2] = subs
->freqn
>> 18;
274 * prepare urb for high speed capture sync pipe
276 * fill the length and offset of each urb descriptor.
277 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
279 static int prepare_capture_sync_urb_hs(struct snd_usb_substream
*subs
,
280 struct snd_pcm_runtime
*runtime
,
283 unsigned char *cp
= urb
->transfer_buffer
;
284 struct snd_urb_ctx
*ctx
= urb
->context
;
286 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
287 urb
->iso_frame_desc
[0].length
= 4;
288 urb
->iso_frame_desc
[0].offset
= 0;
290 cp
[1] = subs
->freqn
>> 8;
291 cp
[2] = subs
->freqn
>> 16;
292 cp
[3] = subs
->freqn
>> 24;
297 * process after capture sync complete
300 static int retire_capture_sync_urb(struct snd_usb_substream
*subs
,
301 struct snd_pcm_runtime
*runtime
,
308 * prepare urb for capture data pipe
310 * fill the offset and length of each descriptor.
312 * we use a temporary buffer to write the captured data.
313 * since the length of written data is determined by host, we cannot
314 * write onto the pcm buffer directly... the data is thus copied
315 * later at complete callback to the global buffer.
317 static int prepare_capture_urb(struct snd_usb_substream
*subs
,
318 struct snd_pcm_runtime
*runtime
,
322 struct snd_urb_ctx
*ctx
= urb
->context
;
325 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
326 for (i
= 0; i
< ctx
->packets
; i
++) {
327 urb
->iso_frame_desc
[i
].offset
= offs
;
328 urb
->iso_frame_desc
[i
].length
= subs
->curpacksize
;
329 offs
+= subs
->curpacksize
;
331 urb
->transfer_buffer_length
= offs
;
332 urb
->number_of_packets
= ctx
->packets
;
337 * process after capture complete
339 * copy the data from each desctiptor to the pcm buffer, and
340 * update the current position.
342 static int retire_capture_urb(struct snd_usb_substream
*subs
,
343 struct snd_pcm_runtime
*runtime
,
349 unsigned int stride
, frames
, bytes
, oldptr
;
350 int period_elapsed
= 0;
352 stride
= runtime
->frame_bits
>> 3;
354 for (i
= 0; i
< urb
->number_of_packets
; i
++) {
355 cp
= (unsigned char *)urb
->transfer_buffer
+ urb
->iso_frame_desc
[i
].offset
;
356 if (urb
->iso_frame_desc
[i
].status
) {
357 snd_printd(KERN_ERR
"frame %d active: %d\n", i
, urb
->iso_frame_desc
[i
].status
);
360 bytes
= urb
->iso_frame_desc
[i
].actual_length
;
361 frames
= bytes
/ stride
;
362 if (!subs
->txfr_quirk
)
363 bytes
= frames
* stride
;
364 if (bytes
% (runtime
->sample_bits
>> 3) != 0) {
365 #ifdef CONFIG_SND_DEBUG_VERBOSE
366 int oldbytes
= bytes
;
368 bytes
= frames
* stride
;
369 snd_printdd(KERN_ERR
"Corrected urb data len. %d->%d\n",
372 /* update the current pointer */
373 spin_lock_irqsave(&subs
->lock
, flags
);
374 oldptr
= subs
->hwptr_done
;
375 subs
->hwptr_done
+= bytes
;
376 if (subs
->hwptr_done
>= runtime
->buffer_size
* stride
)
377 subs
->hwptr_done
-= runtime
->buffer_size
* stride
;
378 frames
= (bytes
+ (oldptr
% stride
)) / stride
;
379 subs
->transfer_done
+= frames
;
380 if (subs
->transfer_done
>= runtime
->period_size
) {
381 subs
->transfer_done
-= runtime
->period_size
;
384 spin_unlock_irqrestore(&subs
->lock
, flags
);
385 /* copy a data chunk */
386 if (oldptr
+ bytes
> runtime
->buffer_size
* stride
) {
387 unsigned int bytes1
=
388 runtime
->buffer_size
* stride
- oldptr
;
389 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes1
);
390 memcpy(runtime
->dma_area
, cp
+ bytes1
, bytes
- bytes1
);
392 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes
);
396 snd_pcm_period_elapsed(subs
->pcm_substream
);
401 * Process after capture complete when paused. Nothing to do.
403 static int retire_paused_capture_urb(struct snd_usb_substream
*subs
,
404 struct snd_pcm_runtime
*runtime
,
412 * prepare urb for full speed playback sync pipe
414 * set up the offset and length to receive the current frequency.
417 static int prepare_playback_sync_urb(struct snd_usb_substream
*subs
,
418 struct snd_pcm_runtime
*runtime
,
421 struct snd_urb_ctx
*ctx
= urb
->context
;
423 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
424 urb
->iso_frame_desc
[0].length
= 3;
425 urb
->iso_frame_desc
[0].offset
= 0;
430 * prepare urb for high speed playback sync pipe
432 * set up the offset and length to receive the current frequency.
435 static int prepare_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
436 struct snd_pcm_runtime
*runtime
,
439 struct snd_urb_ctx
*ctx
= urb
->context
;
441 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
442 urb
->iso_frame_desc
[0].length
= 4;
443 urb
->iso_frame_desc
[0].offset
= 0;
448 * process after full speed playback sync complete
450 * retrieve the current 10.14 frequency from pipe, and set it.
451 * the value is referred in prepare_playback_urb().
453 static int retire_playback_sync_urb(struct snd_usb_substream
*subs
,
454 struct snd_pcm_runtime
*runtime
,
460 if (urb
->iso_frame_desc
[0].status
== 0 &&
461 urb
->iso_frame_desc
[0].actual_length
== 3) {
462 f
= combine_triple((u8
*)urb
->transfer_buffer
) << 2;
463 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
464 spin_lock_irqsave(&subs
->lock
, flags
);
466 spin_unlock_irqrestore(&subs
->lock
, flags
);
474 * process after high speed playback sync complete
476 * retrieve the current 12.13 frequency from pipe, and set it.
477 * the value is referred in prepare_playback_urb().
479 static int retire_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
480 struct snd_pcm_runtime
*runtime
,
486 if (urb
->iso_frame_desc
[0].status
== 0 &&
487 urb
->iso_frame_desc
[0].actual_length
== 4) {
488 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
489 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
490 spin_lock_irqsave(&subs
->lock
, flags
);
492 spin_unlock_irqrestore(&subs
->lock
, flags
);
500 * process after E-Mu 0202/0404/Tracker Pre high speed playback sync complete
502 * These devices return the number of samples per packet instead of the number
503 * of samples per microframe.
505 static int retire_playback_sync_urb_hs_emu(struct snd_usb_substream
*subs
,
506 struct snd_pcm_runtime
*runtime
,
512 if (urb
->iso_frame_desc
[0].status
== 0 &&
513 urb
->iso_frame_desc
[0].actual_length
== 4) {
514 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
515 f
>>= subs
->datainterval
;
516 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
517 spin_lock_irqsave(&subs
->lock
, flags
);
519 spin_unlock_irqrestore(&subs
->lock
, flags
);
526 /* determine the number of frames in the next packet */
527 static int snd_usb_audio_next_packet_size(struct snd_usb_substream
*subs
)
530 return subs
->maxframesize
;
532 subs
->phase
= (subs
->phase
& 0xffff)
533 + (subs
->freqm
<< subs
->datainterval
);
534 return min(subs
->phase
>> 16, subs
->maxframesize
);
539 * Prepare urb for streaming before playback starts or when paused.
541 * We don't have any data, so we send silence.
543 static int prepare_nodata_playback_urb(struct snd_usb_substream
*subs
,
544 struct snd_pcm_runtime
*runtime
,
547 unsigned int i
, offs
, counts
;
548 struct snd_urb_ctx
*ctx
= urb
->context
;
549 int stride
= runtime
->frame_bits
>> 3;
552 urb
->dev
= ctx
->subs
->dev
;
553 for (i
= 0; i
< ctx
->packets
; ++i
) {
554 counts
= snd_usb_audio_next_packet_size(subs
);
555 urb
->iso_frame_desc
[i
].offset
= offs
* stride
;
556 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
559 urb
->number_of_packets
= ctx
->packets
;
560 urb
->transfer_buffer_length
= offs
* stride
;
561 memset(urb
->transfer_buffer
,
562 subs
->cur_audiofmt
->format
== SNDRV_PCM_FORMAT_U8
? 0x80 : 0,
568 * prepare urb for playback data pipe
570 * Since a URB can handle only a single linear buffer, we must use double
571 * buffering when the data to be transferred overflows the buffer boundary.
572 * To avoid inconsistencies when updating hwptr_done, we use double buffering
575 static int prepare_playback_urb(struct snd_usb_substream
*subs
,
576 struct snd_pcm_runtime
*runtime
,
580 unsigned int counts
, frames
, bytes
;
582 int period_elapsed
= 0;
583 struct snd_urb_ctx
*ctx
= urb
->context
;
585 stride
= runtime
->frame_bits
>> 3;
588 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
589 urb
->number_of_packets
= 0;
590 spin_lock_irqsave(&subs
->lock
, flags
);
591 for (i
= 0; i
< ctx
->packets
; i
++) {
592 counts
= snd_usb_audio_next_packet_size(subs
);
593 /* set up descriptor */
594 urb
->iso_frame_desc
[i
].offset
= frames
* stride
;
595 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
597 urb
->number_of_packets
++;
598 subs
->transfer_done
+= counts
;
599 if (subs
->transfer_done
>= runtime
->period_size
) {
600 subs
->transfer_done
-= runtime
->period_size
;
602 if (subs
->fmt_type
== UAC_FORMAT_TYPE_II
) {
603 if (subs
->transfer_done
> 0) {
604 /* FIXME: fill-max mode is not
606 frames
-= subs
->transfer_done
;
607 counts
-= subs
->transfer_done
;
608 urb
->iso_frame_desc
[i
].length
=
610 subs
->transfer_done
= 0;
613 if (i
< ctx
->packets
) {
614 /* add a transfer delimiter */
615 urb
->iso_frame_desc
[i
].offset
=
617 urb
->iso_frame_desc
[i
].length
= 0;
618 urb
->number_of_packets
++;
623 if (period_elapsed
) /* finish at the period boundary */
626 bytes
= frames
* stride
;
627 if (subs
->hwptr_done
+ bytes
> runtime
->buffer_size
* stride
) {
628 /* err, the transferred area goes over buffer boundary. */
629 unsigned int bytes1
=
630 runtime
->buffer_size
* stride
- subs
->hwptr_done
;
631 memcpy(urb
->transfer_buffer
,
632 runtime
->dma_area
+ subs
->hwptr_done
, bytes1
);
633 memcpy(urb
->transfer_buffer
+ bytes1
,
634 runtime
->dma_area
, bytes
- bytes1
);
636 memcpy(urb
->transfer_buffer
,
637 runtime
->dma_area
+ subs
->hwptr_done
, bytes
);
639 subs
->hwptr_done
+= bytes
;
640 if (subs
->hwptr_done
>= runtime
->buffer_size
* stride
)
641 subs
->hwptr_done
-= runtime
->buffer_size
* stride
;
642 runtime
->delay
+= frames
;
643 spin_unlock_irqrestore(&subs
->lock
, flags
);
644 urb
->transfer_buffer_length
= bytes
;
646 snd_pcm_period_elapsed(subs
->pcm_substream
);
651 * process after playback data complete
652 * - decrease the delay count again
654 static int retire_playback_urb(struct snd_usb_substream
*subs
,
655 struct snd_pcm_runtime
*runtime
,
659 int stride
= runtime
->frame_bits
>> 3;
660 int processed
= urb
->transfer_buffer_length
/ stride
;
662 spin_lock_irqsave(&subs
->lock
, flags
);
663 if (processed
> runtime
->delay
)
666 runtime
->delay
-= processed
;
667 spin_unlock_irqrestore(&subs
->lock
, flags
);
674 static struct snd_urb_ops audio_urb_ops
[2] = {
676 .prepare
= prepare_nodata_playback_urb
,
677 .retire
= retire_playback_urb
,
678 .prepare_sync
= prepare_playback_sync_urb
,
679 .retire_sync
= retire_playback_sync_urb
,
682 .prepare
= prepare_capture_urb
,
683 .retire
= retire_capture_urb
,
684 .prepare_sync
= prepare_capture_sync_urb
,
685 .retire_sync
= retire_capture_sync_urb
,
689 static struct snd_urb_ops audio_urb_ops_high_speed
[2] = {
691 .prepare
= prepare_nodata_playback_urb
,
692 .retire
= retire_playback_urb
,
693 .prepare_sync
= prepare_playback_sync_urb_hs
,
694 .retire_sync
= retire_playback_sync_urb_hs
,
697 .prepare
= prepare_capture_urb
,
698 .retire
= retire_capture_urb
,
699 .prepare_sync
= prepare_capture_sync_urb_hs
,
700 .retire_sync
= retire_capture_sync_urb
,
705 * complete callback from data urb
707 static void snd_complete_urb(struct urb
*urb
)
709 struct snd_urb_ctx
*ctx
= urb
->context
;
710 struct snd_usb_substream
*subs
= ctx
->subs
;
711 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
714 if ((subs
->running
&& subs
->ops
.retire(subs
, substream
->runtime
, urb
)) ||
715 !subs
->running
|| /* can be stopped during retire callback */
716 (err
= subs
->ops
.prepare(subs
, substream
->runtime
, urb
)) < 0 ||
717 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
718 clear_bit(ctx
->index
, &subs
->active_mask
);
720 snd_printd(KERN_ERR
"cannot submit urb (err = %d)\n", err
);
721 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
728 * complete callback from sync urb
730 static void snd_complete_sync_urb(struct urb
*urb
)
732 struct snd_urb_ctx
*ctx
= urb
->context
;
733 struct snd_usb_substream
*subs
= ctx
->subs
;
734 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
737 if ((subs
->running
&& subs
->ops
.retire_sync(subs
, substream
->runtime
, urb
)) ||
738 !subs
->running
|| /* can be stopped during retire callback */
739 (err
= subs
->ops
.prepare_sync(subs
, substream
->runtime
, urb
)) < 0 ||
740 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
741 clear_bit(ctx
->index
+ 16, &subs
->active_mask
);
743 snd_printd(KERN_ERR
"cannot submit sync urb (err = %d)\n", err
);
744 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
751 * unlink active urbs.
753 static int deactivate_urbs(struct snd_usb_substream
*subs
, int force
, int can_sleep
)
760 if (!force
&& subs
->stream
->chip
->shutdown
) /* to be sure... */
763 async
= !can_sleep
&& async_unlink
;
765 if (!async
&& in_interrupt())
768 for (i
= 0; i
< subs
->nurbs
; i
++) {
769 if (test_bit(i
, &subs
->active_mask
)) {
770 if (!test_and_set_bit(i
, &subs
->unlink_mask
)) {
771 struct urb
*u
= subs
->dataurb
[i
].urb
;
779 if (subs
->syncpipe
) {
780 for (i
= 0; i
< SYNC_URBS
; i
++) {
781 if (test_bit(i
+16, &subs
->active_mask
)) {
782 if (!test_and_set_bit(i
+16, &subs
->unlink_mask
)) {
783 struct urb
*u
= subs
->syncurb
[i
].urb
;
796 static const char *usb_error_string(int err
)
802 return "endpoint not enabled";
804 return "endpoint stalled";
806 return "not enough bandwidth";
808 return "device disabled";
810 return "device suspended";
815 return "internal error";
817 return "unknown error";
822 * set up and start data/sync urbs
824 static int start_urbs(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
)
829 if (subs
->stream
->chip
->shutdown
)
832 for (i
= 0; i
< subs
->nurbs
; i
++) {
833 if (snd_BUG_ON(!subs
->dataurb
[i
].urb
))
835 if (subs
->ops
.prepare(subs
, runtime
, subs
->dataurb
[i
].urb
) < 0) {
836 snd_printk(KERN_ERR
"cannot prepare datapipe for urb %d\n", i
);
840 if (subs
->syncpipe
) {
841 for (i
= 0; i
< SYNC_URBS
; i
++) {
842 if (snd_BUG_ON(!subs
->syncurb
[i
].urb
))
844 if (subs
->ops
.prepare_sync(subs
, runtime
, subs
->syncurb
[i
].urb
) < 0) {
845 snd_printk(KERN_ERR
"cannot prepare syncpipe for urb %d\n", i
);
851 subs
->active_mask
= 0;
852 subs
->unlink_mask
= 0;
854 for (i
= 0; i
< subs
->nurbs
; i
++) {
855 err
= usb_submit_urb(subs
->dataurb
[i
].urb
, GFP_ATOMIC
);
857 snd_printk(KERN_ERR
"cannot submit datapipe "
858 "for urb %d, error %d: %s\n",
859 i
, err
, usb_error_string(err
));
862 set_bit(i
, &subs
->active_mask
);
864 if (subs
->syncpipe
) {
865 for (i
= 0; i
< SYNC_URBS
; i
++) {
866 err
= usb_submit_urb(subs
->syncurb
[i
].urb
, GFP_ATOMIC
);
868 snd_printk(KERN_ERR
"cannot submit syncpipe "
869 "for urb %d, error %d: %s\n",
870 i
, err
, usb_error_string(err
));
873 set_bit(i
+ 16, &subs
->active_mask
);
879 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
880 deactivate_urbs(subs
, 0, 0);
886 * wait until all urbs are processed.
888 static int wait_clear_urbs(struct snd_usb_substream
*subs
)
890 unsigned long end_time
= jiffies
+ msecs_to_jiffies(1000);
896 for (i
= 0; i
< subs
->nurbs
; i
++) {
897 if (test_bit(i
, &subs
->active_mask
))
900 if (subs
->syncpipe
) {
901 for (i
= 0; i
< SYNC_URBS
; i
++) {
902 if (test_bit(i
+ 16, &subs
->active_mask
))
908 schedule_timeout_uninterruptible(1);
909 } while (time_before(jiffies
, end_time
));
911 snd_printk(KERN_ERR
"timeout: still %d active urbs..\n", alive
);
917 * return the current pcm pointer. just based on the hwptr_done value.
919 static snd_pcm_uframes_t
snd_usb_pcm_pointer(struct snd_pcm_substream
*substream
)
921 struct snd_usb_substream
*subs
;
922 unsigned int hwptr_done
;
924 subs
= (struct snd_usb_substream
*)substream
->runtime
->private_data
;
925 spin_lock(&subs
->lock
);
926 hwptr_done
= subs
->hwptr_done
;
927 spin_unlock(&subs
->lock
);
928 return hwptr_done
/ (substream
->runtime
->frame_bits
>> 3);
933 * start/stop playback substream
935 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream
*substream
,
938 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
941 case SNDRV_PCM_TRIGGER_START
:
942 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
943 subs
->ops
.prepare
= prepare_playback_urb
;
945 case SNDRV_PCM_TRIGGER_STOP
:
946 return deactivate_urbs(subs
, 0, 0);
947 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
948 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
956 * start/stop capture substream
958 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream
*substream
,
961 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
964 case SNDRV_PCM_TRIGGER_START
:
965 subs
->ops
.retire
= retire_capture_urb
;
966 return start_urbs(subs
, substream
->runtime
);
967 case SNDRV_PCM_TRIGGER_STOP
:
968 return deactivate_urbs(subs
, 0, 0);
969 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
970 subs
->ops
.retire
= retire_paused_capture_urb
;
972 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
973 subs
->ops
.retire
= retire_capture_urb
;
984 static void release_urb_ctx(struct snd_urb_ctx
*u
)
988 usb_buffer_free(u
->subs
->dev
, u
->buffer_size
,
989 u
->urb
->transfer_buffer
,
990 u
->urb
->transfer_dma
);
991 usb_free_urb(u
->urb
);
997 * release a substream
999 static void release_substream_urbs(struct snd_usb_substream
*subs
, int force
)
1003 /* stop urbs (to be sure) */
1004 deactivate_urbs(subs
, force
, 1);
1005 wait_clear_urbs(subs
);
1007 for (i
= 0; i
< MAX_URBS
; i
++)
1008 release_urb_ctx(&subs
->dataurb
[i
]);
1009 for (i
= 0; i
< SYNC_URBS
; i
++)
1010 release_urb_ctx(&subs
->syncurb
[i
]);
1011 usb_buffer_free(subs
->dev
, SYNC_URBS
* 4,
1012 subs
->syncbuf
, subs
->sync_dma
);
1013 subs
->syncbuf
= NULL
;
1018 * initialize a substream for plaback/capture
1020 static int init_substream_urbs(struct snd_usb_substream
*subs
, unsigned int period_bytes
,
1021 unsigned int rate
, unsigned int frame_bits
)
1023 unsigned int maxsize
, i
;
1024 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1025 unsigned int urb_packs
, total_packs
, packs_per_ms
;
1027 /* calculate the frequency in 16.16 format */
1028 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1029 subs
->freqn
= get_usb_full_speed_rate(rate
);
1031 subs
->freqn
= get_usb_high_speed_rate(rate
);
1032 subs
->freqm
= subs
->freqn
;
1033 /* calculate max. frequency */
1034 if (subs
->maxpacksize
) {
1035 /* whatever fits into a max. size packet */
1036 maxsize
= subs
->maxpacksize
;
1037 subs
->freqmax
= (maxsize
/ (frame_bits
>> 3))
1038 << (16 - subs
->datainterval
);
1040 /* no max. packet size: just take 25% higher than nominal */
1041 subs
->freqmax
= subs
->freqn
+ (subs
->freqn
>> 2);
1042 maxsize
= ((subs
->freqmax
+ 0xffff) * (frame_bits
>> 3))
1043 >> (16 - subs
->datainterval
);
1048 subs
->curpacksize
= subs
->maxpacksize
;
1050 subs
->curpacksize
= maxsize
;
1052 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
)
1053 packs_per_ms
= 8 >> subs
->datainterval
;
1058 urb_packs
= max(nrpacks
, 1);
1059 urb_packs
= min(urb_packs
, (unsigned int)MAX_PACKS
);
1062 urb_packs
*= packs_per_ms
;
1064 urb_packs
= min(urb_packs
, 1U << subs
->syncinterval
);
1066 /* decide how many packets to be used */
1068 unsigned int minsize
, maxpacks
;
1069 /* determine how small a packet can be */
1070 minsize
= (subs
->freqn
>> (16 - subs
->datainterval
))
1071 * (frame_bits
>> 3);
1072 /* with sync from device, assume it can be 12% lower */
1074 minsize
-= minsize
>> 3;
1075 minsize
= max(minsize
, 1u);
1076 total_packs
= (period_bytes
+ minsize
- 1) / minsize
;
1077 /* we need at least two URBs for queueing */
1078 if (total_packs
< 2) {
1081 /* and we don't want too long a queue either */
1082 maxpacks
= max(MAX_QUEUE
* packs_per_ms
, urb_packs
* 2);
1083 total_packs
= min(total_packs
, maxpacks
);
1086 while (urb_packs
> 1 && urb_packs
* maxsize
>= period_bytes
)
1088 total_packs
= MAX_URBS
* urb_packs
;
1090 subs
->nurbs
= (total_packs
+ urb_packs
- 1) / urb_packs
;
1091 if (subs
->nurbs
> MAX_URBS
) {
1093 subs
->nurbs
= MAX_URBS
;
1094 total_packs
= MAX_URBS
* urb_packs
;
1095 } else if (subs
->nurbs
< 2) {
1096 /* too little - we need at least two packets
1097 * to ensure contiguous playback/capture
1102 /* allocate and initialize data urbs */
1103 for (i
= 0; i
< subs
->nurbs
; i
++) {
1104 struct snd_urb_ctx
*u
= &subs
->dataurb
[i
];
1107 u
->packets
= (i
+ 1) * total_packs
/ subs
->nurbs
1108 - i
* total_packs
/ subs
->nurbs
;
1109 u
->buffer_size
= maxsize
* u
->packets
;
1110 if (subs
->fmt_type
== UAC_FORMAT_TYPE_II
)
1111 u
->packets
++; /* for transfer delimiter */
1112 u
->urb
= usb_alloc_urb(u
->packets
, GFP_KERNEL
);
1115 u
->urb
->transfer_buffer
=
1116 usb_buffer_alloc(subs
->dev
, u
->buffer_size
, GFP_KERNEL
,
1117 &u
->urb
->transfer_dma
);
1118 if (!u
->urb
->transfer_buffer
)
1120 u
->urb
->pipe
= subs
->datapipe
;
1121 u
->urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1122 u
->urb
->interval
= 1 << subs
->datainterval
;
1123 u
->urb
->context
= u
;
1124 u
->urb
->complete
= snd_complete_urb
;
1127 if (subs
->syncpipe
) {
1128 /* allocate and initialize sync urbs */
1129 subs
->syncbuf
= usb_buffer_alloc(subs
->dev
, SYNC_URBS
* 4,
1130 GFP_KERNEL
, &subs
->sync_dma
);
1133 for (i
= 0; i
< SYNC_URBS
; i
++) {
1134 struct snd_urb_ctx
*u
= &subs
->syncurb
[i
];
1138 u
->urb
= usb_alloc_urb(1, GFP_KERNEL
);
1141 u
->urb
->transfer_buffer
= subs
->syncbuf
+ i
* 4;
1142 u
->urb
->transfer_dma
= subs
->sync_dma
+ i
* 4;
1143 u
->urb
->transfer_buffer_length
= 4;
1144 u
->urb
->pipe
= subs
->syncpipe
;
1145 u
->urb
->transfer_flags
= URB_ISO_ASAP
|
1146 URB_NO_TRANSFER_DMA_MAP
;
1147 u
->urb
->number_of_packets
= 1;
1148 u
->urb
->interval
= 1 << subs
->syncinterval
;
1149 u
->urb
->context
= u
;
1150 u
->urb
->complete
= snd_complete_sync_urb
;
1156 release_substream_urbs(subs
, 0);
1162 * find a matching audio format
1164 static struct audioformat
*find_format(struct snd_usb_substream
*subs
, unsigned int format
,
1165 unsigned int rate
, unsigned int channels
)
1167 struct list_head
*p
;
1168 struct audioformat
*found
= NULL
;
1169 int cur_attr
= 0, attr
;
1171 list_for_each(p
, &subs
->fmt_list
) {
1172 struct audioformat
*fp
;
1173 fp
= list_entry(p
, struct audioformat
, list
);
1174 if (fp
->format
!= format
|| fp
->channels
!= channels
)
1176 if (rate
< fp
->rate_min
|| rate
> fp
->rate_max
)
1178 if (! (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)) {
1180 for (i
= 0; i
< fp
->nr_rates
; i
++)
1181 if (fp
->rate_table
[i
] == rate
)
1183 if (i
>= fp
->nr_rates
)
1186 attr
= fp
->ep_attr
& USB_ENDPOINT_SYNCTYPE
;
1192 /* avoid async out and adaptive in if the other method
1193 * supports the same format.
1194 * this is a workaround for the case like
1195 * M-audio audiophile USB.
1197 if (attr
!= cur_attr
) {
1198 if ((attr
== USB_ENDPOINT_SYNC_ASYNC
&&
1199 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1200 (attr
== USB_ENDPOINT_SYNC_ADAPTIVE
&&
1201 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
))
1203 if ((cur_attr
== USB_ENDPOINT_SYNC_ASYNC
&&
1204 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1205 (cur_attr
== USB_ENDPOINT_SYNC_ADAPTIVE
&&
1206 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
)) {
1212 /* find the format with the largest max. packet size */
1213 if (fp
->maxpacksize
> found
->maxpacksize
) {
1223 * initialize the picth control and sample rate
1225 static int init_usb_pitch(struct usb_device
*dev
, int iface
,
1226 struct usb_host_interface
*alts
,
1227 struct audioformat
*fmt
)
1230 unsigned char data
[1];
1233 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1234 /* if endpoint has pitch control, enable it */
1235 if (fmt
->attributes
& UAC_EP_CS_ATTR_PITCH_CONTROL
) {
1237 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
1238 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1239 UAC_EP_CS_ATTR_PITCH_CONTROL
<< 8, ep
, data
, 1, 1000)) < 0) {
1240 snd_printk(KERN_ERR
"%d:%d:%d: cannot set enable PITCH\n",
1241 dev
->devnum
, iface
, ep
);
1248 static int init_usb_sample_rate(struct usb_device
*dev
, int iface
,
1249 struct usb_host_interface
*alts
,
1250 struct audioformat
*fmt
, int rate
)
1253 unsigned char data
[3];
1256 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1257 /* if endpoint has sampling rate control, set it */
1258 if (fmt
->attributes
& UAC_EP_CS_ATTR_SAMPLE_RATE
) {
1261 data
[1] = rate
>> 8;
1262 data
[2] = rate
>> 16;
1263 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
1264 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1265 UAC_EP_CS_ATTR_SAMPLE_RATE
<< 8, ep
, data
, 3, 1000)) < 0) {
1266 snd_printk(KERN_ERR
"%d:%d:%d: cannot set freq %d to ep %#x\n",
1267 dev
->devnum
, iface
, fmt
->altsetting
, rate
, ep
);
1270 if ((err
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), UAC_GET_CUR
,
1271 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_IN
,
1272 UAC_EP_CS_ATTR_SAMPLE_RATE
<< 8, ep
, data
, 3, 1000)) < 0) {
1273 snd_printk(KERN_WARNING
"%d:%d:%d: cannot get freq at ep %#x\n",
1274 dev
->devnum
, iface
, fmt
->altsetting
, ep
);
1275 return 0; /* some devices don't support reading */
1277 crate
= data
[0] | (data
[1] << 8) | (data
[2] << 16);
1278 if (crate
!= rate
) {
1279 snd_printd(KERN_WARNING
"current rate %d is different from the runtime rate %d\n", crate
, rate
);
1280 // runtime->rate = crate;
1287 * For E-Mu 0404USB/0202USB/TrackerPre sample rate should be set for device,
1288 * not for interface.
1290 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1291 struct audioformat
*fmt
)
1293 unsigned char emu_samplerate_id
= 0;
1295 /* When capture is active
1296 * sample rate shouldn't be changed
1297 * by playback substream
1299 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1300 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1304 switch (fmt
->rate_min
) {
1306 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1309 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1312 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1315 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1318 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1321 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1324 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1328 * find a matching format and set up the interface
1330 static int set_format(struct snd_usb_substream
*subs
, struct audioformat
*fmt
)
1332 struct usb_device
*dev
= subs
->dev
;
1333 struct usb_host_interface
*alts
;
1334 struct usb_interface_descriptor
*altsd
;
1335 struct usb_interface
*iface
;
1336 unsigned int ep
, attr
;
1337 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1340 iface
= usb_ifnum_to_if(dev
, fmt
->iface
);
1341 if (WARN_ON(!iface
))
1343 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1344 altsd
= get_iface_desc(alts
);
1345 if (WARN_ON(altsd
->bAlternateSetting
!= fmt
->altsetting
))
1348 if (fmt
== subs
->cur_audiofmt
)
1351 /* close the old interface */
1352 if (subs
->interface
>= 0 && subs
->interface
!= fmt
->iface
) {
1353 if (usb_set_interface(subs
->dev
, subs
->interface
, 0) < 0) {
1354 snd_printk(KERN_ERR
"%d:%d:%d: return to setting 0 failed\n",
1355 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1358 subs
->interface
= -1;
1363 if (subs
->interface
!= fmt
->iface
|| subs
->format
!= fmt
->altset_idx
) {
1364 if (usb_set_interface(dev
, fmt
->iface
, fmt
->altsetting
) < 0) {
1365 snd_printk(KERN_ERR
"%d:%d:%d: usb_set_interface failed\n",
1366 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1369 snd_printdd(KERN_INFO
"setting usb interface %d:%d\n", fmt
->iface
, fmt
->altsetting
);
1370 subs
->interface
= fmt
->iface
;
1371 subs
->format
= fmt
->altset_idx
;
1374 /* create a data pipe */
1375 ep
= fmt
->endpoint
& USB_ENDPOINT_NUMBER_MASK
;
1377 subs
->datapipe
= usb_sndisocpipe(dev
, ep
);
1379 subs
->datapipe
= usb_rcvisocpipe(dev
, ep
);
1380 subs
->datainterval
= fmt
->datainterval
;
1381 subs
->syncpipe
= subs
->syncinterval
= 0;
1382 subs
->maxpacksize
= fmt
->maxpacksize
;
1385 /* we need a sync pipe in async OUT or adaptive IN mode */
1386 /* check the number of EP, since some devices have broken
1387 * descriptors which fool us. if it has only one EP,
1388 * assume it as adaptive-out or sync-in.
1390 attr
= fmt
->ep_attr
& USB_ENDPOINT_SYNCTYPE
;
1391 if (((is_playback
&& attr
== USB_ENDPOINT_SYNC_ASYNC
) ||
1392 (! is_playback
&& attr
== USB_ENDPOINT_SYNC_ADAPTIVE
)) &&
1393 altsd
->bNumEndpoints
>= 2) {
1394 /* check sync-pipe endpoint */
1395 /* ... and check descriptor size before accessing bSynchAddress
1396 because there is a version of the SB Audigy 2 NX firmware lacking
1397 the audio fields in the endpoint descriptors */
1398 if ((get_endpoint(alts
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != 0x01 ||
1399 (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1400 get_endpoint(alts
, 1)->bSynchAddress
!= 0)) {
1401 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1402 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1405 ep
= get_endpoint(alts
, 1)->bEndpointAddress
;
1406 if (get_endpoint(alts
, 0)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1407 (( is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
| USB_DIR_IN
)) ||
1408 (!is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
& ~USB_DIR_IN
)))) {
1409 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1410 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1413 ep
&= USB_ENDPOINT_NUMBER_MASK
;
1415 subs
->syncpipe
= usb_rcvisocpipe(dev
, ep
);
1417 subs
->syncpipe
= usb_sndisocpipe(dev
, ep
);
1418 if (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1419 get_endpoint(alts
, 1)->bRefresh
>= 1 &&
1420 get_endpoint(alts
, 1)->bRefresh
<= 9)
1421 subs
->syncinterval
= get_endpoint(alts
, 1)->bRefresh
;
1422 else if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1423 subs
->syncinterval
= 1;
1424 else if (get_endpoint(alts
, 1)->bInterval
>= 1 &&
1425 get_endpoint(alts
, 1)->bInterval
<= 16)
1426 subs
->syncinterval
= get_endpoint(alts
, 1)->bInterval
- 1;
1428 subs
->syncinterval
= 3;
1431 /* always fill max packet size */
1432 if (fmt
->attributes
& UAC_EP_CS_ATTR_FILL_MAX
)
1435 if ((err
= init_usb_pitch(dev
, subs
->interface
, alts
, fmt
)) < 0)
1438 subs
->cur_audiofmt
= fmt
;
1440 switch (subs
->stream
->chip
->usb_id
) {
1441 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1442 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1443 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1444 set_format_emu_quirk(subs
, fmt
);
1450 "setting done: format = %d, rate = %d..%d, channels = %d\n",
1451 fmt
->format
, fmt
->rate_min
, fmt
->rate_max
, fmt
->channels
);
1453 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
1454 subs
->datapipe
, subs
->syncpipe
);
1461 * hw_params callback
1463 * allocate a buffer and set the given audio format.
1465 * so far we use a physically linear buffer although packetize transfer
1466 * doesn't need a continuous area.
1467 * if sg buffer is supported on the later version of alsa, we'll follow
1470 static int snd_usb_hw_params(struct snd_pcm_substream
*substream
,
1471 struct snd_pcm_hw_params
*hw_params
)
1473 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1474 struct audioformat
*fmt
;
1475 unsigned int channels
, rate
, format
;
1478 ret
= snd_pcm_lib_alloc_vmalloc_buffer(substream
,
1479 params_buffer_bytes(hw_params
));
1483 format
= params_format(hw_params
);
1484 rate
= params_rate(hw_params
);
1485 channels
= params_channels(hw_params
);
1486 fmt
= find_format(subs
, format
, rate
, channels
);
1488 snd_printd(KERN_DEBUG
"cannot set format: format = %#x, rate = %d, channels = %d\n",
1489 format
, rate
, channels
);
1493 changed
= subs
->cur_audiofmt
!= fmt
||
1494 subs
->period_bytes
!= params_period_bytes(hw_params
) ||
1495 subs
->cur_rate
!= rate
;
1496 if ((ret
= set_format(subs
, fmt
)) < 0)
1499 if (subs
->cur_rate
!= rate
) {
1500 struct usb_host_interface
*alts
;
1501 struct usb_interface
*iface
;
1502 iface
= usb_ifnum_to_if(subs
->dev
, fmt
->iface
);
1503 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1504 ret
= init_usb_sample_rate(subs
->dev
, subs
->interface
, alts
, fmt
, rate
);
1507 subs
->cur_rate
= rate
;
1511 /* format changed */
1512 release_substream_urbs(subs
, 0);
1513 /* influenced: period_bytes, channels, rate, format, */
1514 ret
= init_substream_urbs(subs
, params_period_bytes(hw_params
),
1515 params_rate(hw_params
),
1516 snd_pcm_format_physical_width(params_format(hw_params
)) * params_channels(hw_params
));
1525 * reset the audio format and release the buffer
1527 static int snd_usb_hw_free(struct snd_pcm_substream
*substream
)
1529 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1531 subs
->cur_audiofmt
= NULL
;
1533 subs
->period_bytes
= 0;
1534 if (!subs
->stream
->chip
->shutdown
)
1535 release_substream_urbs(subs
, 0);
1536 return snd_pcm_lib_free_vmalloc_buffer(substream
);
1542 * only a few subtle things...
1544 static int snd_usb_pcm_prepare(struct snd_pcm_substream
*substream
)
1546 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1547 struct snd_usb_substream
*subs
= runtime
->private_data
;
1549 if (! subs
->cur_audiofmt
) {
1550 snd_printk(KERN_ERR
"usbaudio: no format is specified!\n");
1554 /* some unit conversions in runtime */
1555 subs
->maxframesize
= bytes_to_frames(runtime
, subs
->maxpacksize
);
1556 subs
->curframesize
= bytes_to_frames(runtime
, subs
->curpacksize
);
1558 /* reset the pointer */
1559 subs
->hwptr_done
= 0;
1560 subs
->transfer_done
= 0;
1564 /* clear urbs (to be sure) */
1565 deactivate_urbs(subs
, 0, 1);
1566 wait_clear_urbs(subs
);
1568 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1569 * updates for all URBs would happen at the same time when starting */
1570 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1571 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
1572 return start_urbs(subs
, runtime
);
1577 static struct snd_pcm_hardware snd_usb_hardware
=
1579 .info
= SNDRV_PCM_INFO_MMAP
|
1580 SNDRV_PCM_INFO_MMAP_VALID
|
1581 SNDRV_PCM_INFO_BATCH
|
1582 SNDRV_PCM_INFO_INTERLEAVED
|
1583 SNDRV_PCM_INFO_BLOCK_TRANSFER
|
1584 SNDRV_PCM_INFO_PAUSE
,
1585 .buffer_bytes_max
= 1024 * 1024,
1586 .period_bytes_min
= 64,
1587 .period_bytes_max
= 512 * 1024,
1589 .periods_max
= 1024,
1596 #ifdef HW_CONST_DEBUG
1597 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1599 #define hwc_debug(fmt, args...) /**/
1602 static int hw_check_valid_format(struct snd_usb_substream
*subs
,
1603 struct snd_pcm_hw_params
*params
,
1604 struct audioformat
*fp
)
1606 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1607 struct snd_interval
*ct
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1608 struct snd_mask
*fmts
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1609 struct snd_interval
*pt
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
);
1612 /* check the format */
1613 if (!snd_mask_test(fmts
, fp
->format
)) {
1614 hwc_debug(" > check: no supported format %d\n", fp
->format
);
1617 /* check the channels */
1618 if (fp
->channels
< ct
->min
|| fp
->channels
> ct
->max
) {
1619 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp
->channels
, ct
->min
, ct
->max
);
1622 /* check the rate is within the range */
1623 if (fp
->rate_min
> it
->max
|| (fp
->rate_min
== it
->max
&& it
->openmax
)) {
1624 hwc_debug(" > check: rate_min %d > max %d\n", fp
->rate_min
, it
->max
);
1627 if (fp
->rate_max
< it
->min
|| (fp
->rate_max
== it
->min
&& it
->openmin
)) {
1628 hwc_debug(" > check: rate_max %d < min %d\n", fp
->rate_max
, it
->min
);
1631 /* check whether the period time is >= the data packet interval */
1632 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
) {
1633 ptime
= 125 * (1 << fp
->datainterval
);
1634 if (ptime
> pt
->max
|| (ptime
== pt
->max
&& pt
->openmax
)) {
1635 hwc_debug(" > check: ptime %u > max %u\n", ptime
, pt
->max
);
1642 static int hw_rule_rate(struct snd_pcm_hw_params
*params
,
1643 struct snd_pcm_hw_rule
*rule
)
1645 struct snd_usb_substream
*subs
= rule
->private;
1646 struct list_head
*p
;
1647 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1648 unsigned int rmin
, rmax
;
1651 hwc_debug("hw_rule_rate: (%d,%d)\n", it
->min
, it
->max
);
1654 list_for_each(p
, &subs
->fmt_list
) {
1655 struct audioformat
*fp
;
1656 fp
= list_entry(p
, struct audioformat
, list
);
1657 if (!hw_check_valid_format(subs
, params
, fp
))
1660 if (rmin
> fp
->rate_min
)
1661 rmin
= fp
->rate_min
;
1662 if (rmax
< fp
->rate_max
)
1663 rmax
= fp
->rate_max
;
1665 rmin
= fp
->rate_min
;
1666 rmax
= fp
->rate_max
;
1671 hwc_debug(" --> get empty\n");
1677 if (it
->min
< rmin
) {
1682 if (it
->max
> rmax
) {
1687 if (snd_interval_checkempty(it
)) {
1691 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1696 static int hw_rule_channels(struct snd_pcm_hw_params
*params
,
1697 struct snd_pcm_hw_rule
*rule
)
1699 struct snd_usb_substream
*subs
= rule
->private;
1700 struct list_head
*p
;
1701 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1702 unsigned int rmin
, rmax
;
1705 hwc_debug("hw_rule_channels: (%d,%d)\n", it
->min
, it
->max
);
1708 list_for_each(p
, &subs
->fmt_list
) {
1709 struct audioformat
*fp
;
1710 fp
= list_entry(p
, struct audioformat
, list
);
1711 if (!hw_check_valid_format(subs
, params
, fp
))
1714 if (rmin
> fp
->channels
)
1715 rmin
= fp
->channels
;
1716 if (rmax
< fp
->channels
)
1717 rmax
= fp
->channels
;
1719 rmin
= fp
->channels
;
1720 rmax
= fp
->channels
;
1725 hwc_debug(" --> get empty\n");
1731 if (it
->min
< rmin
) {
1736 if (it
->max
> rmax
) {
1741 if (snd_interval_checkempty(it
)) {
1745 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1749 static int hw_rule_format(struct snd_pcm_hw_params
*params
,
1750 struct snd_pcm_hw_rule
*rule
)
1752 struct snd_usb_substream
*subs
= rule
->private;
1753 struct list_head
*p
;
1754 struct snd_mask
*fmt
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1759 hwc_debug("hw_rule_format: %x:%x\n", fmt
->bits
[0], fmt
->bits
[1]);
1761 list_for_each(p
, &subs
->fmt_list
) {
1762 struct audioformat
*fp
;
1763 fp
= list_entry(p
, struct audioformat
, list
);
1764 if (!hw_check_valid_format(subs
, params
, fp
))
1766 fbits
|= (1ULL << fp
->format
);
1769 oldbits
[0] = fmt
->bits
[0];
1770 oldbits
[1] = fmt
->bits
[1];
1771 fmt
->bits
[0] &= (u32
)fbits
;
1772 fmt
->bits
[1] &= (u32
)(fbits
>> 32);
1773 if (!fmt
->bits
[0] && !fmt
->bits
[1]) {
1774 hwc_debug(" --> get empty\n");
1777 changed
= (oldbits
[0] != fmt
->bits
[0] || oldbits
[1] != fmt
->bits
[1]);
1778 hwc_debug(" --> %x:%x (changed = %d)\n", fmt
->bits
[0], fmt
->bits
[1], changed
);
1782 static int hw_rule_period_time(struct snd_pcm_hw_params
*params
,
1783 struct snd_pcm_hw_rule
*rule
)
1785 struct snd_usb_substream
*subs
= rule
->private;
1786 struct audioformat
*fp
;
1787 struct snd_interval
*it
;
1788 unsigned char min_datainterval
;
1792 it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
);
1793 hwc_debug("hw_rule_period_time: (%u,%u)\n", it
->min
, it
->max
);
1794 min_datainterval
= 0xff;
1795 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1796 if (!hw_check_valid_format(subs
, params
, fp
))
1798 min_datainterval
= min(min_datainterval
, fp
->datainterval
);
1800 if (min_datainterval
== 0xff) {
1801 hwc_debug(" --> get emtpy\n");
1805 pmin
= 125 * (1 << min_datainterval
);
1807 if (it
->min
< pmin
) {
1812 if (snd_interval_checkempty(it
)) {
1816 hwc_debug(" --> (%u,%u) (changed = %d)\n", it
->min
, it
->max
, changed
);
1821 * If the device supports unusual bit rates, does the request meet these?
1823 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime
*runtime
,
1824 struct snd_usb_substream
*subs
)
1826 struct audioformat
*fp
;
1827 int count
= 0, needs_knot
= 0;
1830 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1831 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
1833 count
+= fp
->nr_rates
;
1834 if (fp
->rates
& SNDRV_PCM_RATE_KNOT
)
1840 subs
->rate_list
.count
= count
;
1841 subs
->rate_list
.list
= kmalloc(sizeof(int) * count
, GFP_KERNEL
);
1842 subs
->rate_list
.mask
= 0;
1844 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1846 for (i
= 0; i
< fp
->nr_rates
; i
++)
1847 subs
->rate_list
.list
[count
++] = fp
->rate_table
[i
];
1849 err
= snd_pcm_hw_constraint_list(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1859 * set up the runtime hardware information.
1862 static int setup_hw_info(struct snd_pcm_runtime
*runtime
, struct snd_usb_substream
*subs
)
1864 struct list_head
*p
;
1865 unsigned int pt
, ptmin
;
1866 int param_period_time_if_needed
;
1869 runtime
->hw
.formats
= subs
->formats
;
1871 runtime
->hw
.rate_min
= 0x7fffffff;
1872 runtime
->hw
.rate_max
= 0;
1873 runtime
->hw
.channels_min
= 256;
1874 runtime
->hw
.channels_max
= 0;
1875 runtime
->hw
.rates
= 0;
1877 /* check min/max rates and channels */
1878 list_for_each(p
, &subs
->fmt_list
) {
1879 struct audioformat
*fp
;
1880 fp
= list_entry(p
, struct audioformat
, list
);
1881 runtime
->hw
.rates
|= fp
->rates
;
1882 if (runtime
->hw
.rate_min
> fp
->rate_min
)
1883 runtime
->hw
.rate_min
= fp
->rate_min
;
1884 if (runtime
->hw
.rate_max
< fp
->rate_max
)
1885 runtime
->hw
.rate_max
= fp
->rate_max
;
1886 if (runtime
->hw
.channels_min
> fp
->channels
)
1887 runtime
->hw
.channels_min
= fp
->channels
;
1888 if (runtime
->hw
.channels_max
< fp
->channels
)
1889 runtime
->hw
.channels_max
= fp
->channels
;
1890 if (fp
->fmt_type
== UAC_FORMAT_TYPE_II
&& fp
->frame_size
> 0) {
1891 /* FIXME: there might be more than one audio formats... */
1892 runtime
->hw
.period_bytes_min
= runtime
->hw
.period_bytes_max
=
1895 pt
= 125 * (1 << fp
->datainterval
);
1896 ptmin
= min(ptmin
, pt
);
1899 param_period_time_if_needed
= SNDRV_PCM_HW_PARAM_PERIOD_TIME
;
1900 if (snd_usb_get_speed(subs
->dev
) != USB_SPEED_HIGH
)
1901 /* full speed devices have fixed data packet interval */
1904 /* if period time doesn't go below 1 ms, no rules needed */
1905 param_period_time_if_needed
= -1;
1906 snd_pcm_hw_constraint_minmax(runtime
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
1909 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1911 SNDRV_PCM_HW_PARAM_FORMAT
,
1912 SNDRV_PCM_HW_PARAM_CHANNELS
,
1913 param_period_time_if_needed
,
1916 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_CHANNELS
,
1917 hw_rule_channels
, subs
,
1918 SNDRV_PCM_HW_PARAM_FORMAT
,
1919 SNDRV_PCM_HW_PARAM_RATE
,
1920 param_period_time_if_needed
,
1923 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_FORMAT
,
1924 hw_rule_format
, subs
,
1925 SNDRV_PCM_HW_PARAM_RATE
,
1926 SNDRV_PCM_HW_PARAM_CHANNELS
,
1927 param_period_time_if_needed
,
1930 if (param_period_time_if_needed
>= 0) {
1931 err
= snd_pcm_hw_rule_add(runtime
, 0,
1932 SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
1933 hw_rule_period_time
, subs
,
1934 SNDRV_PCM_HW_PARAM_FORMAT
,
1935 SNDRV_PCM_HW_PARAM_CHANNELS
,
1936 SNDRV_PCM_HW_PARAM_RATE
,
1941 if ((err
= snd_usb_pcm_check_knot(runtime
, subs
)) < 0)
1946 static int snd_usb_pcm_open(struct snd_pcm_substream
*substream
, int direction
)
1948 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1949 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1950 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1952 subs
->interface
= -1;
1954 runtime
->hw
= snd_usb_hardware
;
1955 runtime
->private_data
= subs
;
1956 subs
->pcm_substream
= substream
;
1957 return setup_hw_info(runtime
, subs
);
1960 static int snd_usb_pcm_close(struct snd_pcm_substream
*substream
, int direction
)
1962 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1963 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1965 if (!as
->chip
->shutdown
&& subs
->interface
>= 0) {
1966 usb_set_interface(subs
->dev
, subs
->interface
, 0);
1967 subs
->interface
= -1;
1969 subs
->pcm_substream
= NULL
;
1973 static int snd_usb_playback_open(struct snd_pcm_substream
*substream
)
1975 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1978 static int snd_usb_playback_close(struct snd_pcm_substream
*substream
)
1980 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1983 static int snd_usb_capture_open(struct snd_pcm_substream
*substream
)
1985 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1988 static int snd_usb_capture_close(struct snd_pcm_substream
*substream
)
1990 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1993 static struct snd_pcm_ops snd_usb_playback_ops
= {
1994 .open
= snd_usb_playback_open
,
1995 .close
= snd_usb_playback_close
,
1996 .ioctl
= snd_pcm_lib_ioctl
,
1997 .hw_params
= snd_usb_hw_params
,
1998 .hw_free
= snd_usb_hw_free
,
1999 .prepare
= snd_usb_pcm_prepare
,
2000 .trigger
= snd_usb_pcm_playback_trigger
,
2001 .pointer
= snd_usb_pcm_pointer
,
2002 .page
= snd_pcm_lib_get_vmalloc_page
,
2003 .mmap
= snd_pcm_lib_mmap_vmalloc
,
2006 static struct snd_pcm_ops snd_usb_capture_ops
= {
2007 .open
= snd_usb_capture_open
,
2008 .close
= snd_usb_capture_close
,
2009 .ioctl
= snd_pcm_lib_ioctl
,
2010 .hw_params
= snd_usb_hw_params
,
2011 .hw_free
= snd_usb_hw_free
,
2012 .prepare
= snd_usb_pcm_prepare
,
2013 .trigger
= snd_usb_pcm_capture_trigger
,
2014 .pointer
= snd_usb_pcm_pointer
,
2015 .page
= snd_pcm_lib_get_vmalloc_page
,
2016 .mmap
= snd_pcm_lib_mmap_vmalloc
,
2026 * combine bytes and get an integer value
2028 unsigned int snd_usb_combine_bytes(unsigned char *bytes
, int size
)
2031 case 1: return *bytes
;
2032 case 2: return combine_word(bytes
);
2033 case 3: return combine_triple(bytes
);
2034 case 4: return combine_quad(bytes
);
2040 * parse descriptor buffer and return the pointer starting the given
2043 void *snd_usb_find_desc(void *descstart
, int desclen
, void *after
, u8 dtype
)
2055 if (p
[1] == dtype
&& (!after
|| (void *)p
> after
)) {
2064 * find a class-specified interface descriptor with the given subtype.
2066 void *snd_usb_find_csint_desc(void *buffer
, int buflen
, void *after
, u8 dsubtype
)
2068 unsigned char *p
= after
;
2070 while ((p
= snd_usb_find_desc(buffer
, buflen
, p
,
2071 USB_DT_CS_INTERFACE
)) != NULL
) {
2072 if (p
[0] >= 3 && p
[2] == dsubtype
)
2079 * Wrapper for usb_control_msg().
2080 * Allocates a temp buffer to prevent dmaing from/to the stack.
2082 int snd_usb_ctl_msg(struct usb_device
*dev
, unsigned int pipe
, __u8 request
,
2083 __u8 requesttype
, __u16 value
, __u16 index
, void *data
,
2084 __u16 size
, int timeout
)
2090 buf
= kmemdup(data
, size
, GFP_KERNEL
);
2094 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
2095 value
, index
, buf
, size
, timeout
);
2097 memcpy(data
, buf
, size
);
2105 * entry point for linux usb interface
2108 static int usb_audio_probe(struct usb_interface
*intf
,
2109 const struct usb_device_id
*id
);
2110 static void usb_audio_disconnect(struct usb_interface
*intf
);
2113 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
);
2114 static int usb_audio_resume(struct usb_interface
*intf
);
2116 #define usb_audio_suspend NULL
2117 #define usb_audio_resume NULL
2120 static struct usb_device_id usb_audio_ids
[] = {
2121 #include "usbquirks.h"
2122 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
2123 .bInterfaceClass
= USB_CLASS_AUDIO
,
2124 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
2125 { } /* Terminating entry */
2128 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
2130 static struct usb_driver usb_audio_driver
= {
2131 .name
= "snd-usb-audio",
2132 .probe
= usb_audio_probe
,
2133 .disconnect
= usb_audio_disconnect
,
2134 .suspend
= usb_audio_suspend
,
2135 .resume
= usb_audio_resume
,
2136 .id_table
= usb_audio_ids
,
2140 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2143 * proc interface for list the supported pcm formats
2145 static void proc_dump_substream_formats(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2147 struct list_head
*p
;
2148 static char *sync_types
[4] = {
2149 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2152 list_for_each(p
, &subs
->fmt_list
) {
2153 struct audioformat
*fp
;
2154 fp
= list_entry(p
, struct audioformat
, list
);
2155 snd_iprintf(buffer
, " Interface %d\n", fp
->iface
);
2156 snd_iprintf(buffer
, " Altset %d\n", fp
->altsetting
);
2157 snd_iprintf(buffer
, " Format: %s\n",
2158 snd_pcm_format_name(fp
->format
));
2159 snd_iprintf(buffer
, " Channels: %d\n", fp
->channels
);
2160 snd_iprintf(buffer
, " Endpoint: %d %s (%s)\n",
2161 fp
->endpoint
& USB_ENDPOINT_NUMBER_MASK
,
2162 fp
->endpoint
& USB_DIR_IN
? "IN" : "OUT",
2163 sync_types
[(fp
->ep_attr
& USB_ENDPOINT_SYNCTYPE
) >> 2]);
2164 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
2165 snd_iprintf(buffer
, " Rates: %d - %d (continuous)\n",
2166 fp
->rate_min
, fp
->rate_max
);
2169 snd_iprintf(buffer
, " Rates: ");
2170 for (i
= 0; i
< fp
->nr_rates
; i
++) {
2172 snd_iprintf(buffer
, ", ");
2173 snd_iprintf(buffer
, "%d", fp
->rate_table
[i
]);
2175 snd_iprintf(buffer
, "\n");
2177 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
)
2178 snd_iprintf(buffer
, " Data packet interval: %d us\n",
2179 125 * (1 << fp
->datainterval
));
2180 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2181 // snd_iprintf(buffer, " EP Attribute = %#x\n", fp->attributes);
2185 static void proc_dump_substream_status(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2187 if (subs
->running
) {
2189 snd_iprintf(buffer
, " Status: Running\n");
2190 snd_iprintf(buffer
, " Interface = %d\n", subs
->interface
);
2191 snd_iprintf(buffer
, " Altset = %d\n", subs
->format
);
2192 snd_iprintf(buffer
, " URBs = %d [ ", subs
->nurbs
);
2193 for (i
= 0; i
< subs
->nurbs
; i
++)
2194 snd_iprintf(buffer
, "%d ", subs
->dataurb
[i
].packets
);
2195 snd_iprintf(buffer
, "]\n");
2196 snd_iprintf(buffer
, " Packet Size = %d\n", subs
->curpacksize
);
2197 snd_iprintf(buffer
, " Momentary freq = %u Hz (%#x.%04x)\n",
2198 snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
2199 ? get_full_speed_hz(subs
->freqm
)
2200 : get_high_speed_hz(subs
->freqm
),
2201 subs
->freqm
>> 16, subs
->freqm
& 0xffff);
2203 snd_iprintf(buffer
, " Status: Stop\n");
2207 static void proc_pcm_format_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
2209 struct snd_usb_stream
*stream
= entry
->private_data
;
2211 snd_iprintf(buffer
, "%s : %s\n", stream
->chip
->card
->longname
, stream
->pcm
->name
);
2213 if (stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
].num_formats
) {
2214 snd_iprintf(buffer
, "\nPlayback:\n");
2215 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2216 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2218 if (stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].num_formats
) {
2219 snd_iprintf(buffer
, "\nCapture:\n");
2220 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2221 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2225 static void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2227 struct snd_info_entry
*entry
;
2229 struct snd_card
*card
= stream
->chip
->card
;
2231 sprintf(name
, "stream%d", stream
->pcm_index
);
2232 if (!snd_card_proc_new(card
, name
, &entry
))
2233 snd_info_set_text_ops(entry
, stream
, proc_pcm_format_read
);
2238 static inline void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2245 * initialize the substream instance.
2248 static void init_substream(struct snd_usb_stream
*as
, int stream
, struct audioformat
*fp
)
2250 struct snd_usb_substream
*subs
= &as
->substream
[stream
];
2252 INIT_LIST_HEAD(&subs
->fmt_list
);
2253 spin_lock_init(&subs
->lock
);
2256 subs
->direction
= stream
;
2257 subs
->dev
= as
->chip
->dev
;
2258 subs
->txfr_quirk
= as
->chip
->txfr_quirk
;
2259 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
) {
2260 subs
->ops
= audio_urb_ops
[stream
];
2262 subs
->ops
= audio_urb_ops_high_speed
[stream
];
2263 switch (as
->chip
->usb_id
) {
2264 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
2265 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
2266 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
2267 subs
->ops
.retire_sync
= retire_playback_sync_urb_hs_emu
;
2271 snd_pcm_set_ops(as
->pcm
, stream
,
2272 stream
== SNDRV_PCM_STREAM_PLAYBACK
?
2273 &snd_usb_playback_ops
: &snd_usb_capture_ops
);
2275 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2276 subs
->formats
|= 1ULL << fp
->format
;
2277 subs
->endpoint
= fp
->endpoint
;
2278 subs
->num_formats
++;
2279 subs
->fmt_type
= fp
->fmt_type
;
2286 static void free_substream(struct snd_usb_substream
*subs
)
2288 struct list_head
*p
, *n
;
2290 if (!subs
->num_formats
)
2291 return; /* not initialized */
2292 list_for_each_safe(p
, n
, &subs
->fmt_list
) {
2293 struct audioformat
*fp
= list_entry(p
, struct audioformat
, list
);
2294 kfree(fp
->rate_table
);
2297 kfree(subs
->rate_list
.list
);
2302 * free a usb stream instance
2304 static void snd_usb_audio_stream_free(struct snd_usb_stream
*stream
)
2306 free_substream(&stream
->substream
[0]);
2307 free_substream(&stream
->substream
[1]);
2308 list_del(&stream
->list
);
2312 static void snd_usb_audio_pcm_free(struct snd_pcm
*pcm
)
2314 struct snd_usb_stream
*stream
= pcm
->private_data
;
2317 snd_usb_audio_stream_free(stream
);
2323 * add this endpoint to the chip instance.
2324 * if a stream with the same endpoint already exists, append to it.
2325 * if not, create a new pcm stream.
2327 static int add_audio_endpoint(struct snd_usb_audio
*chip
, int stream
, struct audioformat
*fp
)
2329 struct list_head
*p
;
2330 struct snd_usb_stream
*as
;
2331 struct snd_usb_substream
*subs
;
2332 struct snd_pcm
*pcm
;
2335 list_for_each(p
, &chip
->pcm_list
) {
2336 as
= list_entry(p
, struct snd_usb_stream
, list
);
2337 if (as
->fmt_type
!= fp
->fmt_type
)
2339 subs
= &as
->substream
[stream
];
2340 if (!subs
->endpoint
)
2342 if (subs
->endpoint
== fp
->endpoint
) {
2343 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2344 subs
->num_formats
++;
2345 subs
->formats
|= 1ULL << fp
->format
;
2349 /* look for an empty stream */
2350 list_for_each(p
, &chip
->pcm_list
) {
2351 as
= list_entry(p
, struct snd_usb_stream
, list
);
2352 if (as
->fmt_type
!= fp
->fmt_type
)
2354 subs
= &as
->substream
[stream
];
2357 err
= snd_pcm_new_stream(as
->pcm
, stream
, 1);
2360 init_substream(as
, stream
, fp
);
2364 /* create a new pcm */
2365 as
= kzalloc(sizeof(*as
), GFP_KERNEL
);
2368 as
->pcm_index
= chip
->pcm_devs
;
2370 as
->fmt_type
= fp
->fmt_type
;
2371 err
= snd_pcm_new(chip
->card
, "USB Audio", chip
->pcm_devs
,
2372 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 1 : 0,
2373 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 0 : 1,
2380 pcm
->private_data
= as
;
2381 pcm
->private_free
= snd_usb_audio_pcm_free
;
2382 pcm
->info_flags
= 0;
2383 if (chip
->pcm_devs
> 0)
2384 sprintf(pcm
->name
, "USB Audio #%d", chip
->pcm_devs
);
2386 strcpy(pcm
->name
, "USB Audio");
2388 init_substream(as
, stream
, fp
);
2390 list_add(&as
->list
, &chip
->pcm_list
);
2393 proc_pcm_format_add(as
);
2400 * check if the device uses big-endian samples
2402 static int is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
2404 switch (chip
->usb_id
) {
2405 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2406 if (fp
->endpoint
& USB_DIR_IN
)
2409 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2410 if (device_setup
[chip
->index
] == 0x00 ||
2411 fp
->altsetting
==1 || fp
->altsetting
==2 || fp
->altsetting
==3)
2418 * parse the audio format type I descriptor
2419 * and returns the corresponding pcm format
2422 * @fp: audioformat record
2423 * @format: the format tag (wFormatTag)
2424 * @fmt: the format type descriptor
2426 static int parse_audio_format_i_type(struct snd_usb_audio
*chip
,
2427 struct audioformat
*fp
,
2428 int format
, void *_fmt
,
2432 int sample_width
, sample_bytes
;
2435 case UAC_VERSION_1
: {
2436 struct uac_format_type_i_discrete_descriptor
*fmt
= _fmt
;
2437 sample_width
= fmt
->bBitResolution
;
2438 sample_bytes
= fmt
->bSubframeSize
;
2442 case UAC_VERSION_2
: {
2443 struct uac_format_type_i_ext_descriptor
*fmt
= _fmt
;
2444 sample_width
= fmt
->bBitResolution
;
2445 sample_bytes
= fmt
->bSubslotSize
;
2449 * USB audio class v2 devices specify a bitmap of possible
2450 * audio formats rather than one fix value. For now, we just
2451 * pick one of them and report that as the only possible
2452 * value for this setting.
2453 * The bit allocation map is in fact compatible to the
2454 * wFormatTag of the v1 AS streaming descriptors, which is why
2455 * we can simply map the matrix.
2458 for (i
= 0; i
< 5; i
++)
2459 if (format
& (1UL << i
)) {
2471 /* FIXME: correct endianess and sign? */
2475 case UAC_FORMAT_TYPE_I_UNDEFINED
: /* some devices don't define this correctly... */
2476 snd_printdd(KERN_INFO
"%d:%u:%d : format type 0 is detected, processed as PCM\n",
2477 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2479 case UAC_FORMAT_TYPE_I_PCM
:
2480 if (sample_width
> sample_bytes
* 8) {
2481 snd_printk(KERN_INFO
"%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2482 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
,
2483 sample_width
, sample_bytes
);
2485 /* check the format byte size */
2486 switch (sample_bytes
) {
2488 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2491 if (is_big_endian_format(chip
, fp
))
2492 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
; /* grrr, big endian!! */
2494 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2497 if (is_big_endian_format(chip
, fp
))
2498 pcm_format
= SNDRV_PCM_FORMAT_S24_3BE
; /* grrr, big endian!! */
2500 pcm_format
= SNDRV_PCM_FORMAT_S24_3LE
;
2503 pcm_format
= SNDRV_PCM_FORMAT_S32_LE
;
2506 snd_printk(KERN_INFO
"%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2507 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
,
2508 sample_width
, sample_bytes
);
2512 case UAC_FORMAT_TYPE_I_PCM8
:
2513 pcm_format
= SNDRV_PCM_FORMAT_U8
;
2515 /* Dallas DS4201 workaround: it advertises U8 format, but really
2517 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2518 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2520 case UAC_FORMAT_TYPE_I_IEEE_FLOAT
:
2521 pcm_format
= SNDRV_PCM_FORMAT_FLOAT_LE
;
2523 case UAC_FORMAT_TYPE_I_ALAW
:
2524 pcm_format
= SNDRV_PCM_FORMAT_A_LAW
;
2526 case UAC_FORMAT_TYPE_I_MULAW
:
2527 pcm_format
= SNDRV_PCM_FORMAT_MU_LAW
;
2530 snd_printk(KERN_INFO
"%d:%u:%d : unsupported format type %d\n",
2531 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2539 * parse the format descriptor and stores the possible sample rates
2540 * on the audioformat table (audio class v1).
2543 * @fp: audioformat record
2544 * @fmt: the format descriptor
2545 * @offset: the start offset of descriptor pointing the rate type
2546 * (7 for type I and II, 8 for type II)
2548 static int parse_audio_format_rates_v1(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2549 unsigned char *fmt
, int offset
)
2551 int nr_rates
= fmt
[offset
];
2553 if (fmt
[0] < offset
+ 1 + 3 * (nr_rates
? nr_rates
: 2)) {
2554 snd_printk(KERN_ERR
"%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
2555 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2561 * build the rate table and bitmap flags
2565 fp
->rate_table
= kmalloc(sizeof(int) * nr_rates
, GFP_KERNEL
);
2566 if (fp
->rate_table
== NULL
) {
2567 snd_printk(KERN_ERR
"cannot malloc\n");
2572 fp
->rate_min
= fp
->rate_max
= 0;
2573 for (r
= 0, idx
= offset
+ 1; r
< nr_rates
; r
++, idx
+= 3) {
2574 unsigned int rate
= combine_triple(&fmt
[idx
]);
2577 /* C-Media CM6501 mislabels its 96 kHz altsetting */
2578 if (rate
== 48000 && nr_rates
== 1 &&
2579 (chip
->usb_id
== USB_ID(0x0d8c, 0x0201) ||
2580 chip
->usb_id
== USB_ID(0x0d8c, 0x0102)) &&
2581 fp
->altsetting
== 5 && fp
->maxpacksize
== 392)
2583 /* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
2584 if (rate
== 16000 && chip
->usb_id
== USB_ID(0x041e, 0x4068))
2586 fp
->rate_table
[fp
->nr_rates
] = rate
;
2587 if (!fp
->rate_min
|| rate
< fp
->rate_min
)
2588 fp
->rate_min
= rate
;
2589 if (!fp
->rate_max
|| rate
> fp
->rate_max
)
2590 fp
->rate_max
= rate
;
2591 fp
->rates
|= snd_pcm_rate_to_rate_bit(rate
);
2594 if (!fp
->nr_rates
) {
2595 hwc_debug("All rates were zero. Skipping format!\n");
2599 /* continuous rates */
2600 fp
->rates
= SNDRV_PCM_RATE_CONTINUOUS
;
2601 fp
->rate_min
= combine_triple(&fmt
[offset
+ 1]);
2602 fp
->rate_max
= combine_triple(&fmt
[offset
+ 4]);
2608 * parse the format descriptor and stores the possible sample rates
2609 * on the audioformat table (audio class v2).
2611 static int parse_audio_format_rates_v2(struct snd_usb_audio
*chip
,
2612 struct audioformat
*fp
,
2613 struct usb_host_interface
*iface
)
2615 struct usb_device
*dev
= chip
->dev
;
2616 unsigned char tmp
[2], *data
;
2617 int i
, nr_rates
, data_size
, ret
= 0;
2619 /* get the number of sample rates first by only fetching 2 bytes */
2620 ret
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), UAC2_CS_RANGE
,
2621 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| USB_DIR_IN
,
2622 0x0100, chip
->clock_id
<< 8, tmp
, sizeof(tmp
), 1000);
2625 snd_printk(KERN_ERR
"unable to retrieve number of sample rates\n");
2629 nr_rates
= (tmp
[1] << 8) | tmp
[0];
2630 data_size
= 2 + 12 * nr_rates
;
2631 data
= kzalloc(data_size
, GFP_KERNEL
);
2637 /* now get the full information */
2638 ret
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), UAC2_CS_RANGE
,
2639 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| USB_DIR_IN
,
2640 0x0100, chip
->clock_id
<< 8, data
, data_size
, 1000);
2643 snd_printk(KERN_ERR
"unable to retrieve sample rate range\n");
2648 fp
->rate_table
= kmalloc(sizeof(int) * nr_rates
, GFP_KERNEL
);
2649 if (!fp
->rate_table
) {
2655 fp
->rate_min
= fp
->rate_max
= 0;
2657 for (i
= 0; i
< nr_rates
; i
++) {
2658 int rate
= combine_quad(&data
[2 + 12 * i
]);
2660 fp
->rate_table
[fp
->nr_rates
] = rate
;
2661 if (!fp
->rate_min
|| rate
< fp
->rate_min
)
2662 fp
->rate_min
= rate
;
2663 if (!fp
->rate_max
|| rate
> fp
->rate_max
)
2664 fp
->rate_max
= rate
;
2665 fp
->rates
|= snd_pcm_rate_to_rate_bit(rate
);
2676 * parse the format type I and III descriptors
2678 static int parse_audio_format_i(struct snd_usb_audio
*chip
,
2679 struct audioformat
*fp
,
2680 int format
, void *_fmt
,
2681 struct usb_host_interface
*iface
)
2683 struct usb_interface_descriptor
*altsd
= get_iface_desc(iface
);
2684 struct uac_format_type_i_discrete_descriptor
*fmt
= _fmt
;
2685 int protocol
= altsd
->bInterfaceProtocol
;
2686 int pcm_format
, ret
;
2688 if (fmt
->bFormatType
== UAC_FORMAT_TYPE_III
) {
2689 /* FIXME: the format type is really IECxxx
2690 * but we give normal PCM format to get the existing
2693 switch (chip
->usb_id
) {
2695 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2696 if (device_setup
[chip
->index
] == 0x00 &&
2697 fp
->altsetting
== 6)
2698 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
;
2700 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2703 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2706 pcm_format
= parse_audio_format_i_type(chip
, fp
, format
, fmt
, protocol
);
2711 fp
->format
= pcm_format
;
2713 /* gather possible sample rates */
2714 /* audio class v1 reports possible sample rates as part of the
2715 * proprietary class specific descriptor.
2716 * audio class v2 uses class specific EP0 range requests for that.
2720 fp
->channels
= fmt
->bNrChannels
;
2721 ret
= parse_audio_format_rates_v1(chip
, fp
, _fmt
, 7);
2724 /* fp->channels is already set in this case */
2725 ret
= parse_audio_format_rates_v2(chip
, fp
, iface
);
2729 if (fp
->channels
< 1) {
2730 snd_printk(KERN_ERR
"%d:%u:%d : invalid channels %d\n",
2731 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fp
->channels
);
2739 * parse the format type II descriptor
2741 static int parse_audio_format_ii(struct snd_usb_audio
*chip
,
2742 struct audioformat
*fp
,
2743 int format
, void *_fmt
,
2744 struct usb_host_interface
*iface
)
2746 int brate
, framesize
, ret
;
2747 struct usb_interface_descriptor
*altsd
= get_iface_desc(iface
);
2748 int protocol
= altsd
->bInterfaceProtocol
;
2751 case UAC_FORMAT_TYPE_II_AC3
:
2752 /* FIXME: there is no AC3 format defined yet */
2753 // fp->format = SNDRV_PCM_FORMAT_AC3;
2754 fp
->format
= SNDRV_PCM_FORMAT_U8
; /* temporarily hack to receive byte streams */
2756 case UAC_FORMAT_TYPE_II_MPEG
:
2757 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2760 snd_printd(KERN_INFO
"%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
2761 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2762 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2769 case UAC_VERSION_1
: {
2770 struct uac_format_type_ii_discrete_descriptor
*fmt
= _fmt
;
2771 brate
= le16_to_cpu(fmt
->wMaxBitRate
);
2772 framesize
= le16_to_cpu(fmt
->wSamplesPerFrame
);
2773 snd_printd(KERN_INFO
"found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
2774 fp
->frame_size
= framesize
;
2775 ret
= parse_audio_format_rates_v1(chip
, fp
, _fmt
, 8); /* fmt[8..] sample rates */
2778 case UAC_VERSION_2
: {
2779 struct uac_format_type_ii_ext_descriptor
*fmt
= _fmt
;
2780 brate
= le16_to_cpu(fmt
->wMaxBitRate
);
2781 framesize
= le16_to_cpu(fmt
->wSamplesPerFrame
);
2782 snd_printd(KERN_INFO
"found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
2783 fp
->frame_size
= framesize
;
2784 ret
= parse_audio_format_rates_v2(chip
, fp
, iface
);
2792 static int parse_audio_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2793 int format
, unsigned char *fmt
, int stream
,
2794 struct usb_host_interface
*iface
)
2799 case UAC_FORMAT_TYPE_I
:
2800 case UAC_FORMAT_TYPE_III
:
2801 err
= parse_audio_format_i(chip
, fp
, format
, fmt
, iface
);
2803 case UAC_FORMAT_TYPE_II
:
2804 err
= parse_audio_format_ii(chip
, fp
, format
, fmt
, iface
);
2807 snd_printd(KERN_INFO
"%d:%u:%d : format type %d is not supported yet\n",
2808 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fmt
[3]);
2811 fp
->fmt_type
= fmt
[3];
2815 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2816 /* extigy apparently supports sample rates other than 48k
2817 * but not in ordinary way. so we enable only 48k atm.
2819 if (chip
->usb_id
== USB_ID(0x041e, 0x3000) ||
2820 chip
->usb_id
== USB_ID(0x041e, 0x3020) ||
2821 chip
->usb_id
== USB_ID(0x041e, 0x3061)) {
2822 if (fmt
[3] == UAC_FORMAT_TYPE_I
&&
2823 fp
->rates
!= SNDRV_PCM_RATE_48000
&&
2824 fp
->rates
!= SNDRV_PCM_RATE_96000
)
2831 static unsigned char parse_datainterval(struct snd_usb_audio
*chip
,
2832 struct usb_host_interface
*alts
)
2834 if (snd_usb_get_speed(chip
->dev
) == USB_SPEED_HIGH
&&
2835 get_endpoint(alts
, 0)->bInterval
>= 1 &&
2836 get_endpoint(alts
, 0)->bInterval
<= 4)
2837 return get_endpoint(alts
, 0)->bInterval
- 1;
2842 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
2843 int iface
, int altno
);
2844 static int parse_audio_endpoints(struct snd_usb_audio
*chip
, int iface_no
)
2846 struct usb_device
*dev
;
2847 struct usb_interface
*iface
;
2848 struct usb_host_interface
*alts
;
2849 struct usb_interface_descriptor
*altsd
;
2850 int i
, altno
, err
, stream
;
2851 int format
= 0, num_channels
= 0;
2852 struct audioformat
*fp
= NULL
;
2853 unsigned char *fmt
, *csep
;
2858 /* parse the interface's altsettings */
2859 iface
= usb_ifnum_to_if(dev
, iface_no
);
2861 num
= iface
->num_altsetting
;
2864 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
2865 * one misses syncpipe, and does not produce any sound.
2867 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2870 for (i
= 0; i
< num
; i
++) {
2871 alts
= &iface
->altsetting
[i
];
2872 altsd
= get_iface_desc(alts
);
2873 protocol
= altsd
->bInterfaceProtocol
;
2874 /* skip invalid one */
2875 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2876 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2877 (altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
&&
2878 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_VENDOR_SPEC
) ||
2879 altsd
->bNumEndpoints
< 1 ||
2880 le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
) == 0)
2882 /* must be isochronous */
2883 if ((get_endpoint(alts
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) !=
2884 USB_ENDPOINT_XFER_ISOC
)
2886 /* check direction */
2887 stream
= (get_endpoint(alts
, 0)->bEndpointAddress
& USB_DIR_IN
) ?
2888 SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2889 altno
= altsd
->bAlternateSetting
;
2891 /* audiophile usb: skip altsets incompatible with device_setup
2893 if (chip
->usb_id
== USB_ID(0x0763, 0x2003) &&
2894 audiophile_skip_setting_quirk(chip
, iface_no
, altno
))
2897 /* get audio formats */
2899 case UAC_VERSION_1
: {
2900 struct uac_as_header_descriptor_v1
*as
=
2901 snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, UAC_AS_GENERAL
);
2904 snd_printk(KERN_ERR
"%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
2905 dev
->devnum
, iface_no
, altno
);
2909 if (as
->bLength
< sizeof(*as
)) {
2910 snd_printk(KERN_ERR
"%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
2911 dev
->devnum
, iface_no
, altno
);
2915 format
= le16_to_cpu(as
->wFormatTag
); /* remember the format value */
2919 case UAC_VERSION_2
: {
2920 struct uac_as_header_descriptor_v2
*as
=
2921 snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, UAC_AS_GENERAL
);
2924 snd_printk(KERN_ERR
"%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
2925 dev
->devnum
, iface_no
, altno
);
2929 if (as
->bLength
< sizeof(*as
)) {
2930 snd_printk(KERN_ERR
"%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
2931 dev
->devnum
, iface_no
, altno
);
2935 num_channels
= as
->bNrChannels
;
2936 format
= le32_to_cpu(as
->bmFormats
);
2942 snd_printk(KERN_ERR
"%d:%u:%d : unknown interface protocol %04x\n",
2943 dev
->devnum
, iface_no
, altno
, protocol
);
2947 /* get format type */
2948 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, UAC_FORMAT_TYPE
);
2950 snd_printk(KERN_ERR
"%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
2951 dev
->devnum
, iface_no
, altno
);
2954 if (((protocol
== UAC_VERSION_1
) && (fmt
[0] < 8)) ||
2955 ((protocol
== UAC_VERSION_2
) && (fmt
[0] != 6))) {
2956 snd_printk(KERN_ERR
"%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
2957 dev
->devnum
, iface_no
, altno
);
2962 * Blue Microphones workaround: The last altsetting is identical
2963 * with the previous one, except for a larger packet size, but
2964 * is actually a mislabeled two-channel setting; ignore it.
2966 if (fmt
[4] == 1 && fmt
[5] == 2 && altno
== 2 && num
== 3 &&
2967 fp
&& fp
->altsetting
== 1 && fp
->channels
== 1 &&
2968 fp
->format
== SNDRV_PCM_FORMAT_S16_LE
&&
2969 protocol
== UAC_VERSION_1
&&
2970 le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
) ==
2971 fp
->maxpacksize
* 2)
2974 csep
= snd_usb_find_desc(alts
->endpoint
[0].extra
, alts
->endpoint
[0].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2975 /* Creamware Noah has this descriptor after the 2nd endpoint */
2976 if (!csep
&& altsd
->bNumEndpoints
>= 2)
2977 csep
= snd_usb_find_desc(alts
->endpoint
[1].extra
, alts
->endpoint
[1].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2978 if (!csep
|| csep
[0] < 7 || csep
[2] != UAC_EP_GENERAL
) {
2979 snd_printk(KERN_WARNING
"%d:%u:%d : no or invalid"
2980 " class specific endpoint descriptor\n",
2981 dev
->devnum
, iface_no
, altno
);
2985 fp
= kzalloc(sizeof(*fp
), GFP_KERNEL
);
2987 snd_printk(KERN_ERR
"cannot malloc\n");
2991 fp
->iface
= iface_no
;
2992 fp
->altsetting
= altno
;
2994 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
2995 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
2996 fp
->datainterval
= parse_datainterval(chip
, alts
);
2997 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2998 /* num_channels is only set for v2 interfaces */
2999 fp
->channels
= num_channels
;
3000 if (snd_usb_get_speed(dev
) == USB_SPEED_HIGH
)
3001 fp
->maxpacksize
= (((fp
->maxpacksize
>> 11) & 3) + 1)
3002 * (fp
->maxpacksize
& 0x7ff);
3003 fp
->attributes
= csep
? csep
[3] : 0;
3005 /* some quirks for attributes here */
3007 switch (chip
->usb_id
) {
3008 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
3009 /* Optoplay sets the sample rate attribute although
3010 * it seems not supporting it in fact.
3012 fp
->attributes
&= ~UAC_EP_CS_ATTR_SAMPLE_RATE
;
3014 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
3015 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
3016 /* doesn't set the sample rate attribute, but supports it */
3017 fp
->attributes
|= UAC_EP_CS_ATTR_SAMPLE_RATE
;
3019 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
3020 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
3021 an older model 77d:223) */
3023 * plantronics headset and Griffin iMic have set adaptive-in
3024 * although it's really not...
3026 fp
->ep_attr
&= ~USB_ENDPOINT_SYNCTYPE
;
3027 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
3028 fp
->ep_attr
|= USB_ENDPOINT_SYNC_ADAPTIVE
;
3030 fp
->ep_attr
|= USB_ENDPOINT_SYNC_SYNC
;
3034 /* ok, let's parse further... */
3035 if (parse_audio_format(chip
, fp
, format
, fmt
, stream
, alts
) < 0) {
3036 kfree(fp
->rate_table
);
3041 snd_printdd(KERN_INFO
"%d:%u:%d: add audio endpoint %#x\n", dev
->devnum
, iface_no
, altno
, fp
->endpoint
);
3042 err
= add_audio_endpoint(chip
, stream
, fp
);
3044 kfree(fp
->rate_table
);
3048 /* try to set the interface... */
3049 usb_set_interface(chip
->dev
, iface_no
, altno
);
3050 init_usb_pitch(chip
->dev
, iface_no
, alts
, fp
);
3051 init_usb_sample_rate(chip
->dev
, iface_no
, alts
, fp
, fp
->rate_max
);
3058 * disconnect streams
3059 * called from snd_usb_audio_disconnect()
3061 static void snd_usb_stream_disconnect(struct list_head
*head
)
3064 struct snd_usb_stream
*as
;
3065 struct snd_usb_substream
*subs
;
3067 as
= list_entry(head
, struct snd_usb_stream
, list
);
3068 for (idx
= 0; idx
< 2; idx
++) {
3069 subs
= &as
->substream
[idx
];
3070 if (!subs
->num_formats
)
3072 release_substream_urbs(subs
, 1);
3073 subs
->interface
= -1;
3077 static int snd_usb_create_stream(struct snd_usb_audio
*chip
, int ctrlif
, int interface
)
3079 struct usb_device
*dev
= chip
->dev
;
3080 struct usb_host_interface
*alts
;
3081 struct usb_interface_descriptor
*altsd
;
3082 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, interface
);
3085 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
3086 dev
->devnum
, ctrlif
, interface
);
3090 if (usb_interface_claimed(iface
)) {
3091 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n",
3092 dev
->devnum
, ctrlif
, interface
);
3096 alts
= &iface
->altsetting
[0];
3097 altsd
= get_iface_desc(alts
);
3098 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
3099 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
3100 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
3101 int err
= snd_usbmidi_create(chip
->card
, iface
,
3102 &chip
->midi_list
, NULL
);
3104 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n",
3105 dev
->devnum
, ctrlif
, interface
);
3108 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
3113 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
3114 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
3115 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
3116 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n",
3117 dev
->devnum
, ctrlif
, interface
, altsd
->bInterfaceClass
);
3118 /* skip non-supported classes */
3122 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
3123 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
3127 if (! parse_audio_endpoints(chip
, interface
)) {
3128 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
3129 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
3137 * parse audio control descriptor and create pcm/midi streams
3139 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
3141 struct usb_device
*dev
= chip
->dev
;
3142 struct usb_host_interface
*host_iface
;
3143 struct usb_interface_descriptor
*altsd
;
3144 void *control_header
;
3147 /* find audiocontrol interface */
3148 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
3149 control_header
= snd_usb_find_csint_desc(host_iface
->extra
,
3150 host_iface
->extralen
,
3152 altsd
= get_iface_desc(host_iface
);
3153 protocol
= altsd
->bInterfaceProtocol
;
3155 if (!control_header
) {
3156 snd_printk(KERN_ERR
"cannot find UAC_HEADER\n");
3161 case UAC_VERSION_1
: {
3162 struct uac_ac_header_descriptor_v1
*h1
= control_header
;
3164 if (!h1
->bInCollection
) {
3165 snd_printk(KERN_INFO
"skipping empty audio interface (v1)\n");
3169 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
3170 snd_printk(KERN_ERR
"invalid UAC_HEADER (v1)\n");
3174 for (i
= 0; i
< h1
->bInCollection
; i
++)
3175 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
3180 case UAC_VERSION_2
: {
3181 struct uac_clock_source_descriptor
*cs
;
3182 struct usb_interface_assoc_descriptor
*assoc
=
3183 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
3186 snd_printk(KERN_ERR
"Audio class v2 interfaces need an interface association\n");
3190 /* FIXME: for now, we expect there is at least one clock source
3191 * descriptor and we always take the first one.
3192 * We should properly support devices with multiple clock sources,
3193 * clock selectors and sample rate conversion units. */
3195 cs
= snd_usb_find_csint_desc(host_iface
->extra
, host_iface
->extralen
,
3196 NULL
, UAC_CLOCK_SOURCE
);
3199 snd_printk(KERN_ERR
"CLOCK_SOURCE descriptor not found\n");
3203 chip
->clock_id
= cs
->bClockID
;
3205 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
3206 int intf
= assoc
->bFirstInterface
+ i
;
3209 snd_usb_create_stream(chip
, ctrlif
, intf
);
3216 snd_printk(KERN_ERR
"unknown protocol version 0x%02x\n", protocol
);
3224 * create a stream for an endpoint/altsetting without proper descriptors
3226 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
3227 struct usb_interface
*iface
,
3228 const struct snd_usb_audio_quirk
*quirk
)
3230 struct audioformat
*fp
;
3231 struct usb_host_interface
*alts
;
3233 unsigned *rate_table
= NULL
;
3235 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
3237 snd_printk(KERN_ERR
"cannot memdup\n");
3240 if (fp
->nr_rates
> 0) {
3241 rate_table
= kmalloc(sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
3246 memcpy(rate_table
, fp
->rate_table
, sizeof(int) * fp
->nr_rates
);
3247 fp
->rate_table
= rate_table
;
3250 stream
= (fp
->endpoint
& USB_DIR_IN
)
3251 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3252 err
= add_audio_endpoint(chip
, stream
, fp
);
3258 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
3259 fp
->altset_idx
>= iface
->num_altsetting
) {
3264 alts
= &iface
->altsetting
[fp
->altset_idx
];
3265 fp
->datainterval
= parse_datainterval(chip
, alts
);
3266 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3267 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3268 init_usb_pitch(chip
->dev
, fp
->iface
, alts
, fp
);
3269 init_usb_sample_rate(chip
->dev
, fp
->iface
, alts
, fp
, fp
->rate_max
);
3274 * create a stream for an interface with proper descriptors
3276 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
3277 struct usb_interface
*iface
,
3278 const struct snd_usb_audio_quirk
*quirk
)
3280 struct usb_host_interface
*alts
;
3281 struct usb_interface_descriptor
*altsd
;
3284 alts
= &iface
->altsetting
[0];
3285 altsd
= get_iface_desc(alts
);
3286 err
= parse_audio_endpoints(chip
, altsd
->bInterfaceNumber
);
3288 snd_printk(KERN_ERR
"cannot setup if %d: error %d\n",
3289 altsd
->bInterfaceNumber
, err
);
3292 /* reset the current interface */
3293 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
3298 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
3299 * The only way to detect the sample rate is by looking at wMaxPacketSize.
3301 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
3302 struct usb_interface
*iface
,
3303 const struct snd_usb_audio_quirk
*quirk
)
3305 static const struct audioformat ua_format
= {
3306 .format
= SNDRV_PCM_FORMAT_S24_3LE
,
3308 .fmt_type
= UAC_FORMAT_TYPE_I
,
3311 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3313 struct usb_host_interface
*alts
;
3314 struct usb_interface_descriptor
*altsd
;
3315 struct audioformat
*fp
;
3318 /* both PCM and MIDI interfaces have 2 or more altsettings */
3319 if (iface
->num_altsetting
< 2)
3321 alts
= &iface
->altsetting
[1];
3322 altsd
= get_iface_desc(alts
);
3324 if (altsd
->bNumEndpoints
== 2) {
3325 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
3326 .out_cables
= 0x0003,
3329 static const struct snd_usb_audio_quirk ua700_quirk
= {
3330 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3333 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
3334 .out_cables
= 0x0001,
3337 static const struct snd_usb_audio_quirk uaxx_quirk
= {
3338 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3341 const struct snd_usb_audio_quirk
*quirk
=
3342 chip
->usb_id
== USB_ID(0x0582, 0x002b)
3343 ? &ua700_quirk
: &uaxx_quirk
;
3344 return snd_usbmidi_create(chip
->card
, iface
,
3345 &chip
->midi_list
, quirk
);
3348 if (altsd
->bNumEndpoints
!= 1)
3351 fp
= kmalloc(sizeof(*fp
), GFP_KERNEL
);
3354 memcpy(fp
, &ua_format
, sizeof(*fp
));
3356 fp
->iface
= altsd
->bInterfaceNumber
;
3357 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3358 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3359 fp
->datainterval
= 0;
3360 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3362 switch (fp
->maxpacksize
) {
3364 fp
->rate_max
= fp
->rate_min
= 44100;
3368 fp
->rate_max
= fp
->rate_min
= 48000;
3372 fp
->rate_max
= fp
->rate_min
= 96000;
3375 snd_printk(KERN_ERR
"unknown sample rate\n");
3380 stream
= (fp
->endpoint
& USB_DIR_IN
)
3381 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3382 err
= add_audio_endpoint(chip
, stream
, fp
);
3387 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3391 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3392 struct usb_interface
*iface
,
3393 const struct snd_usb_audio_quirk
*quirk
);
3396 * handle the quirks for the contained interfaces
3398 static int create_composite_quirk(struct snd_usb_audio
*chip
,
3399 struct usb_interface
*iface
,
3400 const struct snd_usb_audio_quirk
*quirk
)
3402 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
3405 for (quirk
= quirk
->data
; quirk
->ifnum
>= 0; ++quirk
) {
3406 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
3409 if (quirk
->ifnum
!= probed_ifnum
&&
3410 usb_interface_claimed(iface
))
3412 err
= snd_usb_create_quirk(chip
, iface
, quirk
);
3415 if (quirk
->ifnum
!= probed_ifnum
)
3416 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
3421 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
3422 struct usb_interface
*iface
,
3423 const struct snd_usb_audio_quirk
*quirk
)
3429 * Allow alignment on audio sub-slot (channel samples) rather than
3430 * on audio slots (audio frames)
3432 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
3433 struct usb_interface
*iface
,
3434 const struct snd_usb_audio_quirk
*quirk
)
3436 chip
->txfr_quirk
= 1;
3437 return 1; /* Continue with creating streams and mixer */
3445 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3446 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3448 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
3450 struct usb_host_config
*config
= dev
->actconfig
;
3453 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
3454 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
3455 snd_printdd("sending Extigy boot sequence...\n");
3456 /* Send message to force it to reconnect with full interface. */
3457 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
3458 0x10, 0x43, 0x0001, 0x000a, NULL
, 0, 1000);
3459 if (err
< 0) snd_printdd("error sending boot message: %d\n", err
);
3460 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
3461 &dev
->descriptor
, sizeof(dev
->descriptor
));
3462 config
= dev
->actconfig
;
3463 if (err
< 0) snd_printdd("error usb_get_descriptor: %d\n", err
);
3464 err
= usb_reset_configuration(dev
);
3465 if (err
< 0) snd_printdd("error usb_reset_configuration: %d\n", err
);
3466 snd_printdd("extigy_boot: new boot length = %d\n",
3467 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
3468 return -ENODEV
; /* quit this anyway */
3473 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
3477 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
3478 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3479 0, 0, &buf
, 1, 1000);
3481 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
3482 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3483 1, 2000, NULL
, 0, 1000);
3490 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3491 * documented in the device's data sheet.
3493 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
3497 buf
[1] = value
& 0xff;
3498 buf
[2] = (value
>> 8) & 0xff;
3500 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
3501 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
3502 0, 0, &buf
, 4, 1000);
3505 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
3508 * Enable line-out driver mode, set headphone source to front
3509 * channels, enable stereo mic.
3511 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
3515 * C-Media CM6206 is based on CM106 with two additional
3516 * registers that are not documented in the data sheet.
3517 * Values here are chosen based on sniffing USB traffic
3520 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
3523 int val
[] = {0x200c, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
3525 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
3526 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
3535 * This call will put the synth in "USB send" mode, i.e it will send MIDI
3536 * messages through USB (this is disabled at startup). The synth will
3537 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
3538 * sign on its LCD. Values here are chosen based on sniffing USB traffic
3541 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
3543 int err
, actual_length
;
3545 /* "midi send" enable */
3546 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
3548 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
3551 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
3552 ARRAY_SIZE(seq
), &actual_length
, 1000);
3563 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3564 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3565 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3566 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3567 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3568 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3569 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3570 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3571 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3572 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3574 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
3575 int iface
, int altno
)
3577 /* Reset ALL ifaces to 0 altsetting.
3578 * Call it for every possible altsetting of every interface.
3580 usb_set_interface(chip
->dev
, iface
, 0);
3582 if (device_setup
[chip
->index
] & AUDIOPHILE_SET
) {
3583 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_DTS
)
3585 return 1; /* skip this altsetting */
3586 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_96K
)
3588 return 1; /* skip this altsetting */
3589 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3590 AUDIOPHILE_SET_24B_48K_DI
&& altno
!= 2)
3591 return 1; /* skip this altsetting */
3592 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3593 AUDIOPHILE_SET_24B_48K_NOTDI
&& altno
!= 3)
3594 return 1; /* skip this altsetting */
3595 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3596 AUDIOPHILE_SET_16B_48K_DI
&& altno
!= 4)
3597 return 1; /* skip this altsetting */
3598 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3599 AUDIOPHILE_SET_16B_48K_NOTDI
&& altno
!= 5)
3600 return 1; /* skip this altsetting */
3602 return 0; /* keep this altsetting */
3605 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
3606 struct usb_interface
*intf
,
3607 const struct snd_usb_audio_quirk
*quirk
)
3609 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
3613 * audio-interface quirks
3615 * returns zero if no standard audio/MIDI parsing is needed.
3616 * returns a postive value if standard audio/midi interfaces are parsed
3618 * returns a negative value at error.
3620 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3621 struct usb_interface
*iface
,
3622 const struct snd_usb_audio_quirk
*quirk
)
3624 typedef int (*quirk_func_t
)(struct snd_usb_audio
*, struct usb_interface
*,
3625 const struct snd_usb_audio_quirk
*);
3626 static const quirk_func_t quirk_funcs
[] = {
3627 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
3628 [QUIRK_COMPOSITE
] = create_composite_quirk
,
3629 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
3630 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
3631 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
3632 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
3633 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
3634 [QUIRK_MIDI_FASTLANE
] = create_any_midi_quirk
,
3635 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
3636 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
3637 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
3638 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
3639 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
3640 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
3643 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
3644 return quirk_funcs
[quirk
->type
](chip
, iface
, quirk
);
3646 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
3653 * common proc files to show the usb device info
3655 static void proc_audio_usbbus_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3657 struct snd_usb_audio
*chip
= entry
->private_data
;
3658 if (!chip
->shutdown
)
3659 snd_iprintf(buffer
, "%03d/%03d\n", chip
->dev
->bus
->busnum
, chip
->dev
->devnum
);
3662 static void proc_audio_usbid_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3664 struct snd_usb_audio
*chip
= entry
->private_data
;
3665 if (!chip
->shutdown
)
3666 snd_iprintf(buffer
, "%04x:%04x\n",
3667 USB_ID_VENDOR(chip
->usb_id
),
3668 USB_ID_PRODUCT(chip
->usb_id
));
3671 static void snd_usb_audio_create_proc(struct snd_usb_audio
*chip
)
3673 struct snd_info_entry
*entry
;
3674 if (!snd_card_proc_new(chip
->card
, "usbbus", &entry
))
3675 snd_info_set_text_ops(entry
, chip
, proc_audio_usbbus_read
);
3676 if (!snd_card_proc_new(chip
->card
, "usbid", &entry
))
3677 snd_info_set_text_ops(entry
, chip
, proc_audio_usbid_read
);
3681 * free the chip instance
3683 * here we have to do not much, since pcm and controls are already freed
3687 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
3693 static int snd_usb_audio_dev_free(struct snd_device
*device
)
3695 struct snd_usb_audio
*chip
= device
->device_data
;
3696 return snd_usb_audio_free(chip
);
3701 * create a chip instance and set its names.
3703 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
3704 const struct snd_usb_audio_quirk
*quirk
,
3705 struct snd_usb_audio
**rchip
)
3707 struct snd_card
*card
;
3708 struct snd_usb_audio
*chip
;
3711 static struct snd_device_ops ops
= {
3712 .dev_free
= snd_usb_audio_dev_free
,
3717 if (snd_usb_get_speed(dev
) != USB_SPEED_LOW
&&
3718 snd_usb_get_speed(dev
) != USB_SPEED_FULL
&&
3719 snd_usb_get_speed(dev
) != USB_SPEED_HIGH
) {
3720 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
3724 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
3726 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
3730 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
3732 snd_card_free(card
);
3739 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3740 le16_to_cpu(dev
->descriptor
.idProduct
));
3741 INIT_LIST_HEAD(&chip
->pcm_list
);
3742 INIT_LIST_HEAD(&chip
->midi_list
);
3743 INIT_LIST_HEAD(&chip
->mixer_list
);
3745 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
3746 snd_usb_audio_free(chip
);
3747 snd_card_free(card
);
3751 strcpy(card
->driver
, "USB-Audio");
3752 sprintf(component
, "USB%04x:%04x",
3753 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
3754 snd_component_add(card
, component
);
3756 /* retrieve the device string as shortname */
3757 if (quirk
&& quirk
->product_name
) {
3758 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
3760 if (!dev
->descriptor
.iProduct
||
3761 usb_string(dev
, dev
->descriptor
.iProduct
,
3762 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
3763 /* no name available from anywhere, so use ID */
3764 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
3765 USB_ID_VENDOR(chip
->usb_id
),
3766 USB_ID_PRODUCT(chip
->usb_id
));
3770 /* retrieve the vendor and device strings as longname */
3771 if (quirk
&& quirk
->vendor_name
) {
3772 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
3774 if (dev
->descriptor
.iManufacturer
)
3775 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
3776 card
->longname
, sizeof(card
->longname
));
3779 /* we don't really care if there isn't any vendor string */
3782 strlcat(card
->longname
, " ", sizeof(card
->longname
));
3784 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
3786 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
3788 if (len
< sizeof(card
->longname
))
3789 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
3791 strlcat(card
->longname
,
3792 snd_usb_get_speed(dev
) == USB_SPEED_LOW
? ", low speed" :
3793 snd_usb_get_speed(dev
) == USB_SPEED_FULL
? ", full speed" :
3795 sizeof(card
->longname
));
3797 snd_usb_audio_create_proc(chip
);
3805 * probe the active usb device
3807 * note that this can be called multiple times per a device, when it
3808 * includes multiple audio control interfaces.
3810 * thus we check the usb device pointer and creates the card instance
3811 * only at the first time. the successive calls of this function will
3812 * append the pcm interface to the corresponding card.
3814 static void *snd_usb_audio_probe(struct usb_device
*dev
,
3815 struct usb_interface
*intf
,
3816 const struct usb_device_id
*usb_id
)
3818 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
3820 struct snd_usb_audio
*chip
;
3821 struct usb_host_interface
*alts
;
3825 alts
= &intf
->altsetting
[0];
3826 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
3827 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3828 le16_to_cpu(dev
->descriptor
.idProduct
));
3829 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
3832 /* SB Extigy needs special boot-up sequence */
3833 /* if more models come, this will go to the quirk list. */
3834 if (id
== USB_ID(0x041e, 0x3000)) {
3835 if (snd_usb_extigy_boot_quirk(dev
, intf
) < 0)
3838 /* SB Audigy 2 NX needs its own boot-up magic, too */
3839 if (id
== USB_ID(0x041e, 0x3020)) {
3840 if (snd_usb_audigy2nx_boot_quirk(dev
) < 0)
3844 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3845 if (id
== USB_ID(0x10f5, 0x0200)) {
3846 if (snd_usb_cm106_boot_quirk(dev
) < 0)
3850 /* C-Media CM6206 / CM106-Like Sound Device */
3851 if (id
== USB_ID(0x0d8c, 0x0102)) {
3852 if (snd_usb_cm6206_boot_quirk(dev
) < 0)
3856 /* Access Music VirusTI Desktop */
3857 if (id
== USB_ID(0x133e, 0x0815)) {
3858 if (snd_usb_accessmusic_boot_quirk(dev
) < 0)
3863 * found a config. now register to ALSA
3866 /* check whether it's already registered */
3868 mutex_lock(®ister_mutex
);
3869 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
3870 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
3871 if (usb_chip
[i
]->shutdown
) {
3872 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
3880 /* it's a fresh one.
3881 * now look for an empty slot and create a new card instance
3883 for (i
= 0; i
< SNDRV_CARDS
; i
++)
3884 if (enable
[i
] && ! usb_chip
[i
] &&
3885 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
3886 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
3887 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
3890 snd_card_set_dev(chip
->card
, &intf
->dev
);
3894 printk(KERN_ERR
"no available usb audio device\n");
3899 chip
->txfr_quirk
= 0;
3900 err
= 1; /* continue */
3901 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
3902 /* need some special handlings */
3903 if ((err
= snd_usb_create_quirk(chip
, intf
, quirk
)) < 0)
3908 /* create normal USB audio interfaces */
3909 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
3910 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
3915 /* we are allowed to call snd_card_register() many times */
3916 if (snd_card_register(chip
->card
) < 0) {
3920 usb_chip
[chip
->index
] = chip
;
3921 chip
->num_interfaces
++;
3922 mutex_unlock(®ister_mutex
);
3926 if (chip
&& !chip
->num_interfaces
)
3927 snd_card_free(chip
->card
);
3928 mutex_unlock(®ister_mutex
);
3934 * we need to take care of counter, since disconnection can be called also
3935 * many times as well as usb_audio_probe().
3937 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
3939 struct snd_usb_audio
*chip
;
3940 struct snd_card
*card
;
3941 struct list_head
*p
;
3943 if (ptr
== (void *)-1L)
3948 mutex_lock(®ister_mutex
);
3950 chip
->num_interfaces
--;
3951 if (chip
->num_interfaces
<= 0) {
3952 snd_card_disconnect(card
);
3953 /* release the pcm resources */
3954 list_for_each(p
, &chip
->pcm_list
) {
3955 snd_usb_stream_disconnect(p
);
3957 /* release the midi resources */
3958 list_for_each(p
, &chip
->midi_list
) {
3959 snd_usbmidi_disconnect(p
);
3961 /* release mixer resources */
3962 list_for_each(p
, &chip
->mixer_list
) {
3963 snd_usb_mixer_disconnect(p
);
3965 usb_chip
[chip
->index
] = NULL
;
3966 mutex_unlock(®ister_mutex
);
3967 snd_card_free_when_closed(card
);
3969 mutex_unlock(®ister_mutex
);
3974 * new 2.5 USB kernel API
3976 static int usb_audio_probe(struct usb_interface
*intf
,
3977 const struct usb_device_id
*id
)
3980 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
3982 usb_set_intfdata(intf
, chip
);
3988 static void usb_audio_disconnect(struct usb_interface
*intf
)
3990 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
3991 usb_get_intfdata(intf
));
3995 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
3997 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
3998 struct list_head
*p
;
3999 struct snd_usb_stream
*as
;
4001 if (chip
== (void *)-1L)
4004 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
4005 if (!chip
->num_suspended_intf
++) {
4006 list_for_each(p
, &chip
->pcm_list
) {
4007 as
= list_entry(p
, struct snd_usb_stream
, list
);
4008 snd_pcm_suspend_all(as
->pcm
);
4015 static int usb_audio_resume(struct usb_interface
*intf
)
4017 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
4019 if (chip
== (void *)-1L)
4021 if (--chip
->num_suspended_intf
)
4024 * ALSA leaves material resumption to user space
4028 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
4032 #endif /* CONFIG_PM */
4034 static int __init
snd_usb_audio_init(void)
4036 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
4037 printk(KERN_WARNING
"invalid nrpacks value.\n");
4040 return usb_register(&usb_audio_driver
);
4044 static void __exit
snd_usb_audio_cleanup(void)
4046 usb_deregister(&usb_audio_driver
);
4049 module_init(snd_usb_audio_init
);
4050 module_exit(snd_usb_audio_cleanup
);