expand13.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 EXPAND13_H
#define EXPAND13_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 EXPAND13_NO_PIN_MASK                            0x00
#define EXPAND13_PIN_0_MASK                             0x01
#define EXPAND13_PIN_1_MASK                             0x02
#define EXPAND13_PIN_2_MASK                             0x04
#define EXPAND13_PIN_3_MASK                             0x08
#define EXPAND13_PIN_4_MASK                             0x10
#define EXPAND13_PIN_5_MASK                             0x20
#define EXPAND13_PIN_6_MASK                             0x40
#define EXPAND13_PIN_7_MASK                             0x80
#define EXPAND13_ALL_PINS_MASK                          0xFF
 
#define EXPAND13_PORT_0                                 0x00
#define EXPAND13_PORT_1                                 0x01
#define EXPAND13_PORT_2                                 0x02
#define EXPAND13_PORT_3                                 0x03
#define EXPAND13_PORT_4                                 0x04
#define EXPAND13_PORT_5                                 0x05
 
#define EXPAND13_SET_DEV_ADDR_A2A1A0_000                0x20
#define EXPAND13_SET_DEV_ADDR_A2A1A0_001                0x21
#define EXPAND13_SET_DEV_ADDR_A2A1A0_010                0x22
#define EXPAND13_SET_DEV_ADDR_A2A1A0_011                0x23
#define EXPAND13_SET_DEV_ADDR_A2A1A0_100                0x24
#define EXPAND13_SET_DEV_ADDR_A2A1A0_101                0x25
#define EXPAND13_SET_DEV_ADDR_A2A1A0_110                0x26
#define EXPAND13_SET_DEV_ADDR_A2A1A0_111                0x27
 
 // expand13_set
 
#define EXPAND13_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 )
 
 // expand13_map
 // expand13
 
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;      
} expand13_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;  
} expand13_cfg_t;
 
typedef enum
{
    EXPAND13_OK = 0,
    EXPAND13_ERROR = -1
 
} expand13_return_value_t;
 
void expand13_cfg_setup ( expand13_cfg_t *cfg );
 
err_t expand13_init ( expand13_t *ctx, expand13_cfg_t *cfg );
 
void expand13_enable_device ( expand13_t *ctx );
 
void expand13_disable_device ( expand13_t *ctx );
 
uint8_t expand13_get_int_pin ( expand13_t *ctx );
 
err_t expand13_write_all_ports ( expand13_t *ctx, uint8_t *ports );
 
err_t expand13_read_all_ports ( expand13_t *ctx, uint8_t *ports );
 
err_t expand13_set_port_value ( expand13_t *ctx, uint8_t port, uint8_t clr_mask, uint8_t set_mask );
 
err_t expand13_read_port_value ( expand13_t *ctx, uint8_t port, uint8_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND13_H
 
 // expand13
 
// ------------------------------------------------------------------------ END