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