Add definitions for 24C32, 24C64 and 24C128 eeproms. Use the right eeprom type.

[bertos.git] / bertos / drv / eeprom.h

diff --git a/bertos/drv/eeprom.h b/bertos/drv/eeprom.h
index 9c58d58c9d9c6fc0491258b4b2ea6fd963365f18..accbba6f83eb88365f4b5446b2e8ab1b7e512b8e 100644 (file)
--- a/bertos/drv/eeprom.h
+++ b/bertos/drv/eeprom.h
@@ -30,39 +30,101 @@
  * All Rights Reserved.
  * -->
  *
- * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (interface)
- *
- * \version $Id$
+ * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS.
  *
  * \author Stefano Fedrigo <aleph@develer.com>
  * \author Bernie Innocenti <bernie@codewiz.org>
  *
+ * $WIZ$ module_name = "eeprom"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_eeprom.h"
+ * $WIZ$ module_depends = "kfile", "kfile_block", "kblock", "i2c"
  */
 
 #ifndef DRV_EEPROM_H
 #define DRV_EEPROM_H
 
 #include "cfg/cfg_eeprom.h"
+
 #include <cfg/compiler.h>
+#include <cfg/debug.h>
 
-/**
- * \name Values for CONFIG_EEPROM_TYPE
- * \{
- */
-#define EEPROM_24XX16 1
-#define EEPROM_24XX256 2
-/*\}*/
-
-#if CONFIG_EEPROM_TYPE == EEPROM_24XX16
-       #define EEPROM_BLKSIZE   0x10 ///< Eeprom block size (16byte)
-       #define EEPROM_SIZE     0x800 ///< Eeprom total size (2kB)
-#elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
-       #define EEPROM_BLKSIZE   0x40 ///< Eeprom block size (64byte)
-       #define EEPROM_SIZE    0x8000 ///< Eeprom total size (32kB)
+#include <drv/i2c.h>
+
+#include <io/kblock.h>
+#include <io/kfile.h>
+#include <io/kfile_block.h>
+
+#include <cpu/attr.h>
+
+#if COMPILER_C99
+       #define eeprom_init(...)          PP_CAT(eeprom_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
+       #define eeprom_verify(...)        PP_CAT(eeprom_verify ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
 #else
-       #error Unsupported EEPROM type.
+       #define eeprom_init(args...)      PP_CAT(eeprom_init ## _, COUNT_PARMS(args)) (args)
+       #define eeprom_verify(args...)    PP_CAT(eeprom_verify ## _, COUNT_PARMS(args)) (args)
 #endif
 
+
+/**
+ * Values for Eeprom types.
+ */
+typedef enum EepromType
+{
+       EEPROM_24XX08,
+       EEPROM_24XX16,
+       EEPROM_24XX32,
+       EEPROM_24XX64,
+       EEPROM_24XX128,
+       EEPROM_24XX256,
+       EEPROM_24XX512,
+       EEPROM_24XX1024,
+       EEPROM_CNT,
+} EepromType;
+
+/**
+ * On the same I2C bus can live more than one EEPROM
+ * device. Each device can be addressed by one or more
+ * pins.
+ */
+typedef uint8_t e2dev_addr_t;
+
+/**
+ * Describe an EEPROM context, used by the driver to
+ * access the single device.
+ */
+typedef struct Eeprom
+{
+       KBlock blk;
+       I2c *i2c;
+       EepromType type;   ///< EEPROM type
+       e2dev_addr_t addr; ///< Device address.
+       bool verify;
+#if !CONFIG_EEPROM_DISABLE_OLD_API
+       union {
+               KFile fd;
+               KFileBlock fdblk;
+       } DEPRECATED;
+#endif /* !CONFIG_EEPROM_DISABLE_OLD_API */
+} Eeprom;
+
+#if !CONFIG_EEPROM_DISABLE_OLD_API
+       STATIC_ASSERT(offsetof(Eeprom, fd) == offsetof(Eeprom, fdblk.fd));
+#endif /* !CONFIG_EEPROM_DISABLE_OLD_API */
+
+/**
+ * ID for eeproms.
+ */
+#define KBT_EEPROM MAKE_ID('E', 'E', 'P', 'R')
+
+/**
+ * Convert + ASSERT from generic KFile to Eeprom.
+ */
+INLINE Eeprom * EEPROM_CAST_KBLOCK(KBlock *blk)
+{
+       ASSERT(blk->priv.type == KBT_EEPROM);
+       return (Eeprom *)blk;
+}
+
 /// Type for EEPROM addresses
 typedef uint16_t e2addr_t;
 
@@ -77,13 +139,42 @@ typedef uint16_t e2addr_t;
  */
 #define e2addr(type, field) ((e2addr_t)&(((type *)0)->field))
 
+/**
+ * Type for EEPROM block size.
+ */
+typedef uint16_t e2blk_size_t;
+
+/**
+ * Type for accessing EEPROM whole size.
+ */
+typedef uint32_t e2_size_t;
+
+/**
+ * Descrive all EEPROM informations
+ * needed by the driver.
+ */
+typedef struct EepromInfo
+{
+       bool has_dev_addr;     ///< true if memory is device addressable (its A0, A1, A2 pin are used by memory).
+       e2blk_size_t blk_size; ///< block size
+       e2_size_t e2_size;     ///< eeprom size
+} EepromInfo;
+
+bool eeprom_erase(Eeprom *eep, e2addr_t addr, e2_size_t count);
+bool eeprom_verify_4(Eeprom *eep, e2addr_t addr, const void *buf, size_t count);
+void eeprom_init_5(Eeprom *eep, I2c *i2c, EepromType type, e2dev_addr_t addr, bool verify);
+
+#if !CONFIG_EEPROM_DISABLE_OLD_API
 
-bool eeprom_write(e2addr_t addr, const void *buf, size_t count);
-bool eeprom_read(e2addr_t addr, void *buf, size_t count);
-bool eeprom_write_char(e2addr_t addr, char c);
-int eeprom_read_char(e2addr_t addr);
-void eeprom_erase(e2addr_t addr, size_t count);
-void eeprom_init(void);
-void eeprom_test(void);
+DEPRECATED INLINE bool eeprom_verify_3(Eeprom *eep, const void *buf, size_t count)
+{
+       return eeprom_verify_4(eep, (e2addr_t)eep->fdblk.fd.seek_pos, buf, count);
+}
+DEPRECATED INLINE void eeprom_init_4(Eeprom *eep, EepromType type, e2dev_addr_t addr, bool verify)
+{
+       eeprom_init_5(eep, &local_i2c_old_api, type, addr, verify);
+       kfileblock_init(&eep->fdblk, &eep->blk);
+}
+#endif /* !CONFIG_EEPROM_DISABLE_OLD_API */
 
 #endif /* DRV_EEPROM_H */