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