drv/eeprom.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation)
  34  *
  35  * \note This implementation is AVR specific.
  36  *
  37  * \version $Id$
  38  * \author Stefano Fedrigo <aleph@develer.com>
  39  * \author Bernardo Innocenti <bernie@develer.com>
  40  */
  41
  42 /*#*
  43  *#* $Log$
  44  *#* Revision 1.20  2006/07/19 12:56:25  bernie
  45  *#* Convert to new Doxygen style.
  46  *#*
  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.
  49  *#*
  50  *#* Revision 1.18  2005/11/27 23:33:40  bernie
  51  *#* Use appconfig.h instead of cfg/config.h.
  52  *#*
  53  *#* Revision 1.17  2005/04/11 19:10:27  bernie
  54  *#* Include top-level headers from cfg/ subdir.
  55  *#*
  56  *#* Revision 1.16  2005/03/01 23:25:09  bernie
  57  *#* Prune CVS log.
  58  *#*
  59  *#* Revision 1.11  2004/10/26 08:35:31  bernie
  60  *#* Reset watchdog for long operations.
  61  *#*
  62  *#* Revision 1.10  2004/09/20 03:31:22  bernie
  63  *#* Sanitize for C++.
  64  *#*
  65  *#* Revision 1.9  2004/09/14 21:03:46  bernie
  66  *#* Use debug.h instead of kdebug.h.
  67  *#*/
  68
  69 #include "eeprom.h"
  70
  71 #include <cfg/debug.h>
  72 #include <appconfig.h>  // CONFIG_EEPROM_VERIFY
  73 #include <cfg/macros.h>  // MIN()
  74 #include <cpu/cpu.h>
  75 #include CPU_HEADER(twi)
  76 #include <drv/wdt.h>
  77 #include <mware/byteorder.h> // cpu_to_be16()
  78
  79 #include <string.h>  // memset()
  80
  81
  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
  85 #endif
  86
  87 /**
  88  * EEPROM ID code
  89  */
  90 #define EEPROM_ID  0xA0
  91
  92 /**
  93  * This macros form the correct slave address for EEPROMs
  94  */
  95 #define EEPROM_ADDR(x) (EEPROM_ID | (((uint8_t)(x)) << 1))
  96
  97
  98
  99
 100 /**
 101  * Copy \c count bytes from buffer \c buf to
 102  * eeprom at address \c addr.
 103  */
 104 static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count)
 105 {
 106         bool result = true;
 107         ASSERT(addr + count <= EEPROM_SIZE);
 108
 109         while (count && result)
 110         {
 111                 /*
 112                  * Split write in multiple sequential mode operations that
 113                  * don't cross page boundaries.
 114                  */
 115                 size_t size =
 116                         MIN(count, (size_t)(EEPROM_BLKSIZE - (addr & (EEPROM_BLKSIZE - 1))));
 117
 118         #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
 119                 /*
 120                  * The 24LC16 uses the slave address as a 3-bit
 121                  * block address.
 122                  */
 123                 uint8_t blk_addr = (uint8_t)((addr >> 8) & 0x07);
 124                 uint8_t blk_offs = (uint8_t)addr;
 125
 126                 result =
 127                         twi_start_w(EEPROM_ADDR(blk_addr))
 128                         && twi_send(&blk_offs, sizeof blk_offs)
 129                         && twi_send(buf, size);
 130
 131         #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
 132
 133                 // 24LC256 wants big-endian addresses
 134                 uint16_t addr_be = cpu_to_be16(addr);
 135
 136                 result =
 137                         twi_start_w(EEPROM_ID)
 138                         && twi_send((uint8_t *)&addr_be, sizeof addr_be)
 139                         && twi_send(buf, size);
 140
 141         #else
 142                 #error Unknown device type
 143         #endif
 144
 145                 twi_stop();
 146
 147                 // DEBUG
 148                 //kprintf("addr=%d, count=%d, size=%d, *#?=%d\n",
 149                 //      addr, count, size,
 150                 //      (EEPROM_BLKSIZE - (addr & (EEPROM_BLKSIZE - 1)))
 151                 //);
 152
 153                 /* Update count and addr for next operation */
 154                 count -= size;
 155                 addr += size;
 156                 buf = ((const char *)buf) + size;
 157         }
 158
 159         if (!result)
 160                 TRACEMSG("Write error!");
 161         return result;
 162 }
 163
 164
 165 #if CONFIG_EEPROM_VERIFY
 166 /**
 167  * Check that the contents of an EEPROM range
 168  * match with a provided data buffer.
 169  *
 170  * \return true on success.
 171  */
 172 static bool eeprom_verify(e2addr_t addr, const void *buf, size_t count)
 173 {
 174         uint8_t verify_buf[16];
 175         bool result = true;
 176
 177         while (count && result)
 178         {
 179                 /* Split read in smaller pieces */
 180                 size_t size = MIN(count, sizeof verify_buf);
 181
 182                 /* Read back buffer */
 183                 if (eeprom_read(addr, verify_buf, size))
 184                 {
 185                         if (memcmp(buf, verify_buf, size) != 0)
 186                         {
 187                                 TRACEMSG("Data mismatch!");
 188                                 result = false;
 189                         }
 190                 }
 191                 else
 192                 {
 193                         TRACEMSG("Read error!");
 194                         result = false;
 195                 }
 196
 197                 /* Update count and addr for next operation */
 198                 count -= size;
 199                 addr += size;
 200                 buf = ((const char *)buf) + size;
 201         }
 202
 203         return result;
 204 }
 205 #endif /* CONFIG_EEPROM_VERIFY */
 206
 207
 208 bool eeprom_write(e2addr_t addr, const void *buf, size_t count)
 209 {
 210 #if CONFIG_EEPROM_VERIFY
 211         int retries = 5;
 212
 213         while (retries--)
 214                 if (eeprom_writeRaw(addr, buf, count)
 215                                 && eeprom_verify(addr, buf, count))
 216                         return true;
 217
 218         return false;
 219
 220 #else /* !CONFIG_EEPROM_VERIFY */
 221         return eeprom_writeRaw(addr, buf, count);
 222 #endif /* !CONFIG_EEPROM_VERIFY */
 223 }
 224
 225
 226 /**
 227  * Copy \c count bytes at address \c addr
 228  * from eeprom to RAM to buffer \c buf.
 229  *
 230  * \return true on success.
 231  */
 232 bool eeprom_read(e2addr_t addr, void *buf, size_t count)
 233 {
 234         ASSERT(addr + count <= EEPROM_SIZE);
 235
 236 #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
 237         /*
 238          * The 24LC16 uses the slave address as a 3-bit
 239          * block address.
 240          */
 241         uint8_t blk_addr = (uint8_t)((addr >> 8) & 0x07);
 242         uint8_t blk_offs = (uint8_t)addr;
 243
 244         bool res =
 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);
 249
 250 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
 251
 252         // 24LC256 wants big-endian addresses
 253         addr = cpu_to_be16(addr);
 254
 255         bool res =
 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);
 260 #else
 261         #error Unknown device type
 262 #endif
 263
 264         twi_stop();
 265
 266         if (!res)
 267                 TRACEMSG("Read error!");
 268         return res;
 269 }
 270
 271
 272 /**
 273  * Write a single character \a c at address \a addr.
 274  */
 275 bool eeprom_write_char(e2addr_t addr, char c)
 276 {
 277         return eeprom_write(addr, &c, 1);
 278 }
 279
 280
 281 /**
 282  * Read a single character at address \a addr.
 283  *
 284  * \return the requested character or -1 in case of failure.
 285  */
 286 int eeprom_read_char(e2addr_t addr)
 287 {
 288         char c;
 289
 290         if (eeprom_read(addr, &c, 1))
 291                 return c;
 292         else
 293                 return -1;
 294 }
 295
 296
 297 /**
 298  * Erase specified part of eeprom, writing 0xFF.
 299  *
 300  * \param addr   starting address
 301  * \param count  length of block to erase
 302  */
 303 void eeprom_erase(e2addr_t addr, size_t count)
 304 {
 305         uint8_t buf[EEPROM_BLKSIZE];
 306         memset(buf, 0xFF, sizeof buf);
 307
 308         // Clear all but struct hw_info at start of eeprom
 309         while (count)
 310         {
 311                 // Long operation, reset watchdog
 312                 wdt_reset();
 313
 314                 size_t size = MIN(count, sizeof buf);
 315                 eeprom_write(addr, buf, size);
 316                 addr += size;
 317                 count -= size;
 318         }
 319 }
 320
 321
 322 /**
 323  * Initialize TWI module.
 324  */
 325 void eeprom_init(void)
 326 {
 327         twi_init();
 328 }
 329
 330
 331 #ifdef _DEBUG
 332
 333 #include <string.h>
 334
 335 void eeprom_test(void)
 336 {
 337         static const char magic[14] = "Humpty Dumpty";
 338         char buf[sizeof magic];
 339         size_t i;
 340
 341         // Write something to EEPROM using unaligned sequential writes
 342         for (i = 0; i < 42; ++i)
 343         {
 344                 wdt_reset();
 345                 eeprom_write(i * sizeof magic, magic, sizeof magic);
 346         }
 347
 348         // Read back with single-byte reads
 349         for (i = 0; i < 42 * sizeof magic; ++i)
 350         {
 351                 wdt_reset();
 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]);
 355         }
 356
 357         // Read back again using sequential reads
 358         for (i = 0; i < 42; ++i)
 359         {
 360                 wdt_reset();
 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);
 365         }
 366 }
 367
 368 #endif // _DEBUG