mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-27 18:25:05 +00:00
cleanup: eeprom and option comments
No code changes, just updating comments. BUG=chrome-os-partner:23558 BRANCH=none TEST=compile bds project Change-Id: I819244acafcf89a1e983bddecd82f770b0374ee1 Signed-off-by: Randall Spangler <rspangler@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/174512
This commit is contained in:
committed by
chrome-internal-fetch
parent
a88b237729
commit
17ea6d50f0
@@ -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 */
|
||||
|
||||
@@ -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 */
|
||||
|
||||
Reference in New Issue
Block a user