mcp23x17.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "periph/gpio.h"
#include "periph/i2c.h"
#include "periph/spi.h"
 
#if IS_USED(MODULE_SAUL_GPIO) || DOXYGEN
#include "saul/periph.h"
#endif /* MODULE_SAUL_GPIO */
 
#if !IS_USED(MODULE_MCP23X17_I2C) && !IS_USED(MODULE_MCP23X17_SPI)
#error "Please provide the MCP23x17 variants used by the application."
#error "At least one variant has to be specified (mcp23017 and/or mcp23s17)."
#endif
 
#if IS_USED(MODULE_MCP23X17_IRQ) || DOXYGEN
 
#include "event.h"
 
#endif /* MODULE_MCP23X17_IRQ */
 
#define MCP23X17_BASE_ADDR          (0x20)
 
#define MCP23X17_GPIO_PIN_NUM       (16)
 
#define MCP23X17_GPIO_PIN(port, pin) ((gpio_t)((port << 3) | pin))
 
typedef enum {
    MCP23X17_OK,                    
    MCP23X17_ERROR_I2C,             
    MCP23X17_ERROR_SPI,             
    MCP23X17_ERROR_NO_DEV,          
    MCP23X17_ERROR_INV_MODE,        
    MCP23X17_ERROR_INV_FLANK,       
    MCP23X17_ERROR_GPIO,            
    MCP23X17_ERROR_INT_PIN,         
    MCP23X17_ERROR_RESET_PIN,       
} mcp23x17_error_codes_t;
 
typedef enum {
#if IS_USED(MODULE_MCP23X17_I2C) || DOXYGEN
    MCP23X17_I2C,                   
#endif
#if IS_USED(MODULE_MCP23X17_SPI) || DOXYGEN
    MCP23X17_SPI,                   
#endif
} mcp23x17_if_t;
 
#if IS_USED(MODULE_MCP23X17_I2C) || DOXYGEN
typedef struct {
    i2c_t dev;                      
} mcp23x17_i2c_params_t;
#endif
 
#if IS_USED(MODULE_MCP23X17_SPI) || DOXYGEN
typedef struct {
    spi_t     dev;                  
    spi_clk_t clk;                  
    gpio_t    cs;                   
} mcp23x17_spi_params_t;
#endif
 
typedef struct {
    mcp23x17_if_t type;             
    union {
#if IS_USED(MODULE_MCP23X17_I2C) || DOXYGEN
        mcp23x17_i2c_params_t i2c;  
#endif
#if IS_USED(MODULE_MCP23X17_SPI) || DOXYGEN
        mcp23x17_spi_params_t spi;  
#endif
    };
} mcp23x17_if_params_t;
 
typedef struct {
    uint8_t addr;
    gpio_t int_pin;     
    gpio_t reset_pin;   
    mcp23x17_if_params_t if_params; 
} mcp23x17_params_t;
 
#if IS_USED(MODULE_MCP23X17_IRQ) || DOXYGEN
typedef struct {
    event_t event;      
    void *dev;          
} mcp23x17_irq_event_t;
 
#endif /* MODULE_MCP23X17_IRQ */
 
typedef struct {
    mcp23x17_params_t params;   
    uint16_t od_pins;           
#if IS_USED(MODULE_MCP23X17_IRQ) || DOXYGEN
    gpio_isr_ctx_t isr[MCP23X17_GPIO_PIN_NUM];  
    gpio_flank_t flank[MCP23X17_GPIO_PIN_NUM];  
    mcp23x17_irq_event_t irq_event;             
#endif /* MODULE_MCP23X17_IRQ */
 
} mcp23x17_t;
 
#if IS_USED(MODULE_SAUL_GPIO) || DOXYGEN
typedef struct {
    uint8_t dev;                
    saul_gpio_params_t gpio;    
} mcp23x17_saul_gpio_params_t;
#endif
 
int mcp23x17_init(mcp23x17_t *dev, const mcp23x17_params_t *params);
 
int mcp23x17_gpio_init(mcp23x17_t *dev, gpio_t pin, gpio_mode_t mode);
 
#if IS_USED(MODULE_MCP23X17_IRQ) || DOXYGEN
int mcp23x17_gpio_init_int(mcp23x17_t *dev, gpio_t pin,
                                          gpio_mode_t mode,
                                          gpio_flank_t flank,
                                          gpio_cb_t isr,
                                          void *arg);
#endif /* MODULE_MCP23X17_IRQ || DOXYGEN */
 
int mcp23x17_gpio_read(mcp23x17_t *dev, gpio_t pin);
 
void mcp23x17_gpio_write(mcp23x17_t *dev, gpio_t pin, int value);
 
void mcp23x17_gpio_clear(mcp23x17_t *dev, gpio_t pin);
 
void mcp23x17_gpio_set(mcp23x17_t *dev, gpio_t pin);
 
void mcp23x17_gpio_toggle(mcp23x17_t *dev, gpio_t pin);
 
#if IS_USED(MODULE_MCP23X17_IRQ) || DOXYGEN
void mcp23x17_gpio_irq_enable(mcp23x17_t *dev, gpio_t pin);
 
void mcp23x17_gpio_irq_disable(mcp23x17_t *dev, gpio_t pin);
 
#endif /* MODULE_MCP23X17_IRQ || DOXYGEN */
 
#ifdef __cplusplus
}
#endif