mfd_sc18is604.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 TiaC Systems
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_DRIVERS_MFD_SC18IS604_H_
#define ZEPHYR_DRIVERS_MFD_SC18IS604_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/kernel.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/spi.h>
 
#include <zephyr/drivers/mfd/sc18is604.h>
 
/*
 * Values in Hz, intentionally to be comparable with the spi-max-frequency
 * property from DT bindings in spi-device.yaml.
 */
#define MFD_SC18IS604_SPI_HZ_MIN 100000
#define MFD_SC18IS604_SPI_HZ_MAX 1200000
 
#define MFD_SC18IS604_SPI_DELAY_USEC   8 /* between two SPI bytes */
#define MFD_SC18IS604_RESET_SETUP_USEC 1 /* >= 125ns acceptance time */
#define MFD_SC18IS604_RESET_TIME_USEC  500
 
/* timeout for about two times a maximum command (three byte) at 100kHz */
#define MFD_SC18IS604_CMD_MAX_TOUT_USEC 200
 
/* expected chip in version string */
#define MFD_SC18IS604_VERSION_CHIP "SC18IS604"
BUILD_ASSERT(ARRAY_SIZE(MFD_SC18IS604_VERSION_CHIP) <= SC18IS604_VERSION_STRING_SIZE,
             "Chip name too long");
 
struct mfd_sc18is604_config {
        const struct spi_dt_spec spi;
        const struct gpio_dt_spec interrupt;
        const struct gpio_dt_spec reset;
};
 
struct mfd_sc18is604_data {
        const struct device *dev;
        struct k_sem lock;
        struct gpio_callback interrupt_cb;
        struct k_sem interrupt_signal;
        sys_slist_t child_callbacks;
#ifdef CONFIG_MFD_SC18IS604_ASYNC
        struct k_work_q work_queue;
        k_thread_stack_t *work_queue_stack;
#endif /* CONFIG_MFD_SC18IS604_ASYNC */
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_DRIVERS_MFD_SC18IS604_H_ */