Doc fixes.

[bertos.git] / drv / eeprom.c

diff --git a/drv/eeprom.c b/drv/eeprom.c
old mode 100755 (executable)
new mode 100644 (file)
index 8280ef2..4e7f615
--- a/drv/eeprom.c
+++ b/drv/eeprom.c
@@ -1,8 +1,33 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation)
@@ -14,33 +39,13 @@
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.18  2005/11/27 23:33:40  bernie
- *#* Use appconfig.h instead of cfg/config.h.
- *#*
- *#* Revision 1.17  2005/04/11 19:10:27  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.16  2005/03/01 23:25:09  bernie
- *#* Prune CVS log.
- *#*
- *#* Revision 1.11  2004/10/26 08:35:31  bernie
- *#* Reset watchdog for long operations.
- *#*
- *#* Revision 1.10  2004/09/20 03:31:22  bernie
- *#* Sanitize for C++.
- *#*
- *#* Revision 1.9  2004/09/14 21:03:46  bernie
- *#* Use debug.h instead of kdebug.h.
- *#*/
-
 #include "eeprom.h"
 
 #include <cfg/debug.h>
 #include <appconfig.h>  // CONFIG_EEPROM_VERIFY
 #include <cfg/macros.h>  // MIN()
-#include <drv/twi.h>
+#include <cpu/attr.h>
+#include CPU_HEADER(twi)
 #include <drv/wdt.h>
 #include <mware/byteorder.h> // cpu_to_be16()
 
@@ -52,8 +57,20 @@
        #error CONFIG_EEPROM_VERIFY must be defined to either 0 or 1
 #endif
 
+/**
+ * EEPROM ID code
+ */
+#define EEPROM_ID  0xA0
+
+/**
+ * This macros form the correct slave address for EEPROMs
+ */
+#define EEPROM_ADDR(x) (EEPROM_ID | (((uint8_t)(x)) << 1))
+
+
+
 
-/*!
+/**
  * Copy \c count bytes from buffer \c buf to
  * eeprom at address \c addr.
  */
@@ -80,7 +97,7 @@ static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count)
                uint8_t blk_offs = (uint8_t)addr;
 
                result =
-                       twi_start_w(blk_addr)
+                       twi_start_w(EEPROM_ADDR(blk_addr))
                        && twi_send(&blk_offs, sizeof blk_offs)
                        && twi_send(buf, size);
 
@@ -90,7 +107,7 @@ static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count)
                uint16_t addr_be = cpu_to_be16(addr);
 
                result =
-                       twi_start_w(0)
+                       twi_start_w(EEPROM_ID)
                        && twi_send((uint8_t *)&addr_be, sizeof addr_be)
                        && twi_send(buf, size);
 
@@ -119,7 +136,7 @@ static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count)
 
 
 #if CONFIG_EEPROM_VERIFY
-/*!
+/**
  * Check that the contents of an EEPROM range
  * match with a provided data buffer.
  *
@@ -179,7 +196,7 @@ bool eeprom_write(e2addr_t addr, const void *buf, size_t count)
 }
 
 
-/*!
+/**
  * Copy \c count bytes at address \c addr
  * from eeprom to RAM to buffer \c buf.
  *
@@ -198,9 +215,9 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count)
        uint8_t blk_offs = (uint8_t)addr;
 
        bool res =
-               twi_start_w(blk_addr)
+               twi_start_w(EEPROM_ADDR(blk_addr))
                && twi_send(&blk_offs, sizeof blk_offs)
-               && twi_start_r(blk_addr)
+               && twi_start_r(EEPROM_ADDR(blk_addr))
                && twi_recv(buf, count);
 
 #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256
@@ -209,9 +226,9 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count)
        addr = cpu_to_be16(addr);
 
        bool res =
-               twi_start_w(0)
+               twi_start_w(EEPROM_ID)
                && twi_send((uint8_t *)&addr, sizeof(addr))
-               && twi_start_r(0)
+               && twi_start_r(EEPROM_ID)
                && twi_recv(buf, count);
 #else
        #error Unknown device type
@@ -225,7 +242,7 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count)
 }
 
 
-/*!
+/**
  * Write a single character \a c at address \a addr.
  */
 bool eeprom_write_char(e2addr_t addr, char c)
@@ -234,7 +251,7 @@ bool eeprom_write_char(e2addr_t addr, char c)
 }
 
 
-/*!
+/**
  * Read a single character at address \a addr.
  *
  * \return the requested character or -1 in case of failure.
@@ -250,7 +267,7 @@ int eeprom_read_char(e2addr_t addr)
 }
 
 
-/*!
+/**
  * Erase specified part of eeprom, writing 0xFF.
  *
  * \param addr   starting address
@@ -275,7 +292,7 @@ void eeprom_erase(e2addr_t addr, size_t count)
 }
 
 
-/*!
+/**
  * Initialize TWI module.
  */
 void eeprom_init(void)