PM / yenta: Split resume into early and late parts (rev. 4)
[linux/fpc-iii.git] / sound / usb / usbaudio.c
blob44b9cdc8a83bae15856ca18fb7915acc7197757d
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 /* Vendor/product IDs for this card */
69 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
70 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
71 static int nrpacks = 8; /* max. number of packets per urb */
72 static int async_unlink = 1;
73 static int device_setup[SNDRV_CARDS]; /* device parameter for this card*/
74 static int ignore_ctl_error;
76 module_param_array(index, int, NULL, 0444);
77 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
78 module_param_array(id, charp, NULL, 0444);
79 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
80 module_param_array(enable, bool, NULL, 0444);
81 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
82 module_param_array(vid, int, NULL, 0444);
83 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
84 module_param_array(pid, int, NULL, 0444);
85 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
86 module_param(nrpacks, int, 0644);
87 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
88 module_param(async_unlink, bool, 0444);
89 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
90 module_param_array(device_setup, int, NULL, 0444);
91 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
92 module_param(ignore_ctl_error, bool, 0444);
93 MODULE_PARM_DESC(ignore_ctl_error,
94 "Ignore errors from USB controller for mixer interfaces.");
97 * debug the h/w constraints
99 /* #define HW_CONST_DEBUG */
106 #define MAX_PACKS 20
107 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
108 #define MAX_URBS 8
109 #define SYNC_URBS 4 /* always four urbs for sync */
110 #define MAX_QUEUE 24 /* try not to exceed this queue length, in ms */
112 struct audioformat {
113 struct list_head list;
114 snd_pcm_format_t format; /* format type */
115 unsigned int channels; /* # channels */
116 unsigned int fmt_type; /* USB audio format type (1-3) */
117 unsigned int frame_size; /* samples per frame for non-audio */
118 int iface; /* interface number */
119 unsigned char altsetting; /* corresponding alternate setting */
120 unsigned char altset_idx; /* array index of altenate setting */
121 unsigned char attributes; /* corresponding attributes of cs endpoint */
122 unsigned char endpoint; /* endpoint */
123 unsigned char ep_attr; /* endpoint attributes */
124 unsigned char datainterval; /* log_2 of data packet interval */
125 unsigned int maxpacksize; /* max. packet size */
126 unsigned int rates; /* rate bitmasks */
127 unsigned int rate_min, rate_max; /* min/max rates */
128 unsigned int nr_rates; /* number of rate table entries */
129 unsigned int *rate_table; /* rate table */
132 struct snd_usb_substream;
134 struct snd_urb_ctx {
135 struct urb *urb;
136 unsigned int buffer_size; /* size of data buffer, if data URB */
137 struct snd_usb_substream *subs;
138 int index; /* index for urb array */
139 int packets; /* number of packets per urb */
142 struct snd_urb_ops {
143 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
144 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
145 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
146 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
149 struct snd_usb_substream {
150 struct snd_usb_stream *stream;
151 struct usb_device *dev;
152 struct snd_pcm_substream *pcm_substream;
153 int direction; /* playback or capture */
154 int interface; /* current interface */
155 int endpoint; /* assigned endpoint */
156 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
157 unsigned int cur_rate; /* current rate (for hw_params callback) */
158 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
159 unsigned int format; /* USB data format */
160 unsigned int datapipe; /* the data i/o pipe */
161 unsigned int syncpipe; /* 1 - async out or adaptive in */
162 unsigned int datainterval; /* log_2 of data packet interval */
163 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
164 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
165 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
166 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
167 unsigned int phase; /* phase accumulator */
168 unsigned int maxpacksize; /* max packet size in bytes */
169 unsigned int maxframesize; /* max packet size in frames */
170 unsigned int curpacksize; /* current packet size in bytes (for capture) */
171 unsigned int curframesize; /* current packet size in frames (for capture) */
172 unsigned int fill_max: 1; /* fill max packet size always */
173 unsigned int fmt_type; /* USB audio format type (1-3) */
175 unsigned int running: 1; /* running status */
177 unsigned int hwptr_done; /* processed frame position in the buffer */
178 unsigned int transfer_done; /* processed frames since last period update */
179 unsigned long active_mask; /* bitmask of active urbs */
180 unsigned long unlink_mask; /* bitmask of unlinked urbs */
182 unsigned int nurbs; /* # urbs */
183 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
184 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
185 char *syncbuf; /* sync buffer for all sync URBs */
186 dma_addr_t sync_dma; /* DMA address of syncbuf */
188 u64 formats; /* format bitmasks (all or'ed) */
189 unsigned int num_formats; /* number of supported audio formats (list) */
190 struct list_head fmt_list; /* format list */
191 struct snd_pcm_hw_constraint_list rate_list; /* limited rates */
192 spinlock_t lock;
194 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
198 struct snd_usb_stream {
199 struct snd_usb_audio *chip;
200 struct snd_pcm *pcm;
201 int pcm_index;
202 unsigned int fmt_type; /* USB audio format type (1-3) */
203 struct snd_usb_substream substream[2];
204 struct list_head list;
209 * we keep the snd_usb_audio_t instances by ourselves for merging
210 * the all interfaces on the same card as one sound device.
213 static DEFINE_MUTEX(register_mutex);
214 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
218 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
219 * this will overflow at approx 524 kHz
221 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
223 return ((rate << 13) + 62) / 125;
227 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
228 * this will overflow at approx 4 MHz
230 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
232 return ((rate << 10) + 62) / 125;
235 /* convert our full speed USB rate into sampling rate in Hz */
236 static inline unsigned get_full_speed_hz(unsigned int usb_rate)
238 return (usb_rate * 125 + (1 << 12)) >> 13;
241 /* convert our high speed USB rate into sampling rate in Hz */
242 static inline unsigned get_high_speed_hz(unsigned int usb_rate)
244 return (usb_rate * 125 + (1 << 9)) >> 10;
249 * prepare urb for full speed capture sync pipe
251 * fill the length and offset of each urb descriptor.
252 * the fixed 10.14 frequency is passed through the pipe.
254 static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
255 struct snd_pcm_runtime *runtime,
256 struct urb *urb)
258 unsigned char *cp = urb->transfer_buffer;
259 struct snd_urb_ctx *ctx = urb->context;
261 urb->dev = ctx->subs->dev; /* we need to set this at each time */
262 urb->iso_frame_desc[0].length = 3;
263 urb->iso_frame_desc[0].offset = 0;
264 cp[0] = subs->freqn >> 2;
265 cp[1] = subs->freqn >> 10;
266 cp[2] = subs->freqn >> 18;
267 return 0;
271 * prepare urb for high speed capture sync pipe
273 * fill the length and offset of each urb descriptor.
274 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
276 static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
277 struct snd_pcm_runtime *runtime,
278 struct urb *urb)
280 unsigned char *cp = urb->transfer_buffer;
281 struct snd_urb_ctx *ctx = urb->context;
283 urb->dev = ctx->subs->dev; /* we need to set this at each time */
284 urb->iso_frame_desc[0].length = 4;
285 urb->iso_frame_desc[0].offset = 0;
286 cp[0] = subs->freqn;
287 cp[1] = subs->freqn >> 8;
288 cp[2] = subs->freqn >> 16;
289 cp[3] = subs->freqn >> 24;
290 return 0;
294 * process after capture sync complete
295 * - nothing to do
297 static int retire_capture_sync_urb(struct snd_usb_substream *subs,
298 struct snd_pcm_runtime *runtime,
299 struct urb *urb)
301 return 0;
305 * prepare urb for capture data pipe
307 * fill the offset and length of each descriptor.
309 * we use a temporary buffer to write the captured data.
310 * since the length of written data is determined by host, we cannot
311 * write onto the pcm buffer directly... the data is thus copied
312 * later at complete callback to the global buffer.
314 static int prepare_capture_urb(struct snd_usb_substream *subs,
315 struct snd_pcm_runtime *runtime,
316 struct urb *urb)
318 int i, offs;
319 struct snd_urb_ctx *ctx = urb->context;
321 offs = 0;
322 urb->dev = ctx->subs->dev; /* we need to set this at each time */
323 for (i = 0; i < ctx->packets; i++) {
324 urb->iso_frame_desc[i].offset = offs;
325 urb->iso_frame_desc[i].length = subs->curpacksize;
326 offs += subs->curpacksize;
328 urb->transfer_buffer_length = offs;
329 urb->number_of_packets = ctx->packets;
330 return 0;
334 * process after capture complete
336 * copy the data from each desctiptor to the pcm buffer, and
337 * update the current position.
339 static int retire_capture_urb(struct snd_usb_substream *subs,
340 struct snd_pcm_runtime *runtime,
341 struct urb *urb)
343 unsigned long flags;
344 unsigned char *cp;
345 int i;
346 unsigned int stride, len, oldptr;
347 int period_elapsed = 0;
349 stride = runtime->frame_bits >> 3;
351 for (i = 0; i < urb->number_of_packets; i++) {
352 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
353 if (urb->iso_frame_desc[i].status) {
354 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
355 // continue;
357 len = urb->iso_frame_desc[i].actual_length / stride;
358 if (! len)
359 continue;
360 /* update the current pointer */
361 spin_lock_irqsave(&subs->lock, flags);
362 oldptr = subs->hwptr_done;
363 subs->hwptr_done += len;
364 if (subs->hwptr_done >= runtime->buffer_size)
365 subs->hwptr_done -= runtime->buffer_size;
366 subs->transfer_done += len;
367 if (subs->transfer_done >= runtime->period_size) {
368 subs->transfer_done -= runtime->period_size;
369 period_elapsed = 1;
371 spin_unlock_irqrestore(&subs->lock, flags);
372 /* copy a data chunk */
373 if (oldptr + len > runtime->buffer_size) {
374 unsigned int cnt = runtime->buffer_size - oldptr;
375 unsigned int blen = cnt * stride;
376 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
377 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
378 } else {
379 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
382 if (period_elapsed)
383 snd_pcm_period_elapsed(subs->pcm_substream);
384 return 0;
388 * Process after capture complete when paused. Nothing to do.
390 static int retire_paused_capture_urb(struct snd_usb_substream *subs,
391 struct snd_pcm_runtime *runtime,
392 struct urb *urb)
394 return 0;
399 * prepare urb for full speed playback sync pipe
401 * set up the offset and length to receive the current frequency.
404 static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
405 struct snd_pcm_runtime *runtime,
406 struct urb *urb)
408 struct snd_urb_ctx *ctx = urb->context;
410 urb->dev = ctx->subs->dev; /* we need to set this at each time */
411 urb->iso_frame_desc[0].length = 3;
412 urb->iso_frame_desc[0].offset = 0;
413 return 0;
417 * prepare urb for high speed playback sync pipe
419 * set up the offset and length to receive the current frequency.
422 static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
423 struct snd_pcm_runtime *runtime,
424 struct urb *urb)
426 struct snd_urb_ctx *ctx = urb->context;
428 urb->dev = ctx->subs->dev; /* we need to set this at each time */
429 urb->iso_frame_desc[0].length = 4;
430 urb->iso_frame_desc[0].offset = 0;
431 return 0;
435 * process after full speed playback sync complete
437 * retrieve the current 10.14 frequency from pipe, and set it.
438 * the value is referred in prepare_playback_urb().
440 static int retire_playback_sync_urb(struct snd_usb_substream *subs,
441 struct snd_pcm_runtime *runtime,
442 struct urb *urb)
444 unsigned int f;
445 unsigned long flags;
447 if (urb->iso_frame_desc[0].status == 0 &&
448 urb->iso_frame_desc[0].actual_length == 3) {
449 f = combine_triple((u8*)urb->transfer_buffer) << 2;
450 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
451 spin_lock_irqsave(&subs->lock, flags);
452 subs->freqm = f;
453 spin_unlock_irqrestore(&subs->lock, flags);
457 return 0;
461 * process after high speed playback sync complete
463 * retrieve the current 12.13 frequency from pipe, and set it.
464 * the value is referred in prepare_playback_urb().
466 static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
467 struct snd_pcm_runtime *runtime,
468 struct urb *urb)
470 unsigned int f;
471 unsigned long flags;
473 if (urb->iso_frame_desc[0].status == 0 &&
474 urb->iso_frame_desc[0].actual_length == 4) {
475 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
476 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
477 spin_lock_irqsave(&subs->lock, flags);
478 subs->freqm = f;
479 spin_unlock_irqrestore(&subs->lock, flags);
483 return 0;
487 * process after E-Mu 0202/0404/Tracker Pre high speed playback sync complete
489 * These devices return the number of samples per packet instead of the number
490 * of samples per microframe.
492 static int retire_playback_sync_urb_hs_emu(struct snd_usb_substream *subs,
493 struct snd_pcm_runtime *runtime,
494 struct urb *urb)
496 unsigned int f;
497 unsigned long flags;
499 if (urb->iso_frame_desc[0].status == 0 &&
500 urb->iso_frame_desc[0].actual_length == 4) {
501 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
502 f >>= subs->datainterval;
503 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
504 spin_lock_irqsave(&subs->lock, flags);
505 subs->freqm = f;
506 spin_unlock_irqrestore(&subs->lock, flags);
510 return 0;
513 /* determine the number of frames in the next packet */
514 static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
516 if (subs->fill_max)
517 return subs->maxframesize;
518 else {
519 subs->phase = (subs->phase & 0xffff)
520 + (subs->freqm << subs->datainterval);
521 return min(subs->phase >> 16, subs->maxframesize);
526 * Prepare urb for streaming before playback starts or when paused.
528 * We don't have any data, so we send silence.
530 static int prepare_nodata_playback_urb(struct snd_usb_substream *subs,
531 struct snd_pcm_runtime *runtime,
532 struct urb *urb)
534 unsigned int i, offs, counts;
535 struct snd_urb_ctx *ctx = urb->context;
536 int stride = runtime->frame_bits >> 3;
538 offs = 0;
539 urb->dev = ctx->subs->dev;
540 for (i = 0; i < ctx->packets; ++i) {
541 counts = snd_usb_audio_next_packet_size(subs);
542 urb->iso_frame_desc[i].offset = offs * stride;
543 urb->iso_frame_desc[i].length = counts * stride;
544 offs += counts;
546 urb->number_of_packets = ctx->packets;
547 urb->transfer_buffer_length = offs * stride;
548 memset(urb->transfer_buffer,
549 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
550 offs * stride);
551 return 0;
555 * prepare urb for playback data pipe
557 * Since a URB can handle only a single linear buffer, we must use double
558 * buffering when the data to be transferred overflows the buffer boundary.
559 * To avoid inconsistencies when updating hwptr_done, we use double buffering
560 * for all URBs.
562 static int prepare_playback_urb(struct snd_usb_substream *subs,
563 struct snd_pcm_runtime *runtime,
564 struct urb *urb)
566 int i, stride, offs;
567 unsigned int counts;
568 unsigned long flags;
569 int period_elapsed = 0;
570 struct snd_urb_ctx *ctx = urb->context;
572 stride = runtime->frame_bits >> 3;
574 offs = 0;
575 urb->dev = ctx->subs->dev; /* we need to set this at each time */
576 urb->number_of_packets = 0;
577 spin_lock_irqsave(&subs->lock, flags);
578 for (i = 0; i < ctx->packets; i++) {
579 counts = snd_usb_audio_next_packet_size(subs);
580 /* set up descriptor */
581 urb->iso_frame_desc[i].offset = offs * stride;
582 urb->iso_frame_desc[i].length = counts * stride;
583 offs += counts;
584 urb->number_of_packets++;
585 subs->transfer_done += counts;
586 if (subs->transfer_done >= runtime->period_size) {
587 subs->transfer_done -= runtime->period_size;
588 period_elapsed = 1;
589 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
590 if (subs->transfer_done > 0) {
591 /* FIXME: fill-max mode is not
592 * supported yet */
593 offs -= subs->transfer_done;
594 counts -= subs->transfer_done;
595 urb->iso_frame_desc[i].length =
596 counts * stride;
597 subs->transfer_done = 0;
599 i++;
600 if (i < ctx->packets) {
601 /* add a transfer delimiter */
602 urb->iso_frame_desc[i].offset =
603 offs * stride;
604 urb->iso_frame_desc[i].length = 0;
605 urb->number_of_packets++;
607 break;
610 if (period_elapsed) /* finish at the period boundary */
611 break;
613 if (subs->hwptr_done + offs > runtime->buffer_size) {
614 /* err, the transferred area goes over buffer boundary. */
615 unsigned int len = runtime->buffer_size - subs->hwptr_done;
616 memcpy(urb->transfer_buffer,
617 runtime->dma_area + subs->hwptr_done * stride,
618 len * stride);
619 memcpy(urb->transfer_buffer + len * stride,
620 runtime->dma_area,
621 (offs - len) * stride);
622 } else {
623 memcpy(urb->transfer_buffer,
624 runtime->dma_area + subs->hwptr_done * stride,
625 offs * stride);
627 subs->hwptr_done += offs;
628 if (subs->hwptr_done >= runtime->buffer_size)
629 subs->hwptr_done -= runtime->buffer_size;
630 runtime->delay += offs;
631 spin_unlock_irqrestore(&subs->lock, flags);
632 urb->transfer_buffer_length = offs * stride;
633 if (period_elapsed)
634 snd_pcm_period_elapsed(subs->pcm_substream);
635 return 0;
639 * process after playback data complete
640 * - decrease the delay count again
642 static int retire_playback_urb(struct snd_usb_substream *subs,
643 struct snd_pcm_runtime *runtime,
644 struct urb *urb)
646 unsigned long flags;
647 int stride = runtime->frame_bits >> 3;
648 int processed = urb->transfer_buffer_length / stride;
650 spin_lock_irqsave(&subs->lock, flags);
651 if (processed > runtime->delay)
652 runtime->delay = 0;
653 else
654 runtime->delay -= processed;
655 spin_unlock_irqrestore(&subs->lock, flags);
656 return 0;
662 static struct snd_urb_ops audio_urb_ops[2] = {
664 .prepare = prepare_nodata_playback_urb,
665 .retire = retire_playback_urb,
666 .prepare_sync = prepare_playback_sync_urb,
667 .retire_sync = retire_playback_sync_urb,
670 .prepare = prepare_capture_urb,
671 .retire = retire_capture_urb,
672 .prepare_sync = prepare_capture_sync_urb,
673 .retire_sync = retire_capture_sync_urb,
677 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
679 .prepare = prepare_nodata_playback_urb,
680 .retire = retire_playback_urb,
681 .prepare_sync = prepare_playback_sync_urb_hs,
682 .retire_sync = retire_playback_sync_urb_hs,
685 .prepare = prepare_capture_urb,
686 .retire = retire_capture_urb,
687 .prepare_sync = prepare_capture_sync_urb_hs,
688 .retire_sync = retire_capture_sync_urb,
693 * complete callback from data urb
695 static void snd_complete_urb(struct urb *urb)
697 struct snd_urb_ctx *ctx = urb->context;
698 struct snd_usb_substream *subs = ctx->subs;
699 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
700 int err = 0;
702 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
703 !subs->running || /* can be stopped during retire callback */
704 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
705 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
706 clear_bit(ctx->index, &subs->active_mask);
707 if (err < 0) {
708 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
709 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
716 * complete callback from sync urb
718 static void snd_complete_sync_urb(struct urb *urb)
720 struct snd_urb_ctx *ctx = urb->context;
721 struct snd_usb_substream *subs = ctx->subs;
722 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
723 int err = 0;
725 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
726 !subs->running || /* can be stopped during retire callback */
727 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
728 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
729 clear_bit(ctx->index + 16, &subs->active_mask);
730 if (err < 0) {
731 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
732 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
738 /* get the physical page pointer at the given offset */
739 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
740 unsigned long offset)
742 void *pageptr = subs->runtime->dma_area + offset;
743 return vmalloc_to_page(pageptr);
746 /* allocate virtual buffer; may be called more than once */
747 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
749 struct snd_pcm_runtime *runtime = subs->runtime;
750 if (runtime->dma_area) {
751 if (runtime->dma_bytes >= size)
752 return 0; /* already large enough */
753 vfree(runtime->dma_area);
755 runtime->dma_area = vmalloc(size);
756 if (!runtime->dma_area)
757 return -ENOMEM;
758 runtime->dma_bytes = size;
759 return 0;
762 /* free virtual buffer; may be called more than once */
763 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
765 struct snd_pcm_runtime *runtime = subs->runtime;
767 vfree(runtime->dma_area);
768 runtime->dma_area = NULL;
769 return 0;
774 * unlink active urbs.
776 static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
778 unsigned int i;
779 int async;
781 subs->running = 0;
783 if (!force && subs->stream->chip->shutdown) /* to be sure... */
784 return -EBADFD;
786 async = !can_sleep && async_unlink;
788 if (!async && in_interrupt())
789 return 0;
791 for (i = 0; i < subs->nurbs; i++) {
792 if (test_bit(i, &subs->active_mask)) {
793 if (!test_and_set_bit(i, &subs->unlink_mask)) {
794 struct urb *u = subs->dataurb[i].urb;
795 if (async)
796 usb_unlink_urb(u);
797 else
798 usb_kill_urb(u);
802 if (subs->syncpipe) {
803 for (i = 0; i < SYNC_URBS; i++) {
804 if (test_bit(i+16, &subs->active_mask)) {
805 if (!test_and_set_bit(i+16, &subs->unlink_mask)) {
806 struct urb *u = subs->syncurb[i].urb;
807 if (async)
808 usb_unlink_urb(u);
809 else
810 usb_kill_urb(u);
815 return 0;
819 static const char *usb_error_string(int err)
821 switch (err) {
822 case -ENODEV:
823 return "no device";
824 case -ENOENT:
825 return "endpoint not enabled";
826 case -EPIPE:
827 return "endpoint stalled";
828 case -ENOSPC:
829 return "not enough bandwidth";
830 case -ESHUTDOWN:
831 return "device disabled";
832 case -EHOSTUNREACH:
833 return "device suspended";
834 case -EINVAL:
835 case -EAGAIN:
836 case -EFBIG:
837 case -EMSGSIZE:
838 return "internal error";
839 default:
840 return "unknown error";
845 * set up and start data/sync urbs
847 static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
849 unsigned int i;
850 int err;
852 if (subs->stream->chip->shutdown)
853 return -EBADFD;
855 for (i = 0; i < subs->nurbs; i++) {
856 if (snd_BUG_ON(!subs->dataurb[i].urb))
857 return -EINVAL;
858 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
859 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
860 goto __error;
863 if (subs->syncpipe) {
864 for (i = 0; i < SYNC_URBS; i++) {
865 if (snd_BUG_ON(!subs->syncurb[i].urb))
866 return -EINVAL;
867 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
868 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
869 goto __error;
874 subs->active_mask = 0;
875 subs->unlink_mask = 0;
876 subs->running = 1;
877 for (i = 0; i < subs->nurbs; i++) {
878 err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
879 if (err < 0) {
880 snd_printk(KERN_ERR "cannot submit datapipe "
881 "for urb %d, error %d: %s\n",
882 i, err, usb_error_string(err));
883 goto __error;
885 set_bit(i, &subs->active_mask);
887 if (subs->syncpipe) {
888 for (i = 0; i < SYNC_URBS; i++) {
889 err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
890 if (err < 0) {
891 snd_printk(KERN_ERR "cannot submit syncpipe "
892 "for urb %d, error %d: %s\n",
893 i, err, usb_error_string(err));
894 goto __error;
896 set_bit(i + 16, &subs->active_mask);
899 return 0;
901 __error:
902 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
903 deactivate_urbs(subs, 0, 0);
904 return -EPIPE;
909 * wait until all urbs are processed.
911 static int wait_clear_urbs(struct snd_usb_substream *subs)
913 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
914 unsigned int i;
915 int alive;
917 do {
918 alive = 0;
919 for (i = 0; i < subs->nurbs; i++) {
920 if (test_bit(i, &subs->active_mask))
921 alive++;
923 if (subs->syncpipe) {
924 for (i = 0; i < SYNC_URBS; i++) {
925 if (test_bit(i + 16, &subs->active_mask))
926 alive++;
929 if (! alive)
930 break;
931 schedule_timeout_uninterruptible(1);
932 } while (time_before(jiffies, end_time));
933 if (alive)
934 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
935 return 0;
940 * return the current pcm pointer. just return the hwptr_done value.
942 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
944 struct snd_usb_substream *subs;
945 snd_pcm_uframes_t hwptr_done;
947 subs = (struct snd_usb_substream *)substream->runtime->private_data;
948 spin_lock(&subs->lock);
949 hwptr_done = subs->hwptr_done;
950 spin_unlock(&subs->lock);
951 return hwptr_done;
956 * start/stop playback substream
958 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
959 int cmd)
961 struct snd_usb_substream *subs = substream->runtime->private_data;
963 switch (cmd) {
964 case SNDRV_PCM_TRIGGER_START:
965 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
966 subs->ops.prepare = prepare_playback_urb;
967 return 0;
968 case SNDRV_PCM_TRIGGER_STOP:
969 return deactivate_urbs(subs, 0, 0);
970 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
971 subs->ops.prepare = prepare_nodata_playback_urb;
972 return 0;
973 default:
974 return -EINVAL;
979 * start/stop capture substream
981 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
982 int cmd)
984 struct snd_usb_substream *subs = substream->runtime->private_data;
986 switch (cmd) {
987 case SNDRV_PCM_TRIGGER_START:
988 subs->ops.retire = retire_capture_urb;
989 return start_urbs(subs, substream->runtime);
990 case SNDRV_PCM_TRIGGER_STOP:
991 return deactivate_urbs(subs, 0, 0);
992 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
993 subs->ops.retire = retire_paused_capture_urb;
994 return 0;
995 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
996 subs->ops.retire = retire_capture_urb;
997 return 0;
998 default:
999 return -EINVAL;
1005 * release a urb data
1007 static void release_urb_ctx(struct snd_urb_ctx *u)
1009 if (u->urb) {
1010 if (u->buffer_size)
1011 usb_buffer_free(u->subs->dev, u->buffer_size,
1012 u->urb->transfer_buffer,
1013 u->urb->transfer_dma);
1014 usb_free_urb(u->urb);
1015 u->urb = NULL;
1020 * release a substream
1022 static void release_substream_urbs(struct snd_usb_substream *subs, int force)
1024 int i;
1026 /* stop urbs (to be sure) */
1027 deactivate_urbs(subs, force, 1);
1028 wait_clear_urbs(subs);
1030 for (i = 0; i < MAX_URBS; i++)
1031 release_urb_ctx(&subs->dataurb[i]);
1032 for (i = 0; i < SYNC_URBS; i++)
1033 release_urb_ctx(&subs->syncurb[i]);
1034 usb_buffer_free(subs->dev, SYNC_URBS * 4,
1035 subs->syncbuf, subs->sync_dma);
1036 subs->syncbuf = NULL;
1037 subs->nurbs = 0;
1041 * initialize a substream for plaback/capture
1043 static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
1044 unsigned int rate, unsigned int frame_bits)
1046 unsigned int maxsize, i;
1047 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1048 unsigned int urb_packs, total_packs, packs_per_ms;
1050 /* calculate the frequency in 16.16 format */
1051 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1052 subs->freqn = get_usb_full_speed_rate(rate);
1053 else
1054 subs->freqn = get_usb_high_speed_rate(rate);
1055 subs->freqm = subs->freqn;
1056 /* calculate max. frequency */
1057 if (subs->maxpacksize) {
1058 /* whatever fits into a max. size packet */
1059 maxsize = subs->maxpacksize;
1060 subs->freqmax = (maxsize / (frame_bits >> 3))
1061 << (16 - subs->datainterval);
1062 } else {
1063 /* no max. packet size: just take 25% higher than nominal */
1064 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1065 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1066 >> (16 - subs->datainterval);
1068 subs->phase = 0;
1070 if (subs->fill_max)
1071 subs->curpacksize = subs->maxpacksize;
1072 else
1073 subs->curpacksize = maxsize;
1075 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1076 packs_per_ms = 8 >> subs->datainterval;
1077 else
1078 packs_per_ms = 1;
1080 if (is_playback) {
1081 urb_packs = max(nrpacks, 1);
1082 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1083 } else
1084 urb_packs = 1;
1085 urb_packs *= packs_per_ms;
1087 /* decide how many packets to be used */
1088 if (is_playback) {
1089 unsigned int minsize, maxpacks;
1090 /* determine how small a packet can be */
1091 minsize = (subs->freqn >> (16 - subs->datainterval))
1092 * (frame_bits >> 3);
1093 /* with sync from device, assume it can be 12% lower */
1094 if (subs->syncpipe)
1095 minsize -= minsize >> 3;
1096 minsize = max(minsize, 1u);
1097 total_packs = (period_bytes + minsize - 1) / minsize;
1098 /* we need at least two URBs for queueing */
1099 if (total_packs < 2) {
1100 total_packs = 2;
1101 } else {
1102 /* and we don't want too long a queue either */
1103 maxpacks = max(MAX_QUEUE * packs_per_ms, urb_packs * 2);
1104 total_packs = min(total_packs, maxpacks);
1106 } else {
1107 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
1108 urb_packs >>= 1;
1109 total_packs = MAX_URBS * urb_packs;
1111 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1112 if (subs->nurbs > MAX_URBS) {
1113 /* too much... */
1114 subs->nurbs = MAX_URBS;
1115 total_packs = MAX_URBS * urb_packs;
1116 } else if (subs->nurbs < 2) {
1117 /* too little - we need at least two packets
1118 * to ensure contiguous playback/capture
1120 subs->nurbs = 2;
1123 /* allocate and initialize data urbs */
1124 for (i = 0; i < subs->nurbs; i++) {
1125 struct snd_urb_ctx *u = &subs->dataurb[i];
1126 u->index = i;
1127 u->subs = subs;
1128 u->packets = (i + 1) * total_packs / subs->nurbs
1129 - i * total_packs / subs->nurbs;
1130 u->buffer_size = maxsize * u->packets;
1131 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1132 u->packets++; /* for transfer delimiter */
1133 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1134 if (!u->urb)
1135 goto out_of_memory;
1136 u->urb->transfer_buffer =
1137 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1138 &u->urb->transfer_dma);
1139 if (!u->urb->transfer_buffer)
1140 goto out_of_memory;
1141 u->urb->pipe = subs->datapipe;
1142 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1143 u->urb->interval = 1 << subs->datainterval;
1144 u->urb->context = u;
1145 u->urb->complete = snd_complete_urb;
1148 if (subs->syncpipe) {
1149 /* allocate and initialize sync urbs */
1150 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1151 GFP_KERNEL, &subs->sync_dma);
1152 if (!subs->syncbuf)
1153 goto out_of_memory;
1154 for (i = 0; i < SYNC_URBS; i++) {
1155 struct snd_urb_ctx *u = &subs->syncurb[i];
1156 u->index = i;
1157 u->subs = subs;
1158 u->packets = 1;
1159 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1160 if (!u->urb)
1161 goto out_of_memory;
1162 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1163 u->urb->transfer_dma = subs->sync_dma + i * 4;
1164 u->urb->transfer_buffer_length = 4;
1165 u->urb->pipe = subs->syncpipe;
1166 u->urb->transfer_flags = URB_ISO_ASAP |
1167 URB_NO_TRANSFER_DMA_MAP;
1168 u->urb->number_of_packets = 1;
1169 u->urb->interval = 1 << subs->syncinterval;
1170 u->urb->context = u;
1171 u->urb->complete = snd_complete_sync_urb;
1174 return 0;
1176 out_of_memory:
1177 release_substream_urbs(subs, 0);
1178 return -ENOMEM;
1183 * find a matching audio format
1185 static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
1186 unsigned int rate, unsigned int channels)
1188 struct list_head *p;
1189 struct audioformat *found = NULL;
1190 int cur_attr = 0, attr;
1192 list_for_each(p, &subs->fmt_list) {
1193 struct audioformat *fp;
1194 fp = list_entry(p, struct audioformat, list);
1195 if (fp->format != format || fp->channels != channels)
1196 continue;
1197 if (rate < fp->rate_min || rate > fp->rate_max)
1198 continue;
1199 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1200 unsigned int i;
1201 for (i = 0; i < fp->nr_rates; i++)
1202 if (fp->rate_table[i] == rate)
1203 break;
1204 if (i >= fp->nr_rates)
1205 continue;
1207 attr = fp->ep_attr & EP_ATTR_MASK;
1208 if (! found) {
1209 found = fp;
1210 cur_attr = attr;
1211 continue;
1213 /* avoid async out and adaptive in if the other method
1214 * supports the same format.
1215 * this is a workaround for the case like
1216 * M-audio audiophile USB.
1218 if (attr != cur_attr) {
1219 if ((attr == EP_ATTR_ASYNC &&
1220 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1221 (attr == EP_ATTR_ADAPTIVE &&
1222 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1223 continue;
1224 if ((cur_attr == EP_ATTR_ASYNC &&
1225 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1226 (cur_attr == EP_ATTR_ADAPTIVE &&
1227 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1228 found = fp;
1229 cur_attr = attr;
1230 continue;
1233 /* find the format with the largest max. packet size */
1234 if (fp->maxpacksize > found->maxpacksize) {
1235 found = fp;
1236 cur_attr = attr;
1239 return found;
1244 * initialize the picth control and sample rate
1246 static int init_usb_pitch(struct usb_device *dev, int iface,
1247 struct usb_host_interface *alts,
1248 struct audioformat *fmt)
1250 unsigned int ep;
1251 unsigned char data[1];
1252 int err;
1254 ep = get_endpoint(alts, 0)->bEndpointAddress;
1255 /* if endpoint has pitch control, enable it */
1256 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1257 data[0] = 1;
1258 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1259 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1260 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1261 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1262 dev->devnum, iface, ep);
1263 return err;
1266 return 0;
1269 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1270 struct usb_host_interface *alts,
1271 struct audioformat *fmt, int rate)
1273 unsigned int ep;
1274 unsigned char data[3];
1275 int err;
1277 ep = get_endpoint(alts, 0)->bEndpointAddress;
1278 /* if endpoint has sampling rate control, set it */
1279 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1280 int crate;
1281 data[0] = rate;
1282 data[1] = rate >> 8;
1283 data[2] = rate >> 16;
1284 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1285 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1286 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1287 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep %#x\n",
1288 dev->devnum, iface, fmt->altsetting, rate, ep);
1289 return err;
1291 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1292 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1293 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1294 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep %#x\n",
1295 dev->devnum, iface, fmt->altsetting, ep);
1296 return 0; /* some devices don't support reading */
1298 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1299 if (crate != rate) {
1300 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1301 // runtime->rate = crate;
1304 return 0;
1308 * find a matching format and set up the interface
1310 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
1312 struct usb_device *dev = subs->dev;
1313 struct usb_host_interface *alts;
1314 struct usb_interface_descriptor *altsd;
1315 struct usb_interface *iface;
1316 unsigned int ep, attr;
1317 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1318 int err;
1320 iface = usb_ifnum_to_if(dev, fmt->iface);
1321 if (WARN_ON(!iface))
1322 return -EINVAL;
1323 alts = &iface->altsetting[fmt->altset_idx];
1324 altsd = get_iface_desc(alts);
1325 if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
1326 return -EINVAL;
1328 if (fmt == subs->cur_audiofmt)
1329 return 0;
1331 /* close the old interface */
1332 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1333 if (usb_set_interface(subs->dev, subs->interface, 0) < 0) {
1334 snd_printk(KERN_ERR "%d:%d:%d: return to setting 0 failed\n",
1335 dev->devnum, fmt->iface, fmt->altsetting);
1336 return -EIO;
1338 subs->interface = -1;
1339 subs->format = 0;
1342 /* set interface */
1343 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1344 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1345 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1346 dev->devnum, fmt->iface, fmt->altsetting);
1347 return -EIO;
1349 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1350 subs->interface = fmt->iface;
1351 subs->format = fmt->altset_idx;
1354 /* create a data pipe */
1355 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1356 if (is_playback)
1357 subs->datapipe = usb_sndisocpipe(dev, ep);
1358 else
1359 subs->datapipe = usb_rcvisocpipe(dev, ep);
1360 subs->datainterval = fmt->datainterval;
1361 subs->syncpipe = subs->syncinterval = 0;
1362 subs->maxpacksize = fmt->maxpacksize;
1363 subs->fill_max = 0;
1365 /* we need a sync pipe in async OUT or adaptive IN mode */
1366 /* check the number of EP, since some devices have broken
1367 * descriptors which fool us. if it has only one EP,
1368 * assume it as adaptive-out or sync-in.
1370 attr = fmt->ep_attr & EP_ATTR_MASK;
1371 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1372 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1373 altsd->bNumEndpoints >= 2) {
1374 /* check sync-pipe endpoint */
1375 /* ... and check descriptor size before accessing bSynchAddress
1376 because there is a version of the SB Audigy 2 NX firmware lacking
1377 the audio fields in the endpoint descriptors */
1378 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1379 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1380 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1381 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1382 dev->devnum, fmt->iface, fmt->altsetting);
1383 return -EINVAL;
1385 ep = get_endpoint(alts, 1)->bEndpointAddress;
1386 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1387 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1388 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1389 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1390 dev->devnum, fmt->iface, fmt->altsetting);
1391 return -EINVAL;
1393 ep &= USB_ENDPOINT_NUMBER_MASK;
1394 if (is_playback)
1395 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1396 else
1397 subs->syncpipe = usb_sndisocpipe(dev, ep);
1398 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1399 get_endpoint(alts, 1)->bRefresh >= 1 &&
1400 get_endpoint(alts, 1)->bRefresh <= 9)
1401 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1402 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1403 subs->syncinterval = 1;
1404 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1405 get_endpoint(alts, 1)->bInterval <= 16)
1406 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1407 else
1408 subs->syncinterval = 3;
1411 /* always fill max packet size */
1412 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1413 subs->fill_max = 1;
1415 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1416 return err;
1418 subs->cur_audiofmt = fmt;
1420 #if 0
1421 printk(KERN_DEBUG
1422 "setting done: format = %d, rate = %d..%d, channels = %d\n",
1423 fmt->format, fmt->rate_min, fmt->rate_max, fmt->channels);
1424 printk(KERN_DEBUG
1425 " datapipe = 0x%0x, syncpipe = 0x%0x\n",
1426 subs->datapipe, subs->syncpipe);
1427 #endif
1429 return 0;
1433 * hw_params callback
1435 * allocate a buffer and set the given audio format.
1437 * so far we use a physically linear buffer although packetize transfer
1438 * doesn't need a continuous area.
1439 * if sg buffer is supported on the later version of alsa, we'll follow
1440 * that.
1442 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1443 struct snd_pcm_hw_params *hw_params)
1445 struct snd_usb_substream *subs = substream->runtime->private_data;
1446 struct audioformat *fmt;
1447 unsigned int channels, rate, format;
1448 int ret, changed;
1450 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1451 params_buffer_bytes(hw_params));
1452 if (ret < 0)
1453 return ret;
1455 format = params_format(hw_params);
1456 rate = params_rate(hw_params);
1457 channels = params_channels(hw_params);
1458 fmt = find_format(subs, format, rate, channels);
1459 if (!fmt) {
1460 snd_printd(KERN_DEBUG "cannot set format: format = %#x, rate = %d, channels = %d\n",
1461 format, rate, channels);
1462 return -EINVAL;
1465 changed = subs->cur_audiofmt != fmt ||
1466 subs->period_bytes != params_period_bytes(hw_params) ||
1467 subs->cur_rate != rate;
1468 if ((ret = set_format(subs, fmt)) < 0)
1469 return ret;
1471 if (subs->cur_rate != rate) {
1472 struct usb_host_interface *alts;
1473 struct usb_interface *iface;
1474 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1475 alts = &iface->altsetting[fmt->altset_idx];
1476 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1477 if (ret < 0)
1478 return ret;
1479 subs->cur_rate = rate;
1482 if (changed) {
1483 /* format changed */
1484 release_substream_urbs(subs, 0);
1485 /* influenced: period_bytes, channels, rate, format, */
1486 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1487 params_rate(hw_params),
1488 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1491 return ret;
1495 * hw_free callback
1497 * reset the audio format and release the buffer
1499 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
1501 struct snd_usb_substream *subs = substream->runtime->private_data;
1503 subs->cur_audiofmt = NULL;
1504 subs->cur_rate = 0;
1505 subs->period_bytes = 0;
1506 if (!subs->stream->chip->shutdown)
1507 release_substream_urbs(subs, 0);
1508 return snd_pcm_free_vmalloc_buffer(substream);
1512 * prepare callback
1514 * only a few subtle things...
1516 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
1518 struct snd_pcm_runtime *runtime = substream->runtime;
1519 struct snd_usb_substream *subs = runtime->private_data;
1521 if (! subs->cur_audiofmt) {
1522 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1523 return -ENXIO;
1526 /* some unit conversions in runtime */
1527 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1528 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1530 /* reset the pointer */
1531 subs->hwptr_done = 0;
1532 subs->transfer_done = 0;
1533 subs->phase = 0;
1534 runtime->delay = 0;
1536 /* clear urbs (to be sure) */
1537 deactivate_urbs(subs, 0, 1);
1538 wait_clear_urbs(subs);
1540 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1541 * updates for all URBs would happen at the same time when starting */
1542 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1543 subs->ops.prepare = prepare_nodata_playback_urb;
1544 return start_urbs(subs, runtime);
1545 } else
1546 return 0;
1549 static struct snd_pcm_hardware snd_usb_hardware =
1551 .info = SNDRV_PCM_INFO_MMAP |
1552 SNDRV_PCM_INFO_MMAP_VALID |
1553 SNDRV_PCM_INFO_BATCH |
1554 SNDRV_PCM_INFO_INTERLEAVED |
1555 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1556 SNDRV_PCM_INFO_PAUSE,
1557 .buffer_bytes_max = 1024 * 1024,
1558 .period_bytes_min = 64,
1559 .period_bytes_max = 512 * 1024,
1560 .periods_min = 2,
1561 .periods_max = 1024,
1565 * h/w constraints
1568 #ifdef HW_CONST_DEBUG
1569 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1570 #else
1571 #define hwc_debug(fmt, args...) /**/
1572 #endif
1574 static int hw_check_valid_format(struct snd_usb_substream *subs,
1575 struct snd_pcm_hw_params *params,
1576 struct audioformat *fp)
1578 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1579 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1580 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1581 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
1582 unsigned int ptime;
1584 /* check the format */
1585 if (!snd_mask_test(fmts, fp->format)) {
1586 hwc_debug(" > check: no supported format %d\n", fp->format);
1587 return 0;
1589 /* check the channels */
1590 if (fp->channels < ct->min || fp->channels > ct->max) {
1591 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1592 return 0;
1594 /* check the rate is within the range */
1595 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1596 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1597 return 0;
1599 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1600 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1601 return 0;
1603 /* check whether the period time is >= the data packet interval */
1604 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH) {
1605 ptime = 125 * (1 << fp->datainterval);
1606 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
1607 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max);
1608 return 0;
1611 return 1;
1614 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1615 struct snd_pcm_hw_rule *rule)
1617 struct snd_usb_substream *subs = rule->private;
1618 struct list_head *p;
1619 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1620 unsigned int rmin, rmax;
1621 int changed;
1623 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1624 changed = 0;
1625 rmin = rmax = 0;
1626 list_for_each(p, &subs->fmt_list) {
1627 struct audioformat *fp;
1628 fp = list_entry(p, struct audioformat, list);
1629 if (!hw_check_valid_format(subs, params, fp))
1630 continue;
1631 if (changed++) {
1632 if (rmin > fp->rate_min)
1633 rmin = fp->rate_min;
1634 if (rmax < fp->rate_max)
1635 rmax = fp->rate_max;
1636 } else {
1637 rmin = fp->rate_min;
1638 rmax = fp->rate_max;
1642 if (!changed) {
1643 hwc_debug(" --> get empty\n");
1644 it->empty = 1;
1645 return -EINVAL;
1648 changed = 0;
1649 if (it->min < rmin) {
1650 it->min = rmin;
1651 it->openmin = 0;
1652 changed = 1;
1654 if (it->max > rmax) {
1655 it->max = rmax;
1656 it->openmax = 0;
1657 changed = 1;
1659 if (snd_interval_checkempty(it)) {
1660 it->empty = 1;
1661 return -EINVAL;
1663 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1664 return changed;
1668 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1669 struct snd_pcm_hw_rule *rule)
1671 struct snd_usb_substream *subs = rule->private;
1672 struct list_head *p;
1673 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1674 unsigned int rmin, rmax;
1675 int changed;
1677 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1678 changed = 0;
1679 rmin = rmax = 0;
1680 list_for_each(p, &subs->fmt_list) {
1681 struct audioformat *fp;
1682 fp = list_entry(p, struct audioformat, list);
1683 if (!hw_check_valid_format(subs, params, fp))
1684 continue;
1685 if (changed++) {
1686 if (rmin > fp->channels)
1687 rmin = fp->channels;
1688 if (rmax < fp->channels)
1689 rmax = fp->channels;
1690 } else {
1691 rmin = fp->channels;
1692 rmax = fp->channels;
1696 if (!changed) {
1697 hwc_debug(" --> get empty\n");
1698 it->empty = 1;
1699 return -EINVAL;
1702 changed = 0;
1703 if (it->min < rmin) {
1704 it->min = rmin;
1705 it->openmin = 0;
1706 changed = 1;
1708 if (it->max > rmax) {
1709 it->max = rmax;
1710 it->openmax = 0;
1711 changed = 1;
1713 if (snd_interval_checkempty(it)) {
1714 it->empty = 1;
1715 return -EINVAL;
1717 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1718 return changed;
1721 static int hw_rule_format(struct snd_pcm_hw_params *params,
1722 struct snd_pcm_hw_rule *rule)
1724 struct snd_usb_substream *subs = rule->private;
1725 struct list_head *p;
1726 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1727 u64 fbits;
1728 u32 oldbits[2];
1729 int changed;
1731 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1732 fbits = 0;
1733 list_for_each(p, &subs->fmt_list) {
1734 struct audioformat *fp;
1735 fp = list_entry(p, struct audioformat, list);
1736 if (!hw_check_valid_format(subs, params, fp))
1737 continue;
1738 fbits |= (1ULL << fp->format);
1741 oldbits[0] = fmt->bits[0];
1742 oldbits[1] = fmt->bits[1];
1743 fmt->bits[0] &= (u32)fbits;
1744 fmt->bits[1] &= (u32)(fbits >> 32);
1745 if (!fmt->bits[0] && !fmt->bits[1]) {
1746 hwc_debug(" --> get empty\n");
1747 return -EINVAL;
1749 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1750 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1751 return changed;
1754 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
1755 struct snd_pcm_hw_rule *rule)
1757 struct snd_usb_substream *subs = rule->private;
1758 struct audioformat *fp;
1759 struct snd_interval *it;
1760 unsigned char min_datainterval;
1761 unsigned int pmin;
1762 int changed;
1764 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
1765 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
1766 min_datainterval = 0xff;
1767 list_for_each_entry(fp, &subs->fmt_list, list) {
1768 if (!hw_check_valid_format(subs, params, fp))
1769 continue;
1770 min_datainterval = min(min_datainterval, fp->datainterval);
1772 if (min_datainterval == 0xff) {
1773 hwc_debug(" --> get emtpy\n");
1774 it->empty = 1;
1775 return -EINVAL;
1777 pmin = 125 * (1 << min_datainterval);
1778 changed = 0;
1779 if (it->min < pmin) {
1780 it->min = pmin;
1781 it->openmin = 0;
1782 changed = 1;
1784 if (snd_interval_checkempty(it)) {
1785 it->empty = 1;
1786 return -EINVAL;
1788 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
1789 return changed;
1793 * If the device supports unusual bit rates, does the request meet these?
1795 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1796 struct snd_usb_substream *subs)
1798 struct audioformat *fp;
1799 int count = 0, needs_knot = 0;
1800 int err;
1802 list_for_each_entry(fp, &subs->fmt_list, list) {
1803 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1804 return 0;
1805 count += fp->nr_rates;
1806 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1807 needs_knot = 1;
1809 if (!needs_knot)
1810 return 0;
1812 subs->rate_list.count = count;
1813 subs->rate_list.list = kmalloc(sizeof(int) * count, GFP_KERNEL);
1814 subs->rate_list.mask = 0;
1815 count = 0;
1816 list_for_each_entry(fp, &subs->fmt_list, list) {
1817 int i;
1818 for (i = 0; i < fp->nr_rates; i++)
1819 subs->rate_list.list[count++] = fp->rate_table[i];
1821 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1822 &subs->rate_list);
1823 if (err < 0)
1824 return err;
1826 return 0;
1831 * set up the runtime hardware information.
1834 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1836 struct list_head *p;
1837 unsigned int pt, ptmin;
1838 int param_period_time_if_needed;
1839 int err;
1841 runtime->hw.formats = subs->formats;
1843 runtime->hw.rate_min = 0x7fffffff;
1844 runtime->hw.rate_max = 0;
1845 runtime->hw.channels_min = 256;
1846 runtime->hw.channels_max = 0;
1847 runtime->hw.rates = 0;
1848 ptmin = UINT_MAX;
1849 /* check min/max rates and channels */
1850 list_for_each(p, &subs->fmt_list) {
1851 struct audioformat *fp;
1852 fp = list_entry(p, struct audioformat, list);
1853 runtime->hw.rates |= fp->rates;
1854 if (runtime->hw.rate_min > fp->rate_min)
1855 runtime->hw.rate_min = fp->rate_min;
1856 if (runtime->hw.rate_max < fp->rate_max)
1857 runtime->hw.rate_max = fp->rate_max;
1858 if (runtime->hw.channels_min > fp->channels)
1859 runtime->hw.channels_min = fp->channels;
1860 if (runtime->hw.channels_max < fp->channels)
1861 runtime->hw.channels_max = fp->channels;
1862 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1863 /* FIXME: there might be more than one audio formats... */
1864 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1865 fp->frame_size;
1867 pt = 125 * (1 << fp->datainterval);
1868 ptmin = min(ptmin, pt);
1871 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1872 if (snd_usb_get_speed(subs->dev) != USB_SPEED_HIGH)
1873 /* full speed devices have fixed data packet interval */
1874 ptmin = 1000;
1875 if (ptmin == 1000)
1876 /* if period time doesn't go below 1 ms, no rules needed */
1877 param_period_time_if_needed = -1;
1878 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1879 ptmin, UINT_MAX);
1881 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1882 hw_rule_rate, subs,
1883 SNDRV_PCM_HW_PARAM_FORMAT,
1884 SNDRV_PCM_HW_PARAM_CHANNELS,
1885 param_period_time_if_needed,
1886 -1)) < 0)
1887 return err;
1888 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1889 hw_rule_channels, subs,
1890 SNDRV_PCM_HW_PARAM_FORMAT,
1891 SNDRV_PCM_HW_PARAM_RATE,
1892 param_period_time_if_needed,
1893 -1)) < 0)
1894 return err;
1895 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1896 hw_rule_format, subs,
1897 SNDRV_PCM_HW_PARAM_RATE,
1898 SNDRV_PCM_HW_PARAM_CHANNELS,
1899 param_period_time_if_needed,
1900 -1)) < 0)
1901 return err;
1902 if (param_period_time_if_needed >= 0) {
1903 err = snd_pcm_hw_rule_add(runtime, 0,
1904 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1905 hw_rule_period_time, subs,
1906 SNDRV_PCM_HW_PARAM_FORMAT,
1907 SNDRV_PCM_HW_PARAM_CHANNELS,
1908 SNDRV_PCM_HW_PARAM_RATE,
1909 -1);
1910 if (err < 0)
1911 return err;
1913 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1914 return err;
1915 return 0;
1918 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
1920 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1921 struct snd_pcm_runtime *runtime = substream->runtime;
1922 struct snd_usb_substream *subs = &as->substream[direction];
1924 subs->interface = -1;
1925 subs->format = 0;
1926 runtime->hw = snd_usb_hardware;
1927 runtime->private_data = subs;
1928 subs->pcm_substream = substream;
1929 return setup_hw_info(runtime, subs);
1932 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1934 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1935 struct snd_usb_substream *subs = &as->substream[direction];
1937 if (subs->interface >= 0) {
1938 usb_set_interface(subs->dev, subs->interface, 0);
1939 subs->interface = -1;
1941 subs->pcm_substream = NULL;
1942 return 0;
1945 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1947 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1950 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1952 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1955 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1957 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1960 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1962 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1965 static struct snd_pcm_ops snd_usb_playback_ops = {
1966 .open = snd_usb_playback_open,
1967 .close = snd_usb_playback_close,
1968 .ioctl = snd_pcm_lib_ioctl,
1969 .hw_params = snd_usb_hw_params,
1970 .hw_free = snd_usb_hw_free,
1971 .prepare = snd_usb_pcm_prepare,
1972 .trigger = snd_usb_pcm_playback_trigger,
1973 .pointer = snd_usb_pcm_pointer,
1974 .page = snd_pcm_get_vmalloc_page,
1977 static struct snd_pcm_ops snd_usb_capture_ops = {
1978 .open = snd_usb_capture_open,
1979 .close = snd_usb_capture_close,
1980 .ioctl = snd_pcm_lib_ioctl,
1981 .hw_params = snd_usb_hw_params,
1982 .hw_free = snd_usb_hw_free,
1983 .prepare = snd_usb_pcm_prepare,
1984 .trigger = snd_usb_pcm_capture_trigger,
1985 .pointer = snd_usb_pcm_pointer,
1986 .page = snd_pcm_get_vmalloc_page,
1992 * helper functions
1996 * combine bytes and get an integer value
1998 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
2000 switch (size) {
2001 case 1: return *bytes;
2002 case 2: return combine_word(bytes);
2003 case 3: return combine_triple(bytes);
2004 case 4: return combine_quad(bytes);
2005 default: return 0;
2010 * parse descriptor buffer and return the pointer starting the given
2011 * descriptor type.
2013 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
2015 u8 *p, *end, *next;
2017 p = descstart;
2018 end = p + desclen;
2019 for (; p < end;) {
2020 if (p[0] < 2)
2021 return NULL;
2022 next = p + p[0];
2023 if (next > end)
2024 return NULL;
2025 if (p[1] == dtype && (!after || (void *)p > after)) {
2026 return p;
2028 p = next;
2030 return NULL;
2034 * find a class-specified interface descriptor with the given subtype.
2036 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
2038 unsigned char *p = after;
2040 while ((p = snd_usb_find_desc(buffer, buflen, p,
2041 USB_DT_CS_INTERFACE)) != NULL) {
2042 if (p[0] >= 3 && p[2] == dsubtype)
2043 return p;
2045 return NULL;
2049 * Wrapper for usb_control_msg().
2050 * Allocates a temp buffer to prevent dmaing from/to the stack.
2052 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2053 __u8 requesttype, __u16 value, __u16 index, void *data,
2054 __u16 size, int timeout)
2056 int err;
2057 void *buf = NULL;
2059 if (size > 0) {
2060 buf = kmemdup(data, size, GFP_KERNEL);
2061 if (!buf)
2062 return -ENOMEM;
2064 err = usb_control_msg(dev, pipe, request, requesttype,
2065 value, index, buf, size, timeout);
2066 if (size > 0) {
2067 memcpy(data, buf, size);
2068 kfree(buf);
2070 return err;
2075 * entry point for linux usb interface
2078 static int usb_audio_probe(struct usb_interface *intf,
2079 const struct usb_device_id *id);
2080 static void usb_audio_disconnect(struct usb_interface *intf);
2082 #ifdef CONFIG_PM
2083 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message);
2084 static int usb_audio_resume(struct usb_interface *intf);
2085 #else
2086 #define usb_audio_suspend NULL
2087 #define usb_audio_resume NULL
2088 #endif
2090 static struct usb_device_id usb_audio_ids [] = {
2091 #include "usbquirks.h"
2092 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2093 .bInterfaceClass = USB_CLASS_AUDIO,
2094 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2095 { } /* Terminating entry */
2098 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2100 static struct usb_driver usb_audio_driver = {
2101 .name = "snd-usb-audio",
2102 .probe = usb_audio_probe,
2103 .disconnect = usb_audio_disconnect,
2104 .suspend = usb_audio_suspend,
2105 .resume = usb_audio_resume,
2106 .id_table = usb_audio_ids,
2110 #if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2113 * proc interface for list the supported pcm formats
2115 static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2117 struct list_head *p;
2118 static char *sync_types[4] = {
2119 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2122 list_for_each(p, &subs->fmt_list) {
2123 struct audioformat *fp;
2124 fp = list_entry(p, struct audioformat, list);
2125 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2126 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
2127 snd_iprintf(buffer, " Format: %#x (%d bits)\n",
2128 fp->format, snd_pcm_format_width(fp->format));
2129 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2130 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2131 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2132 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2133 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2134 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2135 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2136 fp->rate_min, fp->rate_max);
2137 } else {
2138 unsigned int i;
2139 snd_iprintf(buffer, " Rates: ");
2140 for (i = 0; i < fp->nr_rates; i++) {
2141 if (i > 0)
2142 snd_iprintf(buffer, ", ");
2143 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2145 snd_iprintf(buffer, "\n");
2147 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
2148 snd_iprintf(buffer, " Data packet interval: %d us\n",
2149 125 * (1 << fp->datainterval));
2150 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2151 // snd_iprintf(buffer, " EP Attribute = %#x\n", fp->attributes);
2155 static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2157 if (subs->running) {
2158 unsigned int i;
2159 snd_iprintf(buffer, " Status: Running\n");
2160 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2161 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2162 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2163 for (i = 0; i < subs->nurbs; i++)
2164 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2165 snd_iprintf(buffer, "]\n");
2166 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2167 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2168 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2169 ? get_full_speed_hz(subs->freqm)
2170 : get_high_speed_hz(subs->freqm),
2171 subs->freqm >> 16, subs->freqm & 0xffff);
2172 } else {
2173 snd_iprintf(buffer, " Status: Stop\n");
2177 static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
2179 struct snd_usb_stream *stream = entry->private_data;
2181 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2183 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2184 snd_iprintf(buffer, "\nPlayback:\n");
2185 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2186 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2188 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2189 snd_iprintf(buffer, "\nCapture:\n");
2190 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2191 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2195 static void proc_pcm_format_add(struct snd_usb_stream *stream)
2197 struct snd_info_entry *entry;
2198 char name[32];
2199 struct snd_card *card = stream->chip->card;
2201 sprintf(name, "stream%d", stream->pcm_index);
2202 if (!snd_card_proc_new(card, name, &entry))
2203 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
2206 #else
2208 static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2212 #endif
2215 * initialize the substream instance.
2218 static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
2220 struct snd_usb_substream *subs = &as->substream[stream];
2222 INIT_LIST_HEAD(&subs->fmt_list);
2223 spin_lock_init(&subs->lock);
2225 subs->stream = as;
2226 subs->direction = stream;
2227 subs->dev = as->chip->dev;
2228 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL) {
2229 subs->ops = audio_urb_ops[stream];
2230 } else {
2231 subs->ops = audio_urb_ops_high_speed[stream];
2232 switch (as->chip->usb_id) {
2233 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
2234 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
2235 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
2236 subs->ops.retire_sync = retire_playback_sync_urb_hs_emu;
2237 break;
2240 snd_pcm_set_ops(as->pcm, stream,
2241 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2242 &snd_usb_playback_ops : &snd_usb_capture_ops);
2244 list_add_tail(&fp->list, &subs->fmt_list);
2245 subs->formats |= 1ULL << fp->format;
2246 subs->endpoint = fp->endpoint;
2247 subs->num_formats++;
2248 subs->fmt_type = fp->fmt_type;
2253 * free a substream
2255 static void free_substream(struct snd_usb_substream *subs)
2257 struct list_head *p, *n;
2259 if (!subs->num_formats)
2260 return; /* not initialized */
2261 list_for_each_safe(p, n, &subs->fmt_list) {
2262 struct audioformat *fp = list_entry(p, struct audioformat, list);
2263 kfree(fp->rate_table);
2264 kfree(fp);
2266 kfree(subs->rate_list.list);
2271 * free a usb stream instance
2273 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
2275 free_substream(&stream->substream[0]);
2276 free_substream(&stream->substream[1]);
2277 list_del(&stream->list);
2278 kfree(stream);
2281 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
2283 struct snd_usb_stream *stream = pcm->private_data;
2284 if (stream) {
2285 stream->pcm = NULL;
2286 snd_usb_audio_stream_free(stream);
2292 * add this endpoint to the chip instance.
2293 * if a stream with the same endpoint already exists, append to it.
2294 * if not, create a new pcm stream.
2296 static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
2298 struct list_head *p;
2299 struct snd_usb_stream *as;
2300 struct snd_usb_substream *subs;
2301 struct snd_pcm *pcm;
2302 int err;
2304 list_for_each(p, &chip->pcm_list) {
2305 as = list_entry(p, struct snd_usb_stream, list);
2306 if (as->fmt_type != fp->fmt_type)
2307 continue;
2308 subs = &as->substream[stream];
2309 if (!subs->endpoint)
2310 continue;
2311 if (subs->endpoint == fp->endpoint) {
2312 list_add_tail(&fp->list, &subs->fmt_list);
2313 subs->num_formats++;
2314 subs->formats |= 1ULL << fp->format;
2315 return 0;
2318 /* look for an empty stream */
2319 list_for_each(p, &chip->pcm_list) {
2320 as = list_entry(p, struct snd_usb_stream, list);
2321 if (as->fmt_type != fp->fmt_type)
2322 continue;
2323 subs = &as->substream[stream];
2324 if (subs->endpoint)
2325 continue;
2326 err = snd_pcm_new_stream(as->pcm, stream, 1);
2327 if (err < 0)
2328 return err;
2329 init_substream(as, stream, fp);
2330 return 0;
2333 /* create a new pcm */
2334 as = kzalloc(sizeof(*as), GFP_KERNEL);
2335 if (!as)
2336 return -ENOMEM;
2337 as->pcm_index = chip->pcm_devs;
2338 as->chip = chip;
2339 as->fmt_type = fp->fmt_type;
2340 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2341 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2342 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2343 &pcm);
2344 if (err < 0) {
2345 kfree(as);
2346 return err;
2348 as->pcm = pcm;
2349 pcm->private_data = as;
2350 pcm->private_free = snd_usb_audio_pcm_free;
2351 pcm->info_flags = 0;
2352 if (chip->pcm_devs > 0)
2353 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2354 else
2355 strcpy(pcm->name, "USB Audio");
2357 init_substream(as, stream, fp);
2359 list_add(&as->list, &chip->pcm_list);
2360 chip->pcm_devs++;
2362 proc_pcm_format_add(as);
2364 return 0;
2369 * check if the device uses big-endian samples
2371 static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
2373 switch (chip->usb_id) {
2374 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2375 if (fp->endpoint & USB_DIR_IN)
2376 return 1;
2377 break;
2378 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2379 if (device_setup[chip->index] == 0x00 ||
2380 fp->altsetting==1 || fp->altsetting==2 || fp->altsetting==3)
2381 return 1;
2383 return 0;
2387 * parse the audio format type I descriptor
2388 * and returns the corresponding pcm format
2390 * @dev: usb device
2391 * @fp: audioformat record
2392 * @format: the format tag (wFormatTag)
2393 * @fmt: the format type descriptor
2395 static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
2396 int format, unsigned char *fmt)
2398 int pcm_format;
2399 int sample_width, sample_bytes;
2401 /* FIXME: correct endianess and sign? */
2402 pcm_format = -1;
2403 sample_width = fmt[6];
2404 sample_bytes = fmt[5];
2405 switch (format) {
2406 case 0: /* some devices don't define this correctly... */
2407 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2408 chip->dev->devnum, fp->iface, fp->altsetting);
2409 /* fall-through */
2410 case USB_AUDIO_FORMAT_PCM:
2411 if (sample_width > sample_bytes * 8) {
2412 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2413 chip->dev->devnum, fp->iface, fp->altsetting,
2414 sample_width, sample_bytes);
2416 /* check the format byte size */
2417 switch (fmt[5]) {
2418 case 1:
2419 pcm_format = SNDRV_PCM_FORMAT_S8;
2420 break;
2421 case 2:
2422 if (is_big_endian_format(chip, fp))
2423 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2424 else
2425 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2426 break;
2427 case 3:
2428 if (is_big_endian_format(chip, fp))
2429 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2430 else
2431 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2432 break;
2433 case 4:
2434 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2435 break;
2436 default:
2437 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2438 chip->dev->devnum, fp->iface,
2439 fp->altsetting, sample_width, sample_bytes);
2440 break;
2442 break;
2443 case USB_AUDIO_FORMAT_PCM8:
2444 pcm_format = SNDRV_PCM_FORMAT_U8;
2446 /* Dallas DS4201 workaround: it advertises U8 format, but really
2447 supports S8. */
2448 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2449 pcm_format = SNDRV_PCM_FORMAT_S8;
2450 break;
2451 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2452 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2453 break;
2454 case USB_AUDIO_FORMAT_ALAW:
2455 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2456 break;
2457 case USB_AUDIO_FORMAT_MU_LAW:
2458 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2459 break;
2460 default:
2461 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2462 chip->dev->devnum, fp->iface, fp->altsetting, format);
2463 break;
2465 return pcm_format;
2470 * parse the format descriptor and stores the possible sample rates
2471 * on the audioformat table.
2473 * @dev: usb device
2474 * @fp: audioformat record
2475 * @fmt: the format descriptor
2476 * @offset: the start offset of descriptor pointing the rate type
2477 * (7 for type I and II, 8 for type II)
2479 static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
2480 unsigned char *fmt, int offset)
2482 int nr_rates = fmt[offset];
2484 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2485 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2486 chip->dev->devnum, fp->iface, fp->altsetting);
2487 return -1;
2490 if (nr_rates) {
2492 * build the rate table and bitmap flags
2494 int r, idx;
2496 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2497 if (fp->rate_table == NULL) {
2498 snd_printk(KERN_ERR "cannot malloc\n");
2499 return -1;
2502 fp->nr_rates = 0;
2503 fp->rate_min = fp->rate_max = 0;
2504 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2505 unsigned int rate = combine_triple(&fmt[idx]);
2506 if (!rate)
2507 continue;
2508 /* C-Media CM6501 mislabels its 96 kHz altsetting */
2509 if (rate == 48000 && nr_rates == 1 &&
2510 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
2511 chip->usb_id == USB_ID(0x0d8c, 0x0102)) &&
2512 fp->altsetting == 5 && fp->maxpacksize == 392)
2513 rate = 96000;
2514 fp->rate_table[fp->nr_rates] = rate;
2515 if (!fp->rate_min || rate < fp->rate_min)
2516 fp->rate_min = rate;
2517 if (!fp->rate_max || rate > fp->rate_max)
2518 fp->rate_max = rate;
2519 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
2520 fp->nr_rates++;
2522 if (!fp->nr_rates) {
2523 hwc_debug("All rates were zero. Skipping format!\n");
2524 return -1;
2526 } else {
2527 /* continuous rates */
2528 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2529 fp->rate_min = combine_triple(&fmt[offset + 1]);
2530 fp->rate_max = combine_triple(&fmt[offset + 4]);
2532 return 0;
2536 * parse the format type I and III descriptors
2538 static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
2539 int format, unsigned char *fmt)
2541 int pcm_format;
2543 if (fmt[3] == USB_FORMAT_TYPE_III) {
2544 /* FIXME: the format type is really IECxxx
2545 * but we give normal PCM format to get the existing
2546 * apps working...
2548 switch (chip->usb_id) {
2550 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2551 if (device_setup[chip->index] == 0x00 &&
2552 fp->altsetting == 6)
2553 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
2554 else
2555 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2556 break;
2557 default:
2558 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2560 } else {
2561 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2562 if (pcm_format < 0)
2563 return -1;
2565 fp->format = pcm_format;
2566 fp->channels = fmt[4];
2567 if (fp->channels < 1) {
2568 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2569 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2570 return -1;
2572 return parse_audio_format_rates(chip, fp, fmt, 7);
2576 * prase the format type II descriptor
2578 static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
2579 int format, unsigned char *fmt)
2581 int brate, framesize;
2582 switch (format) {
2583 case USB_AUDIO_FORMAT_AC3:
2584 /* FIXME: there is no AC3 format defined yet */
2585 // fp->format = SNDRV_PCM_FORMAT_AC3;
2586 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2587 break;
2588 case USB_AUDIO_FORMAT_MPEG:
2589 fp->format = SNDRV_PCM_FORMAT_MPEG;
2590 break;
2591 default:
2592 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
2593 chip->dev->devnum, fp->iface, fp->altsetting, format);
2594 fp->format = SNDRV_PCM_FORMAT_MPEG;
2595 break;
2597 fp->channels = 1;
2598 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2599 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2600 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2601 fp->frame_size = framesize;
2602 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2605 static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
2606 int format, unsigned char *fmt, int stream)
2608 int err;
2610 switch (fmt[3]) {
2611 case USB_FORMAT_TYPE_I:
2612 case USB_FORMAT_TYPE_III:
2613 err = parse_audio_format_i(chip, fp, format, fmt);
2614 break;
2615 case USB_FORMAT_TYPE_II:
2616 err = parse_audio_format_ii(chip, fp, format, fmt);
2617 break;
2618 default:
2619 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2620 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2621 return -1;
2623 fp->fmt_type = fmt[3];
2624 if (err < 0)
2625 return err;
2626 #if 1
2627 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2628 /* extigy apparently supports sample rates other than 48k
2629 * but not in ordinary way. so we enable only 48k atm.
2631 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2632 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2633 chip->usb_id == USB_ID(0x041e, 0x3061)) {
2634 if (fmt[3] == USB_FORMAT_TYPE_I &&
2635 fp->rates != SNDRV_PCM_RATE_48000 &&
2636 fp->rates != SNDRV_PCM_RATE_96000)
2637 return -1;
2639 #endif
2640 return 0;
2643 static unsigned char parse_datainterval(struct snd_usb_audio *chip,
2644 struct usb_host_interface *alts)
2646 if (snd_usb_get_speed(chip->dev) == USB_SPEED_HIGH &&
2647 get_endpoint(alts, 0)->bInterval >= 1 &&
2648 get_endpoint(alts, 0)->bInterval <= 4)
2649 return get_endpoint(alts, 0)->bInterval - 1;
2650 else
2651 return 0;
2654 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2655 int iface, int altno);
2656 static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
2658 struct usb_device *dev;
2659 struct usb_interface *iface;
2660 struct usb_host_interface *alts;
2661 struct usb_interface_descriptor *altsd;
2662 int i, altno, err, stream;
2663 int format;
2664 struct audioformat *fp = NULL;
2665 unsigned char *fmt, *csep;
2666 int num;
2668 dev = chip->dev;
2670 /* parse the interface's altsettings */
2671 iface = usb_ifnum_to_if(dev, iface_no);
2673 num = iface->num_altsetting;
2676 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
2677 * one misses syncpipe, and does not produce any sound.
2679 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2680 num = 4;
2682 for (i = 0; i < num; i++) {
2683 alts = &iface->altsetting[i];
2684 altsd = get_iface_desc(alts);
2685 /* skip invalid one */
2686 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2687 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2688 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2689 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2690 altsd->bNumEndpoints < 1 ||
2691 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2692 continue;
2693 /* must be isochronous */
2694 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2695 USB_ENDPOINT_XFER_ISOC)
2696 continue;
2697 /* check direction */
2698 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2699 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2700 altno = altsd->bAlternateSetting;
2702 /* audiophile usb: skip altsets incompatible with device_setup
2704 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2705 audiophile_skip_setting_quirk(chip, iface_no, altno))
2706 continue;
2708 /* get audio formats */
2709 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2710 if (!fmt) {
2711 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2712 dev->devnum, iface_no, altno);
2713 continue;
2716 if (fmt[0] < 7) {
2717 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2718 dev->devnum, iface_no, altno);
2719 continue;
2722 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2724 /* get format type */
2725 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2726 if (!fmt) {
2727 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2728 dev->devnum, iface_no, altno);
2729 continue;
2731 if (fmt[0] < 8) {
2732 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2733 dev->devnum, iface_no, altno);
2734 continue;
2738 * Blue Microphones workaround: The last altsetting is identical
2739 * with the previous one, except for a larger packet size, but
2740 * is actually a mislabeled two-channel setting; ignore it.
2742 if (fmt[4] == 1 && fmt[5] == 2 && altno == 2 && num == 3 &&
2743 fp && fp->altsetting == 1 && fp->channels == 1 &&
2744 fp->format == SNDRV_PCM_FORMAT_S16_LE &&
2745 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
2746 fp->maxpacksize * 2)
2747 continue;
2749 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2750 /* Creamware Noah has this descriptor after the 2nd endpoint */
2751 if (!csep && altsd->bNumEndpoints >= 2)
2752 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2753 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2754 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
2755 " class specific endpoint descriptor\n",
2756 dev->devnum, iface_no, altno);
2757 csep = NULL;
2760 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
2761 if (! fp) {
2762 snd_printk(KERN_ERR "cannot malloc\n");
2763 return -ENOMEM;
2766 fp->iface = iface_no;
2767 fp->altsetting = altno;
2768 fp->altset_idx = i;
2769 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2770 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2771 fp->datainterval = parse_datainterval(chip, alts);
2772 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2773 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2774 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2775 * (fp->maxpacksize & 0x7ff);
2776 fp->attributes = csep ? csep[3] : 0;
2778 /* some quirks for attributes here */
2780 switch (chip->usb_id) {
2781 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2782 /* Optoplay sets the sample rate attribute although
2783 * it seems not supporting it in fact.
2785 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2786 break;
2787 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2788 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2789 /* doesn't set the sample rate attribute, but supports it */
2790 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2791 break;
2792 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2793 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2794 an older model 77d:223) */
2796 * plantronics headset and Griffin iMic have set adaptive-in
2797 * although it's really not...
2799 fp->ep_attr &= ~EP_ATTR_MASK;
2800 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2801 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2802 else
2803 fp->ep_attr |= EP_ATTR_SYNC;
2804 break;
2807 /* ok, let's parse further... */
2808 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2809 kfree(fp->rate_table);
2810 kfree(fp);
2811 continue;
2814 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
2815 err = add_audio_endpoint(chip, stream, fp);
2816 if (err < 0) {
2817 kfree(fp->rate_table);
2818 kfree(fp);
2819 return err;
2821 /* try to set the interface... */
2822 usb_set_interface(chip->dev, iface_no, altno);
2823 init_usb_pitch(chip->dev, iface_no, alts, fp);
2824 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2826 return 0;
2831 * disconnect streams
2832 * called from snd_usb_audio_disconnect()
2834 static void snd_usb_stream_disconnect(struct list_head *head)
2836 int idx;
2837 struct snd_usb_stream *as;
2838 struct snd_usb_substream *subs;
2840 as = list_entry(head, struct snd_usb_stream, list);
2841 for (idx = 0; idx < 2; idx++) {
2842 subs = &as->substream[idx];
2843 if (!subs->num_formats)
2844 return;
2845 release_substream_urbs(subs, 1);
2846 subs->interface = -1;
2851 * parse audio control descriptor and create pcm/midi streams
2853 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
2855 struct usb_device *dev = chip->dev;
2856 struct usb_host_interface *host_iface;
2857 struct usb_interface *iface;
2858 unsigned char *p1;
2859 int i, j;
2861 /* find audiocontrol interface */
2862 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2863 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2864 snd_printk(KERN_ERR "cannot find HEADER\n");
2865 return -EINVAL;
2867 if (! p1[7] || p1[0] < 8 + p1[7]) {
2868 snd_printk(KERN_ERR "invalid HEADER\n");
2869 return -EINVAL;
2873 * parse all USB audio streaming interfaces
2875 for (i = 0; i < p1[7]; i++) {
2876 struct usb_host_interface *alts;
2877 struct usb_interface_descriptor *altsd;
2878 j = p1[8 + i];
2879 iface = usb_ifnum_to_if(dev, j);
2880 if (!iface) {
2881 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2882 dev->devnum, ctrlif, j);
2883 continue;
2885 if (usb_interface_claimed(iface)) {
2886 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2887 continue;
2889 alts = &iface->altsetting[0];
2890 altsd = get_iface_desc(alts);
2891 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2892 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2893 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2894 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2895 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2896 continue;
2898 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2899 continue;
2901 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2902 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2903 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2904 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2905 /* skip non-supported classes */
2906 continue;
2908 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
2909 snd_printk(KERN_ERR "low speed audio streaming not supported\n");
2910 continue;
2912 if (! parse_audio_endpoints(chip, j)) {
2913 usb_set_interface(dev, j, 0); /* reset the current interface */
2914 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2918 return 0;
2922 * create a stream for an endpoint/altsetting without proper descriptors
2924 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
2925 struct usb_interface *iface,
2926 const struct snd_usb_audio_quirk *quirk)
2928 struct audioformat *fp;
2929 struct usb_host_interface *alts;
2930 int stream, err;
2931 unsigned *rate_table = NULL;
2933 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
2934 if (! fp) {
2935 snd_printk(KERN_ERR "cannot memdup\n");
2936 return -ENOMEM;
2938 if (fp->nr_rates > 0) {
2939 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2940 if (!rate_table) {
2941 kfree(fp);
2942 return -ENOMEM;
2944 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2945 fp->rate_table = rate_table;
2948 stream = (fp->endpoint & USB_DIR_IN)
2949 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2950 err = add_audio_endpoint(chip, stream, fp);
2951 if (err < 0) {
2952 kfree(fp);
2953 kfree(rate_table);
2954 return err;
2956 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2957 fp->altset_idx >= iface->num_altsetting) {
2958 kfree(fp);
2959 kfree(rate_table);
2960 return -EINVAL;
2962 alts = &iface->altsetting[fp->altset_idx];
2963 fp->datainterval = parse_datainterval(chip, alts);
2964 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2965 usb_set_interface(chip->dev, fp->iface, 0);
2966 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2967 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2968 return 0;
2972 * create a stream for an interface with proper descriptors
2974 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
2975 struct usb_interface *iface,
2976 const struct snd_usb_audio_quirk *quirk)
2978 struct usb_host_interface *alts;
2979 struct usb_interface_descriptor *altsd;
2980 int err;
2982 alts = &iface->altsetting[0];
2983 altsd = get_iface_desc(alts);
2984 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2985 if (err < 0) {
2986 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2987 altsd->bInterfaceNumber, err);
2988 return err;
2990 /* reset the current interface */
2991 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2992 return 0;
2996 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
2997 * The only way to detect the sample rate is by looking at wMaxPacketSize.
2999 static int create_uaxx_quirk(struct snd_usb_audio *chip,
3000 struct usb_interface *iface,
3001 const struct snd_usb_audio_quirk *quirk)
3003 static const struct audioformat ua_format = {
3004 .format = SNDRV_PCM_FORMAT_S24_3LE,
3005 .channels = 2,
3006 .fmt_type = USB_FORMAT_TYPE_I,
3007 .altsetting = 1,
3008 .altset_idx = 1,
3009 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3011 struct usb_host_interface *alts;
3012 struct usb_interface_descriptor *altsd;
3013 struct audioformat *fp;
3014 int stream, err;
3016 /* both PCM and MIDI interfaces have 2 or more altsettings */
3017 if (iface->num_altsetting < 2)
3018 return -ENXIO;
3019 alts = &iface->altsetting[1];
3020 altsd = get_iface_desc(alts);
3022 if (altsd->bNumEndpoints == 2) {
3023 static const struct snd_usb_midi_endpoint_info ua700_ep = {
3024 .out_cables = 0x0003,
3025 .in_cables = 0x0003
3027 static const struct snd_usb_audio_quirk ua700_quirk = {
3028 .type = QUIRK_MIDI_FIXED_ENDPOINT,
3029 .data = &ua700_ep
3031 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
3032 .out_cables = 0x0001,
3033 .in_cables = 0x0001
3035 static const struct snd_usb_audio_quirk uaxx_quirk = {
3036 .type = QUIRK_MIDI_FIXED_ENDPOINT,
3037 .data = &uaxx_ep
3039 if (chip->usb_id == USB_ID(0x0582, 0x002b))
3040 return snd_usb_create_midi_interface(chip, iface,
3041 &ua700_quirk);
3042 else
3043 return snd_usb_create_midi_interface(chip, iface,
3044 &uaxx_quirk);
3047 if (altsd->bNumEndpoints != 1)
3048 return -ENXIO;
3050 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
3051 if (!fp)
3052 return -ENOMEM;
3053 memcpy(fp, &ua_format, sizeof(*fp));
3055 fp->iface = altsd->bInterfaceNumber;
3056 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3057 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3058 fp->datainterval = 0;
3059 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3061 switch (fp->maxpacksize) {
3062 case 0x120:
3063 fp->rate_max = fp->rate_min = 44100;
3064 break;
3065 case 0x138:
3066 case 0x140:
3067 fp->rate_max = fp->rate_min = 48000;
3068 break;
3069 case 0x258:
3070 case 0x260:
3071 fp->rate_max = fp->rate_min = 96000;
3072 break;
3073 default:
3074 snd_printk(KERN_ERR "unknown sample rate\n");
3075 kfree(fp);
3076 return -ENXIO;
3079 stream = (fp->endpoint & USB_DIR_IN)
3080 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3081 err = add_audio_endpoint(chip, stream, fp);
3082 if (err < 0) {
3083 kfree(fp);
3084 return err;
3086 usb_set_interface(chip->dev, fp->iface, 0);
3087 return 0;
3091 * Create a stream for an Edirol UA-1000 interface.
3093 static int create_ua1000_quirk(struct snd_usb_audio *chip,
3094 struct usb_interface *iface,
3095 const struct snd_usb_audio_quirk *quirk)
3097 static const struct audioformat ua1000_format = {
3098 .format = SNDRV_PCM_FORMAT_S32_LE,
3099 .fmt_type = USB_FORMAT_TYPE_I,
3100 .altsetting = 1,
3101 .altset_idx = 1,
3102 .attributes = 0,
3103 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3105 struct usb_host_interface *alts;
3106 struct usb_interface_descriptor *altsd;
3107 struct audioformat *fp;
3108 int stream, err;
3110 if (iface->num_altsetting != 2)
3111 return -ENXIO;
3112 alts = &iface->altsetting[1];
3113 altsd = get_iface_desc(alts);
3114 if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3115 altsd->bNumEndpoints != 1)
3116 return -ENXIO;
3118 fp = kmemdup(&ua1000_format, sizeof(*fp), GFP_KERNEL);
3119 if (!fp)
3120 return -ENOMEM;
3122 fp->channels = alts->extra[4];
3123 fp->iface = altsd->bInterfaceNumber;
3124 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3125 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3126 fp->datainterval = parse_datainterval(chip, alts);
3127 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3128 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
3130 stream = (fp->endpoint & USB_DIR_IN)
3131 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3132 err = add_audio_endpoint(chip, stream, fp);
3133 if (err < 0) {
3134 kfree(fp);
3135 return err;
3137 /* FIXME: playback must be synchronized to capture */
3138 usb_set_interface(chip->dev, fp->iface, 0);
3139 return 0;
3143 * Create a stream for an Edirol UA-101 interface.
3144 * Copy, paste and modify from Edirol UA-1000
3146 static int create_ua101_quirk(struct snd_usb_audio *chip,
3147 struct usb_interface *iface,
3148 const struct snd_usb_audio_quirk *quirk)
3150 static const struct audioformat ua101_format = {
3151 .format = SNDRV_PCM_FORMAT_S32_LE,
3152 .fmt_type = USB_FORMAT_TYPE_I,
3153 .altsetting = 1,
3154 .altset_idx = 1,
3155 .attributes = 0,
3156 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3158 struct usb_host_interface *alts;
3159 struct usb_interface_descriptor *altsd;
3160 struct audioformat *fp;
3161 int stream, err;
3163 if (iface->num_altsetting != 2)
3164 return -ENXIO;
3165 alts = &iface->altsetting[1];
3166 altsd = get_iface_desc(alts);
3167 if (alts->extralen != 18 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3168 altsd->bNumEndpoints != 1)
3169 return -ENXIO;
3171 fp = kmemdup(&ua101_format, sizeof(*fp), GFP_KERNEL);
3172 if (!fp)
3173 return -ENOMEM;
3175 fp->channels = alts->extra[11];
3176 fp->iface = altsd->bInterfaceNumber;
3177 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3178 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3179 fp->datainterval = parse_datainterval(chip, alts);
3180 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3181 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[15]);
3183 stream = (fp->endpoint & USB_DIR_IN)
3184 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3185 err = add_audio_endpoint(chip, stream, fp);
3186 if (err < 0) {
3187 kfree(fp);
3188 return err;
3190 /* FIXME: playback must be synchronized to capture */
3191 usb_set_interface(chip->dev, fp->iface, 0);
3192 return 0;
3195 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3196 struct usb_interface *iface,
3197 const struct snd_usb_audio_quirk *quirk);
3200 * handle the quirks for the contained interfaces
3202 static int create_composite_quirk(struct snd_usb_audio *chip,
3203 struct usb_interface *iface,
3204 const struct snd_usb_audio_quirk *quirk)
3206 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3207 int err;
3209 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3210 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3211 if (!iface)
3212 continue;
3213 if (quirk->ifnum != probed_ifnum &&
3214 usb_interface_claimed(iface))
3215 continue;
3216 err = snd_usb_create_quirk(chip, iface, quirk);
3217 if (err < 0)
3218 return err;
3219 if (quirk->ifnum != probed_ifnum)
3220 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3222 return 0;
3225 static int ignore_interface_quirk(struct snd_usb_audio *chip,
3226 struct usb_interface *iface,
3227 const struct snd_usb_audio_quirk *quirk)
3229 return 0;
3234 * boot quirks
3237 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3238 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3240 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3242 struct usb_host_config *config = dev->actconfig;
3243 int err;
3245 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3246 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3247 snd_printdd("sending Extigy boot sequence...\n");
3248 /* Send message to force it to reconnect with full interface. */
3249 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3250 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3251 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3252 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3253 &dev->descriptor, sizeof(dev->descriptor));
3254 config = dev->actconfig;
3255 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3256 err = usb_reset_configuration(dev);
3257 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3258 snd_printdd("extigy_boot: new boot length = %d\n",
3259 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3260 return -ENODEV; /* quit this anyway */
3262 return 0;
3265 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3267 u8 buf = 1;
3269 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3270 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3271 0, 0, &buf, 1, 1000);
3272 if (buf == 0) {
3273 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3274 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3275 1, 2000, NULL, 0, 1000);
3276 return -ENODEV;
3278 return 0;
3282 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3283 * documented in the device's data sheet.
3285 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3287 u8 buf[4];
3288 buf[0] = 0x20;
3289 buf[1] = value & 0xff;
3290 buf[2] = (value >> 8) & 0xff;
3291 buf[3] = reg;
3292 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3293 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3294 0, 0, &buf, 4, 1000);
3297 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3300 * Enable line-out driver mode, set headphone source to front
3301 * channels, enable stereo mic.
3303 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3307 * C-Media CM6206 is based on CM106 with two additional
3308 * registers that are not documented in the data sheet.
3309 * Values here are chosen based on sniffing USB traffic
3310 * under Windows.
3312 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
3314 int err, reg;
3315 int val[] = {0x200c, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
3317 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
3318 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
3319 if (err < 0)
3320 return err;
3323 return err;
3327 * Setup quirks
3329 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3330 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3331 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3332 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3333 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3334 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3335 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3336 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3337 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3338 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3340 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3341 int iface, int altno)
3343 /* Reset ALL ifaces to 0 altsetting.
3344 * Call it for every possible altsetting of every interface.
3346 usb_set_interface(chip->dev, iface, 0);
3348 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3349 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3350 && altno != 6)
3351 return 1; /* skip this altsetting */
3352 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3353 && altno != 1)
3354 return 1; /* skip this altsetting */
3355 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3356 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3357 return 1; /* skip this altsetting */
3358 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3359 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3360 return 1; /* skip this altsetting */
3361 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3362 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3363 return 1; /* skip this altsetting */
3364 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3365 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3366 return 1; /* skip this altsetting */
3368 return 0; /* keep this altsetting */
3372 * audio-interface quirks
3374 * returns zero if no standard audio/MIDI parsing is needed.
3375 * returns a postive value if standard audio/midi interfaces are parsed
3376 * after this.
3377 * returns a negative value at error.
3379 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3380 struct usb_interface *iface,
3381 const struct snd_usb_audio_quirk *quirk)
3383 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3384 const struct snd_usb_audio_quirk *);
3385 static const quirk_func_t quirk_funcs[] = {
3386 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3387 [QUIRK_COMPOSITE] = create_composite_quirk,
3388 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3389 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3390 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3391 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3392 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3393 [QUIRK_MIDI_FASTLANE] = snd_usb_create_midi_interface,
3394 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3395 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
3396 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3397 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3398 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3399 [QUIRK_AUDIO_EDIROL_UA101] = create_ua101_quirk,
3400 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk
3403 if (quirk->type < QUIRK_TYPE_COUNT) {
3404 return quirk_funcs[quirk->type](chip, iface, quirk);
3405 } else {
3406 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3407 return -ENXIO;
3413 * common proc files to show the usb device info
3415 static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3417 struct snd_usb_audio *chip = entry->private_data;
3418 if (!chip->shutdown)
3419 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3422 static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3424 struct snd_usb_audio *chip = entry->private_data;
3425 if (!chip->shutdown)
3426 snd_iprintf(buffer, "%04x:%04x\n",
3427 USB_ID_VENDOR(chip->usb_id),
3428 USB_ID_PRODUCT(chip->usb_id));
3431 static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
3433 struct snd_info_entry *entry;
3434 if (!snd_card_proc_new(chip->card, "usbbus", &entry))
3435 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
3436 if (!snd_card_proc_new(chip->card, "usbid", &entry))
3437 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
3441 * free the chip instance
3443 * here we have to do not much, since pcm and controls are already freed
3447 static int snd_usb_audio_free(struct snd_usb_audio *chip)
3449 kfree(chip);
3450 return 0;
3453 static int snd_usb_audio_dev_free(struct snd_device *device)
3455 struct snd_usb_audio *chip = device->device_data;
3456 return snd_usb_audio_free(chip);
3461 * create a chip instance and set its names.
3463 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3464 const struct snd_usb_audio_quirk *quirk,
3465 struct snd_usb_audio **rchip)
3467 struct snd_card *card;
3468 struct snd_usb_audio *chip;
3469 int err, len;
3470 char component[14];
3471 static struct snd_device_ops ops = {
3472 .dev_free = snd_usb_audio_dev_free,
3475 *rchip = NULL;
3477 if (snd_usb_get_speed(dev) != USB_SPEED_LOW &&
3478 snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3479 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3480 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3481 return -ENXIO;
3484 err = snd_card_create(index[idx], id[idx], THIS_MODULE, 0, &card);
3485 if (err < 0) {
3486 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3487 return err;
3490 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3491 if (! chip) {
3492 snd_card_free(card);
3493 return -ENOMEM;
3496 chip->index = idx;
3497 chip->dev = dev;
3498 chip->card = card;
3499 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3500 le16_to_cpu(dev->descriptor.idProduct));
3501 INIT_LIST_HEAD(&chip->pcm_list);
3502 INIT_LIST_HEAD(&chip->midi_list);
3503 INIT_LIST_HEAD(&chip->mixer_list);
3505 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3506 snd_usb_audio_free(chip);
3507 snd_card_free(card);
3508 return err;
3511 strcpy(card->driver, "USB-Audio");
3512 sprintf(component, "USB%04x:%04x",
3513 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3514 snd_component_add(card, component);
3516 /* retrieve the device string as shortname */
3517 if (quirk && quirk->product_name) {
3518 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3519 } else {
3520 if (!dev->descriptor.iProduct ||
3521 usb_string(dev, dev->descriptor.iProduct,
3522 card->shortname, sizeof(card->shortname)) <= 0) {
3523 /* no name available from anywhere, so use ID */
3524 sprintf(card->shortname, "USB Device %#04x:%#04x",
3525 USB_ID_VENDOR(chip->usb_id),
3526 USB_ID_PRODUCT(chip->usb_id));
3530 /* retrieve the vendor and device strings as longname */
3531 if (quirk && quirk->vendor_name) {
3532 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3533 } else {
3534 if (dev->descriptor.iManufacturer)
3535 len = usb_string(dev, dev->descriptor.iManufacturer,
3536 card->longname, sizeof(card->longname));
3537 else
3538 len = 0;
3539 /* we don't really care if there isn't any vendor string */
3541 if (len > 0)
3542 strlcat(card->longname, " ", sizeof(card->longname));
3544 strlcat(card->longname, card->shortname, sizeof(card->longname));
3546 len = strlcat(card->longname, " at ", sizeof(card->longname));
3548 if (len < sizeof(card->longname))
3549 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3551 strlcat(card->longname,
3552 snd_usb_get_speed(dev) == USB_SPEED_LOW ? ", low speed" :
3553 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" :
3554 ", high speed",
3555 sizeof(card->longname));
3557 snd_usb_audio_create_proc(chip);
3559 *rchip = chip;
3560 return 0;
3565 * probe the active usb device
3567 * note that this can be called multiple times per a device, when it
3568 * includes multiple audio control interfaces.
3570 * thus we check the usb device pointer and creates the card instance
3571 * only at the first time. the successive calls of this function will
3572 * append the pcm interface to the corresponding card.
3574 static void *snd_usb_audio_probe(struct usb_device *dev,
3575 struct usb_interface *intf,
3576 const struct usb_device_id *usb_id)
3578 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
3579 int i, err;
3580 struct snd_usb_audio *chip;
3581 struct usb_host_interface *alts;
3582 int ifnum;
3583 u32 id;
3585 alts = &intf->altsetting[0];
3586 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3587 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3588 le16_to_cpu(dev->descriptor.idProduct));
3590 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3591 goto __err_val;
3593 /* SB Extigy needs special boot-up sequence */
3594 /* if more models come, this will go to the quirk list. */
3595 if (id == USB_ID(0x041e, 0x3000)) {
3596 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3597 goto __err_val;
3599 /* SB Audigy 2 NX needs its own boot-up magic, too */
3600 if (id == USB_ID(0x041e, 0x3020)) {
3601 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3602 goto __err_val;
3605 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3606 if (id == USB_ID(0x10f5, 0x0200)) {
3607 if (snd_usb_cm106_boot_quirk(dev) < 0)
3608 goto __err_val;
3611 /* C-Media CM6206 / CM106-Like Sound Device */
3612 if (id == USB_ID(0x0d8c, 0x0102)) {
3613 if (snd_usb_cm6206_boot_quirk(dev) < 0)
3614 goto __err_val;
3618 * found a config. now register to ALSA
3621 /* check whether it's already registered */
3622 chip = NULL;
3623 mutex_lock(&register_mutex);
3624 for (i = 0; i < SNDRV_CARDS; i++) {
3625 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3626 if (usb_chip[i]->shutdown) {
3627 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3628 goto __error;
3630 chip = usb_chip[i];
3631 break;
3634 if (! chip) {
3635 /* it's a fresh one.
3636 * now look for an empty slot and create a new card instance
3638 for (i = 0; i < SNDRV_CARDS; i++)
3639 if (enable[i] && ! usb_chip[i] &&
3640 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3641 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3642 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3643 goto __error;
3645 snd_card_set_dev(chip->card, &intf->dev);
3646 break;
3648 if (!chip) {
3649 printk(KERN_ERR "no available usb audio device\n");
3650 goto __error;
3654 err = 1; /* continue */
3655 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3656 /* need some special handlings */
3657 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3658 goto __error;
3661 if (err > 0) {
3662 /* create normal USB audio interfaces */
3663 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3664 snd_usb_create_mixer(chip, ifnum, ignore_ctl_error) < 0) {
3665 goto __error;
3669 /* we are allowed to call snd_card_register() many times */
3670 if (snd_card_register(chip->card) < 0) {
3671 goto __error;
3674 usb_chip[chip->index] = chip;
3675 chip->num_interfaces++;
3676 mutex_unlock(&register_mutex);
3677 return chip;
3679 __error:
3680 if (chip && !chip->num_interfaces)
3681 snd_card_free(chip->card);
3682 mutex_unlock(&register_mutex);
3683 __err_val:
3684 return NULL;
3688 * we need to take care of counter, since disconnection can be called also
3689 * many times as well as usb_audio_probe().
3691 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3693 struct snd_usb_audio *chip;
3694 struct snd_card *card;
3695 struct list_head *p;
3697 if (ptr == (void *)-1L)
3698 return;
3700 chip = ptr;
3701 card = chip->card;
3702 mutex_lock(&register_mutex);
3703 chip->shutdown = 1;
3704 chip->num_interfaces--;
3705 if (chip->num_interfaces <= 0) {
3706 snd_card_disconnect(card);
3707 /* release the pcm resources */
3708 list_for_each(p, &chip->pcm_list) {
3709 snd_usb_stream_disconnect(p);
3711 /* release the midi resources */
3712 list_for_each(p, &chip->midi_list) {
3713 snd_usbmidi_disconnect(p);
3715 /* release mixer resources */
3716 list_for_each(p, &chip->mixer_list) {
3717 snd_usb_mixer_disconnect(p);
3719 usb_chip[chip->index] = NULL;
3720 mutex_unlock(&register_mutex);
3721 snd_card_free_when_closed(card);
3722 } else {
3723 mutex_unlock(&register_mutex);
3728 * new 2.5 USB kernel API
3730 static int usb_audio_probe(struct usb_interface *intf,
3731 const struct usb_device_id *id)
3733 void *chip;
3734 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3735 if (chip) {
3736 usb_set_intfdata(intf, chip);
3737 return 0;
3738 } else
3739 return -EIO;
3742 static void usb_audio_disconnect(struct usb_interface *intf)
3744 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3745 usb_get_intfdata(intf));
3748 #ifdef CONFIG_PM
3749 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
3751 struct snd_usb_audio *chip = usb_get_intfdata(intf);
3752 struct list_head *p;
3753 struct snd_usb_stream *as;
3755 if (chip == (void *)-1L)
3756 return 0;
3758 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
3759 if (!chip->num_suspended_intf++) {
3760 list_for_each(p, &chip->pcm_list) {
3761 as = list_entry(p, struct snd_usb_stream, list);
3762 snd_pcm_suspend_all(as->pcm);
3766 return 0;
3769 static int usb_audio_resume(struct usb_interface *intf)
3771 struct snd_usb_audio *chip = usb_get_intfdata(intf);
3773 if (chip == (void *)-1L)
3774 return 0;
3775 if (--chip->num_suspended_intf)
3776 return 0;
3778 * ALSA leaves material resumption to user space
3779 * we just notify
3782 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
3784 return 0;
3786 #endif /* CONFIG_PM */
3788 static int __init snd_usb_audio_init(void)
3790 if (nrpacks < 1 || nrpacks > MAX_PACKS) {
3791 printk(KERN_WARNING "invalid nrpacks value.\n");
3792 return -EINVAL;
3794 return usb_register(&usb_audio_driver);
3798 static void __exit snd_usb_audio_cleanup(void)
3800 usb_deregister(&usb_audio_driver);
3803 module_init(snd_usb_audio_init);
3804 module_exit(snd_usb_audio_cleanup);