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