source: src/linux/universal/linux-4.9/sound/usb/pcm.c @ 31859

Last change on this file since 31859 was 31859, checked in by brainslayer, 2 months ago

kernel update

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