eeprom3  2.0.0.0
Functions
Public function

Functions

void eeprom3_cfg_setup (eeprom3_cfg_t *cfg)
 Config Object Initialization function. More...
 
EEPROM3_RETVAL eeprom3_init (eeprom3_t *ctx, eeprom3_cfg_t *cfg)
 Initialization function. More...
 
void eeprom3_write_byte (eeprom3_t *ctx, uint16_t reg_address, uint8_t data_in)
 Generic write function. More...
 
void eeprom3_write_page (eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_in, uint8_t count)
 Generic write page function. More...
 
void eeprom3_read (eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_out, uint16_t count)
 Generic read function. More...
 

Detailed Description

Function Documentation

◆ eeprom3_cfg_setup()

void eeprom3_cfg_setup ( eeprom3_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.

◆ eeprom3_init()

EEPROM3_RETVAL eeprom3_init ( eeprom3_t ctx,
eeprom3_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ eeprom3_read()

void eeprom3_read ( eeprom3_t ctx,
uint16_t  reg_address,
uint8_t *  data_out,
uint16_t  count 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_outOutput data.
countNumber of the bytes to be read.

@description This function reads data from the desired register.

◆ eeprom3_write_byte()

void eeprom3_write_byte ( eeprom3_t ctx,
uint16_t  reg_address,
uint8_t  data_in 
)

Generic write function.

Parameters
ctxClick object.
reg_addressRegister address.
data_inData to be written.

@description This function writes data to the desired register.

◆ eeprom3_write_page()

void eeprom3_write_page ( eeprom3_t ctx,
uint16_t  reg_address,
uint8_t *  data_in,
uint8_t  count 
)

Generic write page function.

Parameters
ctxClick object.
reg_addressRegister address.
data_inData to be written.
countNumber of bytes to be written. @description This function writes given number of data to the desired register.