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 <sound/driver.h>
42 #include <linux/bitops.h>
43 #include <linux/init.h>
44 #include <linux/list.h>
45 #include <linux/slab.h>
46 #include <linux/string.h>
47 #include <linux/usb.h>
48 #include <linux/moduleparam.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 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
68 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
69 static int nrpacks = 4; /* max. number of packets per urb */
70 static int async_unlink = 1;
72 module_param_array(index, int, NULL, 0444);
73 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
74 module_param_array(id, charp, NULL, 0444);
75 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
76 module_param_array(enable, bool, NULL, 0444);
77 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
78 module_param_array(vid, int, NULL, 0444);
79 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
80 module_param_array(pid, int, NULL, 0444);
81 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
82 module_param(nrpacks, int, 0444);
83 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
84 module_param(async_unlink, bool, 0444);
85 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
89 * debug the h/w constraints
91 /* #define HW_CONST_DEBUG */
99 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
100 #define MAX_URBS 5 /* max. 20ms long packets */
101 #define SYNC_URBS 2 /* always two urbs for sync */
102 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
104 typedef struct snd_usb_substream snd_usb_substream_t;
105 typedef struct snd_usb_stream snd_usb_stream_t;
106 typedef struct snd_urb_ctx snd_urb_ctx_t;
109 struct list_head list;
110 snd_pcm_format_t format; /* format type */
111 unsigned int channels; /* # channels */
112 unsigned int fmt_type; /* USB audio format type (1-3) */
113 unsigned int frame_size; /* samples per frame for non-audio */
114 int iface; /* interface number */
115 unsigned char altsetting; /* corresponding alternate setting */
116 unsigned char altset_idx; /* array index of altenate setting */
117 unsigned char attributes; /* corresponding attributes of cs endpoint */
118 unsigned char endpoint; /* endpoint */
119 unsigned char ep_attr; /* endpoint attributes */
120 unsigned int maxpacksize; /* max. packet size */
121 unsigned int rates; /* rate bitmasks */
122 unsigned int rate_min, rate_max; /* min/max rates */
123 unsigned int nr_rates; /* number of rate table entries */
124 unsigned int *rate_table; /* rate table */
129 snd_usb_substream_t *subs;
130 int index; /* index for urb array */
131 int packets; /* number of packets per urb */
132 int transfer; /* transferred size */
133 char *buf; /* buffer for capture */
137 int (*prepare)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
138 int (*retire)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
139 int (*prepare_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
140 int (*retire_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
143 struct snd_usb_substream {
144 snd_usb_stream_t *stream;
145 struct usb_device *dev;
146 snd_pcm_substream_t *pcm_substream;
147 int direction; /* playback or capture */
148 int interface; /* current interface */
149 int endpoint; /* assigned endpoint */
150 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
151 unsigned int cur_rate; /* current rate (for hw_params callback) */
152 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
153 unsigned int format; /* USB data format */
154 unsigned int datapipe; /* the data i/o pipe */
155 unsigned int syncpipe; /* 1 - async out or adaptive in */
156 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
157 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
158 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
159 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
160 unsigned int phase; /* phase accumulator */
161 unsigned int maxpacksize; /* max packet size in bytes */
162 unsigned int maxframesize; /* max packet size in frames */
163 unsigned int curpacksize; /* current packet size in bytes (for capture) */
164 unsigned int curframesize; /* current packet size in frames (for capture) */
165 unsigned int fill_max: 1; /* fill max packet size always */
166 unsigned int fmt_type; /* USB audio format type (1-3) */
168 unsigned int running: 1; /* running status */
170 unsigned int hwptr; /* free frame position in the buffer (only for playback) */
171 unsigned int hwptr_done; /* processed frame position in the buffer */
172 unsigned int transfer_sched; /* scheduled frames since last period (for playback) */
173 unsigned int transfer_done; /* processed frames since last period update */
174 unsigned long active_mask; /* bitmask of active urbs */
175 unsigned long unlink_mask; /* bitmask of unlinked urbs */
177 unsigned int nurbs; /* # urbs */
178 snd_urb_ctx_t dataurb[MAX_URBS]; /* data urb table */
179 snd_urb_ctx_t syncurb[SYNC_URBS]; /* sync urb table */
180 char syncbuf[SYNC_URBS * 4]; /* sync buffer; it's so small - let's get static */
181 char *tmpbuf; /* temporary buffer for playback */
183 u64 formats; /* format bitmasks (all or'ed) */
184 unsigned int num_formats; /* number of supported audio formats (list) */
185 struct list_head fmt_list; /* format list */
188 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
192 struct snd_usb_stream {
193 snd_usb_audio_t *chip;
196 unsigned int fmt_type; /* USB audio format type (1-3) */
197 snd_usb_substream_t substream[2];
198 struct list_head list;
203 * we keep the snd_usb_audio_t instances by ourselves for merging
204 * the all interfaces on the same card as one sound device.
207 static DECLARE_MUTEX(register_mutex);
208 static snd_usb_audio_t *usb_chip[SNDRV_CARDS];
212 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
213 * this will overflow at approx 524 kHz
215 inline static unsigned get_usb_full_speed_rate(unsigned int rate)
217 return ((rate << 13) + 62) / 125;
221 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
222 * this will overflow at approx 4 MHz
224 inline static unsigned get_usb_high_speed_rate(unsigned int rate)
226 return ((rate << 10) + 62) / 125;
229 /* convert our full speed USB rate into sampling rate in Hz */
230 inline static unsigned get_full_speed_hz(unsigned int usb_rate)
232 return (usb_rate * 125 + (1 << 12)) >> 13;
235 /* convert our high speed USB rate into sampling rate in Hz */
236 inline static unsigned get_high_speed_hz(unsigned int usb_rate)
238 return (usb_rate * 125 + (1 << 9)) >> 10;
243 * prepare urb for full speed capture sync pipe
245 * fill the length and offset of each urb descriptor.
246 * the fixed 10.14 frequency is passed through the pipe.
248 static int prepare_capture_sync_urb(snd_usb_substream_t *subs,
249 snd_pcm_runtime_t *runtime,
252 unsigned char *cp = urb->transfer_buffer;
253 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
255 urb->dev = ctx->subs->dev; /* we need to set this at each time */
256 urb->iso_frame_desc[0].length = 3;
257 urb->iso_frame_desc[0].offset = 0;
258 cp[0] = subs->freqn >> 2;
259 cp[1] = subs->freqn >> 10;
260 cp[2] = subs->freqn >> 18;
265 * prepare urb for high speed capture sync pipe
267 * fill the length and offset of each urb descriptor.
268 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
270 static int prepare_capture_sync_urb_hs(snd_usb_substream_t *subs,
271 snd_pcm_runtime_t *runtime,
274 unsigned char *cp = urb->transfer_buffer;
275 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
277 urb->dev = ctx->subs->dev; /* we need to set this at each time */
278 urb->iso_frame_desc[0].length = 4;
279 urb->iso_frame_desc[0].offset = 0;
281 cp[1] = subs->freqn >> 8;
282 cp[2] = subs->freqn >> 16;
283 cp[3] = subs->freqn >> 24;
288 * process after capture sync complete
291 static int retire_capture_sync_urb(snd_usb_substream_t *subs,
292 snd_pcm_runtime_t *runtime,
299 * prepare urb for capture data pipe
301 * fill the offset and length of each descriptor.
303 * we use a temporary buffer to write the captured data.
304 * since the length of written data is determined by host, we cannot
305 * write onto the pcm buffer directly... the data is thus copied
306 * later at complete callback to the global buffer.
308 static int prepare_capture_urb(snd_usb_substream_t *subs,
309 snd_pcm_runtime_t *runtime,
314 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
317 urb->dev = ctx->subs->dev; /* we need to set this at each time */
318 urb->number_of_packets = 0;
319 spin_lock_irqsave(&subs->lock, flags);
320 for (i = 0; i < ctx->packets; i++) {
321 urb->iso_frame_desc[i].offset = offs;
322 urb->iso_frame_desc[i].length = subs->curpacksize;
323 offs += subs->curpacksize;
324 urb->number_of_packets++;
325 subs->transfer_sched += subs->curframesize;
326 if (subs->transfer_sched >= runtime->period_size) {
327 subs->transfer_sched -= runtime->period_size;
331 spin_unlock_irqrestore(&subs->lock, flags);
332 urb->transfer_buffer = ctx->buf;
333 urb->transfer_buffer_length = offs;
335 if (! urb->bandwidth) {
337 bustime = usb_check_bandwidth(urb->dev, urb);
340 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
341 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
348 * process after capture complete
350 * copy the data from each desctiptor to the pcm buffer, and
351 * update the current position.
353 static int retire_capture_urb(snd_usb_substream_t *subs,
354 snd_pcm_runtime_t *runtime,
360 unsigned int stride, len, oldptr;
362 stride = runtime->frame_bits >> 3;
364 for (i = 0; i < urb->number_of_packets; i++) {
365 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
366 if (urb->iso_frame_desc[i].status) {
367 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
370 len = urb->iso_frame_desc[i].actual_length / stride;
373 /* update the current pointer */
374 spin_lock_irqsave(&subs->lock, flags);
375 oldptr = subs->hwptr_done;
376 subs->hwptr_done += len;
377 if (subs->hwptr_done >= runtime->buffer_size)
378 subs->hwptr_done -= runtime->buffer_size;
379 subs->transfer_done += len;
380 spin_unlock_irqrestore(&subs->lock, flags);
381 /* copy a data chunk */
382 if (oldptr + len > runtime->buffer_size) {
383 unsigned int cnt = runtime->buffer_size - oldptr;
384 unsigned int blen = cnt * stride;
385 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
386 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
388 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
390 /* update the pointer, call callback if necessary */
391 spin_lock_irqsave(&subs->lock, flags);
392 if (subs->transfer_done >= runtime->period_size) {
393 subs->transfer_done -= runtime->period_size;
394 spin_unlock_irqrestore(&subs->lock, flags);
395 snd_pcm_period_elapsed(subs->pcm_substream);
397 spin_unlock_irqrestore(&subs->lock, flags);
404 * prepare urb for full speed playback sync pipe
406 * set up the offset and length to receive the current frequency.
409 static int prepare_playback_sync_urb(snd_usb_substream_t *subs,
410 snd_pcm_runtime_t *runtime,
413 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
415 urb->dev = ctx->subs->dev; /* we need to set this at each time */
416 urb->iso_frame_desc[0].length = 3;
417 urb->iso_frame_desc[0].offset = 0;
422 * prepare urb for high speed playback sync pipe
424 * set up the offset and length to receive the current frequency.
427 static int prepare_playback_sync_urb_hs(snd_usb_substream_t *subs,
428 snd_pcm_runtime_t *runtime,
431 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
433 urb->dev = ctx->subs->dev; /* we need to set this at each time */
434 urb->iso_frame_desc[0].length = 4;
435 urb->iso_frame_desc[0].offset = 0;
440 * process after full speed playback sync complete
442 * retrieve the current 10.14 frequency from pipe, and set it.
443 * the value is referred in prepare_playback_urb().
445 static int retire_playback_sync_urb(snd_usb_substream_t *subs,
446 snd_pcm_runtime_t *runtime,
452 if (urb->iso_frame_desc[0].status == 0 &&
453 urb->iso_frame_desc[0].actual_length == 3) {
454 f = combine_triple((u8*)urb->transfer_buffer) << 2;
456 if (f < subs->freqn - (subs->freqn>>3) || f > subs->freqmax) {
457 snd_printd(KERN_WARNING "requested frequency %d (%u,%03uHz) out of range (current nominal %d (%u,%03uHz))\n",
458 f, f >> 14, (f & ((1 << 14) - 1) * 1000) / ((1 << 14) - 1),
459 subs->freqn, subs->freqn >> 14, (subs->freqn & ((1 << 14) - 1) * 1000) / ((1 << 14) - 1));
463 spin_lock_irqsave(&subs->lock, flags);
465 spin_unlock_irqrestore(&subs->lock, flags);
472 * process after high speed playback sync complete
474 * retrieve the current 12.13 frequency from pipe, and set it.
475 * the value is referred in prepare_playback_urb().
477 static int retire_playback_sync_urb_hs(snd_usb_substream_t *subs,
478 snd_pcm_runtime_t *runtime,
484 if (urb->iso_frame_desc[0].status == 0 &&
485 urb->iso_frame_desc[0].actual_length == 4) {
486 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
487 spin_lock_irqsave(&subs->lock, flags);
489 spin_unlock_irqrestore(&subs->lock, flags);
496 * prepare urb for playback data pipe
498 * we copy the data directly from the pcm buffer.
499 * the current position to be copied is held in hwptr field.
500 * since a urb can handle only a single linear buffer, if the total
501 * transferred area overflows the buffer boundary, we cannot send
502 * it directly from the buffer. thus the data is once copied to
503 * a temporary buffer and urb points to that.
505 static int prepare_playback_urb(snd_usb_substream_t *subs,
506 snd_pcm_runtime_t *runtime,
512 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
514 stride = runtime->frame_bits >> 3;
517 urb->dev = ctx->subs->dev; /* we need to set this at each time */
518 urb->number_of_packets = 0;
519 spin_lock_irqsave(&subs->lock, flags);
520 for (i = 0; i < ctx->packets; i++) {
521 /* calculate the size of a packet */
523 counts = subs->maxframesize; /* fixed */
525 subs->phase = (subs->phase & 0xffff) + subs->freqm;
526 counts = subs->phase >> 16;
527 if (counts > subs->maxframesize)
528 counts = subs->maxframesize;
530 /* set up descriptor */
531 urb->iso_frame_desc[i].offset = offs * stride;
532 urb->iso_frame_desc[i].length = counts * stride;
534 urb->number_of_packets++;
535 subs->transfer_sched += counts;
536 if (subs->transfer_sched >= runtime->period_size) {
537 subs->transfer_sched -= runtime->period_size;
538 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
539 if (subs->transfer_sched > 0) {
540 /* FIXME: fill-max mode is not supported yet */
541 offs -= subs->transfer_sched;
542 counts -= subs->transfer_sched;
543 urb->iso_frame_desc[i].length = counts * stride;
544 subs->transfer_sched = 0;
547 if (i < ctx->packets) {
548 /* add a transfer delimiter */
549 urb->iso_frame_desc[i].offset = offs * stride;
550 urb->iso_frame_desc[i].length = 0;
551 urb->number_of_packets++;
557 if (subs->hwptr + offs > runtime->buffer_size) {
558 /* err, the transferred area goes over buffer boundary.
559 * copy the data to the temp buffer.
562 len = runtime->buffer_size - subs->hwptr;
563 urb->transfer_buffer = subs->tmpbuf;
564 memcpy(subs->tmpbuf, runtime->dma_area + subs->hwptr * stride, len * stride);
565 memcpy(subs->tmpbuf + len * stride, runtime->dma_area, (offs - len) * stride);
567 subs->hwptr -= runtime->buffer_size;
569 /* set the buffer pointer */
570 urb->transfer_buffer = runtime->dma_area + subs->hwptr * stride;
573 spin_unlock_irqrestore(&subs->lock, flags);
574 urb->transfer_buffer_length = offs * stride;
575 ctx->transfer = offs;
581 * process after playback data complete
583 * update the current position and call callback if a period is processed.
585 static int retire_playback_urb(snd_usb_substream_t *subs,
586 snd_pcm_runtime_t *runtime,
590 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
592 spin_lock_irqsave(&subs->lock, flags);
593 subs->transfer_done += ctx->transfer;
594 subs->hwptr_done += ctx->transfer;
596 if (subs->hwptr_done >= runtime->buffer_size)
597 subs->hwptr_done -= runtime->buffer_size;
598 if (subs->transfer_done >= runtime->period_size) {
599 subs->transfer_done -= runtime->period_size;
600 spin_unlock_irqrestore(&subs->lock, flags);
601 snd_pcm_period_elapsed(subs->pcm_substream);
603 spin_unlock_irqrestore(&subs->lock, flags);
610 static struct snd_urb_ops audio_urb_ops[2] = {
612 .prepare = prepare_playback_urb,
613 .retire = retire_playback_urb,
614 .prepare_sync = prepare_playback_sync_urb,
615 .retire_sync = retire_playback_sync_urb,
618 .prepare = prepare_capture_urb,
619 .retire = retire_capture_urb,
620 .prepare_sync = prepare_capture_sync_urb,
621 .retire_sync = retire_capture_sync_urb,
625 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
627 .prepare = prepare_playback_urb,
628 .retire = retire_playback_urb,
629 .prepare_sync = prepare_playback_sync_urb_hs,
630 .retire_sync = retire_playback_sync_urb_hs,
633 .prepare = prepare_capture_urb,
634 .retire = retire_capture_urb,
635 .prepare_sync = prepare_capture_sync_urb_hs,
636 .retire_sync = retire_capture_sync_urb,
641 * complete callback from data urb
643 static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
645 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
646 snd_usb_substream_t *subs = ctx->subs;
647 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
650 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
651 ! subs->running || /* can be stopped during retire callback */
652 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
653 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
654 clear_bit(ctx->index, &subs->active_mask);
656 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
657 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
664 * complete callback from sync urb
666 static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
668 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
669 snd_usb_substream_t *subs = ctx->subs;
670 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
673 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
674 ! subs->running || /* can be stopped during retire callback */
675 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
676 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
677 clear_bit(ctx->index + 16, &subs->active_mask);
679 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
680 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
687 * unlink active urbs.
689 static int deactivate_urbs(snd_usb_substream_t *subs, int force, int can_sleep)
696 if (!force && subs->stream->chip->shutdown) /* to be sure... */
699 async = !can_sleep && async_unlink;
701 if (! async && in_interrupt())
704 for (i = 0; i < subs->nurbs; i++) {
705 if (test_bit(i, &subs->active_mask)) {
706 if (! test_and_set_bit(i, &subs->unlink_mask)) {
707 struct urb *u = subs->dataurb[i].urb;
709 u->transfer_flags |= URB_ASYNC_UNLINK;
716 if (subs->syncpipe) {
717 for (i = 0; i < SYNC_URBS; i++) {
718 if (test_bit(i+16, &subs->active_mask)) {
719 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
720 struct urb *u = subs->syncurb[i].urb;
722 u->transfer_flags |= URB_ASYNC_UNLINK;
735 * set up and start data/sync urbs
737 static int start_urbs(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime)
742 if (subs->stream->chip->shutdown)
745 for (i = 0; i < subs->nurbs; i++) {
746 snd_assert(subs->dataurb[i].urb, return -EINVAL);
747 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
748 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
752 if (subs->syncpipe) {
753 for (i = 0; i < SYNC_URBS; i++) {
754 snd_assert(subs->syncurb[i].urb, return -EINVAL);
755 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
756 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
762 subs->active_mask = 0;
763 subs->unlink_mask = 0;
765 for (i = 0; i < subs->nurbs; i++) {
766 if ((err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC)) < 0) {
767 snd_printk(KERN_ERR "cannot submit datapipe for urb %d, err = %d\n", i, err);
770 set_bit(i, &subs->active_mask);
772 if (subs->syncpipe) {
773 for (i = 0; i < SYNC_URBS; i++) {
774 if ((err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC)) < 0) {
775 snd_printk(KERN_ERR "cannot submit syncpipe for urb %d, err = %d\n", i, err);
778 set_bit(i + 16, &subs->active_mask);
784 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
785 deactivate_urbs(subs, 0, 0);
791 * wait until all urbs are processed.
793 static int wait_clear_urbs(snd_usb_substream_t *subs)
801 for (i = 0; i < subs->nurbs; i++) {
802 if (test_bit(i, &subs->active_mask))
805 if (subs->syncpipe) {
806 for (i = 0; i < SYNC_URBS; i++) {
807 if (test_bit(i + 16, &subs->active_mask))
813 set_current_state(TASK_UNINTERRUPTIBLE);
815 } while (--timeout > 0);
817 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
823 * return the current pcm pointer. just return the hwptr_done value.
825 static snd_pcm_uframes_t snd_usb_pcm_pointer(snd_pcm_substream_t *substream)
827 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
828 return subs->hwptr_done;
833 * start/stop substream
835 static int snd_usb_pcm_trigger(snd_pcm_substream_t *substream, int cmd)
837 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
841 case SNDRV_PCM_TRIGGER_START:
842 err = start_urbs(subs, substream->runtime);
844 case SNDRV_PCM_TRIGGER_STOP:
845 err = deactivate_urbs(subs, 0, 0);
851 return err < 0 ? err : 0;
858 static void release_urb_ctx(snd_urb_ctx_t *u)
861 usb_free_urb(u->urb);
871 * release a substream
873 static void release_substream_urbs(snd_usb_substream_t *subs, int force)
877 /* stop urbs (to be sure) */
878 deactivate_urbs(subs, force, 1);
879 wait_clear_urbs(subs);
881 for (i = 0; i < MAX_URBS; i++)
882 release_urb_ctx(&subs->dataurb[i]);
883 for (i = 0; i < SYNC_URBS; i++)
884 release_urb_ctx(&subs->syncurb[i]);
893 * initialize a substream for plaback/capture
895 static int init_substream_urbs(snd_usb_substream_t *subs, unsigned int period_bytes,
896 unsigned int rate, unsigned int frame_bits)
898 unsigned int maxsize, n, i;
899 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
900 unsigned int npacks[MAX_URBS], urb_packs, total_packs;
902 /* calculate the frequency in 16.16 format */
903 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
904 subs->freqn = get_usb_full_speed_rate(rate);
906 subs->freqn = get_usb_high_speed_rate(rate);
907 subs->freqm = subs->freqn;
908 subs->freqmax = subs->freqn + (subs->freqn >> 2); /* max. allowed frequency */
911 /* calculate the max. size of packet */
912 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3)) >> 16;
913 if (subs->maxpacksize && maxsize > subs->maxpacksize) {
914 //snd_printd(KERN_DEBUG "maxsize %d is greater than defined size %d\n",
915 // maxsize, subs->maxpacksize);
916 maxsize = subs->maxpacksize;
920 subs->curpacksize = subs->maxpacksize;
922 subs->curpacksize = maxsize;
924 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
927 urb_packs = nrpacks * 8;
929 /* allocate a temporary buffer for playback */
931 subs->tmpbuf = kmalloc(maxsize * urb_packs, GFP_KERNEL);
932 if (! subs->tmpbuf) {
933 snd_printk(KERN_ERR "cannot malloc tmpbuf\n");
938 /* decide how many packets to be used */
939 total_packs = (period_bytes + maxsize - 1) / maxsize;
940 if (total_packs < 2 * MIN_PACKS_URB)
941 total_packs = 2 * MIN_PACKS_URB;
942 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
943 if (subs->nurbs > MAX_URBS) {
945 subs->nurbs = MAX_URBS;
946 total_packs = MAX_URBS * urb_packs;
949 for (i = 0; i < subs->nurbs; i++) {
950 npacks[i] = n > urb_packs ? urb_packs : n;
953 if (subs->nurbs <= 1) {
954 /* too little - we need at least two packets
955 * to ensure contiguous playback/capture
958 npacks[0] = (total_packs + 1) / 2;
959 npacks[1] = total_packs - npacks[0];
960 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB) {
961 /* the last packet is too small.. */
962 if (subs->nurbs > 2) {
963 /* merge to the first one */
964 npacks[0] += npacks[subs->nurbs - 1];
969 npacks[0] = (total_packs + 1) / 2;
970 npacks[1] = total_packs - npacks[0];
974 /* allocate and initialize data urbs */
975 for (i = 0; i < subs->nurbs; i++) {
976 snd_urb_ctx_t *u = &subs->dataurb[i];
980 u->packets = npacks[i];
981 if (subs->fmt_type == USB_FORMAT_TYPE_II)
982 u->packets++; /* for transfer delimiter */
984 /* allocate a capture buffer per urb */
985 u->buf = kmalloc(maxsize * u->packets, GFP_KERNEL);
987 release_substream_urbs(subs, 0);
991 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
993 release_substream_urbs(subs, 0);
996 u->urb->dev = subs->dev;
997 u->urb->pipe = subs->datapipe;
998 u->urb->transfer_flags = URB_ISO_ASAP;
999 u->urb->number_of_packets = u->packets;
1000 u->urb->interval = 1;
1001 u->urb->context = u;
1002 u->urb->complete = snd_usb_complete_callback(snd_complete_urb);
1005 if (subs->syncpipe) {
1006 /* allocate and initialize sync urbs */
1007 for (i = 0; i < SYNC_URBS; i++) {
1008 snd_urb_ctx_t *u = &subs->syncurb[i];
1012 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1014 release_substream_urbs(subs, 0);
1017 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1018 u->urb->transfer_buffer_length = 4;
1019 u->urb->dev = subs->dev;
1020 u->urb->pipe = subs->syncpipe;
1021 u->urb->transfer_flags = URB_ISO_ASAP;
1022 u->urb->number_of_packets = 1;
1023 u->urb->interval = 1 << subs->syncinterval;
1024 u->urb->context = u;
1025 u->urb->complete = snd_usb_complete_callback(snd_complete_sync_urb);
1033 * find a matching audio format
1035 static struct audioformat *find_format(snd_usb_substream_t *subs, unsigned int format,
1036 unsigned int rate, unsigned int channels)
1038 struct list_head *p;
1039 struct audioformat *found = NULL;
1040 int cur_attr = 0, attr;
1042 list_for_each(p, &subs->fmt_list) {
1043 struct audioformat *fp;
1044 fp = list_entry(p, struct audioformat, list);
1045 if (fp->format != format || fp->channels != channels)
1047 if (rate < fp->rate_min || rate > fp->rate_max)
1049 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1051 for (i = 0; i < fp->nr_rates; i++)
1052 if (fp->rate_table[i] == rate)
1054 if (i >= fp->nr_rates)
1057 attr = fp->ep_attr & EP_ATTR_MASK;
1063 /* avoid async out and adaptive in if the other method
1064 * supports the same format.
1065 * this is a workaround for the case like
1066 * M-audio audiophile USB.
1068 if (attr != cur_attr) {
1069 if ((attr == EP_ATTR_ASYNC &&
1070 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1071 (attr == EP_ATTR_ADAPTIVE &&
1072 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1074 if ((cur_attr == EP_ATTR_ASYNC &&
1075 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1076 (cur_attr == EP_ATTR_ADAPTIVE &&
1077 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1083 /* find the format with the largest max. packet size */
1084 if (fp->maxpacksize > found->maxpacksize) {
1094 * initialize the picth control and sample rate
1096 static int init_usb_pitch(struct usb_device *dev, int iface,
1097 struct usb_host_interface *alts,
1098 struct audioformat *fmt)
1101 unsigned char data[1];
1104 ep = get_endpoint(alts, 0)->bEndpointAddress;
1105 /* if endpoint has pitch control, enable it */
1106 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1108 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1109 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1110 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1111 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1112 dev->devnum, iface, ep);
1119 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1120 struct usb_host_interface *alts,
1121 struct audioformat *fmt, int rate)
1124 unsigned char data[3];
1127 ep = get_endpoint(alts, 0)->bEndpointAddress;
1128 /* if endpoint has sampling rate control, set it */
1129 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1132 data[1] = rate >> 8;
1133 data[2] = rate >> 16;
1134 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1135 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1136 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1137 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1138 dev->devnum, iface, fmt->altsetting, rate, ep);
1141 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1142 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1143 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1144 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1145 dev->devnum, iface, fmt->altsetting, ep);
1146 return 0; /* some devices don't support reading */
1148 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1149 if (crate != rate) {
1150 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1151 // runtime->rate = crate;
1158 * find a matching format and set up the interface
1160 static int set_format(snd_usb_substream_t *subs, struct audioformat *fmt)
1162 struct usb_device *dev = subs->dev;
1163 struct usb_host_interface *alts;
1164 struct usb_interface_descriptor *altsd;
1165 struct usb_interface *iface;
1166 unsigned int ep, attr;
1167 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1170 iface = usb_ifnum_to_if(dev, fmt->iface);
1171 snd_assert(iface, return -EINVAL);
1172 alts = &iface->altsetting[fmt->altset_idx];
1173 altsd = get_iface_desc(alts);
1174 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1176 if (fmt == subs->cur_audiofmt)
1179 /* close the old interface */
1180 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1181 usb_set_interface(subs->dev, subs->interface, 0);
1182 subs->interface = -1;
1187 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1188 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1189 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1190 dev->devnum, fmt->iface, fmt->altsetting);
1193 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1194 subs->interface = fmt->iface;
1195 subs->format = fmt->altset_idx;
1198 /* create a data pipe */
1199 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1201 subs->datapipe = usb_sndisocpipe(dev, ep);
1203 subs->datapipe = usb_rcvisocpipe(dev, ep);
1204 subs->syncpipe = subs->syncinterval = 0;
1205 subs->maxpacksize = fmt->maxpacksize;
1208 /* we need a sync pipe in async OUT or adaptive IN mode */
1209 /* check the number of EP, since some devices have broken
1210 * descriptors which fool us. if it has only one EP,
1211 * assume it as adaptive-out or sync-in.
1213 attr = fmt->ep_attr & EP_ATTR_MASK;
1214 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1215 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1216 altsd->bNumEndpoints >= 2) {
1217 /* check sync-pipe endpoint */
1218 /* ... and check descriptor size before accessing bSynchAddress
1219 because there is a version of the SB Audigy 2 NX firmware lacking
1220 the audio fields in the endpoint descriptors */
1221 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1222 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1223 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1224 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1225 dev->devnum, fmt->iface, fmt->altsetting);
1228 ep = get_endpoint(alts, 1)->bEndpointAddress;
1229 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1230 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1231 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1232 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1233 dev->devnum, fmt->iface, fmt->altsetting);
1236 ep &= USB_ENDPOINT_NUMBER_MASK;
1238 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1240 subs->syncpipe = usb_sndisocpipe(dev, ep);
1241 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1242 get_endpoint(alts, 1)->bRefresh >= 1 &&
1243 get_endpoint(alts, 1)->bRefresh <= 9)
1244 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1246 subs->syncinterval = 1;
1249 /* always fill max packet size */
1250 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1253 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1256 subs->cur_audiofmt = fmt;
1259 printk("setting done: format = %d, rate = %d, channels = %d\n",
1260 fmt->format, fmt->rate, fmt->channels);
1261 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1262 subs->datapipe, subs->syncpipe);
1269 * hw_params callback
1271 * allocate a buffer and set the given audio format.
1273 * so far we use a physically linear buffer although packetize transfer
1274 * doesn't need a continuous area.
1275 * if sg buffer is supported on the later version of alsa, we'll follow
1278 static int snd_usb_hw_params(snd_pcm_substream_t *substream,
1279 snd_pcm_hw_params_t *hw_params)
1281 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1282 struct audioformat *fmt;
1283 unsigned int channels, rate, format;
1286 ret = snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params));
1290 format = params_format(hw_params);
1291 rate = params_rate(hw_params);
1292 channels = params_channels(hw_params);
1293 fmt = find_format(subs, format, rate, channels);
1295 snd_printd(KERN_DEBUG "cannot set format: format = %s, rate = %d, channels = %d\n",
1296 snd_pcm_format_name(format), rate, channels);
1300 changed = subs->cur_audiofmt != fmt ||
1301 subs->period_bytes != params_period_bytes(hw_params) ||
1302 subs->cur_rate != rate;
1303 if ((ret = set_format(subs, fmt)) < 0)
1306 if (subs->cur_rate != rate) {
1307 struct usb_host_interface *alts;
1308 struct usb_interface *iface;
1309 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1310 alts = &iface->altsetting[fmt->altset_idx];
1311 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1314 subs->cur_rate = rate;
1318 /* format changed */
1319 release_substream_urbs(subs, 0);
1320 /* influenced: period_bytes, channels, rate, format, */
1321 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1322 params_rate(hw_params),
1323 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1332 * reset the audio format and release the buffer
1334 static int snd_usb_hw_free(snd_pcm_substream_t *substream)
1336 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1338 subs->cur_audiofmt = NULL;
1340 subs->period_bytes = 0;
1341 release_substream_urbs(subs, 0);
1342 return snd_pcm_lib_free_pages(substream);
1348 * only a few subtle things...
1350 static int snd_usb_pcm_prepare(snd_pcm_substream_t *substream)
1352 snd_pcm_runtime_t *runtime = substream->runtime;
1353 snd_usb_substream_t *subs = (snd_usb_substream_t *)runtime->private_data;
1355 if (! subs->cur_audiofmt) {
1356 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1360 /* some unit conversions in runtime */
1361 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1362 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1364 /* reset the pointer */
1366 subs->hwptr_done = 0;
1367 subs->transfer_sched = 0;
1368 subs->transfer_done = 0;
1371 /* clear urbs (to be sure) */
1372 deactivate_urbs(subs, 0, 1);
1373 wait_clear_urbs(subs);
1378 static snd_pcm_hardware_t snd_usb_playback =
1380 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
1381 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1382 SNDRV_PCM_INFO_MMAP_VALID),
1383 .buffer_bytes_max = (128*1024),
1384 .period_bytes_min = 64,
1385 .period_bytes_max = (128*1024),
1387 .periods_max = 1024,
1390 static snd_pcm_hardware_t snd_usb_capture =
1392 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
1393 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1394 SNDRV_PCM_INFO_MMAP_VALID),
1395 .buffer_bytes_max = (128*1024),
1396 .period_bytes_min = 64,
1397 .period_bytes_max = (128*1024),
1399 .periods_max = 1024,
1406 #ifdef HW_CONST_DEBUG
1407 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1409 #define hwc_debug(fmt, args...) /**/
1412 static int hw_check_valid_format(snd_pcm_hw_params_t *params, struct audioformat *fp)
1414 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1415 snd_interval_t *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1416 snd_mask_t *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1418 /* check the format */
1419 if (! snd_mask_test(fmts, fp->format)) {
1420 hwc_debug(" > check: no supported format %d\n", fp->format);
1423 /* check the channels */
1424 if (fp->channels < ct->min || fp->channels > ct->max) {
1425 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1428 /* check the rate is within the range */
1429 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1430 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1433 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1434 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1440 static int hw_rule_rate(snd_pcm_hw_params_t *params,
1441 snd_pcm_hw_rule_t *rule)
1443 snd_usb_substream_t *subs = rule->private;
1444 struct list_head *p;
1445 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1446 unsigned int rmin, rmax;
1449 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1452 list_for_each(p, &subs->fmt_list) {
1453 struct audioformat *fp;
1454 fp = list_entry(p, struct audioformat, list);
1455 if (! hw_check_valid_format(params, fp))
1458 if (rmin > fp->rate_min)
1459 rmin = fp->rate_min;
1460 if (rmax < fp->rate_max)
1461 rmax = fp->rate_max;
1463 rmin = fp->rate_min;
1464 rmax = fp->rate_max;
1469 hwc_debug(" --> get empty\n");
1475 if (it->min < rmin) {
1480 if (it->max > rmax) {
1485 if (snd_interval_checkempty(it)) {
1489 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1494 static int hw_rule_channels(snd_pcm_hw_params_t *params,
1495 snd_pcm_hw_rule_t *rule)
1497 snd_usb_substream_t *subs = rule->private;
1498 struct list_head *p;
1499 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1500 unsigned int rmin, rmax;
1503 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1506 list_for_each(p, &subs->fmt_list) {
1507 struct audioformat *fp;
1508 fp = list_entry(p, struct audioformat, list);
1509 if (! hw_check_valid_format(params, fp))
1512 if (rmin > fp->channels)
1513 rmin = fp->channels;
1514 if (rmax < fp->channels)
1515 rmax = fp->channels;
1517 rmin = fp->channels;
1518 rmax = fp->channels;
1523 hwc_debug(" --> get empty\n");
1529 if (it->min < rmin) {
1534 if (it->max > rmax) {
1539 if (snd_interval_checkempty(it)) {
1543 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1547 static int hw_rule_format(snd_pcm_hw_params_t *params,
1548 snd_pcm_hw_rule_t *rule)
1550 snd_usb_substream_t *subs = rule->private;
1551 struct list_head *p;
1552 snd_mask_t *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1557 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1559 list_for_each(p, &subs->fmt_list) {
1560 struct audioformat *fp;
1561 fp = list_entry(p, struct audioformat, list);
1562 if (! hw_check_valid_format(params, fp))
1564 fbits |= (1ULL << fp->format);
1567 oldbits[0] = fmt->bits[0];
1568 oldbits[1] = fmt->bits[1];
1569 fmt->bits[0] &= (u32)fbits;
1570 fmt->bits[1] &= (u32)(fbits >> 32);
1571 if (! fmt->bits[0] && ! fmt->bits[1]) {
1572 hwc_debug(" --> get empty\n");
1575 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1576 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1583 * check whether the registered audio formats need special hw-constraints
1585 static int check_hw_params_convention(snd_usb_substream_t *subs)
1590 u32 cmaster, rmaster;
1591 u32 rate_min = 0, rate_max = 0;
1592 struct list_head *p;
1595 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1596 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1598 list_for_each(p, &subs->fmt_list) {
1599 struct audioformat *f;
1600 f = list_entry(p, struct audioformat, list);
1601 /* unconventional channels? */
1602 if (f->channels > 32)
1604 /* continuous rate min/max matches? */
1605 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1606 if (rate_min && f->rate_min != rate_min)
1608 if (rate_max && f->rate_max != rate_max)
1610 rate_min = f->rate_min;
1611 rate_max = f->rate_max;
1613 /* combination of continuous rates and fixed rates? */
1614 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1615 if (f->rates != rates[f->format])
1618 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1619 if (rates[f->format] && rates[f->format] != f->rates)
1622 channels[f->format] |= (1 << f->channels);
1623 rates[f->format] |= f->rates;
1625 /* check whether channels and rates match for all formats */
1626 cmaster = rmaster = 0;
1627 for (i = 0; i < MAX_MASK; i++) {
1628 if (cmaster != channels[i] && cmaster && channels[i])
1630 if (rmaster != rates[i] && rmaster && rates[i])
1633 cmaster = channels[i];
1637 /* check whether channels match for all distinct rates */
1638 memset(channels, 0, MAX_MASK * sizeof(u32));
1639 list_for_each(p, &subs->fmt_list) {
1640 struct audioformat *f;
1641 f = list_entry(p, struct audioformat, list);
1642 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1644 for (i = 0; i < 32; i++) {
1645 if (f->rates & (1 << i))
1646 channels[i] |= (1 << f->channels);
1650 for (i = 0; i < 32; i++) {
1651 if (cmaster != channels[i] && cmaster && channels[i])
1654 cmaster = channels[i];
1666 * set up the runtime hardware information.
1669 static int setup_hw_info(snd_pcm_runtime_t *runtime, snd_usb_substream_t *subs)
1671 struct list_head *p;
1674 runtime->hw.formats = subs->formats;
1676 runtime->hw.rate_min = 0x7fffffff;
1677 runtime->hw.rate_max = 0;
1678 runtime->hw.channels_min = 256;
1679 runtime->hw.channels_max = 0;
1680 runtime->hw.rates = 0;
1681 /* check min/max rates and channels */
1682 list_for_each(p, &subs->fmt_list) {
1683 struct audioformat *fp;
1684 fp = list_entry(p, struct audioformat, list);
1685 runtime->hw.rates |= fp->rates;
1686 if (runtime->hw.rate_min > fp->rate_min)
1687 runtime->hw.rate_min = fp->rate_min;
1688 if (runtime->hw.rate_max < fp->rate_max)
1689 runtime->hw.rate_max = fp->rate_max;
1690 if (runtime->hw.channels_min > fp->channels)
1691 runtime->hw.channels_min = fp->channels;
1692 if (runtime->hw.channels_max < fp->channels)
1693 runtime->hw.channels_max = fp->channels;
1694 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1695 /* FIXME: there might be more than one audio formats... */
1696 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1701 /* set the period time minimum 1ms */
1702 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1703 1000 * MIN_PACKS_URB,
1704 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1706 if (check_hw_params_convention(subs)) {
1707 hwc_debug("setting extra hw constraints...\n");
1708 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1710 SNDRV_PCM_HW_PARAM_FORMAT,
1711 SNDRV_PCM_HW_PARAM_CHANNELS,
1714 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1715 hw_rule_channels, subs,
1716 SNDRV_PCM_HW_PARAM_FORMAT,
1717 SNDRV_PCM_HW_PARAM_RATE,
1720 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1721 hw_rule_format, subs,
1722 SNDRV_PCM_HW_PARAM_RATE,
1723 SNDRV_PCM_HW_PARAM_CHANNELS,
1730 static int snd_usb_pcm_open(snd_pcm_substream_t *substream, int direction,
1731 snd_pcm_hardware_t *hw)
1733 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1734 snd_pcm_runtime_t *runtime = substream->runtime;
1735 snd_usb_substream_t *subs = &as->substream[direction];
1737 subs->interface = -1;
1740 runtime->private_data = subs;
1741 subs->pcm_substream = substream;
1742 return setup_hw_info(runtime, subs);
1745 static int snd_usb_pcm_close(snd_pcm_substream_t *substream, int direction)
1747 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1748 snd_usb_substream_t *subs = &as->substream[direction];
1750 if (subs->interface >= 0) {
1751 usb_set_interface(subs->dev, subs->interface, 0);
1752 subs->interface = -1;
1754 subs->pcm_substream = NULL;
1758 static int snd_usb_playback_open(snd_pcm_substream_t *substream)
1760 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1763 static int snd_usb_playback_close(snd_pcm_substream_t *substream)
1765 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1768 static int snd_usb_capture_open(snd_pcm_substream_t *substream)
1770 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1773 static int snd_usb_capture_close(snd_pcm_substream_t *substream)
1775 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1778 static snd_pcm_ops_t snd_usb_playback_ops = {
1779 .open = snd_usb_playback_open,
1780 .close = snd_usb_playback_close,
1781 .ioctl = snd_pcm_lib_ioctl,
1782 .hw_params = snd_usb_hw_params,
1783 .hw_free = snd_usb_hw_free,
1784 .prepare = snd_usb_pcm_prepare,
1785 .trigger = snd_usb_pcm_trigger,
1786 .pointer = snd_usb_pcm_pointer,
1789 static snd_pcm_ops_t snd_usb_capture_ops = {
1790 .open = snd_usb_capture_open,
1791 .close = snd_usb_capture_close,
1792 .ioctl = snd_pcm_lib_ioctl,
1793 .hw_params = snd_usb_hw_params,
1794 .hw_free = snd_usb_hw_free,
1795 .prepare = snd_usb_pcm_prepare,
1796 .trigger = snd_usb_pcm_trigger,
1797 .pointer = snd_usb_pcm_pointer,
1807 * combine bytes and get an integer value
1809 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1812 case 1: return *bytes;
1813 case 2: return combine_word(bytes);
1814 case 3: return combine_triple(bytes);
1815 case 4: return combine_quad(bytes);
1821 * parse descriptor buffer and return the pointer starting the given
1824 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1836 if (p[1] == dtype && (!after || (void *)p > after)) {
1845 * find a class-specified interface descriptor with the given subtype.
1847 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1849 unsigned char *p = after;
1851 while ((p = snd_usb_find_desc(buffer, buflen, p,
1852 USB_DT_CS_INTERFACE)) != NULL) {
1853 if (p[0] >= 3 && p[2] == dsubtype)
1860 * Wrapper for usb_control_msg().
1861 * Allocates a temp buffer to prevent dmaing from/to the stack.
1863 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
1864 __u8 requesttype, __u16 value, __u16 index, void *data,
1865 __u16 size, int timeout)
1871 buf = kmalloc(size, GFP_KERNEL);
1874 memcpy(buf, data, size);
1876 err = usb_control_msg(dev, pipe, request, requesttype,
1877 value, index, buf, size, timeout);
1879 memcpy(data, buf, size);
1887 * entry point for linux usb interface
1890 static int usb_audio_probe(struct usb_interface *intf,
1891 const struct usb_device_id *id);
1892 static void usb_audio_disconnect(struct usb_interface *intf);
1894 static struct usb_device_id usb_audio_ids [] = {
1895 #include "usbquirks.h"
1896 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1897 .bInterfaceClass = USB_CLASS_AUDIO,
1898 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
1899 { } /* Terminating entry */
1902 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
1904 static struct usb_driver usb_audio_driver = {
1905 .owner = THIS_MODULE,
1906 .name = "snd-usb-audio",
1907 .probe = usb_audio_probe,
1908 .disconnect = usb_audio_disconnect,
1909 .id_table = usb_audio_ids,
1914 * proc interface for list the supported pcm formats
1916 static void proc_dump_substream_formats(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
1918 struct list_head *p;
1919 static char *sync_types[4] = {
1920 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
1923 list_for_each(p, &subs->fmt_list) {
1924 struct audioformat *fp;
1925 fp = list_entry(p, struct audioformat, list);
1926 snd_iprintf(buffer, " Interface %d\n", fp->iface);
1927 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
1928 snd_iprintf(buffer, " Format: %s\n", snd_pcm_format_name(fp->format));
1929 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
1930 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
1931 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
1932 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
1933 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
1934 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1935 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
1936 fp->rate_min, fp->rate_max);
1939 snd_iprintf(buffer, " Rates: ");
1940 for (i = 0; i < fp->nr_rates; i++) {
1942 snd_iprintf(buffer, ", ");
1943 snd_iprintf(buffer, "%d", fp->rate_table[i]);
1945 snd_iprintf(buffer, "\n");
1947 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
1948 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
1952 static void proc_dump_substream_status(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
1954 if (subs->running) {
1956 snd_iprintf(buffer, " Status: Running\n");
1957 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
1958 snd_iprintf(buffer, " Altset = %d\n", subs->format);
1959 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
1960 for (i = 0; i < subs->nurbs; i++)
1961 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
1962 snd_iprintf(buffer, "]\n");
1963 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
1964 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
1965 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
1966 ? get_full_speed_hz(subs->freqm)
1967 : get_high_speed_hz(subs->freqm),
1968 subs->freqm >> 16, subs->freqm & 0xffff);
1970 snd_iprintf(buffer, " Status: Stop\n");
1974 static void proc_pcm_format_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
1976 snd_usb_stream_t *stream = entry->private_data;
1978 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
1980 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
1981 snd_iprintf(buffer, "\nPlayback:\n");
1982 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
1983 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
1985 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
1986 snd_iprintf(buffer, "\nCapture:\n");
1987 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
1988 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
1992 static void proc_pcm_format_add(snd_usb_stream_t *stream)
1994 snd_info_entry_t *entry;
1996 snd_card_t *card = stream->chip->card;
1998 sprintf(name, "stream%d", stream->pcm_index);
1999 if (! snd_card_proc_new(card, name, &entry))
2000 snd_info_set_text_ops(entry, stream, 1024, proc_pcm_format_read);
2005 * initialize the substream instance.
2008 static void init_substream(snd_usb_stream_t *as, int stream, struct audioformat *fp)
2010 snd_usb_substream_t *subs = &as->substream[stream];
2012 INIT_LIST_HEAD(&subs->fmt_list);
2013 spin_lock_init(&subs->lock);
2016 subs->direction = stream;
2017 subs->dev = as->chip->dev;
2018 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2019 subs->ops = audio_urb_ops[stream];
2021 subs->ops = audio_urb_ops_high_speed[stream];
2022 snd_pcm_lib_preallocate_pages(as->pcm->streams[stream].substream,
2023 SNDRV_DMA_TYPE_CONTINUOUS,
2024 snd_dma_continuous_data(GFP_KERNEL),
2025 64 * 1024, 128 * 1024);
2026 snd_pcm_set_ops(as->pcm, stream,
2027 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2028 &snd_usb_playback_ops : &snd_usb_capture_ops);
2030 list_add_tail(&fp->list, &subs->fmt_list);
2031 subs->formats |= 1ULL << fp->format;
2032 subs->endpoint = fp->endpoint;
2033 subs->num_formats++;
2034 subs->fmt_type = fp->fmt_type;
2041 static void free_substream(snd_usb_substream_t *subs)
2043 struct list_head *p, *n;
2045 if (! subs->num_formats)
2046 return; /* not initialized */
2047 list_for_each_safe(p, n, &subs->fmt_list) {
2048 struct audioformat *fp = list_entry(p, struct audioformat, list);
2049 kfree(fp->rate_table);
2056 * free a usb stream instance
2058 static void snd_usb_audio_stream_free(snd_usb_stream_t *stream)
2060 free_substream(&stream->substream[0]);
2061 free_substream(&stream->substream[1]);
2062 list_del(&stream->list);
2066 static void snd_usb_audio_pcm_free(snd_pcm_t *pcm)
2068 snd_usb_stream_t *stream = pcm->private_data;
2071 snd_pcm_lib_preallocate_free_for_all(pcm);
2072 snd_usb_audio_stream_free(stream);
2078 * add this endpoint to the chip instance.
2079 * if a stream with the same endpoint already exists, append to it.
2080 * if not, create a new pcm stream.
2082 static int add_audio_endpoint(snd_usb_audio_t *chip, int stream, struct audioformat *fp)
2084 struct list_head *p;
2085 snd_usb_stream_t *as;
2086 snd_usb_substream_t *subs;
2090 list_for_each(p, &chip->pcm_list) {
2091 as = list_entry(p, snd_usb_stream_t, list);
2092 if (as->fmt_type != fp->fmt_type)
2094 subs = &as->substream[stream];
2095 if (! subs->endpoint)
2097 if (subs->endpoint == fp->endpoint) {
2098 list_add_tail(&fp->list, &subs->fmt_list);
2099 subs->num_formats++;
2100 subs->formats |= 1ULL << fp->format;
2104 /* look for an empty stream */
2105 list_for_each(p, &chip->pcm_list) {
2106 as = list_entry(p, snd_usb_stream_t, list);
2107 if (as->fmt_type != fp->fmt_type)
2109 subs = &as->substream[stream];
2112 err = snd_pcm_new_stream(as->pcm, stream, 1);
2115 init_substream(as, stream, fp);
2119 /* create a new pcm */
2120 as = kmalloc(sizeof(*as), GFP_KERNEL);
2123 memset(as, 0, sizeof(*as));
2124 as->pcm_index = chip->pcm_devs;
2126 as->fmt_type = fp->fmt_type;
2127 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2128 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2129 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2136 pcm->private_data = as;
2137 pcm->private_free = snd_usb_audio_pcm_free;
2138 pcm->info_flags = 0;
2139 if (chip->pcm_devs > 0)
2140 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2142 strcpy(pcm->name, "USB Audio");
2144 init_substream(as, stream, fp);
2146 list_add(&as->list, &chip->pcm_list);
2149 proc_pcm_format_add(as);
2156 * check if the device uses big-endian samples
2158 static int is_big_endian_format(snd_usb_audio_t *chip, struct audioformat *fp)
2160 switch (chip->usb_id) {
2161 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2162 if (fp->endpoint & USB_DIR_IN)
2165 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2172 * parse the audio format type I descriptor
2173 * and returns the corresponding pcm format
2176 * @fp: audioformat record
2177 * @format: the format tag (wFormatTag)
2178 * @fmt: the format type descriptor
2180 static int parse_audio_format_i_type(snd_usb_audio_t *chip, struct audioformat *fp,
2181 int format, unsigned char *fmt)
2184 int sample_width, sample_bytes;
2186 /* FIXME: correct endianess and sign? */
2188 sample_width = fmt[6];
2189 sample_bytes = fmt[5];
2191 case 0: /* some devices don't define this correctly... */
2192 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2193 chip->dev->devnum, fp->iface, fp->altsetting);
2195 case USB_AUDIO_FORMAT_PCM:
2196 if (sample_width > sample_bytes * 8) {
2197 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2198 chip->dev->devnum, fp->iface, fp->altsetting,
2199 sample_width, sample_bytes);
2201 /* check the format byte size */
2204 pcm_format = SNDRV_PCM_FORMAT_S8;
2207 if (is_big_endian_format(chip, fp))
2208 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2210 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2213 if (is_big_endian_format(chip, fp))
2214 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2216 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2219 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2222 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2223 chip->dev->devnum, fp->iface,
2224 fp->altsetting, sample_width, sample_bytes);
2228 case USB_AUDIO_FORMAT_PCM8:
2229 /* Dallas DS4201 workaround */
2230 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2231 pcm_format = SNDRV_PCM_FORMAT_S8;
2233 pcm_format = SNDRV_PCM_FORMAT_U8;
2235 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2236 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2238 case USB_AUDIO_FORMAT_ALAW:
2239 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2241 case USB_AUDIO_FORMAT_MU_LAW:
2242 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2245 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2246 chip->dev->devnum, fp->iface, fp->altsetting, format);
2254 * parse the format descriptor and stores the possible sample rates
2255 * on the audioformat table.
2258 * @fp: audioformat record
2259 * @fmt: the format descriptor
2260 * @offset: the start offset of descriptor pointing the rate type
2261 * (7 for type I and II, 8 for type II)
2263 static int parse_audio_format_rates(snd_usb_audio_t *chip, struct audioformat *fp,
2264 unsigned char *fmt, int offset)
2266 int nr_rates = fmt[offset];
2267 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2268 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2269 chip->dev->devnum, fp->iface, fp->altsetting);
2275 * build the rate table and bitmap flags
2278 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2279 static unsigned int conv_rates[] = {
2280 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2281 64000, 88200, 96000, 176400, 192000
2283 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2284 if (fp->rate_table == NULL) {
2285 snd_printk(KERN_ERR "cannot malloc\n");
2289 fp->nr_rates = nr_rates;
2290 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2291 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2292 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2293 if (rate < fp->rate_min)
2294 fp->rate_min = rate;
2295 else if (rate > fp->rate_max)
2296 fp->rate_max = rate;
2297 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2298 if (rate == conv_rates[c]) {
2299 fp->rates |= (1 << c);
2305 /* continuous rates */
2306 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2307 fp->rate_min = combine_triple(&fmt[offset + 1]);
2308 fp->rate_max = combine_triple(&fmt[offset + 4]);
2314 * parse the format type I and III descriptors
2316 static int parse_audio_format_i(snd_usb_audio_t *chip, struct audioformat *fp,
2317 int format, unsigned char *fmt)
2321 if (fmt[3] == USB_FORMAT_TYPE_III) {
2322 /* FIXME: the format type is really IECxxx
2323 * but we give normal PCM format to get the existing
2326 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2328 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2332 fp->format = pcm_format;
2333 fp->channels = fmt[4];
2334 if (fp->channels < 1) {
2335 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2336 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2339 return parse_audio_format_rates(chip, fp, fmt, 7);
2343 * prase the format type II descriptor
2345 static int parse_audio_format_ii(snd_usb_audio_t *chip, struct audioformat *fp,
2346 int format, unsigned char *fmt)
2348 int brate, framesize;
2350 case USB_AUDIO_FORMAT_AC3:
2351 /* FIXME: there is no AC3 format defined yet */
2352 // fp->format = SNDRV_PCM_FORMAT_AC3;
2353 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2355 case USB_AUDIO_FORMAT_MPEG:
2356 fp->format = SNDRV_PCM_FORMAT_MPEG;
2359 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2360 chip->dev->devnum, fp->iface, fp->altsetting, format);
2361 fp->format = SNDRV_PCM_FORMAT_MPEG;
2365 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2366 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2367 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2368 fp->frame_size = framesize;
2369 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2372 static int parse_audio_format(snd_usb_audio_t *chip, struct audioformat *fp,
2373 int format, unsigned char *fmt, int stream)
2378 case USB_FORMAT_TYPE_I:
2379 case USB_FORMAT_TYPE_III:
2380 err = parse_audio_format_i(chip, fp, format, fmt);
2382 case USB_FORMAT_TYPE_II:
2383 err = parse_audio_format_ii(chip, fp, format, fmt);
2386 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2387 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2390 fp->fmt_type = fmt[3];
2394 /* FIXME: temporary hack for extigy/audigy 2 nx */
2395 /* extigy apparently supports sample rates other than 48k
2396 * but not in ordinary way. so we enable only 48k atm.
2398 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2399 chip->usb_id == USB_ID(0x041e, 0x3020)) {
2400 if (fmt[3] == USB_FORMAT_TYPE_I &&
2401 stream == SNDRV_PCM_STREAM_PLAYBACK &&
2402 fp->rates != SNDRV_PCM_RATE_48000 &&
2403 fp->rates != SNDRV_PCM_RATE_96000)
2404 return -1; /* use 48k only */
2410 static int parse_audio_endpoints(snd_usb_audio_t *chip, int iface_no)
2412 struct usb_device *dev;
2413 struct usb_interface *iface;
2414 struct usb_host_interface *alts;
2415 struct usb_interface_descriptor *altsd;
2416 int i, altno, err, stream;
2418 struct audioformat *fp;
2419 unsigned char *fmt, *csep;
2423 /* parse the interface's altsettings */
2424 iface = usb_ifnum_to_if(dev, iface_no);
2425 for (i = 0; i < iface->num_altsetting; i++) {
2426 alts = &iface->altsetting[i];
2427 altsd = get_iface_desc(alts);
2428 /* skip invalid one */
2429 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2430 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2431 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2432 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2433 altsd->bNumEndpoints < 1 ||
2434 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2436 /* must be isochronous */
2437 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2438 USB_ENDPOINT_XFER_ISOC)
2440 /* check direction */
2441 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2442 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2443 altno = altsd->bAlternateSetting;
2445 /* get audio formats */
2446 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2448 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2449 dev->devnum, iface_no, altno);
2454 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2455 dev->devnum, iface_no, altno);
2459 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2461 /* get format type */
2462 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2464 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2465 dev->devnum, iface_no, altno);
2469 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2470 dev->devnum, iface_no, altno);
2474 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2475 /* Creamware Noah has this descriptor after the 2nd endpoint */
2476 if (!csep && altsd->bNumEndpoints >= 2)
2477 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2478 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2479 snd_printk(KERN_ERR "%d:%u:%d : no or invalid class specific endpoint descriptor\n",
2480 dev->devnum, iface_no, altno);
2484 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2486 snd_printk(KERN_ERR "cannot malloc\n");
2490 memset(fp, 0, sizeof(*fp));
2491 fp->iface = iface_no;
2492 fp->altsetting = altno;
2494 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2495 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2496 /* FIXME: decode wMaxPacketSize of high bandwith endpoints */
2497 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2498 fp->attributes = csep[3];
2500 /* some quirks for attributes here */
2502 /* workaround for AudioTrak Optoplay */
2503 if (chip->usb_id == USB_ID(0x0a92, 0x0053)) {
2504 /* Optoplay sets the sample rate attribute although
2505 * it seems not supporting it in fact.
2507 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2510 /* workaround for M-Audio Audiophile USB */
2511 if (chip->usb_id == USB_ID(0x0763, 0x2003)) {
2512 /* doesn't set the sample rate attribute, but supports it */
2513 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2517 * plantronics headset and Griffin iMic have set adaptive-in
2518 * although it's really not...
2520 if (chip->usb_id == USB_ID(0x047f, 0x0ca1) ||
2521 /* Griffin iMic (note that there is an older model 77d:223) */
2522 chip->usb_id == USB_ID(0x077d, 0x07af)) {
2523 fp->ep_attr &= ~EP_ATTR_MASK;
2524 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2525 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2527 fp->ep_attr |= EP_ATTR_SYNC;
2530 /* ok, let's parse further... */
2531 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2532 kfree(fp->rate_table);
2537 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, i, fp->endpoint);
2538 err = add_audio_endpoint(chip, stream, fp);
2540 kfree(fp->rate_table);
2544 /* try to set the interface... */
2545 usb_set_interface(chip->dev, iface_no, altno);
2546 init_usb_pitch(chip->dev, iface_no, alts, fp);
2547 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2554 * disconnect streams
2555 * called from snd_usb_audio_disconnect()
2557 static void snd_usb_stream_disconnect(struct list_head *head)
2560 snd_usb_stream_t *as;
2561 snd_usb_substream_t *subs;
2563 as = list_entry(head, snd_usb_stream_t, list);
2564 for (idx = 0; idx < 2; idx++) {
2565 subs = &as->substream[idx];
2566 if (!subs->num_formats)
2568 release_substream_urbs(subs, 1);
2569 subs->interface = -1;
2574 * parse audio control descriptor and create pcm/midi streams
2576 static int snd_usb_create_streams(snd_usb_audio_t *chip, int ctrlif)
2578 struct usb_device *dev = chip->dev;
2579 struct usb_host_interface *host_iface;
2580 struct usb_interface *iface;
2584 /* find audiocontrol interface */
2585 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2586 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2587 snd_printk(KERN_ERR "cannot find HEADER\n");
2590 if (! p1[7] || p1[0] < 8 + p1[7]) {
2591 snd_printk(KERN_ERR "invalid HEADER\n");
2596 * parse all USB audio streaming interfaces
2598 for (i = 0; i < p1[7]; i++) {
2599 struct usb_host_interface *alts;
2600 struct usb_interface_descriptor *altsd;
2602 iface = usb_ifnum_to_if(dev, j);
2604 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2605 dev->devnum, ctrlif, j);
2608 if (usb_interface_claimed(iface)) {
2609 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2612 alts = &iface->altsetting[0];
2613 altsd = get_iface_desc(alts);
2614 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2615 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2616 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2617 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2618 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2621 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2624 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2625 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2626 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2627 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2628 /* skip non-supported classes */
2631 if (! parse_audio_endpoints(chip, j)) {
2632 usb_set_interface(dev, j, 0); /* reset the current interface */
2633 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2641 * create a stream for an endpoint/altsetting without proper descriptors
2643 static int create_fixed_stream_quirk(snd_usb_audio_t *chip,
2644 struct usb_interface *iface,
2645 const snd_usb_audio_quirk_t *quirk)
2647 struct audioformat *fp;
2648 struct usb_host_interface *alts;
2650 int *rate_table = NULL;
2652 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2654 snd_printk(KERN_ERR "cannot malloc\n");
2657 memcpy(fp, quirk->data, sizeof(*fp));
2658 if (fp->nr_rates > 0) {
2659 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2664 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2665 fp->rate_table = rate_table;
2668 stream = (fp->endpoint & USB_DIR_IN)
2669 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2670 err = add_audio_endpoint(chip, stream, fp);
2676 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2677 fp->altset_idx >= iface->num_altsetting) {
2682 alts = &iface->altsetting[fp->altset_idx];
2683 usb_set_interface(chip->dev, fp->iface, 0);
2684 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2685 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2690 * create a stream for an interface with proper descriptors
2692 static int create_standard_interface_quirk(snd_usb_audio_t *chip,
2693 struct usb_interface *iface,
2694 const snd_usb_audio_quirk_t *quirk)
2696 struct usb_host_interface *alts;
2697 struct usb_interface_descriptor *altsd;
2700 alts = &iface->altsetting[0];
2701 altsd = get_iface_desc(alts);
2702 switch (quirk->type) {
2703 case QUIRK_AUDIO_STANDARD_INTERFACE:
2704 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2706 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0); /* reset the current interface */
2708 case QUIRK_MIDI_STANDARD_INTERFACE:
2709 err = snd_usb_create_midi_interface(chip, iface, NULL);
2712 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
2716 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2717 altsd->bInterfaceNumber, err);
2724 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2725 * to detect the sample rate is by looking at wMaxPacketSize.
2727 static int create_ua700_ua25_quirk(snd_usb_audio_t *chip,
2728 struct usb_interface *iface)
2730 static const struct audioformat ua_format = {
2731 .format = SNDRV_PCM_FORMAT_S24_3LE,
2733 .fmt_type = USB_FORMAT_TYPE_I,
2736 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2738 struct usb_host_interface *alts;
2739 struct usb_interface_descriptor *altsd;
2740 struct audioformat *fp;
2743 /* both PCM and MIDI interfaces have 2 altsettings */
2744 if (iface->num_altsetting != 2)
2746 alts = &iface->altsetting[1];
2747 altsd = get_iface_desc(alts);
2749 if (altsd->bNumEndpoints == 2) {
2750 static const snd_usb_midi_endpoint_info_t ua700_ep = {
2751 .out_cables = 0x0003,
2754 static const snd_usb_audio_quirk_t ua700_quirk = {
2755 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2758 static const snd_usb_midi_endpoint_info_t ua25_ep = {
2759 .out_cables = 0x0001,
2762 static const snd_usb_audio_quirk_t ua25_quirk = {
2763 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2766 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2767 return snd_usb_create_midi_interface(chip, iface,
2770 return snd_usb_create_midi_interface(chip, iface,
2774 if (altsd->bNumEndpoints != 1)
2777 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2780 memcpy(fp, &ua_format, sizeof(*fp));
2782 fp->iface = altsd->bInterfaceNumber;
2783 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2784 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2785 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2787 switch (fp->maxpacksize) {
2789 fp->rate_max = fp->rate_min = 44100;
2793 fp->rate_max = fp->rate_min = 48000;
2797 fp->rate_max = fp->rate_min = 96000;
2800 snd_printk(KERN_ERR "unknown sample rate\n");
2805 stream = (fp->endpoint & USB_DIR_IN)
2806 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2807 err = add_audio_endpoint(chip, stream, fp);
2812 usb_set_interface(chip->dev, fp->iface, 0);
2817 * Create a stream for an Edirol UA-1000 interface.
2819 static int create_ua1000_quirk(snd_usb_audio_t *chip, struct usb_interface *iface)
2821 static const struct audioformat ua1000_format = {
2822 .format = SNDRV_PCM_FORMAT_S32_LE,
2823 .fmt_type = USB_FORMAT_TYPE_I,
2827 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2829 struct usb_host_interface *alts;
2830 struct usb_interface_descriptor *altsd;
2831 struct audioformat *fp;
2834 if (iface->num_altsetting != 2)
2836 alts = &iface->altsetting[1];
2837 altsd = get_iface_desc(alts);
2838 if (alts->extralen != 11 || alts->extra[1] != CS_AUDIO_INTERFACE ||
2839 altsd->bNumEndpoints != 1)
2842 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2845 memcpy(fp, &ua1000_format, sizeof(*fp));
2847 fp->channels = alts->extra[4];
2848 fp->iface = altsd->bInterfaceNumber;
2849 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2850 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2851 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2852 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2854 stream = (fp->endpoint & USB_DIR_IN)
2855 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2856 err = add_audio_endpoint(chip, stream, fp);
2861 /* FIXME: playback must be synchronized to capture */
2862 usb_set_interface(chip->dev, fp->iface, 0);
2866 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2867 struct usb_interface *iface,
2868 const snd_usb_audio_quirk_t *quirk);
2871 * handle the quirks for the contained interfaces
2873 static int create_composite_quirk(snd_usb_audio_t *chip,
2874 struct usb_interface *iface,
2875 const snd_usb_audio_quirk_t *quirk)
2877 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
2880 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
2881 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
2884 if (quirk->ifnum != probed_ifnum &&
2885 usb_interface_claimed(iface))
2887 err = snd_usb_create_quirk(chip, iface, quirk);
2890 if (quirk->ifnum != probed_ifnum)
2891 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2901 #define EXTIGY_FIRMWARE_SIZE_OLD 794
2902 #define EXTIGY_FIRMWARE_SIZE_NEW 483
2904 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
2906 struct usb_host_config *config = dev->actconfig;
2909 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
2910 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
2911 snd_printdd("sending Extigy boot sequence...\n");
2912 /* Send message to force it to reconnect with full interface. */
2913 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
2914 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
2915 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
2916 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
2917 &dev->descriptor, sizeof(dev->descriptor));
2918 config = dev->actconfig;
2919 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
2920 err = usb_reset_configuration(dev);
2921 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
2922 snd_printdd("extigy_boot: new boot length = %d\n",
2923 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
2924 return -ENODEV; /* quit this anyway */
2931 * audio-interface quirks
2933 * returns zero if no standard audio/MIDI parsing is needed.
2934 * returns a postive value if standard audio/midi interfaces are parsed
2936 * returns a negative value at error.
2938 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2939 struct usb_interface *iface,
2940 const snd_usb_audio_quirk_t *quirk)
2942 switch (quirk->type) {
2943 case QUIRK_MIDI_FIXED_ENDPOINT:
2944 case QUIRK_MIDI_YAMAHA:
2945 case QUIRK_MIDI_MIDIMAN:
2946 case QUIRK_MIDI_NOVATION:
2947 case QUIRK_MIDI_MOTU:
2948 case QUIRK_MIDI_EMAGIC:
2949 return snd_usb_create_midi_interface(chip, iface, quirk);
2950 case QUIRK_COMPOSITE:
2951 return create_composite_quirk(chip, iface, quirk);
2952 case QUIRK_AUDIO_FIXED_ENDPOINT:
2953 return create_fixed_stream_quirk(chip, iface, quirk);
2954 case QUIRK_AUDIO_STANDARD_INTERFACE:
2955 case QUIRK_MIDI_STANDARD_INTERFACE:
2956 return create_standard_interface_quirk(chip, iface, quirk);
2957 case QUIRK_AUDIO_EDIROL_UA700_UA25:
2958 return create_ua700_ua25_quirk(chip, iface);
2959 case QUIRK_AUDIO_EDIROL_UA1000:
2960 return create_ua1000_quirk(chip, iface);
2961 case QUIRK_IGNORE_INTERFACE:
2964 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
2971 * common proc files to show the usb device info
2973 static void proc_audio_usbbus_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
2975 snd_usb_audio_t *chip = entry->private_data;
2976 if (! chip->shutdown)
2977 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
2980 static void proc_audio_usbid_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
2982 snd_usb_audio_t *chip = entry->private_data;
2983 if (! chip->shutdown)
2984 snd_iprintf(buffer, "%04x:%04x\n",
2985 USB_ID_VENDOR(chip->usb_id),
2986 USB_ID_PRODUCT(chip->usb_id));
2989 static void snd_usb_audio_create_proc(snd_usb_audio_t *chip)
2991 snd_info_entry_t *entry;
2992 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
2993 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbbus_read);
2994 if (! snd_card_proc_new(chip->card, "usbid", &entry))
2995 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbid_read);
2999 * free the chip instance
3001 * here we have to do not much, since pcm and controls are already freed
3005 static int snd_usb_audio_free(snd_usb_audio_t *chip)
3011 static int snd_usb_audio_dev_free(snd_device_t *device)
3013 snd_usb_audio_t *chip = device->device_data;
3014 return snd_usb_audio_free(chip);
3019 * create a chip instance and set its names.
3021 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3022 const snd_usb_audio_quirk_t *quirk,
3023 snd_usb_audio_t **rchip)
3026 snd_usb_audio_t *chip;
3029 static snd_device_ops_t ops = {
3030 .dev_free = snd_usb_audio_dev_free,
3035 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3036 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3037 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3041 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3043 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3047 chip = kcalloc(1, sizeof(*chip), GFP_KERNEL);
3049 snd_card_free(card);
3056 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3057 le16_to_cpu(dev->descriptor.idProduct));
3058 INIT_LIST_HEAD(&chip->pcm_list);
3059 INIT_LIST_HEAD(&chip->midi_list);
3060 INIT_LIST_HEAD(&chip->mixer_list);
3062 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3063 snd_usb_audio_free(chip);
3064 snd_card_free(card);
3068 strcpy(card->driver, "USB-Audio");
3069 sprintf(component, "USB%04x:%04x",
3070 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3071 snd_component_add(card, component);
3073 /* retrieve the device string as shortname */
3074 if (quirk && quirk->product_name) {
3075 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3077 if (!dev->descriptor.iProduct ||
3078 usb_string(dev, dev->descriptor.iProduct,
3079 card->shortname, sizeof(card->shortname)) <= 0) {
3080 /* no name available from anywhere, so use ID */
3081 sprintf(card->shortname, "USB Device %#04x:%#04x",
3082 USB_ID_VENDOR(chip->usb_id),
3083 USB_ID_PRODUCT(chip->usb_id));
3087 /* retrieve the vendor and device strings as longname */
3088 if (quirk && quirk->vendor_name) {
3089 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3091 if (dev->descriptor.iManufacturer)
3092 len = usb_string(dev, dev->descriptor.iManufacturer,
3093 card->longname, sizeof(card->longname));
3096 /* we don't really care if there isn't any vendor string */
3099 strlcat(card->longname, " ", sizeof(card->longname));
3101 strlcat(card->longname, card->shortname, sizeof(card->longname));
3103 len = strlcat(card->longname, " at ", sizeof(card->longname));
3105 if (len < sizeof(card->longname))
3106 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3108 strlcat(card->longname,
3109 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3110 sizeof(card->longname));
3112 snd_usb_audio_create_proc(chip);
3114 snd_card_set_dev(card, &dev->dev);
3122 * probe the active usb device
3124 * note that this can be called multiple times per a device, when it
3125 * includes multiple audio control interfaces.
3127 * thus we check the usb device pointer and creates the card instance
3128 * only at the first time. the successive calls of this function will
3129 * append the pcm interface to the corresponding card.
3131 static void *snd_usb_audio_probe(struct usb_device *dev,
3132 struct usb_interface *intf,
3133 const struct usb_device_id *usb_id)
3135 struct usb_host_config *config = dev->actconfig;
3136 const snd_usb_audio_quirk_t *quirk = (const snd_usb_audio_quirk_t *)usb_id->driver_info;
3138 snd_usb_audio_t *chip;
3139 struct usb_host_interface *alts;
3143 alts = &intf->altsetting[0];
3144 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3145 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3146 le16_to_cpu(dev->descriptor.idProduct));
3148 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3151 /* SB Extigy needs special boot-up sequence */
3152 /* if more models come, this will go to the quirk list. */
3153 if (id == USB_ID(0x041e, 0x3000)) {
3154 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3156 config = dev->actconfig;
3160 * found a config. now register to ALSA
3163 /* check whether it's already registered */
3165 down(®ister_mutex);
3166 for (i = 0; i < SNDRV_CARDS; i++) {
3167 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3168 if (usb_chip[i]->shutdown) {
3169 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3177 /* it's a fresh one.
3178 * now look for an empty slot and create a new card instance
3180 /* first, set the current configuration for this device */
3181 if (usb_reset_configuration(dev) < 0) {
3182 snd_printk(KERN_ERR "cannot reset configuration (value 0x%x)\n", get_cfg_desc(config)->bConfigurationValue);
3185 for (i = 0; i < SNDRV_CARDS; i++)
3186 if (enable[i] && ! usb_chip[i] &&
3187 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3188 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3189 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3195 snd_printk(KERN_ERR "no available usb audio device\n");
3200 err = 1; /* continue */
3201 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3202 /* need some special handlings */
3203 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3208 /* create normal USB audio interfaces */
3209 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3210 snd_usb_create_mixer(chip, ifnum) < 0) {
3215 /* we are allowed to call snd_card_register() many times */
3216 if (snd_card_register(chip->card) < 0) {
3220 usb_chip[chip->index] = chip;
3221 chip->num_interfaces++;
3222 up(®ister_mutex);
3226 if (chip && !chip->num_interfaces)
3227 snd_card_free(chip->card);
3228 up(®ister_mutex);
3234 * we need to take care of counter, since disconnection can be called also
3235 * many times as well as usb_audio_probe().
3237 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3239 snd_usb_audio_t *chip;
3241 struct list_head *p;
3243 if (ptr == (void *)-1L)
3248 down(®ister_mutex);
3250 chip->num_interfaces--;
3251 if (chip->num_interfaces <= 0) {
3252 snd_card_disconnect(card);
3253 /* release the pcm resources */
3254 list_for_each(p, &chip->pcm_list) {
3255 snd_usb_stream_disconnect(p);
3257 /* release the midi resources */
3258 list_for_each(p, &chip->midi_list) {
3259 snd_usbmidi_disconnect(p);
3261 /* release mixer resources */
3262 list_for_each(p, &chip->mixer_list) {
3263 snd_usb_mixer_disconnect(p);
3265 usb_chip[chip->index] = NULL;
3266 up(®ister_mutex);
3267 snd_card_free(card);
3269 up(®ister_mutex);
3274 * new 2.5 USB kernel API
3276 static int usb_audio_probe(struct usb_interface *intf,
3277 const struct usb_device_id *id)
3280 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3282 dev_set_drvdata(&intf->dev, chip);
3288 static void usb_audio_disconnect(struct usb_interface *intf)
3290 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3291 dev_get_drvdata(&intf->dev));
3295 static int __init snd_usb_audio_init(void)
3297 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3298 printk(KERN_WARNING "invalid nrpacks value.\n");
3301 usb_register(&usb_audio_driver);
3306 static void __exit snd_usb_audio_cleanup(void)
3308 usb_deregister(&usb_audio_driver);
3311 module_init(snd_usb_audio_init);
3312 module_exit(snd_usb_audio_cleanup);