Fix reference to README.devlib in header.
[bertos.git] / drv / eeprom.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5  * This file is part of DevLib - See README.devlib for information.
6  * -->
7  *
8  * \version $Id$
9  *
10  * \author Stefano Fedrigo <aleph@develer.com>
11  * \author Bernardo Innocenti <bernie@develer.com>
12  *
13  * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (interface)
14  */
15
16 /*#*
17  *#* $Log$
18  *#* Revision 1.7  2005/11/04 16:20:02  bernie
19  *#* Fix reference to README.devlib in header.
20  *#*
21  *#* Revision 1.6  2005/04/11 19:10:27  bernie
22  *#* Include top-level headers from cfg/ subdir.
23  *#*
24  *#* Revision 1.5  2004/11/02 17:50:02  bernie
25  *#* CONFIG_EEPROM_VERIFY: New config option.
26  *#*
27  *#* Revision 1.4  2004/08/25 14:12:08  rasky
28  *#* Aggiornato il comment block dei log RCS
29  *#*
30  *#* Revision 1.3  2004/08/10 06:57:22  bernie
31  *#* eeprom_erase(): New function.
32  *#*
33  *#* Revision 1.2  2004/07/29 22:57:09  bernie
34  *#* Add 24LC16 support.
35  *#*
36  *#* Revision 1.1  2004/07/20 17:11:18  bernie
37  *#* Import into DevLib.
38  *#*
39  *#*/
40 #ifndef DRV_EEPROM_H
41 #define DRV_EEPROM_H
42
43 #include <cfg/compiler.h>
44 #include <cfg/config.h>
45
46 /*!
47  * \name Values for CONFIG_EEPROM_TYPE
48  * \{
49  */
50 #define EEPROM_24XX16 1
51 #define EEPROM_24XX256 2
52 /*\}*/
53
54 #if CONFIG_EEPROM_TYPE == EEPROM_24XX16
55         #define EEPROM_BLKSIZE   0x10 //!< Eeprom block size (16byte)
56         #define EEPROM_SIZE     0x800 //!< Eeprom total size (2kB)
57 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
58         #define EEPROM_BLKSIZE   0x40 //!< Eeprom block size (64byte)
59         #define EEPROM_SIZE    0x8000 //!< Eeprom total size (32kB)
60 #else
61         #error Unsupported EEPROM type.
62 #endif
63
64 //! Type for EEPROM addresses
65 typedef uint16_t e2addr_t;
66
67 bool eeprom_write(e2addr_t addr, const void *buf, size_t count);
68 bool eeprom_read(e2addr_t addr, void *buf, size_t count);
69 bool eeprom_write_char(e2addr_t addr, char c);
70 int eeprom_read_char(e2addr_t addr);
71 void eeprom_erase(e2addr_t addr, size_t count);
72 void eeprom_init(void);
73 void eeprom_test(void);
74
75 #endif /* DRV_EEPROM_H */