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