drivers: gpio: add driver for AD5592

Add MFD subdriver for the built-in GPIO controller in AD5592 chip. Signed-off-by: Bartosz Bilas <[email protected]>
zephyrproject-rtos · Oct 31, 2023 · 08c9291 · 08c9291
1 parent 5bae145
commit 08c9291
Show file tree

Hide file tree

Showing 7 changed files with 282 additions and 1 deletion.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -330,6 +330,7 @@
 /drivers/gpio/*bd8lb600fs*                @benediktibk
 /drivers/gpio/*pcal64xxa*                 @benediktibk
 /drivers/gpio/gpio_altera_pio.c           @shilinte
+/drivers/gpio/gpio_ad5592.c               @bbilas
 /drivers/hwinfo/                          @alexanderwachter
 /drivers/i2c/i2c_common.c                 @sjg20
 /drivers/i2c/i2c_emul.c                   @sjg20

diff --git a/drivers/gpio/CMakeLists.txt b/drivers/gpio/CMakeLists.txt
@@ -4,6 +4,7 @@ zephyr_syscall_header(${ZEPHYR_BASE}/include/zephyr/drivers/gpio.h)
 
 zephyr_library()
 
+zephyr_library_sources_ifdef(CONFIG_GPIO_AD5592     gpio_ad5592.c)
 zephyr_library_sources_ifdef(CONFIG_GPIO_AXP192     gpio_axp192.c)
 zephyr_library_sources_ifdef(CONFIG_GPIO_TELINK_B91 gpio_b91.c)
 zephyr_library_sources_ifdef(CONFIG_GPIO_INFINEON_CAT1 gpio_ifx_cat1.c)

diff --git a/drivers/gpio/Kconfig b/drivers/gpio/Kconfig
@@ -69,6 +69,8 @@ config GPIO_ENABLE_DISABLE_INTERRUPT
 	  pending register, etc. The driver must implement it to work.
 
 
+source "drivers/gpio/Kconfig.ad5592"
+
 source "drivers/gpio/Kconfig.axp192"
 
 source "drivers/gpio/Kconfig.b91"

diff --git a/drivers/gpio/Kconfig.ad5592 b/drivers/gpio/Kconfig.ad5592
@@ -0,0 +1,17 @@
+# Copyright (c) 2023 Grinn
+# SPDX-License-Identifier: Apache-2.0
+
+config GPIO_AD5592
+	bool "AD5592 GPIO driver"
+	default y
+	depends on DT_HAS_ADI_AD5592_GPIO_ENABLED
+	select MFD
+	help
+	  Enable the AD5592 GPIO driver.
+
+config GPIO_AD5592_INIT_PRIORITY
+	int "AD5592 GPIO driver initialization priority"
+	depends on GPIO_AD5592
+	default 82
+	help
+	  Initialization priority for the AD5592 GPIO driver.
diff --git a/drivers/gpio/gpio_ad5592.c b/drivers/gpio/gpio_ad5592.c
@@ -0,0 +1,233 @@
+/*
+ * Copyright (c) 2023 Grinn
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#define DT_DRV_COMPAT adi_ad5592_gpio
+
+#include <zephyr/drivers/gpio.h>
+#include <zephyr/drivers/gpio/gpio_utils.h>
+#include <zephyr/kernel.h>
+#include <zephyr/sys/byteorder.h>
+
+#include <zephyr/drivers/mfd/ad5592.h>
+
+struct gpio_ad5592_config {
+	/* gpio_driver_config needs to be first */
+	struct gpio_driver_config common;
+	const struct device *mfd_dev;
+};
+
+struct gpio_ad5592_data {
+	/* gpio_driver_data needs to be first */
+	struct gpio_driver_data common;
+	uint8_t gpio_val;
+	uint8_t gpio_out;
+	uint8_t gpio_in;
+	uint8_t gpio_pull_down;
+};
+
+static int gpio_ad5592_port_get_raw(const struct device *dev, uint32_t *value)
+{
+	const struct gpio_ad5592_config *config = dev->config;
+	struct gpio_ad5592_data *drv_data = dev->data;
+	uint16_t data;
+	int ret;
+
+	if (k_is_in_isr()) {
+		return -EWOULDBLOCK;
+	}
+
+	ret = mfd_ad5592_read_reg(config->mfd_dev,
+				  AD5592_REG_GPIO_INPUT_EN, drv_data->gpio_in, &data);
+	if (ret < 0) {
+		return ret;
+	}
+
+	*value = (uint32_t)data;
+
+	return 0;
+}
+
+static int gpio_ad5592_port_set_bits_raw(const struct device *dev,
+					  gpio_port_pins_t pins)
+{
+	struct gpio_ad5592_data *data = dev->data;
+	const struct gpio_ad5592_config *config = dev->config;
+
+	if (k_is_in_isr()) {
+		return -EWOULDBLOCK;
+	}
+
+	data->gpio_val |= (uint8_t)pins;
+
+	return mfd_ad5592_write_reg(config->mfd_dev, AD5592_REG_GPIO_SET, data->gpio_val);
+}
+
+static int gpio_ad5592_port_clear_bits_raw(const struct device *dev,
+					    gpio_port_pins_t pins)
+{
+	struct gpio_ad5592_data *data = dev->data;
+	const struct gpio_ad5592_config *config = dev->config;
+
+	if (k_is_in_isr()) {
+		return -EWOULDBLOCK;
+	}
+
+	data->gpio_val &= ~(uint8_t)pins;
+
+	return mfd_ad5592_write_reg(config->mfd_dev, AD5592_REG_GPIO_SET, data->gpio_val);
+}
+
+static inline int gpio_ad5592_configure(const struct device *dev,
+					 gpio_pin_t pin, gpio_flags_t flags)
+{
+	struct gpio_ad5592_data *data = dev->data;
+	const struct gpio_ad5592_config *config = dev->config;
+	uint8_t val;
+	int ret;
+
+	if (k_is_in_isr()) {
+		return -EWOULDBLOCK;
+	}
+
+	if (pin >= AD5592_PIN_MAX) {
+		return -EINVAL;
+	}
+
+	val = BIT(pin);
+	if ((flags & GPIO_OUTPUT) != 0U) {
+		data->gpio_in &= ~val;
+		data->gpio_out |= val;
+
+		if ((flags & GPIO_OUTPUT_INIT_HIGH) != 0U) {
+			ret = gpio_ad5592_port_set_bits_raw(
+				dev, (gpio_port_pins_t)BIT(pin));
+			if (ret < 0) {
+				return ret;
+			}
+		} else if ((flags & GPIO_OUTPUT_INIT_LOW) != 0U) {
+			ret = gpio_ad5592_port_clear_bits_raw(
+				dev, (gpio_port_pins_t)BIT(pin));
+			if (ret < 0) {
+				return ret;
+			}
+		}
+
+		ret = mfd_ad5592_write_reg(config->mfd_dev,
+					   AD5592_REG_GPIO_OUTPUT_EN, data->gpio_out);
+		if (ret < 0) {
+			return ret;
+		}
+
+		ret = mfd_ad5592_write_reg(config->mfd_dev,
+					   AD5592_REG_GPIO_INPUT_EN, data->gpio_in);
+		if (ret < 0) {
+			return ret;
+		}
+	} else if ((flags & GPIO_INPUT) != 0U) {
+		data->gpio_in |= val;
+		data->gpio_out &= ~val;
+
+		if ((flags & GPIO_PULL_DOWN) != 0U) {
+			data->gpio_pull_down |= val;
+
+			ret = mfd_ad5592_write_reg(config->mfd_dev,
+						   AD5592_REG_GPIO_PULLDOWN,
+						   data->gpio_pull_down);
+			if (ret < 0) {
+				return ret;
+			}
+		} else if ((flags & GPIO_PULL_UP) != 0U) {
+			return -ENOTSUP;
+		}
+
+		ret = mfd_ad5592_write_reg(config->mfd_dev,
+					   AD5592_REG_GPIO_OUTPUT_EN, data->gpio_out);
+		if (ret < 0) {
+			return ret;
+		}
+
+		ret = mfd_ad5592_write_reg(config->mfd_dev,
+					   AD5592_REG_GPIO_INPUT_EN, data->gpio_in);
+		if (ret < 0) {
+			return ret;
+		}
+	} else {
+		return -ENOTSUP;
+	}
+
+	return 0;
+}
+
+static int gpio_ad5592_port_set_masked_raw(const struct device *dev,
+					    gpio_port_pins_t mask,
+					    gpio_port_value_t value)
+{
+	ARG_UNUSED(dev);
+	ARG_UNUSED(mask);
+	ARG_UNUSED(value);
+
+	return -ENOTSUP;
+}
+
+static int gpio_ad5592_port_toggle_bits(const struct device *dev,
+					 gpio_port_pins_t pins)
+{
+	ARG_UNUSED(dev);
+	ARG_UNUSED(pins);
+
+	return -ENOTSUP;
+}
+
+static int gpio_ad5592_pin_interrupt_configure(const struct device *dev,
+						gpio_pin_t pin,
+						enum gpio_int_mode mode,
+						enum gpio_int_trig trig)
+{
+	ARG_UNUSED(dev);
+	ARG_UNUSED(pin);
+	ARG_UNUSED(mode);
+	ARG_UNUSED(trig);
+
+	return -ENOTSUP;
+}
+
+static const struct gpio_driver_api gpio_ad5592_api = {
+	.pin_configure = gpio_ad5592_configure,
+	.port_get_raw = gpio_ad5592_port_get_raw,
+	.port_set_masked_raw = gpio_ad5592_port_set_masked_raw,
+	.port_set_bits_raw = gpio_ad5592_port_set_bits_raw,
+	.port_clear_bits_raw = gpio_ad5592_port_clear_bits_raw,
+	.port_toggle_bits = gpio_ad5592_port_toggle_bits,
+	.pin_interrupt_configure = gpio_ad5592_pin_interrupt_configure,
+};
+
+static int gpio_ad5592_init(const struct device *dev)
+{
+	const struct gpio_ad5592_config *config = dev->config;
+
+	if (!device_is_ready(config->mfd_dev)) {
+		return -ENODEV;
+	}
+
+	return 0;
+}
+
+#define GPIO_AD5592_DEFINE(inst)							\
+	static const struct gpio_ad5592_config gpio_ad5592_config##inst = {		\
+		.common = {								\
+			.port_pin_mask =						\
+			GPIO_PORT_PIN_MASK_FROM_DT_INST(inst),				\
+		},									\
+		.mfd_dev = DEVICE_DT_GET(DT_INST_PARENT(inst)),				\
+	};										\
+											\
+	static struct gpio_ad5592_data gpio_ad5592_data##inst;				\
+											\
+	DEVICE_DT_INST_DEFINE(inst, gpio_ad5592_init, NULL,				\
+			      &gpio_ad5592_data##inst, &gpio_ad5592_config##inst,	\
+			      POST_KERNEL, CONFIG_GPIO_AD5592_INIT_PRIORITY,		\
+			      &gpio_ad5592_api);
+
+DT_INST_FOREACH_STATUS_OKAY(GPIO_AD5592_DEFINE)
diff --git a/dts/bindings/gpio/adi,ad5592-gpio.yaml b/dts/bindings/gpio/adi,ad5592-gpio.yaml
@@ -0,0 +1,12 @@
+# Copyright (c) 2023 Grinn
+# SPDX-License-Identifier: Apache-2.0
+
+description: AD5592 GPIO Controller
+
+compatible: "adi,ad5592-gpio"
+
+include: gpio-controller.yaml
+
+gpio-cells:
+  - pin
+  - flags
diff --git a/tests/drivers/build_all/gpio/app.overlay b/tests/drivers/build_all/gpio/app.overlay
@@ -210,7 +210,7 @@
 			clock-frequency = <2000000>;
 
 			/* one entry for every devices at spi.dtsi */
-			cs-gpios = <&test_gpio 0 0 &test_gpio 0 0 &test_gpio 0 0>;
+			cs-gpios = <&test_gpio 0 0 &test_gpio 0 0 &test_gpio 0 0 &test_gpio 0 0>;
 
 			test_spi_mcp23s17: mcp23s17@0 {
 				compatible = "microchip,mcp23s17";
@@ -259,6 +259,21 @@
 					#gpio-cells = <2>;
 				};
 			};
+
+			test_spi_ad5592: ad5592@0 {
+				compatible = "adi,ad5592";
+				status = "okay";
+				reg = <0x0>;
+				spi-max-frequency = <0>;
+				reset-gpios = <&test_gpio 0 0>;
+
+				ad5592_gpio: gpio-controller {
+					compatible = "adi,ad5592-gpio";
+					gpio-controller;
+					#gpio-cells = <2>;
+					ngpios = <8>;
+				};
+			};
 		};
 	};
 };