Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / eeprom_8h.html @ 1398

History | View | Annotate | Download (7.99 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="tabs.css" rel="stylesheet" type="text/css">
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.9 -->
8
<div class="navigation" id="top">
9
  <div class="tabs">
10
    <ul>
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13
      <li><a href="modules.html"><span>Modules</span></a></li>
14
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16
    </ul>
17
  </div>
18
  <div class="tabs">
19
    <ul>
20
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21
      <li><a href="globals.html"><span>Globals</span></a></li>
22
    </ul>
23
  </div>
24
</div>
25
<div class="contents">
26
<h1>eeprom.h File Reference</h1>handles eeprom storage for persistent data  
27
<a href="#_details">More...</a>
28
<p>
29
<code>#include &lt;<a class="el" href="bom_8h_source.html">bom.h</a>&gt;</code><br>
30

    
31
<p>
32
<a href="eeprom_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
33
<tr><td></td></tr>
34
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
35
<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="" -->
36
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>EEPROM_ROBOT_ID_ADDR</b>&nbsp;&nbsp;&nbsp;0x10</td></tr>
37

    
38
<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="" -->
39
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>EEPROM_BOM_TYPE_ADDR</b>&nbsp;&nbsp;&nbsp;0x14</td></tr>
40

    
41
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
42
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>
43

    
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">store a byte to eeproem  <a href="#4f56f25703c0e313fae3d0d327109082"></a><br></td></tr>
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>
46

    
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reads a byte from eeprom  <a href="#1235e4e69e3f0114160e69705f38bda1"></a><br></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="eeprom_8h.html#bfc8e084d177435cbe1cc30cfedf4327">get_robotid</a> (void)</td></tr>
49

    
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get stored robot ID  <a href="#bfc8e084d177435cbe1cc30cfedf4327"></a><br></td></tr>
51
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="eeprom_8h.html#de3f83da05149edf008cb5fa23fde7df">get_bom_type</a> (void)</td></tr>
52

    
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get stored robot ID  <a href="#de3f83da05149edf008cb5fa23fde7df"></a><br></td></tr>
54
</table>
55
<hr><h2>Detailed Description</h2>
56
handles eeprom storage for persistent data 
57
<p>
58
Contains functions and definitions for reading and writing to eeprom<p>
59
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, Brad Neuman </dd></dl>
60
<hr><h2>Function Documentation</h2>
61
<a class="anchor" name="1235e4e69e3f0114160e69705f38bda1"></a><!-- doxytag: member="eeprom.h::eeprom_get_byte" ref="1235e4e69e3f0114160e69705f38bda1" args="(unsigned int addr, unsigned char *byte)" -->
62
<div class="memitem">
63
<div class="memproto">
64
      <table class="memname">
65
        <tr>
66
          <td class="memname">int eeprom_get_byte           </td>
67
          <td>(</td>
68
          <td class="paramtype">unsigned int&nbsp;</td>
69
          <td class="paramname"> <em>addr</em>, </td>
70
        </tr>
71
        <tr>
72
          <td class="paramkey"></td>
73
          <td></td>
74
          <td class="paramtype">unsigned char *&nbsp;</td>
75
          <td class="paramname"> <em>byte</em></td><td>&nbsp;</td>
76
        </tr>
77
        <tr>
78
          <td></td>
79
          <td>)</td>
80
          <td></td><td></td><td></td>
81
        </tr>
82
      </table>
83
</div>
84
<div class="memdoc">
85

    
86
<p>
87
reads a byte from eeprom 
88
<p>
89
Pass it thge address and a pointer to a byte where the byte at the address will be stored<p>
90
<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>
91

    
92
</div>
93
</div><p>
94
<a class="anchor" name="4f56f25703c0e313fae3d0d327109082"></a><!-- doxytag: member="eeprom.h::eeprom_put_byte" ref="4f56f25703c0e313fae3d0d327109082" args="(unsigned int addr, unsigned char byte)" -->
95
<div class="memitem">
96
<div class="memproto">
97
      <table class="memname">
98
        <tr>
99
          <td class="memname">int eeprom_put_byte           </td>
100
          <td>(</td>
101
          <td class="paramtype">unsigned int&nbsp;</td>
102
          <td class="paramname"> <em>addr</em>, </td>
103
        </tr>
104
        <tr>
105
          <td class="paramkey"></td>
106
          <td></td>
107
          <td class="paramtype">unsigned char&nbsp;</td>
108
          <td class="paramname"> <em>byte</em></td><td>&nbsp;</td>
109
        </tr>
110
        <tr>
111
          <td></td>
112
          <td>)</td>
113
          <td></td><td></td><td></td>
114
        </tr>
115
      </table>
116
</div>
117
<div class="memdoc">
118

    
119
<p>
120
store a byte to eeproem 
121
<p>
122
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if success, nonzero on failure </dd></dl>
123

    
124
</div>
125
</div><p>
126
<a class="anchor" name="de3f83da05149edf008cb5fa23fde7df"></a><!-- doxytag: member="eeprom.h::get_bom_type" ref="de3f83da05149edf008cb5fa23fde7df" args="(void)" -->
127
<div class="memitem">
128
<div class="memproto">
129
      <table class="memname">
130
        <tr>
131
          <td class="memname">unsigned char get_bom_type           </td>
132
          <td>(</td>
133
          <td class="paramtype">void&nbsp;</td>
134
          <td class="paramname">          </td>
135
          <td>&nbsp;)&nbsp;</td>
136
          <td></td>
137
        </tr>
138
      </table>
139
</div>
140
<div class="memdoc">
141

    
142
<p>
143
get stored robot ID 
144
<p>
145
checks that EEPROM has been programed with an BOM type and returns it<p>
146
<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>
147

    
148
</div>
149
</div><p>
150
<a class="anchor" name="bfc8e084d177435cbe1cc30cfedf4327"></a><!-- doxytag: member="eeprom.h::get_robotid" ref="bfc8e084d177435cbe1cc30cfedf4327" args="(void)" -->
151
<div class="memitem">
152
<div class="memproto">
153
      <table class="memname">
154
        <tr>
155
          <td class="memname">unsigned char get_robotid           </td>
156
          <td>(</td>
157
          <td class="paramtype">void&nbsp;</td>
158
          <td class="paramname">          </td>
159
          <td>&nbsp;)&nbsp;</td>
160
          <td></td>
161
        </tr>
162
      </table>
163
</div>
164
<div class="memdoc">
165

    
166
<p>
167
get stored robot ID 
168
<p>
169
checks that EEPROM has been programed with an ID and returns it<p>
170
<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>
171

    
172
</div>
173
</div><p>
174
</div>
175
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;
176
<a href="http://www.doxygen.org/index.html">
177
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
178
</body>
179
</html>