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 /* Vendor/product IDs for this card */
69 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
70 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
71 static int nrpacks
= 8; /* max. number of packets per urb */
72 static int async_unlink
= 1;
73 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card*/
74 static int ignore_ctl_error
;
76 module_param_array(index
, int, NULL
, 0444);
77 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
78 module_param_array(id
, charp
, NULL
, 0444);
79 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
80 module_param_array(enable
, bool, NULL
, 0444);
81 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
82 module_param_array(vid
, int, NULL
, 0444);
83 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
84 module_param_array(pid
, int, NULL
, 0444);
85 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
86 module_param(nrpacks
, int, 0644);
87 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
88 module_param(async_unlink
, bool, 0444);
89 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
90 module_param_array(device_setup
, int, NULL
, 0444);
91 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
92 module_param(ignore_ctl_error
, bool, 0444);
93 MODULE_PARM_DESC(ignore_ctl_error
,
94 "Ignore errors from USB controller for mixer interfaces.");
97 * debug the h/w constraints
99 /* #define HW_CONST_DEBUG */
107 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
109 #define SYNC_URBS 4 /* always four urbs for sync */
110 #define MAX_QUEUE 24 /* try not to exceed this queue length, in ms */
113 struct list_head list
;
114 snd_pcm_format_t format
; /* format type */
115 unsigned int channels
; /* # channels */
116 unsigned int fmt_type
; /* USB audio format type (1-3) */
117 unsigned int frame_size
; /* samples per frame for non-audio */
118 int iface
; /* interface number */
119 unsigned char altsetting
; /* corresponding alternate setting */
120 unsigned char altset_idx
; /* array index of altenate setting */
121 unsigned char attributes
; /* corresponding attributes of cs endpoint */
122 unsigned char endpoint
; /* endpoint */
123 unsigned char ep_attr
; /* endpoint attributes */
124 unsigned int maxpacksize
; /* max. packet size */
125 unsigned int rates
; /* rate bitmasks */
126 unsigned int rate_min
, rate_max
; /* min/max rates */
127 unsigned int nr_rates
; /* number of rate table entries */
128 unsigned int *rate_table
; /* rate table */
131 struct snd_usb_substream
;
135 unsigned int buffer_size
; /* size of data buffer, if data URB */
136 struct snd_usb_substream
*subs
;
137 int index
; /* index for urb array */
138 int packets
; /* number of packets per urb */
142 int (*prepare
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
143 int (*retire
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
144 int (*prepare_sync
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
145 int (*retire_sync
)(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
, struct urb
*u
);
148 struct snd_usb_substream
{
149 struct snd_usb_stream
*stream
;
150 struct usb_device
*dev
;
151 struct snd_pcm_substream
*pcm_substream
;
152 int direction
; /* playback or capture */
153 int interface
; /* current interface */
154 int endpoint
; /* assigned endpoint */
155 struct audioformat
*cur_audiofmt
; /* current audioformat pointer (for hw_params callback) */
156 unsigned int cur_rate
; /* current rate (for hw_params callback) */
157 unsigned int period_bytes
; /* current period bytes (for hw_params callback) */
158 unsigned int format
; /* USB data format */
159 unsigned int datapipe
; /* the data i/o pipe */
160 unsigned int syncpipe
; /* 1 - async out or adaptive in */
161 unsigned int datainterval
; /* log_2 of data packet interval */
162 unsigned int syncinterval
; /* P for adaptive mode, 0 otherwise */
163 unsigned int freqn
; /* nominal sampling rate in fs/fps in Q16.16 format */
164 unsigned int freqm
; /* momentary sampling rate in fs/fps in Q16.16 format */
165 unsigned int freqmax
; /* maximum sampling rate, used for buffer management */
166 unsigned int phase
; /* phase accumulator */
167 unsigned int maxpacksize
; /* max packet size in bytes */
168 unsigned int maxframesize
; /* max packet size in frames */
169 unsigned int curpacksize
; /* current packet size in bytes (for capture) */
170 unsigned int curframesize
; /* current packet size in frames (for capture) */
171 unsigned int fill_max
: 1; /* fill max packet size always */
172 unsigned int fmt_type
; /* USB audio format type (1-3) */
173 unsigned int packs_per_ms
; /* packets per millisecond (for playback) */
175 unsigned int running
: 1; /* running status */
177 unsigned int hwptr_done
; /* processed frame position in the buffer */
178 unsigned int transfer_done
; /* processed frames since last period update */
179 unsigned long active_mask
; /* bitmask of active urbs */
180 unsigned long unlink_mask
; /* bitmask of unlinked urbs */
182 unsigned int nurbs
; /* # urbs */
183 struct snd_urb_ctx dataurb
[MAX_URBS
]; /* data urb table */
184 struct snd_urb_ctx syncurb
[SYNC_URBS
]; /* sync urb table */
185 char *syncbuf
; /* sync buffer for all sync URBs */
186 dma_addr_t sync_dma
; /* DMA address of syncbuf */
188 u64 formats
; /* format bitmasks (all or'ed) */
189 unsigned int num_formats
; /* number of supported audio formats (list) */
190 struct list_head fmt_list
; /* format list */
191 struct snd_pcm_hw_constraint_list rate_list
; /* limited rates */
194 struct snd_urb_ops ops
; /* callbacks (must be filled at init) */
198 struct snd_usb_stream
{
199 struct snd_usb_audio
*chip
;
202 unsigned int fmt_type
; /* USB audio format type (1-3) */
203 struct snd_usb_substream substream
[2];
204 struct list_head list
;
209 * we keep the snd_usb_audio_t instances by ourselves for merging
210 * the all interfaces on the same card as one sound device.
213 static DEFINE_MUTEX(register_mutex
);
214 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
218 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
219 * this will overflow at approx 524 kHz
221 static inline unsigned get_usb_full_speed_rate(unsigned int rate
)
223 return ((rate
<< 13) + 62) / 125;
227 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
228 * this will overflow at approx 4 MHz
230 static inline unsigned get_usb_high_speed_rate(unsigned int rate
)
232 return ((rate
<< 10) + 62) / 125;
235 /* convert our full speed USB rate into sampling rate in Hz */
236 static inline unsigned get_full_speed_hz(unsigned int usb_rate
)
238 return (usb_rate
* 125 + (1 << 12)) >> 13;
241 /* convert our high speed USB rate into sampling rate in Hz */
242 static inline unsigned get_high_speed_hz(unsigned int usb_rate
)
244 return (usb_rate
* 125 + (1 << 9)) >> 10;
249 * prepare urb for full speed capture sync pipe
251 * fill the length and offset of each urb descriptor.
252 * the fixed 10.14 frequency is passed through the pipe.
254 static int prepare_capture_sync_urb(struct snd_usb_substream
*subs
,
255 struct snd_pcm_runtime
*runtime
,
258 unsigned char *cp
= urb
->transfer_buffer
;
259 struct snd_urb_ctx
*ctx
= urb
->context
;
261 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
262 urb
->iso_frame_desc
[0].length
= 3;
263 urb
->iso_frame_desc
[0].offset
= 0;
264 cp
[0] = subs
->freqn
>> 2;
265 cp
[1] = subs
->freqn
>> 10;
266 cp
[2] = subs
->freqn
>> 18;
271 * prepare urb for high speed capture sync pipe
273 * fill the length and offset of each urb descriptor.
274 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
276 static int prepare_capture_sync_urb_hs(struct snd_usb_substream
*subs
,
277 struct snd_pcm_runtime
*runtime
,
280 unsigned char *cp
= urb
->transfer_buffer
;
281 struct snd_urb_ctx
*ctx
= urb
->context
;
283 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
284 urb
->iso_frame_desc
[0].length
= 4;
285 urb
->iso_frame_desc
[0].offset
= 0;
287 cp
[1] = subs
->freqn
>> 8;
288 cp
[2] = subs
->freqn
>> 16;
289 cp
[3] = subs
->freqn
>> 24;
294 * process after capture sync complete
297 static int retire_capture_sync_urb(struct snd_usb_substream
*subs
,
298 struct snd_pcm_runtime
*runtime
,
305 * prepare urb for capture data pipe
307 * fill the offset and length of each descriptor.
309 * we use a temporary buffer to write the captured data.
310 * since the length of written data is determined by host, we cannot
311 * write onto the pcm buffer directly... the data is thus copied
312 * later at complete callback to the global buffer.
314 static int prepare_capture_urb(struct snd_usb_substream
*subs
,
315 struct snd_pcm_runtime
*runtime
,
319 struct snd_urb_ctx
*ctx
= urb
->context
;
322 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
323 for (i
= 0; i
< ctx
->packets
; i
++) {
324 urb
->iso_frame_desc
[i
].offset
= offs
;
325 urb
->iso_frame_desc
[i
].length
= subs
->curpacksize
;
326 offs
+= subs
->curpacksize
;
328 urb
->transfer_buffer_length
= offs
;
329 urb
->number_of_packets
= ctx
->packets
;
334 * process after capture complete
336 * copy the data from each desctiptor to the pcm buffer, and
337 * update the current position.
339 static int retire_capture_urb(struct snd_usb_substream
*subs
,
340 struct snd_pcm_runtime
*runtime
,
346 unsigned int stride
, len
, oldptr
;
347 int period_elapsed
= 0;
349 stride
= runtime
->frame_bits
>> 3;
351 for (i
= 0; i
< urb
->number_of_packets
; i
++) {
352 cp
= (unsigned char *)urb
->transfer_buffer
+ urb
->iso_frame_desc
[i
].offset
;
353 if (urb
->iso_frame_desc
[i
].status
) {
354 snd_printd(KERN_ERR
"frame %d active: %d\n", i
, urb
->iso_frame_desc
[i
].status
);
357 len
= urb
->iso_frame_desc
[i
].actual_length
/ stride
;
360 /* update the current pointer */
361 spin_lock_irqsave(&subs
->lock
, flags
);
362 oldptr
= subs
->hwptr_done
;
363 subs
->hwptr_done
+= len
;
364 if (subs
->hwptr_done
>= runtime
->buffer_size
)
365 subs
->hwptr_done
-= runtime
->buffer_size
;
366 subs
->transfer_done
+= len
;
367 if (subs
->transfer_done
>= runtime
->period_size
) {
368 subs
->transfer_done
-= runtime
->period_size
;
371 spin_unlock_irqrestore(&subs
->lock
, flags
);
372 /* copy a data chunk */
373 if (oldptr
+ len
> runtime
->buffer_size
) {
374 unsigned int cnt
= runtime
->buffer_size
- oldptr
;
375 unsigned int blen
= cnt
* stride
;
376 memcpy(runtime
->dma_area
+ oldptr
* stride
, cp
, blen
);
377 memcpy(runtime
->dma_area
, cp
+ blen
, len
* stride
- blen
);
379 memcpy(runtime
->dma_area
+ oldptr
* stride
, cp
, len
* stride
);
383 snd_pcm_period_elapsed(subs
->pcm_substream
);
388 * Process after capture complete when paused. Nothing to do.
390 static int retire_paused_capture_urb(struct snd_usb_substream
*subs
,
391 struct snd_pcm_runtime
*runtime
,
399 * prepare urb for full speed playback sync pipe
401 * set up the offset and length to receive the current frequency.
404 static int prepare_playback_sync_urb(struct snd_usb_substream
*subs
,
405 struct snd_pcm_runtime
*runtime
,
408 struct snd_urb_ctx
*ctx
= urb
->context
;
410 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
411 urb
->iso_frame_desc
[0].length
= 3;
412 urb
->iso_frame_desc
[0].offset
= 0;
417 * prepare urb for high speed playback sync pipe
419 * set up the offset and length to receive the current frequency.
422 static int prepare_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
423 struct snd_pcm_runtime
*runtime
,
426 struct snd_urb_ctx
*ctx
= urb
->context
;
428 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
429 urb
->iso_frame_desc
[0].length
= 4;
430 urb
->iso_frame_desc
[0].offset
= 0;
435 * process after full speed playback sync complete
437 * retrieve the current 10.14 frequency from pipe, and set it.
438 * the value is referred in prepare_playback_urb().
440 static int retire_playback_sync_urb(struct snd_usb_substream
*subs
,
441 struct snd_pcm_runtime
*runtime
,
447 if (urb
->iso_frame_desc
[0].status
== 0 &&
448 urb
->iso_frame_desc
[0].actual_length
== 3) {
449 f
= combine_triple((u8
*)urb
->transfer_buffer
) << 2;
450 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
451 spin_lock_irqsave(&subs
->lock
, flags
);
453 spin_unlock_irqrestore(&subs
->lock
, flags
);
461 * process after high speed playback sync complete
463 * retrieve the current 12.13 frequency from pipe, and set it.
464 * the value is referred in prepare_playback_urb().
466 static int retire_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
467 struct snd_pcm_runtime
*runtime
,
473 if (urb
->iso_frame_desc
[0].status
== 0 &&
474 urb
->iso_frame_desc
[0].actual_length
== 4) {
475 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
476 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
477 spin_lock_irqsave(&subs
->lock
, flags
);
479 spin_unlock_irqrestore(&subs
->lock
, flags
);
487 * process after E-Mu 0202/0404/Tracker Pre high speed playback sync complete
489 * These devices return the number of samples per packet instead of the number
490 * of samples per microframe.
492 static int retire_playback_sync_urb_hs_emu(struct snd_usb_substream
*subs
,
493 struct snd_pcm_runtime
*runtime
,
499 if (urb
->iso_frame_desc
[0].status
== 0 &&
500 urb
->iso_frame_desc
[0].actual_length
== 4) {
501 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
502 f
>>= subs
->datainterval
;
503 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
504 spin_lock_irqsave(&subs
->lock
, flags
);
506 spin_unlock_irqrestore(&subs
->lock
, flags
);
513 /* determine the number of frames in the next packet */
514 static int snd_usb_audio_next_packet_size(struct snd_usb_substream
*subs
)
517 return subs
->maxframesize
;
519 subs
->phase
= (subs
->phase
& 0xffff)
520 + (subs
->freqm
<< subs
->datainterval
);
521 return min(subs
->phase
>> 16, subs
->maxframesize
);
526 * Prepare urb for streaming before playback starts or when paused.
528 * We don't have any data, so we send silence.
530 static int prepare_nodata_playback_urb(struct snd_usb_substream
*subs
,
531 struct snd_pcm_runtime
*runtime
,
534 unsigned int i
, offs
, counts
;
535 struct snd_urb_ctx
*ctx
= urb
->context
;
536 int stride
= runtime
->frame_bits
>> 3;
539 urb
->dev
= ctx
->subs
->dev
;
540 for (i
= 0; i
< ctx
->packets
; ++i
) {
541 counts
= snd_usb_audio_next_packet_size(subs
);
542 urb
->iso_frame_desc
[i
].offset
= offs
* stride
;
543 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
546 urb
->number_of_packets
= ctx
->packets
;
547 urb
->transfer_buffer_length
= offs
* stride
;
548 memset(urb
->transfer_buffer
,
549 subs
->cur_audiofmt
->format
== SNDRV_PCM_FORMAT_U8
? 0x80 : 0,
555 * prepare urb for playback data pipe
557 * Since a URB can handle only a single linear buffer, we must use double
558 * buffering when the data to be transferred overflows the buffer boundary.
559 * To avoid inconsistencies when updating hwptr_done, we use double buffering
562 static int prepare_playback_urb(struct snd_usb_substream
*subs
,
563 struct snd_pcm_runtime
*runtime
,
569 int period_elapsed
= 0;
570 struct snd_urb_ctx
*ctx
= urb
->context
;
572 stride
= runtime
->frame_bits
>> 3;
575 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
576 urb
->number_of_packets
= 0;
577 spin_lock_irqsave(&subs
->lock
, flags
);
578 for (i
= 0; i
< ctx
->packets
; i
++) {
579 counts
= snd_usb_audio_next_packet_size(subs
);
580 /* set up descriptor */
581 urb
->iso_frame_desc
[i
].offset
= offs
* stride
;
582 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
584 urb
->number_of_packets
++;
585 subs
->transfer_done
+= counts
;
586 if (subs
->transfer_done
>= runtime
->period_size
) {
587 subs
->transfer_done
-= runtime
->period_size
;
589 if (subs
->fmt_type
== USB_FORMAT_TYPE_II
) {
590 if (subs
->transfer_done
> 0) {
591 /* FIXME: fill-max mode is not
593 offs
-= subs
->transfer_done
;
594 counts
-= subs
->transfer_done
;
595 urb
->iso_frame_desc
[i
].length
=
597 subs
->transfer_done
= 0;
600 if (i
< ctx
->packets
) {
601 /* add a transfer delimiter */
602 urb
->iso_frame_desc
[i
].offset
=
604 urb
->iso_frame_desc
[i
].length
= 0;
605 urb
->number_of_packets
++;
610 /* finish at the frame boundary at/after the period boundary */
611 if (period_elapsed
&&
612 (i
& (subs
->packs_per_ms
- 1)) == subs
->packs_per_ms
- 1)
615 if (subs
->hwptr_done
+ offs
> runtime
->buffer_size
) {
616 /* err, the transferred area goes over buffer boundary. */
617 unsigned int len
= runtime
->buffer_size
- subs
->hwptr_done
;
618 memcpy(urb
->transfer_buffer
,
619 runtime
->dma_area
+ subs
->hwptr_done
* stride
,
621 memcpy(urb
->transfer_buffer
+ len
* stride
,
623 (offs
- len
) * stride
);
625 memcpy(urb
->transfer_buffer
,
626 runtime
->dma_area
+ subs
->hwptr_done
* stride
,
629 subs
->hwptr_done
+= offs
;
630 if (subs
->hwptr_done
>= runtime
->buffer_size
)
631 subs
->hwptr_done
-= runtime
->buffer_size
;
632 spin_unlock_irqrestore(&subs
->lock
, flags
);
633 urb
->transfer_buffer_length
= offs
* stride
;
635 snd_pcm_period_elapsed(subs
->pcm_substream
);
640 * process after playback data complete
643 static int retire_playback_urb(struct snd_usb_substream
*subs
,
644 struct snd_pcm_runtime
*runtime
,
653 static struct snd_urb_ops audio_urb_ops
[2] = {
655 .prepare
= prepare_nodata_playback_urb
,
656 .retire
= retire_playback_urb
,
657 .prepare_sync
= prepare_playback_sync_urb
,
658 .retire_sync
= retire_playback_sync_urb
,
661 .prepare
= prepare_capture_urb
,
662 .retire
= retire_capture_urb
,
663 .prepare_sync
= prepare_capture_sync_urb
,
664 .retire_sync
= retire_capture_sync_urb
,
668 static struct snd_urb_ops audio_urb_ops_high_speed
[2] = {
670 .prepare
= prepare_nodata_playback_urb
,
671 .retire
= retire_playback_urb
,
672 .prepare_sync
= prepare_playback_sync_urb_hs
,
673 .retire_sync
= retire_playback_sync_urb_hs
,
676 .prepare
= prepare_capture_urb
,
677 .retire
= retire_capture_urb
,
678 .prepare_sync
= prepare_capture_sync_urb_hs
,
679 .retire_sync
= retire_capture_sync_urb
,
684 * complete callback from data urb
686 static void snd_complete_urb(struct urb
*urb
)
688 struct snd_urb_ctx
*ctx
= urb
->context
;
689 struct snd_usb_substream
*subs
= ctx
->subs
;
690 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
693 if ((subs
->running
&& subs
->ops
.retire(subs
, substream
->runtime
, urb
)) ||
694 !subs
->running
|| /* can be stopped during retire callback */
695 (err
= subs
->ops
.prepare(subs
, substream
->runtime
, urb
)) < 0 ||
696 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
697 clear_bit(ctx
->index
, &subs
->active_mask
);
699 snd_printd(KERN_ERR
"cannot submit urb (err = %d)\n", err
);
700 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
707 * complete callback from sync urb
709 static void snd_complete_sync_urb(struct urb
*urb
)
711 struct snd_urb_ctx
*ctx
= urb
->context
;
712 struct snd_usb_substream
*subs
= ctx
->subs
;
713 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
716 if ((subs
->running
&& subs
->ops
.retire_sync(subs
, substream
->runtime
, urb
)) ||
717 !subs
->running
|| /* can be stopped during retire callback */
718 (err
= subs
->ops
.prepare_sync(subs
, substream
->runtime
, urb
)) < 0 ||
719 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
720 clear_bit(ctx
->index
+ 16, &subs
->active_mask
);
722 snd_printd(KERN_ERR
"cannot submit sync urb (err = %d)\n", err
);
723 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
729 /* get the physical page pointer at the given offset */
730 static struct page
*snd_pcm_get_vmalloc_page(struct snd_pcm_substream
*subs
,
731 unsigned long offset
)
733 void *pageptr
= subs
->runtime
->dma_area
+ offset
;
734 return vmalloc_to_page(pageptr
);
737 /* allocate virtual buffer; may be called more than once */
738 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream
*subs
, size_t size
)
740 struct snd_pcm_runtime
*runtime
= subs
->runtime
;
741 if (runtime
->dma_area
) {
742 if (runtime
->dma_bytes
>= size
)
743 return 0; /* already large enough */
744 vfree(runtime
->dma_area
);
746 runtime
->dma_area
= vmalloc(size
);
747 if (!runtime
->dma_area
)
749 runtime
->dma_bytes
= size
;
753 /* free virtual buffer; may be called more than once */
754 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream
*subs
)
756 struct snd_pcm_runtime
*runtime
= subs
->runtime
;
758 vfree(runtime
->dma_area
);
759 runtime
->dma_area
= NULL
;
765 * unlink active urbs.
767 static int deactivate_urbs(struct snd_usb_substream
*subs
, int force
, int can_sleep
)
774 if (!force
&& subs
->stream
->chip
->shutdown
) /* to be sure... */
777 async
= !can_sleep
&& async_unlink
;
779 if (!async
&& in_interrupt())
782 for (i
= 0; i
< subs
->nurbs
; i
++) {
783 if (test_bit(i
, &subs
->active_mask
)) {
784 if (!test_and_set_bit(i
, &subs
->unlink_mask
)) {
785 struct urb
*u
= subs
->dataurb
[i
].urb
;
793 if (subs
->syncpipe
) {
794 for (i
= 0; i
< SYNC_URBS
; i
++) {
795 if (test_bit(i
+16, &subs
->active_mask
)) {
796 if (!test_and_set_bit(i
+16, &subs
->unlink_mask
)) {
797 struct urb
*u
= subs
->syncurb
[i
].urb
;
810 static const char *usb_error_string(int err
)
816 return "endpoint not enabled";
818 return "endpoint stalled";
820 return "not enough bandwidth";
822 return "device disabled";
824 return "device suspended";
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 if (snd_BUG_ON(!subs
->dataurb
[i
].urb
))
849 if (subs
->ops
.prepare(subs
, runtime
, subs
->dataurb
[i
].urb
) < 0) {
850 snd_printk(KERN_ERR
"cannot prepare datapipe for urb %d\n", i
);
854 if (subs
->syncpipe
) {
855 for (i
= 0; i
< SYNC_URBS
; i
++) {
856 if (snd_BUG_ON(!subs
->syncurb
[i
].urb
))
858 if (subs
->ops
.prepare_sync(subs
, runtime
, subs
->syncurb
[i
].urb
) < 0) {
859 snd_printk(KERN_ERR
"cannot prepare syncpipe for urb %d\n", i
);
865 subs
->active_mask
= 0;
866 subs
->unlink_mask
= 0;
868 for (i
= 0; i
< subs
->nurbs
; i
++) {
869 err
= usb_submit_urb(subs
->dataurb
[i
].urb
, GFP_ATOMIC
);
871 snd_printk(KERN_ERR
"cannot submit datapipe "
872 "for urb %d, error %d: %s\n",
873 i
, err
, usb_error_string(err
));
876 set_bit(i
, &subs
->active_mask
);
878 if (subs
->syncpipe
) {
879 for (i
= 0; i
< SYNC_URBS
; i
++) {
880 err
= usb_submit_urb(subs
->syncurb
[i
].urb
, GFP_ATOMIC
);
882 snd_printk(KERN_ERR
"cannot submit syncpipe "
883 "for urb %d, error %d: %s\n",
884 i
, err
, usb_error_string(err
));
887 set_bit(i
+ 16, &subs
->active_mask
);
893 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
894 deactivate_urbs(subs
, 0, 0);
900 * wait until all urbs are processed.
902 static int wait_clear_urbs(struct snd_usb_substream
*subs
)
904 unsigned long end_time
= jiffies
+ msecs_to_jiffies(1000);
910 for (i
= 0; i
< subs
->nurbs
; i
++) {
911 if (test_bit(i
, &subs
->active_mask
))
914 if (subs
->syncpipe
) {
915 for (i
= 0; i
< SYNC_URBS
; i
++) {
916 if (test_bit(i
+ 16, &subs
->active_mask
))
922 schedule_timeout_uninterruptible(1);
923 } while (time_before(jiffies
, end_time
));
925 snd_printk(KERN_ERR
"timeout: still %d active urbs..\n", alive
);
931 * return the current pcm pointer. just return the hwptr_done value.
933 static snd_pcm_uframes_t
snd_usb_pcm_pointer(struct snd_pcm_substream
*substream
)
935 struct snd_usb_substream
*subs
;
936 snd_pcm_uframes_t hwptr_done
;
938 subs
= (struct snd_usb_substream
*)substream
->runtime
->private_data
;
939 spin_lock(&subs
->lock
);
940 hwptr_done
= subs
->hwptr_done
;
941 spin_unlock(&subs
->lock
);
947 * start/stop playback substream
949 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream
*substream
,
952 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
955 case SNDRV_PCM_TRIGGER_START
:
956 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
957 subs
->ops
.prepare
= prepare_playback_urb
;
959 case SNDRV_PCM_TRIGGER_STOP
:
960 return deactivate_urbs(subs
, 0, 0);
961 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
962 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
970 * start/stop capture substream
972 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream
*substream
,
975 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
978 case SNDRV_PCM_TRIGGER_START
:
979 subs
->ops
.retire
= retire_capture_urb
;
980 return start_urbs(subs
, substream
->runtime
);
981 case SNDRV_PCM_TRIGGER_STOP
:
982 return deactivate_urbs(subs
, 0, 0);
983 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
984 subs
->ops
.retire
= retire_paused_capture_urb
;
986 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
987 subs
->ops
.retire
= retire_capture_urb
;
998 static void release_urb_ctx(struct snd_urb_ctx
*u
)
1002 usb_buffer_free(u
->subs
->dev
, u
->buffer_size
,
1003 u
->urb
->transfer_buffer
,
1004 u
->urb
->transfer_dma
);
1005 usb_free_urb(u
->urb
);
1011 * release a substream
1013 static void release_substream_urbs(struct snd_usb_substream
*subs
, int force
)
1017 /* stop urbs (to be sure) */
1018 deactivate_urbs(subs
, force
, 1);
1019 wait_clear_urbs(subs
);
1021 for (i
= 0; i
< MAX_URBS
; i
++)
1022 release_urb_ctx(&subs
->dataurb
[i
]);
1023 for (i
= 0; i
< SYNC_URBS
; i
++)
1024 release_urb_ctx(&subs
->syncurb
[i
]);
1025 usb_buffer_free(subs
->dev
, SYNC_URBS
* 4,
1026 subs
->syncbuf
, subs
->sync_dma
);
1027 subs
->syncbuf
= NULL
;
1032 * initialize a substream for plaback/capture
1034 static int init_substream_urbs(struct snd_usb_substream
*subs
, unsigned int period_bytes
,
1035 unsigned int rate
, unsigned int frame_bits
)
1037 unsigned int maxsize
, i
;
1038 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1039 unsigned int urb_packs
, total_packs
, packs_per_ms
;
1041 /* calculate the frequency in 16.16 format */
1042 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1043 subs
->freqn
= get_usb_full_speed_rate(rate
);
1045 subs
->freqn
= get_usb_high_speed_rate(rate
);
1046 subs
->freqm
= subs
->freqn
;
1047 /* calculate max. frequency */
1048 if (subs
->maxpacksize
) {
1049 /* whatever fits into a max. size packet */
1050 maxsize
= subs
->maxpacksize
;
1051 subs
->freqmax
= (maxsize
/ (frame_bits
>> 3))
1052 << (16 - subs
->datainterval
);
1054 /* no max. packet size: just take 25% higher than nominal */
1055 subs
->freqmax
= subs
->freqn
+ (subs
->freqn
>> 2);
1056 maxsize
= ((subs
->freqmax
+ 0xffff) * (frame_bits
>> 3))
1057 >> (16 - subs
->datainterval
);
1062 subs
->curpacksize
= subs
->maxpacksize
;
1064 subs
->curpacksize
= maxsize
;
1066 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
)
1067 packs_per_ms
= 8 >> subs
->datainterval
;
1070 subs
->packs_per_ms
= packs_per_ms
;
1073 urb_packs
= max(nrpacks
, 1);
1074 urb_packs
= min(urb_packs
, (unsigned int)MAX_PACKS
);
1077 urb_packs
*= packs_per_ms
;
1079 /* decide how many packets to be used */
1081 unsigned int minsize
, maxpacks
;
1082 /* determine how small a packet can be */
1083 minsize
= (subs
->freqn
>> (16 - subs
->datainterval
))
1084 * (frame_bits
>> 3);
1085 /* with sync from device, assume it can be 12% lower */
1087 minsize
-= minsize
>> 3;
1088 minsize
= max(minsize
, 1u);
1089 total_packs
= (period_bytes
+ minsize
- 1) / minsize
;
1090 /* round up to multiple of packs_per_ms */
1091 total_packs
= (total_packs
+ packs_per_ms
- 1)
1092 & ~(packs_per_ms
- 1);
1093 /* we need at least two URBs for queueing */
1094 if (total_packs
< 2 * packs_per_ms
) {
1095 total_packs
= 2 * packs_per_ms
;
1097 /* and we don't want too long a queue either */
1098 maxpacks
= max(MAX_QUEUE
* packs_per_ms
, urb_packs
* 2);
1099 total_packs
= min(total_packs
, maxpacks
);
1102 total_packs
= MAX_URBS
* urb_packs
;
1104 subs
->nurbs
= (total_packs
+ urb_packs
- 1) / urb_packs
;
1105 if (subs
->nurbs
> MAX_URBS
) {
1107 subs
->nurbs
= MAX_URBS
;
1108 total_packs
= MAX_URBS
* urb_packs
;
1109 } else if (subs
->nurbs
< 2) {
1110 /* too little - we need at least two packets
1111 * to ensure contiguous playback/capture
1116 /* allocate and initialize data urbs */
1117 for (i
= 0; i
< subs
->nurbs
; i
++) {
1118 struct snd_urb_ctx
*u
= &subs
->dataurb
[i
];
1121 u
->packets
= (i
+ 1) * total_packs
/ subs
->nurbs
1122 - i
* total_packs
/ subs
->nurbs
;
1123 u
->buffer_size
= maxsize
* u
->packets
;
1124 if (subs
->fmt_type
== USB_FORMAT_TYPE_II
)
1125 u
->packets
++; /* for transfer delimiter */
1126 u
->urb
= usb_alloc_urb(u
->packets
, GFP_KERNEL
);
1129 u
->urb
->transfer_buffer
=
1130 usb_buffer_alloc(subs
->dev
, u
->buffer_size
, GFP_KERNEL
,
1131 &u
->urb
->transfer_dma
);
1132 if (!u
->urb
->transfer_buffer
)
1134 u
->urb
->pipe
= subs
->datapipe
;
1135 u
->urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1136 u
->urb
->interval
= 1 << subs
->datainterval
;
1137 u
->urb
->context
= u
;
1138 u
->urb
->complete
= snd_complete_urb
;
1141 if (subs
->syncpipe
) {
1142 /* allocate and initialize sync urbs */
1143 subs
->syncbuf
= usb_buffer_alloc(subs
->dev
, SYNC_URBS
* 4,
1144 GFP_KERNEL
, &subs
->sync_dma
);
1147 for (i
= 0; i
< SYNC_URBS
; i
++) {
1148 struct snd_urb_ctx
*u
= &subs
->syncurb
[i
];
1152 u
->urb
= usb_alloc_urb(1, GFP_KERNEL
);
1155 u
->urb
->transfer_buffer
= subs
->syncbuf
+ i
* 4;
1156 u
->urb
->transfer_dma
= subs
->sync_dma
+ i
* 4;
1157 u
->urb
->transfer_buffer_length
= 4;
1158 u
->urb
->pipe
= subs
->syncpipe
;
1159 u
->urb
->transfer_flags
= URB_ISO_ASAP
|
1160 URB_NO_TRANSFER_DMA_MAP
;
1161 u
->urb
->number_of_packets
= 1;
1162 u
->urb
->interval
= 1 << subs
->syncinterval
;
1163 u
->urb
->context
= u
;
1164 u
->urb
->complete
= snd_complete_sync_urb
;
1170 release_substream_urbs(subs
, 0);
1176 * find a matching audio format
1178 static struct audioformat
*find_format(struct snd_usb_substream
*subs
, unsigned int format
,
1179 unsigned int rate
, unsigned int channels
)
1181 struct list_head
*p
;
1182 struct audioformat
*found
= NULL
;
1183 int cur_attr
= 0, attr
;
1185 list_for_each(p
, &subs
->fmt_list
) {
1186 struct audioformat
*fp
;
1187 fp
= list_entry(p
, struct audioformat
, list
);
1188 if (fp
->format
!= format
|| fp
->channels
!= channels
)
1190 if (rate
< fp
->rate_min
|| rate
> fp
->rate_max
)
1192 if (! (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)) {
1194 for (i
= 0; i
< fp
->nr_rates
; i
++)
1195 if (fp
->rate_table
[i
] == rate
)
1197 if (i
>= fp
->nr_rates
)
1200 attr
= fp
->ep_attr
& EP_ATTR_MASK
;
1206 /* avoid async out and adaptive in if the other method
1207 * supports the same format.
1208 * this is a workaround for the case like
1209 * M-audio audiophile USB.
1211 if (attr
!= cur_attr
) {
1212 if ((attr
== EP_ATTR_ASYNC
&&
1213 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1214 (attr
== EP_ATTR_ADAPTIVE
&&
1215 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
))
1217 if ((cur_attr
== EP_ATTR_ASYNC
&&
1218 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1219 (cur_attr
== EP_ATTR_ADAPTIVE
&&
1220 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
)) {
1226 /* find the format with the largest max. packet size */
1227 if (fp
->maxpacksize
> found
->maxpacksize
) {
1237 * initialize the picth control and sample rate
1239 static int init_usb_pitch(struct usb_device
*dev
, int iface
,
1240 struct usb_host_interface
*alts
,
1241 struct audioformat
*fmt
)
1244 unsigned char data
[1];
1247 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1248 /* if endpoint has pitch control, enable it */
1249 if (fmt
->attributes
& EP_CS_ATTR_PITCH_CONTROL
) {
1251 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
1252 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1253 PITCH_CONTROL
<< 8, ep
, data
, 1, 1000)) < 0) {
1254 snd_printk(KERN_ERR
"%d:%d:%d: cannot set enable PITCH\n",
1255 dev
->devnum
, iface
, ep
);
1262 static int init_usb_sample_rate(struct usb_device
*dev
, int iface
,
1263 struct usb_host_interface
*alts
,
1264 struct audioformat
*fmt
, int rate
)
1267 unsigned char data
[3];
1270 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1271 /* if endpoint has sampling rate control, set it */
1272 if (fmt
->attributes
& EP_CS_ATTR_SAMPLE_RATE
) {
1275 data
[1] = rate
>> 8;
1276 data
[2] = rate
>> 16;
1277 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
1278 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1279 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000)) < 0) {
1280 snd_printk(KERN_ERR
"%d:%d:%d: cannot set freq %d to ep %#x\n",
1281 dev
->devnum
, iface
, fmt
->altsetting
, rate
, ep
);
1284 if ((err
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), GET_CUR
,
1285 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_IN
,
1286 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000)) < 0) {
1287 snd_printk(KERN_WARNING
"%d:%d:%d: cannot get freq at ep %#x\n",
1288 dev
->devnum
, iface
, fmt
->altsetting
, ep
);
1289 return 0; /* some devices don't support reading */
1291 crate
= data
[0] | (data
[1] << 8) | (data
[2] << 16);
1292 if (crate
!= rate
) {
1293 snd_printd(KERN_WARNING
"current rate %d is different from the runtime rate %d\n", crate
, rate
);
1294 // runtime->rate = crate;
1301 * find a matching format and set up the interface
1303 static int set_format(struct snd_usb_substream
*subs
, struct audioformat
*fmt
)
1305 struct usb_device
*dev
= subs
->dev
;
1306 struct usb_host_interface
*alts
;
1307 struct usb_interface_descriptor
*altsd
;
1308 struct usb_interface
*iface
;
1309 unsigned int ep
, attr
;
1310 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1313 iface
= usb_ifnum_to_if(dev
, fmt
->iface
);
1314 if (WARN_ON(!iface
))
1316 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1317 altsd
= get_iface_desc(alts
);
1318 if (WARN_ON(altsd
->bAlternateSetting
!= fmt
->altsetting
))
1321 if (fmt
== subs
->cur_audiofmt
)
1324 /* close the old interface */
1325 if (subs
->interface
>= 0 && subs
->interface
!= fmt
->iface
) {
1326 if (usb_set_interface(subs
->dev
, subs
->interface
, 0) < 0) {
1327 snd_printk(KERN_ERR
"%d:%d:%d: return to setting 0 failed\n",
1328 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1331 subs
->interface
= -1;
1336 if (subs
->interface
!= fmt
->iface
|| subs
->format
!= fmt
->altset_idx
) {
1337 if (usb_set_interface(dev
, fmt
->iface
, fmt
->altsetting
) < 0) {
1338 snd_printk(KERN_ERR
"%d:%d:%d: usb_set_interface failed\n",
1339 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1342 snd_printdd(KERN_INFO
"setting usb interface %d:%d\n", fmt
->iface
, fmt
->altsetting
);
1343 subs
->interface
= fmt
->iface
;
1344 subs
->format
= fmt
->altset_idx
;
1347 /* create a data pipe */
1348 ep
= fmt
->endpoint
& USB_ENDPOINT_NUMBER_MASK
;
1350 subs
->datapipe
= usb_sndisocpipe(dev
, ep
);
1352 subs
->datapipe
= usb_rcvisocpipe(dev
, ep
);
1353 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
&&
1354 get_endpoint(alts
, 0)->bInterval
>= 1 &&
1355 get_endpoint(alts
, 0)->bInterval
<= 4)
1356 subs
->datainterval
= get_endpoint(alts
, 0)->bInterval
- 1;
1358 subs
->datainterval
= 0;
1359 subs
->syncpipe
= subs
->syncinterval
= 0;
1360 subs
->maxpacksize
= fmt
->maxpacksize
;
1363 /* we need a sync pipe in async OUT or adaptive IN mode */
1364 /* check the number of EP, since some devices have broken
1365 * descriptors which fool us. if it has only one EP,
1366 * assume it as adaptive-out or sync-in.
1368 attr
= fmt
->ep_attr
& EP_ATTR_MASK
;
1369 if (((is_playback
&& attr
== EP_ATTR_ASYNC
) ||
1370 (! is_playback
&& attr
== EP_ATTR_ADAPTIVE
)) &&
1371 altsd
->bNumEndpoints
>= 2) {
1372 /* check sync-pipe endpoint */
1373 /* ... and check descriptor size before accessing bSynchAddress
1374 because there is a version of the SB Audigy 2 NX firmware lacking
1375 the audio fields in the endpoint descriptors */
1376 if ((get_endpoint(alts
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != 0x01 ||
1377 (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1378 get_endpoint(alts
, 1)->bSynchAddress
!= 0)) {
1379 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1380 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1383 ep
= get_endpoint(alts
, 1)->bEndpointAddress
;
1384 if (get_endpoint(alts
, 0)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1385 (( is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
| USB_DIR_IN
)) ||
1386 (!is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
& ~USB_DIR_IN
)))) {
1387 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1388 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1391 ep
&= USB_ENDPOINT_NUMBER_MASK
;
1393 subs
->syncpipe
= usb_rcvisocpipe(dev
, ep
);
1395 subs
->syncpipe
= usb_sndisocpipe(dev
, ep
);
1396 if (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1397 get_endpoint(alts
, 1)->bRefresh
>= 1 &&
1398 get_endpoint(alts
, 1)->bRefresh
<= 9)
1399 subs
->syncinterval
= get_endpoint(alts
, 1)->bRefresh
;
1400 else if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1401 subs
->syncinterval
= 1;
1402 else if (get_endpoint(alts
, 1)->bInterval
>= 1 &&
1403 get_endpoint(alts
, 1)->bInterval
<= 16)
1404 subs
->syncinterval
= get_endpoint(alts
, 1)->bInterval
- 1;
1406 subs
->syncinterval
= 3;
1409 /* always fill max packet size */
1410 if (fmt
->attributes
& EP_CS_ATTR_FILL_MAX
)
1413 if ((err
= init_usb_pitch(dev
, subs
->interface
, alts
, fmt
)) < 0)
1416 subs
->cur_audiofmt
= fmt
;
1420 "setting done: format = %d, rate = %d..%d, channels = %d\n",
1421 fmt
->format
, fmt
->rate_min
, fmt
->rate_max
, fmt
->channels
);
1423 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
1424 subs
->datapipe
, subs
->syncpipe
);
1431 * hw_params callback
1433 * allocate a buffer and set the given audio format.
1435 * so far we use a physically linear buffer although packetize transfer
1436 * doesn't need a continuous area.
1437 * if sg buffer is supported on the later version of alsa, we'll follow
1440 static int snd_usb_hw_params(struct snd_pcm_substream
*substream
,
1441 struct snd_pcm_hw_params
*hw_params
)
1443 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1444 struct audioformat
*fmt
;
1445 unsigned int channels
, rate
, format
;
1448 ret
= snd_pcm_alloc_vmalloc_buffer(substream
,
1449 params_buffer_bytes(hw_params
));
1453 format
= params_format(hw_params
);
1454 rate
= params_rate(hw_params
);
1455 channels
= params_channels(hw_params
);
1456 fmt
= find_format(subs
, format
, rate
, channels
);
1458 snd_printd(KERN_DEBUG
"cannot set format: format = %#x, rate = %d, channels = %d\n",
1459 format
, rate
, channels
);
1463 changed
= subs
->cur_audiofmt
!= fmt
||
1464 subs
->period_bytes
!= params_period_bytes(hw_params
) ||
1465 subs
->cur_rate
!= rate
;
1466 if ((ret
= set_format(subs
, fmt
)) < 0)
1469 if (subs
->cur_rate
!= rate
) {
1470 struct usb_host_interface
*alts
;
1471 struct usb_interface
*iface
;
1472 iface
= usb_ifnum_to_if(subs
->dev
, fmt
->iface
);
1473 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1474 ret
= init_usb_sample_rate(subs
->dev
, subs
->interface
, alts
, fmt
, rate
);
1477 subs
->cur_rate
= rate
;
1481 /* format changed */
1482 release_substream_urbs(subs
, 0);
1483 /* influenced: period_bytes, channels, rate, format, */
1484 ret
= init_substream_urbs(subs
, params_period_bytes(hw_params
),
1485 params_rate(hw_params
),
1486 snd_pcm_format_physical_width(params_format(hw_params
)) * params_channels(hw_params
));
1495 * reset the audio format and release the buffer
1497 static int snd_usb_hw_free(struct snd_pcm_substream
*substream
)
1499 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1501 subs
->cur_audiofmt
= NULL
;
1503 subs
->period_bytes
= 0;
1504 if (!subs
->stream
->chip
->shutdown
)
1505 release_substream_urbs(subs
, 0);
1506 return snd_pcm_free_vmalloc_buffer(substream
);
1512 * only a few subtle things...
1514 static int snd_usb_pcm_prepare(struct snd_pcm_substream
*substream
)
1516 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1517 struct snd_usb_substream
*subs
= runtime
->private_data
;
1519 if (! subs
->cur_audiofmt
) {
1520 snd_printk(KERN_ERR
"usbaudio: no format is specified!\n");
1524 /* some unit conversions in runtime */
1525 subs
->maxframesize
= bytes_to_frames(runtime
, subs
->maxpacksize
);
1526 subs
->curframesize
= bytes_to_frames(runtime
, subs
->curpacksize
);
1528 /* reset the pointer */
1529 subs
->hwptr_done
= 0;
1530 subs
->transfer_done
= 0;
1533 /* clear urbs (to be sure) */
1534 deactivate_urbs(subs
, 0, 1);
1535 wait_clear_urbs(subs
);
1537 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1538 * updates for all URBs would happen at the same time when starting */
1539 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1540 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
1541 return start_urbs(subs
, runtime
);
1546 static struct snd_pcm_hardware snd_usb_hardware
=
1548 .info
= SNDRV_PCM_INFO_MMAP
|
1549 SNDRV_PCM_INFO_MMAP_VALID
|
1550 SNDRV_PCM_INFO_BATCH
|
1551 SNDRV_PCM_INFO_INTERLEAVED
|
1552 SNDRV_PCM_INFO_BLOCK_TRANSFER
|
1553 SNDRV_PCM_INFO_PAUSE
,
1554 .buffer_bytes_max
= 1024 * 1024,
1555 .period_bytes_min
= 64,
1556 .period_bytes_max
= 512 * 1024,
1558 .periods_max
= 1024,
1565 #ifdef HW_CONST_DEBUG
1566 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1568 #define hwc_debug(fmt, args...) /**/
1571 static int hw_check_valid_format(struct snd_pcm_hw_params
*params
, struct audioformat
*fp
)
1573 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1574 struct snd_interval
*ct
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1575 struct snd_mask
*fmts
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1577 /* check the format */
1578 if (!snd_mask_test(fmts
, fp
->format
)) {
1579 hwc_debug(" > check: no supported format %d\n", fp
->format
);
1582 /* check the channels */
1583 if (fp
->channels
< ct
->min
|| fp
->channels
> ct
->max
) {
1584 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp
->channels
, ct
->min
, ct
->max
);
1587 /* check the rate is within the range */
1588 if (fp
->rate_min
> it
->max
|| (fp
->rate_min
== it
->max
&& it
->openmax
)) {
1589 hwc_debug(" > check: rate_min %d > max %d\n", fp
->rate_min
, it
->max
);
1592 if (fp
->rate_max
< it
->min
|| (fp
->rate_max
== it
->min
&& it
->openmin
)) {
1593 hwc_debug(" > check: rate_max %d < min %d\n", fp
->rate_max
, it
->min
);
1599 static int hw_rule_rate(struct snd_pcm_hw_params
*params
,
1600 struct snd_pcm_hw_rule
*rule
)
1602 struct snd_usb_substream
*subs
= rule
->private;
1603 struct list_head
*p
;
1604 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1605 unsigned int rmin
, rmax
;
1608 hwc_debug("hw_rule_rate: (%d,%d)\n", it
->min
, it
->max
);
1611 list_for_each(p
, &subs
->fmt_list
) {
1612 struct audioformat
*fp
;
1613 fp
= list_entry(p
, struct audioformat
, list
);
1614 if (!hw_check_valid_format(params
, fp
))
1617 if (rmin
> fp
->rate_min
)
1618 rmin
= fp
->rate_min
;
1619 if (rmax
< fp
->rate_max
)
1620 rmax
= fp
->rate_max
;
1622 rmin
= fp
->rate_min
;
1623 rmax
= fp
->rate_max
;
1628 hwc_debug(" --> get empty\n");
1634 if (it
->min
< rmin
) {
1639 if (it
->max
> rmax
) {
1644 if (snd_interval_checkempty(it
)) {
1648 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1653 static int hw_rule_channels(struct snd_pcm_hw_params
*params
,
1654 struct snd_pcm_hw_rule
*rule
)
1656 struct snd_usb_substream
*subs
= rule
->private;
1657 struct list_head
*p
;
1658 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1659 unsigned int rmin
, rmax
;
1662 hwc_debug("hw_rule_channels: (%d,%d)\n", it
->min
, it
->max
);
1665 list_for_each(p
, &subs
->fmt_list
) {
1666 struct audioformat
*fp
;
1667 fp
= list_entry(p
, struct audioformat
, list
);
1668 if (!hw_check_valid_format(params
, fp
))
1671 if (rmin
> fp
->channels
)
1672 rmin
= fp
->channels
;
1673 if (rmax
< fp
->channels
)
1674 rmax
= fp
->channels
;
1676 rmin
= fp
->channels
;
1677 rmax
= fp
->channels
;
1682 hwc_debug(" --> get empty\n");
1688 if (it
->min
< rmin
) {
1693 if (it
->max
> rmax
) {
1698 if (snd_interval_checkempty(it
)) {
1702 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1706 static int hw_rule_format(struct snd_pcm_hw_params
*params
,
1707 struct snd_pcm_hw_rule
*rule
)
1709 struct snd_usb_substream
*subs
= rule
->private;
1710 struct list_head
*p
;
1711 struct snd_mask
*fmt
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1716 hwc_debug("hw_rule_format: %x:%x\n", fmt
->bits
[0], fmt
->bits
[1]);
1718 list_for_each(p
, &subs
->fmt_list
) {
1719 struct audioformat
*fp
;
1720 fp
= list_entry(p
, struct audioformat
, list
);
1721 if (!hw_check_valid_format(params
, fp
))
1723 fbits
|= (1ULL << fp
->format
);
1726 oldbits
[0] = fmt
->bits
[0];
1727 oldbits
[1] = fmt
->bits
[1];
1728 fmt
->bits
[0] &= (u32
)fbits
;
1729 fmt
->bits
[1] &= (u32
)(fbits
>> 32);
1730 if (!fmt
->bits
[0] && !fmt
->bits
[1]) {
1731 hwc_debug(" --> get empty\n");
1734 changed
= (oldbits
[0] != fmt
->bits
[0] || oldbits
[1] != fmt
->bits
[1]);
1735 hwc_debug(" --> %x:%x (changed = %d)\n", fmt
->bits
[0], fmt
->bits
[1], changed
);
1742 * check whether the registered audio formats need special hw-constraints
1744 static int check_hw_params_convention(struct snd_usb_substream
*subs
)
1749 u32 cmaster
, rmaster
;
1750 u32 rate_min
= 0, rate_max
= 0;
1751 struct list_head
*p
;
1754 channels
= kcalloc(MAX_MASK
, sizeof(u32
), GFP_KERNEL
);
1755 rates
= kcalloc(MAX_MASK
, sizeof(u32
), GFP_KERNEL
);
1756 if (!channels
|| !rates
) {
1761 list_for_each(p
, &subs
->fmt_list
) {
1762 struct audioformat
*f
;
1763 f
= list_entry(p
, struct audioformat
, list
);
1764 /* unconventional channels? */
1765 if (f
->channels
> 32)
1767 /* continuous rate min/max matches? */
1768 if (f
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
1769 if (rate_min
&& f
->rate_min
!= rate_min
)
1771 if (rate_max
&& f
->rate_max
!= rate_max
)
1773 rate_min
= f
->rate_min
;
1774 rate_max
= f
->rate_max
;
1776 /* combination of continuous rates and fixed rates? */
1777 if (rates
[f
->format
] & SNDRV_PCM_RATE_CONTINUOUS
) {
1778 if (f
->rates
!= rates
[f
->format
])
1781 if (f
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
1782 if (rates
[f
->format
] && rates
[f
->format
] != f
->rates
)
1785 channels
[f
->format
] |= 1 << (f
->channels
- 1);
1786 rates
[f
->format
] |= f
->rates
;
1788 if (f
->rates
& SNDRV_PCM_RATE_KNOT
)
1791 /* check whether channels and rates match for all formats */
1792 cmaster
= rmaster
= 0;
1793 for (i
= 0; i
< MAX_MASK
; i
++) {
1794 if (cmaster
!= channels
[i
] && cmaster
&& channels
[i
])
1796 if (rmaster
!= rates
[i
] && rmaster
&& rates
[i
])
1799 cmaster
= channels
[i
];
1803 /* check whether channels match for all distinct rates */
1804 memset(channels
, 0, MAX_MASK
* sizeof(u32
));
1805 list_for_each(p
, &subs
->fmt_list
) {
1806 struct audioformat
*f
;
1807 f
= list_entry(p
, struct audioformat
, list
);
1808 if (f
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
1810 for (i
= 0; i
< 32; i
++) {
1811 if (f
->rates
& (1 << i
))
1812 channels
[i
] |= 1 << (f
->channels
- 1);
1816 for (i
= 0; i
< 32; i
++) {
1817 if (cmaster
!= channels
[i
] && cmaster
&& channels
[i
])
1820 cmaster
= channels
[i
];
1831 * If the device supports unusual bit rates, does the request meet these?
1833 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime
*runtime
,
1834 struct snd_usb_substream
*subs
)
1836 struct audioformat
*fp
;
1837 int count
= 0, needs_knot
= 0;
1840 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1841 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
1843 count
+= fp
->nr_rates
;
1844 if (fp
->rates
& SNDRV_PCM_RATE_KNOT
)
1850 subs
->rate_list
.count
= count
;
1851 subs
->rate_list
.list
= kmalloc(sizeof(int) * count
, GFP_KERNEL
);
1852 subs
->rate_list
.mask
= 0;
1854 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1856 for (i
= 0; i
< fp
->nr_rates
; i
++)
1857 subs
->rate_list
.list
[count
++] = fp
->rate_table
[i
];
1859 err
= snd_pcm_hw_constraint_list(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1869 * set up the runtime hardware information.
1872 static int setup_hw_info(struct snd_pcm_runtime
*runtime
, struct snd_usb_substream
*subs
)
1874 struct list_head
*p
;
1877 runtime
->hw
.formats
= subs
->formats
;
1879 runtime
->hw
.rate_min
= 0x7fffffff;
1880 runtime
->hw
.rate_max
= 0;
1881 runtime
->hw
.channels_min
= 256;
1882 runtime
->hw
.channels_max
= 0;
1883 runtime
->hw
.rates
= 0;
1884 /* check min/max rates and channels */
1885 list_for_each(p
, &subs
->fmt_list
) {
1886 struct audioformat
*fp
;
1887 fp
= list_entry(p
, struct audioformat
, list
);
1888 runtime
->hw
.rates
|= fp
->rates
;
1889 if (runtime
->hw
.rate_min
> fp
->rate_min
)
1890 runtime
->hw
.rate_min
= fp
->rate_min
;
1891 if (runtime
->hw
.rate_max
< fp
->rate_max
)
1892 runtime
->hw
.rate_max
= fp
->rate_max
;
1893 if (runtime
->hw
.channels_min
> fp
->channels
)
1894 runtime
->hw
.channels_min
= fp
->channels
;
1895 if (runtime
->hw
.channels_max
< fp
->channels
)
1896 runtime
->hw
.channels_max
= fp
->channels
;
1897 if (fp
->fmt_type
== USB_FORMAT_TYPE_II
&& fp
->frame_size
> 0) {
1898 /* FIXME: there might be more than one audio formats... */
1899 runtime
->hw
.period_bytes_min
= runtime
->hw
.period_bytes_max
=
1904 /* set the period time minimum 1ms */
1905 /* FIXME: high-speed mode allows 125us minimum period, but many parts
1906 * in the current code assume the 1ms period.
1908 snd_pcm_hw_constraint_minmax(runtime
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
1910 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX
);
1912 err
= check_hw_params_convention(subs
);
1916 hwc_debug("setting extra hw constraints...\n");
1917 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1919 SNDRV_PCM_HW_PARAM_FORMAT
,
1920 SNDRV_PCM_HW_PARAM_CHANNELS
,
1923 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_CHANNELS
,
1924 hw_rule_channels
, subs
,
1925 SNDRV_PCM_HW_PARAM_FORMAT
,
1926 SNDRV_PCM_HW_PARAM_RATE
,
1929 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_FORMAT
,
1930 hw_rule_format
, subs
,
1931 SNDRV_PCM_HW_PARAM_RATE
,
1932 SNDRV_PCM_HW_PARAM_CHANNELS
,
1935 if ((err
= snd_usb_pcm_check_knot(runtime
, subs
)) < 0)
1941 static int snd_usb_pcm_open(struct snd_pcm_substream
*substream
, int direction
)
1943 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1944 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1945 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1947 subs
->interface
= -1;
1949 runtime
->hw
= snd_usb_hardware
;
1950 runtime
->private_data
= subs
;
1951 subs
->pcm_substream
= substream
;
1952 return setup_hw_info(runtime
, subs
);
1955 static int snd_usb_pcm_close(struct snd_pcm_substream
*substream
, int direction
)
1957 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1958 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1960 if (subs
->interface
>= 0) {
1961 usb_set_interface(subs
->dev
, subs
->interface
, 0);
1962 subs
->interface
= -1;
1964 subs
->pcm_substream
= NULL
;
1968 static int snd_usb_playback_open(struct snd_pcm_substream
*substream
)
1970 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1973 static int snd_usb_playback_close(struct snd_pcm_substream
*substream
)
1975 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1978 static int snd_usb_capture_open(struct snd_pcm_substream
*substream
)
1980 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1983 static int snd_usb_capture_close(struct snd_pcm_substream
*substream
)
1985 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1988 static struct snd_pcm_ops snd_usb_playback_ops
= {
1989 .open
= snd_usb_playback_open
,
1990 .close
= snd_usb_playback_close
,
1991 .ioctl
= snd_pcm_lib_ioctl
,
1992 .hw_params
= snd_usb_hw_params
,
1993 .hw_free
= snd_usb_hw_free
,
1994 .prepare
= snd_usb_pcm_prepare
,
1995 .trigger
= snd_usb_pcm_playback_trigger
,
1996 .pointer
= snd_usb_pcm_pointer
,
1997 .page
= snd_pcm_get_vmalloc_page
,
2000 static struct snd_pcm_ops snd_usb_capture_ops
= {
2001 .open
= snd_usb_capture_open
,
2002 .close
= snd_usb_capture_close
,
2003 .ioctl
= snd_pcm_lib_ioctl
,
2004 .hw_params
= snd_usb_hw_params
,
2005 .hw_free
= snd_usb_hw_free
,
2006 .prepare
= snd_usb_pcm_prepare
,
2007 .trigger
= snd_usb_pcm_capture_trigger
,
2008 .pointer
= snd_usb_pcm_pointer
,
2009 .page
= snd_pcm_get_vmalloc_page
,
2019 * combine bytes and get an integer value
2021 unsigned int snd_usb_combine_bytes(unsigned char *bytes
, int size
)
2024 case 1: return *bytes
;
2025 case 2: return combine_word(bytes
);
2026 case 3: return combine_triple(bytes
);
2027 case 4: return combine_quad(bytes
);
2033 * parse descriptor buffer and return the pointer starting the given
2036 void *snd_usb_find_desc(void *descstart
, int desclen
, void *after
, u8 dtype
)
2048 if (p
[1] == dtype
&& (!after
|| (void *)p
> after
)) {
2057 * find a class-specified interface descriptor with the given subtype.
2059 void *snd_usb_find_csint_desc(void *buffer
, int buflen
, void *after
, u8 dsubtype
)
2061 unsigned char *p
= after
;
2063 while ((p
= snd_usb_find_desc(buffer
, buflen
, p
,
2064 USB_DT_CS_INTERFACE
)) != NULL
) {
2065 if (p
[0] >= 3 && p
[2] == dsubtype
)
2072 * Wrapper for usb_control_msg().
2073 * Allocates a temp buffer to prevent dmaing from/to the stack.
2075 int snd_usb_ctl_msg(struct usb_device
*dev
, unsigned int pipe
, __u8 request
,
2076 __u8 requesttype
, __u16 value
, __u16 index
, void *data
,
2077 __u16 size
, int timeout
)
2083 buf
= kmemdup(data
, size
, GFP_KERNEL
);
2087 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
2088 value
, index
, buf
, size
, timeout
);
2090 memcpy(data
, buf
, size
);
2098 * entry point for linux usb interface
2101 static int usb_audio_probe(struct usb_interface
*intf
,
2102 const struct usb_device_id
*id
);
2103 static void usb_audio_disconnect(struct usb_interface
*intf
);
2106 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
);
2107 static int usb_audio_resume(struct usb_interface
*intf
);
2109 #define usb_audio_suspend NULL
2110 #define usb_audio_resume NULL
2113 static struct usb_device_id usb_audio_ids
[] = {
2114 #include "usbquirks.h"
2115 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
2116 .bInterfaceClass
= USB_CLASS_AUDIO
,
2117 .bInterfaceSubClass
= USB_SUBCLASS_AUDIO_CONTROL
},
2118 { } /* Terminating entry */
2121 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
2123 static struct usb_driver usb_audio_driver
= {
2124 .name
= "snd-usb-audio",
2125 .probe
= usb_audio_probe
,
2126 .disconnect
= usb_audio_disconnect
,
2127 .suspend
= usb_audio_suspend
,
2128 .resume
= usb_audio_resume
,
2129 .id_table
= usb_audio_ids
,
2133 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2136 * proc interface for list the supported pcm formats
2138 static void proc_dump_substream_formats(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2140 struct list_head
*p
;
2141 static char *sync_types
[4] = {
2142 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2145 list_for_each(p
, &subs
->fmt_list
) {
2146 struct audioformat
*fp
;
2147 fp
= list_entry(p
, struct audioformat
, list
);
2148 snd_iprintf(buffer
, " Interface %d\n", fp
->iface
);
2149 snd_iprintf(buffer
, " Altset %d\n", fp
->altsetting
);
2150 snd_iprintf(buffer
, " Format: %#x (%d bits)\n",
2151 fp
->format
, snd_pcm_format_width(fp
->format
));
2152 snd_iprintf(buffer
, " Channels: %d\n", fp
->channels
);
2153 snd_iprintf(buffer
, " Endpoint: %d %s (%s)\n",
2154 fp
->endpoint
& USB_ENDPOINT_NUMBER_MASK
,
2155 fp
->endpoint
& USB_DIR_IN
? "IN" : "OUT",
2156 sync_types
[(fp
->ep_attr
& EP_ATTR_MASK
) >> 2]);
2157 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
2158 snd_iprintf(buffer
, " Rates: %d - %d (continuous)\n",
2159 fp
->rate_min
, fp
->rate_max
);
2162 snd_iprintf(buffer
, " Rates: ");
2163 for (i
= 0; i
< fp
->nr_rates
; i
++) {
2165 snd_iprintf(buffer
, ", ");
2166 snd_iprintf(buffer
, "%d", fp
->rate_table
[i
]);
2168 snd_iprintf(buffer
, "\n");
2170 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2171 // snd_iprintf(buffer, " EP Attribute = %#x\n", fp->attributes);
2175 static void proc_dump_substream_status(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2177 if (subs
->running
) {
2179 snd_iprintf(buffer
, " Status: Running\n");
2180 snd_iprintf(buffer
, " Interface = %d\n", subs
->interface
);
2181 snd_iprintf(buffer
, " Altset = %d\n", subs
->format
);
2182 snd_iprintf(buffer
, " URBs = %d [ ", subs
->nurbs
);
2183 for (i
= 0; i
< subs
->nurbs
; i
++)
2184 snd_iprintf(buffer
, "%d ", subs
->dataurb
[i
].packets
);
2185 snd_iprintf(buffer
, "]\n");
2186 snd_iprintf(buffer
, " Packet Size = %d\n", subs
->curpacksize
);
2187 snd_iprintf(buffer
, " Momentary freq = %u Hz (%#x.%04x)\n",
2188 snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
2189 ? get_full_speed_hz(subs
->freqm
)
2190 : get_high_speed_hz(subs
->freqm
),
2191 subs
->freqm
>> 16, subs
->freqm
& 0xffff);
2193 snd_iprintf(buffer
, " Status: Stop\n");
2197 static void proc_pcm_format_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
2199 struct snd_usb_stream
*stream
= entry
->private_data
;
2201 snd_iprintf(buffer
, "%s : %s\n", stream
->chip
->card
->longname
, stream
->pcm
->name
);
2203 if (stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
].num_formats
) {
2204 snd_iprintf(buffer
, "\nPlayback:\n");
2205 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2206 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2208 if (stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].num_formats
) {
2209 snd_iprintf(buffer
, "\nCapture:\n");
2210 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2211 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2215 static void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2217 struct snd_info_entry
*entry
;
2219 struct snd_card
*card
= stream
->chip
->card
;
2221 sprintf(name
, "stream%d", stream
->pcm_index
);
2222 if (!snd_card_proc_new(card
, name
, &entry
))
2223 snd_info_set_text_ops(entry
, stream
, proc_pcm_format_read
);
2228 static inline void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2235 * initialize the substream instance.
2238 static void init_substream(struct snd_usb_stream
*as
, int stream
, struct audioformat
*fp
)
2240 struct snd_usb_substream
*subs
= &as
->substream
[stream
];
2242 INIT_LIST_HEAD(&subs
->fmt_list
);
2243 spin_lock_init(&subs
->lock
);
2246 subs
->direction
= stream
;
2247 subs
->dev
= as
->chip
->dev
;
2248 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
) {
2249 subs
->ops
= audio_urb_ops
[stream
];
2251 subs
->ops
= audio_urb_ops_high_speed
[stream
];
2252 switch (as
->chip
->usb_id
) {
2253 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
2254 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
2255 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
2256 subs
->ops
.retire_sync
= retire_playback_sync_urb_hs_emu
;
2260 snd_pcm_set_ops(as
->pcm
, stream
,
2261 stream
== SNDRV_PCM_STREAM_PLAYBACK
?
2262 &snd_usb_playback_ops
: &snd_usb_capture_ops
);
2264 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2265 subs
->formats
|= 1ULL << fp
->format
;
2266 subs
->endpoint
= fp
->endpoint
;
2267 subs
->num_formats
++;
2268 subs
->fmt_type
= fp
->fmt_type
;
2275 static void free_substream(struct snd_usb_substream
*subs
)
2277 struct list_head
*p
, *n
;
2279 if (!subs
->num_formats
)
2280 return; /* not initialized */
2281 list_for_each_safe(p
, n
, &subs
->fmt_list
) {
2282 struct audioformat
*fp
= list_entry(p
, struct audioformat
, list
);
2283 kfree(fp
->rate_table
);
2286 kfree(subs
->rate_list
.list
);
2291 * free a usb stream instance
2293 static void snd_usb_audio_stream_free(struct snd_usb_stream
*stream
)
2295 free_substream(&stream
->substream
[0]);
2296 free_substream(&stream
->substream
[1]);
2297 list_del(&stream
->list
);
2301 static void snd_usb_audio_pcm_free(struct snd_pcm
*pcm
)
2303 struct snd_usb_stream
*stream
= pcm
->private_data
;
2306 snd_usb_audio_stream_free(stream
);
2312 * add this endpoint to the chip instance.
2313 * if a stream with the same endpoint already exists, append to it.
2314 * if not, create a new pcm stream.
2316 static int add_audio_endpoint(struct snd_usb_audio
*chip
, int stream
, struct audioformat
*fp
)
2318 struct list_head
*p
;
2319 struct snd_usb_stream
*as
;
2320 struct snd_usb_substream
*subs
;
2321 struct snd_pcm
*pcm
;
2324 list_for_each(p
, &chip
->pcm_list
) {
2325 as
= list_entry(p
, struct snd_usb_stream
, list
);
2326 if (as
->fmt_type
!= fp
->fmt_type
)
2328 subs
= &as
->substream
[stream
];
2329 if (!subs
->endpoint
)
2331 if (subs
->endpoint
== fp
->endpoint
) {
2332 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2333 subs
->num_formats
++;
2334 subs
->formats
|= 1ULL << fp
->format
;
2338 /* look for an empty stream */
2339 list_for_each(p
, &chip
->pcm_list
) {
2340 as
= list_entry(p
, struct snd_usb_stream
, list
);
2341 if (as
->fmt_type
!= fp
->fmt_type
)
2343 subs
= &as
->substream
[stream
];
2346 err
= snd_pcm_new_stream(as
->pcm
, stream
, 1);
2349 init_substream(as
, stream
, fp
);
2353 /* create a new pcm */
2354 as
= kzalloc(sizeof(*as
), GFP_KERNEL
);
2357 as
->pcm_index
= chip
->pcm_devs
;
2359 as
->fmt_type
= fp
->fmt_type
;
2360 err
= snd_pcm_new(chip
->card
, "USB Audio", chip
->pcm_devs
,
2361 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 1 : 0,
2362 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 0 : 1,
2369 pcm
->private_data
= as
;
2370 pcm
->private_free
= snd_usb_audio_pcm_free
;
2371 pcm
->info_flags
= 0;
2372 if (chip
->pcm_devs
> 0)
2373 sprintf(pcm
->name
, "USB Audio #%d", chip
->pcm_devs
);
2375 strcpy(pcm
->name
, "USB Audio");
2377 init_substream(as
, stream
, fp
);
2379 list_add(&as
->list
, &chip
->pcm_list
);
2382 proc_pcm_format_add(as
);
2389 * check if the device uses big-endian samples
2391 static int is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
2393 switch (chip
->usb_id
) {
2394 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2395 if (fp
->endpoint
& USB_DIR_IN
)
2398 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2399 if (device_setup
[chip
->index
] == 0x00 ||
2400 fp
->altsetting
==1 || fp
->altsetting
==2 || fp
->altsetting
==3)
2407 * parse the audio format type I descriptor
2408 * and returns the corresponding pcm format
2411 * @fp: audioformat record
2412 * @format: the format tag (wFormatTag)
2413 * @fmt: the format type descriptor
2415 static int parse_audio_format_i_type(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2416 int format
, unsigned char *fmt
)
2419 int sample_width
, sample_bytes
;
2421 /* FIXME: correct endianess and sign? */
2423 sample_width
= fmt
[6];
2424 sample_bytes
= fmt
[5];
2426 case 0: /* some devices don't define this correctly... */
2427 snd_printdd(KERN_INFO
"%d:%u:%d : format type 0 is detected, processed as PCM\n",
2428 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2430 case USB_AUDIO_FORMAT_PCM
:
2431 if (sample_width
> sample_bytes
* 8) {
2432 snd_printk(KERN_INFO
"%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2433 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
,
2434 sample_width
, sample_bytes
);
2436 /* check the format byte size */
2439 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2442 if (is_big_endian_format(chip
, fp
))
2443 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
; /* grrr, big endian!! */
2445 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2448 if (is_big_endian_format(chip
, fp
))
2449 pcm_format
= SNDRV_PCM_FORMAT_S24_3BE
; /* grrr, big endian!! */
2451 pcm_format
= SNDRV_PCM_FORMAT_S24_3LE
;
2454 pcm_format
= SNDRV_PCM_FORMAT_S32_LE
;
2457 snd_printk(KERN_INFO
"%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2458 chip
->dev
->devnum
, fp
->iface
,
2459 fp
->altsetting
, sample_width
, sample_bytes
);
2463 case USB_AUDIO_FORMAT_PCM8
:
2464 pcm_format
= SNDRV_PCM_FORMAT_U8
;
2466 /* Dallas DS4201 workaround: it advertises U8 format, but really
2468 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2469 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2471 case USB_AUDIO_FORMAT_IEEE_FLOAT
:
2472 pcm_format
= SNDRV_PCM_FORMAT_FLOAT_LE
;
2474 case USB_AUDIO_FORMAT_ALAW
:
2475 pcm_format
= SNDRV_PCM_FORMAT_A_LAW
;
2477 case USB_AUDIO_FORMAT_MU_LAW
:
2478 pcm_format
= SNDRV_PCM_FORMAT_MU_LAW
;
2481 snd_printk(KERN_INFO
"%d:%u:%d : unsupported format type %d\n",
2482 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2490 * parse the format descriptor and stores the possible sample rates
2491 * on the audioformat table.
2494 * @fp: audioformat record
2495 * @fmt: the format descriptor
2496 * @offset: the start offset of descriptor pointing the rate type
2497 * (7 for type I and II, 8 for type II)
2499 static int parse_audio_format_rates(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2500 unsigned char *fmt
, int offset
)
2502 int nr_rates
= fmt
[offset
];
2504 if (fmt
[0] < offset
+ 1 + 3 * (nr_rates
? nr_rates
: 2)) {
2505 snd_printk(KERN_ERR
"%d:%u:%d : invalid FORMAT_TYPE desc\n",
2506 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2512 * build the rate table and bitmap flags
2516 fp
->rate_table
= kmalloc(sizeof(int) * nr_rates
, GFP_KERNEL
);
2517 if (fp
->rate_table
== NULL
) {
2518 snd_printk(KERN_ERR
"cannot malloc\n");
2523 fp
->rate_min
= fp
->rate_max
= 0;
2524 for (r
= 0, idx
= offset
+ 1; r
< nr_rates
; r
++, idx
+= 3) {
2525 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 chip
->usb_id
== USB_ID(0x0d8c, 0x0102)) &&
2532 fp
->altsetting
== 5 && fp
->maxpacksize
== 392)
2534 fp
->rate_table
[fp
->nr_rates
] = rate
;
2535 if (!fp
->rate_min
|| rate
< fp
->rate_min
)
2536 fp
->rate_min
= rate
;
2537 if (!fp
->rate_max
|| rate
> fp
->rate_max
)
2538 fp
->rate_max
= rate
;
2539 fp
->rates
|= snd_pcm_rate_to_rate_bit(rate
);
2542 if (!fp
->nr_rates
) {
2543 hwc_debug("All rates were zero. Skipping format!\n");
2547 /* continuous rates */
2548 fp
->rates
= SNDRV_PCM_RATE_CONTINUOUS
;
2549 fp
->rate_min
= combine_triple(&fmt
[offset
+ 1]);
2550 fp
->rate_max
= combine_triple(&fmt
[offset
+ 4]);
2556 * parse the format type I and III descriptors
2558 static int parse_audio_format_i(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2559 int format
, unsigned char *fmt
)
2563 if (fmt
[3] == USB_FORMAT_TYPE_III
) {
2564 /* FIXME: the format type is really IECxxx
2565 * but we give normal PCM format to get the existing
2568 switch (chip
->usb_id
) {
2570 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2571 if (device_setup
[chip
->index
] == 0x00 &&
2572 fp
->altsetting
== 6)
2573 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
;
2575 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2578 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2581 pcm_format
= parse_audio_format_i_type(chip
, fp
, format
, fmt
);
2585 fp
->format
= pcm_format
;
2586 fp
->channels
= fmt
[4];
2587 if (fp
->channels
< 1) {
2588 snd_printk(KERN_ERR
"%d:%u:%d : invalid channels %d\n",
2589 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fp
->channels
);
2592 return parse_audio_format_rates(chip
, fp
, fmt
, 7);
2596 * prase the format type II descriptor
2598 static int parse_audio_format_ii(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2599 int format
, unsigned char *fmt
)
2601 int brate
, framesize
;
2603 case USB_AUDIO_FORMAT_AC3
:
2604 /* FIXME: there is no AC3 format defined yet */
2605 // fp->format = SNDRV_PCM_FORMAT_AC3;
2606 fp
->format
= SNDRV_PCM_FORMAT_U8
; /* temporarily hack to receive byte streams */
2608 case USB_AUDIO_FORMAT_MPEG
:
2609 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2612 snd_printd(KERN_INFO
"%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
2613 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2614 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2618 brate
= combine_word(&fmt
[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2619 framesize
= combine_word(&fmt
[6]); /* fmt[6,7]: wSamplesPerFrame */
2620 snd_printd(KERN_INFO
"found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
2621 fp
->frame_size
= framesize
;
2622 return parse_audio_format_rates(chip
, fp
, fmt
, 8); /* fmt[8..] sample rates */
2625 static int parse_audio_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2626 int format
, unsigned char *fmt
, int stream
)
2631 case USB_FORMAT_TYPE_I
:
2632 case USB_FORMAT_TYPE_III
:
2633 err
= parse_audio_format_i(chip
, fp
, format
, fmt
);
2635 case USB_FORMAT_TYPE_II
:
2636 err
= parse_audio_format_ii(chip
, fp
, format
, fmt
);
2639 snd_printd(KERN_INFO
"%d:%u:%d : format type %d is not supported yet\n",
2640 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fmt
[3]);
2643 fp
->fmt_type
= fmt
[3];
2647 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2648 /* extigy apparently supports sample rates other than 48k
2649 * but not in ordinary way. so we enable only 48k atm.
2651 if (chip
->usb_id
== USB_ID(0x041e, 0x3000) ||
2652 chip
->usb_id
== USB_ID(0x041e, 0x3020) ||
2653 chip
->usb_id
== USB_ID(0x041e, 0x3061)) {
2654 if (fmt
[3] == USB_FORMAT_TYPE_I
&&
2655 fp
->rates
!= SNDRV_PCM_RATE_48000
&&
2656 fp
->rates
!= SNDRV_PCM_RATE_96000
)
2663 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
2664 int iface
, int altno
);
2665 static int parse_audio_endpoints(struct snd_usb_audio
*chip
, int iface_no
)
2667 struct usb_device
*dev
;
2668 struct usb_interface
*iface
;
2669 struct usb_host_interface
*alts
;
2670 struct usb_interface_descriptor
*altsd
;
2671 int i
, altno
, err
, stream
;
2673 struct audioformat
*fp
;
2674 unsigned char *fmt
, *csep
;
2679 /* parse the interface's altsettings */
2680 iface
= usb_ifnum_to_if(dev
, iface_no
);
2682 num
= iface
->num_altsetting
;
2685 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
2686 * one misses syncpipe, and does not produce any sound.
2688 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2691 for (i
= 0; i
< num
; i
++) {
2692 alts
= &iface
->altsetting
[i
];
2693 altsd
= get_iface_desc(alts
);
2694 /* skip invalid one */
2695 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2696 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2697 (altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIO_STREAMING
&&
2698 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_VENDOR_SPEC
) ||
2699 altsd
->bNumEndpoints
< 1 ||
2700 le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
) == 0)
2702 /* must be isochronous */
2703 if ((get_endpoint(alts
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) !=
2704 USB_ENDPOINT_XFER_ISOC
)
2706 /* check direction */
2707 stream
= (get_endpoint(alts
, 0)->bEndpointAddress
& USB_DIR_IN
) ?
2708 SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2709 altno
= altsd
->bAlternateSetting
;
2711 /* audiophile usb: skip altsets incompatible with device_setup
2713 if (chip
->usb_id
== USB_ID(0x0763, 0x2003) &&
2714 audiophile_skip_setting_quirk(chip
, iface_no
, altno
))
2717 /* get audio formats */
2718 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, AS_GENERAL
);
2720 snd_printk(KERN_ERR
"%d:%u:%d : AS_GENERAL descriptor not found\n",
2721 dev
->devnum
, iface_no
, altno
);
2726 snd_printk(KERN_ERR
"%d:%u:%d : invalid AS_GENERAL desc\n",
2727 dev
->devnum
, iface_no
, altno
);
2731 format
= (fmt
[6] << 8) | fmt
[5]; /* remember the format value */
2733 /* get format type */
2734 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, FORMAT_TYPE
);
2736 snd_printk(KERN_ERR
"%d:%u:%d : no FORMAT_TYPE desc\n",
2737 dev
->devnum
, iface_no
, altno
);
2741 snd_printk(KERN_ERR
"%d:%u:%d : invalid FORMAT_TYPE desc\n",
2742 dev
->devnum
, iface_no
, altno
);
2746 csep
= snd_usb_find_desc(alts
->endpoint
[0].extra
, alts
->endpoint
[0].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2747 /* Creamware Noah has this descriptor after the 2nd endpoint */
2748 if (!csep
&& altsd
->bNumEndpoints
>= 2)
2749 csep
= snd_usb_find_desc(alts
->endpoint
[1].extra
, alts
->endpoint
[1].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2750 if (!csep
|| csep
[0] < 7 || csep
[2] != EP_GENERAL
) {
2751 snd_printk(KERN_WARNING
"%d:%u:%d : no or invalid"
2752 " class specific endpoint descriptor\n",
2753 dev
->devnum
, iface_no
, altno
);
2757 fp
= kzalloc(sizeof(*fp
), GFP_KERNEL
);
2759 snd_printk(KERN_ERR
"cannot malloc\n");
2763 fp
->iface
= iface_no
;
2764 fp
->altsetting
= altno
;
2766 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
2767 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
2768 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2769 if (snd_usb_get_speed(dev
) == USB_SPEED_HIGH
)
2770 fp
->maxpacksize
= (((fp
->maxpacksize
>> 11) & 3) + 1)
2771 * (fp
->maxpacksize
& 0x7ff);
2772 fp
->attributes
= csep
? csep
[3] : 0;
2774 /* some quirks for attributes here */
2776 switch (chip
->usb_id
) {
2777 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2778 /* Optoplay sets the sample rate attribute although
2779 * it seems not supporting it in fact.
2781 fp
->attributes
&= ~EP_CS_ATTR_SAMPLE_RATE
;
2783 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2784 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2785 /* doesn't set the sample rate attribute, but supports it */
2786 fp
->attributes
|= EP_CS_ATTR_SAMPLE_RATE
;
2788 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2789 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2790 an older model 77d:223) */
2792 * plantronics headset and Griffin iMic have set adaptive-in
2793 * although it's really not...
2795 fp
->ep_attr
&= ~EP_ATTR_MASK
;
2796 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
2797 fp
->ep_attr
|= EP_ATTR_ADAPTIVE
;
2799 fp
->ep_attr
|= EP_ATTR_SYNC
;
2803 /* ok, let's parse further... */
2804 if (parse_audio_format(chip
, fp
, format
, fmt
, stream
) < 0) {
2805 kfree(fp
->rate_table
);
2810 snd_printdd(KERN_INFO
"%d:%u:%d: add audio endpoint %#x\n", dev
->devnum
, iface_no
, altno
, fp
->endpoint
);
2811 err
= add_audio_endpoint(chip
, stream
, fp
);
2813 kfree(fp
->rate_table
);
2817 /* try to set the interface... */
2818 usb_set_interface(chip
->dev
, iface_no
, altno
);
2819 init_usb_pitch(chip
->dev
, iface_no
, alts
, fp
);
2820 init_usb_sample_rate(chip
->dev
, iface_no
, alts
, fp
, fp
->rate_max
);
2827 * disconnect streams
2828 * called from snd_usb_audio_disconnect()
2830 static void snd_usb_stream_disconnect(struct list_head
*head
)
2833 struct snd_usb_stream
*as
;
2834 struct snd_usb_substream
*subs
;
2836 as
= list_entry(head
, struct snd_usb_stream
, list
);
2837 for (idx
= 0; idx
< 2; idx
++) {
2838 subs
= &as
->substream
[idx
];
2839 if (!subs
->num_formats
)
2841 release_substream_urbs(subs
, 1);
2842 subs
->interface
= -1;
2847 * parse audio control descriptor and create pcm/midi streams
2849 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
2851 struct usb_device
*dev
= chip
->dev
;
2852 struct usb_host_interface
*host_iface
;
2853 struct usb_interface
*iface
;
2857 /* find audiocontrol interface */
2858 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
2859 if (!(p1
= snd_usb_find_csint_desc(host_iface
->extra
, host_iface
->extralen
, NULL
, HEADER
))) {
2860 snd_printk(KERN_ERR
"cannot find HEADER\n");
2863 if (! p1
[7] || p1
[0] < 8 + p1
[7]) {
2864 snd_printk(KERN_ERR
"invalid HEADER\n");
2869 * parse all USB audio streaming interfaces
2871 for (i
= 0; i
< p1
[7]; i
++) {
2872 struct usb_host_interface
*alts
;
2873 struct usb_interface_descriptor
*altsd
;
2875 iface
= usb_ifnum_to_if(dev
, j
);
2877 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
2878 dev
->devnum
, ctrlif
, j
);
2881 if (usb_interface_claimed(iface
)) {
2882 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n", dev
->devnum
, ctrlif
, j
);
2885 alts
= &iface
->altsetting
[0];
2886 altsd
= get_iface_desc(alts
);
2887 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
2888 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
2889 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDI_STREAMING
) {
2890 if (snd_usb_create_midi_interface(chip
, iface
, NULL
) < 0) {
2891 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n", dev
->devnum
, ctrlif
, j
);
2894 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
2897 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2898 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2899 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIO_STREAMING
) {
2900 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n", dev
->devnum
, ctrlif
, j
, altsd
->bInterfaceClass
);
2901 /* skip non-supported classes */
2904 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
2905 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
2908 if (! parse_audio_endpoints(chip
, j
)) {
2909 usb_set_interface(dev
, j
, 0); /* reset the current interface */
2910 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
2918 * create a stream for an endpoint/altsetting without proper descriptors
2920 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
2921 struct usb_interface
*iface
,
2922 const struct snd_usb_audio_quirk
*quirk
)
2924 struct audioformat
*fp
;
2925 struct usb_host_interface
*alts
;
2927 unsigned *rate_table
= NULL
;
2929 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
2931 snd_printk(KERN_ERR
"cannot memdup\n");
2934 if (fp
->nr_rates
> 0) {
2935 rate_table
= kmalloc(sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
2940 memcpy(rate_table
, fp
->rate_table
, sizeof(int) * fp
->nr_rates
);
2941 fp
->rate_table
= rate_table
;
2944 stream
= (fp
->endpoint
& USB_DIR_IN
)
2945 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2946 err
= add_audio_endpoint(chip
, stream
, fp
);
2952 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
2953 fp
->altset_idx
>= iface
->num_altsetting
) {
2958 alts
= &iface
->altsetting
[fp
->altset_idx
];
2959 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2960 usb_set_interface(chip
->dev
, fp
->iface
, 0);
2961 init_usb_pitch(chip
->dev
, fp
->iface
, alts
, fp
);
2962 init_usb_sample_rate(chip
->dev
, fp
->iface
, alts
, fp
, fp
->rate_max
);
2967 * create a stream for an interface with proper descriptors
2969 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
2970 struct usb_interface
*iface
,
2971 const struct snd_usb_audio_quirk
*quirk
)
2973 struct usb_host_interface
*alts
;
2974 struct usb_interface_descriptor
*altsd
;
2977 alts
= &iface
->altsetting
[0];
2978 altsd
= get_iface_desc(alts
);
2979 err
= parse_audio_endpoints(chip
, altsd
->bInterfaceNumber
);
2981 snd_printk(KERN_ERR
"cannot setup if %d: error %d\n",
2982 altsd
->bInterfaceNumber
, err
);
2985 /* reset the current interface */
2986 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
2991 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
2992 * The only way to detect the sample rate is by looking at wMaxPacketSize.
2994 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
2995 struct usb_interface
*iface
,
2996 const struct snd_usb_audio_quirk
*quirk
)
2998 static const struct audioformat ua_format
= {
2999 .format
= SNDRV_PCM_FORMAT_S24_3LE
,
3001 .fmt_type
= USB_FORMAT_TYPE_I
,
3004 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3006 struct usb_host_interface
*alts
;
3007 struct usb_interface_descriptor
*altsd
;
3008 struct audioformat
*fp
;
3011 /* both PCM and MIDI interfaces have 2 or more altsettings */
3012 if (iface
->num_altsetting
< 2)
3014 alts
= &iface
->altsetting
[1];
3015 altsd
= get_iface_desc(alts
);
3017 if (altsd
->bNumEndpoints
== 2) {
3018 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
3019 .out_cables
= 0x0003,
3022 static const struct snd_usb_audio_quirk ua700_quirk
= {
3023 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3026 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
3027 .out_cables
= 0x0001,
3030 static const struct snd_usb_audio_quirk uaxx_quirk
= {
3031 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3034 if (chip
->usb_id
== USB_ID(0x0582, 0x002b))
3035 return snd_usb_create_midi_interface(chip
, iface
,
3038 return snd_usb_create_midi_interface(chip
, iface
,
3042 if (altsd
->bNumEndpoints
!= 1)
3045 fp
= kmalloc(sizeof(*fp
), GFP_KERNEL
);
3048 memcpy(fp
, &ua_format
, sizeof(*fp
));
3050 fp
->iface
= altsd
->bInterfaceNumber
;
3051 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3052 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3053 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3055 switch (fp
->maxpacksize
) {
3057 fp
->rate_max
= fp
->rate_min
= 44100;
3061 fp
->rate_max
= fp
->rate_min
= 48000;
3065 fp
->rate_max
= fp
->rate_min
= 96000;
3068 snd_printk(KERN_ERR
"unknown sample rate\n");
3073 stream
= (fp
->endpoint
& USB_DIR_IN
)
3074 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3075 err
= add_audio_endpoint(chip
, stream
, fp
);
3080 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3085 * Create a stream for an Edirol UA-1000 interface.
3087 static int create_ua1000_quirk(struct snd_usb_audio
*chip
,
3088 struct usb_interface
*iface
,
3089 const struct snd_usb_audio_quirk
*quirk
)
3091 static const struct audioformat ua1000_format
= {
3092 .format
= SNDRV_PCM_FORMAT_S32_LE
,
3093 .fmt_type
= USB_FORMAT_TYPE_I
,
3097 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3099 struct usb_host_interface
*alts
;
3100 struct usb_interface_descriptor
*altsd
;
3101 struct audioformat
*fp
;
3104 if (iface
->num_altsetting
!= 2)
3106 alts
= &iface
->altsetting
[1];
3107 altsd
= get_iface_desc(alts
);
3108 if (alts
->extralen
!= 11 || alts
->extra
[1] != USB_DT_CS_INTERFACE
||
3109 altsd
->bNumEndpoints
!= 1)
3112 fp
= kmemdup(&ua1000_format
, sizeof(*fp
), GFP_KERNEL
);
3116 fp
->channels
= alts
->extra
[4];
3117 fp
->iface
= altsd
->bInterfaceNumber
;
3118 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3119 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3120 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3121 fp
->rate_max
= fp
->rate_min
= combine_triple(&alts
->extra
[8]);
3123 stream
= (fp
->endpoint
& USB_DIR_IN
)
3124 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3125 err
= add_audio_endpoint(chip
, stream
, fp
);
3130 /* FIXME: playback must be synchronized to capture */
3131 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3136 * Create a stream for an Edirol UA-101 interface.
3137 * Copy, paste and modify from Edirol UA-1000
3139 static int create_ua101_quirk(struct snd_usb_audio
*chip
,
3140 struct usb_interface
*iface
,
3141 const struct snd_usb_audio_quirk
*quirk
)
3143 static const struct audioformat ua101_format
= {
3144 .format
= SNDRV_PCM_FORMAT_S32_LE
,
3145 .fmt_type
= USB_FORMAT_TYPE_I
,
3149 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3151 struct usb_host_interface
*alts
;
3152 struct usb_interface_descriptor
*altsd
;
3153 struct audioformat
*fp
;
3156 if (iface
->num_altsetting
!= 2)
3158 alts
= &iface
->altsetting
[1];
3159 altsd
= get_iface_desc(alts
);
3160 if (alts
->extralen
!= 18 || alts
->extra
[1] != USB_DT_CS_INTERFACE
||
3161 altsd
->bNumEndpoints
!= 1)
3164 fp
= kmemdup(&ua101_format
, sizeof(*fp
), GFP_KERNEL
);
3168 fp
->channels
= alts
->extra
[11];
3169 fp
->iface
= altsd
->bInterfaceNumber
;
3170 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3171 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3172 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3173 fp
->rate_max
= fp
->rate_min
= combine_triple(&alts
->extra
[15]);
3175 stream
= (fp
->endpoint
& USB_DIR_IN
)
3176 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3177 err
= add_audio_endpoint(chip
, stream
, fp
);
3182 /* FIXME: playback must be synchronized to capture */
3183 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3187 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3188 struct usb_interface
*iface
,
3189 const struct snd_usb_audio_quirk
*quirk
);
3192 * handle the quirks for the contained interfaces
3194 static int create_composite_quirk(struct snd_usb_audio
*chip
,
3195 struct usb_interface
*iface
,
3196 const struct snd_usb_audio_quirk
*quirk
)
3198 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
3201 for (quirk
= quirk
->data
; quirk
->ifnum
>= 0; ++quirk
) {
3202 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
3205 if (quirk
->ifnum
!= probed_ifnum
&&
3206 usb_interface_claimed(iface
))
3208 err
= snd_usb_create_quirk(chip
, iface
, quirk
);
3211 if (quirk
->ifnum
!= probed_ifnum
)
3212 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
3217 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
3218 struct usb_interface
*iface
,
3219 const struct snd_usb_audio_quirk
*quirk
)
3229 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3230 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3232 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
3234 struct usb_host_config
*config
= dev
->actconfig
;
3237 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
3238 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
3239 snd_printdd("sending Extigy boot sequence...\n");
3240 /* Send message to force it to reconnect with full interface. */
3241 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
3242 0x10, 0x43, 0x0001, 0x000a, NULL
, 0, 1000);
3243 if (err
< 0) snd_printdd("error sending boot message: %d\n", err
);
3244 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
3245 &dev
->descriptor
, sizeof(dev
->descriptor
));
3246 config
= dev
->actconfig
;
3247 if (err
< 0) snd_printdd("error usb_get_descriptor: %d\n", err
);
3248 err
= usb_reset_configuration(dev
);
3249 if (err
< 0) snd_printdd("error usb_reset_configuration: %d\n", err
);
3250 snd_printdd("extigy_boot: new boot length = %d\n",
3251 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
3252 return -ENODEV
; /* quit this anyway */
3257 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
3261 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
3262 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3263 0, 0, &buf
, 1, 1000);
3265 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
3266 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3267 1, 2000, NULL
, 0, 1000);
3274 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3275 * documented in the device's data sheet.
3277 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
3281 buf
[1] = value
& 0xff;
3282 buf
[2] = (value
>> 8) & 0xff;
3284 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
3285 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
3286 0, 0, &buf
, 4, 1000);
3289 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
3292 * Enable line-out driver mode, set headphone source to front
3293 * channels, enable stereo mic.
3295 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
3302 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3303 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3304 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3305 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3306 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3307 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3308 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3309 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3310 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3311 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3313 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
3314 int iface
, int altno
)
3316 /* Reset ALL ifaces to 0 altsetting.
3317 * Call it for every possible altsetting of every interface.
3319 usb_set_interface(chip
->dev
, iface
, 0);
3321 if (device_setup
[chip
->index
] & AUDIOPHILE_SET
) {
3322 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_DTS
)
3324 return 1; /* skip this altsetting */
3325 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_96K
)
3327 return 1; /* skip this altsetting */
3328 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3329 AUDIOPHILE_SET_24B_48K_DI
&& altno
!= 2)
3330 return 1; /* skip this altsetting */
3331 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3332 AUDIOPHILE_SET_24B_48K_NOTDI
&& altno
!= 3)
3333 return 1; /* skip this altsetting */
3334 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3335 AUDIOPHILE_SET_16B_48K_DI
&& altno
!= 4)
3336 return 1; /* skip this altsetting */
3337 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3338 AUDIOPHILE_SET_16B_48K_NOTDI
&& altno
!= 5)
3339 return 1; /* skip this altsetting */
3341 return 0; /* keep this altsetting */
3345 * audio-interface quirks
3347 * returns zero if no standard audio/MIDI parsing is needed.
3348 * returns a postive value if standard audio/midi interfaces are parsed
3350 * returns a negative value at error.
3352 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3353 struct usb_interface
*iface
,
3354 const struct snd_usb_audio_quirk
*quirk
)
3356 typedef int (*quirk_func_t
)(struct snd_usb_audio
*, struct usb_interface
*,
3357 const struct snd_usb_audio_quirk
*);
3358 static const quirk_func_t quirk_funcs
[] = {
3359 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
3360 [QUIRK_COMPOSITE
] = create_composite_quirk
,
3361 [QUIRK_MIDI_STANDARD_INTERFACE
] = snd_usb_create_midi_interface
,
3362 [QUIRK_MIDI_FIXED_ENDPOINT
] = snd_usb_create_midi_interface
,
3363 [QUIRK_MIDI_YAMAHA
] = snd_usb_create_midi_interface
,
3364 [QUIRK_MIDI_MIDIMAN
] = snd_usb_create_midi_interface
,
3365 [QUIRK_MIDI_NOVATION
] = snd_usb_create_midi_interface
,
3366 [QUIRK_MIDI_RAW
] = snd_usb_create_midi_interface
,
3367 [QUIRK_MIDI_EMAGIC
] = snd_usb_create_midi_interface
,
3368 [QUIRK_MIDI_CME
] = snd_usb_create_midi_interface
,
3369 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
3370 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
3371 [QUIRK_AUDIO_EDIROL_UA1000
] = create_ua1000_quirk
,
3372 [QUIRK_AUDIO_EDIROL_UA101
] = create_ua101_quirk
,
3373 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
3376 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
3377 return quirk_funcs
[quirk
->type
](chip
, iface
, quirk
);
3379 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
3386 * common proc files to show the usb device info
3388 static void proc_audio_usbbus_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3390 struct snd_usb_audio
*chip
= entry
->private_data
;
3391 if (!chip
->shutdown
)
3392 snd_iprintf(buffer
, "%03d/%03d\n", chip
->dev
->bus
->busnum
, chip
->dev
->devnum
);
3395 static void proc_audio_usbid_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3397 struct snd_usb_audio
*chip
= entry
->private_data
;
3398 if (!chip
->shutdown
)
3399 snd_iprintf(buffer
, "%04x:%04x\n",
3400 USB_ID_VENDOR(chip
->usb_id
),
3401 USB_ID_PRODUCT(chip
->usb_id
));
3404 static void snd_usb_audio_create_proc(struct snd_usb_audio
*chip
)
3406 struct snd_info_entry
*entry
;
3407 if (!snd_card_proc_new(chip
->card
, "usbbus", &entry
))
3408 snd_info_set_text_ops(entry
, chip
, proc_audio_usbbus_read
);
3409 if (!snd_card_proc_new(chip
->card
, "usbid", &entry
))
3410 snd_info_set_text_ops(entry
, chip
, proc_audio_usbid_read
);
3414 * free the chip instance
3416 * here we have to do not much, since pcm and controls are already freed
3420 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
3426 static int snd_usb_audio_dev_free(struct snd_device
*device
)
3428 struct snd_usb_audio
*chip
= device
->device_data
;
3429 return snd_usb_audio_free(chip
);
3434 * create a chip instance and set its names.
3436 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
3437 const struct snd_usb_audio_quirk
*quirk
,
3438 struct snd_usb_audio
**rchip
)
3440 struct snd_card
*card
;
3441 struct snd_usb_audio
*chip
;
3444 static struct snd_device_ops ops
= {
3445 .dev_free
= snd_usb_audio_dev_free
,
3450 if (snd_usb_get_speed(dev
) != USB_SPEED_LOW
&&
3451 snd_usb_get_speed(dev
) != USB_SPEED_FULL
&&
3452 snd_usb_get_speed(dev
) != USB_SPEED_HIGH
) {
3453 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
3457 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
3459 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
3463 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
3465 snd_card_free(card
);
3472 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3473 le16_to_cpu(dev
->descriptor
.idProduct
));
3474 INIT_LIST_HEAD(&chip
->pcm_list
);
3475 INIT_LIST_HEAD(&chip
->midi_list
);
3476 INIT_LIST_HEAD(&chip
->mixer_list
);
3478 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
3479 snd_usb_audio_free(chip
);
3480 snd_card_free(card
);
3484 strcpy(card
->driver
, "USB-Audio");
3485 sprintf(component
, "USB%04x:%04x",
3486 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
3487 snd_component_add(card
, component
);
3489 /* retrieve the device string as shortname */
3490 if (quirk
&& quirk
->product_name
) {
3491 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
3493 if (!dev
->descriptor
.iProduct
||
3494 usb_string(dev
, dev
->descriptor
.iProduct
,
3495 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
3496 /* no name available from anywhere, so use ID */
3497 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
3498 USB_ID_VENDOR(chip
->usb_id
),
3499 USB_ID_PRODUCT(chip
->usb_id
));
3503 /* retrieve the vendor and device strings as longname */
3504 if (quirk
&& quirk
->vendor_name
) {
3505 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
3507 if (dev
->descriptor
.iManufacturer
)
3508 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
3509 card
->longname
, sizeof(card
->longname
));
3512 /* we don't really care if there isn't any vendor string */
3515 strlcat(card
->longname
, " ", sizeof(card
->longname
));
3517 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
3519 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
3521 if (len
< sizeof(card
->longname
))
3522 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
3524 strlcat(card
->longname
,
3525 snd_usb_get_speed(dev
) == USB_SPEED_LOW
? ", low speed" :
3526 snd_usb_get_speed(dev
) == USB_SPEED_FULL
? ", full speed" :
3528 sizeof(card
->longname
));
3530 snd_usb_audio_create_proc(chip
);
3538 * probe the active usb device
3540 * note that this can be called multiple times per a device, when it
3541 * includes multiple audio control interfaces.
3543 * thus we check the usb device pointer and creates the card instance
3544 * only at the first time. the successive calls of this function will
3545 * append the pcm interface to the corresponding card.
3547 static void *snd_usb_audio_probe(struct usb_device
*dev
,
3548 struct usb_interface
*intf
,
3549 const struct usb_device_id
*usb_id
)
3551 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
3553 struct snd_usb_audio
*chip
;
3554 struct usb_host_interface
*alts
;
3558 alts
= &intf
->altsetting
[0];
3559 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
3560 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3561 le16_to_cpu(dev
->descriptor
.idProduct
));
3563 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
3566 /* SB Extigy needs special boot-up sequence */
3567 /* if more models come, this will go to the quirk list. */
3568 if (id
== USB_ID(0x041e, 0x3000)) {
3569 if (snd_usb_extigy_boot_quirk(dev
, intf
) < 0)
3572 /* SB Audigy 2 NX needs its own boot-up magic, too */
3573 if (id
== USB_ID(0x041e, 0x3020)) {
3574 if (snd_usb_audigy2nx_boot_quirk(dev
) < 0)
3578 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3579 if (id
== USB_ID(0x10f5, 0x0200)) {
3580 if (snd_usb_cm106_boot_quirk(dev
) < 0)
3585 * found a config. now register to ALSA
3588 /* check whether it's already registered */
3590 mutex_lock(®ister_mutex
);
3591 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
3592 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
3593 if (usb_chip
[i
]->shutdown
) {
3594 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
3602 /* it's a fresh one.
3603 * now look for an empty slot and create a new card instance
3605 for (i
= 0; i
< SNDRV_CARDS
; i
++)
3606 if (enable
[i
] && ! usb_chip
[i
] &&
3607 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
3608 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
3609 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
3612 snd_card_set_dev(chip
->card
, &intf
->dev
);
3616 printk(KERN_ERR
"no available usb audio device\n");
3621 err
= 1; /* continue */
3622 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
3623 /* need some special handlings */
3624 if ((err
= snd_usb_create_quirk(chip
, intf
, quirk
)) < 0)
3629 /* create normal USB audio interfaces */
3630 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
3631 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
3636 /* we are allowed to call snd_card_register() many times */
3637 if (snd_card_register(chip
->card
) < 0) {
3641 usb_chip
[chip
->index
] = chip
;
3642 chip
->num_interfaces
++;
3643 mutex_unlock(®ister_mutex
);
3647 if (chip
&& !chip
->num_interfaces
)
3648 snd_card_free(chip
->card
);
3649 mutex_unlock(®ister_mutex
);
3655 * we need to take care of counter, since disconnection can be called also
3656 * many times as well as usb_audio_probe().
3658 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
3660 struct snd_usb_audio
*chip
;
3661 struct snd_card
*card
;
3662 struct list_head
*p
;
3664 if (ptr
== (void *)-1L)
3669 mutex_lock(®ister_mutex
);
3671 chip
->num_interfaces
--;
3672 if (chip
->num_interfaces
<= 0) {
3673 snd_card_disconnect(card
);
3674 /* release the pcm resources */
3675 list_for_each(p
, &chip
->pcm_list
) {
3676 snd_usb_stream_disconnect(p
);
3678 /* release the midi resources */
3679 list_for_each(p
, &chip
->midi_list
) {
3680 snd_usbmidi_disconnect(p
);
3682 /* release mixer resources */
3683 list_for_each(p
, &chip
->mixer_list
) {
3684 snd_usb_mixer_disconnect(p
);
3686 usb_chip
[chip
->index
] = NULL
;
3687 mutex_unlock(®ister_mutex
);
3688 snd_card_free_when_closed(card
);
3690 mutex_unlock(®ister_mutex
);
3695 * new 2.5 USB kernel API
3697 static int usb_audio_probe(struct usb_interface
*intf
,
3698 const struct usb_device_id
*id
)
3701 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
3703 usb_set_intfdata(intf
, chip
);
3709 static void usb_audio_disconnect(struct usb_interface
*intf
)
3711 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
3712 usb_get_intfdata(intf
));
3716 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
3718 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
3719 struct list_head
*p
;
3720 struct snd_usb_stream
*as
;
3722 if (chip
== (void *)-1L)
3725 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
3726 if (!chip
->num_suspended_intf
++) {
3727 list_for_each(p
, &chip
->pcm_list
) {
3728 as
= list_entry(p
, struct snd_usb_stream
, list
);
3729 snd_pcm_suspend_all(as
->pcm
);
3736 static int usb_audio_resume(struct usb_interface
*intf
)
3738 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
3740 if (chip
== (void *)-1L)
3742 if (--chip
->num_suspended_intf
)
3745 * ALSA leaves material resumption to user space
3749 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
3753 #endif /* CONFIG_PM */
3755 static int __init
snd_usb_audio_init(void)
3757 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
3758 printk(KERN_WARNING
"invalid nrpacks value.\n");
3761 return usb_register(&usb_audio_driver
);
3765 static void __exit
snd_usb_audio_cleanup(void)
3767 usb_deregister(&usb_audio_driver
);
3770 module_init(snd_usb_audio_init
);
3771 module_exit(snd_usb_audio_cleanup
);