PageRenderTime 36ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/generalDrivers/Documentation/group___e_e_p_r_o_m.html

https://github.com/nfox/team_252_10-11
HTML | 263 lines | 248 code | 14 blank | 1 comment | 0 complexity | bf6fd041d049803e23eb21f56387e1ef MD5 | raw file
    

  1. <HTML> 
    2. 

  2. <HEAD> 
    3. 

  3. 	<TITLE>3rd Party ROBOTC Drivers</TITLE> 
    4. 

  4. <link href="tabs.css" rel="stylesheet" type="text/css"/> 
    5. 

  5. <link href="doxygen.css" rel="stylesheet" type="text/css"/> 
    6. 

  6. </HEAD> 
    7. 

  7.  
    8. 

  8. <BODY bgcolor="#ffffff" link="#000000" vlink="#000000"> 
    9. 

  9. <table width="100%" bgcolor="navy" cellspacing=0 cellpadding=1 border=0> 
    10. 

  10. <tr><td><table width="100%" bgcolor="#EEEEDD" cellspacing=0 cellpadding=3 border=0> 
    11. 

  11. <tr> 
    12. 

  12.     <td width="33%" align="left"> <img src="images/LOGO_NXT.gif" width=266 height=44 border="0" alt="Mindstorms"></td> 
    13. 

  13.     <td><b><font size="+3" color="navy">3rd Party ROBOTC Drivers</font></b></td> 
    14. 

  14.     <td align="right"> <img src="images/logo.png" width=44 height=44 border="0" alt="RobotC"></td>     
    15. 

  15. </tr> 
    16. 

  16.   <tr bgcolor="#cccc99" align="right"> 
    17. 

  17.           <td colspan=3> <font face="arial" size="-1"> [<a href=main.html>Home</a>] [<a target=_top href="https://sourceforge.net/projects/rdpartyrobotcdr/">Download</a>] [<a target=_top href="http://apps.sourceforge.net/mantisbt/rdpartyrobotcdr/my_view_page.php">Submit a bug/suggestion</a>]  [<a target=_top href="http://www.robotc.net/forums/">ROBOTC Forums</a>] [<a href="http://mightor.wordpress.com">Blog</a>] [<a target=_top href="http://sourceforge.net/donate/index.php?group_id=257238">Support this project</a>]</font> </td> 
    18. 

  18. </tr> 
    19. 

  19. </table></td></tr> 
    20. 

  20. </table> 
    21. 

  21. <!-- Generated by Doxygen 1.6.3 -->
    22. 

  22. <div class="contents">
    23. 

  23. <h1>Generic I2C EEPROM<br/>
    24. 

  24. <small>
    25. 

  25. [<a class="el" href="group__other.html">Other</a>]</small>
    26. 

  26. </h1><table border="0" cellpadding="0" cellspacing="0">
    27. 

  27. <tr><td colspan="2"><h2>Files</h2></td></tr>
    28. 

  28. <tr><td class="memItemLeft" align="right" valign="top">file &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_e_e_p_r_o_m-driver_8h.html">EEPROM-driver.h</a></td></tr>
    29. 

  29. 

  30. <p><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>RobotC EEPROM Driver. </p>
    31. 

  31. <br/></td></tr>
    32. 

  32. </p>
    33. 

  33. <tr><td colspan="2"><h2>Defines</h2></td></tr>
    34. 

  34. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#ga0bb5af400d8883a7a9dc432ad3296546">EEPROM_I2C_ADDR</a>&nbsp;&nbsp;&nbsp;0xA0</td></tr>
    35. 

  35. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#gaddfda15f5f3ec6f8f325f48be50c548a">EEPROM_PAGE_SIZE</a>&nbsp;&nbsp;&nbsp;128</td></tr>
    36. 

  36. <tr><td colspan="2"><h2>Functions</h2></td></tr>
    37. 

  37. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#ga273af6ee6caa116643c95dc7b3bc3101">EEPROMreadBytes</a> (tSensors link, long address, <a class="el" href="structt_byte_array.html">tByteArray</a> &amp;data, int numbytes)</td></tr>
    38. 

  38. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#gaf986171d64fa04da0955cd6558e749e4">EEPROMwriteBytes</a> (tSensors link, long address, <a class="el" href="structt_byte_array.html">tByteArray</a> &amp;data, int numbytes)</td></tr>
    39. 

  39. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#ga034513db62caab4f3785842540b30f1e">_EEPROMwriteDummy</a> (tSensors link, long address)</td></tr>
    40. 

  40. <tr><td colspan="2"><h2>Variables</h2></td></tr>
    41. 

  41. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structt_byte_array.html">tByteArray</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#gad970205e82294e04606e7a62b34749a3">EEPROM_I2CRequest</a></td></tr>
    42. 

  42. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structt_byte_array.html">tByteArray</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_e_p_r_o_m.html#ga3f227700949481751aec23a8be2a2acd">EEPROM_I2CReply</a></td></tr>
    43. 

  43. </table>
    44. 

  44. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    45. 

  45. <p>Generic I2C EEPROM </p>
    46. 

  46. <hr/><h2>Define Documentation</h2>
    47. 

  47. <a class="anchor" id="ga0bb5af400d8883a7a9dc432ad3296546"></a><!-- doxytag: member="EEPROM&#45;driver.h::EEPROM_I2C_ADDR" ref="ga0bb5af400d8883a7a9dc432ad3296546" args="" -->
    48. 

  48. <div class="memitem">
    49. 

  49. <div class="memproto">
    50. 

  50.       <table class="memname">
    51. 

  51.         <tr>
    52. 

  52.           <td class="memname">#define EEPROM_I2C_ADDR&nbsp;&nbsp;&nbsp;0xA0</td>
    53. 

  53.         </tr>
    54. 

  54.       </table>
    55. 

  55. </div>
    56. 

  56. <div class="memdoc">
    57. 

  57. <p>EEPROM I2C device address </p>
    58. 

  58. 

  59. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00032">32</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    60. 

  60. 

  61. </div>
    62. 

  62. </div>
    63. 

  63. <a class="anchor" id="gaddfda15f5f3ec6f8f325f48be50c548a"></a><!-- doxytag: member="EEPROM&#45;driver.h::EEPROM_PAGE_SIZE" ref="gaddfda15f5f3ec6f8f325f48be50c548a" args="" -->
    64. 

  64. <div class="memitem">
    65. 

  65. <div class="memproto">
    66. 

  66.       <table class="memname">
    67. 

  67.         <tr>
    68. 

  68.           <td class="memname">#define EEPROM_PAGE_SIZE&nbsp;&nbsp;&nbsp;128</td>
    69. 

  69.         </tr>
    70. 

  70.       </table>
    71. 

  71. </div>
    72. 

  72. <div class="memdoc">
    73. 

  73. <p>Page for the AT24C512 </p>
    74. 

  74. 

  75. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00035">35</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    76. 

  76. 

  77. </div>
    78. 

  78. </div>
    79. 

  79. <hr/><h2>Function Documentation</h2>
    80. 

  80. <a class="anchor" id="ga034513db62caab4f3785842540b30f1e"></a><!-- doxytag: member="EEPROM&#45;driver.h::_EEPROMwriteDummy" ref="ga034513db62caab4f3785842540b30f1e" args="(tSensors link, long address)" -->
    81. 

  81. <div class="memitem">
    82. 

  82. <div class="memproto">
    83. 

  83.       <table class="memname">
    84. 

  84.         <tr>
    85. 

  85.           <td class="memname">bool _EEPROMwriteDummy </td>
    86. 

  86.           <td>(</td>
    87. 

  87.           <td class="paramtype">tSensors&nbsp;</td>
    88. 

  88.           <td class="paramname"> <em>link</em>, </td>
    89. 

  89.         </tr>
    90. 

  90.         <tr>
    91. 

  91.           <td class="paramkey"></td>
    92. 

  92.           <td></td>
    93. 

  93.           <td class="paramtype">long&nbsp;</td>
    94. 

  94.           <td class="paramname"> <em>address</em></td><td>&nbsp;</td>
    95. 

  95.         </tr>
    96. 

  96.         <tr>
    97. 

  97.           <td></td>
    98. 

  98.           <td>)</td>
    99. 

  99.           <td></td><td></td><td></td>
    100. 

  100.         </tr>
    101. 

  101.       </table>
    102. 

  102. </div>
    103. 

  103. <div class="memdoc">
    104. 

  104. <p>Perform a dummy write to set address for next read</p>
    105. 

  105. <p>Note: this is an internal function and should not be called directly. </p>
    106. 

  106. <dl><dt><b>Parameters:</b></dt><dd>
    107. 

  107.   <table border="0" cellspacing="2" cellpadding="0">
    108. 

  108.     <tr><td valign="top"></td><td valign="top"><em>link</em>&nbsp;</td><td>the EEPROM </td></tr>
    109. 

  109.     <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>the address to set </td></tr>
    110. 

  110.   </table>
    111. 

  111.   </dd>
    112. 

  112. </dl>
    113. 

  113. <dl class="return"><dt><b>Returns:</b></dt><dd>true if no error occured, false if it did </dd></dl>
    114. 

  114. 

  115. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00084">84</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    116. 

  116. 

  117. </div>
    118. 

  118. </div>
    119. 

  119. <a class="anchor" id="ga273af6ee6caa116643c95dc7b3bc3101"></a><!-- doxytag: member="EEPROM&#45;driver.h::EEPROMreadBytes" ref="ga273af6ee6caa116643c95dc7b3bc3101" args="(tSensors link, long address, tByteArray &amp;data, int numbytes)" -->
    120. 

  120. <div class="memitem">
    121. 

  121. <div class="memproto">
    122. 

  122.       <table class="memname">
    123. 

  123.         <tr>
    124. 

  124.           <td class="memname">bool EEPROMreadBytes </td>
    125. 

  125.           <td>(</td>
    126. 

  126.           <td class="paramtype">tSensors&nbsp;</td>
    127. 

  127.           <td class="paramname"> <em>link</em>, </td>
    128. 

  128.         </tr>
    129. 

  129.         <tr>
    130. 

  130.           <td class="paramkey"></td>
    131. 

  131.           <td></td>
    132. 

  132.           <td class="paramtype">long&nbsp;</td>
    133. 

  133.           <td class="paramname"> <em>address</em>, </td>
    134. 

  134.         </tr>
    135. 

  135.         <tr>
    136. 

  136.           <td class="paramkey"></td>
    137. 

  137.           <td></td>
    138. 

  138.           <td class="paramtype"><a class="el" href="structt_byte_array.html">tByteArray</a> &amp;&nbsp;</td>
    139. 

  139.           <td class="paramname"> <em>data</em>, </td>
    140. 

  140.         </tr>
    141. 

  141.         <tr>
    142. 

  142.           <td class="paramkey"></td>
    143. 

  143.           <td></td>
    144. 

  144.           <td class="paramtype">int&nbsp;</td>
    145. 

  145.           <td class="paramname"> <em>numbytes</em></td><td>&nbsp;</td>
    146. 

  146.         </tr>
    147. 

  147.         <tr>
    148. 

  148.           <td></td>
    149. 

  149.           <td>)</td>
    150. 

  150.           <td></td><td></td><td></td>
    151. 

  151.         </tr>
    152. 

  152.       </table>
    153. 

  153. </div>
    154. 

  154. <div class="memdoc">
    155. 

  155. <p>Read a number of bytes from address </p>
    156. 

  156. <dl><dt><b>Parameters:</b></dt><dd>
    157. 

  157.   <table border="0" cellspacing="2" cellpadding="0">
    158. 

  158.     <tr><td valign="top"></td><td valign="top"><em>link</em>&nbsp;</td><td>the EEPROM </td></tr>
    159. 

  159.     <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>the address to read from </td></tr>
    160. 

  160.     <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the byte array to store read result in </td></tr>
    161. 

  161.     <tr><td valign="top"></td><td valign="top"><em>numbytes</em>&nbsp;</td><td>the number of bytes to read (limited to 16 at a time) </td></tr>
    162. 

  162.   </table>
    163. 

  163.   </dd>
    164. 

  164. </dl>
    165. 

  165. <dl class="return"><dt><b>Returns:</b></dt><dd>true if no error occured, false if it did </dd></dl>
    166. 

  166. <dl><dt><b>Examples: </b></dt><dd><a class="el" href="_e_e_p_r_o_m-test1.c-example.html#a3">EEPROM-test1.c</a>.</dd>
    167. 

  167. </dl>
    168. 

  168. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00056">56</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    169. 

  169. 

  170. </div>
    171. 

  171. </div>
    172. 

  172. <a class="anchor" id="gaf986171d64fa04da0955cd6558e749e4"></a><!-- doxytag: member="EEPROM&#45;driver.h::EEPROMwriteBytes" ref="gaf986171d64fa04da0955cd6558e749e4" args="(tSensors link, long address, tByteArray &amp;data, int numbytes)" -->
    173. 

  173. <div class="memitem">
    174. 

  174. <div class="memproto">
    175. 

  175.       <table class="memname">
    176. 

  176.         <tr>
    177. 

  177.           <td class="memname">bool EEPROMwriteBytes </td>
    178. 

  178.           <td>(</td>
    179. 

  179.           <td class="paramtype">tSensors&nbsp;</td>
    180. 

  180.           <td class="paramname"> <em>link</em>, </td>
    181. 

  181.         </tr>
    182. 

  182.         <tr>
    183. 

  183.           <td class="paramkey"></td>
    184. 

  184.           <td></td>
    185. 

  185.           <td class="paramtype">long&nbsp;</td>
    186. 

  186.           <td class="paramname"> <em>address</em>, </td>
    187. 

  187.         </tr>
    188. 

  188.         <tr>
    189. 

  189.           <td class="paramkey"></td>
    190. 

  190.           <td></td>
    191. 

  191.           <td class="paramtype"><a class="el" href="structt_byte_array.html">tByteArray</a> &amp;&nbsp;</td>
    192. 

  192.           <td class="paramname"> <em>data</em>, </td>
    193. 

  193.         </tr>
    194. 

  194.         <tr>
    195. 

  195.           <td class="paramkey"></td>
    196. 

  196.           <td></td>
    197. 

  197.           <td class="paramtype">int&nbsp;</td>
    198. 

  198.           <td class="paramname"> <em>numbytes</em></td><td>&nbsp;</td>
    199. 

  199.         </tr>
    200. 

  200.         <tr>
    201. 

  201.           <td></td>
    202. 

  202.           <td>)</td>
    203. 

  203.           <td></td><td></td><td></td>
    204. 

  204.         </tr>
    205. 

  205.       </table>
    206. 

  206. </div>
    207. 

  207. <div class="memdoc">
    208. 

  208. <p>Write a single byte to address </p>
    209. 

  209. <dl><dt><b>Parameters:</b></dt><dd>
    210. 

  210.   <table border="0" cellspacing="2" cellpadding="0">
    211. 

  211.     <tr><td valign="top"></td><td valign="top"><em>link</em>&nbsp;</td><td>the EEPROM </td></tr>
    212. 

  212.     <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>the address to write to </td></tr>
    213. 

  213.     <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the byte array to write </td></tr>
    214. 

  214.     <tr><td valign="top"></td><td valign="top"><em>numbytes</em>&nbsp;</td><td>the number of bytes to write (limited to 13 at a time) </td></tr>
    215. 

  215.   </table>
    216. 

  216.   </dd>
    217. 

  217. </dl>
    218. 

  218. <dl class="return"><dt><b>Returns:</b></dt><dd>true if no error occured, false if it did </dd></dl>
    219. 

  219. <dl><dt><b>Examples: </b></dt><dd><a class="el" href="_e_e_p_r_o_m-test1.c-example.html#a2">EEPROM-test1.c</a>.</dd>
    220. 

  220. </dl>
    221. 

  221. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00104">104</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    222. 

  222. 

  223. </div>
    224. 

  224. </div>
    225. 

  225. <hr/><h2>Variable Documentation</h2>
    226. 

  226. <a class="anchor" id="ga3f227700949481751aec23a8be2a2acd"></a><!-- doxytag: member="EEPROM&#45;driver.h::EEPROM_I2CReply" ref="ga3f227700949481751aec23a8be2a2acd" args="" -->
    227. 

  227. <div class="memitem">
    228. 

  228. <div class="memproto">
    229. 

  229.       <table class="memname">
    230. 

  230.         <tr>
    231. 

  231.           <td class="memname"><a class="el" href="structt_byte_array.html">tByteArray</a> <a class="el" href="group___e_e_p_r_o_m.html#ga3f227700949481751aec23a8be2a2acd">EEPROM_I2CReply</a></td>
    232. 

  232.         </tr>
    233. 

  233.       </table>
    234. 

  234. </div>
    235. 

  235. <div class="memdoc">
    236. 

  236. <p>Array to hold I2C reply data </p>
    237. 

  237. 

  238. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00038">38</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    239. 

  239. 

  240. </div>
    241. 

  241. </div>
    242. 

  242. <a class="anchor" id="gad970205e82294e04606e7a62b34749a3"></a><!-- doxytag: member="EEPROM&#45;driver.h::EEPROM_I2CRequest" ref="gad970205e82294e04606e7a62b34749a3" args="" -->
    243. 

  243. <div class="memitem">
    244. 

  244. <div class="memproto">
    245. 

  245.       <table class="memname">
    246. 

  246.         <tr>
    247. 

  247.           <td class="memname"><a class="el" href="structt_byte_array.html">tByteArray</a> <a class="el" href="group___e_e_p_r_o_m.html#gad970205e82294e04606e7a62b34749a3">EEPROM_I2CRequest</a></td>
    248. 

  248.         </tr>
    249. 

  249.       </table>
    250. 

  250. </div>
    251. 

  251. <div class="memdoc">
    252. 

  252. <p>Array to hold I2C command data </p>
    253. 

  253. 

  254. <p>Definition at line <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html#l00037">37</a> of file <a class="el" href="_e_e_p_r_o_m-driver_8h_source.html">EEPROM-driver.h</a>.</p>
    255. 

  255. 

  256. </div>
    257. 

  257. </div>
    258. 

  258. </div>
    259. 

  259. <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Jun 25 14:58:54 2010 for ROBOTC Drivers by&nbsp;
    260. 

  260. <a href="http://www.doxygen.org/index.html">
    261. 

  261. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
    262. 

  262. </body>
    263. 

  263. </html>
    264. 

  264.