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/interrupt.h>
45 #include <linux/list.h>
46 #include <linux/slab.h>
47 #include <linux/string.h>
48 #include <linux/usb.h>
49 #include <linux/vmalloc.h>
50 #include <linux/moduleparam.h>
51 #include <sound/core.h>
52 #include <sound/info.h>
53 #include <sound/pcm.h>
54 #include <sound/pcm_params.h>
55 #include <sound/initval.h>
60 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
61 MODULE_DESCRIPTION("USB Audio");
62 MODULE_LICENSE("GPL");
63 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
66 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
67 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
68 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
69 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
70 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
71 static int nrpacks = 4; /* max. number of packets per urb */
72 static int async_unlink = 1;
74 module_param_array(index, int, NULL, 0444);
75 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
76 module_param_array(id, charp, NULL, 0444);
77 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
78 module_param_array(enable, bool, NULL, 0444);
79 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
80 module_param_array(vid, int, NULL, 0444);
81 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
82 module_param_array(pid, int, NULL, 0444);
83 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
84 module_param(nrpacks, int, 0644);
85 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
86 module_param(async_unlink, bool, 0444);
87 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
91 * debug the h/w constraints
93 /* #define HW_CONST_DEBUG */
101 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
103 #define SYNC_URBS 4 /* always four urbs for sync */
104 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
106 typedef struct snd_usb_substream snd_usb_substream_t;
107 typedef struct snd_usb_stream snd_usb_stream_t;
108 typedef struct snd_urb_ctx snd_urb_ctx_t;
111 struct list_head list;
112 snd_pcm_format_t format; /* format type */
113 unsigned int channels; /* # channels */
114 unsigned int fmt_type; /* USB audio format type (1-3) */
115 unsigned int frame_size; /* samples per frame for non-audio */
116 int iface; /* interface number */
117 unsigned char altsetting; /* corresponding alternate setting */
118 unsigned char altset_idx; /* array index of altenate setting */
119 unsigned char attributes; /* corresponding attributes of cs endpoint */
120 unsigned char endpoint; /* endpoint */
121 unsigned char ep_attr; /* endpoint attributes */
122 unsigned int maxpacksize; /* max. packet size */
123 unsigned int rates; /* rate bitmasks */
124 unsigned int rate_min, rate_max; /* min/max rates */
125 unsigned int nr_rates; /* number of rate table entries */
126 unsigned int *rate_table; /* rate table */
131 unsigned int buffer_size; /* size of data buffer, if data URB */
132 snd_usb_substream_t *subs;
133 int index; /* index for urb array */
134 int packets; /* number of packets per urb */
138 int (*prepare)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
139 int (*retire)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
140 int (*prepare_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
141 int (*retire_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
144 struct snd_usb_substream {
145 snd_usb_stream_t *stream;
146 struct usb_device *dev;
147 snd_pcm_substream_t *pcm_substream;
148 int direction; /* playback or capture */
149 int interface; /* current interface */
150 int endpoint; /* assigned endpoint */
151 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
152 unsigned int cur_rate; /* current rate (for hw_params callback) */
153 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
154 unsigned int format; /* USB data format */
155 unsigned int datapipe; /* the data i/o pipe */
156 unsigned int syncpipe; /* 1 - async out or adaptive in */
157 unsigned int datainterval; /* log_2 of data packet interval */
158 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
159 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
160 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
162 unsigned int phase; /* phase accumulator */
163 unsigned int maxpacksize; /* max packet size in bytes */
164 unsigned int maxframesize; /* max packet size in frames */
165 unsigned int curpacksize; /* current packet size in bytes (for capture) */
166 unsigned int curframesize; /* current packet size in frames (for capture) */
167 unsigned int fill_max: 1; /* fill max packet size always */
168 unsigned int fmt_type; /* USB audio format type (1-3) */
169 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
171 unsigned int running: 1; /* running status */
173 unsigned int hwptr_done; /* processed frame position in the buffer */
174 unsigned int transfer_done; /* processed frames since last period update */
175 unsigned long active_mask; /* bitmask of active urbs */
176 unsigned long unlink_mask; /* bitmask of unlinked urbs */
178 unsigned int nurbs; /* # urbs */
179 snd_urb_ctx_t dataurb[MAX_URBS]; /* data urb table */
180 snd_urb_ctx_t syncurb[SYNC_URBS]; /* sync urb table */
181 char *syncbuf; /* sync buffer for all sync URBs */
182 dma_addr_t sync_dma; /* DMA address of syncbuf */
184 u64 formats; /* format bitmasks (all or'ed) */
185 unsigned int num_formats; /* number of supported audio formats (list) */
186 struct list_head fmt_list; /* format list */
188 struct tasklet_struct start_period_elapsed; /* for start trigger */
190 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
194 struct snd_usb_stream {
195 snd_usb_audio_t *chip;
198 unsigned int fmt_type; /* USB audio format type (1-3) */
199 snd_usb_substream_t substream[2];
200 struct list_head list;
205 * we keep the snd_usb_audio_t instances by ourselves for merging
206 * the all interfaces on the same card as one sound device.
209 static DECLARE_MUTEX(register_mutex);
210 static snd_usb_audio_t *usb_chip[SNDRV_CARDS];
214 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
215 * this will overflow at approx 524 kHz
217 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
219 return ((rate << 13) + 62) / 125;
223 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
224 * this will overflow at approx 4 MHz
226 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
228 return ((rate << 10) + 62) / 125;
231 /* convert our full speed USB rate into sampling rate in Hz */
232 static inline unsigned get_full_speed_hz(unsigned int usb_rate)
234 return (usb_rate * 125 + (1 << 12)) >> 13;
237 /* convert our high speed USB rate into sampling rate in Hz */
238 static inline unsigned get_high_speed_hz(unsigned int usb_rate)
240 return (usb_rate * 125 + (1 << 9)) >> 10;
245 * prepare urb for full speed capture sync pipe
247 * fill the length and offset of each urb descriptor.
248 * the fixed 10.14 frequency is passed through the pipe.
250 static int prepare_capture_sync_urb(snd_usb_substream_t *subs,
251 snd_pcm_runtime_t *runtime,
254 unsigned char *cp = urb->transfer_buffer;
255 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
257 urb->dev = ctx->subs->dev; /* we need to set this at each time */
258 urb->iso_frame_desc[0].length = 3;
259 urb->iso_frame_desc[0].offset = 0;
260 cp[0] = subs->freqn >> 2;
261 cp[1] = subs->freqn >> 10;
262 cp[2] = subs->freqn >> 18;
267 * prepare urb for high speed capture sync pipe
269 * fill the length and offset of each urb descriptor.
270 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
272 static int prepare_capture_sync_urb_hs(snd_usb_substream_t *subs,
273 snd_pcm_runtime_t *runtime,
276 unsigned char *cp = urb->transfer_buffer;
277 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
279 urb->dev = ctx->subs->dev; /* we need to set this at each time */
280 urb->iso_frame_desc[0].length = 4;
281 urb->iso_frame_desc[0].offset = 0;
283 cp[1] = subs->freqn >> 8;
284 cp[2] = subs->freqn >> 16;
285 cp[3] = subs->freqn >> 24;
290 * process after capture sync complete
293 static int retire_capture_sync_urb(snd_usb_substream_t *subs,
294 snd_pcm_runtime_t *runtime,
301 * prepare urb for capture data pipe
303 * fill the offset and length of each descriptor.
305 * we use a temporary buffer to write the captured data.
306 * since the length of written data is determined by host, we cannot
307 * write onto the pcm buffer directly... the data is thus copied
308 * later at complete callback to the global buffer.
310 static int prepare_capture_urb(snd_usb_substream_t *subs,
311 snd_pcm_runtime_t *runtime,
315 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
318 urb->dev = ctx->subs->dev; /* we need to set this at each time */
319 for (i = 0; i < ctx->packets; i++) {
320 urb->iso_frame_desc[i].offset = offs;
321 urb->iso_frame_desc[i].length = subs->curpacksize;
322 offs += subs->curpacksize;
324 urb->transfer_buffer_length = offs;
325 urb->number_of_packets = ctx->packets;
327 if (! urb->bandwidth) {
329 bustime = usb_check_bandwidth(urb->dev, urb);
332 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
333 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
340 * process after capture complete
342 * copy the data from each desctiptor to the pcm buffer, and
343 * update the current position.
345 static int retire_capture_urb(snd_usb_substream_t *subs,
346 snd_pcm_runtime_t *runtime,
352 unsigned int stride, len, oldptr;
353 int period_elapsed = 0;
355 stride = runtime->frame_bits >> 3;
357 for (i = 0; i < urb->number_of_packets; i++) {
358 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
359 if (urb->iso_frame_desc[i].status) {
360 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
363 len = urb->iso_frame_desc[i].actual_length / stride;
366 /* update the current pointer */
367 spin_lock_irqsave(&subs->lock, flags);
368 oldptr = subs->hwptr_done;
369 subs->hwptr_done += len;
370 if (subs->hwptr_done >= runtime->buffer_size)
371 subs->hwptr_done -= runtime->buffer_size;
372 subs->transfer_done += len;
373 if (subs->transfer_done >= runtime->period_size) {
374 subs->transfer_done -= runtime->period_size;
377 spin_unlock_irqrestore(&subs->lock, flags);
378 /* copy a data chunk */
379 if (oldptr + len > runtime->buffer_size) {
380 unsigned int cnt = runtime->buffer_size - oldptr;
381 unsigned int blen = cnt * stride;
382 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
383 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
385 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
389 snd_pcm_period_elapsed(subs->pcm_substream);
395 * prepare urb for full speed playback sync pipe
397 * set up the offset and length to receive the current frequency.
400 static int prepare_playback_sync_urb(snd_usb_substream_t *subs,
401 snd_pcm_runtime_t *runtime,
404 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
406 urb->dev = ctx->subs->dev; /* we need to set this at each time */
407 urb->iso_frame_desc[0].length = 3;
408 urb->iso_frame_desc[0].offset = 0;
413 * prepare urb for high speed playback sync pipe
415 * set up the offset and length to receive the current frequency.
418 static int prepare_playback_sync_urb_hs(snd_usb_substream_t *subs,
419 snd_pcm_runtime_t *runtime,
422 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
424 urb->dev = ctx->subs->dev; /* we need to set this at each time */
425 urb->iso_frame_desc[0].length = 4;
426 urb->iso_frame_desc[0].offset = 0;
431 * process after full speed playback sync complete
433 * retrieve the current 10.14 frequency from pipe, and set it.
434 * the value is referred in prepare_playback_urb().
436 static int retire_playback_sync_urb(snd_usb_substream_t *subs,
437 snd_pcm_runtime_t *runtime,
443 if (urb->iso_frame_desc[0].status == 0 &&
444 urb->iso_frame_desc[0].actual_length == 3) {
445 f = combine_triple((u8*)urb->transfer_buffer) << 2;
446 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
447 spin_lock_irqsave(&subs->lock, flags);
449 spin_unlock_irqrestore(&subs->lock, flags);
457 * process after high speed playback sync complete
459 * retrieve the current 12.13 frequency from pipe, and set it.
460 * the value is referred in prepare_playback_urb().
462 static int retire_playback_sync_urb_hs(snd_usb_substream_t *subs,
463 snd_pcm_runtime_t *runtime,
469 if (urb->iso_frame_desc[0].status == 0 &&
470 urb->iso_frame_desc[0].actual_length == 4) {
471 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
472 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
473 spin_lock_irqsave(&subs->lock, flags);
475 spin_unlock_irqrestore(&subs->lock, flags);
483 * prepare urb for playback data pipe
485 * Since a URB can handle only a single linear buffer, we must use double
486 * buffering when the data to be transferred overflows the buffer boundary.
487 * To avoid inconsistencies when updating hwptr_done, we use double buffering
490 static int prepare_playback_urb(snd_usb_substream_t *subs,
491 snd_pcm_runtime_t *runtime,
497 int period_elapsed = 0;
498 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
500 stride = runtime->frame_bits >> 3;
503 urb->dev = ctx->subs->dev; /* we need to set this at each time */
504 urb->number_of_packets = 0;
505 spin_lock_irqsave(&subs->lock, flags);
506 for (i = 0; i < ctx->packets; i++) {
507 /* calculate the size of a packet */
509 counts = subs->maxframesize; /* fixed */
511 subs->phase = (subs->phase & 0xffff)
512 + (subs->freqm << subs->datainterval);
513 counts = subs->phase >> 16;
514 if (counts > subs->maxframesize)
515 counts = subs->maxframesize;
517 /* set up descriptor */
518 urb->iso_frame_desc[i].offset = offs * stride;
519 urb->iso_frame_desc[i].length = counts * stride;
521 urb->number_of_packets++;
522 subs->transfer_done += counts;
523 if (subs->transfer_done >= runtime->period_size) {
524 subs->transfer_done -= runtime->period_size;
526 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
527 if (subs->transfer_done > 0) {
528 /* FIXME: fill-max mode is not
530 offs -= subs->transfer_done;
531 counts -= subs->transfer_done;
532 urb->iso_frame_desc[i].length =
534 subs->transfer_done = 0;
537 if (i < ctx->packets) {
538 /* add a transfer delimiter */
539 urb->iso_frame_desc[i].offset =
541 urb->iso_frame_desc[i].length = 0;
542 urb->number_of_packets++;
547 /* finish at the frame boundary at/after the period boundary */
548 if (period_elapsed &&
549 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
552 if (subs->hwptr_done + offs > runtime->buffer_size) {
553 /* err, the transferred area goes over buffer boundary. */
554 unsigned int len = runtime->buffer_size - subs->hwptr_done;
555 memcpy(urb->transfer_buffer,
556 runtime->dma_area + subs->hwptr_done * stride,
558 memcpy(urb->transfer_buffer + len * stride,
560 (offs - len) * stride);
562 memcpy(urb->transfer_buffer,
563 runtime->dma_area + subs->hwptr_done * stride,
566 subs->hwptr_done += offs;
567 if (subs->hwptr_done >= runtime->buffer_size)
568 subs->hwptr_done -= runtime->buffer_size;
569 spin_unlock_irqrestore(&subs->lock, flags);
570 urb->transfer_buffer_length = offs * stride;
571 if (period_elapsed) {
572 if (likely(subs->running))
573 snd_pcm_period_elapsed(subs->pcm_substream);
575 tasklet_hi_schedule(&subs->start_period_elapsed);
581 * process after playback data complete
584 static int retire_playback_urb(snd_usb_substream_t *subs,
585 snd_pcm_runtime_t *runtime,
592 * Delay the snd_pcm_period_elapsed() call until after the start trigger
593 * callback so that we're not longer in the substream's lock.
595 static void start_period_elapsed(unsigned long data)
597 snd_usb_substream_t *subs = (snd_usb_substream_t *)data;
598 snd_pcm_period_elapsed(subs->pcm_substream);
604 static struct snd_urb_ops audio_urb_ops[2] = {
606 .prepare = prepare_playback_urb,
607 .retire = retire_playback_urb,
608 .prepare_sync = prepare_playback_sync_urb,
609 .retire_sync = retire_playback_sync_urb,
612 .prepare = prepare_capture_urb,
613 .retire = retire_capture_urb,
614 .prepare_sync = prepare_capture_sync_urb,
615 .retire_sync = retire_capture_sync_urb,
619 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
621 .prepare = prepare_playback_urb,
622 .retire = retire_playback_urb,
623 .prepare_sync = prepare_playback_sync_urb_hs,
624 .retire_sync = retire_playback_sync_urb_hs,
627 .prepare = prepare_capture_urb,
628 .retire = retire_capture_urb,
629 .prepare_sync = prepare_capture_sync_urb_hs,
630 .retire_sync = retire_capture_sync_urb,
635 * complete callback from data urb
637 static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
639 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
640 snd_usb_substream_t *subs = ctx->subs;
641 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
644 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
645 ! subs->running || /* can be stopped during retire callback */
646 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
647 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
648 clear_bit(ctx->index, &subs->active_mask);
650 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
651 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
658 * complete callback from sync urb
660 static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
662 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
663 snd_usb_substream_t *subs = ctx->subs;
664 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
667 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
668 ! subs->running || /* can be stopped during retire callback */
669 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
670 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
671 clear_bit(ctx->index + 16, &subs->active_mask);
673 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
674 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
680 /* get the physical page pointer at the given offset */
681 static struct page *snd_pcm_get_vmalloc_page(snd_pcm_substream_t *subs,
682 unsigned long offset)
684 void *pageptr = subs->runtime->dma_area + offset;
685 return vmalloc_to_page(pageptr);
688 /* allocate virtual buffer; may be called more than once */
689 static int snd_pcm_alloc_vmalloc_buffer(snd_pcm_substream_t *subs, size_t size)
691 snd_pcm_runtime_t *runtime = subs->runtime;
692 if (runtime->dma_area) {
693 if (runtime->dma_bytes >= size)
694 return 0; /* already large enough */
695 vfree(runtime->dma_area);
697 runtime->dma_area = vmalloc(size);
698 if (! runtime->dma_area)
700 runtime->dma_bytes = size;
704 /* free virtual buffer; may be called more than once */
705 static int snd_pcm_free_vmalloc_buffer(snd_pcm_substream_t *subs)
707 snd_pcm_runtime_t *runtime = subs->runtime;
708 if (runtime->dma_area) {
709 vfree(runtime->dma_area);
710 runtime->dma_area = NULL;
717 * unlink active urbs.
719 static int deactivate_urbs(snd_usb_substream_t *subs, int force, int can_sleep)
726 if (!force && subs->stream->chip->shutdown) /* to be sure... */
729 async = !can_sleep && async_unlink;
731 if (! async && in_interrupt())
734 for (i = 0; i < subs->nurbs; i++) {
735 if (test_bit(i, &subs->active_mask)) {
736 if (! test_and_set_bit(i, &subs->unlink_mask)) {
737 struct urb *u = subs->dataurb[i].urb;
745 if (subs->syncpipe) {
746 for (i = 0; i < SYNC_URBS; i++) {
747 if (test_bit(i+16, &subs->active_mask)) {
748 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
749 struct urb *u = subs->syncurb[i].urb;
763 * set up and start data/sync urbs
765 static int start_urbs(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime)
770 if (subs->stream->chip->shutdown)
773 for (i = 0; i < subs->nurbs; i++) {
774 snd_assert(subs->dataurb[i].urb, return -EINVAL);
775 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
776 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
780 if (subs->syncpipe) {
781 for (i = 0; i < SYNC_URBS; i++) {
782 snd_assert(subs->syncurb[i].urb, return -EINVAL);
783 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
784 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
790 subs->active_mask = 0;
791 subs->unlink_mask = 0;
793 for (i = 0; i < subs->nurbs; i++) {
794 if ((err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC)) < 0) {
795 snd_printk(KERN_ERR "cannot submit datapipe for urb %d, err = %d\n", i, err);
798 set_bit(i, &subs->active_mask);
800 if (subs->syncpipe) {
801 for (i = 0; i < SYNC_URBS; i++) {
802 if ((err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC)) < 0) {
803 snd_printk(KERN_ERR "cannot submit syncpipe for urb %d, err = %d\n", i, err);
806 set_bit(i + 16, &subs->active_mask);
812 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
813 deactivate_urbs(subs, 0, 0);
819 * wait until all urbs are processed.
821 static int wait_clear_urbs(snd_usb_substream_t *subs)
823 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
829 for (i = 0; i < subs->nurbs; i++) {
830 if (test_bit(i, &subs->active_mask))
833 if (subs->syncpipe) {
834 for (i = 0; i < SYNC_URBS; i++) {
835 if (test_bit(i + 16, &subs->active_mask))
841 schedule_timeout_uninterruptible(1);
842 } while (time_before(jiffies, end_time));
844 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
850 * return the current pcm pointer. just return the hwptr_done value.
852 static snd_pcm_uframes_t snd_usb_pcm_pointer(snd_pcm_substream_t *substream)
854 snd_usb_substream_t *subs;
855 snd_pcm_uframes_t hwptr_done;
857 subs = (snd_usb_substream_t *)substream->runtime->private_data;
858 spin_lock(&subs->lock);
859 hwptr_done = subs->hwptr_done;
860 spin_unlock(&subs->lock);
866 * start/stop substream
868 static int snd_usb_pcm_trigger(snd_pcm_substream_t *substream, int cmd)
870 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
874 case SNDRV_PCM_TRIGGER_START:
875 err = start_urbs(subs, substream->runtime);
877 case SNDRV_PCM_TRIGGER_STOP:
878 err = deactivate_urbs(subs, 0, 0);
884 return err < 0 ? err : 0;
891 static void release_urb_ctx(snd_urb_ctx_t *u)
895 usb_buffer_free(u->subs->dev, u->buffer_size,
896 u->urb->transfer_buffer,
897 u->urb->transfer_dma);
898 usb_free_urb(u->urb);
904 * release a substream
906 static void release_substream_urbs(snd_usb_substream_t *subs, int force)
910 /* stop urbs (to be sure) */
911 deactivate_urbs(subs, force, 1);
912 wait_clear_urbs(subs);
914 for (i = 0; i < MAX_URBS; i++)
915 release_urb_ctx(&subs->dataurb[i]);
916 for (i = 0; i < SYNC_URBS; i++)
917 release_urb_ctx(&subs->syncurb[i]);
918 usb_buffer_free(subs->dev, SYNC_URBS * 4,
919 subs->syncbuf, subs->sync_dma);
920 subs->syncbuf = NULL;
925 * initialize a substream for plaback/capture
927 static int init_substream_urbs(snd_usb_substream_t *subs, unsigned int period_bytes,
928 unsigned int rate, unsigned int frame_bits)
930 unsigned int maxsize, n, i;
931 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
932 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
934 /* calculate the frequency in 16.16 format */
935 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
936 subs->freqn = get_usb_full_speed_rate(rate);
938 subs->freqn = get_usb_high_speed_rate(rate);
939 subs->freqm = subs->freqn;
940 /* calculate max. frequency */
941 if (subs->maxpacksize) {
942 /* whatever fits into a max. size packet */
943 maxsize = subs->maxpacksize;
944 subs->freqmax = (maxsize / (frame_bits >> 3))
945 << (16 - subs->datainterval);
947 /* no max. packet size: just take 25% higher than nominal */
948 subs->freqmax = subs->freqn + (subs->freqn >> 2);
949 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
950 >> (16 - subs->datainterval);
955 subs->curpacksize = subs->maxpacksize;
957 subs->curpacksize = maxsize;
959 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
960 packs_per_ms = 8 >> subs->datainterval;
963 subs->packs_per_ms = packs_per_ms;
967 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
968 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
971 urb_packs *= packs_per_ms;
973 /* decide how many packets to be used */
975 unsigned int minsize;
976 /* determine how small a packet can be */
977 minsize = (subs->freqn >> (16 - subs->datainterval))
979 /* with sync from device, assume it can be 12% lower */
981 minsize -= minsize >> 3;
982 minsize = max(minsize, 1u);
983 total_packs = (period_bytes + minsize - 1) / minsize;
984 /* round up to multiple of packs_per_ms */
985 total_packs = (total_packs + packs_per_ms - 1)
986 & ~(packs_per_ms - 1);
987 /* we need at least two URBs for queueing */
988 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
989 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
991 total_packs = MAX_URBS * urb_packs;
993 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
994 if (subs->nurbs > MAX_URBS) {
996 subs->nurbs = MAX_URBS;
997 total_packs = MAX_URBS * urb_packs;
1000 for (i = 0; i < subs->nurbs; i++) {
1001 npacks[i] = n > urb_packs ? urb_packs : n;
1004 if (subs->nurbs <= 1) {
1005 /* too little - we need at least two packets
1006 * to ensure contiguous playback/capture
1009 npacks[0] = (total_packs + 1) / 2;
1010 npacks[1] = total_packs - npacks[0];
1011 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1012 /* the last packet is too small.. */
1013 if (subs->nurbs > 2) {
1014 /* merge to the first one */
1015 npacks[0] += npacks[subs->nurbs - 1];
1020 npacks[0] = (total_packs + 1) / 2;
1021 npacks[1] = total_packs - npacks[0];
1025 /* allocate and initialize data urbs */
1026 for (i = 0; i < subs->nurbs; i++) {
1027 snd_urb_ctx_t *u = &subs->dataurb[i];
1030 u->packets = npacks[i];
1031 u->buffer_size = maxsize * u->packets;
1032 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1033 u->packets++; /* for transfer delimiter */
1034 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1037 u->urb->transfer_buffer =
1038 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1039 &u->urb->transfer_dma);
1040 if (! u->urb->transfer_buffer)
1042 u->urb->pipe = subs->datapipe;
1043 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1044 u->urb->interval = 1 << subs->datainterval;
1045 u->urb->context = u;
1046 u->urb->complete = snd_complete_urb;
1049 if (subs->syncpipe) {
1050 /* allocate and initialize sync urbs */
1051 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1052 GFP_KERNEL, &subs->sync_dma);
1053 if (! subs->syncbuf)
1055 for (i = 0; i < SYNC_URBS; i++) {
1056 snd_urb_ctx_t *u = &subs->syncurb[i];
1060 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1063 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1064 u->urb->transfer_dma = subs->sync_dma + i * 4;
1065 u->urb->transfer_buffer_length = 4;
1066 u->urb->pipe = subs->syncpipe;
1067 u->urb->transfer_flags = URB_ISO_ASAP |
1068 URB_NO_TRANSFER_DMA_MAP;
1069 u->urb->number_of_packets = 1;
1070 u->urb->interval = 1 << subs->syncinterval;
1071 u->urb->context = u;
1072 u->urb->complete = snd_complete_sync_urb;
1078 release_substream_urbs(subs, 0);
1084 * find a matching audio format
1086 static struct audioformat *find_format(snd_usb_substream_t *subs, unsigned int format,
1087 unsigned int rate, unsigned int channels)
1089 struct list_head *p;
1090 struct audioformat *found = NULL;
1091 int cur_attr = 0, attr;
1093 list_for_each(p, &subs->fmt_list) {
1094 struct audioformat *fp;
1095 fp = list_entry(p, struct audioformat, list);
1096 if (fp->format != format || fp->channels != channels)
1098 if (rate < fp->rate_min || rate > fp->rate_max)
1100 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1102 for (i = 0; i < fp->nr_rates; i++)
1103 if (fp->rate_table[i] == rate)
1105 if (i >= fp->nr_rates)
1108 attr = fp->ep_attr & EP_ATTR_MASK;
1114 /* avoid async out and adaptive in if the other method
1115 * supports the same format.
1116 * this is a workaround for the case like
1117 * M-audio audiophile USB.
1119 if (attr != cur_attr) {
1120 if ((attr == EP_ATTR_ASYNC &&
1121 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1122 (attr == EP_ATTR_ADAPTIVE &&
1123 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1125 if ((cur_attr == EP_ATTR_ASYNC &&
1126 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1127 (cur_attr == EP_ATTR_ADAPTIVE &&
1128 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1134 /* find the format with the largest max. packet size */
1135 if (fp->maxpacksize > found->maxpacksize) {
1145 * initialize the picth control and sample rate
1147 static int init_usb_pitch(struct usb_device *dev, int iface,
1148 struct usb_host_interface *alts,
1149 struct audioformat *fmt)
1152 unsigned char data[1];
1155 ep = get_endpoint(alts, 0)->bEndpointAddress;
1156 /* if endpoint has pitch control, enable it */
1157 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1159 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1160 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1161 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1162 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1163 dev->devnum, iface, ep);
1170 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1171 struct usb_host_interface *alts,
1172 struct audioformat *fmt, int rate)
1175 unsigned char data[3];
1178 ep = get_endpoint(alts, 0)->bEndpointAddress;
1179 /* if endpoint has sampling rate control, set it */
1180 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1183 data[1] = rate >> 8;
1184 data[2] = rate >> 16;
1185 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1186 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1187 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1188 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1189 dev->devnum, iface, fmt->altsetting, rate, ep);
1192 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1193 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1194 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1195 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1196 dev->devnum, iface, fmt->altsetting, ep);
1197 return 0; /* some devices don't support reading */
1199 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1200 if (crate != rate) {
1201 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1202 // runtime->rate = crate;
1209 * find a matching format and set up the interface
1211 static int set_format(snd_usb_substream_t *subs, struct audioformat *fmt)
1213 struct usb_device *dev = subs->dev;
1214 struct usb_host_interface *alts;
1215 struct usb_interface_descriptor *altsd;
1216 struct usb_interface *iface;
1217 unsigned int ep, attr;
1218 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1221 iface = usb_ifnum_to_if(dev, fmt->iface);
1222 snd_assert(iface, return -EINVAL);
1223 alts = &iface->altsetting[fmt->altset_idx];
1224 altsd = get_iface_desc(alts);
1225 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1227 if (fmt == subs->cur_audiofmt)
1230 /* close the old interface */
1231 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1232 usb_set_interface(subs->dev, subs->interface, 0);
1233 subs->interface = -1;
1238 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1239 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1240 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1241 dev->devnum, fmt->iface, fmt->altsetting);
1244 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1245 subs->interface = fmt->iface;
1246 subs->format = fmt->altset_idx;
1249 /* create a data pipe */
1250 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1252 subs->datapipe = usb_sndisocpipe(dev, ep);
1254 subs->datapipe = usb_rcvisocpipe(dev, ep);
1255 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1256 get_endpoint(alts, 0)->bInterval >= 1 &&
1257 get_endpoint(alts, 0)->bInterval <= 4)
1258 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1260 subs->datainterval = 0;
1261 subs->syncpipe = subs->syncinterval = 0;
1262 subs->maxpacksize = fmt->maxpacksize;
1265 /* we need a sync pipe in async OUT or adaptive IN mode */
1266 /* check the number of EP, since some devices have broken
1267 * descriptors which fool us. if it has only one EP,
1268 * assume it as adaptive-out or sync-in.
1270 attr = fmt->ep_attr & EP_ATTR_MASK;
1271 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1272 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1273 altsd->bNumEndpoints >= 2) {
1274 /* check sync-pipe endpoint */
1275 /* ... and check descriptor size before accessing bSynchAddress
1276 because there is a version of the SB Audigy 2 NX firmware lacking
1277 the audio fields in the endpoint descriptors */
1278 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1279 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1280 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1281 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1282 dev->devnum, fmt->iface, fmt->altsetting);
1285 ep = get_endpoint(alts, 1)->bEndpointAddress;
1286 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1287 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1288 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1289 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1290 dev->devnum, fmt->iface, fmt->altsetting);
1293 ep &= USB_ENDPOINT_NUMBER_MASK;
1295 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1297 subs->syncpipe = usb_sndisocpipe(dev, ep);
1298 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1299 get_endpoint(alts, 1)->bRefresh >= 1 &&
1300 get_endpoint(alts, 1)->bRefresh <= 9)
1301 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1302 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1303 subs->syncinterval = 1;
1304 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1305 get_endpoint(alts, 1)->bInterval <= 16)
1306 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1308 subs->syncinterval = 3;
1311 /* always fill max packet size */
1312 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1315 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1318 subs->cur_audiofmt = fmt;
1321 printk("setting done: format = %d, rate = %d, channels = %d\n",
1322 fmt->format, fmt->rate, fmt->channels);
1323 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1324 subs->datapipe, subs->syncpipe);
1331 * hw_params callback
1333 * allocate a buffer and set the given audio format.
1335 * so far we use a physically linear buffer although packetize transfer
1336 * doesn't need a continuous area.
1337 * if sg buffer is supported on the later version of alsa, we'll follow
1340 static int snd_usb_hw_params(snd_pcm_substream_t *substream,
1341 snd_pcm_hw_params_t *hw_params)
1343 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1344 struct audioformat *fmt;
1345 unsigned int channels, rate, format;
1348 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1349 params_buffer_bytes(hw_params));
1353 format = params_format(hw_params);
1354 rate = params_rate(hw_params);
1355 channels = params_channels(hw_params);
1356 fmt = find_format(subs, format, rate, channels);
1358 snd_printd(KERN_DEBUG "cannot set format: format = %s, rate = %d, channels = %d\n",
1359 snd_pcm_format_name(format), rate, channels);
1363 changed = subs->cur_audiofmt != fmt ||
1364 subs->period_bytes != params_period_bytes(hw_params) ||
1365 subs->cur_rate != rate;
1366 if ((ret = set_format(subs, fmt)) < 0)
1369 if (subs->cur_rate != rate) {
1370 struct usb_host_interface *alts;
1371 struct usb_interface *iface;
1372 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1373 alts = &iface->altsetting[fmt->altset_idx];
1374 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1377 subs->cur_rate = rate;
1381 /* format changed */
1382 release_substream_urbs(subs, 0);
1383 /* influenced: period_bytes, channels, rate, format, */
1384 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1385 params_rate(hw_params),
1386 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1395 * reset the audio format and release the buffer
1397 static int snd_usb_hw_free(snd_pcm_substream_t *substream)
1399 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1401 subs->cur_audiofmt = NULL;
1403 subs->period_bytes = 0;
1404 release_substream_urbs(subs, 0);
1405 return snd_pcm_free_vmalloc_buffer(substream);
1411 * only a few subtle things...
1413 static int snd_usb_pcm_prepare(snd_pcm_substream_t *substream)
1415 snd_pcm_runtime_t *runtime = substream->runtime;
1416 snd_usb_substream_t *subs = (snd_usb_substream_t *)runtime->private_data;
1418 if (! subs->cur_audiofmt) {
1419 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1423 /* some unit conversions in runtime */
1424 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1425 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1427 /* reset the pointer */
1428 subs->hwptr_done = 0;
1429 subs->transfer_done = 0;
1432 /* clear urbs (to be sure) */
1433 deactivate_urbs(subs, 0, 1);
1434 wait_clear_urbs(subs);
1439 static snd_pcm_hardware_t snd_usb_playback =
1441 .info = SNDRV_PCM_INFO_MMAP |
1442 SNDRV_PCM_INFO_MMAP_VALID |
1443 SNDRV_PCM_INFO_BATCH |
1444 SNDRV_PCM_INFO_INTERLEAVED |
1445 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1446 .buffer_bytes_max = 1024 * 1024,
1447 .period_bytes_min = 64,
1448 .period_bytes_max = 512 * 1024,
1450 .periods_max = 1024,
1453 static snd_pcm_hardware_t snd_usb_capture =
1455 .info = SNDRV_PCM_INFO_MMAP |
1456 SNDRV_PCM_INFO_MMAP_VALID |
1457 SNDRV_PCM_INFO_BATCH |
1458 SNDRV_PCM_INFO_INTERLEAVED |
1459 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1460 .buffer_bytes_max = 1024 * 1024,
1461 .period_bytes_min = 64,
1462 .period_bytes_max = 512 * 1024,
1464 .periods_max = 1024,
1471 #ifdef HW_CONST_DEBUG
1472 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1474 #define hwc_debug(fmt, args...) /**/
1477 static int hw_check_valid_format(snd_pcm_hw_params_t *params, struct audioformat *fp)
1479 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1480 snd_interval_t *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1481 snd_mask_t *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1483 /* check the format */
1484 if (! snd_mask_test(fmts, fp->format)) {
1485 hwc_debug(" > check: no supported format %d\n", fp->format);
1488 /* check the channels */
1489 if (fp->channels < ct->min || fp->channels > ct->max) {
1490 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1493 /* check the rate is within the range */
1494 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1495 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1498 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1499 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1505 static int hw_rule_rate(snd_pcm_hw_params_t *params,
1506 snd_pcm_hw_rule_t *rule)
1508 snd_usb_substream_t *subs = rule->private;
1509 struct list_head *p;
1510 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1511 unsigned int rmin, rmax;
1514 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1517 list_for_each(p, &subs->fmt_list) {
1518 struct audioformat *fp;
1519 fp = list_entry(p, struct audioformat, list);
1520 if (! hw_check_valid_format(params, fp))
1523 if (rmin > fp->rate_min)
1524 rmin = fp->rate_min;
1525 if (rmax < fp->rate_max)
1526 rmax = fp->rate_max;
1528 rmin = fp->rate_min;
1529 rmax = fp->rate_max;
1534 hwc_debug(" --> get empty\n");
1540 if (it->min < rmin) {
1545 if (it->max > rmax) {
1550 if (snd_interval_checkempty(it)) {
1554 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1559 static int hw_rule_channels(snd_pcm_hw_params_t *params,
1560 snd_pcm_hw_rule_t *rule)
1562 snd_usb_substream_t *subs = rule->private;
1563 struct list_head *p;
1564 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1565 unsigned int rmin, rmax;
1568 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1571 list_for_each(p, &subs->fmt_list) {
1572 struct audioformat *fp;
1573 fp = list_entry(p, struct audioformat, list);
1574 if (! hw_check_valid_format(params, fp))
1577 if (rmin > fp->channels)
1578 rmin = fp->channels;
1579 if (rmax < fp->channels)
1580 rmax = fp->channels;
1582 rmin = fp->channels;
1583 rmax = fp->channels;
1588 hwc_debug(" --> get empty\n");
1594 if (it->min < rmin) {
1599 if (it->max > rmax) {
1604 if (snd_interval_checkempty(it)) {
1608 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1612 static int hw_rule_format(snd_pcm_hw_params_t *params,
1613 snd_pcm_hw_rule_t *rule)
1615 snd_usb_substream_t *subs = rule->private;
1616 struct list_head *p;
1617 snd_mask_t *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1622 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1624 list_for_each(p, &subs->fmt_list) {
1625 struct audioformat *fp;
1626 fp = list_entry(p, struct audioformat, list);
1627 if (! hw_check_valid_format(params, fp))
1629 fbits |= (1ULL << fp->format);
1632 oldbits[0] = fmt->bits[0];
1633 oldbits[1] = fmt->bits[1];
1634 fmt->bits[0] &= (u32)fbits;
1635 fmt->bits[1] &= (u32)(fbits >> 32);
1636 if (! fmt->bits[0] && ! fmt->bits[1]) {
1637 hwc_debug(" --> get empty\n");
1640 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1641 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1648 * check whether the registered audio formats need special hw-constraints
1650 static int check_hw_params_convention(snd_usb_substream_t *subs)
1655 u32 cmaster, rmaster;
1656 u32 rate_min = 0, rate_max = 0;
1657 struct list_head *p;
1660 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1661 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1663 list_for_each(p, &subs->fmt_list) {
1664 struct audioformat *f;
1665 f = list_entry(p, struct audioformat, list);
1666 /* unconventional channels? */
1667 if (f->channels > 32)
1669 /* continuous rate min/max matches? */
1670 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1671 if (rate_min && f->rate_min != rate_min)
1673 if (rate_max && f->rate_max != rate_max)
1675 rate_min = f->rate_min;
1676 rate_max = f->rate_max;
1678 /* combination of continuous rates and fixed rates? */
1679 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1680 if (f->rates != rates[f->format])
1683 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1684 if (rates[f->format] && rates[f->format] != f->rates)
1687 channels[f->format] |= (1 << f->channels);
1688 rates[f->format] |= f->rates;
1690 /* check whether channels and rates match for all formats */
1691 cmaster = rmaster = 0;
1692 for (i = 0; i < MAX_MASK; i++) {
1693 if (cmaster != channels[i] && cmaster && channels[i])
1695 if (rmaster != rates[i] && rmaster && rates[i])
1698 cmaster = channels[i];
1702 /* check whether channels match for all distinct rates */
1703 memset(channels, 0, MAX_MASK * sizeof(u32));
1704 list_for_each(p, &subs->fmt_list) {
1705 struct audioformat *f;
1706 f = list_entry(p, struct audioformat, list);
1707 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1709 for (i = 0; i < 32; i++) {
1710 if (f->rates & (1 << i))
1711 channels[i] |= (1 << f->channels);
1715 for (i = 0; i < 32; i++) {
1716 if (cmaster != channels[i] && cmaster && channels[i])
1719 cmaster = channels[i];
1731 * set up the runtime hardware information.
1734 static int setup_hw_info(snd_pcm_runtime_t *runtime, snd_usb_substream_t *subs)
1736 struct list_head *p;
1739 runtime->hw.formats = subs->formats;
1741 runtime->hw.rate_min = 0x7fffffff;
1742 runtime->hw.rate_max = 0;
1743 runtime->hw.channels_min = 256;
1744 runtime->hw.channels_max = 0;
1745 runtime->hw.rates = 0;
1746 /* check min/max rates and channels */
1747 list_for_each(p, &subs->fmt_list) {
1748 struct audioformat *fp;
1749 fp = list_entry(p, struct audioformat, list);
1750 runtime->hw.rates |= fp->rates;
1751 if (runtime->hw.rate_min > fp->rate_min)
1752 runtime->hw.rate_min = fp->rate_min;
1753 if (runtime->hw.rate_max < fp->rate_max)
1754 runtime->hw.rate_max = fp->rate_max;
1755 if (runtime->hw.channels_min > fp->channels)
1756 runtime->hw.channels_min = fp->channels;
1757 if (runtime->hw.channels_max < fp->channels)
1758 runtime->hw.channels_max = fp->channels;
1759 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1760 /* FIXME: there might be more than one audio formats... */
1761 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1766 /* set the period time minimum 1ms */
1767 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1768 1000 * MIN_PACKS_URB,
1769 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1771 if (check_hw_params_convention(subs)) {
1772 hwc_debug("setting extra hw constraints...\n");
1773 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1775 SNDRV_PCM_HW_PARAM_FORMAT,
1776 SNDRV_PCM_HW_PARAM_CHANNELS,
1779 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1780 hw_rule_channels, subs,
1781 SNDRV_PCM_HW_PARAM_FORMAT,
1782 SNDRV_PCM_HW_PARAM_RATE,
1785 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1786 hw_rule_format, subs,
1787 SNDRV_PCM_HW_PARAM_RATE,
1788 SNDRV_PCM_HW_PARAM_CHANNELS,
1795 static int snd_usb_pcm_open(snd_pcm_substream_t *substream, int direction,
1796 snd_pcm_hardware_t *hw)
1798 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1799 snd_pcm_runtime_t *runtime = substream->runtime;
1800 snd_usb_substream_t *subs = &as->substream[direction];
1802 subs->interface = -1;
1805 runtime->private_data = subs;
1806 subs->pcm_substream = substream;
1807 return setup_hw_info(runtime, subs);
1810 static int snd_usb_pcm_close(snd_pcm_substream_t *substream, int direction)
1812 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1813 snd_usb_substream_t *subs = &as->substream[direction];
1815 if (subs->interface >= 0) {
1816 usb_set_interface(subs->dev, subs->interface, 0);
1817 subs->interface = -1;
1819 subs->pcm_substream = NULL;
1823 static int snd_usb_playback_open(snd_pcm_substream_t *substream)
1825 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1828 static int snd_usb_playback_close(snd_pcm_substream_t *substream)
1830 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1833 static int snd_usb_capture_open(snd_pcm_substream_t *substream)
1835 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1838 static int snd_usb_capture_close(snd_pcm_substream_t *substream)
1840 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1843 static snd_pcm_ops_t snd_usb_playback_ops = {
1844 .open = snd_usb_playback_open,
1845 .close = snd_usb_playback_close,
1846 .ioctl = snd_pcm_lib_ioctl,
1847 .hw_params = snd_usb_hw_params,
1848 .hw_free = snd_usb_hw_free,
1849 .prepare = snd_usb_pcm_prepare,
1850 .trigger = snd_usb_pcm_trigger,
1851 .pointer = snd_usb_pcm_pointer,
1852 .page = snd_pcm_get_vmalloc_page,
1855 static snd_pcm_ops_t snd_usb_capture_ops = {
1856 .open = snd_usb_capture_open,
1857 .close = snd_usb_capture_close,
1858 .ioctl = snd_pcm_lib_ioctl,
1859 .hw_params = snd_usb_hw_params,
1860 .hw_free = snd_usb_hw_free,
1861 .prepare = snd_usb_pcm_prepare,
1862 .trigger = snd_usb_pcm_trigger,
1863 .pointer = snd_usb_pcm_pointer,
1864 .page = snd_pcm_get_vmalloc_page,
1874 * combine bytes and get an integer value
1876 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1879 case 1: return *bytes;
1880 case 2: return combine_word(bytes);
1881 case 3: return combine_triple(bytes);
1882 case 4: return combine_quad(bytes);
1888 * parse descriptor buffer and return the pointer starting the given
1891 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1903 if (p[1] == dtype && (!after || (void *)p > after)) {
1912 * find a class-specified interface descriptor with the given subtype.
1914 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1916 unsigned char *p = after;
1918 while ((p = snd_usb_find_desc(buffer, buflen, p,
1919 USB_DT_CS_INTERFACE)) != NULL) {
1920 if (p[0] >= 3 && p[2] == dsubtype)
1927 * Wrapper for usb_control_msg().
1928 * Allocates a temp buffer to prevent dmaing from/to the stack.
1930 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
1931 __u8 requesttype, __u16 value, __u16 index, void *data,
1932 __u16 size, int timeout)
1938 buf = kmalloc(size, GFP_KERNEL);
1941 memcpy(buf, data, size);
1943 err = usb_control_msg(dev, pipe, request, requesttype,
1944 value, index, buf, size, timeout);
1946 memcpy(data, buf, size);
1954 * entry point for linux usb interface
1957 static int usb_audio_probe(struct usb_interface *intf,
1958 const struct usb_device_id *id);
1959 static void usb_audio_disconnect(struct usb_interface *intf);
1961 static struct usb_device_id usb_audio_ids [] = {
1962 #include "usbquirks.h"
1963 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1964 .bInterfaceClass = USB_CLASS_AUDIO,
1965 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
1966 { } /* Terminating entry */
1969 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
1971 static struct usb_driver usb_audio_driver = {
1972 .owner = THIS_MODULE,
1973 .name = "snd-usb-audio",
1974 .probe = usb_audio_probe,
1975 .disconnect = usb_audio_disconnect,
1976 .id_table = usb_audio_ids,
1981 * proc interface for list the supported pcm formats
1983 static void proc_dump_substream_formats(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
1985 struct list_head *p;
1986 static char *sync_types[4] = {
1987 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
1990 list_for_each(p, &subs->fmt_list) {
1991 struct audioformat *fp;
1992 fp = list_entry(p, struct audioformat, list);
1993 snd_iprintf(buffer, " Interface %d\n", fp->iface);
1994 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
1995 snd_iprintf(buffer, " Format: %s\n", snd_pcm_format_name(fp->format));
1996 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
1997 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
1998 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
1999 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2000 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2001 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2002 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2003 fp->rate_min, fp->rate_max);
2006 snd_iprintf(buffer, " Rates: ");
2007 for (i = 0; i < fp->nr_rates; i++) {
2009 snd_iprintf(buffer, ", ");
2010 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2012 snd_iprintf(buffer, "\n");
2014 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2015 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2019 static void proc_dump_substream_status(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
2021 if (subs->running) {
2023 snd_iprintf(buffer, " Status: Running\n");
2024 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2025 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2026 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2027 for (i = 0; i < subs->nurbs; i++)
2028 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2029 snd_iprintf(buffer, "]\n");
2030 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2031 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2032 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2033 ? get_full_speed_hz(subs->freqm)
2034 : get_high_speed_hz(subs->freqm),
2035 subs->freqm >> 16, subs->freqm & 0xffff);
2037 snd_iprintf(buffer, " Status: Stop\n");
2041 static void proc_pcm_format_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
2043 snd_usb_stream_t *stream = entry->private_data;
2045 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2047 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2048 snd_iprintf(buffer, "\nPlayback:\n");
2049 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2050 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2052 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2053 snd_iprintf(buffer, "\nCapture:\n");
2054 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2055 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2059 static void proc_pcm_format_add(snd_usb_stream_t *stream)
2061 snd_info_entry_t *entry;
2063 snd_card_t *card = stream->chip->card;
2065 sprintf(name, "stream%d", stream->pcm_index);
2066 if (! snd_card_proc_new(card, name, &entry))
2067 snd_info_set_text_ops(entry, stream, 1024, proc_pcm_format_read);
2072 * initialize the substream instance.
2075 static void init_substream(snd_usb_stream_t *as, int stream, struct audioformat *fp)
2077 snd_usb_substream_t *subs = &as->substream[stream];
2079 INIT_LIST_HEAD(&subs->fmt_list);
2080 spin_lock_init(&subs->lock);
2081 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2082 tasklet_init(&subs->start_period_elapsed, start_period_elapsed,
2083 (unsigned long)subs);
2086 subs->direction = stream;
2087 subs->dev = as->chip->dev;
2088 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2089 subs->ops = audio_urb_ops[stream];
2091 subs->ops = audio_urb_ops_high_speed[stream];
2092 snd_pcm_set_ops(as->pcm, stream,
2093 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2094 &snd_usb_playback_ops : &snd_usb_capture_ops);
2096 list_add_tail(&fp->list, &subs->fmt_list);
2097 subs->formats |= 1ULL << fp->format;
2098 subs->endpoint = fp->endpoint;
2099 subs->num_formats++;
2100 subs->fmt_type = fp->fmt_type;
2107 static void free_substream(snd_usb_substream_t *subs)
2109 struct list_head *p, *n;
2111 if (! subs->num_formats)
2112 return; /* not initialized */
2113 list_for_each_safe(p, n, &subs->fmt_list) {
2114 struct audioformat *fp = list_entry(p, struct audioformat, list);
2115 kfree(fp->rate_table);
2122 * free a usb stream instance
2124 static void snd_usb_audio_stream_free(snd_usb_stream_t *stream)
2126 free_substream(&stream->substream[0]);
2127 free_substream(&stream->substream[1]);
2128 list_del(&stream->list);
2132 static void snd_usb_audio_pcm_free(snd_pcm_t *pcm)
2134 snd_usb_stream_t *stream = pcm->private_data;
2137 snd_usb_audio_stream_free(stream);
2143 * add this endpoint to the chip instance.
2144 * if a stream with the same endpoint already exists, append to it.
2145 * if not, create a new pcm stream.
2147 static int add_audio_endpoint(snd_usb_audio_t *chip, int stream, struct audioformat *fp)
2149 struct list_head *p;
2150 snd_usb_stream_t *as;
2151 snd_usb_substream_t *subs;
2155 list_for_each(p, &chip->pcm_list) {
2156 as = list_entry(p, snd_usb_stream_t, list);
2157 if (as->fmt_type != fp->fmt_type)
2159 subs = &as->substream[stream];
2160 if (! subs->endpoint)
2162 if (subs->endpoint == fp->endpoint) {
2163 list_add_tail(&fp->list, &subs->fmt_list);
2164 subs->num_formats++;
2165 subs->formats |= 1ULL << fp->format;
2169 /* look for an empty stream */
2170 list_for_each(p, &chip->pcm_list) {
2171 as = list_entry(p, snd_usb_stream_t, list);
2172 if (as->fmt_type != fp->fmt_type)
2174 subs = &as->substream[stream];
2177 err = snd_pcm_new_stream(as->pcm, stream, 1);
2180 init_substream(as, stream, fp);
2184 /* create a new pcm */
2185 as = kmalloc(sizeof(*as), GFP_KERNEL);
2188 memset(as, 0, sizeof(*as));
2189 as->pcm_index = chip->pcm_devs;
2191 as->fmt_type = fp->fmt_type;
2192 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2193 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2194 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2201 pcm->private_data = as;
2202 pcm->private_free = snd_usb_audio_pcm_free;
2203 pcm->info_flags = 0;
2204 if (chip->pcm_devs > 0)
2205 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2207 strcpy(pcm->name, "USB Audio");
2209 init_substream(as, stream, fp);
2211 list_add(&as->list, &chip->pcm_list);
2214 proc_pcm_format_add(as);
2221 * check if the device uses big-endian samples
2223 static int is_big_endian_format(snd_usb_audio_t *chip, struct audioformat *fp)
2225 switch (chip->usb_id) {
2226 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2227 if (fp->endpoint & USB_DIR_IN)
2230 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2237 * parse the audio format type I descriptor
2238 * and returns the corresponding pcm format
2241 * @fp: audioformat record
2242 * @format: the format tag (wFormatTag)
2243 * @fmt: the format type descriptor
2245 static int parse_audio_format_i_type(snd_usb_audio_t *chip, struct audioformat *fp,
2246 int format, unsigned char *fmt)
2249 int sample_width, sample_bytes;
2251 /* FIXME: correct endianess and sign? */
2253 sample_width = fmt[6];
2254 sample_bytes = fmt[5];
2256 case 0: /* some devices don't define this correctly... */
2257 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2258 chip->dev->devnum, fp->iface, fp->altsetting);
2260 case USB_AUDIO_FORMAT_PCM:
2261 if (sample_width > sample_bytes * 8) {
2262 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2263 chip->dev->devnum, fp->iface, fp->altsetting,
2264 sample_width, sample_bytes);
2266 /* check the format byte size */
2269 pcm_format = SNDRV_PCM_FORMAT_S8;
2272 if (is_big_endian_format(chip, fp))
2273 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2275 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2278 if (is_big_endian_format(chip, fp))
2279 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2281 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2284 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2287 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2288 chip->dev->devnum, fp->iface,
2289 fp->altsetting, sample_width, sample_bytes);
2293 case USB_AUDIO_FORMAT_PCM8:
2294 /* Dallas DS4201 workaround */
2295 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2296 pcm_format = SNDRV_PCM_FORMAT_S8;
2298 pcm_format = SNDRV_PCM_FORMAT_U8;
2300 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2301 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2303 case USB_AUDIO_FORMAT_ALAW:
2304 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2306 case USB_AUDIO_FORMAT_MU_LAW:
2307 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2310 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2311 chip->dev->devnum, fp->iface, fp->altsetting, format);
2319 * parse the format descriptor and stores the possible sample rates
2320 * on the audioformat table.
2323 * @fp: audioformat record
2324 * @fmt: the format descriptor
2325 * @offset: the start offset of descriptor pointing the rate type
2326 * (7 for type I and II, 8 for type II)
2328 static int parse_audio_format_rates(snd_usb_audio_t *chip, struct audioformat *fp,
2329 unsigned char *fmt, int offset)
2331 int nr_rates = fmt[offset];
2332 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2333 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2334 chip->dev->devnum, fp->iface, fp->altsetting);
2340 * build the rate table and bitmap flags
2343 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2344 static unsigned int conv_rates[] = {
2345 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2346 64000, 88200, 96000, 176400, 192000
2348 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2349 if (fp->rate_table == NULL) {
2350 snd_printk(KERN_ERR "cannot malloc\n");
2354 fp->nr_rates = nr_rates;
2355 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2356 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2357 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2358 if (rate < fp->rate_min)
2359 fp->rate_min = rate;
2360 else if (rate > fp->rate_max)
2361 fp->rate_max = rate;
2362 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2363 if (rate == conv_rates[c]) {
2364 fp->rates |= (1 << c);
2370 /* continuous rates */
2371 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2372 fp->rate_min = combine_triple(&fmt[offset + 1]);
2373 fp->rate_max = combine_triple(&fmt[offset + 4]);
2379 * parse the format type I and III descriptors
2381 static int parse_audio_format_i(snd_usb_audio_t *chip, struct audioformat *fp,
2382 int format, unsigned char *fmt)
2386 if (fmt[3] == USB_FORMAT_TYPE_III) {
2387 /* FIXME: the format type is really IECxxx
2388 * but we give normal PCM format to get the existing
2391 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2393 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2397 fp->format = pcm_format;
2398 fp->channels = fmt[4];
2399 if (fp->channels < 1) {
2400 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2401 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2404 return parse_audio_format_rates(chip, fp, fmt, 7);
2408 * prase the format type II descriptor
2410 static int parse_audio_format_ii(snd_usb_audio_t *chip, struct audioformat *fp,
2411 int format, unsigned char *fmt)
2413 int brate, framesize;
2415 case USB_AUDIO_FORMAT_AC3:
2416 /* FIXME: there is no AC3 format defined yet */
2417 // fp->format = SNDRV_PCM_FORMAT_AC3;
2418 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2420 case USB_AUDIO_FORMAT_MPEG:
2421 fp->format = SNDRV_PCM_FORMAT_MPEG;
2424 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2425 chip->dev->devnum, fp->iface, fp->altsetting, format);
2426 fp->format = SNDRV_PCM_FORMAT_MPEG;
2430 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2431 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2432 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2433 fp->frame_size = framesize;
2434 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2437 static int parse_audio_format(snd_usb_audio_t *chip, struct audioformat *fp,
2438 int format, unsigned char *fmt, int stream)
2443 case USB_FORMAT_TYPE_I:
2444 case USB_FORMAT_TYPE_III:
2445 err = parse_audio_format_i(chip, fp, format, fmt);
2447 case USB_FORMAT_TYPE_II:
2448 err = parse_audio_format_ii(chip, fp, format, fmt);
2451 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2452 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2455 fp->fmt_type = fmt[3];
2459 /* FIXME: temporary hack for extigy/audigy 2 nx */
2460 /* extigy apparently supports sample rates other than 48k
2461 * but not in ordinary way. so we enable only 48k atm.
2463 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2464 chip->usb_id == USB_ID(0x041e, 0x3020)) {
2465 if (fmt[3] == USB_FORMAT_TYPE_I &&
2466 fp->rates != SNDRV_PCM_RATE_48000 &&
2467 fp->rates != SNDRV_PCM_RATE_96000)
2474 static int parse_audio_endpoints(snd_usb_audio_t *chip, int iface_no)
2476 struct usb_device *dev;
2477 struct usb_interface *iface;
2478 struct usb_host_interface *alts;
2479 struct usb_interface_descriptor *altsd;
2480 int i, altno, err, stream;
2482 struct audioformat *fp;
2483 unsigned char *fmt, *csep;
2487 /* parse the interface's altsettings */
2488 iface = usb_ifnum_to_if(dev, iface_no);
2489 for (i = 0; i < iface->num_altsetting; i++) {
2490 alts = &iface->altsetting[i];
2491 altsd = get_iface_desc(alts);
2492 /* skip invalid one */
2493 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2494 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2495 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2496 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2497 altsd->bNumEndpoints < 1 ||
2498 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2500 /* must be isochronous */
2501 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2502 USB_ENDPOINT_XFER_ISOC)
2504 /* check direction */
2505 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2506 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2507 altno = altsd->bAlternateSetting;
2509 /* get audio formats */
2510 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2512 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2513 dev->devnum, iface_no, altno);
2518 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2519 dev->devnum, iface_no, altno);
2523 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2525 /* get format type */
2526 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2528 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2529 dev->devnum, iface_no, altno);
2533 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2534 dev->devnum, iface_no, altno);
2538 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2539 /* Creamware Noah has this descriptor after the 2nd endpoint */
2540 if (!csep && altsd->bNumEndpoints >= 2)
2541 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2542 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2543 snd_printk(KERN_ERR "%d:%u:%d : no or invalid class specific endpoint descriptor\n",
2544 dev->devnum, iface_no, altno);
2548 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2550 snd_printk(KERN_ERR "cannot malloc\n");
2554 memset(fp, 0, sizeof(*fp));
2555 fp->iface = iface_no;
2556 fp->altsetting = altno;
2558 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2559 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2560 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2561 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2562 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2563 * (fp->maxpacksize & 0x7ff);
2564 fp->attributes = csep[3];
2566 /* some quirks for attributes here */
2568 switch (chip->usb_id) {
2569 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2570 /* Optoplay sets the sample rate attribute although
2571 * it seems not supporting it in fact.
2573 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2575 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2576 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2577 /* doesn't set the sample rate attribute, but supports it */
2578 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2580 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2581 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2582 an older model 77d:223) */
2584 * plantronics headset and Griffin iMic have set adaptive-in
2585 * although it's really not...
2587 fp->ep_attr &= ~EP_ATTR_MASK;
2588 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2589 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2591 fp->ep_attr |= EP_ATTR_SYNC;
2595 /* ok, let's parse further... */
2596 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2597 kfree(fp->rate_table);
2602 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, i, fp->endpoint);
2603 err = add_audio_endpoint(chip, stream, fp);
2605 kfree(fp->rate_table);
2609 /* try to set the interface... */
2610 usb_set_interface(chip->dev, iface_no, altno);
2611 init_usb_pitch(chip->dev, iface_no, alts, fp);
2612 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2619 * disconnect streams
2620 * called from snd_usb_audio_disconnect()
2622 static void snd_usb_stream_disconnect(struct list_head *head)
2625 snd_usb_stream_t *as;
2626 snd_usb_substream_t *subs;
2628 as = list_entry(head, snd_usb_stream_t, list);
2629 for (idx = 0; idx < 2; idx++) {
2630 subs = &as->substream[idx];
2631 if (!subs->num_formats)
2633 release_substream_urbs(subs, 1);
2634 subs->interface = -1;
2639 * parse audio control descriptor and create pcm/midi streams
2641 static int snd_usb_create_streams(snd_usb_audio_t *chip, int ctrlif)
2643 struct usb_device *dev = chip->dev;
2644 struct usb_host_interface *host_iface;
2645 struct usb_interface *iface;
2649 /* find audiocontrol interface */
2650 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2651 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2652 snd_printk(KERN_ERR "cannot find HEADER\n");
2655 if (! p1[7] || p1[0] < 8 + p1[7]) {
2656 snd_printk(KERN_ERR "invalid HEADER\n");
2661 * parse all USB audio streaming interfaces
2663 for (i = 0; i < p1[7]; i++) {
2664 struct usb_host_interface *alts;
2665 struct usb_interface_descriptor *altsd;
2667 iface = usb_ifnum_to_if(dev, j);
2669 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2670 dev->devnum, ctrlif, j);
2673 if (usb_interface_claimed(iface)) {
2674 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2677 alts = &iface->altsetting[0];
2678 altsd = get_iface_desc(alts);
2679 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2680 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2681 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2682 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2683 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2686 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2689 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2690 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2691 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2692 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2693 /* skip non-supported classes */
2696 if (! parse_audio_endpoints(chip, j)) {
2697 usb_set_interface(dev, j, 0); /* reset the current interface */
2698 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2706 * create a stream for an endpoint/altsetting without proper descriptors
2708 static int create_fixed_stream_quirk(snd_usb_audio_t *chip,
2709 struct usb_interface *iface,
2710 const snd_usb_audio_quirk_t *quirk)
2712 struct audioformat *fp;
2713 struct usb_host_interface *alts;
2715 int *rate_table = NULL;
2717 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2719 snd_printk(KERN_ERR "cannot malloc\n");
2722 memcpy(fp, quirk->data, sizeof(*fp));
2723 if (fp->nr_rates > 0) {
2724 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2729 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2730 fp->rate_table = rate_table;
2733 stream = (fp->endpoint & USB_DIR_IN)
2734 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2735 err = add_audio_endpoint(chip, stream, fp);
2741 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2742 fp->altset_idx >= iface->num_altsetting) {
2747 alts = &iface->altsetting[fp->altset_idx];
2748 usb_set_interface(chip->dev, fp->iface, 0);
2749 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2750 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2755 * create a stream for an interface with proper descriptors
2757 static int create_standard_audio_quirk(snd_usb_audio_t *chip,
2758 struct usb_interface *iface,
2759 const snd_usb_audio_quirk_t *quirk)
2761 struct usb_host_interface *alts;
2762 struct usb_interface_descriptor *altsd;
2765 alts = &iface->altsetting[0];
2766 altsd = get_iface_desc(alts);
2767 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2769 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2770 altsd->bInterfaceNumber, err);
2773 /* reset the current interface */
2774 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2779 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2780 * to detect the sample rate is by looking at wMaxPacketSize.
2782 static int create_ua700_ua25_quirk(snd_usb_audio_t *chip,
2783 struct usb_interface *iface,
2784 const snd_usb_audio_quirk_t *quirk)
2786 static const struct audioformat ua_format = {
2787 .format = SNDRV_PCM_FORMAT_S24_3LE,
2789 .fmt_type = USB_FORMAT_TYPE_I,
2792 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2794 struct usb_host_interface *alts;
2795 struct usb_interface_descriptor *altsd;
2796 struct audioformat *fp;
2799 /* both PCM and MIDI interfaces have 2 altsettings */
2800 if (iface->num_altsetting != 2)
2802 alts = &iface->altsetting[1];
2803 altsd = get_iface_desc(alts);
2805 if (altsd->bNumEndpoints == 2) {
2806 static const snd_usb_midi_endpoint_info_t ua700_ep = {
2807 .out_cables = 0x0003,
2810 static const snd_usb_audio_quirk_t ua700_quirk = {
2811 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2814 static const snd_usb_midi_endpoint_info_t ua25_ep = {
2815 .out_cables = 0x0001,
2818 static const snd_usb_audio_quirk_t ua25_quirk = {
2819 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2822 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2823 return snd_usb_create_midi_interface(chip, iface,
2826 return snd_usb_create_midi_interface(chip, iface,
2830 if (altsd->bNumEndpoints != 1)
2833 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2836 memcpy(fp, &ua_format, sizeof(*fp));
2838 fp->iface = altsd->bInterfaceNumber;
2839 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2840 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2841 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2843 switch (fp->maxpacksize) {
2845 fp->rate_max = fp->rate_min = 44100;
2849 fp->rate_max = fp->rate_min = 48000;
2853 fp->rate_max = fp->rate_min = 96000;
2856 snd_printk(KERN_ERR "unknown sample rate\n");
2861 stream = (fp->endpoint & USB_DIR_IN)
2862 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2863 err = add_audio_endpoint(chip, stream, fp);
2868 usb_set_interface(chip->dev, fp->iface, 0);
2873 * Create a stream for an Edirol UA-1000 interface.
2875 static int create_ua1000_quirk(snd_usb_audio_t *chip,
2876 struct usb_interface *iface,
2877 const snd_usb_audio_quirk_t *quirk)
2879 static const struct audioformat ua1000_format = {
2880 .format = SNDRV_PCM_FORMAT_S32_LE,
2881 .fmt_type = USB_FORMAT_TYPE_I,
2885 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2887 struct usb_host_interface *alts;
2888 struct usb_interface_descriptor *altsd;
2889 struct audioformat *fp;
2892 if (iface->num_altsetting != 2)
2894 alts = &iface->altsetting[1];
2895 altsd = get_iface_desc(alts);
2896 if (alts->extralen != 11 || alts->extra[1] != CS_AUDIO_INTERFACE ||
2897 altsd->bNumEndpoints != 1)
2900 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2903 memcpy(fp, &ua1000_format, sizeof(*fp));
2905 fp->channels = alts->extra[4];
2906 fp->iface = altsd->bInterfaceNumber;
2907 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2908 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2909 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2910 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2912 stream = (fp->endpoint & USB_DIR_IN)
2913 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2914 err = add_audio_endpoint(chip, stream, fp);
2919 /* FIXME: playback must be synchronized to capture */
2920 usb_set_interface(chip->dev, fp->iface, 0);
2924 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2925 struct usb_interface *iface,
2926 const snd_usb_audio_quirk_t *quirk);
2929 * handle the quirks for the contained interfaces
2931 static int create_composite_quirk(snd_usb_audio_t *chip,
2932 struct usb_interface *iface,
2933 const snd_usb_audio_quirk_t *quirk)
2935 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
2938 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
2939 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
2942 if (quirk->ifnum != probed_ifnum &&
2943 usb_interface_claimed(iface))
2945 err = snd_usb_create_quirk(chip, iface, quirk);
2948 if (quirk->ifnum != probed_ifnum)
2949 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2954 static int ignore_interface_quirk(snd_usb_audio_t *chip,
2955 struct usb_interface *iface,
2956 const snd_usb_audio_quirk_t *quirk)
2966 #define EXTIGY_FIRMWARE_SIZE_OLD 794
2967 #define EXTIGY_FIRMWARE_SIZE_NEW 483
2969 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
2971 struct usb_host_config *config = dev->actconfig;
2974 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
2975 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
2976 snd_printdd("sending Extigy boot sequence...\n");
2977 /* Send message to force it to reconnect with full interface. */
2978 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
2979 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
2980 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
2981 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
2982 &dev->descriptor, sizeof(dev->descriptor));
2983 config = dev->actconfig;
2984 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
2985 err = usb_reset_configuration(dev);
2986 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
2987 snd_printdd("extigy_boot: new boot length = %d\n",
2988 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
2989 return -ENODEV; /* quit this anyway */
2994 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
2998 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
2999 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3000 0, 0, &buf, 1, 1000);
3002 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3003 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3004 1, 2000, NULL, 0, 1000);
3012 * audio-interface quirks
3014 * returns zero if no standard audio/MIDI parsing is needed.
3015 * returns a postive value if standard audio/midi interfaces are parsed
3017 * returns a negative value at error.
3019 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
3020 struct usb_interface *iface,
3021 const snd_usb_audio_quirk_t *quirk)
3023 typedef int (*quirk_func_t)(snd_usb_audio_t *, struct usb_interface *,
3024 const snd_usb_audio_quirk_t *);
3025 static const quirk_func_t quirk_funcs[] = {
3026 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3027 [QUIRK_COMPOSITE] = create_composite_quirk,
3028 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3029 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3030 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3031 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3032 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3033 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3034 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3035 [QUIRK_MIDI_MIDITECH] = snd_usb_create_midi_interface,
3036 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3037 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3038 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3039 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3042 if (quirk->type < QUIRK_TYPE_COUNT) {
3043 return quirk_funcs[quirk->type](chip, iface, quirk);
3045 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3052 * common proc files to show the usb device info
3054 static void proc_audio_usbbus_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3056 snd_usb_audio_t *chip = entry->private_data;
3057 if (! chip->shutdown)
3058 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3061 static void proc_audio_usbid_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3063 snd_usb_audio_t *chip = entry->private_data;
3064 if (! chip->shutdown)
3065 snd_iprintf(buffer, "%04x:%04x\n",
3066 USB_ID_VENDOR(chip->usb_id),
3067 USB_ID_PRODUCT(chip->usb_id));
3070 static void snd_usb_audio_create_proc(snd_usb_audio_t *chip)
3072 snd_info_entry_t *entry;
3073 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3074 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbbus_read);
3075 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3076 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbid_read);
3080 * free the chip instance
3082 * here we have to do not much, since pcm and controls are already freed
3086 static int snd_usb_audio_free(snd_usb_audio_t *chip)
3092 static int snd_usb_audio_dev_free(snd_device_t *device)
3094 snd_usb_audio_t *chip = device->device_data;
3095 return snd_usb_audio_free(chip);
3100 * create a chip instance and set its names.
3102 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3103 const snd_usb_audio_quirk_t *quirk,
3104 snd_usb_audio_t **rchip)
3107 snd_usb_audio_t *chip;
3110 static snd_device_ops_t ops = {
3111 .dev_free = snd_usb_audio_dev_free,
3116 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3117 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3118 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3122 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3124 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3128 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3130 snd_card_free(card);
3137 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3138 le16_to_cpu(dev->descriptor.idProduct));
3139 INIT_LIST_HEAD(&chip->pcm_list);
3140 INIT_LIST_HEAD(&chip->midi_list);
3141 INIT_LIST_HEAD(&chip->mixer_list);
3143 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3144 snd_usb_audio_free(chip);
3145 snd_card_free(card);
3149 strcpy(card->driver, "USB-Audio");
3150 sprintf(component, "USB%04x:%04x",
3151 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3152 snd_component_add(card, component);
3154 /* retrieve the device string as shortname */
3155 if (quirk && quirk->product_name) {
3156 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3158 if (!dev->descriptor.iProduct ||
3159 usb_string(dev, dev->descriptor.iProduct,
3160 card->shortname, sizeof(card->shortname)) <= 0) {
3161 /* no name available from anywhere, so use ID */
3162 sprintf(card->shortname, "USB Device %#04x:%#04x",
3163 USB_ID_VENDOR(chip->usb_id),
3164 USB_ID_PRODUCT(chip->usb_id));
3168 /* retrieve the vendor and device strings as longname */
3169 if (quirk && quirk->vendor_name) {
3170 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3172 if (dev->descriptor.iManufacturer)
3173 len = usb_string(dev, dev->descriptor.iManufacturer,
3174 card->longname, sizeof(card->longname));
3177 /* we don't really care if there isn't any vendor string */
3180 strlcat(card->longname, " ", sizeof(card->longname));
3182 strlcat(card->longname, card->shortname, sizeof(card->longname));
3184 len = strlcat(card->longname, " at ", sizeof(card->longname));
3186 if (len < sizeof(card->longname))
3187 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3189 strlcat(card->longname,
3190 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3191 sizeof(card->longname));
3193 snd_usb_audio_create_proc(chip);
3201 * probe the active usb device
3203 * note that this can be called multiple times per a device, when it
3204 * includes multiple audio control interfaces.
3206 * thus we check the usb device pointer and creates the card instance
3207 * only at the first time. the successive calls of this function will
3208 * append the pcm interface to the corresponding card.
3210 static void *snd_usb_audio_probe(struct usb_device *dev,
3211 struct usb_interface *intf,
3212 const struct usb_device_id *usb_id)
3214 const snd_usb_audio_quirk_t *quirk = (const snd_usb_audio_quirk_t *)usb_id->driver_info;
3216 snd_usb_audio_t *chip;
3217 struct usb_host_interface *alts;
3221 alts = &intf->altsetting[0];
3222 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3223 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3224 le16_to_cpu(dev->descriptor.idProduct));
3226 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3229 /* SB Extigy needs special boot-up sequence */
3230 /* if more models come, this will go to the quirk list. */
3231 if (id == USB_ID(0x041e, 0x3000)) {
3232 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3235 /* SB Audigy 2 NX needs its own boot-up magic, too */
3236 if (id == USB_ID(0x041e, 0x3020)) {
3237 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3242 * found a config. now register to ALSA
3245 /* check whether it's already registered */
3247 down(®ister_mutex);
3248 for (i = 0; i < SNDRV_CARDS; i++) {
3249 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3250 if (usb_chip[i]->shutdown) {
3251 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3259 /* it's a fresh one.
3260 * now look for an empty slot and create a new card instance
3262 for (i = 0; i < SNDRV_CARDS; i++)
3263 if (enable[i] && ! usb_chip[i] &&
3264 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3265 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3266 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3269 snd_card_set_dev(chip->card, &intf->dev);
3273 snd_printk(KERN_ERR "no available usb audio device\n");
3278 err = 1; /* continue */
3279 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3280 /* need some special handlings */
3281 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3286 /* create normal USB audio interfaces */
3287 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3288 snd_usb_create_mixer(chip, ifnum) < 0) {
3293 /* we are allowed to call snd_card_register() many times */
3294 if (snd_card_register(chip->card) < 0) {
3298 usb_chip[chip->index] = chip;
3299 chip->num_interfaces++;
3300 up(®ister_mutex);
3304 if (chip && !chip->num_interfaces)
3305 snd_card_free(chip->card);
3306 up(®ister_mutex);
3312 * we need to take care of counter, since disconnection can be called also
3313 * many times as well as usb_audio_probe().
3315 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3317 snd_usb_audio_t *chip;
3319 struct list_head *p;
3321 if (ptr == (void *)-1L)
3326 down(®ister_mutex);
3328 chip->num_interfaces--;
3329 if (chip->num_interfaces <= 0) {
3330 snd_card_disconnect(card);
3331 /* release the pcm resources */
3332 list_for_each(p, &chip->pcm_list) {
3333 snd_usb_stream_disconnect(p);
3335 /* release the midi resources */
3336 list_for_each(p, &chip->midi_list) {
3337 snd_usbmidi_disconnect(p);
3339 /* release mixer resources */
3340 list_for_each(p, &chip->mixer_list) {
3341 snd_usb_mixer_disconnect(p);
3343 usb_chip[chip->index] = NULL;
3344 up(®ister_mutex);
3345 snd_card_free(card);
3347 up(®ister_mutex);
3352 * new 2.5 USB kernel API
3354 static int usb_audio_probe(struct usb_interface *intf,
3355 const struct usb_device_id *id)
3358 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3360 dev_set_drvdata(&intf->dev, chip);
3366 static void usb_audio_disconnect(struct usb_interface *intf)
3368 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3369 dev_get_drvdata(&intf->dev));
3373 static int __init snd_usb_audio_init(void)
3375 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3376 printk(KERN_WARNING "invalid nrpacks value.\n");
3379 usb_register(&usb_audio_driver);
3384 static void __exit snd_usb_audio_cleanup(void)
3386 usb_deregister(&usb_audio_driver);
3389 module_init(snd_usb_audio_init);
3390 module_exit(snd_usb_audio_cleanup);