spiisolator2.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 SPIISOLATOR2_H
#define SPIISOLATOR2_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"
 
#define SPIISOLATOR2_EEPROM5_CMD_WREN                       0x06
#define SPIISOLATOR2_EEPROM5_CMD_WRDI                       0x04
#define SPIISOLATOR2_EEPROM5_CMD_RDSR                       0x05
#define SPIISOLATOR2_EEPROM5_CMD_WRSR                       0x01
#define SPIISOLATOR2_EEPROM5_CMD_READ                       0x03
#define SPIISOLATOR2_EEPROM5_CMD_WRITE                      0x02
#define SPIISOLATOR2_EEPROM5_CMD_READ_ID                    0x83
#define SPIISOLATOR2_EEPROM5_CMD_WRITE_ID                   0x82
#define SPIISOLATOR2_EEPROM5_CMD_READ_LOCK_STATUS           0x83
#define SPIISOLATOR2_EEPROM5_CMD_LOCK_ID                    0x82
                                                 
#define SPIISOLATOR2_OUT_DISABLE                            0x00
#define SPIISOLATOR2_OUT_ENABLE                             0x01
 
#define SPIISOLATOR2_DUMMY                                  0x00
                           
 // spiisolator2_set
 
#define SPIISOLATOR2_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.en1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
 
 // spiisolator2_map
 // spiisolator2
 
typedef struct
{
    // Output pins
    digital_out_t en1;                              
    // Modules
    spi_master_t  spi;                              
    pin_name_t  chip_select;                        
} spiisolator2_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  en1;                                
    // static variable
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
} spiisolator2_cfg_t;
 
typedef enum
{
   SPIISOLATOR2_OK = 0,
   SPIISOLATOR2_ERROR = -1
 
} spiisolator2_return_value_t;
 
void spiisolator2_cfg_setup ( spiisolator2_cfg_t *cfg );
 
err_t spiisolator2_init ( spiisolator2_t *ctx, spiisolator2_cfg_t *cfg );
 
err_t spiisolator2_generic_write ( spiisolator2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t spiisolator2_generic_read ( spiisolator2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void spiisolator2_output_enable( spiisolator2_t *ctx, uint8_t en_out );
 
void spiisolator2_set_cmd ( spiisolator2_t *ctx, uint8_t cmd );
 
void spiisolator2_write_byte ( spiisolator2_t *ctx, uint8_t reg, uint8_t tx_data );
 
uint8_t spiisolator2_read_byte ( spiisolator2_t *ctx, uint8_t reg );
 
void spiisolator2_burst_write ( spiisolator2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
 
void spiisolator2_burst_read ( spiisolator2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
 
void spiisolator2_multi_write ( spiisolator2_t *ctx, uint32_t addr, uint8_t addr_n_bytes, 
                                uint8_t *p_tx_data, uint8_t tx_data_n_bytes );
 
void spiisolator2_multi_read ( spiisolator2_t *ctx, uint32_t addr, uint8_t addr_n_bytes, 
                               uint8_t *p_rx_data, uint8_t tx_data_n_bytes );
 
#ifdef __cplusplus
}
#endif
#endif // SPIISOLATOR2_H
 
 // spiisolator2
 
// ------------------------------------------------------------------------ END