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