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

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

Version: ~ [ linux-5.10-rc5 ] ~ [ linux-5.9.10 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.79 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.159 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.208 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.245 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.245 ] ~ [ 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 
 18 #include <linux/init.h>
 19 #include <linux/slab.h>
 20 #include <linux/usb.h>
 21 #include <linux/usb/audio.h>
 22 #include <linux/usb/audio-v2.h>
 23 
 24 #include <sound/core.h>
 25 #include <sound/pcm.h>
 26 
 27 #include "usbaudio.h"
 28 #include "card.h"
 29 #include "quirks.h"
 30 #include "helper.h"
 31 #include "debug.h"
 32 #include "clock.h"
 33 #include "format.h"
 34 
 35 /*
 36  * parse the audio format type I descriptor
 37  * and returns the corresponding pcm format
 38  *
 39  * @dev: usb device
 40  * @fp: audioformat record
 41  * @format: the format tag (wFormatTag)
 42  * @fmt: the format type descriptor
 43  */
 44 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
 45                                      struct audioformat *fp,
 46                                      unsigned int format, void *_fmt)
 47 {
 48         int sample_width, sample_bytes;
 49         u64 pcm_formats = 0;
 50 
 51         switch (fp->protocol) {
 52         case UAC_VERSION_1:
 53         default: {
 54                 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
 55                 sample_width = fmt->bBitResolution;
 56                 sample_bytes = fmt->bSubframeSize;
 57                 format = 1 << format;
 58                 break;
 59         }
 60 
 61         case UAC_VERSION_2: {
 62                 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
 63                 sample_width = fmt->bBitResolution;
 64                 sample_bytes = fmt->bSubslotSize;
 65 
 66                 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
 67                         pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
 68 
 69                 format <<= 1;
 70                 break;
 71         }
 72         }
 73 
 74         if ((pcm_formats == 0) &&
 75             (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
 76                 /* some devices don't define this correctly... */
 77                 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
 78                             chip->dev->devnum, fp->iface, fp->altsetting);
 79                 format = 1 << UAC_FORMAT_TYPE_I_PCM;
 80         }
 81         if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
 82                 if (chip->usb_id == USB_ID(0x0582, 0x0016) /* Edirol SD-90 */ &&
 83                     sample_width == 24 && sample_bytes == 2)
 84                         sample_bytes = 3;
 85                 else if (sample_width > sample_bytes * 8) {
 86                         snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
 87                                    chip->dev->devnum, fp->iface, fp->altsetting,
 88                                    sample_width, sample_bytes);
 89                 }
 90                 /* check the format byte size */
 91                 switch (sample_bytes) {
 92                 case 1:
 93                         pcm_formats |= SNDRV_PCM_FMTBIT_S8;
 94                         break;
 95                 case 2:
 96                         if (snd_usb_is_big_endian_format(chip, fp))
 97                                 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
 98                         else
 99                                 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
100                         break;
101                 case 3:
102                         if (snd_usb_is_big_endian_format(chip, fp))
103                                 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
104                         else
105                                 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
106                         break;
107                 case 4:
108                         pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
109                         break;
110                 default:
111                         snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
112                                    chip->dev->devnum, fp->iface, fp->altsetting,
113                                    sample_width, sample_bytes);
114                         break;
115                 }
116         }
117         if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
118                 /* Dallas DS4201 workaround: it advertises U8 format, but really
119                    supports S8. */
120                 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
121                         pcm_formats |= SNDRV_PCM_FMTBIT_S8;
122                 else
123                         pcm_formats |= SNDRV_PCM_FMTBIT_U8;
124         }
125         if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
126                 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
127         }
128         if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
129                 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
130         }
131         if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
132                 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
133         }
134         if (format & ~0x3f) {
135                 snd_printk(KERN_INFO "%d:%u:%d : unsupported format bits %#x\n",
136                            chip->dev->devnum, fp->iface, fp->altsetting, format);
137         }
138 
139         pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
140 
141         return pcm_formats;
142 }
143 
144 
145 /*
146  * parse the format descriptor and stores the possible sample rates
147  * on the audioformat table (audio class v1).
148  *
149  * @dev: usb device
150  * @fp: audioformat record
151  * @fmt: the format descriptor
152  * @offset: the start offset of descriptor pointing the rate type
153  *          (7 for type I and II, 8 for type II)
154  */
155 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
156                                        unsigned char *fmt, int offset)
157 {
158         int nr_rates = fmt[offset];
159 
160         if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
161                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
162                                    chip->dev->devnum, fp->iface, fp->altsetting);
163                 return -EINVAL;
164         }
165 
166         if (nr_rates) {
167                 /*
168                  * build the rate table and bitmap flags
169                  */
170                 int r, idx;
171 
172                 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
173                 if (fp->rate_table == NULL) {
174                         snd_printk(KERN_ERR "cannot malloc\n");
175                         return -ENOMEM;
176                 }
177 
178                 fp->nr_rates = 0;
179                 fp->rate_min = fp->rate_max = 0;
180                 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
181                         unsigned int rate = combine_triple(&fmt[idx]);
182                         if (!rate)
183                                 continue;
184                         /* C-Media CM6501 mislabels its 96 kHz altsetting */
185                         /* Terratec Aureon 7.1 USB C-Media 6206, too */
186                         if (rate == 48000 && nr_rates == 1 &&
187                             (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
188                              chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
189                              chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
190                             fp->altsetting == 5 && fp->maxpacksize == 392)
191                                 rate = 96000;
192                         /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
193                         if (rate == 16000 &&
194                             (chip->usb_id == USB_ID(0x041e, 0x4064) ||
195                              chip->usb_id == USB_ID(0x041e, 0x4068)))
196                                 rate = 8000;
197 
198                         fp->rate_table[fp->nr_rates] = rate;
199                         if (!fp->rate_min || rate < fp->rate_min)
200                                 fp->rate_min = rate;
201                         if (!fp->rate_max || rate > fp->rate_max)
202                                 fp->rate_max = rate;
203                         fp->rates |= snd_pcm_rate_to_rate_bit(rate);
204                         fp->nr_rates++;
205                 }
206                 if (!fp->nr_rates) {
207                         hwc_debug("All rates were zero. Skipping format!\n");
208                         return -EINVAL;
209                 }
210         } else {
211                 /* continuous rates */
212                 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
213                 fp->rate_min = combine_triple(&fmt[offset + 1]);
214                 fp->rate_max = combine_triple(&fmt[offset + 4]);
215         }
216         return 0;
217 }
218 
219 /*
220  * Helper function to walk the array of sample rate triplets reported by
221  * the device. The problem is that we need to parse whole array first to
222  * get to know how many sample rates we have to expect.
223  * Then fp->rate_table can be allocated and filled.
224  */
225 static int parse_uac2_sample_rate_range(struct audioformat *fp, int nr_triplets,
226                                         const unsigned char *data)
227 {
228         int i, nr_rates = 0;
229 
230         fp->rates = fp->rate_min = fp->rate_max = 0;
231 
232         for (i = 0; i < nr_triplets; i++) {
233                 int min = combine_quad(&data[2 + 12 * i]);
234                 int max = combine_quad(&data[6 + 12 * i]);
235                 int res = combine_quad(&data[10 + 12 * i]);
236                 unsigned int rate;
237 
238                 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
239                         continue;
240 
241                 /*
242                  * for ranges with res == 1, we announce a continuous sample
243                  * rate range, and this function should return 0 for no further
244                  * parsing.
245                  */
246                 if (res == 1) {
247                         fp->rate_min = min;
248                         fp->rate_max = max;
249                         fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
250                         return 0;
251                 }
252 
253                 for (rate = min; rate <= max; rate += res) {
254                         if (fp->rate_table)
255                                 fp->rate_table[nr_rates] = rate;
256                         if (!fp->rate_min || rate < fp->rate_min)
257                                 fp->rate_min = rate;
258                         if (!fp->rate_max || rate > fp->rate_max)
259                                 fp->rate_max = rate;
260                         fp->rates |= snd_pcm_rate_to_rate_bit(rate);
261 
262                         nr_rates++;
263                         if (nr_rates >= MAX_NR_RATES) {
264                                 snd_printk(KERN_ERR "invalid uac2 rates\n");
265                                 break;
266                         }
267 
268                         /* avoid endless loop */
269                         if (res == 0)
270                                 break;
271                 }
272         }
273 
274         return nr_rates;
275 }
276 
277 /*
278  * parse the format descriptor and stores the possible sample rates
279  * on the audioformat table (audio class v2).
280  */
281 static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
282                                        struct audioformat *fp)
283 {
284         struct usb_device *dev = chip->dev;
285         unsigned char tmp[2], *data;
286         int nr_triplets, data_size, ret = 0;
287         int clock = snd_usb_clock_find_source(chip, fp->clock, false);
288 
289         if (clock < 0) {
290                 snd_printk(KERN_ERR "%s(): unable to find clock source (clock %d)\n",
291                                 __func__, clock);
292                 goto err;
293         }
294 
295         /* get the number of sample rates first by only fetching 2 bytes */
296         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
297                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
298                               UAC2_CS_CONTROL_SAM_FREQ << 8,
299                               snd_usb_ctrl_intf(chip) | (clock << 8),
300                               tmp, sizeof(tmp));
301 
302         if (ret < 0) {
303                 snd_printk(KERN_ERR "%s(): unable to retrieve number of sample rates (clock %d)\n",
304                                 __func__, clock);
305                 goto err;
306         }
307 
308         nr_triplets = (tmp[1] << 8) | tmp[0];
309         data_size = 2 + 12 * nr_triplets;
310         data = kzalloc(data_size, GFP_KERNEL);
311         if (!data) {
312                 ret = -ENOMEM;
313                 goto err;
314         }
315 
316         /* now get the full information */
317         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
318                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
319                               UAC2_CS_CONTROL_SAM_FREQ << 8,
320                               snd_usb_ctrl_intf(chip) | (clock << 8),
321                               data, data_size);
322 
323         if (ret < 0) {
324                 snd_printk(KERN_ERR "%s(): unable to retrieve sample rate range (clock %d)\n",
325                                 __func__, clock);
326                 ret = -EINVAL;
327                 goto err_free;
328         }
329 
330         /* Call the triplet parser, and make sure fp->rate_table is NULL.
331          * We just use the return value to know how many sample rates we
332          * will have to deal with. */
333         kfree(fp->rate_table);
334         fp->rate_table = NULL;
335         fp->nr_rates = parse_uac2_sample_rate_range(fp, nr_triplets, data);
336 
337         if (fp->nr_rates == 0) {
338                 /* SNDRV_PCM_RATE_CONTINUOUS */
339                 ret = 0;
340                 goto err_free;
341         }
342 
343         fp->rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
344         if (!fp->rate_table) {
345                 ret = -ENOMEM;
346                 goto err_free;
347         }
348 
349         /* Call the triplet parser again, but this time, fp->rate_table is
350          * allocated, so the rates will be stored */
351         parse_uac2_sample_rate_range(fp, nr_triplets, data);
352 
353 err_free:
354         kfree(data);
355 err:
356         return ret;
357 }
358 
359 /*
360  * parse the format type I and III descriptors
361  */
362 static int parse_audio_format_i(struct snd_usb_audio *chip,
363                                 struct audioformat *fp, unsigned int format,
364                                 struct uac_format_type_i_continuous_descriptor *fmt)
365 {
366         snd_pcm_format_t pcm_format;
367         int ret;
368 
369         if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
370                 /* FIXME: the format type is really IECxxx
371                  *        but we give normal PCM format to get the existing
372                  *        apps working...
373                  */
374                 switch (chip->usb_id) {
375 
376                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
377                         if (chip->setup == 0x00 && 
378                             fp->altsetting == 6)
379                                 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
380                         else
381                                 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
382                         break;
383                 default:
384                         pcm_format = SNDRV_PCM_FORMAT_S16_LE;
385                 }
386                 fp->formats = pcm_format_to_bits(pcm_format);
387         } else {
388                 fp->formats = parse_audio_format_i_type(chip, fp, format, fmt);
389                 if (!fp->formats)
390                         return -EINVAL;
391         }
392 
393         /* gather possible sample rates */
394         /* audio class v1 reports possible sample rates as part of the
395          * proprietary class specific descriptor.
396          * audio class v2 uses class specific EP0 range requests for that.
397          */
398         switch (fp->protocol) {
399         default:
400         case UAC_VERSION_1:
401                 fp->channels = fmt->bNrChannels;
402                 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
403                 break;
404         case UAC_VERSION_2:
405                 /* fp->channels is already set in this case */
406                 ret = parse_audio_format_rates_v2(chip, fp);
407                 break;
408         }
409 
410         if (fp->channels < 1) {
411                 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
412                            chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
413                 return -EINVAL;
414         }
415 
416         return ret;
417 }
418 
419 /*
420  * parse the format type II descriptor
421  */
422 static int parse_audio_format_ii(struct snd_usb_audio *chip,
423                                  struct audioformat *fp,
424                                  int format, void *_fmt)
425 {
426         int brate, framesize, ret;
427 
428         switch (format) {
429         case UAC_FORMAT_TYPE_II_AC3:
430                 /* FIXME: there is no AC3 format defined yet */
431                 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
432                 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
433                 break;
434         case UAC_FORMAT_TYPE_II_MPEG:
435                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
436                 break;
437         default:
438                 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected.  processed as MPEG.\n",
439                            chip->dev->devnum, fp->iface, fp->altsetting, format);
440                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
441                 break;
442         }
443 
444         fp->channels = 1;
445 
446         switch (fp->protocol) {
447         default:
448         case UAC_VERSION_1: {
449                 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
450                 brate = le16_to_cpu(fmt->wMaxBitRate);
451                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
452                 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
453                 fp->frame_size = framesize;
454                 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
455                 break;
456         }
457         case UAC_VERSION_2: {
458                 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
459                 brate = le16_to_cpu(fmt->wMaxBitRate);
460                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
461                 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
462                 fp->frame_size = framesize;
463                 ret = parse_audio_format_rates_v2(chip, fp);
464                 break;
465         }
466         }
467 
468         return ret;
469 }
470 
471 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
472                                struct audioformat *fp, unsigned int format,
473                                struct uac_format_type_i_continuous_descriptor *fmt,
474                                int stream)
475 {
476         int err;
477 
478         switch (fmt->bFormatType) {
479         case UAC_FORMAT_TYPE_I:
480         case UAC_FORMAT_TYPE_III:
481                 err = parse_audio_format_i(chip, fp, format, fmt);
482                 break;
483         case UAC_FORMAT_TYPE_II:
484                 err = parse_audio_format_ii(chip, fp, format, fmt);
485                 break;
486         default:
487                 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
488                            chip->dev->devnum, fp->iface, fp->altsetting,
489                            fmt->bFormatType);
490                 return -ENOTSUPP;
491         }
492         fp->fmt_type = fmt->bFormatType;
493         if (err < 0)
494                 return err;
495 #if 1
496         /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
497         /* extigy apparently supports sample rates other than 48k
498          * but not in ordinary way.  so we enable only 48k atm.
499          */
500         if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
501             chip->usb_id == USB_ID(0x041e, 0x3020) ||
502             chip->usb_id == USB_ID(0x041e, 0x3061)) {
503                 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
504                     fp->rates != SNDRV_PCM_RATE_48000 &&
505                     fp->rates != SNDRV_PCM_RATE_96000)
506                         return -ENOTSUPP;
507         }
508 #endif
509         return 0;
510 }
511 
512 

~ [ 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