xref: /openbmc/linux/sound/usb/pcm.c (revision 44c2cd80)
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)
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);
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);
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);
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))
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))
576 			sync_pending_stops(subs);
577 		close_endpoints(chip, subs);
578 		snd_usb_unlock_shutdown(chip);
579 	}
580 
581 	return 0;
582 }
583 
584 /*
585  * prepare callback
586  *
587  * only a few subtle things...
588  */
589 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
590 {
591 	struct snd_pcm_runtime *runtime = substream->runtime;
592 	struct snd_usb_substream *subs = runtime->private_data;
593 	struct snd_usb_audio *chip = subs->stream->chip;
594 	int ret;
595 
596 	ret = snd_usb_lock_shutdown(chip);
597 	if (ret < 0)
598 		return ret;
599 	if (snd_BUG_ON(!subs->data_endpoint)) {
600 		ret = -EIO;
601 		goto unlock;
602 	}
603 
604 	ret = configure_endpoints(chip, subs);
605 	if (ret < 0)
606 		goto unlock;
607 
608 	/* reset the pointer */
609 	subs->buffer_bytes = frames_to_bytes(runtime, runtime->buffer_size);
610 	subs->inflight_bytes = 0;
611 	subs->hwptr_done = 0;
612 	subs->transfer_done = 0;
613 	subs->last_frame_number = 0;
614 	runtime->delay = 0;
615 
616 	/* for playback, submit the URBs now; otherwise, the first hwptr_done
617 	 * updates for all URBs would happen at the same time when starting */
618 	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
619 		ret = start_endpoints(subs);
620 
621  unlock:
622 	snd_usb_unlock_shutdown(chip);
623 	return ret;
624 }
625 
626 /*
627  * h/w constraints
628  */
629 
630 #ifdef HW_CONST_DEBUG
631 #define hwc_debug(fmt, args...) pr_debug(fmt, ##args)
632 #else
633 #define hwc_debug(fmt, args...) do { } while(0)
634 #endif
635 
636 static const struct snd_pcm_hardware snd_usb_hardware =
637 {
638 	.info =			SNDRV_PCM_INFO_MMAP |
639 				SNDRV_PCM_INFO_MMAP_VALID |
640 				SNDRV_PCM_INFO_BATCH |
641 				SNDRV_PCM_INFO_INTERLEAVED |
642 				SNDRV_PCM_INFO_BLOCK_TRANSFER |
643 				SNDRV_PCM_INFO_PAUSE,
644 	.channels_min =		1,
645 	.channels_max =		256,
646 	.buffer_bytes_max =	1024 * 1024,
647 	.period_bytes_min =	64,
648 	.period_bytes_max =	512 * 1024,
649 	.periods_min =		2,
650 	.periods_max =		1024,
651 };
652 
653 static int hw_check_valid_format(struct snd_usb_substream *subs,
654 				 struct snd_pcm_hw_params *params,
655 				 const struct audioformat *fp)
656 {
657 	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
658 	struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
659 	struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
660 	struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
661 	struct snd_mask check_fmts;
662 	unsigned int ptime;
663 
664 	/* check the format */
665 	snd_mask_none(&check_fmts);
666 	check_fmts.bits[0] = (u32)fp->formats;
667 	check_fmts.bits[1] = (u32)(fp->formats >> 32);
668 	snd_mask_intersect(&check_fmts, fmts);
669 	if (snd_mask_empty(&check_fmts)) {
670 		hwc_debug("   > check: no supported format 0x%llx\n", fp->formats);
671 		return 0;
672 	}
673 	/* check the channels */
674 	if (fp->channels < ct->min || fp->channels > ct->max) {
675 		hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
676 		return 0;
677 	}
678 	/* check the rate is within the range */
679 	if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
680 		hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
681 		return 0;
682 	}
683 	if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
684 		hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
685 		return 0;
686 	}
687 	/* check whether the period time is >= the data packet interval */
688 	if (subs->speed != USB_SPEED_FULL) {
689 		ptime = 125 * (1 << fp->datainterval);
690 		if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
691 			hwc_debug("   > check: ptime %u > max %u\n", ptime, pt->max);
692 			return 0;
693 		}
694 	}
695 	return 1;
696 }
697 
698 static int apply_hw_params_minmax(struct snd_interval *it, unsigned int rmin,
699 				  unsigned int rmax)
700 {
701 	int changed;
702 
703 	if (rmin > rmax) {
704 		hwc_debug("  --> get empty\n");
705 		it->empty = 1;
706 		return -EINVAL;
707 	}
708 
709 	changed = 0;
710 	if (it->min < rmin) {
711 		it->min = rmin;
712 		it->openmin = 0;
713 		changed = 1;
714 	}
715 	if (it->max > rmax) {
716 		it->max = rmax;
717 		it->openmax = 0;
718 		changed = 1;
719 	}
720 	if (snd_interval_checkempty(it)) {
721 		it->empty = 1;
722 		return -EINVAL;
723 	}
724 	hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
725 	return changed;
726 }
727 
728 static int hw_rule_rate(struct snd_pcm_hw_params *params,
729 			struct snd_pcm_hw_rule *rule)
730 {
731 	struct snd_usb_substream *subs = rule->private;
732 	const struct audioformat *fp;
733 	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
734 	unsigned int rmin, rmax, r;
735 	int i;
736 
737 	hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
738 	rmin = UINT_MAX;
739 	rmax = 0;
740 	list_for_each_entry(fp, &subs->fmt_list, list) {
741 		if (!hw_check_valid_format(subs, params, fp))
742 			continue;
743 		if (fp->rate_table && fp->nr_rates) {
744 			for (i = 0; i < fp->nr_rates; i++) {
745 				r = fp->rate_table[i];
746 				if (!snd_interval_test(it, r))
747 					continue;
748 				rmin = min(rmin, r);
749 				rmax = max(rmax, r);
750 			}
751 		} else {
752 			rmin = min(rmin, fp->rate_min);
753 			rmax = max(rmax, fp->rate_max);
754 		}
755 	}
756 
757 	return apply_hw_params_minmax(it, rmin, rmax);
758 }
759 
760 
761 static int hw_rule_channels(struct snd_pcm_hw_params *params,
762 			    struct snd_pcm_hw_rule *rule)
763 {
764 	struct snd_usb_substream *subs = rule->private;
765 	const struct audioformat *fp;
766 	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
767 	unsigned int rmin, rmax;
768 
769 	hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
770 	rmin = UINT_MAX;
771 	rmax = 0;
772 	list_for_each_entry(fp, &subs->fmt_list, list) {
773 		if (!hw_check_valid_format(subs, params, fp))
774 			continue;
775 		rmin = min(rmin, fp->channels);
776 		rmax = max(rmax, fp->channels);
777 	}
778 
779 	return apply_hw_params_minmax(it, rmin, rmax);
780 }
781 
782 static int apply_hw_params_format_bits(struct snd_mask *fmt, u64 fbits)
783 {
784 	u32 oldbits[2];
785 	int changed;
786 
787 	oldbits[0] = fmt->bits[0];
788 	oldbits[1] = fmt->bits[1];
789 	fmt->bits[0] &= (u32)fbits;
790 	fmt->bits[1] &= (u32)(fbits >> 32);
791 	if (!fmt->bits[0] && !fmt->bits[1]) {
792 		hwc_debug("  --> get empty\n");
793 		return -EINVAL;
794 	}
795 	changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
796 	hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
797 	return changed;
798 }
799 
800 static int hw_rule_format(struct snd_pcm_hw_params *params,
801 			  struct snd_pcm_hw_rule *rule)
802 {
803 	struct snd_usb_substream *subs = rule->private;
804 	const struct audioformat *fp;
805 	struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
806 	u64 fbits;
807 
808 	hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
809 	fbits = 0;
810 	list_for_each_entry(fp, &subs->fmt_list, list) {
811 		if (!hw_check_valid_format(subs, params, fp))
812 			continue;
813 		fbits |= fp->formats;
814 	}
815 	return apply_hw_params_format_bits(fmt, fbits);
816 }
817 
818 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
819 			       struct snd_pcm_hw_rule *rule)
820 {
821 	struct snd_usb_substream *subs = rule->private;
822 	const struct audioformat *fp;
823 	struct snd_interval *it;
824 	unsigned char min_datainterval;
825 	unsigned int pmin;
826 
827 	it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
828 	hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
829 	min_datainterval = 0xff;
830 	list_for_each_entry(fp, &subs->fmt_list, list) {
831 		if (!hw_check_valid_format(subs, params, fp))
832 			continue;
833 		min_datainterval = min(min_datainterval, fp->datainterval);
834 	}
835 	if (min_datainterval == 0xff) {
836 		hwc_debug("  --> get empty\n");
837 		it->empty = 1;
838 		return -EINVAL;
839 	}
840 	pmin = 125 * (1 << min_datainterval);
841 
842 	return apply_hw_params_minmax(it, pmin, UINT_MAX);
843 }
844 
845 /* get the EP or the sync EP for implicit fb when it's already set up */
846 static const struct snd_usb_endpoint *
847 get_sync_ep_from_substream(struct snd_usb_substream *subs)
848 {
849 	struct snd_usb_audio *chip = subs->stream->chip;
850 	const struct audioformat *fp;
851 	const struct snd_usb_endpoint *ep;
852 
853 	list_for_each_entry(fp, &subs->fmt_list, list) {
854 		ep = snd_usb_get_endpoint(chip, fp->endpoint);
855 		if (ep && ep->cur_audiofmt) {
856 			/* if EP is already opened solely for this substream,
857 			 * we still allow us to change the parameter; otherwise
858 			 * this substream has to follow the existing parameter
859 			 */
860 			if (ep->cur_audiofmt != subs->cur_audiofmt || ep->opened > 1)
861 				return ep;
862 		}
863 		if (!fp->implicit_fb)
864 			continue;
865 		/* for the implicit fb, check the sync ep as well */
866 		ep = snd_usb_get_endpoint(chip, fp->sync_ep);
867 		if (ep && ep->cur_audiofmt)
868 			return ep;
869 	}
870 	return NULL;
871 }
872 
873 /* additional hw constraints for implicit feedback mode */
874 static int hw_rule_format_implicit_fb(struct snd_pcm_hw_params *params,
875 				      struct snd_pcm_hw_rule *rule)
876 {
877 	struct snd_usb_substream *subs = rule->private;
878 	const struct snd_usb_endpoint *ep;
879 	struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
880 
881 	ep = get_sync_ep_from_substream(subs);
882 	if (!ep)
883 		return 0;
884 
885 	hwc_debug("applying %s\n", __func__);
886 	return apply_hw_params_format_bits(fmt, pcm_format_to_bits(ep->cur_format));
887 }
888 
889 static int hw_rule_rate_implicit_fb(struct snd_pcm_hw_params *params,
890 				    struct snd_pcm_hw_rule *rule)
891 {
892 	struct snd_usb_substream *subs = rule->private;
893 	const struct snd_usb_endpoint *ep;
894 	struct snd_interval *it;
895 
896 	ep = get_sync_ep_from_substream(subs);
897 	if (!ep)
898 		return 0;
899 
900 	hwc_debug("applying %s\n", __func__);
901 	it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
902 	return apply_hw_params_minmax(it, ep->cur_rate, ep->cur_rate);
903 }
904 
905 static int hw_rule_period_size_implicit_fb(struct snd_pcm_hw_params *params,
906 					   struct snd_pcm_hw_rule *rule)
907 {
908 	struct snd_usb_substream *subs = rule->private;
909 	const struct snd_usb_endpoint *ep;
910 	struct snd_interval *it;
911 
912 	ep = get_sync_ep_from_substream(subs);
913 	if (!ep)
914 		return 0;
915 
916 	hwc_debug("applying %s\n", __func__);
917 	it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
918 	return apply_hw_params_minmax(it, ep->cur_period_frames,
919 				      ep->cur_period_frames);
920 }
921 
922 static int hw_rule_periods_implicit_fb(struct snd_pcm_hw_params *params,
923 				       struct snd_pcm_hw_rule *rule)
924 {
925 	struct snd_usb_substream *subs = rule->private;
926 	const struct snd_usb_endpoint *ep;
927 	struct snd_interval *it;
928 
929 	ep = get_sync_ep_from_substream(subs);
930 	if (!ep)
931 		return 0;
932 
933 	hwc_debug("applying %s\n", __func__);
934 	it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIODS);
935 	return apply_hw_params_minmax(it, ep->cur_buffer_periods,
936 				      ep->cur_buffer_periods);
937 }
938 
939 /*
940  * set up the runtime hardware information.
941  */
942 
943 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
944 {
945 	const struct audioformat *fp;
946 	unsigned int pt, ptmin;
947 	int param_period_time_if_needed = -1;
948 	int err;
949 
950 	runtime->hw.formats = subs->formats;
951 
952 	runtime->hw.rate_min = 0x7fffffff;
953 	runtime->hw.rate_max = 0;
954 	runtime->hw.channels_min = 256;
955 	runtime->hw.channels_max = 0;
956 	runtime->hw.rates = 0;
957 	ptmin = UINT_MAX;
958 	/* check min/max rates and channels */
959 	list_for_each_entry(fp, &subs->fmt_list, list) {
960 		runtime->hw.rates |= fp->rates;
961 		if (runtime->hw.rate_min > fp->rate_min)
962 			runtime->hw.rate_min = fp->rate_min;
963 		if (runtime->hw.rate_max < fp->rate_max)
964 			runtime->hw.rate_max = fp->rate_max;
965 		if (runtime->hw.channels_min > fp->channels)
966 			runtime->hw.channels_min = fp->channels;
967 		if (runtime->hw.channels_max < fp->channels)
968 			runtime->hw.channels_max = fp->channels;
969 		if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
970 			/* FIXME: there might be more than one audio formats... */
971 			runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
972 				fp->frame_size;
973 		}
974 		pt = 125 * (1 << fp->datainterval);
975 		ptmin = min(ptmin, pt);
976 	}
977 
978 	param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
979 	if (subs->speed == USB_SPEED_FULL)
980 		/* full speed devices have fixed data packet interval */
981 		ptmin = 1000;
982 	if (ptmin == 1000)
983 		/* if period time doesn't go below 1 ms, no rules needed */
984 		param_period_time_if_needed = -1;
985 
986 	err = snd_pcm_hw_constraint_minmax(runtime,
987 					   SNDRV_PCM_HW_PARAM_PERIOD_TIME,
988 					   ptmin, UINT_MAX);
989 	if (err < 0)
990 		return err;
991 
992 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
993 				  hw_rule_rate, subs,
994 				  SNDRV_PCM_HW_PARAM_RATE,
995 				  SNDRV_PCM_HW_PARAM_FORMAT,
996 				  SNDRV_PCM_HW_PARAM_CHANNELS,
997 				  param_period_time_if_needed,
998 				  -1);
999 	if (err < 0)
1000 		return err;
1001 
1002 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1003 				  hw_rule_channels, subs,
1004 				  SNDRV_PCM_HW_PARAM_CHANNELS,
1005 				  SNDRV_PCM_HW_PARAM_FORMAT,
1006 				  SNDRV_PCM_HW_PARAM_RATE,
1007 				  param_period_time_if_needed,
1008 				  -1);
1009 	if (err < 0)
1010 		return err;
1011 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1012 				  hw_rule_format, subs,
1013 				  SNDRV_PCM_HW_PARAM_FORMAT,
1014 				  SNDRV_PCM_HW_PARAM_RATE,
1015 				  SNDRV_PCM_HW_PARAM_CHANNELS,
1016 				  param_period_time_if_needed,
1017 				  -1);
1018 	if (err < 0)
1019 		return err;
1020 	if (param_period_time_if_needed >= 0) {
1021 		err = snd_pcm_hw_rule_add(runtime, 0,
1022 					  SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1023 					  hw_rule_period_time, subs,
1024 					  SNDRV_PCM_HW_PARAM_FORMAT,
1025 					  SNDRV_PCM_HW_PARAM_CHANNELS,
1026 					  SNDRV_PCM_HW_PARAM_RATE,
1027 					  -1);
1028 		if (err < 0)
1029 			return err;
1030 	}
1031 
1032 	/* additional hw constraints for implicit fb */
1033 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1034 				  hw_rule_format_implicit_fb, subs,
1035 				  SNDRV_PCM_HW_PARAM_FORMAT, -1);
1036 	if (err < 0)
1037 		return err;
1038 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1039 				  hw_rule_rate_implicit_fb, subs,
1040 				  SNDRV_PCM_HW_PARAM_RATE, -1);
1041 	if (err < 0)
1042 		return err;
1043 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
1044 				  hw_rule_period_size_implicit_fb, subs,
1045 				  SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
1046 	if (err < 0)
1047 		return err;
1048 	err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
1049 				  hw_rule_periods_implicit_fb, subs,
1050 				  SNDRV_PCM_HW_PARAM_PERIODS, -1);
1051 	if (err < 0)
1052 		return err;
1053 
1054 	return 0;
1055 }
1056 
1057 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1058 {
1059 	int direction = substream->stream;
1060 	struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1061 	struct snd_pcm_runtime *runtime = substream->runtime;
1062 	struct snd_usb_substream *subs = &as->substream[direction];
1063 	int ret;
1064 
1065 	runtime->hw = snd_usb_hardware;
1066 	runtime->private_data = subs;
1067 	subs->pcm_substream = substream;
1068 	/* runtime PM is also done there */
1069 
1070 	/* initialize DSD/DOP context */
1071 	subs->dsd_dop.byte_idx = 0;
1072 	subs->dsd_dop.channel = 0;
1073 	subs->dsd_dop.marker = 1;
1074 
1075 	ret = setup_hw_info(runtime, subs);
1076 	if (ret < 0)
1077 		return ret;
1078 	ret = snd_usb_autoresume(subs->stream->chip);
1079 	if (ret < 0)
1080 		return ret;
1081 	ret = snd_media_stream_init(subs, as->pcm, direction);
1082 	if (ret < 0)
1083 		snd_usb_autosuspend(subs->stream->chip);
1084 	return ret;
1085 }
1086 
1087 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1088 {
1089 	int direction = substream->stream;
1090 	struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1091 	struct snd_usb_substream *subs = &as->substream[direction];
1092 	int ret;
1093 
1094 	snd_media_stop_pipeline(subs);
1095 
1096 	if (!snd_usb_lock_shutdown(subs->stream->chip)) {
1097 		ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1098 		snd_usb_unlock_shutdown(subs->stream->chip);
1099 		if (ret < 0)
1100 			return ret;
1101 	}
1102 
1103 	subs->pcm_substream = NULL;
1104 	snd_usb_autosuspend(subs->stream->chip);
1105 
1106 	return 0;
1107 }
1108 
1109 /* Since a URB can handle only a single linear buffer, we must use double
1110  * buffering when the data to be transferred overflows the buffer boundary.
1111  * To avoid inconsistencies when updating hwptr_done, we use double buffering
1112  * for all URBs.
1113  */
1114 static void retire_capture_urb(struct snd_usb_substream *subs,
1115 			       struct urb *urb)
1116 {
1117 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1118 	unsigned int stride, frames, bytes, oldptr;
1119 	int i, period_elapsed = 0;
1120 	unsigned long flags;
1121 	unsigned char *cp;
1122 	int current_frame_number;
1123 
1124 	/* read frame number here, update pointer in critical section */
1125 	current_frame_number = usb_get_current_frame_number(subs->dev);
1126 
1127 	stride = runtime->frame_bits >> 3;
1128 
1129 	for (i = 0; i < urb->number_of_packets; i++) {
1130 		cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1131 		if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1132 			dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1133 				i, urb->iso_frame_desc[i].status);
1134 			// continue;
1135 		}
1136 		bytes = urb->iso_frame_desc[i].actual_length;
1137 		if (subs->stream_offset_adj > 0) {
1138 			unsigned int adj = min(subs->stream_offset_adj, bytes);
1139 			cp += adj;
1140 			bytes -= adj;
1141 			subs->stream_offset_adj -= adj;
1142 		}
1143 		frames = bytes / stride;
1144 		if (!subs->txfr_quirk)
1145 			bytes = frames * stride;
1146 		if (bytes % (runtime->sample_bits >> 3) != 0) {
1147 			int oldbytes = bytes;
1148 			bytes = frames * stride;
1149 			dev_warn_ratelimited(&subs->dev->dev,
1150 				 "Corrected urb data len. %d->%d\n",
1151 							oldbytes, bytes);
1152 		}
1153 		/* update the current pointer */
1154 		spin_lock_irqsave(&subs->lock, flags);
1155 		oldptr = subs->hwptr_done;
1156 		subs->hwptr_done += bytes;
1157 		if (subs->hwptr_done >= subs->buffer_bytes)
1158 			subs->hwptr_done -= subs->buffer_bytes;
1159 		frames = (bytes + (oldptr % stride)) / stride;
1160 		subs->transfer_done += frames;
1161 		if (subs->transfer_done >= runtime->period_size) {
1162 			subs->transfer_done -= runtime->period_size;
1163 			period_elapsed = 1;
1164 		}
1165 
1166 		/* realign last_frame_number */
1167 		subs->last_frame_number = current_frame_number;
1168 
1169 		spin_unlock_irqrestore(&subs->lock, flags);
1170 		/* copy a data chunk */
1171 		if (oldptr + bytes > subs->buffer_bytes) {
1172 			unsigned int bytes1 = subs->buffer_bytes - oldptr;
1173 
1174 			memcpy(runtime->dma_area + oldptr, cp, bytes1);
1175 			memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1176 		} else {
1177 			memcpy(runtime->dma_area + oldptr, cp, bytes);
1178 		}
1179 	}
1180 
1181 	if (period_elapsed)
1182 		snd_pcm_period_elapsed(subs->pcm_substream);
1183 }
1184 
1185 static void urb_ctx_queue_advance(struct snd_usb_substream *subs,
1186 				  struct urb *urb, unsigned int bytes)
1187 {
1188 	struct snd_urb_ctx *ctx = urb->context;
1189 
1190 	ctx->queued += bytes;
1191 	subs->inflight_bytes += bytes;
1192 	subs->hwptr_done += bytes;
1193 	if (subs->hwptr_done >= subs->buffer_bytes)
1194 		subs->hwptr_done -= subs->buffer_bytes;
1195 }
1196 
1197 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1198 					     struct urb *urb, unsigned int bytes)
1199 {
1200 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1201 	unsigned int dst_idx = 0;
1202 	unsigned int src_idx = subs->hwptr_done;
1203 	unsigned int wrap = subs->buffer_bytes;
1204 	u8 *dst = urb->transfer_buffer;
1205 	u8 *src = runtime->dma_area;
1206 	u8 marker[] = { 0x05, 0xfa };
1207 	unsigned int queued = 0;
1208 
1209 	/*
1210 	 * The DSP DOP format defines a way to transport DSD samples over
1211 	 * normal PCM data endpoints. It requires stuffing of marker bytes
1212 	 * (0x05 and 0xfa, alternating per sample frame), and then expects
1213 	 * 2 additional bytes of actual payload. The whole frame is stored
1214 	 * LSB.
1215 	 *
1216 	 * Hence, for a stereo transport, the buffer layout looks like this,
1217 	 * where L refers to left channel samples and R to right.
1218 	 *
1219 	 *   L1 L2 0x05   R1 R2 0x05   L3 L4 0xfa  R3 R4 0xfa
1220 	 *   L5 L6 0x05   R5 R6 0x05   L7 L8 0xfa  R7 R8 0xfa
1221 	 *   .....
1222 	 *
1223 	 */
1224 
1225 	while (bytes--) {
1226 		if (++subs->dsd_dop.byte_idx == 3) {
1227 			/* frame boundary? */
1228 			dst[dst_idx++] = marker[subs->dsd_dop.marker];
1229 			src_idx += 2;
1230 			subs->dsd_dop.byte_idx = 0;
1231 
1232 			if (++subs->dsd_dop.channel % runtime->channels == 0) {
1233 				/* alternate the marker */
1234 				subs->dsd_dop.marker++;
1235 				subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1236 				subs->dsd_dop.channel = 0;
1237 			}
1238 		} else {
1239 			/* stuff the DSD payload */
1240 			int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1241 
1242 			if (subs->cur_audiofmt->dsd_bitrev)
1243 				dst[dst_idx++] = bitrev8(src[idx]);
1244 			else
1245 				dst[dst_idx++] = src[idx];
1246 			queued++;
1247 		}
1248 	}
1249 
1250 	urb_ctx_queue_advance(subs, urb, queued);
1251 }
1252 
1253 /* copy bit-reversed bytes onto transfer buffer */
1254 static void fill_playback_urb_dsd_bitrev(struct snd_usb_substream *subs,
1255 					 struct urb *urb, unsigned int bytes)
1256 {
1257 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1258 	const u8 *src = runtime->dma_area;
1259 	u8 *buf = urb->transfer_buffer;
1260 	int i, ofs = subs->hwptr_done;
1261 
1262 	for (i = 0; i < bytes; i++) {
1263 		*buf++ = bitrev8(src[ofs]);
1264 		if (++ofs >= subs->buffer_bytes)
1265 			ofs = 0;
1266 	}
1267 
1268 	urb_ctx_queue_advance(subs, urb, bytes);
1269 }
1270 
1271 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1272 			int offset, int stride, unsigned int bytes)
1273 {
1274 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1275 
1276 	if (subs->hwptr_done + bytes > subs->buffer_bytes) {
1277 		/* err, the transferred area goes over buffer boundary. */
1278 		unsigned int bytes1 = subs->buffer_bytes - subs->hwptr_done;
1279 
1280 		memcpy(urb->transfer_buffer + offset,
1281 		       runtime->dma_area + subs->hwptr_done, bytes1);
1282 		memcpy(urb->transfer_buffer + offset + bytes1,
1283 		       runtime->dma_area, bytes - bytes1);
1284 	} else {
1285 		memcpy(urb->transfer_buffer + offset,
1286 		       runtime->dma_area + subs->hwptr_done, bytes);
1287 	}
1288 
1289 	urb_ctx_queue_advance(subs, urb, bytes);
1290 }
1291 
1292 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1293 				      struct urb *urb, int stride,
1294 				      unsigned int bytes)
1295 {
1296 	__le32 packet_length;
1297 	int i;
1298 
1299 	/* Put __le32 length descriptor at start of each packet. */
1300 	for (i = 0; i < urb->number_of_packets; i++) {
1301 		unsigned int length = urb->iso_frame_desc[i].length;
1302 		unsigned int offset = urb->iso_frame_desc[i].offset;
1303 
1304 		packet_length = cpu_to_le32(length);
1305 		offset += i * sizeof(packet_length);
1306 		urb->iso_frame_desc[i].offset = offset;
1307 		urb->iso_frame_desc[i].length += sizeof(packet_length);
1308 		memcpy(urb->transfer_buffer + offset,
1309 		       &packet_length, sizeof(packet_length));
1310 		copy_to_urb(subs, urb, offset + sizeof(packet_length),
1311 			    stride, length);
1312 	}
1313 	/* Adjust transfer size accordingly. */
1314 	bytes += urb->number_of_packets * sizeof(packet_length);
1315 	return bytes;
1316 }
1317 
1318 static void prepare_playback_urb(struct snd_usb_substream *subs,
1319 				 struct urb *urb)
1320 {
1321 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1322 	struct snd_usb_endpoint *ep = subs->data_endpoint;
1323 	struct snd_urb_ctx *ctx = urb->context;
1324 	unsigned int counts, frames, bytes;
1325 	int i, stride, period_elapsed = 0;
1326 	unsigned long flags;
1327 
1328 	stride = ep->stride;
1329 
1330 	frames = 0;
1331 	ctx->queued = 0;
1332 	urb->number_of_packets = 0;
1333 	spin_lock_irqsave(&subs->lock, flags);
1334 	subs->frame_limit += ep->max_urb_frames;
1335 	for (i = 0; i < ctx->packets; i++) {
1336 		counts = snd_usb_endpoint_next_packet_size(ep, ctx, i);
1337 		/* set up descriptor */
1338 		urb->iso_frame_desc[i].offset = frames * stride;
1339 		urb->iso_frame_desc[i].length = counts * stride;
1340 		frames += counts;
1341 		urb->number_of_packets++;
1342 		subs->transfer_done += counts;
1343 		if (subs->transfer_done >= runtime->period_size) {
1344 			subs->transfer_done -= runtime->period_size;
1345 			subs->frame_limit = 0;
1346 			period_elapsed = 1;
1347 			if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1348 				if (subs->transfer_done > 0) {
1349 					/* FIXME: fill-max mode is not
1350 					 * supported yet */
1351 					frames -= subs->transfer_done;
1352 					counts -= subs->transfer_done;
1353 					urb->iso_frame_desc[i].length =
1354 						counts * stride;
1355 					subs->transfer_done = 0;
1356 				}
1357 				i++;
1358 				if (i < ctx->packets) {
1359 					/* add a transfer delimiter */
1360 					urb->iso_frame_desc[i].offset =
1361 						frames * stride;
1362 					urb->iso_frame_desc[i].length = 0;
1363 					urb->number_of_packets++;
1364 				}
1365 				break;
1366 			}
1367 		}
1368 		/* finish at the period boundary or after enough frames */
1369 		if ((period_elapsed ||
1370 				subs->transfer_done >= subs->frame_limit) &&
1371 		    !snd_usb_endpoint_implicit_feedback_sink(ep))
1372 			break;
1373 	}
1374 	bytes = frames * stride;
1375 
1376 	if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1377 		     subs->cur_audiofmt->dsd_dop)) {
1378 		fill_playback_urb_dsd_dop(subs, urb, bytes);
1379 	} else if (unlikely(ep->cur_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1380 			   subs->cur_audiofmt->dsd_bitrev)) {
1381 		fill_playback_urb_dsd_bitrev(subs, urb, bytes);
1382 	} else {
1383 		/* usual PCM */
1384 		if (!subs->tx_length_quirk)
1385 			copy_to_urb(subs, urb, 0, stride, bytes);
1386 		else
1387 			bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1388 			/* bytes is now amount of outgoing data */
1389 	}
1390 
1391 	subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1392 
1393 	if (subs->trigger_tstamp_pending_update) {
1394 		/* this is the first actual URB submitted,
1395 		 * update trigger timestamp to reflect actual start time
1396 		 */
1397 		snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1398 		subs->trigger_tstamp_pending_update = false;
1399 	}
1400 
1401 	spin_unlock_irqrestore(&subs->lock, flags);
1402 	urb->transfer_buffer_length = bytes;
1403 	if (period_elapsed)
1404 		snd_pcm_period_elapsed(subs->pcm_substream);
1405 }
1406 
1407 /*
1408  * process after playback data complete
1409  * - decrease the delay count again
1410  */
1411 static void retire_playback_urb(struct snd_usb_substream *subs,
1412 			       struct urb *urb)
1413 {
1414 	unsigned long flags;
1415 	struct snd_urb_ctx *ctx = urb->context;
1416 
1417 	spin_lock_irqsave(&subs->lock, flags);
1418 	if (ctx->queued) {
1419 		if (subs->inflight_bytes >= ctx->queued)
1420 			subs->inflight_bytes -= ctx->queued;
1421 		else
1422 			subs->inflight_bytes = 0;
1423 	}
1424 
1425 	subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1426 	spin_unlock_irqrestore(&subs->lock, flags);
1427 }
1428 
1429 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1430 					      int cmd)
1431 {
1432 	struct snd_usb_substream *subs = substream->runtime->private_data;
1433 
1434 	switch (cmd) {
1435 	case SNDRV_PCM_TRIGGER_START:
1436 		subs->trigger_tstamp_pending_update = true;
1437 		fallthrough;
1438 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1439 		snd_usb_endpoint_set_callback(subs->data_endpoint,
1440 					      prepare_playback_urb,
1441 					      retire_playback_urb,
1442 					      subs);
1443 		subs->running = 1;
1444 		dev_dbg(&subs->dev->dev, "%d:%d Start Playback PCM\n",
1445 			subs->cur_audiofmt->iface,
1446 			subs->cur_audiofmt->altsetting);
1447 		return 0;
1448 	case SNDRV_PCM_TRIGGER_SUSPEND:
1449 	case SNDRV_PCM_TRIGGER_STOP:
1450 		stop_endpoints(subs);
1451 		snd_usb_endpoint_set_callback(subs->data_endpoint,
1452 					      NULL, NULL, NULL);
1453 		subs->running = 0;
1454 		dev_dbg(&subs->dev->dev, "%d:%d Stop Playback PCM\n",
1455 			subs->cur_audiofmt->iface,
1456 			subs->cur_audiofmt->altsetting);
1457 		return 0;
1458 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1459 		/* keep retire_data_urb for delay calculation */
1460 		snd_usb_endpoint_set_callback(subs->data_endpoint,
1461 					      NULL,
1462 					      retire_playback_urb,
1463 					      subs);
1464 		subs->running = 0;
1465 		dev_dbg(&subs->dev->dev, "%d:%d Pause Playback PCM\n",
1466 			subs->cur_audiofmt->iface,
1467 			subs->cur_audiofmt->altsetting);
1468 		return 0;
1469 	}
1470 
1471 	return -EINVAL;
1472 }
1473 
1474 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1475 					     int cmd)
1476 {
1477 	int err;
1478 	struct snd_usb_substream *subs = substream->runtime->private_data;
1479 
1480 	switch (cmd) {
1481 	case SNDRV_PCM_TRIGGER_START:
1482 		err = start_endpoints(subs);
1483 		if (err < 0)
1484 			return err;
1485 		fallthrough;
1486 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1487 		snd_usb_endpoint_set_callback(subs->data_endpoint,
1488 					      NULL, retire_capture_urb,
1489 					      subs);
1490 		subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1491 		subs->running = 1;
1492 		dev_dbg(&subs->dev->dev, "%d:%d Start Capture PCM\n",
1493 			subs->cur_audiofmt->iface,
1494 			subs->cur_audiofmt->altsetting);
1495 		return 0;
1496 	case SNDRV_PCM_TRIGGER_SUSPEND:
1497 	case SNDRV_PCM_TRIGGER_STOP:
1498 		stop_endpoints(subs);
1499 		fallthrough;
1500 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1501 		snd_usb_endpoint_set_callback(subs->data_endpoint,
1502 					      NULL, NULL, NULL);
1503 		subs->running = 0;
1504 		dev_dbg(&subs->dev->dev, "%d:%d Stop Capture PCM\n",
1505 			subs->cur_audiofmt->iface,
1506 			subs->cur_audiofmt->altsetting);
1507 		return 0;
1508 	}
1509 
1510 	return -EINVAL;
1511 }
1512 
1513 static const struct snd_pcm_ops snd_usb_playback_ops = {
1514 	.open =		snd_usb_pcm_open,
1515 	.close =	snd_usb_pcm_close,
1516 	.hw_params =	snd_usb_hw_params,
1517 	.hw_free =	snd_usb_hw_free,
1518 	.prepare =	snd_usb_pcm_prepare,
1519 	.trigger =	snd_usb_substream_playback_trigger,
1520 	.sync_stop =	snd_usb_pcm_sync_stop,
1521 	.pointer =	snd_usb_pcm_pointer,
1522 };
1523 
1524 static const struct snd_pcm_ops snd_usb_capture_ops = {
1525 	.open =		snd_usb_pcm_open,
1526 	.close =	snd_usb_pcm_close,
1527 	.hw_params =	snd_usb_hw_params,
1528 	.hw_free =	snd_usb_hw_free,
1529 	.prepare =	snd_usb_pcm_prepare,
1530 	.trigger =	snd_usb_substream_capture_trigger,
1531 	.sync_stop =	snd_usb_pcm_sync_stop,
1532 	.pointer =	snd_usb_pcm_pointer,
1533 };
1534 
1535 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1536 {
1537 	const struct snd_pcm_ops *ops;
1538 
1539 	ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1540 			&snd_usb_playback_ops : &snd_usb_capture_ops;
1541 	snd_pcm_set_ops(pcm, stream, ops);
1542 }
1543 
1544 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1545 {
1546 	struct snd_pcm *pcm = subs->stream->pcm;
1547 	struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1548 	struct device *dev = subs->dev->bus->sysdev;
1549 
1550 	if (snd_usb_use_vmalloc)
1551 		snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_VMALLOC,
1552 					   NULL, 0, 0);
1553 	else
1554 		snd_pcm_set_managed_buffer(s, SNDRV_DMA_TYPE_DEV_SG,
1555 					   dev, 64*1024, 512*1024);
1556 }
1557