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