expand5.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 EXPAND5_H
#define EXPAND5_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define EXPAND5_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 ) 
#define EXPAND5_RETVAL  uint8_t
 
#define EXPAND5_OK           0x00
#define EXPAND5_INIT_ERROR   0xFF
#define  EXPAND5_I2C_ADR_GND          0x22
#define  EXPAND5_I2C_ADR_VCC          0x23
#define  EXPAND5_RA_IN_0              0x00
#define  EXPAND5_RA_IN_1              0x01
#define  EXPAND5_RA_IN_2              0x02
#define  EXPAND5_RA_OUT_0             0x04
#define  EXPAND5_RA_OUT_1             0x05
#define  EXPAND5_RA_OUT_2             0x06
#define  EXPAND5_RA_POL_0             0x08
#define  EXPAND5_RA_POL_1             0x09
#define  EXPAND5_RA_POL_2             0x0A
#define  EXPAND5_RA_CFG_0             0x0C
#define  EXPAND5_RA_CFG_1             0x0D
#define  EXPAND5_RA_CFG_2             0x0E
 
#define  EXPAND5_AUTO_INC             0x80
 
#define  EXPAND5_LOW                  0
#define  EXPAND5_HIGH                 1
 
#define  EXPAND5_POL_NORMAL           0
#define  EXPAND5_POL_INVERTED         1
 
#define  EXPAND5_OUT                  0
#define  EXPAND5_IN                   1
 
#define  EXPAND5_P00                  0
#define  EXPAND5_P01                  1
#define  EXPAND5_P02                  2
#define  EXPAND5_P03                  3
#define  EXPAND5_P04                  4
#define  EXPAND5_P05                  5
#define  EXPAND5_P06                  6
#define  EXPAND5_P07                  7
#define  EXPAND5_P10                  8
#define  EXPAND5_P11                  9
#define  EXPAND5_P12                  10
#define  EXPAND5_P13                  11
#define  EXPAND5_P14                  12
#define  EXPAND5_P15                  13
#define  EXPAND5_P16                  14
#define  EXPAND5_P17                  15
#define  EXPAND5_P20                  16
#define  EXPAND5_P21                  17
#define  EXPAND5_P22                  18
#define  EXPAND5_P23                  19
#define  EXPAND5_P24                  20
#define  EXPAND5_P25                  21
#define  EXPAND5_P26                  22
#define  EXPAND5_P27                  23
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} expand5_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} expand5_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void expand5_cfg_setup ( expand5_cfg_t *cfg );
 
EXPAND5_RETVAL expand5_init ( expand5_t *ctx, expand5_cfg_t *cfg );
 
void expand5_generic_write ( expand5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void expand5_generic_read ( expand5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t expand5_read_bit ( expand5_t *ctx, uint8_t reg_adr, uint8_t bit_num );
 
void expand5_write_bit ( expand5_t *ctx, uint8_t reg_adr, uint8_t bit_num, uint8_t pin_val );
 
uint8_t expand5_read_pin ( expand5_t *ctx, uint16_t pin );
 
uint8_t expand5_read_bank ( expand5_t *ctx, uint8_t bank );
 
void expand5_read_all_banks ( expand5_t *ctx, uint8_t *bank0, uint8_t *bank1, uint8_t *bank2 );
 
uint8_t expand5_get_pin_out_lvl ( expand5_t *ctx, uint16_t pin );
 
uint8_t expand5_get_bank_out_lvl ( expand5_t *ctx, uint8_t bank );
 
void expand5_get_all_banks_out_lvl ( expand5_t *ctx, uint8_t *bank0, uint8_t *bank1, uint8_t *bank2 );
 
void expand5_write_pin ( expand5_t *ctx, uint16_t pin, uint8_t pin_val );
 
void expand5_write_bank ( expand5_t *ctx, uint8_t bank, uint8_t value );
 
void expand5_write_all_banks ( expand5_t *ctx, uint8_t bank0, uint8_t bank1, uint8_t bank2 );
 
uint8_t expand5_get_pin_pol ( expand5_t *ctx, uint16_t pin );
 
uint8_t expand5_get_bank_pol ( expand5_t *ctx, uint8_t bank );
 
void expand5_get_all_banks_pol ( expand5_t *ctx, uint8_t *bank0, uint8_t *bank1, uint8_t *bank2 );
 
void expand5_set_pin_pol ( expand5_t *ctx, uint16_t pin, uint8_t polarity );
 
void expand5_set_bank_pol ( expand5_t *ctx, uint8_t bank, uint8_t polarity );
 
void expand5_set_all_banks_pol ( expand5_t *ctx, uint8_t bank0, uint8_t bank1, uint8_t bank2 );
 
uint8_t expand5_get_pin_dir ( expand5_t *ctx, uint16_t pin );
 
uint8_t expand5_get_bank_dir ( expand5_t *ctx, uint8_t bank );
 
void expand5_get_all_dir ( expand5_t *ctx, uint8_t *bank0, uint8_t *bank1, uint8_t *bank2 );
 
void expand5_set_pin_dir( expand5_t *ctx, uint16_t pin, uint8_t direction );
 
void expand5_set_bank_dir ( expand5_t *ctx, uint8_t bank, uint8_t direction );
 
void expand5_set_all_dir ( expand5_t *ctx, uint8_t bank0, uint8_t bank1, uint8_t bank2 );
 
void expand5_reset ( expand5_t *ctx );
 
uint8_t expand5_check_int ( expand5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _EXPAND5_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END