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