spiisolator3  2.0.0.0
Data Structures | Macros | Enumerations | Functions
spiisolator3.h File Reference

This file contains API for SPI Isolator 3 Click Driver. More...

#include "mikrosdk_version.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures

struct  spiisolator3_t
 SPI Isolator 3 Click context object. More...
 
struct  spiisolator3_cfg_t
 SPI Isolator 3 Click configuration object. More...
 

Macros

#define SPIISOLATOR3_PIN_STATE_LOW   0
 SPI Isolator 3 description pin state. More...
 
#define SPIISOLATOR3_PIN_STATE_HIGH   1
 
#define SPIISOLATOR3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  spiisolator3_return_value_t { SPIISOLATOR3_OK = 0, SPIISOLATOR3_ERROR = -1 }
 SPI Isolator 3 Click return value data. More...
 

Functions

void spiisolator3_cfg_setup (spiisolator3_cfg_t *cfg)
 SPI Isolator 3 configuration object setup function. More...
 
err_t spiisolator3_init (spiisolator3_t *ctx, spiisolator3_cfg_t *cfg)
 SPI Isolator 3 initialization function. More...
 
err_t spiisolator3_default_cfg (spiisolator3_t *ctx)
 SPI Isolator 3 default configuration function. More...
 
err_t spiisolator3_generic_write (spiisolator3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 SPI Isolator 3 data writing function. More...
 
err_t spiisolator3_generic_read (spiisolator3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 SPI Isolator 3 data reading function. More...
 
void spiisolator3_set_side_a_active (spiisolator3_t *ctx, uint8_t saa_state)
 SPI Isolator 3 set side A active function. More...
 
void spiisolator3_set_sdo_enable (spiisolator3_t *ctx, uint8_t sdo_state)
 SPI Isolator 3 set SDO enable function. More...
 
void spiisolator3_set_aux (spiisolator3_t *ctx, uint8_t aux_state)
 SPI Isolator 3 set AUX function. More...
 
uint8_t spiisolator3_get_fault (spiisolator3_t *ctx)
 SPI Isolator 3 get fault state function. More...
 

Detailed Description

This file contains API for SPI Isolator 3 Click Driver.

Enumeration Type Documentation

◆ spiisolator3_return_value_t

SPI Isolator 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
SPIISOLATOR3_OK 
SPIISOLATOR3_ERROR