solidswitch2.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 SOLIDSWITCH2_H
#define SOLIDSWITCH2_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_spi_master.h"
#include "spi_specifics.h"
 
#define SOLIDSWITCH2_REG_CHIP_ID                0x00
#define SOLIDSWITCH2_REG_CFG_0                  0x01
#define SOLIDSWITCH2_REG_CFG_1                  0x02
#define SOLIDSWITCH2_REG_CFG_2                  0x03
#define SOLIDSWITCH2_REG_BIM                    0x04
#define SOLIDSWITCH2_REG_RESERVED_1             0x05
#define SOLIDSWITCH2_REG_PWM_SPI                0x06
#define SOLIDSWITCH2_REG_MAP_IN0                0x07
#define SOLIDSWITCH2_REG_MAP_IN1                0x08
#define SOLIDSWITCH2_REG_MAP_PWM                0x09
#define SOLIDSWITCH2_REG_PWM_SEL                0x0A
#define SOLIDSWITCH2_REG_PWM_GEN_DC             0x0B
#define SOLIDSWITCH2_REG_PWM_LED_DC             0x0C
#define SOLIDSWITCH2_REG_DIAG_OFF_EN            0x0D
#define SOLIDSWITCH2_REG_DIAG_OPL_ON_EN         0x0E
#define SOLIDSWITCH2_REG_DIAG_OVC_OVT_RLW       0x0F
#define SOLIDSWITCH2_REG_STA_0                  0x10
#define SOLIDSWITCH2_REG_STA_1                  0x11
#define SOLIDSWITCH2_REG_DIAG_OVC_OVT           0x12
#define SOLIDSWITCH2_REG_DIAG_OPL_OFF           0x13
#define SOLIDSWITCH2_REG_DIAG_OPL_ON            0x14
#define SOLIDSWITCH2_REG_DIAG_SHD               0x15
 
 // solidswitch2_reg
 
#define SOLIDSWITCH2_CHIP_ID                    0x56
 
#define SOLIDSWITCH2_CFG_0_OUT7                 0x80
#define SOLIDSWITCH2_CFG_0_OUT6                 0x40
#define SOLIDSWITCH2_CFG_0_OUT5                 0x20
#define SOLIDSWITCH2_CFG_0_OUT4                 0x10
#define SOLIDSWITCH2_CFG_0_OUT3                 0x08
#define SOLIDSWITCH2_CFG_0_OUT2                 0x04
#define SOLIDSWITCH2_CFG_0_DIS_EN               0x02
#define SOLIDSWITCH2_CFG_0_NRES_EN              0x01
 
#define SOLIDSWITCH2_CFG_1_RST                  0x80
#define SOLIDSWITCH2_CFG_1_ACT                  0x40
#define SOLIDSWITCH2_CFG_1_PWM_DIV_LED_122p5Hz  0x00
#define SOLIDSWITCH2_CFG_1_PWM_DIV_LED_245p1Hz  0x01
#define SOLIDSWITCH2_CFG_1_PWM_DIV_LED_490p2Hz  0x02
#define SOLIDSWITCH2_CFG_1_PWM_DIV_LED_980p4Hz  0x03
 
#define SOLIDSWITCH2_CFG_2_FR_ADJ_NO_FREQ_ADJ   0x00
#define SOLIDSWITCH2_CFG_2_FR_ADJ_MINUS_15_PCT  0x04
#define SOLIDSWITCH2_CFG_2_FR_ADJ_PLUS_15_PCT   0x08
#define SOLIDSWITCH2_CFG_2_PWM_DIV_GEN_122p5Hz  0x00
#define SOLIDSWITCH2_CFG_2_PWM_DIV_GEN_245p1Hz  0x01
#define SOLIDSWITCH2_CFG_2_PWM_DIV_GEN_490p2Hz  0x02
#define SOLIDSWITCH2_CFG_2_PWM_DIV_GEN_980p4Hz  0x03
 
#define SOLIDSWITCH2_OUT7                       0x80
#define SOLIDSWITCH2_OUT6                       0x40
#define SOLIDSWITCH2_OUT5                       0x20
#define SOLIDSWITCH2_OUT4                       0x10
#define SOLIDSWITCH2_OUT3                       0x08
#define SOLIDSWITCH2_OUT2                       0x04
#define SOLIDSWITCH2_OUT1                       0x02
#define SOLIDSWITCH2_OUT0                       0x01
#define SOLIDSWITCH2_OUT_NONE                   0x00
 
#define SOLIDSWITCH2_MAX_DUTY_CYCLE             0xFF
#define SOLIDSWITCH2_MIN_DUTY_CYCLE             0x00
 
#define SOLIDSWITCH2_SPI_RW_BIT                 0x80
#define SOLIDSWITCH2_SPI_ERROR_BIT              0x80
#define SOLIDSWITCH2_ADDRESS_BIT_MASK           0x1F
#define SOLIDSWITCH2_ODD_PARITY                 0x01
#define SOLIDSWITCH2_SPI_ERROR_BIT              0x80
 
#define SOLIDSWITCH2_SET_DATA_SAMPLE_EDGE       SET_SPI_DATA_SAMPLE_EDGE
#define SOLIDSWITCH2_SET_DATA_SAMPLE_MIDDLE     SET_SPI_DATA_SAMPLE_MIDDLE
 
 // solidswitch2_set
 
#define SOLIDSWITCH2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.idle = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.in0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // solidswitch2_map
 // solidswitch2
 
typedef struct
{
    // Output pins
    digital_out_t idle;         
    digital_out_t in0;          
    digital_out_t in1;          
    // Modules
    spi_master_t spi;           
    pin_name_t   chip_select;   
} solidswitch2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins
    pin_name_t idle;            
    pin_name_t in0;             
    pin_name_t in1;             
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} solidswitch2_cfg_t;
 
typedef enum
{
    SOLIDSWITCH2_OK = 0,
    SOLIDSWITCH2_ERROR = -1
 
} solidswitch2_return_value_t;
 
void solidswitch2_cfg_setup ( solidswitch2_cfg_t *cfg );
 
err_t solidswitch2_init ( solidswitch2_t *ctx, solidswitch2_cfg_t *cfg );
 
err_t solidswitch2_default_cfg ( solidswitch2_t *ctx );
 
err_t solidswitch2_write_register ( solidswitch2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t solidswitch2_read_register ( solidswitch2_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t solidswitch2_check_communication ( solidswitch2_t *ctx );
 
void solidswitch2_set_idle_pin ( solidswitch2_t *ctx, uint8_t state );
 
void solidswitch2_set_in0_pin ( solidswitch2_t *ctx, uint8_t state );
 
void solidswitch2_set_in1_pin ( solidswitch2_t *ctx, uint8_t state );
 
void solidswitch2_toggle_in0_pin ( solidswitch2_t *ctx );
 
void solidswitch2_toggle_in1_pin ( solidswitch2_t *ctx );
 
err_t solidswitch2_soft_reset ( solidswitch2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SOLIDSWITCH2_H
 
 // solidswitch2
 
// ------------------------------------------------------------------------ END