From efbaf777249a0846630bfab63f0e182b1a33ba56 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Tue, 16 Feb 2016 22:29:02 +0100
Subject: Storage and a bit of System.receive documentation

---
 src/storage.h | 42 ++++++++++++++++++++++++++++++++++++++++--
 src/system.cc |  7 +++++++
 2 files changed, 47 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/storage.h b/src/storage.h
index 4336d34..656d13e 100644
--- a/src/storage.h
+++ b/src/storage.h
@@ -16,12 +16,50 @@ class Storage {
 		// TODO "file system" housekeeping (index of first free page)
 	public:
 		Storage() { num_anims = 0xff; first_free_page = 0;};
+
+		/**
+		 * Enable the storage hardware: Configures the internal I2C
+		 * module and reads the number of stored animations from the
+		 * EEPROM.
+		 */
 		void enable();
+
+		/**
+		 * Prepares the storage for a complete overwrite by setting the
+		 * number of stored animations to zero. The next save operation
+		 * will get pattern id 0 and overwrite the first stored pattern.
+		 *
+		 * This function itself does not write anything to the EEPROM.
+		 */
 		void reset();
+
+		/**
+		 * Load pattern from EEPROM.
+		 *
+		 * @param idx pattern index
+		 * @param data pointer to data structure for the pattern. Must be
+		 *        at least 256 Bytes
+		 */
 		void load(uint16_t idx, uint8_t *data);
-		void save(uint16_t idx, uint8_t *data);
+
+		/**
+		 * Save (possibly partial) pattern on the EEPROM. 64 bytes of
+		 * dattern data will be read and stored, regardless of the
+		 * pattern header.
+		 *
+		 * @param idx pattern index (subjec to change!)
+		 * @param data pattern data. Must be at least 64 Bytes
+		 */
+		void save(uint16_t idx, uint8_t *data); // TODO probably better without idx
+
+		/**
+		 * Continue saving a pattern on the EEPROM. Appends 64 bytes of
+		 * pattern data after the most recently written block of data
+		 * (i.e., to the pattern which is currently being saved).
+		 *
+		 * @param data pattern data. Must be at least 64 Bytes
+		 */
 		void append(uint8_t *data);
-		// TODO load / save methods for animations
 };
 
 extern Storage storage;
diff --git a/src/system.cc b/src/system.cc
index bee1791..5e705a6 100644
--- a/src/system.cc
+++ b/src/system.cc
@@ -42,6 +42,13 @@ void System::receive(void)
 	static uint16_t remaining_bytes = 0;
 	uint8_t rx_byte = modem.buffer_get();
 
+	/*
+	 * START* and PATTERN* are sync signals, everything else needs to be
+	 * stored on the EEPROM.
+	 * (Note that the C++ standard guarantees "rxExpect > PATTERN2" to match
+	 * for HEADER*, META* and DATA since they are located after PATTERN2
+	 * in the RxExpect enum declaration)
+	 */
 	if (rxExpect > PATTERN2) {
 		rx_buf[rx_pos] = modem.buffer_get();
 	}
-- 
cgit v1.2.3