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 #ifndef DRV_EEPROM_H
  42 #define DRV_EEPROM_H
  43
  44 #include <cfg/compiler.h>
  45 #include <appconfig.h>
  46
  47 /**
  48  * \name Values for CONFIG_EEPROM_TYPE
  49  * \{
  50  */
  51 #define EEPROM_24XX16 1
  52 #define EEPROM_24XX256 2
  53 /*\}*/
  54
  55 #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
  56         #define EEPROM_BLKSIZE   0x10 ///< Eeprom block size (16byte)
  57         #define EEPROM_SIZE     0x800 ///< Eeprom total size (2kB)
  58 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
  59         #define EEPROM_BLKSIZE   0x40 ///< Eeprom block size (64byte)
  60         #define EEPROM_SIZE    0x8000 ///< Eeprom total size (32kB)
  61 #else
  62         #error Unsupported EEPROM type.
  63 #endif
  64
  65 /// Type for EEPROM addresses
  66 typedef uint16_t e2addr_t;
  67
  68 /**
  69  * Macro for E2Layout offset calculation
  70  *
  71  * \note We can't just use offsetof() here because we could use
  72  *       non-constant expressions to access array elements.
  73  *
  74  * \note 'type' is the structure type holding eeprom layout
  75  *       and must be defined in user files.
  76  */
  77 #define e2addr(type, field) ((e2addr_t)&(((type *)0)->field))
  78
  79
  80 bool eeprom_write(e2addr_t addr, const void *buf, size_t count);
  81 bool eeprom_read(e2addr_t addr, void *buf, size_t count);
  82 bool eeprom_write_char(e2addr_t addr, char c);
  83 int eeprom_read_char(e2addr_t addr);
  84 void eeprom_erase(e2addr_t addr, size_t count);
  85 void eeprom_init(void);
  86 void eeprom_test(void);
  87
  88 #endif /* DRV_EEPROM_H */