4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2005, 2010 Develer S.r.l. (http://www.develer.com/)
33 * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation)
35 * \author Stefano Fedrigo <aleph@develer.com>
36 * \author Bernie Innocenti <bernie@codewiz.org>
41 #include "cfg/cfg_i2c.h"
42 #include "cfg/cfg_eeprom.h"
44 /* Define logging setting (for cfg/log.h module). */
45 #define LOG_LEVEL EEPROM_LOG_LEVEL
46 #define LOG_FORMAT EEPROM_LOG_FORMAT
48 #include <cfg/debug.h>
49 #include <cfg/macros.h> // MIN()
55 #include <string.h> // memset()
60 #define EEPROM_ID 0xA0
63 * This macros form the correct slave address for EEPROMs
65 #define EEPROM_ADDR(x) (EEPROM_ID | (((uint8_t)((x) & 0x07)) << 1))
69 * Array used to describe EEPROM memory devices currently supported.
71 static const EepromInfo mem_info[] =
75 .has_dev_addr = false,
81 .has_dev_addr = false,
104 /* Add other memories here */
107 STATIC_ASSERT(countof(mem_info) == EEPROM_CNT);
109 #define CHUNCK_SIZE 16
111 bool eeprom_erase(Eeprom *eep, e2addr_t addr, e2_size_t size)
113 uint8_t tmp[CHUNCK_SIZE] = { [0 ... (CHUNCK_SIZE - 1)] = 0xFF };
117 block_idx_t idx = addr / eep->blk.blk_size;
118 size_t offset = addr % eep->blk.blk_size;
119 size_t count = MIN(size, (e2_size_t)CHUNCK_SIZE);
120 size_t ret_len = eep->blk.priv.vt->writeDirect((KBlock *)eep, idx, tmp, offset, count);
124 if (ret_len != count)
130 bool eeprom_verify(Eeprom *eep, e2addr_t addr, const void *buf, size_t size)
132 uint8_t verify_buf[CHUNCK_SIZE];
135 block_idx_t idx = addr / eep->blk.blk_size;
136 size_t offset = addr % eep->blk.blk_size;
137 size_t count = MIN(size, (size_t)CHUNCK_SIZE);
139 size_t ret_len = eep->blk.priv.vt->readDirect((KBlock *)eep, idx, verify_buf, offset, count);
141 if (ret_len != count)
143 LOG_ERR("Verify read fail.\n");
147 if (memcmp(buf, verify_buf, ret_len) != 0)
149 LOG_ERR("Data mismatch!\n");
155 buf = ((const char *)buf) + ret_len;
161 static size_t eeprom_write(KBlock *blk, block_idx_t idx, const void *buf, size_t offset, size_t size)
163 Eeprom *eep = EEPROM_CAST_KBLOCK(blk);
164 e2dev_addr_t dev_addr;
167 uint32_t abs_addr = blk->blk_size * idx + offset;
169 STATIC_ASSERT(countof(addr_buf) <= sizeof(e2addr_t));
172 /* clamp size to memory limit (otherwise may roll back) */
173 ASSERT(idx <= blk->blk_cnt);
174 size = MIN(size, blk->blk_size - offset);
176 if (mem_info[eep->type].has_dev_addr)
178 dev_addr = eep->addr;
183 dev_addr = (e2dev_addr_t)((abs_addr >> 8) & 0x07);
187 if (mem_info[eep->type].has_dev_addr)
189 addr_buf[0] = (abs_addr >> 8) & 0xFF;
190 addr_buf[1] = (abs_addr & 0xFF);
194 dev_addr = (e2dev_addr_t)((abs_addr >> 8) & 0x07);
195 addr_buf[0] = (abs_addr & 0xFF);
198 i2c_start_w(eep->i2c, EEPROM_ADDR(dev_addr), addr_len + size, I2C_STOP);
199 i2c_write(eep->i2c, addr_buf, addr_len);
200 i2c_write(eep->i2c, buf, size);
202 if (i2c_error(eep->i2c))
208 static size_t eeprom_readDirect(struct KBlock *_blk, block_idx_t idx, void *_buf, size_t offset, size_t size)
210 Eeprom *blk = EEPROM_CAST_KBLOCK(_blk);
214 uint8_t *buf = (uint8_t *)_buf;
215 uint32_t abs_addr = mem_info[blk->type].blk_size * idx + offset;
217 STATIC_ASSERT(countof(addr_buf) <= sizeof(e2addr_t));
219 /* clamp size to memory limit (otherwise may roll back) */
220 ASSERT(idx <= blk->blk.blk_cnt);
221 size = MIN(size, blk->blk.blk_size - offset);
223 e2dev_addr_t dev_addr;
224 if (mem_info[blk->type].has_dev_addr)
226 dev_addr = blk->addr;
228 addr_buf[0] = (abs_addr >> 8) & 0xFF;
229 addr_buf[1] = (abs_addr & 0xFF);
233 dev_addr = (e2dev_addr_t)((abs_addr >> 8) & 0x07);
235 addr_buf[0] = (abs_addr & 0xFF);
239 i2c_start_w(blk->i2c, EEPROM_ADDR(dev_addr), addr_len, I2C_NOSTOP);
240 i2c_write(blk->i2c, addr_buf, addr_len);
242 i2c_start_r(blk->i2c, EEPROM_ADDR(dev_addr), size, I2C_STOP);
243 i2c_read(blk->i2c, buf, size);
245 if (i2c_error(blk->i2c))
253 static size_t eeprom_writeDirect(KBlock *blk, block_idx_t idx, const void *buf, size_t offset, size_t size)
255 Eeprom *eep = EEPROM_CAST_KBLOCK(blk);
257 return eeprom_write(blk, idx, buf, offset, size);
263 uint8_t verify_buf[CHUNCK_SIZE];
268 /* Split read in smaller pieces */
269 size_t count = MIN(size, (size_t)CHUNCK_SIZE);
270 if ((wr_len = eeprom_write(blk, idx, buf, offset, count)) != 0)
272 if (eeprom_readDirect(blk, idx, verify_buf, offset, count) != wr_len)
274 LOG_ERR("Verify read fail.\n");
277 else if (memcmp(buf, verify_buf, wr_len) != 0)
279 LOG_ERR("Data mismatch!\n");
285 LOG_ERR("Write fail.\n");
290 buf = ((const char *)buf) + wr_len;
299 static int kblockEeprom_dummy(UNUSED_ARG(struct KBlock *,b))
305 static const KBlockVTable eeprom_unbuffered_vt =
307 .readDirect = eeprom_readDirect,
308 .writeDirect = eeprom_writeDirect,
310 .error = kblockEeprom_dummy,
311 .clearerr = (kblock_clearerr_t)kblockEeprom_dummy,
315 * Initialize EEPROM module.
316 * \param b is the Kblock context.
317 * \param type is the eeprom device we want to initialize (\see EepromType)
318 * \param i2c context for i2c channel
319 * \param addr is the i2c devide address (usually pins A0, A1, A2).
321 void eeprom_init_5(Eeprom *eep, I2c *i2c, EepromType type, e2dev_addr_t addr, bool verify)
323 ASSERT(type < EEPROM_CNT);
325 memset(eep, 0, sizeof(*eep));
326 DB(eep->blk.priv.type = KBT_EEPROM);
331 eep->verify = verify;
333 eep->blk.blk_size = mem_info[type].blk_size;
334 eep->blk.blk_cnt = mem_info[type].e2_size / mem_info[type].blk_size;
335 eep->blk.priv.flags |= KB_PARTIAL_WRITE;
336 eep->blk.priv.vt = &eeprom_unbuffered_vt;