2 * bebob_focusrite.c - a part of driver for BeBoB based devices
4 * Copyright (c) 2013-2014 Takashi Sakamoto
6 * Licensed under the terms of the GNU General Public License, version 2.
11 #define ANA_IN "Analog In"
12 #define DIG_IN "Digital In"
13 #define ANA_OUT "Analog Out"
14 #define DIG_OUT "Digital Out"
15 #define STM_IN "Stream In"
17 #define SAFFIRE_ADDRESS_BASE 0x000100000000ULL
19 #define SAFFIRE_OFFSET_CLOCK_SOURCE 0x00f8
20 #define SAFFIREPRO_OFFSET_CLOCK_SOURCE 0x0174
22 /* whether sync to external device or not */
23 #define SAFFIRE_OFFSET_CLOCK_SYNC_EXT 0x013c
24 #define SAFFIRE_LE_OFFSET_CLOCK_SYNC_EXT 0x0432
25 #define SAFFIREPRO_OFFSET_CLOCK_SYNC_EXT 0x0164
27 #define SAFFIRE_CLOCK_SOURCE_INTERNAL 0
28 #define SAFFIRE_CLOCK_SOURCE_SPDIF 1
30 /* clock sources as returned from register of Saffire Pro 10 and 26 */
31 #define SAFFIREPRO_CLOCK_SOURCE_SELECT_MASK 0x000000ff
32 #define SAFFIREPRO_CLOCK_SOURCE_DETECT_MASK 0x0000ff00
33 #define SAFFIREPRO_CLOCK_SOURCE_INTERNAL 0
34 #define SAFFIREPRO_CLOCK_SOURCE_SKIP 1 /* never used on hardware */
35 #define SAFFIREPRO_CLOCK_SOURCE_SPDIF 2
36 #define SAFFIREPRO_CLOCK_SOURCE_ADAT1 3 /* not used on s.pro. 10 */
37 #define SAFFIREPRO_CLOCK_SOURCE_ADAT2 4 /* not used on s.pro. 10 */
38 #define SAFFIREPRO_CLOCK_SOURCE_WORDCLOCK 5
39 #define SAFFIREPRO_CLOCK_SOURCE_COUNT 6
41 /* S/PDIF, ADAT1, ADAT2 is enabled or not. three quadlets */
42 #define SAFFIREPRO_ENABLE_DIG_IFACES 0x01a4
44 /* saffirepro has its own parameter for sampling frequency */
45 #define SAFFIREPRO_RATE_NOREBOOT 0x01cc
46 /* index is the value for this register */
47 static const unsigned int rates[] = {
57 /* saffire(no label)/saffire LE has metering */
58 #define SAFFIRE_OFFSET_METER 0x0100
59 #define SAFFIRE_LE_OFFSET_METER 0x0168
62 saffire_read_block(struct snd_bebob *bebob, u64 offset,
63 u32 *buf, unsigned int size)
67 __be32 *tmp = (__be32 *)buf;
69 err = snd_fw_transaction(bebob->unit, TCODE_READ_BLOCK_REQUEST,
70 SAFFIRE_ADDRESS_BASE + offset,
75 for (i = 0; i < size / sizeof(u32); i++)
76 buf[i] = be32_to_cpu(tmp[i]);
82 saffire_read_quad(struct snd_bebob *bebob, u64 offset, u32 *value)
87 err = snd_fw_transaction(bebob->unit, TCODE_READ_QUADLET_REQUEST,
88 SAFFIRE_ADDRESS_BASE + offset,
89 &tmp, sizeof(__be32), 0);
93 *value = be32_to_cpu(tmp);
99 saffire_write_quad(struct snd_bebob *bebob, u64 offset, u32 value)
101 __be32 data = cpu_to_be32(value);
103 return snd_fw_transaction(bebob->unit, TCODE_WRITE_QUADLET_REQUEST,
104 SAFFIRE_ADDRESS_BASE + offset,
105 &data, sizeof(__be32), 0);
108 static const enum snd_bebob_clock_type saffirepro_10_clk_src_types[] = {
109 SND_BEBOB_CLOCK_TYPE_INTERNAL,
110 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* S/PDIF */
111 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* Word Clock */
113 static const enum snd_bebob_clock_type saffirepro_26_clk_src_types[] = {
114 SND_BEBOB_CLOCK_TYPE_INTERNAL,
115 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* S/PDIF */
116 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* ADAT1 */
117 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* ADAT2 */
118 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* Word Clock */
120 /* Value maps between registers and labels for SaffirePro 10/26. */
121 static const signed char saffirepro_clk_maps[][SAFFIREPRO_CLOCK_SOURCE_COUNT] = {
124 [SAFFIREPRO_CLOCK_SOURCE_INTERNAL] = 0,
125 [SAFFIREPRO_CLOCK_SOURCE_SKIP] = -1, /* not supported */
126 [SAFFIREPRO_CLOCK_SOURCE_SPDIF] = 1,
127 [SAFFIREPRO_CLOCK_SOURCE_ADAT1] = -1, /* not supported */
128 [SAFFIREPRO_CLOCK_SOURCE_ADAT2] = -1, /* not supported */
129 [SAFFIREPRO_CLOCK_SOURCE_WORDCLOCK] = 2,
133 [SAFFIREPRO_CLOCK_SOURCE_INTERNAL] = 0,
134 [SAFFIREPRO_CLOCK_SOURCE_SKIP] = -1, /* not supported */
135 [SAFFIREPRO_CLOCK_SOURCE_SPDIF] = 1,
136 [SAFFIREPRO_CLOCK_SOURCE_ADAT1] = 2,
137 [SAFFIREPRO_CLOCK_SOURCE_ADAT2] = 3,
138 [SAFFIREPRO_CLOCK_SOURCE_WORDCLOCK] = 4,
143 saffirepro_both_clk_freq_get(struct snd_bebob *bebob, unsigned int *rate)
148 err = saffire_read_quad(bebob, SAFFIREPRO_RATE_NOREBOOT, &id);
151 if (id >= ARRAY_SIZE(rates))
159 saffirepro_both_clk_freq_set(struct snd_bebob *bebob, unsigned int rate)
163 for (id = 0; id < ARRAY_SIZE(rates); id++) {
164 if (rates[id] == rate)
167 if (id == ARRAY_SIZE(rates))
170 return saffire_write_quad(bebob, SAFFIREPRO_RATE_NOREBOOT, id);
174 * query hardware for current clock source, return our internally
175 * used clock index in *id, depending on hardware.
178 saffirepro_both_clk_src_get(struct snd_bebob *bebob, unsigned int *id)
181 u32 value; /* clock source read from hw register */
182 const signed char *map;
184 err = saffire_read_quad(bebob, SAFFIREPRO_OFFSET_CLOCK_SOURCE, &value);
188 /* depending on hardware, use a different mapping */
189 if (bebob->spec->clock->types == saffirepro_10_clk_src_types)
190 map = saffirepro_clk_maps[0];
192 map = saffirepro_clk_maps[1];
194 /* In a case that this driver cannot handle the value of register. */
195 value &= SAFFIREPRO_CLOCK_SOURCE_SELECT_MASK;
196 if (value >= SAFFIREPRO_CLOCK_SOURCE_COUNT || map[value] < 0) {
201 *id = (unsigned int)map[value];
206 const struct snd_bebob_spec saffire_le_spec;
207 static const enum snd_bebob_clock_type saffire_both_clk_src_types[] = {
208 SND_BEBOB_CLOCK_TYPE_INTERNAL,
209 SND_BEBOB_CLOCK_TYPE_EXTERNAL,
212 saffire_both_clk_src_get(struct snd_bebob *bebob, unsigned int *id)
217 err = saffire_read_quad(bebob, SAFFIRE_OFFSET_CLOCK_SOURCE, &value);
223 static const char *const saffire_le_meter_labels[] = {
224 ANA_IN, ANA_IN, DIG_IN,
225 ANA_OUT, ANA_OUT, ANA_OUT, ANA_OUT,
228 static const char *const saffire_meter_labels[] = {
230 STM_IN, STM_IN, STM_IN, STM_IN, STM_IN,
233 saffire_meter_get(struct snd_bebob *bebob, u32 *buf, unsigned int size)
235 const struct snd_bebob_meter_spec *spec = bebob->spec->meter;
236 unsigned int channels;
240 if (spec->labels == saffire_le_meter_labels)
241 offset = SAFFIRE_LE_OFFSET_METER;
243 offset = SAFFIRE_OFFSET_METER;
245 channels = spec->num * 2;
246 if (size < channels * sizeof(u32))
249 err = saffire_read_block(bebob, offset, buf, size);
250 if (err >= 0 && spec->labels == saffire_le_meter_labels) {
251 swap(buf[1], buf[3]);
252 swap(buf[2], buf[3]);
253 swap(buf[3], buf[4]);
255 swap(buf[7], buf[10]);
256 swap(buf[8], buf[10]);
257 swap(buf[9], buf[11]);
258 swap(buf[11], buf[12]);
260 swap(buf[15], buf[16]);
266 static const struct snd_bebob_rate_spec saffirepro_both_rate_spec = {
267 .get = &saffirepro_both_clk_freq_get,
268 .set = &saffirepro_both_clk_freq_set,
270 /* Saffire Pro 26 I/O */
271 static const struct snd_bebob_clock_spec saffirepro_26_clk_spec = {
272 .num = ARRAY_SIZE(saffirepro_26_clk_src_types),
273 .types = saffirepro_26_clk_src_types,
274 .get = &saffirepro_both_clk_src_get,
276 const struct snd_bebob_spec saffirepro_26_spec = {
277 .clock = &saffirepro_26_clk_spec,
278 .rate = &saffirepro_both_rate_spec,
281 /* Saffire Pro 10 I/O */
282 static const struct snd_bebob_clock_spec saffirepro_10_clk_spec = {
283 .num = ARRAY_SIZE(saffirepro_10_clk_src_types),
284 .types = saffirepro_10_clk_src_types,
285 .get = &saffirepro_both_clk_src_get,
287 const struct snd_bebob_spec saffirepro_10_spec = {
288 .clock = &saffirepro_10_clk_spec,
289 .rate = &saffirepro_both_rate_spec,
293 static const struct snd_bebob_rate_spec saffire_both_rate_spec = {
294 .get = &snd_bebob_stream_get_rate,
295 .set = &snd_bebob_stream_set_rate,
297 static const struct snd_bebob_clock_spec saffire_both_clk_spec = {
298 .num = ARRAY_SIZE(saffire_both_clk_src_types),
299 .types = saffire_both_clk_src_types,
300 .get = &saffire_both_clk_src_get,
303 static const struct snd_bebob_meter_spec saffire_le_meter_spec = {
304 .num = ARRAY_SIZE(saffire_le_meter_labels),
305 .labels = saffire_le_meter_labels,
306 .get = &saffire_meter_get,
308 const struct snd_bebob_spec saffire_le_spec = {
309 .clock = &saffire_both_clk_spec,
310 .rate = &saffire_both_rate_spec,
311 .meter = &saffire_le_meter_spec
314 static const struct snd_bebob_meter_spec saffire_meter_spec = {
315 .num = ARRAY_SIZE(saffire_meter_labels),
316 .labels = saffire_meter_labels,
317 .get = &saffire_meter_get,
319 const struct snd_bebob_spec saffire_spec = {
320 .clock = &saffire_both_clk_spec,
321 .rate = &saffire_both_rate_spec,
322 .meter = &saffire_meter_spec