| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: EEPROM Parameter Storage Library (param.c)</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <h1>EEPROM Parameter Storage Library (param.c)<br> |
||
| 9 | <small> |
||
| 10 | [<a class="el" href="group__driver__avr.html">Drivers (for AVR peripherals)</a>]</small> |
||
| 11 | </h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 12 | <div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "<a class="code" href="param_8h.html">param.h</a>"</span> |
||
| 13 | </pre></div> <dl compact><dt><b>Description</b></dt><dd>The "Param" library provide two simple functions for loading and storing blocks of parameters out of and into internal EEPROM. </dd></dl> |
||
| 14 | |||
| 15 | <p> |
||
| 16 | <table border="0" cellpadding="0" cellspacing="0"> |
||
| 17 | <tr><td></td></tr> |
||
| 18 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 19 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__param.html#ga0">paramStore</a> (u08 *parameters, u08 *memaddr, u16 sizebytes)</td></tr> |
||
| 20 | |||
| 21 | <tr><td class="memItemLeft" nowrap align="right" valign="top">u08 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__param.html#ga1">paramLoad</a> (u08 *parameters, u08 *memaddr, u16 sizebytes)</td></tr> |
||
| 22 | |||
| 23 | </table> |
||
| 24 | <hr><h2>Function Documentation</h2> |
||
| 25 | <a class="anchor" name="ga1" doxytag="param.h::paramLoad"></a><p> |
||
| 26 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
| 27 | <tr> |
||
| 28 | <td class="mdRow"> |
||
| 29 | <table cellpadding="0" cellspacing="0" border="0"> |
||
| 30 | <tr> |
||
| 31 | <td class="md" nowrap valign="top">u08 paramLoad </td> |
||
| 32 | <td class="md" valign="top">( </td> |
||
| 33 | <td class="md" nowrap valign="top">u08 * </td> |
||
| 34 | <td class="mdname" nowrap> <em>parameters</em>, </td> |
||
| 35 | </tr> |
||
| 36 | <tr> |
||
| 37 | <td class="md" nowrap align="right"></td> |
||
| 38 | <td class="md"></td> |
||
| 39 | <td class="md" nowrap>u08 * </td> |
||
| 40 | <td class="mdname" nowrap> <em>memaddr</em>, </td> |
||
| 41 | </tr> |
||
| 42 | <tr> |
||
| 43 | <td class="md" nowrap align="right"></td> |
||
| 44 | <td class="md"></td> |
||
| 45 | <td class="md" nowrap>u16 </td> |
||
| 46 | <td class="mdname" nowrap> <em>sizebytes</em></td> |
||
| 47 | </tr> |
||
| 48 | <tr> |
||
| 49 | <td class="md"></td> |
||
| 50 | <td class="md">) </td> |
||
| 51 | <td class="md" colspan="2"></td> |
||
| 52 | </tr> |
||
| 53 | </table> |
||
| 54 | </td> |
||
| 55 | </tr> |
||
| 56 | </table> |
||
| 57 | <table cellspacing="5" cellpadding="0" border="0"> |
||
| 58 | <tr> |
||
| 59 | <td> |
||
| 60 | |
||
| 61 | </td> |
||
| 62 | <td> |
||
| 63 | |||
| 64 | <p> |
||
| 65 | paramLoad loads a block of data/parameters into RAM from EEPROM, and performs an 8-bit checksum to validate it. <dl compact><dt><b>Parameters:</b></dt><dd> |
||
| 66 | <table border="0" cellspacing="2" cellpadding="0"> |
||
| 67 | <tr><td valign="top"></td><td valign="top"><em>parameters</em> </td><td>pointer to SRAM location into which parameters should be loaded </td></tr> |
||
| 68 | <tr><td valign="top"></td><td valign="top"><em>memaddr</em> </td><td>pointer to EEPROM memory address parameters are stored </td></tr> |
||
| 69 | <tr><td valign="top"></td><td valign="top"><em>sizebytes</em> </td><td>size of parameter block in bytes </td></tr> |
||
| 70 | </table> |
||
| 71 | </dl> |
||
| 72 | <dl compact><dt><b>Returns:</b></dt><dd>TRUE if load successful and checksum matched, FALSE otherwise </dd></dl> |
||
| 73 | |||
| 74 | <p> |
||
| 75 | Definition at line <a class="el" href="param_8c-source.html#l00019">19</a> of file <a class="el" href="param_8c-source.html">param.c</a>. </td> |
||
| 76 | </tr> |
||
| 77 | </table> |
||
| 78 | <a class="anchor" name="ga0" doxytag="param.h::paramStore"></a><p> |
||
| 79 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
||
| 80 | <tr> |
||
| 81 | <td class="mdRow"> |
||
| 82 | <table cellpadding="0" cellspacing="0" border="0"> |
||
| 83 | <tr> |
||
| 84 | <td class="md" nowrap valign="top">void paramStore </td> |
||
| 85 | <td class="md" valign="top">( </td> |
||
| 86 | <td class="md" nowrap valign="top">u08 * </td> |
||
| 87 | <td class="mdname" nowrap> <em>parameters</em>, </td> |
||
| 88 | </tr> |
||
| 89 | <tr> |
||
| 90 | <td class="md" nowrap align="right"></td> |
||
| 91 | <td class="md"></td> |
||
| 92 | <td class="md" nowrap>u08 * </td> |
||
| 93 | <td class="mdname" nowrap> <em>memaddr</em>, </td> |
||
| 94 | </tr> |
||
| 95 | <tr> |
||
| 96 | <td class="md" nowrap align="right"></td> |
||
| 97 | <td class="md"></td> |
||
| 98 | <td class="md" nowrap>u16 </td> |
||
| 99 | <td class="mdname" nowrap> <em>sizebytes</em></td> |
||
| 100 | </tr> |
||
| 101 | <tr> |
||
| 102 | <td class="md"></td> |
||
| 103 | <td class="md">) </td> |
||
| 104 | <td class="md" colspan="2"></td> |
||
| 105 | </tr> |
||
| 106 | </table> |
||
| 107 | </td> |
||
| 108 | </tr> |
||
| 109 | </table> |
||
| 110 | <table cellspacing="5" cellpadding="0" border="0"> |
||
| 111 | <tr> |
||
| 112 | <td> |
||
| 113 | |
||
| 114 | </td> |
||
| 115 | <td> |
||
| 116 | |||
| 117 | <p> |
||
| 118 | paramStore saves a block of data/parameters into EEPROM from RAM, and performs an 8-bit checksum, stored in EEPROM immediately after the data block. <dl compact><dt><b>Parameters:</b></dt><dd> |
||
| 119 | <table border="0" cellspacing="2" cellpadding="0"> |
||
| 120 | <tr><td valign="top"></td><td valign="top"><em>parameters</em> </td><td>pointer to SRAM location where parameters are stored </td></tr> |
||
| 121 | <tr><td valign="top"></td><td valign="top"><em>memaddr</em> </td><td>pointer to EEPROM memory address where parameters should be written </td></tr> |
||
| 122 | <tr><td valign="top"></td><td valign="top"><em>sizebytes</em> </td><td>size of parameter block in bytes </td></tr> |
||
| 123 | </table> |
||
| 124 | </dl> |
||
| 125 | |||
| 126 | <p> |
||
| 127 | Definition at line <a class="el" href="param_8c-source.html#l00041">41</a> of file <a class="el" href="param_8c-source.html">param.c</a>. </td> |
||
| 128 | </tr> |
||
| 129 | </table> |
||
| 130 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:09 2006 for Procyon AVRlib by |
||
| 131 | <a href="http://www.doxygen.org/index.html"> |
||
| 132 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 133 | </body> |
||
| 134 | </html> |
Powered by WebSVN v2.8.3