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 Develer S.r.l. (http://www.develer.com/)
33 * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation)
35 * \note This implementation is AVR specific.
38 * \author Stefano Fedrigo <aleph@develer.com>
39 * \author Bernardo Innocenti <bernie@develer.com>
44 *#* Revision 1.20 2006/07/19 12:56:25 bernie
45 *#* Convert to new Doxygen style.
47 *#* Revision 1.19 2006/03/20 17:49:50 bernie
48 *#* Make the TWI driver more generic to work with devices other than EEPROMS.
50 *#* Revision 1.18 2005/11/27 23:33:40 bernie
51 *#* Use appconfig.h instead of cfg/config.h.
53 *#* Revision 1.17 2005/04/11 19:10:27 bernie
54 *#* Include top-level headers from cfg/ subdir.
56 *#* Revision 1.16 2005/03/01 23:25:09 bernie
59 *#* Revision 1.11 2004/10/26 08:35:31 bernie
60 *#* Reset watchdog for long operations.
62 *#* Revision 1.10 2004/09/20 03:31:22 bernie
65 *#* Revision 1.9 2004/09/14 21:03:46 bernie
66 *#* Use debug.h instead of kdebug.h.
71 #include <cfg/debug.h>
72 #include <appconfig.h> // CONFIG_EEPROM_VERIFY
73 #include <cfg/macros.h> // MIN()
75 #include CPU_HEADER(twi)
77 #include <mware/byteorder.h> // cpu_to_be16()
79 #include <string.h> // memset()
82 // Configuration sanity checks
83 #if !defined(CONFIG_EEPROM_VERIFY) || (CONFIG_EEPROM_VERIFY != 0 && CONFIG_EEPROM_VERIFY != 1)
84 #error CONFIG_EEPROM_VERIFY must be defined to either 0 or 1
90 #define EEPROM_ID 0xA0
93 * This macros form the correct slave address for EEPROMs
95 #define EEPROM_ADDR(x) (EEPROM_ID | (((uint8_t)(x)) << 1))
101 * Copy \c count bytes from buffer \c buf to
102 * eeprom at address \c addr.
104 static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count)
107 ASSERT(addr + count <= EEPROM_SIZE);
109 while (count && result)
112 * Split write in multiple sequential mode operations that
113 * don't cross page boundaries.
116 MIN(count, (size_t)(EEPROM_BLKSIZE - (addr & (EEPROM_BLKSIZE - 1))));
118 #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
120 * The 24LC16 uses the slave address as a 3-bit
123 uint8_t blk_addr = (uint8_t)((addr >> 8) & 0x07);
124 uint8_t blk_offs = (uint8_t)addr;
127 twi_start_w(EEPROM_ADDR(blk_addr))
128 && twi_send(&blk_offs, sizeof blk_offs)
129 && twi_send(buf, size);
131 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
133 // 24LC256 wants big-endian addresses
134 uint16_t addr_be = cpu_to_be16(addr);
137 twi_start_w(EEPROM_ID)
138 && twi_send((uint8_t *)&addr_be, sizeof addr_be)
139 && twi_send(buf, size);
142 #error Unknown device type
148 //kprintf("addr=%d, count=%d, size=%d, *#?=%d\n",
149 // addr, count, size,
150 // (EEPROM_BLKSIZE - (addr & (EEPROM_BLKSIZE - 1)))
153 /* Update count and addr for next operation */
156 buf = ((const char *)buf) + size;
160 TRACEMSG("Write error!");
165 #if CONFIG_EEPROM_VERIFY
167 * Check that the contents of an EEPROM range
168 * match with a provided data buffer.
170 * \return true on success.
172 static bool eeprom_verify(e2addr_t addr, const void *buf, size_t count)
174 uint8_t verify_buf[16];
177 while (count && result)
179 /* Split read in smaller pieces */
180 size_t size = MIN(count, sizeof verify_buf);
182 /* Read back buffer */
183 if (eeprom_read(addr, verify_buf, size))
185 if (memcmp(buf, verify_buf, size) != 0)
187 TRACEMSG("Data mismatch!");
193 TRACEMSG("Read error!");
197 /* Update count and addr for next operation */
200 buf = ((const char *)buf) + size;
205 #endif /* CONFIG_EEPROM_VERIFY */
208 bool eeprom_write(e2addr_t addr, const void *buf, size_t count)
210 #if CONFIG_EEPROM_VERIFY
214 if (eeprom_writeRaw(addr, buf, count)
215 && eeprom_verify(addr, buf, count))
220 #else /* !CONFIG_EEPROM_VERIFY */
221 return eeprom_writeRaw(addr, buf, count);
222 #endif /* !CONFIG_EEPROM_VERIFY */
227 * Copy \c count bytes at address \c addr
228 * from eeprom to RAM to buffer \c buf.
230 * \return true on success.
232 bool eeprom_read(e2addr_t addr, void *buf, size_t count)
234 ASSERT(addr + count <= EEPROM_SIZE);
236 #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
238 * The 24LC16 uses the slave address as a 3-bit
241 uint8_t blk_addr = (uint8_t)((addr >> 8) & 0x07);
242 uint8_t blk_offs = (uint8_t)addr;
245 twi_start_w(EEPROM_ADDR(blk_addr))
246 && twi_send(&blk_offs, sizeof blk_offs)
247 && twi_start_r(EEPROM_ADDR(blk_addr))
248 && twi_recv(buf, count);
250 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
252 // 24LC256 wants big-endian addresses
253 addr = cpu_to_be16(addr);
256 twi_start_w(EEPROM_ID)
257 && twi_send((uint8_t *)&addr, sizeof(addr))
258 && twi_start_r(EEPROM_ID)
259 && twi_recv(buf, count);
261 #error Unknown device type
267 TRACEMSG("Read error!");
273 * Write a single character \a c at address \a addr.
275 bool eeprom_write_char(e2addr_t addr, char c)
277 return eeprom_write(addr, &c, 1);
282 * Read a single character at address \a addr.
284 * \return the requested character or -1 in case of failure.
286 int eeprom_read_char(e2addr_t addr)
290 if (eeprom_read(addr, &c, 1))
298 * Erase specified part of eeprom, writing 0xFF.
300 * \param addr starting address
301 * \param count length of block to erase
303 void eeprom_erase(e2addr_t addr, size_t count)
305 uint8_t buf[EEPROM_BLKSIZE];
306 memset(buf, 0xFF, sizeof buf);
308 // Clear all but struct hw_info at start of eeprom
311 // Long operation, reset watchdog
314 size_t size = MIN(count, sizeof buf);
315 eeprom_write(addr, buf, size);
323 * Initialize TWI module.
325 void eeprom_init(void)
335 void eeprom_test(void)
337 static const char magic[14] = "Humpty Dumpty";
338 char buf[sizeof magic];
341 // Write something to EEPROM using unaligned sequential writes
342 for (i = 0; i < 42; ++i)
345 eeprom_write(i * sizeof magic, magic, sizeof magic);
348 // Read back with single-byte reads
349 for (i = 0; i < 42 * sizeof magic; ++i)
352 eeprom_read(i, buf, 1);
353 kprintf("EEPROM byte read: %c (%d)\n", buf[0], buf[0]);
354 ASSERT(buf[0] == magic[i % sizeof magic]);
357 // Read back again using sequential reads
358 for (i = 0; i < 42; ++i)
361 memset(buf, 0, sizeof buf);
362 eeprom_read(i * sizeof magic, buf, sizeof magic);
363 kprintf("EEPROM seq read @ 0x%x: '%s'\n", i * sizeof magic, buf);
364 ASSERT(memcmp(buf, magic, sizeof magic) == 0);