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