Merged from external project:
[bertos.git] / 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 (interface)
34  *
35  * \version $Id$
36  *
37  * \author Stefano Fedrigo <aleph@develer.com>
38  * \author Bernie Innocenti <bernie@codewiz.org>
39  *
40  */
41
42 #ifndef DRV_EEPROM_H
43 #define DRV_EEPROM_H
44
45 #include <cfg/compiler.h>
46 #include <kern/kfile.h>
47
48
49 /**
50  * Values for Eeprom types.
51  */
52 typedef enum EepromType
53 {
54         EEPROM_24XX16,
55         EEPROM_24XX256,
56         EEPROM_24XX512,
57         EEPROM_CNT,
58 } EepromType;
59
60 /**
61  * On the same I2C bus can live more than one EEPROM
62  * device. Each device can be addressed by one or more
63  * pins.
64  */
65 typedef uint8_t e2dev_addr_t;
66
67 /**
68  * Describe an EEPROM context, used by the driver to
69  * access the single device.
70  */
71 typedef struct Eeprom
72 {
73         KFile fd;          ///< File descriptor.
74         EepromType type;   ///< EEPROM type
75         e2dev_addr_t addr; ///< Device address.
76 } Eeprom;
77
78 /**
79  * ID for eeproms.
80  */
81 #define KFT_EEPROM MAKE_ID('E', 'E', 'P', 'R')
82
83 /**
84  * Convert + ASSERT from generic KFile to Eeprom.
85  */
86 INLINE Eeprom * EEPROM_CAST(KFile *fd)
87 {
88         ASSERT(fd->_type == KFT_EEPROM);
89         return (Eeprom *)fd;
90 }
91
92 /// Type for EEPROM addresses
93 typedef uint16_t e2addr_t;
94
95 /**
96  * Macro for E2Layout offset calculation
97  *
98  * \note We can't just use offsetof() here because we could use
99  *       non-constant expressions to access array elements.
100  *
101  * \note 'type' is the structure type holding eeprom layout
102  *       and must be defined in user files.
103  */
104 #define e2addr(type, field) ((e2addr_t)&(((type *)0)->field))
105
106 /**
107  * Type for EEPROM block size.
108  */
109 typedef uint16_t e2blk_size_t;
110
111 /**
112  * Type for accessing EEPROM whole size.
113  */
114 typedef uint32_t e2_size_t;
115
116 /**
117  * Descrive all EEPROM informations
118  * needed by the driver.
119  */
120 typedef struct EepromInfo
121 {
122         bool has_dev_addr;     ///< true if memory is device addressable (its A0, A1, A2 pin are used by memory).
123         e2blk_size_t blk_size; ///< block size
124         e2_size_t e2_size;     ///< eeprom size
125 } EepromInfo;
126
127 bool eeprom_erase(Eeprom *fd, e2addr_t addr, e2_size_t count);
128 bool eeprom_verify(Eeprom *fd, const void *buf, size_t count);
129 void eeprom_init(Eeprom *fd, EepromType, e2dev_addr_t, bool verify);
130
131 #endif /* DRV_EEPROM_H */