drivers/sensor/ti/opt3001/opt3001.h

/*
 * Copyright (c) 2019 Actinius
 * Copyright (c) 2025 Bang & Olufsen A/S
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef ZEPHYR_DRIVERS_SENSOR_OPT3001_H_
#define ZEPHYR_DRIVERS_SENSOR_OPT3001_H_

#include <zephyr/sys/util.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/sensor.h>
#include <zephyr/kernel.h>

#define OPT3001_REG_RESULT 0x00
#define OPT3001_REG_CONFIG 0x01
#define OPT3001_REG_LOW_LIMIT 0x02
#define OPT3001_REG_MANUFACTURER_ID 0x7E
#define OPT3001_REG_DEVICE_ID 0x7F

#define OPT3001_MANUFACTURER_ID_VALUE 0x5449
#define OPT3001_DEVICE_ID_VALUE 0x3001

#define OPT3001_CONVERSION_MODE_MASK (BIT(10) | BIT(9))
#define OPT3001_CONVERSION_MODE_CONTINUOUS (BIT(10) | BIT(9))

#define OPT3001_LIMIT_EXPONENT_MASK (BIT(15) | BIT(14) | BIT(13) | BIT(12))
#define OPT3001_LIMIT_EXPONENT_DEFAULT 0x0000

#define OPT3001_SAMPLE_EXPONENT_SHIFT 12
#define OPT3001_MANTISSA_MASK 0xfff

#ifdef CONFIG_OPT3001_TRIGGER
int opt3001_init_interrupt(const struct device *dev);

int opt3001_trigger_set(const struct device *dev, const struct sensor_trigger *trig,
			sensor_trigger_handler_t handler);

int opt3001_reg_update(const struct device *dev, uint8_t reg, uint16_t mask, uint16_t val);

int opt3001_reg_read(const struct device *dev, uint8_t reg, uint16_t *val);

#endif

struct opt3001_data {
	uint16_t sample;

#ifdef CONFIG_OPT3001_TRIGGER
	const struct device *dev;
	struct gpio_callback gpio_cb_int;

	const struct sensor_trigger *trigger;
	sensor_trigger_handler_t handler;
	struct k_mutex handler_mutex;

#if defined(CONFIG_OPT3001_TRIGGER_OWN_THREAD)
	K_KERNEL_STACK_MEMBER(thread_stack, CONFIG_OPT3001_THREAD_STACK_SIZE);
	struct k_sem gpio_sem;
	struct k_thread thread;
#elif defined(CONFIG_OPT3001_TRIGGER_GLOBAL_THREAD)
	struct k_work work_int;
#endif

#endif
};

struct opt3001_config {
	struct i2c_dt_spec i2c;
#ifdef CONFIG_OPT3001_TRIGGER
	const struct gpio_dt_spec gpio_int;
#endif
};

#endif /* _SENSOR_OPT3001_ */