PCA9555 GPIO Controller (w/regrst)

GPIO controller for an PCA9555 (w/regrst) More...

Data Structures
struct	gpio_pca9555_regrst_config
	Configuration data. More...
struct	gpio_pca9555_regrst_drv_data
	Runtime driver data. More...

Macros
#define	REG_INPUT_PORT0   0x00
#define	REG_INPUT_PORT1   0x01
#define	REG_OUTPUT_PORT0   0x02
#define	REG_OUTPUT_PORT1   0x03
#define	REG_OUTPUT_DFLT   0xFFFF
#define	REG_POL_INV_PORT0   0x04
#define	REG_POL_INV_PORT1   0x05
#define	REG_POL_INV_DFLT   0x0000
#define	REG_CONF_PORT0   0x06
#define	REG_CONG_PORT1   0x07
#define	REG_CONG_DFLT   0xFFFF
#define	PCA_HAS_INTERRUPT   BIT(1)
#define	PCA_HAS_RST_DFLTS   BIT(7)
#define	GPIO_PCA9555_REGRST_DEVICE_INSTANCE(inst)

Functions
static int	read_port_regs (const struct device *dev, uint8_t reg, uint16_t *cache, uint16_t *buf)
	Read both port 0 and port 1 registers of certain register function.
static int	write_port_regs (const struct device *dev, uint8_t reg, uint16_t *cache, uint16_t value)
	Write both port 0 and port 1 registers of certain register function.
static int	update_input_regs (const struct device *dev, uint16_t *buf)
static int	update_output_regs (const struct device *dev, uint16_t value)
static int	update_direction_regs (const struct device *dev, uint16_t value)
static int	setup_pin_dir (const struct device *dev, uint32_t pin, int flags)
	Setup the pin direction (input or output)
static int	gpio_pca9555_regrst_config (const struct device *dev, gpio_pin_t pin, gpio_flags_t flags)
	Configure pin or port.
static int	gpio_pca9555_regrst_port_get_raw (const struct device *dev, uint32_t *value)
static int	gpio_pca9555_regrst_port_set_masked_raw (const struct device *dev, uint32_t mask, uint32_t value)
static int	gpio_pca9555_regrst_port_set_bits_raw (const struct device *dev, uint32_t mask)
static int	gpio_pca9555_regrst_port_clear_bits_raw (const struct device *dev, uint32_t mask)
static int	gpio_pca9555_regrst_port_toggle_bits (const struct device *dev, uint32_t mask)
static int	gpio_pca9555_regrst_pin_interrupt_configure (const struct device *dev, gpio_pin_t pin, enum gpio_int_mode mode, enum gpio_int_trig trig)
static int	gpio_pca9555_regrst_reset_defaults (const struct device *dev)
	Reset defaults function of PCA9555.
static int	gpio_pca9555_regrst_init (const struct device *dev)
	Initialization function of PCA9555.

Variables
static const struct gpio_driver_api	gpio_pca9555_regrst_drv_api_funcs

Detailed Description

GPIO controller for an PCA9555 (w/regrst)

Since

3.4

Version

1.0.0

The GPIO controller for the I2C-based PCA9555 chip with the reset register to defaults feature.

Macro Definition Documentation

GPIO_PCA9555_REGRST_DEVICE_INSTANCE

#define GPIO_PCA9555_REGRST_DEVICE_INSTANCE

(

inst

)

#include <drivers/gpio/gpio_pca9555_regrst.c>

Value:

static const struct gpio_pca9555_regrst_config                          \
gpio_pca9555_regrst_##inst##_cfg = {                                    \
        .common = {                                                     \
                .port_pin_mask = GPIO_PORT_PIN_MASK_FROM_DT_INST(inst), \
        },                                                              \
        .bus = I2C_DT_SPEC_INST_GET(inst),                              \
        .capabilities =                                                 \
                (DT_INST_PROP(inst, rst_dflts) ?                        \
                        PCA_HAS_RST_DFLTS : 0) |                        \
                IF_ENABLED(CONFIG_GPIO_PCA9555_REGRST_INTERRUPT, (      \
                (DT_INST_NODE_HAS_PROP(inst, interrupt_gpios) ?         \
                        PCA_HAS_INTERRUPT : 0) |                        \
                ))                                                      \
                0,                                                      \
        IF_ENABLED(CONFIG_GPIO_PCA9555_REGRST_INTERRUPT, (              \
                .int_gpio = GPIO_DT_SPEC_INST_GET_OR(                   \
                        inst, interrupt_gpios, {}),                     \
        ))                                                              \
};                                                                      \
                                                                        \
static struct gpio_pca9555_regrst_drv_data                              \
gpio_pca9555_regrst_##inst##_drvdata = {                                \
        .reg_cache.input = 0x0,                                         \
        .reg_cache.output = REG_OUTPUT_DFLT,                            \
        .reg_cache.dir = REG_CONG_DFLT,                                 \
        IF_ENABLED(CONFIG_GPIO_PCA9555_REGRST_INTERRUPT, (              \
        .interrupt_active = false,                                      \
        ))                                                              \
};                                                                      \
                                                                        \
DEVICE_DT_INST_DEFINE(inst,                                             \
        gpio_pca9555_regrst_init,                                       \
        NULL,                                                           \
        &gpio_pca9555_regrst_##inst##_drvdata,                          \
        &gpio_pca9555_regrst_##inst##_cfg,                              \
        POST_KERNEL, CONFIG_GPIO_PCA9555_REGRST_INIT_PRIORITY,          \
        &gpio_pca9555_regrst_drv_api_funcs);

PCA_HAS_INTERRUPT

#define PCA_HAS_INTERRUPT   BIT(1)

#include <drivers/gpio/gpio_pca9555_regrst.c>

PCA_HAS_RST_DFLTS

#define PCA_HAS_RST_DFLTS   BIT(7)

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_CONF_PORT0

#define REG_CONF_PORT0   0x06

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_CONG_DFLT

#define REG_CONG_DFLT   0xFFFF

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_CONG_PORT1

#define REG_CONG_PORT1   0x07

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_INPUT_PORT0

#define REG_INPUT_PORT0   0x00

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_INPUT_PORT1

#define REG_INPUT_PORT1   0x01

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_OUTPUT_DFLT

#define REG_OUTPUT_DFLT   0xFFFF

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_OUTPUT_PORT0

#define REG_OUTPUT_PORT0   0x02

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_OUTPUT_PORT1

#define REG_OUTPUT_PORT1   0x03

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_POL_INV_DFLT

#define REG_POL_INV_DFLT   0x0000

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_POL_INV_PORT0

#define REG_POL_INV_PORT0   0x04

#include <drivers/gpio/gpio_pca9555_regrst.c>

REG_POL_INV_PORT1

#define REG_POL_INV_PORT1   0x05

#include <drivers/gpio/gpio_pca9555_regrst.c>

Function Documentation

gpio_pca9555_regrst_config()

static int gpio_pca9555_regrst_config ( const struct device *  dev, gpio_pin_t  pin, gpio_flags_t  flags  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Configure pin or port.

Parameters

dev	Device struct of the PCA9555
pin	The pin number
flags	Flags of pin or port

Returns

0 if successful, failed otherwise

gpio_pca9555_regrst_init()

static int gpio_pca9555_regrst_init ( const struct device *  dev )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Initialization function of PCA9555.

Parameters

dev	Device struct

Returns

0 if successful, failed otherwise.

gpio_pca9555_regrst_pin_interrupt_configure()

static int gpio_pca9555_regrst_pin_interrupt_configure ( const struct device *  dev, gpio_pin_t  pin, enum gpio_int_mode  mode, enum gpio_int_trig  trig  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

gpio_pca9555_regrst_port_clear_bits_raw()

static int gpio_pca9555_regrst_port_clear_bits_raw ( const struct device *  dev, uint32_t  mask  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

gpio_pca9555_regrst_port_get_raw()

static int gpio_pca9555_regrst_port_get_raw ( const struct device *  dev, uint32_t *  value  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

gpio_pca9555_regrst_port_set_bits_raw()

static int gpio_pca9555_regrst_port_set_bits_raw ( const struct device *  dev, uint32_t  mask  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

gpio_pca9555_regrst_port_set_masked_raw()

static int gpio_pca9555_regrst_port_set_masked_raw ( const struct device *  dev, uint32_t  mask, uint32_t  value  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

gpio_pca9555_regrst_port_toggle_bits()

static int gpio_pca9555_regrst_port_toggle_bits ( const struct device *  dev, uint32_t  mask  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

gpio_pca9555_regrst_reset_defaults()

static int gpio_pca9555_regrst_reset_defaults ( const struct device *  dev )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Reset defaults function of PCA9555.

Parameters

dev	Device struct

Returns

0 if successful, failed otherwise.

read_port_regs()

static int read_port_regs ( const struct device *  dev, uint8_t  reg, uint16_t *  cache, uint16_t *  buf  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Read both port 0 and port 1 registers of certain register function.

Given the register in reg, read the pair of port 0 and port 1.

Parameters

dev	Device struct of the PCA9555.
reg	Register to read (the PORT0 of the pair of registers).
cache	Pointer to the cache to be updated after successful read.
buf	Buffer to read data into.

Returns

0 if successful, failed otherwise.

setup_pin_dir()

static int setup_pin_dir ( const struct device *  dev, uint32_t  pin, int  flags  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Setup the pin direction (input or output)

Parameters

dev	Device struct of the PCA9555
pin	The pin number
flags	Flags of pin or port

Returns

0 if successful, failed otherwise

update_direction_regs()

static int update_direction_regs ( const struct device *  dev, uint16_t  value  )

inlinestatic

#include <drivers/gpio/gpio_pca9555_regrst.c>

update_input_regs()

static int update_input_regs ( const struct device *  dev, uint16_t *  buf  )

inlinestatic

#include <drivers/gpio/gpio_pca9555_regrst.c>

update_output_regs()

static int update_output_regs ( const struct device *  dev, uint16_t  value  )

inlinestatic

#include <drivers/gpio/gpio_pca9555_regrst.c>

write_port_regs()

static int write_port_regs ( const struct device *  dev, uint8_t  reg, uint16_t *  cache, uint16_t  value  )

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Write both port 0 and port 1 registers of certain register function.

Given the register in reg, write the pair of port 0 and port 1.

Parameters

dev	Device struct of the PCA9555.
reg	Register to write into (the PORT0 of the pair of registers).
cache	Pointer to the cache to be updated after successful write.
value	New value to set.

Returns

0 if successful, failed otherwise.

Variable Documentation

gpio_pca9555_regrst_drv_api_funcs

const struct gpio_driver_api gpio_pca9555_regrst_drv_api_funcs

static

#include <drivers/gpio/gpio_pca9555_regrst.c>

Initial value:

= {
        .pin_configure = gpio_pca9555_regrst_config,
        .port_get_raw = gpio_pca9555_regrst_port_get_raw,
        .port_set_masked_raw = gpio_pca9555_regrst_port_set_masked_raw,
        .port_set_bits_raw = gpio_pca9555_regrst_port_set_bits_raw,
        .port_clear_bits_raw = gpio_pca9555_regrst_port_clear_bits_raw,
        .port_toggle_bits = gpio_pca9555_regrst_port_toggle_bits,
        .pin_interrupt_configure = gpio_pca9555_regrst_pin_interrupt_configure,
 
 
 
}