~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/sound/usb/pcm.c

Version: ~ [ linux-5.9-rc6 ] ~ [ linux-5.8.10 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.66 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.146 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.198 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.236 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.236 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp