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