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