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 /*
 187  * Prepare a PLAYBACK urb for submission to the bus.
 188  */
 189 static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
 190                                  struct snd_urb_ctx *ctx)
 191 {
 192         int i;
 193         struct urb *urb = ctx->urb;
 194         unsigned char *cp = urb->transfer_buffer;
 195
 196         urb->dev = ep->chip->dev; /* we need to set this at each time */
 197
 198         switch (ep->type) {
 199         case SND_USB_ENDPOINT_TYPE_DATA:
 200                 if (ep->prepare_data_urb) {
 201                         ep->prepare_data_urb(ep->data_subs, urb);
 202                 } else {
 203                         /* no data provider, so send silence */
 204                         unsigned int offs = 0;
 205                         for (i = 0; i < ctx->packets; ++i) {
 206                                 int counts;
 207
 208                                 if (ctx->packet_size[i])
 209                                         counts = ctx->packet_size[i];
 210                                 else
 211                                         counts = snd_usb_endpoint_next_packet_size(ep);
 212
 213                                 urb->iso_frame_desc[i].offset = offs * ep->stride;
 214                                 urb->iso_frame_desc[i].length = counts * ep->stride;
 215                                 offs += counts;
 216                         }
 217
 218                         urb->number_of_packets = ctx->packets;
 219                         urb->transfer_buffer_length = offs * ep->stride;
 220                         memset(urb->transfer_buffer, ep->silence_value,
 221                                offs * ep->stride);
 222                 }
 223                 break;
 224
 225         case SND_USB_ENDPOINT_TYPE_SYNC:
 226                 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
 227                         /*
 228                          * fill the length and offset of each urb descriptor.
 229                          * the fixed 12.13 frequency is passed as 16.16 through the pipe.
 230                          */
 231                         urb->iso_frame_desc[0].length = 4;
 232                         urb->iso_frame_desc[0].offset = 0;
 233                         cp[0] = ep->freqn;
 234                         cp[1] = ep->freqn >> 8;
 235                         cp[2] = ep->freqn >> 16;
 236                         cp[3] = ep->freqn >> 24;
 237                 } else {
 238                         /*
 239                          * fill the length and offset of each urb descriptor.
 240                          * the fixed 10.14 frequency is passed through the pipe.
 241                          */
 242                         urb->iso_frame_desc[0].length = 3;
 243                         urb->iso_frame_desc[0].offset = 0;
 244                         cp[0] = ep->freqn >> 2;
 245                         cp[1] = ep->freqn >> 10;
 246                         cp[2] = ep->freqn >> 18;
 247                 }
 248
 249                 break;
 250         }
 251 }
 252
 253 /*
 254  * Prepare a CAPTURE or SYNC urb for submission to the bus.
 255  */
 256 static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
 257                                        struct snd_urb_ctx *urb_ctx)
 258 {
 259         int i, offs;
 260         struct urb *urb = urb_ctx->urb;
 261
 262         urb->dev = ep->chip->dev; /* we need to set this at each time */
 263
 264         switch (ep->type) {
 265         case SND_USB_ENDPOINT_TYPE_DATA:
 266                 offs = 0;
 267                 for (i = 0; i < urb_ctx->packets; i++) {
 268                         urb->iso_frame_desc[i].offset = offs;
 269                         urb->iso_frame_desc[i].length = ep->curpacksize;
 270                         offs += ep->curpacksize;
 271                 }
 272
 273                 urb->transfer_buffer_length = offs;
 274                 urb->number_of_packets = urb_ctx->packets;
 275                 break;
 276
 277         case SND_USB_ENDPOINT_TYPE_SYNC:
 278                 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
 279                 urb->iso_frame_desc[0].offset = 0;
 280                 break;
 281         }
 282 }
 283
 284 /*
 285  * Send output urbs that have been prepared previously. URBs are dequeued
 286  * from ep->ready_playback_urbs and in case there there aren't any available
 287  * or there are no packets that have been prepared, this function does
 288  * nothing.
 289  *
 290  * The reason why the functionality of sending and preparing URBs is separated
 291  * is that host controllers don't guarantee the order in which they return
 292  * inbound and outbound packets to their submitters.
 293  *
 294  * This function is only used for implicit feedback endpoints. For endpoints
 295  * driven by dedicated sync endpoints, URBs are immediately re-submitted
 296  * from their completion handler.
 297  */
 298 static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
 299 {
 300         while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
 301
 302                 unsigned long flags;
 303                 struct snd_usb_packet_info *uninitialized_var(packet);
 304                 struct snd_urb_ctx *ctx = NULL;
 305                 struct urb *urb;
 306                 int err, i;
 307
 308                 spin_lock_irqsave(&ep->lock, flags);
 309                 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
 310                         packet = ep->next_packet + ep->next_packet_read_pos;
 311                         ep->next_packet_read_pos++;
 312                         ep->next_packet_read_pos %= MAX_URBS;
 313
 314                         /* take URB out of FIFO */
 315                         if (!list_empty(&ep->ready_playback_urbs))
 316                                 ctx = list_first_entry(&ep->ready_playback_urbs,
 317                                                struct snd_urb_ctx, ready_list);
 318                 }
 319                 spin_unlock_irqrestore(&ep->lock, flags);
 320
 321                 if (ctx == NULL)
 322                         return;
 323
 324                 list_del_init(&ctx->ready_list);
 325                 urb = ctx->urb;
 326
 327                 /* copy over the length information */
 328                 for (i = 0; i < packet->packets; i++)
 329                         ctx->packet_size[i] = packet->packet_size[i];
 330
 331                 /* call the data handler to fill in playback data */
 332                 prepare_outbound_urb(ep, ctx);
 333
 334                 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
 335                 if (err < 0)
 336                         snd_printk(KERN_ERR "Unable to submit urb #%d: %d (urb %p)\n",
 337                                    ctx->index, err, ctx->urb);
 338                 else
 339                         set_bit(ctx->index, &ep->active_mask);
 340         }
 341 }
 342
 343 /*
 344  * complete callback for urbs
 345  */
 346 static void snd_complete_urb(struct urb *urb)
 347 {
 348         struct snd_urb_ctx *ctx = urb->context;
 349         struct snd_usb_endpoint *ep = ctx->ep;
 350         int err;
 351
 352         if (unlikely(urb->status == -ENOENT ||          /* unlinked */
 353                      urb->status == -ENODEV ||          /* device removed */
 354                      urb->status == -ECONNRESET ||      /* unlinked */
 355                      urb->status == -ESHUTDOWN ||       /* device disabled */
 356                      ep->chip->shutdown))               /* device disconnected */
 357                 goto exit_clear;
 358
 359         if (usb_pipeout(ep->pipe)) {
 360                 retire_outbound_urb(ep, ctx);
 361                 /* can be stopped during retire callback */
 362                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 363                         goto exit_clear;
 364
 365                 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
 366                         unsigned long flags;
 367
 368                         spin_lock_irqsave(&ep->lock, flags);
 369                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 370                         spin_unlock_irqrestore(&ep->lock, flags);
 371                         queue_pending_output_urbs(ep);
 372
 373                         goto exit_clear;
 374                 }
 375
 376                 prepare_outbound_urb(ep, ctx);
 377         } else {
 378                 retire_inbound_urb(ep, ctx);
 379                 /* can be stopped during retire callback */
 380                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 381                         goto exit_clear;
 382
 383                 prepare_inbound_urb(ep, ctx);
 384         }
 385
 386         err = usb_submit_urb(urb, GFP_ATOMIC);
 387         if (err == 0)
 388                 return;
 389
 390         snd_printk(KERN_ERR "cannot submit urb (err = %d)\n", err);
 391         //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
 392
 393 exit_clear:
 394         clear_bit(ctx->index, &ep->active_mask);
 395 }
 396
 397 /**
 398  * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
 399  *
 400  * @chip: The chip
 401  * @alts: The USB host interface
 402  * @ep_num: The number of the endpoint to use
 403  * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
 404  * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
 405  *
 406  * If the requested endpoint has not been added to the given chip before,
 407  * a new instance is created. Otherwise, a pointer to the previoulsy
 408  * created instance is returned. In case of any error, NULL is returned.
 409  *
 410  * New endpoints will be added to chip->ep_list and must be freed by
 411  * calling snd_usb_endpoint_free().
 412  */
 413 struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
 414                                               struct usb_host_interface *alts,
 415                                               int ep_num, int direction, int type)
 416 {
 417         struct snd_usb_endpoint *ep;
 418         int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
 419
 420         if (WARN_ON(!alts))
 421                 return NULL;
 422
 423         mutex_lock(&chip->mutex);
 424
 425         list_for_each_entry(ep, &chip->ep_list, list) {
 426                 if (ep->ep_num == ep_num &&
 427                     ep->iface == alts->desc.bInterfaceNumber &&
 428                     ep->altsetting == alts->desc.bAlternateSetting) {
 429                         snd_printdd(KERN_DEBUG "Re-using EP %x in iface %d,%d @%p\n",
 430                                         ep_num, ep->iface, ep->altsetting, ep);
 431                         goto __exit_unlock;
 432                 }
 433         }
 434
 435         snd_printdd(KERN_DEBUG "Creating new %s %s endpoint #%x\n",
 436                     is_playback ? "playback" : "capture",
 437                     type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
 438                     ep_num);
 439
 440         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
 441         if (!ep)
 442                 goto __exit_unlock;
 443
 444         ep->chip = chip;
 445         spin_lock_init(&ep->lock);
 446         ep->type = type;
 447         ep->ep_num = ep_num;
 448         ep->iface = alts->desc.bInterfaceNumber;
 449         ep->altsetting = alts->desc.bAlternateSetting;
 450         INIT_LIST_HEAD(&ep->ready_playback_urbs);
 451         ep_num &= USB_ENDPOINT_NUMBER_MASK;
 452
 453         if (is_playback)
 454                 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
 455         else
 456                 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
 457
 458         if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
 459                 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
 460                     get_endpoint(alts, 1)->bRefresh >= 1 &&
 461                     get_endpoint(alts, 1)->bRefresh <= 9)
 462                         ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
 463                 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
 464                         ep->syncinterval = 1;
 465                 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
 466                          get_endpoint(alts, 1)->bInterval <= 16)
 467                         ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
 468                 else
 469                         ep->syncinterval = 3;
 470
 471                 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
 472         }
 473
 474         list_add_tail(&ep->list, &chip->ep_list);
 475
 476 __exit_unlock:
 477         mutex_unlock(&chip->mutex);
 478
 479         return ep;
 480 }
 481
 482 /*
 483  *  wait until all urbs are processed.
 484  */
 485 static int wait_clear_urbs(struct snd_usb_endpoint *ep)
 486 {
 487         unsigned long end_time = jiffies + msecs_to_jiffies(1000);
 488         int alive;
 489
 490         do {
 491                 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
 492                 if (!alive)
 493                         break;
 494
 495                 schedule_timeout_uninterruptible(1);
 496         } while (time_before(jiffies, end_time));
 497
 498         if (alive)
 499                 snd_printk(KERN_ERR "timeout: still %d active urbs on EP #%x\n",
 500                                         alive, ep->ep_num);
 501         clear_bit(EP_FLAG_STOPPING, &ep->flags);
 502
 503         return 0;
 504 }
 505
 506 /* sync the pending stop operation;
 507  * this function itself doesn't trigger the stop operation
 508  */
 509 void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
 510 {
 511         if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
 512                 wait_clear_urbs(ep);
 513 }
 514
 515 /*
 516  * unlink active urbs.
 517  */
 518 static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
 519 {
 520         unsigned int i;
 521
 522         if (!force && ep->chip->shutdown) /* to be sure... */
 523                 return -EBADFD;
 524
 525         clear_bit(EP_FLAG_RUNNING, &ep->flags);
 526
 527         INIT_LIST_HEAD(&ep->ready_playback_urbs);
 528         ep->next_packet_read_pos = 0;
 529         ep->next_packet_write_pos = 0;
 530
 531         for (i = 0; i < ep->nurbs; i++) {
 532                 if (test_bit(i, &ep->active_mask)) {
 533                         if (!test_and_set_bit(i, &ep->unlink_mask)) {
 534                                 struct urb *u = ep->urb[i].urb;
 535                                 usb_unlink_urb(u);
 536                         }
 537                 }
 538         }
 539
 540         return 0;
 541 }
 542
 543 /*
 544  * release an endpoint's urbs
 545  */
 546 static void release_urbs(struct snd_usb_endpoint *ep, int force)
 547 {
 548         int i;
 549
 550         /* route incoming urbs to nirvana */
 551         ep->retire_data_urb = NULL;
 552         ep->prepare_data_urb = NULL;
 553
 554         /* stop urbs */
 555         deactivate_urbs(ep, force);
 556         wait_clear_urbs(ep);
 557
 558         for (i = 0; i < ep->nurbs; i++)
 559                 release_urb_ctx(&ep->urb[i]);
 560
 561         if (ep->syncbuf)
 562                 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
 563                                   ep->syncbuf, ep->sync_dma);
 564
 565         ep->syncbuf = NULL;
 566         ep->nurbs = 0;
 567 }
 568
 569 /*
 570  * configure a data endpoint
 571  */
 572 static int data_ep_set_params(struct snd_usb_endpoint *ep,
 573                               snd_pcm_format_t pcm_format,
 574                               unsigned int channels,
 575                               unsigned int period_bytes,
 576                               unsigned int frames_per_period,
 577                               unsigned int periods_per_buffer,
 578                               struct audioformat *fmt,
 579                               struct snd_usb_endpoint *sync_ep)
 580 {
 581         unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
 582         unsigned int max_packs_per_period, urbs_per_period, urb_packs;
 583         unsigned int max_urbs, i;
 584         int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
 585
 586         if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
 587                 /*
 588                  * When operating in DSD DOP mode, the size of a sample frame
 589                  * in hardware differs from the actual physical format width
 590                  * because we need to make room for the DOP markers.
 591                  */
 592                 frame_bits += channels << 3;
 593         }
 594
 595         ep->datainterval = fmt->datainterval;
 596         ep->stride = frame_bits >> 3;
 597         ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
 598
 599         /* assume max. frequency is 25% higher than nominal */
 600         ep->freqmax = ep->freqn + (ep->freqn >> 2);
 601         maxsize = ((ep->freqmax + 0xffff) * (frame_bits >> 3))
 602                                 >> (16 - ep->datainterval);
 603         /* but wMaxPacketSize might reduce this */
 604         if (ep->maxpacksize && ep->maxpacksize < maxsize) {
 605                 /* whatever fits into a max. size packet */
 606                 maxsize = ep->maxpacksize;
 607                 ep->freqmax = (maxsize / (frame_bits >> 3))
 608                                 << (16 - ep->datainterval);
 609         }
 610
 611         if (ep->fill_max)
 612                 ep->curpacksize = ep->maxpacksize;
 613         else
 614                 ep->curpacksize = maxsize;
 615
 616         if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
 617                 packs_per_ms = 8 >> ep->datainterval;
 618                 max_packs_per_urb = MAX_PACKS_HS;
 619         } else {
 620                 packs_per_ms = 1;
 621                 max_packs_per_urb = MAX_PACKS;
 622         }
 623         if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
 624                 max_packs_per_urb = min(max_packs_per_urb,
 625                                         1U << sync_ep->syncinterval);
 626         max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
 627
 628         /*
 629          * Capture endpoints need to use small URBs because there's no way
 630          * to tell in advance where the next period will end, and we don't
 631          * want the next URB to complete much after the period ends.
 632          *
 633          * Playback endpoints with implicit sync much use the same parameters
 634          * as their corresponding capture endpoint.
 635          */
 636         if (usb_pipein(ep->pipe) ||
 637                         snd_usb_endpoint_implicit_feedback_sink(ep)) {
 638
 639                 /* make capture URBs <= 1 ms and smaller than a period */
 640                 urb_packs = min(max_packs_per_urb, packs_per_ms);
 641                 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
 642                         urb_packs >>= 1;
 643                 ep->nurbs = MAX_URBS;
 644
 645         /*
 646          * Playback endpoints without implicit sync are adjusted so that
 647          * a period fits as evenly as possible in the smallest number of
 648          * URBs.  The total number of URBs is adjusted to the size of the
 649          * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
 650          */
 651         } else {
 652                 /* determine how small a packet can be */
 653                 minsize = (ep->freqn >> (16 - ep->datainterval)) *
 654                                 (frame_bits >> 3);
 655                 /* with sync from device, assume it can be 12% lower */
 656                 if (sync_ep)
 657                         minsize -= minsize >> 3;
 658                 minsize = max(minsize, 1u);
 659
 660                 /* how many packets will contain an entire ALSA period? */
 661                 max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
 662
 663                 /* how many URBs will contain a period? */
 664                 urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
 665                                 max_packs_per_urb);
 666                 /* how many packets are needed in each URB? */
 667                 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
 668
 669                 /* limit the number of frames in a single URB */
 670                 ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
 671                                         urbs_per_period);
 672
 673                 /* try to use enough URBs to contain an entire ALSA buffer */
 674                 max_urbs = min((unsigned) MAX_URBS,
 675                                 MAX_QUEUE * packs_per_ms / urb_packs);
 676                 ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
 677         }
 678
 679         /* allocate and initialize data urbs */
 680         for (i = 0; i < ep->nurbs; i++) {
 681                 struct snd_urb_ctx *u = &ep->urb[i];
 682                 u->index = i;
 683                 u->ep = ep;
 684                 u->packets = urb_packs;
 685                 u->buffer_size = maxsize * u->packets;
 686
 687                 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
 688                         u->packets++; /* for transfer delimiter */
 689                 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
 690                 if (!u->urb)
 691                         goto out_of_memory;
 692
 693                 u->urb->transfer_buffer =
 694                         usb_alloc_coherent(ep->chip->dev, u->buffer_size,
 695                                            GFP_KERNEL, &u->urb->transfer_dma);
 696                 if (!u->urb->transfer_buffer)
 697                         goto out_of_memory;
 698                 u->urb->pipe = ep->pipe;
 699                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 700                 u->urb->interval = 1 << ep->datainterval;
 701                 u->urb->context = u;
 702                 u->urb->complete = snd_complete_urb;
 703                 INIT_LIST_HEAD(&u->ready_list);
 704         }
 705
 706         return 0;
 707
 708 out_of_memory:
 709         release_urbs(ep, 0);
 710         return -ENOMEM;
 711 }
 712
 713 /*
 714  * configure a sync endpoint
 715  */
 716 static int sync_ep_set_params(struct snd_usb_endpoint *ep)
 717 {
 718         int i;
 719
 720         ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
 721                                          GFP_KERNEL, &ep->sync_dma);
 722         if (!ep->syncbuf)
 723                 return -ENOMEM;
 724
 725         for (i = 0; i < SYNC_URBS; i++) {
 726                 struct snd_urb_ctx *u = &ep->urb[i];
 727                 u->index = i;
 728                 u->ep = ep;
 729                 u->packets = 1;
 730                 u->urb = usb_alloc_urb(1, GFP_KERNEL);
 731                 if (!u->urb)
 732                         goto out_of_memory;
 733                 u->urb->transfer_buffer = ep->syncbuf + i * 4;
 734                 u->urb->transfer_dma = ep->sync_dma + i * 4;
 735                 u->urb->transfer_buffer_length = 4;
 736                 u->urb->pipe = ep->pipe;
 737                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 738                 u->urb->number_of_packets = 1;
 739                 u->urb->interval = 1 << ep->syncinterval;
 740                 u->urb->context = u;
 741                 u->urb->complete = snd_complete_urb;
 742         }
 743
 744         ep->nurbs = SYNC_URBS;
 745
 746         return 0;
 747
 748 out_of_memory:
 749         release_urbs(ep, 0);
 750         return -ENOMEM;
 751 }
 752
 753 /**
 754  * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
 755  *
 756  * @ep: the snd_usb_endpoint to configure
 757  * @pcm_format: the audio fomat.
 758  * @channels: the number of audio channels.
 759  * @period_bytes: the number of bytes in one alsa period.
 760  * @period_frames: the number of frames in one alsa period.
 761  * @buffer_periods: the number of periods in one alsa buffer.
 762  * @rate: the frame rate.
 763  * @fmt: the USB audio format information
 764  * @sync_ep: the sync endpoint to use, if any
 765  *
 766  * Determine the number of URBs to be used on this endpoint.
 767  * An endpoint must be configured before it can be started.
 768  * An endpoint that is already running can not be reconfigured.
 769  */
 770 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
 771                                 snd_pcm_format_t pcm_format,
 772                                 unsigned int channels,
 773                                 unsigned int period_bytes,
 774                                 unsigned int period_frames,
 775                                 unsigned int buffer_periods,
 776                                 unsigned int rate,
 777                                 struct audioformat *fmt,
 778                                 struct snd_usb_endpoint *sync_ep)
 779 {
 780         int err;
 781
 782         if (ep->use_count != 0) {
 783                 snd_printk(KERN_WARNING "Unable to change format on ep #%x: already in use\n",
 784                            ep->ep_num);
 785                 return -EBUSY;
 786         }
 787
 788         /* release old buffers, if any */
 789         release_urbs(ep, 0);
 790
 791         ep->datainterval = fmt->datainterval;
 792         ep->maxpacksize = fmt->maxpacksize;
 793         ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
 794
 795         if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
 796                 ep->freqn = get_usb_full_speed_rate(rate);
 797         else
 798                 ep->freqn = get_usb_high_speed_rate(rate);
 799
 800         /* calculate the frequency in 16.16 format */
 801         ep->freqm = ep->freqn;
 802         ep->freqshift = INT_MIN;
 803
 804         ep->phase = 0;
 805
 806         switch (ep->type) {
 807         case  SND_USB_ENDPOINT_TYPE_DATA:
 808                 err = data_ep_set_params(ep, pcm_format, channels,
 809                                          period_bytes, period_frames,
 810                                          buffer_periods, fmt, sync_ep);
 811                 break;
 812         case  SND_USB_ENDPOINT_TYPE_SYNC:
 813                 err = sync_ep_set_params(ep);
 814                 break;
 815         default:
 816                 err = -EINVAL;
 817         }
 818
 819         snd_printdd(KERN_DEBUG "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
 820                    ep->ep_num, ep->type, ep->nurbs, err);
 821
 822         return err;
 823 }
 824
 825 /**
 826  * snd_usb_endpoint_start: start an snd_usb_endpoint
 827  *
 828  * @ep:         the endpoint to start
 829  * @can_sleep:  flag indicating whether the operation is executed in
 830  *              non-atomic context
 831  *
 832  * A call to this function will increment the use count of the endpoint.
 833  * In case it is not already running, the URBs for this endpoint will be
 834  * submitted. Otherwise, this function does nothing.
 835  *
 836  * Must be balanced to calls of snd_usb_endpoint_stop().
 837  *
 838  * Returns an error if the URB submission failed, 0 in all other cases.
 839  */
 840 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, bool can_sleep)
 841 {
 842         int err;
 843         unsigned int i;
 844
 845         if (ep->chip->shutdown)
 846                 return -EBADFD;
 847
 848         /* already running? */
 849         if (++ep->use_count != 1)
 850                 return 0;
 851
 852         /* just to be sure */
 853         deactivate_urbs(ep, false);
 854         if (can_sleep)
 855                 wait_clear_urbs(ep);
 856
 857         ep->active_mask = 0;
 858         ep->unlink_mask = 0;
 859         ep->phase = 0;
 860
 861         snd_usb_endpoint_start_quirk(ep);
 862
 863         /*
 864          * If this endpoint has a data endpoint as implicit feedback source,
 865          * don't start the urbs here. Instead, mark them all as available,
 866          * wait for the record urbs to return and queue the playback urbs
 867          * from that context.
 868          */
 869
 870         set_bit(EP_FLAG_RUNNING, &ep->flags);
 871
 872         if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
 873                 for (i = 0; i < ep->nurbs; i++) {
 874                         struct snd_urb_ctx *ctx = ep->urb + i;
 875                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 876                 }
 877
 878                 return 0;
 879         }
 880
 881         for (i = 0; i < ep->nurbs; i++) {
 882                 struct urb *urb = ep->urb[i].urb;
 883
 884                 if (snd_BUG_ON(!urb))
 885                         goto __error;
 886
 887                 if (usb_pipeout(ep->pipe)) {
 888                         prepare_outbound_urb(ep, urb->context);
 889                 } else {
 890                         prepare_inbound_urb(ep, urb->context);
 891                 }
 892
 893                 err = usb_submit_urb(urb, GFP_ATOMIC);
 894                 if (err < 0) {
 895                         snd_printk(KERN_ERR "cannot submit urb %d, error %d: %s\n",
 896                                    i, err, usb_error_string(err));
 897                         goto __error;
 898                 }
 899                 set_bit(i, &ep->active_mask);
 900         }
 901
 902         return 0;
 903
 904 __error:
 905         clear_bit(EP_FLAG_RUNNING, &ep->flags);
 906         ep->use_count--;
 907         deactivate_urbs(ep, false);
 908         return -EPIPE;
 909 }
 910
 911 /**
 912  * snd_usb_endpoint_stop: stop an snd_usb_endpoint
 913  *
 914  * @ep: the endpoint to stop (may be NULL)
 915  *
 916  * A call to this function will decrement the use count of the endpoint.
 917  * In case the last user has requested the endpoint stop, the URBs will
 918  * actually be deactivated.
 919  *
 920  * Must be balanced to calls of snd_usb_endpoint_start().
 921  *
 922  * The caller needs to synchronize the pending stop operation via
 923  * snd_usb_endpoint_sync_pending_stop().
 924  */
 925 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
 926 {
 927         if (!ep)
 928                 return;
 929
 930         if (snd_BUG_ON(ep->use_count == 0))
 931                 return;
 932
 933         if (--ep->use_count == 0) {
 934                 deactivate_urbs(ep, false);
 935                 ep->data_subs = NULL;
 936                 ep->sync_slave = NULL;
 937                 ep->retire_data_urb = NULL;
 938                 ep->prepare_data_urb = NULL;
 939                 set_bit(EP_FLAG_STOPPING, &ep->flags);
 940         }
 941 }
 942
 943 /**
 944  * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
 945  *
 946  * @ep: the endpoint to deactivate
 947  *
 948  * If the endpoint is not currently in use, this functions will
 949  * deactivate its associated URBs.
 950  *
 951  * In case of any active users, this functions does nothing.
 952  */
 953 void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
 954 {
 955         if (!ep)
 956                 return;
 957
 958         if (ep->use_count != 0)
 959                 return;
 960
 961         deactivate_urbs(ep, true);
 962         wait_clear_urbs(ep);
 963 }
 964
 965 /**
 966  * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
 967  *
 968  * @ep: the list header of the endpoint to free
 969  *
 970  * This function does not care for the endpoint's use count but will tear
 971  * down all the streaming URBs immediately and free all resources.
 972  */
 973 void snd_usb_endpoint_free(struct list_head *head)
 974 {
 975         struct snd_usb_endpoint *ep;
 976
 977         ep = list_entry(head, struct snd_usb_endpoint, list);
 978         release_urbs(ep, 1);
 979         kfree(ep);
 980 }
 981
 982 /**
 983  * snd_usb_handle_sync_urb: parse an USB sync packet
 984  *
 985  * @ep: the endpoint to handle the packet
 986  * @sender: the sending endpoint
 987  * @urb: the received packet
 988  *
 989  * This function is called from the context of an endpoint that received
 990  * the packet and is used to let another endpoint object handle the payload.
 991  */
 992 void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
 993                              struct snd_usb_endpoint *sender,
 994                              const struct urb *urb)
 995 {
 996         int shift;
 997         unsigned int f;
 998         unsigned long flags;
 999
1000         snd_BUG_ON(ep == sender);
1001
1002         /*
1003          * In case the endpoint is operating in implicit feedback mode, prepare
1004          * a new outbound URB that has the same layout as the received packet
1005          * and add it to the list of pending urbs. queue_pending_output_urbs()
1006          * will take care of them later.
1007          */
1008         if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
1009             ep->use_count != 0) {
1010
1011                 /* implicit feedback case */
1012                 int i, bytes = 0;
1013                 struct snd_urb_ctx *in_ctx;
1014                 struct snd_usb_packet_info *out_packet;
1015
1016                 in_ctx = urb->context;
1017
1018                 /* Count overall packet size */
1019                 for (i = 0; i < in_ctx->packets; i++)
1020                         if (urb->iso_frame_desc[i].status == 0)
1021                                 bytes += urb->iso_frame_desc[i].actual_length;
1022
1023                 /*
1024                  * skip empty packets. At least M-Audio's Fast Track Ultra stops
1025                  * streaming once it received a 0-byte OUT URB
1026                  */
1027                 if (bytes == 0)
1028                         return;
1029
1030                 spin_lock_irqsave(&ep->lock, flags);
1031                 out_packet = ep->next_packet + ep->next_packet_write_pos;
1032
1033                 /*
1034                  * Iterate through the inbound packet and prepare the lengths
1035                  * for the output packet. The OUT packet we are about to send
1036                  * will have the same amount of payload bytes per stride as the
1037                  * IN packet we just received. Since the actual size is scaled
1038                  * by the stride, use the sender stride to calculate the length
1039                  * in case the number of channels differ between the implicitly
1040                  * fed-back endpoint and the synchronizing endpoint.
1041                  */
1042
1043                 out_packet->packets = in_ctx->packets;
1044                 for (i = 0; i < in_ctx->packets; i++) {
1045                         if (urb->iso_frame_desc[i].status == 0)
1046                                 out_packet->packet_size[i] =
1047                                         urb->iso_frame_desc[i].actual_length / sender->stride;
1048                         else
1049                                 out_packet->packet_size[i] = 0;
1050                 }
1051
1052                 ep->next_packet_write_pos++;
1053                 ep->next_packet_write_pos %= MAX_URBS;
1054                 spin_unlock_irqrestore(&ep->lock, flags);
1055                 queue_pending_output_urbs(ep);
1056
1057                 return;
1058         }
1059
1060         /*
1061          * process after playback sync complete
1062          *
1063          * Full speed devices report feedback values in 10.14 format as samples
1064          * per frame, high speed devices in 16.16 format as samples per
1065          * microframe.
1066          *
1067          * Because the Audio Class 1 spec was written before USB 2.0, many high
1068          * speed devices use a wrong interpretation, some others use an
1069          * entirely different format.
1070          *
1071          * Therefore, we cannot predict what format any particular device uses
1072          * and must detect it automatically.
1073          */
1074
1075         if (urb->iso_frame_desc[0].status != 0 ||
1076             urb->iso_frame_desc[0].actual_length < 3)
1077                 return;
1078
1079         f = le32_to_cpup(urb->transfer_buffer);
1080         if (urb->iso_frame_desc[0].actual_length == 3)
1081                 f &= 0x00ffffff;
1082         else
1083                 f &= 0x0fffffff;
1084
1085         if (f == 0)
1086                 return;
1087
1088         if (unlikely(ep->freqshift == INT_MIN)) {
1089                 /*
1090                  * The first time we see a feedback value, determine its format
1091                  * by shifting it left or right until it matches the nominal
1092                  * frequency value.  This assumes that the feedback does not
1093                  * differ from the nominal value more than +50% or -25%.
1094                  */
1095                 shift = 0;
1096                 while (f < ep->freqn - ep->freqn / 4) {
1097                         f <<= 1;
1098                         shift++;
1099                 }
1100                 while (f > ep->freqn + ep->freqn / 2) {
1101                         f >>= 1;
1102                         shift--;
1103                 }
1104                 ep->freqshift = shift;
1105         } else if (ep->freqshift >= 0)
1106                 f <<= ep->freqshift;
1107         else
1108                 f >>= -ep->freqshift;
1109
1110         if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1111                 /*
1112                  * If the frequency looks valid, set it.
1113                  * This value is referred to in prepare_playback_urb().
1114                  */
1115                 spin_lock_irqsave(&ep->lock, flags);
1116                 ep->freqm = f;
1117                 spin_unlock_irqrestore(&ep->lock, flags);
1118         } else {
1119                 /*
1120                  * Out of range; maybe the shift value is wrong.
1121                  * Reset it so that we autodetect again the next time.
1122                  */
1123                 ep->freqshift = INT_MIN;
1124         }
1125 }
1126