1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20#include <linux/bitops.h>
21#include <linux/init.h>
22#include <linux/string.h>
23#include <linux/usb.h>
24#include <linux/usb/audio.h>
25#include <linux/usb/audio-v2.h>
26#include <linux/usb/audio-v3.h>
27
28#include <sound/core.h>
29#include <sound/info.h>
30#include <sound/pcm.h>
31
32#include "usbaudio.h"
33#include "card.h"
34#include "helper.h"
35#include "clock.h"
36#include "quirks.h"
37
38static void *find_uac_clock_desc(struct usb_host_interface *iface, int id,
39 bool (*validator)(void *, int), u8 type)
40{
41 void *cs = NULL;
42
43 while ((cs = snd_usb_find_csint_desc(iface->extra, iface->extralen,
44 cs, type))) {
45 if (validator(cs, id))
46 return cs;
47 }
48
49 return NULL;
50}
51
52static bool validate_clock_source_v2(void *p, int id)
53{
54 struct uac_clock_source_descriptor *cs = p;
55 return cs->bLength == sizeof(*cs) && cs->bClockID == id;
56}
57
58static bool validate_clock_source_v3(void *p, int id)
59{
60 struct uac3_clock_source_descriptor *cs = p;
61 return cs->bLength == sizeof(*cs) && cs->bClockID == id;
62}
63
64static bool validate_clock_selector_v2(void *p, int id)
65{
66 struct uac_clock_selector_descriptor *cs = p;
67 return cs->bLength >= sizeof(*cs) && cs->bClockID == id &&
68 cs->bLength == 7 + cs->bNrInPins;
69}
70
71static bool validate_clock_selector_v3(void *p, int id)
72{
73 struct uac3_clock_selector_descriptor *cs = p;
74 return cs->bLength >= sizeof(*cs) && cs->bClockID == id &&
75 cs->bLength == 11 + cs->bNrInPins;
76}
77
78static bool validate_clock_multiplier_v2(void *p, int id)
79{
80 struct uac_clock_multiplier_descriptor *cs = p;
81 return cs->bLength == sizeof(*cs) && cs->bClockID == id;
82}
83
84static bool validate_clock_multiplier_v3(void *p, int id)
85{
86 struct uac3_clock_multiplier_descriptor *cs = p;
87 return cs->bLength == sizeof(*cs) && cs->bClockID == id;
88}
89
90#define DEFINE_FIND_HELPER(name, obj, validator, type) \
91static obj *name(struct usb_host_interface *iface, int id) \
92{ \
93 return find_uac_clock_desc(iface, id, validator, type); \
94}
95
96DEFINE_FIND_HELPER(snd_usb_find_clock_source,
97 struct uac_clock_source_descriptor,
98 validate_clock_source_v2, UAC2_CLOCK_SOURCE);
99DEFINE_FIND_HELPER(snd_usb_find_clock_source_v3,
100 struct uac3_clock_source_descriptor,
101 validate_clock_source_v3, UAC3_CLOCK_SOURCE);
102
103DEFINE_FIND_HELPER(snd_usb_find_clock_selector,
104 struct uac_clock_selector_descriptor,
105 validate_clock_selector_v2, UAC2_CLOCK_SELECTOR);
106DEFINE_FIND_HELPER(snd_usb_find_clock_selector_v3,
107 struct uac3_clock_selector_descriptor,
108 validate_clock_selector_v3, UAC3_CLOCK_SELECTOR);
109
110DEFINE_FIND_HELPER(snd_usb_find_clock_multiplier,
111 struct uac_clock_multiplier_descriptor,
112 validate_clock_multiplier_v2, UAC2_CLOCK_MULTIPLIER);
113DEFINE_FIND_HELPER(snd_usb_find_clock_multiplier_v3,
114 struct uac3_clock_multiplier_descriptor,
115 validate_clock_multiplier_v3, UAC3_CLOCK_MULTIPLIER);
116
117static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id)
118{
119 unsigned char buf;
120 int ret;
121
122 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0),
123 UAC2_CS_CUR,
124 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
125 UAC2_CX_CLOCK_SELECTOR << 8,
126 snd_usb_ctrl_intf(chip) | (selector_id << 8),
127 &buf, sizeof(buf));
128
129 if (ret < 0)
130 return ret;
131
132 return buf;
133}
134
135static int uac_clock_selector_set_val(struct snd_usb_audio *chip, int selector_id,
136 unsigned char pin)
137{
138 int ret;
139
140 ret = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0),
141 UAC2_CS_CUR,
142 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
143 UAC2_CX_CLOCK_SELECTOR << 8,
144 snd_usb_ctrl_intf(chip) | (selector_id << 8),
145 &pin, sizeof(pin));
146 if (ret < 0)
147 return ret;
148
149 if (ret != sizeof(pin)) {
150 usb_audio_err(chip,
151 "setting selector (id %d) unexpected length %d\n",
152 selector_id, ret);
153 return -EINVAL;
154 }
155
156 ret = uac_clock_selector_get_val(chip, selector_id);
157 if (ret < 0)
158 return ret;
159
160 if (ret != pin) {
161 usb_audio_err(chip,
162 "setting selector (id %d) to %x failed (current: %d)\n",
163 selector_id, pin, ret);
164 return -EINVAL;
165 }
166
167 return ret;
168}
169
170static bool uac_clock_source_is_valid(struct snd_usb_audio *chip,
171 int protocol,
172 int source_id)
173{
174 int err;
175 unsigned char data;
176 struct usb_device *dev = chip->dev;
177 u32 bmControls;
178
179 if (protocol == UAC_VERSION_3) {
180 struct uac3_clock_source_descriptor *cs_desc =
181 snd_usb_find_clock_source_v3(chip->ctrl_intf, source_id);
182
183 if (!cs_desc)
184 return 0;
185 bmControls = le32_to_cpu(cs_desc->bmControls);
186 } else {
187 struct uac_clock_source_descriptor *cs_desc =
188 snd_usb_find_clock_source(chip->ctrl_intf, source_id);
189
190 if (!cs_desc)
191 return 0;
192 bmControls = cs_desc->bmControls;
193 }
194
195
196 if (!uac_v2v3_control_is_readable(bmControls,
197 UAC2_CS_CONTROL_CLOCK_VALID))
198 return 1;
199
200 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
201 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
202 UAC2_CS_CONTROL_CLOCK_VALID << 8,
203 snd_usb_ctrl_intf(chip) | (source_id << 8),
204 &data, sizeof(data));
205
206 if (err < 0) {
207 dev_warn(&dev->dev,
208 "%s(): cannot get clock validity for id %d\n",
209 __func__, source_id);
210 return 0;
211 }
212
213 return !!data;
214}
215
216static int __uac_clock_find_source(struct snd_usb_audio *chip, int entity_id,
217 unsigned long *visited, bool validate)
218{
219 struct uac_clock_source_descriptor *source;
220 struct uac_clock_selector_descriptor *selector;
221 struct uac_clock_multiplier_descriptor *multiplier;
222
223 entity_id &= 0xff;
224
225 if (test_and_set_bit(entity_id, visited)) {
226 usb_audio_warn(chip,
227 "%s(): recursive clock topology detected, id %d.\n",
228 __func__, entity_id);
229 return -EINVAL;
230 }
231
232
233 source = snd_usb_find_clock_source(chip->ctrl_intf, entity_id);
234 if (source) {
235 entity_id = source->bClockID;
236 if (validate && !uac_clock_source_is_valid(chip, UAC_VERSION_2,
237 entity_id)) {
238 usb_audio_err(chip,
239 "clock source %d is not valid, cannot use\n",
240 entity_id);
241 return -ENXIO;
242 }
243 return entity_id;
244 }
245
246 selector = snd_usb_find_clock_selector(chip->ctrl_intf, entity_id);
247 if (selector) {
248 int ret, i, cur;
249
250
251
252 ret = uac_clock_selector_get_val(chip, selector->bClockID);
253 if (ret < 0)
254 return ret;
255
256
257
258 if (ret > selector->bNrInPins || ret < 1) {
259 usb_audio_err(chip,
260 "%s(): selector reported illegal value, id %d, ret %d\n",
261 __func__, selector->bClockID, ret);
262
263 return -EINVAL;
264 }
265
266 cur = ret;
267 ret = __uac_clock_find_source(chip, selector->baCSourceID[ret - 1],
268 visited, validate);
269 if (!validate || ret > 0 || !chip->autoclock)
270 return ret;
271
272
273 for (i = 1; i <= selector->bNrInPins; i++) {
274 int err;
275
276 if (i == cur)
277 continue;
278
279 ret = __uac_clock_find_source(chip, selector->baCSourceID[i - 1],
280 visited, true);
281 if (ret < 0)
282 continue;
283
284 err = uac_clock_selector_set_val(chip, entity_id, i);
285 if (err < 0)
286 continue;
287
288 usb_audio_info(chip,
289 "found and selected valid clock source %d\n",
290 ret);
291 return ret;
292 }
293
294 return -ENXIO;
295 }
296
297
298 multiplier = snd_usb_find_clock_multiplier(chip->ctrl_intf, entity_id);
299 if (multiplier)
300 return __uac_clock_find_source(chip, multiplier->bCSourceID,
301 visited, validate);
302
303 return -EINVAL;
304}
305
306static int __uac3_clock_find_source(struct snd_usb_audio *chip, int entity_id,
307 unsigned long *visited, bool validate)
308{
309 struct uac3_clock_source_descriptor *source;
310 struct uac3_clock_selector_descriptor *selector;
311 struct uac3_clock_multiplier_descriptor *multiplier;
312
313 entity_id &= 0xff;
314
315 if (test_and_set_bit(entity_id, visited)) {
316 usb_audio_warn(chip,
317 "%s(): recursive clock topology detected, id %d.\n",
318 __func__, entity_id);
319 return -EINVAL;
320 }
321
322
323 source = snd_usb_find_clock_source_v3(chip->ctrl_intf, entity_id);
324 if (source) {
325 entity_id = source->bClockID;
326 if (validate && !uac_clock_source_is_valid(chip, UAC_VERSION_3,
327 entity_id)) {
328 usb_audio_err(chip,
329 "clock source %d is not valid, cannot use\n",
330 entity_id);
331 return -ENXIO;
332 }
333 return entity_id;
334 }
335
336 selector = snd_usb_find_clock_selector_v3(chip->ctrl_intf, entity_id);
337 if (selector) {
338 int ret, i, cur;
339
340
341
342 ret = uac_clock_selector_get_val(chip, selector->bClockID);
343 if (ret < 0)
344 return ret;
345
346
347
348 if (ret > selector->bNrInPins || ret < 1) {
349 usb_audio_err(chip,
350 "%s(): selector reported illegal value, id %d, ret %d\n",
351 __func__, selector->bClockID, ret);
352
353 return -EINVAL;
354 }
355
356 cur = ret;
357 ret = __uac3_clock_find_source(chip, selector->baCSourceID[ret - 1],
358 visited, validate);
359 if (!validate || ret > 0 || !chip->autoclock)
360 return ret;
361
362
363 for (i = 1; i <= selector->bNrInPins; i++) {
364 int err;
365
366 if (i == cur)
367 continue;
368
369 ret = __uac3_clock_find_source(chip, selector->baCSourceID[i - 1],
370 visited, true);
371 if (ret < 0)
372 continue;
373
374 err = uac_clock_selector_set_val(chip, entity_id, i);
375 if (err < 0)
376 continue;
377
378 usb_audio_info(chip,
379 "found and selected valid clock source %d\n",
380 ret);
381 return ret;
382 }
383
384 return -ENXIO;
385 }
386
387
388 multiplier = snd_usb_find_clock_multiplier_v3(chip->ctrl_intf,
389 entity_id);
390 if (multiplier)
391 return __uac3_clock_find_source(chip, multiplier->bCSourceID,
392 visited, validate);
393
394 return -EINVAL;
395}
396
397
398
399
400
401
402
403
404
405
406
407
408int snd_usb_clock_find_source(struct snd_usb_audio *chip, int protocol,
409 int entity_id, bool validate)
410{
411 DECLARE_BITMAP(visited, 256);
412 memset(visited, 0, sizeof(visited));
413
414 switch (protocol) {
415 case UAC_VERSION_2:
416 return __uac_clock_find_source(chip, entity_id, visited,
417 validate);
418 case UAC_VERSION_3:
419 return __uac3_clock_find_source(chip, entity_id, visited,
420 validate);
421 default:
422 return -EINVAL;
423 }
424}
425
426static int set_sample_rate_v1(struct snd_usb_audio *chip, int iface,
427 struct usb_host_interface *alts,
428 struct audioformat *fmt, int rate)
429{
430 struct usb_device *dev = chip->dev;
431 unsigned int ep;
432 unsigned char data[3];
433 int err, crate;
434
435 if (get_iface_desc(alts)->bNumEndpoints < 1)
436 return -EINVAL;
437 ep = get_endpoint(alts, 0)->bEndpointAddress;
438
439
440 if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE))
441 return 0;
442
443 data[0] = rate;
444 data[1] = rate >> 8;
445 data[2] = rate >> 16;
446 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
447 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
448 UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
449 data, sizeof(data))) < 0) {
450 dev_err(&dev->dev, "%d:%d: cannot set freq %d to ep %#x\n",
451 iface, fmt->altsetting, rate, ep);
452 return err;
453 }
454
455
456
457 if (snd_usb_get_sample_rate_quirk(chip))
458 return 0;
459
460 if (chip->sample_rate_read_error > 2)
461 return 0;
462
463 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR,
464 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN,
465 UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
466 data, sizeof(data))) < 0) {
467 dev_err(&dev->dev, "%d:%d: cannot get freq at ep %#x\n",
468 iface, fmt->altsetting, ep);
469 chip->sample_rate_read_error++;
470 return 0;
471 }
472
473 crate = data[0] | (data[1] << 8) | (data[2] << 16);
474 if (crate != rate) {
475 dev_warn(&dev->dev, "current rate %d is different from the runtime rate %d\n", crate, rate);
476
477 }
478
479 return 0;
480}
481
482static int get_sample_rate_v2v3(struct snd_usb_audio *chip, int iface,
483 int altsetting, int clock)
484{
485 struct usb_device *dev = chip->dev;
486 __le32 data;
487 int err;
488
489 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
490 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
491 UAC2_CS_CONTROL_SAM_FREQ << 8,
492 snd_usb_ctrl_intf(chip) | (clock << 8),
493 &data, sizeof(data));
494 if (err < 0) {
495 dev_warn(&dev->dev, "%d:%d: cannot get freq (v2/v3): err %d\n",
496 iface, altsetting, err);
497 return 0;
498 }
499
500 return le32_to_cpu(data);
501}
502
503static int set_sample_rate_v2v3(struct snd_usb_audio *chip, int iface,
504 struct usb_host_interface *alts,
505 struct audioformat *fmt, int rate)
506{
507 struct usb_device *dev = chip->dev;
508 __le32 data;
509 int err, cur_rate, prev_rate;
510 int clock;
511 bool writeable;
512 u32 bmControls;
513
514 clock = snd_usb_clock_find_source(chip, fmt->protocol,
515 fmt->clock, true);
516 if (clock < 0)
517 return clock;
518
519 prev_rate = get_sample_rate_v2v3(chip, iface, fmt->altsetting, clock);
520 if (prev_rate == rate)
521 return 0;
522
523 if (fmt->protocol == UAC_VERSION_3) {
524 struct uac3_clock_source_descriptor *cs_desc;
525
526 cs_desc = snd_usb_find_clock_source_v3(chip->ctrl_intf, clock);
527 bmControls = le32_to_cpu(cs_desc->bmControls);
528 } else {
529 struct uac_clock_source_descriptor *cs_desc;
530
531 cs_desc = snd_usb_find_clock_source(chip->ctrl_intf, clock);
532 bmControls = cs_desc->bmControls;
533 }
534
535 writeable = uac_v2v3_control_is_writeable(bmControls,
536 UAC2_CS_CONTROL_SAM_FREQ);
537 if (writeable) {
538 data = cpu_to_le32(rate);
539 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
540 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
541 UAC2_CS_CONTROL_SAM_FREQ << 8,
542 snd_usb_ctrl_intf(chip) | (clock << 8),
543 &data, sizeof(data));
544 if (err < 0) {
545 usb_audio_err(chip,
546 "%d:%d: cannot set freq %d (v2/v3): err %d\n",
547 iface, fmt->altsetting, rate, err);
548 return err;
549 }
550
551 cur_rate = get_sample_rate_v2v3(chip, iface,
552 fmt->altsetting, clock);
553 } else {
554 cur_rate = prev_rate;
555 }
556
557 if (cur_rate != rate) {
558 if (!writeable) {
559 usb_audio_warn(chip,
560 "%d:%d: freq mismatch (RO clock): req %d, clock runs @%d\n",
561 iface, fmt->altsetting, rate, cur_rate);
562 return -ENXIO;
563 }
564 usb_audio_dbg(chip,
565 "current rate %d is different from the runtime rate %d\n",
566 cur_rate, rate);
567 }
568
569
570
571 if (rate != prev_rate) {
572 usb_set_interface(dev, iface, 0);
573 snd_usb_set_interface_quirk(dev);
574 usb_set_interface(dev, iface, fmt->altsetting);
575 snd_usb_set_interface_quirk(dev);
576 }
577
578 return 0;
579}
580
581int snd_usb_init_sample_rate(struct snd_usb_audio *chip, int iface,
582 struct usb_host_interface *alts,
583 struct audioformat *fmt, int rate)
584{
585 switch (fmt->protocol) {
586 case UAC_VERSION_1:
587 default:
588 return set_sample_rate_v1(chip, iface, alts, fmt, rate);
589
590 case UAC_VERSION_2:
591 case UAC_VERSION_3:
592 return set_sample_rate_v2v3(chip, iface, alts, fmt, rate);
593 }
594}
595
596
