crc_8h_source.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>CoffeePi: crc.h Source File</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">CoffeePi
  27. </div>
  28. <div id="projectbrief">Coffee machine control for Raspberry Pi</div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li class="current"><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="files.html"><span>File&#160;List</span></a></li>
  65. <li><a href="globals.html"><span>Globals</span></a></li>
  66. </ul>
  67. </div>
  68. </div><!-- top -->
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div class="header">
  82. <div class="headertitle">
  83. <div class="title">crc.h</div> </div>
  84. </div><!--header-->
  85. <div class="contents">
  86. <a href="crc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**********************************************************************</span></div>
  87. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  88. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Filename: crc.h</span></div>
  89. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * </span></div>
  90. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Description: A header file describing the various CRC standards.</span></div>
  91. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
  92. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Notes: </span></div>
  93. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  94. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * </span></div>
  95. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Copyright (c) 2000 by Michael Barr. This software is placed into</span></div>
  96. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * the public domain and may be used for any purpose. However, this</span></div>
  97. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * notice must not be changed or removed and no warranty is either</span></div>
  98. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * expressed or implied by its publication or distribution.</span></div>
  99. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> **********************************************************************/</span></div>
  100. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
  101. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#ifndef _crc_h</span></div>
  102. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define _crc_h</span></div>
  103. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
  104. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
  105. <div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="crc_8h.html#aa93f0eb578d23995850d61f7d61c55c1"> 20</a></span>&#160;<span class="preprocessor">#define FALSE 0</span></div>
  106. <div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="crc_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d"> 21</a></span>&#160;<span class="preprocessor">#define TRUE !FALSE</span></div>
  107. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
  108. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">/*</span></div>
  109. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * Select the CRC standard from the list that follows.</span></div>
  110. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> */</span></div>
  111. <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="crc_8h.html#a491e419c18fbc5c7cb4a2cd901e31440"> 26</a></span>&#160;<span class="preprocessor">#define CRC32</span></div>
  112. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
  113. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
  114. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#if defined(CRC_CCITT)</span></div>
  115. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
  116. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be">crc</a>;</div>
  117. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
  118. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define CRC_NAME &quot;CRC-CCITT&quot;</span></div>
  119. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define POLYNOMIAL 0x1021</span></div>
  120. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define INITIAL_REMAINDER 0xFFFF</span></div>
  121. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define FINAL_XOR_VALUE 0x0000</span></div>
  122. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define REFLECT_DATA FALSE</span></div>
  123. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define REFLECT_REMAINDER FALSE</span></div>
  124. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define CHECK_VALUE 0x29B1</span></div>
  125. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
  126. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#elif defined(CRC16)</span></div>
  127. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
  128. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be">crc</a>;</div>
  129. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
  130. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#define CRC_NAME &quot;CRC-16&quot;</span></div>
  131. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define POLYNOMIAL 0x8005</span></div>
  132. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define INITIAL_REMAINDER 0x0000</span></div>
  133. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#define FINAL_XOR_VALUE 0x0000</span></div>
  134. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#define REFLECT_DATA TRUE</span></div>
  135. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define REFLECT_REMAINDER TRUE</span></div>
  136. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#define CHECK_VALUE 0xBB3D</span></div>
  137. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
  138. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#elif defined(CRC32)</span></div>
  139. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
  140. <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be"> 55</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be">crc</a>;</div>
  141. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
  142. <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="crc_8h.html#ad679f457b8d23bfed7ccf1b9584e8514"> 57</a></span>&#160;<span class="preprocessor">#define CRC_NAME &quot;CRC-32&quot;</span></div>
  143. <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="crc_8h.html#ae13d91fe6e514f0aa1caba701ef1ff92"> 58</a></span>&#160;<span class="preprocessor">#define POLYNOMIAL 0x04C11DB7</span></div>
  144. <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="crc_8h.html#acce5b79e1a8ad8ffe40fb9f7d63b2fdc"> 59</a></span>&#160;<span class="preprocessor">#define INITIAL_REMAINDER 0xFFFFFFFF</span></div>
  145. <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="crc_8h.html#a5e491822bb6a5bf7114dd453ab48891e"> 60</a></span>&#160;<span class="preprocessor">#define FINAL_XOR_VALUE 0xFFFFFFFF</span></div>
  146. <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="crc_8h.html#af6653e78d37b912d592ffc6e96eb7abb"> 61</a></span>&#160;<span class="preprocessor">#define REFLECT_DATA TRUE</span></div>
  147. <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="crc_8h.html#a5aa89bef30ad5bd061deda3eef36e327"> 62</a></span>&#160;<span class="preprocessor">#define REFLECT_REMAINDER TRUE</span></div>
  148. <div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="crc_8h.html#aee81a10f43f9dc645ba69a7407c151d0"> 63</a></span>&#160;<span class="preprocessor">#define CHECK_VALUE 0xCBF43926</span></div>
  149. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
  150. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#else</span></div>
  151. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
  152. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#error &quot;One of CRC_CCITT, CRC16, or CRC32 must be #define&#39;d.&quot;</span></div>
  153. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
  154. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif</span></div>
  155. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
  156. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
  157. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keywordtype">void</span> <a class="code" href="crc_8h.html#a5a735798e6972adc694a5428dd7ccaf9">crcInit</a>(<span class="keywordtype">void</span>);</div>
  158. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<a class="code" href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be">crc</a> <a class="code" href="crc_8h.html#a027c2916f24b3daaf662408cc72026b1">crcSlow</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span> message[], <span class="keywordtype">int</span> nBytes);</div>
  159. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<a class="code" href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be">crc</a> <a class="code" href="crc_8h.html#a31e9ca3a3979a4c1e5043f5bfa5befaf">crcFast</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span> message[], <span class="keywordtype">int</span> nBytes);</div>
  160. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
  161. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
  162. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _crc_h */</span><span class="preprocessor"></span></div>
  163. <div class="ttc" id="crc_8h_html_a73364f0434186bc77eaa8e3b03a437be"><div class="ttname"><a href="crc_8h.html#a73364f0434186bc77eaa8e3b03a437be">crc</a></div><div class="ttdeci">unsigned long crc</div><div class="ttdef"><b>Definition:</b> crc.h:55</div></div>
  164. <div class="ttc" id="crc_8h_html_a027c2916f24b3daaf662408cc72026b1"><div class="ttname"><a href="crc_8h.html#a027c2916f24b3daaf662408cc72026b1">crcSlow</a></div><div class="ttdeci">crc crcSlow(unsigned char const message[], int nBytes)</div><div class="ttdef"><b>Definition:</b> crc.cpp:95</div></div>
  165. <div class="ttc" id="crc_8h_html_a31e9ca3a3979a4c1e5043f5bfa5befaf"><div class="ttname"><a href="crc_8h.html#a31e9ca3a3979a4c1e5043f5bfa5befaf">crcFast</a></div><div class="ttdeci">crc crcFast(unsigned char const message[], int nBytes)</div><div class="ttdef"><b>Definition:</b> crc.cpp:212</div></div>
  166. <div class="ttc" id="crc_8h_html_a5a735798e6972adc694a5428dd7ccaf9"><div class="ttname"><a href="crc_8h.html#a5a735798e6972adc694a5428dd7ccaf9">crcInit</a></div><div class="ttdeci">void crcInit(void)</div><div class="ttdef"><b>Definition:</b> crc.cpp:156</div></div>
  167. </div><!-- fragment --></div><!-- contents -->
  168. <!-- start footer part -->
  169. <hr class="footer"/><address class="footer"><small>
  170. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  171. <img class="footer" src="doxygen.png" alt="doxygen"/>
  172. </a> 1.8.10
  173. </small></address>
  174. </body>
  175. </html>