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 (usb_pipeout(ep->pipe)) {
 388                 retire_outbound_urb(ep, ctx);
 389                 /* can be stopped during retire callback */
 390                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 391                         goto exit_clear;
 392
 393                 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
 394                         spin_lock_irqsave(&ep->lock, flags);
 395                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 396                         spin_unlock_irqrestore(&ep->lock, flags);
 397                         queue_pending_output_urbs(ep);
 398
 399                         goto exit_clear;
 400                 }
 401
 402                 prepare_outbound_urb(ep, ctx);
 403         } else {
 404                 retire_inbound_urb(ep, ctx);
 405                 /* can be stopped during retire callback */
 406                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 407                         goto exit_clear;
 408
 409                 prepare_inbound_urb(ep, ctx);
 410         }
 411
 412         err = usb_submit_urb(urb, GFP_ATOMIC);
 413         if (err == 0)
 414                 return;
 415
 416         usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
 417         if (ep->data_subs && ep->data_subs->pcm_substream) {
 418                 substream = ep->data_subs->pcm_substream;
 419                 snd_pcm_stop_xrun(substream);
 420         }
 421
 422 exit_clear:
 423         clear_bit(ctx->index, &ep->active_mask);
 424 }
 425
 426 /**
 427  * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
 428  *
 429  * @chip: The chip
 430  * @alts: The USB host interface
 431  * @ep_num: The number of the endpoint to use
 432  * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
 433  * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
 434  *
 435  * If the requested endpoint has not been added to the given chip before,
 436  * a new instance is created. Otherwise, a pointer to the previoulsy
 437  * created instance is returned. In case of any error, NULL is returned.
 438  *
 439  * New endpoints will be added to chip->ep_list and must be freed by
 440  * calling snd_usb_endpoint_free().
 441  *
 442  * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that
 443  * bNumEndpoints > 1 beforehand.
 444  */
 445 struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
 446                                               struct usb_host_interface *alts,
 447                                               int ep_num, int direction, int type)
 448 {
 449         struct snd_usb_endpoint *ep;
 450         int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
 451
 452         if (WARN_ON(!alts))
 453                 return NULL;
 454
 455         mutex_lock(&chip->mutex);
 456
 457         list_for_each_entry(ep, &chip->ep_list, list) {
 458                 if (ep->ep_num == ep_num &&
 459                     ep->iface == alts->desc.bInterfaceNumber &&
 460                     ep->altsetting == alts->desc.bAlternateSetting) {
 461                         usb_audio_dbg(ep->chip,
 462                                       "Re-using EP %x in iface %d,%d @%p\n",
 463                                         ep_num, ep->iface, ep->altsetting, ep);
 464                         goto __exit_unlock;
 465                 }
 466         }
 467
 468         usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
 469                     is_playback ? "playback" : "capture",
 470                     type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
 471                     ep_num);
 472
 473         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
 474         if (!ep)
 475                 goto __exit_unlock;
 476
 477         ep->chip = chip;
 478         spin_lock_init(&ep->lock);
 479         ep->type = type;
 480         ep->ep_num = ep_num;
 481         ep->iface = alts->desc.bInterfaceNumber;
 482         ep->altsetting = alts->desc.bAlternateSetting;
 483         INIT_LIST_HEAD(&ep->ready_playback_urbs);
 484         ep_num &= USB_ENDPOINT_NUMBER_MASK;
 485
 486         if (is_playback)
 487                 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
 488         else
 489                 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
 490
 491         if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
 492                 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 493                     get_endpoint(alts, 1)->bRefresh >= 1 &&
 494                     get_endpoint(alts, 1)->bRefresh <= 9)
 495                         ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
 496                 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
 497                         ep->syncinterval = 1;
 498                 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
 499                          get_endpoint(alts, 1)->bInterval <= 16)
 500                         ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
 501                 else
 502                         ep->syncinterval = 3;
 503
 504                 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
 505         }
 506
 507         list_add_tail(&ep->list, &chip->ep_list);
 508
 509 __exit_unlock:
 510         mutex_unlock(&chip->mutex);
 511
 512         return ep;
 513 }
 514
 515 /*
 516  *  wait until all urbs are processed.
 517  */
 518 static int wait_clear_urbs(struct snd_usb_endpoint *ep)
 519 {
 520         unsigned long end_time = jiffies + msecs_to_jiffies(1000);
 521         int alive;
 522
 523         do {
 524                 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
 525                 if (!alive)
 526                         break;
 527
 528                 schedule_timeout_uninterruptible(1);
 529         } while (time_before(jiffies, end_time));
 530
 531         if (alive)
 532                 usb_audio_err(ep->chip,
 533                         "timeout: still %d active urbs on EP #%x\n",
 534                         alive, ep->ep_num);
 535         clear_bit(EP_FLAG_STOPPING, &ep->flags);
 536
 537         return 0;
 538 }
 539
 540 /* sync the pending stop operation;
 541  * this function itself doesn't trigger the stop operation
 542  */
 543 void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
 544 {
 545         if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
 546                 wait_clear_urbs(ep);
 547 }
 548
 549 /*
 550  * unlink active urbs.
 551  */
 552 static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
 553 {
 554         unsigned int i;
 555
 556         if (!force && atomic_read(&ep->chip->shutdown)) /* to be sure... */
 557                 return -EBADFD;
 558
 559         clear_bit(EP_FLAG_RUNNING, &ep->flags);
 560
 561         INIT_LIST_HEAD(&ep->ready_playback_urbs);
 562         ep->next_packet_read_pos = 0;
 563         ep->next_packet_write_pos = 0;
 564
 565         for (i = 0; i < ep->nurbs; i++) {
 566                 if (test_bit(i, &ep->active_mask)) {
 567                         if (!test_and_set_bit(i, &ep->unlink_mask)) {
 568                                 struct urb *u = ep->urb[i].urb;
 569                                 usb_unlink_urb(u);
 570                         }
 571                 }
 572         }
 573
 574         return 0;
 575 }
 576
 577 /*
 578  * release an endpoint's urbs
 579  */
 580 static void release_urbs(struct snd_usb_endpoint *ep, int force)
 581 {
 582         int i;
 583
 584         /* route incoming urbs to nirvana */
 585         ep->retire_data_urb = NULL;
 586         ep->prepare_data_urb = NULL;
 587
 588         /* stop urbs */
 589         deactivate_urbs(ep, force);
 590         wait_clear_urbs(ep);
 591
 592         for (i = 0; i < ep->nurbs; i++)
 593                 release_urb_ctx(&ep->urb[i]);
 594
 595         if (ep->syncbuf)
 596                 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
 597                                   ep->syncbuf, ep->sync_dma);
 598
 599         ep->syncbuf = NULL;
 600         ep->nurbs = 0;
 601 }
 602
 603 /*
 604  * configure a data endpoint
 605  */
 606 static int data_ep_set_params(struct snd_usb_endpoint *ep,
 607                               snd_pcm_format_t pcm_format,
 608                               unsigned int channels,
 609                               unsigned int period_bytes,
 610                               unsigned int frames_per_period,
 611                               unsigned int periods_per_buffer,
 612                               struct audioformat *fmt,
 613                               struct snd_usb_endpoint *sync_ep)
 614 {
 615         unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
 616         unsigned int max_packs_per_period, urbs_per_period, urb_packs;
 617         unsigned int max_urbs, i;
 618         int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
 619         int tx_length_quirk = (ep->chip->tx_length_quirk &&
 620                                usb_pipeout(ep->pipe));
 621
 622         if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
 623                 /*
 624                  * When operating in DSD DOP mode, the size of a sample frame
 625                  * in hardware differs from the actual physical format width
 626                  * because we need to make room for the DOP markers.
 627                  */
 628                 frame_bits += channels << 3;
 629         }
 630
 631         ep->datainterval = fmt->datainterval;
 632         ep->stride = frame_bits >> 3;
 633
 634         switch (pcm_format) {
 635         case SNDRV_PCM_FORMAT_U8:
 636                 ep->silence_value = 0x80;
 637                 break;
 638         case SNDRV_PCM_FORMAT_DSD_U8:
 639         case SNDRV_PCM_FORMAT_DSD_U16_LE:
 640         case SNDRV_PCM_FORMAT_DSD_U32_LE:
 641         case SNDRV_PCM_FORMAT_DSD_U16_BE:
 642         case SNDRV_PCM_FORMAT_DSD_U32_BE:
 643                 ep->silence_value = 0x69;
 644                 break;
 645         default:
 646                 ep->silence_value = 0;
 647         }
 648
 649         /* assume max. frequency is 50% higher than nominal */
 650         ep->freqmax = ep->freqn + (ep->freqn >> 1);
 651         /* Round up freqmax to nearest integer in order to calculate maximum
 652          * packet size, which must represent a whole number of frames.
 653          * This is accomplished by adding 0x0.ffff before converting the
 654          * Q16.16 format into integer.
 655          * In order to accurately calculate the maximum packet size when
 656          * the data interval is more than 1 (i.e. ep->datainterval > 0),
 657          * multiply by the data interval prior to rounding. For instance,
 658          * a freqmax of 41 kHz will result in a max packet size of 6 (5.125)
 659          * frames with a data interval of 1, but 11 (10.25) frames with a
 660          * data interval of 2.
 661          * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the
 662          * maximum datainterval value of 3, at USB full speed, higher for
 663          * USB high speed, noting that ep->freqmax is in units of
 664          * frames per packet in Q16.16 format.)
 665          */
 666         maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) *
 667                          (frame_bits >> 3);
 668         if (tx_length_quirk)
 669                 maxsize += sizeof(__le32); /* Space for length descriptor */
 670         /* but wMaxPacketSize might reduce this */
 671         if (ep->maxpacksize && ep->maxpacksize < maxsize) {
 672                 /* whatever fits into a max. size packet */
 673                 unsigned int data_maxsize = maxsize = ep->maxpacksize;
 674
 675                 if (tx_length_quirk)
 676                         /* Need to remove the length descriptor to calc freq */
 677                         data_maxsize -= sizeof(__le32);
 678                 ep->freqmax = (data_maxsize / (frame_bits >> 3))
 679                                 << (16 - ep->datainterval);
 680         }
 681
 682         if (ep->fill_max)
 683                 ep->curpacksize = ep->maxpacksize;
 684         else
 685                 ep->curpacksize = maxsize;
 686
 687         if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
 688                 packs_per_ms = 8 >> ep->datainterval;
 689                 max_packs_per_urb = MAX_PACKS_HS;
 690         } else {
 691                 packs_per_ms = 1;
 692                 max_packs_per_urb = MAX_PACKS;
 693         }
 694         if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
 695                 max_packs_per_urb = min(max_packs_per_urb,
 696                                         1U << sync_ep->syncinterval);
 697         max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
 698
 699         /*
 700          * Capture endpoints need to use small URBs because there's no way
 701          * to tell in advance where the next period will end, and we don't
 702          * want the next URB to complete much after the period ends.
 703          *
 704          * Playback endpoints with implicit sync much use the same parameters
 705          * as their corresponding capture endpoint.
 706          */
 707         if (usb_pipein(ep->pipe) ||
 708                         snd_usb_endpoint_implicit_feedback_sink(ep)) {
 709
 710                 urb_packs = packs_per_ms;
 711                 /*
 712                  * Wireless devices can poll at a max rate of once per 4ms.
 713                  * For dataintervals less than 5, increase the packet count to
 714                  * allow the host controller to use bursting to fill in the
 715                  * gaps.
 716                  */
 717                 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
 718                         int interval = ep->datainterval;
 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                 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                 ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
 756                                         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                 ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
 762         }
 763
 764         /* allocate and initialize data urbs */
 765         for (i = 0; i < ep->nurbs; i++) {
 766                 struct snd_urb_ctx *u = &ep->urb[i];
 767                 u->index = i;
 768                 u->ep = ep;
 769                 u->packets = urb_packs;
 770                 u->buffer_size = maxsize * u->packets;
 771
 772                 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
 773                         u->packets++; /* for transfer delimiter */
 774                 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
 775                 if (!u->urb)
 776                         goto out_of_memory;
 777
 778                 u->urb->transfer_buffer =
 779                         usb_alloc_coherent(ep->chip->dev, u->buffer_size,
 780                                            GFP_KERNEL, &u->urb->transfer_dma);
 781                 if (!u->urb->transfer_buffer)
 782                         goto out_of_memory;
 783                 u->urb->pipe = ep->pipe;
 784                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 785                 u->urb->interval = 1 << ep->datainterval;
 786                 u->urb->context = u;
 787                 u->urb->complete = snd_complete_urb;
 788                 INIT_LIST_HEAD(&u->ready_list);
 789         }
 790
 791         return 0;
 792
 793 out_of_memory:
 794         release_urbs(ep, 0);
 795         return -ENOMEM;
 796 }
 797
 798 /*
 799  * configure a sync endpoint
 800  */
 801 static int sync_ep_set_params(struct snd_usb_endpoint *ep)
 802 {
 803         int i;
 804
 805         ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
 806                                          GFP_KERNEL, &ep->sync_dma);
 807         if (!ep->syncbuf)
 808                 return -ENOMEM;
 809
 810         for (i = 0; i < SYNC_URBS; i++) {
 811                 struct snd_urb_ctx *u = &ep->urb[i];
 812                 u->index = i;
 813                 u->ep = ep;
 814                 u->packets = 1;
 815                 u->urb = usb_alloc_urb(1, GFP_KERNEL);
 816                 if (!u->urb)
 817                         goto out_of_memory;
 818                 u->urb->transfer_buffer = ep->syncbuf + i * 4;
 819                 u->urb->transfer_dma = ep->sync_dma + i * 4;
 820                 u->urb->transfer_buffer_length = 4;
 821                 u->urb->pipe = ep->pipe;
 822                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 823                 u->urb->number_of_packets = 1;
 824                 u->urb->interval = 1 << ep->syncinterval;
 825                 u->urb->context = u;
 826                 u->urb->complete = snd_complete_urb;
 827         }
 828
 829         ep->nurbs = SYNC_URBS;
 830
 831         return 0;
 832
 833 out_of_memory:
 834         release_urbs(ep, 0);
 835         return -ENOMEM;
 836 }
 837
 838 /**
 839  * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
 840  *
 841  * @ep: the snd_usb_endpoint to configure
 842  * @pcm_format: the audio fomat.
 843  * @channels: the number of audio channels.
 844  * @period_bytes: the number of bytes in one alsa period.
 845  * @period_frames: the number of frames in one alsa period.
 846  * @buffer_periods: the number of periods in one alsa buffer.
 847  * @rate: the frame rate.
 848  * @fmt: the USB audio format information
 849  * @sync_ep: the sync endpoint to use, if any
 850  *
 851  * Determine the number of URBs to be used on this endpoint.
 852  * An endpoint must be configured before it can be started.
 853  * An endpoint that is already running can not be reconfigured.
 854  */
 855 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
 856                                 snd_pcm_format_t pcm_format,
 857                                 unsigned int channels,
 858                                 unsigned int period_bytes,
 859                                 unsigned int period_frames,
 860                                 unsigned int buffer_periods,
 861                                 unsigned int rate,
 862                                 struct audioformat *fmt,
 863                                 struct snd_usb_endpoint *sync_ep)
 864 {
 865         int err;
 866
 867         if (ep->use_count != 0) {
 868                 usb_audio_warn(ep->chip,
 869                          "Unable to change format on ep #%x: already in use\n",
 870                          ep->ep_num);
 871                 return -EBUSY;
 872         }
 873
 874         /* release old buffers, if any */
 875         release_urbs(ep, 0);
 876
 877         ep->datainterval = fmt->datainterval;
 878         ep->maxpacksize = fmt->maxpacksize;
 879         ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
 880
 881         if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
 882                 ep->freqn = get_usb_full_speed_rate(rate);
 883         else
 884                 ep->freqn = get_usb_high_speed_rate(rate);
 885
 886         /* calculate the frequency in 16.16 format */
 887         ep->freqm = ep->freqn;
 888         ep->freqshift = INT_MIN;
 889
 890         ep->phase = 0;
 891
 892         switch (ep->type) {
 893         case  SND_USB_ENDPOINT_TYPE_DATA:
 894                 err = data_ep_set_params(ep, pcm_format, channels,
 895                                          period_bytes, period_frames,
 896                                          buffer_periods, fmt, sync_ep);
 897                 break;
 898         case  SND_USB_ENDPOINT_TYPE_SYNC:
 899                 err = sync_ep_set_params(ep);
 900                 break;
 901         default:
 902                 err = -EINVAL;
 903         }
 904
 905         usb_audio_dbg(ep->chip,
 906                 "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
 907                 ep->ep_num, ep->type, ep->nurbs, err);
 908
 909         return err;
 910 }
 911
 912 /**
 913  * snd_usb_endpoint_start: start an snd_usb_endpoint
 914  *
 915  * @ep:         the endpoint to start
 916  * @can_sleep:  flag indicating whether the operation is executed in
 917  *              non-atomic context
 918  *
 919  * A call to this function will increment the use count of the endpoint.
 920  * In case it is not already running, the URBs for this endpoint will be
 921  * submitted. Otherwise, this function does nothing.
 922  *
 923  * Must be balanced to calls of snd_usb_endpoint_stop().
 924  *
 925  * Returns an error if the URB submission failed, 0 in all other cases.
 926  */
 927 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, bool can_sleep)
 928 {
 929         int err;
 930         unsigned int i;
 931
 932         if (atomic_read(&ep->chip->shutdown))
 933                 return -EBADFD;
 934
 935         /* already running? */
 936         if (++ep->use_count != 1)
 937                 return 0;
 938
 939         /* just to be sure */
 940         deactivate_urbs(ep, false);
 941         if (can_sleep)
 942                 wait_clear_urbs(ep);
 943
 944         ep->active_mask = 0;
 945         ep->unlink_mask = 0;
 946         ep->phase = 0;
 947
 948         snd_usb_endpoint_start_quirk(ep);
 949
 950         /*
 951          * If this endpoint has a data endpoint as implicit feedback source,
 952          * don't start the urbs here. Instead, mark them all as available,
 953          * wait for the record urbs to return and queue the playback urbs
 954          * from that context.
 955          */
 956
 957         set_bit(EP_FLAG_RUNNING, &ep->flags);
 958
 959         if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
 960                 for (i = 0; i < ep->nurbs; i++) {
 961                         struct snd_urb_ctx *ctx = ep->urb + i;
 962                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 963                 }
 964
 965                 return 0;
 966         }
 967
 968         for (i = 0; i < ep->nurbs; i++) {
 969                 struct urb *urb = ep->urb[i].urb;
 970
 971                 if (snd_BUG_ON(!urb))
 972                         goto __error;
 973
 974                 if (usb_pipeout(ep->pipe)) {
 975                         prepare_outbound_urb(ep, urb->context);
 976                 } else {
 977                         prepare_inbound_urb(ep, urb->context);
 978                 }
 979
 980                 err = usb_submit_urb(urb, GFP_ATOMIC);
 981                 if (err < 0) {
 982                         usb_audio_err(ep->chip,
 983                                 "cannot submit urb %d, error %d: %s\n",
 984                                 i, err, usb_error_string(err));
 985                         goto __error;
 986                 }
 987                 set_bit(i, &ep->active_mask);
 988         }
 989
 990         return 0;
 991
 992 __error:
 993         clear_bit(EP_FLAG_RUNNING, &ep->flags);
 994         ep->use_count--;
 995         deactivate_urbs(ep, false);
 996         return -EPIPE;
 997 }
 998
 999 /**
1000  * snd_usb_endpoint_stop: stop an snd_usb_endpoint
1001  *
1002  * @ep: the endpoint to stop (may be NULL)
1003  *
1004  * A call to this function will decrement the use count of the endpoint.
1005  * In case the last user has requested the endpoint stop, the URBs will
1006  * actually be deactivated.
1007  *
1008  * Must be balanced to calls of snd_usb_endpoint_start().
1009  *
1010  * The caller needs to synchronize the pending stop operation via
1011  * snd_usb_endpoint_sync_pending_stop().
1012  */
1013 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
1014 {
1015         if (!ep)
1016                 return;
1017
1018         if (snd_BUG_ON(ep->use_count == 0))
1019                 return;
1020
1021         if (--ep->use_count == 0) {
1022                 deactivate_urbs(ep, false);
1023                 ep->data_subs = NULL;
1024                 ep->sync_slave = NULL;
1025                 ep->retire_data_urb = NULL;
1026                 ep->prepare_data_urb = NULL;
1027                 set_bit(EP_FLAG_STOPPING, &ep->flags);
1028         }
1029 }
1030
1031 /**
1032  * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
1033  *
1034  * @ep: the endpoint to deactivate
1035  *
1036  * If the endpoint is not currently in use, this functions will
1037  * deactivate its associated URBs.
1038  *
1039  * In case of any active users, this functions does nothing.
1040  */
1041 void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
1042 {
1043         if (!ep)
1044                 return;
1045
1046         if (ep->use_count != 0)
1047                 return;
1048
1049         deactivate_urbs(ep, true);
1050         wait_clear_urbs(ep);
1051 }
1052
1053 /**
1054  * snd_usb_endpoint_release: Tear down an snd_usb_endpoint
1055  *
1056  * @ep: the endpoint to release
1057  *
1058  * This function does not care for the endpoint's use count but will tear
1059  * down all the streaming URBs immediately.
1060  */
1061 void snd_usb_endpoint_release(struct snd_usb_endpoint *ep)
1062 {
1063         release_urbs(ep, 1);
1064 }
1065
1066 /**
1067  * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
1068  *
1069  * @ep: the endpoint to free
1070  *
1071  * This free all resources of the given ep.
1072  */
1073 void snd_usb_endpoint_free(struct snd_usb_endpoint *ep)
1074 {
1075         kfree(ep);
1076 }
1077
1078 /**
1079  * snd_usb_handle_sync_urb: parse an USB sync packet
1080  *
1081  * @ep: the endpoint to handle the packet
1082  * @sender: the sending endpoint
1083  * @urb: the received packet
1084  *
1085  * This function is called from the context of an endpoint that received
1086  * the packet and is used to let another endpoint object handle the payload.
1087  */
1088 void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
1089                              struct snd_usb_endpoint *sender,
1090                              const struct urb *urb)
1091 {
1092         int shift;
1093         unsigned int f;
1094         unsigned long flags;
1095
1096         snd_BUG_ON(ep == sender);
1097
1098         /*
1099          * In case the endpoint is operating in implicit feedback mode, prepare
1100          * a new outbound URB that has the same layout as the received packet
1101          * and add it to the list of pending urbs. queue_pending_output_urbs()
1102          * will take care of them later.
1103          */
1104         if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
1105             ep->use_count != 0) {
1106
1107                 /* implicit feedback case */
1108                 int i, bytes = 0;
1109                 struct snd_urb_ctx *in_ctx;
1110                 struct snd_usb_packet_info *out_packet;
1111
1112                 in_ctx = urb->context;
1113
1114                 /* Count overall packet size */
1115                 for (i = 0; i < in_ctx->packets; i++)
1116                         if (urb->iso_frame_desc[i].status == 0)
1117                                 bytes += urb->iso_frame_desc[i].actual_length;
1118
1119                 /*
1120                  * skip empty packets. At least M-Audio's Fast Track Ultra stops
1121                  * streaming once it received a 0-byte OUT URB
1122                  */
1123                 if (bytes == 0)
1124                         return;
1125
1126                 spin_lock_irqsave(&ep->lock, flags);
1127                 out_packet = ep->next_packet + ep->next_packet_write_pos;
1128
1129                 /*
1130                  * Iterate through the inbound packet and prepare the lengths
1131                  * for the output packet. The OUT packet we are about to send
1132                  * will have the same amount of payload bytes per stride as the
1133                  * IN packet we just received. Since the actual size is scaled
1134                  * by the stride, use the sender stride to calculate the length
1135                  * in case the number of channels differ between the implicitly
1136                  * fed-back endpoint and the synchronizing endpoint.
1137                  */
1138
1139                 out_packet->packets = in_ctx->packets;
1140                 for (i = 0; i < in_ctx->packets; i++) {
1141                         if (urb->iso_frame_desc[i].status == 0)
1142                                 out_packet->packet_size[i] =
1143                                         urb->iso_frame_desc[i].actual_length / sender->stride;
1144                         else
1145                                 out_packet->packet_size[i] = 0;
1146                 }
1147
1148                 ep->next_packet_write_pos++;
1149                 ep->next_packet_write_pos %= MAX_URBS;
1150                 spin_unlock_irqrestore(&ep->lock, flags);
1151                 queue_pending_output_urbs(ep);
1152
1153                 return;
1154         }
1155
1156         /*
1157          * process after playback sync complete
1158          *
1159          * Full speed devices report feedback values in 10.14 format as samples
1160          * per frame, high speed devices in 16.16 format as samples per
1161          * microframe.
1162          *
1163          * Because the Audio Class 1 spec was written before USB 2.0, many high
1164          * speed devices use a wrong interpretation, some others use an
1165          * entirely different format.
1166          *
1167          * Therefore, we cannot predict what format any particular device uses
1168          * and must detect it automatically.
1169          */
1170
1171         if (urb->iso_frame_desc[0].status != 0 ||
1172             urb->iso_frame_desc[0].actual_length < 3)
1173                 return;
1174
1175         f = le32_to_cpup(urb->transfer_buffer);
1176         if (urb->iso_frame_desc[0].actual_length == 3)
1177                 f &= 0x00ffffff;
1178         else
1179                 f &= 0x0fffffff;
1180
1181         if (f == 0)
1182                 return;
1183
1184         if (unlikely(sender->tenor_fb_quirk)) {
1185                 /*
1186                  * Devices based on Tenor 8802 chipsets (TEAC UD-H01
1187                  * and others) sometimes change the feedback value
1188                  * by +/- 0x1.0000.
1189                  */
1190                 if (f < ep->freqn - 0x8000)
1191                         f += 0xf000;
1192                 else if (f > ep->freqn + 0x8000)
1193                         f -= 0xf000;
1194         } else if (unlikely(ep->freqshift == INT_MIN)) {
1195                 /*
1196                  * The first time we see a feedback value, determine its format
1197                  * by shifting it left or right until it matches the nominal
1198                  * frequency value.  This assumes that the feedback does not
1199                  * differ from the nominal value more than +50% or -25%.
1200                  */
1201                 shift = 0;
1202                 while (f < ep->freqn - ep->freqn / 4) {
1203                         f <<= 1;
1204                         shift++;
1205                 }
1206                 while (f > ep->freqn + ep->freqn / 2) {
1207                         f >>= 1;
1208                         shift--;
1209                 }
1210                 ep->freqshift = shift;
1211         } else if (ep->freqshift >= 0)
1212                 f <<= ep->freqshift;
1213         else
1214                 f >>= -ep->freqshift;
1215
1216         if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1217                 /*
1218                  * If the frequency looks valid, set it.
1219                  * This value is referred to in prepare_playback_urb().
1220                  */
1221                 spin_lock_irqsave(&ep->lock, flags);
1222                 ep->freqm = f;
1223                 spin_unlock_irqrestore(&ep->lock, flags);
1224         } else {
1225                 /*
1226                  * Out of range; maybe the shift value is wrong.
1227                  * Reset it so that we autodetect again the next time.
1228                  */
1229                 ep->freqshift = INT_MIN;
1230         }
1231 }
1232