1 // SPDX-License-Identifier: GPL-2.0-only
3 * bebob_maudio.c - a part of driver for BeBoB based devices
5 * Copyright (c) 2013-2014 Takashi Sakamoto
9 #include <sound/control.h>
12 * Just powering on, Firewire 410/Audiophile/1814 and ProjectMix I/O wait to
13 * download firmware blob. To enable these devices, drivers should upload
14 * firmware blob and send a command to initialize configuration to factory
15 * settings when completing uploading. Then these devices generate bus reset
16 * and are recognized as new devices with the firmware.
18 * But with firmware version 5058 or later, the firmware is stored to flash
19 * memory in the device and drivers can tell bootloader to load the firmware
20 * by sending a cue. This cue must be sent one time.
22 * For streaming, both of output and input streams are needed for Firewire 410
23 * and Ozonic. The single stream is OK for the other devices even if the clock
24 * source is not SYT-Match (I note no devices use SYT-Match).
26 * Without streaming, the devices except for Firewire Audiophile can mix any
27 * input and output. For this reason, Audiophile cannot be used as standalone
30 * Firewire 1814 and ProjectMix I/O uses special firmware. It will be freezed
31 * when receiving any commands which the firmware can't understand. These
32 * devices utilize completely different system to control. It is some
33 * write-transaction directly into a certain address. All of addresses for mixer
34 * functionality is between 0xffc700700000 to 0xffc70070009c.
37 /* Offset from information register */
38 #define INFO_OFFSET_SW_DATE 0x20
40 /* Bootloader Protocol Version 1 */
41 #define MAUDIO_BOOTLOADER_CUE1 0x00000001
43 * Initializing configuration to factory settings (= 0x1101), (swapped in line),
44 * Command code is zero (= 0x00),
45 * the number of operands is zero (= 0x00)(at least significant byte)
47 #define MAUDIO_BOOTLOADER_CUE2 0x01110000
49 #define MAUDIO_BOOTLOADER_CUE3 0x00000000
51 #define MAUDIO_SPECIFIC_ADDRESS 0xffc700000000ULL
53 #define METER_OFFSET 0x00600000
55 /* some device has sync info after metering data */
56 #define METER_SIZE_SPECIAL 84 /* with sync info */
57 #define METER_SIZE_FW410 76 /* with sync info */
58 #define METER_SIZE_AUDIOPHILE 60 /* with sync info */
59 #define METER_SIZE_SOLO 52 /* with sync info */
60 #define METER_SIZE_OZONIC 48
61 #define METER_SIZE_NRV10 80
63 /* labels for metering */
64 #define ANA_IN "Analog In"
65 #define ANA_OUT "Analog Out"
66 #define DIG_IN "Digital In"
67 #define SPDIF_IN "S/PDIF In"
68 #define ADAT_IN "ADAT In"
69 #define DIG_OUT "Digital Out"
70 #define SPDIF_OUT "S/PDIF Out"
71 #define ADAT_OUT "ADAT Out"
72 #define STRM_IN "Stream In"
73 #define AUX_OUT "Aux Out"
74 #define HP_OUT "HP Out"
76 #define UNKNOWN_METER "Unknown"
78 struct special_params {
81 unsigned int dig_in_fmt;
82 unsigned int dig_out_fmt;
83 unsigned int clk_lock;
84 struct snd_ctl_elem_id *ctl_id_sync;
88 * For some M-Audio devices, this module just send cue to load firmware. After
89 * loading, the device generates bus reset and newly detected.
91 * If we make any transactions to load firmware, the operation may failed.
93 int snd_bebob_maudio_load_firmware(struct fw_unit *unit)
95 struct fw_device *device = fw_parent_device(unit);
100 /* check date of software used to build */
101 err = snd_bebob_read_block(unit, INFO_OFFSET_SW_DATE,
106 * firmware version 5058 or later has date later than "20070401", but
107 * 'date' is not null-terminated.
109 if (date < 0x3230303730343031LL) {
110 dev_err(&unit->device,
111 "Use firmware version 5058 or later\n");
115 cues = kmalloc_array(3, sizeof(*cues), GFP_KERNEL);
119 cues[0] = cpu_to_le32(MAUDIO_BOOTLOADER_CUE1);
120 cues[1] = cpu_to_le32(MAUDIO_BOOTLOADER_CUE2);
121 cues[2] = cpu_to_le32(MAUDIO_BOOTLOADER_CUE3);
123 rcode = fw_run_transaction(device->card, TCODE_WRITE_BLOCK_REQUEST,
124 device->node_id, device->generation,
125 device->max_speed, BEBOB_ADDR_REG_REQ,
126 cues, 3 * sizeof(*cues));
128 if (rcode != RCODE_COMPLETE) {
129 dev_err(&unit->device,
130 "Failed to send a cue to load firmware\n");
138 get_meter(struct snd_bebob *bebob, void *buf, unsigned int size)
140 return snd_fw_transaction(bebob->unit, TCODE_READ_BLOCK_REQUEST,
141 MAUDIO_SPECIFIC_ADDRESS + METER_OFFSET,
146 check_clk_sync(struct snd_bebob *bebob, unsigned int size, bool *sync)
151 buf = kmalloc(size, GFP_KERNEL);
155 err = get_meter(bebob, buf, size);
159 /* if synced, this value is the same as SFC of FDF in CIP header */
160 *sync = (buf[size - 2] != 0xff);
167 * dig_fmt: 0x00:S/PDIF, 0x01:ADAT
168 * clk_lock: 0x00:unlock, 0x01:lock
171 avc_maudio_set_special_clk(struct snd_bebob *bebob, unsigned int clk_src,
172 unsigned int dig_in_fmt, unsigned int dig_out_fmt,
173 unsigned int clk_lock)
175 struct special_params *params = bebob->maudio_special_quirk;
179 if (amdtp_stream_running(&bebob->rx_stream) ||
180 amdtp_stream_running(&bebob->tx_stream))
183 buf = kmalloc(12, GFP_KERNEL);
187 buf[0] = 0x00; /* CONTROL */
188 buf[1] = 0xff; /* UNIT */
189 buf[2] = 0x00; /* vendor dependent */
190 buf[3] = 0x04; /* company ID high */
191 buf[4] = 0x00; /* company ID middle */
192 buf[5] = 0x04; /* company ID low */
193 buf[6] = 0xff & clk_src; /* clock source */
194 buf[7] = 0xff & dig_in_fmt; /* input digital format */
195 buf[8] = 0xff & dig_out_fmt; /* output digital format */
196 buf[9] = 0xff & clk_lock; /* lock these settings */
197 buf[10] = 0x00; /* padding */
198 buf[11] = 0x00; /* padding */
200 err = fcp_avc_transaction(bebob->unit, buf, 12, buf, 12,
201 BIT(1) | BIT(2) | BIT(3) | BIT(4) |
202 BIT(5) | BIT(6) | BIT(7) | BIT(8) |
204 if ((err > 0) && (err < 10))
206 else if (buf[0] == 0x08) /* NOT IMPLEMENTED */
208 else if (buf[0] == 0x0a) /* REJECTED */
213 params->clk_src = buf[6];
214 params->dig_in_fmt = buf[7];
215 params->dig_out_fmt = buf[8];
216 params->clk_lock = buf[9];
218 if (params->ctl_id_sync)
219 snd_ctl_notify(bebob->card, SNDRV_CTL_EVENT_MASK_VALUE,
220 params->ctl_id_sync);
228 special_stream_formation_set(struct snd_bebob *bebob)
230 static const unsigned int ch_table[2][2][3] = {
231 /* AMDTP_OUT_STREAM */
232 { { 6, 6, 4 }, /* SPDIF */
233 { 12, 8, 4 } }, /* ADAT */
234 /* AMDTP_IN_STREAM */
235 { { 10, 10, 2 }, /* SPDIF */
236 { 16, 12, 2 } } /* ADAT */
238 struct special_params *params = bebob->maudio_special_quirk;
241 max = SND_BEBOB_STRM_FMT_ENTRIES - 1;
245 for (i = 0; i < max; i++) {
246 bebob->tx_stream_formations[i + 1].pcm =
247 ch_table[AMDTP_IN_STREAM][params->dig_in_fmt][i / 2];
248 bebob->tx_stream_formations[i + 1].midi = 1;
250 bebob->rx_stream_formations[i + 1].pcm =
251 ch_table[AMDTP_OUT_STREAM][params->dig_out_fmt][i / 2];
252 bebob->rx_stream_formations[i + 1].midi = 1;
256 static int add_special_controls(struct snd_bebob *bebob);
258 snd_bebob_maudio_special_discover(struct snd_bebob *bebob, bool is1814)
260 struct special_params *params;
263 params = devm_kzalloc(&bebob->card->card_dev,
264 sizeof(struct special_params), GFP_KERNEL);
268 mutex_lock(&bebob->mutex);
270 bebob->maudio_special_quirk = (void *)params;
271 params->is1814 = is1814;
273 /* initialize these parameters because driver is not allowed to ask */
274 bebob->rx_stream.context = ERR_PTR(-1);
275 bebob->tx_stream.context = ERR_PTR(-1);
276 err = avc_maudio_set_special_clk(bebob, 0x03, 0x00, 0x00, 0x00);
278 dev_err(&bebob->unit->device,
279 "fail to initialize clock params: %d\n", err);
283 err = add_special_controls(bebob);
287 special_stream_formation_set(bebob);
289 if (params->is1814) {
290 bebob->midi_input_ports = 1;
291 bebob->midi_output_ports = 1;
293 bebob->midi_input_ports = 2;
294 bebob->midi_output_ports = 2;
297 mutex_unlock(&bebob->mutex);
301 /* Input plug shows actual rate. Output plug is needless for this purpose. */
302 static int special_get_rate(struct snd_bebob *bebob, unsigned int *rate)
308 err = avc_general_get_sig_fmt(bebob->unit, rate,
309 AVC_GENERAL_PLUG_DIR_IN, 0);
310 } while (err == -EAGAIN && ++trials < 3);
314 static int special_set_rate(struct snd_bebob *bebob, unsigned int rate)
316 struct special_params *params = bebob->maudio_special_quirk;
319 err = avc_general_set_sig_fmt(bebob->unit, rate,
320 AVC_GENERAL_PLUG_DIR_OUT, 0);
325 * Just after changing sampling rate for output, a followed command
326 * for input is easy to fail. This is a workaround fot this issue.
330 err = avc_general_set_sig_fmt(bebob->unit, rate,
331 AVC_GENERAL_PLUG_DIR_IN, 0);
335 if (params->ctl_id_sync)
336 snd_ctl_notify(bebob->card, SNDRV_CTL_EVENT_MASK_VALUE,
337 params->ctl_id_sync);
342 /* Clock source control for special firmware */
343 static const enum snd_bebob_clock_type special_clk_types[] = {
344 SND_BEBOB_CLOCK_TYPE_INTERNAL, /* With digital mute */
345 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* SPDIF/ADAT */
346 SND_BEBOB_CLOCK_TYPE_EXTERNAL, /* Word Clock */
347 SND_BEBOB_CLOCK_TYPE_INTERNAL,
349 static int special_clk_get(struct snd_bebob *bebob, unsigned int *id)
351 struct special_params *params = bebob->maudio_special_quirk;
352 *id = params->clk_src;
355 static int special_clk_ctl_info(struct snd_kcontrol *kctl,
356 struct snd_ctl_elem_info *einf)
358 static const char *const special_clk_labels[] = {
359 "Internal with Digital Mute",
364 return snd_ctl_enum_info(einf, 1, ARRAY_SIZE(special_clk_types),
367 static int special_clk_ctl_get(struct snd_kcontrol *kctl,
368 struct snd_ctl_elem_value *uval)
370 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
371 struct special_params *params = bebob->maudio_special_quirk;
372 uval->value.enumerated.item[0] = params->clk_src;
375 static int special_clk_ctl_put(struct snd_kcontrol *kctl,
376 struct snd_ctl_elem_value *uval)
378 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
379 struct special_params *params = bebob->maudio_special_quirk;
382 id = uval->value.enumerated.item[0];
383 if (id >= ARRAY_SIZE(special_clk_types))
386 mutex_lock(&bebob->mutex);
388 err = avc_maudio_set_special_clk(bebob, id,
392 mutex_unlock(&bebob->mutex);
399 static const struct snd_kcontrol_new special_clk_ctl = {
400 .name = "Clock Source",
401 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
402 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
403 .info = special_clk_ctl_info,
404 .get = special_clk_ctl_get,
405 .put = special_clk_ctl_put
408 /* Clock synchronization control for special firmware */
409 static int special_sync_ctl_info(struct snd_kcontrol *kctl,
410 struct snd_ctl_elem_info *einf)
412 einf->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
414 einf->value.integer.min = 0;
415 einf->value.integer.max = 1;
419 static int special_sync_ctl_get(struct snd_kcontrol *kctl,
420 struct snd_ctl_elem_value *uval)
422 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
426 err = check_clk_sync(bebob, METER_SIZE_SPECIAL, &synced);
428 uval->value.integer.value[0] = synced;
432 static const struct snd_kcontrol_new special_sync_ctl = {
433 .name = "Sync Status",
434 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
435 .access = SNDRV_CTL_ELEM_ACCESS_READ,
436 .info = special_sync_ctl_info,
437 .get = special_sync_ctl_get,
440 /* Digital input interface control for special firmware */
441 static const char *const special_dig_in_iface_labels[] = {
442 "S/PDIF Optical", "S/PDIF Coaxial", "ADAT Optical"
444 static int special_dig_in_iface_ctl_info(struct snd_kcontrol *kctl,
445 struct snd_ctl_elem_info *einf)
447 return snd_ctl_enum_info(einf, 1,
448 ARRAY_SIZE(special_dig_in_iface_labels),
449 special_dig_in_iface_labels);
451 static int special_dig_in_iface_ctl_get(struct snd_kcontrol *kctl,
452 struct snd_ctl_elem_value *uval)
454 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
455 struct special_params *params = bebob->maudio_special_quirk;
456 unsigned int dig_in_iface;
459 mutex_lock(&bebob->mutex);
461 err = avc_audio_get_selector(bebob->unit, 0x00, 0x04,
464 dev_err(&bebob->unit->device,
465 "fail to get digital input interface: %d\n", err);
469 /* encoded id for user value */
470 val = (params->dig_in_fmt << 1) | (dig_in_iface & 0x01);
472 /* for ADAT Optical */
476 uval->value.enumerated.item[0] = val;
478 mutex_unlock(&bebob->mutex);
481 static int special_dig_in_iface_ctl_set(struct snd_kcontrol *kctl,
482 struct snd_ctl_elem_value *uval)
484 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
485 struct special_params *params = bebob->maudio_special_quirk;
486 unsigned int id, dig_in_fmt, dig_in_iface;
489 id = uval->value.enumerated.item[0];
490 if (id >= ARRAY_SIZE(special_dig_in_iface_labels))
493 /* decode user value */
494 dig_in_fmt = (id >> 1) & 0x01;
495 dig_in_iface = id & 0x01;
497 mutex_lock(&bebob->mutex);
499 err = avc_maudio_set_special_clk(bebob,
507 /* For ADAT, optical interface is only available. */
508 if (params->dig_in_fmt > 0) {
513 /* For S/PDIF, optical/coaxial interfaces are selectable. */
514 err = avc_audio_set_selector(bebob->unit, 0x00, 0x04, dig_in_iface);
516 dev_err(&bebob->unit->device,
517 "fail to set digital input interface: %d\n", err);
520 special_stream_formation_set(bebob);
521 mutex_unlock(&bebob->mutex);
524 static const struct snd_kcontrol_new special_dig_in_iface_ctl = {
525 .name = "Digital Input Interface",
526 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
527 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
528 .info = special_dig_in_iface_ctl_info,
529 .get = special_dig_in_iface_ctl_get,
530 .put = special_dig_in_iface_ctl_set
533 /* Digital output interface control for special firmware */
534 static const char *const special_dig_out_iface_labels[] = {
535 "S/PDIF Optical and Coaxial", "ADAT Optical"
537 static int special_dig_out_iface_ctl_info(struct snd_kcontrol *kctl,
538 struct snd_ctl_elem_info *einf)
540 return snd_ctl_enum_info(einf, 1,
541 ARRAY_SIZE(special_dig_out_iface_labels),
542 special_dig_out_iface_labels);
544 static int special_dig_out_iface_ctl_get(struct snd_kcontrol *kctl,
545 struct snd_ctl_elem_value *uval)
547 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
548 struct special_params *params = bebob->maudio_special_quirk;
549 mutex_lock(&bebob->mutex);
550 uval->value.enumerated.item[0] = params->dig_out_fmt;
551 mutex_unlock(&bebob->mutex);
554 static int special_dig_out_iface_ctl_set(struct snd_kcontrol *kctl,
555 struct snd_ctl_elem_value *uval)
557 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
558 struct special_params *params = bebob->maudio_special_quirk;
562 id = uval->value.enumerated.item[0];
563 if (id >= ARRAY_SIZE(special_dig_out_iface_labels))
566 mutex_lock(&bebob->mutex);
568 err = avc_maudio_set_special_clk(bebob,
571 id, params->clk_lock);
573 special_stream_formation_set(bebob);
577 mutex_unlock(&bebob->mutex);
580 static const struct snd_kcontrol_new special_dig_out_iface_ctl = {
581 .name = "Digital Output Interface",
582 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
583 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
584 .info = special_dig_out_iface_ctl_info,
585 .get = special_dig_out_iface_ctl_get,
586 .put = special_dig_out_iface_ctl_set
589 static int add_special_controls(struct snd_bebob *bebob)
591 struct snd_kcontrol *kctl;
592 struct special_params *params = bebob->maudio_special_quirk;
595 kctl = snd_ctl_new1(&special_clk_ctl, bebob);
596 err = snd_ctl_add(bebob->card, kctl);
600 kctl = snd_ctl_new1(&special_sync_ctl, bebob);
601 err = snd_ctl_add(bebob->card, kctl);
604 params->ctl_id_sync = &kctl->id;
606 kctl = snd_ctl_new1(&special_dig_in_iface_ctl, bebob);
607 err = snd_ctl_add(bebob->card, kctl);
611 kctl = snd_ctl_new1(&special_dig_out_iface_ctl, bebob);
612 err = snd_ctl_add(bebob->card, kctl);
617 /* Hardware metering for special firmware */
618 static const char *const special_meter_labels[] = {
619 ANA_IN, ANA_IN, ANA_IN, ANA_IN,
621 ADAT_IN, ADAT_IN, ADAT_IN, ADAT_IN,
624 ADAT_OUT, ADAT_OUT, ADAT_OUT, ADAT_OUT,
629 special_meter_get(struct snd_bebob *bebob, u32 *target, unsigned int size)
632 unsigned int i, c, channels;
635 channels = ARRAY_SIZE(special_meter_labels) * 2;
636 if (size < channels * sizeof(u32))
639 /* omit last 4 bytes because it's clock info. */
640 buf = kmalloc(METER_SIZE_SPECIAL - 4, GFP_KERNEL);
644 err = get_meter(bebob, (void *)buf, METER_SIZE_SPECIAL - 4);
648 /* Its format is u16 and some channels are unknown. */
650 for (c = 2; c < channels + 2; c++)
651 target[i++] = be16_to_cpu(buf[c]) << 16;
657 /* last 4 bytes are omitted because it's clock info. */
658 static const char *const fw410_meter_labels[] = {
660 ANA_OUT, ANA_OUT, ANA_OUT, ANA_OUT, DIG_OUT,
663 static const char *const audiophile_meter_labels[] = {
665 ANA_OUT, ANA_OUT, DIG_OUT,
668 static const char *const solo_meter_labels[] = {
675 static const char *const ozonic_meter_labels[] = {
680 /* TODO: need testers. these positions are based on authour's assumption */
681 static const char *const nrv10_meter_labels[] = {
682 ANA_IN, ANA_IN, ANA_IN, ANA_IN,
684 ANA_OUT, ANA_OUT, ANA_OUT, ANA_OUT,
688 normal_meter_get(struct snd_bebob *bebob, u32 *buf, unsigned int size)
690 const struct snd_bebob_meter_spec *spec = bebob->spec->meter;
691 unsigned int c, channels;
694 channels = spec->num * 2;
695 if (size < channels * sizeof(u32))
698 err = get_meter(bebob, (void *)buf, size);
702 for (c = 0; c < channels; c++)
703 be32_to_cpus(&buf[c]);
705 /* swap stream channels because inverted */
706 if (spec->labels == solo_meter_labels) {
707 swap(buf[4], buf[6]);
708 swap(buf[5], buf[7]);
714 /* for special customized devices */
715 static const struct snd_bebob_rate_spec special_rate_spec = {
716 .get = &special_get_rate,
717 .set = &special_set_rate,
719 static const struct snd_bebob_clock_spec special_clk_spec = {
720 .num = ARRAY_SIZE(special_clk_types),
721 .types = special_clk_types,
722 .get = &special_clk_get,
724 static const struct snd_bebob_meter_spec special_meter_spec = {
725 .num = ARRAY_SIZE(special_meter_labels),
726 .labels = special_meter_labels,
727 .get = &special_meter_get
729 const struct snd_bebob_spec maudio_special_spec = {
730 .clock = &special_clk_spec,
731 .rate = &special_rate_spec,
732 .meter = &special_meter_spec
735 /* Firewire 410 specification */
736 static const struct snd_bebob_rate_spec usual_rate_spec = {
737 .get = &snd_bebob_stream_get_rate,
738 .set = &snd_bebob_stream_set_rate,
740 static const struct snd_bebob_meter_spec fw410_meter_spec = {
741 .num = ARRAY_SIZE(fw410_meter_labels),
742 .labels = fw410_meter_labels,
743 .get = &normal_meter_get
745 const struct snd_bebob_spec maudio_fw410_spec = {
747 .rate = &usual_rate_spec,
748 .meter = &fw410_meter_spec
751 /* Firewire Audiophile specification */
752 static const struct snd_bebob_meter_spec audiophile_meter_spec = {
753 .num = ARRAY_SIZE(audiophile_meter_labels),
754 .labels = audiophile_meter_labels,
755 .get = &normal_meter_get
757 const struct snd_bebob_spec maudio_audiophile_spec = {
759 .rate = &usual_rate_spec,
760 .meter = &audiophile_meter_spec
763 /* Firewire Solo specification */
764 static const struct snd_bebob_meter_spec solo_meter_spec = {
765 .num = ARRAY_SIZE(solo_meter_labels),
766 .labels = solo_meter_labels,
767 .get = &normal_meter_get
769 const struct snd_bebob_spec maudio_solo_spec = {
771 .rate = &usual_rate_spec,
772 .meter = &solo_meter_spec
775 /* Ozonic specification */
776 static const struct snd_bebob_meter_spec ozonic_meter_spec = {
777 .num = ARRAY_SIZE(ozonic_meter_labels),
778 .labels = ozonic_meter_labels,
779 .get = &normal_meter_get
781 const struct snd_bebob_spec maudio_ozonic_spec = {
783 .rate = &usual_rate_spec,
784 .meter = &ozonic_meter_spec
787 /* NRV10 specification */
788 static const struct snd_bebob_meter_spec nrv10_meter_spec = {
789 .num = ARRAY_SIZE(nrv10_meter_labels),
790 .labels = nrv10_meter_labels,
791 .get = &normal_meter_get
793 const struct snd_bebob_spec maudio_nrv10_spec = {
795 .rate = &usual_rate_spec,
796 .meter = &nrv10_meter_spec