drivers/soundwire/max98373: Support MAX98373 SoundWire device

The MAX98373 smart speaker amp can be connected over SoundWire and be
configured for mainboards to use:

- Data Port 0 and Bulk Register Access is not supported
- Data Port 1 is the 32bit data input for the speaker path
- Data Port 3 is the 16bit data output for I/V sense ADC path

The data port and audio mode properties are filled out as best as
possible with the datasheet as a reference.

The ACPI address for the codec is calculated with the information in
the codec driver combined with the devicetree.cb hierarchy where the
link and unique IDs are extracted from the device path.

For example this device is connected to master link ID 1 and has strap
settings configuring it for unique ID 3.

chip drivers/soundwire/max98373
  register "desc" = ""Left Speaker Amp""
  device generic 1.3 on end
end

This driver was tested with the volteer reference design by booting
and disassembling the runtime SSDT to ensure that the devices have the
expected address and properties.

Device (SW13)
{
    Name (_ADR, 0x000123019F837300)
    Name (_DDN, "Left Speaker Amp")
    Method (_STA)
    {
        Return (0x0F)
    }
    Name (_DSD, Package ()
    {
        ToUUID ("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
        Package () {
            Package () { "mipi-sdw-sw-interface-revision", 0x00010000 },
            [...]
        },
        ToUUID ("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
        Package () {
            Package () { "mipi-sdw-port-audio-mode-0", "MOD0" },
            Package () { "mipi-sdw-dp-1-sink-subproperties", "SNK1" },
            Package () { "mipi-sdw-dp-3-source-subproperties", "SRC3" },
        }
    }
    Name (MOD0, Package ()
    {
        ToUUID ("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
        Package () {
            Package () {
                "mipi-sdw-audio-mode-bus-frequency-configs",
                Package () { 0x00753000, [...] }
            },
            [...]
        }
    }
    Name (SNK1, Package ()
    {
        ToUUID ("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
        Package () {
            Package () { "mipi-sdw-data-port-type", Zero },
            [...]
        },
        ToUUID ("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
        Package () {
            Package () { "mipi-sdw-port-audio-mode-0", "MOD0" }
        }
    }
    Name (SRC3, Package ()
    {
        ToUUID ("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
        Package () {
            Package () { "mipi-sdw-data-port-type", Zero },
            [...]
        },
        ToUUID ("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
        Package () {
            Package () { "mipi-sdw-port-audio-mode-0", "MOD0" }
        }
    }
}

BUG=b:146482091

Signed-off-by: Duncan Laurie <dlaurie@google.com>
Change-Id: I3f8cb2779ddde98c5df739bd8a1e83a12a305c00
Reviewed-on: https://review.coreboot.org/c/coreboot/+/40890
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>

5 files changed, 183 insertions, 0 deletions

diff --git a/src/drivers/soundwire/max98373/Kconfig b/src/drivers/soundwire/max98373/Kconfig
new file mode 100644
index 0000000000..0dc2c6116d
--- /dev/null
+++ b/src/drivers/soundwire/max98373/Kconfig
@@ -0,0 +1,2 @@
+config DRIVERS_SOUNDWIRE_MAX98373
+	bool
diff --git a/src/drivers/soundwire/max98373/Makefile.inc b/src/drivers/soundwire/max98373/Makefile.inc
new file mode 100644
index 0000000000..41c784d2ee
--- /dev/null
+++ b/src/drivers/soundwire/max98373/Makefile.inc
@@ -0,0 +1 @@
+ramstage-$(CONFIG_DRIVERS_SOUNDWIRE_MAX98373) += max98373.c
diff --git a/src/drivers/soundwire/max98373/chip.h b/src/drivers/soundwire/max98373/chip.h
new file mode 100644
index 0000000000..c263577af5
--- /dev/null
+++ b/src/drivers/soundwire/max98373/chip.h
@@ -0,0 +1,11 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __DRIVERS_SOUNDWIRE_MAX98373_CHIP_H__
+#define __DRIVERS_SOUNDWIRE_MAX98373_CHIP_H__
+
+struct drivers_soundwire_max98373_config {
+	const char *name;
+	const char *desc;
+};
+
+#endif /* __DRIVERS_SOUNDWIRE_MAX98373_CHIP_H__ */
diff --git a/src/drivers/soundwire/max98373/max98373.c b/src/drivers/soundwire/max98373/max98373.c
new file mode 100644
index 0000000000..231385cd57
--- /dev/null
+++ b/src/drivers/soundwire/max98373/max98373.c
@@ -0,0 +1,165 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#include <acpi/acpigen.h>
+#include <acpi/acpi_device.h>
+#include <acpi/acpi_soundwire.h>
+#include <device/device.h>
+#include <device/path.h>
+#include <device/mipi_ids.h>
+#include <device/soundwire.h>
+#include <stdio.h>
+
+#include "chip.h"
+
+static struct soundwire_address max98373_address = {
+	.version = SOUNDWIRE_VERSION_1_1,
+	.manufacturer_id = MIPI_MFG_ID_MAXIM,
+	.part_id = MIPI_DEV_ID_MAXIM_MAX98373,
+	.class = MIPI_CLASS_NONE
+};
+
+static struct soundwire_slave max98373_slave = {
+	.wake_up_unavailable = false,
+	.test_mode_supported = false,
+	.clock_stop_mode1_supported = true,
+	.simplified_clockstopprepare_sm_supported = true,
+	.clockstopprepare_hard_reset_behavior = false,
+	.highPHY_capable = false,
+	.paging_supported = false,
+	.bank_delay_supported = false,
+	.port15_read_behavior = false,
+	.source_port_list = SOUNDWIRE_PORT(3),
+	.sink_port_list = SOUNDWIRE_PORT(1),
+};
+
+static struct soundwire_audio_mode max98373_audio_mode = {
+	/* Bus frequency must be 1/2/4/8 divider of supported input frequencies. */
+	.bus_frequency_configs_count = 27,
+	.bus_frequency_configs = {
+		7680 * KHz, 3840 * KHz, 1920 * KHz, 960 * KHz,   /* 7.68 MHz */
+		8400 * KHz, 4200 * KHz, 2100 * KHz, 1050 * KHz,  /* 8.4 MHz */
+		9600 * KHz, 4800 * KHz, 2400 * KHz, 1200 * KHz,  /* 9.6 MHz */
+		11289600, 5644800, 2822400, 1411200,             /* 11.2896 MHz */
+		12000 * KHz, 6000 * KHz, 3000 * KHz, 1500 * KHz, /* 12 MHz */
+		12288 * KHz, 6144 * KHz, 3072 * KHz, 1536 * KHz, /* 12.288 MHz */
+		13000 * KHz, 6500 * KHz, 3250 * KHz              /* 13 MHz (no /8) */
+	},
+	/* Support 16 KHz to 96 KHz sampling frequency */
+	.sampling_frequency_configs_count = 8,
+	.sampling_frequency_configs = {
+		16 * KHz,
+		22.05 * KHz,
+		24 * KHz,
+		32 * KHz,
+		44.1 * KHz,
+		48 * KHz,
+		88.2 * KHz,
+		96 * KHz,
+	},
+	.prepare_channel_behavior = CHANNEL_PREPARE_ANY_FREQUENCY
+};
+
+static struct soundwire_dpn max98373_dp1 = {
+	.port_wordlength_configs_count = 1,
+	.port_wordlength_configs = { 32 },
+	.data_port_type = FULL_DATA_PORT,
+	.max_grouping_supported = BLOCK_GROUP_COUNT_1,
+	.simplified_channelprepare_sm = false,
+	.imp_def_dpn_interrupts_supported = 0,
+	.min_channel_number = 1,
+	.max_channel_number = 2,
+	.modes_supported = MODE_ISOCHRONOUS | MODE_TX_CONTROLLED |
+			   MODE_RX_CONTROLLED | MODE_FULL_ASYNCHRONOUS,
+	.block_packing_mode = true,
+	.port_audio_mode_count = 1,
+	.port_audio_mode_list = { 0 }
+};
+
+static struct soundwire_dpn max98373_dp3 = {
+	.port_wordlength_configs_count = 1,
+	.port_wordlength_configs = { 16 },
+	.data_port_type = FULL_DATA_PORT,
+	.max_grouping_supported = BLOCK_GROUP_COUNT_1,
+	.simplified_channelprepare_sm = false,
+	.imp_def_dpn_interrupts_supported = 0,
+	.min_channel_number = 1,
+	.max_channel_number = 2,
+	.modes_supported = MODE_ISOCHRONOUS | MODE_TX_CONTROLLED |
+			   MODE_RX_CONTROLLED | MODE_FULL_ASYNCHRONOUS,
+	.block_packing_mode = true,
+	.port_audio_mode_count = 1,
+	.port_audio_mode_list = { 0 }
+};
+
+static const struct soundwire_codec max98373_codec = {
+	.slave = &max98373_slave,
+	.audio_mode = { &max98373_audio_mode },
+	.dpn = {
+		{
+			/* Data Input for Speaker Path */
+			.port = 1,
+			.sink = &max98373_dp1
+		},
+		{
+			/* Data Output for I/V Sense ADC Path */
+			.port = 3,
+			.source = &max98373_dp3,
+		}
+	}
+};
+
+static void soundwire_max98373_fill_ssdt(const struct device *dev)
+{
+	struct drivers_soundwire_max98373_config *config = dev->chip_info;
+	const char *scope = acpi_device_scope(dev);
+	struct acpi_dp *dsd;
+
+	if (!dev->enabled || !scope)
+		return;
+
+	acpigen_write_scope(scope);
+	acpigen_write_device(acpi_device_name(dev));
+
+	/* Set codec address IDs. */
+	max98373_address.link_id = dev->path.generic.id;
+	max98373_address.unique_id = dev->path.generic.subid;
+
+	acpigen_write_ADR_soundwire_device(&max98373_address);
+	acpigen_write_name_string("_DDN", config->desc ? : dev->chip_ops->name);
+	acpigen_write_STA(acpi_device_status(dev));
+
+	dsd = acpi_dp_new_table("_DSD");
+	soundwire_gen_codec(dsd, &max98373_codec, NULL);
+	acpi_dp_write(dsd);
+
+	acpigen_pop_len(); /* Device */
+	acpigen_pop_len(); /* Scope */
+}
+
+static const char *soundwire_max98373_acpi_name(const struct device *dev)
+{
+	struct drivers_soundwire_max98373_config *config = dev->chip_info;
+	static char name[5];
+
+	if (config->name)
+		return config->name;
+	snprintf(name, sizeof(name), "SW%1X%1X", dev->path.generic.id, dev->path.generic.subid);
+	return name;
+}
+
+static struct device_operations soundwire_max98373_ops = {
+	.read_resources		= noop_read_resources,
+	.set_resources		= noop_set_resources,
+	.acpi_name		= soundwire_max98373_acpi_name,
+	.acpi_fill_ssdt		= soundwire_max98373_fill_ssdt,
+};
+
+static void soundwire_max98373_enable(struct device *dev)
+{
+	dev->ops = &soundwire_max98373_ops;
+}
+
+struct chip_operations drivers_soundwire_max98373_ops = {
+	CHIP_NAME("Maxim MAX98373 SoundWire Codec")
+	.enable_dev = soundwire_max98373_enable
+};
diff --git a/src/include/device/mipi_ids.h b/src/include/device/mipi_ids.h
index 2e0254c0b7..4d01300e72 100644
--- a/src/include/device/mipi_ids.h
+++ b/src/include/device/mipi_ids.h
@@ -18,4 +18,8 @@
 #define MIPI_MFG_ID_TI				0x0102
 #define MIPI_MFG_ID_TOSHIBA			0x0126
 
+/* Contributing Members */
+#define MIPI_MFG_ID_MAXIM			0x019f
+#define MIPI_DEV_ID_MAXIM_MAX98373		0x8373
+
 #endif /* __DEVICE_MIPI_IDS_H__ */