blob: 03fed6611d9e83d489e2ab66d94320c84eed4c18 [file] [log] [blame]
Daniel Mack79f920f2010-05-31 14:51:31 +02001/*
2 * Clock domain and sample rate management functions
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 */
19
20#include <linux/bitops.h>
21#include <linux/init.h>
Daniel Mack79f920f2010-05-31 14:51:31 +020022#include <linux/string.h>
23#include <linux/usb.h>
Daniel Mack79f920f2010-05-31 14:51:31 +020024#include <linux/usb/audio.h>
25#include <linux/usb/audio-v2.h>
26
27#include <sound/core.h>
28#include <sound/info.h>
29#include <sound/pcm.h>
Daniel Mack79f920f2010-05-31 14:51:31 +020030
31#include "usbaudio.h"
32#include "card.h"
Daniel Mack79f920f2010-05-31 14:51:31 +020033#include "helper.h"
Daniel Mackf22aa942010-06-16 17:57:27 +020034#include "clock.h"
Daniel Mack21bb5aa2013-04-10 00:56:03 +080035#include "quirks.h"
Daniel Mack79f920f2010-05-31 14:51:31 +020036
37static struct uac_clock_source_descriptor *
38 snd_usb_find_clock_source(struct usb_host_interface *ctrl_iface,
39 int clock_id)
40{
41 struct uac_clock_source_descriptor *cs = NULL;
42
43 while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
44 ctrl_iface->extralen,
45 cs, UAC2_CLOCK_SOURCE))) {
46 if (cs->bClockID == clock_id)
47 return cs;
48 }
49
50 return NULL;
51}
52
53static struct uac_clock_selector_descriptor *
54 snd_usb_find_clock_selector(struct usb_host_interface *ctrl_iface,
55 int clock_id)
56{
57 struct uac_clock_selector_descriptor *cs = NULL;
58
59 while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
60 ctrl_iface->extralen,
61 cs, UAC2_CLOCK_SELECTOR))) {
62 if (cs->bClockID == clock_id)
63 return cs;
64 }
65
66 return NULL;
67}
68
69static struct uac_clock_multiplier_descriptor *
70 snd_usb_find_clock_multiplier(struct usb_host_interface *ctrl_iface,
71 int clock_id)
72{
73 struct uac_clock_multiplier_descriptor *cs = NULL;
74
75 while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
76 ctrl_iface->extralen,
77 cs, UAC2_CLOCK_MULTIPLIER))) {
78 if (cs->bClockID == clock_id)
79 return cs;
80 }
81
82 return NULL;
83}
84
85static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id)
86{
87 unsigned char buf;
88 int ret;
89
90 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0),
91 UAC2_CS_CUR,
92 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Daniel Mack11bcbc42010-06-11 17:34:20 +020093 UAC2_CX_CLOCK_SELECTOR << 8,
94 snd_usb_ctrl_intf(chip) | (selector_id << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +020095 &buf, sizeof(buf));
Daniel Mack79f920f2010-05-31 14:51:31 +020096
97 if (ret < 0)
98 return ret;
99
100 return buf;
101}
102
Eldad Zack8c55af32013-04-03 23:18:55 +0200103static int uac_clock_selector_set_val(struct snd_usb_audio *chip, int selector_id,
104 unsigned char pin)
105{
106 int ret;
107
108 ret = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0),
109 UAC2_CS_CUR,
110 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
111 UAC2_CX_CLOCK_SELECTOR << 8,
112 snd_usb_ctrl_intf(chip) | (selector_id << 8),
113 &pin, sizeof(pin));
114 if (ret < 0)
115 return ret;
116
117 if (ret != sizeof(pin)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100118 usb_audio_err(chip,
119 "setting selector (id %d) unexpected length %d\n",
120 selector_id, ret);
Eldad Zack8c55af32013-04-03 23:18:55 +0200121 return -EINVAL;
122 }
123
124 ret = uac_clock_selector_get_val(chip, selector_id);
125 if (ret < 0)
126 return ret;
127
128 if (ret != pin) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100129 usb_audio_err(chip,
130 "setting selector (id %d) to %x failed (current: %d)\n",
131 selector_id, pin, ret);
Eldad Zack8c55af32013-04-03 23:18:55 +0200132 return -EINVAL;
133 }
134
135 return ret;
136}
137
Daniel Mack79f920f2010-05-31 14:51:31 +0200138static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, int source_id)
139{
140 int err;
141 unsigned char data;
142 struct usb_device *dev = chip->dev;
Daniel Mack3bc6fbc72011-05-18 11:28:44 +0200143 struct uac_clock_source_descriptor *cs_desc =
144 snd_usb_find_clock_source(chip->ctrl_intf, source_id);
145
146 if (!cs_desc)
147 return 0;
148
149 /* If a clock source can't tell us whether it's valid, we assume it is */
Daniel Mackaff252a2012-08-01 10:16:53 +0200150 if (!uac2_control_is_readable(cs_desc->bmControls,
151 UAC2_CS_CONTROL_CLOCK_VALID - 1))
Daniel Mack3bc6fbc72011-05-18 11:28:44 +0200152 return 1;
Daniel Mack79f920f2010-05-31 14:51:31 +0200153
154 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
155 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
Daniel Mack11bcbc42010-06-11 17:34:20 +0200156 UAC2_CS_CONTROL_CLOCK_VALID << 8,
157 snd_usb_ctrl_intf(chip) | (source_id << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200158 &data, sizeof(data));
Daniel Mack79f920f2010-05-31 14:51:31 +0200159
160 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100161 dev_warn(&dev->dev,
162 "%s(): cannot get clock validity for id %d\n",
Daniel Mack79f920f2010-05-31 14:51:31 +0200163 __func__, source_id);
Daniel Mack3bc6fbc72011-05-18 11:28:44 +0200164 return 0;
Daniel Mack79f920f2010-05-31 14:51:31 +0200165 }
166
167 return !!data;
168}
169
Daniel Mack79f920f2010-05-31 14:51:31 +0200170static int __uac_clock_find_source(struct snd_usb_audio *chip,
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200171 int entity_id, unsigned long *visited,
172 bool validate)
Daniel Mack79f920f2010-05-31 14:51:31 +0200173{
174 struct uac_clock_source_descriptor *source;
175 struct uac_clock_selector_descriptor *selector;
176 struct uac_clock_multiplier_descriptor *multiplier;
177
178 entity_id &= 0xff;
179
180 if (test_and_set_bit(entity_id, visited)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100181 usb_audio_warn(chip,
182 "%s(): recursive clock topology detected, id %d.\n",
183 __func__, entity_id);
Daniel Mack79f920f2010-05-31 14:51:31 +0200184 return -EINVAL;
185 }
186
187 /* first, see if the ID we're looking for is a clock source already */
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200188 source = snd_usb_find_clock_source(chip->ctrl_intf, entity_id);
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200189 if (source) {
190 entity_id = source->bClockID;
191 if (validate && !uac_clock_source_is_valid(chip, entity_id)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100192 usb_audio_err(chip,
193 "clock source %d is not valid, cannot use\n",
194 entity_id);
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200195 return -ENXIO;
196 }
197 return entity_id;
198 }
Daniel Mack79f920f2010-05-31 14:51:31 +0200199
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200200 selector = snd_usb_find_clock_selector(chip->ctrl_intf, entity_id);
Daniel Mack79f920f2010-05-31 14:51:31 +0200201 if (selector) {
Eldad Zack8c55af32013-04-03 23:18:55 +0200202 int ret, i, cur;
Daniel Mack79f920f2010-05-31 14:51:31 +0200203
204 /* the entity ID we are looking for is a selector.
205 * find out what it currently selects */
206 ret = uac_clock_selector_get_val(chip, selector->bClockID);
207 if (ret < 0)
208 return ret;
209
Daniel Mack157a57b2010-06-16 17:57:30 +0200210 /* Selector values are one-based */
211
Daniel Mack79f920f2010-05-31 14:51:31 +0200212 if (ret > selector->bNrInPins || ret < 1) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100213 usb_audio_err(chip,
Daniel Mack79f920f2010-05-31 14:51:31 +0200214 "%s(): selector reported illegal value, id %d, ret %d\n",
215 __func__, selector->bClockID, ret);
216
217 return -EINVAL;
218 }
219
Eldad Zack8c55af32013-04-03 23:18:55 +0200220 cur = ret;
221 ret = __uac_clock_find_source(chip, selector->baCSourceID[ret - 1],
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200222 visited, validate);
Eldad Zackef02e292013-04-03 23:18:56 +0200223 if (!validate || ret > 0 || !chip->autoclock)
Eldad Zack8c55af32013-04-03 23:18:55 +0200224 return ret;
225
226 /* The current clock source is invalid, try others. */
227 for (i = 1; i <= selector->bNrInPins; i++) {
228 int err;
229
230 if (i == cur)
231 continue;
232
233 ret = __uac_clock_find_source(chip, selector->baCSourceID[i - 1],
234 visited, true);
235 if (ret < 0)
236 continue;
237
238 err = uac_clock_selector_set_val(chip, entity_id, i);
239 if (err < 0)
240 continue;
241
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100242 usb_audio_info(chip,
243 "found and selected valid clock source %d\n",
244 ret);
Eldad Zack8c55af32013-04-03 23:18:55 +0200245 return ret;
246 }
247
248 return -ENXIO;
Daniel Mack79f920f2010-05-31 14:51:31 +0200249 }
250
251 /* FIXME: multipliers only act as pass-thru element for now */
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200252 multiplier = snd_usb_find_clock_multiplier(chip->ctrl_intf, entity_id);
Daniel Mack79f920f2010-05-31 14:51:31 +0200253 if (multiplier)
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200254 return __uac_clock_find_source(chip, multiplier->bCSourceID,
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200255 visited, validate);
Daniel Mack79f920f2010-05-31 14:51:31 +0200256
257 return -EINVAL;
258}
259
Daniel Mack157a57b2010-06-16 17:57:30 +0200260/*
261 * For all kinds of sample rate settings and other device queries,
262 * the clock source (end-leaf) must be used. However, clock selectors,
263 * clock multipliers and sample rate converters may be specified as
264 * clock source input to terminal. This functions walks the clock path
265 * to its end and tries to find the source.
266 *
267 * The 'visited' bitfield is used internally to detect recursive loops.
268 *
269 * Returns the clock source UnitID (>=0) on success, or an error.
270 */
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200271int snd_usb_clock_find_source(struct snd_usb_audio *chip, int entity_id,
272 bool validate)
Daniel Mack79f920f2010-05-31 14:51:31 +0200273{
274 DECLARE_BITMAP(visited, 256);
275 memset(visited, 0, sizeof(visited));
Eldad Zack06ffc1e2013-04-03 23:18:54 +0200276 return __uac_clock_find_source(chip, entity_id, visited, validate);
Daniel Mack79f920f2010-05-31 14:51:31 +0200277}
278
279static int set_sample_rate_v1(struct snd_usb_audio *chip, int iface,
280 struct usb_host_interface *alts,
281 struct audioformat *fmt, int rate)
282{
283 struct usb_device *dev = chip->dev;
284 unsigned int ep;
285 unsigned char data[3];
286 int err, crate;
287
288 ep = get_endpoint(alts, 0)->bEndpointAddress;
289
290 /* if endpoint doesn't have sampling rate control, bail out */
Clemens Ladischd32d5522010-07-08 16:38:01 +0200291 if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE))
Daniel Mack79f920f2010-05-31 14:51:31 +0200292 return 0;
Daniel Mack79f920f2010-05-31 14:51:31 +0200293
294 data[0] = rate;
295 data[1] = rate >> 8;
296 data[2] = rate >> 16;
297 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
298 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
299 UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200300 data, sizeof(data))) < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100301 dev_err(&dev->dev, "%d:%d: cannot set freq %d to ep %#x\n",
302 iface, fmt->altsetting, rate, ep);
Daniel Mack79f920f2010-05-31 14:51:31 +0200303 return err;
304 }
305
306 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR,
307 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN,
308 UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200309 data, sizeof(data))) < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100310 dev_err(&dev->dev, "%d:%d: cannot get freq at ep %#x\n",
311 iface, fmt->altsetting, ep);
Daniel Mack79f920f2010-05-31 14:51:31 +0200312 return 0; /* some devices don't support reading */
313 }
314
315 crate = data[0] | (data[1] << 8) | (data[2] << 16);
316 if (crate != rate) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100317 dev_warn(&dev->dev, "current rate %d is different from the runtime rate %d\n", crate, rate);
Daniel Mack79f920f2010-05-31 14:51:31 +0200318 // runtime->rate = crate;
319 }
320
321 return 0;
322}
323
Takashi Iwai7c5174652013-04-03 19:08:29 +0200324static int get_sample_rate_v2(struct snd_usb_audio *chip, int iface,
325 int altsetting, int clock)
326{
327 struct usb_device *dev = chip->dev;
Eldad Zackf6a8bc72013-04-03 23:18:53 +0200328 __le32 data;
Takashi Iwai7c5174652013-04-03 19:08:29 +0200329 int err;
330
331 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
332 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
333 UAC2_CS_CONTROL_SAM_FREQ << 8,
334 snd_usb_ctrl_intf(chip) | (clock << 8),
Eldad Zackf6a8bc72013-04-03 23:18:53 +0200335 &data, sizeof(data));
Takashi Iwai7c5174652013-04-03 19:08:29 +0200336 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100337 dev_warn(&dev->dev, "%d:%d: cannot get freq (v2): err %d\n",
338 iface, altsetting, err);
Takashi Iwai7c5174652013-04-03 19:08:29 +0200339 return 0;
340 }
341
Eldad Zackf6a8bc72013-04-03 23:18:53 +0200342 return le32_to_cpu(data);
Takashi Iwai7c5174652013-04-03 19:08:29 +0200343}
344
Daniel Mack79f920f2010-05-31 14:51:31 +0200345static int set_sample_rate_v2(struct snd_usb_audio *chip, int iface,
346 struct usb_host_interface *alts,
347 struct audioformat *fmt, int rate)
348{
349 struct usb_device *dev = chip->dev;
Eldad Zackf6a8bc72013-04-03 23:18:53 +0200350 __le32 data;
Torstein Hegge690a8632013-03-26 22:10:05 +0100351 int err, cur_rate, prev_rate;
Eldad Zack8c55af32013-04-03 23:18:55 +0200352 int clock;
Eldad Zack1dc669f2013-04-03 23:18:58 +0200353 bool writeable;
354 struct uac_clock_source_descriptor *cs_desc;
Daniel Mack79f920f2010-05-31 14:51:31 +0200355
Eldad Zack8c55af32013-04-03 23:18:55 +0200356 clock = snd_usb_clock_find_source(chip, fmt->clock, true);
Daniel Mack79f920f2010-05-31 14:51:31 +0200357 if (clock < 0)
358 return clock;
359
Takashi Iwai7c5174652013-04-03 19:08:29 +0200360 prev_rate = get_sample_rate_v2(chip, iface, fmt->altsetting, clock);
David Henningssonfa92dd72013-04-25 14:32:24 +0200361 if (prev_rate == rate)
362 return 0;
Torstein Hegge690a8632013-03-26 22:10:05 +0100363
Eldad Zack1dc669f2013-04-03 23:18:58 +0200364 cs_desc = snd_usb_find_clock_source(chip->ctrl_intf, clock);
365 writeable = uac2_control_is_writeable(cs_desc->bmControls, UAC2_CS_CONTROL_SAM_FREQ - 1);
366 if (writeable) {
367 data = cpu_to_le32(rate);
368 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
369 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
370 UAC2_CS_CONTROL_SAM_FREQ << 8,
371 snd_usb_ctrl_intf(chip) | (clock << 8),
372 &data, sizeof(data));
373 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100374 usb_audio_err(chip,
375 "%d:%d: cannot set freq %d (v2): err %d\n",
376 iface, fmt->altsetting, rate, err);
Eldad Zack1dc669f2013-04-03 23:18:58 +0200377 return err;
378 }
379
380 cur_rate = get_sample_rate_v2(chip, iface, fmt->altsetting, clock);
381 } else {
382 cur_rate = prev_rate;
Daniel Mack79f920f2010-05-31 14:51:31 +0200383 }
384
Torstein Hegge690a8632013-03-26 22:10:05 +0100385 if (cur_rate != rate) {
Eldad Zack1dc669f2013-04-03 23:18:58 +0200386 if (!writeable) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100387 usb_audio_warn(chip,
388 "%d:%d: freq mismatch (RO clock): req %d, clock runs @%d\n",
389 iface, fmt->altsetting, rate, cur_rate);
Eldad Zack1dc669f2013-04-03 23:18:58 +0200390 return -ENXIO;
391 }
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100392 usb_audio_dbg(chip,
393 "current rate %d is different from the runtime rate %d\n",
394 cur_rate, rate);
Torstein Hegge690a8632013-03-26 22:10:05 +0100395 }
396
397 /* Some devices doesn't respond to sample rate changes while the
398 * interface is active. */
399 if (rate != prev_rate) {
400 usb_set_interface(dev, iface, 0);
Daniel Mack21bb5aa2013-04-10 00:56:03 +0800401 snd_usb_set_interface_quirk(dev);
Torstein Hegge690a8632013-03-26 22:10:05 +0100402 usb_set_interface(dev, iface, fmt->altsetting);
Daniel Mack21bb5aa2013-04-10 00:56:03 +0800403 snd_usb_set_interface_quirk(dev);
Torstein Hegge690a8632013-03-26 22:10:05 +0100404 }
Daniel Mack79f920f2010-05-31 14:51:31 +0200405
406 return 0;
407}
408
409int snd_usb_init_sample_rate(struct snd_usb_audio *chip, int iface,
410 struct usb_host_interface *alts,
411 struct audioformat *fmt, int rate)
412{
Clemens Ladisch8f898e92013-01-31 21:39:17 +0100413 switch (fmt->protocol) {
Daniel Mack79f920f2010-05-31 14:51:31 +0200414 case UAC_VERSION_1:
Clemens Ladischa2acad82010-09-03 10:53:11 +0200415 default:
Daniel Mack79f920f2010-05-31 14:51:31 +0200416 return set_sample_rate_v1(chip, iface, alts, fmt, rate);
417
418 case UAC_VERSION_2:
419 return set_sample_rate_v2(chip, iface, alts, fmt, rate);
420 }
Daniel Mack79f920f2010-05-31 14:51:31 +0200421}
422