From 4e4b0f5fe62bd85f3df0ef5b219a25c9b3fb45e3 Mon Sep 17 00:00:00 2001 From: asterix Date: Thu, 5 Aug 2010 15:43:24 +0000 Subject: [PATCH] Add comments. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4152 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/drv/eeprom.c | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/bertos/drv/eeprom.c b/bertos/drv/eeprom.c index f66135fc..ba62b003 100644 --- a/bertos/drv/eeprom.c +++ b/bertos/drv/eeprom.c @@ -108,6 +108,12 @@ STATIC_ASSERT(countof(mem_info) == EEPROM_CNT); #define CHUNCK_SIZE 16 +/** + * Erase EEPROM. + * \param eep is the Kblock context. + * \param addr eeprom address where start to erase + * \param size number of byte to erase + */ bool eeprom_erase(Eeprom *eep, e2addr_t addr, e2_size_t size) { uint8_t tmp[CHUNCK_SIZE] = { [0 ... (CHUNCK_SIZE - 1)] = 0xFF }; @@ -127,6 +133,13 @@ bool eeprom_erase(Eeprom *eep, e2addr_t addr, e2_size_t size) return true; } +/** + * Verify EEPROM. + * \param eep is the Kblock context. + * \param addr eeprom address where start to verify. + * \param buf buffer of data to compare with eeprom data read. + * \param size number of byte to verify. + */ bool eeprom_verify(Eeprom *eep, e2addr_t addr, const void *buf, size_t size) { uint8_t verify_buf[CHUNCK_SIZE]; @@ -313,7 +326,7 @@ static const KBlockVTable eeprom_unbuffered_vt = /** * Initialize EEPROM module. - * \param b is the Kblock context. + * \param eep is the Kblock context. * \param type is the eeprom device we want to initialize (\see EepromType) * \param i2c context for i2c channel * \param addr is the i2c devide address (usually pins A0, A1, A2). -- 2.25.1