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