sound/usb/pcm.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  */
   4
   5 #include <linux/init.h>
   6 #include <linux/slab.h>
   7 #include <linux/bitrev.h>
   8 #include <linux/ratelimit.h>
   9 #include <linux/usb.h>
  10 #include <linux/usb/audio.h>
  11 #include <linux/usb/audio-v2.h>
  12
  13 #include <sound/core.h>
  14 #include <sound/pcm.h>
  15 #include <sound/pcm_params.h>
  16
  17 #include "usbaudio.h"
  18 #include "card.h"
  19 #include "quirks.h"
  20 #include "endpoint.h"
  21 #include "helper.h"
  22 #include "pcm.h"
  23 #include "clock.h"
  24 #include "power.h"
  25 #include "media.h"
  26 #include "implicit.h"
  27
  28 #define SUBSTREAM_FLAG_DATA_EP_STARTED  0
  29 #define SUBSTREAM_FLAG_SYNC_EP_STARTED  1
  30
  31 /* return the estimated delay based on USB frame counters */
  32 static snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
  33                                            struct snd_pcm_runtime *runtime)
  34 {
  35         unsigned int current_frame_number;
  36         unsigned int frame_diff;
  37         int est_delay;
  38         int queued;
  39
  40         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
  41                 queued = bytes_to_frames(runtime, subs->inflight_bytes);
  42                 if (!queued)
  43                         return 0;
  44         } else if (!subs->running) {
  45                 return 0;
  46         }
  47
  48         current_frame_number = usb_get_current_frame_number(subs->dev);
  49         /*
  50          * HCD implementations use different widths, use lower 8 bits.
  51          * The delay will be managed up to 256ms, which is more than
  52          * enough
  53          */
  54         frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
  55
  56         /* Approximation based on number of samples per USB frame (ms),
  57            some truncation for 44.1 but the estimate is good enough */
  58         est_delay = frame_diff * runtime->rate / 1000;
  59
  60         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
  61                 est_delay = queued - est_delay;
  62                 if (est_delay < 0)
  63                         est_delay = 0;
  64         }
  65
  66         return est_delay;
  67 }
  68
  69 /*
  70  * return the current pcm pointer.  just based on the hwptr_done value.
  71  */
  72 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
  73 {
  74         struct snd_pcm_runtime *runtime = substream->runtime;
  75         struct snd_usb_substream *subs = runtime->private_data;
  76         unsigned int hwptr_done;
  77
  78         if (atomic_read(&subs->stream->chip->shutdown))
  79                 return SNDRV_PCM_POS_XRUN;
  80         spin_lock(&subs->lock);
  81         hwptr_done = subs->hwptr_done;
  82         runtime->delay = snd_usb_pcm_delay(subs, runtime);
  83         spin_unlock(&subs->lock);
  84         return bytes_to_frames(runtime, hwptr_done);
  85 }
  86
  87 /*
  88  * find a matching audio format
  89  */
  90 static const struct audioformat *
  91 find_format(struct list_head *fmt_list_head, snd_pcm_format_t format,
  92             unsigned int rate, unsigned int channels, bool strict_match,
  93             struct snd_usb_substream *subs)
  94 {
  95         const struct audioformat *fp;
  96         const struct audioformat *found = NULL;
  97         int cur_attr = 0, attr;
  98
  99         list_for_each_entry(fp, fmt_list_head, list) {
 100                 if (strict_match) {
 101                         if (!(fp->formats & pcm_format_to_bits(format)))
 102                                 continue;
 103                         if (fp->channels != channels)
 104                                 continue;
 105                 }
 106                 if (rate < fp->rate_min || rate > fp->rate_max)
 107                         continue;
 108                 if (!(fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
 109                         unsigned int i;
 110                         for (i = 0; i < fp->nr_rates; i++)
 111                                 if (fp->rate_table[i] == rate)
 112                                         break;
 113                         if (i >= fp->nr_rates)
 114                                 continue;
 115                 }
 116                 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
 117                 if (!found) {
 118                         found = fp;
 119                         cur_attr = attr;
 120                         continue;
 121                 }
 122                 /* avoid async out and adaptive in if the other method
 123                  * supports the same format.
 124                  * this is a workaround for the case like
 125                  * M-audio audiophile USB.
 126                  */
 127                 if (subs && attr != cur_attr) {
 128                         if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
 129                              subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
 130                             (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
 131                              subs->direction == SNDRV_PCM_STREAM_CAPTURE))
 132                                 continue;
 133                         if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
 134                              subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
 135                             (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
 136                              subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
 137                                 found = fp;
 138                                 cur_attr = attr;
 139                                 continue;
 140                         }
 141                 }
 142                 /* find the format with the largest max. packet size */
 143                 if (fp->maxpacksize > found->maxpacksize) {
 144                         found = fp;
 145                         cur_attr = attr;
 146                 }
 147         }
 148         return found;
 149 }
 150
 151 static const struct audioformat *
 152 find_substream_format(struct snd_usb_substream *subs,
 153                       const struct snd_pcm_hw_params *params)
 154 {
 155         return find_format(&subs->fmt_list, params_format(params),
 156                            params_rate(params), params_channels(params),
 157                            true, subs);
 158 }
 159
 160 static int init_pitch_v1(struct snd_usb_audio *chip, int ep)
 161 {
 162         struct usb_device *dev = chip->dev;
 163         unsigned char data[1];
 164         int err;
 165
 166         data[0] = 1;
 167         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
 168                               USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
 169                               UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
 170                               data, sizeof(data));
 171         return err;
 172 }
 173
 174 static int init_pitch_v2(struct snd_usb_audio *chip, int ep)
 175 {
 176         struct usb_device *dev = chip->dev;
 177         unsigned char data[1];
 178         int err;
 179
 180         data[0] = 1;
 181         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
 182                               USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
 183                               UAC2_EP_CS_PITCH << 8, 0,
 184                               data, sizeof(data));
 185         return err;
 186 }
 187
 188 /*
 189  * initialize the pitch control and sample rate
 190  */
 191 int snd_usb_init_pitch(struct snd_usb_audio *chip,
 192                        const struct audioformat *fmt)
 193 {
 194         int err;
 195
 196         /* if endpoint doesn't have pitch control, bail out */
 197         if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
 198                 return 0;
 199
 200         usb_audio_dbg(chip, "enable PITCH for EP 0x%x\n", fmt->endpoint);
 201
 202         switch (fmt->protocol) {
 203         case UAC_VERSION_1:
 204                 err = init_pitch_v1(chip, fmt->endpoint);
 205                 break;
 206         case UAC_VERSION_2:
 207                 err = init_pitch_v2(chip, fmt->endpoint);
 208                 break;
 209         default:
 210                 return 0;
 211         }
 212
 213         if (err < 0) {
 214                 usb_audio_err(chip, "failed to enable PITCH for EP 0x%x\n",
 215                               fmt->endpoint);
 216                 return err;
 217         }
 218
 219         return 0;
 220 }
 221
 222 static bool stop_endpoints(struct snd_usb_substream *subs)
 223 {
 224         bool stopped = 0;
 225
 226         if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
 227                 snd_usb_endpoint_stop(subs->sync_endpoint);
 228                 stopped = true;
 229         }
 230         if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
 231                 snd_usb_endpoint_stop(subs->data_endpoint);
 232                 stopped = true;
 233         }
 234         return stopped;
 235 }
 236
 237 static int start_endpoints(struct snd_usb_substream *subs)
 238 {
 239         int err;
 240
 241         if (!subs->data_endpoint)
 242                 return -EINVAL;
 243
 244         if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
 245                 err = snd_usb_endpoint_start(subs->data_endpoint);
 246                 if (err < 0) {
 247                         clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
 248                         goto error;
 249                 }
 250         }
 251
 252         if (subs->sync_endpoint &&
 253             !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
 254                 err = snd_usb_endpoint_start(subs->sync_endpoint);
 255                 if (err < 0) {
 256                         clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
 257                         goto error;
 258                 }
 259         }
 260
 261         return 0;
 262
 263  error:
 264         stop_endpoints(subs);
 265         return err;
 266 }
 267
 268 static void sync_pending_stops(struct snd_usb_substream *subs)
 269 {
 270         snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
 271         snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
 272 }
 273
 274 /* PCM sync_stop callback */
 275 static int snd_usb_pcm_sync_stop(struct snd_pcm_substream *substream)
 276 {
 277         struct snd_usb_substream *subs = substream->runtime->private_data;
 278
 279         sync_pending_stops(subs);
 280         return 0;
 281 }
 282
 283 /* Set up sync endpoint */
 284 int snd_usb_audioformat_set_sync_ep(struct snd_usb_audio *chip,
 285                                     struct audioformat *fmt)
 286 {
 287         struct usb_device *dev = chip->dev;
 288         struct usb_host_interface *alts;
 289         struct usb_interface_descriptor *altsd;
 290         unsigned int ep, attr, sync_attr;
 291         bool is_playback;
 292         int err;
 293
 294         alts = snd_usb_get_host_interface(chip, fmt->iface, fmt->altsetting);
 295         if (!alts)
 296                 return 0;
 297         altsd = get_iface_desc(alts);
 298
 299         err = snd_usb_parse_implicit_fb_quirk(chip, fmt, alts);
 300         if (err > 0)
 301                 return 0; /* matched */
 302
 303         /*
 304          * Generic sync EP handling
 305          */
 306
 307         if (altsd->bNumEndpoints < 2)
 308                 return 0;
 309
 310         is_playback = !(get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
 311         attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
 312         if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC ||
 313                              attr == USB_ENDPOINT_SYNC_ADAPTIVE)) ||
 314             (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
 315                 return 0;
 316
 317         sync_attr = get_endpoint(alts, 1)->bmAttributes;
 318
 319         /*
 320          * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see
 321          * if we don't find a sync endpoint, as on M-Audio Transit. In case of
 322          * error fall back to SYNC mode and don't create sync endpoint
 323          */
 324
 325         /* check sync-pipe endpoint */
 326         /* ... and check descriptor size before accessing bSynchAddress
 327            because there is a version of the SB Audigy 2 NX firmware lacking
 328            the audio fields in the endpoint descriptors */
 329         if ((sync_attr & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
 330             (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 331              get_endpoint(alts, 1)->bSynchAddress != 0)) {
 332                 dev_err(&dev->dev,
 333                         "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
 334                            fmt->iface, fmt->altsetting,
 335                            get_endpoint(alts, 1)->bmAttributes,
 336                            get_endpoint(alts, 1)->bLength,
 337                            get_endpoint(alts, 1)->bSynchAddress);
 338                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
 339                         return 0;
 340                 return -EINVAL;
 341         }
 342         ep = get_endpoint(alts, 1)->bEndpointAddress;
 343         if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 344             get_endpoint(alts, 0)->bSynchAddress != 0 &&
 345             ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
 346              (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
 347                 dev_err(&dev->dev,
 348                         "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
 349                            fmt->iface, fmt->altsetting,
 350                            is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
 351                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
 352                         return 0;
 353                 return -EINVAL;
 354         }
 355
 356         fmt->sync_ep = ep;
 357         fmt->sync_iface = altsd->bInterfaceNumber;
 358         fmt->sync_altsetting = altsd->bAlternateSetting;
 359         fmt->sync_ep_idx = 1;
 360         if ((sync_attr & USB_ENDPOINT_USAGE_MASK) == USB_ENDPOINT_USAGE_IMPLICIT_FB)
 361                 fmt->implicit_fb = 1;
 362
 363         dev_dbg(&dev->dev, "%d:%d: found sync_ep=0x%x, iface=%d, alt=%d, implicit_fb=%d\n",
 364                 fmt->iface, fmt->altsetting, fmt->sync_ep, fmt->sync_iface,
 365                 fmt->sync_altsetting, fmt->implicit_fb);
 366
 367         return 0;
 368 }
 369
 370 static int snd_usb_pcm_change_state(struct snd_usb_substream *subs, int state)
 371 {
 372         int ret;
 373
 374         if (!subs->str_pd)
 375                 return 0;
 376
 377         ret = snd_usb_power_domain_set(subs->stream->chip, subs->str_pd, state);
 378         if (ret < 0) {
 379                 dev_err(&subs->dev->dev,
 380                         "Cannot change Power Domain ID: %d to state: %d. Err: %d\n",
 381                         subs->str_pd->pd_id, state, ret);
 382                 return ret;
 383         }
 384
 385         return 0;
 386 }
 387
 388 int snd_usb_pcm_suspend(struct snd_usb_stream *as)
 389 {
 390         int ret;
 391
 392         ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D2);
 393         if (ret < 0)
 394                 return ret;
 395
 396         ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D2);
 397         if (ret < 0)
 398                 return ret;
 399
 400         return 0;
 401 }
 402
 403 int snd_usb_pcm_resume(struct snd_usb_stream *as)
 404 {
 405         int ret;
 406
 407         ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D1);
 408         if (ret < 0)
 409                 return ret;
 410
 411         ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D1);
 412         if (ret < 0)
 413                 return ret;
 414
 415         return 0;
 416 }
 417
 418 static void close_endpoints(struct snd_usb_audio *chip,
 419                             struct snd_usb_substream *subs)
 420 {
 421         if (subs->data_endpoint) {
 422                 snd_usb_endpoint_set_sync(chip, subs->data_endpoint, NULL);
 423                 snd_usb_endpoint_close(chip, subs->data_endpoint);
 424                 subs->data_endpoint = NULL;
 425         }
 426
 427         if (subs->sync_endpoint) {
 428                 snd_usb_endpoint_close(chip, subs->sync_endpoint);
 429                 subs->sync_endpoint = NULL;
 430         }
 431 }
 432
 433 static int configure_endpoints(struct snd_usb_audio *chip,
 434                                struct snd_usb_substream *subs)
 435 {
 436         int err;
 437
 438         if (subs->data_endpoint->need_setup) {
 439                 /* stop any running stream beforehand */
 440                 if (stop_endpoints(subs))
 441                         sync_pending_stops(subs);
 442                 err = snd_usb_endpoint_configure(chip, subs->data_endpoint);
 443                 if (err < 0)
 444                         return err;
 445                 snd_usb_set_format_quirk(subs, subs->cur_audiofmt);
 446         }
 447
 448         if (subs->sync_endpoint) {
 449                 err = snd_usb_endpoint_configure(chip, subs->sync_endpoint);
 450                 if (err < 0)
 451                         return err;
 452         }
 453
 454         return 0;
 455 }
 456
 457 /*
 458  * hw_params callback
 459  *
 460  * allocate a buffer and set the given audio format.
 461  *
 462  * so far we use a physically linear buffer although packetize transfer
 463  * doesn't need a continuous area.
 464  * if sg buffer is supported on the later version of alsa, we'll follow
 465  * that.
 466  */
 467 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
 468                              struct snd_pcm_hw_params *hw_params)
 469 {
 470         struct snd_usb_substream *subs = substream->runtime->private_data;
 471         struct snd_usb_audio *chip = subs->stream->chip;
 472         const struct audioformat *fmt;
 473         const struct audioformat *sync_fmt;
 474         int ret;
 475
 476         ret = snd_media_start_pipeline(subs);
 477         if (ret)
 478                 return ret;
 479
 480         fmt = find_substream_format(subs, hw_params);
 481         if (!fmt) {
 482                 usb_audio_dbg(chip,
 483                               "cannot find format: format=%s, rate=%d, channels=%d\n",
 484                               snd_pcm_format_name(params_format(hw_params)),
 485                               params_rate(hw_params), params_channels(hw_params));
 486                 ret = -EINVAL;
 487                 goto stop_pipeline;
 488         }
 489
 490         if (fmt->implicit_fb) {
 491                 sync_fmt = snd_usb_find_implicit_fb_sync_format(chip, fmt,
 492                                                                 hw_params,
 493                                                                 !substream->stream);
 494                 if (!sync_fmt) {
 495                         usb_audio_dbg(chip,
 496                                       "cannot find sync format: ep=0x%x, iface=%d:%d, format=%s, rate=%d, channels=%d\n",
 497                                       fmt->sync_ep, fmt->sync_iface,
 498                                       fmt->sync_altsetting,
 499                                       snd_pcm_format_name(params_format(hw_params)),
 500                                       params_rate(hw_params), params_channels(hw_params));
 501                         ret = -EINVAL;
 502                         goto stop_pipeline;
 503                 }
 504         } else {
 505                 sync_fmt = fmt;
 506         }
 507
 508         ret = snd_usb_lock_shutdown(chip);
 509         if (ret < 0)
 510                 goto stop_pipeline;
 511
 512         ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
 513         if (ret < 0)
 514                 goto unlock;
 515
 516         if (subs->data_endpoint) {
 517                 if (snd_usb_endpoint_compatible(chip, subs->data_endpoint,
 518                                                 fmt, hw_params))
 519                         goto unlock;
 520                 close_endpoints(chip, subs);
 521         }
 522
 523         subs->data_endpoint = snd_usb_endpoint_open(chip, fmt, hw_params, false);
 524         if (!subs->data_endpoint) {
 525                 ret = -EINVAL;
 526                 goto unlock;
 527         }
 528
 529         if (fmt->sync_ep) {
 530                 subs->sync_endpoint = snd_usb_endpoint_open(chip, sync_fmt,
 531                                                             hw_params,
 532                                                             fmt == sync_fmt);
 533                 if (!subs->sync_endpoint) {
 534                         ret = -EINVAL;
 535                         goto unlock;
 536                 }
 537
 538                 snd_usb_endpoint_set_sync(chip, subs->data_endpoint,
 539                                           subs->sync_endpoint);
 540         }
 541
 542         mutex_lock(&chip->mutex);
 543         subs->cur_audiofmt = fmt;
 544         mutex_unlock(&chip->mutex);
 545
 546         ret = configure_endpoints(chip, subs);
 547
 548  unlock:
 549         if (ret < 0)
 550                 close_endpoints(chip, subs);
 551
 552         snd_usb_unlock_shutdown(chip);
 553  stop_pipeline:
 554         if (ret < 0)
 555                 snd_media_stop_pipeline(subs);
 556
 557         return ret;
 558 }
 559
 560 /*
 561  * hw_free callback
 562  *
 563  * reset the audio format and release the buffer
 564  */
 565 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
 566 {
 567         struct snd_usb_substream *subs = substream->runtime->private_data;
 568         struct snd_usb_audio *chip = subs->stream->chip;
 569
 570         snd_media_stop_pipeline(subs);
 571         mutex_lock(&chip->mutex);
 572         subs->cur_audiofmt = NULL;
 573         mutex_unlock(&chip->mutex);
 574         if (!snd_usb_lock_shutdown(chip)) {
 575                 if (stop_endpoints(subs))
 576                         sync_pending_stops(subs);
 577                 close_endpoints(chip, subs);
 578                 snd_usb_unlock_shutdown(chip);
 579         }
 580
 581         return 0;
 582 }
 583
 584 /*
 585  * prepare callback
 586  *
 587  * only a few subtle things...
 588  */
 589 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
 590 {
 591         struct snd_pcm_runtime *runtime = substream->runtime;
 592         struct snd_usb_substream *subs = runtime->private_data;
 593         struct snd_usb_audio *chip = subs->stream->chip;
 594         int ret;
 595
 596         ret = snd_usb_lock_shutdown(chip);
 597         if (ret < 0)
 598                 return ret;
 599         if (snd_BUG_ON(!subs->data_endpoint)) {
 600                 ret = -EIO;
 601                 goto unlock;
 602         }
 603
 604         ret = configure_endpoints(chip, subs);
 605         if (ret < 0)
 606                 goto unlock;
 607
 608         /* reset the pointer */
 609         subs->buffer_bytes = frames_to_bytes(runtime, runtime->buffer_size);
 610         subs->inflight_bytes = 0;
 611         subs->hwptr_done = 0;
 612         subs->transfer_done = 0;
 613         subs->last_frame_number = 0;
 614         subs->period_elapsed_pending = 0;
 615         runtime->delay = 0;
 616
 617  unlock:
 618         snd_usb_unlock_shutdown(chip);
 619         return ret;
 620 }
 621
 622 /*
 623  * h/w constraints
 624  */
 625
 626 #ifdef HW_CONST_DEBUG
 627 #define hwc_debug(fmt, args...) pr_debug(fmt, ##args)
 628 #else
 629 #define hwc_debug(fmt, args...) do { } while(0)
 630 #endif
 631
 632 static const struct snd_pcm_hardware snd_usb_hardware =
 633 {
 634         .info =                 SNDRV_PCM_INFO_MMAP |
 635                                 SNDRV_PCM_INFO_MMAP_VALID |
 636                                 SNDRV_PCM_INFO_BATCH |
 637                                 SNDRV_PCM_INFO_INTERLEAVED |
 638                                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
 639                                 SNDRV_PCM_INFO_PAUSE,
 640         .channels_min =         1,
 641         .channels_max =         256,
 642         .buffer_bytes_max =     1024 * 1024,
 643         .period_bytes_min =     64,
 644         .period_bytes_max =     512 * 1024,
 645         .periods_min =          2,
 646         .periods_max =          1024,
 647 };
 648
 649 static int hw_check_valid_format(struct snd_usb_substream *subs,
 650                                  struct snd_pcm_hw_params *params,
 651                                  const struct audioformat *fp)
 652 {
 653         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 654         struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 655         struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 656         struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
 657         struct snd_mask check_fmts;
 658         unsigned int ptime;
 659
 660         /* check the format */
 661         snd_mask_none(&check_fmts);
 662         check_fmts.bits[0] = (u32)fp->formats;
 663         check_fmts.bits[1] = (u32)(fp->formats >> 32);
 664         snd_mask_intersect(&check_fmts, fmts);
 665         if (snd_mask_empty(&check_fmts)) {
 666                 hwc_debug("   > check: no supported format 0x%llx\n", fp->formats);
 667                 return 0;
 668         }
 669         /* check the channels */
 670         if (fp->channels < ct->min || fp->channels > ct->max) {
 671                 hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
 672                 return 0;
 673         }
 674         /* check the rate is within the range */
 675         if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
 676                 hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
 677                 return 0;
 678         }
 679         if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
 680                 hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
 681                 return 0;
 682         }
 683         /* check whether the period time is >= the data packet interval */
 684         if (subs->speed != USB_SPEED_FULL) {
 685                 ptime = 125 * (1 << fp->datainterval);
 686                 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
 687                         hwc_debug("   > check: ptime %u > max %u\n", ptime, pt->max);
 688                         return 0;
 689                 }
 690         }
 691         return 1;
 692 }
 693
 694 static int apply_hw_params_minmax(struct snd_interval *it, unsigned int rmin,
 695                                   unsigned int rmax)
 696 {
 697         int changed;
 698
 699         if (rmin > rmax) {
 700                 hwc_debug("  --> get empty\n");
 701                 it->empty = 1;
 702                 return -EINVAL;
 703         }
 704
 705         changed = 0;
 706         if (it->min < rmin) {
 707                 it->min = rmin;
 708                 it->openmin = 0;
 709                 changed = 1;
 710         }
 711         if (it->max > rmax) {
 712                 it->max = rmax;
 713                 it->openmax = 0;
 714                 changed = 1;
 715         }
 716         if (snd_interval_checkempty(it)) {
 717                 it->empty = 1;
 718                 return -EINVAL;
 719         }
 720         hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
 721         return changed;
 722 }
 723
 724 static int hw_rule_rate(struct snd_pcm_hw_params *params,
 725                         struct snd_pcm_hw_rule *rule)
 726 {
 727         struct snd_usb_substream *subs = rule->private;
 728         const struct audioformat *fp;
 729         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 730         unsigned int rmin, rmax, r;
 731         int i;
 732
 733         hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
 734         rmin = UINT_MAX;
 735         rmax = 0;
 736         list_for_each_entry(fp, &subs->fmt_list, list) {
 737                 if (!hw_check_valid_format(subs, params, fp))
 738                         continue;
 739                 if (fp->rate_table && fp->nr_rates) {
 740                         for (i = 0; i < fp->nr_rates; i++) {
 741                                 r = fp->rate_table[i];
 742                                 if (!snd_interval_test(it, r))
 743                                         continue;
 744                                 rmin = min(rmin, r);
 745                                 rmax = max(rmax, r);
 746                         }
 747                 } else {
 748                         rmin = min(rmin, fp->rate_min);
 749                         rmax = max(rmax, fp->rate_max);
 750                 }
 751         }
 752
 753         return apply_hw_params_minmax(it, rmin, rmax);
 754 }
 755
 756
 757 static int hw_rule_channels(struct snd_pcm_hw_params *params,
 758                             struct snd_pcm_hw_rule *rule)
 759 {
 760         struct snd_usb_substream *subs = rule->private;
 761         const struct audioformat *fp;
 762         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 763         unsigned int rmin, rmax;
 764
 765         hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
 766         rmin = UINT_MAX;
 767         rmax = 0;
 768         list_for_each_entry(fp, &subs->fmt_list, list) {
 769                 if (!hw_check_valid_format(subs, params, fp))
 770                         continue;
 771                 rmin = min(rmin, fp->channels);
 772                 rmax = max(rmax, fp->channels);
 773         }
 774
 775         return apply_hw_params_minmax(it, rmin, rmax);
 776 }
 777
 778 static int apply_hw_params_format_bits(struct snd_mask *fmt, u64 fbits)
 779 {
 780         u32 oldbits[2];
 781         int changed;
 782
 783         oldbits[0] = fmt->bits[0];
 784         oldbits[1] = fmt->bits[1];
 785         fmt->bits[0] &= (u32)fbits;
 786         fmt->bits[1] &= (u32)(fbits >> 32);
 787         if (!fmt->bits[0] && !fmt->bits[1]) {
 788                 hwc_debug("  --> get empty\n");
 789                 return -EINVAL;
 790         }
 791         changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
 792         hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
 793         return changed;
 794 }
 795
 796 static int hw_rule_format(struct snd_pcm_hw_params *params,
 797                           struct snd_pcm_hw_rule *rule)
 798 {
 799         struct snd_usb_substream *subs = rule->private;
 800         const struct audioformat *fp;
 801         struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 802         u64 fbits;
 803
 804         hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
 805         fbits = 0;
 806         list_for_each_entry(fp, &subs->fmt_list, list) {
 807                 if (!hw_check_valid_format(subs, params, fp))
 808                         continue;
 809                 fbits |= fp->formats;
 810         }
 811         return apply_hw_params_format_bits(fmt, fbits);
 812 }
 813
 814 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
 815                                struct snd_pcm_hw_rule *rule)
 816 {
 817         struct snd_usb_substream *subs = rule->private;
 818         const struct audioformat *fp;
 819         struct snd_interval *it;
 820         unsigned char min_datainterval;
 821         unsigned int pmin;
 822
 823         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
 824         hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
 825         min_datainterval = 0xff;
 826         list_for_each_entry(fp, &subs->fmt_list, list) {
 827                 if (!hw_check_valid_format(subs, params, fp))
 828                         continue;
 829                 min_datainterval = min(min_datainterval, fp->datainterval);
 830         }
 831         if (min_datainterval == 0xff) {
 832                 hwc_debug("  --> get empty\n");
 833                 it->empty = 1;
 834                 return -EINVAL;
 835         }
 836         pmin = 125 * (1 << min_datainterval);
 837
 838         return apply_hw_params_minmax(it, pmin, UINT_MAX);
 839 }
 840
 841 /* get the EP or the sync EP for implicit fb when it's already set up */
 842 static const struct snd_usb_endpoint *
 843 get_sync_ep_from_substream(struct snd_usb_substream *subs)
 844 {
 845         struct snd_usb_audio *chip = subs->stream->chip;
 846         const struct audioformat *fp;
 847         const struct snd_usb_endpoint *ep;
 848
 849         list_for_each_entry(fp, &subs->fmt_list, list) {
 850                 ep = snd_usb_get_endpoint(chip, fp->endpoint);
 851                 if (ep && ep->cur_audiofmt) {
 852                         /* if EP is already opened solely for this substream,
 853                          * we still allow us to change the parameter; otherwise
 854                          * this substream has to follow the existing parameter
 855                          */
 856                         if (ep->cur_audiofmt != subs->cur_audiofmt || ep->opened > 1)
 857                                 return ep;
 858                 }
 859                 if (!fp->implicit_fb)
 860                         continue;
 861                 /* for the implicit fb, check the sync ep as well */
 862                 ep = snd_usb_get_endpoint(chip, fp->sync_ep);
 863                 if (ep && ep->cur_audiofmt)
 864                         return ep;
 865         }
 866         return NULL;
 867 }
 868
 869 /* additional hw constraints for implicit feedback mode */
 870 static int hw_rule_format_implicit_fb(struct snd_pcm_hw_params *params,
 871                                       struct snd_pcm_hw_rule *rule)
 872 {
 873         struct snd_usb_substream *subs = rule->private;
 874         const struct snd_usb_endpoint *ep;
 875         struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 876
 877         ep = get_sync_ep_from_substream(subs);
 878         if (!ep)
 879                 return 0;
 880
 881         hwc_debug("applying %s\n", __func__);
 882         return apply_hw_params_format_bits(fmt, pcm_format_to_bits(ep->cur_format));
 883 }
 884
 885 static int hw_rule_rate_implicit_fb(struct snd_pcm_hw_params *params,
 886                                     struct snd_pcm_hw_rule *rule)
 887 {
 888         struct snd_usb_substream *subs = rule->private;
 889         const struct snd_usb_endpoint *ep;
 890         struct snd_interval *it;
 891
 892         ep = get_sync_ep_from_substream(subs);
 893         if (!ep)
 894                 return 0;
 895
 896         hwc_debug("applying %s\n", __func__);
 897         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 898         return apply_hw_params_minmax(it, ep->cur_rate, ep->cur_rate);
 899 }
 900
 901 static int hw_rule_period_size_implicit_fb(struct snd_pcm_hw_params *params,
 902                                            struct snd_pcm_hw_rule *rule)
 903 {
 904         struct snd_usb_substream *subs = rule->private;
 905         const struct snd_usb_endpoint *ep;
 906         struct snd_interval *it;
 907
 908         ep = get_sync_ep_from_substream(subs);
 909         if (!ep)
 910                 return 0;
 911
 912         hwc_debug("applying %s\n", __func__);
 913         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
 914         return apply_hw_params_minmax(it, ep->cur_period_frames,
 915                                       ep->cur_period_frames);
 916 }
 917
 918 static int hw_rule_periods_implicit_fb(struct snd_pcm_hw_params *params,
 919                                        struct snd_pcm_hw_rule *rule)
 920 {
 921         struct snd_usb_substream *subs = rule->private;
 922         const struct snd_usb_endpoint *ep;
 923         struct snd_interval *it;
 924
 925         ep = get_sync_ep_from_substream(subs);
 926         if (!ep)
 927                 return 0;
 928
 929         hwc_debug("applying %s\n", __func__);
 930         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIODS);
 931         return apply_hw_params_minmax(it, ep->cur_buffer_periods,
 932                                       ep->cur_buffer_periods);
 933 }
 934
 935 /*
 936  * set up the runtime hardware information.
 937  */
 938
 939 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
 940 {
 941         const struct audioformat *fp;
 942         unsigned int pt, ptmin;
 943         int param_period_time_if_needed = -1;
 944         int err;
 945
 946         runtime->hw.formats = subs->formats;
 947
 948         runtime->hw.rate_min = 0x7fffffff;
 949         runtime->hw.rate_max = 0;
 950         runtime->hw.channels_min = 256;
 951         runtime->hw.channels_max = 0;
 952         runtime->hw.rates = 0;
 953         ptmin = UINT_MAX;
 954         /* check min/max rates and channels */
 955         list_for_each_entry(fp, &subs->fmt_list, list) {
 956                 runtime->hw.rates |= fp->rates;
 957                 if (runtime->hw.rate_min > fp->rate_min)
 958                         runtime->hw.rate_min = fp->rate_min;
 959                 if (runtime->hw.rate_max < fp->rate_max)
 960                         runtime->hw.rate_max = fp->rate_max;
 961                 if (runtime->hw.channels_min > fp->channels)
 962                         runtime->hw.channels_min = fp->channels;
 963                 if (runtime->hw.channels_max < fp->channels)
 964                         runtime->hw.channels_max = fp->channels;
 965                 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
 966                         /* FIXME: there might be more than one audio formats... */
 967                         runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
 968                                 fp->frame_size;
 969                 }
 970                 pt = 125 * (1 << fp->datainterval);
 971                 ptmin = min(ptmin, pt);
 972         }
 973
 974         param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
 975         if (subs->speed == USB_SPEED_FULL)
 976                 /* full speed devices have fixed data packet interval */
 977                 ptmin = 1000;
 978         if (ptmin == 1000)
 979                 /* if period time doesn't go below 1 ms, no rules needed */
 980                 param_period_time_if_needed = -1;
 981
 982         err = snd_pcm_hw_constraint_minmax(runtime,
 983                                            SNDRV_PCM_HW_PARAM_PERIOD_TIME,
 984                                            ptmin, UINT_MAX);
 985         if (err < 0)
 986                 return err;
 987
 988         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
 989                                   hw_rule_rate, subs,
 990                                   SNDRV_PCM_HW_PARAM_RATE,
 991                                   SNDRV_PCM_HW_PARAM_FORMAT,
 992                                   SNDRV_PCM_HW_PARAM_CHANNELS,
 993                                   param_period_time_if_needed,
 994                                   -1);
 995         if (err < 0)
 996                 return err;
 997
 998         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
 999                                   hw_rule_channels, subs,
1000                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1001                                   SNDRV_PCM_HW_PARAM_FORMAT,
1002                                   SNDRV_PCM_HW_PARAM_RATE,
1003                                   param_period_time_if_needed,
1004                                   -1);
1005         if (err < 0)
1006                 return err;
1007         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1008                                   hw_rule_format, subs,
1009                                   SNDRV_PCM_HW_PARAM_FORMAT,
1010                                   SNDRV_PCM_HW_PARAM_RATE,
1011                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1012                                   param_period_time_if_needed,
1013                                   -1);
1014         if (err < 0)
1015                 return err;
1016         if (param_period_time_if_needed >= 0) {
1017                 err = snd_pcm_hw_rule_add(runtime, 0,
1018                                           SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1019                                           hw_rule_period_time, subs,
1020                                           SNDRV_PCM_HW_PARAM_FORMAT,
1021                                           SNDRV_PCM_HW_PARAM_CHANNELS,
1022                                           SNDRV_PCM_HW_PARAM_RATE,
1023                                           -1);
1024                 if (err < 0)
1025                         return err;
1026         }
1027
1028         /* additional hw constraints for implicit fb */
1029         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1030                                   hw_rule_format_implicit_fb, subs,
1031                                   SNDRV_PCM_HW_PARAM_FORMAT, -1);
1032         if (err < 0)
1033                 return err;
1034         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1035                                   hw_rule_rate_implicit_fb, subs,
1036                                   SNDRV_PCM_HW_PARAM_RATE, -1);
1037         if (err < 0)
1038                 return err;
1039         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
1040                                   hw_rule_period_size_implicit_fb, subs,
1041                                   SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
1042         if (err < 0)
1043                 return err;
1044         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
1045                                   hw_rule_periods_implicit_fb, subs,
1046                                   SNDRV_PCM_HW_PARAM_PERIODS, -1);
1047         if (err < 0)
1048                 return err;
1049
1050         return 0;
1051 }
1052
1053 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1054 {
1055         int direction = substream->stream;
1056         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1057         struct snd_pcm_runtime *runtime = substream->runtime;
1058         struct snd_usb_substream *subs = &as->substream[direction];
1059         int ret;
1060
1061         runtime->hw = snd_usb_hardware;
1062         runtime->private_data = subs;
1063         subs->pcm_substream = substream;
1064         /* runtime PM is also done there */
1065
1066         /* initialize DSD/DOP context */
1067         subs->dsd_dop.byte_idx = 0;
1068         subs->dsd_dop.channel = 0;
1069         subs->dsd_dop.marker = 1;
1070
1071         ret = setup_hw_info(runtime, subs);
1072         if (ret < 0)
1073                 return ret;
1074         ret = snd_usb_autoresume(subs->stream->chip);
1075         if (ret < 0)
1076                 return ret;
1077         ret = snd_media_stream_init(subs, as->pcm, direction);
1078         if (ret < 0)
1079                 snd_usb_autosuspend(subs->stream->chip);
1080         return ret;
1081 }
1082
1083 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1084 {
1085         int direction = substream->stream;
1086         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1087         struct snd_usb_substream *subs = &as->substream[direction];
1088         int ret;
1089
1090         snd_media_stop_pipeline(subs);
1091
1092         if (!snd_usb_lock_shutdown(subs->stream->chip)) {
1093                 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1094                 snd_usb_unlock_shutdown(subs->stream->chip);
1095                 if (ret < 0)
1096                         return ret;
1097         }
1098
1099         subs->pcm_substream = NULL;
1100         snd_usb_autosuspend(subs->stream->chip);
1101
1102         return 0;
1103 }
1104
1105 /* Since a URB can handle only a single linear buffer, we must use double
1106  * buffering when the data to be transferred overflows the buffer boundary.
1107  * To avoid inconsistencies when updating hwptr_done, we use double buffering
1108  * for all URBs.
1109  */
1110 static void retire_capture_urb(struct snd_usb_substream *subs,
1111                                struct urb *urb)
1112 {
1113         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1114         unsigned int stride, frames, bytes, oldptr;
1115         int i, period_elapsed = 0;
1116         unsigned long flags;
1117         unsigned char *cp;
1118         int current_frame_number;
1119
1120         /* read frame number here, update pointer in critical section */
1121         current_frame_number = usb_get_current_frame_number(subs->dev);
1122
1123         stride = runtime->frame_bits >> 3;
1124
1125         for (i = 0; i < urb->number_of_packets; i++) {
1126                 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1127                 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1128                         dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1129                                 i, urb->iso_frame_desc[i].status);
1130                         // continue;
1131                 }
1132                 bytes = urb->iso_frame_desc[i].actual_length;
1133                 if (subs->stream_offset_adj > 0) {
1134                         unsigned int adj = min(subs->stream_offset_adj, bytes);
1135                         cp += adj;
1136                         bytes -= adj;
1137                         subs->stream_offset_adj -= adj;
1138                 }
1139                 frames = bytes / stride;
1140                 if (!subs->txfr_quirk)
1141                         bytes = frames * stride;
1142                 if (bytes % (runtime->sample_bits >> 3) != 0) {
1143                         int oldbytes = bytes;
1144                         bytes = frames * stride;
1145                         dev_warn_ratelimited(&subs->dev->dev,
1146                                  "Corrected urb data len. %d->%d\n",
1147                                                         oldbytes, bytes);
1148                 }
1149                 /* update the current pointer */
1150                 spin_lock_irqsave(&subs->lock, flags);
1151                 oldptr = subs->hwptr_done;
1152                 subs->hwptr_done += bytes;
1153                 if (subs->hwptr_done >= subs->buffer_bytes)
1154                         subs->hwptr_done -= subs->buffer_bytes;
1155                 frames = (bytes + (oldptr % stride)) / stride;
1156                 subs->transfer_done += frames;
1157                 if (subs->transfer_done >= runtime->period_size) {
1158                         subs->transfer_done -= runtime->period_size;
1159                         period_elapsed = 1;
1160                 }
1161
1162                 /* realign last_frame_number */
1163                 subs->last_frame_number = current_frame_number;
1164
1165                 spin_unlock_irqrestore(&subs->lock, flags);
1166                 /* copy a data chunk */
1167                 if (oldptr + bytes > subs->buffer_bytes) {
1168                         unsigned int bytes1 = subs->buffer_bytes - oldptr;
1169
1170                         memcpy(runtime->dma_area + oldptr, cp, bytes1);
1171                         memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1172                 } else {
1173                         memcpy(runtime->dma_area + oldptr, cp, bytes);
1174                 }
1175         }
1176
1177         if (period_elapsed)
1178                 snd_pcm_period_elapsed(subs->pcm_substream);
1179 }
1180
1181 static void urb_ctx_queue_advance(struct snd_usb_substream *subs,
1182                                   struct urb *urb, unsigned int bytes)
1183 {
1184         struct snd_urb_ctx *ctx = urb->context;
1185
1186         ctx->queued += bytes;
1187         subs->inflight_bytes += bytes;
1188         subs->hwptr_done += bytes;
1189         if (subs->hwptr_done >= subs->buffer_bytes)
1190                 subs->hwptr_done -= subs->buffer_bytes;
1191 }
1192
1193 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1194                                              struct urb *urb, unsigned int bytes)
1195 {
1196         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1197         unsigned int dst_idx = 0;
1198         unsigned int src_idx = subs->hwptr_done;
1199         unsigned int wrap = subs->buffer_bytes;
1200         u8 *dst = urb->transfer_buffer;
1201         u8 *src = runtime->dma_area;
1202         u8 marker[] = { 0x05, 0xfa };
1203         unsigned int queued = 0;
1204
1205         /*
1206          * The DSP DOP format defines a way to transport DSD samples over
1207          * normal PCM data endpoints. It requires stuffing of marker bytes
1208          * (0x05 and 0xfa, alternating per sample frame), and then expects
1209          * 2 additional bytes of actual payload. The whole frame is stored
1210          * LSB.
1211          *
1212          * Hence, for a stereo transport, the buffer layout looks like this,
1213          * where L refers to left channel samples and R to right.
1214          *
1215          *   L1 L2 0x05   R1 R2 0x05   L3 L4 0xfa  R3 R4 0xfa
1216          *   L5 L6 0x05   R5 R6 0x05   L7 L8 0xfa  R7 R8 0xfa
1217          *   .....
1218          *
1219          */
1220
1221         while (bytes--) {
1222                 if (++subs->dsd_dop.byte_idx == 3) {
1223                         /* frame boundary? */
1224                         dst[dst_idx++] = marker[subs->dsd_dop.marker];
1225                         src_idx += 2;
1226                         subs->dsd_dop.byte_idx = 0;
1227
1228                         if (++subs->dsd_dop.channel % runtime->channels == 0) {
1229                                 /* alternate the marker */
1230                                 subs->dsd_dop.marker++;
1231                                 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1232                                 subs->dsd_dop.channel = 0;
1233                         }
1234                 } else {
1235                         /* stuff the DSD payload */
1236                         int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1237
1238                         if (subs->cur_audiofmt->dsd_bitrev)
1239                                 dst[dst_idx++] = bitrev8(src[idx]);
1240                         else
1241                                 dst[dst_idx++] = src[idx];
1242                         queued++;
1243                 }
1244         }
1245
1246         urb_ctx_queue_advance(subs, urb, queued);
1247 }
1248
1249 /* copy bit-reversed bytes onto transfer buffer */
1250 static void fill_playback_urb_dsd_bitrev(struct snd_usb_substream *subs,
1251                                          struct urb *urb, unsigned int bytes)
1252 {
1253         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1254         const u8 *src = runtime->dma_area;
1255         u8 *buf = urb->transfer_buffer;
1256         int i, ofs = subs->hwptr_done;
1257
1258         for (i = 0; i < bytes; i++) {
1259                 *buf++ = bitrev8(src[ofs]);
1260                 if (++ofs >= subs->buffer_bytes)
1261                         ofs = 0;
1262         }
1263
1264         urb_ctx_queue_advance(subs, urb, bytes);
1265 }
1266
1267 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1268                         int offset, int stride, unsigned int bytes)
1269 {
1270         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1271
1272         if (subs->hwptr_done + bytes > subs->buffer_bytes) {
1273                 /* err, the transferred area goes over buffer boundary. */
1274                 unsigned int bytes1 = subs->buffer_bytes - subs->hwptr_done;
1275
1276                 memcpy(urb->transfer_buffer + offset,
1277                        runtime->dma_area + subs->hwptr_done, bytes1);
1278                 memcpy(urb->transfer_buffer + offset + bytes1,
1279                        runtime->dma_area, bytes - bytes1);
1280         } else {
1281                 memcpy(urb->transfer_buffer + offset,
1282                        runtime->dma_area + subs->hwptr_done, bytes);
1283         }
1284
1285         urb_ctx_queue_advance(subs, urb, bytes);
1286 }
1287
1288 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1289                                       struct urb *urb, int stride,
1290                                       unsigned int bytes)
1291 {
1292         __le32 packet_length;
1293         int i;
1294
1295         /* Put __le32 length descriptor at start of each packet. */
1296         for (i = 0; i < urb->number_of_packets; i++) {
1297                 unsigned int length = urb->iso_frame_desc[i].length;
1298                 unsigned int offset = urb->iso_frame_desc[i].offset;
1299
1300                 packet_length = cpu_to_le32(length);
1301                 offset += i * sizeof(packet_length);
1302                 urb->iso_frame_desc[i].offset = offset;
1303                 urb->iso_frame_desc[i].length += sizeof(packet_length);
1304                 memcpy(urb->transfer_buffer + offset,
1305                        &packet_length, sizeof(packet_length));
1306                 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1307                             stride, length);
1308         }
1309         /* Adjust transfer size accordingly. */
1310         bytes += urb->number_of_packets * sizeof(packet_length);
1311         return bytes;
1312 }
1313
1314 static void prepare_playback_urb(struct snd_usb_substream *subs,
1315                                  struct urb *urb)
1316 {
1317         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1318         struct snd_usb_endpoint *ep = subs->data_endpoint;
1319         struct snd_urb_ctx *ctx = urb->context;
1320         unsigned int counts, frames, bytes;
1321         int i, stride, period_elapsed = 0;
1322         unsigned long flags;
1323
1324         stride = ep->stride;
1325
1326         frames = 0;
1327         ctx->queued = 0;
1328         urb->number_of_packets = 0;
1329         spin_lock_irqsave(&subs->lock, flags);
1330         subs->frame_limit += ep->max_urb_frames;
1331         for (i = 0; i < ctx->packets; i++) {
1332                 counts = snd_usb_endpoint_next_packet_size(ep, ctx, i);
1333                 /* set up descriptor */
1334                 urb->iso_frame_desc[i].offset = frames * stride;
1335                 urb->iso_frame_desc[i].length = counts * stride;
1336                 frames += counts;
1337                 urb->number_of_packets++;
1338                 subs->transfer_done += counts;
1339                 if (subs->transfer_done >= runtime->period_size) {
1340                         subs->transfer_done -= runtime->period_size;
1341                         subs->frame_limit = 0;
1342                         period_elapsed = 1;
1343                         if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1344                                 if (subs->transfer_done > 0) {
1345                                         /* FIXME: fill-max mode is not
1346                                          * supported yet */
1347                                         frames -= subs->transfer_done;
1348                                         counts -= subs->transfer_done;
1349                                         urb->iso_frame_desc[i].length =
1350                                                 counts * stride;
1351                                         subs->transfer_done = 0;
1352                                 }
1353                                 i++;
1354                                 if (i < ctx->packets) {
1355                                         /* add a transfer delimiter */
1356                                         urb->iso_frame_desc[i].offset =
1357                                                 frames * stride;
1358                                         urb->iso_frame_desc[i].length = 0;
1359                                         urb->number_of_packets++;
1360                                 }
1361                                 break;
1362                         }
1363                 }
1364                 /* finish at the period boundary or after enough frames */
1365                 if ((period_elapsed ||
1366                                 subs->transfer_done >= subs->frame_limit) &&
1367                     !snd_usb_endpoint_implicit_feedback_sink(ep))
1368                         break;
1369         }
1370         bytes = frames * stride;
1371
1372         if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1373                      subs->cur_audiofmt->dsd_dop)) {
1374                 fill_playback_urb_dsd_dop(subs, urb, bytes);
1375         } else if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1376                            subs->cur_audiofmt->dsd_bitrev)) {
1377                 fill_playback_urb_dsd_bitrev(subs, urb, bytes);
1378         } else {
1379                 /* usual PCM */
1380                 if (!subs->tx_length_quirk)
1381                         copy_to_urb(subs, urb, 0, stride, bytes);
1382                 else
1383                         bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1384                         /* bytes is now amount of outgoing data */
1385         }
1386
1387         subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1388
1389         if (subs->trigger_tstamp_pending_update) {
1390                 /* this is the first actual URB submitted,
1391                  * update trigger timestamp to reflect actual start time
1392                  */
1393                 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1394                 subs->trigger_tstamp_pending_update = false;
1395         }
1396
1397         if (period_elapsed && !subs->running) {
1398                 subs->period_elapsed_pending = 1;
1399                 period_elapsed = 0;
1400         }
1401         spin_unlock_irqrestore(&subs->lock, flags);
1402         urb->transfer_buffer_length = bytes;
1403         if (period_elapsed)
1404                 snd_pcm_period_elapsed(subs->pcm_substream);
1405 }
1406
1407 /*
1408  * process after playback data complete
1409  * - decrease the delay count again
1410  */
1411 static void retire_playback_urb(struct snd_usb_substream *subs,
1412                                struct urb *urb)
1413 {
1414         unsigned long flags;
1415         struct snd_urb_ctx *ctx = urb->context;
1416         bool period_elapsed = false;
1417
1418         spin_lock_irqsave(&subs->lock, flags);
1419         if (ctx->queued) {
1420                 if (subs->inflight_bytes >= ctx->queued)
1421                         subs->inflight_bytes -= ctx->queued;
1422                 else
1423                         subs->inflight_bytes = 0;
1424         }
1425
1426         subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1427         if (subs->running) {
1428                 period_elapsed = subs->period_elapsed_pending;
1429                 subs->period_elapsed_pending = 0;
1430         }
1431         spin_unlock_irqrestore(&subs->lock, flags);
1432         if (period_elapsed)
1433                 snd_pcm_period_elapsed(subs->pcm_substream);
1434 }
1435
1436 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1437                                               int cmd)
1438 {
1439         struct snd_usb_substream *subs = substream->runtime->private_data;
1440         int err;
1441
1442         switch (cmd) {
1443         case SNDRV_PCM_TRIGGER_START:
1444                 subs->trigger_tstamp_pending_update = true;
1445                 fallthrough;
1446         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1447                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1448                                               prepare_playback_urb,
1449                                               retire_playback_urb,
1450                                               subs);
1451                 if (cmd == SNDRV_PCM_TRIGGER_START) {
1452                         err = start_endpoints(subs);
1453                         if (err < 0) {
1454                                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1455                                                               NULL, NULL, NULL);
1456                                 return err;
1457                         }
1458                 }
1459                 subs->running = 1;
1460                 dev_dbg(&subs->dev->dev, "%d:%d Start Playback PCM\n",
1461                         subs->cur_audiofmt->iface,
1462                         subs->cur_audiofmt->altsetting);
1463                 return 0;
1464         case SNDRV_PCM_TRIGGER_SUSPEND:
1465         case SNDRV_PCM_TRIGGER_STOP:
1466                 stop_endpoints(subs);
1467                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1468                                               NULL, NULL, NULL);
1469                 subs->running = 0;
1470                 dev_dbg(&subs->dev->dev, "%d:%d Stop Playback PCM\n",
1471                         subs->cur_audiofmt->iface,
1472                         subs->cur_audiofmt->altsetting);
1473                 return 0;
1474         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1475                 /* keep retire_data_urb for delay calculation */
1476                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1477                                               NULL,
1478                                               retire_playback_urb,
1479                                               subs);
1480                 subs->running = 0;
1481                 dev_dbg(&subs->dev->dev, "%d:%d Pause Playback PCM\n",
1482                         subs->cur_audiofmt->iface,
1483                         subs->cur_audiofmt->altsetting);
1484                 return 0;
1485         }
1486
1487         return -EINVAL;
1488 }
1489
1490 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1491                                              int cmd)
1492 {
1493         int err;
1494         struct snd_usb_substream *subs = substream->runtime->private_data;
1495
1496         switch (cmd) {
1497         case SNDRV_PCM_TRIGGER_START:
1498                 err = start_endpoints(subs);
1499                 if (err < 0)
1500                         return err;
1501                 fallthrough;
1502         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1503                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1504                                               NULL, retire_capture_urb,
1505                                               subs);
1506                 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1507                 subs->running = 1;
1508                 dev_dbg(&subs->dev->dev, "%d:%d Start Capture PCM\n",
1509                         subs->cur_audiofmt->iface,
1510                         subs->cur_audiofmt->altsetting);
1511                 return 0;
1512         case SNDRV_PCM_TRIGGER_SUSPEND:
1513         case SNDRV_PCM_TRIGGER_STOP:
1514                 stop_endpoints(subs);
1515                 fallthrough;
1516         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1517                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1518                                               NULL, NULL, NULL);
1519                 subs->running = 0;
1520                 dev_dbg(&subs->dev->dev, "%d:%d Stop Capture PCM\n",
1521                         subs->cur_audiofmt->iface,
1522                         subs->cur_audiofmt->altsetting);
1523                 return 0;
1524         }
1525
1526         return -EINVAL;
1527 }
1528
1529 static const struct snd_pcm_ops snd_usb_playback_ops = {
1530         .open =         snd_usb_pcm_open,
1531         .close =        snd_usb_pcm_close,
1532         .hw_params =    snd_usb_hw_params,
1533         .hw_free =      snd_usb_hw_free,
1534         .prepare =      snd_usb_pcm_prepare,
1535         .trigger =      snd_usb_substream_playback_trigger,
1536         .sync_stop =    snd_usb_pcm_sync_stop,
1537         .pointer =      snd_usb_pcm_pointer,
1538 };
1539
1540 static const struct snd_pcm_ops snd_usb_capture_ops = {
1541         .open =         snd_usb_pcm_open,
1542         .close =        snd_usb_pcm_close,
1543         .hw_params =    snd_usb_hw_params,
1544         .hw_free =      snd_usb_hw_free,
1545         .prepare =      snd_usb_pcm_prepare,
1546         .trigger =      snd_usb_substream_capture_trigger,
1547         .sync_stop =    snd_usb_pcm_sync_stop,
1548         .pointer =      snd_usb_pcm_pointer,
1549 };
1550
1551 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1552 {
1553         const struct snd_pcm_ops *ops;
1554
1555         ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1556                         &snd_usb_playback_ops : &snd_usb_capture_ops;
1557         snd_pcm_set_ops(pcm, stream, ops);
1558 }
1559
1560 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1561 {
1562         struct snd_pcm *pcm = subs->stream->pcm;
1563         struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1564         struct device *dev = subs->dev->bus->sysdev;
1565
1566         if (snd_usb_use_vmalloc)
1567                 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_VMALLOC,
1568                                            NULL, 0, 0);
1569         else
1570                 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_DEV_SG,
1571                                            dev, 64*1024, 512*1024);
1572 }