solidswitch.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 SOLIDSWITCH_H
#define SOLIDSWITCH_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 SOLIDSWITCH_ENABLE_OUT7             0x80
#define SOLIDSWITCH_ENABLE_OUT6             0x40
#define SOLIDSWITCH_ENABLE_OUT1             0x02
#define SOLIDSWITCH_ENABLE_OUT0             0x01
#define SOLIDSWITCH_ENABLE_ALL_OUTPUTS      0xC3
#define SOLIDSWITCH_DISABLE_ALL_OUTPUTS     0x00
 
#define SOLIDSWITCH_DEV_ADDR_A1_GND_A0_GND  0x68
#define SOLIDSWITCH_DEV_ADDR_A1_GND_A0_VCC  0x69
#define SOLIDSWITCH_DEV_ADDR_A1_VCC_A0_GND  0x6C
#define SOLIDSWITCH_DEV_ADDR_A1_VCC_A0_VCC  0x6D
 
 // solidswitch_set
 
#define SOLIDSWITCH_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 )
 
 // solidswitch_map
 // solidswitch
 
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;     
} solidswitch_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;  
} solidswitch_cfg_t;
 
typedef enum
{
    SOLIDSWITCH_OK = 0,
    SOLIDSWITCH_ERROR = -1
 
} solidswitch_return_value_t;
 
void solidswitch_cfg_setup ( solidswitch_cfg_t *cfg );
 
err_t solidswitch_init ( solidswitch_t *ctx, solidswitch_cfg_t *cfg );
 
err_t solidswitch_default_cfg ( solidswitch_t *ctx );
 
err_t solidswitch_write_single ( solidswitch_t *ctx, uint8_t logic_state );
 
err_t solidswitch_write_two_bytes ( solidswitch_t *ctx, uint8_t logic_state, uint8_t int_mask );
 
err_t solidswitch_read_single ( solidswitch_t *ctx, uint8_t *logic_state );
 
err_t solidswitch_read_two_bytes ( solidswitch_t *ctx, uint8_t *logic_state, uint8_t *transition_flags );
 
void solidswitch_reset ( solidswitch_t *ctx );
 
uint8_t solidswitch_get_int_state ( solidswitch_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SOLIDSWITCH_H
 
 // solidswitch
 
// ------------------------------------------------------------------------ END