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