sound/usb/endpoint.c

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