SAFE public projects git trees. - safe/jmp/linux-2.6/blob - sound/usb/usbaudio.c

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