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