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