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