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