HalEepromInformationType Struct Reference

This structure defines a variety of information about the attached external EEPROM device.

#include <bootloader-eeprom.h>

Data Fields

uint16_t version
 The version of this data structure.
 
uint16_t capabilitiesMask
 A bitmask describing the capabilites of this particular external EEPROM.
 
uint16_t pageEraseMs
 Maximum time it takes to erase a page.
 
uint16_t partEraseTime
 Maximum time it takes to erase the entire part.
 
uint32_t pageSize
 The size of a single erasable page in bytes.
 
uint32_t partSize
 The total size of the external EEPROM in bytes.
 
const char *const partDescription
 Pointer to a string describing the attached external EEPROM.
 
uint8_t wordSizeBytes
 The number of bytes in a word for the external EEPROM.
 

This structure defines a variety of information about the attached external EEPROM device.

Field Documentation

◆ version

uint16_t HalEepromInformationType::version

The version of this data structure.

◆ capabilitiesMask

uint16_t HalEepromInformationType::capabilitiesMask

A bitmask describing the capabilites of this particular external EEPROM.

◆ pageEraseMs

uint16_t HalEepromInformationType::pageEraseMs

Maximum time it takes to erase a page.

(in 1024Hz Milliseconds)

◆ partEraseTime

uint16_t HalEepromInformationType::partEraseTime

Maximum time it takes to erase the entire part.

(in 1024Hz Milliseconds). Can be changed to be in seconds using EEPROM_CAPABILITIES_PART_ERASE_SECONDS

◆ pageSize

uint32_t HalEepromInformationType::pageSize

The size of a single erasable page in bytes.

◆ partSize

uint32_t HalEepromInformationType::partSize

The total size of the external EEPROM in bytes.

◆ partDescription

const char* const HalEepromInformationType::partDescription

Pointer to a string describing the attached external EEPROM.

◆ wordSizeBytes

uint8_t HalEepromInformationType::wordSizeBytes

The number of bytes in a word for the external EEPROM.