blob: 114e3e7ff511d49897d292b541c634872614c656 [file] [log] [blame]
Daniel Macke5779992010-03-04 19:46:13 +01001/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 */
17
Daniel Mackc731bc92011-09-14 12:46:57 +020018#include <linux/gfp.h>
19#include <linux/init.h>
Takashi Iwai80c8a2a2012-01-09 11:37:20 +010020#include <linux/ratelimit.h>
Daniel Mackc731bc92011-09-14 12:46:57 +020021#include <linux/usb.h>
22#include <linux/usb/audio.h>
Daniel Mack8fdff6a2012-04-12 13:51:11 +020023#include <linux/slab.h>
Daniel Mackc731bc92011-09-14 12:46:57 +020024
25#include <sound/core.h>
26#include <sound/pcm.h>
Daniel Mack8fdff6a2012-04-12 13:51:11 +020027#include <sound/pcm_params.h>
Daniel Mackc731bc92011-09-14 12:46:57 +020028
29#include "usbaudio.h"
30#include "helper.h"
31#include "card.h"
32#include "endpoint.h"
33#include "pcm.h"
Daniel Mack2b58fd52012-09-04 10:23:07 +020034#include "quirks.h"
Daniel Mackc731bc92011-09-14 12:46:57 +020035
Daniel Mack8fdff6a2012-04-12 13:51:11 +020036#define EP_FLAG_RUNNING 1
Takashi Iwaif58161b2012-11-08 08:52:45 +010037#define EP_FLAG_STOPPING 2
Daniel Mack8fdff6a2012-04-12 13:51:11 +020038
Daniel Mackc731bc92011-09-14 12:46:57 +020039/*
Daniel Mack94c27212012-04-12 13:51:15 +020040 * snd_usb_endpoint is a model that abstracts everything related to an
41 * USB endpoint and its streaming.
42 *
43 * There are functions to activate and deactivate the streaming URBs and
Daniel Mack07a5e9d2012-04-24 19:31:24 +020044 * optional callbacks to let the pcm logic handle the actual content of the
Daniel Mack94c27212012-04-12 13:51:15 +020045 * packets for playback and record. Thus, the bus streaming and the audio
46 * handlers are fully decoupled.
47 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +020048 * There are two different types of endpoints in audio applications.
Daniel Mack94c27212012-04-12 13:51:15 +020049 *
50 * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
51 * inbound and outbound traffic.
52 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +020053 * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
54 * expect the payload to carry Q10.14 / Q16.16 formatted sync information
55 * (3 or 4 bytes).
Daniel Mack94c27212012-04-12 13:51:15 +020056 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +020057 * Each endpoint has to be configured prior to being used by calling
58 * snd_usb_endpoint_set_params().
Daniel Mack94c27212012-04-12 13:51:15 +020059 *
60 * The model incorporates a reference counting, so that multiple users
61 * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
62 * only the first user will effectively start the URBs, and only the last
Daniel Mack07a5e9d2012-04-24 19:31:24 +020063 * one to stop it will tear the URBs down again.
Daniel Mack94c27212012-04-12 13:51:15 +020064 */
65
66/*
Daniel Mackc731bc92011-09-14 12:46:57 +020067 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
68 * this will overflow at approx 524 kHz
69 */
70static inline unsigned get_usb_full_speed_rate(unsigned int rate)
71{
72 return ((rate << 13) + 62) / 125;
73}
74
75/*
76 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
77 * this will overflow at approx 4 MHz
78 */
79static inline unsigned get_usb_high_speed_rate(unsigned int rate)
80{
81 return ((rate << 10) + 62) / 125;
82}
83
84/*
Daniel Mackc731bc92011-09-14 12:46:57 +020085 * release a urb data
86 */
87static void release_urb_ctx(struct snd_urb_ctx *u)
88{
Daniel Mackd399ff92012-04-12 13:51:13 +020089 if (u->buffer_size)
90 usb_free_coherent(u->ep->chip->dev, u->buffer_size,
91 u->urb->transfer_buffer,
92 u->urb->transfer_dma);
93 usb_free_urb(u->urb);
94 u->urb = NULL;
Daniel Mackc731bc92011-09-14 12:46:57 +020095}
96
97static const char *usb_error_string(int err)
98{
99 switch (err) {
100 case -ENODEV:
101 return "no device";
102 case -ENOENT:
103 return "endpoint not enabled";
104 case -EPIPE:
105 return "endpoint stalled";
106 case -ENOSPC:
107 return "not enough bandwidth";
108 case -ESHUTDOWN:
109 return "device disabled";
110 case -EHOSTUNREACH:
111 return "device suspended";
112 case -EINVAL:
113 case -EAGAIN:
114 case -EFBIG:
115 case -EMSGSIZE:
116 return "internal error";
117 default:
118 return "unknown error";
119 }
120}
121
Daniel Mack94c27212012-04-12 13:51:15 +0200122/**
123 * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
124 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200125 * @ep: The snd_usb_endpoint
Daniel Mack94c27212012-04-12 13:51:15 +0200126 *
127 * Determine whether an endpoint is driven by an implicit feedback
128 * data endpoint source.
129 */
Eldad Zack98ae4722013-04-03 23:18:52 +0200130int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200131{
132 return ep->sync_master &&
133 ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
134 ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
135 usb_pipeout(ep->pipe);
136}
137
Daniel Mack94c27212012-04-12 13:51:15 +0200138/*
139 * For streaming based on information derived from sync endpoints,
140 * prepare_outbound_urb_sizes() will call next_packet_size() to
141 * determine the number of samples to be sent in the next packet.
142 *
143 * For implicit feedback, next_packet_size() is unused.
144 */
Daniel Mack245baf92012-08-30 18:52:30 +0200145int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200146{
147 unsigned long flags;
148 int ret;
149
150 if (ep->fill_max)
151 return ep->maxframesize;
152
153 spin_lock_irqsave(&ep->lock, flags);
154 ep->phase = (ep->phase & 0xffff)
155 + (ep->freqm << ep->datainterval);
156 ret = min(ep->phase >> 16, ep->maxframesize);
157 spin_unlock_irqrestore(&ep->lock, flags);
158
159 return ret;
160}
161
162static void retire_outbound_urb(struct snd_usb_endpoint *ep,
163 struct snd_urb_ctx *urb_ctx)
164{
165 if (ep->retire_data_urb)
166 ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
167}
168
169static void retire_inbound_urb(struct snd_usb_endpoint *ep,
170 struct snd_urb_ctx *urb_ctx)
171{
172 struct urb *urb = urb_ctx->urb;
173
Daniel Mack2b58fd52012-09-04 10:23:07 +0200174 if (unlikely(ep->skip_packets > 0)) {
175 ep->skip_packets--;
176 return;
177 }
178
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200179 if (ep->sync_slave)
180 snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
181
182 if (ep->retire_data_urb)
183 ep->retire_data_urb(ep->data_subs, urb);
184}
185
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200186/*
187 * Prepare a PLAYBACK urb for submission to the bus.
188 */
189static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
190 struct snd_urb_ctx *ctx)
191{
192 int i;
193 struct urb *urb = ctx->urb;
194 unsigned char *cp = urb->transfer_buffer;
195
196 urb->dev = ep->chip->dev; /* we need to set this at each time */
197
198 switch (ep->type) {
199 case SND_USB_ENDPOINT_TYPE_DATA:
200 if (ep->prepare_data_urb) {
201 ep->prepare_data_urb(ep->data_subs, urb);
202 } else {
203 /* no data provider, so send silence */
204 unsigned int offs = 0;
205 for (i = 0; i < ctx->packets; ++i) {
Daniel Mack8dce30c2012-09-27 10:26:01 +0200206 int counts;
207
208 if (ctx->packet_size[i])
209 counts = ctx->packet_size[i];
210 else
211 counts = snd_usb_endpoint_next_packet_size(ep);
212
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200213 urb->iso_frame_desc[i].offset = offs * ep->stride;
214 urb->iso_frame_desc[i].length = counts * ep->stride;
215 offs += counts;
216 }
217
218 urb->number_of_packets = ctx->packets;
219 urb->transfer_buffer_length = offs * ep->stride;
220 memset(urb->transfer_buffer, ep->silence_value,
221 offs * ep->stride);
222 }
223 break;
224
225 case SND_USB_ENDPOINT_TYPE_SYNC:
226 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
227 /*
228 * fill the length and offset of each urb descriptor.
229 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
230 */
231 urb->iso_frame_desc[0].length = 4;
232 urb->iso_frame_desc[0].offset = 0;
233 cp[0] = ep->freqn;
234 cp[1] = ep->freqn >> 8;
235 cp[2] = ep->freqn >> 16;
236 cp[3] = ep->freqn >> 24;
237 } else {
238 /*
239 * fill the length and offset of each urb descriptor.
240 * the fixed 10.14 frequency is passed through the pipe.
241 */
242 urb->iso_frame_desc[0].length = 3;
243 urb->iso_frame_desc[0].offset = 0;
244 cp[0] = ep->freqn >> 2;
245 cp[1] = ep->freqn >> 10;
246 cp[2] = ep->freqn >> 18;
247 }
248
249 break;
250 }
251}
252
253/*
254 * Prepare a CAPTURE or SYNC urb for submission to the bus.
255 */
256static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
257 struct snd_urb_ctx *urb_ctx)
258{
259 int i, offs;
260 struct urb *urb = urb_ctx->urb;
261
262 urb->dev = ep->chip->dev; /* we need to set this at each time */
263
264 switch (ep->type) {
265 case SND_USB_ENDPOINT_TYPE_DATA:
266 offs = 0;
267 for (i = 0; i < urb_ctx->packets; i++) {
268 urb->iso_frame_desc[i].offset = offs;
269 urb->iso_frame_desc[i].length = ep->curpacksize;
270 offs += ep->curpacksize;
271 }
272
273 urb->transfer_buffer_length = offs;
274 urb->number_of_packets = urb_ctx->packets;
275 break;
276
277 case SND_USB_ENDPOINT_TYPE_SYNC:
278 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
279 urb->iso_frame_desc[0].offset = 0;
280 break;
281 }
282}
283
Daniel Mack94c27212012-04-12 13:51:15 +0200284/*
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200285 * Send output urbs that have been prepared previously. URBs are dequeued
Daniel Mack94c27212012-04-12 13:51:15 +0200286 * from ep->ready_playback_urbs and in case there there aren't any available
287 * or there are no packets that have been prepared, this function does
288 * nothing.
289 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200290 * The reason why the functionality of sending and preparing URBs is separated
291 * is that host controllers don't guarantee the order in which they return
292 * inbound and outbound packets to their submitters.
Daniel Mack94c27212012-04-12 13:51:15 +0200293 *
294 * This function is only used for implicit feedback endpoints. For endpoints
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200295 * driven by dedicated sync endpoints, URBs are immediately re-submitted
296 * from their completion handler.
Daniel Mack94c27212012-04-12 13:51:15 +0200297 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200298static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
299{
300 while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
301
302 unsigned long flags;
Andrew Morton68853fa2012-04-24 08:10:10 +0200303 struct snd_usb_packet_info *uninitialized_var(packet);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200304 struct snd_urb_ctx *ctx = NULL;
305 struct urb *urb;
306 int err, i;
307
308 spin_lock_irqsave(&ep->lock, flags);
309 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
310 packet = ep->next_packet + ep->next_packet_read_pos;
311 ep->next_packet_read_pos++;
312 ep->next_packet_read_pos %= MAX_URBS;
313
314 /* take URB out of FIFO */
315 if (!list_empty(&ep->ready_playback_urbs))
316 ctx = list_first_entry(&ep->ready_playback_urbs,
317 struct snd_urb_ctx, ready_list);
318 }
319 spin_unlock_irqrestore(&ep->lock, flags);
320
321 if (ctx == NULL)
322 return;
323
324 list_del_init(&ctx->ready_list);
325 urb = ctx->urb;
326
327 /* copy over the length information */
328 for (i = 0; i < packet->packets; i++)
329 ctx->packet_size[i] = packet->packet_size[i];
330
Daniel Mack94c27212012-04-12 13:51:15 +0200331 /* call the data handler to fill in playback data */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200332 prepare_outbound_urb(ep, ctx);
333
334 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
335 if (err < 0)
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100336 usb_audio_err(ep->chip,
337 "Unable to submit urb #%d: %d (urb %p)\n",
338 ctx->index, err, ctx->urb);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200339 else
340 set_bit(ctx->index, &ep->active_mask);
341 }
342}
343
344/*
345 * complete callback for urbs
346 */
347static void snd_complete_urb(struct urb *urb)
348{
349 struct snd_urb_ctx *ctx = urb->context;
350 struct snd_usb_endpoint *ep = ctx->ep;
351 int err;
352
353 if (unlikely(urb->status == -ENOENT || /* unlinked */
354 urb->status == -ENODEV || /* device removed */
355 urb->status == -ECONNRESET || /* unlinked */
356 urb->status == -ESHUTDOWN || /* device disabled */
357 ep->chip->shutdown)) /* device disconnected */
358 goto exit_clear;
359
360 if (usb_pipeout(ep->pipe)) {
361 retire_outbound_urb(ep, ctx);
362 /* can be stopped during retire callback */
363 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
364 goto exit_clear;
365
Eldad Zack98ae4722013-04-03 23:18:52 +0200366 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200367 unsigned long flags;
368
369 spin_lock_irqsave(&ep->lock, flags);
370 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
371 spin_unlock_irqrestore(&ep->lock, flags);
372 queue_pending_output_urbs(ep);
373
374 goto exit_clear;
375 }
376
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200377 prepare_outbound_urb(ep, ctx);
378 } else {
379 retire_inbound_urb(ep, ctx);
380 /* can be stopped during retire callback */
381 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
382 goto exit_clear;
383
384 prepare_inbound_urb(ep, ctx);
385 }
386
387 err = usb_submit_urb(urb, GFP_ATOMIC);
388 if (err == 0)
389 return;
390
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100391 usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200392 //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
393
394exit_clear:
395 clear_bit(ctx->index, &ep->active_mask);
396}
397
Daniel Mack94c27212012-04-12 13:51:15 +0200398/**
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200399 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
Daniel Mack94c27212012-04-12 13:51:15 +0200400 *
401 * @chip: The chip
402 * @alts: The USB host interface
403 * @ep_num: The number of the endpoint to use
404 * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
405 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
406 *
407 * If the requested endpoint has not been added to the given chip before,
408 * a new instance is created. Otherwise, a pointer to the previoulsy
409 * created instance is returned. In case of any error, NULL is returned.
410 *
411 * New endpoints will be added to chip->ep_list and must be freed by
412 * calling snd_usb_endpoint_free().
413 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200414struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
415 struct usb_host_interface *alts,
416 int ep_num, int direction, int type)
417{
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200418 struct snd_usb_endpoint *ep;
Daniel Mack68e67f42012-07-12 13:08:40 +0200419 int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200420
Eldad Zacke7e58df2013-08-03 10:51:15 +0200421 if (WARN_ON(!alts))
422 return NULL;
423
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200424 mutex_lock(&chip->mutex);
425
Eldad Zack88766f02013-04-03 23:18:49 +0200426 list_for_each_entry(ep, &chip->ep_list, list) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200427 if (ep->ep_num == ep_num &&
428 ep->iface == alts->desc.bInterfaceNumber &&
Eldad Zackdf23a242013-10-06 22:31:13 +0200429 ep->altsetting == alts->desc.bAlternateSetting) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100430 usb_audio_dbg(ep->chip,
431 "Re-using EP %x in iface %d,%d @%p\n",
Eldad Zackdf23a242013-10-06 22:31:13 +0200432 ep_num, ep->iface, ep->altsetting, ep);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200433 goto __exit_unlock;
434 }
435 }
436
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100437 usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200438 is_playback ? "playback" : "capture",
439 type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
440 ep_num);
441
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200442 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
443 if (!ep)
444 goto __exit_unlock;
445
446 ep->chip = chip;
447 spin_lock_init(&ep->lock);
448 ep->type = type;
449 ep->ep_num = ep_num;
450 ep->iface = alts->desc.bInterfaceNumber;
Eldad Zackdf23a242013-10-06 22:31:13 +0200451 ep->altsetting = alts->desc.bAlternateSetting;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200452 INIT_LIST_HEAD(&ep->ready_playback_urbs);
453 ep_num &= USB_ENDPOINT_NUMBER_MASK;
454
455 if (is_playback)
456 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
457 else
458 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
459
460 if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
461 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
462 get_endpoint(alts, 1)->bRefresh >= 1 &&
463 get_endpoint(alts, 1)->bRefresh <= 9)
464 ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
465 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
466 ep->syncinterval = 1;
467 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
468 get_endpoint(alts, 1)->bInterval <= 16)
469 ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
470 else
471 ep->syncinterval = 3;
472
473 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
Clemens Ladisch7040b6d2014-05-01 12:20:22 +0200474
475 if (chip->usb_id == USB_ID(0x0644, 0x8038) /* TEAC UD-H01 */ &&
476 ep->syncmaxsize == 4)
477 ep->udh01_fb_quirk = 1;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200478 }
479
480 list_add_tail(&ep->list, &chip->ep_list);
481
482__exit_unlock:
483 mutex_unlock(&chip->mutex);
484
485 return ep;
486}
487
488/*
489 * wait until all urbs are processed.
490 */
491static int wait_clear_urbs(struct snd_usb_endpoint *ep)
492{
493 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200494 int alive;
495
496 do {
Joe Perches190006f2012-11-16 23:35:16 -0800497 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200498 if (!alive)
499 break;
500
501 schedule_timeout_uninterruptible(1);
502 } while (time_before(jiffies, end_time));
503
504 if (alive)
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100505 usb_audio_err(ep->chip,
506 "timeout: still %d active urbs on EP #%x\n",
507 alive, ep->ep_num);
Takashi Iwaif58161b2012-11-08 08:52:45 +0100508 clear_bit(EP_FLAG_STOPPING, &ep->flags);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200509
510 return 0;
511}
512
Takashi Iwaif58161b2012-11-08 08:52:45 +0100513/* sync the pending stop operation;
514 * this function itself doesn't trigger the stop operation
515 */
516void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
517{
518 if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
519 wait_clear_urbs(ep);
520}
521
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200522/*
523 * unlink active urbs.
524 */
Takashi Iwaiccc16962012-11-21 08:22:52 +0100525static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200526{
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200527 unsigned int i;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200528
529 if (!force && ep->chip->shutdown) /* to be sure... */
530 return -EBADFD;
531
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200532 clear_bit(EP_FLAG_RUNNING, &ep->flags);
533
534 INIT_LIST_HEAD(&ep->ready_playback_urbs);
535 ep->next_packet_read_pos = 0;
536 ep->next_packet_write_pos = 0;
537
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200538 for (i = 0; i < ep->nurbs; i++) {
539 if (test_bit(i, &ep->active_mask)) {
540 if (!test_and_set_bit(i, &ep->unlink_mask)) {
541 struct urb *u = ep->urb[i].urb;
Takashi Iwaiccc16962012-11-21 08:22:52 +0100542 usb_unlink_urb(u);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200543 }
544 }
545 }
546
547 return 0;
548}
549
550/*
551 * release an endpoint's urbs
552 */
553static void release_urbs(struct snd_usb_endpoint *ep, int force)
554{
555 int i;
556
557 /* route incoming urbs to nirvana */
558 ep->retire_data_urb = NULL;
559 ep->prepare_data_urb = NULL;
560
561 /* stop urbs */
Takashi Iwaiccc16962012-11-21 08:22:52 +0100562 deactivate_urbs(ep, force);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200563 wait_clear_urbs(ep);
564
565 for (i = 0; i < ep->nurbs; i++)
566 release_urb_ctx(&ep->urb[i]);
567
568 if (ep->syncbuf)
569 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
570 ep->syncbuf, ep->sync_dma);
571
572 ep->syncbuf = NULL;
573 ep->nurbs = 0;
574}
575
Daniel Mack94c27212012-04-12 13:51:15 +0200576/*
577 * configure a data endpoint
578 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200579static int data_ep_set_params(struct snd_usb_endpoint *ep,
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700580 snd_pcm_format_t pcm_format,
581 unsigned int channels,
582 unsigned int period_bytes,
Alan Stern976b6c02013-09-24 15:51:58 -0400583 unsigned int frames_per_period,
584 unsigned int periods_per_buffer,
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200585 struct audioformat *fmt,
586 struct snd_usb_endpoint *sync_ep)
587{
Alan Stern976b6c02013-09-24 15:51:58 -0400588 unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
589 unsigned int max_packs_per_period, urbs_per_period, urb_packs;
590 unsigned int max_urbs, i;
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700591 int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200592
Daniel Mackd24f5062013-04-17 00:01:38 +0800593 if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
594 /*
595 * When operating in DSD DOP mode, the size of a sample frame
596 * in hardware differs from the actual physical format width
597 * because we need to make room for the DOP markers.
598 */
599 frame_bits += channels << 3;
600 }
601
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200602 ep->datainterval = fmt->datainterval;
603 ep->stride = frame_bits >> 3;
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700604 ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200605
Clemens Ladisch57e6dae2013-08-08 11:24:55 +0200606 /* assume max. frequency is 25% higher than nominal */
607 ep->freqmax = ep->freqn + (ep->freqn >> 2);
608 maxsize = ((ep->freqmax + 0xffff) * (frame_bits >> 3))
609 >> (16 - ep->datainterval);
610 /* but wMaxPacketSize might reduce this */
611 if (ep->maxpacksize && ep->maxpacksize < maxsize) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200612 /* whatever fits into a max. size packet */
613 maxsize = ep->maxpacksize;
614 ep->freqmax = (maxsize / (frame_bits >> 3))
615 << (16 - ep->datainterval);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200616 }
617
618 if (ep->fill_max)
619 ep->curpacksize = ep->maxpacksize;
620 else
621 ep->curpacksize = maxsize;
622
Alan Stern976b6c02013-09-24 15:51:58 -0400623 if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200624 packs_per_ms = 8 >> ep->datainterval;
Alan Stern976b6c02013-09-24 15:51:58 -0400625 max_packs_per_urb = MAX_PACKS_HS;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200626 } else {
Alan Stern976b6c02013-09-24 15:51:58 -0400627 packs_per_ms = 1;
628 max_packs_per_urb = MAX_PACKS;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200629 }
Eldad Zack98ae4722013-04-03 23:18:52 +0200630 if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
Alan Stern976b6c02013-09-24 15:51:58 -0400631 max_packs_per_urb = min(max_packs_per_urb,
632 1U << sync_ep->syncinterval);
633 max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200634
Alan Stern976b6c02013-09-24 15:51:58 -0400635 /*
636 * Capture endpoints need to use small URBs because there's no way
637 * to tell in advance where the next period will end, and we don't
638 * want the next URB to complete much after the period ends.
639 *
640 * Playback endpoints with implicit sync much use the same parameters
641 * as their corresponding capture endpoint.
642 */
643 if (usb_pipein(ep->pipe) ||
644 snd_usb_endpoint_implicit_feedback_sink(ep)) {
645
Thomas Pugliesea93455e2013-11-26 13:58:15 -0600646 urb_packs = packs_per_ms;
647 /*
648 * Wireless devices can poll at a max rate of once per 4ms.
649 * For dataintervals less than 5, increase the packet count to
650 * allow the host controller to use bursting to fill in the
651 * gaps.
652 */
653 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
654 int interval = ep->datainterval;
655 while (interval < 5) {
656 urb_packs <<= 1;
657 ++interval;
658 }
659 }
Alan Stern976b6c02013-09-24 15:51:58 -0400660 /* make capture URBs <= 1 ms and smaller than a period */
Thomas Pugliesea93455e2013-11-26 13:58:15 -0600661 urb_packs = min(max_packs_per_urb, urb_packs);
Alan Stern976b6c02013-09-24 15:51:58 -0400662 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
663 urb_packs >>= 1;
664 ep->nurbs = MAX_URBS;
665
666 /*
667 * Playback endpoints without implicit sync are adjusted so that
668 * a period fits as evenly as possible in the smallest number of
669 * URBs. The total number of URBs is adjusted to the size of the
670 * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
671 */
672 } else {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200673 /* determine how small a packet can be */
Alan Stern976b6c02013-09-24 15:51:58 -0400674 minsize = (ep->freqn >> (16 - ep->datainterval)) *
675 (frame_bits >> 3);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200676 /* with sync from device, assume it can be 12% lower */
677 if (sync_ep)
678 minsize -= minsize >> 3;
679 minsize = max(minsize, 1u);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200680
Alan Stern976b6c02013-09-24 15:51:58 -0400681 /* how many packets will contain an entire ALSA period? */
682 max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
683
684 /* how many URBs will contain a period? */
685 urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
686 max_packs_per_urb);
687 /* how many packets are needed in each URB? */
688 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
689
690 /* limit the number of frames in a single URB */
691 ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
692 urbs_per_period);
693
694 /* try to use enough URBs to contain an entire ALSA buffer */
695 max_urbs = min((unsigned) MAX_URBS,
696 MAX_QUEUE * packs_per_ms / urb_packs);
697 ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200698 }
699
700 /* allocate and initialize data urbs */
701 for (i = 0; i < ep->nurbs; i++) {
702 struct snd_urb_ctx *u = &ep->urb[i];
703 u->index = i;
704 u->ep = ep;
Alan Stern976b6c02013-09-24 15:51:58 -0400705 u->packets = urb_packs;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200706 u->buffer_size = maxsize * u->packets;
707
708 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
709 u->packets++; /* for transfer delimiter */
710 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
711 if (!u->urb)
712 goto out_of_memory;
713
714 u->urb->transfer_buffer =
715 usb_alloc_coherent(ep->chip->dev, u->buffer_size,
716 GFP_KERNEL, &u->urb->transfer_dma);
717 if (!u->urb->transfer_buffer)
718 goto out_of_memory;
719 u->urb->pipe = ep->pipe;
Clemens Ladischc75c5ab2013-04-27 12:10:32 +0200720 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200721 u->urb->interval = 1 << ep->datainterval;
722 u->urb->context = u;
723 u->urb->complete = snd_complete_urb;
724 INIT_LIST_HEAD(&u->ready_list);
725 }
726
727 return 0;
728
729out_of_memory:
730 release_urbs(ep, 0);
731 return -ENOMEM;
732}
733
Daniel Mack94c27212012-04-12 13:51:15 +0200734/*
735 * configure a sync endpoint
736 */
Eldad Zack93721032013-10-06 22:31:06 +0200737static int sync_ep_set_params(struct snd_usb_endpoint *ep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200738{
739 int i;
740
741 ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
742 GFP_KERNEL, &ep->sync_dma);
743 if (!ep->syncbuf)
744 return -ENOMEM;
745
746 for (i = 0; i < SYNC_URBS; i++) {
747 struct snd_urb_ctx *u = &ep->urb[i];
748 u->index = i;
749 u->ep = ep;
750 u->packets = 1;
751 u->urb = usb_alloc_urb(1, GFP_KERNEL);
752 if (!u->urb)
753 goto out_of_memory;
754 u->urb->transfer_buffer = ep->syncbuf + i * 4;
755 u->urb->transfer_dma = ep->sync_dma + i * 4;
756 u->urb->transfer_buffer_length = 4;
757 u->urb->pipe = ep->pipe;
Clemens Ladischc75c5ab2013-04-27 12:10:32 +0200758 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200759 u->urb->number_of_packets = 1;
760 u->urb->interval = 1 << ep->syncinterval;
761 u->urb->context = u;
762 u->urb->complete = snd_complete_urb;
763 }
764
765 ep->nurbs = SYNC_URBS;
766
767 return 0;
768
769out_of_memory:
770 release_urbs(ep, 0);
771 return -ENOMEM;
772}
773
Daniel Mack94c27212012-04-12 13:51:15 +0200774/**
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200775 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
Daniel Mack94c27212012-04-12 13:51:15 +0200776 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200777 * @ep: the snd_usb_endpoint to configure
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700778 * @pcm_format: the audio fomat.
779 * @channels: the number of audio channels.
780 * @period_bytes: the number of bytes in one alsa period.
Alan Stern976b6c02013-09-24 15:51:58 -0400781 * @period_frames: the number of frames in one alsa period.
782 * @buffer_periods: the number of periods in one alsa buffer.
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700783 * @rate: the frame rate.
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200784 * @fmt: the USB audio format information
785 * @sync_ep: the sync endpoint to use, if any
Daniel Mack94c27212012-04-12 13:51:15 +0200786 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200787 * Determine the number of URBs to be used on this endpoint.
Daniel Mack94c27212012-04-12 13:51:15 +0200788 * An endpoint must be configured before it can be started.
789 * An endpoint that is already running can not be reconfigured.
790 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200791int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700792 snd_pcm_format_t pcm_format,
793 unsigned int channels,
794 unsigned int period_bytes,
Alan Stern976b6c02013-09-24 15:51:58 -0400795 unsigned int period_frames,
796 unsigned int buffer_periods,
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700797 unsigned int rate,
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200798 struct audioformat *fmt,
799 struct snd_usb_endpoint *sync_ep)
800{
801 int err;
802
803 if (ep->use_count != 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100804 usb_audio_warn(ep->chip,
805 "Unable to change format on ep #%x: already in use\n",
806 ep->ep_num);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200807 return -EBUSY;
808 }
809
810 /* release old buffers, if any */
811 release_urbs(ep, 0);
812
813 ep->datainterval = fmt->datainterval;
814 ep->maxpacksize = fmt->maxpacksize;
Takashi Iwai85f71932012-04-13 12:41:54 +0200815 ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200816
817 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700818 ep->freqn = get_usb_full_speed_rate(rate);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200819 else
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700820 ep->freqn = get_usb_high_speed_rate(rate);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200821
822 /* calculate the frequency in 16.16 format */
823 ep->freqm = ep->freqn;
824 ep->freqshift = INT_MIN;
825
826 ep->phase = 0;
827
828 switch (ep->type) {
829 case SND_USB_ENDPOINT_TYPE_DATA:
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700830 err = data_ep_set_params(ep, pcm_format, channels,
Alan Stern976b6c02013-09-24 15:51:58 -0400831 period_bytes, period_frames,
832 buffer_periods, fmt, sync_ep);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200833 break;
834 case SND_USB_ENDPOINT_TYPE_SYNC:
Eldad Zack93721032013-10-06 22:31:06 +0200835 err = sync_ep_set_params(ep);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200836 break;
837 default:
838 err = -EINVAL;
839 }
840
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100841 usb_audio_dbg(ep->chip,
842 "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
843 ep->ep_num, ep->type, ep->nurbs, err);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200844
845 return err;
846}
847
Daniel Mack94c27212012-04-12 13:51:15 +0200848/**
849 * snd_usb_endpoint_start: start an snd_usb_endpoint
850 *
Daniel Mack015618b2012-08-29 13:17:05 +0200851 * @ep: the endpoint to start
852 * @can_sleep: flag indicating whether the operation is executed in
853 * non-atomic context
Daniel Mack94c27212012-04-12 13:51:15 +0200854 *
855 * A call to this function will increment the use count of the endpoint.
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200856 * In case it is not already running, the URBs for this endpoint will be
Daniel Mack94c27212012-04-12 13:51:15 +0200857 * submitted. Otherwise, this function does nothing.
858 *
859 * Must be balanced to calls of snd_usb_endpoint_stop().
860 *
861 * Returns an error if the URB submission failed, 0 in all other cases.
862 */
Takashi Iwaia9bb3622012-11-20 18:32:06 +0100863int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, bool can_sleep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200864{
865 int err;
866 unsigned int i;
867
868 if (ep->chip->shutdown)
869 return -EBADFD;
870
871 /* already running? */
872 if (++ep->use_count != 1)
873 return 0;
874
Daniel Mack015618b2012-08-29 13:17:05 +0200875 /* just to be sure */
Takashi Iwaiccc16962012-11-21 08:22:52 +0100876 deactivate_urbs(ep, false);
Daniel Mack015618b2012-08-29 13:17:05 +0200877 if (can_sleep)
878 wait_clear_urbs(ep);
879
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200880 ep->active_mask = 0;
881 ep->unlink_mask = 0;
882 ep->phase = 0;
883
Daniel Mack2b58fd52012-09-04 10:23:07 +0200884 snd_usb_endpoint_start_quirk(ep);
885
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200886 /*
887 * If this endpoint has a data endpoint as implicit feedback source,
888 * don't start the urbs here. Instead, mark them all as available,
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200889 * wait for the record urbs to return and queue the playback urbs
890 * from that context.
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200891 */
892
893 set_bit(EP_FLAG_RUNNING, &ep->flags);
894
Eldad Zack98ae4722013-04-03 23:18:52 +0200895 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200896 for (i = 0; i < ep->nurbs; i++) {
897 struct snd_urb_ctx *ctx = ep->urb + i;
898 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
899 }
900
901 return 0;
902 }
903
904 for (i = 0; i < ep->nurbs; i++) {
905 struct urb *urb = ep->urb[i].urb;
906
907 if (snd_BUG_ON(!urb))
908 goto __error;
909
910 if (usb_pipeout(ep->pipe)) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200911 prepare_outbound_urb(ep, urb->context);
912 } else {
913 prepare_inbound_urb(ep, urb->context);
914 }
915
916 err = usb_submit_urb(urb, GFP_ATOMIC);
917 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100918 usb_audio_err(ep->chip,
919 "cannot submit urb %d, error %d: %s\n",
920 i, err, usb_error_string(err));
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200921 goto __error;
922 }
923 set_bit(i, &ep->active_mask);
924 }
925
926 return 0;
927
928__error:
929 clear_bit(EP_FLAG_RUNNING, &ep->flags);
930 ep->use_count--;
Takashi Iwaiccc16962012-11-21 08:22:52 +0100931 deactivate_urbs(ep, false);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200932 return -EPIPE;
933}
934
Daniel Mack94c27212012-04-12 13:51:15 +0200935/**
936 * snd_usb_endpoint_stop: stop an snd_usb_endpoint
937 *
938 * @ep: the endpoint to stop (may be NULL)
939 *
940 * A call to this function will decrement the use count of the endpoint.
941 * In case the last user has requested the endpoint stop, the URBs will
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200942 * actually be deactivated.
Daniel Mack94c27212012-04-12 13:51:15 +0200943 *
944 * Must be balanced to calls of snd_usb_endpoint_start().
Takashi Iwaib2eb9502012-11-21 08:30:48 +0100945 *
946 * The caller needs to synchronize the pending stop operation via
947 * snd_usb_endpoint_sync_pending_stop().
Daniel Mack94c27212012-04-12 13:51:15 +0200948 */
Takashi Iwaib2eb9502012-11-21 08:30:48 +0100949void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200950{
951 if (!ep)
952 return;
953
954 if (snd_BUG_ON(ep->use_count == 0))
955 return;
956
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200957 if (--ep->use_count == 0) {
Takashi Iwaiccc16962012-11-21 08:22:52 +0100958 deactivate_urbs(ep, false);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200959 ep->data_subs = NULL;
960 ep->sync_slave = NULL;
961 ep->retire_data_urb = NULL;
962 ep->prepare_data_urb = NULL;
Takashi Iwaib2eb9502012-11-21 08:30:48 +0100963 set_bit(EP_FLAG_STOPPING, &ep->flags);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200964 }
965}
966
Daniel Mack94c27212012-04-12 13:51:15 +0200967/**
Daniel Mack94c27212012-04-12 13:51:15 +0200968 * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
969 *
970 * @ep: the endpoint to deactivate
971 *
Eldad Zack9b7c5522013-10-06 22:31:10 +0200972 * If the endpoint is not currently in use, this functions will
973 * deactivate its associated URBs.
Daniel Mack94c27212012-04-12 13:51:15 +0200974 *
975 * In case of any active users, this functions does nothing.
Daniel Mack94c27212012-04-12 13:51:15 +0200976 */
Eldad Zack9b7c5522013-10-06 22:31:10 +0200977void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200978{
979 if (!ep)
Eldad Zack9b7c5522013-10-06 22:31:10 +0200980 return;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200981
982 if (ep->use_count != 0)
Eldad Zack9b7c5522013-10-06 22:31:10 +0200983 return;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200984
Eldad Zack239b9f72013-10-06 22:31:09 +0200985 deactivate_urbs(ep, true);
986 wait_clear_urbs(ep);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200987}
988
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200989/**
Takashi Iwai92a586b2014-06-25 14:24:47 +0200990 * snd_usb_endpoint_release: Tear down an snd_usb_endpoint
991 *
992 * @ep: the endpoint to release
993 *
994 * This function does not care for the endpoint's use count but will tear
995 * down all the streaming URBs immediately.
996 */
997void snd_usb_endpoint_release(struct snd_usb_endpoint *ep)
998{
999 release_urbs(ep, 1);
1000}
1001
1002/**
Daniel Mack07a5e9d2012-04-24 19:31:24 +02001003 * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
Daniel Mack94c27212012-04-12 13:51:15 +02001004 *
1005 * @ep: the list header of the endpoint to free
1006 *
Takashi Iwai92a586b2014-06-25 14:24:47 +02001007 * This free all resources of the given ep.
Daniel Mack94c27212012-04-12 13:51:15 +02001008 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001009void snd_usb_endpoint_free(struct list_head *head)
1010{
1011 struct snd_usb_endpoint *ep;
1012
1013 ep = list_entry(head, struct snd_usb_endpoint, list);
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001014 kfree(ep);
1015}
1016
Daniel Mack94c27212012-04-12 13:51:15 +02001017/**
1018 * snd_usb_handle_sync_urb: parse an USB sync packet
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001019 *
Daniel Mack94c27212012-04-12 13:51:15 +02001020 * @ep: the endpoint to handle the packet
1021 * @sender: the sending endpoint
1022 * @urb: the received packet
1023 *
1024 * This function is called from the context of an endpoint that received
1025 * the packet and is used to let another endpoint object handle the payload.
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001026 */
1027void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
1028 struct snd_usb_endpoint *sender,
1029 const struct urb *urb)
1030{
1031 int shift;
1032 unsigned int f;
1033 unsigned long flags;
1034
1035 snd_BUG_ON(ep == sender);
1036
Daniel Mack94c27212012-04-12 13:51:15 +02001037 /*
1038 * In case the endpoint is operating in implicit feedback mode, prepare
Daniel Mack07a5e9d2012-04-24 19:31:24 +02001039 * a new outbound URB that has the same layout as the received packet
1040 * and add it to the list of pending urbs. queue_pending_output_urbs()
1041 * will take care of them later.
Daniel Mack94c27212012-04-12 13:51:15 +02001042 */
Eldad Zack98ae4722013-04-03 23:18:52 +02001043 if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001044 ep->use_count != 0) {
1045
1046 /* implicit feedback case */
1047 int i, bytes = 0;
1048 struct snd_urb_ctx *in_ctx;
1049 struct snd_usb_packet_info *out_packet;
1050
1051 in_ctx = urb->context;
1052
1053 /* Count overall packet size */
1054 for (i = 0; i < in_ctx->packets; i++)
1055 if (urb->iso_frame_desc[i].status == 0)
1056 bytes += urb->iso_frame_desc[i].actual_length;
1057
1058 /*
1059 * skip empty packets. At least M-Audio's Fast Track Ultra stops
1060 * streaming once it received a 0-byte OUT URB
1061 */
1062 if (bytes == 0)
1063 return;
1064
1065 spin_lock_irqsave(&ep->lock, flags);
1066 out_packet = ep->next_packet + ep->next_packet_write_pos;
1067
1068 /*
1069 * Iterate through the inbound packet and prepare the lengths
1070 * for the output packet. The OUT packet we are about to send
Eldad Zack28acb122012-11-28 23:55:34 +01001071 * will have the same amount of payload bytes per stride as the
1072 * IN packet we just received. Since the actual size is scaled
1073 * by the stride, use the sender stride to calculate the length
1074 * in case the number of channels differ between the implicitly
1075 * fed-back endpoint and the synchronizing endpoint.
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001076 */
1077
1078 out_packet->packets = in_ctx->packets;
1079 for (i = 0; i < in_ctx->packets; i++) {
1080 if (urb->iso_frame_desc[i].status == 0)
1081 out_packet->packet_size[i] =
Eldad Zack28acb122012-11-28 23:55:34 +01001082 urb->iso_frame_desc[i].actual_length / sender->stride;
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001083 else
1084 out_packet->packet_size[i] = 0;
1085 }
1086
1087 ep->next_packet_write_pos++;
1088 ep->next_packet_write_pos %= MAX_URBS;
1089 spin_unlock_irqrestore(&ep->lock, flags);
1090 queue_pending_output_urbs(ep);
1091
1092 return;
1093 }
1094
Daniel Mack94c27212012-04-12 13:51:15 +02001095 /*
1096 * process after playback sync complete
1097 *
1098 * Full speed devices report feedback values in 10.14 format as samples
1099 * per frame, high speed devices in 16.16 format as samples per
1100 * microframe.
1101 *
1102 * Because the Audio Class 1 spec was written before USB 2.0, many high
1103 * speed devices use a wrong interpretation, some others use an
1104 * entirely different format.
1105 *
1106 * Therefore, we cannot predict what format any particular device uses
1107 * and must detect it automatically.
1108 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001109
1110 if (urb->iso_frame_desc[0].status != 0 ||
1111 urb->iso_frame_desc[0].actual_length < 3)
1112 return;
1113
1114 f = le32_to_cpup(urb->transfer_buffer);
1115 if (urb->iso_frame_desc[0].actual_length == 3)
1116 f &= 0x00ffffff;
1117 else
1118 f &= 0x0fffffff;
1119
1120 if (f == 0)
1121 return;
1122
Clemens Ladisch7040b6d2014-05-01 12:20:22 +02001123 if (unlikely(sender->udh01_fb_quirk)) {
1124 /*
1125 * The TEAC UD-H01 firmware sometimes changes the feedback value
1126 * by +/- 0x1.0000.
1127 */
1128 if (f < ep->freqn - 0x8000)
1129 f += 0x10000;
1130 else if (f > ep->freqn + 0x8000)
1131 f -= 0x10000;
1132 } else if (unlikely(ep->freqshift == INT_MIN)) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001133 /*
1134 * The first time we see a feedback value, determine its format
1135 * by shifting it left or right until it matches the nominal
1136 * frequency value. This assumes that the feedback does not
1137 * differ from the nominal value more than +50% or -25%.
1138 */
1139 shift = 0;
1140 while (f < ep->freqn - ep->freqn / 4) {
1141 f <<= 1;
1142 shift++;
1143 }
1144 while (f > ep->freqn + ep->freqn / 2) {
1145 f >>= 1;
1146 shift--;
1147 }
1148 ep->freqshift = shift;
1149 } else if (ep->freqshift >= 0)
1150 f <<= ep->freqshift;
1151 else
1152 f >>= -ep->freqshift;
1153
1154 if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1155 /*
1156 * If the frequency looks valid, set it.
1157 * This value is referred to in prepare_playback_urb().
1158 */
1159 spin_lock_irqsave(&ep->lock, flags);
1160 ep->freqm = f;
1161 spin_unlock_irqrestore(&ep->lock, flags);
1162 } else {
1163 /*
1164 * Out of range; maybe the shift value is wrong.
1165 * Reset it so that we autodetect again the next time.
1166 */
1167 ep->freqshift = INT_MIN;
1168 }
1169}
1170