digiisolator.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 DIGIISOLATOR_H
#define DIGIISOLATOR_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"
#include "drv_uart.h"
#include "drv_analog_in.h"
 
#define DIGIISOLATOR_VREF_3V3                  3.3
#define DIGIISOLATOR_VREF_5V                   5.0
 
#define DIGIISOLATOR_TX_DRV_BUFFER_SIZE        100
#define DIGIISOLATOR_RX_DRV_BUFFER_SIZE        300
 
#define DIGIISOLATOR_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define DIGIISOLATOR_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // digiisolator_set
 
#define DIGIISOLATOR_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.d1 = MIKROBUS( mikrobus, MIKROBUS_AN );      \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.d2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // digiisolator_map
 // digiisolator
 
typedef struct
{
    // Input pins
    analog_in_t adc;     
    digital_in_t d2;     
    // Modules
    spi_master_t spi;    
    uart_t uart;         
    pin_name_t   chip_select;    
    // Buffers
    char uart_rx_buffer[ DIGIISOLATOR_RX_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ DIGIISOLATOR_TX_DRV_BUFFER_SIZE ];    
} digiisolator_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;       
    pin_name_t mosi;       
    pin_name_t sck;        
    pin_name_t cs;         
    pin_name_t rx_pin;     
    pin_name_t tx_pin;     
    // Additional gpio pins
    pin_name_t d1;    
    pin_name_t d2;    
    // Static variable
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
    uint32_t         baud_rate;                       
    bool             uart_blocking;                   
    uart_data_bits_t data_bit;                        
    uart_parity_t    parity_bit;                      
    uart_stop_bits_t stop_bit;                        
    analog_in_resolution_t resolution;    
    float                  vref;          
} digiisolator_cfg_t;
 
typedef enum
{
    DIGIISOLATOR_OK = 0,
    DIGIISOLATOR_ERROR = -1
 
} digiisolator_return_value_t;
 
void digiisolator_cfg_setup ( digiisolator_cfg_t *cfg );
 
err_t digiisolator_init ( digiisolator_t *ctx, digiisolator_cfg_t *cfg );
 
err_t digiisolator_spi_write ( digiisolator_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t digiisolator_spi_read ( digiisolator_t *ctx, uint8_t *data_out, uint8_t len );
 
err_t digiisolator_spi_write_read ( digiisolator_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out );
 
err_t digiisolator_spi_transfer ( digiisolator_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len );
 
err_t digiisolator_uart_write ( digiisolator_t *ctx, char *data_in, uint16_t len );
 
err_t digiisolator_uart_read ( digiisolator_t *ctx, char *data_out, uint16_t len );
 
err_t digiisolator_get_d1_pin_value ( digiisolator_t *ctx, uint16_t *data_out );
 
err_t digiisolator_get_d1_pin_voltage ( digiisolator_t *ctx, float *data_out );
 
uint8_t digiisolator_get_d2 ( digiisolator_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIISOLATOR_H
 
 // digiisolator
 
// ------------------------------------------------------------------------ END