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