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