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