drivers/i2c/max98373: Add driver for generating device in SSDT

Add a device driver to generate the device and required properties
into the SSDT for max98373.

TEST=verified SSDT contained relevant params
BUG=None

Change-Id: Id45f74e52855f4b19276e1d3d673d5448207ef4b
Signed-off-by: Sathyanarayana Nujella <sathyanarayana.nujella@intel.com>
Signed-off-by: N, Harshapriya <harshapriya.n@intel.com>
Reviewed-on: https://review.coreboot.org/22673
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Aaron Durbin <adurbin@chromium.org>

4 files changed, 143 insertions, 0 deletions

diff --git a/src/drivers/i2c/max98373/Kconfig b/src/drivers/i2c/max98373/Kconfig
new file mode 100644
index 0000000000..fe1473e1ad
--- /dev/null
+++ b/src/drivers/i2c/max98373/Kconfig
@@ -0,0 +1,4 @@
+config DRIVERS_I2C_MAX98373
+	bool
+	default n
+	depends on HAVE_ACPI_TABLES
diff --git a/src/drivers/i2c/max98373/Makefile.inc b/src/drivers/i2c/max98373/Makefile.inc
new file mode 100644
index 0000000000..0a8871d987
--- /dev/null
+++ b/src/drivers/i2c/max98373/Makefile.inc
@@ -0,0 +1 @@
+ramstage-$(CONFIG_DRIVERS_I2C_MAX98373) += max98373.c
diff --git a/src/drivers/i2c/max98373/chip.h b/src/drivers/i2c/max98373/chip.h
new file mode 100644
index 0000000000..150998b83b
--- /dev/null
+++ b/src/drivers/i2c/max98373/chip.h
@@ -0,0 +1,34 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2017 Intel Corp.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+/*
+ * Maxim MAX98373 audio codec devicetree bindings
+ */
+struct drivers_i2c_max98373_config {
+	/* I2C Bus Frequency in Hertz (default 400kHz) */
+	uint32_t bus_speed;
+	/* Set ‘1’ if I2S channel size is not 32bit. */
+	bool interleave_mode;
+	/* Identifier for chips */
+	uint32_t uid;
+	/* Device Description */
+	const char *desc;
+	/* ACPI Device Name */
+	const char *name;
+	/* slot number where voltage feedback will be received */
+	uint32_t vmon_slot_no;
+	/* slot number where current feedback will be received */
+	uint32_t imon_slot_no;
+};
diff --git a/src/drivers/i2c/max98373/max98373.c b/src/drivers/i2c/max98373/max98373.c
new file mode 100644
index 0000000000..576667176a
--- /dev/null
+++ b/src/drivers/i2c/max98373/max98373.c
@@ -0,0 +1,104 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2017 Intel Corporation.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <arch/acpi.h>
+#include <arch/acpi_device.h>
+#include <arch/acpigen.h>
+#include <console/console.h>
+#include <device/i2c_simple.h>
+#include <device/device.h>
+#include <device/path.h>
+#include <stdint.h>
+#include <string.h>
+#include "chip.h"
+
+#define MAX98373_ACPI_NAME	"MAXI"
+#define MAX98373_ACPI_HID	"MX98373"
+
+static void max98373_fill_ssdt(struct device *dev)
+{
+	struct drivers_i2c_max98373_config *config = dev->chip_info;
+	const char *scope = acpi_device_scope(dev);
+	struct acpi_i2c i2c = {
+		.address = dev->path.i2c.device,
+		.mode_10bit = dev->path.i2c.mode_10bit,
+		.speed = config->bus_speed ? : I2C_SPEED_STANDARD,
+		.resource = scope,
+	};
+	struct acpi_dp *dp;
+
+	if (!dev->enabled || !scope) {
+		printk(BIOS_ERR, "%s: dev not enabled", __func__);
+		return;
+	}
+
+	/* Device */
+	acpigen_write_scope(scope);
+	acpigen_write_device(acpi_device_name(dev));
+	acpigen_write_name_string("_HID", MAX98373_ACPI_HID);
+	acpigen_write_name_integer("_UID", config->uid);
+	if (config->desc)
+		acpigen_write_name_string("_DDN", config->desc);
+	acpigen_write_STA(ACPI_STATUS_DEVICE_ALL_ON);
+
+	/* Resources */
+	acpigen_write_name("_CRS");
+	acpigen_write_resourcetemplate_header();
+	acpi_device_write_i2c(&i2c);
+	acpigen_write_resourcetemplate_footer();
+
+	/* Device Properties */
+	dp = acpi_dp_new_table("_DSD");
+
+	acpi_dp_add_integer(dp, "interleave_mode", config->interleave_mode);
+	acpi_dp_add_integer(dp, "vmon-slot-no", config->vmon_slot_no);
+	acpi_dp_add_integer(dp, "imon-slot-no", config->imon_slot_no);
+
+	acpi_dp_write(dp);
+
+	acpigen_pop_len(); /* Device */
+	acpigen_pop_len(); /* Scope */
+
+	printk(BIOS_INFO, "%s: %s address 0%xh\n", acpi_device_path(dev),
+			dev->chip_ops->name, dev->path.i2c.device);
+}
+
+static const char *max98373_acpi_name(const struct device *dev)
+{
+	struct drivers_i2c_max98373_config *config = dev->chip_info;
+
+	if (config->name)
+		return config->name;
+
+	return MAX98373_ACPI_NAME;
+}
+
+static struct device_operations max98373_ops = {
+	.read_resources		  = DEVICE_NOOP,
+	.set_resources		  = DEVICE_NOOP,
+	.enable_resources	  = DEVICE_NOOP,
+	.acpi_name		  = &max98373_acpi_name,
+	.acpi_fill_ssdt_generator = &max98373_fill_ssdt,
+};
+
+static void max98373_enable(struct device *dev)
+{
+	dev->ops = &max98373_ops;
+}
+
+struct chip_operations drivers_i2c_max98373_ops = {
+	CHIP_NAME("Maxim MAX98373 Codec")
+	.enable_dev = &max98373_enable
+};