drivers/nxp/uwb: Add new driver for NXP UWB SR1xx chip

Add a new driver for NXP UWB SR1xx (e.g., SR150) device.

The driver was originally written by Tim Wawrzynczak as a WIP in
CL:3503703, and was based on drivers/spi/acpi.

BUG=b:240607130
BRANCH=firmware-brya-14505.B
TEST=On ghost (with follow-up CL), patch linux with NXP's pending
     drivers
     -> UWB device is probed and can respond to a simple hello
        packet

Co-authored-by: Tim Wawrzynczak <twawrzynczak@chromium.org>
Signed-off-by: Jack Rosenthal <jrosenth@chromium.org>
Change-Id: I5b1b0a5c1b48d0b09e7ab5f2ea6b6bc2fba2a7d8
Reviewed-on: https://review.coreboot.org/c/coreboot/+/66466
Reviewed-by: Karthik Ramasubramanian <kramasub@google.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

4 files changed, 196 insertions, 0 deletions

diff --git a/src/drivers/nxp/uwb/Kconfig b/src/drivers/nxp/uwb/Kconfig
new file mode 100644
index 0000000000..01c82d1bae
--- /dev/null
+++ b/src/drivers/nxp/uwb/Kconfig
@@ -0,0 +1,30 @@
+config DRIVERS_NXP_UWB_SR1XX
+	bool "NXP UWB SR1xx driver"
+	help
+	  Enable support for a NXP UWB SR1xx (e.g., SR150) chip.
+
+	  A configuration should be added to device tree like below:
+	  device ref gspi0 on
+	          chip drivers/nxp/uwb
+	                  # The ACPI name of the device.  Note it will be
+	                  # truncated to 4 characters if a longer name is given.
+	                  register "name" = ""UWB0""
+
+	                  # Description of the module.
+	                  register "desc" = ""NXP UWB Module""
+
+	                  # SPI bus speed (in Hz).
+	                  register "speed" = "1000000"
+
+	                  # The GPIO connected to SENSORINT.
+	                  register "irq_gpio" = "ACPI_GPIO_IRQ_LEVEL_HIGH(GPP_F21)"
+
+	                  # The GPIO connected to CHIP_EN.
+	                  register "ce_gpio" = "ACPI_GPIO_OUTPUT_ACTIVE_HIGH(GPP_A12)"
+
+	                  # The GPIO connected to WAKEUP.
+	                  register "ri_gpio" = "ACPI_GPIO_OUTPUT_ACTIVE_HIGH(GPP_A7)"
+
+	                  device spi 0 on end
+	          end
+	  end
diff --git a/src/drivers/nxp/uwb/Makefile.inc b/src/drivers/nxp/uwb/Makefile.inc
new file mode 100644
index 0000000000..11ba2736ab
--- /dev/null
+++ b/src/drivers/nxp/uwb/Makefile.inc
@@ -0,0 +1 @@
+ramstage-$(CONFIG_DRIVER_NXP_UWB_SR1XX) += uwb.c
diff --git a/src/drivers/nxp/uwb/chip.h b/src/drivers/nxp/uwb/chip.h
new file mode 100644
index 0000000000..8233b254b4
--- /dev/null
+++ b/src/drivers/nxp/uwb/chip.h
@@ -0,0 +1,27 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __NXP_UWB_CHIP_H__
+#define __NXP_UWB_CHIP_H__
+
+#include <acpi/acpi_device.h>
+
+struct drivers_nxp_uwb_config {
+	/* ACPI Device Name */
+	const char *name;
+
+	/* Device Description */
+	const char *desc;
+
+	/* ACPI _UID */
+	unsigned int uid;
+
+	/* Bus speed in Hz (default 1MHz) */
+	unsigned int speed;
+
+	/* Use GPIO based interrupt instead of PIRQ */
+	struct acpi_gpio irq_gpio;
+	struct acpi_gpio ce_gpio;
+	struct acpi_gpio ri_gpio;
+};
+
+#endif /* __NXP_UWB_CHIP_H__ */
diff --git a/src/drivers/nxp/uwb/uwb.c b/src/drivers/nxp/uwb/uwb.c
new file mode 100644
index 0000000000..978edebd63
--- /dev/null
+++ b/src/drivers/nxp/uwb/uwb.c
@@ -0,0 +1,138 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#include <acpi/acpi_device.h>
+#include <acpi/acpigen.h>
+#include <console/console.h>
+#include <device/device.h>
+#include <device/path.h>
+#include <device/spi.h>
+#include <spi-generic.h>
+#include <string.h>
+#include "chip.h"
+
+static int spi_acpi_get_bus(const struct device *dev)
+{
+	struct device *spi_dev;
+	struct device_operations *ops;
+
+	if (!dev->bus || !dev->bus->dev)
+		return -1;
+
+	spi_dev = dev->bus->dev;
+	ops = spi_dev->ops;
+
+	if (ops && ops->ops_spi_bus && ops->ops_spi_bus->dev_to_bus)
+		return ops->ops_spi_bus->dev_to_bus(spi_dev);
+
+	return -1;
+}
+
+static int write_gpio(struct acpi_gpio *gpio, int *curr_index)
+{
+	int ret = -1;
+
+	if (gpio->pin_count == 0)
+		return ret;
+
+	acpi_device_write_gpio(gpio);
+	ret = *curr_index;
+	(*curr_index)++;
+
+	return ret;
+}
+
+static void nxp_uwb_fill_ssdt(const struct device *dev)
+{
+	struct drivers_nxp_uwb_config *config = dev->chip_info;
+	const char *scope = acpi_device_scope(dev);
+	const char *path = acpi_device_path(dev);
+	struct acpi_spi spi = {
+		.device_select = dev->path.spi.cs,
+		.speed = config->speed ? : 1 * MHz,
+		.resource = scope,
+		.device_select_polarity = SPI_POLARITY_LOW,
+		.wire_mode = SPI_4_WIRE_MODE,
+		.data_bit_length = 8,
+		.clock_phase = SPI_CLOCK_PHASE_FIRST,
+		.clock_polarity = SPI_POLARITY_LOW,
+	};
+	int curr_index = 0;
+	int irq_gpio_index = -1;
+	int ce_gpio_index = -1;
+	int ri_gpio_index = -1;
+
+	if (!scope)
+		return;
+
+	if (spi_acpi_get_bus(dev) == -1) {
+		printk(BIOS_ERR, "%s: Cannot get bus for device.\n",
+		       dev_path(dev));
+		return;
+	}
+
+	/* Device */
+	acpigen_write_scope(scope);
+	acpigen_write_device(acpi_device_name(dev));
+	acpigen_write_name_string("_HID", ACPI_DT_NAMESPACE_HID);
+	acpigen_write_name_integer("_UID", config->uid);
+	if (config->desc)
+		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_spi(&spi);
+	irq_gpio_index = write_gpio(&config->irq_gpio, &curr_index);
+	ce_gpio_index = write_gpio(&config->ce_gpio, &curr_index);
+	ri_gpio_index = write_gpio(&config->ri_gpio, &curr_index);
+	acpigen_write_resourcetemplate_footer();
+
+	struct acpi_dp *dsd = acpi_dp_new_table("_DSD");
+	acpi_dp_add_string(dsd, "compatible", "nxp,sr1xx");
+	acpi_dp_add_gpio(dsd, "nxp,sr1xx-irq-gpios", path, irq_gpio_index, 0,
+			 config->irq_gpio.active_low);
+
+	acpi_dp_add_gpio(dsd, "nxp,sr1xx-ce-gpios", path, ce_gpio_index, 0,
+			 config->ce_gpio.active_low);
+
+	acpi_dp_add_gpio(dsd, "nxp,sr1xx-ri-gpios", path, ri_gpio_index, 0,
+			 config->ri_gpio.active_low);
+	acpi_dp_write(dsd);
+
+	acpigen_write_device_end();
+	acpigen_write_scope_end();
+
+	printk(BIOS_INFO, "%s: %s at %s\n", path,
+	       config->desc ? : dev->chip_ops->name, dev_path(dev));
+}
+
+static const char *nxp_uwb_name(const struct device *dev)
+{
+	struct drivers_nxp_uwb_config *config = dev->chip_info;
+	static char name[ACPI_NAME_BUFFER_SIZE];
+
+	if (config->name)
+		snprintf(name, sizeof(name), "%s", config->name);
+	else
+		snprintf(name, sizeof(name), "UWB%1X", spi_acpi_get_bus(dev));
+	name[4] = '\0';
+	return name;
+}
+
+static struct device_operations nxp_uwb_ops = {
+	.read_resources		= noop_read_resources,
+	.set_resources		= noop_set_resources,
+	.acpi_name		= nxp_uwb_name,
+	.acpi_fill_ssdt		= nxp_uwb_fill_ssdt,
+};
+
+static void nxb_uwb_enable(struct device *dev)
+{
+	dev->ops = &nxp_uwb_ops;
+}
+
+struct chip_operations drivers_nxp_uwb_ops = {
+	CHIP_NAME("NXP UWB Device")
+	.enable_dev = nxb_uwb_enable
+};