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