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