1 EEPROM Library

• struct eeprom_interface

  Creates an instance of the EEPROM interface for the devices.

• struct EEPROM_DEVICE_CONTEXT

  Contains the EEPROM driver context used in the API routines.

• enum EEPROM_STATUS { EEPROM_NO_ERROR = 0U, EEPROM_ERROR = 1U, EEPROM_I2C_TIMEOUT = 3U, EEPROM_INVALID_PARAMETER = 104U, EEPROM_NULL_ERROR = 105U, EEPROM_COM_ERROR = 106U }

  Enumeration of the EEPROM driver status codes.

• static void EEPROM_UpdateWriteData (uint16_t dataLength, uint16_t pageCounter)

  Updates the write operation parameters.

• static uint8_t EEPROM_WordAddressLowGet (uint32_t address)

  Gets the lower byte of the word address from the target memory address.

• static uint8_t EEPROM_WordAddressHighGet (uint32_t address)

  Gets the upper byte of the word address from the target memory address.

• static uint8_t EEPROM_DeviceAddressGet (uint32_t address)

  Gets the device address of the EEPROM.

• static void EEPROM_Tasks (void)

  Performs the read and write operations of the driver.

• static void EEPROM_Close (void)

  Resets the EEPROM status.

• bool EEPROM_ByteWrite (uint32_t address, uint8_t *data)

  Writes a byte of data to a specified address in the EEPROM device.

• bool EEPROM_ByteRead (uint32_t address, uint8_t *data)

  Reads a byte of data from a specified address in the EEPROM device.

• bool EEPROM_IsBusy (void)

  Checks if the EEPROM device is busy.

• bool EEPROM_SequentialWrite (uint32_t address, uint8_t *data, size_t dataLength)

  Writes n-bytes of data to a specified start address in the EEPROM device.

• bool EEPROM_SequentialRead (uint32_t address, uint8_t *data, size_t dataLength)

  Reads n-bytes of data from a specified start address in the EEPROM device.

• bool EEPROM_PageWrite (uint32_t address, uint8_t *data)

  Writes the data to an entire page of the EEPROM device.

• bool EEPROM_PageRead (uint32_t address, uint8_t *data)

  Reads the data of an entire page of the EEPROM device.

• EEPROM_STATUS_t EEPROM_ErrorGet (void)

  Checks the type of the error encountered in the EEPROM operation.

bool EEPROM_ByteRead (uint32_t address, uint8_t * data)

Reads a byte of data from a specified address in the EEPROM device.

bool EEPROM_ByteWrite (uint32_t address, uint8_t * data)

Writes a byte of data to a specified address in the EEPROM device.

static void EEPROM_Close (void )[static]

Resets the EEPROM status.

static uint8_t EEPROM_DeviceAddressGet (uint32_t address)[static]

Gets the device address of the EEPROM.

EEPROM_STATUS_t EEPROM_ErrorGet (void )

Checks the type of the error encountered in the EEPROM operation.

bool EEPROM_IsBusy (void )

Checks if the EEPROM device is busy.

bool EEPROM_PageRead (uint32_t address, uint8_t * data)

Reads the data of an entire page of the EEPROM device.

bool EEPROM_PageWrite (uint32_t address, uint8_t * data)

Writes the data to an entire page of the EEPROM device.

bool EEPROM_SequentialRead (uint32_t address, uint8_t * data, size_t dataLength)

Reads n-bytes of data from a specified start address in the EEPROM device.

bool EEPROM_SequentialWrite (uint32_t address, uint8_t * data, size_t dataLength)

Writes n-bytes of data to a specified start address in the EEPROM device.

static void EEPROM_Tasks (void )[static]

Performs the read and write operations of the driver.

static void EEPROM_UpdateWriteData (uint16_t dataLength, uint16_t pageCounter)[static]

Updates the write operation parameters.

static uint8_t EEPROM_WordAddressHighGet (uint32_t address)[static]

Gets the upper byte of the word address from the target memory address.

static uint8_t EEPROM_WordAddressLowGet (uint32_t address)[static]

Gets the lower byte of the word address from the target memory address.

enum EEPROM_STATUS

Enumeration of the EEPROM driver status codes.

• uint8_t EEPROM_I2C_Write (uint8_t deviceAddress, uint8_t *data, size_t writeLength)

  Writes the data to the EEPROM via the I2C bus.

• uint8_t EEPROM_I2C_Read (uint8_t deviceAddress, uint8_t *eepromAddress, size_t addressLength, uint8_t *readData, size_t readLength)

  Reads the data from the EEPROM via the I2C bus.

• bool EEPROM_AckPoll (uint8_t deviceAddress)

  Checks if the data sent was acknowledged by the EEPROM device.

• static const i2c_host_interface_t * EEPROM_I2C = &I2C1

  An instance of the I2C Host driver interface for the EEPROM device.

bool EEPROM_AckPoll (uint8_t deviceAddress)

Checks if the data sent was acknowledged by the EEPROM device.

uint8_t EEPROM_I2C_Read (uint8_t deviceAddress, uint8_t * eepromAddress, size_t addressLength, uint8_t * readData, size_t readLength)

Reads the data from the EEPROM via the I2C bus.

uint8_t EEPROM_I2C_Write (uint8_t deviceAddress, uint8_t * data, size_t writeLength)

Writes the data to the EEPROM via the I2C bus.

* EEPROM_I2C = &I2C1[static]

An instance of the I2C Host driver interface for the EEPROM device.

• bool busy

• uint32_t startAddress

• uint8_t deviceAddress

• uint8_t wordAddress [EEPROM_I2C_WORD_LEN_BYTES]

• uint8_t dataBuffer [EEPROM_I2C_PAGESIZE]

• uint8_t * writePtr

• size_t writeLength

• bool firstWrite

• uint8_t * readPtr

• size_t readLength

• bool switchToRead

• EEPROM_STATUS_t errorState

bool busy

Sets the software busy flag.

uint8_t dataBuffer[EEPROM_I2C_PAGESIZE]

Holds the data address buffer for the read and write operation.

uint8_t deviceAddress

Sets the I2C address of the device.

EEPROM_STATUS_t errorState

Sets the error state of the operation.

bool firstWrite

Sets the write operation flag.

size_t readLength

Sets the read buffer length for the read operation.

uint8_t* readPtr

Pointer to read buffer for the read operation.

uint32_t startAddress

Sets the starting word address of the device.

bool switchToRead

Sets the operation from Write to Read mode.

uint8_t wordAddress[EEPROM_I2C_WORD_LEN_BYTES]

Holds the word address buffer for the device operation.

size_t writeLength

Sets the write buffer length for the write operation.

uint8_t* writePtr

Pointer to write buffer for the write operation.

• bool(* SequentialWrite )(uint32_t address, uint8_t *data, size_t dataLength)

• bool(* SequentialRead )(uint32_t address, uint8_t *data, size_t dataLength)

• bool(* PageWrite )(uint32_t address, uint8_t *data)

• bool(* PageRead )(uint32_t address, uint8_t *data)

• bool(* ByteWrite )(uint32_t address, uint8_t *data)

• bool(* ByteRead )(uint32_t address, uint8_t *data)

• bool(* IsBusy )(void)

bool(* ByteRead) (uint32_t address, uint8_t *data)

bool(* ByteWrite) (uint32_t address, uint8_t *data)

bool(* IsBusy) (void)

bool(* PageRead) (uint32_t address, uint8_t *data)

bool(* PageWrite) (uint32_t address, uint8_t *data)

bool(* SequentialRead) (uint32_t address, uint8_t *data, size_t dataLength)

bool(* SequentialWrite) (uint32_t address, uint8_t *data, size_t dataLength)

#define MIN( a, b) ((a) < (b) ? (a) : (b))

Computes the minimum of a and b.

const EEPROM_INTERFACE_t eeprom_interface

Initial value:

= {
    .SequentialWrite = EEPROM_SequentialWrite,
    .SequentialRead = EEPROM_SequentialRead,
    .PageWrite = EEPROM_PageWrite,
    .PageRead = EEPROM_PageRead,
    .ByteWrite = EEPROM_ByteWrite,
    .ByteRead = EEPROM_ByteRead,
    .IsBusy = EEPROM_IsBusy
}

EEPROM_DEVICE_CONTEXT_t eepromStatus = {0}[static]

size_t null = 0[static]

const EEPROM_INTERFACE_t eeprom_interface

#define EEPROM_I2C_ERROR (1U)

#define EEPROM_I2C_NO_ERROR (0U)

I2C interface status codes.

• #define EEPROM_I2C_NO_ERROR (0U)

• #define EEPROM_I2C_ERROR (1U)

#define EEPROM_I2C_ERROR (1U)

#define EEPROM_I2C_NO_ERROR (0U)

EEPROM device size specification.

• #define EEPROM_I2C_DEVICE_ADDR (0x54U)

• #define EEPROM_I2C_WORD_LEN_BYTES (2U)

• #define EEPROM_I2C_WORD_LEN_BIT (18U)

• #define EEPROM_I2C_SIZE (262144U)

• #define EEPROM_I2C_PAGESIZE (256U)

• #define EEPROM_I2C_PAGES EEPROM_I2C_SIZE / EEPROM_I2C_PAGESIZE

#define EEPROM_I2C_DEVICE_ADDR (0x54U)

#define EEPROM_I2C_PAGES EEPROM_I2C_SIZE / EEPROM_I2C_PAGESIZE

#define EEPROM_I2C_PAGESIZE (256U)

#define EEPROM_I2C_SIZE (262144U)

#define EEPROM_I2C_WORD_LEN_BIT (18U)

#define EEPROM_I2C_WORD_LEN_BYTES (2U)

typedef struct EEPROM_DEVICE_CONTEXT EEPROM_DEVICE_CONTEXT_t

typedef enum EEPROM_STATUS EEPROM_STATUS_t

typedef struct EEPROM_INTERFACE EEPROM_INTERFACE_t