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