root / trunk / docs / libdragonfly / eeprom_8h.html @ 1371
History | View | Annotate | Download (7.88 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libdragonfly: eeprom.h File Reference</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.5 -->
|
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul>
|
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
| 13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 15 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 16 |
</ul>
|
| 17 |
</div>
|
| 18 |
</div>
|
| 19 |
<div class="contents"> |
| 20 |
<h1>eeprom.h File Reference</h1>handles eeprom storage for persistent data <a href="#_details">More...</a> |
| 21 |
<p>
|
| 22 |
<code>#include <<a class="el" href="bom_8h-source.html">bom.h</a>></code><br> |
| 23 |
|
| 24 |
<p>
|
| 25 |
<a href="eeprom_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 26 |
<tr><td></td></tr> |
| 27 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44e05e0de5d78546c63718c7d8773a9a"></a><!-- doxytag: member="eeprom.h::EEPROM_ROBOT_ID_ADDR" ref="44e05e0de5d78546c63718c7d8773a9a" args="" --> |
| 29 |
#define </td><td class="memItemRight" valign="bottom"><b>EEPROM_ROBOT_ID_ADDR</b> 0x10</td></tr> |
| 30 |
|
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea8a316eb9414e62e8b2c1434ab57661"></a><!-- doxytag: member="eeprom.h::EEPROM_BOM_TYPE_ADDR" ref="ea8a316eb9414e62e8b2c1434ab57661" args="" --> |
| 32 |
#define </td><td class="memItemRight" valign="bottom"><b>EEPROM_BOM_TYPE_ADDR</b> 0x14</td></tr> |
| 33 |
|
| 34 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="eeprom_8h.html#4f56f25703c0e313fae3d0d327109082">eeprom_put_byte</a> (unsigned int addr, unsigned char byte)</td></tr> |
| 36 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">store a byte to eeproem <a href="#4f56f25703c0e313fae3d0d327109082"></a><br></td></tr> |
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="eeprom_8h.html#1235e4e69e3f0114160e69705f38bda1">eeprom_get_byte</a> (unsigned int addr, unsigned char *byte)</td></tr> |
| 39 |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">reads a byte from eeprom <a href="#1235e4e69e3f0114160e69705f38bda1"></a><br></td></tr> |
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="eeprom_8h.html#bfc8e084d177435cbe1cc30cfedf4327">get_robotid</a> (void)</td></tr> |
| 42 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">get stored robot ID <a href="#bfc8e084d177435cbe1cc30cfedf4327"></a><br></td></tr> |
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="eeprom_8h.html#de3f83da05149edf008cb5fa23fde7df">get_bom_type</a> (void)</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">get stored robot ID <a href="#de3f83da05149edf008cb5fa23fde7df"></a><br></td></tr> |
| 47 |
</table>
|
| 48 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 49 |
handles eeprom storage for persistent data |
| 50 |
<p>
|
| 51 |
Contains functions and definitions for reading and writing to eeprom<p>
|
| 52 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, Brad Neuman </dd></dl> |
| 53 |
<hr><h2>Function Documentation</h2> |
| 54 |
<a class="anchor" name="1235e4e69e3f0114160e69705f38bda1"></a><!-- doxytag: member="eeprom.h::eeprom_get_byte" ref="1235e4e69e3f0114160e69705f38bda1" args="(unsigned int addr, unsigned char *byte)" --> |
| 55 |
<div class="memitem"> |
| 56 |
<div class="memproto"> |
| 57 |
<table class="memname"> |
| 58 |
<tr>
|
| 59 |
<td class="memname">int eeprom_get_byte </td> |
| 60 |
<td>(</td> |
| 61 |
<td class="paramtype">unsigned int </td> |
| 62 |
<td class="paramname"> <em>addr</em>, </td> |
| 63 |
</tr>
|
| 64 |
<tr>
|
| 65 |
<td class="paramkey"></td> |
| 66 |
<td></td> |
| 67 |
<td class="paramtype">unsigned char * </td> |
| 68 |
<td class="paramname"> <em>byte</em></td><td> </td> |
| 69 |
</tr>
|
| 70 |
<tr>
|
| 71 |
<td></td> |
| 72 |
<td>)</td> |
| 73 |
<td></td><td></td><td width="100%"></td> |
| 74 |
</tr>
|
| 75 |
</table>
|
| 76 |
</div>
|
| 77 |
<div class="memdoc"> |
| 78 |
|
| 79 |
<p>
|
| 80 |
reads a byte from eeprom |
| 81 |
<p>
|
| 82 |
Pass it thge address and a pointer to a byte where the byte at the address will be stored<p>
|
| 83 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful (byte is set to the eeprom value at addr), nonzero if there was a problem </dd></dl> |
| 84 |
|
| 85 |
</div>
|
| 86 |
</div><p> |
| 87 |
<a class="anchor" name="4f56f25703c0e313fae3d0d327109082"></a><!-- doxytag: member="eeprom.h::eeprom_put_byte" ref="4f56f25703c0e313fae3d0d327109082" args="(unsigned int addr, unsigned char byte)" --> |
| 88 |
<div class="memitem"> |
| 89 |
<div class="memproto"> |
| 90 |
<table class="memname"> |
| 91 |
<tr>
|
| 92 |
<td class="memname">int eeprom_put_byte </td> |
| 93 |
<td>(</td> |
| 94 |
<td class="paramtype">unsigned int </td> |
| 95 |
<td class="paramname"> <em>addr</em>, </td> |
| 96 |
</tr>
|
| 97 |
<tr>
|
| 98 |
<td class="paramkey"></td> |
| 99 |
<td></td> |
| 100 |
<td class="paramtype">unsigned char </td> |
| 101 |
<td class="paramname"> <em>byte</em></td><td> </td> |
| 102 |
</tr>
|
| 103 |
<tr>
|
| 104 |
<td></td> |
| 105 |
<td>)</td> |
| 106 |
<td></td><td></td><td width="100%"></td> |
| 107 |
</tr>
|
| 108 |
</table>
|
| 109 |
</div>
|
| 110 |
<div class="memdoc"> |
| 111 |
|
| 112 |
<p>
|
| 113 |
store a byte to eeproem |
| 114 |
<p>
|
| 115 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if success, nonzero on failure </dd></dl> |
| 116 |
|
| 117 |
</div>
|
| 118 |
</div><p> |
| 119 |
<a class="anchor" name="de3f83da05149edf008cb5fa23fde7df"></a><!-- doxytag: member="eeprom.h::get_bom_type" ref="de3f83da05149edf008cb5fa23fde7df" args="(void)" --> |
| 120 |
<div class="memitem"> |
| 121 |
<div class="memproto"> |
| 122 |
<table class="memname"> |
| 123 |
<tr>
|
| 124 |
<td class="memname">unsigned char get_bom_type </td> |
| 125 |
<td>(</td> |
| 126 |
<td class="paramtype">void </td> |
| 127 |
<td class="paramname"> </td> |
| 128 |
<td> ) </td> |
| 129 |
<td width="100%"></td> |
| 130 |
</tr>
|
| 131 |
</table>
|
| 132 |
</div>
|
| 133 |
<div class="memdoc"> |
| 134 |
|
| 135 |
<p>
|
| 136 |
get stored robot ID |
| 137 |
<p>
|
| 138 |
checks that EEPROM has been programed with an BOM type and returns it<p>
|
| 139 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the robot bom type as defined in <a class="el" href="bom_8h.html" title="Definitions for using the BOM.">bom.h</a>, if it is stored. If it returns 0xFF it is probably invalid </dd></dl> |
| 140 |
|
| 141 |
</div>
|
| 142 |
</div><p> |
| 143 |
<a class="anchor" name="bfc8e084d177435cbe1cc30cfedf4327"></a><!-- doxytag: member="eeprom.h::get_robotid" ref="bfc8e084d177435cbe1cc30cfedf4327" args="(void)" --> |
| 144 |
<div class="memitem"> |
| 145 |
<div class="memproto"> |
| 146 |
<table class="memname"> |
| 147 |
<tr>
|
| 148 |
<td class="memname">unsigned char get_robotid </td> |
| 149 |
<td>(</td> |
| 150 |
<td class="paramtype">void </td> |
| 151 |
<td class="paramname"> </td> |
| 152 |
<td> ) </td> |
| 153 |
<td width="100%"></td> |
| 154 |
</tr>
|
| 155 |
</table>
|
| 156 |
</div>
|
| 157 |
<div class="memdoc"> |
| 158 |
|
| 159 |
<p>
|
| 160 |
get stored robot ID |
| 161 |
<p>
|
| 162 |
checks that EEPROM has been programed with an ID and returns it<p>
|
| 163 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the robot id, if it is stored. If it returns 0xFF it is probably invalid </dd></dl> |
| 164 |
|
| 165 |
</div>
|
| 166 |
</div><p> |
| 167 |
</div>
|
| 168 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:08 2009 for libdragonfly by |
| 169 |
<a href="http://www.doxygen.org/index.html"> |
| 170 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
| 171 |
</body>
|
| 172 |
</html>
|