4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
30 * All Rights Reserved.
33 * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS.
35 * \author Stefano Fedrigo <aleph@develer.com>
36 * \author Bernie Innocenti <bernie@codewiz.org>
38 * $WIZ$ module_name = "eeprom"
39 * $WIZ$ module_depends = "kfile", "kfile_block", "kblock", "i2c"
45 #include "cfg/cfg_eeprom.h"
47 #include <cfg/compiler.h>
48 #include <cfg/debug.h>
52 #include <io/kblock.h>
54 #include <io/kfile_block.h>
59 #define eeprom_init(...) PP_CAT(eeprom_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
60 #define eeprom_verify(...) PP_CAT(eeprom_verify ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
62 #define eeprom_init(args...) PP_CAT(eeprom_init ## _, COUNT_PARMS(args)) (args)
63 #define eeprom_verify(args...) PP_CAT(eeprom_verify ## _, COUNT_PARMS(args)) (args)
68 * Values for Eeprom types.
70 typedef enum EepromType
81 * On the same I2C bus can live more than one EEPROM
82 * device. Each device can be addressed by one or more
85 typedef uint8_t e2dev_addr_t;
88 * Describe an EEPROM context, used by the driver to
89 * access the single device.
95 EepromType type; ///< EEPROM type
96 e2dev_addr_t addr; ///< Device address.
98 #if !CONFIG_EEPROM_DISABLE_OLD_API
103 #endif /* !CONFIG_EEPROM_DISABLE_OLD_API */
106 #if !CONFIG_EEPROM_DISABLE_OLD_API
107 STATIC_ASSERT(offsetof(Eeprom, fd) == offsetof(Eeprom, fdblk.fd));
108 #endif /* !CONFIG_EEPROM_DISABLE_OLD_API */
113 #define KBT_EEPROM MAKE_ID('E', 'E', 'P', 'R')
116 * Convert + ASSERT from generic KFile to Eeprom.
118 INLINE Eeprom * EEPROM_CAST_KBLOCK(KBlock *blk)
120 ASSERT(blk->priv.type == KBT_EEPROM);
121 return (Eeprom *)blk;
124 /// Type for EEPROM addresses
125 typedef uint16_t e2addr_t;
128 * Macro for E2Layout offset calculation
130 * \note We can't just use offsetof() here because we could use
131 * non-constant expressions to access array elements.
133 * \note 'type' is the structure type holding eeprom layout
134 * and must be defined in user files.
136 #define e2addr(type, field) ((e2addr_t)&(((type *)0)->field))
139 * Type for EEPROM block size.
141 typedef uint16_t e2blk_size_t;
144 * Type for accessing EEPROM whole size.
146 typedef uint32_t e2_size_t;
149 * Descrive all EEPROM informations
150 * needed by the driver.
152 typedef struct EepromInfo
154 bool has_dev_addr; ///< true if memory is device addressable (its A0, A1, A2 pin are used by memory).
155 e2blk_size_t blk_size; ///< block size
156 e2_size_t e2_size; ///< eeprom size
159 bool eeprom_erase(Eeprom *eep, e2addr_t addr, e2_size_t count);
160 bool eeprom_verify_4(Eeprom *eep, e2addr_t addr, const void *buf, size_t count);
161 void eeprom_init_5(Eeprom *eep, I2c *i2c, EepromType type, e2dev_addr_t addr, bool verify);
163 #if !CONFIG_EEPROM_DISABLE_OLD_API
165 DEPRECATED INLINE bool eeprom_verify_3(Eeprom *eep, const void *buf, size_t count)
167 return eeprom_verify_4(eep, (e2addr_t)eep->fdblk.fd.seek_pos, buf, count);
169 DEPRECATED INLINE void eeprom_init_4(Eeprom *eep, EepromType type, e2dev_addr_t addr, bool verify)
171 eeprom_init_5(eep, &local_i2c_old_api, type, addr, verify);
172 kfileblock_init(&eep->fdblk, &eep->blk);
174 #endif /* !CONFIG_EEPROM_DISABLE_OLD_API */
176 #endif /* DRV_EEPROM_H */