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