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