fram3  2.0.0.0
Functions
Public function

Functions

void fram3_cfg_setup (fram3_cfg_t *cfg)
 Config Object Initialization function. More...
 
FRAM3_RETVAL fram3_init (fram3_t *ctx, fram3_cfg_t *cfg)
 Initialization function. More...
 
void fram3_generic_write (fram3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void fram3_generic_read (fram3_t *ctx, uint8_t *tx_buf, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
uint8_t fram3_read_free_access_memory (fram3_t *ctx, uint8_t start_addr, uint8_t *data_buf, uint8_t n_buf_size)
 Memory read function. More...
 
uint8_t fram3_write_free_access_memory (fram3_t *ctx, uint8_t start_addr, uint8_t *data_buf, uint8_t n_buf_size)
 Memory write function. More...
 

Detailed Description

Function Documentation

◆ fram3_cfg_setup()

void fram3_cfg_setup ( fram3_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ fram3_generic_read()

void fram3_generic_read ( fram3_t ctx,
uint8_t *  tx_buf,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
tx_bufRegister buffer.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ fram3_generic_write()

void fram3_generic_write ( fram3_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ fram3_init()

FRAM3_RETVAL fram3_init ( fram3_t ctx,
fram3_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ fram3_read_free_access_memory()

uint8_t fram3_read_free_access_memory ( fram3_t ctx,
uint8_t  start_addr,
uint8_t *  data_buf,
uint8_t  n_buf_size 
)

Memory read function.

Parameters
ctxClick object.
start_addrAddress from where data will be read
data_bufOUTPUT buffer data
n_buf_sizeNumber of bytes data
Returns
either FRAM3_SUCCESSFUL or FRAM3_ERROR.

◆ fram3_write_free_access_memory()

uint8_t fram3_write_free_access_memory ( fram3_t ctx,
uint8_t  start_addr,
uint8_t *  data_buf,
uint8_t  n_buf_size 
)

Memory write function.

Parameters
ctxClick object.
start_addrAddress from where data will be written
data_bufOUTPUT buffer data
n_buf_sizeNumber of bytes data
Returns
either FRAM3_SUCCESSFUL or FRAM3_ERROR.