1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 */ 4 5 #include <linux/init.h> 6 #include <linux/slab.h> 7 #include <linux/bitrev.h> 8 #include <linux/ratelimit.h> 9 #include <linux/usb.h> 10 #include <linux/usb/audio.h> 11 #include <linux/usb/audio-v2.h> 12 13 #include <sound/core.h> 14 #include <sound/pcm.h> 15 #include <sound/pcm_params.h> 16 17 #include "usbaudio.h" 18 #include "card.h" 19 #include "quirks.h" 20 #include "debug.h" 21 #include "endpoint.h" 22 #include "helper.h" 23 #include "pcm.h" 24 #include "clock.h" 25 #include "power.h" 26 #include "media.h" 27 28 #define SUBSTREAM_FLAG_DATA_EP_STARTED 0 29 #define SUBSTREAM_FLAG_SYNC_EP_STARTED 1 30 31 /* return the estimated delay based on USB frame counters */ 32 snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs, 33 unsigned int rate) 34 { 35 int current_frame_number; 36 int frame_diff; 37 int est_delay; 38 39 if (!subs->last_delay) 40 return 0; /* short path */ 41 42 current_frame_number = usb_get_current_frame_number(subs->dev); 43 /* 44 * HCD implementations use different widths, use lower 8 bits. 45 * The delay will be managed up to 256ms, which is more than 46 * enough 47 */ 48 frame_diff = (current_frame_number - subs->last_frame_number) & 0xff; 49 50 /* Approximation based on number of samples per USB frame (ms), 51 some truncation for 44.1 but the estimate is good enough */ 52 est_delay = frame_diff * rate / 1000; 53 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) 54 est_delay = subs->last_delay - est_delay; 55 else 56 est_delay = subs->last_delay + est_delay; 57 58 if (est_delay < 0) 59 est_delay = 0; 60 return est_delay; 61 } 62 63 /* 64 * return the current pcm pointer. just based on the hwptr_done value. 65 */ 66 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream) 67 { 68 struct snd_usb_substream *subs = substream->runtime->private_data; 69 unsigned int hwptr_done; 70 71 if (atomic_read(&subs->stream->chip->shutdown)) 72 return SNDRV_PCM_POS_XRUN; 73 spin_lock(&subs->lock); 74 hwptr_done = subs->hwptr_done; 75 substream->runtime->delay = snd_usb_pcm_delay(subs, 76 substream->runtime->rate); 77 spin_unlock(&subs->lock); 78 return hwptr_done / (substream->runtime->frame_bits >> 3); 79 } 80 81 /* 82 * find a matching audio format 83 */ 84 static struct audioformat *find_format(struct snd_usb_substream *subs) 85 { 86 struct audioformat *fp; 87 struct audioformat *found = NULL; 88 int cur_attr = 0, attr; 89 90 list_for_each_entry(fp, &subs->fmt_list, list) { 91 if (!(fp->formats & pcm_format_to_bits(subs->pcm_format))) 92 continue; 93 if (fp->channels != subs->channels) 94 continue; 95 if (subs->cur_rate < fp->rate_min || 96 subs->cur_rate > fp->rate_max) 97 continue; 98 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) { 99 unsigned int i; 100 for (i = 0; i < fp->nr_rates; i++) 101 if (fp->rate_table[i] == subs->cur_rate) 102 break; 103 if (i >= fp->nr_rates) 104 continue; 105 } 106 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE; 107 if (! found) { 108 found = fp; 109 cur_attr = attr; 110 continue; 111 } 112 /* avoid async out and adaptive in if the other method 113 * supports the same format. 114 * this is a workaround for the case like 115 * M-audio audiophile USB. 116 */ 117 if (attr != cur_attr) { 118 if ((attr == USB_ENDPOINT_SYNC_ASYNC && 119 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) || 120 (attr == USB_ENDPOINT_SYNC_ADAPTIVE && 121 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) 122 continue; 123 if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC && 124 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) || 125 (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE && 126 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) { 127 found = fp; 128 cur_attr = attr; 129 continue; 130 } 131 } 132 /* find the format with the largest max. packet size */ 133 if (fp->maxpacksize > found->maxpacksize) { 134 found = fp; 135 cur_attr = attr; 136 } 137 } 138 return found; 139 } 140 141 static int init_pitch_v1(struct snd_usb_audio *chip, int iface, 142 struct usb_host_interface *alts, 143 struct audioformat *fmt) 144 { 145 struct usb_device *dev = chip->dev; 146 unsigned int ep; 147 unsigned char data[1]; 148 int err; 149 150 if (get_iface_desc(alts)->bNumEndpoints < 1) 151 return -EINVAL; 152 ep = get_endpoint(alts, 0)->bEndpointAddress; 153 154 data[0] = 1; 155 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR, 156 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT, 157 UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep, 158 data, sizeof(data)); 159 if (err < 0) { 160 usb_audio_err(chip, "%d:%d: cannot set enable PITCH\n", 161 iface, ep); 162 return err; 163 } 164 165 return 0; 166 } 167 168 static int init_pitch_v2(struct snd_usb_audio *chip, int iface, 169 struct usb_host_interface *alts, 170 struct audioformat *fmt) 171 { 172 struct usb_device *dev = chip->dev; 173 unsigned char data[1]; 174 int err; 175 176 data[0] = 1; 177 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR, 178 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT, 179 UAC2_EP_CS_PITCH << 8, 0, 180 data, sizeof(data)); 181 if (err < 0) { 182 usb_audio_err(chip, "%d:%d: cannot set enable PITCH (v2)\n", 183 iface, fmt->altsetting); 184 return err; 185 } 186 187 return 0; 188 } 189 190 /* 191 * initialize the pitch control and sample rate 192 */ 193 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface, 194 struct usb_host_interface *alts, 195 struct audioformat *fmt) 196 { 197 /* if endpoint doesn't have pitch control, bail out */ 198 if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL)) 199 return 0; 200 201 switch (fmt->protocol) { 202 case UAC_VERSION_1: 203 default: 204 return init_pitch_v1(chip, iface, alts, fmt); 205 206 case UAC_VERSION_2: 207 return init_pitch_v2(chip, iface, alts, fmt); 208 } 209 } 210 211 static int start_endpoints(struct snd_usb_substream *subs) 212 { 213 int err; 214 215 if (!subs->data_endpoint) 216 return -EINVAL; 217 218 if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) { 219 struct snd_usb_endpoint *ep = subs->data_endpoint; 220 221 dev_dbg(&subs->dev->dev, "Starting data EP @%p\n", ep); 222 223 ep->data_subs = subs; 224 err = snd_usb_endpoint_start(ep); 225 if (err < 0) { 226 clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags); 227 return err; 228 } 229 } 230 231 if (subs->sync_endpoint && 232 !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) { 233 struct snd_usb_endpoint *ep = subs->sync_endpoint; 234 235 if (subs->data_endpoint->iface != subs->sync_endpoint->iface || 236 subs->data_endpoint->altsetting != subs->sync_endpoint->altsetting) { 237 err = usb_set_interface(subs->dev, 238 subs->sync_endpoint->iface, 239 subs->sync_endpoint->altsetting); 240 if (err < 0) { 241 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags); 242 dev_err(&subs->dev->dev, 243 "%d:%d: cannot set interface (%d)\n", 244 subs->sync_endpoint->iface, 245 subs->sync_endpoint->altsetting, err); 246 return -EIO; 247 } 248 } 249 250 dev_dbg(&subs->dev->dev, "Starting sync EP @%p\n", ep); 251 252 ep->sync_slave = subs->data_endpoint; 253 err = snd_usb_endpoint_start(ep); 254 if (err < 0) { 255 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags); 256 return err; 257 } 258 } 259 260 return 0; 261 } 262 263 static void stop_endpoints(struct snd_usb_substream *subs, bool wait) 264 { 265 if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) 266 snd_usb_endpoint_stop(subs->sync_endpoint); 267 268 if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) 269 snd_usb_endpoint_stop(subs->data_endpoint); 270 271 if (wait) { 272 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint); 273 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint); 274 } 275 } 276 277 static int search_roland_implicit_fb(struct usb_device *dev, int ifnum, 278 unsigned int altsetting, 279 struct usb_host_interface **alts, 280 unsigned int *ep) 281 { 282 struct usb_interface *iface; 283 struct usb_interface_descriptor *altsd; 284 struct usb_endpoint_descriptor *epd; 285 286 iface = usb_ifnum_to_if(dev, ifnum); 287 if (!iface || iface->num_altsetting < altsetting + 1) 288 return -ENOENT; 289 *alts = &iface->altsetting[altsetting]; 290 altsd = get_iface_desc(*alts); 291 if (altsd->bAlternateSetting != altsetting || 292 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC || 293 (altsd->bInterfaceSubClass != 2 && 294 altsd->bInterfaceProtocol != 2 ) || 295 altsd->bNumEndpoints < 1) 296 return -ENOENT; 297 epd = get_endpoint(*alts, 0); 298 if (!usb_endpoint_is_isoc_in(epd) || 299 (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) != 300 USB_ENDPOINT_USAGE_IMPLICIT_FB) 301 return -ENOENT; 302 *ep = epd->bEndpointAddress; 303 return 0; 304 } 305 306 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk 307 * applies. Returns 1 if a quirk was found. 308 */ 309 static int set_sync_ep_implicit_fb_quirk(struct snd_usb_substream *subs, 310 struct usb_device *dev, 311 struct usb_interface_descriptor *altsd, 312 unsigned int attr) 313 { 314 struct usb_host_interface *alts; 315 struct usb_interface *iface; 316 unsigned int ep; 317 unsigned int ifnum; 318 319 /* Implicit feedback sync EPs consumers are always playback EPs */ 320 if (subs->direction != SNDRV_PCM_STREAM_PLAYBACK) 321 return 0; 322 323 switch (subs->stream->chip->usb_id) { 324 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */ 325 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */ 326 ep = 0x81; 327 ifnum = 3; 328 goto add_sync_ep_from_ifnum; 329 case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */ 330 case USB_ID(0x0763, 0x2081): 331 ep = 0x81; 332 ifnum = 2; 333 goto add_sync_ep_from_ifnum; 334 case USB_ID(0x2466, 0x8003): /* Fractal Audio Axe-Fx II */ 335 ep = 0x86; 336 ifnum = 2; 337 goto add_sync_ep_from_ifnum; 338 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx III */ 339 ep = 0x81; 340 ifnum = 2; 341 goto add_sync_ep_from_ifnum; 342 case USB_ID(0x1397, 0x0001): /* Behringer UFX1604 */ 343 case USB_ID(0x1397, 0x0002): /* Behringer UFX1204 */ 344 ep = 0x81; 345 ifnum = 1; 346 goto add_sync_ep_from_ifnum; 347 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */ 348 ep = 0x84; 349 ifnum = 0; 350 goto add_sync_ep_from_ifnum; 351 case USB_ID(0x0582, 0x01d8): /* BOSS Katana */ 352 /* BOSS Katana amplifiers do not need quirks */ 353 return 0; 354 } 355 356 if (attr == USB_ENDPOINT_SYNC_ASYNC && 357 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC && 358 altsd->bInterfaceProtocol == 2 && 359 altsd->bNumEndpoints == 1 && 360 USB_ID_VENDOR(subs->stream->chip->usb_id) == 0x0582 /* Roland */ && 361 search_roland_implicit_fb(dev, altsd->bInterfaceNumber + 1, 362 altsd->bAlternateSetting, 363 &alts, &ep) >= 0) { 364 goto add_sync_ep; 365 } 366 367 /* No quirk */ 368 return 0; 369 370 add_sync_ep_from_ifnum: 371 iface = usb_ifnum_to_if(dev, ifnum); 372 373 if (!iface || iface->num_altsetting == 0) 374 return -EINVAL; 375 376 alts = &iface->altsetting[1]; 377 378 add_sync_ep: 379 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip, 380 alts, ep, !subs->direction, 381 SND_USB_ENDPOINT_TYPE_DATA); 382 if (!subs->sync_endpoint) 383 return -EINVAL; 384 385 subs->data_endpoint->sync_master = subs->sync_endpoint; 386 387 return 1; 388 } 389 390 static int set_sync_endpoint(struct snd_usb_substream *subs, 391 struct audioformat *fmt, 392 struct usb_device *dev, 393 struct usb_host_interface *alts, 394 struct usb_interface_descriptor *altsd) 395 { 396 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK; 397 unsigned int ep, attr; 398 bool implicit_fb; 399 int err; 400 401 /* we need a sync pipe in async OUT or adaptive IN mode */ 402 /* check the number of EP, since some devices have broken 403 * descriptors which fool us. if it has only one EP, 404 * assume it as adaptive-out or sync-in. 405 */ 406 attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE; 407 408 if ((is_playback && (attr != USB_ENDPOINT_SYNC_ASYNC)) || 409 (!is_playback && (attr != USB_ENDPOINT_SYNC_ADAPTIVE))) { 410 411 /* 412 * In these modes the notion of sync_endpoint is irrelevant. 413 * Reset pointers to avoid using stale data from previously 414 * used settings, e.g. when configuration and endpoints were 415 * changed 416 */ 417 418 subs->sync_endpoint = NULL; 419 subs->data_endpoint->sync_master = NULL; 420 } 421 422 err = set_sync_ep_implicit_fb_quirk(subs, dev, altsd, attr); 423 if (err < 0) 424 return err; 425 426 /* endpoint set by quirk */ 427 if (err > 0) 428 return 0; 429 430 if (altsd->bNumEndpoints < 2) 431 return 0; 432 433 if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC || 434 attr == USB_ENDPOINT_SYNC_ADAPTIVE)) || 435 (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE)) 436 return 0; 437 438 /* 439 * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see 440 * if we don't find a sync endpoint, as on M-Audio Transit. In case of 441 * error fall back to SYNC mode and don't create sync endpoint 442 */ 443 444 /* check sync-pipe endpoint */ 445 /* ... and check descriptor size before accessing bSynchAddress 446 because there is a version of the SB Audigy 2 NX firmware lacking 447 the audio fields in the endpoint descriptors */ 448 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC || 449 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE && 450 get_endpoint(alts, 1)->bSynchAddress != 0)) { 451 dev_err(&dev->dev, 452 "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n", 453 fmt->iface, fmt->altsetting, 454 get_endpoint(alts, 1)->bmAttributes, 455 get_endpoint(alts, 1)->bLength, 456 get_endpoint(alts, 1)->bSynchAddress); 457 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE) 458 return 0; 459 return -EINVAL; 460 } 461 ep = get_endpoint(alts, 1)->bEndpointAddress; 462 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE && 463 get_endpoint(alts, 0)->bSynchAddress != 0 && 464 ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) || 465 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) { 466 dev_err(&dev->dev, 467 "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n", 468 fmt->iface, fmt->altsetting, 469 is_playback, ep, get_endpoint(alts, 0)->bSynchAddress); 470 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE) 471 return 0; 472 return -EINVAL; 473 } 474 475 implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK) 476 == USB_ENDPOINT_USAGE_IMPLICIT_FB; 477 478 subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip, 479 alts, ep, !subs->direction, 480 implicit_fb ? 481 SND_USB_ENDPOINT_TYPE_DATA : 482 SND_USB_ENDPOINT_TYPE_SYNC); 483 if (!subs->sync_endpoint) { 484 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE) 485 return 0; 486 return -EINVAL; 487 } 488 489 subs->data_endpoint->sync_master = subs->sync_endpoint; 490 491 return 0; 492 } 493 494 /* 495 * find a matching format and set up the interface 496 */ 497 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt) 498 { 499 struct usb_device *dev = subs->dev; 500 struct usb_host_interface *alts; 501 struct usb_interface_descriptor *altsd; 502 struct usb_interface *iface; 503 int err; 504 505 iface = usb_ifnum_to_if(dev, fmt->iface); 506 if (WARN_ON(!iface)) 507 return -EINVAL; 508 alts = usb_altnum_to_altsetting(iface, fmt->altsetting); 509 altsd = get_iface_desc(alts); 510 if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting)) 511 return -EINVAL; 512 513 if (fmt == subs->cur_audiofmt) 514 return 0; 515 516 /* close the old interface */ 517 if (subs->interface >= 0 && subs->interface != fmt->iface) { 518 if (!subs->stream->chip->keep_iface) { 519 err = usb_set_interface(subs->dev, subs->interface, 0); 520 if (err < 0) { 521 dev_err(&dev->dev, 522 "%d:%d: return to setting 0 failed (%d)\n", 523 fmt->iface, fmt->altsetting, err); 524 return -EIO; 525 } 526 } 527 subs->interface = -1; 528 subs->altset_idx = 0; 529 } 530 531 /* set interface */ 532 if (iface->cur_altsetting != alts) { 533 err = snd_usb_select_mode_quirk(subs, fmt); 534 if (err < 0) 535 return -EIO; 536 537 err = usb_set_interface(dev, fmt->iface, fmt->altsetting); 538 if (err < 0) { 539 dev_err(&dev->dev, 540 "%d:%d: usb_set_interface failed (%d)\n", 541 fmt->iface, fmt->altsetting, err); 542 return -EIO; 543 } 544 dev_dbg(&dev->dev, "setting usb interface %d:%d\n", 545 fmt->iface, fmt->altsetting); 546 snd_usb_set_interface_quirk(dev); 547 } 548 549 subs->interface = fmt->iface; 550 subs->altset_idx = fmt->altset_idx; 551 subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip, 552 alts, fmt->endpoint, subs->direction, 553 SND_USB_ENDPOINT_TYPE_DATA); 554 555 if (!subs->data_endpoint) 556 return -EINVAL; 557 558 err = set_sync_endpoint(subs, fmt, dev, alts, altsd); 559 if (err < 0) 560 return err; 561 562 err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt); 563 if (err < 0) 564 return err; 565 566 subs->cur_audiofmt = fmt; 567 568 snd_usb_set_format_quirk(subs, fmt); 569 570 return 0; 571 } 572 573 /* 574 * Return the score of matching two audioformats. 575 * Veto the audioformat if: 576 * - It has no channels for some reason. 577 * - Requested PCM format is not supported. 578 * - Requested sample rate is not supported. 579 */ 580 static int match_endpoint_audioformats(struct snd_usb_substream *subs, 581 struct audioformat *fp, 582 struct audioformat *match, int rate, 583 snd_pcm_format_t pcm_format) 584 { 585 int i; 586 int score = 0; 587 588 if (fp->channels < 1) { 589 dev_dbg(&subs->dev->dev, 590 "%s: (fmt @%p) no channels\n", __func__, fp); 591 return 0; 592 } 593 594 if (!(fp->formats & pcm_format_to_bits(pcm_format))) { 595 dev_dbg(&subs->dev->dev, 596 "%s: (fmt @%p) no match for format %d\n", __func__, 597 fp, pcm_format); 598 return 0; 599 } 600 601 for (i = 0; i < fp->nr_rates; i++) { 602 if (fp->rate_table[i] == rate) { 603 score++; 604 break; 605 } 606 } 607 if (!score) { 608 dev_dbg(&subs->dev->dev, 609 "%s: (fmt @%p) no match for rate %d\n", __func__, 610 fp, rate); 611 return 0; 612 } 613 614 if (fp->channels == match->channels) 615 score++; 616 617 dev_dbg(&subs->dev->dev, 618 "%s: (fmt @%p) score %d\n", __func__, fp, score); 619 620 return score; 621 } 622 623 /* 624 * Configure the sync ep using the rate and pcm format of the data ep. 625 */ 626 static int configure_sync_endpoint(struct snd_usb_substream *subs) 627 { 628 int ret; 629 struct audioformat *fp; 630 struct audioformat *sync_fp = NULL; 631 int cur_score = 0; 632 int sync_period_bytes = subs->period_bytes; 633 struct snd_usb_substream *sync_subs = 634 &subs->stream->substream[subs->direction ^ 1]; 635 636 if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA || 637 !subs->stream) 638 return snd_usb_endpoint_set_params(subs->sync_endpoint, 639 subs->pcm_format, 640 subs->channels, 641 subs->period_bytes, 642 0, 0, 643 subs->cur_rate, 644 subs->cur_audiofmt, 645 NULL); 646 647 /* Try to find the best matching audioformat. */ 648 list_for_each_entry(fp, &sync_subs->fmt_list, list) { 649 int score = match_endpoint_audioformats(subs, 650 fp, subs->cur_audiofmt, 651 subs->cur_rate, subs->pcm_format); 652 653 if (score > cur_score) { 654 sync_fp = fp; 655 cur_score = score; 656 } 657 } 658 659 if (unlikely(sync_fp == NULL)) { 660 dev_err(&subs->dev->dev, 661 "%s: no valid audioformat for sync ep %x found\n", 662 __func__, sync_subs->ep_num); 663 return -EINVAL; 664 } 665 666 /* 667 * Recalculate the period bytes if channel number differ between 668 * data and sync ep audioformat. 669 */ 670 if (sync_fp->channels != subs->channels) { 671 sync_period_bytes = (subs->period_bytes / subs->channels) * 672 sync_fp->channels; 673 dev_dbg(&subs->dev->dev, 674 "%s: adjusted sync ep period bytes (%d -> %d)\n", 675 __func__, subs->period_bytes, sync_period_bytes); 676 } 677 678 ret = snd_usb_endpoint_set_params(subs->sync_endpoint, 679 subs->pcm_format, 680 sync_fp->channels, 681 sync_period_bytes, 682 0, 0, 683 subs->cur_rate, 684 sync_fp, 685 NULL); 686 687 return ret; 688 } 689 690 /* 691 * configure endpoint params 692 * 693 * called during initial setup and upon resume 694 */ 695 static int configure_endpoint(struct snd_usb_substream *subs) 696 { 697 int ret; 698 699 /* format changed */ 700 stop_endpoints(subs, true); 701 ret = snd_usb_endpoint_set_params(subs->data_endpoint, 702 subs->pcm_format, 703 subs->channels, 704 subs->period_bytes, 705 subs->period_frames, 706 subs->buffer_periods, 707 subs->cur_rate, 708 subs->cur_audiofmt, 709 subs->sync_endpoint); 710 if (ret < 0) 711 return ret; 712 713 if (subs->sync_endpoint) 714 ret = configure_sync_endpoint(subs); 715 716 return ret; 717 } 718 719 static int snd_usb_pcm_change_state(struct snd_usb_substream *subs, int state) 720 { 721 int ret; 722 723 if (!subs->str_pd) 724 return 0; 725 726 ret = snd_usb_power_domain_set(subs->stream->chip, subs->str_pd, state); 727 if (ret < 0) { 728 dev_err(&subs->dev->dev, 729 "Cannot change Power Domain ID: %d to state: %d. Err: %d\n", 730 subs->str_pd->pd_id, state, ret); 731 return ret; 732 } 733 734 return 0; 735 } 736 737 int snd_usb_pcm_suspend(struct snd_usb_stream *as) 738 { 739 int ret; 740 741 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D2); 742 if (ret < 0) 743 return ret; 744 745 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D2); 746 if (ret < 0) 747 return ret; 748 749 return 0; 750 } 751 752 int snd_usb_pcm_resume(struct snd_usb_stream *as) 753 { 754 int ret; 755 756 ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D1); 757 if (ret < 0) 758 return ret; 759 760 ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D1); 761 if (ret < 0) 762 return ret; 763 764 return 0; 765 } 766 767 /* 768 * hw_params callback 769 * 770 * allocate a buffer and set the given audio format. 771 * 772 * so far we use a physically linear buffer although packetize transfer 773 * doesn't need a continuous area. 774 * if sg buffer is supported on the later version of alsa, we'll follow 775 * that. 776 */ 777 static int snd_usb_hw_params(struct snd_pcm_substream *substream, 778 struct snd_pcm_hw_params *hw_params) 779 { 780 struct snd_usb_substream *subs = substream->runtime->private_data; 781 struct audioformat *fmt; 782 int ret; 783 784 ret = snd_media_start_pipeline(subs); 785 if (ret) 786 return ret; 787 788 subs->pcm_format = params_format(hw_params); 789 subs->period_bytes = params_period_bytes(hw_params); 790 subs->period_frames = params_period_size(hw_params); 791 subs->buffer_periods = params_periods(hw_params); 792 subs->channels = params_channels(hw_params); 793 subs->cur_rate = params_rate(hw_params); 794 795 fmt = find_format(subs); 796 if (!fmt) { 797 dev_dbg(&subs->dev->dev, 798 "cannot set format: format = %#x, rate = %d, channels = %d\n", 799 subs->pcm_format, subs->cur_rate, subs->channels); 800 ret = -EINVAL; 801 goto stop_pipeline; 802 } 803 804 ret = snd_usb_lock_shutdown(subs->stream->chip); 805 if (ret < 0) 806 goto stop_pipeline; 807 808 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0); 809 if (ret < 0) 810 goto unlock; 811 812 ret = set_format(subs, fmt); 813 if (ret < 0) 814 goto unlock; 815 816 subs->interface = fmt->iface; 817 subs->altset_idx = fmt->altset_idx; 818 subs->need_setup_ep = true; 819 820 unlock: 821 snd_usb_unlock_shutdown(subs->stream->chip); 822 if (ret < 0) 823 goto stop_pipeline; 824 return ret; 825 826 stop_pipeline: 827 snd_media_stop_pipeline(subs); 828 return ret; 829 } 830 831 /* 832 * hw_free callback 833 * 834 * reset the audio format and release the buffer 835 */ 836 static int snd_usb_hw_free(struct snd_pcm_substream *substream) 837 { 838 struct snd_usb_substream *subs = substream->runtime->private_data; 839 840 snd_media_stop_pipeline(subs); 841 subs->cur_audiofmt = NULL; 842 subs->cur_rate = 0; 843 subs->period_bytes = 0; 844 if (!snd_usb_lock_shutdown(subs->stream->chip)) { 845 stop_endpoints(subs, true); 846 snd_usb_endpoint_deactivate(subs->sync_endpoint); 847 snd_usb_endpoint_deactivate(subs->data_endpoint); 848 snd_usb_unlock_shutdown(subs->stream->chip); 849 } 850 851 return 0; 852 } 853 854 /* 855 * prepare callback 856 * 857 * only a few subtle things... 858 */ 859 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream) 860 { 861 struct snd_pcm_runtime *runtime = substream->runtime; 862 struct snd_usb_substream *subs = runtime->private_data; 863 struct usb_host_interface *alts; 864 struct usb_interface *iface; 865 int ret; 866 867 if (! subs->cur_audiofmt) { 868 dev_err(&subs->dev->dev, "no format is specified!\n"); 869 return -ENXIO; 870 } 871 872 ret = snd_usb_lock_shutdown(subs->stream->chip); 873 if (ret < 0) 874 return ret; 875 if (snd_BUG_ON(!subs->data_endpoint)) { 876 ret = -EIO; 877 goto unlock; 878 } 879 880 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint); 881 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint); 882 883 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0); 884 if (ret < 0) 885 goto unlock; 886 887 ret = set_format(subs, subs->cur_audiofmt); 888 if (ret < 0) 889 goto unlock; 890 891 if (subs->need_setup_ep) { 892 893 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface); 894 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx]; 895 ret = snd_usb_init_sample_rate(subs->stream->chip, 896 subs->cur_audiofmt->iface, 897 alts, 898 subs->cur_audiofmt, 899 subs->cur_rate); 900 if (ret < 0) 901 goto unlock; 902 903 ret = configure_endpoint(subs); 904 if (ret < 0) 905 goto unlock; 906 subs->need_setup_ep = false; 907 } 908 909 /* some unit conversions in runtime */ 910 subs->data_endpoint->maxframesize = 911 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize); 912 subs->data_endpoint->curframesize = 913 bytes_to_frames(runtime, subs->data_endpoint->curpacksize); 914 915 /* reset the pointer */ 916 subs->hwptr_done = 0; 917 subs->transfer_done = 0; 918 subs->last_delay = 0; 919 subs->last_frame_number = 0; 920 runtime->delay = 0; 921 922 /* for playback, submit the URBs now; otherwise, the first hwptr_done 923 * updates for all URBs would happen at the same time when starting */ 924 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) 925 ret = start_endpoints(subs); 926 927 unlock: 928 snd_usb_unlock_shutdown(subs->stream->chip); 929 return ret; 930 } 931 932 static const struct snd_pcm_hardware snd_usb_hardware = 933 { 934 .info = SNDRV_PCM_INFO_MMAP | 935 SNDRV_PCM_INFO_MMAP_VALID | 936 SNDRV_PCM_INFO_BATCH | 937 SNDRV_PCM_INFO_INTERLEAVED | 938 SNDRV_PCM_INFO_BLOCK_TRANSFER | 939 SNDRV_PCM_INFO_PAUSE, 940 .buffer_bytes_max = 1024 * 1024, 941 .period_bytes_min = 64, 942 .period_bytes_max = 512 * 1024, 943 .periods_min = 2, 944 .periods_max = 1024, 945 }; 946 947 static int hw_check_valid_format(struct snd_usb_substream *subs, 948 struct snd_pcm_hw_params *params, 949 struct audioformat *fp) 950 { 951 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE); 952 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS); 953 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT); 954 struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME); 955 struct snd_mask check_fmts; 956 unsigned int ptime; 957 958 /* check the format */ 959 snd_mask_none(&check_fmts); 960 check_fmts.bits[0] = (u32)fp->formats; 961 check_fmts.bits[1] = (u32)(fp->formats >> 32); 962 snd_mask_intersect(&check_fmts, fmts); 963 if (snd_mask_empty(&check_fmts)) { 964 hwc_debug(" > check: no supported format %d\n", fp->format); 965 return 0; 966 } 967 /* check the channels */ 968 if (fp->channels < ct->min || fp->channels > ct->max) { 969 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max); 970 return 0; 971 } 972 /* check the rate is within the range */ 973 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) { 974 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max); 975 return 0; 976 } 977 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) { 978 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min); 979 return 0; 980 } 981 /* check whether the period time is >= the data packet interval */ 982 if (subs->speed != USB_SPEED_FULL) { 983 ptime = 125 * (1 << fp->datainterval); 984 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) { 985 hwc_debug(" > check: ptime %u > max %u\n", ptime, pt->max); 986 return 0; 987 } 988 } 989 return 1; 990 } 991 992 static int hw_rule_rate(struct snd_pcm_hw_params *params, 993 struct snd_pcm_hw_rule *rule) 994 { 995 struct snd_usb_substream *subs = rule->private; 996 struct audioformat *fp; 997 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE); 998 unsigned int rmin, rmax; 999 int changed; 1000 1001 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max); 1002 changed = 0; 1003 rmin = rmax = 0; 1004 list_for_each_entry(fp, &subs->fmt_list, list) { 1005 if (!hw_check_valid_format(subs, params, fp)) 1006 continue; 1007 if (changed++) { 1008 if (rmin > fp->rate_min) 1009 rmin = fp->rate_min; 1010 if (rmax < fp->rate_max) 1011 rmax = fp->rate_max; 1012 } else { 1013 rmin = fp->rate_min; 1014 rmax = fp->rate_max; 1015 } 1016 } 1017 1018 if (!changed) { 1019 hwc_debug(" --> get empty\n"); 1020 it->empty = 1; 1021 return -EINVAL; 1022 } 1023 1024 changed = 0; 1025 if (it->min < rmin) { 1026 it->min = rmin; 1027 it->openmin = 0; 1028 changed = 1; 1029 } 1030 if (it->max > rmax) { 1031 it->max = rmax; 1032 it->openmax = 0; 1033 changed = 1; 1034 } 1035 if (snd_interval_checkempty(it)) { 1036 it->empty = 1; 1037 return -EINVAL; 1038 } 1039 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed); 1040 return changed; 1041 } 1042 1043 1044 static int hw_rule_channels(struct snd_pcm_hw_params *params, 1045 struct snd_pcm_hw_rule *rule) 1046 { 1047 struct snd_usb_substream *subs = rule->private; 1048 struct audioformat *fp; 1049 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS); 1050 unsigned int rmin, rmax; 1051 int changed; 1052 1053 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max); 1054 changed = 0; 1055 rmin = rmax = 0; 1056 list_for_each_entry(fp, &subs->fmt_list, list) { 1057 if (!hw_check_valid_format(subs, params, fp)) 1058 continue; 1059 if (changed++) { 1060 if (rmin > fp->channels) 1061 rmin = fp->channels; 1062 if (rmax < fp->channels) 1063 rmax = fp->channels; 1064 } else { 1065 rmin = fp->channels; 1066 rmax = fp->channels; 1067 } 1068 } 1069 1070 if (!changed) { 1071 hwc_debug(" --> get empty\n"); 1072 it->empty = 1; 1073 return -EINVAL; 1074 } 1075 1076 changed = 0; 1077 if (it->min < rmin) { 1078 it->min = rmin; 1079 it->openmin = 0; 1080 changed = 1; 1081 } 1082 if (it->max > rmax) { 1083 it->max = rmax; 1084 it->openmax = 0; 1085 changed = 1; 1086 } 1087 if (snd_interval_checkempty(it)) { 1088 it->empty = 1; 1089 return -EINVAL; 1090 } 1091 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed); 1092 return changed; 1093 } 1094 1095 static int hw_rule_format(struct snd_pcm_hw_params *params, 1096 struct snd_pcm_hw_rule *rule) 1097 { 1098 struct snd_usb_substream *subs = rule->private; 1099 struct audioformat *fp; 1100 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT); 1101 u64 fbits; 1102 u32 oldbits[2]; 1103 int changed; 1104 1105 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]); 1106 fbits = 0; 1107 list_for_each_entry(fp, &subs->fmt_list, list) { 1108 if (!hw_check_valid_format(subs, params, fp)) 1109 continue; 1110 fbits |= fp->formats; 1111 } 1112 1113 oldbits[0] = fmt->bits[0]; 1114 oldbits[1] = fmt->bits[1]; 1115 fmt->bits[0] &= (u32)fbits; 1116 fmt->bits[1] &= (u32)(fbits >> 32); 1117 if (!fmt->bits[0] && !fmt->bits[1]) { 1118 hwc_debug(" --> get empty\n"); 1119 return -EINVAL; 1120 } 1121 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]); 1122 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed); 1123 return changed; 1124 } 1125 1126 static int hw_rule_period_time(struct snd_pcm_hw_params *params, 1127 struct snd_pcm_hw_rule *rule) 1128 { 1129 struct snd_usb_substream *subs = rule->private; 1130 struct audioformat *fp; 1131 struct snd_interval *it; 1132 unsigned char min_datainterval; 1133 unsigned int pmin; 1134 int changed; 1135 1136 it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME); 1137 hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max); 1138 min_datainterval = 0xff; 1139 list_for_each_entry(fp, &subs->fmt_list, list) { 1140 if (!hw_check_valid_format(subs, params, fp)) 1141 continue; 1142 min_datainterval = min(min_datainterval, fp->datainterval); 1143 } 1144 if (min_datainterval == 0xff) { 1145 hwc_debug(" --> get empty\n"); 1146 it->empty = 1; 1147 return -EINVAL; 1148 } 1149 pmin = 125 * (1 << min_datainterval); 1150 changed = 0; 1151 if (it->min < pmin) { 1152 it->min = pmin; 1153 it->openmin = 0; 1154 changed = 1; 1155 } 1156 if (snd_interval_checkempty(it)) { 1157 it->empty = 1; 1158 return -EINVAL; 1159 } 1160 hwc_debug(" --> (%u,%u) (changed = %d)\n", it->min, it->max, changed); 1161 return changed; 1162 } 1163 1164 /* 1165 * If the device supports unusual bit rates, does the request meet these? 1166 */ 1167 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime, 1168 struct snd_usb_substream *subs) 1169 { 1170 struct audioformat *fp; 1171 int *rate_list; 1172 int count = 0, needs_knot = 0; 1173 int err; 1174 1175 kfree(subs->rate_list.list); 1176 subs->rate_list.list = NULL; 1177 1178 list_for_each_entry(fp, &subs->fmt_list, list) { 1179 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) 1180 return 0; 1181 count += fp->nr_rates; 1182 if (fp->rates & SNDRV_PCM_RATE_KNOT) 1183 needs_knot = 1; 1184 } 1185 if (!needs_knot) 1186 return 0; 1187 1188 subs->rate_list.list = rate_list = 1189 kmalloc_array(count, sizeof(int), GFP_KERNEL); 1190 if (!subs->rate_list.list) 1191 return -ENOMEM; 1192 subs->rate_list.count = count; 1193 subs->rate_list.mask = 0; 1194 count = 0; 1195 list_for_each_entry(fp, &subs->fmt_list, list) { 1196 int i; 1197 for (i = 0; i < fp->nr_rates; i++) 1198 rate_list[count++] = fp->rate_table[i]; 1199 } 1200 err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, 1201 &subs->rate_list); 1202 if (err < 0) 1203 return err; 1204 1205 return 0; 1206 } 1207 1208 1209 /* 1210 * set up the runtime hardware information. 1211 */ 1212 1213 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs) 1214 { 1215 struct audioformat *fp; 1216 unsigned int pt, ptmin; 1217 int param_period_time_if_needed; 1218 int err; 1219 1220 runtime->hw.formats = subs->formats; 1221 1222 runtime->hw.rate_min = 0x7fffffff; 1223 runtime->hw.rate_max = 0; 1224 runtime->hw.channels_min = 256; 1225 runtime->hw.channels_max = 0; 1226 runtime->hw.rates = 0; 1227 ptmin = UINT_MAX; 1228 /* check min/max rates and channels */ 1229 list_for_each_entry(fp, &subs->fmt_list, list) { 1230 runtime->hw.rates |= fp->rates; 1231 if (runtime->hw.rate_min > fp->rate_min) 1232 runtime->hw.rate_min = fp->rate_min; 1233 if (runtime->hw.rate_max < fp->rate_max) 1234 runtime->hw.rate_max = fp->rate_max; 1235 if (runtime->hw.channels_min > fp->channels) 1236 runtime->hw.channels_min = fp->channels; 1237 if (runtime->hw.channels_max < fp->channels) 1238 runtime->hw.channels_max = fp->channels; 1239 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) { 1240 /* FIXME: there might be more than one audio formats... */ 1241 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max = 1242 fp->frame_size; 1243 } 1244 pt = 125 * (1 << fp->datainterval); 1245 ptmin = min(ptmin, pt); 1246 } 1247 1248 param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME; 1249 if (subs->speed == USB_SPEED_FULL) 1250 /* full speed devices have fixed data packet interval */ 1251 ptmin = 1000; 1252 if (ptmin == 1000) 1253 /* if period time doesn't go below 1 ms, no rules needed */ 1254 param_period_time_if_needed = -1; 1255 1256 err = snd_pcm_hw_constraint_minmax(runtime, 1257 SNDRV_PCM_HW_PARAM_PERIOD_TIME, 1258 ptmin, UINT_MAX); 1259 if (err < 0) 1260 return err; 1261 1262 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, 1263 hw_rule_rate, subs, 1264 SNDRV_PCM_HW_PARAM_FORMAT, 1265 SNDRV_PCM_HW_PARAM_CHANNELS, 1266 param_period_time_if_needed, 1267 -1); 1268 if (err < 0) 1269 return err; 1270 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS, 1271 hw_rule_channels, subs, 1272 SNDRV_PCM_HW_PARAM_FORMAT, 1273 SNDRV_PCM_HW_PARAM_RATE, 1274 param_period_time_if_needed, 1275 -1); 1276 if (err < 0) 1277 return err; 1278 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT, 1279 hw_rule_format, subs, 1280 SNDRV_PCM_HW_PARAM_RATE, 1281 SNDRV_PCM_HW_PARAM_CHANNELS, 1282 param_period_time_if_needed, 1283 -1); 1284 if (err < 0) 1285 return err; 1286 if (param_period_time_if_needed >= 0) { 1287 err = snd_pcm_hw_rule_add(runtime, 0, 1288 SNDRV_PCM_HW_PARAM_PERIOD_TIME, 1289 hw_rule_period_time, subs, 1290 SNDRV_PCM_HW_PARAM_FORMAT, 1291 SNDRV_PCM_HW_PARAM_CHANNELS, 1292 SNDRV_PCM_HW_PARAM_RATE, 1293 -1); 1294 if (err < 0) 1295 return err; 1296 } 1297 err = snd_usb_pcm_check_knot(runtime, subs); 1298 if (err < 0) 1299 return err; 1300 1301 return snd_usb_autoresume(subs->stream->chip); 1302 } 1303 1304 static int snd_usb_pcm_open(struct snd_pcm_substream *substream) 1305 { 1306 int direction = substream->stream; 1307 struct snd_usb_stream *as = snd_pcm_substream_chip(substream); 1308 struct snd_pcm_runtime *runtime = substream->runtime; 1309 struct snd_usb_substream *subs = &as->substream[direction]; 1310 int ret; 1311 1312 subs->interface = -1; 1313 subs->altset_idx = 0; 1314 runtime->hw = snd_usb_hardware; 1315 runtime->private_data = subs; 1316 subs->pcm_substream = substream; 1317 /* runtime PM is also done there */ 1318 1319 /* initialize DSD/DOP context */ 1320 subs->dsd_dop.byte_idx = 0; 1321 subs->dsd_dop.channel = 0; 1322 subs->dsd_dop.marker = 1; 1323 1324 ret = setup_hw_info(runtime, subs); 1325 if (ret == 0) { 1326 ret = snd_media_stream_init(subs, as->pcm, direction); 1327 if (ret) 1328 snd_usb_autosuspend(subs->stream->chip); 1329 } 1330 return ret; 1331 } 1332 1333 static int snd_usb_pcm_close(struct snd_pcm_substream *substream) 1334 { 1335 int direction = substream->stream; 1336 struct snd_usb_stream *as = snd_pcm_substream_chip(substream); 1337 struct snd_usb_substream *subs = &as->substream[direction]; 1338 int ret; 1339 1340 stop_endpoints(subs, true); 1341 snd_media_stop_pipeline(subs); 1342 1343 if (!as->chip->keep_iface && 1344 subs->interface >= 0 && 1345 !snd_usb_lock_shutdown(subs->stream->chip)) { 1346 usb_set_interface(subs->dev, subs->interface, 0); 1347 subs->interface = -1; 1348 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1); 1349 snd_usb_unlock_shutdown(subs->stream->chip); 1350 if (ret < 0) 1351 return ret; 1352 } 1353 1354 subs->pcm_substream = NULL; 1355 snd_usb_autosuspend(subs->stream->chip); 1356 1357 return 0; 1358 } 1359 1360 /* Since a URB can handle only a single linear buffer, we must use double 1361 * buffering when the data to be transferred overflows the buffer boundary. 1362 * To avoid inconsistencies when updating hwptr_done, we use double buffering 1363 * for all URBs. 1364 */ 1365 static void retire_capture_urb(struct snd_usb_substream *subs, 1366 struct urb *urb) 1367 { 1368 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime; 1369 unsigned int stride, frames, bytes, oldptr; 1370 int i, period_elapsed = 0; 1371 unsigned long flags; 1372 unsigned char *cp; 1373 int current_frame_number; 1374 1375 /* read frame number here, update pointer in critical section */ 1376 current_frame_number = usb_get_current_frame_number(subs->dev); 1377 1378 stride = runtime->frame_bits >> 3; 1379 1380 for (i = 0; i < urb->number_of_packets; i++) { 1381 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj; 1382 if (urb->iso_frame_desc[i].status && printk_ratelimit()) { 1383 dev_dbg(&subs->dev->dev, "frame %d active: %d\n", 1384 i, urb->iso_frame_desc[i].status); 1385 // continue; 1386 } 1387 bytes = urb->iso_frame_desc[i].actual_length; 1388 frames = bytes / stride; 1389 if (!subs->txfr_quirk) 1390 bytes = frames * stride; 1391 if (bytes % (runtime->sample_bits >> 3) != 0) { 1392 int oldbytes = bytes; 1393 bytes = frames * stride; 1394 dev_warn_ratelimited(&subs->dev->dev, 1395 "Corrected urb data len. %d->%d\n", 1396 oldbytes, bytes); 1397 } 1398 /* update the current pointer */ 1399 spin_lock_irqsave(&subs->lock, flags); 1400 oldptr = subs->hwptr_done; 1401 subs->hwptr_done += bytes; 1402 if (subs->hwptr_done >= runtime->buffer_size * stride) 1403 subs->hwptr_done -= runtime->buffer_size * stride; 1404 frames = (bytes + (oldptr % stride)) / stride; 1405 subs->transfer_done += frames; 1406 if (subs->transfer_done >= runtime->period_size) { 1407 subs->transfer_done -= runtime->period_size; 1408 period_elapsed = 1; 1409 } 1410 /* capture delay is by construction limited to one URB, 1411 * reset delays here 1412 */ 1413 runtime->delay = subs->last_delay = 0; 1414 1415 /* realign last_frame_number */ 1416 subs->last_frame_number = current_frame_number; 1417 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */ 1418 1419 spin_unlock_irqrestore(&subs->lock, flags); 1420 /* copy a data chunk */ 1421 if (oldptr + bytes > runtime->buffer_size * stride) { 1422 unsigned int bytes1 = 1423 runtime->buffer_size * stride - oldptr; 1424 memcpy(runtime->dma_area + oldptr, cp, bytes1); 1425 memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1); 1426 } else { 1427 memcpy(runtime->dma_area + oldptr, cp, bytes); 1428 } 1429 } 1430 1431 if (period_elapsed) 1432 snd_pcm_period_elapsed(subs->pcm_substream); 1433 } 1434 1435 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs, 1436 struct urb *urb, unsigned int bytes) 1437 { 1438 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime; 1439 unsigned int stride = runtime->frame_bits >> 3; 1440 unsigned int dst_idx = 0; 1441 unsigned int src_idx = subs->hwptr_done; 1442 unsigned int wrap = runtime->buffer_size * stride; 1443 u8 *dst = urb->transfer_buffer; 1444 u8 *src = runtime->dma_area; 1445 u8 marker[] = { 0x05, 0xfa }; 1446 1447 /* 1448 * The DSP DOP format defines a way to transport DSD samples over 1449 * normal PCM data endpoints. It requires stuffing of marker bytes 1450 * (0x05 and 0xfa, alternating per sample frame), and then expects 1451 * 2 additional bytes of actual payload. The whole frame is stored 1452 * LSB. 1453 * 1454 * Hence, for a stereo transport, the buffer layout looks like this, 1455 * where L refers to left channel samples and R to right. 1456 * 1457 * L1 L2 0x05 R1 R2 0x05 L3 L4 0xfa R3 R4 0xfa 1458 * L5 L6 0x05 R5 R6 0x05 L7 L8 0xfa R7 R8 0xfa 1459 * ..... 1460 * 1461 */ 1462 1463 while (bytes--) { 1464 if (++subs->dsd_dop.byte_idx == 3) { 1465 /* frame boundary? */ 1466 dst[dst_idx++] = marker[subs->dsd_dop.marker]; 1467 src_idx += 2; 1468 subs->dsd_dop.byte_idx = 0; 1469 1470 if (++subs->dsd_dop.channel % runtime->channels == 0) { 1471 /* alternate the marker */ 1472 subs->dsd_dop.marker++; 1473 subs->dsd_dop.marker %= ARRAY_SIZE(marker); 1474 subs->dsd_dop.channel = 0; 1475 } 1476 } else { 1477 /* stuff the DSD payload */ 1478 int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap; 1479 1480 if (subs->cur_audiofmt->dsd_bitrev) 1481 dst[dst_idx++] = bitrev8(src[idx]); 1482 else 1483 dst[dst_idx++] = src[idx]; 1484 1485 subs->hwptr_done++; 1486 } 1487 } 1488 if (subs->hwptr_done >= runtime->buffer_size * stride) 1489 subs->hwptr_done -= runtime->buffer_size * stride; 1490 } 1491 1492 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb, 1493 int offset, int stride, unsigned int bytes) 1494 { 1495 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime; 1496 1497 if (subs->hwptr_done + bytes > runtime->buffer_size * stride) { 1498 /* err, the transferred area goes over buffer boundary. */ 1499 unsigned int bytes1 = 1500 runtime->buffer_size * stride - subs->hwptr_done; 1501 memcpy(urb->transfer_buffer + offset, 1502 runtime->dma_area + subs->hwptr_done, bytes1); 1503 memcpy(urb->transfer_buffer + offset + bytes1, 1504 runtime->dma_area, bytes - bytes1); 1505 } else { 1506 memcpy(urb->transfer_buffer + offset, 1507 runtime->dma_area + subs->hwptr_done, bytes); 1508 } 1509 subs->hwptr_done += bytes; 1510 if (subs->hwptr_done >= runtime->buffer_size * stride) 1511 subs->hwptr_done -= runtime->buffer_size * stride; 1512 } 1513 1514 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs, 1515 struct urb *urb, int stride, 1516 unsigned int bytes) 1517 { 1518 __le32 packet_length; 1519 int i; 1520 1521 /* Put __le32 length descriptor at start of each packet. */ 1522 for (i = 0; i < urb->number_of_packets; i++) { 1523 unsigned int length = urb->iso_frame_desc[i].length; 1524 unsigned int offset = urb->iso_frame_desc[i].offset; 1525 1526 packet_length = cpu_to_le32(length); 1527 offset += i * sizeof(packet_length); 1528 urb->iso_frame_desc[i].offset = offset; 1529 urb->iso_frame_desc[i].length += sizeof(packet_length); 1530 memcpy(urb->transfer_buffer + offset, 1531 &packet_length, sizeof(packet_length)); 1532 copy_to_urb(subs, urb, offset + sizeof(packet_length), 1533 stride, length); 1534 } 1535 /* Adjust transfer size accordingly. */ 1536 bytes += urb->number_of_packets * sizeof(packet_length); 1537 return bytes; 1538 } 1539 1540 static void prepare_playback_urb(struct snd_usb_substream *subs, 1541 struct urb *urb) 1542 { 1543 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime; 1544 struct snd_usb_endpoint *ep = subs->data_endpoint; 1545 struct snd_urb_ctx *ctx = urb->context; 1546 unsigned int counts, frames, bytes; 1547 int i, stride, period_elapsed = 0; 1548 unsigned long flags; 1549 1550 stride = runtime->frame_bits >> 3; 1551 1552 frames = 0; 1553 urb->number_of_packets = 0; 1554 spin_lock_irqsave(&subs->lock, flags); 1555 subs->frame_limit += ep->max_urb_frames; 1556 for (i = 0; i < ctx->packets; i++) { 1557 if (ctx->packet_size[i]) 1558 counts = ctx->packet_size[i]; 1559 else 1560 counts = snd_usb_endpoint_next_packet_size(ep); 1561 1562 /* set up descriptor */ 1563 urb->iso_frame_desc[i].offset = frames * ep->stride; 1564 urb->iso_frame_desc[i].length = counts * ep->stride; 1565 frames += counts; 1566 urb->number_of_packets++; 1567 subs->transfer_done += counts; 1568 if (subs->transfer_done >= runtime->period_size) { 1569 subs->transfer_done -= runtime->period_size; 1570 subs->frame_limit = 0; 1571 period_elapsed = 1; 1572 if (subs->fmt_type == UAC_FORMAT_TYPE_II) { 1573 if (subs->transfer_done > 0) { 1574 /* FIXME: fill-max mode is not 1575 * supported yet */ 1576 frames -= subs->transfer_done; 1577 counts -= subs->transfer_done; 1578 urb->iso_frame_desc[i].length = 1579 counts * ep->stride; 1580 subs->transfer_done = 0; 1581 } 1582 i++; 1583 if (i < ctx->packets) { 1584 /* add a transfer delimiter */ 1585 urb->iso_frame_desc[i].offset = 1586 frames * ep->stride; 1587 urb->iso_frame_desc[i].length = 0; 1588 urb->number_of_packets++; 1589 } 1590 break; 1591 } 1592 } 1593 /* finish at the period boundary or after enough frames */ 1594 if ((period_elapsed || 1595 subs->transfer_done >= subs->frame_limit) && 1596 !snd_usb_endpoint_implicit_feedback_sink(ep)) 1597 break; 1598 } 1599 bytes = frames * ep->stride; 1600 1601 if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && 1602 subs->cur_audiofmt->dsd_dop)) { 1603 fill_playback_urb_dsd_dop(subs, urb, bytes); 1604 } else if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U8 && 1605 subs->cur_audiofmt->dsd_bitrev)) { 1606 /* bit-reverse the bytes */ 1607 u8 *buf = urb->transfer_buffer; 1608 for (i = 0; i < bytes; i++) { 1609 int idx = (subs->hwptr_done + i) 1610 % (runtime->buffer_size * stride); 1611 buf[i] = bitrev8(runtime->dma_area[idx]); 1612 } 1613 1614 subs->hwptr_done += bytes; 1615 if (subs->hwptr_done >= runtime->buffer_size * stride) 1616 subs->hwptr_done -= runtime->buffer_size * stride; 1617 } else { 1618 /* usual PCM */ 1619 if (!subs->tx_length_quirk) 1620 copy_to_urb(subs, urb, 0, stride, bytes); 1621 else 1622 bytes = copy_to_urb_quirk(subs, urb, stride, bytes); 1623 /* bytes is now amount of outgoing data */ 1624 } 1625 1626 /* update delay with exact number of samples queued */ 1627 runtime->delay = subs->last_delay; 1628 runtime->delay += frames; 1629 subs->last_delay = runtime->delay; 1630 1631 /* realign last_frame_number */ 1632 subs->last_frame_number = usb_get_current_frame_number(subs->dev); 1633 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */ 1634 1635 if (subs->trigger_tstamp_pending_update) { 1636 /* this is the first actual URB submitted, 1637 * update trigger timestamp to reflect actual start time 1638 */ 1639 snd_pcm_gettime(runtime, &runtime->trigger_tstamp); 1640 subs->trigger_tstamp_pending_update = false; 1641 } 1642 1643 spin_unlock_irqrestore(&subs->lock, flags); 1644 urb->transfer_buffer_length = bytes; 1645 if (period_elapsed) 1646 snd_pcm_period_elapsed(subs->pcm_substream); 1647 } 1648 1649 /* 1650 * process after playback data complete 1651 * - decrease the delay count again 1652 */ 1653 static void retire_playback_urb(struct snd_usb_substream *subs, 1654 struct urb *urb) 1655 { 1656 unsigned long flags; 1657 struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime; 1658 struct snd_usb_endpoint *ep = subs->data_endpoint; 1659 int processed = urb->transfer_buffer_length / ep->stride; 1660 int est_delay; 1661 1662 /* ignore the delay accounting when procssed=0 is given, i.e. 1663 * silent payloads are procssed before handling the actual data 1664 */ 1665 if (!processed) 1666 return; 1667 1668 spin_lock_irqsave(&subs->lock, flags); 1669 if (!subs->last_delay) 1670 goto out; /* short path */ 1671 1672 est_delay = snd_usb_pcm_delay(subs, runtime->rate); 1673 /* update delay with exact number of samples played */ 1674 if (processed > subs->last_delay) 1675 subs->last_delay = 0; 1676 else 1677 subs->last_delay -= processed; 1678 runtime->delay = subs->last_delay; 1679 1680 /* 1681 * Report when delay estimate is off by more than 2ms. 1682 * The error should be lower than 2ms since the estimate relies 1683 * on two reads of a counter updated every ms. 1684 */ 1685 if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2) 1686 dev_dbg_ratelimited(&subs->dev->dev, 1687 "delay: estimated %d, actual %d\n", 1688 est_delay, subs->last_delay); 1689 1690 if (!subs->running) { 1691 /* update last_frame_number for delay counting here since 1692 * prepare_playback_urb won't be called during pause 1693 */ 1694 subs->last_frame_number = 1695 usb_get_current_frame_number(subs->dev) & 0xff; 1696 } 1697 1698 out: 1699 spin_unlock_irqrestore(&subs->lock, flags); 1700 } 1701 1702 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream, 1703 int cmd) 1704 { 1705 struct snd_usb_substream *subs = substream->runtime->private_data; 1706 1707 switch (cmd) { 1708 case SNDRV_PCM_TRIGGER_START: 1709 subs->trigger_tstamp_pending_update = true; 1710 /* fall through */ 1711 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE: 1712 subs->data_endpoint->prepare_data_urb = prepare_playback_urb; 1713 subs->data_endpoint->retire_data_urb = retire_playback_urb; 1714 subs->running = 1; 1715 return 0; 1716 case SNDRV_PCM_TRIGGER_STOP: 1717 stop_endpoints(subs, false); 1718 subs->running = 0; 1719 return 0; 1720 case SNDRV_PCM_TRIGGER_PAUSE_PUSH: 1721 subs->data_endpoint->prepare_data_urb = NULL; 1722 /* keep retire_data_urb for delay calculation */ 1723 subs->data_endpoint->retire_data_urb = retire_playback_urb; 1724 subs->running = 0; 1725 return 0; 1726 } 1727 1728 return -EINVAL; 1729 } 1730 1731 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream, 1732 int cmd) 1733 { 1734 int err; 1735 struct snd_usb_substream *subs = substream->runtime->private_data; 1736 1737 switch (cmd) { 1738 case SNDRV_PCM_TRIGGER_START: 1739 err = start_endpoints(subs); 1740 if (err < 0) 1741 return err; 1742 1743 subs->data_endpoint->retire_data_urb = retire_capture_urb; 1744 subs->running = 1; 1745 return 0; 1746 case SNDRV_PCM_TRIGGER_STOP: 1747 stop_endpoints(subs, false); 1748 subs->running = 0; 1749 return 0; 1750 case SNDRV_PCM_TRIGGER_PAUSE_PUSH: 1751 subs->data_endpoint->retire_data_urb = NULL; 1752 subs->running = 0; 1753 return 0; 1754 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE: 1755 subs->data_endpoint->retire_data_urb = retire_capture_urb; 1756 subs->running = 1; 1757 return 0; 1758 } 1759 1760 return -EINVAL; 1761 } 1762 1763 static const struct snd_pcm_ops snd_usb_playback_ops = { 1764 .open = snd_usb_pcm_open, 1765 .close = snd_usb_pcm_close, 1766 .ioctl = snd_pcm_lib_ioctl, 1767 .hw_params = snd_usb_hw_params, 1768 .hw_free = snd_usb_hw_free, 1769 .prepare = snd_usb_pcm_prepare, 1770 .trigger = snd_usb_substream_playback_trigger, 1771 .pointer = snd_usb_pcm_pointer, 1772 }; 1773 1774 static const struct snd_pcm_ops snd_usb_capture_ops = { 1775 .open = snd_usb_pcm_open, 1776 .close = snd_usb_pcm_close, 1777 .ioctl = snd_pcm_lib_ioctl, 1778 .hw_params = snd_usb_hw_params, 1779 .hw_free = snd_usb_hw_free, 1780 .prepare = snd_usb_pcm_prepare, 1781 .trigger = snd_usb_substream_capture_trigger, 1782 .pointer = snd_usb_pcm_pointer, 1783 }; 1784 1785 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream) 1786 { 1787 const struct snd_pcm_ops *ops; 1788 1789 ops = stream == SNDRV_PCM_STREAM_PLAYBACK ? 1790 &snd_usb_playback_ops : &snd_usb_capture_ops; 1791 snd_pcm_set_ops(pcm, stream, ops); 1792 } 1793 1794 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs) 1795 { 1796 struct snd_pcm *pcm = subs->stream->pcm; 1797 struct snd_pcm_substream *s = pcm->streams[subs->direction].substream; 1798 struct device *dev = subs->dev->bus->controller; 1799 1800 if (snd_usb_use_vmalloc) 1801 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_VMALLOC, 1802 NULL, 0, 0); 1803 else 1804 snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_DEV_SG, 1805 dev, 64*1024, 512*1024); 1806 } 1807