sound/usb/endpoint.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  */
   4
   5 #include <linux/gfp.h>
   6 #include <linux/init.h>
   7 #include <linux/ratelimit.h>
   8 #include <linux/usb.h>
   9 #include <linux/usb/audio.h>
  10 #include <linux/slab.h>
  11
  12 #include <sound/core.h>
  13 #include <sound/pcm.h>
  14 #include <sound/pcm_params.h>
  15
  16 #include "usbaudio.h"
  17 #include "helper.h"
  18 #include "card.h"
  19 #include "endpoint.h"
  20 #include "pcm.h"
  21 #include "quirks.h"
  22
  23 #define EP_FLAG_RUNNING         1
  24 #define EP_FLAG_STOPPING        2
  25
  26 /*
  27  * snd_usb_endpoint is a model that abstracts everything related to an
  28  * USB endpoint and its streaming.
  29  *
  30  * There are functions to activate and deactivate the streaming URBs and
  31  * optional callbacks to let the pcm logic handle the actual content of the
  32  * packets for playback and record. Thus, the bus streaming and the audio
  33  * handlers are fully decoupled.
  34  *
  35  * There are two different types of endpoints in audio applications.
  36  *
  37  * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
  38  * inbound and outbound traffic.
  39  *
  40  * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
  41  * expect the payload to carry Q10.14 / Q16.16 formatted sync information
  42  * (3 or 4 bytes).
  43  *
  44  * Each endpoint has to be configured prior to being used by calling
  45  * snd_usb_endpoint_set_params().
  46  *
  47  * The model incorporates a reference counting, so that multiple users
  48  * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
  49  * only the first user will effectively start the URBs, and only the last
  50  * one to stop it will tear the URBs down again.
  51  */
  52
  53 /*
  54  * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
  55  * this will overflow at approx 524 kHz
  56  */
  57 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
  58 {
  59         return ((rate << 13) + 62) / 125;
  60 }
  61
  62 /*
  63  * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
  64  * this will overflow at approx 4 MHz
  65  */
  66 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
  67 {
  68         return ((rate << 10) + 62) / 125;
  69 }
  70
  71 /*
  72  * release a urb data
  73  */
  74 static void release_urb_ctx(struct snd_urb_ctx *u)
  75 {
  76         if (u->buffer_size)
  77                 usb_free_coherent(u->ep->chip->dev, u->buffer_size,
  78                                   u->urb->transfer_buffer,
  79                                   u->urb->transfer_dma);
  80         usb_free_urb(u->urb);
  81         u->urb = NULL;
  82 }
  83
  84 static const char *usb_error_string(int err)
  85 {
  86         switch (err) {
  87         case -ENODEV:
  88                 return "no device";
  89         case -ENOENT:
  90                 return "endpoint not enabled";
  91         case -EPIPE:
  92                 return "endpoint stalled";
  93         case -ENOSPC:
  94                 return "not enough bandwidth";
  95         case -ESHUTDOWN:
  96                 return "device disabled";
  97         case -EHOSTUNREACH:
  98                 return "device suspended";
  99         case -EINVAL:
 100         case -EAGAIN:
 101         case -EFBIG:
 102         case -EMSGSIZE:
 103                 return "internal error";
 104         default:
 105                 return "unknown error";
 106         }
 107 }
 108
 109 /**
 110  * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
 111  *
 112  * @ep: The snd_usb_endpoint
 113  *
 114  * Determine whether an endpoint is driven by an implicit feedback
 115  * data endpoint source.
 116  */
 117 int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
 118 {
 119         return  ep->sync_master &&
 120                 ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
 121                 ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
 122                 usb_pipeout(ep->pipe);
 123 }
 124
 125 /*
 126  * For streaming based on information derived from sync endpoints,
 127  * prepare_outbound_urb_sizes() will call next_packet_size() to
 128  * determine the number of samples to be sent in the next packet.
 129  *
 130  * For implicit feedback, next_packet_size() is unused.
 131  */
 132 int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
 133 {
 134         unsigned long flags;
 135         int ret;
 136
 137         if (ep->fill_max)
 138                 return ep->maxframesize;
 139
 140         spin_lock_irqsave(&ep->lock, flags);
 141         ep->phase = (ep->phase & 0xffff)
 142                 + (ep->freqm << ep->datainterval);
 143         ret = min(ep->phase >> 16, ep->maxframesize);
 144         spin_unlock_irqrestore(&ep->lock, flags);
 145
 146         return ret;
 147 }
 148
 149 static void retire_outbound_urb(struct snd_usb_endpoint *ep,
 150                                 struct snd_urb_ctx *urb_ctx)
 151 {
 152         if (ep->retire_data_urb)
 153                 ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
 154 }
 155
 156 static void retire_inbound_urb(struct snd_usb_endpoint *ep,
 157                                struct snd_urb_ctx *urb_ctx)
 158 {
 159         struct urb *urb = urb_ctx->urb;
 160
 161         if (unlikely(ep->skip_packets > 0)) {
 162                 ep->skip_packets--;
 163                 return;
 164         }
 165
 166         if (ep->sync_slave)
 167                 snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
 168
 169         if (ep->retire_data_urb)
 170                 ep->retire_data_urb(ep->data_subs, urb);
 171 }
 172
 173 static void prepare_silent_urb(struct snd_usb_endpoint *ep,
 174                                struct snd_urb_ctx *ctx)
 175 {
 176         struct urb *urb = ctx->urb;
 177         unsigned int offs = 0;
 178         unsigned int extra = 0;
 179         __le32 packet_length;
 180         int i;
 181
 182         /* For tx_length_quirk, put packet length at start of packet */
 183         if (ep->chip->tx_length_quirk)
 184                 extra = sizeof(packet_length);
 185
 186         for (i = 0; i < ctx->packets; ++i) {
 187                 unsigned int offset;
 188                 unsigned int length;
 189                 int counts;
 190
 191                 if (ctx->packet_size[i])
 192                         counts = ctx->packet_size[i];
 193                 else
 194                         counts = snd_usb_endpoint_next_packet_size(ep);
 195
 196                 length = counts * ep->stride; /* number of silent bytes */
 197                 offset = offs * ep->stride + extra * i;
 198                 urb->iso_frame_desc[i].offset = offset;
 199                 urb->iso_frame_desc[i].length = length + extra;
 200                 if (extra) {
 201                         packet_length = cpu_to_le32(length);
 202                         memcpy(urb->transfer_buffer + offset,
 203                                &packet_length, sizeof(packet_length));
 204                 }
 205                 memset(urb->transfer_buffer + offset + extra,
 206                        ep->silence_value, length);
 207                 offs += counts;
 208         }
 209
 210         urb->number_of_packets = ctx->packets;
 211         urb->transfer_buffer_length = offs * ep->stride + ctx->packets * extra;
 212 }
 213
 214 /*
 215  * Prepare a PLAYBACK urb for submission to the bus.
 216  */
 217 static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
 218                                  struct snd_urb_ctx *ctx)
 219 {
 220         struct urb *urb = ctx->urb;
 221         unsigned char *cp = urb->transfer_buffer;
 222
 223         urb->dev = ep->chip->dev; /* we need to set this at each time */
 224
 225         switch (ep->type) {
 226         case SND_USB_ENDPOINT_TYPE_DATA:
 227                 if (ep->prepare_data_urb) {
 228                         ep->prepare_data_urb(ep->data_subs, urb);
 229                 } else {
 230                         /* no data provider, so send silence */
 231                         prepare_silent_urb(ep, ctx);
 232                 }
 233                 break;
 234
 235         case SND_USB_ENDPOINT_TYPE_SYNC:
 236                 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
 237                         /*
 238                          * fill the length and offset of each urb descriptor.
 239                          * the fixed 12.13 frequency is passed as 16.16 through the pipe.
 240                          */
 241                         urb->iso_frame_desc[0].length = 4;
 242                         urb->iso_frame_desc[0].offset = 0;
 243                         cp[0] = ep->freqn;
 244                         cp[1] = ep->freqn >> 8;
 245                         cp[2] = ep->freqn >> 16;
 246                         cp[3] = ep->freqn >> 24;
 247                 } else {
 248                         /*
 249                          * fill the length and offset of each urb descriptor.
 250                          * the fixed 10.14 frequency is passed through the pipe.
 251                          */
 252                         urb->iso_frame_desc[0].length = 3;
 253                         urb->iso_frame_desc[0].offset = 0;
 254                         cp[0] = ep->freqn >> 2;
 255                         cp[1] = ep->freqn >> 10;
 256                         cp[2] = ep->freqn >> 18;
 257                 }
 258
 259                 break;
 260         }
 261 }
 262
 263 /*
 264  * Prepare a CAPTURE or SYNC urb for submission to the bus.
 265  */
 266 static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
 267                                        struct snd_urb_ctx *urb_ctx)
 268 {
 269         int i, offs;
 270         struct urb *urb = urb_ctx->urb;
 271
 272         urb->dev = ep->chip->dev; /* we need to set this at each time */
 273
 274         switch (ep->type) {
 275         case SND_USB_ENDPOINT_TYPE_DATA:
 276                 offs = 0;
 277                 for (i = 0; i < urb_ctx->packets; i++) {
 278                         urb->iso_frame_desc[i].offset = offs;
 279                         urb->iso_frame_desc[i].length = ep->curpacksize;
 280                         offs += ep->curpacksize;
 281                 }
 282
 283                 urb->transfer_buffer_length = offs;
 284                 urb->number_of_packets = urb_ctx->packets;
 285                 break;
 286
 287         case SND_USB_ENDPOINT_TYPE_SYNC:
 288                 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
 289                 urb->iso_frame_desc[0].offset = 0;
 290                 break;
 291         }
 292 }
 293
 294 /*
 295  * Send output urbs that have been prepared previously. URBs are dequeued
 296  * from ep->ready_playback_urbs and in case there there aren't any available
 297  * or there are no packets that have been prepared, this function does
 298  * nothing.
 299  *
 300  * The reason why the functionality of sending and preparing URBs is separated
 301  * is that host controllers don't guarantee the order in which they return
 302  * inbound and outbound packets to their submitters.
 303  *
 304  * This function is only used for implicit feedback endpoints. For endpoints
 305  * driven by dedicated sync endpoints, URBs are immediately re-submitted
 306  * from their completion handler.
 307  */
 308 static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
 309 {
 310         while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
 311
 312                 unsigned long flags;
 313                 struct snd_usb_packet_info *uninitialized_var(packet);
 314                 struct snd_urb_ctx *ctx = NULL;
 315                 int err, i;
 316
 317                 spin_lock_irqsave(&ep->lock, flags);
 318                 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
 319                         packet = ep->next_packet + ep->next_packet_read_pos;
 320                         ep->next_packet_read_pos++;
 321                         ep->next_packet_read_pos %= MAX_URBS;
 322
 323                         /* take URB out of FIFO */
 324                         if (!list_empty(&ep->ready_playback_urbs)) {
 325                                 ctx = list_first_entry(&ep->ready_playback_urbs,
 326                                                struct snd_urb_ctx, ready_list);
 327                                 list_del_init(&ctx->ready_list);
 328                         }
 329                 }
 330                 spin_unlock_irqrestore(&ep->lock, flags);
 331
 332                 if (ctx == NULL)
 333                         return;
 334
 335                 /* copy over the length information */
 336                 for (i = 0; i < packet->packets; i++)
 337                         ctx->packet_size[i] = packet->packet_size[i];
 338
 339                 /* call the data handler to fill in playback data */
 340                 prepare_outbound_urb(ep, ctx);
 341
 342                 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
 343                 if (err < 0)
 344                         usb_audio_err(ep->chip,
 345                                 "Unable to submit urb #%d: %d (urb %p)\n",
 346                                 ctx->index, err, ctx->urb);
 347                 else
 348                         set_bit(ctx->index, &ep->active_mask);
 349         }
 350 }
 351
 352 /*
 353  * complete callback for urbs
 354  */
 355 static void snd_complete_urb(struct urb *urb)
 356 {
 357         struct snd_urb_ctx *ctx = urb->context;
 358         struct snd_usb_endpoint *ep = ctx->ep;
 359         struct snd_pcm_substream *substream;
 360         unsigned long flags;
 361         int err;
 362
 363         if (unlikely(urb->status == -ENOENT ||          /* unlinked */
 364                      urb->status == -ENODEV ||          /* device removed */
 365                      urb->status == -ECONNRESET ||      /* unlinked */
 366                      urb->status == -ESHUTDOWN))        /* device disabled */
 367                 goto exit_clear;
 368         /* device disconnected */
 369         if (unlikely(atomic_read(&ep->chip->shutdown)))
 370                 goto exit_clear;
 371
 372         if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 373                 goto exit_clear;
 374
 375         if (usb_pipeout(ep->pipe)) {
 376                 retire_outbound_urb(ep, ctx);
 377                 /* can be stopped during retire callback */
 378                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 379                         goto exit_clear;
 380
 381                 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
 382                         spin_lock_irqsave(&ep->lock, flags);
 383                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 384                         spin_unlock_irqrestore(&ep->lock, flags);
 385                         queue_pending_output_urbs(ep);
 386
 387                         goto exit_clear;
 388                 }
 389
 390                 prepare_outbound_urb(ep, ctx);
 391                 /* can be stopped during prepare callback */
 392                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 393                         goto exit_clear;
 394         } else {
 395                 retire_inbound_urb(ep, ctx);
 396                 /* can be stopped during retire callback */
 397                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 398                         goto exit_clear;
 399
 400                 prepare_inbound_urb(ep, ctx);
 401         }
 402
 403         err = usb_submit_urb(urb, GFP_ATOMIC);
 404         if (err == 0)
 405                 return;
 406
 407         usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
 408         if (ep->data_subs && ep->data_subs->pcm_substream) {
 409                 substream = ep->data_subs->pcm_substream;
 410                 snd_pcm_stop_xrun(substream);
 411         }
 412
 413 exit_clear:
 414         clear_bit(ctx->index, &ep->active_mask);
 415 }
 416
 417 /**
 418  * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
 419  *
 420  * @chip: The chip
 421  * @alts: The USB host interface
 422  * @ep_num: The number of the endpoint to use
 423  * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
 424  * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
 425  *
 426  * If the requested endpoint has not been added to the given chip before,
 427  * a new instance is created. Otherwise, a pointer to the previoulsy
 428  * created instance is returned. In case of any error, NULL is returned.
 429  *
 430  * New endpoints will be added to chip->ep_list and must be freed by
 431  * calling snd_usb_endpoint_free().
 432  *
 433  * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that
 434  * bNumEndpoints > 1 beforehand.
 435  */
 436 struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
 437                                               struct usb_host_interface *alts,
 438                                               int ep_num, int direction, int type)
 439 {
 440         struct snd_usb_endpoint *ep;
 441         int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
 442
 443         if (WARN_ON(!alts))
 444                 return NULL;
 445
 446         mutex_lock(&chip->mutex);
 447
 448         list_for_each_entry(ep, &chip->ep_list, list) {
 449                 if (ep->ep_num == ep_num &&
 450                     ep->iface == alts->desc.bInterfaceNumber &&
 451                     ep->altsetting == alts->desc.bAlternateSetting) {
 452                         usb_audio_dbg(ep->chip,
 453                                       "Re-using EP %x in iface %d,%d @%p\n",
 454                                         ep_num, ep->iface, ep->altsetting, ep);
 455                         goto __exit_unlock;
 456                 }
 457         }
 458
 459         usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
 460                     is_playback ? "playback" : "capture",
 461                     type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
 462                     ep_num);
 463
 464         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
 465         if (!ep)
 466                 goto __exit_unlock;
 467
 468         ep->chip = chip;
 469         spin_lock_init(&ep->lock);
 470         ep->type = type;
 471         ep->ep_num = ep_num;
 472         ep->iface = alts->desc.bInterfaceNumber;
 473         ep->altsetting = alts->desc.bAlternateSetting;
 474         INIT_LIST_HEAD(&ep->ready_playback_urbs);
 475         ep_num &= USB_ENDPOINT_NUMBER_MASK;
 476
 477         if (is_playback)
 478                 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
 479         else
 480                 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
 481
 482         if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
 483                 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 484                     get_endpoint(alts, 1)->bRefresh >= 1 &&
 485                     get_endpoint(alts, 1)->bRefresh <= 9)
 486                         ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
 487                 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
 488                         ep->syncinterval = 1;
 489                 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
 490                          get_endpoint(alts, 1)->bInterval <= 16)
 491                         ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
 492                 else
 493                         ep->syncinterval = 3;
 494
 495                 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
 496         }
 497
 498         list_add_tail(&ep->list, &chip->ep_list);
 499
 500         ep->is_implicit_feedback = 0;
 501
 502 __exit_unlock:
 503         mutex_unlock(&chip->mutex);
 504
 505         return ep;
 506 }
 507
 508 /*
 509  *  wait until all urbs are processed.
 510  */
 511 static int wait_clear_urbs(struct snd_usb_endpoint *ep)
 512 {
 513         unsigned long end_time = jiffies + msecs_to_jiffies(1000);
 514         int alive;
 515
 516         do {
 517                 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
 518                 if (!alive)
 519                         break;
 520
 521                 schedule_timeout_uninterruptible(1);
 522         } while (time_before(jiffies, end_time));
 523
 524         if (alive)
 525                 usb_audio_err(ep->chip,
 526                         "timeout: still %d active urbs on EP #%x\n",
 527                         alive, ep->ep_num);
 528         clear_bit(EP_FLAG_STOPPING, &ep->flags);
 529
 530         ep->data_subs = NULL;
 531         ep->sync_slave = NULL;
 532         ep->retire_data_urb = NULL;
 533         ep->prepare_data_urb = NULL;
 534
 535         return 0;
 536 }
 537
 538 /* sync the pending stop operation;
 539  * this function itself doesn't trigger the stop operation
 540  */
 541 void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
 542 {
 543         if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
 544                 wait_clear_urbs(ep);
 545 }
 546
 547 /*
 548  * unlink active urbs.
 549  */
 550 static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
 551 {
 552         unsigned int i;
 553
 554         if (!force && atomic_read(&ep->chip->shutdown)) /* to be sure... */
 555                 return -EBADFD;
 556
 557         clear_bit(EP_FLAG_RUNNING, &ep->flags);
 558
 559         INIT_LIST_HEAD(&ep->ready_playback_urbs);
 560         ep->next_packet_read_pos = 0;
 561         ep->next_packet_write_pos = 0;
 562
 563         for (i = 0; i < ep->nurbs; i++) {
 564                 if (test_bit(i, &ep->active_mask)) {
 565                         if (!test_and_set_bit(i, &ep->unlink_mask)) {
 566                                 struct urb *u = ep->urb[i].urb;
 567                                 usb_unlink_urb(u);
 568                         }
 569                 }
 570         }
 571
 572         return 0;
 573 }
 574
 575 /*
 576  * release an endpoint's urbs
 577  */
 578 static void release_urbs(struct snd_usb_endpoint *ep, int force)
 579 {
 580         int i;
 581
 582         /* route incoming urbs to nirvana */
 583         ep->retire_data_urb = NULL;
 584         ep->prepare_data_urb = NULL;
 585
 586         /* stop urbs */
 587         deactivate_urbs(ep, force);
 588         wait_clear_urbs(ep);
 589
 590         for (i = 0; i < ep->nurbs; i++)
 591                 release_urb_ctx(&ep->urb[i]);
 592
 593         if (ep->syncbuf)
 594                 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
 595                                   ep->syncbuf, ep->sync_dma);
 596
 597         ep->syncbuf = NULL;
 598         ep->nurbs = 0;
 599 }
 600
 601 /*
 602  * Check data endpoint for format differences
 603  */
 604 static bool check_ep_params(struct snd_usb_endpoint *ep,
 605                               snd_pcm_format_t pcm_format,
 606                               unsigned int channels,
 607                               unsigned int period_bytes,
 608                               unsigned int frames_per_period,
 609                               unsigned int periods_per_buffer,
 610                               struct audioformat *fmt,
 611                               struct snd_usb_endpoint *sync_ep)
 612 {
 613         unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
 614         unsigned int max_packs_per_period, urbs_per_period, urb_packs;
 615         unsigned int max_urbs;
 616         int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
 617         int tx_length_quirk = (ep->chip->tx_length_quirk &&
 618                                usb_pipeout(ep->pipe));
 619         bool ret = 1;
 620
 621         if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
 622                 /*
 623                  * When operating in DSD DOP mode, the size of a sample frame
 624                  * in hardware differs from the actual physical format width
 625                  * because we need to make room for the DOP markers.
 626                  */
 627                 frame_bits += channels << 3;
 628         }
 629
 630         ret = ret && (ep->datainterval == fmt->datainterval);
 631         ret = ret && (ep->stride == frame_bits >> 3);
 632
 633         switch (pcm_format) {
 634         case SNDRV_PCM_FORMAT_U8:
 635                 ret = ret && (ep->silence_value == 0x80);
 636                 break;
 637         case SNDRV_PCM_FORMAT_DSD_U8:
 638         case SNDRV_PCM_FORMAT_DSD_U16_LE:
 639         case SNDRV_PCM_FORMAT_DSD_U32_LE:
 640         case SNDRV_PCM_FORMAT_DSD_U16_BE:
 641         case SNDRV_PCM_FORMAT_DSD_U32_BE:
 642                 ret = ret && (ep->silence_value == 0x69);
 643                 break;
 644         default:
 645                 ret = ret && (ep->silence_value == 0);
 646         }
 647
 648         /* assume max. frequency is 50% higher than nominal */
 649         ret = ret && (ep->freqmax == ep->freqn + (ep->freqn >> 1));
 650         /* Round up freqmax to nearest integer in order to calculate maximum
 651          * packet size, which must represent a whole number of frames.
 652          * This is accomplished by adding 0x0.ffff before converting the
 653          * Q16.16 format into integer.
 654          * In order to accurately calculate the maximum packet size when
 655          * the data interval is more than 1 (i.e. ep->datainterval > 0),
 656          * multiply by the data interval prior to rounding. For instance,
 657          * a freqmax of 41 kHz will result in a max packet size of 6 (5.125)
 658          * frames with a data interval of 1, but 11 (10.25) frames with a
 659          * data interval of 2.
 660          * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the
 661          * maximum datainterval value of 3, at USB full speed, higher for
 662          * USB high speed, noting that ep->freqmax is in units of
 663          * frames per packet in Q16.16 format.)
 664          */
 665         maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) *
 666                          (frame_bits >> 3);
 667         if (tx_length_quirk)
 668                 maxsize += sizeof(__le32); /* Space for length descriptor */
 669         /* but wMaxPacketSize might reduce this */
 670         if (ep->maxpacksize && ep->maxpacksize < maxsize) {
 671                 /* whatever fits into a max. size packet */
 672                 unsigned int data_maxsize = maxsize = ep->maxpacksize;
 673
 674                 if (tx_length_quirk)
 675                         /* Need to remove the length descriptor to calc freq */
 676                         data_maxsize -= sizeof(__le32);
 677                 ret = ret && (ep->freqmax == (data_maxsize / (frame_bits >> 3))
 678                                 << (16 - ep->datainterval));
 679         }
 680
 681         if (ep->fill_max)
 682                 ret = ret && (ep->curpacksize == ep->maxpacksize);
 683         else
 684                 ret = ret && (ep->curpacksize == maxsize);
 685
 686         if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
 687                 packs_per_ms = 8 >> ep->datainterval;
 688                 max_packs_per_urb = MAX_PACKS_HS;
 689         } else {
 690                 packs_per_ms = 1;
 691                 max_packs_per_urb = MAX_PACKS;
 692         }
 693         if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
 694                 max_packs_per_urb = min(max_packs_per_urb,
 695                                         1U << sync_ep->syncinterval);
 696         max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
 697
 698         /*
 699          * Capture endpoints need to use small URBs because there's no way
 700          * to tell in advance where the next period will end, and we don't
 701          * want the next URB to complete much after the period ends.
 702          *
 703          * Playback endpoints with implicit sync much use the same parameters
 704          * as their corresponding capture endpoint.
 705          */
 706         if (usb_pipein(ep->pipe) ||
 707                         snd_usb_endpoint_implicit_feedback_sink(ep)) {
 708
 709                 urb_packs = packs_per_ms;
 710                 /*
 711                  * Wireless devices can poll at a max rate of once per 4ms.
 712                  * For dataintervals less than 5, increase the packet count to
 713                  * allow the host controller to use bursting to fill in the
 714                  * gaps.
 715                  */
 716                 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
 717                         int interval = ep->datainterval;
 718
 719                         while (interval < 5) {
 720                                 urb_packs <<= 1;
 721                                 ++interval;
 722                         }
 723                 }
 724                 /* make capture URBs <= 1 ms and smaller than a period */
 725                 urb_packs = min(max_packs_per_urb, urb_packs);
 726                 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
 727                         urb_packs >>= 1;
 728                 ret = ret && (ep->nurbs == MAX_URBS);
 729
 730         /*
 731          * Playback endpoints without implicit sync are adjusted so that
 732          * a period fits as evenly as possible in the smallest number of
 733          * URBs.  The total number of URBs is adjusted to the size of the
 734          * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
 735          */
 736         } else {
 737                 /* determine how small a packet can be */
 738                 minsize = (ep->freqn >> (16 - ep->datainterval)) *
 739                                 (frame_bits >> 3);
 740                 /* with sync from device, assume it can be 12% lower */
 741                 if (sync_ep)
 742                         minsize -= minsize >> 3;
 743                 minsize = max(minsize, 1u);
 744
 745                 /* how many packets will contain an entire ALSA period? */
 746                 max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
 747
 748                 /* how many URBs will contain a period? */
 749                 urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
 750                                 max_packs_per_urb);
 751                 /* how many packets are needed in each URB? */
 752                 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
 753
 754                 /* limit the number of frames in a single URB */
 755                 ret = ret && (ep->max_urb_frames ==
 756                         DIV_ROUND_UP(frames_per_period, urbs_per_period));
 757
 758                 /* try to use enough URBs to contain an entire ALSA buffer */
 759                 max_urbs = min((unsigned) MAX_URBS,
 760                                 MAX_QUEUE * packs_per_ms / urb_packs);
 761                 ret = ret && (ep->nurbs == min(max_urbs,
 762                                 urbs_per_period * periods_per_buffer));
 763         }
 764
 765         ret = ret && (ep->datainterval == fmt->datainterval);
 766         ret = ret && (ep->maxpacksize == fmt->maxpacksize);
 767         ret = ret &&
 768                 (ep->fill_max == !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX));
 769
 770         return ret;
 771 }
 772
 773 /*
 774  * configure a data endpoint
 775  */
 776 static int data_ep_set_params(struct snd_usb_endpoint *ep,
 777                               snd_pcm_format_t pcm_format,
 778                               unsigned int channels,
 779                               unsigned int period_bytes,
 780                               unsigned int frames_per_period,
 781                               unsigned int periods_per_buffer,
 782                               struct audioformat *fmt,
 783                               struct snd_usb_endpoint *sync_ep)
 784 {
 785         unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
 786         unsigned int max_packs_per_period, urbs_per_period, urb_packs;
 787         unsigned int max_urbs, i;
 788         int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
 789         int tx_length_quirk = (ep->chip->tx_length_quirk &&
 790                                usb_pipeout(ep->pipe));
 791
 792         if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
 793                 /*
 794                  * When operating in DSD DOP mode, the size of a sample frame
 795                  * in hardware differs from the actual physical format width
 796                  * because we need to make room for the DOP markers.
 797                  */
 798                 frame_bits += channels << 3;
 799         }
 800
 801         ep->datainterval = fmt->datainterval;
 802         ep->stride = frame_bits >> 3;
 803
 804         switch (pcm_format) {
 805         case SNDRV_PCM_FORMAT_U8:
 806                 ep->silence_value = 0x80;
 807                 break;
 808         case SNDRV_PCM_FORMAT_DSD_U8:
 809         case SNDRV_PCM_FORMAT_DSD_U16_LE:
 810         case SNDRV_PCM_FORMAT_DSD_U32_LE:
 811         case SNDRV_PCM_FORMAT_DSD_U16_BE:
 812         case SNDRV_PCM_FORMAT_DSD_U32_BE:
 813                 ep->silence_value = 0x69;
 814                 break;
 815         default:
 816                 ep->silence_value = 0;
 817         }
 818
 819         /* assume max. frequency is 50% higher than nominal */
 820         ep->freqmax = ep->freqn + (ep->freqn >> 1);
 821         /* Round up freqmax to nearest integer in order to calculate maximum
 822          * packet size, which must represent a whole number of frames.
 823          * This is accomplished by adding 0x0.ffff before converting the
 824          * Q16.16 format into integer.
 825          * In order to accurately calculate the maximum packet size when
 826          * the data interval is more than 1 (i.e. ep->datainterval > 0),
 827          * multiply by the data interval prior to rounding. For instance,
 828          * a freqmax of 41 kHz will result in a max packet size of 6 (5.125)
 829          * frames with a data interval of 1, but 11 (10.25) frames with a
 830          * data interval of 2.
 831          * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the
 832          * maximum datainterval value of 3, at USB full speed, higher for
 833          * USB high speed, noting that ep->freqmax is in units of
 834          * frames per packet in Q16.16 format.)
 835          */
 836         maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) *
 837                          (frame_bits >> 3);
 838         if (tx_length_quirk)
 839                 maxsize += sizeof(__le32); /* Space for length descriptor */
 840         /* but wMaxPacketSize might reduce this */
 841         if (ep->maxpacksize && ep->maxpacksize < maxsize) {
 842                 /* whatever fits into a max. size packet */
 843                 unsigned int data_maxsize = maxsize = ep->maxpacksize;
 844
 845                 if (tx_length_quirk)
 846                         /* Need to remove the length descriptor to calc freq */
 847                         data_maxsize -= sizeof(__le32);
 848                 ep->freqmax = (data_maxsize / (frame_bits >> 3))
 849                                 << (16 - ep->datainterval);
 850         }
 851
 852         if (ep->fill_max)
 853                 ep->curpacksize = ep->maxpacksize;
 854         else
 855                 ep->curpacksize = maxsize;
 856
 857         if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
 858                 packs_per_ms = 8 >> ep->datainterval;
 859                 max_packs_per_urb = MAX_PACKS_HS;
 860         } else {
 861                 packs_per_ms = 1;
 862                 max_packs_per_urb = MAX_PACKS;
 863         }
 864         if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
 865                 max_packs_per_urb = min(max_packs_per_urb,
 866                                         1U << sync_ep->syncinterval);
 867         max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
 868
 869         /*
 870          * Capture endpoints need to use small URBs because there's no way
 871          * to tell in advance where the next period will end, and we don't
 872          * want the next URB to complete much after the period ends.
 873          *
 874          * Playback endpoints with implicit sync much use the same parameters
 875          * as their corresponding capture endpoint.
 876          */
 877         if (usb_pipein(ep->pipe) ||
 878                         snd_usb_endpoint_implicit_feedback_sink(ep)) {
 879
 880                 urb_packs = packs_per_ms;
 881                 /*
 882                  * Wireless devices can poll at a max rate of once per 4ms.
 883                  * For dataintervals less than 5, increase the packet count to
 884                  * allow the host controller to use bursting to fill in the
 885                  * gaps.
 886                  */
 887                 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
 888                         int interval = ep->datainterval;
 889                         while (interval < 5) {
 890                                 urb_packs <<= 1;
 891                                 ++interval;
 892                         }
 893                 }
 894                 /* make capture URBs <= 1 ms and smaller than a period */
 895                 urb_packs = min(max_packs_per_urb, urb_packs);
 896                 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
 897                         urb_packs >>= 1;
 898                 ep->nurbs = MAX_URBS;
 899
 900         /*
 901          * Playback endpoints without implicit sync are adjusted so that
 902          * a period fits as evenly as possible in the smallest number of
 903          * URBs.  The total number of URBs is adjusted to the size of the
 904          * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
 905          */
 906         } else {
 907                 /* determine how small a packet can be */
 908                 minsize = (ep->freqn >> (16 - ep->datainterval)) *
 909                                 (frame_bits >> 3);
 910                 /* with sync from device, assume it can be 12% lower */
 911                 if (sync_ep)
 912                         minsize -= minsize >> 3;
 913                 minsize = max(minsize, 1u);
 914
 915                 /* how many packets will contain an entire ALSA period? */
 916                 max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
 917
 918                 /* how many URBs will contain a period? */
 919                 urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
 920                                 max_packs_per_urb);
 921                 /* how many packets are needed in each URB? */
 922                 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
 923
 924                 /* limit the number of frames in a single URB */
 925                 ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
 926                                         urbs_per_period);
 927
 928                 /* try to use enough URBs to contain an entire ALSA buffer */
 929                 max_urbs = min((unsigned) MAX_URBS,
 930                                 MAX_QUEUE * packs_per_ms / urb_packs);
 931                 ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
 932         }
 933
 934         /* allocate and initialize data urbs */
 935         for (i = 0; i < ep->nurbs; i++) {
 936                 struct snd_urb_ctx *u = &ep->urb[i];
 937                 u->index = i;
 938                 u->ep = ep;
 939                 u->packets = urb_packs;
 940                 u->buffer_size = maxsize * u->packets;
 941
 942                 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
 943                         u->packets++; /* for transfer delimiter */
 944                 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
 945                 if (!u->urb)
 946                         goto out_of_memory;
 947
 948                 u->urb->transfer_buffer =
 949                         usb_alloc_coherent(ep->chip->dev, u->buffer_size,
 950                                            GFP_KERNEL, &u->urb->transfer_dma);
 951                 if (!u->urb->transfer_buffer)
 952                         goto out_of_memory;
 953                 u->urb->pipe = ep->pipe;
 954                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 955                 u->urb->interval = 1 << ep->datainterval;
 956                 u->urb->context = u;
 957                 u->urb->complete = snd_complete_urb;
 958                 INIT_LIST_HEAD(&u->ready_list);
 959         }
 960
 961         return 0;
 962
 963 out_of_memory:
 964         release_urbs(ep, 0);
 965         return -ENOMEM;
 966 }
 967
 968 /*
 969  * configure a sync endpoint
 970  */
 971 static int sync_ep_set_params(struct snd_usb_endpoint *ep)
 972 {
 973         int i;
 974
 975         ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
 976                                          GFP_KERNEL, &ep->sync_dma);
 977         if (!ep->syncbuf)
 978                 return -ENOMEM;
 979
 980         for (i = 0; i < SYNC_URBS; i++) {
 981                 struct snd_urb_ctx *u = &ep->urb[i];
 982                 u->index = i;
 983                 u->ep = ep;
 984                 u->packets = 1;
 985                 u->urb = usb_alloc_urb(1, GFP_KERNEL);
 986                 if (!u->urb)
 987                         goto out_of_memory;
 988                 u->urb->transfer_buffer = ep->syncbuf + i * 4;
 989                 u->urb->transfer_dma = ep->sync_dma + i * 4;
 990                 u->urb->transfer_buffer_length = 4;
 991                 u->urb->pipe = ep->pipe;
 992                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 993                 u->urb->number_of_packets = 1;
 994                 u->urb->interval = 1 << ep->syncinterval;
 995                 u->urb->context = u;
 996                 u->urb->complete = snd_complete_urb;
 997         }
 998
 999         ep->nurbs = SYNC_URBS;
1000
1001         return 0;
1002
1003 out_of_memory:
1004         release_urbs(ep, 0);
1005         return -ENOMEM;
1006 }
1007
1008 /**
1009  * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
1010  *
1011  * @ep: the snd_usb_endpoint to configure
1012  * @pcm_format: the audio fomat.
1013  * @channels: the number of audio channels.
1014  * @period_bytes: the number of bytes in one alsa period.
1015  * @period_frames: the number of frames in one alsa period.
1016  * @buffer_periods: the number of periods in one alsa buffer.
1017  * @rate: the frame rate.
1018  * @fmt: the USB audio format information
1019  * @sync_ep: the sync endpoint to use, if any
1020  *
1021  * Determine the number of URBs to be used on this endpoint.
1022  * An endpoint must be configured before it can be started.
1023  * An endpoint that is already running can not be reconfigured.
1024  */
1025 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
1026                                 snd_pcm_format_t pcm_format,
1027                                 unsigned int channels,
1028                                 unsigned int period_bytes,
1029                                 unsigned int period_frames,
1030                                 unsigned int buffer_periods,
1031                                 unsigned int rate,
1032                                 struct audioformat *fmt,
1033                                 struct snd_usb_endpoint *sync_ep)
1034 {
1035         int err;
1036
1037         if (ep->use_count != 0) {
1038                 bool check = ep->is_implicit_feedback &&
1039                         check_ep_params(ep, pcm_format,
1040                                              channels, period_bytes,
1041                                              period_frames, buffer_periods,
1042                                              fmt, sync_ep);
1043
1044                 if (!check) {
1045                         usb_audio_warn(ep->chip,
1046                                 "Unable to change format on ep #%x: already in use\n",
1047                                 ep->ep_num);
1048                         return -EBUSY;
1049                 }
1050
1051                 usb_audio_dbg(ep->chip,
1052                               "Ep #%x already in use as implicit feedback but format not changed\n",
1053                               ep->ep_num);
1054                 return 0;
1055         }
1056
1057         /* release old buffers, if any */
1058         release_urbs(ep, 0);
1059
1060         ep->datainterval = fmt->datainterval;
1061         ep->maxpacksize = fmt->maxpacksize;
1062         ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
1063
1064         if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
1065                 ep->freqn = get_usb_full_speed_rate(rate);
1066         else
1067                 ep->freqn = get_usb_high_speed_rate(rate);
1068
1069         /* calculate the frequency in 16.16 format */
1070         ep->freqm = ep->freqn;
1071         ep->freqshift = INT_MIN;
1072
1073         ep->phase = 0;
1074
1075         switch (ep->type) {
1076         case  SND_USB_ENDPOINT_TYPE_DATA:
1077                 err = data_ep_set_params(ep, pcm_format, channels,
1078                                          period_bytes, period_frames,
1079                                          buffer_periods, fmt, sync_ep);
1080                 break;
1081         case  SND_USB_ENDPOINT_TYPE_SYNC:
1082                 err = sync_ep_set_params(ep);
1083                 break;
1084         default:
1085                 err = -EINVAL;
1086         }
1087
1088         usb_audio_dbg(ep->chip,
1089                 "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
1090                 ep->ep_num, ep->type, ep->nurbs, err);
1091
1092         return err;
1093 }
1094
1095 /**
1096  * snd_usb_endpoint_start: start an snd_usb_endpoint
1097  *
1098  * @ep: the endpoint to start
1099  *
1100  * A call to this function will increment the use count of the endpoint.
1101  * In case it is not already running, the URBs for this endpoint will be
1102  * submitted. Otherwise, this function does nothing.
1103  *
1104  * Must be balanced to calls of snd_usb_endpoint_stop().
1105  *
1106  * Returns an error if the URB submission failed, 0 in all other cases.
1107  */
1108 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep)
1109 {
1110         int err;
1111         unsigned int i;
1112
1113         if (atomic_read(&ep->chip->shutdown))
1114                 return -EBADFD;
1115
1116         /* already running? */
1117         if (++ep->use_count != 1)
1118                 return 0;
1119
1120         /* just to be sure */
1121         deactivate_urbs(ep, false);
1122
1123         ep->active_mask = 0;
1124         ep->unlink_mask = 0;
1125         ep->phase = 0;
1126
1127         snd_usb_endpoint_start_quirk(ep);
1128
1129         /*
1130          * If this endpoint has a data endpoint as implicit feedback source,
1131          * don't start the urbs here. Instead, mark them all as available,
1132          * wait for the record urbs to return and queue the playback urbs
1133          * from that context.
1134          */
1135
1136         set_bit(EP_FLAG_RUNNING, &ep->flags);
1137
1138         if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
1139                 for (i = 0; i < ep->nurbs; i++) {
1140                         struct snd_urb_ctx *ctx = ep->urb + i;
1141                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
1142                 }
1143
1144                 return 0;
1145         }
1146
1147         for (i = 0; i < ep->nurbs; i++) {
1148                 struct urb *urb = ep->urb[i].urb;
1149
1150                 if (snd_BUG_ON(!urb))
1151                         goto __error;
1152
1153                 if (usb_pipeout(ep->pipe)) {
1154                         prepare_outbound_urb(ep, urb->context);
1155                 } else {
1156                         prepare_inbound_urb(ep, urb->context);
1157                 }
1158
1159                 err = usb_submit_urb(urb, GFP_ATOMIC);
1160                 if (err < 0) {
1161                         usb_audio_err(ep->chip,
1162                                 "cannot submit urb %d, error %d: %s\n",
1163                                 i, err, usb_error_string(err));
1164                         goto __error;
1165                 }
1166                 set_bit(i, &ep->active_mask);
1167         }
1168
1169         return 0;
1170
1171 __error:
1172         clear_bit(EP_FLAG_RUNNING, &ep->flags);
1173         ep->use_count--;
1174         deactivate_urbs(ep, false);
1175         return -EPIPE;
1176 }
1177
1178 /**
1179  * snd_usb_endpoint_stop: stop an snd_usb_endpoint
1180  *
1181  * @ep: the endpoint to stop (may be NULL)
1182  *
1183  * A call to this function will decrement the use count of the endpoint.
1184  * In case the last user has requested the endpoint stop, the URBs will
1185  * actually be deactivated.
1186  *
1187  * Must be balanced to calls of snd_usb_endpoint_start().
1188  *
1189  * The caller needs to synchronize the pending stop operation via
1190  * snd_usb_endpoint_sync_pending_stop().
1191  */
1192 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
1193 {
1194         if (!ep)
1195                 return;
1196
1197         if (snd_BUG_ON(ep->use_count == 0))
1198                 return;
1199
1200         if (--ep->use_count == 0) {
1201                 deactivate_urbs(ep, false);
1202                 set_bit(EP_FLAG_STOPPING, &ep->flags);
1203         }
1204 }
1205
1206 /**
1207  * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
1208  *
1209  * @ep: the endpoint to deactivate
1210  *
1211  * If the endpoint is not currently in use, this functions will
1212  * deactivate its associated URBs.
1213  *
1214  * In case of any active users, this functions does nothing.
1215  */
1216 void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
1217 {
1218         if (!ep)
1219                 return;
1220
1221         if (ep->use_count != 0)
1222                 return;
1223
1224         deactivate_urbs(ep, true);
1225         wait_clear_urbs(ep);
1226 }
1227
1228 /**
1229  * snd_usb_endpoint_release: Tear down an snd_usb_endpoint
1230  *
1231  * @ep: the endpoint to release
1232  *
1233  * This function does not care for the endpoint's use count but will tear
1234  * down all the streaming URBs immediately.
1235  */
1236 void snd_usb_endpoint_release(struct snd_usb_endpoint *ep)
1237 {
1238         release_urbs(ep, 1);
1239 }
1240
1241 /**
1242  * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
1243  *
1244  * @ep: the endpoint to free
1245  *
1246  * This free all resources of the given ep.
1247  */
1248 void snd_usb_endpoint_free(struct snd_usb_endpoint *ep)
1249 {
1250         kfree(ep);
1251 }
1252
1253 /**
1254  * snd_usb_handle_sync_urb: parse an USB sync packet
1255  *
1256  * @ep: the endpoint to handle the packet
1257  * @sender: the sending endpoint
1258  * @urb: the received packet
1259  *
1260  * This function is called from the context of an endpoint that received
1261  * the packet and is used to let another endpoint object handle the payload.
1262  */
1263 void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
1264                              struct snd_usb_endpoint *sender,
1265                              const struct urb *urb)
1266 {
1267         int shift;
1268         unsigned int f;
1269         unsigned long flags;
1270
1271         snd_BUG_ON(ep == sender);
1272
1273         /*
1274          * In case the endpoint is operating in implicit feedback mode, prepare
1275          * a new outbound URB that has the same layout as the received packet
1276          * and add it to the list of pending urbs. queue_pending_output_urbs()
1277          * will take care of them later.
1278          */
1279         if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
1280             ep->use_count != 0) {
1281
1282                 /* implicit feedback case */
1283                 int i, bytes = 0;
1284                 struct snd_urb_ctx *in_ctx;
1285                 struct snd_usb_packet_info *out_packet;
1286
1287                 in_ctx = urb->context;
1288
1289                 /* Count overall packet size */
1290                 for (i = 0; i < in_ctx->packets; i++)
1291                         if (urb->iso_frame_desc[i].status == 0)
1292                                 bytes += urb->iso_frame_desc[i].actual_length;
1293
1294                 /*
1295                  * skip empty packets. At least M-Audio's Fast Track Ultra stops
1296                  * streaming once it received a 0-byte OUT URB
1297                  */
1298                 if (bytes == 0)
1299                         return;
1300
1301                 spin_lock_irqsave(&ep->lock, flags);
1302                 out_packet = ep->next_packet + ep->next_packet_write_pos;
1303
1304                 /*
1305                  * Iterate through the inbound packet and prepare the lengths
1306                  * for the output packet. The OUT packet we are about to send
1307                  * will have the same amount of payload bytes per stride as the
1308                  * IN packet we just received. Since the actual size is scaled
1309                  * by the stride, use the sender stride to calculate the length
1310                  * in case the number of channels differ between the implicitly
1311                  * fed-back endpoint and the synchronizing endpoint.
1312                  */
1313
1314                 out_packet->packets = in_ctx->packets;
1315                 for (i = 0; i < in_ctx->packets; i++) {
1316                         if (urb->iso_frame_desc[i].status == 0)
1317                                 out_packet->packet_size[i] =
1318                                         urb->iso_frame_desc[i].actual_length / sender->stride;
1319                         else
1320                                 out_packet->packet_size[i] = 0;
1321                 }
1322
1323                 ep->next_packet_write_pos++;
1324                 ep->next_packet_write_pos %= MAX_URBS;
1325                 spin_unlock_irqrestore(&ep->lock, flags);
1326                 queue_pending_output_urbs(ep);
1327
1328                 return;
1329         }
1330
1331         /*
1332          * process after playback sync complete
1333          *
1334          * Full speed devices report feedback values in 10.14 format as samples
1335          * per frame, high speed devices in 16.16 format as samples per
1336          * microframe.
1337          *
1338          * Because the Audio Class 1 spec was written before USB 2.0, many high
1339          * speed devices use a wrong interpretation, some others use an
1340          * entirely different format.
1341          *
1342          * Therefore, we cannot predict what format any particular device uses
1343          * and must detect it automatically.
1344          */
1345
1346         if (urb->iso_frame_desc[0].status != 0 ||
1347             urb->iso_frame_desc[0].actual_length < 3)
1348                 return;
1349
1350         f = le32_to_cpup(urb->transfer_buffer);
1351         if (urb->iso_frame_desc[0].actual_length == 3)
1352                 f &= 0x00ffffff;
1353         else
1354                 f &= 0x0fffffff;
1355
1356         if (f == 0)
1357                 return;
1358
1359         if (unlikely(sender->tenor_fb_quirk)) {
1360                 /*
1361                  * Devices based on Tenor 8802 chipsets (TEAC UD-H01
1362                  * and others) sometimes change the feedback value
1363                  * by +/- 0x1.0000.
1364                  */
1365                 if (f < ep->freqn - 0x8000)
1366                         f += 0xf000;
1367                 else if (f > ep->freqn + 0x8000)
1368                         f -= 0xf000;
1369         } else if (unlikely(ep->freqshift == INT_MIN)) {
1370                 /*
1371                  * The first time we see a feedback value, determine its format
1372                  * by shifting it left or right until it matches the nominal
1373                  * frequency value.  This assumes that the feedback does not
1374                  * differ from the nominal value more than +50% or -25%.
1375                  */
1376                 shift = 0;
1377                 while (f < ep->freqn - ep->freqn / 4) {
1378                         f <<= 1;
1379                         shift++;
1380                 }
1381                 while (f > ep->freqn + ep->freqn / 2) {
1382                         f >>= 1;
1383                         shift--;
1384                 }
1385                 ep->freqshift = shift;
1386         } else if (ep->freqshift >= 0)
1387                 f <<= ep->freqshift;
1388         else
1389                 f >>= -ep->freqshift;
1390
1391         if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1392                 /*
1393                  * If the frequency looks valid, set it.
1394                  * This value is referred to in prepare_playback_urb().
1395                  */
1396                 spin_lock_irqsave(&ep->lock, flags);
1397                 ep->freqm = f;
1398                 spin_unlock_irqrestore(&ep->lock, flags);
1399         } else {
1400                 /*
1401                  * Out of range; maybe the shift value is wrong.
1402                  * Reset it so that we autodetect again the next time.
1403                  */
1404                 ep->freqshift = INT_MIN;
1405         }
1406 }
1407