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.
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.
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
18 #include <linux/gfp.h>
19 #include <linux/init.h>
20 #include <linux/ratelimit.h>
21 #include <linux/usb.h>
22 #include <linux/usb/audio.h>
23 #include <linux/slab.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
36 #define EP_FLAG_RUNNING 1
37 #define EP_FLAG_STOPPING 2
40 * snd_usb_endpoint is a model that abstracts everything related to an
41 * USB endpoint and its streaming.
43 * There are functions to activate and deactivate the streaming URBs and
44 * optional callbacks to let the pcm logic handle the actual content of the
45 * packets for playback and record. Thus, the bus streaming and the audio
46 * handlers are fully decoupled.
48 * There are two different types of endpoints in audio applications.
50 * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
51 * inbound and outbound traffic.
53 * 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
57 * Each endpoint has to be configured prior to being used by calling
58 * snd_usb_endpoint_set_params().
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
63 * one to stop it will tear the URBs down again.
67 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
68 * this will overflow at approx 524 kHz
70 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
72 return ((rate << 13) + 62) / 125;
76 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
77 * this will overflow at approx 4 MHz
79 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
81 return ((rate << 10) + 62) / 125;
87 static void release_urb_ctx(struct snd_urb_ctx *u)
89 if (u->urb && u->buffer_size)
90 usb_free_coherent(u->ep->chip->dev, u->buffer_size,
91 u->urb->transfer_buffer,
92 u->urb->transfer_dma);
98 static const char *usb_error_string(int err)
104 return "endpoint not enabled";
106 return "endpoint stalled";
108 return "not enough bandwidth";
110 return "device disabled";
112 return "device suspended";
117 return "internal error";
119 return "unknown error";
124 * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
126 * @ep: The snd_usb_endpoint
128 * Determine whether an endpoint is driven by an implicit feedback
129 * data endpoint source.
131 int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
133 return ep->sync_master &&
134 ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
135 ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
136 usb_pipeout(ep->pipe);
140 * For streaming based on information derived from sync endpoints,
141 * prepare_outbound_urb_sizes() will call next_packet_size() to
142 * determine the number of samples to be sent in the next packet.
144 * For implicit feedback, next_packet_size() is unused.
146 int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
152 return ep->maxframesize;
154 spin_lock_irqsave(&ep->lock, flags);
155 ep->phase = (ep->phase & 0xffff)
156 + (ep->freqm << ep->datainterval);
157 ret = min(ep->phase >> 16, ep->maxframesize);
158 spin_unlock_irqrestore(&ep->lock, flags);
163 static void retire_outbound_urb(struct snd_usb_endpoint *ep,
164 struct snd_urb_ctx *urb_ctx)
166 if (ep->retire_data_urb)
167 ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
170 static void retire_inbound_urb(struct snd_usb_endpoint *ep,
171 struct snd_urb_ctx *urb_ctx)
173 struct urb *urb = urb_ctx->urb;
175 if (unlikely(ep->skip_packets > 0)) {
181 snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
183 if (ep->retire_data_urb)
184 ep->retire_data_urb(ep->data_subs, urb);
187 static void prepare_silent_urb(struct snd_usb_endpoint *ep,
188 struct snd_urb_ctx *ctx)
190 struct urb *urb = ctx->urb;
191 unsigned int offs = 0;
192 unsigned int extra = 0;
193 __le32 packet_length;
196 /* For tx_length_quirk, put packet length at start of packet */
197 if (ep->chip->tx_length_quirk)
198 extra = sizeof(packet_length);
200 for (i = 0; i < ctx->packets; ++i) {
205 if (ctx->packet_size[i])
206 counts = ctx->packet_size[i];
208 counts = snd_usb_endpoint_next_packet_size(ep);
210 length = counts * ep->stride; /* number of silent bytes */
211 offset = offs * ep->stride + extra * i;
212 urb->iso_frame_desc[i].offset = offset;
213 urb->iso_frame_desc[i].length = length + extra;
215 packet_length = cpu_to_le32(length);
216 memcpy(urb->transfer_buffer + offset,
217 &packet_length, sizeof(packet_length));
219 memset(urb->transfer_buffer + offset + extra,
220 ep->silence_value, length);
224 urb->number_of_packets = ctx->packets;
225 urb->transfer_buffer_length = offs * ep->stride + ctx->packets * extra;
229 * Prepare a PLAYBACK urb for submission to the bus.
231 static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
232 struct snd_urb_ctx *ctx)
234 struct urb *urb = ctx->urb;
235 unsigned char *cp = urb->transfer_buffer;
237 urb->dev = ep->chip->dev; /* we need to set this at each time */
240 case SND_USB_ENDPOINT_TYPE_DATA:
241 if (ep->prepare_data_urb) {
242 ep->prepare_data_urb(ep->data_subs, urb);
244 /* no data provider, so send silence */
245 prepare_silent_urb(ep, ctx);
249 case SND_USB_ENDPOINT_TYPE_SYNC:
250 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
252 * fill the length and offset of each urb descriptor.
253 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
255 urb->iso_frame_desc[0].length = 4;
256 urb->iso_frame_desc[0].offset = 0;
258 cp[1] = ep->freqn >> 8;
259 cp[2] = ep->freqn >> 16;
260 cp[3] = ep->freqn >> 24;
263 * fill the length and offset of each urb descriptor.
264 * the fixed 10.14 frequency is passed through the pipe.
266 urb->iso_frame_desc[0].length = 3;
267 urb->iso_frame_desc[0].offset = 0;
268 cp[0] = ep->freqn >> 2;
269 cp[1] = ep->freqn >> 10;
270 cp[2] = ep->freqn >> 18;
278 * Prepare a CAPTURE or SYNC urb for submission to the bus.
280 static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
281 struct snd_urb_ctx *urb_ctx)
284 struct urb *urb = urb_ctx->urb;
286 urb->dev = ep->chip->dev; /* we need to set this at each time */
289 case SND_USB_ENDPOINT_TYPE_DATA:
291 for (i = 0; i < urb_ctx->packets; i++) {
292 urb->iso_frame_desc[i].offset = offs;
293 urb->iso_frame_desc[i].length = ep->curpacksize;
294 offs += ep->curpacksize;
297 urb->transfer_buffer_length = offs;
298 urb->number_of_packets = urb_ctx->packets;
301 case SND_USB_ENDPOINT_TYPE_SYNC:
302 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
303 urb->iso_frame_desc[0].offset = 0;
309 * Send output urbs that have been prepared previously. URBs are dequeued
310 * from ep->ready_playback_urbs and in case there there aren't any available
311 * or there are no packets that have been prepared, this function does
314 * The reason why the functionality of sending and preparing URBs is separated
315 * is that host controllers don't guarantee the order in which they return
316 * inbound and outbound packets to their submitters.
318 * This function is only used for implicit feedback endpoints. For endpoints
319 * driven by dedicated sync endpoints, URBs are immediately re-submitted
320 * from their completion handler.
322 static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
324 while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
327 struct snd_usb_packet_info *packet;
328 struct snd_urb_ctx *ctx = NULL;
332 spin_lock_irqsave(&ep->lock, flags);
333 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
334 packet = ep->next_packet + ep->next_packet_read_pos;
335 ep->next_packet_read_pos++;
336 ep->next_packet_read_pos %= MAX_URBS;
338 /* take URB out of FIFO */
339 if (!list_empty(&ep->ready_playback_urbs))
340 ctx = list_first_entry(&ep->ready_playback_urbs,
341 struct snd_urb_ctx, ready_list);
343 spin_unlock_irqrestore(&ep->lock, flags);
348 list_del_init(&ctx->ready_list);
351 /* copy over the length information */
352 for (i = 0; i < packet->packets; i++)
353 ctx->packet_size[i] = packet->packet_size[i];
355 /* call the data handler to fill in playback data */
356 prepare_outbound_urb(ep, ctx);
358 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
360 usb_audio_err(ep->chip,
361 "Unable to submit urb #%d: %d (urb %p)\n",
362 ctx->index, err, ctx->urb);
364 set_bit(ctx->index, &ep->active_mask);
369 * complete callback for urbs
371 static void snd_complete_urb(struct urb *urb)
373 struct snd_urb_ctx *ctx = urb->context;
374 struct snd_usb_endpoint *ep = ctx->ep;
375 struct snd_pcm_substream *substream;
379 if (unlikely(urb->status == -ENOENT || /* unlinked */
380 urb->status == -ENODEV || /* device removed */
381 urb->status == -ECONNRESET || /* unlinked */
382 urb->status == -ESHUTDOWN)) /* device disabled */
384 /* device disconnected */
385 if (unlikely(atomic_read(&ep->chip->shutdown)))
388 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
391 if (usb_pipeout(ep->pipe)) {
392 retire_outbound_urb(ep, ctx);
393 /* can be stopped during retire callback */
394 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
397 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
398 spin_lock_irqsave(&ep->lock, flags);
399 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
400 spin_unlock_irqrestore(&ep->lock, flags);
401 queue_pending_output_urbs(ep);
406 prepare_outbound_urb(ep, ctx);
407 /* can be stopped during prepare callback */
408 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
411 retire_inbound_urb(ep, ctx);
412 /* can be stopped during retire callback */
413 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
416 prepare_inbound_urb(ep, ctx);
419 err = usb_submit_urb(urb, GFP_ATOMIC);
423 usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
424 if (ep->data_subs && ep->data_subs->pcm_substream) {
425 substream = ep->data_subs->pcm_substream;
426 snd_pcm_stop_xrun(substream);
430 clear_bit(ctx->index, &ep->active_mask);
434 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
437 * @alts: The USB host interface
438 * @ep_num: The number of the endpoint to use
439 * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
440 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
442 * If the requested endpoint has not been added to the given chip before,
443 * a new instance is created. Otherwise, a pointer to the previoulsy
444 * created instance is returned. In case of any error, NULL is returned.
446 * New endpoints will be added to chip->ep_list and must be freed by
447 * calling snd_usb_endpoint_free().
449 * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that
450 * bNumEndpoints > 1 beforehand.
452 struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
453 struct usb_host_interface *alts,
454 int ep_num, int direction, int type)
456 struct snd_usb_endpoint *ep;
457 int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
462 mutex_lock(&chip->mutex);
464 list_for_each_entry(ep, &chip->ep_list, list) {
465 if (ep->ep_num == ep_num &&
466 ep->iface == alts->desc.bInterfaceNumber &&
467 ep->altsetting == alts->desc.bAlternateSetting) {
468 usb_audio_dbg(ep->chip,
469 "Re-using EP %x in iface %d,%d @%p\n",
470 ep_num, ep->iface, ep->altsetting, ep);
475 usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
476 is_playback ? "playback" : "capture",
477 type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
480 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
485 spin_lock_init(&ep->lock);
488 ep->iface = alts->desc.bInterfaceNumber;
489 ep->altsetting = alts->desc.bAlternateSetting;
490 INIT_LIST_HEAD(&ep->ready_playback_urbs);
491 ep_num &= USB_ENDPOINT_NUMBER_MASK;
494 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
496 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
498 if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
499 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
500 get_endpoint(alts, 1)->bRefresh >= 1 &&
501 get_endpoint(alts, 1)->bRefresh <= 9)
502 ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
503 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
504 ep->syncinterval = 1;
505 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
506 get_endpoint(alts, 1)->bInterval <= 16)
507 ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
509 ep->syncinterval = 3;
511 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
514 list_add_tail(&ep->list, &chip->ep_list);
517 mutex_unlock(&chip->mutex);
523 * wait until all urbs are processed.
525 static int wait_clear_urbs(struct snd_usb_endpoint *ep)
527 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
531 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
535 schedule_timeout_uninterruptible(1);
536 } while (time_before(jiffies, end_time));
539 usb_audio_err(ep->chip,
540 "timeout: still %d active urbs on EP #%x\n",
542 clear_bit(EP_FLAG_STOPPING, &ep->flags);
544 ep->data_subs = NULL;
545 ep->sync_slave = NULL;
546 ep->retire_data_urb = NULL;
547 ep->prepare_data_urb = NULL;
552 /* sync the pending stop operation;
553 * this function itself doesn't trigger the stop operation
555 void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
557 if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
562 * unlink active urbs.
564 static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
568 if (!force && atomic_read(&ep->chip->shutdown)) /* to be sure... */
571 clear_bit(EP_FLAG_RUNNING, &ep->flags);
573 INIT_LIST_HEAD(&ep->ready_playback_urbs);
574 ep->next_packet_read_pos = 0;
575 ep->next_packet_write_pos = 0;
577 for (i = 0; i < ep->nurbs; i++) {
578 if (test_bit(i, &ep->active_mask)) {
579 if (!test_and_set_bit(i, &ep->unlink_mask)) {
580 struct urb *u = ep->urb[i].urb;
590 * release an endpoint's urbs
592 static void release_urbs(struct snd_usb_endpoint *ep, int force)
596 /* route incoming urbs to nirvana */
597 ep->retire_data_urb = NULL;
598 ep->prepare_data_urb = NULL;
601 deactivate_urbs(ep, force);
604 for (i = 0; i < ep->nurbs; i++)
605 release_urb_ctx(&ep->urb[i]);
608 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
609 ep->syncbuf, ep->sync_dma);
616 * configure a data endpoint
618 static int data_ep_set_params(struct snd_usb_endpoint *ep,
619 snd_pcm_format_t pcm_format,
620 unsigned int channels,
621 unsigned int period_bytes,
622 unsigned int frames_per_period,
623 unsigned int periods_per_buffer,
624 struct audioformat *fmt,
625 struct snd_usb_endpoint *sync_ep)
627 unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
628 unsigned int max_packs_per_period, urbs_per_period, urb_packs;
629 unsigned int max_urbs, i;
630 int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
631 int tx_length_quirk = (ep->chip->tx_length_quirk &&
632 usb_pipeout(ep->pipe));
634 if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
636 * When operating in DSD DOP mode, the size of a sample frame
637 * in hardware differs from the actual physical format width
638 * because we need to make room for the DOP markers.
640 frame_bits += channels << 3;
643 ep->datainterval = fmt->datainterval;
644 ep->stride = frame_bits >> 3;
646 switch (pcm_format) {
647 case SNDRV_PCM_FORMAT_U8:
648 ep->silence_value = 0x80;
650 case SNDRV_PCM_FORMAT_DSD_U8:
651 case SNDRV_PCM_FORMAT_DSD_U16_LE:
652 case SNDRV_PCM_FORMAT_DSD_U32_LE:
653 case SNDRV_PCM_FORMAT_DSD_U16_BE:
654 case SNDRV_PCM_FORMAT_DSD_U32_BE:
655 ep->silence_value = 0x69;
658 ep->silence_value = 0;
661 /* assume max. frequency is 50% higher than nominal */
662 ep->freqmax = ep->freqn + (ep->freqn >> 1);
663 /* Round up freqmax to nearest integer in order to calculate maximum
664 * packet size, which must represent a whole number of frames.
665 * This is accomplished by adding 0x0.ffff before converting the
666 * Q16.16 format into integer.
667 * In order to accurately calculate the maximum packet size when
668 * the data interval is more than 1 (i.e. ep->datainterval > 0),
669 * multiply by the data interval prior to rounding. For instance,
670 * a freqmax of 41 kHz will result in a max packet size of 6 (5.125)
671 * frames with a data interval of 1, but 11 (10.25) frames with a
672 * data interval of 2.
673 * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the
674 * maximum datainterval value of 3, at USB full speed, higher for
675 * USB high speed, noting that ep->freqmax is in units of
676 * frames per packet in Q16.16 format.)
678 maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) *
681 maxsize += sizeof(__le32); /* Space for length descriptor */
682 /* but wMaxPacketSize might reduce this */
683 if (ep->maxpacksize && ep->maxpacksize < maxsize) {
684 /* whatever fits into a max. size packet */
685 unsigned int data_maxsize = maxsize = ep->maxpacksize;
688 /* Need to remove the length descriptor to calc freq */
689 data_maxsize -= sizeof(__le32);
690 ep->freqmax = (data_maxsize / (frame_bits >> 3))
691 << (16 - ep->datainterval);
695 ep->curpacksize = ep->maxpacksize;
697 ep->curpacksize = maxsize;
699 if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
700 packs_per_ms = 8 >> ep->datainterval;
701 max_packs_per_urb = MAX_PACKS_HS;
704 max_packs_per_urb = MAX_PACKS;
706 if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
707 max_packs_per_urb = min(max_packs_per_urb,
708 1U << sync_ep->syncinterval);
709 max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
712 * Capture endpoints need to use small URBs because there's no way
713 * to tell in advance where the next period will end, and we don't
714 * want the next URB to complete much after the period ends.
716 * Playback endpoints with implicit sync much use the same parameters
717 * as their corresponding capture endpoint.
719 if (usb_pipein(ep->pipe) ||
720 snd_usb_endpoint_implicit_feedback_sink(ep)) {
722 urb_packs = packs_per_ms;
724 * Wireless devices can poll at a max rate of once per 4ms.
725 * For dataintervals less than 5, increase the packet count to
726 * allow the host controller to use bursting to fill in the
729 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
730 int interval = ep->datainterval;
731 while (interval < 5) {
736 /* make capture URBs <= 1 ms and smaller than a period */
737 urb_packs = min(max_packs_per_urb, urb_packs);
738 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
740 ep->nurbs = MAX_URBS;
743 * Playback endpoints without implicit sync are adjusted so that
744 * a period fits as evenly as possible in the smallest number of
745 * URBs. The total number of URBs is adjusted to the size of the
746 * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
749 /* determine how small a packet can be */
750 minsize = (ep->freqn >> (16 - ep->datainterval)) *
752 /* with sync from device, assume it can be 12% lower */
754 minsize -= minsize >> 3;
755 minsize = max(minsize, 1u);
757 /* how many packets will contain an entire ALSA period? */
758 max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
760 /* how many URBs will contain a period? */
761 urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
763 /* how many packets are needed in each URB? */
764 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
766 /* limit the number of frames in a single URB */
767 ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
770 /* try to use enough URBs to contain an entire ALSA buffer */
771 max_urbs = min((unsigned) MAX_URBS,
772 MAX_QUEUE * packs_per_ms / urb_packs);
773 ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
776 /* allocate and initialize data urbs */
777 for (i = 0; i < ep->nurbs; i++) {
778 struct snd_urb_ctx *u = &ep->urb[i];
781 u->packets = urb_packs;
782 u->buffer_size = maxsize * u->packets;
784 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
785 u->packets++; /* for transfer delimiter */
786 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
790 u->urb->transfer_buffer =
791 usb_alloc_coherent(ep->chip->dev, u->buffer_size,
792 GFP_KERNEL, &u->urb->transfer_dma);
793 if (!u->urb->transfer_buffer)
795 u->urb->pipe = ep->pipe;
796 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
797 u->urb->interval = 1 << ep->datainterval;
799 u->urb->complete = snd_complete_urb;
800 INIT_LIST_HEAD(&u->ready_list);
811 * configure a sync endpoint
813 static int sync_ep_set_params(struct snd_usb_endpoint *ep)
817 ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
818 GFP_KERNEL, &ep->sync_dma);
822 ep->nurbs = SYNC_URBS;
823 for (i = 0; i < SYNC_URBS; i++) {
824 struct snd_urb_ctx *u = &ep->urb[i];
828 u->urb = usb_alloc_urb(1, GFP_KERNEL);
831 u->urb->transfer_buffer = ep->syncbuf + i * 4;
832 u->urb->transfer_dma = ep->sync_dma + i * 4;
833 u->urb->transfer_buffer_length = 4;
834 u->urb->pipe = ep->pipe;
835 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
836 u->urb->number_of_packets = 1;
837 u->urb->interval = 1 << ep->syncinterval;
839 u->urb->complete = snd_complete_urb;
850 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
852 * @ep: the snd_usb_endpoint to configure
853 * @pcm_format: the audio fomat.
854 * @channels: the number of audio channels.
855 * @period_bytes: the number of bytes in one alsa period.
856 * @period_frames: the number of frames in one alsa period.
857 * @buffer_periods: the number of periods in one alsa buffer.
858 * @rate: the frame rate.
859 * @fmt: the USB audio format information
860 * @sync_ep: the sync endpoint to use, if any
862 * Determine the number of URBs to be used on this endpoint.
863 * An endpoint must be configured before it can be started.
864 * An endpoint that is already running can not be reconfigured.
866 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
867 snd_pcm_format_t pcm_format,
868 unsigned int channels,
869 unsigned int period_bytes,
870 unsigned int period_frames,
871 unsigned int buffer_periods,
873 struct audioformat *fmt,
874 struct snd_usb_endpoint *sync_ep)
878 if (ep->use_count != 0) {
879 usb_audio_warn(ep->chip,
880 "Unable to change format on ep #%x: already in use\n",
885 /* release old buffers, if any */
888 ep->datainterval = fmt->datainterval;
889 ep->maxpacksize = fmt->maxpacksize;
890 ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
892 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
893 ep->freqn = get_usb_full_speed_rate(rate);
895 ep->freqn = get_usb_high_speed_rate(rate);
897 /* calculate the frequency in 16.16 format */
898 ep->freqm = ep->freqn;
899 ep->freqshift = INT_MIN;
904 case SND_USB_ENDPOINT_TYPE_DATA:
905 err = data_ep_set_params(ep, pcm_format, channels,
906 period_bytes, period_frames,
907 buffer_periods, fmt, sync_ep);
909 case SND_USB_ENDPOINT_TYPE_SYNC:
910 err = sync_ep_set_params(ep);
916 usb_audio_dbg(ep->chip,
917 "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
918 ep->ep_num, ep->type, ep->nurbs, err);
924 * snd_usb_endpoint_start: start an snd_usb_endpoint
926 * @ep: the endpoint to start
928 * A call to this function will increment the use count of the endpoint.
929 * In case it is not already running, the URBs for this endpoint will be
930 * submitted. Otherwise, this function does nothing.
932 * Must be balanced to calls of snd_usb_endpoint_stop().
934 * Returns an error if the URB submission failed, 0 in all other cases.
936 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep)
941 if (atomic_read(&ep->chip->shutdown))
944 /* already running? */
945 if (++ep->use_count != 1)
948 /* just to be sure */
949 deactivate_urbs(ep, false);
955 snd_usb_endpoint_start_quirk(ep);
958 * If this endpoint has a data endpoint as implicit feedback source,
959 * don't start the urbs here. Instead, mark them all as available,
960 * wait for the record urbs to return and queue the playback urbs
964 set_bit(EP_FLAG_RUNNING, &ep->flags);
966 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
967 for (i = 0; i < ep->nurbs; i++) {
968 struct snd_urb_ctx *ctx = ep->urb + i;
969 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
975 for (i = 0; i < ep->nurbs; i++) {
976 struct urb *urb = ep->urb[i].urb;
978 if (snd_BUG_ON(!urb))
981 if (usb_pipeout(ep->pipe)) {
982 prepare_outbound_urb(ep, urb->context);
984 prepare_inbound_urb(ep, urb->context);
987 err = usb_submit_urb(urb, GFP_ATOMIC);
989 usb_audio_err(ep->chip,
990 "cannot submit urb %d, error %d: %s\n",
991 i, err, usb_error_string(err));
994 set_bit(i, &ep->active_mask);
1000 clear_bit(EP_FLAG_RUNNING, &ep->flags);
1002 deactivate_urbs(ep, false);
1007 * snd_usb_endpoint_stop: stop an snd_usb_endpoint
1009 * @ep: the endpoint to stop (may be NULL)
1011 * A call to this function will decrement the use count of the endpoint.
1012 * In case the last user has requested the endpoint stop, the URBs will
1013 * actually be deactivated.
1015 * Must be balanced to calls of snd_usb_endpoint_start().
1017 * The caller needs to synchronize the pending stop operation via
1018 * snd_usb_endpoint_sync_pending_stop().
1020 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
1025 if (snd_BUG_ON(ep->use_count == 0))
1028 if (--ep->use_count == 0) {
1029 deactivate_urbs(ep, false);
1030 set_bit(EP_FLAG_STOPPING, &ep->flags);
1035 * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
1037 * @ep: the endpoint to deactivate
1039 * If the endpoint is not currently in use, this functions will
1040 * deactivate its associated URBs.
1042 * In case of any active users, this functions does nothing.
1044 void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
1049 if (ep->use_count != 0)
1052 deactivate_urbs(ep, true);
1053 wait_clear_urbs(ep);
1057 * snd_usb_endpoint_release: Tear down an snd_usb_endpoint
1059 * @ep: the endpoint to release
1061 * This function does not care for the endpoint's use count but will tear
1062 * down all the streaming URBs immediately.
1064 void snd_usb_endpoint_release(struct snd_usb_endpoint *ep)
1066 release_urbs(ep, 1);
1070 * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
1072 * @ep: the endpoint to free
1074 * This free all resources of the given ep.
1076 void snd_usb_endpoint_free(struct snd_usb_endpoint *ep)
1082 * snd_usb_handle_sync_urb: parse an USB sync packet
1084 * @ep: the endpoint to handle the packet
1085 * @sender: the sending endpoint
1086 * @urb: the received packet
1088 * This function is called from the context of an endpoint that received
1089 * the packet and is used to let another endpoint object handle the payload.
1091 void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
1092 struct snd_usb_endpoint *sender,
1093 const struct urb *urb)
1097 unsigned long flags;
1099 snd_BUG_ON(ep == sender);
1102 * In case the endpoint is operating in implicit feedback mode, prepare
1103 * a new outbound URB that has the same layout as the received packet
1104 * and add it to the list of pending urbs. queue_pending_output_urbs()
1105 * will take care of them later.
1107 if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
1108 ep->use_count != 0) {
1110 /* implicit feedback case */
1112 struct snd_urb_ctx *in_ctx;
1113 struct snd_usb_packet_info *out_packet;
1115 in_ctx = urb->context;
1117 /* Count overall packet size */
1118 for (i = 0; i < in_ctx->packets; i++)
1119 if (urb->iso_frame_desc[i].status == 0)
1120 bytes += urb->iso_frame_desc[i].actual_length;
1123 * skip empty packets. At least M-Audio's Fast Track Ultra stops
1124 * streaming once it received a 0-byte OUT URB
1129 spin_lock_irqsave(&ep->lock, flags);
1130 out_packet = ep->next_packet + ep->next_packet_write_pos;
1133 * Iterate through the inbound packet and prepare the lengths
1134 * for the output packet. The OUT packet we are about to send
1135 * will have the same amount of payload bytes per stride as the
1136 * IN packet we just received. Since the actual size is scaled
1137 * by the stride, use the sender stride to calculate the length
1138 * in case the number of channels differ between the implicitly
1139 * fed-back endpoint and the synchronizing endpoint.
1142 out_packet->packets = in_ctx->packets;
1143 for (i = 0; i < in_ctx->packets; i++) {
1144 if (urb->iso_frame_desc[i].status == 0)
1145 out_packet->packet_size[i] =
1146 urb->iso_frame_desc[i].actual_length / sender->stride;
1148 out_packet->packet_size[i] = 0;
1151 ep->next_packet_write_pos++;
1152 ep->next_packet_write_pos %= MAX_URBS;
1153 spin_unlock_irqrestore(&ep->lock, flags);
1154 queue_pending_output_urbs(ep);
1160 * process after playback sync complete
1162 * Full speed devices report feedback values in 10.14 format as samples
1163 * per frame, high speed devices in 16.16 format as samples per
1166 * Because the Audio Class 1 spec was written before USB 2.0, many high
1167 * speed devices use a wrong interpretation, some others use an
1168 * entirely different format.
1170 * Therefore, we cannot predict what format any particular device uses
1171 * and must detect it automatically.
1174 if (urb->iso_frame_desc[0].status != 0 ||
1175 urb->iso_frame_desc[0].actual_length < 3)
1178 f = le32_to_cpup(urb->transfer_buffer);
1179 if (urb->iso_frame_desc[0].actual_length == 3)
1187 if (unlikely(sender->tenor_fb_quirk)) {
1189 * Devices based on Tenor 8802 chipsets (TEAC UD-H01
1190 * and others) sometimes change the feedback value
1193 if (f < ep->freqn - 0x8000)
1195 else if (f > ep->freqn + 0x8000)
1197 } else if (unlikely(ep->freqshift == INT_MIN)) {
1199 * The first time we see a feedback value, determine its format
1200 * by shifting it left or right until it matches the nominal
1201 * frequency value. This assumes that the feedback does not
1202 * differ from the nominal value more than +50% or -25%.
1205 while (f < ep->freqn - ep->freqn / 4) {
1209 while (f > ep->freqn + ep->freqn / 2) {
1213 ep->freqshift = shift;
1214 } else if (ep->freqshift >= 0)
1215 f <<= ep->freqshift;
1217 f >>= -ep->freqshift;
1219 if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1221 * If the frequency looks valid, set it.
1222 * This value is referred to in prepare_playback_urb().
1224 spin_lock_irqsave(&ep->lock, flags);
1226 spin_unlock_irqrestore(&ep->lock, flags);
1229 * Out of range; maybe the shift value is wrong.
1230 * Reset it so that we autodetect again the next time.
1232 ep->freqshift = INT_MIN;