2 * bebob_maudio.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.
10 #include <sound/control.h>
13 * Just powering on, Firewire 410/Audiophile/1814 and ProjectMix I/O wait to
14 * download firmware blob. To enable these devices, drivers should upload
15 * firmware blob and send a command to initialize configuration to factory
16 * settings when completing uploading. Then these devices generate bus reset
17 * and are recognized as new devices with the firmware.
19 * But with firmware version 5058 or later, the firmware is stored to flash
20 * memory in the device and drivers can tell bootloader to load the firmware
21 * by sending a cue. This cue must be sent one time.
23 * For streaming, both of output and input streams are needed for Firewire 410
24 * and Ozonic. The single stream is OK for the other devices even if the clock
25 * source is not SYT-Match (I note no devices use SYT-Match).
27 * Without streaming, the devices except for Firewire Audiophile can mix any
28 * input and output. For this reason, Audiophile cannot be used as standalone
31 * Firewire 1814 and ProjectMix I/O uses special firmware. It will be freezed
32 * when receiving any commands which the firmware can't understand. These
33 * devices utilize completely different system to control. It is some
34 * write-transaction directly into a certain address. All of addresses for mixer
35 * functionality is between 0xffc700700000 to 0xffc70070009c.
38 /* Offset from information register */
39 #define INFO_OFFSET_SW_DATE 0x20
41 /* Bootloader Protocol Version 1 */
42 #define MAUDIO_BOOTLOADER_CUE1 0x00000001
44 * Initializing configuration to factory settings (= 0x1101), (swapped in line),
45 * Command code is zero (= 0x00),
46 * the number of operands is zero (= 0x00)(at least significant byte)
48 #define MAUDIO_BOOTLOADER_CUE2 0x01110000
50 #define MAUDIO_BOOTLOADER_CUE3 0x00000000
52 #define MAUDIO_SPECIFIC_ADDRESS 0xffc700000000ULL
54 #define METER_OFFSET 0x00600000
56 /* some device has sync info after metering data */
57 #define METER_SIZE_SPECIAL 84 /* with sync info */
58 #define METER_SIZE_FW410 76 /* with sync info */
59 #define METER_SIZE_AUDIOPHILE 60 /* with sync info */
60 #define METER_SIZE_SOLO 52 /* with sync info */
61 #define METER_SIZE_OZONIC 48
62 #define METER_SIZE_NRV10 80
64 /* labels for metering */
65 #define ANA_IN "Analog In"
66 #define ANA_OUT "Analog Out"
67 #define DIG_IN "Digital In"
68 #define SPDIF_IN "S/PDIF In"
69 #define ADAT_IN "ADAT In"
70 #define DIG_OUT "Digital Out"
71 #define SPDIF_OUT "S/PDIF Out"
72 #define ADAT_OUT "ADAT Out"
73 #define STRM_IN "Stream In"
74 #define AUX_OUT "Aux Out"
75 #define HP_OUT "HP Out"
77 #define UNKNOWN_METER "Unknown"
79 struct special_params {
82 unsigned int dig_in_fmt;
83 unsigned int dig_out_fmt;
84 unsigned int clk_lock;
85 struct snd_ctl_elem_id *ctl_id_sync;
89 * For some M-Audio devices, this module just send cue to load firmware. After
90 * loading, the device generates bus reset and newly detected.
92 * If we make any transactions to load firmware, the operation may failed.
94 int snd_bebob_maudio_load_firmware(struct fw_unit *unit)
96 struct fw_device *device = fw_parent_device(unit);
100 MAUDIO_BOOTLOADER_CUE1,
101 MAUDIO_BOOTLOADER_CUE2,
102 MAUDIO_BOOTLOADER_CUE3
105 /* check date of software used to build */
106 err = snd_bebob_read_block(unit, INFO_OFFSET_SW_DATE,
111 * firmware version 5058 or later has date later than "20070401", but
112 * 'date' is not null-terminated.
114 if (date < 0x3230303730343031LL) {
115 dev_err(&unit->device,
116 "Use firmware version 5058 or later\n");
121 rcode = fw_run_transaction(device->card, TCODE_WRITE_BLOCK_REQUEST,
122 device->node_id, device->generation,
123 device->max_speed, BEBOB_ADDR_REG_REQ,
125 if (rcode != RCODE_COMPLETE) {
126 dev_err(&unit->device,
127 "Failed to send a cue to load firmware\n");
135 get_meter(struct snd_bebob *bebob, void *buf, unsigned int size)
137 return snd_fw_transaction(bebob->unit, TCODE_READ_BLOCK_REQUEST,
138 MAUDIO_SPECIFIC_ADDRESS + METER_OFFSET,
143 check_clk_sync(struct snd_bebob *bebob, unsigned int size, bool *sync)
148 buf = kmalloc(size, GFP_KERNEL);
152 err = get_meter(bebob, buf, size);
156 /* if synced, this value is the same as SFC of FDF in CIP header */
157 *sync = (buf[size - 2] != 0xff);
164 * dig_fmt: 0x00:S/PDIF, 0x01:ADAT
165 * clk_lock: 0x00:unlock, 0x01:lock
168 avc_maudio_set_special_clk(struct snd_bebob *bebob, unsigned int clk_src,
169 unsigned int dig_in_fmt, unsigned int dig_out_fmt,
170 unsigned int clk_lock)
172 struct special_params *params = bebob->maudio_special_quirk;
176 if (amdtp_stream_running(&bebob->rx_stream) ||
177 amdtp_stream_running(&bebob->tx_stream))
180 buf = kmalloc(12, GFP_KERNEL);
184 buf[0] = 0x00; /* CONTROL */
185 buf[1] = 0xff; /* UNIT */
186 buf[2] = 0x00; /* vendor dependent */
187 buf[3] = 0x04; /* company ID high */
188 buf[4] = 0x00; /* company ID middle */
189 buf[5] = 0x04; /* company ID low */
190 buf[6] = 0xff & clk_src; /* clock source */
191 buf[7] = 0xff & dig_in_fmt; /* input digital format */
192 buf[8] = 0xff & dig_out_fmt; /* output digital format */
193 buf[9] = 0xff & clk_lock; /* lock these settings */
194 buf[10] = 0x00; /* padding */
195 buf[11] = 0x00; /* padding */
197 err = fcp_avc_transaction(bebob->unit, buf, 12, buf, 12,
198 BIT(1) | BIT(2) | BIT(3) | BIT(4) |
199 BIT(5) | BIT(6) | BIT(7) | BIT(8) |
201 if ((err > 0) && (err < 10))
203 else if (buf[0] == 0x08) /* NOT IMPLEMENTED */
205 else if (buf[0] == 0x0a) /* REJECTED */
210 params->clk_src = buf[6];
211 params->dig_in_fmt = buf[7];
212 params->dig_out_fmt = buf[8];
213 params->clk_lock = buf[9];
215 if (params->ctl_id_sync)
216 snd_ctl_notify(bebob->card, SNDRV_CTL_EVENT_MASK_VALUE,
217 params->ctl_id_sync);
225 special_stream_formation_set(struct snd_bebob *bebob)
227 static const unsigned int ch_table[2][2][3] = {
228 /* AMDTP_OUT_STREAM */
229 { { 6, 6, 4 }, /* SPDIF */
230 { 12, 8, 4 } }, /* ADAT */
231 /* AMDTP_IN_STREAM */
232 { { 10, 10, 2 }, /* SPDIF */
233 { 16, 12, 2 } } /* ADAT */
235 struct special_params *params = bebob->maudio_special_quirk;
238 max = SND_BEBOB_STRM_FMT_ENTRIES - 1;
242 for (i = 0; i < max; i++) {
243 bebob->tx_stream_formations[i + 1].pcm =
244 ch_table[AMDTP_IN_STREAM][params->dig_in_fmt][i / 2];
245 bebob->tx_stream_formations[i + 1].midi = 1;
247 bebob->rx_stream_formations[i + 1].pcm =
248 ch_table[AMDTP_OUT_STREAM][params->dig_out_fmt][i / 2];
249 bebob->rx_stream_formations[i + 1].midi = 1;
253 static int add_special_controls(struct snd_bebob *bebob);
255 snd_bebob_maudio_special_discover(struct snd_bebob *bebob, bool is1814)
257 struct special_params *params;
260 params = kzalloc(sizeof(struct special_params), GFP_KERNEL);
264 mutex_lock(&bebob->mutex);
266 bebob->maudio_special_quirk = (void *)params;
267 params->is1814 = is1814;
269 /* initialize these parameters because driver is not allowed to ask */
270 bebob->rx_stream.context = ERR_PTR(-1);
271 bebob->tx_stream.context = ERR_PTR(-1);
272 err = avc_maudio_set_special_clk(bebob, 0x03, 0x00, 0x00, 0x00);
274 dev_err(&bebob->unit->device,
275 "fail to initialize clock params: %d\n", err);
279 err = add_special_controls(bebob);
283 special_stream_formation_set(bebob);
285 if (params->is1814) {
286 bebob->midi_input_ports = 1;
287 bebob->midi_output_ports = 1;
289 bebob->midi_input_ports = 2;
290 bebob->midi_output_ports = 2;
295 bebob->maudio_special_quirk = NULL;
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 char *const special_clk_labels[] = {
344 SND_BEBOB_CLOCK_INTERNAL " with Digital Mute", "Digital",
345 "Word Clock", SND_BEBOB_CLOCK_INTERNAL};
346 static int special_clk_get(struct snd_bebob *bebob, unsigned int *id)
348 struct special_params *params = bebob->maudio_special_quirk;
349 *id = params->clk_src;
352 static int special_clk_ctl_info(struct snd_kcontrol *kctl,
353 struct snd_ctl_elem_info *einf)
355 return snd_ctl_enum_info(einf, 1, ARRAY_SIZE(special_clk_labels),
358 static int special_clk_ctl_get(struct snd_kcontrol *kctl,
359 struct snd_ctl_elem_value *uval)
361 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
362 struct special_params *params = bebob->maudio_special_quirk;
363 uval->value.enumerated.item[0] = params->clk_src;
366 static int special_clk_ctl_put(struct snd_kcontrol *kctl,
367 struct snd_ctl_elem_value *uval)
369 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
370 struct special_params *params = bebob->maudio_special_quirk;
373 id = uval->value.enumerated.item[0];
374 if (id >= ARRAY_SIZE(special_clk_labels))
377 mutex_lock(&bebob->mutex);
379 err = avc_maudio_set_special_clk(bebob, id,
383 mutex_unlock(&bebob->mutex);
390 static struct snd_kcontrol_new special_clk_ctl = {
391 .name = "Clock Source",
392 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
393 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
394 .info = special_clk_ctl_info,
395 .get = special_clk_ctl_get,
396 .put = special_clk_ctl_put
399 /* Clock synchronization control for special firmware */
400 static int special_sync_ctl_info(struct snd_kcontrol *kctl,
401 struct snd_ctl_elem_info *einf)
403 einf->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
405 einf->value.integer.min = 0;
406 einf->value.integer.max = 1;
410 static int special_sync_ctl_get(struct snd_kcontrol *kctl,
411 struct snd_ctl_elem_value *uval)
413 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
417 err = check_clk_sync(bebob, METER_SIZE_SPECIAL, &synced);
419 uval->value.integer.value[0] = synced;
423 static struct snd_kcontrol_new special_sync_ctl = {
424 .name = "Sync Status",
425 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
426 .access = SNDRV_CTL_ELEM_ACCESS_READ,
427 .info = special_sync_ctl_info,
428 .get = special_sync_ctl_get,
431 /* Digital input interface control for special firmware */
432 static const char *const special_dig_in_iface_labels[] = {
433 "S/PDIF Optical", "S/PDIF Coaxial", "ADAT Optical"
435 static int special_dig_in_iface_ctl_info(struct snd_kcontrol *kctl,
436 struct snd_ctl_elem_info *einf)
438 return snd_ctl_enum_info(einf, 1,
439 ARRAY_SIZE(special_dig_in_iface_labels),
440 special_dig_in_iface_labels);
442 static int special_dig_in_iface_ctl_get(struct snd_kcontrol *kctl,
443 struct snd_ctl_elem_value *uval)
445 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
446 struct special_params *params = bebob->maudio_special_quirk;
447 unsigned int dig_in_iface;
450 mutex_lock(&bebob->mutex);
452 err = avc_audio_get_selector(bebob->unit, 0x00, 0x04,
455 dev_err(&bebob->unit->device,
456 "fail to get digital input interface: %d\n", err);
460 /* encoded id for user value */
461 val = (params->dig_in_fmt << 1) | (dig_in_iface & 0x01);
463 /* for ADAT Optical */
467 uval->value.enumerated.item[0] = val;
469 mutex_unlock(&bebob->mutex);
472 static int special_dig_in_iface_ctl_set(struct snd_kcontrol *kctl,
473 struct snd_ctl_elem_value *uval)
475 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
476 struct special_params *params = bebob->maudio_special_quirk;
477 unsigned int id, dig_in_fmt, dig_in_iface;
480 id = uval->value.enumerated.item[0];
481 if (id >= ARRAY_SIZE(special_dig_in_iface_labels))
484 /* decode user value */
485 dig_in_fmt = (id >> 1) & 0x01;
486 dig_in_iface = id & 0x01;
488 mutex_lock(&bebob->mutex);
490 err = avc_maudio_set_special_clk(bebob,
498 /* For ADAT, optical interface is only available. */
499 if (params->dig_in_fmt > 0) {
504 /* For S/PDIF, optical/coaxial interfaces are selectable. */
505 err = avc_audio_set_selector(bebob->unit, 0x00, 0x04, dig_in_iface);
507 dev_err(&bebob->unit->device,
508 "fail to set digital input interface: %d\n", err);
511 special_stream_formation_set(bebob);
512 mutex_unlock(&bebob->mutex);
515 static struct snd_kcontrol_new special_dig_in_iface_ctl = {
516 .name = "Digital Input Interface",
517 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
518 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
519 .info = special_dig_in_iface_ctl_info,
520 .get = special_dig_in_iface_ctl_get,
521 .put = special_dig_in_iface_ctl_set
524 /* Digital output interface control for special firmware */
525 static const char *const special_dig_out_iface_labels[] = {
526 "S/PDIF Optical and Coaxial", "ADAT Optical"
528 static int special_dig_out_iface_ctl_info(struct snd_kcontrol *kctl,
529 struct snd_ctl_elem_info *einf)
531 return snd_ctl_enum_info(einf, 1,
532 ARRAY_SIZE(special_dig_out_iface_labels),
533 special_dig_out_iface_labels);
535 static int special_dig_out_iface_ctl_get(struct snd_kcontrol *kctl,
536 struct snd_ctl_elem_value *uval)
538 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
539 struct special_params *params = bebob->maudio_special_quirk;
540 mutex_lock(&bebob->mutex);
541 uval->value.enumerated.item[0] = params->dig_out_fmt;
542 mutex_unlock(&bebob->mutex);
545 static int special_dig_out_iface_ctl_set(struct snd_kcontrol *kctl,
546 struct snd_ctl_elem_value *uval)
548 struct snd_bebob *bebob = snd_kcontrol_chip(kctl);
549 struct special_params *params = bebob->maudio_special_quirk;
553 id = uval->value.enumerated.item[0];
554 if (id >= ARRAY_SIZE(special_dig_out_iface_labels))
557 mutex_lock(&bebob->mutex);
559 err = avc_maudio_set_special_clk(bebob,
562 id, params->clk_lock);
564 special_stream_formation_set(bebob);
568 mutex_unlock(&bebob->mutex);
571 static struct snd_kcontrol_new special_dig_out_iface_ctl = {
572 .name = "Digital Output Interface",
573 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
574 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
575 .info = special_dig_out_iface_ctl_info,
576 .get = special_dig_out_iface_ctl_get,
577 .put = special_dig_out_iface_ctl_set
580 static int add_special_controls(struct snd_bebob *bebob)
582 struct snd_kcontrol *kctl;
583 struct special_params *params = bebob->maudio_special_quirk;
586 kctl = snd_ctl_new1(&special_clk_ctl, bebob);
587 err = snd_ctl_add(bebob->card, kctl);
591 kctl = snd_ctl_new1(&special_sync_ctl, bebob);
592 err = snd_ctl_add(bebob->card, kctl);
595 params->ctl_id_sync = &kctl->id;
597 kctl = snd_ctl_new1(&special_dig_in_iface_ctl, bebob);
598 err = snd_ctl_add(bebob->card, kctl);
602 kctl = snd_ctl_new1(&special_dig_out_iface_ctl, bebob);
603 err = snd_ctl_add(bebob->card, kctl);
608 /* Hardware metering for special firmware */
609 static const char *const special_meter_labels[] = {
610 ANA_IN, ANA_IN, ANA_IN, ANA_IN,
612 ADAT_IN, ADAT_IN, ADAT_IN, ADAT_IN,
615 ADAT_OUT, ADAT_OUT, ADAT_OUT, ADAT_OUT,
620 special_meter_get(struct snd_bebob *bebob, u32 *target, unsigned int size)
623 unsigned int i, c, channels;
626 channels = ARRAY_SIZE(special_meter_labels) * 2;
627 if (size < channels * sizeof(u32))
630 /* omit last 4 bytes because it's clock info. */
631 buf = kmalloc(METER_SIZE_SPECIAL - 4, GFP_KERNEL);
635 err = get_meter(bebob, (void *)buf, METER_SIZE_SPECIAL - 4);
639 /* Its format is u16 and some channels are unknown. */
641 for (c = 2; c < channels + 2; c++)
642 target[i++] = be16_to_cpu(buf[c]) << 16;
648 /* last 4 bytes are omitted because it's clock info. */
649 static const char *const fw410_meter_labels[] = {
651 ANA_OUT, ANA_OUT, ANA_OUT, ANA_OUT, DIG_OUT,
654 static const char *const audiophile_meter_labels[] = {
656 ANA_OUT, ANA_OUT, DIG_OUT,
659 static const char *const solo_meter_labels[] = {
666 static const char *const ozonic_meter_labels[] = {
671 /* TODO: need testers. these positions are based on authour's assumption */
672 static const char *const nrv10_meter_labels[] = {
673 ANA_IN, ANA_IN, ANA_IN, ANA_IN,
675 ANA_OUT, ANA_OUT, ANA_OUT, ANA_OUT,
679 normal_meter_get(struct snd_bebob *bebob, u32 *buf, unsigned int size)
681 struct snd_bebob_meter_spec *spec = bebob->spec->meter;
682 unsigned int c, channels;
685 channels = spec->num * 2;
686 if (size < channels * sizeof(u32))
689 err = get_meter(bebob, (void *)buf, size);
693 for (c = 0; c < channels; c++)
694 be32_to_cpus(&buf[c]);
696 /* swap stream channels because inverted */
697 if (spec->labels == solo_meter_labels) {
698 swap(buf[4], buf[6]);
699 swap(buf[5], buf[7]);
705 /* for special customized devices */
706 static struct snd_bebob_rate_spec special_rate_spec = {
707 .get = &special_get_rate,
708 .set = &special_set_rate,
710 static struct snd_bebob_clock_spec special_clk_spec = {
711 .num = ARRAY_SIZE(special_clk_labels),
712 .labels = special_clk_labels,
713 .get = &special_clk_get,
715 static struct snd_bebob_meter_spec special_meter_spec = {
716 .num = ARRAY_SIZE(special_meter_labels),
717 .labels = special_meter_labels,
718 .get = &special_meter_get
720 struct snd_bebob_spec maudio_special_spec = {
721 .clock = &special_clk_spec,
722 .rate = &special_rate_spec,
723 .meter = &special_meter_spec
726 /* Firewire 410 specification */
727 static struct snd_bebob_rate_spec usual_rate_spec = {
728 .get = &snd_bebob_stream_get_rate,
729 .set = &snd_bebob_stream_set_rate,
731 static struct snd_bebob_meter_spec fw410_meter_spec = {
732 .num = ARRAY_SIZE(fw410_meter_labels),
733 .labels = fw410_meter_labels,
734 .get = &normal_meter_get
736 struct snd_bebob_spec maudio_fw410_spec = {
738 .rate = &usual_rate_spec,
739 .meter = &fw410_meter_spec
742 /* Firewire Audiophile specification */
743 static struct snd_bebob_meter_spec audiophile_meter_spec = {
744 .num = ARRAY_SIZE(audiophile_meter_labels),
745 .labels = audiophile_meter_labels,
746 .get = &normal_meter_get
748 struct snd_bebob_spec maudio_audiophile_spec = {
750 .rate = &usual_rate_spec,
751 .meter = &audiophile_meter_spec
754 /* Firewire Solo specification */
755 static struct snd_bebob_meter_spec solo_meter_spec = {
756 .num = ARRAY_SIZE(solo_meter_labels),
757 .labels = solo_meter_labels,
758 .get = &normal_meter_get
760 struct snd_bebob_spec maudio_solo_spec = {
762 .rate = &usual_rate_spec,
763 .meter = &solo_meter_spec
766 /* Ozonic specification */
767 static struct snd_bebob_meter_spec ozonic_meter_spec = {
768 .num = ARRAY_SIZE(ozonic_meter_labels),
769 .labels = ozonic_meter_labels,
770 .get = &normal_meter_get
772 struct snd_bebob_spec maudio_ozonic_spec = {
774 .rate = &usual_rate_spec,
775 .meter = &ozonic_meter_spec
778 /* NRV10 specification */
779 static struct snd_bebob_meter_spec nrv10_meter_spec = {
780 .num = ARRAY_SIZE(nrv10_meter_labels),
781 .labels = nrv10_meter_labels,
782 .get = &normal_meter_get
784 struct snd_bebob_spec maudio_nrv10_spec = {
786 .rate = &usual_rate_spec,
787 .meter = &nrv10_meter_spec