2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * - async unlink should be used for avoiding the sleep inside lock.
31 * 2.4.22 usb-uhci seems buggy for async unlinking and results in
32 * oops. in such a cse, pass async_unlink=0 option.
33 * - the linked URBs would be preferred but not used so far because of
34 * the instability of unlinking.
35 * - type II is not supported properly. there is no device which supports
36 * this type *correctly*. SB extigy looks as if it supports, but it's
37 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
41 #include <sound/driver.h>
42 #include <linux/bitops.h>
43 #include <linux/init.h>
44 #include <linux/list.h>
45 #include <linux/slab.h>
46 #include <linux/string.h>
47 #include <linux/usb.h>
48 #include <linux/moduleparam.h>
49 #include <sound/core.h>
50 #include <sound/info.h>
51 #include <sound/pcm.h>
52 #include <sound/pcm_params.h>
53 #include <sound/initval.h>
58 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
59 MODULE_DESCRIPTION("USB Audio");
60 MODULE_LICENSE("GPL");
61 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
64 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
65 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
66 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
67 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
68 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
69 static int nrpacks = 4; /* max. number of packets per urb */
70 static int async_unlink = 1;
72 module_param_array(index, int, NULL, 0444);
73 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
74 module_param_array(id, charp, NULL, 0444);
75 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
76 module_param_array(enable, bool, NULL, 0444);
77 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
78 module_param_array(vid, int, NULL, 0444);
79 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
80 module_param_array(pid, int, NULL, 0444);
81 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
82 module_param(nrpacks, int, 0644);
83 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
84 module_param(async_unlink, bool, 0444);
85 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
89 * debug the h/w constraints
91 /* #define HW_CONST_DEBUG */
99 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
101 #define SYNC_URBS 4 /* always four urbs for sync */
102 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
104 typedef struct snd_usb_substream snd_usb_substream_t;
105 typedef struct snd_usb_stream snd_usb_stream_t;
106 typedef struct snd_urb_ctx snd_urb_ctx_t;
109 struct list_head list;
110 snd_pcm_format_t format; /* format type */
111 unsigned int channels; /* # channels */
112 unsigned int fmt_type; /* USB audio format type (1-3) */
113 unsigned int frame_size; /* samples per frame for non-audio */
114 int iface; /* interface number */
115 unsigned char altsetting; /* corresponding alternate setting */
116 unsigned char altset_idx; /* array index of altenate setting */
117 unsigned char attributes; /* corresponding attributes of cs endpoint */
118 unsigned char endpoint; /* endpoint */
119 unsigned char ep_attr; /* endpoint attributes */
120 unsigned int maxpacksize; /* max. packet size */
121 unsigned int rates; /* rate bitmasks */
122 unsigned int rate_min, rate_max; /* min/max rates */
123 unsigned int nr_rates; /* number of rate table entries */
124 unsigned int *rate_table; /* rate table */
129 snd_usb_substream_t *subs;
130 int index; /* index for urb array */
131 int packets; /* number of packets per urb */
132 int transfer; /* transferred size */
133 char *buf; /* buffer for capture */
137 int (*prepare)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
138 int (*retire)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
139 int (*prepare_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
140 int (*retire_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
143 struct snd_usb_substream {
144 snd_usb_stream_t *stream;
145 struct usb_device *dev;
146 snd_pcm_substream_t *pcm_substream;
147 int direction; /* playback or capture */
148 int interface; /* current interface */
149 int endpoint; /* assigned endpoint */
150 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
151 unsigned int cur_rate; /* current rate (for hw_params callback) */
152 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
153 unsigned int format; /* USB data format */
154 unsigned int datapipe; /* the data i/o pipe */
155 unsigned int syncpipe; /* 1 - async out or adaptive in */
156 unsigned int 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) */
169 unsigned int running: 1; /* running status */
171 unsigned int hwptr; /* free frame position in the buffer (only for playback) */
172 unsigned int hwptr_done; /* processed frame position in the buffer */
173 unsigned int transfer_sched; /* scheduled frames since last period (for playback) */
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_URBS * 4]; /* sync buffer; it's so small - let's get static */
182 char *tmpbuf; /* temporary buffer for playback */
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 */
189 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
193 struct snd_usb_stream {
194 snd_usb_audio_t *chip;
197 unsigned int fmt_type; /* USB audio format type (1-3) */
198 snd_usb_substream_t substream[2];
199 struct list_head list;
204 * we keep the snd_usb_audio_t instances by ourselves for merging
205 * the all interfaces on the same card as one sound device.
208 static DECLARE_MUTEX(register_mutex);
209 static snd_usb_audio_t *usb_chip[SNDRV_CARDS];
213 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
214 * this will overflow at approx 524 kHz
216 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
218 return ((rate << 13) + 62) / 125;
222 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
223 * this will overflow at approx 4 MHz
225 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
227 return ((rate << 10) + 62) / 125;
230 /* convert our full speed USB rate into sampling rate in Hz */
231 static inline unsigned get_full_speed_hz(unsigned int usb_rate)
233 return (usb_rate * 125 + (1 << 12)) >> 13;
236 /* convert our high speed USB rate into sampling rate in Hz */
237 static inline unsigned get_high_speed_hz(unsigned int usb_rate)
239 return (usb_rate * 125 + (1 << 9)) >> 10;
244 * prepare urb for full speed capture sync pipe
246 * fill the length and offset of each urb descriptor.
247 * the fixed 10.14 frequency is passed through the pipe.
249 static int prepare_capture_sync_urb(snd_usb_substream_t *subs,
250 snd_pcm_runtime_t *runtime,
253 unsigned char *cp = urb->transfer_buffer;
254 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
256 urb->dev = ctx->subs->dev; /* we need to set this at each time */
257 urb->iso_frame_desc[0].length = 3;
258 urb->iso_frame_desc[0].offset = 0;
259 cp[0] = subs->freqn >> 2;
260 cp[1] = subs->freqn >> 10;
261 cp[2] = subs->freqn >> 18;
266 * prepare urb for high speed capture sync pipe
268 * fill the length and offset of each urb descriptor.
269 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
271 static int prepare_capture_sync_urb_hs(snd_usb_substream_t *subs,
272 snd_pcm_runtime_t *runtime,
275 unsigned char *cp = urb->transfer_buffer;
276 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
278 urb->dev = ctx->subs->dev; /* we need to set this at each time */
279 urb->iso_frame_desc[0].length = 4;
280 urb->iso_frame_desc[0].offset = 0;
282 cp[1] = subs->freqn >> 8;
283 cp[2] = subs->freqn >> 16;
284 cp[3] = subs->freqn >> 24;
289 * process after capture sync complete
292 static int retire_capture_sync_urb(snd_usb_substream_t *subs,
293 snd_pcm_runtime_t *runtime,
300 * prepare urb for capture data pipe
302 * fill the offset and length of each descriptor.
304 * we use a temporary buffer to write the captured data.
305 * since the length of written data is determined by host, we cannot
306 * write onto the pcm buffer directly... the data is thus copied
307 * later at complete callback to the global buffer.
309 static int prepare_capture_urb(snd_usb_substream_t *subs,
310 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 urb->number_of_packets = 0;
320 spin_lock_irqsave(&subs->lock, flags);
321 for (i = 0; i < ctx->packets; i++) {
322 urb->iso_frame_desc[i].offset = offs;
323 urb->iso_frame_desc[i].length = subs->curpacksize;
324 offs += subs->curpacksize;
325 urb->number_of_packets++;
326 subs->transfer_sched += subs->curframesize;
327 if (subs->transfer_sched >= runtime->period_size) {
328 subs->transfer_sched -= runtime->period_size;
332 spin_unlock_irqrestore(&subs->lock, flags);
333 urb->transfer_buffer = ctx->buf;
334 urb->transfer_buffer_length = offs;
336 if (! urb->bandwidth) {
338 bustime = usb_check_bandwidth(urb->dev, urb);
341 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
342 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
349 * process after capture complete
351 * copy the data from each desctiptor to the pcm buffer, and
352 * update the current position.
354 static int retire_capture_urb(snd_usb_substream_t *subs,
355 snd_pcm_runtime_t *runtime,
361 unsigned int stride, len, oldptr;
363 stride = runtime->frame_bits >> 3;
365 for (i = 0; i < urb->number_of_packets; i++) {
366 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
367 if (urb->iso_frame_desc[i].status) {
368 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
371 len = urb->iso_frame_desc[i].actual_length / stride;
374 /* update the current pointer */
375 spin_lock_irqsave(&subs->lock, flags);
376 oldptr = subs->hwptr_done;
377 subs->hwptr_done += len;
378 if (subs->hwptr_done >= runtime->buffer_size)
379 subs->hwptr_done -= runtime->buffer_size;
380 subs->transfer_done += len;
381 spin_unlock_irqrestore(&subs->lock, flags);
382 /* copy a data chunk */
383 if (oldptr + len > runtime->buffer_size) {
384 unsigned int cnt = runtime->buffer_size - oldptr;
385 unsigned int blen = cnt * stride;
386 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
387 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
389 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
391 /* update the pointer, call callback if necessary */
392 spin_lock_irqsave(&subs->lock, flags);
393 if (subs->transfer_done >= runtime->period_size) {
394 subs->transfer_done -= runtime->period_size;
395 spin_unlock_irqrestore(&subs->lock, flags);
396 snd_pcm_period_elapsed(subs->pcm_substream);
398 spin_unlock_irqrestore(&subs->lock, flags);
405 * prepare urb for full speed playback sync pipe
407 * set up the offset and length to receive the current frequency.
410 static int prepare_playback_sync_urb(snd_usb_substream_t *subs,
411 snd_pcm_runtime_t *runtime,
414 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
416 urb->dev = ctx->subs->dev; /* we need to set this at each time */
417 urb->iso_frame_desc[0].length = 3;
418 urb->iso_frame_desc[0].offset = 0;
423 * prepare urb for high speed playback sync pipe
425 * set up the offset and length to receive the current frequency.
428 static int prepare_playback_sync_urb_hs(snd_usb_substream_t *subs,
429 snd_pcm_runtime_t *runtime,
432 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
434 urb->dev = ctx->subs->dev; /* we need to set this at each time */
435 urb->iso_frame_desc[0].length = 4;
436 urb->iso_frame_desc[0].offset = 0;
441 * process after full speed playback sync complete
443 * retrieve the current 10.14 frequency from pipe, and set it.
444 * the value is referred in prepare_playback_urb().
446 static int retire_playback_sync_urb(snd_usb_substream_t *subs,
447 snd_pcm_runtime_t *runtime,
453 if (urb->iso_frame_desc[0].status == 0 &&
454 urb->iso_frame_desc[0].actual_length == 3) {
455 f = combine_triple((u8*)urb->transfer_buffer) << 2;
456 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
457 spin_lock_irqsave(&subs->lock, flags);
459 spin_unlock_irqrestore(&subs->lock, flags);
467 * process after high speed playback sync complete
469 * retrieve the current 12.13 frequency from pipe, and set it.
470 * the value is referred in prepare_playback_urb().
472 static int retire_playback_sync_urb_hs(snd_usb_substream_t *subs,
473 snd_pcm_runtime_t *runtime,
479 if (urb->iso_frame_desc[0].status == 0 &&
480 urb->iso_frame_desc[0].actual_length == 4) {
481 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
482 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
483 spin_lock_irqsave(&subs->lock, flags);
485 spin_unlock_irqrestore(&subs->lock, flags);
493 * prepare urb for playback data pipe
495 * we copy the data directly from the pcm buffer.
496 * the current position to be copied is held in hwptr field.
497 * since a urb can handle only a single linear buffer, if the total
498 * transferred area overflows the buffer boundary, we cannot send
499 * it directly from the buffer. thus the data is once copied to
500 * a temporary buffer and urb points to that.
502 static int prepare_playback_urb(snd_usb_substream_t *subs,
503 snd_pcm_runtime_t *runtime,
509 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
511 stride = runtime->frame_bits >> 3;
514 urb->dev = ctx->subs->dev; /* we need to set this at each time */
515 urb->number_of_packets = 0;
516 spin_lock_irqsave(&subs->lock, flags);
517 for (i = 0; i < ctx->packets; i++) {
518 /* calculate the size of a packet */
520 counts = subs->maxframesize; /* fixed */
522 subs->phase = (subs->phase & 0xffff)
523 + (subs->freqm << subs->datainterval);
524 counts = subs->phase >> 16;
525 if (counts > subs->maxframesize)
526 counts = subs->maxframesize;
528 /* set up descriptor */
529 urb->iso_frame_desc[i].offset = offs * stride;
530 urb->iso_frame_desc[i].length = counts * stride;
532 urb->number_of_packets++;
533 subs->transfer_sched += counts;
534 if (subs->transfer_sched >= runtime->period_size) {
535 subs->transfer_sched -= runtime->period_size;
536 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
537 if (subs->transfer_sched > 0) {
538 /* FIXME: fill-max mode is not supported yet */
539 offs -= subs->transfer_sched;
540 counts -= subs->transfer_sched;
541 urb->iso_frame_desc[i].length = counts * stride;
542 subs->transfer_sched = 0;
545 if (i < ctx->packets) {
546 /* add a transfer delimiter */
547 urb->iso_frame_desc[i].offset = offs * stride;
548 urb->iso_frame_desc[i].length = 0;
549 urb->number_of_packets++;
555 if (subs->hwptr + offs > runtime->buffer_size) {
556 /* err, the transferred area goes over buffer boundary.
557 * copy the data to the temp buffer.
560 len = runtime->buffer_size - subs->hwptr;
561 urb->transfer_buffer = subs->tmpbuf;
562 memcpy(subs->tmpbuf, runtime->dma_area + subs->hwptr * stride, len * stride);
563 memcpy(subs->tmpbuf + len * stride, runtime->dma_area, (offs - len) * stride);
565 subs->hwptr -= runtime->buffer_size;
567 /* set the buffer pointer */
568 urb->transfer_buffer = runtime->dma_area + subs->hwptr * stride;
570 if (subs->hwptr == runtime->buffer_size)
573 spin_unlock_irqrestore(&subs->lock, flags);
574 urb->transfer_buffer_length = offs * stride;
575 ctx->transfer = offs;
581 * process after playback data complete
583 * update the current position and call callback if a period is processed.
585 static int retire_playback_urb(snd_usb_substream_t *subs,
586 snd_pcm_runtime_t *runtime,
590 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
592 spin_lock_irqsave(&subs->lock, flags);
593 subs->transfer_done += ctx->transfer;
594 subs->hwptr_done += ctx->transfer;
596 if (subs->hwptr_done >= runtime->buffer_size)
597 subs->hwptr_done -= runtime->buffer_size;
598 if (subs->transfer_done >= runtime->period_size) {
599 subs->transfer_done -= runtime->period_size;
600 spin_unlock_irqrestore(&subs->lock, flags);
601 snd_pcm_period_elapsed(subs->pcm_substream);
603 spin_unlock_irqrestore(&subs->lock, flags);
610 static struct snd_urb_ops audio_urb_ops[2] = {
612 .prepare = prepare_playback_urb,
613 .retire = retire_playback_urb,
614 .prepare_sync = prepare_playback_sync_urb,
615 .retire_sync = retire_playback_sync_urb,
618 .prepare = prepare_capture_urb,
619 .retire = retire_capture_urb,
620 .prepare_sync = prepare_capture_sync_urb,
621 .retire_sync = retire_capture_sync_urb,
625 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
627 .prepare = prepare_playback_urb,
628 .retire = retire_playback_urb,
629 .prepare_sync = prepare_playback_sync_urb_hs,
630 .retire_sync = retire_playback_sync_urb_hs,
633 .prepare = prepare_capture_urb,
634 .retire = retire_capture_urb,
635 .prepare_sync = prepare_capture_sync_urb_hs,
636 .retire_sync = retire_capture_sync_urb,
641 * complete callback from data urb
643 static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
645 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
646 snd_usb_substream_t *subs = ctx->subs;
647 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
650 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
651 ! subs->running || /* can be stopped during retire callback */
652 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
653 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
654 clear_bit(ctx->index, &subs->active_mask);
656 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
657 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
664 * complete callback from sync urb
666 static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
668 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
669 snd_usb_substream_t *subs = ctx->subs;
670 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
673 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
674 ! subs->running || /* can be stopped during retire callback */
675 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
676 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
677 clear_bit(ctx->index + 16, &subs->active_mask);
679 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
680 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
687 * unlink active urbs.
689 static int deactivate_urbs(snd_usb_substream_t *subs, int force, int can_sleep)
696 if (!force && subs->stream->chip->shutdown) /* to be sure... */
699 async = !can_sleep && async_unlink;
701 if (! async && in_interrupt())
704 for (i = 0; i < subs->nurbs; i++) {
705 if (test_bit(i, &subs->active_mask)) {
706 if (! test_and_set_bit(i, &subs->unlink_mask)) {
707 struct urb *u = subs->dataurb[i].urb;
709 u->transfer_flags |= URB_ASYNC_UNLINK;
716 if (subs->syncpipe) {
717 for (i = 0; i < SYNC_URBS; i++) {
718 if (test_bit(i+16, &subs->active_mask)) {
719 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
720 struct urb *u = subs->syncurb[i].urb;
722 u->transfer_flags |= URB_ASYNC_UNLINK;
735 * set up and start data/sync urbs
737 static int start_urbs(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime)
742 if (subs->stream->chip->shutdown)
745 for (i = 0; i < subs->nurbs; i++) {
746 snd_assert(subs->dataurb[i].urb, return -EINVAL);
747 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
748 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
752 if (subs->syncpipe) {
753 for (i = 0; i < SYNC_URBS; i++) {
754 snd_assert(subs->syncurb[i].urb, return -EINVAL);
755 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
756 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
762 subs->active_mask = 0;
763 subs->unlink_mask = 0;
765 for (i = 0; i < subs->nurbs; i++) {
766 if ((err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC)) < 0) {
767 snd_printk(KERN_ERR "cannot submit datapipe for urb %d, err = %d\n", i, err);
770 set_bit(i, &subs->active_mask);
772 if (subs->syncpipe) {
773 for (i = 0; i < SYNC_URBS; i++) {
774 if ((err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC)) < 0) {
775 snd_printk(KERN_ERR "cannot submit syncpipe for urb %d, err = %d\n", i, err);
778 set_bit(i + 16, &subs->active_mask);
784 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
785 deactivate_urbs(subs, 0, 0);
791 * wait until all urbs are processed.
793 static int wait_clear_urbs(snd_usb_substream_t *subs)
795 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
801 for (i = 0; i < subs->nurbs; i++) {
802 if (test_bit(i, &subs->active_mask))
805 if (subs->syncpipe) {
806 for (i = 0; i < SYNC_URBS; i++) {
807 if (test_bit(i + 16, &subs->active_mask))
813 set_current_state(TASK_UNINTERRUPTIBLE);
815 } while (time_before(jiffies, end_time));
817 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
823 * return the current pcm pointer. just return the hwptr_done value.
825 static snd_pcm_uframes_t snd_usb_pcm_pointer(snd_pcm_substream_t *substream)
827 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
828 return subs->hwptr_done;
833 * start/stop substream
835 static int snd_usb_pcm_trigger(snd_pcm_substream_t *substream, int cmd)
837 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
841 case SNDRV_PCM_TRIGGER_START:
842 err = start_urbs(subs, substream->runtime);
844 case SNDRV_PCM_TRIGGER_STOP:
845 err = deactivate_urbs(subs, 0, 0);
851 return err < 0 ? err : 0;
858 static void release_urb_ctx(snd_urb_ctx_t *u)
861 usb_free_urb(u->urb);
869 * release a substream
871 static void release_substream_urbs(snd_usb_substream_t *subs, int force)
875 /* stop urbs (to be sure) */
876 deactivate_urbs(subs, force, 1);
877 wait_clear_urbs(subs);
879 for (i = 0; i < MAX_URBS; i++)
880 release_urb_ctx(&subs->dataurb[i]);
881 for (i = 0; i < SYNC_URBS; i++)
882 release_urb_ctx(&subs->syncurb[i]);
889 * initialize a substream for plaback/capture
891 static int init_substream_urbs(snd_usb_substream_t *subs, unsigned int period_bytes,
892 unsigned int rate, unsigned int frame_bits)
894 unsigned int maxsize, n, i;
895 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
896 unsigned int npacks[MAX_URBS], urb_packs, total_packs;
898 /* calculate the frequency in 16.16 format */
899 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
900 subs->freqn = get_usb_full_speed_rate(rate);
902 subs->freqn = get_usb_high_speed_rate(rate);
903 subs->freqm = subs->freqn;
904 /* calculate max. frequency */
905 if (subs->maxpacksize) {
906 /* whatever fits into a max. size packet */
907 maxsize = subs->maxpacksize;
908 subs->freqmax = (maxsize / (frame_bits >> 3))
909 << (16 - subs->datainterval);
911 /* no max. packet size: just take 25% higher than nominal */
912 subs->freqmax = subs->freqn + (subs->freqn >> 2);
913 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
914 >> (16 - subs->datainterval);
919 subs->curpacksize = subs->maxpacksize;
921 subs->curpacksize = maxsize;
925 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
926 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
929 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
930 urb_packs = (urb_packs * 8) >> subs->datainterval;
932 /* allocate a temporary buffer for playback */
934 subs->tmpbuf = kmalloc(maxsize * urb_packs, GFP_KERNEL);
935 if (! subs->tmpbuf) {
936 snd_printk(KERN_ERR "cannot malloc tmpbuf\n");
941 /* decide how many packets to be used */
943 unsigned int minsize;
944 /* determine how small a packet can be */
945 minsize = (subs->freqn >> (16 - subs->datainterval))
947 /* with sync from device, assume it can be 25% lower */
949 minsize -= minsize >> 2;
950 minsize = max(minsize, 1u);
951 total_packs = (period_bytes + minsize - 1) / minsize;
952 if (total_packs < 2 * MIN_PACKS_URB)
953 total_packs = 2 * MIN_PACKS_URB;
955 total_packs = MAX_URBS * urb_packs;
957 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
958 if (subs->nurbs > MAX_URBS) {
960 subs->nurbs = MAX_URBS;
961 total_packs = MAX_URBS * urb_packs;
964 for (i = 0; i < subs->nurbs; i++) {
965 npacks[i] = n > urb_packs ? urb_packs : n;
968 if (subs->nurbs <= 1) {
969 /* too little - we need at least two packets
970 * to ensure contiguous playback/capture
973 npacks[0] = (total_packs + 1) / 2;
974 npacks[1] = total_packs - npacks[0];
975 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB) {
976 /* the last packet is too small.. */
977 if (subs->nurbs > 2) {
978 /* merge to the first one */
979 npacks[0] += npacks[subs->nurbs - 1];
984 npacks[0] = (total_packs + 1) / 2;
985 npacks[1] = total_packs - npacks[0];
989 /* allocate and initialize data urbs */
990 for (i = 0; i < subs->nurbs; i++) {
991 snd_urb_ctx_t *u = &subs->dataurb[i];
995 u->packets = npacks[i];
996 if (subs->fmt_type == USB_FORMAT_TYPE_II)
997 u->packets++; /* for transfer delimiter */
999 /* allocate a capture buffer per urb */
1000 u->buf = kmalloc(maxsize * u->packets, GFP_KERNEL);
1002 release_substream_urbs(subs, 0);
1006 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1008 release_substream_urbs(subs, 0);
1011 u->urb->dev = subs->dev;
1012 u->urb->pipe = subs->datapipe;
1013 u->urb->transfer_flags = URB_ISO_ASAP;
1014 u->urb->number_of_packets = u->packets;
1015 u->urb->interval = 1 << subs->datainterval;
1016 u->urb->context = u;
1017 u->urb->complete = snd_usb_complete_callback(snd_complete_urb);
1020 if (subs->syncpipe) {
1021 /* allocate and initialize sync urbs */
1022 for (i = 0; i < SYNC_URBS; i++) {
1023 snd_urb_ctx_t *u = &subs->syncurb[i];
1027 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1029 release_substream_urbs(subs, 0);
1032 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1033 u->urb->transfer_buffer_length = 4;
1034 u->urb->dev = subs->dev;
1035 u->urb->pipe = subs->syncpipe;
1036 u->urb->transfer_flags = URB_ISO_ASAP;
1037 u->urb->number_of_packets = 1;
1038 u->urb->interval = 1 << subs->syncinterval;
1039 u->urb->context = u;
1040 u->urb->complete = snd_usb_complete_callback(snd_complete_sync_urb);
1048 * find a matching audio format
1050 static struct audioformat *find_format(snd_usb_substream_t *subs, unsigned int format,
1051 unsigned int rate, unsigned int channels)
1053 struct list_head *p;
1054 struct audioformat *found = NULL;
1055 int cur_attr = 0, attr;
1057 list_for_each(p, &subs->fmt_list) {
1058 struct audioformat *fp;
1059 fp = list_entry(p, struct audioformat, list);
1060 if (fp->format != format || fp->channels != channels)
1062 if (rate < fp->rate_min || rate > fp->rate_max)
1064 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1066 for (i = 0; i < fp->nr_rates; i++)
1067 if (fp->rate_table[i] == rate)
1069 if (i >= fp->nr_rates)
1072 attr = fp->ep_attr & EP_ATTR_MASK;
1078 /* avoid async out and adaptive in if the other method
1079 * supports the same format.
1080 * this is a workaround for the case like
1081 * M-audio audiophile USB.
1083 if (attr != cur_attr) {
1084 if ((attr == EP_ATTR_ASYNC &&
1085 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1086 (attr == EP_ATTR_ADAPTIVE &&
1087 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1089 if ((cur_attr == EP_ATTR_ASYNC &&
1090 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1091 (cur_attr == EP_ATTR_ADAPTIVE &&
1092 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1098 /* find the format with the largest max. packet size */
1099 if (fp->maxpacksize > found->maxpacksize) {
1109 * initialize the picth control and sample rate
1111 static int init_usb_pitch(struct usb_device *dev, int iface,
1112 struct usb_host_interface *alts,
1113 struct audioformat *fmt)
1116 unsigned char data[1];
1119 ep = get_endpoint(alts, 0)->bEndpointAddress;
1120 /* if endpoint has pitch control, enable it */
1121 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1123 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1124 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1125 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1126 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1127 dev->devnum, iface, ep);
1134 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1135 struct usb_host_interface *alts,
1136 struct audioformat *fmt, int rate)
1139 unsigned char data[3];
1142 ep = get_endpoint(alts, 0)->bEndpointAddress;
1143 /* if endpoint has sampling rate control, set it */
1144 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1147 data[1] = rate >> 8;
1148 data[2] = rate >> 16;
1149 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1150 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1151 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1152 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1153 dev->devnum, iface, fmt->altsetting, rate, ep);
1156 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1157 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1158 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1159 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1160 dev->devnum, iface, fmt->altsetting, ep);
1161 return 0; /* some devices don't support reading */
1163 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1164 if (crate != rate) {
1165 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1166 // runtime->rate = crate;
1173 * find a matching format and set up the interface
1175 static int set_format(snd_usb_substream_t *subs, struct audioformat *fmt)
1177 struct usb_device *dev = subs->dev;
1178 struct usb_host_interface *alts;
1179 struct usb_interface_descriptor *altsd;
1180 struct usb_interface *iface;
1181 unsigned int ep, attr;
1182 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1185 iface = usb_ifnum_to_if(dev, fmt->iface);
1186 snd_assert(iface, return -EINVAL);
1187 alts = &iface->altsetting[fmt->altset_idx];
1188 altsd = get_iface_desc(alts);
1189 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1191 if (fmt == subs->cur_audiofmt)
1194 /* close the old interface */
1195 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1196 usb_set_interface(subs->dev, subs->interface, 0);
1197 subs->interface = -1;
1202 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1203 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1204 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1205 dev->devnum, fmt->iface, fmt->altsetting);
1208 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1209 subs->interface = fmt->iface;
1210 subs->format = fmt->altset_idx;
1213 /* create a data pipe */
1214 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1216 subs->datapipe = usb_sndisocpipe(dev, ep);
1218 subs->datapipe = usb_rcvisocpipe(dev, ep);
1219 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1220 get_endpoint(alts, 0)->bInterval >= 1 &&
1221 get_endpoint(alts, 0)->bInterval <= 4)
1222 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1224 subs->datainterval = 0;
1225 subs->syncpipe = subs->syncinterval = 0;
1226 subs->maxpacksize = fmt->maxpacksize;
1229 /* we need a sync pipe in async OUT or adaptive IN mode */
1230 /* check the number of EP, since some devices have broken
1231 * descriptors which fool us. if it has only one EP,
1232 * assume it as adaptive-out or sync-in.
1234 attr = fmt->ep_attr & EP_ATTR_MASK;
1235 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1236 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1237 altsd->bNumEndpoints >= 2) {
1238 /* check sync-pipe endpoint */
1239 /* ... and check descriptor size before accessing bSynchAddress
1240 because there is a version of the SB Audigy 2 NX firmware lacking
1241 the audio fields in the endpoint descriptors */
1242 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1243 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1244 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1245 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1246 dev->devnum, fmt->iface, fmt->altsetting);
1249 ep = get_endpoint(alts, 1)->bEndpointAddress;
1250 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1251 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1252 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1253 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1254 dev->devnum, fmt->iface, fmt->altsetting);
1257 ep &= USB_ENDPOINT_NUMBER_MASK;
1259 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1261 subs->syncpipe = usb_sndisocpipe(dev, ep);
1262 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1263 get_endpoint(alts, 1)->bRefresh >= 1 &&
1264 get_endpoint(alts, 1)->bRefresh <= 9)
1265 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1266 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1267 subs->syncinterval = 1;
1268 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1269 get_endpoint(alts, 1)->bInterval <= 16)
1270 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1272 subs->syncinterval = 3;
1275 /* always fill max packet size */
1276 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1279 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1282 subs->cur_audiofmt = fmt;
1285 printk("setting done: format = %d, rate = %d, channels = %d\n",
1286 fmt->format, fmt->rate, fmt->channels);
1287 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1288 subs->datapipe, subs->syncpipe);
1295 * hw_params callback
1297 * allocate a buffer and set the given audio format.
1299 * so far we use a physically linear buffer although packetize transfer
1300 * doesn't need a continuous area.
1301 * if sg buffer is supported on the later version of alsa, we'll follow
1304 static int snd_usb_hw_params(snd_pcm_substream_t *substream,
1305 snd_pcm_hw_params_t *hw_params)
1307 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1308 struct audioformat *fmt;
1309 unsigned int channels, rate, format;
1312 ret = snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params));
1316 format = params_format(hw_params);
1317 rate = params_rate(hw_params);
1318 channels = params_channels(hw_params);
1319 fmt = find_format(subs, format, rate, channels);
1321 snd_printd(KERN_DEBUG "cannot set format: format = %s, rate = %d, channels = %d\n",
1322 snd_pcm_format_name(format), rate, channels);
1326 changed = subs->cur_audiofmt != fmt ||
1327 subs->period_bytes != params_period_bytes(hw_params) ||
1328 subs->cur_rate != rate;
1329 if ((ret = set_format(subs, fmt)) < 0)
1332 if (subs->cur_rate != rate) {
1333 struct usb_host_interface *alts;
1334 struct usb_interface *iface;
1335 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1336 alts = &iface->altsetting[fmt->altset_idx];
1337 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1340 subs->cur_rate = rate;
1344 /* format changed */
1345 release_substream_urbs(subs, 0);
1346 /* influenced: period_bytes, channels, rate, format, */
1347 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1348 params_rate(hw_params),
1349 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1358 * reset the audio format and release the buffer
1360 static int snd_usb_hw_free(snd_pcm_substream_t *substream)
1362 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1364 subs->cur_audiofmt = NULL;
1366 subs->period_bytes = 0;
1367 release_substream_urbs(subs, 0);
1368 return snd_pcm_lib_free_pages(substream);
1374 * only a few subtle things...
1376 static int snd_usb_pcm_prepare(snd_pcm_substream_t *substream)
1378 snd_pcm_runtime_t *runtime = substream->runtime;
1379 snd_usb_substream_t *subs = (snd_usb_substream_t *)runtime->private_data;
1381 if (! subs->cur_audiofmt) {
1382 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1386 /* some unit conversions in runtime */
1387 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1388 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1390 /* reset the pointer */
1392 subs->hwptr_done = 0;
1393 subs->transfer_sched = 0;
1394 subs->transfer_done = 0;
1397 /* clear urbs (to be sure) */
1398 deactivate_urbs(subs, 0, 1);
1399 wait_clear_urbs(subs);
1404 static snd_pcm_hardware_t snd_usb_playback =
1406 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
1407 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1408 SNDRV_PCM_INFO_MMAP_VALID),
1409 .buffer_bytes_max = (128*1024),
1410 .period_bytes_min = 64,
1411 .period_bytes_max = (128*1024),
1413 .periods_max = 1024,
1416 static snd_pcm_hardware_t snd_usb_capture =
1418 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
1419 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1420 SNDRV_PCM_INFO_MMAP_VALID),
1421 .buffer_bytes_max = (128*1024),
1422 .period_bytes_min = 64,
1423 .period_bytes_max = (128*1024),
1425 .periods_max = 1024,
1432 #ifdef HW_CONST_DEBUG
1433 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1435 #define hwc_debug(fmt, args...) /**/
1438 static int hw_check_valid_format(snd_pcm_hw_params_t *params, struct audioformat *fp)
1440 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1441 snd_interval_t *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1442 snd_mask_t *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1444 /* check the format */
1445 if (! snd_mask_test(fmts, fp->format)) {
1446 hwc_debug(" > check: no supported format %d\n", fp->format);
1449 /* check the channels */
1450 if (fp->channels < ct->min || fp->channels > ct->max) {
1451 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1454 /* check the rate is within the range */
1455 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1456 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1459 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1460 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1466 static int hw_rule_rate(snd_pcm_hw_params_t *params,
1467 snd_pcm_hw_rule_t *rule)
1469 snd_usb_substream_t *subs = rule->private;
1470 struct list_head *p;
1471 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1472 unsigned int rmin, rmax;
1475 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1478 list_for_each(p, &subs->fmt_list) {
1479 struct audioformat *fp;
1480 fp = list_entry(p, struct audioformat, list);
1481 if (! hw_check_valid_format(params, fp))
1484 if (rmin > fp->rate_min)
1485 rmin = fp->rate_min;
1486 if (rmax < fp->rate_max)
1487 rmax = fp->rate_max;
1489 rmin = fp->rate_min;
1490 rmax = fp->rate_max;
1495 hwc_debug(" --> get empty\n");
1501 if (it->min < rmin) {
1506 if (it->max > rmax) {
1511 if (snd_interval_checkempty(it)) {
1515 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1520 static int hw_rule_channels(snd_pcm_hw_params_t *params,
1521 snd_pcm_hw_rule_t *rule)
1523 snd_usb_substream_t *subs = rule->private;
1524 struct list_head *p;
1525 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1526 unsigned int rmin, rmax;
1529 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1532 list_for_each(p, &subs->fmt_list) {
1533 struct audioformat *fp;
1534 fp = list_entry(p, struct audioformat, list);
1535 if (! hw_check_valid_format(params, fp))
1538 if (rmin > fp->channels)
1539 rmin = fp->channels;
1540 if (rmax < fp->channels)
1541 rmax = fp->channels;
1543 rmin = fp->channels;
1544 rmax = fp->channels;
1549 hwc_debug(" --> get empty\n");
1555 if (it->min < rmin) {
1560 if (it->max > rmax) {
1565 if (snd_interval_checkempty(it)) {
1569 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1573 static int hw_rule_format(snd_pcm_hw_params_t *params,
1574 snd_pcm_hw_rule_t *rule)
1576 snd_usb_substream_t *subs = rule->private;
1577 struct list_head *p;
1578 snd_mask_t *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1583 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1585 list_for_each(p, &subs->fmt_list) {
1586 struct audioformat *fp;
1587 fp = list_entry(p, struct audioformat, list);
1588 if (! hw_check_valid_format(params, fp))
1590 fbits |= (1ULL << fp->format);
1593 oldbits[0] = fmt->bits[0];
1594 oldbits[1] = fmt->bits[1];
1595 fmt->bits[0] &= (u32)fbits;
1596 fmt->bits[1] &= (u32)(fbits >> 32);
1597 if (! fmt->bits[0] && ! fmt->bits[1]) {
1598 hwc_debug(" --> get empty\n");
1601 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1602 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1609 * check whether the registered audio formats need special hw-constraints
1611 static int check_hw_params_convention(snd_usb_substream_t *subs)
1616 u32 cmaster, rmaster;
1617 u32 rate_min = 0, rate_max = 0;
1618 struct list_head *p;
1621 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1622 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1624 list_for_each(p, &subs->fmt_list) {
1625 struct audioformat *f;
1626 f = list_entry(p, struct audioformat, list);
1627 /* unconventional channels? */
1628 if (f->channels > 32)
1630 /* continuous rate min/max matches? */
1631 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1632 if (rate_min && f->rate_min != rate_min)
1634 if (rate_max && f->rate_max != rate_max)
1636 rate_min = f->rate_min;
1637 rate_max = f->rate_max;
1639 /* combination of continuous rates and fixed rates? */
1640 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1641 if (f->rates != rates[f->format])
1644 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1645 if (rates[f->format] && rates[f->format] != f->rates)
1648 channels[f->format] |= (1 << f->channels);
1649 rates[f->format] |= f->rates;
1651 /* check whether channels and rates match for all formats */
1652 cmaster = rmaster = 0;
1653 for (i = 0; i < MAX_MASK; i++) {
1654 if (cmaster != channels[i] && cmaster && channels[i])
1656 if (rmaster != rates[i] && rmaster && rates[i])
1659 cmaster = channels[i];
1663 /* check whether channels match for all distinct rates */
1664 memset(channels, 0, MAX_MASK * sizeof(u32));
1665 list_for_each(p, &subs->fmt_list) {
1666 struct audioformat *f;
1667 f = list_entry(p, struct audioformat, list);
1668 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1670 for (i = 0; i < 32; i++) {
1671 if (f->rates & (1 << i))
1672 channels[i] |= (1 << f->channels);
1676 for (i = 0; i < 32; i++) {
1677 if (cmaster != channels[i] && cmaster && channels[i])
1680 cmaster = channels[i];
1692 * set up the runtime hardware information.
1695 static int setup_hw_info(snd_pcm_runtime_t *runtime, snd_usb_substream_t *subs)
1697 struct list_head *p;
1700 runtime->hw.formats = subs->formats;
1702 runtime->hw.rate_min = 0x7fffffff;
1703 runtime->hw.rate_max = 0;
1704 runtime->hw.channels_min = 256;
1705 runtime->hw.channels_max = 0;
1706 runtime->hw.rates = 0;
1707 /* check min/max rates and channels */
1708 list_for_each(p, &subs->fmt_list) {
1709 struct audioformat *fp;
1710 fp = list_entry(p, struct audioformat, list);
1711 runtime->hw.rates |= fp->rates;
1712 if (runtime->hw.rate_min > fp->rate_min)
1713 runtime->hw.rate_min = fp->rate_min;
1714 if (runtime->hw.rate_max < fp->rate_max)
1715 runtime->hw.rate_max = fp->rate_max;
1716 if (runtime->hw.channels_min > fp->channels)
1717 runtime->hw.channels_min = fp->channels;
1718 if (runtime->hw.channels_max < fp->channels)
1719 runtime->hw.channels_max = fp->channels;
1720 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1721 /* FIXME: there might be more than one audio formats... */
1722 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1727 /* set the period time minimum 1ms */
1728 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1729 1000 * MIN_PACKS_URB,
1730 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1732 if (check_hw_params_convention(subs)) {
1733 hwc_debug("setting extra hw constraints...\n");
1734 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1736 SNDRV_PCM_HW_PARAM_FORMAT,
1737 SNDRV_PCM_HW_PARAM_CHANNELS,
1740 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1741 hw_rule_channels, subs,
1742 SNDRV_PCM_HW_PARAM_FORMAT,
1743 SNDRV_PCM_HW_PARAM_RATE,
1746 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1747 hw_rule_format, subs,
1748 SNDRV_PCM_HW_PARAM_RATE,
1749 SNDRV_PCM_HW_PARAM_CHANNELS,
1756 static int snd_usb_pcm_open(snd_pcm_substream_t *substream, int direction,
1757 snd_pcm_hardware_t *hw)
1759 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1760 snd_pcm_runtime_t *runtime = substream->runtime;
1761 snd_usb_substream_t *subs = &as->substream[direction];
1763 subs->interface = -1;
1766 runtime->private_data = subs;
1767 subs->pcm_substream = substream;
1768 return setup_hw_info(runtime, subs);
1771 static int snd_usb_pcm_close(snd_pcm_substream_t *substream, int direction)
1773 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1774 snd_usb_substream_t *subs = &as->substream[direction];
1776 if (subs->interface >= 0) {
1777 usb_set_interface(subs->dev, subs->interface, 0);
1778 subs->interface = -1;
1780 subs->pcm_substream = NULL;
1784 static int snd_usb_playback_open(snd_pcm_substream_t *substream)
1786 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1789 static int snd_usb_playback_close(snd_pcm_substream_t *substream)
1791 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1794 static int snd_usb_capture_open(snd_pcm_substream_t *substream)
1796 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1799 static int snd_usb_capture_close(snd_pcm_substream_t *substream)
1801 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1804 static snd_pcm_ops_t snd_usb_playback_ops = {
1805 .open = snd_usb_playback_open,
1806 .close = snd_usb_playback_close,
1807 .ioctl = snd_pcm_lib_ioctl,
1808 .hw_params = snd_usb_hw_params,
1809 .hw_free = snd_usb_hw_free,
1810 .prepare = snd_usb_pcm_prepare,
1811 .trigger = snd_usb_pcm_trigger,
1812 .pointer = snd_usb_pcm_pointer,
1815 static snd_pcm_ops_t snd_usb_capture_ops = {
1816 .open = snd_usb_capture_open,
1817 .close = snd_usb_capture_close,
1818 .ioctl = snd_pcm_lib_ioctl,
1819 .hw_params = snd_usb_hw_params,
1820 .hw_free = snd_usb_hw_free,
1821 .prepare = snd_usb_pcm_prepare,
1822 .trigger = snd_usb_pcm_trigger,
1823 .pointer = snd_usb_pcm_pointer,
1833 * combine bytes and get an integer value
1835 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1838 case 1: return *bytes;
1839 case 2: return combine_word(bytes);
1840 case 3: return combine_triple(bytes);
1841 case 4: return combine_quad(bytes);
1847 * parse descriptor buffer and return the pointer starting the given
1850 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1862 if (p[1] == dtype && (!after || (void *)p > after)) {
1871 * find a class-specified interface descriptor with the given subtype.
1873 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1875 unsigned char *p = after;
1877 while ((p = snd_usb_find_desc(buffer, buflen, p,
1878 USB_DT_CS_INTERFACE)) != NULL) {
1879 if (p[0] >= 3 && p[2] == dsubtype)
1886 * Wrapper for usb_control_msg().
1887 * Allocates a temp buffer to prevent dmaing from/to the stack.
1889 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
1890 __u8 requesttype, __u16 value, __u16 index, void *data,
1891 __u16 size, int timeout)
1897 buf = kmalloc(size, GFP_KERNEL);
1900 memcpy(buf, data, size);
1902 err = usb_control_msg(dev, pipe, request, requesttype,
1903 value, index, buf, size, timeout);
1905 memcpy(data, buf, size);
1913 * entry point for linux usb interface
1916 static int usb_audio_probe(struct usb_interface *intf,
1917 const struct usb_device_id *id);
1918 static void usb_audio_disconnect(struct usb_interface *intf);
1920 static struct usb_device_id usb_audio_ids [] = {
1921 #include "usbquirks.h"
1922 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1923 .bInterfaceClass = USB_CLASS_AUDIO,
1924 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
1925 { } /* Terminating entry */
1928 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
1930 static struct usb_driver usb_audio_driver = {
1931 .owner = THIS_MODULE,
1932 .name = "snd-usb-audio",
1933 .probe = usb_audio_probe,
1934 .disconnect = usb_audio_disconnect,
1935 .id_table = usb_audio_ids,
1940 * proc interface for list the supported pcm formats
1942 static void proc_dump_substream_formats(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
1944 struct list_head *p;
1945 static char *sync_types[4] = {
1946 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
1949 list_for_each(p, &subs->fmt_list) {
1950 struct audioformat *fp;
1951 fp = list_entry(p, struct audioformat, list);
1952 snd_iprintf(buffer, " Interface %d\n", fp->iface);
1953 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
1954 snd_iprintf(buffer, " Format: %s\n", snd_pcm_format_name(fp->format));
1955 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
1956 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
1957 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
1958 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
1959 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
1960 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1961 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
1962 fp->rate_min, fp->rate_max);
1965 snd_iprintf(buffer, " Rates: ");
1966 for (i = 0; i < fp->nr_rates; i++) {
1968 snd_iprintf(buffer, ", ");
1969 snd_iprintf(buffer, "%d", fp->rate_table[i]);
1971 snd_iprintf(buffer, "\n");
1973 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
1974 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
1978 static void proc_dump_substream_status(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
1980 if (subs->running) {
1982 snd_iprintf(buffer, " Status: Running\n");
1983 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
1984 snd_iprintf(buffer, " Altset = %d\n", subs->format);
1985 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
1986 for (i = 0; i < subs->nurbs; i++)
1987 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
1988 snd_iprintf(buffer, "]\n");
1989 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
1990 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
1991 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
1992 ? get_full_speed_hz(subs->freqm)
1993 : get_high_speed_hz(subs->freqm),
1994 subs->freqm >> 16, subs->freqm & 0xffff);
1996 snd_iprintf(buffer, " Status: Stop\n");
2000 static void proc_pcm_format_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
2002 snd_usb_stream_t *stream = entry->private_data;
2004 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2006 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2007 snd_iprintf(buffer, "\nPlayback:\n");
2008 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2009 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2011 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2012 snd_iprintf(buffer, "\nCapture:\n");
2013 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2014 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2018 static void proc_pcm_format_add(snd_usb_stream_t *stream)
2020 snd_info_entry_t *entry;
2022 snd_card_t *card = stream->chip->card;
2024 sprintf(name, "stream%d", stream->pcm_index);
2025 if (! snd_card_proc_new(card, name, &entry))
2026 snd_info_set_text_ops(entry, stream, 1024, proc_pcm_format_read);
2031 * initialize the substream instance.
2034 static void init_substream(snd_usb_stream_t *as, int stream, struct audioformat *fp)
2036 snd_usb_substream_t *subs = &as->substream[stream];
2038 INIT_LIST_HEAD(&subs->fmt_list);
2039 spin_lock_init(&subs->lock);
2042 subs->direction = stream;
2043 subs->dev = as->chip->dev;
2044 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2045 subs->ops = audio_urb_ops[stream];
2047 subs->ops = audio_urb_ops_high_speed[stream];
2048 snd_pcm_lib_preallocate_pages(as->pcm->streams[stream].substream,
2049 SNDRV_DMA_TYPE_CONTINUOUS,
2050 snd_dma_continuous_data(GFP_KERNEL),
2051 64 * 1024, 128 * 1024);
2052 snd_pcm_set_ops(as->pcm, stream,
2053 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2054 &snd_usb_playback_ops : &snd_usb_capture_ops);
2056 list_add_tail(&fp->list, &subs->fmt_list);
2057 subs->formats |= 1ULL << fp->format;
2058 subs->endpoint = fp->endpoint;
2059 subs->num_formats++;
2060 subs->fmt_type = fp->fmt_type;
2067 static void free_substream(snd_usb_substream_t *subs)
2069 struct list_head *p, *n;
2071 if (! subs->num_formats)
2072 return; /* not initialized */
2073 list_for_each_safe(p, n, &subs->fmt_list) {
2074 struct audioformat *fp = list_entry(p, struct audioformat, list);
2075 kfree(fp->rate_table);
2082 * free a usb stream instance
2084 static void snd_usb_audio_stream_free(snd_usb_stream_t *stream)
2086 free_substream(&stream->substream[0]);
2087 free_substream(&stream->substream[1]);
2088 list_del(&stream->list);
2092 static void snd_usb_audio_pcm_free(snd_pcm_t *pcm)
2094 snd_usb_stream_t *stream = pcm->private_data;
2097 snd_pcm_lib_preallocate_free_for_all(pcm);
2098 snd_usb_audio_stream_free(stream);
2104 * add this endpoint to the chip instance.
2105 * if a stream with the same endpoint already exists, append to it.
2106 * if not, create a new pcm stream.
2108 static int add_audio_endpoint(snd_usb_audio_t *chip, int stream, struct audioformat *fp)
2110 struct list_head *p;
2111 snd_usb_stream_t *as;
2112 snd_usb_substream_t *subs;
2116 list_for_each(p, &chip->pcm_list) {
2117 as = list_entry(p, snd_usb_stream_t, list);
2118 if (as->fmt_type != fp->fmt_type)
2120 subs = &as->substream[stream];
2121 if (! subs->endpoint)
2123 if (subs->endpoint == fp->endpoint) {
2124 list_add_tail(&fp->list, &subs->fmt_list);
2125 subs->num_formats++;
2126 subs->formats |= 1ULL << fp->format;
2130 /* look for an empty stream */
2131 list_for_each(p, &chip->pcm_list) {
2132 as = list_entry(p, snd_usb_stream_t, list);
2133 if (as->fmt_type != fp->fmt_type)
2135 subs = &as->substream[stream];
2138 err = snd_pcm_new_stream(as->pcm, stream, 1);
2141 init_substream(as, stream, fp);
2145 /* create a new pcm */
2146 as = kmalloc(sizeof(*as), GFP_KERNEL);
2149 memset(as, 0, sizeof(*as));
2150 as->pcm_index = chip->pcm_devs;
2152 as->fmt_type = fp->fmt_type;
2153 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2154 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2155 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2162 pcm->private_data = as;
2163 pcm->private_free = snd_usb_audio_pcm_free;
2164 pcm->info_flags = 0;
2165 if (chip->pcm_devs > 0)
2166 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2168 strcpy(pcm->name, "USB Audio");
2170 init_substream(as, stream, fp);
2172 list_add(&as->list, &chip->pcm_list);
2175 proc_pcm_format_add(as);
2182 * check if the device uses big-endian samples
2184 static int is_big_endian_format(snd_usb_audio_t *chip, struct audioformat *fp)
2186 switch (chip->usb_id) {
2187 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2188 if (fp->endpoint & USB_DIR_IN)
2191 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2198 * parse the audio format type I descriptor
2199 * and returns the corresponding pcm format
2202 * @fp: audioformat record
2203 * @format: the format tag (wFormatTag)
2204 * @fmt: the format type descriptor
2206 static int parse_audio_format_i_type(snd_usb_audio_t *chip, struct audioformat *fp,
2207 int format, unsigned char *fmt)
2210 int sample_width, sample_bytes;
2212 /* FIXME: correct endianess and sign? */
2214 sample_width = fmt[6];
2215 sample_bytes = fmt[5];
2217 case 0: /* some devices don't define this correctly... */
2218 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2219 chip->dev->devnum, fp->iface, fp->altsetting);
2221 case USB_AUDIO_FORMAT_PCM:
2222 if (sample_width > sample_bytes * 8) {
2223 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2224 chip->dev->devnum, fp->iface, fp->altsetting,
2225 sample_width, sample_bytes);
2227 /* check the format byte size */
2230 pcm_format = SNDRV_PCM_FORMAT_S8;
2233 if (is_big_endian_format(chip, fp))
2234 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2236 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2239 if (is_big_endian_format(chip, fp))
2240 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2242 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2245 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2248 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2249 chip->dev->devnum, fp->iface,
2250 fp->altsetting, sample_width, sample_bytes);
2254 case USB_AUDIO_FORMAT_PCM8:
2255 /* Dallas DS4201 workaround */
2256 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2257 pcm_format = SNDRV_PCM_FORMAT_S8;
2259 pcm_format = SNDRV_PCM_FORMAT_U8;
2261 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2262 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2264 case USB_AUDIO_FORMAT_ALAW:
2265 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2267 case USB_AUDIO_FORMAT_MU_LAW:
2268 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2271 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2272 chip->dev->devnum, fp->iface, fp->altsetting, format);
2280 * parse the format descriptor and stores the possible sample rates
2281 * on the audioformat table.
2284 * @fp: audioformat record
2285 * @fmt: the format descriptor
2286 * @offset: the start offset of descriptor pointing the rate type
2287 * (7 for type I and II, 8 for type II)
2289 static int parse_audio_format_rates(snd_usb_audio_t *chip, struct audioformat *fp,
2290 unsigned char *fmt, int offset)
2292 int nr_rates = fmt[offset];
2293 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2294 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2295 chip->dev->devnum, fp->iface, fp->altsetting);
2301 * build the rate table and bitmap flags
2304 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2305 static unsigned int conv_rates[] = {
2306 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2307 64000, 88200, 96000, 176400, 192000
2309 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2310 if (fp->rate_table == NULL) {
2311 snd_printk(KERN_ERR "cannot malloc\n");
2315 fp->nr_rates = nr_rates;
2316 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2317 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2318 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2319 if (rate < fp->rate_min)
2320 fp->rate_min = rate;
2321 else if (rate > fp->rate_max)
2322 fp->rate_max = rate;
2323 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2324 if (rate == conv_rates[c]) {
2325 fp->rates |= (1 << c);
2331 /* continuous rates */
2332 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2333 fp->rate_min = combine_triple(&fmt[offset + 1]);
2334 fp->rate_max = combine_triple(&fmt[offset + 4]);
2340 * parse the format type I and III descriptors
2342 static int parse_audio_format_i(snd_usb_audio_t *chip, struct audioformat *fp,
2343 int format, unsigned char *fmt)
2347 if (fmt[3] == USB_FORMAT_TYPE_III) {
2348 /* FIXME: the format type is really IECxxx
2349 * but we give normal PCM format to get the existing
2352 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2354 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2358 fp->format = pcm_format;
2359 fp->channels = fmt[4];
2360 if (fp->channels < 1) {
2361 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2362 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2365 return parse_audio_format_rates(chip, fp, fmt, 7);
2369 * prase the format type II descriptor
2371 static int parse_audio_format_ii(snd_usb_audio_t *chip, struct audioformat *fp,
2372 int format, unsigned char *fmt)
2374 int brate, framesize;
2376 case USB_AUDIO_FORMAT_AC3:
2377 /* FIXME: there is no AC3 format defined yet */
2378 // fp->format = SNDRV_PCM_FORMAT_AC3;
2379 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2381 case USB_AUDIO_FORMAT_MPEG:
2382 fp->format = SNDRV_PCM_FORMAT_MPEG;
2385 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2386 chip->dev->devnum, fp->iface, fp->altsetting, format);
2387 fp->format = SNDRV_PCM_FORMAT_MPEG;
2391 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2392 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2393 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2394 fp->frame_size = framesize;
2395 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2398 static int parse_audio_format(snd_usb_audio_t *chip, struct audioformat *fp,
2399 int format, unsigned char *fmt, int stream)
2404 case USB_FORMAT_TYPE_I:
2405 case USB_FORMAT_TYPE_III:
2406 err = parse_audio_format_i(chip, fp, format, fmt);
2408 case USB_FORMAT_TYPE_II:
2409 err = parse_audio_format_ii(chip, fp, format, fmt);
2412 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2413 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2416 fp->fmt_type = fmt[3];
2420 /* FIXME: temporary hack for extigy/audigy 2 nx */
2421 /* extigy apparently supports sample rates other than 48k
2422 * but not in ordinary way. so we enable only 48k atm.
2424 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2425 chip->usb_id == USB_ID(0x041e, 0x3020)) {
2426 if (fmt[3] == USB_FORMAT_TYPE_I &&
2427 fp->rates != SNDRV_PCM_RATE_48000 &&
2428 fp->rates != SNDRV_PCM_RATE_96000)
2435 static int parse_audio_endpoints(snd_usb_audio_t *chip, int iface_no)
2437 struct usb_device *dev;
2438 struct usb_interface *iface;
2439 struct usb_host_interface *alts;
2440 struct usb_interface_descriptor *altsd;
2441 int i, altno, err, stream;
2443 struct audioformat *fp;
2444 unsigned char *fmt, *csep;
2448 /* parse the interface's altsettings */
2449 iface = usb_ifnum_to_if(dev, iface_no);
2450 for (i = 0; i < iface->num_altsetting; i++) {
2451 alts = &iface->altsetting[i];
2452 altsd = get_iface_desc(alts);
2453 /* skip invalid one */
2454 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2455 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2456 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2457 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2458 altsd->bNumEndpoints < 1 ||
2459 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2461 /* must be isochronous */
2462 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2463 USB_ENDPOINT_XFER_ISOC)
2465 /* check direction */
2466 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2467 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2468 altno = altsd->bAlternateSetting;
2470 /* get audio formats */
2471 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2473 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2474 dev->devnum, iface_no, altno);
2479 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2480 dev->devnum, iface_no, altno);
2484 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2486 /* get format type */
2487 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2489 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2490 dev->devnum, iface_no, altno);
2494 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2495 dev->devnum, iface_no, altno);
2499 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2500 /* Creamware Noah has this descriptor after the 2nd endpoint */
2501 if (!csep && altsd->bNumEndpoints >= 2)
2502 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2503 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2504 snd_printk(KERN_ERR "%d:%u:%d : no or invalid class specific endpoint descriptor\n",
2505 dev->devnum, iface_no, altno);
2509 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2511 snd_printk(KERN_ERR "cannot malloc\n");
2515 memset(fp, 0, sizeof(*fp));
2516 fp->iface = iface_no;
2517 fp->altsetting = altno;
2519 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2520 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2521 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2522 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2523 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2524 * (fp->maxpacksize & 0x7ff);
2525 fp->attributes = csep[3];
2527 /* some quirks for attributes here */
2529 switch (chip->usb_id) {
2530 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2531 /* Optoplay sets the sample rate attribute although
2532 * it seems not supporting it in fact.
2534 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2536 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2537 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2538 /* doesn't set the sample rate attribute, but supports it */
2539 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2541 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2542 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2543 an older model 77d:223) */
2545 * plantronics headset and Griffin iMic have set adaptive-in
2546 * although it's really not...
2548 fp->ep_attr &= ~EP_ATTR_MASK;
2549 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2550 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2552 fp->ep_attr |= EP_ATTR_SYNC;
2556 /* ok, let's parse further... */
2557 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2558 kfree(fp->rate_table);
2563 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, i, fp->endpoint);
2564 err = add_audio_endpoint(chip, stream, fp);
2566 kfree(fp->rate_table);
2570 /* try to set the interface... */
2571 usb_set_interface(chip->dev, iface_no, altno);
2572 init_usb_pitch(chip->dev, iface_no, alts, fp);
2573 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2580 * disconnect streams
2581 * called from snd_usb_audio_disconnect()
2583 static void snd_usb_stream_disconnect(struct list_head *head)
2586 snd_usb_stream_t *as;
2587 snd_usb_substream_t *subs;
2589 as = list_entry(head, snd_usb_stream_t, list);
2590 for (idx = 0; idx < 2; idx++) {
2591 subs = &as->substream[idx];
2592 if (!subs->num_formats)
2594 release_substream_urbs(subs, 1);
2595 subs->interface = -1;
2600 * parse audio control descriptor and create pcm/midi streams
2602 static int snd_usb_create_streams(snd_usb_audio_t *chip, int ctrlif)
2604 struct usb_device *dev = chip->dev;
2605 struct usb_host_interface *host_iface;
2606 struct usb_interface *iface;
2610 /* find audiocontrol interface */
2611 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2612 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2613 snd_printk(KERN_ERR "cannot find HEADER\n");
2616 if (! p1[7] || p1[0] < 8 + p1[7]) {
2617 snd_printk(KERN_ERR "invalid HEADER\n");
2622 * parse all USB audio streaming interfaces
2624 for (i = 0; i < p1[7]; i++) {
2625 struct usb_host_interface *alts;
2626 struct usb_interface_descriptor *altsd;
2628 iface = usb_ifnum_to_if(dev, j);
2630 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2631 dev->devnum, ctrlif, j);
2634 if (usb_interface_claimed(iface)) {
2635 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2638 alts = &iface->altsetting[0];
2639 altsd = get_iface_desc(alts);
2640 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2641 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2642 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2643 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2644 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2647 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2650 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2651 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2652 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2653 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2654 /* skip non-supported classes */
2657 if (! parse_audio_endpoints(chip, j)) {
2658 usb_set_interface(dev, j, 0); /* reset the current interface */
2659 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2667 * create a stream for an endpoint/altsetting without proper descriptors
2669 static int create_fixed_stream_quirk(snd_usb_audio_t *chip,
2670 struct usb_interface *iface,
2671 const snd_usb_audio_quirk_t *quirk)
2673 struct audioformat *fp;
2674 struct usb_host_interface *alts;
2676 int *rate_table = NULL;
2678 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2680 snd_printk(KERN_ERR "cannot malloc\n");
2683 memcpy(fp, quirk->data, sizeof(*fp));
2684 if (fp->nr_rates > 0) {
2685 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2690 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2691 fp->rate_table = rate_table;
2694 stream = (fp->endpoint & USB_DIR_IN)
2695 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2696 err = add_audio_endpoint(chip, stream, fp);
2702 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2703 fp->altset_idx >= iface->num_altsetting) {
2708 alts = &iface->altsetting[fp->altset_idx];
2709 usb_set_interface(chip->dev, fp->iface, 0);
2710 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2711 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2716 * create a stream for an interface with proper descriptors
2718 static int create_standard_interface_quirk(snd_usb_audio_t *chip,
2719 struct usb_interface *iface,
2720 const snd_usb_audio_quirk_t *quirk)
2722 struct usb_host_interface *alts;
2723 struct usb_interface_descriptor *altsd;
2726 alts = &iface->altsetting[0];
2727 altsd = get_iface_desc(alts);
2728 switch (quirk->type) {
2729 case QUIRK_AUDIO_STANDARD_INTERFACE:
2730 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2732 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0); /* reset the current interface */
2734 case QUIRK_MIDI_STANDARD_INTERFACE:
2735 err = snd_usb_create_midi_interface(chip, iface, NULL);
2738 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
2742 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2743 altsd->bInterfaceNumber, err);
2750 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2751 * to detect the sample rate is by looking at wMaxPacketSize.
2753 static int create_ua700_ua25_quirk(snd_usb_audio_t *chip,
2754 struct usb_interface *iface,
2755 const snd_usb_audio_quirk_t *quirk)
2757 static const struct audioformat ua_format = {
2758 .format = SNDRV_PCM_FORMAT_S24_3LE,
2760 .fmt_type = USB_FORMAT_TYPE_I,
2763 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2765 struct usb_host_interface *alts;
2766 struct usb_interface_descriptor *altsd;
2767 struct audioformat *fp;
2770 /* both PCM and MIDI interfaces have 2 altsettings */
2771 if (iface->num_altsetting != 2)
2773 alts = &iface->altsetting[1];
2774 altsd = get_iface_desc(alts);
2776 if (altsd->bNumEndpoints == 2) {
2777 static const snd_usb_midi_endpoint_info_t ua700_ep = {
2778 .out_cables = 0x0003,
2781 static const snd_usb_audio_quirk_t ua700_quirk = {
2782 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2785 static const snd_usb_midi_endpoint_info_t ua25_ep = {
2786 .out_cables = 0x0001,
2789 static const snd_usb_audio_quirk_t ua25_quirk = {
2790 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2793 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2794 return snd_usb_create_midi_interface(chip, iface,
2797 return snd_usb_create_midi_interface(chip, iface,
2801 if (altsd->bNumEndpoints != 1)
2804 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2807 memcpy(fp, &ua_format, sizeof(*fp));
2809 fp->iface = altsd->bInterfaceNumber;
2810 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2811 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2812 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2814 switch (fp->maxpacksize) {
2816 fp->rate_max = fp->rate_min = 44100;
2820 fp->rate_max = fp->rate_min = 48000;
2824 fp->rate_max = fp->rate_min = 96000;
2827 snd_printk(KERN_ERR "unknown sample rate\n");
2832 stream = (fp->endpoint & USB_DIR_IN)
2833 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2834 err = add_audio_endpoint(chip, stream, fp);
2839 usb_set_interface(chip->dev, fp->iface, 0);
2844 * Create a stream for an Edirol UA-1000 interface.
2846 static int create_ua1000_quirk(snd_usb_audio_t *chip,
2847 struct usb_interface *iface,
2848 const snd_usb_audio_quirk_t *quirk)
2850 static const struct audioformat ua1000_format = {
2851 .format = SNDRV_PCM_FORMAT_S32_LE,
2852 .fmt_type = USB_FORMAT_TYPE_I,
2856 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2858 struct usb_host_interface *alts;
2859 struct usb_interface_descriptor *altsd;
2860 struct audioformat *fp;
2863 if (iface->num_altsetting != 2)
2865 alts = &iface->altsetting[1];
2866 altsd = get_iface_desc(alts);
2867 if (alts->extralen != 11 || alts->extra[1] != CS_AUDIO_INTERFACE ||
2868 altsd->bNumEndpoints != 1)
2871 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2874 memcpy(fp, &ua1000_format, sizeof(*fp));
2876 fp->channels = alts->extra[4];
2877 fp->iface = altsd->bInterfaceNumber;
2878 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2879 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2880 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2881 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2883 stream = (fp->endpoint & USB_DIR_IN)
2884 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2885 err = add_audio_endpoint(chip, stream, fp);
2890 /* FIXME: playback must be synchronized to capture */
2891 usb_set_interface(chip->dev, fp->iface, 0);
2895 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2896 struct usb_interface *iface,
2897 const snd_usb_audio_quirk_t *quirk);
2900 * handle the quirks for the contained interfaces
2902 static int create_composite_quirk(snd_usb_audio_t *chip,
2903 struct usb_interface *iface,
2904 const snd_usb_audio_quirk_t *quirk)
2906 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
2909 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
2910 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
2913 if (quirk->ifnum != probed_ifnum &&
2914 usb_interface_claimed(iface))
2916 err = snd_usb_create_quirk(chip, iface, quirk);
2919 if (quirk->ifnum != probed_ifnum)
2920 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2925 static int ignore_interface_quirk(snd_usb_audio_t *chip,
2926 struct usb_interface *iface,
2927 const snd_usb_audio_quirk_t *quirk)
2937 #define EXTIGY_FIRMWARE_SIZE_OLD 794
2938 #define EXTIGY_FIRMWARE_SIZE_NEW 483
2940 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
2942 struct usb_host_config *config = dev->actconfig;
2945 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
2946 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
2947 snd_printdd("sending Extigy boot sequence...\n");
2948 /* Send message to force it to reconnect with full interface. */
2949 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
2950 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
2951 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
2952 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
2953 &dev->descriptor, sizeof(dev->descriptor));
2954 config = dev->actconfig;
2955 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
2956 err = usb_reset_configuration(dev);
2957 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
2958 snd_printdd("extigy_boot: new boot length = %d\n",
2959 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
2960 return -ENODEV; /* quit this anyway */
2965 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
2969 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
2970 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
2971 0, 0, &buf, 1, 1000);
2973 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
2974 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
2975 1, 2000, NULL, 0, 1000);
2983 * audio-interface quirks
2985 * returns zero if no standard audio/MIDI parsing is needed.
2986 * returns a postive value if standard audio/midi interfaces are parsed
2988 * returns a negative value at error.
2990 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2991 struct usb_interface *iface,
2992 const snd_usb_audio_quirk_t *quirk)
2994 typedef int (*quirk_func_t)(snd_usb_audio_t *, struct usb_interface *,
2995 const snd_usb_audio_quirk_t *);
2996 static const quirk_func_t quirk_funcs[] = {
2997 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
2998 [QUIRK_COMPOSITE] = create_composite_quirk,
2999 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3000 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3001 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3002 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3003 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3004 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3005 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3006 [QUIRK_MIDI_MIDITECH] = snd_usb_create_midi_interface,
3007 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_interface_quirk,
3008 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3009 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3010 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3013 if (quirk->type < QUIRK_TYPE_COUNT) {
3014 return quirk_funcs[quirk->type](chip, iface, quirk);
3016 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3023 * common proc files to show the usb device info
3025 static void proc_audio_usbbus_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3027 snd_usb_audio_t *chip = entry->private_data;
3028 if (! chip->shutdown)
3029 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3032 static void proc_audio_usbid_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3034 snd_usb_audio_t *chip = entry->private_data;
3035 if (! chip->shutdown)
3036 snd_iprintf(buffer, "%04x:%04x\n",
3037 USB_ID_VENDOR(chip->usb_id),
3038 USB_ID_PRODUCT(chip->usb_id));
3041 static void snd_usb_audio_create_proc(snd_usb_audio_t *chip)
3043 snd_info_entry_t *entry;
3044 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3045 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbbus_read);
3046 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3047 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbid_read);
3051 * free the chip instance
3053 * here we have to do not much, since pcm and controls are already freed
3057 static int snd_usb_audio_free(snd_usb_audio_t *chip)
3063 static int snd_usb_audio_dev_free(snd_device_t *device)
3065 snd_usb_audio_t *chip = device->device_data;
3066 return snd_usb_audio_free(chip);
3071 * create a chip instance and set its names.
3073 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3074 const snd_usb_audio_quirk_t *quirk,
3075 snd_usb_audio_t **rchip)
3078 snd_usb_audio_t *chip;
3081 static snd_device_ops_t ops = {
3082 .dev_free = snd_usb_audio_dev_free,
3087 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3088 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3089 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3093 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3095 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3099 chip = kcalloc(1, sizeof(*chip), GFP_KERNEL);
3101 snd_card_free(card);
3108 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3109 le16_to_cpu(dev->descriptor.idProduct));
3110 INIT_LIST_HEAD(&chip->pcm_list);
3111 INIT_LIST_HEAD(&chip->midi_list);
3112 INIT_LIST_HEAD(&chip->mixer_list);
3114 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3115 snd_usb_audio_free(chip);
3116 snd_card_free(card);
3120 strcpy(card->driver, "USB-Audio");
3121 sprintf(component, "USB%04x:%04x",
3122 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3123 snd_component_add(card, component);
3125 /* retrieve the device string as shortname */
3126 if (quirk && quirk->product_name) {
3127 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3129 if (!dev->descriptor.iProduct ||
3130 usb_string(dev, dev->descriptor.iProduct,
3131 card->shortname, sizeof(card->shortname)) <= 0) {
3132 /* no name available from anywhere, so use ID */
3133 sprintf(card->shortname, "USB Device %#04x:%#04x",
3134 USB_ID_VENDOR(chip->usb_id),
3135 USB_ID_PRODUCT(chip->usb_id));
3139 /* retrieve the vendor and device strings as longname */
3140 if (quirk && quirk->vendor_name) {
3141 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3143 if (dev->descriptor.iManufacturer)
3144 len = usb_string(dev, dev->descriptor.iManufacturer,
3145 card->longname, sizeof(card->longname));
3148 /* we don't really care if there isn't any vendor string */
3151 strlcat(card->longname, " ", sizeof(card->longname));
3153 strlcat(card->longname, card->shortname, sizeof(card->longname));
3155 len = strlcat(card->longname, " at ", sizeof(card->longname));
3157 if (len < sizeof(card->longname))
3158 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3160 strlcat(card->longname,
3161 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3162 sizeof(card->longname));
3164 snd_usb_audio_create_proc(chip);
3172 * probe the active usb device
3174 * note that this can be called multiple times per a device, when it
3175 * includes multiple audio control interfaces.
3177 * thus we check the usb device pointer and creates the card instance
3178 * only at the first time. the successive calls of this function will
3179 * append the pcm interface to the corresponding card.
3181 static void *snd_usb_audio_probe(struct usb_device *dev,
3182 struct usb_interface *intf,
3183 const struct usb_device_id *usb_id)
3185 struct usb_host_config *config = dev->actconfig;
3186 const snd_usb_audio_quirk_t *quirk = (const snd_usb_audio_quirk_t *)usb_id->driver_info;
3188 snd_usb_audio_t *chip;
3189 struct usb_host_interface *alts;
3193 alts = &intf->altsetting[0];
3194 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3195 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3196 le16_to_cpu(dev->descriptor.idProduct));
3198 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3201 /* SB Extigy needs special boot-up sequence */
3202 /* if more models come, this will go to the quirk list. */
3203 if (id == USB_ID(0x041e, 0x3000)) {
3204 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3206 config = dev->actconfig;
3208 /* SB Audigy 2 NX needs its own boot-up magic, too */
3209 if (id == USB_ID(0x041e, 0x3020)) {
3210 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3215 * found a config. now register to ALSA
3218 /* check whether it's already registered */
3220 down(®ister_mutex);
3221 for (i = 0; i < SNDRV_CARDS; i++) {
3222 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3223 if (usb_chip[i]->shutdown) {
3224 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3232 /* it's a fresh one.
3233 * now look for an empty slot and create a new card instance
3235 /* first, set the current configuration for this device */
3236 if (usb_reset_configuration(dev) < 0) {
3237 snd_printk(KERN_ERR "cannot reset configuration (value 0x%x)\n", get_cfg_desc(config)->bConfigurationValue);
3240 for (i = 0; i < SNDRV_CARDS; i++)
3241 if (enable[i] && ! usb_chip[i] &&
3242 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3243 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3244 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3247 snd_card_set_dev(chip->card, &intf->dev);
3251 snd_printk(KERN_ERR "no available usb audio device\n");
3256 err = 1; /* continue */
3257 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3258 /* need some special handlings */
3259 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3264 /* create normal USB audio interfaces */
3265 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3266 snd_usb_create_mixer(chip, ifnum) < 0) {
3271 /* we are allowed to call snd_card_register() many times */
3272 if (snd_card_register(chip->card) < 0) {
3276 usb_chip[chip->index] = chip;
3277 chip->num_interfaces++;
3278 up(®ister_mutex);
3282 if (chip && !chip->num_interfaces)
3283 snd_card_free(chip->card);
3284 up(®ister_mutex);
3290 * we need to take care of counter, since disconnection can be called also
3291 * many times as well as usb_audio_probe().
3293 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3295 snd_usb_audio_t *chip;
3297 struct list_head *p;
3299 if (ptr == (void *)-1L)
3304 down(®ister_mutex);
3306 chip->num_interfaces--;
3307 if (chip->num_interfaces <= 0) {
3308 snd_card_disconnect(card);
3309 /* release the pcm resources */
3310 list_for_each(p, &chip->pcm_list) {
3311 snd_usb_stream_disconnect(p);
3313 /* release the midi resources */
3314 list_for_each(p, &chip->midi_list) {
3315 snd_usbmidi_disconnect(p);
3317 /* release mixer resources */
3318 list_for_each(p, &chip->mixer_list) {
3319 snd_usb_mixer_disconnect(p);
3321 usb_chip[chip->index] = NULL;
3322 up(®ister_mutex);
3323 snd_card_free(card);
3325 up(®ister_mutex);
3330 * new 2.5 USB kernel API
3332 static int usb_audio_probe(struct usb_interface *intf,
3333 const struct usb_device_id *id)
3336 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3338 dev_set_drvdata(&intf->dev, chip);
3344 static void usb_audio_disconnect(struct usb_interface *intf)
3346 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3347 dev_get_drvdata(&intf->dev));
3351 static int __init snd_usb_audio_init(void)
3353 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3354 printk(KERN_WARNING "invalid nrpacks value.\n");
3357 usb_register(&usb_audio_driver);
3362 static void __exit snd_usb_audio_cleanup(void)
3364 usb_deregister(&usb_audio_driver);
3367 module_init(snd_usb_audio_init);
3368 module_exit(snd_usb_audio_cleanup);