expand16.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef EXPAND16_H
#define EXPAND16_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define EXPAND16_REG_DEV_ID_AND_CTRL            0x01
#define EXPAND16_REG_IO_DIRECTION               0x03
#define EXPAND16_REG_OUTPUT_STATE               0x05
#define EXPAND16_REG_OUTPUT_HIGH_Z              0x07
#define EXPAND16_REG_INPUT_DEF_STATE            0x09
#define EXPAND16_REG_PULL_ENABLE                0x0B
#define EXPAND16_REG_PULL_DOWN_UP               0x0D
#define EXPAND16_REG_INPUT_STATE                0x0F
#define EXPAND16_REG_INTERRUPT_MASK             0x11
#define EXPAND16_REG_INTERRUPT_STATUS           0x13
 
 // expand16_reg
 
#define EXPAND16_PIN_MASK_NONE                  0x00
#define EXPAND16_PIN_MASK_GPIO_0                0x01
#define EXPAND16_PIN_MASK_GPIO_1                0x02
#define EXPAND16_PIN_MASK_GPIO_2                0x04
#define EXPAND16_PIN_MASK_GPIO_3                0x08
#define EXPAND16_PIN_MASK_GPIO_4                0x10
#define EXPAND16_PIN_MASK_GPIO_5                0x20
#define EXPAND16_PIN_MASK_GPIO_6                0x40
#define EXPAND16_PIN_MASK_GPIO_7                0x80
#define EXPAND16_PIN_MASK_ALL                   0xFF
 
#define EXPAND16_SW_RESET_CMD                   0x01
 
#define EXPAND16_DEVICE_ID                      0xA0
#define EXPAND16_DEVICE_ID_MASK                 0xE0
 
#define EXPAND16_PIN_STATE_HIGH                 0x01
#define EXPAND16_PIN_STATE_LOW                  0x00
 
#define EXPAND16_DEVICE_ADDRESS_GND             0x43
#define EXPAND16_DEVICE_ADDRESS_VCC             0x44
 
 // expand16_set
 
#define EXPAND16_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // expand16_map
 // expand16
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} expand16_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rst;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} expand16_cfg_t;
 
typedef enum
{
    EXPAND16_OK = 0,
    EXPAND16_ERROR = -1
 
} expand16_return_value_t;
 
void expand16_cfg_setup ( expand16_cfg_t *cfg );
 
err_t expand16_init ( expand16_t *ctx, expand16_cfg_t *cfg );
 
err_t expand16_default_cfg ( expand16_t *ctx );
 
err_t expand16_generic_write ( expand16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t expand16_generic_read ( expand16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void expand16_set_rst_pin ( expand16_t *ctx, uint8_t pin_state );
 
void expand16_hw_reset ( expand16_t *ctx );
 
uint8_t expand16_get_int_pin ( expand16_t *ctx );
 
err_t expand16_write_reg ( expand16_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t expand16_read_reg ( expand16_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t expand16_set_io_dir ( expand16_t *ctx, uint8_t input_pins, uint8_t output_pins );
 
err_t expand16_set_output_state ( expand16_t *ctx, uint8_t clr_mask, uint8_t set_mask );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND16_H
 
 // expand16
 
// ------------------------------------------------------------------------ END