ia64/linux-2.6.18-xen.hg

view sound/usb/usbaudio.c @ 890:2e94884f0e8d

Dom0 PCI: fix a regression introduced by the SR-IOV change

The device class may be changed during the early fixup. So need to
re-read the device class from pci_dev after the fixup.

The patch "PCI: centralize device setup code" (c/s 825) wrongly
cleaned up the device class re-read. This patch reverts that change.

Signed-off-by: Yu Zhao <yu.zhao@intel.com>
author Keir Fraser <keir.fraser@citrix.com>
date Wed Jun 03 11:21:52 2009 +0100 (2009-06-03)
parents 831230e53067
children
line source
1 /*
2 * (Tentative) USB Audio Driver for ALSA
3 *
4 * Main and PCM part
5 *
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7 *
8 * Many codes borrowed from audio.c by
9 * Alan Cox (alan@lxorguk.ukuu.org.uk)
10 * Thomas Sailer (sailer@ife.ee.ethz.ch)
11 *
12 *
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.
17 *
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.
22 *
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
26 *
27 *
28 * NOTES:
29 *
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).
38 */
41 #include <sound/driver.h>
42 #include <linux/bitops.h>
43 #include <linux/init.h>
44 #include <linux/list.h>
45 #include <linux/slab.h>
46 #include <linux/string.h>
47 #include <linux/usb.h>
48 #include <linux/vmalloc.h>
49 #include <linux/moduleparam.h>
50 #include <linux/mutex.h>
51 #include <sound/core.h>
52 #include <sound/info.h>
53 #include <sound/pcm.h>
54 #include <sound/pcm_params.h>
55 #include <sound/initval.h>
57 #include "usbaudio.h"
60 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
61 MODULE_DESCRIPTION("USB Audio");
62 MODULE_LICENSE("GPL");
63 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
66 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
67 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
68 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
69 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
70 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
71 static int nrpacks = 4; /* max. number of packets per urb */
72 static int async_unlink = 1;
73 static int device_setup[SNDRV_CARDS]; /* device parameter for this card*/
75 module_param_array(index, int, NULL, 0444);
76 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
77 module_param_array(id, charp, NULL, 0444);
78 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
79 module_param_array(enable, bool, NULL, 0444);
80 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
81 module_param_array(vid, int, NULL, 0444);
82 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
83 module_param_array(pid, int, NULL, 0444);
84 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
85 module_param(nrpacks, int, 0644);
86 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
87 module_param(async_unlink, bool, 0444);
88 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
89 module_param_array(device_setup, int, NULL, 0444);
90 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
93 /*
94 * debug the h/w constraints
95 */
96 /* #define HW_CONST_DEBUG */
99 /*
100 *
101 */
103 #define MAX_PACKS 10
104 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
105 #define MAX_URBS 8
106 #define SYNC_URBS 4 /* always four urbs for sync */
107 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
109 struct audioformat {
110 struct list_head list;
111 snd_pcm_format_t format; /* format type */
112 unsigned int channels; /* # channels */
113 unsigned int fmt_type; /* USB audio format type (1-3) */
114 unsigned int frame_size; /* samples per frame for non-audio */
115 int iface; /* interface number */
116 unsigned char altsetting; /* corresponding alternate setting */
117 unsigned char altset_idx; /* array index of altenate setting */
118 unsigned char attributes; /* corresponding attributes of cs endpoint */
119 unsigned char endpoint; /* endpoint */
120 unsigned char ep_attr; /* endpoint attributes */
121 unsigned int maxpacksize; /* max. packet size */
122 unsigned int rates; /* rate bitmasks */
123 unsigned int rate_min, rate_max; /* min/max rates */
124 unsigned int nr_rates; /* number of rate table entries */
125 unsigned int *rate_table; /* rate table */
126 };
128 struct snd_usb_substream;
130 struct snd_urb_ctx {
131 struct urb *urb;
132 unsigned int buffer_size; /* size of data buffer, if data URB */
133 struct snd_usb_substream *subs;
134 int index; /* index for urb array */
135 int packets; /* number of packets per urb */
136 };
138 struct snd_urb_ops {
139 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
140 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
142 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
143 };
145 struct snd_usb_substream {
146 struct snd_usb_stream *stream;
147 struct usb_device *dev;
148 struct snd_pcm_substream *pcm_substream;
149 int direction; /* playback or capture */
150 int interface; /* current interface */
151 int endpoint; /* assigned endpoint */
152 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
153 unsigned int cur_rate; /* current rate (for hw_params callback) */
154 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
155 unsigned int format; /* USB data format */
156 unsigned int datapipe; /* the data i/o pipe */
157 unsigned int syncpipe; /* 1 - async out or adaptive in */
158 unsigned int datainterval; /* log_2 of data packet interval */
159 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
160 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
162 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
163 unsigned int phase; /* phase accumulator */
164 unsigned int maxpacksize; /* max packet size in bytes */
165 unsigned int maxframesize; /* max packet size in frames */
166 unsigned int curpacksize; /* current packet size in bytes (for capture) */
167 unsigned int curframesize; /* current packet size in frames (for capture) */
168 unsigned int fill_max: 1; /* fill max packet size always */
169 unsigned int fmt_type; /* USB audio format type (1-3) */
170 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
172 unsigned int running: 1; /* running status */
174 unsigned int hwptr_done; /* processed frame position in the buffer */
175 unsigned int transfer_done; /* processed frames since last period update */
176 unsigned long active_mask; /* bitmask of active urbs */
177 unsigned long unlink_mask; /* bitmask of unlinked urbs */
179 unsigned int nurbs; /* # urbs */
180 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
181 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
182 char *syncbuf; /* sync buffer for all sync URBs */
183 dma_addr_t sync_dma; /* DMA address of syncbuf */
185 u64 formats; /* format bitmasks (all or'ed) */
186 unsigned int num_formats; /* number of supported audio formats (list) */
187 struct list_head fmt_list; /* format list */
188 spinlock_t lock;
190 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
191 };
194 struct snd_usb_stream {
195 struct snd_usb_audio *chip;
196 struct snd_pcm *pcm;
197 int pcm_index;
198 unsigned int fmt_type; /* USB audio format type (1-3) */
199 struct snd_usb_substream substream[2];
200 struct list_head list;
201 };
204 /*
205 * we keep the snd_usb_audio_t instances by ourselves for merging
206 * the all interfaces on the same card as one sound device.
207 */
209 static DEFINE_MUTEX(register_mutex);
210 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
213 /*
214 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
215 * this will overflow at approx 524 kHz
216 */
217 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
218 {
219 return ((rate << 13) + 62) / 125;
220 }
222 /*
223 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
224 * this will overflow at approx 4 MHz
225 */
226 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
227 {
228 return ((rate << 10) + 62) / 125;
229 }
231 /* convert our full speed USB rate into sampling rate in Hz */
232 static inline unsigned get_full_speed_hz(unsigned int usb_rate)
233 {
234 return (usb_rate * 125 + (1 << 12)) >> 13;
235 }
237 /* convert our high speed USB rate into sampling rate in Hz */
238 static inline unsigned get_high_speed_hz(unsigned int usb_rate)
239 {
240 return (usb_rate * 125 + (1 << 9)) >> 10;
241 }
244 /*
245 * prepare urb for full speed capture sync pipe
246 *
247 * fill the length and offset of each urb descriptor.
248 * the fixed 10.14 frequency is passed through the pipe.
249 */
250 static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
251 struct snd_pcm_runtime *runtime,
252 struct urb *urb)
253 {
254 unsigned char *cp = urb->transfer_buffer;
255 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
257 urb->dev = ctx->subs->dev; /* we need to set this at each time */
258 urb->iso_frame_desc[0].length = 3;
259 urb->iso_frame_desc[0].offset = 0;
260 cp[0] = subs->freqn >> 2;
261 cp[1] = subs->freqn >> 10;
262 cp[2] = subs->freqn >> 18;
263 return 0;
264 }
266 /*
267 * prepare urb for high speed capture sync pipe
268 *
269 * fill the length and offset of each urb descriptor.
270 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
271 */
272 static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
273 struct snd_pcm_runtime *runtime,
274 struct urb *urb)
275 {
276 unsigned char *cp = urb->transfer_buffer;
277 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
279 urb->dev = ctx->subs->dev; /* we need to set this at each time */
280 urb->iso_frame_desc[0].length = 4;
281 urb->iso_frame_desc[0].offset = 0;
282 cp[0] = subs->freqn;
283 cp[1] = subs->freqn >> 8;
284 cp[2] = subs->freqn >> 16;
285 cp[3] = subs->freqn >> 24;
286 return 0;
287 }
289 /*
290 * process after capture sync complete
291 * - nothing to do
292 */
293 static int retire_capture_sync_urb(struct snd_usb_substream *subs,
294 struct snd_pcm_runtime *runtime,
295 struct urb *urb)
296 {
297 return 0;
298 }
300 /*
301 * prepare urb for capture data pipe
302 *
303 * fill the offset and length of each descriptor.
304 *
305 * we use a temporary buffer to write the captured data.
306 * since the length of written data is determined by host, we cannot
307 * write onto the pcm buffer directly... the data is thus copied
308 * later at complete callback to the global buffer.
309 */
310 static int prepare_capture_urb(struct snd_usb_substream *subs,
311 struct snd_pcm_runtime *runtime,
312 struct urb *urb)
313 {
314 int i, offs;
315 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
317 offs = 0;
318 urb->dev = ctx->subs->dev; /* we need to set this at each time */
319 for (i = 0; i < ctx->packets; i++) {
320 urb->iso_frame_desc[i].offset = offs;
321 urb->iso_frame_desc[i].length = subs->curpacksize;
322 offs += subs->curpacksize;
323 }
324 urb->transfer_buffer_length = offs;
325 urb->number_of_packets = ctx->packets;
326 #if 0 // for check
327 if (! urb->bandwidth) {
328 int bustime;
329 bustime = usb_check_bandwidth(urb->dev, urb);
330 if (bustime < 0)
331 return bustime;
332 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
333 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
334 }
335 #endif // for check
336 return 0;
337 }
339 /*
340 * process after capture complete
341 *
342 * copy the data from each desctiptor to the pcm buffer, and
343 * update the current position.
344 */
345 static int retire_capture_urb(struct snd_usb_substream *subs,
346 struct snd_pcm_runtime *runtime,
347 struct urb *urb)
348 {
349 unsigned long flags;
350 unsigned char *cp;
351 int i;
352 unsigned int stride, len, oldptr;
353 int period_elapsed = 0;
355 stride = runtime->frame_bits >> 3;
357 for (i = 0; i < urb->number_of_packets; i++) {
358 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
359 if (urb->iso_frame_desc[i].status) {
360 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
361 // continue;
362 }
363 len = urb->iso_frame_desc[i].actual_length / stride;
364 if (! len)
365 continue;
366 /* update the current pointer */
367 spin_lock_irqsave(&subs->lock, flags);
368 oldptr = subs->hwptr_done;
369 subs->hwptr_done += len;
370 if (subs->hwptr_done >= runtime->buffer_size)
371 subs->hwptr_done -= runtime->buffer_size;
372 subs->transfer_done += len;
373 if (subs->transfer_done >= runtime->period_size) {
374 subs->transfer_done -= runtime->period_size;
375 period_elapsed = 1;
376 }
377 spin_unlock_irqrestore(&subs->lock, flags);
378 /* copy a data chunk */
379 if (oldptr + len > runtime->buffer_size) {
380 unsigned int cnt = runtime->buffer_size - oldptr;
381 unsigned int blen = cnt * stride;
382 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
383 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
384 } else {
385 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
386 }
387 }
388 if (period_elapsed)
389 snd_pcm_period_elapsed(subs->pcm_substream);
390 return 0;
391 }
394 /*
395 * prepare urb for full speed playback sync pipe
396 *
397 * set up the offset and length to receive the current frequency.
398 */
400 static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
401 struct snd_pcm_runtime *runtime,
402 struct urb *urb)
403 {
404 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
406 urb->dev = ctx->subs->dev; /* we need to set this at each time */
407 urb->iso_frame_desc[0].length = 3;
408 urb->iso_frame_desc[0].offset = 0;
409 return 0;
410 }
412 /*
413 * prepare urb for high speed playback sync pipe
414 *
415 * set up the offset and length to receive the current frequency.
416 */
418 static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
419 struct snd_pcm_runtime *runtime,
420 struct urb *urb)
421 {
422 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
424 urb->dev = ctx->subs->dev; /* we need to set this at each time */
425 urb->iso_frame_desc[0].length = 4;
426 urb->iso_frame_desc[0].offset = 0;
427 return 0;
428 }
430 /*
431 * process after full speed playback sync complete
432 *
433 * retrieve the current 10.14 frequency from pipe, and set it.
434 * the value is referred in prepare_playback_urb().
435 */
436 static int retire_playback_sync_urb(struct snd_usb_substream *subs,
437 struct snd_pcm_runtime *runtime,
438 struct urb *urb)
439 {
440 unsigned int f;
441 unsigned long flags;
443 if (urb->iso_frame_desc[0].status == 0 &&
444 urb->iso_frame_desc[0].actual_length == 3) {
445 f = combine_triple((u8*)urb->transfer_buffer) << 2;
446 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
447 spin_lock_irqsave(&subs->lock, flags);
448 subs->freqm = f;
449 spin_unlock_irqrestore(&subs->lock, flags);
450 }
451 }
453 return 0;
454 }
456 /*
457 * process after high speed playback sync complete
458 *
459 * retrieve the current 12.13 frequency from pipe, and set it.
460 * the value is referred in prepare_playback_urb().
461 */
462 static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
463 struct snd_pcm_runtime *runtime,
464 struct urb *urb)
465 {
466 unsigned int f;
467 unsigned long flags;
469 if (urb->iso_frame_desc[0].status == 0 &&
470 urb->iso_frame_desc[0].actual_length == 4) {
471 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
472 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
473 spin_lock_irqsave(&subs->lock, flags);
474 subs->freqm = f;
475 spin_unlock_irqrestore(&subs->lock, flags);
476 }
477 }
479 return 0;
480 }
482 /* determine the number of frames in the next packet */
483 static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
484 {
485 if (subs->fill_max)
486 return subs->maxframesize;
487 else {
488 subs->phase = (subs->phase & 0xffff)
489 + (subs->freqm << subs->datainterval);
490 return min(subs->phase >> 16, subs->maxframesize);
491 }
492 }
494 /*
495 * Prepare urb for streaming before playback starts.
496 *
497 * We don't yet have data, so we send a frame of silence.
498 */
499 static int prepare_startup_playback_urb(struct snd_usb_substream *subs,
500 struct snd_pcm_runtime *runtime,
501 struct urb *urb)
502 {
503 unsigned int i, offs, counts;
504 struct snd_urb_ctx *ctx = urb->context;
505 int stride = runtime->frame_bits >> 3;
507 offs = 0;
508 urb->dev = ctx->subs->dev;
509 urb->number_of_packets = subs->packs_per_ms;
510 for (i = 0; i < subs->packs_per_ms; ++i) {
511 counts = snd_usb_audio_next_packet_size(subs);
512 urb->iso_frame_desc[i].offset = offs * stride;
513 urb->iso_frame_desc[i].length = counts * stride;
514 offs += counts;
515 }
516 urb->transfer_buffer_length = offs * stride;
517 memset(urb->transfer_buffer,
518 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
519 offs * stride);
520 return 0;
521 }
523 /*
524 * prepare urb for playback data pipe
525 *
526 * Since a URB can handle only a single linear buffer, we must use double
527 * buffering when the data to be transferred overflows the buffer boundary.
528 * To avoid inconsistencies when updating hwptr_done, we use double buffering
529 * for all URBs.
530 */
531 static int prepare_playback_urb(struct snd_usb_substream *subs,
532 struct snd_pcm_runtime *runtime,
533 struct urb *urb)
534 {
535 int i, stride, offs;
536 unsigned int counts;
537 unsigned long flags;
538 int period_elapsed = 0;
539 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
541 stride = runtime->frame_bits >> 3;
543 offs = 0;
544 urb->dev = ctx->subs->dev; /* we need to set this at each time */
545 urb->number_of_packets = 0;
546 spin_lock_irqsave(&subs->lock, flags);
547 for (i = 0; i < ctx->packets; i++) {
548 counts = snd_usb_audio_next_packet_size(subs);
549 /* set up descriptor */
550 urb->iso_frame_desc[i].offset = offs * stride;
551 urb->iso_frame_desc[i].length = counts * stride;
552 offs += counts;
553 urb->number_of_packets++;
554 subs->transfer_done += counts;
555 if (subs->transfer_done >= runtime->period_size) {
556 subs->transfer_done -= runtime->period_size;
557 period_elapsed = 1;
558 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
559 if (subs->transfer_done > 0) {
560 /* FIXME: fill-max mode is not
561 * supported yet */
562 offs -= subs->transfer_done;
563 counts -= subs->transfer_done;
564 urb->iso_frame_desc[i].length =
565 counts * stride;
566 subs->transfer_done = 0;
567 }
568 i++;
569 if (i < ctx->packets) {
570 /* add a transfer delimiter */
571 urb->iso_frame_desc[i].offset =
572 offs * stride;
573 urb->iso_frame_desc[i].length = 0;
574 urb->number_of_packets++;
575 }
576 break;
577 }
578 }
579 /* finish at the frame boundary at/after the period boundary */
580 if (period_elapsed &&
581 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
582 break;
583 }
584 if (subs->hwptr_done + offs > runtime->buffer_size) {
585 /* err, the transferred area goes over buffer boundary. */
586 unsigned int len = runtime->buffer_size - subs->hwptr_done;
587 memcpy(urb->transfer_buffer,
588 runtime->dma_area + subs->hwptr_done * stride,
589 len * stride);
590 memcpy(urb->transfer_buffer + len * stride,
591 runtime->dma_area,
592 (offs - len) * stride);
593 } else {
594 memcpy(urb->transfer_buffer,
595 runtime->dma_area + subs->hwptr_done * stride,
596 offs * stride);
597 }
598 subs->hwptr_done += offs;
599 if (subs->hwptr_done >= runtime->buffer_size)
600 subs->hwptr_done -= runtime->buffer_size;
601 spin_unlock_irqrestore(&subs->lock, flags);
602 urb->transfer_buffer_length = offs * stride;
603 if (period_elapsed)
604 snd_pcm_period_elapsed(subs->pcm_substream);
605 return 0;
606 }
608 /*
609 * process after playback data complete
610 * - nothing to do
611 */
612 static int retire_playback_urb(struct snd_usb_substream *subs,
613 struct snd_pcm_runtime *runtime,
614 struct urb *urb)
615 {
616 return 0;
617 }
620 /*
621 */
622 static struct snd_urb_ops audio_urb_ops[2] = {
623 {
624 .prepare = prepare_startup_playback_urb,
625 .retire = retire_playback_urb,
626 .prepare_sync = prepare_playback_sync_urb,
627 .retire_sync = retire_playback_sync_urb,
628 },
629 {
630 .prepare = prepare_capture_urb,
631 .retire = retire_capture_urb,
632 .prepare_sync = prepare_capture_sync_urb,
633 .retire_sync = retire_capture_sync_urb,
634 },
635 };
637 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
638 {
639 .prepare = prepare_startup_playback_urb,
640 .retire = retire_playback_urb,
641 .prepare_sync = prepare_playback_sync_urb_hs,
642 .retire_sync = retire_playback_sync_urb_hs,
643 },
644 {
645 .prepare = prepare_capture_urb,
646 .retire = retire_capture_urb,
647 .prepare_sync = prepare_capture_sync_urb_hs,
648 .retire_sync = retire_capture_sync_urb,
649 },
650 };
652 /*
653 * complete callback from data urb
654 */
655 static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
656 {
657 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
658 struct snd_usb_substream *subs = ctx->subs;
659 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
660 int err = 0;
662 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
663 ! subs->running || /* can be stopped during retire callback */
664 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
665 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
666 clear_bit(ctx->index, &subs->active_mask);
667 if (err < 0) {
668 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
669 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
670 }
671 }
672 }
675 /*
676 * complete callback from sync urb
677 */
678 static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
679 {
680 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
681 struct snd_usb_substream *subs = ctx->subs;
682 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
683 int err = 0;
685 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
686 ! subs->running || /* can be stopped during retire callback */
687 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
688 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
689 clear_bit(ctx->index + 16, &subs->active_mask);
690 if (err < 0) {
691 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
692 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
693 }
694 }
695 }
698 /* get the physical page pointer at the given offset */
699 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
700 unsigned long offset)
701 {
702 void *pageptr = subs->runtime->dma_area + offset;
703 return vmalloc_to_page(pageptr);
704 }
706 /* allocate virtual buffer; may be called more than once */
707 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
708 {
709 struct snd_pcm_runtime *runtime = subs->runtime;
710 if (runtime->dma_area) {
711 if (runtime->dma_bytes >= size)
712 return 0; /* already large enough */
713 vfree(runtime->dma_area);
714 }
715 runtime->dma_area = vmalloc(size);
716 if (! runtime->dma_area)
717 return -ENOMEM;
718 runtime->dma_bytes = size;
719 return 0;
720 }
722 /* free virtual buffer; may be called more than once */
723 static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
724 {
725 struct snd_pcm_runtime *runtime = subs->runtime;
727 vfree(runtime->dma_area);
728 runtime->dma_area = NULL;
729 return 0;
730 }
733 /*
734 * unlink active urbs.
735 */
736 static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
737 {
738 unsigned int i;
739 int async;
741 subs->running = 0;
743 if (!force && subs->stream->chip->shutdown) /* to be sure... */
744 return -EBADFD;
746 async = !can_sleep && async_unlink;
748 if (! async && in_interrupt())
749 return 0;
751 for (i = 0; i < subs->nurbs; i++) {
752 if (test_bit(i, &subs->active_mask)) {
753 if (! test_and_set_bit(i, &subs->unlink_mask)) {
754 struct urb *u = subs->dataurb[i].urb;
755 if (async)
756 usb_unlink_urb(u);
757 else
758 usb_kill_urb(u);
759 }
760 }
761 }
762 if (subs->syncpipe) {
763 for (i = 0; i < SYNC_URBS; i++) {
764 if (test_bit(i+16, &subs->active_mask)) {
765 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
766 struct urb *u = subs->syncurb[i].urb;
767 if (async)
768 usb_unlink_urb(u);
769 else
770 usb_kill_urb(u);
771 }
772 }
773 }
774 }
775 return 0;
776 }
779 static const char *usb_error_string(int err)
780 {
781 switch (err) {
782 case -ENODEV:
783 return "no device";
784 case -ENOENT:
785 return "endpoint not enabled";
786 case -EPIPE:
787 return "endpoint stalled";
788 case -ENOSPC:
789 return "not enough bandwidth";
790 case -ESHUTDOWN:
791 return "device disabled";
792 case -EHOSTUNREACH:
793 return "device suspended";
794 #ifndef CONFIG_USB_EHCI_SPLIT_ISO
795 case -ENOSYS:
796 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
797 #endif
798 case -EINVAL:
799 case -EAGAIN:
800 case -EFBIG:
801 case -EMSGSIZE:
802 return "internal error";
803 default:
804 return "unknown error";
805 }
806 }
808 /*
809 * set up and start data/sync urbs
810 */
811 static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
812 {
813 unsigned int i;
814 int err;
816 if (subs->stream->chip->shutdown)
817 return -EBADFD;
819 for (i = 0; i < subs->nurbs; i++) {
820 snd_assert(subs->dataurb[i].urb, return -EINVAL);
821 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
822 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
823 goto __error;
824 }
825 }
826 if (subs->syncpipe) {
827 for (i = 0; i < SYNC_URBS; i++) {
828 snd_assert(subs->syncurb[i].urb, return -EINVAL);
829 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
830 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
831 goto __error;
832 }
833 }
834 }
836 subs->active_mask = 0;
837 subs->unlink_mask = 0;
838 subs->running = 1;
839 for (i = 0; i < subs->nurbs; i++) {
840 err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
841 if (err < 0) {
842 snd_printk(KERN_ERR "cannot submit datapipe "
843 "for urb %d, error %d: %s\n",
844 i, err, usb_error_string(err));
845 goto __error;
846 }
847 set_bit(i, &subs->active_mask);
848 }
849 if (subs->syncpipe) {
850 for (i = 0; i < SYNC_URBS; i++) {
851 err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
852 if (err < 0) {
853 snd_printk(KERN_ERR "cannot submit syncpipe "
854 "for urb %d, error %d: %s\n",
855 i, err, usb_error_string(err));
856 goto __error;
857 }
858 set_bit(i + 16, &subs->active_mask);
859 }
860 }
861 return 0;
863 __error:
864 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
865 deactivate_urbs(subs, 0, 0);
866 return -EPIPE;
867 }
870 /*
871 * wait until all urbs are processed.
872 */
873 static int wait_clear_urbs(struct snd_usb_substream *subs)
874 {
875 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
876 unsigned int i;
877 int alive;
879 do {
880 alive = 0;
881 for (i = 0; i < subs->nurbs; i++) {
882 if (test_bit(i, &subs->active_mask))
883 alive++;
884 }
885 if (subs->syncpipe) {
886 for (i = 0; i < SYNC_URBS; i++) {
887 if (test_bit(i + 16, &subs->active_mask))
888 alive++;
889 }
890 }
891 if (! alive)
892 break;
893 schedule_timeout_uninterruptible(1);
894 } while (time_before(jiffies, end_time));
895 if (alive)
896 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
897 return 0;
898 }
901 /*
902 * return the current pcm pointer. just return the hwptr_done value.
903 */
904 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
905 {
906 struct snd_usb_substream *subs;
907 snd_pcm_uframes_t hwptr_done;
909 subs = (struct snd_usb_substream *)substream->runtime->private_data;
910 spin_lock(&subs->lock);
911 hwptr_done = subs->hwptr_done;
912 spin_unlock(&subs->lock);
913 return hwptr_done;
914 }
917 /*
918 * start/stop playback substream
919 */
920 static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
921 int cmd)
922 {
923 struct snd_usb_substream *subs = substream->runtime->private_data;
925 switch (cmd) {
926 case SNDRV_PCM_TRIGGER_START:
927 subs->ops.prepare = prepare_playback_urb;
928 return 0;
929 case SNDRV_PCM_TRIGGER_STOP:
930 return deactivate_urbs(subs, 0, 0);
931 default:
932 return -EINVAL;
933 }
934 }
936 /*
937 * start/stop capture substream
938 */
939 static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
940 int cmd)
941 {
942 struct snd_usb_substream *subs = substream->runtime->private_data;
944 switch (cmd) {
945 case SNDRV_PCM_TRIGGER_START:
946 return start_urbs(subs, substream->runtime);
947 case SNDRV_PCM_TRIGGER_STOP:
948 return deactivate_urbs(subs, 0, 0);
949 default:
950 return -EINVAL;
951 }
952 }
955 /*
956 * release a urb data
957 */
958 static void release_urb_ctx(struct snd_urb_ctx *u)
959 {
960 if (u->urb) {
961 if (u->buffer_size)
962 usb_buffer_free(u->subs->dev, u->buffer_size,
963 u->urb->transfer_buffer,
964 u->urb->transfer_dma);
965 usb_free_urb(u->urb);
966 u->urb = NULL;
967 }
968 }
970 /*
971 * release a substream
972 */
973 static void release_substream_urbs(struct snd_usb_substream *subs, int force)
974 {
975 int i;
977 /* stop urbs (to be sure) */
978 deactivate_urbs(subs, force, 1);
979 wait_clear_urbs(subs);
981 for (i = 0; i < MAX_URBS; i++)
982 release_urb_ctx(&subs->dataurb[i]);
983 for (i = 0; i < SYNC_URBS; i++)
984 release_urb_ctx(&subs->syncurb[i]);
985 usb_buffer_free(subs->dev, SYNC_URBS * 4,
986 subs->syncbuf, subs->sync_dma);
987 subs->syncbuf = NULL;
988 subs->nurbs = 0;
989 }
991 /*
992 * initialize a substream for plaback/capture
993 */
994 static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
995 unsigned int rate, unsigned int frame_bits)
996 {
997 unsigned int maxsize, n, i;
998 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
999 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
1001 /* calculate the frequency in 16.16 format */
1002 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1003 subs->freqn = get_usb_full_speed_rate(rate);
1004 else
1005 subs->freqn = get_usb_high_speed_rate(rate);
1006 subs->freqm = subs->freqn;
1007 /* calculate max. frequency */
1008 if (subs->maxpacksize) {
1009 /* whatever fits into a max. size packet */
1010 maxsize = subs->maxpacksize;
1011 subs->freqmax = (maxsize / (frame_bits >> 3))
1012 << (16 - subs->datainterval);
1013 } else {
1014 /* no max. packet size: just take 25% higher than nominal */
1015 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1016 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1017 >> (16 - subs->datainterval);
1019 subs->phase = 0;
1021 if (subs->fill_max)
1022 subs->curpacksize = subs->maxpacksize;
1023 else
1024 subs->curpacksize = maxsize;
1026 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1027 packs_per_ms = 8 >> subs->datainterval;
1028 else
1029 packs_per_ms = 1;
1030 subs->packs_per_ms = packs_per_ms;
1032 if (is_playback) {
1033 urb_packs = nrpacks;
1034 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1035 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1036 } else
1037 urb_packs = 1;
1038 urb_packs *= packs_per_ms;
1040 /* decide how many packets to be used */
1041 if (is_playback) {
1042 unsigned int minsize;
1043 /* determine how small a packet can be */
1044 minsize = (subs->freqn >> (16 - subs->datainterval))
1045 * (frame_bits >> 3);
1046 /* with sync from device, assume it can be 12% lower */
1047 if (subs->syncpipe)
1048 minsize -= minsize >> 3;
1049 minsize = max(minsize, 1u);
1050 total_packs = (period_bytes + minsize - 1) / minsize;
1051 /* round up to multiple of packs_per_ms */
1052 total_packs = (total_packs + packs_per_ms - 1)
1053 & ~(packs_per_ms - 1);
1054 /* we need at least two URBs for queueing */
1055 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1056 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
1057 } else {
1058 total_packs = MAX_URBS * urb_packs;
1060 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1061 if (subs->nurbs > MAX_URBS) {
1062 /* too much... */
1063 subs->nurbs = MAX_URBS;
1064 total_packs = MAX_URBS * urb_packs;
1066 n = total_packs;
1067 for (i = 0; i < subs->nurbs; i++) {
1068 npacks[i] = n > urb_packs ? urb_packs : n;
1069 n -= urb_packs;
1071 if (subs->nurbs <= 1) {
1072 /* too little - we need at least two packets
1073 * to ensure contiguous playback/capture
1074 */
1075 subs->nurbs = 2;
1076 npacks[0] = (total_packs + 1) / 2;
1077 npacks[1] = total_packs - npacks[0];
1078 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1079 /* the last packet is too small.. */
1080 if (subs->nurbs > 2) {
1081 /* merge to the first one */
1082 npacks[0] += npacks[subs->nurbs - 1];
1083 subs->nurbs--;
1084 } else {
1085 /* divide to two */
1086 subs->nurbs = 2;
1087 npacks[0] = (total_packs + 1) / 2;
1088 npacks[1] = total_packs - npacks[0];
1092 /* allocate and initialize data urbs */
1093 for (i = 0; i < subs->nurbs; i++) {
1094 struct snd_urb_ctx *u = &subs->dataurb[i];
1095 u->index = i;
1096 u->subs = subs;
1097 u->packets = npacks[i];
1098 u->buffer_size = maxsize * u->packets;
1099 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1100 u->packets++; /* for transfer delimiter */
1101 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1102 if (! u->urb)
1103 goto out_of_memory;
1104 u->urb->transfer_buffer =
1105 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1106 &u->urb->transfer_dma);
1107 if (! u->urb->transfer_buffer)
1108 goto out_of_memory;
1109 u->urb->pipe = subs->datapipe;
1110 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1111 u->urb->interval = 1 << subs->datainterval;
1112 u->urb->context = u;
1113 u->urb->complete = snd_complete_urb;
1116 if (subs->syncpipe) {
1117 /* allocate and initialize sync urbs */
1118 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1119 GFP_KERNEL, &subs->sync_dma);
1120 if (! subs->syncbuf)
1121 goto out_of_memory;
1122 for (i = 0; i < SYNC_URBS; i++) {
1123 struct snd_urb_ctx *u = &subs->syncurb[i];
1124 u->index = i;
1125 u->subs = subs;
1126 u->packets = 1;
1127 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1128 if (! u->urb)
1129 goto out_of_memory;
1130 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1131 u->urb->transfer_dma = subs->sync_dma + i * 4;
1132 u->urb->transfer_buffer_length = 4;
1133 u->urb->pipe = subs->syncpipe;
1134 u->urb->transfer_flags = URB_ISO_ASAP |
1135 URB_NO_TRANSFER_DMA_MAP;
1136 u->urb->number_of_packets = 1;
1137 u->urb->interval = 1 << subs->syncinterval;
1138 u->urb->context = u;
1139 u->urb->complete = snd_complete_sync_urb;
1142 return 0;
1144 out_of_memory:
1145 release_substream_urbs(subs, 0);
1146 return -ENOMEM;
1150 /*
1151 * find a matching audio format
1152 */
1153 static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
1154 unsigned int rate, unsigned int channels)
1156 struct list_head *p;
1157 struct audioformat *found = NULL;
1158 int cur_attr = 0, attr;
1160 list_for_each(p, &subs->fmt_list) {
1161 struct audioformat *fp;
1162 fp = list_entry(p, struct audioformat, list);
1163 if (fp->format != format || fp->channels != channels)
1164 continue;
1165 if (rate < fp->rate_min || rate > fp->rate_max)
1166 continue;
1167 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1168 unsigned int i;
1169 for (i = 0; i < fp->nr_rates; i++)
1170 if (fp->rate_table[i] == rate)
1171 break;
1172 if (i >= fp->nr_rates)
1173 continue;
1175 attr = fp->ep_attr & EP_ATTR_MASK;
1176 if (! found) {
1177 found = fp;
1178 cur_attr = attr;
1179 continue;
1181 /* avoid async out and adaptive in if the other method
1182 * supports the same format.
1183 * this is a workaround for the case like
1184 * M-audio audiophile USB.
1185 */
1186 if (attr != cur_attr) {
1187 if ((attr == EP_ATTR_ASYNC &&
1188 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1189 (attr == EP_ATTR_ADAPTIVE &&
1190 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1191 continue;
1192 if ((cur_attr == EP_ATTR_ASYNC &&
1193 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1194 (cur_attr == EP_ATTR_ADAPTIVE &&
1195 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1196 found = fp;
1197 cur_attr = attr;
1198 continue;
1201 /* find the format with the largest max. packet size */
1202 if (fp->maxpacksize > found->maxpacksize) {
1203 found = fp;
1204 cur_attr = attr;
1207 return found;
1211 /*
1212 * initialize the picth control and sample rate
1213 */
1214 static int init_usb_pitch(struct usb_device *dev, int iface,
1215 struct usb_host_interface *alts,
1216 struct audioformat *fmt)
1218 unsigned int ep;
1219 unsigned char data[1];
1220 int err;
1222 ep = get_endpoint(alts, 0)->bEndpointAddress;
1223 /* if endpoint has pitch control, enable it */
1224 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1225 data[0] = 1;
1226 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1227 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1228 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1229 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1230 dev->devnum, iface, ep);
1231 return err;
1234 return 0;
1237 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1238 struct usb_host_interface *alts,
1239 struct audioformat *fmt, int rate)
1241 unsigned int ep;
1242 unsigned char data[3];
1243 int err;
1245 ep = get_endpoint(alts, 0)->bEndpointAddress;
1246 /* if endpoint has sampling rate control, set it */
1247 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1248 int crate;
1249 data[0] = rate;
1250 data[1] = rate >> 8;
1251 data[2] = rate >> 16;
1252 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1253 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1254 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1255 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1256 dev->devnum, iface, fmt->altsetting, rate, ep);
1257 return err;
1259 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1260 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1261 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1262 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1263 dev->devnum, iface, fmt->altsetting, ep);
1264 return 0; /* some devices don't support reading */
1266 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1267 if (crate != rate) {
1268 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1269 // runtime->rate = crate;
1272 return 0;
1275 /*
1276 * find a matching format and set up the interface
1277 */
1278 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
1280 struct usb_device *dev = subs->dev;
1281 struct usb_host_interface *alts;
1282 struct usb_interface_descriptor *altsd;
1283 struct usb_interface *iface;
1284 unsigned int ep, attr;
1285 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1286 int err;
1288 iface = usb_ifnum_to_if(dev, fmt->iface);
1289 snd_assert(iface, return -EINVAL);
1290 alts = &iface->altsetting[fmt->altset_idx];
1291 altsd = get_iface_desc(alts);
1292 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1294 if (fmt == subs->cur_audiofmt)
1295 return 0;
1297 /* close the old interface */
1298 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1299 usb_set_interface(subs->dev, subs->interface, 0);
1300 subs->interface = -1;
1301 subs->format = 0;
1304 /* set interface */
1305 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1306 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1307 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1308 dev->devnum, fmt->iface, fmt->altsetting);
1309 return -EIO;
1311 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1312 subs->interface = fmt->iface;
1313 subs->format = fmt->altset_idx;
1316 /* create a data pipe */
1317 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1318 if (is_playback)
1319 subs->datapipe = usb_sndisocpipe(dev, ep);
1320 else
1321 subs->datapipe = usb_rcvisocpipe(dev, ep);
1322 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1323 get_endpoint(alts, 0)->bInterval >= 1 &&
1324 get_endpoint(alts, 0)->bInterval <= 4)
1325 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1326 else
1327 subs->datainterval = 0;
1328 subs->syncpipe = subs->syncinterval = 0;
1329 subs->maxpacksize = fmt->maxpacksize;
1330 subs->fill_max = 0;
1332 /* we need a sync pipe in async OUT or adaptive IN mode */
1333 /* check the number of EP, since some devices have broken
1334 * descriptors which fool us. if it has only one EP,
1335 * assume it as adaptive-out or sync-in.
1336 */
1337 attr = fmt->ep_attr & EP_ATTR_MASK;
1338 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1339 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1340 altsd->bNumEndpoints >= 2) {
1341 /* check sync-pipe endpoint */
1342 /* ... and check descriptor size before accessing bSynchAddress
1343 because there is a version of the SB Audigy 2 NX firmware lacking
1344 the audio fields in the endpoint descriptors */
1345 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1346 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1347 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1348 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1349 dev->devnum, fmt->iface, fmt->altsetting);
1350 return -EINVAL;
1352 ep = get_endpoint(alts, 1)->bEndpointAddress;
1353 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1354 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1355 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1356 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1357 dev->devnum, fmt->iface, fmt->altsetting);
1358 return -EINVAL;
1360 ep &= USB_ENDPOINT_NUMBER_MASK;
1361 if (is_playback)
1362 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1363 else
1364 subs->syncpipe = usb_sndisocpipe(dev, ep);
1365 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1366 get_endpoint(alts, 1)->bRefresh >= 1 &&
1367 get_endpoint(alts, 1)->bRefresh <= 9)
1368 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1369 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1370 subs->syncinterval = 1;
1371 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1372 get_endpoint(alts, 1)->bInterval <= 16)
1373 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1374 else
1375 subs->syncinterval = 3;
1378 /* always fill max packet size */
1379 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1380 subs->fill_max = 1;
1382 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1383 return err;
1385 subs->cur_audiofmt = fmt;
1387 #if 0
1388 printk("setting done: format = %d, rate = %d, channels = %d\n",
1389 fmt->format, fmt->rate, fmt->channels);
1390 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1391 subs->datapipe, subs->syncpipe);
1392 #endif
1394 return 0;
1397 /*
1398 * hw_params callback
1400 * allocate a buffer and set the given audio format.
1402 * so far we use a physically linear buffer although packetize transfer
1403 * doesn't need a continuous area.
1404 * if sg buffer is supported on the later version of alsa, we'll follow
1405 * that.
1406 */
1407 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1408 struct snd_pcm_hw_params *hw_params)
1410 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
1411 struct audioformat *fmt;
1412 unsigned int channels, rate, format;
1413 int ret, changed;
1415 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1416 params_buffer_bytes(hw_params));
1417 if (ret < 0)
1418 return ret;
1420 format = params_format(hw_params);
1421 rate = params_rate(hw_params);
1422 channels = params_channels(hw_params);
1423 fmt = find_format(subs, format, rate, channels);
1424 if (! fmt) {
1425 snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1426 format, rate, channels);
1427 return -EINVAL;
1430 changed = subs->cur_audiofmt != fmt ||
1431 subs->period_bytes != params_period_bytes(hw_params) ||
1432 subs->cur_rate != rate;
1433 if ((ret = set_format(subs, fmt)) < 0)
1434 return ret;
1436 if (subs->cur_rate != rate) {
1437 struct usb_host_interface *alts;
1438 struct usb_interface *iface;
1439 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1440 alts = &iface->altsetting[fmt->altset_idx];
1441 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1442 if (ret < 0)
1443 return ret;
1444 subs->cur_rate = rate;
1447 if (changed) {
1448 /* format changed */
1449 release_substream_urbs(subs, 0);
1450 /* influenced: period_bytes, channels, rate, format, */
1451 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1452 params_rate(hw_params),
1453 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1456 return ret;
1459 /*
1460 * hw_free callback
1462 * reset the audio format and release the buffer
1463 */
1464 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
1466 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
1468 subs->cur_audiofmt = NULL;
1469 subs->cur_rate = 0;
1470 subs->period_bytes = 0;
1471 release_substream_urbs(subs, 0);
1472 return snd_pcm_free_vmalloc_buffer(substream);
1475 /*
1476 * prepare callback
1478 * only a few subtle things...
1479 */
1480 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
1482 struct snd_pcm_runtime *runtime = substream->runtime;
1483 struct snd_usb_substream *subs = runtime->private_data;
1485 if (! subs->cur_audiofmt) {
1486 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1487 return -ENXIO;
1490 /* some unit conversions in runtime */
1491 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1492 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1494 /* reset the pointer */
1495 subs->hwptr_done = 0;
1496 subs->transfer_done = 0;
1497 subs->phase = 0;
1499 /* clear urbs (to be sure) */
1500 deactivate_urbs(subs, 0, 1);
1501 wait_clear_urbs(subs);
1503 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1504 * updates for all URBs would happen at the same time when starting */
1505 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1506 subs->ops.prepare = prepare_startup_playback_urb;
1507 return start_urbs(subs, runtime);
1508 } else
1509 return 0;
1512 static struct snd_pcm_hardware snd_usb_playback =
1514 .info = SNDRV_PCM_INFO_MMAP |
1515 SNDRV_PCM_INFO_MMAP_VALID |
1516 SNDRV_PCM_INFO_BATCH |
1517 SNDRV_PCM_INFO_INTERLEAVED |
1518 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1519 .buffer_bytes_max = 1024 * 1024,
1520 .period_bytes_min = 64,
1521 .period_bytes_max = 512 * 1024,
1522 .periods_min = 2,
1523 .periods_max = 1024,
1524 };
1526 static struct snd_pcm_hardware snd_usb_capture =
1528 .info = SNDRV_PCM_INFO_MMAP |
1529 SNDRV_PCM_INFO_MMAP_VALID |
1530 SNDRV_PCM_INFO_BATCH |
1531 SNDRV_PCM_INFO_INTERLEAVED |
1532 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1533 .buffer_bytes_max = 1024 * 1024,
1534 .period_bytes_min = 64,
1535 .period_bytes_max = 512 * 1024,
1536 .periods_min = 2,
1537 .periods_max = 1024,
1538 };
1540 /*
1541 * h/w constraints
1542 */
1544 #ifdef HW_CONST_DEBUG
1545 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1546 #else
1547 #define hwc_debug(fmt, args...) /**/
1548 #endif
1550 static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
1552 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1553 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1554 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1556 /* check the format */
1557 if (! snd_mask_test(fmts, fp->format)) {
1558 hwc_debug(" > check: no supported format %d\n", fp->format);
1559 return 0;
1561 /* check the channels */
1562 if (fp->channels < ct->min || fp->channels > ct->max) {
1563 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1564 return 0;
1566 /* check the rate is within the range */
1567 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1568 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1569 return 0;
1571 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1572 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1573 return 0;
1575 return 1;
1578 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1579 struct snd_pcm_hw_rule *rule)
1581 struct snd_usb_substream *subs = rule->private;
1582 struct list_head *p;
1583 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1584 unsigned int rmin, rmax;
1585 int changed;
1587 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1588 changed = 0;
1589 rmin = rmax = 0;
1590 list_for_each(p, &subs->fmt_list) {
1591 struct audioformat *fp;
1592 fp = list_entry(p, struct audioformat, list);
1593 if (! hw_check_valid_format(params, fp))
1594 continue;
1595 if (changed++) {
1596 if (rmin > fp->rate_min)
1597 rmin = fp->rate_min;
1598 if (rmax < fp->rate_max)
1599 rmax = fp->rate_max;
1600 } else {
1601 rmin = fp->rate_min;
1602 rmax = fp->rate_max;
1606 if (! changed) {
1607 hwc_debug(" --> get empty\n");
1608 it->empty = 1;
1609 return -EINVAL;
1612 changed = 0;
1613 if (it->min < rmin) {
1614 it->min = rmin;
1615 it->openmin = 0;
1616 changed = 1;
1618 if (it->max > rmax) {
1619 it->max = rmax;
1620 it->openmax = 0;
1621 changed = 1;
1623 if (snd_interval_checkempty(it)) {
1624 it->empty = 1;
1625 return -EINVAL;
1627 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1628 return changed;
1632 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1633 struct snd_pcm_hw_rule *rule)
1635 struct snd_usb_substream *subs = rule->private;
1636 struct list_head *p;
1637 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1638 unsigned int rmin, rmax;
1639 int changed;
1641 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1642 changed = 0;
1643 rmin = rmax = 0;
1644 list_for_each(p, &subs->fmt_list) {
1645 struct audioformat *fp;
1646 fp = list_entry(p, struct audioformat, list);
1647 if (! hw_check_valid_format(params, fp))
1648 continue;
1649 if (changed++) {
1650 if (rmin > fp->channels)
1651 rmin = fp->channels;
1652 if (rmax < fp->channels)
1653 rmax = fp->channels;
1654 } else {
1655 rmin = fp->channels;
1656 rmax = fp->channels;
1660 if (! changed) {
1661 hwc_debug(" --> get empty\n");
1662 it->empty = 1;
1663 return -EINVAL;
1666 changed = 0;
1667 if (it->min < rmin) {
1668 it->min = rmin;
1669 it->openmin = 0;
1670 changed = 1;
1672 if (it->max > rmax) {
1673 it->max = rmax;
1674 it->openmax = 0;
1675 changed = 1;
1677 if (snd_interval_checkempty(it)) {
1678 it->empty = 1;
1679 return -EINVAL;
1681 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1682 return changed;
1685 static int hw_rule_format(struct snd_pcm_hw_params *params,
1686 struct snd_pcm_hw_rule *rule)
1688 struct snd_usb_substream *subs = rule->private;
1689 struct list_head *p;
1690 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1691 u64 fbits;
1692 u32 oldbits[2];
1693 int changed;
1695 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1696 fbits = 0;
1697 list_for_each(p, &subs->fmt_list) {
1698 struct audioformat *fp;
1699 fp = list_entry(p, struct audioformat, list);
1700 if (! hw_check_valid_format(params, fp))
1701 continue;
1702 fbits |= (1ULL << fp->format);
1705 oldbits[0] = fmt->bits[0];
1706 oldbits[1] = fmt->bits[1];
1707 fmt->bits[0] &= (u32)fbits;
1708 fmt->bits[1] &= (u32)(fbits >> 32);
1709 if (! fmt->bits[0] && ! fmt->bits[1]) {
1710 hwc_debug(" --> get empty\n");
1711 return -EINVAL;
1713 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1714 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1715 return changed;
1718 #define MAX_MASK 64
1720 /*
1721 * check whether the registered audio formats need special hw-constraints
1722 */
1723 static int check_hw_params_convention(struct snd_usb_substream *subs)
1725 int i;
1726 u32 *channels;
1727 u32 *rates;
1728 u32 cmaster, rmaster;
1729 u32 rate_min = 0, rate_max = 0;
1730 struct list_head *p;
1731 int err = 1;
1733 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1734 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1736 list_for_each(p, &subs->fmt_list) {
1737 struct audioformat *f;
1738 f = list_entry(p, struct audioformat, list);
1739 /* unconventional channels? */
1740 if (f->channels > 32)
1741 goto __out;
1742 /* continuous rate min/max matches? */
1743 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1744 if (rate_min && f->rate_min != rate_min)
1745 goto __out;
1746 if (rate_max && f->rate_max != rate_max)
1747 goto __out;
1748 rate_min = f->rate_min;
1749 rate_max = f->rate_max;
1751 /* combination of continuous rates and fixed rates? */
1752 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1753 if (f->rates != rates[f->format])
1754 goto __out;
1756 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1757 if (rates[f->format] && rates[f->format] != f->rates)
1758 goto __out;
1760 channels[f->format] |= (1 << f->channels);
1761 rates[f->format] |= f->rates;
1763 /* check whether channels and rates match for all formats */
1764 cmaster = rmaster = 0;
1765 for (i = 0; i < MAX_MASK; i++) {
1766 if (cmaster != channels[i] && cmaster && channels[i])
1767 goto __out;
1768 if (rmaster != rates[i] && rmaster && rates[i])
1769 goto __out;
1770 if (channels[i])
1771 cmaster = channels[i];
1772 if (rates[i])
1773 rmaster = rates[i];
1775 /* check whether channels match for all distinct rates */
1776 memset(channels, 0, MAX_MASK * sizeof(u32));
1777 list_for_each(p, &subs->fmt_list) {
1778 struct audioformat *f;
1779 f = list_entry(p, struct audioformat, list);
1780 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1781 continue;
1782 for (i = 0; i < 32; i++) {
1783 if (f->rates & (1 << i))
1784 channels[i] |= (1 << f->channels);
1787 cmaster = 0;
1788 for (i = 0; i < 32; i++) {
1789 if (cmaster != channels[i] && cmaster && channels[i])
1790 goto __out;
1791 if (channels[i])
1792 cmaster = channels[i];
1794 err = 0;
1796 __out:
1797 kfree(channels);
1798 kfree(rates);
1799 return err;
1803 /*
1804 * set up the runtime hardware information.
1805 */
1807 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1809 struct list_head *p;
1810 int err;
1812 runtime->hw.formats = subs->formats;
1814 runtime->hw.rate_min = 0x7fffffff;
1815 runtime->hw.rate_max = 0;
1816 runtime->hw.channels_min = 256;
1817 runtime->hw.channels_max = 0;
1818 runtime->hw.rates = 0;
1819 /* check min/max rates and channels */
1820 list_for_each(p, &subs->fmt_list) {
1821 struct audioformat *fp;
1822 fp = list_entry(p, struct audioformat, list);
1823 runtime->hw.rates |= fp->rates;
1824 if (runtime->hw.rate_min > fp->rate_min)
1825 runtime->hw.rate_min = fp->rate_min;
1826 if (runtime->hw.rate_max < fp->rate_max)
1827 runtime->hw.rate_max = fp->rate_max;
1828 if (runtime->hw.channels_min > fp->channels)
1829 runtime->hw.channels_min = fp->channels;
1830 if (runtime->hw.channels_max < fp->channels)
1831 runtime->hw.channels_max = fp->channels;
1832 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1833 /* FIXME: there might be more than one audio formats... */
1834 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1835 fp->frame_size;
1839 /* set the period time minimum 1ms */
1840 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1841 1000 * MIN_PACKS_URB,
1842 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1844 if (check_hw_params_convention(subs)) {
1845 hwc_debug("setting extra hw constraints...\n");
1846 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1847 hw_rule_rate, subs,
1848 SNDRV_PCM_HW_PARAM_FORMAT,
1849 SNDRV_PCM_HW_PARAM_CHANNELS,
1850 -1)) < 0)
1851 return err;
1852 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1853 hw_rule_channels, subs,
1854 SNDRV_PCM_HW_PARAM_FORMAT,
1855 SNDRV_PCM_HW_PARAM_RATE,
1856 -1)) < 0)
1857 return err;
1858 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1859 hw_rule_format, subs,
1860 SNDRV_PCM_HW_PARAM_RATE,
1861 SNDRV_PCM_HW_PARAM_CHANNELS,
1862 -1)) < 0)
1863 return err;
1865 return 0;
1868 static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction,
1869 struct snd_pcm_hardware *hw)
1871 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1872 struct snd_pcm_runtime *runtime = substream->runtime;
1873 struct snd_usb_substream *subs = &as->substream[direction];
1875 subs->interface = -1;
1876 subs->format = 0;
1877 runtime->hw = *hw;
1878 runtime->private_data = subs;
1879 subs->pcm_substream = substream;
1880 return setup_hw_info(runtime, subs);
1883 static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1885 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1886 struct snd_usb_substream *subs = &as->substream[direction];
1888 if (subs->interface >= 0) {
1889 usb_set_interface(subs->dev, subs->interface, 0);
1890 subs->interface = -1;
1892 subs->pcm_substream = NULL;
1893 return 0;
1896 static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1898 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1901 static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1903 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1906 static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1908 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1911 static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1913 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1916 static struct snd_pcm_ops snd_usb_playback_ops = {
1917 .open = snd_usb_playback_open,
1918 .close = snd_usb_playback_close,
1919 .ioctl = snd_pcm_lib_ioctl,
1920 .hw_params = snd_usb_hw_params,
1921 .hw_free = snd_usb_hw_free,
1922 .prepare = snd_usb_pcm_prepare,
1923 .trigger = snd_usb_pcm_playback_trigger,
1924 .pointer = snd_usb_pcm_pointer,
1925 .page = snd_pcm_get_vmalloc_page,
1926 };
1928 static struct snd_pcm_ops snd_usb_capture_ops = {
1929 .open = snd_usb_capture_open,
1930 .close = snd_usb_capture_close,
1931 .ioctl = snd_pcm_lib_ioctl,
1932 .hw_params = snd_usb_hw_params,
1933 .hw_free = snd_usb_hw_free,
1934 .prepare = snd_usb_pcm_prepare,
1935 .trigger = snd_usb_pcm_capture_trigger,
1936 .pointer = snd_usb_pcm_pointer,
1937 .page = snd_pcm_get_vmalloc_page,
1938 };
1942 /*
1943 * helper functions
1944 */
1946 /*
1947 * combine bytes and get an integer value
1948 */
1949 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1951 switch (size) {
1952 case 1: return *bytes;
1953 case 2: return combine_word(bytes);
1954 case 3: return combine_triple(bytes);
1955 case 4: return combine_quad(bytes);
1956 default: return 0;
1960 /*
1961 * parse descriptor buffer and return the pointer starting the given
1962 * descriptor type.
1963 */
1964 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1966 u8 *p, *end, *next;
1968 p = descstart;
1969 end = p + desclen;
1970 for (; p < end;) {
1971 if (p[0] < 2)
1972 return NULL;
1973 next = p + p[0];
1974 if (next > end)
1975 return NULL;
1976 if (p[1] == dtype && (!after || (void *)p > after)) {
1977 return p;
1979 p = next;
1981 return NULL;
1984 /*
1985 * find a class-specified interface descriptor with the given subtype.
1986 */
1987 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1989 unsigned char *p = after;
1991 while ((p = snd_usb_find_desc(buffer, buflen, p,
1992 USB_DT_CS_INTERFACE)) != NULL) {
1993 if (p[0] >= 3 && p[2] == dsubtype)
1994 return p;
1996 return NULL;
1999 /*
2000 * Wrapper for usb_control_msg().
2001 * Allocates a temp buffer to prevent dmaing from/to the stack.
2002 */
2003 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2004 __u8 requesttype, __u16 value, __u16 index, void *data,
2005 __u16 size, int timeout)
2007 int err;
2008 void *buf = NULL;
2010 if (size > 0) {
2011 buf = kmalloc(size, GFP_KERNEL);
2012 if (!buf)
2013 return -ENOMEM;
2014 memcpy(buf, data, size);
2016 err = usb_control_msg(dev, pipe, request, requesttype,
2017 value, index, buf, size, timeout);
2018 if (size > 0) {
2019 memcpy(data, buf, size);
2020 kfree(buf);
2022 return err;
2026 /*
2027 * entry point for linux usb interface
2028 */
2030 static int usb_audio_probe(struct usb_interface *intf,
2031 const struct usb_device_id *id);
2032 static void usb_audio_disconnect(struct usb_interface *intf);
2034 static struct usb_device_id usb_audio_ids [] = {
2035 #include "usbquirks.h"
2036 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2037 .bInterfaceClass = USB_CLASS_AUDIO,
2038 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2039 { } /* Terminating entry */
2040 };
2042 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2044 static struct usb_driver usb_audio_driver = {
2045 .name = "snd-usb-audio",
2046 .probe = usb_audio_probe,
2047 .disconnect = usb_audio_disconnect,
2048 .id_table = usb_audio_ids,
2049 };
2052 #if defined(CONFIG_PROCFS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2054 /*
2055 * proc interface for list the supported pcm formats
2056 */
2057 static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2059 struct list_head *p;
2060 static char *sync_types[4] = {
2061 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2062 };
2064 list_for_each(p, &subs->fmt_list) {
2065 struct audioformat *fp;
2066 fp = list_entry(p, struct audioformat, list);
2067 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2068 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
2069 snd_iprintf(buffer, " Format: 0x%x\n", fp->format);
2070 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2071 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2072 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2073 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2074 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2075 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2076 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2077 fp->rate_min, fp->rate_max);
2078 } else {
2079 unsigned int i;
2080 snd_iprintf(buffer, " Rates: ");
2081 for (i = 0; i < fp->nr_rates; i++) {
2082 if (i > 0)
2083 snd_iprintf(buffer, ", ");
2084 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2086 snd_iprintf(buffer, "\n");
2088 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2089 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2093 static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2095 if (subs->running) {
2096 unsigned int i;
2097 snd_iprintf(buffer, " Status: Running\n");
2098 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2099 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2100 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2101 for (i = 0; i < subs->nurbs; i++)
2102 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2103 snd_iprintf(buffer, "]\n");
2104 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2105 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2106 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2107 ? get_full_speed_hz(subs->freqm)
2108 : get_high_speed_hz(subs->freqm),
2109 subs->freqm >> 16, subs->freqm & 0xffff);
2110 } else {
2111 snd_iprintf(buffer, " Status: Stop\n");
2115 static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
2117 struct snd_usb_stream *stream = entry->private_data;
2119 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2121 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2122 snd_iprintf(buffer, "\nPlayback:\n");
2123 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2124 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2126 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2127 snd_iprintf(buffer, "\nCapture:\n");
2128 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2129 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2133 static void proc_pcm_format_add(struct snd_usb_stream *stream)
2135 struct snd_info_entry *entry;
2136 char name[32];
2137 struct snd_card *card = stream->chip->card;
2139 sprintf(name, "stream%d", stream->pcm_index);
2140 if (! snd_card_proc_new(card, name, &entry))
2141 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
2144 #else
2146 static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2150 #endif
2152 /*
2153 * initialize the substream instance.
2154 */
2156 static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
2158 struct snd_usb_substream *subs = &as->substream[stream];
2160 INIT_LIST_HEAD(&subs->fmt_list);
2161 spin_lock_init(&subs->lock);
2163 subs->stream = as;
2164 subs->direction = stream;
2165 subs->dev = as->chip->dev;
2166 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2167 subs->ops = audio_urb_ops[stream];
2168 else
2169 subs->ops = audio_urb_ops_high_speed[stream];
2170 snd_pcm_set_ops(as->pcm, stream,
2171 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2172 &snd_usb_playback_ops : &snd_usb_capture_ops);
2174 list_add_tail(&fp->list, &subs->fmt_list);
2175 subs->formats |= 1ULL << fp->format;
2176 subs->endpoint = fp->endpoint;
2177 subs->num_formats++;
2178 subs->fmt_type = fp->fmt_type;
2182 /*
2183 * free a substream
2184 */
2185 static void free_substream(struct snd_usb_substream *subs)
2187 struct list_head *p, *n;
2189 if (! subs->num_formats)
2190 return; /* not initialized */
2191 list_for_each_safe(p, n, &subs->fmt_list) {
2192 struct audioformat *fp = list_entry(p, struct audioformat, list);
2193 kfree(fp->rate_table);
2194 kfree(fp);
2199 /*
2200 * free a usb stream instance
2201 */
2202 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
2204 free_substream(&stream->substream[0]);
2205 free_substream(&stream->substream[1]);
2206 list_del(&stream->list);
2207 kfree(stream);
2210 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
2212 struct snd_usb_stream *stream = pcm->private_data;
2213 if (stream) {
2214 stream->pcm = NULL;
2215 snd_usb_audio_stream_free(stream);
2220 /*
2221 * add this endpoint to the chip instance.
2222 * if a stream with the same endpoint already exists, append to it.
2223 * if not, create a new pcm stream.
2224 */
2225 static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
2227 struct list_head *p;
2228 struct snd_usb_stream *as;
2229 struct snd_usb_substream *subs;
2230 struct snd_pcm *pcm;
2231 int err;
2233 list_for_each(p, &chip->pcm_list) {
2234 as = list_entry(p, struct snd_usb_stream, list);
2235 if (as->fmt_type != fp->fmt_type)
2236 continue;
2237 subs = &as->substream[stream];
2238 if (! subs->endpoint)
2239 continue;
2240 if (subs->endpoint == fp->endpoint) {
2241 list_add_tail(&fp->list, &subs->fmt_list);
2242 subs->num_formats++;
2243 subs->formats |= 1ULL << fp->format;
2244 return 0;
2247 /* look for an empty stream */
2248 list_for_each(p, &chip->pcm_list) {
2249 as = list_entry(p, struct snd_usb_stream, list);
2250 if (as->fmt_type != fp->fmt_type)
2251 continue;
2252 subs = &as->substream[stream];
2253 if (subs->endpoint)
2254 continue;
2255 err = snd_pcm_new_stream(as->pcm, stream, 1);
2256 if (err < 0)
2257 return err;
2258 init_substream(as, stream, fp);
2259 return 0;
2262 /* create a new pcm */
2263 as = kzalloc(sizeof(*as), GFP_KERNEL);
2264 if (! as)
2265 return -ENOMEM;
2266 as->pcm_index = chip->pcm_devs;
2267 as->chip = chip;
2268 as->fmt_type = fp->fmt_type;
2269 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2270 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2271 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2272 &pcm);
2273 if (err < 0) {
2274 kfree(as);
2275 return err;
2277 as->pcm = pcm;
2278 pcm->private_data = as;
2279 pcm->private_free = snd_usb_audio_pcm_free;
2280 pcm->info_flags = 0;
2281 if (chip->pcm_devs > 0)
2282 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2283 else
2284 strcpy(pcm->name, "USB Audio");
2286 init_substream(as, stream, fp);
2288 list_add(&as->list, &chip->pcm_list);
2289 chip->pcm_devs++;
2291 proc_pcm_format_add(as);
2293 return 0;
2297 /*
2298 * check if the device uses big-endian samples
2299 */
2300 static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
2302 switch (chip->usb_id) {
2303 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2304 if (fp->endpoint & USB_DIR_IN)
2305 return 1;
2306 break;
2307 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2308 return 1;
2310 return 0;
2313 /*
2314 * parse the audio format type I descriptor
2315 * and returns the corresponding pcm format
2317 * @dev: usb device
2318 * @fp: audioformat record
2319 * @format: the format tag (wFormatTag)
2320 * @fmt: the format type descriptor
2321 */
2322 static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
2323 int format, unsigned char *fmt)
2325 int pcm_format;
2326 int sample_width, sample_bytes;
2328 /* FIXME: correct endianess and sign? */
2329 pcm_format = -1;
2330 sample_width = fmt[6];
2331 sample_bytes = fmt[5];
2332 switch (format) {
2333 case 0: /* some devices don't define this correctly... */
2334 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2335 chip->dev->devnum, fp->iface, fp->altsetting);
2336 /* fall-through */
2337 case USB_AUDIO_FORMAT_PCM:
2338 if (sample_width > sample_bytes * 8) {
2339 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2340 chip->dev->devnum, fp->iface, fp->altsetting,
2341 sample_width, sample_bytes);
2343 /* check the format byte size */
2344 switch (fmt[5]) {
2345 case 1:
2346 pcm_format = SNDRV_PCM_FORMAT_S8;
2347 break;
2348 case 2:
2349 if (is_big_endian_format(chip, fp))
2350 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2351 else
2352 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2353 break;
2354 case 3:
2355 if (is_big_endian_format(chip, fp))
2356 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2357 else
2358 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2359 break;
2360 case 4:
2361 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2362 break;
2363 default:
2364 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2365 chip->dev->devnum, fp->iface,
2366 fp->altsetting, sample_width, sample_bytes);
2367 break;
2369 break;
2370 case USB_AUDIO_FORMAT_PCM8:
2371 /* Dallas DS4201 workaround */
2372 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2373 pcm_format = SNDRV_PCM_FORMAT_S8;
2374 else
2375 pcm_format = SNDRV_PCM_FORMAT_U8;
2376 break;
2377 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2378 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2379 break;
2380 case USB_AUDIO_FORMAT_ALAW:
2381 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2382 break;
2383 case USB_AUDIO_FORMAT_MU_LAW:
2384 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2385 break;
2386 default:
2387 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2388 chip->dev->devnum, fp->iface, fp->altsetting, format);
2389 break;
2391 return pcm_format;
2395 /*
2396 * parse the format descriptor and stores the possible sample rates
2397 * on the audioformat table.
2399 * @dev: usb device
2400 * @fp: audioformat record
2401 * @fmt: the format descriptor
2402 * @offset: the start offset of descriptor pointing the rate type
2403 * (7 for type I and II, 8 for type II)
2404 */
2405 static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
2406 unsigned char *fmt, int offset)
2408 int nr_rates = fmt[offset];
2409 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2410 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2411 chip->dev->devnum, fp->iface, fp->altsetting);
2412 return -1;
2415 if (nr_rates) {
2416 /*
2417 * build the rate table and bitmap flags
2418 */
2419 int r, idx, c;
2420 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2421 static unsigned int conv_rates[] = {
2422 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2423 64000, 88200, 96000, 176400, 192000
2424 };
2425 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2426 if (fp->rate_table == NULL) {
2427 snd_printk(KERN_ERR "cannot malloc\n");
2428 return -1;
2431 fp->nr_rates = nr_rates;
2432 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2433 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2434 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2435 if (rate < fp->rate_min)
2436 fp->rate_min = rate;
2437 else if (rate > fp->rate_max)
2438 fp->rate_max = rate;
2439 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2440 if (rate == conv_rates[c]) {
2441 fp->rates |= (1 << c);
2442 break;
2446 } else {
2447 /* continuous rates */
2448 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2449 fp->rate_min = combine_triple(&fmt[offset + 1]);
2450 fp->rate_max = combine_triple(&fmt[offset + 4]);
2452 return 0;
2455 /*
2456 * parse the format type I and III descriptors
2457 */
2458 static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
2459 int format, unsigned char *fmt)
2461 int pcm_format;
2463 if (fmt[3] == USB_FORMAT_TYPE_III) {
2464 /* FIXME: the format type is really IECxxx
2465 * but we give normal PCM format to get the existing
2466 * apps working...
2467 */
2468 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2469 } else {
2470 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2471 if (pcm_format < 0)
2472 return -1;
2474 fp->format = pcm_format;
2475 fp->channels = fmt[4];
2476 if (fp->channels < 1) {
2477 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2478 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2479 return -1;
2481 return parse_audio_format_rates(chip, fp, fmt, 7);
2484 /*
2485 * prase the format type II descriptor
2486 */
2487 static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
2488 int format, unsigned char *fmt)
2490 int brate, framesize;
2491 switch (format) {
2492 case USB_AUDIO_FORMAT_AC3:
2493 /* FIXME: there is no AC3 format defined yet */
2494 // fp->format = SNDRV_PCM_FORMAT_AC3;
2495 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2496 break;
2497 case USB_AUDIO_FORMAT_MPEG:
2498 fp->format = SNDRV_PCM_FORMAT_MPEG;
2499 break;
2500 default:
2501 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2502 chip->dev->devnum, fp->iface, fp->altsetting, format);
2503 fp->format = SNDRV_PCM_FORMAT_MPEG;
2504 break;
2506 fp->channels = 1;
2507 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2508 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2509 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2510 fp->frame_size = framesize;
2511 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2514 static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
2515 int format, unsigned char *fmt, int stream)
2517 int err;
2519 switch (fmt[3]) {
2520 case USB_FORMAT_TYPE_I:
2521 case USB_FORMAT_TYPE_III:
2522 err = parse_audio_format_i(chip, fp, format, fmt);
2523 break;
2524 case USB_FORMAT_TYPE_II:
2525 err = parse_audio_format_ii(chip, fp, format, fmt);
2526 break;
2527 default:
2528 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2529 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2530 return -1;
2532 fp->fmt_type = fmt[3];
2533 if (err < 0)
2534 return err;
2535 #if 1
2536 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
2537 /* extigy apparently supports sample rates other than 48k
2538 * but not in ordinary way. so we enable only 48k atm.
2539 */
2540 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2541 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2542 chip->usb_id == USB_ID(0x041e, 0x3061)) {
2543 if (fmt[3] == USB_FORMAT_TYPE_I &&
2544 fp->rates != SNDRV_PCM_RATE_48000 &&
2545 fp->rates != SNDRV_PCM_RATE_96000)
2546 return -1;
2548 #endif
2549 return 0;
2552 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2553 int iface, int altno);
2554 static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
2556 struct usb_device *dev;
2557 struct usb_interface *iface;
2558 struct usb_host_interface *alts;
2559 struct usb_interface_descriptor *altsd;
2560 int i, altno, err, stream;
2561 int format;
2562 struct audioformat *fp;
2563 unsigned char *fmt, *csep;
2565 dev = chip->dev;
2567 /* parse the interface's altsettings */
2568 iface = usb_ifnum_to_if(dev, iface_no);
2569 for (i = 0; i < iface->num_altsetting; i++) {
2570 alts = &iface->altsetting[i];
2571 altsd = get_iface_desc(alts);
2572 /* skip invalid one */
2573 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2574 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2575 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2576 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2577 altsd->bNumEndpoints < 1 ||
2578 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2579 continue;
2580 /* must be isochronous */
2581 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2582 USB_ENDPOINT_XFER_ISOC)
2583 continue;
2584 /* check direction */
2585 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2586 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2587 altno = altsd->bAlternateSetting;
2589 /* audiophile usb: skip altsets incompatible with device_setup
2590 */
2591 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2592 audiophile_skip_setting_quirk(chip, iface_no, altno))
2593 continue;
2595 /* get audio formats */
2596 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2597 if (!fmt) {
2598 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2599 dev->devnum, iface_no, altno);
2600 continue;
2603 if (fmt[0] < 7) {
2604 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2605 dev->devnum, iface_no, altno);
2606 continue;
2609 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2611 /* get format type */
2612 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2613 if (!fmt) {
2614 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2615 dev->devnum, iface_no, altno);
2616 continue;
2618 if (fmt[0] < 8) {
2619 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2620 dev->devnum, iface_no, altno);
2621 continue;
2624 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2625 /* Creamware Noah has this descriptor after the 2nd endpoint */
2626 if (!csep && altsd->bNumEndpoints >= 2)
2627 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2628 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2629 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
2630 " class specific endpoint descriptor\n",
2631 dev->devnum, iface_no, altno);
2632 csep = NULL;
2635 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
2636 if (! fp) {
2637 snd_printk(KERN_ERR "cannot malloc\n");
2638 return -ENOMEM;
2641 fp->iface = iface_no;
2642 fp->altsetting = altno;
2643 fp->altset_idx = i;
2644 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2645 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2646 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2647 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2648 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2649 * (fp->maxpacksize & 0x7ff);
2650 fp->attributes = csep ? csep[3] : 0;
2652 /* some quirks for attributes here */
2654 switch (chip->usb_id) {
2655 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2656 /* Optoplay sets the sample rate attribute although
2657 * it seems not supporting it in fact.
2658 */
2659 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2660 break;
2661 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2662 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2663 /* doesn't set the sample rate attribute, but supports it */
2664 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2665 break;
2666 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2667 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2668 an older model 77d:223) */
2669 /*
2670 * plantronics headset and Griffin iMic have set adaptive-in
2671 * although it's really not...
2672 */
2673 fp->ep_attr &= ~EP_ATTR_MASK;
2674 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2675 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2676 else
2677 fp->ep_attr |= EP_ATTR_SYNC;
2678 break;
2681 /* ok, let's parse further... */
2682 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2683 kfree(fp->rate_table);
2684 kfree(fp);
2685 continue;
2688 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, altno, fp->endpoint);
2689 err = add_audio_endpoint(chip, stream, fp);
2690 if (err < 0) {
2691 kfree(fp->rate_table);
2692 kfree(fp);
2693 return err;
2695 /* try to set the interface... */
2696 usb_set_interface(chip->dev, iface_no, altno);
2697 init_usb_pitch(chip->dev, iface_no, alts, fp);
2698 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2700 return 0;
2704 /*
2705 * disconnect streams
2706 * called from snd_usb_audio_disconnect()
2707 */
2708 static void snd_usb_stream_disconnect(struct list_head *head)
2710 int idx;
2711 struct snd_usb_stream *as;
2712 struct snd_usb_substream *subs;
2714 as = list_entry(head, struct snd_usb_stream, list);
2715 for (idx = 0; idx < 2; idx++) {
2716 subs = &as->substream[idx];
2717 if (!subs->num_formats)
2718 return;
2719 release_substream_urbs(subs, 1);
2720 subs->interface = -1;
2724 /*
2725 * parse audio control descriptor and create pcm/midi streams
2726 */
2727 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
2729 struct usb_device *dev = chip->dev;
2730 struct usb_host_interface *host_iface;
2731 struct usb_interface *iface;
2732 unsigned char *p1;
2733 int i, j;
2735 /* find audiocontrol interface */
2736 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2737 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2738 snd_printk(KERN_ERR "cannot find HEADER\n");
2739 return -EINVAL;
2741 if (! p1[7] || p1[0] < 8 + p1[7]) {
2742 snd_printk(KERN_ERR "invalid HEADER\n");
2743 return -EINVAL;
2746 /*
2747 * parse all USB audio streaming interfaces
2748 */
2749 for (i = 0; i < p1[7]; i++) {
2750 struct usb_host_interface *alts;
2751 struct usb_interface_descriptor *altsd;
2752 j = p1[8 + i];
2753 iface = usb_ifnum_to_if(dev, j);
2754 if (!iface) {
2755 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2756 dev->devnum, ctrlif, j);
2757 continue;
2759 if (usb_interface_claimed(iface)) {
2760 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2761 continue;
2763 alts = &iface->altsetting[0];
2764 altsd = get_iface_desc(alts);
2765 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2766 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2767 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2768 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2769 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2770 continue;
2772 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2773 continue;
2775 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2776 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2777 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2778 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2779 /* skip non-supported classes */
2780 continue;
2782 if (! parse_audio_endpoints(chip, j)) {
2783 usb_set_interface(dev, j, 0); /* reset the current interface */
2784 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2788 return 0;
2791 /*
2792 * create a stream for an endpoint/altsetting without proper descriptors
2793 */
2794 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
2795 struct usb_interface *iface,
2796 const struct snd_usb_audio_quirk *quirk)
2798 struct audioformat *fp;
2799 struct usb_host_interface *alts;
2800 int stream, err;
2801 int *rate_table = NULL;
2803 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2804 if (! fp) {
2805 snd_printk(KERN_ERR "cannot malloc\n");
2806 return -ENOMEM;
2808 memcpy(fp, quirk->data, sizeof(*fp));
2809 if (fp->nr_rates > 0) {
2810 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2811 if (!rate_table) {
2812 kfree(fp);
2813 return -ENOMEM;
2815 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2816 fp->rate_table = rate_table;
2819 stream = (fp->endpoint & USB_DIR_IN)
2820 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2821 err = add_audio_endpoint(chip, stream, fp);
2822 if (err < 0) {
2823 kfree(fp);
2824 kfree(rate_table);
2825 return err;
2827 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2828 fp->altset_idx >= iface->num_altsetting) {
2829 kfree(fp);
2830 kfree(rate_table);
2831 return -EINVAL;
2833 alts = &iface->altsetting[fp->altset_idx];
2834 usb_set_interface(chip->dev, fp->iface, 0);
2835 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2836 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2837 return 0;
2840 /*
2841 * create a stream for an interface with proper descriptors
2842 */
2843 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
2844 struct usb_interface *iface,
2845 const struct snd_usb_audio_quirk *quirk)
2847 struct usb_host_interface *alts;
2848 struct usb_interface_descriptor *altsd;
2849 int err;
2851 alts = &iface->altsetting[0];
2852 altsd = get_iface_desc(alts);
2853 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2854 if (err < 0) {
2855 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2856 altsd->bInterfaceNumber, err);
2857 return err;
2859 /* reset the current interface */
2860 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2861 return 0;
2864 /*
2865 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2866 * to detect the sample rate is by looking at wMaxPacketSize.
2867 */
2868 static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
2869 struct usb_interface *iface,
2870 const struct snd_usb_audio_quirk *quirk)
2872 static const struct audioformat ua_format = {
2873 .format = SNDRV_PCM_FORMAT_S24_3LE,
2874 .channels = 2,
2875 .fmt_type = USB_FORMAT_TYPE_I,
2876 .altsetting = 1,
2877 .altset_idx = 1,
2878 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2879 };
2880 struct usb_host_interface *alts;
2881 struct usb_interface_descriptor *altsd;
2882 struct audioformat *fp;
2883 int stream, err;
2885 /* both PCM and MIDI interfaces have 2 altsettings */
2886 if (iface->num_altsetting != 2)
2887 return -ENXIO;
2888 alts = &iface->altsetting[1];
2889 altsd = get_iface_desc(alts);
2891 if (altsd->bNumEndpoints == 2) {
2892 static const struct snd_usb_midi_endpoint_info ua700_ep = {
2893 .out_cables = 0x0003,
2894 .in_cables = 0x0003
2895 };
2896 static const struct snd_usb_audio_quirk ua700_quirk = {
2897 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2898 .data = &ua700_ep
2899 };
2900 static const struct snd_usb_midi_endpoint_info ua25_ep = {
2901 .out_cables = 0x0001,
2902 .in_cables = 0x0001
2903 };
2904 static const struct snd_usb_audio_quirk ua25_quirk = {
2905 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2906 .data = &ua25_ep
2907 };
2908 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2909 return snd_usb_create_midi_interface(chip, iface,
2910 &ua700_quirk);
2911 else
2912 return snd_usb_create_midi_interface(chip, iface,
2913 &ua25_quirk);
2916 if (altsd->bNumEndpoints != 1)
2917 return -ENXIO;
2919 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2920 if (!fp)
2921 return -ENOMEM;
2922 memcpy(fp, &ua_format, sizeof(*fp));
2924 fp->iface = altsd->bInterfaceNumber;
2925 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2926 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2927 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2929 switch (fp->maxpacksize) {
2930 case 0x120:
2931 fp->rate_max = fp->rate_min = 44100;
2932 break;
2933 case 0x138:
2934 case 0x140:
2935 fp->rate_max = fp->rate_min = 48000;
2936 break;
2937 case 0x258:
2938 case 0x260:
2939 fp->rate_max = fp->rate_min = 96000;
2940 break;
2941 default:
2942 snd_printk(KERN_ERR "unknown sample rate\n");
2943 kfree(fp);
2944 return -ENXIO;
2947 stream = (fp->endpoint & USB_DIR_IN)
2948 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2949 err = add_audio_endpoint(chip, stream, fp);
2950 if (err < 0) {
2951 kfree(fp);
2952 return err;
2954 usb_set_interface(chip->dev, fp->iface, 0);
2955 return 0;
2958 /*
2959 * Create a stream for an Edirol UA-1000 interface.
2960 */
2961 static int create_ua1000_quirk(struct snd_usb_audio *chip,
2962 struct usb_interface *iface,
2963 const struct snd_usb_audio_quirk *quirk)
2965 static const struct audioformat ua1000_format = {
2966 .format = SNDRV_PCM_FORMAT_S32_LE,
2967 .fmt_type = USB_FORMAT_TYPE_I,
2968 .altsetting = 1,
2969 .altset_idx = 1,
2970 .attributes = 0,
2971 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2972 };
2973 struct usb_host_interface *alts;
2974 struct usb_interface_descriptor *altsd;
2975 struct audioformat *fp;
2976 int stream, err;
2978 if (iface->num_altsetting != 2)
2979 return -ENXIO;
2980 alts = &iface->altsetting[1];
2981 altsd = get_iface_desc(alts);
2982 if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
2983 altsd->bNumEndpoints != 1)
2984 return -ENXIO;
2986 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2987 if (!fp)
2988 return -ENOMEM;
2989 memcpy(fp, &ua1000_format, sizeof(*fp));
2991 fp->channels = alts->extra[4];
2992 fp->iface = altsd->bInterfaceNumber;
2993 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2994 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2995 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2996 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2998 stream = (fp->endpoint & USB_DIR_IN)
2999 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3000 err = add_audio_endpoint(chip, stream, fp);
3001 if (err < 0) {
3002 kfree(fp);
3003 return err;
3005 /* FIXME: playback must be synchronized to capture */
3006 usb_set_interface(chip->dev, fp->iface, 0);
3007 return 0;
3010 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3011 struct usb_interface *iface,
3012 const struct snd_usb_audio_quirk *quirk);
3014 /*
3015 * handle the quirks for the contained interfaces
3016 */
3017 static int create_composite_quirk(struct snd_usb_audio *chip,
3018 struct usb_interface *iface,
3019 const struct snd_usb_audio_quirk *quirk)
3021 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3022 int err;
3024 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3025 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3026 if (!iface)
3027 continue;
3028 if (quirk->ifnum != probed_ifnum &&
3029 usb_interface_claimed(iface))
3030 continue;
3031 err = snd_usb_create_quirk(chip, iface, quirk);
3032 if (err < 0)
3033 return err;
3034 if (quirk->ifnum != probed_ifnum)
3035 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3037 return 0;
3040 static int ignore_interface_quirk(struct snd_usb_audio *chip,
3041 struct usb_interface *iface,
3042 const struct snd_usb_audio_quirk *quirk)
3044 return 0;
3048 /*
3049 * boot quirks
3050 */
3052 #define EXTIGY_FIRMWARE_SIZE_OLD 794
3053 #define EXTIGY_FIRMWARE_SIZE_NEW 483
3055 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3057 struct usb_host_config *config = dev->actconfig;
3058 int err;
3060 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3061 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3062 snd_printdd("sending Extigy boot sequence...\n");
3063 /* Send message to force it to reconnect with full interface. */
3064 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3065 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3066 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3067 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3068 &dev->descriptor, sizeof(dev->descriptor));
3069 config = dev->actconfig;
3070 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3071 err = usb_reset_configuration(dev);
3072 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3073 snd_printdd("extigy_boot: new boot length = %d\n",
3074 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3075 return -ENODEV; /* quit this anyway */
3077 return 0;
3080 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3082 u8 buf = 1;
3084 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3085 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3086 0, 0, &buf, 1, 1000);
3087 if (buf == 0) {
3088 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3089 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3090 1, 2000, NULL, 0, 1000);
3091 return -ENODEV;
3093 return 0;
3096 /*
3097 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3098 * documented in the device's data sheet.
3099 */
3100 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3102 u8 buf[4];
3103 buf[0] = 0x20;
3104 buf[1] = value & 0xff;
3105 buf[2] = (value >> 8) & 0xff;
3106 buf[3] = reg;
3107 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3108 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3109 0, 0, &buf, 4, 1000);
3112 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3114 /*
3115 * Enable line-out driver mode, set headphone source to front
3116 * channels, enable stereo mic.
3117 */
3118 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3122 /*
3123 * Setup quirks
3124 */
3125 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3126 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3127 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3128 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3129 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3130 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3131 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3132 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3133 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3134 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3136 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3137 int iface, int altno)
3139 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3140 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3141 && altno != 6)
3142 return 1; /* skip this altsetting */
3143 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3144 && altno != 1)
3145 return 1; /* skip this altsetting */
3146 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3147 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3148 return 1; /* skip this altsetting */
3149 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3150 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3151 return 1; /* skip this altsetting */
3152 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3153 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3154 return 1; /* skip this altsetting */
3155 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3156 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3157 return 1; /* skip this altsetting */
3159 return 0; /* keep this altsetting */
3162 /*
3163 * audio-interface quirks
3165 * returns zero if no standard audio/MIDI parsing is needed.
3166 * returns a postive value if standard audio/midi interfaces are parsed
3167 * after this.
3168 * returns a negative value at error.
3169 */
3170 static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3171 struct usb_interface *iface,
3172 const struct snd_usb_audio_quirk *quirk)
3174 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3175 const struct snd_usb_audio_quirk *);
3176 static const quirk_func_t quirk_funcs[] = {
3177 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3178 [QUIRK_COMPOSITE] = create_composite_quirk,
3179 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3180 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3181 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3182 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3183 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3184 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3185 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3186 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
3187 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3188 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3189 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3190 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3191 };
3193 if (quirk->type < QUIRK_TYPE_COUNT) {
3194 return quirk_funcs[quirk->type](chip, iface, quirk);
3195 } else {
3196 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3197 return -ENXIO;
3202 /*
3203 * common proc files to show the usb device info
3204 */
3205 static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3207 struct snd_usb_audio *chip = entry->private_data;
3208 if (! chip->shutdown)
3209 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3212 static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3214 struct snd_usb_audio *chip = entry->private_data;
3215 if (! chip->shutdown)
3216 snd_iprintf(buffer, "%04x:%04x\n",
3217 USB_ID_VENDOR(chip->usb_id),
3218 USB_ID_PRODUCT(chip->usb_id));
3221 static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
3223 struct snd_info_entry *entry;
3224 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3225 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
3226 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3227 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
3230 /*
3231 * free the chip instance
3233 * here we have to do not much, since pcm and controls are already freed
3235 */
3237 static int snd_usb_audio_free(struct snd_usb_audio *chip)
3239 kfree(chip);
3240 return 0;
3243 static int snd_usb_audio_dev_free(struct snd_device *device)
3245 struct snd_usb_audio *chip = device->device_data;
3246 return snd_usb_audio_free(chip);
3250 /*
3251 * create a chip instance and set its names.
3252 */
3253 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3254 const struct snd_usb_audio_quirk *quirk,
3255 struct snd_usb_audio **rchip)
3257 struct snd_card *card;
3258 struct snd_usb_audio *chip;
3259 int err, len;
3260 char component[14];
3261 static struct snd_device_ops ops = {
3262 .dev_free = snd_usb_audio_dev_free,
3263 };
3265 *rchip = NULL;
3267 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3268 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3269 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3270 return -ENXIO;
3273 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3274 if (card == NULL) {
3275 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3276 return -ENOMEM;
3279 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3280 if (! chip) {
3281 snd_card_free(card);
3282 return -ENOMEM;
3285 chip->index = idx;
3286 chip->dev = dev;
3287 chip->card = card;
3288 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3289 le16_to_cpu(dev->descriptor.idProduct));
3290 INIT_LIST_HEAD(&chip->pcm_list);
3291 INIT_LIST_HEAD(&chip->midi_list);
3292 INIT_LIST_HEAD(&chip->mixer_list);
3294 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3295 snd_usb_audio_free(chip);
3296 snd_card_free(card);
3297 return err;
3300 strcpy(card->driver, "USB-Audio");
3301 sprintf(component, "USB%04x:%04x",
3302 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3303 snd_component_add(card, component);
3305 /* retrieve the device string as shortname */
3306 if (quirk && quirk->product_name) {
3307 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3308 } else {
3309 if (!dev->descriptor.iProduct ||
3310 usb_string(dev, dev->descriptor.iProduct,
3311 card->shortname, sizeof(card->shortname)) <= 0) {
3312 /* no name available from anywhere, so use ID */
3313 sprintf(card->shortname, "USB Device %#04x:%#04x",
3314 USB_ID_VENDOR(chip->usb_id),
3315 USB_ID_PRODUCT(chip->usb_id));
3319 /* retrieve the vendor and device strings as longname */
3320 if (quirk && quirk->vendor_name) {
3321 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3322 } else {
3323 if (dev->descriptor.iManufacturer)
3324 len = usb_string(dev, dev->descriptor.iManufacturer,
3325 card->longname, sizeof(card->longname));
3326 else
3327 len = 0;
3328 /* we don't really care if there isn't any vendor string */
3330 if (len > 0)
3331 strlcat(card->longname, " ", sizeof(card->longname));
3333 strlcat(card->longname, card->shortname, sizeof(card->longname));
3335 len = strlcat(card->longname, " at ", sizeof(card->longname));
3337 if (len < sizeof(card->longname))
3338 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3340 strlcat(card->longname,
3341 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3342 sizeof(card->longname));
3344 snd_usb_audio_create_proc(chip);
3346 *rchip = chip;
3347 return 0;
3351 /*
3352 * probe the active usb device
3354 * note that this can be called multiple times per a device, when it
3355 * includes multiple audio control interfaces.
3357 * thus we check the usb device pointer and creates the card instance
3358 * only at the first time. the successive calls of this function will
3359 * append the pcm interface to the corresponding card.
3360 */
3361 static void *snd_usb_audio_probe(struct usb_device *dev,
3362 struct usb_interface *intf,
3363 const struct usb_device_id *usb_id)
3365 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
3366 int i, err;
3367 struct snd_usb_audio *chip;
3368 struct usb_host_interface *alts;
3369 int ifnum;
3370 u32 id;
3372 alts = &intf->altsetting[0];
3373 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3374 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3375 le16_to_cpu(dev->descriptor.idProduct));
3377 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3378 goto __err_val;
3380 /* SB Extigy needs special boot-up sequence */
3381 /* if more models come, this will go to the quirk list. */
3382 if (id == USB_ID(0x041e, 0x3000)) {
3383 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3384 goto __err_val;
3386 /* SB Audigy 2 NX needs its own boot-up magic, too */
3387 if (id == USB_ID(0x041e, 0x3020)) {
3388 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3389 goto __err_val;
3392 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3393 if (id == USB_ID(0x10f5, 0x0200)) {
3394 if (snd_usb_cm106_boot_quirk(dev) < 0)
3395 goto __err_val;
3398 /*
3399 * found a config. now register to ALSA
3400 */
3402 /* check whether it's already registered */
3403 chip = NULL;
3404 mutex_lock(&register_mutex);
3405 for (i = 0; i < SNDRV_CARDS; i++) {
3406 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3407 if (usb_chip[i]->shutdown) {
3408 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3409 goto __error;
3411 chip = usb_chip[i];
3412 break;
3415 if (! chip) {
3416 /* it's a fresh one.
3417 * now look for an empty slot and create a new card instance
3418 */
3419 for (i = 0; i < SNDRV_CARDS; i++)
3420 if (enable[i] && ! usb_chip[i] &&
3421 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3422 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3423 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3424 goto __error;
3426 snd_card_set_dev(chip->card, &intf->dev);
3427 break;
3429 if (! chip) {
3430 snd_printk(KERN_ERR "no available usb audio device\n");
3431 goto __error;
3435 err = 1; /* continue */
3436 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3437 /* need some special handlings */
3438 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3439 goto __error;
3442 if (err > 0) {
3443 /* create normal USB audio interfaces */
3444 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3445 snd_usb_create_mixer(chip, ifnum) < 0) {
3446 goto __error;
3450 /* we are allowed to call snd_card_register() many times */
3451 if (snd_card_register(chip->card) < 0) {
3452 goto __error;
3455 usb_chip[chip->index] = chip;
3456 chip->num_interfaces++;
3457 mutex_unlock(&register_mutex);
3458 return chip;
3460 __error:
3461 if (chip && !chip->num_interfaces)
3462 snd_card_free(chip->card);
3463 mutex_unlock(&register_mutex);
3464 __err_val:
3465 return NULL;
3468 /*
3469 * we need to take care of counter, since disconnection can be called also
3470 * many times as well as usb_audio_probe().
3471 */
3472 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3474 struct snd_usb_audio *chip;
3475 struct snd_card *card;
3476 struct list_head *p;
3478 if (ptr == (void *)-1L)
3479 return;
3481 chip = ptr;
3482 card = chip->card;
3483 mutex_lock(&register_mutex);
3484 chip->shutdown = 1;
3485 chip->num_interfaces--;
3486 if (chip->num_interfaces <= 0) {
3487 snd_card_disconnect(card);
3488 /* release the pcm resources */
3489 list_for_each(p, &chip->pcm_list) {
3490 snd_usb_stream_disconnect(p);
3492 /* release the midi resources */
3493 list_for_each(p, &chip->midi_list) {
3494 snd_usbmidi_disconnect(p);
3496 /* release mixer resources */
3497 list_for_each(p, &chip->mixer_list) {
3498 snd_usb_mixer_disconnect(p);
3500 usb_chip[chip->index] = NULL;
3501 mutex_unlock(&register_mutex);
3502 snd_card_free(card);
3503 } else {
3504 mutex_unlock(&register_mutex);
3508 /*
3509 * new 2.5 USB kernel API
3510 */
3511 static int usb_audio_probe(struct usb_interface *intf,
3512 const struct usb_device_id *id)
3514 void *chip;
3515 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3516 if (chip) {
3517 dev_set_drvdata(&intf->dev, chip);
3518 return 0;
3519 } else
3520 return -EIO;
3523 static void usb_audio_disconnect(struct usb_interface *intf)
3525 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3526 dev_get_drvdata(&intf->dev));
3530 static int __init snd_usb_audio_init(void)
3532 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3533 printk(KERN_WARNING "invalid nrpacks value.\n");
3534 return -EINVAL;
3536 usb_register(&usb_audio_driver);
3537 return 0;
3541 static void __exit snd_usb_audio_cleanup(void)
3543 usb_deregister(&usb_audio_driver);
3546 module_init(snd_usb_audio_init);
3547 module_exit(snd_usb_audio_cleanup);