Diff: Memory/InternalEEPROM.h

Revision:

34:fc366bab393f

Parent:

20:9df19da50290

diff -r 8a0a99d54bf8 -r fc366bab393f Memory/InternalEEPROM.h
--- a/Memory/InternalEEPROM.h	Thu Feb 19 14:41:14 2015 +0100
+++ b/Memory/InternalEEPROM.h	Mon Mar 09 11:15:56 2015 +0100
@@ -42,9 +42,36 @@
      */
     void init();
     
+    /** Put the internal EEPROM in a low power state
+     */
     void powerDown();
     
+    /** Reads size bytes from offset addr
+     *
+     *  Note that this function will power up the EEPROM so it is
+     *  recommended to call powerDown() when finished reading.
+     *
+     *  @param addr  the offset to read from
+     *  @param data  buffer to store the read data in
+     *  @param size  number of bytes to read
+     *
+     *  @returns
+     *       The number of bytes read
+     */
     int read(uint32_t addr, uint8_t* data, uint32_t size);
+
+    /** Writes size bytes to offset addr
+     *
+     *  Note that this function will power up the EEPROM so it is
+     *  recommended to call powerDown() when finished writing.
+     *
+     *  @param addr  the offset to write to
+     *  @param data  the data to write
+     *  @param size  number of bytes to write
+     *
+     *  @returns
+     *       The number of bytes written
+     */
     int write(uint32_t addr, const uint8_t* data, uint32_t size);
   
     /** Returns the size (in bytes) of the internal EEPROM
@@ -54,20 +81,6 @@
      */
     uint32_t memorySize() { return EEPROM_MEMORY_SIZE; }
   
-    /** Returns the size of a page (in bytes) of the internal EEPROM
-     *
-     *  @returns
-     *       The page size in bytes
-     */
-    //uint32_t pageSize() { return EEPROM_PAGE_SIZE; }
-  
-    /** Returns the number of pages in the internal EEPROM
-     *
-     *  @returns
-     *       The number of pages
-     */
-    //uint32_t numPages() { return EEPROM_NUM_PAGES; }
-  
 private:
 
     bool _initialized;