ALSA: usb-audio: do not trust too-big wMaxPacketSize values
[linux-3.10.git] / sound / usb / endpoint.c
1 /*
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
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>
24
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28
29 #include "usbaudio.h"
30 #include "helper.h"
31 #include "card.h"
32 #include "endpoint.h"
33 #include "pcm.h"
34 #include "quirks.h"
35
36 #define EP_FLAG_ACTIVATED       0
37 #define EP_FLAG_RUNNING         1
38 #define EP_FLAG_STOPPING        2
39
40 /*
41  * snd_usb_endpoint is a model that abstracts everything related to an
42  * USB endpoint and its streaming.
43  *
44  * There are functions to activate and deactivate the streaming URBs and
45  * optional callbacks to let the pcm logic handle the actual content of the
46  * packets for playback and record. Thus, the bus streaming and the audio
47  * handlers are fully decoupled.
48  *
49  * There are two different types of endpoints in audio applications.
50  *
51  * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
52  * inbound and outbound traffic.
53  *
54  * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
55  * expect the payload to carry Q10.14 / Q16.16 formatted sync information
56  * (3 or 4 bytes).
57  *
58  * Each endpoint has to be configured prior to being used by calling
59  * snd_usb_endpoint_set_params().
60  *
61  * The model incorporates a reference counting, so that multiple users
62  * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
63  * only the first user will effectively start the URBs, and only the last
64  * one to stop it will tear the URBs down again.
65  */
66
67 /*
68  * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
69  * this will overflow at approx 524 kHz
70  */
71 static inline unsigned get_usb_full_speed_rate(unsigned int rate)
72 {
73         return ((rate << 13) + 62) / 125;
74 }
75
76 /*
77  * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
78  * this will overflow at approx 4 MHz
79  */
80 static inline unsigned get_usb_high_speed_rate(unsigned int rate)
81 {
82         return ((rate << 10) + 62) / 125;
83 }
84
85 /*
86  * release a urb data
87  */
88 static void release_urb_ctx(struct snd_urb_ctx *u)
89 {
90         if (u->buffer_size)
91                 usb_free_coherent(u->ep->chip->dev, u->buffer_size,
92                                   u->urb->transfer_buffer,
93                                   u->urb->transfer_dma);
94         usb_free_urb(u->urb);
95         u->urb = NULL;
96 }
97
98 static const char *usb_error_string(int err)
99 {
100         switch (err) {
101         case -ENODEV:
102                 return "no device";
103         case -ENOENT:
104                 return "endpoint not enabled";
105         case -EPIPE:
106                 return "endpoint stalled";
107         case -ENOSPC:
108                 return "not enough bandwidth";
109         case -ESHUTDOWN:
110                 return "device disabled";
111         case -EHOSTUNREACH:
112                 return "device suspended";
113         case -EINVAL:
114         case -EAGAIN:
115         case -EFBIG:
116         case -EMSGSIZE:
117                 return "internal error";
118         default:
119                 return "unknown error";
120         }
121 }
122
123 /**
124  * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
125  *
126  * @ep: The snd_usb_endpoint
127  *
128  * Determine whether an endpoint is driven by an implicit feedback
129  * data endpoint source.
130  */
131 int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
132 {
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);
137 }
138
139 /*
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.
143  *
144  * For implicit feedback, next_packet_size() is unused.
145  */
146 int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
147 {
148         unsigned long flags;
149         int ret;
150
151         if (ep->fill_max)
152                 return ep->maxframesize;
153
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);
159
160         return ret;
161 }
162
163 static void retire_outbound_urb(struct snd_usb_endpoint *ep,
164                                 struct snd_urb_ctx *urb_ctx)
165 {
166         if (ep->retire_data_urb)
167                 ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
168 }
169
170 static void retire_inbound_urb(struct snd_usb_endpoint *ep,
171                                struct snd_urb_ctx *urb_ctx)
172 {
173         struct urb *urb = urb_ctx->urb;
174
175         if (unlikely(ep->skip_packets > 0)) {
176                 ep->skip_packets--;
177                 return;
178         }
179
180         if (ep->sync_slave)
181                 snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
182
183         if (ep->retire_data_urb)
184                 ep->retire_data_urb(ep->data_subs, urb);
185 }
186
187 /*
188  * Prepare a PLAYBACK urb for submission to the bus.
189  */
190 static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
191                                  struct snd_urb_ctx *ctx)
192 {
193         int i;
194         struct urb *urb = ctx->urb;
195         unsigned char *cp = urb->transfer_buffer;
196
197         urb->dev = ep->chip->dev; /* we need to set this at each time */
198
199         switch (ep->type) {
200         case SND_USB_ENDPOINT_TYPE_DATA:
201                 if (ep->prepare_data_urb) {
202                         ep->prepare_data_urb(ep->data_subs, urb);
203                 } else {
204                         /* no data provider, so send silence */
205                         unsigned int offs = 0;
206                         for (i = 0; i < ctx->packets; ++i) {
207                                 int counts;
208
209                                 if (ctx->packet_size[i])
210                                         counts = ctx->packet_size[i];
211                                 else
212                                         counts = snd_usb_endpoint_next_packet_size(ep);
213
214                                 urb->iso_frame_desc[i].offset = offs * ep->stride;
215                                 urb->iso_frame_desc[i].length = counts * ep->stride;
216                                 offs += counts;
217                         }
218
219                         urb->number_of_packets = ctx->packets;
220                         urb->transfer_buffer_length = offs * ep->stride;
221                         memset(urb->transfer_buffer, ep->silence_value,
222                                offs * ep->stride);
223                 }
224                 break;
225
226         case SND_USB_ENDPOINT_TYPE_SYNC:
227                 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
228                         /*
229                          * fill the length and offset of each urb descriptor.
230                          * the fixed 12.13 frequency is passed as 16.16 through the pipe.
231                          */
232                         urb->iso_frame_desc[0].length = 4;
233                         urb->iso_frame_desc[0].offset = 0;
234                         cp[0] = ep->freqn;
235                         cp[1] = ep->freqn >> 8;
236                         cp[2] = ep->freqn >> 16;
237                         cp[3] = ep->freqn >> 24;
238                 } else {
239                         /*
240                          * fill the length and offset of each urb descriptor.
241                          * the fixed 10.14 frequency is passed through the pipe.
242                          */
243                         urb->iso_frame_desc[0].length = 3;
244                         urb->iso_frame_desc[0].offset = 0;
245                         cp[0] = ep->freqn >> 2;
246                         cp[1] = ep->freqn >> 10;
247                         cp[2] = ep->freqn >> 18;
248                 }
249
250                 break;
251         }
252 }
253
254 /*
255  * Prepare a CAPTURE or SYNC urb for submission to the bus.
256  */
257 static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
258                                        struct snd_urb_ctx *urb_ctx)
259 {
260         int i, offs;
261         struct urb *urb = urb_ctx->urb;
262
263         urb->dev = ep->chip->dev; /* we need to set this at each time */
264
265         switch (ep->type) {
266         case SND_USB_ENDPOINT_TYPE_DATA:
267                 offs = 0;
268                 for (i = 0; i < urb_ctx->packets; i++) {
269                         urb->iso_frame_desc[i].offset = offs;
270                         urb->iso_frame_desc[i].length = ep->curpacksize;
271                         offs += ep->curpacksize;
272                 }
273
274                 urb->transfer_buffer_length = offs;
275                 urb->number_of_packets = urb_ctx->packets;
276                 break;
277
278         case SND_USB_ENDPOINT_TYPE_SYNC:
279                 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
280                 urb->iso_frame_desc[0].offset = 0;
281                 break;
282         }
283 }
284
285 /*
286  * Send output urbs that have been prepared previously. URBs are dequeued
287  * from ep->ready_playback_urbs and in case there there aren't any available
288  * or there are no packets that have been prepared, this function does
289  * nothing.
290  *
291  * The reason why the functionality of sending and preparing URBs is separated
292  * is that host controllers don't guarantee the order in which they return
293  * inbound and outbound packets to their submitters.
294  *
295  * This function is only used for implicit feedback endpoints. For endpoints
296  * driven by dedicated sync endpoints, URBs are immediately re-submitted
297  * from their completion handler.
298  */
299 static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
300 {
301         while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
302
303                 unsigned long flags;
304                 struct snd_usb_packet_info *uninitialized_var(packet);
305                 struct snd_urb_ctx *ctx = NULL;
306                 struct urb *urb;
307                 int err, i;
308
309                 spin_lock_irqsave(&ep->lock, flags);
310                 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
311                         packet = ep->next_packet + ep->next_packet_read_pos;
312                         ep->next_packet_read_pos++;
313                         ep->next_packet_read_pos %= MAX_URBS;
314
315                         /* take URB out of FIFO */
316                         if (!list_empty(&ep->ready_playback_urbs))
317                                 ctx = list_first_entry(&ep->ready_playback_urbs,
318                                                struct snd_urb_ctx, ready_list);
319                 }
320                 spin_unlock_irqrestore(&ep->lock, flags);
321
322                 if (ctx == NULL)
323                         return;
324
325                 list_del_init(&ctx->ready_list);
326                 urb = ctx->urb;
327
328                 /* copy over the length information */
329                 for (i = 0; i < packet->packets; i++)
330                         ctx->packet_size[i] = packet->packet_size[i];
331
332                 /* call the data handler to fill in playback data */
333                 prepare_outbound_urb(ep, ctx);
334
335                 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
336                 if (err < 0)
337                         snd_printk(KERN_ERR "Unable to submit urb #%d: %d (urb %p)\n",
338                                    ctx->index, err, ctx->urb);
339                 else
340                         set_bit(ctx->index, &ep->active_mask);
341         }
342 }
343
344 /*
345  * complete callback for urbs
346  */
347 static void snd_complete_urb(struct urb *urb)
348 {
349         struct snd_urb_ctx *ctx = urb->context;
350         struct snd_usb_endpoint *ep = ctx->ep;
351         int err;
352
353         if (unlikely(urb->status == -ENOENT ||          /* unlinked */
354                      urb->status == -ENODEV ||          /* device removed */
355                      urb->status == -ECONNRESET ||      /* unlinked */
356                      urb->status == -ESHUTDOWN ||       /* device disabled */
357                      ep->chip->shutdown))               /* device disconnected */
358                 goto exit_clear;
359
360         if (usb_pipeout(ep->pipe)) {
361                 retire_outbound_urb(ep, ctx);
362                 /* can be stopped during retire callback */
363                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
364                         goto exit_clear;
365
366                 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
367                         unsigned long flags;
368
369                         spin_lock_irqsave(&ep->lock, flags);
370                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
371                         spin_unlock_irqrestore(&ep->lock, flags);
372                         queue_pending_output_urbs(ep);
373
374                         goto exit_clear;
375                 }
376
377                 prepare_outbound_urb(ep, ctx);
378         } else {
379                 retire_inbound_urb(ep, ctx);
380                 /* can be stopped during retire callback */
381                 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
382                         goto exit_clear;
383
384                 prepare_inbound_urb(ep, ctx);
385         }
386
387         err = usb_submit_urb(urb, GFP_ATOMIC);
388         if (err == 0)
389                 return;
390
391         snd_printk(KERN_ERR "cannot submit urb (err = %d)\n", err);
392         //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
393
394 exit_clear:
395         clear_bit(ctx->index, &ep->active_mask);
396 }
397
398 /**
399  * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
400  *
401  * @chip: The chip
402  * @alts: The USB host interface
403  * @ep_num: The number of the endpoint to use
404  * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
405  * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
406  *
407  * If the requested endpoint has not been added to the given chip before,
408  * a new instance is created. Otherwise, a pointer to the previoulsy
409  * created instance is returned. In case of any error, NULL is returned.
410  *
411  * New endpoints will be added to chip->ep_list and must be freed by
412  * calling snd_usb_endpoint_free().
413  */
414 struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
415                                               struct usb_host_interface *alts,
416                                               int ep_num, int direction, int type)
417 {
418         struct snd_usb_endpoint *ep;
419         int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
420
421         mutex_lock(&chip->mutex);
422
423         list_for_each_entry(ep, &chip->ep_list, list) {
424                 if (ep->ep_num == ep_num &&
425                     ep->iface == alts->desc.bInterfaceNumber &&
426                     ep->alt_idx == alts->desc.bAlternateSetting) {
427                         snd_printdd(KERN_DEBUG "Re-using EP %x in iface %d,%d @%p\n",
428                                         ep_num, ep->iface, ep->alt_idx, ep);
429                         goto __exit_unlock;
430                 }
431         }
432
433         snd_printdd(KERN_DEBUG "Creating new %s %s endpoint #%x\n",
434                     is_playback ? "playback" : "capture",
435                     type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
436                     ep_num);
437
438         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
439         if (!ep)
440                 goto __exit_unlock;
441
442         ep->chip = chip;
443         spin_lock_init(&ep->lock);
444         ep->type = type;
445         ep->ep_num = ep_num;
446         ep->iface = alts->desc.bInterfaceNumber;
447         ep->alt_idx = alts->desc.bAlternateSetting;
448         INIT_LIST_HEAD(&ep->ready_playback_urbs);
449         ep_num &= USB_ENDPOINT_NUMBER_MASK;
450
451         if (is_playback)
452                 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
453         else
454                 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
455
456         if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
457                 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
458                     get_endpoint(alts, 1)->bRefresh >= 1 &&
459                     get_endpoint(alts, 1)->bRefresh <= 9)
460                         ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
461                 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
462                         ep->syncinterval = 1;
463                 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
464                          get_endpoint(alts, 1)->bInterval <= 16)
465                         ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
466                 else
467                         ep->syncinterval = 3;
468
469                 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
470         }
471
472         list_add_tail(&ep->list, &chip->ep_list);
473
474 __exit_unlock:
475         mutex_unlock(&chip->mutex);
476
477         return ep;
478 }
479
480 /*
481  *  wait until all urbs are processed.
482  */
483 static int wait_clear_urbs(struct snd_usb_endpoint *ep)
484 {
485         unsigned long end_time = jiffies + msecs_to_jiffies(1000);
486         int alive;
487
488         do {
489                 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
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         clear_bit(EP_FLAG_STOPPING, &ep->flags);
500
501         return 0;
502 }
503
504 /* sync the pending stop operation;
505  * this function itself doesn't trigger the stop operation
506  */
507 void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
508 {
509         if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
510                 wait_clear_urbs(ep);
511 }
512
513 /*
514  * unlink active urbs.
515  */
516 static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
517 {
518         unsigned int i;
519
520         if (!force && ep->chip->shutdown) /* to be sure... */
521                 return -EBADFD;
522
523         clear_bit(EP_FLAG_RUNNING, &ep->flags);
524
525         INIT_LIST_HEAD(&ep->ready_playback_urbs);
526         ep->next_packet_read_pos = 0;
527         ep->next_packet_write_pos = 0;
528
529         for (i = 0; i < ep->nurbs; i++) {
530                 if (test_bit(i, &ep->active_mask)) {
531                         if (!test_and_set_bit(i, &ep->unlink_mask)) {
532                                 struct urb *u = ep->urb[i].urb;
533                                 usb_unlink_urb(u);
534                         }
535                 }
536         }
537
538         return 0;
539 }
540
541 /*
542  * release an endpoint's urbs
543  */
544 static void release_urbs(struct snd_usb_endpoint *ep, int force)
545 {
546         int i;
547
548         /* route incoming urbs to nirvana */
549         ep->retire_data_urb = NULL;
550         ep->prepare_data_urb = NULL;
551
552         /* stop urbs */
553         deactivate_urbs(ep, force);
554         wait_clear_urbs(ep);
555
556         for (i = 0; i < ep->nurbs; i++)
557                 release_urb_ctx(&ep->urb[i]);
558
559         if (ep->syncbuf)
560                 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
561                                   ep->syncbuf, ep->sync_dma);
562
563         ep->syncbuf = NULL;
564         ep->nurbs = 0;
565 }
566
567 /*
568  * configure a data endpoint
569  */
570 static int data_ep_set_params(struct snd_usb_endpoint *ep,
571                               snd_pcm_format_t pcm_format,
572                               unsigned int channels,
573                               unsigned int period_bytes,
574                               struct audioformat *fmt,
575                               struct snd_usb_endpoint *sync_ep)
576 {
577         unsigned int maxsize, i, urb_packs, total_packs, packs_per_ms;
578         int is_playback = usb_pipeout(ep->pipe);
579         int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
580
581         if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
582                 /*
583                  * When operating in DSD DOP mode, the size of a sample frame
584                  * in hardware differs from the actual physical format width
585                  * because we need to make room for the DOP markers.
586                  */
587                 frame_bits += channels << 3;
588         }
589
590         ep->datainterval = fmt->datainterval;
591         ep->stride = frame_bits >> 3;
592         ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
593
594         /* assume max. frequency is 25% higher than nominal */
595         ep->freqmax = ep->freqn + (ep->freqn >> 2);
596         maxsize = ((ep->freqmax + 0xffff) * (frame_bits >> 3))
597                                 >> (16 - ep->datainterval);
598         /* but wMaxPacketSize might reduce this */
599         if (ep->maxpacksize && ep->maxpacksize < maxsize) {
600                 /* whatever fits into a max. size packet */
601                 maxsize = ep->maxpacksize;
602                 ep->freqmax = (maxsize / (frame_bits >> 3))
603                                 << (16 - ep->datainterval);
604         }
605
606         if (ep->fill_max)
607                 ep->curpacksize = ep->maxpacksize;
608         else
609                 ep->curpacksize = maxsize;
610
611         if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL)
612                 packs_per_ms = 8 >> ep->datainterval;
613         else
614                 packs_per_ms = 1;
615
616         if (is_playback && !snd_usb_endpoint_implicit_feedback_sink(ep)) {
617                 urb_packs = max(ep->chip->nrpacks, 1);
618                 urb_packs = min(urb_packs, (unsigned int) MAX_PACKS);
619         } else {
620                 urb_packs = 1;
621         }
622
623         urb_packs *= packs_per_ms;
624
625         if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
626                 urb_packs = min(urb_packs, 1U << sync_ep->syncinterval);
627
628         /* decide how many packets to be used */
629         if (is_playback && !snd_usb_endpoint_implicit_feedback_sink(ep)) {
630                 unsigned int minsize, maxpacks;
631                 /* determine how small a packet can be */
632                 minsize = (ep->freqn >> (16 - ep->datainterval))
633                           * (frame_bits >> 3);
634                 /* with sync from device, assume it can be 12% lower */
635                 if (sync_ep)
636                         minsize -= minsize >> 3;
637                 minsize = max(minsize, 1u);
638                 total_packs = (period_bytes + minsize - 1) / minsize;
639                 /* we need at least two URBs for queueing */
640                 if (total_packs < 2) {
641                         total_packs = 2;
642                 } else {
643                         /* and we don't want too long a queue either */
644                         maxpacks = max(MAX_QUEUE * packs_per_ms, urb_packs * 2);
645                         total_packs = min(total_packs, maxpacks);
646                 }
647         } else {
648                 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
649                         urb_packs >>= 1;
650                 total_packs = MAX_URBS * urb_packs;
651         }
652
653         ep->nurbs = (total_packs + urb_packs - 1) / urb_packs;
654         if (ep->nurbs > MAX_URBS) {
655                 /* too much... */
656                 ep->nurbs = MAX_URBS;
657                 total_packs = MAX_URBS * urb_packs;
658         } else if (ep->nurbs < 2) {
659                 /* too little - we need at least two packets
660                  * to ensure contiguous playback/capture
661                  */
662                 ep->nurbs = 2;
663         }
664
665         /* allocate and initialize data urbs */
666         for (i = 0; i < ep->nurbs; i++) {
667                 struct snd_urb_ctx *u = &ep->urb[i];
668                 u->index = i;
669                 u->ep = ep;
670                 u->packets = (i + 1) * total_packs / ep->nurbs
671                         - i * total_packs / ep->nurbs;
672                 u->buffer_size = maxsize * u->packets;
673
674                 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
675                         u->packets++; /* for transfer delimiter */
676                 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
677                 if (!u->urb)
678                         goto out_of_memory;
679
680                 u->urb->transfer_buffer =
681                         usb_alloc_coherent(ep->chip->dev, u->buffer_size,
682                                            GFP_KERNEL, &u->urb->transfer_dma);
683                 if (!u->urb->transfer_buffer)
684                         goto out_of_memory;
685                 u->urb->pipe = ep->pipe;
686                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
687                 u->urb->interval = 1 << ep->datainterval;
688                 u->urb->context = u;
689                 u->urb->complete = snd_complete_urb;
690                 INIT_LIST_HEAD(&u->ready_list);
691         }
692
693         return 0;
694
695 out_of_memory:
696         release_urbs(ep, 0);
697         return -ENOMEM;
698 }
699
700 /*
701  * configure a sync endpoint
702  */
703 static int sync_ep_set_params(struct snd_usb_endpoint *ep,
704                               struct audioformat *fmt)
705 {
706         int i;
707
708         ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
709                                          GFP_KERNEL, &ep->sync_dma);
710         if (!ep->syncbuf)
711                 return -ENOMEM;
712
713         for (i = 0; i < SYNC_URBS; i++) {
714                 struct snd_urb_ctx *u = &ep->urb[i];
715                 u->index = i;
716                 u->ep = ep;
717                 u->packets = 1;
718                 u->urb = usb_alloc_urb(1, GFP_KERNEL);
719                 if (!u->urb)
720                         goto out_of_memory;
721                 u->urb->transfer_buffer = ep->syncbuf + i * 4;
722                 u->urb->transfer_dma = ep->sync_dma + i * 4;
723                 u->urb->transfer_buffer_length = 4;
724                 u->urb->pipe = ep->pipe;
725                 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
726                 u->urb->number_of_packets = 1;
727                 u->urb->interval = 1 << ep->syncinterval;
728                 u->urb->context = u;
729                 u->urb->complete = snd_complete_urb;
730         }
731
732         ep->nurbs = SYNC_URBS;
733
734         return 0;
735
736 out_of_memory:
737         release_urbs(ep, 0);
738         return -ENOMEM;
739 }
740
741 /**
742  * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
743  *
744  * @ep: the snd_usb_endpoint to configure
745  * @pcm_format: the audio fomat.
746  * @channels: the number of audio channels.
747  * @period_bytes: the number of bytes in one alsa period.
748  * @rate: the frame rate.
749  * @fmt: the USB audio format information
750  * @sync_ep: the sync endpoint to use, if any
751  *
752  * Determine the number of URBs to be used on this endpoint.
753  * An endpoint must be configured before it can be started.
754  * An endpoint that is already running can not be reconfigured.
755  */
756 int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
757                                 snd_pcm_format_t pcm_format,
758                                 unsigned int channels,
759                                 unsigned int period_bytes,
760                                 unsigned int rate,
761                                 struct audioformat *fmt,
762                                 struct snd_usb_endpoint *sync_ep)
763 {
764         int err;
765
766         if (ep->use_count != 0) {
767                 snd_printk(KERN_WARNING "Unable to change format on ep #%x: already in use\n",
768                            ep->ep_num);
769                 return -EBUSY;
770         }
771
772         /* release old buffers, if any */
773         release_urbs(ep, 0);
774
775         ep->datainterval = fmt->datainterval;
776         ep->maxpacksize = fmt->maxpacksize;
777         ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
778
779         if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
780                 ep->freqn = get_usb_full_speed_rate(rate);
781         else
782                 ep->freqn = get_usb_high_speed_rate(rate);
783
784         /* calculate the frequency in 16.16 format */
785         ep->freqm = ep->freqn;
786         ep->freqshift = INT_MIN;
787
788         ep->phase = 0;
789
790         switch (ep->type) {
791         case  SND_USB_ENDPOINT_TYPE_DATA:
792                 err = data_ep_set_params(ep, pcm_format, channels,
793                                          period_bytes, fmt, sync_ep);
794                 break;
795         case  SND_USB_ENDPOINT_TYPE_SYNC:
796                 err = sync_ep_set_params(ep, fmt);
797                 break;
798         default:
799                 err = -EINVAL;
800         }
801
802         snd_printdd(KERN_DEBUG "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
803                    ep->ep_num, ep->type, ep->nurbs, err);
804
805         return err;
806 }
807
808 /**
809  * snd_usb_endpoint_start: start an snd_usb_endpoint
810  *
811  * @ep:         the endpoint to start
812  * @can_sleep:  flag indicating whether the operation is executed in
813  *              non-atomic context
814  *
815  * A call to this function will increment the use count of the endpoint.
816  * In case it is not already running, the URBs for this endpoint will be
817  * submitted. Otherwise, this function does nothing.
818  *
819  * Must be balanced to calls of snd_usb_endpoint_stop().
820  *
821  * Returns an error if the URB submission failed, 0 in all other cases.
822  */
823 int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, bool can_sleep)
824 {
825         int err;
826         unsigned int i;
827
828         if (ep->chip->shutdown)
829                 return -EBADFD;
830
831         /* already running? */
832         if (++ep->use_count != 1)
833                 return 0;
834
835         /* just to be sure */
836         deactivate_urbs(ep, false);
837         if (can_sleep)
838                 wait_clear_urbs(ep);
839
840         ep->active_mask = 0;
841         ep->unlink_mask = 0;
842         ep->phase = 0;
843
844         snd_usb_endpoint_start_quirk(ep);
845
846         /*
847          * If this endpoint has a data endpoint as implicit feedback source,
848          * don't start the urbs here. Instead, mark them all as available,
849          * wait for the record urbs to return and queue the playback urbs
850          * from that context.
851          */
852
853         set_bit(EP_FLAG_RUNNING, &ep->flags);
854
855         if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
856                 for (i = 0; i < ep->nurbs; i++) {
857                         struct snd_urb_ctx *ctx = ep->urb + i;
858                         list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
859                 }
860
861                 return 0;
862         }
863
864         for (i = 0; i < ep->nurbs; i++) {
865                 struct urb *urb = ep->urb[i].urb;
866
867                 if (snd_BUG_ON(!urb))
868                         goto __error;
869
870                 if (usb_pipeout(ep->pipe)) {
871                         prepare_outbound_urb(ep, urb->context);
872                 } else {
873                         prepare_inbound_urb(ep, urb->context);
874                 }
875
876                 err = usb_submit_urb(urb, GFP_ATOMIC);
877                 if (err < 0) {
878                         snd_printk(KERN_ERR "cannot submit urb %d, error %d: %s\n",
879                                    i, err, usb_error_string(err));
880                         goto __error;
881                 }
882                 set_bit(i, &ep->active_mask);
883         }
884
885         return 0;
886
887 __error:
888         clear_bit(EP_FLAG_RUNNING, &ep->flags);
889         ep->use_count--;
890         deactivate_urbs(ep, false);
891         return -EPIPE;
892 }
893
894 /**
895  * snd_usb_endpoint_stop: stop an snd_usb_endpoint
896  *
897  * @ep: the endpoint to stop (may be NULL)
898  *
899  * A call to this function will decrement the use count of the endpoint.
900  * In case the last user has requested the endpoint stop, the URBs will
901  * actually be deactivated.
902  *
903  * Must be balanced to calls of snd_usb_endpoint_start().
904  *
905  * The caller needs to synchronize the pending stop operation via
906  * snd_usb_endpoint_sync_pending_stop().
907  */
908 void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
909 {
910         if (!ep)
911                 return;
912
913         if (snd_BUG_ON(ep->use_count == 0))
914                 return;
915
916         if (--ep->use_count == 0) {
917                 deactivate_urbs(ep, false);
918                 ep->data_subs = NULL;
919                 ep->sync_slave = NULL;
920                 ep->retire_data_urb = NULL;
921                 ep->prepare_data_urb = NULL;
922                 set_bit(EP_FLAG_STOPPING, &ep->flags);
923         }
924 }
925
926 /**
927  * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
928  *
929  * @ep: the endpoint to deactivate
930  *
931  * If the endpoint is not currently in use, this functions will select the
932  * alternate interface setting 0 for the interface of this endpoint.
933  *
934  * In case of any active users, this functions does nothing.
935  *
936  * Returns an error if usb_set_interface() failed, 0 in all other
937  * cases.
938  */
939 int snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
940 {
941         if (!ep)
942                 return -EINVAL;
943
944         deactivate_urbs(ep, true);
945         wait_clear_urbs(ep);
946
947         if (ep->use_count != 0)
948                 return 0;
949
950         clear_bit(EP_FLAG_ACTIVATED, &ep->flags);
951
952         return 0;
953 }
954
955 /**
956  * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
957  *
958  * @ep: the list header of the endpoint to free
959  *
960  * This function does not care for the endpoint's use count but will tear
961  * down all the streaming URBs immediately and free all resources.
962  */
963 void snd_usb_endpoint_free(struct list_head *head)
964 {
965         struct snd_usb_endpoint *ep;
966
967         ep = list_entry(head, struct snd_usb_endpoint, list);
968         release_urbs(ep, 1);
969         kfree(ep);
970 }
971
972 /**
973  * snd_usb_handle_sync_urb: parse an USB sync packet
974  *
975  * @ep: the endpoint to handle the packet
976  * @sender: the sending endpoint
977  * @urb: the received packet
978  *
979  * This function is called from the context of an endpoint that received
980  * the packet and is used to let another endpoint object handle the payload.
981  */
982 void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
983                              struct snd_usb_endpoint *sender,
984                              const struct urb *urb)
985 {
986         int shift;
987         unsigned int f;
988         unsigned long flags;
989
990         snd_BUG_ON(ep == sender);
991
992         /*
993          * In case the endpoint is operating in implicit feedback mode, prepare
994          * a new outbound URB that has the same layout as the received packet
995          * and add it to the list of pending urbs. queue_pending_output_urbs()
996          * will take care of them later.
997          */
998         if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
999             ep->use_count != 0) {
1000
1001                 /* implicit feedback case */
1002                 int i, bytes = 0;
1003                 struct snd_urb_ctx *in_ctx;
1004                 struct snd_usb_packet_info *out_packet;
1005
1006                 in_ctx = urb->context;
1007
1008                 /* Count overall packet size */
1009                 for (i = 0; i < in_ctx->packets; i++)
1010                         if (urb->iso_frame_desc[i].status == 0)
1011                                 bytes += urb->iso_frame_desc[i].actual_length;
1012
1013                 /*
1014                  * skip empty packets. At least M-Audio's Fast Track Ultra stops
1015                  * streaming once it received a 0-byte OUT URB
1016                  */
1017                 if (bytes == 0)
1018                         return;
1019
1020                 spin_lock_irqsave(&ep->lock, flags);
1021                 out_packet = ep->next_packet + ep->next_packet_write_pos;
1022
1023                 /*
1024                  * Iterate through the inbound packet and prepare the lengths
1025                  * for the output packet. The OUT packet we are about to send
1026                  * will have the same amount of payload bytes per stride as the
1027                  * IN packet we just received. Since the actual size is scaled
1028                  * by the stride, use the sender stride to calculate the length
1029                  * in case the number of channels differ between the implicitly
1030                  * fed-back endpoint and the synchronizing endpoint.
1031                  */
1032
1033                 out_packet->packets = in_ctx->packets;
1034                 for (i = 0; i < in_ctx->packets; i++) {
1035                         if (urb->iso_frame_desc[i].status == 0)
1036                                 out_packet->packet_size[i] =
1037                                         urb->iso_frame_desc[i].actual_length / sender->stride;
1038                         else
1039                                 out_packet->packet_size[i] = 0;
1040                 }
1041
1042                 ep->next_packet_write_pos++;
1043                 ep->next_packet_write_pos %= MAX_URBS;
1044                 spin_unlock_irqrestore(&ep->lock, flags);
1045                 queue_pending_output_urbs(ep);
1046
1047                 return;
1048         }
1049
1050         /*
1051          * process after playback sync complete
1052          *
1053          * Full speed devices report feedback values in 10.14 format as samples
1054          * per frame, high speed devices in 16.16 format as samples per
1055          * microframe.
1056          *
1057          * Because the Audio Class 1 spec was written before USB 2.0, many high
1058          * speed devices use a wrong interpretation, some others use an
1059          * entirely different format.
1060          *
1061          * Therefore, we cannot predict what format any particular device uses
1062          * and must detect it automatically.
1063          */
1064
1065         if (urb->iso_frame_desc[0].status != 0 ||
1066             urb->iso_frame_desc[0].actual_length < 3)
1067                 return;
1068
1069         f = le32_to_cpup(urb->transfer_buffer);
1070         if (urb->iso_frame_desc[0].actual_length == 3)
1071                 f &= 0x00ffffff;
1072         else
1073                 f &= 0x0fffffff;
1074
1075         if (f == 0)
1076                 return;
1077
1078         if (unlikely(ep->freqshift == INT_MIN)) {
1079                 /*
1080                  * The first time we see a feedback value, determine its format
1081                  * by shifting it left or right until it matches the nominal
1082                  * frequency value.  This assumes that the feedback does not
1083                  * differ from the nominal value more than +50% or -25%.
1084                  */
1085                 shift = 0;
1086                 while (f < ep->freqn - ep->freqn / 4) {
1087                         f <<= 1;
1088                         shift++;
1089                 }
1090                 while (f > ep->freqn + ep->freqn / 2) {
1091                         f >>= 1;
1092                         shift--;
1093                 }
1094                 ep->freqshift = shift;
1095         } else if (ep->freqshift >= 0)
1096                 f <<= ep->freqshift;
1097         else
1098                 f >>= -ep->freqshift;
1099
1100         if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1101                 /*
1102                  * If the frequency looks valid, set it.
1103                  * This value is referred to in prepare_playback_urb().
1104                  */
1105                 spin_lock_irqsave(&ep->lock, flags);
1106                 ep->freqm = f;
1107                 spin_unlock_irqrestore(&ep->lock, flags);
1108         } else {
1109                 /*
1110                  * Out of range; maybe the shift value is wrong.
1111                  * Reset it so that we autodetect again the next time.
1112                  */
1113                 ep->freqshift = INT_MIN;
1114         }
1115 }
1116