pcm.c 45.1 KB
Newer Older
Daniel Mack's avatar
Daniel Mack committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

#include <linux/init.h>
18
#include <linux/slab.h>
19
#include <linux/bitrev.h>
20
#include <linux/ratelimit.h>
Daniel Mack's avatar
Daniel Mack committed
21 22
#include <linux/usb.h>
#include <linux/usb/audio.h>
Daniel Mack's avatar
Daniel Mack committed
23
#include <linux/usb/audio-v2.h>
Daniel Mack's avatar
Daniel Mack committed
24 25 26 27 28 29 30 31 32

#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>

#include "usbaudio.h"
#include "card.h"
#include "quirks.h"
#include "debug.h"
33
#include "endpoint.h"
Daniel Mack's avatar
Daniel Mack committed
34 35
#include "helper.h"
#include "pcm.h"
36
#include "clock.h"
37
#include "power.h"
Daniel Mack's avatar
Daniel Mack committed
38

39 40 41
#define SUBSTREAM_FLAG_DATA_EP_STARTED	0
#define SUBSTREAM_FLAG_SYNC_EP_STARTED	1

42 43 44 45 46 47 48 49
/* return the estimated delay based on USB frame counters */
snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
				    unsigned int rate)
{
	int current_frame_number;
	int frame_diff;
	int est_delay;

50 51 52
	if (!subs->last_delay)
		return 0; /* short path */

53 54 55 56 57 58 59 60 61 62
	current_frame_number = usb_get_current_frame_number(subs->dev);
	/*
	 * HCD implementations use different widths, use lower 8 bits.
	 * The delay will be managed up to 256ms, which is more than
	 * enough
	 */
	frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;

	/* Approximation based on number of samples per USB frame (ms),
	   some truncation for 44.1 but the estimate is good enough */
63 64 65 66 67 68
	est_delay =  frame_diff * rate / 1000;
	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
		est_delay = subs->last_delay - est_delay;
	else
		est_delay = subs->last_delay + est_delay;

69 70 71 72 73
	if (est_delay < 0)
		est_delay = 0;
	return est_delay;
}

Daniel Mack's avatar
Daniel Mack committed
74 75 76 77 78 79 80 81 82
/*
 * return the current pcm pointer.  just based on the hwptr_done value.
 */
static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
{
	struct snd_usb_substream *subs;
	unsigned int hwptr_done;

	subs = (struct snd_usb_substream *)substream->runtime->private_data;
83 84
	if (subs->stream->chip->shutdown)
		return SNDRV_PCM_POS_XRUN;
Daniel Mack's avatar
Daniel Mack committed
85 86
	spin_lock(&subs->lock);
	hwptr_done = subs->hwptr_done;
87
	substream->runtime->delay = snd_usb_pcm_delay(subs,
88
						substream->runtime->rate);
Daniel Mack's avatar
Daniel Mack committed
89 90 91 92 93 94 95
	spin_unlock(&subs->lock);
	return hwptr_done / (substream->runtime->frame_bits >> 3);
}

/*
 * find a matching audio format
 */
96
static struct audioformat *find_format(struct snd_usb_substream *subs)
Daniel Mack's avatar
Daniel Mack committed
97
{
98
	struct audioformat *fp;
Daniel Mack's avatar
Daniel Mack committed
99 100 101
	struct audioformat *found = NULL;
	int cur_attr = 0, attr;

102
	list_for_each_entry(fp, &subs->fmt_list, list) {
103
		if (!(fp->formats & pcm_format_to_bits(subs->pcm_format)))
104
			continue;
105
		if (fp->channels != subs->channels)
Daniel Mack's avatar
Daniel Mack committed
106
			continue;
107 108
		if (subs->cur_rate < fp->rate_min ||
		    subs->cur_rate > fp->rate_max)
Daniel Mack's avatar
Daniel Mack committed
109 110 111 112
			continue;
		if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
			unsigned int i;
			for (i = 0; i < fp->nr_rates; i++)
113
				if (fp->rate_table[i] == subs->cur_rate)
Daniel Mack's avatar
Daniel Mack committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
					break;
			if (i >= fp->nr_rates)
				continue;
		}
		attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
		if (! found) {
			found = fp;
			cur_attr = attr;
			continue;
		}
		/* avoid async out and adaptive in if the other method
		 * supports the same format.
		 * this is a workaround for the case like
		 * M-audio audiophile USB.
		 */
		if (attr != cur_attr) {
			if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
			     subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
			    (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
			     subs->direction == SNDRV_PCM_STREAM_CAPTURE))
				continue;
			if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
			     subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
			    (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
			     subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
				found = fp;
				cur_attr = attr;
				continue;
			}
		}
		/* find the format with the largest max. packet size */
		if (fp->maxpacksize > found->maxpacksize) {
			found = fp;
			cur_attr = attr;
		}
	}
	return found;
}

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
			 struct usb_host_interface *alts,
			 struct audioformat *fmt)
{
	struct usb_device *dev = chip->dev;
	unsigned int ep;
	unsigned char data[1];
	int err;

	ep = get_endpoint(alts, 0)->bEndpointAddress;

	data[0] = 1;
	if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
				   USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
				   UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
168
				   data, sizeof(data))) < 0) {
169 170
		usb_audio_err(chip, "%d:%d: cannot set enable PITCH\n",
			      iface, ep);
171 172 173 174 175
		return err;
	}

	return 0;
}
Daniel Mack's avatar
Daniel Mack committed
176

177 178 179 180 181 182 183 184 185 186 187 188
static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
			 struct usb_host_interface *alts,
			 struct audioformat *fmt)
{
	struct usb_device *dev = chip->dev;
	unsigned char data[1];
	int err;

	data[0] = 1;
	if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
				   USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
				   UAC2_EP_CS_PITCH << 8, 0,
189
				   data, sizeof(data))) < 0) {
190 191
		usb_audio_err(chip, "%d:%d: cannot set enable PITCH (v2)\n",
			      iface, fmt->altsetting);
192 193 194 195 196 197
		return err;
	}

	return 0;
}

Daniel Mack's avatar
Daniel Mack committed
198
/*
199
 * initialize the pitch control and sample rate
Daniel Mack's avatar
Daniel Mack committed
200
 */
201
int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
Daniel Mack's avatar
Daniel Mack committed
202 203 204
		       struct usb_host_interface *alts,
		       struct audioformat *fmt)
{
205 206 207 208
	/* if endpoint doesn't have pitch control, bail out */
	if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
		return 0;

209
	switch (fmt->protocol) {
210
	case UAC_VERSION_1:
211
	default:
212 213 214
		return init_pitch_v1(chip, iface, alts, fmt);

	case UAC_VERSION_2:
215
		return init_pitch_v2(chip, iface, alts, fmt);
216 217 218
	}
}

219
static int start_endpoints(struct snd_usb_substream *subs, bool can_sleep)
220 221 222 223 224 225 226 227 228
{
	int err;

	if (!subs->data_endpoint)
		return -EINVAL;

	if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
		struct snd_usb_endpoint *ep = subs->data_endpoint;

229
		dev_dbg(&subs->dev->dev, "Starting data EP @%p\n", ep);
230 231

		ep->data_subs = subs;
232
		err = snd_usb_endpoint_start(ep, can_sleep);
233 234 235 236 237 238 239 240 241 242
		if (err < 0) {
			clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
			return err;
		}
	}

	if (subs->sync_endpoint &&
	    !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
		struct snd_usb_endpoint *ep = subs->sync_endpoint;

243
		if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
244
		    subs->data_endpoint->altsetting != subs->sync_endpoint->altsetting) {
245 246
			err = usb_set_interface(subs->dev,
						subs->sync_endpoint->iface,
247
						subs->sync_endpoint->altsetting);
248
			if (err < 0) {
249
				clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
250 251
				dev_err(&subs->dev->dev,
					   "%d:%d: cannot set interface (%d)\n",
252
					   subs->sync_endpoint->iface,
253
					   subs->sync_endpoint->altsetting, err);
254 255 256 257
				return -EIO;
			}
		}

258
		dev_dbg(&subs->dev->dev, "Starting sync EP @%p\n", ep);
259 260

		ep->sync_slave = subs->data_endpoint;
261
		err = snd_usb_endpoint_start(ep, can_sleep);
262 263 264 265 266 267 268 269 270
		if (err < 0) {
			clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
			return err;
		}
	}

	return 0;
}

271
static void stop_endpoints(struct snd_usb_substream *subs, bool wait)
272 273
{
	if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
274
		snd_usb_endpoint_stop(subs->sync_endpoint);
275 276

	if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
277 278 279 280 281 282
		snd_usb_endpoint_stop(subs->data_endpoint);

	if (wait) {
		snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
		snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
	}
283 284
}

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
static int search_roland_implicit_fb(struct usb_device *dev, int ifnum,
				     unsigned int altsetting,
				     struct usb_host_interface **alts,
				     unsigned int *ep)
{
	struct usb_interface *iface;
	struct usb_interface_descriptor *altsd;
	struct usb_endpoint_descriptor *epd;

	iface = usb_ifnum_to_if(dev, ifnum);
	if (!iface || iface->num_altsetting < altsetting + 1)
		return -ENOENT;
	*alts = &iface->altsetting[altsetting];
	altsd = get_iface_desc(*alts);
	if (altsd->bAlternateSetting != altsetting ||
	    altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
	    (altsd->bInterfaceSubClass != 2 &&
	     altsd->bInterfaceProtocol != 2   ) ||
	    altsd->bNumEndpoints < 1)
		return -ENOENT;
	epd = get_endpoint(*alts, 0);
	if (!usb_endpoint_is_isoc_in(epd) ||
	    (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
					USB_ENDPOINT_USAGE_IMPLICIT_FB)
		return -ENOENT;
	*ep = epd->bEndpointAddress;
	return 0;
}

314 315 316 317
static int set_sync_ep_implicit_fb_quirk(struct snd_usb_substream *subs,
					 struct usb_device *dev,
					 struct usb_interface_descriptor *altsd,
					 unsigned int attr)
Daniel Mack's avatar
Daniel Mack committed
318
{
319
	struct usb_host_interface *alts;
Daniel Mack's avatar
Daniel Mack committed
320
	struct usb_interface *iface;
321
	unsigned int ep;
322

323 324 325 326
	/* Implicit feedback sync EPs consumers are always playback EPs */
	if (subs->direction != SNDRV_PCM_STREAM_PLAYBACK)
		return 0;

327
	switch (subs->stream->chip->usb_id) {
328
	case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
329
	case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
330 331
		ep = 0x81;
		iface = usb_ifnum_to_if(dev, 3);
332

333 334
		if (!iface || iface->num_altsetting == 0)
			return -EINVAL;
335

336 337
		alts = &iface->altsetting[1];
		goto add_sync_ep;
338
		break;
339 340
	case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
	case USB_ID(0x0763, 0x2081):
341 342
		ep = 0x81;
		iface = usb_ifnum_to_if(dev, 2);
343

344 345
		if (!iface || iface->num_altsetting == 0)
			return -EINVAL;
346

347 348
		alts = &iface->altsetting[1];
		goto add_sync_ep;
349
	}
350
	if (attr == USB_ENDPOINT_SYNC_ASYNC &&
351 352 353 354 355 356 357 358 359
	    altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
	    altsd->bInterfaceProtocol == 2 &&
	    altsd->bNumEndpoints == 1 &&
	    USB_ID_VENDOR(subs->stream->chip->usb_id) == 0x0582 /* Roland */ &&
	    search_roland_implicit_fb(dev, altsd->bInterfaceNumber + 1,
				      altsd->bAlternateSetting,
				      &alts, &ep) >= 0) {
		goto add_sync_ep;
	}
360

361 362 363 364 365 366
	/* No quirk */
	return 0;

add_sync_ep:
	subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
						   alts, ep, !subs->direction,
367
						   SND_USB_ENDPOINT_TYPE_DATA);
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
	if (!subs->sync_endpoint)
		return -EINVAL;

	subs->data_endpoint->sync_master = subs->sync_endpoint;

	return 0;
}

static int set_sync_endpoint(struct snd_usb_substream *subs,
			     struct audioformat *fmt,
			     struct usb_device *dev,
			     struct usb_host_interface *alts,
			     struct usb_interface_descriptor *altsd)
{
	int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
	unsigned int ep, attr;
384
	bool implicit_fb;
385 386 387 388 389 390 391 392 393 394 395 396 397
	int err;

	/* we need a sync pipe in async OUT or adaptive IN mode */
	/* check the number of EP, since some devices have broken
	 * descriptors which fool us.  if it has only one EP,
	 * assume it as adaptive-out or sync-in.
	 */
	attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;

	err = set_sync_ep_implicit_fb_quirk(subs, dev, altsd, attr);
	if (err < 0)
		return err;

398 399
	if (altsd->bNumEndpoints < 2)
		return 0;
400

401 402 403
	if ((is_playback && attr != USB_ENDPOINT_SYNC_ASYNC) ||
	    (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
		return 0;
404

405 406 407 408 409 410
	/* check sync-pipe endpoint */
	/* ... and check descriptor size before accessing bSynchAddress
	   because there is a version of the SB Audigy 2 NX firmware lacking
	   the audio fields in the endpoint descriptors */
	if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
	    (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
411
	     get_endpoint(alts, 1)->bSynchAddress != 0)) {
412 413 414
		dev_err(&dev->dev,
			"%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
			   fmt->iface, fmt->altsetting,
415 416 417 418 419 420
			   get_endpoint(alts, 1)->bmAttributes,
			   get_endpoint(alts, 1)->bLength,
			   get_endpoint(alts, 1)->bSynchAddress);
		return -EINVAL;
	}
	ep = get_endpoint(alts, 1)->bEndpointAddress;
421
	if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
422 423
	    ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
	     (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
424 425 426
		dev_err(&dev->dev,
			"%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
			   fmt->iface, fmt->altsetting,
427 428
			   is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
		return -EINVAL;
429
	}
Daniel Mack's avatar
Daniel Mack committed
430

431 432 433 434 435 436 437 438 439 440 441 442 443
	implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
			== USB_ENDPOINT_USAGE_IMPLICIT_FB;

	subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
						   alts, ep, !subs->direction,
						   implicit_fb ?
							SND_USB_ENDPOINT_TYPE_DATA :
							SND_USB_ENDPOINT_TYPE_SYNC);
	if (!subs->sync_endpoint)
		return -EINVAL;

	subs->data_endpoint->sync_master = subs->sync_endpoint;

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
	return 0;
}

/*
 * find a matching format and set up the interface
 */
static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
{
	struct usb_device *dev = subs->dev;
	struct usb_host_interface *alts;
	struct usb_interface_descriptor *altsd;
	struct usb_interface *iface;
	int err;

	iface = usb_ifnum_to_if(dev, fmt->iface);
	if (WARN_ON(!iface))
		return -EINVAL;
	alts = &iface->altsetting[fmt->altset_idx];
	altsd = get_iface_desc(alts);
	if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
		return -EINVAL;

	if (fmt == subs->cur_audiofmt)
		return 0;

	/* close the old interface */
	if (subs->interface >= 0 && subs->interface != fmt->iface) {
		err = usb_set_interface(subs->dev, subs->interface, 0);
		if (err < 0) {
473 474 475
			dev_err(&dev->dev,
				"%d:%d: return to setting 0 failed (%d)\n",
				fmt->iface, fmt->altsetting, err);
476 477 478 479 480 481 482 483 484
			return -EIO;
		}
		subs->interface = -1;
		subs->altset_idx = 0;
	}

	/* set interface */
	if (subs->interface != fmt->iface ||
	    subs->altset_idx != fmt->altset_idx) {
485 486 487 488 489

		err = snd_usb_select_mode_quirk(subs, fmt);
		if (err < 0)
			return -EIO;

490 491
		err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
		if (err < 0) {
492 493 494
			dev_err(&dev->dev,
				"%d:%d: usb_set_interface failed (%d)\n",
				fmt->iface, fmt->altsetting, err);
495 496
			return -EIO;
		}
497 498
		dev_dbg(&dev->dev, "setting usb interface %d:%d\n",
			fmt->iface, fmt->altsetting);
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
		subs->interface = fmt->iface;
		subs->altset_idx = fmt->altset_idx;

		snd_usb_set_interface_quirk(dev);
	}

	subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
						   alts, fmt->endpoint, subs->direction,
						   SND_USB_ENDPOINT_TYPE_DATA);

	if (!subs->data_endpoint)
		return -EINVAL;

	err = set_sync_endpoint(subs, fmt, dev, alts, altsd);
	if (err < 0)
		return err;

516 517
	err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt);
	if (err < 0)
Daniel Mack's avatar
Daniel Mack committed
518 519 520 521 522 523 524 525 526
		return err;

	subs->cur_audiofmt = fmt;

	snd_usb_set_format_quirk(subs, fmt);

	return 0;
}

527 528 529 530 531 532 533
/*
 * Return the score of matching two audioformats.
 * Veto the audioformat if:
 * - It has no channels for some reason.
 * - Requested PCM format is not supported.
 * - Requested sample rate is not supported.
 */
534 535 536 537
static int match_endpoint_audioformats(struct snd_usb_substream *subs,
				       struct audioformat *fp,
				       struct audioformat *match, int rate,
				       snd_pcm_format_t pcm_format)
538 539 540 541 542
{
	int i;
	int score = 0;

	if (fp->channels < 1) {
543 544
		dev_dbg(&subs->dev->dev,
			"%s: (fmt @%p) no channels\n", __func__, fp);
545 546 547
		return 0;
	}

548
	if (!(fp->formats & pcm_format_to_bits(pcm_format))) {
549 550
		dev_dbg(&subs->dev->dev,
			"%s: (fmt @%p) no match for format %d\n", __func__,
551 552 553 554 555 556 557 558 559 560 561
			fp, pcm_format);
		return 0;
	}

	for (i = 0; i < fp->nr_rates; i++) {
		if (fp->rate_table[i] == rate) {
			score++;
			break;
		}
	}
	if (!score) {
562 563
		dev_dbg(&subs->dev->dev,
			"%s: (fmt @%p) no match for rate %d\n", __func__,
564 565 566 567 568 569 570
			fp, rate);
		return 0;
	}

	if (fp->channels == match->channels)
		score++;

571 572
	dev_dbg(&subs->dev->dev,
		"%s: (fmt @%p) score %d\n", __func__, fp, score);
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

	return score;
}

/*
 * Configure the sync ep using the rate and pcm format of the data ep.
 */
static int configure_sync_endpoint(struct snd_usb_substream *subs)
{
	int ret;
	struct audioformat *fp;
	struct audioformat *sync_fp = NULL;
	int cur_score = 0;
	int sync_period_bytes = subs->period_bytes;
	struct snd_usb_substream *sync_subs =
		&subs->stream->substream[subs->direction ^ 1];

590 591 592 593 594 595
	if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
	    !subs->stream)
		return snd_usb_endpoint_set_params(subs->sync_endpoint,
						   subs->pcm_format,
						   subs->channels,
						   subs->period_bytes,
596
						   0, 0,
597 598 599 600
						   subs->cur_rate,
						   subs->cur_audiofmt,
						   NULL);

601 602
	/* Try to find the best matching audioformat. */
	list_for_each_entry(fp, &sync_subs->fmt_list, list) {
603 604
		int score = match_endpoint_audioformats(subs,
							fp, subs->cur_audiofmt,
605 606 607 608 609 610 611 612 613
			subs->cur_rate, subs->pcm_format);

		if (score > cur_score) {
			sync_fp = fp;
			cur_score = score;
		}
	}

	if (unlikely(sync_fp == NULL)) {
614 615
		dev_err(&subs->dev->dev,
			"%s: no valid audioformat for sync ep %x found\n",
616 617 618 619 620 621 622 623 624 625 626
			__func__, sync_subs->ep_num);
		return -EINVAL;
	}

	/*
	 * Recalculate the period bytes if channel number differ between
	 * data and sync ep audioformat.
	 */
	if (sync_fp->channels != subs->channels) {
		sync_period_bytes = (subs->period_bytes / subs->channels) *
			sync_fp->channels;
627 628
		dev_dbg(&subs->dev->dev,
			"%s: adjusted sync ep period bytes (%d -> %d)\n",
629 630 631 632 633 634 635
			__func__, subs->period_bytes, sync_period_bytes);
	}

	ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
					  subs->pcm_format,
					  sync_fp->channels,
					  sync_period_bytes,
636
					  0, 0,
637 638 639 640 641 642 643
					  subs->cur_rate,
					  sync_fp,
					  NULL);

	return ret;
}

644 645 646 647 648 649 650 651 652 653
/*
 * configure endpoint params
 *
 * called  during initial setup and upon resume
 */
static int configure_endpoint(struct snd_usb_substream *subs)
{
	int ret;

	/* format changed */
654
	stop_endpoints(subs, true);
655 656 657 658
	ret = snd_usb_endpoint_set_params(subs->data_endpoint,
					  subs->pcm_format,
					  subs->channels,
					  subs->period_bytes,
659 660
					  subs->period_frames,
					  subs->buffer_periods,
661 662 663 664
					  subs->cur_rate,
					  subs->cur_audiofmt,
					  subs->sync_endpoint);
	if (ret < 0)
665
		return ret;
666 667

	if (subs->sync_endpoint)
668 669
		ret = configure_sync_endpoint(subs);

670 671 672
	return ret;
}

Daniel Mack's avatar
Daniel Mack committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
/*
 * hw_params callback
 *
 * allocate a buffer and set the given audio format.
 *
 * so far we use a physically linear buffer although packetize transfer
 * doesn't need a continuous area.
 * if sg buffer is supported on the later version of alsa, we'll follow
 * that.
 */
static int snd_usb_hw_params(struct snd_pcm_substream *substream,
			     struct snd_pcm_hw_params *hw_params)
{
	struct snd_usb_substream *subs = substream->runtime->private_data;
	struct audioformat *fmt;
688
	int ret;
Daniel Mack's avatar
Daniel Mack committed
689 690 691 692 693 694

	ret = snd_pcm_lib_alloc_vmalloc_buffer(substream,
					       params_buffer_bytes(hw_params));
	if (ret < 0)
		return ret;

695 696
	subs->pcm_format = params_format(hw_params);
	subs->period_bytes = params_period_bytes(hw_params);
697 698
	subs->period_frames = params_period_size(hw_params);
	subs->buffer_periods = params_periods(hw_params);
699 700 701 702
	subs->channels = params_channels(hw_params);
	subs->cur_rate = params_rate(hw_params);

	fmt = find_format(subs);
Daniel Mack's avatar
Daniel Mack committed
703
	if (!fmt) {
704 705
		dev_dbg(&subs->dev->dev,
			"cannot set format: format = %#x, rate = %d, channels = %d\n",
706
			   subs->pcm_format, subs->cur_rate, subs->channels);
Daniel Mack's avatar
Daniel Mack committed
707 708 709
		return -EINVAL;
	}

710
	down_read(&subs->stream->chip->shutdown_rwsem);
711 712 713 714
	if (subs->stream->chip->shutdown)
		ret = -ENODEV;
	else
		ret = set_format(subs, fmt);
715
	up_read(&subs->stream->chip->shutdown_rwsem);
716
	if (ret < 0)
Daniel Mack's avatar
Daniel Mack committed
717 718
		return ret;

719 720
	subs->interface = fmt->iface;
	subs->altset_idx = fmt->altset_idx;
721
	subs->need_setup_ep = true;
722

723
	return 0;
Daniel Mack's avatar
Daniel Mack committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737
}

/*
 * hw_free callback
 *
 * reset the audio format and release the buffer
 */
static int snd_usb_hw_free(struct snd_pcm_substream *substream)
{
	struct snd_usb_substream *subs = substream->runtime->private_data;

	subs->cur_audiofmt = NULL;
	subs->cur_rate = 0;
	subs->period_bytes = 0;
738
	down_read(&subs->stream->chip->shutdown_rwsem);
739
	if (!subs->stream->chip->shutdown) {
740
		stop_endpoints(subs, true);
741 742
		snd_usb_endpoint_deactivate(subs->sync_endpoint);
		snd_usb_endpoint_deactivate(subs->data_endpoint);
743
	}
744
	up_read(&subs->stream->chip->shutdown_rwsem);
Daniel Mack's avatar
Daniel Mack committed
745 746 747 748 749 750 751 752 753 754 755 756
	return snd_pcm_lib_free_vmalloc_buffer(substream);
}

/*
 * prepare callback
 *
 * only a few subtle things...
 */
static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
{
	struct snd_pcm_runtime *runtime = substream->runtime;
	struct snd_usb_substream *subs = runtime->private_data;
757 758 759
	struct usb_host_interface *alts;
	struct usb_interface *iface;
	int ret;
Daniel Mack's avatar
Daniel Mack committed
760 761

	if (! subs->cur_audiofmt) {
762
		dev_err(&subs->dev->dev, "no format is specified!\n");
Daniel Mack's avatar
Daniel Mack committed
763 764 765
		return -ENXIO;
	}

766
	down_read(&subs->stream->chip->shutdown_rwsem);
767 768 769 770 771 772 773 774
	if (subs->stream->chip->shutdown) {
		ret = -ENODEV;
		goto unlock;
	}
	if (snd_BUG_ON(!subs->data_endpoint)) {
		ret = -EIO;
		goto unlock;
	}
775

776 777 778
	snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
	snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);

779 780
	ret = set_format(subs, subs->cur_audiofmt);
	if (ret < 0)
781
		goto unlock;
782 783 784 785 786 787 788 789 790

	iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
	alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
	ret = snd_usb_init_sample_rate(subs->stream->chip,
				       subs->cur_audiofmt->iface,
				       alts,
				       subs->cur_audiofmt,
				       subs->cur_rate);
	if (ret < 0)
791
		goto unlock;
792

793 794 795
	if (subs->need_setup_ep) {
		ret = configure_endpoint(subs);
		if (ret < 0)
796
			goto unlock;
797 798
		subs->need_setup_ep = false;
	}
799

Daniel Mack's avatar
Daniel Mack committed
800
	/* some unit conversions in runtime */
801 802 803 804
	subs->data_endpoint->maxframesize =
		bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
	subs->data_endpoint->curframesize =
		bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
Daniel Mack's avatar
Daniel Mack committed
805 806 807 808

	/* reset the pointer */
	subs->hwptr_done = 0;
	subs->transfer_done = 0;
809 810
	subs->last_delay = 0;
	subs->last_frame_number = 0;
Daniel Mack's avatar
Daniel Mack committed
811 812
	runtime->delay = 0;

813 814 815
	/* for playback, submit the URBs now; otherwise, the first hwptr_done
	 * updates for all URBs would happen at the same time when starting */
	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
816
		ret = start_endpoints(subs, true);
817

818
 unlock:
819
	up_read(&subs->stream->chip->shutdown_rwsem);
820
	return ret;
Daniel Mack's avatar
Daniel Mack committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
}

static struct snd_pcm_hardware snd_usb_hardware =
{
	.info =			SNDRV_PCM_INFO_MMAP |
				SNDRV_PCM_INFO_MMAP_VALID |
				SNDRV_PCM_INFO_BATCH |
				SNDRV_PCM_INFO_INTERLEAVED |
				SNDRV_PCM_INFO_BLOCK_TRANSFER |
				SNDRV_PCM_INFO_PAUSE,
	.buffer_bytes_max =	1024 * 1024,
	.period_bytes_min =	64,
	.period_bytes_max =	512 * 1024,
	.periods_min =		2,
	.periods_max =		1024,
};

static int hw_check_valid_format(struct snd_usb_substream *subs,
				 struct snd_pcm_hw_params *params,
				 struct audioformat *fp)
{
	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
	struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
	struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
	struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
846
	struct snd_mask check_fmts;
Daniel Mack's avatar
Daniel Mack committed
847 848 849
	unsigned int ptime;

	/* check the format */
850 851 852 853 854
	snd_mask_none(&check_fmts);
	check_fmts.bits[0] = (u32)fp->formats;
	check_fmts.bits[1] = (u32)(fp->formats >> 32);
	snd_mask_intersect(&check_fmts, fmts);
	if (snd_mask_empty(&check_fmts)) {
Daniel Mack's avatar
Daniel Mack committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
		hwc_debug("   > check: no supported format %d\n", fp->format);
		return 0;
	}
	/* check the channels */
	if (fp->channels < ct->min || fp->channels > ct->max) {
		hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
		return 0;
	}
	/* check the rate is within the range */
	if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
		hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
		return 0;
	}
	if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
		hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
		return 0;
	}
	/* check whether the period time is >= the data packet interval */
873
	if (subs->speed != USB_SPEED_FULL) {
Daniel Mack's avatar
Daniel Mack committed
874 875 876 877 878 879 880 881 882 883 884 885 886
		ptime = 125 * (1 << fp->datainterval);
		if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
			hwc_debug("   > check: ptime %u > max %u\n", ptime, pt->max);
			return 0;
		}
	}
	return 1;
}

static int hw_rule_rate(struct snd_pcm_hw_params *params,
			struct snd_pcm_hw_rule *rule)
{
	struct snd_usb_substream *subs = rule->private;
887
	struct audioformat *fp;
Daniel Mack's avatar
Daniel Mack committed
888 889 890 891 892 893 894
	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
	unsigned int rmin, rmax;
	int changed;

	hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
	changed = 0;
	rmin = rmax = 0;
895
	list_for_each_entry(fp, &subs->fmt_list, list) {
Daniel Mack's avatar
Daniel Mack committed
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
		if (!hw_check_valid_format(subs, params, fp))
			continue;
		if (changed++) {
			if (rmin > fp->rate_min)
				rmin = fp->rate_min;
			if (rmax < fp->rate_max)
				rmax = fp->rate_max;
		} else {
			rmin = fp->rate_min;
			rmax = fp->rate_max;
		}
	}

	if (!changed) {
		hwc_debug("  --> get empty\n");
		it->empty = 1;
		return -EINVAL;
	}

	changed = 0;
	if (it->min < rmin) {
		it->min = rmin;
		it->openmin = 0;
		changed = 1;
	}
	if (it->max > rmax) {
		it->max = rmax;
		it->openmax = 0;
		changed = 1;
	}
	if (snd_interval_checkempty(it)) {
		it->empty = 1;
		return -EINVAL;
	}
	hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
	return changed;
}


static int hw_rule_channels(struct snd_pcm_hw_params *params,
			    struct snd_pcm_hw_rule *rule)
{
	struct snd_usb_substream *subs = rule->private;
939
	struct audioformat *fp;
Daniel Mack's avatar
Daniel Mack committed
940 941 942 943 944 945 946
	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
	unsigned int rmin, rmax;
	int changed;

	hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
	changed = 0;
	rmin = rmax = 0;
947
	list_for_each_entry(fp, &subs->fmt_list, list) {
Daniel Mack's avatar
Daniel Mack committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
		if (!hw_check_valid_format(subs, params, fp))
			continue;
		if (changed++) {
			if (rmin > fp->channels)
				rmin = fp->channels;
			if (rmax < fp->channels)
				rmax = fp->channels;
		} else {
			rmin = fp->channels;
			rmax = fp->channels;
		}
	}

	if (!changed) {
		hwc_debug("  --> get empty\n");
		it->empty = 1;
		return -EINVAL;
	}

	changed = 0;
	if (it->min < rmin) {
		it->min = rmin;
		it->openmin = 0;
		changed = 1;
	}
	if (it->max > rmax) {
		it->max = rmax;
		it->openmax = 0;
		changed = 1;
	}
	if (snd_interval_checkempty(it)) {
		it->empty = 1;
		return -EINVAL;
	}
	hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
	return changed;
}

static int hw_rule_format(struct snd_pcm_hw_params *params,
			  struct snd_pcm_hw_rule *rule)
{
	struct snd_usb_substream *subs = rule->private;
990
	struct audioformat *fp;
Daniel Mack's avatar
Daniel Mack committed
991 992 993 994 995 996 997
	struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
	u64 fbits;
	u32 oldbits[2];
	int changed;

	hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
	fbits = 0;
998
	list_for_each_entry(fp, &subs->fmt_list, list) {
Daniel Mack's avatar
Daniel Mack committed
999 1000
		if (!hw_check_valid_format(subs, params, fp))
			continue;
1001
		fbits |= fp->formats;
Daniel Mack's avatar
Daniel Mack committed
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
	}

	oldbits[0] = fmt->bits[0];
	oldbits[1] = fmt->bits[1];
	fmt->bits[0] &= (u32)fbits;
	fmt->bits[1] &= (u32)(fbits >> 32);
	if (!fmt->bits[0] && !fmt->bits[1]) {
		hwc_debug("  --> get empty\n");
		return -EINVAL;
	}
	changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
	hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
	return changed;
}

static int hw_rule_period_time(struct snd_pcm_hw_params *params,
			       struct snd_pcm_hw_rule *rule)
{
	struct snd_usb_substream *subs = rule->private;
	struct audioformat *fp;
	struct snd_interval *it;
	unsigned char min_datainterval;
	unsigned int pmin;
	int changed;

	it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
	hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
	min_datainterval = 0xff;
	list_for_each_entry(fp, &subs->fmt_list, list) {
		if (!hw_check_valid_format(subs, params, fp))
			continue;
		min_datainterval = min(min_datainterval, fp->datainterval);
	}
	if (min_datainterval == 0xff) {
1036
		hwc_debug("  --> get empty\n");
Daniel Mack's avatar
Daniel Mack committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
		it->empty = 1;
		return -EINVAL;
	}
	pmin = 125 * (1 << min_datainterval);
	changed = 0;
	if (it->min < pmin) {
		it->min = pmin;
		it->openmin = 0;
		changed = 1;
	}
	if (snd_interval_checkempty(it)) {
		it->empty = 1;
		return -EINVAL;
	}
	hwc_debug("  --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
	return changed;
}

/*
 *  If the device supports unusual bit rates, does the request meet these?
 */
static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
				  struct snd_usb_substream *subs)
{
	struct audioformat *fp;
1062
	int *rate_list;
Daniel Mack's avatar
Daniel Mack committed
1063 1064 1065
	int count = 0, needs_knot = 0;
	int err;

1066 1067 1068
	kfree(subs->rate_list.list);
	subs->rate_list.list = NULL;

Daniel Mack's avatar
Daniel Mack committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	list_for_each_entry(fp, &subs->fmt_list, list) {
		if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
			return 0;
		count += fp->nr_rates;
		if (fp->rates & SNDRV_PCM_RATE_KNOT)
			needs_knot = 1;
	}
	if (!needs_knot)
		return 0;

1079 1080
	subs->rate_list.list = rate_list =
		kmalloc(sizeof(int) * count, GFP_KERNEL);
1081 1082 1083
	if (!subs->rate_list.list)
		return -ENOMEM;
	subs->rate_list.count = count;
Daniel Mack's avatar
Daniel Mack committed
1084 1085 1086 1087 1088
	subs->rate_list.mask = 0;
	count = 0;
	list_for_each_entry(fp, &subs->fmt_list, list) {
		int i;
		for (i = 0; i < fp->nr_rates; i++)
1089
			rate_list[count++] = fp->rate_table[i];
Daniel Mack's avatar
Daniel Mack committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	}
	err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
					 &subs->rate_list);
	if (err < 0)
		return err;

	return 0;
}


/*
 * set up the runtime hardware information.
 */

static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
{
1106
	struct audioformat *fp;
Daniel Mack's avatar
Daniel Mack committed
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	unsigned int pt, ptmin;
	int param_period_time_if_needed;
	int err;

	runtime->hw.formats = subs->formats;

	runtime->hw.rate_min = 0x7fffffff;
	runtime->hw.rate_max = 0;
	runtime->hw.channels_min = 256;
	runtime->hw.channels_max = 0;
	runtime->hw.rates = 0;
	ptmin = UINT_MAX;
	/* check min/max rates and channels */
1120
	list_for_each_entry(fp, &subs->fmt_list, list) {
Daniel Mack's avatar
Daniel Mack committed
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
		runtime->hw.rates |= fp->rates;
		if (runtime->hw.rate_min > fp->rate_min)
			runtime->hw.rate_min = fp->rate_min;
		if (runtime->hw.rate_max < fp->rate_max)
			runtime->hw.rate_max = fp->rate_max;
		if (runtime->hw.channels_min > fp->channels)
			runtime->hw.channels_min = fp->channels;
		if (runtime->hw.channels_max < fp->channels)
			runtime->hw.channels_max = fp->channels;
		if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
			/* FIXME: there might be more than one audio formats... */
			runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
				fp->frame_size;
		}
		pt = 125 * (1 << fp->datainterval);
		ptmin = min(ptmin, pt);
	}
1138 1139 1140
	err = snd_usb_autoresume(subs->stream->chip);
	if (err < 0)
		return err;
Daniel Mack's avatar
Daniel Mack committed
1141 1142

	param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1143
	if (subs->speed == USB_SPEED_FULL)
Daniel Mack's avatar
Daniel Mack committed
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
		/* full speed devices have fixed data packet interval */
		ptmin = 1000;
	if (ptmin == 1000)
		/* if period time doesn't go below 1 ms, no rules needed */
		param_period_time_if_needed = -1;
	snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
				     ptmin, UINT_MAX);

	if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
				       hw_rule_rate, subs,
				       SNDRV_PCM_HW_PARAM_FORMAT,
				       SNDRV_PCM_HW_PARAM_CHANNELS,
				       param_period_time_if_needed,
				       -1)) < 0)
1158
		goto rep_err;
Daniel Mack's avatar
Daniel Mack committed
1159 1160 1161 1162 1163 1164
	if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
				       hw_rule_channels, subs,
				       SNDRV_PCM_HW_PARAM_FORMAT,
				       SNDRV_PCM_HW_PARAM_RATE,
				       param_period_time_if_needed,
				       -1)) < 0)
1165
		goto rep_err;
Daniel Mack's avatar
Daniel Mack committed
1166 1167 1168 1169 1170 1171
	if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
				       hw_rule_format, subs,
				       SNDRV_PCM_HW_PARAM_RATE,
				       SNDRV_PCM_HW_PARAM_CHANNELS,
				       param_period_time_if_needed,
				       -1)) < 0)
1172
		goto rep_err;
Daniel Mack's avatar
Daniel Mack committed
1173 1174 1175 1176 1177 1178 1179 1180 1181
	if (param_period_time_if_needed >= 0) {
		err = snd_pcm_hw_rule_add(runtime, 0,
					  SNDRV_PCM_HW_PARAM_PERIOD_TIME,
					  hw_rule_period_time, subs,
					  SNDRV_PCM_HW_PARAM_FORMAT,
					  SNDRV_PCM_HW_PARAM_CHANNELS,
					  SNDRV_PCM_HW_PARAM_RATE,
					  -1);
		if (err < 0)
1182
			goto rep_err;
Daniel Mack's avatar
Daniel Mack committed
1183 1184
	}
	if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1185
		goto rep_err;
Daniel Mack's avatar
Daniel Mack committed
1186
	return 0;
1187 1188 1189 1190

rep_err:
	snd_usb_autosuspend(subs->stream->chip);
	return err;
Daniel Mack's avatar
Daniel Mack committed
1191 1192 1193 1194 1195 1196 1197 1198 1199
}

static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
{
	struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
	struct snd_pcm_runtime *runtime = substream->runtime;
	struct snd_usb_substream *subs = &as->substream[direction];

	subs->interface = -1;
1200
	subs->altset_idx = 0;
Daniel Mack's avatar
Daniel Mack committed
1201 1202 1203
	runtime->hw = snd_usb_hardware;
	runtime->private_data = subs;
	subs->pcm_substream = substream;
1204
	/* runtime PM is also done there */
1205 1206 1207 1208 1209 1210

	/* initialize DSD/DOP context */
	subs->dsd_dop.byte_idx = 0;
	subs->dsd_dop.channel = 0;
	subs->dsd_dop.marker = 1;

Daniel Mack's avatar
Daniel Mack committed
1211 1212 1213 1214 1215 1216 1217 1218
	return setup_hw_info(runtime, subs);
}

static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
{
	struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
	struct snd_usb_substream *subs = &as->substream[direction];

1219
	stop_endpoints(subs, true);
1220 1221 1222 1223 1224 1225

	if (!as->chip->shutdown && subs->interface >= 0) {
		usb_set_interface(subs->dev, subs->interface, 0);
		subs->interface = -1;
	}

Daniel Mack's avatar
Daniel Mack committed
1226
	subs->pcm_substream = NULL;
1227
	snd_usb_autosuspend(subs->stream->chip);
1228

1229
	return 0;
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
}

/* Since a URB can handle only a single linear buffer, we must use double
 * buffering when the data to be transferred overflows the buffer boundary.
 * To avoid inconsistencies when updating hwptr_done, we use double buffering
 * for all URBs.
 */
static void retire_capture_urb(struct snd_usb_substream *subs,
			       struct urb *urb)
{
	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
	unsigned int stride, frames, bytes, oldptr;
	int i, period_elapsed = 0;
	unsigned long flags;
	unsigned char *cp;
1245 1246 1247 1248
	int current_frame_number;

	/* read frame number here, update pointer in critical section */
	current_frame_number = usb_get_current_frame_number(subs->dev);
1249 1250 1251 1252

	stride = runtime->frame_bits >> 3;

	for (i = 0; i < urb->number_of_packets; i++) {
1253
		cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1254
		if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1255 1256
			dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
				i, urb->iso_frame_desc[i].status);
1257 1258 1259 1260 1261 1262 1263 1264 1265
			// continue;
		}
		bytes = urb->iso_frame_desc[i].actual_length;
		frames = bytes / stride;
		if (!subs->txfr_quirk)
			bytes = frames * stride;
		if (bytes % (runtime->sample_bits >> 3) != 0) {
			int oldbytes = bytes;
			bytes = frames * stride;
1266 1267
			dev_warn(&subs->dev->dev,
				 "Corrected urb data len. %d->%d\n",
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
							oldbytes, bytes);
		}
		/* update the current pointer */
		spin_lock_irqsave(&subs->lock, flags);
		oldptr = subs->hwptr_done;
		subs->hwptr_done += bytes;
		if (subs->hwptr_done >= runtime->buffer_size * stride)
			subs->hwptr_done -= runtime->buffer_size * stride;
		frames = (bytes + (oldptr % stride)) / stride;
		subs->transfer_done += frames;
		if (subs->transfer_done >= runtime->period_size) {
			subs->transfer_done -= runtime->period_size;
			period_elapsed = 1;
		}
1282 1283 1284 1285 1286 1287 1288 1289 1290
		/* capture delay is by construction limited to one URB,
		 * reset delays here
		 */
		runtime->delay = subs->last_delay = 0;

		/* realign last_frame_number */
		subs->last_frame_number = current_frame_number;
		subs->last_frame_number &= 0xFF; /* keep 8 LSBs */

1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
		spin_unlock_irqrestore(&subs->lock, flags);
		/* copy a data chunk */
		if (oldptr + bytes > runtime->buffer_size * stride) {
			unsigned int bytes1 =
					runtime->buffer_size * stride - oldptr;
			memcpy(runtime->dma_area + oldptr, cp, bytes1);
			memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
		} else {
			memcpy(runtime->dma_area + oldptr, cp, bytes);
		}
	}

	if (period_elapsed)
		snd_pcm_period_elapsed(subs->pcm_substream);
}

1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
					     struct urb *urb, unsigned int bytes)
{
	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
	unsigned int stride = runtime->frame_bits >> 3;
	unsigned int dst_idx = 0;
	unsigned int src_idx = subs->hwptr_done;
	unsigned int wrap = runtime->buffer_size * stride;
	u8 *dst = urb->transfer_buffer;
	u8 *src = runtime->dma_area;
	u8 marker[] = { 0x05, 0xfa };

	/*
	 * The DSP DOP format defines a way to transport DSD samples over
	 * normal PCM data endpoints. It requires stuffing of marker bytes
	 * (0x05 and 0xfa, alternating per sample frame), and then expects
	 * 2 additional bytes of actual payload. The whole frame is stored
	 * LSB.
	 *
	 * Hence, for a stereo transport, the buffer layout looks like this,
	 * where L refers to left channel samples and R to right.
	 *
	 *   L1 L2 0x05   R1 R2 0x05   L3 L4 0xfa  R3 R4 0xfa
	 *   L5 L6 0x05   R5 R6 0x05   L7 L8 0xfa  R7 R8 0xfa
	 *   .....
	 *
	 */

	while (bytes--) {
		if (++subs->dsd_dop.byte_idx == 3) {
			/* frame boundary? */
			dst[dst_idx++] = marker[subs->dsd_dop.marker];
			src_idx += 2;
			subs->dsd_dop.byte_idx = 0;

			if (++subs->dsd_dop.channel % runtime->channels == 0) {
				/* alternate the marker */
				subs->dsd_dop.marker++;
				subs->dsd_dop.marker %= ARRAY_SIZE(marker);
				subs->dsd_dop.channel = 0;
			}
		} else {
			/* stuff the DSD payload */
			int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1351 1352 1353 1354 1355 1356

			if (subs->cur_audiofmt->dsd_bitrev)
				dst[dst_idx++] = bitrev8(src[idx]);
			else
				dst[dst_idx++] = src[idx];

1357 1358 1359 1360 1361
			subs->hwptr_done++;
		}
	}
}

1362 1363 1364 1365
static void prepare_playback_urb(struct snd_usb_substream *subs,
				 struct urb *urb)
{
	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1366
	struct snd_usb_endpoint *ep = subs->data_endpoint;
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
	struct snd_urb_ctx *ctx = urb->context;
	unsigned int counts, frames, bytes;
	int i, stride, period_elapsed = 0;
	unsigned long flags;

	stride = runtime->frame_bits >> 3;

	frames = 0;
	urb->number_of_packets = 0;
	spin_lock_irqsave(&subs->lock, flags);
1377
	subs->frame_limit += ep->max_urb_frames;
1378
	for (i = 0; i < ctx->packets; i++) {
1379 1380 1381 1382 1383
		if (ctx->packet_size[i])
			counts = ctx->packet_size[i];
		else
			counts = snd_usb_endpoint_next_packet_size(ep);

1384
		/* set up descriptor */
1385 1386
		urb->iso_frame_desc[i].offset = frames * ep->stride;
		urb->iso_frame_desc[i].length = counts * ep->stride;
1387 1388 1389 1390 1391
		frames += counts;
		urb->number_of_packets++;
		subs->transfer_done += counts;
		if (subs->transfer_done >= runtime->period_size) {
			subs->transfer_done -= runtime->period_size;
1392
			subs->frame_limit = 0;
1393 1394 1395 1396 1397 1398 1399 1400
			period_elapsed = 1;
			if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
				if (subs->transfer_done > 0) {
					/* FIXME: fill-max mode is not
					 * supported yet */
					frames -= subs->transfer_done;
					counts -= subs->transfer_done;
					urb->iso_frame_desc[i].length =
1401
						counts * ep->stride;
1402 1403 1404 1405 1406 1407
					subs->transfer_done = 0;
				}
				i++;
				if (i < ctx->packets) {
					/* add a transfer delimiter */
					urb->iso_frame_desc[i].offset =
1408
						frames * ep->stride;
1409 1410 1411 1412 1413 1414
					urb->iso_frame_desc[i].length = 0;
					urb->number_of_packets++;
				}
				break;
			}
		}
1415 1416 1417 1418
		/* finish at the period boundary or after enough frames */
		if ((period_elapsed ||
				subs->transfer_done >= subs->frame_limit) &&
		    !snd_usb_endpoint_implicit_feedback_sink(ep))
1419 1420
			break;
	}
1421
	bytes = frames * ep->stride;
1422 1423 1424 1425

	if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
		     subs->cur_audiofmt->dsd_dop)) {
		fill_playback_urb_dsd_dop(subs, urb, bytes);
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
	} else if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U8 &&
			   subs->cur_audiofmt->dsd_bitrev)) {
		/* bit-reverse the bytes */
		u8 *buf = urb->transfer_buffer;
		for (i = 0; i < bytes; i++) {
			int idx = (subs->hwptr_done + i)
				% (runtime->buffer_size * stride);
			buf[i] = bitrev8(runtime->dma_area[idx]);
		}

		subs->hwptr_done += bytes;
1437
	} else {
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
		/* usual PCM */
		if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
			/* err, the transferred area goes over buffer boundary. */
			unsigned int bytes1 =
				runtime->buffer_size * stride - subs->hwptr_done;
			memcpy(urb->transfer_buffer,
			       runtime->dma_area + subs->hwptr_done, bytes1);
			memcpy(urb->transfer_buffer + bytes1,
			       runtime->dma_area, bytes - bytes1);
		} else {
			memcpy(urb->transfer_buffer,
			       runtime->dma_area + subs->hwptr_done, bytes);
		}

		subs->hwptr_done += bytes;
1453
	}
1454

1455 1456
	if (subs->hwptr_done >= runtime->buffer_size * stride)
		subs->hwptr_done -= runtime->buffer_size * stride;
1457 1458 1459

	/* update delay with exact number of samples queued */
	runtime->delay = subs->last_delay;
1460
	runtime->delay += frames;
1461 1462 1463 1464 1465 1466
	subs->last_delay = runtime->delay;

	/* realign last_frame_number */
	subs->last_frame_number = usb_get_current_frame_number(subs->dev);
	subs->last_frame_number &= 0xFF; /* keep 8 LSBs */

1467 1468 1469 1470 1471 1472 1473 1474
	if (subs->trigger_tstamp_pending_update) {
		/* this is the first actual URB submitted,
		 * update trigger timestamp to reflect actual start time
		 */
		snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
		subs->trigger_tstamp_pending_update = false;
	}

1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
	spin_unlock_irqrestore(&subs->lock, flags);
	urb->transfer_buffer_length = bytes;
	if (period_elapsed)
		snd_pcm_period_elapsed(subs->pcm_substream);
}

/*
 * process after playback data complete
 * - decrease the delay count again
 */
static void retire_playback_urb(struct snd_usb_substream *subs,
			       struct urb *urb)
{
	unsigned long flags;
	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1490 1491
	struct snd_usb_endpoint *ep = subs->data_endpoint;
	int processed = urb->transfer_buffer_length / ep->stride;
1492
	int est_delay;
1493

1494 1495 1496 1497 1498 1499
	/* ignore the delay accounting when procssed=0 is given, i.e.
	 * silent payloads are procssed before handling the actual data
	 */
	if (!processed)
		return;

1500
	spin_lock_irqsave(&subs->lock, flags);
1501 1502 1503
	if (!subs->last_delay)
		goto out; /* short path */

1504 1505 1506 1507
	est_delay = snd_usb_pcm_delay(subs, runtime->rate);
	/* update delay with exact number of samples played */
	if (processed > subs->last_delay)
		subs->last_delay = 0;
1508
	else
1509 1510 1511 1512 1513 1514 1515 1516
		subs->last_delay -= processed;
	runtime->delay = subs->last_delay;

	/*
	 * Report when delay estimate is off by more than 2ms.
	 * The error should be lower than 2ms since the estimate relies
	 * on two reads of a counter updated every ms.
	 */
<