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