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