sc18is604.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 TiaC Systems
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MFD_SC18IS604_H_
#define ZEPHYR_INCLUDE_DRIVERS_MFD_SC18IS604_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include <zephyr/device.h>
#include <zephyr/kernel.h>
#include <zephyr/drivers/gpio.h>
 
#define SC18IS604_CMD_WRITE_I2C                 0x00
#define SC18IS604_CMD_READ_I2C                  0x01
#define SC18IS604_CMD_READ_AFTER_WRITE_I2C      0x02
#define SC18IS604_CMD_WRITE_AFTER_WRITE_I2C     0x03
#define SC18IS604_CMD_READ_BUFFER               0x06
#define SC18IS604_CMD_SPI_CONFIG                0x18
#define SC18IS604_CMD_WRITE_REGISTER            0x20
#define SC18IS604_CMD_READ_REGISTER             0x21
#define SC18IS604_CMD_POWER_DOWN                0x30
#define SC18IS604_CMD_POWER_DOWN_KEY1           0x5A
#define SC18IS604_CMD_POWER_DOWN_KEY2           0xA5
#define SC18IS604_CMD_VERSION_STRING            0xFE
 
/*
 * The version string is in the form "SC18IS604 1.0.0". The total
 * length is 16 bytes and includes a 00h null terminator.
 */
#define SC18IS604_VERSION_STRING_SIZE           16
 
#define SC18IS604_REG_IO_CONFIG                 0x00
#define SC18IS604_REG_IO_STATE                  0x01
#define SC18IS604_REG_I2C_CLOCK                 0x02
#define SC18IS604_REG_I2C_TIMEOUT               0x03
#define SC18IS604_REG_I2C_STATUS                0x04
#define SC18IS604_REG_I2C_ADDRESS               0x05
 
#define SC18IS604_IO_NUM_PINS_INOUT             4
#define SC18IS604_IO_NUM_PINS_IONLY             1
#define SC18IS604_IO_NUM_PINS_MAX               (SC18IS604_IO_NUM_PINS_INOUT \
                                                + SC18IS604_IO_NUM_PINS_IONLY)
 
#define SC18IS604_IO_CONFIG_INPUT               0b00
#define SC18IS604_IO_CONFIG_PUSH_PULL           0b10
#define SC18IS604_IO_CONFIG_OPEN_DRAIN          0b11
 
#define SC18IS604_I2C_STATUS_SUCCESS            0xF0
#define SC18IS604_I2C_STATUS_DEVICE_ADDR_NACK   0xF1
#define SC18IS604_I2C_STATUS_BYTE_NACK          0xF2
#define SC18IS604_I2C_STATUS_BUSY               0xF3
 
#define SC18IS604_I2C_CLOCK_99KHZ               19
#define SC18IS604_I2C_CLOCK_375KHZ              5
 
int mfd_sc18is604_transfer(const struct device *dev,
                           uint8_t *cmd, size_t cmd_len,
                           uint8_t *tx_data, size_t tx_len,
                           uint8_t *rx_data, size_t rx_len);
 
 
int mfd_sc18is604_read_register(const struct device *dev,
                                uint8_t reg, uint8_t *val);
 
#define READ_SC18IS604_REG(dev, reg, val) \
        mfd_sc18is604_read_register((dev), SC18IS604_REG_##reg, (val));
 
int mfd_sc18is604_write_register(const struct device *dev,
                                 uint8_t reg, uint8_t val);
 
#define WRITE_SC18IS604_REG(dev, reg, val) \
        mfd_sc18is604_write_register((dev), SC18IS604_REG_##reg, (val));
 
int mfd_sc18is604_read_buffer(const struct device *dev,
                              uint8_t *data, size_t len);
 
int mfd_sc18is604_add_callback(const struct device *dev,
                               struct gpio_callback *callback);
 
int mfd_sc18is604_remove_callback(const struct device *dev,
                                  struct gpio_callback *callback);
 
int mfd_sc18is604_claim(const struct device *dev, k_timeout_t timeout);
 
void mfd_sc18is604_release(const struct device *dev);
 
#if defined(CONFIG_MFD_SC18IS604_ASYNC)
 
int mfd_sc18is604_transfer_signal(const struct device *dev,
                                  uint8_t *cmd, size_t cmd_len,
                                  uint8_t *tx_data, size_t tx_len,
                                  uint8_t *rx_data, size_t rx_len,
                                  struct k_poll_signal *signal);
 
int mfd_sc18is604_read_register_signal(const struct device *dev,
                                       uint8_t reg, uint8_t *val,
                                       struct k_poll_signal *signal);
 
#define READ_SC18IS604_REG_SIGNAL(dev, reg, val, signal) \
        mfd_sc18is604_read_register_signal((dev), SC18IS604_REG_##reg, (val), (signal));
 
int mfd_sc18is604_read_buffer_signal(const struct device *dev,
                              uint8_t *data, size_t len,
                              struct k_poll_signal *signal);
 
#endif /* defined(CONFIG_MFD_SC18IS604_ASYNC) */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MFD_SC18IS604_H_ */