expand14.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 EXPAND14_H
#define EXPAND14_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 EXPAND14_REG_INPUT_PORT_0               0x00
#define EXPAND14_REG_INPUT_PORT_1               0x01
#define EXPAND14_REG_OUTPUT_PORT_0              0x02
#define EXPAND14_REG_OUTPUT_PORT_1              0x03
#define EXPAND14_REG_POLARITY_INV_PORT_0        0x04
#define EXPAND14_REG_POLARITY_INV_PORT_1        0x05
#define EXPAND14_REG_CONFIG_PORT_0              0x06
#define EXPAND14_REG_CONFIG_PORT_1              0x07
 
 // expand14_reg
 
#define EXPAND14_NO_PIN_MASK                    0x00
#define EXPAND14_PIN_0_MASK                     0x01
#define EXPAND14_PIN_1_MASK                     0x02
#define EXPAND14_PIN_2_MASK                     0x04
#define EXPAND14_PIN_3_MASK                     0x08
#define EXPAND14_PIN_4_MASK                     0x10
#define EXPAND14_PIN_5_MASK                     0x20
#define EXPAND14_PIN_6_MASK                     0x40
#define EXPAND14_PIN_7_MASK                     0x80
#define EXPAND14_ALL_PINS_MASK                  0xFF
 
#define EXPAND14_PORT_0                         0x00
#define EXPAND14_PORT_1                         0x01
 
#define EXPAND14_OUTPUT_DIRECTION               0x00
#define EXPAND14_INPUT_DIRECTION                0x01
 
#define EXPAND14_PIN_LOW_LEVEL                  0x00
#define EXPAND14_PIN_HIGH_LEVEL                 0x01
 
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_000      0x20
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_001      0x21
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_010      0x22
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_011      0x23
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_100      0x24
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_101      0x25
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_110      0x26
#define EXPAND14_DEVICE_ADDRESS_A2A1A0_111      0x27
 
 // expand14_set
 
#define EXPAND14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // expand14_map
 // expand14
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;           
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} expand14_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} expand14_cfg_t;
 
typedef enum
{
    EXPAND14_OK = 0,
    EXPAND14_ERROR = -1
 
} expand14_return_value_t;
 
void expand14_cfg_setup ( expand14_cfg_t *cfg );
 
err_t expand14_init ( expand14_t *ctx, expand14_cfg_t *cfg );
 
err_t expand14_default_cfg ( expand14_t *ctx );
 
err_t expand14_generic_write ( expand14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t expand14_generic_read ( expand14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t expand14_write_register ( expand14_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t expand14_read_register ( expand14_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t expand14_set_pin_direction ( expand14_t *ctx, uint8_t direction, uint8_t port, uint8_t pin_mask );
 
err_t expand14_set_all_pins_direction ( expand14_t *ctx, uint8_t direction );
 
err_t expand14_set_all_pins_value ( expand14_t *ctx, uint8_t set_mask );
 
err_t expand14_set_pin_value ( expand14_t *ctx, uint8_t port, uint8_t clr_mask, uint8_t set_mask );
 
err_t expand14_read_port_value ( expand14_t *ctx, uint8_t port, uint8_t *data_out );
 
uint8_t expand14_get_int_pin ( expand14_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND14_H
 
 // expand14
 
// ------------------------------------------------------------------------ END