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