summaryrefslogtreecommitdiffhomepage
path: root/digital/io/src/eeprom.h
diff options
context:
space:
mode:
authorJérémy Dufour2008-03-19 11:34:01 +0100
committerJérémy Dufour2008-03-19 11:34:01 +0100
commit193dd6732798199a4a94749188a56635fda6dd90 (patch)
tree5475506a41cf72460a2e7d6326d7a48bedcc412f /digital/io/src/eeprom.h
parent624f2f2aade9f87ff22f56e0b5a9999cdd1db458 (diff)
* digital/io/src
- add trap module (not integrated in the io program); - add eeprom module to support load/store parameters (for the trap module); - partial integration of eeprom in the io program.
Diffstat (limited to 'digital/io/src/eeprom.h')
-rw-r--r--digital/io/src/eeprom.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/digital/io/src/eeprom.h b/digital/io/src/eeprom.h
new file mode 100644
index 00000000..1bd7d213
--- /dev/null
+++ b/digital/io/src/eeprom.h
@@ -0,0 +1,56 @@
+#ifndef eeprom_h
+#define eeprom_h
+/* eeprom.h */
+/* io - Input & Output with Artificial Intelligence (ai) support on AVR. {{{
+ *
+ * Copyright (C) 2008 Dufour Jrmy
+ *
+ * APBTeam:
+ * Web: http://apbteam.org/
+ * Email: team AT apbteam DOT org
+ *
+ * This program 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * }}} */
+
+/**
+ * @file Store and load configuration parameters from the EEPROM of the AVR.
+ * This module is able to store some parameters for the io program and its
+ * sub-modules, to load them.
+ * To prevent problem when you change the format of your the parameters (or
+ * add/remove some), it uses a key to store the version of the parameters
+ * organization. So when you change something, update the key.
+ */
+
+/**
+ * Load parameters from the EEPROM.
+ * Check if the key is correct.
+ */
+void
+eeprom_load_param ();
+
+/**
+ * Store parameters in the EEPROM.
+ */
+void
+eeprom_save_param ();
+
+/**
+ * Clear parameters in the EEPROM by invalidating the key.
+ */
+void
+eeprom_clear_param ();
+
+#endif /* eeprom_h */