[NET]: Make netlink_kernel_release publically available as sk_release_kernel.
[linux-2.6.git] / sound / usb / usbaudio.c
blob8fa93566570272036365009776ec0fa952c1303d
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 <linux/bitops.h>
42 #include <linux/init.h>
43 #include <linux/list.h>
44 #include <linux/slab.h>
45 #include <linux/string.h>
46 #include <linux/usb.h>
47 #include <linux/vmalloc.h>
48 #include <linux/moduleparam.h>
49 #include <linux/mutex.h>
50 #include <sound/core.h>
51 #include <sound/info.h>
52 #include <sound/pcm.h>
53 #include <sound/pcm_params.h>
54 #include <sound/initval.h>
56 #include "usbaudio.h"
59 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
60 MODULE_DESCRIPTION("USB Audio");
61 MODULE_LICENSE("GPL");
62 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
65 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
66 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
67 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
68 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
69 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
70 static int nrpacks = 8; /* max. number of packets per urb */
71 static int async_unlink = 1;
72 static int device_setup[SNDRV_CARDS]; /* device parameter for this card*/
74 module_param_array(index, int, NULL, 0444);
75 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
76 module_param_array(id, charp, NULL, 0444);
77 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
78 module_param_array(enable, bool, NULL, 0444);
79 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
80 module_param_array(vid, int, NULL, 0444);
81 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
82 module_param_array(pid, int, NULL, 0444);
83 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
84 module_param(nrpacks, int, 0644);
85 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
86 module_param(async_unlink, bool, 0444);
87 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
88 module_param_array(device_setup, int, NULL, 0444);
89 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
93 * debug the h/w constraints
95 /* #define HW_CONST_DEBUG */
102 #define MAX_PACKS 20
103 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
104 #define MAX_URBS 8
105 #define SYNC_URBS 4 /* always four urbs for sync */
106 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
108 struct audioformat {
109 struct list_head list;
110 snd_pcm_format_t format; /* format type */
111 unsigned int channels; /* # channels */
112 unsigned int fmt_type; /* USB audio format type (1-3) */
113 unsigned int frame_size; /* samples per frame for non-audio */
114 int iface; /* interface number */
115 unsigned char altsetting; /* corresponding alternate setting */
116 unsigned char altset_idx; /* array index of altenate setting */
117 unsigned char attributes; /* corresponding attributes of cs endpoint */
118 unsigned char endpoint; /* endpoint */
119 unsigned char ep_attr; /* endpoint attributes */
120 unsigned int maxpacksize; /* max. packet size */
121 unsigned int rates; /* rate bitmasks */
122 unsigned int rate_min, rate_max; /* min/max rates */
123 unsigned int nr_rates; /* number of rate table entries */
124 unsigned int *rate_table; /* rate table */
127 struct snd_usb_substream;
129 struct snd_urb_ctx {
130 struct urb *urb;
131 unsigned int buffer_size; /* size of data buffer, if data URB */
132 struct snd_usb_substream *subs;
133 int index; /* index for urb array */
134 int packets; /* number of packets per urb */
137 struct snd_urb_ops {
138 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
139 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
140 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
144 struct snd_usb_substream {
145 struct snd_usb_stream *stream;
146 struct usb_device *dev;
147 struct snd_pcm_substream *pcm_substream;
148 int direction; /* playback or capture */
149 int interface; /* current interface */
150 int endpoint; /* assigned endpoint */
151 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
152 unsigned int cur_rate; /* current rate (for hw_params callback) */
153 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
154 unsigned int format; /* USB data format */
155 unsigned int datapipe; /* the data i/o pipe */
156 unsigned int syncpipe; /* 1 - async out or adaptive in */
157 unsigned int datainterval; /* log_2 of data packet interval */
158 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
159 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
160 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
162 unsigned int phase; /* phase accumulator */
163 unsigned int maxpacksize; /* max packet size in bytes */
164 unsigned int maxframesize; /* max packet size in frames */
165 unsigned int curpacksize; /* current packet size in bytes (for capture) */
166 unsigned int curframesize; /* current packet size in frames (for capture) */
167 unsigned int fill_max: 1; /* fill max packet size always */
168 unsigned int fmt_type; /* USB audio format type (1-3) */
169 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
171 unsigned int running: 1; /* running status */
173 unsigned int hwptr_done; /* processed frame position in the buffer */
174 unsigned int transfer_done; /* processed frames since last period update */
175 unsigned long active_mask; /* bitmask of active urbs */
176 unsigned long unlink_mask; /* bitmask of unlinked urbs */
178 unsigned int nurbs; /* # urbs */
179 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
180 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
181 char *syncbuf; /* sync buffer for all sync URBs */
182 dma_addr_t sync_dma; /* DMA address of syncbuf */
184 u64 formats; /* format bitmasks (all or'ed) */
185 unsigned int num_formats; /* number of supported audio formats (list) */
186 struct list_head fmt_list; /* format list */
187 struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
188 spinlock_t lock;
190 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
194 struct snd_usb_stream {
195 struct snd_usb_audio *chip;
196 struct snd_pcm *pcm;
197 int pcm_index;
198 unsigned int fmt_type; /* USB audio format type (1-3) */
199 struct snd_usb_substream substream[2];
200 struct list_head list;
205 * we keep the snd_usb_audio_t instances by ourselves for merging
206 * the all interfaces on the same card as one sound device.
209 static DEFINE_MUTEX(register_mutex);
210 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
214 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
215 * this will overflow at approx 524 kHz
217 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
219 return ((rate << 13) + 62) / 125;
223 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
224 * this will overflow at approx 4 MHz
226 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
228 return ((rate << 10) + 62) / 125;
231 /* convert our full speed USB rate into sampling rate in Hz */
232 static inline unsigned get_full_speed_hz(unsigned int usb_rate)
234 return (usb_rate * 125 + (1 << 12)) >> 13;
237 /* convert our high speed USB rate into sampling rate in Hz */
238 static inline unsigned get_high_speed_hz(unsigned int usb_rate)
240 return (usb_rate * 125 + (1 << 9)) >> 10;
245 * prepare urb for full speed capture sync pipe
247 * fill the length and offset of each urb descriptor.
248 * the fixed 10.14 frequency is passed through the pipe.
250 static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
251 struct snd_pcm_runtime *runtime,
252 struct urb *urb)
254 unsigned char *cp = urb->transfer_buffer;
255 struct snd_urb_ctx *ctx = urb->context;
257 urb->dev = ctx->subs->dev; /* we need to set this at each time */
258 urb->iso_frame_desc[0].length = 3;
259 urb->iso_frame_desc[0].offset = 0;
260 cp[0] = subs->freqn >> 2;
261 cp[1] = subs->freqn >> 10;
262 cp[2] = subs->freqn >> 18;
263 return 0;
267 * prepare urb for high speed capture sync pipe
269 * fill the length and offset of each urb descriptor.
270 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
272 static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
273 struct snd_pcm_runtime *runtime,
274 struct urb *urb)
276 unsigned char *cp = urb->transfer_buffer;
277 struct snd_urb_ctx *ctx = urb->context;
279 urb->dev = ctx->subs->dev; /* we need to set this at each time */
280 urb->iso_frame_desc[0].length = 4;
281 urb->iso_frame_desc[0].offset = 0;
282 cp[0] = subs->freqn;
283 cp[1] = subs->freqn >> 8;
284 cp[2] = subs->freqn >> 16;
285 cp[3] = subs->freqn >> 24;
286 return 0;
290 * process after capture sync complete
291 * - nothing to do
293 static int retire_capture_sync_urb(struct snd_usb_substream *subs,
294 struct snd_pcm_runtime *runtime,
295 struct urb *urb)
297 return 0;
301 * prepare urb for capture data pipe
303 * fill the offset and length of each descriptor.
305 * we use a temporary buffer to write the captured data.
306 * since the length of written data is determined by host, we cannot
307 * write onto the pcm buffer directly... the data is thus copied
308 * later at complete callback to the global buffer.
310 static int prepare_capture_urb(struct snd_usb_substream *subs,
311 struct snd_pcm_runtime *runtime,
312 struct urb *urb)
314 int i, offs;
315 struct snd_urb_ctx *ctx = urb->context;
317 offs = 0;
318 urb->dev = ctx->subs->dev; /* we need to set this at each time */
319 for (i = 0; i < ctx->packets; i++) {
320 urb->iso_frame_desc[i].offset = offs;
321 urb->iso_frame_desc[i].length = subs->curpacksize;
322 offs += subs->curpacksize;
324 urb->transfer_buffer_length = offs;
325 urb->number_of_packets = ctx->packets;
326 return 0;
330 * process after capture complete
332 * copy the data from each desctiptor to the pcm buffer, and
333 * update the current position.
335 static int retire_capture_urb(struct snd_usb_substream *subs,
336 struct snd_pcm_runtime *runtime,
337 struct urb *urb)
339 unsigned long flags;
340 unsigned char *cp;
341 int i;
342 unsigned int stride, len, oldptr;
343 int period_elapsed = 0;
345 stride = runtime->frame_bits >> 3;
347 for (i = 0; i < urb->number_of_packets; i++) {
348 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
349 if (urb->iso_frame_desc[i].status) {
350 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
351 // continue;
353 len = urb->iso_frame_desc[i].actual_length / stride;
354 if (! len)
355 continue;
356 /* update the current pointer */
357 spin_lock_irqsave(&subs->lock, flags);
358 oldptr = subs->hwptr_done;
359 subs->hwptr_done += len;
360 if (subs->hwptr_done >= runtime->buffer_size)
361 subs->hwptr_done -= runtime->buffer_size;
362 subs->transfer_done += len;
363 if (subs->transfer_done >= runtime->period_size) {
364 subs->transfer_done -= runtime->period_size;
365 period_elapsed = 1;
367 spin_unlock_irqrestore(&subs->lock, flags);
368 /* copy a data chunk */
369 if (oldptr + len > runtime->buffer_size) {
370 unsigned int cnt = runtime->buffer_size - oldptr;
371 unsigned int blen = cnt * stride;
372 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
373 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
374 } else {
375 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
378 if (period_elapsed)
379 snd_pcm_period_elapsed(subs->pcm_substream);
380 return 0;
384 * Process after capture complete when paused. Nothing to do.
386 static int retire_paused_capture_urb(struct snd_usb_substream *subs,
387 struct snd_pcm_runtime *runtime,
388 struct urb *urb)
390 return 0;
395 * prepare urb for full speed playback sync pipe
397 * set up the offset and length to receive the current frequency.
400 static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
401 struct snd_pcm_runtime *runtime,
402 struct urb *urb)
404 struct snd_urb_ctx *ctx = urb->context;
406 urb->dev = ctx->subs->dev; /* we need to set this at each time */
407 urb->iso_frame_desc[0].length = 3;
408 urb->iso_frame_desc[0].offset = 0;
409 return 0;
413 * prepare urb for high speed playback sync pipe
415 * set up the offset and length to receive the current frequency.
418 static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
419 struct snd_pcm_runtime *runtime,
420 struct urb *urb)
422 struct snd_urb_ctx *ctx = urb->context;
424 urb->dev = ctx->subs->dev; /* we need to set this at each time */
425 urb->iso_frame_desc[0].length = 4;
426 urb->iso_frame_desc[0].offset = 0;
427 return 0;
431 * process after full speed playback sync complete
433 * retrieve the current 10.14 frequency from pipe, and set it.
434 * the value is referred in prepare_playback_urb().
436 static int retire_playback_sync_urb(struct snd_usb_substream *subs,
437 struct snd_pcm_runtime *runtime,
438 struct urb *urb)
440 unsigned int f;
441 unsigned long flags;
443 if (urb->iso_frame_desc[0].status == 0 &&
444 urb->iso_frame_desc[0].actual_length == 3) {
445 f = combine_triple((u8*)urb->transfer_buffer) << 2;
446 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
447 spin_lock_irqsave(&subs->lock, flags);
448 subs->freqm = f;
449 spin_unlock_irqrestore(&subs->lock, flags);
453 return 0;
457 * process after high speed playback sync complete
459 * retrieve the current 12.13 frequency from pipe, and set it.
460 * the value is referred in prepare_playback_urb().
462 static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
463 struct snd_pcm_runtime *runtime,
464 struct urb *urb)
466 unsigned int f;
467 unsigned long flags;
469 if (urb->iso_frame_desc[0].status == 0 &&
470 urb->iso_frame_desc[0].actual_length == 4) {
471 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
472 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
473 spin_lock_irqsave(&subs->lock, flags);
474 subs->freqm = f;
475 spin_unlock_irqrestore(&subs->lock, flags);
479 return 0;
482 /* determine the number of frames in the next packet */
483 static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
485 if (subs->fill_max)
486 return subs->maxframesize;
487 else {
488 subs->phase = (subs->phase & 0xffff)
489 + (subs->freqm << subs->datainterval);
490 return min(subs->phase >> 16, subs->maxframesize);
495 * Prepare urb for streaming before playback starts or when paused.
497 * We don't have any data, so we send a frame of silence.
499 static int prepare_nodata_playback_urb(struct snd_usb_substream *subs,
500 struct snd_pcm_runtime *runtime,
501 struct urb *urb)
503 unsigned int i, offs, counts;
504 struct snd_urb_ctx *ctx = urb->context;
505 int stride = runtime->frame_bits >> 3;
507 offs = 0;
508 urb->dev = ctx->subs->dev;
509 urb->number_of_packets = subs->packs_per_ms;
510 for (i = 0; i < subs->packs_per_ms; ++i) {
511 counts = snd_usb_audio_next_packet_size(subs);
512 urb->iso_frame_desc[i].offset = offs * stride;
513 urb->iso_frame_desc[i].length = counts * stride;
514 offs += counts;
516 urb->transfer_buffer_length = offs * stride;
517 memset(urb->transfer_buffer,
518 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
519 offs * stride);
520 return 0;
524 * prepare urb for playback data pipe
526 * Since a URB can handle only a single linear buffer, we must use double
527 * buffering when the data to be transferred overflows the buffer boundary.
528 * To avoid inconsistencies when updating hwptr_done, we use double buffering
529 * for all URBs.
531 static int prepare_playback_urb(struct snd_usb_substream *subs,
532 struct snd_pcm_runtime *runtime,
533 struct urb *urb)
535 int i, stride, offs;
536 unsigned int counts;
537 unsigned long flags;
538 int period_elapsed = 0;
539 struct snd_urb_ctx *ctx = urb->context;
541 stride = runtime->frame_bits >> 3;
543 offs = 0;
544 urb->dev = ctx->subs->dev; /* we need to set this at each time */
545 urb->number_of_packets = 0;
546 spin_lock_irqsave(&subs->lock, flags);
547 for (i = 0; i < ctx->packets; i++) {
548 counts = snd_usb_audio_next_packet_size(subs);
549 /* set up descriptor */
550 urb->iso_frame_desc[i].offset = offs * stride;
551 urb->iso_frame_desc[i].length = counts * stride;
552 offs += counts;
553 urb->number_of_packets++;
554 subs->transfer_done += counts;
555 if (subs->transfer_done >= runtime->period_size) {
556 subs->transfer_done -= runtime->period_size;
557 period_elapsed = 1;
558 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
559 if (subs->transfer_done > 0) {
560 /* FIXME: fill-max mode is not
561 * supported yet */
562 offs -= subs->transfer_done;
563 counts -= subs->transfer_done;
564 urb->iso_frame_desc[i].length =
565 counts * stride;
566 subs->transfer_done = 0;
568 i++;
569 if (i < ctx->packets) {
570 /* add a transfer delimiter */
571 urb->iso_frame_desc[i].offset =
572 offs * stride;
573 urb->iso_frame_desc[i].length = 0;
574 urb->number_of_packets++;
576 break;
579 /* finish at the frame boundary at/after the period boundary */
580 if (period_elapsed &&
581 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
582 break;
584 if (subs->hwptr_done + offs > runtime->buffer_size) {
585 /* err, the transferred area goes over buffer boundary. */
586 unsigned int len = runtime->buffer_size - subs->hwptr_done;
587 memcpy(urb->transfer_buffer,
588 runtime->dma_area + subs->hwptr_done * stride,
589 len * stride);
590 memcpy(urb->transfer_buffer + len * stride,
591 runtime->dma_area,
592 (offs - len) * stride);
593 } else {
594 memcpy(urb->transfer_buffer,
595 runtime->dma_area + subs->hwptr_done * stride,
596 offs * stride);
598 subs->hwptr_done += offs;
599 if (subs->hwptr_done >= runtime->buffer_size)
600 subs->hwptr_done -= runtime->buffer_size;
601 spin_unlock_irqrestore(&subs->lock, flags);
602 urb->transfer_buffer_length = offs * stride;
603 if (period_elapsed)
604 snd_pcm_period_elapsed(subs->pcm_substream);
605 return 0;
609 * process after playback data complete
610 * - nothing to do
612 static int retire_playback_urb(struct snd_usb_substream *subs,
613 struct snd_pcm_runtime *runtime,
614 struct urb *urb)
616 return 0;
622 static struct snd_urb_ops audio_urb_ops[2] = {
624 .prepare = prepare_nodata_playback_urb,
625 .retire = retire_playback_urb,
626 .prepare_sync = prepare_playback_sync_urb,
627 .retire_sync = retire_playback_sync_urb,
630 .prepare = prepare_capture_urb,
631 .retire = retire_capture_urb,
632 .prepare_sync = prepare_capture_sync_urb,
633 .retire_sync = retire_capture_sync_urb,
637 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
639 .prepare = prepare_nodata_playback_urb,
640 .retire = retire_playback_urb,
641 .prepare_sync = prepare_playback_sync_urb_hs,
642 .retire_sync = retire_playback_sync_urb_hs,
645 .prepare = prepare_capture_urb,
646 .retire = retire_capture_urb,
647 .prepare_sync = prepare_capture_sync_urb_hs,
648 .retire_sync = retire_capture_sync_urb,
653 * complete callback from data urb
655 static void snd_complete_urb(struct urb *urb)
657 struct snd_urb_ctx *ctx = urb->context;
658 struct snd_usb_substream *subs = ctx->subs;
659 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
660 int err = 0;
662 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
663 ! subs->running || /* can be stopped during retire callback */
664 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
665 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
666 clear_bit(ctx->index, &subs->active_mask);
667 if (err < 0) {
668 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
669 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
676 * complete callback from sync urb
678 static void snd_complete_sync_urb(struct urb *urb)
680 struct snd_urb_ctx *ctx = urb->context;
681 struct snd_usb_substream *subs = ctx->subs;
682 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
683 int err = 0;
685 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
686 ! subs->running || /* can be stopped during retire callback */
687 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
688 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
689 clear_bit(ctx->index + 16, &subs->active_mask);
690 if (err < 0) {
691 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
692 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
698 /* get the physical page pointer at the given offset */
699 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
700 unsigned long offset)
702 void *pageptr = subs->runtime->dma_area + offset;
703 return vmalloc_to_page(pageptr);
706 /* allocate virtual buffer; may be called more than once */
707 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
709 struct snd_pcm_runtime *runtime = subs->runtime;
710 if (runtime->dma_area) {
711 if (runtime->dma_bytes >= size)
712 return 0; /* already large enough */
713 vfree(runtime->dma_area);
715 runtime->dma_area = vmalloc(size);
716 if (! runtime->dma_area)
717 return -ENOMEM;
718 runtime->dma_bytes = size;
719 return 0;
722 /* free virtual buffer; may be called more than once */
723 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
725 struct snd_pcm_runtime *runtime = subs->runtime;
727 vfree(runtime->dma_area);
728 runtime->dma_area = NULL;
729 return 0;
734 * unlink active urbs.
736 static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
738 unsigned int i;
739 int async;
741 subs->running = 0;
743 if (!force && subs->stream->chip->shutdown) /* to be sure... */
744 return -EBADFD;
746 async = !can_sleep && async_unlink;
748 if (! async && in_interrupt())
749 return 0;
751 for (i = 0; i < subs->nurbs; i++) {
752 if (test_bit(i, &subs->active_mask)) {
753 if (! test_and_set_bit(i, &subs->unlink_mask)) {
754 struct urb *u = subs->dataurb[i].urb;
755 if (async)
756 usb_unlink_urb(u);
757 else
758 usb_kill_urb(u);
762 if (subs->syncpipe) {
763 for (i = 0; i < SYNC_URBS; i++) {
764 if (test_bit(i+16, &subs->active_mask)) {
765 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
766 struct urb *u = subs->syncurb[i].urb;
767 if (async)
768 usb_unlink_urb(u);
769 else
770 usb_kill_urb(u);
775 return 0;
779 static const char *usb_error_string(int err)
781 switch (err) {
782 case -ENODEV:
783 return "no device";
784 case -ENOENT:
785 return "endpoint not enabled";
786 case -EPIPE:
787 return "endpoint stalled";
788 case -ENOSPC:
789 return "not enough bandwidth";
790 case -ESHUTDOWN:
791 return "device disabled";
792 case -EHOSTUNREACH:
793 return "device suspended";
794 #ifndef CONFIG_USB_EHCI_SPLIT_ISO
795 case -ENOSYS:
796 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
797 #endif
798 case -EINVAL:
799 case -EAGAIN:
800 case -EFBIG:
801 case -EMSGSIZE:
802 return "internal error";
803 default:
804 return "unknown error";
809 * set up and start data/sync urbs
811 static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
813 unsigned int i;
814 int err;
816 if (subs->stream->chip->shutdown)
817 return -EBADFD;
819 for (i = 0; i < subs->nurbs; i++) {
820 snd_assert(subs->dataurb[i].urb, return -EINVAL);
821 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
822 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
823 goto __error;
826 if (subs->syncpipe) {
827 for (i = 0; i < SYNC_URBS; i++) {
828 snd_assert(subs->syncurb[i].urb, return -EINVAL);
829 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
830 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
831 goto __error;
836 subs->active_mask = 0;
837 subs->unlink_mask = 0;
838 subs->running = 1;
839 for (i = 0; i < subs->nurbs; i++) {
840 err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
841 if (err < 0) {
842 snd_printk(KERN_ERR "cannot submit datapipe "
843 "for urb %d, error %d: %s\n",
844 i, err, usb_error_string(err));
845 goto __error;
847 set_bit(i, &subs->active_mask);
849 if (subs->syncpipe) {
850 for (i = 0; i < SYNC_URBS; i++) {
851 err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
852 if (err < 0) {
853 snd_printk(KERN_ERR "cannot submit syncpipe "
854 "for urb %d, error %d: %s\n",
855 i, err, usb_error_string(err));
856 goto __error;
858 set_bit(i + 16, &subs->active_mask);
861 return 0;
863 __error:
864 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
865 deactivate_urbs(subs, 0, 0);
866 return -EPIPE;
871 * wait until all urbs are processed.
873 static int wait_clear_urbs(struct snd_usb_substream *subs)
875 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
876 unsigned int i;
877 int alive;
879 do {
880 alive = 0;
881 for (i = 0; i < subs->nurbs; i++) {
882 if (test_bit(i, &subs->active_mask))
883 alive++;
885 if (subs->syncpipe) {
886 for (i = 0; i < SYNC_URBS; i++) {
887 if (test_bit(i + 16, &subs->active_mask))
888 alive++;
891 if (! alive)
892 break;
893 schedule_timeout_uninterruptible(1);
894 } while (time_before(jiffies, end_time));
895 if (alive)
896 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
897 return 0;
902 * return the current pcm pointer. just return the hwptr_done value.
904 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
906 struct snd_usb_substream *subs;
907 snd_pcm_uframes_t hwptr_done;
909 subs = (struct snd_usb_substream *)substream->runtime->private_data;
910 spin_lock(&subs->lock);
911 hwptr_done = subs->hwptr_done;
912 spin_unlock(&subs->lock);
913 return hwptr_done;
918 * start/stop playback substream
920 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
921 int cmd)
923 struct snd_usb_substream *subs = substream->runtime->private_data;
925 switch (cmd) {
926 case SNDRV_PCM_TRIGGER_START:
927 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
928 subs->ops.prepare = prepare_playback_urb;
929 return 0;
930 case SNDRV_PCM_TRIGGER_STOP:
931 return deactivate_urbs(subs, 0, 0);
932 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
933 subs->ops.prepare = prepare_nodata_playback_urb;
934 return 0;
935 default:
936 return -EINVAL;
941 * start/stop capture substream
943 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
944 int cmd)
946 struct snd_usb_substream *subs = substream->runtime->private_data;
948 switch (cmd) {
949 case SNDRV_PCM_TRIGGER_START:
950 subs->ops.retire = retire_capture_urb;
951 return start_urbs(subs, substream->runtime);
952 case SNDRV_PCM_TRIGGER_STOP:
953 return deactivate_urbs(subs, 0, 0);
954 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
955 subs->ops.retire = retire_paused_capture_urb;
956 return 0;
957 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
958 subs->ops.retire = retire_capture_urb;
959 return 0;
960 default:
961 return -EINVAL;
967 * release a urb data
969 static void release_urb_ctx(struct snd_urb_ctx *u)
971 if (u->urb) {
972 if (u->buffer_size)
973 usb_buffer_free(u->subs->dev, u->buffer_size,
974 u->urb->transfer_buffer,
975 u->urb->transfer_dma);
976 usb_free_urb(u->urb);
977 u->urb = NULL;
982 * release a substream
984 static void release_substream_urbs(struct snd_usb_substream *subs, int force)
986 int i;
988 /* stop urbs (to be sure) */
989 deactivate_urbs(subs, force, 1);
990 wait_clear_urbs(subs);
992 for (i = 0; i < MAX_URBS; i++)
993 release_urb_ctx(&subs->dataurb[i]);
994 for (i = 0; i < SYNC_URBS; i++)
995 release_urb_ctx(&subs->syncurb[i]);
996 usb_buffer_free(subs->dev, SYNC_URBS * 4,
997 subs->syncbuf, subs->sync_dma);
998 subs->syncbuf = NULL;
999 subs->nurbs = 0;
1003 * initialize a substream for plaback/capture
1005 static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
1006 unsigned int rate, unsigned int frame_bits)
1008 unsigned int maxsize, n, i;
1009 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1010 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
1012 /* calculate the frequency in 16.16 format */
1013 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1014 subs->freqn = get_usb_full_speed_rate(rate);
1015 else
1016 subs->freqn = get_usb_high_speed_rate(rate);
1017 subs->freqm = subs->freqn;
1018 /* calculate max. frequency */
1019 if (subs->maxpacksize) {
1020 /* whatever fits into a max. size packet */
1021 maxsize = subs->maxpacksize;
1022 subs->freqmax = (maxsize / (frame_bits >> 3))
1023 << (16 - subs->datainterval);
1024 } else {
1025 /* no max. packet size: just take 25% higher than nominal */
1026 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1027 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1028 >> (16 - subs->datainterval);
1030 subs->phase = 0;
1032 if (subs->fill_max)
1033 subs->curpacksize = subs->maxpacksize;
1034 else
1035 subs->curpacksize = maxsize;
1037 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1038 packs_per_ms = 8 >> subs->datainterval;
1039 else
1040 packs_per_ms = 1;
1041 subs->packs_per_ms = packs_per_ms;
1043 if (is_playback) {
1044 urb_packs = nrpacks;
1045 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1046 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1047 } else
1048 urb_packs = 1;
1049 urb_packs *= packs_per_ms;
1051 /* decide how many packets to be used */
1052 if (is_playback) {
1053 unsigned int minsize;
1054 /* determine how small a packet can be */
1055 minsize = (subs->freqn >> (16 - subs->datainterval))
1056 * (frame_bits >> 3);
1057 /* with sync from device, assume it can be 12% lower */
1058 if (subs->syncpipe)
1059 minsize -= minsize >> 3;
1060 minsize = max(minsize, 1u);
1061 total_packs = (period_bytes + minsize - 1) / minsize;
1062 /* round up to multiple of packs_per_ms */
1063 total_packs = (total_packs + packs_per_ms - 1)
1064 & ~(packs_per_ms - 1);
1065 /* we need at least two URBs for queueing */
1066 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1067 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
1068 } else {
1069 total_packs = MAX_URBS * urb_packs;
1071 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1072 if (subs->nurbs > MAX_URBS) {
1073 /* too much... */
1074 subs->nurbs = MAX_URBS;
1075 total_packs = MAX_URBS * urb_packs;
1077 n = total_packs;
1078 for (i = 0; i < subs->nurbs; i++) {
1079 npacks[i] = n > urb_packs ? urb_packs : n;
1080 n -= urb_packs;
1082 if (subs->nurbs <= 1) {
1083 /* too little - we need at least two packets
1084 * to ensure contiguous playback/capture
1086 subs->nurbs = 2;
1087 npacks[0] = (total_packs + 1) / 2;
1088 npacks[1] = total_packs - npacks[0];
1089 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1090 /* the last packet is too small.. */
1091 if (subs->nurbs > 2) {
1092 /* merge to the first one */
1093 npacks[0] += npacks[subs->nurbs - 1];
1094 subs->nurbs--;
1095 } else {
1096 /* divide to two */
1097 subs->nurbs = 2;
1098 npacks[0] = (total_packs + 1) / 2;
1099 npacks[1] = total_packs - npacks[0];
1103 /* allocate and initialize data urbs */
1104 for (i = 0; i < subs->nurbs; i++) {
1105 struct snd_urb_ctx *u = &subs->dataurb[i];
1106 u->index = i;
1107 u->subs = subs;
1108 u->packets = npacks[i];
1109 u->buffer_size = maxsize * u->packets;
1110 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1111 u->packets++; /* for transfer delimiter */
1112 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1113 if (! u->urb)
1114 goto out_of_memory;
1115 u->urb->transfer_buffer =
1116 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1117 &u->urb->transfer_dma);
1118 if (! u->urb->transfer_buffer)
1119 goto out_of_memory;
1120 u->urb->pipe = subs->datapipe;
1121 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1122 u->urb->interval = 1 << subs->datainterval;
1123 u->urb->context = u;
1124 u->urb->complete = snd_complete_urb;
1127 if (subs->syncpipe) {
1128 /* allocate and initialize sync urbs */
1129 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1130 GFP_KERNEL, &subs->sync_dma);
1131 if (! subs->syncbuf)
1132 goto out_of_memory;
1133 for (i = 0; i < SYNC_URBS; i++) {
1134 struct snd_urb_ctx *u = &subs->syncurb[i];
1135 u->index = i;
1136 u->subs = subs;
1137 u->packets = 1;
1138 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1139 if (! u->urb)
1140 goto out_of_memory;
1141 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1142 u->urb->transfer_dma = subs->sync_dma + i * 4;
1143 u->urb->transfer_buffer_length = 4;
1144 u->urb->pipe = subs->syncpipe;
1145 u->urb->transfer_flags = URB_ISO_ASAP |
1146 URB_NO_TRANSFER_DMA_MAP;
1147 u->urb->number_of_packets = 1;
1148 u->urb->interval = 1 << subs->syncinterval;
1149 u->urb->context = u;
1150 u->urb->complete = snd_complete_sync_urb;
1153 return 0;
1155 out_of_memory:
1156 release_substream_urbs(subs, 0);
1157 return -ENOMEM;
1162 * find a matching audio format
1164 static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
1165 unsigned int rate, unsigned int channels)
1167 struct list_head *p;
1168 struct audioformat *found = NULL;
1169 int cur_attr = 0, attr;
1171 list_for_each(p, &subs->fmt_list) {
1172 struct audioformat *fp;
1173 fp = list_entry(p, struct audioformat, list);
1174 if (fp->format != format || fp->channels != channels)
1175 continue;
1176 if (rate < fp->rate_min || rate > fp->rate_max)
1177 continue;
1178 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1179 unsigned int i;
1180 for (i = 0; i < fp->nr_rates; i++)
1181 if (fp->rate_table[i] == rate)
1182 break;
1183 if (i >= fp->nr_rates)
1184 continue;
1186 attr = fp->ep_attr & EP_ATTR_MASK;
1187 if (! found) {
1188 found = fp;
1189 cur_attr = attr;
1190 continue;
1192 /* avoid async out and adaptive in if the other method
1193 * supports the same format.
1194 * this is a workaround for the case like
1195 * M-audio audiophile USB.
1197 if (attr != cur_attr) {
1198 if ((attr == EP_ATTR_ASYNC &&
1199 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1200 (attr == EP_ATTR_ADAPTIVE &&
1201 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1202 continue;
1203 if ((cur_attr == EP_ATTR_ASYNC &&
1204 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1205 (cur_attr == EP_ATTR_ADAPTIVE &&
1206 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1207 found = fp;
1208 cur_attr = attr;
1209 continue;
1212 /* find the format with the largest max. packet size */
1213 if (fp->maxpacksize > found->maxpacksize) {
1214 found = fp;
1215 cur_attr = attr;
1218 return found;
1223 * initialize the picth control and sample rate
1225 static int init_usb_pitch(struct usb_device *dev, int iface,
1226 struct usb_host_interface *alts,
1227 struct audioformat *fmt)
1229 unsigned int ep;
1230 unsigned char data[1];
1231 int err;
1233 ep = get_endpoint(alts, 0)->bEndpointAddress;
1234 /* if endpoint has pitch control, enable it */
1235 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1236 data[0] = 1;
1237 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1238 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1239 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1240 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1241 dev->devnum, iface, ep);
1242 return err;
1245 return 0;
1248 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1249 struct usb_host_interface *alts,
1250 struct audioformat *fmt, int rate)
1252 unsigned int ep;
1253 unsigned char data[3];
1254 int err;
1256 ep = get_endpoint(alts, 0)->bEndpointAddress;
1257 /* if endpoint has sampling rate control, set it */
1258 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1259 int crate;
1260 data[0] = rate;
1261 data[1] = rate >> 8;
1262 data[2] = rate >> 16;
1263 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1264 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1265 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1266 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1267 dev->devnum, iface, fmt->altsetting, rate, ep);
1268 return err;
1270 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1271 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1272 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1273 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1274 dev->devnum, iface, fmt->altsetting, ep);
1275 return 0; /* some devices don't support reading */
1277 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1278 if (crate != rate) {
1279 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1280 // runtime->rate = crate;
1283 return 0;
1287 * find a matching format and set up the interface
1289 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
1291 struct usb_device *dev = subs->dev;
1292 struct usb_host_interface *alts;
1293 struct usb_interface_descriptor *altsd;
1294 struct usb_interface *iface;
1295 unsigned int ep, attr;
1296 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1297 int err;
1299 iface = usb_ifnum_to_if(dev, fmt->iface);
1300 snd_assert(iface, return -EINVAL);
1301 alts = &iface->altsetting[fmt->altset_idx];
1302 altsd = get_iface_desc(alts);
1303 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1305 if (fmt == subs->cur_audiofmt)
1306 return 0;
1308 /* close the old interface */
1309 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1310 if (usb_set_interface(subs->dev, subs->interface, 0) < 0) {
1311 snd_printk(KERN_ERR "%d:%d:%d: return to setting 0 failed\n",
1312 dev->devnum, fmt->iface, fmt->altsetting);
1313 return -EIO;
1315 subs->interface = -1;
1316 subs->format = 0;
1319 /* set interface */
1320 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1321 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1322 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1323 dev->devnum, fmt->iface, fmt->altsetting);
1324 return -EIO;
1326 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1327 subs->interface = fmt->iface;
1328 subs->format = fmt->altset_idx;
1331 /* create a data pipe */
1332 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1333 if (is_playback)
1334 subs->datapipe = usb_sndisocpipe(dev, ep);
1335 else
1336 subs->datapipe = usb_rcvisocpipe(dev, ep);
1337 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1338 get_endpoint(alts, 0)->bInterval >= 1 &&
1339 get_endpoint(alts, 0)->bInterval <= 4)
1340 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1341 else
1342 subs->datainterval = 0;
1343 subs->syncpipe = subs->syncinterval = 0;
1344 subs->maxpacksize = fmt->maxpacksize;
1345 subs->fill_max = 0;
1347 /* we need a sync pipe in async OUT or adaptive IN mode */
1348 /* check the number of EP, since some devices have broken
1349 * descriptors which fool us. if it has only one EP,
1350 * assume it as adaptive-out or sync-in.
1352 attr = fmt->ep_attr & EP_ATTR_MASK;
1353 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1354 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1355 altsd->bNumEndpoints >= 2) {
1356 /* check sync-pipe endpoint */
1357 /* ... and check descriptor size before accessing bSynchAddress
1358 because there is a version of the SB Audigy 2 NX firmware lacking
1359 the audio fields in the endpoint descriptors */
1360 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1361 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1362 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1363 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1364 dev->devnum, fmt->iface, fmt->altsetting);
1365 return -EINVAL;
1367 ep = get_endpoint(alts, 1)->bEndpointAddress;
1368 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1369 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1370 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1371 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1372 dev->devnum, fmt->iface, fmt->altsetting);
1373 return -EINVAL;
1375 ep &= USB_ENDPOINT_NUMBER_MASK;
1376 if (is_playback)
1377 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1378 else
1379 subs->syncpipe = usb_sndisocpipe(dev, ep);
1380 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1381 get_endpoint(alts, 1)->bRefresh >= 1 &&
1382 get_endpoint(alts, 1)->bRefresh <= 9)
1383 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1384 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1385 subs->syncinterval = 1;
1386 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1387 get_endpoint(alts, 1)->bInterval <= 16)
1388 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1389 else
1390 subs->syncinterval = 3;
1393 /* always fill max packet size */
1394 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1395 subs->fill_max = 1;
1397 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1398 return err;
1400 subs->cur_audiofmt = fmt;
1402 #if 0
1403 printk("setting done: format = %d, rate = %d, channels = %d\n",
1404 fmt->format, fmt->rate, fmt->channels);
1405 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1406 subs->datapipe, subs->syncpipe);
1407 #endif
1409 return 0;
1413 * hw_params callback
1415 * allocate a buffer and set the given audio format.
1417 * so far we use a physically linear buffer although packetize transfer
1418 * doesn't need a continuous area.
1419 * if sg buffer is supported on the later version of alsa, we'll follow
1420 * that.
1422 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1423 struct snd_pcm_hw_params *hw_params)
1425 struct snd_usb_substream *subs = substream->runtime->private_data;
1426 struct audioformat *fmt;
1427 unsigned int channels, rate, format;
1428 int ret, changed;
1430 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1431 params_buffer_bytes(hw_params));
1432 if (ret < 0)
1433 return ret;
1435 format = params_format(hw_params);
1436 rate = params_rate(hw_params);
1437 channels = params_channels(hw_params);
1438 fmt = find_format(subs, format, rate, channels);
1439 if (! fmt) {
1440 snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1441 format, rate, channels);
1442 return -EINVAL;
1445 changed = subs->cur_audiofmt != fmt ||
1446 subs->period_bytes != params_period_bytes(hw_params) ||
1447 subs->cur_rate != rate;
1448 if ((ret = set_format(subs, fmt)) < 0)
1449 return ret;
1451 if (subs->cur_rate != rate) {
1452 struct usb_host_interface *alts;
1453 struct usb_interface *iface;
1454 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1455 alts = &iface->altsetting[fmt->altset_idx];
1456 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1457 if (ret < 0)
1458 return ret;
1459 subs->cur_rate = rate;
1462 if (changed) {
1463 /* format changed */
1464 release_substream_urbs(subs, 0);
1465 /* influenced: period_bytes, channels, rate, format, */
1466 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1467 params_rate(hw_params),
1468 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1471 return ret;
1475 * hw_free callback
1477 * reset the audio format and release the buffer
1479 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
1481 struct snd_usb_substream *subs = substream->runtime->private_data;
1483 subs->cur_audiofmt = NULL;
1484 subs->cur_rate = 0;
1485 subs->period_bytes = 0;
1486 if (!subs->stream->chip->shutdown)
1487 release_substream_urbs(subs, 0);
1488 return snd_pcm_free_vmalloc_buffer(substream);
1492 * prepare callback
1494 * only a few subtle things...
1496 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
1498 struct snd_pcm_runtime *runtime = substream->runtime;
1499 struct snd_usb_substream *subs = runtime->private_data;
1501 if (! subs->cur_audiofmt) {
1502 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1503 return -ENXIO;
1506 /* some unit conversions in runtime */
1507 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1508 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1510 /* reset the pointer */
1511 subs->hwptr_done = 0;
1512 subs->transfer_done = 0;
1513 subs->phase = 0;
1515 /* clear urbs (to be sure) */
1516 deactivate_urbs(subs, 0, 1);
1517 wait_clear_urbs(subs);
1519 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1520 * updates for all URBs would happen at the same time when starting */
1521 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1522 subs->ops.prepare = prepare_nodata_playback_urb;
1523 return start_urbs(subs, runtime);
1524 } else
1525 return 0;
1528 static struct snd_pcm_hardware snd_usb_hardware =
1530 .info = SNDRV_PCM_INFO_MMAP |
1531 SNDRV_PCM_INFO_MMAP_VALID |
1532 SNDRV_PCM_INFO_BATCH |
1533 SNDRV_PCM_INFO_INTERLEAVED |
1534 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1535 SNDRV_PCM_INFO_PAUSE,
1536 .buffer_bytes_max = 1024 * 1024,
1537 .period_bytes_min = 64,
1538 .period_bytes_max = 512 * 1024,
1539 .periods_min = 2,
1540 .periods_max = 1024,
1544 * h/w constraints
1547 #ifdef HW_CONST_DEBUG
1548 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1549 #else
1550 #define hwc_debug(fmt, args...) /**/
1551 #endif
1553 static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
1555 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1556 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1557 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1559 /* check the format */
1560 if (! snd_mask_test(fmts, fp->format)) {
1561 hwc_debug(" > check: no supported format %d\n", fp->format);
1562 return 0;
1564 /* check the channels */
1565 if (fp->channels < ct->min || fp->channels > ct->max) {
1566 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1567 return 0;
1569 /* check the rate is within the range */
1570 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1571 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1572 return 0;
1574 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1575 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1576 return 0;
1578 return 1;
1581 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1582 struct snd_pcm_hw_rule *rule)
1584 struct snd_usb_substream *subs = rule->private;
1585 struct list_head *p;
1586 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1587 unsigned int rmin, rmax;
1588 int changed;
1590 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1591 changed = 0;
1592 rmin = rmax = 0;
1593 list_for_each(p, &subs->fmt_list) {
1594 struct audioformat *fp;
1595 fp = list_entry(p, struct audioformat, list);
1596 if (! hw_check_valid_format(params, fp))
1597 continue;
1598 if (changed++) {
1599 if (rmin > fp->rate_min)
1600 rmin = fp->rate_min;
1601 if (rmax < fp->rate_max)
1602 rmax = fp->rate_max;
1603 } else {
1604 rmin = fp->rate_min;
1605 rmax = fp->rate_max;
1609 if (! changed) {
1610 hwc_debug(" --> get empty\n");
1611 it->empty = 1;
1612 return -EINVAL;
1615 changed = 0;
1616 if (it->min < rmin) {
1617 it->min = rmin;
1618 it->openmin = 0;
1619 changed = 1;
1621 if (it->max > rmax) {
1622 it->max = rmax;
1623 it->openmax = 0;
1624 changed = 1;
1626 if (snd_interval_checkempty(it)) {
1627 it->empty = 1;
1628 return -EINVAL;
1630 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1631 return changed;
1635 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1636 struct snd_pcm_hw_rule *rule)
1638 struct snd_usb_substream *subs = rule->private;
1639 struct list_head *p;
1640 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1641 unsigned int rmin, rmax;
1642 int changed;
1644 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1645 changed = 0;
1646 rmin = rmax = 0;
1647 list_for_each(p, &subs->fmt_list) {
1648 struct audioformat *fp;
1649 fp = list_entry(p, struct audioformat, list);
1650 if (! hw_check_valid_format(params, fp))
1651 continue;
1652 if (changed++) {
1653 if (rmin > fp->channels)
1654 rmin = fp->channels;
1655 if (rmax < fp->channels)
1656 rmax = fp->channels;
1657 } else {
1658 rmin = fp->channels;
1659 rmax = fp->channels;
1663 if (! changed) {
1664 hwc_debug(" --> get empty\n");
1665 it->empty = 1;
1666 return -EINVAL;
1669 changed = 0;
1670 if (it->min < rmin) {
1671 it->min = rmin;
1672 it->openmin = 0;
1673 changed = 1;
1675 if (it->max > rmax) {
1676 it->max = rmax;
1677 it->openmax = 0;
1678 changed = 1;
1680 if (snd_interval_checkempty(it)) {
1681 it->empty = 1;
1682 return -EINVAL;
1684 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1685 return changed;
1688 static int hw_rule_format(struct snd_pcm_hw_params *params,
1689 struct snd_pcm_hw_rule *rule)
1691 struct snd_usb_substream *subs = rule->private;
1692 struct list_head *p;
1693 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1694 u64 fbits;
1695 u32 oldbits[2];
1696 int changed;
1698 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1699 fbits = 0;
1700 list_for_each(p, &subs->fmt_list) {
1701 struct audioformat *fp;
1702 fp = list_entry(p, struct audioformat, list);
1703 if (! hw_check_valid_format(params, fp))
1704 continue;
1705 fbits |= (1ULL << fp->format);
1708 oldbits[0] = fmt->bits[0];
1709 oldbits[1] = fmt->bits[1];
1710 fmt->bits[0] &= (u32)fbits;
1711 fmt->bits[1] &= (u32)(fbits >> 32);
1712 if (! fmt->bits[0] && ! fmt->bits[1]) {
1713 hwc_debug(" --> get empty\n");
1714 return -EINVAL;
1716 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1717 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1718 return changed;
1721 #define MAX_MASK 64
1724 * check whether the registered audio formats need special hw-constraints
1726 static int check_hw_params_convention(struct snd_usb_substream *subs)
1728 int i;
1729 u32 *channels;
1730 u32 *rates;
1731 u32 cmaster, rmaster;
1732 u32 rate_min = 0, rate_max = 0;
1733 struct list_head *p;
1734 int err = 1;
1736 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1737 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1739 list_for_each(p, &subs->fmt_list) {
1740 struct audioformat *f;
1741 f = list_entry(p, struct audioformat, list);
1742 /* unconventional channels? */
1743 if (f->channels > 32)
1744 goto __out;
1745 /* continuous rate min/max matches? */
1746 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1747 if (rate_min && f->rate_min != rate_min)
1748 goto __out;
1749 if (rate_max && f->rate_max != rate_max)
1750 goto __out;
1751 rate_min = f->rate_min;
1752 rate_max = f->rate_max;
1754 /* combination of continuous rates and fixed rates? */
1755 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1756 if (f->rates != rates[f->format])
1757 goto __out;
1759 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1760 if (rates[f->format] && rates[f->format] != f->rates)
1761 goto __out;
1763 channels[f->format] |= (1 << f->channels);
1764 rates[f->format] |= f->rates;
1765 /* needs knot? */
1766 if (f->rates & SNDRV_PCM_RATE_KNOT)
1767 goto __out;
1769 /* check whether channels and rates match for all formats */
1770 cmaster = rmaster = 0;
1771 for (i = 0; i < MAX_MASK; i++) {
1772 if (cmaster != channels[i] && cmaster && channels[i])
1773 goto __out;
1774 if (rmaster != rates[i] && rmaster && rates[i])
1775 goto __out;
1776 if (channels[i])
1777 cmaster = channels[i];
1778 if (rates[i])
1779 rmaster = rates[i];
1781 /* check whether channels match for all distinct rates */
1782 memset(channels, 0, MAX_MASK * sizeof(u32));
1783 list_for_each(p, &subs->fmt_list) {
1784 struct audioformat *f;
1785 f = list_entry(p, struct audioformat, list);
1786 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1787 continue;
1788 for (i = 0; i < 32; i++) {
1789 if (f->rates & (1 << i))
1790 channels[i] |= (1 << f->channels);
1793 cmaster = 0;
1794 for (i = 0; i < 32; i++) {
1795 if (cmaster != channels[i] && cmaster && channels[i])
1796 goto __out;
1797 if (channels[i])
1798 cmaster = channels[i];
1800 err = 0;
1802 __out:
1803 kfree(channels);
1804 kfree(rates);
1805 return err;
1809 * If the device supports unusual bit rates, does the request meet these?
1811 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1812 struct snd_usb_substream *subs)
1814 struct audioformat *fp;
1815 int count = 0, needs_knot = 0;
1816 int err;
1818 list_for_each_entry(fp, &subs->fmt_list, list) {
1819 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1820 return 0;
1821 count += fp->nr_rates;
1822 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1823 needs_knot = 1;
1825 if (!needs_knot)
1826 return 0;
1828 subs->rate_list.count = count;
1829 subs->rate_list.list = kmalloc(sizeof(int) * count, GFP_KERNEL);
1830 subs->rate_list.mask = 0;
1831 count = 0;
1832 list_for_each_entry(fp, &subs->fmt_list, list) {
1833 int i;
1834 for (i = 0; i < fp->nr_rates; i++)
1835 subs->rate_list.list[count++] = fp->rate_table[i];
1837 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1838 &subs->rate_list);
1839 if (err < 0)
1840 return err;
1842 return 0;
1847 * set up the runtime hardware information.
1850 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1852 struct list_head *p;
1853 int err;
1855 runtime->hw.formats = subs->formats;
1857 runtime->hw.rate_min = 0x7fffffff;
1858 runtime->hw.rate_max = 0;
1859 runtime->hw.channels_min = 256;
1860 runtime->hw.channels_max = 0;
1861 runtime->hw.rates = 0;
1862 /* check min/max rates and channels */
1863 list_for_each(p, &subs->fmt_list) {
1864 struct audioformat *fp;
1865 fp = list_entry(p, struct audioformat, list);
1866 runtime->hw.rates |= fp->rates;
1867 if (runtime->hw.rate_min > fp->rate_min)
1868 runtime->hw.rate_min = fp->rate_min;
1869 if (runtime->hw.rate_max < fp->rate_max)
1870 runtime->hw.rate_max = fp->rate_max;
1871 if (runtime->hw.channels_min > fp->channels)
1872 runtime->hw.channels_min = fp->channels;
1873 if (runtime->hw.channels_max < fp->channels)
1874 runtime->hw.channels_max = fp->channels;
1875 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1876 /* FIXME: there might be more than one audio formats... */
1877 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1878 fp->frame_size;
1882 /* set the period time minimum 1ms */
1883 /* FIXME: high-speed mode allows 125us minimum period, but many parts
1884 * in the current code assume the 1ms period.
1886 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1887 1000 * MIN_PACKS_URB,
1888 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1890 if (check_hw_params_convention(subs)) {
1891 hwc_debug("setting extra hw constraints...\n");
1892 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1893 hw_rule_rate, subs,
1894 SNDRV_PCM_HW_PARAM_FORMAT,
1895 SNDRV_PCM_HW_PARAM_CHANNELS,
1896 -1)) < 0)
1897 return err;
1898 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1899 hw_rule_channels, subs,
1900 SNDRV_PCM_HW_PARAM_FORMAT,
1901 SNDRV_PCM_HW_PARAM_RATE,
1902 -1)) < 0)
1903 return err;
1904 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1905 hw_rule_format, subs,
1906 SNDRV_PCM_HW_PARAM_RATE,
1907 SNDRV_PCM_HW_PARAM_CHANNELS,
1908 -1)) < 0)
1909 return err;
1910 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1911 return err;
1913 return 0;
1916 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
1918 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1919 struct snd_pcm_runtime *runtime = substream->runtime;
1920 struct snd_usb_substream *subs = &as->substream[direction];
1922 subs->interface = -1;
1923 subs->format = 0;
1924 runtime->hw = snd_usb_hardware;
1925 runtime->private_data = subs;
1926 subs->pcm_substream = substream;
1927 return setup_hw_info(runtime, subs);
1930 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1932 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1933 struct snd_usb_substream *subs = &as->substream[direction];
1935 if (subs->interface >= 0) {
1936 usb_set_interface(subs->dev, subs->interface, 0);
1937 subs->interface = -1;
1939 subs->pcm_substream = NULL;
1940 return 0;
1943 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1945 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1948 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1950 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1953 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1955 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1958 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1960 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1963 static struct snd_pcm_ops snd_usb_playback_ops = {
1964 .open = snd_usb_playback_open,
1965 .close = snd_usb_playback_close,
1966 .ioctl = snd_pcm_lib_ioctl,
1967 .hw_params = snd_usb_hw_params,
1968 .hw_free = snd_usb_hw_free,
1969 .prepare = snd_usb_pcm_prepare,
1970 .trigger = snd_usb_pcm_playback_trigger,
1971 .pointer = snd_usb_pcm_pointer,
1972 .page = snd_pcm_get_vmalloc_page,
1975 static struct snd_pcm_ops snd_usb_capture_ops = {
1976 .open = snd_usb_capture_open,
1977 .close = snd_usb_capture_close,
1978 .ioctl = snd_pcm_lib_ioctl,
1979 .hw_params = snd_usb_hw_params,
1980 .hw_free = snd_usb_hw_free,
1981 .prepare = snd_usb_pcm_prepare,
1982 .trigger = snd_usb_pcm_capture_trigger,
1983 .pointer = snd_usb_pcm_pointer,
1984 .page = snd_pcm_get_vmalloc_page,
1990 * helper functions
1994 * combine bytes and get an integer value
1996 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1998 switch (size) {
1999 case 1: return *bytes;
2000 case 2: return combine_word(bytes);
2001 case 3: return combine_triple(bytes);
2002 case 4: return combine_quad(bytes);
2003 default: return 0;
2008 * parse descriptor buffer and return the pointer starting the given
2009 * descriptor type.
2011 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
2013 u8 *p, *end, *next;
2015 p = descstart;
2016 end = p + desclen;
2017 for (; p < end;) {
2018 if (p[0] < 2)
2019 return NULL;
2020 next = p + p[0];
2021 if (next > end)
2022 return NULL;
2023 if (p[1] == dtype && (!after || (void *)p > after)) {
2024 return p;
2026 p = next;
2028 return NULL;
2032 * find a class-specified interface descriptor with the given subtype.
2034 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
2036 unsigned char *p = after;
2038 while ((p = snd_usb_find_desc(buffer, buflen, p,
2039 USB_DT_CS_INTERFACE)) != NULL) {
2040 if (p[0] >= 3 && p[2] == dsubtype)
2041 return p;
2043 return NULL;
2047 * Wrapper for usb_control_msg().
2048 * Allocates a temp buffer to prevent dmaing from/to the stack.
2050 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2051 __u8 requesttype, __u16 value, __u16 index, void *data,
2052 __u16 size, int timeout)
2054 int err;
2055 void *buf = NULL;
2057 if (size > 0) {
2058 buf = kmemdup(data, size, GFP_KERNEL);
2059 if (!buf)
2060 return -ENOMEM;
2062 err = usb_control_msg(dev, pipe, request, requesttype,
2063 value, index, buf, size, timeout);
2064 if (size > 0) {
2065 memcpy(data, buf, size);
2066 kfree(buf);
2068 return err;
2073 * entry point for linux usb interface
2076 static int usb_audio_probe(struct usb_interface *intf,
2077 const struct usb_device_id *id);
2078 static void usb_audio_disconnect(struct usb_interface *intf);
2080 #ifdef CONFIG_PM
2081 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message);
2082 static int usb_audio_resume(struct usb_interface *intf);
2083 #else
2084 #define usb_audio_suspend NULL
2085 #define usb_audio_resume NULL
2086 #endif
2088 static struct usb_device_id usb_audio_ids [] = {
2089 #include "usbquirks.h"
2090 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2091 .bInterfaceClass = USB_CLASS_AUDIO,
2092 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2093 { } /* Terminating entry */
2096 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2098 static struct usb_driver usb_audio_driver = {
2099 .name = "snd-usb-audio",
2100 .probe = usb_audio_probe,
2101 .disconnect = usb_audio_disconnect,
2102 .suspend = usb_audio_suspend,
2103 .resume = usb_audio_resume,
2104 .id_table = usb_audio_ids,
2108 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2111 * proc interface for list the supported pcm formats
2113 static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2115 struct list_head *p;
2116 static char *sync_types[4] = {
2117 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2120 list_for_each(p, &subs->fmt_list) {
2121 struct audioformat *fp;
2122 fp = list_entry(p, struct audioformat, list);
2123 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2124 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
2125 snd_iprintf(buffer, " Format: 0x%x\n", fp->format);
2126 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2127 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2128 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2129 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2130 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2131 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2132 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2133 fp->rate_min, fp->rate_max);
2134 } else {
2135 unsigned int i;
2136 snd_iprintf(buffer, " Rates: ");
2137 for (i = 0; i < fp->nr_rates; i++) {
2138 if (i > 0)
2139 snd_iprintf(buffer, ", ");
2140 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2142 snd_iprintf(buffer, "\n");
2144 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2145 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2149 static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2151 if (subs->running) {
2152 unsigned int i;
2153 snd_iprintf(buffer, " Status: Running\n");
2154 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2155 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2156 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2157 for (i = 0; i < subs->nurbs; i++)
2158 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2159 snd_iprintf(buffer, "]\n");
2160 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2161 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2162 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2163 ? get_full_speed_hz(subs->freqm)
2164 : get_high_speed_hz(subs->freqm),
2165 subs->freqm >> 16, subs->freqm & 0xffff);
2166 } else {
2167 snd_iprintf(buffer, " Status: Stop\n");
2171 static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
2173 struct snd_usb_stream *stream = entry->private_data;
2175 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2177 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2178 snd_iprintf(buffer, "\nPlayback:\n");
2179 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2180 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2182 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2183 snd_iprintf(buffer, "\nCapture:\n");
2184 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2185 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2189 static void proc_pcm_format_add(struct snd_usb_stream *stream)
2191 struct snd_info_entry *entry;
2192 char name[32];
2193 struct snd_card *card = stream->chip->card;
2195 sprintf(name, "stream%d", stream->pcm_index);
2196 if (! snd_card_proc_new(card, name, &entry))
2197 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
2200 #else
2202 static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2206 #endif
2209 * initialize the substream instance.
2212 static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
2214 struct snd_usb_substream *subs = &as->substream[stream];
2216 INIT_LIST_HEAD(&subs->fmt_list);
2217 spin_lock_init(&subs->lock);
2219 subs->stream = as;
2220 subs->direction = stream;
2221 subs->dev = as->chip->dev;
2222 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2223 subs->ops = audio_urb_ops[stream];
2224 else
2225 subs->ops = audio_urb_ops_high_speed[stream];
2226 snd_pcm_set_ops(as->pcm, stream,
2227 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2228 &snd_usb_playback_ops : &snd_usb_capture_ops);
2230 list_add_tail(&fp->list, &subs->fmt_list);
2231 subs->formats |= 1ULL << fp->format;
2232 subs->endpoint = fp->endpoint;
2233 subs->num_formats++;
2234 subs->fmt_type = fp->fmt_type;
2239 * free a substream
2241 static void free_substream(struct snd_usb_substream *subs)
2243 struct list_head *p, *n;
2245 if (! subs->num_formats)
2246 return; /* not initialized */
2247 list_for_each_safe(p, n, &subs->fmt_list) {
2248 struct audioformat *fp = list_entry(p, struct audioformat, list);
2249 kfree(fp->rate_table);
2250 kfree(fp);
2252 kfree(subs->rate_list.list);
2257 * free a usb stream instance
2259 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
2261 free_substream(&stream->substream[0]);
2262 free_substream(&stream->substream[1]);
2263 list_del(&stream->list);
2264 kfree(stream);
2267 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
2269 struct snd_usb_stream *stream = pcm->private_data;
2270 if (stream) {
2271 stream->pcm = NULL;
2272 snd_usb_audio_stream_free(stream);
2278 * add this endpoint to the chip instance.
2279 * if a stream with the same endpoint already exists, append to it.
2280 * if not, create a new pcm stream.
2282 static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
2284 struct list_head *p;
2285 struct snd_usb_stream *as;
2286 struct snd_usb_substream *subs;
2287 struct snd_pcm *pcm;
2288 int err;
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 if (subs->endpoint == fp->endpoint) {
2298 list_add_tail(&fp->list, &subs->fmt_list);
2299 subs->num_formats++;
2300 subs->formats |= 1ULL << fp->format;
2301 return 0;
2304 /* look for an empty stream */
2305 list_for_each(p, &chip->pcm_list) {
2306 as = list_entry(p, struct snd_usb_stream, list);
2307 if (as->fmt_type != fp->fmt_type)
2308 continue;
2309 subs = &as->substream[stream];
2310 if (subs->endpoint)
2311 continue;
2312 err = snd_pcm_new_stream(as->pcm, stream, 1);
2313 if (err < 0)
2314 return err;
2315 init_substream(as, stream, fp);
2316 return 0;
2319 /* create a new pcm */
2320 as = kzalloc(sizeof(*as), GFP_KERNEL);
2321 if (! as)
2322 return -ENOMEM;
2323 as->pcm_index = chip->pcm_devs;
2324 as->chip = chip;
2325 as->fmt_type = fp->fmt_type;
2326 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2327 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2328 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2329 &pcm);
2330 if (err < 0) {
2331 kfree(as);
2332 return err;
2334 as->pcm = pcm;
2335 pcm->private_data = as;
2336 pcm->private_free = snd_usb_audio_pcm_free;
2337 pcm->info_flags = 0;
2338 if (chip->pcm_devs > 0)
2339 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2340 else
2341 strcpy(pcm->name, "USB Audio");
2343 init_substream(as, stream, fp);
2345 list_add(&as->list, &chip->pcm_list);
2346 chip->pcm_devs++;
2348 proc_pcm_format_add(as);
2350 return 0;
2355 * check if the device uses big-endian samples
2357 static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
2359 switch (chip->usb_id) {
2360 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2361 if (fp->endpoint & USB_DIR_IN)
2362 return 1;
2363 break;
2364 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2365 if (device_setup[chip->index] == 0x00 ||
2366 fp->altsetting==1 || fp->altsetting==2 || fp->altsetting==3)
2367 return 1;
2369 return 0;
2373 * parse the audio format type I descriptor
2374 * and returns the corresponding pcm format
2376 * @dev: usb device
2377 * @fp: audioformat record
2378 * @format: the format tag (wFormatTag)
2379 * @fmt: the format type descriptor
2381 static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
2382 int format, unsigned char *fmt)
2384 int pcm_format;
2385 int sample_width, sample_bytes;
2387 /* FIXME: correct endianess and sign? */
2388 pcm_format = -1;
2389 sample_width = fmt[6];
2390 sample_bytes = fmt[5];
2391 switch (format) {
2392 case 0: /* some devices don't define this correctly... */
2393 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2394 chip->dev->devnum, fp->iface, fp->altsetting);
2395 /* fall-through */
2396 case USB_AUDIO_FORMAT_PCM:
2397 if (sample_width > sample_bytes * 8) {
2398 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2399 chip->dev->devnum, fp->iface, fp->altsetting,
2400 sample_width, sample_bytes);
2402 /* check the format byte size */
2403 switch (fmt[5]) {
2404 case 1:
2405 pcm_format = SNDRV_PCM_FORMAT_S8;
2406 break;
2407 case 2:
2408 if (is_big_endian_format(chip, fp))
2409 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2410 else
2411 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2412 break;
2413 case 3:
2414 if (is_big_endian_format(chip, fp))
2415 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2416 else
2417 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2418 break;
2419 case 4:
2420 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2421 break;
2422 default:
2423 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2424 chip->dev->devnum, fp->iface,
2425 fp->altsetting, sample_width, sample_bytes);
2426 break;
2428 break;
2429 case USB_AUDIO_FORMAT_PCM8:
2430 /* Dallas DS4201 workaround */
2431 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2432 pcm_format = SNDRV_PCM_FORMAT_S8;
2433 else
2434 pcm_format = SNDRV_PCM_FORMAT_U8;
2435 break;
2436 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2437 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2438 break;
2439 case USB_AUDIO_FORMAT_ALAW:
2440 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2441 break;
2442 case USB_AUDIO_FORMAT_MU_LAW:
2443 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2444 break;
2445 default:
2446 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2447 chip->dev->devnum, fp->iface, fp->altsetting, format);
2448 break;
2450 return pcm_format;
2455 * parse the format descriptor and stores the possible sample rates
2456 * on the audioformat table.
2458 * @dev: usb device
2459 * @fp: audioformat record
2460 * @fmt: the format descriptor
2461 * @offset: the start offset of descriptor pointing the rate type
2462 * (7 for type I and II, 8 for type II)
2464 static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
2465 unsigned char *fmt, int offset)
2467 int nr_rates = fmt[offset];
2469 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2470 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2471 chip->dev->devnum, fp->iface, fp->altsetting);
2472 return -1;
2475 if (nr_rates) {
2477 * build the rate table and bitmap flags
2479 int r, idx;
2480 unsigned int nonzero_rates = 0;
2482 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2483 if (fp->rate_table == NULL) {
2484 snd_printk(KERN_ERR "cannot malloc\n");
2485 return -1;
2488 fp->nr_rates = nr_rates;
2489 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2490 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2491 unsigned int rate = combine_triple(&fmt[idx]);
2492 /* C-Media CM6501 mislabels its 96 kHz altsetting */
2493 if (rate == 48000 && nr_rates == 1 &&
2494 chip->usb_id == USB_ID(0x0d8c, 0x0201) &&
2495 fp->altsetting == 5 && fp->maxpacksize == 392)
2496 rate = 96000;
2497 fp->rate_table[r] = rate;
2498 nonzero_rates |= rate;
2499 if (rate < fp->rate_min)
2500 fp->rate_min = rate;
2501 else if (rate > fp->rate_max)
2502 fp->rate_max = rate;
2503 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
2505 if (!nonzero_rates) {
2506 hwc_debug("All rates were zero. Skipping format!\n");
2507 return -1;
2509 } else {
2510 /* continuous rates */
2511 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2512 fp->rate_min = combine_triple(&fmt[offset + 1]);
2513 fp->rate_max = combine_triple(&fmt[offset + 4]);
2515 return 0;
2519 * parse the format type I and III descriptors
2521 static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
2522 int format, unsigned char *fmt)
2524 int pcm_format;
2526 if (fmt[3] == USB_FORMAT_TYPE_III) {
2527 /* FIXME: the format type is really IECxxx
2528 * but we give normal PCM format to get the existing
2529 * apps working...
2531 switch (chip->usb_id) {
2533 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2534 if (device_setup[chip->index] == 0x00 &&
2535 fp->altsetting == 6)
2536 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
2537 else
2538 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2539 break;
2540 default:
2541 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2543 } else {
2544 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2545 if (pcm_format < 0)
2546 return -1;
2548 fp->format = pcm_format;
2549 fp->channels = fmt[4];
2550 if (fp->channels < 1) {
2551 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2552 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2553 return -1;
2555 return parse_audio_format_rates(chip, fp, fmt, 7);
2559 * prase the format type II descriptor
2561 static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
2562 int format, unsigned char *fmt)
2564 int brate, framesize;
2565 switch (format) {
2566 case USB_AUDIO_FORMAT_AC3:
2567 /* FIXME: there is no AC3 format defined yet */
2568 // fp->format = SNDRV_PCM_FORMAT_AC3;
2569 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2570 break;
2571 case USB_AUDIO_FORMAT_MPEG:
2572 fp->format = SNDRV_PCM_FORMAT_MPEG;
2573 break;
2574 default:
2575 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2576 chip->dev->devnum, fp->iface, fp->altsetting, format);
2577 fp->format = SNDRV_PCM_FORMAT_MPEG;
2578 break;
2580 fp->channels = 1;
2581 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2582 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2583 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2584 fp->frame_size = framesize;
2585 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2588 static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
2589 int format, unsigned char *fmt, int stream)
2591 int err;
2593 switch (fmt[3]) {
2594 case USB_FORMAT_TYPE_I:
2595 case USB_FORMAT_TYPE_III:
2596 err = parse_audio_format_i(chip, fp, format, fmt);
2597 break;
2598 case USB_FORMAT_TYPE_II:
2599 err = parse_audio_format_ii(chip, fp, format, fmt);
2600 break;
2601 default:
2602 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2603 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2604 return -1;
2606 fp->fmt_type = fmt[3];
2607 if (err < 0)
2608 return err;
2609 #if 1
2610 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2611 /* extigy apparently supports sample rates other than 48k
2612 * but not in ordinary way. so we enable only 48k atm.
2614 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2615 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2616 chip->usb_id == USB_ID(0x041e, 0x3061)) {
2617 if (fmt[3] == USB_FORMAT_TYPE_I &&
2618 fp->rates != SNDRV_PCM_RATE_48000 &&
2619 fp->rates != SNDRV_PCM_RATE_96000)
2620 return -1;
2622 #endif
2623 return 0;
2626 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2627 int iface, int altno);
2628 static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
2630 struct usb_device *dev;
2631 struct usb_interface *iface;
2632 struct usb_host_interface *alts;
2633 struct usb_interface_descriptor *altsd;
2634 int i, altno, err, stream;
2635 int format;
2636 struct audioformat *fp;
2637 unsigned char *fmt, *csep;
2639 dev = chip->dev;
2641 /* parse the interface's altsettings */
2642 iface = usb_ifnum_to_if(dev, iface_no);
2643 for (i = 0; i < iface->num_altsetting; i++) {
2644 alts = &iface->altsetting[i];
2645 altsd = get_iface_desc(alts);
2646 /* skip invalid one */
2647 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2648 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2649 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2650 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2651 altsd->bNumEndpoints < 1 ||
2652 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2653 continue;
2654 /* must be isochronous */
2655 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2656 USB_ENDPOINT_XFER_ISOC)
2657 continue;
2658 /* check direction */
2659 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2660 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2661 altno = altsd->bAlternateSetting;
2663 /* audiophile usb: skip altsets incompatible with device_setup
2665 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2666 audiophile_skip_setting_quirk(chip, iface_no, altno))
2667 continue;
2669 /* get audio formats */
2670 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2671 if (!fmt) {
2672 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2673 dev->devnum, iface_no, altno);
2674 continue;
2677 if (fmt[0] < 7) {
2678 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2679 dev->devnum, iface_no, altno);
2680 continue;
2683 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2685 /* get format type */
2686 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2687 if (!fmt) {
2688 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2689 dev->devnum, iface_no, altno);
2690 continue;
2692 if (fmt[0] < 8) {
2693 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2694 dev->devnum, iface_no, altno);
2695 continue;
2698 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2699 /* Creamware Noah has this descriptor after the 2nd endpoint */
2700 if (!csep && altsd->bNumEndpoints >= 2)
2701 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2702 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2703 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
2704 " class specific endpoint descriptor\n",
2705 dev->devnum, iface_no, altno);
2706 csep = NULL;
2709 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
2710 if (! fp) {
2711 snd_printk(KERN_ERR "cannot malloc\n");
2712 return -ENOMEM;
2715 fp->iface = iface_no;
2716 fp->altsetting = altno;
2717 fp->altset_idx = i;
2718 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2719 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2720 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2721 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2722 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2723 * (fp->maxpacksize & 0x7ff);
2724 fp->attributes = csep ? csep[3] : 0;
2726 /* some quirks for attributes here */
2728 switch (chip->usb_id) {
2729 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2730 /* Optoplay sets the sample rate attribute although
2731 * it seems not supporting it in fact.
2733 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2734 break;
2735 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2736 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2737 /* doesn't set the sample rate attribute, but supports it */
2738 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2739 break;
2740 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2741 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2742 an older model 77d:223) */
2744 * plantronics headset and Griffin iMic have set adaptive-in
2745 * although it's really not...
2747 fp->ep_attr &= ~EP_ATTR_MASK;
2748 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2749 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2750 else
2751 fp->ep_attr |= EP_ATTR_SYNC;
2752 break;
2755 /* ok, let's parse further... */
2756 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2757 kfree(fp->rate_table);
2758 kfree(fp);
2759 continue;
2762 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, altno, fp->endpoint);
2763 err = add_audio_endpoint(chip, stream, fp);
2764 if (err < 0) {
2765 kfree(fp->rate_table);
2766 kfree(fp);
2767 return err;
2769 /* try to set the interface... */
2770 usb_set_interface(chip->dev, iface_no, altno);
2771 init_usb_pitch(chip->dev, iface_no, alts, fp);
2772 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2774 return 0;
2779 * disconnect streams
2780 * called from snd_usb_audio_disconnect()
2782 static void snd_usb_stream_disconnect(struct list_head *head)
2784 int idx;
2785 struct snd_usb_stream *as;
2786 struct snd_usb_substream *subs;
2788 as = list_entry(head, struct snd_usb_stream, list);
2789 for (idx = 0; idx < 2; idx++) {
2790 subs = &as->substream[idx];
2791 if (!subs->num_formats)
2792 return;
2793 release_substream_urbs(subs, 1);
2794 subs->interface = -1;
2799 * parse audio control descriptor and create pcm/midi streams
2801 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
2803 struct usb_device *dev = chip->dev;
2804 struct usb_host_interface *host_iface;
2805 struct usb_interface *iface;
2806 unsigned char *p1;
2807 int i, j;
2809 /* find audiocontrol interface */
2810 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2811 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2812 snd_printk(KERN_ERR "cannot find HEADER\n");
2813 return -EINVAL;
2815 if (! p1[7] || p1[0] < 8 + p1[7]) {
2816 snd_printk(KERN_ERR "invalid HEADER\n");
2817 return -EINVAL;
2821 * parse all USB audio streaming interfaces
2823 for (i = 0; i < p1[7]; i++) {
2824 struct usb_host_interface *alts;
2825 struct usb_interface_descriptor *altsd;
2826 j = p1[8 + i];
2827 iface = usb_ifnum_to_if(dev, j);
2828 if (!iface) {
2829 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2830 dev->devnum, ctrlif, j);
2831 continue;
2833 if (usb_interface_claimed(iface)) {
2834 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2835 continue;
2837 alts = &iface->altsetting[0];
2838 altsd = get_iface_desc(alts);
2839 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2840 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2841 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2842 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2843 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2844 continue;
2846 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2847 continue;
2849 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2850 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2851 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2852 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2853 /* skip non-supported classes */
2854 continue;
2856 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
2857 snd_printk(KERN_ERR "low speed audio streaming not supported\n");
2858 continue;
2860 if (! parse_audio_endpoints(chip, j)) {
2861 usb_set_interface(dev, j, 0); /* reset the current interface */
2862 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2866 return 0;
2870 * create a stream for an endpoint/altsetting without proper descriptors
2872 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
2873 struct usb_interface *iface,
2874 const struct snd_usb_audio_quirk *quirk)
2876 struct audioformat *fp;
2877 struct usb_host_interface *alts;
2878 int stream, err;
2879 unsigned *rate_table = NULL;
2881 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
2882 if (! fp) {
2883 snd_printk(KERN_ERR "cannot memdup\n");
2884 return -ENOMEM;
2886 if (fp->nr_rates > 0) {
2887 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2888 if (!rate_table) {
2889 kfree(fp);
2890 return -ENOMEM;
2892 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2893 fp->rate_table = rate_table;
2896 stream = (fp->endpoint & USB_DIR_IN)
2897 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2898 err = add_audio_endpoint(chip, stream, fp);
2899 if (err < 0) {
2900 kfree(fp);
2901 kfree(rate_table);
2902 return err;
2904 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2905 fp->altset_idx >= iface->num_altsetting) {
2906 kfree(fp);
2907 kfree(rate_table);
2908 return -EINVAL;
2910 alts = &iface->altsetting[fp->altset_idx];
2911 usb_set_interface(chip->dev, fp->iface, 0);
2912 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2913 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2914 return 0;
2918 * create a stream for an interface with proper descriptors
2920 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
2921 struct usb_interface *iface,
2922 const struct snd_usb_audio_quirk *quirk)
2924 struct usb_host_interface *alts;
2925 struct usb_interface_descriptor *altsd;
2926 int err;
2928 alts = &iface->altsetting[0];
2929 altsd = get_iface_desc(alts);
2930 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2931 if (err < 0) {
2932 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2933 altsd->bInterfaceNumber, err);
2934 return err;
2936 /* reset the current interface */
2937 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2938 return 0;
2942 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2943 * to detect the sample rate is by looking at wMaxPacketSize.
2945 static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
2946 struct usb_interface *iface,
2947 const struct snd_usb_audio_quirk *quirk)
2949 static const struct audioformat ua_format = {
2950 .format = SNDRV_PCM_FORMAT_S24_3LE,
2951 .channels = 2,
2952 .fmt_type = USB_FORMAT_TYPE_I,
2953 .altsetting = 1,
2954 .altset_idx = 1,
2955 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2957 struct usb_host_interface *alts;
2958 struct usb_interface_descriptor *altsd;
2959 struct audioformat *fp;
2960 int stream, err;
2962 /* both PCM and MIDI interfaces have 2 altsettings */
2963 if (iface->num_altsetting != 2)
2964 return -ENXIO;
2965 alts = &iface->altsetting[1];
2966 altsd = get_iface_desc(alts);
2968 if (altsd->bNumEndpoints == 2) {
2969 static const struct snd_usb_midi_endpoint_info ua700_ep = {
2970 .out_cables = 0x0003,
2971 .in_cables = 0x0003
2973 static const struct snd_usb_audio_quirk ua700_quirk = {
2974 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2975 .data = &ua700_ep
2977 static const struct snd_usb_midi_endpoint_info ua25_ep = {
2978 .out_cables = 0x0001,
2979 .in_cables = 0x0001
2981 static const struct snd_usb_audio_quirk ua25_quirk = {
2982 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2983 .data = &ua25_ep
2985 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2986 return snd_usb_create_midi_interface(chip, iface,
2987 &ua700_quirk);
2988 else
2989 return snd_usb_create_midi_interface(chip, iface,
2990 &ua25_quirk);
2993 if (altsd->bNumEndpoints != 1)
2994 return -ENXIO;
2996 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2997 if (!fp)
2998 return -ENOMEM;
2999 memcpy(fp, &ua_format, sizeof(*fp));
3001 fp->iface = altsd->bInterfaceNumber;
3002 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3003 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3004 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3006 switch (fp->maxpacksize) {
3007 case 0x120:
3008 fp->rate_max = fp->rate_min = 44100;
3009 break;
3010 case 0x138:
3011 case 0x140:
3012 fp->rate_max = fp->rate_min = 48000;
3013 break;
3014 case 0x258:
3015 case 0x260:
3016 fp->rate_max = fp->rate_min = 96000;
3017 break;
3018 default:
3019 snd_printk(KERN_ERR "unknown sample rate\n");
3020 kfree(fp);
3021 return -ENXIO;
3024 stream = (fp->endpoint & USB_DIR_IN)
3025 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3026 err = add_audio_endpoint(chip, stream, fp);
3027 if (err < 0) {
3028 kfree(fp);
3029 return err;
3031 usb_set_interface(chip->dev, fp->iface, 0);
3032 return 0;
3036 * Create a stream for an Edirol UA-1000 interface.
3038 static int create_ua1000_quirk(struct snd_usb_audio *chip,
3039 struct usb_interface *iface,
3040 const struct snd_usb_audio_quirk *quirk)
3042 static const struct audioformat ua1000_format = {
3043 .format = SNDRV_PCM_FORMAT_S32_LE,
3044 .fmt_type = USB_FORMAT_TYPE_I,
3045 .altsetting = 1,
3046 .altset_idx = 1,
3047 .attributes = 0,
3048 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3050 struct usb_host_interface *alts;
3051 struct usb_interface_descriptor *altsd;
3052 struct audioformat *fp;
3053 int stream, err;
3055 if (iface->num_altsetting != 2)
3056 return -ENXIO;
3057 alts = &iface->altsetting[1];
3058 altsd = get_iface_desc(alts);
3059 if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3060 altsd->bNumEndpoints != 1)
3061 return -ENXIO;
3063 fp = kmemdup(&ua1000_format, sizeof(*fp), GFP_KERNEL);
3064 if (!fp)
3065 return -ENOMEM;
3067 fp->channels = alts->extra[4];
3068 fp->iface = altsd->bInterfaceNumber;
3069 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3070 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3071 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3072 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
3074 stream = (fp->endpoint & USB_DIR_IN)
3075 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3076 err = add_audio_endpoint(chip, stream, fp);
3077 if (err < 0) {
3078 kfree(fp);
3079 return err;
3081 /* FIXME: playback must be synchronized to capture */
3082 usb_set_interface(chip->dev, fp->iface, 0);
3083 return 0;
3087 * Create a stream for an Edirol UA-101 interface.
3088 * Copy, paste and modify from Edirol UA-1000
3090 static int create_ua101_quirk(struct snd_usb_audio *chip,
3091 struct usb_interface *iface,
3092 const struct snd_usb_audio_quirk *quirk)
3094 static const struct audioformat ua101_format = {
3095 .format = SNDRV_PCM_FORMAT_S32_LE,
3096 .fmt_type = USB_FORMAT_TYPE_I,
3097 .altsetting = 1,
3098 .altset_idx = 1,
3099 .attributes = 0,
3100 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3102 struct usb_host_interface *alts;
3103 struct usb_interface_descriptor *altsd;
3104 struct audioformat *fp;
3105 int stream, err;
3107 if (iface->num_altsetting != 2)
3108 return -ENXIO;
3109 alts = &iface->altsetting[1];
3110 altsd = get_iface_desc(alts);
3111 if (alts->extralen != 18 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3112 altsd->bNumEndpoints != 1)
3113 return -ENXIO;
3115 fp = kmemdup(&ua101_format, sizeof(*fp), GFP_KERNEL);
3116 if (!fp)
3117 return -ENOMEM;
3119 fp->channels = alts->extra[11];
3120 fp->iface = altsd->bInterfaceNumber;
3121 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3122 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3123 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3124 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[15]);
3126 stream = (fp->endpoint & USB_DIR_IN)
3127 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3128 err = add_audio_endpoint(chip, stream, fp);
3129 if (err < 0) {
3130 kfree(fp);
3131 return err;
3133 /* FIXME: playback must be synchronized to capture */
3134 usb_set_interface(chip->dev, fp->iface, 0);
3135 return 0;
3138 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3139 struct usb_interface *iface,
3140 const struct snd_usb_audio_quirk *quirk);
3143 * handle the quirks for the contained interfaces
3145 static int create_composite_quirk(struct snd_usb_audio *chip,
3146 struct usb_interface *iface,
3147 const struct snd_usb_audio_quirk *quirk)
3149 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3150 int err;
3152 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3153 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3154 if (!iface)
3155 continue;
3156 if (quirk->ifnum != probed_ifnum &&
3157 usb_interface_claimed(iface))
3158 continue;
3159 err = snd_usb_create_quirk(chip, iface, quirk);
3160 if (err < 0)
3161 return err;
3162 if (quirk->ifnum != probed_ifnum)
3163 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3165 return 0;
3168 static int ignore_interface_quirk(struct snd_usb_audio *chip,
3169 struct usb_interface *iface,
3170 const struct snd_usb_audio_quirk *quirk)
3172 return 0;
3177 * boot quirks
3180 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3181 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3183 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3185 struct usb_host_config *config = dev->actconfig;
3186 int err;
3188 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3189 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3190 snd_printdd("sending Extigy boot sequence...\n");
3191 /* Send message to force it to reconnect with full interface. */
3192 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3193 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3194 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3195 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3196 &dev->descriptor, sizeof(dev->descriptor));
3197 config = dev->actconfig;
3198 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3199 err = usb_reset_configuration(dev);
3200 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3201 snd_printdd("extigy_boot: new boot length = %d\n",
3202 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3203 return -ENODEV; /* quit this anyway */
3205 return 0;
3208 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3210 u8 buf = 1;
3212 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3213 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3214 0, 0, &buf, 1, 1000);
3215 if (buf == 0) {
3216 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3217 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3218 1, 2000, NULL, 0, 1000);
3219 return -ENODEV;
3221 return 0;
3225 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3226 * documented in the device's data sheet.
3228 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3230 u8 buf[4];
3231 buf[0] = 0x20;
3232 buf[1] = value & 0xff;
3233 buf[2] = (value >> 8) & 0xff;
3234 buf[3] = reg;
3235 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3236 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3237 0, 0, &buf, 4, 1000);
3240 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3243 * Enable line-out driver mode, set headphone source to front
3244 * channels, enable stereo mic.
3246 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3251 * Setup quirks
3253 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3254 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3255 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3256 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3257 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3258 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3259 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3260 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3261 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3262 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3264 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3265 int iface, int altno)
3267 /* Reset ALL ifaces to 0 altsetting.
3268 * Call it for every possible altsetting of every interface.
3270 usb_set_interface(chip->dev, iface, 0);
3272 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3273 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3274 && altno != 6)
3275 return 1; /* skip this altsetting */
3276 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3277 && altno != 1)
3278 return 1; /* skip this altsetting */
3279 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3280 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3281 return 1; /* skip this altsetting */
3282 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3283 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3284 return 1; /* skip this altsetting */
3285 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3286 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3287 return 1; /* skip this altsetting */
3288 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3289 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3290 return 1; /* skip this altsetting */
3292 return 0; /* keep this altsetting */
3296 * audio-interface quirks
3298 * returns zero if no standard audio/MIDI parsing is needed.
3299 * returns a postive value if standard audio/midi interfaces are parsed
3300 * after this.
3301 * returns a negative value at error.
3303 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3304 struct usb_interface *iface,
3305 const struct snd_usb_audio_quirk *quirk)
3307 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3308 const struct snd_usb_audio_quirk *);
3309 static const quirk_func_t quirk_funcs[] = {
3310 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3311 [QUIRK_COMPOSITE] = create_composite_quirk,
3312 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3313 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3314 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3315 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3316 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3317 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3318 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3319 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
3320 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3321 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3322 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3323 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3324 [QUIRK_AUDIO_EDIROL_UA101] = create_ua101_quirk,
3327 if (quirk->type < QUIRK_TYPE_COUNT) {
3328 return quirk_funcs[quirk->type](chip, iface, quirk);
3329 } else {
3330 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3331 return -ENXIO;
3337 * common proc files to show the usb device info
3339 static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3341 struct snd_usb_audio *chip = entry->private_data;
3342 if (! chip->shutdown)
3343 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3346 static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3348 struct snd_usb_audio *chip = entry->private_data;
3349 if (! chip->shutdown)
3350 snd_iprintf(buffer, "%04x:%04x\n",
3351 USB_ID_VENDOR(chip->usb_id),
3352 USB_ID_PRODUCT(chip->usb_id));
3355 static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
3357 struct snd_info_entry *entry;
3358 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3359 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
3360 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3361 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
3365 * free the chip instance
3367 * here we have to do not much, since pcm and controls are already freed
3371 static int snd_usb_audio_free(struct snd_usb_audio *chip)
3373 usb_chip[chip->index] = NULL;
3374 kfree(chip);
3375 return 0;
3378 static int snd_usb_audio_dev_free(struct snd_device *device)
3380 struct snd_usb_audio *chip = device->device_data;
3381 return snd_usb_audio_free(chip);
3386 * create a chip instance and set its names.
3388 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3389 const struct snd_usb_audio_quirk *quirk,
3390 struct snd_usb_audio **rchip)
3392 struct snd_card *card;
3393 struct snd_usb_audio *chip;
3394 int err, len;
3395 char component[14];
3396 static struct snd_device_ops ops = {
3397 .dev_free = snd_usb_audio_dev_free,
3400 *rchip = NULL;
3402 if (snd_usb_get_speed(dev) != USB_SPEED_LOW &&
3403 snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3404 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3405 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3406 return -ENXIO;
3409 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3410 if (card == NULL) {
3411 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3412 return -ENOMEM;
3415 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3416 if (! chip) {
3417 snd_card_free(card);
3418 return -ENOMEM;
3421 chip->index = idx;
3422 chip->dev = dev;
3423 chip->card = card;
3424 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3425 le16_to_cpu(dev->descriptor.idProduct));
3426 INIT_LIST_HEAD(&chip->pcm_list);
3427 INIT_LIST_HEAD(&chip->midi_list);
3428 INIT_LIST_HEAD(&chip->mixer_list);
3430 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3431 snd_usb_audio_free(chip);
3432 snd_card_free(card);
3433 return err;
3436 strcpy(card->driver, "USB-Audio");
3437 sprintf(component, "USB%04x:%04x",
3438 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3439 snd_component_add(card, component);
3441 /* retrieve the device string as shortname */
3442 if (quirk && quirk->product_name) {
3443 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3444 } else {
3445 if (!dev->descriptor.iProduct ||
3446 usb_string(dev, dev->descriptor.iProduct,
3447 card->shortname, sizeof(card->shortname)) <= 0) {
3448 /* no name available from anywhere, so use ID */
3449 sprintf(card->shortname, "USB Device %#04x:%#04x",
3450 USB_ID_VENDOR(chip->usb_id),
3451 USB_ID_PRODUCT(chip->usb_id));
3455 /* retrieve the vendor and device strings as longname */
3456 if (quirk && quirk->vendor_name) {
3457 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3458 } else {
3459 if (dev->descriptor.iManufacturer)
3460 len = usb_string(dev, dev->descriptor.iManufacturer,
3461 card->longname, sizeof(card->longname));
3462 else
3463 len = 0;
3464 /* we don't really care if there isn't any vendor string */
3466 if (len > 0)
3467 strlcat(card->longname, " ", sizeof(card->longname));
3469 strlcat(card->longname, card->shortname, sizeof(card->longname));
3471 len = strlcat(card->longname, " at ", sizeof(card->longname));
3473 if (len < sizeof(card->longname))
3474 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3476 strlcat(card->longname,
3477 snd_usb_get_speed(dev) == USB_SPEED_LOW ? ", low speed" :
3478 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" :
3479 ", high speed",
3480 sizeof(card->longname));
3482 snd_usb_audio_create_proc(chip);
3484 *rchip = chip;
3485 return 0;
3490 * probe the active usb device
3492 * note that this can be called multiple times per a device, when it
3493 * includes multiple audio control interfaces.
3495 * thus we check the usb device pointer and creates the card instance
3496 * only at the first time. the successive calls of this function will
3497 * append the pcm interface to the corresponding card.
3499 static void *snd_usb_audio_probe(struct usb_device *dev,
3500 struct usb_interface *intf,
3501 const struct usb_device_id *usb_id)
3503 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
3504 int i, err;
3505 struct snd_usb_audio *chip;
3506 struct usb_host_interface *alts;
3507 int ifnum;
3508 u32 id;
3510 alts = &intf->altsetting[0];
3511 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3512 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3513 le16_to_cpu(dev->descriptor.idProduct));
3515 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3516 goto __err_val;
3518 /* SB Extigy needs special boot-up sequence */
3519 /* if more models come, this will go to the quirk list. */
3520 if (id == USB_ID(0x041e, 0x3000)) {
3521 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3522 goto __err_val;
3524 /* SB Audigy 2 NX needs its own boot-up magic, too */
3525 if (id == USB_ID(0x041e, 0x3020)) {
3526 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3527 goto __err_val;
3530 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3531 if (id == USB_ID(0x10f5, 0x0200)) {
3532 if (snd_usb_cm106_boot_quirk(dev) < 0)
3533 goto __err_val;
3537 * found a config. now register to ALSA
3540 /* check whether it's already registered */
3541 chip = NULL;
3542 mutex_lock(&register_mutex);
3543 for (i = 0; i < SNDRV_CARDS; i++) {
3544 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3545 if (usb_chip[i]->shutdown) {
3546 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3547 goto __error;
3549 chip = usb_chip[i];
3550 break;
3553 if (! chip) {
3554 /* it's a fresh one.
3555 * now look for an empty slot and create a new card instance
3557 for (i = 0; i < SNDRV_CARDS; i++)
3558 if (enable[i] && ! usb_chip[i] &&
3559 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3560 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3561 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3562 goto __error;
3564 snd_card_set_dev(chip->card, &intf->dev);
3565 break;
3567 if (! chip) {
3568 snd_printk(KERN_ERR "no available usb audio device\n");
3569 goto __error;
3573 err = 1; /* continue */
3574 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3575 /* need some special handlings */
3576 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3577 goto __error;
3580 if (err > 0) {
3581 /* create normal USB audio interfaces */
3582 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3583 snd_usb_create_mixer(chip, ifnum) < 0) {
3584 goto __error;
3588 /* we are allowed to call snd_card_register() many times */
3589 if (snd_card_register(chip->card) < 0) {
3590 goto __error;
3593 usb_chip[chip->index] = chip;
3594 chip->num_interfaces++;
3595 mutex_unlock(&register_mutex);
3596 return chip;
3598 __error:
3599 if (chip && !chip->num_interfaces)
3600 snd_card_free(chip->card);
3601 mutex_unlock(&register_mutex);
3602 __err_val:
3603 return NULL;
3607 * we need to take care of counter, since disconnection can be called also
3608 * many times as well as usb_audio_probe().
3610 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3612 struct snd_usb_audio *chip;
3613 struct snd_card *card;
3614 struct list_head *p;
3616 if (ptr == (void *)-1L)
3617 return;
3619 chip = ptr;
3620 card = chip->card;
3621 mutex_lock(&register_mutex);
3622 chip->shutdown = 1;
3623 chip->num_interfaces--;
3624 if (chip->num_interfaces <= 0) {
3625 snd_card_disconnect(card);
3626 /* release the pcm resources */
3627 list_for_each(p, &chip->pcm_list) {
3628 snd_usb_stream_disconnect(p);
3630 /* release the midi resources */
3631 list_for_each(p, &chip->midi_list) {
3632 snd_usbmidi_disconnect(p);
3634 /* release mixer resources */
3635 list_for_each(p, &chip->mixer_list) {
3636 snd_usb_mixer_disconnect(p);
3638 mutex_unlock(&register_mutex);
3639 snd_card_free_when_closed(card);
3640 } else {
3641 mutex_unlock(&register_mutex);
3646 * new 2.5 USB kernel API
3648 static int usb_audio_probe(struct usb_interface *intf,
3649 const struct usb_device_id *id)
3651 void *chip;
3652 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3653 if (chip) {
3654 dev_set_drvdata(&intf->dev, chip);
3655 return 0;
3656 } else
3657 return -EIO;
3660 static void usb_audio_disconnect(struct usb_interface *intf)
3662 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3663 dev_get_drvdata(&intf->dev));
3666 #ifdef CONFIG_PM
3667 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
3669 struct snd_usb_audio *chip = dev_get_drvdata(&intf->dev);
3670 struct list_head *p;
3671 struct snd_usb_stream *as;
3673 if (chip == (void *)-1L)
3674 return 0;
3676 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
3677 if (!chip->num_suspended_intf++) {
3678 list_for_each(p, &chip->pcm_list) {
3679 as = list_entry(p, struct snd_usb_stream, list);
3680 snd_pcm_suspend_all(as->pcm);
3684 return 0;
3687 static int usb_audio_resume(struct usb_interface *intf)
3689 struct snd_usb_audio *chip = dev_get_drvdata(&intf->dev);
3691 if (chip == (void *)-1L)
3692 return 0;
3693 if (--chip->num_suspended_intf)
3694 return 0;
3696 * ALSA leaves material resumption to user space
3697 * we just notify
3700 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
3702 return 0;
3704 #endif /* CONFIG_PM */
3706 static int __init snd_usb_audio_init(void)
3708 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3709 printk(KERN_WARNING "invalid nrpacks value.\n");
3710 return -EINVAL;
3712 return usb_register(&usb_audio_driver);
3716 static void __exit snd_usb_audio_cleanup(void)
3718 usb_deregister(&usb_audio_driver);
3721 module_init(snd_usb_audio_init);
3722 module_exit(snd_usb_audio_cleanup);