blob: 8bdc6bb802de3d073d60282c9d3b6f13f586f79d [file] [log] [blame]
<!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"/>
<title>Status Error Codes</title>
<title>CMSIS-Driver: Status Error Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.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>
</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: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
&#160;<span id="projectnumber">Version 2.7.1</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
<li><a href="modules.html"><span>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('group__can__status__code__ctrls.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Status Error Codes<div class="ingroups"><a class="el" href="group__can__interface__gr.html">CAN Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Status codes of the CAN driver.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga911a65cc31304d57d283a21476d9ade7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga911a65cc31304d57d283a21476d9ade7">ARM_CAN_UNIT_STATE_INACTIVE</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga911a65cc31304d57d283a21476d9ade7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Not active on bus (initialization) <a href="#ga911a65cc31304d57d283a21476d9ade7">More...</a><br/></td></tr>
<tr class="separator:ga911a65cc31304d57d283a21476d9ade7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga5f72c295ee2b829a8ae33b96466cc0e8">ARM_CAN_UNIT_STATE_ACTIVE</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Active on bus (can generate active error frame) <a href="#ga5f72c295ee2b829a8ae33b96466cc0e8">More...</a><br/></td></tr>
<tr class="separator:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace2db0f930f935054c21242f735e1922"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gace2db0f930f935054c21242f735e1922">ARM_CAN_UNIT_STATE_PASSIVE</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:gace2db0f930f935054c21242f735e1922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Error passive (can not generate active error frame) <a href="#gace2db0f930f935054c21242f735e1922">More...</a><br/></td></tr>
<tr class="separator:gace2db0f930f935054c21242f735e1922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd78b515410235cd77d0a10213ff4192"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gadd78b515410235cd77d0a10213ff4192">ARM_CAN_UNIT_STATE_BUS_OFF</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:gadd78b515410235cd77d0a10213ff4192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Bus-off (can recover to active state) <a href="#gadd78b515410235cd77d0a10213ff4192">More...</a><br/></td></tr>
<tr class="separator:gadd78b515410235cd77d0a10213ff4192"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5332a311f44caec256d59087c705e1e9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga5332a311f44caec256d59087c705e1e9">ARM_CAN_LEC_NO_ERROR</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga5332a311f44caec256d59087c705e1e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: No error. <a href="#ga5332a311f44caec256d59087c705e1e9">More...</a><br/></td></tr>
<tr class="separator:ga5332a311f44caec256d59087c705e1e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga0571c3c3e341ac0579aa713fdfdae77e">ARM_CAN_LEC_BIT_ERROR</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Bit error. <a href="#ga0571c3c3e341ac0579aa713fdfdae77e">More...</a><br/></td></tr>
<tr class="separator:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga33cbda311f4c2f2464e4070dee78b2f2">ARM_CAN_LEC_STUFF_ERROR</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Bit stuffing error. <a href="#ga33cbda311f4c2f2464e4070dee78b2f2">More...</a><br/></td></tr>
<tr class="separator:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1380f80b709ca921634aecdaf34a24e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga1380f80b709ca921634aecdaf34a24e5">ARM_CAN_LEC_CRC_ERROR</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:ga1380f80b709ca921634aecdaf34a24e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: CRC error. <a href="#ga1380f80b709ca921634aecdaf34a24e5">More...</a><br/></td></tr>
<tr class="separator:ga1380f80b709ca921634aecdaf34a24e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga9f753ba50045b28653fb3215ec2e4b8a">ARM_CAN_LEC_FORM_ERROR</a>&#160;&#160;&#160;(4U)</td></tr>
<tr class="memdesc:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Illegal fixed-form bit. <a href="#ga9f753ba50045b28653fb3215ec2e4b8a">More...</a><br/></td></tr>
<tr class="separator:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae6e827242137bc4d8976cd4ba73015f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gaae6e827242137bc4d8976cd4ba73015f">ARM_CAN_LEC_ACK_ERROR</a>&#160;&#160;&#160;(5U)</td></tr>
<tr class="memdesc:gaae6e827242137bc4d8976cd4ba73015f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Acknowledgment error. <a href="#gaae6e827242137bc4d8976cd4ba73015f">More...</a><br/></td></tr>
<tr class="separator:gaae6e827242137bc4d8976cd4ba73015f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Status codes of the CAN driver. </p>
<p>The following callback notification unit events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga911a65cc31304d57d283a21476d9ade7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_UNIT_STATE_INACTIVE&#160;&#160;&#160;(0U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit state: Not active on bus (initialization) </p>
</div>
</div>
<a class="anchor" id="ga5f72c295ee2b829a8ae33b96466cc0e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_UNIT_STATE_ACTIVE&#160;&#160;&#160;(1U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit state: Active on bus (can generate active error frame) </p>
</div>
</div>
<a class="anchor" id="gace2db0f930f935054c21242f735e1922"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_UNIT_STATE_PASSIVE&#160;&#160;&#160;(2U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit state: Error passive (can not generate active error frame) </p>
</div>
</div>
<a class="anchor" id="gadd78b515410235cd77d0a10213ff4192"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_UNIT_STATE_BUS_OFF&#160;&#160;&#160;(3U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit state: Bus-off (can recover to active state) </p>
</div>
</div>
<a class="anchor" id="ga5332a311f44caec256d59087c705e1e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_LEC_NO_ERROR&#160;&#160;&#160;(0U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last error code: No error. </p>
</div>
</div>
<a class="anchor" id="ga0571c3c3e341ac0579aa713fdfdae77e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_LEC_BIT_ERROR&#160;&#160;&#160;(1U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last error code: Bit error. </p>
</div>
</div>
<a class="anchor" id="ga33cbda311f4c2f2464e4070dee78b2f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_LEC_STUFF_ERROR&#160;&#160;&#160;(2U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last error code: Bit stuffing error. </p>
</div>
</div>
<a class="anchor" id="ga1380f80b709ca921634aecdaf34a24e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_LEC_CRC_ERROR&#160;&#160;&#160;(3U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last error code: CRC error. </p>
</div>
</div>
<a class="anchor" id="ga9f753ba50045b28653fb3215ec2e4b8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_LEC_FORM_ERROR&#160;&#160;&#160;(4U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last error code: Illegal fixed-form bit. </p>
</div>
</div>
<a class="anchor" id="gaae6e827242137bc4d8976cd4ba73015f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_LEC_ACK_ERROR&#160;&#160;&#160;(5U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last error code: Acknowledgment error. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>