sound/usb/usbaudio.c

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