555 lines
32 KiB
HTML
555 lines
32 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: CRC_Adapter</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="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.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="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('a00022.html','');});
|
|
</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)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">CRC_Adapter</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00335"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a00335">_hal_crc_config</a></td></tr>
|
|
<tr class="memdesc:a00335"><td class="mdescLeft"> </td><td class="mdescRight">CRC configuration structure. <a href="a00022.html#a00335">More...</a><br/></td></tr>
|
|
<tr class="separator:a00335"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gab75716944b982b7dd9033e44a242ce38"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00022.html#ga8bc145db4573dce98c82484265c3342b">_hal_crc_cfg_refin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#gab75716944b982b7dd9033e44a242ce38">hal_crc_cfg_refin_t</a></td></tr>
|
|
<tr class="memdesc:gab75716944b982b7dd9033e44a242ce38"><td class="mdescLeft"> </td><td class="mdescRight">crcRefIn definitions. <a href="#gab75716944b982b7dd9033e44a242ce38">More...</a><br/></td></tr>
|
|
<tr class="separator:gab75716944b982b7dd9033e44a242ce38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga635d6ca2a466f9f57ada5c9c32ca0add"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00022.html#gacdca6ac1352cf6e29d518e1966d53f7a">_hal_crc_cfg_refout</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ga635d6ca2a466f9f57ada5c9c32ca0add">hal_crc_cfg_refout_t</a></td></tr>
|
|
<tr class="memdesc:ga635d6ca2a466f9f57ada5c9c32ca0add"><td class="mdescLeft"> </td><td class="mdescRight">crcRefOut definitions. <a href="#ga635d6ca2a466f9f57ada5c9c32ca0add">More...</a><br/></td></tr>
|
|
<tr class="separator:ga635d6ca2a466f9f57ada5c9c32ca0add"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaea9ec2d512dcb42628ea90fe6eb7cd16"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00022.html#ga9a00699c6937e2539eeb1c9e7be1828d">_hal_crc_cfg_byteord</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#gaea9ec2d512dcb42628ea90fe6eb7cd16">hal_crc_cfg_byteord_t</a></td></tr>
|
|
<tr class="memdesc:gaea9ec2d512dcb42628ea90fe6eb7cd16"><td class="mdescLeft"> </td><td class="mdescRight">crcByteOrder definitions. <a href="#gaea9ec2d512dcb42628ea90fe6eb7cd16">More...</a><br/></td></tr>
|
|
<tr class="separator:gaea9ec2d512dcb42628ea90fe6eb7cd16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad7b3dbab91759d203438a455e22dc628"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00022.html#gab44ab35534299b2c38d874e0448a5854">_hal_crc_polynomial</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#gad7b3dbab91759d203438a455e22dc628">hal_crc_polynomial_t</a></td></tr>
|
|
<tr class="memdesc:gad7b3dbab91759d203438a455e22dc628"><td class="mdescLeft"> </td><td class="mdescRight">CRC polynomials to use. <a href="#gad7b3dbab91759d203438a455e22dc628">More...</a><br/></td></tr>
|
|
<tr class="separator:gad7b3dbab91759d203438a455e22dc628"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2cb27600c4049d9c16e4fc5aa3fedceb"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00022.html#a00335">_hal_crc_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ga2cb27600c4049d9c16e4fc5aa3fedceb">hal_crc_config_t</a></td></tr>
|
|
<tr class="memdesc:ga2cb27600c4049d9c16e4fc5aa3fedceb"><td class="mdescLeft"> </td><td class="mdescRight">CRC configuration structure. <a href="#ga2cb27600c4049d9c16e4fc5aa3fedceb">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2cb27600c4049d9c16e4fc5aa3fedceb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga8bc145db4573dce98c82484265c3342b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ga8bc145db4573dce98c82484265c3342b">_hal_crc_cfg_refin</a> { <br/>
|
|
  <a class="el" href="a00022.html#gga8bc145db4573dce98c82484265c3342ba15dc98651460a56dc3efd9cd5fd0d771">KHAL_CrcInputNoRef</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00022.html#gga8bc145db4573dce98c82484265c3342ba00826d7f98eae45c6b99149e0b702ab6">KHAL_CrcRefInput</a> = 1U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga8bc145db4573dce98c82484265c3342b"><td class="mdescLeft"> </td><td class="mdescRight">crcRefIn definitions. <a href="a00022.html#ga8bc145db4573dce98c82484265c3342b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8bc145db4573dce98c82484265c3342b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacdca6ac1352cf6e29d518e1966d53f7a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#gacdca6ac1352cf6e29d518e1966d53f7a">_hal_crc_cfg_refout</a> { <br/>
|
|
  <a class="el" href="a00022.html#ggacdca6ac1352cf6e29d518e1966d53f7aaf1553d681ddaadf4ef9d0c0223dff02f">KHAL_CrcOutputNoRef</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00022.html#ggacdca6ac1352cf6e29d518e1966d53f7aa9cbbc2a13879d22a28ed3ae432eaf2ba">KHAL_CrcRefOutput</a> = 1U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gacdca6ac1352cf6e29d518e1966d53f7a"><td class="mdescLeft"> </td><td class="mdescRight">crcRefOut definitions. <a href="a00022.html#gacdca6ac1352cf6e29d518e1966d53f7a">More...</a><br/></td></tr>
|
|
<tr class="separator:gacdca6ac1352cf6e29d518e1966d53f7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9a00699c6937e2539eeb1c9e7be1828d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ga9a00699c6937e2539eeb1c9e7be1828d">_hal_crc_cfg_byteord</a> { <br/>
|
|
  <a class="el" href="a00022.html#gga9a00699c6937e2539eeb1c9e7be1828da26d0908db565dadc777d1e41e1bff629">KHAL_CrcLSByteFirst</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00022.html#gga9a00699c6937e2539eeb1c9e7be1828da63253867900666bd065720690d94128d">KHAL_CrcMSByteFirst</a> = 1U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga9a00699c6937e2539eeb1c9e7be1828d"><td class="mdescLeft"> </td><td class="mdescRight">crcByteOrder definitions. <a href="a00022.html#ga9a00699c6937e2539eeb1c9e7be1828d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9a00699c6937e2539eeb1c9e7be1828d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab44ab35534299b2c38d874e0448a5854"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#gab44ab35534299b2c38d874e0448a5854">_hal_crc_polynomial</a> { <br/>
|
|
  <a class="el" href="a00022.html#ggab44ab35534299b2c38d874e0448a5854aaa1af8f11b9ec3fa5b5e8981bb927934">KHAL_CrcPolynomial_CRC_8_CCITT</a> = 0x103,
|
|
<br/>
|
|
  <a class="el" href="a00022.html#ggab44ab35534299b2c38d874e0448a5854a13860dbbcf817e5a9d6e7a470faf5c6d">KHAL_CrcPolynomial_CRC_16</a> = 0x1021,
|
|
<br/>
|
|
  <a class="el" href="a00022.html#ggab44ab35534299b2c38d874e0448a5854afc524a4e62b90bd0bf21f53bbda88829">KHAL_CrcPolynomial_CRC_32</a> = 0x4C11DB7U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gab44ab35534299b2c38d874e0448a5854"><td class="mdescLeft"> </td><td class="mdescRight">CRC polynomials to use. <a href="a00022.html#gab44ab35534299b2c38d874e0448a5854">More...</a><br/></td></tr>
|
|
<tr class="separator:gab44ab35534299b2c38d874e0448a5854"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
CRC</h2></td></tr>
|
|
<tr class="memitem:gacfcdec9d606aed3613b071ea6f389bf7"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#gacfcdec9d606aed3613b071ea6f389bf7">HAL_CrcCompute</a> (<a class="el" href="a00022.html#ga2cb27600c4049d9c16e4fc5aa3fedceb">hal_crc_config_t</a> *crcConfig, uint8_t *dataIn, uint32_t length)</td></tr>
|
|
<tr class="memdesc:gacfcdec9d606aed3613b071ea6f389bf7"><td class="mdescLeft"> </td><td class="mdescRight">Compute CRC function. <a href="#gacfcdec9d606aed3613b071ea6f389bf7">More...</a><br/></td></tr>
|
|
<tr class="separator:gacfcdec9d606aed3613b071ea6f389bf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00335" id="a00335"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _hal_crc_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a65bf823118885cafe1996cdda07b50ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#gab75716944b982b7dd9033e44a242ce38">hal_crc_cfg_refin_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a65bf823118885cafe1996cdda07b50ad">crcRefIn</a></td></tr>
|
|
<tr class="memdesc:a65bf823118885cafe1996cdda07b50ad"><td class="mdescLeft"> </td><td class="mdescRight">CRC reflect input. <a href="#a65bf823118885cafe1996cdda07b50ad">More...</a><br/></td></tr>
|
|
<tr class="separator:a65bf823118885cafe1996cdda07b50ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45cbf9819ceed125fca8ad33cde19c90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#ga635d6ca2a466f9f57ada5c9c32ca0add">hal_crc_cfg_refout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a45cbf9819ceed125fca8ad33cde19c90">crcRefOut</a></td></tr>
|
|
<tr class="memdesc:a45cbf9819ceed125fca8ad33cde19c90"><td class="mdescLeft"> </td><td class="mdescRight">CRC reflect output. <a href="#a45cbf9819ceed125fca8ad33cde19c90">More...</a><br/></td></tr>
|
|
<tr class="separator:a45cbf9819ceed125fca8ad33cde19c90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada136dc9167bb0b51a19fadb914187db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#gaea9ec2d512dcb42628ea90fe6eb7cd16">hal_crc_cfg_byteord_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ada136dc9167bb0b51a19fadb914187db">crcByteOrder</a></td></tr>
|
|
<tr class="memdesc:ada136dc9167bb0b51a19fadb914187db"><td class="mdescLeft"> </td><td class="mdescRight">CRC byte order. <a href="#ada136dc9167bb0b51a19fadb914187db">More...</a><br/></td></tr>
|
|
<tr class="separator:ada136dc9167bb0b51a19fadb914187db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a880e49eb1dee8e99f2163d00c596a484"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a880e49eb1dee8e99f2163d00c596a484">crcSeed</a></td></tr>
|
|
<tr class="memdesc:a880e49eb1dee8e99f2163d00c596a484"><td class="mdescLeft"> </td><td class="mdescRight">CRC Seed value. <a href="#a880e49eb1dee8e99f2163d00c596a484">More...</a><br/></td></tr>
|
|
<tr class="separator:a880e49eb1dee8e99f2163d00c596a484"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c9459665ce1c76f5faa21705fff8aa9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a0c9459665ce1c76f5faa21705fff8aa9">crcPoly</a></td></tr>
|
|
<tr class="memdesc:a0c9459665ce1c76f5faa21705fff8aa9"><td class="mdescLeft"> </td><td class="mdescRight">CRC Polynomial value. <a href="#a0c9459665ce1c76f5faa21705fff8aa9">More...</a><br/></td></tr>
|
|
<tr class="separator:a0c9459665ce1c76f5faa21705fff8aa9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bf35f48e15de7ee862f16e41e15772d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a0bf35f48e15de7ee862f16e41e15772d">crcXorOut</a></td></tr>
|
|
<tr class="memdesc:a0bf35f48e15de7ee862f16e41e15772d"><td class="mdescLeft"> </td><td class="mdescRight">XOR mask for CRC result (for no mask, should be 0). <a href="#a0bf35f48e15de7ee862f16e41e15772d">More...</a><br/></td></tr>
|
|
<tr class="separator:a0bf35f48e15de7ee862f16e41e15772d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6453a8d2d08377dbfceb6447a4a0f453"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a6453a8d2d08377dbfceb6447a4a0f453">complementChecksum</a></td></tr>
|
|
<tr class="memdesc:a6453a8d2d08377dbfceb6447a4a0f453"><td class="mdescLeft"> </td><td class="mdescRight">wether output the complement checksum. <a href="#a6453a8d2d08377dbfceb6447a4a0f453">More...</a><br/></td></tr>
|
|
<tr class="separator:a6453a8d2d08377dbfceb6447a4a0f453"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa91fbdf1a7c7e0cb0d18e7c128b35977"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#aa91fbdf1a7c7e0cb0d18e7c128b35977">crcSize</a></td></tr>
|
|
<tr class="memdesc:aa91fbdf1a7c7e0cb0d18e7c128b35977"><td class="mdescLeft"> </td><td class="mdescRight">Number of CRC octets, 2 mean use CRC16, 4 mean use CRC32. <a href="#aa91fbdf1a7c7e0cb0d18e7c128b35977">More...</a><br/></td></tr>
|
|
<tr class="separator:aa91fbdf1a7c7e0cb0d18e7c128b35977"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34f5985e967ce15aefb801f35685cea7"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a34f5985e967ce15aefb801f35685cea7">crcStartByte</a></td></tr>
|
|
<tr class="memdesc:a34f5985e967ce15aefb801f35685cea7"><td class="mdescLeft"> </td><td class="mdescRight">Start CRC with this byte position. <a href="#a34f5985e967ce15aefb801f35685cea7">More...</a><br/></td></tr>
|
|
<tr class="separator:a34f5985e967ce15aefb801f35685cea7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a65bf823118885cafe1996cdda07b50ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#gab75716944b982b7dd9033e44a242ce38">hal_crc_cfg_refin_t</a> _hal_crc_config::crcRefIn</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>See "hal_crc_cfg_refin_t". </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a45cbf9819ceed125fca8ad33cde19c90"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#ga635d6ca2a466f9f57ada5c9c32ca0add">hal_crc_cfg_refout_t</a> _hal_crc_config::crcRefOut</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>See "hal_crc_cfg_refout_t". </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada136dc9167bb0b51a19fadb914187db"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#gaea9ec2d512dcb42628ea90fe6eb7cd16">hal_crc_cfg_byteord_t</a> _hal_crc_config::crcByteOrder</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>See "hal_crc_cfg_byteord_t". </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a880e49eb1dee8e99f2163d00c596a484"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _hal_crc_config::crcSeed</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initial value for CRC LFSR. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0c9459665ce1c76f5faa21705fff8aa9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _hal_crc_config::crcPoly</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0bf35f48e15de7ee862f16e41e15772d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _hal_crc_config::crcXorOut</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6453a8d2d08377dbfceb6447a4a0f453"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _hal_crc_config::complementChecksum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa91fbdf1a7c7e0cb0d18e7c128b35977"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _hal_crc_config::crcSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a34f5985e967ce15aefb801f35685cea7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _hal_crc_config::crcStartByte</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Byte #0 is the first byte of Sync Address. </p>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="gab75716944b982b7dd9033e44a242ce38"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00022.html#ga8bc145db4573dce98c82484265c3342b">_hal_crc_cfg_refin</a> <a class="el" href="a00022.html#gab75716944b982b7dd9033e44a242ce38">hal_crc_cfg_refin_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga635d6ca2a466f9f57ada5c9c32ca0add"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00022.html#gacdca6ac1352cf6e29d518e1966d53f7a">_hal_crc_cfg_refout</a> <a class="el" href="a00022.html#ga635d6ca2a466f9f57ada5c9c32ca0add">hal_crc_cfg_refout_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaea9ec2d512dcb42628ea90fe6eb7cd16"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00022.html#ga9a00699c6937e2539eeb1c9e7be1828d">_hal_crc_cfg_byteord</a> <a class="el" href="a00022.html#gaea9ec2d512dcb42628ea90fe6eb7cd16">hal_crc_cfg_byteord_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad7b3dbab91759d203438a455e22dc628"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00022.html#gab44ab35534299b2c38d874e0448a5854">_hal_crc_polynomial</a> <a class="el" href="a00022.html#gad7b3dbab91759d203438a455e22dc628">hal_crc_polynomial_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2cb27600c4049d9c16e4fc5aa3fedceb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00022.html#a00335">_hal_crc_config</a> <a class="el" href="a00022.html#ga2cb27600c4049d9c16e4fc5aa3fedceb">hal_crc_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga8bc145db4573dce98c82484265c3342b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00022.html#ga8bc145db4573dce98c82484265c3342b">_hal_crc_cfg_refin</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga8bc145db4573dce98c82484265c3342ba15dc98651460a56dc3efd9cd5fd0d771"></a>KHAL_CrcInputNoRef</em> </td><td class="fielddoc">
|
|
<p>Do not manipulate input data stream. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga8bc145db4573dce98c82484265c3342ba00826d7f98eae45c6b99149e0b702ab6"></a>KHAL_CrcRefInput</em> </td><td class="fielddoc">
|
|
<p>Reflect each byte in the input stream bitwise. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gacdca6ac1352cf6e29d518e1966d53f7a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00022.html#gacdca6ac1352cf6e29d518e1966d53f7a">_hal_crc_cfg_refout</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggacdca6ac1352cf6e29d518e1966d53f7aaf1553d681ddaadf4ef9d0c0223dff02f"></a>KHAL_CrcOutputNoRef</em> </td><td class="fielddoc">
|
|
<p>Do not manipulate CRC result. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggacdca6ac1352cf6e29d518e1966d53f7aa9cbbc2a13879d22a28ed3ae432eaf2ba"></a>KHAL_CrcRefOutput</em> </td><td class="fielddoc">
|
|
<p>CRC result is to be reflected bitwise (operated on entire word). </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9a00699c6937e2539eeb1c9e7be1828d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00022.html#ga9a00699c6937e2539eeb1c9e7be1828d">_hal_crc_cfg_byteord</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga9a00699c6937e2539eeb1c9e7be1828da26d0908db565dadc777d1e41e1bff629"></a>KHAL_CrcLSByteFirst</em> </td><td class="fielddoc">
|
|
<p>Byte order of the CRC LS Byte first. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga9a00699c6937e2539eeb1c9e7be1828da63253867900666bd065720690d94128d"></a>KHAL_CrcMSByteFirst</em> </td><td class="fielddoc">
|
|
<p>Bit order of the CRC MS Byte first. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab44ab35534299b2c38d874e0448a5854"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00022.html#gab44ab35534299b2c38d874e0448a5854">_hal_crc_polynomial</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggab44ab35534299b2c38d874e0448a5854aaa1af8f11b9ec3fa5b5e8981bb927934"></a>KHAL_CrcPolynomial_CRC_8_CCITT</em> </td><td class="fielddoc">
|
|
<p>x^8+x^2+x^1+1 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggab44ab35534299b2c38d874e0448a5854a13860dbbcf817e5a9d6e7a470faf5c6d"></a>KHAL_CrcPolynomial_CRC_16</em> </td><td class="fielddoc">
|
|
<p>x^16+x^12+x^5+1 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggab44ab35534299b2c38d874e0448a5854afc524a4e62b90bd0bf21f53bbda88829"></a>KHAL_CrcPolynomial_CRC_32</em> </td><td class="fielddoc">
|
|
<p>x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x+1 </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gacfcdec9d606aed3613b071ea6f389bf7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t HAL_CrcCompute </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00022.html#ga2cb27600c4049d9c16e4fc5aa3fedceb">hal_crc_config_t</a> * </td>
|
|
<td class="paramname"><em>crcConfig</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The function computes the CRC.</p>
|
|
<div class="fragment"><div class="line">* config = (<a class="code" href="a00022.html#ga2cb27600c4049d9c16e4fc5aa3fedceb">hal_crc_config_t</a>) {</div>
|
|
<div class="line">* .crcSize = 4,</div>
|
|
<div class="line">* .crcStartByte = 0,</div>
|
|
<div class="line">* .crcRefIn = <a class="code" href="a00022.html#gga8bc145db4573dce98c82484265c3342ba15dc98651460a56dc3efd9cd5fd0d771">KHAL_CrcInputNoRef</a>,</div>
|
|
<div class="line">* .crcRefOut = <a class="code" href="a00022.html#ggacdca6ac1352cf6e29d518e1966d53f7aaf1553d681ddaadf4ef9d0c0223dff02f">KHAL_CrcOutputNoRef</a>,</div>
|
|
<div class="line">* .crcByteOrder = <a class="code" href="a00022.html#gga9a00699c6937e2539eeb1c9e7be1828da63253867900666bd065720690d94128d">KHAL_CrcMSByteFirst</a>,</div>
|
|
<div class="line">* .complementChecksum = <span class="keyword">true</span>,</div>
|
|
<div class="line">* .crcSeed = 0xFFFFFFFF,</div>
|
|
<div class="line">* .crcPoly = <a class="code" href="a00022.html#ggab44ab35534299b2c38d874e0448a5854afc524a4e62b90bd0bf21f53bbda88829">KHAL_CrcPolynomial_CRC_32</a>,</div>
|
|
<div class="line">* .crcXorOut = 0xFFFFFFFF,</div>
|
|
<div class="line">* };</div>
|
|
<div class="line">*</div>
|
|
<div class="line">* res = <a class="code" href="a00022.html#gacfcdec9d606aed3613b071ea6f389bf7">HAL_CrcCompute</a>(&config, (uint8_t *) pattern, strlen(pattern));</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>The settings for compute CRC are taken from the passed CRC_config_t structure.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">crcConfig</td><td>configuration structure. </td></tr>
|
|
<tr><td class="paramname">dataIn</td><td>input data buffer. </td></tr>
|
|
<tr><td class="paramname">length</td><td>input data buffer size.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">Computed</td><td>CRC value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|