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

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