Line No. | Rev | Author | Line |
---|---|---|---|
1 | 6 | kaklik | /*! \file param.h \brief EEPROM Parameter Storage Library. */ |
2 | //***************************************************************************** |
||
3 | // |
||
4 | // File Name : 'param.h' |
||
5 | // Title : EEPROM Parameter Storage Library |
||
6 | // Author : Pascal Stang (c)2005 |
||
7 | // Created : 9/16/2005 |
||
8 | // Revised : 9/20/2005 |
||
9 | // Version : 0.1 |
||
10 | // Target MCU : Atmel AVR series |
||
11 | // Editor Tabs : 4 |
||
12 | // |
||
13 | /// \ingroup driver_avr |
||
14 | /// \defgroup param EEPROM Parameter Storage Library (param.c) |
||
15 | /// \code #include "param.h" \endcode |
||
16 | /// \par Description |
||
17 | /// The "Param" library provide two simple functions for loading and |
||
18 | /// storing blocks of parameters out of and into internal EEPROM. |
||
19 | // |
||
20 | // This code is distributed under the GNU Public License |
||
21 | // which can be found at http://www.gnu.org/licenses/gpl.txt |
||
22 | //***************************************************************************** |
||
23 | //@{ |
||
24 | |||
25 | #ifndef PARAM_H |
||
26 | #define PARAM_H |
||
27 | |||
28 | |||
29 | /*! paramStore saves a block of data/parameters into EEPROM from RAM, |
||
30 | and performs an 8-bit checksum, stored in EEPROM immediately after the data block. |
||
31 | \param parameters pointer to SRAM location where parameters are stored |
||
32 | \param memaddr pointer to EEPROM memory address where parameters should be written |
||
33 | \param sizebytes size of parameter block in bytes */ |
||
34 | void paramStore(u08* parameters, u08* memaddr, u16 sizebytes); |
||
35 | |||
36 | /*! paramLoad loads a block of data/parameters into RAM from EEPROM, |
||
37 | and performs an 8-bit checksum to validate it. |
||
38 | \param parameters pointer to SRAM location into which parameters should be loaded |
||
39 | \param memaddr pointer to EEPROM memory address parameters are stored |
||
40 | \param sizebytes size of parameter block in bytes |
||
41 | \return TRUE if load successful and checksum matched, FALSE otherwise */ |
||
42 | u08 paramLoad(u08* parameters, u08* memaddr, u16 sizebytes); |
||
43 | |||
44 | #endif |
||
45 | //@} |
Powered by WebSVN v2.8.3