sound/usb/pcm.c

   1 /*
   2  *   This program is free software; you can redistribute it and/or modify
   3  *   it under the terms of the GNU General Public License as published by
   4  *   the Free Software Foundation; either version 2 of the License, or
   5  *   (at your option) any later version.
   6  *
   7  *   This program is distributed in the hope that it will be useful,
   8  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  *   GNU General Public License for more details.
  11  *
  12  *   You should have received a copy of the GNU General Public License
  13  *   along with this program; if not, write to the Free Software
  14  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15  */
  16
  17 #include <linux/init.h>
  18 #include <linux/slab.h>
  19 #include <linux/bitrev.h>
  20 #include <linux/ratelimit.h>
  21 #include <linux/usb.h>
  22 #include <linux/usb/audio.h>
  23 #include <linux/usb/audio-v2.h>
  24
  25 #include <sound/core.h>
  26 #include <sound/pcm.h>
  27 #include <sound/pcm_params.h>
  28
  29 #include "usbaudio.h"
  30 #include "card.h"
  31 #include "quirks.h"
  32 #include "debug.h"
  33 #include "endpoint.h"
  34 #include "helper.h"
  35 #include "pcm.h"
  36 #include "clock.h"
  37 #include "power.h"
  38
  39 #define SUBSTREAM_FLAG_DATA_EP_STARTED  0
  40 #define SUBSTREAM_FLAG_SYNC_EP_STARTED  1
  41
  42 /* return the estimated delay based on USB frame counters */
  43 snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
  44                                     unsigned int rate)
  45 {
  46         int current_frame_number;
  47         int frame_diff;
  48         int est_delay;
  49
  50         if (!subs->last_delay)
  51                 return 0; /* short path */
  52
  53         current_frame_number = usb_get_current_frame_number(subs->dev);
  54         /*
  55          * HCD implementations use different widths, use lower 8 bits.
  56          * The delay will be managed up to 256ms, which is more than
  57          * enough
  58          */
  59         frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
  60
  61         /* Approximation based on number of samples per USB frame (ms),
  62            some truncation for 44.1 but the estimate is good enough */
  63         est_delay =  frame_diff * rate / 1000;
  64         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
  65                 est_delay = subs->last_delay - est_delay;
  66         else
  67                 est_delay = subs->last_delay + est_delay;
  68
  69         if (est_delay < 0)
  70                 est_delay = 0;
  71         return est_delay;
  72 }
  73
  74 /*
  75  * return the current pcm pointer.  just based on the hwptr_done value.
  76  */
  77 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
  78 {
  79         struct snd_usb_substream *subs = substream->runtime->private_data;
  80         unsigned int hwptr_done;
  81
  82         if (atomic_read(&subs->stream->chip->shutdown))
  83                 return SNDRV_PCM_POS_XRUN;
  84         spin_lock(&subs->lock);
  85         hwptr_done = subs->hwptr_done;
  86         substream->runtime->delay = snd_usb_pcm_delay(subs,
  87                                                 substream->runtime->rate);
  88         spin_unlock(&subs->lock);
  89         return hwptr_done / (substream->runtime->frame_bits >> 3);
  90 }
  91
  92 /*
  93  * find a matching audio format
  94  */
  95 static struct audioformat *find_format(struct snd_usb_substream *subs)
  96 {
  97         struct audioformat *fp;
  98         struct audioformat *found = NULL;
  99         int cur_attr = 0, attr;
 100
 101         list_for_each_entry(fp, &subs->fmt_list, list) {
 102                 if (!(fp->formats & pcm_format_to_bits(subs->pcm_format)))
 103                         continue;
 104                 if (fp->channels != subs->channels)
 105                         continue;
 106                 if (subs->cur_rate < fp->rate_min ||
 107                     subs->cur_rate > fp->rate_max)
 108                         continue;
 109                 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
 110                         unsigned int i;
 111                         for (i = 0; i < fp->nr_rates; i++)
 112                                 if (fp->rate_table[i] == subs->cur_rate)
 113                                         break;
 114                         if (i >= fp->nr_rates)
 115                                 continue;
 116                 }
 117                 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
 118                 if (! found) {
 119                         found = fp;
 120                         cur_attr = attr;
 121                         continue;
 122                 }
 123                 /* avoid async out and adaptive in if the other method
 124                  * supports the same format.
 125                  * this is a workaround for the case like
 126                  * M-audio audiophile USB.
 127                  */
 128                 if (attr != cur_attr) {
 129                         if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
 130                              subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
 131                             (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
 132                              subs->direction == SNDRV_PCM_STREAM_CAPTURE))
 133                                 continue;
 134                         if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
 135                              subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
 136                             (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
 137                              subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
 138                                 found = fp;
 139                                 cur_attr = attr;
 140                                 continue;
 141                         }
 142                 }
 143                 /* find the format with the largest max. packet size */
 144                 if (fp->maxpacksize > found->maxpacksize) {
 145                         found = fp;
 146                         cur_attr = attr;
 147                 }
 148         }
 149         return found;
 150 }
 151
 152 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
 153                          struct usb_host_interface *alts,
 154                          struct audioformat *fmt)
 155 {
 156         struct usb_device *dev = chip->dev;
 157         unsigned int ep;
 158         unsigned char data[1];
 159         int err;
 160
 161         if (get_iface_desc(alts)->bNumEndpoints < 1)
 162                 return -EINVAL;
 163         ep = get_endpoint(alts, 0)->bEndpointAddress;
 164
 165         data[0] = 1;
 166         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
 167                               USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
 168                               UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
 169                               data, sizeof(data));
 170         if (err < 0) {
 171                 usb_audio_err(chip, "%d:%d: cannot set enable PITCH\n",
 172                               iface, ep);
 173                 return err;
 174         }
 175
 176         return 0;
 177 }
 178
 179 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
 180                          struct usb_host_interface *alts,
 181                          struct audioformat *fmt)
 182 {
 183         struct usb_device *dev = chip->dev;
 184         unsigned char data[1];
 185         int err;
 186
 187         data[0] = 1;
 188         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
 189                               USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
 190                               UAC2_EP_CS_PITCH << 8, 0,
 191                               data, sizeof(data));
 192         if (err < 0) {
 193                 usb_audio_err(chip, "%d:%d: cannot set enable PITCH (v2)\n",
 194                               iface, fmt->altsetting);
 195                 return err;
 196         }
 197
 198         return 0;
 199 }
 200
 201 /*
 202  * initialize the pitch control and sample rate
 203  */
 204 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
 205                        struct usb_host_interface *alts,
 206                        struct audioformat *fmt)
 207 {
 208         /* if endpoint doesn't have pitch control, bail out */
 209         if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
 210                 return 0;
 211
 212         switch (fmt->protocol) {
 213         case UAC_VERSION_1:
 214         default:
 215                 return init_pitch_v1(chip, iface, alts, fmt);
 216
 217         case UAC_VERSION_2:
 218                 return init_pitch_v2(chip, iface, alts, fmt);
 219         }
 220 }
 221
 222 static int start_endpoints(struct snd_usb_substream *subs)
 223 {
 224         int err;
 225
 226         if (!subs->data_endpoint)
 227                 return -EINVAL;
 228
 229         if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
 230                 struct snd_usb_endpoint *ep = subs->data_endpoint;
 231
 232                 dev_dbg(&subs->dev->dev, "Starting data EP @%p\n", ep);
 233
 234                 ep->data_subs = subs;
 235                 err = snd_usb_endpoint_start(ep);
 236                 if (err < 0) {
 237                         clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
 238                         return err;
 239                 }
 240         }
 241
 242         if (subs->sync_endpoint &&
 243             !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
 244                 struct snd_usb_endpoint *ep = subs->sync_endpoint;
 245
 246                 if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
 247                     subs->data_endpoint->altsetting != subs->sync_endpoint->altsetting) {
 248                         err = usb_set_interface(subs->dev,
 249                                                 subs->sync_endpoint->iface,
 250                                                 subs->sync_endpoint->altsetting);
 251                         if (err < 0) {
 252                                 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
 253                                 dev_err(&subs->dev->dev,
 254                                            "%d:%d: cannot set interface (%d)\n",
 255                                            subs->sync_endpoint->iface,
 256                                            subs->sync_endpoint->altsetting, err);
 257                                 return -EIO;
 258                         }
 259                 }
 260
 261                 dev_dbg(&subs->dev->dev, "Starting sync EP @%p\n", ep);
 262
 263                 ep->sync_slave = subs->data_endpoint;
 264                 err = snd_usb_endpoint_start(ep);
 265                 if (err < 0) {
 266                         clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
 267                         return err;
 268                 }
 269         }
 270
 271         return 0;
 272 }
 273
 274 static void stop_endpoints(struct snd_usb_substream *subs, bool wait)
 275 {
 276         if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
 277                 snd_usb_endpoint_stop(subs->sync_endpoint);
 278
 279         if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
 280                 snd_usb_endpoint_stop(subs->data_endpoint);
 281
 282         if (wait) {
 283                 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
 284                 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
 285         }
 286 }
 287
 288 static int search_roland_implicit_fb(struct usb_device *dev, int ifnum,
 289                                      unsigned int altsetting,
 290                                      struct usb_host_interface **alts,
 291                                      unsigned int *ep)
 292 {
 293         struct usb_interface *iface;
 294         struct usb_interface_descriptor *altsd;
 295         struct usb_endpoint_descriptor *epd;
 296
 297         iface = usb_ifnum_to_if(dev, ifnum);
 298         if (!iface || iface->num_altsetting < altsetting + 1)
 299                 return -ENOENT;
 300         *alts = &iface->altsetting[altsetting];
 301         altsd = get_iface_desc(*alts);
 302         if (altsd->bAlternateSetting != altsetting ||
 303             altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
 304             (altsd->bInterfaceSubClass != 2 &&
 305              altsd->bInterfaceProtocol != 2   ) ||
 306             altsd->bNumEndpoints < 1)
 307                 return -ENOENT;
 308         epd = get_endpoint(*alts, 0);
 309         if (!usb_endpoint_is_isoc_in(epd) ||
 310             (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
 311                                         USB_ENDPOINT_USAGE_IMPLICIT_FB)
 312                 return -ENOENT;
 313         *ep = epd->bEndpointAddress;
 314         return 0;
 315 }
 316
 317 static int set_sync_ep_implicit_fb_quirk(struct snd_usb_substream *subs,
 318                                          struct usb_device *dev,
 319                                          struct usb_interface_descriptor *altsd,
 320                                          unsigned int attr)
 321 {
 322         struct usb_host_interface *alts;
 323         struct usb_interface *iface;
 324         unsigned int ep;
 325         unsigned int ifnum;
 326
 327         /* Implicit feedback sync EPs consumers are always playback EPs */
 328         if (subs->direction != SNDRV_PCM_STREAM_PLAYBACK)
 329                 return 0;
 330
 331         switch (subs->stream->chip->usb_id) {
 332         case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
 333         case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
 334                 ep = 0x81;
 335                 ifnum = 3;
 336                 goto add_sync_ep_from_ifnum;
 337         case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
 338         case USB_ID(0x0763, 0x2081):
 339                 ep = 0x81;
 340                 ifnum = 2;
 341                 goto add_sync_ep_from_ifnum;
 342         case USB_ID(0x2466, 0x8003): /* Fractal Audio Axe-Fx II */
 343                 ep = 0x86;
 344                 ifnum = 2;
 345                 goto add_sync_ep_from_ifnum;
 346         case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx III */
 347                 ep = 0x81;
 348                 ifnum = 2;
 349                 goto add_sync_ep_from_ifnum;
 350         case USB_ID(0x1397, 0x0002): /* Behringer UFX1204 */
 351                 ep = 0x81;
 352                 ifnum = 1;
 353                 goto add_sync_ep_from_ifnum;
 354         }
 355
 356         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
 357             altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
 358             altsd->bInterfaceProtocol == 2 &&
 359             altsd->bNumEndpoints == 1 &&
 360             USB_ID_VENDOR(subs->stream->chip->usb_id) == 0x0582 /* Roland */ &&
 361             search_roland_implicit_fb(dev, altsd->bInterfaceNumber + 1,
 362                                       altsd->bAlternateSetting,
 363                                       &alts, &ep) >= 0) {
 364                 goto add_sync_ep;
 365         }
 366
 367         /* No quirk */
 368         return 0;
 369
 370 add_sync_ep_from_ifnum:
 371         iface = usb_ifnum_to_if(dev, ifnum);
 372
 373         if (!iface || iface->num_altsetting == 0)
 374                 return -EINVAL;
 375
 376         alts = &iface->altsetting[1];
 377
 378 add_sync_ep:
 379         subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
 380                                                    alts, ep, !subs->direction,
 381                                                    SND_USB_ENDPOINT_TYPE_DATA);
 382         if (!subs->sync_endpoint)
 383                 return -EINVAL;
 384
 385         subs->data_endpoint->sync_master = subs->sync_endpoint;
 386
 387         return 0;
 388 }
 389
 390 static int set_sync_endpoint(struct snd_usb_substream *subs,
 391                              struct audioformat *fmt,
 392                              struct usb_device *dev,
 393                              struct usb_host_interface *alts,
 394                              struct usb_interface_descriptor *altsd)
 395 {
 396         int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
 397         unsigned int ep, attr;
 398         bool implicit_fb;
 399         int err;
 400
 401         /* we need a sync pipe in async OUT or adaptive IN mode */
 402         /* check the number of EP, since some devices have broken
 403          * descriptors which fool us.  if it has only one EP,
 404          * assume it as adaptive-out or sync-in.
 405          */
 406         attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
 407
 408         if ((is_playback && (attr != USB_ENDPOINT_SYNC_ASYNC)) ||
 409                 (!is_playback && (attr != USB_ENDPOINT_SYNC_ADAPTIVE))) {
 410
 411                 /*
 412                  * In these modes the notion of sync_endpoint is irrelevant.
 413                  * Reset pointers to avoid using stale data from previously
 414                  * used settings, e.g. when configuration and endpoints were
 415                  * changed
 416                  */
 417
 418                 subs->sync_endpoint = NULL;
 419                 subs->data_endpoint->sync_master = NULL;
 420         }
 421
 422         err = set_sync_ep_implicit_fb_quirk(subs, dev, altsd, attr);
 423         if (err < 0)
 424                 return err;
 425
 426         if (altsd->bNumEndpoints < 2)
 427                 return 0;
 428
 429         if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC ||
 430                              attr == USB_ENDPOINT_SYNC_ADAPTIVE)) ||
 431             (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
 432                 return 0;
 433
 434         /*
 435          * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see
 436          * if we don't find a sync endpoint, as on M-Audio Transit. In case of
 437          * error fall back to SYNC mode and don't create sync endpoint
 438          */
 439
 440         /* check sync-pipe endpoint */
 441         /* ... and check descriptor size before accessing bSynchAddress
 442            because there is a version of the SB Audigy 2 NX firmware lacking
 443            the audio fields in the endpoint descriptors */
 444         if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
 445             (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 446              get_endpoint(alts, 1)->bSynchAddress != 0)) {
 447                 dev_err(&dev->dev,
 448                         "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
 449                            fmt->iface, fmt->altsetting,
 450                            get_endpoint(alts, 1)->bmAttributes,
 451                            get_endpoint(alts, 1)->bLength,
 452                            get_endpoint(alts, 1)->bSynchAddress);
 453                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
 454                         return 0;
 455                 return -EINVAL;
 456         }
 457         ep = get_endpoint(alts, 1)->bEndpointAddress;
 458         if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 459             ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
 460              (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
 461                 dev_err(&dev->dev,
 462                         "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
 463                            fmt->iface, fmt->altsetting,
 464                            is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
 465                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
 466                         return 0;
 467                 return -EINVAL;
 468         }
 469
 470         implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
 471                         == USB_ENDPOINT_USAGE_IMPLICIT_FB;
 472
 473         subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
 474                                                    alts, ep, !subs->direction,
 475                                                    implicit_fb ?
 476                                                         SND_USB_ENDPOINT_TYPE_DATA :
 477                                                         SND_USB_ENDPOINT_TYPE_SYNC);
 478         if (!subs->sync_endpoint) {
 479                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
 480                         return 0;
 481                 return -EINVAL;
 482         }
 483
 484         subs->data_endpoint->sync_master = subs->sync_endpoint;
 485
 486         return 0;
 487 }
 488
 489 /*
 490  * find a matching format and set up the interface
 491  */
 492 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
 493 {
 494         struct usb_device *dev = subs->dev;
 495         struct usb_host_interface *alts;
 496         struct usb_interface_descriptor *altsd;
 497         struct usb_interface *iface;
 498         int err;
 499
 500         iface = usb_ifnum_to_if(dev, fmt->iface);
 501         if (WARN_ON(!iface))
 502                 return -EINVAL;
 503         alts = usb_altnum_to_altsetting(iface, fmt->altsetting);
 504         altsd = get_iface_desc(alts);
 505         if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
 506                 return -EINVAL;
 507
 508         if (fmt == subs->cur_audiofmt)
 509                 return 0;
 510
 511         /* close the old interface */
 512         if (subs->interface >= 0 && subs->interface != fmt->iface) {
 513                 if (!subs->stream->chip->keep_iface) {
 514                         err = usb_set_interface(subs->dev, subs->interface, 0);
 515                         if (err < 0) {
 516                                 dev_err(&dev->dev,
 517                                         "%d:%d: return to setting 0 failed (%d)\n",
 518                                         fmt->iface, fmt->altsetting, err);
 519                                 return -EIO;
 520                         }
 521                 }
 522                 subs->interface = -1;
 523                 subs->altset_idx = 0;
 524         }
 525
 526         /* set interface */
 527         if (iface->cur_altsetting != alts) {
 528                 err = snd_usb_select_mode_quirk(subs, fmt);
 529                 if (err < 0)
 530                         return -EIO;
 531
 532                 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
 533                 if (err < 0) {
 534                         dev_err(&dev->dev,
 535                                 "%d:%d: usb_set_interface failed (%d)\n",
 536                                 fmt->iface, fmt->altsetting, err);
 537                         return -EIO;
 538                 }
 539                 dev_dbg(&dev->dev, "setting usb interface %d:%d\n",
 540                         fmt->iface, fmt->altsetting);
 541                 snd_usb_set_interface_quirk(dev);
 542         }
 543
 544         subs->interface = fmt->iface;
 545         subs->altset_idx = fmt->altset_idx;
 546         subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
 547                                                    alts, fmt->endpoint, subs->direction,
 548                                                    SND_USB_ENDPOINT_TYPE_DATA);
 549
 550         if (!subs->data_endpoint)
 551                 return -EINVAL;
 552
 553         err = set_sync_endpoint(subs, fmt, dev, alts, altsd);
 554         if (err < 0)
 555                 return err;
 556
 557         err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt);
 558         if (err < 0)
 559                 return err;
 560
 561         subs->cur_audiofmt = fmt;
 562
 563         snd_usb_set_format_quirk(subs, fmt);
 564
 565         return 0;
 566 }
 567
 568 /*
 569  * Return the score of matching two audioformats.
 570  * Veto the audioformat if:
 571  * - It has no channels for some reason.
 572  * - Requested PCM format is not supported.
 573  * - Requested sample rate is not supported.
 574  */
 575 static int match_endpoint_audioformats(struct snd_usb_substream *subs,
 576                                        struct audioformat *fp,
 577                                        struct audioformat *match, int rate,
 578                                        snd_pcm_format_t pcm_format)
 579 {
 580         int i;
 581         int score = 0;
 582
 583         if (fp->channels < 1) {
 584                 dev_dbg(&subs->dev->dev,
 585                         "%s: (fmt @%p) no channels\n", __func__, fp);
 586                 return 0;
 587         }
 588
 589         if (!(fp->formats & pcm_format_to_bits(pcm_format))) {
 590                 dev_dbg(&subs->dev->dev,
 591                         "%s: (fmt @%p) no match for format %d\n", __func__,
 592                         fp, pcm_format);
 593                 return 0;
 594         }
 595
 596         for (i = 0; i < fp->nr_rates; i++) {
 597                 if (fp->rate_table[i] == rate) {
 598                         score++;
 599                         break;
 600                 }
 601         }
 602         if (!score) {
 603                 dev_dbg(&subs->dev->dev,
 604                         "%s: (fmt @%p) no match for rate %d\n", __func__,
 605                         fp, rate);
 606                 return 0;
 607         }
 608
 609         if (fp->channels == match->channels)
 610                 score++;
 611
 612         dev_dbg(&subs->dev->dev,
 613                 "%s: (fmt @%p) score %d\n", __func__, fp, score);
 614
 615         return score;
 616 }
 617
 618 /*
 619  * Configure the sync ep using the rate and pcm format of the data ep.
 620  */
 621 static int configure_sync_endpoint(struct snd_usb_substream *subs)
 622 {
 623         int ret;
 624         struct audioformat *fp;
 625         struct audioformat *sync_fp = NULL;
 626         int cur_score = 0;
 627         int sync_period_bytes = subs->period_bytes;
 628         struct snd_usb_substream *sync_subs =
 629                 &subs->stream->substream[subs->direction ^ 1];
 630
 631         if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
 632             !subs->stream)
 633                 return snd_usb_endpoint_set_params(subs->sync_endpoint,
 634                                                    subs->pcm_format,
 635                                                    subs->channels,
 636                                                    subs->period_bytes,
 637                                                    0, 0,
 638                                                    subs->cur_rate,
 639                                                    subs->cur_audiofmt,
 640                                                    NULL);
 641
 642         /* Try to find the best matching audioformat. */
 643         list_for_each_entry(fp, &sync_subs->fmt_list, list) {
 644                 int score = match_endpoint_audioformats(subs,
 645                                                         fp, subs->cur_audiofmt,
 646                         subs->cur_rate, subs->pcm_format);
 647
 648                 if (score > cur_score) {
 649                         sync_fp = fp;
 650                         cur_score = score;
 651                 }
 652         }
 653
 654         if (unlikely(sync_fp == NULL)) {
 655                 dev_err(&subs->dev->dev,
 656                         "%s: no valid audioformat for sync ep %x found\n",
 657                         __func__, sync_subs->ep_num);
 658                 return -EINVAL;
 659         }
 660
 661         /*
 662          * Recalculate the period bytes if channel number differ between
 663          * data and sync ep audioformat.
 664          */
 665         if (sync_fp->channels != subs->channels) {
 666                 sync_period_bytes = (subs->period_bytes / subs->channels) *
 667                         sync_fp->channels;
 668                 dev_dbg(&subs->dev->dev,
 669                         "%s: adjusted sync ep period bytes (%d -> %d)\n",
 670                         __func__, subs->period_bytes, sync_period_bytes);
 671         }
 672
 673         ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
 674                                           subs->pcm_format,
 675                                           sync_fp->channels,
 676                                           sync_period_bytes,
 677                                           0, 0,
 678                                           subs->cur_rate,
 679                                           sync_fp,
 680                                           NULL);
 681
 682         return ret;
 683 }
 684
 685 /*
 686  * configure endpoint params
 687  *
 688  * called  during initial setup and upon resume
 689  */
 690 static int configure_endpoint(struct snd_usb_substream *subs)
 691 {
 692         int ret;
 693
 694         /* format changed */
 695         stop_endpoints(subs, true);
 696         ret = snd_usb_endpoint_set_params(subs->data_endpoint,
 697                                           subs->pcm_format,
 698                                           subs->channels,
 699                                           subs->period_bytes,
 700                                           subs->period_frames,
 701                                           subs->buffer_periods,
 702                                           subs->cur_rate,
 703                                           subs->cur_audiofmt,
 704                                           subs->sync_endpoint);
 705         if (ret < 0)
 706                 return ret;
 707
 708         if (subs->sync_endpoint)
 709                 ret = configure_sync_endpoint(subs);
 710
 711         return ret;
 712 }
 713
 714 /*
 715  * hw_params callback
 716  *
 717  * allocate a buffer and set the given audio format.
 718  *
 719  * so far we use a physically linear buffer although packetize transfer
 720  * doesn't need a continuous area.
 721  * if sg buffer is supported on the later version of alsa, we'll follow
 722  * that.
 723  */
 724 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
 725                              struct snd_pcm_hw_params *hw_params)
 726 {
 727         struct snd_usb_substream *subs = substream->runtime->private_data;
 728         struct audioformat *fmt;
 729         int ret;
 730
 731         if (snd_usb_use_vmalloc)
 732                 ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
 733                                                        params_buffer_bytes(hw_params));
 734         else
 735                 ret = snd_pcm_lib_malloc_pages(substream,
 736                                                params_buffer_bytes(hw_params));
 737         if (ret < 0)
 738                 return ret;
 739
 740         subs->pcm_format = params_format(hw_params);
 741         subs->period_bytes = params_period_bytes(hw_params);
 742         subs->period_frames = params_period_size(hw_params);
 743         subs->buffer_periods = params_periods(hw_params);
 744         subs->channels = params_channels(hw_params);
 745         subs->cur_rate = params_rate(hw_params);
 746
 747         fmt = find_format(subs);
 748         if (!fmt) {
 749                 dev_dbg(&subs->dev->dev,
 750                         "cannot set format: format = %#x, rate = %d, channels = %d\n",
 751                            subs->pcm_format, subs->cur_rate, subs->channels);
 752                 return -EINVAL;
 753         }
 754
 755         ret = snd_usb_lock_shutdown(subs->stream->chip);
 756         if (ret < 0)
 757                 return ret;
 758         ret = set_format(subs, fmt);
 759         snd_usb_unlock_shutdown(subs->stream->chip);
 760         if (ret < 0)
 761                 return ret;
 762
 763         subs->interface = fmt->iface;
 764         subs->altset_idx = fmt->altset_idx;
 765         subs->need_setup_ep = true;
 766
 767         return 0;
 768 }
 769
 770 /*
 771  * hw_free callback
 772  *
 773  * reset the audio format and release the buffer
 774  */
 775 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
 776 {
 777         struct snd_usb_substream *subs = substream->runtime->private_data;
 778
 779         subs->cur_audiofmt = NULL;
 780         subs->cur_rate = 0;
 781         subs->period_bytes = 0;
 782         if (!snd_usb_lock_shutdown(subs->stream->chip)) {
 783                 stop_endpoints(subs, true);
 784                 snd_usb_endpoint_deactivate(subs->sync_endpoint);
 785                 snd_usb_endpoint_deactivate(subs->data_endpoint);
 786                 snd_usb_unlock_shutdown(subs->stream->chip);
 787         }
 788
 789         if (snd_usb_use_vmalloc)
 790                 return snd_pcm_lib_free_vmalloc_buffer(substream);
 791         else
 792                 return snd_pcm_lib_free_pages(substream);
 793 }
 794
 795 /*
 796  * prepare callback
 797  *
 798  * only a few subtle things...
 799  */
 800 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
 801 {
 802         struct snd_pcm_runtime *runtime = substream->runtime;
 803         struct snd_usb_substream *subs = runtime->private_data;
 804         struct usb_host_interface *alts;
 805         struct usb_interface *iface;
 806         int ret;
 807
 808         if (! subs->cur_audiofmt) {
 809                 dev_err(&subs->dev->dev, "no format is specified!\n");
 810                 return -ENXIO;
 811         }
 812
 813         ret = snd_usb_lock_shutdown(subs->stream->chip);
 814         if (ret < 0)
 815                 return ret;
 816         if (snd_BUG_ON(!subs->data_endpoint)) {
 817                 ret = -EIO;
 818                 goto unlock;
 819         }
 820
 821         snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
 822         snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
 823
 824         ret = set_format(subs, subs->cur_audiofmt);
 825         if (ret < 0)
 826                 goto unlock;
 827
 828         if (subs->need_setup_ep) {
 829
 830                 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
 831                 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
 832                 ret = snd_usb_init_sample_rate(subs->stream->chip,
 833                                                subs->cur_audiofmt->iface,
 834                                                alts,
 835                                                subs->cur_audiofmt,
 836                                                subs->cur_rate);
 837                 if (ret < 0)
 838                         goto unlock;
 839
 840                 ret = configure_endpoint(subs);
 841                 if (ret < 0)
 842                         goto unlock;
 843                 subs->need_setup_ep = false;
 844         }
 845
 846         /* some unit conversions in runtime */
 847         subs->data_endpoint->maxframesize =
 848                 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
 849         subs->data_endpoint->curframesize =
 850                 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
 851
 852         /* reset the pointer */
 853         subs->hwptr_done = 0;
 854         subs->transfer_done = 0;
 855         subs->last_delay = 0;
 856         subs->last_frame_number = 0;
 857         runtime->delay = 0;
 858
 859         /* for playback, submit the URBs now; otherwise, the first hwptr_done
 860          * updates for all URBs would happen at the same time when starting */
 861         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
 862                 ret = start_endpoints(subs);
 863
 864  unlock:
 865         snd_usb_unlock_shutdown(subs->stream->chip);
 866         return ret;
 867 }
 868
 869 static const struct snd_pcm_hardware snd_usb_hardware =
 870 {
 871         .info =                 SNDRV_PCM_INFO_MMAP |
 872                                 SNDRV_PCM_INFO_MMAP_VALID |
 873                                 SNDRV_PCM_INFO_BATCH |
 874                                 SNDRV_PCM_INFO_INTERLEAVED |
 875                                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
 876                                 SNDRV_PCM_INFO_PAUSE,
 877         .buffer_bytes_max =     1024 * 1024,
 878         .period_bytes_min =     64,
 879         .period_bytes_max =     512 * 1024,
 880         .periods_min =          2,
 881         .periods_max =          1024,
 882 };
 883
 884 static int hw_check_valid_format(struct snd_usb_substream *subs,
 885                                  struct snd_pcm_hw_params *params,
 886                                  struct audioformat *fp)
 887 {
 888         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 889         struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 890         struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 891         struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
 892         struct snd_mask check_fmts;
 893         unsigned int ptime;
 894
 895         /* check the format */
 896         snd_mask_none(&check_fmts);
 897         check_fmts.bits[0] = (u32)fp->formats;
 898         check_fmts.bits[1] = (u32)(fp->formats >> 32);
 899         snd_mask_intersect(&check_fmts, fmts);
 900         if (snd_mask_empty(&check_fmts)) {
 901                 hwc_debug("   > check: no supported format %d\n", fp->format);
 902                 return 0;
 903         }
 904         /* check the channels */
 905         if (fp->channels < ct->min || fp->channels > ct->max) {
 906                 hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
 907                 return 0;
 908         }
 909         /* check the rate is within the range */
 910         if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
 911                 hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
 912                 return 0;
 913         }
 914         if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
 915                 hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
 916                 return 0;
 917         }
 918         /* check whether the period time is >= the data packet interval */
 919         if (subs->speed != USB_SPEED_FULL) {
 920                 ptime = 125 * (1 << fp->datainterval);
 921                 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
 922                         hwc_debug("   > check: ptime %u > max %u\n", ptime, pt->max);
 923                         return 0;
 924                 }
 925         }
 926         return 1;
 927 }
 928
 929 static int hw_rule_rate(struct snd_pcm_hw_params *params,
 930                         struct snd_pcm_hw_rule *rule)
 931 {
 932         struct snd_usb_substream *subs = rule->private;
 933         struct audioformat *fp;
 934         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 935         unsigned int rmin, rmax;
 936         int changed;
 937
 938         hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
 939         changed = 0;
 940         rmin = rmax = 0;
 941         list_for_each_entry(fp, &subs->fmt_list, list) {
 942                 if (!hw_check_valid_format(subs, params, fp))
 943                         continue;
 944                 if (changed++) {
 945                         if (rmin > fp->rate_min)
 946                                 rmin = fp->rate_min;
 947                         if (rmax < fp->rate_max)
 948                                 rmax = fp->rate_max;
 949                 } else {
 950                         rmin = fp->rate_min;
 951                         rmax = fp->rate_max;
 952                 }
 953         }
 954
 955         if (!changed) {
 956                 hwc_debug("  --> get empty\n");
 957                 it->empty = 1;
 958                 return -EINVAL;
 959         }
 960
 961         changed = 0;
 962         if (it->min < rmin) {
 963                 it->min = rmin;
 964                 it->openmin = 0;
 965                 changed = 1;
 966         }
 967         if (it->max > rmax) {
 968                 it->max = rmax;
 969                 it->openmax = 0;
 970                 changed = 1;
 971         }
 972         if (snd_interval_checkempty(it)) {
 973                 it->empty = 1;
 974                 return -EINVAL;
 975         }
 976         hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
 977         return changed;
 978 }
 979
 980
 981 static int hw_rule_channels(struct snd_pcm_hw_params *params,
 982                             struct snd_pcm_hw_rule *rule)
 983 {
 984         struct snd_usb_substream *subs = rule->private;
 985         struct audioformat *fp;
 986         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 987         unsigned int rmin, rmax;
 988         int changed;
 989
 990         hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
 991         changed = 0;
 992         rmin = rmax = 0;
 993         list_for_each_entry(fp, &subs->fmt_list, list) {
 994                 if (!hw_check_valid_format(subs, params, fp))
 995                         continue;
 996                 if (changed++) {
 997                         if (rmin > fp->channels)
 998                                 rmin = fp->channels;
 999                         if (rmax < fp->channels)
1000                                 rmax = fp->channels;
1001                 } else {
1002                         rmin = fp->channels;
1003                         rmax = fp->channels;
1004                 }
1005         }
1006
1007         if (!changed) {
1008                 hwc_debug("  --> get empty\n");
1009                 it->empty = 1;
1010                 return -EINVAL;
1011         }
1012
1013         changed = 0;
1014         if (it->min < rmin) {
1015                 it->min = rmin;
1016                 it->openmin = 0;
1017                 changed = 1;
1018         }
1019         if (it->max > rmax) {
1020                 it->max = rmax;
1021                 it->openmax = 0;
1022                 changed = 1;
1023         }
1024         if (snd_interval_checkempty(it)) {
1025                 it->empty = 1;
1026                 return -EINVAL;
1027         }
1028         hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1029         return changed;
1030 }
1031
1032 static int hw_rule_format(struct snd_pcm_hw_params *params,
1033                           struct snd_pcm_hw_rule *rule)
1034 {
1035         struct snd_usb_substream *subs = rule->private;
1036         struct audioformat *fp;
1037         struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1038         u64 fbits;
1039         u32 oldbits[2];
1040         int changed;
1041
1042         hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1043         fbits = 0;
1044         list_for_each_entry(fp, &subs->fmt_list, list) {
1045                 if (!hw_check_valid_format(subs, params, fp))
1046                         continue;
1047                 fbits |= fp->formats;
1048         }
1049
1050         oldbits[0] = fmt->bits[0];
1051         oldbits[1] = fmt->bits[1];
1052         fmt->bits[0] &= (u32)fbits;
1053         fmt->bits[1] &= (u32)(fbits >> 32);
1054         if (!fmt->bits[0] && !fmt->bits[1]) {
1055                 hwc_debug("  --> get empty\n");
1056                 return -EINVAL;
1057         }
1058         changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1059         hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1060         return changed;
1061 }
1062
1063 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
1064                                struct snd_pcm_hw_rule *rule)
1065 {
1066         struct snd_usb_substream *subs = rule->private;
1067         struct audioformat *fp;
1068         struct snd_interval *it;
1069         unsigned char min_datainterval;
1070         unsigned int pmin;
1071         int changed;
1072
1073         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
1074         hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
1075         min_datainterval = 0xff;
1076         list_for_each_entry(fp, &subs->fmt_list, list) {
1077                 if (!hw_check_valid_format(subs, params, fp))
1078                         continue;
1079                 min_datainterval = min(min_datainterval, fp->datainterval);
1080         }
1081         if (min_datainterval == 0xff) {
1082                 hwc_debug("  --> get empty\n");
1083                 it->empty = 1;
1084                 return -EINVAL;
1085         }
1086         pmin = 125 * (1 << min_datainterval);
1087         changed = 0;
1088         if (it->min < pmin) {
1089                 it->min = pmin;
1090                 it->openmin = 0;
1091                 changed = 1;
1092         }
1093         if (snd_interval_checkempty(it)) {
1094                 it->empty = 1;
1095                 return -EINVAL;
1096         }
1097         hwc_debug("  --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
1098         return changed;
1099 }
1100
1101 /*
1102  *  If the device supports unusual bit rates, does the request meet these?
1103  */
1104 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1105                                   struct snd_usb_substream *subs)
1106 {
1107         struct audioformat *fp;
1108         int *rate_list;
1109         int count = 0, needs_knot = 0;
1110         int err;
1111
1112         kfree(subs->rate_list.list);
1113         subs->rate_list.list = NULL;
1114
1115         list_for_each_entry(fp, &subs->fmt_list, list) {
1116                 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1117                         return 0;
1118                 count += fp->nr_rates;
1119                 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1120                         needs_knot = 1;
1121         }
1122         if (!needs_knot)
1123                 return 0;
1124
1125         subs->rate_list.list = rate_list =
1126                 kmalloc(sizeof(int) * count, GFP_KERNEL);
1127         if (!subs->rate_list.list)
1128                 return -ENOMEM;
1129         subs->rate_list.count = count;
1130         subs->rate_list.mask = 0;
1131         count = 0;
1132         list_for_each_entry(fp, &subs->fmt_list, list) {
1133                 int i;
1134                 for (i = 0; i < fp->nr_rates; i++)
1135                         rate_list[count++] = fp->rate_table[i];
1136         }
1137         err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1138                                          &subs->rate_list);
1139         if (err < 0)
1140                 return err;
1141
1142         return 0;
1143 }
1144
1145
1146 /*
1147  * set up the runtime hardware information.
1148  */
1149
1150 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1151 {
1152         struct audioformat *fp;
1153         unsigned int pt, ptmin;
1154         int param_period_time_if_needed;
1155         int err;
1156
1157         runtime->hw.formats = subs->formats;
1158
1159         runtime->hw.rate_min = 0x7fffffff;
1160         runtime->hw.rate_max = 0;
1161         runtime->hw.channels_min = 256;
1162         runtime->hw.channels_max = 0;
1163         runtime->hw.rates = 0;
1164         ptmin = UINT_MAX;
1165         /* check min/max rates and channels */
1166         list_for_each_entry(fp, &subs->fmt_list, list) {
1167                 runtime->hw.rates |= fp->rates;
1168                 if (runtime->hw.rate_min > fp->rate_min)
1169                         runtime->hw.rate_min = fp->rate_min;
1170                 if (runtime->hw.rate_max < fp->rate_max)
1171                         runtime->hw.rate_max = fp->rate_max;
1172                 if (runtime->hw.channels_min > fp->channels)
1173                         runtime->hw.channels_min = fp->channels;
1174                 if (runtime->hw.channels_max < fp->channels)
1175                         runtime->hw.channels_max = fp->channels;
1176                 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1177                         /* FIXME: there might be more than one audio formats... */
1178                         runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1179                                 fp->frame_size;
1180                 }
1181                 pt = 125 * (1 << fp->datainterval);
1182                 ptmin = min(ptmin, pt);
1183         }
1184
1185         param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1186         if (subs->speed == USB_SPEED_FULL)
1187                 /* full speed devices have fixed data packet interval */
1188                 ptmin = 1000;
1189         if (ptmin == 1000)
1190                 /* if period time doesn't go below 1 ms, no rules needed */
1191                 param_period_time_if_needed = -1;
1192
1193         err = snd_pcm_hw_constraint_minmax(runtime,
1194                                            SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1195                                            ptmin, UINT_MAX);
1196         if (err < 0)
1197                 return err;
1198
1199         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1200                                   hw_rule_rate, subs,
1201                                   SNDRV_PCM_HW_PARAM_FORMAT,
1202                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1203                                   param_period_time_if_needed,
1204                                   -1);
1205         if (err < 0)
1206                 return err;
1207         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1208                                   hw_rule_channels, subs,
1209                                   SNDRV_PCM_HW_PARAM_FORMAT,
1210                                   SNDRV_PCM_HW_PARAM_RATE,
1211                                   param_period_time_if_needed,
1212                                   -1);
1213         if (err < 0)
1214                 return err;
1215         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1216                                   hw_rule_format, subs,
1217                                   SNDRV_PCM_HW_PARAM_RATE,
1218                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1219                                   param_period_time_if_needed,
1220                                   -1);
1221         if (err < 0)
1222                 return err;
1223         if (param_period_time_if_needed >= 0) {
1224                 err = snd_pcm_hw_rule_add(runtime, 0,
1225                                           SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1226                                           hw_rule_period_time, subs,
1227                                           SNDRV_PCM_HW_PARAM_FORMAT,
1228                                           SNDRV_PCM_HW_PARAM_CHANNELS,
1229                                           SNDRV_PCM_HW_PARAM_RATE,
1230                                           -1);
1231                 if (err < 0)
1232                         return err;
1233         }
1234         err = snd_usb_pcm_check_knot(runtime, subs);
1235         if (err < 0)
1236                 return err;
1237
1238         return snd_usb_autoresume(subs->stream->chip);
1239 }
1240
1241 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1242 {
1243         int direction = substream->stream;
1244         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1245         struct snd_pcm_runtime *runtime = substream->runtime;
1246         struct snd_usb_substream *subs = &as->substream[direction];
1247
1248         subs->interface = -1;
1249         subs->altset_idx = 0;
1250         runtime->hw = snd_usb_hardware;
1251         runtime->private_data = subs;
1252         subs->pcm_substream = substream;
1253         /* runtime PM is also done there */
1254
1255         /* initialize DSD/DOP context */
1256         subs->dsd_dop.byte_idx = 0;
1257         subs->dsd_dop.channel = 0;
1258         subs->dsd_dop.marker = 1;
1259
1260         return setup_hw_info(runtime, subs);
1261 }
1262
1263 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1264 {
1265         int direction = substream->stream;
1266         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1267         struct snd_usb_substream *subs = &as->substream[direction];
1268
1269         stop_endpoints(subs, true);
1270
1271         if (!as->chip->keep_iface &&
1272             subs->interface >= 0 &&
1273             !snd_usb_lock_shutdown(subs->stream->chip)) {
1274                 usb_set_interface(subs->dev, subs->interface, 0);
1275                 subs->interface = -1;
1276                 snd_usb_unlock_shutdown(subs->stream->chip);
1277         }
1278
1279         subs->pcm_substream = NULL;
1280         snd_usb_autosuspend(subs->stream->chip);
1281
1282         return 0;
1283 }
1284
1285 /* Since a URB can handle only a single linear buffer, we must use double
1286  * buffering when the data to be transferred overflows the buffer boundary.
1287  * To avoid inconsistencies when updating hwptr_done, we use double buffering
1288  * for all URBs.
1289  */
1290 static void retire_capture_urb(struct snd_usb_substream *subs,
1291                                struct urb *urb)
1292 {
1293         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1294         unsigned int stride, frames, bytes, oldptr;
1295         int i, period_elapsed = 0;
1296         unsigned long flags;
1297         unsigned char *cp;
1298         int current_frame_number;
1299
1300         /* read frame number here, update pointer in critical section */
1301         current_frame_number = usb_get_current_frame_number(subs->dev);
1302
1303         stride = runtime->frame_bits >> 3;
1304
1305         for (i = 0; i < urb->number_of_packets; i++) {
1306                 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1307                 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1308                         dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1309                                 i, urb->iso_frame_desc[i].status);
1310                         // continue;
1311                 }
1312                 bytes = urb->iso_frame_desc[i].actual_length;
1313                 frames = bytes / stride;
1314                 if (!subs->txfr_quirk)
1315                         bytes = frames * stride;
1316                 if (bytes % (runtime->sample_bits >> 3) != 0) {
1317                         int oldbytes = bytes;
1318                         bytes = frames * stride;
1319                         dev_warn_ratelimited(&subs->dev->dev,
1320                                  "Corrected urb data len. %d->%d\n",
1321                                                         oldbytes, bytes);
1322                 }
1323                 /* update the current pointer */
1324                 spin_lock_irqsave(&subs->lock, flags);
1325                 oldptr = subs->hwptr_done;
1326                 subs->hwptr_done += bytes;
1327                 if (subs->hwptr_done >= runtime->buffer_size * stride)
1328                         subs->hwptr_done -= runtime->buffer_size * stride;
1329                 frames = (bytes + (oldptr % stride)) / stride;
1330                 subs->transfer_done += frames;
1331                 if (subs->transfer_done >= runtime->period_size) {
1332                         subs->transfer_done -= runtime->period_size;
1333                         period_elapsed = 1;
1334                 }
1335                 /* capture delay is by construction limited to one URB,
1336                  * reset delays here
1337                  */
1338                 runtime->delay = subs->last_delay = 0;
1339
1340                 /* realign last_frame_number */
1341                 subs->last_frame_number = current_frame_number;
1342                 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1343
1344                 spin_unlock_irqrestore(&subs->lock, flags);
1345                 /* copy a data chunk */
1346                 if (oldptr + bytes > runtime->buffer_size * stride) {
1347                         unsigned int bytes1 =
1348                                         runtime->buffer_size * stride - oldptr;
1349                         memcpy(runtime->dma_area + oldptr, cp, bytes1);
1350                         memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1351                 } else {
1352                         memcpy(runtime->dma_area + oldptr, cp, bytes);
1353                 }
1354         }
1355
1356         if (period_elapsed)
1357                 snd_pcm_period_elapsed(subs->pcm_substream);
1358 }
1359
1360 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1361                                              struct urb *urb, unsigned int bytes)
1362 {
1363         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1364         unsigned int stride = runtime->frame_bits >> 3;
1365         unsigned int dst_idx = 0;
1366         unsigned int src_idx = subs->hwptr_done;
1367         unsigned int wrap = runtime->buffer_size * stride;
1368         u8 *dst = urb->transfer_buffer;
1369         u8 *src = runtime->dma_area;
1370         u8 marker[] = { 0x05, 0xfa };
1371
1372         /*
1373          * The DSP DOP format defines a way to transport DSD samples over
1374          * normal PCM data endpoints. It requires stuffing of marker bytes
1375          * (0x05 and 0xfa, alternating per sample frame), and then expects
1376          * 2 additional bytes of actual payload. The whole frame is stored
1377          * LSB.
1378          *
1379          * Hence, for a stereo transport, the buffer layout looks like this,
1380          * where L refers to left channel samples and R to right.
1381          *
1382          *   L1 L2 0x05   R1 R2 0x05   L3 L4 0xfa  R3 R4 0xfa
1383          *   L5 L6 0x05   R5 R6 0x05   L7 L8 0xfa  R7 R8 0xfa
1384          *   .....
1385          *
1386          */
1387
1388         while (bytes--) {
1389                 if (++subs->dsd_dop.byte_idx == 3) {
1390                         /* frame boundary? */
1391                         dst[dst_idx++] = marker[subs->dsd_dop.marker];
1392                         src_idx += 2;
1393                         subs->dsd_dop.byte_idx = 0;
1394
1395                         if (++subs->dsd_dop.channel % runtime->channels == 0) {
1396                                 /* alternate the marker */
1397                                 subs->dsd_dop.marker++;
1398                                 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1399                                 subs->dsd_dop.channel = 0;
1400                         }
1401                 } else {
1402                         /* stuff the DSD payload */
1403                         int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1404
1405                         if (subs->cur_audiofmt->dsd_bitrev)
1406                                 dst[dst_idx++] = bitrev8(src[idx]);
1407                         else
1408                                 dst[dst_idx++] = src[idx];
1409
1410                         subs->hwptr_done++;
1411                 }
1412         }
1413         if (subs->hwptr_done >= runtime->buffer_size * stride)
1414                 subs->hwptr_done -= runtime->buffer_size * stride;
1415 }
1416
1417 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1418                         int offset, int stride, unsigned int bytes)
1419 {
1420         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1421
1422         if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1423                 /* err, the transferred area goes over buffer boundary. */
1424                 unsigned int bytes1 =
1425                         runtime->buffer_size * stride - subs->hwptr_done;
1426                 memcpy(urb->transfer_buffer + offset,
1427                        runtime->dma_area + subs->hwptr_done, bytes1);
1428                 memcpy(urb->transfer_buffer + offset + bytes1,
1429                        runtime->dma_area, bytes - bytes1);
1430         } else {
1431                 memcpy(urb->transfer_buffer + offset,
1432                        runtime->dma_area + subs->hwptr_done, bytes);
1433         }
1434         subs->hwptr_done += bytes;
1435         if (subs->hwptr_done >= runtime->buffer_size * stride)
1436                 subs->hwptr_done -= runtime->buffer_size * stride;
1437 }
1438
1439 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1440                                       struct urb *urb, int stride,
1441                                       unsigned int bytes)
1442 {
1443         __le32 packet_length;
1444         int i;
1445
1446         /* Put __le32 length descriptor at start of each packet. */
1447         for (i = 0; i < urb->number_of_packets; i++) {
1448                 unsigned int length = urb->iso_frame_desc[i].length;
1449                 unsigned int offset = urb->iso_frame_desc[i].offset;
1450
1451                 packet_length = cpu_to_le32(length);
1452                 offset += i * sizeof(packet_length);
1453                 urb->iso_frame_desc[i].offset = offset;
1454                 urb->iso_frame_desc[i].length += sizeof(packet_length);
1455                 memcpy(urb->transfer_buffer + offset,
1456                        &packet_length, sizeof(packet_length));
1457                 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1458                             stride, length);
1459         }
1460         /* Adjust transfer size accordingly. */
1461         bytes += urb->number_of_packets * sizeof(packet_length);
1462         return bytes;
1463 }
1464
1465 static void prepare_playback_urb(struct snd_usb_substream *subs,
1466                                  struct urb *urb)
1467 {
1468         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1469         struct snd_usb_endpoint *ep = subs->data_endpoint;
1470         struct snd_urb_ctx *ctx = urb->context;
1471         unsigned int counts, frames, bytes;
1472         int i, stride, period_elapsed = 0;
1473         unsigned long flags;
1474
1475         stride = runtime->frame_bits >> 3;
1476
1477         frames = 0;
1478         urb->number_of_packets = 0;
1479         spin_lock_irqsave(&subs->lock, flags);
1480         subs->frame_limit += ep->max_urb_frames;
1481         for (i = 0; i < ctx->packets; i++) {
1482                 if (ctx->packet_size[i])
1483                         counts = ctx->packet_size[i];
1484                 else
1485                         counts = snd_usb_endpoint_next_packet_size(ep);
1486
1487                 /* set up descriptor */
1488                 urb->iso_frame_desc[i].offset = frames * ep->stride;
1489                 urb->iso_frame_desc[i].length = counts * ep->stride;
1490                 frames += counts;
1491                 urb->number_of_packets++;
1492                 subs->transfer_done += counts;
1493                 if (subs->transfer_done >= runtime->period_size) {
1494                         subs->transfer_done -= runtime->period_size;
1495                         subs->frame_limit = 0;
1496                         period_elapsed = 1;
1497                         if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1498                                 if (subs->transfer_done > 0) {
1499                                         /* FIXME: fill-max mode is not
1500                                          * supported yet */
1501                                         frames -= subs->transfer_done;
1502                                         counts -= subs->transfer_done;
1503                                         urb->iso_frame_desc[i].length =
1504                                                 counts * ep->stride;
1505                                         subs->transfer_done = 0;
1506                                 }
1507                                 i++;
1508                                 if (i < ctx->packets) {
1509                                         /* add a transfer delimiter */
1510                                         urb->iso_frame_desc[i].offset =
1511                                                 frames * ep->stride;
1512                                         urb->iso_frame_desc[i].length = 0;
1513                                         urb->number_of_packets++;
1514                                 }
1515                                 break;
1516                         }
1517                 }
1518                 /* finish at the period boundary or after enough frames */
1519                 if ((period_elapsed ||
1520                                 subs->transfer_done >= subs->frame_limit) &&
1521                     !snd_usb_endpoint_implicit_feedback_sink(ep))
1522                         break;
1523         }
1524         bytes = frames * ep->stride;
1525
1526         if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1527                      subs->cur_audiofmt->dsd_dop)) {
1528                 fill_playback_urb_dsd_dop(subs, urb, bytes);
1529         } else if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1530                            subs->cur_audiofmt->dsd_bitrev)) {
1531                 /* bit-reverse the bytes */
1532                 u8 *buf = urb->transfer_buffer;
1533                 for (i = 0; i < bytes; i++) {
1534                         int idx = (subs->hwptr_done + i)
1535                                 % (runtime->buffer_size * stride);
1536                         buf[i] = bitrev8(runtime->dma_area[idx]);
1537                 }
1538
1539                 subs->hwptr_done += bytes;
1540                 if (subs->hwptr_done >= runtime->buffer_size * stride)
1541                         subs->hwptr_done -= runtime->buffer_size * stride;
1542         } else {
1543                 /* usual PCM */
1544                 if (!subs->tx_length_quirk)
1545                         copy_to_urb(subs, urb, 0, stride, bytes);
1546                 else
1547                         bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1548                         /* bytes is now amount of outgoing data */
1549         }
1550
1551         /* update delay with exact number of samples queued */
1552         runtime->delay = subs->last_delay;
1553         runtime->delay += frames;
1554         subs->last_delay = runtime->delay;
1555
1556         /* realign last_frame_number */
1557         subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1558         subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1559
1560         if (subs->trigger_tstamp_pending_update) {
1561                 /* this is the first actual URB submitted,
1562                  * update trigger timestamp to reflect actual start time
1563                  */
1564                 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1565                 subs->trigger_tstamp_pending_update = false;
1566         }
1567
1568         spin_unlock_irqrestore(&subs->lock, flags);
1569         urb->transfer_buffer_length = bytes;
1570         if (period_elapsed)
1571                 snd_pcm_period_elapsed(subs->pcm_substream);
1572 }
1573
1574 /*
1575  * process after playback data complete
1576  * - decrease the delay count again
1577  */
1578 static void retire_playback_urb(struct snd_usb_substream *subs,
1579                                struct urb *urb)
1580 {
1581         unsigned long flags;
1582         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1583         struct snd_usb_endpoint *ep = subs->data_endpoint;
1584         int processed = urb->transfer_buffer_length / ep->stride;
1585         int est_delay;
1586
1587         /* ignore the delay accounting when procssed=0 is given, i.e.
1588          * silent payloads are procssed before handling the actual data
1589          */
1590         if (!processed)
1591                 return;
1592
1593         spin_lock_irqsave(&subs->lock, flags);
1594         if (!subs->last_delay)
1595                 goto out; /* short path */
1596
1597         est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1598         /* update delay with exact number of samples played */
1599         if (processed > subs->last_delay)
1600                 subs->last_delay = 0;
1601         else
1602                 subs->last_delay -= processed;
1603         runtime->delay = subs->last_delay;
1604
1605         /*
1606          * Report when delay estimate is off by more than 2ms.
1607          * The error should be lower than 2ms since the estimate relies
1608          * on two reads of a counter updated every ms.
1609          */
1610         if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1611                 dev_dbg_ratelimited(&subs->dev->dev,
1612                         "delay: estimated %d, actual %d\n",
1613                         est_delay, subs->last_delay);
1614
1615         if (!subs->running) {
1616                 /* update last_frame_number for delay counting here since
1617                  * prepare_playback_urb won't be called during pause
1618                  */
1619                 subs->last_frame_number =
1620                         usb_get_current_frame_number(subs->dev) & 0xff;
1621         }
1622
1623  out:
1624         spin_unlock_irqrestore(&subs->lock, flags);
1625 }
1626
1627 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1628                                               int cmd)
1629 {
1630         struct snd_usb_substream *subs = substream->runtime->private_data;
1631
1632         switch (cmd) {
1633         case SNDRV_PCM_TRIGGER_START:
1634                 subs->trigger_tstamp_pending_update = true;
1635         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1636                 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1637                 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1638                 subs->running = 1;
1639                 return 0;
1640         case SNDRV_PCM_TRIGGER_STOP:
1641                 stop_endpoints(subs, false);
1642                 subs->running = 0;
1643                 return 0;
1644         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1645                 subs->data_endpoint->prepare_data_urb = NULL;
1646                 /* keep retire_data_urb for delay calculation */
1647                 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1648                 subs->running = 0;
1649                 return 0;
1650         }
1651
1652         return -EINVAL;
1653 }
1654
1655 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1656                                              int cmd)
1657 {
1658         int err;
1659         struct snd_usb_substream *subs = substream->runtime->private_data;
1660
1661         switch (cmd) {
1662         case SNDRV_PCM_TRIGGER_START:
1663                 err = start_endpoints(subs);
1664                 if (err < 0)
1665                         return err;
1666
1667                 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1668                 subs->running = 1;
1669                 return 0;
1670         case SNDRV_PCM_TRIGGER_STOP:
1671                 stop_endpoints(subs, false);
1672                 subs->running = 0;
1673                 return 0;
1674         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1675                 subs->data_endpoint->retire_data_urb = NULL;
1676                 subs->running = 0;
1677                 return 0;
1678         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1679                 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1680                 subs->running = 1;
1681                 return 0;
1682         }
1683
1684         return -EINVAL;
1685 }
1686
1687 static const struct snd_pcm_ops snd_usb_playback_ops = {
1688         .open =         snd_usb_pcm_open,
1689         .close =        snd_usb_pcm_close,
1690         .ioctl =        snd_pcm_lib_ioctl,
1691         .hw_params =    snd_usb_hw_params,
1692         .hw_free =      snd_usb_hw_free,
1693         .prepare =      snd_usb_pcm_prepare,
1694         .trigger =      snd_usb_substream_playback_trigger,
1695         .pointer =      snd_usb_pcm_pointer,
1696         .page =         snd_pcm_lib_get_vmalloc_page,
1697         .mmap =         snd_pcm_lib_mmap_vmalloc,
1698 };
1699
1700 static const struct snd_pcm_ops snd_usb_capture_ops = {
1701         .open =         snd_usb_pcm_open,
1702         .close =        snd_usb_pcm_close,
1703         .ioctl =        snd_pcm_lib_ioctl,
1704         .hw_params =    snd_usb_hw_params,
1705         .hw_free =      snd_usb_hw_free,
1706         .prepare =      snd_usb_pcm_prepare,
1707         .trigger =      snd_usb_substream_capture_trigger,
1708         .pointer =      snd_usb_pcm_pointer,
1709         .page =         snd_pcm_lib_get_vmalloc_page,
1710         .mmap =         snd_pcm_lib_mmap_vmalloc,
1711 };
1712
1713 static const struct snd_pcm_ops snd_usb_playback_dev_ops = {
1714         .open =         snd_usb_pcm_open,
1715         .close =        snd_usb_pcm_close,
1716         .ioctl =        snd_pcm_lib_ioctl,
1717         .hw_params =    snd_usb_hw_params,
1718         .hw_free =      snd_usb_hw_free,
1719         .prepare =      snd_usb_pcm_prepare,
1720         .trigger =      snd_usb_substream_playback_trigger,
1721         .pointer =      snd_usb_pcm_pointer,
1722         .page =         snd_pcm_sgbuf_ops_page,
1723 };
1724
1725 static const struct snd_pcm_ops snd_usb_capture_dev_ops = {
1726         .open =         snd_usb_pcm_open,
1727         .close =        snd_usb_pcm_close,
1728         .ioctl =        snd_pcm_lib_ioctl,
1729         .hw_params =    snd_usb_hw_params,
1730         .hw_free =      snd_usb_hw_free,
1731         .prepare =      snd_usb_pcm_prepare,
1732         .trigger =      snd_usb_substream_capture_trigger,
1733         .pointer =      snd_usb_pcm_pointer,
1734         .page =         snd_pcm_sgbuf_ops_page,
1735 };
1736
1737 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1738 {
1739         const struct snd_pcm_ops *ops;
1740
1741         if (snd_usb_use_vmalloc)
1742                 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1743                         &snd_usb_playback_ops : &snd_usb_capture_ops;
1744         else
1745                 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1746                         &snd_usb_playback_dev_ops : &snd_usb_capture_dev_ops;
1747         snd_pcm_set_ops(pcm, stream, ops);
1748 }
1749
1750 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1751 {
1752         struct snd_pcm *pcm = subs->stream->pcm;
1753         struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1754         struct device *dev = subs->dev->bus->controller;
1755
1756         if (!snd_usb_use_vmalloc)
1757                 snd_pcm_lib_preallocate_pages(s, SNDRV_DMA_TYPE_DEV_SG,
1758                                               dev, 64*1024, 512*1024);
1759 }