Diff: eprom.h

Revision:

0:d6269d17c8cf

Child:

2:c6986ee3c7c5

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eprom.h	Thu Feb 04 21:48:54 2016 +0000
@@ -0,0 +1,56 @@
+/** University of York Robotics Laboratory PsiSwarm Library: Eprom Functions Header File
+ * 
+ * File: eprom.h
+ *
+ * (C) Dept. Electronics & Computer Science, University of York
+ * James Hilder, Alan Millard, Alexander Horsfield, Homero Elizondo, Jon Timmis
+ *
+ * PsiSwarm Library Version: 0.4
+ *
+ * February 2016
+ *
+ * Functions for accessing the 64Kb EPROM chip and reading the reserved firmware block
+ *
+ * Example:
+ * @code
+ * #include "psiswarm.h"
+ * 
+ * int main() {
+ *     init();
+ *     write_eeprom_byte(0,0xDD);    //Writes byte 0xDD in EPROM address 0
+ *     char c = read_eeprom_byte(0); //c will hold 0xDD
+ *     //Valid address range is from 0 to 65279
+ * }
+ * @endcode
+ */
+       
+#ifndef EPROM_H
+#define EPROM_H
+
+/** Write a single byte to the EPROM
+ *
+ * @param address The address to store the data, range 0-65279
+ * @param data The character to store
+ */
+void write_eeprom_byte ( int address, char data );
+
+/** Read a single byte from the EPROM
+ *
+ * @param address The address to read from, range 0-65279
+ * @return The character stored at address
+ */
+char read_eeprom_byte ( int address );
+
+/** Read the next byte from the EPROM, to be called after read_eeprom_byte
+ *
+ * @return The character stored at address after the previous one read from
+ */
+char read_next_eeprom_byte ( void );
+
+/** Read the data stored in the reserved firmware area of the EPROM
+ *
+ * @return 1 if a valid firmware is read, 0 otherwise
+ */
+char read_firmware ( void );
+
+#endif  
\ No newline at end of file