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