Revert "[PATCH] paravirt: Add startup infrastructure for paravirtualization"
[pv_ops_mirror.git] / sound / usb / usbaudio.c
blobb6d886373bb001b46da476a0cb1a2f3c6d44db19
1 /*
2 * (Tentative) USB Audio Driver for ALSA
4 * Main and PCM part
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
28 * NOTES:
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>
57 #include "usbaudio.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 = 8; /* 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 */
103 #define MAX_PACKS 20
104 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
105 #define MAX_URBS 8
106 #define SYNC_URBS 4 /* always four urbs for sync */
107 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
109 struct audioformat {
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 */
126 unsigned int needs_knot; /* any unusual rates? */
129 struct snd_usb_substream;
131 struct snd_urb_ctx {
132 struct urb *urb;
133 unsigned int buffer_size; /* size of data buffer, if data URB */
134 struct snd_usb_substream *subs;
135 int index; /* index for urb array */
136 int packets; /* number of packets per urb */
139 struct snd_urb_ops {
140 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
142 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
143 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
146 struct snd_usb_substream {
147 struct snd_usb_stream *stream;
148 struct usb_device *dev;
149 struct snd_pcm_substream *pcm_substream;
150 int direction; /* playback or capture */
151 int interface; /* current interface */
152 int endpoint; /* assigned endpoint */
153 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
154 unsigned int cur_rate; /* current rate (for hw_params callback) */
155 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
156 unsigned int format; /* USB data format */
157 unsigned int datapipe; /* the data i/o pipe */
158 unsigned int syncpipe; /* 1 - async out or adaptive in */
159 unsigned int datainterval; /* log_2 of data packet interval */
160 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
161 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
162 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
163 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
164 unsigned int phase; /* phase accumulator */
165 unsigned int maxpacksize; /* max packet size in bytes */
166 unsigned int maxframesize; /* max packet size in frames */
167 unsigned int curpacksize; /* current packet size in bytes (for capture) */
168 unsigned int curframesize; /* current packet size in frames (for capture) */
169 unsigned int fill_max: 1; /* fill max packet size always */
170 unsigned int fmt_type; /* USB audio format type (1-3) */
171 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
173 unsigned int running: 1; /* running status */
175 unsigned int hwptr_done; /* processed frame position in the buffer */
176 unsigned int transfer_done; /* processed frames since last period update */
177 unsigned long active_mask; /* bitmask of active urbs */
178 unsigned long unlink_mask; /* bitmask of unlinked urbs */
180 unsigned int nurbs; /* # urbs */
181 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
182 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
183 char *syncbuf; /* sync buffer for all sync URBs */
184 dma_addr_t sync_dma; /* DMA address of syncbuf */
186 u64 formats; /* format bitmasks (all or'ed) */
187 unsigned int num_formats; /* number of supported audio formats (list) */
188 struct list_head fmt_list; /* format list */
189 struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
190 spinlock_t lock;
192 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
196 struct snd_usb_stream {
197 struct snd_usb_audio *chip;
198 struct snd_pcm *pcm;
199 int pcm_index;
200 unsigned int fmt_type; /* USB audio format type (1-3) */
201 struct snd_usb_substream substream[2];
202 struct list_head list;
207 * we keep the snd_usb_audio_t instances by ourselves for merging
208 * the all interfaces on the same card as one sound device.
211 static DEFINE_MUTEX(register_mutex);
212 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
216 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
217 * this will overflow at approx 524 kHz
219 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
221 return ((rate << 13) + 62) / 125;
225 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
226 * this will overflow at approx 4 MHz
228 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
230 return ((rate << 10) + 62) / 125;
233 /* convert our full speed USB rate into sampling rate in Hz */
234 static inline unsigned get_full_speed_hz(unsigned int usb_rate)
236 return (usb_rate * 125 + (1 << 12)) >> 13;
239 /* convert our high speed USB rate into sampling rate in Hz */
240 static inline unsigned get_high_speed_hz(unsigned int usb_rate)
242 return (usb_rate * 125 + (1 << 9)) >> 10;
247 * prepare urb for full speed capture sync pipe
249 * fill the length and offset of each urb descriptor.
250 * the fixed 10.14 frequency is passed through the pipe.
252 static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
253 struct snd_pcm_runtime *runtime,
254 struct urb *urb)
256 unsigned char *cp = urb->transfer_buffer;
257 struct snd_urb_ctx *ctx = urb->context;
259 urb->dev = ctx->subs->dev; /* we need to set this at each time */
260 urb->iso_frame_desc[0].length = 3;
261 urb->iso_frame_desc[0].offset = 0;
262 cp[0] = subs->freqn >> 2;
263 cp[1] = subs->freqn >> 10;
264 cp[2] = subs->freqn >> 18;
265 return 0;
269 * prepare urb for high speed capture sync pipe
271 * fill the length and offset of each urb descriptor.
272 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
274 static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
275 struct snd_pcm_runtime *runtime,
276 struct urb *urb)
278 unsigned char *cp = urb->transfer_buffer;
279 struct snd_urb_ctx *ctx = urb->context;
281 urb->dev = ctx->subs->dev; /* we need to set this at each time */
282 urb->iso_frame_desc[0].length = 4;
283 urb->iso_frame_desc[0].offset = 0;
284 cp[0] = subs->freqn;
285 cp[1] = subs->freqn >> 8;
286 cp[2] = subs->freqn >> 16;
287 cp[3] = subs->freqn >> 24;
288 return 0;
292 * process after capture sync complete
293 * - nothing to do
295 static int retire_capture_sync_urb(struct snd_usb_substream *subs,
296 struct snd_pcm_runtime *runtime,
297 struct urb *urb)
299 return 0;
303 * prepare urb for capture data pipe
305 * fill the offset and length of each descriptor.
307 * we use a temporary buffer to write the captured data.
308 * since the length of written data is determined by host, we cannot
309 * write onto the pcm buffer directly... the data is thus copied
310 * later at complete callback to the global buffer.
312 static int prepare_capture_urb(struct snd_usb_substream *subs,
313 struct snd_pcm_runtime *runtime,
314 struct urb *urb)
316 int i, offs;
317 struct snd_urb_ctx *ctx = urb->context;
319 offs = 0;
320 urb->dev = ctx->subs->dev; /* we need to set this at each time */
321 for (i = 0; i < ctx->packets; i++) {
322 urb->iso_frame_desc[i].offset = offs;
323 urb->iso_frame_desc[i].length = subs->curpacksize;
324 offs += subs->curpacksize;
326 urb->transfer_buffer_length = offs;
327 urb->number_of_packets = ctx->packets;
328 return 0;
332 * process after capture complete
334 * copy the data from each desctiptor to the pcm buffer, and
335 * update the current position.
337 static int retire_capture_urb(struct snd_usb_substream *subs,
338 struct snd_pcm_runtime *runtime,
339 struct urb *urb)
341 unsigned long flags;
342 unsigned char *cp;
343 int i;
344 unsigned int stride, len, oldptr;
345 int period_elapsed = 0;
347 stride = runtime->frame_bits >> 3;
349 for (i = 0; i < urb->number_of_packets; i++) {
350 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
351 if (urb->iso_frame_desc[i].status) {
352 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
353 // continue;
355 len = urb->iso_frame_desc[i].actual_length / stride;
356 if (! len)
357 continue;
358 /* update the current pointer */
359 spin_lock_irqsave(&subs->lock, flags);
360 oldptr = subs->hwptr_done;
361 subs->hwptr_done += len;
362 if (subs->hwptr_done >= runtime->buffer_size)
363 subs->hwptr_done -= runtime->buffer_size;
364 subs->transfer_done += len;
365 if (subs->transfer_done >= runtime->period_size) {
366 subs->transfer_done -= runtime->period_size;
367 period_elapsed = 1;
369 spin_unlock_irqrestore(&subs->lock, flags);
370 /* copy a data chunk */
371 if (oldptr + len > runtime->buffer_size) {
372 unsigned int cnt = runtime->buffer_size - oldptr;
373 unsigned int blen = cnt * stride;
374 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
375 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
376 } else {
377 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
380 if (period_elapsed)
381 snd_pcm_period_elapsed(subs->pcm_substream);
382 return 0;
386 * Process after capture complete when paused. Nothing to do.
388 static int retire_paused_capture_urb(struct snd_usb_substream *subs,
389 struct snd_pcm_runtime *runtime,
390 struct urb *urb)
392 return 0;
397 * prepare urb for full speed playback sync pipe
399 * set up the offset and length to receive the current frequency.
402 static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
403 struct snd_pcm_runtime *runtime,
404 struct urb *urb)
406 struct snd_urb_ctx *ctx = urb->context;
408 urb->dev = ctx->subs->dev; /* we need to set this at each time */
409 urb->iso_frame_desc[0].length = 3;
410 urb->iso_frame_desc[0].offset = 0;
411 return 0;
415 * prepare urb for high speed playback sync pipe
417 * set up the offset and length to receive the current frequency.
420 static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
421 struct snd_pcm_runtime *runtime,
422 struct urb *urb)
424 struct snd_urb_ctx *ctx = urb->context;
426 urb->dev = ctx->subs->dev; /* we need to set this at each time */
427 urb->iso_frame_desc[0].length = 4;
428 urb->iso_frame_desc[0].offset = 0;
429 return 0;
433 * process after full speed playback sync complete
435 * retrieve the current 10.14 frequency from pipe, and set it.
436 * the value is referred in prepare_playback_urb().
438 static int retire_playback_sync_urb(struct snd_usb_substream *subs,
439 struct snd_pcm_runtime *runtime,
440 struct urb *urb)
442 unsigned int f;
443 unsigned long flags;
445 if (urb->iso_frame_desc[0].status == 0 &&
446 urb->iso_frame_desc[0].actual_length == 3) {
447 f = combine_triple((u8*)urb->transfer_buffer) << 2;
448 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
449 spin_lock_irqsave(&subs->lock, flags);
450 subs->freqm = f;
451 spin_unlock_irqrestore(&subs->lock, flags);
455 return 0;
459 * process after high speed playback sync complete
461 * retrieve the current 12.13 frequency from pipe, and set it.
462 * the value is referred in prepare_playback_urb().
464 static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
465 struct snd_pcm_runtime *runtime,
466 struct urb *urb)
468 unsigned int f;
469 unsigned long flags;
471 if (urb->iso_frame_desc[0].status == 0 &&
472 urb->iso_frame_desc[0].actual_length == 4) {
473 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
474 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
475 spin_lock_irqsave(&subs->lock, flags);
476 subs->freqm = f;
477 spin_unlock_irqrestore(&subs->lock, flags);
481 return 0;
484 /* determine the number of frames in the next packet */
485 static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
487 if (subs->fill_max)
488 return subs->maxframesize;
489 else {
490 subs->phase = (subs->phase & 0xffff)
491 + (subs->freqm << subs->datainterval);
492 return min(subs->phase >> 16, subs->maxframesize);
497 * Prepare urb for streaming before playback starts or when paused.
499 * We don't have any data, so we send a frame of silence.
501 static int prepare_nodata_playback_urb(struct snd_usb_substream *subs,
502 struct snd_pcm_runtime *runtime,
503 struct urb *urb)
505 unsigned int i, offs, counts;
506 struct snd_urb_ctx *ctx = urb->context;
507 int stride = runtime->frame_bits >> 3;
509 offs = 0;
510 urb->dev = ctx->subs->dev;
511 urb->number_of_packets = subs->packs_per_ms;
512 for (i = 0; i < subs->packs_per_ms; ++i) {
513 counts = snd_usb_audio_next_packet_size(subs);
514 urb->iso_frame_desc[i].offset = offs * stride;
515 urb->iso_frame_desc[i].length = counts * stride;
516 offs += counts;
518 urb->transfer_buffer_length = offs * stride;
519 memset(urb->transfer_buffer,
520 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
521 offs * stride);
522 return 0;
526 * prepare urb for playback data pipe
528 * Since a URB can handle only a single linear buffer, we must use double
529 * buffering when the data to be transferred overflows the buffer boundary.
530 * To avoid inconsistencies when updating hwptr_done, we use double buffering
531 * for all URBs.
533 static int prepare_playback_urb(struct snd_usb_substream *subs,
534 struct snd_pcm_runtime *runtime,
535 struct urb *urb)
537 int i, stride, offs;
538 unsigned int counts;
539 unsigned long flags;
540 int period_elapsed = 0;
541 struct snd_urb_ctx *ctx = urb->context;
543 stride = runtime->frame_bits >> 3;
545 offs = 0;
546 urb->dev = ctx->subs->dev; /* we need to set this at each time */
547 urb->number_of_packets = 0;
548 spin_lock_irqsave(&subs->lock, flags);
549 for (i = 0; i < ctx->packets; i++) {
550 counts = snd_usb_audio_next_packet_size(subs);
551 /* set up descriptor */
552 urb->iso_frame_desc[i].offset = offs * stride;
553 urb->iso_frame_desc[i].length = counts * stride;
554 offs += counts;
555 urb->number_of_packets++;
556 subs->transfer_done += counts;
557 if (subs->transfer_done >= runtime->period_size) {
558 subs->transfer_done -= runtime->period_size;
559 period_elapsed = 1;
560 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
561 if (subs->transfer_done > 0) {
562 /* FIXME: fill-max mode is not
563 * supported yet */
564 offs -= subs->transfer_done;
565 counts -= subs->transfer_done;
566 urb->iso_frame_desc[i].length =
567 counts * stride;
568 subs->transfer_done = 0;
570 i++;
571 if (i < ctx->packets) {
572 /* add a transfer delimiter */
573 urb->iso_frame_desc[i].offset =
574 offs * stride;
575 urb->iso_frame_desc[i].length = 0;
576 urb->number_of_packets++;
578 break;
581 /* finish at the frame boundary at/after the period boundary */
582 if (period_elapsed &&
583 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
584 break;
586 if (subs->hwptr_done + offs > runtime->buffer_size) {
587 /* err, the transferred area goes over buffer boundary. */
588 unsigned int len = runtime->buffer_size - subs->hwptr_done;
589 memcpy(urb->transfer_buffer,
590 runtime->dma_area + subs->hwptr_done * stride,
591 len * stride);
592 memcpy(urb->transfer_buffer + len * stride,
593 runtime->dma_area,
594 (offs - len) * stride);
595 } else {
596 memcpy(urb->transfer_buffer,
597 runtime->dma_area + subs->hwptr_done * stride,
598 offs * stride);
600 subs->hwptr_done += offs;
601 if (subs->hwptr_done >= runtime->buffer_size)
602 subs->hwptr_done -= runtime->buffer_size;
603 spin_unlock_irqrestore(&subs->lock, flags);
604 urb->transfer_buffer_length = offs * stride;
605 if (period_elapsed)
606 snd_pcm_period_elapsed(subs->pcm_substream);
607 return 0;
611 * process after playback data complete
612 * - nothing to do
614 static int retire_playback_urb(struct snd_usb_substream *subs,
615 struct snd_pcm_runtime *runtime,
616 struct urb *urb)
618 return 0;
624 static struct snd_urb_ops audio_urb_ops[2] = {
626 .prepare = prepare_nodata_playback_urb,
627 .retire = retire_playback_urb,
628 .prepare_sync = prepare_playback_sync_urb,
629 .retire_sync = retire_playback_sync_urb,
632 .prepare = prepare_capture_urb,
633 .retire = retire_capture_urb,
634 .prepare_sync = prepare_capture_sync_urb,
635 .retire_sync = retire_capture_sync_urb,
639 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
641 .prepare = prepare_nodata_playback_urb,
642 .retire = retire_playback_urb,
643 .prepare_sync = prepare_playback_sync_urb_hs,
644 .retire_sync = retire_playback_sync_urb_hs,
647 .prepare = prepare_capture_urb,
648 .retire = retire_capture_urb,
649 .prepare_sync = prepare_capture_sync_urb_hs,
650 .retire_sync = retire_capture_sync_urb,
655 * complete callback from data urb
657 static void snd_complete_urb(struct urb *urb)
659 struct snd_urb_ctx *ctx = urb->context;
660 struct snd_usb_substream *subs = ctx->subs;
661 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
662 int err = 0;
664 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
665 ! subs->running || /* can be stopped during retire callback */
666 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
667 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
668 clear_bit(ctx->index, &subs->active_mask);
669 if (err < 0) {
670 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
671 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
678 * complete callback from sync urb
680 static void snd_complete_sync_urb(struct urb *urb)
682 struct snd_urb_ctx *ctx = urb->context;
683 struct snd_usb_substream *subs = ctx->subs;
684 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
685 int err = 0;
687 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
688 ! subs->running || /* can be stopped during retire callback */
689 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
690 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
691 clear_bit(ctx->index + 16, &subs->active_mask);
692 if (err < 0) {
693 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
694 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
700 /* get the physical page pointer at the given offset */
701 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
702 unsigned long offset)
704 void *pageptr = subs->runtime->dma_area + offset;
705 return vmalloc_to_page(pageptr);
708 /* allocate virtual buffer; may be called more than once */
709 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
711 struct snd_pcm_runtime *runtime = subs->runtime;
712 if (runtime->dma_area) {
713 if (runtime->dma_bytes >= size)
714 return 0; /* already large enough */
715 vfree(runtime->dma_area);
717 runtime->dma_area = vmalloc(size);
718 if (! runtime->dma_area)
719 return -ENOMEM;
720 runtime->dma_bytes = size;
721 return 0;
724 /* free virtual buffer; may be called more than once */
725 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
727 struct snd_pcm_runtime *runtime = subs->runtime;
729 vfree(runtime->dma_area);
730 runtime->dma_area = NULL;
731 return 0;
736 * unlink active urbs.
738 static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
740 unsigned int i;
741 int async;
743 subs->running = 0;
745 if (!force && subs->stream->chip->shutdown) /* to be sure... */
746 return -EBADFD;
748 async = !can_sleep && async_unlink;
750 if (! async && in_interrupt())
751 return 0;
753 for (i = 0; i < subs->nurbs; i++) {
754 if (test_bit(i, &subs->active_mask)) {
755 if (! test_and_set_bit(i, &subs->unlink_mask)) {
756 struct urb *u = subs->dataurb[i].urb;
757 if (async)
758 usb_unlink_urb(u);
759 else
760 usb_kill_urb(u);
764 if (subs->syncpipe) {
765 for (i = 0; i < SYNC_URBS; i++) {
766 if (test_bit(i+16, &subs->active_mask)) {
767 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
768 struct urb *u = subs->syncurb[i].urb;
769 if (async)
770 usb_unlink_urb(u);
771 else
772 usb_kill_urb(u);
777 return 0;
781 static const char *usb_error_string(int err)
783 switch (err) {
784 case -ENODEV:
785 return "no device";
786 case -ENOENT:
787 return "endpoint not enabled";
788 case -EPIPE:
789 return "endpoint stalled";
790 case -ENOSPC:
791 return "not enough bandwidth";
792 case -ESHUTDOWN:
793 return "device disabled";
794 case -EHOSTUNREACH:
795 return "device suspended";
796 #ifndef CONFIG_USB_EHCI_SPLIT_ISO
797 case -ENOSYS:
798 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
799 #endif
800 case -EINVAL:
801 case -EAGAIN:
802 case -EFBIG:
803 case -EMSGSIZE:
804 return "internal error";
805 default:
806 return "unknown error";
811 * set up and start data/sync urbs
813 static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
815 unsigned int i;
816 int err;
818 if (subs->stream->chip->shutdown)
819 return -EBADFD;
821 for (i = 0; i < subs->nurbs; i++) {
822 snd_assert(subs->dataurb[i].urb, return -EINVAL);
823 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
824 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
825 goto __error;
828 if (subs->syncpipe) {
829 for (i = 0; i < SYNC_URBS; i++) {
830 snd_assert(subs->syncurb[i].urb, return -EINVAL);
831 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
832 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
833 goto __error;
838 subs->active_mask = 0;
839 subs->unlink_mask = 0;
840 subs->running = 1;
841 for (i = 0; i < subs->nurbs; i++) {
842 err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
843 if (err < 0) {
844 snd_printk(KERN_ERR "cannot submit datapipe "
845 "for urb %d, error %d: %s\n",
846 i, err, usb_error_string(err));
847 goto __error;
849 set_bit(i, &subs->active_mask);
851 if (subs->syncpipe) {
852 for (i = 0; i < SYNC_URBS; i++) {
853 err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
854 if (err < 0) {
855 snd_printk(KERN_ERR "cannot submit syncpipe "
856 "for urb %d, error %d: %s\n",
857 i, err, usb_error_string(err));
858 goto __error;
860 set_bit(i + 16, &subs->active_mask);
863 return 0;
865 __error:
866 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
867 deactivate_urbs(subs, 0, 0);
868 return -EPIPE;
873 * wait until all urbs are processed.
875 static int wait_clear_urbs(struct snd_usb_substream *subs)
877 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
878 unsigned int i;
879 int alive;
881 do {
882 alive = 0;
883 for (i = 0; i < subs->nurbs; i++) {
884 if (test_bit(i, &subs->active_mask))
885 alive++;
887 if (subs->syncpipe) {
888 for (i = 0; i < SYNC_URBS; i++) {
889 if (test_bit(i + 16, &subs->active_mask))
890 alive++;
893 if (! alive)
894 break;
895 schedule_timeout_uninterruptible(1);
896 } while (time_before(jiffies, end_time));
897 if (alive)
898 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
899 return 0;
904 * return the current pcm pointer. just return the hwptr_done value.
906 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
908 struct snd_usb_substream *subs;
909 snd_pcm_uframes_t hwptr_done;
911 subs = (struct snd_usb_substream *)substream->runtime->private_data;
912 spin_lock(&subs->lock);
913 hwptr_done = subs->hwptr_done;
914 spin_unlock(&subs->lock);
915 return hwptr_done;
920 * start/stop playback substream
922 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
923 int cmd)
925 struct snd_usb_substream *subs = substream->runtime->private_data;
927 switch (cmd) {
928 case SNDRV_PCM_TRIGGER_START:
929 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
930 subs->ops.prepare = prepare_playback_urb;
931 return 0;
932 case SNDRV_PCM_TRIGGER_STOP:
933 return deactivate_urbs(subs, 0, 0);
934 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
935 subs->ops.prepare = prepare_nodata_playback_urb;
936 return 0;
937 default:
938 return -EINVAL;
943 * start/stop capture substream
945 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
946 int cmd)
948 struct snd_usb_substream *subs = substream->runtime->private_data;
950 switch (cmd) {
951 case SNDRV_PCM_TRIGGER_START:
952 subs->ops.retire = retire_capture_urb;
953 return start_urbs(subs, substream->runtime);
954 case SNDRV_PCM_TRIGGER_STOP:
955 return deactivate_urbs(subs, 0, 0);
956 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
957 subs->ops.retire = retire_paused_capture_urb;
958 return 0;
959 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
960 subs->ops.retire = retire_capture_urb;
961 return 0;
962 default:
963 return -EINVAL;
969 * release a urb data
971 static void release_urb_ctx(struct snd_urb_ctx *u)
973 if (u->urb) {
974 if (u->buffer_size)
975 usb_buffer_free(u->subs->dev, u->buffer_size,
976 u->urb->transfer_buffer,
977 u->urb->transfer_dma);
978 usb_free_urb(u->urb);
979 u->urb = NULL;
984 * release a substream
986 static void release_substream_urbs(struct snd_usb_substream *subs, int force)
988 int i;
990 /* stop urbs (to be sure) */
991 deactivate_urbs(subs, force, 1);
992 wait_clear_urbs(subs);
994 for (i = 0; i < MAX_URBS; i++)
995 release_urb_ctx(&subs->dataurb[i]);
996 for (i = 0; i < SYNC_URBS; i++)
997 release_urb_ctx(&subs->syncurb[i]);
998 usb_buffer_free(subs->dev, SYNC_URBS * 4,
999 subs->syncbuf, subs->sync_dma);
1000 subs->syncbuf = NULL;
1001 subs->nurbs = 0;
1005 * initialize a substream for plaback/capture
1007 static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
1008 unsigned int rate, unsigned int frame_bits)
1010 unsigned int maxsize, n, i;
1011 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1012 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
1014 /* calculate the frequency in 16.16 format */
1015 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1016 subs->freqn = get_usb_full_speed_rate(rate);
1017 else
1018 subs->freqn = get_usb_high_speed_rate(rate);
1019 subs->freqm = subs->freqn;
1020 /* calculate max. frequency */
1021 if (subs->maxpacksize) {
1022 /* whatever fits into a max. size packet */
1023 maxsize = subs->maxpacksize;
1024 subs->freqmax = (maxsize / (frame_bits >> 3))
1025 << (16 - subs->datainterval);
1026 } else {
1027 /* no max. packet size: just take 25% higher than nominal */
1028 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1029 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1030 >> (16 - subs->datainterval);
1032 subs->phase = 0;
1034 if (subs->fill_max)
1035 subs->curpacksize = subs->maxpacksize;
1036 else
1037 subs->curpacksize = maxsize;
1039 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1040 packs_per_ms = 8 >> subs->datainterval;
1041 else
1042 packs_per_ms = 1;
1043 subs->packs_per_ms = packs_per_ms;
1045 if (is_playback) {
1046 urb_packs = nrpacks;
1047 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1048 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1049 } else
1050 urb_packs = 1;
1051 urb_packs *= packs_per_ms;
1053 /* decide how many packets to be used */
1054 if (is_playback) {
1055 unsigned int minsize;
1056 /* determine how small a packet can be */
1057 minsize = (subs->freqn >> (16 - subs->datainterval))
1058 * (frame_bits >> 3);
1059 /* with sync from device, assume it can be 12% lower */
1060 if (subs->syncpipe)
1061 minsize -= minsize >> 3;
1062 minsize = max(minsize, 1u);
1063 total_packs = (period_bytes + minsize - 1) / minsize;
1064 /* round up to multiple of packs_per_ms */
1065 total_packs = (total_packs + packs_per_ms - 1)
1066 & ~(packs_per_ms - 1);
1067 /* we need at least two URBs for queueing */
1068 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1069 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
1070 } else {
1071 total_packs = MAX_URBS * urb_packs;
1073 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1074 if (subs->nurbs > MAX_URBS) {
1075 /* too much... */
1076 subs->nurbs = MAX_URBS;
1077 total_packs = MAX_URBS * urb_packs;
1079 n = total_packs;
1080 for (i = 0; i < subs->nurbs; i++) {
1081 npacks[i] = n > urb_packs ? urb_packs : n;
1082 n -= urb_packs;
1084 if (subs->nurbs <= 1) {
1085 /* too little - we need at least two packets
1086 * to ensure contiguous playback/capture
1088 subs->nurbs = 2;
1089 npacks[0] = (total_packs + 1) / 2;
1090 npacks[1] = total_packs - npacks[0];
1091 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1092 /* the last packet is too small.. */
1093 if (subs->nurbs > 2) {
1094 /* merge to the first one */
1095 npacks[0] += npacks[subs->nurbs - 1];
1096 subs->nurbs--;
1097 } else {
1098 /* divide to two */
1099 subs->nurbs = 2;
1100 npacks[0] = (total_packs + 1) / 2;
1101 npacks[1] = total_packs - npacks[0];
1105 /* allocate and initialize data urbs */
1106 for (i = 0; i < subs->nurbs; i++) {
1107 struct snd_urb_ctx *u = &subs->dataurb[i];
1108 u->index = i;
1109 u->subs = subs;
1110 u->packets = npacks[i];
1111 u->buffer_size = maxsize * u->packets;
1112 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1113 u->packets++; /* for transfer delimiter */
1114 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1115 if (! u->urb)
1116 goto out_of_memory;
1117 u->urb->transfer_buffer =
1118 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1119 &u->urb->transfer_dma);
1120 if (! u->urb->transfer_buffer)
1121 goto out_of_memory;
1122 u->urb->pipe = subs->datapipe;
1123 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1124 u->urb->interval = 1 << subs->datainterval;
1125 u->urb->context = u;
1126 u->urb->complete = snd_complete_urb;
1129 if (subs->syncpipe) {
1130 /* allocate and initialize sync urbs */
1131 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1132 GFP_KERNEL, &subs->sync_dma);
1133 if (! subs->syncbuf)
1134 goto out_of_memory;
1135 for (i = 0; i < SYNC_URBS; i++) {
1136 struct snd_urb_ctx *u = &subs->syncurb[i];
1137 u->index = i;
1138 u->subs = subs;
1139 u->packets = 1;
1140 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1141 if (! u->urb)
1142 goto out_of_memory;
1143 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1144 u->urb->transfer_dma = subs->sync_dma + i * 4;
1145 u->urb->transfer_buffer_length = 4;
1146 u->urb->pipe = subs->syncpipe;
1147 u->urb->transfer_flags = URB_ISO_ASAP |
1148 URB_NO_TRANSFER_DMA_MAP;
1149 u->urb->number_of_packets = 1;
1150 u->urb->interval = 1 << subs->syncinterval;
1151 u->urb->context = u;
1152 u->urb->complete = snd_complete_sync_urb;
1155 return 0;
1157 out_of_memory:
1158 release_substream_urbs(subs, 0);
1159 return -ENOMEM;
1164 * find a matching audio format
1166 static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
1167 unsigned int rate, unsigned int channels)
1169 struct list_head *p;
1170 struct audioformat *found = NULL;
1171 int cur_attr = 0, attr;
1173 list_for_each(p, &subs->fmt_list) {
1174 struct audioformat *fp;
1175 fp = list_entry(p, struct audioformat, list);
1176 if (fp->format != format || fp->channels != channels)
1177 continue;
1178 if (rate < fp->rate_min || rate > fp->rate_max)
1179 continue;
1180 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1181 unsigned int i;
1182 for (i = 0; i < fp->nr_rates; i++)
1183 if (fp->rate_table[i] == rate)
1184 break;
1185 if (i >= fp->nr_rates)
1186 continue;
1188 attr = fp->ep_attr & EP_ATTR_MASK;
1189 if (! found) {
1190 found = fp;
1191 cur_attr = attr;
1192 continue;
1194 /* avoid async out and adaptive in if the other method
1195 * supports the same format.
1196 * this is a workaround for the case like
1197 * M-audio audiophile USB.
1199 if (attr != cur_attr) {
1200 if ((attr == EP_ATTR_ASYNC &&
1201 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1202 (attr == EP_ATTR_ADAPTIVE &&
1203 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1204 continue;
1205 if ((cur_attr == EP_ATTR_ASYNC &&
1206 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1207 (cur_attr == EP_ATTR_ADAPTIVE &&
1208 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1209 found = fp;
1210 cur_attr = attr;
1211 continue;
1214 /* find the format with the largest max. packet size */
1215 if (fp->maxpacksize > found->maxpacksize) {
1216 found = fp;
1217 cur_attr = attr;
1220 return found;
1225 * initialize the picth control and sample rate
1227 static int init_usb_pitch(struct usb_device *dev, int iface,
1228 struct usb_host_interface *alts,
1229 struct audioformat *fmt)
1231 unsigned int ep;
1232 unsigned char data[1];
1233 int err;
1235 ep = get_endpoint(alts, 0)->bEndpointAddress;
1236 /* if endpoint has pitch control, enable it */
1237 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1238 data[0] = 1;
1239 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1240 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1241 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1242 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1243 dev->devnum, iface, ep);
1244 return err;
1247 return 0;
1250 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1251 struct usb_host_interface *alts,
1252 struct audioformat *fmt, int rate)
1254 unsigned int ep;
1255 unsigned char data[3];
1256 int err;
1258 ep = get_endpoint(alts, 0)->bEndpointAddress;
1259 /* if endpoint has sampling rate control, set it */
1260 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1261 int crate;
1262 data[0] = rate;
1263 data[1] = rate >> 8;
1264 data[2] = rate >> 16;
1265 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1266 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1267 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1268 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1269 dev->devnum, iface, fmt->altsetting, rate, ep);
1270 return err;
1272 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1273 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1274 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1275 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1276 dev->devnum, iface, fmt->altsetting, ep);
1277 return 0; /* some devices don't support reading */
1279 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1280 if (crate != rate) {
1281 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1282 // runtime->rate = crate;
1285 return 0;
1289 * find a matching format and set up the interface
1291 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
1293 struct usb_device *dev = subs->dev;
1294 struct usb_host_interface *alts;
1295 struct usb_interface_descriptor *altsd;
1296 struct usb_interface *iface;
1297 unsigned int ep, attr;
1298 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1299 int err;
1301 iface = usb_ifnum_to_if(dev, fmt->iface);
1302 snd_assert(iface, return -EINVAL);
1303 alts = &iface->altsetting[fmt->altset_idx];
1304 altsd = get_iface_desc(alts);
1305 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1307 if (fmt == subs->cur_audiofmt)
1308 return 0;
1310 /* close the old interface */
1311 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1312 usb_set_interface(subs->dev, subs->interface, 0);
1313 subs->interface = -1;
1314 subs->format = 0;
1317 /* set interface */
1318 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1319 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1320 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1321 dev->devnum, fmt->iface, fmt->altsetting);
1322 return -EIO;
1324 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1325 subs->interface = fmt->iface;
1326 subs->format = fmt->altset_idx;
1329 /* create a data pipe */
1330 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1331 if (is_playback)
1332 subs->datapipe = usb_sndisocpipe(dev, ep);
1333 else
1334 subs->datapipe = usb_rcvisocpipe(dev, ep);
1335 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1336 get_endpoint(alts, 0)->bInterval >= 1 &&
1337 get_endpoint(alts, 0)->bInterval <= 4)
1338 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1339 else
1340 subs->datainterval = 0;
1341 subs->syncpipe = subs->syncinterval = 0;
1342 subs->maxpacksize = fmt->maxpacksize;
1343 subs->fill_max = 0;
1345 /* we need a sync pipe in async OUT or adaptive IN mode */
1346 /* check the number of EP, since some devices have broken
1347 * descriptors which fool us. if it has only one EP,
1348 * assume it as adaptive-out or sync-in.
1350 attr = fmt->ep_attr & EP_ATTR_MASK;
1351 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1352 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1353 altsd->bNumEndpoints >= 2) {
1354 /* check sync-pipe endpoint */
1355 /* ... and check descriptor size before accessing bSynchAddress
1356 because there is a version of the SB Audigy 2 NX firmware lacking
1357 the audio fields in the endpoint descriptors */
1358 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1359 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1360 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1361 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1362 dev->devnum, fmt->iface, fmt->altsetting);
1363 return -EINVAL;
1365 ep = get_endpoint(alts, 1)->bEndpointAddress;
1366 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1367 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1368 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1369 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1370 dev->devnum, fmt->iface, fmt->altsetting);
1371 return -EINVAL;
1373 ep &= USB_ENDPOINT_NUMBER_MASK;
1374 if (is_playback)
1375 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1376 else
1377 subs->syncpipe = usb_sndisocpipe(dev, ep);
1378 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1379 get_endpoint(alts, 1)->bRefresh >= 1 &&
1380 get_endpoint(alts, 1)->bRefresh <= 9)
1381 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1382 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1383 subs->syncinterval = 1;
1384 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1385 get_endpoint(alts, 1)->bInterval <= 16)
1386 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1387 else
1388 subs->syncinterval = 3;
1391 /* always fill max packet size */
1392 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1393 subs->fill_max = 1;
1395 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1396 return err;
1398 subs->cur_audiofmt = fmt;
1400 #if 0
1401 printk("setting done: format = %d, rate = %d, channels = %d\n",
1402 fmt->format, fmt->rate, fmt->channels);
1403 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1404 subs->datapipe, subs->syncpipe);
1405 #endif
1407 return 0;
1411 * hw_params callback
1413 * allocate a buffer and set the given audio format.
1415 * so far we use a physically linear buffer although packetize transfer
1416 * doesn't need a continuous area.
1417 * if sg buffer is supported on the later version of alsa, we'll follow
1418 * that.
1420 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1421 struct snd_pcm_hw_params *hw_params)
1423 struct snd_usb_substream *subs = substream->runtime->private_data;
1424 struct audioformat *fmt;
1425 unsigned int channels, rate, format;
1426 int ret, changed;
1428 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1429 params_buffer_bytes(hw_params));
1430 if (ret < 0)
1431 return ret;
1433 format = params_format(hw_params);
1434 rate = params_rate(hw_params);
1435 channels = params_channels(hw_params);
1436 fmt = find_format(subs, format, rate, channels);
1437 if (! fmt) {
1438 snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1439 format, rate, channels);
1440 return -EINVAL;
1443 changed = subs->cur_audiofmt != fmt ||
1444 subs->period_bytes != params_period_bytes(hw_params) ||
1445 subs->cur_rate != rate;
1446 if ((ret = set_format(subs, fmt)) < 0)
1447 return ret;
1449 if (subs->cur_rate != rate) {
1450 struct usb_host_interface *alts;
1451 struct usb_interface *iface;
1452 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1453 alts = &iface->altsetting[fmt->altset_idx];
1454 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1455 if (ret < 0)
1456 return ret;
1457 subs->cur_rate = rate;
1460 if (changed) {
1461 /* format changed */
1462 release_substream_urbs(subs, 0);
1463 /* influenced: period_bytes, channels, rate, format, */
1464 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1465 params_rate(hw_params),
1466 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1469 return ret;
1473 * hw_free callback
1475 * reset the audio format and release the buffer
1477 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
1479 struct snd_usb_substream *subs = substream->runtime->private_data;
1481 subs->cur_audiofmt = NULL;
1482 subs->cur_rate = 0;
1483 subs->period_bytes = 0;
1484 if (!subs->stream->chip->shutdown)
1485 release_substream_urbs(subs, 0);
1486 return snd_pcm_free_vmalloc_buffer(substream);
1490 * prepare callback
1492 * only a few subtle things...
1494 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
1496 struct snd_pcm_runtime *runtime = substream->runtime;
1497 struct snd_usb_substream *subs = runtime->private_data;
1499 if (! subs->cur_audiofmt) {
1500 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1501 return -ENXIO;
1504 /* some unit conversions in runtime */
1505 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1506 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1508 /* reset the pointer */
1509 subs->hwptr_done = 0;
1510 subs->transfer_done = 0;
1511 subs->phase = 0;
1513 /* clear urbs (to be sure) */
1514 deactivate_urbs(subs, 0, 1);
1515 wait_clear_urbs(subs);
1517 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1518 * updates for all URBs would happen at the same time when starting */
1519 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1520 subs->ops.prepare = prepare_nodata_playback_urb;
1521 return start_urbs(subs, runtime);
1522 } else
1523 return 0;
1526 static struct snd_pcm_hardware snd_usb_hardware =
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 SNDRV_PCM_INFO_PAUSE,
1534 .buffer_bytes_max = 1024 * 1024,
1535 .period_bytes_min = 64,
1536 .period_bytes_max = 512 * 1024,
1537 .periods_min = 2,
1538 .periods_max = 1024,
1542 * h/w constraints
1545 #ifdef HW_CONST_DEBUG
1546 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1547 #else
1548 #define hwc_debug(fmt, args...) /**/
1549 #endif
1551 static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
1553 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1554 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1555 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1557 /* check the format */
1558 if (! snd_mask_test(fmts, fp->format)) {
1559 hwc_debug(" > check: no supported format %d\n", fp->format);
1560 return 0;
1562 /* check the channels */
1563 if (fp->channels < ct->min || fp->channels > ct->max) {
1564 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1565 return 0;
1567 /* check the rate is within the range */
1568 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1569 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1570 return 0;
1572 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1573 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1574 return 0;
1576 return 1;
1579 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1580 struct snd_pcm_hw_rule *rule)
1582 struct snd_usb_substream *subs = rule->private;
1583 struct list_head *p;
1584 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1585 unsigned int rmin, rmax;
1586 int changed;
1588 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1589 changed = 0;
1590 rmin = rmax = 0;
1591 list_for_each(p, &subs->fmt_list) {
1592 struct audioformat *fp;
1593 fp = list_entry(p, struct audioformat, list);
1594 if (! hw_check_valid_format(params, fp))
1595 continue;
1596 if (changed++) {
1597 if (rmin > fp->rate_min)
1598 rmin = fp->rate_min;
1599 if (rmax < fp->rate_max)
1600 rmax = fp->rate_max;
1601 } else {
1602 rmin = fp->rate_min;
1603 rmax = fp->rate_max;
1607 if (! changed) {
1608 hwc_debug(" --> get empty\n");
1609 it->empty = 1;
1610 return -EINVAL;
1613 changed = 0;
1614 if (it->min < rmin) {
1615 it->min = rmin;
1616 it->openmin = 0;
1617 changed = 1;
1619 if (it->max > rmax) {
1620 it->max = rmax;
1621 it->openmax = 0;
1622 changed = 1;
1624 if (snd_interval_checkempty(it)) {
1625 it->empty = 1;
1626 return -EINVAL;
1628 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1629 return changed;
1633 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1634 struct snd_pcm_hw_rule *rule)
1636 struct snd_usb_substream *subs = rule->private;
1637 struct list_head *p;
1638 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1639 unsigned int rmin, rmax;
1640 int changed;
1642 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1643 changed = 0;
1644 rmin = rmax = 0;
1645 list_for_each(p, &subs->fmt_list) {
1646 struct audioformat *fp;
1647 fp = list_entry(p, struct audioformat, list);
1648 if (! hw_check_valid_format(params, fp))
1649 continue;
1650 if (changed++) {
1651 if (rmin > fp->channels)
1652 rmin = fp->channels;
1653 if (rmax < fp->channels)
1654 rmax = fp->channels;
1655 } else {
1656 rmin = fp->channels;
1657 rmax = fp->channels;
1661 if (! changed) {
1662 hwc_debug(" --> get empty\n");
1663 it->empty = 1;
1664 return -EINVAL;
1667 changed = 0;
1668 if (it->min < rmin) {
1669 it->min = rmin;
1670 it->openmin = 0;
1671 changed = 1;
1673 if (it->max > rmax) {
1674 it->max = rmax;
1675 it->openmax = 0;
1676 changed = 1;
1678 if (snd_interval_checkempty(it)) {
1679 it->empty = 1;
1680 return -EINVAL;
1682 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1683 return changed;
1686 static int hw_rule_format(struct snd_pcm_hw_params *params,
1687 struct snd_pcm_hw_rule *rule)
1689 struct snd_usb_substream *subs = rule->private;
1690 struct list_head *p;
1691 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1692 u64 fbits;
1693 u32 oldbits[2];
1694 int changed;
1696 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1697 fbits = 0;
1698 list_for_each(p, &subs->fmt_list) {
1699 struct audioformat *fp;
1700 fp = list_entry(p, struct audioformat, list);
1701 if (! hw_check_valid_format(params, fp))
1702 continue;
1703 fbits |= (1ULL << fp->format);
1706 oldbits[0] = fmt->bits[0];
1707 oldbits[1] = fmt->bits[1];
1708 fmt->bits[0] &= (u32)fbits;
1709 fmt->bits[1] &= (u32)(fbits >> 32);
1710 if (! fmt->bits[0] && ! fmt->bits[1]) {
1711 hwc_debug(" --> get empty\n");
1712 return -EINVAL;
1714 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1715 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1716 return changed;
1719 #define MAX_MASK 64
1722 * check whether the registered audio formats need special hw-constraints
1724 static int check_hw_params_convention(struct snd_usb_substream *subs)
1726 int i;
1727 u32 *channels;
1728 u32 *rates;
1729 u32 cmaster, rmaster;
1730 u32 rate_min = 0, rate_max = 0;
1731 struct list_head *p;
1732 int err = 1;
1734 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1735 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1737 list_for_each(p, &subs->fmt_list) {
1738 struct audioformat *f;
1739 f = list_entry(p, struct audioformat, list);
1740 /* unconventional channels? */
1741 if (f->channels > 32)
1742 goto __out;
1743 /* continuous rate min/max matches? */
1744 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1745 if (rate_min && f->rate_min != rate_min)
1746 goto __out;
1747 if (rate_max && f->rate_max != rate_max)
1748 goto __out;
1749 rate_min = f->rate_min;
1750 rate_max = f->rate_max;
1752 /* combination of continuous rates and fixed rates? */
1753 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1754 if (f->rates != rates[f->format])
1755 goto __out;
1757 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1758 if (rates[f->format] && rates[f->format] != f->rates)
1759 goto __out;
1761 channels[f->format] |= (1 << f->channels);
1762 rates[f->format] |= f->rates;
1763 /* needs knot? */
1764 if (f->needs_knot)
1765 goto __out;
1767 /* check whether channels and rates match for all formats */
1768 cmaster = rmaster = 0;
1769 for (i = 0; i < MAX_MASK; i++) {
1770 if (cmaster != channels[i] && cmaster && channels[i])
1771 goto __out;
1772 if (rmaster != rates[i] && rmaster && rates[i])
1773 goto __out;
1774 if (channels[i])
1775 cmaster = channels[i];
1776 if (rates[i])
1777 rmaster = rates[i];
1779 /* check whether channels match for all distinct rates */
1780 memset(channels, 0, MAX_MASK * sizeof(u32));
1781 list_for_each(p, &subs->fmt_list) {
1782 struct audioformat *f;
1783 f = list_entry(p, struct audioformat, list);
1784 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1785 continue;
1786 for (i = 0; i < 32; i++) {
1787 if (f->rates & (1 << i))
1788 channels[i] |= (1 << f->channels);
1791 cmaster = 0;
1792 for (i = 0; i < 32; i++) {
1793 if (cmaster != channels[i] && cmaster && channels[i])
1794 goto __out;
1795 if (channels[i])
1796 cmaster = channels[i];
1798 err = 0;
1800 __out:
1801 kfree(channels);
1802 kfree(rates);
1803 return err;
1807 * If the device supports unusual bit rates, does the request meet these?
1809 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1810 struct snd_usb_substream *subs)
1812 struct audioformat *fp;
1813 int count = 0, needs_knot = 0;
1814 int err;
1816 list_for_each_entry(fp, &subs->fmt_list, list) {
1817 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1818 return 0;
1819 count += fp->nr_rates;
1820 if (fp->needs_knot)
1821 needs_knot = 1;
1823 if (!needs_knot)
1824 return 0;
1826 subs->rate_list.count = count;
1827 subs->rate_list.list = kmalloc(sizeof(int) * count, GFP_KERNEL);
1828 subs->rate_list.mask = 0;
1829 count = 0;
1830 list_for_each_entry(fp, &subs->fmt_list, list) {
1831 int i;
1832 for (i = 0; i < fp->nr_rates; i++)
1833 subs->rate_list.list[count++] = fp->rate_table[i];
1835 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1836 &subs->rate_list);
1837 if (err < 0)
1838 return err;
1840 return 0;
1845 * set up the runtime hardware information.
1848 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1850 struct list_head *p;
1851 int err;
1853 runtime->hw.formats = subs->formats;
1855 runtime->hw.rate_min = 0x7fffffff;
1856 runtime->hw.rate_max = 0;
1857 runtime->hw.channels_min = 256;
1858 runtime->hw.channels_max = 0;
1859 runtime->hw.rates = 0;
1860 /* check min/max rates and channels */
1861 list_for_each(p, &subs->fmt_list) {
1862 struct audioformat *fp;
1863 fp = list_entry(p, struct audioformat, list);
1864 runtime->hw.rates |= fp->rates;
1865 if (runtime->hw.rate_min > fp->rate_min)
1866 runtime->hw.rate_min = fp->rate_min;
1867 if (runtime->hw.rate_max < fp->rate_max)
1868 runtime->hw.rate_max = fp->rate_max;
1869 if (runtime->hw.channels_min > fp->channels)
1870 runtime->hw.channels_min = fp->channels;
1871 if (runtime->hw.channels_max < fp->channels)
1872 runtime->hw.channels_max = fp->channels;
1873 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1874 /* FIXME: there might be more than one audio formats... */
1875 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1876 fp->frame_size;
1880 /* set the period time minimum 1ms */
1881 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1882 1000 * MIN_PACKS_URB,
1883 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1885 if (check_hw_params_convention(subs)) {
1886 hwc_debug("setting extra hw constraints...\n");
1887 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1888 hw_rule_rate, subs,
1889 SNDRV_PCM_HW_PARAM_FORMAT,
1890 SNDRV_PCM_HW_PARAM_CHANNELS,
1891 -1)) < 0)
1892 return err;
1893 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1894 hw_rule_channels, subs,
1895 SNDRV_PCM_HW_PARAM_FORMAT,
1896 SNDRV_PCM_HW_PARAM_RATE,
1897 -1)) < 0)
1898 return err;
1899 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1900 hw_rule_format, subs,
1901 SNDRV_PCM_HW_PARAM_RATE,
1902 SNDRV_PCM_HW_PARAM_CHANNELS,
1903 -1)) < 0)
1904 return err;
1905 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1906 return err;
1908 return 0;
1911 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
1913 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1914 struct snd_pcm_runtime *runtime = substream->runtime;
1915 struct snd_usb_substream *subs = &as->substream[direction];
1917 subs->interface = -1;
1918 subs->format = 0;
1919 runtime->hw = snd_usb_hardware;
1920 runtime->private_data = subs;
1921 subs->pcm_substream = substream;
1922 return setup_hw_info(runtime, subs);
1925 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1927 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1928 struct snd_usb_substream *subs = &as->substream[direction];
1930 if (subs->interface >= 0) {
1931 usb_set_interface(subs->dev, subs->interface, 0);
1932 subs->interface = -1;
1934 subs->pcm_substream = NULL;
1935 return 0;
1938 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1940 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1943 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1945 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1948 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1950 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1953 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1955 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1958 static struct snd_pcm_ops snd_usb_playback_ops = {
1959 .open = snd_usb_playback_open,
1960 .close = snd_usb_playback_close,
1961 .ioctl = snd_pcm_lib_ioctl,
1962 .hw_params = snd_usb_hw_params,
1963 .hw_free = snd_usb_hw_free,
1964 .prepare = snd_usb_pcm_prepare,
1965 .trigger = snd_usb_pcm_playback_trigger,
1966 .pointer = snd_usb_pcm_pointer,
1967 .page = snd_pcm_get_vmalloc_page,
1970 static struct snd_pcm_ops snd_usb_capture_ops = {
1971 .open = snd_usb_capture_open,
1972 .close = snd_usb_capture_close,
1973 .ioctl = snd_pcm_lib_ioctl,
1974 .hw_params = snd_usb_hw_params,
1975 .hw_free = snd_usb_hw_free,
1976 .prepare = snd_usb_pcm_prepare,
1977 .trigger = snd_usb_pcm_capture_trigger,
1978 .pointer = snd_usb_pcm_pointer,
1979 .page = snd_pcm_get_vmalloc_page,
1985 * helper functions
1989 * combine bytes and get an integer value
1991 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1993 switch (size) {
1994 case 1: return *bytes;
1995 case 2: return combine_word(bytes);
1996 case 3: return combine_triple(bytes);
1997 case 4: return combine_quad(bytes);
1998 default: return 0;
2003 * parse descriptor buffer and return the pointer starting the given
2004 * descriptor type.
2006 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
2008 u8 *p, *end, *next;
2010 p = descstart;
2011 end = p + desclen;
2012 for (; p < end;) {
2013 if (p[0] < 2)
2014 return NULL;
2015 next = p + p[0];
2016 if (next > end)
2017 return NULL;
2018 if (p[1] == dtype && (!after || (void *)p > after)) {
2019 return p;
2021 p = next;
2023 return NULL;
2027 * find a class-specified interface descriptor with the given subtype.
2029 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
2031 unsigned char *p = after;
2033 while ((p = snd_usb_find_desc(buffer, buflen, p,
2034 USB_DT_CS_INTERFACE)) != NULL) {
2035 if (p[0] >= 3 && p[2] == dsubtype)
2036 return p;
2038 return NULL;
2042 * Wrapper for usb_control_msg().
2043 * Allocates a temp buffer to prevent dmaing from/to the stack.
2045 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2046 __u8 requesttype, __u16 value, __u16 index, void *data,
2047 __u16 size, int timeout)
2049 int err;
2050 void *buf = NULL;
2052 if (size > 0) {
2053 buf = kmemdup(data, size, GFP_KERNEL);
2054 if (!buf)
2055 return -ENOMEM;
2057 err = usb_control_msg(dev, pipe, request, requesttype,
2058 value, index, buf, size, timeout);
2059 if (size > 0) {
2060 memcpy(data, buf, size);
2061 kfree(buf);
2063 return err;
2068 * entry point for linux usb interface
2071 static int usb_audio_probe(struct usb_interface *intf,
2072 const struct usb_device_id *id);
2073 static void usb_audio_disconnect(struct usb_interface *intf);
2075 static struct usb_device_id usb_audio_ids [] = {
2076 #include "usbquirks.h"
2077 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2078 .bInterfaceClass = USB_CLASS_AUDIO,
2079 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2080 { } /* Terminating entry */
2083 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2085 static struct usb_driver usb_audio_driver = {
2086 .name = "snd-usb-audio",
2087 .probe = usb_audio_probe,
2088 .disconnect = usb_audio_disconnect,
2089 .id_table = usb_audio_ids,
2093 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2096 * proc interface for list the supported pcm formats
2098 static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2100 struct list_head *p;
2101 static char *sync_types[4] = {
2102 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2105 list_for_each(p, &subs->fmt_list) {
2106 struct audioformat *fp;
2107 fp = list_entry(p, struct audioformat, list);
2108 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2109 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
2110 snd_iprintf(buffer, " Format: 0x%x\n", fp->format);
2111 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2112 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2113 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2114 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2115 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2116 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2117 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2118 fp->rate_min, fp->rate_max);
2119 } else {
2120 unsigned int i;
2121 snd_iprintf(buffer, " Rates: ");
2122 for (i = 0; i < fp->nr_rates; i++) {
2123 if (i > 0)
2124 snd_iprintf(buffer, ", ");
2125 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2127 snd_iprintf(buffer, "\n");
2129 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2130 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2134 static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2136 if (subs->running) {
2137 unsigned int i;
2138 snd_iprintf(buffer, " Status: Running\n");
2139 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2140 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2141 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2142 for (i = 0; i < subs->nurbs; i++)
2143 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2144 snd_iprintf(buffer, "]\n");
2145 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2146 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2147 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2148 ? get_full_speed_hz(subs->freqm)
2149 : get_high_speed_hz(subs->freqm),
2150 subs->freqm >> 16, subs->freqm & 0xffff);
2151 } else {
2152 snd_iprintf(buffer, " Status: Stop\n");
2156 static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
2158 struct snd_usb_stream *stream = entry->private_data;
2160 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2162 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2163 snd_iprintf(buffer, "\nPlayback:\n");
2164 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2165 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2167 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2168 snd_iprintf(buffer, "\nCapture:\n");
2169 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2170 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2174 static void proc_pcm_format_add(struct snd_usb_stream *stream)
2176 struct snd_info_entry *entry;
2177 char name[32];
2178 struct snd_card *card = stream->chip->card;
2180 sprintf(name, "stream%d", stream->pcm_index);
2181 if (! snd_card_proc_new(card, name, &entry))
2182 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
2185 #else
2187 static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2191 #endif
2194 * initialize the substream instance.
2197 static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
2199 struct snd_usb_substream *subs = &as->substream[stream];
2201 INIT_LIST_HEAD(&subs->fmt_list);
2202 spin_lock_init(&subs->lock);
2204 subs->stream = as;
2205 subs->direction = stream;
2206 subs->dev = as->chip->dev;
2207 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2208 subs->ops = audio_urb_ops[stream];
2209 else
2210 subs->ops = audio_urb_ops_high_speed[stream];
2211 snd_pcm_set_ops(as->pcm, stream,
2212 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2213 &snd_usb_playback_ops : &snd_usb_capture_ops);
2215 list_add_tail(&fp->list, &subs->fmt_list);
2216 subs->formats |= 1ULL << fp->format;
2217 subs->endpoint = fp->endpoint;
2218 subs->num_formats++;
2219 subs->fmt_type = fp->fmt_type;
2224 * free a substream
2226 static void free_substream(struct snd_usb_substream *subs)
2228 struct list_head *p, *n;
2230 if (! subs->num_formats)
2231 return; /* not initialized */
2232 list_for_each_safe(p, n, &subs->fmt_list) {
2233 struct audioformat *fp = list_entry(p, struct audioformat, list);
2234 kfree(fp->rate_table);
2235 kfree(fp);
2237 kfree(subs->rate_list.list);
2242 * free a usb stream instance
2244 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
2246 free_substream(&stream->substream[0]);
2247 free_substream(&stream->substream[1]);
2248 list_del(&stream->list);
2249 kfree(stream);
2252 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
2254 struct snd_usb_stream *stream = pcm->private_data;
2255 if (stream) {
2256 stream->pcm = NULL;
2257 snd_usb_audio_stream_free(stream);
2263 * add this endpoint to the chip instance.
2264 * if a stream with the same endpoint already exists, append to it.
2265 * if not, create a new pcm stream.
2267 static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
2269 struct list_head *p;
2270 struct snd_usb_stream *as;
2271 struct snd_usb_substream *subs;
2272 struct snd_pcm *pcm;
2273 int err;
2275 list_for_each(p, &chip->pcm_list) {
2276 as = list_entry(p, struct snd_usb_stream, list);
2277 if (as->fmt_type != fp->fmt_type)
2278 continue;
2279 subs = &as->substream[stream];
2280 if (! subs->endpoint)
2281 continue;
2282 if (subs->endpoint == fp->endpoint) {
2283 list_add_tail(&fp->list, &subs->fmt_list);
2284 subs->num_formats++;
2285 subs->formats |= 1ULL << fp->format;
2286 return 0;
2289 /* look for an empty stream */
2290 list_for_each(p, &chip->pcm_list) {
2291 as = list_entry(p, struct snd_usb_stream, list);
2292 if (as->fmt_type != fp->fmt_type)
2293 continue;
2294 subs = &as->substream[stream];
2295 if (subs->endpoint)
2296 continue;
2297 err = snd_pcm_new_stream(as->pcm, stream, 1);
2298 if (err < 0)
2299 return err;
2300 init_substream(as, stream, fp);
2301 return 0;
2304 /* create a new pcm */
2305 as = kzalloc(sizeof(*as), GFP_KERNEL);
2306 if (! as)
2307 return -ENOMEM;
2308 as->pcm_index = chip->pcm_devs;
2309 as->chip = chip;
2310 as->fmt_type = fp->fmt_type;
2311 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2312 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2313 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2314 &pcm);
2315 if (err < 0) {
2316 kfree(as);
2317 return err;
2319 as->pcm = pcm;
2320 pcm->private_data = as;
2321 pcm->private_free = snd_usb_audio_pcm_free;
2322 pcm->info_flags = 0;
2323 if (chip->pcm_devs > 0)
2324 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2325 else
2326 strcpy(pcm->name, "USB Audio");
2328 init_substream(as, stream, fp);
2330 list_add(&as->list, &chip->pcm_list);
2331 chip->pcm_devs++;
2333 proc_pcm_format_add(as);
2335 return 0;
2340 * check if the device uses big-endian samples
2342 static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
2344 switch (chip->usb_id) {
2345 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2346 if (fp->endpoint & USB_DIR_IN)
2347 return 1;
2348 break;
2349 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2350 return 1;
2352 return 0;
2356 * parse the audio format type I descriptor
2357 * and returns the corresponding pcm format
2359 * @dev: usb device
2360 * @fp: audioformat record
2361 * @format: the format tag (wFormatTag)
2362 * @fmt: the format type descriptor
2364 static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
2365 int format, unsigned char *fmt)
2367 int pcm_format;
2368 int sample_width, sample_bytes;
2370 /* FIXME: correct endianess and sign? */
2371 pcm_format = -1;
2372 sample_width = fmt[6];
2373 sample_bytes = fmt[5];
2374 switch (format) {
2375 case 0: /* some devices don't define this correctly... */
2376 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2377 chip->dev->devnum, fp->iface, fp->altsetting);
2378 /* fall-through */
2379 case USB_AUDIO_FORMAT_PCM:
2380 if (sample_width > sample_bytes * 8) {
2381 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2382 chip->dev->devnum, fp->iface, fp->altsetting,
2383 sample_width, sample_bytes);
2385 /* check the format byte size */
2386 switch (fmt[5]) {
2387 case 1:
2388 pcm_format = SNDRV_PCM_FORMAT_S8;
2389 break;
2390 case 2:
2391 if (is_big_endian_format(chip, fp))
2392 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2393 else
2394 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2395 break;
2396 case 3:
2397 if (is_big_endian_format(chip, fp))
2398 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2399 else
2400 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2401 break;
2402 case 4:
2403 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2404 break;
2405 default:
2406 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2407 chip->dev->devnum, fp->iface,
2408 fp->altsetting, sample_width, sample_bytes);
2409 break;
2411 break;
2412 case USB_AUDIO_FORMAT_PCM8:
2413 /* Dallas DS4201 workaround */
2414 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2415 pcm_format = SNDRV_PCM_FORMAT_S8;
2416 else
2417 pcm_format = SNDRV_PCM_FORMAT_U8;
2418 break;
2419 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2420 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2421 break;
2422 case USB_AUDIO_FORMAT_ALAW:
2423 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2424 break;
2425 case USB_AUDIO_FORMAT_MU_LAW:
2426 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2427 break;
2428 default:
2429 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2430 chip->dev->devnum, fp->iface, fp->altsetting, format);
2431 break;
2433 return pcm_format;
2438 * parse the format descriptor and stores the possible sample rates
2439 * on the audioformat table.
2441 * @dev: usb device
2442 * @fp: audioformat record
2443 * @fmt: the format descriptor
2444 * @offset: the start offset of descriptor pointing the rate type
2445 * (7 for type I and II, 8 for type II)
2447 static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
2448 unsigned char *fmt, int offset)
2450 int nr_rates = fmt[offset];
2451 int found;
2452 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2453 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2454 chip->dev->devnum, fp->iface, fp->altsetting);
2455 return -1;
2458 if (nr_rates) {
2460 * build the rate table and bitmap flags
2462 int r, idx, c;
2463 unsigned int nonzero_rates = 0;
2464 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2465 static unsigned int conv_rates[] = {
2466 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2467 64000, 88200, 96000, 176400, 192000
2469 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2470 if (fp->rate_table == NULL) {
2471 snd_printk(KERN_ERR "cannot malloc\n");
2472 return -1;
2475 fp->needs_knot = 0;
2476 fp->nr_rates = nr_rates;
2477 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2478 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2479 unsigned int rate = combine_triple(&fmt[idx]);
2480 /* C-Media CM6501 mislabels its 96 kHz altsetting */
2481 if (rate == 48000 && nr_rates == 1 &&
2482 chip->usb_id == USB_ID(0x0d8c, 0x0201) &&
2483 fp->altsetting == 5 && fp->maxpacksize == 392)
2484 rate = 96000;
2485 fp->rate_table[r] = rate;
2486 nonzero_rates |= rate;
2487 if (rate < fp->rate_min)
2488 fp->rate_min = rate;
2489 else if (rate > fp->rate_max)
2490 fp->rate_max = rate;
2491 found = 0;
2492 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2493 if (rate == conv_rates[c]) {
2494 found = 1;
2495 fp->rates |= (1 << c);
2496 break;
2499 if (!found)
2500 fp->needs_knot = 1;
2502 if (!nonzero_rates) {
2503 hwc_debug("All rates were zero. Skipping format!\n");
2504 return -1;
2506 if (fp->needs_knot)
2507 fp->rates |= SNDRV_PCM_RATE_KNOT;
2508 } else {
2509 /* continuous rates */
2510 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2511 fp->rate_min = combine_triple(&fmt[offset + 1]);
2512 fp->rate_max = combine_triple(&fmt[offset + 4]);
2514 return 0;
2518 * parse the format type I and III descriptors
2520 static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
2521 int format, unsigned char *fmt)
2523 int pcm_format;
2525 if (fmt[3] == USB_FORMAT_TYPE_III) {
2526 /* FIXME: the format type is really IECxxx
2527 * but we give normal PCM format to get the existing
2528 * apps working...
2530 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2531 } else {
2532 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2533 if (pcm_format < 0)
2534 return -1;
2536 fp->format = pcm_format;
2537 fp->channels = fmt[4];
2538 if (fp->channels < 1) {
2539 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2540 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2541 return -1;
2543 return parse_audio_format_rates(chip, fp, fmt, 7);
2547 * prase the format type II descriptor
2549 static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
2550 int format, unsigned char *fmt)
2552 int brate, framesize;
2553 switch (format) {
2554 case USB_AUDIO_FORMAT_AC3:
2555 /* FIXME: there is no AC3 format defined yet */
2556 // fp->format = SNDRV_PCM_FORMAT_AC3;
2557 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2558 break;
2559 case USB_AUDIO_FORMAT_MPEG:
2560 fp->format = SNDRV_PCM_FORMAT_MPEG;
2561 break;
2562 default:
2563 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2564 chip->dev->devnum, fp->iface, fp->altsetting, format);
2565 fp->format = SNDRV_PCM_FORMAT_MPEG;
2566 break;
2568 fp->channels = 1;
2569 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2570 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2571 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2572 fp->frame_size = framesize;
2573 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2576 static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
2577 int format, unsigned char *fmt, int stream)
2579 int err;
2581 switch (fmt[3]) {
2582 case USB_FORMAT_TYPE_I:
2583 case USB_FORMAT_TYPE_III:
2584 err = parse_audio_format_i(chip, fp, format, fmt);
2585 break;
2586 case USB_FORMAT_TYPE_II:
2587 err = parse_audio_format_ii(chip, fp, format, fmt);
2588 break;
2589 default:
2590 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2591 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2592 return -1;
2594 fp->fmt_type = fmt[3];
2595 if (err < 0)
2596 return err;
2597 #if 1
2598 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2599 /* extigy apparently supports sample rates other than 48k
2600 * but not in ordinary way. so we enable only 48k atm.
2602 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2603 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2604 chip->usb_id == USB_ID(0x041e, 0x3061)) {
2605 if (fmt[3] == USB_FORMAT_TYPE_I &&
2606 fp->rates != SNDRV_PCM_RATE_48000 &&
2607 fp->rates != SNDRV_PCM_RATE_96000)
2608 return -1;
2610 #endif
2611 return 0;
2614 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2615 int iface, int altno);
2616 static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
2618 struct usb_device *dev;
2619 struct usb_interface *iface;
2620 struct usb_host_interface *alts;
2621 struct usb_interface_descriptor *altsd;
2622 int i, altno, err, stream;
2623 int format;
2624 struct audioformat *fp;
2625 unsigned char *fmt, *csep;
2627 dev = chip->dev;
2629 /* parse the interface's altsettings */
2630 iface = usb_ifnum_to_if(dev, iface_no);
2631 for (i = 0; i < iface->num_altsetting; i++) {
2632 alts = &iface->altsetting[i];
2633 altsd = get_iface_desc(alts);
2634 /* skip invalid one */
2635 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2636 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2637 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2638 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2639 altsd->bNumEndpoints < 1 ||
2640 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2641 continue;
2642 /* must be isochronous */
2643 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2644 USB_ENDPOINT_XFER_ISOC)
2645 continue;
2646 /* check direction */
2647 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2648 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2649 altno = altsd->bAlternateSetting;
2651 /* audiophile usb: skip altsets incompatible with device_setup
2653 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2654 audiophile_skip_setting_quirk(chip, iface_no, altno))
2655 continue;
2657 /* get audio formats */
2658 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2659 if (!fmt) {
2660 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2661 dev->devnum, iface_no, altno);
2662 continue;
2665 if (fmt[0] < 7) {
2666 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2667 dev->devnum, iface_no, altno);
2668 continue;
2671 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2673 /* get format type */
2674 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2675 if (!fmt) {
2676 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2677 dev->devnum, iface_no, altno);
2678 continue;
2680 if (fmt[0] < 8) {
2681 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2682 dev->devnum, iface_no, altno);
2683 continue;
2686 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2687 /* Creamware Noah has this descriptor after the 2nd endpoint */
2688 if (!csep && altsd->bNumEndpoints >= 2)
2689 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2690 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2691 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
2692 " class specific endpoint descriptor\n",
2693 dev->devnum, iface_no, altno);
2694 csep = NULL;
2697 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
2698 if (! fp) {
2699 snd_printk(KERN_ERR "cannot malloc\n");
2700 return -ENOMEM;
2703 fp->iface = iface_no;
2704 fp->altsetting = altno;
2705 fp->altset_idx = i;
2706 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2707 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2708 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2709 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2710 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2711 * (fp->maxpacksize & 0x7ff);
2712 fp->attributes = csep ? csep[3] : 0;
2714 /* some quirks for attributes here */
2716 switch (chip->usb_id) {
2717 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2718 /* Optoplay sets the sample rate attribute although
2719 * it seems not supporting it in fact.
2721 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2722 break;
2723 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2724 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2725 /* doesn't set the sample rate attribute, but supports it */
2726 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2727 break;
2728 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2729 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2730 an older model 77d:223) */
2732 * plantronics headset and Griffin iMic have set adaptive-in
2733 * although it's really not...
2735 fp->ep_attr &= ~EP_ATTR_MASK;
2736 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2737 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2738 else
2739 fp->ep_attr |= EP_ATTR_SYNC;
2740 break;
2743 /* ok, let's parse further... */
2744 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2745 kfree(fp->rate_table);
2746 kfree(fp);
2747 continue;
2750 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, altno, fp->endpoint);
2751 err = add_audio_endpoint(chip, stream, fp);
2752 if (err < 0) {
2753 kfree(fp->rate_table);
2754 kfree(fp);
2755 return err;
2757 /* try to set the interface... */
2758 usb_set_interface(chip->dev, iface_no, altno);
2759 init_usb_pitch(chip->dev, iface_no, alts, fp);
2760 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2762 return 0;
2767 * disconnect streams
2768 * called from snd_usb_audio_disconnect()
2770 static void snd_usb_stream_disconnect(struct list_head *head)
2772 int idx;
2773 struct snd_usb_stream *as;
2774 struct snd_usb_substream *subs;
2776 as = list_entry(head, struct snd_usb_stream, list);
2777 for (idx = 0; idx < 2; idx++) {
2778 subs = &as->substream[idx];
2779 if (!subs->num_formats)
2780 return;
2781 release_substream_urbs(subs, 1);
2782 subs->interface = -1;
2787 * parse audio control descriptor and create pcm/midi streams
2789 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
2791 struct usb_device *dev = chip->dev;
2792 struct usb_host_interface *host_iface;
2793 struct usb_interface *iface;
2794 unsigned char *p1;
2795 int i, j;
2797 /* find audiocontrol interface */
2798 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2799 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2800 snd_printk(KERN_ERR "cannot find HEADER\n");
2801 return -EINVAL;
2803 if (! p1[7] || p1[0] < 8 + p1[7]) {
2804 snd_printk(KERN_ERR "invalid HEADER\n");
2805 return -EINVAL;
2809 * parse all USB audio streaming interfaces
2811 for (i = 0; i < p1[7]; i++) {
2812 struct usb_host_interface *alts;
2813 struct usb_interface_descriptor *altsd;
2814 j = p1[8 + i];
2815 iface = usb_ifnum_to_if(dev, j);
2816 if (!iface) {
2817 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2818 dev->devnum, ctrlif, j);
2819 continue;
2821 if (usb_interface_claimed(iface)) {
2822 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2823 continue;
2825 alts = &iface->altsetting[0];
2826 altsd = get_iface_desc(alts);
2827 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2828 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2829 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2830 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2831 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2832 continue;
2834 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2835 continue;
2837 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2838 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2839 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2840 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2841 /* skip non-supported classes */
2842 continue;
2844 if (! parse_audio_endpoints(chip, j)) {
2845 usb_set_interface(dev, j, 0); /* reset the current interface */
2846 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2850 return 0;
2854 * create a stream for an endpoint/altsetting without proper descriptors
2856 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
2857 struct usb_interface *iface,
2858 const struct snd_usb_audio_quirk *quirk)
2860 struct audioformat *fp;
2861 struct usb_host_interface *alts;
2862 int stream, err;
2863 int *rate_table = NULL;
2865 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
2866 if (! fp) {
2867 snd_printk(KERN_ERR "cannot memdup\n");
2868 return -ENOMEM;
2870 if (fp->nr_rates > 0) {
2871 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2872 if (!rate_table) {
2873 kfree(fp);
2874 return -ENOMEM;
2876 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2877 fp->rate_table = rate_table;
2880 stream = (fp->endpoint & USB_DIR_IN)
2881 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2882 err = add_audio_endpoint(chip, stream, fp);
2883 if (err < 0) {
2884 kfree(fp);
2885 kfree(rate_table);
2886 return err;
2888 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2889 fp->altset_idx >= iface->num_altsetting) {
2890 kfree(fp);
2891 kfree(rate_table);
2892 return -EINVAL;
2894 alts = &iface->altsetting[fp->altset_idx];
2895 usb_set_interface(chip->dev, fp->iface, 0);
2896 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2897 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2898 return 0;
2902 * create a stream for an interface with proper descriptors
2904 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
2905 struct usb_interface *iface,
2906 const struct snd_usb_audio_quirk *quirk)
2908 struct usb_host_interface *alts;
2909 struct usb_interface_descriptor *altsd;
2910 int err;
2912 alts = &iface->altsetting[0];
2913 altsd = get_iface_desc(alts);
2914 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2915 if (err < 0) {
2916 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2917 altsd->bInterfaceNumber, err);
2918 return err;
2920 /* reset the current interface */
2921 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2922 return 0;
2926 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2927 * to detect the sample rate is by looking at wMaxPacketSize.
2929 static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
2930 struct usb_interface *iface,
2931 const struct snd_usb_audio_quirk *quirk)
2933 static const struct audioformat ua_format = {
2934 .format = SNDRV_PCM_FORMAT_S24_3LE,
2935 .channels = 2,
2936 .fmt_type = USB_FORMAT_TYPE_I,
2937 .altsetting = 1,
2938 .altset_idx = 1,
2939 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2941 struct usb_host_interface *alts;
2942 struct usb_interface_descriptor *altsd;
2943 struct audioformat *fp;
2944 int stream, err;
2946 /* both PCM and MIDI interfaces have 2 altsettings */
2947 if (iface->num_altsetting != 2)
2948 return -ENXIO;
2949 alts = &iface->altsetting[1];
2950 altsd = get_iface_desc(alts);
2952 if (altsd->bNumEndpoints == 2) {
2953 static const struct snd_usb_midi_endpoint_info ua700_ep = {
2954 .out_cables = 0x0003,
2955 .in_cables = 0x0003
2957 static const struct snd_usb_audio_quirk ua700_quirk = {
2958 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2959 .data = &ua700_ep
2961 static const struct snd_usb_midi_endpoint_info ua25_ep = {
2962 .out_cables = 0x0001,
2963 .in_cables = 0x0001
2965 static const struct snd_usb_audio_quirk ua25_quirk = {
2966 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2967 .data = &ua25_ep
2969 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2970 return snd_usb_create_midi_interface(chip, iface,
2971 &ua700_quirk);
2972 else
2973 return snd_usb_create_midi_interface(chip, iface,
2974 &ua25_quirk);
2977 if (altsd->bNumEndpoints != 1)
2978 return -ENXIO;
2980 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2981 if (!fp)
2982 return -ENOMEM;
2983 memcpy(fp, &ua_format, sizeof(*fp));
2985 fp->iface = altsd->bInterfaceNumber;
2986 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2987 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2988 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2990 switch (fp->maxpacksize) {
2991 case 0x120:
2992 fp->rate_max = fp->rate_min = 44100;
2993 break;
2994 case 0x138:
2995 case 0x140:
2996 fp->rate_max = fp->rate_min = 48000;
2997 break;
2998 case 0x258:
2999 case 0x260:
3000 fp->rate_max = fp->rate_min = 96000;
3001 break;
3002 default:
3003 snd_printk(KERN_ERR "unknown sample rate\n");
3004 kfree(fp);
3005 return -ENXIO;
3008 stream = (fp->endpoint & USB_DIR_IN)
3009 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3010 err = add_audio_endpoint(chip, stream, fp);
3011 if (err < 0) {
3012 kfree(fp);
3013 return err;
3015 usb_set_interface(chip->dev, fp->iface, 0);
3016 return 0;
3020 * Create a stream for an Edirol UA-1000 interface.
3022 static int create_ua1000_quirk(struct snd_usb_audio *chip,
3023 struct usb_interface *iface,
3024 const struct snd_usb_audio_quirk *quirk)
3026 static const struct audioformat ua1000_format = {
3027 .format = SNDRV_PCM_FORMAT_S32_LE,
3028 .fmt_type = USB_FORMAT_TYPE_I,
3029 .altsetting = 1,
3030 .altset_idx = 1,
3031 .attributes = 0,
3032 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3034 struct usb_host_interface *alts;
3035 struct usb_interface_descriptor *altsd;
3036 struct audioformat *fp;
3037 int stream, err;
3039 if (iface->num_altsetting != 2)
3040 return -ENXIO;
3041 alts = &iface->altsetting[1];
3042 altsd = get_iface_desc(alts);
3043 if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3044 altsd->bNumEndpoints != 1)
3045 return -ENXIO;
3047 fp = kmemdup(&ua1000_format, sizeof(*fp), GFP_KERNEL);
3048 if (!fp)
3049 return -ENOMEM;
3051 fp->channels = alts->extra[4];
3052 fp->iface = altsd->bInterfaceNumber;
3053 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3054 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3055 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3056 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
3058 stream = (fp->endpoint & USB_DIR_IN)
3059 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3060 err = add_audio_endpoint(chip, stream, fp);
3061 if (err < 0) {
3062 kfree(fp);
3063 return err;
3065 /* FIXME: playback must be synchronized to capture */
3066 usb_set_interface(chip->dev, fp->iface, 0);
3067 return 0;
3071 * Create a stream for an Edirol UA-101 interface.
3072 * Copy, paste and modify from Edirol UA-1000
3074 static int create_ua101_quirk(struct snd_usb_audio *chip,
3075 struct usb_interface *iface,
3076 const struct snd_usb_audio_quirk *quirk)
3078 static const struct audioformat ua101_format = {
3079 .format = SNDRV_PCM_FORMAT_S32_LE,
3080 .fmt_type = USB_FORMAT_TYPE_I,
3081 .altsetting = 1,
3082 .altset_idx = 1,
3083 .attributes = 0,
3084 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3086 struct usb_host_interface *alts;
3087 struct usb_interface_descriptor *altsd;
3088 struct audioformat *fp;
3089 int stream, err;
3091 if (iface->num_altsetting != 2)
3092 return -ENXIO;
3093 alts = &iface->altsetting[1];
3094 altsd = get_iface_desc(alts);
3095 if (alts->extralen != 18 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3096 altsd->bNumEndpoints != 1)
3097 return -ENXIO;
3099 fp = kmemdup(&ua101_format, sizeof(*fp), GFP_KERNEL);
3100 if (!fp)
3101 return -ENOMEM;
3103 fp->channels = alts->extra[11];
3104 fp->iface = altsd->bInterfaceNumber;
3105 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3106 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3107 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3108 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[15]);
3110 stream = (fp->endpoint & USB_DIR_IN)
3111 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3112 err = add_audio_endpoint(chip, stream, fp);
3113 if (err < 0) {
3114 kfree(fp);
3115 return err;
3117 /* FIXME: playback must be synchronized to capture */
3118 usb_set_interface(chip->dev, fp->iface, 0);
3119 return 0;
3122 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3123 struct usb_interface *iface,
3124 const struct snd_usb_audio_quirk *quirk);
3127 * handle the quirks for the contained interfaces
3129 static int create_composite_quirk(struct snd_usb_audio *chip,
3130 struct usb_interface *iface,
3131 const struct snd_usb_audio_quirk *quirk)
3133 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3134 int err;
3136 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3137 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3138 if (!iface)
3139 continue;
3140 if (quirk->ifnum != probed_ifnum &&
3141 usb_interface_claimed(iface))
3142 continue;
3143 err = snd_usb_create_quirk(chip, iface, quirk);
3144 if (err < 0)
3145 return err;
3146 if (quirk->ifnum != probed_ifnum)
3147 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3149 return 0;
3152 static int ignore_interface_quirk(struct snd_usb_audio *chip,
3153 struct usb_interface *iface,
3154 const struct snd_usb_audio_quirk *quirk)
3156 return 0;
3161 * boot quirks
3164 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3165 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3167 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3169 struct usb_host_config *config = dev->actconfig;
3170 int err;
3172 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3173 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3174 snd_printdd("sending Extigy boot sequence...\n");
3175 /* Send message to force it to reconnect with full interface. */
3176 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3177 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3178 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3179 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3180 &dev->descriptor, sizeof(dev->descriptor));
3181 config = dev->actconfig;
3182 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3183 err = usb_reset_configuration(dev);
3184 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3185 snd_printdd("extigy_boot: new boot length = %d\n",
3186 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3187 return -ENODEV; /* quit this anyway */
3189 return 0;
3192 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3194 u8 buf = 1;
3196 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3197 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3198 0, 0, &buf, 1, 1000);
3199 if (buf == 0) {
3200 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3201 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3202 1, 2000, NULL, 0, 1000);
3203 return -ENODEV;
3205 return 0;
3209 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3210 * documented in the device's data sheet.
3212 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3214 u8 buf[4];
3215 buf[0] = 0x20;
3216 buf[1] = value & 0xff;
3217 buf[2] = (value >> 8) & 0xff;
3218 buf[3] = reg;
3219 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3220 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3221 0, 0, &buf, 4, 1000);
3224 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3227 * Enable line-out driver mode, set headphone source to front
3228 * channels, enable stereo mic.
3230 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3235 * Setup quirks
3237 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3238 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3239 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3240 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3241 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3242 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3243 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3244 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3245 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3246 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3248 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3249 int iface, int altno)
3251 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3252 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3253 && altno != 6)
3254 return 1; /* skip this altsetting */
3255 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3256 && altno != 1)
3257 return 1; /* skip this altsetting */
3258 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3259 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3260 return 1; /* skip this altsetting */
3261 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3262 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3263 return 1; /* skip this altsetting */
3264 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3265 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3266 return 1; /* skip this altsetting */
3267 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3268 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3269 return 1; /* skip this altsetting */
3271 return 0; /* keep this altsetting */
3275 * audio-interface quirks
3277 * returns zero if no standard audio/MIDI parsing is needed.
3278 * returns a postive value if standard audio/midi interfaces are parsed
3279 * after this.
3280 * returns a negative value at error.
3282 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3283 struct usb_interface *iface,
3284 const struct snd_usb_audio_quirk *quirk)
3286 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3287 const struct snd_usb_audio_quirk *);
3288 static const quirk_func_t quirk_funcs[] = {
3289 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3290 [QUIRK_COMPOSITE] = create_composite_quirk,
3291 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3292 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3293 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3294 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3295 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3296 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3297 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3298 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
3299 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3300 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3301 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3302 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3303 [QUIRK_AUDIO_EDIROL_UA101] = create_ua101_quirk,
3306 if (quirk->type < QUIRK_TYPE_COUNT) {
3307 return quirk_funcs[quirk->type](chip, iface, quirk);
3308 } else {
3309 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3310 return -ENXIO;
3316 * common proc files to show the usb device info
3318 static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3320 struct snd_usb_audio *chip = entry->private_data;
3321 if (! chip->shutdown)
3322 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3325 static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3327 struct snd_usb_audio *chip = entry->private_data;
3328 if (! chip->shutdown)
3329 snd_iprintf(buffer, "%04x:%04x\n",
3330 USB_ID_VENDOR(chip->usb_id),
3331 USB_ID_PRODUCT(chip->usb_id));
3334 static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
3336 struct snd_info_entry *entry;
3337 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3338 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
3339 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3340 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
3344 * free the chip instance
3346 * here we have to do not much, since pcm and controls are already freed
3350 static int snd_usb_audio_free(struct snd_usb_audio *chip)
3352 usb_chip[chip->index] = NULL;
3353 kfree(chip);
3354 return 0;
3357 static int snd_usb_audio_dev_free(struct snd_device *device)
3359 struct snd_usb_audio *chip = device->device_data;
3360 return snd_usb_audio_free(chip);
3365 * create a chip instance and set its names.
3367 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3368 const struct snd_usb_audio_quirk *quirk,
3369 struct snd_usb_audio **rchip)
3371 struct snd_card *card;
3372 struct snd_usb_audio *chip;
3373 int err, len;
3374 char component[14];
3375 static struct snd_device_ops ops = {
3376 .dev_free = snd_usb_audio_dev_free,
3379 *rchip = NULL;
3381 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3382 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3383 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3384 return -ENXIO;
3387 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3388 if (card == NULL) {
3389 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3390 return -ENOMEM;
3393 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3394 if (! chip) {
3395 snd_card_free(card);
3396 return -ENOMEM;
3399 chip->index = idx;
3400 chip->dev = dev;
3401 chip->card = card;
3402 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3403 le16_to_cpu(dev->descriptor.idProduct));
3404 INIT_LIST_HEAD(&chip->pcm_list);
3405 INIT_LIST_HEAD(&chip->midi_list);
3406 INIT_LIST_HEAD(&chip->mixer_list);
3408 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3409 snd_usb_audio_free(chip);
3410 snd_card_free(card);
3411 return err;
3414 strcpy(card->driver, "USB-Audio");
3415 sprintf(component, "USB%04x:%04x",
3416 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3417 snd_component_add(card, component);
3419 /* retrieve the device string as shortname */
3420 if (quirk && quirk->product_name) {
3421 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3422 } else {
3423 if (!dev->descriptor.iProduct ||
3424 usb_string(dev, dev->descriptor.iProduct,
3425 card->shortname, sizeof(card->shortname)) <= 0) {
3426 /* no name available from anywhere, so use ID */
3427 sprintf(card->shortname, "USB Device %#04x:%#04x",
3428 USB_ID_VENDOR(chip->usb_id),
3429 USB_ID_PRODUCT(chip->usb_id));
3433 /* retrieve the vendor and device strings as longname */
3434 if (quirk && quirk->vendor_name) {
3435 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3436 } else {
3437 if (dev->descriptor.iManufacturer)
3438 len = usb_string(dev, dev->descriptor.iManufacturer,
3439 card->longname, sizeof(card->longname));
3440 else
3441 len = 0;
3442 /* we don't really care if there isn't any vendor string */
3444 if (len > 0)
3445 strlcat(card->longname, " ", sizeof(card->longname));
3447 strlcat(card->longname, card->shortname, sizeof(card->longname));
3449 len = strlcat(card->longname, " at ", sizeof(card->longname));
3451 if (len < sizeof(card->longname))
3452 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3454 strlcat(card->longname,
3455 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3456 sizeof(card->longname));
3458 snd_usb_audio_create_proc(chip);
3460 *rchip = chip;
3461 return 0;
3466 * probe the active usb device
3468 * note that this can be called multiple times per a device, when it
3469 * includes multiple audio control interfaces.
3471 * thus we check the usb device pointer and creates the card instance
3472 * only at the first time. the successive calls of this function will
3473 * append the pcm interface to the corresponding card.
3475 static void *snd_usb_audio_probe(struct usb_device *dev,
3476 struct usb_interface *intf,
3477 const struct usb_device_id *usb_id)
3479 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
3480 int i, err;
3481 struct snd_usb_audio *chip;
3482 struct usb_host_interface *alts;
3483 int ifnum;
3484 u32 id;
3486 alts = &intf->altsetting[0];
3487 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3488 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3489 le16_to_cpu(dev->descriptor.idProduct));
3491 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3492 goto __err_val;
3494 /* SB Extigy needs special boot-up sequence */
3495 /* if more models come, this will go to the quirk list. */
3496 if (id == USB_ID(0x041e, 0x3000)) {
3497 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3498 goto __err_val;
3500 /* SB Audigy 2 NX needs its own boot-up magic, too */
3501 if (id == USB_ID(0x041e, 0x3020)) {
3502 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3503 goto __err_val;
3506 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3507 if (id == USB_ID(0x10f5, 0x0200)) {
3508 if (snd_usb_cm106_boot_quirk(dev) < 0)
3509 goto __err_val;
3513 * found a config. now register to ALSA
3516 /* check whether it's already registered */
3517 chip = NULL;
3518 mutex_lock(&register_mutex);
3519 for (i = 0; i < SNDRV_CARDS; i++) {
3520 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3521 if (usb_chip[i]->shutdown) {
3522 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3523 goto __error;
3525 chip = usb_chip[i];
3526 break;
3529 if (! chip) {
3530 /* it's a fresh one.
3531 * now look for an empty slot and create a new card instance
3533 for (i = 0; i < SNDRV_CARDS; i++)
3534 if (enable[i] && ! usb_chip[i] &&
3535 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3536 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3537 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3538 goto __error;
3540 snd_card_set_dev(chip->card, &intf->dev);
3541 break;
3543 if (! chip) {
3544 snd_printk(KERN_ERR "no available usb audio device\n");
3545 goto __error;
3549 err = 1; /* continue */
3550 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3551 /* need some special handlings */
3552 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3553 goto __error;
3556 if (err > 0) {
3557 /* create normal USB audio interfaces */
3558 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3559 snd_usb_create_mixer(chip, ifnum) < 0) {
3560 goto __error;
3564 /* we are allowed to call snd_card_register() many times */
3565 if (snd_card_register(chip->card) < 0) {
3566 goto __error;
3569 usb_chip[chip->index] = chip;
3570 chip->num_interfaces++;
3571 mutex_unlock(&register_mutex);
3572 return chip;
3574 __error:
3575 if (chip && !chip->num_interfaces)
3576 snd_card_free(chip->card);
3577 mutex_unlock(&register_mutex);
3578 __err_val:
3579 return NULL;
3583 * we need to take care of counter, since disconnection can be called also
3584 * many times as well as usb_audio_probe().
3586 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3588 struct snd_usb_audio *chip;
3589 struct snd_card *card;
3590 struct list_head *p;
3592 if (ptr == (void *)-1L)
3593 return;
3595 chip = ptr;
3596 card = chip->card;
3597 mutex_lock(&register_mutex);
3598 chip->shutdown = 1;
3599 chip->num_interfaces--;
3600 if (chip->num_interfaces <= 0) {
3601 snd_card_disconnect(card);
3602 /* release the pcm resources */
3603 list_for_each(p, &chip->pcm_list) {
3604 snd_usb_stream_disconnect(p);
3606 /* release the midi resources */
3607 list_for_each(p, &chip->midi_list) {
3608 snd_usbmidi_disconnect(p);
3610 /* release mixer resources */
3611 list_for_each(p, &chip->mixer_list) {
3612 snd_usb_mixer_disconnect(p);
3614 mutex_unlock(&register_mutex);
3615 snd_card_free_when_closed(card);
3616 } else {
3617 mutex_unlock(&register_mutex);
3622 * new 2.5 USB kernel API
3624 static int usb_audio_probe(struct usb_interface *intf,
3625 const struct usb_device_id *id)
3627 void *chip;
3628 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3629 if (chip) {
3630 dev_set_drvdata(&intf->dev, chip);
3631 return 0;
3632 } else
3633 return -EIO;
3636 static void usb_audio_disconnect(struct usb_interface *intf)
3638 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3639 dev_get_drvdata(&intf->dev));
3643 static int __init snd_usb_audio_init(void)
3645 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3646 printk(KERN_WARNING "invalid nrpacks value.\n");
3647 return -EINVAL;
3649 return usb_register(&usb_audio_driver);
3653 static void __exit snd_usb_audio_cleanup(void)
3655 usb_deregister(&usb_audio_driver);
3658 module_init(snd_usb_audio_init);
3659 module_exit(snd_usb_audio_cleanup);