drivers/i2c: Add a driver for Semtech SX9324

This adds a new driver for the SX9324 proximity detector device.
Follow SX9324 datasheet Rev3.

BUG=b:172397658
BRANCH=zork
TEST=Test sx9324 is working as expected.

Signed-off-by: Eric Lai <ericr_lai@compal.corp-partner.google.com>
Change-Id: Ifd582482728a2f535ed85f6696b2f5a4529ba421
Reviewed-on: https://review.coreboot.org/c/coreboot/+/47640
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

5 files changed, 192 insertions, 0 deletions

diff --git a/src/drivers/i2c/sx9324/Kconfig b/src/drivers/i2c/sx9324/Kconfig
new file mode 100644
index 0000000000..77f6967b7e
--- /dev/null
+++ b/src/drivers/i2c/sx9324/Kconfig
@@ -0,0 +1,6 @@
+config DRIVERS_I2C_SX9324
+	bool
+	default n
+	depends on HAVE_ACPI_TABLES
+	help
+	  Board has a Semtech SX9324 proximity sensor.
diff --git a/src/drivers/i2c/sx9324/Makefile.inc b/src/drivers/i2c/sx9324/Makefile.inc
new file mode 100644
index 0000000000..8811c996b0
--- /dev/null
+++ b/src/drivers/i2c/sx9324/Makefile.inc
@@ -0,0 +1 @@
+ramstage-$(CONFIG_DRIVERS_I2C_SX9324) += sx9324.c
diff --git a/src/drivers/i2c/sx9324/chip.h b/src/drivers/i2c/sx9324/chip.h
new file mode 100644
index 0000000000..9c9dd3cf35
--- /dev/null
+++ b/src/drivers/i2c/sx9324/chip.h
@@ -0,0 +1,31 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __DRIVERS_I2C_SX9324_CHIP_H__
+#define __DRIVERS_I2C_SX9324_CHIP_H__
+
+#include <acpi/acpi_device.h>
+#include <device/i2c_simple.h>
+
+#define REGISTER(NAME) uint8_t NAME
+
+struct drivers_i2c_sx9324_config {
+	/* Device Description */
+	const char *desc;
+
+	/* ACPI _UID */
+	unsigned int uid;
+
+	/* Bus speed in Hz, default is I2C_SPEED_FAST */
+	enum i2c_speed speed;
+
+	/* Use GPIO-based interrupt instead of IO-APIC */
+	struct acpi_gpio irq_gpio;
+
+	/* IO-APIC interrupt */
+	struct acpi_irq irq;
+#include "registers.h"
+};
+
+#undef REGISTER
+
+#endif /* __DRIVERS_I2C_SX9324_CHIP_H__ */
diff --git a/src/drivers/i2c/sx9324/registers.h b/src/drivers/i2c/sx9324/registers.h
new file mode 100644
index 0000000000..160e5e7b05
--- /dev/null
+++ b/src/drivers/i2c/sx9324/registers.h
@@ -0,0 +1,50 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef REGISTER
+#error "define REGISTER(NAME) before including this file"
+#endif
+
+REGISTER(reg_gnrl_ctrl0);
+REGISTER(reg_gnrl_ctrl1);
+
+REGISTER(reg_afe_ctrl0);
+REGISTER(reg_afe_ctrl1);
+REGISTER(reg_afe_ctrl2);
+REGISTER(reg_afe_ctrl3);
+REGISTER(reg_afe_ctrl4);
+REGISTER(reg_afe_ctrl5);
+REGISTER(reg_afe_ctrl6);
+REGISTER(reg_afe_ctrl7);
+REGISTER(reg_afe_ctrl8);
+REGISTER(reg_afe_ctrl9);
+
+REGISTER(reg_prox_ctrl0);
+REGISTER(reg_prox_ctrl1);
+REGISTER(reg_prox_ctrl2);
+REGISTER(reg_prox_ctrl3);
+REGISTER(reg_prox_ctrl4);
+REGISTER(reg_prox_ctrl5);
+REGISTER(reg_prox_ctrl6);
+REGISTER(reg_prox_ctrl7);
+
+REGISTER(reg_adv_ctrl0);
+REGISTER(reg_adv_ctrl1);
+REGISTER(reg_adv_ctrl2);
+REGISTER(reg_adv_ctrl3);
+REGISTER(reg_adv_ctrl4);
+REGISTER(reg_adv_ctrl5);
+REGISTER(reg_adv_ctrl6);
+REGISTER(reg_adv_ctrl7);
+REGISTER(reg_adv_ctrl8);
+REGISTER(reg_adv_ctrl9);
+REGISTER(reg_adv_ctrl10);
+REGISTER(reg_adv_ctrl11);
+REGISTER(reg_adv_ctrl12);
+REGISTER(reg_adv_ctrl13);
+REGISTER(reg_adv_ctrl14);
+REGISTER(reg_adv_ctrl15);
+REGISTER(reg_adv_ctrl16);
+REGISTER(reg_adv_ctrl17);
+REGISTER(reg_adv_ctrl18);
+REGISTER(reg_adv_ctrl19);
+REGISTER(reg_adv_ctrl20);
diff --git a/src/drivers/i2c/sx9324/sx9324.c b/src/drivers/i2c/sx9324/sx9324.c
new file mode 100644
index 0000000000..2ca9f36345
--- /dev/null
+++ b/src/drivers/i2c/sx9324/sx9324.c
@@ -0,0 +1,104 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#include <acpi/acpi_device.h>
+#include <acpi/acpigen.h>
+#include <console/console.h>
+#include <device/i2c_simple.h>
+#include <device/device.h>
+#include <device/path.h>
+#include <string.h>
+#include "chip.h"
+
+#define I2C_SX9324_ACPI_ID	"STH9324"
+#define I2C_SX9324_CHIP_NAME	"Semtech SX9324"
+
+#define REGISTER(NAME) acpi_dp_add_integer(dsd, \
+					I2C_SX9324_ACPI_ID "," #NAME, \
+					config->NAME)
+
+static void i2c_sx9324_fill_ssdt(const struct device *dev)
+{
+	struct drivers_i2c_sx9324_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 = I2C_SPEED_FAST,
+		.resource = scope,
+	};
+	struct acpi_dp *dsd;
+
+	if (!scope || !config)
+		return;
+
+	if (config->speed)
+		i2c.speed = config->speed;
+
+	/* Device */
+	acpigen_write_scope(scope);
+	acpigen_write_device(acpi_device_name(dev));
+	acpigen_write_name_string("_HID", I2C_SX9324_ACPI_ID);
+	acpigen_write_name_integer("_UID", config->uid);
+	acpigen_write_name_string("_DDN", config->desc);
+	acpigen_write_STA(acpi_device_status(dev));
+
+	/* Resources */
+	acpigen_write_name("_CRS");
+	acpigen_write_resourcetemplate_header();
+	acpi_device_write_i2c(&i2c);
+
+	if (config->irq_gpio.pin_count)
+		acpi_device_write_gpio(&config->irq_gpio);
+	else
+		acpi_device_write_interrupt(&config->irq);
+
+	acpigen_write_resourcetemplate_footer();
+
+	/* DSD */
+	dsd = acpi_dp_new_table("_DSD");
+#include "registers.h"
+	acpi_dp_write(dsd);
+
+	acpigen_pop_len(); /* Device */
+	acpigen_pop_len(); /* Scope */
+
+	printk(BIOS_INFO, "%s: %s at %s\n", acpi_device_path(dev),
+	       config->desc ? : dev->chip_ops->name, dev_path(dev));
+}
+
+#undef REGISTER
+
+static const char *i2c_sx9324_acpi_name(const struct device *dev)
+{
+	static char name[5];
+
+	snprintf(name, sizeof(name), "SX%02.2X", dev->path.i2c.device);
+	return name;
+}
+
+static struct device_operations i2c_sx9324_ops = {
+	.read_resources		= noop_read_resources,
+	.set_resources		= noop_set_resources,
+	.acpi_name		= i2c_sx9324_acpi_name,
+	.acpi_fill_ssdt		= i2c_sx9324_fill_ssdt,
+};
+
+static void i2c_sx9324_enable(struct device *dev)
+{
+	struct drivers_i2c_sx9324_config *config = dev->chip_info;
+
+	if (!config) {
+		dev->enabled = 0;
+		return;
+	}
+
+	dev->ops = &i2c_sx9324_ops;
+
+	if (config->desc)
+		dev->name = config->desc;
+}
+
+struct chip_operations drivers_i2c_sx9324_ops = {
+	CHIP_NAME(I2C_SX9324_CHIP_NAME)
+	.enable_dev = i2c_sx9324_enable
+};