drv/eeprom.h

   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 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \version $Id$
  34  *
  35  * \author Stefano Fedrigo <aleph@develer.com>
  36  * \author Bernardo Innocenti <bernie@develer.com>
  37  *
  38  * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (interface)
  39  */
  40
  41 /*#*
  42  *#* $Log$
  43  *#* Revision 1.10  2006/09/13 18:29:54  bernie
  44  *#* e2addr(): New macro.
  45  *#*
  46  *#* Revision 1.9  2006/07/19 12:56:25  bernie
  47  *#* Convert to new Doxygen style.
  48  *#*
  49  *#* Revision 1.8  2005/11/27 23:33:40  bernie
  50  *#* Use appconfig.h instead of cfg/config.h.
  51  *#*
  52  *#* Revision 1.7  2005/11/04 16:20:02  bernie
  53  *#* Fix reference to README.devlib in header.
  54  *#*
  55  *#* Revision 1.6  2005/04/11 19:10:27  bernie
  56  *#* Include top-level headers from cfg/ subdir.
  57  *#*
  58  *#* Revision 1.5  2004/11/02 17:50:02  bernie
  59  *#* CONFIG_EEPROM_VERIFY: New config option.
  60  *#*
  61  *#* Revision 1.4  2004/08/25 14:12:08  rasky
  62  *#* Aggiornato il comment block dei log RCS
  63  *#*
  64  *#* Revision 1.3  2004/08/10 06:57:22  bernie
  65  *#* eeprom_erase(): New function.
  66  *#*
  67  *#* Revision 1.2  2004/07/29 22:57:09  bernie
  68  *#* Add 24LC16 support.
  69  *#*
  70  *#* Revision 1.1  2004/07/20 17:11:18  bernie
  71  *#* Import into DevLib.
  72  *#*
  73  *#*/
  74 #ifndef DRV_EEPROM_H
  75 #define DRV_EEPROM_H
  76
  77 #include <cfg/compiler.h>
  78 #include <appconfig.h>
  79
  80 /**
  81  * \name Values for CONFIG_EEPROM_TYPE
  82  * \{
  83  */
  84 #define EEPROM_24XX16 1
  85 #define EEPROM_24XX256 2
  86 /*\}*/
  87
  88 #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
  89         #define EEPROM_BLKSIZE   0x10 ///< Eeprom block size (16byte)
  90         #define EEPROM_SIZE     0x800 ///< Eeprom total size (2kB)
  91 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
  92         #define EEPROM_BLKSIZE   0x40 ///< Eeprom block size (64byte)
  93         #define EEPROM_SIZE    0x8000 ///< Eeprom total size (32kB)
  94 #else
  95         #error Unsupported EEPROM type.
  96 #endif
  97
  98 /// Type for EEPROM addresses
  99 typedef uint16_t e2addr_t;
 100
 101 /**
 102  * Macro for E2Layout offset calculation
 103  *
 104  * \note We can't just use offsetof() here because we could use
 105  *       non-constant expressions to access array elements.
 106  *
 107  * \note E2Layout is a structure that must be defined in user files.
 108  */
 109 #define e2addr(x) ((e2addr_t)&(((struct E2Layout *)0)->x))
 110
 111
 112 bool eeprom_write(e2addr_t addr, const void *buf, size_t count);
 113 bool eeprom_read(e2addr_t addr, void *buf, size_t count);
 114 bool eeprom_write_char(e2addr_t addr, char c);
 115 int eeprom_read_char(e2addr_t addr);
 116 void eeprom_erase(e2addr_t addr, size_t count);
 117 void eeprom_init(void);
 118 void eeprom_test(void);
 119
 120 #endif /* DRV_EEPROM_H */