vcnl36825t: add trigger capability

Adds trigger capability to the Vishay VCNL36825T sensor.

Signed-off-by: Juliane Schulze <[email protected]>

Author: deveritec-jusc

drivers/sensor/vishay/vcnl36825t/CMakeLists.txt

@@ -4,3 +4,4 @@
 zephyr_library()
 
 zephyr_library_sources(vcnl36825t.c)
+zephyr_library_sources_ifdef(CONFIG_VCNL36825T_TRIGGER vcnl36825t_trigger.c)

drivers/sensor/vishay/vcnl36825t/Kconfig

@@ -10,3 +10,49 @@ config VCNL36825T
 	select I2C
 	help
 	  Enable driver for VCNL36825T sensors.
+
+if VCNL36825T
+
+config VCNL36825T_TRIGGER
+	bool
+
+choice VCNL36825T_TRIGGER_CHOICE
+	prompt "trigger mode"
+	default VCNL36825T_TRIGGER_NONE
+	help
+	  Specify the type of triggering to be used by the driver.
+	  Note: Since figuring out which interrupt was triggered, using the Zephyr
+	  standard types will deactivate the other interrupt.
+
+config VCNL36825T_TRIGGER_NONE
+	bool "no trigger"
+
+config VCNL36825T_TRIGGER_GLOBAL_THREAD
+	bool "use global thread"
+	select VCNL36825T_TRIGGER
+
+config VCNL36825T_TRIGGER_OWN_THREAD
+	bool "use own thread"
+	select VCNL36825T_TRIGGER
+
+endchoice
+
+if VCNL36825T_TRIGGER
+
+config VCNL36825T_THREAD_PRIORITY
+	int "thread priority"
+	depends on VCNL36825T_TRIGGER_OWN_THREAD
+	default 10
+	help
+	  Priority of thread used by the driver to handle interrupts.
+
+config VCNL36825T_THREAD_STACK_SIZE
+	int "thread stack size"
+	depends on VCNL36825T_TRIGGER_OWN_THREAD
+	default 1024
+	help
+	  Stack size of thread used by the driver to handle interrupts.
+
+endif # VCNL36825T_TRIGGER
+
+endif # VCNL36825T

drivers/sensor/vishay/vcnl36825t/vcnl36825t.c

@@ -11,14 +11,16 @@
 #include <stdlib.h>
 
 #include <zephyr/drivers/i2c.h>
+#include <zephyr/drivers/sensor.h>
 #include <zephyr/logging/log.h>
 #include <zephyr/pm/device.h>
 #include <zephyr/sys/byteorder.h>
+#include <zephyr/sys/check.h>
 #include <zephyr/sys/util.h>
 
 LOG_MODULE_REGISTER(VCNL36825T, CONFIG_SENSOR_LOG_LEVEL);
 
-static int vcnl36825t_read(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t *value)
+int vcnl36825t_read(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t *value)
 {
 	uint8_t rx_buf[2];
 	int rc;
@@ -33,16 +35,16 @@ static int vcnl36825t_read(const struct i2c_dt_spec *spec, uint8_t reg_addr, uin
 	return 0;
 }
 
-static int vcnl36825t_write(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t value)
+int vcnl36825t_write(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t value)
 {
 	uint8_t tx_buf[3] = {reg_addr};
 
 	sys_put_le16(value, &tx_buf[1]);
 	return i2c_write_dt(spec, tx_buf, sizeof(tx_buf));
 }
 
-static int vcnl36825t_update(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t mask,
-			     uint16_t value)
+int vcnl36825t_update(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t mask,
+		      uint16_t value)
 {
 	int rc;
 	uint16_t old_value, new_value;
@@ -210,6 +212,36 @@ static int vcnl36825t_channel_get(const struct device *dev, enum sensor_channel
 	return 0;
 }
 
+static int vcnl36825t_attr_set(const struct device *dev, enum sensor_channel chan,
+			       enum sensor_attribute attr, const struct sensor_value *val)
+{
+	CHECKIF(dev == NULL) {
+		LOG_ERR("dev: NULL");
+		return -EINVAL;
+	}
+
+	CHECKIF(val == NULL) {
+		LOG_ERR("val: NULL");
+		return -EINVAL;
+	}
+
+	int __maybe_unused rc;
+
+	switch (attr) {
+	default:
+#if CONFIG_VCNL36825T_TRIGGER
+		rc = vcnl36825t_trigger_attr_set(dev, chan, attr, val);
+		if (rc < 0) {
+			return rc;
+		}
+#else
+		return -ENOTSUP;
+#endif
+	}
+
+	return 0;
+}
+
 /**
  * @brief calculate measurement timeout in us
  *
@@ -485,6 +517,12 @@ static int vcnl36825t_init(const struct device *dev)
 		return rc;
 	}
 
+#if CONFIG_VCNL36825T_TRIGGER
+	rc = vcnl36825t_trigger_init(dev);
+	if (rc < 0) {
+		return rc;
+	}
+#endif
 	rc = vcnl36825t_update(&config->i2c, VCNL36825T_REG_PS_CONF2, VCNL36825T_PS_ST_MSK,
 			       VCNL36825T_PS_ST_START);
 	if (rc < 0) {
@@ -498,6 +536,10 @@ static int vcnl36825t_init(const struct device *dev)
 static const struct sensor_driver_api vcnl36825t_driver_api = {
 	.sample_fetch = vcnl36825t_sample_fetch,
 	.channel_get = vcnl36825t_channel_get,
+	.attr_set = vcnl36825t_attr_set,
+#if CONFIG_VCNL36825T_TRIGGER
+	.trigger_set = vcnl36825t_trigger_set,
+#endif
 };
 
 #define VCNL36825T_DEFINE(inst)                                                                    \
@@ -524,7 +566,11 @@ static const struct sensor_driver_api vcnl36825t_driver_api = {
 		.laser_current = DT_INST_ENUM_IDX(inst, laser_current),                            \
 		.high_dynamic_output = DT_INST_PROP(inst, high_dynamic_output),                    \
 		.sunlight_cancellation = DT_INST_PROP(inst, sunlight_cancellation),                \
-	};                                                                                         \
+		IF_ENABLED(CONFIG_VCNL36825T_TRIGGER,                                              \
+			   (.int_gpio = GPIO_DT_SPEC_INST_GET(inst, int_gpios),                    \
+			    .int_mode = DT_INST_ENUM_IDX(inst, int_mode),                          \
+			    .int_proximity_count = DT_INST_PROP(inst, int_proximity_count),        \
+			    .int_smart_persistence = DT_INST_PROP(inst, int_smart_persistence)))}; \
 	IF_ENABLED(CONFIG_PM_DEVICE, (PM_DEVICE_DT_INST_DEFINE(inst, vcnl36825t_pm_action)));      \
 	SENSOR_DEVICE_DT_INST_DEFINE(                                                              \
 		inst, vcnl36825t_init,                                                             \

drivers/sensor/vishay/vcnl36825t/vcnl36825t.h

@@ -56,7 +56,10 @@
 #define VCNL36825T_PS_MPS_POS		12
 #define VCNL36825T_PS_IT_POS		14
 
-#define VCNL36825T_PS_ST_MSK	GENMASK(0, 0)
+#define VCNL36825T_PS_ST_MSK		GENMASK(0, 0)
+#define VCNL36825T_PS_SMART_PERS_MSK	GENMASK(1, 1)
+#define VCNL36825T_PS_INT_MSK		GENMASK(3, 2)
+#define VCNL36825T_PS_PERS_MSK		GENMASK(5, 4)
 
 #define VCNL36825T_PS_ST_START	(0 << VCNL36825T_PS_ST_POS)
 #define VCNL36825T_PS_ST_STOP	(1 << VCNL36825T_PS_ST_POS)
@@ -65,9 +68,9 @@
 #define VCNL36825T_PS_SMART_PERS_ENABLED	(1 << VCNL36825T_PS_PS_SMART_PERS_POS)
 
 #define VCNL36825T_PS_INT_DISABLE		(0 << VCNL36825T_PS_INT_POS)
-#define VCNL36825T_PS_INT_THDH_PERS_LATCHED	(1 << VCNL36825T_PS_INT_POS)
-#define VCNL36825T_PS_INT_THDH_FIRST_LATCHED	(2 << VCNL36825T_PS_INT_POS)
-#define VCNL36825T_PS_INT_ENABLED		(3 << VCNL36825T_PS_INT_POS)
+#define VCNL36825T_PS_INT_MODE_LOGIC_HIGH_LOW	(1 << VCNL36825T_PS_INT_POS)
+#define VCNL36825T_PS_INT_MODE_FIRST_HIGH	(2 << VCNL36825T_PS_INT_POS)
+#define VCNL36825T_PS_INT_MODE_NORMAL		(3 << VCNL36825T_PS_INT_POS)
 
 #define VCNL36825T_PS_PERS_1	(0 << VCNL36825T_PS_PERS_POS)
 #define VCNL36825T_PS_PERS_2	(1 << VCNL36825T_PS_PERS_POS)
@@ -281,6 +284,12 @@ enum vcnl38625t_laser_current {
 	VCNL36825T_LASER_CURRENT_20MS,
 };
 
+enum vcnl36825t_int_mode {
+	VCNL36825T_INT_MODE_NORMAL,
+	VCNL36825T_INT_MODE_FIRST_HIGH,
+	VCNL36825T_INT_MODE_LOGIC_HIGH_LOW,
+};
+
 struct vcnl36825t_config {
 	struct i2c_dt_spec i2c;
 
@@ -297,6 +306,13 @@ struct vcnl36825t_config {
 	enum vcnl38625t_laser_current laser_current;
 	bool high_dynamic_output;
 	bool sunlight_cancellation;
+
+#if CONFIG_VCNL36825T_TRIGGER
+	struct gpio_dt_spec int_gpio;
+	enum vcnl36825t_int_mode int_mode;
+	uint8_t int_proximity_count;
+	bool int_smart_persistence;
+#endif
 };
 
 struct vcnl36825t_data {
@@ -308,6 +324,42 @@ struct vcnl36825t_data {
 	unsigned int meas_timeout_running_us;
 	unsigned int meas_timeout_wakeup_us;
 #endif
+
+#if CONFIG_VCNL36825T_TRIGGER
+	const struct device *dev;
+	const struct gpio_dt_spec *int_gpio;
+
+	const struct sensor_trigger *int_trigger;
+	sensor_trigger_handler_t int_handler;
+
+	struct gpio_callback int_gpio_handler;
+
+#if CONFIG_VCNL36825T_TRIGGER_OWN_THREAD
+	K_KERNEL_STACK_MEMBER(int_thread_stack, CONFIG_VCNL36825T_THREAD_STACK_SIZE);
+	struct k_thread int_thread;
+	struct k_sem int_gpio_sem;
+#elif CONFIG_VCNL36825T_TRIGGER_GLOBAL_THREAD
+	struct k_work int_work;
+#endif
+#endif
 };
 
+int vcnl36825t_read(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t *value);
+
+int vcnl36825t_write(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t value);
+
+int vcnl36825t_update(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint16_t mask,
+		      uint16_t value);
+
+#if CONFIG_VCNL36825T_TRIGGER
+int vcnl36825t_trigger_init(const struct device *dev);
+
+int vcnl36825t_trigger_set(const struct device *dev, const struct sensor_trigger *trig,
+			   sensor_trigger_handler_t handler);
+
+int vcnl36825t_trigger_attr_set(const struct device *dev, enum sensor_channel chan,
+				enum sensor_attribute attr, const struct sensor_value *val);
+
+#endif
+
 #endif