bertos/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  * All Rights Reserved.
  31  * -->
  32  *
  33  * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS.
  34  *
  35  * \author Stefano Fedrigo <aleph@develer.com>
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  *
  38  * $WIZ$ module_name = "eeprom"
  39  * $WIZ$ module_depends = "kfile", "i2c"
  40  */
  41
  42 #ifndef DRV_EEPROM_H
  43 #define DRV_EEPROM_H
  44
  45 #define EEPROM_OLD_API  1
  46
  47 #include <cfg/compiler.h>
  48 #include <cfg/debug.h>
  49
  50 #include <drv/i2c.h>
  51
  52 #include <io/kblock.h>
  53 #include <io/kfile.h>
  54 #include <io/kfile_block.h>
  55
  56 #include <cpu/attr.h>
  57
  58 #if COMPILER_C99
  59         #define eeprom_init(...)        PP_CAT(eeprom_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
  60 #else
  61         #define eeprom_init(args...)    PP_CAT(eeprom_init ## _, COUNT_PARMS(args)) (args)
  62 #endif
  63
  64
  65 /**
  66  * Values for Eeprom types.
  67  */
  68 typedef enum EepromType
  69 {
  70         EEPROM_24XX08,
  71         EEPROM_24XX16,
  72         EEPROM_24XX256,
  73         EEPROM_24XX512,
  74         EEPROM_24XX1024,
  75         EEPROM_CNT,
  76 } EepromType;
  77
  78 /**
  79  * On the same I2C bus can live more than one EEPROM
  80  * device. Each device can be addressed by one or more
  81  * pins.
  82  */
  83 typedef uint8_t e2dev_addr_t;
  84
  85 /**
  86  * Describe an EEPROM context, used by the driver to
  87  * access the single device.
  88  */
  89 typedef struct Eeprom
  90 {
  91         KBlock blk;
  92         I2c *i2c;
  93         EepromType type;   ///< EEPROM type
  94         e2dev_addr_t addr; ///< Device address.
  95         bool verify;
  96 #if EEPROM_OLD_API
  97         union {
  98                 KFile fd;
  99                 KFileBlock fdblk;
 100         } DEPRECATED;
 101 #endif
 102 } Eeprom;
 103
 104 #if EEPROM_OLD_API
 105         STATIC_ASSERT(offsetof(Eeprom, fd) == offsetof(Eeprom, fdblk.fd));
 106 #endif
 107
 108 /**
 109  * ID for eeproms.
 110  */
 111 #define KBT_EEPROM MAKE_ID('E', 'E', 'P', 'R')
 112
 113 /**
 114  * Convert + ASSERT from generic KFile to Eeprom.
 115  */
 116 INLINE Eeprom * EEPROM_CAST_KBLOCK(KBlock *blk)
 117 {
 118         ASSERT(blk->priv.type == KBT_EEPROM);
 119         return (Eeprom *)blk;
 120 }
 121
 122 /// Type for EEPROM addresses
 123 typedef uint16_t e2addr_t;
 124
 125 /**
 126  * Macro for E2Layout offset calculation
 127  *
 128  * \note We can't just use offsetof() here because we could use
 129  *       non-constant expressions to access array elements.
 130  *
 131  * \note 'type' is the structure type holding eeprom layout
 132  *       and must be defined in user files.
 133  */
 134 #define e2addr(type, field) ((e2addr_t)&(((type *)0)->field))
 135
 136 /**
 137  * Type for EEPROM block size.
 138  */
 139 typedef uint16_t e2blk_size_t;
 140
 141 /**
 142  * Type for accessing EEPROM whole size.
 143  */
 144 typedef uint32_t e2_size_t;
 145
 146 /**
 147  * Descrive all EEPROM informations
 148  * needed by the driver.
 149  */
 150 typedef struct EepromInfo
 151 {
 152         bool has_dev_addr;     ///< true if memory is device addressable (its A0, A1, A2 pin are used by memory).
 153         e2blk_size_t blk_size; ///< block size
 154         e2_size_t e2_size;     ///< eeprom size
 155 } EepromInfo;
 156
 157 void eeprom_init_5(Eeprom *blk, I2c *i2c, EepromType type, e2dev_addr_t addr, bool verify);
 158
 159 #if EEPROM_OLD_API
 160 DEPRECATED bool eeprom_erase(Eeprom *fd, e2addr_t addr, e2_size_t count);
 161 DEPRECATED bool eeprom_verify(Eeprom *fd, const void *buf, size_t count);
 162
 163
 164 DEPRECATED INLINE void eeprom_init_4(Eeprom *ee, EepromType type, e2dev_addr_t addr, bool verify)
 165 {
 166         eeprom_init_5(ee, &local_i2c_old_api, type, addr, verify);
 167         kfileblock_init(&ee->fdblk, &ee->blk);
 168 }
 169
 170 #endif
 171
 172 #endif /* DRV_EEPROM_H */