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>
35 #define EP_FLAG_ACTIVATED 0
36 #define EP_FLAG_RUNNING 1
39 * snd_usb_endpoint is a model that abstracts everything related to an
40 * USB endpoint and its streaming.
42 * There are functions to activate and deactivate the streaming URBs and
43 * optional callbacks to let the pcm logic handle the actual content of the
44 * packets for playback and record. Thus, the bus streaming and the audio
45 * handlers are fully decoupled.
47 * There are two different types of endpoints in audio applications.
49 * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
50 * inbound and outbound traffic.
52 * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
53 * expect the payload to carry Q10.14 / Q16.16 formatted sync information
56 * Each endpoint has to be configured prior to being used by calling
57 * snd_usb_endpoint_set_params().
59 * The model incorporates a reference counting, so that multiple users
60 * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
61 * only the first user will effectively start the URBs, and only the last
62 * one to stop it will tear the URBs down again.
66 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
67 * this will overflow at approx 524 kHz
69 static inline unsigned get_usb_full_speed_rate(unsigned int rate
)
71 return ((rate
<< 13) + 62) / 125;
75 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
76 * this will overflow at approx 4 MHz
78 static inline unsigned get_usb_high_speed_rate(unsigned int rate
)
80 return ((rate
<< 10) + 62) / 125;
86 static void release_urb_ctx(struct snd_urb_ctx
*u
)
89 usb_free_coherent(u
->ep
->chip
->dev
, u
->buffer_size
,
90 u
->urb
->transfer_buffer
,
91 u
->urb
->transfer_dma
);
96 static const char *usb_error_string(int err
)
102 return "endpoint not enabled";
104 return "endpoint stalled";
106 return "not enough bandwidth";
108 return "device disabled";
110 return "device suspended";
115 return "internal error";
117 return "unknown error";
122 * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
124 * @ep: The snd_usb_endpoint
126 * Determine whether an endpoint is driven by an implicit feedback
127 * data endpoint source.
129 int snd_usb_endpoint_implict_feedback_sink(struct snd_usb_endpoint
*ep
)
131 return ep
->sync_master
&&
132 ep
->sync_master
->type
== SND_USB_ENDPOINT_TYPE_DATA
&&
133 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
&&
134 usb_pipeout(ep
->pipe
);
138 * For streaming based on information derived from sync endpoints,
139 * prepare_outbound_urb_sizes() will call next_packet_size() to
140 * determine the number of samples to be sent in the next packet.
142 * For implicit feedback, next_packet_size() is unused.
144 int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint
*ep
)
150 return ep
->maxframesize
;
152 spin_lock_irqsave(&ep
->lock
, flags
);
153 ep
->phase
= (ep
->phase
& 0xffff)
154 + (ep
->freqm
<< ep
->datainterval
);
155 ret
= min(ep
->phase
>> 16, ep
->maxframesize
);
156 spin_unlock_irqrestore(&ep
->lock
, flags
);
161 static void retire_outbound_urb(struct snd_usb_endpoint
*ep
,
162 struct snd_urb_ctx
*urb_ctx
)
164 if (ep
->retire_data_urb
)
165 ep
->retire_data_urb(ep
->data_subs
, urb_ctx
->urb
);
168 static void retire_inbound_urb(struct snd_usb_endpoint
*ep
,
169 struct snd_urb_ctx
*urb_ctx
)
171 struct urb
*urb
= urb_ctx
->urb
;
174 snd_usb_handle_sync_urb(ep
->sync_slave
, ep
, urb
);
176 if (ep
->retire_data_urb
)
177 ep
->retire_data_urb(ep
->data_subs
, urb
);
181 * Prepare a PLAYBACK urb for submission to the bus.
183 static void prepare_outbound_urb(struct snd_usb_endpoint
*ep
,
184 struct snd_urb_ctx
*ctx
)
187 struct urb
*urb
= ctx
->urb
;
188 unsigned char *cp
= urb
->transfer_buffer
;
190 urb
->dev
= ep
->chip
->dev
; /* we need to set this at each time */
193 case SND_USB_ENDPOINT_TYPE_DATA
:
194 if (ep
->prepare_data_urb
) {
195 ep
->prepare_data_urb(ep
->data_subs
, urb
);
197 /* no data provider, so send silence */
198 unsigned int offs
= 0;
199 for (i
= 0; i
< ctx
->packets
; ++i
) {
200 int counts
= ctx
->packet_size
[i
];
201 urb
->iso_frame_desc
[i
].offset
= offs
* ep
->stride
;
202 urb
->iso_frame_desc
[i
].length
= counts
* ep
->stride
;
206 urb
->number_of_packets
= ctx
->packets
;
207 urb
->transfer_buffer_length
= offs
* ep
->stride
;
208 memset(urb
->transfer_buffer
, ep
->silence_value
,
213 case SND_USB_ENDPOINT_TYPE_SYNC
:
214 if (snd_usb_get_speed(ep
->chip
->dev
) >= USB_SPEED_HIGH
) {
216 * fill the length and offset of each urb descriptor.
217 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
219 urb
->iso_frame_desc
[0].length
= 4;
220 urb
->iso_frame_desc
[0].offset
= 0;
222 cp
[1] = ep
->freqn
>> 8;
223 cp
[2] = ep
->freqn
>> 16;
224 cp
[3] = ep
->freqn
>> 24;
227 * fill the length and offset of each urb descriptor.
228 * the fixed 10.14 frequency is passed through the pipe.
230 urb
->iso_frame_desc
[0].length
= 3;
231 urb
->iso_frame_desc
[0].offset
= 0;
232 cp
[0] = ep
->freqn
>> 2;
233 cp
[1] = ep
->freqn
>> 10;
234 cp
[2] = ep
->freqn
>> 18;
242 * Prepare a CAPTURE or SYNC urb for submission to the bus.
244 static inline void prepare_inbound_urb(struct snd_usb_endpoint
*ep
,
245 struct snd_urb_ctx
*urb_ctx
)
248 struct urb
*urb
= urb_ctx
->urb
;
250 urb
->dev
= ep
->chip
->dev
; /* we need to set this at each time */
253 case SND_USB_ENDPOINT_TYPE_DATA
:
255 for (i
= 0; i
< urb_ctx
->packets
; i
++) {
256 urb
->iso_frame_desc
[i
].offset
= offs
;
257 urb
->iso_frame_desc
[i
].length
= ep
->curpacksize
;
258 offs
+= ep
->curpacksize
;
261 urb
->transfer_buffer_length
= offs
;
262 urb
->number_of_packets
= urb_ctx
->packets
;
265 case SND_USB_ENDPOINT_TYPE_SYNC
:
266 urb
->iso_frame_desc
[0].length
= min(4u, ep
->syncmaxsize
);
267 urb
->iso_frame_desc
[0].offset
= 0;
273 * Send output urbs that have been prepared previously. URBs are dequeued
274 * from ep->ready_playback_urbs and in case there there aren't any available
275 * or there are no packets that have been prepared, this function does
278 * The reason why the functionality of sending and preparing URBs is separated
279 * is that host controllers don't guarantee the order in which they return
280 * inbound and outbound packets to their submitters.
282 * This function is only used for implicit feedback endpoints. For endpoints
283 * driven by dedicated sync endpoints, URBs are immediately re-submitted
284 * from their completion handler.
286 static void queue_pending_output_urbs(struct snd_usb_endpoint
*ep
)
288 while (test_bit(EP_FLAG_RUNNING
, &ep
->flags
)) {
291 struct snd_usb_packet_info
*uninitialized_var(packet
);
292 struct snd_urb_ctx
*ctx
= NULL
;
296 spin_lock_irqsave(&ep
->lock
, flags
);
297 if (ep
->next_packet_read_pos
!= ep
->next_packet_write_pos
) {
298 packet
= ep
->next_packet
+ ep
->next_packet_read_pos
;
299 ep
->next_packet_read_pos
++;
300 ep
->next_packet_read_pos
%= MAX_URBS
;
302 /* take URB out of FIFO */
303 if (!list_empty(&ep
->ready_playback_urbs
))
304 ctx
= list_first_entry(&ep
->ready_playback_urbs
,
305 struct snd_urb_ctx
, ready_list
);
307 spin_unlock_irqrestore(&ep
->lock
, flags
);
312 list_del_init(&ctx
->ready_list
);
315 /* copy over the length information */
316 for (i
= 0; i
< packet
->packets
; i
++)
317 ctx
->packet_size
[i
] = packet
->packet_size
[i
];
319 /* call the data handler to fill in playback data */
320 prepare_outbound_urb(ep
, ctx
);
322 err
= usb_submit_urb(ctx
->urb
, GFP_ATOMIC
);
324 snd_printk(KERN_ERR
"Unable to submit urb #%d: %d (urb %p)\n",
325 ctx
->index
, err
, ctx
->urb
);
327 set_bit(ctx
->index
, &ep
->active_mask
);
332 * complete callback for urbs
334 static void snd_complete_urb(struct urb
*urb
)
336 struct snd_urb_ctx
*ctx
= urb
->context
;
337 struct snd_usb_endpoint
*ep
= ctx
->ep
;
340 if (unlikely(urb
->status
== -ENOENT
|| /* unlinked */
341 urb
->status
== -ENODEV
|| /* device removed */
342 urb
->status
== -ECONNRESET
|| /* unlinked */
343 urb
->status
== -ESHUTDOWN
|| /* device disabled */
344 ep
->chip
->shutdown
)) /* device disconnected */
347 if (usb_pipeout(ep
->pipe
)) {
348 retire_outbound_urb(ep
, ctx
);
349 /* can be stopped during retire callback */
350 if (unlikely(!test_bit(EP_FLAG_RUNNING
, &ep
->flags
)))
353 if (snd_usb_endpoint_implict_feedback_sink(ep
)) {
356 spin_lock_irqsave(&ep
->lock
, flags
);
357 list_add_tail(&ctx
->ready_list
, &ep
->ready_playback_urbs
);
358 spin_unlock_irqrestore(&ep
->lock
, flags
);
359 queue_pending_output_urbs(ep
);
364 prepare_outbound_urb(ep
, ctx
);
366 retire_inbound_urb(ep
, ctx
);
367 /* can be stopped during retire callback */
368 if (unlikely(!test_bit(EP_FLAG_RUNNING
, &ep
->flags
)))
371 prepare_inbound_urb(ep
, ctx
);
374 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
378 snd_printk(KERN_ERR
"cannot submit urb (err = %d)\n", err
);
379 //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
382 clear_bit(ctx
->index
, &ep
->active_mask
);
386 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
389 * @alts: The USB host interface
390 * @ep_num: The number of the endpoint to use
391 * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
392 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
394 * If the requested endpoint has not been added to the given chip before,
395 * a new instance is created. Otherwise, a pointer to the previoulsy
396 * created instance is returned. In case of any error, NULL is returned.
398 * New endpoints will be added to chip->ep_list and must be freed by
399 * calling snd_usb_endpoint_free().
401 struct snd_usb_endpoint
*snd_usb_add_endpoint(struct snd_usb_audio
*chip
,
402 struct usb_host_interface
*alts
,
403 int ep_num
, int direction
, int type
)
406 struct snd_usb_endpoint
*ep
;
407 int is_playback
= direction
== SNDRV_PCM_STREAM_PLAYBACK
;
409 mutex_lock(&chip
->mutex
);
411 list_for_each(p
, &chip
->ep_list
) {
412 ep
= list_entry(p
, struct snd_usb_endpoint
, list
);
413 if (ep
->ep_num
== ep_num
&&
414 ep
->iface
== alts
->desc
.bInterfaceNumber
&&
415 ep
->alt_idx
== alts
->desc
.bAlternateSetting
) {
416 snd_printdd(KERN_DEBUG
"Re-using EP %x in iface %d,%d @%p\n",
417 ep_num
, ep
->iface
, ep
->alt_idx
, ep
);
422 snd_printdd(KERN_DEBUG
"Creating new %s %s endpoint #%x\n",
423 is_playback
? "playback" : "capture",
424 type
== SND_USB_ENDPOINT_TYPE_DATA
? "data" : "sync",
427 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
432 spin_lock_init(&ep
->lock
);
435 ep
->iface
= alts
->desc
.bInterfaceNumber
;
436 ep
->alt_idx
= alts
->desc
.bAlternateSetting
;
437 INIT_LIST_HEAD(&ep
->ready_playback_urbs
);
438 ep_num
&= USB_ENDPOINT_NUMBER_MASK
;
441 ep
->pipe
= usb_sndisocpipe(chip
->dev
, ep_num
);
443 ep
->pipe
= usb_rcvisocpipe(chip
->dev
, ep_num
);
445 if (type
== SND_USB_ENDPOINT_TYPE_SYNC
) {
446 if (get_endpoint(alts
, 1)->bLength
>= USB_DT_ENDPOINT_AUDIO_SIZE
&&
447 get_endpoint(alts
, 1)->bRefresh
>= 1 &&
448 get_endpoint(alts
, 1)->bRefresh
<= 9)
449 ep
->syncinterval
= get_endpoint(alts
, 1)->bRefresh
;
450 else if (snd_usb_get_speed(chip
->dev
) == USB_SPEED_FULL
)
451 ep
->syncinterval
= 1;
452 else if (get_endpoint(alts
, 1)->bInterval
>= 1 &&
453 get_endpoint(alts
, 1)->bInterval
<= 16)
454 ep
->syncinterval
= get_endpoint(alts
, 1)->bInterval
- 1;
456 ep
->syncinterval
= 3;
458 ep
->syncmaxsize
= le16_to_cpu(get_endpoint(alts
, 1)->wMaxPacketSize
);
461 list_add_tail(&ep
->list
, &chip
->ep_list
);
464 mutex_unlock(&chip
->mutex
);
470 * wait until all urbs are processed.
472 static int wait_clear_urbs(struct snd_usb_endpoint
*ep
)
474 unsigned long end_time
= jiffies
+ msecs_to_jiffies(1000);
480 for (i
= 0; i
< ep
->nurbs
; i
++)
481 if (test_bit(i
, &ep
->active_mask
))
487 schedule_timeout_uninterruptible(1);
488 } while (time_before(jiffies
, end_time
));
491 snd_printk(KERN_ERR
"timeout: still %d active urbs on EP #%x\n",
498 * unlink active urbs.
500 static int deactivate_urbs(struct snd_usb_endpoint
*ep
, int force
, int can_sleep
)
505 if (!force
&& ep
->chip
->shutdown
) /* to be sure... */
508 async
= !can_sleep
&& ep
->chip
->async_unlink
;
510 clear_bit(EP_FLAG_RUNNING
, &ep
->flags
);
512 INIT_LIST_HEAD(&ep
->ready_playback_urbs
);
513 ep
->next_packet_read_pos
= 0;
514 ep
->next_packet_write_pos
= 0;
516 if (!async
&& in_interrupt())
519 for (i
= 0; i
< ep
->nurbs
; i
++) {
520 if (test_bit(i
, &ep
->active_mask
)) {
521 if (!test_and_set_bit(i
, &ep
->unlink_mask
)) {
522 struct urb
*u
= ep
->urb
[i
].urb
;
535 * release an endpoint's urbs
537 static void release_urbs(struct snd_usb_endpoint
*ep
, int force
)
541 /* route incoming urbs to nirvana */
542 ep
->retire_data_urb
= NULL
;
543 ep
->prepare_data_urb
= NULL
;
546 deactivate_urbs(ep
, force
, 1);
549 for (i
= 0; i
< ep
->nurbs
; i
++)
550 release_urb_ctx(&ep
->urb
[i
]);
553 usb_free_coherent(ep
->chip
->dev
, SYNC_URBS
* 4,
554 ep
->syncbuf
, ep
->sync_dma
);
561 * configure a data endpoint
563 static int data_ep_set_params(struct snd_usb_endpoint
*ep
,
564 struct snd_pcm_hw_params
*hw_params
,
565 struct audioformat
*fmt
,
566 struct snd_usb_endpoint
*sync_ep
)
568 unsigned int maxsize
, i
, urb_packs
, total_packs
, packs_per_ms
;
569 int period_bytes
= params_period_bytes(hw_params
);
570 int format
= params_format(hw_params
);
571 int is_playback
= usb_pipeout(ep
->pipe
);
572 int frame_bits
= snd_pcm_format_physical_width(params_format(hw_params
)) *
573 params_channels(hw_params
);
575 ep
->datainterval
= fmt
->datainterval
;
576 ep
->stride
= frame_bits
>> 3;
577 ep
->silence_value
= format
== SNDRV_PCM_FORMAT_U8
? 0x80 : 0;
579 /* calculate max. frequency */
580 if (ep
->maxpacksize
) {
581 /* whatever fits into a max. size packet */
582 maxsize
= ep
->maxpacksize
;
583 ep
->freqmax
= (maxsize
/ (frame_bits
>> 3))
584 << (16 - ep
->datainterval
);
586 /* no max. packet size: just take 25% higher than nominal */
587 ep
->freqmax
= ep
->freqn
+ (ep
->freqn
>> 2);
588 maxsize
= ((ep
->freqmax
+ 0xffff) * (frame_bits
>> 3))
589 >> (16 - ep
->datainterval
);
593 ep
->curpacksize
= ep
->maxpacksize
;
595 ep
->curpacksize
= maxsize
;
597 if (snd_usb_get_speed(ep
->chip
->dev
) != USB_SPEED_FULL
)
598 packs_per_ms
= 8 >> ep
->datainterval
;
602 if (is_playback
&& !snd_usb_endpoint_implict_feedback_sink(ep
)) {
603 urb_packs
= max(ep
->chip
->nrpacks
, 1);
604 urb_packs
= min(urb_packs
, (unsigned int) MAX_PACKS
);
609 urb_packs
*= packs_per_ms
;
611 if (sync_ep
&& !snd_usb_endpoint_implict_feedback_sink(ep
))
612 urb_packs
= min(urb_packs
, 1U << sync_ep
->syncinterval
);
614 /* decide how many packets to be used */
615 if (is_playback
&& !snd_usb_endpoint_implict_feedback_sink(ep
)) {
616 unsigned int minsize
, maxpacks
;
617 /* determine how small a packet can be */
618 minsize
= (ep
->freqn
>> (16 - ep
->datainterval
))
620 /* with sync from device, assume it can be 12% lower */
622 minsize
-= minsize
>> 3;
623 minsize
= max(minsize
, 1u);
624 total_packs
= (period_bytes
+ minsize
- 1) / minsize
;
625 /* we need at least two URBs for queueing */
626 if (total_packs
< 2) {
629 /* and we don't want too long a queue either */
630 maxpacks
= max(MAX_QUEUE
* packs_per_ms
, urb_packs
* 2);
631 total_packs
= min(total_packs
, maxpacks
);
634 while (urb_packs
> 1 && urb_packs
* maxsize
>= period_bytes
)
636 total_packs
= MAX_URBS
* urb_packs
;
639 ep
->nurbs
= (total_packs
+ urb_packs
- 1) / urb_packs
;
640 if (ep
->nurbs
> MAX_URBS
) {
642 ep
->nurbs
= MAX_URBS
;
643 total_packs
= MAX_URBS
* urb_packs
;
644 } else if (ep
->nurbs
< 2) {
645 /* too little - we need at least two packets
646 * to ensure contiguous playback/capture
651 /* allocate and initialize data urbs */
652 for (i
= 0; i
< ep
->nurbs
; i
++) {
653 struct snd_urb_ctx
*u
= &ep
->urb
[i
];
656 u
->packets
= (i
+ 1) * total_packs
/ ep
->nurbs
657 - i
* total_packs
/ ep
->nurbs
;
658 u
->buffer_size
= maxsize
* u
->packets
;
660 if (fmt
->fmt_type
== UAC_FORMAT_TYPE_II
)
661 u
->packets
++; /* for transfer delimiter */
662 u
->urb
= usb_alloc_urb(u
->packets
, GFP_KERNEL
);
666 u
->urb
->transfer_buffer
=
667 usb_alloc_coherent(ep
->chip
->dev
, u
->buffer_size
,
668 GFP_KERNEL
, &u
->urb
->transfer_dma
);
669 if (!u
->urb
->transfer_buffer
)
671 u
->urb
->pipe
= ep
->pipe
;
672 u
->urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
673 u
->urb
->interval
= 1 << ep
->datainterval
;
675 u
->urb
->complete
= snd_complete_urb
;
676 INIT_LIST_HEAD(&u
->ready_list
);
687 * configure a sync endpoint
689 static int sync_ep_set_params(struct snd_usb_endpoint
*ep
,
690 struct snd_pcm_hw_params
*hw_params
,
691 struct audioformat
*fmt
)
695 ep
->syncbuf
= usb_alloc_coherent(ep
->chip
->dev
, SYNC_URBS
* 4,
696 GFP_KERNEL
, &ep
->sync_dma
);
700 for (i
= 0; i
< SYNC_URBS
; i
++) {
701 struct snd_urb_ctx
*u
= &ep
->urb
[i
];
705 u
->urb
= usb_alloc_urb(1, GFP_KERNEL
);
708 u
->urb
->transfer_buffer
= ep
->syncbuf
+ i
* 4;
709 u
->urb
->transfer_dma
= ep
->sync_dma
+ i
* 4;
710 u
->urb
->transfer_buffer_length
= 4;
711 u
->urb
->pipe
= ep
->pipe
;
712 u
->urb
->transfer_flags
= URB_ISO_ASAP
|
713 URB_NO_TRANSFER_DMA_MAP
;
714 u
->urb
->number_of_packets
= 1;
715 u
->urb
->interval
= 1 << ep
->syncinterval
;
717 u
->urb
->complete
= snd_complete_urb
;
720 ep
->nurbs
= SYNC_URBS
;
730 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
732 * @ep: the snd_usb_endpoint to configure
733 * @hw_params: the hardware parameters
734 * @fmt: the USB audio format information
735 * @sync_ep: the sync endpoint to use, if any
737 * Determine the number of URBs to be used on this endpoint.
738 * An endpoint must be configured before it can be started.
739 * An endpoint that is already running can not be reconfigured.
741 int snd_usb_endpoint_set_params(struct snd_usb_endpoint
*ep
,
742 struct snd_pcm_hw_params
*hw_params
,
743 struct audioformat
*fmt
,
744 struct snd_usb_endpoint
*sync_ep
)
748 if (ep
->use_count
!= 0) {
749 snd_printk(KERN_WARNING
"Unable to change format on ep #%x: already in use\n",
754 /* release old buffers, if any */
757 ep
->datainterval
= fmt
->datainterval
;
758 ep
->maxpacksize
= fmt
->maxpacksize
;
759 ep
->fill_max
= !!(fmt
->attributes
& UAC_EP_CS_ATTR_FILL_MAX
);
761 if (snd_usb_get_speed(ep
->chip
->dev
) == USB_SPEED_FULL
)
762 ep
->freqn
= get_usb_full_speed_rate(params_rate(hw_params
));
764 ep
->freqn
= get_usb_high_speed_rate(params_rate(hw_params
));
766 /* calculate the frequency in 16.16 format */
767 ep
->freqm
= ep
->freqn
;
768 ep
->freqshift
= INT_MIN
;
773 case SND_USB_ENDPOINT_TYPE_DATA
:
774 err
= data_ep_set_params(ep
, hw_params
, fmt
, sync_ep
);
776 case SND_USB_ENDPOINT_TYPE_SYNC
:
777 err
= sync_ep_set_params(ep
, hw_params
, fmt
);
783 snd_printdd(KERN_DEBUG
"Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
784 ep
->ep_num
, ep
->type
, ep
->nurbs
, err
);
790 * snd_usb_endpoint_start: start an snd_usb_endpoint
792 * @ep: the endpoint to start
793 * @can_sleep: flag indicating whether the operation is executed in
796 * A call to this function will increment the use count of the endpoint.
797 * In case it is not already running, the URBs for this endpoint will be
798 * submitted. Otherwise, this function does nothing.
800 * Must be balanced to calls of snd_usb_endpoint_stop().
802 * Returns an error if the URB submission failed, 0 in all other cases.
804 int snd_usb_endpoint_start(struct snd_usb_endpoint
*ep
, int can_sleep
)
809 if (ep
->chip
->shutdown
)
812 /* already running? */
813 if (++ep
->use_count
!= 1)
816 /* just to be sure */
817 deactivate_urbs(ep
, 0, can_sleep
);
826 * If this endpoint has a data endpoint as implicit feedback source,
827 * don't start the urbs here. Instead, mark them all as available,
828 * wait for the record urbs to return and queue the playback urbs
832 set_bit(EP_FLAG_RUNNING
, &ep
->flags
);
834 if (snd_usb_endpoint_implict_feedback_sink(ep
)) {
835 for (i
= 0; i
< ep
->nurbs
; i
++) {
836 struct snd_urb_ctx
*ctx
= ep
->urb
+ i
;
837 list_add_tail(&ctx
->ready_list
, &ep
->ready_playback_urbs
);
843 for (i
= 0; i
< ep
->nurbs
; i
++) {
844 struct urb
*urb
= ep
->urb
[i
].urb
;
846 if (snd_BUG_ON(!urb
))
849 if (usb_pipeout(ep
->pipe
)) {
850 prepare_outbound_urb(ep
, urb
->context
);
852 prepare_inbound_urb(ep
, urb
->context
);
855 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
857 snd_printk(KERN_ERR
"cannot submit urb %d, error %d: %s\n",
858 i
, err
, usb_error_string(err
));
861 set_bit(i
, &ep
->active_mask
);
867 clear_bit(EP_FLAG_RUNNING
, &ep
->flags
);
869 deactivate_urbs(ep
, 0, 0);
874 * snd_usb_endpoint_stop: stop an snd_usb_endpoint
876 * @ep: the endpoint to stop (may be NULL)
878 * A call to this function will decrement the use count of the endpoint.
879 * In case the last user has requested the endpoint stop, the URBs will
880 * actually be deactivated.
882 * Must be balanced to calls of snd_usb_endpoint_start().
884 void snd_usb_endpoint_stop(struct snd_usb_endpoint
*ep
,
885 int force
, int can_sleep
, int wait
)
890 if (snd_BUG_ON(ep
->use_count
== 0))
893 if (--ep
->use_count
== 0) {
894 deactivate_urbs(ep
, force
, can_sleep
);
895 ep
->data_subs
= NULL
;
896 ep
->sync_slave
= NULL
;
897 ep
->retire_data_urb
= NULL
;
898 ep
->prepare_data_urb
= NULL
;
906 * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
908 * @ep: the endpoint to deactivate
910 * If the endpoint is not currently in use, this functions will select the
911 * alternate interface setting 0 for the interface of this endpoint.
913 * In case of any active users, this functions does nothing.
915 * Returns an error if usb_set_interface() failed, 0 in all other
918 int snd_usb_endpoint_deactivate(struct snd_usb_endpoint
*ep
)
923 deactivate_urbs(ep
, 1, 1);
926 if (ep
->use_count
!= 0)
929 clear_bit(EP_FLAG_ACTIVATED
, &ep
->flags
);
935 * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
937 * @ep: the list header of the endpoint to free
939 * This function does not care for the endpoint's use count but will tear
940 * down all the streaming URBs immediately and free all resources.
942 void snd_usb_endpoint_free(struct list_head
*head
)
944 struct snd_usb_endpoint
*ep
;
946 ep
= list_entry(head
, struct snd_usb_endpoint
, list
);
952 * snd_usb_handle_sync_urb: parse an USB sync packet
954 * @ep: the endpoint to handle the packet
955 * @sender: the sending endpoint
956 * @urb: the received packet
958 * This function is called from the context of an endpoint that received
959 * the packet and is used to let another endpoint object handle the payload.
961 void snd_usb_handle_sync_urb(struct snd_usb_endpoint
*ep
,
962 struct snd_usb_endpoint
*sender
,
963 const struct urb
*urb
)
969 snd_BUG_ON(ep
== sender
);
972 * In case the endpoint is operating in implicit feedback mode, prepare
973 * a new outbound URB that has the same layout as the received packet
974 * and add it to the list of pending urbs. queue_pending_output_urbs()
975 * will take care of them later.
977 if (snd_usb_endpoint_implict_feedback_sink(ep
) &&
978 ep
->use_count
!= 0) {
980 /* implicit feedback case */
982 struct snd_urb_ctx
*in_ctx
;
983 struct snd_usb_packet_info
*out_packet
;
985 in_ctx
= urb
->context
;
987 /* Count overall packet size */
988 for (i
= 0; i
< in_ctx
->packets
; i
++)
989 if (urb
->iso_frame_desc
[i
].status
== 0)
990 bytes
+= urb
->iso_frame_desc
[i
].actual_length
;
993 * skip empty packets. At least M-Audio's Fast Track Ultra stops
994 * streaming once it received a 0-byte OUT URB
999 spin_lock_irqsave(&ep
->lock
, flags
);
1000 out_packet
= ep
->next_packet
+ ep
->next_packet_write_pos
;
1003 * Iterate through the inbound packet and prepare the lengths
1004 * for the output packet. The OUT packet we are about to send
1005 * will have the same amount of payload bytes than the IN
1006 * packet we just received.
1009 out_packet
->packets
= in_ctx
->packets
;
1010 for (i
= 0; i
< in_ctx
->packets
; i
++) {
1011 if (urb
->iso_frame_desc
[i
].status
== 0)
1012 out_packet
->packet_size
[i
] =
1013 urb
->iso_frame_desc
[i
].actual_length
/ ep
->stride
;
1015 out_packet
->packet_size
[i
] = 0;
1018 ep
->next_packet_write_pos
++;
1019 ep
->next_packet_write_pos
%= MAX_URBS
;
1020 spin_unlock_irqrestore(&ep
->lock
, flags
);
1021 queue_pending_output_urbs(ep
);
1027 * process after playback sync complete
1029 * Full speed devices report feedback values in 10.14 format as samples
1030 * per frame, high speed devices in 16.16 format as samples per
1033 * Because the Audio Class 1 spec was written before USB 2.0, many high
1034 * speed devices use a wrong interpretation, some others use an
1035 * entirely different format.
1037 * Therefore, we cannot predict what format any particular device uses
1038 * and must detect it automatically.
1041 if (urb
->iso_frame_desc
[0].status
!= 0 ||
1042 urb
->iso_frame_desc
[0].actual_length
< 3)
1045 f
= le32_to_cpup(urb
->transfer_buffer
);
1046 if (urb
->iso_frame_desc
[0].actual_length
== 3)
1054 if (unlikely(ep
->freqshift
== INT_MIN
)) {
1056 * The first time we see a feedback value, determine its format
1057 * by shifting it left or right until it matches the nominal
1058 * frequency value. This assumes that the feedback does not
1059 * differ from the nominal value more than +50% or -25%.
1062 while (f
< ep
->freqn
- ep
->freqn
/ 4) {
1066 while (f
> ep
->freqn
+ ep
->freqn
/ 2) {
1070 ep
->freqshift
= shift
;
1071 } else if (ep
->freqshift
>= 0)
1072 f
<<= ep
->freqshift
;
1074 f
>>= -ep
->freqshift
;
1076 if (likely(f
>= ep
->freqn
- ep
->freqn
/ 8 && f
<= ep
->freqmax
)) {
1078 * If the frequency looks valid, set it.
1079 * This value is referred to in prepare_playback_urb().
1081 spin_lock_irqsave(&ep
->lock
, flags
);
1083 spin_unlock_irqrestore(&ep
->lock
, flags
);
1086 * Out of range; maybe the shift value is wrong.
1087 * Reset it so that we autodetect again the next time.
1089 ep
->freqshift
= INT_MIN
;