kopia lustrzana https://github.com/jgromes/RadioLib
146 wiersze
13 KiB
HTML
146 wiersze
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: src/utils/CRC.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_c_r_c_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">CRC.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_CRC_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_CRC_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../TypeDef.h"</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "../Module.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../ArduinoHal.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// CCITT CRC properties (used by AX.25)</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define RADIOLIB_CRC_CCITT_POLY (0x1021)</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define RADIOLIB_CRC_CCITT_INIT (0xFFFF)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define RADIOLIB_CRC_CCITT_OUT (0xFFFF)</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html"> 19</a></span> <span class="keyword">class </span><a class="code" href="class_radio_lib_c_r_c.html">RadioLibCRC</a> {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html#ad09b067c00cda1cc676c13602dee2f5a"> 24</a></span>  uint8_t <a class="code" href="class_radio_lib_c_r_c.html#ad09b067c00cda1cc676c13602dee2f5a">size</a> = 8;</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html#af3942e08bde9d9d127f735bd10392f6d"> 29</a></span>  uint32_t <a class="code" href="class_radio_lib_c_r_c.html#af3942e08bde9d9d127f735bd10392f6d">poly</a> = 0;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html#a579acc51fe7a01b0b9b3f2e0e57b7d5f"> 34</a></span>  uint32_t <a class="code" href="class_radio_lib_c_r_c.html#a579acc51fe7a01b0b9b3f2e0e57b7d5f">init</a> = 0;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html#a46616ef58e9eeeca646de0c9fe681050"> 39</a></span>  uint32_t <a class="code" href="class_radio_lib_c_r_c.html#a46616ef58e9eeeca646de0c9fe681050">out</a> = 0;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html#ac65a358753efd05067c19fcf1098ec04"> 44</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_radio_lib_c_r_c.html#ac65a358753efd05067c19fcf1098ec04">refIn</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="class_radio_lib_c_r_c.html#ab1b5aa578ed5818a7618df8c6cf98087"> 49</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_radio_lib_c_r_c.html#ab1b5aa578ed5818a7618df8c6cf98087">refOut</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="class_radio_lib_c_r_c.html#a4f4042a369d55e234f4fc28f189139d5">RadioLibCRC</a>();</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uint32_t <a class="code" href="class_radio_lib_c_r_c.html#a92328d778fe59c046c6e74296eb5fb23">checksum</a>(<span class="keyword">const</span> uint8_t* buff, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> };</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// the global singleton</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">extern</span> <a class="code" href="class_radio_lib_c_r_c.html">RadioLibCRC</a> RadioLibCRCInstance;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html"><div class="ttname"><a href="class_radio_lib_c_r_c.html">RadioLibCRC</a></div><div class="ttdoc">Class to calculate CRCs of varying formats.</div><div class="ttdef"><b>Definition:</b> CRC.h:19</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_a46616ef58e9eeeca646de0c9fe681050"><div class="ttname"><a href="class_radio_lib_c_r_c.html#a46616ef58e9eeeca646de0c9fe681050">RadioLibCRC::out</a></div><div class="ttdeci">uint32_t out</div><div class="ttdoc">Final XOR value.</div><div class="ttdef"><b>Definition:</b> CRC.h:39</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_a4f4042a369d55e234f4fc28f189139d5"><div class="ttname"><a href="class_radio_lib_c_r_c.html#a4f4042a369d55e234f4fc28f189139d5">RadioLibCRC::RadioLibCRC</a></div><div class="ttdeci">RadioLibCRC()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> CRC.cpp:3</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_a579acc51fe7a01b0b9b3f2e0e57b7d5f"><div class="ttname"><a href="class_radio_lib_c_r_c.html#a579acc51fe7a01b0b9b3f2e0e57b7d5f">RadioLibCRC::init</a></div><div class="ttdeci">uint32_t init</div><div class="ttdoc">Initial value.</div><div class="ttdef"><b>Definition:</b> CRC.h:34</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_a92328d778fe59c046c6e74296eb5fb23"><div class="ttname"><a href="class_radio_lib_c_r_c.html#a92328d778fe59c046c6e74296eb5fb23">RadioLibCRC::checksum</a></div><div class="ttdeci">uint32_t checksum(const uint8_t *buff, size_t len)</div><div class="ttdoc">Calculate checksum of a buffer.</div><div class="ttdef"><b>Definition:</b> CRC.cpp:7</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_ab1b5aa578ed5818a7618df8c6cf98087"><div class="ttname"><a href="class_radio_lib_c_r_c.html#ab1b5aa578ed5818a7618df8c6cf98087">RadioLibCRC::refOut</a></div><div class="ttdeci">bool refOut</div><div class="ttdoc">Whether to reflect the result.</div><div class="ttdef"><b>Definition:</b> CRC.h:49</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_ac65a358753efd05067c19fcf1098ec04"><div class="ttname"><a href="class_radio_lib_c_r_c.html#ac65a358753efd05067c19fcf1098ec04">RadioLibCRC::refIn</a></div><div class="ttdeci">bool refIn</div><div class="ttdoc">Whether to reflect input bytes.</div><div class="ttdef"><b>Definition:</b> CRC.h:44</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_ad09b067c00cda1cc676c13602dee2f5a"><div class="ttname"><a href="class_radio_lib_c_r_c.html#ad09b067c00cda1cc676c13602dee2f5a">RadioLibCRC::size</a></div><div class="ttdeci">uint8_t size</div><div class="ttdoc">CRC size in bits.</div><div class="ttdef"><b>Definition:</b> CRC.h:24</div></div>
|
|
<div class="ttc" id="aclass_radio_lib_c_r_c_html_af3942e08bde9d9d127f735bd10392f6d"><div class="ttname"><a href="class_radio_lib_c_r_c.html#af3942e08bde9d9d127f735bd10392f6d">RadioLibCRC::poly</a></div><div class="ttdeci">uint32_t poly</div><div class="ttdoc">CRC polynomial.</div><div class="ttdef"><b>Definition:</b> CRC.h:29</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_313caf1132e152dd9b58bea13a4052ca.html">utils</a></li><li class="navelem"><b>CRC.h</b></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|