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, bool keep_pending)
 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, keep_pending);
 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, keep_pending);
 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, false);
 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, false))
 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, false))
 576                         sync_pending_stops(subs);
 577                 close_endpoints(chip, subs);
 578                 snd_usb_unlock_shutdown(chip);
 579         }
 580
 581         return 0;
 582 }
 583
 584 /* free-wheeling mode? (e.g. dmix) */
 585 static int in_free_wheeling_mode(struct snd_pcm_runtime *runtime)
 586 {
 587         return runtime->stop_threshold > runtime->buffer_size;
 588 }
 589
 590 /* check whether early start is needed for playback stream */
 591 static int lowlatency_playback_available(struct snd_pcm_runtime *runtime,
 592                                          struct snd_usb_substream *subs)
 593 {
 594         struct snd_usb_audio *chip = subs->stream->chip;
 595
 596         if (subs->direction == SNDRV_PCM_STREAM_CAPTURE)
 597                 return false;
 598         /* disabled via module option? */
 599         if (!chip->lowlatency)
 600                 return false;
 601         if (in_free_wheeling_mode(runtime))
 602                 return false;
 603         /* implicit feedback mode has own operation mode */
 604         if (snd_usb_endpoint_implicit_feedback_sink(subs->data_endpoint))
 605                 return false;
 606         return true;
 607 }
 608
 609 /*
 610  * prepare callback
 611  *
 612  * only a few subtle things...
 613  */
 614 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
 615 {
 616         struct snd_pcm_runtime *runtime = substream->runtime;
 617         struct snd_usb_substream *subs = runtime->private_data;
 618         struct snd_usb_audio *chip = subs->stream->chip;
 619         int ret;
 620
 621         ret = snd_usb_lock_shutdown(chip);
 622         if (ret < 0)
 623                 return ret;
 624         if (snd_BUG_ON(!subs->data_endpoint)) {
 625                 ret = -EIO;
 626                 goto unlock;
 627         }
 628
 629         ret = configure_endpoints(chip, subs);
 630         if (ret < 0)
 631                 goto unlock;
 632
 633         /* reset the pointer */
 634         subs->buffer_bytes = frames_to_bytes(runtime, runtime->buffer_size);
 635         subs->inflight_bytes = 0;
 636         subs->hwptr_done = 0;
 637         subs->transfer_done = 0;
 638         subs->last_frame_number = 0;
 639         subs->period_elapsed_pending = 0;
 640         runtime->delay = 0;
 641
 642         subs->lowlatency_playback = lowlatency_playback_available(runtime, subs);
 643         if (!subs->lowlatency_playback)
 644                 ret = start_endpoints(subs);
 645
 646  unlock:
 647         snd_usb_unlock_shutdown(chip);
 648         return ret;
 649 }
 650
 651 /*
 652  * h/w constraints
 653  */
 654
 655 #ifdef HW_CONST_DEBUG
 656 #define hwc_debug(fmt, args...) pr_debug(fmt, ##args)
 657 #else
 658 #define hwc_debug(fmt, args...) do { } while(0)
 659 #endif
 660
 661 static const struct snd_pcm_hardware snd_usb_hardware =
 662 {
 663         .info =                 SNDRV_PCM_INFO_MMAP |
 664                                 SNDRV_PCM_INFO_MMAP_VALID |
 665                                 SNDRV_PCM_INFO_BATCH |
 666                                 SNDRV_PCM_INFO_INTERLEAVED |
 667                                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
 668                                 SNDRV_PCM_INFO_PAUSE,
 669         .channels_min =         1,
 670         .channels_max =         256,
 671         .buffer_bytes_max =     1024 * 1024,
 672         .period_bytes_min =     64,
 673         .period_bytes_max =     512 * 1024,
 674         .periods_min =          2,
 675         .periods_max =          1024,
 676 };
 677
 678 static int hw_check_valid_format(struct snd_usb_substream *subs,
 679                                  struct snd_pcm_hw_params *params,
 680                                  const struct audioformat *fp)
 681 {
 682         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 683         struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 684         struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 685         struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
 686         struct snd_mask check_fmts;
 687         unsigned int ptime;
 688
 689         /* check the format */
 690         snd_mask_none(&check_fmts);
 691         check_fmts.bits[0] = (u32)fp->formats;
 692         check_fmts.bits[1] = (u32)(fp->formats >> 32);
 693         snd_mask_intersect(&check_fmts, fmts);
 694         if (snd_mask_empty(&check_fmts)) {
 695                 hwc_debug("   > check: no supported format 0x%llx\n", fp->formats);
 696                 return 0;
 697         }
 698         /* check the channels */
 699         if (fp->channels < ct->min || fp->channels > ct->max) {
 700                 hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
 701                 return 0;
 702         }
 703         /* check the rate is within the range */
 704         if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
 705                 hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
 706                 return 0;
 707         }
 708         if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
 709                 hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
 710                 return 0;
 711         }
 712         /* check whether the period time is >= the data packet interval */
 713         if (subs->speed != USB_SPEED_FULL) {
 714                 ptime = 125 * (1 << fp->datainterval);
 715                 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
 716                         hwc_debug("   > check: ptime %u > max %u\n", ptime, pt->max);
 717                         return 0;
 718                 }
 719         }
 720         return 1;
 721 }
 722
 723 static int apply_hw_params_minmax(struct snd_interval *it, unsigned int rmin,
 724                                   unsigned int rmax)
 725 {
 726         int changed;
 727
 728         if (rmin > rmax) {
 729                 hwc_debug("  --> get empty\n");
 730                 it->empty = 1;
 731                 return -EINVAL;
 732         }
 733
 734         changed = 0;
 735         if (it->min < rmin) {
 736                 it->min = rmin;
 737                 it->openmin = 0;
 738                 changed = 1;
 739         }
 740         if (it->max > rmax) {
 741                 it->max = rmax;
 742                 it->openmax = 0;
 743                 changed = 1;
 744         }
 745         if (snd_interval_checkempty(it)) {
 746                 it->empty = 1;
 747                 return -EINVAL;
 748         }
 749         hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
 750         return changed;
 751 }
 752
 753 static int hw_rule_rate(struct snd_pcm_hw_params *params,
 754                         struct snd_pcm_hw_rule *rule)
 755 {
 756         struct snd_usb_substream *subs = rule->private;
 757         struct snd_usb_audio *chip = subs->stream->chip;
 758         const struct audioformat *fp;
 759         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 760         unsigned int rmin, rmax, r;
 761         int i;
 762
 763         hwc_debug("hw_rule_rate: (%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                 r = snd_usb_endpoint_get_clock_rate(chip, fp->clock);
 770                 if (r > 0) {
 771                         if (!snd_interval_test(it, r))
 772                                 continue;
 773                         rmin = min(rmin, r);
 774                         rmax = max(rmax, r);
 775                         continue;
 776                 }
 777                 if (fp->rate_table && fp->nr_rates) {
 778                         for (i = 0; i < fp->nr_rates; i++) {
 779                                 r = fp->rate_table[i];
 780                                 if (!snd_interval_test(it, r))
 781                                         continue;
 782                                 rmin = min(rmin, r);
 783                                 rmax = max(rmax, r);
 784                         }
 785                 } else {
 786                         rmin = min(rmin, fp->rate_min);
 787                         rmax = max(rmax, fp->rate_max);
 788                 }
 789         }
 790
 791         return apply_hw_params_minmax(it, rmin, rmax);
 792 }
 793
 794
 795 static int hw_rule_channels(struct snd_pcm_hw_params *params,
 796                             struct snd_pcm_hw_rule *rule)
 797 {
 798         struct snd_usb_substream *subs = rule->private;
 799         const struct audioformat *fp;
 800         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 801         unsigned int rmin, rmax;
 802
 803         hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
 804         rmin = UINT_MAX;
 805         rmax = 0;
 806         list_for_each_entry(fp, &subs->fmt_list, list) {
 807                 if (!hw_check_valid_format(subs, params, fp))
 808                         continue;
 809                 rmin = min(rmin, fp->channels);
 810                 rmax = max(rmax, fp->channels);
 811         }
 812
 813         return apply_hw_params_minmax(it, rmin, rmax);
 814 }
 815
 816 static int apply_hw_params_format_bits(struct snd_mask *fmt, u64 fbits)
 817 {
 818         u32 oldbits[2];
 819         int changed;
 820
 821         oldbits[0] = fmt->bits[0];
 822         oldbits[1] = fmt->bits[1];
 823         fmt->bits[0] &= (u32)fbits;
 824         fmt->bits[1] &= (u32)(fbits >> 32);
 825         if (!fmt->bits[0] && !fmt->bits[1]) {
 826                 hwc_debug("  --> get empty\n");
 827                 return -EINVAL;
 828         }
 829         changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
 830         hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
 831         return changed;
 832 }
 833
 834 static int hw_rule_format(struct snd_pcm_hw_params *params,
 835                           struct snd_pcm_hw_rule *rule)
 836 {
 837         struct snd_usb_substream *subs = rule->private;
 838         const struct audioformat *fp;
 839         struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 840         u64 fbits;
 841
 842         hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
 843         fbits = 0;
 844         list_for_each_entry(fp, &subs->fmt_list, list) {
 845                 if (!hw_check_valid_format(subs, params, fp))
 846                         continue;
 847                 fbits |= fp->formats;
 848         }
 849         return apply_hw_params_format_bits(fmt, fbits);
 850 }
 851
 852 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
 853                                struct snd_pcm_hw_rule *rule)
 854 {
 855         struct snd_usb_substream *subs = rule->private;
 856         const struct audioformat *fp;
 857         struct snd_interval *it;
 858         unsigned char min_datainterval;
 859         unsigned int pmin;
 860
 861         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
 862         hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
 863         min_datainterval = 0xff;
 864         list_for_each_entry(fp, &subs->fmt_list, list) {
 865                 if (!hw_check_valid_format(subs, params, fp))
 866                         continue;
 867                 min_datainterval = min(min_datainterval, fp->datainterval);
 868         }
 869         if (min_datainterval == 0xff) {
 870                 hwc_debug("  --> get empty\n");
 871                 it->empty = 1;
 872                 return -EINVAL;
 873         }
 874         pmin = 125 * (1 << min_datainterval);
 875
 876         return apply_hw_params_minmax(it, pmin, UINT_MAX);
 877 }
 878
 879 /* get the EP or the sync EP for implicit fb when it's already set up */
 880 static const struct snd_usb_endpoint *
 881 get_sync_ep_from_substream(struct snd_usb_substream *subs)
 882 {
 883         struct snd_usb_audio *chip = subs->stream->chip;
 884         const struct audioformat *fp;
 885         const struct snd_usb_endpoint *ep;
 886
 887         list_for_each_entry(fp, &subs->fmt_list, list) {
 888                 ep = snd_usb_get_endpoint(chip, fp->endpoint);
 889                 if (ep && ep->cur_audiofmt) {
 890                         /* if EP is already opened solely for this substream,
 891                          * we still allow us to change the parameter; otherwise
 892                          * this substream has to follow the existing parameter
 893                          */
 894                         if (ep->cur_audiofmt != subs->cur_audiofmt || ep->opened > 1)
 895                                 return ep;
 896                 }
 897                 if (!fp->implicit_fb)
 898                         continue;
 899                 /* for the implicit fb, check the sync ep as well */
 900                 ep = snd_usb_get_endpoint(chip, fp->sync_ep);
 901                 if (ep && ep->cur_audiofmt)
 902                         return ep;
 903         }
 904         return NULL;
 905 }
 906
 907 /* additional hw constraints for implicit feedback mode */
 908 static int hw_rule_format_implicit_fb(struct snd_pcm_hw_params *params,
 909                                       struct snd_pcm_hw_rule *rule)
 910 {
 911         struct snd_usb_substream *subs = rule->private;
 912         const struct snd_usb_endpoint *ep;
 913         struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
 914
 915         ep = get_sync_ep_from_substream(subs);
 916         if (!ep)
 917                 return 0;
 918
 919         hwc_debug("applying %s\n", __func__);
 920         return apply_hw_params_format_bits(fmt, pcm_format_to_bits(ep->cur_format));
 921 }
 922
 923 static int hw_rule_rate_implicit_fb(struct snd_pcm_hw_params *params,
 924                                     struct snd_pcm_hw_rule *rule)
 925 {
 926         struct snd_usb_substream *subs = rule->private;
 927         const struct snd_usb_endpoint *ep;
 928         struct snd_interval *it;
 929
 930         ep = get_sync_ep_from_substream(subs);
 931         if (!ep)
 932                 return 0;
 933
 934         hwc_debug("applying %s\n", __func__);
 935         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 936         return apply_hw_params_minmax(it, ep->cur_rate, ep->cur_rate);
 937 }
 938
 939 static int hw_rule_period_size_implicit_fb(struct snd_pcm_hw_params *params,
 940                                            struct snd_pcm_hw_rule *rule)
 941 {
 942         struct snd_usb_substream *subs = rule->private;
 943         const struct snd_usb_endpoint *ep;
 944         struct snd_interval *it;
 945
 946         ep = get_sync_ep_from_substream(subs);
 947         if (!ep)
 948                 return 0;
 949
 950         hwc_debug("applying %s\n", __func__);
 951         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
 952         return apply_hw_params_minmax(it, ep->cur_period_frames,
 953                                       ep->cur_period_frames);
 954 }
 955
 956 static int hw_rule_periods_implicit_fb(struct snd_pcm_hw_params *params,
 957                                        struct snd_pcm_hw_rule *rule)
 958 {
 959         struct snd_usb_substream *subs = rule->private;
 960         const struct snd_usb_endpoint *ep;
 961         struct snd_interval *it;
 962
 963         ep = get_sync_ep_from_substream(subs);
 964         if (!ep)
 965                 return 0;
 966
 967         hwc_debug("applying %s\n", __func__);
 968         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIODS);
 969         return apply_hw_params_minmax(it, ep->cur_buffer_periods,
 970                                       ep->cur_buffer_periods);
 971 }
 972
 973 /*
 974  * set up the runtime hardware information.
 975  */
 976
 977 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
 978 {
 979         const struct audioformat *fp;
 980         unsigned int pt, ptmin;
 981         int param_period_time_if_needed = -1;
 982         int err;
 983
 984         runtime->hw.formats = subs->formats;
 985
 986         runtime->hw.rate_min = 0x7fffffff;
 987         runtime->hw.rate_max = 0;
 988         runtime->hw.channels_min = 256;
 989         runtime->hw.channels_max = 0;
 990         runtime->hw.rates = 0;
 991         ptmin = UINT_MAX;
 992         /* check min/max rates and channels */
 993         list_for_each_entry(fp, &subs->fmt_list, list) {
 994                 runtime->hw.rates |= fp->rates;
 995                 if (runtime->hw.rate_min > fp->rate_min)
 996                         runtime->hw.rate_min = fp->rate_min;
 997                 if (runtime->hw.rate_max < fp->rate_max)
 998                         runtime->hw.rate_max = fp->rate_max;
 999                 if (runtime->hw.channels_min > fp->channels)
1000                         runtime->hw.channels_min = fp->channels;
1001                 if (runtime->hw.channels_max < fp->channels)
1002                         runtime->hw.channels_max = fp->channels;
1003                 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1004                         /* FIXME: there might be more than one audio formats... */
1005                         runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1006                                 fp->frame_size;
1007                 }
1008                 pt = 125 * (1 << fp->datainterval);
1009                 ptmin = min(ptmin, pt);
1010         }
1011
1012         param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1013         if (subs->speed == USB_SPEED_FULL)
1014                 /* full speed devices have fixed data packet interval */
1015                 ptmin = 1000;
1016         if (ptmin == 1000)
1017                 /* if period time doesn't go below 1 ms, no rules needed */
1018                 param_period_time_if_needed = -1;
1019
1020         err = snd_pcm_hw_constraint_minmax(runtime,
1021                                            SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1022                                            ptmin, UINT_MAX);
1023         if (err < 0)
1024                 return err;
1025
1026         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1027                                   hw_rule_rate, subs,
1028                                   SNDRV_PCM_HW_PARAM_RATE,
1029                                   SNDRV_PCM_HW_PARAM_FORMAT,
1030                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1031                                   param_period_time_if_needed,
1032                                   -1);
1033         if (err < 0)
1034                 return err;
1035
1036         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1037                                   hw_rule_channels, subs,
1038                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1039                                   SNDRV_PCM_HW_PARAM_FORMAT,
1040                                   SNDRV_PCM_HW_PARAM_RATE,
1041                                   param_period_time_if_needed,
1042                                   -1);
1043         if (err < 0)
1044                 return err;
1045         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1046                                   hw_rule_format, subs,
1047                                   SNDRV_PCM_HW_PARAM_FORMAT,
1048                                   SNDRV_PCM_HW_PARAM_RATE,
1049                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1050                                   param_period_time_if_needed,
1051                                   -1);
1052         if (err < 0)
1053                 return err;
1054         if (param_period_time_if_needed >= 0) {
1055                 err = snd_pcm_hw_rule_add(runtime, 0,
1056                                           SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1057                                           hw_rule_period_time, subs,
1058                                           SNDRV_PCM_HW_PARAM_FORMAT,
1059                                           SNDRV_PCM_HW_PARAM_CHANNELS,
1060                                           SNDRV_PCM_HW_PARAM_RATE,
1061                                           -1);
1062                 if (err < 0)
1063                         return err;
1064         }
1065
1066         /* additional hw constraints for implicit fb */
1067         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1068                                   hw_rule_format_implicit_fb, subs,
1069                                   SNDRV_PCM_HW_PARAM_FORMAT, -1);
1070         if (err < 0)
1071                 return err;
1072         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1073                                   hw_rule_rate_implicit_fb, subs,
1074                                   SNDRV_PCM_HW_PARAM_RATE, -1);
1075         if (err < 0)
1076                 return err;
1077         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
1078                                   hw_rule_period_size_implicit_fb, subs,
1079                                   SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
1080         if (err < 0)
1081                 return err;
1082         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
1083                                   hw_rule_periods_implicit_fb, subs,
1084                                   SNDRV_PCM_HW_PARAM_PERIODS, -1);
1085         if (err < 0)
1086                 return err;
1087
1088         list_for_each_entry(fp, &subs->fmt_list, list) {
1089                 if (fp->implicit_fb) {
1090                         runtime->hw.info |= SNDRV_PCM_INFO_JOINT_DUPLEX;
1091                         break;
1092                 }
1093         }
1094
1095         return 0;
1096 }
1097
1098 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1099 {
1100         int direction = substream->stream;
1101         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1102         struct snd_pcm_runtime *runtime = substream->runtime;
1103         struct snd_usb_substream *subs = &as->substream[direction];
1104         int ret;
1105
1106         runtime->hw = snd_usb_hardware;
1107         /* need an explicit sync to catch applptr update in low-latency mode */
1108         if (direction == SNDRV_PCM_STREAM_PLAYBACK &&
1109             as->chip->lowlatency)
1110                 runtime->hw.info |= SNDRV_PCM_INFO_SYNC_APPLPTR;
1111         runtime->private_data = subs;
1112         subs->pcm_substream = substream;
1113         /* runtime PM is also done there */
1114
1115         /* initialize DSD/DOP context */
1116         subs->dsd_dop.byte_idx = 0;
1117         subs->dsd_dop.channel = 0;
1118         subs->dsd_dop.marker = 1;
1119
1120         ret = setup_hw_info(runtime, subs);
1121         if (ret < 0)
1122                 return ret;
1123         ret = snd_usb_autoresume(subs->stream->chip);
1124         if (ret < 0)
1125                 return ret;
1126         ret = snd_media_stream_init(subs, as->pcm, direction);
1127         if (ret < 0)
1128                 snd_usb_autosuspend(subs->stream->chip);
1129         return ret;
1130 }
1131
1132 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1133 {
1134         int direction = substream->stream;
1135         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1136         struct snd_usb_substream *subs = &as->substream[direction];
1137         int ret;
1138
1139         snd_media_stop_pipeline(subs);
1140
1141         if (!snd_usb_lock_shutdown(subs->stream->chip)) {
1142                 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1143                 snd_usb_unlock_shutdown(subs->stream->chip);
1144                 if (ret < 0)
1145                         return ret;
1146         }
1147
1148         subs->pcm_substream = NULL;
1149         snd_usb_autosuspend(subs->stream->chip);
1150
1151         return 0;
1152 }
1153
1154 /* Since a URB can handle only a single linear buffer, we must use double
1155  * buffering when the data to be transferred overflows the buffer boundary.
1156  * To avoid inconsistencies when updating hwptr_done, we use double buffering
1157  * for all URBs.
1158  */
1159 static void retire_capture_urb(struct snd_usb_substream *subs,
1160                                struct urb *urb)
1161 {
1162         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1163         unsigned int stride, frames, bytes, oldptr;
1164         int i, period_elapsed = 0;
1165         unsigned long flags;
1166         unsigned char *cp;
1167         int current_frame_number;
1168
1169         /* read frame number here, update pointer in critical section */
1170         current_frame_number = usb_get_current_frame_number(subs->dev);
1171
1172         stride = runtime->frame_bits >> 3;
1173
1174         for (i = 0; i < urb->number_of_packets; i++) {
1175                 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1176                 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1177                         dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1178                                 i, urb->iso_frame_desc[i].status);
1179                         // continue;
1180                 }
1181                 bytes = urb->iso_frame_desc[i].actual_length;
1182                 if (subs->stream_offset_adj > 0) {
1183                         unsigned int adj = min(subs->stream_offset_adj, bytes);
1184                         cp += adj;
1185                         bytes -= adj;
1186                         subs->stream_offset_adj -= adj;
1187                 }
1188                 frames = bytes / stride;
1189                 if (!subs->txfr_quirk)
1190                         bytes = frames * stride;
1191                 if (bytes % (runtime->sample_bits >> 3) != 0) {
1192                         int oldbytes = bytes;
1193                         bytes = frames * stride;
1194                         dev_warn_ratelimited(&subs->dev->dev,
1195                                  "Corrected urb data len. %d->%d\n",
1196                                                         oldbytes, bytes);
1197                 }
1198                 /* update the current pointer */
1199                 spin_lock_irqsave(&subs->lock, flags);
1200                 oldptr = subs->hwptr_done;
1201                 subs->hwptr_done += bytes;
1202                 if (subs->hwptr_done >= subs->buffer_bytes)
1203                         subs->hwptr_done -= subs->buffer_bytes;
1204                 frames = (bytes + (oldptr % stride)) / stride;
1205                 subs->transfer_done += frames;
1206                 if (subs->transfer_done >= runtime->period_size) {
1207                         subs->transfer_done -= runtime->period_size;
1208                         period_elapsed = 1;
1209                 }
1210
1211                 /* realign last_frame_number */
1212                 subs->last_frame_number = current_frame_number;
1213
1214                 spin_unlock_irqrestore(&subs->lock, flags);
1215                 /* copy a data chunk */
1216                 if (oldptr + bytes > subs->buffer_bytes) {
1217                         unsigned int bytes1 = subs->buffer_bytes - oldptr;
1218
1219                         memcpy(runtime->dma_area + oldptr, cp, bytes1);
1220                         memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1221                 } else {
1222                         memcpy(runtime->dma_area + oldptr, cp, bytes);
1223                 }
1224         }
1225
1226         if (period_elapsed)
1227                 snd_pcm_period_elapsed(subs->pcm_substream);
1228 }
1229
1230 static void urb_ctx_queue_advance(struct snd_usb_substream *subs,
1231                                   struct urb *urb, unsigned int bytes)
1232 {
1233         struct snd_urb_ctx *ctx = urb->context;
1234
1235         ctx->queued += bytes;
1236         subs->inflight_bytes += bytes;
1237         subs->hwptr_done += bytes;
1238         if (subs->hwptr_done >= subs->buffer_bytes)
1239                 subs->hwptr_done -= subs->buffer_bytes;
1240 }
1241
1242 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1243                                              struct urb *urb, unsigned int bytes)
1244 {
1245         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1246         unsigned int dst_idx = 0;
1247         unsigned int src_idx = subs->hwptr_done;
1248         unsigned int wrap = subs->buffer_bytes;
1249         u8 *dst = urb->transfer_buffer;
1250         u8 *src = runtime->dma_area;
1251         u8 marker[] = { 0x05, 0xfa };
1252         unsigned int queued = 0;
1253
1254         /*
1255          * The DSP DOP format defines a way to transport DSD samples over
1256          * normal PCM data endpoints. It requires stuffing of marker bytes
1257          * (0x05 and 0xfa, alternating per sample frame), and then expects
1258          * 2 additional bytes of actual payload. The whole frame is stored
1259          * LSB.
1260          *
1261          * Hence, for a stereo transport, the buffer layout looks like this,
1262          * where L refers to left channel samples and R to right.
1263          *
1264          *   L1 L2 0x05   R1 R2 0x05   L3 L4 0xfa  R3 R4 0xfa
1265          *   L5 L6 0x05   R5 R6 0x05   L7 L8 0xfa  R7 R8 0xfa
1266          *   .....
1267          *
1268          */
1269
1270         while (bytes--) {
1271                 if (++subs->dsd_dop.byte_idx == 3) {
1272                         /* frame boundary? */
1273                         dst[dst_idx++] = marker[subs->dsd_dop.marker];
1274                         src_idx += 2;
1275                         subs->dsd_dop.byte_idx = 0;
1276
1277                         if (++subs->dsd_dop.channel % runtime->channels == 0) {
1278                                 /* alternate the marker */
1279                                 subs->dsd_dop.marker++;
1280                                 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1281                                 subs->dsd_dop.channel = 0;
1282                         }
1283                 } else {
1284                         /* stuff the DSD payload */
1285                         int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1286
1287                         if (subs->cur_audiofmt->dsd_bitrev)
1288                                 dst[dst_idx++] = bitrev8(src[idx]);
1289                         else
1290                                 dst[dst_idx++] = src[idx];
1291                         queued++;
1292                 }
1293         }
1294
1295         urb_ctx_queue_advance(subs, urb, queued);
1296 }
1297
1298 /* copy bit-reversed bytes onto transfer buffer */
1299 static void fill_playback_urb_dsd_bitrev(struct snd_usb_substream *subs,
1300                                          struct urb *urb, unsigned int bytes)
1301 {
1302         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1303         const u8 *src = runtime->dma_area;
1304         u8 *buf = urb->transfer_buffer;
1305         int i, ofs = subs->hwptr_done;
1306
1307         for (i = 0; i < bytes; i++) {
1308                 *buf++ = bitrev8(src[ofs]);
1309                 if (++ofs >= subs->buffer_bytes)
1310                         ofs = 0;
1311         }
1312
1313         urb_ctx_queue_advance(subs, urb, bytes);
1314 }
1315
1316 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1317                         int offset, int stride, unsigned int bytes)
1318 {
1319         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1320
1321         if (subs->hwptr_done + bytes > subs->buffer_bytes) {
1322                 /* err, the transferred area goes over buffer boundary. */
1323                 unsigned int bytes1 = subs->buffer_bytes - subs->hwptr_done;
1324
1325                 memcpy(urb->transfer_buffer + offset,
1326                        runtime->dma_area + subs->hwptr_done, bytes1);
1327                 memcpy(urb->transfer_buffer + offset + bytes1,
1328                        runtime->dma_area, bytes - bytes1);
1329         } else {
1330                 memcpy(urb->transfer_buffer + offset,
1331                        runtime->dma_area + subs->hwptr_done, bytes);
1332         }
1333
1334         urb_ctx_queue_advance(subs, urb, bytes);
1335 }
1336
1337 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1338                                       struct urb *urb, int stride,
1339                                       unsigned int bytes)
1340 {
1341         __le32 packet_length;
1342         int i;
1343
1344         /* Put __le32 length descriptor at start of each packet. */
1345         for (i = 0; i < urb->number_of_packets; i++) {
1346                 unsigned int length = urb->iso_frame_desc[i].length;
1347                 unsigned int offset = urb->iso_frame_desc[i].offset;
1348
1349                 packet_length = cpu_to_le32(length);
1350                 offset += i * sizeof(packet_length);
1351                 urb->iso_frame_desc[i].offset = offset;
1352                 urb->iso_frame_desc[i].length += sizeof(packet_length);
1353                 memcpy(urb->transfer_buffer + offset,
1354                        &packet_length, sizeof(packet_length));
1355                 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1356                             stride, length);
1357         }
1358         /* Adjust transfer size accordingly. */
1359         bytes += urb->number_of_packets * sizeof(packet_length);
1360         return bytes;
1361 }
1362
1363 static int prepare_playback_urb(struct snd_usb_substream *subs,
1364                                 struct urb *urb,
1365                                 bool in_stream_lock)
1366 {
1367         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1368         struct snd_usb_endpoint *ep = subs->data_endpoint;
1369         struct snd_urb_ctx *ctx = urb->context;
1370         unsigned int frames, bytes;
1371         int counts;
1372         unsigned int transfer_done, frame_limit, avail = 0;
1373         int i, stride, period_elapsed = 0;
1374         unsigned long flags;
1375         int err = 0;
1376
1377         stride = ep->stride;
1378
1379         frames = 0;
1380         ctx->queued = 0;
1381         urb->number_of_packets = 0;
1382
1383         spin_lock_irqsave(&subs->lock, flags);
1384         frame_limit = subs->frame_limit + ep->max_urb_frames;
1385         transfer_done = subs->transfer_done;
1386
1387         if (subs->lowlatency_playback &&
1388             runtime->status->state != SNDRV_PCM_STATE_DRAINING) {
1389                 unsigned int hwptr = subs->hwptr_done / stride;
1390
1391                 /* calculate the byte offset-in-buffer of the appl_ptr */
1392                 avail = (runtime->control->appl_ptr - runtime->hw_ptr_base)
1393                         % runtime->buffer_size;
1394                 if (avail <= hwptr)
1395                         avail += runtime->buffer_size;
1396                 avail -= hwptr;
1397         }
1398
1399         for (i = 0; i < ctx->packets; i++) {
1400                 counts = snd_usb_endpoint_next_packet_size(ep, ctx, i, avail);
1401                 if (counts < 0)
1402                         break;
1403                 /* set up descriptor */
1404                 urb->iso_frame_desc[i].offset = frames * stride;
1405                 urb->iso_frame_desc[i].length = counts * stride;
1406                 frames += counts;
1407                 avail -= counts;
1408                 urb->number_of_packets++;
1409                 transfer_done += counts;
1410                 if (transfer_done >= runtime->period_size) {
1411                         transfer_done -= runtime->period_size;
1412                         frame_limit = 0;
1413                         period_elapsed = 1;
1414                         if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1415                                 if (transfer_done > 0) {
1416                                         /* FIXME: fill-max mode is not
1417                                          * supported yet */
1418                                         frames -= transfer_done;
1419                                         counts -= transfer_done;
1420                                         urb->iso_frame_desc[i].length =
1421                                                 counts * stride;
1422                                         transfer_done = 0;
1423                                 }
1424                                 i++;
1425                                 if (i < ctx->packets) {
1426                                         /* add a transfer delimiter */
1427                                         urb->iso_frame_desc[i].offset =
1428                                                 frames * stride;
1429                                         urb->iso_frame_desc[i].length = 0;
1430                                         urb->number_of_packets++;
1431                                 }
1432                                 break;
1433                         }
1434                 }
1435                 /* finish at the period boundary or after enough frames */
1436                 if ((period_elapsed || transfer_done >= frame_limit) &&
1437                     !snd_usb_endpoint_implicit_feedback_sink(ep))
1438                         break;
1439         }
1440
1441         if (!frames) {
1442                 err = -EAGAIN;
1443                 goto unlock;
1444         }
1445
1446         bytes = frames * stride;
1447         subs->transfer_done = transfer_done;
1448         subs->frame_limit = frame_limit;
1449         if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1450                      subs->cur_audiofmt->dsd_dop)) {
1451                 fill_playback_urb_dsd_dop(subs, urb, bytes);
1452         } else if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1453                            subs->cur_audiofmt->dsd_bitrev)) {
1454                 fill_playback_urb_dsd_bitrev(subs, urb, bytes);
1455         } else {
1456                 /* usual PCM */
1457                 if (!subs->tx_length_quirk)
1458                         copy_to_urb(subs, urb, 0, stride, bytes);
1459                 else
1460                         bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1461                         /* bytes is now amount of outgoing data */
1462         }
1463
1464         subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1465
1466         if (subs->trigger_tstamp_pending_update) {
1467                 /* this is the first actual URB submitted,
1468                  * update trigger timestamp to reflect actual start time
1469                  */
1470                 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1471                 subs->trigger_tstamp_pending_update = false;
1472         }
1473
1474         if (period_elapsed && !subs->running && subs->lowlatency_playback) {
1475                 subs->period_elapsed_pending = 1;
1476                 period_elapsed = 0;
1477         }
1478
1479  unlock:
1480         spin_unlock_irqrestore(&subs->lock, flags);
1481         if (err < 0)
1482                 return err;
1483         urb->transfer_buffer_length = bytes;
1484         if (period_elapsed) {
1485                 if (in_stream_lock)
1486                         snd_pcm_period_elapsed_under_stream_lock(subs->pcm_substream);
1487                 else
1488                         snd_pcm_period_elapsed(subs->pcm_substream);
1489         }
1490         return 0;
1491 }
1492
1493 /*
1494  * process after playback data complete
1495  * - decrease the delay count again
1496  */
1497 static void retire_playback_urb(struct snd_usb_substream *subs,
1498                                struct urb *urb)
1499 {
1500         unsigned long flags;
1501         struct snd_urb_ctx *ctx = urb->context;
1502         bool period_elapsed = false;
1503
1504         spin_lock_irqsave(&subs->lock, flags);
1505         if (ctx->queued) {
1506                 if (subs->inflight_bytes >= ctx->queued)
1507                         subs->inflight_bytes -= ctx->queued;
1508                 else
1509                         subs->inflight_bytes = 0;
1510         }
1511
1512         subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1513         if (subs->running) {
1514                 period_elapsed = subs->period_elapsed_pending;
1515                 subs->period_elapsed_pending = 0;
1516         }
1517         spin_unlock_irqrestore(&subs->lock, flags);
1518         if (period_elapsed)
1519                 snd_pcm_period_elapsed(subs->pcm_substream);
1520 }
1521
1522 /* PCM ack callback for the playback stream;
1523  * this plays a role only when the stream is running in low-latency mode.
1524  */
1525 static int snd_usb_pcm_playback_ack(struct snd_pcm_substream *substream)
1526 {
1527         struct snd_usb_substream *subs = substream->runtime->private_data;
1528         struct snd_usb_endpoint *ep;
1529
1530         if (!subs->lowlatency_playback || !subs->running)
1531                 return 0;
1532         ep = subs->data_endpoint;
1533         if (!ep)
1534                 return 0;
1535         /* When no more in-flight URBs available, try to process the pending
1536          * outputs here
1537          */
1538         if (!ep->active_mask)
1539                 snd_usb_queue_pending_output_urbs(ep, true);
1540         return 0;
1541 }
1542
1543 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1544                                               int cmd)
1545 {
1546         struct snd_usb_substream *subs = substream->runtime->private_data;
1547         int err;
1548
1549         switch (cmd) {
1550         case SNDRV_PCM_TRIGGER_START:
1551                 subs->trigger_tstamp_pending_update = true;
1552                 fallthrough;
1553         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1554                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1555                                               prepare_playback_urb,
1556                                               retire_playback_urb,
1557                                               subs);
1558                 if (subs->lowlatency_playback &&
1559                     cmd == SNDRV_PCM_TRIGGER_START) {
1560                         if (in_free_wheeling_mode(substream->runtime))
1561                                 subs->lowlatency_playback = false;
1562                         err = start_endpoints(subs);
1563                         if (err < 0) {
1564                                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1565                                                               NULL, NULL, NULL);
1566                                 return err;
1567                         }
1568                 }
1569                 subs->running = 1;
1570                 dev_dbg(&subs->dev->dev, "%d:%d Start Playback PCM\n",
1571                         subs->cur_audiofmt->iface,
1572                         subs->cur_audiofmt->altsetting);
1573                 return 0;
1574         case SNDRV_PCM_TRIGGER_SUSPEND:
1575         case SNDRV_PCM_TRIGGER_STOP:
1576                 stop_endpoints(subs, substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING);
1577                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1578                                               NULL, NULL, NULL);
1579                 subs->running = 0;
1580                 dev_dbg(&subs->dev->dev, "%d:%d Stop Playback PCM\n",
1581                         subs->cur_audiofmt->iface,
1582                         subs->cur_audiofmt->altsetting);
1583                 return 0;
1584         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1585                 /* keep retire_data_urb for delay calculation */
1586                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1587                                               NULL,
1588                                               retire_playback_urb,
1589                                               subs);
1590                 subs->running = 0;
1591                 dev_dbg(&subs->dev->dev, "%d:%d Pause Playback PCM\n",
1592                         subs->cur_audiofmt->iface,
1593                         subs->cur_audiofmt->altsetting);
1594                 return 0;
1595         }
1596
1597         return -EINVAL;
1598 }
1599
1600 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1601                                              int cmd)
1602 {
1603         int err;
1604         struct snd_usb_substream *subs = substream->runtime->private_data;
1605
1606         switch (cmd) {
1607         case SNDRV_PCM_TRIGGER_START:
1608                 err = start_endpoints(subs);
1609                 if (err < 0)
1610                         return err;
1611                 fallthrough;
1612         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1613                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1614                                               NULL, retire_capture_urb,
1615                                               subs);
1616                 subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1617                 subs->running = 1;
1618                 dev_dbg(&subs->dev->dev, "%d:%d Start Capture PCM\n",
1619                         subs->cur_audiofmt->iface,
1620                         subs->cur_audiofmt->altsetting);
1621                 return 0;
1622         case SNDRV_PCM_TRIGGER_SUSPEND:
1623         case SNDRV_PCM_TRIGGER_STOP:
1624                 stop_endpoints(subs, false);
1625                 fallthrough;
1626         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1627                 snd_usb_endpoint_set_callback(subs->data_endpoint,
1628                                               NULL, NULL, NULL);
1629                 subs->running = 0;
1630                 dev_dbg(&subs->dev->dev, "%d:%d Stop Capture PCM\n",
1631                         subs->cur_audiofmt->iface,
1632                         subs->cur_audiofmt->altsetting);
1633                 return 0;
1634         }
1635
1636         return -EINVAL;
1637 }
1638
1639 static const struct snd_pcm_ops snd_usb_playback_ops = {
1640         .open =         snd_usb_pcm_open,
1641         .close =        snd_usb_pcm_close,
1642         .hw_params =    snd_usb_hw_params,
1643         .hw_free =      snd_usb_hw_free,
1644         .prepare =      snd_usb_pcm_prepare,
1645         .trigger =      snd_usb_substream_playback_trigger,
1646         .sync_stop =    snd_usb_pcm_sync_stop,
1647         .pointer =      snd_usb_pcm_pointer,
1648         .ack =          snd_usb_pcm_playback_ack,
1649 };
1650
1651 static const struct snd_pcm_ops snd_usb_capture_ops = {
1652         .open =         snd_usb_pcm_open,
1653         .close =        snd_usb_pcm_close,
1654         .hw_params =    snd_usb_hw_params,
1655         .hw_free =      snd_usb_hw_free,
1656         .prepare =      snd_usb_pcm_prepare,
1657         .trigger =      snd_usb_substream_capture_trigger,
1658         .sync_stop =    snd_usb_pcm_sync_stop,
1659         .pointer =      snd_usb_pcm_pointer,
1660 };
1661
1662 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1663 {
1664         const struct snd_pcm_ops *ops;
1665
1666         ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1667                         &snd_usb_playback_ops : &snd_usb_capture_ops;
1668         snd_pcm_set_ops(pcm, stream, ops);
1669 }
1670
1671 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1672 {
1673         struct snd_pcm *pcm = subs->stream->pcm;
1674         struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1675         struct device *dev = subs->dev->bus->sysdev;
1676
1677         if (snd_usb_use_vmalloc)
1678                 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_VMALLOC,
1679                                            NULL, 0, 0);
1680         else
1681                 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_DEV_SG,
1682                                            dev, 64*1024, 512*1024);
1683 }