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