[ALSA] usb-audio: simplify MIDI quirk handling
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / sound / usb / usbaudio.c
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 */
39
40
41 #include <sound/driver.h>
42 #include <linux/bitops.h>
43 #include <linux/init.h>
44 #include <linux/interrupt.h>
45 #include <linux/list.h>
46 #include <linux/slab.h>
47 #include <linux/string.h>
48 #include <linux/usb.h>
49 #include <linux/vmalloc.h>
50 #include <linux/moduleparam.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>
56
57 #include "usbaudio.h"
58
59
60 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
61 MODULE_DESCRIPTION("USB Audio");
62 MODULE_LICENSE("GPL");
63 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
64
65
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
74 module_param_array(index, int, NULL, 0444);
75 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
76 module_param_array(id, charp, NULL, 0444);
77 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
78 module_param_array(enable, bool, NULL, 0444);
79 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
80 module_param_array(vid, int, NULL, 0444);
81 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
82 module_param_array(pid, int, NULL, 0444);
83 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
84 module_param(nrpacks, int, 0644);
85 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
86 module_param(async_unlink, bool, 0444);
87 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
88
89
90 /*
91 * debug the h/w constraints
92 */
93 /* #define HW_CONST_DEBUG */
94
95
96 /*
97 *
98 */
99
100 #define MAX_PACKS 10
101 #define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
102 #define MAX_URBS 8
103 #define SYNC_URBS 4 /* always four urbs for sync */
104 #define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
105
106 typedef struct snd_usb_substream snd_usb_substream_t;
107 typedef struct snd_usb_stream snd_usb_stream_t;
108 typedef struct snd_urb_ctx snd_urb_ctx_t;
109
110 struct audioformat {
111 struct list_head list;
112 snd_pcm_format_t format; /* format type */
113 unsigned int channels; /* # channels */
114 unsigned int fmt_type; /* USB audio format type (1-3) */
115 unsigned int frame_size; /* samples per frame for non-audio */
116 int iface; /* interface number */
117 unsigned char altsetting; /* corresponding alternate setting */
118 unsigned char altset_idx; /* array index of altenate setting */
119 unsigned char attributes; /* corresponding attributes of cs endpoint */
120 unsigned char endpoint; /* endpoint */
121 unsigned char ep_attr; /* endpoint attributes */
122 unsigned int maxpacksize; /* max. packet size */
123 unsigned int rates; /* rate bitmasks */
124 unsigned int rate_min, rate_max; /* min/max rates */
125 unsigned int nr_rates; /* number of rate table entries */
126 unsigned int *rate_table; /* rate table */
127 };
128
129 struct snd_urb_ctx {
130 struct urb *urb;
131 unsigned int buffer_size; /* size of data buffer, if data URB */
132 snd_usb_substream_t *subs;
133 int index; /* index for urb array */
134 int packets; /* number of packets per urb */
135 };
136
137 struct snd_urb_ops {
138 int (*prepare)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
139 int (*retire)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
140 int (*prepare_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
141 int (*retire_sync)(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime, struct urb *u);
142 };
143
144 struct snd_usb_substream {
145 snd_usb_stream_t *stream;
146 struct usb_device *dev;
147 snd_pcm_substream_t *pcm_substream;
148 int direction; /* playback or capture */
149 int interface; /* current interface */
150 int endpoint; /* assigned endpoint */
151 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
152 unsigned int cur_rate; /* current rate (for hw_params callback) */
153 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
154 unsigned int format; /* USB data format */
155 unsigned int datapipe; /* the data i/o pipe */
156 unsigned int syncpipe; /* 1 - async out or adaptive in */
157 unsigned int datainterval; /* log_2 of data packet interval */
158 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
159 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
160 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
162 unsigned int phase; /* phase accumulator */
163 unsigned int maxpacksize; /* max packet size in bytes */
164 unsigned int maxframesize; /* max packet size in frames */
165 unsigned int curpacksize; /* current packet size in bytes (for capture) */
166 unsigned int curframesize; /* current packet size in frames (for capture) */
167 unsigned int fill_max: 1; /* fill max packet size always */
168 unsigned int fmt_type; /* USB audio format type (1-3) */
169 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
170
171 unsigned int running: 1; /* running status */
172
173 unsigned int hwptr_done; /* processed frame position in the buffer */
174 unsigned int transfer_done; /* processed frames since last period update */
175 unsigned long active_mask; /* bitmask of active urbs */
176 unsigned long unlink_mask; /* bitmask of unlinked urbs */
177
178 unsigned int nurbs; /* # urbs */
179 snd_urb_ctx_t dataurb[MAX_URBS]; /* data urb table */
180 snd_urb_ctx_t syncurb[SYNC_URBS]; /* sync urb table */
181 char *syncbuf; /* sync buffer for all sync URBs */
182 dma_addr_t sync_dma; /* DMA address of syncbuf */
183
184 u64 formats; /* format bitmasks (all or'ed) */
185 unsigned int num_formats; /* number of supported audio formats (list) */
186 struct list_head fmt_list; /* format list */
187 spinlock_t lock;
188 struct tasklet_struct start_period_elapsed; /* for start trigger */
189
190 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
191 };
192
193
194 struct snd_usb_stream {
195 snd_usb_audio_t *chip;
196 snd_pcm_t *pcm;
197 int pcm_index;
198 unsigned int fmt_type; /* USB audio format type (1-3) */
199 snd_usb_substream_t substream[2];
200 struct list_head list;
201 };
202
203
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 */
208
209 static DECLARE_MUTEX(register_mutex);
210 static snd_usb_audio_t *usb_chip[SNDRV_CARDS];
211
212
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 }
221
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 }
230
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 }
236
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 }
242
243
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(snd_usb_substream_t *subs,
251 snd_pcm_runtime_t *runtime,
252 struct urb *urb)
253 {
254 unsigned char *cp = urb->transfer_buffer;
255 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
256
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 }
265
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(snd_usb_substream_t *subs,
273 snd_pcm_runtime_t *runtime,
274 struct urb *urb)
275 {
276 unsigned char *cp = urb->transfer_buffer;
277 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
278
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 }
288
289 /*
290 * process after capture sync complete
291 * - nothing to do
292 */
293 static int retire_capture_sync_urb(snd_usb_substream_t *subs,
294 snd_pcm_runtime_t *runtime,
295 struct urb *urb)
296 {
297 return 0;
298 }
299
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(snd_usb_substream_t *subs,
311 snd_pcm_runtime_t *runtime,
312 struct urb *urb)
313 {
314 int i, offs;
315 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
316
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 }
338
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(snd_usb_substream_t *subs,
346 snd_pcm_runtime_t *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;
354
355 stride = runtime->frame_bits >> 3;
356
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 }
392
393
394 /*
395 * prepare urb for full speed playback sync pipe
396 *
397 * set up the offset and length to receive the current frequency.
398 */
399
400 static int prepare_playback_sync_urb(snd_usb_substream_t *subs,
401 snd_pcm_runtime_t *runtime,
402 struct urb *urb)
403 {
404 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
405
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 }
411
412 /*
413 * prepare urb for high speed playback sync pipe
414 *
415 * set up the offset and length to receive the current frequency.
416 */
417
418 static int prepare_playback_sync_urb_hs(snd_usb_substream_t *subs,
419 snd_pcm_runtime_t *runtime,
420 struct urb *urb)
421 {
422 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
423
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 }
429
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(snd_usb_substream_t *subs,
437 snd_pcm_runtime_t *runtime,
438 struct urb *urb)
439 {
440 unsigned int f;
441 unsigned long flags;
442
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 }
452
453 return 0;
454 }
455
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(snd_usb_substream_t *subs,
463 snd_pcm_runtime_t *runtime,
464 struct urb *urb)
465 {
466 unsigned int f;
467 unsigned long flags;
468
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 }
478
479 return 0;
480 }
481
482 /*
483 * prepare urb for playback data pipe
484 *
485 * Since a URB can handle only a single linear buffer, we must use double
486 * buffering when the data to be transferred overflows the buffer boundary.
487 * To avoid inconsistencies when updating hwptr_done, we use double buffering
488 * for all URBs.
489 */
490 static int prepare_playback_urb(snd_usb_substream_t *subs,
491 snd_pcm_runtime_t *runtime,
492 struct urb *urb)
493 {
494 int i, stride, offs;
495 unsigned int counts;
496 unsigned long flags;
497 int period_elapsed = 0;
498 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
499
500 stride = runtime->frame_bits >> 3;
501
502 offs = 0;
503 urb->dev = ctx->subs->dev; /* we need to set this at each time */
504 urb->number_of_packets = 0;
505 spin_lock_irqsave(&subs->lock, flags);
506 for (i = 0; i < ctx->packets; i++) {
507 /* calculate the size of a packet */
508 if (subs->fill_max)
509 counts = subs->maxframesize; /* fixed */
510 else {
511 subs->phase = (subs->phase & 0xffff)
512 + (subs->freqm << subs->datainterval);
513 counts = subs->phase >> 16;
514 if (counts > subs->maxframesize)
515 counts = subs->maxframesize;
516 }
517 /* set up descriptor */
518 urb->iso_frame_desc[i].offset = offs * stride;
519 urb->iso_frame_desc[i].length = counts * stride;
520 offs += counts;
521 urb->number_of_packets++;
522 subs->transfer_done += counts;
523 if (subs->transfer_done >= runtime->period_size) {
524 subs->transfer_done -= runtime->period_size;
525 period_elapsed = 1;
526 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
527 if (subs->transfer_done > 0) {
528 /* FIXME: fill-max mode is not
529 * supported yet */
530 offs -= subs->transfer_done;
531 counts -= subs->transfer_done;
532 urb->iso_frame_desc[i].length =
533 counts * stride;
534 subs->transfer_done = 0;
535 }
536 i++;
537 if (i < ctx->packets) {
538 /* add a transfer delimiter */
539 urb->iso_frame_desc[i].offset =
540 offs * stride;
541 urb->iso_frame_desc[i].length = 0;
542 urb->number_of_packets++;
543 }
544 break;
545 }
546 }
547 /* finish at the frame boundary at/after the period boundary */
548 if (period_elapsed &&
549 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
550 break;
551 }
552 if (subs->hwptr_done + offs > runtime->buffer_size) {
553 /* err, the transferred area goes over buffer boundary. */
554 unsigned int len = runtime->buffer_size - subs->hwptr_done;
555 memcpy(urb->transfer_buffer,
556 runtime->dma_area + subs->hwptr_done * stride,
557 len * stride);
558 memcpy(urb->transfer_buffer + len * stride,
559 runtime->dma_area,
560 (offs - len) * stride);
561 } else {
562 memcpy(urb->transfer_buffer,
563 runtime->dma_area + subs->hwptr_done * stride,
564 offs * stride);
565 }
566 subs->hwptr_done += offs;
567 if (subs->hwptr_done >= runtime->buffer_size)
568 subs->hwptr_done -= runtime->buffer_size;
569 spin_unlock_irqrestore(&subs->lock, flags);
570 urb->transfer_buffer_length = offs * stride;
571 if (period_elapsed) {
572 if (likely(subs->running))
573 snd_pcm_period_elapsed(subs->pcm_substream);
574 else
575 tasklet_hi_schedule(&subs->start_period_elapsed);
576 }
577 return 0;
578 }
579
580 /*
581 * process after playback data complete
582 * - nothing to do
583 */
584 static int retire_playback_urb(snd_usb_substream_t *subs,
585 snd_pcm_runtime_t *runtime,
586 struct urb *urb)
587 {
588 return 0;
589 }
590
591 /*
592 * Delay the snd_pcm_period_elapsed() call until after the start trigger
593 * callback so that we're not longer in the substream's lock.
594 */
595 static void start_period_elapsed(unsigned long data)
596 {
597 snd_usb_substream_t *subs = (snd_usb_substream_t *)data;
598 snd_pcm_period_elapsed(subs->pcm_substream);
599 }
600
601
602 /*
603 */
604 static struct snd_urb_ops audio_urb_ops[2] = {
605 {
606 .prepare = prepare_playback_urb,
607 .retire = retire_playback_urb,
608 .prepare_sync = prepare_playback_sync_urb,
609 .retire_sync = retire_playback_sync_urb,
610 },
611 {
612 .prepare = prepare_capture_urb,
613 .retire = retire_capture_urb,
614 .prepare_sync = prepare_capture_sync_urb,
615 .retire_sync = retire_capture_sync_urb,
616 },
617 };
618
619 static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
620 {
621 .prepare = prepare_playback_urb,
622 .retire = retire_playback_urb,
623 .prepare_sync = prepare_playback_sync_urb_hs,
624 .retire_sync = retire_playback_sync_urb_hs,
625 },
626 {
627 .prepare = prepare_capture_urb,
628 .retire = retire_capture_urb,
629 .prepare_sync = prepare_capture_sync_urb_hs,
630 .retire_sync = retire_capture_sync_urb,
631 },
632 };
633
634 /*
635 * complete callback from data urb
636 */
637 static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
638 {
639 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
640 snd_usb_substream_t *subs = ctx->subs;
641 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
642 int err = 0;
643
644 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
645 ! subs->running || /* can be stopped during retire callback */
646 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
647 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
648 clear_bit(ctx->index, &subs->active_mask);
649 if (err < 0) {
650 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
651 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
652 }
653 }
654 }
655
656
657 /*
658 * complete callback from sync urb
659 */
660 static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
661 {
662 snd_urb_ctx_t *ctx = (snd_urb_ctx_t *)urb->context;
663 snd_usb_substream_t *subs = ctx->subs;
664 snd_pcm_substream_t *substream = ctx->subs->pcm_substream;
665 int err = 0;
666
667 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
668 ! subs->running || /* can be stopped during retire callback */
669 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
670 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
671 clear_bit(ctx->index + 16, &subs->active_mask);
672 if (err < 0) {
673 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
674 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
675 }
676 }
677 }
678
679
680 /* get the physical page pointer at the given offset */
681 static struct page *snd_pcm_get_vmalloc_page(snd_pcm_substream_t *subs,
682 unsigned long offset)
683 {
684 void *pageptr = subs->runtime->dma_area + offset;
685 return vmalloc_to_page(pageptr);
686 }
687
688 /* allocate virtual buffer; may be called more than once */
689 static int snd_pcm_alloc_vmalloc_buffer(snd_pcm_substream_t *subs, size_t size)
690 {
691 snd_pcm_runtime_t *runtime = subs->runtime;
692 if (runtime->dma_area) {
693 if (runtime->dma_bytes >= size)
694 return 0; /* already large enough */
695 vfree_nocheck(runtime->dma_area);
696 }
697 runtime->dma_area = vmalloc_nocheck(size);
698 if (! runtime->dma_area)
699 return -ENOMEM;
700 runtime->dma_bytes = size;
701 return 0;
702 }
703
704 /* free virtual buffer; may be called more than once */
705 static int snd_pcm_free_vmalloc_buffer(snd_pcm_substream_t *subs)
706 {
707 snd_pcm_runtime_t *runtime = subs->runtime;
708 if (runtime->dma_area) {
709 vfree_nocheck(runtime->dma_area);
710 runtime->dma_area = NULL;
711 }
712 return 0;
713 }
714
715
716 /*
717 * unlink active urbs.
718 */
719 static int deactivate_urbs(snd_usb_substream_t *subs, int force, int can_sleep)
720 {
721 unsigned int i;
722 int async;
723
724 subs->running = 0;
725
726 if (!force && subs->stream->chip->shutdown) /* to be sure... */
727 return -EBADFD;
728
729 async = !can_sleep && async_unlink;
730
731 if (! async && in_interrupt())
732 return 0;
733
734 for (i = 0; i < subs->nurbs; i++) {
735 if (test_bit(i, &subs->active_mask)) {
736 if (! test_and_set_bit(i, &subs->unlink_mask)) {
737 struct urb *u = subs->dataurb[i].urb;
738 if (async)
739 usb_unlink_urb(u);
740 else
741 usb_kill_urb(u);
742 }
743 }
744 }
745 if (subs->syncpipe) {
746 for (i = 0; i < SYNC_URBS; i++) {
747 if (test_bit(i+16, &subs->active_mask)) {
748 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
749 struct urb *u = subs->syncurb[i].urb;
750 if (async)
751 usb_unlink_urb(u);
752 else
753 usb_kill_urb(u);
754 }
755 }
756 }
757 }
758 return 0;
759 }
760
761
762 /*
763 * set up and start data/sync urbs
764 */
765 static int start_urbs(snd_usb_substream_t *subs, snd_pcm_runtime_t *runtime)
766 {
767 unsigned int i;
768 int err;
769
770 if (subs->stream->chip->shutdown)
771 return -EBADFD;
772
773 for (i = 0; i < subs->nurbs; i++) {
774 snd_assert(subs->dataurb[i].urb, return -EINVAL);
775 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
776 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
777 goto __error;
778 }
779 }
780 if (subs->syncpipe) {
781 for (i = 0; i < SYNC_URBS; i++) {
782 snd_assert(subs->syncurb[i].urb, return -EINVAL);
783 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
784 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
785 goto __error;
786 }
787 }
788 }
789
790 subs->active_mask = 0;
791 subs->unlink_mask = 0;
792 subs->running = 1;
793 for (i = 0; i < subs->nurbs; i++) {
794 if ((err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC)) < 0) {
795 snd_printk(KERN_ERR "cannot submit datapipe for urb %d, err = %d\n", i, err);
796 goto __error;
797 }
798 set_bit(i, &subs->active_mask);
799 }
800 if (subs->syncpipe) {
801 for (i = 0; i < SYNC_URBS; i++) {
802 if ((err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC)) < 0) {
803 snd_printk(KERN_ERR "cannot submit syncpipe for urb %d, err = %d\n", i, err);
804 goto __error;
805 }
806 set_bit(i + 16, &subs->active_mask);
807 }
808 }
809 return 0;
810
811 __error:
812 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
813 deactivate_urbs(subs, 0, 0);
814 return -EPIPE;
815 }
816
817
818 /*
819 * wait until all urbs are processed.
820 */
821 static int wait_clear_urbs(snd_usb_substream_t *subs)
822 {
823 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
824 unsigned int i;
825 int alive;
826
827 do {
828 alive = 0;
829 for (i = 0; i < subs->nurbs; i++) {
830 if (test_bit(i, &subs->active_mask))
831 alive++;
832 }
833 if (subs->syncpipe) {
834 for (i = 0; i < SYNC_URBS; i++) {
835 if (test_bit(i + 16, &subs->active_mask))
836 alive++;
837 }
838 }
839 if (! alive)
840 break;
841 set_current_state(TASK_UNINTERRUPTIBLE);
842 schedule_timeout(1);
843 } while (time_before(jiffies, end_time));
844 if (alive)
845 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
846 return 0;
847 }
848
849
850 /*
851 * return the current pcm pointer. just return the hwptr_done value.
852 */
853 static snd_pcm_uframes_t snd_usb_pcm_pointer(snd_pcm_substream_t *substream)
854 {
855 snd_usb_substream_t *subs;
856 snd_pcm_uframes_t hwptr_done;
857
858 subs = (snd_usb_substream_t *)substream->runtime->private_data;
859 spin_lock(&subs->lock);
860 hwptr_done = subs->hwptr_done;
861 spin_unlock(&subs->lock);
862 return hwptr_done;
863 }
864
865
866 /*
867 * start/stop substream
868 */
869 static int snd_usb_pcm_trigger(snd_pcm_substream_t *substream, int cmd)
870 {
871 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
872 int err;
873
874 switch (cmd) {
875 case SNDRV_PCM_TRIGGER_START:
876 err = start_urbs(subs, substream->runtime);
877 break;
878 case SNDRV_PCM_TRIGGER_STOP:
879 err = deactivate_urbs(subs, 0, 0);
880 break;
881 default:
882 err = -EINVAL;
883 break;
884 }
885 return err < 0 ? err : 0;
886 }
887
888
889 /*
890 * release a urb data
891 */
892 static void release_urb_ctx(snd_urb_ctx_t *u)
893 {
894 if (u->urb) {
895 if (u->buffer_size)
896 usb_buffer_free(u->subs->dev, u->buffer_size,
897 u->urb->transfer_buffer,
898 u->urb->transfer_dma);
899 usb_free_urb(u->urb);
900 u->urb = NULL;
901 }
902 }
903
904 /*
905 * release a substream
906 */
907 static void release_substream_urbs(snd_usb_substream_t *subs, int force)
908 {
909 int i;
910
911 /* stop urbs (to be sure) */
912 deactivate_urbs(subs, force, 1);
913 wait_clear_urbs(subs);
914
915 for (i = 0; i < MAX_URBS; i++)
916 release_urb_ctx(&subs->dataurb[i]);
917 for (i = 0; i < SYNC_URBS; i++)
918 release_urb_ctx(&subs->syncurb[i]);
919 usb_buffer_free(subs->dev, SYNC_URBS * 4,
920 subs->syncbuf, subs->sync_dma);
921 subs->syncbuf = NULL;
922 subs->nurbs = 0;
923 }
924
925 /*
926 * initialize a substream for plaback/capture
927 */
928 static int init_substream_urbs(snd_usb_substream_t *subs, unsigned int period_bytes,
929 unsigned int rate, unsigned int frame_bits)
930 {
931 unsigned int maxsize, n, i;
932 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
933 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
934
935 /* calculate the frequency in 16.16 format */
936 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
937 subs->freqn = get_usb_full_speed_rate(rate);
938 else
939 subs->freqn = get_usb_high_speed_rate(rate);
940 subs->freqm = subs->freqn;
941 /* calculate max. frequency */
942 if (subs->maxpacksize) {
943 /* whatever fits into a max. size packet */
944 maxsize = subs->maxpacksize;
945 subs->freqmax = (maxsize / (frame_bits >> 3))
946 << (16 - subs->datainterval);
947 } else {
948 /* no max. packet size: just take 25% higher than nominal */
949 subs->freqmax = subs->freqn + (subs->freqn >> 2);
950 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
951 >> (16 - subs->datainterval);
952 }
953 subs->phase = 0;
954
955 if (subs->fill_max)
956 subs->curpacksize = subs->maxpacksize;
957 else
958 subs->curpacksize = maxsize;
959
960 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
961 packs_per_ms = 8 >> subs->datainterval;
962 else
963 packs_per_ms = 1;
964 subs->packs_per_ms = packs_per_ms;
965
966 if (is_playback) {
967 urb_packs = nrpacks;
968 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
969 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
970 } else
971 urb_packs = 1;
972 urb_packs *= packs_per_ms;
973
974 /* decide how many packets to be used */
975 if (is_playback) {
976 unsigned int minsize;
977 /* determine how small a packet can be */
978 minsize = (subs->freqn >> (16 - subs->datainterval))
979 * (frame_bits >> 3);
980 /* with sync from device, assume it can be 12% lower */
981 if (subs->syncpipe)
982 minsize -= minsize >> 3;
983 minsize = max(minsize, 1u);
984 total_packs = (period_bytes + minsize - 1) / minsize;
985 /* round up to multiple of packs_per_ms */
986 total_packs = (total_packs + packs_per_ms - 1)
987 & ~(packs_per_ms - 1);
988 /* we need at least two URBs for queueing */
989 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
990 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
991 } else {
992 total_packs = MAX_URBS * urb_packs;
993 }
994 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
995 if (subs->nurbs > MAX_URBS) {
996 /* too much... */
997 subs->nurbs = MAX_URBS;
998 total_packs = MAX_URBS * urb_packs;
999 }
1000 n = total_packs;
1001 for (i = 0; i < subs->nurbs; i++) {
1002 npacks[i] = n > urb_packs ? urb_packs : n;
1003 n -= urb_packs;
1004 }
1005 if (subs->nurbs <= 1) {
1006 /* too little - we need at least two packets
1007 * to ensure contiguous playback/capture
1008 */
1009 subs->nurbs = 2;
1010 npacks[0] = (total_packs + 1) / 2;
1011 npacks[1] = total_packs - npacks[0];
1012 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1013 /* the last packet is too small.. */
1014 if (subs->nurbs > 2) {
1015 /* merge to the first one */
1016 npacks[0] += npacks[subs->nurbs - 1];
1017 subs->nurbs--;
1018 } else {
1019 /* divide to two */
1020 subs->nurbs = 2;
1021 npacks[0] = (total_packs + 1) / 2;
1022 npacks[1] = total_packs - npacks[0];
1023 }
1024 }
1025
1026 /* allocate and initialize data urbs */
1027 for (i = 0; i < subs->nurbs; i++) {
1028 snd_urb_ctx_t *u = &subs->dataurb[i];
1029 u->index = i;
1030 u->subs = subs;
1031 u->packets = npacks[i];
1032 u->buffer_size = maxsize * u->packets;
1033 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1034 u->packets++; /* for transfer delimiter */
1035 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1036 if (! u->urb)
1037 goto out_of_memory;
1038 u->urb->transfer_buffer =
1039 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1040 &u->urb->transfer_dma);
1041 if (! u->urb->transfer_buffer)
1042 goto out_of_memory;
1043 u->urb->pipe = subs->datapipe;
1044 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1045 u->urb->interval = 1 << subs->datainterval;
1046 u->urb->context = u;
1047 u->urb->complete = snd_usb_complete_callback(snd_complete_urb);
1048 }
1049
1050 if (subs->syncpipe) {
1051 /* allocate and initialize sync urbs */
1052 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1053 GFP_KERNEL, &subs->sync_dma);
1054 if (! subs->syncbuf)
1055 goto out_of_memory;
1056 for (i = 0; i < SYNC_URBS; i++) {
1057 snd_urb_ctx_t *u = &subs->syncurb[i];
1058 u->index = i;
1059 u->subs = subs;
1060 u->packets = 1;
1061 u->urb = usb_alloc_urb(1, GFP_KERNEL);
1062 if (! u->urb)
1063 goto out_of_memory;
1064 u->urb->transfer_buffer = subs->syncbuf + i * 4;
1065 u->urb->transfer_dma = subs->sync_dma + i * 4;
1066 u->urb->transfer_buffer_length = 4;
1067 u->urb->pipe = subs->syncpipe;
1068 u->urb->transfer_flags = URB_ISO_ASAP |
1069 URB_NO_TRANSFER_DMA_MAP;
1070 u->urb->number_of_packets = 1;
1071 u->urb->interval = 1 << subs->syncinterval;
1072 u->urb->context = u;
1073 u->urb->complete = snd_usb_complete_callback(snd_complete_sync_urb);
1074 }
1075 }
1076 return 0;
1077
1078 out_of_memory:
1079 release_substream_urbs(subs, 0);
1080 return -ENOMEM;
1081 }
1082
1083
1084 /*
1085 * find a matching audio format
1086 */
1087 static struct audioformat *find_format(snd_usb_substream_t *subs, unsigned int format,
1088 unsigned int rate, unsigned int channels)
1089 {
1090 struct list_head *p;
1091 struct audioformat *found = NULL;
1092 int cur_attr = 0, attr;
1093
1094 list_for_each(p, &subs->fmt_list) {
1095 struct audioformat *fp;
1096 fp = list_entry(p, struct audioformat, list);
1097 if (fp->format != format || fp->channels != channels)
1098 continue;
1099 if (rate < fp->rate_min || rate > fp->rate_max)
1100 continue;
1101 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1102 unsigned int i;
1103 for (i = 0; i < fp->nr_rates; i++)
1104 if (fp->rate_table[i] == rate)
1105 break;
1106 if (i >= fp->nr_rates)
1107 continue;
1108 }
1109 attr = fp->ep_attr & EP_ATTR_MASK;
1110 if (! found) {
1111 found = fp;
1112 cur_attr = attr;
1113 continue;
1114 }
1115 /* avoid async out and adaptive in if the other method
1116 * supports the same format.
1117 * this is a workaround for the case like
1118 * M-audio audiophile USB.
1119 */
1120 if (attr != cur_attr) {
1121 if ((attr == EP_ATTR_ASYNC &&
1122 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1123 (attr == EP_ATTR_ADAPTIVE &&
1124 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1125 continue;
1126 if ((cur_attr == EP_ATTR_ASYNC &&
1127 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1128 (cur_attr == EP_ATTR_ADAPTIVE &&
1129 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1130 found = fp;
1131 cur_attr = attr;
1132 continue;
1133 }
1134 }
1135 /* find the format with the largest max. packet size */
1136 if (fp->maxpacksize > found->maxpacksize) {
1137 found = fp;
1138 cur_attr = attr;
1139 }
1140 }
1141 return found;
1142 }
1143
1144
1145 /*
1146 * initialize the picth control and sample rate
1147 */
1148 static int init_usb_pitch(struct usb_device *dev, int iface,
1149 struct usb_host_interface *alts,
1150 struct audioformat *fmt)
1151 {
1152 unsigned int ep;
1153 unsigned char data[1];
1154 int err;
1155
1156 ep = get_endpoint(alts, 0)->bEndpointAddress;
1157 /* if endpoint has pitch control, enable it */
1158 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1159 data[0] = 1;
1160 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1161 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1162 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1163 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1164 dev->devnum, iface, ep);
1165 return err;
1166 }
1167 }
1168 return 0;
1169 }
1170
1171 static int init_usb_sample_rate(struct usb_device *dev, int iface,
1172 struct usb_host_interface *alts,
1173 struct audioformat *fmt, int rate)
1174 {
1175 unsigned int ep;
1176 unsigned char data[3];
1177 int err;
1178
1179 ep = get_endpoint(alts, 0)->bEndpointAddress;
1180 /* if endpoint has sampling rate control, set it */
1181 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1182 int crate;
1183 data[0] = rate;
1184 data[1] = rate >> 8;
1185 data[2] = rate >> 16;
1186 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1187 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1188 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1189 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1190 dev->devnum, iface, fmt->altsetting, rate, ep);
1191 return err;
1192 }
1193 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1194 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1195 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1196 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1197 dev->devnum, iface, fmt->altsetting, ep);
1198 return 0; /* some devices don't support reading */
1199 }
1200 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1201 if (crate != rate) {
1202 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1203 // runtime->rate = crate;
1204 }
1205 }
1206 return 0;
1207 }
1208
1209 /*
1210 * find a matching format and set up the interface
1211 */
1212 static int set_format(snd_usb_substream_t *subs, struct audioformat *fmt)
1213 {
1214 struct usb_device *dev = subs->dev;
1215 struct usb_host_interface *alts;
1216 struct usb_interface_descriptor *altsd;
1217 struct usb_interface *iface;
1218 unsigned int ep, attr;
1219 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1220 int err;
1221
1222 iface = usb_ifnum_to_if(dev, fmt->iface);
1223 snd_assert(iface, return -EINVAL);
1224 alts = &iface->altsetting[fmt->altset_idx];
1225 altsd = get_iface_desc(alts);
1226 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1227
1228 if (fmt == subs->cur_audiofmt)
1229 return 0;
1230
1231 /* close the old interface */
1232 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1233 usb_set_interface(subs->dev, subs->interface, 0);
1234 subs->interface = -1;
1235 subs->format = 0;
1236 }
1237
1238 /* set interface */
1239 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1240 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1241 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1242 dev->devnum, fmt->iface, fmt->altsetting);
1243 return -EIO;
1244 }
1245 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1246 subs->interface = fmt->iface;
1247 subs->format = fmt->altset_idx;
1248 }
1249
1250 /* create a data pipe */
1251 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1252 if (is_playback)
1253 subs->datapipe = usb_sndisocpipe(dev, ep);
1254 else
1255 subs->datapipe = usb_rcvisocpipe(dev, ep);
1256 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1257 get_endpoint(alts, 0)->bInterval >= 1 &&
1258 get_endpoint(alts, 0)->bInterval <= 4)
1259 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1260 else
1261 subs->datainterval = 0;
1262 subs->syncpipe = subs->syncinterval = 0;
1263 subs->maxpacksize = fmt->maxpacksize;
1264 subs->fill_max = 0;
1265
1266 /* we need a sync pipe in async OUT or adaptive IN mode */
1267 /* check the number of EP, since some devices have broken
1268 * descriptors which fool us. if it has only one EP,
1269 * assume it as adaptive-out or sync-in.
1270 */
1271 attr = fmt->ep_attr & EP_ATTR_MASK;
1272 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1273 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1274 altsd->bNumEndpoints >= 2) {
1275 /* check sync-pipe endpoint */
1276 /* ... and check descriptor size before accessing bSynchAddress
1277 because there is a version of the SB Audigy 2 NX firmware lacking
1278 the audio fields in the endpoint descriptors */
1279 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1280 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1281 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1282 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1283 dev->devnum, fmt->iface, fmt->altsetting);
1284 return -EINVAL;
1285 }
1286 ep = get_endpoint(alts, 1)->bEndpointAddress;
1287 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1288 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1289 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1290 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1291 dev->devnum, fmt->iface, fmt->altsetting);
1292 return -EINVAL;
1293 }
1294 ep &= USB_ENDPOINT_NUMBER_MASK;
1295 if (is_playback)
1296 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1297 else
1298 subs->syncpipe = usb_sndisocpipe(dev, ep);
1299 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1300 get_endpoint(alts, 1)->bRefresh >= 1 &&
1301 get_endpoint(alts, 1)->bRefresh <= 9)
1302 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1303 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1304 subs->syncinterval = 1;
1305 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1306 get_endpoint(alts, 1)->bInterval <= 16)
1307 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1308 else
1309 subs->syncinterval = 3;
1310 }
1311
1312 /* always fill max packet size */
1313 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1314 subs->fill_max = 1;
1315
1316 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1317 return err;
1318
1319 subs->cur_audiofmt = fmt;
1320
1321 #if 0
1322 printk("setting done: format = %d, rate = %d, channels = %d\n",
1323 fmt->format, fmt->rate, fmt->channels);
1324 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1325 subs->datapipe, subs->syncpipe);
1326 #endif
1327
1328 return 0;
1329 }
1330
1331 /*
1332 * hw_params callback
1333 *
1334 * allocate a buffer and set the given audio format.
1335 *
1336 * so far we use a physically linear buffer although packetize transfer
1337 * doesn't need a continuous area.
1338 * if sg buffer is supported on the later version of alsa, we'll follow
1339 * that.
1340 */
1341 static int snd_usb_hw_params(snd_pcm_substream_t *substream,
1342 snd_pcm_hw_params_t *hw_params)
1343 {
1344 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1345 struct audioformat *fmt;
1346 unsigned int channels, rate, format;
1347 int ret, changed;
1348
1349 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1350 params_buffer_bytes(hw_params));
1351 if (ret < 0)
1352 return ret;
1353
1354 format = params_format(hw_params);
1355 rate = params_rate(hw_params);
1356 channels = params_channels(hw_params);
1357 fmt = find_format(subs, format, rate, channels);
1358 if (! fmt) {
1359 snd_printd(KERN_DEBUG "cannot set format: format = %s, rate = %d, channels = %d\n",
1360 snd_pcm_format_name(format), rate, channels);
1361 return -EINVAL;
1362 }
1363
1364 changed = subs->cur_audiofmt != fmt ||
1365 subs->period_bytes != params_period_bytes(hw_params) ||
1366 subs->cur_rate != rate;
1367 if ((ret = set_format(subs, fmt)) < 0)
1368 return ret;
1369
1370 if (subs->cur_rate != rate) {
1371 struct usb_host_interface *alts;
1372 struct usb_interface *iface;
1373 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1374 alts = &iface->altsetting[fmt->altset_idx];
1375 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1376 if (ret < 0)
1377 return ret;
1378 subs->cur_rate = rate;
1379 }
1380
1381 if (changed) {
1382 /* format changed */
1383 release_substream_urbs(subs, 0);
1384 /* influenced: period_bytes, channels, rate, format, */
1385 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1386 params_rate(hw_params),
1387 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1388 }
1389
1390 return ret;
1391 }
1392
1393 /*
1394 * hw_free callback
1395 *
1396 * reset the audio format and release the buffer
1397 */
1398 static int snd_usb_hw_free(snd_pcm_substream_t *substream)
1399 {
1400 snd_usb_substream_t *subs = (snd_usb_substream_t *)substream->runtime->private_data;
1401
1402 subs->cur_audiofmt = NULL;
1403 subs->cur_rate = 0;
1404 subs->period_bytes = 0;
1405 release_substream_urbs(subs, 0);
1406 return snd_pcm_free_vmalloc_buffer(substream);
1407 }
1408
1409 /*
1410 * prepare callback
1411 *
1412 * only a few subtle things...
1413 */
1414 static int snd_usb_pcm_prepare(snd_pcm_substream_t *substream)
1415 {
1416 snd_pcm_runtime_t *runtime = substream->runtime;
1417 snd_usb_substream_t *subs = (snd_usb_substream_t *)runtime->private_data;
1418
1419 if (! subs->cur_audiofmt) {
1420 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1421 return -ENXIO;
1422 }
1423
1424 /* some unit conversions in runtime */
1425 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1426 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1427
1428 /* reset the pointer */
1429 subs->hwptr_done = 0;
1430 subs->transfer_done = 0;
1431 subs->phase = 0;
1432
1433 /* clear urbs (to be sure) */
1434 deactivate_urbs(subs, 0, 1);
1435 wait_clear_urbs(subs);
1436
1437 return 0;
1438 }
1439
1440 static snd_pcm_hardware_t snd_usb_playback =
1441 {
1442 .info = SNDRV_PCM_INFO_MMAP |
1443 SNDRV_PCM_INFO_MMAP_VALID |
1444 SNDRV_PCM_INFO_BATCH |
1445 SNDRV_PCM_INFO_INTERLEAVED |
1446 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1447 .buffer_bytes_max = 1024 * 1024,
1448 .period_bytes_min = 64,
1449 .period_bytes_max = 512 * 1024,
1450 .periods_min = 2,
1451 .periods_max = 1024,
1452 };
1453
1454 static snd_pcm_hardware_t snd_usb_capture =
1455 {
1456 .info = SNDRV_PCM_INFO_MMAP |
1457 SNDRV_PCM_INFO_MMAP_VALID |
1458 SNDRV_PCM_INFO_BATCH |
1459 SNDRV_PCM_INFO_INTERLEAVED |
1460 SNDRV_PCM_INFO_BLOCK_TRANSFER,
1461 .buffer_bytes_max = 1024 * 1024,
1462 .period_bytes_min = 64,
1463 .period_bytes_max = 512 * 1024,
1464 .periods_min = 2,
1465 .periods_max = 1024,
1466 };
1467
1468 /*
1469 * h/w constraints
1470 */
1471
1472 #ifdef HW_CONST_DEBUG
1473 #define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1474 #else
1475 #define hwc_debug(fmt, args...) /**/
1476 #endif
1477
1478 static int hw_check_valid_format(snd_pcm_hw_params_t *params, struct audioformat *fp)
1479 {
1480 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1481 snd_interval_t *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1482 snd_mask_t *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1483
1484 /* check the format */
1485 if (! snd_mask_test(fmts, fp->format)) {
1486 hwc_debug(" > check: no supported format %d\n", fp->format);
1487 return 0;
1488 }
1489 /* check the channels */
1490 if (fp->channels < ct->min || fp->channels > ct->max) {
1491 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1492 return 0;
1493 }
1494 /* check the rate is within the range */
1495 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1496 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1497 return 0;
1498 }
1499 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1500 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1501 return 0;
1502 }
1503 return 1;
1504 }
1505
1506 static int hw_rule_rate(snd_pcm_hw_params_t *params,
1507 snd_pcm_hw_rule_t *rule)
1508 {
1509 snd_usb_substream_t *subs = rule->private;
1510 struct list_head *p;
1511 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1512 unsigned int rmin, rmax;
1513 int changed;
1514
1515 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1516 changed = 0;
1517 rmin = rmax = 0;
1518 list_for_each(p, &subs->fmt_list) {
1519 struct audioformat *fp;
1520 fp = list_entry(p, struct audioformat, list);
1521 if (! hw_check_valid_format(params, fp))
1522 continue;
1523 if (changed++) {
1524 if (rmin > fp->rate_min)
1525 rmin = fp->rate_min;
1526 if (rmax < fp->rate_max)
1527 rmax = fp->rate_max;
1528 } else {
1529 rmin = fp->rate_min;
1530 rmax = fp->rate_max;
1531 }
1532 }
1533
1534 if (! changed) {
1535 hwc_debug(" --> get empty\n");
1536 it->empty = 1;
1537 return -EINVAL;
1538 }
1539
1540 changed = 0;
1541 if (it->min < rmin) {
1542 it->min = rmin;
1543 it->openmin = 0;
1544 changed = 1;
1545 }
1546 if (it->max > rmax) {
1547 it->max = rmax;
1548 it->openmax = 0;
1549 changed = 1;
1550 }
1551 if (snd_interval_checkempty(it)) {
1552 it->empty = 1;
1553 return -EINVAL;
1554 }
1555 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1556 return changed;
1557 }
1558
1559
1560 static int hw_rule_channels(snd_pcm_hw_params_t *params,
1561 snd_pcm_hw_rule_t *rule)
1562 {
1563 snd_usb_substream_t *subs = rule->private;
1564 struct list_head *p;
1565 snd_interval_t *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1566 unsigned int rmin, rmax;
1567 int changed;
1568
1569 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1570 changed = 0;
1571 rmin = rmax = 0;
1572 list_for_each(p, &subs->fmt_list) {
1573 struct audioformat *fp;
1574 fp = list_entry(p, struct audioformat, list);
1575 if (! hw_check_valid_format(params, fp))
1576 continue;
1577 if (changed++) {
1578 if (rmin > fp->channels)
1579 rmin = fp->channels;
1580 if (rmax < fp->channels)
1581 rmax = fp->channels;
1582 } else {
1583 rmin = fp->channels;
1584 rmax = fp->channels;
1585 }
1586 }
1587
1588 if (! changed) {
1589 hwc_debug(" --> get empty\n");
1590 it->empty = 1;
1591 return -EINVAL;
1592 }
1593
1594 changed = 0;
1595 if (it->min < rmin) {
1596 it->min = rmin;
1597 it->openmin = 0;
1598 changed = 1;
1599 }
1600 if (it->max > rmax) {
1601 it->max = rmax;
1602 it->openmax = 0;
1603 changed = 1;
1604 }
1605 if (snd_interval_checkempty(it)) {
1606 it->empty = 1;
1607 return -EINVAL;
1608 }
1609 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1610 return changed;
1611 }
1612
1613 static int hw_rule_format(snd_pcm_hw_params_t *params,
1614 snd_pcm_hw_rule_t *rule)
1615 {
1616 snd_usb_substream_t *subs = rule->private;
1617 struct list_head *p;
1618 snd_mask_t *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1619 u64 fbits;
1620 u32 oldbits[2];
1621 int changed;
1622
1623 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1624 fbits = 0;
1625 list_for_each(p, &subs->fmt_list) {
1626 struct audioformat *fp;
1627 fp = list_entry(p, struct audioformat, list);
1628 if (! hw_check_valid_format(params, fp))
1629 continue;
1630 fbits |= (1ULL << fp->format);
1631 }
1632
1633 oldbits[0] = fmt->bits[0];
1634 oldbits[1] = fmt->bits[1];
1635 fmt->bits[0] &= (u32)fbits;
1636 fmt->bits[1] &= (u32)(fbits >> 32);
1637 if (! fmt->bits[0] && ! fmt->bits[1]) {
1638 hwc_debug(" --> get empty\n");
1639 return -EINVAL;
1640 }
1641 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1642 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1643 return changed;
1644 }
1645
1646 #define MAX_MASK 64
1647
1648 /*
1649 * check whether the registered audio formats need special hw-constraints
1650 */
1651 static int check_hw_params_convention(snd_usb_substream_t *subs)
1652 {
1653 int i;
1654 u32 *channels;
1655 u32 *rates;
1656 u32 cmaster, rmaster;
1657 u32 rate_min = 0, rate_max = 0;
1658 struct list_head *p;
1659 int err = 1;
1660
1661 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1662 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1663
1664 list_for_each(p, &subs->fmt_list) {
1665 struct audioformat *f;
1666 f = list_entry(p, struct audioformat, list);
1667 /* unconventional channels? */
1668 if (f->channels > 32)
1669 goto __out;
1670 /* continuous rate min/max matches? */
1671 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1672 if (rate_min && f->rate_min != rate_min)
1673 goto __out;
1674 if (rate_max && f->rate_max != rate_max)
1675 goto __out;
1676 rate_min = f->rate_min;
1677 rate_max = f->rate_max;
1678 }
1679 /* combination of continuous rates and fixed rates? */
1680 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1681 if (f->rates != rates[f->format])
1682 goto __out;
1683 }
1684 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1685 if (rates[f->format] && rates[f->format] != f->rates)
1686 goto __out;
1687 }
1688 channels[f->format] |= (1 << f->channels);
1689 rates[f->format] |= f->rates;
1690 }
1691 /* check whether channels and rates match for all formats */
1692 cmaster = rmaster = 0;
1693 for (i = 0; i < MAX_MASK; i++) {
1694 if (cmaster != channels[i] && cmaster && channels[i])
1695 goto __out;
1696 if (rmaster != rates[i] && rmaster && rates[i])
1697 goto __out;
1698 if (channels[i])
1699 cmaster = channels[i];
1700 if (rates[i])
1701 rmaster = rates[i];
1702 }
1703 /* check whether channels match for all distinct rates */
1704 memset(channels, 0, MAX_MASK * sizeof(u32));
1705 list_for_each(p, &subs->fmt_list) {
1706 struct audioformat *f;
1707 f = list_entry(p, struct audioformat, list);
1708 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1709 continue;
1710 for (i = 0; i < 32; i++) {
1711 if (f->rates & (1 << i))
1712 channels[i] |= (1 << f->channels);
1713 }
1714 }
1715 cmaster = 0;
1716 for (i = 0; i < 32; i++) {
1717 if (cmaster != channels[i] && cmaster && channels[i])
1718 goto __out;
1719 if (channels[i])
1720 cmaster = channels[i];
1721 }
1722 err = 0;
1723
1724 __out:
1725 kfree(channels);
1726 kfree(rates);
1727 return err;
1728 }
1729
1730
1731 /*
1732 * set up the runtime hardware information.
1733 */
1734
1735 static int setup_hw_info(snd_pcm_runtime_t *runtime, snd_usb_substream_t *subs)
1736 {
1737 struct list_head *p;
1738 int err;
1739
1740 runtime->hw.formats = subs->formats;
1741
1742 runtime->hw.rate_min = 0x7fffffff;
1743 runtime->hw.rate_max = 0;
1744 runtime->hw.channels_min = 256;
1745 runtime->hw.channels_max = 0;
1746 runtime->hw.rates = 0;
1747 /* check min/max rates and channels */
1748 list_for_each(p, &subs->fmt_list) {
1749 struct audioformat *fp;
1750 fp = list_entry(p, struct audioformat, list);
1751 runtime->hw.rates |= fp->rates;
1752 if (runtime->hw.rate_min > fp->rate_min)
1753 runtime->hw.rate_min = fp->rate_min;
1754 if (runtime->hw.rate_max < fp->rate_max)
1755 runtime->hw.rate_max = fp->rate_max;
1756 if (runtime->hw.channels_min > fp->channels)
1757 runtime->hw.channels_min = fp->channels;
1758 if (runtime->hw.channels_max < fp->channels)
1759 runtime->hw.channels_max = fp->channels;
1760 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1761 /* FIXME: there might be more than one audio formats... */
1762 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1763 fp->frame_size;
1764 }
1765 }
1766
1767 /* set the period time minimum 1ms */
1768 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1769 1000 * MIN_PACKS_URB,
1770 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1771
1772 if (check_hw_params_convention(subs)) {
1773 hwc_debug("setting extra hw constraints...\n");
1774 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1775 hw_rule_rate, subs,
1776 SNDRV_PCM_HW_PARAM_FORMAT,
1777 SNDRV_PCM_HW_PARAM_CHANNELS,
1778 -1)) < 0)
1779 return err;
1780 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1781 hw_rule_channels, subs,
1782 SNDRV_PCM_HW_PARAM_FORMAT,
1783 SNDRV_PCM_HW_PARAM_RATE,
1784 -1)) < 0)
1785 return err;
1786 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1787 hw_rule_format, subs,
1788 SNDRV_PCM_HW_PARAM_RATE,
1789 SNDRV_PCM_HW_PARAM_CHANNELS,
1790 -1)) < 0)
1791 return err;
1792 }
1793 return 0;
1794 }
1795
1796 static int snd_usb_pcm_open(snd_pcm_substream_t *substream, int direction,
1797 snd_pcm_hardware_t *hw)
1798 {
1799 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1800 snd_pcm_runtime_t *runtime = substream->runtime;
1801 snd_usb_substream_t *subs = &as->substream[direction];
1802
1803 subs->interface = -1;
1804 subs->format = 0;
1805 runtime->hw = *hw;
1806 runtime->private_data = subs;
1807 subs->pcm_substream = substream;
1808 return setup_hw_info(runtime, subs);
1809 }
1810
1811 static int snd_usb_pcm_close(snd_pcm_substream_t *substream, int direction)
1812 {
1813 snd_usb_stream_t *as = snd_pcm_substream_chip(substream);
1814 snd_usb_substream_t *subs = &as->substream[direction];
1815
1816 if (subs->interface >= 0) {
1817 usb_set_interface(subs->dev, subs->interface, 0);
1818 subs->interface = -1;
1819 }
1820 subs->pcm_substream = NULL;
1821 return 0;
1822 }
1823
1824 static int snd_usb_playback_open(snd_pcm_substream_t *substream)
1825 {
1826 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1827 }
1828
1829 static int snd_usb_playback_close(snd_pcm_substream_t *substream)
1830 {
1831 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1832 }
1833
1834 static int snd_usb_capture_open(snd_pcm_substream_t *substream)
1835 {
1836 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1837 }
1838
1839 static int snd_usb_capture_close(snd_pcm_substream_t *substream)
1840 {
1841 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1842 }
1843
1844 static snd_pcm_ops_t snd_usb_playback_ops = {
1845 .open = snd_usb_playback_open,
1846 .close = snd_usb_playback_close,
1847 .ioctl = snd_pcm_lib_ioctl,
1848 .hw_params = snd_usb_hw_params,
1849 .hw_free = snd_usb_hw_free,
1850 .prepare = snd_usb_pcm_prepare,
1851 .trigger = snd_usb_pcm_trigger,
1852 .pointer = snd_usb_pcm_pointer,
1853 .page = snd_pcm_get_vmalloc_page,
1854 };
1855
1856 static snd_pcm_ops_t snd_usb_capture_ops = {
1857 .open = snd_usb_capture_open,
1858 .close = snd_usb_capture_close,
1859 .ioctl = snd_pcm_lib_ioctl,
1860 .hw_params = snd_usb_hw_params,
1861 .hw_free = snd_usb_hw_free,
1862 .prepare = snd_usb_pcm_prepare,
1863 .trigger = snd_usb_pcm_trigger,
1864 .pointer = snd_usb_pcm_pointer,
1865 .page = snd_pcm_get_vmalloc_page,
1866 };
1867
1868
1869
1870 /*
1871 * helper functions
1872 */
1873
1874 /*
1875 * combine bytes and get an integer value
1876 */
1877 unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1878 {
1879 switch (size) {
1880 case 1: return *bytes;
1881 case 2: return combine_word(bytes);
1882 case 3: return combine_triple(bytes);
1883 case 4: return combine_quad(bytes);
1884 default: return 0;
1885 }
1886 }
1887
1888 /*
1889 * parse descriptor buffer and return the pointer starting the given
1890 * descriptor type.
1891 */
1892 void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1893 {
1894 u8 *p, *end, *next;
1895
1896 p = descstart;
1897 end = p + desclen;
1898 for (; p < end;) {
1899 if (p[0] < 2)
1900 return NULL;
1901 next = p + p[0];
1902 if (next > end)
1903 return NULL;
1904 if (p[1] == dtype && (!after || (void *)p > after)) {
1905 return p;
1906 }
1907 p = next;
1908 }
1909 return NULL;
1910 }
1911
1912 /*
1913 * find a class-specified interface descriptor with the given subtype.
1914 */
1915 void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1916 {
1917 unsigned char *p = after;
1918
1919 while ((p = snd_usb_find_desc(buffer, buflen, p,
1920 USB_DT_CS_INTERFACE)) != NULL) {
1921 if (p[0] >= 3 && p[2] == dsubtype)
1922 return p;
1923 }
1924 return NULL;
1925 }
1926
1927 /*
1928 * Wrapper for usb_control_msg().
1929 * Allocates a temp buffer to prevent dmaing from/to the stack.
1930 */
1931 int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
1932 __u8 requesttype, __u16 value, __u16 index, void *data,
1933 __u16 size, int timeout)
1934 {
1935 int err;
1936 void *buf = NULL;
1937
1938 if (size > 0) {
1939 buf = kmalloc(size, GFP_KERNEL);
1940 if (!buf)
1941 return -ENOMEM;
1942 memcpy(buf, data, size);
1943 }
1944 err = usb_control_msg(dev, pipe, request, requesttype,
1945 value, index, buf, size, timeout);
1946 if (size > 0) {
1947 memcpy(data, buf, size);
1948 kfree(buf);
1949 }
1950 return err;
1951 }
1952
1953
1954 /*
1955 * entry point for linux usb interface
1956 */
1957
1958 static int usb_audio_probe(struct usb_interface *intf,
1959 const struct usb_device_id *id);
1960 static void usb_audio_disconnect(struct usb_interface *intf);
1961
1962 static struct usb_device_id usb_audio_ids [] = {
1963 #include "usbquirks.h"
1964 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1965 .bInterfaceClass = USB_CLASS_AUDIO,
1966 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
1967 { } /* Terminating entry */
1968 };
1969
1970 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
1971
1972 static struct usb_driver usb_audio_driver = {
1973 .owner = THIS_MODULE,
1974 .name = "snd-usb-audio",
1975 .probe = usb_audio_probe,
1976 .disconnect = usb_audio_disconnect,
1977 .id_table = usb_audio_ids,
1978 };
1979
1980
1981 /*
1982 * proc interface for list the supported pcm formats
1983 */
1984 static void proc_dump_substream_formats(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
1985 {
1986 struct list_head *p;
1987 static char *sync_types[4] = {
1988 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
1989 };
1990
1991 list_for_each(p, &subs->fmt_list) {
1992 struct audioformat *fp;
1993 fp = list_entry(p, struct audioformat, list);
1994 snd_iprintf(buffer, " Interface %d\n", fp->iface);
1995 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
1996 snd_iprintf(buffer, " Format: %s\n", snd_pcm_format_name(fp->format));
1997 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
1998 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
1999 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2000 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2001 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2002 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2003 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2004 fp->rate_min, fp->rate_max);
2005 } else {
2006 unsigned int i;
2007 snd_iprintf(buffer, " Rates: ");
2008 for (i = 0; i < fp->nr_rates; i++) {
2009 if (i > 0)
2010 snd_iprintf(buffer, ", ");
2011 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2012 }
2013 snd_iprintf(buffer, "\n");
2014 }
2015 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2016 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2017 }
2018 }
2019
2020 static void proc_dump_substream_status(snd_usb_substream_t *subs, snd_info_buffer_t *buffer)
2021 {
2022 if (subs->running) {
2023 unsigned int i;
2024 snd_iprintf(buffer, " Status: Running\n");
2025 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2026 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2027 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2028 for (i = 0; i < subs->nurbs; i++)
2029 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2030 snd_iprintf(buffer, "]\n");
2031 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
2032 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
2033 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2034 ? get_full_speed_hz(subs->freqm)
2035 : get_high_speed_hz(subs->freqm),
2036 subs->freqm >> 16, subs->freqm & 0xffff);
2037 } else {
2038 snd_iprintf(buffer, " Status: Stop\n");
2039 }
2040 }
2041
2042 static void proc_pcm_format_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
2043 {
2044 snd_usb_stream_t *stream = entry->private_data;
2045
2046 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2047
2048 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2049 snd_iprintf(buffer, "\nPlayback:\n");
2050 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2051 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2052 }
2053 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2054 snd_iprintf(buffer, "\nCapture:\n");
2055 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2056 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2057 }
2058 }
2059
2060 static void proc_pcm_format_add(snd_usb_stream_t *stream)
2061 {
2062 snd_info_entry_t *entry;
2063 char name[32];
2064 snd_card_t *card = stream->chip->card;
2065
2066 sprintf(name, "stream%d", stream->pcm_index);
2067 if (! snd_card_proc_new(card, name, &entry))
2068 snd_info_set_text_ops(entry, stream, 1024, proc_pcm_format_read);
2069 }
2070
2071
2072 /*
2073 * initialize the substream instance.
2074 */
2075
2076 static void init_substream(snd_usb_stream_t *as, int stream, struct audioformat *fp)
2077 {
2078 snd_usb_substream_t *subs = &as->substream[stream];
2079
2080 INIT_LIST_HEAD(&subs->fmt_list);
2081 spin_lock_init(&subs->lock);
2082 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2083 tasklet_init(&subs->start_period_elapsed, start_period_elapsed,
2084 (unsigned long)subs);
2085
2086 subs->stream = as;
2087 subs->direction = stream;
2088 subs->dev = as->chip->dev;
2089 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2090 subs->ops = audio_urb_ops[stream];
2091 else
2092 subs->ops = audio_urb_ops_high_speed[stream];
2093 snd_pcm_set_ops(as->pcm, stream,
2094 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2095 &snd_usb_playback_ops : &snd_usb_capture_ops);
2096
2097 list_add_tail(&fp->list, &subs->fmt_list);
2098 subs->formats |= 1ULL << fp->format;
2099 subs->endpoint = fp->endpoint;
2100 subs->num_formats++;
2101 subs->fmt_type = fp->fmt_type;
2102 }
2103
2104
2105 /*
2106 * free a substream
2107 */
2108 static void free_substream(snd_usb_substream_t *subs)
2109 {
2110 struct list_head *p, *n;
2111
2112 if (! subs->num_formats)
2113 return; /* not initialized */
2114 list_for_each_safe(p, n, &subs->fmt_list) {
2115 struct audioformat *fp = list_entry(p, struct audioformat, list);
2116 kfree(fp->rate_table);
2117 kfree(fp);
2118 }
2119 }
2120
2121
2122 /*
2123 * free a usb stream instance
2124 */
2125 static void snd_usb_audio_stream_free(snd_usb_stream_t *stream)
2126 {
2127 free_substream(&stream->substream[0]);
2128 free_substream(&stream->substream[1]);
2129 list_del(&stream->list);
2130 kfree(stream);
2131 }
2132
2133 static void snd_usb_audio_pcm_free(snd_pcm_t *pcm)
2134 {
2135 snd_usb_stream_t *stream = pcm->private_data;
2136 if (stream) {
2137 stream->pcm = NULL;
2138 snd_usb_audio_stream_free(stream);
2139 }
2140 }
2141
2142
2143 /*
2144 * add this endpoint to the chip instance.
2145 * if a stream with the same endpoint already exists, append to it.
2146 * if not, create a new pcm stream.
2147 */
2148 static int add_audio_endpoint(snd_usb_audio_t *chip, int stream, struct audioformat *fp)
2149 {
2150 struct list_head *p;
2151 snd_usb_stream_t *as;
2152 snd_usb_substream_t *subs;
2153 snd_pcm_t *pcm;
2154 int err;
2155
2156 list_for_each(p, &chip->pcm_list) {
2157 as = list_entry(p, snd_usb_stream_t, list);
2158 if (as->fmt_type != fp->fmt_type)
2159 continue;
2160 subs = &as->substream[stream];
2161 if (! subs->endpoint)
2162 continue;
2163 if (subs->endpoint == fp->endpoint) {
2164 list_add_tail(&fp->list, &subs->fmt_list);
2165 subs->num_formats++;
2166 subs->formats |= 1ULL << fp->format;
2167 return 0;
2168 }
2169 }
2170 /* look for an empty stream */
2171 list_for_each(p, &chip->pcm_list) {
2172 as = list_entry(p, snd_usb_stream_t, list);
2173 if (as->fmt_type != fp->fmt_type)
2174 continue;
2175 subs = &as->substream[stream];
2176 if (subs->endpoint)
2177 continue;
2178 err = snd_pcm_new_stream(as->pcm, stream, 1);
2179 if (err < 0)
2180 return err;
2181 init_substream(as, stream, fp);
2182 return 0;
2183 }
2184
2185 /* create a new pcm */
2186 as = kmalloc(sizeof(*as), GFP_KERNEL);
2187 if (! as)
2188 return -ENOMEM;
2189 memset(as, 0, sizeof(*as));
2190 as->pcm_index = chip->pcm_devs;
2191 as->chip = chip;
2192 as->fmt_type = fp->fmt_type;
2193 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2194 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2195 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2196 &pcm);
2197 if (err < 0) {
2198 kfree(as);
2199 return err;
2200 }
2201 as->pcm = pcm;
2202 pcm->private_data = as;
2203 pcm->private_free = snd_usb_audio_pcm_free;
2204 pcm->info_flags = 0;
2205 if (chip->pcm_devs > 0)
2206 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2207 else
2208 strcpy(pcm->name, "USB Audio");
2209
2210 init_substream(as, stream, fp);
2211
2212 list_add(&as->list, &chip->pcm_list);
2213 chip->pcm_devs++;
2214
2215 proc_pcm_format_add(as);
2216
2217 return 0;
2218 }
2219
2220
2221 /*
2222 * check if the device uses big-endian samples
2223 */
2224 static int is_big_endian_format(snd_usb_audio_t *chip, struct audioformat *fp)
2225 {
2226 switch (chip->usb_id) {
2227 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2228 if (fp->endpoint & USB_DIR_IN)
2229 return 1;
2230 break;
2231 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2232 return 1;
2233 }
2234 return 0;
2235 }
2236
2237 /*
2238 * parse the audio format type I descriptor
2239 * and returns the corresponding pcm format
2240 *
2241 * @dev: usb device
2242 * @fp: audioformat record
2243 * @format: the format tag (wFormatTag)
2244 * @fmt: the format type descriptor
2245 */
2246 static int parse_audio_format_i_type(snd_usb_audio_t *chip, struct audioformat *fp,
2247 int format, unsigned char *fmt)
2248 {
2249 int pcm_format;
2250 int sample_width, sample_bytes;
2251
2252 /* FIXME: correct endianess and sign? */
2253 pcm_format = -1;
2254 sample_width = fmt[6];
2255 sample_bytes = fmt[5];
2256 switch (format) {
2257 case 0: /* some devices don't define this correctly... */
2258 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2259 chip->dev->devnum, fp->iface, fp->altsetting);
2260 /* fall-through */
2261 case USB_AUDIO_FORMAT_PCM:
2262 if (sample_width > sample_bytes * 8) {
2263 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2264 chip->dev->devnum, fp->iface, fp->altsetting,
2265 sample_width, sample_bytes);
2266 }
2267 /* check the format byte size */
2268 switch (fmt[5]) {
2269 case 1:
2270 pcm_format = SNDRV_PCM_FORMAT_S8;
2271 break;
2272 case 2:
2273 if (is_big_endian_format(chip, fp))
2274 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2275 else
2276 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2277 break;
2278 case 3:
2279 if (is_big_endian_format(chip, fp))
2280 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2281 else
2282 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2283 break;
2284 case 4:
2285 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2286 break;
2287 default:
2288 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2289 chip->dev->devnum, fp->iface,
2290 fp->altsetting, sample_width, sample_bytes);
2291 break;
2292 }
2293 break;
2294 case USB_AUDIO_FORMAT_PCM8:
2295 /* Dallas DS4201 workaround */
2296 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2297 pcm_format = SNDRV_PCM_FORMAT_S8;
2298 else
2299 pcm_format = SNDRV_PCM_FORMAT_U8;
2300 break;
2301 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2302 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2303 break;
2304 case USB_AUDIO_FORMAT_ALAW:
2305 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2306 break;
2307 case USB_AUDIO_FORMAT_MU_LAW:
2308 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2309 break;
2310 default:
2311 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2312 chip->dev->devnum, fp->iface, fp->altsetting, format);
2313 break;
2314 }
2315 return pcm_format;
2316 }
2317
2318
2319 /*
2320 * parse the format descriptor and stores the possible sample rates
2321 * on the audioformat table.
2322 *
2323 * @dev: usb device
2324 * @fp: audioformat record
2325 * @fmt: the format descriptor
2326 * @offset: the start offset of descriptor pointing the rate type
2327 * (7 for type I and II, 8 for type II)
2328 */
2329 static int parse_audio_format_rates(snd_usb_audio_t *chip, struct audioformat *fp,
2330 unsigned char *fmt, int offset)
2331 {
2332 int nr_rates = fmt[offset];
2333 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2334 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2335 chip->dev->devnum, fp->iface, fp->altsetting);
2336 return -1;
2337 }
2338
2339 if (nr_rates) {
2340 /*
2341 * build the rate table and bitmap flags
2342 */
2343 int r, idx, c;
2344 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2345 static unsigned int conv_rates[] = {
2346 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2347 64000, 88200, 96000, 176400, 192000
2348 };
2349 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2350 if (fp->rate_table == NULL) {
2351 snd_printk(KERN_ERR "cannot malloc\n");
2352 return -1;
2353 }
2354
2355 fp->nr_rates = nr_rates;
2356 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2357 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2358 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2359 if (rate < fp->rate_min)
2360 fp->rate_min = rate;
2361 else if (rate > fp->rate_max)
2362 fp->rate_max = rate;
2363 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2364 if (rate == conv_rates[c]) {
2365 fp->rates |= (1 << c);
2366 break;
2367 }
2368 }
2369 }
2370 } else {
2371 /* continuous rates */
2372 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2373 fp->rate_min = combine_triple(&fmt[offset + 1]);
2374 fp->rate_max = combine_triple(&fmt[offset + 4]);
2375 }
2376 return 0;
2377 }
2378
2379 /*
2380 * parse the format type I and III descriptors
2381 */
2382 static int parse_audio_format_i(snd_usb_audio_t *chip, struct audioformat *fp,
2383 int format, unsigned char *fmt)
2384 {
2385 int pcm_format;
2386
2387 if (fmt[3] == USB_FORMAT_TYPE_III) {
2388 /* FIXME: the format type is really IECxxx
2389 * but we give normal PCM format to get the existing
2390 * apps working...
2391 */
2392 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2393 } else {
2394 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2395 if (pcm_format < 0)
2396 return -1;
2397 }
2398 fp->format = pcm_format;
2399 fp->channels = fmt[4];
2400 if (fp->channels < 1) {
2401 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2402 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2403 return -1;
2404 }
2405 return parse_audio_format_rates(chip, fp, fmt, 7);
2406 }
2407
2408 /*
2409 * prase the format type II descriptor
2410 */
2411 static int parse_audio_format_ii(snd_usb_audio_t *chip, struct audioformat *fp,
2412 int format, unsigned char *fmt)
2413 {
2414 int brate, framesize;
2415 switch (format) {
2416 case USB_AUDIO_FORMAT_AC3:
2417 /* FIXME: there is no AC3 format defined yet */
2418 // fp->format = SNDRV_PCM_FORMAT_AC3;
2419 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2420 break;
2421 case USB_AUDIO_FORMAT_MPEG:
2422 fp->format = SNDRV_PCM_FORMAT_MPEG;
2423 break;
2424 default:
2425 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
2426 chip->dev->devnum, fp->iface, fp->altsetting, format);
2427 fp->format = SNDRV_PCM_FORMAT_MPEG;
2428 break;
2429 }
2430 fp->channels = 1;
2431 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2432 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2433 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2434 fp->frame_size = framesize;
2435 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2436 }
2437
2438 static int parse_audio_format(snd_usb_audio_t *chip, struct audioformat *fp,
2439 int format, unsigned char *fmt, int stream)
2440 {
2441 int err;
2442
2443 switch (fmt[3]) {
2444 case USB_FORMAT_TYPE_I:
2445 case USB_FORMAT_TYPE_III:
2446 err = parse_audio_format_i(chip, fp, format, fmt);
2447 break;
2448 case USB_FORMAT_TYPE_II:
2449 err = parse_audio_format_ii(chip, fp, format, fmt);
2450 break;
2451 default:
2452 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2453 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2454 return -1;
2455 }
2456 fp->fmt_type = fmt[3];
2457 if (err < 0)
2458 return err;
2459 #if 1
2460 /* FIXME: temporary hack for extigy/audigy 2 nx */
2461 /* extigy apparently supports sample rates other than 48k
2462 * but not in ordinary way. so we enable only 48k atm.
2463 */
2464 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2465 chip->usb_id == USB_ID(0x041e, 0x3020)) {
2466 if (fmt[3] == USB_FORMAT_TYPE_I &&
2467 fp->rates != SNDRV_PCM_RATE_48000 &&
2468 fp->rates != SNDRV_PCM_RATE_96000)
2469 return -1;
2470 }
2471 #endif
2472 return 0;
2473 }
2474
2475 static int parse_audio_endpoints(snd_usb_audio_t *chip, int iface_no)
2476 {
2477 struct usb_device *dev;
2478 struct usb_interface *iface;
2479 struct usb_host_interface *alts;
2480 struct usb_interface_descriptor *altsd;
2481 int i, altno, err, stream;
2482 int format;
2483 struct audioformat *fp;
2484 unsigned char *fmt, *csep;
2485
2486 dev = chip->dev;
2487
2488 /* parse the interface's altsettings */
2489 iface = usb_ifnum_to_if(dev, iface_no);
2490 for (i = 0; i < iface->num_altsetting; i++) {
2491 alts = &iface->altsetting[i];
2492 altsd = get_iface_desc(alts);
2493 /* skip invalid one */
2494 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2495 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2496 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2497 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2498 altsd->bNumEndpoints < 1 ||
2499 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2500 continue;
2501 /* must be isochronous */
2502 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2503 USB_ENDPOINT_XFER_ISOC)
2504 continue;
2505 /* check direction */
2506 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2507 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2508 altno = altsd->bAlternateSetting;
2509
2510 /* get audio formats */
2511 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2512 if (!fmt) {
2513 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2514 dev->devnum, iface_no, altno);
2515 continue;
2516 }
2517
2518 if (fmt[0] < 7) {
2519 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2520 dev->devnum, iface_no, altno);
2521 continue;
2522 }
2523
2524 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2525
2526 /* get format type */
2527 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2528 if (!fmt) {
2529 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2530 dev->devnum, iface_no, altno);
2531 continue;
2532 }
2533 if (fmt[0] < 8) {
2534 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2535 dev->devnum, iface_no, altno);
2536 continue;
2537 }
2538
2539 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2540 /* Creamware Noah has this descriptor after the 2nd endpoint */
2541 if (!csep && altsd->bNumEndpoints >= 2)
2542 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2543 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2544 snd_printk(KERN_ERR "%d:%u:%d : no or invalid class specific endpoint descriptor\n",
2545 dev->devnum, iface_no, altno);
2546 continue;
2547 }
2548
2549 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2550 if (! fp) {
2551 snd_printk(KERN_ERR "cannot malloc\n");
2552 return -ENOMEM;
2553 }
2554
2555 memset(fp, 0, sizeof(*fp));
2556 fp->iface = iface_no;
2557 fp->altsetting = altno;
2558 fp->altset_idx = i;
2559 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2560 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2561 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2562 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2563 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2564 * (fp->maxpacksize & 0x7ff);
2565 fp->attributes = csep[3];
2566
2567 /* some quirks for attributes here */
2568
2569 switch (chip->usb_id) {
2570 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2571 /* Optoplay sets the sample rate attribute although
2572 * it seems not supporting it in fact.
2573 */
2574 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2575 break;
2576 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2577 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2578 /* doesn't set the sample rate attribute, but supports it */
2579 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2580 break;
2581 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2582 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2583 an older model 77d:223) */
2584 /*
2585 * plantronics headset and Griffin iMic have set adaptive-in
2586 * although it's really not...
2587 */
2588 fp->ep_attr &= ~EP_ATTR_MASK;
2589 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2590 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2591 else
2592 fp->ep_attr |= EP_ATTR_SYNC;
2593 break;
2594 }
2595
2596 /* ok, let's parse further... */
2597 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2598 kfree(fp->rate_table);
2599 kfree(fp);
2600 continue;
2601 }
2602
2603 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, i, fp->endpoint);
2604 err = add_audio_endpoint(chip, stream, fp);
2605 if (err < 0) {
2606 kfree(fp->rate_table);
2607 kfree(fp);
2608 return err;
2609 }
2610 /* try to set the interface... */
2611 usb_set_interface(chip->dev, iface_no, altno);
2612 init_usb_pitch(chip->dev, iface_no, alts, fp);
2613 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2614 }
2615 return 0;
2616 }
2617
2618
2619 /*
2620 * disconnect streams
2621 * called from snd_usb_audio_disconnect()
2622 */
2623 static void snd_usb_stream_disconnect(struct list_head *head)
2624 {
2625 int idx;
2626 snd_usb_stream_t *as;
2627 snd_usb_substream_t *subs;
2628
2629 as = list_entry(head, snd_usb_stream_t, list);
2630 for (idx = 0; idx < 2; idx++) {
2631 subs = &as->substream[idx];
2632 if (!subs->num_formats)
2633 return;
2634 release_substream_urbs(subs, 1);
2635 subs->interface = -1;
2636 }
2637 }
2638
2639 /*
2640 * parse audio control descriptor and create pcm/midi streams
2641 */
2642 static int snd_usb_create_streams(snd_usb_audio_t *chip, int ctrlif)
2643 {
2644 struct usb_device *dev = chip->dev;
2645 struct usb_host_interface *host_iface;
2646 struct usb_interface *iface;
2647 unsigned char *p1;
2648 int i, j;
2649
2650 /* find audiocontrol interface */
2651 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2652 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2653 snd_printk(KERN_ERR "cannot find HEADER\n");
2654 return -EINVAL;
2655 }
2656 if (! p1[7] || p1[0] < 8 + p1[7]) {
2657 snd_printk(KERN_ERR "invalid HEADER\n");
2658 return -EINVAL;
2659 }
2660
2661 /*
2662 * parse all USB audio streaming interfaces
2663 */
2664 for (i = 0; i < p1[7]; i++) {
2665 struct usb_host_interface *alts;
2666 struct usb_interface_descriptor *altsd;
2667 j = p1[8 + i];
2668 iface = usb_ifnum_to_if(dev, j);
2669 if (!iface) {
2670 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2671 dev->devnum, ctrlif, j);
2672 continue;
2673 }
2674 if (usb_interface_claimed(iface)) {
2675 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2676 continue;
2677 }
2678 alts = &iface->altsetting[0];
2679 altsd = get_iface_desc(alts);
2680 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2681 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2682 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2683 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2684 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2685 continue;
2686 }
2687 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2688 continue;
2689 }
2690 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2691 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2692 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2693 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2694 /* skip non-supported classes */
2695 continue;
2696 }
2697 if (! parse_audio_endpoints(chip, j)) {
2698 usb_set_interface(dev, j, 0); /* reset the current interface */
2699 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2700 }
2701 }
2702
2703 return 0;
2704 }
2705
2706 /*
2707 * create a stream for an endpoint/altsetting without proper descriptors
2708 */
2709 static int create_fixed_stream_quirk(snd_usb_audio_t *chip,
2710 struct usb_interface *iface,
2711 const snd_usb_audio_quirk_t *quirk)
2712 {
2713 struct audioformat *fp;
2714 struct usb_host_interface *alts;
2715 int stream, err;
2716 int *rate_table = NULL;
2717
2718 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2719 if (! fp) {
2720 snd_printk(KERN_ERR "cannot malloc\n");
2721 return -ENOMEM;
2722 }
2723 memcpy(fp, quirk->data, sizeof(*fp));
2724 if (fp->nr_rates > 0) {
2725 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2726 if (!rate_table) {
2727 kfree(fp);
2728 return -ENOMEM;
2729 }
2730 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2731 fp->rate_table = rate_table;
2732 }
2733
2734 stream = (fp->endpoint & USB_DIR_IN)
2735 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2736 err = add_audio_endpoint(chip, stream, fp);
2737 if (err < 0) {
2738 kfree(fp);
2739 kfree(rate_table);
2740 return err;
2741 }
2742 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2743 fp->altset_idx >= iface->num_altsetting) {
2744 kfree(fp);
2745 kfree(rate_table);
2746 return -EINVAL;
2747 }
2748 alts = &iface->altsetting[fp->altset_idx];
2749 usb_set_interface(chip->dev, fp->iface, 0);
2750 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2751 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2752 return 0;
2753 }
2754
2755 /*
2756 * create a stream for an interface with proper descriptors
2757 */
2758 static int create_standard_audio_quirk(snd_usb_audio_t *chip,
2759 struct usb_interface *iface,
2760 const snd_usb_audio_quirk_t *quirk)
2761 {
2762 struct usb_host_interface *alts;
2763 struct usb_interface_descriptor *altsd;
2764 int err;
2765
2766 alts = &iface->altsetting[0];
2767 altsd = get_iface_desc(alts);
2768 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2769 if (err < 0) {
2770 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2771 altsd->bInterfaceNumber, err);
2772 return err;
2773 }
2774 /* reset the current interface */
2775 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2776 return 0;
2777 }
2778
2779 /*
2780 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2781 * to detect the sample rate is by looking at wMaxPacketSize.
2782 */
2783 static int create_ua700_ua25_quirk(snd_usb_audio_t *chip,
2784 struct usb_interface *iface,
2785 const snd_usb_audio_quirk_t *quirk)
2786 {
2787 static const struct audioformat ua_format = {
2788 .format = SNDRV_PCM_FORMAT_S24_3LE,
2789 .channels = 2,
2790 .fmt_type = USB_FORMAT_TYPE_I,
2791 .altsetting = 1,
2792 .altset_idx = 1,
2793 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2794 };
2795 struct usb_host_interface *alts;
2796 struct usb_interface_descriptor *altsd;
2797 struct audioformat *fp;
2798 int stream, err;
2799
2800 /* both PCM and MIDI interfaces have 2 altsettings */
2801 if (iface->num_altsetting != 2)
2802 return -ENXIO;
2803 alts = &iface->altsetting[1];
2804 altsd = get_iface_desc(alts);
2805
2806 if (altsd->bNumEndpoints == 2) {
2807 static const snd_usb_midi_endpoint_info_t ua700_ep = {
2808 .out_cables = 0x0003,
2809 .in_cables = 0x0003
2810 };
2811 static const snd_usb_audio_quirk_t ua700_quirk = {
2812 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2813 .data = &ua700_ep
2814 };
2815 static const snd_usb_midi_endpoint_info_t ua25_ep = {
2816 .out_cables = 0x0001,
2817 .in_cables = 0x0001
2818 };
2819 static const snd_usb_audio_quirk_t ua25_quirk = {
2820 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2821 .data = &ua25_ep
2822 };
2823 if (chip->usb_id == USB_ID(0x0582, 0x002b))
2824 return snd_usb_create_midi_interface(chip, iface,
2825 &ua700_quirk);
2826 else
2827 return snd_usb_create_midi_interface(chip, iface,
2828 &ua25_quirk);
2829 }
2830
2831 if (altsd->bNumEndpoints != 1)
2832 return -ENXIO;
2833
2834 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2835 if (!fp)
2836 return -ENOMEM;
2837 memcpy(fp, &ua_format, sizeof(*fp));
2838
2839 fp->iface = altsd->bInterfaceNumber;
2840 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2841 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2842 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2843
2844 switch (fp->maxpacksize) {
2845 case 0x120:
2846 fp->rate_max = fp->rate_min = 44100;
2847 break;
2848 case 0x138:
2849 case 0x140:
2850 fp->rate_max = fp->rate_min = 48000;
2851 break;
2852 case 0x258:
2853 case 0x260:
2854 fp->rate_max = fp->rate_min = 96000;
2855 break;
2856 default:
2857 snd_printk(KERN_ERR "unknown sample rate\n");
2858 kfree(fp);
2859 return -ENXIO;
2860 }
2861
2862 stream = (fp->endpoint & USB_DIR_IN)
2863 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2864 err = add_audio_endpoint(chip, stream, fp);
2865 if (err < 0) {
2866 kfree(fp);
2867 return err;
2868 }
2869 usb_set_interface(chip->dev, fp->iface, 0);
2870 return 0;
2871 }
2872
2873 /*
2874 * Create a stream for an Edirol UA-1000 interface.
2875 */
2876 static int create_ua1000_quirk(snd_usb_audio_t *chip,
2877 struct usb_interface *iface,
2878 const snd_usb_audio_quirk_t *quirk)
2879 {
2880 static const struct audioformat ua1000_format = {
2881 .format = SNDRV_PCM_FORMAT_S32_LE,
2882 .fmt_type = USB_FORMAT_TYPE_I,
2883 .altsetting = 1,
2884 .altset_idx = 1,
2885 .attributes = 0,
2886 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2887 };
2888 struct usb_host_interface *alts;
2889 struct usb_interface_descriptor *altsd;
2890 struct audioformat *fp;
2891 int stream, err;
2892
2893 if (iface->num_altsetting != 2)
2894 return -ENXIO;
2895 alts = &iface->altsetting[1];
2896 altsd = get_iface_desc(alts);
2897 if (alts->extralen != 11 || alts->extra[1] != CS_AUDIO_INTERFACE ||
2898 altsd->bNumEndpoints != 1)
2899 return -ENXIO;
2900
2901 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2902 if (!fp)
2903 return -ENOMEM;
2904 memcpy(fp, &ua1000_format, sizeof(*fp));
2905
2906 fp->channels = alts->extra[4];
2907 fp->iface = altsd->bInterfaceNumber;
2908 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2909 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2910 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2911 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2912
2913 stream = (fp->endpoint & USB_DIR_IN)
2914 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2915 err = add_audio_endpoint(chip, stream, fp);
2916 if (err < 0) {
2917 kfree(fp);
2918 return err;
2919 }
2920 /* FIXME: playback must be synchronized to capture */
2921 usb_set_interface(chip->dev, fp->iface, 0);
2922 return 0;
2923 }
2924
2925 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
2926 struct usb_interface *iface,
2927 const snd_usb_audio_quirk_t *quirk);
2928
2929 /*
2930 * handle the quirks for the contained interfaces
2931 */
2932 static int create_composite_quirk(snd_usb_audio_t *chip,
2933 struct usb_interface *iface,
2934 const snd_usb_audio_quirk_t *quirk)
2935 {
2936 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
2937 int err;
2938
2939 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
2940 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
2941 if (!iface)
2942 continue;
2943 if (quirk->ifnum != probed_ifnum &&
2944 usb_interface_claimed(iface))
2945 continue;
2946 err = snd_usb_create_quirk(chip, iface, quirk);
2947 if (err < 0)
2948 return err;
2949 if (quirk->ifnum != probed_ifnum)
2950 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2951 }
2952 return 0;
2953 }
2954
2955 static int ignore_interface_quirk(snd_usb_audio_t *chip,
2956 struct usb_interface *iface,
2957 const snd_usb_audio_quirk_t *quirk)
2958 {
2959 return 0;
2960 }
2961
2962
2963 /*
2964 * boot quirks
2965 */
2966
2967 #define EXTIGY_FIRMWARE_SIZE_OLD 794
2968 #define EXTIGY_FIRMWARE_SIZE_NEW 483
2969
2970 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
2971 {
2972 struct usb_host_config *config = dev->actconfig;
2973 int err;
2974
2975 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
2976 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
2977 snd_printdd("sending Extigy boot sequence...\n");
2978 /* Send message to force it to reconnect with full interface. */
2979 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
2980 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
2981 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
2982 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
2983 &dev->descriptor, sizeof(dev->descriptor));
2984 config = dev->actconfig;
2985 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
2986 err = usb_reset_configuration(dev);
2987 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
2988 snd_printdd("extigy_boot: new boot length = %d\n",
2989 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
2990 return -ENODEV; /* quit this anyway */
2991 }
2992 return 0;
2993 }
2994
2995 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
2996 {
2997 u8 buf = 1;
2998
2999 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3000 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3001 0, 0, &buf, 1, 1000);
3002 if (buf == 0) {
3003 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3004 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3005 1, 2000, NULL, 0, 1000);
3006 return -ENODEV;
3007 }
3008 return 0;
3009 }
3010
3011
3012 /*
3013 * audio-interface quirks
3014 *
3015 * returns zero if no standard audio/MIDI parsing is needed.
3016 * returns a postive value if standard audio/midi interfaces are parsed
3017 * after this.
3018 * returns a negative value at error.
3019 */
3020 static int snd_usb_create_quirk(snd_usb_audio_t *chip,
3021 struct usb_interface *iface,
3022 const snd_usb_audio_quirk_t *quirk)
3023 {
3024 typedef int (*quirk_func_t)(snd_usb_audio_t *, struct usb_interface *,
3025 const snd_usb_audio_quirk_t *);
3026 static const quirk_func_t quirk_funcs[] = {
3027 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3028 [QUIRK_COMPOSITE] = create_composite_quirk,
3029 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3030 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3031 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3032 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3033 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3034 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3035 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3036 [QUIRK_MIDI_MIDITECH] = snd_usb_create_midi_interface,
3037 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3038 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3039 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3040 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3041 };
3042
3043 if (quirk->type < QUIRK_TYPE_COUNT) {
3044 return quirk_funcs[quirk->type](chip, iface, quirk);
3045 } else {
3046 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3047 return -ENXIO;
3048 }
3049 }
3050
3051
3052 /*
3053 * common proc files to show the usb device info
3054 */
3055 static void proc_audio_usbbus_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3056 {
3057 snd_usb_audio_t *chip = entry->private_data;
3058 if (! chip->shutdown)
3059 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3060 }
3061
3062 static void proc_audio_usbid_read(snd_info_entry_t *entry, snd_info_buffer_t *buffer)
3063 {
3064 snd_usb_audio_t *chip = entry->private_data;
3065 if (! chip->shutdown)
3066 snd_iprintf(buffer, "%04x:%04x\n",
3067 USB_ID_VENDOR(chip->usb_id),
3068 USB_ID_PRODUCT(chip->usb_id));
3069 }
3070
3071 static void snd_usb_audio_create_proc(snd_usb_audio_t *chip)
3072 {
3073 snd_info_entry_t *entry;
3074 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3075 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbbus_read);
3076 if (! snd_card_proc_new(chip->card, "usbid", &entry))
3077 snd_info_set_text_ops(entry, chip, 1024, proc_audio_usbid_read);
3078 }
3079
3080 /*
3081 * free the chip instance
3082 *
3083 * here we have to do not much, since pcm and controls are already freed
3084 *
3085 */
3086
3087 static int snd_usb_audio_free(snd_usb_audio_t *chip)
3088 {
3089 kfree(chip);
3090 return 0;
3091 }
3092
3093 static int snd_usb_audio_dev_free(snd_device_t *device)
3094 {
3095 snd_usb_audio_t *chip = device->device_data;
3096 return snd_usb_audio_free(chip);
3097 }
3098
3099
3100 /*
3101 * create a chip instance and set its names.
3102 */
3103 static int snd_usb_audio_create(struct usb_device *dev, int idx,
3104 const snd_usb_audio_quirk_t *quirk,
3105 snd_usb_audio_t **rchip)
3106 {
3107 snd_card_t *card;
3108 snd_usb_audio_t *chip;
3109 int err, len;
3110 char component[14];
3111 static snd_device_ops_t ops = {
3112 .dev_free = snd_usb_audio_dev_free,
3113 };
3114
3115 *rchip = NULL;
3116
3117 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3118 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3119 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3120 return -ENXIO;
3121 }
3122
3123 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3124 if (card == NULL) {
3125 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3126 return -ENOMEM;
3127 }
3128
3129 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3130 if (! chip) {
3131 snd_card_free(card);
3132 return -ENOMEM;
3133 }
3134
3135 chip->index = idx;
3136 chip->dev = dev;
3137 chip->card = card;
3138 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3139 le16_to_cpu(dev->descriptor.idProduct));
3140 INIT_LIST_HEAD(&chip->pcm_list);
3141 INIT_LIST_HEAD(&chip->midi_list);
3142 INIT_LIST_HEAD(&chip->mixer_list);
3143
3144 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3145 snd_usb_audio_free(chip);
3146 snd_card_free(card);
3147 return err;
3148 }
3149
3150 strcpy(card->driver, "USB-Audio");
3151 sprintf(component, "USB%04x:%04x",
3152 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3153 snd_component_add(card, component);
3154
3155 /* retrieve the device string as shortname */
3156 if (quirk && quirk->product_name) {
3157 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3158 } else {
3159 if (!dev->descriptor.iProduct ||
3160 usb_string(dev, dev->descriptor.iProduct,
3161 card->shortname, sizeof(card->shortname)) <= 0) {
3162 /* no name available from anywhere, so use ID */
3163 sprintf(card->shortname, "USB Device %#04x:%#04x",
3164 USB_ID_VENDOR(chip->usb_id),
3165 USB_ID_PRODUCT(chip->usb_id));
3166 }
3167 }
3168
3169 /* retrieve the vendor and device strings as longname */
3170 if (quirk && quirk->vendor_name) {
3171 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3172 } else {
3173 if (dev->descriptor.iManufacturer)
3174 len = usb_string(dev, dev->descriptor.iManufacturer,
3175 card->longname, sizeof(card->longname));
3176 else
3177 len = 0;
3178 /* we don't really care if there isn't any vendor string */
3179 }
3180 if (len > 0)
3181 strlcat(card->longname, " ", sizeof(card->longname));
3182
3183 strlcat(card->longname, card->shortname, sizeof(card->longname));
3184
3185 len = strlcat(card->longname, " at ", sizeof(card->longname));
3186
3187 if (len < sizeof(card->longname))
3188 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3189
3190 strlcat(card->longname,
3191 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3192 sizeof(card->longname));
3193
3194 snd_usb_audio_create_proc(chip);
3195
3196 *rchip = chip;
3197 return 0;
3198 }
3199
3200
3201 /*
3202 * probe the active usb device
3203 *
3204 * note that this can be called multiple times per a device, when it
3205 * includes multiple audio control interfaces.
3206 *
3207 * thus we check the usb device pointer and creates the card instance
3208 * only at the first time. the successive calls of this function will
3209 * append the pcm interface to the corresponding card.
3210 */
3211 static void *snd_usb_audio_probe(struct usb_device *dev,
3212 struct usb_interface *intf,
3213 const struct usb_device_id *usb_id)
3214 {
3215 struct usb_host_config *config = dev->actconfig;
3216 const snd_usb_audio_quirk_t *quirk = (const snd_usb_audio_quirk_t *)usb_id->driver_info;
3217 int i, err;
3218 snd_usb_audio_t *chip;
3219 struct usb_host_interface *alts;
3220 int ifnum;
3221 u32 id;
3222
3223 alts = &intf->altsetting[0];
3224 ifnum = get_iface_desc(alts)->bInterfaceNumber;
3225 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3226 le16_to_cpu(dev->descriptor.idProduct));
3227
3228 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3229 goto __err_val;
3230
3231 /* SB Extigy needs special boot-up sequence */
3232 /* if more models come, this will go to the quirk list. */
3233 if (id == USB_ID(0x041e, 0x3000)) {
3234 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3235 goto __err_val;
3236 config = dev->actconfig;
3237 }
3238 /* SB Audigy 2 NX needs its own boot-up magic, too */
3239 if (id == USB_ID(0x041e, 0x3020)) {
3240 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3241 goto __err_val;
3242 }
3243
3244 /*
3245 * found a config. now register to ALSA
3246 */
3247
3248 /* check whether it's already registered */
3249 chip = NULL;
3250 down(&register_mutex);
3251 for (i = 0; i < SNDRV_CARDS; i++) {
3252 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3253 if (usb_chip[i]->shutdown) {
3254 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3255 goto __error;
3256 }
3257 chip = usb_chip[i];
3258 break;
3259 }
3260 }
3261 if (! chip) {
3262 /* it's a fresh one.
3263 * now look for an empty slot and create a new card instance
3264 */
3265 /* first, set the current configuration for this device */
3266 if (usb_reset_configuration(dev) < 0) {
3267 snd_printk(KERN_ERR "cannot reset configuration (value 0x%x)\n", get_cfg_desc(config)->bConfigurationValue);
3268 goto __error;
3269 }
3270 for (i = 0; i < SNDRV_CARDS; i++)
3271 if (enable[i] && ! usb_chip[i] &&
3272 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3273 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3274 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3275 goto __error;
3276 }
3277 snd_card_set_dev(chip->card, &intf->dev);
3278 break;
3279 }
3280 if (! chip) {
3281 snd_printk(KERN_ERR "no available usb audio device\n");
3282 goto __error;
3283 }
3284 }
3285
3286 err = 1; /* continue */
3287 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3288 /* need some special handlings */
3289 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3290 goto __error;
3291 }
3292
3293 if (err > 0) {
3294 /* create normal USB audio interfaces */
3295 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3296 snd_usb_create_mixer(chip, ifnum) < 0) {
3297 goto __error;
3298 }
3299 }
3300
3301 /* we are allowed to call snd_card_register() many times */
3302 if (snd_card_register(chip->card) < 0) {
3303 goto __error;
3304 }
3305
3306 usb_chip[chip->index] = chip;
3307 chip->num_interfaces++;
3308 up(&register_mutex);
3309 return chip;
3310
3311 __error:
3312 if (chip && !chip->num_interfaces)
3313 snd_card_free(chip->card);
3314 up(&register_mutex);
3315 __err_val:
3316 return NULL;
3317 }
3318
3319 /*
3320 * we need to take care of counter, since disconnection can be called also
3321 * many times as well as usb_audio_probe().
3322 */
3323 static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3324 {
3325 snd_usb_audio_t *chip;
3326 snd_card_t *card;
3327 struct list_head *p;
3328
3329 if (ptr == (void *)-1L)
3330 return;
3331
3332 chip = ptr;
3333 card = chip->card;
3334 down(&register_mutex);
3335 chip->shutdown = 1;
3336 chip->num_interfaces--;
3337 if (chip->num_interfaces <= 0) {
3338 snd_card_disconnect(card);
3339 /* release the pcm resources */
3340 list_for_each(p, &chip->pcm_list) {
3341 snd_usb_stream_disconnect(p);
3342 }
3343 /* release the midi resources */
3344 list_for_each(p, &chip->midi_list) {
3345 snd_usbmidi_disconnect(p);
3346 }
3347 /* release mixer resources */
3348 list_for_each(p, &chip->mixer_list) {
3349 snd_usb_mixer_disconnect(p);
3350 }
3351 usb_chip[chip->index] = NULL;
3352 up(&register_mutex);
3353 snd_card_free(card);
3354 } else {
3355 up(&register_mutex);
3356 }
3357 }
3358
3359 /*
3360 * new 2.5 USB kernel API
3361 */
3362 static int usb_audio_probe(struct usb_interface *intf,
3363 const struct usb_device_id *id)
3364 {
3365 void *chip;
3366 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3367 if (chip) {
3368 dev_set_drvdata(&intf->dev, chip);
3369 return 0;
3370 } else
3371 return -EIO;
3372 }
3373
3374 static void usb_audio_disconnect(struct usb_interface *intf)
3375 {
3376 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3377 dev_get_drvdata(&intf->dev));
3378 }
3379
3380
3381 static int __init snd_usb_audio_init(void)
3382 {
3383 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3384 printk(KERN_WARNING "invalid nrpacks value.\n");
3385 return -EINVAL;
3386 }
3387 usb_register(&usb_audio_driver);
3388 return 0;
3389 }
3390
3391
3392 static void __exit snd_usb_audio_cleanup(void)
3393 {
3394 usb_deregister(&usb_audio_driver);
3395 }
3396
3397 module_init(snd_usb_audio_init);
3398 module_exit(snd_usb_audio_cleanup);