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/vmalloc.h>
48 #include <linux/moduleparam.h>
49 #include <linux/mutex.h>
50 #include <sound/core.h>
51 #include <sound/info.h>
52 #include <sound/pcm.h>
53 #include <sound/pcm_params.h>
54 #include <sound/initval.h>
59 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
60 MODULE_DESCRIPTION("USB Audio");
61 MODULE_LICENSE("GPL");
62 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
65 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
66 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
67 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
; /* Enable this card */
68 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 }; /* Vendor ID for this card */
69 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 }; /* Product ID for this card */
70 static int nrpacks
= 8; /* max. number of packets per urb */
71 static int async_unlink
= 1;
72 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card*/
74 module_param_array(index
, int, NULL
, 0444);
75 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
76 module_param_array(id
, charp
, NULL
, 0444);
77 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
78 module_param_array(enable
, bool, NULL
, 0444);
79 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
80 module_param_array(vid
, int, NULL
, 0444);
81 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
82 module_param_array(pid
, int, NULL
, 0444);
83 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
84 module_param(nrpacks
, int, 0644);
85 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
86 module_param(async_unlink
, bool, 0444);
87 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
88 module_param_array(device_setup
, int, NULL
, 0444);
89 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
93 * debug the h/w constraints
95 /* #define HW_CONST_DEBUG */
103 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
105 #define SYNC_URBS 4 /* always four urbs for sync */
106 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
109 struct list_head list
;
110 snd_pcm_format_t format
; /* format type */
111 unsigned int channels
; /* # channels */
112 unsigned int fmt_type
; /* USB audio format type (1-3) */
113 unsigned int frame_size
; /* samples per frame for non-audio */
114 int iface
; /* interface number */
115 unsigned char altsetting
; /* corresponding alternate setting */
116 unsigned char altset_idx
; /* array index of altenate setting */
117 unsigned char attributes
; /* corresponding attributes of cs endpoint */
118 unsigned char endpoint
; /* endpoint */
119 unsigned char ep_attr
; /* endpoint attributes */
120 unsigned int maxpacksize
; /* max. packet size */
121 unsigned int rates
; /* rate bitmasks */
122 unsigned int rate_min
, rate_max
; /* min/max rates */
123 unsigned int nr_rates
; /* number of rate table entries */
124 unsigned int *rate_table
; /* rate table */
127 struct snd_usb_substream
;
131 unsigned int buffer_size
; /* size of data buffer, if data URB */
132 struct snd_usb_substream
*subs
;
133 int index
; /* index for urb array */
134 int packets
; /* number of packets per urb */
138 int (*prepare
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
139 int (*retire
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
140 int (*prepare_sync
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
141 int (*retire_sync
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
144 struct snd_usb_substream
{
145 struct snd_usb_stream
*stream
;
146 struct usb_device
*dev
;
147 struct snd_pcm_substream
*pcm_substream
;
148 int direction
; /* playback or capture */
149 int interface
; /* current interface */
150 int endpoint
; /* assigned endpoint */
151 struct audioformat
*cur_audiofmt
; /* current audioformat pointer (for hw_params callback) */
152 unsigned int cur_rate
; /* current rate (for hw_params callback) */
153 unsigned int period_bytes
; /* current period bytes (for hw_params callback) */
154 unsigned int format
; /* USB data format */
155 unsigned int datapipe
; /* the data i/o pipe */
156 unsigned int syncpipe
; /* 1 - async out or adaptive in */
157 unsigned int datainterval
; /* log_2 of data packet interval */
158 unsigned int syncinterval
; /* P for adaptive mode, 0 otherwise */
159 unsigned int freqn
; /* nominal sampling rate in fs/fps in Q16.16 format */
160 unsigned int freqm
; /* momentary sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqmax
; /* maximum sampling rate, used for buffer management */
162 unsigned int phase
; /* phase accumulator */
163 unsigned int maxpacksize
; /* max packet size in bytes */
164 unsigned int maxframesize
; /* max packet size in frames */
165 unsigned int curpacksize
; /* current packet size in bytes (for capture) */
166 unsigned int curframesize
; /* current packet size in frames (for capture) */
167 unsigned int fill_max
: 1; /* fill max packet size always */
168 unsigned int fmt_type
; /* USB audio format type (1-3) */
169 unsigned int packs_per_ms
; /* packets per millisecond (for playback) */
171 unsigned int running
: 1; /* running status */
173 unsigned int hwptr_done
; /* processed frame position in the buffer */
174 unsigned int transfer_done
; /* processed frames since last period update */
175 unsigned long active_mask
; /* bitmask of active urbs */
176 unsigned long unlink_mask
; /* bitmask of unlinked urbs */
178 unsigned int nurbs
; /* # urbs */
179 struct snd_urb_ctx dataurb
[MAX_URBS
]; /* data urb table */
180 struct snd_urb_ctx syncurb
[SYNC_URBS
]; /* sync urb table */
181 char *syncbuf
; /* sync buffer for all sync URBs */
182 dma_addr_t sync_dma
; /* DMA address of syncbuf */
184 u64 formats
; /* format bitmasks (all or'ed) */
185 unsigned int num_formats
; /* number of supported audio formats (list) */
186 struct list_head fmt_list
; /* format list */
187 struct snd_pcm_hw_constraint_list rate_list
; /* limited rates */
190 struct snd_urb_ops ops
; /* callbacks (must be filled at init) */
194 struct snd_usb_stream
{
195 struct snd_usb_audio
*chip
;
198 unsigned int fmt_type
; /* USB audio format type (1-3) */
199 struct snd_usb_substream substream
[2];
200 struct list_head list
;
205 * we keep the snd_usb_audio_t instances by ourselves for merging
206 * the all interfaces on the same card as one sound device.
209 static DEFINE_MUTEX(register_mutex
);
210 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
214 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
215 * this will overflow at approx 524 kHz
217 static inline unsigned get_usb_full_speed_rate(unsigned int rate
)
219 return ((rate
<< 13) + 62) / 125;
223 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
224 * this will overflow at approx 4 MHz
226 static inline unsigned get_usb_high_speed_rate(unsigned int rate
)
228 return ((rate
<< 10) + 62) / 125;
231 /* convert our full speed USB rate into sampling rate in Hz */
232 static inline unsigned get_full_speed_hz(unsigned int usb_rate
)
234 return (usb_rate
* 125 + (1 << 12)) >> 13;
237 /* convert our high speed USB rate into sampling rate in Hz */
238 static inline unsigned get_high_speed_hz(unsigned int usb_rate
)
240 return (usb_rate
* 125 + (1 << 9)) >> 10;
245 * prepare urb for full speed capture sync pipe
247 * fill the length and offset of each urb descriptor.
248 * the fixed 10.14 frequency is passed through the pipe.
250 static int prepare_capture_sync_urb(struct snd_usb_substream
*subs
,
251 struct snd_pcm_runtime
*runtime
,
254 unsigned char *cp
= urb
->transfer_buffer
;
255 struct snd_urb_ctx
*ctx
= urb
->context
;
257 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
258 urb
->iso_frame_desc
[0].length
= 3;
259 urb
->iso_frame_desc
[0].offset
= 0;
260 cp
[0] = subs
->freqn
>> 2;
261 cp
[1] = subs
->freqn
>> 10;
262 cp
[2] = subs
->freqn
>> 18;
267 * prepare urb for high speed capture sync pipe
269 * fill the length and offset of each urb descriptor.
270 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
272 static int prepare_capture_sync_urb_hs(struct snd_usb_substream
*subs
,
273 struct snd_pcm_runtime
*runtime
,
276 unsigned char *cp
= urb
->transfer_buffer
;
277 struct snd_urb_ctx
*ctx
= urb
->context
;
279 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
280 urb
->iso_frame_desc
[0].length
= 4;
281 urb
->iso_frame_desc
[0].offset
= 0;
283 cp
[1] = subs
->freqn
>> 8;
284 cp
[2] = subs
->freqn
>> 16;
285 cp
[3] = subs
->freqn
>> 24;
290 * process after capture sync complete
293 static int retire_capture_sync_urb(struct snd_usb_substream
*subs
,
294 struct snd_pcm_runtime
*runtime
,
301 * prepare urb for capture data pipe
303 * fill the offset and length of each descriptor.
305 * we use a temporary buffer to write the captured data.
306 * since the length of written data is determined by host, we cannot
307 * write onto the pcm buffer directly... the data is thus copied
308 * later at complete callback to the global buffer.
310 static int prepare_capture_urb(struct snd_usb_substream
*subs
,
311 struct snd_pcm_runtime
*runtime
,
315 struct snd_urb_ctx
*ctx
= urb
->context
;
318 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
319 for (i
= 0; i
< ctx
->packets
; i
++) {
320 urb
->iso_frame_desc
[i
].offset
= offs
;
321 urb
->iso_frame_desc
[i
].length
= subs
->curpacksize
;
322 offs
+= subs
->curpacksize
;
324 urb
->transfer_buffer_length
= offs
;
325 urb
->number_of_packets
= ctx
->packets
;
330 * process after capture complete
332 * copy the data from each desctiptor to the pcm buffer, and
333 * update the current position.
335 static int retire_capture_urb(struct snd_usb_substream
*subs
,
336 struct snd_pcm_runtime
*runtime
,
342 unsigned int stride
, len
, oldptr
;
343 int period_elapsed
= 0;
345 stride
= runtime
->frame_bits
>> 3;
347 for (i
= 0; i
< urb
->number_of_packets
; i
++) {
348 cp
= (unsigned char *)urb
->transfer_buffer
+ urb
->iso_frame_desc
[i
].offset
;
349 if (urb
->iso_frame_desc
[i
].status
) {
350 snd_printd(KERN_ERR
"frame %d active: %d\n", i
, urb
->iso_frame_desc
[i
].status
);
353 len
= urb
->iso_frame_desc
[i
].actual_length
/ stride
;
356 /* update the current pointer */
357 spin_lock_irqsave(&subs
->lock
, flags
);
358 oldptr
= subs
->hwptr_done
;
359 subs
->hwptr_done
+= len
;
360 if (subs
->hwptr_done
>= runtime
->buffer_size
)
361 subs
->hwptr_done
-= runtime
->buffer_size
;
362 subs
->transfer_done
+= len
;
363 if (subs
->transfer_done
>= runtime
->period_size
) {
364 subs
->transfer_done
-= runtime
->period_size
;
367 spin_unlock_irqrestore(&subs
->lock
, flags
);
368 /* copy a data chunk */
369 if (oldptr
+ len
> runtime
->buffer_size
) {
370 unsigned int cnt
= runtime
->buffer_size
- oldptr
;
371 unsigned int blen
= cnt
* stride
;
372 memcpy(runtime
->dma_area
+ oldptr
* stride
, cp
, blen
);
373 memcpy(runtime
->dma_area
, cp
+ blen
, len
* stride
- blen
);
375 memcpy(runtime
->dma_area
+ oldptr
* stride
, cp
, len
* stride
);
379 snd_pcm_period_elapsed(subs
->pcm_substream
);
384 * Process after capture complete when paused. Nothing to do.
386 static int retire_paused_capture_urb(struct snd_usb_substream
*subs
,
387 struct snd_pcm_runtime
*runtime
,
395 * prepare urb for full speed playback sync pipe
397 * set up the offset and length to receive the current frequency.
400 static int prepare_playback_sync_urb(struct snd_usb_substream
*subs
,
401 struct snd_pcm_runtime
*runtime
,
404 struct snd_urb_ctx
*ctx
= urb
->context
;
406 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
407 urb
->iso_frame_desc
[0].length
= 3;
408 urb
->iso_frame_desc
[0].offset
= 0;
413 * prepare urb for high speed playback sync pipe
415 * set up the offset and length to receive the current frequency.
418 static int prepare_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
419 struct snd_pcm_runtime
*runtime
,
422 struct snd_urb_ctx
*ctx
= urb
->context
;
424 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
425 urb
->iso_frame_desc
[0].length
= 4;
426 urb
->iso_frame_desc
[0].offset
= 0;
431 * process after full speed playback sync complete
433 * retrieve the current 10.14 frequency from pipe, and set it.
434 * the value is referred in prepare_playback_urb().
436 static int retire_playback_sync_urb(struct snd_usb_substream
*subs
,
437 struct snd_pcm_runtime
*runtime
,
443 if (urb
->iso_frame_desc
[0].status
== 0 &&
444 urb
->iso_frame_desc
[0].actual_length
== 3) {
445 f
= combine_triple((u8
*)urb
->transfer_buffer
) << 2;
446 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
447 spin_lock_irqsave(&subs
->lock
, flags
);
449 spin_unlock_irqrestore(&subs
->lock
, flags
);
457 * process after high speed playback sync complete
459 * retrieve the current 12.13 frequency from pipe, and set it.
460 * the value is referred in prepare_playback_urb().
462 static int retire_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
463 struct snd_pcm_runtime
*runtime
,
469 if (urb
->iso_frame_desc
[0].status
== 0 &&
470 urb
->iso_frame_desc
[0].actual_length
== 4) {
471 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
472 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
473 spin_lock_irqsave(&subs
->lock
, flags
);
475 spin_unlock_irqrestore(&subs
->lock
, flags
);
483 * process after E-Mu 0202/0404 high speed playback sync complete
485 * These devices return the number of samples per packet instead of the number
486 * of samples per microframe.
488 static int retire_playback_sync_urb_hs_emu(struct snd_usb_substream
*subs
,
489 struct snd_pcm_runtime
*runtime
,
495 if (urb
->iso_frame_desc
[0].status
== 0 &&
496 urb
->iso_frame_desc
[0].actual_length
== 4) {
497 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
498 f
>>= subs
->datainterval
;
499 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
500 spin_lock_irqsave(&subs
->lock
, flags
);
502 spin_unlock_irqrestore(&subs
->lock
, flags
);
509 /* determine the number of frames in the next packet */
510 static int snd_usb_audio_next_packet_size(struct snd_usb_substream
*subs
)
513 return subs
->maxframesize
;
515 subs
->phase
= (subs
->phase
& 0xffff)
516 + (subs
->freqm
<< subs
->datainterval
);
517 return min(subs
->phase
>> 16, subs
->maxframesize
);
522 * Prepare urb for streaming before playback starts or when paused.
524 * We don't have any data, so we send a frame of silence.
526 static int prepare_nodata_playback_urb(struct snd_usb_substream
*subs
,
527 struct snd_pcm_runtime
*runtime
,
530 unsigned int i
, offs
, counts
;
531 struct snd_urb_ctx
*ctx
= urb
->context
;
532 int stride
= runtime
->frame_bits
>> 3;
535 urb
->dev
= ctx
->subs
->dev
;
536 urb
->number_of_packets
= subs
->packs_per_ms
;
537 for (i
= 0; i
< subs
->packs_per_ms
; ++i
) {
538 counts
= snd_usb_audio_next_packet_size(subs
);
539 urb
->iso_frame_desc
[i
].offset
= offs
* stride
;
540 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
543 urb
->transfer_buffer_length
= offs
* stride
;
544 memset(urb
->transfer_buffer
,
545 subs
->cur_audiofmt
->format
== SNDRV_PCM_FORMAT_U8
? 0x80 : 0,
551 * prepare urb for playback data pipe
553 * Since a URB can handle only a single linear buffer, we must use double
554 * buffering when the data to be transferred overflows the buffer boundary.
555 * To avoid inconsistencies when updating hwptr_done, we use double buffering
558 static int prepare_playback_urb(struct snd_usb_substream
*subs
,
559 struct snd_pcm_runtime
*runtime
,
565 int period_elapsed
= 0;
566 struct snd_urb_ctx
*ctx
= urb
->context
;
568 stride
= runtime
->frame_bits
>> 3;
571 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
572 urb
->number_of_packets
= 0;
573 spin_lock_irqsave(&subs
->lock
, flags
);
574 for (i
= 0; i
< ctx
->packets
; i
++) {
575 counts
= snd_usb_audio_next_packet_size(subs
);
576 /* set up descriptor */
577 urb
->iso_frame_desc
[i
].offset
= offs
* stride
;
578 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
580 urb
->number_of_packets
++;
581 subs
->transfer_done
+= counts
;
582 if (subs
->transfer_done
>= runtime
->period_size
) {
583 subs
->transfer_done
-= runtime
->period_size
;
585 if (subs
->fmt_type
== USB_FORMAT_TYPE_II
) {
586 if (subs
->transfer_done
> 0) {
587 /* FIXME: fill-max mode is not
589 offs
-= subs
->transfer_done
;
590 counts
-= subs
->transfer_done
;
591 urb
->iso_frame_desc
[i
].length
=
593 subs
->transfer_done
= 0;
596 if (i
< ctx
->packets
) {
597 /* add a transfer delimiter */
598 urb
->iso_frame_desc
[i
].offset
=
600 urb
->iso_frame_desc
[i
].length
= 0;
601 urb
->number_of_packets
++;
606 /* finish at the frame boundary at/after the period boundary */
607 if (period_elapsed
&&
608 (i
& (subs
->packs_per_ms
- 1)) == subs
->packs_per_ms
- 1)
611 if (subs
->hwptr_done
+ offs
> runtime
->buffer_size
) {
612 /* err, the transferred area goes over buffer boundary. */
613 unsigned int len
= runtime
->buffer_size
- subs
->hwptr_done
;
614 memcpy(urb
->transfer_buffer
,
615 runtime
->dma_area
+ subs
->hwptr_done
* stride
,
617 memcpy(urb
->transfer_buffer
+ len
* stride
,
619 (offs
- len
) * stride
);
621 memcpy(urb
->transfer_buffer
,
622 runtime
->dma_area
+ subs
->hwptr_done
* stride
,
625 subs
->hwptr_done
+= offs
;
626 if (subs
->hwptr_done
>= runtime
->buffer_size
)
627 subs
->hwptr_done
-= runtime
->buffer_size
;
628 spin_unlock_irqrestore(&subs
->lock
, flags
);
629 urb
->transfer_buffer_length
= offs
* stride
;
631 snd_pcm_period_elapsed(subs
->pcm_substream
);
636 * process after playback data complete
639 static int retire_playback_urb(struct snd_usb_substream
*subs
,
640 struct snd_pcm_runtime
*runtime
,
649 static struct snd_urb_ops audio_urb_ops
[2] = {
651 .prepare
= prepare_nodata_playback_urb
,
652 .retire
= retire_playback_urb
,
653 .prepare_sync
= prepare_playback_sync_urb
,
654 .retire_sync
= retire_playback_sync_urb
,
657 .prepare
= prepare_capture_urb
,
658 .retire
= retire_capture_urb
,
659 .prepare_sync
= prepare_capture_sync_urb
,
660 .retire_sync
= retire_capture_sync_urb
,
664 static struct snd_urb_ops audio_urb_ops_high_speed
[2] = {
666 .prepare
= prepare_nodata_playback_urb
,
667 .retire
= retire_playback_urb
,
668 .prepare_sync
= prepare_playback_sync_urb_hs
,
669 .retire_sync
= retire_playback_sync_urb_hs
,
672 .prepare
= prepare_capture_urb
,
673 .retire
= retire_capture_urb
,
674 .prepare_sync
= prepare_capture_sync_urb_hs
,
675 .retire_sync
= retire_capture_sync_urb
,
680 * complete callback from data urb
682 static void snd_complete_urb(struct urb
*urb
)
684 struct snd_urb_ctx
*ctx
= urb
->context
;
685 struct snd_usb_substream
*subs
= ctx
->subs
;
686 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
689 if ((subs
->running
&& subs
->ops
.retire(subs
, substream
->runtime
, urb
)) ||
690 ! subs
->running
|| /* can be stopped during retire callback */
691 (err
= subs
->ops
.prepare(subs
, substream
->runtime
, urb
)) < 0 ||
692 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
693 clear_bit(ctx
->index
, &subs
->active_mask
);
695 snd_printd(KERN_ERR
"cannot submit urb (err = %d)\n", err
);
696 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
703 * complete callback from sync urb
705 static void snd_complete_sync_urb(struct urb
*urb
)
707 struct snd_urb_ctx
*ctx
= urb
->context
;
708 struct snd_usb_substream
*subs
= ctx
->subs
;
709 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
712 if ((subs
->running
&& subs
->ops
.retire_sync(subs
, substream
->runtime
, urb
)) ||
713 ! subs
->running
|| /* can be stopped during retire callback */
714 (err
= subs
->ops
.prepare_sync(subs
, substream
->runtime
, urb
)) < 0 ||
715 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
716 clear_bit(ctx
->index
+ 16, &subs
->active_mask
);
718 snd_printd(KERN_ERR
"cannot submit sync urb (err = %d)\n", err
);
719 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
725 /* get the physical page pointer at the given offset */
726 static struct page
*snd_pcm_get_vmalloc_page(struct snd_pcm_substream
*subs
,
727 unsigned long offset
)
729 void *pageptr
= subs
->runtime
->dma_area
+ offset
;
730 return vmalloc_to_page(pageptr
);
733 /* allocate virtual buffer; may be called more than once */
734 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream
*subs
, size_t size
)
736 struct snd_pcm_runtime
*runtime
= subs
->runtime
;
737 if (runtime
->dma_area
) {
738 if (runtime
->dma_bytes
>= size
)
739 return 0; /* already large enough */
740 vfree(runtime
->dma_area
);
742 runtime
->dma_area
= vmalloc(size
);
743 if (! runtime
->dma_area
)
745 runtime
->dma_bytes
= size
;
749 /* free virtual buffer; may be called more than once */
750 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream
*subs
)
752 struct snd_pcm_runtime
*runtime
= subs
->runtime
;
754 vfree(runtime
->dma_area
);
755 runtime
->dma_area
= NULL
;
761 * unlink active urbs.
763 static int deactivate_urbs(struct snd_usb_substream
*subs
, int force
, int can_sleep
)
770 if (!force
&& subs
->stream
->chip
->shutdown
) /* to be sure... */
773 async
= !can_sleep
&& async_unlink
;
775 if (! async
&& in_interrupt())
778 for (i
= 0; i
< subs
->nurbs
; i
++) {
779 if (test_bit(i
, &subs
->active_mask
)) {
780 if (! test_and_set_bit(i
, &subs
->unlink_mask
)) {
781 struct urb
*u
= subs
->dataurb
[i
].urb
;
789 if (subs
->syncpipe
) {
790 for (i
= 0; i
< SYNC_URBS
; i
++) {
791 if (test_bit(i
+16, &subs
->active_mask
)) {
792 if (! test_and_set_bit(i
+16, &subs
->unlink_mask
)) {
793 struct urb
*u
= subs
->syncurb
[i
].urb
;
806 static const char *usb_error_string(int err
)
812 return "endpoint not enabled";
814 return "endpoint stalled";
816 return "not enough bandwidth";
818 return "device disabled";
820 return "device suspended";
821 #ifndef CONFIG_USB_EHCI_SPLIT_ISO
823 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
829 return "internal error";
831 return "unknown error";
836 * set up and start data/sync urbs
838 static int start_urbs(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
)
843 if (subs
->stream
->chip
->shutdown
)
846 for (i
= 0; i
< subs
->nurbs
; i
++) {
847 snd_assert(subs
->dataurb
[i
].urb
, return -EINVAL
);
848 if (subs
->ops
.prepare(subs
, runtime
, subs
->dataurb
[i
].urb
) < 0) {
849 snd_printk(KERN_ERR
"cannot prepare datapipe for urb %d\n", i
);
853 if (subs
->syncpipe
) {
854 for (i
= 0; i
< SYNC_URBS
; i
++) {
855 snd_assert(subs
->syncurb
[i
].urb
, return -EINVAL
);
856 if (subs
->ops
.prepare_sync(subs
, runtime
, subs
->syncurb
[i
].urb
) < 0) {
857 snd_printk(KERN_ERR
"cannot prepare syncpipe for urb %d\n", i
);
863 subs
->active_mask
= 0;
864 subs
->unlink_mask
= 0;
866 for (i
= 0; i
< subs
->nurbs
; i
++) {
867 err
= usb_submit_urb(subs
->dataurb
[i
].urb
, GFP_ATOMIC
);
869 snd_printk(KERN_ERR
"cannot submit datapipe "
870 "for urb %d, error %d: %s\n",
871 i
, err
, usb_error_string(err
));
874 set_bit(i
, &subs
->active_mask
);
876 if (subs
->syncpipe
) {
877 for (i
= 0; i
< SYNC_URBS
; i
++) {
878 err
= usb_submit_urb(subs
->syncurb
[i
].urb
, GFP_ATOMIC
);
880 snd_printk(KERN_ERR
"cannot submit syncpipe "
881 "for urb %d, error %d: %s\n",
882 i
, err
, usb_error_string(err
));
885 set_bit(i
+ 16, &subs
->active_mask
);
891 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
892 deactivate_urbs(subs
, 0, 0);
898 * wait until all urbs are processed.
900 static int wait_clear_urbs(struct snd_usb_substream
*subs
)
902 unsigned long end_time
= jiffies
+ msecs_to_jiffies(1000);
908 for (i
= 0; i
< subs
->nurbs
; i
++) {
909 if (test_bit(i
, &subs
->active_mask
))
912 if (subs
->syncpipe
) {
913 for (i
= 0; i
< SYNC_URBS
; i
++) {
914 if (test_bit(i
+ 16, &subs
->active_mask
))
920 schedule_timeout_uninterruptible(1);
921 } while (time_before(jiffies
, end_time
));
923 snd_printk(KERN_ERR
"timeout: still %d active urbs..\n", alive
);
929 * return the current pcm pointer. just return the hwptr_done value.
931 static snd_pcm_uframes_t
snd_usb_pcm_pointer(struct snd_pcm_substream
*substream
)
933 struct snd_usb_substream
*subs
;
934 snd_pcm_uframes_t hwptr_done
;
936 subs
= (struct snd_usb_substream
*)substream
->runtime
->private_data
;
937 spin_lock(&subs
->lock
);
938 hwptr_done
= subs
->hwptr_done
;
939 spin_unlock(&subs
->lock
);
945 * start/stop playback substream
947 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream
*substream
,
950 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
953 case SNDRV_PCM_TRIGGER_START
:
954 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
955 subs
->ops
.prepare
= prepare_playback_urb
;
957 case SNDRV_PCM_TRIGGER_STOP
:
958 return deactivate_urbs(subs
, 0, 0);
959 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
960 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
968 * start/stop capture substream
970 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream
*substream
,
973 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
976 case SNDRV_PCM_TRIGGER_START
:
977 subs
->ops
.retire
= retire_capture_urb
;
978 return start_urbs(subs
, substream
->runtime
);
979 case SNDRV_PCM_TRIGGER_STOP
:
980 return deactivate_urbs(subs
, 0, 0);
981 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
982 subs
->ops
.retire
= retire_paused_capture_urb
;
984 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
985 subs
->ops
.retire
= retire_capture_urb
;
996 static void release_urb_ctx(struct snd_urb_ctx
*u
)
1000 usb_buffer_free(u
->subs
->dev
, u
->buffer_size
,
1001 u
->urb
->transfer_buffer
,
1002 u
->urb
->transfer_dma
);
1003 usb_free_urb(u
->urb
);
1009 * release a substream
1011 static void release_substream_urbs(struct snd_usb_substream
*subs
, int force
)
1015 /* stop urbs (to be sure) */
1016 deactivate_urbs(subs
, force
, 1);
1017 wait_clear_urbs(subs
);
1019 for (i
= 0; i
< MAX_URBS
; i
++)
1020 release_urb_ctx(&subs
->dataurb
[i
]);
1021 for (i
= 0; i
< SYNC_URBS
; i
++)
1022 release_urb_ctx(&subs
->syncurb
[i
]);
1023 usb_buffer_free(subs
->dev
, SYNC_URBS
* 4,
1024 subs
->syncbuf
, subs
->sync_dma
);
1025 subs
->syncbuf
= NULL
;
1030 * initialize a substream for plaback/capture
1032 static int init_substream_urbs(struct snd_usb_substream
*subs
, unsigned int period_bytes
,
1033 unsigned int rate
, unsigned int frame_bits
)
1035 unsigned int maxsize
, n
, i
;
1036 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1037 unsigned int npacks
[MAX_URBS
], urb_packs
, total_packs
, packs_per_ms
;
1039 /* calculate the frequency in 16.16 format */
1040 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1041 subs
->freqn
= get_usb_full_speed_rate(rate
);
1043 subs
->freqn
= get_usb_high_speed_rate(rate
);
1044 subs
->freqm
= subs
->freqn
;
1045 /* calculate max. frequency */
1046 if (subs
->maxpacksize
) {
1047 /* whatever fits into a max. size packet */
1048 maxsize
= subs
->maxpacksize
;
1049 subs
->freqmax
= (maxsize
/ (frame_bits
>> 3))
1050 << (16 - subs
->datainterval
);
1052 /* no max. packet size: just take 25% higher than nominal */
1053 subs
->freqmax
= subs
->freqn
+ (subs
->freqn
>> 2);
1054 maxsize
= ((subs
->freqmax
+ 0xffff) * (frame_bits
>> 3))
1055 >> (16 - subs
->datainterval
);
1060 subs
->curpacksize
= subs
->maxpacksize
;
1062 subs
->curpacksize
= maxsize
;
1064 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
)
1065 packs_per_ms
= 8 >> subs
->datainterval
;
1068 subs
->packs_per_ms
= packs_per_ms
;
1071 urb_packs
= nrpacks
;
1072 urb_packs
= max(urb_packs
, (unsigned int)MIN_PACKS_URB
);
1073 urb_packs
= min(urb_packs
, (unsigned int)MAX_PACKS
);
1076 urb_packs
*= packs_per_ms
;
1078 /* decide how many packets to be used */
1080 unsigned int minsize
;
1081 /* determine how small a packet can be */
1082 minsize
= (subs
->freqn
>> (16 - subs
->datainterval
))
1083 * (frame_bits
>> 3);
1084 /* with sync from device, assume it can be 12% lower */
1086 minsize
-= minsize
>> 3;
1087 minsize
= max(minsize
, 1u);
1088 total_packs
= (period_bytes
+ minsize
- 1) / minsize
;
1089 /* round up to multiple of packs_per_ms */
1090 total_packs
= (total_packs
+ packs_per_ms
- 1)
1091 & ~(packs_per_ms
- 1);
1092 /* we need at least two URBs for queueing */
1093 if (total_packs
< 2 * MIN_PACKS_URB
* packs_per_ms
)
1094 total_packs
= 2 * MIN_PACKS_URB
* packs_per_ms
;
1096 total_packs
= MAX_URBS
* urb_packs
;
1098 subs
->nurbs
= (total_packs
+ urb_packs
- 1) / urb_packs
;
1099 if (subs
->nurbs
> MAX_URBS
) {
1101 subs
->nurbs
= MAX_URBS
;
1102 total_packs
= MAX_URBS
* urb_packs
;
1105 for (i
= 0; i
< subs
->nurbs
; i
++) {
1106 npacks
[i
] = n
> urb_packs
? urb_packs
: n
;
1109 if (subs
->nurbs
<= 1) {
1110 /* too little - we need at least two packets
1111 * to ensure contiguous playback/capture
1114 npacks
[0] = (total_packs
+ 1) / 2;
1115 npacks
[1] = total_packs
- npacks
[0];
1116 } else if (npacks
[subs
->nurbs
-1] < MIN_PACKS_URB
* packs_per_ms
) {
1117 /* the last packet is too small.. */
1118 if (subs
->nurbs
> 2) {
1119 /* merge to the first one */
1120 npacks
[0] += npacks
[subs
->nurbs
- 1];
1125 npacks
[0] = (total_packs
+ 1) / 2;
1126 npacks
[1] = total_packs
- npacks
[0];
1130 /* allocate and initialize data urbs */
1131 for (i
= 0; i
< subs
->nurbs
; i
++) {
1132 struct snd_urb_ctx
*u
= &subs
->dataurb
[i
];
1135 u
->packets
= npacks
[i
];
1136 u
->buffer_size
= maxsize
* u
->packets
;
1137 if (subs
->fmt_type
== USB_FORMAT_TYPE_II
)
1138 u
->packets
++; /* for transfer delimiter */
1139 u
->urb
= usb_alloc_urb(u
->packets
, GFP_KERNEL
);
1142 u
->urb
->transfer_buffer
=
1143 usb_buffer_alloc(subs
->dev
, u
->buffer_size
, GFP_KERNEL
,
1144 &u
->urb
->transfer_dma
);
1145 if (! u
->urb
->transfer_buffer
)
1147 u
->urb
->pipe
= subs
->datapipe
;
1148 u
->urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1149 u
->urb
->interval
= 1 << subs
->datainterval
;
1150 u
->urb
->context
= u
;
1151 u
->urb
->complete
= snd_complete_urb
;
1154 if (subs
->syncpipe
) {
1155 /* allocate and initialize sync urbs */
1156 subs
->syncbuf
= usb_buffer_alloc(subs
->dev
, SYNC_URBS
* 4,
1157 GFP_KERNEL
, &subs
->sync_dma
);
1158 if (! subs
->syncbuf
)
1160 for (i
= 0; i
< SYNC_URBS
; i
++) {
1161 struct snd_urb_ctx
*u
= &subs
->syncurb
[i
];
1165 u
->urb
= usb_alloc_urb(1, GFP_KERNEL
);
1168 u
->urb
->transfer_buffer
= subs
->syncbuf
+ i
* 4;
1169 u
->urb
->transfer_dma
= subs
->sync_dma
+ i
* 4;
1170 u
->urb
->transfer_buffer_length
= 4;
1171 u
->urb
->pipe
= subs
->syncpipe
;
1172 u
->urb
->transfer_flags
= URB_ISO_ASAP
|
1173 URB_NO_TRANSFER_DMA_MAP
;
1174 u
->urb
->number_of_packets
= 1;
1175 u
->urb
->interval
= 1 << subs
->syncinterval
;
1176 u
->urb
->context
= u
;
1177 u
->urb
->complete
= snd_complete_sync_urb
;
1183 release_substream_urbs(subs
, 0);
1189 * find a matching audio format
1191 static struct audioformat
*find_format(struct snd_usb_substream
*subs
, unsigned int format
,
1192 unsigned int rate
, unsigned int channels
)
1194 struct list_head
*p
;
1195 struct audioformat
*found
= NULL
;
1196 int cur_attr
= 0, attr
;
1198 list_for_each(p
, &subs
->fmt_list
) {
1199 struct audioformat
*fp
;
1200 fp
= list_entry(p
, struct audioformat
, list
);
1201 if (fp
->format
!= format
|| fp
->channels
!= channels
)
1203 if (rate
< fp
->rate_min
|| rate
> fp
->rate_max
)
1205 if (! (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)) {
1207 for (i
= 0; i
< fp
->nr_rates
; i
++)
1208 if (fp
->rate_table
[i
] == rate
)
1210 if (i
>= fp
->nr_rates
)
1213 attr
= fp
->ep_attr
& EP_ATTR_MASK
;
1219 /* avoid async out and adaptive in if the other method
1220 * supports the same format.
1221 * this is a workaround for the case like
1222 * M-audio audiophile USB.
1224 if (attr
!= cur_attr
) {
1225 if ((attr
== EP_ATTR_ASYNC
&&
1226 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1227 (attr
== EP_ATTR_ADAPTIVE
&&
1228 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
))
1230 if ((cur_attr
== EP_ATTR_ASYNC
&&
1231 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1232 (cur_attr
== EP_ATTR_ADAPTIVE
&&
1233 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
)) {
1239 /* find the format with the largest max. packet size */
1240 if (fp
->maxpacksize
> found
->maxpacksize
) {
1250 * initialize the picth control and sample rate
1252 static int init_usb_pitch(struct usb_device
*dev
, int iface
,
1253 struct usb_host_interface
*alts
,
1254 struct audioformat
*fmt
)
1257 unsigned char data
[1];
1260 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1261 /* if endpoint has pitch control, enable it */
1262 if (fmt
->attributes
& EP_CS_ATTR_PITCH_CONTROL
) {
1264 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
1265 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1266 PITCH_CONTROL
<< 8, ep
, data
, 1, 1000)) < 0) {
1267 snd_printk(KERN_ERR
"%d:%d:%d: cannot set enable PITCH\n",
1268 dev
->devnum
, iface
, ep
);
1275 static int init_usb_sample_rate(struct usb_device
*dev
, int iface
,
1276 struct usb_host_interface
*alts
,
1277 struct audioformat
*fmt
, int rate
)
1280 unsigned char data
[3];
1283 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1284 /* if endpoint has sampling rate control, set it */
1285 if (fmt
->attributes
& EP_CS_ATTR_SAMPLE_RATE
) {
1288 data
[1] = rate
>> 8;
1289 data
[2] = rate
>> 16;
1290 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
1291 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1292 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000)) < 0) {
1293 snd_printk(KERN_ERR
"%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1294 dev
->devnum
, iface
, fmt
->altsetting
, rate
, ep
);
1297 if ((err
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), GET_CUR
,
1298 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_IN
,
1299 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000)) < 0) {
1300 snd_printk(KERN_WARNING
"%d:%d:%d: cannot get freq at ep 0x%x\n",
1301 dev
->devnum
, iface
, fmt
->altsetting
, ep
);
1302 return 0; /* some devices don't support reading */
1304 crate
= data
[0] | (data
[1] << 8) | (data
[2] << 16);
1305 if (crate
!= rate
) {
1306 snd_printd(KERN_WARNING
"current rate %d is different from the runtime rate %d\n", crate
, rate
);
1307 // runtime->rate = crate;
1314 * find a matching format and set up the interface
1316 static int set_format(struct snd_usb_substream
*subs
, struct audioformat
*fmt
)
1318 struct usb_device
*dev
= subs
->dev
;
1319 struct usb_host_interface
*alts
;
1320 struct usb_interface_descriptor
*altsd
;
1321 struct usb_interface
*iface
;
1322 unsigned int ep
, attr
;
1323 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1326 iface
= usb_ifnum_to_if(dev
, fmt
->iface
);
1327 snd_assert(iface
, return -EINVAL
);
1328 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1329 altsd
= get_iface_desc(alts
);
1330 snd_assert(altsd
->bAlternateSetting
== fmt
->altsetting
, return -EINVAL
);
1332 if (fmt
== subs
->cur_audiofmt
)
1335 /* close the old interface */
1336 if (subs
->interface
>= 0 && subs
->interface
!= fmt
->iface
) {
1337 if (usb_set_interface(subs
->dev
, subs
->interface
, 0) < 0) {
1338 snd_printk(KERN_ERR
"%d:%d:%d: return to setting 0 failed\n",
1339 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1342 subs
->interface
= -1;
1347 if (subs
->interface
!= fmt
->iface
|| subs
->format
!= fmt
->altset_idx
) {
1348 if (usb_set_interface(dev
, fmt
->iface
, fmt
->altsetting
) < 0) {
1349 snd_printk(KERN_ERR
"%d:%d:%d: usb_set_interface failed\n",
1350 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1353 snd_printdd(KERN_INFO
"setting usb interface %d:%d\n", fmt
->iface
, fmt
->altsetting
);
1354 subs
->interface
= fmt
->iface
;
1355 subs
->format
= fmt
->altset_idx
;
1358 /* create a data pipe */
1359 ep
= fmt
->endpoint
& USB_ENDPOINT_NUMBER_MASK
;
1361 subs
->datapipe
= usb_sndisocpipe(dev
, ep
);
1363 subs
->datapipe
= usb_rcvisocpipe(dev
, ep
);
1364 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
&&
1365 get_endpoint(alts
, 0)->bInterval
>= 1 &&
1366 get_endpoint(alts
, 0)->bInterval
<= 4)
1367 subs
->datainterval
= get_endpoint(alts
, 0)->bInterval
- 1;
1369 subs
->datainterval
= 0;
1370 subs
->syncpipe
= subs
->syncinterval
= 0;
1371 subs
->maxpacksize
= fmt
->maxpacksize
;
1374 /* we need a sync pipe in async OUT or adaptive IN mode */
1375 /* check the number of EP, since some devices have broken
1376 * descriptors which fool us. if it has only one EP,
1377 * assume it as adaptive-out or sync-in.
1379 attr
= fmt
->ep_attr
& EP_ATTR_MASK
;
1380 if (((is_playback
&& attr
== EP_ATTR_ASYNC
) ||
1381 (! is_playback
&& attr
== EP_ATTR_ADAPTIVE
)) &&
1382 altsd
->bNumEndpoints
>= 2) {
1383 /* check sync-pipe endpoint */
1384 /* ... and check descriptor size before accessing bSynchAddress
1385 because there is a version of the SB Audigy 2 NX firmware lacking
1386 the audio fields in the endpoint descriptors */
1387 if ((get_endpoint(alts
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != 0x01 ||
1388 (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1389 get_endpoint(alts
, 1)->bSynchAddress
!= 0)) {
1390 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1391 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1394 ep
= get_endpoint(alts
, 1)->bEndpointAddress
;
1395 if (get_endpoint(alts
, 0)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1396 (( is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
| USB_DIR_IN
)) ||
1397 (!is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
& ~USB_DIR_IN
)))) {
1398 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1399 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1402 ep
&= USB_ENDPOINT_NUMBER_MASK
;
1404 subs
->syncpipe
= usb_rcvisocpipe(dev
, ep
);
1406 subs
->syncpipe
= usb_sndisocpipe(dev
, ep
);
1407 if (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1408 get_endpoint(alts
, 1)->bRefresh
>= 1 &&
1409 get_endpoint(alts
, 1)->bRefresh
<= 9)
1410 subs
->syncinterval
= get_endpoint(alts
, 1)->bRefresh
;
1411 else if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1412 subs
->syncinterval
= 1;
1413 else if (get_endpoint(alts
, 1)->bInterval
>= 1 &&
1414 get_endpoint(alts
, 1)->bInterval
<= 16)
1415 subs
->syncinterval
= get_endpoint(alts
, 1)->bInterval
- 1;
1417 subs
->syncinterval
= 3;
1420 /* always fill max packet size */
1421 if (fmt
->attributes
& EP_CS_ATTR_FILL_MAX
)
1424 if ((err
= init_usb_pitch(dev
, subs
->interface
, alts
, fmt
)) < 0)
1427 subs
->cur_audiofmt
= fmt
;
1430 printk("setting done: format = %d, rate = %d, channels = %d\n",
1431 fmt
->format
, fmt
->rate
, fmt
->channels
);
1432 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1433 subs
->datapipe
, subs
->syncpipe
);
1440 * hw_params callback
1442 * allocate a buffer and set the given audio format.
1444 * so far we use a physically linear buffer although packetize transfer
1445 * doesn't need a continuous area.
1446 * if sg buffer is supported on the later version of alsa, we'll follow
1449 static int snd_usb_hw_params(struct snd_pcm_substream
*substream
,
1450 struct snd_pcm_hw_params
*hw_params
)
1452 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1453 struct audioformat
*fmt
;
1454 unsigned int channels
, rate
, format
;
1457 ret
= snd_pcm_alloc_vmalloc_buffer(substream
,
1458 params_buffer_bytes(hw_params
));
1462 format
= params_format(hw_params
);
1463 rate
= params_rate(hw_params
);
1464 channels
= params_channels(hw_params
);
1465 fmt
= find_format(subs
, format
, rate
, channels
);
1467 snd_printd(KERN_DEBUG
"cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1468 format
, rate
, channels
);
1472 changed
= subs
->cur_audiofmt
!= fmt
||
1473 subs
->period_bytes
!= params_period_bytes(hw_params
) ||
1474 subs
->cur_rate
!= rate
;
1475 if ((ret
= set_format(subs
, fmt
)) < 0)
1478 if (subs
->cur_rate
!= rate
) {
1479 struct usb_host_interface
*alts
;
1480 struct usb_interface
*iface
;
1481 iface
= usb_ifnum_to_if(subs
->dev
, fmt
->iface
);
1482 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1483 ret
= init_usb_sample_rate(subs
->dev
, subs
->interface
, alts
, fmt
, rate
);
1486 subs
->cur_rate
= rate
;
1490 /* format changed */
1491 release_substream_urbs(subs
, 0);
1492 /* influenced: period_bytes, channels, rate, format, */
1493 ret
= init_substream_urbs(subs
, params_period_bytes(hw_params
),
1494 params_rate(hw_params
),
1495 snd_pcm_format_physical_width(params_format(hw_params
)) * params_channels(hw_params
));
1504 * reset the audio format and release the buffer
1506 static int snd_usb_hw_free(struct snd_pcm_substream
*substream
)
1508 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1510 subs
->cur_audiofmt
= NULL
;
1512 subs
->period_bytes
= 0;
1513 if (!subs
->stream
->chip
->shutdown
)
1514 release_substream_urbs(subs
, 0);
1515 return snd_pcm_free_vmalloc_buffer(substream
);
1521 * only a few subtle things...
1523 static int snd_usb_pcm_prepare(struct snd_pcm_substream
*substream
)
1525 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1526 struct snd_usb_substream
*subs
= runtime
->private_data
;
1528 if (! subs
->cur_audiofmt
) {
1529 snd_printk(KERN_ERR
"usbaudio: no format is specified!\n");
1533 /* some unit conversions in runtime */
1534 subs
->maxframesize
= bytes_to_frames(runtime
, subs
->maxpacksize
);
1535 subs
->curframesize
= bytes_to_frames(runtime
, subs
->curpacksize
);
1537 /* reset the pointer */
1538 subs
->hwptr_done
= 0;
1539 subs
->transfer_done
= 0;
1542 /* clear urbs (to be sure) */
1543 deactivate_urbs(subs
, 0, 1);
1544 wait_clear_urbs(subs
);
1546 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1547 * updates for all URBs would happen at the same time when starting */
1548 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1549 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
1550 return start_urbs(subs
, runtime
);
1555 static struct snd_pcm_hardware snd_usb_hardware
=
1557 .info
= SNDRV_PCM_INFO_MMAP
|
1558 SNDRV_PCM_INFO_MMAP_VALID
|
1559 SNDRV_PCM_INFO_BATCH
|
1560 SNDRV_PCM_INFO_INTERLEAVED
|
1561 SNDRV_PCM_INFO_BLOCK_TRANSFER
|
1562 SNDRV_PCM_INFO_PAUSE
,
1563 .buffer_bytes_max
= 1024 * 1024,
1564 .period_bytes_min
= 64,
1565 .period_bytes_max
= 512 * 1024,
1567 .periods_max
= 1024,
1574 #ifdef HW_CONST_DEBUG
1575 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1577 #define hwc_debug(fmt, args...) /**/
1580 static int hw_check_valid_format(struct snd_pcm_hw_params
*params
, struct audioformat
*fp
)
1582 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1583 struct snd_interval
*ct
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1584 struct snd_mask
*fmts
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1586 /* check the format */
1587 if (! snd_mask_test(fmts
, fp
->format
)) {
1588 hwc_debug(" > check: no supported format %d\n", fp
->format
);
1591 /* check the channels */
1592 if (fp
->channels
< ct
->min
|| fp
->channels
> ct
->max
) {
1593 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp
->channels
, ct
->min
, ct
->max
);
1596 /* check the rate is within the range */
1597 if (fp
->rate_min
> it
->max
|| (fp
->rate_min
== it
->max
&& it
->openmax
)) {
1598 hwc_debug(" > check: rate_min %d > max %d\n", fp
->rate_min
, it
->max
);
1601 if (fp
->rate_max
< it
->min
|| (fp
->rate_max
== it
->min
&& it
->openmin
)) {
1602 hwc_debug(" > check: rate_max %d < min %d\n", fp
->rate_max
, it
->min
);
1608 static int hw_rule_rate(struct snd_pcm_hw_params
*params
,
1609 struct snd_pcm_hw_rule
*rule
)
1611 struct snd_usb_substream
*subs
= rule
->private;
1612 struct list_head
*p
;
1613 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1614 unsigned int rmin
, rmax
;
1617 hwc_debug("hw_rule_rate: (%d,%d)\n", it
->min
, it
->max
);
1620 list_for_each(p
, &subs
->fmt_list
) {
1621 struct audioformat
*fp
;
1622 fp
= list_entry(p
, struct audioformat
, list
);
1623 if (! hw_check_valid_format(params
, fp
))
1626 if (rmin
> fp
->rate_min
)
1627 rmin
= fp
->rate_min
;
1628 if (rmax
< fp
->rate_max
)
1629 rmax
= fp
->rate_max
;
1631 rmin
= fp
->rate_min
;
1632 rmax
= fp
->rate_max
;
1637 hwc_debug(" --> get empty\n");
1643 if (it
->min
< rmin
) {
1648 if (it
->max
> rmax
) {
1653 if (snd_interval_checkempty(it
)) {
1657 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1662 static int hw_rule_channels(struct snd_pcm_hw_params
*params
,
1663 struct snd_pcm_hw_rule
*rule
)
1665 struct snd_usb_substream
*subs
= rule
->private;
1666 struct list_head
*p
;
1667 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1668 unsigned int rmin
, rmax
;
1671 hwc_debug("hw_rule_channels: (%d,%d)\n", it
->min
, it
->max
);
1674 list_for_each(p
, &subs
->fmt_list
) {
1675 struct audioformat
*fp
;
1676 fp
= list_entry(p
, struct audioformat
, list
);
1677 if (! hw_check_valid_format(params
, fp
))
1680 if (rmin
> fp
->channels
)
1681 rmin
= fp
->channels
;
1682 if (rmax
< fp
->channels
)
1683 rmax
= fp
->channels
;
1685 rmin
= fp
->channels
;
1686 rmax
= fp
->channels
;
1691 hwc_debug(" --> get empty\n");
1697 if (it
->min
< rmin
) {
1702 if (it
->max
> rmax
) {
1707 if (snd_interval_checkempty(it
)) {
1711 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1715 static int hw_rule_format(struct snd_pcm_hw_params
*params
,
1716 struct snd_pcm_hw_rule
*rule
)
1718 struct snd_usb_substream
*subs
= rule
->private;
1719 struct list_head
*p
;
1720 struct snd_mask
*fmt
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1725 hwc_debug("hw_rule_format: %x:%x\n", fmt
->bits
[0], fmt
->bits
[1]);
1727 list_for_each(p
, &subs
->fmt_list
) {
1728 struct audioformat
*fp
;
1729 fp
= list_entry(p
, struct audioformat
, list
);
1730 if (! hw_check_valid_format(params
, fp
))
1732 fbits
|= (1ULL << fp
->format
);
1735 oldbits
[0] = fmt
->bits
[0];
1736 oldbits
[1] = fmt
->bits
[1];
1737 fmt
->bits
[0] &= (u32
)fbits
;
1738 fmt
->bits
[1] &= (u32
)(fbits
>> 32);
1739 if (! fmt
->bits
[0] && ! fmt
->bits
[1]) {
1740 hwc_debug(" --> get empty\n");
1743 changed
= (oldbits
[0] != fmt
->bits
[0] || oldbits
[1] != fmt
->bits
[1]);
1744 hwc_debug(" --> %x:%x (changed = %d)\n", fmt
->bits
[0], fmt
->bits
[1], changed
);
1751 * check whether the registered audio formats need special hw-constraints
1753 static int check_hw_params_convention(struct snd_usb_substream
*subs
)
1758 u32 cmaster
, rmaster
;
1759 u32 rate_min
= 0, rate_max
= 0;
1760 struct list_head
*p
;
1763 channels
= kcalloc(MAX_MASK
, sizeof(u32
), GFP_KERNEL
);
1764 rates
= kcalloc(MAX_MASK
, sizeof(u32
), GFP_KERNEL
);
1765 if (!channels
|| !rates
)
1768 list_for_each(p
, &subs
->fmt_list
) {
1769 struct audioformat
*f
;
1770 f
= list_entry(p
, struct audioformat
, list
);
1771 /* unconventional channels? */
1772 if (f
->channels
> 32)
1774 /* continuous rate min/max matches? */
1775 if (f
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
1776 if (rate_min
&& f
->rate_min
!= rate_min
)
1778 if (rate_max
&& f
->rate_max
!= rate_max
)
1780 rate_min
= f
->rate_min
;
1781 rate_max
= f
->rate_max
;
1783 /* combination of continuous rates and fixed rates? */
1784 if (rates
[f
->format
] & SNDRV_PCM_RATE_CONTINUOUS
) {
1785 if (f
->rates
!= rates
[f
->format
])
1788 if (f
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
1789 if (rates
[f
->format
] && rates
[f
->format
] != f
->rates
)
1792 channels
[f
->format
] |= (1 << f
->channels
);
1793 rates
[f
->format
] |= f
->rates
;
1795 if (f
->rates
& SNDRV_PCM_RATE_KNOT
)
1798 /* check whether channels and rates match for all formats */
1799 cmaster
= rmaster
= 0;
1800 for (i
= 0; i
< MAX_MASK
; i
++) {
1801 if (cmaster
!= channels
[i
] && cmaster
&& channels
[i
])
1803 if (rmaster
!= rates
[i
] && rmaster
&& rates
[i
])
1806 cmaster
= channels
[i
];
1810 /* check whether channels match for all distinct rates */
1811 memset(channels
, 0, MAX_MASK
* sizeof(u32
));
1812 list_for_each(p
, &subs
->fmt_list
) {
1813 struct audioformat
*f
;
1814 f
= list_entry(p
, struct audioformat
, list
);
1815 if (f
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
1817 for (i
= 0; i
< 32; i
++) {
1818 if (f
->rates
& (1 << i
))
1819 channels
[i
] |= (1 << f
->channels
);
1823 for (i
= 0; i
< 32; i
++) {
1824 if (cmaster
!= channels
[i
] && cmaster
&& channels
[i
])
1827 cmaster
= channels
[i
];
1838 * If the device supports unusual bit rates, does the request meet these?
1840 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime
*runtime
,
1841 struct snd_usb_substream
*subs
)
1843 struct audioformat
*fp
;
1844 int count
= 0, needs_knot
= 0;
1847 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1848 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
1850 count
+= fp
->nr_rates
;
1851 if (fp
->rates
& SNDRV_PCM_RATE_KNOT
)
1857 subs
->rate_list
.count
= count
;
1858 subs
->rate_list
.list
= kmalloc(sizeof(int) * count
, GFP_KERNEL
);
1859 subs
->rate_list
.mask
= 0;
1861 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1863 for (i
= 0; i
< fp
->nr_rates
; i
++)
1864 subs
->rate_list
.list
[count
++] = fp
->rate_table
[i
];
1866 err
= snd_pcm_hw_constraint_list(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1876 * set up the runtime hardware information.
1879 static int setup_hw_info(struct snd_pcm_runtime
*runtime
, struct snd_usb_substream
*subs
)
1881 struct list_head
*p
;
1884 runtime
->hw
.formats
= subs
->formats
;
1886 runtime
->hw
.rate_min
= 0x7fffffff;
1887 runtime
->hw
.rate_max
= 0;
1888 runtime
->hw
.channels_min
= 256;
1889 runtime
->hw
.channels_max
= 0;
1890 runtime
->hw
.rates
= 0;
1891 /* check min/max rates and channels */
1892 list_for_each(p
, &subs
->fmt_list
) {
1893 struct audioformat
*fp
;
1894 fp
= list_entry(p
, struct audioformat
, list
);
1895 runtime
->hw
.rates
|= fp
->rates
;
1896 if (runtime
->hw
.rate_min
> fp
->rate_min
)
1897 runtime
->hw
.rate_min
= fp
->rate_min
;
1898 if (runtime
->hw
.rate_max
< fp
->rate_max
)
1899 runtime
->hw
.rate_max
= fp
->rate_max
;
1900 if (runtime
->hw
.channels_min
> fp
->channels
)
1901 runtime
->hw
.channels_min
= fp
->channels
;
1902 if (runtime
->hw
.channels_max
< fp
->channels
)
1903 runtime
->hw
.channels_max
= fp
->channels
;
1904 if (fp
->fmt_type
== USB_FORMAT_TYPE_II
&& fp
->frame_size
> 0) {
1905 /* FIXME: there might be more than one audio formats... */
1906 runtime
->hw
.period_bytes_min
= runtime
->hw
.period_bytes_max
=
1911 /* set the period time minimum 1ms */
1912 /* FIXME: high-speed mode allows 125us minimum period, but many parts
1913 * in the current code assume the 1ms period.
1915 snd_pcm_hw_constraint_minmax(runtime
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
1916 1000 * MIN_PACKS_URB
,
1917 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX
);
1919 if (check_hw_params_convention(subs
)) {
1920 hwc_debug("setting extra hw constraints...\n");
1921 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1923 SNDRV_PCM_HW_PARAM_FORMAT
,
1924 SNDRV_PCM_HW_PARAM_CHANNELS
,
1927 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_CHANNELS
,
1928 hw_rule_channels
, subs
,
1929 SNDRV_PCM_HW_PARAM_FORMAT
,
1930 SNDRV_PCM_HW_PARAM_RATE
,
1933 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_FORMAT
,
1934 hw_rule_format
, subs
,
1935 SNDRV_PCM_HW_PARAM_RATE
,
1936 SNDRV_PCM_HW_PARAM_CHANNELS
,
1939 if ((err
= snd_usb_pcm_check_knot(runtime
, subs
)) < 0)
1945 static int snd_usb_pcm_open(struct snd_pcm_substream
*substream
, int direction
)
1947 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1948 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1949 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1951 subs
->interface
= -1;
1953 runtime
->hw
= snd_usb_hardware
;
1954 runtime
->private_data
= subs
;
1955 subs
->pcm_substream
= substream
;
1956 return setup_hw_info(runtime
, subs
);
1959 static int snd_usb_pcm_close(struct snd_pcm_substream
*substream
, int direction
)
1961 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1962 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1964 if (subs
->interface
>= 0) {
1965 usb_set_interface(subs
->dev
, subs
->interface
, 0);
1966 subs
->interface
= -1;
1968 subs
->pcm_substream
= NULL
;
1972 static int snd_usb_playback_open(struct snd_pcm_substream
*substream
)
1974 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1977 static int snd_usb_playback_close(struct snd_pcm_substream
*substream
)
1979 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1982 static int snd_usb_capture_open(struct snd_pcm_substream
*substream
)
1984 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1987 static int snd_usb_capture_close(struct snd_pcm_substream
*substream
)
1989 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1992 static struct snd_pcm_ops snd_usb_playback_ops
= {
1993 .open
= snd_usb_playback_open
,
1994 .close
= snd_usb_playback_close
,
1995 .ioctl
= snd_pcm_lib_ioctl
,
1996 .hw_params
= snd_usb_hw_params
,
1997 .hw_free
= snd_usb_hw_free
,
1998 .prepare
= snd_usb_pcm_prepare
,
1999 .trigger
= snd_usb_pcm_playback_trigger
,
2000 .pointer
= snd_usb_pcm_pointer
,
2001 .page
= snd_pcm_get_vmalloc_page
,
2004 static struct snd_pcm_ops snd_usb_capture_ops
= {
2005 .open
= snd_usb_capture_open
,
2006 .close
= snd_usb_capture_close
,
2007 .ioctl
= snd_pcm_lib_ioctl
,
2008 .hw_params
= snd_usb_hw_params
,
2009 .hw_free
= snd_usb_hw_free
,
2010 .prepare
= snd_usb_pcm_prepare
,
2011 .trigger
= snd_usb_pcm_capture_trigger
,
2012 .pointer
= snd_usb_pcm_pointer
,
2013 .page
= snd_pcm_get_vmalloc_page
,
2023 * combine bytes and get an integer value
2025 unsigned int snd_usb_combine_bytes(unsigned char *bytes
, int size
)
2028 case 1: return *bytes
;
2029 case 2: return combine_word(bytes
);
2030 case 3: return combine_triple(bytes
);
2031 case 4: return combine_quad(bytes
);
2037 * parse descriptor buffer and return the pointer starting the given
2040 void *snd_usb_find_desc(void *descstart
, int desclen
, void *after
, u8 dtype
)
2052 if (p
[1] == dtype
&& (!after
|| (void *)p
> after
)) {
2061 * find a class-specified interface descriptor with the given subtype.
2063 void *snd_usb_find_csint_desc(void *buffer
, int buflen
, void *after
, u8 dsubtype
)
2065 unsigned char *p
= after
;
2067 while ((p
= snd_usb_find_desc(buffer
, buflen
, p
,
2068 USB_DT_CS_INTERFACE
)) != NULL
) {
2069 if (p
[0] >= 3 && p
[2] == dsubtype
)
2076 * Wrapper for usb_control_msg().
2077 * Allocates a temp buffer to prevent dmaing from/to the stack.
2079 int snd_usb_ctl_msg(struct usb_device
*dev
, unsigned int pipe
, __u8 request
,
2080 __u8 requesttype
, __u16 value
, __u16 index
, void *data
,
2081 __u16 size
, int timeout
)
2087 buf
= kmemdup(data
, size
, GFP_KERNEL
);
2091 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
2092 value
, index
, buf
, size
, timeout
);
2094 memcpy(data
, buf
, size
);
2102 * entry point for linux usb interface
2105 static int usb_audio_probe(struct usb_interface
*intf
,
2106 const struct usb_device_id
*id
);
2107 static void usb_audio_disconnect(struct usb_interface
*intf
);
2110 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
);
2111 static int usb_audio_resume(struct usb_interface
*intf
);
2113 #define usb_audio_suspend NULL
2114 #define usb_audio_resume NULL
2117 static struct usb_device_id usb_audio_ids
[] = {
2118 #include "usbquirks.h"
2119 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
2120 .bInterfaceClass
= USB_CLASS_AUDIO
,
2121 .bInterfaceSubClass
= USB_SUBCLASS_AUDIO_CONTROL
},
2122 { } /* Terminating entry */
2125 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
2127 static struct usb_driver usb_audio_driver
= {
2128 .name
= "snd-usb-audio",
2129 .probe
= usb_audio_probe
,
2130 .disconnect
= usb_audio_disconnect
,
2131 .suspend
= usb_audio_suspend
,
2132 .resume
= usb_audio_resume
,
2133 .id_table
= usb_audio_ids
,
2137 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2140 * proc interface for list the supported pcm formats
2142 static void proc_dump_substream_formats(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2144 struct list_head
*p
;
2145 static char *sync_types
[4] = {
2146 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2149 list_for_each(p
, &subs
->fmt_list
) {
2150 struct audioformat
*fp
;
2151 fp
= list_entry(p
, struct audioformat
, list
);
2152 snd_iprintf(buffer
, " Interface %d\n", fp
->iface
);
2153 snd_iprintf(buffer
, " Altset %d\n", fp
->altsetting
);
2154 snd_iprintf(buffer
, " Format: 0x%x\n", fp
->format
);
2155 snd_iprintf(buffer
, " Channels: %d\n", fp
->channels
);
2156 snd_iprintf(buffer
, " Endpoint: %d %s (%s)\n",
2157 fp
->endpoint
& USB_ENDPOINT_NUMBER_MASK
,
2158 fp
->endpoint
& USB_DIR_IN
? "IN" : "OUT",
2159 sync_types
[(fp
->ep_attr
& EP_ATTR_MASK
) >> 2]);
2160 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
2161 snd_iprintf(buffer
, " Rates: %d - %d (continuous)\n",
2162 fp
->rate_min
, fp
->rate_max
);
2165 snd_iprintf(buffer
, " Rates: ");
2166 for (i
= 0; i
< fp
->nr_rates
; i
++) {
2168 snd_iprintf(buffer
, ", ");
2169 snd_iprintf(buffer
, "%d", fp
->rate_table
[i
]);
2171 snd_iprintf(buffer
, "\n");
2173 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2174 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2178 static void proc_dump_substream_status(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2180 if (subs
->running
) {
2182 snd_iprintf(buffer
, " Status: Running\n");
2183 snd_iprintf(buffer
, " Interface = %d\n", subs
->interface
);
2184 snd_iprintf(buffer
, " Altset = %d\n", subs
->format
);
2185 snd_iprintf(buffer
, " URBs = %d [ ", subs
->nurbs
);
2186 for (i
= 0; i
< subs
->nurbs
; i
++)
2187 snd_iprintf(buffer
, "%d ", subs
->dataurb
[i
].packets
);
2188 snd_iprintf(buffer
, "]\n");
2189 snd_iprintf(buffer
, " Packet Size = %d\n", subs
->curpacksize
);
2190 snd_iprintf(buffer
, " Momentary freq = %u Hz (%#x.%04x)\n",
2191 snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
2192 ? get_full_speed_hz(subs
->freqm
)
2193 : get_high_speed_hz(subs
->freqm
),
2194 subs
->freqm
>> 16, subs
->freqm
& 0xffff);
2196 snd_iprintf(buffer
, " Status: Stop\n");
2200 static void proc_pcm_format_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
2202 struct snd_usb_stream
*stream
= entry
->private_data
;
2204 snd_iprintf(buffer
, "%s : %s\n", stream
->chip
->card
->longname
, stream
->pcm
->name
);
2206 if (stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
].num_formats
) {
2207 snd_iprintf(buffer
, "\nPlayback:\n");
2208 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2209 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2211 if (stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].num_formats
) {
2212 snd_iprintf(buffer
, "\nCapture:\n");
2213 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2214 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2218 static void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2220 struct snd_info_entry
*entry
;
2222 struct snd_card
*card
= stream
->chip
->card
;
2224 sprintf(name
, "stream%d", stream
->pcm_index
);
2225 if (! snd_card_proc_new(card
, name
, &entry
))
2226 snd_info_set_text_ops(entry
, stream
, proc_pcm_format_read
);
2231 static inline void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2238 * initialize the substream instance.
2241 static void init_substream(struct snd_usb_stream
*as
, int stream
, struct audioformat
*fp
)
2243 struct snd_usb_substream
*subs
= &as
->substream
[stream
];
2245 INIT_LIST_HEAD(&subs
->fmt_list
);
2246 spin_lock_init(&subs
->lock
);
2249 subs
->direction
= stream
;
2250 subs
->dev
= as
->chip
->dev
;
2251 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
) {
2252 subs
->ops
= audio_urb_ops
[stream
];
2254 subs
->ops
= audio_urb_ops_high_speed
[stream
];
2255 switch (as
->chip
->usb_id
) {
2256 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
2257 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
2258 subs
->ops
.retire_sync
= retire_playback_sync_urb_hs_emu
;
2262 snd_pcm_set_ops(as
->pcm
, stream
,
2263 stream
== SNDRV_PCM_STREAM_PLAYBACK
?
2264 &snd_usb_playback_ops
: &snd_usb_capture_ops
);
2266 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2267 subs
->formats
|= 1ULL << fp
->format
;
2268 subs
->endpoint
= fp
->endpoint
;
2269 subs
->num_formats
++;
2270 subs
->fmt_type
= fp
->fmt_type
;
2277 static void free_substream(struct snd_usb_substream
*subs
)
2279 struct list_head
*p
, *n
;
2281 if (! subs
->num_formats
)
2282 return; /* not initialized */
2283 list_for_each_safe(p
, n
, &subs
->fmt_list
) {
2284 struct audioformat
*fp
= list_entry(p
, struct audioformat
, list
);
2285 kfree(fp
->rate_table
);
2288 kfree(subs
->rate_list
.list
);
2293 * free a usb stream instance
2295 static void snd_usb_audio_stream_free(struct snd_usb_stream
*stream
)
2297 free_substream(&stream
->substream
[0]);
2298 free_substream(&stream
->substream
[1]);
2299 list_del(&stream
->list
);
2303 static void snd_usb_audio_pcm_free(struct snd_pcm
*pcm
)
2305 struct snd_usb_stream
*stream
= pcm
->private_data
;
2308 snd_usb_audio_stream_free(stream
);
2314 * add this endpoint to the chip instance.
2315 * if a stream with the same endpoint already exists, append to it.
2316 * if not, create a new pcm stream.
2318 static int add_audio_endpoint(struct snd_usb_audio
*chip
, int stream
, struct audioformat
*fp
)
2320 struct list_head
*p
;
2321 struct snd_usb_stream
*as
;
2322 struct snd_usb_substream
*subs
;
2323 struct snd_pcm
*pcm
;
2326 list_for_each(p
, &chip
->pcm_list
) {
2327 as
= list_entry(p
, struct snd_usb_stream
, list
);
2328 if (as
->fmt_type
!= fp
->fmt_type
)
2330 subs
= &as
->substream
[stream
];
2331 if (! subs
->endpoint
)
2333 if (subs
->endpoint
== fp
->endpoint
) {
2334 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2335 subs
->num_formats
++;
2336 subs
->formats
|= 1ULL << fp
->format
;
2340 /* look for an empty stream */
2341 list_for_each(p
, &chip
->pcm_list
) {
2342 as
= list_entry(p
, struct snd_usb_stream
, list
);
2343 if (as
->fmt_type
!= fp
->fmt_type
)
2345 subs
= &as
->substream
[stream
];
2348 err
= snd_pcm_new_stream(as
->pcm
, stream
, 1);
2351 init_substream(as
, stream
, fp
);
2355 /* create a new pcm */
2356 as
= kzalloc(sizeof(*as
), GFP_KERNEL
);
2359 as
->pcm_index
= chip
->pcm_devs
;
2361 as
->fmt_type
= fp
->fmt_type
;
2362 err
= snd_pcm_new(chip
->card
, "USB Audio", chip
->pcm_devs
,
2363 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 1 : 0,
2364 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 0 : 1,
2371 pcm
->private_data
= as
;
2372 pcm
->private_free
= snd_usb_audio_pcm_free
;
2373 pcm
->info_flags
= 0;
2374 if (chip
->pcm_devs
> 0)
2375 sprintf(pcm
->name
, "USB Audio #%d", chip
->pcm_devs
);
2377 strcpy(pcm
->name
, "USB Audio");
2379 init_substream(as
, stream
, fp
);
2381 list_add(&as
->list
, &chip
->pcm_list
);
2384 proc_pcm_format_add(as
);
2391 * check if the device uses big-endian samples
2393 static int is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
2395 switch (chip
->usb_id
) {
2396 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2397 if (fp
->endpoint
& USB_DIR_IN
)
2400 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2401 if (device_setup
[chip
->index
] == 0x00 ||
2402 fp
->altsetting
==1 || fp
->altsetting
==2 || fp
->altsetting
==3)
2409 * parse the audio format type I descriptor
2410 * and returns the corresponding pcm format
2413 * @fp: audioformat record
2414 * @format: the format tag (wFormatTag)
2415 * @fmt: the format type descriptor
2417 static int parse_audio_format_i_type(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2418 int format
, unsigned char *fmt
)
2421 int sample_width
, sample_bytes
;
2423 /* FIXME: correct endianess and sign? */
2425 sample_width
= fmt
[6];
2426 sample_bytes
= fmt
[5];
2428 case 0: /* some devices don't define this correctly... */
2429 snd_printdd(KERN_INFO
"%d:%u:%d : format type 0 is detected, processed as PCM\n",
2430 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2432 case USB_AUDIO_FORMAT_PCM
:
2433 if (sample_width
> sample_bytes
* 8) {
2434 snd_printk(KERN_INFO
"%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2435 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
,
2436 sample_width
, sample_bytes
);
2438 /* check the format byte size */
2441 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2444 if (is_big_endian_format(chip
, fp
))
2445 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
; /* grrr, big endian!! */
2447 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2450 if (is_big_endian_format(chip
, fp
))
2451 pcm_format
= SNDRV_PCM_FORMAT_S24_3BE
; /* grrr, big endian!! */
2453 pcm_format
= SNDRV_PCM_FORMAT_S24_3LE
;
2456 pcm_format
= SNDRV_PCM_FORMAT_S32_LE
;
2459 snd_printk(KERN_INFO
"%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2460 chip
->dev
->devnum
, fp
->iface
,
2461 fp
->altsetting
, sample_width
, sample_bytes
);
2465 case USB_AUDIO_FORMAT_PCM8
:
2466 /* Dallas DS4201 workaround */
2467 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2468 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2470 pcm_format
= SNDRV_PCM_FORMAT_U8
;
2472 case USB_AUDIO_FORMAT_IEEE_FLOAT
:
2473 pcm_format
= SNDRV_PCM_FORMAT_FLOAT_LE
;
2475 case USB_AUDIO_FORMAT_ALAW
:
2476 pcm_format
= SNDRV_PCM_FORMAT_A_LAW
;
2478 case USB_AUDIO_FORMAT_MU_LAW
:
2479 pcm_format
= SNDRV_PCM_FORMAT_MU_LAW
;
2482 snd_printk(KERN_INFO
"%d:%u:%d : unsupported format type %d\n",
2483 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2491 * parse the format descriptor and stores the possible sample rates
2492 * on the audioformat table.
2495 * @fp: audioformat record
2496 * @fmt: the format descriptor
2497 * @offset: the start offset of descriptor pointing the rate type
2498 * (7 for type I and II, 8 for type II)
2500 static int parse_audio_format_rates(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2501 unsigned char *fmt
, int offset
)
2503 int nr_rates
= fmt
[offset
];
2505 if (fmt
[0] < offset
+ 1 + 3 * (nr_rates
? nr_rates
: 2)) {
2506 snd_printk(KERN_ERR
"%d:%u:%d : invalid FORMAT_TYPE desc\n",
2507 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2513 * build the rate table and bitmap flags
2516 unsigned int nonzero_rates
= 0;
2518 fp
->rate_table
= kmalloc(sizeof(int) * nr_rates
, GFP_KERNEL
);
2519 if (fp
->rate_table
== NULL
) {
2520 snd_printk(KERN_ERR
"cannot malloc\n");
2524 fp
->nr_rates
= nr_rates
;
2525 fp
->rate_min
= fp
->rate_max
= combine_triple(&fmt
[8]);
2526 for (r
= 0, idx
= offset
+ 1; r
< nr_rates
; r
++, idx
+= 3) {
2527 unsigned int rate
= combine_triple(&fmt
[idx
]);
2528 /* C-Media CM6501 mislabels its 96 kHz altsetting */
2529 if (rate
== 48000 && nr_rates
== 1 &&
2530 chip
->usb_id
== USB_ID(0x0d8c, 0x0201) &&
2531 fp
->altsetting
== 5 && fp
->maxpacksize
== 392)
2533 fp
->rate_table
[r
] = rate
;
2534 nonzero_rates
|= rate
;
2535 if (rate
< fp
->rate_min
)
2536 fp
->rate_min
= rate
;
2537 else if (rate
> fp
->rate_max
)
2538 fp
->rate_max
= rate
;
2539 fp
->rates
|= snd_pcm_rate_to_rate_bit(rate
);
2541 if (!nonzero_rates
) {
2542 hwc_debug("All rates were zero. Skipping format!\n");
2546 /* continuous rates */
2547 fp
->rates
= SNDRV_PCM_RATE_CONTINUOUS
;
2548 fp
->rate_min
= combine_triple(&fmt
[offset
+ 1]);
2549 fp
->rate_max
= combine_triple(&fmt
[offset
+ 4]);
2555 * parse the format type I and III descriptors
2557 static int parse_audio_format_i(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2558 int format
, unsigned char *fmt
)
2562 if (fmt
[3] == USB_FORMAT_TYPE_III
) {
2563 /* FIXME: the format type is really IECxxx
2564 * but we give normal PCM format to get the existing
2567 switch (chip
->usb_id
) {
2569 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2570 if (device_setup
[chip
->index
] == 0x00 &&
2571 fp
->altsetting
== 6)
2572 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
;
2574 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2577 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2580 pcm_format
= parse_audio_format_i_type(chip
, fp
, format
, fmt
);
2584 fp
->format
= pcm_format
;
2585 fp
->channels
= fmt
[4];
2586 if (fp
->channels
< 1) {
2587 snd_printk(KERN_ERR
"%d:%u:%d : invalid channels %d\n",
2588 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fp
->channels
);
2591 return parse_audio_format_rates(chip
, fp
, fmt
, 7);
2595 * prase the format type II descriptor
2597 static int parse_audio_format_ii(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2598 int format
, unsigned char *fmt
)
2600 int brate
, framesize
;
2602 case USB_AUDIO_FORMAT_AC3
:
2603 /* FIXME: there is no AC3 format defined yet */
2604 // fp->format = SNDRV_PCM_FORMAT_AC3;
2605 fp
->format
= SNDRV_PCM_FORMAT_U8
; /* temporarily hack to receive byte streams */
2607 case USB_AUDIO_FORMAT_MPEG
:
2608 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2611 snd_printd(KERN_INFO
"%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2612 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2613 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2617 brate
= combine_word(&fmt
[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2618 framesize
= combine_word(&fmt
[6]); /* fmt[6,7]: wSamplesPerFrame */
2619 snd_printd(KERN_INFO
"found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
2620 fp
->frame_size
= framesize
;
2621 return parse_audio_format_rates(chip
, fp
, fmt
, 8); /* fmt[8..] sample rates */
2624 static int parse_audio_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2625 int format
, unsigned char *fmt
, int stream
)
2630 case USB_FORMAT_TYPE_I
:
2631 case USB_FORMAT_TYPE_III
:
2632 err
= parse_audio_format_i(chip
, fp
, format
, fmt
);
2634 case USB_FORMAT_TYPE_II
:
2635 err
= parse_audio_format_ii(chip
, fp
, format
, fmt
);
2638 snd_printd(KERN_INFO
"%d:%u:%d : format type %d is not supported yet\n",
2639 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fmt
[3]);
2642 fp
->fmt_type
= fmt
[3];
2646 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2647 /* extigy apparently supports sample rates other than 48k
2648 * but not in ordinary way. so we enable only 48k atm.
2650 if (chip
->usb_id
== USB_ID(0x041e, 0x3000) ||
2651 chip
->usb_id
== USB_ID(0x041e, 0x3020) ||
2652 chip
->usb_id
== USB_ID(0x041e, 0x3061)) {
2653 if (fmt
[3] == USB_FORMAT_TYPE_I
&&
2654 fp
->rates
!= SNDRV_PCM_RATE_48000
&&
2655 fp
->rates
!= SNDRV_PCM_RATE_96000
)
2662 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
2663 int iface
, int altno
);
2664 static int parse_audio_endpoints(struct snd_usb_audio
*chip
, int iface_no
)
2666 struct usb_device
*dev
;
2667 struct usb_interface
*iface
;
2668 struct usb_host_interface
*alts
;
2669 struct usb_interface_descriptor
*altsd
;
2670 int i
, altno
, err
, stream
;
2672 struct audioformat
*fp
;
2673 unsigned char *fmt
, *csep
;
2677 /* parse the interface's altsettings */
2678 iface
= usb_ifnum_to_if(dev
, iface_no
);
2679 for (i
= 0; i
< iface
->num_altsetting
; i
++) {
2680 alts
= &iface
->altsetting
[i
];
2681 altsd
= get_iface_desc(alts
);
2682 /* skip invalid one */
2683 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2684 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2685 (altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIO_STREAMING
&&
2686 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_VENDOR_SPEC
) ||
2687 altsd
->bNumEndpoints
< 1 ||
2688 le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
) == 0)
2690 /* must be isochronous */
2691 if ((get_endpoint(alts
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) !=
2692 USB_ENDPOINT_XFER_ISOC
)
2694 /* check direction */
2695 stream
= (get_endpoint(alts
, 0)->bEndpointAddress
& USB_DIR_IN
) ?
2696 SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2697 altno
= altsd
->bAlternateSetting
;
2699 /* audiophile usb: skip altsets incompatible with device_setup
2701 if (chip
->usb_id
== USB_ID(0x0763, 0x2003) &&
2702 audiophile_skip_setting_quirk(chip
, iface_no
, altno
))
2705 /* get audio formats */
2706 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, AS_GENERAL
);
2708 snd_printk(KERN_ERR
"%d:%u:%d : AS_GENERAL descriptor not found\n",
2709 dev
->devnum
, iface_no
, altno
);
2714 snd_printk(KERN_ERR
"%d:%u:%d : invalid AS_GENERAL desc\n",
2715 dev
->devnum
, iface_no
, altno
);
2719 format
= (fmt
[6] << 8) | fmt
[5]; /* remember the format value */
2721 /* get format type */
2722 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, FORMAT_TYPE
);
2724 snd_printk(KERN_ERR
"%d:%u:%d : no FORMAT_TYPE desc\n",
2725 dev
->devnum
, iface_no
, altno
);
2729 snd_printk(KERN_ERR
"%d:%u:%d : invalid FORMAT_TYPE desc\n",
2730 dev
->devnum
, iface_no
, altno
);
2734 csep
= snd_usb_find_desc(alts
->endpoint
[0].extra
, alts
->endpoint
[0].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2735 /* Creamware Noah has this descriptor after the 2nd endpoint */
2736 if (!csep
&& altsd
->bNumEndpoints
>= 2)
2737 csep
= snd_usb_find_desc(alts
->endpoint
[1].extra
, alts
->endpoint
[1].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2738 if (!csep
|| csep
[0] < 7 || csep
[2] != EP_GENERAL
) {
2739 snd_printk(KERN_WARNING
"%d:%u:%d : no or invalid"
2740 " class specific endpoint descriptor\n",
2741 dev
->devnum
, iface_no
, altno
);
2745 fp
= kzalloc(sizeof(*fp
), GFP_KERNEL
);
2747 snd_printk(KERN_ERR
"cannot malloc\n");
2751 fp
->iface
= iface_no
;
2752 fp
->altsetting
= altno
;
2754 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
2755 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
2756 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2757 if (snd_usb_get_speed(dev
) == USB_SPEED_HIGH
)
2758 fp
->maxpacksize
= (((fp
->maxpacksize
>> 11) & 3) + 1)
2759 * (fp
->maxpacksize
& 0x7ff);
2760 fp
->attributes
= csep
? csep
[3] : 0;
2762 /* some quirks for attributes here */
2764 switch (chip
->usb_id
) {
2765 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2766 /* Optoplay sets the sample rate attribute although
2767 * it seems not supporting it in fact.
2769 fp
->attributes
&= ~EP_CS_ATTR_SAMPLE_RATE
;
2771 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2772 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2773 /* doesn't set the sample rate attribute, but supports it */
2774 fp
->attributes
|= EP_CS_ATTR_SAMPLE_RATE
;
2776 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2777 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2778 an older model 77d:223) */
2780 * plantronics headset and Griffin iMic have set adaptive-in
2781 * although it's really not...
2783 fp
->ep_attr
&= ~EP_ATTR_MASK
;
2784 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
2785 fp
->ep_attr
|= EP_ATTR_ADAPTIVE
;
2787 fp
->ep_attr
|= EP_ATTR_SYNC
;
2791 /* ok, let's parse further... */
2792 if (parse_audio_format(chip
, fp
, format
, fmt
, stream
) < 0) {
2793 kfree(fp
->rate_table
);
2798 snd_printdd(KERN_INFO
"%d:%u:%d: add audio endpoint 0x%x\n", dev
->devnum
, iface_no
, altno
, fp
->endpoint
);
2799 err
= add_audio_endpoint(chip
, stream
, fp
);
2801 kfree(fp
->rate_table
);
2805 /* try to set the interface... */
2806 usb_set_interface(chip
->dev
, iface_no
, altno
);
2807 init_usb_pitch(chip
->dev
, iface_no
, alts
, fp
);
2808 init_usb_sample_rate(chip
->dev
, iface_no
, alts
, fp
, fp
->rate_max
);
2815 * disconnect streams
2816 * called from snd_usb_audio_disconnect()
2818 static void snd_usb_stream_disconnect(struct list_head
*head
)
2821 struct snd_usb_stream
*as
;
2822 struct snd_usb_substream
*subs
;
2824 as
= list_entry(head
, struct snd_usb_stream
, list
);
2825 for (idx
= 0; idx
< 2; idx
++) {
2826 subs
= &as
->substream
[idx
];
2827 if (!subs
->num_formats
)
2829 release_substream_urbs(subs
, 1);
2830 subs
->interface
= -1;
2835 * parse audio control descriptor and create pcm/midi streams
2837 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
2839 struct usb_device
*dev
= chip
->dev
;
2840 struct usb_host_interface
*host_iface
;
2841 struct usb_interface
*iface
;
2845 /* find audiocontrol interface */
2846 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
2847 if (!(p1
= snd_usb_find_csint_desc(host_iface
->extra
, host_iface
->extralen
, NULL
, HEADER
))) {
2848 snd_printk(KERN_ERR
"cannot find HEADER\n");
2851 if (! p1
[7] || p1
[0] < 8 + p1
[7]) {
2852 snd_printk(KERN_ERR
"invalid HEADER\n");
2857 * parse all USB audio streaming interfaces
2859 for (i
= 0; i
< p1
[7]; i
++) {
2860 struct usb_host_interface
*alts
;
2861 struct usb_interface_descriptor
*altsd
;
2863 iface
= usb_ifnum_to_if(dev
, j
);
2865 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
2866 dev
->devnum
, ctrlif
, j
);
2869 if (usb_interface_claimed(iface
)) {
2870 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n", dev
->devnum
, ctrlif
, j
);
2873 alts
= &iface
->altsetting
[0];
2874 altsd
= get_iface_desc(alts
);
2875 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
2876 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
2877 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDI_STREAMING
) {
2878 if (snd_usb_create_midi_interface(chip
, iface
, NULL
) < 0) {
2879 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n", dev
->devnum
, ctrlif
, j
);
2882 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
2885 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2886 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2887 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIO_STREAMING
) {
2888 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n", dev
->devnum
, ctrlif
, j
, altsd
->bInterfaceClass
);
2889 /* skip non-supported classes */
2892 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
2893 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
2896 if (! parse_audio_endpoints(chip
, j
)) {
2897 usb_set_interface(dev
, j
, 0); /* reset the current interface */
2898 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
2906 * create a stream for an endpoint/altsetting without proper descriptors
2908 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
2909 struct usb_interface
*iface
,
2910 const struct snd_usb_audio_quirk
*quirk
)
2912 struct audioformat
*fp
;
2913 struct usb_host_interface
*alts
;
2915 unsigned *rate_table
= NULL
;
2917 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
2919 snd_printk(KERN_ERR
"cannot memdup\n");
2922 if (fp
->nr_rates
> 0) {
2923 rate_table
= kmalloc(sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
2928 memcpy(rate_table
, fp
->rate_table
, sizeof(int) * fp
->nr_rates
);
2929 fp
->rate_table
= rate_table
;
2932 stream
= (fp
->endpoint
& USB_DIR_IN
)
2933 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2934 err
= add_audio_endpoint(chip
, stream
, fp
);
2940 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
2941 fp
->altset_idx
>= iface
->num_altsetting
) {
2946 alts
= &iface
->altsetting
[fp
->altset_idx
];
2947 usb_set_interface(chip
->dev
, fp
->iface
, 0);
2948 init_usb_pitch(chip
->dev
, fp
->iface
, alts
, fp
);
2949 init_usb_sample_rate(chip
->dev
, fp
->iface
, alts
, fp
, fp
->rate_max
);
2954 * create a stream for an interface with proper descriptors
2956 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
2957 struct usb_interface
*iface
,
2958 const struct snd_usb_audio_quirk
*quirk
)
2960 struct usb_host_interface
*alts
;
2961 struct usb_interface_descriptor
*altsd
;
2964 alts
= &iface
->altsetting
[0];
2965 altsd
= get_iface_desc(alts
);
2966 err
= parse_audio_endpoints(chip
, altsd
->bInterfaceNumber
);
2968 snd_printk(KERN_ERR
"cannot setup if %d: error %d\n",
2969 altsd
->bInterfaceNumber
, err
);
2972 /* reset the current interface */
2973 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
2978 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2979 * to detect the sample rate is by looking at wMaxPacketSize.
2981 static int create_ua700_ua25_quirk(struct snd_usb_audio
*chip
,
2982 struct usb_interface
*iface
,
2983 const struct snd_usb_audio_quirk
*quirk
)
2985 static const struct audioformat ua_format
= {
2986 .format
= SNDRV_PCM_FORMAT_S24_3LE
,
2988 .fmt_type
= USB_FORMAT_TYPE_I
,
2991 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
2993 struct usb_host_interface
*alts
;
2994 struct usb_interface_descriptor
*altsd
;
2995 struct audioformat
*fp
;
2998 /* both PCM and MIDI interfaces have 2 altsettings */
2999 if (iface
->num_altsetting
!= 2)
3001 alts
= &iface
->altsetting
[1];
3002 altsd
= get_iface_desc(alts
);
3004 if (altsd
->bNumEndpoints
== 2) {
3005 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
3006 .out_cables
= 0x0003,
3009 static const struct snd_usb_audio_quirk ua700_quirk
= {
3010 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3013 static const struct snd_usb_midi_endpoint_info ua25_ep
= {
3014 .out_cables
= 0x0001,
3017 static const struct snd_usb_audio_quirk ua25_quirk
= {
3018 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3021 if (chip
->usb_id
== USB_ID(0x0582, 0x002b))
3022 return snd_usb_create_midi_interface(chip
, iface
,
3025 return snd_usb_create_midi_interface(chip
, iface
,
3029 if (altsd
->bNumEndpoints
!= 1)
3032 fp
= kmalloc(sizeof(*fp
), GFP_KERNEL
);
3035 memcpy(fp
, &ua_format
, sizeof(*fp
));
3037 fp
->iface
= altsd
->bInterfaceNumber
;
3038 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3039 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3040 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3042 switch (fp
->maxpacksize
) {
3044 fp
->rate_max
= fp
->rate_min
= 44100;
3048 fp
->rate_max
= fp
->rate_min
= 48000;
3052 fp
->rate_max
= fp
->rate_min
= 96000;
3055 snd_printk(KERN_ERR
"unknown sample rate\n");
3060 stream
= (fp
->endpoint
& USB_DIR_IN
)
3061 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3062 err
= add_audio_endpoint(chip
, stream
, fp
);
3067 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3072 * Create a stream for an Edirol UA-1000 interface.
3074 static int create_ua1000_quirk(struct snd_usb_audio
*chip
,
3075 struct usb_interface
*iface
,
3076 const struct snd_usb_audio_quirk
*quirk
)
3078 static const struct audioformat ua1000_format
= {
3079 .format
= SNDRV_PCM_FORMAT_S32_LE
,
3080 .fmt_type
= USB_FORMAT_TYPE_I
,
3084 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3086 struct usb_host_interface
*alts
;
3087 struct usb_interface_descriptor
*altsd
;
3088 struct audioformat
*fp
;
3091 if (iface
->num_altsetting
!= 2)
3093 alts
= &iface
->altsetting
[1];
3094 altsd
= get_iface_desc(alts
);
3095 if (alts
->extralen
!= 11 || alts
->extra
[1] != USB_DT_CS_INTERFACE
||
3096 altsd
->bNumEndpoints
!= 1)
3099 fp
= kmemdup(&ua1000_format
, sizeof(*fp
), GFP_KERNEL
);
3103 fp
->channels
= alts
->extra
[4];
3104 fp
->iface
= altsd
->bInterfaceNumber
;
3105 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3106 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3107 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3108 fp
->rate_max
= fp
->rate_min
= combine_triple(&alts
->extra
[8]);
3110 stream
= (fp
->endpoint
& USB_DIR_IN
)
3111 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3112 err
= add_audio_endpoint(chip
, stream
, fp
);
3117 /* FIXME: playback must be synchronized to capture */
3118 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3123 * Create a stream for an Edirol UA-101 interface.
3124 * Copy, paste and modify from Edirol UA-1000
3126 static int create_ua101_quirk(struct snd_usb_audio
*chip
,
3127 struct usb_interface
*iface
,
3128 const struct snd_usb_audio_quirk
*quirk
)
3130 static const struct audioformat ua101_format
= {
3131 .format
= SNDRV_PCM_FORMAT_S32_LE
,
3132 .fmt_type
= USB_FORMAT_TYPE_I
,
3136 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3138 struct usb_host_interface
*alts
;
3139 struct usb_interface_descriptor
*altsd
;
3140 struct audioformat
*fp
;
3143 if (iface
->num_altsetting
!= 2)
3145 alts
= &iface
->altsetting
[1];
3146 altsd
= get_iface_desc(alts
);
3147 if (alts
->extralen
!= 18 || alts
->extra
[1] != USB_DT_CS_INTERFACE
||
3148 altsd
->bNumEndpoints
!= 1)
3151 fp
= kmemdup(&ua101_format
, sizeof(*fp
), GFP_KERNEL
);
3155 fp
->channels
= alts
->extra
[11];
3156 fp
->iface
= altsd
->bInterfaceNumber
;
3157 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3158 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3159 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3160 fp
->rate_max
= fp
->rate_min
= combine_triple(&alts
->extra
[15]);
3162 stream
= (fp
->endpoint
& USB_DIR_IN
)
3163 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3164 err
= add_audio_endpoint(chip
, stream
, fp
);
3169 /* FIXME: playback must be synchronized to capture */
3170 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3174 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3175 struct usb_interface
*iface
,
3176 const struct snd_usb_audio_quirk
*quirk
);
3179 * handle the quirks for the contained interfaces
3181 static int create_composite_quirk(struct snd_usb_audio
*chip
,
3182 struct usb_interface
*iface
,
3183 const struct snd_usb_audio_quirk
*quirk
)
3185 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
3188 for (quirk
= quirk
->data
; quirk
->ifnum
>= 0; ++quirk
) {
3189 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
3192 if (quirk
->ifnum
!= probed_ifnum
&&
3193 usb_interface_claimed(iface
))
3195 err
= snd_usb_create_quirk(chip
, iface
, quirk
);
3198 if (quirk
->ifnum
!= probed_ifnum
)
3199 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
3204 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
3205 struct usb_interface
*iface
,
3206 const struct snd_usb_audio_quirk
*quirk
)
3216 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3217 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3219 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
3221 struct usb_host_config
*config
= dev
->actconfig
;
3224 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
3225 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
3226 snd_printdd("sending Extigy boot sequence...\n");
3227 /* Send message to force it to reconnect with full interface. */
3228 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
3229 0x10, 0x43, 0x0001, 0x000a, NULL
, 0, 1000);
3230 if (err
< 0) snd_printdd("error sending boot message: %d\n", err
);
3231 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
3232 &dev
->descriptor
, sizeof(dev
->descriptor
));
3233 config
= dev
->actconfig
;
3234 if (err
< 0) snd_printdd("error usb_get_descriptor: %d\n", err
);
3235 err
= usb_reset_configuration(dev
);
3236 if (err
< 0) snd_printdd("error usb_reset_configuration: %d\n", err
);
3237 snd_printdd("extigy_boot: new boot length = %d\n",
3238 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
3239 return -ENODEV
; /* quit this anyway */
3244 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
3248 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
3249 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3250 0, 0, &buf
, 1, 1000);
3252 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
3253 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3254 1, 2000, NULL
, 0, 1000);
3261 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3262 * documented in the device's data sheet.
3264 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
3268 buf
[1] = value
& 0xff;
3269 buf
[2] = (value
>> 8) & 0xff;
3271 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
3272 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
3273 0, 0, &buf
, 4, 1000);
3276 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
3279 * Enable line-out driver mode, set headphone source to front
3280 * channels, enable stereo mic.
3282 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
3289 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3290 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3291 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3292 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3293 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3294 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3295 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3296 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3297 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3298 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3300 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
3301 int iface
, int altno
)
3303 /* Reset ALL ifaces to 0 altsetting.
3304 * Call it for every possible altsetting of every interface.
3306 usb_set_interface(chip
->dev
, iface
, 0);
3308 if (device_setup
[chip
->index
] & AUDIOPHILE_SET
) {
3309 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_DTS
)
3311 return 1; /* skip this altsetting */
3312 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_96K
)
3314 return 1; /* skip this altsetting */
3315 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3316 AUDIOPHILE_SET_24B_48K_DI
&& altno
!= 2)
3317 return 1; /* skip this altsetting */
3318 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3319 AUDIOPHILE_SET_24B_48K_NOTDI
&& altno
!= 3)
3320 return 1; /* skip this altsetting */
3321 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3322 AUDIOPHILE_SET_16B_48K_DI
&& altno
!= 4)
3323 return 1; /* skip this altsetting */
3324 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3325 AUDIOPHILE_SET_16B_48K_NOTDI
&& altno
!= 5)
3326 return 1; /* skip this altsetting */
3328 return 0; /* keep this altsetting */
3332 * audio-interface quirks
3334 * returns zero if no standard audio/MIDI parsing is needed.
3335 * returns a postive value if standard audio/midi interfaces are parsed
3337 * returns a negative value at error.
3339 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3340 struct usb_interface
*iface
,
3341 const struct snd_usb_audio_quirk
*quirk
)
3343 typedef int (*quirk_func_t
)(struct snd_usb_audio
*, struct usb_interface
*,
3344 const struct snd_usb_audio_quirk
*);
3345 static const quirk_func_t quirk_funcs
[] = {
3346 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
3347 [QUIRK_COMPOSITE
] = create_composite_quirk
,
3348 [QUIRK_MIDI_STANDARD_INTERFACE
] = snd_usb_create_midi_interface
,
3349 [QUIRK_MIDI_FIXED_ENDPOINT
] = snd_usb_create_midi_interface
,
3350 [QUIRK_MIDI_YAMAHA
] = snd_usb_create_midi_interface
,
3351 [QUIRK_MIDI_MIDIMAN
] = snd_usb_create_midi_interface
,
3352 [QUIRK_MIDI_NOVATION
] = snd_usb_create_midi_interface
,
3353 [QUIRK_MIDI_RAW
] = snd_usb_create_midi_interface
,
3354 [QUIRK_MIDI_EMAGIC
] = snd_usb_create_midi_interface
,
3355 [QUIRK_MIDI_CME
] = snd_usb_create_midi_interface
,
3356 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
3357 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
3358 [QUIRK_AUDIO_EDIROL_UA700_UA25
] = create_ua700_ua25_quirk
,
3359 [QUIRK_AUDIO_EDIROL_UA1000
] = create_ua1000_quirk
,
3360 [QUIRK_AUDIO_EDIROL_UA101
] = create_ua101_quirk
,
3363 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
3364 return quirk_funcs
[quirk
->type
](chip
, iface
, quirk
);
3366 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
3373 * common proc files to show the usb device info
3375 static void proc_audio_usbbus_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3377 struct snd_usb_audio
*chip
= entry
->private_data
;
3378 if (! chip
->shutdown
)
3379 snd_iprintf(buffer
, "%03d/%03d\n", chip
->dev
->bus
->busnum
, chip
->dev
->devnum
);
3382 static void proc_audio_usbid_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3384 struct snd_usb_audio
*chip
= entry
->private_data
;
3385 if (! chip
->shutdown
)
3386 snd_iprintf(buffer
, "%04x:%04x\n",
3387 USB_ID_VENDOR(chip
->usb_id
),
3388 USB_ID_PRODUCT(chip
->usb_id
));
3391 static void snd_usb_audio_create_proc(struct snd_usb_audio
*chip
)
3393 struct snd_info_entry
*entry
;
3394 if (! snd_card_proc_new(chip
->card
, "usbbus", &entry
))
3395 snd_info_set_text_ops(entry
, chip
, proc_audio_usbbus_read
);
3396 if (! snd_card_proc_new(chip
->card
, "usbid", &entry
))
3397 snd_info_set_text_ops(entry
, chip
, proc_audio_usbid_read
);
3401 * free the chip instance
3403 * here we have to do not much, since pcm and controls are already freed
3407 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
3409 usb_chip
[chip
->index
] = NULL
;
3414 static int snd_usb_audio_dev_free(struct snd_device
*device
)
3416 struct snd_usb_audio
*chip
= device
->device_data
;
3417 return snd_usb_audio_free(chip
);
3422 * create a chip instance and set its names.
3424 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
3425 const struct snd_usb_audio_quirk
*quirk
,
3426 struct snd_usb_audio
**rchip
)
3428 struct snd_card
*card
;
3429 struct snd_usb_audio
*chip
;
3432 static struct snd_device_ops ops
= {
3433 .dev_free
= snd_usb_audio_dev_free
,
3438 if (snd_usb_get_speed(dev
) != USB_SPEED_LOW
&&
3439 snd_usb_get_speed(dev
) != USB_SPEED_FULL
&&
3440 snd_usb_get_speed(dev
) != USB_SPEED_HIGH
) {
3441 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
3445 card
= snd_card_new(index
[idx
], id
[idx
], THIS_MODULE
, 0);
3447 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
3451 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
3453 snd_card_free(card
);
3460 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3461 le16_to_cpu(dev
->descriptor
.idProduct
));
3462 INIT_LIST_HEAD(&chip
->pcm_list
);
3463 INIT_LIST_HEAD(&chip
->midi_list
);
3464 INIT_LIST_HEAD(&chip
->mixer_list
);
3466 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
3467 snd_usb_audio_free(chip
);
3468 snd_card_free(card
);
3472 strcpy(card
->driver
, "USB-Audio");
3473 sprintf(component
, "USB%04x:%04x",
3474 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
3475 snd_component_add(card
, component
);
3477 /* retrieve the device string as shortname */
3478 if (quirk
&& quirk
->product_name
) {
3479 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
3481 if (!dev
->descriptor
.iProduct
||
3482 usb_string(dev
, dev
->descriptor
.iProduct
,
3483 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
3484 /* no name available from anywhere, so use ID */
3485 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
3486 USB_ID_VENDOR(chip
->usb_id
),
3487 USB_ID_PRODUCT(chip
->usb_id
));
3491 /* retrieve the vendor and device strings as longname */
3492 if (quirk
&& quirk
->vendor_name
) {
3493 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
3495 if (dev
->descriptor
.iManufacturer
)
3496 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
3497 card
->longname
, sizeof(card
->longname
));
3500 /* we don't really care if there isn't any vendor string */
3503 strlcat(card
->longname
, " ", sizeof(card
->longname
));
3505 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
3507 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
3509 if (len
< sizeof(card
->longname
))
3510 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
3512 strlcat(card
->longname
,
3513 snd_usb_get_speed(dev
) == USB_SPEED_LOW
? ", low speed" :
3514 snd_usb_get_speed(dev
) == USB_SPEED_FULL
? ", full speed" :
3516 sizeof(card
->longname
));
3518 snd_usb_audio_create_proc(chip
);
3526 * probe the active usb device
3528 * note that this can be called multiple times per a device, when it
3529 * includes multiple audio control interfaces.
3531 * thus we check the usb device pointer and creates the card instance
3532 * only at the first time. the successive calls of this function will
3533 * append the pcm interface to the corresponding card.
3535 static void *snd_usb_audio_probe(struct usb_device
*dev
,
3536 struct usb_interface
*intf
,
3537 const struct usb_device_id
*usb_id
)
3539 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
3541 struct snd_usb_audio
*chip
;
3542 struct usb_host_interface
*alts
;
3546 alts
= &intf
->altsetting
[0];
3547 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
3548 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3549 le16_to_cpu(dev
->descriptor
.idProduct
));
3551 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
3554 /* SB Extigy needs special boot-up sequence */
3555 /* if more models come, this will go to the quirk list. */
3556 if (id
== USB_ID(0x041e, 0x3000)) {
3557 if (snd_usb_extigy_boot_quirk(dev
, intf
) < 0)
3560 /* SB Audigy 2 NX needs its own boot-up magic, too */
3561 if (id
== USB_ID(0x041e, 0x3020)) {
3562 if (snd_usb_audigy2nx_boot_quirk(dev
) < 0)
3566 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3567 if (id
== USB_ID(0x10f5, 0x0200)) {
3568 if (snd_usb_cm106_boot_quirk(dev
) < 0)
3573 * found a config. now register to ALSA
3576 /* check whether it's already registered */
3578 mutex_lock(®ister_mutex
);
3579 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
3580 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
3581 if (usb_chip
[i
]->shutdown
) {
3582 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
3590 /* it's a fresh one.
3591 * now look for an empty slot and create a new card instance
3593 for (i
= 0; i
< SNDRV_CARDS
; i
++)
3594 if (enable
[i
] && ! usb_chip
[i
] &&
3595 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
3596 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
3597 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
3600 snd_card_set_dev(chip
->card
, &intf
->dev
);
3604 snd_printk(KERN_ERR
"no available usb audio device\n");
3609 err
= 1; /* continue */
3610 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
3611 /* need some special handlings */
3612 if ((err
= snd_usb_create_quirk(chip
, intf
, quirk
)) < 0)
3617 /* create normal USB audio interfaces */
3618 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
3619 snd_usb_create_mixer(chip
, ifnum
) < 0) {
3624 /* we are allowed to call snd_card_register() many times */
3625 if (snd_card_register(chip
->card
) < 0) {
3629 usb_chip
[chip
->index
] = chip
;
3630 chip
->num_interfaces
++;
3631 mutex_unlock(®ister_mutex
);
3635 if (chip
&& !chip
->num_interfaces
)
3636 snd_card_free(chip
->card
);
3637 mutex_unlock(®ister_mutex
);
3643 * we need to take care of counter, since disconnection can be called also
3644 * many times as well as usb_audio_probe().
3646 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
3648 struct snd_usb_audio
*chip
;
3649 struct snd_card
*card
;
3650 struct list_head
*p
;
3652 if (ptr
== (void *)-1L)
3657 mutex_lock(®ister_mutex
);
3659 chip
->num_interfaces
--;
3660 if (chip
->num_interfaces
<= 0) {
3661 snd_card_disconnect(card
);
3662 /* release the pcm resources */
3663 list_for_each(p
, &chip
->pcm_list
) {
3664 snd_usb_stream_disconnect(p
);
3666 /* release the midi resources */
3667 list_for_each(p
, &chip
->midi_list
) {
3668 snd_usbmidi_disconnect(p
);
3670 /* release mixer resources */
3671 list_for_each(p
, &chip
->mixer_list
) {
3672 snd_usb_mixer_disconnect(p
);
3674 mutex_unlock(®ister_mutex
);
3675 snd_card_free_when_closed(card
);
3677 mutex_unlock(®ister_mutex
);
3682 * new 2.5 USB kernel API
3684 static int usb_audio_probe(struct usb_interface
*intf
,
3685 const struct usb_device_id
*id
)
3688 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
3690 dev_set_drvdata(&intf
->dev
, chip
);
3696 static void usb_audio_disconnect(struct usb_interface
*intf
)
3698 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
3699 dev_get_drvdata(&intf
->dev
));
3703 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
3705 struct snd_usb_audio
*chip
= dev_get_drvdata(&intf
->dev
);
3706 struct list_head
*p
;
3707 struct snd_usb_stream
*as
;
3709 if (chip
== (void *)-1L)
3712 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
3713 if (!chip
->num_suspended_intf
++) {
3714 list_for_each(p
, &chip
->pcm_list
) {
3715 as
= list_entry(p
, struct snd_usb_stream
, list
);
3716 snd_pcm_suspend_all(as
->pcm
);
3723 static int usb_audio_resume(struct usb_interface
*intf
)
3725 struct snd_usb_audio
*chip
= dev_get_drvdata(&intf
->dev
);
3727 if (chip
== (void *)-1L)
3729 if (--chip
->num_suspended_intf
)
3732 * ALSA leaves material resumption to user space
3736 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
3740 #endif /* CONFIG_PM */
3742 static int __init
snd_usb_audio_init(void)
3744 if (nrpacks
< MIN_PACKS_URB
|| nrpacks
> MAX_PACKS
) {
3745 printk(KERN_WARNING
"invalid nrpacks value.\n");
3748 return usb_register(&usb_audio_driver
);
3752 static void __exit
snd_usb_audio_cleanup(void)
3754 usb_deregister(&usb_audio_driver
);
3757 module_init(snd_usb_audio_init
);
3758 module_exit(snd_usb_audio_cleanup
);