endpoint.c 33.2 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
Daniel Mack's avatar
Daniel Mack committed
2
3
4
/*
 */

5
6
#include <linux/gfp.h>
#include <linux/init.h>
7
#include <linux/ratelimit.h>
8
9
#include <linux/usb.h>
#include <linux/usb/audio.h>
10
#include <linux/slab.h>
11
12
13

#include <sound/core.h>
#include <sound/pcm.h>
14
#include <sound/pcm_params.h>
15
16
17
18
19
20

#include "usbaudio.h"
#include "helper.h"
#include "card.h"
#include "endpoint.h"
#include "pcm.h"
21
#include "quirks.h"
22

23
#define EP_FLAG_RUNNING		1
24
#define EP_FLAG_STOPPING	2
25

26
27
28
29
30
/*
 * snd_usb_endpoint is a model that abstracts everything related to an
 * USB endpoint and its streaming.
 *
 * There are functions to activate and deactivate the streaming URBs and
31
 * optional callbacks to let the pcm logic handle the actual content of the
32
33
34
 * packets for playback and record. Thus, the bus streaming and the audio
 * handlers are fully decoupled.
 *
35
 * There are two different types of endpoints in audio applications.
36
37
38
39
 *
 * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
 * inbound and outbound traffic.
 *
40
41
42
 * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
 * expect the payload to carry Q10.14 / Q16.16 formatted sync information
 * (3 or 4 bytes).
43
 *
44
45
 * Each endpoint has to be configured prior to being used by calling
 * snd_usb_endpoint_set_params().
46
47
48
49
 *
 * The model incorporates a reference counting, so that multiple users
 * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
 * only the first user will effectively start the URBs, and only the last
50
 * one to stop it will tear the URBs down again.
51
52
 */

53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
 * this will overflow at approx 524 kHz
 */
static inline unsigned get_usb_full_speed_rate(unsigned int rate)
{
	return ((rate << 13) + 62) / 125;
}

/*
 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
 * this will overflow at approx 4 MHz
 */
static inline unsigned get_usb_high_speed_rate(unsigned int rate)
{
	return ((rate << 10) + 62) / 125;
}

/*
 * release a urb data
 */
static void release_urb_ctx(struct snd_urb_ctx *u)
{
76
77
78
79
80
81
	if (u->buffer_size)
		usb_free_coherent(u->ep->chip->dev, u->buffer_size,
				  u->urb->transfer_buffer,
				  u->urb->transfer_dma);
	usb_free_urb(u->urb);
	u->urb = NULL;
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
}

static const char *usb_error_string(int err)
{
	switch (err) {
	case -ENODEV:
		return "no device";
	case -ENOENT:
		return "endpoint not enabled";
	case -EPIPE:
		return "endpoint stalled";
	case -ENOSPC:
		return "not enough bandwidth";
	case -ESHUTDOWN:
		return "device disabled";
	case -EHOSTUNREACH:
		return "device suspended";
	case -EINVAL:
	case -EAGAIN:
	case -EFBIG:
	case -EMSGSIZE:
		return "internal error";
	default:
		return "unknown error";
	}
}

109
110
111
/**
 * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
 *
112
 * @ep: The snd_usb_endpoint
113
114
115
116
 *
 * Determine whether an endpoint is driven by an implicit feedback
 * data endpoint source.
 */
117
int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
118
119
120
121
122
123
124
{
	return  ep->sync_master &&
		ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
		ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
		usb_pipeout(ep->pipe);
}

125
126
/*
 * For streaming based on information derived from sync endpoints,
127
 * prepare_outbound_urb_sizes() will call slave_next_packet_size() to
128
129
 * determine the number of samples to be sent in the next packet.
 *
130
 * For implicit feedback, slave_next_packet_size() is unused.
131
 */
132
int snd_usb_endpoint_slave_next_packet_size(struct snd_usb_endpoint *ep)
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
	unsigned long flags;
	int ret;

	if (ep->fill_max)
		return ep->maxframesize;

	spin_lock_irqsave(&ep->lock, flags);
	ep->phase = (ep->phase & 0xffff)
		+ (ep->freqm << ep->datainterval);
	ret = min(ep->phase >> 16, ep->maxframesize);
	spin_unlock_irqrestore(&ep->lock, flags);

	return ret;
}

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
 * For adaptive and synchronous endpoints, prepare_outbound_urb_sizes()
 * will call next_packet_size() to determine the number of samples to be
 * sent in the next packet.
 */
int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
{
	int ret;

	if (ep->fill_max)
		return ep->maxframesize;

	ep->sample_accum += ep->sample_rem;
	if (ep->sample_accum >= ep->fps) {
		ep->sample_accum -= ep->fps;
		ret = ep->framesize[1];
	} else {
		ret = ep->framesize[0];
	}

	return ret;
}

172
173
174
175
176
177
178
179
180
181
182
183
static void retire_outbound_urb(struct snd_usb_endpoint *ep,
				struct snd_urb_ctx *urb_ctx)
{
	if (ep->retire_data_urb)
		ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
}

static void retire_inbound_urb(struct snd_usb_endpoint *ep,
			       struct snd_urb_ctx *urb_ctx)
{
	struct urb *urb = urb_ctx->urb;

184
185
186
187
188
	if (unlikely(ep->skip_packets > 0)) {
		ep->skip_packets--;
		return;
	}

189
190
191
192
193
194
195
	if (ep->sync_slave)
		snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);

	if (ep->retire_data_urb)
		ep->retire_data_urb(ep->data_subs, urb);
}

196
197
198
199
200
static void prepare_silent_urb(struct snd_usb_endpoint *ep,
			       struct snd_urb_ctx *ctx)
{
	struct urb *urb = ctx->urb;
	unsigned int offs = 0;
201
202
	unsigned int extra = 0;
	__le32 packet_length;
203
204
	int i;

205
206
207
208
	/* For tx_length_quirk, put packet length at start of packet */
	if (ep->chip->tx_length_quirk)
		extra = sizeof(packet_length);

209
	for (i = 0; i < ctx->packets; ++i) {
210
211
		unsigned int offset;
		unsigned int length;
212
213
214
215
		int counts;

		if (ctx->packet_size[i])
			counts = ctx->packet_size[i];
216
217
		else if (ep->sync_master)
			counts = snd_usb_endpoint_slave_next_packet_size(ep);
218
219
220
		else
			counts = snd_usb_endpoint_next_packet_size(ep);

221
222
223
224
225
226
227
228
229
230
231
		length = counts * ep->stride; /* number of silent bytes */
		offset = offs * ep->stride + extra * i;
		urb->iso_frame_desc[i].offset = offset;
		urb->iso_frame_desc[i].length = length + extra;
		if (extra) {
			packet_length = cpu_to_le32(length);
			memcpy(urb->transfer_buffer + offset,
			       &packet_length, sizeof(packet_length));
		}
		memset(urb->transfer_buffer + offset + extra,
		       ep->silence_value, length);
232
233
234
235
		offs += counts;
	}

	urb->number_of_packets = ctx->packets;
236
	urb->transfer_buffer_length = offs * ep->stride + ctx->packets * extra;
237
238
}

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*
 * Prepare a PLAYBACK urb for submission to the bus.
 */
static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
				 struct snd_urb_ctx *ctx)
{
	struct urb *urb = ctx->urb;
	unsigned char *cp = urb->transfer_buffer;

	urb->dev = ep->chip->dev; /* we need to set this at each time */

	switch (ep->type) {
	case SND_USB_ENDPOINT_TYPE_DATA:
		if (ep->prepare_data_urb) {
			ep->prepare_data_urb(ep->data_subs, urb);
		} else {
			/* no data provider, so send silence */
256
			prepare_silent_urb(ep, ctx);
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
		}
		break;

	case SND_USB_ENDPOINT_TYPE_SYNC:
		if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
			/*
			 * fill the length and offset of each urb descriptor.
			 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
			 */
			urb->iso_frame_desc[0].length = 4;
			urb->iso_frame_desc[0].offset = 0;
			cp[0] = ep->freqn;
			cp[1] = ep->freqn >> 8;
			cp[2] = ep->freqn >> 16;
			cp[3] = ep->freqn >> 24;
		} else {
			/*
			 * fill the length and offset of each urb descriptor.
			 * the fixed 10.14 frequency is passed through the pipe.
			 */
			urb->iso_frame_desc[0].length = 3;
			urb->iso_frame_desc[0].offset = 0;
			cp[0] = ep->freqn >> 2;
			cp[1] = ep->freqn >> 10;
			cp[2] = ep->freqn >> 18;
		}

		break;
	}
}

/*
 * Prepare a CAPTURE or SYNC urb for submission to the bus.
 */
static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
				       struct snd_urb_ctx *urb_ctx)
{
	int i, offs;
	struct urb *urb = urb_ctx->urb;

	urb->dev = ep->chip->dev; /* we need to set this at each time */

	switch (ep->type) {
	case SND_USB_ENDPOINT_TYPE_DATA:
		offs = 0;
		for (i = 0; i < urb_ctx->packets; i++) {
			urb->iso_frame_desc[i].offset = offs;
			urb->iso_frame_desc[i].length = ep->curpacksize;
			offs += ep->curpacksize;
		}

		urb->transfer_buffer_length = offs;
		urb->number_of_packets = urb_ctx->packets;
		break;

	case SND_USB_ENDPOINT_TYPE_SYNC:
		urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
		urb->iso_frame_desc[0].offset = 0;
		break;
	}
}

319
/*
320
 * Send output urbs that have been prepared previously. URBs are dequeued
321
322
323
324
 * from ep->ready_playback_urbs and in case there there aren't any available
 * or there are no packets that have been prepared, this function does
 * nothing.
 *
325
326
327
 * The reason why the functionality of sending and preparing URBs is separated
 * is that host controllers don't guarantee the order in which they return
 * inbound and outbound packets to their submitters.
328
329
 *
 * This function is only used for implicit feedback endpoints. For endpoints
330
331
 * driven by dedicated sync endpoints, URBs are immediately re-submitted
 * from their completion handler.
332
 */
333
334
335
336
337
static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
{
	while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {

		unsigned long flags;
338
		struct snd_usb_packet_info *uninitialized_var(packet);
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
		struct snd_urb_ctx *ctx = NULL;
		int err, i;

		spin_lock_irqsave(&ep->lock, flags);
		if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
			packet = ep->next_packet + ep->next_packet_read_pos;
			ep->next_packet_read_pos++;
			ep->next_packet_read_pos %= MAX_URBS;

			/* take URB out of FIFO */
			if (!list_empty(&ep->ready_playback_urbs))
				ctx = list_first_entry(&ep->ready_playback_urbs,
					       struct snd_urb_ctx, ready_list);
		}
		spin_unlock_irqrestore(&ep->lock, flags);

		if (ctx == NULL)
			return;

		list_del_init(&ctx->ready_list);

		/* copy over the length information */
		for (i = 0; i < packet->packets; i++)
			ctx->packet_size[i] = packet->packet_size[i];

364
		/* call the data handler to fill in playback data */
365
366
367
368
		prepare_outbound_urb(ep, ctx);

		err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
		if (err < 0)
369
370
371
			usb_audio_err(ep->chip,
				"Unable to submit urb #%d: %d (urb %p)\n",
				ctx->index, err, ctx->urb);
372
373
374
375
376
377
378
379
380
381
382
383
		else
			set_bit(ctx->index, &ep->active_mask);
	}
}

/*
 * complete callback for urbs
 */
static void snd_complete_urb(struct urb *urb)
{
	struct snd_urb_ctx *ctx = urb->context;
	struct snd_usb_endpoint *ep = ctx->ep;
384
385
	struct snd_pcm_substream *substream;
	unsigned long flags;
386
387
388
389
390
	int err;

	if (unlikely(urb->status == -ENOENT ||		/* unlinked */
		     urb->status == -ENODEV ||		/* device removed */
		     urb->status == -ECONNRESET ||	/* unlinked */
391
392
393
394
		     urb->status == -ESHUTDOWN))	/* device disabled */
		goto exit_clear;
	/* device disconnected */
	if (unlikely(atomic_read(&ep->chip->shutdown)))
395
396
		goto exit_clear;

397
398
399
	if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
		goto exit_clear;

400
401
402
403
404
405
	if (usb_pipeout(ep->pipe)) {
		retire_outbound_urb(ep, ctx);
		/* can be stopped during retire callback */
		if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
			goto exit_clear;

406
		if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
407
408
409
410
411
412
413
414
415
			spin_lock_irqsave(&ep->lock, flags);
			list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
			spin_unlock_irqrestore(&ep->lock, flags);
			queue_pending_output_urbs(ep);

			goto exit_clear;
		}

		prepare_outbound_urb(ep, ctx);
416
417
418
		/* can be stopped during prepare callback */
		if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
			goto exit_clear;
419
420
421
422
423
424
425
426
427
428
429
430
431
	} else {
		retire_inbound_urb(ep, ctx);
		/* can be stopped during retire callback */
		if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
			goto exit_clear;

		prepare_inbound_urb(ep, ctx);
	}

	err = usb_submit_urb(urb, GFP_ATOMIC);
	if (err == 0)
		return;

432
	usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
433
434
	if (ep->data_subs && ep->data_subs->pcm_substream) {
		substream = ep->data_subs->pcm_substream;
435
		snd_pcm_stop_xrun(substream);
436
	}
437
438
439
440
441

exit_clear:
	clear_bit(ctx->index, &ep->active_mask);
}

442
/**
443
 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
444
445
446
447
448
449
450
451
452
453
454
455
456
 *
 * @chip: The chip
 * @alts: The USB host interface
 * @ep_num: The number of the endpoint to use
 * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
 *
 * If the requested endpoint has not been added to the given chip before,
 * a new instance is created. Otherwise, a pointer to the previoulsy
 * created instance is returned. In case of any error, NULL is returned.
 *
 * New endpoints will be added to chip->ep_list and must be freed by
 * calling snd_usb_endpoint_free().
457
458
459
 *
 * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that
 * bNumEndpoints > 1 beforehand.
460
 */
461
462
463
464
465
struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
					      struct usb_host_interface *alts,
					      int ep_num, int direction, int type)
{
	struct snd_usb_endpoint *ep;
466
	int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
467

468
469
470
	if (WARN_ON(!alts))
		return NULL;

471
472
	mutex_lock(&chip->mutex);

473
	list_for_each_entry(ep, &chip->ep_list, list) {
474
475
		if (ep->ep_num == ep_num &&
		    ep->iface == alts->desc.bInterfaceNumber &&
476
		    ep->altsetting == alts->desc.bAlternateSetting) {
477
478
			usb_audio_dbg(ep->chip,
				      "Re-using EP %x in iface %d,%d @%p\n",
479
					ep_num, ep->iface, ep->altsetting, ep);
480
481
482
483
			goto __exit_unlock;
		}
	}

484
	usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
485
486
487
488
489
490
491
492
493
494
495
496
497
		    is_playback ? "playback" : "capture",
		    type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
		    ep_num);

	ep = kzalloc(sizeof(*ep), GFP_KERNEL);
	if (!ep)
		goto __exit_unlock;

	ep->chip = chip;
	spin_lock_init(&ep->lock);
	ep->type = type;
	ep->ep_num = ep_num;
	ep->iface = alts->desc.bInterfaceNumber;
498
	ep->altsetting = alts->desc.bAlternateSetting;
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
	INIT_LIST_HEAD(&ep->ready_playback_urbs);
	ep_num &= USB_ENDPOINT_NUMBER_MASK;

	if (is_playback)
		ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
	else
		ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);

	if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
		if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
		    get_endpoint(alts, 1)->bRefresh >= 1 &&
		    get_endpoint(alts, 1)->bRefresh <= 9)
			ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
		else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
			ep->syncinterval = 1;
		else if (get_endpoint(alts, 1)->bInterval >= 1 &&
			 get_endpoint(alts, 1)->bInterval <= 16)
			ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
		else
			ep->syncinterval = 3;

		ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
	}

	list_add_tail(&ep->list, &chip->ep_list);

__exit_unlock:
	mutex_unlock(&chip->mutex);

	return ep;
}

/*
 *  wait until all urbs are processed.
 */
static int wait_clear_urbs(struct snd_usb_endpoint *ep)
{
	unsigned long end_time = jiffies + msecs_to_jiffies(1000);
	int alive;

	do {
540
		alive = bitmap_weight(&ep->active_mask, ep->nurbs);
541
542
543
544
545
546
547
		if (!alive)
			break;

		schedule_timeout_uninterruptible(1);
	} while (time_before(jiffies, end_time));

	if (alive)
548
549
550
		usb_audio_err(ep->chip,
			"timeout: still %d active urbs on EP #%x\n",
			alive, ep->ep_num);
551
	clear_bit(EP_FLAG_STOPPING, &ep->flags);
552

553
554
555
556
557
	ep->data_subs = NULL;
	ep->sync_slave = NULL;
	ep->retire_data_urb = NULL;
	ep->prepare_data_urb = NULL;

558
559
560
	return 0;
}

561
562
563
564
565
566
567
568
569
/* sync the pending stop operation;
 * this function itself doesn't trigger the stop operation
 */
void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
{
	if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
		wait_clear_urbs(ep);
}

570
571
572
/*
 * unlink active urbs.
 */
573
static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
574
575
576
{
	unsigned int i;

577
	if (!force && atomic_read(&ep->chip->shutdown)) /* to be sure... */
578
579
580
581
582
583
584
585
586
587
588
589
		return -EBADFD;

	clear_bit(EP_FLAG_RUNNING, &ep->flags);

	INIT_LIST_HEAD(&ep->ready_playback_urbs);
	ep->next_packet_read_pos = 0;
	ep->next_packet_write_pos = 0;

	for (i = 0; i < ep->nurbs; i++) {
		if (test_bit(i, &ep->active_mask)) {
			if (!test_and_set_bit(i, &ep->unlink_mask)) {
				struct urb *u = ep->urb[i].urb;
590
				usb_unlink_urb(u);
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
			}
		}
	}

	return 0;
}

/*
 * release an endpoint's urbs
 */
static void release_urbs(struct snd_usb_endpoint *ep, int force)
{
	int i;

	/* route incoming urbs to nirvana */
	ep->retire_data_urb = NULL;
	ep->prepare_data_urb = NULL;

	/* stop urbs */
610
	deactivate_urbs(ep, force);
611
612
613
614
615
616
617
618
619
620
621
622
623
	wait_clear_urbs(ep);

	for (i = 0; i < ep->nurbs; i++)
		release_urb_ctx(&ep->urb[i]);

	if (ep->syncbuf)
		usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
				  ep->syncbuf, ep->sync_dma);

	ep->syncbuf = NULL;
	ep->nurbs = 0;
}

624
625
626
/*
 * configure a data endpoint
 */
627
static int data_ep_set_params(struct snd_usb_endpoint *ep,
628
629
630
			      snd_pcm_format_t pcm_format,
			      unsigned int channels,
			      unsigned int period_bytes,
631
632
			      unsigned int frames_per_period,
			      unsigned int periods_per_buffer,
633
634
635
			      struct audioformat *fmt,
			      struct snd_usb_endpoint *sync_ep)
{
636
637
638
	unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
	unsigned int max_packs_per_period, urbs_per_period, urb_packs;
	unsigned int max_urbs, i;
639
	int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
640
641
	int tx_length_quirk = (ep->chip->tx_length_quirk &&
			       usb_pipeout(ep->pipe));
642

643
644
645
646
647
648
649
650
651
	if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
		/*
		 * When operating in DSD DOP mode, the size of a sample frame
		 * in hardware differs from the actual physical format width
		 * because we need to make room for the DOP markers.
		 */
		frame_bits += channels << 3;
	}

652
653
	ep->datainterval = fmt->datainterval;
	ep->stride = frame_bits >> 3;
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668

	switch (pcm_format) {
	case SNDRV_PCM_FORMAT_U8:
		ep->silence_value = 0x80;
		break;
	case SNDRV_PCM_FORMAT_DSD_U8:
	case SNDRV_PCM_FORMAT_DSD_U16_LE:
	case SNDRV_PCM_FORMAT_DSD_U32_LE:
	case SNDRV_PCM_FORMAT_DSD_U16_BE:
	case SNDRV_PCM_FORMAT_DSD_U32_BE:
		ep->silence_value = 0x69;
		break;
	default:
		ep->silence_value = 0;
	}
669

670
671
	/* assume max. frequency is 50% higher than nominal */
	ep->freqmax = ep->freqn + (ep->freqn >> 1);
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
	/* Round up freqmax to nearest integer in order to calculate maximum
	 * packet size, which must represent a whole number of frames.
	 * This is accomplished by adding 0x0.ffff before converting the
	 * Q16.16 format into integer.
	 * In order to accurately calculate the maximum packet size when
	 * the data interval is more than 1 (i.e. ep->datainterval > 0),
	 * multiply by the data interval prior to rounding. For instance,
	 * a freqmax of 41 kHz will result in a max packet size of 6 (5.125)
	 * frames with a data interval of 1, but 11 (10.25) frames with a
	 * data interval of 2.
	 * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the
	 * maximum datainterval value of 3, at USB full speed, higher for
	 * USB high speed, noting that ep->freqmax is in units of
	 * frames per packet in Q16.16 format.)
	 */
	maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) *
			 (frame_bits >> 3);
689
690
	if (tx_length_quirk)
		maxsize += sizeof(__le32); /* Space for length descriptor */
691
692
	/* but wMaxPacketSize might reduce this */
	if (ep->maxpacksize && ep->maxpacksize < maxsize) {
693
		/* whatever fits into a max. size packet */
694
695
696
697
698
699
		unsigned int data_maxsize = maxsize = ep->maxpacksize;

		if (tx_length_quirk)
			/* Need to remove the length descriptor to calc freq */
			data_maxsize -= sizeof(__le32);
		ep->freqmax = (data_maxsize / (frame_bits >> 3))
700
701
702
703
704
705
706
707
				<< (16 - ep->datainterval);
	}

	if (ep->fill_max)
		ep->curpacksize = ep->maxpacksize;
	else
		ep->curpacksize = maxsize;

708
	if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
709
		packs_per_ms = 8 >> ep->datainterval;
710
		max_packs_per_urb = MAX_PACKS_HS;
711
	} else {
712
713
		packs_per_ms = 1;
		max_packs_per_urb = MAX_PACKS;
714
	}
715
	if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
		max_packs_per_urb = min(max_packs_per_urb,
					1U << sync_ep->syncinterval);
	max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);

	/*
	 * Capture endpoints need to use small URBs because there's no way
	 * to tell in advance where the next period will end, and we don't
	 * want the next URB to complete much after the period ends.
	 *
	 * Playback endpoints with implicit sync much use the same parameters
	 * as their corresponding capture endpoint.
	 */
	if (usb_pipein(ep->pipe) ||
			snd_usb_endpoint_implicit_feedback_sink(ep)) {

731
732
733
734
735
736
737
738
739
740
741
742
743
744
		urb_packs = packs_per_ms;
		/*
		 * Wireless devices can poll at a max rate of once per 4ms.
		 * For dataintervals less than 5, increase the packet count to
		 * allow the host controller to use bursting to fill in the
		 * gaps.
		 */
		if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
			int interval = ep->datainterval;
			while (interval < 5) {
				urb_packs <<= 1;
				++interval;
			}
		}
745
		/* make capture URBs <= 1 ms and smaller than a period */
746
		urb_packs = min(max_packs_per_urb, urb_packs);
747
748
749
		while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
			urb_packs >>= 1;
		ep->nurbs = MAX_URBS;
750

751
752
753
754
755
756
757
	/*
	 * Playback endpoints without implicit sync are adjusted so that
	 * a period fits as evenly as possible in the smallest number of
	 * URBs.  The total number of URBs is adjusted to the size of the
	 * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
	 */
	} else {
758
		/* determine how small a packet can be */
759
760
		minsize = (ep->freqn >> (16 - ep->datainterval)) *
				(frame_bits >> 3);
761
762
763
764
765
		/* with sync from device, assume it can be 12% lower */
		if (sync_ep)
			minsize -= minsize >> 3;
		minsize = max(minsize, 1u);

766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
		/* how many packets will contain an entire ALSA period? */
		max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);

		/* how many URBs will contain a period? */
		urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
				max_packs_per_urb);
		/* how many packets are needed in each URB? */
		urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);

		/* limit the number of frames in a single URB */
		ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
					urbs_per_period);

		/* try to use enough URBs to contain an entire ALSA buffer */
		max_urbs = min((unsigned) MAX_URBS,
				MAX_QUEUE * packs_per_ms / urb_packs);
		ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
783
784
785
786
787
788
789
	}

	/* allocate and initialize data urbs */
	for (i = 0; i < ep->nurbs; i++) {
		struct snd_urb_ctx *u = &ep->urb[i];
		u->index = i;
		u->ep = ep;
790
		u->packets = urb_packs;
791
792
793
794
795
796
797
798
799
800
801
802
803
804
		u->buffer_size = maxsize * u->packets;

		if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
			u->packets++; /* for transfer delimiter */
		u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
		if (!u->urb)
			goto out_of_memory;

		u->urb->transfer_buffer =
			usb_alloc_coherent(ep->chip->dev, u->buffer_size,
					   GFP_KERNEL, &u->urb->transfer_dma);
		if (!u->urb->transfer_buffer)
			goto out_of_memory;
		u->urb->pipe = ep->pipe;
805
		u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
806
807
808
809
810
811
812
813
814
815
816
817
818
		u->urb->interval = 1 << ep->datainterval;
		u->urb->context = u;
		u->urb->complete = snd_complete_urb;
		INIT_LIST_HEAD(&u->ready_list);
	}

	return 0;

out_of_memory:
	release_urbs(ep, 0);
	return -ENOMEM;
}

819
820
821
/*
 * configure a sync endpoint
 */
822
static int sync_ep_set_params(struct snd_usb_endpoint *ep)
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
{
	int i;

	ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
					 GFP_KERNEL, &ep->sync_dma);
	if (!ep->syncbuf)
		return -ENOMEM;

	for (i = 0; i < SYNC_URBS; i++) {
		struct snd_urb_ctx *u = &ep->urb[i];
		u->index = i;
		u->ep = ep;
		u->packets = 1;
		u->urb = usb_alloc_urb(1, GFP_KERNEL);
		if (!u->urb)
			goto out_of_memory;
		u->urb->transfer_buffer = ep->syncbuf + i * 4;
		u->urb->transfer_dma = ep->sync_dma + i * 4;
		u->urb->transfer_buffer_length = 4;
		u->urb->pipe = ep->pipe;
843
		u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
		u->urb->number_of_packets = 1;
		u->urb->interval = 1 << ep->syncinterval;
		u->urb->context = u;
		u->urb->complete = snd_complete_urb;
	}

	ep->nurbs = SYNC_URBS;

	return 0;

out_of_memory:
	release_urbs(ep, 0);
	return -ENOMEM;
}

859
/**
860
 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
861
 *
862
 * @ep: the snd_usb_endpoint to configure
863
864
865
 * @pcm_format: the audio fomat.
 * @channels: the number of audio channels.
 * @period_bytes: the number of bytes in one alsa period.
866
867
 * @period_frames: the number of frames in one alsa period.
 * @buffer_periods: the number of periods in one alsa buffer.
868
 * @rate: the frame rate.
869
870
 * @fmt: the USB audio format information
 * @sync_ep: the sync endpoint to use, if any
871
 *
872
 * Determine the number of URBs to be used on this endpoint.
873
874
875
 * An endpoint must be configured before it can be started.
 * An endpoint that is already running can not be reconfigured.
 */
876
int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
877
878
879
				snd_pcm_format_t pcm_format,
				unsigned int channels,
				unsigned int period_bytes,
880
881
				unsigned int period_frames,
				unsigned int buffer_periods,
882
				unsigned int rate,
883
884
885
886
887
888
				struct audioformat *fmt,
				struct snd_usb_endpoint *sync_ep)
{
	int err;

	if (ep->use_count != 0) {
889
890
891
		usb_audio_warn(ep->chip,
			 "Unable to change format on ep #%x: already in use\n",
			 ep->ep_num);
892
893
894
895
896
897
898
899
		return -EBUSY;
	}

	/* release old buffers, if any */
	release_urbs(ep, 0);

	ep->datainterval = fmt->datainterval;
	ep->maxpacksize = fmt->maxpacksize;
900
	ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
901

902
	if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL) {
903
		ep->freqn = get_usb_full_speed_rate(rate);
904
905
		ep->fps = 1000;
	} else {
906
		ep->freqn = get_usb_high_speed_rate(rate);
907
908
909
910
911
912
		ep->fps = 8000;
	}

	ep->sample_rem = rate % ep->fps;
	ep->framesize[0] = rate / ep->fps;
	ep->framesize[1] = (rate + (ep->fps - 1)) / ep->fps;
913
914
915
916
917
918
919
920
921

	/* calculate the frequency in 16.16 format */
	ep->freqm = ep->freqn;
	ep->freqshift = INT_MIN;

	ep->phase = 0;

	switch (ep->type) {
	case  SND_USB_ENDPOINT_TYPE_DATA:
922
		err = data_ep_set_params(ep, pcm_format, channels,
923
924
					 period_bytes, period_frames,
					 buffer_periods, fmt, sync_ep);
925
926
		break;
	case  SND_USB_ENDPOINT_TYPE_SYNC:
927
		err = sync_ep_set_params(ep);
928
929
930
931
932
		break;
	default:
		err = -EINVAL;
	}

933
934
935
	usb_audio_dbg(ep->chip,
		"Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
		ep->ep_num, ep->type, ep->nurbs, err);
936
937
938
939

	return err;
}

940
941
942
/**
 * snd_usb_endpoint_start: start an snd_usb_endpoint
 *
943
 * @ep: the endpoint to start
944
945
 *
 * A call to this function will increment the use count of the endpoint.
946
 * In case it is not already running, the URBs for this endpoint will be
947
948
949
950
951
952
 * submitted. Otherwise, this function does nothing.
 *
 * Must be balanced to calls of snd_usb_endpoint_stop().
 *
 * Returns an error if the URB submission failed, 0 in all other cases.
 */
953
int snd_usb_endpoint_start(struct snd_usb_endpoint *ep)
954
955
956
957
{
	int err;
	unsigned int i;

958
	if (atomic_read(&ep->chip->shutdown))
959
960
961
962
963
964
		return -EBADFD;

	/* already running? */
	if (++ep->use_count != 1)
		return 0;

965
	/* just to be sure */
966
	deactivate_urbs(ep, false);
967

968
969
970
	ep->active_mask = 0;
	ep->unlink_mask = 0;
	ep->phase = 0;
971
	ep->sample_accum = 0;
972

973
974
	snd_usb_endpoint_start_quirk(ep);

975
976
977
	/*
	 * If this endpoint has a data endpoint as implicit feedback source,
	 * don't start the urbs here. Instead, mark them all as available,
978
979
	 * wait for the record urbs to return and queue the playback urbs
	 * from that context.
980
981
982
983
	 */

	set_bit(EP_FLAG_RUNNING, &ep->flags);

984
	if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
		for (i = 0; i < ep->nurbs; i++) {
			struct snd_urb_ctx *ctx = ep->urb + i;
			list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
		}

		return 0;
	}

	for (i = 0; i < ep->nurbs; i++) {
		struct urb *urb = ep->urb[i].urb;

		if (snd_BUG_ON(!urb))
			goto __error;

		if (usb_pipeout(ep->pipe)) {
			prepare_outbound_urb(ep, urb->context);
		} else {
			prepare_inbound_urb(ep, urb->context);
		}

		err = usb_submit_urb(urb, GFP_ATOMIC);
		if (err < 0) {
1007
1008
1009
			usb_audio_err(ep->chip,
				"cannot submit urb %d, error %d: %s\n",
				i, err, usb_error_string(err));
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
			goto __error;
		}
		set_bit(i, &ep->active_mask);
	}

	return 0;

__error:
	clear_bit(EP_FLAG_RUNNING, &ep->flags);
	ep->use_count--;
1020
	deactivate_urbs(ep, false);
1021
1022
1023
	return -EPIPE;
}

1024
1025
1026
1027
1028
1029
1030
/**
 * snd_usb_endpoint_stop: stop an snd_usb_endpoint
 *
 * @ep: the endpoint to stop (may be NULL)
 *
 * A call to this function will decrement the use count of the endpoint.
 * In case the last user has requested the endpoint stop, the URBs will
1031
 * actually be deactivated.
1032
1033
 *
 * Must be balanced to calls of snd_usb_endpoint_start().
1034
1035
1036
 *
 * The caller needs to synchronize the pending stop operation via
 * snd_usb_endpoint_sync_pending_stop().
1037
 */
1038
void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
1039
1040
1041
1042
1043
1044
1045
1046
{
	if (!ep)
		return;

	if (snd_BUG_ON(ep->use_count == 0))
		return;

	if (--ep->use_count == 0) {
1047
		deactivate_urbs(ep, false);
1048
		set_bit(EP_FLAG_STOPPING, &ep->flags);
1049
1050
1051
	}
}

1052
1053
1054
1055
1056
/**
 * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
 *
 * @ep: the endpoint to deactivate
 *
1057
1058
 * If the endpoint is not currently in use, this functions will
 * deactivate its associated URBs.
1059
1060
1061
 *
 * In case of any active users, this functions does nothing.
 */
1062
void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
1063
1064
{
	if (!ep)
1065
		return;
1066
1067

	if (ep->use_count != 0)
1068
		return;
1069

1070
1071
	deactivate_urbs(ep, true);
	wait_clear_urbs(ep);
1072
1073
}

1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
/**
 * snd_usb_endpoint_release: Tear down an snd_usb_endpoint
 *
 * @ep: the endpoint to release
 *
 * This function does not care for the endpoint's use count but will tear
 * down all the streaming URBs immediately.
 */
void snd_usb_endpoint_release(struct snd_usb_endpoint *ep)
{
	release_urbs(ep, 1);
}

1087
1088
/**
 * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
1089
 *
1090
 * @ep: the endpoint to free
1091
 *
1092
 * This free all resources of the given ep.
1093
 */
1094
void snd_usb_endpoint_free(struct snd_usb_endpoint *ep)
1095
1096
1097
1098
{
	kfree(ep);
}

1099
1100
1101
1102
1103
1104
1105
1106
1107
/**
 * snd_usb_handle_sync_urb: parse an USB sync packet
 *
 * @ep: the endpoint to handle the packet
 * @sender: the sending endpoint
 * @urb: the received packet
 *
 * This function is called from the context of an endpoint that received
 * the packet and is used to let another endpoint object handle the payload.
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 */
void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
			     struct snd_usb_endpoint *sender,
			     const struct urb *urb)
{
	int shift;
	unsigned int f;
	unsigned long flags;

	snd_BUG_ON(ep == sender);

1119
1120
	/*
	 * In case the endpoint is operating in implicit feedback mode, prepare
1121
1122
1123
	 * a new outbound URB that has the same layout as the received packet
	 * and add it to the list of pending urbs. queue_pending_output_urbs()
	 * will take care of them later.
1124
	 */
1125
	if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
	    ep->use_count != 0) {

		/* implicit feedback case */
		int i, bytes = 0;
		struct snd_urb_ctx *in_ctx;
		struct snd_usb_packet_info *out_packet;

		in_ctx = urb->context;

		/* Count overall packet size */
		for (i = 0; i < in_ctx->packets; i++)
			if (urb->iso_frame_desc[i].status == 0)
				bytes += urb->iso_frame_desc[i].actual_length;

		/*
		 * skip empty packets. At least M-Audio's Fast Track Ultra stops
		 * streaming once it received a 0-byte OUT URB
		 */
		if (bytes == 0)
			return;

		spin_lock_irqsave(&ep->lock, flags);
		out_packet = ep->next_packet + ep->next_packet_write_pos;

		/*
		 * Iterate through the inbound packet and prepare the lengths
		 * for the output packet. The OUT packet we are about to send
1153
1154
1155
1156
1157
		 * will have the same amount of payload bytes per stride as the
		 * IN packet we just received. Since the actual size is scaled
		 * by the stride, use the sender stride to calculate the length
		 * in case the number of channels differ between the implicitly
		 * fed-back endpoint and the synchronizing endpoint.
1158
1159
1160
1161
1162
1163
		 */

		out_packet->packets = in_ctx->packets;
		for (i = 0; i < in_ctx->packets; i++) {
			if (urb->iso_frame_desc[i].status == 0)
				out_packet->packet_size[i] =
1164
					urb->iso_frame_desc[i].actual_length / sender->stride;
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
			else
				out_packet->packet_size[i] = 0;
		}

		ep->next_packet_write_pos++;
		ep->next_packet_write_pos %= MAX_URBS;
		spin_unlock_irqrestore(&ep->lock, flags);
		queue_pending_output_urbs(ep);

		return;
	}

1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
	/*
	 * process after playback sync complete
	 *
	 * Full speed devices report feedback values in 10.14 format as samples
	 * per frame, high speed devices in 16.16 format as samples per
	 * microframe.
	 *
	 * Because the Audio Class 1 spec was written before USB 2.0, many high
	 * speed devices use a wrong interpretation, some others use an
	 * entirely different format.
	 *
	 * Therefore, we cannot predict what format any particular device uses
	 * and must detect it automatically.
	 */
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204

	if (urb->iso_frame_desc[0].status != 0 ||
	    urb->iso_frame_desc[0].actual_length < 3)
		return;

	f = le32_to_cpup(urb->transfer_buffer);
	if (urb->iso_frame_desc[0].actual_length == 3)
		f &= 0x00ffffff;
	else
		f &= 0x0fffffff;

	if (f == 0)
		return;

1205
	if (unlikely(sender->tenor_fb_quirk)) {
1206
		/*
1207
1208
		 * Devices based on Tenor 8802 chipsets (TEAC UD-H01
		 * and others) sometimes change the feedback value
1209
1210
1211
		 * by +/- 0x1.0000.
		 */
		if (f < ep->freqn - 0x8000)
1212
			f += 0xf000;
1213
		else if (f > ep->freqn + 0x8000)
1214
			f -= 0xf000;
1215
	} else if (unlikely(ep->freqshift == INT_MIN)) {
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
		/*
		 * The first time we see a feedback value, determine its format
		 * by shifting it left or right until it matches the nominal
		 * frequency value.  This assumes that the feedback does not
		 * differ from the nominal value more than +50% or -25%.
		 */
		shift = 0;
		while (f < ep->freqn - ep->freqn / 4) {
			f <<= 1;
			shift++;
		}
		while (f > ep->freqn + ep->freqn / 2) {
			f >>= 1;
			shift--;
		}
		ep->freqshift = shift;
	} else if (ep->freqshift >= 0)
		f <<= ep->freqshift;
	else
		f >>= -ep->freqshift;

	if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
		/*
		 * If the frequency looks valid, set it.
		 * This value is referred to in prepare_playback_urb().
		 */
		spin_lock_irqsave(&ep->lock, flags);
		ep->freqm = f;
		spin_unlock_irqrestore(&ep->lock, flags);
	} else {
		/*
		 * Out of range; maybe the shift value is wrong.
		 * Reset it so that we autodetect again the next time.
		 */
		ep->freqshift = INT_MIN;
	}
}