1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 */ 4 5 #include <linux/gfp.h> 6 #include <linux/init.h> 7 #include <linux/ratelimit.h> 8 #include <linux/usb.h> 9 #include <linux/usb/audio.h> 10 #include <linux/slab.h> 11 12 #include <sound/core.h> 13 #include <sound/pcm.h> 14 #include <sound/pcm_params.h> 15 16 #include "usbaudio.h" 17 #include "helper.h" 18 #include "card.h" 19 #include "endpoint.h" 20 #include "pcm.h" 21 #include "clock.h" 22 #include "quirks.h" 23 24 enum { 25 EP_STATE_STOPPED, 26 EP_STATE_RUNNING, 27 EP_STATE_STOPPING, 28 }; 29 30 /* interface refcounting */ 31 struct snd_usb_iface_ref { 32 unsigned char iface; 33 bool need_setup; 34 int opened; 35 int altset; 36 struct list_head list; 37 }; 38 39 /* clock refcounting */ 40 struct snd_usb_clock_ref { 41 unsigned char clock; 42 atomic_t locked; 43 int opened; 44 int rate; 45 bool need_setup; 46 struct list_head list; 47 }; 48 49 /* 50 * snd_usb_endpoint is a model that abstracts everything related to an 51 * USB endpoint and its streaming. 52 * 53 * There are functions to activate and deactivate the streaming URBs and 54 * optional callbacks to let the pcm logic handle the actual content of the 55 * packets for playback and record. Thus, the bus streaming and the audio 56 * handlers are fully decoupled. 57 * 58 * There are two different types of endpoints in audio applications. 59 * 60 * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both 61 * inbound and outbound traffic. 62 * 63 * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and 64 * expect the payload to carry Q10.14 / Q16.16 formatted sync information 65 * (3 or 4 bytes). 66 * 67 * Each endpoint has to be configured prior to being used by calling 68 * snd_usb_endpoint_set_params(). 69 * 70 * The model incorporates a reference counting, so that multiple users 71 * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and 72 * only the first user will effectively start the URBs, and only the last 73 * one to stop it will tear the URBs down again. 74 */ 75 76 /* 77 * convert a sampling rate into our full speed format (fs/1000 in Q16.16) 78 * this will overflow at approx 524 kHz 79 */ 80 static inline unsigned get_usb_full_speed_rate(unsigned int rate) 81 { 82 return ((rate << 13) + 62) / 125; 83 } 84 85 /* 86 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16) 87 * this will overflow at approx 4 MHz 88 */ 89 static inline unsigned get_usb_high_speed_rate(unsigned int rate) 90 { 91 return ((rate << 10) + 62) / 125; 92 } 93 94 /* 95 * release a urb data 96 */ 97 static void release_urb_ctx(struct snd_urb_ctx *u) 98 { 99 if (u->urb && u->buffer_size) 100 usb_free_coherent(u->ep->chip->dev, u->buffer_size, 101 u->urb->transfer_buffer, 102 u->urb->transfer_dma); 103 usb_free_urb(u->urb); 104 u->urb = NULL; 105 u->buffer_size = 0; 106 } 107 108 static const char *usb_error_string(int err) 109 { 110 switch (err) { 111 case -ENODEV: 112 return "no device"; 113 case -ENOENT: 114 return "endpoint not enabled"; 115 case -EPIPE: 116 return "endpoint stalled"; 117 case -ENOSPC: 118 return "not enough bandwidth"; 119 case -ESHUTDOWN: 120 return "device disabled"; 121 case -EHOSTUNREACH: 122 return "device suspended"; 123 case -EINVAL: 124 case -EAGAIN: 125 case -EFBIG: 126 case -EMSGSIZE: 127 return "internal error"; 128 default: 129 return "unknown error"; 130 } 131 } 132 133 static inline bool ep_state_running(struct snd_usb_endpoint *ep) 134 { 135 return atomic_read(&ep->state) == EP_STATE_RUNNING; 136 } 137 138 static inline bool ep_state_update(struct snd_usb_endpoint *ep, int old, int new) 139 { 140 return atomic_try_cmpxchg(&ep->state, &old, new); 141 } 142 143 /** 144 * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type 145 * 146 * @ep: The snd_usb_endpoint 147 * 148 * Determine whether an endpoint is driven by an implicit feedback 149 * data endpoint source. 150 */ 151 int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep) 152 { 153 return ep->implicit_fb_sync && usb_pipeout(ep->pipe); 154 } 155 156 /* 157 * Return the number of samples to be sent in the next packet 158 * for streaming based on information derived from sync endpoints 159 * 160 * This won't be used for implicit feedback which takes the packet size 161 * returned from the sync source 162 */ 163 static int slave_next_packet_size(struct snd_usb_endpoint *ep, 164 unsigned int avail) 165 { 166 unsigned int phase; 167 int ret; 168 169 if (ep->fill_max) 170 return ep->maxframesize; 171 172 guard(spinlock_irqsave)(&ep->lock); 173 phase = (ep->phase & 0xffff) + (ep->freqm << ep->datainterval); 174 ret = min(phase >> 16, ep->maxframesize); 175 if (avail && ret >= avail) 176 ret = -EAGAIN; 177 else 178 ep->phase = phase; 179 return ret; 180 } 181 182 /* 183 * Return the number of samples to be sent in the next packet 184 * for adaptive and synchronous endpoints 185 */ 186 static int next_packet_size(struct snd_usb_endpoint *ep, unsigned int avail) 187 { 188 unsigned int sample_accum; 189 int ret; 190 191 if (ep->fill_max) 192 return ep->maxframesize; 193 194 sample_accum = ep->sample_accum + ep->sample_rem; 195 if (sample_accum >= ep->pps) { 196 sample_accum -= ep->pps; 197 ret = ep->packsize[1]; 198 } else { 199 ret = ep->packsize[0]; 200 } 201 if (avail && ret >= avail) 202 ret = -EAGAIN; 203 else 204 ep->sample_accum = sample_accum; 205 206 return ret; 207 } 208 209 /* 210 * snd_usb_endpoint_next_packet_size: Return the number of samples to be sent 211 * in the next packet 212 * 213 * If the size is equal or exceeds @avail, don't proceed but return -EAGAIN 214 * Exception: @avail = 0 for skipping the check. 215 */ 216 int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep, 217 struct snd_urb_ctx *ctx, int idx, 218 unsigned int avail) 219 { 220 unsigned int packet; 221 222 packet = ctx->packet_size[idx]; 223 if (packet) { 224 if (avail && packet >= avail) 225 return -EAGAIN; 226 return packet; 227 } 228 229 if (ep->sync_source) 230 return slave_next_packet_size(ep, avail); 231 else 232 return next_packet_size(ep, avail); 233 } 234 235 static void call_retire_callback(struct snd_usb_endpoint *ep, 236 struct urb *urb) 237 { 238 struct snd_usb_substream *data_subs; 239 240 data_subs = READ_ONCE(ep->data_subs); 241 if (data_subs && ep->retire_data_urb) 242 ep->retire_data_urb(data_subs, urb); 243 } 244 245 static void retire_outbound_urb(struct snd_usb_endpoint *ep, 246 struct snd_urb_ctx *urb_ctx) 247 { 248 call_retire_callback(ep, urb_ctx->urb); 249 } 250 251 static void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep, 252 struct snd_usb_endpoint *sender, 253 const struct urb *urb); 254 255 static void retire_inbound_urb(struct snd_usb_endpoint *ep, 256 struct snd_urb_ctx *urb_ctx) 257 { 258 struct urb *urb = urb_ctx->urb; 259 struct snd_usb_endpoint *sync_sink; 260 261 if (unlikely(ep->skip_packets > 0)) { 262 ep->skip_packets--; 263 return; 264 } 265 266 sync_sink = READ_ONCE(ep->sync_sink); 267 if (sync_sink) 268 snd_usb_handle_sync_urb(sync_sink, ep, urb); 269 270 call_retire_callback(ep, urb); 271 } 272 273 static inline bool has_tx_length_quirk(struct snd_usb_audio *chip) 274 { 275 return chip->quirk_flags & QUIRK_FLAG_TX_LENGTH; 276 } 277 278 static int prepare_silent_urb(struct snd_usb_endpoint *ep, 279 struct snd_urb_ctx *ctx) 280 { 281 struct urb *urb = ctx->urb; 282 unsigned int offs = 0; 283 unsigned int extra = 0; 284 __le32 packet_length; 285 int i; 286 287 /* For tx_length_quirk, put packet length at start of packet */ 288 if (has_tx_length_quirk(ep->chip)) 289 extra = sizeof(packet_length); 290 291 for (i = 0; i < ctx->packets; ++i) { 292 int length; 293 294 length = snd_usb_endpoint_next_packet_size(ep, ctx, i, 0); 295 if (length < 0) 296 return length; 297 length *= ep->stride; /* number of silent bytes */ 298 if (offs + length + extra > ctx->buffer_size) 299 break; 300 urb->iso_frame_desc[i].offset = offs; 301 urb->iso_frame_desc[i].length = length + extra; 302 if (extra) { 303 packet_length = cpu_to_le32(length); 304 memcpy(urb->transfer_buffer + offs, 305 &packet_length, sizeof(packet_length)); 306 offs += extra; 307 } 308 memset(urb->transfer_buffer + offs, 309 ep->silence_value, length); 310 offs += length; 311 } 312 313 if (!offs) 314 return -EPIPE; 315 316 urb->number_of_packets = i; 317 urb->transfer_buffer_length = offs; 318 ctx->queued = 0; 319 return 0; 320 } 321 322 /* 323 * Prepare a PLAYBACK urb for submission to the bus. 324 */ 325 static int prepare_outbound_urb(struct snd_usb_endpoint *ep, 326 struct snd_urb_ctx *ctx, 327 bool in_stream_lock) 328 { 329 struct urb *urb = ctx->urb; 330 unsigned char *cp = urb->transfer_buffer; 331 struct snd_usb_substream *data_subs; 332 333 urb->dev = ep->chip->dev; /* we need to set this at each time */ 334 335 switch (ep->type) { 336 case SND_USB_ENDPOINT_TYPE_DATA: 337 data_subs = READ_ONCE(ep->data_subs); 338 if (data_subs && ep->prepare_data_urb) 339 return ep->prepare_data_urb(data_subs, urb, in_stream_lock); 340 /* no data provider, so send silence */ 341 return prepare_silent_urb(ep, ctx); 342 343 case SND_USB_ENDPOINT_TYPE_SYNC: 344 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) { 345 /* 346 * fill the length and offset of each urb descriptor. 347 * the fixed 12.13 frequency is passed as 16.16 through the pipe. 348 */ 349 urb->iso_frame_desc[0].length = 4; 350 urb->iso_frame_desc[0].offset = 0; 351 cp[0] = ep->freqn; 352 cp[1] = ep->freqn >> 8; 353 cp[2] = ep->freqn >> 16; 354 cp[3] = ep->freqn >> 24; 355 } else { 356 /* 357 * fill the length and offset of each urb descriptor. 358 * the fixed 10.14 frequency is passed through the pipe. 359 */ 360 urb->iso_frame_desc[0].length = 3; 361 urb->iso_frame_desc[0].offset = 0; 362 cp[0] = ep->freqn >> 2; 363 cp[1] = ep->freqn >> 10; 364 cp[2] = ep->freqn >> 18; 365 } 366 367 break; 368 } 369 return 0; 370 } 371 372 /* 373 * Prepare a CAPTURE or SYNC urb for submission to the bus. 374 */ 375 static int prepare_inbound_urb(struct snd_usb_endpoint *ep, 376 struct snd_urb_ctx *urb_ctx) 377 { 378 int i, offs; 379 struct urb *urb = urb_ctx->urb; 380 381 urb->dev = ep->chip->dev; /* we need to set this at each time */ 382 383 switch (ep->type) { 384 case SND_USB_ENDPOINT_TYPE_DATA: 385 offs = 0; 386 for (i = 0; i < urb_ctx->packets; i++) { 387 urb->iso_frame_desc[i].offset = offs; 388 urb->iso_frame_desc[i].length = ep->curpacksize; 389 offs += ep->curpacksize; 390 } 391 392 urb->transfer_buffer_length = offs; 393 urb->number_of_packets = urb_ctx->packets; 394 break; 395 396 case SND_USB_ENDPOINT_TYPE_SYNC: 397 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize); 398 urb->iso_frame_desc[0].offset = 0; 399 break; 400 } 401 return 0; 402 } 403 404 /* notify an error as XRUN to the assigned PCM data substream */ 405 static bool notify_xrun(struct snd_usb_endpoint *ep) 406 { 407 struct snd_usb_substream *data_subs; 408 struct snd_pcm_substream *psubs; 409 410 data_subs = READ_ONCE(ep->data_subs); 411 if (!data_subs) 412 return false; 413 psubs = data_subs->pcm_substream; 414 if (psubs && psubs->runtime && 415 psubs->runtime->state == SNDRV_PCM_STATE_RUNNING) { 416 snd_pcm_stop_xrun(psubs); 417 return true; 418 } 419 return false; 420 } 421 422 static struct snd_usb_packet_info * 423 next_packet_fifo_enqueue(struct snd_usb_endpoint *ep) 424 { 425 struct snd_usb_packet_info *p; 426 427 p = ep->next_packet + (ep->next_packet_head + ep->next_packet_queued) % 428 ARRAY_SIZE(ep->next_packet); 429 ep->next_packet_queued++; 430 return p; 431 } 432 433 static struct snd_usb_packet_info * 434 next_packet_fifo_dequeue(struct snd_usb_endpoint *ep) 435 { 436 struct snd_usb_packet_info *p; 437 438 p = ep->next_packet + ep->next_packet_head; 439 ep->next_packet_head++; 440 ep->next_packet_head %= ARRAY_SIZE(ep->next_packet); 441 ep->next_packet_queued--; 442 return p; 443 } 444 445 static void push_back_to_ready_list(struct snd_usb_endpoint *ep, 446 struct snd_urb_ctx *ctx) 447 { 448 guard(spinlock_irqsave)(&ep->lock); 449 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs); 450 } 451 452 /* 453 * Send output urbs that have been prepared previously. URBs are dequeued 454 * from ep->ready_playback_urbs and in case there aren't any available 455 * or there are no packets that have been prepared, this function does 456 * nothing. 457 * 458 * The reason why the functionality of sending and preparing URBs is separated 459 * is that host controllers don't guarantee the order in which they return 460 * inbound and outbound packets to their submitters. 461 * 462 * This function is used both for implicit feedback endpoints and in low- 463 * latency playback mode. 464 */ 465 int snd_usb_queue_pending_output_urbs(struct snd_usb_endpoint *ep, 466 bool in_stream_lock) 467 { 468 bool implicit_fb = snd_usb_endpoint_implicit_feedback_sink(ep); 469 470 while (ep_state_running(ep)) { 471 struct snd_usb_packet_info *packet; 472 struct snd_urb_ctx *ctx = NULL; 473 int err; 474 475 scoped_guard(spinlock_irqsave, &ep->lock) { 476 if ((!implicit_fb || ep->next_packet_queued > 0) && 477 !list_empty(&ep->ready_playback_urbs)) { 478 /* take URB out of FIFO */ 479 ctx = list_first_entry(&ep->ready_playback_urbs, 480 struct snd_urb_ctx, ready_list); 481 list_del_init(&ctx->ready_list); 482 if (implicit_fb) 483 packet = next_packet_fifo_dequeue(ep); 484 } 485 } 486 487 if (ctx == NULL) 488 break; 489 490 /* copy over the length information */ 491 if (implicit_fb) { 492 ctx->packets = packet->packets; 493 memcpy(ctx->packet_size, packet->packet_size, 494 packet->packets * sizeof(packet->packet_size[0])); 495 } 496 497 /* call the data handler to fill in playback data */ 498 err = prepare_outbound_urb(ep, ctx, in_stream_lock); 499 /* can be stopped during prepare callback */ 500 if (unlikely(!ep_state_running(ep))) 501 break; 502 if (err < 0) { 503 /* push back to ready list again for -EAGAIN */ 504 if (err == -EAGAIN) { 505 push_back_to_ready_list(ep, ctx); 506 break; 507 } 508 509 if (!in_stream_lock) 510 notify_xrun(ep); 511 return -EPIPE; 512 } 513 514 if (!atomic_read(&ep->chip->shutdown)) 515 err = usb_submit_urb(ctx->urb, GFP_ATOMIC); 516 else 517 err = -ENODEV; 518 if (err < 0) { 519 if (!atomic_read(&ep->chip->shutdown)) { 520 usb_audio_err(ep->chip, 521 "Unable to submit urb #%d: %d at %s\n", 522 ctx->index, err, __func__); 523 if (!in_stream_lock) 524 notify_xrun(ep); 525 } 526 return -EPIPE; 527 } 528 529 set_bit(ctx->index, &ep->active_mask); 530 atomic_inc(&ep->submitted_urbs); 531 } 532 533 return 0; 534 } 535 536 /* 537 * complete callback for urbs 538 */ 539 static void snd_complete_urb(struct urb *urb) 540 { 541 struct snd_urb_ctx *ctx = urb->context; 542 struct snd_usb_endpoint *ep = ctx->ep; 543 int err; 544 545 if (unlikely(urb->status == -ENOENT || /* unlinked */ 546 urb->status == -ENODEV || /* device removed */ 547 urb->status == -ECONNRESET || /* unlinked */ 548 urb->status == -ESHUTDOWN)) /* device disabled */ 549 goto exit_clear; 550 /* device disconnected */ 551 if (unlikely(atomic_read(&ep->chip->shutdown))) 552 goto exit_clear; 553 554 if (unlikely(!ep_state_running(ep))) 555 goto exit_clear; 556 557 if (usb_pipeout(ep->pipe)) { 558 retire_outbound_urb(ep, ctx); 559 /* can be stopped during retire callback */ 560 if (unlikely(!ep_state_running(ep))) 561 goto exit_clear; 562 563 /* in low-latency and implicit-feedback modes, push back the 564 * URB to ready list at first, then process as much as possible 565 */ 566 if (ep->lowlatency_playback || 567 snd_usb_endpoint_implicit_feedback_sink(ep)) { 568 push_back_to_ready_list(ep, ctx); 569 clear_bit(ctx->index, &ep->active_mask); 570 snd_usb_queue_pending_output_urbs(ep, false); 571 /* decrement at last, and check xrun */ 572 if (atomic_dec_and_test(&ep->submitted_urbs) && 573 !snd_usb_endpoint_implicit_feedback_sink(ep)) 574 notify_xrun(ep); 575 return; 576 } 577 578 /* in non-lowlatency mode, no error handling for prepare */ 579 prepare_outbound_urb(ep, ctx, false); 580 /* can be stopped during prepare callback */ 581 if (unlikely(!ep_state_running(ep))) 582 goto exit_clear; 583 } else { 584 retire_inbound_urb(ep, ctx); 585 /* can be stopped during retire callback */ 586 if (unlikely(!ep_state_running(ep))) 587 goto exit_clear; 588 589 prepare_inbound_urb(ep, ctx); 590 } 591 592 if (!atomic_read(&ep->chip->shutdown)) 593 err = usb_submit_urb(urb, GFP_ATOMIC); 594 else 595 err = -ENODEV; 596 if (err == 0) 597 return; 598 599 if (!atomic_read(&ep->chip->shutdown)) { 600 if (notify_xrun(ep)) 601 usb_audio_err(ep->chip, 602 "cannot submit urb (err = %d)\n", err); 603 } 604 605 exit_clear: 606 clear_bit(ctx->index, &ep->active_mask); 607 atomic_dec(&ep->submitted_urbs); 608 } 609 610 /* 611 * Find or create a refcount object for the given interface 612 * 613 * The objects are released altogether in snd_usb_endpoint_free_all() 614 */ 615 static struct snd_usb_iface_ref * 616 iface_ref_find(struct snd_usb_audio *chip, int iface) 617 { 618 struct snd_usb_iface_ref *ip; 619 620 list_for_each_entry(ip, &chip->iface_ref_list, list) 621 if (ip->iface == iface) 622 return ip; 623 624 ip = kzalloc_obj(*ip); 625 if (!ip) 626 return NULL; 627 ip->iface = iface; 628 list_add_tail(&ip->list, &chip->iface_ref_list); 629 return ip; 630 } 631 632 /* Similarly, a refcount object for clock */ 633 static struct snd_usb_clock_ref * 634 clock_ref_find(struct snd_usb_audio *chip, int clock) 635 { 636 struct snd_usb_clock_ref *ref; 637 638 list_for_each_entry(ref, &chip->clock_ref_list, list) 639 if (ref->clock == clock) 640 return ref; 641 642 ref = kzalloc_obj(*ref); 643 if (!ref) 644 return NULL; 645 ref->clock = clock; 646 atomic_set(&ref->locked, 0); 647 list_add_tail(&ref->list, &chip->clock_ref_list); 648 return ref; 649 } 650 651 /* 652 * Get the existing endpoint object corresponding EP 653 * Returns NULL if not present. 654 */ 655 struct snd_usb_endpoint * 656 snd_usb_get_endpoint(struct snd_usb_audio *chip, int ep_num) 657 { 658 struct snd_usb_endpoint *ep; 659 660 list_for_each_entry(ep, &chip->ep_list, list) { 661 if (ep->ep_num == ep_num) 662 return ep; 663 } 664 665 return NULL; 666 } 667 668 #define ep_type_name(type) \ 669 (type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync") 670 671 /** 672 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip 673 * 674 * @chip: The chip 675 * @ep_num: The number of the endpoint to use 676 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC 677 * 678 * If the requested endpoint has not been added to the given chip before, 679 * a new instance is created. 680 * 681 * Returns zero on success or a negative error code. 682 * 683 * New endpoints will be added to chip->ep_list and freed by 684 * calling snd_usb_endpoint_free_all(). 685 * 686 * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that 687 * bNumEndpoints > 1 beforehand. 688 */ 689 int snd_usb_add_endpoint(struct snd_usb_audio *chip, int ep_num, int type) 690 { 691 struct snd_usb_endpoint *ep; 692 bool is_playback; 693 694 ep = snd_usb_get_endpoint(chip, ep_num); 695 if (ep) 696 return 0; 697 698 usb_audio_dbg(chip, "Creating new %s endpoint #%x\n", 699 ep_type_name(type), 700 ep_num); 701 ep = kzalloc_obj(*ep); 702 if (!ep) 703 return -ENOMEM; 704 705 ep->chip = chip; 706 spin_lock_init(&ep->lock); 707 ep->type = type; 708 ep->ep_num = ep_num; 709 INIT_LIST_HEAD(&ep->ready_playback_urbs); 710 atomic_set(&ep->submitted_urbs, 0); 711 712 is_playback = ((ep_num & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT); 713 ep_num &= USB_ENDPOINT_NUMBER_MASK; 714 if (is_playback) 715 ep->pipe = usb_sndisocpipe(chip->dev, ep_num); 716 else 717 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num); 718 719 list_add_tail(&ep->list, &chip->ep_list); 720 return 0; 721 } 722 723 /* Set up syncinterval and maxsyncsize for a sync EP */ 724 static void endpoint_set_syncinterval(struct snd_usb_audio *chip, 725 struct snd_usb_endpoint *ep) 726 { 727 struct usb_host_interface *alts; 728 struct usb_endpoint_descriptor *desc; 729 730 alts = snd_usb_get_host_interface(chip, ep->iface, ep->altsetting); 731 if (!alts) 732 return; 733 734 desc = get_endpoint(alts, ep->ep_idx); 735 if (desc->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE && 736 desc->bRefresh >= 1 && desc->bRefresh <= 9) 737 ep->syncinterval = desc->bRefresh; 738 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL) 739 ep->syncinterval = 1; 740 else if (desc->bInterval >= 1 && desc->bInterval <= 16) 741 ep->syncinterval = desc->bInterval - 1; 742 else 743 ep->syncinterval = 3; 744 745 ep->syncmaxsize = le16_to_cpu(desc->wMaxPacketSize); 746 } 747 748 static bool endpoint_compatible(struct snd_usb_endpoint *ep, 749 const struct audioformat *fp, 750 const struct snd_pcm_hw_params *params) 751 { 752 if (!ep->opened) 753 return false; 754 if (ep->cur_audiofmt != fp) 755 return false; 756 if (ep->cur_rate != params_rate(params) || 757 ep->cur_format != params_format(params) || 758 ep->cur_period_frames != params_period_size(params) || 759 ep->cur_buffer_periods != params_periods(params)) 760 return false; 761 return true; 762 } 763 764 /* 765 * Check whether the given fp and hw params are compatible with the current 766 * setup of the target EP for implicit feedback sync 767 */ 768 bool snd_usb_endpoint_compatible(struct snd_usb_audio *chip, 769 struct snd_usb_endpoint *ep, 770 const struct audioformat *fp, 771 const struct snd_pcm_hw_params *params) 772 { 773 guard(mutex)(&chip->mutex); 774 return endpoint_compatible(ep, fp, params); 775 } 776 777 /* 778 * snd_usb_endpoint_open: Open the endpoint 779 * 780 * Called from hw_params to assign the endpoint to the substream. 781 * It's reference-counted, and only the first opener is allowed to set up 782 * arbitrary parameters. The later opener must be compatible with the 783 * former opened parameters. 784 * The endpoint needs to be closed via snd_usb_endpoint_close() later. 785 * 786 * Note that this function doesn't configure the endpoint. The substream 787 * needs to set it up later via snd_usb_endpoint_set_params() and 788 * snd_usb_endpoint_prepare(). 789 */ 790 struct snd_usb_endpoint * 791 snd_usb_endpoint_open(struct snd_usb_audio *chip, 792 const struct audioformat *fp, 793 const struct snd_pcm_hw_params *params, 794 bool is_sync_ep, 795 bool fixed_rate) 796 { 797 struct snd_usb_endpoint *ep; 798 int ep_num = is_sync_ep ? fp->sync_ep : fp->endpoint; 799 800 guard(mutex)(&chip->mutex); 801 ep = snd_usb_get_endpoint(chip, ep_num); 802 if (!ep) { 803 usb_audio_err(chip, "Cannot find EP 0x%x to open\n", ep_num); 804 return NULL; 805 } 806 807 if (!ep->opened) { 808 if (is_sync_ep) { 809 ep->iface = fp->sync_iface; 810 ep->altsetting = fp->sync_altsetting; 811 ep->ep_idx = fp->sync_ep_idx; 812 } else { 813 ep->iface = fp->iface; 814 ep->altsetting = fp->altsetting; 815 ep->ep_idx = fp->ep_idx; 816 } 817 usb_audio_dbg(chip, "Open EP 0x%x, iface=%d:%d, idx=%d\n", 818 ep_num, ep->iface, ep->altsetting, ep->ep_idx); 819 820 ep->iface_ref = iface_ref_find(chip, ep->iface); 821 if (!ep->iface_ref) 822 return NULL; 823 824 if (fp->protocol != UAC_VERSION_1) { 825 ep->clock_ref = clock_ref_find(chip, fp->clock); 826 if (!ep->clock_ref) 827 return NULL; 828 ep->clock_ref->opened++; 829 } 830 831 ep->cur_audiofmt = fp; 832 ep->cur_channels = fp->channels; 833 ep->cur_rate = params_rate(params); 834 ep->cur_format = params_format(params); 835 ep->cur_frame_bytes = snd_pcm_format_physical_width(ep->cur_format) * 836 ep->cur_channels / 8; 837 ep->cur_period_frames = params_period_size(params); 838 ep->cur_period_bytes = ep->cur_period_frames * ep->cur_frame_bytes; 839 ep->cur_buffer_periods = params_periods(params); 840 841 if (ep->type == SND_USB_ENDPOINT_TYPE_SYNC) 842 endpoint_set_syncinterval(chip, ep); 843 844 ep->implicit_fb_sync = fp->implicit_fb; 845 ep->need_setup = true; 846 ep->need_prepare = true; 847 ep->fixed_rate = fixed_rate; 848 849 usb_audio_dbg(chip, " channels=%d, rate=%d, format=%s, period_bytes=%d, periods=%d, implicit_fb=%d\n", 850 ep->cur_channels, ep->cur_rate, 851 snd_pcm_format_name(ep->cur_format), 852 ep->cur_period_bytes, ep->cur_buffer_periods, 853 ep->implicit_fb_sync); 854 855 } else { 856 if (WARN_ON(!ep->iface_ref)) 857 return NULL; 858 859 if (!endpoint_compatible(ep, fp, params)) { 860 usb_audio_err(chip, "Incompatible EP setup for 0x%x\n", 861 ep_num); 862 return NULL; 863 } 864 865 usb_audio_dbg(chip, "Reopened EP 0x%x (count %d)\n", 866 ep_num, ep->opened); 867 } 868 869 if (!ep->iface_ref->opened++) 870 ep->iface_ref->need_setup = true; 871 872 ep->opened++; 873 return ep; 874 } 875 876 /* 877 * snd_usb_endpoint_set_sync: Link data and sync endpoints 878 * 879 * Pass NULL to sync_ep to unlink again 880 */ 881 void snd_usb_endpoint_set_sync(struct snd_usb_audio *chip, 882 struct snd_usb_endpoint *data_ep, 883 struct snd_usb_endpoint *sync_ep) 884 { 885 data_ep->sync_source = sync_ep; 886 } 887 888 /* 889 * Set data endpoint callbacks and the assigned data stream 890 * 891 * Called at PCM trigger and cleanups. 892 * Pass NULL to deactivate each callback. 893 */ 894 void snd_usb_endpoint_set_callback(struct snd_usb_endpoint *ep, 895 int (*prepare)(struct snd_usb_substream *subs, 896 struct urb *urb, 897 bool in_stream_lock), 898 void (*retire)(struct snd_usb_substream *subs, 899 struct urb *urb), 900 struct snd_usb_substream *data_subs) 901 { 902 ep->prepare_data_urb = prepare; 903 ep->retire_data_urb = retire; 904 if (data_subs) 905 ep->lowlatency_playback = data_subs->lowlatency_playback; 906 else 907 ep->lowlatency_playback = false; 908 WRITE_ONCE(ep->data_subs, data_subs); 909 } 910 911 static int endpoint_set_interface(struct snd_usb_audio *chip, 912 struct snd_usb_endpoint *ep, 913 bool set) 914 { 915 int altset = set ? ep->altsetting : 0; 916 int err; 917 int retries = 0; 918 const int max_retries = 5; 919 920 if (ep->iface_ref->altset == altset) 921 return 0; 922 /* already disconnected? */ 923 if (unlikely(atomic_read(&chip->shutdown))) 924 return -ENODEV; 925 926 usb_audio_dbg(chip, "Setting usb interface %d:%d for EP 0x%x\n", 927 ep->iface, altset, ep->ep_num); 928 retry: 929 err = usb_set_interface(chip->dev, ep->iface, altset); 930 if (err < 0) { 931 if (err == -EPROTO && ++retries <= max_retries) { 932 msleep(5 * (1 << (retries - 1))); 933 goto retry; 934 } 935 usb_audio_err_ratelimited( 936 chip, "%d:%d: usb_set_interface failed (%d)\n", 937 ep->iface, altset, err); 938 return err; 939 } 940 941 if (chip->quirk_flags & QUIRK_FLAG_IFACE_DELAY) 942 msleep(50); 943 ep->iface_ref->altset = altset; 944 return 0; 945 } 946 947 /* 948 * snd_usb_endpoint_close: Close the endpoint 949 * 950 * Unreference the already opened endpoint via snd_usb_endpoint_open(). 951 */ 952 void snd_usb_endpoint_close(struct snd_usb_audio *chip, 953 struct snd_usb_endpoint *ep) 954 { 955 guard(mutex)(&chip->mutex); 956 usb_audio_dbg(chip, "Closing EP 0x%x (count %d)\n", 957 ep->ep_num, ep->opened); 958 959 if (!--ep->iface_ref->opened && 960 !(chip->quirk_flags & QUIRK_FLAG_IFACE_SKIP_CLOSE)) 961 endpoint_set_interface(chip, ep, false); 962 963 if (!--ep->opened) { 964 if (ep->clock_ref) { 965 if (!--ep->clock_ref->opened) 966 ep->clock_ref->rate = 0; 967 } 968 ep->iface = 0; 969 ep->altsetting = 0; 970 ep->cur_audiofmt = NULL; 971 ep->cur_rate = 0; 972 ep->iface_ref = NULL; 973 ep->clock_ref = NULL; 974 usb_audio_dbg(chip, "EP 0x%x closed\n", ep->ep_num); 975 } 976 } 977 978 /* Prepare for suspening EP, called from the main suspend handler */ 979 void snd_usb_endpoint_suspend(struct snd_usb_endpoint *ep) 980 { 981 ep->need_prepare = true; 982 if (ep->iface_ref) 983 ep->iface_ref->need_setup = true; 984 if (ep->clock_ref) 985 ep->clock_ref->rate = 0; 986 } 987 988 /* 989 * wait until all urbs are processed. 990 */ 991 static int wait_clear_urbs(struct snd_usb_endpoint *ep) 992 { 993 unsigned long end_time = jiffies + msecs_to_jiffies(1000); 994 int alive; 995 996 if (atomic_read(&ep->state) != EP_STATE_STOPPING) 997 return 0; 998 999 do { 1000 alive = atomic_read(&ep->submitted_urbs); 1001 if (!alive) 1002 break; 1003 1004 schedule_timeout_uninterruptible(1); 1005 } while (time_before(jiffies, end_time)); 1006 1007 if (alive) 1008 usb_audio_err(ep->chip, 1009 "timeout: still %d active urbs on EP #%x\n", 1010 alive, ep->ep_num); 1011 1012 if (ep_state_update(ep, EP_STATE_STOPPING, EP_STATE_STOPPED)) { 1013 ep->sync_sink = NULL; 1014 snd_usb_endpoint_set_callback(ep, NULL, NULL, NULL); 1015 } 1016 1017 return 0; 1018 } 1019 1020 /* sync the pending stop operation; 1021 * this function itself doesn't trigger the stop operation 1022 */ 1023 void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep) 1024 { 1025 if (ep) 1026 wait_clear_urbs(ep); 1027 } 1028 1029 /* 1030 * Stop active urbs 1031 * 1032 * This function moves the EP to STOPPING state if it's being RUNNING. 1033 */ 1034 static int stop_urbs(struct snd_usb_endpoint *ep, bool force, bool keep_pending) 1035 { 1036 unsigned int i; 1037 1038 if (!force && atomic_read(&ep->running)) 1039 return -EBUSY; 1040 1041 if (!ep_state_update(ep, EP_STATE_RUNNING, EP_STATE_STOPPING)) 1042 return 0; 1043 1044 scoped_guard(spinlock_irqsave, &ep->lock) { 1045 INIT_LIST_HEAD(&ep->ready_playback_urbs); 1046 ep->next_packet_head = 0; 1047 ep->next_packet_queued = 0; 1048 } 1049 1050 if (keep_pending) 1051 return 0; 1052 1053 for (i = 0; i < ep->nurbs; i++) { 1054 if (test_bit(i, &ep->active_mask)) { 1055 if (!test_and_set_bit(i, &ep->unlink_mask)) { 1056 struct urb *u = ep->urb[i].urb; 1057 usb_unlink_urb(u); 1058 } 1059 } 1060 } 1061 1062 return 0; 1063 } 1064 1065 /* 1066 * release an endpoint's urbs 1067 */ 1068 static int release_urbs(struct snd_usb_endpoint *ep, bool force) 1069 { 1070 int i, err; 1071 1072 /* route incoming urbs to nirvana */ 1073 snd_usb_endpoint_set_callback(ep, NULL, NULL, NULL); 1074 1075 /* stop and unlink urbs */ 1076 err = stop_urbs(ep, force, false); 1077 if (err) 1078 return err; 1079 1080 wait_clear_urbs(ep); 1081 1082 for (i = 0; i < ep->nurbs; i++) 1083 release_urb_ctx(&ep->urb[i]); 1084 1085 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4, 1086 ep->syncbuf, ep->sync_dma); 1087 1088 ep->syncbuf = NULL; 1089 ep->nurbs = 0; 1090 return 0; 1091 } 1092 1093 /* 1094 * configure a data endpoint 1095 */ 1096 static int data_ep_set_params(struct snd_usb_endpoint *ep) 1097 { 1098 struct snd_usb_audio *chip = ep->chip; 1099 unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb; 1100 unsigned int max_packs_per_period, urbs_per_period, urb_packs; 1101 unsigned int max_urbs, i; 1102 const struct audioformat *fmt = ep->cur_audiofmt; 1103 int frame_bits = ep->cur_frame_bytes * 8; 1104 int tx_length_quirk = (has_tx_length_quirk(chip) && 1105 usb_pipeout(ep->pipe)); 1106 1107 usb_audio_dbg(chip, "Setting params for data EP 0x%x, pipe 0x%x\n", 1108 ep->ep_num, ep->pipe); 1109 1110 if (ep->cur_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) { 1111 /* 1112 * When operating in DSD DOP mode, the size of a sample frame 1113 * in hardware differs from the actual physical format width 1114 * because we need to make room for the DOP markers. 1115 */ 1116 frame_bits += ep->cur_channels << 3; 1117 } 1118 1119 ep->datainterval = fmt->datainterval; 1120 ep->stride = frame_bits >> 3; 1121 1122 switch (ep->cur_format) { 1123 case SNDRV_PCM_FORMAT_U8: 1124 ep->silence_value = 0x80; 1125 break; 1126 case SNDRV_PCM_FORMAT_DSD_U8: 1127 case SNDRV_PCM_FORMAT_DSD_U16_LE: 1128 case SNDRV_PCM_FORMAT_DSD_U32_LE: 1129 case SNDRV_PCM_FORMAT_DSD_U16_BE: 1130 case SNDRV_PCM_FORMAT_DSD_U32_BE: 1131 ep->silence_value = 0x69; 1132 break; 1133 default: 1134 ep->silence_value = 0; 1135 } 1136 1137 /* assume max. frequency is 50% higher than nominal */ 1138 ep->freqmax = ep->freqn + (ep->freqn >> 1); 1139 /* Round up freqmax to nearest integer in order to calculate maximum 1140 * packet size, which must represent a whole number of frames. 1141 * This is accomplished by adding 0x0.ffff before converting the 1142 * Q16.16 format into integer. 1143 * In order to accurately calculate the maximum packet size when 1144 * the data interval is more than 1 (i.e. ep->datainterval > 0), 1145 * multiply by the data interval prior to rounding. For instance, 1146 * a freqmax of 41 kHz will result in a max packet size of 6 (5.125) 1147 * frames with a data interval of 1, but 11 (10.25) frames with a 1148 * data interval of 2. 1149 * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the 1150 * maximum datainterval value of 3, at USB full speed, higher for 1151 * USB high speed, noting that ep->freqmax is in units of 1152 * frames per packet in Q16.16 format.) 1153 */ 1154 maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) * 1155 (frame_bits >> 3); 1156 if (tx_length_quirk) 1157 maxsize += sizeof(__le32); /* Space for length descriptor */ 1158 /* but wMaxPacketSize might reduce this */ 1159 if (ep->maxpacksize && ep->maxpacksize < maxsize) { 1160 /* whatever fits into a max. size packet */ 1161 unsigned int data_maxsize = maxsize = ep->maxpacksize; 1162 1163 if (tx_length_quirk) 1164 /* Need to remove the length descriptor to calc freq */ 1165 data_maxsize -= sizeof(__le32); 1166 ep->freqmax = (data_maxsize / (frame_bits >> 3)) 1167 << (16 - ep->datainterval); 1168 } 1169 1170 if (ep->fill_max) 1171 ep->curpacksize = ep->maxpacksize; 1172 else 1173 ep->curpacksize = maxsize; 1174 1175 if (snd_usb_get_speed(chip->dev) != USB_SPEED_FULL) { 1176 packs_per_ms = 8 >> ep->datainterval; 1177 max_packs_per_urb = MAX_PACKS_HS; 1178 } else { 1179 packs_per_ms = 1; 1180 max_packs_per_urb = MAX_PACKS; 1181 } 1182 if (ep->sync_source && !ep->implicit_fb_sync) 1183 max_packs_per_urb = min(max_packs_per_urb, 1184 1U << ep->sync_source->syncinterval); 1185 max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval); 1186 1187 /* 1188 * Capture endpoints need to use small URBs because there's no way 1189 * to tell in advance where the next period will end, and we don't 1190 * want the next URB to complete much after the period ends. 1191 * 1192 * Playback endpoints with implicit sync much use the same parameters 1193 * as their corresponding capture endpoint. 1194 */ 1195 if (usb_pipein(ep->pipe) || ep->implicit_fb_sync) { 1196 1197 /* make capture URBs <= 1 ms and smaller than a period */ 1198 urb_packs = min(max_packs_per_urb, packs_per_ms); 1199 while (urb_packs > 1 && urb_packs * maxsize >= ep->cur_period_bytes) 1200 urb_packs >>= 1; 1201 ep->nurbs = MAX_URBS; 1202 1203 /* 1204 * Playback endpoints without implicit sync are adjusted so that 1205 * a period fits as evenly as possible in the smallest number of 1206 * URBs. The total number of URBs is adjusted to the size of the 1207 * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits. 1208 */ 1209 } else { 1210 /* determine how small a packet can be */ 1211 minsize = (ep->freqn >> (16 - ep->datainterval)) * 1212 (frame_bits >> 3); 1213 /* with sync from device, assume it can be 12% lower */ 1214 if (ep->sync_source) 1215 minsize -= minsize >> 3; 1216 minsize = max(minsize, 1u); 1217 1218 /* how many packets will contain an entire ALSA period? */ 1219 max_packs_per_period = DIV_ROUND_UP(ep->cur_period_bytes, minsize); 1220 1221 /* how many URBs will contain a period? */ 1222 urbs_per_period = DIV_ROUND_UP(max_packs_per_period, 1223 max_packs_per_urb); 1224 /* how many packets are needed in each URB? */ 1225 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period); 1226 1227 /* limit the number of frames in a single URB */ 1228 ep->max_urb_frames = DIV_ROUND_UP(ep->cur_period_frames, 1229 urbs_per_period); 1230 1231 /* try to use enough URBs to contain an entire ALSA buffer */ 1232 max_urbs = min((unsigned) MAX_URBS, 1233 MAX_QUEUE * packs_per_ms / urb_packs); 1234 ep->nurbs = min(max_urbs, urbs_per_period * ep->cur_buffer_periods); 1235 } 1236 1237 /* allocate and initialize data urbs */ 1238 for (i = 0; i < ep->nurbs; i++) { 1239 struct snd_urb_ctx *u = &ep->urb[i]; 1240 u->index = i; 1241 u->ep = ep; 1242 u->packets = urb_packs; 1243 u->buffer_size = maxsize * u->packets; 1244 1245 if (fmt->fmt_type == UAC_FORMAT_TYPE_II) 1246 u->packets++; /* for transfer delimiter */ 1247 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL); 1248 if (!u->urb) 1249 goto out_of_memory; 1250 1251 u->urb->transfer_buffer = 1252 usb_alloc_coherent(chip->dev, u->buffer_size, 1253 GFP_KERNEL, &u->urb->transfer_dma); 1254 if (!u->urb->transfer_buffer) 1255 goto out_of_memory; 1256 u->urb->pipe = ep->pipe; 1257 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP; 1258 u->urb->interval = 1 << ep->datainterval; 1259 u->urb->context = u; 1260 u->urb->complete = snd_complete_urb; 1261 INIT_LIST_HEAD(&u->ready_list); 1262 } 1263 1264 return 0; 1265 1266 out_of_memory: 1267 release_urbs(ep, false); 1268 return -ENOMEM; 1269 } 1270 1271 /* 1272 * configure a sync endpoint 1273 */ 1274 static int sync_ep_set_params(struct snd_usb_endpoint *ep) 1275 { 1276 struct snd_usb_audio *chip = ep->chip; 1277 int i; 1278 1279 usb_audio_dbg(chip, "Setting params for sync EP 0x%x, pipe 0x%x\n", 1280 ep->ep_num, ep->pipe); 1281 1282 ep->syncbuf = usb_alloc_coherent(chip->dev, SYNC_URBS * 4, 1283 GFP_KERNEL, &ep->sync_dma); 1284 if (!ep->syncbuf) 1285 return -ENOMEM; 1286 1287 ep->nurbs = SYNC_URBS; 1288 for (i = 0; i < SYNC_URBS; i++) { 1289 struct snd_urb_ctx *u = &ep->urb[i]; 1290 u->index = i; 1291 u->ep = ep; 1292 u->packets = 1; 1293 u->urb = usb_alloc_urb(1, GFP_KERNEL); 1294 if (!u->urb) 1295 goto out_of_memory; 1296 u->urb->transfer_buffer = ep->syncbuf + i * 4; 1297 u->urb->transfer_dma = ep->sync_dma + i * 4; 1298 u->urb->transfer_buffer_length = 4; 1299 u->urb->pipe = ep->pipe; 1300 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP; 1301 u->urb->number_of_packets = 1; 1302 u->urb->interval = 1 << ep->syncinterval; 1303 u->urb->context = u; 1304 u->urb->complete = snd_complete_urb; 1305 } 1306 1307 return 0; 1308 1309 out_of_memory: 1310 release_urbs(ep, false); 1311 return -ENOMEM; 1312 } 1313 1314 /* update the rate of the referred clock; return the actual rate */ 1315 static int update_clock_ref_rate(struct snd_usb_audio *chip, 1316 struct snd_usb_endpoint *ep) 1317 { 1318 struct snd_usb_clock_ref *clock = ep->clock_ref; 1319 int rate = ep->cur_rate; 1320 1321 if (!clock || clock->rate == rate) 1322 return rate; 1323 if (clock->rate) { 1324 if (atomic_read(&clock->locked)) 1325 return clock->rate; 1326 if (clock->rate != rate) { 1327 usb_audio_err(chip, "Mismatched sample rate %d vs %d for EP 0x%x\n", 1328 clock->rate, rate, ep->ep_num); 1329 return clock->rate; 1330 } 1331 } 1332 clock->rate = rate; 1333 clock->need_setup = true; 1334 return rate; 1335 } 1336 1337 /* 1338 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint 1339 * 1340 * It's called either from hw_params callback. 1341 * Determine the number of URBs to be used on this endpoint. 1342 * An endpoint must be configured before it can be started. 1343 * An endpoint that is already running can not be reconfigured. 1344 */ 1345 int snd_usb_endpoint_set_params(struct snd_usb_audio *chip, 1346 struct snd_usb_endpoint *ep) 1347 { 1348 const struct audioformat *fmt = ep->cur_audiofmt; 1349 int err; 1350 1351 guard(mutex)(&chip->mutex); 1352 if (!ep->need_setup) 1353 return 0; 1354 1355 /* release old buffers, if any */ 1356 err = release_urbs(ep, false); 1357 if (err < 0) 1358 return err; 1359 1360 ep->datainterval = fmt->datainterval; 1361 ep->maxpacksize = fmt->maxpacksize; 1362 ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX); 1363 1364 if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL) { 1365 ep->freqn = get_usb_full_speed_rate(ep->cur_rate); 1366 ep->pps = 1000 >> ep->datainterval; 1367 } else { 1368 ep->freqn = get_usb_high_speed_rate(ep->cur_rate); 1369 ep->pps = 8000 >> ep->datainterval; 1370 } 1371 1372 ep->sample_rem = ep->cur_rate % ep->pps; 1373 ep->packsize[0] = ep->cur_rate / ep->pps; 1374 ep->packsize[1] = (ep->cur_rate + (ep->pps - 1)) / ep->pps; 1375 if (ep->packsize[1] > ep->maxpacksize) { 1376 usb_audio_dbg(chip, "Too small maxpacksize %u for rate %u / pps %u\n", 1377 ep->maxpacksize, ep->cur_rate, ep->pps); 1378 return -EINVAL; 1379 } 1380 1381 /* calculate the frequency in 16.16 format */ 1382 ep->freqm = ep->freqn; 1383 ep->freqshift = INT_MIN; 1384 1385 ep->phase = 0; 1386 1387 switch (ep->type) { 1388 case SND_USB_ENDPOINT_TYPE_DATA: 1389 err = data_ep_set_params(ep); 1390 break; 1391 case SND_USB_ENDPOINT_TYPE_SYNC: 1392 err = sync_ep_set_params(ep); 1393 break; 1394 default: 1395 err = -EINVAL; 1396 } 1397 1398 usb_audio_dbg(chip, "Set up %d URBS, ret=%d\n", ep->nurbs, err); 1399 1400 if (err < 0) 1401 return err; 1402 1403 /* some unit conversions in runtime */ 1404 ep->maxframesize = ep->maxpacksize / ep->cur_frame_bytes; 1405 ep->curframesize = ep->curpacksize / ep->cur_frame_bytes; 1406 1407 err = update_clock_ref_rate(chip, ep); 1408 if (err >= 0) { 1409 ep->need_setup = false; 1410 err = 0; 1411 } 1412 1413 return err; 1414 } 1415 1416 static int init_sample_rate(struct snd_usb_audio *chip, 1417 struct snd_usb_endpoint *ep) 1418 { 1419 struct snd_usb_clock_ref *clock = ep->clock_ref; 1420 int rate, err; 1421 1422 rate = update_clock_ref_rate(chip, ep); 1423 if (rate < 0) 1424 return rate; 1425 if (clock && !clock->need_setup) 1426 return 0; 1427 1428 if (!ep->fixed_rate) { 1429 err = snd_usb_init_sample_rate(chip, ep->cur_audiofmt, rate); 1430 if (err < 0) { 1431 if (clock) 1432 clock->rate = 0; /* reset rate */ 1433 return err; 1434 } 1435 } 1436 1437 if (clock) 1438 clock->need_setup = false; 1439 return 0; 1440 } 1441 1442 /* 1443 * snd_usb_endpoint_prepare: Prepare the endpoint 1444 * 1445 * This function sets up the EP to be fully usable state. 1446 * It's called either from prepare callback. 1447 * The function checks need_setup flag, and performs nothing unless needed, 1448 * so it's safe to call this multiple times. 1449 * 1450 * This returns zero if unchanged, 1 if the configuration has changed, 1451 * or a negative error code. 1452 */ 1453 int snd_usb_endpoint_prepare(struct snd_usb_audio *chip, 1454 struct snd_usb_endpoint *ep) 1455 { 1456 bool iface_first; 1457 int err = 0; 1458 1459 guard(mutex)(&chip->mutex); 1460 if (WARN_ON(!ep->iface_ref)) 1461 return 0; 1462 if (!ep->need_prepare) 1463 return 0; 1464 1465 /* If the interface has been already set up, just set EP parameters */ 1466 if (!ep->iface_ref->need_setup) { 1467 /* sample rate setup of UAC1 is per endpoint, and we need 1468 * to update at each EP configuration 1469 */ 1470 if (ep->cur_audiofmt->protocol == UAC_VERSION_1) { 1471 err = init_sample_rate(chip, ep); 1472 if (err < 0) 1473 return err; 1474 } 1475 goto done; 1476 } 1477 1478 /* Need to deselect altsetting at first */ 1479 endpoint_set_interface(chip, ep, false); 1480 1481 /* Some UAC1 devices (e.g. Yamaha THR10) need the host interface 1482 * to be set up before parameter setups 1483 */ 1484 iface_first = ep->cur_audiofmt->protocol == UAC_VERSION_1; 1485 /* Workaround for devices that require the interface setup at first like UAC1 */ 1486 if (chip->quirk_flags & QUIRK_FLAG_SET_IFACE_FIRST) 1487 iface_first = true; 1488 if (iface_first) { 1489 err = endpoint_set_interface(chip, ep, true); 1490 if (err < 0) 1491 return err; 1492 } 1493 1494 err = snd_usb_select_mode_quirk(chip, ep->cur_audiofmt); 1495 if (err < 0) 1496 return err; 1497 1498 err = snd_usb_init_pitch(chip, ep->cur_audiofmt); 1499 if (err < 0) 1500 return err; 1501 1502 err = init_sample_rate(chip, ep); 1503 if (err < 0) 1504 return err; 1505 1506 /* for UAC2/3, enable the interface altset here at last */ 1507 if (!iface_first) { 1508 err = endpoint_set_interface(chip, ep, true); 1509 if (err < 0) 1510 return err; 1511 } 1512 1513 ep->iface_ref->need_setup = false; 1514 1515 done: 1516 ep->need_prepare = false; 1517 return 1; 1518 } 1519 EXPORT_SYMBOL_GPL(snd_usb_endpoint_prepare); 1520 1521 /* get the current rate set to the given clock by any endpoint */ 1522 int snd_usb_endpoint_get_clock_rate(struct snd_usb_audio *chip, int clock) 1523 { 1524 struct snd_usb_clock_ref *ref; 1525 int rate = 0; 1526 1527 if (!clock) 1528 return 0; 1529 guard(mutex)(&chip->mutex); 1530 list_for_each_entry(ref, &chip->clock_ref_list, list) { 1531 if (ref->clock == clock) { 1532 rate = ref->rate; 1533 break; 1534 } 1535 } 1536 return rate; 1537 } 1538 1539 /** 1540 * snd_usb_endpoint_start: start an snd_usb_endpoint 1541 * 1542 * @ep: the endpoint to start 1543 * 1544 * A call to this function will increment the running count of the endpoint. 1545 * In case it is not already running, the URBs for this endpoint will be 1546 * submitted. Otherwise, this function does nothing. 1547 * 1548 * Must be balanced to calls of snd_usb_endpoint_stop(). 1549 * 1550 * Returns an error if the URB submission failed, 0 in all other cases. 1551 */ 1552 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep) 1553 { 1554 bool is_playback = usb_pipeout(ep->pipe); 1555 int err; 1556 unsigned int i; 1557 1558 if (atomic_read(&ep->chip->shutdown)) 1559 return -EBADFD; 1560 1561 if (ep->sync_source) 1562 WRITE_ONCE(ep->sync_source->sync_sink, ep); 1563 1564 usb_audio_dbg(ep->chip, "Starting %s EP 0x%x (running %d)\n", 1565 ep_type_name(ep->type), ep->ep_num, 1566 atomic_read(&ep->running)); 1567 1568 /* already running? */ 1569 if (atomic_inc_return(&ep->running) != 1) 1570 return 0; 1571 1572 if (ep->clock_ref) 1573 atomic_inc(&ep->clock_ref->locked); 1574 1575 ep->active_mask = 0; 1576 ep->unlink_mask = 0; 1577 ep->phase = 0; 1578 ep->sample_accum = 0; 1579 1580 snd_usb_endpoint_start_quirk(ep); 1581 1582 /* 1583 * If this endpoint has a data endpoint as implicit feedback source, 1584 * don't start the urbs here. Instead, mark them all as available, 1585 * wait for the record urbs to return and queue the playback urbs 1586 * from that context. 1587 */ 1588 1589 if (!ep_state_update(ep, EP_STATE_STOPPED, EP_STATE_RUNNING)) 1590 goto __error; 1591 1592 if (snd_usb_endpoint_implicit_feedback_sink(ep) && 1593 !(ep->chip->quirk_flags & QUIRK_FLAG_PLAYBACK_FIRST)) { 1594 usb_audio_dbg(ep->chip, "No URB submission due to implicit fb sync\n"); 1595 i = 0; 1596 goto fill_rest; 1597 } 1598 1599 for (i = 0; i < ep->nurbs; i++) { 1600 struct urb *urb = ep->urb[i].urb; 1601 1602 if (snd_BUG_ON(!urb)) 1603 goto __error; 1604 1605 if (is_playback) 1606 err = prepare_outbound_urb(ep, urb->context, true); 1607 else 1608 err = prepare_inbound_urb(ep, urb->context); 1609 if (err < 0) { 1610 /* stop filling at applptr */ 1611 if (err == -EAGAIN) 1612 break; 1613 usb_audio_dbg(ep->chip, 1614 "EP 0x%x: failed to prepare urb: %d\n", 1615 ep->ep_num, err); 1616 goto __error; 1617 } 1618 1619 if (!atomic_read(&ep->chip->shutdown)) 1620 err = usb_submit_urb(urb, GFP_ATOMIC); 1621 else 1622 err = -ENODEV; 1623 if (err < 0) { 1624 if (!atomic_read(&ep->chip->shutdown)) 1625 usb_audio_err(ep->chip, 1626 "cannot submit urb %d, error %d: %s\n", 1627 i, err, usb_error_string(err)); 1628 goto __error; 1629 } 1630 set_bit(i, &ep->active_mask); 1631 atomic_inc(&ep->submitted_urbs); 1632 } 1633 1634 if (!i) { 1635 usb_audio_dbg(ep->chip, "XRUN at starting EP 0x%x\n", 1636 ep->ep_num); 1637 goto __error; 1638 } 1639 1640 usb_audio_dbg(ep->chip, "%d URBs submitted for EP 0x%x\n", 1641 i, ep->ep_num); 1642 1643 fill_rest: 1644 /* put the remaining URBs to ready list */ 1645 if (is_playback) { 1646 for (; i < ep->nurbs; i++) 1647 push_back_to_ready_list(ep, ep->urb + i); 1648 } 1649 1650 return 0; 1651 1652 __error: 1653 snd_usb_endpoint_stop(ep, false); 1654 return -EPIPE; 1655 } 1656 1657 /** 1658 * snd_usb_endpoint_stop: stop an snd_usb_endpoint 1659 * 1660 * @ep: the endpoint to stop (may be NULL) 1661 * @keep_pending: keep in-flight URBs 1662 * 1663 * A call to this function will decrement the running count of the endpoint. 1664 * In case the last user has requested the endpoint stop, the URBs will 1665 * actually be deactivated. 1666 * 1667 * Must be balanced to calls of snd_usb_endpoint_start(). 1668 * 1669 * The caller needs to synchronize the pending stop operation via 1670 * snd_usb_endpoint_sync_pending_stop(). 1671 */ 1672 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep, bool keep_pending) 1673 { 1674 if (!ep) 1675 return; 1676 1677 usb_audio_dbg(ep->chip, "Stopping %s EP 0x%x (running %d)\n", 1678 ep_type_name(ep->type), ep->ep_num, 1679 atomic_read(&ep->running)); 1680 1681 if (snd_BUG_ON(!atomic_read(&ep->running))) 1682 return; 1683 1684 if (!atomic_dec_return(&ep->running)) { 1685 if (ep->sync_source) 1686 WRITE_ONCE(ep->sync_source->sync_sink, NULL); 1687 stop_urbs(ep, false, keep_pending); 1688 if (ep->clock_ref) 1689 atomic_dec(&ep->clock_ref->locked); 1690 1691 if (ep->chip->quirk_flags & QUIRK_FLAG_FORCE_IFACE_RESET && 1692 usb_pipeout(ep->pipe)) { 1693 ep->need_prepare = true; 1694 if (ep->iface_ref) 1695 ep->iface_ref->need_setup = true; 1696 } 1697 } 1698 } 1699 1700 /** 1701 * snd_usb_endpoint_release: Tear down an snd_usb_endpoint 1702 * 1703 * @ep: the endpoint to release 1704 * 1705 * This function does not care for the endpoint's running count but will tear 1706 * down all the streaming URBs immediately. 1707 */ 1708 void snd_usb_endpoint_release(struct snd_usb_endpoint *ep) 1709 { 1710 release_urbs(ep, true); 1711 } 1712 1713 /** 1714 * snd_usb_endpoint_free_all: Free the resources of an snd_usb_endpoint 1715 * @chip: The chip 1716 * 1717 * This free all endpoints and those resources 1718 */ 1719 void snd_usb_endpoint_free_all(struct snd_usb_audio *chip) 1720 { 1721 struct snd_usb_endpoint *ep, *en; 1722 struct snd_usb_iface_ref *ip, *in; 1723 struct snd_usb_clock_ref *cp, *cn; 1724 1725 list_for_each_entry_safe(ep, en, &chip->ep_list, list) 1726 kfree(ep); 1727 1728 list_for_each_entry_safe(ip, in, &chip->iface_ref_list, list) 1729 kfree(ip); 1730 1731 list_for_each_entry_safe(cp, cn, &chip->clock_ref_list, list) 1732 kfree(cp); 1733 } 1734 1735 /* 1736 * snd_usb_handle_sync_urb: parse an USB sync packet 1737 * 1738 * @ep: the endpoint to handle the packet 1739 * @sender: the sending endpoint 1740 * @urb: the received packet 1741 * 1742 * This function is called from the context of an endpoint that received 1743 * the packet and is used to let another endpoint object handle the payload. 1744 */ 1745 static void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep, 1746 struct snd_usb_endpoint *sender, 1747 const struct urb *urb) 1748 { 1749 int shift; 1750 unsigned int f; 1751 unsigned long flags; 1752 1753 snd_BUG_ON(ep == sender); 1754 1755 /* 1756 * In case the endpoint is operating in implicit feedback mode, prepare 1757 * a new outbound URB that has the same layout as the received packet 1758 * and add it to the list of pending urbs. queue_pending_output_urbs() 1759 * will take care of them later. 1760 */ 1761 if (snd_usb_endpoint_implicit_feedback_sink(ep) && 1762 atomic_read(&ep->running)) { 1763 1764 /* implicit feedback case */ 1765 int i, bytes = 0; 1766 struct snd_urb_ctx *in_ctx; 1767 struct snd_usb_packet_info *out_packet; 1768 1769 in_ctx = urb->context; 1770 1771 /* Count overall packet size */ 1772 for (i = 0; i < in_ctx->packets; i++) 1773 if (urb->iso_frame_desc[i].status == 0) 1774 bytes += urb->iso_frame_desc[i].actual_length; 1775 1776 /* 1777 * skip empty packets. At least M-Audio's Fast Track Ultra stops 1778 * streaming once it received a 0-byte OUT URB 1779 */ 1780 if (bytes == 0) 1781 return; 1782 1783 spin_lock_irqsave(&ep->lock, flags); 1784 if (ep->next_packet_queued >= ARRAY_SIZE(ep->next_packet)) { 1785 spin_unlock_irqrestore(&ep->lock, flags); 1786 if (notify_xrun(ep)) { 1787 usb_audio_err(ep->chip, 1788 "next packet FIFO overflow EP 0x%x\n", 1789 ep->ep_num); 1790 } 1791 return; 1792 } 1793 1794 out_packet = next_packet_fifo_enqueue(ep); 1795 1796 /* 1797 * Iterate through the inbound packet and prepare the lengths 1798 * for the output packet. The OUT packet we are about to send 1799 * will have the same amount of payload bytes per stride as the 1800 * IN packet we just received. Since the actual size is scaled 1801 * by the stride, use the sender stride to calculate the length 1802 * in case the number of channels differ between the implicitly 1803 * fed-back endpoint and the synchronizing endpoint. 1804 */ 1805 1806 out_packet->packets = in_ctx->packets; 1807 for (i = 0; i < in_ctx->packets; i++) { 1808 if (urb->iso_frame_desc[i].status == 0) 1809 out_packet->packet_size[i] = 1810 urb->iso_frame_desc[i].actual_length / sender->stride; 1811 else 1812 out_packet->packet_size[i] = 0; 1813 } 1814 1815 spin_unlock_irqrestore(&ep->lock, flags); 1816 snd_usb_queue_pending_output_urbs(ep, false); 1817 1818 return; 1819 } 1820 1821 /* 1822 * process after playback sync complete 1823 * 1824 * Full speed devices report feedback values in 10.14 format as samples 1825 * per frame, high speed devices in 16.16 format as samples per 1826 * microframe. 1827 * 1828 * Because the Audio Class 1 spec was written before USB 2.0, many high 1829 * speed devices use a wrong interpretation, some others use an 1830 * entirely different format. 1831 * 1832 * Therefore, we cannot predict what format any particular device uses 1833 * and must detect it automatically. 1834 */ 1835 1836 if (urb->iso_frame_desc[0].status != 0 || 1837 urb->iso_frame_desc[0].actual_length < 3) 1838 return; 1839 1840 f = le32_to_cpup(urb->transfer_buffer); 1841 if (urb->iso_frame_desc[0].actual_length == 3) 1842 f &= 0x00ffffff; 1843 else 1844 f &= 0x0fffffff; 1845 1846 if (f == 0) 1847 return; 1848 1849 if (unlikely(sender->tenor_fb_quirk)) { 1850 /* 1851 * Devices based on Tenor 8802 chipsets (TEAC UD-H01 1852 * and others) sometimes change the feedback value 1853 * by +/- 0x1.0000. 1854 */ 1855 if (f < ep->freqn - 0x8000) 1856 f += 0xf000; 1857 else if (f > ep->freqn + 0x8000) 1858 f -= 0xf000; 1859 } else if (unlikely(ep->freqshift == INT_MIN)) { 1860 /* 1861 * The first time we see a feedback value, determine its format 1862 * by shifting it left or right until it matches the nominal 1863 * frequency value. This assumes that the feedback does not 1864 * differ from the nominal value more than +50% or -25%. 1865 */ 1866 shift = 0; 1867 while (f < ep->freqn - ep->freqn / 4) { 1868 f <<= 1; 1869 shift++; 1870 } 1871 while (f > ep->freqn + ep->freqn / 2) { 1872 f >>= 1; 1873 shift--; 1874 } 1875 ep->freqshift = shift; 1876 } else if (ep->freqshift >= 0) 1877 f <<= ep->freqshift; 1878 else 1879 f >>= -ep->freqshift; 1880 1881 if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) { 1882 /* 1883 * If the frequency looks valid, set it. 1884 * This value is referred to in prepare_playback_urb(). 1885 */ 1886 guard(spinlock_irqsave)(&ep->lock); 1887 ep->freqm = f; 1888 } else { 1889 /* 1890 * Out of range; maybe the shift value is wrong. 1891 * Reset it so that we autodetect again the next time. 1892 */ 1893 ep->freqshift = INT_MIN; 1894 } 1895 } 1896 1897