digiisolator2.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 DIGIISOLATOR2_H
#define DIGIISOLATOR2_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 DIGIISOLATOR2_REG_INPUT_DATA            0x00
#define DIGIISOLATOR2_REG_WIRE_BREAK            0x01
#define DIGIISOLATOR2_REG_FAULT                 0x02
#define DIGIISOLATOR2_REG_FILTER_CH1_CH2        0x03
#define DIGIISOLATOR2_REG_FILTER_CH3_CH4        0x04
#define DIGIISOLATOR2_REG_FILTER_CH5_CH6        0x05
#define DIGIISOLATOR2_REG_FILTER_CH7_CH8        0x06
 
 // digiisolator2_reg
 
#define DIGIISOLATOR2_CHANNEL_IN1               0x01
#define DIGIISOLATOR2_CHANNEL_IN2               0x02
#define DIGIISOLATOR2_CHANNEL_IN3               0x04
#define DIGIISOLATOR2_CHANNEL_IN4               0x08
#define DIGIISOLATOR2_CHANNEL_IN5               0x10
#define DIGIISOLATOR2_CHANNEL_IN6               0x20
#define DIGIISOLATOR2_CHANNEL_IN7               0x40
#define DIGIISOLATOR2_CHANNEL_IN8               0x80
#define DIGIISOLATOR2_CHANNEL_ALL               0xFF
 
#define DIGIISOLATOR2_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define DIGIISOLATOR2_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // digiisolator2_set
 
#define DIGIISOLATOR2_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.en = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sync = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // digiisolator2_map
 // digiisolator2
 
typedef enum
{
    DIGIISOLATOR2_DRV_SEL_SPI,      
    DIGIISOLATOR2_DRV_SEL_GPIO      
} digiisolator2_drv_t;
 
typedef struct
{
    // Output pins in SPI mode
    digital_out_t en;               
    digital_out_t rst;              
    // Input pins in SPI mode
    digital_in_t sync;              
    digital_in_t int_pin;           
    // Input pins in GPIO mode
    digital_in_t out1;              
    digital_in_t out2;              
    digital_in_t out3;              
    digital_in_t out4;              
    digital_in_t out5;              
    digital_in_t out6;              
    digital_in_t out8;              
    // Modules
    spi_master_t spi;               
    pin_name_t   chip_select;       
    digiisolator2_drv_t drv_sel;    
} digiisolator2_t;
 
typedef struct
{
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
    pin_name_t en;                  
    pin_name_t rst;                 
    pin_name_t sync;                
    pin_name_t int_pin;             
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
    digiisolator2_drv_t drv_sel;    
} digiisolator2_cfg_t;
 
typedef enum
{
    DIGIISOLATOR2_OK = 0,
    DIGIISOLATOR2_ERROR = -1
 
} digiisolator2_return_value_t;
 
void digiisolator2_cfg_setup ( digiisolator2_cfg_t *cfg );
 
void digiisolator2_drv_interface_sel ( digiisolator2_cfg_t *cfg, digiisolator2_drv_t drv_sel );
 
err_t digiisolator2_init ( digiisolator2_t *ctx, digiisolator2_cfg_t *cfg );
 
err_t digiisolator2_spi_write ( digiisolator2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t digiisolator2_spi_read ( digiisolator2_t *ctx, uint8_t reg, uint8_t *data_out );
 
void digiisolator2_set_rst_pin ( digiisolator2_t *ctx, uint8_t state );
 
uint8_t digiisolator2_get_int_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_sync_pin ( digiisolator2_t *ctx );
 
err_t digiisolator2_read_inputs ( digiisolator2_t *ctx, uint8_t *data_out );
 
uint8_t digiisolator2_get_out1_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_out2_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_out3_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_out4_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_out5_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_out6_pin ( digiisolator2_t *ctx );
 
uint8_t digiisolator2_get_out8_pin ( digiisolator2_t *ctx );
 
void digiisolator2_enable_output ( digiisolator2_t *ctx );
 
void digiisolator2_disable_output ( digiisolator2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIISOLATOR2_H
 
 // digiisolator2
 
// ------------------------------------------------------------------------ END