blob: 152bfd48a31123652c641ca636f6aad777e6dd26 [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_ACTIVATED 0
37#define EP_FLAG_RUNNING 1
38
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 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200130int snd_usb_endpoint_implict_feedback_sink(struct snd_usb_endpoint *ep)
131{
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) {
206 int counts = ctx->packet_size[i];
207 urb->iso_frame_desc[i].offset = offs * ep->stride;
208 urb->iso_frame_desc[i].length = counts * ep->stride;
209 offs += counts;
210 }
211
212 urb->number_of_packets = ctx->packets;
213 urb->transfer_buffer_length = offs * ep->stride;
214 memset(urb->transfer_buffer, ep->silence_value,
215 offs * ep->stride);
216 }
217 break;
218
219 case SND_USB_ENDPOINT_TYPE_SYNC:
220 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
221 /*
222 * fill the length and offset of each urb descriptor.
223 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
224 */
225 urb->iso_frame_desc[0].length = 4;
226 urb->iso_frame_desc[0].offset = 0;
227 cp[0] = ep->freqn;
228 cp[1] = ep->freqn >> 8;
229 cp[2] = ep->freqn >> 16;
230 cp[3] = ep->freqn >> 24;
231 } else {
232 /*
233 * fill the length and offset of each urb descriptor.
234 * the fixed 10.14 frequency is passed through the pipe.
235 */
236 urb->iso_frame_desc[0].length = 3;
237 urb->iso_frame_desc[0].offset = 0;
238 cp[0] = ep->freqn >> 2;
239 cp[1] = ep->freqn >> 10;
240 cp[2] = ep->freqn >> 18;
241 }
242
243 break;
244 }
245}
246
247/*
248 * Prepare a CAPTURE or SYNC urb for submission to the bus.
249 */
250static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
251 struct snd_urb_ctx *urb_ctx)
252{
253 int i, offs;
254 struct urb *urb = urb_ctx->urb;
255
256 urb->dev = ep->chip->dev; /* we need to set this at each time */
257
258 switch (ep->type) {
259 case SND_USB_ENDPOINT_TYPE_DATA:
260 offs = 0;
261 for (i = 0; i < urb_ctx->packets; i++) {
262 urb->iso_frame_desc[i].offset = offs;
263 urb->iso_frame_desc[i].length = ep->curpacksize;
264 offs += ep->curpacksize;
265 }
266
267 urb->transfer_buffer_length = offs;
268 urb->number_of_packets = urb_ctx->packets;
269 break;
270
271 case SND_USB_ENDPOINT_TYPE_SYNC:
272 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
273 urb->iso_frame_desc[0].offset = 0;
274 break;
275 }
276}
277
Daniel Mack94c27212012-04-12 13:51:15 +0200278/*
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200279 * Send output urbs that have been prepared previously. URBs are dequeued
Daniel Mack94c27212012-04-12 13:51:15 +0200280 * from ep->ready_playback_urbs and in case there there aren't any available
281 * or there are no packets that have been prepared, this function does
282 * nothing.
283 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200284 * The reason why the functionality of sending and preparing URBs is separated
285 * is that host controllers don't guarantee the order in which they return
286 * inbound and outbound packets to their submitters.
Daniel Mack94c27212012-04-12 13:51:15 +0200287 *
288 * This function is only used for implicit feedback endpoints. For endpoints
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200289 * driven by dedicated sync endpoints, URBs are immediately re-submitted
290 * from their completion handler.
Daniel Mack94c27212012-04-12 13:51:15 +0200291 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200292static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
293{
294 while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
295
296 unsigned long flags;
Andrew Morton68853fa2012-04-24 08:10:10 +0200297 struct snd_usb_packet_info *uninitialized_var(packet);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200298 struct snd_urb_ctx *ctx = NULL;
299 struct urb *urb;
300 int err, i;
301
302 spin_lock_irqsave(&ep->lock, flags);
303 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
304 packet = ep->next_packet + ep->next_packet_read_pos;
305 ep->next_packet_read_pos++;
306 ep->next_packet_read_pos %= MAX_URBS;
307
308 /* take URB out of FIFO */
309 if (!list_empty(&ep->ready_playback_urbs))
310 ctx = list_first_entry(&ep->ready_playback_urbs,
311 struct snd_urb_ctx, ready_list);
312 }
313 spin_unlock_irqrestore(&ep->lock, flags);
314
315 if (ctx == NULL)
316 return;
317
318 list_del_init(&ctx->ready_list);
319 urb = ctx->urb;
320
321 /* copy over the length information */
322 for (i = 0; i < packet->packets; i++)
323 ctx->packet_size[i] = packet->packet_size[i];
324
Daniel Mack94c27212012-04-12 13:51:15 +0200325 /* call the data handler to fill in playback data */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200326 prepare_outbound_urb(ep, ctx);
327
328 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
329 if (err < 0)
330 snd_printk(KERN_ERR "Unable to submit urb #%d: %d (urb %p)\n",
331 ctx->index, err, ctx->urb);
332 else
333 set_bit(ctx->index, &ep->active_mask);
334 }
335}
336
337/*
338 * complete callback for urbs
339 */
340static void snd_complete_urb(struct urb *urb)
341{
342 struct snd_urb_ctx *ctx = urb->context;
343 struct snd_usb_endpoint *ep = ctx->ep;
344 int err;
345
346 if (unlikely(urb->status == -ENOENT || /* unlinked */
347 urb->status == -ENODEV || /* device removed */
348 urb->status == -ECONNRESET || /* unlinked */
349 urb->status == -ESHUTDOWN || /* device disabled */
350 ep->chip->shutdown)) /* device disconnected */
351 goto exit_clear;
352
353 if (usb_pipeout(ep->pipe)) {
354 retire_outbound_urb(ep, ctx);
355 /* can be stopped during retire callback */
356 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
357 goto exit_clear;
358
359 if (snd_usb_endpoint_implict_feedback_sink(ep)) {
360 unsigned long flags;
361
362 spin_lock_irqsave(&ep->lock, flags);
363 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
364 spin_unlock_irqrestore(&ep->lock, flags);
365 queue_pending_output_urbs(ep);
366
367 goto exit_clear;
368 }
369
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200370 prepare_outbound_urb(ep, ctx);
371 } else {
372 retire_inbound_urb(ep, ctx);
373 /* can be stopped during retire callback */
374 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
375 goto exit_clear;
376
377 prepare_inbound_urb(ep, ctx);
378 }
379
380 err = usb_submit_urb(urb, GFP_ATOMIC);
381 if (err == 0)
382 return;
383
384 snd_printk(KERN_ERR "cannot submit urb (err = %d)\n", err);
385 //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
386
387exit_clear:
388 clear_bit(ctx->index, &ep->active_mask);
389}
390
Daniel Mack94c27212012-04-12 13:51:15 +0200391/**
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200392 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
Daniel Mack94c27212012-04-12 13:51:15 +0200393 *
394 * @chip: The chip
395 * @alts: The USB host interface
396 * @ep_num: The number of the endpoint to use
397 * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
398 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
399 *
400 * If the requested endpoint has not been added to the given chip before,
401 * a new instance is created. Otherwise, a pointer to the previoulsy
402 * created instance is returned. In case of any error, NULL is returned.
403 *
404 * New endpoints will be added to chip->ep_list and must be freed by
405 * calling snd_usb_endpoint_free().
406 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200407struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
408 struct usb_host_interface *alts,
409 int ep_num, int direction, int type)
410{
411 struct list_head *p;
412 struct snd_usb_endpoint *ep;
Daniel Mack68e67f42012-07-12 13:08:40 +0200413 int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200414
415 mutex_lock(&chip->mutex);
416
417 list_for_each(p, &chip->ep_list) {
418 ep = list_entry(p, struct snd_usb_endpoint, list);
419 if (ep->ep_num == ep_num &&
420 ep->iface == alts->desc.bInterfaceNumber &&
421 ep->alt_idx == alts->desc.bAlternateSetting) {
422 snd_printdd(KERN_DEBUG "Re-using EP %x in iface %d,%d @%p\n",
423 ep_num, ep->iface, ep->alt_idx, ep);
424 goto __exit_unlock;
425 }
426 }
427
428 snd_printdd(KERN_DEBUG "Creating new %s %s endpoint #%x\n",
429 is_playback ? "playback" : "capture",
430 type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
431 ep_num);
432
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200433 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
434 if (!ep)
435 goto __exit_unlock;
436
437 ep->chip = chip;
438 spin_lock_init(&ep->lock);
439 ep->type = type;
440 ep->ep_num = ep_num;
441 ep->iface = alts->desc.bInterfaceNumber;
442 ep->alt_idx = alts->desc.bAlternateSetting;
443 INIT_LIST_HEAD(&ep->ready_playback_urbs);
444 ep_num &= USB_ENDPOINT_NUMBER_MASK;
445
446 if (is_playback)
447 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
448 else
449 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
450
451 if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
452 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
453 get_endpoint(alts, 1)->bRefresh >= 1 &&
454 get_endpoint(alts, 1)->bRefresh <= 9)
455 ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
456 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
457 ep->syncinterval = 1;
458 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
459 get_endpoint(alts, 1)->bInterval <= 16)
460 ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
461 else
462 ep->syncinterval = 3;
463
464 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
465 }
466
467 list_add_tail(&ep->list, &chip->ep_list);
468
469__exit_unlock:
470 mutex_unlock(&chip->mutex);
471
472 return ep;
473}
474
475/*
476 * wait until all urbs are processed.
477 */
478static int wait_clear_urbs(struct snd_usb_endpoint *ep)
479{
480 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
481 unsigned int i;
482 int alive;
483
484 do {
485 alive = 0;
486 for (i = 0; i < ep->nurbs; i++)
487 if (test_bit(i, &ep->active_mask))
488 alive++;
489
490 if (!alive)
491 break;
492
493 schedule_timeout_uninterruptible(1);
494 } while (time_before(jiffies, end_time));
495
496 if (alive)
497 snd_printk(KERN_ERR "timeout: still %d active urbs on EP #%x\n",
498 alive, ep->ep_num);
499
500 return 0;
501}
502
503/*
504 * unlink active urbs.
505 */
506static int deactivate_urbs(struct snd_usb_endpoint *ep, int force, int can_sleep)
507{
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200508 unsigned int i;
509 int async;
510
511 if (!force && ep->chip->shutdown) /* to be sure... */
512 return -EBADFD;
513
514 async = !can_sleep && ep->chip->async_unlink;
515
516 clear_bit(EP_FLAG_RUNNING, &ep->flags);
517
518 INIT_LIST_HEAD(&ep->ready_playback_urbs);
519 ep->next_packet_read_pos = 0;
520 ep->next_packet_write_pos = 0;
521
522 if (!async && in_interrupt())
523 return 0;
524
525 for (i = 0; i < ep->nurbs; i++) {
526 if (test_bit(i, &ep->active_mask)) {
527 if (!test_and_set_bit(i, &ep->unlink_mask)) {
528 struct urb *u = ep->urb[i].urb;
529 if (async)
530 usb_unlink_urb(u);
531 else
532 usb_kill_urb(u);
533 }
534 }
535 }
536
537 return 0;
538}
539
540/*
541 * release an endpoint's urbs
542 */
543static void release_urbs(struct snd_usb_endpoint *ep, int force)
544{
545 int i;
546
547 /* route incoming urbs to nirvana */
548 ep->retire_data_urb = NULL;
549 ep->prepare_data_urb = NULL;
550
551 /* stop urbs */
552 deactivate_urbs(ep, force, 1);
553 wait_clear_urbs(ep);
554
555 for (i = 0; i < ep->nurbs; i++)
556 release_urb_ctx(&ep->urb[i]);
557
558 if (ep->syncbuf)
559 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
560 ep->syncbuf, ep->sync_dma);
561
562 ep->syncbuf = NULL;
563 ep->nurbs = 0;
564}
565
Daniel Mack94c27212012-04-12 13:51:15 +0200566/*
567 * configure a data endpoint
568 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200569static int data_ep_set_params(struct snd_usb_endpoint *ep,
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700570 snd_pcm_format_t pcm_format,
571 unsigned int channels,
572 unsigned int period_bytes,
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200573 struct audioformat *fmt,
574 struct snd_usb_endpoint *sync_ep)
575{
576 unsigned int maxsize, i, urb_packs, total_packs, packs_per_ms;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200577 int is_playback = usb_pipeout(ep->pipe);
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700578 int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200579
580 ep->datainterval = fmt->datainterval;
581 ep->stride = frame_bits >> 3;
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700582 ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200583
584 /* calculate max. frequency */
585 if (ep->maxpacksize) {
586 /* whatever fits into a max. size packet */
587 maxsize = ep->maxpacksize;
588 ep->freqmax = (maxsize / (frame_bits >> 3))
589 << (16 - ep->datainterval);
590 } else {
591 /* no max. packet size: just take 25% higher than nominal */
592 ep->freqmax = ep->freqn + (ep->freqn >> 2);
593 maxsize = ((ep->freqmax + 0xffff) * (frame_bits >> 3))
594 >> (16 - ep->datainterval);
595 }
596
597 if (ep->fill_max)
598 ep->curpacksize = ep->maxpacksize;
599 else
600 ep->curpacksize = maxsize;
601
602 if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL)
603 packs_per_ms = 8 >> ep->datainterval;
604 else
605 packs_per_ms = 1;
606
607 if (is_playback && !snd_usb_endpoint_implict_feedback_sink(ep)) {
608 urb_packs = max(ep->chip->nrpacks, 1);
609 urb_packs = min(urb_packs, (unsigned int) MAX_PACKS);
610 } else {
611 urb_packs = 1;
612 }
613
614 urb_packs *= packs_per_ms;
615
616 if (sync_ep && !snd_usb_endpoint_implict_feedback_sink(ep))
617 urb_packs = min(urb_packs, 1U << sync_ep->syncinterval);
618
619 /* decide how many packets to be used */
620 if (is_playback && !snd_usb_endpoint_implict_feedback_sink(ep)) {
621 unsigned int minsize, maxpacks;
622 /* determine how small a packet can be */
623 minsize = (ep->freqn >> (16 - ep->datainterval))
624 * (frame_bits >> 3);
625 /* with sync from device, assume it can be 12% lower */
626 if (sync_ep)
627 minsize -= minsize >> 3;
628 minsize = max(minsize, 1u);
629 total_packs = (period_bytes + minsize - 1) / minsize;
630 /* we need at least two URBs for queueing */
631 if (total_packs < 2) {
632 total_packs = 2;
633 } else {
634 /* and we don't want too long a queue either */
635 maxpacks = max(MAX_QUEUE * packs_per_ms, urb_packs * 2);
636 total_packs = min(total_packs, maxpacks);
637 }
638 } else {
639 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
640 urb_packs >>= 1;
641 total_packs = MAX_URBS * urb_packs;
642 }
643
644 ep->nurbs = (total_packs + urb_packs - 1) / urb_packs;
645 if (ep->nurbs > MAX_URBS) {
646 /* too much... */
647 ep->nurbs = MAX_URBS;
648 total_packs = MAX_URBS * urb_packs;
649 } else if (ep->nurbs < 2) {
650 /* too little - we need at least two packets
651 * to ensure contiguous playback/capture
652 */
653 ep->nurbs = 2;
654 }
655
656 /* allocate and initialize data urbs */
657 for (i = 0; i < ep->nurbs; i++) {
658 struct snd_urb_ctx *u = &ep->urb[i];
659 u->index = i;
660 u->ep = ep;
661 u->packets = (i + 1) * total_packs / ep->nurbs
662 - i * total_packs / ep->nurbs;
663 u->buffer_size = maxsize * u->packets;
664
665 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
666 u->packets++; /* for transfer delimiter */
667 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
668 if (!u->urb)
669 goto out_of_memory;
670
671 u->urb->transfer_buffer =
672 usb_alloc_coherent(ep->chip->dev, u->buffer_size,
673 GFP_KERNEL, &u->urb->transfer_dma);
674 if (!u->urb->transfer_buffer)
675 goto out_of_memory;
676 u->urb->pipe = ep->pipe;
677 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
678 u->urb->interval = 1 << ep->datainterval;
679 u->urb->context = u;
680 u->urb->complete = snd_complete_urb;
681 INIT_LIST_HEAD(&u->ready_list);
682 }
683
684 return 0;
685
686out_of_memory:
687 release_urbs(ep, 0);
688 return -ENOMEM;
689}
690
Daniel Mack94c27212012-04-12 13:51:15 +0200691/*
692 * configure a sync endpoint
693 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200694static int sync_ep_set_params(struct snd_usb_endpoint *ep,
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200695 struct audioformat *fmt)
696{
697 int i;
698
699 ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
700 GFP_KERNEL, &ep->sync_dma);
701 if (!ep->syncbuf)
702 return -ENOMEM;
703
704 for (i = 0; i < SYNC_URBS; i++) {
705 struct snd_urb_ctx *u = &ep->urb[i];
706 u->index = i;
707 u->ep = ep;
708 u->packets = 1;
709 u->urb = usb_alloc_urb(1, GFP_KERNEL);
710 if (!u->urb)
711 goto out_of_memory;
712 u->urb->transfer_buffer = ep->syncbuf + i * 4;
713 u->urb->transfer_dma = ep->sync_dma + i * 4;
714 u->urb->transfer_buffer_length = 4;
715 u->urb->pipe = ep->pipe;
716 u->urb->transfer_flags = URB_ISO_ASAP |
717 URB_NO_TRANSFER_DMA_MAP;
718 u->urb->number_of_packets = 1;
719 u->urb->interval = 1 << ep->syncinterval;
720 u->urb->context = u;
721 u->urb->complete = snd_complete_urb;
722 }
723
724 ep->nurbs = SYNC_URBS;
725
726 return 0;
727
728out_of_memory:
729 release_urbs(ep, 0);
730 return -ENOMEM;
731}
732
Daniel Mack94c27212012-04-12 13:51:15 +0200733/**
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200734 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
Daniel Mack94c27212012-04-12 13:51:15 +0200735 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200736 * @ep: the snd_usb_endpoint to configure
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700737 * @pcm_format: the audio fomat.
738 * @channels: the number of audio channels.
739 * @period_bytes: the number of bytes in one alsa period.
740 * @rate: the frame rate.
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200741 * @fmt: the USB audio format information
742 * @sync_ep: the sync endpoint to use, if any
Daniel Mack94c27212012-04-12 13:51:15 +0200743 *
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200744 * Determine the number of URBs to be used on this endpoint.
Daniel Mack94c27212012-04-12 13:51:15 +0200745 * An endpoint must be configured before it can be started.
746 * An endpoint that is already running can not be reconfigured.
747 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200748int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700749 snd_pcm_format_t pcm_format,
750 unsigned int channels,
751 unsigned int period_bytes,
752 unsigned int rate,
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200753 struct audioformat *fmt,
754 struct snd_usb_endpoint *sync_ep)
755{
756 int err;
757
758 if (ep->use_count != 0) {
759 snd_printk(KERN_WARNING "Unable to change format on ep #%x: already in use\n",
760 ep->ep_num);
761 return -EBUSY;
762 }
763
764 /* release old buffers, if any */
765 release_urbs(ep, 0);
766
767 ep->datainterval = fmt->datainterval;
768 ep->maxpacksize = fmt->maxpacksize;
Takashi Iwai85f71932012-04-13 12:41:54 +0200769 ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200770
771 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700772 ep->freqn = get_usb_full_speed_rate(rate);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200773 else
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700774 ep->freqn = get_usb_high_speed_rate(rate);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200775
776 /* calculate the frequency in 16.16 format */
777 ep->freqm = ep->freqn;
778 ep->freqshift = INT_MIN;
779
780 ep->phase = 0;
781
782 switch (ep->type) {
783 case SND_USB_ENDPOINT_TYPE_DATA:
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700784 err = data_ep_set_params(ep, pcm_format, channels,
785 period_bytes, fmt, sync_ep);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200786 break;
787 case SND_USB_ENDPOINT_TYPE_SYNC:
Dylan Reid35ec7aa22012-09-18 09:49:47 -0700788 err = sync_ep_set_params(ep, fmt);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200789 break;
790 default:
791 err = -EINVAL;
792 }
793
794 snd_printdd(KERN_DEBUG "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
795 ep->ep_num, ep->type, ep->nurbs, err);
796
797 return err;
798}
799
Daniel Mack94c27212012-04-12 13:51:15 +0200800/**
801 * snd_usb_endpoint_start: start an snd_usb_endpoint
802 *
Daniel Mack015618b2012-08-29 13:17:05 +0200803 * @ep: the endpoint to start
804 * @can_sleep: flag indicating whether the operation is executed in
805 * non-atomic context
Daniel Mack94c27212012-04-12 13:51:15 +0200806 *
807 * A call to this function will increment the use count of the endpoint.
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200808 * In case it is not already running, the URBs for this endpoint will be
Daniel Mack94c27212012-04-12 13:51:15 +0200809 * submitted. Otherwise, this function does nothing.
810 *
811 * Must be balanced to calls of snd_usb_endpoint_stop().
812 *
813 * Returns an error if the URB submission failed, 0 in all other cases.
814 */
Daniel Mack015618b2012-08-29 13:17:05 +0200815int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, int can_sleep)
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200816{
817 int err;
818 unsigned int i;
819
820 if (ep->chip->shutdown)
821 return -EBADFD;
822
823 /* already running? */
824 if (++ep->use_count != 1)
825 return 0;
826
Daniel Mack015618b2012-08-29 13:17:05 +0200827 /* just to be sure */
828 deactivate_urbs(ep, 0, can_sleep);
829 if (can_sleep)
830 wait_clear_urbs(ep);
831
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200832 ep->active_mask = 0;
833 ep->unlink_mask = 0;
834 ep->phase = 0;
835
Daniel Mack2b58fd52012-09-04 10:23:07 +0200836 snd_usb_endpoint_start_quirk(ep);
837
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200838 /*
839 * If this endpoint has a data endpoint as implicit feedback source,
840 * don't start the urbs here. Instead, mark them all as available,
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200841 * wait for the record urbs to return and queue the playback urbs
842 * from that context.
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200843 */
844
845 set_bit(EP_FLAG_RUNNING, &ep->flags);
846
847 if (snd_usb_endpoint_implict_feedback_sink(ep)) {
848 for (i = 0; i < ep->nurbs; i++) {
849 struct snd_urb_ctx *ctx = ep->urb + i;
850 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
851 }
852
853 return 0;
854 }
855
856 for (i = 0; i < ep->nurbs; i++) {
857 struct urb *urb = ep->urb[i].urb;
858
859 if (snd_BUG_ON(!urb))
860 goto __error;
861
862 if (usb_pipeout(ep->pipe)) {
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200863 prepare_outbound_urb(ep, urb->context);
864 } else {
865 prepare_inbound_urb(ep, urb->context);
866 }
867
868 err = usb_submit_urb(urb, GFP_ATOMIC);
869 if (err < 0) {
870 snd_printk(KERN_ERR "cannot submit urb %d, error %d: %s\n",
871 i, err, usb_error_string(err));
872 goto __error;
873 }
874 set_bit(i, &ep->active_mask);
875 }
876
877 return 0;
878
879__error:
880 clear_bit(EP_FLAG_RUNNING, &ep->flags);
881 ep->use_count--;
882 deactivate_urbs(ep, 0, 0);
883 return -EPIPE;
884}
885
Daniel Mack94c27212012-04-12 13:51:15 +0200886/**
887 * snd_usb_endpoint_stop: stop an snd_usb_endpoint
888 *
889 * @ep: the endpoint to stop (may be NULL)
890 *
891 * A call to this function will decrement the use count of the endpoint.
892 * In case the last user has requested the endpoint stop, the URBs will
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200893 * actually be deactivated.
Daniel Mack94c27212012-04-12 13:51:15 +0200894 *
895 * Must be balanced to calls of snd_usb_endpoint_start().
896 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200897void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep,
898 int force, int can_sleep, int wait)
899{
900 if (!ep)
901 return;
902
903 if (snd_BUG_ON(ep->use_count == 0))
904 return;
905
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200906 if (--ep->use_count == 0) {
907 deactivate_urbs(ep, force, can_sleep);
908 ep->data_subs = NULL;
909 ep->sync_slave = NULL;
910 ep->retire_data_urb = NULL;
911 ep->prepare_data_urb = NULL;
912
913 if (wait)
914 wait_clear_urbs(ep);
915 }
916}
917
Daniel Mack94c27212012-04-12 13:51:15 +0200918/**
Daniel Mack94c27212012-04-12 13:51:15 +0200919 * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
920 *
921 * @ep: the endpoint to deactivate
922 *
923 * If the endpoint is not currently in use, this functions will select the
924 * alternate interface setting 0 for the interface of this endpoint.
925 *
926 * In case of any active users, this functions does nothing.
927 *
928 * Returns an error if usb_set_interface() failed, 0 in all other
929 * cases.
930 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200931int snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
932{
933 if (!ep)
934 return -EINVAL;
935
Daniel Mack68e67f42012-07-12 13:08:40 +0200936 deactivate_urbs(ep, 1, 1);
937 wait_clear_urbs(ep);
938
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200939 if (ep->use_count != 0)
940 return 0;
941
Daniel Mack68e67f42012-07-12 13:08:40 +0200942 clear_bit(EP_FLAG_ACTIVATED, &ep->flags);
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200943
Daniel Mack68e67f42012-07-12 13:08:40 +0200944 return 0;
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200945}
946
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200947/**
948 * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
Daniel Mack94c27212012-04-12 13:51:15 +0200949 *
950 * @ep: the list header of the endpoint to free
951 *
952 * This function does not care for the endpoint's use count but will tear
953 * down all the streaming URBs immediately and free all resources.
954 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200955void snd_usb_endpoint_free(struct list_head *head)
956{
957 struct snd_usb_endpoint *ep;
958
959 ep = list_entry(head, struct snd_usb_endpoint, list);
960 release_urbs(ep, 1);
961 kfree(ep);
962}
963
Daniel Mack94c27212012-04-12 13:51:15 +0200964/**
965 * snd_usb_handle_sync_urb: parse an USB sync packet
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200966 *
Daniel Mack94c27212012-04-12 13:51:15 +0200967 * @ep: the endpoint to handle the packet
968 * @sender: the sending endpoint
969 * @urb: the received packet
970 *
971 * This function is called from the context of an endpoint that received
972 * the packet and is used to let another endpoint object handle the payload.
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200973 */
974void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
975 struct snd_usb_endpoint *sender,
976 const struct urb *urb)
977{
978 int shift;
979 unsigned int f;
980 unsigned long flags;
981
982 snd_BUG_ON(ep == sender);
983
Daniel Mack94c27212012-04-12 13:51:15 +0200984 /*
985 * In case the endpoint is operating in implicit feedback mode, prepare
Daniel Mack07a5e9d2012-04-24 19:31:24 +0200986 * a new outbound URB that has the same layout as the received packet
987 * and add it to the list of pending urbs. queue_pending_output_urbs()
988 * will take care of them later.
Daniel Mack94c27212012-04-12 13:51:15 +0200989 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +0200990 if (snd_usb_endpoint_implict_feedback_sink(ep) &&
991 ep->use_count != 0) {
992
993 /* implicit feedback case */
994 int i, bytes = 0;
995 struct snd_urb_ctx *in_ctx;
996 struct snd_usb_packet_info *out_packet;
997
998 in_ctx = urb->context;
999
1000 /* Count overall packet size */
1001 for (i = 0; i < in_ctx->packets; i++)
1002 if (urb->iso_frame_desc[i].status == 0)
1003 bytes += urb->iso_frame_desc[i].actual_length;
1004
1005 /*
1006 * skip empty packets. At least M-Audio's Fast Track Ultra stops
1007 * streaming once it received a 0-byte OUT URB
1008 */
1009 if (bytes == 0)
1010 return;
1011
1012 spin_lock_irqsave(&ep->lock, flags);
1013 out_packet = ep->next_packet + ep->next_packet_write_pos;
1014
1015 /*
1016 * Iterate through the inbound packet and prepare the lengths
1017 * for the output packet. The OUT packet we are about to send
Daniel Mack07a5e9d2012-04-24 19:31:24 +02001018 * will have the same amount of payload bytes than the IN
1019 * packet we just received.
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001020 */
1021
1022 out_packet->packets = in_ctx->packets;
1023 for (i = 0; i < in_ctx->packets; i++) {
1024 if (urb->iso_frame_desc[i].status == 0)
1025 out_packet->packet_size[i] =
1026 urb->iso_frame_desc[i].actual_length / ep->stride;
1027 else
1028 out_packet->packet_size[i] = 0;
1029 }
1030
1031 ep->next_packet_write_pos++;
1032 ep->next_packet_write_pos %= MAX_URBS;
1033 spin_unlock_irqrestore(&ep->lock, flags);
1034 queue_pending_output_urbs(ep);
1035
1036 return;
1037 }
1038
Daniel Mack94c27212012-04-12 13:51:15 +02001039 /*
1040 * process after playback sync complete
1041 *
1042 * Full speed devices report feedback values in 10.14 format as samples
1043 * per frame, high speed devices in 16.16 format as samples per
1044 * microframe.
1045 *
1046 * Because the Audio Class 1 spec was written before USB 2.0, many high
1047 * speed devices use a wrong interpretation, some others use an
1048 * entirely different format.
1049 *
1050 * Therefore, we cannot predict what format any particular device uses
1051 * and must detect it automatically.
1052 */
Daniel Mack8fdff6a2012-04-12 13:51:11 +02001053
1054 if (urb->iso_frame_desc[0].status != 0 ||
1055 urb->iso_frame_desc[0].actual_length < 3)
1056 return;
1057
1058 f = le32_to_cpup(urb->transfer_buffer);
1059 if (urb->iso_frame_desc[0].actual_length == 3)
1060 f &= 0x00ffffff;
1061 else
1062 f &= 0x0fffffff;
1063
1064 if (f == 0)
1065 return;
1066
1067 if (unlikely(ep->freqshift == INT_MIN)) {
1068 /*
1069 * The first time we see a feedback value, determine its format
1070 * by shifting it left or right until it matches the nominal
1071 * frequency value. This assumes that the feedback does not
1072 * differ from the nominal value more than +50% or -25%.
1073 */
1074 shift = 0;
1075 while (f < ep->freqn - ep->freqn / 4) {
1076 f <<= 1;
1077 shift++;
1078 }
1079 while (f > ep->freqn + ep->freqn / 2) {
1080 f >>= 1;
1081 shift--;
1082 }
1083 ep->freqshift = shift;
1084 } else if (ep->freqshift >= 0)
1085 f <<= ep->freqshift;
1086 else
1087 f >>= -ep->freqshift;
1088
1089 if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1090 /*
1091 * If the frequency looks valid, set it.
1092 * This value is referred to in prepare_playback_urb().
1093 */
1094 spin_lock_irqsave(&ep->lock, flags);
1095 ep->freqm = f;
1096 spin_unlock_irqrestore(&ep->lock, flags);
1097 } else {
1098 /*
1099 * Out of range; maybe the shift value is wrong.
1100 * Reset it so that we autodetect again the next time.
1101 */
1102 ep->freqshift = INT_MIN;
1103 }
1104}
1105