Blame view

sound/usb/endpoint.c 39.5 KB
1a59d1b8e   Thomas Gleixner   treewide: Replace...
1
  // SPDX-License-Identifier: GPL-2.0-or-later
e5779998b   Daniel Mack   ALSA: usb-audio: ...
2
  /*
e5779998b   Daniel Mack   ALSA: usb-audio: ...
3
   */
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
4
5
  #include <linux/gfp.h>
  #include <linux/init.h>
80c8a2a37   Takashi Iwai   ALSA: usb-audio -...
6
  #include <linux/ratelimit.h>
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
7
8
  #include <linux/usb.h>
  #include <linux/usb/audio.h>
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
9
  #include <linux/slab.h>
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
10
11
12
  
  #include <sound/core.h>
  #include <sound/pcm.h>
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
13
  #include <sound/pcm_params.h>
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
14
15
16
17
18
19
  
  #include "usbaudio.h"
  #include "helper.h"
  #include "card.h"
  #include "endpoint.h"
  #include "pcm.h"
2b58fd5b3   Daniel Mack   ALSA: snd-usb: Ad...
20
  #include "quirks.h"
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
21

8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
22
  #define EP_FLAG_RUNNING		1
f58161ba1   Takashi Iwai   ALSA: usb-audio: ...
23
  #define EP_FLAG_STOPPING	2
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
24

c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
25
  /*
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
26
27
28
29
   * 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
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
30
   * optional callbacks to let the pcm logic handle the actual content of the
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
31
32
33
   * packets for playback and record. Thus, the bus streaming and the audio
   * handlers are fully decoupled.
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
34
   * There are two different types of endpoints in audio applications.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
35
36
37
38
   *
   * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
   * inbound and outbound traffic.
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
39
40
41
   * 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).
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
42
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
43
44
   * Each endpoint has to be configured prior to being used by calling
   * snd_usb_endpoint_set_params().
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
45
46
47
48
   *
   * 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
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
49
   * one to stop it will tear the URBs down again.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
50
51
52
   */
  
  /*
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
   * 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;
  }
  
  /*
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
71
72
73
74
   * release a urb data
   */
  static void release_urb_ctx(struct snd_urb_ctx *u)
  {
d399ff959   Daniel Mack   ALSA: snd-usb: re...
75
76
77
78
79
80
  	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;
c731bc96a   Daniel Mack   ALSA: snd-usb: mo...
81
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
  }
  
  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";
  	}
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
107
108
109
  /**
   * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
110
   * @ep: The snd_usb_endpoint
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
111
112
113
114
   *
   * Determine whether an endpoint is driven by an implicit feedback
   * data endpoint source.
   */
98ae472b5   Eldad Zack   ALSA: usb-audio: ...
115
  int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
116
117
118
119
120
121
  {
  	return  ep->sync_master &&
  		ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
  		ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
  		usb_pipeout(ep->pipe);
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
122
123
  /*
   * For streaming based on information derived from sync endpoints,
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
124
   * prepare_outbound_urb_sizes() will call slave_next_packet_size() to
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
125
126
   * determine the number of samples to be sent in the next packet.
   *
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
127
   * For implicit feedback, slave_next_packet_size() is unused.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
128
   */
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
129
  int snd_usb_endpoint_slave_next_packet_size(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
  {
  	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;
  }
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
145
146
147
148
149
150
151
152
153
154
155
156
157
  /*
   * 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;
b9fd2007c   Alexander Tsoy   ALSA: usb-audio: ...
158
159
160
  	if (ep->sample_accum >= ep->pps) {
  		ep->sample_accum -= ep->pps;
  		ret = ep->packsize[1];
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
161
  	} else {
b9fd2007c   Alexander Tsoy   ALSA: usb-audio: ...
162
  		ret = ep->packsize[0];
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
163
164
165
166
  	}
  
  	return ret;
  }
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
167
168
169
170
171
172
173
174
175
176
177
  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;
2b58fd5b3   Daniel Mack   ALSA: snd-usb: Ad...
178
179
180
181
  	if (unlikely(ep->skip_packets > 0)) {
  		ep->skip_packets--;
  		return;
  	}
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
182
183
184
185
186
187
  	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);
  }
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
188
189
190
191
192
  static void prepare_silent_urb(struct snd_usb_endpoint *ep,
  			       struct snd_urb_ctx *ctx)
  {
  	struct urb *urb = ctx->urb;
  	unsigned int offs = 0;
e05704467   Ricard Wanderlof   ALSA: USB-audio: ...
193
194
  	unsigned int extra = 0;
  	__le32 packet_length;
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
195
  	int i;
e05704467   Ricard Wanderlof   ALSA: USB-audio: ...
196
197
198
  	/* For tx_length_quirk, put packet length at start of packet */
  	if (ep->chip->tx_length_quirk)
  		extra = sizeof(packet_length);
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
199
  	for (i = 0; i < ctx->packets; ++i) {
e05704467   Ricard Wanderlof   ALSA: USB-audio: ...
200
201
  		unsigned int offset;
  		unsigned int length;
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
202
203
204
205
  		int counts;
  
  		if (ctx->packet_size[i])
  			counts = ctx->packet_size[i];
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
206
207
  		else if (ep->sync_master)
  			counts = snd_usb_endpoint_slave_next_packet_size(ep);
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
208
209
  		else
  			counts = snd_usb_endpoint_next_packet_size(ep);
e05704467   Ricard Wanderlof   ALSA: USB-audio: ...
210
211
212
213
214
215
216
217
218
219
220
  		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);
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
221
222
223
224
  		offs += counts;
  	}
  
  	urb->number_of_packets = ctx->packets;
e05704467   Ricard Wanderlof   ALSA: USB-audio: ...
225
  	urb->transfer_buffer_length = offs * ep->stride + ctx->packets * extra;
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
226
  }
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
227
228
229
230
231
232
  /*
   * Prepare a PLAYBACK urb for submission to the bus.
   */
  static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
  				 struct snd_urb_ctx *ctx)
  {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
233
234
235
236
237
238
239
240
241
242
243
  	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 */
5cf310e97   Ricard Wanderlof   ALSA: USB-audio: ...
244
  			prepare_silent_urb(ep, ctx);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
245
246
247
248
249
250
251
252
253
254
255
256
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
  		}
  		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;
  	}
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
306
  /*
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
307
   * Send output urbs that have been prepared previously. URBs are dequeued
0569b3d8a   Randy Dunlap   ALSA: usb-audio: ...
308
   * from ep->ready_playback_urbs and in case there aren't any available
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
309
310
311
   * or there are no packets that have been prepared, this function does
   * nothing.
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
312
313
314
   * 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.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
315
316
   *
   * This function is only used for implicit feedback endpoints. For endpoints
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
317
318
   * driven by dedicated sync endpoints, URBs are immediately re-submitted
   * from their completion handler.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
319
   */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
320
321
322
323
324
  static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
  {
  	while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
  
  		unsigned long flags;
3f649ab72   Kees Cook   treewide: Remove ...
325
  		struct snd_usb_packet_info *packet;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
326
  		struct snd_urb_ctx *ctx = NULL;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
327
328
329
330
331
332
333
334
335
  		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 */
5b6cc38f3   Takashi Iwai   ALSA: usb-audio: ...
336
  			if (!list_empty(&ep->ready_playback_urbs)) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
337
338
  				ctx = list_first_entry(&ep->ready_playback_urbs,
  					       struct snd_urb_ctx, ready_list);
5b6cc38f3   Takashi Iwai   ALSA: usb-audio: ...
339
340
  				list_del_init(&ctx->ready_list);
  			}
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
341
342
343
344
345
  		}
  		spin_unlock_irqrestore(&ep->lock, flags);
  
  		if (ctx == NULL)
  			return;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
346
347
348
  		/* copy over the length information */
  		for (i = 0; i < packet->packets; i++)
  			ctx->packet_size[i] = packet->packet_size[i];
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
349
  		/* call the data handler to fill in playback data */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
350
351
352
353
  		prepare_outbound_urb(ep, ctx);
  
  		err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
  		if (err < 0)
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
354
355
356
357
  			usb_audio_err(ep->chip,
  				"Unable to submit urb #%d: %d (urb %p)
  ",
  				ctx->index, err, ctx->urb);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
358
359
360
361
362
363
364
365
366
367
368
369
  		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;
67e225009   Takashi Iwai   ALSA: usb-audio: ...
370
371
  	struct snd_pcm_substream *substream;
  	unsigned long flags;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
372
373
374
375
376
  	int err;
  
  	if (unlikely(urb->status == -ENOENT ||		/* unlinked */
  		     urb->status == -ENODEV ||		/* device removed */
  		     urb->status == -ECONNRESET ||	/* unlinked */
47ab15459   Takashi Iwai   ALSA: usb-audio: ...
377
378
379
380
  		     urb->status == -ESHUTDOWN))	/* device disabled */
  		goto exit_clear;
  	/* device disconnected */
  	if (unlikely(atomic_read(&ep->chip->shutdown)))
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
381
  		goto exit_clear;
13a6c8328   Ioan-Adrian Ratiu   ALSA: usb-audio: ...
382
383
  	if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
  		goto exit_clear;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
384
385
386
387
388
  	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;
98ae472b5   Eldad Zack   ALSA: usb-audio: ...
389
  		if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
390
391
392
393
394
395
396
  			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;
  		}
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
397
  		prepare_outbound_urb(ep, ctx);
528699317   Henry Lin   ALSA: usb-audio: ...
398
399
400
  		/* can be stopped during prepare callback */
  		if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
  			goto exit_clear;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
401
402
403
404
405
406
407
408
409
410
411
412
  	} 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;
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
413
414
  	usb_audio_err(ep->chip, "cannot submit urb (err = %d)
  ", err);
67e225009   Takashi Iwai   ALSA: usb-audio: ...
415
416
  	if (ep->data_subs && ep->data_subs->pcm_substream) {
  		substream = ep->data_subs->pcm_substream;
1fb8510cd   Takashi Iwai   ALSA: pcm: Add sn...
417
  		snd_pcm_stop_xrun(substream);
67e225009   Takashi Iwai   ALSA: usb-audio: ...
418
  	}
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
419
420
421
422
  
  exit_clear:
  	clear_bit(ctx->index, &ep->active_mask);
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
423
  /**
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
424
   * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
425
426
427
428
429
430
431
432
433
434
435
436
437
   *
   * @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().
447d6275f   Takashi Iwai   ALSA: usb-audio: ...
438
439
440
   *
   * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that
   * bNumEndpoints > 1 beforehand.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
441
   */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
442
443
444
445
  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)
  {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
446
  	struct snd_usb_endpoint *ep;
68e67f40b   Daniel Mack   ALSA: snd-usb: mo...
447
  	int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
448

e7e58df8e   Eldad Zack   ALSA: usb-audio: ...
449
450
  	if (WARN_ON(!alts))
  		return NULL;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
451
  	mutex_lock(&chip->mutex);
88766f04c   Eldad Zack   ALSA: usb-audio: ...
452
  	list_for_each_entry(ep, &chip->ep_list, list) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
453
454
  		if (ep->ep_num == ep_num &&
  		    ep->iface == alts->desc.bInterfaceNumber &&
df23a2466   Eldad Zack   ALSA: usb-audio: ...
455
  		    ep->altsetting == alts->desc.bAlternateSetting) {
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
456
457
458
  			usb_audio_dbg(ep->chip,
  				      "Re-using EP %x in iface %d,%d @%p
  ",
df23a2466   Eldad Zack   ALSA: usb-audio: ...
459
  					ep_num, ep->iface, ep->altsetting, ep);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
460
461
462
  			goto __exit_unlock;
  		}
  	}
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
463
464
  	usb_audio_dbg(chip, "Creating new %s %s endpoint #%x
  ",
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
465
466
467
  		    is_playback ? "playback" : "capture",
  		    type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
  		    ep_num);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
468
469
470
471
472
473
474
475
476
  	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;
df23a2466   Eldad Zack   ALSA: usb-audio: ...
477
  	ep->altsetting = alts->desc.bAlternateSetting;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
  	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);
10ce77e48   Erwin Burema   ALSA: usb-audio: ...
503
  	ep->is_implicit_feedback = 0;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
504
505
506
507
508
509
510
511
512
513
514
515
  __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);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
516
517
518
  	int alive;
  
  	do {
190006f9d   Joe Perches   ALSA: usb-audio: ...
519
  		alive = bitmap_weight(&ep->active_mask, ep->nurbs);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
520
521
522
523
524
525
526
  		if (!alive)
  			break;
  
  		schedule_timeout_uninterruptible(1);
  	} while (time_before(jiffies, end_time));
  
  	if (alive)
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
527
528
529
530
  		usb_audio_err(ep->chip,
  			"timeout: still %d active urbs on EP #%x
  ",
  			alive, ep->ep_num);
f58161ba1   Takashi Iwai   ALSA: usb-audio: ...
531
  	clear_bit(EP_FLAG_STOPPING, &ep->flags);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
532

1d0f95308   Ioan-Adrian Ratiu   ALSA: usb-audio: ...
533
534
535
536
  	ep->data_subs = NULL;
  	ep->sync_slave = NULL;
  	ep->retire_data_urb = NULL;
  	ep->prepare_data_urb = NULL;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
537
538
  	return 0;
  }
f58161ba1   Takashi Iwai   ALSA: usb-audio: ...
539
540
541
542
543
544
545
546
  /* 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);
  }
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
547
548
549
  /*
   * unlink active urbs.
   */
ccc1696d5   Takashi Iwai   ALSA: usb-audio: ...
550
  static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
551
  {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
552
  	unsigned int i;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
553

47ab15459   Takashi Iwai   ALSA: usb-audio: ...
554
  	if (!force && atomic_read(&ep->chip->shutdown)) /* to be sure... */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
555
  		return -EBADFD;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
556
557
558
559
560
  	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;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
561
562
563
564
  	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;
ccc1696d5   Takashi Iwai   ALSA: usb-audio: ...
565
  				usb_unlink_urb(u);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
  			}
  		}
  	}
  
  	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 */
ccc1696d5   Takashi Iwai   ALSA: usb-audio: ...
585
  	deactivate_urbs(ep, force);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
586
587
588
589
  	wait_clear_urbs(ep);
  
  	for (i = 0; i < ep->nurbs; i++)
  		release_urb_ctx(&ep->urb[i]);
2e5a8e152   Xu Wang   ALSA: usb-audio: ...
590
591
  	usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
  			  ep->syncbuf, ep->sync_dma);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
592
593
594
595
  
  	ep->syncbuf = NULL;
  	ep->nurbs = 0;
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
596
  /*
10ce77e48   Erwin Burema   ALSA: usb-audio: ...
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
   * Check data endpoint for format differences
   */
  static bool check_ep_params(struct snd_usb_endpoint *ep,
  			      snd_pcm_format_t pcm_format,
  			      unsigned int channels,
  			      unsigned int period_bytes,
  			      unsigned int frames_per_period,
  			      unsigned int periods_per_buffer,
  			      struct audioformat *fmt,
  			      struct snd_usb_endpoint *sync_ep)
  {
  	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;
  	int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
  	int tx_length_quirk = (ep->chip->tx_length_quirk &&
  			       usb_pipeout(ep->pipe));
  	bool ret = 1;
  
  	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;
  	}
  
  	ret = ret && (ep->datainterval == fmt->datainterval);
  	ret = ret && (ep->stride == frame_bits >> 3);
  
  	switch (pcm_format) {
  	case SNDRV_PCM_FORMAT_U8:
  		ret = ret && (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:
  		ret = ret && (ep->silence_value == 0x69);
  		break;
  	default:
  		ret = ret && (ep->silence_value == 0);
  	}
  
  	/* assume max. frequency is 50% higher than nominal */
  	ret = ret && (ep->freqmax == ep->freqn + (ep->freqn >> 1));
  	/* 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);
  	if (tx_length_quirk)
  		maxsize += sizeof(__le32); /* Space for length descriptor */
  	/* but wMaxPacketSize might reduce this */
  	if (ep->maxpacksize && ep->maxpacksize < maxsize) {
  		/* whatever fits into a max. size packet */
  		unsigned int data_maxsize = maxsize = ep->maxpacksize;
  
  		if (tx_length_quirk)
  			/* Need to remove the length descriptor to calc freq */
  			data_maxsize -= sizeof(__le32);
  		ret = ret && (ep->freqmax == (data_maxsize / (frame_bits >> 3))
  				<< (16 - ep->datainterval));
  	}
  
  	if (ep->fill_max)
  		ret = ret && (ep->curpacksize == ep->maxpacksize);
  	else
  		ret = ret && (ep->curpacksize == maxsize);
  
  	if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
  		packs_per_ms = 8 >> ep->datainterval;
  		max_packs_per_urb = MAX_PACKS_HS;
  	} else {
  		packs_per_ms = 1;
  		max_packs_per_urb = MAX_PACKS;
  	}
  	if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
  		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)) {
  
  		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;
  			}
  		}
  		/* make capture URBs <= 1 ms and smaller than a period */
  		urb_packs = min(max_packs_per_urb, urb_packs);
  		while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
  			urb_packs >>= 1;
  		ret = ret && (ep->nurbs == MAX_URBS);
  
  	/*
  	 * 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 {
  		/* determine how small a packet can be */
  		minsize = (ep->freqn >> (16 - ep->datainterval)) *
  				(frame_bits >> 3);
  		/* with sync from device, assume it can be 12% lower */
  		if (sync_ep)
  			minsize -= minsize >> 3;
  		minsize = max(minsize, 1u);
  
  		/* 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 */
  		ret = ret && (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);
  		ret = ret && (ep->nurbs == min(max_urbs,
  				urbs_per_period * periods_per_buffer));
  	}
  
  	ret = ret && (ep->datainterval == fmt->datainterval);
  	ret = ret && (ep->maxpacksize == fmt->maxpacksize);
  	ret = ret &&
  		(ep->fill_max == !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX));
  
  	return ret;
  }
  
  /*
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
769
770
   * configure a data endpoint
   */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
771
  static int data_ep_set_params(struct snd_usb_endpoint *ep,
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
772
773
774
  			      snd_pcm_format_t pcm_format,
  			      unsigned int channels,
  			      unsigned int period_bytes,
976b6c064   Alan Stern   ALSA: improve buf...
775
776
  			      unsigned int frames_per_period,
  			      unsigned int periods_per_buffer,
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
777
778
779
  			      struct audioformat *fmt,
  			      struct snd_usb_endpoint *sync_ep)
  {
976b6c064   Alan Stern   ALSA: improve buf...
780
781
782
  	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;
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
783
  	int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
759c90fe0   Ricard Wanderlof   ALSA: USB-audio: ...
784
785
  	int tx_length_quirk = (ep->chip->tx_length_quirk &&
  			       usb_pipeout(ep->pipe));
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
786

d24f5061e   Daniel Mack   ALSA: snd-usb: ad...
787
788
789
790
791
792
793
794
  	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;
  	}
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
795
796
  	ep->datainterval = fmt->datainterval;
  	ep->stride = frame_bits >> 3;
012007309   Nobutaka Okabe   ALSA: usb-audio: ...
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
  
  	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;
  	}
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
812

fd1a50596   Andreas Pape   ALSA: usb-audio: ...
813
814
  	/* assume max. frequency is 50% higher than nominal */
  	ep->freqmax = ep->freqn + (ep->freqn >> 1);
ab30965d9   Ricard Wanderlof   ALSA: usb-audio: ...
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
  	/* 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);
759c90fe0   Ricard Wanderlof   ALSA: USB-audio: ...
832
833
  	if (tx_length_quirk)
  		maxsize += sizeof(__le32); /* Space for length descriptor */
57e6dae10   Clemens Ladisch   ALSA: usb-audio: ...
834
835
  	/* but wMaxPacketSize might reduce this */
  	if (ep->maxpacksize && ep->maxpacksize < maxsize) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
836
  		/* whatever fits into a max. size packet */
759c90fe0   Ricard Wanderlof   ALSA: USB-audio: ...
837
838
839
840
841
842
  		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))
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
843
  				<< (16 - ep->datainterval);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
844
845
846
847
848
849
  	}
  
  	if (ep->fill_max)
  		ep->curpacksize = ep->maxpacksize;
  	else
  		ep->curpacksize = maxsize;
976b6c064   Alan Stern   ALSA: improve buf...
850
  	if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
851
  		packs_per_ms = 8 >> ep->datainterval;
976b6c064   Alan Stern   ALSA: improve buf...
852
  		max_packs_per_urb = MAX_PACKS_HS;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
853
  	} else {
976b6c064   Alan Stern   ALSA: improve buf...
854
855
  		packs_per_ms = 1;
  		max_packs_per_urb = MAX_PACKS;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
856
  	}
98ae472b5   Eldad Zack   ALSA: usb-audio: ...
857
  	if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
976b6c064   Alan Stern   ALSA: improve buf...
858
859
860
861
862
863
864
865
866
867
868
869
870
871
  		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)) {
a93455e1c   Thomas Pugliese   ALSA: usb: use mu...
872
873
874
875
876
877
878
879
880
881
882
883
884
885
  		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;
  			}
  		}
976b6c064   Alan Stern   ALSA: improve buf...
886
  		/* make capture URBs <= 1 ms and smaller than a period */
a93455e1c   Thomas Pugliese   ALSA: usb: use mu...
887
  		urb_packs = min(max_packs_per_urb, urb_packs);
976b6c064   Alan Stern   ALSA: improve buf...
888
889
890
  		while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
  			urb_packs >>= 1;
  		ep->nurbs = MAX_URBS;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
891

976b6c064   Alan Stern   ALSA: improve buf...
892
893
894
895
896
897
898
  	/*
  	 * 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 {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
899
  		/* determine how small a packet can be */
976b6c064   Alan Stern   ALSA: improve buf...
900
901
  		minsize = (ep->freqn >> (16 - ep->datainterval)) *
  				(frame_bits >> 3);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
902
903
904
905
  		/* with sync from device, assume it can be 12% lower */
  		if (sync_ep)
  			minsize -= minsize >> 3;
  		minsize = max(minsize, 1u);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
906

976b6c064   Alan Stern   ALSA: improve buf...
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
  		/* 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);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
924
925
926
927
928
929
930
  	}
  
  	/* 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;
976b6c064   Alan Stern   ALSA: improve buf...
931
  		u->packets = urb_packs;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
932
933
934
935
936
937
938
939
940
941
942
943
944
945
  		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;
c75c5ab57   Clemens Ladisch   ALSA: USB: adjust...
946
  		u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
947
948
949
950
951
952
953
954
955
956
957
958
  		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;
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
959
960
961
  /*
   * configure a sync endpoint
   */
937210399   Eldad Zack   ALSA: usb-audio: ...
962
  static int sync_ep_set_params(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
  {
  	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;
c75c5ab57   Clemens Ladisch   ALSA: USB: adjust...
983
  		u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
984
985
986
987
988
989
990
991
992
993
994
995
996
997
  		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;
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
998
  /**
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
999
   * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1000
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1001
   * @ep: the snd_usb_endpoint to configure
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1002
1003
1004
   * @pcm_format: the audio fomat.
   * @channels: the number of audio channels.
   * @period_bytes: the number of bytes in one alsa period.
976b6c064   Alan Stern   ALSA: improve buf...
1005
1006
   * @period_frames: the number of frames in one alsa period.
   * @buffer_periods: the number of periods in one alsa buffer.
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1007
   * @rate: the frame rate.
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1008
1009
   * @fmt: the USB audio format information
   * @sync_ep: the sync endpoint to use, if any
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1010
   *
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1011
   * Determine the number of URBs to be used on this endpoint.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1012
1013
1014
   * An endpoint must be configured before it can be started.
   * An endpoint that is already running can not be reconfigured.
   */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1015
  int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1016
1017
1018
  				snd_pcm_format_t pcm_format,
  				unsigned int channels,
  				unsigned int period_bytes,
976b6c064   Alan Stern   ALSA: improve buf...
1019
1020
  				unsigned int period_frames,
  				unsigned int buffer_periods,
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1021
  				unsigned int rate,
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1022
1023
1024
1025
1026
1027
  				struct audioformat *fmt,
  				struct snd_usb_endpoint *sync_ep)
  {
  	int err;
  
  	if (ep->use_count != 0) {
10ce77e48   Erwin Burema   ALSA: usb-audio: ...
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
  		bool check = ep->is_implicit_feedback &&
  			check_ep_params(ep, pcm_format,
  					     channels, period_bytes,
  					     period_frames, buffer_periods,
  					     fmt, sync_ep);
  
  		if (!check) {
  			usb_audio_warn(ep->chip,
  				"Unable to change format on ep #%x: already in use
  ",
  				ep->ep_num);
  			return -EBUSY;
  		}
  
  		usb_audio_dbg(ep->chip,
  			      "Ep #%x already in use as implicit feedback but format not changed
  ",
  			      ep->ep_num);
  		return 0;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1047
1048
1049
1050
1051
1052
1053
  	}
  
  	/* release old buffers, if any */
  	release_urbs(ep, 0);
  
  	ep->datainterval = fmt->datainterval;
  	ep->maxpacksize = fmt->maxpacksize;
85f71932e   Takashi Iwai   ALSA: usb: Fix fi...
1054
  	ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1055

f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
1056
  	if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL) {
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1057
  		ep->freqn = get_usb_full_speed_rate(rate);
b9fd2007c   Alexander Tsoy   ALSA: usb-audio: ...
1058
  		ep->pps = 1000 >> ep->datainterval;
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
1059
  	} else {
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1060
  		ep->freqn = get_usb_high_speed_rate(rate);
b9fd2007c   Alexander Tsoy   ALSA: usb-audio: ...
1061
  		ep->pps = 8000 >> ep->datainterval;
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
1062
  	}
b9fd2007c   Alexander Tsoy   ALSA: usb-audio: ...
1063
1064
1065
  	ep->sample_rem = rate % ep->pps;
  	ep->packsize[0] = rate / ep->pps;
  	ep->packsize[1] = (rate + (ep->pps - 1)) / ep->pps;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1066
1067
1068
1069
1070
1071
1072
1073
1074
  
  	/* 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:
35ec7aa29   Dylan Reid   ALSA: usb-audio: ...
1075
  		err = data_ep_set_params(ep, pcm_format, channels,
976b6c064   Alan Stern   ALSA: improve buf...
1076
1077
  					 period_bytes, period_frames,
  					 buffer_periods, fmt, sync_ep);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1078
1079
  		break;
  	case  SND_USB_ENDPOINT_TYPE_SYNC:
937210399   Eldad Zack   ALSA: usb-audio: ...
1080
  		err = sync_ep_set_params(ep);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1081
1082
1083
1084
  		break;
  	default:
  		err = -EINVAL;
  	}
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
1085
1086
1087
1088
  	usb_audio_dbg(ep->chip,
  		"Setting params for ep #%x (type %d, %d urbs), ret=%d
  ",
  		ep->ep_num, ep->type, ep->nurbs, err);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1089
1090
1091
  
  	return err;
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1092
1093
1094
  /**
   * snd_usb_endpoint_start: start an snd_usb_endpoint
   *
1d0f95308   Ioan-Adrian Ratiu   ALSA: usb-audio: ...
1095
   * @ep: the endpoint to start
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1096
1097
   *
   * A call to this function will increment the use count of the endpoint.
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1098
   * In case it is not already running, the URBs for this endpoint will be
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1099
1100
1101
1102
1103
1104
   * 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.
   */
1d0f95308   Ioan-Adrian Ratiu   ALSA: usb-audio: ...
1105
  int snd_usb_endpoint_start(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1106
1107
1108
  {
  	int err;
  	unsigned int i;
47ab15459   Takashi Iwai   ALSA: usb-audio: ...
1109
  	if (atomic_read(&ep->chip->shutdown))
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1110
1111
1112
1113
1114
  		return -EBADFD;
  
  	/* already running? */
  	if (++ep->use_count != 1)
  		return 0;
015618b90   Daniel Mack   ALSA: snd-usb: Fi...
1115
  	/* just to be sure */
ccc1696d5   Takashi Iwai   ALSA: usb-audio: ...
1116
  	deactivate_urbs(ep, false);
015618b90   Daniel Mack   ALSA: snd-usb: Fi...
1117

8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1118
1119
1120
  	ep->active_mask = 0;
  	ep->unlink_mask = 0;
  	ep->phase = 0;
f0bd62b64   Alexander Tsoy   ALSA: usb-audio: ...
1121
  	ep->sample_accum = 0;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1122

2b58fd5b3   Daniel Mack   ALSA: snd-usb: Ad...
1123
  	snd_usb_endpoint_start_quirk(ep);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1124
1125
1126
  	/*
  	 * If this endpoint has a data endpoint as implicit feedback source,
  	 * don't start the urbs here. Instead, mark them all as available,
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1127
1128
  	 * wait for the record urbs to return and queue the playback urbs
  	 * from that context.
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1129
1130
1131
  	 */
  
  	set_bit(EP_FLAG_RUNNING, &ep->flags);
98ae472b5   Eldad Zack   ALSA: usb-audio: ...
1132
  	if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
  		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)) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1148
1149
1150
1151
1152
1153
1154
  			prepare_outbound_urb(ep, urb->context);
  		} else {
  			prepare_inbound_urb(ep, urb->context);
  		}
  
  		err = usb_submit_urb(urb, GFP_ATOMIC);
  		if (err < 0) {
0ba41d917   Takashi Iwai   ALSA: usb-audio: ...
1155
1156
1157
1158
  			usb_audio_err(ep->chip,
  				"cannot submit urb %d, error %d: %s
  ",
  				i, err, usb_error_string(err));
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
  			goto __error;
  		}
  		set_bit(i, &ep->active_mask);
  	}
  
  	return 0;
  
  __error:
  	clear_bit(EP_FLAG_RUNNING, &ep->flags);
  	ep->use_count--;
ccc1696d5   Takashi Iwai   ALSA: usb-audio: ...
1169
  	deactivate_urbs(ep, false);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1170
1171
  	return -EPIPE;
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1172
1173
1174
1175
1176
1177
1178
  /**
   * 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
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1179
   * actually be deactivated.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1180
1181
   *
   * Must be balanced to calls of snd_usb_endpoint_start().
b2eb950de   Takashi Iwai   ALSA: usb-audio: ...
1182
1183
1184
   *
   * The caller needs to synchronize the pending stop operation via
   * snd_usb_endpoint_sync_pending_stop().
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1185
   */
b2eb950de   Takashi Iwai   ALSA: usb-audio: ...
1186
  void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1187
1188
1189
1190
1191
1192
  {
  	if (!ep)
  		return;
  
  	if (snd_BUG_ON(ep->use_count == 0))
  		return;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1193
  	if (--ep->use_count == 0) {
ccc1696d5   Takashi Iwai   ALSA: usb-audio: ...
1194
  		deactivate_urbs(ep, false);
b2eb950de   Takashi Iwai   ALSA: usb-audio: ...
1195
  		set_bit(EP_FLAG_STOPPING, &ep->flags);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1196
1197
  	}
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1198
  /**
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1199
1200
1201
1202
   * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
   *
   * @ep: the endpoint to deactivate
   *
9b7c552bb   Eldad Zack   ALSA: usb-audio: ...
1203
1204
   * If the endpoint is not currently in use, this functions will
   * deactivate its associated URBs.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1205
1206
   *
   * In case of any active users, this functions does nothing.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1207
   */
9b7c552bb   Eldad Zack   ALSA: usb-audio: ...
1208
  void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1209
1210
  {
  	if (!ep)
9b7c552bb   Eldad Zack   ALSA: usb-audio: ...
1211
  		return;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1212
1213
  
  	if (ep->use_count != 0)
9b7c552bb   Eldad Zack   ALSA: usb-audio: ...
1214
  		return;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1215

239b9f799   Eldad Zack   ALSA: usb-audio: ...
1216
1217
  	deactivate_urbs(ep, true);
  	wait_clear_urbs(ep);
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1218
  }
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1219
  /**
92a586bdc   Takashi Iwai   ALSA: usb-audio: ...
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
   * 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);
  }
  
  /**
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1233
   * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1234
   *
a6cece9d8   Takashi Iwai   ALSA: usb-audio: ...
1235
   * @ep: the endpoint to free
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1236
   *
92a586bdc   Takashi Iwai   ALSA: usb-audio: ...
1237
   * This free all resources of the given ep.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1238
   */
a6cece9d8   Takashi Iwai   ALSA: usb-audio: ...
1239
  void snd_usb_endpoint_free(struct snd_usb_endpoint *ep)
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1240
  {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1241
1242
  	kfree(ep);
  }
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1243
1244
1245
1246
1247
1248
1249
1250
1251
  /**
   * 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.
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
   */
  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);
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1262
1263
  	/*
  	 * In case the endpoint is operating in implicit feedback mode, prepare
07a5e9d4f   Daniel Mack   ALSA: snd-usb: fi...
1264
1265
1266
  	 * 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.
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1267
  	 */
98ae472b5   Eldad Zack   ALSA: usb-audio: ...
1268
  	if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
  	    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
28acb1201   Eldad Zack   ALSA: usb-audio: ...
1296
1297
1298
1299
1300
  		 * 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.
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1301
1302
1303
1304
1305
1306
  		 */
  
  		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] =
28acb1201   Eldad Zack   ALSA: usb-audio: ...
1307
  					urb->iso_frame_desc[i].actual_length / sender->stride;
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
  			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;
  	}
94c27215b   Daniel Mack   ALSA: snd-usb: ad...
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
  	/*
  	 * 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.
  	 */
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
  
  	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;
ca0dd2736   Daniel Mack   ALSA: usb: use TE...
1346
  	if (unlikely(sender->tenor_fb_quirk)) {
7040b6d1f   Clemens Ladisch   ALSA: usb-audio: ...
1347
  		/*
ca0dd2736   Daniel Mack   ALSA: usb: use TE...
1348
1349
  		 * Devices based on Tenor 8802 chipsets (TEAC UD-H01
  		 * and others) sometimes change the feedback value
7040b6d1f   Clemens Ladisch   ALSA: usb-audio: ...
1350
1351
1352
  		 * by +/- 0x1.0000.
  		 */
  		if (f < ep->freqn - 0x8000)
36e1ac3cf   Daniel Mack   ALSA: usb: fine-t...
1353
  			f += 0xf000;
7040b6d1f   Clemens Ladisch   ALSA: usb-audio: ...
1354
  		else if (f > ep->freqn + 0x8000)
36e1ac3cf   Daniel Mack   ALSA: usb: fine-t...
1355
  			f -= 0xf000;
7040b6d1f   Clemens Ladisch   ALSA: usb-audio: ...
1356
  	} else if (unlikely(ep->freqshift == INT_MIN)) {
8fdff6a31   Daniel Mack   ALSA: snd-usb: im...
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
  		/*
  		 * 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;
  	}
  }