sound/usb/usbaudio.c

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