solidswitch3.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 SOLIDSWITCH3_H
#define SOLIDSWITCH3_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 SOLIDSWITCH3_CH_OUT1                    0x01
#define SOLIDSWITCH3_CH_OUT2                    0x02
#define SOLIDSWITCH3_CH_OUT3                    0x04
#define SOLIDSWITCH3_CH_OUT4                    0x08
#define SOLIDSWITCH3_CH_OUT5                    0x10
#define SOLIDSWITCH3_CH_OUT6                    0x20
#define SOLIDSWITCH3_CH_OUT7                    0x40
#define SOLIDSWITCH3_CH_OUT8                    0x80
#define SOLIDSWITCH3_ALL_CHANNELS               0xFF
 
#define SOLIDSWITCH3_DIR_MODE_SPI               0
#define SOLIDSWITCH3_DIR_MODE_GPIO              1
 
#define SOLIDSWITCH3_OUT_DISABLE                0u
#define SOLIDSWITCH3_OUT_IN_TERMINAL            1u
#define SOLIDSWITCH3_OUT_ENABLE                 2u
#define SOLIDSWITCH3_OUT_BITS_MASK              3u
 
#define SOLIDSWITCH3_SET_DATA_SAMPLE_EDGE       SET_SPI_DATA_SAMPLE_EDGE
#define SOLIDSWITCH3_SET_DATA_SAMPLE_MIDDLE     SET_SPI_DATA_SAMPLE_MIDDLE
 
 // solidswitch3_set
 
#define SOLIDSWITCH3_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.dir  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.in1  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.in2  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // solidswitch3_map
 // solidswitch3
 
typedef struct
{
    // Output pins
    digital_out_t  dir;                 
    digital_out_t  rst;                 
    digital_out_t  in1;                 
    digital_out_t  in2;                 
    // Modules
    spi_master_t  spi;                  
    pin_name_t  chip_select;            
    uint16_t    output_state;           
} solidswitch3_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  dir;                                    
    pin_name_t  rst;                                    
    pin_name_t  in1;                                    
    pin_name_t  in2;                                    
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} solidswitch3_cfg_t;
 
typedef enum
{
    SOLIDSWITCH3_OK = 0,
    SOLIDSWITCH3_ERROR = -1
 
} solidswitch3_return_value_t;
 
void solidswitch3_cfg_setup ( solidswitch3_cfg_t *cfg );
 
err_t solidswitch3_init ( solidswitch3_t *ctx, solidswitch3_cfg_t *cfg );
 
err_t solidswitch3_default_cfg ( solidswitch3_t *ctx );
 
err_t solidswitch3_write_data ( solidswitch3_t *ctx, uint16_t data_in );
 
err_t solidswitch3_enable_output ( solidswitch3_t *ctx, uint8_t channel );
 
err_t solidswitch3_disable_output ( solidswitch3_t *ctx, uint8_t channel );
 
void solidswitch3_reset ( solidswitch3_t *ctx );
 
void solidswitch3_set_dir_mode ( solidswitch3_t *ctx, uint8_t dir_mode );
 
void solidswitch3_set_rst_pin ( solidswitch3_t *ctx, uint8_t state );
 
void solidswitch3_set_in1_pin ( solidswitch3_t *ctx, uint8_t state );
 
void solidswitch3_set_in2_pin ( solidswitch3_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // SOLIDSWITCH3_H
 
 // solidswitch3
 
// ------------------------------------------------------------------------ END