ALSA: usb-audio: set the interface format after resume on Dell WD19
[muen/linux.git] / sound / usb / pcm.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  */
4
5 #include <linux/init.h>
6 #include <linux/slab.h>
7 #include <linux/bitrev.h>
8 #include <linux/ratelimit.h>
9 #include <linux/usb.h>
10 #include <linux/usb/audio.h>
11 #include <linux/usb/audio-v2.h>
12
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/pcm_params.h>
16
17 #include "usbaudio.h"
18 #include "card.h"
19 #include "quirks.h"
20 #include "debug.h"
21 #include "endpoint.h"
22 #include "helper.h"
23 #include "pcm.h"
24 #include "clock.h"
25 #include "power.h"
26 #include "media.h"
27
28 #define SUBSTREAM_FLAG_DATA_EP_STARTED  0
29 #define SUBSTREAM_FLAG_SYNC_EP_STARTED  1
30
31 /* return the estimated delay based on USB frame counters */
32 snd_pcm_uframes_t snd_usb_pcm_delay(struct snd_usb_substream *subs,
33                                     unsigned int rate)
34 {
35         int current_frame_number;
36         int frame_diff;
37         int est_delay;
38
39         if (!subs->last_delay)
40                 return 0; /* short path */
41
42         current_frame_number = usb_get_current_frame_number(subs->dev);
43         /*
44          * HCD implementations use different widths, use lower 8 bits.
45          * The delay will be managed up to 256ms, which is more than
46          * enough
47          */
48         frame_diff = (current_frame_number - subs->last_frame_number) & 0xff;
49
50         /* Approximation based on number of samples per USB frame (ms),
51            some truncation for 44.1 but the estimate is good enough */
52         est_delay =  frame_diff * rate / 1000;
53         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
54                 est_delay = subs->last_delay - est_delay;
55         else
56                 est_delay = subs->last_delay + est_delay;
57
58         if (est_delay < 0)
59                 est_delay = 0;
60         return est_delay;
61 }
62
63 /*
64  * return the current pcm pointer.  just based on the hwptr_done value.
65  */
66 static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
67 {
68         struct snd_usb_substream *subs = substream->runtime->private_data;
69         unsigned int hwptr_done;
70
71         if (atomic_read(&subs->stream->chip->shutdown))
72                 return SNDRV_PCM_POS_XRUN;
73         spin_lock(&subs->lock);
74         hwptr_done = subs->hwptr_done;
75         substream->runtime->delay = snd_usb_pcm_delay(subs,
76                                                 substream->runtime->rate);
77         spin_unlock(&subs->lock);
78         return hwptr_done / (substream->runtime->frame_bits >> 3);
79 }
80
81 /*
82  * find a matching audio format
83  */
84 static struct audioformat *find_format(struct snd_usb_substream *subs)
85 {
86         struct audioformat *fp;
87         struct audioformat *found = NULL;
88         int cur_attr = 0, attr;
89
90         list_for_each_entry(fp, &subs->fmt_list, list) {
91                 if (!(fp->formats & pcm_format_to_bits(subs->pcm_format)))
92                         continue;
93                 if (fp->channels != subs->channels)
94                         continue;
95                 if (subs->cur_rate < fp->rate_min ||
96                     subs->cur_rate > fp->rate_max)
97                         continue;
98                 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
99                         unsigned int i;
100                         for (i = 0; i < fp->nr_rates; i++)
101                                 if (fp->rate_table[i] == subs->cur_rate)
102                                         break;
103                         if (i >= fp->nr_rates)
104                                 continue;
105                 }
106                 attr = fp->ep_attr & USB_ENDPOINT_SYNCTYPE;
107                 if (! found) {
108                         found = fp;
109                         cur_attr = attr;
110                         continue;
111                 }
112                 /* avoid async out and adaptive in if the other method
113                  * supports the same format.
114                  * this is a workaround for the case like
115                  * M-audio audiophile USB.
116                  */
117                 if (attr != cur_attr) {
118                         if ((attr == USB_ENDPOINT_SYNC_ASYNC &&
119                              subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
120                             (attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
121                              subs->direction == SNDRV_PCM_STREAM_CAPTURE))
122                                 continue;
123                         if ((cur_attr == USB_ENDPOINT_SYNC_ASYNC &&
124                              subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
125                             (cur_attr == USB_ENDPOINT_SYNC_ADAPTIVE &&
126                              subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
127                                 found = fp;
128                                 cur_attr = attr;
129                                 continue;
130                         }
131                 }
132                 /* find the format with the largest max. packet size */
133                 if (fp->maxpacksize > found->maxpacksize) {
134                         found = fp;
135                         cur_attr = attr;
136                 }
137         }
138         return found;
139 }
140
141 static int init_pitch_v1(struct snd_usb_audio *chip, int iface,
142                          struct usb_host_interface *alts,
143                          struct audioformat *fmt)
144 {
145         struct usb_device *dev = chip->dev;
146         unsigned int ep;
147         unsigned char data[1];
148         int err;
149
150         if (get_iface_desc(alts)->bNumEndpoints < 1)
151                 return -EINVAL;
152         ep = get_endpoint(alts, 0)->bEndpointAddress;
153
154         data[0] = 1;
155         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
156                               USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
157                               UAC_EP_CS_ATTR_PITCH_CONTROL << 8, ep,
158                               data, sizeof(data));
159         if (err < 0) {
160                 usb_audio_err(chip, "%d:%d: cannot set enable PITCH\n",
161                               iface, ep);
162                 return err;
163         }
164
165         return 0;
166 }
167
168 static int init_pitch_v2(struct snd_usb_audio *chip, int iface,
169                          struct usb_host_interface *alts,
170                          struct audioformat *fmt)
171 {
172         struct usb_device *dev = chip->dev;
173         unsigned char data[1];
174         int err;
175
176         data[0] = 1;
177         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
178                               USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
179                               UAC2_EP_CS_PITCH << 8, 0,
180                               data, sizeof(data));
181         if (err < 0) {
182                 usb_audio_err(chip, "%d:%d: cannot set enable PITCH (v2)\n",
183                               iface, fmt->altsetting);
184                 return err;
185         }
186
187         return 0;
188 }
189
190 /*
191  * initialize the pitch control and sample rate
192  */
193 int snd_usb_init_pitch(struct snd_usb_audio *chip, int iface,
194                        struct usb_host_interface *alts,
195                        struct audioformat *fmt)
196 {
197         /* if endpoint doesn't have pitch control, bail out */
198         if (!(fmt->attributes & UAC_EP_CS_ATTR_PITCH_CONTROL))
199                 return 0;
200
201         switch (fmt->protocol) {
202         case UAC_VERSION_1:
203         default:
204                 return init_pitch_v1(chip, iface, alts, fmt);
205
206         case UAC_VERSION_2:
207                 return init_pitch_v2(chip, iface, alts, fmt);
208         }
209 }
210
211 static int start_endpoints(struct snd_usb_substream *subs)
212 {
213         int err;
214
215         if (!subs->data_endpoint)
216                 return -EINVAL;
217
218         if (!test_and_set_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags)) {
219                 struct snd_usb_endpoint *ep = subs->data_endpoint;
220
221                 dev_dbg(&subs->dev->dev, "Starting data EP @%p\n", ep);
222
223                 ep->data_subs = subs;
224                 err = snd_usb_endpoint_start(ep);
225                 if (err < 0) {
226                         clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags);
227                         return err;
228                 }
229         }
230
231         if (subs->sync_endpoint &&
232             !test_and_set_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags)) {
233                 struct snd_usb_endpoint *ep = subs->sync_endpoint;
234
235                 if (subs->data_endpoint->iface != subs->sync_endpoint->iface ||
236                     subs->data_endpoint->altsetting != subs->sync_endpoint->altsetting) {
237                         err = usb_set_interface(subs->dev,
238                                                 subs->sync_endpoint->iface,
239                                                 subs->sync_endpoint->altsetting);
240                         if (err < 0) {
241                                 clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
242                                 dev_err(&subs->dev->dev,
243                                            "%d:%d: cannot set interface (%d)\n",
244                                            subs->sync_endpoint->iface,
245                                            subs->sync_endpoint->altsetting, err);
246                                 return -EIO;
247                         }
248                 }
249
250                 dev_dbg(&subs->dev->dev, "Starting sync EP @%p\n", ep);
251
252                 ep->sync_slave = subs->data_endpoint;
253                 err = snd_usb_endpoint_start(ep);
254                 if (err < 0) {
255                         clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags);
256                         return err;
257                 }
258         }
259
260         return 0;
261 }
262
263 static void stop_endpoints(struct snd_usb_substream *subs, bool wait)
264 {
265         if (test_and_clear_bit(SUBSTREAM_FLAG_SYNC_EP_STARTED, &subs->flags))
266                 snd_usb_endpoint_stop(subs->sync_endpoint);
267
268         if (test_and_clear_bit(SUBSTREAM_FLAG_DATA_EP_STARTED, &subs->flags))
269                 snd_usb_endpoint_stop(subs->data_endpoint);
270
271         if (wait) {
272                 snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
273                 snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
274         }
275 }
276
277 static int search_roland_implicit_fb(struct usb_device *dev, int ifnum,
278                                      unsigned int altsetting,
279                                      struct usb_host_interface **alts,
280                                      unsigned int *ep)
281 {
282         struct usb_interface *iface;
283         struct usb_interface_descriptor *altsd;
284         struct usb_endpoint_descriptor *epd;
285
286         iface = usb_ifnum_to_if(dev, ifnum);
287         if (!iface || iface->num_altsetting < altsetting + 1)
288                 return -ENOENT;
289         *alts = &iface->altsetting[altsetting];
290         altsd = get_iface_desc(*alts);
291         if (altsd->bAlternateSetting != altsetting ||
292             altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
293             (altsd->bInterfaceSubClass != 2 &&
294              altsd->bInterfaceProtocol != 2   ) ||
295             altsd->bNumEndpoints < 1)
296                 return -ENOENT;
297         epd = get_endpoint(*alts, 0);
298         if (!usb_endpoint_is_isoc_in(epd) ||
299             (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
300                                         USB_ENDPOINT_USAGE_IMPLICIT_FB)
301                 return -ENOENT;
302         *ep = epd->bEndpointAddress;
303         return 0;
304 }
305
306 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk
307  * applies. Returns 1 if a quirk was found.
308  */
309 static int set_sync_ep_implicit_fb_quirk(struct snd_usb_substream *subs,
310                                          struct usb_device *dev,
311                                          struct usb_interface_descriptor *altsd,
312                                          unsigned int attr)
313 {
314         struct usb_host_interface *alts;
315         struct usb_interface *iface;
316         unsigned int ep;
317         unsigned int ifnum;
318
319         /* Implicit feedback sync EPs consumers are always playback EPs */
320         if (subs->direction != SNDRV_PCM_STREAM_PLAYBACK)
321                 return 0;
322
323         switch (subs->stream->chip->usb_id) {
324         case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
325         case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
326                 ep = 0x81;
327                 ifnum = 3;
328                 goto add_sync_ep_from_ifnum;
329         case USB_ID(0x0763, 0x2080): /* M-Audio FastTrack Ultra */
330         case USB_ID(0x0763, 0x2081):
331                 ep = 0x81;
332                 ifnum = 2;
333                 goto add_sync_ep_from_ifnum;
334         case USB_ID(0x2466, 0x8003): /* Fractal Audio Axe-Fx II */
335                 ep = 0x86;
336                 ifnum = 2;
337                 goto add_sync_ep_from_ifnum;
338         case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx III */
339                 ep = 0x81;
340                 ifnum = 2;
341                 goto add_sync_ep_from_ifnum;
342         case USB_ID(0x1397, 0x0001): /* Behringer UFX1604 */
343         case USB_ID(0x1397, 0x0002): /* Behringer UFX1204 */
344                 ep = 0x81;
345                 ifnum = 1;
346                 goto add_sync_ep_from_ifnum;
347         case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
348                 ep = 0x84;
349                 ifnum = 0;
350                 goto add_sync_ep_from_ifnum;
351         case USB_ID(0x0582, 0x01d8): /* BOSS Katana */
352                 /* BOSS Katana amplifiers do not need quirks */
353                 return 0;
354         }
355
356         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
357             altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
358             altsd->bInterfaceProtocol == 2 &&
359             altsd->bNumEndpoints == 1 &&
360             USB_ID_VENDOR(subs->stream->chip->usb_id) == 0x0582 /* Roland */ &&
361             search_roland_implicit_fb(dev, altsd->bInterfaceNumber + 1,
362                                       altsd->bAlternateSetting,
363                                       &alts, &ep) >= 0) {
364                 goto add_sync_ep;
365         }
366
367         /* No quirk */
368         return 0;
369
370 add_sync_ep_from_ifnum:
371         iface = usb_ifnum_to_if(dev, ifnum);
372
373         if (!iface || iface->num_altsetting == 0)
374                 return -EINVAL;
375
376         alts = &iface->altsetting[1];
377
378 add_sync_ep:
379         subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
380                                                    alts, ep, !subs->direction,
381                                                    SND_USB_ENDPOINT_TYPE_DATA);
382         if (!subs->sync_endpoint)
383                 return -EINVAL;
384
385         subs->data_endpoint->sync_master = subs->sync_endpoint;
386
387         return 1;
388 }
389
390 static int set_sync_endpoint(struct snd_usb_substream *subs,
391                              struct audioformat *fmt,
392                              struct usb_device *dev,
393                              struct usb_host_interface *alts,
394                              struct usb_interface_descriptor *altsd)
395 {
396         int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
397         unsigned int ep, attr;
398         bool implicit_fb;
399         int err;
400
401         /* we need a sync pipe in async OUT or adaptive IN mode */
402         /* check the number of EP, since some devices have broken
403          * descriptors which fool us.  if it has only one EP,
404          * assume it as adaptive-out or sync-in.
405          */
406         attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
407
408         if ((is_playback && (attr != USB_ENDPOINT_SYNC_ASYNC)) ||
409                 (!is_playback && (attr != USB_ENDPOINT_SYNC_ADAPTIVE))) {
410
411                 /*
412                  * In these modes the notion of sync_endpoint is irrelevant.
413                  * Reset pointers to avoid using stale data from previously
414                  * used settings, e.g. when configuration and endpoints were
415                  * changed
416                  */
417
418                 subs->sync_endpoint = NULL;
419                 subs->data_endpoint->sync_master = NULL;
420         }
421
422         err = set_sync_ep_implicit_fb_quirk(subs, dev, altsd, attr);
423         if (err < 0)
424                 return err;
425
426         /* endpoint set by quirk */
427         if (err > 0)
428                 return 0;
429
430         if (altsd->bNumEndpoints < 2)
431                 return 0;
432
433         if ((is_playback && (attr == USB_ENDPOINT_SYNC_SYNC ||
434                              attr == USB_ENDPOINT_SYNC_ADAPTIVE)) ||
435             (!is_playback && attr != USB_ENDPOINT_SYNC_ADAPTIVE))
436                 return 0;
437
438         /*
439          * In case of illegal SYNC_NONE for OUT endpoint, we keep going to see
440          * if we don't find a sync endpoint, as on M-Audio Transit. In case of
441          * error fall back to SYNC mode and don't create sync endpoint
442          */
443
444         /* check sync-pipe endpoint */
445         /* ... and check descriptor size before accessing bSynchAddress
446            because there is a version of the SB Audigy 2 NX firmware lacking
447            the audio fields in the endpoint descriptors */
448         if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_ISOC ||
449             (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
450              get_endpoint(alts, 1)->bSynchAddress != 0)) {
451                 dev_err(&dev->dev,
452                         "%d:%d : invalid sync pipe. bmAttributes %02x, bLength %d, bSynchAddress %02x\n",
453                            fmt->iface, fmt->altsetting,
454                            get_endpoint(alts, 1)->bmAttributes,
455                            get_endpoint(alts, 1)->bLength,
456                            get_endpoint(alts, 1)->bSynchAddress);
457                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
458                         return 0;
459                 return -EINVAL;
460         }
461         ep = get_endpoint(alts, 1)->bEndpointAddress;
462         if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
463             get_endpoint(alts, 0)->bSynchAddress != 0 &&
464             ((is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
465              (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
466                 dev_err(&dev->dev,
467                         "%d:%d : invalid sync pipe. is_playback %d, ep %02x, bSynchAddress %02x\n",
468                            fmt->iface, fmt->altsetting,
469                            is_playback, ep, get_endpoint(alts, 0)->bSynchAddress);
470                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
471                         return 0;
472                 return -EINVAL;
473         }
474
475         implicit_fb = (get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_USAGE_MASK)
476                         == USB_ENDPOINT_USAGE_IMPLICIT_FB;
477
478         subs->sync_endpoint = snd_usb_add_endpoint(subs->stream->chip,
479                                                    alts, ep, !subs->direction,
480                                                    implicit_fb ?
481                                                         SND_USB_ENDPOINT_TYPE_DATA :
482                                                         SND_USB_ENDPOINT_TYPE_SYNC);
483         if (!subs->sync_endpoint) {
484                 if (is_playback && attr == USB_ENDPOINT_SYNC_NONE)
485                         return 0;
486                 return -EINVAL;
487         }
488
489         subs->data_endpoint->sync_master = subs->sync_endpoint;
490
491         return 0;
492 }
493
494 /*
495  * find a matching format and set up the interface
496  */
497 static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
498 {
499         struct usb_device *dev = subs->dev;
500         struct usb_host_interface *alts;
501         struct usb_interface_descriptor *altsd;
502         struct usb_interface *iface;
503         int err;
504
505         iface = usb_ifnum_to_if(dev, fmt->iface);
506         if (WARN_ON(!iface))
507                 return -EINVAL;
508         alts = usb_altnum_to_altsetting(iface, fmt->altsetting);
509         altsd = get_iface_desc(alts);
510         if (WARN_ON(altsd->bAlternateSetting != fmt->altsetting))
511                 return -EINVAL;
512
513         if (fmt == subs->cur_audiofmt && !subs->need_setup_fmt)
514                 return 0;
515
516         /* close the old interface */
517         if (subs->interface >= 0 && (subs->interface != fmt->iface || subs->need_setup_fmt)) {
518                 if (!subs->stream->chip->keep_iface) {
519                         err = usb_set_interface(subs->dev, subs->interface, 0);
520                         if (err < 0) {
521                                 dev_err(&dev->dev,
522                                         "%d:%d: return to setting 0 failed (%d)\n",
523                                         fmt->iface, fmt->altsetting, err);
524                                 return -EIO;
525                         }
526                 }
527                 subs->interface = -1;
528                 subs->altset_idx = 0;
529         }
530
531         if (subs->need_setup_fmt)
532                 subs->need_setup_fmt = false;
533
534         /* set interface */
535         if (iface->cur_altsetting != alts) {
536                 err = snd_usb_select_mode_quirk(subs, fmt);
537                 if (err < 0)
538                         return -EIO;
539
540                 err = usb_set_interface(dev, fmt->iface, fmt->altsetting);
541                 if (err < 0) {
542                         dev_err(&dev->dev,
543                                 "%d:%d: usb_set_interface failed (%d)\n",
544                                 fmt->iface, fmt->altsetting, err);
545                         return -EIO;
546                 }
547                 dev_dbg(&dev->dev, "setting usb interface %d:%d\n",
548                         fmt->iface, fmt->altsetting);
549                 snd_usb_set_interface_quirk(dev);
550         }
551
552         subs->interface = fmt->iface;
553         subs->altset_idx = fmt->altset_idx;
554         subs->data_endpoint = snd_usb_add_endpoint(subs->stream->chip,
555                                                    alts, fmt->endpoint, subs->direction,
556                                                    SND_USB_ENDPOINT_TYPE_DATA);
557
558         if (!subs->data_endpoint)
559                 return -EINVAL;
560
561         err = set_sync_endpoint(subs, fmt, dev, alts, altsd);
562         if (err < 0)
563                 return err;
564
565         err = snd_usb_init_pitch(subs->stream->chip, fmt->iface, alts, fmt);
566         if (err < 0)
567                 return err;
568
569         subs->cur_audiofmt = fmt;
570
571         snd_usb_set_format_quirk(subs, fmt);
572
573         return 0;
574 }
575
576 /*
577  * Return the score of matching two audioformats.
578  * Veto the audioformat if:
579  * - It has no channels for some reason.
580  * - Requested PCM format is not supported.
581  * - Requested sample rate is not supported.
582  */
583 static int match_endpoint_audioformats(struct snd_usb_substream *subs,
584                                        struct audioformat *fp,
585                                        struct audioformat *match, int rate,
586                                        snd_pcm_format_t pcm_format)
587 {
588         int i;
589         int score = 0;
590
591         if (fp->channels < 1) {
592                 dev_dbg(&subs->dev->dev,
593                         "%s: (fmt @%p) no channels\n", __func__, fp);
594                 return 0;
595         }
596
597         if (!(fp->formats & pcm_format_to_bits(pcm_format))) {
598                 dev_dbg(&subs->dev->dev,
599                         "%s: (fmt @%p) no match for format %d\n", __func__,
600                         fp, pcm_format);
601                 return 0;
602         }
603
604         for (i = 0; i < fp->nr_rates; i++) {
605                 if (fp->rate_table[i] == rate) {
606                         score++;
607                         break;
608                 }
609         }
610         if (!score) {
611                 dev_dbg(&subs->dev->dev,
612                         "%s: (fmt @%p) no match for rate %d\n", __func__,
613                         fp, rate);
614                 return 0;
615         }
616
617         if (fp->channels == match->channels)
618                 score++;
619
620         dev_dbg(&subs->dev->dev,
621                 "%s: (fmt @%p) score %d\n", __func__, fp, score);
622
623         return score;
624 }
625
626 /*
627  * Configure the sync ep using the rate and pcm format of the data ep.
628  */
629 static int configure_sync_endpoint(struct snd_usb_substream *subs)
630 {
631         int ret;
632         struct audioformat *fp;
633         struct audioformat *sync_fp = NULL;
634         int cur_score = 0;
635         int sync_period_bytes = subs->period_bytes;
636         struct snd_usb_substream *sync_subs =
637                 &subs->stream->substream[subs->direction ^ 1];
638
639         if (subs->sync_endpoint->type != SND_USB_ENDPOINT_TYPE_DATA ||
640             !subs->stream)
641                 return snd_usb_endpoint_set_params(subs->sync_endpoint,
642                                                    subs->pcm_format,
643                                                    subs->channels,
644                                                    subs->period_bytes,
645                                                    0, 0,
646                                                    subs->cur_rate,
647                                                    subs->cur_audiofmt,
648                                                    NULL);
649
650         /* Try to find the best matching audioformat. */
651         list_for_each_entry(fp, &sync_subs->fmt_list, list) {
652                 int score = match_endpoint_audioformats(subs,
653                                                         fp, subs->cur_audiofmt,
654                         subs->cur_rate, subs->pcm_format);
655
656                 if (score > cur_score) {
657                         sync_fp = fp;
658                         cur_score = score;
659                 }
660         }
661
662         if (unlikely(sync_fp == NULL)) {
663                 dev_err(&subs->dev->dev,
664                         "%s: no valid audioformat for sync ep %x found\n",
665                         __func__, sync_subs->ep_num);
666                 return -EINVAL;
667         }
668
669         /*
670          * Recalculate the period bytes if channel number differ between
671          * data and sync ep audioformat.
672          */
673         if (sync_fp->channels != subs->channels) {
674                 sync_period_bytes = (subs->period_bytes / subs->channels) *
675                         sync_fp->channels;
676                 dev_dbg(&subs->dev->dev,
677                         "%s: adjusted sync ep period bytes (%d -> %d)\n",
678                         __func__, subs->period_bytes, sync_period_bytes);
679         }
680
681         ret = snd_usb_endpoint_set_params(subs->sync_endpoint,
682                                           subs->pcm_format,
683                                           sync_fp->channels,
684                                           sync_period_bytes,
685                                           0, 0,
686                                           subs->cur_rate,
687                                           sync_fp,
688                                           NULL);
689
690         return ret;
691 }
692
693 /*
694  * configure endpoint params
695  *
696  * called  during initial setup and upon resume
697  */
698 static int configure_endpoint(struct snd_usb_substream *subs)
699 {
700         int ret;
701
702         /* format changed */
703         stop_endpoints(subs, true);
704         ret = snd_usb_endpoint_set_params(subs->data_endpoint,
705                                           subs->pcm_format,
706                                           subs->channels,
707                                           subs->period_bytes,
708                                           subs->period_frames,
709                                           subs->buffer_periods,
710                                           subs->cur_rate,
711                                           subs->cur_audiofmt,
712                                           subs->sync_endpoint);
713         if (ret < 0)
714                 return ret;
715
716         if (subs->sync_endpoint)
717                 ret = configure_sync_endpoint(subs);
718
719         return ret;
720 }
721
722 static int snd_usb_pcm_change_state(struct snd_usb_substream *subs, int state)
723 {
724         int ret;
725
726         if (!subs->str_pd)
727                 return 0;
728
729         ret = snd_usb_power_domain_set(subs->stream->chip, subs->str_pd, state);
730         if (ret < 0) {
731                 dev_err(&subs->dev->dev,
732                         "Cannot change Power Domain ID: %d to state: %d. Err: %d\n",
733                         subs->str_pd->pd_id, state, ret);
734                 return ret;
735         }
736
737         return 0;
738 }
739
740 int snd_usb_pcm_suspend(struct snd_usb_stream *as)
741 {
742         int ret;
743
744         ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D2);
745         if (ret < 0)
746                 return ret;
747
748         ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D2);
749         if (ret < 0)
750                 return ret;
751
752         return 0;
753 }
754
755 int snd_usb_pcm_resume(struct snd_usb_stream *as)
756 {
757         int ret;
758
759         ret = snd_usb_pcm_change_state(&as->substream[0], UAC3_PD_STATE_D1);
760         if (ret < 0)
761                 return ret;
762
763         ret = snd_usb_pcm_change_state(&as->substream[1], UAC3_PD_STATE_D1);
764         if (ret < 0)
765                 return ret;
766
767         return 0;
768 }
769
770 /*
771  * hw_params callback
772  *
773  * allocate a buffer and set the given audio format.
774  *
775  * so far we use a physically linear buffer although packetize transfer
776  * doesn't need a continuous area.
777  * if sg buffer is supported on the later version of alsa, we'll follow
778  * that.
779  */
780 static int snd_usb_hw_params(struct snd_pcm_substream *substream,
781                              struct snd_pcm_hw_params *hw_params)
782 {
783         struct snd_usb_substream *subs = substream->runtime->private_data;
784         struct audioformat *fmt;
785         int ret;
786
787         ret = snd_media_start_pipeline(subs);
788         if (ret)
789                 return ret;
790
791         ret = snd_pcm_lib_malloc_pages(substream,
792                                        params_buffer_bytes(hw_params));
793         if (ret < 0)
794                 goto stop_pipeline;
795
796         subs->pcm_format = params_format(hw_params);
797         subs->period_bytes = params_period_bytes(hw_params);
798         subs->period_frames = params_period_size(hw_params);
799         subs->buffer_periods = params_periods(hw_params);
800         subs->channels = params_channels(hw_params);
801         subs->cur_rate = params_rate(hw_params);
802
803         fmt = find_format(subs);
804         if (!fmt) {
805                 dev_dbg(&subs->dev->dev,
806                         "cannot set format: format = %#x, rate = %d, channels = %d\n",
807                            subs->pcm_format, subs->cur_rate, subs->channels);
808                 ret = -EINVAL;
809                 goto stop_pipeline;
810         }
811
812         ret = snd_usb_lock_shutdown(subs->stream->chip);
813         if (ret < 0)
814                 goto stop_pipeline;
815
816         ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
817         if (ret < 0)
818                 goto unlock;
819
820         ret = set_format(subs, fmt);
821         if (ret < 0)
822                 goto unlock;
823
824         subs->interface = fmt->iface;
825         subs->altset_idx = fmt->altset_idx;
826         subs->need_setup_ep = true;
827
828  unlock:
829         snd_usb_unlock_shutdown(subs->stream->chip);
830         if (ret < 0)
831                 goto stop_pipeline;
832         return ret;
833
834  stop_pipeline:
835         snd_media_stop_pipeline(subs);
836         return ret;
837 }
838
839 /*
840  * hw_free callback
841  *
842  * reset the audio format and release the buffer
843  */
844 static int snd_usb_hw_free(struct snd_pcm_substream *substream)
845 {
846         struct snd_usb_substream *subs = substream->runtime->private_data;
847
848         snd_media_stop_pipeline(subs);
849         subs->cur_audiofmt = NULL;
850         subs->cur_rate = 0;
851         subs->period_bytes = 0;
852         if (!snd_usb_lock_shutdown(subs->stream->chip)) {
853                 stop_endpoints(subs, true);
854                 snd_usb_endpoint_deactivate(subs->sync_endpoint);
855                 snd_usb_endpoint_deactivate(subs->data_endpoint);
856                 snd_usb_unlock_shutdown(subs->stream->chip);
857         }
858
859         return snd_pcm_lib_free_pages(substream);
860 }
861
862 /*
863  * prepare callback
864  *
865  * only a few subtle things...
866  */
867 static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
868 {
869         struct snd_pcm_runtime *runtime = substream->runtime;
870         struct snd_usb_substream *subs = runtime->private_data;
871         struct usb_host_interface *alts;
872         struct usb_interface *iface;
873         int ret;
874
875         if (! subs->cur_audiofmt) {
876                 dev_err(&subs->dev->dev, "no format is specified!\n");
877                 return -ENXIO;
878         }
879
880         ret = snd_usb_lock_shutdown(subs->stream->chip);
881         if (ret < 0)
882                 return ret;
883         if (snd_BUG_ON(!subs->data_endpoint)) {
884                 ret = -EIO;
885                 goto unlock;
886         }
887
888         snd_usb_endpoint_sync_pending_stop(subs->sync_endpoint);
889         snd_usb_endpoint_sync_pending_stop(subs->data_endpoint);
890
891         ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D0);
892         if (ret < 0)
893                 goto unlock;
894
895         ret = set_format(subs, subs->cur_audiofmt);
896         if (ret < 0)
897                 goto unlock;
898
899         if (subs->need_setup_ep) {
900
901                 iface = usb_ifnum_to_if(subs->dev, subs->cur_audiofmt->iface);
902                 alts = &iface->altsetting[subs->cur_audiofmt->altset_idx];
903                 ret = snd_usb_init_sample_rate(subs->stream->chip,
904                                                subs->cur_audiofmt->iface,
905                                                alts,
906                                                subs->cur_audiofmt,
907                                                subs->cur_rate);
908                 if (ret < 0)
909                         goto unlock;
910
911                 ret = configure_endpoint(subs);
912                 if (ret < 0)
913                         goto unlock;
914                 subs->need_setup_ep = false;
915         }
916
917         /* some unit conversions in runtime */
918         subs->data_endpoint->maxframesize =
919                 bytes_to_frames(runtime, subs->data_endpoint->maxpacksize);
920         subs->data_endpoint->curframesize =
921                 bytes_to_frames(runtime, subs->data_endpoint->curpacksize);
922
923         /* reset the pointer */
924         subs->hwptr_done = 0;
925         subs->transfer_done = 0;
926         subs->last_delay = 0;
927         subs->last_frame_number = 0;
928         runtime->delay = 0;
929
930         /* for playback, submit the URBs now; otherwise, the first hwptr_done
931          * updates for all URBs would happen at the same time when starting */
932         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK)
933                 ret = start_endpoints(subs);
934
935  unlock:
936         snd_usb_unlock_shutdown(subs->stream->chip);
937         return ret;
938 }
939
940 static const struct snd_pcm_hardware snd_usb_hardware =
941 {
942         .info =                 SNDRV_PCM_INFO_MMAP |
943                                 SNDRV_PCM_INFO_MMAP_VALID |
944                                 SNDRV_PCM_INFO_BATCH |
945                                 SNDRV_PCM_INFO_INTERLEAVED |
946                                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
947                                 SNDRV_PCM_INFO_PAUSE,
948         .buffer_bytes_max =     1024 * 1024,
949         .period_bytes_min =     64,
950         .period_bytes_max =     512 * 1024,
951         .periods_min =          2,
952         .periods_max =          1024,
953 };
954
955 static int hw_check_valid_format(struct snd_usb_substream *subs,
956                                  struct snd_pcm_hw_params *params,
957                                  struct audioformat *fp)
958 {
959         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
960         struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
961         struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
962         struct snd_interval *pt = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
963         struct snd_mask check_fmts;
964         unsigned int ptime;
965
966         /* check the format */
967         snd_mask_none(&check_fmts);
968         check_fmts.bits[0] = (u32)fp->formats;
969         check_fmts.bits[1] = (u32)(fp->formats >> 32);
970         snd_mask_intersect(&check_fmts, fmts);
971         if (snd_mask_empty(&check_fmts)) {
972                 hwc_debug("   > check: no supported format %d\n", fp->format);
973                 return 0;
974         }
975         /* check the channels */
976         if (fp->channels < ct->min || fp->channels > ct->max) {
977                 hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
978                 return 0;
979         }
980         /* check the rate is within the range */
981         if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
982                 hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
983                 return 0;
984         }
985         if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
986                 hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
987                 return 0;
988         }
989         /* check whether the period time is >= the data packet interval */
990         if (subs->speed != USB_SPEED_FULL) {
991                 ptime = 125 * (1 << fp->datainterval);
992                 if (ptime > pt->max || (ptime == pt->max && pt->openmax)) {
993                         hwc_debug("   > check: ptime %u > max %u\n", ptime, pt->max);
994                         return 0;
995                 }
996         }
997         return 1;
998 }
999
1000 static int hw_rule_rate(struct snd_pcm_hw_params *params,
1001                         struct snd_pcm_hw_rule *rule)
1002 {
1003         struct snd_usb_substream *subs = rule->private;
1004         struct audioformat *fp;
1005         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1006         unsigned int rmin, rmax;
1007         int changed;
1008
1009         hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1010         changed = 0;
1011         rmin = rmax = 0;
1012         list_for_each_entry(fp, &subs->fmt_list, list) {
1013                 if (!hw_check_valid_format(subs, params, fp))
1014                         continue;
1015                 if (changed++) {
1016                         if (rmin > fp->rate_min)
1017                                 rmin = fp->rate_min;
1018                         if (rmax < fp->rate_max)
1019                                 rmax = fp->rate_max;
1020                 } else {
1021                         rmin = fp->rate_min;
1022                         rmax = fp->rate_max;
1023                 }
1024         }
1025
1026         if (!changed) {
1027                 hwc_debug("  --> get empty\n");
1028                 it->empty = 1;
1029                 return -EINVAL;
1030         }
1031
1032         changed = 0;
1033         if (it->min < rmin) {
1034                 it->min = rmin;
1035                 it->openmin = 0;
1036                 changed = 1;
1037         }
1038         if (it->max > rmax) {
1039                 it->max = rmax;
1040                 it->openmax = 0;
1041                 changed = 1;
1042         }
1043         if (snd_interval_checkempty(it)) {
1044                 it->empty = 1;
1045                 return -EINVAL;
1046         }
1047         hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1048         return changed;
1049 }
1050
1051
1052 static int hw_rule_channels(struct snd_pcm_hw_params *params,
1053                             struct snd_pcm_hw_rule *rule)
1054 {
1055         struct snd_usb_substream *subs = rule->private;
1056         struct audioformat *fp;
1057         struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1058         unsigned int rmin, rmax;
1059         int changed;
1060
1061         hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1062         changed = 0;
1063         rmin = rmax = 0;
1064         list_for_each_entry(fp, &subs->fmt_list, list) {
1065                 if (!hw_check_valid_format(subs, params, fp))
1066                         continue;
1067                 if (changed++) {
1068                         if (rmin > fp->channels)
1069                                 rmin = fp->channels;
1070                         if (rmax < fp->channels)
1071                                 rmax = fp->channels;
1072                 } else {
1073                         rmin = fp->channels;
1074                         rmax = fp->channels;
1075                 }
1076         }
1077
1078         if (!changed) {
1079                 hwc_debug("  --> get empty\n");
1080                 it->empty = 1;
1081                 return -EINVAL;
1082         }
1083
1084         changed = 0;
1085         if (it->min < rmin) {
1086                 it->min = rmin;
1087                 it->openmin = 0;
1088                 changed = 1;
1089         }
1090         if (it->max > rmax) {
1091                 it->max = rmax;
1092                 it->openmax = 0;
1093                 changed = 1;
1094         }
1095         if (snd_interval_checkempty(it)) {
1096                 it->empty = 1;
1097                 return -EINVAL;
1098         }
1099         hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1100         return changed;
1101 }
1102
1103 static int hw_rule_format(struct snd_pcm_hw_params *params,
1104                           struct snd_pcm_hw_rule *rule)
1105 {
1106         struct snd_usb_substream *subs = rule->private;
1107         struct audioformat *fp;
1108         struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1109         u64 fbits;
1110         u32 oldbits[2];
1111         int changed;
1112
1113         hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1114         fbits = 0;
1115         list_for_each_entry(fp, &subs->fmt_list, list) {
1116                 if (!hw_check_valid_format(subs, params, fp))
1117                         continue;
1118                 fbits |= fp->formats;
1119         }
1120
1121         oldbits[0] = fmt->bits[0];
1122         oldbits[1] = fmt->bits[1];
1123         fmt->bits[0] &= (u32)fbits;
1124         fmt->bits[1] &= (u32)(fbits >> 32);
1125         if (!fmt->bits[0] && !fmt->bits[1]) {
1126                 hwc_debug("  --> get empty\n");
1127                 return -EINVAL;
1128         }
1129         changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1130         hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1131         return changed;
1132 }
1133
1134 static int hw_rule_period_time(struct snd_pcm_hw_params *params,
1135                                struct snd_pcm_hw_rule *rule)
1136 {
1137         struct snd_usb_substream *subs = rule->private;
1138         struct audioformat *fp;
1139         struct snd_interval *it;
1140         unsigned char min_datainterval;
1141         unsigned int pmin;
1142         int changed;
1143
1144         it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_PERIOD_TIME);
1145         hwc_debug("hw_rule_period_time: (%u,%u)\n", it->min, it->max);
1146         min_datainterval = 0xff;
1147         list_for_each_entry(fp, &subs->fmt_list, list) {
1148                 if (!hw_check_valid_format(subs, params, fp))
1149                         continue;
1150                 min_datainterval = min(min_datainterval, fp->datainterval);
1151         }
1152         if (min_datainterval == 0xff) {
1153                 hwc_debug("  --> get empty\n");
1154                 it->empty = 1;
1155                 return -EINVAL;
1156         }
1157         pmin = 125 * (1 << min_datainterval);
1158         changed = 0;
1159         if (it->min < pmin) {
1160                 it->min = pmin;
1161                 it->openmin = 0;
1162                 changed = 1;
1163         }
1164         if (snd_interval_checkempty(it)) {
1165                 it->empty = 1;
1166                 return -EINVAL;
1167         }
1168         hwc_debug("  --> (%u,%u) (changed = %d)\n", it->min, it->max, changed);
1169         return changed;
1170 }
1171
1172 /*
1173  *  If the device supports unusual bit rates, does the request meet these?
1174  */
1175 static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1176                                   struct snd_usb_substream *subs)
1177 {
1178         struct audioformat *fp;
1179         int *rate_list;
1180         int count = 0, needs_knot = 0;
1181         int err;
1182
1183         kfree(subs->rate_list.list);
1184         subs->rate_list.list = NULL;
1185
1186         list_for_each_entry(fp, &subs->fmt_list, list) {
1187                 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1188                         return 0;
1189                 count += fp->nr_rates;
1190                 if (fp->rates & SNDRV_PCM_RATE_KNOT)
1191                         needs_knot = 1;
1192         }
1193         if (!needs_knot)
1194                 return 0;
1195
1196         subs->rate_list.list = rate_list =
1197                 kmalloc_array(count, sizeof(int), GFP_KERNEL);
1198         if (!subs->rate_list.list)
1199                 return -ENOMEM;
1200         subs->rate_list.count = count;
1201         subs->rate_list.mask = 0;
1202         count = 0;
1203         list_for_each_entry(fp, &subs->fmt_list, list) {
1204                 int i;
1205                 for (i = 0; i < fp->nr_rates; i++)
1206                         rate_list[count++] = fp->rate_table[i];
1207         }
1208         err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1209                                          &subs->rate_list);
1210         if (err < 0)
1211                 return err;
1212
1213         return 0;
1214 }
1215
1216
1217 /*
1218  * set up the runtime hardware information.
1219  */
1220
1221 static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1222 {
1223         struct audioformat *fp;
1224         unsigned int pt, ptmin;
1225         int param_period_time_if_needed;
1226         int err;
1227
1228         runtime->hw.formats = subs->formats;
1229
1230         runtime->hw.rate_min = 0x7fffffff;
1231         runtime->hw.rate_max = 0;
1232         runtime->hw.channels_min = 256;
1233         runtime->hw.channels_max = 0;
1234         runtime->hw.rates = 0;
1235         ptmin = UINT_MAX;
1236         /* check min/max rates and channels */
1237         list_for_each_entry(fp, &subs->fmt_list, list) {
1238                 runtime->hw.rates |= fp->rates;
1239                 if (runtime->hw.rate_min > fp->rate_min)
1240                         runtime->hw.rate_min = fp->rate_min;
1241                 if (runtime->hw.rate_max < fp->rate_max)
1242                         runtime->hw.rate_max = fp->rate_max;
1243                 if (runtime->hw.channels_min > fp->channels)
1244                         runtime->hw.channels_min = fp->channels;
1245                 if (runtime->hw.channels_max < fp->channels)
1246                         runtime->hw.channels_max = fp->channels;
1247                 if (fp->fmt_type == UAC_FORMAT_TYPE_II && fp->frame_size > 0) {
1248                         /* FIXME: there might be more than one audio formats... */
1249                         runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1250                                 fp->frame_size;
1251                 }
1252                 pt = 125 * (1 << fp->datainterval);
1253                 ptmin = min(ptmin, pt);
1254         }
1255
1256         param_period_time_if_needed = SNDRV_PCM_HW_PARAM_PERIOD_TIME;
1257         if (subs->speed == USB_SPEED_FULL)
1258                 /* full speed devices have fixed data packet interval */
1259                 ptmin = 1000;
1260         if (ptmin == 1000)
1261                 /* if period time doesn't go below 1 ms, no rules needed */
1262                 param_period_time_if_needed = -1;
1263
1264         err = snd_pcm_hw_constraint_minmax(runtime,
1265                                            SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1266                                            ptmin, UINT_MAX);
1267         if (err < 0)
1268                 return err;
1269
1270         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1271                                   hw_rule_rate, subs,
1272                                   SNDRV_PCM_HW_PARAM_FORMAT,
1273                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1274                                   param_period_time_if_needed,
1275                                   -1);
1276         if (err < 0)
1277                 return err;
1278         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1279                                   hw_rule_channels, subs,
1280                                   SNDRV_PCM_HW_PARAM_FORMAT,
1281                                   SNDRV_PCM_HW_PARAM_RATE,
1282                                   param_period_time_if_needed,
1283                                   -1);
1284         if (err < 0)
1285                 return err;
1286         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1287                                   hw_rule_format, subs,
1288                                   SNDRV_PCM_HW_PARAM_RATE,
1289                                   SNDRV_PCM_HW_PARAM_CHANNELS,
1290                                   param_period_time_if_needed,
1291                                   -1);
1292         if (err < 0)
1293                 return err;
1294         if (param_period_time_if_needed >= 0) {
1295                 err = snd_pcm_hw_rule_add(runtime, 0,
1296                                           SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1297                                           hw_rule_period_time, subs,
1298                                           SNDRV_PCM_HW_PARAM_FORMAT,
1299                                           SNDRV_PCM_HW_PARAM_CHANNELS,
1300                                           SNDRV_PCM_HW_PARAM_RATE,
1301                                           -1);
1302                 if (err < 0)
1303                         return err;
1304         }
1305         err = snd_usb_pcm_check_knot(runtime, subs);
1306         if (err < 0)
1307                 return err;
1308
1309         return snd_usb_autoresume(subs->stream->chip);
1310 }
1311
1312 static int snd_usb_pcm_open(struct snd_pcm_substream *substream)
1313 {
1314         int direction = substream->stream;
1315         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1316         struct snd_pcm_runtime *runtime = substream->runtime;
1317         struct snd_usb_substream *subs = &as->substream[direction];
1318         int ret;
1319
1320         subs->interface = -1;
1321         subs->altset_idx = 0;
1322         runtime->hw = snd_usb_hardware;
1323         runtime->private_data = subs;
1324         subs->pcm_substream = substream;
1325         /* runtime PM is also done there */
1326
1327         /* initialize DSD/DOP context */
1328         subs->dsd_dop.byte_idx = 0;
1329         subs->dsd_dop.channel = 0;
1330         subs->dsd_dop.marker = 1;
1331
1332         ret = setup_hw_info(runtime, subs);
1333         if (ret == 0) {
1334                 ret = snd_media_stream_init(subs, as->pcm, direction);
1335                 if (ret)
1336                         snd_usb_autosuspend(subs->stream->chip);
1337         }
1338         return ret;
1339 }
1340
1341 static int snd_usb_pcm_close(struct snd_pcm_substream *substream)
1342 {
1343         int direction = substream->stream;
1344         struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1345         struct snd_usb_substream *subs = &as->substream[direction];
1346         int ret;
1347
1348         stop_endpoints(subs, true);
1349         snd_media_stop_pipeline(subs);
1350
1351         if (!as->chip->keep_iface &&
1352             subs->interface >= 0 &&
1353             !snd_usb_lock_shutdown(subs->stream->chip)) {
1354                 usb_set_interface(subs->dev, subs->interface, 0);
1355                 subs->interface = -1;
1356                 ret = snd_usb_pcm_change_state(subs, UAC3_PD_STATE_D1);
1357                 snd_usb_unlock_shutdown(subs->stream->chip);
1358                 if (ret < 0)
1359                         return ret;
1360         }
1361
1362         subs->pcm_substream = NULL;
1363         snd_usb_autosuspend(subs->stream->chip);
1364
1365         return 0;
1366 }
1367
1368 /* Since a URB can handle only a single linear buffer, we must use double
1369  * buffering when the data to be transferred overflows the buffer boundary.
1370  * To avoid inconsistencies when updating hwptr_done, we use double buffering
1371  * for all URBs.
1372  */
1373 static void retire_capture_urb(struct snd_usb_substream *subs,
1374                                struct urb *urb)
1375 {
1376         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1377         unsigned int stride, frames, bytes, oldptr;
1378         int i, period_elapsed = 0;
1379         unsigned long flags;
1380         unsigned char *cp;
1381         int current_frame_number;
1382
1383         /* read frame number here, update pointer in critical section */
1384         current_frame_number = usb_get_current_frame_number(subs->dev);
1385
1386         stride = runtime->frame_bits >> 3;
1387
1388         for (i = 0; i < urb->number_of_packets; i++) {
1389                 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset + subs->pkt_offset_adj;
1390                 if (urb->iso_frame_desc[i].status && printk_ratelimit()) {
1391                         dev_dbg(&subs->dev->dev, "frame %d active: %d\n",
1392                                 i, urb->iso_frame_desc[i].status);
1393                         // continue;
1394                 }
1395                 bytes = urb->iso_frame_desc[i].actual_length;
1396                 frames = bytes / stride;
1397                 if (!subs->txfr_quirk)
1398                         bytes = frames * stride;
1399                 if (bytes % (runtime->sample_bits >> 3) != 0) {
1400                         int oldbytes = bytes;
1401                         bytes = frames * stride;
1402                         dev_warn_ratelimited(&subs->dev->dev,
1403                                  "Corrected urb data len. %d->%d\n",
1404                                                         oldbytes, bytes);
1405                 }
1406                 /* update the current pointer */
1407                 spin_lock_irqsave(&subs->lock, flags);
1408                 oldptr = subs->hwptr_done;
1409                 subs->hwptr_done += bytes;
1410                 if (subs->hwptr_done >= runtime->buffer_size * stride)
1411                         subs->hwptr_done -= runtime->buffer_size * stride;
1412                 frames = (bytes + (oldptr % stride)) / stride;
1413                 subs->transfer_done += frames;
1414                 if (subs->transfer_done >= runtime->period_size) {
1415                         subs->transfer_done -= runtime->period_size;
1416                         period_elapsed = 1;
1417                 }
1418                 /* capture delay is by construction limited to one URB,
1419                  * reset delays here
1420                  */
1421                 runtime->delay = subs->last_delay = 0;
1422
1423                 /* realign last_frame_number */
1424                 subs->last_frame_number = current_frame_number;
1425                 subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1426
1427                 spin_unlock_irqrestore(&subs->lock, flags);
1428                 /* copy a data chunk */
1429                 if (oldptr + bytes > runtime->buffer_size * stride) {
1430                         unsigned int bytes1 =
1431                                         runtime->buffer_size * stride - oldptr;
1432                         memcpy(runtime->dma_area + oldptr, cp, bytes1);
1433                         memcpy(runtime->dma_area, cp + bytes1, bytes - bytes1);
1434                 } else {
1435                         memcpy(runtime->dma_area + oldptr, cp, bytes);
1436                 }
1437         }
1438
1439         if (period_elapsed)
1440                 snd_pcm_period_elapsed(subs->pcm_substream);
1441 }
1442
1443 static inline void fill_playback_urb_dsd_dop(struct snd_usb_substream *subs,
1444                                              struct urb *urb, unsigned int bytes)
1445 {
1446         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1447         unsigned int stride = runtime->frame_bits >> 3;
1448         unsigned int dst_idx = 0;
1449         unsigned int src_idx = subs->hwptr_done;
1450         unsigned int wrap = runtime->buffer_size * stride;
1451         u8 *dst = urb->transfer_buffer;
1452         u8 *src = runtime->dma_area;
1453         u8 marker[] = { 0x05, 0xfa };
1454
1455         /*
1456          * The DSP DOP format defines a way to transport DSD samples over
1457          * normal PCM data endpoints. It requires stuffing of marker bytes
1458          * (0x05 and 0xfa, alternating per sample frame), and then expects
1459          * 2 additional bytes of actual payload. The whole frame is stored
1460          * LSB.
1461          *
1462          * Hence, for a stereo transport, the buffer layout looks like this,
1463          * where L refers to left channel samples and R to right.
1464          *
1465          *   L1 L2 0x05   R1 R2 0x05   L3 L4 0xfa  R3 R4 0xfa
1466          *   L5 L6 0x05   R5 R6 0x05   L7 L8 0xfa  R7 R8 0xfa
1467          *   .....
1468          *
1469          */
1470
1471         while (bytes--) {
1472                 if (++subs->dsd_dop.byte_idx == 3) {
1473                         /* frame boundary? */
1474                         dst[dst_idx++] = marker[subs->dsd_dop.marker];
1475                         src_idx += 2;
1476                         subs->dsd_dop.byte_idx = 0;
1477
1478                         if (++subs->dsd_dop.channel % runtime->channels == 0) {
1479                                 /* alternate the marker */
1480                                 subs->dsd_dop.marker++;
1481                                 subs->dsd_dop.marker %= ARRAY_SIZE(marker);
1482                                 subs->dsd_dop.channel = 0;
1483                         }
1484                 } else {
1485                         /* stuff the DSD payload */
1486                         int idx = (src_idx + subs->dsd_dop.byte_idx - 1) % wrap;
1487
1488                         if (subs->cur_audiofmt->dsd_bitrev)
1489                                 dst[dst_idx++] = bitrev8(src[idx]);
1490                         else
1491                                 dst[dst_idx++] = src[idx];
1492
1493                         subs->hwptr_done++;
1494                 }
1495         }
1496         if (subs->hwptr_done >= runtime->buffer_size * stride)
1497                 subs->hwptr_done -= runtime->buffer_size * stride;
1498 }
1499
1500 static void copy_to_urb(struct snd_usb_substream *subs, struct urb *urb,
1501                         int offset, int stride, unsigned int bytes)
1502 {
1503         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1504
1505         if (subs->hwptr_done + bytes > runtime->buffer_size * stride) {
1506                 /* err, the transferred area goes over buffer boundary. */
1507                 unsigned int bytes1 =
1508                         runtime->buffer_size * stride - subs->hwptr_done;
1509                 memcpy(urb->transfer_buffer + offset,
1510                        runtime->dma_area + subs->hwptr_done, bytes1);
1511                 memcpy(urb->transfer_buffer + offset + bytes1,
1512                        runtime->dma_area, bytes - bytes1);
1513         } else {
1514                 memcpy(urb->transfer_buffer + offset,
1515                        runtime->dma_area + subs->hwptr_done, bytes);
1516         }
1517         subs->hwptr_done += bytes;
1518         if (subs->hwptr_done >= runtime->buffer_size * stride)
1519                 subs->hwptr_done -= runtime->buffer_size * stride;
1520 }
1521
1522 static unsigned int copy_to_urb_quirk(struct snd_usb_substream *subs,
1523                                       struct urb *urb, int stride,
1524                                       unsigned int bytes)
1525 {
1526         __le32 packet_length;
1527         int i;
1528
1529         /* Put __le32 length descriptor at start of each packet. */
1530         for (i = 0; i < urb->number_of_packets; i++) {
1531                 unsigned int length = urb->iso_frame_desc[i].length;
1532                 unsigned int offset = urb->iso_frame_desc[i].offset;
1533
1534                 packet_length = cpu_to_le32(length);
1535                 offset += i * sizeof(packet_length);
1536                 urb->iso_frame_desc[i].offset = offset;
1537                 urb->iso_frame_desc[i].length += sizeof(packet_length);
1538                 memcpy(urb->transfer_buffer + offset,
1539                        &packet_length, sizeof(packet_length));
1540                 copy_to_urb(subs, urb, offset + sizeof(packet_length),
1541                             stride, length);
1542         }
1543         /* Adjust transfer size accordingly. */
1544         bytes += urb->number_of_packets * sizeof(packet_length);
1545         return bytes;
1546 }
1547
1548 static void prepare_playback_urb(struct snd_usb_substream *subs,
1549                                  struct urb *urb)
1550 {
1551         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1552         struct snd_usb_endpoint *ep = subs->data_endpoint;
1553         struct snd_urb_ctx *ctx = urb->context;
1554         unsigned int counts, frames, bytes;
1555         int i, stride, period_elapsed = 0;
1556         unsigned long flags;
1557
1558         stride = runtime->frame_bits >> 3;
1559
1560         frames = 0;
1561         urb->number_of_packets = 0;
1562         spin_lock_irqsave(&subs->lock, flags);
1563         subs->frame_limit += ep->max_urb_frames;
1564         for (i = 0; i < ctx->packets; i++) {
1565                 if (ctx->packet_size[i])
1566                         counts = ctx->packet_size[i];
1567                 else
1568                         counts = snd_usb_endpoint_next_packet_size(ep);
1569
1570                 /* set up descriptor */
1571                 urb->iso_frame_desc[i].offset = frames * ep->stride;
1572                 urb->iso_frame_desc[i].length = counts * ep->stride;
1573                 frames += counts;
1574                 urb->number_of_packets++;
1575                 subs->transfer_done += counts;
1576                 if (subs->transfer_done >= runtime->period_size) {
1577                         subs->transfer_done -= runtime->period_size;
1578                         subs->frame_limit = 0;
1579                         period_elapsed = 1;
1580                         if (subs->fmt_type == UAC_FORMAT_TYPE_II) {
1581                                 if (subs->transfer_done > 0) {
1582                                         /* FIXME: fill-max mode is not
1583                                          * supported yet */
1584                                         frames -= subs->transfer_done;
1585                                         counts -= subs->transfer_done;
1586                                         urb->iso_frame_desc[i].length =
1587                                                 counts * ep->stride;
1588                                         subs->transfer_done = 0;
1589                                 }
1590                                 i++;
1591                                 if (i < ctx->packets) {
1592                                         /* add a transfer delimiter */
1593                                         urb->iso_frame_desc[i].offset =
1594                                                 frames * ep->stride;
1595                                         urb->iso_frame_desc[i].length = 0;
1596                                         urb->number_of_packets++;
1597                                 }
1598                                 break;
1599                         }
1600                 }
1601                 /* finish at the period boundary or after enough frames */
1602                 if ((period_elapsed ||
1603                                 subs->transfer_done >= subs->frame_limit) &&
1604                     !snd_usb_endpoint_implicit_feedback_sink(ep))
1605                         break;
1606         }
1607         bytes = frames * ep->stride;
1608
1609         if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE &&
1610                      subs->cur_audiofmt->dsd_dop)) {
1611                 fill_playback_urb_dsd_dop(subs, urb, bytes);
1612         } else if (unlikely(subs->pcm_format == SNDRV_PCM_FORMAT_DSD_U8 &&
1613                            subs->cur_audiofmt->dsd_bitrev)) {
1614                 /* bit-reverse the bytes */
1615                 u8 *buf = urb->transfer_buffer;
1616                 for (i = 0; i < bytes; i++) {
1617                         int idx = (subs->hwptr_done + i)
1618                                 % (runtime->buffer_size * stride);
1619                         buf[i] = bitrev8(runtime->dma_area[idx]);
1620                 }
1621
1622                 subs->hwptr_done += bytes;
1623                 if (subs->hwptr_done >= runtime->buffer_size * stride)
1624                         subs->hwptr_done -= runtime->buffer_size * stride;
1625         } else {
1626                 /* usual PCM */
1627                 if (!subs->tx_length_quirk)
1628                         copy_to_urb(subs, urb, 0, stride, bytes);
1629                 else
1630                         bytes = copy_to_urb_quirk(subs, urb, stride, bytes);
1631                         /* bytes is now amount of outgoing data */
1632         }
1633
1634         /* update delay with exact number of samples queued */
1635         runtime->delay = subs->last_delay;
1636         runtime->delay += frames;
1637         subs->last_delay = runtime->delay;
1638
1639         /* realign last_frame_number */
1640         subs->last_frame_number = usb_get_current_frame_number(subs->dev);
1641         subs->last_frame_number &= 0xFF; /* keep 8 LSBs */
1642
1643         if (subs->trigger_tstamp_pending_update) {
1644                 /* this is the first actual URB submitted,
1645                  * update trigger timestamp to reflect actual start time
1646                  */
1647                 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1648                 subs->trigger_tstamp_pending_update = false;
1649         }
1650
1651         spin_unlock_irqrestore(&subs->lock, flags);
1652         urb->transfer_buffer_length = bytes;
1653         if (period_elapsed)
1654                 snd_pcm_period_elapsed(subs->pcm_substream);
1655 }
1656
1657 /*
1658  * process after playback data complete
1659  * - decrease the delay count again
1660  */
1661 static void retire_playback_urb(struct snd_usb_substream *subs,
1662                                struct urb *urb)
1663 {
1664         unsigned long flags;
1665         struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
1666         struct snd_usb_endpoint *ep = subs->data_endpoint;
1667         int processed = urb->transfer_buffer_length / ep->stride;
1668         int est_delay;
1669
1670         /* ignore the delay accounting when procssed=0 is given, i.e.
1671          * silent payloads are procssed before handling the actual data
1672          */
1673         if (!processed)
1674                 return;
1675
1676         spin_lock_irqsave(&subs->lock, flags);
1677         if (!subs->last_delay)
1678                 goto out; /* short path */
1679
1680         est_delay = snd_usb_pcm_delay(subs, runtime->rate);
1681         /* update delay with exact number of samples played */
1682         if (processed > subs->last_delay)
1683                 subs->last_delay = 0;
1684         else
1685                 subs->last_delay -= processed;
1686         runtime->delay = subs->last_delay;
1687
1688         /*
1689          * Report when delay estimate is off by more than 2ms.
1690          * The error should be lower than 2ms since the estimate relies
1691          * on two reads of a counter updated every ms.
1692          */
1693         if (abs(est_delay - subs->last_delay) * 1000 > runtime->rate * 2)
1694                 dev_dbg_ratelimited(&subs->dev->dev,
1695                         "delay: estimated %d, actual %d\n",
1696                         est_delay, subs->last_delay);
1697
1698         if (!subs->running) {
1699                 /* update last_frame_number for delay counting here since
1700                  * prepare_playback_urb won't be called during pause
1701                  */
1702                 subs->last_frame_number =
1703                         usb_get_current_frame_number(subs->dev) & 0xff;
1704         }
1705
1706  out:
1707         spin_unlock_irqrestore(&subs->lock, flags);
1708 }
1709
1710 static int snd_usb_substream_playback_trigger(struct snd_pcm_substream *substream,
1711                                               int cmd)
1712 {
1713         struct snd_usb_substream *subs = substream->runtime->private_data;
1714
1715         switch (cmd) {
1716         case SNDRV_PCM_TRIGGER_START:
1717                 subs->trigger_tstamp_pending_update = true;
1718                 /* fall through */
1719         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1720                 subs->data_endpoint->prepare_data_urb = prepare_playback_urb;
1721                 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1722                 subs->running = 1;
1723                 return 0;
1724         case SNDRV_PCM_TRIGGER_STOP:
1725                 stop_endpoints(subs, false);
1726                 subs->running = 0;
1727                 return 0;
1728         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1729                 subs->data_endpoint->prepare_data_urb = NULL;
1730                 /* keep retire_data_urb for delay calculation */
1731                 subs->data_endpoint->retire_data_urb = retire_playback_urb;
1732                 subs->running = 0;
1733                 return 0;
1734         case SNDRV_PCM_TRIGGER_SUSPEND:
1735                 if (subs->stream->chip->setup_fmt_after_resume_quirk) {
1736                         stop_endpoints(subs, true);
1737                         subs->need_setup_fmt = true;
1738                         return 0;
1739                 }
1740                 break;
1741         }
1742
1743         return -EINVAL;
1744 }
1745
1746 static int snd_usb_substream_capture_trigger(struct snd_pcm_substream *substream,
1747                                              int cmd)
1748 {
1749         int err;
1750         struct snd_usb_substream *subs = substream->runtime->private_data;
1751
1752         switch (cmd) {
1753         case SNDRV_PCM_TRIGGER_START:
1754                 err = start_endpoints(subs);
1755                 if (err < 0)
1756                         return err;
1757
1758                 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1759                 subs->running = 1;
1760                 return 0;
1761         case SNDRV_PCM_TRIGGER_STOP:
1762                 stop_endpoints(subs, false);
1763                 subs->running = 0;
1764                 return 0;
1765         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1766                 subs->data_endpoint->retire_data_urb = NULL;
1767                 subs->running = 0;
1768                 return 0;
1769         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1770                 subs->data_endpoint->retire_data_urb = retire_capture_urb;
1771                 subs->running = 1;
1772                 return 0;
1773         case SNDRV_PCM_TRIGGER_SUSPEND:
1774                 if (subs->stream->chip->setup_fmt_after_resume_quirk) {
1775                         stop_endpoints(subs, true);
1776                         subs->need_setup_fmt = true;
1777                         return 0;
1778                 }
1779                 break;
1780         }
1781
1782         return -EINVAL;
1783 }
1784
1785 static const struct snd_pcm_ops snd_usb_playback_ops = {
1786         .open =         snd_usb_pcm_open,
1787         .close =        snd_usb_pcm_close,
1788         .ioctl =        snd_pcm_lib_ioctl,
1789         .hw_params =    snd_usb_hw_params,
1790         .hw_free =      snd_usb_hw_free,
1791         .prepare =      snd_usb_pcm_prepare,
1792         .trigger =      snd_usb_substream_playback_trigger,
1793         .pointer =      snd_usb_pcm_pointer,
1794 };
1795
1796 static const struct snd_pcm_ops snd_usb_capture_ops = {
1797         .open =         snd_usb_pcm_open,
1798         .close =        snd_usb_pcm_close,
1799         .ioctl =        snd_pcm_lib_ioctl,
1800         .hw_params =    snd_usb_hw_params,
1801         .hw_free =      snd_usb_hw_free,
1802         .prepare =      snd_usb_pcm_prepare,
1803         .trigger =      snd_usb_substream_capture_trigger,
1804         .pointer =      snd_usb_pcm_pointer,
1805 };
1806
1807 void snd_usb_set_pcm_ops(struct snd_pcm *pcm, int stream)
1808 {
1809         const struct snd_pcm_ops *ops;
1810
1811         ops = stream == SNDRV_PCM_STREAM_PLAYBACK ?
1812                         &snd_usb_playback_ops : &snd_usb_capture_ops;
1813         snd_pcm_set_ops(pcm, stream, ops);
1814 }
1815
1816 void snd_usb_preallocate_buffer(struct snd_usb_substream *subs)
1817 {
1818         struct snd_pcm *pcm = subs->stream->pcm;
1819         struct snd_pcm_substream *s = pcm->streams[subs->direction].substream;
1820         struct device *dev = subs->dev->bus->controller;
1821
1822         if (snd_usb_use_vmalloc)
1823                 snd_pcm_lib_preallocate_pages(s, SNDRV_DMA_TYPE_VMALLOC,
1824                                               NULL, 0, 0);
1825         else
1826                 snd_pcm_lib_preallocate_pages(s, SNDRV_DMA_TYPE_DEV_SG,
1827                                               dev, 64*1024, 512*1024);
1828 }