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