err.no Git - linux-2.6/blob - sound/usb/usbaudio.c

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