eeprom2 2.0.0.0
Public function

Functions

void eeprom2_cfg_setup (eeprom2_cfg_t *cfg)
 Config Object Initialization function.
 
err_t eeprom2_init (eeprom2_t *ctx, eeprom2_cfg_t *cfg)
 Initialization function.
 
void eeprom2_write (eeprom2_t *ctx, uint32_t memory_address, uint8_t value)
 Generic write function.
 
void eeprom2_write_bytes (eeprom2_t *ctx, uint32_t memory_address, uint8_t *value, uint8_t count)
 Function to write bytes.
 
uint8_t eeprom2_read (eeprom2_t *ctx, uint32_t memory_address)
 Generic read function.
 
void eeprom2_read_bytes (eeprom2_t *ctx, uint32_t memory_address, uint8_t *value, uint8_t count)
 Function to read bytes.
 
void eeprom2_memory_enable (eeprom2_t *ctx)
 Enable EEPROM memory.
 
void eeprom2_memory_disable (eeprom2_t *ctx)
 Disable EEPROM memory.
 

Detailed Description

Function Documentation

◆ eeprom2_cfg_setup()

void eeprom2_cfg_setup ( eeprom2_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ eeprom2_init()

err_t eeprom2_init ( eeprom2_t * ctx,
eeprom2_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ eeprom2_memory_disable()

void eeprom2_memory_disable ( eeprom2_t * ctx)

Disable EEPROM memory.

Parameters
ctxClick object.

This function disables EEPROM memory.

◆ eeprom2_memory_enable()

void eeprom2_memory_enable ( eeprom2_t * ctx)

Enable EEPROM memory.

Parameters
ctxClick object.

This function enables EEPROM memory.

◆ eeprom2_read()

uint8_t eeprom2_read ( eeprom2_t * ctx,
uint32_t memory_address )

Generic read function.

Parameters
ctxClick object.
memory_addressMemory address.
Returns
Data read from the given memory address.

This function reads a single byte from the given memory address.

◆ eeprom2_read_bytes()

void eeprom2_read_bytes ( eeprom2_t * ctx,
uint32_t memory_address,
uint8_t * value,
uint8_t count )

Function to read bytes.

Parameters
ctxClick object.
memory_addressMemory address.
valueValues read from the given memory address.
countCount of data read from memory.

This function reads bytes from the given memory address.

◆ eeprom2_write()

void eeprom2_write ( eeprom2_t * ctx,
uint32_t memory_address,
uint8_t value )

Generic write function.

Parameters
ctxClick object.
memory_addressMemory address.
valueValue to be written to memory address.

This function writes a single byte of data to the given memory address.

◆ eeprom2_write_bytes()

void eeprom2_write_bytes ( eeprom2_t * ctx,
uint32_t memory_address,
uint8_t * value,
uint8_t count )

Function to write bytes.

Parameters
ctxClick object.
memory_addressMemory address.
valueValues to be written to memory address.
countCount of data (in bytes, max 256) to be written.

This function writes bytes of data to the given memory address.