?lang_form?
?lang_select?
?lang_submit?
?lang_endform?
{HEADER END}
{FILE START}
library
?curdirlinks? - Rev 6
?prevdifflink? - Blame - ?getfile?
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Procyon AVRlib: EEPROM Parameter Storage Library (param.c)</title>
<link href="dox.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<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>
<h1>EEPROM Parameter Storage Library (param.c)<br>
<small>
[<a class="el" href="group__driver__avr.html">Drivers (for AVR peripherals)</a>]</small>
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "<a class="code" href="param_8h.html">param.h</a>"</span>
</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>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<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>
<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>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ga1" doxytag="param.h::paramLoad"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">u08 paramLoad </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">u08 * </td>
<td class="mdname" nowrap> <em>parameters</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u08 * </td>
<td class="mdname" nowrap> <em>memaddr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u16 </td>
<td class="mdname" nowrap> <em>sizebytes</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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>
<table border="0" cellspacing="2" cellpadding="0">
<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>
<tr><td valign="top"></td><td valign="top"><em>memaddr</em> </td><td>pointer to EEPROM memory address parameters are stored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sizebytes</em> </td><td>size of parameter block in bytes </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>TRUE if load successful and checksum matched, FALSE otherwise </dd></dl>
<p>
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>
</tr>
</table>
<a class="anchor" name="ga0" doxytag="param.h::paramStore"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void paramStore </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">u08 * </td>
<td class="mdname" nowrap> <em>parameters</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u08 * </td>
<td class="mdname" nowrap> <em>memaddr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u16 </td>
<td class="mdname" nowrap> <em>sizebytes</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parameters</em> </td><td>pointer to SRAM location where parameters are stored </td></tr>
<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>
<tr><td valign="top"></td><td valign="top"><em>sizebytes</em> </td><td>size of parameter block in bytes </td></tr>
</table>
</dl>
<p>
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>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:09 2006 for Procyon AVRlib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
{FILE END}
{FOOTER START}
Powered by WebSVN v2.8.3