code stringlengths 1 1.05M | repo_name stringlengths 6 83 | path stringlengths 3 242 | language stringclasses 222
values | license stringclasses 20
values | size int64 1 1.05M |
|---|---|---|---|---|---|
<!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>Globals</title>
<title>CMSIS-Driver: Globals</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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 id="navrow3" class="tabs2">
<ul class="tablist">
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li class="current"><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Macros</span></a></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('globals_type.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="contents">
 <ul>
<li>ARM_CAN_SignalObjectEvent_t
: <a class="el" href="group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb">Driver_CAN.h</a>
</li>
<li>ARM_CAN_SignalUnitEvent_t
: <a class="el" href="group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e">Driver_CAN.h</a>
</li>
<li>ARM_ETH_MAC_SignalEvent_t
: <a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">Driver_ETH_MAC.h</a>
</li>
<li>ARM_ETH_PHY_Read_t
: <a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">Driver_ETH_PHY.h</a>
</li>
<li>ARM_ETH_PHY_Write_t
: <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">Driver_ETH_PHY.h</a>
</li>
<li>ARM_Flash_SignalEvent_t
: <a class="el" href="group__flash__interface__gr.html#gabeb4ad43b1e6fa4ed956cd5c9371d327">Driver_Flash.h</a>
</li>
<li>ARM_I2C_SignalEvent_t
: <a class="el" href="group__i2c__interface__gr.html#ga24277c48248a09b0dd7f12bbe22ce13c">Driver_I2C.h</a>
</li>
<li>ARM_MCI_SignalEvent_t
: <a class="el" href="group__mci__interface__gr.html#ga0d14651f6788c1ffd81544602565faf1">Driver_MCI.h</a>
</li>
<li>ARM_NAND_SignalEvent_t
: <a class="el" href="group__nand__interface__gr.html#ga09f4cf2f2df0bb690bce38b13d77e50f">Driver_NAND.h</a>
</li>
<li>ARM_SAI_SignalEvent_t
: <a class="el" href="group__sai__interface__gr.html#gad8ca8e2459e540928f6315b3df6da0ee">Driver_SAI.h</a>
</li>
<li>ARM_SPI_SignalEvent_t
: <a class="el" href="group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640">Driver_SPI.h</a>
</li>
<li>ARM_Storage_Callback_t
: <a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">Driver_Storage.h</a>
</li>
<li>ARM_USART_SignalEvent_t
: <a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">Driver_USART.h</a>
</li>
<li>ARM_USBD_SignalDeviceEvent_t
: <a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">Driver_USBD.h</a>
</li>
<li>ARM_USBD_SignalEndpointEvent_t
: <a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">Driver_USBD.h</a>
</li>
<li>ARM_USBH_HCI_Interrupt_t
: <a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PIPE_HANDLE
: <a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">Driver_USBH.h</a>
</li>
<li>ARM_USBH_SignalPipeEvent_t
: <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">Driver_USBH.h</a>
</li>
<li>ARM_USBH_SignalPortEvent_t
: <a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">Driver_USBH.h</a>
</li>
<li>ARM_WIFI_SignalEvent_t
: <a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">Driver_WiFi.h</a>
</li>
</ul>
</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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/globals_type.html | HTML | apache-2.0 | 9,418 |
<!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>Globals</title>
<title>CMSIS-Driver: Globals</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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 id="navrow3" class="tabs2">
<ul class="tablist">
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Macros</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="globals.html#index__"><span>_</span></a></li>
<li><a href="globals_c.html#index_c"><span>c</span></a></li>
<li><a href="globals_d.html#index_d"><span>d</span></a></li>
<li><a href="globals_e.html#index_e"><span>e</span></a></li>
<li><a href="globals_f.html#index_f"><span>f</span></a></li>
<li><a href="globals_i.html#index_i"><span>i</span></a></li>
<li><a href="globals_m.html#index_m"><span>m</span></a></li>
<li><a href="globals_n.html#index_n"><span>n</span></a></li>
<li><a href="globals_p.html#index_p"><span>p</span></a></li>
<li><a href="globals_r.html#index_r"><span>r</span></a></li>
<li><a href="globals_s.html#index_s"><span>s</span></a></li>
<li class="current"><a href="globals_u.html#index_u"><span>u</span></a></li>
<li><a href="globals_w.html#index_w"><span>w</span></a></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('globals_u.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="contents">
<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div>
<h3><a class="anchor" id="index_u"></a>- u -</h3><ul>
<li>ARM_USART_ABORT_RECEIVE
: <a class="el" href="group__usart__misc__control.html#ga3f57bcedf610dc844e6cc3a230dba5f7">Driver_USART.h</a>
</li>
<li>ARM_USART_ABORT_SEND
: <a class="el" href="group__usart__misc__control.html#ga54e88b32bc7368ff9c44613eae735c44">Driver_USART.h</a>
</li>
<li>ARM_USART_ABORT_TRANSFER
: <a class="el" href="group__usart__misc__control.html#ga83d0ef402feb342f9939f0e4ffe26182">Driver_USART.h</a>
</li>
<li>ARM_USART_API_VERSION
: <a class="el" href="Driver__USART_8h.html#ab37a12fd0981e09c42ea42684a5dfbab">Driver_USART.h</a>
</li>
<li>ARM_USART_Control()
: <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">Driver_USART.c</a>
</li>
<li>ARM_USART_CONTROL_BREAK
: <a class="el" href="group__usart__misc__control.html#gab194a6f916e5b25e0262534c0cce54dc">Driver_USART.h</a>
</li>
<li>ARM_USART_CONTROL_Msk
: <a class="el" href="Driver__USART_8h.html#a253d29333d1a40d0401a02f9675a90fd">Driver_USART.h</a>
</li>
<li>ARM_USART_CONTROL_Pos
: <a class="el" href="Driver__USART_8h.html#ab654e36e71012c28b91273e96827e1b8">Driver_USART.h</a>
</li>
<li>ARM_USART_CONTROL_RX
: <a class="el" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">Driver_USART.h</a>
</li>
<li>ARM_USART_CONTROL_SMART_CARD_NACK
: <a class="el" href="group__usart__misc__control.html#ga4bb5374e7db308b6ff48aa13aa9c4b8a">Driver_USART.h</a>
</li>
<li>ARM_USART_CONTROL_TX
: <a class="el" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">Driver_USART.h</a>
</li>
<li>ARM_USART_CPHA0
: <a class="el" href="group__usart__clock__phase.html#ga5eb27c2294b7d14a20d0c7e2ef0a47b4">Driver_USART.h</a>
</li>
<li>ARM_USART_CPHA1
: <a class="el" href="group__usart__clock__phase.html#ga4b9f16371870476739a198c52dba6862">Driver_USART.h</a>
</li>
<li>ARM_USART_CPHA_Msk
: <a class="el" href="Driver__USART_8h.html#afba3e5931503b5a820472c4610252d72">Driver_USART.h</a>
</li>
<li>ARM_USART_CPHA_Pos
: <a class="el" href="Driver__USART_8h.html#a01ec7322a6a62197e82e948b1a8a41fa">Driver_USART.h</a>
</li>
<li>ARM_USART_CPOL0
: <a class="el" href="group__usart__clock__polarity.html#ga472d459abb99f1caaff94fa0cdd2ad27">Driver_USART.h</a>
</li>
<li>ARM_USART_CPOL1
: <a class="el" href="group__usart__clock__polarity.html#ga9e5541d8937a9d92e42aeb273138592a">Driver_USART.h</a>
</li>
<li>ARM_USART_CPOL_Msk
: <a class="el" href="Driver__USART_8h.html#a2424397076d0479ab6b83e557be35db2">Driver_USART.h</a>
</li>
<li>ARM_USART_CPOL_Pos
: <a class="el" href="Driver__USART_8h.html#a76148e4ea9d9e8a798e904e1d65d5dfc">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_5
: <a class="el" href="group__usart__data__bits.html#ga981ff25b4ff806f743d1af4575b87339">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_6
: <a class="el" href="group__usart__data__bits.html#ga92ba3d6cea5cd5c0b661667539a9e43c">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_7
: <a class="el" href="group__usart__data__bits.html#gad86a2d971ce521c6f6eda28d4f8786a4">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_8
: <a class="el" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_9
: <a class="el" href="group__usart__data__bits.html#gae238a08198dc7ac6178ae0a2a95a2764">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_Msk
: <a class="el" href="Driver__USART_8h.html#a84581b0925c149db3ca28d2656107656">Driver_USART.h</a>
</li>
<li>ARM_USART_DATA_BITS_Pos
: <a class="el" href="Driver__USART_8h.html#a08696262ebd491edf1e7865ebe93a81f">Driver_USART.h</a>
</li>
<li>ARM_USART_DTR_CLEAR
: <a class="el" href="Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c">Driver_USART.h</a>
</li>
<li>ARM_USART_DTR_SET
: <a class="el" href="Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_BAUDRATE
: <a class="el" href="group__usart__execution__status.html#gab57c4e8d4cb3a4b73751a002f5ec4586">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_CPHA
: <a class="el" href="group__usart__execution__status.html#gade1af23c4ed5409dacd99ab76dc2ff8b">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_CPOL
: <a class="el" href="group__usart__execution__status.html#ga2a1cd0a1e1bce9b545b0d7854a6fd6d6">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_DATA_BITS
: <a class="el" href="group__usart__execution__status.html#gaade95ddec6882e96c086dfe8e0ba9a4c">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_FLOW_CONTROL
: <a class="el" href="group__usart__execution__status.html#gaf8fea8d43ff72c76434d8b5e9eebd890">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_MODE
: <a class="el" href="group__usart__execution__status.html#gaa98f35611ec5bd7034f21cb47199322b">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_PARITY
: <a class="el" href="group__usart__execution__status.html#gaefabd886c586a45f4f7346c1f04392d0">Driver_USART.h</a>
</li>
<li>ARM_USART_ERROR_STOP_BITS
: <a class="el" href="group__usart__execution__status.html#ga1d699654fbbed3ca41c5ea10aac8f859">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_CTS
: <a class="el" href="group__USART__events.html#ga4cd807ca131bdcb1a7eb4f223fa70476">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_DCD
: <a class="el" href="group__USART__events.html#ga1628b951feba1c851f424ce89da409a4">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_DSR
: <a class="el" href="group__USART__events.html#ga5afef591c2e8dd9bc4332b7bc8d96309">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RECEIVE_COMPLETE
: <a class="el" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RI
: <a class="el" href="group__USART__events.html#gac17fe5723d4c5923656dadd9d1302154">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RX_BREAK
: <a class="el" href="group__USART__events.html#gaa1d19e48faf2bdc2a976de448928288e">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RX_FRAMING_ERROR
: <a class="el" href="group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RX_OVERFLOW
: <a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RX_PARITY_ERROR
: <a class="el" href="group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_RX_TIMEOUT
: <a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_SEND_COMPLETE
: <a class="el" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_TRANSFER_COMPLETE
: <a class="el" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_TX_COMPLETE
: <a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">Driver_USART.h</a>
</li>
<li>ARM_USART_EVENT_TX_UNDERFLOW
: <a class="el" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">Driver_USART.h</a>
</li>
<li>ARM_USART_FLOW_CONTROL_CTS
: <a class="el" href="group__usart__flow__control.html#gaa7b38ebff1ce0f5c3e4479d22e66715f">Driver_USART.h</a>
</li>
<li>ARM_USART_FLOW_CONTROL_Msk
: <a class="el" href="Driver__USART_8h.html#a0e80cb6a6f47c164fb1fe5fe8eab43f4">Driver_USART.h</a>
</li>
<li>ARM_USART_FLOW_CONTROL_NONE
: <a class="el" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">Driver_USART.h</a>
</li>
<li>ARM_USART_FLOW_CONTROL_Pos
: <a class="el" href="Driver__USART_8h.html#a2e09a6b54db30327511241fdf422c4c9">Driver_USART.h</a>
</li>
<li>ARM_USART_FLOW_CONTROL_RTS
: <a class="el" href="group__usart__flow__control.html#ga80c8a78e8868165cfcc543105bfd9621">Driver_USART.h</a>
</li>
<li>ARM_USART_FLOW_CONTROL_RTS_CTS
: <a class="el" href="group__usart__flow__control.html#gab16151b5c376b41586faf033f4a42d02">Driver_USART.h</a>
</li>
<li>ARM_USART_GetCapabilities()
: <a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">Driver_USART.c</a>
</li>
<li>ARM_USART_GetModemStatus()
: <a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">Driver_USART.c</a>
</li>
<li>ARM_USART_GetRxCount()
: <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">Driver_USART.c</a>
</li>
<li>ARM_USART_GetStatus()
: <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">Driver_USART.c</a>
</li>
<li>ARM_USART_GetTxCount()
: <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">Driver_USART.c</a>
</li>
<li>ARM_USART_GetVersion()
: <a class="el" href="group__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">Driver_USART.c</a>
</li>
<li>ARM_USART_Initialize()
: <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">Driver_USART.c</a>
</li>
<li>ARM_USART_MODE_ASYNCHRONOUS
: <a class="el" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">Driver_USART.h</a>
</li>
<li>ARM_USART_MODE_IRDA
: <a class="el" href="group__usart__mode__control.html#ga458f4f60d1d772cfd7567ae424d9aad9">Driver_USART.h</a>
</li>
<li>ARM_USART_MODE_SINGLE_WIRE
: <a class="el" href="group__usart__mode__control.html#ga4132136971d4f93f2e6a87c6775a9bb0">Driver_USART.h</a>
</li>
<li>ARM_USART_MODE_SMART_CARD
: <a class="el" href="group__usart__mode__control.html#gade65a1c27d9097d9ef0e86c02b55cecd">Driver_USART.h</a>
</li>
<li>ARM_USART_MODE_SYNCHRONOUS_MASTER
: <a class="el" href="group__usart__mode__control.html#ga7d3e9e0e838a3f15f8661983b9ac4573">Driver_USART.h</a>
</li>
<li>ARM_USART_MODE_SYNCHRONOUS_SLAVE
: <a class="el" href="group__usart__mode__control.html#gae78778475f3fab09a080c2279afc69fa">Driver_USART.h</a>
</li>
<li>ARM_USART_MODEM_CONTROL
: <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">Driver_USART.h</a>
</li>
<li>ARM_USART_PARITY_EVEN
: <a class="el" href="group__usart__parity__bit.html#gabc35e8dd2cbebb730abf36959e87a207">Driver_USART.h</a>
</li>
<li>ARM_USART_PARITY_Msk
: <a class="el" href="Driver__USART_8h.html#a434c48980c65129c01aa5bc1c8e22898">Driver_USART.h</a>
</li>
<li>ARM_USART_PARITY_NONE
: <a class="el" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">Driver_USART.h</a>
</li>
<li>ARM_USART_PARITY_ODD
: <a class="el" href="group__usart__parity__bit.html#ga02f30181eedd3b04d650dd507bf40d6d">Driver_USART.h</a>
</li>
<li>ARM_USART_PARITY_Pos
: <a class="el" href="Driver__USART_8h.html#a2ce50af2e58db12c25a5791080aca258">Driver_USART.h</a>
</li>
<li>ARM_USART_PowerControl()
: <a class="el" href="group__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">Driver_USART.c</a>
</li>
<li>ARM_USART_Receive()
: <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">Driver_USART.c</a>
</li>
<li>ARM_USART_RTS_CLEAR
: <a class="el" href="Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6">Driver_USART.h</a>
</li>
<li>ARM_USART_RTS_SET
: <a class="el" href="Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434">Driver_USART.h</a>
</li>
<li>ARM_USART_Send()
: <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">Driver_USART.c</a>
</li>
<li>ARM_USART_SET_DEFAULT_TX_VALUE
: <a class="el" href="group__usart__misc__control.html#gacd6f060afd55ffa1422567c31ebad950">Driver_USART.h</a>
</li>
<li>ARM_USART_SET_IRDA_PULSE
: <a class="el" href="group__usart__misc__control.html#gab8565d1f26382e832327e4553d18eb02">Driver_USART.h</a>
</li>
<li>ARM_USART_SET_SMART_CARD_CLOCK
: <a class="el" href="group__usart__misc__control.html#ga79698a2bd564c1f5bb1829ea422e9d3d">Driver_USART.h</a>
</li>
<li>ARM_USART_SET_SMART_CARD_GUARD_TIME
: <a class="el" href="group__usart__misc__control.html#ga169be809adc186c131bb8b1618005b28">Driver_USART.h</a>
</li>
<li>ARM_USART_SetModemControl()
: <a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">Driver_USART.c</a>
</li>
<li>ARM_USART_SignalEvent()
: <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">Driver_USART.c</a>
</li>
<li>ARM_USART_SignalEvent_t
: <a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">Driver_USART.h</a>
</li>
<li>ARM_USART_STOP_BITS_0_5
: <a class="el" href="group__usart__stop__bits.html#ga47f43cb83d9955a4c90d918acaaa44ba">Driver_USART.h</a>
</li>
<li>ARM_USART_STOP_BITS_1
: <a class="el" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">Driver_USART.h</a>
</li>
<li>ARM_USART_STOP_BITS_1_5
: <a class="el" href="group__usart__stop__bits.html#gafc1d0f2c95a76ef4c5152792a619f136">Driver_USART.h</a>
</li>
<li>ARM_USART_STOP_BITS_2
: <a class="el" href="group__usart__stop__bits.html#ga17f034b5f0d0328dc636b403d1954795">Driver_USART.h</a>
</li>
<li>ARM_USART_STOP_BITS_Msk
: <a class="el" href="Driver__USART_8h.html#aff72dd7b794cf2be5b5edca180be7a40">Driver_USART.h</a>
</li>
<li>ARM_USART_STOP_BITS_Pos
: <a class="el" href="Driver__USART_8h.html#ac73d045a0058006dbdc64a6d43772217">Driver_USART.h</a>
</li>
<li>ARM_USART_Transfer()
: <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">Driver_USART.c</a>
</li>
<li>ARM_USART_Uninitialize()
: <a class="el" href="group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">Driver_USART.c</a>
</li>
<li>ARM_USB_ENDPOINT_BULK
: <a class="el" href="group__USB__endpoint__type.html#gac80fcc73aada5562e35e4bf2c21b7b2d">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_CONTROL
: <a class="el" href="group__USB__endpoint__type.html#gaf8df4a353e829cf41a9f712e1b3c93a1">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_DIRECTION_MASK
: <a class="el" href="Driver__USB_8h.html#afc3be8e98be7a242c81cd677996f21d8">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_INTERRUPT
: <a class="el" href="group__USB__endpoint__type.html#ga9375cd3a2735e7d5c8c359a1cdbc7d95">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_ISOCHRONOUS
: <a class="el" href="group__USB__endpoint__type.html#gabb5913e9d1434240588ec43722d3eb16">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_MAX_PACKET_SIZE_MASK
: <a class="el" href="Driver__USB_8h.html#acdacc3b2d7854566a90f0fe265a96f9d">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_MICROFRAME_TRANSACTIONS_1
: <a class="el" href="Driver__USB_8h.html#aff3c2adf06d5dc8ccb3622b5860b380c">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_MICROFRAME_TRANSACTIONS_2
: <a class="el" href="Driver__USB_8h.html#afd061484f2de3a75e89b126f6ed21226">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_MICROFRAME_TRANSACTIONS_3
: <a class="el" href="Driver__USB_8h.html#a7c23bf8680f3feaf444d289df3603c38">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_MICROFRAME_TRANSACTIONS_MASK
: <a class="el" href="Driver__USB_8h.html#a72544ba674dc6d32c9caffcf9083fdfd">Driver_USB.h</a>
</li>
<li>ARM_USB_ENDPOINT_NUMBER_MASK
: <a class="el" href="Driver__USB_8h.html#a6ef3e2cf16ee3b1356947a17e5d42a6c">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_ACK
: <a class="el" href="Driver__USB_8h.html#a27505b779f79c82f3d7e63f7841b9c98">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_DATA0
: <a class="el" href="Driver__USB_8h.html#a047d50d8c7ffa89fb75608cce2756ac6">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_DATA1
: <a class="el" href="Driver__USB_8h.html#ab46f4fe90edf21e8e88f21a07876d88d">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_DATA2
: <a class="el" href="Driver__USB_8h.html#af3462fb5987bcda04963c7fd02461ced">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_ERR
: <a class="el" href="Driver__USB_8h.html#a56e57da4c1665866bf48a4bff4fa36b7">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_IN
: <a class="el" href="Driver__USB_8h.html#adb2459ddd000755c1ea52183bb8c55bb">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_MDATA
: <a class="el" href="Driver__USB_8h.html#ad78b3806a0963b041135a76eaf2fcd73">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_NAK
: <a class="el" href="Driver__USB_8h.html#a3a0de1078536cc459dd21d9b87b952f5">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_NYET
: <a class="el" href="Driver__USB_8h.html#ab4f0fb1af1b2257eef132a684a58b62b">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_OUT
: <a class="el" href="Driver__USB_8h.html#a828674d5225de2aadf7fb764a22e74f3">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_PING
: <a class="el" href="Driver__USB_8h.html#a2249b4907c4e9fa63a9d5685a6525ae6">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_PRE
: <a class="el" href="Driver__USB_8h.html#aa044bae2705c08f38d6cc40bc32d0323">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_RESERVED
: <a class="el" href="Driver__USB_8h.html#a8a8e917e48e97820b08e36b3da87f678">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_SETUP
: <a class="el" href="Driver__USB_8h.html#a08d69b2a1e3d5ef4ef1a36f591ea0df6">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_SOF
: <a class="el" href="Driver__USB_8h.html#ab8945ae385d3e7d0da9ba9ff461e09c1">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_SPLIT
: <a class="el" href="Driver__USB_8h.html#a136c540358ff3ec0007a7fee6ddcf308">Driver_USB.h</a>
</li>
<li>ARM_USB_PID_STALL
: <a class="el" href="Driver__USB_8h.html#ab7f3d6c2acab8b6b607ff7c063c11444">Driver_USB.h</a>
</li>
<li>ARM_USB_PIN_DM
: <a class="el" href="Driver__USB_8h.html#a5a5348d08c911233e4e9d81d1c42a367">Driver_USB.h</a>
</li>
<li>ARM_USB_PIN_DP
: <a class="el" href="Driver__USB_8h.html#a7f42a0ff2d6e9187428a0126cc140c5b">Driver_USB.h</a>
</li>
<li>ARM_USB_PIN_ID
: <a class="el" href="Driver__USB_8h.html#a03a103d754d9751485b748cd144cbfd7">Driver_USB.h</a>
</li>
<li>ARM_USB_PIN_OC
: <a class="el" href="Driver__USB_8h.html#a03ae07428733660d5e187fec1aede075">Driver_USB.h</a>
</li>
<li>ARM_USB_PIN_VBUS
: <a class="el" href="Driver__USB_8h.html#a390491e93356426de470ae41302dd547">Driver_USB.h</a>
</li>
<li>ARM_USB_ROLE_DEVICE
: <a class="el" href="Driver__USB_8h.html#ab67eb404d64392b8910d7fdaef01aa0d">Driver_USB.h</a>
</li>
<li>ARM_USB_ROLE_HOST
: <a class="el" href="Driver__USB_8h.html#ab21de5df4cadf9bc4381c8c1066205d8">Driver_USB.h</a>
</li>
<li>ARM_USB_ROLE_NONE
: <a class="el" href="Driver__USB_8h.html#a2cb4a6a3dc939c3b13021be266f23e76">Driver_USB.h</a>
</li>
<li>ARM_USB_SPEED_FULL
: <a class="el" href="group__USB__speed.html#ga0d1b465db654b651dcf588c8b59899d5">Driver_USB.h</a>
</li>
<li>ARM_USB_SPEED_HIGH
: <a class="el" href="group__USB__speed.html#ga13fa1e1934021f744dba837776205c89">Driver_USB.h</a>
</li>
<li>ARM_USB_SPEED_LOW
: <a class="el" href="group__USB__speed.html#gae44fe8958474cd90f2288ea27752df27">Driver_USB.h</a>
</li>
<li>ARM_USBD_API_VERSION
: <a class="el" href="Driver__USBD_8h.html#a71df406694e557f19cae5e43ff1960ba">Driver_USBD.h</a>
</li>
<li>ARM_USBD_DeviceConnect()
: <a class="el" href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca">Driver_USBD.c</a>
</li>
<li>ARM_USBD_DeviceDisconnect()
: <a class="el" href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1">Driver_USBD.c</a>
</li>
<li>ARM_USBD_DeviceGetState()
: <a class="el" href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2">Driver_USBD.c</a>
</li>
<li>ARM_USBD_DeviceRemoteWakeup()
: <a class="el" href="group__usbd__interface__gr.html#ga7e149a4c6a0196da24a44f4fada75fb1">Driver_USBD.c</a>
</li>
<li>ARM_USBD_DeviceSetAddress()
: <a class="el" href="group__usbd__interface__gr.html#gae66f696584e25fb2ddabe9070fa38670">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EndpointConfigure()
: <a class="el" href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EndpointStall()
: <a class="el" href="group__usbd__interface__gr.html#ga9502cd7b8e4c583920fccadc4ccf7975">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EndpointTransfer()
: <a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EndpointTransferAbort()
: <a class="el" href="group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EndpointTransferGetResult()
: <a class="el" href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EndpointUnconfigure()
: <a class="el" href="group__usbd__interface__gr.html#gaca913df5188dc0f0c4f707b57c2a88fc">Driver_USBD.c</a>
</li>
<li>ARM_USBD_EVENT_HIGH_SPEED
: <a class="el" href="group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_IN
: <a class="el" href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_OUT
: <a class="el" href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_RESET
: <a class="el" href="group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_RESUME
: <a class="el" href="group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_SETUP
: <a class="el" href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_SUSPEND
: <a class="el" href="group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_VBUS_OFF
: <a class="el" href="group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec">Driver_USBD.h</a>
</li>
<li>ARM_USBD_EVENT_VBUS_ON
: <a class="el" href="group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045">Driver_USBD.h</a>
</li>
<li>ARM_USBD_GetCapabilities()
: <a class="el" href="group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d">Driver_USBD.c</a>
</li>
<li>ARM_USBD_GetFrameNumber()
: <a class="el" href="group__usbd__interface__gr.html#ga4cd050b8343407fe465a27ad1cb7c264">Driver_USBD.c</a>
</li>
<li>ARM_USBD_GetVersion()
: <a class="el" href="group__usbd__interface__gr.html#ga1dcb8b7790f0e3613ee3da77e5fd18fc">Driver_USBD.c</a>
</li>
<li>ARM_USBD_Initialize()
: <a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">Driver_USBD.c</a>
</li>
<li>ARM_USBD_PowerControl()
: <a class="el" href="group__usbd__interface__gr.html#gaa5bdaac19f6df30c6e569abef17cdb42">Driver_USBD.c</a>
</li>
<li>ARM_USBD_ReadSetupPacket()
: <a class="el" href="group__usbd__interface__gr.html#ga6bc0ebf699a0f28330f21cab83f85e9e">Driver_USBD.c</a>
</li>
<li>ARM_USBD_SignalDeviceEvent()
: <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">Driver_USBD.c</a>
</li>
<li>ARM_USBD_SignalDeviceEvent_t
: <a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">Driver_USBD.h</a>
</li>
<li>ARM_USBD_SignalEndpointEvent()
: <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">Driver_USBD.c</a>
</li>
<li>ARM_USBD_SignalEndpointEvent_t
: <a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">Driver_USBD.h</a>
</li>
<li>ARM_USBD_Uninitialize()
: <a class="el" href="group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b">Driver_USBD.c</a>
</li>
<li>ARM_USBH_API_VERSION
: <a class="el" href="Driver__USBH_8h.html#a032e1e5caca3235109e2d2d6bf2e34bb">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EP_HANDLE
: <a class="el" href="Driver__USBH_8h.html#ab2c57d8ea726b331b891167aa4a201c9">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_BUS_ERROR
: <a class="el" href="group__USBH__pipe__events.html#ga7bd871b1e5c059bee398c32429370724">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_CONNECT
: <a class="el" href="group__USBH__port__events.html#ga71bfd8b8cd41b8aa6303d5d3a91597e6">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_DISCONNECT
: <a class="el" href="group__USBH__port__events.html#gaba67919f64e9a08ba1264363b2710d20">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_HANDSHAKE_ERR
: <a class="el" href="group__USBH__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_HANDSHAKE_MDATA
: <a class="el" href="group__USBH__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_HANDSHAKE_NAK
: <a class="el" href="group__USBH__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_HANDSHAKE_NYET
: <a class="el" href="group__USBH__pipe__events.html#ga62ae214576c923ce737a16098e9836e5">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_HANDSHAKE_STALL
: <a class="el" href="group__USBH__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_OVERCURRENT
: <a class="el" href="group__USBH__port__events.html#ga0955fdc2aedd2c5aa2be6cd782b3f2a8">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_REMOTE_WAKEUP
: <a class="el" href="group__USBH__port__events.html#ga2b61e9df3c63fd78fc08f79280a7066e">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_RESET
: <a class="el" href="group__USBH__port__events.html#ga70ae1e0a7872556d302a7f7840843c4a">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_RESUME
: <a class="el" href="group__USBH__port__events.html#ga42f62bdf6dd639f9f3dffc6c127456e3">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_SUSPEND
: <a class="el" href="group__USBH__port__events.html#gae1f91db7d31bcebbf60a23fb04cf7eb5">Driver_USBH.h</a>
</li>
<li>ARM_USBH_EVENT_TRANSFER_COMPLETE
: <a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">Driver_USBH.h</a>
</li>
<li>ARM_USBH_GetCapabilities()
: <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">Driver_USBH.c</a>
</li>
<li>ARM_USBH_GetFrameNumber()
: <a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">Driver_USBH.c</a>
</li>
<li>ARM_USBH_GetVersion()
: <a class="el" href="group__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_GetCapabilities()
: <a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_GetVersion()
: <a class="el" href="group__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_Initialize()
: <a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_Interrupt()
: <a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_Interrupt_t
: <a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">Driver_USBH.h</a>
</li>
<li>ARM_USBH_HCI_PortVbusOnOff()
: <a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_PowerControl()
: <a class="el" href="group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">Driver_USBH.c</a>
</li>
<li>ARM_USBH_HCI_Uninitialize()
: <a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">Driver_USBH.c</a>
</li>
<li>ARM_USBH_Initialize()
: <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PACKET_CSPLIT
: <a class="el" href="group__USBH__packets.html#gadbfbbf7b4709f3ee4c3610da8402cfec">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_DATA0
: <a class="el" href="group__USBH__packets.html#ga40075aa1d3eff6d4b94dfe28d7745873">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_DATA1
: <a class="el" href="group__USBH__packets.html#ga34014ff212b26e3ee8c8670a180846e2">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_DATA_Msk
: <a class="el" href="Driver__USBH_8h.html#a979e5c7ad6bae9b5eb42eb9ee1b6a843">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_DATA_Pos
: <a class="el" href="Driver__USBH_8h.html#a2b28435952abaeea6fd29480f10e56eb">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_IN
: <a class="el" href="group__USBH__packets.html#ga08d60ec20c091b5e7e252d137268cb76">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_OUT
: <a class="el" href="group__USBH__packets.html#ga409b2ae6503e738eb86e35652f9ebf8d">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_PING
: <a class="el" href="group__USBH__packets.html#ga2eeab58cebb4556214c021ff02c36b16">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_PRE
: <a class="el" href="group__USBH__packets.html#ga6dd82c7b96bc1339d725a6133a32a62f">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SETUP
: <a class="el" href="group__USBH__packets.html#gafb0bcfee8abd4ada7f789aec2993048a">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SPLIT_Msk
: <a class="el" href="Driver__USBH_8h.html#ad0c886d7d97a8ad2c343eab0552a09db">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SPLIT_Pos
: <a class="el" href="Driver__USBH_8h.html#a41e5706fcf6e028c5c86751b37a27dd6">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SSPLIT
: <a class="el" href="group__USBH__packets.html#gaf47930d994c53fc1772caed129aee921">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SSPLIT_E
: <a class="el" href="group__USBH__packets.html#gaf99ee84befc6522fef56b21df870df72">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SSPLIT_S
: <a class="el" href="group__USBH__packets.html#ga3b8fa0d3aa083718b4f5d60e92394b47">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_SSPLIT_S_E
: <a class="el" href="group__USBH__packets.html#ga8d2b46fbc04d871abe0661f8acd18a94">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_TOKEN_Msk
: <a class="el" href="Driver__USBH_8h.html#a366b3541934b74772eba60e6332923ad">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PACKET_TOKEN_Pos
: <a class="el" href="Driver__USBH_8h.html#a8139a9c76ea4a062795130196d3b6ed9">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PIPE_HANDLE
: <a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">Driver_USBH.h</a>
</li>
<li>ARM_USBH_PipeCreate()
: <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PipeDelete()
: <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PipeModify()
: <a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PipeReset()
: <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PipeTransfer()
: <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PipeTransferAbort()
: <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PipeTransferGetResult()
: <a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PortGetState()
: <a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PortReset()
: <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PortResume()
: <a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PortSuspend()
: <a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PortVbusOnOff()
: <a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">Driver_USBH.c</a>
</li>
<li>ARM_USBH_PowerControl()
: <a class="el" href="group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">Driver_USBH.c</a>
</li>
<li>ARM_USBH_SignalEndpointEvent_t
: <a class="el" href="Driver__USBH_8h.html#ab66601b4c31f638479d7ab6efa515dcc">Driver_USBH.h</a>
</li>
<li>ARM_USBH_SignalPipeEvent()
: <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">Driver_USBH.c</a>
</li>
<li>ARM_USBH_SignalPipeEvent_t
: <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">Driver_USBH.h</a>
</li>
<li>ARM_USBH_SignalPortEvent()
: <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">Driver_USBH.c</a>
</li>
<li>ARM_USBH_SignalPortEvent_t
: <a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">Driver_USBH.h</a>
</li>
<li>ARM_USBH_Uninitialize()
: <a class="el" href="group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">Driver_USBH.c</a>
</li>
</ul>
</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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/globals_u.html | HTML | apache-2.0 | 39,853 |
<!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>Globals</title>
<title>CMSIS-Driver: Globals</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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 id="navrow3" class="tabs2">
<ul class="tablist">
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Macros</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="globals.html#index__"><span>_</span></a></li>
<li><a href="globals_c.html#index_c"><span>c</span></a></li>
<li><a href="globals_d.html#index_d"><span>d</span></a></li>
<li><a href="globals_e.html#index_e"><span>e</span></a></li>
<li><a href="globals_f.html#index_f"><span>f</span></a></li>
<li><a href="globals_i.html#index_i"><span>i</span></a></li>
<li><a href="globals_m.html#index_m"><span>m</span></a></li>
<li><a href="globals_n.html#index_n"><span>n</span></a></li>
<li><a href="globals_p.html#index_p"><span>p</span></a></li>
<li><a href="globals_r.html#index_r"><span>r</span></a></li>
<li><a href="globals_s.html#index_s"><span>s</span></a></li>
<li><a href="globals_u.html#index_u"><span>u</span></a></li>
<li class="current"><a href="globals_w.html#index_w"><span>w</span></a></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('globals_w.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="contents">
<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div>
<h3><a class="anchor" id="index_w"></a>- w -</h3><ul>
<li>ARM_WIFI_Activate()
: <a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_API_VERSION
: <a class="el" href="Driver__WiFi_8h.html#aa6a3705716b58d58fdbf72d8308f1383">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_BEACON
: <a class="el" href="group__WiFi__option.html#ga6171d24c661b54465ced2dae7980897c">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_BSSID
: <a class="el" href="group__WiFi__option.html#gae84cbf48cd5168371621fc5f78aac0a4">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_BypassControl()
: <a class="el" href="group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_Deactivate()
: <a class="el" href="group__wifi__management__gr.html#ga1842127df60067481ac2f40d19153e3e">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_DTIM
: <a class="el" href="group__WiFi__option.html#ga947c297f1364993524bf515beba296f1">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_EthGetRxFrameSize()
: <a class="el" href="group__wifi__bypass__gr.html#gab67442ff061d0c4311a7046bce8d0cd1">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_EthReadFrame()
: <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_EthSendFrame()
: <a class="el" href="group__wifi__bypass__gr.html#gac1da4619feaf62d0cc90cfe44642d16b">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_EVENT_AP_CONNECT
: <a class="el" href="group__wifi__event.html#ga4a87b9a3c3a404e3917d54df98469a62">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_EVENT_AP_DISCONNECT
: <a class="el" href="group__wifi__event.html#ga271e73cda122e7ec3c5a5ca71d44eae3">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_EVENT_ETH_RX_FRAME
: <a class="el" href="group__wifi__event.html#ga833f2c7a47bd2523d7a62ff6506a997f">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_GetCapabilities()
: <a class="el" href="group__wifi__control__gr.html#ga3496996799a4762e9958a8b6af683b4b">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_GetModuleInfo()
: <a class="el" href="group__wifi__control__gr.html#gabdc4c9966a3f22ac6e53119e71e67579">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_GetNetInfo()
: <a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_GetOption()
: <a class="el" href="group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_GetVersion()
: <a class="el" href="group__wifi__control__gr.html#gad349fb835926a508e2a33501c0dff6a2">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_Initialize()
: <a class="el" href="group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_IP
: <a class="el" href="group__WiFi__option.html#ga50ee1ca627ebe536cae0ab7155ed1d17">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_DHCP_MODE
: <a class="el" href="group__WiFi__option.html#ga6b864e923870ec473ee0c876d1a3b032">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_DHCP_OFF
: <a class="el" href="group__wifi__dhcp__v6__mode.html#gaf200f735500dc647bc665f60a2df7552">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_DHCP_STATEFULL
: <a class="el" href="group__wifi__dhcp__v6__mode.html#ga205f9604967e290c053952cab850841a">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_DHCP_STATELESS
: <a class="el" href="group__wifi__dhcp__v6__mode.html#ga9d63d8029532c586703c77f1c8f990fc">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_DNS1
: <a class="el" href="group__WiFi__option.html#gaeb86e25e3b7c6360c977b05b40ff7676">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_DNS2
: <a class="el" href="group__WiFi__option.html#ga24dee294436d575b47c7a314cba1654d">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_GATEWAY
: <a class="el" href="group__WiFi__option.html#ga218d49572adcac8d678f7a8ae2f0c67e">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_GLOBAL
: <a class="el" href="group__WiFi__option.html#gaeac3fc297297b9bf5f2b5cf84788d77f">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_LINK_LOCAL
: <a class="el" href="group__WiFi__option.html#ga11fdcc3403a43187158434a87fdfb83c">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP6_SUBNET_PREFIX_LEN
: <a class="el" href="group__WiFi__option.html#ga545cb7e1da8715966bee7c7ff9d427d8">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_DHCP
: <a class="el" href="group__WiFi__option.html#gad37e95b697872782973057ae94c085a9">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_DHCP_LEASE_TIME
: <a class="el" href="group__WiFi__option.html#ga78ec2d08d4f1d3ce486b40a329bd8713">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_DHCP_POOL_BEGIN
: <a class="el" href="group__WiFi__option.html#ga10065d0d9cb7530e0747be83ba9e4c35">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_DHCP_POOL_END
: <a class="el" href="group__WiFi__option.html#ga4054f0e4045a25928531be73fb9d6b45">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_DNS1
: <a class="el" href="group__WiFi__option.html#ga657f5c6c504defe04422dbe468c6c134">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_DNS2
: <a class="el" href="group__WiFi__option.html#ga5a5fa4c298b16d0acd0a71f873802d31">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_GATEWAY
: <a class="el" href="group__WiFi__option.html#gad0c719fedd39d738ee7f6fd3c7317169">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IP_SUBNET_MASK
: <a class="el" href="group__WiFi__option.html#gac2603479ebad0ed05413e1e01b8a649f">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_IsConnected()
: <a class="el" href="group__wifi__management__gr.html#ga3d641222defb5f52f6dae4ce1d540d0f">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_LP_TIMER
: <a class="el" href="group__WiFi__option.html#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_MAC
: <a class="el" href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_Ping()
: <a class="el" href="group__wifi__socket__gr.html#gac7a8abb9e23f3f52dabce4153a53c1ca">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_PowerControl()
: <a class="el" href="group__wifi__control__gr.html#ga48d4cb7c00e96d2b928cc4468d4e623b">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_Scan()
: <a class="el" href="group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SECURITY_OPEN
: <a class="el" href="group__wifi__sec__type.html#gab5b0d06b14b916c244c42ad8a3053d1d">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_SECURITY_UNKNOWN
: <a class="el" href="group__wifi__sec__type.html#ga1c0904e056c3f720fe38b903230d9f89">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_SECURITY_WEP
: <a class="el" href="group__wifi__sec__type.html#ga75d8f1830db25a9f0b1390397186ddd5">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_SECURITY_WPA
: <a class="el" href="group__wifi__sec__type.html#ga40f2c6844d3d81bbfedaa96e72402b35">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_SECURITY_WPA2
: <a class="el" href="group__wifi__sec__type.html#gab4622ed5c27f910299ed6c3997d14b66">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_SetOption()
: <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SignalEvent()
: <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SignalEvent_t
: <a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_SocketAccept()
: <a class="el" href="group__wifi__socket__gr.html#ga24e6a015e519373c3f108cc5aa764ef8">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketBind()
: <a class="el" href="group__wifi__socket__gr.html#gae69f7822b658765f1cd3f74e9a50c246">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketClose()
: <a class="el" href="group__wifi__socket__gr.html#ga391464de71b6a5d300fda9434fe87a87">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketConnect()
: <a class="el" href="group__wifi__socket__gr.html#gac0f189afbd35914d4c85e77b40672b16">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketCreate()
: <a class="el" href="group__wifi__socket__gr.html#ga1433b297315ab394f1544a18548ffcc6">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketGetHostByName()
: <a class="el" href="group__wifi__socket__gr.html#ga0c37435c6abc68ee0f1f4357b503e0bf">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketGetOpt()
: <a class="el" href="group__wifi__socket__gr.html#ga6d69360e9774937b7bdc03b45fbc9075">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketGetPeerName()
: <a class="el" href="group__wifi__socket__gr.html#gaa484a931d55d163477920bc865dd9220">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketGetSockName()
: <a class="el" href="group__wifi__socket__gr.html#gac187e418893de33817e4fcbdd85dbaee">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketListen()
: <a class="el" href="group__wifi__socket__gr.html#ga4929aab257781dcaae7197f917991779">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketRecv()
: <a class="el" href="group__wifi__socket__gr.html#gaecc9ba19491ed00c27da3f5677895d48">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketRecvFrom()
: <a class="el" href="group__wifi__socket__gr.html#ga2b15232d69f2ae8e189512d6c68c8a81">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketSend()
: <a class="el" href="group__wifi__socket__gr.html#gaee8615b026e8525fb21ca45ba3778ac8">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketSendTo()
: <a class="el" href="group__wifi__socket__gr.html#ga5ddd3dd5f863b8392e4281dd48a28d28">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_SocketSetOpt()
: <a class="el" href="group__wifi__socket__gr.html#ga5de80d6729d9504a21dd5d31dc504017">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_TX_POWER
: <a class="el" href="group__WiFi__option.html#ga1fbda584fe5750db6a04b1ed27730d95">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_Uninitialize()
: <a class="el" href="group__wifi__control__gr.html#gae1e488d4ecc365e30712e6b1711a9c5d">Driver_WiFi.c</a>
</li>
<li>ARM_WIFI_WPS_METHOD_NONE
: <a class="el" href="group__wifi__wps__method.html#gaade5c0e07cfee79973643b9f98a73438">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_WPS_METHOD_PBC
: <a class="el" href="group__wifi__wps__method.html#gafe4555319019fa722d2f2a8cc519af41">Driver_WiFi.h</a>
</li>
<li>ARM_WIFI_WPS_METHOD_PIN
: <a class="el" href="group__wifi__wps__method.html#ga12a4e06347498f9765f339cdb5f391de">Driver_WiFi.h</a>
</li>
</ul>
</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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/globals_w.html | HTML | apache-2.0 | 17,574 |
<!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>CAN Object Events</title>
<title>CMSIS-Driver: CAN Object Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">CAN Object Events<div class="ingroups"><a class="el" href="group__can__interface__gr.html">CAN Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Callback objects events notified via <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>.
<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:ga486f0f35ebc7e3b5931ee68b56703503"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503">ARM_CAN_EVENT_SEND_COMPLETE</a>   (1UL << 0)</td></tr>
<tr class="memdesc:ga486f0f35ebc7e3b5931ee68b56703503"><td class="mdescLeft"> </td><td class="mdescRight">Send complete. <a href="#ga486f0f35ebc7e3b5931ee68b56703503">More...</a><br/></td></tr>
<tr class="separator:ga486f0f35ebc7e3b5931ee68b56703503"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c1082561eeae3b2b8132e81fc241e47"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47">ARM_CAN_EVENT_RECEIVE</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga2c1082561eeae3b2b8132e81fc241e47"><td class="mdescLeft"> </td><td class="mdescRight">Message received. <a href="#ga2c1082561eeae3b2b8132e81fc241e47">More...</a><br/></td></tr>
<tr class="separator:ga2c1082561eeae3b2b8132e81fc241e47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6c2d29b5c49d5cd18e97f5931157a94c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html#ga6c2d29b5c49d5cd18e97f5931157a94c">ARM_CAN_EVENT_RECEIVE_OVERRUN</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga6c2d29b5c49d5cd18e97f5931157a94c"><td class="mdescLeft"> </td><td class="mdescRight">Received message overrun. <a href="#ga6c2d29b5c49d5cd18e97f5931157a94c">More...</a><br/></td></tr>
<tr class="separator:ga6c2d29b5c49d5cd18e97f5931157a94c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Callback objects events notified via <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>. </p>
<p>The CAN driver generates callback objects events that are notified via the function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>.</p>
<p>The following callback notification object events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga486f0f35ebc7e3b5931ee68b56703503"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_SEND_COMPLETE   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send complete. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2c1082561eeae3b2b8132e81fc241e47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_RECEIVE   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Message received. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6c2d29b5c49d5cd18e97f5931157a94c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_RECEIVE_OVERRUN   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Received message overrun. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__CAN__events.html | HTML | apache-2.0 | 10,783 |
var group__CAN__events =
[
[ "ARM_CAN_EVENT_SEND_COMPLETE", "group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503", null ],
[ "ARM_CAN_EVENT_RECEIVE", "group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47", null ],
[ "ARM_CAN_EVENT_RECEIVE_OVERRUN", "group__CAN__events.html#ga6c2d29b5c49d5cd18e97f5931157a94c", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__CAN__events.js | JavaScript | apache-2.0 | 345 |
<!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>CAN Unit Events</title>
<title>CMSIS-Driver: CAN Unit Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__unit__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">CAN Unit Events<div class="ingroups"><a class="el" href="group__can__interface__gr.html">CAN Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>.
<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:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#gaa2347c172c8a8f42ac66cb42cd7a08db">ARM_CAN_EVENT_UNIT_INACTIVE</a>   (0U)</td></tr>
<tr class="memdesc:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="mdescLeft"> </td><td class="mdescRight">Unit entered Inactive state. <a href="#gaa2347c172c8a8f42ac66cb42cd7a08db">More...</a><br/></td></tr>
<tr class="separator:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e65231ccb20684d7c8eac80385f8c18"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#ga0e65231ccb20684d7c8eac80385f8c18">ARM_CAN_EVENT_UNIT_ACTIVE</a>   (1U)</td></tr>
<tr class="memdesc:ga0e65231ccb20684d7c8eac80385f8c18"><td class="mdescLeft"> </td><td class="mdescRight">Unit entered Error Active state. <a href="#ga0e65231ccb20684d7c8eac80385f8c18">More...</a><br/></td></tr>
<tr class="separator:ga0e65231ccb20684d7c8eac80385f8c18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#ga3690f864edd2e124f4f9875fdde9a2eb">ARM_CAN_EVENT_UNIT_WARNING</a>   (2U)</td></tr>
<tr class="memdesc:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="mdescLeft"> </td><td class="mdescRight">Unit entered Error Warning state (one or both error counters >= 96) <a href="#ga3690f864edd2e124f4f9875fdde9a2eb">More...</a><br/></td></tr>
<tr class="separator:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c529d6697fe21e69639224322f8c4b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#ga9c529d6697fe21e69639224322f8c4b4">ARM_CAN_EVENT_UNIT_PASSIVE</a>   (3U)</td></tr>
<tr class="memdesc:ga9c529d6697fe21e69639224322f8c4b4"><td class="mdescLeft"> </td><td class="mdescRight">Unit entered Error Passive state. <a href="#ga9c529d6697fe21e69639224322f8c4b4">More...</a><br/></td></tr>
<tr class="separator:ga9c529d6697fe21e69639224322f8c4b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa4f992a97b4ca0f079aec2990a69bed"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#gafa4f992a97b4ca0f079aec2990a69bed">ARM_CAN_EVENT_UNIT_BUS_OFF</a>   (4U)</td></tr>
<tr class="memdesc:gafa4f992a97b4ca0f079aec2990a69bed"><td class="mdescLeft"> </td><td class="mdescRight">Unit entered Bus-off state. <a href="#gafa4f992a97b4ca0f079aec2990a69bed">More...</a><br/></td></tr>
<tr class="separator:gafa4f992a97b4ca0f079aec2990a69bed"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>. </p>
<p>The CAN driver generates callback unit events that are notified via the function <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>.</p>
<p>The following callback notification unit events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaa2347c172c8a8f42ac66cb42cd7a08db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_UNIT_INACTIVE   (0U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit entered Inactive state. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0e65231ccb20684d7c8eac80385f8c18"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_UNIT_ACTIVE   (1U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit entered Error Active state. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3690f864edd2e124f4f9875fdde9a2eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_UNIT_WARNING   (2U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit entered Error Warning state (one or both error counters >= 96) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9c529d6697fe21e69639224322f8c4b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_UNIT_PASSIVE   (3U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit entered Error Passive state. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafa4f992a97b4ca0f079aec2990a69bed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EVENT_UNIT_BUS_OFF   (4U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unit entered Bus-off state. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__CAN__unit__events.html | HTML | apache-2.0 | 13,188 |
var group__CAN__unit__events =
[
[ "ARM_CAN_EVENT_UNIT_INACTIVE", "group__CAN__unit__events.html#gaa2347c172c8a8f42ac66cb42cd7a08db", null ],
[ "ARM_CAN_EVENT_UNIT_ACTIVE", "group__CAN__unit__events.html#ga0e65231ccb20684d7c8eac80385f8c18", null ],
[ "ARM_CAN_EVENT_UNIT_WARNING", "group__CAN__unit__events.html#ga3690f864edd2e124f4f9875fdde9a2eb", null ],
[ "ARM_CAN_EVENT_UNIT_PASSIVE", "group__CAN__unit__events.html#ga9c529d6697fe21e69639224322f8c4b4", null ],
[ "ARM_CAN_EVENT_UNIT_BUS_OFF", "group__CAN__unit__events.html#gafa4f992a97b4ca0f079aec2990a69bed", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__CAN__unit__events.js | JavaScript | apache-2.0 | 594 |
<!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>Ethernet MAC Events</title>
<title>CMSIS-Driver: Ethernet MAC Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__ETH__MAC__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Events<div class="ingroups"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The Ethernet MAC driver generates call back events that are notified via the function <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a>.
<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:ga76943471a4a3e9e8c1ff9fe83e43bd47"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ETH__MAC__events.html#ga76943471a4a3e9e8c1ff9fe83e43bd47">ARM_ETH_MAC_EVENT_RX_FRAME</a>   (1UL << 0)</td></tr>
<tr class="memdesc:ga76943471a4a3e9e8c1ff9fe83e43bd47"><td class="mdescLeft"> </td><td class="mdescRight">Frame Received. <a href="#ga76943471a4a3e9e8c1ff9fe83e43bd47">More...</a><br/></td></tr>
<tr class="separator:ga76943471a4a3e9e8c1ff9fe83e43bd47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0c0328ff7cf886d5fdb53bb84ec03c1b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga0c0328ff7cf886d5fdb53bb84ec03c1b"><td class="mdescLeft"> </td><td class="mdescRight">Frame Transmitted. <a href="#ga0c0328ff7cf886d5fdb53bb84ec03c1b">More...</a><br/></td></tr>
<tr class="separator:ga0c0328ff7cf886d5fdb53bb84ec03c1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f3bdb219afa8f2a121b58cc84f5761c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ETH__MAC__events.html#ga1f3bdb219afa8f2a121b58cc84f5761c">ARM_ETH_MAC_EVENT_WAKEUP</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga1f3bdb219afa8f2a121b58cc84f5761c"><td class="mdescLeft"> </td><td class="mdescRight">Wake-up (on Magic Packet) <a href="#ga1f3bdb219afa8f2a121b58cc84f5761c">More...</a><br/></td></tr>
<tr class="separator:ga1f3bdb219afa8f2a121b58cc84f5761c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4afc71ecac964f195e27be4acdbe7c61"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ETH__MAC__events.html#ga4afc71ecac964f195e27be4acdbe7c61">ARM_ETH_MAC_EVENT_TIMER_ALARM</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga4afc71ecac964f195e27be4acdbe7c61"><td class="mdescLeft"> </td><td class="mdescRight">Timer Alarm. <a href="#ga4afc71ecac964f195e27be4acdbe7c61">More...</a><br/></td></tr>
<tr class="separator:ga4afc71ecac964f195e27be4acdbe7c61"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The Ethernet MAC driver generates call back events that are notified via the function <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga76943471a4a3e9e8c1ff9fe83e43bd47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_EVENT_RX_FRAME   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame Received. </p>
</div>
</div>
<a class="anchor" id="ga0c0328ff7cf886d5fdb53bb84ec03c1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_EVENT_TX_FRAME   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame Transmitted. </p>
</div>
</div>
<a class="anchor" id="ga1f3bdb219afa8f2a121b58cc84f5761c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_EVENT_WAKEUP   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Wake-up (on Magic Packet) </p>
</div>
</div>
<a class="anchor" id="ga4afc71ecac964f195e27be4acdbe7c61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_EVENT_TIMER_ALARM   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timer Alarm. </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__ETH__MAC__events.html | HTML | apache-2.0 | 11,376 |
var group__ETH__MAC__events =
[
[ "ARM_ETH_MAC_EVENT_RX_FRAME", "group__ETH__MAC__events.html#ga76943471a4a3e9e8c1ff9fe83e43bd47", null ],
[ "ARM_ETH_MAC_EVENT_TX_FRAME", "group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b", null ],
[ "ARM_ETH_MAC_EVENT_WAKEUP", "group__ETH__MAC__events.html#ga1f3bdb219afa8f2a121b58cc84f5761c", null ],
[ "ARM_ETH_MAC_EVENT_TIMER_ALARM", "group__ETH__MAC__events.html#ga4afc71ecac964f195e27be4acdbe7c61", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__ETH__MAC__events.js | JavaScript | apache-2.0 | 478 |
<!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>Flash Events</title>
<title>CMSIS-Driver: Flash Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__Flash__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Flash Events<div class="ingroups"><a class="el" href="group__flash__interface__gr.html">Flash Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The Flash driver generates call back events that are notified via the function <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a>.
<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:gaf7a9c4ad125ee90df35907d861151e23"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23">ARM_FLASH_EVENT_READY</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gaf7a9c4ad125ee90df35907d861151e23"><td class="mdescLeft"> </td><td class="mdescRight">Flash Ready. <a href="#gaf7a9c4ad125ee90df35907d861151e23">More...</a><br/></td></tr>
<tr class="separator:gaf7a9c4ad125ee90df35907d861151e23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962">ARM_FLASH_EVENT_ERROR</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="mdescLeft"> </td><td class="mdescRight">Read/Program/Erase Error. <a href="#ga0dfea52761c0eed83e5d73e7a7f69962">More...</a><br/></td></tr>
<tr class="separator:ga0dfea52761c0eed83e5d73e7a7f69962"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The Flash driver generates call back events that are notified via the function <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__flash__interface__gr.html#ga97b75555b5433b268add81f2e60f095a">ARM_Flash_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf7a9c4ad125ee90df35907d861151e23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_FLASH_EVENT_READY   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flash Ready. </p>
</div>
</div>
<a class="anchor" id="ga0dfea52761c0eed83e5d73e7a7f69962"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_FLASH_EVENT_ERROR   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read/Program/Erase 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__Flash__events.html | HTML | apache-2.0 | 9,303 |
var group__Flash__events =
[
[ "ARM_FLASH_EVENT_READY", "group__Flash__events.html#gaf7a9c4ad125ee90df35907d861151e23", null ],
[ "ARM_FLASH_EVENT_ERROR", "group__Flash__events.html#ga0dfea52761c0eed83e5d73e7a7f69962", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__Flash__events.js | JavaScript | apache-2.0 | 236 |
<!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>I2C Events</title>
<title>CMSIS-Driver: I2C Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__I2C__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">I2C Events<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The I2C driver generates call back events that are notified via the function <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a>.
<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:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>   (1UL << 0)</td></tr>
<tr class="memdesc:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="mdescLeft"> </td><td class="mdescRight">Master/Slave Transmit/Receive finished. <a href="#ga5992dc0f6e839c4d066cfa83d535f30d">More...</a><br/></td></tr>
<tr class="separator:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a>   (1UL << 1)</td></tr>
<tr class="memdesc:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="mdescLeft"> </td><td class="mdescRight">Master/Slave Transmit/Receive incomplete transfer. <a href="#gafac3989c7b57727e1bed4ee9f2496ac9">More...</a><br/></td></tr>
<tr class="separator:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a>   (1UL << 2)</td></tr>
<tr class="memdesc:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="mdescLeft"> </td><td class="mdescRight">Addressed as Slave Transmitter but transmit operation is not set. <a href="#gacfbbec9af083d35e8ea87ad16e9c6ec2">More...</a><br/></td></tr>
<tr class="separator:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd875b57ce39dadd849c53b885ad6661"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a>   (1UL << 3)</td></tr>
<tr class="memdesc:gabd875b57ce39dadd849c53b885ad6661"><td class="mdescLeft"> </td><td class="mdescRight">Addressed as Slave Receiver but receive operation is not set. <a href="#gabd875b57ce39dadd849c53b885ad6661">More...</a><br/></td></tr>
<tr class="separator:gabd875b57ce39dadd849c53b885ad6661"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga98b815769634d9578526b43589caa017"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga98b815769634d9578526b43589caa017"><td class="mdescLeft"> </td><td class="mdescRight">Address not acknowledged from Slave. <a href="#ga98b815769634d9578526b43589caa017">More...</a><br/></td></tr>
<tr class="separator:ga98b815769634d9578526b43589caa017"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="mdescLeft"> </td><td class="mdescRight">Slave addressed with general call address. <a href="#ga3ab54410b6410ed3a58762ff0c0d68b9">More...</a><br/></td></tr>
<tr class="separator:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac9000f44a578e2117d64dbc2093cec6d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a>   (1UL << 6)</td></tr>
<tr class="memdesc:gac9000f44a578e2117d64dbc2093cec6d"><td class="mdescLeft"> </td><td class="mdescRight">Master lost arbitration. <a href="#gac9000f44a578e2117d64dbc2093cec6d">More...</a><br/></td></tr>
<tr class="separator:gac9000f44a578e2117d64dbc2093cec6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeef542840355131c18b53fd9ed1904a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a>   (1UL << 7)</td></tr>
<tr class="memdesc:gaeef542840355131c18b53fd9ed1904a8"><td class="mdescLeft"> </td><td class="mdescRight">Bus error detected (START/STOP at illegal position) <a href="#gaeef542840355131c18b53fd9ed1904a8">More...</a><br/></td></tr>
<tr class="separator:gaeef542840355131c18b53fd9ed1904a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga81ca21fad73dac1ffaff58921f848ea9">ARM_I2C_EVENT_BUS_CLEAR</a>   (1UL << 8)</td></tr>
<tr class="memdesc:ga81ca21fad73dac1ffaff58921f848ea9"><td class="mdescLeft"> </td><td class="mdescRight">Bus clear finished. <a href="#ga81ca21fad73dac1ffaff58921f848ea9">More...</a><br/></td></tr>
<tr class="separator:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The I2C driver generates call back events that are notified via the function <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga5992dc0f6e839c4d066cfa83d535f30d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_TRANSFER_DONE   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Master/Slave Transmit/Receive finished. </p>
</div>
</div>
<a class="anchor" id="gafac3989c7b57727e1bed4ee9f2496ac9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_TRANSFER_INCOMPLETE   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Master/Slave Transmit/Receive incomplete transfer. </p>
</div>
</div>
<a class="anchor" id="gacfbbec9af083d35e8ea87ad16e9c6ec2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_SLAVE_TRANSMIT   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Addressed as Slave Transmitter but transmit operation is not set. </p>
</div>
</div>
<a class="anchor" id="gabd875b57ce39dadd849c53b885ad6661"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_SLAVE_RECEIVE   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Addressed as Slave Receiver but receive operation is not set. </p>
</div>
</div>
<a class="anchor" id="ga98b815769634d9578526b43589caa017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_ADDRESS_NACK   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Address not acknowledged from Slave. </p>
</div>
</div>
<a class="anchor" id="ga3ab54410b6410ed3a58762ff0c0d68b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_GENERAL_CALL   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Slave addressed with general call address. </p>
</div>
</div>
<a class="anchor" id="gac9000f44a578e2117d64dbc2093cec6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_ARBITRATION_LOST   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Master lost arbitration. </p>
</div>
</div>
<a class="anchor" id="gaeef542840355131c18b53fd9ed1904a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_BUS_ERROR   (1UL << 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus error detected (START/STOP at illegal position) </p>
</div>
</div>
<a class="anchor" id="ga81ca21fad73dac1ffaff58921f848ea9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_EVENT_BUS_CLEAR   (1UL << 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus clear finished. </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__I2C__events.html | HTML | apache-2.0 | 16,680 |
var group__I2C__events =
[
[ "ARM_I2C_EVENT_TRANSFER_DONE", "group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d", null ],
[ "ARM_I2C_EVENT_TRANSFER_INCOMPLETE", "group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9", null ],
[ "ARM_I2C_EVENT_SLAVE_TRANSMIT", "group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2", null ],
[ "ARM_I2C_EVENT_SLAVE_RECEIVE", "group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661", null ],
[ "ARM_I2C_EVENT_ADDRESS_NACK", "group__I2C__events.html#ga98b815769634d9578526b43589caa017", null ],
[ "ARM_I2C_EVENT_GENERAL_CALL", "group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9", null ],
[ "ARM_I2C_EVENT_ARBITRATION_LOST", "group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d", null ],
[ "ARM_I2C_EVENT_BUS_ERROR", "group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8", null ],
[ "ARM_I2C_EVENT_BUS_CLEAR", "group__I2C__events.html#ga81ca21fad73dac1ffaff58921f848ea9", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__I2C__events.js | JavaScript | apache-2.0 | 991 |
<!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>NAND Events</title>
<title>CMSIS-Driver: NAND Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__NAND__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">NAND Events<div class="ingroups"><a class="el" href="group__nand__interface__gr.html">NAND Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The NAND driver generates call back events that are notified via the function <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a>.
<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:gae0be7e1b41188def905de0a1568d442d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d">ARM_NAND_EVENT_DEVICE_READY</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gae0be7e1b41188def905de0a1568d442d"><td class="mdescLeft"> </td><td class="mdescRight">Device Ready: R/Bn rising edge. <a href="#gae0be7e1b41188def905de0a1568d442d">More...</a><br/></td></tr>
<tr class="separator:gae0be7e1b41188def905de0a1568d442d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b390a906db42c5ea4db38e0e85bb9e9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9">ARM_NAND_EVENT_DRIVER_READY</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga7b390a906db42c5ea4db38e0e85bb9e9"><td class="mdescLeft"> </td><td class="mdescRight">Driver Ready. <a href="#ga7b390a906db42c5ea4db38e0e85bb9e9">More...</a><br/></td></tr>
<tr class="separator:ga7b390a906db42c5ea4db38e0e85bb9e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac774a334871789d24107b843d1ebd00c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NAND__events.html#gac774a334871789d24107b843d1ebd00c">ARM_NAND_EVENT_DRIVER_DONE</a>   (1UL << 2)</td></tr>
<tr class="memdesc:gac774a334871789d24107b843d1ebd00c"><td class="mdescLeft"> </td><td class="mdescRight">Driver operation done. <a href="#gac774a334871789d24107b843d1ebd00c">More...</a><br/></td></tr>
<tr class="separator:gac774a334871789d24107b843d1ebd00c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bee0c32528ab991c0c064f895f80664"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664">ARM_NAND_EVENT_ECC_ERROR</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga7bee0c32528ab991c0c064f895f80664"><td class="mdescLeft"> </td><td class="mdescRight">ECC could not correct data. <a href="#ga7bee0c32528ab991c0c064f895f80664">More...</a><br/></td></tr>
<tr class="separator:ga7bee0c32528ab991c0c064f895f80664"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The NAND driver generates call back events that are notified via the function <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__nand__interface__gr.html#gaf4ce80b0fd6717de7ddfb1cfaf7dd754">ARM_NAND_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gae0be7e1b41188def905de0a1568d442d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_EVENT_DEVICE_READY   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Device Ready: R/Bn rising edge. </p>
</div>
</div>
<a class="anchor" id="ga7b390a906db42c5ea4db38e0e85bb9e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_EVENT_DRIVER_READY   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver Ready. </p>
</div>
</div>
<a class="anchor" id="gac774a334871789d24107b843d1ebd00c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_EVENT_DRIVER_DONE   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver operation done. </p>
</div>
</div>
<a class="anchor" id="ga7bee0c32528ab991c0c064f895f80664"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_NAND_EVENT_ECC_ERROR   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>ECC could not correct data. </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__NAND__events.html | HTML | apache-2.0 | 11,327 |
var group__NAND__events =
[
[ "ARM_NAND_EVENT_DEVICE_READY", "group__NAND__events.html#gae0be7e1b41188def905de0a1568d442d", null ],
[ "ARM_NAND_EVENT_DRIVER_READY", "group__NAND__events.html#ga7b390a906db42c5ea4db38e0e85bb9e9", null ],
[ "ARM_NAND_EVENT_DRIVER_DONE", "group__NAND__events.html#gac774a334871789d24107b843d1ebd00c", null ],
[ "ARM_NAND_EVENT_ECC_ERROR", "group__NAND__events.html#ga7bee0c32528ab991c0c064f895f80664", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__NAND__events.js | JavaScript | apache-2.0 | 457 |
<!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>SAI Events</title>
<title>CMSIS-Driver: SAI Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__SAI__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SAI Events<div class="ingroups"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The SAI driver generates call back events that are notified via the function <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a>.
<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:ga3dfa64375859f40d157c224187d2885e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga3dfa64375859f40d157c224187d2885e">ARM_SAI_EVENT_SEND_COMPLETE</a>   (1U << 0)</td></tr>
<tr class="memdesc:ga3dfa64375859f40d157c224187d2885e"><td class="mdescLeft"> </td><td class="mdescRight">Send completed. <a href="#ga3dfa64375859f40d157c224187d2885e">More...</a><br/></td></tr>
<tr class="separator:ga3dfa64375859f40d157c224187d2885e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a9bde0b096aafe53279529a0adbef55"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga5a9bde0b096aafe53279529a0adbef55">ARM_SAI_EVENT_RECEIVE_COMPLETE</a>   (1U << 1)</td></tr>
<tr class="memdesc:ga5a9bde0b096aafe53279529a0adbef55"><td class="mdescLeft"> </td><td class="mdescRight">Receive completed. <a href="#ga5a9bde0b096aafe53279529a0adbef55">More...</a><br/></td></tr>
<tr class="separator:ga5a9bde0b096aafe53279529a0adbef55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a0be7aaf9d700e5259f741641bc37ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga6a0be7aaf9d700e5259f741641bc37ca">ARM_SAI_EVENT_TX_UNDERFLOW</a>   (1U << 2)</td></tr>
<tr class="memdesc:ga6a0be7aaf9d700e5259f741641bc37ca"><td class="mdescLeft"> </td><td class="mdescRight">Transmit data not available. <a href="#ga6a0be7aaf9d700e5259f741641bc37ca">More...</a><br/></td></tr>
<tr class="separator:ga6a0be7aaf9d700e5259f741641bc37ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac83e9df0238803ef2c88f16605f73bf5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#gac83e9df0238803ef2c88f16605f73bf5">ARM_SAI_EVENT_RX_OVERFLOW</a>   (1U << 3)</td></tr>
<tr class="memdesc:gac83e9df0238803ef2c88f16605f73bf5"><td class="mdescLeft"> </td><td class="mdescRight">Receive data overflow. <a href="#gac83e9df0238803ef2c88f16605f73bf5">More...</a><br/></td></tr>
<tr class="separator:gac83e9df0238803ef2c88f16605f73bf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ffcf96fe404b48421a57fbd122b26bc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc">ARM_SAI_EVENT_FRAME_ERROR</a>   (1U << 4)</td></tr>
<tr class="memdesc:ga6ffcf96fe404b48421a57fbd122b26bc"><td class="mdescLeft"> </td><td class="mdescRight">Sync Frame error in Slave mode (optional) <a href="#ga6ffcf96fe404b48421a57fbd122b26bc">More...</a><br/></td></tr>
<tr class="separator:ga6ffcf96fe404b48421a57fbd122b26bc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The SAI driver generates call back events that are notified via the function <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga3dfa64375859f40d157c224187d2885e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_EVENT_SEND_COMPLETE   (1U << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send completed. </p>
</div>
</div>
<a class="anchor" id="ga5a9bde0b096aafe53279529a0adbef55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_EVENT_RECEIVE_COMPLETE   (1U << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive completed. </p>
</div>
</div>
<a class="anchor" id="ga6a0be7aaf9d700e5259f741641bc37ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_EVENT_TX_UNDERFLOW   (1U << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit data not available. </p>
</div>
</div>
<a class="anchor" id="gac83e9df0238803ef2c88f16605f73bf5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_EVENT_RX_OVERFLOW   (1U << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive data overflow. </p>
</div>
</div>
<a class="anchor" id="ga6ffcf96fe404b48421a57fbd122b26bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_EVENT_FRAME_ERROR   (1U << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sync Frame error in Slave mode (optional) </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SAI__events.html | HTML | apache-2.0 | 12,320 |
var group__SAI__events =
[
[ "ARM_SAI_EVENT_SEND_COMPLETE", "group__SAI__events.html#ga3dfa64375859f40d157c224187d2885e", null ],
[ "ARM_SAI_EVENT_RECEIVE_COMPLETE", "group__SAI__events.html#ga5a9bde0b096aafe53279529a0adbef55", null ],
[ "ARM_SAI_EVENT_TX_UNDERFLOW", "group__SAI__events.html#ga6a0be7aaf9d700e5259f741641bc37ca", null ],
[ "ARM_SAI_EVENT_RX_OVERFLOW", "group__SAI__events.html#gac83e9df0238803ef2c88f16605f73bf5", null ],
[ "ARM_SAI_EVENT_FRAME_ERROR", "group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SAI__events.js | JavaScript | apache-2.0 | 561 |
<!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>SPI Control Codes</title>
<title>CMSIS-Driver: SPI Control 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__SPI__control.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">SPI Control Codes<div class="ingroups"><a class="el" href="group__spi__interface__gr.html">SPI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Many parameters of the SPI driver are configured using the <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> function.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__spi__mode__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__mode__ctrls.html">SPI Mode Controls</a></td></tr>
<tr class="memdesc:group__spi__mode__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specifies SPI mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__spi__frame__format__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html">SPI Frame Format</a></td></tr>
<tr class="memdesc:group__spi__frame__format__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Defines the frame format. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__spi__data__bits__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__data__bits__ctrls.html">SPI Data Bits</a></td></tr>
<tr class="memdesc:group__spi__data__bits__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Defines the number of data bits. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__spi__bit__order__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__bit__order__ctrls.html">SPI Bit Order</a></td></tr>
<tr class="memdesc:group__spi__bit__order__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Defines the bit order. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__spi__slave__select__mode__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html">SPI Slave Select Mode</a></td></tr>
<tr class="memdesc:group__spi__slave__select__mode__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specifies SPI slave select mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__spi__misc__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__misc__ctrls.html">SPI Miscellaneous Controls</a></td></tr>
<tr class="memdesc:group__spi__misc__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specifies additional miscellaneous controls. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Many parameters of the SPI driver are configured using the <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> function. </p>
<p>The various SPI control codes define:</p>
<ul>
<li><a class="el" href="group__spi__mode__ctrls.html">SPI Mode Controls</a> specifies SPI mode</li>
<li><a class="el" href="group__spi__frame__format__ctrls.html">SPI Frame Format</a> defines the frame format</li>
<li><a class="el" href="group__spi__data__bits__ctrls.html">SPI Data Bits</a> defines the number of data bits</li>
<li><a class="el" href="group__spi__bit__order__ctrls.html">SPI Bit Order</a> defines the bit order</li>
<li><a class="el" href="group__spi__slave__select__mode__ctrls.html">SPI Slave Select Mode</a> specifies slave select mode</li>
<li><a class="el" href="group__spi__misc__ctrls.html">SPI Miscellaneous Controls</a> specifies additional miscellaneous controls</li>
</ul>
<p>Refer to the <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> function for further details. </p>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SPI__control.html | HTML | apache-2.0 | 10,716 |
var group__SPI__control =
[
[ "SPI Mode Controls", "group__spi__mode__ctrls.html", "group__spi__mode__ctrls" ],
[ "SPI Frame Format", "group__spi__frame__format__ctrls.html", "group__spi__frame__format__ctrls" ],
[ "SPI Data Bits", "group__spi__data__bits__ctrls.html", "group__spi__data__bits__ctrls" ],
[ "SPI Bit Order", "group__spi__bit__order__ctrls.html", "group__spi__bit__order__ctrls" ],
[ "SPI Slave Select Mode", "group__spi__slave__select__mode__ctrls.html", "group__spi__slave__select__mode__ctrls" ],
[ "SPI Miscellaneous Controls", "group__spi__misc__ctrls.html", "group__spi__misc__ctrls" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SPI__control.js | JavaScript | apache-2.0 | 633 |
<!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>SPI Events</title>
<title>CMSIS-Driver: SPI Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__SPI__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">SPI Events<div class="ingroups"><a class="el" href="group__spi__interface__gr.html">SPI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The SPI driver generates call back events that are notified via the function <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a>.
<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:gaabdfc9e17641144cd50d36d15511a1b8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gaabdfc9e17641144cd50d36d15511a1b8"><td class="mdescLeft"> </td><td class="mdescRight">Data Transfer completed. <a href="#gaabdfc9e17641144cd50d36d15511a1b8">More...</a><br/></td></tr>
<tr class="separator:gaabdfc9e17641144cd50d36d15511a1b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e63d99c80ea56de596a8d0a51fd8244"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244">ARM_SPI_EVENT_DATA_LOST</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga8e63d99c80ea56de596a8d0a51fd8244"><td class="mdescLeft"> </td><td class="mdescRight">Data lost: Receive overflow / Transmit underflow. <a href="#ga8e63d99c80ea56de596a8d0a51fd8244">More...</a><br/></td></tr>
<tr class="separator:ga8e63d99c80ea56de596a8d0a51fd8244"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7eaa229003689aa18598273490b3e630"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga7eaa229003689aa18598273490b3e630"><td class="mdescLeft"> </td><td class="mdescRight">Master Mode Fault (SS deactivated when Master) <a href="#ga7eaa229003689aa18598273490b3e630">More...</a><br/></td></tr>
<tr class="separator:ga7eaa229003689aa18598273490b3e630"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The SPI driver generates call back events that are notified via the function <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaabdfc9e17641144cd50d36d15511a1b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_EVENT_TRANSFER_COMPLETE   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data Transfer completed. </p>
</div>
</div>
<a class="anchor" id="ga8e63d99c80ea56de596a8d0a51fd8244"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_EVENT_DATA_LOST   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data lost: Receive overflow / Transmit underflow. </p>
</div>
</div>
<a class="anchor" id="ga7eaa229003689aa18598273490b3e630"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_EVENT_MODE_FAULT   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Master Mode Fault (SS deactivated when Master) </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SPI__events.html | HTML | apache-2.0 | 10,408 |
var group__SPI__events =
[
[ "ARM_SPI_EVENT_TRANSFER_COMPLETE", "group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8", null ],
[ "ARM_SPI_EVENT_DATA_LOST", "group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244", null ],
[ "ARM_SPI_EVENT_MODE_FAULT", "group__SPI__events.html#ga7eaa229003689aa18598273490b3e630", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SPI__events.js | JavaScript | apache-2.0 | 346 |
<!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>Sample Use of Storage Driver</title>
<title>CMSIS-Driver: Sample Use of Storage Driver</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__SampleUseOfStorageDriver.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="headertitle">
<div class="title">Sample Use of Storage Driver<div class="ingroups"><a class="el" href="group__storage__interface__gr.html">Storage Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><b>Example Code:</b></p>
<p>The following is a generic algorithm to erase and program one <a class="el" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">ARM_STORAGE_BLOCK_ATTRIBUTES::erase_unit</a> worth of storage and then read it back to be verified. It handles both synchronous and asynchronous driver implementations.</p>
<div class="fragment"><div class="line"><span class="comment">// Copyright (c) 2006-2016, Arm Limited, All Rights Reserved</span></div>
<div class="line"><span class="comment">// SPDX-License-Identifier: Apache-2.0</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div>
<div class="line"><span class="comment">// not use this file except in compliance with the License.</span></div>
<div class="line"><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// http:// www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div>
<div class="line"><span class="comment">// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><span class="comment">// limitations under the License.</span></div>
<div class="line"></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__Storage_8h.html">Driver_Storage.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><span class="preprocessor">#include <string.h></span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#define TEST_ASSERT(Expr) if (!(Expr)) { printf("%s:%u: assertion failure\n", __FUNCTION__, __LINE__); while (1) ;}</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define TEST_ASSERT_EQUAL(expected, actual) if ((expected) != (actual)) {printf("%s:%u: assertion failure\n", __FUNCTION__, __LINE__); while (1) ;}</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define TEST_ASSERT_NOT_EQUAL(expected, actual) if ((expected) == (actual)) {printf("%s:%u: assertion failure\n", __FUNCTION__, __LINE__); while (1) ;}</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"><span class="comment">// forward declarations</span></div>
<div class="line"><span class="keywordtype">void</span> callbackHandler(int32_t status, <a class="code" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> operation);</div>
<div class="line"><span class="keywordtype">void</span> progressStateMachine(<span class="keywordtype">void</span>);</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <span class="keyword">enum</span> {</div>
<div class="line"> NEEDS_INITIALIZATION,</div>
<div class="line"> NEEDS_ERASE,</div>
<div class="line"> NEEDS_PROGRAMMING,</div>
<div class="line"> NEEDS_READ,</div>
<div class="line"> NEEDS_VERIFICATION_FOLLOWING_READ,</div>
<div class="line"> FINISHED</div>
<div class="line">} state;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> <a class="code" href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a>(0);</div>
<div class="line"><a class="code" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> *drv = &<a class="code" href="Driver__Storage_8h.html#af4ce245f055ef69edd1306ef8fde37cf">ARM_Driver_Storage_</a>(0);</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> BUFFER_SIZE = 16384;</div>
<div class="line"><span class="keyword">static</span> uint8_t buffer[BUFFER_SIZE];</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> main(<span class="keywordtype">int</span> argc __unused, <span class="keywordtype">char</span>** argv __unused)</div>
<div class="line">{</div>
<div class="line"> state = NEEDS_INITIALIZATION;</div>
<div class="line"> </div>
<div class="line"> progressStateMachine();</div>
<div class="line"> <span class="keywordflow">while</span> (<span class="keyword">true</span>) {</div>
<div class="line"> <span class="comment">// WFE(); // optional low-power sleep</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> progressStateMachine(<span class="keywordtype">void</span>)</div>
<div class="line">{</div>
<div class="line"> int32_t rc;</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">static</span> <a class="code" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> firstBlock;</div>
<div class="line"> <span class="keywordflow">if</span> (!<a class="code" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(&firstBlock)) {</div>
<div class="line"> <span class="comment">// Get the first block. This block is entered only once.</span></div>
<div class="line"> rc = drv-><a class="code" href="group__storage__interface__gr.html#adda93f4d74519247517f036c4551dd13">GetNextBlock</a>(NULL, &firstBlock); <span class="comment">// get first block</span></div>
<div class="line"> TEST_ASSERT_EQUAL(<a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>, rc);</div>
<div class="line"> }</div>
<div class="line"> TEST_ASSERT(<a class="code" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(&firstBlock));</div>
<div class="line"> TEST_ASSERT(firstBlock.<a class="code" href="group__storage__interface__gr.html#af931a8871310b4dad23f0f0b0f623560">size</a> > 0);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">switch</span> (state) {</div>
<div class="line"> <span class="keywordflow">case</span> NEEDS_INITIALIZATION:</div>
<div class="line"> rc = drv-><a class="code" href="group__storage__interface__gr.html#a4a126668a113ce450b0d831c74199b23">Initialize</a>(callbackHandler);</div>
<div class="line"> TEST_ASSERT(rc >= <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (rc == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code" href="group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55">GetCapabilities</a>().<a class="code" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
<div class="line"> state = NEEDS_ERASE;</div>
<div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
<div class="line"> }</div>
<div class="line"> TEST_ASSERT_EQUAL(1, rc); <span class="comment">// synchronous completion</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// intentional fall-through</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">case</span> NEEDS_ERASE:</div>
<div class="line"> TEST_ASSERT(firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a> > 0);</div>
<div class="line"> rc = drv-><a class="code" href="group__storage__interface__gr.html#abb5018d1afb3ea4632e6e6006314f37f">Erase</a>(firstBlock.<a class="code" href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">addr</a>, firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
<div class="line"> TEST_ASSERT(rc >= <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (rc == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code" href="group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55">GetCapabilities</a>().<a class="code" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
<div class="line"> state = NEEDS_PROGRAMMING;</div>
<div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
<div class="line"> }</div>
<div class="line"> TEST_ASSERT_EQUAL(firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>, (uint32_t)rc); <span class="comment">// synchronous completion</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// intentional fall-through</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">case</span> NEEDS_PROGRAMMING:</div>
<div class="line"> TEST_ASSERT(BUFFER_SIZE >= firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
<div class="line"><span class="preprocessor"> #define PATTERN 0xAA</span></div>
<div class="line"><span class="preprocessor"></span> memset(buffer, PATTERN, firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
<div class="line"> rc = drv-><a class="code" href="group__storage__interface__gr.html#aedda6cc77ea7c4ef2356c683f9013d8b">ProgramData</a>(firstBlock.<a class="code" href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">addr</a>, buffer, firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
<div class="line"> TEST_ASSERT(rc >= <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (rc == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code" href="group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55">GetCapabilities</a>().<a class="code" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
<div class="line"> state = NEEDS_READ;</div>
<div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
<div class="line"> }</div>
<div class="line"> TEST_ASSERT_EQUAL(firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>, (uint32_t)rc); <span class="comment">// synchronous completion</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// intentional fall-through</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">case</span> NEEDS_READ:</div>
<div class="line"> rc = drv-><a class="code" href="group__storage__interface__gr.html#a79b015933daca07a88f98a8f20e1144d">ReadData</a>(firstBlock.<a class="code" href="group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df">addr</a>, buffer, firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>);</div>
<div class="line"> TEST_ASSERT(rc >= <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (rc == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> TEST_ASSERT_EQUAL(1, drv-><a class="code" href="group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55">GetCapabilities</a>().<a class="code" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc">asynchronous_ops</a>);</div>
<div class="line"> state = NEEDS_VERIFICATION_FOLLOWING_READ;</div>
<div class="line"> <span class="keywordflow">return</span>; <span class="comment">// there is pending asynchronous activity which will lead to a completion callback later.</span></div>
<div class="line"> }</div>
<div class="line"> TEST_ASSERT_EQUAL(firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>, (uint32_t)rc);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// intentional fall-through</span></div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">case</span> NEEDS_VERIFICATION_FOLLOWING_READ:</div>
<div class="line"> printf(<span class="stringliteral">"verifying data\r\n"</span>);</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = 0; i < firstBlock.<a class="code" href="group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830">attributes</a>.<a class="code" href="group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a">erase_unit</a>; i++) {</div>
<div class="line"> TEST_ASSERT_EQUAL(PATTERN, buffer[i]);</div>
<div class="line"> }</div>
<div class="line"> state = FINISHED;</div>
<div class="line"> printf(<span class="stringliteral">"done\r\n"</span>);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">case</span> FINISHED:</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> } <span class="comment">// switch (state)</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> callbackHandler(int32_t status, <a class="code" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> operation)</div>
<div class="line">{</div>
<div class="line"> (void)status;</div>
<div class="line"> (void)operation;</div>
<div class="line"> <span class="keywordflow">switch</span> (operation) {</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971">ARM_STORAGE_OPERATION_INITIALIZE</a>:</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454">ARM_STORAGE_OPERATION_READ_DATA</a>:</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0">ARM_STORAGE_OPERATION_PROGRAM_DATA</a>:</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75">ARM_STORAGE_OPERATION_ERASE</a>:</div>
<div class="line"> progressStateMachine();</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">default</span>:</div>
<div class="line"> printf(<span class="stringliteral">"callbackHandler: unexpected callback for opcode %u with status %ld\r\n"</span>, operation, status);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line">}</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="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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__SampleUseOfStorageDriver.html | HTML | apache-2.0 | 24,828 |
<!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>Use of Storage APIs</title>
<title>CMSIS-Driver: Use of Storage APIs</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__StorageDriverFunctions.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="headertitle">
<div class="title">Use of Storage APIs<div class="ingroups"><a class="el" href="group__storage__interface__gr.html">Storage Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Function pointers within <a class="el" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> form the set of operations constituting the Storage driver. Their implementation is platform-specific, and needs to be supplied by the porting effort.</p>
<p>Some of these APIs will always operate synchronously:</p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#gaf28193431b1a2ee64b22bfb36aed27e3">ARM_Storage_GetVersion</a></li>
<li><a class="el" href="group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2">ARM_Storage_GetCapabilities</a></li>
<li><a class="el" href="group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20">ARM_Storage_GetStatus</a></li>
<li><a class="el" href="group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747">ARM_Storage_GetInfo</a></li>
<li><a class="el" href="group__storage__interface__gr.html#ga5a1934750a51c74b8b0fea52588a3b9a">ARM_Storage_ResolveAddress</a></li>
<li><a class="el" href="group__storage__interface__gr.html#gad318f8cb38626cbeea1fcf36a0977c44">ARM_Storage_GetNextBlock</a> and</li>
<li><a class="el" href="group__storage__interface__gr.html#ga5fe9d27ce8afe65124dec62566114073">ARM_Storage_GetBlock</a>.</li>
</ul>
<p>This means that control returns to the caller with a relevant status code only after the completion of the operation (or the discovery of a failure condition).</p>
<p>The remainder of the APIs:</p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174">ARM_Storage_Initialize</a></li>
<li><a class="el" href="group__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca">ARM_Storage_Uninitialize</a></li>
<li><a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54">ARM_Storage_PowerControl</a></li>
<li><a class="el" href="group__storage__interface__gr.html#gabaa24553c165add98020434c980b3ab4">ARM_Storage_ReadData</a></li>
<li><a class="el" href="group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230">ARM_Storage_ProgramData</a></li>
<li><a class="el" href="group__storage__interface__gr.html#gaceef4851d9181cce65c8b2d05f4429bc">ARM_Storage_Erase</a> and</li>
<li><a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a></li>
</ul>
<p>can function asynchronously if the underlying controller supports it; that is if <a class="el" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc" title="Used to indicate if APIs like initialize, read, erase, program, etc. can operate in asynchronous mode...">ARM_STORAGE_CAPABILITIES::asynchronous_ops</a> is set. In the case of asynchronous operation, the invocation returns early (with ARM_DRIVER_OK) and results in a completion callback later. If <a class="el" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc" title="Used to indicate if APIs like initialize, read, erase, program, etc. can operate in asynchronous mode...">ARM_STORAGE_CAPABILITIES::asynchronous_ops</a> is not set, then all such APIs execute synchronously, and control returns to the caller with a status code only after the completion of the operation (or the discovery of a failure condition).</p>
<p>If <a class="el" href="group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc" title="Used to indicate if APIs like initialize, read, erase, program, etc. can operate in asynchronous mode...">ARM_STORAGE_CAPABILITIES::asynchronous_ops</a> is set, a storage driver may still choose to execute asynchronous operations in a synchronous manner. If so, the driver returns a positive value to indicate successful synchronous completion (or an error code in case of failure) and no further invocation of completion callback should be expected. The expected return value for synchronous completion of such asynchronous operations varies depending on the operation. For operations involving data access, it often equals the amount of data transferred or affected. For non data-transfer operations, such as EraseAll or Initialize, it is usually 1.</p>
<p>Here's a code snippet to suggest how asynchronous APIs might be used by callers to handle both synchronous and asynchronous execution by the underlying storage driver: </p>
<div class="fragment"><div class="line">ASSERT(<a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> == 0); <span class="comment">// this is a precondition; it doesn't need to be put in code</span></div>
<div class="line"></div>
<div class="line">int32_t returnValue = drv->asynchronousAPI(...);</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (returnValue < <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// handle error.</span></div>
<div class="line"> </div>
<div class="line">} <span class="keywordflow">else</span> <span class="keywordflow">if</span> (returnValue == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> ASSERT(drv-><a class="code" href="group__nand__interface__gr.html#adab9d081aee3e5d1f83c6911e45ceaa6">GetCapabilities</a>().asynchronous_ops == 1);</div>
<div class="line"> <span class="comment">// handle early return from asynchronous execution; remainder of the work is done in the callback handler.</span></div>
<div class="line"> </div>
<div class="line">} <span class="keywordflow">else</span> {</div>
<div class="line"> ASSERT(returnValue == EXPECTED_RETURN_VALUE_FOR_SYNCHRONOUS_COMPLETION);</div>
<div class="line"> <span class="comment">// handle synchronous completion.</span></div>
<div class="line">}</div>
</div><!-- fragment --><p>THis example is mixing synchronous and asynchronous APIs: <a class="el" href="group__SampleUseOfStorageDriver.html">Sample Use of Storage Driver</a> </p>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__StorageDriverFunctions.html | HTML | apache-2.0 | 12,387 |
<!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>USART Control Codes</title>
<title>CMSIS-Driver: USART Control 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USART__control.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">USART Control Codes<div class="ingroups"><a class="el" href="group__usart__interface__gr.html">USART Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Many parameters of the USART driver are configured using the <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> function.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__usart__mode__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html">USART Mode Control</a></td></tr>
<tr class="memdesc:group__usart__mode__control"><td class="mdescLeft"> </td><td class="mdescRight">Specify USART mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__misc__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html">USART Miscellaneous Control</a></td></tr>
<tr class="memdesc:group__usart__misc__control"><td class="mdescLeft"> </td><td class="mdescRight">Specifies additional miscellaneous controls. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__data__bits"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html">USART Data Bits</a></td></tr>
<tr class="memdesc:group__usart__data__bits"><td class="mdescLeft"> </td><td class="mdescRight">Defines the number of data bits. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__parity__bit"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__parity__bit.html">USART Parity Bit</a></td></tr>
<tr class="memdesc:group__usart__parity__bit"><td class="mdescLeft"> </td><td class="mdescRight">Defines the parity bit. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__stop__bits"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__stop__bits.html">USART Stop Bits</a></td></tr>
<tr class="memdesc:group__usart__stop__bits"><td class="mdescLeft"> </td><td class="mdescRight">Defines the number of stop bits. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__flow__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html">USART Flow Control</a></td></tr>
<tr class="memdesc:group__usart__flow__control"><td class="mdescLeft"> </td><td class="mdescRight">Specifies RTS/CTS flow control. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__clock__polarity"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__clock__polarity.html">USART Clock Polarity</a></td></tr>
<tr class="memdesc:group__usart__clock__polarity"><td class="mdescLeft"> </td><td class="mdescRight">Defines the clock polarity for the synchronous mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usart__clock__phase"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__clock__phase.html">USART Clock Phase</a></td></tr>
<tr class="memdesc:group__usart__clock__phase"><td class="mdescLeft"> </td><td class="mdescRight">Defines the clock phase for the synchronous mode. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Many parameters of the USART driver are configured using the <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> function. </p>
<p>The various USART control codes define:</p>
<ul>
<li><a class="el" href="group__usart__mode__control.html">USART Mode Control</a> specifies USART mode</li>
<li><a class="el" href="group__usart__data__bits.html">USART Data Bits</a> defines the number of data bits</li>
<li><a class="el" href="group__usart__parity__bit.html">USART Parity Bit</a> defines the parity bit</li>
<li><a class="el" href="group__usart__stop__bits.html">USART Stop Bits</a> defines the number of stop bits</li>
<li><a class="el" href="group__usart__flow__control.html">USART Flow Control</a> specifies RTS/CTS flow control</li>
<li><a class="el" href="group__usart__clock__polarity.html">USART Clock Polarity</a> defines the clock polarity for the synchronous mode</li>
<li><a class="el" href="group__usart__clock__phase.html">USART Clock Phase</a> defines the clock phase for the synchronous mode</li>
<li><a class="el" href="group__usart__misc__control.html">USART Miscellaneous Control</a> specifies additional miscellaneous controls</li>
</ul>
<p>Refer to the <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> function for further details. </p>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USART__control.html | HTML | apache-2.0 | 11,944 |
var group__USART__control =
[
[ "USART Mode Control", "group__usart__mode__control.html", "group__usart__mode__control" ],
[ "USART Miscellaneous Control", "group__usart__misc__control.html", "group__usart__misc__control" ],
[ "USART Data Bits", "group__usart__data__bits.html", "group__usart__data__bits" ],
[ "USART Parity Bit", "group__usart__parity__bit.html", "group__usart__parity__bit" ],
[ "USART Stop Bits", "group__usart__stop__bits.html", "group__usart__stop__bits" ],
[ "USART Flow Control", "group__usart__flow__control.html", "group__usart__flow__control" ],
[ "USART Clock Polarity", "group__usart__clock__polarity.html", "group__usart__clock__polarity" ],
[ "USART Clock Phase", "group__usart__clock__phase.html", "group__usart__clock__phase" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USART__control.js | JavaScript | apache-2.0 | 795 |
<!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>USART Events</title>
<title>CMSIS-Driver: USART Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USART__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USART Events<div class="ingroups"><a class="el" href="group__usart__interface__gr.html">USART Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The USART driver generates call back events that are notified via the function <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a>.
<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:gaae1c626192b16ccace93f3546e7884bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gaae1c626192b16ccace93f3546e7884bf"><td class="mdescLeft"> </td><td class="mdescRight">Send completed; however USART may still transmit data. <a href="#gaae1c626192b16ccace93f3546e7884bf">More...</a><br/></td></tr>
<tr class="separator:gaae1c626192b16ccace93f3546e7884bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga08b165fd8525e44e3ce42ed6183cd30a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga08b165fd8525e44e3ce42ed6183cd30a"><td class="mdescLeft"> </td><td class="mdescRight">Receive completed. <a href="#ga08b165fd8525e44e3ce42ed6183cd30a">More...</a><br/></td></tr>
<tr class="separator:ga08b165fd8525e44e3ce42ed6183cd30a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0599793e6aa531d56ff9f81ff12605d7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga0599793e6aa531d56ff9f81ff12605d7"><td class="mdescLeft"> </td><td class="mdescRight">Transfer completed. <a href="#ga0599793e6aa531d56ff9f81ff12605d7">More...</a><br/></td></tr>
<tr class="separator:ga0599793e6aa531d56ff9f81ff12605d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12872a3b04343f97d9535b5b0d37286d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga12872a3b04343f97d9535b5b0d37286d"><td class="mdescLeft"> </td><td class="mdescRight">Transmit completed (optional) <a href="#ga12872a3b04343f97d9535b5b0d37286d">More...</a><br/></td></tr>
<tr class="separator:ga12872a3b04343f97d9535b5b0d37286d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae57b9977bd338bf8bef86978843fa443"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a>   (1UL << 4)</td></tr>
<tr class="memdesc:gae57b9977bd338bf8bef86978843fa443"><td class="mdescLeft"> </td><td class="mdescRight">Transmit data not available (Synchronous Slave) <a href="#gae57b9977bd338bf8bef86978843fa443">More...</a><br/></td></tr>
<tr class="separator:gae57b9977bd338bf8bef86978843fa443"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga43a0869daf83abb3fea96926a97047ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga43a0869daf83abb3fea96926a97047ad"><td class="mdescLeft"> </td><td class="mdescRight">Receive data overflow. <a href="#ga43a0869daf83abb3fea96926a97047ad">More...</a><br/></td></tr>
<tr class="separator:ga43a0869daf83abb3fea96926a97047ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66ee2256571450a3fc3c530344ea9bd7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a>   (1UL << 6)</td></tr>
<tr class="memdesc:ga66ee2256571450a3fc3c530344ea9bd7"><td class="mdescLeft"> </td><td class="mdescRight">Receive character timeout (optional) <a href="#ga66ee2256571450a3fc3c530344ea9bd7">More...</a><br/></td></tr>
<tr class="separator:ga66ee2256571450a3fc3c530344ea9bd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1d19e48faf2bdc2a976de448928288e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gaa1d19e48faf2bdc2a976de448928288e">ARM_USART_EVENT_RX_BREAK</a>   (1UL << 7)</td></tr>
<tr class="memdesc:gaa1d19e48faf2bdc2a976de448928288e"><td class="mdescLeft"> </td><td class="mdescRight">Break detected on receive. <a href="#gaa1d19e48faf2bdc2a976de448928288e">More...</a><br/></td></tr>
<tr class="separator:gaa1d19e48faf2bdc2a976de448928288e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d97495c650220fbfe9d6977d0953127"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127">ARM_USART_EVENT_RX_FRAMING_ERROR</a>   (1UL << 8)</td></tr>
<tr class="memdesc:ga2d97495c650220fbfe9d6977d0953127"><td class="mdescLeft"> </td><td class="mdescRight">Framing error detected on receive. <a href="#ga2d97495c650220fbfe9d6977d0953127">More...</a><br/></td></tr>
<tr class="separator:ga2d97495c650220fbfe9d6977d0953127"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb4fec2530fc5ae3ad2b056741883451"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451">ARM_USART_EVENT_RX_PARITY_ERROR</a>   (1UL << 9)</td></tr>
<tr class="memdesc:gadb4fec2530fc5ae3ad2b056741883451"><td class="mdescLeft"> </td><td class="mdescRight">Parity error detected on receive. <a href="#gadb4fec2530fc5ae3ad2b056741883451">More...</a><br/></td></tr>
<tr class="separator:gadb4fec2530fc5ae3ad2b056741883451"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4cd807ca131bdcb1a7eb4f223fa70476"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga4cd807ca131bdcb1a7eb4f223fa70476">ARM_USART_EVENT_CTS</a>   (1UL << 10)</td></tr>
<tr class="memdesc:ga4cd807ca131bdcb1a7eb4f223fa70476"><td class="mdescLeft"> </td><td class="mdescRight">CTS state changed (optional) <a href="#ga4cd807ca131bdcb1a7eb4f223fa70476">More...</a><br/></td></tr>
<tr class="separator:ga4cd807ca131bdcb1a7eb4f223fa70476"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5afef591c2e8dd9bc4332b7bc8d96309"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga5afef591c2e8dd9bc4332b7bc8d96309">ARM_USART_EVENT_DSR</a>   (1UL << 11)</td></tr>
<tr class="memdesc:ga5afef591c2e8dd9bc4332b7bc8d96309"><td class="mdescLeft"> </td><td class="mdescRight">DSR state changed (optional) <a href="#ga5afef591c2e8dd9bc4332b7bc8d96309">More...</a><br/></td></tr>
<tr class="separator:ga5afef591c2e8dd9bc4332b7bc8d96309"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1628b951feba1c851f424ce89da409a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga1628b951feba1c851f424ce89da409a4">ARM_USART_EVENT_DCD</a>   (1UL << 12)</td></tr>
<tr class="memdesc:ga1628b951feba1c851f424ce89da409a4"><td class="mdescLeft"> </td><td class="mdescRight">DCD state changed (optional) <a href="#ga1628b951feba1c851f424ce89da409a4">More...</a><br/></td></tr>
<tr class="separator:ga1628b951feba1c851f424ce89da409a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac17fe5723d4c5923656dadd9d1302154"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gac17fe5723d4c5923656dadd9d1302154">ARM_USART_EVENT_RI</a>   (1UL << 13)</td></tr>
<tr class="memdesc:gac17fe5723d4c5923656dadd9d1302154"><td class="mdescLeft"> </td><td class="mdescRight">RI state changed (optional) <a href="#gac17fe5723d4c5923656dadd9d1302154">More...</a><br/></td></tr>
<tr class="separator:gac17fe5723d4c5923656dadd9d1302154"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The USART driver generates call back events that are notified via the function <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaae1c626192b16ccace93f3546e7884bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_SEND_COMPLETE   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send completed; however USART may still transmit data. </p>
</div>
</div>
<a class="anchor" id="ga08b165fd8525e44e3ce42ed6183cd30a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RECEIVE_COMPLETE   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive completed. </p>
</div>
</div>
<a class="anchor" id="ga0599793e6aa531d56ff9f81ff12605d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_TRANSFER_COMPLETE   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transfer completed. </p>
</div>
</div>
<a class="anchor" id="ga12872a3b04343f97d9535b5b0d37286d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_TX_COMPLETE   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit completed (optional) </p>
</div>
</div>
<a class="anchor" id="gae57b9977bd338bf8bef86978843fa443"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_TX_UNDERFLOW   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit data not available (Synchronous Slave) </p>
</div>
</div>
<a class="anchor" id="ga43a0869daf83abb3fea96926a97047ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RX_OVERFLOW   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive data overflow. </p>
</div>
</div>
<a class="anchor" id="ga66ee2256571450a3fc3c530344ea9bd7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RX_TIMEOUT   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive character timeout (optional) </p>
</div>
</div>
<a class="anchor" id="gaa1d19e48faf2bdc2a976de448928288e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RX_BREAK   (1UL << 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Break detected on receive. </p>
</div>
</div>
<a class="anchor" id="ga2d97495c650220fbfe9d6977d0953127"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RX_FRAMING_ERROR   (1UL << 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Framing error detected on receive. </p>
</div>
</div>
<a class="anchor" id="gadb4fec2530fc5ae3ad2b056741883451"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RX_PARITY_ERROR   (1UL << 9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parity error detected on receive. </p>
</div>
</div>
<a class="anchor" id="ga4cd807ca131bdcb1a7eb4f223fa70476"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_CTS   (1UL << 10)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CTS state changed (optional) </p>
</div>
</div>
<a class="anchor" id="ga5afef591c2e8dd9bc4332b7bc8d96309"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_DSR   (1UL << 11)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DSR state changed (optional) </p>
</div>
</div>
<a class="anchor" id="ga1628b951feba1c851f424ce89da409a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_DCD   (1UL << 12)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DCD state changed (optional) </p>
</div>
</div>
<a class="anchor" id="gac17fe5723d4c5923656dadd9d1302154"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_EVENT_RI   (1UL << 13)</td>
</tr>
</table>
</div><div class="memdoc">
<p>RI state changed (optional) </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USART__events.html | HTML | apache-2.0 | 21,575 |
var group__USART__events =
[
[ "ARM_USART_EVENT_SEND_COMPLETE", "group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf", null ],
[ "ARM_USART_EVENT_RECEIVE_COMPLETE", "group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a", null ],
[ "ARM_USART_EVENT_TRANSFER_COMPLETE", "group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7", null ],
[ "ARM_USART_EVENT_TX_COMPLETE", "group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d", null ],
[ "ARM_USART_EVENT_TX_UNDERFLOW", "group__USART__events.html#gae57b9977bd338bf8bef86978843fa443", null ],
[ "ARM_USART_EVENT_RX_OVERFLOW", "group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad", null ],
[ "ARM_USART_EVENT_RX_TIMEOUT", "group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7", null ],
[ "ARM_USART_EVENT_RX_BREAK", "group__USART__events.html#gaa1d19e48faf2bdc2a976de448928288e", null ],
[ "ARM_USART_EVENT_RX_FRAMING_ERROR", "group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127", null ],
[ "ARM_USART_EVENT_RX_PARITY_ERROR", "group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451", null ],
[ "ARM_USART_EVENT_CTS", "group__USART__events.html#ga4cd807ca131bdcb1a7eb4f223fa70476", null ],
[ "ARM_USART_EVENT_DSR", "group__USART__events.html#ga5afef591c2e8dd9bc4332b7bc8d96309", null ],
[ "ARM_USART_EVENT_DCD", "group__USART__events.html#ga1628b951feba1c851f424ce89da409a4", null ],
[ "ARM_USART_EVENT_RI", "group__USART__events.html#gac17fe5723d4c5923656dadd9d1302154", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USART__events.js | JavaScript | apache-2.0 | 1,542 |
<!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>USBD Device Events</title>
<title>CMSIS-Driver: USBD Device Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USBD__dev__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USBD Device Events<div class="ingroups"><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The USB Device driver generates Device call back events that are notified via the function <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a>.
<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:ga32546413cfe55154351f74fb56de1045"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045">ARM_USBD_EVENT_VBUS_ON</a>   (1UL << 0)</td></tr>
<tr class="memdesc:ga32546413cfe55154351f74fb56de1045"><td class="mdescLeft"> </td><td class="mdescRight">USB Device VBUS On. <a href="#ga32546413cfe55154351f74fb56de1045">More...</a><br/></td></tr>
<tr class="separator:ga32546413cfe55154351f74fb56de1045"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec">ARM_USBD_EVENT_VBUS_OFF</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="mdescLeft"> </td><td class="mdescRight">USB Device VBUS Off. <a href="#ga6810c08a6e6a46ba443899e5ba9c3aec">More...</a><br/></td></tr>
<tr class="separator:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a">ARM_USBD_EVENT_RESET</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="mdescLeft"> </td><td class="mdescRight">USB Reset occurred. <a href="#ga489e1b88f7b0361494ca3a8dc73c227a">More...</a><br/></td></tr>
<tr class="separator:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga689d1e031013d0e66aeef4243490d843"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843">ARM_USBD_EVENT_HIGH_SPEED</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga689d1e031013d0e66aeef4243490d843"><td class="mdescLeft"> </td><td class="mdescRight">USB switch to High Speed occurred. <a href="#ga689d1e031013d0e66aeef4243490d843">More...</a><br/></td></tr>
<tr class="separator:ga689d1e031013d0e66aeef4243490d843"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74dc7c0ba71baf285400d5a555224653"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653">ARM_USBD_EVENT_SUSPEND</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga74dc7c0ba71baf285400d5a555224653"><td class="mdescLeft"> </td><td class="mdescRight">USB Suspend occurred. <a href="#ga74dc7c0ba71baf285400d5a555224653">More...</a><br/></td></tr>
<tr class="separator:ga74dc7c0ba71baf285400d5a555224653"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45">ARM_USBD_EVENT_RESUME</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga5b1c9884b237ba7778f79761e5db9f45"><td class="mdescLeft"> </td><td class="mdescRight">USB Resume occurred. <a href="#ga5b1c9884b237ba7778f79761e5db9f45">More...</a><br/></td></tr>
<tr class="separator:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The USB Device driver generates Device call back events that are notified via the function <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga32546413cfe55154351f74fb56de1045"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_VBUS_ON   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device VBUS On. </p>
</div>
</div>
<a class="anchor" id="ga6810c08a6e6a46ba443899e5ba9c3aec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_VBUS_OFF   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device VBUS Off. </p>
</div>
</div>
<a class="anchor" id="ga489e1b88f7b0361494ca3a8dc73c227a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_RESET   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Reset occurred. </p>
</div>
</div>
<a class="anchor" id="ga689d1e031013d0e66aeef4243490d843"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_HIGH_SPEED   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB switch to High Speed occurred. </p>
</div>
</div>
<a class="anchor" id="ga74dc7c0ba71baf285400d5a555224653"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_SUSPEND   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Suspend occurred. </p>
</div>
</div>
<a class="anchor" id="ga5b1c9884b237ba7778f79761e5db9f45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_RESUME   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Resume occurred. </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBD__dev__events.html | HTML | apache-2.0 | 13,375 |
var group__USBD__dev__events =
[
[ "ARM_USBD_EVENT_VBUS_ON", "group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045", null ],
[ "ARM_USBD_EVENT_VBUS_OFF", "group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec", null ],
[ "ARM_USBD_EVENT_RESET", "group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a", null ],
[ "ARM_USBD_EVENT_HIGH_SPEED", "group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843", null ],
[ "ARM_USBD_EVENT_SUSPEND", "group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653", null ],
[ "ARM_USBD_EVENT_RESUME", "group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBD__dev__events.js | JavaScript | apache-2.0 | 683 |
<!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>USBD Endpoint Events</title>
<title>CMSIS-Driver: USBD Endpoint Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USBD__ep__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USBD Endpoint Events<div class="ingroups"><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The USB Device driver generates Endpoint call back events that are notified via the function <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a>.
<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:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">ARM_USBD_EVENT_SETUP</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="mdescLeft"> </td><td class="mdescRight">SETUP Packet. <a href="#gaa0814f6880f4c0ac302ac9ebc8170739">More...</a><br/></td></tr>
<tr class="separator:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">ARM_USBD_EVENT_OUT</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="mdescLeft"> </td><td class="mdescRight">OUT Packet(s) <a href="#ga35f7340508acb5fe7a5f43bbcac1887a">More...</a><br/></td></tr>
<tr class="separator:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga375d3d8f363a056ff607c5ab3b92a864"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">ARM_USBD_EVENT_IN</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga375d3d8f363a056ff607c5ab3b92a864"><td class="mdescLeft"> </td><td class="mdescRight">IN Packet(s) <a href="#ga375d3d8f363a056ff607c5ab3b92a864">More...</a><br/></td></tr>
<tr class="separator:ga375d3d8f363a056ff607c5ab3b92a864"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The USB Device driver generates Endpoint call back events that are notified via the function <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaa0814f6880f4c0ac302ac9ebc8170739"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_SETUP   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SETUP Packet. </p>
</div>
</div>
<a class="anchor" id="ga35f7340508acb5fe7a5f43bbcac1887a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_OUT   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>OUT Packet(s) </p>
</div>
</div>
<a class="anchor" id="ga375d3d8f363a056ff607c5ab3b92a864"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBD_EVENT_IN   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>IN Packet(s) </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBD__ep__events.html | HTML | apache-2.0 | 10,320 |
var group__USBD__ep__events =
[
[ "ARM_USBD_EVENT_SETUP", "group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739", null ],
[ "ARM_USBD_EVENT_OUT", "group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a", null ],
[ "ARM_USBD_EVENT_IN", "group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBD__ep__events.js | JavaScript | apache-2.0 | 343 |
<!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>USBH Packet Information</title>
<title>CMSIS-Driver: USBH Packet Information</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USBH__packets.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USBH Packet Information<div class="ingroups"><a class="el" href="group__usbh__host__gr.html">USB Host</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify USB packet information used by the function <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>.
<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:gafb0bcfee8abd4ada7f789aec2993048a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#gafb0bcfee8abd4ada7f789aec2993048a">ARM_USBH_PACKET_SETUP</a>   (0x01UL << ARM_USBH_PACKET_TOKEN_Pos)</td></tr>
<tr class="memdesc:gafb0bcfee8abd4ada7f789aec2993048a"><td class="mdescLeft"> </td><td class="mdescRight">SETUP Packet. <a href="#gafb0bcfee8abd4ada7f789aec2993048a">More...</a><br/></td></tr>
<tr class="separator:gafb0bcfee8abd4ada7f789aec2993048a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga409b2ae6503e738eb86e35652f9ebf8d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga409b2ae6503e738eb86e35652f9ebf8d">ARM_USBH_PACKET_OUT</a>   (0x02UL << ARM_USBH_PACKET_TOKEN_Pos)</td></tr>
<tr class="memdesc:ga409b2ae6503e738eb86e35652f9ebf8d"><td class="mdescLeft"> </td><td class="mdescRight">OUT Packet. <a href="#ga409b2ae6503e738eb86e35652f9ebf8d">More...</a><br/></td></tr>
<tr class="separator:ga409b2ae6503e738eb86e35652f9ebf8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga08d60ec20c091b5e7e252d137268cb76"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga08d60ec20c091b5e7e252d137268cb76">ARM_USBH_PACKET_IN</a>   (0x03UL << ARM_USBH_PACKET_TOKEN_Pos)</td></tr>
<tr class="memdesc:ga08d60ec20c091b5e7e252d137268cb76"><td class="mdescLeft"> </td><td class="mdescRight">IN Packet. <a href="#ga08d60ec20c091b5e7e252d137268cb76">More...</a><br/></td></tr>
<tr class="separator:ga08d60ec20c091b5e7e252d137268cb76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2eeab58cebb4556214c021ff02c36b16"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga2eeab58cebb4556214c021ff02c36b16">ARM_USBH_PACKET_PING</a>   (0x04UL << ARM_USBH_PACKET_TOKEN_Pos)</td></tr>
<tr class="memdesc:ga2eeab58cebb4556214c021ff02c36b16"><td class="mdescLeft"> </td><td class="mdescRight">PING Packet. <a href="#ga2eeab58cebb4556214c021ff02c36b16">More...</a><br/></td></tr>
<tr class="separator:ga2eeab58cebb4556214c021ff02c36b16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga40075aa1d3eff6d4b94dfe28d7745873"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga40075aa1d3eff6d4b94dfe28d7745873">ARM_USBH_PACKET_DATA0</a>   (0x01UL << ARM_USBH_PACKET_DATA_Pos)</td></tr>
<tr class="memdesc:ga40075aa1d3eff6d4b94dfe28d7745873"><td class="mdescLeft"> </td><td class="mdescRight">DATA0 PID. <a href="#ga40075aa1d3eff6d4b94dfe28d7745873">More...</a><br/></td></tr>
<tr class="separator:ga40075aa1d3eff6d4b94dfe28d7745873"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga34014ff212b26e3ee8c8670a180846e2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga34014ff212b26e3ee8c8670a180846e2">ARM_USBH_PACKET_DATA1</a>   (0x02UL << ARM_USBH_PACKET_DATA_Pos)</td></tr>
<tr class="memdesc:ga34014ff212b26e3ee8c8670a180846e2"><td class="mdescLeft"> </td><td class="mdescRight">DATA1 PID. <a href="#ga34014ff212b26e3ee8c8670a180846e2">More...</a><br/></td></tr>
<tr class="separator:ga34014ff212b26e3ee8c8670a180846e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf47930d994c53fc1772caed129aee921"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#gaf47930d994c53fc1772caed129aee921">ARM_USBH_PACKET_SSPLIT</a>   (0x08UL << ARM_USBH_PACKET_SPLIT_Pos)</td></tr>
<tr class="memdesc:gaf47930d994c53fc1772caed129aee921"><td class="mdescLeft"> </td><td class="mdescRight">SSPLIT Packet. <a href="#gaf47930d994c53fc1772caed129aee921">More...</a><br/></td></tr>
<tr class="separator:gaf47930d994c53fc1772caed129aee921"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b8fa0d3aa083718b4f5d60e92394b47"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga3b8fa0d3aa083718b4f5d60e92394b47">ARM_USBH_PACKET_SSPLIT_S</a>   (0x09UL << ARM_USBH_PACKET_SPLIT_Pos)</td></tr>
<tr class="memdesc:ga3b8fa0d3aa083718b4f5d60e92394b47"><td class="mdescLeft"> </td><td class="mdescRight">SSPLIT Packet: Data Start. <a href="#ga3b8fa0d3aa083718b4f5d60e92394b47">More...</a><br/></td></tr>
<tr class="separator:ga3b8fa0d3aa083718b4f5d60e92394b47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf99ee84befc6522fef56b21df870df72"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#gaf99ee84befc6522fef56b21df870df72">ARM_USBH_PACKET_SSPLIT_E</a>   (0x0AUL << ARM_USBH_PACKET_SPLIT_Pos)</td></tr>
<tr class="memdesc:gaf99ee84befc6522fef56b21df870df72"><td class="mdescLeft"> </td><td class="mdescRight">SSPLIT Packet: Data End. <a href="#gaf99ee84befc6522fef56b21df870df72">More...</a><br/></td></tr>
<tr class="separator:gaf99ee84befc6522fef56b21df870df72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d2b46fbc04d871abe0661f8acd18a94"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga8d2b46fbc04d871abe0661f8acd18a94">ARM_USBH_PACKET_SSPLIT_S_E</a>   (0x0BUL << ARM_USBH_PACKET_SPLIT_Pos)</td></tr>
<tr class="memdesc:ga8d2b46fbc04d871abe0661f8acd18a94"><td class="mdescLeft"> </td><td class="mdescRight">SSPLIT Packet: Data All. <a href="#ga8d2b46fbc04d871abe0661f8acd18a94">More...</a><br/></td></tr>
<tr class="separator:ga8d2b46fbc04d871abe0661f8acd18a94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadbfbbf7b4709f3ee4c3610da8402cfec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#gadbfbbf7b4709f3ee4c3610da8402cfec">ARM_USBH_PACKET_CSPLIT</a>   (0x0CUL << ARM_USBH_PACKET_SPLIT_Pos)</td></tr>
<tr class="memdesc:gadbfbbf7b4709f3ee4c3610da8402cfec"><td class="mdescLeft"> </td><td class="mdescRight">CSPLIT Packet. <a href="#gadbfbbf7b4709f3ee4c3610da8402cfec">More...</a><br/></td></tr>
<tr class="separator:gadbfbbf7b4709f3ee4c3610da8402cfec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6dd82c7b96bc1339d725a6133a32a62f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html#ga6dd82c7b96bc1339d725a6133a32a62f">ARM_USBH_PACKET_PRE</a>   (1UL << 12)</td></tr>
<tr class="memdesc:ga6dd82c7b96bc1339d725a6133a32a62f"><td class="mdescLeft"> </td><td class="mdescRight">PRE Token. <a href="#ga6dd82c7b96bc1339d725a6133a32a62f">More...</a><br/></td></tr>
<tr class="separator:ga6dd82c7b96bc1339d725a6133a32a62f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify USB packet information used by the function <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>. </p>
<p>This section provides the packet information values (parameter <em>packet</em>) for the <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> function.</p>
<p>The following values are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gafb0bcfee8abd4ada7f789aec2993048a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_SETUP   (0x01UL << ARM_USBH_PACKET_TOKEN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SETUP Packet. </p>
<p>Generate SETUP transaction. </p>
</div>
</div>
<a class="anchor" id="ga409b2ae6503e738eb86e35652f9ebf8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_OUT   (0x02UL << ARM_USBH_PACKET_TOKEN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>OUT Packet. </p>
<p>Generate OUT transaction. </p>
</div>
</div>
<a class="anchor" id="ga08d60ec20c091b5e7e252d137268cb76"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_IN   (0x03UL << ARM_USBH_PACKET_TOKEN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>IN Packet. </p>
<p>Generate IN transaction. </p>
</div>
</div>
<a class="anchor" id="ga2eeab58cebb4556214c021ff02c36b16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_PING   (0x04UL << ARM_USBH_PACKET_TOKEN_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>PING Packet. </p>
<p>Generate PING transaction (no data packet). </p>
</div>
</div>
<a class="anchor" id="ga40075aa1d3eff6d4b94dfe28d7745873"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_DATA0   (0x01UL << ARM_USBH_PACKET_DATA_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DATA0 PID. </p>
<p>Force DATA0 PID (Packet Identifier) for the initial data packet. When not specified than the driver provides the initial value according to the current state. </p>
</div>
</div>
<a class="anchor" id="ga34014ff212b26e3ee8c8670a180846e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_DATA1   (0x02UL << ARM_USBH_PACKET_DATA_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>DATA1 PID. </p>
<p>Force DATA1 PID (Packet Identifier) for the initial data packet. When not specified than the driver provides the initial value according to the current state. </p>
</div>
</div>
<a class="anchor" id="gaf47930d994c53fc1772caed129aee921"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_SSPLIT   (0x08UL << ARM_USBH_PACKET_SPLIT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SSPLIT Packet. </p>
<p>Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. For isochronous OUT it indicates that the High-speed data is in the middle of the Full-speed data payload. </p>
</div>
</div>
<a class="anchor" id="ga3b8fa0d3aa083718b4f5d60e92394b47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_SSPLIT_S   (0x09UL << ARM_USBH_PACKET_SPLIT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SSPLIT Packet: Data Start. </p>
<p>Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. Valid only for isochronous OUT and indicates that the High-speed data is the start of the Full-speed data payload. </p>
</div>
</div>
<a class="anchor" id="gaf99ee84befc6522fef56b21df870df72"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_SSPLIT_E   (0x0AUL << ARM_USBH_PACKET_SPLIT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SSPLIT Packet: Data End. </p>
<p>Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. Valid only for isochronous OUT and indicates that the High-speed data is the end of the Full-speed data payload. </p>
</div>
</div>
<a class="anchor" id="ga8d2b46fbc04d871abe0661f8acd18a94"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_SSPLIT_S_E   (0x0BUL << ARM_USBH_PACKET_SPLIT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SSPLIT Packet: Data All. </p>
<p>Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet. Valid only for isochronous OUT and indicates that the High-speed data is all of the Full-speed data payload. </p>
</div>
</div>
<a class="anchor" id="gadbfbbf7b4709f3ee4c3610da8402cfec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_CSPLIT   (0x0CUL << ARM_USBH_PACKET_SPLIT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CSPLIT Packet. </p>
<p>Used when driver does not support automatic handling of SPLIT packets and indicates Complete-Split packet. </p>
</div>
</div>
<a class="anchor" id="ga6dd82c7b96bc1339d725a6133a32a62f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_PACKET_PRE   (1UL << 12)</td>
</tr>
</table>
</div><div class="memdoc">
<p>PRE Token. </p>
<p>Generate PRE (Preamble) for low-speed devices within a full/low-speed signaling environment. </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBH__packets.html | HTML | apache-2.0 | 21,189 |
var group__USBH__packets =
[
[ "ARM_USBH_PACKET_SETUP", "group__USBH__packets.html#gafb0bcfee8abd4ada7f789aec2993048a", null ],
[ "ARM_USBH_PACKET_OUT", "group__USBH__packets.html#ga409b2ae6503e738eb86e35652f9ebf8d", null ],
[ "ARM_USBH_PACKET_IN", "group__USBH__packets.html#ga08d60ec20c091b5e7e252d137268cb76", null ],
[ "ARM_USBH_PACKET_PING", "group__USBH__packets.html#ga2eeab58cebb4556214c021ff02c36b16", null ],
[ "ARM_USBH_PACKET_DATA0", "group__USBH__packets.html#ga40075aa1d3eff6d4b94dfe28d7745873", null ],
[ "ARM_USBH_PACKET_DATA1", "group__USBH__packets.html#ga34014ff212b26e3ee8c8670a180846e2", null ],
[ "ARM_USBH_PACKET_SSPLIT", "group__USBH__packets.html#gaf47930d994c53fc1772caed129aee921", null ],
[ "ARM_USBH_PACKET_SSPLIT_S", "group__USBH__packets.html#ga3b8fa0d3aa083718b4f5d60e92394b47", null ],
[ "ARM_USBH_PACKET_SSPLIT_E", "group__USBH__packets.html#gaf99ee84befc6522fef56b21df870df72", null ],
[ "ARM_USBH_PACKET_SSPLIT_S_E", "group__USBH__packets.html#ga8d2b46fbc04d871abe0661f8acd18a94", null ],
[ "ARM_USBH_PACKET_CSPLIT", "group__USBH__packets.html#gadbfbbf7b4709f3ee4c3610da8402cfec", null ],
[ "ARM_USBH_PACKET_PRE", "group__USBH__packets.html#ga6dd82c7b96bc1339d725a6133a32a62f", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBH__packets.js | JavaScript | apache-2.0 | 1,271 |
<!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>USBH Pipe Events</title>
<title>CMSIS-Driver: USBH Pipe Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USBH__pipe__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USBH Pipe Events<div class="ingroups"><a class="el" href="group__usbh__host__gr.html">USB Host</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The USB Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>.
<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:gab161955b1ab0b7928befe446ef78634b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gab161955b1ab0b7928befe446ef78634b"><td class="mdescLeft"> </td><td class="mdescRight">Transfer completed. <a href="#gab161955b1ab0b7928befe446ef78634b">More...</a><br/></td></tr>
<tr class="separator:gab161955b1ab0b7928befe446ef78634b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0">ARM_USBH_EVENT_HANDSHAKE_NAK</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="mdescLeft"> </td><td class="mdescRight">NAK Handshake received. <a href="#ga3895b82193855d9a6f0b7e8a9b65e2c0">More...</a><br/></td></tr>
<tr class="separator:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga62ae214576c923ce737a16098e9836e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga62ae214576c923ce737a16098e9836e5">ARM_USBH_EVENT_HANDSHAKE_NYET</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga62ae214576c923ce737a16098e9836e5"><td class="mdescLeft"> </td><td class="mdescRight">NYET Handshake received. <a href="#ga62ae214576c923ce737a16098e9836e5">More...</a><br/></td></tr>
<tr class="separator:ga62ae214576c923ce737a16098e9836e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010">ARM_USBH_EVENT_HANDSHAKE_MDATA</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="mdescLeft"> </td><td class="mdescRight">MDATA Handshake received. <a href="#ga681ce0983f8c77c41f3cc5df1af8d010">More...</a><br/></td></tr>
<tr class="separator:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8">ARM_USBH_EVENT_HANDSHAKE_STALL</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="mdescLeft"> </td><td class="mdescRight">STALL Handshake received. <a href="#ga4fdc44fc78f342576dd11ad7cb84b4b8">More...</a><br/></td></tr>
<tr class="separator:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac7cc573f879fbab678dc7d1347c68614"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614">ARM_USBH_EVENT_HANDSHAKE_ERR</a>   (1UL << 5)</td></tr>
<tr class="memdesc:gac7cc573f879fbab678dc7d1347c68614"><td class="mdescLeft"> </td><td class="mdescRight">ERR Handshake received. <a href="#gac7cc573f879fbab678dc7d1347c68614">More...</a><br/></td></tr>
<tr class="separator:gac7cc573f879fbab678dc7d1347c68614"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bd871b1e5c059bee398c32429370724"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga7bd871b1e5c059bee398c32429370724">ARM_USBH_EVENT_BUS_ERROR</a>   (1UL << 6)</td></tr>
<tr class="memdesc:ga7bd871b1e5c059bee398c32429370724"><td class="mdescLeft"> </td><td class="mdescRight">Bus Error detected. <a href="#ga7bd871b1e5c059bee398c32429370724">More...</a><br/></td></tr>
<tr class="separator:ga7bd871b1e5c059bee398c32429370724"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The USB Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gab161955b1ab0b7928befe446ef78634b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_TRANSFER_COMPLETE   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transfer completed. </p>
</div>
</div>
<a class="anchor" id="ga3895b82193855d9a6f0b7e8a9b65e2c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_NAK   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>NAK Handshake received. </p>
</div>
</div>
<a class="anchor" id="ga62ae214576c923ce737a16098e9836e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_NYET   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>NYET Handshake received. </p>
</div>
</div>
<a class="anchor" id="ga681ce0983f8c77c41f3cc5df1af8d010"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_MDATA   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>MDATA Handshake received. </p>
</div>
</div>
<a class="anchor" id="ga4fdc44fc78f342576dd11ad7cb84b4b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_STALL   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>STALL Handshake received. </p>
</div>
</div>
<a class="anchor" id="gac7cc573f879fbab678dc7d1347c68614"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_ERR   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>ERR Handshake received. </p>
</div>
</div>
<a class="anchor" id="ga7bd871b1e5c059bee398c32429370724"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_BUS_ERROR   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bus Error detected. </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBH__pipe__events.html | HTML | apache-2.0 | 14,424 |
var group__USBH__pipe__events =
[
[ "ARM_USBH_EVENT_TRANSFER_COMPLETE", "group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b", null ],
[ "ARM_USBH_EVENT_HANDSHAKE_NAK", "group__USBH__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0", null ],
[ "ARM_USBH_EVENT_HANDSHAKE_NYET", "group__USBH__pipe__events.html#ga62ae214576c923ce737a16098e9836e5", null ],
[ "ARM_USBH_EVENT_HANDSHAKE_MDATA", "group__USBH__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010", null ],
[ "ARM_USBH_EVENT_HANDSHAKE_STALL", "group__USBH__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8", null ],
[ "ARM_USBH_EVENT_HANDSHAKE_ERR", "group__USBH__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614", null ],
[ "ARM_USBH_EVENT_BUS_ERROR", "group__USBH__pipe__events.html#ga7bd871b1e5c059bee398c32429370724", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBH__pipe__events.js | JavaScript | apache-2.0 | 845 |
<!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>USBH Port Events</title>
<title>CMSIS-Driver: USBH Port Events</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USBH__port__events.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USBH Port Events<div class="ingroups"><a class="el" href="group__usbh__host__gr.html">USB Host</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The USB Host driver generates Port call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a>.
<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:ga71bfd8b8cd41b8aa6303d5d3a91597e6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#ga71bfd8b8cd41b8aa6303d5d3a91597e6">ARM_USBH_EVENT_CONNECT</a>   (1UL << 0)</td></tr>
<tr class="memdesc:ga71bfd8b8cd41b8aa6303d5d3a91597e6"><td class="mdescLeft"> </td><td class="mdescRight">USB Device Connected to Port. <a href="#ga71bfd8b8cd41b8aa6303d5d3a91597e6">More...</a><br/></td></tr>
<tr class="separator:ga71bfd8b8cd41b8aa6303d5d3a91597e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba67919f64e9a08ba1264363b2710d20"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#gaba67919f64e9a08ba1264363b2710d20">ARM_USBH_EVENT_DISCONNECT</a>   (1UL << 1)</td></tr>
<tr class="memdesc:gaba67919f64e9a08ba1264363b2710d20"><td class="mdescLeft"> </td><td class="mdescRight">USB Device Disconnected from Port. <a href="#gaba67919f64e9a08ba1264363b2710d20">More...</a><br/></td></tr>
<tr class="separator:gaba67919f64e9a08ba1264363b2710d20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0955fdc2aedd2c5aa2be6cd782b3f2a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#ga0955fdc2aedd2c5aa2be6cd782b3f2a8">ARM_USBH_EVENT_OVERCURRENT</a>   (1UL << 2)</td></tr>
<tr class="memdesc:ga0955fdc2aedd2c5aa2be6cd782b3f2a8"><td class="mdescLeft"> </td><td class="mdescRight">USB Device caused Overcurrent. <a href="#ga0955fdc2aedd2c5aa2be6cd782b3f2a8">More...</a><br/></td></tr>
<tr class="separator:ga0955fdc2aedd2c5aa2be6cd782b3f2a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70ae1e0a7872556d302a7f7840843c4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#ga70ae1e0a7872556d302a7f7840843c4a">ARM_USBH_EVENT_RESET</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga70ae1e0a7872556d302a7f7840843c4a"><td class="mdescLeft"> </td><td class="mdescRight">USB Reset completed. <a href="#ga70ae1e0a7872556d302a7f7840843c4a">More...</a><br/></td></tr>
<tr class="separator:ga70ae1e0a7872556d302a7f7840843c4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1f91db7d31bcebbf60a23fb04cf7eb5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#gae1f91db7d31bcebbf60a23fb04cf7eb5">ARM_USBH_EVENT_SUSPEND</a>   (1UL << 4)</td></tr>
<tr class="memdesc:gae1f91db7d31bcebbf60a23fb04cf7eb5"><td class="mdescLeft"> </td><td class="mdescRight">USB Suspend occurred. <a href="#gae1f91db7d31bcebbf60a23fb04cf7eb5">More...</a><br/></td></tr>
<tr class="separator:gae1f91db7d31bcebbf60a23fb04cf7eb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42f62bdf6dd639f9f3dffc6c127456e3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#ga42f62bdf6dd639f9f3dffc6c127456e3">ARM_USBH_EVENT_RESUME</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga42f62bdf6dd639f9f3dffc6c127456e3"><td class="mdescLeft"> </td><td class="mdescRight">USB Resume occurred. <a href="#ga42f62bdf6dd639f9f3dffc6c127456e3">More...</a><br/></td></tr>
<tr class="separator:ga42f62bdf6dd639f9f3dffc6c127456e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b61e9df3c63fd78fc08f79280a7066e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html#ga2b61e9df3c63fd78fc08f79280a7066e">ARM_USBH_EVENT_REMOTE_WAKEUP</a>   (1UL << 6)</td></tr>
<tr class="memdesc:ga2b61e9df3c63fd78fc08f79280a7066e"><td class="mdescLeft"> </td><td class="mdescRight">USB Device activated Remote Wakeup. <a href="#ga2b61e9df3c63fd78fc08f79280a7066e">More...</a><br/></td></tr>
<tr class="separator:ga2b61e9df3c63fd78fc08f79280a7066e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The USB Host driver generates Port call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a>. </p>
<p>This section provides the event values for the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function.</p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga71bfd8b8cd41b8aa6303d5d3a91597e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_CONNECT   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device Connected to Port. </p>
</div>
</div>
<a class="anchor" id="gaba67919f64e9a08ba1264363b2710d20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_DISCONNECT   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device Disconnected from Port. </p>
</div>
</div>
<a class="anchor" id="ga0955fdc2aedd2c5aa2be6cd782b3f2a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_OVERCURRENT   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device caused Overcurrent. </p>
</div>
</div>
<a class="anchor" id="ga70ae1e0a7872556d302a7f7840843c4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_RESET   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Reset completed. </p>
</div>
</div>
<a class="anchor" id="gae1f91db7d31bcebbf60a23fb04cf7eb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_SUSPEND   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Suspend occurred. </p>
</div>
</div>
<a class="anchor" id="ga42f62bdf6dd639f9f3dffc6c127456e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_RESUME   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Resume occurred. </p>
</div>
</div>
<a class="anchor" id="ga2b61e9df3c63fd78fc08f79280a7066e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USBH_EVENT_REMOTE_WAKEUP   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device activated Remote Wakeup. </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBH__port__events.html | HTML | apache-2.0 | 14,412 |
var group__USBH__port__events =
[
[ "ARM_USBH_EVENT_CONNECT", "group__USBH__port__events.html#ga71bfd8b8cd41b8aa6303d5d3a91597e6", null ],
[ "ARM_USBH_EVENT_DISCONNECT", "group__USBH__port__events.html#gaba67919f64e9a08ba1264363b2710d20", null ],
[ "ARM_USBH_EVENT_OVERCURRENT", "group__USBH__port__events.html#ga0955fdc2aedd2c5aa2be6cd782b3f2a8", null ],
[ "ARM_USBH_EVENT_RESET", "group__USBH__port__events.html#ga70ae1e0a7872556d302a7f7840843c4a", null ],
[ "ARM_USBH_EVENT_SUSPEND", "group__USBH__port__events.html#gae1f91db7d31bcebbf60a23fb04cf7eb5", null ],
[ "ARM_USBH_EVENT_RESUME", "group__USBH__port__events.html#ga42f62bdf6dd639f9f3dffc6c127456e3", null ],
[ "ARM_USBH_EVENT_REMOTE_WAKEUP", "group__USBH__port__events.html#ga2b61e9df3c63fd78fc08f79280a7066e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USBH__port__events.js | JavaScript | apache-2.0 | 808 |
<!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>USB Endpoint Type</title>
<title>CMSIS-Driver: USB Endpoint Type</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USB__endpoint__type.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USB Endpoint Type<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>USB Endpoint Type definitions.
<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:gaf8df4a353e829cf41a9f712e1b3c93a1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__endpoint__type.html#gaf8df4a353e829cf41a9f712e1b3c93a1">ARM_USB_ENDPOINT_CONTROL</a>   (0)</td></tr>
<tr class="memdesc:gaf8df4a353e829cf41a9f712e1b3c93a1"><td class="mdescLeft"> </td><td class="mdescRight">Control Endpoint. <a href="#gaf8df4a353e829cf41a9f712e1b3c93a1">More...</a><br/></td></tr>
<tr class="separator:gaf8df4a353e829cf41a9f712e1b3c93a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb5913e9d1434240588ec43722d3eb16"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__endpoint__type.html#gabb5913e9d1434240588ec43722d3eb16">ARM_USB_ENDPOINT_ISOCHRONOUS</a>   (1)</td></tr>
<tr class="memdesc:gabb5913e9d1434240588ec43722d3eb16"><td class="mdescLeft"> </td><td class="mdescRight">Isochronous Endpoint. <a href="#gabb5913e9d1434240588ec43722d3eb16">More...</a><br/></td></tr>
<tr class="separator:gabb5913e9d1434240588ec43722d3eb16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac80fcc73aada5562e35e4bf2c21b7b2d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__endpoint__type.html#gac80fcc73aada5562e35e4bf2c21b7b2d">ARM_USB_ENDPOINT_BULK</a>   (2)</td></tr>
<tr class="memdesc:gac80fcc73aada5562e35e4bf2c21b7b2d"><td class="mdescLeft"> </td><td class="mdescRight">Bulk Endpoint. <a href="#gac80fcc73aada5562e35e4bf2c21b7b2d">More...</a><br/></td></tr>
<tr class="separator:gac80fcc73aada5562e35e4bf2c21b7b2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9375cd3a2735e7d5c8c359a1cdbc7d95"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__endpoint__type.html#ga9375cd3a2735e7d5c8c359a1cdbc7d95">ARM_USB_ENDPOINT_INTERRUPT</a>   (3)</td></tr>
<tr class="memdesc:ga9375cd3a2735e7d5c8c359a1cdbc7d95"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt Endpoint. <a href="#ga9375cd3a2735e7d5c8c359a1cdbc7d95">More...</a><br/></td></tr>
<tr class="separator:ga9375cd3a2735e7d5c8c359a1cdbc7d95"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>USB Endpoint Type definitions. </p>
<p>The following USB Endpoint Type values are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf8df4a353e829cf41a9f712e1b3c93a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_ENDPOINT_CONTROL   (0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Endpoint. </p>
</div>
</div>
<a class="anchor" id="gabb5913e9d1434240588ec43722d3eb16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_ENDPOINT_ISOCHRONOUS   (1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Isochronous Endpoint. </p>
</div>
</div>
<a class="anchor" id="gac80fcc73aada5562e35e4bf2c21b7b2d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_ENDPOINT_BULK   (2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bulk Endpoint. </p>
</div>
</div>
<a class="anchor" id="ga9375cd3a2735e7d5c8c359a1cdbc7d95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_ENDPOINT_INTERRUPT   (3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Interrupt Endpoint. </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USB__endpoint__type.html | HTML | apache-2.0 | 10,705 |
var group__USB__endpoint__type =
[
[ "ARM_USB_ENDPOINT_CONTROL", "group__USB__endpoint__type.html#gaf8df4a353e829cf41a9f712e1b3c93a1", null ],
[ "ARM_USB_ENDPOINT_ISOCHRONOUS", "group__USB__endpoint__type.html#gabb5913e9d1434240588ec43722d3eb16", null ],
[ "ARM_USB_ENDPOINT_BULK", "group__USB__endpoint__type.html#gac80fcc73aada5562e35e4bf2c21b7b2d", null ],
[ "ARM_USB_ENDPOINT_INTERRUPT", "group__USB__endpoint__type.html#ga9375cd3a2735e7d5c8c359a1cdbc7d95", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USB__endpoint__type.js | JavaScript | apache-2.0 | 487 |
<!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>USB Speed</title>
<title>CMSIS-Driver: USB Speed</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__USB__speed.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">USB Speed<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>USB Speed definitions.
<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:gae44fe8958474cd90f2288ea27752df27"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__speed.html#gae44fe8958474cd90f2288ea27752df27">ARM_USB_SPEED_LOW</a>   (0)</td></tr>
<tr class="memdesc:gae44fe8958474cd90f2288ea27752df27"><td class="mdescLeft"> </td><td class="mdescRight">Low-speed USB. <a href="#gae44fe8958474cd90f2288ea27752df27">More...</a><br/></td></tr>
<tr class="separator:gae44fe8958474cd90f2288ea27752df27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d1b465db654b651dcf588c8b59899d5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__speed.html#ga0d1b465db654b651dcf588c8b59899d5">ARM_USB_SPEED_FULL</a>   (1)</td></tr>
<tr class="memdesc:ga0d1b465db654b651dcf588c8b59899d5"><td class="mdescLeft"> </td><td class="mdescRight">Full-speed USB. <a href="#ga0d1b465db654b651dcf588c8b59899d5">More...</a><br/></td></tr>
<tr class="separator:ga0d1b465db654b651dcf588c8b59899d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13fa1e1934021f744dba837776205c89"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__speed.html#ga13fa1e1934021f744dba837776205c89">ARM_USB_SPEED_HIGH</a>   (2)</td></tr>
<tr class="memdesc:ga13fa1e1934021f744dba837776205c89"><td class="mdescLeft"> </td><td class="mdescRight">High-speed USB. <a href="#ga13fa1e1934021f744dba837776205c89">More...</a><br/></td></tr>
<tr class="separator:ga13fa1e1934021f744dba837776205c89"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>USB Speed definitions. </p>
<p>The following USB speed values are defined: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gae44fe8958474cd90f2288ea27752df27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_SPEED_LOW   (0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Low-speed USB. </p>
</div>
</div>
<a class="anchor" id="ga0d1b465db654b651dcf588c8b59899d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_SPEED_FULL   (1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Full-speed USB. </p>
</div>
</div>
<a class="anchor" id="ga13fa1e1934021f744dba837776205c89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USB_SPEED_HIGH   (2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>High-speed USB. </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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USB__speed.html | HTML | apache-2.0 | 9,592 |
var group__USB__speed =
[
[ "ARM_USB_SPEED_LOW", "group__USB__speed.html#gae44fe8958474cd90f2288ea27752df27", null ],
[ "ARM_USB_SPEED_FULL", "group__USB__speed.html#ga0d1b465db654b651dcf588c8b59899d5", null ],
[ "ARM_USB_SPEED_HIGH", "group__USB__speed.html#ga13fa1e1934021f744dba837776205c89", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__USB__speed.js | JavaScript | apache-2.0 | 317 |
<!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>WiFi Option Codes</title>
<title>CMSIS-Driver: WiFi Option 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__WiFi__option.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">WiFi Option Codes<div class="ingroups"><a class="el" href="group__wifi__management__gr.html">WiFi Management</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>WiFi Option Codes for <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a> or <a class="el" href="group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf">ARM_WIFI_GetOption</a> function.
<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:gae84cbf48cd5168371621fc5f78aac0a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gae84cbf48cd5168371621fc5f78aac0a4">ARM_WIFI_BSSID</a>   1U</td></tr>
<tr class="memdesc:gae84cbf48cd5168371621fc5f78aac0a4"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get BSSID of AP to connect or of AP; data = &bssid, len = 6, uint8_t[6]. <a href="#gae84cbf48cd5168371621fc5f78aac0a4">More...</a><br/></td></tr>
<tr class="separator:gae84cbf48cd5168371621fc5f78aac0a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1fbda584fe5750db6a04b1ed27730d95"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga1fbda584fe5750db6a04b1ed27730d95">ARM_WIFI_TX_POWER</a>   2U</td></tr>
<tr class="memdesc:ga1fbda584fe5750db6a04b1ed27730d95"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get transmit power; data = &power, len = 4, uint32_t: 0 .. 20 [dBm]. <a href="#ga1fbda584fe5750db6a04b1ed27730d95">More...</a><br/></td></tr>
<tr class="separator:ga1fbda584fe5750db6a04b1ed27730d95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga77e38a3d5d2fe8c04aebaf8d24e1b8d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4">ARM_WIFI_LP_TIMER</a>   3U</td></tr>
<tr class="memdesc:ga77e38a3d5d2fe8c04aebaf8d24e1b8d4"><td class="mdescLeft"> </td><td class="mdescRight">Station Set/Get low-power deep-sleep time; data = &time, len = 4, uint32_t [seconds]: 0 = disable (default) <a href="#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4">More...</a><br/></td></tr>
<tr class="separator:ga77e38a3d5d2fe8c04aebaf8d24e1b8d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga947c297f1364993524bf515beba296f1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga947c297f1364993524bf515beba296f1">ARM_WIFI_DTIM</a>   4U</td></tr>
<tr class="memdesc:ga947c297f1364993524bf515beba296f1"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get DTIM interval; data = &dtim, len = 4, uint32_t [beacons]. <a href="#ga947c297f1364993524bf515beba296f1">More...</a><br/></td></tr>
<tr class="separator:ga947c297f1364993524bf515beba296f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6171d24c661b54465ced2dae7980897c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga6171d24c661b54465ced2dae7980897c">ARM_WIFI_BEACON</a>   5U</td></tr>
<tr class="memdesc:ga6171d24c661b54465ced2dae7980897c"><td class="mdescLeft"> </td><td class="mdescRight">AP Set/Get beacon interval; data = &interval, len = 4, uint32_t [ms]. <a href="#ga6171d24c661b54465ced2dae7980897c">More...</a><br/></td></tr>
<tr class="separator:ga6171d24c661b54465ced2dae7980897c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafefb0fe1e5cdfb71f7f8cc7606840865"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">ARM_WIFI_MAC</a>   6U</td></tr>
<tr class="memdesc:gafefb0fe1e5cdfb71f7f8cc7606840865"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get MAC; data = &mac, len = 6, uint8_t[6]. <a href="#gafefb0fe1e5cdfb71f7f8cc7606840865">More...</a><br/></td></tr>
<tr class="separator:gafefb0fe1e5cdfb71f7f8cc7606840865"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga50ee1ca627ebe536cae0ab7155ed1d17"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga50ee1ca627ebe536cae0ab7155ed1d17">ARM_WIFI_IP</a>   7U</td></tr>
<tr class="memdesc:ga50ee1ca627ebe536cae0ab7155ed1d17"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv4 static/assigned address; data = &ip, len = 4, uint8_t[4]. <a href="#ga50ee1ca627ebe536cae0ab7155ed1d17">More...</a><br/></td></tr>
<tr class="separator:ga50ee1ca627ebe536cae0ab7155ed1d17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2603479ebad0ed05413e1e01b8a649f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gac2603479ebad0ed05413e1e01b8a649f">ARM_WIFI_IP_SUBNET_MASK</a>   8U</td></tr>
<tr class="memdesc:gac2603479ebad0ed05413e1e01b8a649f"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv4 subnet mask; data = &mask, len = 4, uint8_t[4]. <a href="#gac2603479ebad0ed05413e1e01b8a649f">More...</a><br/></td></tr>
<tr class="separator:gac2603479ebad0ed05413e1e01b8a649f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad0c719fedd39d738ee7f6fd3c7317169"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gad0c719fedd39d738ee7f6fd3c7317169">ARM_WIFI_IP_GATEWAY</a>   9U</td></tr>
<tr class="memdesc:gad0c719fedd39d738ee7f6fd3c7317169"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv4 gateway address; data = &ip, len = 4, uint8_t[4]. <a href="#gad0c719fedd39d738ee7f6fd3c7317169">More...</a><br/></td></tr>
<tr class="separator:gad0c719fedd39d738ee7f6fd3c7317169"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga657f5c6c504defe04422dbe468c6c134"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga657f5c6c504defe04422dbe468c6c134">ARM_WIFI_IP_DNS1</a>   10U</td></tr>
<tr class="memdesc:ga657f5c6c504defe04422dbe468c6c134"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv4 primary DNS address; data = &ip, len = 4, uint8_t[4]. <a href="#ga657f5c6c504defe04422dbe468c6c134">More...</a><br/></td></tr>
<tr class="separator:ga657f5c6c504defe04422dbe468c6c134"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a5fa4c298b16d0acd0a71f873802d31"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga5a5fa4c298b16d0acd0a71f873802d31">ARM_WIFI_IP_DNS2</a>   11U</td></tr>
<tr class="memdesc:ga5a5fa4c298b16d0acd0a71f873802d31"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv4 secondary DNS address; data = &ip, len = 4, uint8_t[4]. <a href="#ga5a5fa4c298b16d0acd0a71f873802d31">More...</a><br/></td></tr>
<tr class="separator:ga5a5fa4c298b16d0acd0a71f873802d31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad37e95b697872782973057ae94c085a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gad37e95b697872782973057ae94c085a9">ARM_WIFI_IP_DHCP</a>   12U</td></tr>
<tr class="memdesc:gad37e95b697872782973057ae94c085a9"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv4 DHCP client/server enable/disable; data = &dhcp, len = 4, uint32_t: 0 = disable, non-zero = enable (default) <a href="#gad37e95b697872782973057ae94c085a9">More...</a><br/></td></tr>
<tr class="separator:gad37e95b697872782973057ae94c085a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga10065d0d9cb7530e0747be83ba9e4c35"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga10065d0d9cb7530e0747be83ba9e4c35">ARM_WIFI_IP_DHCP_POOL_BEGIN</a>   13U</td></tr>
<tr class="memdesc:ga10065d0d9cb7530e0747be83ba9e4c35"><td class="mdescLeft"> </td><td class="mdescRight">AP Set/Get IPv4 DHCP pool begin address; data = &ip, len = 4, uint8_t[4]. <a href="#ga10065d0d9cb7530e0747be83ba9e4c35">More...</a><br/></td></tr>
<tr class="separator:ga10065d0d9cb7530e0747be83ba9e4c35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4054f0e4045a25928531be73fb9d6b45"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga4054f0e4045a25928531be73fb9d6b45">ARM_WIFI_IP_DHCP_POOL_END</a>   14U</td></tr>
<tr class="memdesc:ga4054f0e4045a25928531be73fb9d6b45"><td class="mdescLeft"> </td><td class="mdescRight">AP Set/Get IPv4 DHCP pool end address; data = &ip, len = 4, uint8_t[4]. <a href="#ga4054f0e4045a25928531be73fb9d6b45">More...</a><br/></td></tr>
<tr class="separator:ga4054f0e4045a25928531be73fb9d6b45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga78ec2d08d4f1d3ce486b40a329bd8713"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga78ec2d08d4f1d3ce486b40a329bd8713">ARM_WIFI_IP_DHCP_LEASE_TIME</a>   15U</td></tr>
<tr class="memdesc:ga78ec2d08d4f1d3ce486b40a329bd8713"><td class="mdescLeft"> </td><td class="mdescRight">AP Set/Get IPv4 DHCP lease time; data = &time, len = 4, uint32_t [seconds]. <a href="#ga78ec2d08d4f1d3ce486b40a329bd8713">More...</a><br/></td></tr>
<tr class="separator:ga78ec2d08d4f1d3ce486b40a329bd8713"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeac3fc297297b9bf5f2b5cf84788d77f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gaeac3fc297297b9bf5f2b5cf84788d77f">ARM_WIFI_IP6_GLOBAL</a>   16U</td></tr>
<tr class="memdesc:gaeac3fc297297b9bf5f2b5cf84788d77f"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 global address; data = &ip6, len = 16, uint8_t[16]. <a href="#gaeac3fc297297b9bf5f2b5cf84788d77f">More...</a><br/></td></tr>
<tr class="separator:gaeac3fc297297b9bf5f2b5cf84788d77f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga11fdcc3403a43187158434a87fdfb83c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga11fdcc3403a43187158434a87fdfb83c">ARM_WIFI_IP6_LINK_LOCAL</a>   17U</td></tr>
<tr class="memdesc:ga11fdcc3403a43187158434a87fdfb83c"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 link local address; data = &ip6, len = 16, uint8_t[16]. <a href="#ga11fdcc3403a43187158434a87fdfb83c">More...</a><br/></td></tr>
<tr class="separator:ga11fdcc3403a43187158434a87fdfb83c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga545cb7e1da8715966bee7c7ff9d427d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga545cb7e1da8715966bee7c7ff9d427d8">ARM_WIFI_IP6_SUBNET_PREFIX_LEN</a>   18U</td></tr>
<tr class="memdesc:ga545cb7e1da8715966bee7c7ff9d427d8"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 subnet prefix length; data = &len, len = 4, uint32_t: 1 .. 127. <a href="#ga545cb7e1da8715966bee7c7ff9d427d8">More...</a><br/></td></tr>
<tr class="separator:ga545cb7e1da8715966bee7c7ff9d427d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga218d49572adcac8d678f7a8ae2f0c67e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga218d49572adcac8d678f7a8ae2f0c67e">ARM_WIFI_IP6_GATEWAY</a>   19U</td></tr>
<tr class="memdesc:ga218d49572adcac8d678f7a8ae2f0c67e"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 gateway address; data = &ip6, len = 16, uint8_t[16]. <a href="#ga218d49572adcac8d678f7a8ae2f0c67e">More...</a><br/></td></tr>
<tr class="separator:ga218d49572adcac8d678f7a8ae2f0c67e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb86e25e3b7c6360c977b05b40ff7676"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#gaeb86e25e3b7c6360c977b05b40ff7676">ARM_WIFI_IP6_DNS1</a>   20U</td></tr>
<tr class="memdesc:gaeb86e25e3b7c6360c977b05b40ff7676"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 primary DNS address; data = &ip6, len = 16, uint8_t[16]. <a href="#gaeb86e25e3b7c6360c977b05b40ff7676">More...</a><br/></td></tr>
<tr class="separator:gaeb86e25e3b7c6360c977b05b40ff7676"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24dee294436d575b47c7a314cba1654d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga24dee294436d575b47c7a314cba1654d">ARM_WIFI_IP6_DNS2</a>   21U</td></tr>
<tr class="memdesc:ga24dee294436d575b47c7a314cba1654d"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 secondary DNS address; data = &ip6, len = 16, uint8_t[16]. <a href="#ga24dee294436d575b47c7a314cba1654d">More...</a><br/></td></tr>
<tr class="separator:ga24dee294436d575b47c7a314cba1654d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6b864e923870ec473ee0c876d1a3b032"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html#ga6b864e923870ec473ee0c876d1a3b032">ARM_WIFI_IP6_DHCP_MODE</a>   22U</td></tr>
<tr class="memdesc:ga6b864e923870ec473ee0c876d1a3b032"><td class="mdescLeft"> </td><td class="mdescRight">Station/AP Set/Get IPv6 DHCPv6 client mode; data = &mode, len = 4, uint32_t: ARM_WIFI_IP6_DHCP_xxx (default Off) <a href="#ga6b864e923870ec473ee0c876d1a3b032">More...</a><br/></td></tr>
<tr class="separator:ga6b864e923870ec473ee0c876d1a3b032"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>WiFi Option Codes for <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a> or <a class="el" href="group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf">ARM_WIFI_GetOption</a> function. </p>
<p>Many parameters of the WiFi module are configured using the <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a> or <a class="el" href="group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf">ARM_WIFI_GetOption</a> function. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gae84cbf48cd5168371621fc5f78aac0a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_BSSID   1U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get BSSID of AP to connect or of AP; data = &bssid, len = 6, uint8_t[6]. </p>
<p>Specifies the BSSID of the access point to connect or the access point itself. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga1fbda584fe5750db6a04b1ed27730d95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_TX_POWER   2U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get transmit power; data = &power, len = 4, uint32_t: 0 .. 20 [dBm]. </p>
<p>Specifies the transmit power in dBm. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga77e38a3d5d2fe8c04aebaf8d24e1b8d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_LP_TIMER   3U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station Set/Get low-power deep-sleep time; data = &time, len = 4, uint32_t [seconds]: 0 = disable (default) </p>
<p>Specifies the low-power deep-sleep time in seconds for station (disabled when 0 - default). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga947c297f1364993524bf515beba296f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_DTIM   4U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get DTIM interval; data = &dtim, len = 4, uint32_t [beacons]. </p>
<p>Specifies the DTIM interval in number of beacons. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6171d24c661b54465ced2dae7980897c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_BEACON   5U</td>
</tr>
</table>
</div><div class="memdoc">
<p>AP Set/Get beacon interval; data = &interval, len = 4, uint32_t [ms]. </p>
<p>Specifies the beacon interval in milliseconds for access point. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafefb0fe1e5cdfb71f7f8cc7606840865"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_MAC   6U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get MAC; data = &mac, len = 6, uint8_t[6]. </p>
<p>Specifies the MAC address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga50ee1ca627ebe536cae0ab7155ed1d17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP   7U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv4 static/assigned address; data = &ip, len = 4, uint8_t[4]. </p>
<p>Specifies the IP address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac2603479ebad0ed05413e1e01b8a649f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_SUBNET_MASK   8U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv4 subnet mask; data = &mask, len = 4, uint8_t[4]. </p>
<p>Specifies the subnet mask. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad0c719fedd39d738ee7f6fd3c7317169"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_GATEWAY   9U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv4 gateway address; data = &ip, len = 4, uint8_t[4]. </p>
<p>Specifies the gateway IP address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga657f5c6c504defe04422dbe468c6c134"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_DNS1   10U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv4 primary DNS address; data = &ip, len = 4, uint8_t[4]. </p>
<p>Specifies the IP address of the primary DNS server. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5a5fa4c298b16d0acd0a71f873802d31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_DNS2   11U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv4 secondary DNS address; data = &ip, len = 4, uint8_t[4]. </p>
<p>Specifies the IP address of the secondary DNS server. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad37e95b697872782973057ae94c085a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_DHCP   12U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv4 DHCP client/server enable/disable; data = &dhcp, len = 4, uint32_t: 0 = disable, non-zero = enable (default) </p>
<p>Enables or disables the DHCP client for station or DHCP server for access point. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga10065d0d9cb7530e0747be83ba9e4c35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_DHCP_POOL_BEGIN   13U</td>
</tr>
</table>
</div><div class="memdoc">
<p>AP Set/Get IPv4 DHCP pool begin address; data = &ip, len = 4, uint8_t[4]. </p>
<p>Specifies the start IP address for DHCP server (access point). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4054f0e4045a25928531be73fb9d6b45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_DHCP_POOL_END   14U</td>
</tr>
</table>
</div><div class="memdoc">
<p>AP Set/Get IPv4 DHCP pool end address; data = &ip, len = 4, uint8_t[4]. </p>
<p>Specifies the end IP address for DHCP server (access point). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga78ec2d08d4f1d3ce486b40a329bd8713"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP_DHCP_LEASE_TIME   15U</td>
</tr>
</table>
</div><div class="memdoc">
<p>AP Set/Get IPv4 DHCP lease time; data = &time, len = 4, uint32_t [seconds]. </p>
<p>Specifies the lease time for DHCP server (access point). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaeac3fc297297b9bf5f2b5cf84788d77f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_GLOBAL   16U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 global address; data = &ip6, len = 16, uint8_t[16]. </p>
<p>Specifies the global IPv6 address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga11fdcc3403a43187158434a87fdfb83c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_LINK_LOCAL   17U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 link local address; data = &ip6, len = 16, uint8_t[16]. </p>
<p>Specifies the link-local IPv6 address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga545cb7e1da8715966bee7c7ff9d427d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_SUBNET_PREFIX_LEN   18U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 subnet prefix length; data = &len, len = 4, uint32_t: 1 .. 127. </p>
<p>Specifies the address prefix length. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga218d49572adcac8d678f7a8ae2f0c67e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_GATEWAY   19U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 gateway address; data = &ip6, len = 16, uint8_t[16]. </p>
<p>Specifies the gateway IPv6 address. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaeb86e25e3b7c6360c977b05b40ff7676"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_DNS1   20U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 primary DNS address; data = &ip6, len = 16, uint8_t[16]. </p>
<p>Specifies the IPv6 address of the primary DNS server. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga24dee294436d575b47c7a314cba1654d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_DNS2   21U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 secondary DNS address; data = &ip6, len = 16, uint8_t[16]. </p>
<p>Specifies the IPv6 address of the secondary DNS server. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6b864e923870ec473ee0c876d1a3b032"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_DHCP_MODE   22U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Station/AP Set/Get IPv6 DHCPv6 client mode; data = &mode, len = 4, uint32_t: ARM_WIFI_IP6_DHCP_xxx (default Off) </p>
<p>Specifies the operation mode of the DHCPv6 client. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__WiFi__option.html" title="WiFi Option Codes for ARM_WIFI_SetOption or ARM_WIFI_GetOption function. ">WiFi Option Codes</a> </dd></dl>
</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:32 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__WiFi__option.html | HTML | apache-2.0 | 37,217 |
var group__WiFi__option =
[
[ "ARM_WIFI_BSSID", "group__WiFi__option.html#gae84cbf48cd5168371621fc5f78aac0a4", null ],
[ "ARM_WIFI_TX_POWER", "group__WiFi__option.html#ga1fbda584fe5750db6a04b1ed27730d95", null ],
[ "ARM_WIFI_LP_TIMER", "group__WiFi__option.html#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4", null ],
[ "ARM_WIFI_DTIM", "group__WiFi__option.html#ga947c297f1364993524bf515beba296f1", null ],
[ "ARM_WIFI_BEACON", "group__WiFi__option.html#ga6171d24c661b54465ced2dae7980897c", null ],
[ "ARM_WIFI_MAC", "group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865", null ],
[ "ARM_WIFI_IP", "group__WiFi__option.html#ga50ee1ca627ebe536cae0ab7155ed1d17", null ],
[ "ARM_WIFI_IP_SUBNET_MASK", "group__WiFi__option.html#gac2603479ebad0ed05413e1e01b8a649f", null ],
[ "ARM_WIFI_IP_GATEWAY", "group__WiFi__option.html#gad0c719fedd39d738ee7f6fd3c7317169", null ],
[ "ARM_WIFI_IP_DNS1", "group__WiFi__option.html#ga657f5c6c504defe04422dbe468c6c134", null ],
[ "ARM_WIFI_IP_DNS2", "group__WiFi__option.html#ga5a5fa4c298b16d0acd0a71f873802d31", null ],
[ "ARM_WIFI_IP_DHCP", "group__WiFi__option.html#gad37e95b697872782973057ae94c085a9", null ],
[ "ARM_WIFI_IP_DHCP_POOL_BEGIN", "group__WiFi__option.html#ga10065d0d9cb7530e0747be83ba9e4c35", null ],
[ "ARM_WIFI_IP_DHCP_POOL_END", "group__WiFi__option.html#ga4054f0e4045a25928531be73fb9d6b45", null ],
[ "ARM_WIFI_IP_DHCP_LEASE_TIME", "group__WiFi__option.html#ga78ec2d08d4f1d3ce486b40a329bd8713", null ],
[ "ARM_WIFI_IP6_GLOBAL", "group__WiFi__option.html#gaeac3fc297297b9bf5f2b5cf84788d77f", null ],
[ "ARM_WIFI_IP6_LINK_LOCAL", "group__WiFi__option.html#ga11fdcc3403a43187158434a87fdfb83c", null ],
[ "ARM_WIFI_IP6_SUBNET_PREFIX_LEN", "group__WiFi__option.html#ga545cb7e1da8715966bee7c7ff9d427d8", null ],
[ "ARM_WIFI_IP6_GATEWAY", "group__WiFi__option.html#ga218d49572adcac8d678f7a8ae2f0c67e", null ],
[ "ARM_WIFI_IP6_DNS1", "group__WiFi__option.html#gaeb86e25e3b7c6360c977b05b40ff7676", null ],
[ "ARM_WIFI_IP6_DNS2", "group__WiFi__option.html#ga24dee294436d575b47c7a314cba1654d", null ],
[ "ARM_WIFI_IP6_DHCP_MODE", "group__WiFi__option.html#ga6b864e923870ec473ee0c876d1a3b032", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__WiFi__option.js | JavaScript | apache-2.0 | 2,227 |
<!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>CAN Bus Communication Mode</title>
<title>CMSIS-Driver: CAN Bus Communication Mode</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__bus__mode__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">CAN Bus Communication Mode<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Set or initialize the CAN bus.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gabbca99c46d478bcf822eee71cdf75dcd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd">ARM_CAN_MODE</a> { <br/>
  <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcda9967a5ebaa045afe54d75e5629676ddc">ARM_CAN_MODE_INITIALIZATION</a>,
<br/>
  <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcdaa3190344bdf3452462e5c0518ac3cdc4">ARM_CAN_MODE_NORMAL</a>,
<br/>
  <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcda22a9bb26e68c2a04f641d466040d755d">ARM_CAN_MODE_RESTRICTED</a>,
<br/>
  <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcda904f68f08c84c4b85c763f5d98c574ab">ARM_CAN_MODE_MONITOR</a>,
<br/>
  <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcda8579315576baa43860a398a30fd527d8">ARM_CAN_MODE_LOOPBACK_INTERNAL</a>,
<br/>
  <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcda5ee1ba60abcf39d575e7cb309e641b9b">ARM_CAN_MODE_LOOPBACK_EXTERNAL</a>
<br/>
}</td></tr>
<tr class="separator:gabbca99c46d478bcf822eee71cdf75dcd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Set or initialize the CAN bus. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd">ARM_CAN_MODE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The enumerations below initialize and set the bus communication mode.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a> </li>
</ul>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcda9967a5ebaa045afe54d75e5629676ddc"></a>ARM_CAN_MODE_INITIALIZATION</em> </td><td class="fielddoc">
<p>Initialization mode. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcdaa3190344bdf3452462e5c0518ac3cdc4"></a>ARM_CAN_MODE_NORMAL</em> </td><td class="fielddoc">
<p>Normal operation mode. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcda22a9bb26e68c2a04f641d466040d755d"></a>ARM_CAN_MODE_RESTRICTED</em> </td><td class="fielddoc">
<p>Restricted operation mode. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcda904f68f08c84c4b85c763f5d98c574ab"></a>ARM_CAN_MODE_MONITOR</em> </td><td class="fielddoc">
<p>Bus monitoring mode. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcda8579315576baa43860a398a30fd527d8"></a>ARM_CAN_MODE_LOOPBACK_INTERNAL</em> </td><td class="fielddoc">
<p>Loopback internal mode. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gabbca99c46d478bcf822eee71cdf75dcda5ee1ba60abcf39d575e7cb309e641b9b"></a>ARM_CAN_MODE_LOOPBACK_EXTERNAL</em> </td><td class="fielddoc">
<p>Loopback external mode. </p>
</td></tr>
</table>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__bus__mode__ctrls.html | HTML | apache-2.0 | 10,305 |
var group__can__bus__mode__ctrls =
[
[ "ARM_CAN_MODE", "group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd", [
[ "ARM_CAN_MODE_INITIALIZATION", "Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda9967a5ebaa045afe54d75e5629676ddc", null ],
[ "ARM_CAN_MODE_NORMAL", "Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcdaa3190344bdf3452462e5c0518ac3cdc4", null ],
[ "ARM_CAN_MODE_RESTRICTED", "Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda22a9bb26e68c2a04f641d466040d755d", null ],
[ "ARM_CAN_MODE_MONITOR", "Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda904f68f08c84c4b85c763f5d98c574ab", null ],
[ "ARM_CAN_MODE_LOOPBACK_INTERNAL", "Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda8579315576baa43860a398a30fd527d8", null ],
[ "ARM_CAN_MODE_LOOPBACK_EXTERNAL", "Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda5ee1ba60abcf39d575e7cb309e641b9b", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__bus__mode__ctrls.js | JavaScript | apache-2.0 | 957 |
<!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>CAN Control Codes</title>
<title>CMSIS-Driver: CAN Control 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__control.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">CAN Control 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>Codes to configure the CAN driver.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__can__identifer__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__identifer__ctrls.html">CAN Identifier</a></td></tr>
<tr class="memdesc:group__can__identifer__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Set object to standard or extended. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__can__mode__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html">CAN Operation Codes</a></td></tr>
<tr class="memdesc:group__can__mode__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Set CAN operation modes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__can__bus__mode__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__bus__mode__ctrls.html">CAN Bus Communication Mode</a></td></tr>
<tr class="memdesc:group__can__bus__mode__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Set or initialize the CAN bus. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__can__timeseg__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html">CAN Bit Timing Codes</a></td></tr>
<tr class="memdesc:group__can__timeseg__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Set bit timing. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__can__filter__operation__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__filter__operation__ctrls.html">CAN Filter Operation Codes</a></td></tr>
<tr class="memdesc:group__can__filter__operation__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Set CAN filter manipulation codes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__can__obj__config__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__obj__config__ctrls.html">CAN Object Configuration Codes</a></td></tr>
<tr class="memdesc:group__can__obj__config__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">CAN Object Configuration codes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Codes to configure the CAN driver. </p>
<p>The various CAN control codes define:</p>
<ul>
<li><a class="el" href="group__can__identifer__ctrls.html">CAN Identifier</a> specify CAN identifier. Refer to <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a>.</li>
<li><a class="el" href="group__can__mode__ctrls.html">CAN Operation Codes</a> control CAN interface operation. Refer to <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a>.</li>
<li><a class="el" href="group__can__timeseg__ctrls.html">CAN Bit Timing Codes</a> specify CAN bit rate and timing. Refer to <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a>.</li>
<li><a class="el" href="group__can__bus__mode__ctrls.html">CAN Bus Communication Mode</a> specify CAN bus operating mode. Refer to <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a>.</li>
<li><a class="el" href="group__can__filter__operation__ctrls.html">CAN Filter Operation Codes</a> specify CAN filter operations. Refer to <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a>.</li>
<li><a class="el" href="group__can__obj__config__ctrls.html">CAN Object Configuration Codes</a> specify CAN object configuration modes. Refer to <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a>. </li>
</ul>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__control.html | HTML | apache-2.0 | 11,070 |
var group__can__control =
[
[ "CAN Identifier", "group__can__identifer__ctrls.html", "group__can__identifer__ctrls" ],
[ "CAN Operation Codes", "group__can__mode__ctrls.html", "group__can__mode__ctrls" ],
[ "CAN Bus Communication Mode", "group__can__bus__mode__ctrls.html", "group__can__bus__mode__ctrls" ],
[ "CAN Bit Timing Codes", "group__can__timeseg__ctrls.html", "group__can__timeseg__ctrls" ],
[ "CAN Filter Operation Codes", "group__can__filter__operation__ctrls.html", "group__can__filter__operation__ctrls" ],
[ "CAN Object Configuration Codes", "group__can__obj__config__ctrls.html", "group__can__obj__config__ctrls" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__control.js | JavaScript | apache-2.0 | 656 |
<!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>CAN Filter Operation Codes</title>
<title>CMSIS-Driver: CAN Filter Operation 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__filter__operation__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">CAN Filter Operation Codes<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Set CAN filter manipulation codes.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gacb04d0f8b3969ee69362ff2b62941d75"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a> { <br/>
  <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>,
<br/>
  <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75a6fdaecf3fa244ef1e4d1069d9c6c95f8">ARM_CAN_FILTER_ID_EXACT_REMOVE</a>,
<br/>
  <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5">ARM_CAN_FILTER_ID_RANGE_ADD</a>,
<br/>
  <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75a17fea7d388dc702bb3318ecae911f50d">ARM_CAN_FILTER_ID_RANGE_REMOVE</a>,
<br/>
  <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a>,
<br/>
  <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75ad9573d5d0e112aece7abc0bc24aa92fb">ARM_CAN_FILTER_ID_MASKABLE_REMOVE</a>
<br/>
}</td></tr>
<tr class="separator:gacb04d0f8b3969ee69362ff2b62941d75"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Set CAN filter manipulation codes. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>ARM_CAN_FILTER_OPERATION</b> provides the controls for setting the filter type. Refer to <a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a> for details.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> </li>
</ul>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b"></a>ARM_CAN_FILTER_ID_EXACT_ADD</em> </td><td class="fielddoc">
<p>Add exact id filter. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75a6fdaecf3fa244ef1e4d1069d9c6c95f8"></a>ARM_CAN_FILTER_ID_EXACT_REMOVE</em> </td><td class="fielddoc">
<p>Remove exact id filter. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5"></a>ARM_CAN_FILTER_ID_RANGE_ADD</em> </td><td class="fielddoc">
<p>Add range id filter. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75a17fea7d388dc702bb3318ecae911f50d"></a>ARM_CAN_FILTER_ID_RANGE_REMOVE</em> </td><td class="fielddoc">
<p>Remove range id filter. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9"></a>ARM_CAN_FILTER_ID_MASKABLE_ADD</em> </td><td class="fielddoc">
<p>Add maskable id filter. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gacb04d0f8b3969ee69362ff2b62941d75ad9573d5d0e112aece7abc0bc24aa92fb"></a>ARM_CAN_FILTER_ID_MASKABLE_REMOVE</em> </td><td class="fielddoc">
<p>Remove maskable id filter. </p>
</td></tr>
</table>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__filter__operation__ctrls.html | HTML | apache-2.0 | 10,601 |
var group__can__filter__operation__ctrls =
[
[ "ARM_CAN_FILTER_OPERATION", "group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75", [
[ "ARM_CAN_FILTER_ID_EXACT_ADD", "Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b", null ],
[ "ARM_CAN_FILTER_ID_EXACT_REMOVE", "Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a6fdaecf3fa244ef1e4d1069d9c6c95f8", null ],
[ "ARM_CAN_FILTER_ID_RANGE_ADD", "Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5", null ],
[ "ARM_CAN_FILTER_ID_RANGE_REMOVE", "Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a17fea7d388dc702bb3318ecae911f50d", null ],
[ "ARM_CAN_FILTER_ID_MASKABLE_ADD", "Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9", null ],
[ "ARM_CAN_FILTER_ID_MASKABLE_REMOVE", "Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ad9573d5d0e112aece7abc0bc24aa92fb", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__filter__operation__ctrls.js | JavaScript | apache-2.0 | 1,013 |
<!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>CAN Identifier</title>
<title>CMSIS-Driver: CAN Identifier</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__identifer__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">CAN Identifier<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Set object to standard or extended.
<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:ga561635b816ddaf5fb87377155fc692c7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__identifer__ctrls.html#ga561635b816ddaf5fb87377155fc692c7">ARM_CAN_STANDARD_ID</a>(id)   (id & 0x000007FFUL)</td></tr>
<tr class="memdesc:ga561635b816ddaf5fb87377155fc692c7"><td class="mdescLeft"> </td><td class="mdescRight">CAN identifier in standard format (11-bits) <a href="#ga561635b816ddaf5fb87377155fc692c7">More...</a><br/></td></tr>
<tr class="separator:ga561635b816ddaf5fb87377155fc692c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae7d4efb6fb49e1ec47c2b12e22f37cae"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(id)   ((id & 0x1FFFFFFFUL) | ARM_CAN_ID_IDE_Msk)</td></tr>
<tr class="memdesc:gae7d4efb6fb49e1ec47c2b12e22f37cae"><td class="mdescLeft"> </td><td class="mdescRight">CAN identifier in extended format (29-bits) <a href="#gae7d4efb6fb49e1ec47c2b12e22f37cae">More...</a><br/></td></tr>
<tr class="separator:gae7d4efb6fb49e1ec47c2b12e22f37cae"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Set object to standard or extended. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga561635b816ddaf5fb87377155fc692c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_STANDARD_ID</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">id</td><td>)</td>
<td>   (id & 0x000007FFUL)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CAN identifier in standard format (11-bits) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae7d4efb6fb49e1ec47c2b12e22f37cae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_EXTENDED_ID</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">id</td><td>)</td>
<td>   ((id & 0x1FFFFFFFUL) | ARM_CAN_ID_IDE_Msk)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CAN identifier in extended format (29-bits) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__identifer__ctrls.html | HTML | apache-2.0 | 9,538 |
var group__can__identifer__ctrls =
[
[ "ARM_CAN_STANDARD_ID", "group__can__identifer__ctrls.html#ga561635b816ddaf5fb87377155fc692c7", null ],
[ "ARM_CAN_EXTENDED_ID", "group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__identifer__ctrls.js | JavaScript | apache-2.0 | 256 |
<!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>CAN Interface</title>
<title>CMSIS-Driver: CAN Interface</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__interface__gr.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">CAN Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for CAN Bus Peripheral (Driver_CAN.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__can__status__code__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html">Status Error Codes</a></td></tr>
<tr class="memdesc:group__can__status__code__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Status codes of the CAN driver. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__CAN__unit__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html">CAN Unit Events</a></td></tr>
<tr class="memdesc:group__CAN__unit__events"><td class="mdescLeft"> </td><td class="mdescRight">Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__CAN__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html">CAN Object Events</a></td></tr>
<tr class="memdesc:group__CAN__events"><td class="mdescLeft"> </td><td class="mdescRight">Callback objects events notified via <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__can__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__control.html">CAN Control Codes</a></td></tr>
<tr class="memdesc:group__can__control"><td class="mdescLeft"> </td><td class="mdescRight">Codes to configure the CAN driver. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:structARM__DRIVER__CAN"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a></td></tr>
<tr class="memdesc:structARM__DRIVER__CAN"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the CAN Driver. <a href="group__can__interface__gr.html#structARM__DRIVER__CAN">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__CAN"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__CAN__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__CAN__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">CAN Device Driver Capabilities. <a href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__CAN__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__CAN__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#structARM__CAN__STATUS">ARM_CAN_STATUS</a></td></tr>
<tr class="memdesc:structARM__CAN__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">CAN Status. <a href="group__can__interface__gr.html#structARM__CAN__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__CAN__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__CAN__MSG__INFO"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a></td></tr>
<tr class="memdesc:structARM__CAN__MSG__INFO"><td class="mdescLeft"> </td><td class="mdescRight">CAN Message Information. <a href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">More...</a><br/></td></tr>
<tr class="separator:structARM__CAN__MSG__INFO"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__CAN__OBJ__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__CAN__OBJ__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">CAN Object Capabilities. <a href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__CAN__OBJ__CAPABILITIES"><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:gaac07b9fdf614bf439414f5417aaa376e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e">ARM_CAN_SignalUnitEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:gaac07b9fdf614bf439414f5417aaa376e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> : Signal CAN Unit Event. <a href="#gaac07b9fdf614bf439414f5417aaa376e">More...</a><br/></td></tr>
<tr class="separator:gaac07b9fdf614bf439414f5417aaa376e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ceceac3e9aa0981c5cacfab88efb4eb"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb">ARM_CAN_SignalObjectEvent_t</a> )(uint32_t obj_idx, uint32_t event)</td></tr>
<tr class="memdesc:ga7ceceac3e9aa0981c5cacfab88efb4eb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> : Signal CAN Object Event. <a href="#ga7ceceac3e9aa0981c5cacfab88efb4eb">More...</a><br/></td></tr>
<tr class="separator:ga7ceceac3e9aa0981c5cacfab88efb4eb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4256d5b23ffcb27759a05f8e6b854f13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga4256d5b23ffcb27759a05f8e6b854f13">ARM_CAN_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga4256d5b23ffcb27759a05f8e6b854f13"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga4256d5b23ffcb27759a05f8e6b854f13">More...</a><br/></td></tr>
<tr class="separator:ga4256d5b23ffcb27759a05f8e6b854f13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35f21cabe1637b1be964024a8f77721c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga35f21cabe1637b1be964024a8f77721c"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga35f21cabe1637b1be964024a8f77721c">More...</a><br/></td></tr>
<tr class="separator:ga35f21cabe1637b1be964024a8f77721c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa72ceb25ba67e279d7432404632deb44"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a> (<a class="el" href="group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e">ARM_CAN_SignalUnitEvent_t</a> cb_unit_event, <a class="el" href="group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb">ARM_CAN_SignalObjectEvent_t</a> cb_object_event)</td></tr>
<tr class="memdesc:gaa72ceb25ba67e279d7432404632deb44"><td class="mdescLeft"> </td><td class="mdescRight">Initialize CAN interface and register signal (callback) functions. <a href="#gaa72ceb25ba67e279d7432404632deb44">More...</a><br/></td></tr>
<tr class="separator:gaa72ceb25ba67e279d7432404632deb44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1e3e364b64f2ab277399e3279cce5ef8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga1e3e364b64f2ab277399e3279cce5ef8">ARM_CAN_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:ga1e3e364b64f2ab277399e3279cce5ef8"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize CAN interface. <a href="#ga1e3e364b64f2ab277399e3279cce5ef8">More...</a><br/></td></tr>
<tr class="separator:ga1e3e364b64f2ab277399e3279cce5ef8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f634f126ac97daef2f3115aa7bfed7c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga6f634f126ac97daef2f3115aa7bfed7c">ARM_CAN_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga6f634f126ac97daef2f3115aa7bfed7c"><td class="mdescLeft"> </td><td class="mdescRight">Control CAN interface power. <a href="#ga6f634f126ac97daef2f3115aa7bfed7c">More...</a><br/></td></tr>
<tr class="separator:ga6f634f126ac97daef2f3115aa7bfed7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1fe6cc207415de604975ae251e269361"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga1fe6cc207415de604975ae251e269361">ARM_CAN_GetClock</a> (void)</td></tr>
<tr class="memdesc:ga1fe6cc207415de604975ae251e269361"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve CAN base clock frequency. <a href="#ga1fe6cc207415de604975ae251e269361">More...</a><br/></td></tr>
<tr class="separator:ga1fe6cc207415de604975ae251e269361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga88bb27a8525503a250cca7a2c4a5d07a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> (<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> select, uint32_t bitrate, uint32_t bit_segments)</td></tr>
<tr class="memdesc:ga88bb27a8525503a250cca7a2c4a5d07a"><td class="mdescLeft"> </td><td class="mdescRight">Set bitrate for CAN interface. <a href="#ga88bb27a8525503a250cca7a2c4a5d07a">More...</a><br/></td></tr>
<tr class="separator:ga88bb27a8525503a250cca7a2c4a5d07a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga28226a6e223f9b95b4dafb7c2f48a855"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a> (<a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd">ARM_CAN_MODE</a> mode)</td></tr>
<tr class="memdesc:ga28226a6e223f9b95b4dafb7c2f48a855"><td class="mdescLeft"> </td><td class="mdescRight">Set operating mode for CAN interface. <a href="#ga28226a6e223f9b95b4dafb7c2f48a855">More...</a><br/></td></tr>
<tr class="separator:ga28226a6e223f9b95b4dafb7c2f48a855"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga45ab314f5121cf5a1b32d9adc600e0f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a> (uint32_t obj_idx)</td></tr>
<tr class="memdesc:ga45ab314f5121cf5a1b32d9adc600e0f7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve capabilities of an object. <a href="#ga45ab314f5121cf5a1b32d9adc600e0f7">More...</a><br/></td></tr>
<tr class="separator:ga45ab314f5121cf5a1b32d9adc600e0f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f9bc7088704483388e14872c9d5385d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> (uint32_t obj_idx, <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a> operation, uint32_t id, uint32_t arg)</td></tr>
<tr class="memdesc:ga4f9bc7088704483388e14872c9d5385d"><td class="mdescLeft"> </td><td class="mdescRight">Add or remove filter for message reception. <a href="#ga4f9bc7088704483388e14872c9d5385d">More...</a><br/></td></tr>
<tr class="separator:ga4f9bc7088704483388e14872c9d5385d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga00ec0715f6755a49dae5b60dca182630"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> (uint32_t obj_idx, <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0">ARM_CAN_OBJ_CONFIG</a> obj_cfg)</td></tr>
<tr class="memdesc:ga00ec0715f6755a49dae5b60dca182630"><td class="mdescLeft"> </td><td class="mdescRight">Configure object. <a href="#ga00ec0715f6755a49dae5b60dca182630">More...</a><br/></td></tr>
<tr class="separator:ga00ec0715f6755a49dae5b60dca182630"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0dcffd362b4093043442a030eaebbcfe"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> (uint32_t obj_idx, <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> *msg_info, const uint8_t *data, uint8_t size)</td></tr>
<tr class="memdesc:ga0dcffd362b4093043442a030eaebbcfe"><td class="mdescLeft"> </td><td class="mdescRight">Send message on CAN bus. <a href="#ga0dcffd362b4093043442a030eaebbcfe">More...</a><br/></td></tr>
<tr class="separator:ga0dcffd362b4093043442a030eaebbcfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc37084df5eab32f593c2744d35cf647"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a> (uint32_t obj_idx, <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> *msg_info, uint8_t *data, uint8_t size)</td></tr>
<tr class="memdesc:gafc37084df5eab32f593c2744d35cf647"><td class="mdescLeft"> </td><td class="mdescRight">Read message received on CAN bus. <a href="#gafc37084df5eab32f593c2744d35cf647">More...</a><br/></td></tr>
<tr class="separator:gafc37084df5eab32f593c2744d35cf647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d9f0c5f03a8a81ab062b5aa57e5dea4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> (uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:ga8d9f0c5f03a8a81ab062b5aa57e5dea4"><td class="mdescLeft"> </td><td class="mdescRight">Control CAN interface. <a href="#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">More...</a><br/></td></tr>
<tr class="separator:ga8d9f0c5f03a8a81ab062b5aa57e5dea4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga676d6b567fc4ab3d44f5d7a50ec9419c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__can__interface__gr.html#structARM__CAN__STATUS">ARM_CAN_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga676d6b567fc4ab3d44f5d7a50ec9419c"><td class="mdescLeft"> </td><td class="mdescRight">Get CAN status. <a href="#ga676d6b567fc4ab3d44f5d7a50ec9419c">More...</a><br/></td></tr>
<tr class="separator:ga676d6b567fc4ab3d44f5d7a50ec9419c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38795d1ed135ce3bd87f31ef1596bccf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:ga38795d1ed135ce3bd87f31ef1596bccf"><td class="mdescLeft"> </td><td class="mdescRight">Signal CAN unit event. <a href="#ga38795d1ed135ce3bd87f31ef1596bccf">More...</a><br/></td></tr>
<tr class="separator:ga38795d1ed135ce3bd87f31ef1596bccf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabfcaeac9e2ca25936ba5a29f2d594e7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> (uint32_t obj_idx, uint32_t event)</td></tr>
<tr class="memdesc:gabfcaeac9e2ca25936ba5a29f2d594e7e"><td class="mdescLeft"> </td><td class="mdescRight">Signal CAN object event. <a href="#gabfcaeac9e2ca25936ba5a29f2d594e7e">More...</a><br/></td></tr>
<tr class="separator:gabfcaeac9e2ca25936ba5a29f2d594e7e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for CAN Bus Peripheral (Driver_CAN.h) </p>
<p>The <b>Controller Area Network</b> Interface Bus (CAN) implements a multi-master serial bus for connecting microcontrollers and devices, also known as nodes, to communicate with each other in applications without a host computer. CAN is a message-based protocol, designed originally for automotive applications, but meanwhile used also in many other surroundings. The complexity of the node can range from a simple I/O device up to an embedded computer with a CAN interface and sophisticated software. The node may also be a gateway allowing a standard computer to communicate over a USB or Ethernet port to the devices on a CAN network. Devices are connected to the bus through a host processor, a CAN controller, and a CAN transceiver.</p>
<p>The CAN Driver API allows to implement CAN Interfaces that conform to the <a href="http://www.bosch-semiconductors.com/" target="_blank">CAN specifications available from BOSCH</a>:</p>
<ul>
<li>CAN 2.0B: CAN Specification 2.0B (released Sep. 1991) which is now superseded by ISO 11898-1.</li>
<li>CAN FD: CAN with Flexible Data Rate introduced in 2012 (released April 17th, 2012).</li>
</ul>
<p>Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/CAN_bus" target="_blank"><b>CAN Bus</b></a>.</p>
<p>CAN 2.0B** Every CAN CMSIS-Driver supports the CAN 2.0B standard</p>
<p>CAN 2.0B supports:</p>
<ul>
<li>message can contain up to 8 data bytes</li>
<li>bitrates of up to 1Mbits/s</li>
<li><a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> requests</li>
</ul>
<p><a class="anchor" id="CAN_FD"></a><b>CAN FD</b></p>
<p>Support for CAN FD depends on the hardware. A CMSIS-Driver that supports CAN FD has the capability <a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> data field <b>fd_mode</b> = <span class="XML-Token">1</span>, which can be retrieved with the function <a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a>.</p>
<p>CAN FD supports:</p>
<ul>
<li>message can contain up to 64 data bytes</li>
<li>faster data transfers with faster bitrate used during the data phase</li>
</ul>
<p>CAN FD does not support <a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> requests.</p>
<p><b>Block Diagram</b></p>
<p>The CAN Driver API defines a <b>CAN</b> interface for middleware components. The CAN Driver supports multiple nodes, which are able to send and receive messages, but not simultaneously.</p>
<div class="image">
<img src="CAN_Node.png" alt="CAN_Node.png"/>
<div class="caption">
CAN Node Schematic</div></div>
<h2>CAN API </h2>
<p>The following header files define the Application Programming Interface (API) for the CAN interface:</p>
<ul>
<li><b>Driver_CAN.h</b> : Driver API for CAN Bus Peripheral</li>
</ul>
<p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a> : access struct for CAN driver functions</li>
</ul>
<p><b>Example Code</b></p>
<p>The following example code shows the usage of the CAN interface.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><span class="preprocessor">#include <string.h></span></div>
<div class="line"><span class="preprocessor">#include "cmsis_os.h"</span></div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__CAN_8h.html">Driver_CAN.h</a>"</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// CAN Driver Controller selector</span></div>
<div class="line"><span class="preprocessor">#define CAN_CONTROLLER 1 // CAN Controller number</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"><span class="preprocessor">#define _CAN_Driver_(n) Driver_CAN##n</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define CAN_Driver_(n) _CAN_Driver_(n)</span></div>
<div class="line"><span class="preprocessor"></span><span class="keyword">extern</span> <a class="code" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a> CAN_Driver_(CAN_CONTROLLER);</div>
<div class="line"><span class="preprocessor">#define ptrCAN (&CAN_Driver_(CAN_CONTROLLER))</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line">uint32_t rx_obj_idx = 0xFFFFFFFFU;</div>
<div class="line">uint8_t rx_data[8];</div>
<div class="line"><a class="code" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> rx_msg_info;</div>
<div class="line">uint32_t tx_obj_idx = 0xFFFFFFFFU;</div>
<div class="line">uint8_t tx_data[8];</div>
<div class="line"><a class="code" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> tx_msg_info;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> Error_Handler (<span class="keywordtype">void</span>) { <span class="keywordflow">while</span> (1); }</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> CAN_SignalUnitEvent (uint32_t event) {}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> CAN_SignalObjectEvent (uint32_t obj_idx, uint32_t event) {</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (obj_idx == rx_obj_idx) { <span class="comment">// If receive object event</span></div>
<div class="line"> <span class="keywordflow">if</span> (event == <a class="code" href="group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47">ARM_CAN_EVENT_RECEIVE</a>) { <span class="comment">// If message was received successfully</span></div>
<div class="line"> <span class="keywordflow">if</span> (ptrCAN->MessageRead(rx_obj_idx, &rx_msg_info, rx_data, 8U) > 0U) {</div>
<div class="line"> <span class="comment">// Read received message</span></div>
<div class="line"> <span class="comment">// process received message ...</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> (obj_idx == tx_obj_idx) { <span class="comment">// If transmit object event</span></div>
<div class="line"> <span class="keywordflow">if</span> (event == <a class="code" href="group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503">ARM_CAN_EVENT_SEND_COMPLETE</a>) { <span class="comment">// If message was sent successfully</span></div>
<div class="line"> <span class="comment">// acknowledge sent message ...</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> can_cap;</div>
<div class="line"> <a class="code" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> can_obj_cap;</div>
<div class="line"> int32_t status;</div>
<div class="line"> uint32_t i, num_objects;</div>
<div class="line"> </div>
<div class="line"> can_cap = ptrCAN->GetCapabilities (); <span class="comment">// Get CAN driver capabilities</span></div>
<div class="line"> num_objects = can_cap.<a class="code" href="group__can__interface__gr.html#a69bd1a164443cf6f501489f4d31f4681">num_objects</a>; <span class="comment">// Number of receive/transmit objects</span></div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->Initialize (CAN_SignalUnitEvent, CAN_SignalObjectEvent); <span class="comment">// Initialize CAN driver</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->PowerControl (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>); <span class="comment">// Power-up CAN controller</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->SetMode (<a class="code" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda9967a5ebaa045afe54d75e5629676ddc">ARM_CAN_MODE_INITIALIZATION</a>); <span class="comment">// Activate initialization mode</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->SetBitrate (<a class="code" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a>, <span class="comment">// Set nominal bitrate</span></div>
<div class="line"> 100000U, <span class="comment">// Set bitrate to 100 kbit/s</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea">ARM_CAN_BIT_PROP_SEG</a>(5U) | <span class="comment">// Set propagation segment to 5 time quanta</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792">ARM_CAN_BIT_PHASE_SEG1</a>(1U) | <span class="comment">// Set phase segment 1 to 1 time quantum (sample point at 87.5% of bit time)</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80">ARM_CAN_BIT_PHASE_SEG2</a>(1U) | <span class="comment">// Set phase segment 2 to 1 time quantum (total bit is 8 time quanta long)</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269">ARM_CAN_BIT_SJW</a>(1U)); <span class="comment">// Resynchronization jump width is same as phase segment 2</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">for</span> (i = 0U; i < num_objects; i++) { <span class="comment">// Find first available object for receive and transmit</span></div>
<div class="line"> can_obj_cap = ptrCAN->ObjectGetCapabilities (i); <span class="comment">// Get object capabilities</span></div>
<div class="line"> <span class="keywordflow">if</span> ((rx_obj_idx == 0xFFFFFFFFU) && (can_obj_cap.<a class="code" href="group__can__interface__gr.html#a895532773c3204e1538191f155c7bac8">rx</a> == 1U)) { rx_obj_idx = i; }</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> ((tx_obj_idx == 0xFFFFFFFFU) && (can_obj_cap.<a class="code" href="group__can__interface__gr.html#a9706173b2ed538efeb5ee4a952e2272f">tx</a> == 1U)) { tx_obj_idx = i; <span class="keywordflow">break</span>; }</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> ((rx_obj_idx == 0xFFFFFFFFU) || (tx_obj_idx == 0xFFFFFFFFU)) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Set filter to receive messages with extended ID 0x12345678 to receive object</span></div>
<div class="line"> status = ptrCAN->ObjectSetFilter(rx_obj_idx, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U), 0U);</div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->ObjectConfigure(tx_obj_idx, <a class="code" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c">ARM_CAN_OBJ_TX</a>); <span class="comment">// Configure transmit object</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->ObjectConfigure(rx_obj_idx, <a class="code" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a14780ac7274831ee94f427cbbf67c003">ARM_CAN_OBJ_RX</a>); <span class="comment">// Configure receive object</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> status = ptrCAN->SetMode (<a class="code" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcdaa3190344bdf3452462e5c0518ac3cdc4">ARM_CAN_MODE_NORMAL</a>); <span class="comment">// Activate normal operation mode</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"> </div>
<div class="line"> memset(&tx_msg_info, 0U, <span class="keyword">sizeof</span>(<a class="code" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a>)); <span class="comment">// Clear message info structure</span></div>
<div class="line"> tx_msg_info.<a class="code" href="group__can__interface__gr.html#abaabdc509cdaba7df9f56c6c76f3ae19">id</a> = <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U); <span class="comment">// Set extended ID for transmit message</span></div>
<div class="line"> tx_data[0] = 0xFFU; <span class="comment">// Initialize transmit data</span></div>
<div class="line"> <span class="keywordflow">while</span> (1) {</div>
<div class="line"> tx_data[0]++; <span class="comment">// Increment transmit data</span></div>
<div class="line"> status = ptrCAN->MessageSend(tx_obj_idx, &tx_msg_info, tx_data, 1U); <span class="comment">// Send data message with 1 data byte</span></div>
<div class="line"> <span class="keywordflow">if</span> (status != 1U) { Error_Handler(); }</div>
<div class="line"> <span class="keywordflow">for</span> (i = 0U; i < 1000000U; i++) { __nop(); } <span class="comment">// Wait a little while</span></div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --><h1><a class="anchor" id="can_objects"></a>
CAN Message Objects</h1>
<p>The CMSIS-Driver for the CAN interface provides multiple CAN message objects, which can be seen as individual communication channels. The number of available CAN message objects depends on the CAN peripheral. The function <a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a> returns the maximum number of available CAN message objects. The number is encoded in the structure <a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> in the data field <em>num_objects</em>. CAN message objects are addressed with the functions listed below, whereby the parameter <em>obj_idx</em> addresses an individual object. The valid range for <em>obj_idx</em> is <span class="XML-Token">[0 .. (<em>num_objects</em> - 1)]</span>.</p>
<table class="doxtable">
<tr>
<th align="left">Function </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a> </td><td align="left">Retrieves message object capabilities such as receive, transmit, <a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> automatic handling and <a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> </td><td align="left">Allows to set-up CAN ID filtering for the message object. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> </td><td align="left">Allows to configure the message object for receive, transmit or <a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> automatic handling. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a> </td><td align="left">Read received message from the message object. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> </td><td align="left">Send CAN message or send <a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> or set CAN message to be sent automatically on reception of matching <a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> on the message object. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </td><td align="left">Callback function that signals a message transfer or a received message overrun. </td></tr>
</table>
<p>Each CAN message object may have different capabilities. Before using a CAN message object, call the function <a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a> to verify the available features.</p>
<h1><a class="anchor" id="can_filtering"></a>
CAN Message Filtering</h1>
<p>The CMSIS-Driver for the CAN interface supports ID filtering for the receiving message objects. The receiving CAN node examines the identifier to decide if it was relevant. This filtering is done by the CAN peripheral according the settings configured with the function <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a>.</p>
<p>The function <a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a> retrieves the filter capabilities of the CAN message objects stored in <a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a>.</p>
<table class="doxtable">
<tr>
<th align="left">Data Fields </th><th align="left">CAN Messages Object can be filtered with ... </th></tr>
<tr>
<td align="left"><em>exact_filtering</em> </td><td align="left">an exact ID value set by using the function <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> with <em>control</em> = <a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>. </td></tr>
<tr>
<td align="left"><em>range_filtering</em> </td><td align="left">a range ID value set by using the function <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> with <em>control</em> = <a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5">ARM_CAN_FILTER_ID_RANGE_ADD</a>. </td></tr>
<tr>
<td align="left"><em>mask_filtering</em> </td><td align="left">a mask ID value set by as using the function <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> with <em>control</em> = <a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a>. </td></tr>
<tr>
<td align="left"><em>multiple_filters</em> </td><td align="left">... several filters to capture multiple ID values, or ID value ranges. </td></tr>
</table>
<p><b>CAN message filtering using an exact ID</b></p>
<p>Example: accept in message object #1 only frames with extended ID = 0x1567. </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter (1, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x1567), 0);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
</div><!-- fragment --><p>Example: accept in message object #2 frames with extended ID = 0x3167 and extended ID = 0x42123. </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter (2, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x3167), 0);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">status = ptrCAN->ObjectSetFilter (2, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x42123), 0);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
</div><!-- fragment --><p><b>CAN message filtering using a range ID</b></p>
<p>Example: accept in message object #3 only frames with extended ID >= 0x1567 and extended ID <= 0x1577. </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter (3, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5">ARM_CAN_FILTER_ID_RANGE_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x1567), <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x1577));</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
</div><!-- fragment --><p><b>CAN message filtering using a mask ID</b></p>
<p>Using the function <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> with <em>control</em> = <a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a> allows to specify with <em>arg</em> a mask value.</p>
<ul>
<li>if a mask bit is <span class="XML-Token">0</span>, the corresponding <em>ID</em> bit will be accepted, regardless of the value.</li>
<li>if a mask bit is <span class="XML-Token">1</span>, the corresponding <em>ID</em> bit will be compared with the value of the ID filter bit; if they match the message will be accepted otherwise the frame is rejected.</li>
</ul>
<p>Example: accept in message object #0 only frames with extended IDs 0x1560 to 0x156F. </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter (0, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x1560), 0x1FFFFFF0);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
</div><!-- fragment --><p>Example: accept in message object #2 only frames with extended IDs 0x35603, 0x35613, 0x35623, and 0x35633. </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter (2, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x35603), 0x1FFFFFCF);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
</div><!-- fragment --><p>Example: accept any message in object #4 regardless of the ID. </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter (4, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0), 0);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
</div><!-- fragment --><h1><a class="anchor" id="Remote_Frame"></a>
Remote Frame</h1>
<p>In general, data transmission is performed on an autonomous basis with the data source node sending out Data Frames.</p>
<p>However, sending a <b>Remote Frame</b> allows a destination node to request the data from the source node. The examples below shows the data exchange using a <b>Remote Transmission Request (RTR)</b>.</p>
<p><b>Example for automatic Data Message response on RTR</b></p>
<p>For automatic data message response on an RTR, the object is configured with the function <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> <em>obj_cfg</em> = <a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c">ARM_CAN_OBJ_RX_RTR_TX_DATA</a>.</p>
<p>In this case, the function <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> sets a data message that is transmitted when an RTR with a matching CAN ID is received. If <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> was not called before the RTR is received, the response is hardware dependent (either last data message is repeated or no data message is sent until <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> is called).</p>
<p>After data transmission is completed, the driver calls a callback function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> with <em>event</em> = <a class="el" href="group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503">ARM_CAN_EVENT_SEND_COMPLETE</a> and the related <em>obj_idx</em>.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter(0, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U), 0U);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">status = trCAN->ObjectConfigure(0, <a class="code" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c">ARM_CAN_OBJ_RX_RTR_TX_DATA</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line"></div>
<div class="line">memset(&tx_msg_info, 0, <span class="keyword">sizeof</span>(<a class="code" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a>)); <span class="comment">// Clear transmit message structure</span></div>
<div class="line">tx_msg_info.<a class="code" href="group__can__interface__gr.html#abaabdc509cdaba7df9f56c6c76f3ae19">id</a> = <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U); <span class="comment">// Set ID of message</span></div>
<div class="line">data_buf[0] = <span class="charliteral">'1'</span>; data_buf[1] = <span class="charliteral">'2'</span>; <span class="comment">// Prepare data to transmit</span></div>
<div class="line">data_buf[2] = <span class="charliteral">'3'</span>; data_buf[3] = <span class="charliteral">'4'</span>;</div>
<div class="line">data_buf[4] = <span class="charliteral">'5'</span>; data_buf[5] = <span class="charliteral">'6'</span>;</div>
<div class="line">data_buf[6] = <span class="charliteral">'7'</span>; data_buf[7] = <span class="charliteral">'8'</span>;</div>
<div class="line">ptrCAN->MessageSend(0, &tx_msg_info, data_buf, 8); <span class="comment">// Start send message that will be triggered on RTR reception</span></div>
</div><!-- fragment --><p><b>Example for automatic Data Message reception using RTR</b></p>
<p>For automatic data message reception on an RTR, the object is configured with the function <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> <em>obj_cfg</em> = <a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5">ARM_CAN_OBJ_TX_RTR_RX_DATA</a>.</p>
<p>The receiver or consumer requests data with transmission of an RTR with the <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a>. This RTR requests from the transmitter or producer to send the data message. Once the data message is received, the driver calls a callback function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> with <em>event</em> = <a class="el" href="group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47">ARM_CAN_EVENT_RECEIVE</a> and the related <em>obj_idx</em>. The received data message can then be read with the function <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a>.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectSetFilter(0, <a class="code" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a>, <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U), 0U);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">status = ptrCAN->ObjectConfigure(0, <a class="code" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5">ARM_CAN_OBJ_TX_RTR_RX_DATA</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">memset(&tx_msg_info, 0, <span class="keyword">sizeof</span>(<a class="code" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a>)); <span class="comment">// Clear transmit message structure</span></div>
<div class="line">tx_msg_info.<a class="code" href="group__can__interface__gr.html#abaabdc509cdaba7df9f56c6c76f3ae19">id</a> = <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U); <span class="comment">// Set ID of message</span></div>
<div class="line">tx_msg_info.<a class="code" href="group__can__interface__gr.html#a1f32fc9e5d3b33babf5905140e7a53af">rtr</a> = 1; <span class="comment">// Set RTR flag of message to send RTR</span></div>
<div class="line">tx_msg_info.<a class="code" href="group__can__interface__gr.html#a811fbb0cb2c2263b1a7440a7e9d78239">dlc</a> = 1; <span class="comment">// Set data length code of message to 1 to request 1 data byte</span></div>
<div class="line">ptrCAN->MesageSend(0, &tx_msg_info, 0, 0); <span class="comment">// Send RTR</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// Wait for ARM_CAN_EVENT_RECEIVE</span></div>
<div class="line">ptrCAN->MessageRead(0, &rx_msg_info, data_buf, 8); <span class="comment">// Read received message</span></div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__CAN" id="structARM__DRIVER__CAN"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_CAN</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the CAN Driver. </p>
<p>The functions of the CAN are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of a CAN provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p>
<ul>
<li><b>Driver_CAN0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_CAN1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A configuration setting in the middleware allows you to connect the middleware to a specific driver instance <b>Driver_CAN<em>n</em></b>. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga4256d5b23ffcb27759a05f8e6b854f13">ARM_CAN_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62c0c62c2bf482c000b1b2a2c817a96f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a62c0c62c2bf482c000b1b2a2c817a96f">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a62c0c62c2bf482c000b1b2a2c817a96f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a> : Get driver capabilities. <a href="#a62c0c62c2bf482c000b1b2a2c817a96f">More...</a><br/></td></tr>
<tr class="separator:a62c0c62c2bf482c000b1b2a2c817a96f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a322b44b8e757887616b75035a8fd7027"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a322b44b8e757887616b75035a8fd7027">Initialize</a> )(<a class="el" href="group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e">ARM_CAN_SignalUnitEvent_t</a> cb_unit_event, <a class="el" href="group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb">ARM_CAN_SignalObjectEvent_t</a> cb_object_event)</td></tr>
<tr class="memdesc:a322b44b8e757887616b75035a8fd7027"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a> : Initialize CAN interface. <a href="#a322b44b8e757887616b75035a8fd7027">More...</a><br/></td></tr>
<tr class="separator:a322b44b8e757887616b75035a8fd7027"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga1e3e364b64f2ab277399e3279cce5ef8">ARM_CAN_Uninitialize</a> : De-initialize CAN interface. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga6f634f126ac97daef2f3115aa7bfed7c">ARM_CAN_PowerControl</a> : Control CAN interface power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21063f38e762cf29dfd3f5991ee936e2"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a21063f38e762cf29dfd3f5991ee936e2">GetClock</a> )(void)</td></tr>
<tr class="memdesc:a21063f38e762cf29dfd3f5991ee936e2"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga1fe6cc207415de604975ae251e269361">ARM_CAN_GetClock</a> : Retrieve CAN base clock frequency. <a href="#a21063f38e762cf29dfd3f5991ee936e2">More...</a><br/></td></tr>
<tr class="separator:a21063f38e762cf29dfd3f5991ee936e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a360a314665607fc2d866c24e1608fd06"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a360a314665607fc2d866c24e1608fd06">SetBitrate</a> )(<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> select, uint32_t bitrate, uint32_t bit_segments)</td></tr>
<tr class="memdesc:a360a314665607fc2d866c24e1608fd06"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> : Set bitrate for CAN interface. <a href="#a360a314665607fc2d866c24e1608fd06">More...</a><br/></td></tr>
<tr class="separator:a360a314665607fc2d866c24e1608fd06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0fa2edbde052011604addec816782b4e"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a0fa2edbde052011604addec816782b4e">SetMode</a> )(<a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd">ARM_CAN_MODE</a> mode)</td></tr>
<tr class="memdesc:a0fa2edbde052011604addec816782b4e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a> : Set operating mode for CAN interface. <a href="#a0fa2edbde052011604addec816782b4e">More...</a><br/></td></tr>
<tr class="separator:a0fa2edbde052011604addec816782b4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7239c03265659edcaf69dc9ea5e29ce3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a7239c03265659edcaf69dc9ea5e29ce3">ObjectGetCapabilities</a> )(uint32_t obj_idx)</td></tr>
<tr class="memdesc:a7239c03265659edcaf69dc9ea5e29ce3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a> : Retrieve capabilities of an object. <a href="#a7239c03265659edcaf69dc9ea5e29ce3">More...</a><br/></td></tr>
<tr class="separator:a7239c03265659edcaf69dc9ea5e29ce3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bfa264f66c84606ebf9f9e8dc45b907"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a2bfa264f66c84606ebf9f9e8dc45b907">ObjectSetFilter</a> )(uint32_t obj_idx, <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a> operation, uint32_t id, uint32_t arg)</td></tr>
<tr class="memdesc:a2bfa264f66c84606ebf9f9e8dc45b907"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> : Add or remove filter for message reception. <a href="#a2bfa264f66c84606ebf9f9e8dc45b907">More...</a><br/></td></tr>
<tr class="separator:a2bfa264f66c84606ebf9f9e8dc45b907"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24cfe29d7f6a29dfbac3c7011fc5b652"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a24cfe29d7f6a29dfbac3c7011fc5b652">ObjectConfigure</a> )(uint32_t obj_idx, <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0">ARM_CAN_OBJ_CONFIG</a> obj_cfg)</td></tr>
<tr class="memdesc:a24cfe29d7f6a29dfbac3c7011fc5b652"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> : Configure object. <a href="#a24cfe29d7f6a29dfbac3c7011fc5b652">More...</a><br/></td></tr>
<tr class="separator:a24cfe29d7f6a29dfbac3c7011fc5b652"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e6eb8bae2b7f8af99a3ca3cbbacce22"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a3e6eb8bae2b7f8af99a3ca3cbbacce22">MessageSend</a> )(uint32_t obj_idx, <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> *msg_info, const uint8_t *data, uint8_t size)</td></tr>
<tr class="memdesc:a3e6eb8bae2b7f8af99a3ca3cbbacce22"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> : Send message on CAN bus. <a href="#a3e6eb8bae2b7f8af99a3ca3cbbacce22">More...</a><br/></td></tr>
<tr class="separator:a3e6eb8bae2b7f8af99a3ca3cbbacce22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace17a0046cf2c6cdbcb0fd3202e460a0"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ace17a0046cf2c6cdbcb0fd3202e460a0">MessageRead</a> )(uint32_t obj_idx, <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> *msg_info, uint8_t *data, uint8_t size)</td></tr>
<tr class="memdesc:ace17a0046cf2c6cdbcb0fd3202e460a0"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a> : Read message received on CAN bus. <a href="#ace17a0046cf2c6cdbcb0fd3202e460a0">More...</a><br/></td></tr>
<tr class="separator:ace17a0046cf2c6cdbcb0fd3202e460a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e0f47a92f626a971c5197fca6545505"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:a6e0f47a92f626a971c5197fca6545505"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> : Control CAN interface. <a href="#a6e0f47a92f626a971c5197fca6545505">More...</a><br/></td></tr>
<tr class="separator:a6e0f47a92f626a971c5197fca6545505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad60ff24982cdb3ce38b8c17e0b4f0acc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__can__interface__gr.html#structARM__CAN__STATUS">ARM_CAN_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__interface__gr.html#ad60ff24982cdb3ce38b8c17e0b4f0acc">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:ad60ff24982cdb3ce38b8c17e0b4f0acc"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus</a> : Get CAN status. <a href="#ad60ff24982cdb3ce38b8c17e0b4f0acc">More...</a><br/></td></tr>
<tr class="separator:ad60ff24982cdb3ce38b8c17e0b4f0acc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga4256d5b23ffcb27759a05f8e6b854f13">ARM_CAN_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a62c0c62c2bf482c000b1b2a2c817a96f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a322b44b8e757887616b75035a8fd7027"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e">ARM_CAN_SignalUnitEvent_t</a> cb_unit_event, <a class="el" href="group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb">ARM_CAN_SignalObjectEvent_t</a> cb_object_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a> : Initialize CAN interface. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga1e3e364b64f2ab277399e3279cce5ef8">ARM_CAN_Uninitialize</a> : De-initialize CAN interface. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga6f634f126ac97daef2f3115aa7bfed7c">ARM_CAN_PowerControl</a> : Control CAN interface power. </p>
</div>
</div>
<a class="anchor" id="a21063f38e762cf29dfd3f5991ee936e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetClock)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga1fe6cc207415de604975ae251e269361">ARM_CAN_GetClock</a> : Retrieve CAN base clock frequency. </p>
</div>
</div>
<a class="anchor" id="a360a314665607fc2d866c24e1608fd06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetBitrate)(<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> select, uint32_t bitrate, uint32_t bit_segments)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> : Set bitrate for CAN interface. </p>
</div>
</div>
<a class="anchor" id="a0fa2edbde052011604addec816782b4e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetMode)(<a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd">ARM_CAN_MODE</a> mode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a> : Set operating mode for CAN interface. </p>
</div>
</div>
<a class="anchor" id="a7239c03265659edcaf69dc9ea5e29ce3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a>(* ObjectGetCapabilities)(uint32_t obj_idx)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a> : Retrieve capabilities of an object. </p>
</div>
</div>
<a class="anchor" id="a2bfa264f66c84606ebf9f9e8dc45b907"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ObjectSetFilter)(uint32_t obj_idx, <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a> operation, uint32_t id, uint32_t arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter</a> : Add or remove filter for message reception. </p>
</div>
</div>
<a class="anchor" id="a24cfe29d7f6a29dfbac3c7011fc5b652"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ObjectConfigure)(uint32_t obj_idx, <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0">ARM_CAN_OBJ_CONFIG</a> obj_cfg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> : Configure object. </p>
</div>
</div>
<a class="anchor" id="a3e6eb8bae2b7f8af99a3ca3cbbacce22"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* MessageSend)(uint32_t obj_idx, <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> *msg_info, const uint8_t *data, uint8_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> : Send message on CAN bus. </p>
</div>
</div>
<a class="anchor" id="ace17a0046cf2c6cdbcb0fd3202e460a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* MessageRead)(uint32_t obj_idx, <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> *msg_info, uint8_t *data, uint8_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a> : Read message received on CAN bus. </p>
</div>
</div>
<a class="anchor" id="a6e0f47a92f626a971c5197fca6545505"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Control)(uint32_t control, uint32_t arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> : Control CAN interface. </p>
</div>
</div>
<a class="anchor" id="ad60ff24982cdb3ce38b8c17e0b4f0acc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__can__interface__gr.html#structARM__CAN__STATUS">ARM_CAN_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus</a> : Get CAN status. </p>
</div>
</div>
</div>
</div>
<a name="structARM__CAN__CAPABILITIES" id="structARM__CAN__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_CAN_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>CAN Device Driver Capabilities. </p>
<p>A CAN driver can be implemented with different capabilities encoded in the data fields of this structure.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a></li>
</ul>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> for information about CAN objects. </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a69bd1a164443cf6f501489f4d31f4681"></a>uint32_t</td>
<td class="fieldname">
num_objects: 8</td>
<td class="fielddoc">
Number of <a class="el" href="group__can__interface__gr.html#can_objects">CAN Message Objects</a> available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae0514834750c7452431717a881471e2b"></a>uint32_t</td>
<td class="fieldname">
reentrant_operation: 1</td>
<td class="fielddoc">
Support for reentrant calls to <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a>, <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a>, <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> and abort message sending used by <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a15d22d5906d419ed1a7ca0968be00a04"></a>uint32_t</td>
<td class="fieldname">
fd_mode: 1</td>
<td class="fielddoc">
Support for CAN with flexible data-rate mode (CAN_FD) (set by <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a>) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a93008ac105806db484e78e0582ca118c"></a>uint32_t</td>
<td class="fieldname">
restricted_mode: 1</td>
<td class="fielddoc">
Support for restricted operation mode (set by <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a>) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a176f42e68d9cba86b3594c40044b86c6"></a>uint32_t</td>
<td class="fieldname">
monitor_mode: 1</td>
<td class="fielddoc">
Support for bus monitoring mode (set by <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a>) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af19cdbb26d3496ed7dd63a59a7c7711f"></a>uint32_t</td>
<td class="fieldname">
internal_loopback: 1</td>
<td class="fielddoc">
Support for internal loopback mode (set by <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a>) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2b76df7e4bfbdd9866cc906415e626c9"></a>uint32_t</td>
<td class="fieldname">
external_loopback: 1</td>
<td class="fielddoc">
Support for external loopback mode (set by <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode</a>) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 18</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__CAN__STATUS" id="structARM__CAN__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_CAN_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>CAN Status. </p>
<p>Structure with information about the status of the CAN unit state and errors. The data fields encode the unit bus state, last error code, transmitter error count, and receiver error count.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a96ec94acab56690b3801e3c5fbd09fa2"></a>uint32_t</td>
<td class="fieldname">
unit_state: 4</td>
<td class="fielddoc">
Unit bus state. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2171ea8dff5e4b54e84728aa134854b6"></a>uint32_t</td>
<td class="fieldname">
last_error_code: 4</td>
<td class="fielddoc">
Last error code. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8941505f6f3ebd69825c4382184c580f"></a>uint32_t</td>
<td class="fieldname">
tx_error_count: 8</td>
<td class="fielddoc">
Transmitter error count. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab7e8b863b379b786ad1af935aa3ef2e8"></a>uint32_t</td>
<td class="fieldname">
rx_error_count: 8</td>
<td class="fielddoc">
Receiver error count. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 8</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structARM__CAN__MSG__INFO" id="structARM__CAN__MSG__INFO"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_CAN_MSG_INFO</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>CAN Message Information. </p>
<p>Structure with information about the CAN message.</p>
<p>In CAN mode, the following <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> data fields are ignored: <em>edl</em>, <em>brs</em>, <em>esi</em>. <br/>
In CAN FD mode, the following <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> data field is ignored: <em>rtr</em>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a></li>
<li><a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a></li>
</ul>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abaabdc509cdaba7df9f56c6c76f3ae19"></a>uint32_t</td>
<td class="fieldname">
id</td>
<td class="fielddoc">
CAN identifier with frame format specifier (bit 31) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1f32fc9e5d3b33babf5905140e7a53af"></a>uint32_t</td>
<td class="fieldname">
rtr: 1</td>
<td class="fielddoc">
Remote transmission request frame. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab6883964c9d4bdf60616684e8d2459df"></a>uint32_t</td>
<td class="fieldname">
edl: 1</td>
<td class="fielddoc">
Flexible data-rate format extended data length. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3539c043c5868c59f76c736fe2bcadf4"></a>uint32_t</td>
<td class="fieldname">
brs: 1</td>
<td class="fielddoc">
Flexible data-rate format with bitrate switch. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ada78e3124de6adf5a5d212f9ebc4bbe0"></a>uint32_t</td>
<td class="fieldname">
esi: 1</td>
<td class="fielddoc">
Flexible data-rate format error state indicator. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a811fbb0cb2c2263b1a7440a7e9d78239"></a>uint32_t</td>
<td class="fieldname">
dlc: 4</td>
<td class="fielddoc">
Data length code. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 24</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structARM__CAN__OBJ__CAPABILITIES" id="structARM__CAN__OBJ__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_CAN_OBJ_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>CAN Object Capabilities. </p>
<p>A CAN object can be implemented with different capabilities encoded in the data fields of this structure.</p>
<p><b>Returned by</b>:</p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7">ARM_CAN_ObjectGetCapabilities</a></li>
</ul>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a> </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9706173b2ed538efeb5ee4a952e2272f"></a>uint32_t</td>
<td class="fieldname">
tx: 1</td>
<td class="fielddoc">
Object supports transmission. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a895532773c3204e1538191f155c7bac8"></a>uint32_t</td>
<td class="fieldname">
rx: 1</td>
<td class="fielddoc">
Object supports reception. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8a41139926d7c032247458d055071fda"></a>uint32_t</td>
<td class="fieldname">
rx_rtr_tx_data: 1</td>
<td class="fielddoc">
Object supports RTR reception and automatic Data Frame transmission. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1debac19545140bdfe3c5fa8d53f1863"></a>uint32_t</td>
<td class="fieldname">
tx_rtr_rx_data: 1</td>
<td class="fielddoc">
Object supports RTR transmission and automatic Data Frame reception. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3662fb9a8fb81212043cadd90da704af"></a>uint32_t</td>
<td class="fieldname">
multiple_filters: 1</td>
<td class="fielddoc">
Object allows assignment of multiple filters to it. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a886337af58da4f995529eba228fb9b7a"></a>uint32_t</td>
<td class="fieldname">
exact_filtering: 1</td>
<td class="fielddoc">
Object supports exact identifier filtering. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a96dcf869f4adc9cec686630082c7c60a"></a>uint32_t</td>
<td class="fieldname">
range_filtering: 1</td>
<td class="fielddoc">
Object supports range identifier filtering. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2aa0e772d6cb8c30bb76ce1324423464"></a>uint32_t</td>
<td class="fieldname">
mask_filtering: 1</td>
<td class="fielddoc">
Object supports mask identifier filtering. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5a782fc223b0ea5034c6676eaec6f2d4"></a>uint32_t</td>
<td class="fieldname">
message_depth: 8</td>
<td class="fielddoc">
Number of messages buffers (FIFO) for that object. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 16</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaac07b9fdf614bf439414f5417aaa376e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_CAN_SignalUnitEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> : Signal CAN Unit Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga7ceceac3e9aa0981c5cacfab88efb4eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_CAN_SignalObjectEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> : Signal CAN Object Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4256d5b23ffcb27759a05f8e6b854f13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_CAN_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_CAN_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a> Driver_CAN0;</div>
<div class="line"><a class="code" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a> *drv_info;</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> setup_can (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"></div>
<div class="line"> drv_info = &Driver_CAN0;</div>
<div class="line"> version = drv_info-><a class="code" href="group__can__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga35f21cabe1637b1be964024a8f77721c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> ARM_CAN_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_CAN_GetCapabilities</b> returns information about the capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> encode various capabilities.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a> Driver_CAN0;</div>
<div class="line"><a class="code" href="group__can__interface__gr.html#structARM__DRIVER__CAN">ARM_DRIVER_CAN</a> *drv_info;</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__can__interface__gr.html#structARM__CAN__CAPABILITIES">ARM_CAN_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"></div>
<div class="line"> drv_info = &Driver_CAN0;</div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__can__interface__gr.html#a62c0c62c2bf482c000b1b2a2c817a96f">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"></div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaa72ceb25ba67e279d7432404632deb44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e">ARM_CAN_SignalUnitEvent_t</a> </td>
<td class="paramname"><em>cb_unit_event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb">ARM_CAN_SignalObjectEvent_t</a> </td>
<td class="paramname"><em>cb_object_event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize CAN interface and register signal (callback) functions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_unit_event</td><td>Pointer to <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> callback function </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb_object_event</td><td>Pointer to <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>initializes</b> the CAN interface.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the CAN interface, for example dynamic memory allocation, RTOS object allocation, and possibly hardware pin configuration.</li>
<li>Registers the <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> callback function.</li>
<li>Registers the <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_unit_event</em> is a pointer to the <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p>The parameter <em>cb_object_event</em> is a pointer to the <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__can__interface__gr.html">CAN Interface</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga1e3e364b64f2ab277399e3279cce5ef8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize CAN interface. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_Uninitialize</b> de-initializes the resources of the CAN interface. It is called to release the software resources used by the interface such as deallocate any RTOS objects, dynamic memory and pin de-configuration. </p>
</div>
</div>
<a class="anchor" id="ga6f634f126ac97daef2f3115aa7bfed7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control CAN interface power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : power off: no operation possible</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : low power mode: retain state, detect and signal wake-up events</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : power on: full operation at maximum performance </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_PowerControl</b> controls the power modes of the CAN interface.</p>
<p>The parameter <em>state</em> can be:</p>
<ul>
<li>ARM_POWER_FULL: Activate clocks and driver functionality as if peripheral was reset.</li>
<li>ARM_POWER_OFF: Unconditionally put peripheral into non-functional (reset) state.</li>
<li>ARM_POWER_LOW: Put peripheral into low power consumption state ready to wake up on bus event. </li>
</ul>
</div>
</div>
<a class="anchor" id="ga1fe6cc207415de604975ae251e269361"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_CAN_GetClock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve CAN base clock frequency. </p>
<dl class="section return"><dt>Returns</dt><dd>base clock frequency</dd></dl>
<p>The function <b>ARM_CAN_GetClock</b> returns the CAN base clock frequency in <span class="XML-Token">[Hz]</span>. This value may be used to validate the <em>bitrate</em> for the function <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a>.</p>
<p><b>Example</b>: </p>
<div class="fragment"><div class="line">CAN_clock = <a class="code" href="group__can__interface__gr.html#ga1fe6cc207415de604975ae251e269361">ARM_CAN_GetClock</a>(); <span class="comment">// CAN base clock frequency</span></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga88bb27a8525503a250cca7a2c4a5d07a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_SetBitrate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> </td>
<td class="paramname"><em>select</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>bitrate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>bit_segments</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set bitrate for CAN interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">select</td><td>Bitrate selection<ul>
<li><a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a> : nominal (flexible data-rate arbitration) bitrate</li>
<li><a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc">ARM_CAN_BITRATE_FD_DATA</a> : flexible data-rate data bitrate </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bitrate</td><td>Bitrate </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bit_segments</td><td>Bit segments settings<ul>
<li><a class="el" href="group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea">ARM_CAN_BIT_PROP_SEG(x)</a> : number of time quanta for propagation time segment</li>
<li><a class="el" href="group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792">ARM_CAN_BIT_PHASE_SEG1(x)</a> : number of time quanta for phase buffer segment 1</li>
<li><a class="el" href="group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80">ARM_CAN_BIT_PHASE_SEG2(x)</a> : number of time quanta for phase buffer Segment 2</li>
<li><a class="el" href="group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269">ARM_CAN_BIT_SJW(x)</a> : number of time quanta for (re-)synchronization jump width </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_SetBitrate</b> sets the CAN communication bit rate.</p>
<p>The parameter <em>select</em> selects the bit rate affected by function call as defined in <a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> and listed in the table below.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>select</em> </th><th align="left">CAN Mode Bit Rate </th></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a> </td><td align="left">Select nominal (flexible data-rate arbitration) bitrate (CAN 2.0B) </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc">ARM_CAN_BITRATE_FD_DATA</a> </td><td align="left">Select flexible data-rate data bitrate (<a class="el" href="group__can__interface__gr.html#CAN_FD">CAN_FD</a>) </td></tr>
</table>
<p>The parameter <em>bitrate</em> is the bit rate for the selected CAN mode.</p>
<p>The parameter <em>bit_segments</em> is used to setup the time quanta for sampling (see picture below). The values listed in the table below are ORed and specify the various sampling segments. The CAN controller samples each bit on the bus at the <em>Sample Point</em>.</p>
<table class="cmtable">
<tr>
<th>Parameter <em>bit_segments</em> </th><th>Bit </th><th>for <em>select</em> = <a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a> <br/>
(CAN specification) </th><th>for <em>select</em> = <a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a> <br/>
(CAN FD specification) </th><th>for <em>select</em> = <a class="el" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc">ARM_CAN_BITRATE_FD_DATA</a> <br/>
(CAN FD specification) </th></tr>
<tr>
<td><a class="el" href="group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea">ARM_CAN_BIT_PROP_SEG</a>(<em>x</em>) <br/>
Propagation Time Segment <br/>
(PROP_SEG) </td><td>0..7 </td><td><em>x</em> = <span class="XML-Token">[1..8]</span> </td><td><em>x</em> = <span class="XML-Token">[1..32] or more</span> </td><td><em>x</em> = <span class="XML-Token">[0..8]</span> </td></tr>
<tr>
<td><a class="el" href="group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792">ARM_CAN_BIT_PHASE_SEG1</a>(<em>x</em>) <br/>
Phase Buffer Segment 1 <br/>
(PHASE_SEG1) </td><td>8..15 </td><td><em>x</em> = <span class="XML-Token">[1..8]</span> </td><td><em>x</em> = <span class="XML-Token">[1..32] or more</span> </td><td><em>x</em> = <span class="XML-Token">[1..8]</span> </td></tr>
<tr>
<td rowspan="2"><a class="el" href="group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80">ARM_CAN_BIT_PHASE_SEG2</a>(<em>x</em>) <br/>
Phase Buffer Segment 2 <br/>
(PHASE_SEG2) </td><td rowspan="2">16..23 </td><td><em>x</em> = <span class="XML-Token">[1..8]</span> </td><td><em>x</em> = <span class="XML-Token">[1..32] or more</span> </td><td><em>x</em> = <span class="XML-Token">[1..8]</span> </td></tr>
<tr>
<td colspan="3">The maximum allowed value is <span class="XML-Token">x = MAX (PHASE_SEG1, IPT)</span>. IPT = Information Processing Time. Usually, IPT = <span class="XML-Token">2</span>. Exceptions apply. Read the specifications of your CAN controller. </td></tr>
<tr>
<td rowspan="2"><a class="el" href="group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269">ARM_CAN_BIT_SJW</a>(<em>x</em>) <br/>
(Re-)Synchronization Jump Width <br/>
(SJW). </td><td rowspan="2">24..31 </td><td><em>x</em> = <span class="XML-Token">[1..4]</span> </td><td><em>x</em> = <span class="XML-Token">[1..4]</span> </td><td><em>x</em> = <span class="XML-Token">[1..4]</span> </td></tr>
<tr>
<td colspan="3">The maximum allowed value is <span class="XML-Token">x = MIN (MIN (PHASE_SEG1, PHASE_SEG2), 4)</span>. SJW is not allowed to be greater than either PHASE segment. </td></tr>
</table>
<p>The picture shows a Nominal Bit Time with 10 time quanta. </p>
<div class="image">
<img src="CAN_Bit_Timing.png" alt="CAN_Bit_Timing.png"/>
<div class="caption">
CAN Bit Timing</div></div>
<p>The time quanta (N) per bit is: </p>
<div class="fragment"><div class="line">N = 1 + PROP_SEG + PHASE_SEG1 + PHASE_SEG2; <span class="comment">// note SYNC_SEG is always 1</span></div>
</div><!-- fragment --><p>The driver uses this value and the CAN clock to calculate a suitable prescaler value (P). If the driver cannot achieve the requested <em>bitrate</em> it returns with <a class="el" href="Driver__CAN_8h.html#a90b9d9323a6049fb4fcd1efe7c892294">ARM_CAN_INVALID_BITRATE</a>. The formula for the <em>bitrate</em> is: </p>
<div class="fragment"><div class="line">bitrate = (CAN_Clock / P) / N;</div>
</div><!-- fragment --><p><b>Example</b>: </p>
<div class="fragment"><div class="line">status = ptrCAN->SetBitrate (<a class="code" href="Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a>, <span class="comment">// Set nominal bitrate</span></div>
<div class="line"> 125000U, <span class="comment">// Set bitrate to 125 kbit/s</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea">ARM_CAN_BIT_PROP_SEG</a>(5U) | <span class="comment">// Set propagation segment to 5 time quanta</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792">ARM_CAN_BIT_PHASE_SEG1</a>(1U) | <span class="comment">// Set phase segment 1 to 1 time quantum (sample point at 87.5% of bit time)</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80">ARM_CAN_BIT_PHASE_SEG2</a>(1U) | <span class="comment">// Set phase segment 2 to 1 time quantum (total bit is 8 time quanta long)</span></div>
<div class="line"> <a class="code" href="group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269">ARM_CAN_BIT_SJW</a>(1U)); <span class="comment">// Resynchronization jump width is same as phase segment 2</span></div>
</div><!-- fragment --><p>In this example, N = 8 and with a CAN_Clock = 8MHz the prescaler (P) is calculated by the driver to 8. </p>
</div>
</div>
<a class="anchor" id="ga28226a6e223f9b95b4dafb7c2f48a855"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_SetMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__can__bus__mode__ctrls.html#gabbca99c46d478bcf822eee71cdf75dcd">ARM_CAN_MODE</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set operating mode for CAN interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Operating mode<ul>
<li><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda9967a5ebaa045afe54d75e5629676ddc">ARM_CAN_MODE_INITIALIZATION</a> : initialization mode</li>
<li><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcdaa3190344bdf3452462e5c0518ac3cdc4">ARM_CAN_MODE_NORMAL</a> : normal operation mode</li>
<li><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda22a9bb26e68c2a04f641d466040d755d">ARM_CAN_MODE_RESTRICTED</a> : restricted operation mode</li>
<li><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda904f68f08c84c4b85c763f5d98c574ab">ARM_CAN_MODE_MONITOR</a> : bus monitoring mode</li>
<li><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda8579315576baa43860a398a30fd527d8">ARM_CAN_MODE_LOOPBACK_INTERNAL</a> : loopback internal mode</li>
<li><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda5ee1ba60abcf39d575e7cb309e641b9b">ARM_CAN_MODE_LOOPBACK_EXTERNAL</a> : loopback external mode </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_SetMode</b> sets the CAN bus communication mode using the parameter <em>mode</em>.</p>
<p>The table lists the values for <em>mode</em>.</p>
<table class="cmtable">
<tr>
<th>Parameter <em>mode</em> </th><th>Bus Communication Mode </th><th>supported when <a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> data field </th></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda9967a5ebaa045afe54d75e5629676ddc">ARM_CAN_MODE_INITIALIZATION</a> </td><td>Initialization mode; Used to setup communication parameters for the reception objects and global filtering, while peripheral is not active on the bus. Refer to <a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a> for details. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcdaa3190344bdf3452462e5c0518ac3cdc4">ARM_CAN_MODE_NORMAL</a> </td><td>Normal operation mode. Used when peripheral is in active mode to receive, transmit, and acknowledge messages on the bus. Depending on the current unit state, it can generate error or overload messages. Verify the unit state with <a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda22a9bb26e68c2a04f641d466040d755d">ARM_CAN_MODE_RESTRICTED</a> </td><td>Restricted operation mode. Used for monitoring the bus communication non-intrusively without transmitting. </td><td><em>restricted_mode</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda904f68f08c84c4b85c763f5d98c574ab">ARM_CAN_MODE_MONITOR</a> </td><td>Bus monitoring mode. </td><td><em>monitor_mode</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda8579315576baa43860a398a30fd527d8">ARM_CAN_MODE_LOOPBACK_INTERNAL</a> </td><td>Test mode; loopback of CAN transmission to its receiver. No transmission visible on CAN bus. </td><td><em>internal_loopback</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gabbca99c46d478bcf822eee71cdf75dcda5ee1ba60abcf39d575e7cb309e641b9b">ARM_CAN_MODE_LOOPBACK_EXTERNAL</a> </td><td>Test mode; loopback of CAN transmission to its receiver. Transmission is visible on CAN bus. </td><td><em>external_loopback</em> = <span class="XML-Token">1</span> </td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga45ab314f5121cf5a1b32d9adc600e0f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> ARM_CAN_ObjectGetCapabilities </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>obj_idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve capabilities of an object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_idx</td><td>Object index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_CAN_ObjectGetCapabilities</b> retrieves the capabilities of a CAN object. The structure <a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> stores the values.</p>
<p>The parameter <em>obj_idx</em> is the message object index.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630" title="Configure object. ">ARM_CAN_ObjectConfigure</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d" title="Add or remove filter for message reception. ">ARM_CAN_ObjectSetFilter</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4f9bc7088704483388e14872c9d5385d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_ObjectSetFilter </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>obj_idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a> </td>
<td class="paramname"><em>operation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add or remove filter for message reception. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_idx</td><td>Object index of object that filter should be or is assigned to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">operation</td><td>Operation on filter<ul>
<li><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a> : add exact id filter</li>
<li><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a6fdaecf3fa244ef1e4d1069d9c6c95f8">ARM_CAN_FILTER_ID_EXACT_REMOVE</a> : remove exact id filter</li>
<li><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5">ARM_CAN_FILTER_ID_RANGE_ADD</a> : add range id filter</li>
<li><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a17fea7d388dc702bb3318ecae911f50d">ARM_CAN_FILTER_ID_RANGE_REMOVE</a> : remove range id filter</li>
<li><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a> : add maskable id filter</li>
<li><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ad9573d5d0e112aece7abc0bc24aa92fb">ARM_CAN_FILTER_ID_MASKABLE_REMOVE</a> : remove maskable id filter </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>ID or start of ID range (depending on filter type) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Mask or end of ID range (depending on filter type) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_ObjectSetFilter</b> sets or removes the filter for message reception. Refer to <a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a> for details on filtering.</p>
<p>The parameter <em>obj_idx</em> is the message object index. <br/>
The parameter <em>operation</em> is the operation on the filter as listed in the table below and which are defined in the structure <a class="el" href="group__can__filter__operation__ctrls.html#gacb04d0f8b3969ee69362ff2b62941d75">ARM_CAN_FILTER_OPERATION</a>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>operation</em> </th><th align="left">Operation on Filter </th><th align="left">supported when <a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> data field </th></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75aa734058b50573de3b0cc49311997806b">ARM_CAN_FILTER_ID_EXACT_ADD</a> </td><td align="left">Add exact ID filter </td><td align="left"><em>exact_filtering</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a6fdaecf3fa244ef1e4d1069d9c6c95f8">ARM_CAN_FILTER_ID_EXACT_REMOVE</a> </td><td align="left">Remove exact ID filter </td><td align="left"><em>exact_filtering</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a22123bef8e773844fce604c553bf2ed5">ARM_CAN_FILTER_ID_RANGE_ADD</a> </td><td align="left">Add range ID filter </td><td align="left"><em>range_filtering</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75a17fea7d388dc702bb3318ecae911f50d">ARM_CAN_FILTER_ID_RANGE_REMOVE</a> </td><td align="left">Remove range ID filter </td><td align="left"><em>range_filtering</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ac4ad302fa9b762c1d14964141e234ba9">ARM_CAN_FILTER_ID_MASKABLE_ADD</a> </td><td align="left">Add maskable ID filter </td><td align="left"><em>mask_filtering</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="Driver__CAN_8h.html#gacb04d0f8b3969ee69362ff2b62941d75ad9573d5d0e112aece7abc0bc24aa92fb">ARM_CAN_FILTER_ID_MASKABLE_REMOVE</a> </td><td align="left">Remove maskable ID filter </td><td align="left"><em>mask_filtering</em> = <span class="XML-Token">1</span> </td></tr>
</table>
<p>The parameter <em>id</em> is the identifier of the filter or defines the start of the filter range (depends on the filter operation). <br/>
The parameter <em>arg</em> is the mask of the filter or defines the end of the filter range (depends on the filter operation).</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630" title="Configure object. ">ARM_CAN_ObjectConfigure</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga00ec0715f6755a49dae5b60dca182630"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_ObjectConfigure </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>obj_idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0">ARM_CAN_OBJ_CONFIG</a> </td>
<td class="paramname"><em>obj_cfg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_idx</td><td>Object index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">obj_cfg</td><td>Object configuration state<ul>
<li><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0aebbd0da59658805af30203be66d80249">ARM_CAN_OBJ_INACTIVE</a> : deactivate object</li>
<li><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a14780ac7274831ee94f427cbbf67c003">ARM_CAN_OBJ_RX</a> : configure object for reception</li>
<li><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c">ARM_CAN_OBJ_TX</a> : configure object for transmission</li>
<li><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c">ARM_CAN_OBJ_RX_RTR_TX_DATA</a> : configure object that on RTR reception automatically transmits Data Frame</li>
<li><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5">ARM_CAN_OBJ_TX_RTR_RX_DATA</a> : configure object that transmits RTR and automatically receives Data Frame </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_ObjectConfigure</b> configures the message object, which can be a mailbox or FIFO. Refer to <a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a> for details.</p>
<p>The parameter <em>obj_idx</em> specifies the message object index. <br/>
The parameter <em>obj_cfg</em> configures the <b>object</b> with values as shown in the following table.</p>
<table class="cmtable">
<tr>
<th>Parameter <em>obj_cfg</em> </th><th>Object Configuration </th><th>supported when <a class="el" href="group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES">ARM_CAN_OBJ_CAPABILITIES</a> data field </th></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0aebbd0da59658805af30203be66d80249">ARM_CAN_OBJ_INACTIVE</a> </td><td>Deactivate object (default after <a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a>) </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a14780ac7274831ee94f427cbbf67c003">ARM_CAN_OBJ_RX</a> </td><td>Receive object; read received message with <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a>. </td><td><em>rx</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c">ARM_CAN_OBJ_TX</a> </td><td>Transmit object; send message with <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a>. </td><td><em>tx</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c">ARM_CAN_OBJ_RX_RTR_TX_DATA</a> </td><td><a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> Receive; when <b>RTR</b> is received data message is transmitted; set data message with <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a>. </td><td><em>rx_rtr_tx_data</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5">ARM_CAN_OBJ_TX_RTR_RX_DATA</a> </td><td><a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> Transmit; a <b>RTR</b> is sent with <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> to trigger object reception; read received data message with <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a>. </td><td><em>tx_rtr_rx_data</em> = <span class="XML-Token">1</span> </td></tr>
</table>
<p>When the <b>object</b> is deactivated, it is not used for data communication.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d" title="Add or remove filter for message reception. ">ARM_CAN_ObjectSetFilter</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0dcffd362b4093043442a030eaebbcfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_MessageSend </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>obj_idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> * </td>
<td class="paramname"><em>msg_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send message on CAN bus. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_idx</td><td>Object index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg_info</td><td>Pointer to CAN message information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to data buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of data bytes to send </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value >= 0 number of data bytes accepted to send </dd>
<dd>
value < 0 <a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_MessageSend</b> sends a CAN message on the CAN bus, or sets data message that will be automatically returned upon RTR reception with matching CAN ID.</p>
<p>Only one message can be sent with a call to this function (for CAN up to <span class="XML-Token">8</span> bytes; for CAN FD up to <span class="XML-Token">64</span> bytes of data). A message transmission can be terminated with a call to the function <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> with <em>control</em> = <a class="el" href="group__can__mode__ctrls.html#gae051a548bf785104a934908360529438">ARM_CAN_ABORT_MESSAGE_SEND</a>.</p>
<p>The parameter <em>obj_idx</em> specifies the message object index.</p>
<p>The parameter <em>msg_info</em> is a pointer to the structure <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a>, which contains the following relevant data fields for sending message:</p>
<ul>
<li><em>id:</em> Identifier of the message; bit <span class="XML-Token">31</span> specifies if this is an <span class="XML-Token">11-bit</span> or <span class="XML-Token">29-bit</span> identifier.</li>
<li><em>rtr:</em> Specifies if Remote Transmission Request should be sent (<em>dlc</em> is used for number of requested bytes), otherwise the data message will be sent. Refer to <a class="el" href="group__can__interface__gr.html#Remote_Frame">Remote Frame</a> for details.</li>
<li><em>edl:</em> Specifies if Extended Data Length is used; for CAN FD, message can contain up to <span class="XML-Token">64</span> data bytes.</li>
<li><em>brs:</em> Specifies if Bit Rate Switching is to be used; for CAN FD, the bit rate can be increased during data phase.</li>
<li><em>dlc:</em> Data Length Code of requested data bytes when sending Remote Transmission Request.</li>
</ul>
<p>The parameter <em>data</em> is a pointer to the data buffer.<br/>
The parameter <em>size</em> is the number of data bytes to send.<br/>
The function returns the number of bytes accepted to be sent or <a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a> if the hardware is not ready to accept a new message for transmission.</p>
<p>When the message is sent, the callback function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> is called signalling <a class="el" href="group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503">ARM_CAN_EVENT_SEND_COMPLETE</a> on specified object.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#can_filtering">CAN Message Filtering</a></dd></dl>
<p><b>Example:</b></p>
<div class="fragment"><div class="line">status = ptrCAN->ObjectConfigure(0, <a class="code" href="Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c">ARM_CAN_OBJ_TX</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
<div class="line"></div>
<div class="line">memset(&tx_msg_info, 0, <span class="keyword">sizeof</span>(<a class="code" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a>)); <span class="comment">// Clear transmit message structure</span></div>
<div class="line">tx_msg_info.<a class="code" href="group__can__interface__gr.html#abaabdc509cdaba7df9f56c6c76f3ae19">id</a> = <a class="code" href="group__can__identifer__ctrls.html#gae7d4efb6fb49e1ec47c2b12e22f37cae">ARM_CAN_EXTENDED_ID</a>(0x12345678U); <span class="comment">// Set ID of message</span></div>
<div class="line">data_buf[0] = <span class="charliteral">'1'</span>; data_buf[1] = <span class="charliteral">'2'</span>; <span class="comment">// Prepare data to transmit</span></div>
<div class="line">data_buf[2] = <span class="charliteral">'3'</span>; data_buf[3] = <span class="charliteral">'4'</span>;</div>
<div class="line">data_buf[4] = <span class="charliteral">'5'</span>; data_buf[5] = <span class="charliteral">'6'</span>;</div>
<div class="line">data_buf[6] = <span class="charliteral">'7'</span>; data_buf[7] = <span class="charliteral">'8'</span>;</div>
<div class="line">status = ptrCAN->MesageSend(0, &tx_msg_info, data_buf, 8); <span class="comment">// Send message</span></div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> ) { Error_Handler(); }</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gafc37084df5eab32f593c2744d35cf647"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_MessageRead </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>obj_idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> * </td>
<td class="paramname"><em>msg_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read message received on CAN bus. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_idx</td><td>Object index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">msg_info</td><td>Pointer to read CAN message information </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to data buffer for read data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Maximum number of data bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value >= 0 number of data bytes read </dd>
<dd>
value < 0 <a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_MessageRead</b> reads the message received on the CAN bus, if <em>obj_idx</em> was configured for reception or for automatic Data Message reception using RTR and the callback function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> was called signalling <a class="el" href="group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47">ARM_CAN_EVENT_RECEIVE</a>. If the message was overrun by another received message, then the callback function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> will be called signalling <a class="el" href="group__CAN__events.html#ga6c2d29b5c49d5cd18e97f5931157a94c">ARM_CAN_EVENT_RECEIVE_OVERRUN</a>.</p>
<p>The function can read a maximum of <span class="XML-Token">8</span> data bytes for CAN and <span class="XML-Token">64</span> bytes for CAN FD.</p>
<p>The parameter <em>obj_idx</em> specifies the message object index. <br/>
The parameter <em>msg_info</em> is a pointer to the CAN information structure. <br/>
The parameter <em>data</em> is a pointer to the data buffer for reading data. <br/>
The parameter <em>size</em> is data buffer size in bytes and indicates the maximum number of bytes that can be read.</p>
<p>The function returns the number of read data in bytes or the <a class="el" href="group__execution__status.html">Status Error Codes</a>.</p>
<p>All data fields of the structure <a class="el" href="group__can__interface__gr.html#structARM__CAN__MSG__INFO">ARM_CAN_MSG_INFO</a> are updated as described below:</p>
<ul>
<li>id: Identifier of the message that was received, bit <span class="XML-Token">31</span> specifies if it is a <span class="XML-Token">11-bit</span> identifier or <span class="XML-Token">29-bit</span> identifier.</li>
<li>rtr: <span class="XML-Token">1</span> = Remote Frame Request was received (<em>dlc</em> is number of requested bytes). <span class="XML-Token">0</span> = data message</li>
<li>edl: <span class="XML-Token">1</span> = CAN FD Extended Data Length message was received. <span class="XML-Token">0</span> = not Extended Data Length message.</li>
<li>brs: <span class="XML-Token">1</span> = CAN FD Bit Rate Switching was used for message transfer. <span class="XML-Token">0</span> = no Bit Rate Switching was used.</li>
<li>esi: <span class="XML-Token">1</span> = CAN FD Error State Indicator is active for received message. <span class="XML-Token">0</span> = Error State Indicator is not active.</li>
<li>dlc: Data Length Code is the number of data bytes in the received message or number of data bytes requested by RTR.</li>
</ul>
<p>Message reception can be disabled by de-configuring the receive object with the function <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a>. </p>
</div>
</div>
<a class="anchor" id="ga8d9f0c5f03a8a81ab062b5aa57e5dea4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_CAN_Control </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control CAN interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation<ul>
<li><a class="el" href="group__can__mode__ctrls.html#ga978ab3e8860f644dea780e87b3478ff4">ARM_CAN_SET_FD_MODE</a> : set FD operation mode</li>
<li><a class="el" href="group__can__mode__ctrls.html#gae051a548bf785104a934908360529438">ARM_CAN_ABORT_MESSAGE_SEND</a> : abort sending of CAN message</li>
<li><a class="el" href="group__can__mode__ctrls.html#ga0453b8900ca3a0d5210ffd6a918a78e6">ARM_CAN_CONTROL_RETRANSMISSION</a> : enable/disable automatic retransmission</li>
<li><a class="el" href="group__can__mode__ctrls.html#ga398dd25256e644cd8d6506495a06bde8">ARM_CAN_SET_TRANSCEIVER_DELAY</a> : set transceiver delay </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_CAN_Control</b> controls the CAN interface settings and executes various operations.</p>
<p>The parameter <em>control</em> specifies various operations that are listed in the table below.</p>
<p>The parameters <em>arg</em> provides, depending on the <em>control</em> value, additional information or set values.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>control</em> </th><th align="left">Operation </th></tr>
<tr>
<td align="left"><a class="el" href="group__can__mode__ctrls.html#ga978ab3e8860f644dea780e87b3478ff4">ARM_CAN_SET_FD_MODE</a> </td><td align="left">Select <a href="#CAN_FD"><b>CAN FD</b></a> mode; <em>arg</em> : <span class="XML-Token">0</span> = CAN 2.0B; <span class="XML-Token">1</span> = CAN FD. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__mode__ctrls.html#gae051a548bf785104a934908360529438">ARM_CAN_ABORT_MESSAGE_SEND</a> </td><td align="left">Abort sending of CAN message; <em>arg</em> : object index </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__mode__ctrls.html#ga0453b8900ca3a0d5210ffd6a918a78e6">ARM_CAN_CONTROL_RETRANSMISSION</a> </td><td align="left">Enable/disable automatic retransmission; <em>arg</em> : <span class="XML-Token">0 = disable, 1 = enable (default state)</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__mode__ctrls.html#ga398dd25256e644cd8d6506495a06bde8">ARM_CAN_SET_TRANSCEIVER_DELAY</a> </td><td align="left">Set transceiver delay; <em>arg</em> : delay in time quanta </td></tr>
</table>
<p>Verify the CAN interface capabilities with <a class="el" href="group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c">ARM_CAN_GetCapabilities</a>. </p>
</div>
</div>
<a class="anchor" id="ga676d6b567fc4ab3d44f5d7a50ec9419c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__can__interface__gr.html#structARM__CAN__STATUS">ARM_CAN_STATUS</a> ARM_CAN_GetStatus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get CAN status. </p>
<dl class="section return"><dt>Returns</dt><dd>CAN status <a class="el" href="group__can__interface__gr.html#structARM__CAN__STATUS">ARM_CAN_STATUS</a></dd></dl>
<p>The function <b>ARM_CAN_GetStatus</b> retrieves runtime information on CAN bus and CAN unit state.</p>
<p>The following defines give information about the current unit involvement in bus communication:</p>
<table class="doxtable">
<tr>
<th align="left">Unit State </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga911a65cc31304d57d283a21476d9ade7">ARM_CAN_UNIT_STATE_INACTIVE</a> </td><td align="left">Unit state: Not active on the bus. Unit is in initialization state. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga5f72c295ee2b829a8ae33b96466cc0e8">ARM_CAN_UNIT_STATE_ACTIVE</a> </td><td align="left">Unit state: Active on the bus. Unit can generate active error frames. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#gace2db0f930f935054c21242f735e1922">ARM_CAN_UNIT_STATE_PASSIVE</a> </td><td align="left">Unit state: Error passive. Unit is interacting on the bus but does not send active error frames. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#gadd78b515410235cd77d0a10213ff4192">ARM_CAN_UNIT_STATE_BUS_OFF</a> </td><td align="left">Unit state: Bus-off. Unit does not participate on the bus but monitors it and can recover to active state. </td></tr>
</table>
<p>The following defines are error codes of the last error that happened on the bus:</p>
<table class="doxtable">
<tr>
<th align="left">Last Error Code </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga5332a311f44caec256d59087c705e1e9">ARM_CAN_LEC_NO_ERROR</a> </td><td align="left">No error. There was no error since last read of status or last successful transmit or receive. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga0571c3c3e341ac0579aa713fdfdae77e">ARM_CAN_LEC_BIT_ERROR</a> </td><td align="left">Bit error. The bit monitored is different than the bit sent (except during arbitration phase). </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga33cbda311f4c2f2464e4070dee78b2f2">ARM_CAN_LEC_STUFF_ERROR</a> </td><td align="left">Bit stuffing error. There were 6 consecutive same bit levels on the bus. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga1380f80b709ca921634aecdaf34a24e5">ARM_CAN_LEC_CRC_ERROR</a> </td><td align="left">CRC error. CRC of received data is not as expected. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#ga9f753ba50045b28653fb3215ec2e4b8a">ARM_CAN_LEC_FORM_ERROR</a> </td><td align="left">Illegal fixed-form bit. Error in fixed form bits. </td></tr>
<tr>
<td align="left"><a class="el" href="group__can__status__code__ctrls.html#gaae6e827242137bc4d8976cd4ba73015f">ARM_CAN_LEC_ACK_ERROR</a> </td><td align="left">Acknowledgment error. Message was not acknowledged by any receiver on the bus. </td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga38795d1ed135ce3bd87f31ef1596bccf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_CAN_SignalUnitEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal CAN unit event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__CAN__unit__events.html">CAN Unit Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_CAN_SignalUnitEvent</b> is a callback function registered by the function <a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a>.</p>
<p>The parameter <em>event</em> indicates unit event that occurred during driver operation.</p>
<p>The following callback notifications are generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="center">Value </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__unit__events.html#gaa2347c172c8a8f42ac66cb42cd7a08db">ARM_CAN_EVENT_UNIT_INACTIVE</a> </td><td align="center">0 </td><td align="left">Unit entered Inactive state. </td></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__unit__events.html#ga0e65231ccb20684d7c8eac80385f8c18">ARM_CAN_EVENT_UNIT_ACTIVE</a> </td><td align="center">1 </td><td align="left">Unit entered Error Active state. </td></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__unit__events.html#ga3690f864edd2e124f4f9875fdde9a2eb">ARM_CAN_EVENT_UNIT_WARNING</a> </td><td align="center">2 </td><td align="left">Unit entered Error Warning state (one or both error counters >= <span class="XML-Token">96</span>). </td></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__unit__events.html#ga9c529d6697fe21e69639224322f8c4b4">ARM_CAN_EVENT_UNIT_PASSIVE</a> </td><td align="center">3 </td><td align="left">Unit entered Error Passive state. </td></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__unit__events.html#gafa4f992a97b4ca0f079aec2990a69bed">ARM_CAN_EVENT_UNIT_BUS_OFF</a> </td><td align="center">4 </td><td align="left">Unit entered Bus-off state. </td></tr>
</table>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gabfcaeac9e2ca25936ba5a29f2d594e7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_CAN_SignalObjectEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>obj_idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signal CAN object event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_idx</td><td>Object index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__CAN__events.html">CAN Object Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_CAN_SignalObjectEvent</b> is a callback function registered by the function <a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize</a> and signals a CAN message object event.</p>
<p>The parameter <em>obj_idx</em> is the index of the message object. <br/>
The parameter <em>event</em> indicates object event that occurred during driver operation.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="center">Bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503">ARM_CAN_EVENT_SEND_COMPLETE</a> </td><td align="center">0 </td><td align="left">Message was sent successfully by the <em>obj_idx</em> object. </td></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47">ARM_CAN_EVENT_RECEIVE</a> </td><td align="center">1 </td><td align="left">Message was received successfully by the <em>obj_idx</em> object. </td></tr>
<tr>
<td align="left"><a class="el" href="group__CAN__events.html#ga6c2d29b5c49d5cd18e97f5931157a94c">ARM_CAN_EVENT_RECEIVE_OVERRUN</a> </td><td align="center">2 </td><td align="left">Message was overwritten before it was read on the <em>obj_idx</em> object. </td></tr>
</table>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead</a> </dd>
<dd>
<a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr.html | HTML | apache-2.0 | 161,539 |
var group__can__interface__gr =
[
[ "Status Error Codes", "group__can__status__code__ctrls.html", "group__can__status__code__ctrls" ],
[ "CAN Unit Events", "group__CAN__unit__events.html", "group__CAN__unit__events" ],
[ "CAN Object Events", "group__CAN__events.html", "group__CAN__events" ],
[ "CAN Control Codes", "group__can__control.html", "group__can__control" ],
[ "ARM_DRIVER_CAN", "group__can__interface__gr.html#structARM__DRIVER__CAN", [
[ "GetVersion", "group__can__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__can__interface__gr.html#a62c0c62c2bf482c000b1b2a2c817a96f", null ],
[ "Initialize", "group__can__interface__gr.html#a322b44b8e757887616b75035a8fd7027", null ],
[ "Uninitialize", "group__can__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__can__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "GetClock", "group__can__interface__gr.html#a21063f38e762cf29dfd3f5991ee936e2", null ],
[ "SetBitrate", "group__can__interface__gr.html#a360a314665607fc2d866c24e1608fd06", null ],
[ "SetMode", "group__can__interface__gr.html#a0fa2edbde052011604addec816782b4e", null ],
[ "ObjectGetCapabilities", "group__can__interface__gr.html#a7239c03265659edcaf69dc9ea5e29ce3", null ],
[ "ObjectSetFilter", "group__can__interface__gr.html#a2bfa264f66c84606ebf9f9e8dc45b907", null ],
[ "ObjectConfigure", "group__can__interface__gr.html#a24cfe29d7f6a29dfbac3c7011fc5b652", null ],
[ "MessageSend", "group__can__interface__gr.html#a3e6eb8bae2b7f8af99a3ca3cbbacce22", null ],
[ "MessageRead", "group__can__interface__gr.html#ace17a0046cf2c6cdbcb0fd3202e460a0", null ],
[ "Control", "group__can__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__can__interface__gr.html#ad60ff24982cdb3ce38b8c17e0b4f0acc", null ]
] ],
[ "ARM_CAN_CAPABILITIES", "group__can__interface__gr.html#structARM__CAN__CAPABILITIES", [
[ "num_objects", "group__can__interface__gr.html#a69bd1a164443cf6f501489f4d31f4681", null ],
[ "reentrant_operation", "group__can__interface__gr.html#ae0514834750c7452431717a881471e2b", null ],
[ "fd_mode", "group__can__interface__gr.html#a15d22d5906d419ed1a7ca0968be00a04", null ],
[ "restricted_mode", "group__can__interface__gr.html#a93008ac105806db484e78e0582ca118c", null ],
[ "monitor_mode", "group__can__interface__gr.html#a176f42e68d9cba86b3594c40044b86c6", null ],
[ "internal_loopback", "group__can__interface__gr.html#af19cdbb26d3496ed7dd63a59a7c7711f", null ],
[ "external_loopback", "group__can__interface__gr.html#a2b76df7e4bfbdd9866cc906415e626c9", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_CAN_STATUS", "group__can__interface__gr.html#structARM__CAN__STATUS", [
[ "unit_state", "group__can__interface__gr.html#a96ec94acab56690b3801e3c5fbd09fa2", null ],
[ "last_error_code", "group__can__interface__gr.html#a2171ea8dff5e4b54e84728aa134854b6", null ],
[ "tx_error_count", "group__can__interface__gr.html#a8941505f6f3ebd69825c4382184c580f", null ],
[ "rx_error_count", "group__can__interface__gr.html#ab7e8b863b379b786ad1af935aa3ef2e8", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_CAN_MSG_INFO", "group__can__interface__gr.html#structARM__CAN__MSG__INFO", [
[ "id", "group__can__interface__gr.html#abaabdc509cdaba7df9f56c6c76f3ae19", null ],
[ "rtr", "group__can__interface__gr.html#a1f32fc9e5d3b33babf5905140e7a53af", null ],
[ "edl", "group__can__interface__gr.html#ab6883964c9d4bdf60616684e8d2459df", null ],
[ "brs", "group__can__interface__gr.html#a3539c043c5868c59f76c736fe2bcadf4", null ],
[ "esi", "group__can__interface__gr.html#ada78e3124de6adf5a5d212f9ebc4bbe0", null ],
[ "dlc", "group__can__interface__gr.html#a811fbb0cb2c2263b1a7440a7e9d78239", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_CAN_OBJ_CAPABILITIES", "group__can__interface__gr.html#structARM__CAN__OBJ__CAPABILITIES", [
[ "tx", "group__can__interface__gr.html#a9706173b2ed538efeb5ee4a952e2272f", null ],
[ "rx", "group__can__interface__gr.html#a895532773c3204e1538191f155c7bac8", null ],
[ "rx_rtr_tx_data", "group__can__interface__gr.html#a8a41139926d7c032247458d055071fda", null ],
[ "tx_rtr_rx_data", "group__can__interface__gr.html#a1debac19545140bdfe3c5fa8d53f1863", null ],
[ "multiple_filters", "group__can__interface__gr.html#a3662fb9a8fb81212043cadd90da704af", null ],
[ "exact_filtering", "group__can__interface__gr.html#a886337af58da4f995529eba228fb9b7a", null ],
[ "range_filtering", "group__can__interface__gr.html#a96dcf869f4adc9cec686630082c7c60a", null ],
[ "mask_filtering", "group__can__interface__gr.html#a2aa0e772d6cb8c30bb76ce1324423464", null ],
[ "message_depth", "group__can__interface__gr.html#a5a782fc223b0ea5034c6676eaec6f2d4", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_CAN_SignalUnitEvent_t", "group__can__interface__gr.html#gaac07b9fdf614bf439414f5417aaa376e", null ],
[ "ARM_CAN_SignalObjectEvent_t", "group__can__interface__gr.html#ga7ceceac3e9aa0981c5cacfab88efb4eb", null ],
[ "ARM_CAN_GetVersion", "group__can__interface__gr.html#ga4256d5b23ffcb27759a05f8e6b854f13", null ],
[ "ARM_CAN_GetCapabilities", "group__can__interface__gr.html#ga35f21cabe1637b1be964024a8f77721c", null ],
[ "ARM_CAN_Initialize", "group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44", null ],
[ "ARM_CAN_Uninitialize", "group__can__interface__gr.html#ga1e3e364b64f2ab277399e3279cce5ef8", null ],
[ "ARM_CAN_PowerControl", "group__can__interface__gr.html#ga6f634f126ac97daef2f3115aa7bfed7c", null ],
[ "ARM_CAN_GetClock", "group__can__interface__gr.html#ga1fe6cc207415de604975ae251e269361", null ],
[ "ARM_CAN_SetBitrate", "group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a", null ],
[ "ARM_CAN_SetMode", "group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855", null ],
[ "ARM_CAN_ObjectGetCapabilities", "group__can__interface__gr.html#ga45ab314f5121cf5a1b32d9adc600e0f7", null ],
[ "ARM_CAN_ObjectSetFilter", "group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d", null ],
[ "ARM_CAN_ObjectConfigure", "group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630", null ],
[ "ARM_CAN_MessageSend", "group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe", null ],
[ "ARM_CAN_MessageRead", "group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647", null ],
[ "ARM_CAN_Control", "group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4", null ],
[ "ARM_CAN_GetStatus", "group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c", null ],
[ "ARM_CAN_SignalUnitEvent", "group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf", null ],
[ "ARM_CAN_SignalObjectEvent", "group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr.js | JavaScript | apache-2.0 | 7,363 |
var group__can__interface__gr_structARM__CAN__CAPABILITIES =
[
[ "num_objects", "group__can__interface__gr.html#a69bd1a164443cf6f501489f4d31f4681", null ],
[ "reentrant_operation", "group__can__interface__gr.html#ae0514834750c7452431717a881471e2b", null ],
[ "fd_mode", "group__can__interface__gr.html#a15d22d5906d419ed1a7ca0968be00a04", null ],
[ "restricted_mode", "group__can__interface__gr.html#a93008ac105806db484e78e0582ca118c", null ],
[ "monitor_mode", "group__can__interface__gr.html#a176f42e68d9cba86b3594c40044b86c6", null ],
[ "internal_loopback", "group__can__interface__gr.html#af19cdbb26d3496ed7dd63a59a7c7711f", null ],
[ "external_loopback", "group__can__interface__gr.html#a2b76df7e4bfbdd9866cc906415e626c9", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr_structARM__CAN__CAPABILITIES.js | JavaScript | apache-2.0 | 858 |
var group__can__interface__gr_structARM__CAN__MSG__INFO =
[
[ "id", "group__can__interface__gr.html#abaabdc509cdaba7df9f56c6c76f3ae19", null ],
[ "rtr", "group__can__interface__gr.html#a1f32fc9e5d3b33babf5905140e7a53af", null ],
[ "edl", "group__can__interface__gr.html#ab6883964c9d4bdf60616684e8d2459df", null ],
[ "brs", "group__can__interface__gr.html#a3539c043c5868c59f76c736fe2bcadf4", null ],
[ "esi", "group__can__interface__gr.html#ada78e3124de6adf5a5d212f9ebc4bbe0", null ],
[ "dlc", "group__can__interface__gr.html#a811fbb0cb2c2263b1a7440a7e9d78239", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr_structARM__CAN__MSG__INFO.js | JavaScript | apache-2.0 | 688 |
var group__can__interface__gr_structARM__CAN__OBJ__CAPABILITIES =
[
[ "tx", "group__can__interface__gr.html#a9706173b2ed538efeb5ee4a952e2272f", null ],
[ "rx", "group__can__interface__gr.html#a895532773c3204e1538191f155c7bac8", null ],
[ "rx_rtr_tx_data", "group__can__interface__gr.html#a8a41139926d7c032247458d055071fda", null ],
[ "tx_rtr_rx_data", "group__can__interface__gr.html#a1debac19545140bdfe3c5fa8d53f1863", null ],
[ "multiple_filters", "group__can__interface__gr.html#a3662fb9a8fb81212043cadd90da704af", null ],
[ "exact_filtering", "group__can__interface__gr.html#a886337af58da4f995529eba228fb9b7a", null ],
[ "range_filtering", "group__can__interface__gr.html#a96dcf869f4adc9cec686630082c7c60a", null ],
[ "mask_filtering", "group__can__interface__gr.html#a2aa0e772d6cb8c30bb76ce1324423464", null ],
[ "message_depth", "group__can__interface__gr.html#a5a782fc223b0ea5034c6676eaec6f2d4", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr_structARM__CAN__OBJ__CAPABILITIES.js | JavaScript | apache-2.0 | 1,042 |
var group__can__interface__gr_structARM__CAN__STATUS =
[
[ "unit_state", "group__can__interface__gr.html#a96ec94acab56690b3801e3c5fbd09fa2", null ],
[ "last_error_code", "group__can__interface__gr.html#a2171ea8dff5e4b54e84728aa134854b6", null ],
[ "tx_error_count", "group__can__interface__gr.html#a8941505f6f3ebd69825c4382184c580f", null ],
[ "rx_error_count", "group__can__interface__gr.html#ab7e8b863b379b786ad1af935aa3ef2e8", null ],
[ "reserved", "group__can__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr_structARM__CAN__STATUS.js | JavaScript | apache-2.0 | 549 |
var group__can__interface__gr_structARM__DRIVER__CAN =
[
[ "GetVersion", "group__can__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__can__interface__gr.html#a62c0c62c2bf482c000b1b2a2c817a96f", null ],
[ "Initialize", "group__can__interface__gr.html#a322b44b8e757887616b75035a8fd7027", null ],
[ "Uninitialize", "group__can__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__can__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "GetClock", "group__can__interface__gr.html#a21063f38e762cf29dfd3f5991ee936e2", null ],
[ "SetBitrate", "group__can__interface__gr.html#a360a314665607fc2d866c24e1608fd06", null ],
[ "SetMode", "group__can__interface__gr.html#a0fa2edbde052011604addec816782b4e", null ],
[ "ObjectGetCapabilities", "group__can__interface__gr.html#a7239c03265659edcaf69dc9ea5e29ce3", null ],
[ "ObjectSetFilter", "group__can__interface__gr.html#a2bfa264f66c84606ebf9f9e8dc45b907", null ],
[ "ObjectConfigure", "group__can__interface__gr.html#a24cfe29d7f6a29dfbac3c7011fc5b652", null ],
[ "MessageSend", "group__can__interface__gr.html#a3e6eb8bae2b7f8af99a3ca3cbbacce22", null ],
[ "MessageRead", "group__can__interface__gr.html#ace17a0046cf2c6cdbcb0fd3202e460a0", null ],
[ "Control", "group__can__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__can__interface__gr.html#ad60ff24982cdb3ce38b8c17e0b4f0acc", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__interface__gr_structARM__DRIVER__CAN.js | JavaScript | apache-2.0 | 1,521 |
<!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>CAN Operation Codes</title>
<title>CMSIS-Driver: CAN Operation 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__mode__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">CAN Operation Codes<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Set CAN operation modes.
<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:ga978ab3e8860f644dea780e87b3478ff4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#ga978ab3e8860f644dea780e87b3478ff4">ARM_CAN_SET_FD_MODE</a>   (1UL << ARM_CAN_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga978ab3e8860f644dea780e87b3478ff4"><td class="mdescLeft"> </td><td class="mdescRight">Set FD operation mode; arg: 0 = disable, 1 = enable. <a href="#ga978ab3e8860f644dea780e87b3478ff4">More...</a><br/></td></tr>
<tr class="separator:ga978ab3e8860f644dea780e87b3478ff4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae051a548bf785104a934908360529438"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#gae051a548bf785104a934908360529438">ARM_CAN_ABORT_MESSAGE_SEND</a>   (2UL << ARM_CAN_CONTROL_Pos)</td></tr>
<tr class="memdesc:gae051a548bf785104a934908360529438"><td class="mdescLeft"> </td><td class="mdescRight">Abort sending of CAN message; arg = object. <a href="#gae051a548bf785104a934908360529438">More...</a><br/></td></tr>
<tr class="separator:gae051a548bf785104a934908360529438"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0453b8900ca3a0d5210ffd6a918a78e6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#ga0453b8900ca3a0d5210ffd6a918a78e6">ARM_CAN_CONTROL_RETRANSMISSION</a>   (3UL << ARM_CAN_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga0453b8900ca3a0d5210ffd6a918a78e6"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable automatic retransmission; arg: 0 = disable, 1 = enable (default state) <a href="#ga0453b8900ca3a0d5210ffd6a918a78e6">More...</a><br/></td></tr>
<tr class="separator:ga0453b8900ca3a0d5210ffd6a918a78e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga398dd25256e644cd8d6506495a06bde8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#ga398dd25256e644cd8d6506495a06bde8">ARM_CAN_SET_TRANSCEIVER_DELAY</a>   (4UL << ARM_CAN_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga398dd25256e644cd8d6506495a06bde8"><td class="mdescLeft"> </td><td class="mdescRight">Set transceiver delay; arg = delay in time quanta. <a href="#ga398dd25256e644cd8d6506495a06bde8">More...</a><br/></td></tr>
<tr class="separator:ga398dd25256e644cd8d6506495a06bde8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Set CAN operation modes. </p>
<p>These controls set the CAN operation using the function <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga978ab3e8860f644dea780e87b3478ff4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_SET_FD_MODE   (1UL << ARM_CAN_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set FD operation mode; arg: 0 = disable, 1 = enable. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae051a548bf785104a934908360529438"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_ABORT_MESSAGE_SEND   (2UL << ARM_CAN_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort sending of CAN message; arg = object. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0453b8900ca3a0d5210ffd6a918a78e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_CONTROL_RETRANSMISSION   (3UL << ARM_CAN_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/disable automatic retransmission; arg: 0 = disable, 1 = enable (default state) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga398dd25256e644cd8d6506495a06bde8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_SET_TRANSCEIVER_DELAY   (4UL << ARM_CAN_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set transceiver delay; arg = delay in time quanta. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__mode__ctrls.html | HTML | apache-2.0 | 12,046 |
var group__can__mode__ctrls =
[
[ "ARM_CAN_SET_FD_MODE", "group__can__mode__ctrls.html#ga978ab3e8860f644dea780e87b3478ff4", null ],
[ "ARM_CAN_ABORT_MESSAGE_SEND", "group__can__mode__ctrls.html#gae051a548bf785104a934908360529438", null ],
[ "ARM_CAN_CONTROL_RETRANSMISSION", "group__can__mode__ctrls.html#ga0453b8900ca3a0d5210ffd6a918a78e6", null ],
[ "ARM_CAN_SET_TRANSCEIVER_DELAY", "group__can__mode__ctrls.html#ga398dd25256e644cd8d6506495a06bde8", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__mode__ctrls.js | JavaScript | apache-2.0 | 477 |
<!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>CAN Object Configuration Codes</title>
<title>CMSIS-Driver: CAN Object Configuration 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__obj__config__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">CAN Object Configuration Codes<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>CAN Object Configuration codes.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaa9488554de0575bc821c9f65213c4cd0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0">ARM_CAN_OBJ_CONFIG</a> { <br/>
  <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0aebbd0da59658805af30203be66d80249">ARM_CAN_OBJ_INACTIVE</a>,
<br/>
  <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c">ARM_CAN_OBJ_TX</a>,
<br/>
  <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0a14780ac7274831ee94f427cbbf67c003">ARM_CAN_OBJ_RX</a>,
<br/>
  <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c">ARM_CAN_OBJ_RX_RTR_TX_DATA</a>,
<br/>
  <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5">ARM_CAN_OBJ_TX_RTR_RX_DATA</a>
<br/>
}</td></tr>
<tr class="separator:gaa9488554de0575bc821c9f65213c4cd0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>CAN Object Configuration codes. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaa9488554de0575bc821c9f65213c4cd0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0">ARM_CAN_OBJ_CONFIG</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides defined values for the configuration of CAN objects.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure</a> </li>
</ul>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gaa9488554de0575bc821c9f65213c4cd0aebbd0da59658805af30203be66d80249"></a>ARM_CAN_OBJ_INACTIVE</em> </td><td class="fielddoc">
<p>CAN object inactive. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c"></a>ARM_CAN_OBJ_TX</em> </td><td class="fielddoc">
<p>CAN transmit object. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gaa9488554de0575bc821c9f65213c4cd0a14780ac7274831ee94f427cbbf67c003"></a>ARM_CAN_OBJ_RX</em> </td><td class="fielddoc">
<p>CAN receive object. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c"></a>ARM_CAN_OBJ_RX_RTR_TX_DATA</em> </td><td class="fielddoc">
<p>CAN object that on RTR reception automatically transmits Data Frame. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5"></a>ARM_CAN_OBJ_TX_RTR_RX_DATA</em> </td><td class="fielddoc">
<p>CAN object that transmits RTR and automatically receives Data Frame. </p>
</td></tr>
</table>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__obj__config__ctrls.html | HTML | apache-2.0 | 9,979 |
var group__can__obj__config__ctrls =
[
[ "ARM_CAN_OBJ_CONFIG", "group__can__obj__config__ctrls.html#gaa9488554de0575bc821c9f65213c4cd0", [
[ "ARM_CAN_OBJ_INACTIVE", "Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0aebbd0da59658805af30203be66d80249", null ],
[ "ARM_CAN_OBJ_TX", "Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a3e20952f92855298cd0a39a7f47b3f3c", null ],
[ "ARM_CAN_OBJ_RX", "Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a14780ac7274831ee94f427cbbf67c003", null ],
[ "ARM_CAN_OBJ_RX_RTR_TX_DATA", "Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0ac5d28d180ea9e4328974ffcb8b928a0c", null ],
[ "ARM_CAN_OBJ_TX_RTR_RX_DATA", "Driver__CAN_8h.html#gaa9488554de0575bc821c9f65213c4cd0a396d7a6cd2353e1a2936405ace6417f5", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__obj__config__ctrls.js | JavaScript | apache-2.0 | 807 |
<!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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga911a65cc31304d57d283a21476d9ade7">ARM_CAN_UNIT_STATE_INACTIVE</a>   (0U)</td></tr>
<tr class="memdesc:ga911a65cc31304d57d283a21476d9ade7"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga5f72c295ee2b829a8ae33b96466cc0e8">ARM_CAN_UNIT_STATE_ACTIVE</a>   (1U)</td></tr>
<tr class="memdesc:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:gace2db0f930f935054c21242f735e1922"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gace2db0f930f935054c21242f735e1922">ARM_CAN_UNIT_STATE_PASSIVE</a>   (2U)</td></tr>
<tr class="memdesc:gace2db0f930f935054c21242f735e1922"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:gadd78b515410235cd77d0a10213ff4192"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gadd78b515410235cd77d0a10213ff4192">ARM_CAN_UNIT_STATE_BUS_OFF</a>   (3U)</td></tr>
<tr class="memdesc:gadd78b515410235cd77d0a10213ff4192"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:ga5332a311f44caec256d59087c705e1e9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga5332a311f44caec256d59087c705e1e9">ARM_CAN_LEC_NO_ERROR</a>   (0U)</td></tr>
<tr class="memdesc:ga5332a311f44caec256d59087c705e1e9"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga0571c3c3e341ac0579aa713fdfdae77e">ARM_CAN_LEC_BIT_ERROR</a>   (1U)</td></tr>
<tr class="memdesc:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga33cbda311f4c2f2464e4070dee78b2f2">ARM_CAN_LEC_STUFF_ERROR</a>   (2U)</td></tr>
<tr class="memdesc:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:ga1380f80b709ca921634aecdaf34a24e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga1380f80b709ca921634aecdaf34a24e5">ARM_CAN_LEC_CRC_ERROR</a>   (3U)</td></tr>
<tr class="memdesc:ga1380f80b709ca921634aecdaf34a24e5"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga9f753ba50045b28653fb3215ec2e4b8a">ARM_CAN_LEC_FORM_ERROR</a>   (4U)</td></tr>
<tr class="memdesc:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:gaae6e827242137bc4d8976cd4ba73015f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gaae6e827242137bc4d8976cd4ba73015f">ARM_CAN_LEC_ACK_ERROR</a>   (5U)</td></tr>
<tr class="memdesc:gaae6e827242137bc4d8976cd4ba73015f"><td class="mdescLeft"> </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"> </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   (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   (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   (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   (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   (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   (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   (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   (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   (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   (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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__status__code__ctrls.html | HTML | apache-2.0 | 17,040 |
var group__can__status__code__ctrls =
[
[ "ARM_CAN_UNIT_STATE_INACTIVE", "group__can__status__code__ctrls.html#ga911a65cc31304d57d283a21476d9ade7", null ],
[ "ARM_CAN_UNIT_STATE_ACTIVE", "group__can__status__code__ctrls.html#ga5f72c295ee2b829a8ae33b96466cc0e8", null ],
[ "ARM_CAN_UNIT_STATE_PASSIVE", "group__can__status__code__ctrls.html#gace2db0f930f935054c21242f735e1922", null ],
[ "ARM_CAN_UNIT_STATE_BUS_OFF", "group__can__status__code__ctrls.html#gadd78b515410235cd77d0a10213ff4192", null ],
[ "ARM_CAN_LEC_NO_ERROR", "group__can__status__code__ctrls.html#ga5332a311f44caec256d59087c705e1e9", null ],
[ "ARM_CAN_LEC_BIT_ERROR", "group__can__status__code__ctrls.html#ga0571c3c3e341ac0579aa713fdfdae77e", null ],
[ "ARM_CAN_LEC_STUFF_ERROR", "group__can__status__code__ctrls.html#ga33cbda311f4c2f2464e4070dee78b2f2", null ],
[ "ARM_CAN_LEC_CRC_ERROR", "group__can__status__code__ctrls.html#ga1380f80b709ca921634aecdaf34a24e5", null ],
[ "ARM_CAN_LEC_FORM_ERROR", "group__can__status__code__ctrls.html#ga9f753ba50045b28653fb3215ec2e4b8a", null ],
[ "ARM_CAN_LEC_ACK_ERROR", "group__can__status__code__ctrls.html#gaae6e827242137bc4d8976cd4ba73015f", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__status__code__ctrls.js | JavaScript | apache-2.0 | 1,203 |
<!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>CAN Bit Timing Codes</title>
<title>CMSIS-Driver: CAN Bit Timing 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__timeseg__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">CAN Bit Timing Codes<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Set bit timing.
<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:ga01183319a5a899eafea9ffe7af73d5ea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea">ARM_CAN_BIT_PROP_SEG</a>(x)   (((x) << <a class="el" href="Driver__CAN_8h.html#a71e16a70efe5e4b21e5622d2b0cb7889">ARM_CAN_BIT_PROP_SEG_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#a018bef85dc771e75a5d0f017393af01a">ARM_CAN_BIT_PROP_SEG_Msk</a>)</td></tr>
<tr class="separator:ga01183319a5a899eafea9ffe7af73d5ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga03f1921ee97a7ebf5d767b6cacf40792"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792">ARM_CAN_BIT_PHASE_SEG1</a>(x)   (((x) << <a class="el" href="Driver__CAN_8h.html#a23658b0cb98b00c900857aef64926922">ARM_CAN_BIT_PHASE_SEG1_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#a4a661aa69c2825d9118a97695ba39546">ARM_CAN_BIT_PHASE_SEG1_Msk</a>)</td></tr>
<tr class="separator:ga03f1921ee97a7ebf5d767b6cacf40792"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga76de056d56803cb7a0d01978ee981e80"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80">ARM_CAN_BIT_PHASE_SEG2</a>(x)   (((x) << <a class="el" href="Driver__CAN_8h.html#acd52b5921a5ab0ad0b251957a93a5993">ARM_CAN_BIT_PHASE_SEG2_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#ae4df531026a911d53df401a4b9eec89c">ARM_CAN_BIT_PHASE_SEG2_Msk</a>)</td></tr>
<tr class="separator:ga76de056d56803cb7a0d01978ee981e80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab32e97fa4edf497c111dd3f0d8779269"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269">ARM_CAN_BIT_SJW</a>(x)   (((x) << <a class="el" href="Driver__CAN_8h.html#ac233859cfb244895fa47c02d8df02ee8">ARM_CAN_BIT_SJW_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#ac3af13704609a6b14655f00b3d7ac419">ARM_CAN_BIT_SJW_Msk</a>)</td></tr>
<tr class="separator:gab32e97fa4edf497c111dd3f0d8779269"><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:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> { <br/>
  <a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a>,
<br/>
  <a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc">ARM_CAN_BITRATE_FD_DATA</a>
<br/>
}</td></tr>
<tr class="memdesc:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="mdescLeft"> </td><td class="mdescRight">Set the bit rate. <a href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">More...</a><br/></td></tr>
<tr class="separator:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Set bit timing. </p>
<p>The following codes are used with the function <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga01183319a5a899eafea9ffe7af73d5ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_BIT_PROP_SEG</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td>   (((x) << <a class="el" href="Driver__CAN_8h.html#a71e16a70efe5e4b21e5622d2b0cb7889">ARM_CAN_BIT_PROP_SEG_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#a018bef85dc771e75a5d0f017393af01a">ARM_CAN_BIT_PROP_SEG_Msk</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga03f1921ee97a7ebf5d767b6cacf40792"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_BIT_PHASE_SEG1</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td>   (((x) << <a class="el" href="Driver__CAN_8h.html#a23658b0cb98b00c900857aef64926922">ARM_CAN_BIT_PHASE_SEG1_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#a4a661aa69c2825d9118a97695ba39546">ARM_CAN_BIT_PHASE_SEG1_Msk</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga76de056d56803cb7a0d01978ee981e80"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_BIT_PHASE_SEG2</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td>   (((x) << <a class="el" href="Driver__CAN_8h.html#acd52b5921a5ab0ad0b251957a93a5993">ARM_CAN_BIT_PHASE_SEG2_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#ae4df531026a911d53df401a4b9eec89c">ARM_CAN_BIT_PHASE_SEG2_Msk</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab32e97fa4edf497c111dd3f0d8779269"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_CAN_BIT_SJW</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td>   (((x) << <a class="el" href="Driver__CAN_8h.html#ac233859cfb244895fa47c02d8df02ee8">ARM_CAN_BIT_SJW_Pos</a>) & <a class="el" href="Driver__CAN_8h.html#ac3af13704609a6b14655f00b3d7ac419">ARM_CAN_BIT_SJW_Msk</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga11c12020b81a63a73a8b53e96a7e3dea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the bit rate. </p>
<p>Provides the typedef for setting the bit rate.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </li>
</ul>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3"></a>ARM_CAN_BITRATE_NOMINAL</em> </td><td class="fielddoc">
<p>Select nominal (flexible data-rate arbitration) bitrate. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc"></a>ARM_CAN_BITRATE_FD_DATA</em> </td><td class="fielddoc">
<p>Select flexible data-rate data bitrate. </p>
</td></tr>
</table>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__timeseg__ctrls.html | HTML | apache-2.0 | 15,319 |
var group__can__timeseg__ctrls =
[
[ "ARM_CAN_BIT_PROP_SEG", "group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea", null ],
[ "ARM_CAN_BIT_PHASE_SEG1", "group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792", null ],
[ "ARM_CAN_BIT_PHASE_SEG2", "group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80", null ],
[ "ARM_CAN_BIT_SJW", "group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269", null ],
[ "ARM_CAN_BITRATE_SELECT", "group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea", [
[ "ARM_CAN_BITRATE_NOMINAL", "Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3", null ],
[ "ARM_CAN_BITRATE_FD_DATA", "Driver__CAN_8h.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__can__timeseg__ctrls.js | JavaScript | apache-2.0 | 847 |
<!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>Common Driver Definitions</title>
<title>CMSIS-Driver: Common Driver Definitions</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__common__drv__gr.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Common Driver Definitions</div> </div>
</div><!--header-->
<div class="contents">
<p>Definitions common in all driver interfaces (Driver_Common.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__execution__status"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html">Status Error Codes</a></td></tr>
<tr class="memdesc:group__execution__status"><td class="mdescLeft"> </td><td class="mdescRight">Negative return values of functions indicate errors occurred during execution. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:structARM__DRIVER__VERSION"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></td></tr>
<tr class="memdesc:structARM__DRIVER__VERSION"><td class="mdescLeft"> </td><td class="mdescRight">Driver Version. <a href="group__common__drv__gr.html#structARM__DRIVER__VERSION">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__VERSION"><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:ga47d6d7c31f88f3b8ae4aaf9d8444afa5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> { <br/>
  <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>,
<br/>
  <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a>,
<br/>
  <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>
<br/>
}</td></tr>
<tr class="memdesc:ga47d6d7c31f88f3b8ae4aaf9d8444afa5"><td class="mdescLeft"> </td><td class="mdescRight">General power states. <a href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">More...</a><br/></td></tr>
<tr class="separator:ga47d6d7c31f88f3b8ae4aaf9d8444afa5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Definitions common in all driver interfaces (Driver_Common.h) </p>
<p>The following definitions are common in all CMSIS-Driver interfaces. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for a general overview. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__VERSION" id="structARM__DRIVER__VERSION"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_VERSION</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Driver Version. </p>
<p>The access structure of each CMSIS-Driver provides the function <b>GetVersion</b>, which returns in the struct <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION" title="Driver Version. ">ARM_DRIVER_VERSION</a>:</p>
<ul>
<li>API version, which is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version, which is the source code version of the actual driver implementation.</li>
</ul>
<p>The version is encoded as 16-bit unsigned value (uint16_t) with:</p>
<ul>
<li>high-byte: major version.</li>
<li>low-byte: minor version.</li>
</ul>
<p>For example, version 1.12 is encoded as 0x10C. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ad180da20fbde1d3dafc074af87c19540"></a>uint16_t</td>
<td class="fieldname">
api</td>
<td class="fielddoc">
API version. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="adcd153bc4507926c792e86ebe74e6455"></a>uint16_t</td>
<td class="fieldname">
drv</td>
<td class="fielddoc">
Driver version. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>General power states. </p>
<p>The access structure of each CMSIS-Driver provides the function <b>PowerControl</b>, which handles the power profile for a peripheral using the parameter <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>. Depending on this parameter, the peripheral will operate at full speed, detect just events, or is completely un-powered.</p>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35"></a>ARM_POWER_OFF</em> </td><td class="fielddoc">
<p>Power off: no operation possible. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434"></a>ARM_POWER_LOW</em> </td><td class="fielddoc">
<p>Low Power mode: retain state, detect and signal wake-up events. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e"></a>ARM_POWER_FULL</em> </td><td class="fielddoc">
<p>Power on: full operation at maximum performance. </p>
</td></tr>
</table>
</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:30 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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__common__drv__gr.html | HTML | apache-2.0 | 12,762 |
var group__common__drv__gr =
[
[ "Status Error Codes", "group__execution__status.html", "group__execution__status" ],
[ "ARM_DRIVER_VERSION", "group__common__drv__gr.html#structARM__DRIVER__VERSION", [
[ "api", "group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540", null ],
[ "drv", "group__common__drv__gr.html#adcd153bc4507926c792e86ebe74e6455", null ]
] ],
[ "ARM_POWER_STATE", "group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5", [
[ "ARM_POWER_OFF", "Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35", null ],
[ "ARM_POWER_LOW", "Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434", null ],
[ "ARM_POWER_FULL", "Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__common__drv__gr.js | JavaScript | apache-2.0 | 878 |
var group__common__drv__gr_structARM__DRIVER__VERSION =
[
[ "api", "group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540", null ],
[ "drv", "group__common__drv__gr.html#adcd153bc4507926c792e86ebe74e6455", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__common__drv__gr_structARM__DRIVER__VERSION.js | JavaScript | apache-2.0 | 231 |
<!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>Ethernet Interface</title>
<title>CMSIS-Driver: Ethernet Interface</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__interface__gr.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Ethernet Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Ethernet common definitions (Driver_ETH.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__eth__interface__types1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html">Media Interface Types</a></td></tr>
<tr class="memdesc:group__eth__interface__types1"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet Media Interface type. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__interface__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a></td></tr>
<tr class="memdesc:group__eth__mac__interface__gr"><td class="mdescLeft"> </td><td class="mdescRight">Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h) <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__phy__interface__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html">Ethernet PHY Interface</a></td></tr>
<tr class="memdesc:group__eth__phy__interface__gr"><td class="mdescLeft"> </td><td class="mdescRight">Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h) <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:structARM__ETH__LINK__INFO"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a></td></tr>
<tr class="memdesc:structARM__ETH__LINK__INFO"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet link information. <a href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">More...</a><br/></td></tr>
<tr class="separator:structARM__ETH__LINK__INFO"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__ETH__MAC__ADDR"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a></td></tr>
<tr class="memdesc:structARM__ETH__MAC__ADDR"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet MAC Address. <a href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">More...</a><br/></td></tr>
<tr class="separator:structARM__ETH__MAC__ADDR"><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:gacf7db5320eb841b462a4af3c56cc9291"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> { <br/>
  <a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291a5f635c9352db6cb6fa9ad95660850487">ARM_ETH_LINK_DOWN</a>,
<br/>
  <a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291ab5e5b02c3c8a5a0fefcf69f3be7e31c1">ARM_ETH_LINK_UP</a>
<br/>
}</td></tr>
<tr class="memdesc:gacf7db5320eb841b462a4af3c56cc9291"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet link state. <a href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">More...</a><br/></td></tr>
<tr class="separator:gacf7db5320eb841b462a4af3c56cc9291"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Ethernet common definitions (Driver_ETH.h) </p>
<p><b>Ethernet</b> is a networking technology for exchanging data packages between computer systems. Several microcontrollers integrate an Ethernet MAC (Media Access Control) data-link layer that interfaces to an Ethernet PHY (Physical Interface Transceiver).</p>
<p>Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/Ethernet" target="_blank"><b>Ethernet</b></a>.</p>
<p><b>Block Diagram</b></p>
<p>The Ethernet PHY connects typically to the Ethernet MAC using an MII (Media Independent Interface) or RMII (Reduced Media Independent Interface).</p>
<p><br/>
</p>
<div class="image">
<img src="EthernetSchematic.png" alt="EthernetSchematic.png"/>
<div class="caption">
Block Diagram of a typical Ethernet Interface</div></div>
<p><b>Ethernet API</b></p>
<p>The following header files define the Application Programming Interface (API) for the <b>Ethernet</b> interface:</p>
<ul>
<li><b>Driver_ETH.h</b> : Common definitions of the Ethernet PHY and MAC part</li>
<li><b>Driver_ETH_MAC.h</b> : API for the Ethernet MAC</li>
<li><b>Driver_ETH_PHY.h</b> : API for the Ethernet PHY</li>
</ul>
<p>The driver implementation of the Ethernet MAC is a typical part of a Device Family Pack (DFP) that supports the peripherals of the microcontroller family. The driver implementation of the Ethernet PHY is a typical part of a <b>Network</b> Software Pack, since PHY is typically not integrated into the microcontroller.</p>
<dl class="section note"><dt>Note</dt><dd>For parameters, the value marked with (default) is the setting after the driver initialization.</dd></dl>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p>
<ul>
<li><a class="el" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> : access struct for <b>Ethernet MAC</b> driver functions.</li>
<li><a class="el" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> : access struct for <b>Ethernet PHY</b> driver functions.</li>
</ul>
<p>Both drivers are used in combination and usually the Ethernet MAC provides a media interface to the Ethernet PHY. A typical setup sequence for the drivers is shown below:</p>
<p><b>Example Code</b></p>
<p>The following example code shows the usage of the Ethernet interface.</p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> Driver_ETH_MAC0;</div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> Driver_ETH_PHY0;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *phy;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> own_mac_address;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> capabilities;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> ethernet_mac_notify (uint32_t event) {</div>
<div class="line"> <span class="keywordflow">switch</span> (event) {</div>
<div class="line"> :</div>
<div class="line"> } </div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> initialize_ethernet_interface (<span class="keywordtype">void</span>) {</div>
<div class="line"> mac = &Driver_ETH_MAC0;</div>
<div class="line"> phy = &Driver_ETH_PHY0;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize Media Access Controller</span></div>
<div class="line"> capabilities = mac-><a class="code" href="group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1">GetCapabilities</a> ();</div>
<div class="line"> </div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#aa34417c70cb8b43567c59aa530866cc7">Initialize</a> (ethernet_mac_notify);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__eth__mac__interface__gr.html#a7fdea04bacd9c0e12792751055ef6238">mac_address</a> == 0) {</div>
<div class="line"> <span class="comment">// populate own_mac_address with the address to use</span></div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#ac640f929dc4d5bde3e4282c75b25c00d">SetMacAddress</a>(&own_mac_address);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a02837059933cd04b04bf795a7138f218">GetMacAddress</a>(&own_mac_address);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize Physical Media Interface</span></div>
<div class="line"> <span class="keywordflow">if</span> (phy-><a class="code" href="group__eth__phy__interface__gr.html#a9f9e7173bf8fed4d774fa48da53739ba">Initialize</a> (mac-><a class="code" href="group__eth__mac__interface__gr.html#a0f2ddb734e4242077275761400b26e35">PHY_Read</a>, mac-><a class="code" href="group__eth__mac__interface__gr.html#ac3efe9bdc31c3b1d7fd8eb82bbfb4c13">PHY_Write</a>) == <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> phy-><a class="code" href="group__eth__phy__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> phy-><a class="code" href="group__eth__phy__interface__gr.html#a7dfc7cf346c80e7fdb2fe4cea2c61161">SetInterface</a> (capabilities.<a class="code" href="group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d">media_interface</a>);</div>
<div class="line"> phy-><a class="code" href="group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d">SetMode</a> (<a class="code" href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a>);</div>
<div class="line"> }</div>
<div class="line"> :</div>
<div class="line"> :</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> ethernet_link; <span class="comment">// current link status</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> ethernet_check_link_status (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> link;</div>
<div class="line"> </div>
<div class="line"> link = phy-><a class="code" href="group__eth__phy__interface__gr.html#a0e25b2f267edc874f1bd785175fcf08a">GetLinkState</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (link == ethernet_link) { </div>
<div class="line"> <span class="keywordflow">return</span>; <span class="comment">// link state unchanged</span></div>
<div class="line"> }</div>
<div class="line"> <span class="comment">// link state changed</span></div>
<div class="line"> ethernet_link = link; </div>
<div class="line"> <span class="keywordflow">if</span> (link == <a class="code" href="Driver__ETH_8h.html#gacf7db5320eb841b462a4af3c56cc9291ab5e5b02c3c8a5a0fefcf69f3be7e31c1">ARM_ETH_LINK_UP</a>) { <span class="comment">// start transfer</span></div>
<div class="line"> <a class="code" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a> info = phy-><a class="code" href="group__eth__phy__interface__gr.html#ac162bfaf93512fa0966bfbb923c45463">GetLinkInfo</a> ();</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>,</div>
<div class="line"> info.<a class="code" href="group__eth__interface__gr.html#a220859a8b5da0232739a11cbe7f79fc5">speed</a> << <a class="code" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a> |</div>
<div class="line"> info.<a class="code" href="group__eth__interface__gr.html#a44b6cae894d7311dcdae7e93969c3c09">duplex</a> << <a class="code" href="Driver__ETH__MAC_8h.html#a245688f6265e8d017435dc6d2c233b87">ARM_ETH_MAC_DUPLEX_Pos</a> |</div>
<div class="line"> <a class="code" href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a>);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>, 1);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>, 1);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> { <span class="comment">// stop transfer</span></div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a>, <a class="code" href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a> | <a class="code" href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a>);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>, 0);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>, 0);</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__ETH__LINK__INFO" id="structARM__ETH__LINK__INFO"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_ETH_LINK_INFO</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Ethernet link information. </p>
<p>The Ethernet Link information provides parameters about the current established communication.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a220859a8b5da0232739a11cbe7f79fc5"></a>uint32_t</td>
<td class="fieldname">
speed: 2</td>
<td class="fielddoc">
Link speed: 0= 10 MBit, 1= 100 MBit, 2= 1 GBit. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a44b6cae894d7311dcdae7e93969c3c09"></a>uint32_t</td>
<td class="fieldname">
duplex: 1</td>
<td class="fielddoc">
Duplex mode: 0= Half, 1= Full. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 29</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structARM__ETH__MAC__ADDR" id="structARM__ETH__MAC__ADDR"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_ETH_MAC_ADDR</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Ethernet MAC Address. </p>
<p>Stores the MAC Address of the Ethernet interface as defined by IEEE 802. Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/MAC_address" target="_blank"><b>MAC Address</b></a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a>, <a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a>, <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab590318ac859d0e57e15c3dd6c62a605"></a>uint8_t</td>
<td class="fieldname">
b[6]</td>
<td class="fielddoc">
MAC Address (6 bytes), MSB first. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gacf7db5320eb841b462a4af3c56cc9291"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ethernet link state. </p>
<p>The Ethernet Link status shows if the communication is currently established (up) or interrupted (down).</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> </li>
</ul>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gacf7db5320eb841b462a4af3c56cc9291a5f635c9352db6cb6fa9ad95660850487"></a>ARM_ETH_LINK_DOWN</em> </td><td class="fielddoc">
<p>Link is down. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gacf7db5320eb841b462a4af3c56cc9291ab5e5b02c3c8a5a0fefcf69f3be7e31c1"></a>ARM_ETH_LINK_UP</em> </td><td class="fielddoc">
<p>Link is up. </p>
</td></tr>
</table>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__interface__gr.html | HTML | apache-2.0 | 26,332 |
var group__eth__interface__gr =
[
[ "Media Interface Types", "group__eth__interface__types1.html", "group__eth__interface__types1" ],
[ "Ethernet MAC Interface", "group__eth__mac__interface__gr.html", "group__eth__mac__interface__gr" ],
[ "Ethernet PHY Interface", "group__eth__phy__interface__gr.html", "group__eth__phy__interface__gr" ],
[ "ARM_ETH_LINK_INFO", "group__eth__interface__gr.html#structARM__ETH__LINK__INFO", [
[ "speed", "group__eth__interface__gr.html#a220859a8b5da0232739a11cbe7f79fc5", null ],
[ "duplex", "group__eth__interface__gr.html#a44b6cae894d7311dcdae7e93969c3c09", null ],
[ "reserved", "group__eth__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_ETH_MAC_ADDR", "group__eth__interface__gr.html#structARM__ETH__MAC__ADDR", [
[ "b", "group__eth__interface__gr.html#ab590318ac859d0e57e15c3dd6c62a605", null ]
] ],
[ "ARM_ETH_LINK_STATE", "group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291", [
[ "ARM_ETH_LINK_DOWN", "Driver__ETH_8h.html#gacf7db5320eb841b462a4af3c56cc9291a5f635c9352db6cb6fa9ad95660850487", null ],
[ "ARM_ETH_LINK_UP", "Driver__ETH_8h.html#gacf7db5320eb841b462a4af3c56cc9291ab5e5b02c3c8a5a0fefcf69f3be7e31c1", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__interface__gr.js | JavaScript | apache-2.0 | 1,280 |
var group__eth__interface__gr_structARM__ETH__LINK__INFO =
[
[ "speed", "group__eth__interface__gr.html#a220859a8b5da0232739a11cbe7f79fc5", null ],
[ "duplex", "group__eth__interface__gr.html#a44b6cae894d7311dcdae7e93969c3c09", null ],
[ "reserved", "group__eth__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__interface__gr_structARM__ETH__LINK__INFO.js | JavaScript | apache-2.0 | 339 |
var group__eth__interface__gr_structARM__ETH__MAC__ADDR =
[
[ "b", "group__eth__interface__gr.html#ab590318ac859d0e57e15c3dd6c62a605", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__interface__gr_structARM__ETH__MAC__ADDR.js | JavaScript | apache-2.0 | 148 |
<!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>Media Interface Types</title>
<title>CMSIS-Driver: Media Interface Types</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__interface__types1.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Media Interface Types<div class="ingroups"><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Ethernet Media Interface type.
<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:ga468c848ddf75d7925130171af1ec2ac7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html#ga468c848ddf75d7925130171af1ec2ac7">ARM_ETH_INTERFACE_MII</a>   (0)</td></tr>
<tr class="memdesc:ga468c848ddf75d7925130171af1ec2ac7"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet Media Interface type. <a href="#ga468c848ddf75d7925130171af1ec2ac7">More...</a><br/></td></tr>
<tr class="separator:ga468c848ddf75d7925130171af1ec2ac7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac0361b34fbec9c19840ad0349e4c388b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html#gac0361b34fbec9c19840ad0349e4c388b">ARM_ETH_INTERFACE_RMII</a>   (1)</td></tr>
<tr class="memdesc:gac0361b34fbec9c19840ad0349e4c388b"><td class="mdescLeft"> </td><td class="mdescRight">Reduced Media Independent Interface (RMII) <a href="#gac0361b34fbec9c19840ad0349e4c388b">More...</a><br/></td></tr>
<tr class="separator:gac0361b34fbec9c19840ad0349e4c388b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24047d142be48bbc241e8d6eacb5cf7a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a">ARM_ETH_INTERFACE_SMII</a>   (2)</td></tr>
<tr class="memdesc:ga24047d142be48bbc241e8d6eacb5cf7a"><td class="mdescLeft"> </td><td class="mdescRight">Serial Media Independent Interface (SMII) <a href="#ga24047d142be48bbc241e8d6eacb5cf7a">More...</a><br/></td></tr>
<tr class="separator:ga24047d142be48bbc241e8d6eacb5cf7a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Ethernet Media Interface type. </p>
<p>Encodes the supported media interface between Ethernet MAC and Ethernet PHY. The function <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> retrieves the media interface type encoded in the data field <b>media_interface</b> of the struct <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> </li>
</ul>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga468c848ddf75d7925130171af1ec2ac7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_INTERFACE_MII   (0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ethernet Media Interface type. </p>
<p>Media Independent Interface (MII)</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c" title="Set Ethernet Media Interface. ">ARM_ETH_PHY_SetInterface</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac0361b34fbec9c19840ad0349e4c388b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_INTERFACE_RMII   (1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reduced Media Independent Interface (RMII) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c" title="Set Ethernet Media Interface. ">ARM_ETH_PHY_SetInterface</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga24047d142be48bbc241e8d6eacb5cf7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_INTERFACE_SMII   (2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Serial Media Independent Interface (SMII) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c" title="Set Ethernet Media Interface. ">ARM_ETH_PHY_SetInterface</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__interface__types1.html | HTML | apache-2.0 | 11,107 |
var group__eth__interface__types1 =
[
[ "ARM_ETH_INTERFACE_MII", "group__eth__interface__types1.html#ga468c848ddf75d7925130171af1ec2ac7", null ],
[ "ARM_ETH_INTERFACE_RMII", "group__eth__interface__types1.html#gac0361b34fbec9c19840ad0349e4c388b", null ],
[ "ARM_ETH_INTERFACE_SMII", "group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__interface__types1.js | JavaScript | apache-2.0 | 377 |
<!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>Ethernet MAC Configuration</title>
<title>CMSIS-Driver: Ethernet MAC Configuration</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__configuration__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Configuration<div class="ingroups"><a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies speed mode, link mode, checksum, and frame filtering modes.
<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:ga8c5b40d018ecfad05fe2546ba717c1d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga8c5b40d018ecfad05fe2546ba717c1d4">ARM_ETH_MAC_SPEED_10M</a>   (<a class="el" href="Driver__ETH_8h.html#a1f834c4c785d7f69b1eaca011ee298ec">ARM_ETH_SPEED_10M</a> << <a class="el" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a>)</td></tr>
<tr class="memdesc:ga8c5b40d018ecfad05fe2546ba717c1d4"><td class="mdescLeft"> </td><td class="mdescRight">10 Mbps link speed <a href="#ga8c5b40d018ecfad05fe2546ba717c1d4">More...</a><br/></td></tr>
<tr class="separator:ga8c5b40d018ecfad05fe2546ba717c1d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29160c83a7b0952c64053d86789c6490"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a>   (<a class="el" href="Driver__ETH_8h.html#a3bddfc4cf5645f8568d9cb6621fd606a">ARM_ETH_SPEED_100M</a> << <a class="el" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a>)</td></tr>
<tr class="memdesc:ga29160c83a7b0952c64053d86789c6490"><td class="mdescLeft"> </td><td class="mdescRight">100 Mbps link speed <a href="#ga29160c83a7b0952c64053d86789c6490">More...</a><br/></td></tr>
<tr class="separator:ga29160c83a7b0952c64053d86789c6490"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8acefed744d8397a1777b9fd0e6230d2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga8acefed744d8397a1777b9fd0e6230d2">ARM_ETH_MAC_SPEED_1G</a>   (<a class="el" href="Driver__ETH_8h.html#a218f470079b7c04de6776d467a53772a">ARM_ETH_SPEED_1G</a> << <a class="el" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a>)</td></tr>
<tr class="memdesc:ga8acefed744d8397a1777b9fd0e6230d2"><td class="mdescLeft"> </td><td class="mdescRight">1 Gpbs link speed <a href="#ga8acefed744d8397a1777b9fd0e6230d2">More...</a><br/></td></tr>
<tr class="separator:ga8acefed744d8397a1777b9fd0e6230d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb0fe2c5a1e21b0656d39c788ae22f36"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#gadb0fe2c5a1e21b0656d39c788ae22f36">ARM_ETH_MAC_DUPLEX_HALF</a>   (<a class="el" href="Driver__ETH_8h.html#acb15afc2bfe61c56049b7279d6eae8fe">ARM_ETH_DUPLEX_HALF</a> << <a class="el" href="Driver__ETH__MAC_8h.html#a245688f6265e8d017435dc6d2c233b87">ARM_ETH_MAC_DUPLEX_Pos</a>)</td></tr>
<tr class="memdesc:gadb0fe2c5a1e21b0656d39c788ae22f36"><td class="mdescLeft"> </td><td class="mdescRight">Half duplex link. <a href="#gadb0fe2c5a1e21b0656d39c788ae22f36">More...</a><br/></td></tr>
<tr class="separator:gadb0fe2c5a1e21b0656d39c788ae22f36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad5a7d4b5b8a31825eff1504e3828d8f6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a>   (<a class="el" href="Driver__ETH_8h.html#a7848c83cd1fd6b2645c17919c2990354">ARM_ETH_DUPLEX_FULL</a> << <a class="el" href="Driver__ETH__MAC_8h.html#a245688f6265e8d017435dc6d2c233b87">ARM_ETH_MAC_DUPLEX_Pos</a>)</td></tr>
<tr class="memdesc:gad5a7d4b5b8a31825eff1504e3828d8f6"><td class="mdescLeft"> </td><td class="mdescRight">Full duplex link. <a href="#gad5a7d4b5b8a31825eff1504e3828d8f6">More...</a><br/></td></tr>
<tr class="separator:gad5a7d4b5b8a31825eff1504e3828d8f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab32765f35c35b672ee476278fe24a24e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e">ARM_ETH_MAC_LOOPBACK</a>   (1UL << 4)</td></tr>
<tr class="memdesc:gab32765f35c35b672ee476278fe24a24e"><td class="mdescLeft"> </td><td class="mdescRight">Loop-back test mode. <a href="#gab32765f35c35b672ee476278fe24a24e">More...</a><br/></td></tr>
<tr class="separator:gab32765f35c35b672ee476278fe24a24e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga281dfed993b5666ed999709b9f28578f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga281dfed993b5666ed999709b9f28578f">ARM_ETH_MAC_CHECKSUM_OFFLOAD_RX</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga281dfed993b5666ed999709b9f28578f"><td class="mdescLeft"> </td><td class="mdescRight">Receiver Checksum offload. <a href="#ga281dfed993b5666ed999709b9f28578f">More...</a><br/></td></tr>
<tr class="separator:ga281dfed993b5666ed999709b9f28578f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7272d2c55aeeeadbb95c591cbf6c1a2e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga7272d2c55aeeeadbb95c591cbf6c1a2e">ARM_ETH_MAC_CHECKSUM_OFFLOAD_TX</a>   (1UL << 6)</td></tr>
<tr class="memdesc:ga7272d2c55aeeeadbb95c591cbf6c1a2e"><td class="mdescLeft"> </td><td class="mdescRight">Transmitter Checksum offload. <a href="#ga7272d2c55aeeeadbb95c591cbf6c1a2e">More...</a><br/></td></tr>
<tr class="separator:ga7272d2c55aeeeadbb95c591cbf6c1a2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga43792feab641c3c87eafb943351ab0f4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a>   (1UL << 7)</td></tr>
<tr class="memdesc:ga43792feab641c3c87eafb943351ab0f4"><td class="mdescLeft"> </td><td class="mdescRight">Accept frames with Broadcast address. <a href="#ga43792feab641c3c87eafb943351ab0f4">More...</a><br/></td></tr>
<tr class="separator:ga43792feab641c3c87eafb943351ab0f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d3ff8c63362b385548fe91730f20588"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#ga1d3ff8c63362b385548fe91730f20588">ARM_ETH_MAC_ADDRESS_MULTICAST</a>   (1UL << 8)</td></tr>
<tr class="memdesc:ga1d3ff8c63362b385548fe91730f20588"><td class="mdescLeft"> </td><td class="mdescRight">Accept frames with any Multicast address. <a href="#ga1d3ff8c63362b385548fe91730f20588">More...</a><br/></td></tr>
<tr class="separator:ga1d3ff8c63362b385548fe91730f20588"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab29ab9e295807f4c59ddd1c4642086d1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html#gab29ab9e295807f4c59ddd1c4642086d1">ARM_ETH_MAC_ADDRESS_ALL</a>   (1UL << 9)</td></tr>
<tr class="memdesc:gab29ab9e295807f4c59ddd1c4642086d1"><td class="mdescLeft"> </td><td class="mdescRight">Accept frames with any address (Promiscuous Mode) <a href="#gab29ab9e295807f4c59ddd1c4642086d1">More...</a><br/></td></tr>
<tr class="separator:gab29ab9e295807f4c59ddd1c4642086d1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies speed mode, link mode, checksum, and frame filtering modes. </p>
<p>The function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <em>control</em> = <a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a> configures the Ethernet MAC interface as specified with <em>arg</em> listed bellow. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga8c5b40d018ecfad05fe2546ba717c1d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_SPEED_10M   (<a class="el" href="Driver__ETH_8h.html#a1f834c4c785d7f69b1eaca011ee298ec">ARM_ETH_SPEED_10M</a> << <a class="el" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>10 Mbps link speed </p>
</div>
</div>
<a class="anchor" id="ga29160c83a7b0952c64053d86789c6490"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_SPEED_100M   (<a class="el" href="Driver__ETH_8h.html#a3bddfc4cf5645f8568d9cb6621fd606a">ARM_ETH_SPEED_100M</a> << <a class="el" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>100 Mbps link speed </p>
</div>
</div>
<a class="anchor" id="ga8acefed744d8397a1777b9fd0e6230d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_SPEED_1G   (<a class="el" href="Driver__ETH_8h.html#a218f470079b7c04de6776d467a53772a">ARM_ETH_SPEED_1G</a> << <a class="el" href="Driver__ETH__MAC_8h.html#ad7fd5c5f4d4f39a56466c2d34cb699ef">ARM_ETH_MAC_SPEED_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 Gpbs link speed </p>
</div>
</div>
<a class="anchor" id="gadb0fe2c5a1e21b0656d39c788ae22f36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_DUPLEX_HALF   (<a class="el" href="Driver__ETH_8h.html#acb15afc2bfe61c56049b7279d6eae8fe">ARM_ETH_DUPLEX_HALF</a> << <a class="el" href="Driver__ETH__MAC_8h.html#a245688f6265e8d017435dc6d2c233b87">ARM_ETH_MAC_DUPLEX_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Half duplex link. </p>
</div>
</div>
<a class="anchor" id="gad5a7d4b5b8a31825eff1504e3828d8f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_DUPLEX_FULL   (<a class="el" href="Driver__ETH_8h.html#a7848c83cd1fd6b2645c17919c2990354">ARM_ETH_DUPLEX_FULL</a> << <a class="el" href="Driver__ETH__MAC_8h.html#a245688f6265e8d017435dc6d2c233b87">ARM_ETH_MAC_DUPLEX_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Full duplex link. </p>
</div>
</div>
<a class="anchor" id="gab32765f35c35b672ee476278fe24a24e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_LOOPBACK   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Loop-back test mode. </p>
</div>
</div>
<a class="anchor" id="ga281dfed993b5666ed999709b9f28578f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_CHECKSUM_OFFLOAD_RX   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receiver Checksum offload. </p>
</div>
</div>
<a class="anchor" id="ga7272d2c55aeeeadbb95c591cbf6c1a2e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_CHECKSUM_OFFLOAD_TX   (1UL << 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmitter Checksum offload. </p>
</div>
</div>
<a class="anchor" id="ga43792feab641c3c87eafb943351ab0f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_ADDRESS_BROADCAST   (1UL << 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accept frames with Broadcast address. </p>
</div>
</div>
<a class="anchor" id="ga1d3ff8c63362b385548fe91730f20588"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_ADDRESS_MULTICAST   (1UL << 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accept frames with any Multicast address. </p>
</div>
</div>
<a class="anchor" id="gab29ab9e295807f4c59ddd1c4642086d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_ADDRESS_ALL   (1UL << 9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accept frames with any address (Promiscuous Mode) </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__configuration__ctrls.html | HTML | apache-2.0 | 20,494 |
var group__eth__mac__configuration__ctrls =
[
[ "ARM_ETH_MAC_SPEED_10M", "group__eth__mac__configuration__ctrls.html#ga8c5b40d018ecfad05fe2546ba717c1d4", null ],
[ "ARM_ETH_MAC_SPEED_100M", "group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490", null ],
[ "ARM_ETH_MAC_SPEED_1G", "group__eth__mac__configuration__ctrls.html#ga8acefed744d8397a1777b9fd0e6230d2", null ],
[ "ARM_ETH_MAC_DUPLEX_HALF", "group__eth__mac__configuration__ctrls.html#gadb0fe2c5a1e21b0656d39c788ae22f36", null ],
[ "ARM_ETH_MAC_DUPLEX_FULL", "group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6", null ],
[ "ARM_ETH_MAC_LOOPBACK", "group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e", null ],
[ "ARM_ETH_MAC_CHECKSUM_OFFLOAD_RX", "group__eth__mac__configuration__ctrls.html#ga281dfed993b5666ed999709b9f28578f", null ],
[ "ARM_ETH_MAC_CHECKSUM_OFFLOAD_TX", "group__eth__mac__configuration__ctrls.html#ga7272d2c55aeeeadbb95c591cbf6c1a2e", null ],
[ "ARM_ETH_MAC_ADDRESS_BROADCAST", "group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4", null ],
[ "ARM_ETH_MAC_ADDRESS_MULTICAST", "group__eth__mac__configuration__ctrls.html#ga1d3ff8c63362b385548fe91730f20588", null ],
[ "ARM_ETH_MAC_ADDRESS_ALL", "group__eth__mac__configuration__ctrls.html#gab29ab9e295807f4c59ddd1c4642086d1", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__configuration__ctrls.js | JavaScript | apache-2.0 | 1,408 |
<!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>Ethernet MAC Control Codes</title>
<title>CMSIS-Driver: Ethernet MAC Control 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__control.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Control Codes<div class="ingroups"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Configure and control the Ethernet MAC using the <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__eth__mac__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html">Ethernet MAC Controls</a></td></tr>
<tr class="memdesc:group__eth__mac__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Configure and control the Ethernet MAC interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__configuration__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__configuration__ctrls.html">Ethernet MAC Configuration</a></td></tr>
<tr class="memdesc:group__eth__mac__configuration__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specifies speed mode, link mode, checksum, and frame filtering modes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__flush__flag__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__flush__flag__ctrls.html">Ethernet MAC Flush Flags</a></td></tr>
<tr class="memdesc:group__eth__mac__flush__flag__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify controls to flush a buffer. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__vlan__filter__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__vlan__filter__ctrls.html">Ethernet MAC VLAN Filter Flag</a></td></tr>
<tr class="memdesc:group__eth__mac__vlan__filter__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify whether to compare only the VLAN Identifier. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Configure and control the Ethernet MAC using the <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a>. </p>
<p>Many parameters of the Ethernet MAC driver are configured using the <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> function.</p>
<p>The various Ethernet MAC control codes define:</p>
<ul>
<li><a class="el" href="group__eth__mac__ctrls.html">Ethernet MAC Controls</a> configures and controls the Ethernet MAC interface</li>
<li><a class="el" href="group__eth__mac__configuration__ctrls.html">Ethernet MAC Configuration</a> specifies speed mode, link mode, checksum, and frame filtering modes</li>
<li><a class="el" href="group__eth__mac__flush__flag__ctrls.html">Ethernet MAC Flush Flags</a> specify controls to flush a buffer</li>
<li><a class="el" href="group__eth__mac__vlan__filter__ctrls.html">Ethernet MAC VLAN Filter Flag</a> specifies whether to compare only the VLAN Identifier</li>
</ul>
<p>Refer to the <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> function for further details. </p>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__control.html | HTML | apache-2.0 | 10,087 |
var group__eth__mac__control =
[
[ "Ethernet MAC Controls", "group__eth__mac__ctrls.html", "group__eth__mac__ctrls" ],
[ "Ethernet MAC Configuration", "group__eth__mac__configuration__ctrls.html", "group__eth__mac__configuration__ctrls" ],
[ "Ethernet MAC Flush Flags", "group__eth__mac__flush__flag__ctrls.html", "group__eth__mac__flush__flag__ctrls" ],
[ "Ethernet MAC VLAN Filter Flag", "group__eth__mac__vlan__filter__ctrls.html", "group__eth__mac__vlan__filter__ctrls" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__control.js | JavaScript | apache-2.0 | 494 |
<!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>Ethernet MAC Controls</title>
<title>CMSIS-Driver: Ethernet MAC Controls</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Controls<div class="ingroups"><a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Configure and control the Ethernet MAC interface.
<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:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>   (0x01)</td></tr>
<tr class="memdesc:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="mdescLeft"> </td><td class="mdescRight">Configure MAC; arg = configuration. <a href="#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">More...</a><br/></td></tr>
<tr class="separator:ga7819c7a1aa7bbc13dc42d0fd7e75a23c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>   (0x02)</td></tr>
<tr class="memdesc:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="mdescLeft"> </td><td class="mdescRight">Transmitter; arg: 0=disabled (default), 1=enabled. <a href="#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">More...</a><br/></td></tr>
<tr class="separator:ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae0964364b81b38b6e1fbf7196f3be869"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>   (0x03)</td></tr>
<tr class="memdesc:gae0964364b81b38b6e1fbf7196f3be869"><td class="mdescLeft"> </td><td class="mdescRight">Receiver; arg: 0=disabled (default), 1=enabled. <a href="#gae0964364b81b38b6e1fbf7196f3be869">More...</a><br/></td></tr>
<tr class="separator:gae0964364b81b38b6e1fbf7196f3be869"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga530812ef349a2e297f23de72e660fe27"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a>   (0x04)</td></tr>
<tr class="memdesc:ga530812ef349a2e297f23de72e660fe27"><td class="mdescLeft"> </td><td class="mdescRight">Flush buffer; arg = ARM_ETH_MAC_FLUSH_... <a href="#ga530812ef349a2e297f23de72e660fe27">More...</a><br/></td></tr>
<tr class="separator:ga530812ef349a2e297f23de72e660fe27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4afe66589216f566f529af52f9075fdf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf">ARM_ETH_MAC_SLEEP</a>   (0x05)</td></tr>
<tr class="memdesc:ga4afe66589216f566f529af52f9075fdf"><td class="mdescLeft"> </td><td class="mdescRight">Sleep mode; arg: 1=enter and wait for Magic packet, 0=exit. <a href="#ga4afe66589216f566f529af52f9075fdf">More...</a><br/></td></tr>
<tr class="separator:ga4afe66589216f566f529af52f9075fdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab332b58ba320e73864830dc42ad74181"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__ctrls.html#gab332b58ba320e73864830dc42ad74181">ARM_ETH_MAC_VLAN_FILTER</a>   (0x06)</td></tr>
<tr class="memdesc:gab332b58ba320e73864830dc42ad74181"><td class="mdescLeft"> </td><td class="mdescRight">VLAN Filter for received frames; arg15..0: VLAN Tag; arg16: optional ARM_ETH_MAC_VLAN_FILTER_ID_ONLY; 0=disabled (default) <a href="#gab332b58ba320e73864830dc42ad74181">More...</a><br/></td></tr>
<tr class="separator:gab332b58ba320e73864830dc42ad74181"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Configure and control the Ethernet MAC interface. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga7819c7a1aa7bbc13dc42d0fd7e75a23c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_CONFIGURE   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure MAC; arg = configuration. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface. ">ARM_ETH_MAC_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3a98c8a7ee5ed4b1ffd250eecaeefe5c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_CONTROL_TX   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmitter; arg: 0=disabled (default), 1=enabled. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface. ">ARM_ETH_MAC_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae0964364b81b38b6e1fbf7196f3be869"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_CONTROL_RX   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receiver; arg: 0=disabled (default), 1=enabled. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface. ">ARM_ETH_MAC_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga530812ef349a2e297f23de72e660fe27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_FLUSH   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush buffer; arg = ARM_ETH_MAC_FLUSH_... </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface. ">ARM_ETH_MAC_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4afe66589216f566f529af52f9075fdf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_SLEEP   (0x05)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleep mode; arg: 1=enter and wait for Magic packet, 0=exit. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface. ">ARM_ETH_MAC_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab332b58ba320e73864830dc42ad74181"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_VLAN_FILTER   (0x06)</td>
</tr>
</table>
</div><div class="memdoc">
<p>VLAN Filter for received frames; arg15..0: VLAN Tag; arg16: optional ARM_ETH_MAC_VLAN_FILTER_ID_ONLY; 0=disabled (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536" title="Control Ethernet Interface. ">ARM_ETH_MAC_Control</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__ctrls.html | HTML | apache-2.0 | 14,347 |
var group__eth__mac__ctrls =
[
[ "ARM_ETH_MAC_CONFIGURE", "group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c", null ],
[ "ARM_ETH_MAC_CONTROL_TX", "group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c", null ],
[ "ARM_ETH_MAC_CONTROL_RX", "group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869", null ],
[ "ARM_ETH_MAC_FLUSH", "group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27", null ],
[ "ARM_ETH_MAC_SLEEP", "group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf", null ],
[ "ARM_ETH_MAC_VLAN_FILTER", "group__eth__mac__ctrls.html#gab332b58ba320e73864830dc42ad74181", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__ctrls.js | JavaScript | apache-2.0 | 658 |
<!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>Ethernet MAC Flush Flags</title>
<title>CMSIS-Driver: Ethernet MAC Flush Flags</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__flush__flag__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Flush Flags<div class="ingroups"><a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify controls to flush a buffer.
<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:gac18950811038319960756f063e1ef6d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gac18950811038319960756f063e1ef6d4"><td class="mdescLeft"> </td><td class="mdescRight">Flush Receive buffer. <a href="#gac18950811038319960756f063e1ef6d4">More...</a><br/></td></tr>
<tr class="separator:gac18950811038319960756f063e1ef6d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d10ff33f4f4927820c6a17a2262b120"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga2d10ff33f4f4927820c6a17a2262b120"><td class="mdescLeft"> </td><td class="mdescRight">Flush Transmit buffer. <a href="#ga2d10ff33f4f4927820c6a17a2262b120">More...</a><br/></td></tr>
<tr class="separator:ga2d10ff33f4f4927820c6a17a2262b120"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify controls to flush a buffer. </p>
<p>The function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <em>control</em> = <a class="el" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a> flushes the buffer which is specified with <em>arg</em> listed bellow. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gac18950811038319960756f063e1ef6d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_FLUSH_RX   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush Receive buffer. </p>
</div>
</div>
<a class="anchor" id="ga2d10ff33f4f4927820c6a17a2262b120"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_FLUSH_TX   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush Transmit buffer. </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__flush__flag__ctrls.html | HTML | apache-2.0 | 9,165 |
var group__eth__mac__flush__flag__ctrls =
[
[ "ARM_ETH_MAC_FLUSH_RX", "group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4", null ],
[ "ARM_ETH_MAC_FLUSH_TX", "group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__flush__flag__ctrls.js | JavaScript | apache-2.0 | 279 |
<!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>Ethernet MAC Frame Transmit Flags</title>
<title>CMSIS-Driver: Ethernet MAC Frame Transmit Flags</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__frame__transmit__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Frame Transmit Flags<div class="ingroups"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify frame transmit flags.
<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:gab7bd6dea5bb57240291db71e95c99d9c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#gab7bd6dea5bb57240291db71e95c99d9c">ARM_ETH_MAC_TX_FRAME_FRAGMENT</a>   (1UL << 0)</td></tr>
<tr class="memdesc:gab7bd6dea5bb57240291db71e95c99d9c"><td class="mdescLeft"> </td><td class="mdescRight">Indicate frame fragment. <a href="#gab7bd6dea5bb57240291db71e95c99d9c">More...</a><br/></td></tr>
<tr class="separator:gab7bd6dea5bb57240291db71e95c99d9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91a923680ea0dad758b8950a3fbd237e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#ga91a923680ea0dad758b8950a3fbd237e">ARM_ETH_MAC_TX_FRAME_EVENT</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga91a923680ea0dad758b8950a3fbd237e"><td class="mdescLeft"> </td><td class="mdescRight">Generate event when frame is transmitted. <a href="#ga91a923680ea0dad758b8950a3fbd237e">More...</a><br/></td></tr>
<tr class="separator:ga91a923680ea0dad758b8950a3fbd237e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade137f65dd345ae40e93c77d495f9b54"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#gade137f65dd345ae40e93c77d495f9b54">ARM_ETH_MAC_TX_FRAME_TIMESTAMP</a>   (1UL << 2)</td></tr>
<tr class="memdesc:gade137f65dd345ae40e93c77d495f9b54"><td class="mdescLeft"> </td><td class="mdescRight">Capture frame time stamp. <a href="#gade137f65dd345ae40e93c77d495f9b54">More...</a><br/></td></tr>
<tr class="separator:gade137f65dd345ae40e93c77d495f9b54"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify frame transmit flags. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gab7bd6dea5bb57240291db71e95c99d9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TX_FRAME_FRAGMENT   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate frame fragment. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3" title="Send Ethernet frame. ">ARM_ETH_MAC_SendFrame</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga91a923680ea0dad758b8950a3fbd237e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TX_FRAME_EVENT   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate event when frame is transmitted. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3" title="Send Ethernet frame. ">ARM_ETH_MAC_SendFrame</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gade137f65dd345ae40e93c77d495f9b54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TX_FRAME_TIMESTAMP   (1UL << 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Capture frame time stamp. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3" title="Send Ethernet frame. ">ARM_ETH_MAC_SendFrame</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__frame__transmit__ctrls.html | HTML | apache-2.0 | 10,574 |
var group__eth__mac__frame__transmit__ctrls =
[
[ "ARM_ETH_MAC_TX_FRAME_FRAGMENT", "group__eth__mac__frame__transmit__ctrls.html#gab7bd6dea5bb57240291db71e95c99d9c", null ],
[ "ARM_ETH_MAC_TX_FRAME_EVENT", "group__eth__mac__frame__transmit__ctrls.html#ga91a923680ea0dad758b8950a3fbd237e", null ],
[ "ARM_ETH_MAC_TX_FRAME_TIMESTAMP", "group__eth__mac__frame__transmit__ctrls.html#gade137f65dd345ae40e93c77d495f9b54", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__frame__transmit__ctrls.js | JavaScript | apache-2.0 | 437 |
<!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>Ethernet MAC Interface</title>
<title>CMSIS-Driver: Ethernet MAC Interface</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__interface__gr.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Interface<div class="ingroups"><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__ETH__MAC__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ETH__MAC__events.html">Ethernet MAC Events</a></td></tr>
<tr class="memdesc:group__ETH__MAC__events"><td class="mdescLeft"> </td><td class="mdescRight">The Ethernet MAC driver generates call back events that are notified via the function <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></td></tr>
<tr class="memdesc:group__eth__mac__control"><td class="mdescLeft"> </td><td class="mdescRight">Configure and control the Ethernet MAC using the <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__time__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html">Ethernet MAC Timer Control Codes</a></td></tr>
<tr class="memdesc:group__eth__mac__time__control"><td class="mdescLeft"> </td><td class="mdescRight">Control codes for <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__eth__mac__frame__transmit__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html">Ethernet MAC Frame Transmit Flags</a></td></tr>
<tr class="memdesc:group__eth__mac__frame__transmit__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify frame transmit flags. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:structARM__ETH__MAC__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__ETH__MAC__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet MAC Capabilities. <a href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__ETH__MAC__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__DRIVER__ETH__MAC"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a></td></tr>
<tr class="memdesc:structARM__DRIVER__ETH__MAC"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the Ethernet MAC Driver. <a href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__ETH__MAC"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__ETH__MAC__TIME"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a></td></tr>
<tr class="memdesc:structARM__ETH__MAC__TIME"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet MAC Time. <a href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">More...</a><br/></td></tr>
<tr class="separator:structARM__ETH__MAC__TIME"><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:gadfc95cb09c541a29a72da86963668726"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:gadfc95cb09c541a29a72da86963668726"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> : Signal Ethernet Event. <a href="#gadfc95cb09c541a29a72da86963668726">More...</a><br/></td></tr>
<tr class="separator:gadfc95cb09c541a29a72da86963668726"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga86b15062c297384ad5842dd57b9d6b1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d">ARM_ETH_MAC_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga86b15062c297384ad5842dd57b9d6b1d"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga86b15062c297384ad5842dd57b9d6b1d">More...</a><br/></td></tr>
<tr class="separator:ga86b15062c297384ad5842dd57b9d6b1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b13b230502736d8c7679b359dff20d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga2b13b230502736d8c7679b359dff20d0"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga2b13b230502736d8c7679b359dff20d0">More...</a><br/></td></tr>
<tr class="separator:ga2b13b230502736d8c7679b359dff20d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacf42d11b171cd032f0ec1de6db2b6832"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> (<a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:gacf42d11b171cd032f0ec1de6db2b6832"><td class="mdescLeft"> </td><td class="mdescRight">Initialize Ethernet MAC Device. <a href="#gacf42d11b171cd032f0ec1de6db2b6832">More...</a><br/></td></tr>
<tr class="separator:gacf42d11b171cd032f0ec1de6db2b6832"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacb2c2ae06f32328775bffbdeaaabfb5d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d">ARM_ETH_MAC_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gacb2c2ae06f32328775bffbdeaaabfb5d"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize Ethernet MAC Device. <a href="#gacb2c2ae06f32328775bffbdeaaabfb5d">More...</a><br/></td></tr>
<tr class="separator:gacb2c2ae06f32328775bffbdeaaabfb5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga346fef040a0e9bac5762a04a306b1be7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7">ARM_ETH_MAC_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga346fef040a0e9bac5762a04a306b1be7"><td class="mdescLeft"> </td><td class="mdescRight">Control Ethernet MAC Device Power. <a href="#ga346fef040a0e9bac5762a04a306b1be7">More...</a><br/></td></tr>
<tr class="separator:ga346fef040a0e9bac5762a04a306b1be7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66308c1e791952047e974bd653037fae"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a> (<a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
<tr class="memdesc:ga66308c1e791952047e974bd653037fae"><td class="mdescLeft"> </td><td class="mdescRight">Get Ethernet MAC Address. <a href="#ga66308c1e791952047e974bd653037fae">More...</a><br/></td></tr>
<tr class="separator:ga66308c1e791952047e974bd653037fae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7cc3d17c7312c5032202dfd9a915f24a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a> (const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
<tr class="memdesc:ga7cc3d17c7312c5032202dfd9a915f24a"><td class="mdescLeft"> </td><td class="mdescRight">Set Ethernet MAC Address. <a href="#ga7cc3d17c7312c5032202dfd9a915f24a">More...</a><br/></td></tr>
<tr class="separator:ga7cc3d17c7312c5032202dfd9a915f24a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga150fe30290275a4b32756f94208124e8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> (const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr, uint32_t num_addr)</td></tr>
<tr class="memdesc:ga150fe30290275a4b32756f94208124e8"><td class="mdescLeft"> </td><td class="mdescRight">Configure Address Filter. <a href="#ga150fe30290275a4b32756f94208124e8">More...</a><br/></td></tr>
<tr class="separator:ga150fe30290275a4b32756f94208124e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5bf58defdb239ed7dc948f1da147a1c3"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> (const uint8_t *frame, uint32_t len, uint32_t flags)</td></tr>
<tr class="memdesc:ga5bf58defdb239ed7dc948f1da147a1c3"><td class="mdescLeft"> </td><td class="mdescRight">Send Ethernet frame. <a href="#ga5bf58defdb239ed7dc948f1da147a1c3">More...</a><br/></td></tr>
<tr class="separator:ga5bf58defdb239ed7dc948f1da147a1c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b79f57d8624bb4410ee12c73a483993"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> (uint8_t *frame, uint32_t len)</td></tr>
<tr class="memdesc:ga4b79f57d8624bb4410ee12c73a483993"><td class="mdescLeft"> </td><td class="mdescRight">Read data of received Ethernet frame. <a href="#ga4b79f57d8624bb4410ee12c73a483993">More...</a><br/></td></tr>
<tr class="separator:ga4b79f57d8624bb4410ee12c73a483993"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ee86d6b0efab5329b9bc191c23a466d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a> (void)</td></tr>
<tr class="memdesc:ga5ee86d6b0efab5329b9bc191c23a466d"><td class="mdescLeft"> </td><td class="mdescRight">Get size of received Ethernet frame. <a href="#ga5ee86d6b0efab5329b9bc191c23a466d">More...</a><br/></td></tr>
<tr class="separator:ga5ee86d6b0efab5329b9bc191c23a466d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7c6865fb09754be869778142466c5e4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a> (<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
<tr class="memdesc:gaa7c6865fb09754be869778142466c5e4"><td class="mdescLeft"> </td><td class="mdescRight">Get time of received Ethernet frame. <a href="#gaa7c6865fb09754be869778142466c5e4">More...</a><br/></td></tr>
<tr class="separator:gaa7c6865fb09754be869778142466c5e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga115b5c7e149aec2b181de760f5d83f60"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a> (<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
<tr class="memdesc:ga115b5c7e149aec2b181de760f5d83f60"><td class="mdescLeft"> </td><td class="mdescRight">Get time of transmitted Ethernet frame. <a href="#ga115b5c7e149aec2b181de760f5d83f60">More...</a><br/></td></tr>
<tr class="separator:ga115b5c7e149aec2b181de760f5d83f60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac3e90c66058d20077f04ac8e8b8d0536"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> (uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:gac3e90c66058d20077f04ac8e8b8d0536"><td class="mdescLeft"> </td><td class="mdescRight">Control Ethernet Interface. <a href="#gac3e90c66058d20077f04ac8e8b8d0536">More...</a><br/></td></tr>
<tr class="separator:gac3e90c66058d20077f04ac8e8b8d0536"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85d9dc865af3702b71a514b18a588643"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> (uint32_t control, <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
<tr class="memdesc:ga85d9dc865af3702b71a514b18a588643"><td class="mdescLeft"> </td><td class="mdescRight">Control Precision Timer. <a href="#ga85d9dc865af3702b71a514b18a588643">More...</a><br/></td></tr>
<tr class="separator:ga85d9dc865af3702b71a514b18a588643"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaded29ad58366e9222487db9944373c29"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> (uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td></tr>
<tr class="memdesc:gaded29ad58366e9222487db9944373c29"><td class="mdescLeft"> </td><td class="mdescRight">Read Ethernet PHY Register through Management Interface. <a href="#gaded29ad58366e9222487db9944373c29">More...</a><br/></td></tr>
<tr class="separator:gaded29ad58366e9222487db9944373c29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79dd38672749aeebd28f39d9b4f813ce"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> (uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td></tr>
<tr class="memdesc:ga79dd38672749aeebd28f39d9b4f813ce"><td class="mdescLeft"> </td><td class="mdescRight">Write Ethernet PHY Register through Management Interface. <a href="#ga79dd38672749aeebd28f39d9b4f813ce">More...</a><br/></td></tr>
<tr class="separator:ga79dd38672749aeebd28f39d9b4f813ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae0697be4c4229601f3bfc17e2978ada6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:gae0697be4c4229601f3bfc17e2978ada6"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that signals a Ethernet Event. <a href="#gae0697be4c4229601f3bfc17e2978ada6">More...</a><br/></td></tr>
<tr class="separator:gae0697be4c4229601f3bfc17e2978ada6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Ethernet MAC Peripheral (Driver_ETH_MAC.h) </p>
<p>The following section describes the Ethernet MAC Interface as defined in the Driver_ETH_MAC.h header file. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__ETH__MAC__CAPABILITIES" id="structARM__ETH__MAC__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_ETH_MAC_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Ethernet MAC Capabilities. </p>
<p>An Ethernet MAC driver can be implemented with different capabilities. The data fields of this struct encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0051111be2e389c3161da1c444746216"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_rx_ip4: 1</td>
<td class="fielddoc">
1 = IPv4 header checksum verified on receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a674b2306c64901e924b3cb7bb882f32f"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_rx_ip6: 1</td>
<td class="fielddoc">
1 = IPv6 checksum verification supported on receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5a447f05a5fbfd35896aad9cd769511c"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_rx_udp: 1</td>
<td class="fielddoc">
1 = UDP payload checksum verified on receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a730d6be6a7b868e0690d9548e77b7aae"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_rx_tcp: 1</td>
<td class="fielddoc">
1 = TCP payload checksum verified on receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a142179445bfdbaaaf0d451f277fb0e96"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_rx_icmp: 1</td>
<td class="fielddoc">
1 = ICMP payload checksum verified on receive </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac787d70407ce70e28724932fb32ef0ba"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_tx_ip4: 1</td>
<td class="fielddoc">
1 = IPv4 header checksum generated on transmit </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8f7a154565e652d976b9e65bf3516504"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_tx_ip6: 1</td>
<td class="fielddoc">
1 = IPv6 checksum generation supported on transmit </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab3f9560668a087606c40cd81b935396b"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_tx_udp: 1</td>
<td class="fielddoc">
1 = UDP payload checksum generated on transmit </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a6c2b80bbfe520f3e7808cf3d4aaedb45"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_tx_tcp: 1</td>
<td class="fielddoc">
1 = TCP payload checksum generated on transmit </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7b701bac9d66886b5c6964b20c6ca55a"></a>uint32_t</td>
<td class="fieldname">
checksum_offload_tx_icmp: 1</td>
<td class="fielddoc">
1 = ICMP payload checksum generated on transmit </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3c5cb74e086417a01d0079f847a3fc8d"></a>uint32_t</td>
<td class="fieldname">
media_interface: 2</td>
<td class="fielddoc">
Ethernet Media Interface type. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7fdea04bacd9c0e12792751055ef6238"></a>uint32_t</td>
<td class="fieldname">
mac_address: 1</td>
<td class="fielddoc">
1 = driver provides initial valid MAC address </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8c8f1ac2bf053a9bac98c476646a6018"></a>uint32_t</td>
<td class="fieldname">
event_rx_frame: 1</td>
<td class="fielddoc">
1 = callback event <a class="el" href="group__ETH__MAC__events.html#ga76943471a4a3e9e8c1ff9fe83e43bd47">ARM_ETH_MAC_EVENT_RX_FRAME</a> generated </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1b4af3590d59ea4f8e845b4239a4e445"></a>uint32_t</td>
<td class="fieldname">
event_tx_frame: 1</td>
<td class="fielddoc">
1 = callback event <a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a> generated </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7536d9b9818b20b6974a712e0449439b"></a>uint32_t</td>
<td class="fieldname">
event_wakeup: 1</td>
<td class="fielddoc">
1 = wakeup event <a class="el" href="group__ETH__MAC__events.html#ga1f3bdb219afa8f2a121b58cc84f5761c">ARM_ETH_MAC_EVENT_WAKEUP</a> generated </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a881a863974d32f95d7829f768ac47aa2"></a>uint32_t</td>
<td class="fieldname">
precision_timer: 1</td>
<td class="fielddoc">
1 = Precision Timer supported </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 15</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__DRIVER__ETH__MAC" id="structARM__DRIVER__ETH__MAC"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_ETH_MAC</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the Ethernet MAC Driver. </p>
<p>The functions of the Ethernet MAC are accessed by function pointers. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of an Ethernet MAC provides such an access struct. The instance is indicated by a postfix in the symbol name of the access struct, for example:</p>
<ul>
<li><b>Driver_ETH_MAC0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_ETH_MAC1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_ETH_MAC<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d">ARM_ETH_MAC_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fd725bb058c584a9ced9c579561cdf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a9fd725bb058c584a9ced9c579561cdf1"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> : Get driver capabilities. <a href="#a9fd725bb058c584a9ced9c579561cdf1">More...</a><br/></td></tr>
<tr class="separator:a9fd725bb058c584a9ced9c579561cdf1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa34417c70cb8b43567c59aa530866cc7"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#aa34417c70cb8b43567c59aa530866cc7">Initialize</a> )(<a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:aa34417c70cb8b43567c59aa530866cc7"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> : Initialize Ethernet MAC Device. <a href="#aa34417c70cb8b43567c59aa530866cc7">More...</a><br/></td></tr>
<tr class="separator:aa34417c70cb8b43567c59aa530866cc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d">ARM_ETH_MAC_Uninitialize</a> : De-initialize Ethernet MAC Device. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7">ARM_ETH_MAC_PowerControl</a> : Control Ethernet MAC Device Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02837059933cd04b04bf795a7138f218"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a02837059933cd04b04bf795a7138f218">GetMacAddress</a> )(<a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
<tr class="memdesc:a02837059933cd04b04bf795a7138f218"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a> : Get Ethernet MAC Address. <a href="#a02837059933cd04b04bf795a7138f218">More...</a><br/></td></tr>
<tr class="separator:a02837059933cd04b04bf795a7138f218"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac640f929dc4d5bde3e4282c75b25c00d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ac640f929dc4d5bde3e4282c75b25c00d">SetMacAddress</a> )(const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td></tr>
<tr class="memdesc:ac640f929dc4d5bde3e4282c75b25c00d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a> : Set Ethernet MAC Address. <a href="#ac640f929dc4d5bde3e4282c75b25c00d">More...</a><br/></td></tr>
<tr class="separator:ac640f929dc4d5bde3e4282c75b25c00d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45b879a6df608f582d1866daff715798"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a45b879a6df608f582d1866daff715798">SetAddressFilter</a> )(const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr, uint32_t num_addr)</td></tr>
<tr class="memdesc:a45b879a6df608f582d1866daff715798"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> : Configure Address Filter. <a href="#a45b879a6df608f582d1866daff715798">More...</a><br/></td></tr>
<tr class="separator:a45b879a6df608f582d1866daff715798"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac095aea379f23e30a0e51b1f3518ad37"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ac095aea379f23e30a0e51b1f3518ad37">SendFrame</a> )(const uint8_t *frame, uint32_t len, uint32_t flags)</td></tr>
<tr class="memdesc:ac095aea379f23e30a0e51b1f3518ad37"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> : Send Ethernet frame. <a href="#ac095aea379f23e30a0e51b1f3518ad37">More...</a><br/></td></tr>
<tr class="separator:ac095aea379f23e30a0e51b1f3518ad37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a466b724be2167ea7d9a14569062a8fa8"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a466b724be2167ea7d9a14569062a8fa8">ReadFrame</a> )(uint8_t *frame, uint32_t len)</td></tr>
<tr class="memdesc:a466b724be2167ea7d9a14569062a8fa8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> : Read data of received Ethernet frame. <a href="#a466b724be2167ea7d9a14569062a8fa8">More...</a><br/></td></tr>
<tr class="separator:a466b724be2167ea7d9a14569062a8fa8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3286cc9c7624168b162aa3ce3cbe135e"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a3286cc9c7624168b162aa3ce3cbe135e">GetRxFrameSize</a> )(void)</td></tr>
<tr class="memdesc:a3286cc9c7624168b162aa3ce3cbe135e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a> : Get size of received Ethernet frame. <a href="#a3286cc9c7624168b162aa3ce3cbe135e">More...</a><br/></td></tr>
<tr class="separator:a3286cc9c7624168b162aa3ce3cbe135e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ae5a588bf4055bba3de73cfba78f7e8"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a8ae5a588bf4055bba3de73cfba78f7e8">GetRxFrameTime</a> )(<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
<tr class="memdesc:a8ae5a588bf4055bba3de73cfba78f7e8"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a> : Get time of received Ethernet frame. <a href="#a8ae5a588bf4055bba3de73cfba78f7e8">More...</a><br/></td></tr>
<tr class="separator:a8ae5a588bf4055bba3de73cfba78f7e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf081f5020f4ef1435bcff7333a70b93"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#acf081f5020f4ef1435bcff7333a70b93">GetTxFrameTime</a> )(<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
<tr class="memdesc:acf081f5020f4ef1435bcff7333a70b93"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a> : Get time of transmitted Ethernet frame. <a href="#acf081f5020f4ef1435bcff7333a70b93">More...</a><br/></td></tr>
<tr class="separator:acf081f5020f4ef1435bcff7333a70b93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6bdbdc7fdfcc52e027201738b88b431"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ab6bdbdc7fdfcc52e027201738b88b431">ControlTimer</a> )(uint32_t control, <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td></tr>
<tr class="memdesc:ab6bdbdc7fdfcc52e027201738b88b431"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> : Control Precision Timer. <a href="#ab6bdbdc7fdfcc52e027201738b88b431">More...</a><br/></td></tr>
<tr class="separator:ab6bdbdc7fdfcc52e027201738b88b431"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e0f47a92f626a971c5197fca6545505"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:a6e0f47a92f626a971c5197fca6545505"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> : Control Ethernet Interface. <a href="#a6e0f47a92f626a971c5197fca6545505">More...</a><br/></td></tr>
<tr class="separator:a6e0f47a92f626a971c5197fca6545505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f2ddb734e4242077275761400b26e35"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#a0f2ddb734e4242077275761400b26e35">PHY_Read</a> )(uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td></tr>
<tr class="memdesc:a0f2ddb734e4242077275761400b26e35"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register through Management Interface. <a href="#a0f2ddb734e4242077275761400b26e35">More...</a><br/></td></tr>
<tr class="separator:a0f2ddb734e4242077275761400b26e35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3efe9bdc31c3b1d7fd8eb82bbfb4c13"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__interface__gr.html#ac3efe9bdc31c3b1d7fd8eb82bbfb4c13">PHY_Write</a> )(uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td></tr>
<tr class="memdesc:ac3efe9bdc31c3b1d7fd8eb82bbfb4c13"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register through Management Interface. <a href="#ac3efe9bdc31c3b1d7fd8eb82bbfb4c13">More...</a><br/></td></tr>
<tr class="separator:ac3efe9bdc31c3b1d7fd8eb82bbfb4c13"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d">ARM_ETH_MAC_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a9fd725bb058c584a9ced9c579561cdf1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="aa34417c70cb8b43567c59aa530866cc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> : Initialize Ethernet MAC Device. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d">ARM_ETH_MAC_Uninitialize</a> : De-initialize Ethernet MAC Device. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7">ARM_ETH_MAC_PowerControl</a> : Control Ethernet MAC Device Power. </p>
</div>
</div>
<a class="anchor" id="a02837059933cd04b04bf795a7138f218"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetMacAddress)(<a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae">ARM_ETH_MAC_GetMacAddress</a> : Get Ethernet MAC Address. </p>
</div>
</div>
<a class="anchor" id="ac640f929dc4d5bde3e4282c75b25c00d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetMacAddress)(const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a">ARM_ETH_MAC_SetMacAddress</a> : Set Ethernet MAC Address. </p>
</div>
</div>
<a class="anchor" id="a45b879a6df608f582d1866daff715798"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetAddressFilter)(const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> *ptr_addr, uint32_t num_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> : Configure Address Filter. </p>
</div>
</div>
<a class="anchor" id="ac095aea379f23e30a0e51b1f3518ad37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SendFrame)(const uint8_t *frame, uint32_t len, uint32_t flags)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> : Send Ethernet frame. </p>
</div>
</div>
<a class="anchor" id="a466b724be2167ea7d9a14569062a8fa8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadFrame)(uint8_t *frame, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> : Read data of received Ethernet frame. </p>
</div>
</div>
<a class="anchor" id="a3286cc9c7624168b162aa3ce3cbe135e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetRxFrameSize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a> : Get size of received Ethernet frame. </p>
</div>
</div>
<a class="anchor" id="a8ae5a588bf4055bba3de73cfba78f7e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetRxFrameTime)(<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a> : Get time of received Ethernet frame. </p>
</div>
</div>
<a class="anchor" id="acf081f5020f4ef1435bcff7333a70b93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetTxFrameTime)(<a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a> : Get time of transmitted Ethernet frame. </p>
</div>
</div>
<a class="anchor" id="ab6bdbdc7fdfcc52e027201738b88b431"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ControlTimer)(uint32_t control, <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> : Control Precision Timer. </p>
</div>
</div>
<a class="anchor" id="a6e0f47a92f626a971c5197fca6545505"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Control)(uint32_t control, uint32_t arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> : Control Ethernet Interface. </p>
</div>
</div>
<a class="anchor" id="a0f2ddb734e4242077275761400b26e35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PHY_Read)(uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register through Management Interface. </p>
</div>
</div>
<a class="anchor" id="ac3efe9bdc31c3b1d7fd8eb82bbfb4c13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PHY_Write)(uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register through Management Interface. </p>
</div>
</div>
</div>
</div>
<a name="structARM__ETH__MAC__TIME" id="structARM__ETH__MAC__TIME"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_ETH_MAC_TIME</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Ethernet MAC Time. </p>
<p>The two members of this struct provide fields to encode time values in the order <span class="XML-Token">Nano seconds</span> and <span class="XML-Token">seconds</span>.</p>
<p>The member <em>ns</em> is also used as a correction factor for <a class="el" href="group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7">ARM_ETH_MAC_TIMER_ADJUST_CLOCK</a>.</p>
<p><b>Used in:</b></p>
<ul>
<li><a class="el" href="group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4">ARM_ETH_MAC_GetRxFrameTime</a></li>
<li><a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a></li>
<li><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a048317f84621fb38ed0bf8c8255e26f0"></a>uint32_t</td>
<td class="fieldname">
ns</td>
<td class="fielddoc">
Nano seconds. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aaf5f5a3fa5d596a9136b4331f2b54bfc"></a>uint32_t</td>
<td class="fieldname">
sec</td>
<td class="fielddoc">
Seconds. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gadfc95cb09c541a29a72da86963668726"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_ETH_MAC_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> : Signal Ethernet Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga86b15062c297384ad5842dd57b9d6b1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_ETH_MAC_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> Driver_ETH_MAC0;</div>
<div class="line"><a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_ethernet (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> mac = &Driver_ETH_MAC0; </div>
<div class="line"> version = mac-><a class="code" href="group__eth__mac__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga2b13b230502736d8c7679b359dff20d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> ARM_ETH_MAC_GetCapabilities </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_GetCapabilities</b> retrieves information about capabilities in this driver implementation. The data fields of the struct <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> encode various capabilities, for example if a hardware is capable to create checksums in hardware or signal events using the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> Driver_ETH_MAC0;</div>
<div class="line"><a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> mac_capabilities;</div>
<div class="line"> </div>
<div class="line"> mac = &Driver_ETH_MAC0; </div>
<div class="line"> mac_capabilities = mac-><a class="code" href="group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"> </div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gacf42d11b171cd032f0ec1de6db2b6832"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726">ARM_ETH_MAC_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize Ethernet MAC Device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_Initialize</b> initializes the Ethernet MAC interface. It is called when the middleware component starts operation.</p>
<p>The <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a> function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the Ethernet MAC peripheral.</li>
<li>Registers the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gacb2c2ae06f32328775bffbdeaaabfb5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize Ethernet MAC Device. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_Uninitialize</b> de-initializes the resources of Ethernet MAC interface.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
</div>
</div>
<a class="anchor" id="ga346fef040a0e9bac5762a04a306b1be7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Ethernet MAC Device Power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_PowerControl</b> allows you to configure the power modes of the Ethernet MAC interface.</p>
<p>The parameter <em>state</em> can be:</p>
<ul>
<li>ARM_POWER_OFF: Ethernet MAC peripheral is turned off.</li>
<li>ARM_POWER_FULL: Ethernet MAC peripheral is turned on and fully operational.</li>
</ul>
<p>If power <em>state</em> specifies an unsupported mode, the function returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> as status information and the previous power state of the peripheral is unchanged. Multiple calls with the same <em>state</em> generate no error.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="ga66308c1e791952047e974bd653037fae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_GetMacAddress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> * </td>
<td class="paramname"><em>ptr_addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Ethernet MAC Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ptr_addr</td><td>Pointer to address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_GetMacAddress</b> retrieves the Ethernet MAC own address from the driver. </p>
</div>
</div>
<a class="anchor" id="ga7cc3d17c7312c5032202dfd9a915f24a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_SetMacAddress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> * </td>
<td class="paramname"><em>ptr_addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Ethernet MAC Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ptr_addr</td><td>Pointer to address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_SetMacAddress</b> configures Ethernet MAC own address. The Ethernet MAC accepts packets <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frames</b></a> which contains a MAC destination address that matches the address specified with <em>ptr_addr</em>.</p>
<p>The Ethernet MAC receiver will accept also packets with addresses configured by <a class="el" href="group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8">ARM_ETH_MAC_SetAddressFilter</a> function.</p>
<p>MAC receiver can be configured to accept also packets with broadcast address, any multicast address or even all packets regardless of address (Promiscuity Mode). This is configured by function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a> as control parameter. </p>
</div>
</div>
<a class="anchor" id="ga150fe30290275a4b32756f94208124e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_SetAddressFilter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__eth__interface__gr.html#structARM__ETH__MAC__ADDR">ARM_ETH_MAC_ADDR</a> * </td>
<td class="paramname"><em>ptr_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num_addr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure Address Filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ptr_addr</td><td>Pointer to addresses </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num_addr</td><td>Number of addresses to configure </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_SetAddressFilter</b> configures Ethernet MAC receiver address filtering. The Ethernet MAC accepts packets <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frames</b></a> which contains a MAC destination address of the list supplied with <em>ptr_addr</em>. The parameter <em>ptr_addr</em> provides and array of Ethernet MAC addresses. The number of addresses is supplied by <em>num_addr</em>. Specifying <em>num_adr</em> = 0 disables address filtering previously set with this function.</p>
<p>The Ethernet MAC receiver will accept packets addressed to its own address and packets with addresses configured by this function.</p>
<p>MAC receiver can be configured to accept also packets with broadcast address, any multicast address or even all packets regardless of address (Promiscuity Mode). This is configured by function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a> as control parameter. </p>
</div>
</div>
<a class="anchor" id="ga5bf58defdb239ed7dc948f1da147a1c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_SendFrame </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Ethernet frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>Pointer to frame buffer with data to send </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Frame buffer length in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Frame transmit flags (see ARM_ETH_MAC_TX_FRAME_...) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_SendFrame</b> writes an <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a> to the Ethernet MAC transmit buffer.</p>
<p>The Ethernet MAC transmit engine must be enabled by using the function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> (ARM_ETH_MAC_CONTROL_TX, 1) before a call to this function.</p>
<p>The frame data addressed by <em>buf</em> starts with MAC destination and ends with the last Payload data byte. The frame data is copied into the transmit buffer of the Ethernet MAC interface. The function does not wait until the transmission over the Ethernet is complete, however the memory addressed by <em>buf</em> is available for the next Ethernet frame after return.</p>
<p>The maximum value for <em>len</em> is implied by the size restrictions of the Ethernet frame but is not verified. Using an invalid value for <em>len</em> may generate unpredicted results.</p>
<p>The parameter <em>flags</em> specifies additional attributes for the function as shown in the following table. Multiple flags can be combined, for example: ARM_ETH_MAC_TX_FRAME_EVENT | ARM_ETH_MAC_TX_FRAME_TIMESTAMP.</p>
<table class="doxtable">
<tr>
<th align="left">Flag bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#gab7bd6dea5bb57240291db71e95c99d9c">ARM_ETH_MAC_TX_FRAME_FRAGMENT</a> </td><td align="left">Indicates that it is a fragment of the frame. allows you to collect multiple fragments before the frame is sent. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#ga91a923680ea0dad758b8950a3fbd237e">ARM_ETH_MAC_TX_FRAME_EVENT</a> </td><td align="left"><a class="el" href="group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6">ARM_ETH_MAC_SignalEvent</a> with <em>event</em> bit <a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a> set will be called when frame send is complete. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__frame__transmit__ctrls.html#gade137f65dd345ae40e93c77d495f9b54">ARM_ETH_MAC_TX_FRAME_TIMESTAMP</a> </td><td align="left">Capture the time stamp of the frame. The time stamp can be obtained using the function <a class="el" href="group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60">ARM_ETH_MAC_GetTxFrameTime</a>. </td></tr>
</table>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">status = mac-><a class="code" href="group__eth__mac__interface__gr.html#ac095aea379f23e30a0e51b1f3518ad37">SendFrame</a> (&frame->data[0], frame->length, 0);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) {</div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga4b79f57d8624bb4410ee12c73a483993"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_ReadFrame </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data of received Ethernet frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">frame</td><td>Pointer to frame buffer for data to read into </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Frame buffer length in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of data bytes read or execution status<ul>
<li>value >= 0: number of data bytes read</li>
<li>value < 0: error occurred, value is execution status as defined with <a class="el" href="group__execution__status.html">Status Error Codes</a></li>
</ul>
</dd></dl>
<p>The function <b>ARM_ETH_MAC_ReadFrame</b> reads an <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a> from the Ethernet MAC receive buffer.</p>
<p>The Ethernet MAC receive engine must be enabled using the function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> (ARM_ETH_MAC_CONTROL_RX , 1) before a call to this function. The <em>len</em> of the Ethernet frame can be checked using the function <a class="el" href="group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d">ARM_ETH_MAC_GetRxFrameSize</a>.</p>
<p>The frame data addressed by <em>buf</em> starts with MAC destination and ends with the last Payload data byte. The frame data is read from the receive buffer of the Ethernet MAC interface and the number of bytes written into the memory addressed by <em>buf</em> is returned. A negative return value indicates an error whereby the status code is defined with driver common return codes.</p>
<p>The function <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> may be called with <em>buf</em> = NULL and <em>len</em> = 0 to discard or release an frame. This is useful when an incorrect frame has been received or no memory is available to hold the Ethernet frame.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">size = mac-><a class="code" href="group__eth__mac__interface__gr.html#a3286cc9c7624168b162aa3ce3cbe135e">GetRxFrameSize</a> ();</div>
<div class="line"><span class="keywordflow">if</span> ((size < 14) || (size > 1514)) { <span class="comment">// frame excludes CRC</span></div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a466b724be2167ea7d9a14569062a8fa8">ReadFrame</a> (NULL, 0); <span class="comment">// Frame error, release it</span></div>
<div class="line">}</div>
<div class="line">len = mac-><a class="code" href="group__eth__mac__interface__gr.html#a466b724be2167ea7d9a14569062a8fa8">ReadFrame</a> (&frame->data[0], size);</div>
<div class="line"><span class="keywordflow">if</span> (len < 0) {</div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga5ee86d6b0efab5329b9bc191c23a466d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_ETH_MAC_GetRxFrameSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get size of received Ethernet frame. </p>
<dl class="section return"><dt>Returns</dt><dd>number of bytes in received frame</dd></dl>
<p>The function <b>ARM_ETH_MAC_GetRxFrameSize</b> returns the size of a received <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a>. This function is called before <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> and supplies the value <em>len</em>.</p>
<p>The frame size includes MAC destination and ends with the last Payload data byte. Value <em>0</em> indicates that no Ethernet frame is available in the receive buffer. Values smaller than minimum size of Ethernet frame or larger than maximum size of Ethernet frame indicate an invalid frame which needs to be discarded by calling <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a>.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="gaa7c6865fb09754be869778142466c5e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_GetRxFrameTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> * </td>
<td class="paramname"><em>time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get time of received Ethernet frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>Pointer to time structure for data to read into </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>Retrieve time stamp of a received <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a>. This function must be called before the frame is read using <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a>. </p>
</div>
</div>
<a class="anchor" id="ga115b5c7e149aec2b181de760f5d83f60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_GetTxFrameTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> * </td>
<td class="paramname"><em>time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get time of transmitted Ethernet frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>Pointer to time structure for data to read into </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>returns</b> the time stamp of a transmitted <a href="http://en.wikipedia.org/wiki/Ethernet_frame" target="_blank"><b>Ethernet frame</b></a>. </p>
</div>
</div>
<a class="anchor" id="gac3e90c66058d20077f04ac8e8b8d0536"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_Control </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Ethernet Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation (optional) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_Control</b> controls the Ethernet MAC interface and executes various operations. After initialization, the Ethernet transceiver and receiver are disabled.</p>
<p>The parameter <em>control</em> specifies an operation as defined in the table <b>Parameter <em>control</b></em>. <br/>
The parameter <em>arg</em> provides, depending on the operation, additional information or values.</p>
<p>The table lists values for the parameter <em>control</em>.</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>control</em> </th><th align="left">Operation </th></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a> </td><td align="left">Configure the Ethernet MAC interface; For <em>arg</em> values, see table <b>Parameter <em>arg</em> for CONFIGURE</b> </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a> </td><td align="left">Enable or disable the transmitter; <em>arg</em> : <span class="XML-Token">0=disable; 1=enable</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a> </td><td align="left">Enable or disable the receiver; <em>arg</em> : <span class="XML-Token">0=disable; 1=enable</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a> </td><td align="left">Flush a buffer; <em>arg</em> : see table <b>Parameter <em>arg</em> for FLUSH</b> </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf">ARM_ETH_MAC_SLEEP</a> </td><td align="left">Exit/Enter Sleep mode; <em>arg</em> : <span class="XML-Token">0=exit; 1=enter and wait for Magic packet</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__ctrls.html#gab332b58ba320e73864830dc42ad74181">ARM_ETH_MAC_VLAN_FILTER</a> </td><td align="left">Configure VLAN Filter for received frames; <em>arg</em> : See table <b>Parameter <em>arg</em> for VLAN Filter</b> </td></tr>
</table>
<p>The table <b>Parameter <em>arg</em> for CONFIGURE</b> lists the <em>arg</em> values for the <em>control</em> <b>ARM_ETH_MAC_CONFIGURE</b>. The values can be ORed in the following way: </p>
<div class="fragment"><div class="line">mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>, <a class="code" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a> | <a class="code" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a> | <a class="code" href="group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e">ARM_ETH_MAC_LOOPBACK</a>);</div>
</div><!-- fragment --><table class="cmtable">
<tr>
<th colspan="4">Parameter <em>arg</em> CONFIGURE </th></tr>
<tr>
<th>Parameter <em>arg</em> </th><th>Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga8c5b40d018ecfad05fe2546ba717c1d4">ARM_ETH_MAC_SPEED_10M</a> </td><td rowspan="3">0..1 </td><td rowspan="3">Link Speed </td><td>Set the link speed to <span class="XML-Token">10 [Mbps]</span> </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a> </td><td>Set the link speed to <span class="XML-Token">100 [Mbps]</span> </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga8acefed744d8397a1777b9fd0e6230d2">ARM_ETH_MAC_SPEED_1G</a> </td><td>Set the link speed to <span class="XML-Token">1 [Gbps]</span> </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#gadb0fe2c5a1e21b0656d39c788ae22f36">ARM_ETH_MAC_DUPLEX_HALF</a> </td><td rowspan="2">2 </td><td rowspan="2">Link Mode </td><td>Set the link mode to half duplex </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a> </td><td>Set the link mode to full duplex </td></tr>
<tr>
<td>n.a. </td><td>3 </td><td>n.a. </td><td><em>reserved</em> </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#gab32765f35c35b672ee476278fe24a24e">ARM_ETH_MAC_LOOPBACK</a> </td><td>4 </td><td>Loopback Test Mode </td><td>Set the interface into a Loop-back test mode </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga281dfed993b5666ed999709b9f28578f">ARM_ETH_MAC_CHECKSUM_OFFLOAD_RX</a></td><td>5 </td><td>Receiver Checksum offload</td><td>Enable Receiver Checksum offload </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga7272d2c55aeeeadbb95c591cbf6c1a2e">ARM_ETH_MAC_CHECKSUM_OFFLOAD_TX</a></td><td>6 </td><td>Transmitter Checksum offload</td><td>Enable Transmitter Checksum offload </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a> </td><td>7 </td><td>Broadcast Frame address </td><td>Accept frames with Broadcast address </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#ga1d3ff8c63362b385548fe91730f20588">ARM_ETH_MAC_ADDRESS_MULTICAST</a> </td><td>8 </td><td>Multicast Frame address </td><td>Accept frames with any Multicast address </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__configuration__ctrls.html#gab29ab9e295807f4c59ddd1c4642086d1">ARM_ETH_MAC_ADDRESS_ALL</a> </td><td>9 </td><td>Any Frame address </td><td>Accept frames with any address (Promiscuous Mode) </td></tr>
</table>
<p>The table <b>Parameter <em>arg</em> for FLUSH</b> lists the <em>arg</em> values for the <em>control</em> <b>ARM_ETH_MAC_FLUSH</b>. The <em>arg</em> values can be ORed.</p>
<table class="cmtable">
<tr>
<th colspan="4">Parameter <em>arg</em> for FLUSH </th></tr>
<tr>
<th>Parameter <em>arg</em> </th><th>Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a> </td><td>1 </td><td>Receive buffer </td><td>Flush the Receive buffer </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a> </td><td>2 </td><td>Transmit buffer </td><td>Flush the Transmit buffer </td></tr>
</table>
<p>The table <b>Parameter <em>arg</em> for VLAN Filter</b> lists the <em>arg</em> values for the <em>control</em> <b>ARM_ETH_MAC_VLAN_FILTER</b>. The <em>arg</em> values can be ORed.</p>
<table class="cmtable">
<tr>
<th colspan="4">Parameter <em>arg</em> for VLAN Filter </th></tr>
<tr>
<th>Parameter <em>arg</em> </th><th>Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><em>value</em> </td><td>0..15 </td><td>VLAN Tag </td><td>Set VLAN Tag value </td></tr>
<tr>
<td><span class="XML-Token">0</span> </td><td rowspan="2">16 </td><td rowspan="2">Use of VLAN </td><td>Compare the complete 16-bit VLAN Tag value </td></tr>
<tr>
<td><a class="el" href="group__eth__mac__vlan__filter__ctrls.html#ga2511c9e4c22a2b351ce2e454be1c9427">ARM_ETH_MAC_VLAN_FILTER_ID_ONLY</a> </td><td>Compare only the 12-bit VLAN Identifier </td></tr>
<tr>
<td><span class="XML-Token">0</span> </td><td>0..16 </td><td>Disable </td><td>Disable the VLAN Filter </td></tr>
</table>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">...</div>
<div class="line"> <span class="comment">// start transfer</span></div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga7819c7a1aa7bbc13dc42d0fd7e75a23c">ARM_ETH_MAC_CONFIGURE</a>, <a class="code" href="group__eth__mac__configuration__ctrls.html#ga29160c83a7b0952c64053d86789c6490">ARM_ETH_MAC_SPEED_100M</a> | <a class="code" href="group__eth__mac__configuration__ctrls.html#gad5a7d4b5b8a31825eff1504e3828d8f6">ARM_ETH_MAC_DUPLEX_FULL</a> | <a class="code" href="group__eth__mac__configuration__ctrls.html#ga43792feab641c3c87eafb943351ab0f4">ARM_ETH_MAC_ADDRESS_BROADCAST</a>);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>, 1);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>, 1);</div>
<div class="line"> </div>
<div class="line">... <span class="comment">// stop transfer</span></div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga530812ef349a2e297f23de72e660fe27">ARM_ETH_MAC_FLUSH</a>, <a class="code" href="group__eth__mac__flush__flag__ctrls.html#ga2d10ff33f4f4927820c6a17a2262b120">ARM_ETH_MAC_FLUSH_TX</a> | <a class="code" href="group__eth__mac__flush__flag__ctrls.html#gac18950811038319960756f063e1ef6d4">ARM_ETH_MAC_FLUSH_RX</a>);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#ga3a98c8a7ee5ed4b1ffd250eecaeefe5c">ARM_ETH_MAC_CONTROL_TX</a>, 0);</div>
<div class="line"> mac-><a class="code" href="group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__eth__mac__ctrls.html#gae0964364b81b38b6e1fbf7196f3be869">ARM_ETH_MAC_CONTROL_RX</a>, 0);</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --><p>For a complete example, refer to <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions. </p>
</div>
</div>
<a class="anchor" id="ga85d9dc865af3702b71a514b18a588643"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_ControlTimer </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>control</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> * </td>
<td class="paramname"><em>time</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Precision Timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>Pointer to time structure </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_ControlTimer</b> controls the timer required for PTP (Precision Time Protocol).</p>
<p>The parameter <em>control</em> receives <b>ARM_ETH_MAC_TIMER_xxx</b> codes to manage the timer for a PTP enabled Ethernet MAC interface. <br/>
The parameter <em>time</em> is pointer to a structure that holds time information.</p>
<table class="doxtable">
<tr>
<th align="left">Mode Parameters: Timer Controls </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__time__control.html#gad9a439b9727c032a7d851df2a7a622c2">ARM_ETH_MAC_TIMER_GET_TIME</a> </td><td align="left">Retrieve the current time and update the content <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__time__control.html#ga5e867a003c06046d7944bcb5723e6049">ARM_ETH_MAC_TIMER_SET_TIME</a> </td><td align="left">Set the new time using the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__time__control.html#ga3c57b3150717fb1a8cbbbac6a9b7ff69">ARM_ETH_MAC_TIMER_INC_TIME</a> </td><td align="left">Increment the current time by using the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__time__control.html#gaca9f1c4259d0342e9717a362de1ccf41">ARM_ETH_MAC_TIMER_DEC_TIME</a> </td><td align="left">Decrement the current time by using the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74">ARM_ETH_MAC_TIMER_SET_ALARM</a> </td><td align="left">Set the alarm time to the values provided with <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME">ARM_ETH_MAC_TIME</a> *time. </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7">ARM_ETH_MAC_TIMER_ADJUST_CLOCK</a> </td><td align="left">Set the clock frequency; the value in time->ns is the <b>correction factor</b> in fractional format q31. </td></tr>
</table>
</div>
</div>
<a class="anchor" id="gaded29ad58366e9222487db9944373c29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_PHY_Read </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>phy_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>reg_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read Ethernet PHY Register through Management Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">phy_addr</td><td>5-bit device address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>5-bit register address </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer where the result is written to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>Read Ethernet PHY Register through the Management Interface. The function is passed to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a>. The Ethernet PHY driver uses this function to read the value of PHY registers.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="ga79dd38672749aeebd28f39d9b4f813ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_MAC_PHY_Write </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>phy_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>reg_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write Ethernet PHY Register through Management Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">phy_addr</td><td>5-bit device address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg_addr</td><td>5-bit register address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>16-bit data to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_MAC_PHY_Write</b> writes to a Ethernet PHY register through the Management Interface. The function is passed to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a>. The Ethernet PHY driver uses this function to write data to PHY registers.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gae0697be4c4229601f3bfc17e2978ada6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_ETH_MAC_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function that signals a Ethernet Event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>event notification mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_ETH_MAC_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832">ARM_ETH_MAC_Initialize</a>. This function is typically called from interrupt service routines (ISR) to indicate that a frame is processed or a special event occurred.</p>
<p>The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
<p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="center">Bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__ETH__MAC__events.html#ga76943471a4a3e9e8c1ff9fe83e43bd47">ARM_ETH_MAC_EVENT_RX_FRAME</a> </td><td align="center">0 </td><td align="left">Occurs after a frame is received. Frame can be read by calling <a class="el" href="group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993">ARM_ETH_MAC_ReadFrame</a>. </td></tr>
<tr>
<td align="left"><a class="el" href="group__ETH__MAC__events.html#ga0c0328ff7cf886d5fdb53bb84ec03c1b">ARM_ETH_MAC_EVENT_TX_FRAME</a> </td><td align="center">1 </td><td align="left">Occurs after call to <a class="el" href="group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3">ARM_ETH_MAC_SendFrame</a> to indicate that the frame is transmitted. </td></tr>
<tr>
<td align="left"><a class="el" href="group__ETH__MAC__events.html#ga1f3bdb219afa8f2a121b58cc84f5761c">ARM_ETH_MAC_EVENT_WAKEUP</a> </td><td align="center">2 </td><td align="left">Indicates that a Magic Packet is received while the driver is in Sleep mode (set by <a class="el" href="group__eth__mac__ctrls.html#ga4afe66589216f566f529af52f9075fdf">ARM_ETH_MAC_SLEEP</a> using <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a>). </td></tr>
<tr>
<td align="left"><a class="el" href="group__ETH__MAC__events.html#ga4afc71ecac964f195e27be4acdbe7c61">ARM_ETH_MAC_EVENT_TIMER_ALARM</a> </td><td align="center">3 </td><td align="left">Indicates that a Timer Alarm occurred that was set with <a class="el" href="group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74">ARM_ETH_MAC_TIMER_SET_ALARM</a> using ARM_ETH_MAC_ControlTimer. </td></tr>
</table>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__interface__gr.html | HTML | apache-2.0 | 107,461 |
var group__eth__mac__interface__gr =
[
[ "Ethernet MAC Events", "group__ETH__MAC__events.html", "group__ETH__MAC__events" ],
[ "Ethernet MAC Control Codes", "group__eth__mac__control.html", "group__eth__mac__control" ],
[ "Ethernet MAC Timer Control Codes", "group__eth__mac__time__control.html", "group__eth__mac__time__control" ],
[ "Ethernet MAC Frame Transmit Flags", "group__eth__mac__frame__transmit__ctrls.html", "group__eth__mac__frame__transmit__ctrls" ],
[ "ARM_ETH_MAC_CAPABILITIES", "group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES", [
[ "checksum_offload_rx_ip4", "group__eth__mac__interface__gr.html#a0051111be2e389c3161da1c444746216", null ],
[ "checksum_offload_rx_ip6", "group__eth__mac__interface__gr.html#a674b2306c64901e924b3cb7bb882f32f", null ],
[ "checksum_offload_rx_udp", "group__eth__mac__interface__gr.html#a5a447f05a5fbfd35896aad9cd769511c", null ],
[ "checksum_offload_rx_tcp", "group__eth__mac__interface__gr.html#a730d6be6a7b868e0690d9548e77b7aae", null ],
[ "checksum_offload_rx_icmp", "group__eth__mac__interface__gr.html#a142179445bfdbaaaf0d451f277fb0e96", null ],
[ "checksum_offload_tx_ip4", "group__eth__mac__interface__gr.html#ac787d70407ce70e28724932fb32ef0ba", null ],
[ "checksum_offload_tx_ip6", "group__eth__mac__interface__gr.html#a8f7a154565e652d976b9e65bf3516504", null ],
[ "checksum_offload_tx_udp", "group__eth__mac__interface__gr.html#ab3f9560668a087606c40cd81b935396b", null ],
[ "checksum_offload_tx_tcp", "group__eth__mac__interface__gr.html#a6c2b80bbfe520f3e7808cf3d4aaedb45", null ],
[ "checksum_offload_tx_icmp", "group__eth__mac__interface__gr.html#a7b701bac9d66886b5c6964b20c6ca55a", null ],
[ "media_interface", "group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d", null ],
[ "mac_address", "group__eth__mac__interface__gr.html#a7fdea04bacd9c0e12792751055ef6238", null ],
[ "event_rx_frame", "group__eth__mac__interface__gr.html#a8c8f1ac2bf053a9bac98c476646a6018", null ],
[ "event_tx_frame", "group__eth__mac__interface__gr.html#a1b4af3590d59ea4f8e845b4239a4e445", null ],
[ "event_wakeup", "group__eth__mac__interface__gr.html#a7536d9b9818b20b6974a712e0449439b", null ],
[ "precision_timer", "group__eth__mac__interface__gr.html#a881a863974d32f95d7829f768ac47aa2", null ],
[ "reserved", "group__eth__mac__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_DRIVER_ETH_MAC", "group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC", [
[ "GetVersion", "group__eth__mac__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1", null ],
[ "Initialize", "group__eth__mac__interface__gr.html#aa34417c70cb8b43567c59aa530866cc7", null ],
[ "Uninitialize", "group__eth__mac__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__eth__mac__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "GetMacAddress", "group__eth__mac__interface__gr.html#a02837059933cd04b04bf795a7138f218", null ],
[ "SetMacAddress", "group__eth__mac__interface__gr.html#ac640f929dc4d5bde3e4282c75b25c00d", null ],
[ "SetAddressFilter", "group__eth__mac__interface__gr.html#a45b879a6df608f582d1866daff715798", null ],
[ "SendFrame", "group__eth__mac__interface__gr.html#ac095aea379f23e30a0e51b1f3518ad37", null ],
[ "ReadFrame", "group__eth__mac__interface__gr.html#a466b724be2167ea7d9a14569062a8fa8", null ],
[ "GetRxFrameSize", "group__eth__mac__interface__gr.html#a3286cc9c7624168b162aa3ce3cbe135e", null ],
[ "GetRxFrameTime", "group__eth__mac__interface__gr.html#a8ae5a588bf4055bba3de73cfba78f7e8", null ],
[ "GetTxFrameTime", "group__eth__mac__interface__gr.html#acf081f5020f4ef1435bcff7333a70b93", null ],
[ "ControlTimer", "group__eth__mac__interface__gr.html#ab6bdbdc7fdfcc52e027201738b88b431", null ],
[ "Control", "group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "PHY_Read", "group__eth__mac__interface__gr.html#a0f2ddb734e4242077275761400b26e35", null ],
[ "PHY_Write", "group__eth__mac__interface__gr.html#ac3efe9bdc31c3b1d7fd8eb82bbfb4c13", null ]
] ],
[ "ARM_ETH_MAC_TIME", "group__eth__mac__interface__gr.html#structARM__ETH__MAC__TIME", [
[ "ns", "group__eth__mac__interface__gr.html#a048317f84621fb38ed0bf8c8255e26f0", null ],
[ "sec", "group__eth__mac__interface__gr.html#aaf5f5a3fa5d596a9136b4331f2b54bfc", null ]
] ],
[ "ARM_ETH_MAC_SignalEvent_t", "group__eth__mac__interface__gr.html#gadfc95cb09c541a29a72da86963668726", null ],
[ "ARM_ETH_MAC_GetVersion", "group__eth__mac__interface__gr.html#ga86b15062c297384ad5842dd57b9d6b1d", null ],
[ "ARM_ETH_MAC_GetCapabilities", "group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0", null ],
[ "ARM_ETH_MAC_Initialize", "group__eth__mac__interface__gr.html#gacf42d11b171cd032f0ec1de6db2b6832", null ],
[ "ARM_ETH_MAC_Uninitialize", "group__eth__mac__interface__gr.html#gacb2c2ae06f32328775bffbdeaaabfb5d", null ],
[ "ARM_ETH_MAC_PowerControl", "group__eth__mac__interface__gr.html#ga346fef040a0e9bac5762a04a306b1be7", null ],
[ "ARM_ETH_MAC_GetMacAddress", "group__eth__mac__interface__gr.html#ga66308c1e791952047e974bd653037fae", null ],
[ "ARM_ETH_MAC_SetMacAddress", "group__eth__mac__interface__gr.html#ga7cc3d17c7312c5032202dfd9a915f24a", null ],
[ "ARM_ETH_MAC_SetAddressFilter", "group__eth__mac__interface__gr.html#ga150fe30290275a4b32756f94208124e8", null ],
[ "ARM_ETH_MAC_SendFrame", "group__eth__mac__interface__gr.html#ga5bf58defdb239ed7dc948f1da147a1c3", null ],
[ "ARM_ETH_MAC_ReadFrame", "group__eth__mac__interface__gr.html#ga4b79f57d8624bb4410ee12c73a483993", null ],
[ "ARM_ETH_MAC_GetRxFrameSize", "group__eth__mac__interface__gr.html#ga5ee86d6b0efab5329b9bc191c23a466d", null ],
[ "ARM_ETH_MAC_GetRxFrameTime", "group__eth__mac__interface__gr.html#gaa7c6865fb09754be869778142466c5e4", null ],
[ "ARM_ETH_MAC_GetTxFrameTime", "group__eth__mac__interface__gr.html#ga115b5c7e149aec2b181de760f5d83f60", null ],
[ "ARM_ETH_MAC_Control", "group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536", null ],
[ "ARM_ETH_MAC_ControlTimer", "group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643", null ],
[ "ARM_ETH_MAC_PHY_Read", "group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29", null ],
[ "ARM_ETH_MAC_PHY_Write", "group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce", null ],
[ "ARM_ETH_MAC_SignalEvent", "group__eth__mac__interface__gr.html#gae0697be4c4229601f3bfc17e2978ada6", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__interface__gr.js | JavaScript | apache-2.0 | 6,873 |
var group__eth__mac__interface__gr_structARM__DRIVER__ETH__MAC =
[
[ "GetVersion", "group__eth__mac__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1", null ],
[ "Initialize", "group__eth__mac__interface__gr.html#aa34417c70cb8b43567c59aa530866cc7", null ],
[ "Uninitialize", "group__eth__mac__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__eth__mac__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "GetMacAddress", "group__eth__mac__interface__gr.html#a02837059933cd04b04bf795a7138f218", null ],
[ "SetMacAddress", "group__eth__mac__interface__gr.html#ac640f929dc4d5bde3e4282c75b25c00d", null ],
[ "SetAddressFilter", "group__eth__mac__interface__gr.html#a45b879a6df608f582d1866daff715798", null ],
[ "SendFrame", "group__eth__mac__interface__gr.html#ac095aea379f23e30a0e51b1f3518ad37", null ],
[ "ReadFrame", "group__eth__mac__interface__gr.html#a466b724be2167ea7d9a14569062a8fa8", null ],
[ "GetRxFrameSize", "group__eth__mac__interface__gr.html#a3286cc9c7624168b162aa3ce3cbe135e", null ],
[ "GetRxFrameTime", "group__eth__mac__interface__gr.html#a8ae5a588bf4055bba3de73cfba78f7e8", null ],
[ "GetTxFrameTime", "group__eth__mac__interface__gr.html#acf081f5020f4ef1435bcff7333a70b93", null ],
[ "ControlTimer", "group__eth__mac__interface__gr.html#ab6bdbdc7fdfcc52e027201738b88b431", null ],
[ "Control", "group__eth__mac__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "PHY_Read", "group__eth__mac__interface__gr.html#a0f2ddb734e4242077275761400b26e35", null ],
[ "PHY_Write", "group__eth__mac__interface__gr.html#ac3efe9bdc31c3b1d7fd8eb82bbfb4c13", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__interface__gr_structARM__DRIVER__ETH__MAC.js | JavaScript | apache-2.0 | 1,812 |
var group__eth__mac__interface__gr_structARM__ETH__MAC__CAPABILITIES =
[
[ "checksum_offload_rx_ip4", "group__eth__mac__interface__gr.html#a0051111be2e389c3161da1c444746216", null ],
[ "checksum_offload_rx_ip6", "group__eth__mac__interface__gr.html#a674b2306c64901e924b3cb7bb882f32f", null ],
[ "checksum_offload_rx_udp", "group__eth__mac__interface__gr.html#a5a447f05a5fbfd35896aad9cd769511c", null ],
[ "checksum_offload_rx_tcp", "group__eth__mac__interface__gr.html#a730d6be6a7b868e0690d9548e77b7aae", null ],
[ "checksum_offload_rx_icmp", "group__eth__mac__interface__gr.html#a142179445bfdbaaaf0d451f277fb0e96", null ],
[ "checksum_offload_tx_ip4", "group__eth__mac__interface__gr.html#ac787d70407ce70e28724932fb32ef0ba", null ],
[ "checksum_offload_tx_ip6", "group__eth__mac__interface__gr.html#a8f7a154565e652d976b9e65bf3516504", null ],
[ "checksum_offload_tx_udp", "group__eth__mac__interface__gr.html#ab3f9560668a087606c40cd81b935396b", null ],
[ "checksum_offload_tx_tcp", "group__eth__mac__interface__gr.html#a6c2b80bbfe520f3e7808cf3d4aaedb45", null ],
[ "checksum_offload_tx_icmp", "group__eth__mac__interface__gr.html#a7b701bac9d66886b5c6964b20c6ca55a", null ],
[ "media_interface", "group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d", null ],
[ "mac_address", "group__eth__mac__interface__gr.html#a7fdea04bacd9c0e12792751055ef6238", null ],
[ "event_rx_frame", "group__eth__mac__interface__gr.html#a8c8f1ac2bf053a9bac98c476646a6018", null ],
[ "event_tx_frame", "group__eth__mac__interface__gr.html#a1b4af3590d59ea4f8e845b4239a4e445", null ],
[ "event_wakeup", "group__eth__mac__interface__gr.html#a7536d9b9818b20b6974a712e0449439b", null ],
[ "precision_timer", "group__eth__mac__interface__gr.html#a881a863974d32f95d7829f768ac47aa2", null ],
[ "reserved", "group__eth__mac__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__interface__gr_structARM__ETH__MAC__CAPABILITIES.js | JavaScript | apache-2.0 | 1,942 |
var group__eth__mac__interface__gr_structARM__ETH__MAC__TIME =
[
[ "ns", "group__eth__mac__interface__gr.html#a048317f84621fb38ed0bf8c8255e26f0", null ],
[ "sec", "group__eth__mac__interface__gr.html#aaf5f5a3fa5d596a9136b4331f2b54bfc", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__interface__gr_structARM__ETH__MAC__TIME.js | JavaScript | apache-2.0 | 253 |
<!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>Ethernet MAC Timer Control Codes</title>
<title>CMSIS-Driver: Ethernet MAC Timer Control 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__time__control.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC Timer Control Codes<div class="ingroups"><a class="el" href="group__eth__mac__interface__gr.html">Ethernet MAC Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Control codes for <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function.
<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:gad9a439b9727c032a7d851df2a7a622c2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#gad9a439b9727c032a7d851df2a7a622c2">ARM_ETH_MAC_TIMER_GET_TIME</a>   (0x01)</td></tr>
<tr class="memdesc:gad9a439b9727c032a7d851df2a7a622c2"><td class="mdescLeft"> </td><td class="mdescRight">Get current time. <a href="#gad9a439b9727c032a7d851df2a7a622c2">More...</a><br/></td></tr>
<tr class="separator:gad9a439b9727c032a7d851df2a7a622c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5e867a003c06046d7944bcb5723e6049"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga5e867a003c06046d7944bcb5723e6049">ARM_ETH_MAC_TIMER_SET_TIME</a>   (0x02)</td></tr>
<tr class="memdesc:ga5e867a003c06046d7944bcb5723e6049"><td class="mdescLeft"> </td><td class="mdescRight">Set new time. <a href="#ga5e867a003c06046d7944bcb5723e6049">More...</a><br/></td></tr>
<tr class="separator:ga5e867a003c06046d7944bcb5723e6049"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3c57b3150717fb1a8cbbbac6a9b7ff69"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga3c57b3150717fb1a8cbbbac6a9b7ff69">ARM_ETH_MAC_TIMER_INC_TIME</a>   (0x03)</td></tr>
<tr class="memdesc:ga3c57b3150717fb1a8cbbbac6a9b7ff69"><td class="mdescLeft"> </td><td class="mdescRight">Increment current time. <a href="#ga3c57b3150717fb1a8cbbbac6a9b7ff69">More...</a><br/></td></tr>
<tr class="separator:ga3c57b3150717fb1a8cbbbac6a9b7ff69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca9f1c4259d0342e9717a362de1ccf41"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#gaca9f1c4259d0342e9717a362de1ccf41">ARM_ETH_MAC_TIMER_DEC_TIME</a>   (0x04)</td></tr>
<tr class="memdesc:gaca9f1c4259d0342e9717a362de1ccf41"><td class="mdescLeft"> </td><td class="mdescRight">Decrement current time. <a href="#gaca9f1c4259d0342e9717a362de1ccf41">More...</a><br/></td></tr>
<tr class="separator:gaca9f1c4259d0342e9717a362de1ccf41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04c2469ba027b020bc6b5baf3b51cf74"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74">ARM_ETH_MAC_TIMER_SET_ALARM</a>   (0x05)</td></tr>
<tr class="memdesc:ga04c2469ba027b020bc6b5baf3b51cf74"><td class="mdescLeft"> </td><td class="mdescRight">Set alarm time. <a href="#ga04c2469ba027b020bc6b5baf3b51cf74">More...</a><br/></td></tr>
<tr class="separator:ga04c2469ba027b020bc6b5baf3b51cf74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85cb862eba0934e958a8552022588db7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7">ARM_ETH_MAC_TIMER_ADJUST_CLOCK</a>   (0x06)</td></tr>
<tr class="memdesc:ga85cb862eba0934e958a8552022588db7"><td class="mdescLeft"> </td><td class="mdescRight">Adjust clock frequency; time->ns: correction factor * 2^31. <a href="#ga85cb862eba0934e958a8552022588db7">More...</a><br/></td></tr>
<tr class="separator:ga85cb862eba0934e958a8552022588db7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Control codes for <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function. </p>
<p>The following timer controls are used as parameter <em>control</em> for the <a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643">ARM_ETH_MAC_ControlTimer</a> function: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad9a439b9727c032a7d851df2a7a622c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TIMER_GET_TIME   (0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer. ">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5e867a003c06046d7944bcb5723e6049"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TIMER_SET_TIME   (0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set new time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer. ">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3c57b3150717fb1a8cbbbac6a9b7ff69"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TIMER_INC_TIME   (0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Increment current time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer. ">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaca9f1c4259d0342e9717a362de1ccf41"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TIMER_DEC_TIME   (0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrement current time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer. ">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga04c2469ba027b020bc6b5baf3b51cf74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TIMER_SET_ALARM   (0x05)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set alarm time. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer. ">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga85cb862eba0934e958a8552022588db7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_TIMER_ADJUST_CLOCK   (0x06)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adjust clock frequency; time->ns: correction factor * 2^31. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__mac__interface__gr.html#ga85d9dc865af3702b71a514b18a588643" title="Control Precision Timer. ">ARM_ETH_MAC_ControlTimer</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__time__control.html | HTML | apache-2.0 | 14,539 |
var group__eth__mac__time__control =
[
[ "ARM_ETH_MAC_TIMER_GET_TIME", "group__eth__mac__time__control.html#gad9a439b9727c032a7d851df2a7a622c2", null ],
[ "ARM_ETH_MAC_TIMER_SET_TIME", "group__eth__mac__time__control.html#ga5e867a003c06046d7944bcb5723e6049", null ],
[ "ARM_ETH_MAC_TIMER_INC_TIME", "group__eth__mac__time__control.html#ga3c57b3150717fb1a8cbbbac6a9b7ff69", null ],
[ "ARM_ETH_MAC_TIMER_DEC_TIME", "group__eth__mac__time__control.html#gaca9f1c4259d0342e9717a362de1ccf41", null ],
[ "ARM_ETH_MAC_TIMER_SET_ALARM", "group__eth__mac__time__control.html#ga04c2469ba027b020bc6b5baf3b51cf74", null ],
[ "ARM_ETH_MAC_TIMER_ADJUST_CLOCK", "group__eth__mac__time__control.html#ga85cb862eba0934e958a8552022588db7", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__time__control.js | JavaScript | apache-2.0 | 753 |
<!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>Ethernet MAC VLAN Filter Flag</title>
<title>CMSIS-Driver: Ethernet MAC VLAN Filter Flag</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__mac__vlan__filter__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet MAC VLAN Filter Flag<div class="ingroups"><a class="el" href="group__eth__mac__control.html">Ethernet MAC Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify whether to compare only the VLAN Identifier.
<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:ga2511c9e4c22a2b351ce2e454be1c9427"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__mac__vlan__filter__ctrls.html#ga2511c9e4c22a2b351ce2e454be1c9427">ARM_ETH_MAC_VLAN_FILTER_ID_ONLY</a>   (1UL << 16)</td></tr>
<tr class="memdesc:ga2511c9e4c22a2b351ce2e454be1c9427"><td class="mdescLeft"> </td><td class="mdescRight">Compare only the VLAN Identifier (12-bit) <a href="#ga2511c9e4c22a2b351ce2e454be1c9427">More...</a><br/></td></tr>
<tr class="separator:ga2511c9e4c22a2b351ce2e454be1c9427"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify whether to compare only the VLAN Identifier. </p>
<p>The function <a class="el" href="group__eth__mac__interface__gr.html#gac3e90c66058d20077f04ac8e8b8d0536">ARM_ETH_MAC_Control</a> with <em>control</em> = <a class="el" href="group__eth__mac__ctrls.html#gab332b58ba320e73864830dc42ad74181">ARM_ETH_MAC_VLAN_FILTER</a> configures the VLAN Filter for received frames as specified with <em>arg</em>.</p>
<p>By default the complete VLAN Tag (16-bit) is compared. When <a class="el" href="group__eth__mac__vlan__filter__ctrls.html#ga2511c9e4c22a2b351ce2e454be1c9427">ARM_ETH_MAC_VLAN_FILTER_ID_ONLY</a> is specified then only the VLAN Identifier (12-bit) is compared.</p>
<p>Specifying <em>arg=0</em> disables the VLAN Filter. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga2511c9e4c22a2b351ce2e454be1c9427"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_MAC_VLAN_FILTER_ID_ONLY   (1UL << 16)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare only the VLAN Identifier (12-bit) </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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__vlan__filter__ctrls.html | HTML | apache-2.0 | 8,617 |
var group__eth__mac__vlan__filter__ctrls =
[
[ "ARM_ETH_MAC_VLAN_FILTER_ID_ONLY", "group__eth__mac__vlan__filter__ctrls.html#ga2511c9e4c22a2b351ce2e454be1c9427", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__mac__vlan__filter__ctrls.js | JavaScript | apache-2.0 | 175 |
<!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>Ethernet PHY Interface</title>
<title>CMSIS-Driver: Ethernet PHY Interface</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__phy__interface__gr.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#groups">Content</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Ethernet PHY Interface<div class="ingroups"><a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Content</h2></td></tr>
<tr class="memitem:group__eth__phy__mode__ctrls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html">Ethernet PHY Mode</a></td></tr>
<tr class="memdesc:group__eth__phy__mode__ctrls"><td class="mdescLeft"> </td><td class="mdescRight">Specify operation modes of the Ethernet PHY interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:structARM__DRIVER__ETH__PHY"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a></td></tr>
<tr class="memdesc:structARM__DRIVER__ETH__PHY"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the Ethernet PHY Driver. <a href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__ETH__PHY"><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:ga987d5dd36f179192721c03df37d93e87"><td class="memItemLeft" align="right" valign="top">typedef int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> )(uint8_t phy_addr, uint8_t reg_addr, uint16_t *data)</td></tr>
<tr class="memdesc:ga987d5dd36f179192721c03df37d93e87"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register. <a href="#ga987d5dd36f179192721c03df37d93e87">More...</a><br/></td></tr>
<tr class="separator:ga987d5dd36f179192721c03df37d93e87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf690fde16281b25f2ffa07f9c4e8e240"><td class="memItemLeft" align="right" valign="top">typedef int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> )(uint8_t phy_addr, uint8_t reg_addr, uint16_t data)</td></tr>
<tr class="memdesc:gaf690fde16281b25f2ffa07f9c4e8e240"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register. <a href="#gaf690fde16281b25f2ffa07f9c4e8e240">More...</a><br/></td></tr>
<tr class="separator:gaf690fde16281b25f2ffa07f9c4e8e240"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6850d33d699d9deee4e983a2c99e9734"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734">ARM_ETH_PHY_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga6850d33d699d9deee4e983a2c99e9734"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga6850d33d699d9deee4e983a2c99e9734">More...</a><br/></td></tr>
<tr class="separator:ga6850d33d699d9deee4e983a2c99e9734"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacf2332a7fa2d84694b8e5f0838135589"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> (<a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> fn_read, <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> fn_write)</td></tr>
<tr class="memdesc:gacf2332a7fa2d84694b8e5f0838135589"><td class="mdescLeft"> </td><td class="mdescRight">Initialize Ethernet PHY Device. <a href="#gacf2332a7fa2d84694b8e5f0838135589">More...</a><br/></td></tr>
<tr class="separator:gacf2332a7fa2d84694b8e5f0838135589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga26ea7e1e9825b959284241ebff6eea3f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f">ARM_ETH_PHY_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:ga26ea7e1e9825b959284241ebff6eea3f"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize Ethernet PHY Device. <a href="#ga26ea7e1e9825b959284241ebff6eea3f">More...</a><br/></td></tr>
<tr class="separator:ga26ea7e1e9825b959284241ebff6eea3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba0f92561754dad8f8f03feb1cf2855e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e">ARM_ETH_PHY_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:gaba0f92561754dad8f8f03feb1cf2855e"><td class="mdescLeft"> </td><td class="mdescRight">Control Ethernet PHY Device Power. <a href="#gaba0f92561754dad8f8f03feb1cf2855e">More...</a><br/></td></tr>
<tr class="separator:gaba0f92561754dad8f8f03feb1cf2855e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaedd8b5650a1259d572a1f303d3e2c01c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> (uint32_t interface)</td></tr>
<tr class="memdesc:gaedd8b5650a1259d572a1f303d3e2c01c"><td class="mdescLeft"> </td><td class="mdescRight">Set Ethernet Media Interface. <a href="#gaedd8b5650a1259d572a1f303d3e2c01c">More...</a><br/></td></tr>
<tr class="separator:gaedd8b5650a1259d572a1f303d3e2c01c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9aa688c951f01ed9ca7c88cf51be8a09"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09">ARM_ETH_PHY_SetMode</a> (uint32_t mode)</td></tr>
<tr class="memdesc:ga9aa688c951f01ed9ca7c88cf51be8a09"><td class="mdescLeft"> </td><td class="mdescRight">Set Ethernet PHY Device Operation mode. <a href="#ga9aa688c951f01ed9ca7c88cf51be8a09">More...</a><br/></td></tr>
<tr class="separator:ga9aa688c951f01ed9ca7c88cf51be8a09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4085cd24ebe33b78d51a3c003da4a5ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> (void)</td></tr>
<tr class="memdesc:ga4085cd24ebe33b78d51a3c003da4a5ba"><td class="mdescLeft"> </td><td class="mdescRight">Get Ethernet PHY Device Link state. <a href="#ga4085cd24ebe33b78d51a3c003da4a5ba">More...</a><br/></td></tr>
<tr class="separator:ga4085cd24ebe33b78d51a3c003da4a5ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8c79dcd7a12656403f3befab3c8605a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> (void)</td></tr>
<tr class="memdesc:ga8c79dcd7a12656403f3befab3c8605a2"><td class="mdescLeft"> </td><td class="mdescRight">Get Ethernet PHY Device Link information. <a href="#ga8c79dcd7a12656403f3befab3c8605a2">More...</a><br/></td></tr>
<tr class="separator:ga8c79dcd7a12656403f3befab3c8605a2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Ethernet PHY Peripheral (Driver_ETH_PHY.h) </p>
<p>The following section describes the Ethernet PHY Interface as defined in the Driver_ETH_PHY.h header file.</p>
<p>The Driver_ETH_PHY.h contains two #defines that are used to configure the connection between the PHY and the microcontroller device:</p>
<ul>
<li><code>ETH_PHY_NUM</code> and</li>
<li><code>ETH_PHY_ADDR</code> </li>
</ul>
<p>Usually, the Serial Management Interface (<b>SMI</b>) (using MDC and MDIO) is used to access the PHY’s internal registers to read the state of the link (up/down), duplex mode, speed, and to restart auto-negotiation etc. SMI is a serial bus, which allows to connect up to 32 devices. Devices on the bus are accessed using a 5-bit device address. A default device address is hardware configurable by pin-strapping on the device (some pins are sampled when a reset is asserted or at power-up).</p>
<p>The device’s internal weak pull-up or pull-down resistors define a default device address. This address can be changed by connecting strong pull-up or pull-down resistors externally. In this case, the <code>ETH_PHY_ADDR</code> needs to be defined by the user.</p>
<p>If a microcontroller device offers more than one Ethernet PHY driver, the user needs to set the correct <code>ETH_PHY_NUM</code> in his application. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__ETH__PHY" id="structARM__DRIVER__ETH__PHY"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_ETH_PHY</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the Ethernet PHY Driver. </p>
<p>The functions of the Ethernet PHY are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
<p>Each instance of an Ethernet PHY provides such an access struct. The instance is identified by a postfix number in the symbol name of the access struct, for example:</p>
<ul>
<li><b>Driver_ETH_PHY0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_ETH_PHY1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_ETH_PHY<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
</div><table class="memberdecls">
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
<tr class="memitem:a8834b281da48583845c044a81566c1b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="memdesc:a8834b281da48583845c044a81566c1b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734">ARM_ETH_PHY_GetVersion</a> : Get driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f9e7173bf8fed4d774fa48da53739ba"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a9f9e7173bf8fed4d774fa48da53739ba">Initialize</a> )(<a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> fn_read, <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> fn_write)</td></tr>
<tr class="memdesc:a9f9e7173bf8fed4d774fa48da53739ba"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> : Initialize PHY Device. <a href="#a9f9e7173bf8fed4d774fa48da53739ba">More...</a><br/></td></tr>
<tr class="separator:a9f9e7173bf8fed4d774fa48da53739ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf20681a1402869ecb5c6447fada17b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</td></tr>
<tr class="memdesc:adcf20681a1402869ecb5c6447fada17b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f">ARM_ETH_PHY_Uninitialize</a> : De-initialize PHY Device. <a href="#adcf20681a1402869ecb5c6447fada17b">More...</a><br/></td></tr>
<tr class="separator:adcf20681a1402869ecb5c6447fada17b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba8f1c8019af95ffe19c32403e3240ef"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:aba8f1c8019af95ffe19c32403e3240ef"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e">ARM_ETH_PHY_PowerControl</a> : Control PHY Device Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7dfc7cf346c80e7fdb2fe4cea2c61161"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a7dfc7cf346c80e7fdb2fe4cea2c61161">SetInterface</a> )(uint32_t interface)</td></tr>
<tr class="memdesc:a7dfc7cf346c80e7fdb2fe4cea2c61161"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> : Set Ethernet Media Interface. <a href="#a7dfc7cf346c80e7fdb2fe4cea2c61161">More...</a><br/></td></tr>
<tr class="separator:a7dfc7cf346c80e7fdb2fe4cea2c61161"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6686344f4d6afa0881d1e545c898a3d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d">SetMode</a> )(uint32_t mode)</td></tr>
<tr class="memdesc:ae6686344f4d6afa0881d1e545c898a3d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09">ARM_ETH_PHY_SetMode</a> : Set Ethernet PHY Device Operation mode. <a href="#ae6686344f4d6afa0881d1e545c898a3d">More...</a><br/></td></tr>
<tr class="separator:ae6686344f4d6afa0881d1e545c898a3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e25b2f267edc874f1bd785175fcf08a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#a0e25b2f267edc874f1bd785175fcf08a">GetLinkState</a> )(void)</td></tr>
<tr class="memdesc:a0e25b2f267edc874f1bd785175fcf08a"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> : Get Ethernet PHY Device Link state. <a href="#a0e25b2f267edc874f1bd785175fcf08a">More...</a><br/></td></tr>
<tr class="separator:a0e25b2f267edc874f1bd785175fcf08a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac162bfaf93512fa0966bfbb923c45463"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__interface__gr.html#ac162bfaf93512fa0966bfbb923c45463">GetLinkInfo</a> )(void)</td></tr>
<tr class="memdesc:ac162bfaf93512fa0966bfbb923c45463"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> : Get Ethernet PHY Device Link information. <a href="#ac162bfaf93512fa0966bfbb923c45463">More...</a><br/></td></tr>
<tr class="separator:ac162bfaf93512fa0966bfbb923c45463"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h4 class="groupheader">Field Documentation</h4>
<a class="anchor" id="a8834b281da48583845c044a81566c1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734">ARM_ETH_PHY_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a9f9e7173bf8fed4d774fa48da53739ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> fn_read, <a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> fn_write)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> : Initialize PHY Device. </p>
</div>
</div>
<a class="anchor" id="adcf20681a1402869ecb5c6447fada17b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Uninitialize)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f">ARM_ETH_PHY_Uninitialize</a> : De-initialize PHY Device. </p>
</div>
</div>
<a class="anchor" id="aba8f1c8019af95ffe19c32403e3240ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PowerControl)(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e">ARM_ETH_PHY_PowerControl</a> : Control PHY Device Power. </p>
</div>
</div>
<a class="anchor" id="a7dfc7cf346c80e7fdb2fe4cea2c61161"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetInterface)(uint32_t interface)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c">ARM_ETH_PHY_SetInterface</a> : Set Ethernet Media Interface. </p>
</div>
</div>
<a class="anchor" id="ae6686344f4d6afa0881d1e545c898a3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetMode)(uint32_t mode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09">ARM_ETH_PHY_SetMode</a> : Set Ethernet PHY Device Operation mode. </p>
</div>
</div>
<a class="anchor" id="a0e25b2f267edc874f1bd785175fcf08a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a>(* GetLinkState)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a> : Get Ethernet PHY Device Link state. </p>
</div>
</div>
<a class="anchor" id="ac162bfaf93512fa0966bfbb923c45463"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a>(* GetLinkInfo)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2">ARM_ETH_PHY_GetLinkInfo</a> : Get Ethernet PHY Device Link information. </p>
</div>
</div>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga987d5dd36f179192721c03df37d93e87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_ETH_PHY_Read_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> : Read Ethernet PHY Register. </p>
<p>Provides the typedef for the register read function <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="gaf690fde16281b25f2ffa07f9c4e8e240"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_ETH_PHY_Write_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> : Write Ethernet PHY Register. </p>
<p>Provides the typedef for the register write function <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga6850d33d699d9deee4e983a2c99e9734"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_ETH_PHY_GetVersion </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get driver version. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p>
<ul>
<li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
<li>Driver version is source code version of the actual driver implementation.</li>
</ul>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> Driver_ETH_PHY0;</div>
<div class="line"><a class="code" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_ethernet_phy (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_ETH_PHY0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__eth__phy__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (version.<a class="code" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> < 0x10A) { <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
<div class="line"> <span class="comment">// error handling</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gacf2332a7fa2d84694b8e5f0838135589"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_PHY_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87">ARM_ETH_PHY_Read_t</a> </td>
<td class="paramname"><em>fn_read</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240">ARM_ETH_PHY_Write_t</a> </td>
<td class="paramname"><em>fn_write</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize Ethernet PHY Device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fn_read</td><td>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fn_write</td><td>Pointer to <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_Initialize</b> initializes the Ethernet PHY interface. It is called when the middleware component starts operation.</p>
<p>The <a class="el" href="group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589">ARM_ETH_PHY_Initialize</a> function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for Ethernet PHY peripheral.</li>
<li>Registers the <a class="el" href="group__eth__mac__interface__gr.html#gaded29ad58366e9222487db9944373c29">ARM_ETH_MAC_PHY_Read</a> register read access function.</li>
<li>Registers the <a class="el" href="group__eth__mac__interface__gr.html#ga79dd38672749aeebd28f39d9b4f813ce">ARM_ETH_MAC_PHY_Write</a> register write access function.</li>
</ul>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="ga26ea7e1e9825b959284241ebff6eea3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_PHY_Uninitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize Ethernet PHY Device. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_Uninitialize</b> de-initializes the resources of Ethernet PHY interface.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
</div>
</div>
<a class="anchor" id="gaba0f92561754dad8f8f03feb1cf2855e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_PHY_PowerControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Ethernet PHY Device Power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_PowerControl</b> operates the power modes of the Ethernet PHY interface.</p>
<p>The parameter <em>state</em> sets the operation and can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
</ul>
<p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gaedd8b5650a1259d572a1f303d3e2c01c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_PHY_SetInterface </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Ethernet Media Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Media Interface type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_SetInterface</b> specifies the <a class="el" href="group__eth__interface__types1.html">Media Interface Types</a> that links the Ethernet MAC and Ethernet PHY. After initialization of the PHY interface, you can set the media type. The function <a class="el" href="group__eth__mac__interface__gr.html#ga2b13b230502736d8c7679b359dff20d0">ARM_ETH_MAC_GetCapabilities</a> retrieves the media interface type encoded in the data field <b>media_interface</b> of the structure <a class="el" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a>.</p>
<p>The parameter <em>interface</em> can have the following values:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>interface</em> </th><th align="left">Media Type </th></tr>
<tr>
<td align="left"><a class="el" href="group__eth__interface__types1.html#ga468c848ddf75d7925130171af1ec2ac7">ARM_ETH_INTERFACE_MII</a> </td><td align="left">Media Independent Interface (MII) </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__interface__types1.html#gac0361b34fbec9c19840ad0349e4c388b">ARM_ETH_INTERFACE_RMII</a> </td><td align="left">Reduced Media Independent Interface (RMII) </td></tr>
<tr>
<td align="left"><a class="el" href="group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a">ARM_ETH_INTERFACE_SMII</a> </td><td align="left">Serial Media Independent Interface (SMII); </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd>Some <em>interface</em> values may be unsupported by a driver implementation. For example <a class="el" href="group__eth__interface__types1.html#ga24047d142be48bbc241e8d6eacb5cf7a">ARM_ETH_INTERFACE_SMII</a> may return <b>ARM_DRIVER_ERROR_UNSUPPORTED</b>.</dd></dl>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> capabilities;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *phy;</div>
<div class="line"> </div>
<div class="line">mac = &Driver_ETH_MAC0;</div>
<div class="line">phy = &Driver_ETH_PHY0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Initialize Media Access Controller</span></div>
<div class="line">capabilities = mac-><a class="code" href="group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1">GetCapabilities</a> ();</div>
<div class="line">...</div>
<div class="line">status = phy-><a class="code" href="group__eth__phy__interface__gr.html#a7dfc7cf346c80e7fdb2fe4cea2c61161">SetInterface</a> (capabilities.<a class="code" href="group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d">media_interface</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">status = phy-><a class="code" href="group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d">SetMode</a> (<a class="code" href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">...</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga9aa688c951f01ed9ca7c88cf51be8a09"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_ETH_PHY_SetMode </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Ethernet PHY Device Operation mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Operation Mode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_SetMode</b> sets the operation mode parameters for the Ethernet PHY.</p>
<p>The table below lists the possible values for the parameter <em>mode</em>. Values from different categories can be ORed as shown in this example code:</p>
<div class="fragment"><div class="line">phy-><a class="code" href="group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d">SetMode</a> (<a class="code" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a> | <a class="code" href="group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">ARM_ETH_PHY_LOOPBACK</a> | <a class="code" href="group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d">ARM_ETH_PHY_DUPLEX_HALF</a> );</div>
</div><!-- fragment --><p> <br/>
</p>
<table class="cmtable">
<tr>
<th>Parameter <em>mode</em> </th><th>bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#gabc7acc4ebe828c3d0825400e14ad20f0">ARM_ETH_PHY_SPEED_10M</a> </td><td rowspan="3">0..1 </td><td rowspan="3">Link Speed </td><td>Set the link speed to <span class="XML-Token">10 [Mbps]</span> </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a> </td><td>Set the link speed to <span class="XML-Token">100 [Mbps]</span> </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#ga046605398ceae99a176e6f82432ae710">ARM_ETH_PHY_SPEED_1G</a> </td><td>Set the link speed to <span class="XML-Token">1 [Gbps]</span> </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d">ARM_ETH_PHY_DUPLEX_HALF</a> </td><td rowspan="2">2 </td><td rowspan="2">Link Mode </td><td>Set the link mode to half duplex </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3">ARM_ETH_PHY_DUPLEX_FULL</a> </td><td>Set the link mode to full duplex </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a> </td><td>3 </td><td>Autonegotiation </td><td>Set the interface to Auto Negotiation mode of transmission parameters </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">ARM_ETH_PHY_LOOPBACK</a> </td><td>4 </td><td>Loopback </td><td>Set the interface into a Loop-back test mode </td></tr>
<tr>
<td><a class="el" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a> </td><td>5 </td><td>Isolation </td><td>Set to indicate electrical isolation of PHY interface from MII/RMII interface </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd>Some settings may be also taken from configuration pins (example <a class="el" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a>). Check the effect of mode settings in the actual driver implementation. </dd>
<dd>
Some <em>mode</em> values may be unsupported by a driver implementation. For example <a class="el" href="group__eth__phy__mode__ctrls.html#ga046605398ceae99a176e6f82432ae710">ARM_ETH_PHY_SPEED_1G</a> may return <b>ARM_DRIVER_ERROR_UNSUPPORTED</b>.</dd></dl>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__ETH__MAC__CAPABILITIES">ARM_ETH_MAC_CAPABILITIES</a> capabilities;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__mac__interface__gr.html#structARM__DRIVER__ETH__MAC">ARM_DRIVER_ETH_MAC</a> *mac;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY">ARM_DRIVER_ETH_PHY</a> *phy;</div>
<div class="line"> </div>
<div class="line">mac = &Driver_ETH_MAC0;</div>
<div class="line">phy = &Driver_ETH_PHY0;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Initialize Media Access Controller</span></div>
<div class="line">capabilities = mac-><a class="code" href="group__eth__mac__interface__gr.html#a9fd725bb058c584a9ced9c579561cdf1">GetCapabilities</a> ();</div>
<div class="line">...</div>
<div class="line">status = phy-><a class="code" href="group__eth__phy__interface__gr.html#a7dfc7cf346c80e7fdb2fe4cea2c61161">SetInterface</a> (capabilities.<a class="code" href="group__eth__mac__interface__gr.html#a3c5cb74e086417a01d0079f847a3fc8d">media_interface</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">status = phy-><a class="code" href="group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d">SetMode</a> (<a class="code" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a> | <a class="code" href="group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3">ARM_ETH_PHY_DUPLEX_FULL</a> | <a class="code" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a>);</div>
<div class="line"><span class="keywordflow">if</span> (status != <a class="code" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>) ... <span class="comment">// error handling</span></div>
<div class="line">...</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga4085cd24ebe33b78d51a3c003da4a5ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a> ARM_ETH_PHY_GetLinkState </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Ethernet PHY Device Link state. </p>
<dl class="section return"><dt>Returns</dt><dd>current link status <a class="el" href="group__eth__interface__gr.html#gacf7db5320eb841b462a4af3c56cc9291">ARM_ETH_LINK_STATE</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_GetLinkState</b> retrieves the connection status of the physical Ethernet link.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="ga8c79dcd7a12656403f3befab3c8605a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a> ARM_ETH_PHY_GetLinkInfo </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Ethernet PHY Device Link information. </p>
<dl class="section return"><dt>Returns</dt><dd>current link parameters <a class="el" href="group__eth__interface__gr.html#structARM__ETH__LINK__INFO">ARM_ETH_LINK_INFO</a></dd></dl>
<p>The function <b>ARM_ETH_PHY_GetLinkInfo</b> retrieves information about the current established communication mode (half/full duplex) and communication speed. Information is only valid when link is up (see <a class="el" href="group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba">ARM_ETH_PHY_GetLinkState</a>).</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__eth__interface__gr.html">Ethernet Interface</a> - Driver Functions </li>
</ul>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__phy__interface__gr.html | HTML | apache-2.0 | 52,838 |
var group__eth__phy__interface__gr =
[
[ "Ethernet PHY Mode", "group__eth__phy__mode__ctrls.html", "group__eth__phy__mode__ctrls" ],
[ "ARM_DRIVER_ETH_PHY", "group__eth__phy__interface__gr.html#structARM__DRIVER__ETH__PHY", [
[ "GetVersion", "group__eth__phy__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "Initialize", "group__eth__phy__interface__gr.html#a9f9e7173bf8fed4d774fa48da53739ba", null ],
[ "Uninitialize", "group__eth__phy__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__eth__phy__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "SetInterface", "group__eth__phy__interface__gr.html#a7dfc7cf346c80e7fdb2fe4cea2c61161", null ],
[ "SetMode", "group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d", null ],
[ "GetLinkState", "group__eth__phy__interface__gr.html#a0e25b2f267edc874f1bd785175fcf08a", null ],
[ "GetLinkInfo", "group__eth__phy__interface__gr.html#ac162bfaf93512fa0966bfbb923c45463", null ]
] ],
[ "ARM_ETH_PHY_Read_t", "group__eth__phy__interface__gr.html#ga987d5dd36f179192721c03df37d93e87", null ],
[ "ARM_ETH_PHY_Write_t", "group__eth__phy__interface__gr.html#gaf690fde16281b25f2ffa07f9c4e8e240", null ],
[ "ARM_ETH_PHY_GetVersion", "group__eth__phy__interface__gr.html#ga6850d33d699d9deee4e983a2c99e9734", null ],
[ "ARM_ETH_PHY_Initialize", "group__eth__phy__interface__gr.html#gacf2332a7fa2d84694b8e5f0838135589", null ],
[ "ARM_ETH_PHY_Uninitialize", "group__eth__phy__interface__gr.html#ga26ea7e1e9825b959284241ebff6eea3f", null ],
[ "ARM_ETH_PHY_PowerControl", "group__eth__phy__interface__gr.html#gaba0f92561754dad8f8f03feb1cf2855e", null ],
[ "ARM_ETH_PHY_SetInterface", "group__eth__phy__interface__gr.html#gaedd8b5650a1259d572a1f303d3e2c01c", null ],
[ "ARM_ETH_PHY_SetMode", "group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09", null ],
[ "ARM_ETH_PHY_GetLinkState", "group__eth__phy__interface__gr.html#ga4085cd24ebe33b78d51a3c003da4a5ba", null ],
[ "ARM_ETH_PHY_GetLinkInfo", "group__eth__phy__interface__gr.html#ga8c79dcd7a12656403f3befab3c8605a2", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__phy__interface__gr.js | JavaScript | apache-2.0 | 2,212 |
var group__eth__phy__interface__gr_structARM__DRIVER__ETH__PHY =
[
[ "GetVersion", "group__eth__phy__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "Initialize", "group__eth__phy__interface__gr.html#a9f9e7173bf8fed4d774fa48da53739ba", null ],
[ "Uninitialize", "group__eth__phy__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__eth__phy__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "SetInterface", "group__eth__phy__interface__gr.html#a7dfc7cf346c80e7fdb2fe4cea2c61161", null ],
[ "SetMode", "group__eth__phy__interface__gr.html#ae6686344f4d6afa0881d1e545c898a3d", null ],
[ "GetLinkState", "group__eth__phy__interface__gr.html#a0e25b2f267edc874f1bd785175fcf08a", null ],
[ "GetLinkInfo", "group__eth__phy__interface__gr.html#ac162bfaf93512fa0966bfbb923c45463", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__phy__interface__gr_structARM__DRIVER__ETH__PHY.js | JavaScript | apache-2.0 | 882 |
<!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>Ethernet PHY Mode</title>
<title>CMSIS-Driver: Ethernet PHY Mode</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__eth__phy__mode__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"> </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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Ethernet PHY Mode<div class="ingroups"><a class="el" href="group__eth__phy__interface__gr.html">Ethernet PHY Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify operation modes of the Ethernet PHY interface.
<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:gabc7acc4ebe828c3d0825400e14ad20f0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#gabc7acc4ebe828c3d0825400e14ad20f0">ARM_ETH_PHY_SPEED_10M</a>   (<a class="el" href="Driver__ETH_8h.html#a1f834c4c785d7f69b1eaca011ee298ec">ARM_ETH_SPEED_10M</a> << <a class="el" href="Driver__ETH__PHY_8h.html#a13700fab82aa60a3357614faa0619e97">ARM_ETH_PHY_SPEED_Pos</a>)</td></tr>
<tr class="memdesc:gabc7acc4ebe828c3d0825400e14ad20f0"><td class="mdescLeft"> </td><td class="mdescRight">10 Mbps link speed <a href="#gabc7acc4ebe828c3d0825400e14ad20f0">More...</a><br/></td></tr>
<tr class="separator:gabc7acc4ebe828c3d0825400e14ad20f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad1e8b2c8c210fa36949db9a34a993657"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657">ARM_ETH_PHY_SPEED_100M</a>   (<a class="el" href="Driver__ETH_8h.html#a3bddfc4cf5645f8568d9cb6621fd606a">ARM_ETH_SPEED_100M</a> << <a class="el" href="Driver__ETH__PHY_8h.html#a13700fab82aa60a3357614faa0619e97">ARM_ETH_PHY_SPEED_Pos</a>)</td></tr>
<tr class="memdesc:gad1e8b2c8c210fa36949db9a34a993657"><td class="mdescLeft"> </td><td class="mdescRight">100 Mbps link speed <a href="#gad1e8b2c8c210fa36949db9a34a993657">More...</a><br/></td></tr>
<tr class="separator:gad1e8b2c8c210fa36949db9a34a993657"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga046605398ceae99a176e6f82432ae710"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#ga046605398ceae99a176e6f82432ae710">ARM_ETH_PHY_SPEED_1G</a>   (<a class="el" href="Driver__ETH_8h.html#a218f470079b7c04de6776d467a53772a">ARM_ETH_SPEED_1G</a> << <a class="el" href="Driver__ETH__PHY_8h.html#a13700fab82aa60a3357614faa0619e97">ARM_ETH_PHY_SPEED_Pos</a>)</td></tr>
<tr class="memdesc:ga046605398ceae99a176e6f82432ae710"><td class="mdescLeft"> </td><td class="mdescRight">1 Gpbs link speed <a href="#ga046605398ceae99a176e6f82432ae710">More...</a><br/></td></tr>
<tr class="separator:ga046605398ceae99a176e6f82432ae710"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace797b3cd143be22f47c3ef61b20e14d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d">ARM_ETH_PHY_DUPLEX_HALF</a>   (<a class="el" href="Driver__ETH_8h.html#acb15afc2bfe61c56049b7279d6eae8fe">ARM_ETH_DUPLEX_HALF</a> << <a class="el" href="Driver__ETH__PHY_8h.html#aebafadc356d8e58407db156a5dac743f">ARM_ETH_PHY_DUPLEX_Pos</a>)</td></tr>
<tr class="memdesc:gace797b3cd143be22f47c3ef61b20e14d"><td class="mdescLeft"> </td><td class="mdescRight">Half duplex link. <a href="#gace797b3cd143be22f47c3ef61b20e14d">More...</a><br/></td></tr>
<tr class="separator:gace797b3cd143be22f47c3ef61b20e14d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d06a94867c89cd311b6e279669321e3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3">ARM_ETH_PHY_DUPLEX_FULL</a>   (<a class="el" href="Driver__ETH_8h.html#a7848c83cd1fd6b2645c17919c2990354">ARM_ETH_DUPLEX_FULL</a> << <a class="el" href="Driver__ETH__PHY_8h.html#aebafadc356d8e58407db156a5dac743f">ARM_ETH_PHY_DUPLEX_Pos</a>)</td></tr>
<tr class="memdesc:ga5d06a94867c89cd311b6e279669321e3"><td class="mdescLeft"> </td><td class="mdescRight">Full duplex link. <a href="#ga5d06a94867c89cd311b6e279669321e3">More...</a><br/></td></tr>
<tr class="separator:ga5d06a94867c89cd311b6e279669321e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a8c54f8fed3e5f68bd04eb715d10ab9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9">ARM_ETH_PHY_AUTO_NEGOTIATE</a>   (1UL << 3)</td></tr>
<tr class="memdesc:ga6a8c54f8fed3e5f68bd04eb715d10ab9"><td class="mdescLeft"> </td><td class="mdescRight">Auto Negotiation mode. <a href="#ga6a8c54f8fed3e5f68bd04eb715d10ab9">More...</a><br/></td></tr>
<tr class="separator:ga6a8c54f8fed3e5f68bd04eb715d10ab9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">ARM_ETH_PHY_LOOPBACK</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec"><td class="mdescLeft"> </td><td class="mdescRight">Loop-back test mode. <a href="#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec">More...</a><br/></td></tr>
<tr class="separator:ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d68719e07c7af449b57c5df802376c8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8">ARM_ETH_PHY_ISOLATE</a>   (1UL << 5)</td></tr>
<tr class="memdesc:ga8d68719e07c7af449b57c5df802376c8"><td class="mdescLeft"> </td><td class="mdescRight">Isolate PHY from MII/RMII interface. <a href="#ga8d68719e07c7af449b57c5df802376c8">More...</a><br/></td></tr>
<tr class="separator:ga8d68719e07c7af449b57c5df802376c8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify operation modes of the Ethernet PHY interface. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gabc7acc4ebe828c3d0825400e14ad20f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_SPEED_10M   (<a class="el" href="Driver__ETH_8h.html#a1f834c4c785d7f69b1eaca011ee298ec">ARM_ETH_SPEED_10M</a> << <a class="el" href="Driver__ETH__PHY_8h.html#a13700fab82aa60a3357614faa0619e97">ARM_ETH_PHY_SPEED_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>10 Mbps link speed </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad1e8b2c8c210fa36949db9a34a993657"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_SPEED_100M   (<a class="el" href="Driver__ETH_8h.html#a3bddfc4cf5645f8568d9cb6621fd606a">ARM_ETH_SPEED_100M</a> << <a class="el" href="Driver__ETH__PHY_8h.html#a13700fab82aa60a3357614faa0619e97">ARM_ETH_PHY_SPEED_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>100 Mbps link speed </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga046605398ceae99a176e6f82432ae710"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_SPEED_1G   (<a class="el" href="Driver__ETH_8h.html#a218f470079b7c04de6776d467a53772a">ARM_ETH_SPEED_1G</a> << <a class="el" href="Driver__ETH__PHY_8h.html#a13700fab82aa60a3357614faa0619e97">ARM_ETH_PHY_SPEED_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 Gpbs link speed </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gace797b3cd143be22f47c3ef61b20e14d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_DUPLEX_HALF   (<a class="el" href="Driver__ETH_8h.html#acb15afc2bfe61c56049b7279d6eae8fe">ARM_ETH_DUPLEX_HALF</a> << <a class="el" href="Driver__ETH__PHY_8h.html#aebafadc356d8e58407db156a5dac743f">ARM_ETH_PHY_DUPLEX_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Half duplex link. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5d06a94867c89cd311b6e279669321e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_DUPLEX_FULL   (<a class="el" href="Driver__ETH_8h.html#a7848c83cd1fd6b2645c17919c2990354">ARM_ETH_DUPLEX_FULL</a> << <a class="el" href="Driver__ETH__PHY_8h.html#aebafadc356d8e58407db156a5dac743f">ARM_ETH_PHY_DUPLEX_Pos</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Full duplex link. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6a8c54f8fed3e5f68bd04eb715d10ab9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_AUTO_NEGOTIATE   (1UL << 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Auto Negotiation mode. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_LOOPBACK   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Loop-back test mode. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8d68719e07c7af449b57c5df802376c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_ETH_PHY_ISOLATE   (1UL << 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Isolate PHY from MII/RMII interface. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__eth__phy__interface__gr.html#ga9aa688c951f01ed9ca7c88cf51be8a09" title="Set Ethernet PHY Device Operation mode. ">ARM_ETH_PHY_SetMode</a> </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__phy__mode__ctrls.html | HTML | apache-2.0 | 18,567 |
var group__eth__phy__mode__ctrls =
[
[ "ARM_ETH_PHY_SPEED_10M", "group__eth__phy__mode__ctrls.html#gabc7acc4ebe828c3d0825400e14ad20f0", null ],
[ "ARM_ETH_PHY_SPEED_100M", "group__eth__phy__mode__ctrls.html#gad1e8b2c8c210fa36949db9a34a993657", null ],
[ "ARM_ETH_PHY_SPEED_1G", "group__eth__phy__mode__ctrls.html#ga046605398ceae99a176e6f82432ae710", null ],
[ "ARM_ETH_PHY_DUPLEX_HALF", "group__eth__phy__mode__ctrls.html#gace797b3cd143be22f47c3ef61b20e14d", null ],
[ "ARM_ETH_PHY_DUPLEX_FULL", "group__eth__phy__mode__ctrls.html#ga5d06a94867c89cd311b6e279669321e3", null ],
[ "ARM_ETH_PHY_AUTO_NEGOTIATE", "group__eth__phy__mode__ctrls.html#ga6a8c54f8fed3e5f68bd04eb715d10ab9", null ],
[ "ARM_ETH_PHY_LOOPBACK", "group__eth__phy__mode__ctrls.html#ga5f7e46cda8ab3c774fe7ce0a8a1ba3ec", null ],
[ "ARM_ETH_PHY_ISOLATE", "group__eth__phy__mode__ctrls.html#ga8d68719e07c7af449b57c5df802376c8", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__eth__phy__mode__ctrls.js | JavaScript | apache-2.0 | 932 |
<!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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Usage and 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__execution__status.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Status Error Codes<div class="ingroups"><a class="el" href="group__common__drv__gr.html">Common Driver Definitions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Negative return values of functions indicate errors occurred during execution.
<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:ga85752c5de59e8adeb001e35ff5be6be7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>   0</td></tr>
<tr class="memdesc:ga85752c5de59e8adeb001e35ff5be6be7"><td class="mdescLeft"> </td><td class="mdescRight">Operation succeeded. <a href="#ga85752c5de59e8adeb001e35ff5be6be7">More...</a><br/></td></tr>
<tr class="separator:ga85752c5de59e8adeb001e35ff5be6be7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2f627075447749bb368d3b768be107cb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a>   -1</td></tr>
<tr class="memdesc:ga2f627075447749bb368d3b768be107cb"><td class="mdescLeft"> </td><td class="mdescRight">Unspecified error. <a href="#ga2f627075447749bb368d3b768be107cb">More...</a><br/></td></tr>
<tr class="separator:ga2f627075447749bb368d3b768be107cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13c1123319c7b9a4735d63447f35116b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a>   -2</td></tr>
<tr class="memdesc:ga13c1123319c7b9a4735d63447f35116b"><td class="mdescLeft"> </td><td class="mdescRight">Driver is busy. <a href="#ga13c1123319c7b9a4735d63447f35116b">More...</a><br/></td></tr>
<tr class="separator:ga13c1123319c7b9a4735d63447f35116b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0bac892205bb2d586b822e8b178ab310"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga0bac892205bb2d586b822e8b178ab310">ARM_DRIVER_ERROR_TIMEOUT</a>   -3</td></tr>
<tr class="memdesc:ga0bac892205bb2d586b822e8b178ab310"><td class="mdescLeft"> </td><td class="mdescRight">Timeout occurred. <a href="#ga0bac892205bb2d586b822e8b178ab310">More...</a><br/></td></tr>
<tr class="separator:ga0bac892205bb2d586b822e8b178ab310"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2efa59e480d82697795439220e6884e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a>   -4</td></tr>
<tr class="memdesc:ga2efa59e480d82697795439220e6884e4"><td class="mdescLeft"> </td><td class="mdescRight">Operation not supported. <a href="#ga2efa59e480d82697795439220e6884e4">More...</a><br/></td></tr>
<tr class="separator:ga2efa59e480d82697795439220e6884e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac781d4b70ce17c4c2efe2db045be751c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a>   -5</td></tr>
<tr class="memdesc:gac781d4b70ce17c4c2efe2db045be751c"><td class="mdescLeft"> </td><td class="mdescRight">Parameter error. <a href="#gac781d4b70ce17c4c2efe2db045be751c">More...</a><br/></td></tr>
<tr class="separator:gac781d4b70ce17c4c2efe2db045be751c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a2b5d68f6649598d099b88c0eaee3e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a>   -6</td></tr>
<tr class="memdesc:ga5a2b5d68f6649598d099b88c0eaee3e5"><td class="mdescLeft"> </td><td class="mdescRight">Start of driver specific errors. <a href="#ga5a2b5d68f6649598d099b88c0eaee3e5">More...</a><br/></td></tr>
<tr class="separator:ga5a2b5d68f6649598d099b88c0eaee3e5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Negative return values of functions indicate errors occurred during execution. </p>
<p>Most functions return a status information using negative return values. The following list provides the status error codes that are common in all drivers. The drivers may return also status error codes that are specific to the peripheral. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__execution__status.html">Status Error Codes</a> for SPI driver; <a class="el" href="group__usart__execution__status.html">Status Error Codes</a> for USART driver; <a class="el" href="group__nand__execution__status.html">Status Error Codes</a> for NAND driver; </dd></dl>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga85752c5de59e8adeb001e35ff5be6be7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_OK   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operation succeeded. </p>
<p>The value 0 or positive values indicate that the function execution is completed without any errors. Note that positive values are used to provide for example the number of data items. </p>
<p>Referenced by <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control()</a>, <a class="el" href="group__can__interface__gr.html#ga1fe6cc207415de604975ae251e269361">ARM_CAN_GetClock()</a>, <a class="el" href="group__can__interface__gr.html#ga676d6b567fc4ab3d44f5d7a50ec9419c">ARM_CAN_GetStatus()</a>, <a class="el" href="group__can__interface__gr.html#gaa72ceb25ba67e279d7432404632deb44">ARM_CAN_Initialize()</a>, <a class="el" href="group__can__interface__gr.html#gafc37084df5eab32f593c2744d35cf647">ARM_CAN_MessageRead()</a>, <a class="el" href="group__can__interface__gr.html#ga0dcffd362b4093043442a030eaebbcfe">ARM_CAN_MessageSend()</a>, <a class="el" href="group__can__interface__gr.html#ga00ec0715f6755a49dae5b60dca182630">ARM_CAN_ObjectConfigure()</a>, <a class="el" href="group__can__interface__gr.html#ga4f9bc7088704483388e14872c9d5385d">ARM_CAN_ObjectSetFilter()</a>, <a class="el" href="group__can__interface__gr.html#ga6f634f126ac97daef2f3115aa7bfed7c">ARM_CAN_PowerControl()</a>, <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate()</a>, <a class="el" href="group__can__interface__gr.html#ga28226a6e223f9b95b4dafb7c2f48a855">ARM_CAN_SetMode()</a>, <a class="el" href="group__can__interface__gr.html#ga1e3e364b64f2ab277399e3279cce5ef8">ARM_CAN_Uninitialize()</a>, <a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc">ARM_I2C_Control()</a>, <a class="el" href="group__i2c__interface__gr.html#ga79d2f7d01b3a681d1cf0d70ac6692696">ARM_I2C_Initialize()</a>, <a class="el" href="group__i2c__interface__gr.html#gafa22504bcf88a85584dfe6e0dd270ad5">ARM_I2C_MasterReceive()</a>, <a class="el" href="group__i2c__interface__gr.html#ga8bf4214580149d5a5d2360f71f0feb94">ARM_I2C_MasterTransmit()</a>, <a class="el" href="group__i2c__interface__gr.html#ga734a69200e063fdbfb5110062afe9329">ARM_I2C_PowerControl()</a>, <a class="el" href="group__i2c__interface__gr.html#gae3c9abccd1d377385d3d4cfe29035164">ARM_I2C_SlaveReceive()</a>, <a class="el" href="group__i2c__interface__gr.html#gafe164f30eba78f066272373b98a62cd4">ARM_I2C_SlaveTransmit()</a>, <a class="el" href="group__i2c__interface__gr.html#ga30d8bf600b6b3182a1f867407b3d6e75">ARM_I2C_Uninitialize()</a>, <a class="el" href="group__mci__interface__gr.html#ga3dfcf7b7186b711f9b63a096be816fe5">ARM_MCI_AbortTransfer()</a>, <a class="el" href="group__mci__interface__gr.html#gab161f80e0eda2815f3e0ebbba1314ff0">ARM_MCI_CardPower()</a>, <a class="el" href="group__mci__interface__gr.html#gaec0506a2aa4ae75cf6bc02528f36fe30">ARM_MCI_Control()</a>, <a class="el" href="group__mci__interface__gr.html#ga8d61aa42ce78d1864fa928c1f273cbd9">ARM_MCI_GetStatus()</a>, <a class="el" href="group__mci__interface__gr.html#ga6f34d4ab362e596ddaf23aac093268cf">ARM_MCI_Initialize()</a>, <a class="el" href="group__mci__interface__gr.html#ga19752749d04ed22dc91c4294645e0244">ARM_MCI_PowerControl()</a>, <a class="el" href="group__mci__interface__gr.html#ga5a431da89feabc2b4bc0c27943dff6f2">ARM_MCI_SendCommand()</a>, <a class="el" href="group__mci__interface__gr.html#gaaec681bcd8e6811c5743e33ee0f35ed1">ARM_MCI_SetupTransfer()</a>, <a class="el" href="group__mci__interface__gr.html#gaef8183e77797e74997551d03646d42c2">ARM_MCI_Uninitialize()</a>, <a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869">ARM_SAI_Control()</a>, <a class="el" href="group__sai__interface__gr.html#ga89622a02ca1e7affb1a01eefacb6f54c">ARM_SAI_Initialize()</a>, <a class="el" href="group__sai__interface__gr.html#gacdec50a3dd5902de601caa7397c1dabc">ARM_SAI_PowerControl()</a>, <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive()</a>, <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send()</a>, <a class="el" href="group__sai__interface__gr.html#gabdefafaba6f072cfd7ed6f8f132422b6">ARM_SAI_Uninitialize()</a>, <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control()</a>, <a class="el" href="group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906">ARM_SPI_Initialize()</a>, <a class="el" href="group__spi__interface__gr.html#ga1a1e7e80ea32ae381b75213c32aa8067">ARM_SPI_PowerControl()</a>, <a class="el" href="group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6">ARM_SPI_Receive()</a>, <a class="el" href="group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479">ARM_SPI_Send()</a>, <a class="el" href="group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2">ARM_SPI_Transfer()</a>, <a class="el" href="group__spi__interface__gr.html#ga0c480ee3eabb82fc746e89741ed2e03e">ARM_SPI_Uninitialize()</a>, <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control()</a>, <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize()</a>, <a class="el" href="group__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">ARM_USART_PowerControl()</a>, <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive()</a>, <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send()</a>, <a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl()</a>, <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer()</a>, <a class="el" href="group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize()</a>, <a class="el" href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca">ARM_USBD_DeviceConnect()</a>, <a class="el" href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1">ARM_USBD_DeviceDisconnect()</a>, <a class="el" href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2">ARM_USBD_DeviceGetState()</a>, <a class="el" href="group__usbd__interface__gr.html#ga7e149a4c6a0196da24a44f4fada75fb1">ARM_USBD_DeviceRemoteWakeup()</a>, <a class="el" href="group__usbd__interface__gr.html#gae66f696584e25fb2ddabe9070fa38670">ARM_USBD_DeviceSetAddress()</a>, <a class="el" href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8">ARM_USBD_EndpointConfigure()</a>, <a class="el" href="group__usbd__interface__gr.html#ga9502cd7b8e4c583920fccadc4ccf7975">ARM_USBD_EndpointStall()</a>, <a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">ARM_USBD_EndpointTransfer()</a>, <a class="el" href="group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e">ARM_USBD_EndpointTransferAbort()</a>, <a class="el" href="group__usbd__interface__gr.html#gaca913df5188dc0f0c4f707b57c2a88fc">ARM_USBD_EndpointUnconfigure()</a>, <a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize()</a>, <a class="el" href="group__usbd__interface__gr.html#gaa5bdaac19f6df30c6e569abef17cdb42">ARM_USBD_PowerControl()</a>, <a class="el" href="group__usbd__interface__gr.html#ga6bc0ebf699a0f28330f21cab83f85e9e">ARM_USBD_ReadSetupPacket()</a>, <a class="el" href="group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b">ARM_USBD_Uninitialize()</a>, <a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize()</a>, <a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff()</a>, <a class="el" href="group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl()</a>, <a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize()</a>, <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize()</a>, <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete()</a>, <a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify()</a>, <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset()</a>, <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer()</a>, <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort()</a>, <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset()</a>, <a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume()</a>, <a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend()</a>, <a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff()</a>, <a class="el" href="group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl()</a>, <a class="el" href="group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize()</a>, <a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate()</a>, <a class="el" href="group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e">ARM_WIFI_BypassControl()</a>, <a class="el" href="group__wifi__management__gr.html#ga1842127df60067481ac2f40d19153e3e">ARM_WIFI_Deactivate()</a>, <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame()</a>, <a class="el" href="group__wifi__bypass__gr.html#gac1da4619feaf62d0cc90cfe44642d16b">ARM_WIFI_EthSendFrame()</a>, <a class="el" href="group__wifi__control__gr.html#gabdc4c9966a3f22ac6e53119e71e67579">ARM_WIFI_GetModuleInfo()</a>, <a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">ARM_WIFI_GetNetInfo()</a>, <a class="el" href="group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf">ARM_WIFI_GetOption()</a>, <a class="el" href="group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">ARM_WIFI_Initialize()</a>, <a class="el" href="group__wifi__socket__gr.html#gac7a8abb9e23f3f52dabce4153a53c1ca">ARM_WIFI_Ping()</a>, <a class="el" href="group__wifi__control__gr.html#ga48d4cb7c00e96d2b928cc4468d4e623b">ARM_WIFI_PowerControl()</a>, <a class="el" href="group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f">ARM_WIFI_Scan()</a>, <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption()</a>, and <a class="el" href="group__wifi__control__gr.html#gae1e488d4ecc365e30712e6b1711a9c5d">ARM_WIFI_Uninitialize()</a>.</p>
</div>
</div>
<a class="anchor" id="ga2f627075447749bb368d3b768be107cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_ERROR   -1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unspecified error. </p>
<p>The function did not execute correct and an unspecified error occurred during execution. </p>
</div>
</div>
<a class="anchor" id="ga13c1123319c7b9a4735d63447f35116b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_ERROR_BUSY   -2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver is busy. </p>
<p>The function cannot be executed because the driver is busy with the execution of a conflicting operation. </p>
</div>
</div>
<a class="anchor" id="ga0bac892205bb2d586b822e8b178ab310"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_ERROR_TIMEOUT   -3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timeout occurred. </p>
<p>The function execution is terminated because a peripheral did not react within a specific timeout limit. </p>
</div>
</div>
<a class="anchor" id="ga2efa59e480d82697795439220e6884e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_ERROR_UNSUPPORTED   -4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operation not supported. </p>
<p>The function requested an operation (for example by using an illegal control code) that is not supported. </p>
</div>
</div>
<a class="anchor" id="gac781d4b70ce17c4c2efe2db045be751c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_ERROR_PARAMETER   -5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter error. </p>
<p>A function parameter is incorrect. </p>
</div>
</div>
<a class="anchor" id="ga5a2b5d68f6649598d099b88c0eaee3e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_DRIVER_ERROR_SPECIFIC   -6</td>
</tr>
</table>
</div><div class="memdoc">
<p>Start of driver specific errors. </p>
<p>This value indicates the start of status error codes that are specific to the peripheral driver. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__execution__status.html">Status Error Codes</a> for SPI driver; <a class="el" href="group__usart__execution__status.html">Status Error Codes</a> for USART driver; </dd></dl>
</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>
| YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__execution__status.html | HTML | apache-2.0 | 26,025 |