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