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