diff options
| -rw-r--r-- | common/eoption.c | 4 | ||||
| -rw-r--r-- | include/eeprom.h | 40 |
2 files changed, 32 insertions, 12 deletions
diff --git a/common/eoption.c b/common/eoption.c index 24879a76e0..2a3f64f846 100644 --- a/common/eoption.c +++ b/common/eoption.c @@ -119,8 +119,8 @@ void eoption_init(void) return; /* - * TODO: should have a CRC if we start using this for real - * (non-debugging) options. + * TODO(crosbug.com/p/23558): The header should really have a checksum + * field, so that we can detect uninitialized/corrupt data. */ /* Initialize fields which weren't set in previous versions */ diff --git a/include/eeprom.h b/include/eeprom.h index 70290e17d4..fd2ff21d71 100644 --- a/include/eeprom.h +++ b/include/eeprom.h @@ -10,26 +10,46 @@ #include "common.h" -/* Initializes the module. */ +/** + * Initialize the module. + */ int eeprom_init(void); -/* Returns the number of EEPROM blocks on the system. */ +/** + * Returns the number of EEPROM blocks on the system. + */ int eeprom_get_block_count(void); -/* Returns the EEPROM block size in bytes. */ +/** + * Return the EEPROM block size in bytes. + */ int eeprom_get_block_size(void); -/* Reads <size> bytes of data from <offset> in <block> of EEPROM. Offset - * and size must be a multiple of 32 bits. */ +/** + * Read data from EEPROM. + * + * @param block Block number + * @param offset Byte offset in block; must be multiple of 4. + * @param size Number of bytes to read; must be multiple of 4. + * @param data Destination for data + */ int eeprom_read(int block, int offset, int size, char *data); -/* Writes <size> bytes of data to <offset> in <block> of EEPROM. Offset - * and size must be a multiple of 32 bits. */ +/** + * Write data to EEPROM. + * + * @param block Block number + * @param offset Byte offset in block; must be multiple of 4. + * @param size Number of bytes to write; must be multiple of 4. + * @param data Data to write + */ int eeprom_write(int block, int offset, int size, const char *data); -/* Hides an EEPROM block until the next reset. */ +/** + * Hide an EEPROM block until the next reset. + * + * @param block Block number + */ int eeprom_hide(int block); -/* TODO: write protect */ - #endif /* __CROS_EC_EEPROM_H */ |