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/vmalloc.h>
49 #include <linux/moduleparam.h>
50 #include <sound/core.h>
51 #include <sound/info.h>
52 #include <sound/pcm.h>
53 #include <sound/pcm_params.h>
54 #include <sound/initval.h>
59 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
60 MODULE_DESCRIPTION("USB Audio");
61 MODULE_LICENSE("GPL");
62 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
65 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
66 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
67 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
68 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
69 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
70 static int nrpacks = 4; /* max. number of packets per urb */
71 static int async_unlink = 1;
73 module_param_array(index, int, NULL, 0444);
74 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
75 module_param_array(id, charp, NULL, 0444);
76 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
77 module_param_array(enable, bool, NULL, 0444);
78 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
79 module_param_array(vid, int, NULL, 0444);
80 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
81 module_param_array(pid, int, NULL, 0444);
82 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
83 module_param(nrpacks, int, 0644);
84 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
85 module_param(async_unlink, bool, 0444);
86 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
90 * debug the h/w constraints
92 /* #define HW_CONST_DEBUG */
100 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
102 #define SYNC_URBS 4 /* always four urbs for sync */
103 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
105 typedef struct snd_usb_substream snd_usb_substream_t;
106 typedef struct snd_usb_stream snd_usb_stream_t;
107 typedef struct snd_urb_ctx snd_urb_ctx_t;
110 struct list_head list;
111 snd_pcm_format_t format; /* format type */
112 unsigned int channels; /* # channels */
113 unsigned int fmt_type; /* USB audio format type (1-3) */
114 unsigned int frame_size; /* samples per frame for non-audio */
115 int iface; /* interface number */
116 unsigned char altsetting; /* corresponding alternate setting */
117 unsigned char altset_idx; /* array index of altenate setting */
118 unsigned char attributes; /* corresponding attributes of cs endpoint */
119 unsigned char endpoint; /* endpoint */
120 unsigned char ep_attr; /* endpoint attributes */
121 unsigned int maxpacksize; /* max. packet size */
122 unsigned int rates; /* rate bitmasks */
123 unsigned int rate_min, rate_max; /* min/max rates */
124 unsigned int nr_rates; /* number of rate table entries */
125 unsigned int *rate_table; /* rate table */
130 unsigned int buffer_size; /* size of data buffer, if data URB */
131 snd_usb_substream_t *subs;
132 int index; /* index for urb array */
133 int packets; /* number of packets per urb */
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 datainterval; /* log_2 of data packet interval */
157 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
158 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
159 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
160 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
161 unsigned int phase; /* phase accumulator */
162 unsigned int maxpacksize; /* max packet size in bytes */
163 unsigned int maxframesize; /* max packet size in frames */
164 unsigned int curpacksize; /* current packet size in bytes (for capture) */
165 unsigned int curframesize; /* current packet size in frames (for capture) */
166 unsigned int fill_max: 1; /* fill max packet size always */
167 unsigned int fmt_type; /* USB audio format type (1-3) */
168 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
170 unsigned int running: 1; /* running status */
172 unsigned int hwptr_done; /* processed frame position in the buffer */
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 buffer for all sync URBs */
181 dma_addr_t sync_dma; /* DMA address of syncbuf */
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 static inline 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 static inline 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 static inline 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 static inline 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,
313 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
316 urb->dev = ctx->subs->dev; /* we need to set this at each time */
317 for (i = 0; i < ctx->packets; i++) {
318 urb->iso_frame_desc[i].offset = offs;
319 urb->iso_frame_desc[i].length = subs->curpacksize;
320 offs += subs->curpacksize;
322 urb->transfer_buffer_length = offs;
323 urb->number_of_packets = ctx->packets;
325 if (! urb->bandwidth) {
327 bustime = usb_check_bandwidth(urb->dev, urb);
330 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
331 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
338 * process after capture complete
340 * copy the data from each desctiptor to the pcm buffer, and
341 * update the current position.
343 static int retire_capture_urb(snd_usb_substream_t *subs,
344 snd_pcm_runtime_t *runtime,
350 unsigned int stride, len, oldptr;
351 int period_elapsed = 0;
353 stride = runtime->frame_bits >> 3;
355 for (i = 0; i < urb->number_of_packets; i++) {
356 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
357 if (urb->iso_frame_desc[i].status) {
358 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
361 len = urb->iso_frame_desc[i].actual_length / stride;
364 /* update the current pointer */
365 spin_lock_irqsave(&subs->lock, flags);
366 oldptr = subs->hwptr_done;
367 subs->hwptr_done += len;
368 if (subs->hwptr_done >= runtime->buffer_size)
369 subs->hwptr_done -= runtime->buffer_size;
370 subs->transfer_done += len;
371 if (subs->transfer_done >= runtime->period_size) {
372 subs->transfer_done -= runtime->period_size;
375 spin_unlock_irqrestore(&subs->lock, flags);
376 /* copy a data chunk */
377 if (oldptr + len > runtime->buffer_size) {
378 unsigned int cnt = runtime->buffer_size - oldptr;
379 unsigned int blen = cnt * stride;
380 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
381 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
383 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
387 snd_pcm_period_elapsed(subs->pcm_substream);
393 * prepare urb for full speed playback sync pipe
395 * set up the offset and length to receive the current frequency.
398 static int prepare_playback_sync_urb(snd_usb_substream_t *subs,
399 snd_pcm_runtime_t *runtime,
402 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
404 urb->dev = ctx->subs->dev; /* we need to set this at each time */
405 urb->iso_frame_desc[0].length = 3;
406 urb->iso_frame_desc[0].offset = 0;
411 * prepare urb for high speed playback sync pipe
413 * set up the offset and length to receive the current frequency.
416 static int prepare_playback_sync_urb_hs(snd_usb_substream_t *subs,
417 snd_pcm_runtime_t *runtime,
420 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
422 urb->dev = ctx->subs->dev; /* we need to set this at each time */
423 urb->iso_frame_desc[0].length = 4;
424 urb->iso_frame_desc[0].offset = 0;
429 * process after full speed playback sync complete
431 * retrieve the current 10.14 frequency from pipe, and set it.
432 * the value is referred in prepare_playback_urb().
434 static int retire_playback_sync_urb(snd_usb_substream_t *subs,
435 snd_pcm_runtime_t *runtime,
441 if (urb->iso_frame_desc[0].status == 0 &&
442 urb->iso_frame_desc[0].actual_length == 3) {
443 f = combine_triple((u8*)urb->transfer_buffer) << 2;
444 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
445 spin_lock_irqsave(&subs->lock, flags);
447 spin_unlock_irqrestore(&subs->lock, flags);
455 * process after high speed playback sync complete
457 * retrieve the current 12.13 frequency from pipe, and set it.
458 * the value is referred in prepare_playback_urb().
460 static int retire_playback_sync_urb_hs(snd_usb_substream_t *subs,
461 snd_pcm_runtime_t *runtime,
467 if (urb->iso_frame_desc[0].status == 0 &&
468 urb->iso_frame_desc[0].actual_length == 4) {
469 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
470 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
471 spin_lock_irqsave(&subs->lock, flags);
473 spin_unlock_irqrestore(&subs->lock, flags);
481 * Prepare urb for streaming before playback starts.
483 * We don't care about (or have) any data, so we just send a transfer delimiter.
485 static int prepare_startup_playback_urb(snd_usb_substream_t *subs,
486 snd_pcm_runtime_t *runtime,
490 snd_urb_ctx_t *ctx = urb->context;
492 urb->dev = ctx->subs->dev;
493 urb->number_of_packets = subs->packs_per_ms;
494 for (i = 0; i < subs->packs_per_ms; ++i) {
495 urb->iso_frame_desc[i].offset = 0;
496 urb->iso_frame_desc[i].length = 0;
498 urb->transfer_buffer_length = 0;
503 * prepare urb for playback data pipe
505 * Since a URB can handle only a single linear buffer, we must use double
506 * buffering when the data to be transferred overflows the buffer boundary.
507 * To avoid inconsistencies when updating hwptr_done, we use double buffering
510 static int prepare_playback_urb(snd_usb_substream_t *subs,
511 snd_pcm_runtime_t *runtime,
517 int period_elapsed = 0;
518 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
520 stride = runtime->frame_bits >> 3;
523 urb->dev = ctx->subs->dev; /* we need to set this at each time */
524 urb->number_of_packets = 0;
525 spin_lock_irqsave(&subs->lock, flags);
526 for (i = 0; i < ctx->packets; i++) {
527 /* calculate the size of a packet */
529 counts = subs->maxframesize; /* fixed */
531 subs->phase = (subs->phase & 0xffff)
532 + (subs->freqm << subs->datainterval);
533 counts = subs->phase >> 16;
534 if (counts > subs->maxframesize)
535 counts = subs->maxframesize;
537 /* set up descriptor */
538 urb->iso_frame_desc[i].offset = offs * stride;
539 urb->iso_frame_desc[i].length = counts * stride;
541 urb->number_of_packets++;
542 subs->transfer_done += counts;
543 if (subs->transfer_done >= runtime->period_size) {
544 subs->transfer_done -= runtime->period_size;
546 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
547 if (subs->transfer_done > 0) {
548 /* FIXME: fill-max mode is not
550 offs -= subs->transfer_done;
551 counts -= subs->transfer_done;
552 urb->iso_frame_desc[i].length =
554 subs->transfer_done = 0;
557 if (i < ctx->packets) {
558 /* add a transfer delimiter */
559 urb->iso_frame_desc[i].offset =
561 urb->iso_frame_desc[i].length = 0;
562 urb->number_of_packets++;
567 /* finish at the frame boundary at/after the period boundary */
568 if (period_elapsed &&
569 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
572 if (subs->hwptr_done + offs > runtime->buffer_size) {
573 /* err, the transferred area goes over buffer boundary. */
574 unsigned int len = runtime->buffer_size - subs->hwptr_done;
575 memcpy(urb->transfer_buffer,
576 runtime->dma_area + subs->hwptr_done * stride,
578 memcpy(urb->transfer_buffer + len * stride,
580 (offs - len) * stride);
582 memcpy(urb->transfer_buffer,
583 runtime->dma_area + subs->hwptr_done * stride,
586 subs->hwptr_done += offs;
587 if (subs->hwptr_done >= runtime->buffer_size)
588 subs->hwptr_done -= runtime->buffer_size;
589 spin_unlock_irqrestore(&subs->lock, flags);
590 urb->transfer_buffer_length = offs * stride;
592 snd_pcm_period_elapsed(subs->pcm_substream);
597 * process after playback data complete
600 static int retire_playback_urb(snd_usb_substream_t *subs,
601 snd_pcm_runtime_t *runtime,
610 static struct snd_urb_ops audio_urb_ops[2] = {
612 .prepare = prepare_startup_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_startup_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);
686 /* get the physical page pointer at the given offset */
687 static struct page *snd_pcm_get_vmalloc_page(snd_pcm_substream_t *subs,
688 unsigned long offset)
690 void *pageptr = subs->runtime->dma_area + offset;
691 return vmalloc_to_page(pageptr);
694 /* allocate virtual buffer; may be called more than once */
695 static int snd_pcm_alloc_vmalloc_buffer(snd_pcm_substream_t *subs, size_t size)
697 snd_pcm_runtime_t *runtime = subs->runtime;
698 if (runtime->dma_area) {
699 if (runtime->dma_bytes >= size)
700 return 0; /* already large enough */
701 vfree(runtime->dma_area);
703 runtime->dma_area = vmalloc(size);
704 if (! runtime->dma_area)
706 runtime->dma_bytes = size;
710 /* free virtual buffer; may be called more than once */
711 static int snd_pcm_free_vmalloc_buffer(snd_pcm_substream_t *subs)
713 snd_pcm_runtime_t *runtime = subs->runtime;
714 if (runtime->dma_area) {
715 vfree(runtime->dma_area);
716 runtime->dma_area = NULL;
723 * unlink active urbs.
725 static int deactivate_urbs(snd_usb_substream_t *subs, int force, int can_sleep)
732 if (!force && subs->stream->chip->shutdown) /* to be sure... */
735 async = !can_sleep && async_unlink;
737 if (! async && in_interrupt())
740 for (i = 0; i < subs->nurbs; i++) {
741 if (test_bit(i, &subs->active_mask)) {
742 if (! test_and_set_bit(i, &subs->unlink_mask)) {
743 struct urb *u = subs->dataurb[i].urb;
751 if (subs->syncpipe) {
752 for (i = 0; i < SYNC_URBS; i++) {
753 if (test_bit(i+16, &subs->active_mask)) {
754 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
755 struct urb *u = subs->syncurb[i].urb;
769 * set up and start data/sync urbs
771 static int start_urbs(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime)
776 if (subs->stream->chip->shutdown)
779 for (i = 0; i < subs->nurbs; i++) {
780 snd_assert(subs->dataurb[i].urb, return -EINVAL);
781 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
782 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
786 if (subs->syncpipe) {
787 for (i = 0; i < SYNC_URBS; i++) {
788 snd_assert(subs->syncurb[i].urb, return -EINVAL);
789 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
790 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
796 subs->active_mask = 0;
797 subs->unlink_mask = 0;
799 for (i = 0; i < subs->nurbs; i++) {
800 if ((err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC)) < 0) {
801 snd_printk(KERN_ERR "cannot submit datapipe for urb %d, err = %d\n", i, err);
804 set_bit(i, &subs->active_mask);
806 if (subs->syncpipe) {
807 for (i = 0; i < SYNC_URBS; i++) {
808 if ((err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC)) < 0) {
809 snd_printk(KERN_ERR "cannot submit syncpipe for urb %d, err = %d\n", i, err);
812 set_bit(i + 16, &subs->active_mask);
818 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
819 deactivate_urbs(subs, 0, 0);
825 * wait until all urbs are processed.
827 static int wait_clear_urbs(snd_usb_substream_t *subs)
829 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
835 for (i = 0; i < subs->nurbs; i++) {
836 if (test_bit(i, &subs->active_mask))
839 if (subs->syncpipe) {
840 for (i = 0; i < SYNC_URBS; i++) {
841 if (test_bit(i + 16, &subs->active_mask))
847 schedule_timeout_uninterruptible(1);
848 } while (time_before(jiffies, end_time));
850 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
856 * return the current pcm pointer. just return the hwptr_done value.
858 static snd_pcm_uframes_t snd_usb_pcm_pointer(snd_pcm_substream_t *substream)
860 snd_usb_substream_t *subs;
861 snd_pcm_uframes_t hwptr_done;
863 subs = (snd_usb_substream_t *)substream->runtime->private_data;
864 spin_lock(&subs->lock);
865 hwptr_done = subs->hwptr_done;
866 spin_unlock(&subs->lock);
872 * start/stop playback substream
874 static int snd_usb_pcm_playback_trigger(snd_pcm_substream_t *substream,
877 snd_usb_substream_t *subs = substream->runtime->private_data;
880 case SNDRV_PCM_TRIGGER_START:
881 subs->ops.prepare = prepare_playback_urb;
883 case SNDRV_PCM_TRIGGER_STOP:
884 return deactivate_urbs(subs, 0, 0);
891 * start/stop capture substream
893 static int snd_usb_pcm_capture_trigger(snd_pcm_substream_t *substream,
896 snd_usb_substream_t *subs = substream->runtime->private_data;
899 case SNDRV_PCM_TRIGGER_START:
900 return start_urbs(subs, substream->runtime);
901 case SNDRV_PCM_TRIGGER_STOP:
902 return deactivate_urbs(subs, 0, 0);
912 static void release_urb_ctx(snd_urb_ctx_t *u)
916 usb_buffer_free(u->subs->dev, u->buffer_size,
917 u->urb->transfer_buffer,
918 u->urb->transfer_dma);
919 usb_free_urb(u->urb);
925 * release a substream
927 static void release_substream_urbs(snd_usb_substream_t *subs, int force)
931 /* stop urbs (to be sure) */
932 deactivate_urbs(subs, force, 1);
933 wait_clear_urbs(subs);
935 for (i = 0; i < MAX_URBS; i++)
936 release_urb_ctx(&subs->dataurb[i]);
937 for (i = 0; i < SYNC_URBS; i++)
938 release_urb_ctx(&subs->syncurb[i]);
939 usb_buffer_free(subs->dev, SYNC_URBS * 4,
940 subs->syncbuf, subs->sync_dma);
941 subs->syncbuf = NULL;
946 * initialize a substream for plaback/capture
948 static int init_substream_urbs(snd_usb_substream_t *subs, unsigned int period_bytes,
949 unsigned int rate, unsigned int frame_bits)
951 unsigned int maxsize, n, i;
952 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
953 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
955 /* calculate the frequency in 16.16 format */
956 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
957 subs->freqn = get_usb_full_speed_rate(rate);
959 subs->freqn = get_usb_high_speed_rate(rate);
960 subs->freqm = subs->freqn;
961 /* calculate max. frequency */
962 if (subs->maxpacksize) {
963 /* whatever fits into a max. size packet */
964 maxsize = subs->maxpacksize;
965 subs->freqmax = (maxsize / (frame_bits >> 3))
966 << (16 - subs->datainterval);
968 /* no max. packet size: just take 25% higher than nominal */
969 subs->freqmax = subs->freqn + (subs->freqn >> 2);
970 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
971 >> (16 - subs->datainterval);
976 subs->curpacksize = subs->maxpacksize;
978 subs->curpacksize = maxsize;
980 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
981 packs_per_ms = 8 >> subs->datainterval;
984 subs->packs_per_ms = packs_per_ms;
988 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
989 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
992 urb_packs *= packs_per_ms;
994 /* decide how many packets to be used */
996 unsigned int minsize;
997 /* determine how small a packet can be */
998 minsize = (subs->freqn >> (16 - subs->datainterval))
1000 /* with sync from device, assume it can be 12% lower */
1002 minsize -= minsize >> 3;
1003 minsize = max(minsize, 1u);
1004 total_packs = (period_bytes + minsize - 1) / minsize;
1005 /* round up to multiple of packs_per_ms */
1006 total_packs = (total_packs + packs_per_ms - 1)
1007 & ~(packs_per_ms - 1);
1008 /* we need at least two URBs for queueing */
1009 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1010 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
1012 total_packs = MAX_URBS * urb_packs;
1014 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1015 if (subs->nurbs > MAX_URBS) {
1017 subs->nurbs = MAX_URBS;
1018 total_packs = MAX_URBS * urb_packs;
1021 for (i = 0; i < subs->nurbs; i++) {
1022 npacks[i] = n > urb_packs ? urb_packs : n;
1025 if (subs->nurbs <= 1) {
1026 /* too little - we need at least two packets
1027 * to ensure contiguous playback/capture
1030 npacks[0] = (total_packs + 1) / 2;
1031 npacks[1] = total_packs - npacks[0];
1032 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1033 /* the last packet is too small.. */
1034 if (subs->nurbs > 2) {
1035 /* merge to the first one */
1036 npacks[0] += npacks[subs->nurbs - 1];
1041 npacks[0] = (total_packs + 1) / 2;
1042 npacks[1] = total_packs - npacks[0];
1046 /* allocate and initialize data urbs */
1047 for (i = 0; i < subs->nurbs; i++) {
1048 snd_urb_ctx_t *u = &subs->dataurb[i];
1051 u->packets = npacks[i];
1052 u->buffer_size = maxsize * u->packets;
1053 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1054 u->packets++; /* for transfer delimiter */
1055 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1058 u->urb->transfer_buffer =
1059 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1060 &u->urb->transfer_dma);
1061 if (! u->urb->transfer_buffer)
1063 u->urb->pipe = subs->datapipe;
1064 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1065 u->urb->interval = 1 << subs->datainterval;
1066 u->urb->context = u;
1067 u->urb->complete = snd_complete_urb;
1070 if (subs->syncpipe) {
1071 /* allocate and initialize sync urbs */
1072 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1073 GFP_KERNEL, &subs->sync_dma);
1074 if (! subs->syncbuf)
1076 for (i = 0; i < SYNC_URBS; i++) {
1077 snd_urb_ctx_t *u = &subs->syncurb[i];
1081 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1084 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1085 u->urb->transfer_dma = subs->sync_dma + i * 4;
1086 u->urb->transfer_buffer_length = 4;
1087 u->urb->pipe = subs->syncpipe;
1088 u->urb->transfer_flags = URB_ISO_ASAP |
1089 URB_NO_TRANSFER_DMA_MAP;
1090 u->urb->number_of_packets = 1;
1091 u->urb->interval = 1 << subs->syncinterval;
1092 u->urb->context = u;
1093 u->urb->complete = snd_complete_sync_urb;
1099 release_substream_urbs(subs, 0);
1105 * find a matching audio format
1107 static struct audioformat *find_format(snd_usb_substream_t *subs, unsigned int format,
1108 unsigned int rate, unsigned int channels)
1110 struct list_head *p;
1111 struct audioformat *found = NULL;
1112 int cur_attr = 0, attr;
1114 list_for_each(p, &subs->fmt_list) {
1115 struct audioformat *fp;
1116 fp = list_entry(p, struct audioformat, list);
1117 if (fp->format != format || fp->channels != channels)
1119 if (rate < fp->rate_min || rate > fp->rate_max)
1121 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1123 for (i = 0; i < fp->nr_rates; i++)
1124 if (fp->rate_table[i] == rate)
1126 if (i >= fp->nr_rates)
1129 attr = fp->ep_attr & EP_ATTR_MASK;
1135 /* avoid async out and adaptive in if the other method
1136 * supports the same format.
1137 * this is a workaround for the case like
1138 * M-audio audiophile USB.
1140 if (attr != cur_attr) {
1141 if ((attr == EP_ATTR_ASYNC &&
1142 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1143 (attr == EP_ATTR_ADAPTIVE &&
1144 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1146 if ((cur_attr == EP_ATTR_ASYNC &&
1147 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1148 (cur_attr == EP_ATTR_ADAPTIVE &&
1149 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1155 /* find the format with the largest max. packet size */
1156 if (fp->maxpacksize > found->maxpacksize) {
1166 * initialize the picth control and sample rate
1168 static int init_usb_pitch(struct usb_device *dev, int iface,
1169 struct usb_host_interface *alts,
1170 struct audioformat *fmt)
1173 unsigned char data[1];
1176 ep = get_endpoint(alts, 0)->bEndpointAddress;
1177 /* if endpoint has pitch control, enable it */
1178 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1180 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1181 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1182 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1183 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1184 dev->devnum, iface, ep);
1191 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1192 struct usb_host_interface *alts,
1193 struct audioformat *fmt, int rate)
1196 unsigned char data[3];
1199 ep = get_endpoint(alts, 0)->bEndpointAddress;
1200 /* if endpoint has sampling rate control, set it */
1201 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1204 data[1] = rate >> 8;
1205 data[2] = rate >> 16;
1206 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1207 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1208 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1209 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1210 dev->devnum, iface, fmt->altsetting, rate, ep);
1213 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1214 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1215 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1216 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1217 dev->devnum, iface, fmt->altsetting, ep);
1218 return 0; /* some devices don't support reading */
1220 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1221 if (crate != rate) {
1222 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1223 // runtime->rate = crate;
1230 * find a matching format and set up the interface
1232 static int set_format(snd_usb_substream_t *subs, struct audioformat *fmt)
1234 struct usb_device *dev = subs->dev;
1235 struct usb_host_interface *alts;
1236 struct usb_interface_descriptor *altsd;
1237 struct usb_interface *iface;
1238 unsigned int ep, attr;
1239 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1242 iface = usb_ifnum_to_if(dev, fmt->iface);
1243 snd_assert(iface, return -EINVAL);
1244 alts = &iface->altsetting[fmt->altset_idx];
1245 altsd = get_iface_desc(alts);
1246 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1248 if (fmt == subs->cur_audiofmt)
1251 /* close the old interface */
1252 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1253 usb_set_interface(subs->dev, subs->interface, 0);
1254 subs->interface = -1;
1259 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1260 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1261 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1262 dev->devnum, fmt->iface, fmt->altsetting);
1265 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1266 subs->interface = fmt->iface;
1267 subs->format = fmt->altset_idx;
1270 /* create a data pipe */
1271 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1273 subs->datapipe = usb_sndisocpipe(dev, ep);
1275 subs->datapipe = usb_rcvisocpipe(dev, ep);
1276 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1277 get_endpoint(alts, 0)->bInterval >= 1 &&
1278 get_endpoint(alts, 0)->bInterval <= 4)
1279 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1281 subs->datainterval = 0;
1282 subs->syncpipe = subs->syncinterval = 0;
1283 subs->maxpacksize = fmt->maxpacksize;
1286 /* we need a sync pipe in async OUT or adaptive IN mode */
1287 /* check the number of EP, since some devices have broken
1288 * descriptors which fool us. if it has only one EP,
1289 * assume it as adaptive-out or sync-in.
1291 attr = fmt->ep_attr & EP_ATTR_MASK;
1292 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1293 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1294 altsd->bNumEndpoints >= 2) {
1295 /* check sync-pipe endpoint */
1296 /* ... and check descriptor size before accessing bSynchAddress
1297 because there is a version of the SB Audigy 2 NX firmware lacking
1298 the audio fields in the endpoint descriptors */
1299 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1300 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1301 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1302 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1303 dev->devnum, fmt->iface, fmt->altsetting);
1306 ep = get_endpoint(alts, 1)->bEndpointAddress;
1307 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1308 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1309 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1310 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1311 dev->devnum, fmt->iface, fmt->altsetting);
1314 ep &= USB_ENDPOINT_NUMBER_MASK;
1316 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1318 subs->syncpipe = usb_sndisocpipe(dev, ep);
1319 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1320 get_endpoint(alts, 1)->bRefresh >= 1 &&
1321 get_endpoint(alts, 1)->bRefresh <= 9)
1322 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1323 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1324 subs->syncinterval = 1;
1325 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1326 get_endpoint(alts, 1)->bInterval <= 16)
1327 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1329 subs->syncinterval = 3;
1332 /* always fill max packet size */
1333 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1336 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1339 subs->cur_audiofmt = fmt;
1342 printk("setting done: format = %d, rate = %d, channels = %d\n",
1343 fmt->format, fmt->rate, fmt->channels);
1344 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1345 subs->datapipe, subs->syncpipe);
1352 * hw_params callback
1354 * allocate a buffer and set the given audio format.
1356 * so far we use a physically linear buffer although packetize transfer
1357 * doesn't need a continuous area.
1358 * if sg buffer is supported on the later version of alsa, we'll follow
1361 static int snd_usb_hw_params(snd_pcm_substream_t *substream,
1362 snd_pcm_hw_params_t *hw_params)
1364 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1365 struct audioformat *fmt;
1366 unsigned int channels, rate, format;
1369 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1370 params_buffer_bytes(hw_params));
1374 format = params_format(hw_params);
1375 rate = params_rate(hw_params);
1376 channels = params_channels(hw_params);
1377 fmt = find_format(subs, format, rate, channels);
1379 snd_printd(KERN_DEBUG "cannot set format: format = %s, rate = %d, channels = %d\n",
1380 snd_pcm_format_name(format), rate, channels);
1384 changed = subs->cur_audiofmt != fmt ||
1385 subs->period_bytes != params_period_bytes(hw_params) ||
1386 subs->cur_rate != rate;
1387 if ((ret = set_format(subs, fmt)) < 0)
1390 if (subs->cur_rate != rate) {
1391 struct usb_host_interface *alts;
1392 struct usb_interface *iface;
1393 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1394 alts = &iface->altsetting[fmt->altset_idx];
1395 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1398 subs->cur_rate = rate;
1402 /* format changed */
1403 release_substream_urbs(subs, 0);
1404 /* influenced: period_bytes, channels, rate, format, */
1405 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1406 params_rate(hw_params),
1407 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1416 * reset the audio format and release the buffer
1418 static int snd_usb_hw_free(snd_pcm_substream_t *substream)
1420 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1422 subs->cur_audiofmt = NULL;
1424 subs->period_bytes = 0;
1425 release_substream_urbs(subs, 0);
1426 return snd_pcm_free_vmalloc_buffer(substream);
1432 * only a few subtle things...
1434 static int snd_usb_pcm_prepare(snd_pcm_substream_t *substream)
1436 snd_pcm_runtime_t *runtime = substream->runtime;
1437 snd_usb_substream_t *subs = runtime->private_data;
1439 if (! subs->cur_audiofmt) {
1440 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1444 /* some unit conversions in runtime */
1445 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1446 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1448 /* reset the pointer */
1449 subs->hwptr_done = 0;
1450 subs->transfer_done = 0;
1453 /* clear urbs (to be sure) */
1454 deactivate_urbs(subs, 0, 1);
1455 wait_clear_urbs(subs);
1457 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1458 * updates for all URBs would happen at the same time when starting */
1459 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1460 subs->ops.prepare = prepare_startup_playback_urb;
1461 return start_urbs(subs, runtime);
1466 static snd_pcm_hardware_t snd_usb_playback =
1468 .info = SNDRV_PCM_INFO_MMAP |
1469 SNDRV_PCM_INFO_MMAP_VALID |
1470 SNDRV_PCM_INFO_BATCH |
1471 SNDRV_PCM_INFO_INTERLEAVED |
1472 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1473 .buffer_bytes_max = 1024 * 1024,
1474 .period_bytes_min = 64,
1475 .period_bytes_max = 512 * 1024,
1477 .periods_max = 1024,
1480 static snd_pcm_hardware_t snd_usb_capture =
1482 .info = SNDRV_PCM_INFO_MMAP |
1483 SNDRV_PCM_INFO_MMAP_VALID |
1484 SNDRV_PCM_INFO_BATCH |
1485 SNDRV_PCM_INFO_INTERLEAVED |
1486 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1487 .buffer_bytes_max = 1024 * 1024,
1488 .period_bytes_min = 64,
1489 .period_bytes_max = 512 * 1024,
1491 .periods_max = 1024,
1498 #ifdef HW_CONST_DEBUG
1499 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1501 #define hwc_debug(fmt, args...) /**/
1504 static int hw_check_valid_format(snd_pcm_hw_params_t *params, struct audioformat *fp)
1506 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1507 snd_interval_t *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1508 snd_mask_t *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1510 /* check the format */
1511 if (! snd_mask_test(fmts, fp->format)) {
1512 hwc_debug(" > check: no supported format %d\n", fp->format);
1515 /* check the channels */
1516 if (fp->channels < ct->min || fp->channels > ct->max) {
1517 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1520 /* check the rate is within the range */
1521 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1522 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1525 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1526 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1532 static int hw_rule_rate(snd_pcm_hw_params_t *params,
1533 snd_pcm_hw_rule_t *rule)
1535 snd_usb_substream_t *subs = rule->private;
1536 struct list_head *p;
1537 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1538 unsigned int rmin, rmax;
1541 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1544 list_for_each(p, &subs->fmt_list) {
1545 struct audioformat *fp;
1546 fp = list_entry(p, struct audioformat, list);
1547 if (! hw_check_valid_format(params, fp))
1550 if (rmin > fp->rate_min)
1551 rmin = fp->rate_min;
1552 if (rmax < fp->rate_max)
1553 rmax = fp->rate_max;
1555 rmin = fp->rate_min;
1556 rmax = fp->rate_max;
1561 hwc_debug(" --> get empty\n");
1567 if (it->min < rmin) {
1572 if (it->max > rmax) {
1577 if (snd_interval_checkempty(it)) {
1581 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1586 static int hw_rule_channels(snd_pcm_hw_params_t *params,
1587 snd_pcm_hw_rule_t *rule)
1589 snd_usb_substream_t *subs = rule->private;
1590 struct list_head *p;
1591 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1592 unsigned int rmin, rmax;
1595 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1598 list_for_each(p, &subs->fmt_list) {
1599 struct audioformat *fp;
1600 fp = list_entry(p, struct audioformat, list);
1601 if (! hw_check_valid_format(params, fp))
1604 if (rmin > fp->channels)
1605 rmin = fp->channels;
1606 if (rmax < fp->channels)
1607 rmax = fp->channels;
1609 rmin = fp->channels;
1610 rmax = fp->channels;
1615 hwc_debug(" --> get empty\n");
1621 if (it->min < rmin) {
1626 if (it->max > rmax) {
1631 if (snd_interval_checkempty(it)) {
1635 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1639 static int hw_rule_format(snd_pcm_hw_params_t *params,
1640 snd_pcm_hw_rule_t *rule)
1642 snd_usb_substream_t *subs = rule->private;
1643 struct list_head *p;
1644 snd_mask_t *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1649 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
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(params, fp))
1656 fbits |= (1ULL << fp->format);
1659 oldbits[0] = fmt->bits[0];
1660 oldbits[1] = fmt->bits[1];
1661 fmt->bits[0] &= (u32)fbits;
1662 fmt->bits[1] &= (u32)(fbits >> 32);
1663 if (! fmt->bits[0] && ! fmt->bits[1]) {
1664 hwc_debug(" --> get empty\n");
1667 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1668 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1675 * check whether the registered audio formats need special hw-constraints
1677 static int check_hw_params_convention(snd_usb_substream_t *subs)
1682 u32 cmaster, rmaster;
1683 u32 rate_min = 0, rate_max = 0;
1684 struct list_head *p;
1687 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1688 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1690 list_for_each(p, &subs->fmt_list) {
1691 struct audioformat *f;
1692 f = list_entry(p, struct audioformat, list);
1693 /* unconventional channels? */
1694 if (f->channels > 32)
1696 /* continuous rate min/max matches? */
1697 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1698 if (rate_min && f->rate_min != rate_min)
1700 if (rate_max && f->rate_max != rate_max)
1702 rate_min = f->rate_min;
1703 rate_max = f->rate_max;
1705 /* combination of continuous rates and fixed rates? */
1706 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1707 if (f->rates != rates[f->format])
1710 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1711 if (rates[f->format] && rates[f->format] != f->rates)
1714 channels[f->format] |= (1 << f->channels);
1715 rates[f->format] |= f->rates;
1717 /* check whether channels and rates match for all formats */
1718 cmaster = rmaster = 0;
1719 for (i = 0; i < MAX_MASK; i++) {
1720 if (cmaster != channels[i] && cmaster && channels[i])
1722 if (rmaster != rates[i] && rmaster && rates[i])
1725 cmaster = channels[i];
1729 /* check whether channels match for all distinct rates */
1730 memset(channels, 0, MAX_MASK * sizeof(u32));
1731 list_for_each(p, &subs->fmt_list) {
1732 struct audioformat *f;
1733 f = list_entry(p, struct audioformat, list);
1734 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1736 for (i = 0; i < 32; i++) {
1737 if (f->rates & (1 << i))
1738 channels[i] |= (1 << f->channels);
1742 for (i = 0; i < 32; i++) {
1743 if (cmaster != channels[i] && cmaster && channels[i])
1746 cmaster = channels[i];
1758 * set up the runtime hardware information.
1761 static int setup_hw_info(snd_pcm_runtime_t *runtime, snd_usb_substream_t *subs)
1763 struct list_head *p;
1766 runtime->hw.formats = subs->formats;
1768 runtime->hw.rate_min = 0x7fffffff;
1769 runtime->hw.rate_max = 0;
1770 runtime->hw.channels_min = 256;
1771 runtime->hw.channels_max = 0;
1772 runtime->hw.rates = 0;
1773 /* check min/max rates and channels */
1774 list_for_each(p, &subs->fmt_list) {
1775 struct audioformat *fp;
1776 fp = list_entry(p, struct audioformat, list);
1777 runtime->hw.rates |= fp->rates;
1778 if (runtime->hw.rate_min > fp->rate_min)
1779 runtime->hw.rate_min = fp->rate_min;
1780 if (runtime->hw.rate_max < fp->rate_max)
1781 runtime->hw.rate_max = fp->rate_max;
1782 if (runtime->hw.channels_min > fp->channels)
1783 runtime->hw.channels_min = fp->channels;
1784 if (runtime->hw.channels_max < fp->channels)
1785 runtime->hw.channels_max = fp->channels;
1786 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1787 /* FIXME: there might be more than one audio formats... */
1788 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1793 /* set the period time minimum 1ms */
1794 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1795 1000 * MIN_PACKS_URB,
1796 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1798 if (check_hw_params_convention(subs)) {
1799 hwc_debug("setting extra hw constraints...\n");
1800 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1802 SNDRV_PCM_HW_PARAM_FORMAT,
1803 SNDRV_PCM_HW_PARAM_CHANNELS,
1806 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1807 hw_rule_channels, subs,
1808 SNDRV_PCM_HW_PARAM_FORMAT,
1809 SNDRV_PCM_HW_PARAM_RATE,
1812 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1813 hw_rule_format, subs,
1814 SNDRV_PCM_HW_PARAM_RATE,
1815 SNDRV_PCM_HW_PARAM_CHANNELS,
1822 static int snd_usb_pcm_open(snd_pcm_substream_t *substream, int direction,
1823 snd_pcm_hardware_t *hw)
1825 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1826 snd_pcm_runtime_t *runtime = substream->runtime;
1827 snd_usb_substream_t *subs = &as->substream[direction];
1829 subs->interface = -1;
1832 runtime->private_data = subs;
1833 subs->pcm_substream = substream;
1834 return setup_hw_info(runtime, subs);
1837 static int snd_usb_pcm_close(snd_pcm_substream_t *substream, int direction)
1839 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1840 snd_usb_substream_t *subs = &as->substream[direction];
1842 if (subs->interface >= 0) {
1843 usb_set_interface(subs->dev, subs->interface, 0);
1844 subs->interface = -1;
1846 subs->pcm_substream = NULL;
1850 static int snd_usb_playback_open(snd_pcm_substream_t *substream)
1852 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1855 static int snd_usb_playback_close(snd_pcm_substream_t *substream)
1857 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1860 static int snd_usb_capture_open(snd_pcm_substream_t *substream)
1862 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1865 static int snd_usb_capture_close(snd_pcm_substream_t *substream)
1867 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1870 static snd_pcm_ops_t snd_usb_playback_ops = {
1871 .open = snd_usb_playback_open,
1872 .close = snd_usb_playback_close,
1873 .ioctl = snd_pcm_lib_ioctl,
1874 .hw_params = snd_usb_hw_params,
1875 .hw_free = snd_usb_hw_free,
1876 .prepare = snd_usb_pcm_prepare,
1877 .trigger = snd_usb_pcm_playback_trigger,
1878 .pointer = snd_usb_pcm_pointer,
1879 .page = snd_pcm_get_vmalloc_page,
1882 static snd_pcm_ops_t snd_usb_capture_ops = {
1883 .open = snd_usb_capture_open,
1884 .close = snd_usb_capture_close,
1885 .ioctl = snd_pcm_lib_ioctl,
1886 .hw_params = snd_usb_hw_params,
1887 .hw_free = snd_usb_hw_free,
1888 .prepare = snd_usb_pcm_prepare,
1889 .trigger = snd_usb_pcm_capture_trigger,
1890 .pointer = snd_usb_pcm_pointer,
1891 .page = snd_pcm_get_vmalloc_page,
1901 * combine bytes and get an integer value
1903 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1906 case 1: return *bytes;
1907 case 2: return combine_word(bytes);
1908 case 3: return combine_triple(bytes);
1909 case 4: return combine_quad(bytes);
1915 * parse descriptor buffer and return the pointer starting the given
1918 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1930 if (p[1] == dtype && (!after || (void *)p > after)) {
1939 * find a class-specified interface descriptor with the given subtype.
1941 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1943 unsigned char *p = after;
1945 while ((p = snd_usb_find_desc(buffer, buflen, p,
1946 USB_DT_CS_INTERFACE)) != NULL) {
1947 if (p[0] >= 3 && p[2] == dsubtype)
1954 * Wrapper for usb_control_msg().
1955 * Allocates a temp buffer to prevent dmaing from/to the stack.
1957 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
1958 __u8 requesttype, __u16 value, __u16 index, void *data,
1959 __u16 size, int timeout)
1965 buf = kmalloc(size, GFP_KERNEL);
1968 memcpy(buf, data, size);
1970 err = usb_control_msg(dev, pipe, request, requesttype,
1971 value, index, buf, size, timeout);
1973 memcpy(data, buf, size);
1981 * entry point for linux usb interface
1984 static int usb_audio_probe(struct usb_interface *intf,
1985 const struct usb_device_id *id);
1986 static void usb_audio_disconnect(struct usb_interface *intf);
1988 static struct usb_device_id usb_audio_ids [] = {
1989 #include "usbquirks.h"
1990 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1991 .bInterfaceClass = USB_CLASS_AUDIO,
1992 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
1993 { } /* Terminating entry */
1996 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
1998 static struct usb_driver usb_audio_driver = {
1999 .name = "snd-usb-audio",
2000 .probe = usb_audio_probe,
2001 .disconnect = usb_audio_disconnect,
2002 .id_table = usb_audio_ids,
2007 * proc interface for list the supported pcm formats
2009 static void proc_dump_substream_formats(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
2011 struct list_head *p;
2012 static char *sync_types[4] = {
2013 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2016 list_for_each(p, &subs->fmt_list) {
2017 struct audioformat *fp;
2018 fp = list_entry(p, struct audioformat, list);
2019 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2020 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
2021 snd_iprintf(buffer, " Format: %s\n", snd_pcm_format_name(fp->format));
2022 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2023 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2024 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2025 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2026 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2027 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2028 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2029 fp->rate_min, fp->rate_max);
2032 snd_iprintf(buffer, " Rates: ");
2033 for (i = 0; i < fp->nr_rates; i++) {
2035 snd_iprintf(buffer, ", ");
2036 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2038 snd_iprintf(buffer, "\n");
2040 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2041 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2045 static void proc_dump_substream_status(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
2047 if (subs->running) {
2049 snd_iprintf(buffer, " Status: Running\n");
2050 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2051 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2052 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2053 for (i = 0; i < subs->nurbs; i++)
2054 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2055 snd_iprintf(buffer, "]\n");
2056 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2057 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2058 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2059 ? get_full_speed_hz(subs->freqm)
2060 : get_high_speed_hz(subs->freqm),
2061 subs->freqm >> 16, subs->freqm & 0xffff);
2063 snd_iprintf(buffer, " Status: Stop\n");
2067 static void proc_pcm_format_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
2069 snd_usb_stream_t *stream = entry->private_data;
2071 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2073 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2074 snd_iprintf(buffer, "\nPlayback:\n");
2075 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2076 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2078 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2079 snd_iprintf(buffer, "\nCapture:\n");
2080 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2081 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2085 static void proc_pcm_format_add(snd_usb_stream_t *stream)
2087 snd_info_entry_t *entry;
2089 snd_card_t *card = stream->chip->card;
2091 sprintf(name, "stream%d", stream->pcm_index);
2092 if (! snd_card_proc_new(card, name, &entry))
2093 snd_info_set_text_ops(entry, stream, 1024, proc_pcm_format_read);
2098 * initialize the substream instance.
2101 static void init_substream(snd_usb_stream_t *as, int stream, struct audioformat *fp)
2103 snd_usb_substream_t *subs = &as->substream[stream];
2105 INIT_LIST_HEAD(&subs->fmt_list);
2106 spin_lock_init(&subs->lock);
2109 subs->direction = stream;
2110 subs->dev = as->chip->dev;
2111 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2112 subs->ops = audio_urb_ops[stream];
2114 subs->ops = audio_urb_ops_high_speed[stream];
2115 snd_pcm_set_ops(as->pcm, stream,
2116 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2117 &snd_usb_playback_ops : &snd_usb_capture_ops);
2119 list_add_tail(&fp->list, &subs->fmt_list);
2120 subs->formats |= 1ULL << fp->format;
2121 subs->endpoint = fp->endpoint;
2122 subs->num_formats++;
2123 subs->fmt_type = fp->fmt_type;
2130 static void free_substream(snd_usb_substream_t *subs)
2132 struct list_head *p, *n;
2134 if (! subs->num_formats)
2135 return; /* not initialized */
2136 list_for_each_safe(p, n, &subs->fmt_list) {
2137 struct audioformat *fp = list_entry(p, struct audioformat, list);
2138 kfree(fp->rate_table);
2145 * free a usb stream instance
2147 static void snd_usb_audio_stream_free(snd_usb_stream_t *stream)
2149 free_substream(&stream->substream[0]);
2150 free_substream(&stream->substream[1]);
2151 list_del(&stream->list);
2155 static void snd_usb_audio_pcm_free(snd_pcm_t *pcm)
2157 snd_usb_stream_t *stream = pcm->private_data;
2160 snd_usb_audio_stream_free(stream);
2166 * add this endpoint to the chip instance.
2167 * if a stream with the same endpoint already exists, append to it.
2168 * if not, create a new pcm stream.
2170 static int add_audio_endpoint(snd_usb_audio_t *chip, int stream, struct audioformat *fp)
2172 struct list_head *p;
2173 snd_usb_stream_t *as;
2174 snd_usb_substream_t *subs;
2178 list_for_each(p, &chip->pcm_list) {
2179 as = list_entry(p, snd_usb_stream_t, list);
2180 if (as->fmt_type != fp->fmt_type)
2182 subs = &as->substream[stream];
2183 if (! subs->endpoint)
2185 if (subs->endpoint == fp->endpoint) {
2186 list_add_tail(&fp->list, &subs->fmt_list);
2187 subs->num_formats++;
2188 subs->formats |= 1ULL << fp->format;
2192 /* look for an empty stream */
2193 list_for_each(p, &chip->pcm_list) {
2194 as = list_entry(p, snd_usb_stream_t, list);
2195 if (as->fmt_type != fp->fmt_type)
2197 subs = &as->substream[stream];
2200 err = snd_pcm_new_stream(as->pcm, stream, 1);
2203 init_substream(as, stream, fp);
2207 /* create a new pcm */
2208 as = kmalloc(sizeof(*as), GFP_KERNEL);
2211 memset(as, 0, sizeof(*as));
2212 as->pcm_index = chip->pcm_devs;
2214 as->fmt_type = fp->fmt_type;
2215 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2216 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2217 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2224 pcm->private_data = as;
2225 pcm->private_free = snd_usb_audio_pcm_free;
2226 pcm->info_flags = 0;
2227 if (chip->pcm_devs > 0)
2228 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2230 strcpy(pcm->name, "USB Audio");
2232 init_substream(as, stream, fp);
2234 list_add(&as->list, &chip->pcm_list);
2237 proc_pcm_format_add(as);
2244 * check if the device uses big-endian samples
2246 static int is_big_endian_format(snd_usb_audio_t *chip, struct audioformat *fp)
2248 switch (chip->usb_id) {
2249 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2250 if (fp->endpoint & USB_DIR_IN)
2253 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2260 * parse the audio format type I descriptor
2261 * and returns the corresponding pcm format
2264 * @fp: audioformat record
2265 * @format: the format tag (wFormatTag)
2266 * @fmt: the format type descriptor
2268 static int parse_audio_format_i_type(snd_usb_audio_t *chip, struct audioformat *fp,
2269 int format, unsigned char *fmt)
2272 int sample_width, sample_bytes;
2274 /* FIXME: correct endianess and sign? */
2276 sample_width = fmt[6];
2277 sample_bytes = fmt[5];
2279 case 0: /* some devices don't define this correctly... */
2280 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2281 chip->dev->devnum, fp->iface, fp->altsetting);
2283 case USB_AUDIO_FORMAT_PCM:
2284 if (sample_width > sample_bytes * 8) {
2285 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2286 chip->dev->devnum, fp->iface, fp->altsetting,
2287 sample_width, sample_bytes);
2289 /* check the format byte size */
2292 pcm_format = SNDRV_PCM_FORMAT_S8;
2295 if (is_big_endian_format(chip, fp))
2296 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2298 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2301 if (is_big_endian_format(chip, fp))
2302 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2304 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2307 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2310 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2311 chip->dev->devnum, fp->iface,
2312 fp->altsetting, sample_width, sample_bytes);
2316 case USB_AUDIO_FORMAT_PCM8:
2317 /* Dallas DS4201 workaround */
2318 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2319 pcm_format = SNDRV_PCM_FORMAT_S8;
2321 pcm_format = SNDRV_PCM_FORMAT_U8;
2323 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2324 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2326 case USB_AUDIO_FORMAT_ALAW:
2327 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2329 case USB_AUDIO_FORMAT_MU_LAW:
2330 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2333 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2334 chip->dev->devnum, fp->iface, fp->altsetting, format);
2342 * parse the format descriptor and stores the possible sample rates
2343 * on the audioformat table.
2346 * @fp: audioformat record
2347 * @fmt: the format descriptor
2348 * @offset: the start offset of descriptor pointing the rate type
2349 * (7 for type I and II, 8 for type II)
2351 static int parse_audio_format_rates(snd_usb_audio_t *chip, struct audioformat *fp,
2352 unsigned char *fmt, int offset)
2354 int nr_rates = fmt[offset];
2355 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2356 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2357 chip->dev->devnum, fp->iface, fp->altsetting);
2363 * build the rate table and bitmap flags
2366 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2367 static unsigned int conv_rates[] = {
2368 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2369 64000, 88200, 96000, 176400, 192000
2371 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2372 if (fp->rate_table == NULL) {
2373 snd_printk(KERN_ERR "cannot malloc\n");
2377 fp->nr_rates = nr_rates;
2378 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2379 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2380 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2381 if (rate < fp->rate_min)
2382 fp->rate_min = rate;
2383 else if (rate > fp->rate_max)
2384 fp->rate_max = rate;
2385 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2386 if (rate == conv_rates[c]) {
2387 fp->rates |= (1 << c);
2393 /* continuous rates */
2394 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2395 fp->rate_min = combine_triple(&fmt[offset + 1]);
2396 fp->rate_max = combine_triple(&fmt[offset + 4]);
2402 * parse the format type I and III descriptors
2404 static int parse_audio_format_i(snd_usb_audio_t *chip, struct audioformat *fp,
2405 int format, unsigned char *fmt)
2409 if (fmt[3] == USB_FORMAT_TYPE_III) {
2410 /* FIXME: the format type is really IECxxx
2411 * but we give normal PCM format to get the existing
2414 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2416 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2420 fp->format = pcm_format;
2421 fp->channels = fmt[4];
2422 if (fp->channels < 1) {
2423 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2424 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2427 return parse_audio_format_rates(chip, fp, fmt, 7);
2431 * prase the format type II descriptor
2433 static int parse_audio_format_ii(snd_usb_audio_t *chip, struct audioformat *fp,
2434 int format, unsigned char *fmt)
2436 int brate, framesize;
2438 case USB_AUDIO_FORMAT_AC3:
2439 /* FIXME: there is no AC3 format defined yet */
2440 // fp->format = SNDRV_PCM_FORMAT_AC3;
2441 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2443 case USB_AUDIO_FORMAT_MPEG:
2444 fp->format = SNDRV_PCM_FORMAT_MPEG;
2447 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2448 chip->dev->devnum, fp->iface, fp->altsetting, format);
2449 fp->format = SNDRV_PCM_FORMAT_MPEG;
2453 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2454 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2455 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2456 fp->frame_size = framesize;
2457 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2460 static int parse_audio_format(snd_usb_audio_t *chip, struct audioformat *fp,
2461 int format, unsigned char *fmt, int stream)
2466 case USB_FORMAT_TYPE_I:
2467 case USB_FORMAT_TYPE_III:
2468 err = parse_audio_format_i(chip, fp, format, fmt);
2470 case USB_FORMAT_TYPE_II:
2471 err = parse_audio_format_ii(chip, fp, format, fmt);
2474 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2475 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2478 fp->fmt_type = fmt[3];
2482 /* FIXME: temporary hack for extigy/audigy 2 nx */
2483 /* extigy apparently supports sample rates other than 48k
2484 * but not in ordinary way. so we enable only 48k atm.
2486 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2487 chip->usb_id == USB_ID(0x041e, 0x3020)) {
2488 if (fmt[3] == USB_FORMAT_TYPE_I &&
2489 fp->rates != SNDRV_PCM_RATE_48000 &&
2490 fp->rates != SNDRV_PCM_RATE_96000)
2497 static int parse_audio_endpoints(snd_usb_audio_t *chip, int iface_no)
2499 struct usb_device *dev;
2500 struct usb_interface *iface;
2501 struct usb_host_interface *alts;
2502 struct usb_interface_descriptor *altsd;
2503 int i, altno, err, stream;
2505 struct audioformat *fp;
2506 unsigned char *fmt, *csep;
2510 /* parse the interface's altsettings */
2511 iface = usb_ifnum_to_if(dev, iface_no);
2512 for (i = 0; i < iface->num_altsetting; i++) {
2513 alts = &iface->altsetting[i];
2514 altsd = get_iface_desc(alts);
2515 /* skip invalid one */
2516 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2517 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2518 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2519 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2520 altsd->bNumEndpoints < 1 ||
2521 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2523 /* must be isochronous */
2524 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2525 USB_ENDPOINT_XFER_ISOC)
2527 /* check direction */
2528 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2529 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2530 altno = altsd->bAlternateSetting;
2532 /* get audio formats */
2533 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2535 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2536 dev->devnum, iface_no, altno);
2541 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2542 dev->devnum, iface_no, altno);
2546 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2548 /* get format type */
2549 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2551 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2552 dev->devnum, iface_no, altno);
2556 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2557 dev->devnum, iface_no, altno);
2561 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2562 /* Creamware Noah has this descriptor after the 2nd endpoint */
2563 if (!csep && altsd->bNumEndpoints >= 2)
2564 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2565 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2566 snd_printk(KERN_ERR "%d:%u:%d : no or invalid class specific endpoint descriptor\n",
2567 dev->devnum, iface_no, altno);
2571 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2573 snd_printk(KERN_ERR "cannot malloc\n");
2577 memset(fp, 0, sizeof(*fp));
2578 fp->iface = iface_no;
2579 fp->altsetting = altno;
2581 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2582 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2583 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2584 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2585 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2586 * (fp->maxpacksize & 0x7ff);
2587 fp->attributes = csep[3];
2589 /* some quirks for attributes here */
2591 switch (chip->usb_id) {
2592 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2593 /* Optoplay sets the sample rate attribute although
2594 * it seems not supporting it in fact.
2596 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2598 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2599 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2600 /* doesn't set the sample rate attribute, but supports it */
2601 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2603 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2604 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2605 an older model 77d:223) */
2607 * plantronics headset and Griffin iMic have set adaptive-in
2608 * although it's really not...
2610 fp->ep_attr &= ~EP_ATTR_MASK;
2611 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2612 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2614 fp->ep_attr |= EP_ATTR_SYNC;
2618 /* ok, let's parse further... */
2619 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2620 kfree(fp->rate_table);
2625 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, i, fp->endpoint);
2626 err = add_audio_endpoint(chip, stream, fp);
2628 kfree(fp->rate_table);
2632 /* try to set the interface... */
2633 usb_set_interface(chip->dev, iface_no, altno);
2634 init_usb_pitch(chip->dev, iface_no, alts, fp);
2635 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2642 * disconnect streams
2643 * called from snd_usb_audio_disconnect()
2645 static void snd_usb_stream_disconnect(struct list_head *head)
2648 snd_usb_stream_t *as;
2649 snd_usb_substream_t *subs;
2651 as = list_entry(head, snd_usb_stream_t, list);
2652 for (idx = 0; idx < 2; idx++) {
2653 subs = &as->substream[idx];
2654 if (!subs->num_formats)
2656 release_substream_urbs(subs, 1);
2657 subs->interface = -1;
2662 * parse audio control descriptor and create pcm/midi streams
2664 static int snd_usb_create_streams(snd_usb_audio_t *chip, int ctrlif)
2666 struct usb_device *dev = chip->dev;
2667 struct usb_host_interface *host_iface;
2668 struct usb_interface *iface;
2672 /* find audiocontrol interface */
2673 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2674 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2675 snd_printk(KERN_ERR "cannot find HEADER\n");
2678 if (! p1[7] || p1[0] < 8 + p1[7]) {
2679 snd_printk(KERN_ERR "invalid HEADER\n");
2684 * parse all USB audio streaming interfaces
2686 for (i = 0; i < p1[7]; i++) {
2687 struct usb_host_interface *alts;
2688 struct usb_interface_descriptor *altsd;
2690 iface = usb_ifnum_to_if(dev, j);
2692 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2693 dev->devnum, ctrlif, j);
2696 if (usb_interface_claimed(iface)) {
2697 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2700 alts = &iface->altsetting[0];
2701 altsd = get_iface_desc(alts);
2702 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2703 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2704 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2705 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2706 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2709 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2712 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2713 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2714 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2715 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2716 /* skip non-supported classes */
2719 if (! parse_audio_endpoints(chip, j)) {
2720 usb_set_interface(dev, j, 0); /* reset the current interface */
2721 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2729 * create a stream for an endpoint/altsetting without proper descriptors
2731 static int create_fixed_stream_quirk(snd_usb_audio_t *chip,
2732 struct usb_interface *iface,
2733 const snd_usb_audio_quirk_t *quirk)
2735 struct audioformat *fp;
2736 struct usb_host_interface *alts;
2738 int *rate_table = NULL;
2740 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2742 snd_printk(KERN_ERR "cannot malloc\n");
2745 memcpy(fp, quirk->data, sizeof(*fp));
2746 if (fp->nr_rates > 0) {
2747 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2752 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2753 fp->rate_table = rate_table;
2756 stream = (fp->endpoint & USB_DIR_IN)
2757 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2758 err = add_audio_endpoint(chip, stream, fp);
2764 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2765 fp->altset_idx >= iface->num_altsetting) {
2770 alts = &iface->altsetting[fp->altset_idx];
2771 usb_set_interface(chip->dev, fp->iface, 0);
2772 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2773 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2778 * create a stream for an interface with proper descriptors
2780 static int create_standard_audio_quirk(snd_usb_audio_t *chip,
2781 struct usb_interface *iface,
2782 const snd_usb_audio_quirk_t *quirk)
2784 struct usb_host_interface *alts;
2785 struct usb_interface_descriptor *altsd;
2788 alts = &iface->altsetting[0];
2789 altsd = get_iface_desc(alts);
2790 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2792 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2793 altsd->bInterfaceNumber, err);
2796 /* reset the current interface */
2797 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2802 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2803 * to detect the sample rate is by looking at wMaxPacketSize.
2805 static int create_ua700_ua25_quirk(snd_usb_audio_t *chip,
2806 struct usb_interface *iface,
2807 const snd_usb_audio_quirk_t *quirk)
2809 static const struct audioformat ua_format = {
2810 .format = SNDRV_PCM_FORMAT_S24_3LE,
2812 .fmt_type = USB_FORMAT_TYPE_I,
2815 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2817 struct usb_host_interface *alts;
2818 struct usb_interface_descriptor *altsd;
2819 struct audioformat *fp;
2822 /* both PCM and MIDI interfaces have 2 altsettings */
2823 if (iface->num_altsetting != 2)
2825 alts = &iface->altsetting[1];
2826 altsd = get_iface_desc(alts);
2828 if (altsd->bNumEndpoints == 2) {
2829 static const snd_usb_midi_endpoint_info_t ua700_ep = {
2830 .out_cables = 0x0003,
2833 static const snd_usb_audio_quirk_t ua700_quirk = {
2834 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2837 static const snd_usb_midi_endpoint_info_t ua25_ep = {
2838 .out_cables = 0x0001,
2841 static const snd_usb_audio_quirk_t ua25_quirk = {
2842 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2845 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2846 return snd_usb_create_midi_interface(chip, iface,
2849 return snd_usb_create_midi_interface(chip, iface,
2853 if (altsd->bNumEndpoints != 1)
2856 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2859 memcpy(fp, &ua_format, sizeof(*fp));
2861 fp->iface = altsd->bInterfaceNumber;
2862 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2863 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2864 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2866 switch (fp->maxpacksize) {
2868 fp->rate_max = fp->rate_min = 44100;
2872 fp->rate_max = fp->rate_min = 48000;
2876 fp->rate_max = fp->rate_min = 96000;
2879 snd_printk(KERN_ERR "unknown sample rate\n");
2884 stream = (fp->endpoint & USB_DIR_IN)
2885 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2886 err = add_audio_endpoint(chip, stream, fp);
2891 usb_set_interface(chip->dev, fp->iface, 0);
2896 * Create a stream for an Edirol UA-1000 interface.
2898 static int create_ua1000_quirk(snd_usb_audio_t *chip,
2899 struct usb_interface *iface,
2900 const snd_usb_audio_quirk_t *quirk)
2902 static const struct audioformat ua1000_format = {
2903 .format = SNDRV_PCM_FORMAT_S32_LE,
2904 .fmt_type = USB_FORMAT_TYPE_I,
2908 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2910 struct usb_host_interface *alts;
2911 struct usb_interface_descriptor *altsd;
2912 struct audioformat *fp;
2915 if (iface->num_altsetting != 2)
2917 alts = &iface->altsetting[1];
2918 altsd = get_iface_desc(alts);
2919 if (alts->extralen != 11 || alts->extra[1] != CS_AUDIO_INTERFACE ||
2920 altsd->bNumEndpoints != 1)
2923 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2926 memcpy(fp, &ua1000_format, sizeof(*fp));
2928 fp->channels = alts->extra[4];
2929 fp->iface = altsd->bInterfaceNumber;
2930 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2931 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2932 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2933 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2935 stream = (fp->endpoint & USB_DIR_IN)
2936 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2937 err = add_audio_endpoint(chip, stream, fp);
2942 /* FIXME: playback must be synchronized to capture */
2943 usb_set_interface(chip->dev, fp->iface, 0);
2947 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2948 struct usb_interface *iface,
2949 const snd_usb_audio_quirk_t *quirk);
2952 * handle the quirks for the contained interfaces
2954 static int create_composite_quirk(snd_usb_audio_t *chip,
2955 struct usb_interface *iface,
2956 const snd_usb_audio_quirk_t *quirk)
2958 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
2961 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
2962 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
2965 if (quirk->ifnum != probed_ifnum &&
2966 usb_interface_claimed(iface))
2968 err = snd_usb_create_quirk(chip, iface, quirk);
2971 if (quirk->ifnum != probed_ifnum)
2972 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2977 static int ignore_interface_quirk(snd_usb_audio_t *chip,
2978 struct usb_interface *iface,
2979 const snd_usb_audio_quirk_t *quirk)
2989 #define EXTIGY_FIRMWARE_SIZE_OLD 794
2990 #define EXTIGY_FIRMWARE_SIZE_NEW 483
2992 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
2994 struct usb_host_config *config = dev->actconfig;
2997 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
2998 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
2999 snd_printdd("sending Extigy boot sequence...\n");
3000 /* Send message to force it to reconnect with full interface. */
3001 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3002 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3003 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3004 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3005 &dev->descriptor, sizeof(dev->descriptor));
3006 config = dev->actconfig;
3007 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3008 err = usb_reset_configuration(dev);
3009 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3010 snd_printdd("extigy_boot: new boot length = %d\n",
3011 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3012 return -ENODEV; /* quit this anyway */
3017 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3021 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3022 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3023 0, 0, &buf, 1, 1000);
3025 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3026 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3027 1, 2000, NULL, 0, 1000);
3035 * audio-interface quirks
3037 * returns zero if no standard audio/MIDI parsing is needed.
3038 * returns a postive value if standard audio/midi interfaces are parsed
3040 * returns a negative value at error.
3042 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
3043 struct usb_interface *iface,
3044 const snd_usb_audio_quirk_t *quirk)
3046 typedef int (*quirk_func_t)(snd_usb_audio_t *, struct usb_interface *,
3047 const snd_usb_audio_quirk_t *);
3048 static const quirk_func_t quirk_funcs[] = {
3049 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3050 [QUIRK_COMPOSITE] = create_composite_quirk,
3051 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3052 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3053 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3054 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3055 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3056 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3057 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3058 [QUIRK_MIDI_MIDITECH] = snd_usb_create_midi_interface,
3059 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3060 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3061 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3062 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3065 if (quirk->type < QUIRK_TYPE_COUNT) {
3066 return quirk_funcs[quirk->type](chip, iface, quirk);
3068 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3075 * common proc files to show the usb device info
3077 static void proc_audio_usbbus_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3079 snd_usb_audio_t *chip = entry->private_data;
3080 if (! chip->shutdown)
3081 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3084 static void proc_audio_usbid_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3086 snd_usb_audio_t *chip = entry->private_data;
3087 if (! chip->shutdown)
3088 snd_iprintf(buffer, "%04x:%04x\n",
3089 USB_ID_VENDOR(chip->usb_id),
3090 USB_ID_PRODUCT(chip->usb_id));
3093 static void snd_usb_audio_create_proc(snd_usb_audio_t *chip)
3095 snd_info_entry_t *entry;
3096 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3097 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbbus_read);
3098 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3099 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbid_read);
3103 * free the chip instance
3105 * here we have to do not much, since pcm and controls are already freed
3109 static int snd_usb_audio_free(snd_usb_audio_t *chip)
3115 static int snd_usb_audio_dev_free(snd_device_t *device)
3117 snd_usb_audio_t *chip = device->device_data;
3118 return snd_usb_audio_free(chip);
3123 * create a chip instance and set its names.
3125 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3126 const snd_usb_audio_quirk_t *quirk,
3127 snd_usb_audio_t **rchip)
3130 snd_usb_audio_t *chip;
3133 static snd_device_ops_t ops = {
3134 .dev_free = snd_usb_audio_dev_free,
3139 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3140 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3141 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3145 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3147 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3151 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3153 snd_card_free(card);
3160 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3161 le16_to_cpu(dev->descriptor.idProduct));
3162 INIT_LIST_HEAD(&chip->pcm_list);
3163 INIT_LIST_HEAD(&chip->midi_list);
3164 INIT_LIST_HEAD(&chip->mixer_list);
3166 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3167 snd_usb_audio_free(chip);
3168 snd_card_free(card);
3172 strcpy(card->driver, "USB-Audio");
3173 sprintf(component, "USB%04x:%04x",
3174 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3175 snd_component_add(card, component);
3177 /* retrieve the device string as shortname */
3178 if (quirk && quirk->product_name) {
3179 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3181 if (!dev->descriptor.iProduct ||
3182 usb_string(dev, dev->descriptor.iProduct,
3183 card->shortname, sizeof(card->shortname)) <= 0) {
3184 /* no name available from anywhere, so use ID */
3185 sprintf(card->shortname, "USB Device %#04x:%#04x",
3186 USB_ID_VENDOR(chip->usb_id),
3187 USB_ID_PRODUCT(chip->usb_id));
3191 /* retrieve the vendor and device strings as longname */
3192 if (quirk && quirk->vendor_name) {
3193 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3195 if (dev->descriptor.iManufacturer)
3196 len = usb_string(dev, dev->descriptor.iManufacturer,
3197 card->longname, sizeof(card->longname));
3200 /* we don't really care if there isn't any vendor string */
3203 strlcat(card->longname, " ", sizeof(card->longname));
3205 strlcat(card->longname, card->shortname, sizeof(card->longname));
3207 len = strlcat(card->longname, " at ", sizeof(card->longname));
3209 if (len < sizeof(card->longname))
3210 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3212 strlcat(card->longname,
3213 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3214 sizeof(card->longname));
3216 snd_usb_audio_create_proc(chip);
3224 * probe the active usb device
3226 * note that this can be called multiple times per a device, when it
3227 * includes multiple audio control interfaces.
3229 * thus we check the usb device pointer and creates the card instance
3230 * only at the first time. the successive calls of this function will
3231 * append the pcm interface to the corresponding card.
3233 static void *snd_usb_audio_probe(struct usb_device *dev,
3234 struct usb_interface *intf,
3235 const struct usb_device_id *usb_id)
3237 const snd_usb_audio_quirk_t *quirk = (const snd_usb_audio_quirk_t *)usb_id->driver_info;
3239 snd_usb_audio_t *chip;
3240 struct usb_host_interface *alts;
3244 alts = &intf->altsetting[0];
3245 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3246 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3247 le16_to_cpu(dev->descriptor.idProduct));
3249 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3252 /* SB Extigy needs special boot-up sequence */
3253 /* if more models come, this will go to the quirk list. */
3254 if (id == USB_ID(0x041e, 0x3000)) {
3255 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3258 /* SB Audigy 2 NX needs its own boot-up magic, too */
3259 if (id == USB_ID(0x041e, 0x3020)) {
3260 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3265 * found a config. now register to ALSA
3268 /* check whether it's already registered */
3270 down(®ister_mutex);
3271 for (i = 0; i < SNDRV_CARDS; i++) {
3272 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3273 if (usb_chip[i]->shutdown) {
3274 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3282 /* it's a fresh one.
3283 * now look for an empty slot and create a new card instance
3285 for (i = 0; i < SNDRV_CARDS; i++)
3286 if (enable[i] && ! usb_chip[i] &&
3287 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3288 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3289 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3292 snd_card_set_dev(chip->card, &intf->dev);
3296 snd_printk(KERN_ERR "no available usb audio device\n");
3301 err = 1; /* continue */
3302 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3303 /* need some special handlings */
3304 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3309 /* create normal USB audio interfaces */
3310 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3311 snd_usb_create_mixer(chip, ifnum) < 0) {
3316 /* we are allowed to call snd_card_register() many times */
3317 if (snd_card_register(chip->card) < 0) {
3321 usb_chip[chip->index] = chip;
3322 chip->num_interfaces++;
3323 up(®ister_mutex);
3327 if (chip && !chip->num_interfaces)
3328 snd_card_free(chip->card);
3329 up(®ister_mutex);
3335 * we need to take care of counter, since disconnection can be called also
3336 * many times as well as usb_audio_probe().
3338 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3340 snd_usb_audio_t *chip;
3342 struct list_head *p;
3344 if (ptr == (void *)-1L)
3349 down(®ister_mutex);
3351 chip->num_interfaces--;
3352 if (chip->num_interfaces <= 0) {
3353 snd_card_disconnect(card);
3354 /* release the pcm resources */
3355 list_for_each(p, &chip->pcm_list) {
3356 snd_usb_stream_disconnect(p);
3358 /* release the midi resources */
3359 list_for_each(p, &chip->midi_list) {
3360 snd_usbmidi_disconnect(p);
3362 /* release mixer resources */
3363 list_for_each(p, &chip->mixer_list) {
3364 snd_usb_mixer_disconnect(p);
3366 usb_chip[chip->index] = NULL;
3367 up(®ister_mutex);
3368 snd_card_free(card);
3370 up(®ister_mutex);
3375 * new 2.5 USB kernel API
3377 static int usb_audio_probe(struct usb_interface *intf,
3378 const struct usb_device_id *id)
3381 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3383 dev_set_drvdata(&intf->dev, chip);
3389 static void usb_audio_disconnect(struct usb_interface *intf)
3391 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3392 dev_get_drvdata(&intf->dev));
3396 static int __init snd_usb_audio_init(void)
3398 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3399 printk(KERN_WARNING "invalid nrpacks value.\n");
3402 usb_register(&usb_audio_driver);
3407 static void __exit snd_usb_audio_cleanup(void)
3409 usb_deregister(&usb_audio_driver);
3412 module_init(snd_usb_audio_init);
3413 module_exit(snd_usb_audio_cleanup);