2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * - async unlink should be used for avoiding the sleep inside lock.
31 * 2.4.22 usb-uhci seems buggy for async unlinking and results in
32 * oops. in such a cse, pass async_unlink=0 option.
33 * - the linked URBs would be preferred but not used so far because of
34 * the instability of unlinking.
35 * - type II is not supported properly. there is no device which supports
36 * this type *correctly*. SB extigy looks as if it supports, but it's
37 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
41 #include <linux/bitops.h>
42 #include <linux/init.h>
43 #include <linux/list.h>
44 #include <linux/slab.h>
45 #include <linux/string.h>
46 #include <linux/usb.h>
47 #include <linux/moduleparam.h>
48 #include <linux/mutex.h>
49 #include <sound/core.h>
50 #include <sound/info.h>
51 #include <sound/pcm.h>
52 #include <sound/pcm_params.h>
53 #include <sound/initval.h>
58 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
59 MODULE_DESCRIPTION("USB Audio");
60 MODULE_LICENSE("GPL");
61 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
64 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
65 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
66 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
67 /* Vendor/product IDs for this card */
68 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
69 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
70 static int nrpacks
= 8; /* max. number of packets per urb */
71 static int async_unlink
= 1;
72 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card*/
73 static int ignore_ctl_error
;
75 module_param_array(index
, int, NULL
, 0444);
76 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
77 module_param_array(id
, charp
, NULL
, 0444);
78 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
79 module_param_array(enable
, bool, NULL
, 0444);
80 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
81 module_param_array(vid
, int, NULL
, 0444);
82 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
83 module_param_array(pid
, int, NULL
, 0444);
84 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
85 module_param(nrpacks
, int, 0644);
86 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
87 module_param(async_unlink
, bool, 0444);
88 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
89 module_param_array(device_setup
, int, NULL
, 0444);
90 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
91 module_param(ignore_ctl_error
, bool, 0444);
92 MODULE_PARM_DESC(ignore_ctl_error
,
93 "Ignore errors from USB controller for mixer interfaces.");
96 * debug the h/w constraints
98 /* #define HW_CONST_DEBUG */
106 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
108 #define SYNC_URBS 4 /* always four urbs for sync */
109 #define MAX_QUEUE 24 /* try not to exceed this queue length, in ms */
112 struct list_head list
;
113 snd_pcm_format_t format
; /* format type */
114 unsigned int channels
; /* # channels */
115 unsigned int fmt_type
; /* USB audio format type (1-3) */
116 unsigned int frame_size
; /* samples per frame for non-audio */
117 int iface
; /* interface number */
118 unsigned char altsetting
; /* corresponding alternate setting */
119 unsigned char altset_idx
; /* array index of altenate setting */
120 unsigned char attributes
; /* corresponding attributes of cs endpoint */
121 unsigned char endpoint
; /* endpoint */
122 unsigned char ep_attr
; /* endpoint attributes */
123 unsigned char datainterval
; /* log_2 of data packet interval */
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 txfr_quirk
:1; /* allow sub-frame alignment */
173 unsigned int fmt_type
; /* USB audio format type (1-3) */
175 unsigned int running
: 1; /* running status */
177 unsigned int hwptr_done
; /* processed byte 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
, frames
, bytes
, 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 bytes
= urb
->iso_frame_desc
[i
].actual_length
;
358 frames
= bytes
/ stride
;
359 if (!subs
->txfr_quirk
)
360 bytes
= frames
* stride
;
361 if (bytes
% (runtime
->sample_bits
>> 3) != 0) {
362 #ifdef CONFIG_SND_DEBUG_VERBOSE
363 int oldbytes
= bytes
;
365 bytes
= frames
* stride
;
366 snd_printdd(KERN_ERR
"Corrected urb data len. %d->%d\n",
369 /* update the current pointer */
370 spin_lock_irqsave(&subs
->lock
, flags
);
371 oldptr
= subs
->hwptr_done
;
372 subs
->hwptr_done
+= bytes
;
373 if (subs
->hwptr_done
>= runtime
->buffer_size
* stride
)
374 subs
->hwptr_done
-= runtime
->buffer_size
* stride
;
375 frames
= (bytes
+ (oldptr
% stride
)) / stride
;
376 subs
->transfer_done
+= frames
;
377 if (subs
->transfer_done
>= runtime
->period_size
) {
378 subs
->transfer_done
-= runtime
->period_size
;
381 spin_unlock_irqrestore(&subs
->lock
, flags
);
382 /* copy a data chunk */
383 if (oldptr
+ bytes
> runtime
->buffer_size
* stride
) {
384 unsigned int bytes1
=
385 runtime
->buffer_size
* stride
- oldptr
;
386 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes1
);
387 memcpy(runtime
->dma_area
, cp
+ bytes1
, bytes
- bytes1
);
389 memcpy(runtime
->dma_area
+ oldptr
, cp
, bytes
);
393 snd_pcm_period_elapsed(subs
->pcm_substream
);
398 * Process after capture complete when paused. Nothing to do.
400 static int retire_paused_capture_urb(struct snd_usb_substream
*subs
,
401 struct snd_pcm_runtime
*runtime
,
409 * prepare urb for full speed playback sync pipe
411 * set up the offset and length to receive the current frequency.
414 static int prepare_playback_sync_urb(struct snd_usb_substream
*subs
,
415 struct snd_pcm_runtime
*runtime
,
418 struct snd_urb_ctx
*ctx
= urb
->context
;
420 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
421 urb
->iso_frame_desc
[0].length
= 3;
422 urb
->iso_frame_desc
[0].offset
= 0;
427 * prepare urb for high speed playback sync pipe
429 * set up the offset and length to receive the current frequency.
432 static int prepare_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
433 struct snd_pcm_runtime
*runtime
,
436 struct snd_urb_ctx
*ctx
= urb
->context
;
438 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
439 urb
->iso_frame_desc
[0].length
= 4;
440 urb
->iso_frame_desc
[0].offset
= 0;
445 * process after full speed playback sync complete
447 * retrieve the current 10.14 frequency from pipe, and set it.
448 * the value is referred in prepare_playback_urb().
450 static int retire_playback_sync_urb(struct snd_usb_substream
*subs
,
451 struct snd_pcm_runtime
*runtime
,
457 if (urb
->iso_frame_desc
[0].status
== 0 &&
458 urb
->iso_frame_desc
[0].actual_length
== 3) {
459 f
= combine_triple((u8
*)urb
->transfer_buffer
) << 2;
460 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
461 spin_lock_irqsave(&subs
->lock
, flags
);
463 spin_unlock_irqrestore(&subs
->lock
, flags
);
471 * process after high speed playback sync complete
473 * retrieve the current 12.13 frequency from pipe, and set it.
474 * the value is referred in prepare_playback_urb().
476 static int retire_playback_sync_urb_hs(struct snd_usb_substream
*subs
,
477 struct snd_pcm_runtime
*runtime
,
483 if (urb
->iso_frame_desc
[0].status
== 0 &&
484 urb
->iso_frame_desc
[0].actual_length
== 4) {
485 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
486 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
487 spin_lock_irqsave(&subs
->lock
, flags
);
489 spin_unlock_irqrestore(&subs
->lock
, flags
);
497 * process after E-Mu 0202/0404/Tracker Pre high speed playback sync complete
499 * These devices return the number of samples per packet instead of the number
500 * of samples per microframe.
502 static int retire_playback_sync_urb_hs_emu(struct snd_usb_substream
*subs
,
503 struct snd_pcm_runtime
*runtime
,
509 if (urb
->iso_frame_desc
[0].status
== 0 &&
510 urb
->iso_frame_desc
[0].actual_length
== 4) {
511 f
= combine_quad((u8
*)urb
->transfer_buffer
) & 0x0fffffff;
512 f
>>= subs
->datainterval
;
513 if (f
>= subs
->freqn
- subs
->freqn
/ 8 && f
<= subs
->freqmax
) {
514 spin_lock_irqsave(&subs
->lock
, flags
);
516 spin_unlock_irqrestore(&subs
->lock
, flags
);
523 /* determine the number of frames in the next packet */
524 static int snd_usb_audio_next_packet_size(struct snd_usb_substream
*subs
)
527 return subs
->maxframesize
;
529 subs
->phase
= (subs
->phase
& 0xffff)
530 + (subs
->freqm
<< subs
->datainterval
);
531 return min(subs
->phase
>> 16, subs
->maxframesize
);
536 * Prepare urb for streaming before playback starts or when paused.
538 * We don't have any data, so we send silence.
540 static int prepare_nodata_playback_urb(struct snd_usb_substream
*subs
,
541 struct snd_pcm_runtime
*runtime
,
544 unsigned int i
, offs
, counts
;
545 struct snd_urb_ctx
*ctx
= urb
->context
;
546 int stride
= runtime
->frame_bits
>> 3;
549 urb
->dev
= ctx
->subs
->dev
;
550 for (i
= 0; i
< ctx
->packets
; ++i
) {
551 counts
= snd_usb_audio_next_packet_size(subs
);
552 urb
->iso_frame_desc
[i
].offset
= offs
* stride
;
553 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
556 urb
->number_of_packets
= ctx
->packets
;
557 urb
->transfer_buffer_length
= offs
* stride
;
558 memset(urb
->transfer_buffer
,
559 subs
->cur_audiofmt
->format
== SNDRV_PCM_FORMAT_U8
? 0x80 : 0,
565 * prepare urb for playback data pipe
567 * Since a URB can handle only a single linear buffer, we must use double
568 * buffering when the data to be transferred overflows the buffer boundary.
569 * To avoid inconsistencies when updating hwptr_done, we use double buffering
572 static int prepare_playback_urb(struct snd_usb_substream
*subs
,
573 struct snd_pcm_runtime
*runtime
,
577 unsigned int counts
, frames
, bytes
;
579 int period_elapsed
= 0;
580 struct snd_urb_ctx
*ctx
= urb
->context
;
582 stride
= runtime
->frame_bits
>> 3;
585 urb
->dev
= ctx
->subs
->dev
; /* we need to set this at each time */
586 urb
->number_of_packets
= 0;
587 spin_lock_irqsave(&subs
->lock
, flags
);
588 for (i
= 0; i
< ctx
->packets
; i
++) {
589 counts
= snd_usb_audio_next_packet_size(subs
);
590 /* set up descriptor */
591 urb
->iso_frame_desc
[i
].offset
= frames
* stride
;
592 urb
->iso_frame_desc
[i
].length
= counts
* stride
;
594 urb
->number_of_packets
++;
595 subs
->transfer_done
+= counts
;
596 if (subs
->transfer_done
>= runtime
->period_size
) {
597 subs
->transfer_done
-= runtime
->period_size
;
599 if (subs
->fmt_type
== USB_FORMAT_TYPE_II
) {
600 if (subs
->transfer_done
> 0) {
601 /* FIXME: fill-max mode is not
603 frames
-= subs
->transfer_done
;
604 counts
-= subs
->transfer_done
;
605 urb
->iso_frame_desc
[i
].length
=
607 subs
->transfer_done
= 0;
610 if (i
< ctx
->packets
) {
611 /* add a transfer delimiter */
612 urb
->iso_frame_desc
[i
].offset
=
614 urb
->iso_frame_desc
[i
].length
= 0;
615 urb
->number_of_packets
++;
620 if (period_elapsed
) /* finish at the period boundary */
623 bytes
= frames
* stride
;
624 if (subs
->hwptr_done
+ bytes
> runtime
->buffer_size
* stride
) {
625 /* err, the transferred area goes over buffer boundary. */
626 unsigned int bytes1
=
627 runtime
->buffer_size
* stride
- subs
->hwptr_done
;
628 memcpy(urb
->transfer_buffer
,
629 runtime
->dma_area
+ subs
->hwptr_done
, bytes1
);
630 memcpy(urb
->transfer_buffer
+ bytes1
,
631 runtime
->dma_area
, bytes
- bytes1
);
633 memcpy(urb
->transfer_buffer
,
634 runtime
->dma_area
+ subs
->hwptr_done
, bytes
);
636 subs
->hwptr_done
+= bytes
;
637 if (subs
->hwptr_done
>= runtime
->buffer_size
* stride
)
638 subs
->hwptr_done
-= runtime
->buffer_size
* stride
;
639 runtime
->delay
+= frames
;
640 spin_unlock_irqrestore(&subs
->lock
, flags
);
641 urb
->transfer_buffer_length
= bytes
;
643 snd_pcm_period_elapsed(subs
->pcm_substream
);
648 * process after playback data complete
649 * - decrease the delay count again
651 static int retire_playback_urb(struct snd_usb_substream
*subs
,
652 struct snd_pcm_runtime
*runtime
,
656 int stride
= runtime
->frame_bits
>> 3;
657 int processed
= urb
->transfer_buffer_length
/ stride
;
659 spin_lock_irqsave(&subs
->lock
, flags
);
660 if (processed
> runtime
->delay
)
663 runtime
->delay
-= processed
;
664 spin_unlock_irqrestore(&subs
->lock
, flags
);
671 static struct snd_urb_ops audio_urb_ops
[2] = {
673 .prepare
= prepare_nodata_playback_urb
,
674 .retire
= retire_playback_urb
,
675 .prepare_sync
= prepare_playback_sync_urb
,
676 .retire_sync
= retire_playback_sync_urb
,
679 .prepare
= prepare_capture_urb
,
680 .retire
= retire_capture_urb
,
681 .prepare_sync
= prepare_capture_sync_urb
,
682 .retire_sync
= retire_capture_sync_urb
,
686 static struct snd_urb_ops audio_urb_ops_high_speed
[2] = {
688 .prepare
= prepare_nodata_playback_urb
,
689 .retire
= retire_playback_urb
,
690 .prepare_sync
= prepare_playback_sync_urb_hs
,
691 .retire_sync
= retire_playback_sync_urb_hs
,
694 .prepare
= prepare_capture_urb
,
695 .retire
= retire_capture_urb
,
696 .prepare_sync
= prepare_capture_sync_urb_hs
,
697 .retire_sync
= retire_capture_sync_urb
,
702 * complete callback from data urb
704 static void snd_complete_urb(struct urb
*urb
)
706 struct snd_urb_ctx
*ctx
= urb
->context
;
707 struct snd_usb_substream
*subs
= ctx
->subs
;
708 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
711 if ((subs
->running
&& subs
->ops
.retire(subs
, substream
->runtime
, urb
)) ||
712 !subs
->running
|| /* can be stopped during retire callback */
713 (err
= subs
->ops
.prepare(subs
, substream
->runtime
, urb
)) < 0 ||
714 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
715 clear_bit(ctx
->index
, &subs
->active_mask
);
717 snd_printd(KERN_ERR
"cannot submit urb (err = %d)\n", err
);
718 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
725 * complete callback from sync urb
727 static void snd_complete_sync_urb(struct urb
*urb
)
729 struct snd_urb_ctx
*ctx
= urb
->context
;
730 struct snd_usb_substream
*subs
= ctx
->subs
;
731 struct snd_pcm_substream
*substream
= ctx
->subs
->pcm_substream
;
734 if ((subs
->running
&& subs
->ops
.retire_sync(subs
, substream
->runtime
, urb
)) ||
735 !subs
->running
|| /* can be stopped during retire callback */
736 (err
= subs
->ops
.prepare_sync(subs
, substream
->runtime
, urb
)) < 0 ||
737 (err
= usb_submit_urb(urb
, GFP_ATOMIC
)) < 0) {
738 clear_bit(ctx
->index
+ 16, &subs
->active_mask
);
740 snd_printd(KERN_ERR
"cannot submit sync urb (err = %d)\n", err
);
741 snd_pcm_stop(substream
, SNDRV_PCM_STATE_XRUN
);
748 * unlink active urbs.
750 static int deactivate_urbs(struct snd_usb_substream
*subs
, int force
, int can_sleep
)
757 if (!force
&& subs
->stream
->chip
->shutdown
) /* to be sure... */
760 async
= !can_sleep
&& async_unlink
;
762 if (!async
&& in_interrupt())
765 for (i
= 0; i
< subs
->nurbs
; i
++) {
766 if (test_bit(i
, &subs
->active_mask
)) {
767 if (!test_and_set_bit(i
, &subs
->unlink_mask
)) {
768 struct urb
*u
= subs
->dataurb
[i
].urb
;
776 if (subs
->syncpipe
) {
777 for (i
= 0; i
< SYNC_URBS
; i
++) {
778 if (test_bit(i
+16, &subs
->active_mask
)) {
779 if (!test_and_set_bit(i
+16, &subs
->unlink_mask
)) {
780 struct urb
*u
= subs
->syncurb
[i
].urb
;
793 static const char *usb_error_string(int err
)
799 return "endpoint not enabled";
801 return "endpoint stalled";
803 return "not enough bandwidth";
805 return "device disabled";
807 return "device suspended";
812 return "internal error";
814 return "unknown error";
819 * set up and start data/sync urbs
821 static int start_urbs(struct snd_usb_substream
*subs
, struct snd_pcm_runtime
*runtime
)
826 if (subs
->stream
->chip
->shutdown
)
829 for (i
= 0; i
< subs
->nurbs
; i
++) {
830 if (snd_BUG_ON(!subs
->dataurb
[i
].urb
))
832 if (subs
->ops
.prepare(subs
, runtime
, subs
->dataurb
[i
].urb
) < 0) {
833 snd_printk(KERN_ERR
"cannot prepare datapipe for urb %d\n", i
);
837 if (subs
->syncpipe
) {
838 for (i
= 0; i
< SYNC_URBS
; i
++) {
839 if (snd_BUG_ON(!subs
->syncurb
[i
].urb
))
841 if (subs
->ops
.prepare_sync(subs
, runtime
, subs
->syncurb
[i
].urb
) < 0) {
842 snd_printk(KERN_ERR
"cannot prepare syncpipe for urb %d\n", i
);
848 subs
->active_mask
= 0;
849 subs
->unlink_mask
= 0;
851 for (i
= 0; i
< subs
->nurbs
; i
++) {
852 err
= usb_submit_urb(subs
->dataurb
[i
].urb
, GFP_ATOMIC
);
854 snd_printk(KERN_ERR
"cannot submit datapipe "
855 "for urb %d, error %d: %s\n",
856 i
, err
, usb_error_string(err
));
859 set_bit(i
, &subs
->active_mask
);
861 if (subs
->syncpipe
) {
862 for (i
= 0; i
< SYNC_URBS
; i
++) {
863 err
= usb_submit_urb(subs
->syncurb
[i
].urb
, GFP_ATOMIC
);
865 snd_printk(KERN_ERR
"cannot submit syncpipe "
866 "for urb %d, error %d: %s\n",
867 i
, err
, usb_error_string(err
));
870 set_bit(i
+ 16, &subs
->active_mask
);
876 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
877 deactivate_urbs(subs
, 0, 0);
883 * wait until all urbs are processed.
885 static int wait_clear_urbs(struct snd_usb_substream
*subs
)
887 unsigned long end_time
= jiffies
+ msecs_to_jiffies(1000);
893 for (i
= 0; i
< subs
->nurbs
; i
++) {
894 if (test_bit(i
, &subs
->active_mask
))
897 if (subs
->syncpipe
) {
898 for (i
= 0; i
< SYNC_URBS
; i
++) {
899 if (test_bit(i
+ 16, &subs
->active_mask
))
905 schedule_timeout_uninterruptible(1);
906 } while (time_before(jiffies
, end_time
));
908 snd_printk(KERN_ERR
"timeout: still %d active urbs..\n", alive
);
914 * return the current pcm pointer. just based on the hwptr_done value.
916 static snd_pcm_uframes_t
snd_usb_pcm_pointer(struct snd_pcm_substream
*substream
)
918 struct snd_usb_substream
*subs
;
919 unsigned int hwptr_done
;
921 subs
= (struct snd_usb_substream
*)substream
->runtime
->private_data
;
922 spin_lock(&subs
->lock
);
923 hwptr_done
= subs
->hwptr_done
;
924 spin_unlock(&subs
->lock
);
925 return hwptr_done
/ (substream
->runtime
->frame_bits
>> 3);
930 * start/stop playback substream
932 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream
*substream
,
935 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
938 case SNDRV_PCM_TRIGGER_START
:
939 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
940 subs
->ops
.prepare
= prepare_playback_urb
;
942 case SNDRV_PCM_TRIGGER_STOP
:
943 return deactivate_urbs(subs
, 0, 0);
944 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
945 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
953 * start/stop capture substream
955 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream
*substream
,
958 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
961 case SNDRV_PCM_TRIGGER_START
:
962 subs
->ops
.retire
= retire_capture_urb
;
963 return start_urbs(subs
, substream
->runtime
);
964 case SNDRV_PCM_TRIGGER_STOP
:
965 return deactivate_urbs(subs
, 0, 0);
966 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
967 subs
->ops
.retire
= retire_paused_capture_urb
;
969 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
970 subs
->ops
.retire
= retire_capture_urb
;
981 static void release_urb_ctx(struct snd_urb_ctx
*u
)
985 usb_buffer_free(u
->subs
->dev
, u
->buffer_size
,
986 u
->urb
->transfer_buffer
,
987 u
->urb
->transfer_dma
);
988 usb_free_urb(u
->urb
);
994 * release a substream
996 static void release_substream_urbs(struct snd_usb_substream
*subs
, int force
)
1000 /* stop urbs (to be sure) */
1001 deactivate_urbs(subs
, force
, 1);
1002 wait_clear_urbs(subs
);
1004 for (i
= 0; i
< MAX_URBS
; i
++)
1005 release_urb_ctx(&subs
->dataurb
[i
]);
1006 for (i
= 0; i
< SYNC_URBS
; i
++)
1007 release_urb_ctx(&subs
->syncurb
[i
]);
1008 usb_buffer_free(subs
->dev
, SYNC_URBS
* 4,
1009 subs
->syncbuf
, subs
->sync_dma
);
1010 subs
->syncbuf
= NULL
;
1015 * initialize a substream for plaback/capture
1017 static int init_substream_urbs(struct snd_usb_substream
*subs
, unsigned int period_bytes
,
1018 unsigned int rate
, unsigned int frame_bits
)
1020 unsigned int maxsize
, i
;
1021 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1022 unsigned int urb_packs
, total_packs
, packs_per_ms
;
1024 /* calculate the frequency in 16.16 format */
1025 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1026 subs
->freqn
= get_usb_full_speed_rate(rate
);
1028 subs
->freqn
= get_usb_high_speed_rate(rate
);
1029 subs
->freqm
= subs
->freqn
;
1030 /* calculate max. frequency */
1031 if (subs
->maxpacksize
) {
1032 /* whatever fits into a max. size packet */
1033 maxsize
= subs
->maxpacksize
;
1034 subs
->freqmax
= (maxsize
/ (frame_bits
>> 3))
1035 << (16 - subs
->datainterval
);
1037 /* no max. packet size: just take 25% higher than nominal */
1038 subs
->freqmax
= subs
->freqn
+ (subs
->freqn
>> 2);
1039 maxsize
= ((subs
->freqmax
+ 0xffff) * (frame_bits
>> 3))
1040 >> (16 - subs
->datainterval
);
1045 subs
->curpacksize
= subs
->maxpacksize
;
1047 subs
->curpacksize
= maxsize
;
1049 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
)
1050 packs_per_ms
= 8 >> subs
->datainterval
;
1055 urb_packs
= max(nrpacks
, 1);
1056 urb_packs
= min(urb_packs
, (unsigned int)MAX_PACKS
);
1059 urb_packs
*= packs_per_ms
;
1061 urb_packs
= min(urb_packs
, 1U << subs
->syncinterval
);
1063 /* decide how many packets to be used */
1065 unsigned int minsize
, maxpacks
;
1066 /* determine how small a packet can be */
1067 minsize
= (subs
->freqn
>> (16 - subs
->datainterval
))
1068 * (frame_bits
>> 3);
1069 /* with sync from device, assume it can be 12% lower */
1071 minsize
-= minsize
>> 3;
1072 minsize
= max(minsize
, 1u);
1073 total_packs
= (period_bytes
+ minsize
- 1) / minsize
;
1074 /* we need at least two URBs for queueing */
1075 if (total_packs
< 2) {
1078 /* and we don't want too long a queue either */
1079 maxpacks
= max(MAX_QUEUE
* packs_per_ms
, urb_packs
* 2);
1080 total_packs
= min(total_packs
, maxpacks
);
1083 while (urb_packs
> 1 && urb_packs
* maxsize
>= period_bytes
)
1085 total_packs
= MAX_URBS
* urb_packs
;
1087 subs
->nurbs
= (total_packs
+ urb_packs
- 1) / urb_packs
;
1088 if (subs
->nurbs
> MAX_URBS
) {
1090 subs
->nurbs
= MAX_URBS
;
1091 total_packs
= MAX_URBS
* urb_packs
;
1092 } else if (subs
->nurbs
< 2) {
1093 /* too little - we need at least two packets
1094 * to ensure contiguous playback/capture
1099 /* allocate and initialize data urbs */
1100 for (i
= 0; i
< subs
->nurbs
; i
++) {
1101 struct snd_urb_ctx
*u
= &subs
->dataurb
[i
];
1104 u
->packets
= (i
+ 1) * total_packs
/ subs
->nurbs
1105 - i
* total_packs
/ subs
->nurbs
;
1106 u
->buffer_size
= maxsize
* u
->packets
;
1107 if (subs
->fmt_type
== USB_FORMAT_TYPE_II
)
1108 u
->packets
++; /* for transfer delimiter */
1109 u
->urb
= usb_alloc_urb(u
->packets
, GFP_KERNEL
);
1112 u
->urb
->transfer_buffer
=
1113 usb_buffer_alloc(subs
->dev
, u
->buffer_size
, GFP_KERNEL
,
1114 &u
->urb
->transfer_dma
);
1115 if (!u
->urb
->transfer_buffer
)
1117 u
->urb
->pipe
= subs
->datapipe
;
1118 u
->urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1119 u
->urb
->interval
= 1 << subs
->datainterval
;
1120 u
->urb
->context
= u
;
1121 u
->urb
->complete
= snd_complete_urb
;
1124 if (subs
->syncpipe
) {
1125 /* allocate and initialize sync urbs */
1126 subs
->syncbuf
= usb_buffer_alloc(subs
->dev
, SYNC_URBS
* 4,
1127 GFP_KERNEL
, &subs
->sync_dma
);
1130 for (i
= 0; i
< SYNC_URBS
; i
++) {
1131 struct snd_urb_ctx
*u
= &subs
->syncurb
[i
];
1135 u
->urb
= usb_alloc_urb(1, GFP_KERNEL
);
1138 u
->urb
->transfer_buffer
= subs
->syncbuf
+ i
* 4;
1139 u
->urb
->transfer_dma
= subs
->sync_dma
+ i
* 4;
1140 u
->urb
->transfer_buffer_length
= 4;
1141 u
->urb
->pipe
= subs
->syncpipe
;
1142 u
->urb
->transfer_flags
= URB_ISO_ASAP
|
1143 URB_NO_TRANSFER_DMA_MAP
;
1144 u
->urb
->number_of_packets
= 1;
1145 u
->urb
->interval
= 1 << subs
->syncinterval
;
1146 u
->urb
->context
= u
;
1147 u
->urb
->complete
= snd_complete_sync_urb
;
1153 release_substream_urbs(subs
, 0);
1159 * find a matching audio format
1161 static struct audioformat
*find_format(struct snd_usb_substream
*subs
, unsigned int format
,
1162 unsigned int rate
, unsigned int channels
)
1164 struct list_head
*p
;
1165 struct audioformat
*found
= NULL
;
1166 int cur_attr
= 0, attr
;
1168 list_for_each(p
, &subs
->fmt_list
) {
1169 struct audioformat
*fp
;
1170 fp
= list_entry(p
, struct audioformat
, list
);
1171 if (fp
->format
!= format
|| fp
->channels
!= channels
)
1173 if (rate
< fp
->rate_min
|| rate
> fp
->rate_max
)
1175 if (! (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)) {
1177 for (i
= 0; i
< fp
->nr_rates
; i
++)
1178 if (fp
->rate_table
[i
] == rate
)
1180 if (i
>= fp
->nr_rates
)
1183 attr
= fp
->ep_attr
& EP_ATTR_MASK
;
1189 /* avoid async out and adaptive in if the other method
1190 * supports the same format.
1191 * this is a workaround for the case like
1192 * M-audio audiophile USB.
1194 if (attr
!= cur_attr
) {
1195 if ((attr
== EP_ATTR_ASYNC
&&
1196 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1197 (attr
== EP_ATTR_ADAPTIVE
&&
1198 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
))
1200 if ((cur_attr
== EP_ATTR_ASYNC
&&
1201 subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) ||
1202 (cur_attr
== EP_ATTR_ADAPTIVE
&&
1203 subs
->direction
== SNDRV_PCM_STREAM_CAPTURE
)) {
1209 /* find the format with the largest max. packet size */
1210 if (fp
->maxpacksize
> found
->maxpacksize
) {
1220 * initialize the picth control and sample rate
1222 static int init_usb_pitch(struct usb_device
*dev
, int iface
,
1223 struct usb_host_interface
*alts
,
1224 struct audioformat
*fmt
)
1227 unsigned char data
[1];
1230 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1231 /* if endpoint has pitch control, enable it */
1232 if (fmt
->attributes
& EP_CS_ATTR_PITCH_CONTROL
) {
1234 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
1235 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1236 PITCH_CONTROL
<< 8, ep
, data
, 1, 1000)) < 0) {
1237 snd_printk(KERN_ERR
"%d:%d:%d: cannot set enable PITCH\n",
1238 dev
->devnum
, iface
, ep
);
1245 static int init_usb_sample_rate(struct usb_device
*dev
, int iface
,
1246 struct usb_host_interface
*alts
,
1247 struct audioformat
*fmt
, int rate
)
1250 unsigned char data
[3];
1253 ep
= get_endpoint(alts
, 0)->bEndpointAddress
;
1254 /* if endpoint has sampling rate control, set it */
1255 if (fmt
->attributes
& EP_CS_ATTR_SAMPLE_RATE
) {
1258 data
[1] = rate
>> 8;
1259 data
[2] = rate
>> 16;
1260 if ((err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
1261 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
1262 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000)) < 0) {
1263 snd_printk(KERN_ERR
"%d:%d:%d: cannot set freq %d to ep %#x\n",
1264 dev
->devnum
, iface
, fmt
->altsetting
, rate
, ep
);
1267 if ((err
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), GET_CUR
,
1268 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_IN
,
1269 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000)) < 0) {
1270 snd_printk(KERN_WARNING
"%d:%d:%d: cannot get freq at ep %#x\n",
1271 dev
->devnum
, iface
, fmt
->altsetting
, ep
);
1272 return 0; /* some devices don't support reading */
1274 crate
= data
[0] | (data
[1] << 8) | (data
[2] << 16);
1275 if (crate
!= rate
) {
1276 snd_printd(KERN_WARNING
"current rate %d is different from the runtime rate %d\n", crate
, rate
);
1277 // runtime->rate = crate;
1284 * For E-Mu 0404USB/0202USB/TrackerPre sample rate should be set for device,
1285 * not for interface.
1287 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1288 struct audioformat
*fmt
)
1290 unsigned char emu_samplerate_id
= 0;
1292 /* When capture is active
1293 * sample rate shouldn't be changed
1294 * by playback substream
1296 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1297 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1301 switch (fmt
->rate_min
) {
1303 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1306 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1309 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1312 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1315 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1318 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1321 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1325 * find a matching format and set up the interface
1327 static int set_format(struct snd_usb_substream
*subs
, struct audioformat
*fmt
)
1329 struct usb_device
*dev
= subs
->dev
;
1330 struct usb_host_interface
*alts
;
1331 struct usb_interface_descriptor
*altsd
;
1332 struct usb_interface
*iface
;
1333 unsigned int ep
, attr
;
1334 int is_playback
= subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
;
1337 iface
= usb_ifnum_to_if(dev
, fmt
->iface
);
1338 if (WARN_ON(!iface
))
1340 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1341 altsd
= get_iface_desc(alts
);
1342 if (WARN_ON(altsd
->bAlternateSetting
!= fmt
->altsetting
))
1345 if (fmt
== subs
->cur_audiofmt
)
1348 /* close the old interface */
1349 if (subs
->interface
>= 0 && subs
->interface
!= fmt
->iface
) {
1350 if (usb_set_interface(subs
->dev
, subs
->interface
, 0) < 0) {
1351 snd_printk(KERN_ERR
"%d:%d:%d: return to setting 0 failed\n",
1352 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1355 subs
->interface
= -1;
1360 if (subs
->interface
!= fmt
->iface
|| subs
->format
!= fmt
->altset_idx
) {
1361 if (usb_set_interface(dev
, fmt
->iface
, fmt
->altsetting
) < 0) {
1362 snd_printk(KERN_ERR
"%d:%d:%d: usb_set_interface failed\n",
1363 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1366 snd_printdd(KERN_INFO
"setting usb interface %d:%d\n", fmt
->iface
, fmt
->altsetting
);
1367 subs
->interface
= fmt
->iface
;
1368 subs
->format
= fmt
->altset_idx
;
1371 /* create a data pipe */
1372 ep
= fmt
->endpoint
& USB_ENDPOINT_NUMBER_MASK
;
1374 subs
->datapipe
= usb_sndisocpipe(dev
, ep
);
1376 subs
->datapipe
= usb_rcvisocpipe(dev
, ep
);
1377 subs
->datainterval
= fmt
->datainterval
;
1378 subs
->syncpipe
= subs
->syncinterval
= 0;
1379 subs
->maxpacksize
= fmt
->maxpacksize
;
1382 /* we need a sync pipe in async OUT or adaptive IN mode */
1383 /* check the number of EP, since some devices have broken
1384 * descriptors which fool us. if it has only one EP,
1385 * assume it as adaptive-out or sync-in.
1387 attr
= fmt
->ep_attr
& EP_ATTR_MASK
;
1388 if (((is_playback
&& attr
== EP_ATTR_ASYNC
) ||
1389 (! is_playback
&& attr
== EP_ATTR_ADAPTIVE
)) &&
1390 altsd
->bNumEndpoints
>= 2) {
1391 /* check sync-pipe endpoint */
1392 /* ... and check descriptor size before accessing bSynchAddress
1393 because there is a version of the SB Audigy 2 NX firmware lacking
1394 the audio fields in the endpoint descriptors */
1395 if ((get_endpoint(alts
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != 0x01 ||
1396 (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1397 get_endpoint(alts
, 1)->bSynchAddress
!= 0)) {
1398 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1399 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1402 ep
= get_endpoint(alts
, 1)->bEndpointAddress
;
1403 if (get_endpoint(alts
, 0)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1404 (( is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
| USB_DIR_IN
)) ||
1405 (!is_playback
&& ep
!= (unsigned int)(get_endpoint(alts
, 0)->bSynchAddress
& ~USB_DIR_IN
)))) {
1406 snd_printk(KERN_ERR
"%d:%d:%d : invalid synch pipe\n",
1407 dev
->devnum
, fmt
->iface
, fmt
->altsetting
);
1410 ep
&= USB_ENDPOINT_NUMBER_MASK
;
1412 subs
->syncpipe
= usb_rcvisocpipe(dev
, ep
);
1414 subs
->syncpipe
= usb_sndisocpipe(dev
, ep
);
1415 if (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
1416 get_endpoint(alts
, 1)->bRefresh
>= 1 &&
1417 get_endpoint(alts
, 1)->bRefresh
<= 9)
1418 subs
->syncinterval
= get_endpoint(alts
, 1)->bRefresh
;
1419 else if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
)
1420 subs
->syncinterval
= 1;
1421 else if (get_endpoint(alts
, 1)->bInterval
>= 1 &&
1422 get_endpoint(alts
, 1)->bInterval
<= 16)
1423 subs
->syncinterval
= get_endpoint(alts
, 1)->bInterval
- 1;
1425 subs
->syncinterval
= 3;
1428 /* always fill max packet size */
1429 if (fmt
->attributes
& EP_CS_ATTR_FILL_MAX
)
1432 if ((err
= init_usb_pitch(dev
, subs
->interface
, alts
, fmt
)) < 0)
1435 subs
->cur_audiofmt
= fmt
;
1437 switch (subs
->stream
->chip
->usb_id
) {
1438 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1439 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1440 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1441 set_format_emu_quirk(subs
, fmt
);
1447 "setting done: format = %d, rate = %d..%d, channels = %d\n",
1448 fmt
->format
, fmt
->rate_min
, fmt
->rate_max
, fmt
->channels
);
1450 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
1451 subs
->datapipe
, subs
->syncpipe
);
1458 * hw_params callback
1460 * allocate a buffer and set the given audio format.
1462 * so far we use a physically linear buffer although packetize transfer
1463 * doesn't need a continuous area.
1464 * if sg buffer is supported on the later version of alsa, we'll follow
1467 static int snd_usb_hw_params(struct snd_pcm_substream
*substream
,
1468 struct snd_pcm_hw_params
*hw_params
)
1470 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1471 struct audioformat
*fmt
;
1472 unsigned int channels
, rate
, format
;
1475 ret
= snd_pcm_lib_alloc_vmalloc_buffer(substream
,
1476 params_buffer_bytes(hw_params
));
1480 format
= params_format(hw_params
);
1481 rate
= params_rate(hw_params
);
1482 channels
= params_channels(hw_params
);
1483 fmt
= find_format(subs
, format
, rate
, channels
);
1485 snd_printd(KERN_DEBUG
"cannot set format: format = %#x, rate = %d, channels = %d\n",
1486 format
, rate
, channels
);
1490 changed
= subs
->cur_audiofmt
!= fmt
||
1491 subs
->period_bytes
!= params_period_bytes(hw_params
) ||
1492 subs
->cur_rate
!= rate
;
1493 if ((ret
= set_format(subs
, fmt
)) < 0)
1496 if (subs
->cur_rate
!= rate
) {
1497 struct usb_host_interface
*alts
;
1498 struct usb_interface
*iface
;
1499 iface
= usb_ifnum_to_if(subs
->dev
, fmt
->iface
);
1500 alts
= &iface
->altsetting
[fmt
->altset_idx
];
1501 ret
= init_usb_sample_rate(subs
->dev
, subs
->interface
, alts
, fmt
, rate
);
1504 subs
->cur_rate
= rate
;
1508 /* format changed */
1509 release_substream_urbs(subs
, 0);
1510 /* influenced: period_bytes, channels, rate, format, */
1511 ret
= init_substream_urbs(subs
, params_period_bytes(hw_params
),
1512 params_rate(hw_params
),
1513 snd_pcm_format_physical_width(params_format(hw_params
)) * params_channels(hw_params
));
1522 * reset the audio format and release the buffer
1524 static int snd_usb_hw_free(struct snd_pcm_substream
*substream
)
1526 struct snd_usb_substream
*subs
= substream
->runtime
->private_data
;
1528 subs
->cur_audiofmt
= NULL
;
1530 subs
->period_bytes
= 0;
1531 if (!subs
->stream
->chip
->shutdown
)
1532 release_substream_urbs(subs
, 0);
1533 return snd_pcm_lib_free_vmalloc_buffer(substream
);
1539 * only a few subtle things...
1541 static int snd_usb_pcm_prepare(struct snd_pcm_substream
*substream
)
1543 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1544 struct snd_usb_substream
*subs
= runtime
->private_data
;
1546 if (! subs
->cur_audiofmt
) {
1547 snd_printk(KERN_ERR
"usbaudio: no format is specified!\n");
1551 /* some unit conversions in runtime */
1552 subs
->maxframesize
= bytes_to_frames(runtime
, subs
->maxpacksize
);
1553 subs
->curframesize
= bytes_to_frames(runtime
, subs
->curpacksize
);
1555 /* reset the pointer */
1556 subs
->hwptr_done
= 0;
1557 subs
->transfer_done
= 0;
1561 /* clear urbs (to be sure) */
1562 deactivate_urbs(subs
, 0, 1);
1563 wait_clear_urbs(subs
);
1565 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1566 * updates for all URBs would happen at the same time when starting */
1567 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1568 subs
->ops
.prepare
= prepare_nodata_playback_urb
;
1569 return start_urbs(subs
, runtime
);
1574 static struct snd_pcm_hardware snd_usb_hardware
=
1576 .info
= SNDRV_PCM_INFO_MMAP
|
1577 SNDRV_PCM_INFO_MMAP_VALID
|
1578 SNDRV_PCM_INFO_BATCH
|
1579 SNDRV_PCM_INFO_INTERLEAVED
|
1580 SNDRV_PCM_INFO_BLOCK_TRANSFER
|
1581 SNDRV_PCM_INFO_PAUSE
,
1582 .buffer_bytes_max
= 1024 * 1024,
1583 .period_bytes_min
= 64,
1584 .period_bytes_max
= 512 * 1024,
1586 .periods_max
= 1024,
1593 #ifdef HW_CONST_DEBUG
1594 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1596 #define hwc_debug(fmt, args...) /**/
1599 static int hw_check_valid_format(struct snd_usb_substream
*subs
,
1600 struct snd_pcm_hw_params
*params
,
1601 struct audioformat
*fp
)
1603 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1604 struct snd_interval
*ct
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1605 struct snd_mask
*fmts
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1606 struct snd_interval
*pt
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
);
1609 /* check the format */
1610 if (!snd_mask_test(fmts
, fp
->format
)) {
1611 hwc_debug(" > check: no supported format %d\n", fp
->format
);
1614 /* check the channels */
1615 if (fp
->channels
< ct
->min
|| fp
->channels
> ct
->max
) {
1616 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp
->channels
, ct
->min
, ct
->max
);
1619 /* check the rate is within the range */
1620 if (fp
->rate_min
> it
->max
|| (fp
->rate_min
== it
->max
&& it
->openmax
)) {
1621 hwc_debug(" > check: rate_min %d > max %d\n", fp
->rate_min
, it
->max
);
1624 if (fp
->rate_max
< it
->min
|| (fp
->rate_max
== it
->min
&& it
->openmin
)) {
1625 hwc_debug(" > check: rate_max %d < min %d\n", fp
->rate_max
, it
->min
);
1628 /* check whether the period time is >= the data packet interval */
1629 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
) {
1630 ptime
= 125 * (1 << fp
->datainterval
);
1631 if (ptime
> pt
->max
|| (ptime
== pt
->max
&& pt
->openmax
)) {
1632 hwc_debug(" > check: ptime %u > max %u\n", ptime
, pt
->max
);
1639 static int hw_rule_rate(struct snd_pcm_hw_params
*params
,
1640 struct snd_pcm_hw_rule
*rule
)
1642 struct snd_usb_substream
*subs
= rule
->private;
1643 struct list_head
*p
;
1644 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_RATE
);
1645 unsigned int rmin
, rmax
;
1648 hwc_debug("hw_rule_rate: (%d,%d)\n", it
->min
, it
->max
);
1651 list_for_each(p
, &subs
->fmt_list
) {
1652 struct audioformat
*fp
;
1653 fp
= list_entry(p
, struct audioformat
, list
);
1654 if (!hw_check_valid_format(subs
, params
, fp
))
1657 if (rmin
> fp
->rate_min
)
1658 rmin
= fp
->rate_min
;
1659 if (rmax
< fp
->rate_max
)
1660 rmax
= fp
->rate_max
;
1662 rmin
= fp
->rate_min
;
1663 rmax
= fp
->rate_max
;
1668 hwc_debug(" --> get empty\n");
1674 if (it
->min
< rmin
) {
1679 if (it
->max
> rmax
) {
1684 if (snd_interval_checkempty(it
)) {
1688 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1693 static int hw_rule_channels(struct snd_pcm_hw_params
*params
,
1694 struct snd_pcm_hw_rule
*rule
)
1696 struct snd_usb_substream
*subs
= rule
->private;
1697 struct list_head
*p
;
1698 struct snd_interval
*it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_CHANNELS
);
1699 unsigned int rmin
, rmax
;
1702 hwc_debug("hw_rule_channels: (%d,%d)\n", it
->min
, it
->max
);
1705 list_for_each(p
, &subs
->fmt_list
) {
1706 struct audioformat
*fp
;
1707 fp
= list_entry(p
, struct audioformat
, list
);
1708 if (!hw_check_valid_format(subs
, params
, fp
))
1711 if (rmin
> fp
->channels
)
1712 rmin
= fp
->channels
;
1713 if (rmax
< fp
->channels
)
1714 rmax
= fp
->channels
;
1716 rmin
= fp
->channels
;
1717 rmax
= fp
->channels
;
1722 hwc_debug(" --> get empty\n");
1728 if (it
->min
< rmin
) {
1733 if (it
->max
> rmax
) {
1738 if (snd_interval_checkempty(it
)) {
1742 hwc_debug(" --> (%d, %d) (changed = %d)\n", it
->min
, it
->max
, changed
);
1746 static int hw_rule_format(struct snd_pcm_hw_params
*params
,
1747 struct snd_pcm_hw_rule
*rule
)
1749 struct snd_usb_substream
*subs
= rule
->private;
1750 struct list_head
*p
;
1751 struct snd_mask
*fmt
= hw_param_mask(params
, SNDRV_PCM_HW_PARAM_FORMAT
);
1756 hwc_debug("hw_rule_format: %x:%x\n", fmt
->bits
[0], fmt
->bits
[1]);
1758 list_for_each(p
, &subs
->fmt_list
) {
1759 struct audioformat
*fp
;
1760 fp
= list_entry(p
, struct audioformat
, list
);
1761 if (!hw_check_valid_format(subs
, params
, fp
))
1763 fbits
|= (1ULL << fp
->format
);
1766 oldbits
[0] = fmt
->bits
[0];
1767 oldbits
[1] = fmt
->bits
[1];
1768 fmt
->bits
[0] &= (u32
)fbits
;
1769 fmt
->bits
[1] &= (u32
)(fbits
>> 32);
1770 if (!fmt
->bits
[0] && !fmt
->bits
[1]) {
1771 hwc_debug(" --> get empty\n");
1774 changed
= (oldbits
[0] != fmt
->bits
[0] || oldbits
[1] != fmt
->bits
[1]);
1775 hwc_debug(" --> %x:%x (changed = %d)\n", fmt
->bits
[0], fmt
->bits
[1], changed
);
1779 static int hw_rule_period_time(struct snd_pcm_hw_params
*params
,
1780 struct snd_pcm_hw_rule
*rule
)
1782 struct snd_usb_substream
*subs
= rule
->private;
1783 struct audioformat
*fp
;
1784 struct snd_interval
*it
;
1785 unsigned char min_datainterval
;
1789 it
= hw_param_interval(params
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
);
1790 hwc_debug("hw_rule_period_time: (%u,%u)\n", it
->min
, it
->max
);
1791 min_datainterval
= 0xff;
1792 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1793 if (!hw_check_valid_format(subs
, params
, fp
))
1795 min_datainterval
= min(min_datainterval
, fp
->datainterval
);
1797 if (min_datainterval
== 0xff) {
1798 hwc_debug(" --> get emtpy\n");
1802 pmin
= 125 * (1 << min_datainterval
);
1804 if (it
->min
< pmin
) {
1809 if (snd_interval_checkempty(it
)) {
1813 hwc_debug(" --> (%u,%u) (changed = %d)\n", it
->min
, it
->max
, changed
);
1818 * If the device supports unusual bit rates, does the request meet these?
1820 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime
*runtime
,
1821 struct snd_usb_substream
*subs
)
1823 struct audioformat
*fp
;
1824 int count
= 0, needs_knot
= 0;
1827 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1828 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
)
1830 count
+= fp
->nr_rates
;
1831 if (fp
->rates
& SNDRV_PCM_RATE_KNOT
)
1837 subs
->rate_list
.count
= count
;
1838 subs
->rate_list
.list
= kmalloc(sizeof(int) * count
, GFP_KERNEL
);
1839 subs
->rate_list
.mask
= 0;
1841 list_for_each_entry(fp
, &subs
->fmt_list
, list
) {
1843 for (i
= 0; i
< fp
->nr_rates
; i
++)
1844 subs
->rate_list
.list
[count
++] = fp
->rate_table
[i
];
1846 err
= snd_pcm_hw_constraint_list(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1856 * set up the runtime hardware information.
1859 static int setup_hw_info(struct snd_pcm_runtime
*runtime
, struct snd_usb_substream
*subs
)
1861 struct list_head
*p
;
1862 unsigned int pt
, ptmin
;
1863 int param_period_time_if_needed
;
1866 runtime
->hw
.formats
= subs
->formats
;
1868 runtime
->hw
.rate_min
= 0x7fffffff;
1869 runtime
->hw
.rate_max
= 0;
1870 runtime
->hw
.channels_min
= 256;
1871 runtime
->hw
.channels_max
= 0;
1872 runtime
->hw
.rates
= 0;
1874 /* check min/max rates and channels */
1875 list_for_each(p
, &subs
->fmt_list
) {
1876 struct audioformat
*fp
;
1877 fp
= list_entry(p
, struct audioformat
, list
);
1878 runtime
->hw
.rates
|= fp
->rates
;
1879 if (runtime
->hw
.rate_min
> fp
->rate_min
)
1880 runtime
->hw
.rate_min
= fp
->rate_min
;
1881 if (runtime
->hw
.rate_max
< fp
->rate_max
)
1882 runtime
->hw
.rate_max
= fp
->rate_max
;
1883 if (runtime
->hw
.channels_min
> fp
->channels
)
1884 runtime
->hw
.channels_min
= fp
->channels
;
1885 if (runtime
->hw
.channels_max
< fp
->channels
)
1886 runtime
->hw
.channels_max
= fp
->channels
;
1887 if (fp
->fmt_type
== USB_FORMAT_TYPE_II
&& fp
->frame_size
> 0) {
1888 /* FIXME: there might be more than one audio formats... */
1889 runtime
->hw
.period_bytes_min
= runtime
->hw
.period_bytes_max
=
1892 pt
= 125 * (1 << fp
->datainterval
);
1893 ptmin
= min(ptmin
, pt
);
1896 param_period_time_if_needed
= SNDRV_PCM_HW_PARAM_PERIOD_TIME
;
1897 if (snd_usb_get_speed(subs
->dev
) != USB_SPEED_HIGH
)
1898 /* full speed devices have fixed data packet interval */
1901 /* if period time doesn't go below 1 ms, no rules needed */
1902 param_period_time_if_needed
= -1;
1903 snd_pcm_hw_constraint_minmax(runtime
, SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
1906 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_RATE
,
1908 SNDRV_PCM_HW_PARAM_FORMAT
,
1909 SNDRV_PCM_HW_PARAM_CHANNELS
,
1910 param_period_time_if_needed
,
1913 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_CHANNELS
,
1914 hw_rule_channels
, subs
,
1915 SNDRV_PCM_HW_PARAM_FORMAT
,
1916 SNDRV_PCM_HW_PARAM_RATE
,
1917 param_period_time_if_needed
,
1920 if ((err
= snd_pcm_hw_rule_add(runtime
, 0, SNDRV_PCM_HW_PARAM_FORMAT
,
1921 hw_rule_format
, subs
,
1922 SNDRV_PCM_HW_PARAM_RATE
,
1923 SNDRV_PCM_HW_PARAM_CHANNELS
,
1924 param_period_time_if_needed
,
1927 if (param_period_time_if_needed
>= 0) {
1928 err
= snd_pcm_hw_rule_add(runtime
, 0,
1929 SNDRV_PCM_HW_PARAM_PERIOD_TIME
,
1930 hw_rule_period_time
, subs
,
1931 SNDRV_PCM_HW_PARAM_FORMAT
,
1932 SNDRV_PCM_HW_PARAM_CHANNELS
,
1933 SNDRV_PCM_HW_PARAM_RATE
,
1938 if ((err
= snd_usb_pcm_check_knot(runtime
, subs
)) < 0)
1943 static int snd_usb_pcm_open(struct snd_pcm_substream
*substream
, int direction
)
1945 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1946 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
1947 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1949 subs
->interface
= -1;
1951 runtime
->hw
= snd_usb_hardware
;
1952 runtime
->private_data
= subs
;
1953 subs
->pcm_substream
= substream
;
1954 return setup_hw_info(runtime
, subs
);
1957 static int snd_usb_pcm_close(struct snd_pcm_substream
*substream
, int direction
)
1959 struct snd_usb_stream
*as
= snd_pcm_substream_chip(substream
);
1960 struct snd_usb_substream
*subs
= &as
->substream
[direction
];
1962 if (subs
->interface
>= 0) {
1963 usb_set_interface(subs
->dev
, subs
->interface
, 0);
1964 subs
->interface
= -1;
1966 subs
->pcm_substream
= NULL
;
1970 static int snd_usb_playback_open(struct snd_pcm_substream
*substream
)
1972 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1975 static int snd_usb_playback_close(struct snd_pcm_substream
*substream
)
1977 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_PLAYBACK
);
1980 static int snd_usb_capture_open(struct snd_pcm_substream
*substream
)
1982 return snd_usb_pcm_open(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1985 static int snd_usb_capture_close(struct snd_pcm_substream
*substream
)
1987 return snd_usb_pcm_close(substream
, SNDRV_PCM_STREAM_CAPTURE
);
1990 static struct snd_pcm_ops snd_usb_playback_ops
= {
1991 .open
= snd_usb_playback_open
,
1992 .close
= snd_usb_playback_close
,
1993 .ioctl
= snd_pcm_lib_ioctl
,
1994 .hw_params
= snd_usb_hw_params
,
1995 .hw_free
= snd_usb_hw_free
,
1996 .prepare
= snd_usb_pcm_prepare
,
1997 .trigger
= snd_usb_pcm_playback_trigger
,
1998 .pointer
= snd_usb_pcm_pointer
,
1999 .page
= snd_pcm_lib_get_vmalloc_page
,
2002 static struct snd_pcm_ops snd_usb_capture_ops
= {
2003 .open
= snd_usb_capture_open
,
2004 .close
= snd_usb_capture_close
,
2005 .ioctl
= snd_pcm_lib_ioctl
,
2006 .hw_params
= snd_usb_hw_params
,
2007 .hw_free
= snd_usb_hw_free
,
2008 .prepare
= snd_usb_pcm_prepare
,
2009 .trigger
= snd_usb_pcm_capture_trigger
,
2010 .pointer
= snd_usb_pcm_pointer
,
2011 .page
= snd_pcm_lib_get_vmalloc_page
,
2021 * combine bytes and get an integer value
2023 unsigned int snd_usb_combine_bytes(unsigned char *bytes
, int size
)
2026 case 1: return *bytes
;
2027 case 2: return combine_word(bytes
);
2028 case 3: return combine_triple(bytes
);
2029 case 4: return combine_quad(bytes
);
2035 * parse descriptor buffer and return the pointer starting the given
2038 void *snd_usb_find_desc(void *descstart
, int desclen
, void *after
, u8 dtype
)
2050 if (p
[1] == dtype
&& (!after
|| (void *)p
> after
)) {
2059 * find a class-specified interface descriptor with the given subtype.
2061 void *snd_usb_find_csint_desc(void *buffer
, int buflen
, void *after
, u8 dsubtype
)
2063 unsigned char *p
= after
;
2065 while ((p
= snd_usb_find_desc(buffer
, buflen
, p
,
2066 USB_DT_CS_INTERFACE
)) != NULL
) {
2067 if (p
[0] >= 3 && p
[2] == dsubtype
)
2074 * Wrapper for usb_control_msg().
2075 * Allocates a temp buffer to prevent dmaing from/to the stack.
2077 int snd_usb_ctl_msg(struct usb_device
*dev
, unsigned int pipe
, __u8 request
,
2078 __u8 requesttype
, __u16 value
, __u16 index
, void *data
,
2079 __u16 size
, int timeout
)
2085 buf
= kmemdup(data
, size
, GFP_KERNEL
);
2089 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
2090 value
, index
, buf
, size
, timeout
);
2092 memcpy(data
, buf
, size
);
2100 * entry point for linux usb interface
2103 static int usb_audio_probe(struct usb_interface
*intf
,
2104 const struct usb_device_id
*id
);
2105 static void usb_audio_disconnect(struct usb_interface
*intf
);
2108 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
);
2109 static int usb_audio_resume(struct usb_interface
*intf
);
2111 #define usb_audio_suspend NULL
2112 #define usb_audio_resume NULL
2115 static struct usb_device_id usb_audio_ids
[] = {
2116 #include "usbquirks.h"
2117 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
2118 .bInterfaceClass
= USB_CLASS_AUDIO
,
2119 .bInterfaceSubClass
= USB_SUBCLASS_AUDIO_CONTROL
},
2120 { } /* Terminating entry */
2123 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
2125 static struct usb_driver usb_audio_driver
= {
2126 .name
= "snd-usb-audio",
2127 .probe
= usb_audio_probe
,
2128 .disconnect
= usb_audio_disconnect
,
2129 .suspend
= usb_audio_suspend
,
2130 .resume
= usb_audio_resume
,
2131 .id_table
= usb_audio_ids
,
2135 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2138 * proc interface for list the supported pcm formats
2140 static void proc_dump_substream_formats(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2142 struct list_head
*p
;
2143 static char *sync_types
[4] = {
2144 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2147 list_for_each(p
, &subs
->fmt_list
) {
2148 struct audioformat
*fp
;
2149 fp
= list_entry(p
, struct audioformat
, list
);
2150 snd_iprintf(buffer
, " Interface %d\n", fp
->iface
);
2151 snd_iprintf(buffer
, " Altset %d\n", fp
->altsetting
);
2152 snd_iprintf(buffer
, " Format: %s\n",
2153 snd_pcm_format_name(fp
->format
));
2154 snd_iprintf(buffer
, " Channels: %d\n", fp
->channels
);
2155 snd_iprintf(buffer
, " Endpoint: %d %s (%s)\n",
2156 fp
->endpoint
& USB_ENDPOINT_NUMBER_MASK
,
2157 fp
->endpoint
& USB_DIR_IN
? "IN" : "OUT",
2158 sync_types
[(fp
->ep_attr
& EP_ATTR_MASK
) >> 2]);
2159 if (fp
->rates
& SNDRV_PCM_RATE_CONTINUOUS
) {
2160 snd_iprintf(buffer
, " Rates: %d - %d (continuous)\n",
2161 fp
->rate_min
, fp
->rate_max
);
2164 snd_iprintf(buffer
, " Rates: ");
2165 for (i
= 0; i
< fp
->nr_rates
; i
++) {
2167 snd_iprintf(buffer
, ", ");
2168 snd_iprintf(buffer
, "%d", fp
->rate_table
[i
]);
2170 snd_iprintf(buffer
, "\n");
2172 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_HIGH
)
2173 snd_iprintf(buffer
, " Data packet interval: %d us\n",
2174 125 * (1 << fp
->datainterval
));
2175 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2176 // snd_iprintf(buffer, " EP Attribute = %#x\n", fp->attributes);
2180 static void proc_dump_substream_status(struct snd_usb_substream
*subs
, struct snd_info_buffer
*buffer
)
2182 if (subs
->running
) {
2184 snd_iprintf(buffer
, " Status: Running\n");
2185 snd_iprintf(buffer
, " Interface = %d\n", subs
->interface
);
2186 snd_iprintf(buffer
, " Altset = %d\n", subs
->format
);
2187 snd_iprintf(buffer
, " URBs = %d [ ", subs
->nurbs
);
2188 for (i
= 0; i
< subs
->nurbs
; i
++)
2189 snd_iprintf(buffer
, "%d ", subs
->dataurb
[i
].packets
);
2190 snd_iprintf(buffer
, "]\n");
2191 snd_iprintf(buffer
, " Packet Size = %d\n", subs
->curpacksize
);
2192 snd_iprintf(buffer
, " Momentary freq = %u Hz (%#x.%04x)\n",
2193 snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
2194 ? get_full_speed_hz(subs
->freqm
)
2195 : get_high_speed_hz(subs
->freqm
),
2196 subs
->freqm
>> 16, subs
->freqm
& 0xffff);
2198 snd_iprintf(buffer
, " Status: Stop\n");
2202 static void proc_pcm_format_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
2204 struct snd_usb_stream
*stream
= entry
->private_data
;
2206 snd_iprintf(buffer
, "%s : %s\n", stream
->chip
->card
->longname
, stream
->pcm
->name
);
2208 if (stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
].num_formats
) {
2209 snd_iprintf(buffer
, "\nPlayback:\n");
2210 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2211 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_PLAYBACK
], buffer
);
2213 if (stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].num_formats
) {
2214 snd_iprintf(buffer
, "\nCapture:\n");
2215 proc_dump_substream_status(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2216 proc_dump_substream_formats(&stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
], buffer
);
2220 static void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2222 struct snd_info_entry
*entry
;
2224 struct snd_card
*card
= stream
->chip
->card
;
2226 sprintf(name
, "stream%d", stream
->pcm_index
);
2227 if (!snd_card_proc_new(card
, name
, &entry
))
2228 snd_info_set_text_ops(entry
, stream
, proc_pcm_format_read
);
2233 static inline void proc_pcm_format_add(struct snd_usb_stream
*stream
)
2240 * initialize the substream instance.
2243 static void init_substream(struct snd_usb_stream
*as
, int stream
, struct audioformat
*fp
)
2245 struct snd_usb_substream
*subs
= &as
->substream
[stream
];
2247 INIT_LIST_HEAD(&subs
->fmt_list
);
2248 spin_lock_init(&subs
->lock
);
2251 subs
->direction
= stream
;
2252 subs
->dev
= as
->chip
->dev
;
2253 subs
->txfr_quirk
= as
->chip
->txfr_quirk
;
2254 if (snd_usb_get_speed(subs
->dev
) == USB_SPEED_FULL
) {
2255 subs
->ops
= audio_urb_ops
[stream
];
2257 subs
->ops
= audio_urb_ops_high_speed
[stream
];
2258 switch (as
->chip
->usb_id
) {
2259 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
2260 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
2261 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
2262 subs
->ops
.retire_sync
= retire_playback_sync_urb_hs_emu
;
2266 snd_pcm_set_ops(as
->pcm
, stream
,
2267 stream
== SNDRV_PCM_STREAM_PLAYBACK
?
2268 &snd_usb_playback_ops
: &snd_usb_capture_ops
);
2270 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2271 subs
->formats
|= 1ULL << fp
->format
;
2272 subs
->endpoint
= fp
->endpoint
;
2273 subs
->num_formats
++;
2274 subs
->fmt_type
= fp
->fmt_type
;
2281 static void free_substream(struct snd_usb_substream
*subs
)
2283 struct list_head
*p
, *n
;
2285 if (!subs
->num_formats
)
2286 return; /* not initialized */
2287 list_for_each_safe(p
, n
, &subs
->fmt_list
) {
2288 struct audioformat
*fp
= list_entry(p
, struct audioformat
, list
);
2289 kfree(fp
->rate_table
);
2292 kfree(subs
->rate_list
.list
);
2297 * free a usb stream instance
2299 static void snd_usb_audio_stream_free(struct snd_usb_stream
*stream
)
2301 free_substream(&stream
->substream
[0]);
2302 free_substream(&stream
->substream
[1]);
2303 list_del(&stream
->list
);
2307 static void snd_usb_audio_pcm_free(struct snd_pcm
*pcm
)
2309 struct snd_usb_stream
*stream
= pcm
->private_data
;
2312 snd_usb_audio_stream_free(stream
);
2318 * add this endpoint to the chip instance.
2319 * if a stream with the same endpoint already exists, append to it.
2320 * if not, create a new pcm stream.
2322 static int add_audio_endpoint(struct snd_usb_audio
*chip
, int stream
, struct audioformat
*fp
)
2324 struct list_head
*p
;
2325 struct snd_usb_stream
*as
;
2326 struct snd_usb_substream
*subs
;
2327 struct snd_pcm
*pcm
;
2330 list_for_each(p
, &chip
->pcm_list
) {
2331 as
= list_entry(p
, struct snd_usb_stream
, list
);
2332 if (as
->fmt_type
!= fp
->fmt_type
)
2334 subs
= &as
->substream
[stream
];
2335 if (!subs
->endpoint
)
2337 if (subs
->endpoint
== fp
->endpoint
) {
2338 list_add_tail(&fp
->list
, &subs
->fmt_list
);
2339 subs
->num_formats
++;
2340 subs
->formats
|= 1ULL << fp
->format
;
2344 /* look for an empty stream */
2345 list_for_each(p
, &chip
->pcm_list
) {
2346 as
= list_entry(p
, struct snd_usb_stream
, list
);
2347 if (as
->fmt_type
!= fp
->fmt_type
)
2349 subs
= &as
->substream
[stream
];
2352 err
= snd_pcm_new_stream(as
->pcm
, stream
, 1);
2355 init_substream(as
, stream
, fp
);
2359 /* create a new pcm */
2360 as
= kzalloc(sizeof(*as
), GFP_KERNEL
);
2363 as
->pcm_index
= chip
->pcm_devs
;
2365 as
->fmt_type
= fp
->fmt_type
;
2366 err
= snd_pcm_new(chip
->card
, "USB Audio", chip
->pcm_devs
,
2367 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 1 : 0,
2368 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 0 : 1,
2375 pcm
->private_data
= as
;
2376 pcm
->private_free
= snd_usb_audio_pcm_free
;
2377 pcm
->info_flags
= 0;
2378 if (chip
->pcm_devs
> 0)
2379 sprintf(pcm
->name
, "USB Audio #%d", chip
->pcm_devs
);
2381 strcpy(pcm
->name
, "USB Audio");
2383 init_substream(as
, stream
, fp
);
2385 list_add(&as
->list
, &chip
->pcm_list
);
2388 proc_pcm_format_add(as
);
2395 * check if the device uses big-endian samples
2397 static int is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
2399 switch (chip
->usb_id
) {
2400 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2401 if (fp
->endpoint
& USB_DIR_IN
)
2404 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2405 if (device_setup
[chip
->index
] == 0x00 ||
2406 fp
->altsetting
==1 || fp
->altsetting
==2 || fp
->altsetting
==3)
2413 * parse the audio format type I descriptor
2414 * and returns the corresponding pcm format
2417 * @fp: audioformat record
2418 * @format: the format tag (wFormatTag)
2419 * @fmt: the format type descriptor
2421 static int parse_audio_format_i_type(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2422 int format
, unsigned char *fmt
)
2425 int sample_width
, sample_bytes
;
2427 /* FIXME: correct endianess and sign? */
2429 sample_width
= fmt
[6];
2430 sample_bytes
= fmt
[5];
2432 case 0: /* some devices don't define this correctly... */
2433 snd_printdd(KERN_INFO
"%d:%u:%d : format type 0 is detected, processed as PCM\n",
2434 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2436 case USB_AUDIO_FORMAT_PCM
:
2437 if (sample_width
> sample_bytes
* 8) {
2438 snd_printk(KERN_INFO
"%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2439 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
,
2440 sample_width
, sample_bytes
);
2442 /* check the format byte size */
2445 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2448 if (is_big_endian_format(chip
, fp
))
2449 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
; /* grrr, big endian!! */
2451 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2454 if (is_big_endian_format(chip
, fp
))
2455 pcm_format
= SNDRV_PCM_FORMAT_S24_3BE
; /* grrr, big endian!! */
2457 pcm_format
= SNDRV_PCM_FORMAT_S24_3LE
;
2460 pcm_format
= SNDRV_PCM_FORMAT_S32_LE
;
2463 snd_printk(KERN_INFO
"%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2464 chip
->dev
->devnum
, fp
->iface
,
2465 fp
->altsetting
, sample_width
, sample_bytes
);
2469 case USB_AUDIO_FORMAT_PCM8
:
2470 pcm_format
= SNDRV_PCM_FORMAT_U8
;
2472 /* Dallas DS4201 workaround: it advertises U8 format, but really
2474 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2475 pcm_format
= SNDRV_PCM_FORMAT_S8
;
2477 case USB_AUDIO_FORMAT_IEEE_FLOAT
:
2478 pcm_format
= SNDRV_PCM_FORMAT_FLOAT_LE
;
2480 case USB_AUDIO_FORMAT_ALAW
:
2481 pcm_format
= SNDRV_PCM_FORMAT_A_LAW
;
2483 case USB_AUDIO_FORMAT_MU_LAW
:
2484 pcm_format
= SNDRV_PCM_FORMAT_MU_LAW
;
2487 snd_printk(KERN_INFO
"%d:%u:%d : unsupported format type %d\n",
2488 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2496 * parse the format descriptor and stores the possible sample rates
2497 * on the audioformat table.
2500 * @fp: audioformat record
2501 * @fmt: the format descriptor
2502 * @offset: the start offset of descriptor pointing the rate type
2503 * (7 for type I and II, 8 for type II)
2505 static int parse_audio_format_rates(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2506 unsigned char *fmt
, int offset
)
2508 int nr_rates
= fmt
[offset
];
2510 if (fmt
[0] < offset
+ 1 + 3 * (nr_rates
? nr_rates
: 2)) {
2511 snd_printk(KERN_ERR
"%d:%u:%d : invalid FORMAT_TYPE desc\n",
2512 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
);
2518 * build the rate table and bitmap flags
2522 fp
->rate_table
= kmalloc(sizeof(int) * nr_rates
, GFP_KERNEL
);
2523 if (fp
->rate_table
== NULL
) {
2524 snd_printk(KERN_ERR
"cannot malloc\n");
2529 fp
->rate_min
= fp
->rate_max
= 0;
2530 for (r
= 0, idx
= offset
+ 1; r
< nr_rates
; r
++, idx
+= 3) {
2531 unsigned int rate
= combine_triple(&fmt
[idx
]);
2534 /* C-Media CM6501 mislabels its 96 kHz altsetting */
2535 if (rate
== 48000 && nr_rates
== 1 &&
2536 (chip
->usb_id
== USB_ID(0x0d8c, 0x0201) ||
2537 chip
->usb_id
== USB_ID(0x0d8c, 0x0102)) &&
2538 fp
->altsetting
== 5 && fp
->maxpacksize
== 392)
2540 fp
->rate_table
[fp
->nr_rates
] = rate
;
2541 if (!fp
->rate_min
|| rate
< fp
->rate_min
)
2542 fp
->rate_min
= rate
;
2543 if (!fp
->rate_max
|| rate
> fp
->rate_max
)
2544 fp
->rate_max
= rate
;
2545 fp
->rates
|= snd_pcm_rate_to_rate_bit(rate
);
2548 if (!fp
->nr_rates
) {
2549 hwc_debug("All rates were zero. Skipping format!\n");
2553 /* continuous rates */
2554 fp
->rates
= SNDRV_PCM_RATE_CONTINUOUS
;
2555 fp
->rate_min
= combine_triple(&fmt
[offset
+ 1]);
2556 fp
->rate_max
= combine_triple(&fmt
[offset
+ 4]);
2562 * parse the format type I and III descriptors
2564 static int parse_audio_format_i(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2565 int format
, unsigned char *fmt
)
2569 if (fmt
[3] == USB_FORMAT_TYPE_III
) {
2570 /* FIXME: the format type is really IECxxx
2571 * but we give normal PCM format to get the existing
2574 switch (chip
->usb_id
) {
2576 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2577 if (device_setup
[chip
->index
] == 0x00 &&
2578 fp
->altsetting
== 6)
2579 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
;
2581 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2584 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
2587 pcm_format
= parse_audio_format_i_type(chip
, fp
, format
, fmt
);
2591 fp
->format
= pcm_format
;
2592 fp
->channels
= fmt
[4];
2593 if (fp
->channels
< 1) {
2594 snd_printk(KERN_ERR
"%d:%u:%d : invalid channels %d\n",
2595 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fp
->channels
);
2598 return parse_audio_format_rates(chip
, fp
, fmt
, 7);
2602 * prase the format type II descriptor
2604 static int parse_audio_format_ii(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2605 int format
, unsigned char *fmt
)
2607 int brate
, framesize
;
2609 case USB_AUDIO_FORMAT_AC3
:
2610 /* FIXME: there is no AC3 format defined yet */
2611 // fp->format = SNDRV_PCM_FORMAT_AC3;
2612 fp
->format
= SNDRV_PCM_FORMAT_U8
; /* temporarily hack to receive byte streams */
2614 case USB_AUDIO_FORMAT_MPEG
:
2615 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2618 snd_printd(KERN_INFO
"%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
2619 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, format
);
2620 fp
->format
= SNDRV_PCM_FORMAT_MPEG
;
2624 brate
= combine_word(&fmt
[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2625 framesize
= combine_word(&fmt
[6]); /* fmt[6,7]: wSamplesPerFrame */
2626 snd_printd(KERN_INFO
"found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
2627 fp
->frame_size
= framesize
;
2628 return parse_audio_format_rates(chip
, fp
, fmt
, 8); /* fmt[8..] sample rates */
2631 static int parse_audio_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
,
2632 int format
, unsigned char *fmt
, int stream
)
2637 case USB_FORMAT_TYPE_I
:
2638 case USB_FORMAT_TYPE_III
:
2639 err
= parse_audio_format_i(chip
, fp
, format
, fmt
);
2641 case USB_FORMAT_TYPE_II
:
2642 err
= parse_audio_format_ii(chip
, fp
, format
, fmt
);
2645 snd_printd(KERN_INFO
"%d:%u:%d : format type %d is not supported yet\n",
2646 chip
->dev
->devnum
, fp
->iface
, fp
->altsetting
, fmt
[3]);
2649 fp
->fmt_type
= fmt
[3];
2653 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2654 /* extigy apparently supports sample rates other than 48k
2655 * but not in ordinary way. so we enable only 48k atm.
2657 if (chip
->usb_id
== USB_ID(0x041e, 0x3000) ||
2658 chip
->usb_id
== USB_ID(0x041e, 0x3020) ||
2659 chip
->usb_id
== USB_ID(0x041e, 0x3061)) {
2660 if (fmt
[3] == USB_FORMAT_TYPE_I
&&
2661 fp
->rates
!= SNDRV_PCM_RATE_48000
&&
2662 fp
->rates
!= SNDRV_PCM_RATE_96000
)
2669 static unsigned char parse_datainterval(struct snd_usb_audio
*chip
,
2670 struct usb_host_interface
*alts
)
2672 if (snd_usb_get_speed(chip
->dev
) == USB_SPEED_HIGH
&&
2673 get_endpoint(alts
, 0)->bInterval
>= 1 &&
2674 get_endpoint(alts
, 0)->bInterval
<= 4)
2675 return get_endpoint(alts
, 0)->bInterval
- 1;
2680 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
2681 int iface
, int altno
);
2682 static int parse_audio_endpoints(struct snd_usb_audio
*chip
, int iface_no
)
2684 struct usb_device
*dev
;
2685 struct usb_interface
*iface
;
2686 struct usb_host_interface
*alts
;
2687 struct usb_interface_descriptor
*altsd
;
2688 int i
, altno
, err
, stream
;
2690 struct audioformat
*fp
= NULL
;
2691 unsigned char *fmt
, *csep
;
2696 /* parse the interface's altsettings */
2697 iface
= usb_ifnum_to_if(dev
, iface_no
);
2699 num
= iface
->num_altsetting
;
2702 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
2703 * one misses syncpipe, and does not produce any sound.
2705 if (chip
->usb_id
== USB_ID(0x04fa, 0x4201))
2708 for (i
= 0; i
< num
; i
++) {
2709 alts
= &iface
->altsetting
[i
];
2710 altsd
= get_iface_desc(alts
);
2711 /* skip invalid one */
2712 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2713 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2714 (altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIO_STREAMING
&&
2715 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_VENDOR_SPEC
) ||
2716 altsd
->bNumEndpoints
< 1 ||
2717 le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
) == 0)
2719 /* must be isochronous */
2720 if ((get_endpoint(alts
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) !=
2721 USB_ENDPOINT_XFER_ISOC
)
2723 /* check direction */
2724 stream
= (get_endpoint(alts
, 0)->bEndpointAddress
& USB_DIR_IN
) ?
2725 SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2726 altno
= altsd
->bAlternateSetting
;
2728 /* audiophile usb: skip altsets incompatible with device_setup
2730 if (chip
->usb_id
== USB_ID(0x0763, 0x2003) &&
2731 audiophile_skip_setting_quirk(chip
, iface_no
, altno
))
2734 /* get audio formats */
2735 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, AS_GENERAL
);
2737 snd_printk(KERN_ERR
"%d:%u:%d : AS_GENERAL descriptor not found\n",
2738 dev
->devnum
, iface_no
, altno
);
2743 snd_printk(KERN_ERR
"%d:%u:%d : invalid AS_GENERAL desc\n",
2744 dev
->devnum
, iface_no
, altno
);
2748 format
= (fmt
[6] << 8) | fmt
[5]; /* remember the format value */
2750 /* get format type */
2751 fmt
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
, FORMAT_TYPE
);
2753 snd_printk(KERN_ERR
"%d:%u:%d : no FORMAT_TYPE desc\n",
2754 dev
->devnum
, iface_no
, altno
);
2758 snd_printk(KERN_ERR
"%d:%u:%d : invalid FORMAT_TYPE desc\n",
2759 dev
->devnum
, iface_no
, altno
);
2764 * Blue Microphones workaround: The last altsetting is identical
2765 * with the previous one, except for a larger packet size, but
2766 * is actually a mislabeled two-channel setting; ignore it.
2768 if (fmt
[4] == 1 && fmt
[5] == 2 && altno
== 2 && num
== 3 &&
2769 fp
&& fp
->altsetting
== 1 && fp
->channels
== 1 &&
2770 fp
->format
== SNDRV_PCM_FORMAT_S16_LE
&&
2771 le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
) ==
2772 fp
->maxpacksize
* 2)
2775 csep
= snd_usb_find_desc(alts
->endpoint
[0].extra
, alts
->endpoint
[0].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2776 /* Creamware Noah has this descriptor after the 2nd endpoint */
2777 if (!csep
&& altsd
->bNumEndpoints
>= 2)
2778 csep
= snd_usb_find_desc(alts
->endpoint
[1].extra
, alts
->endpoint
[1].extralen
, NULL
, USB_DT_CS_ENDPOINT
);
2779 if (!csep
|| csep
[0] < 7 || csep
[2] != EP_GENERAL
) {
2780 snd_printk(KERN_WARNING
"%d:%u:%d : no or invalid"
2781 " class specific endpoint descriptor\n",
2782 dev
->devnum
, iface_no
, altno
);
2786 fp
= kzalloc(sizeof(*fp
), GFP_KERNEL
);
2788 snd_printk(KERN_ERR
"cannot malloc\n");
2792 fp
->iface
= iface_no
;
2793 fp
->altsetting
= altno
;
2795 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
2796 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
2797 fp
->datainterval
= parse_datainterval(chip
, alts
);
2798 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2799 if (snd_usb_get_speed(dev
) == USB_SPEED_HIGH
)
2800 fp
->maxpacksize
= (((fp
->maxpacksize
>> 11) & 3) + 1)
2801 * (fp
->maxpacksize
& 0x7ff);
2802 fp
->attributes
= csep
? csep
[3] : 0;
2804 /* some quirks for attributes here */
2806 switch (chip
->usb_id
) {
2807 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2808 /* Optoplay sets the sample rate attribute although
2809 * it seems not supporting it in fact.
2811 fp
->attributes
&= ~EP_CS_ATTR_SAMPLE_RATE
;
2813 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2814 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2815 /* doesn't set the sample rate attribute, but supports it */
2816 fp
->attributes
|= EP_CS_ATTR_SAMPLE_RATE
;
2818 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2819 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2820 an older model 77d:223) */
2822 * plantronics headset and Griffin iMic have set adaptive-in
2823 * although it's really not...
2825 fp
->ep_attr
&= ~EP_ATTR_MASK
;
2826 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
2827 fp
->ep_attr
|= EP_ATTR_ADAPTIVE
;
2829 fp
->ep_attr
|= EP_ATTR_SYNC
;
2833 /* ok, let's parse further... */
2834 if (parse_audio_format(chip
, fp
, format
, fmt
, stream
) < 0) {
2835 kfree(fp
->rate_table
);
2840 snd_printdd(KERN_INFO
"%d:%u:%d: add audio endpoint %#x\n", dev
->devnum
, iface_no
, altno
, fp
->endpoint
);
2841 err
= add_audio_endpoint(chip
, stream
, fp
);
2843 kfree(fp
->rate_table
);
2847 /* try to set the interface... */
2848 usb_set_interface(chip
->dev
, iface_no
, altno
);
2849 init_usb_pitch(chip
->dev
, iface_no
, alts
, fp
);
2850 init_usb_sample_rate(chip
->dev
, iface_no
, alts
, fp
, fp
->rate_max
);
2857 * disconnect streams
2858 * called from snd_usb_audio_disconnect()
2860 static void snd_usb_stream_disconnect(struct list_head
*head
)
2863 struct snd_usb_stream
*as
;
2864 struct snd_usb_substream
*subs
;
2866 as
= list_entry(head
, struct snd_usb_stream
, list
);
2867 for (idx
= 0; idx
< 2; idx
++) {
2868 subs
= &as
->substream
[idx
];
2869 if (!subs
->num_formats
)
2871 release_substream_urbs(subs
, 1);
2872 subs
->interface
= -1;
2877 * parse audio control descriptor and create pcm/midi streams
2879 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
2881 struct usb_device
*dev
= chip
->dev
;
2882 struct usb_host_interface
*host_iface
;
2883 struct usb_interface
*iface
;
2887 /* find audiocontrol interface */
2888 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
2889 if (!(p1
= snd_usb_find_csint_desc(host_iface
->extra
, host_iface
->extralen
, NULL
, HEADER
))) {
2890 snd_printk(KERN_ERR
"cannot find HEADER\n");
2893 if (! p1
[7] || p1
[0] < 8 + p1
[7]) {
2894 snd_printk(KERN_ERR
"invalid HEADER\n");
2899 * parse all USB audio streaming interfaces
2901 for (i
= 0; i
< p1
[7]; i
++) {
2902 struct usb_host_interface
*alts
;
2903 struct usb_interface_descriptor
*altsd
;
2905 iface
= usb_ifnum_to_if(dev
, j
);
2907 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
2908 dev
->devnum
, ctrlif
, j
);
2911 if (usb_interface_claimed(iface
)) {
2912 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n", dev
->devnum
, ctrlif
, j
);
2915 alts
= &iface
->altsetting
[0];
2916 altsd
= get_iface_desc(alts
);
2917 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
2918 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
2919 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDI_STREAMING
) {
2920 int err
= snd_usbmidi_create(chip
->card
, iface
,
2921 &chip
->midi_list
, NULL
);
2923 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n", dev
->devnum
, ctrlif
, j
);
2926 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
2929 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
2930 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
2931 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIO_STREAMING
) {
2932 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n", dev
->devnum
, ctrlif
, j
, altsd
->bInterfaceClass
);
2933 /* skip non-supported classes */
2936 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
2937 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
2940 if (! parse_audio_endpoints(chip
, j
)) {
2941 usb_set_interface(dev
, j
, 0); /* reset the current interface */
2942 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
2950 * create a stream for an endpoint/altsetting without proper descriptors
2952 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
2953 struct usb_interface
*iface
,
2954 const struct snd_usb_audio_quirk
*quirk
)
2956 struct audioformat
*fp
;
2957 struct usb_host_interface
*alts
;
2959 unsigned *rate_table
= NULL
;
2961 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
2963 snd_printk(KERN_ERR
"cannot memdup\n");
2966 if (fp
->nr_rates
> 0) {
2967 rate_table
= kmalloc(sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
2972 memcpy(rate_table
, fp
->rate_table
, sizeof(int) * fp
->nr_rates
);
2973 fp
->rate_table
= rate_table
;
2976 stream
= (fp
->endpoint
& USB_DIR_IN
)
2977 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
2978 err
= add_audio_endpoint(chip
, stream
, fp
);
2984 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
2985 fp
->altset_idx
>= iface
->num_altsetting
) {
2990 alts
= &iface
->altsetting
[fp
->altset_idx
];
2991 fp
->datainterval
= parse_datainterval(chip
, alts
);
2992 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
2993 usb_set_interface(chip
->dev
, fp
->iface
, 0);
2994 init_usb_pitch(chip
->dev
, fp
->iface
, alts
, fp
);
2995 init_usb_sample_rate(chip
->dev
, fp
->iface
, alts
, fp
, fp
->rate_max
);
3000 * create a stream for an interface with proper descriptors
3002 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
3003 struct usb_interface
*iface
,
3004 const struct snd_usb_audio_quirk
*quirk
)
3006 struct usb_host_interface
*alts
;
3007 struct usb_interface_descriptor
*altsd
;
3010 alts
= &iface
->altsetting
[0];
3011 altsd
= get_iface_desc(alts
);
3012 err
= parse_audio_endpoints(chip
, altsd
->bInterfaceNumber
);
3014 snd_printk(KERN_ERR
"cannot setup if %d: error %d\n",
3015 altsd
->bInterfaceNumber
, err
);
3018 /* reset the current interface */
3019 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
3024 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
3025 * The only way to detect the sample rate is by looking at wMaxPacketSize.
3027 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
3028 struct usb_interface
*iface
,
3029 const struct snd_usb_audio_quirk
*quirk
)
3031 static const struct audioformat ua_format
= {
3032 .format
= SNDRV_PCM_FORMAT_S24_3LE
,
3034 .fmt_type
= USB_FORMAT_TYPE_I
,
3037 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3039 struct usb_host_interface
*alts
;
3040 struct usb_interface_descriptor
*altsd
;
3041 struct audioformat
*fp
;
3044 /* both PCM and MIDI interfaces have 2 or more altsettings */
3045 if (iface
->num_altsetting
< 2)
3047 alts
= &iface
->altsetting
[1];
3048 altsd
= get_iface_desc(alts
);
3050 if (altsd
->bNumEndpoints
== 2) {
3051 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
3052 .out_cables
= 0x0003,
3055 static const struct snd_usb_audio_quirk ua700_quirk
= {
3056 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3059 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
3060 .out_cables
= 0x0001,
3063 static const struct snd_usb_audio_quirk uaxx_quirk
= {
3064 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
3067 const struct snd_usb_audio_quirk
*quirk
=
3068 chip
->usb_id
== USB_ID(0x0582, 0x002b)
3069 ? &ua700_quirk
: &uaxx_quirk
;
3070 return snd_usbmidi_create(chip
->card
, iface
,
3071 &chip
->midi_list
, quirk
);
3074 if (altsd
->bNumEndpoints
!= 1)
3077 fp
= kmalloc(sizeof(*fp
), GFP_KERNEL
);
3080 memcpy(fp
, &ua_format
, sizeof(*fp
));
3082 fp
->iface
= altsd
->bInterfaceNumber
;
3083 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3084 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3085 fp
->datainterval
= 0;
3086 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3088 switch (fp
->maxpacksize
) {
3090 fp
->rate_max
= fp
->rate_min
= 44100;
3094 fp
->rate_max
= fp
->rate_min
= 48000;
3098 fp
->rate_max
= fp
->rate_min
= 96000;
3101 snd_printk(KERN_ERR
"unknown sample rate\n");
3106 stream
= (fp
->endpoint
& USB_DIR_IN
)
3107 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3108 err
= add_audio_endpoint(chip
, stream
, fp
);
3113 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3118 * Create a stream for an Edirol UA-1000 interface.
3120 static int create_ua1000_quirk(struct snd_usb_audio
*chip
,
3121 struct usb_interface
*iface
,
3122 const struct snd_usb_audio_quirk
*quirk
)
3124 static const struct audioformat ua1000_format
= {
3125 .format
= SNDRV_PCM_FORMAT_S32_LE
,
3126 .fmt_type
= USB_FORMAT_TYPE_I
,
3130 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
3132 struct usb_host_interface
*alts
;
3133 struct usb_interface_descriptor
*altsd
;
3134 struct audioformat
*fp
;
3137 if (iface
->num_altsetting
!= 2)
3139 alts
= &iface
->altsetting
[1];
3140 altsd
= get_iface_desc(alts
);
3141 if (alts
->extralen
!= 11 || alts
->extra
[1] != USB_DT_CS_INTERFACE
||
3142 altsd
->bNumEndpoints
!= 1)
3145 fp
= kmemdup(&ua1000_format
, sizeof(*fp
), GFP_KERNEL
);
3149 fp
->channels
= alts
->extra
[4];
3150 fp
->iface
= altsd
->bInterfaceNumber
;
3151 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
3152 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
3153 fp
->datainterval
= parse_datainterval(chip
, alts
);
3154 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
3155 fp
->rate_max
= fp
->rate_min
= combine_triple(&alts
->extra
[8]);
3157 stream
= (fp
->endpoint
& USB_DIR_IN
)
3158 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
3159 err
= add_audio_endpoint(chip
, stream
, fp
);
3164 /* FIXME: playback must be synchronized to capture */
3165 usb_set_interface(chip
->dev
, fp
->iface
, 0);
3169 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3170 struct usb_interface
*iface
,
3171 const struct snd_usb_audio_quirk
*quirk
);
3174 * handle the quirks for the contained interfaces
3176 static int create_composite_quirk(struct snd_usb_audio
*chip
,
3177 struct usb_interface
*iface
,
3178 const struct snd_usb_audio_quirk
*quirk
)
3180 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
3183 for (quirk
= quirk
->data
; quirk
->ifnum
>= 0; ++quirk
) {
3184 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
3187 if (quirk
->ifnum
!= probed_ifnum
&&
3188 usb_interface_claimed(iface
))
3190 err
= snd_usb_create_quirk(chip
, iface
, quirk
);
3193 if (quirk
->ifnum
!= probed_ifnum
)
3194 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
3199 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
3200 struct usb_interface
*iface
,
3201 const struct snd_usb_audio_quirk
*quirk
)
3207 * Allow alignment on audio sub-slot (channel samples) rather than
3208 * on audio slots (audio frames)
3210 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
3211 struct usb_interface
*iface
,
3212 const struct snd_usb_audio_quirk
*quirk
)
3214 chip
->txfr_quirk
= 1;
3215 return 1; /* Continue with creating streams and mixer */
3223 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3224 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3226 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
3228 struct usb_host_config
*config
= dev
->actconfig
;
3231 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
3232 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
3233 snd_printdd("sending Extigy boot sequence...\n");
3234 /* Send message to force it to reconnect with full interface. */
3235 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
3236 0x10, 0x43, 0x0001, 0x000a, NULL
, 0, 1000);
3237 if (err
< 0) snd_printdd("error sending boot message: %d\n", err
);
3238 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
3239 &dev
->descriptor
, sizeof(dev
->descriptor
));
3240 config
= dev
->actconfig
;
3241 if (err
< 0) snd_printdd("error usb_get_descriptor: %d\n", err
);
3242 err
= usb_reset_configuration(dev
);
3243 if (err
< 0) snd_printdd("error usb_reset_configuration: %d\n", err
);
3244 snd_printdd("extigy_boot: new boot length = %d\n",
3245 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
3246 return -ENODEV
; /* quit this anyway */
3251 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
3255 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
3256 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3257 0, 0, &buf
, 1, 1000);
3259 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
3260 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
3261 1, 2000, NULL
, 0, 1000);
3268 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3269 * documented in the device's data sheet.
3271 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
3275 buf
[1] = value
& 0xff;
3276 buf
[2] = (value
>> 8) & 0xff;
3278 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
3279 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
3280 0, 0, &buf
, 4, 1000);
3283 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
3286 * Enable line-out driver mode, set headphone source to front
3287 * channels, enable stereo mic.
3289 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
3293 * C-Media CM6206 is based on CM106 with two additional
3294 * registers that are not documented in the data sheet.
3295 * Values here are chosen based on sniffing USB traffic
3298 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
3301 int val
[] = {0x200c, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
3303 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
3304 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
3315 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3316 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3317 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3318 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3319 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3320 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3321 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3322 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3323 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3324 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3326 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
3327 int iface
, int altno
)
3329 /* Reset ALL ifaces to 0 altsetting.
3330 * Call it for every possible altsetting of every interface.
3332 usb_set_interface(chip
->dev
, iface
, 0);
3334 if (device_setup
[chip
->index
] & AUDIOPHILE_SET
) {
3335 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_DTS
)
3337 return 1; /* skip this altsetting */
3338 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_96K
)
3340 return 1; /* skip this altsetting */
3341 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3342 AUDIOPHILE_SET_24B_48K_DI
&& altno
!= 2)
3343 return 1; /* skip this altsetting */
3344 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3345 AUDIOPHILE_SET_24B_48K_NOTDI
&& altno
!= 3)
3346 return 1; /* skip this altsetting */
3347 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3348 AUDIOPHILE_SET_16B_48K_DI
&& altno
!= 4)
3349 return 1; /* skip this altsetting */
3350 if ((device_setup
[chip
->index
] & AUDIOPHILE_SET_MASK
) ==
3351 AUDIOPHILE_SET_16B_48K_NOTDI
&& altno
!= 5)
3352 return 1; /* skip this altsetting */
3354 return 0; /* keep this altsetting */
3357 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
3358 struct usb_interface
*intf
,
3359 const struct snd_usb_audio_quirk
*quirk
)
3361 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
3365 * audio-interface quirks
3367 * returns zero if no standard audio/MIDI parsing is needed.
3368 * returns a postive value if standard audio/midi interfaces are parsed
3370 * returns a negative value at error.
3372 static int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
3373 struct usb_interface
*iface
,
3374 const struct snd_usb_audio_quirk
*quirk
)
3376 typedef int (*quirk_func_t
)(struct snd_usb_audio
*, struct usb_interface
*,
3377 const struct snd_usb_audio_quirk
*);
3378 static const quirk_func_t quirk_funcs
[] = {
3379 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
3380 [QUIRK_COMPOSITE
] = create_composite_quirk
,
3381 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
3382 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
3383 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
3384 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
3385 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
3386 [QUIRK_MIDI_FASTLANE
] = create_any_midi_quirk
,
3387 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
3388 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
3389 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
3390 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
3391 [QUIRK_AUDIO_EDIROL_UA1000
] = create_ua1000_quirk
,
3392 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
3393 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
3396 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
3397 return quirk_funcs
[quirk
->type
](chip
, iface
, quirk
);
3399 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
3406 * common proc files to show the usb device info
3408 static void proc_audio_usbbus_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3410 struct snd_usb_audio
*chip
= entry
->private_data
;
3411 if (!chip
->shutdown
)
3412 snd_iprintf(buffer
, "%03d/%03d\n", chip
->dev
->bus
->busnum
, chip
->dev
->devnum
);
3415 static void proc_audio_usbid_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
3417 struct snd_usb_audio
*chip
= entry
->private_data
;
3418 if (!chip
->shutdown
)
3419 snd_iprintf(buffer
, "%04x:%04x\n",
3420 USB_ID_VENDOR(chip
->usb_id
),
3421 USB_ID_PRODUCT(chip
->usb_id
));
3424 static void snd_usb_audio_create_proc(struct snd_usb_audio
*chip
)
3426 struct snd_info_entry
*entry
;
3427 if (!snd_card_proc_new(chip
->card
, "usbbus", &entry
))
3428 snd_info_set_text_ops(entry
, chip
, proc_audio_usbbus_read
);
3429 if (!snd_card_proc_new(chip
->card
, "usbid", &entry
))
3430 snd_info_set_text_ops(entry
, chip
, proc_audio_usbid_read
);
3434 * free the chip instance
3436 * here we have to do not much, since pcm and controls are already freed
3440 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
3446 static int snd_usb_audio_dev_free(struct snd_device
*device
)
3448 struct snd_usb_audio
*chip
= device
->device_data
;
3449 return snd_usb_audio_free(chip
);
3454 * create a chip instance and set its names.
3456 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
3457 const struct snd_usb_audio_quirk
*quirk
,
3458 struct snd_usb_audio
**rchip
)
3460 struct snd_card
*card
;
3461 struct snd_usb_audio
*chip
;
3464 static struct snd_device_ops ops
= {
3465 .dev_free
= snd_usb_audio_dev_free
,
3470 if (snd_usb_get_speed(dev
) != USB_SPEED_LOW
&&
3471 snd_usb_get_speed(dev
) != USB_SPEED_FULL
&&
3472 snd_usb_get_speed(dev
) != USB_SPEED_HIGH
) {
3473 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
3477 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
3479 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
3483 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
3485 snd_card_free(card
);
3492 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3493 le16_to_cpu(dev
->descriptor
.idProduct
));
3494 INIT_LIST_HEAD(&chip
->pcm_list
);
3495 INIT_LIST_HEAD(&chip
->midi_list
);
3496 INIT_LIST_HEAD(&chip
->mixer_list
);
3498 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
3499 snd_usb_audio_free(chip
);
3500 snd_card_free(card
);
3504 strcpy(card
->driver
, "USB-Audio");
3505 sprintf(component
, "USB%04x:%04x",
3506 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
3507 snd_component_add(card
, component
);
3509 /* retrieve the device string as shortname */
3510 if (quirk
&& quirk
->product_name
) {
3511 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
3513 if (!dev
->descriptor
.iProduct
||
3514 usb_string(dev
, dev
->descriptor
.iProduct
,
3515 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
3516 /* no name available from anywhere, so use ID */
3517 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
3518 USB_ID_VENDOR(chip
->usb_id
),
3519 USB_ID_PRODUCT(chip
->usb_id
));
3523 /* retrieve the vendor and device strings as longname */
3524 if (quirk
&& quirk
->vendor_name
) {
3525 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
3527 if (dev
->descriptor
.iManufacturer
)
3528 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
3529 card
->longname
, sizeof(card
->longname
));
3532 /* we don't really care if there isn't any vendor string */
3535 strlcat(card
->longname
, " ", sizeof(card
->longname
));
3537 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
3539 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
3541 if (len
< sizeof(card
->longname
))
3542 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
3544 strlcat(card
->longname
,
3545 snd_usb_get_speed(dev
) == USB_SPEED_LOW
? ", low speed" :
3546 snd_usb_get_speed(dev
) == USB_SPEED_FULL
? ", full speed" :
3548 sizeof(card
->longname
));
3550 snd_usb_audio_create_proc(chip
);
3558 * probe the active usb device
3560 * note that this can be called multiple times per a device, when it
3561 * includes multiple audio control interfaces.
3563 * thus we check the usb device pointer and creates the card instance
3564 * only at the first time. the successive calls of this function will
3565 * append the pcm interface to the corresponding card.
3567 static void *snd_usb_audio_probe(struct usb_device
*dev
,
3568 struct usb_interface
*intf
,
3569 const struct usb_device_id
*usb_id
)
3571 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
3573 struct snd_usb_audio
*chip
;
3574 struct usb_host_interface
*alts
;
3578 alts
= &intf
->altsetting
[0];
3579 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
3580 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
3581 le16_to_cpu(dev
->descriptor
.idProduct
));
3583 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
3586 /* SB Extigy needs special boot-up sequence */
3587 /* if more models come, this will go to the quirk list. */
3588 if (id
== USB_ID(0x041e, 0x3000)) {
3589 if (snd_usb_extigy_boot_quirk(dev
, intf
) < 0)
3592 /* SB Audigy 2 NX needs its own boot-up magic, too */
3593 if (id
== USB_ID(0x041e, 0x3020)) {
3594 if (snd_usb_audigy2nx_boot_quirk(dev
) < 0)
3598 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3599 if (id
== USB_ID(0x10f5, 0x0200)) {
3600 if (snd_usb_cm106_boot_quirk(dev
) < 0)
3604 /* C-Media CM6206 / CM106-Like Sound Device */
3605 if (id
== USB_ID(0x0d8c, 0x0102)) {
3606 if (snd_usb_cm6206_boot_quirk(dev
) < 0)
3611 * found a config. now register to ALSA
3614 /* check whether it's already registered */
3616 mutex_lock(®ister_mutex
);
3617 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
3618 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
3619 if (usb_chip
[i
]->shutdown
) {
3620 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
3628 /* it's a fresh one.
3629 * now look for an empty slot and create a new card instance
3631 for (i
= 0; i
< SNDRV_CARDS
; i
++)
3632 if (enable
[i
] && ! usb_chip
[i
] &&
3633 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
3634 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
3635 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
3638 snd_card_set_dev(chip
->card
, &intf
->dev
);
3642 printk(KERN_ERR
"no available usb audio device\n");
3647 chip
->txfr_quirk
= 0;
3648 err
= 1; /* continue */
3649 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
3650 /* need some special handlings */
3651 if ((err
= snd_usb_create_quirk(chip
, intf
, quirk
)) < 0)
3656 /* create normal USB audio interfaces */
3657 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
3658 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
3663 /* we are allowed to call snd_card_register() many times */
3664 if (snd_card_register(chip
->card
) < 0) {
3668 usb_chip
[chip
->index
] = chip
;
3669 chip
->num_interfaces
++;
3670 mutex_unlock(®ister_mutex
);
3674 if (chip
&& !chip
->num_interfaces
)
3675 snd_card_free(chip
->card
);
3676 mutex_unlock(®ister_mutex
);
3682 * we need to take care of counter, since disconnection can be called also
3683 * many times as well as usb_audio_probe().
3685 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
3687 struct snd_usb_audio
*chip
;
3688 struct snd_card
*card
;
3689 struct list_head
*p
;
3691 if (ptr
== (void *)-1L)
3696 mutex_lock(®ister_mutex
);
3698 chip
->num_interfaces
--;
3699 if (chip
->num_interfaces
<= 0) {
3700 snd_card_disconnect(card
);
3701 /* release the pcm resources */
3702 list_for_each(p
, &chip
->pcm_list
) {
3703 snd_usb_stream_disconnect(p
);
3705 /* release the midi resources */
3706 list_for_each(p
, &chip
->midi_list
) {
3707 snd_usbmidi_disconnect(p
);
3709 /* release mixer resources */
3710 list_for_each(p
, &chip
->mixer_list
) {
3711 snd_usb_mixer_disconnect(p
);
3713 usb_chip
[chip
->index
] = NULL
;
3714 mutex_unlock(®ister_mutex
);
3715 snd_card_free_when_closed(card
);
3717 mutex_unlock(®ister_mutex
);
3722 * new 2.5 USB kernel API
3724 static int usb_audio_probe(struct usb_interface
*intf
,
3725 const struct usb_device_id
*id
)
3728 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
3730 usb_set_intfdata(intf
, chip
);
3736 static void usb_audio_disconnect(struct usb_interface
*intf
)
3738 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
3739 usb_get_intfdata(intf
));
3743 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
3745 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
3746 struct list_head
*p
;
3747 struct snd_usb_stream
*as
;
3749 if (chip
== (void *)-1L)
3752 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
3753 if (!chip
->num_suspended_intf
++) {
3754 list_for_each(p
, &chip
->pcm_list
) {
3755 as
= list_entry(p
, struct snd_usb_stream
, list
);
3756 snd_pcm_suspend_all(as
->pcm
);
3763 static int usb_audio_resume(struct usb_interface
*intf
)
3765 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
3767 if (chip
== (void *)-1L)
3769 if (--chip
->num_suspended_intf
)
3772 * ALSA leaves material resumption to user space
3776 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
3780 #endif /* CONFIG_PM */
3782 static int __init
snd_usb_audio_init(void)
3784 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
3785 printk(KERN_WARNING
"invalid nrpacks value.\n");
3788 return usb_register(&usb_audio_driver
);
3792 static void __exit
snd_usb_audio_cleanup(void)
3794 usb_deregister(&usb_audio_driver
);
3797 module_init(snd_usb_audio_init
);
3798 module_exit(snd_usb_audio_cleanup
);