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_ACTIVATED       0
  37 #define EP_FLAG_RUNNING         1
  38 #define EP_FLAG_STOPPING        2
  39
  40 /*
  41  * snd_usb_endpoint is a model that abstracts everything related to an
  42  * USB endpoint and its streaming.
  43  *
  44  * There are functions to activate and deactivate the streaming URBs and
  45  * optional callbacks to let the pcm logic handle the actual content of the
  46  * packets for playback and record. Thus, the bus streaming and the audio
  47  * handlers are fully decoupled.
  48  *
  49  * There are two different types of endpoints in audio applications.
  50  *
  51  * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
  52  * inbound and outbound traffic.
  53  *
  54  * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
  55  * expect the payload to carry Q10.14 / Q16.16 formatted sync information
  56  * (3 or 4 bytes).
  57  *
  58  * Each endpoint has to be configured prior to being used by calling
  59  * snd_usb_endpoint_set_params().
  60  *
  61  * The model incorporates a reference counting, so that multiple users
  62  * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
  63  * only the first user will effectively start the URBs, and only the last
  64  * one to stop it will tear the URBs down again.
  65  */
  66
  67 /*
  68  * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
  69  * this will overflow at approx 524 kHz
  70  */
  71 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
  72 {
  73         return ((rate << 13) + 62) / 125;
  74 }
  75
  76 /*
  77  * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
  78  * this will overflow at approx 4 MHz
  79  */
  80 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
  81 {
  82         return ((rate << 10) + 62) / 125;
  83 }
  84
  85 /*
  86  * release a urb data
  87  */
  88 static void release_urb_ctx(struct snd_urb_ctx *u)
  89 {
  90         if (u->buffer_size)
  91                 usb_free_coherent(u->ep->chip->dev, u->buffer_size,
  92                                   u->urb->transfer_buffer,
  93                                   u->urb->transfer_dma);
  94         usb_free_urb(u->urb);
  95         u->urb = NULL;
  96 }
  97
  98 static const char *usb_error_string(int err)
  99 {
 100         switch (err) {
 101         case -ENODEV:
 102                 return "no device";
 103         case -ENOENT:
 104                 return "endpoint not enabled";
 105         case -EPIPE:
 106                 return "endpoint stalled";
 107         case -ENOSPC:
 108                 return "not enough bandwidth";
 109         case -ESHUTDOWN:
 110                 return "device disabled";
 111         case -EHOSTUNREACH:
 112                 return "device suspended";
 113         case -EINVAL:
 114         case -EAGAIN:
 115         case -EFBIG:
 116         case -EMSGSIZE:
 117                 return "internal error";
 118         default:
 119                 return "unknown error";
 120         }
 121 }
 122
 123 /**
 124  * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
 125  *
 126  * @ep: The snd_usb_endpoint
 127  *
 128  * Determine whether an endpoint is driven by an implicit feedback
 129  * data endpoint source.
 130  */
 131 int snd_usb_endpoint_implict_feedback_sink(struct snd_usb_endpoint *ep)
 132 {
 133         return  ep->sync_master &&
 134                 ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
 135                 ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
 136                 usb_pipeout(ep->pipe);
 137 }
 138
 139 /*
 140  * For streaming based on information derived from sync endpoints,
 141  * prepare_outbound_urb_sizes() will call next_packet_size() to
 142  * determine the number of samples to be sent in the next packet.
 143  *
 144  * For implicit feedback, next_packet_size() is unused.
 145  */
 146 int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
 147 {
 148         unsigned long flags;
 149         int ret;
 150
 151         if (ep->fill_max)
 152                 return ep->maxframesize;
 153
 154         spin_lock_irqsave(&ep->lock, flags);
 155         ep->phase = (ep->phase & 0xffff)
 156                 + (ep->freqm << ep->datainterval);
 157         ret = min(ep->phase >> 16, ep->maxframesize);
 158         spin_unlock_irqrestore(&ep->lock, flags);
 159
 160         return ret;
 161 }
 162
 163 static void retire_outbound_urb(struct snd_usb_endpoint *ep,
 164                                 struct snd_urb_ctx *urb_ctx)
 165 {
 166         if (ep->retire_data_urb)
 167                 ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
 168 }
 169
 170 static void retire_inbound_urb(struct snd_usb_endpoint *ep,
 171                                struct snd_urb_ctx *urb_ctx)
 172 {
 173         struct urb *urb = urb_ctx->urb;
 174
 175         if (unlikely(ep->skip_packets > 0)) {
 176                 ep->skip_packets--;
 177                 return;
 178         }
 179
 180         if (ep->sync_slave)
 181                 snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
 182
 183         if (ep->retire_data_urb)
 184                 ep->retire_data_urb(ep->data_subs, urb);
 185 }
 186
 187 /*
 188  * Prepare a PLAYBACK urb for submission to the bus.
 189  */
 190 static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
 191                                  struct snd_urb_ctx *ctx)
 192 {
 193         int i;
 194         struct urb *urb = ctx->urb;
 195         unsigned char *cp = urb->transfer_buffer;
 196
 197         urb->dev = ep->chip->dev; /* we need to set this at each time */
 198
 199         switch (ep->type) {
 200         case SND_USB_ENDPOINT_TYPE_DATA:
 201                 if (ep->prepare_data_urb) {
 202                         ep->prepare_data_urb(ep->data_subs, urb);
 203                 } else {
 204                         /* no data provider, so send silence */
 205                         unsigned int offs = 0;
 206                         for (i = 0; i < ctx->packets; ++i) {
 207                                 int counts;
 208
 209                                 if (ctx->packet_size[i])
 210                                         counts = ctx->packet_size[i];
 211                                 else
 212                                         counts = snd_usb_endpoint_next_packet_size(ep);
 213
 214                                 urb->iso_frame_desc[i].offset = offs * ep->stride;
 215                                 urb->iso_frame_desc[i].length = counts * ep->stride;
 216                                 offs += counts;
 217                         }
 218
 219                         urb->number_of_packets = ctx->packets;
 220                         urb->transfer_buffer_length = offs * ep->stride;
 221                         memset(urb->transfer_buffer, ep->silence_value,
 222                                offs * ep->stride);
 223                 }
 224                 break;
 225
 226         case SND_USB_ENDPOINT_TYPE_SYNC:
 227                 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
 228                         /*
 229                          * fill the length and offset of each urb descriptor.
 230                          * the fixed 12.13 frequency is passed as 16.16 through the pipe.
 231                          */
 232                         urb->iso_frame_desc[0].length = 4;
 233                         urb->iso_frame_desc[0].offset = 0;
 234                         cp[0] = ep->freqn;
 235                         cp[1] = ep->freqn >> 8;
 236                         cp[2] = ep->freqn >> 16;
 237                         cp[3] = ep->freqn >> 24;
 238                 } else {
 239                         /*
 240                          * fill the length and offset of each urb descriptor.
 241                          * the fixed 10.14 frequency is passed through the pipe.
 242                          */
 243                         urb->iso_frame_desc[0].length = 3;
 244                         urb->iso_frame_desc[0].offset = 0;
 245                         cp[0] = ep->freqn >> 2;
 246                         cp[1] = ep->freqn >> 10;
 247                         cp[2] = ep->freqn >> 18;
 248                 }
 249
 250                 break;
 251         }
 252 }
 253
 254 /*
 255  * Prepare a CAPTURE or SYNC urb for submission to the bus.
 256  */
 257 static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
 258                                        struct snd_urb_ctx *urb_ctx)
 259 {
 260         int i, offs;
 261         struct urb *urb = urb_ctx->urb;
 262
 263         urb->dev = ep->chip->dev; /* we need to set this at each time */
 264
 265         switch (ep->type) {
 266         case SND_USB_ENDPOINT_TYPE_DATA:
 267                 offs = 0;
 268                 for (i = 0; i < urb_ctx->packets; i++) {
 269                         urb->iso_frame_desc[i].offset = offs;
 270                         urb->iso_frame_desc[i].length = ep->curpacksize;
 271                         offs += ep->curpacksize;
 272                 }
 273
 274                 urb->transfer_buffer_length = offs;
 275                 urb->number_of_packets = urb_ctx->packets;
 276                 break;
 277
 278         case SND_USB_ENDPOINT_TYPE_SYNC:
 279                 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
 280                 urb->iso_frame_desc[0].offset = 0;
 281                 break;
 282         }
 283 }
 284
 285 /*
 286  * Send output urbs that have been prepared previously. URBs are dequeued
 287  * from ep->ready_playback_urbs and in case there there aren't any available
 288  * or there are no packets that have been prepared, this function does
 289  * nothing.
 290  *
 291  * The reason why the functionality of sending and preparing URBs is separated
 292  * is that host controllers don't guarantee the order in which they return
 293  * inbound and outbound packets to their submitters.
 294  *
 295  * This function is only used for implicit feedback endpoints. For endpoints
 296  * driven by dedicated sync endpoints, URBs are immediately re-submitted
 297  * from their completion handler.
 298  */
 299 static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
 300 {
 301         while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
 302
 303                 unsigned long flags;
 304                 struct snd_usb_packet_info *uninitialized_var(packet);
 305                 struct snd_urb_ctx *ctx = NULL;
 306                 struct urb *urb;
 307                 int err, i;
 308
 309                 spin_lock_irqsave(&ep->lock, flags);
 310                 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
 311                         packet = ep->next_packet + ep->next_packet_read_pos;
 312                         ep->next_packet_read_pos++;
 313                         ep->next_packet_read_pos %= MAX_URBS;
 314
 315                         /* take URB out of FIFO */
 316                         if (!list_empty(&ep->ready_playback_urbs))
 317                                 ctx = list_first_entry(&ep->ready_playback_urbs,
 318                                                struct snd_urb_ctx, ready_list);
 319                 }
 320                 spin_unlock_irqrestore(&ep->lock, flags);
 321
 322                 if (ctx == NULL)
 323                         return;
 324
 325                 list_del_init(&ctx->ready_list);
 326                 urb = ctx->urb;
 327
 328                 /* copy over the length information */
 329                 for (i = 0; i < packet->packets; i++)
 330                         ctx->packet_size[i] = packet->packet_size[i];
 331
 332                 /* call the data handler to fill in playback data */
 333                 prepare_outbound_urb(ep, ctx);
 334
 335                 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
 336                 if (err < 0)
 337                         snd_printk(KERN_ERR "Unable to submit urb #%d: %d (urb %p)\n",
 338                                    ctx->index, err, ctx->urb);
 339                 else
 340                         set_bit(ctx->index, &ep->active_mask);
 341         }
 342 }
 343
 344 /*
 345  * complete callback for urbs
 346  */
 347 static void snd_complete_urb(struct urb *urb)
 348 {
 349         struct snd_urb_ctx *ctx = urb->context;
 350         struct snd_usb_endpoint *ep = ctx->ep;
 351         int err;
 352
 353         if (unlikely(urb->status == -ENOENT ||          /* unlinked */
 354                      urb->status == -ENODEV ||          /* device removed */
 355                      urb->status == -ECONNRESET ||      /* unlinked */
 356                      urb->status == -ESHUTDOWN ||       /* device disabled */
 357                      ep->chip->shutdown))               /* device disconnected */
 358                 goto exit_clear;
 359
 360         if (usb_pipeout(ep->pipe)) {
 361                 retire_outbound_urb(ep, ctx);
 362                 /* can be stopped during retire callback */
 363                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 364                         goto exit_clear;
 365
 366                 if (snd_usb_endpoint_implict_feedback_sink(ep)) {
 367                         unsigned long flags;
 368
 369                         spin_lock_irqsave(&ep->lock, flags);
 370                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 371                         spin_unlock_irqrestore(&ep->lock, flags);
 372                         queue_pending_output_urbs(ep);
 373
 374                         goto exit_clear;
 375                 }
 376
 377                 prepare_outbound_urb(ep, ctx);
 378         } else {
 379                 retire_inbound_urb(ep, ctx);
 380                 /* can be stopped during retire callback */
 381                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
 382                         goto exit_clear;
 383
 384                 prepare_inbound_urb(ep, ctx);
 385         }
 386
 387         err = usb_submit_urb(urb, GFP_ATOMIC);
 388         if (err == 0)
 389                 return;
 390
 391         snd_printk(KERN_ERR "cannot submit urb (err = %d)\n", err);
 392         //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
 393
 394 exit_clear:
 395         clear_bit(ctx->index, &ep->active_mask);
 396 }
 397
 398 /**
 399  * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
 400  *
 401  * @chip: The chip
 402  * @alts: The USB host interface
 403  * @ep_num: The number of the endpoint to use
 404  * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
 405  * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
 406  *
 407  * If the requested endpoint has not been added to the given chip before,
 408  * a new instance is created. Otherwise, a pointer to the previoulsy
 409  * created instance is returned. In case of any error, NULL is returned.
 410  *
 411  * New endpoints will be added to chip->ep_list and must be freed by
 412  * calling snd_usb_endpoint_free().
 413  */
 414 struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
 415                                               struct usb_host_interface *alts,
 416                                               int ep_num, int direction, int type)
 417 {
 418         struct list_head *p;
 419         struct snd_usb_endpoint *ep;
 420         int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
 421
 422         mutex_lock(&chip->mutex);
 423
 424         list_for_each(p, &chip->ep_list) {
 425                 ep = list_entry(p, struct snd_usb_endpoint, list);
 426                 if (ep->ep_num == ep_num &&
 427                     ep->iface == alts->desc.bInterfaceNumber &&
 428                     ep->alt_idx == alts->desc.bAlternateSetting) {
 429                         snd_printdd(KERN_DEBUG "Re-using EP %x in iface %d,%d @%p\n",
 430                                         ep_num, ep->iface, ep->alt_idx, 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->alt_idx = 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                               struct audioformat *fmt,
 577                               struct snd_usb_endpoint *sync_ep)
 578 {
 579         unsigned int maxsize, i, urb_packs, total_packs, packs_per_ms;
 580         int is_playback = usb_pipeout(ep->pipe);
 581         int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
 582
 583         ep->datainterval = fmt->datainterval;
 584         ep->stride = frame_bits >> 3;
 585         ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
 586
 587         /* calculate max. frequency */
 588         if (ep->maxpacksize) {
 589                 /* whatever fits into a max. size packet */
 590                 maxsize = ep->maxpacksize;
 591                 ep->freqmax = (maxsize / (frame_bits >> 3))
 592                                 << (16 - ep->datainterval);
 593         } else {
 594                 /* no max. packet size: just take 25% higher than nominal */
 595                 ep->freqmax = ep->freqn + (ep->freqn >> 2);
 596                 maxsize = ((ep->freqmax + 0xffff) * (frame_bits >> 3))
 597                                 >> (16 - ep->datainterval);
 598         }
 599
 600         if (ep->fill_max)
 601                 ep->curpacksize = ep->maxpacksize;
 602         else
 603                 ep->curpacksize = maxsize;
 604
 605         if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL)
 606                 packs_per_ms = 8 >> ep->datainterval;
 607         else
 608                 packs_per_ms = 1;
 609
 610         if (is_playback && !snd_usb_endpoint_implict_feedback_sink(ep)) {
 611                 urb_packs = max(ep->chip->nrpacks, 1);
 612                 urb_packs = min(urb_packs, (unsigned int) MAX_PACKS);
 613         } else {
 614                 urb_packs = 1;
 615         }
 616
 617         urb_packs *= packs_per_ms;
 618
 619         if (sync_ep && !snd_usb_endpoint_implict_feedback_sink(ep))
 620                 urb_packs = min(urb_packs, 1U << sync_ep->syncinterval);
 621
 622         /* decide how many packets to be used */
 623         if (is_playback && !snd_usb_endpoint_implict_feedback_sink(ep)) {
 624                 unsigned int minsize, maxpacks;
 625                 /* determine how small a packet can be */
 626                 minsize = (ep->freqn >> (16 - ep->datainterval))
 627                           * (frame_bits >> 3);
 628                 /* with sync from device, assume it can be 12% lower */
 629                 if (sync_ep)
 630                         minsize -= minsize >> 3;
 631                 minsize = max(minsize, 1u);
 632                 total_packs = (period_bytes + minsize - 1) / minsize;
 633                 /* we need at least two URBs for queueing */
 634                 if (total_packs < 2) {
 635                         total_packs = 2;
 636                 } else {
 637                         /* and we don't want too long a queue either */
 638                         maxpacks = max(MAX_QUEUE * packs_per_ms, urb_packs * 2);
 639                         total_packs = min(total_packs, maxpacks);
 640                 }
 641         } else {
 642                 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
 643                         urb_packs >>= 1;
 644                 total_packs = MAX_URBS * urb_packs;
 645         }
 646
 647         ep->nurbs = (total_packs + urb_packs - 1) / urb_packs;
 648         if (ep->nurbs > MAX_URBS) {
 649                 /* too much... */
 650                 ep->nurbs = MAX_URBS;
 651                 total_packs = MAX_URBS * urb_packs;
 652         } else if (ep->nurbs < 2) {
 653                 /* too little - we need at least two packets
 654                  * to ensure contiguous playback/capture
 655                  */
 656                 ep->nurbs = 2;
 657         }
 658
 659         /* allocate and initialize data urbs */
 660         for (i = 0; i < ep->nurbs; i++) {
 661                 struct snd_urb_ctx *u = &ep->urb[i];
 662                 u->index = i;
 663                 u->ep = ep;
 664                 u->packets = (i + 1) * total_packs / ep->nurbs
 665                         - i * total_packs / ep->nurbs;
 666                 u->buffer_size = maxsize * u->packets;
 667
 668                 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
 669                         u->packets++; /* for transfer delimiter */
 670                 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
 671                 if (!u->urb)
 672                         goto out_of_memory;
 673
 674                 u->urb->transfer_buffer =
 675                         usb_alloc_coherent(ep->chip->dev, u->buffer_size,
 676                                            GFP_KERNEL, &u->urb->transfer_dma);
 677                 if (!u->urb->transfer_buffer)
 678                         goto out_of_memory;
 679                 u->urb->pipe = ep->pipe;
 680                 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
 681                 u->urb->interval = 1 << ep->datainterval;
 682                 u->urb->context = u;
 683                 u->urb->complete = snd_complete_urb;
 684                 INIT_LIST_HEAD(&u->ready_list);
 685         }
 686
 687         return 0;
 688
 689 out_of_memory:
 690         release_urbs(ep, 0);
 691         return -ENOMEM;
 692 }
 693
 694 /*
 695  * configure a sync endpoint
 696  */
 697 static int sync_ep_set_params(struct snd_usb_endpoint *ep,
 698                               struct audioformat *fmt)
 699 {
 700         int i;
 701
 702         ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
 703                                          GFP_KERNEL, &ep->sync_dma);
 704         if (!ep->syncbuf)
 705                 return -ENOMEM;
 706
 707         for (i = 0; i < SYNC_URBS; i++) {
 708                 struct snd_urb_ctx *u = &ep->urb[i];
 709                 u->index = i;
 710                 u->ep = ep;
 711                 u->packets = 1;
 712                 u->urb = usb_alloc_urb(1, GFP_KERNEL);
 713                 if (!u->urb)
 714                         goto out_of_memory;
 715                 u->urb->transfer_buffer = ep->syncbuf + i * 4;
 716                 u->urb->transfer_dma = ep->sync_dma + i * 4;
 717                 u->urb->transfer_buffer_length = 4;
 718                 u->urb->pipe = ep->pipe;
 719                 u->urb->transfer_flags = URB_ISO_ASAP |
 720                                          URB_NO_TRANSFER_DMA_MAP;
 721                 u->urb->number_of_packets = 1;
 722                 u->urb->interval = 1 << ep->syncinterval;
 723                 u->urb->context = u;
 724                 u->urb->complete = snd_complete_urb;
 725         }
 726
 727         ep->nurbs = SYNC_URBS;
 728
 729         return 0;
 730
 731 out_of_memory:
 732         release_urbs(ep, 0);
 733         return -ENOMEM;
 734 }
 735
 736 /**
 737  * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
 738  *
 739  * @ep: the snd_usb_endpoint to configure
 740  * @pcm_format: the audio fomat.
 741  * @channels: the number of audio channels.
 742  * @period_bytes: the number of bytes in one alsa period.
 743  * @rate: the frame rate.
 744  * @fmt: the USB audio format information
 745  * @sync_ep: the sync endpoint to use, if any
 746  *
 747  * Determine the number of URBs to be used on this endpoint.
 748  * An endpoint must be configured before it can be started.
 749  * An endpoint that is already running can not be reconfigured.
 750  */
 751 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
 752                                 snd_pcm_format_t pcm_format,
 753                                 unsigned int channels,
 754                                 unsigned int period_bytes,
 755                                 unsigned int rate,
 756                                 struct audioformat *fmt,
 757                                 struct snd_usb_endpoint *sync_ep)
 758 {
 759         int err;
 760
 761         if (ep->use_count != 0) {
 762                 snd_printk(KERN_WARNING "Unable to change format on ep #%x: already in use\n",
 763                            ep->ep_num);
 764                 return -EBUSY;
 765         }
 766
 767         /* release old buffers, if any */
 768         release_urbs(ep, 0);
 769
 770         ep->datainterval = fmt->datainterval;
 771         ep->maxpacksize = fmt->maxpacksize;
 772         ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
 773
 774         if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
 775                 ep->freqn = get_usb_full_speed_rate(rate);
 776         else
 777                 ep->freqn = get_usb_high_speed_rate(rate);
 778
 779         /* calculate the frequency in 16.16 format */
 780         ep->freqm = ep->freqn;
 781         ep->freqshift = INT_MIN;
 782
 783         ep->phase = 0;
 784
 785         switch (ep->type) {
 786         case  SND_USB_ENDPOINT_TYPE_DATA:
 787                 err = data_ep_set_params(ep, pcm_format, channels,
 788                                          period_bytes, fmt, sync_ep);
 789                 break;
 790         case  SND_USB_ENDPOINT_TYPE_SYNC:
 791                 err = sync_ep_set_params(ep, fmt);
 792                 break;
 793         default:
 794                 err = -EINVAL;
 795         }
 796
 797         snd_printdd(KERN_DEBUG "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
 798                    ep->ep_num, ep->type, ep->nurbs, err);
 799
 800         return err;
 801 }
 802
 803 /**
 804  * snd_usb_endpoint_start: start an snd_usb_endpoint
 805  *
 806  * @ep:         the endpoint to start
 807  * @can_sleep:  flag indicating whether the operation is executed in
 808  *              non-atomic context
 809  *
 810  * A call to this function will increment the use count of the endpoint.
 811  * In case it is not already running, the URBs for this endpoint will be
 812  * submitted. Otherwise, this function does nothing.
 813  *
 814  * Must be balanced to calls of snd_usb_endpoint_stop().
 815  *
 816  * Returns an error if the URB submission failed, 0 in all other cases.
 817  */
 818 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, bool can_sleep)
 819 {
 820         int err;
 821         unsigned int i;
 822
 823         if (ep->chip->shutdown)
 824                 return -EBADFD;
 825
 826         /* already running? */
 827         if (++ep->use_count != 1)
 828                 return 0;
 829
 830         /* just to be sure */
 831         deactivate_urbs(ep, false);
 832         if (can_sleep)
 833                 wait_clear_urbs(ep);
 834
 835         ep->active_mask = 0;
 836         ep->unlink_mask = 0;
 837         ep->phase = 0;
 838
 839         snd_usb_endpoint_start_quirk(ep);
 840
 841         /*
 842          * If this endpoint has a data endpoint as implicit feedback source,
 843          * don't start the urbs here. Instead, mark them all as available,
 844          * wait for the record urbs to return and queue the playback urbs
 845          * from that context.
 846          */
 847
 848         set_bit(EP_FLAG_RUNNING, &ep->flags);
 849
 850         if (snd_usb_endpoint_implict_feedback_sink(ep)) {
 851                 for (i = 0; i < ep->nurbs; i++) {
 852                         struct snd_urb_ctx *ctx = ep->urb + i;
 853                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
 854                 }
 855
 856                 return 0;
 857         }
 858
 859         for (i = 0; i < ep->nurbs; i++) {
 860                 struct urb *urb = ep->urb[i].urb;
 861
 862                 if (snd_BUG_ON(!urb))
 863                         goto __error;
 864
 865                 if (usb_pipeout(ep->pipe)) {
 866                         prepare_outbound_urb(ep, urb->context);
 867                 } else {
 868                         prepare_inbound_urb(ep, urb->context);
 869                 }
 870
 871                 err = usb_submit_urb(urb, GFP_ATOMIC);
 872                 if (err < 0) {
 873                         snd_printk(KERN_ERR "cannot submit urb %d, error %d: %s\n",
 874                                    i, err, usb_error_string(err));
 875                         goto __error;
 876                 }
 877                 set_bit(i, &ep->active_mask);
 878         }
 879
 880         return 0;
 881
 882 __error:
 883         clear_bit(EP_FLAG_RUNNING, &ep->flags);
 884         ep->use_count--;
 885         deactivate_urbs(ep, false);
 886         return -EPIPE;
 887 }
 888
 889 /**
 890  * snd_usb_endpoint_stop: stop an snd_usb_endpoint
 891  *
 892  * @ep: the endpoint to stop (may be NULL)
 893  *
 894  * A call to this function will decrement the use count of the endpoint.
 895  * In case the last user has requested the endpoint stop, the URBs will
 896  * actually be deactivated.
 897  *
 898  * Must be balanced to calls of snd_usb_endpoint_start().
 899  *
 900  * The caller needs to synchronize the pending stop operation via
 901  * snd_usb_endpoint_sync_pending_stop().
 902  */
 903 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
 904 {
 905         if (!ep)
 906                 return;
 907
 908         if (snd_BUG_ON(ep->use_count == 0))
 909                 return;
 910
 911         if (--ep->use_count == 0) {
 912                 deactivate_urbs(ep, false);
 913                 ep->data_subs = NULL;
 914                 ep->sync_slave = NULL;
 915                 ep->retire_data_urb = NULL;
 916                 ep->prepare_data_urb = NULL;
 917                 set_bit(EP_FLAG_STOPPING, &ep->flags);
 918         }
 919 }
 920
 921 /**
 922  * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
 923  *
 924  * @ep: the endpoint to deactivate
 925  *
 926  * If the endpoint is not currently in use, this functions will select the
 927  * alternate interface setting 0 for the interface of this endpoint.
 928  *
 929  * In case of any active users, this functions does nothing.
 930  *
 931  * Returns an error if usb_set_interface() failed, 0 in all other
 932  * cases.
 933  */
 934 int snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
 935 {
 936         if (!ep)
 937                 return -EINVAL;
 938
 939         deactivate_urbs(ep, true);
 940         wait_clear_urbs(ep);
 941
 942         if (ep->use_count != 0)
 943                 return 0;
 944
 945         clear_bit(EP_FLAG_ACTIVATED, &ep->flags);
 946
 947         return 0;
 948 }
 949
 950 /**
 951  * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
 952  *
 953  * @ep: the list header of the endpoint to free
 954  *
 955  * This function does not care for the endpoint's use count but will tear
 956  * down all the streaming URBs immediately and free all resources.
 957  */
 958 void snd_usb_endpoint_free(struct list_head *head)
 959 {
 960         struct snd_usb_endpoint *ep;
 961
 962         ep = list_entry(head, struct snd_usb_endpoint, list);
 963         release_urbs(ep, 1);
 964         kfree(ep);
 965 }
 966
 967 /**
 968  * snd_usb_handle_sync_urb: parse an USB sync packet
 969  *
 970  * @ep: the endpoint to handle the packet
 971  * @sender: the sending endpoint
 972  * @urb: the received packet
 973  *
 974  * This function is called from the context of an endpoint that received
 975  * the packet and is used to let another endpoint object handle the payload.
 976  */
 977 void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
 978                              struct snd_usb_endpoint *sender,
 979                              const struct urb *urb)
 980 {
 981         int shift;
 982         unsigned int f;
 983         unsigned long flags;
 984
 985         snd_BUG_ON(ep == sender);
 986
 987         /*
 988          * In case the endpoint is operating in implicit feedback mode, prepare
 989          * a new outbound URB that has the same layout as the received packet
 990          * and add it to the list of pending urbs. queue_pending_output_urbs()
 991          * will take care of them later.
 992          */
 993         if (snd_usb_endpoint_implict_feedback_sink(ep) &&
 994             ep->use_count != 0) {
 995
 996                 /* implicit feedback case */
 997                 int i, bytes = 0;
 998                 struct snd_urb_ctx *in_ctx;
 999                 struct snd_usb_packet_info *out_packet;
1000
1001                 in_ctx = urb->context;
1002
1003                 /* Count overall packet size */
1004                 for (i = 0; i < in_ctx->packets; i++)
1005                         if (urb->iso_frame_desc[i].status == 0)
1006                                 bytes += urb->iso_frame_desc[i].actual_length;
1007
1008                 /*
1009                  * skip empty packets. At least M-Audio's Fast Track Ultra stops
1010                  * streaming once it received a 0-byte OUT URB
1011                  */
1012                 if (bytes == 0)
1013                         return;
1014
1015                 spin_lock_irqsave(&ep->lock, flags);
1016                 out_packet = ep->next_packet + ep->next_packet_write_pos;
1017
1018                 /*
1019                  * Iterate through the inbound packet and prepare the lengths
1020                  * for the output packet. The OUT packet we are about to send
1021                  * will have the same amount of payload bytes per stride as the
1022                  * IN packet we just received. Since the actual size is scaled
1023                  * by the stride, use the sender stride to calculate the length
1024                  * in case the number of channels differ between the implicitly
1025                  * fed-back endpoint and the synchronizing endpoint.
1026                  */
1027
1028                 out_packet->packets = in_ctx->packets;
1029                 for (i = 0; i < in_ctx->packets; i++) {
1030                         if (urb->iso_frame_desc[i].status == 0)
1031                                 out_packet->packet_size[i] =
1032                                         urb->iso_frame_desc[i].actual_length / sender->stride;
1033                         else
1034                                 out_packet->packet_size[i] = 0;
1035                 }
1036
1037                 ep->next_packet_write_pos++;
1038                 ep->next_packet_write_pos %= MAX_URBS;
1039                 spin_unlock_irqrestore(&ep->lock, flags);
1040                 queue_pending_output_urbs(ep);
1041
1042                 return;
1043         }
1044
1045         /*
1046          * process after playback sync complete
1047          *
1048          * Full speed devices report feedback values in 10.14 format as samples
1049          * per frame, high speed devices in 16.16 format as samples per
1050          * microframe.
1051          *
1052          * Because the Audio Class 1 spec was written before USB 2.0, many high
1053          * speed devices use a wrong interpretation, some others use an
1054          * entirely different format.
1055          *
1056          * Therefore, we cannot predict what format any particular device uses
1057          * and must detect it automatically.
1058          */
1059
1060         if (urb->iso_frame_desc[0].status != 0 ||
1061             urb->iso_frame_desc[0].actual_length < 3)
1062                 return;
1063
1064         f = le32_to_cpup(urb->transfer_buffer);
1065         if (urb->iso_frame_desc[0].actual_length == 3)
1066                 f &= 0x00ffffff;
1067         else
1068                 f &= 0x0fffffff;
1069
1070         if (f == 0)
1071                 return;
1072
1073         if (unlikely(ep->freqshift == INT_MIN)) {
1074                 /*
1075                  * The first time we see a feedback value, determine its format
1076                  * by shifting it left or right until it matches the nominal
1077                  * frequency value.  This assumes that the feedback does not
1078                  * differ from the nominal value more than +50% or -25%.
1079                  */
1080                 shift = 0;
1081                 while (f < ep->freqn - ep->freqn / 4) {
1082                         f <<= 1;
1083                         shift++;
1084                 }
1085                 while (f > ep->freqn + ep->freqn / 2) {
1086                         f >>= 1;
1087                         shift--;
1088                 }
1089                 ep->freqshift = shift;
1090         } else if (ep->freqshift >= 0)
1091                 f <<= ep->freqshift;
1092         else
1093                 f >>= -ep->freqshift;
1094
1095         if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1096                 /*
1097                  * If the frequency looks valid, set it.
1098                  * This value is referred to in prepare_playback_urb().
1099                  */
1100                 spin_lock_irqsave(&ep->lock, flags);
1101                 ep->freqm = f;
1102                 spin_unlock_irqrestore(&ep->lock, flags);
1103         } else {
1104                 /*
1105                  * Out of range; maybe the shift value is wrong.
1106                  * Reset it so that we autodetect again the next time.
1107                  */
1108                 ep->freqshift = INT_MIN;
1109         }
1110 }
1111