2 * (Tentative) USB Audio Driver for ALSA
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * - async unlink should be used for avoiding the sleep inside lock.
31 * 2.4.22 usb-uhci seems buggy for async unlinking and results in
32 * oops. in such a cse, pass async_unlink=0 option.
33 * - the linked URBs would be preferred but not used so far because of
34 * the instability of unlinking.
35 * - type II is not supported properly. there is no device which supports
36 * this type *correctly*. SB extigy looks as if it supports, but it's
37 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
41 #include <sound/driver.h>
42 #include <linux/bitops.h>
43 #include <linux/init.h>
44 #include <linux/list.h>
45 #include <linux/slab.h>
46 #include <linux/string.h>
47 #include <linux/usb.h>
48 #include <linux/vmalloc.h>
49 #include <linux/moduleparam.h>
50 #include <linux/mutex.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;
73 static int device_setup[SNDRV_CARDS]; /* device parameter for this card*/
75 module_param_array(index, int, NULL, 0444);
76 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
77 module_param_array(id, charp, NULL, 0444);
78 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
79 module_param_array(enable, bool, NULL, 0444);
80 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
81 module_param_array(vid, int, NULL, 0444);
82 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
83 module_param_array(pid, int, NULL, 0444);
84 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
85 module_param(nrpacks, int, 0644);
86 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
87 module_param(async_unlink, bool, 0444);
88 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
89 module_param_array(device_setup, int, NULL, 0444);
90 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
94 * debug the h/w constraints
96 /* #define HW_CONST_DEBUG */
104 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
106 #define SYNC_URBS 4 /* always four urbs for sync */
107 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
110 struct list_head list;
111 snd_pcm_format_t format; /* format type */
112 unsigned int channels; /* # channels */
113 unsigned int fmt_type; /* USB audio format type (1-3) */
114 unsigned int frame_size; /* samples per frame for non-audio */
115 int iface; /* interface number */
116 unsigned char altsetting; /* corresponding alternate setting */
117 unsigned char altset_idx; /* array index of altenate setting */
118 unsigned char attributes; /* corresponding attributes of cs endpoint */
119 unsigned char endpoint; /* endpoint */
120 unsigned char ep_attr; /* endpoint attributes */
121 unsigned int maxpacksize; /* max. packet size */
122 unsigned int rates; /* rate bitmasks */
123 unsigned int rate_min, rate_max; /* min/max rates */
124 unsigned int nr_rates; /* number of rate table entries */
125 unsigned int *rate_table; /* rate table */
128 struct snd_usb_substream;
132 unsigned int buffer_size; /* size of data buffer, if data URB */
133 struct snd_usb_substream *subs;
134 int index; /* index for urb array */
135 int packets; /* number of packets per urb */
139 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
140 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
142 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
145 struct snd_usb_substream {
146 struct snd_usb_stream *stream;
147 struct usb_device *dev;
148 struct snd_pcm_substream *pcm_substream;
149 int direction; /* playback or capture */
150 int interface; /* current interface */
151 int endpoint; /* assigned endpoint */
152 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
153 unsigned int cur_rate; /* current rate (for hw_params callback) */
154 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
155 unsigned int format; /* USB data format */
156 unsigned int datapipe; /* the data i/o pipe */
157 unsigned int syncpipe; /* 1 - async out or adaptive in */
158 unsigned int datainterval; /* log_2 of data packet interval */
159 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
160 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
162 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
163 unsigned int phase; /* phase accumulator */
164 unsigned int maxpacksize; /* max packet size in bytes */
165 unsigned int maxframesize; /* max packet size in frames */
166 unsigned int curpacksize; /* current packet size in bytes (for capture) */
167 unsigned int curframesize; /* current packet size in frames (for capture) */
168 unsigned int fill_max: 1; /* fill max packet size always */
169 unsigned int fmt_type; /* USB audio format type (1-3) */
170 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
172 unsigned int running: 1; /* running status */
174 unsigned int hwptr_done; /* processed frame position in the buffer */
175 unsigned int transfer_done; /* processed frames since last period update */
176 unsigned long active_mask; /* bitmask of active urbs */
177 unsigned long unlink_mask; /* bitmask of unlinked urbs */
179 unsigned int nurbs; /* # urbs */
180 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
181 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
182 char *syncbuf; /* sync buffer for all sync URBs */
183 dma_addr_t sync_dma; /* DMA address of syncbuf */
185 u64 formats; /* format bitmasks (all or'ed) */
186 unsigned int num_formats; /* number of supported audio formats (list) */
187 struct list_head fmt_list; /* format list */
190 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
194 struct snd_usb_stream {
195 struct snd_usb_audio *chip;
198 unsigned int fmt_type; /* USB audio format type (1-3) */
199 struct snd_usb_substream 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 DEFINE_MUTEX(register_mutex);
210 static struct snd_usb_audio *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(struct snd_usb_substream *subs,
251 struct snd_pcm_runtime *runtime,
254 unsigned char *cp = urb->transfer_buffer;
255 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)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(struct snd_usb_substream *subs,
273 struct snd_pcm_runtime *runtime,
276 unsigned char *cp = urb->transfer_buffer;
277 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)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(struct snd_usb_substream *subs,
294 struct snd_pcm_runtime *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(struct snd_usb_substream *subs,
311 struct snd_pcm_runtime *runtime,
315 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)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(struct snd_usb_substream *subs,
346 struct snd_pcm_runtime *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(struct snd_usb_substream *subs,
401 struct snd_pcm_runtime *runtime,
404 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)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(struct snd_usb_substream *subs,
419 struct snd_pcm_runtime *runtime,
422 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)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(struct snd_usb_substream *subs,
437 struct snd_pcm_runtime *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(struct snd_usb_substream *subs,
463 struct snd_pcm_runtime *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);
482 /* determine the number of frames in the next packet */
483 static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
486 return subs->maxframesize;
488 subs->phase = (subs->phase & 0xffff)
489 + (subs->freqm << subs->datainterval);
490 return min(subs->phase >> 16, subs->maxframesize);
495 * Prepare urb for streaming before playback starts.
497 * We don't yet have data, so we send a frame of silence.
499 static int prepare_startup_playback_urb(struct snd_usb_substream *subs,
500 struct snd_pcm_runtime *runtime,
503 unsigned int i, offs, counts;
504 struct snd_urb_ctx *ctx = urb->context;
505 int stride = runtime->frame_bits >> 3;
508 urb->dev = ctx->subs->dev;
509 urb->number_of_packets = subs->packs_per_ms;
510 for (i = 0; i < subs->packs_per_ms; ++i) {
511 counts = snd_usb_audio_next_packet_size(subs);
512 urb->iso_frame_desc[i].offset = offs * stride;
513 urb->iso_frame_desc[i].length = counts * stride;
516 urb->transfer_buffer_length = offs * stride;
517 memset(urb->transfer_buffer,
518 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
524 * prepare urb for playback data pipe
526 * Since a URB can handle only a single linear buffer, we must use double
527 * buffering when the data to be transferred overflows the buffer boundary.
528 * To avoid inconsistencies when updating hwptr_done, we use double buffering
531 static int prepare_playback_urb(struct snd_usb_substream *subs,
532 struct snd_pcm_runtime *runtime,
538 int period_elapsed = 0;
539 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
541 stride = runtime->frame_bits >> 3;
544 urb->dev = ctx->subs->dev; /* we need to set this at each time */
545 urb->number_of_packets = 0;
546 spin_lock_irqsave(&subs->lock, flags);
547 for (i = 0; i < ctx->packets; i++) {
548 counts = snd_usb_audio_next_packet_size(subs);
549 /* set up descriptor */
550 urb->iso_frame_desc[i].offset = offs * stride;
551 urb->iso_frame_desc[i].length = counts * stride;
553 urb->number_of_packets++;
554 subs->transfer_done += counts;
555 if (subs->transfer_done >= runtime->period_size) {
556 subs->transfer_done -= runtime->period_size;
558 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
559 if (subs->transfer_done > 0) {
560 /* FIXME: fill-max mode is not
562 offs -= subs->transfer_done;
563 counts -= subs->transfer_done;
564 urb->iso_frame_desc[i].length =
566 subs->transfer_done = 0;
569 if (i < ctx->packets) {
570 /* add a transfer delimiter */
571 urb->iso_frame_desc[i].offset =
573 urb->iso_frame_desc[i].length = 0;
574 urb->number_of_packets++;
579 /* finish at the frame boundary at/after the period boundary */
580 if (period_elapsed &&
581 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
584 if (subs->hwptr_done + offs > runtime->buffer_size) {
585 /* err, the transferred area goes over buffer boundary. */
586 unsigned int len = runtime->buffer_size - subs->hwptr_done;
587 memcpy(urb->transfer_buffer,
588 runtime->dma_area + subs->hwptr_done * stride,
590 memcpy(urb->transfer_buffer + len * stride,
592 (offs - len) * stride);
594 memcpy(urb->transfer_buffer,
595 runtime->dma_area + subs->hwptr_done * stride,
598 subs->hwptr_done += offs;
599 if (subs->hwptr_done >= runtime->buffer_size)
600 subs->hwptr_done -= runtime->buffer_size;
601 spin_unlock_irqrestore(&subs->lock, flags);
602 urb->transfer_buffer_length = offs * stride;
604 snd_pcm_period_elapsed(subs->pcm_substream);
609 * process after playback data complete
612 static int retire_playback_urb(struct snd_usb_substream *subs,
613 struct snd_pcm_runtime *runtime,
622 static struct snd_urb_ops audio_urb_ops[2] = {
624 .prepare = prepare_startup_playback_urb,
625 .retire = retire_playback_urb,
626 .prepare_sync = prepare_playback_sync_urb,
627 .retire_sync = retire_playback_sync_urb,
630 .prepare = prepare_capture_urb,
631 .retire = retire_capture_urb,
632 .prepare_sync = prepare_capture_sync_urb,
633 .retire_sync = retire_capture_sync_urb,
637 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
639 .prepare = prepare_startup_playback_urb,
640 .retire = retire_playback_urb,
641 .prepare_sync = prepare_playback_sync_urb_hs,
642 .retire_sync = retire_playback_sync_urb_hs,
645 .prepare = prepare_capture_urb,
646 .retire = retire_capture_urb,
647 .prepare_sync = prepare_capture_sync_urb_hs,
648 .retire_sync = retire_capture_sync_urb,
653 * complete callback from data urb
655 static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
657 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
658 struct snd_usb_substream *subs = ctx->subs;
659 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
662 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
663 ! subs->running || /* can be stopped during retire callback */
664 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
665 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
666 clear_bit(ctx->index, &subs->active_mask);
668 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
669 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
676 * complete callback from sync urb
678 static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
680 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
681 struct snd_usb_substream *subs = ctx->subs;
682 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
685 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
686 ! subs->running || /* can be stopped during retire callback */
687 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
688 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
689 clear_bit(ctx->index + 16, &subs->active_mask);
691 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
692 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
698 /* get the physical page pointer at the given offset */
699 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
700 unsigned long offset)
702 void *pageptr = subs->runtime->dma_area + offset;
703 return vmalloc_to_page(pageptr);
706 /* allocate virtual buffer; may be called more than once */
707 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
709 struct snd_pcm_runtime *runtime = subs->runtime;
710 if (runtime->dma_area) {
711 if (runtime->dma_bytes >= size)
712 return 0; /* already large enough */
713 vfree(runtime->dma_area);
715 runtime->dma_area = vmalloc(size);
716 if (! runtime->dma_area)
718 runtime->dma_bytes = size;
722 /* free virtual buffer; may be called more than once */
723 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
725 struct snd_pcm_runtime *runtime = subs->runtime;
727 vfree(runtime->dma_area);
728 runtime->dma_area = NULL;
734 * unlink active urbs.
736 static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
743 if (!force && subs->stream->chip->shutdown) /* to be sure... */
746 async = !can_sleep && async_unlink;
748 if (! async && in_interrupt())
751 for (i = 0; i < subs->nurbs; i++) {
752 if (test_bit(i, &subs->active_mask)) {
753 if (! test_and_set_bit(i, &subs->unlink_mask)) {
754 struct urb *u = subs->dataurb[i].urb;
762 if (subs->syncpipe) {
763 for (i = 0; i < SYNC_URBS; i++) {
764 if (test_bit(i+16, &subs->active_mask)) {
765 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
766 struct urb *u = subs->syncurb[i].urb;
779 static const char *usb_error_string(int err)
785 return "endpoint not enabled";
787 return "endpoint stalled";
789 return "not enough bandwidth";
791 return "device disabled";
793 return "device suspended";
794 #ifndef CONFIG_USB_EHCI_SPLIT_ISO
796 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
802 return "internal error";
804 return "unknown error";
809 * set up and start data/sync urbs
811 static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
816 if (subs->stream->chip->shutdown)
819 for (i = 0; i < subs->nurbs; i++) {
820 snd_assert(subs->dataurb[i].urb, return -EINVAL);
821 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
822 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
826 if (subs->syncpipe) {
827 for (i = 0; i < SYNC_URBS; i++) {
828 snd_assert(subs->syncurb[i].urb, return -EINVAL);
829 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
830 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
836 subs->active_mask = 0;
837 subs->unlink_mask = 0;
839 for (i = 0; i < subs->nurbs; i++) {
840 err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
842 snd_printk(KERN_ERR "cannot submit datapipe "
843 "for urb %d, error %d: %s\n",
844 i, err, usb_error_string(err));
847 set_bit(i, &subs->active_mask);
849 if (subs->syncpipe) {
850 for (i = 0; i < SYNC_URBS; i++) {
851 err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
853 snd_printk(KERN_ERR "cannot submit syncpipe "
854 "for urb %d, error %d: %s\n",
855 i, err, usb_error_string(err));
858 set_bit(i + 16, &subs->active_mask);
864 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
865 deactivate_urbs(subs, 0, 0);
871 * wait until all urbs are processed.
873 static int wait_clear_urbs(struct snd_usb_substream *subs)
875 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
881 for (i = 0; i < subs->nurbs; i++) {
882 if (test_bit(i, &subs->active_mask))
885 if (subs->syncpipe) {
886 for (i = 0; i < SYNC_URBS; i++) {
887 if (test_bit(i + 16, &subs->active_mask))
893 schedule_timeout_uninterruptible(1);
894 } while (time_before(jiffies, end_time));
896 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
902 * return the current pcm pointer. just return the hwptr_done value.
904 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
906 struct snd_usb_substream *subs;
907 snd_pcm_uframes_t hwptr_done;
909 subs = (struct snd_usb_substream *)substream->runtime->private_data;
910 spin_lock(&subs->lock);
911 hwptr_done = subs->hwptr_done;
912 spin_unlock(&subs->lock);
918 * start/stop playback substream
920 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
923 struct snd_usb_substream *subs = substream->runtime->private_data;
926 case SNDRV_PCM_TRIGGER_START:
927 subs->ops.prepare = prepare_playback_urb;
929 case SNDRV_PCM_TRIGGER_STOP:
930 return deactivate_urbs(subs, 0, 0);
937 * start/stop capture substream
939 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
942 struct snd_usb_substream *subs = substream->runtime->private_data;
945 case SNDRV_PCM_TRIGGER_START:
946 return start_urbs(subs, substream->runtime);
947 case SNDRV_PCM_TRIGGER_STOP:
948 return deactivate_urbs(subs, 0, 0);
958 static void release_urb_ctx(struct snd_urb_ctx *u)
962 usb_buffer_free(u->subs->dev, u->buffer_size,
963 u->urb->transfer_buffer,
964 u->urb->transfer_dma);
965 usb_free_urb(u->urb);
971 * release a substream
973 static void release_substream_urbs(struct snd_usb_substream *subs, int force)
977 /* stop urbs (to be sure) */
978 deactivate_urbs(subs, force, 1);
979 wait_clear_urbs(subs);
981 for (i = 0; i < MAX_URBS; i++)
982 release_urb_ctx(&subs->dataurb[i]);
983 for (i = 0; i < SYNC_URBS; i++)
984 release_urb_ctx(&subs->syncurb[i]);
985 usb_buffer_free(subs->dev, SYNC_URBS * 4,
986 subs->syncbuf, subs->sync_dma);
987 subs->syncbuf = NULL;
992 * initialize a substream for plaback/capture
994 static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
995 unsigned int rate, unsigned int frame_bits)
997 unsigned int maxsize, n, i;
998 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
999 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
1001 /* calculate the frequency in 16.16 format */
1002 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1003 subs->freqn = get_usb_full_speed_rate(rate);
1005 subs->freqn = get_usb_high_speed_rate(rate);
1006 subs->freqm = subs->freqn;
1007 /* calculate max. frequency */
1008 if (subs->maxpacksize) {
1009 /* whatever fits into a max. size packet */
1010 maxsize = subs->maxpacksize;
1011 subs->freqmax = (maxsize / (frame_bits >> 3))
1012 << (16 - subs->datainterval);
1014 /* no max. packet size: just take 25% higher than nominal */
1015 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1016 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1017 >> (16 - subs->datainterval);
1022 subs->curpacksize = subs->maxpacksize;
1024 subs->curpacksize = maxsize;
1026 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1027 packs_per_ms = 8 >> subs->datainterval;
1030 subs->packs_per_ms = packs_per_ms;
1033 urb_packs = nrpacks;
1034 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1035 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1038 urb_packs *= packs_per_ms;
1040 /* decide how many packets to be used */
1042 unsigned int minsize;
1043 /* determine how small a packet can be */
1044 minsize = (subs->freqn >> (16 - subs->datainterval))
1045 * (frame_bits >> 3);
1046 /* with sync from device, assume it can be 12% lower */
1048 minsize -= minsize >> 3;
1049 minsize = max(minsize, 1u);
1050 total_packs = (period_bytes + minsize - 1) / minsize;
1051 /* round up to multiple of packs_per_ms */
1052 total_packs = (total_packs + packs_per_ms - 1)
1053 & ~(packs_per_ms - 1);
1054 /* we need at least two URBs for queueing */
1055 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1056 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
1058 total_packs = MAX_URBS * urb_packs;
1060 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1061 if (subs->nurbs > MAX_URBS) {
1063 subs->nurbs = MAX_URBS;
1064 total_packs = MAX_URBS * urb_packs;
1067 for (i = 0; i < subs->nurbs; i++) {
1068 npacks[i] = n > urb_packs ? urb_packs : n;
1071 if (subs->nurbs <= 1) {
1072 /* too little - we need at least two packets
1073 * to ensure contiguous playback/capture
1076 npacks[0] = (total_packs + 1) / 2;
1077 npacks[1] = total_packs - npacks[0];
1078 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1079 /* the last packet is too small.. */
1080 if (subs->nurbs > 2) {
1081 /* merge to the first one */
1082 npacks[0] += npacks[subs->nurbs - 1];
1087 npacks[0] = (total_packs + 1) / 2;
1088 npacks[1] = total_packs - npacks[0];
1092 /* allocate and initialize data urbs */
1093 for (i = 0; i < subs->nurbs; i++) {
1094 struct snd_urb_ctx *u = &subs->dataurb[i];
1097 u->packets = npacks[i];
1098 u->buffer_size = maxsize * u->packets;
1099 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1100 u->packets++; /* for transfer delimiter */
1101 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1104 u->urb->transfer_buffer =
1105 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1106 &u->urb->transfer_dma);
1107 if (! u->urb->transfer_buffer)
1109 u->urb->pipe = subs->datapipe;
1110 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1111 u->urb->interval = 1 << subs->datainterval;
1112 u->urb->context = u;
1113 u->urb->complete = snd_complete_urb;
1116 if (subs->syncpipe) {
1117 /* allocate and initialize sync urbs */
1118 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1119 GFP_KERNEL, &subs->sync_dma);
1120 if (! subs->syncbuf)
1122 for (i = 0; i < SYNC_URBS; i++) {
1123 struct snd_urb_ctx *u = &subs->syncurb[i];
1127 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1130 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1131 u->urb->transfer_dma = subs->sync_dma + i * 4;
1132 u->urb->transfer_buffer_length = 4;
1133 u->urb->pipe = subs->syncpipe;
1134 u->urb->transfer_flags = URB_ISO_ASAP |
1135 URB_NO_TRANSFER_DMA_MAP;
1136 u->urb->number_of_packets = 1;
1137 u->urb->interval = 1 << subs->syncinterval;
1138 u->urb->context = u;
1139 u->urb->complete = snd_complete_sync_urb;
1145 release_substream_urbs(subs, 0);
1151 * find a matching audio format
1153 static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
1154 unsigned int rate, unsigned int channels)
1156 struct list_head *p;
1157 struct audioformat *found = NULL;
1158 int cur_attr = 0, attr;
1160 list_for_each(p, &subs->fmt_list) {
1161 struct audioformat *fp;
1162 fp = list_entry(p, struct audioformat, list);
1163 if (fp->format != format || fp->channels != channels)
1165 if (rate < fp->rate_min || rate > fp->rate_max)
1167 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1169 for (i = 0; i < fp->nr_rates; i++)
1170 if (fp->rate_table[i] == rate)
1172 if (i >= fp->nr_rates)
1175 attr = fp->ep_attr & EP_ATTR_MASK;
1181 /* avoid async out and adaptive in if the other method
1182 * supports the same format.
1183 * this is a workaround for the case like
1184 * M-audio audiophile USB.
1186 if (attr != cur_attr) {
1187 if ((attr == EP_ATTR_ASYNC &&
1188 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1189 (attr == EP_ATTR_ADAPTIVE &&
1190 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1192 if ((cur_attr == EP_ATTR_ASYNC &&
1193 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1194 (cur_attr == EP_ATTR_ADAPTIVE &&
1195 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1201 /* find the format with the largest max. packet size */
1202 if (fp->maxpacksize > found->maxpacksize) {
1212 * initialize the picth control and sample rate
1214 static int init_usb_pitch(struct usb_device *dev, int iface,
1215 struct usb_host_interface *alts,
1216 struct audioformat *fmt)
1219 unsigned char data[1];
1222 ep = get_endpoint(alts, 0)->bEndpointAddress;
1223 /* if endpoint has pitch control, enable it */
1224 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1226 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1227 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1228 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1229 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1230 dev->devnum, iface, ep);
1237 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1238 struct usb_host_interface *alts,
1239 struct audioformat *fmt, int rate)
1242 unsigned char data[3];
1245 ep = get_endpoint(alts, 0)->bEndpointAddress;
1246 /* if endpoint has sampling rate control, set it */
1247 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1250 data[1] = rate >> 8;
1251 data[2] = rate >> 16;
1252 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1253 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1254 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1255 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1256 dev->devnum, iface, fmt->altsetting, rate, ep);
1259 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1260 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1261 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1262 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1263 dev->devnum, iface, fmt->altsetting, ep);
1264 return 0; /* some devices don't support reading */
1266 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1267 if (crate != rate) {
1268 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1269 // runtime->rate = crate;
1276 * find a matching format and set up the interface
1278 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
1280 struct usb_device *dev = subs->dev;
1281 struct usb_host_interface *alts;
1282 struct usb_interface_descriptor *altsd;
1283 struct usb_interface *iface;
1284 unsigned int ep, attr;
1285 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1288 iface = usb_ifnum_to_if(dev, fmt->iface);
1289 snd_assert(iface, return -EINVAL);
1290 alts = &iface->altsetting[fmt->altset_idx];
1291 altsd = get_iface_desc(alts);
1292 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1294 if (fmt == subs->cur_audiofmt)
1297 /* close the old interface */
1298 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1299 usb_set_interface(subs->dev, subs->interface, 0);
1300 subs->interface = -1;
1305 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1306 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1307 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1308 dev->devnum, fmt->iface, fmt->altsetting);
1311 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1312 subs->interface = fmt->iface;
1313 subs->format = fmt->altset_idx;
1316 /* create a data pipe */
1317 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1319 subs->datapipe = usb_sndisocpipe(dev, ep);
1321 subs->datapipe = usb_rcvisocpipe(dev, ep);
1322 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1323 get_endpoint(alts, 0)->bInterval >= 1 &&
1324 get_endpoint(alts, 0)->bInterval <= 4)
1325 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1327 subs->datainterval = 0;
1328 subs->syncpipe = subs->syncinterval = 0;
1329 subs->maxpacksize = fmt->maxpacksize;
1332 /* we need a sync pipe in async OUT or adaptive IN mode */
1333 /* check the number of EP, since some devices have broken
1334 * descriptors which fool us. if it has only one EP,
1335 * assume it as adaptive-out or sync-in.
1337 attr = fmt->ep_attr & EP_ATTR_MASK;
1338 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1339 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1340 altsd->bNumEndpoints >= 2) {
1341 /* check sync-pipe endpoint */
1342 /* ... and check descriptor size before accessing bSynchAddress
1343 because there is a version of the SB Audigy 2 NX firmware lacking
1344 the audio fields in the endpoint descriptors */
1345 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1346 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1347 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1348 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1349 dev->devnum, fmt->iface, fmt->altsetting);
1352 ep = get_endpoint(alts, 1)->bEndpointAddress;
1353 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1354 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1355 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1356 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1357 dev->devnum, fmt->iface, fmt->altsetting);
1360 ep &= USB_ENDPOINT_NUMBER_MASK;
1362 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1364 subs->syncpipe = usb_sndisocpipe(dev, ep);
1365 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1366 get_endpoint(alts, 1)->bRefresh >= 1 &&
1367 get_endpoint(alts, 1)->bRefresh <= 9)
1368 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1369 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1370 subs->syncinterval = 1;
1371 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1372 get_endpoint(alts, 1)->bInterval <= 16)
1373 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1375 subs->syncinterval = 3;
1378 /* always fill max packet size */
1379 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1382 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1385 subs->cur_audiofmt = fmt;
1388 printk("setting done: format = %d, rate = %d, channels = %d\n",
1389 fmt->format, fmt->rate, fmt->channels);
1390 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1391 subs->datapipe, subs->syncpipe);
1398 * hw_params callback
1400 * allocate a buffer and set the given audio format.
1402 * so far we use a physically linear buffer although packetize transfer
1403 * doesn't need a continuous area.
1404 * if sg buffer is supported on the later version of alsa, we'll follow
1407 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1408 struct snd_pcm_hw_params *hw_params)
1410 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
1411 struct audioformat *fmt;
1412 unsigned int channels, rate, format;
1415 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1416 params_buffer_bytes(hw_params));
1420 format = params_format(hw_params);
1421 rate = params_rate(hw_params);
1422 channels = params_channels(hw_params);
1423 fmt = find_format(subs, format, rate, channels);
1425 snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1426 format, rate, channels);
1430 changed = subs->cur_audiofmt != fmt ||
1431 subs->period_bytes != params_period_bytes(hw_params) ||
1432 subs->cur_rate != rate;
1433 if ((ret = set_format(subs, fmt)) < 0)
1436 if (subs->cur_rate != rate) {
1437 struct usb_host_interface *alts;
1438 struct usb_interface *iface;
1439 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1440 alts = &iface->altsetting[fmt->altset_idx];
1441 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1444 subs->cur_rate = rate;
1448 /* format changed */
1449 release_substream_urbs(subs, 0);
1450 /* influenced: period_bytes, channels, rate, format, */
1451 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1452 params_rate(hw_params),
1453 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1462 * reset the audio format and release the buffer
1464 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
1466 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
1468 subs->cur_audiofmt = NULL;
1470 subs->period_bytes = 0;
1471 release_substream_urbs(subs, 0);
1472 return snd_pcm_free_vmalloc_buffer(substream);
1478 * only a few subtle things...
1480 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
1482 struct snd_pcm_runtime *runtime = substream->runtime;
1483 struct snd_usb_substream *subs = runtime->private_data;
1485 if (! subs->cur_audiofmt) {
1486 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1490 /* some unit conversions in runtime */
1491 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1492 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1494 /* reset the pointer */
1495 subs->hwptr_done = 0;
1496 subs->transfer_done = 0;
1499 /* clear urbs (to be sure) */
1500 deactivate_urbs(subs, 0, 1);
1501 wait_clear_urbs(subs);
1503 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1504 * updates for all URBs would happen at the same time when starting */
1505 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1506 subs->ops.prepare = prepare_startup_playback_urb;
1507 return start_urbs(subs, runtime);
1512 static struct snd_pcm_hardware snd_usb_playback =
1514 .info = SNDRV_PCM_INFO_MMAP |
1515 SNDRV_PCM_INFO_MMAP_VALID |
1516 SNDRV_PCM_INFO_BATCH |
1517 SNDRV_PCM_INFO_INTERLEAVED |
1518 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1519 .buffer_bytes_max = 1024 * 1024,
1520 .period_bytes_min = 64,
1521 .period_bytes_max = 512 * 1024,
1523 .periods_max = 1024,
1526 static struct snd_pcm_hardware snd_usb_capture =
1528 .info = SNDRV_PCM_INFO_MMAP |
1529 SNDRV_PCM_INFO_MMAP_VALID |
1530 SNDRV_PCM_INFO_BATCH |
1531 SNDRV_PCM_INFO_INTERLEAVED |
1532 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1533 .buffer_bytes_max = 1024 * 1024,
1534 .period_bytes_min = 64,
1535 .period_bytes_max = 512 * 1024,
1537 .periods_max = 1024,
1544 #ifdef HW_CONST_DEBUG
1545 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1547 #define hwc_debug(fmt, args...) /**/
1550 static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
1552 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1553 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1554 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1556 /* check the format */
1557 if (! snd_mask_test(fmts, fp->format)) {
1558 hwc_debug(" > check: no supported format %d\n", fp->format);
1561 /* check the channels */
1562 if (fp->channels < ct->min || fp->channels > ct->max) {
1563 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1566 /* check the rate is within the range */
1567 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1568 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1571 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1572 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1578 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1579 struct snd_pcm_hw_rule *rule)
1581 struct snd_usb_substream *subs = rule->private;
1582 struct list_head *p;
1583 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1584 unsigned int rmin, rmax;
1587 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1590 list_for_each(p, &subs->fmt_list) {
1591 struct audioformat *fp;
1592 fp = list_entry(p, struct audioformat, list);
1593 if (! hw_check_valid_format(params, fp))
1596 if (rmin > fp->rate_min)
1597 rmin = fp->rate_min;
1598 if (rmax < fp->rate_max)
1599 rmax = fp->rate_max;
1601 rmin = fp->rate_min;
1602 rmax = fp->rate_max;
1607 hwc_debug(" --> get empty\n");
1613 if (it->min < rmin) {
1618 if (it->max > rmax) {
1623 if (snd_interval_checkempty(it)) {
1627 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1632 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1633 struct snd_pcm_hw_rule *rule)
1635 struct snd_usb_substream *subs = rule->private;
1636 struct list_head *p;
1637 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1638 unsigned int rmin, rmax;
1641 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1644 list_for_each(p, &subs->fmt_list) {
1645 struct audioformat *fp;
1646 fp = list_entry(p, struct audioformat, list);
1647 if (! hw_check_valid_format(params, fp))
1650 if (rmin > fp->channels)
1651 rmin = fp->channels;
1652 if (rmax < fp->channels)
1653 rmax = fp->channels;
1655 rmin = fp->channels;
1656 rmax = fp->channels;
1661 hwc_debug(" --> get empty\n");
1667 if (it->min < rmin) {
1672 if (it->max > rmax) {
1677 if (snd_interval_checkempty(it)) {
1681 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1685 static int hw_rule_format(struct snd_pcm_hw_params *params,
1686 struct snd_pcm_hw_rule *rule)
1688 struct snd_usb_substream *subs = rule->private;
1689 struct list_head *p;
1690 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1695 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1697 list_for_each(p, &subs->fmt_list) {
1698 struct audioformat *fp;
1699 fp = list_entry(p, struct audioformat, list);
1700 if (! hw_check_valid_format(params, fp))
1702 fbits |= (1ULL << fp->format);
1705 oldbits[0] = fmt->bits[0];
1706 oldbits[1] = fmt->bits[1];
1707 fmt->bits[0] &= (u32)fbits;
1708 fmt->bits[1] &= (u32)(fbits >> 32);
1709 if (! fmt->bits[0] && ! fmt->bits[1]) {
1710 hwc_debug(" --> get empty\n");
1713 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1714 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1721 * check whether the registered audio formats need special hw-constraints
1723 static int check_hw_params_convention(struct snd_usb_substream *subs)
1728 u32 cmaster, rmaster;
1729 u32 rate_min = 0, rate_max = 0;
1730 struct list_head *p;
1733 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1734 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1736 list_for_each(p, &subs->fmt_list) {
1737 struct audioformat *f;
1738 f = list_entry(p, struct audioformat, list);
1739 /* unconventional channels? */
1740 if (f->channels > 32)
1742 /* continuous rate min/max matches? */
1743 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1744 if (rate_min && f->rate_min != rate_min)
1746 if (rate_max && f->rate_max != rate_max)
1748 rate_min = f->rate_min;
1749 rate_max = f->rate_max;
1751 /* combination of continuous rates and fixed rates? */
1752 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1753 if (f->rates != rates[f->format])
1756 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1757 if (rates[f->format] && rates[f->format] != f->rates)
1760 channels[f->format] |= (1 << f->channels);
1761 rates[f->format] |= f->rates;
1763 /* check whether channels and rates match for all formats */
1764 cmaster = rmaster = 0;
1765 for (i = 0; i < MAX_MASK; i++) {
1766 if (cmaster != channels[i] && cmaster && channels[i])
1768 if (rmaster != rates[i] && rmaster && rates[i])
1771 cmaster = channels[i];
1775 /* check whether channels match for all distinct rates */
1776 memset(channels, 0, MAX_MASK * sizeof(u32));
1777 list_for_each(p, &subs->fmt_list) {
1778 struct audioformat *f;
1779 f = list_entry(p, struct audioformat, list);
1780 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1782 for (i = 0; i < 32; i++) {
1783 if (f->rates & (1 << i))
1784 channels[i] |= (1 << f->channels);
1788 for (i = 0; i < 32; i++) {
1789 if (cmaster != channels[i] && cmaster && channels[i])
1792 cmaster = channels[i];
1804 * set up the runtime hardware information.
1807 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1809 struct list_head *p;
1812 runtime->hw.formats = subs->formats;
1814 runtime->hw.rate_min = 0x7fffffff;
1815 runtime->hw.rate_max = 0;
1816 runtime->hw.channels_min = 256;
1817 runtime->hw.channels_max = 0;
1818 runtime->hw.rates = 0;
1819 /* check min/max rates and channels */
1820 list_for_each(p, &subs->fmt_list) {
1821 struct audioformat *fp;
1822 fp = list_entry(p, struct audioformat, list);
1823 runtime->hw.rates |= fp->rates;
1824 if (runtime->hw.rate_min > fp->rate_min)
1825 runtime->hw.rate_min = fp->rate_min;
1826 if (runtime->hw.rate_max < fp->rate_max)
1827 runtime->hw.rate_max = fp->rate_max;
1828 if (runtime->hw.channels_min > fp->channels)
1829 runtime->hw.channels_min = fp->channels;
1830 if (runtime->hw.channels_max < fp->channels)
1831 runtime->hw.channels_max = fp->channels;
1832 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1833 /* FIXME: there might be more than one audio formats... */
1834 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1839 /* set the period time minimum 1ms */
1840 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1841 1000 * MIN_PACKS_URB,
1842 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1844 if (check_hw_params_convention(subs)) {
1845 hwc_debug("setting extra hw constraints...\n");
1846 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1848 SNDRV_PCM_HW_PARAM_FORMAT,
1849 SNDRV_PCM_HW_PARAM_CHANNELS,
1852 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1853 hw_rule_channels, subs,
1854 SNDRV_PCM_HW_PARAM_FORMAT,
1855 SNDRV_PCM_HW_PARAM_RATE,
1858 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1859 hw_rule_format, subs,
1860 SNDRV_PCM_HW_PARAM_RATE,
1861 SNDRV_PCM_HW_PARAM_CHANNELS,
1868 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction,
1869 struct snd_pcm_hardware *hw)
1871 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1872 struct snd_pcm_runtime *runtime = substream->runtime;
1873 struct snd_usb_substream *subs = &as->substream[direction];
1875 subs->interface = -1;
1878 runtime->private_data = subs;
1879 subs->pcm_substream = substream;
1880 return setup_hw_info(runtime, subs);
1883 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1885 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1886 struct snd_usb_substream *subs = &as->substream[direction];
1888 if (subs->interface >= 0) {
1889 usb_set_interface(subs->dev, subs->interface, 0);
1890 subs->interface = -1;
1892 subs->pcm_substream = NULL;
1896 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1898 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1901 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1903 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1906 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1908 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1911 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1913 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1916 static struct snd_pcm_ops snd_usb_playback_ops = {
1917 .open = snd_usb_playback_open,
1918 .close = snd_usb_playback_close,
1919 .ioctl = snd_pcm_lib_ioctl,
1920 .hw_params = snd_usb_hw_params,
1921 .hw_free = snd_usb_hw_free,
1922 .prepare = snd_usb_pcm_prepare,
1923 .trigger = snd_usb_pcm_playback_trigger,
1924 .pointer = snd_usb_pcm_pointer,
1925 .page = snd_pcm_get_vmalloc_page,
1928 static struct snd_pcm_ops snd_usb_capture_ops = {
1929 .open = snd_usb_capture_open,
1930 .close = snd_usb_capture_close,
1931 .ioctl = snd_pcm_lib_ioctl,
1932 .hw_params = snd_usb_hw_params,
1933 .hw_free = snd_usb_hw_free,
1934 .prepare = snd_usb_pcm_prepare,
1935 .trigger = snd_usb_pcm_capture_trigger,
1936 .pointer = snd_usb_pcm_pointer,
1937 .page = snd_pcm_get_vmalloc_page,
1947 * combine bytes and get an integer value
1949 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1952 case 1: return *bytes;
1953 case 2: return combine_word(bytes);
1954 case 3: return combine_triple(bytes);
1955 case 4: return combine_quad(bytes);
1961 * parse descriptor buffer and return the pointer starting the given
1964 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1976 if (p[1] == dtype && (!after || (void *)p > after)) {
1985 * find a class-specified interface descriptor with the given subtype.
1987 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1989 unsigned char *p = after;
1991 while ((p = snd_usb_find_desc(buffer, buflen, p,
1992 USB_DT_CS_INTERFACE)) != NULL) {
1993 if (p[0] >= 3 && p[2] == dsubtype)
2000 * Wrapper for usb_control_msg().
2001 * Allocates a temp buffer to prevent dmaing from/to the stack.
2003 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2004 __u8 requesttype, __u16 value, __u16 index, void *data,
2005 __u16 size, int timeout)
2011 buf = kmalloc(size, GFP_KERNEL);
2014 memcpy(buf, data, size);
2016 err = usb_control_msg(dev, pipe, request, requesttype,
2017 value, index, buf, size, timeout);
2019 memcpy(data, buf, size);
2027 * entry point for linux usb interface
2030 static int usb_audio_probe(struct usb_interface *intf,
2031 const struct usb_device_id *id);
2032 static void usb_audio_disconnect(struct usb_interface *intf);
2034 static struct usb_device_id usb_audio_ids [] = {
2035 #include "usbquirks.h"
2036 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2037 .bInterfaceClass = USB_CLASS_AUDIO,
2038 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2039 { } /* Terminating entry */
2042 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2044 static struct usb_driver usb_audio_driver = {
2045 .name = "snd-usb-audio",
2046 .probe = usb_audio_probe,
2047 .disconnect = usb_audio_disconnect,
2048 .id_table = usb_audio_ids,
2052 #if defined(CONFIG_PROCFS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2055 * proc interface for list the supported pcm formats
2057 static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2059 struct list_head *p;
2060 static char *sync_types[4] = {
2061 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2064 list_for_each(p, &subs->fmt_list) {
2065 struct audioformat *fp;
2066 fp = list_entry(p, struct audioformat, list);
2067 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2068 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
2069 snd_iprintf(buffer, " Format: 0x%x\n", fp->format);
2070 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2071 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2072 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2073 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2074 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2075 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2076 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2077 fp->rate_min, fp->rate_max);
2080 snd_iprintf(buffer, " Rates: ");
2081 for (i = 0; i < fp->nr_rates; i++) {
2083 snd_iprintf(buffer, ", ");
2084 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2086 snd_iprintf(buffer, "\n");
2088 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2089 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2093 static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2095 if (subs->running) {
2097 snd_iprintf(buffer, " Status: Running\n");
2098 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2099 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2100 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2101 for (i = 0; i < subs->nurbs; i++)
2102 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2103 snd_iprintf(buffer, "]\n");
2104 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2105 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2106 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2107 ? get_full_speed_hz(subs->freqm)
2108 : get_high_speed_hz(subs->freqm),
2109 subs->freqm >> 16, subs->freqm & 0xffff);
2111 snd_iprintf(buffer, " Status: Stop\n");
2115 static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
2117 struct snd_usb_stream *stream = entry->private_data;
2119 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2121 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2122 snd_iprintf(buffer, "\nPlayback:\n");
2123 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2124 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2126 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2127 snd_iprintf(buffer, "\nCapture:\n");
2128 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2129 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2133 static void proc_pcm_format_add(struct snd_usb_stream *stream)
2135 struct snd_info_entry *entry;
2137 struct snd_card *card = stream->chip->card;
2139 sprintf(name, "stream%d", stream->pcm_index);
2140 if (! snd_card_proc_new(card, name, &entry))
2141 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
2146 static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2153 * initialize the substream instance.
2156 static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
2158 struct snd_usb_substream *subs = &as->substream[stream];
2160 INIT_LIST_HEAD(&subs->fmt_list);
2161 spin_lock_init(&subs->lock);
2164 subs->direction = stream;
2165 subs->dev = as->chip->dev;
2166 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2167 subs->ops = audio_urb_ops[stream];
2169 subs->ops = audio_urb_ops_high_speed[stream];
2170 snd_pcm_set_ops(as->pcm, stream,
2171 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2172 &snd_usb_playback_ops : &snd_usb_capture_ops);
2174 list_add_tail(&fp->list, &subs->fmt_list);
2175 subs->formats |= 1ULL << fp->format;
2176 subs->endpoint = fp->endpoint;
2177 subs->num_formats++;
2178 subs->fmt_type = fp->fmt_type;
2185 static void free_substream(struct snd_usb_substream *subs)
2187 struct list_head *p, *n;
2189 if (! subs->num_formats)
2190 return; /* not initialized */
2191 list_for_each_safe(p, n, &subs->fmt_list) {
2192 struct audioformat *fp = list_entry(p, struct audioformat, list);
2193 kfree(fp->rate_table);
2200 * free a usb stream instance
2202 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
2204 free_substream(&stream->substream[0]);
2205 free_substream(&stream->substream[1]);
2206 list_del(&stream->list);
2210 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
2212 struct snd_usb_stream *stream = pcm->private_data;
2215 snd_usb_audio_stream_free(stream);
2221 * add this endpoint to the chip instance.
2222 * if a stream with the same endpoint already exists, append to it.
2223 * if not, create a new pcm stream.
2225 static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
2227 struct list_head *p;
2228 struct snd_usb_stream *as;
2229 struct snd_usb_substream *subs;
2230 struct snd_pcm *pcm;
2233 list_for_each(p, &chip->pcm_list) {
2234 as = list_entry(p, struct snd_usb_stream, list);
2235 if (as->fmt_type != fp->fmt_type)
2237 subs = &as->substream[stream];
2238 if (! subs->endpoint)
2240 if (subs->endpoint == fp->endpoint) {
2241 list_add_tail(&fp->list, &subs->fmt_list);
2242 subs->num_formats++;
2243 subs->formats |= 1ULL << fp->format;
2247 /* look for an empty stream */
2248 list_for_each(p, &chip->pcm_list) {
2249 as = list_entry(p, struct snd_usb_stream, list);
2250 if (as->fmt_type != fp->fmt_type)
2252 subs = &as->substream[stream];
2255 err = snd_pcm_new_stream(as->pcm, stream, 1);
2258 init_substream(as, stream, fp);
2262 /* create a new pcm */
2263 as = kmalloc(sizeof(*as), GFP_KERNEL);
2266 memset(as, 0, sizeof(*as));
2267 as->pcm_index = chip->pcm_devs;
2269 as->fmt_type = fp->fmt_type;
2270 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2271 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2272 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2279 pcm->private_data = as;
2280 pcm->private_free = snd_usb_audio_pcm_free;
2281 pcm->info_flags = 0;
2282 if (chip->pcm_devs > 0)
2283 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2285 strcpy(pcm->name, "USB Audio");
2287 init_substream(as, stream, fp);
2289 list_add(&as->list, &chip->pcm_list);
2292 proc_pcm_format_add(as);
2299 * check if the device uses big-endian samples
2301 static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
2303 switch (chip->usb_id) {
2304 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2305 if (fp->endpoint & USB_DIR_IN)
2308 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2315 * parse the audio format type I descriptor
2316 * and returns the corresponding pcm format
2319 * @fp: audioformat record
2320 * @format: the format tag (wFormatTag)
2321 * @fmt: the format type descriptor
2323 static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
2324 int format, unsigned char *fmt)
2327 int sample_width, sample_bytes;
2329 /* FIXME: correct endianess and sign? */
2331 sample_width = fmt[6];
2332 sample_bytes = fmt[5];
2334 case 0: /* some devices don't define this correctly... */
2335 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2336 chip->dev->devnum, fp->iface, fp->altsetting);
2338 case USB_AUDIO_FORMAT_PCM:
2339 if (sample_width > sample_bytes * 8) {
2340 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2341 chip->dev->devnum, fp->iface, fp->altsetting,
2342 sample_width, sample_bytes);
2344 /* check the format byte size */
2347 pcm_format = SNDRV_PCM_FORMAT_S8;
2350 if (is_big_endian_format(chip, fp))
2351 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2353 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2356 if (is_big_endian_format(chip, fp))
2357 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2359 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2362 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2365 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2366 chip->dev->devnum, fp->iface,
2367 fp->altsetting, sample_width, sample_bytes);
2371 case USB_AUDIO_FORMAT_PCM8:
2372 /* Dallas DS4201 workaround */
2373 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2374 pcm_format = SNDRV_PCM_FORMAT_S8;
2376 pcm_format = SNDRV_PCM_FORMAT_U8;
2378 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2379 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2381 case USB_AUDIO_FORMAT_ALAW:
2382 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2384 case USB_AUDIO_FORMAT_MU_LAW:
2385 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2388 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2389 chip->dev->devnum, fp->iface, fp->altsetting, format);
2397 * parse the format descriptor and stores the possible sample rates
2398 * on the audioformat table.
2401 * @fp: audioformat record
2402 * @fmt: the format descriptor
2403 * @offset: the start offset of descriptor pointing the rate type
2404 * (7 for type I and II, 8 for type II)
2406 static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
2407 unsigned char *fmt, int offset)
2409 int nr_rates = fmt[offset];
2410 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2411 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2412 chip->dev->devnum, fp->iface, fp->altsetting);
2418 * build the rate table and bitmap flags
2421 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2422 static unsigned int conv_rates[] = {
2423 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2424 64000, 88200, 96000, 176400, 192000
2426 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2427 if (fp->rate_table == NULL) {
2428 snd_printk(KERN_ERR "cannot malloc\n");
2432 fp->nr_rates = nr_rates;
2433 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2434 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2435 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2436 if (rate < fp->rate_min)
2437 fp->rate_min = rate;
2438 else if (rate > fp->rate_max)
2439 fp->rate_max = rate;
2440 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2441 if (rate == conv_rates[c]) {
2442 fp->rates |= (1 << c);
2448 /* continuous rates */
2449 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2450 fp->rate_min = combine_triple(&fmt[offset + 1]);
2451 fp->rate_max = combine_triple(&fmt[offset + 4]);
2457 * parse the format type I and III descriptors
2459 static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
2460 int format, unsigned char *fmt)
2464 if (fmt[3] == USB_FORMAT_TYPE_III) {
2465 /* FIXME: the format type is really IECxxx
2466 * but we give normal PCM format to get the existing
2469 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2471 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2475 fp->format = pcm_format;
2476 fp->channels = fmt[4];
2477 if (fp->channels < 1) {
2478 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2479 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2482 return parse_audio_format_rates(chip, fp, fmt, 7);
2486 * prase the format type II descriptor
2488 static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
2489 int format, unsigned char *fmt)
2491 int brate, framesize;
2493 case USB_AUDIO_FORMAT_AC3:
2494 /* FIXME: there is no AC3 format defined yet */
2495 // fp->format = SNDRV_PCM_FORMAT_AC3;
2496 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2498 case USB_AUDIO_FORMAT_MPEG:
2499 fp->format = SNDRV_PCM_FORMAT_MPEG;
2502 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2503 chip->dev->devnum, fp->iface, fp->altsetting, format);
2504 fp->format = SNDRV_PCM_FORMAT_MPEG;
2508 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2509 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2510 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2511 fp->frame_size = framesize;
2512 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2515 static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
2516 int format, unsigned char *fmt, int stream)
2521 case USB_FORMAT_TYPE_I:
2522 case USB_FORMAT_TYPE_III:
2523 err = parse_audio_format_i(chip, fp, format, fmt);
2525 case USB_FORMAT_TYPE_II:
2526 err = parse_audio_format_ii(chip, fp, format, fmt);
2529 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2530 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2533 fp->fmt_type = fmt[3];
2537 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2538 /* extigy apparently supports sample rates other than 48k
2539 * but not in ordinary way. so we enable only 48k atm.
2541 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2542 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2543 chip->usb_id == USB_ID(0x041e, 0x3061)) {
2544 if (fmt[3] == USB_FORMAT_TYPE_I &&
2545 fp->rates != SNDRV_PCM_RATE_48000 &&
2546 fp->rates != SNDRV_PCM_RATE_96000)
2553 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2554 int iface, int altno);
2555 static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
2557 struct usb_device *dev;
2558 struct usb_interface *iface;
2559 struct usb_host_interface *alts;
2560 struct usb_interface_descriptor *altsd;
2561 int i, altno, err, stream;
2563 struct audioformat *fp;
2564 unsigned char *fmt, *csep;
2568 /* parse the interface's altsettings */
2569 iface = usb_ifnum_to_if(dev, iface_no);
2570 for (i = 0; i < iface->num_altsetting; i++) {
2571 alts = &iface->altsetting[i];
2572 altsd = get_iface_desc(alts);
2573 /* skip invalid one */
2574 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2575 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2576 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2577 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2578 altsd->bNumEndpoints < 1 ||
2579 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2581 /* must be isochronous */
2582 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2583 USB_ENDPOINT_XFER_ISOC)
2585 /* check direction */
2586 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2587 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2588 altno = altsd->bAlternateSetting;
2590 /* audiophile usb: skip altsets incompatible with device_setup
2592 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2593 audiophile_skip_setting_quirk(chip, iface_no, altno))
2596 /* get audio formats */
2597 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2599 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2600 dev->devnum, iface_no, altno);
2605 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2606 dev->devnum, iface_no, altno);
2610 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2612 /* get format type */
2613 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2615 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2616 dev->devnum, iface_no, altno);
2620 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2621 dev->devnum, iface_no, altno);
2625 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2626 /* Creamware Noah has this descriptor after the 2nd endpoint */
2627 if (!csep && altsd->bNumEndpoints >= 2)
2628 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2629 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2630 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
2631 " class specific endpoint descriptor\n",
2632 dev->devnum, iface_no, altno);
2636 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2638 snd_printk(KERN_ERR "cannot malloc\n");
2642 memset(fp, 0, sizeof(*fp));
2643 fp->iface = iface_no;
2644 fp->altsetting = altno;
2646 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2647 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2648 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2649 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2650 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2651 * (fp->maxpacksize & 0x7ff);
2652 fp->attributes = csep ? csep[3] : 0;
2654 /* some quirks for attributes here */
2656 switch (chip->usb_id) {
2657 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2658 /* Optoplay sets the sample rate attribute although
2659 * it seems not supporting it in fact.
2661 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2663 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2664 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2665 /* doesn't set the sample rate attribute, but supports it */
2666 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2668 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2669 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2670 an older model 77d:223) */
2672 * plantronics headset and Griffin iMic have set adaptive-in
2673 * although it's really not...
2675 fp->ep_attr &= ~EP_ATTR_MASK;
2676 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2677 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2679 fp->ep_attr |= EP_ATTR_SYNC;
2683 /* ok, let's parse further... */
2684 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2685 kfree(fp->rate_table);
2690 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, altno, fp->endpoint);
2691 err = add_audio_endpoint(chip, stream, fp);
2693 kfree(fp->rate_table);
2697 /* try to set the interface... */
2698 usb_set_interface(chip->dev, iface_no, altno);
2699 init_usb_pitch(chip->dev, iface_no, alts, fp);
2700 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2707 * disconnect streams
2708 * called from snd_usb_audio_disconnect()
2710 static void snd_usb_stream_disconnect(struct list_head *head)
2713 struct snd_usb_stream *as;
2714 struct snd_usb_substream *subs;
2716 as = list_entry(head, struct snd_usb_stream, list);
2717 for (idx = 0; idx < 2; idx++) {
2718 subs = &as->substream[idx];
2719 if (!subs->num_formats)
2721 release_substream_urbs(subs, 1);
2722 subs->interface = -1;
2727 * parse audio control descriptor and create pcm/midi streams
2729 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
2731 struct usb_device *dev = chip->dev;
2732 struct usb_host_interface *host_iface;
2733 struct usb_interface *iface;
2737 /* find audiocontrol interface */
2738 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2739 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2740 snd_printk(KERN_ERR "cannot find HEADER\n");
2743 if (! p1[7] || p1[0] < 8 + p1[7]) {
2744 snd_printk(KERN_ERR "invalid HEADER\n");
2749 * parse all USB audio streaming interfaces
2751 for (i = 0; i < p1[7]; i++) {
2752 struct usb_host_interface *alts;
2753 struct usb_interface_descriptor *altsd;
2755 iface = usb_ifnum_to_if(dev, j);
2757 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2758 dev->devnum, ctrlif, j);
2761 if (usb_interface_claimed(iface)) {
2762 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2765 alts = &iface->altsetting[0];
2766 altsd = get_iface_desc(alts);
2767 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2768 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2769 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2770 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2771 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2774 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2777 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2778 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2779 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2780 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2781 /* skip non-supported classes */
2784 if (! parse_audio_endpoints(chip, j)) {
2785 usb_set_interface(dev, j, 0); /* reset the current interface */
2786 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2794 * create a stream for an endpoint/altsetting without proper descriptors
2796 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
2797 struct usb_interface *iface,
2798 const struct snd_usb_audio_quirk *quirk)
2800 struct audioformat *fp;
2801 struct usb_host_interface *alts;
2803 int *rate_table = NULL;
2805 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2807 snd_printk(KERN_ERR "cannot malloc\n");
2810 memcpy(fp, quirk->data, sizeof(*fp));
2811 if (fp->nr_rates > 0) {
2812 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2817 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2818 fp->rate_table = rate_table;
2821 stream = (fp->endpoint & USB_DIR_IN)
2822 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2823 err = add_audio_endpoint(chip, stream, fp);
2829 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2830 fp->altset_idx >= iface->num_altsetting) {
2835 alts = &iface->altsetting[fp->altset_idx];
2836 usb_set_interface(chip->dev, fp->iface, 0);
2837 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2838 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2843 * create a stream for an interface with proper descriptors
2845 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
2846 struct usb_interface *iface,
2847 const struct snd_usb_audio_quirk *quirk)
2849 struct usb_host_interface *alts;
2850 struct usb_interface_descriptor *altsd;
2853 alts = &iface->altsetting[0];
2854 altsd = get_iface_desc(alts);
2855 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2857 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2858 altsd->bInterfaceNumber, err);
2861 /* reset the current interface */
2862 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2867 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2868 * to detect the sample rate is by looking at wMaxPacketSize.
2870 static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
2871 struct usb_interface *iface,
2872 const struct snd_usb_audio_quirk *quirk)
2874 static const struct audioformat ua_format = {
2875 .format = SNDRV_PCM_FORMAT_S24_3LE,
2877 .fmt_type = USB_FORMAT_TYPE_I,
2880 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2882 struct usb_host_interface *alts;
2883 struct usb_interface_descriptor *altsd;
2884 struct audioformat *fp;
2887 /* both PCM and MIDI interfaces have 2 altsettings */
2888 if (iface->num_altsetting != 2)
2890 alts = &iface->altsetting[1];
2891 altsd = get_iface_desc(alts);
2893 if (altsd->bNumEndpoints == 2) {
2894 static const struct snd_usb_midi_endpoint_info ua700_ep = {
2895 .out_cables = 0x0003,
2898 static const struct snd_usb_audio_quirk ua700_quirk = {
2899 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2902 static const struct snd_usb_midi_endpoint_info ua25_ep = {
2903 .out_cables = 0x0001,
2906 static const struct snd_usb_audio_quirk ua25_quirk = {
2907 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2910 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2911 return snd_usb_create_midi_interface(chip, iface,
2914 return snd_usb_create_midi_interface(chip, iface,
2918 if (altsd->bNumEndpoints != 1)
2921 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2924 memcpy(fp, &ua_format, sizeof(*fp));
2926 fp->iface = altsd->bInterfaceNumber;
2927 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2928 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2929 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2931 switch (fp->maxpacksize) {
2933 fp->rate_max = fp->rate_min = 44100;
2937 fp->rate_max = fp->rate_min = 48000;
2941 fp->rate_max = fp->rate_min = 96000;
2944 snd_printk(KERN_ERR "unknown sample rate\n");
2949 stream = (fp->endpoint & USB_DIR_IN)
2950 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2951 err = add_audio_endpoint(chip, stream, fp);
2956 usb_set_interface(chip->dev, fp->iface, 0);
2961 * Create a stream for an Edirol UA-1000 interface.
2963 static int create_ua1000_quirk(struct snd_usb_audio *chip,
2964 struct usb_interface *iface,
2965 const struct snd_usb_audio_quirk *quirk)
2967 static const struct audioformat ua1000_format = {
2968 .format = SNDRV_PCM_FORMAT_S32_LE,
2969 .fmt_type = USB_FORMAT_TYPE_I,
2973 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2975 struct usb_host_interface *alts;
2976 struct usb_interface_descriptor *altsd;
2977 struct audioformat *fp;
2980 if (iface->num_altsetting != 2)
2982 alts = &iface->altsetting[1];
2983 altsd = get_iface_desc(alts);
2984 if (alts->extralen != 11 || alts->extra[1] != CS_AUDIO_INTERFACE ||
2985 altsd->bNumEndpoints != 1)
2988 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2991 memcpy(fp, &ua1000_format, sizeof(*fp));
2993 fp->channels = alts->extra[4];
2994 fp->iface = altsd->bInterfaceNumber;
2995 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2996 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2997 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2998 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
3000 stream = (fp->endpoint & USB_DIR_IN)
3001 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3002 err = add_audio_endpoint(chip, stream, fp);
3007 /* FIXME: playback must be synchronized to capture */
3008 usb_set_interface(chip->dev, fp->iface, 0);
3012 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3013 struct usb_interface *iface,
3014 const struct snd_usb_audio_quirk *quirk);
3017 * handle the quirks for the contained interfaces
3019 static int create_composite_quirk(struct snd_usb_audio *chip,
3020 struct usb_interface *iface,
3021 const struct snd_usb_audio_quirk *quirk)
3023 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3026 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3027 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3030 if (quirk->ifnum != probed_ifnum &&
3031 usb_interface_claimed(iface))
3033 err = snd_usb_create_quirk(chip, iface, quirk);
3036 if (quirk->ifnum != probed_ifnum)
3037 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3042 static int ignore_interface_quirk(struct snd_usb_audio *chip,
3043 struct usb_interface *iface,
3044 const struct snd_usb_audio_quirk *quirk)
3054 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3055 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3057 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3059 struct usb_host_config *config = dev->actconfig;
3062 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3063 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3064 snd_printdd("sending Extigy boot sequence...\n");
3065 /* Send message to force it to reconnect with full interface. */
3066 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3067 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3068 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3069 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3070 &dev->descriptor, sizeof(dev->descriptor));
3071 config = dev->actconfig;
3072 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3073 err = usb_reset_configuration(dev);
3074 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3075 snd_printdd("extigy_boot: new boot length = %d\n",
3076 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3077 return -ENODEV; /* quit this anyway */
3082 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3086 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3087 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3088 0, 0, &buf, 1, 1000);
3090 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3091 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3092 1, 2000, NULL, 0, 1000);
3101 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3102 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3103 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3104 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3105 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3106 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3107 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3108 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3109 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3110 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3112 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3113 int iface, int altno)
3115 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3116 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3118 return 1; /* skip this altsetting */
3119 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3121 return 1; /* skip this altsetting */
3122 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3123 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3124 return 1; /* skip this altsetting */
3125 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3126 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3127 return 1; /* skip this altsetting */
3128 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3129 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3130 return 1; /* skip this altsetting */
3131 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3132 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3133 return 1; /* skip this altsetting */
3135 return 0; /* keep this altsetting */
3139 * audio-interface quirks
3141 * returns zero if no standard audio/MIDI parsing is needed.
3142 * returns a postive value if standard audio/midi interfaces are parsed
3144 * returns a negative value at error.
3146 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3147 struct usb_interface *iface,
3148 const struct snd_usb_audio_quirk *quirk)
3150 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3151 const struct snd_usb_audio_quirk *);
3152 static const quirk_func_t quirk_funcs[] = {
3153 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3154 [QUIRK_COMPOSITE] = create_composite_quirk,
3155 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3156 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3157 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3158 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3159 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3160 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3161 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3162 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
3163 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3164 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3165 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3166 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3169 if (quirk->type < QUIRK_TYPE_COUNT) {
3170 return quirk_funcs[quirk->type](chip, iface, quirk);
3172 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3179 * common proc files to show the usb device info
3181 static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3183 struct snd_usb_audio *chip = entry->private_data;
3184 if (! chip->shutdown)
3185 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3188 static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3190 struct snd_usb_audio *chip = entry->private_data;
3191 if (! chip->shutdown)
3192 snd_iprintf(buffer, "%04x:%04x\n",
3193 USB_ID_VENDOR(chip->usb_id),
3194 USB_ID_PRODUCT(chip->usb_id));
3197 static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
3199 struct snd_info_entry *entry;
3200 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3201 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
3202 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3203 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
3207 * free the chip instance
3209 * here we have to do not much, since pcm and controls are already freed
3213 static int snd_usb_audio_free(struct snd_usb_audio *chip)
3219 static int snd_usb_audio_dev_free(struct snd_device *device)
3221 struct snd_usb_audio *chip = device->device_data;
3222 return snd_usb_audio_free(chip);
3227 * create a chip instance and set its names.
3229 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3230 const struct snd_usb_audio_quirk *quirk,
3231 struct snd_usb_audio **rchip)
3233 struct snd_card *card;
3234 struct snd_usb_audio *chip;
3237 static struct snd_device_ops ops = {
3238 .dev_free = snd_usb_audio_dev_free,
3243 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3244 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3245 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3249 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3251 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3255 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3257 snd_card_free(card);
3264 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3265 le16_to_cpu(dev->descriptor.idProduct));
3266 INIT_LIST_HEAD(&chip->pcm_list);
3267 INIT_LIST_HEAD(&chip->midi_list);
3268 INIT_LIST_HEAD(&chip->mixer_list);
3270 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3271 snd_usb_audio_free(chip);
3272 snd_card_free(card);
3276 strcpy(card->driver, "USB-Audio");
3277 sprintf(component, "USB%04x:%04x",
3278 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3279 snd_component_add(card, component);
3281 /* retrieve the device string as shortname */
3282 if (quirk && quirk->product_name) {
3283 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3285 if (!dev->descriptor.iProduct ||
3286 usb_string(dev, dev->descriptor.iProduct,
3287 card->shortname, sizeof(card->shortname)) <= 0) {
3288 /* no name available from anywhere, so use ID */
3289 sprintf(card->shortname, "USB Device %#04x:%#04x",
3290 USB_ID_VENDOR(chip->usb_id),
3291 USB_ID_PRODUCT(chip->usb_id));
3295 /* retrieve the vendor and device strings as longname */
3296 if (quirk && quirk->vendor_name) {
3297 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3299 if (dev->descriptor.iManufacturer)
3300 len = usb_string(dev, dev->descriptor.iManufacturer,
3301 card->longname, sizeof(card->longname));
3304 /* we don't really care if there isn't any vendor string */
3307 strlcat(card->longname, " ", sizeof(card->longname));
3309 strlcat(card->longname, card->shortname, sizeof(card->longname));
3311 len = strlcat(card->longname, " at ", sizeof(card->longname));
3313 if (len < sizeof(card->longname))
3314 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3316 strlcat(card->longname,
3317 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3318 sizeof(card->longname));
3320 snd_usb_audio_create_proc(chip);
3328 * probe the active usb device
3330 * note that this can be called multiple times per a device, when it
3331 * includes multiple audio control interfaces.
3333 * thus we check the usb device pointer and creates the card instance
3334 * only at the first time. the successive calls of this function will
3335 * append the pcm interface to the corresponding card.
3337 static void *snd_usb_audio_probe(struct usb_device *dev,
3338 struct usb_interface *intf,
3339 const struct usb_device_id *usb_id)
3341 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
3343 struct snd_usb_audio *chip;
3344 struct usb_host_interface *alts;
3348 alts = &intf->altsetting[0];
3349 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3350 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3351 le16_to_cpu(dev->descriptor.idProduct));
3353 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3356 /* SB Extigy needs special boot-up sequence */
3357 /* if more models come, this will go to the quirk list. */
3358 if (id == USB_ID(0x041e, 0x3000)) {
3359 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3362 /* SB Audigy 2 NX needs its own boot-up magic, too */
3363 if (id == USB_ID(0x041e, 0x3020)) {
3364 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3369 * found a config. now register to ALSA
3372 /* check whether it's already registered */
3374 mutex_lock(®ister_mutex);
3375 for (i = 0; i < SNDRV_CARDS; i++) {
3376 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3377 if (usb_chip[i]->shutdown) {
3378 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3386 /* it's a fresh one.
3387 * now look for an empty slot and create a new card instance
3389 for (i = 0; i < SNDRV_CARDS; i++)
3390 if (enable[i] && ! usb_chip[i] &&
3391 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3392 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3393 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3396 snd_card_set_dev(chip->card, &intf->dev);
3400 snd_printk(KERN_ERR "no available usb audio device\n");
3405 err = 1; /* continue */
3406 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3407 /* need some special handlings */
3408 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3413 /* create normal USB audio interfaces */
3414 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3415 snd_usb_create_mixer(chip, ifnum) < 0) {
3420 /* we are allowed to call snd_card_register() many times */
3421 if (snd_card_register(chip->card) < 0) {
3425 usb_chip[chip->index] = chip;
3426 chip->num_interfaces++;
3427 mutex_unlock(®ister_mutex);
3431 if (chip && !chip->num_interfaces)
3432 snd_card_free(chip->card);
3433 mutex_unlock(®ister_mutex);
3439 * we need to take care of counter, since disconnection can be called also
3440 * many times as well as usb_audio_probe().
3442 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3444 struct snd_usb_audio *chip;
3445 struct snd_card *card;
3446 struct list_head *p;
3448 if (ptr == (void *)-1L)
3453 mutex_lock(®ister_mutex);
3455 chip->num_interfaces--;
3456 if (chip->num_interfaces <= 0) {
3457 snd_card_disconnect(card);
3458 /* release the pcm resources */
3459 list_for_each(p, &chip->pcm_list) {
3460 snd_usb_stream_disconnect(p);
3462 /* release the midi resources */
3463 list_for_each(p, &chip->midi_list) {
3464 snd_usbmidi_disconnect(p);
3466 /* release mixer resources */
3467 list_for_each(p, &chip->mixer_list) {
3468 snd_usb_mixer_disconnect(p);
3470 usb_chip[chip->index] = NULL;
3471 mutex_unlock(®ister_mutex);
3472 snd_card_free(card);
3474 mutex_unlock(®ister_mutex);
3479 * new 2.5 USB kernel API
3481 static int usb_audio_probe(struct usb_interface *intf,
3482 const struct usb_device_id *id)
3485 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3487 dev_set_drvdata(&intf->dev, chip);
3493 static void usb_audio_disconnect(struct usb_interface *intf)
3495 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3496 dev_get_drvdata(&intf->dev));
3500 static int __init snd_usb_audio_init(void)
3502 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3503 printk(KERN_WARNING "invalid nrpacks value.\n");
3506 usb_register(&usb_audio_driver);
3511 static void __exit snd_usb_audio_cleanup(void)
3513 usb_deregister(&usb_audio_driver);
3516 module_init(snd_usb_audio_init);
3517 module_exit(snd_usb_audio_cleanup);