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