pcf857x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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.
 */
 
#ifndef PCF857X_H
#define PCF857X_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <errno.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "kernel_defines.h"
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#if IS_USED(MODULE_SAUL_GPIO) || DOXYGEN
#include "saul/periph.h"
#endif /* MODULE_SAUL_GPIO */
 
#if IS_USED(MODULE_PCF857X_IRQ) || DOXYGEN
#include "event.h"
#endif /* MODULE_PCF857X_IRQ */
 
#ifndef PCF8575_BASE_ADDR
#define PCF8575_BASE_ADDR   (0x20)  
#endif
#ifndef PCF8574_BASE_ADDR
#define PCF8574_BASE_ADDR   (0x20)  
#endif
#ifndef PCF8574A_BASE_ADDR
#define PCF8574A_BASE_ADDR  (0x38)  
#endif
#define PCF8575_GPIO_PIN_NUM    (16) 
#define PCF8574_GPIO_PIN_NUM    (8)  
#define PCF8574A_GPIO_PIN_NUM   (8)  
#define PCF857X_GPIO_PIN(x,y)  (y)
 
#if IS_USED(MODULE_PCF8575) || DOXYGEN
 
#define PCF857X_GPIO_PIN_NUM   (16)
 
typedef uint16_t pcf857x_data_t;
 
#else /* MODULE_PCF8575 || DOXYGEN */
 
#define PCF857X_GPIO_PIN_NUM   (8)  
typedef uint8_t pcf857x_data_t;     
#endif /* MODULE_PCF8575 || DOXYGEN */
typedef enum {
    PCF857X_OK              = 0,        
    PCF857X_ERROR_I2C       = ENXIO,    
    PCF857X_ERROR_INV_EXP   = ENOTSUP,  
    PCF857X_ERROR_INV_MODE  = EINVAL,   
    PCF857X_ERROR_INV_FLANK = EINVAL,   
    PCF857X_ERROR_INT_PIN   = ENOSYS,   
} pcf857x_error_codes_t;
 
typedef enum {
#if IS_USED(MODULE_PCF8574) || DOXYGEN
    PCF857X_EXP_PCF8574,    
#endif
#if IS_USED(MODULE_PCF8574A) || DOXYGEN
    PCF857X_EXP_PCF8574A,   
#endif
#if IS_USED(MODULE_PCF8575) || DOXYGEN
    PCF857X_EXP_PCF8575,    
#endif
    PCF857X_EXP_MAX,
} pcf857x_exp_t;
 
typedef struct {
 
    i2c_t    dev;       
    uint16_t addr;      
    pcf857x_exp_t exp;  
#if IS_USED(MODULE_PCF857X_IRQ) || DOXYGEN
    gpio_t   int_pin;   
#endif /* MODULE_PCF857X_IRQ */
} pcf857x_params_t;
 
#if IS_USED(MODULE_PCF857X_IRQ) || DOXYGEN
typedef struct {
    event_t event;      
    void *dev;          
} pcf857x_irq_event_t;
 
#endif /* MODULE_PCF857X_IRQ */
 
typedef struct {
    pcf857x_params_t params;  
    uint8_t pin_num;          
    pcf857x_data_t modes;     
    pcf857x_data_t in;        
    pcf857x_data_t out;       
#if IS_USED(MODULE_PCF857X_IRQ) || DOXYGEN
    gpio_isr_ctx_t isr[PCF857X_GPIO_PIN_NUM];  
    gpio_flank_t flank[PCF857X_GPIO_PIN_NUM];  
    bool enabled[PCF857X_GPIO_PIN_NUM];        
    pcf857x_irq_event_t irq_event;  
#endif /* MODULE_PCF857X_IRQ */
 
} pcf857x_t;
 
#if IS_USED(MODULE_SAUL_GPIO) || DOXYGEN
typedef struct {
    unsigned int dev;           
    saul_gpio_params_t gpio;    
} pcf857x_saul_gpio_params_t;
#endif
 
int pcf857x_init(pcf857x_t *dev, const pcf857x_params_t *params);
 
int pcf857x_gpio_init(pcf857x_t *dev, uint8_t pin, gpio_mode_t mode);
 
#if IS_USED(MODULE_PCF857X_IRQ) || DOXYGEN
int pcf857x_gpio_init_int(pcf857x_t *dev, uint8_t pin,
                                          gpio_mode_t mode,
                                          gpio_flank_t flank,
                                          gpio_cb_t isr,
                                          void *arg);
#endif /* MODULE_PCF857X_IRQ || DOXYGEN */
 
int pcf857x_gpio_read(pcf857x_t *dev, uint8_t pin);
 
void pcf857x_gpio_write(pcf857x_t *dev, uint8_t pin, int value);
 
void pcf857x_gpio_clear(pcf857x_t *dev, uint8_t pin);
 
void pcf857x_gpio_set(pcf857x_t *dev, uint8_t pin);
 
void pcf857x_gpio_toggle(pcf857x_t *dev, uint8_t pin);
 
#if IS_USED(MODULE_PCF857X_IRQ) || DOXYGEN
void pcf857x_gpio_irq_enable(pcf857x_t *dev, uint8_t pin);
 
void pcf857x_gpio_irq_disable(pcf857x_t *dev, uint8_t pin);
#endif /* MODULE_PCF857X_IRQ || DOXYGEN */
 
#ifdef __cplusplus
}
#endif
 
#endif /* PCF857X_H */