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