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 |
|---|---|---|---|---|---|
var group__sai__mono__control =
[
[ "ARM_SAI_MONO_MODE", "group__sai__mono__control.html#ga0adcd27875d92add813b9664e9cb0b4b", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__mono__control.js | JavaScript | apache-2.0 | 139 |
<!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 Protocol</title>
<title>CMSIS-Driver: SAI Protocol</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__protocol__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">SAI Protocol<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines Transmitter/Receiver protocol.
<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:gacef87941052c21ebacd3dde6ce9d6925"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gacef87941052c21ebacd3dde6ce9d6925">ARM_SAI_PROTOCOL_USER</a>   (0U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:gacef87941052c21ebacd3dde6ce9d6925"><td class="mdescLeft"> </td><td class="mdescRight">User defined (default) <a href="#gacef87941052c21ebacd3dde6ce9d6925">More...</a><br/></td></tr>
<tr class="separator:gacef87941052c21ebacd3dde6ce9d6925"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gaaaf423bbe59920b3c7813e22ce083ddc">ARM_SAI_PROTOCOL_I2S</a>   (1U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="mdescLeft"> </td><td class="mdescRight">I2S. <a href="#gaaaf423bbe59920b3c7813e22ce083ddc">More...</a><br/></td></tr>
<tr class="separator:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad931f9e8aedff4e6040d726d707862f0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gad931f9e8aedff4e6040d726d707862f0">ARM_SAI_PROTOCOL_MSB_JUSTIFIED</a>   (2U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:gad931f9e8aedff4e6040d726d707862f0"><td class="mdescLeft"> </td><td class="mdescRight">MSB (left) justified. <a href="#gad931f9e8aedff4e6040d726d707862f0">More...</a><br/></td></tr>
<tr class="separator:gad931f9e8aedff4e6040d726d707862f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gab88b6f9b61a20927ac8f8d39e46c6349">ARM_SAI_PROTOCOL_LSB_JUSTIFIED</a>   (3U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="mdescLeft"> </td><td class="mdescRight">LSB (right) justified. <a href="#gab88b6f9b61a20927ac8f8d39e46c6349">More...</a><br/></td></tr>
<tr class="separator:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3762437e0b1402b5d4fd293ae745f103"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#ga3762437e0b1402b5d4fd293ae745f103">ARM_SAI_PROTOCOL_PCM_SHORT</a>   (4U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:ga3762437e0b1402b5d4fd293ae745f103"><td class="mdescLeft"> </td><td class="mdescRight">PCM with short frame. <a href="#ga3762437e0b1402b5d4fd293ae745f103">More...</a><br/></td></tr>
<tr class="separator:ga3762437e0b1402b5d4fd293ae745f103"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad43530c5b6ae1e89db587b20d71440b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gad43530c5b6ae1e89db587b20d71440b4">ARM_SAI_PROTOCOL_PCM_LONG</a>   (5U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:gad43530c5b6ae1e89db587b20d71440b4"><td class="mdescLeft"> </td><td class="mdescRight">PCM with long frame. <a href="#gad43530c5b6ae1e89db587b20d71440b4">More...</a><br/></td></tr>
<tr class="separator:gad43530c5b6ae1e89db587b20d71440b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#ga8b1669910f4db4bb3584543e7eb04d7a">ARM_SAI_PROTOCOL_AC97</a>   (6U << ARM_SAI_PROTOCOL_Pos)</td></tr>
<tr class="memdesc:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="mdescLeft"> </td><td class="mdescRight">AC'97. <a href="#ga8b1669910f4db4bb3584543e7eb04d7a">More...</a><br/></td></tr>
<tr class="separator:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines Transmitter/Receiver protocol. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gacef87941052c21ebacd3dde6ce9d6925"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_USER   (0U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>User defined (default) </p>
</div>
</div>
<a class="anchor" id="gaaaf423bbe59920b3c7813e22ce083ddc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_I2S   (1U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>I2S. </p>
</div>
</div>
<a class="anchor" id="gad931f9e8aedff4e6040d726d707862f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_MSB_JUSTIFIED   (2U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>MSB (left) justified. </p>
</div>
</div>
<a class="anchor" id="gab88b6f9b61a20927ac8f8d39e46c6349"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_LSB_JUSTIFIED   (3U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>LSB (right) justified. </p>
</div>
</div>
<a class="anchor" id="ga3762437e0b1402b5d4fd293ae745f103"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_PCM_SHORT   (4U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>PCM with short frame. </p>
</div>
</div>
<a class="anchor" id="gad43530c5b6ae1e89db587b20d71440b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_PCM_LONG   (5U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>PCM with long frame. </p>
</div>
</div>
<a class="anchor" id="ga8b1669910f4db4bb3584543e7eb04d7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_PROTOCOL_AC97   (6U << ARM_SAI_PROTOCOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>AC'97. </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__protocol__control.html | HTML | apache-2.0 | 14,000 |
var group__sai__protocol__control =
[
[ "ARM_SAI_PROTOCOL_USER", "group__sai__protocol__control.html#gacef87941052c21ebacd3dde6ce9d6925", null ],
[ "ARM_SAI_PROTOCOL_I2S", "group__sai__protocol__control.html#gaaaf423bbe59920b3c7813e22ce083ddc", null ],
[ "ARM_SAI_PROTOCOL_MSB_JUSTIFIED", "group__sai__protocol__control.html#gad931f9e8aedff4e6040d726d707862f0", null ],
[ "ARM_SAI_PROTOCOL_LSB_JUSTIFIED", "group__sai__protocol__control.html#gab88b6f9b61a20927ac8f8d39e46c6349", null ],
[ "ARM_SAI_PROTOCOL_PCM_SHORT", "group__sai__protocol__control.html#ga3762437e0b1402b5d4fd293ae745f103", null ],
[ "ARM_SAI_PROTOCOL_PCM_LONG", "group__sai__protocol__control.html#gad43530c5b6ae1e89db587b20d71440b4", null ],
[ "ARM_SAI_PROTOCOL_AC97", "group__sai__protocol__control.html#ga8b1669910f4db4bb3584543e7eb04d7a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__protocol__control.js | JavaScript | apache-2.0 | 849 |
<!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 Slot</title>
<title>CMSIS-Driver: SAI Slot</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__slot__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">SAI Slot<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines data slots.
<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:ga8f2cf3a212ca7fe389e00b082efb5d0b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__slot__control.html#ga8f2cf3a212ca7fe389e00b082efb5d0b">ARM_SAI_SLOT_COUNT</a>(n)   ((((n)-1)&0x1FU) << ARM_SAI_SLOT_COUNT_Pos)</td></tr>
<tr class="memdesc:ga8f2cf3a212ca7fe389e00b082efb5d0b"><td class="mdescLeft"> </td><td class="mdescRight">Number of slots in frame (1..32); default=1; User Protocol only (ignored otherwise) <a href="#ga8f2cf3a212ca7fe389e00b082efb5d0b">More...</a><br/></td></tr>
<tr class="separator:ga8f2cf3a212ca7fe389e00b082efb5d0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad77c6c0de2a4e7223a0c42e1594f0a2c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__slot__control.html#gad77c6c0de2a4e7223a0c42e1594f0a2c">ARM_SAI_SLOT_SIZE_DEFAULT</a>   (0U << ARM_SAI_SLOT_SIZE_Pos)</td></tr>
<tr class="memdesc:gad77c6c0de2a4e7223a0c42e1594f0a2c"><td class="mdescLeft"> </td><td class="mdescRight">Slot size is equal to data size (default) <a href="#gad77c6c0de2a4e7223a0c42e1594f0a2c">More...</a><br/></td></tr>
<tr class="separator:gad77c6c0de2a4e7223a0c42e1594f0a2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2bb9cf53b07cac81fb0fe71de6c97c83"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__slot__control.html#ga2bb9cf53b07cac81fb0fe71de6c97c83">ARM_SAI_SLOT_SIZE_16</a>   (1U << ARM_SAI_SLOT_SIZE_Pos)</td></tr>
<tr class="memdesc:ga2bb9cf53b07cac81fb0fe71de6c97c83"><td class="mdescLeft"> </td><td class="mdescRight">Slot size = 16 bits; User Protocol only (ignored otherwise) <a href="#ga2bb9cf53b07cac81fb0fe71de6c97c83">More...</a><br/></td></tr>
<tr class="separator:ga2bb9cf53b07cac81fb0fe71de6c97c83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaa5c4cc18a0f5668bc9f117874cd83dd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__slot__control.html#gaaa5c4cc18a0f5668bc9f117874cd83dd">ARM_SAI_SLOT_SIZE_32</a>   (3U << ARM_SAI_SLOT_SIZE_Pos)</td></tr>
<tr class="memdesc:gaaa5c4cc18a0f5668bc9f117874cd83dd"><td class="mdescLeft"> </td><td class="mdescRight">Slot size = 32 bits; User Protocol only (ignored otherwise) <a href="#gaaa5c4cc18a0f5668bc9f117874cd83dd">More...</a><br/></td></tr>
<tr class="separator:gaaa5c4cc18a0f5668bc9f117874cd83dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48d4a142f3a1bb0fa4e88c9e427932a0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__slot__control.html#ga48d4a142f3a1bb0fa4e88c9e427932a0">ARM_SAI_SLOT_OFFSET</a>(n)   (((n)&0x1FU) << ARM_SAI_SLOT_OFFSET_Pos)</td></tr>
<tr class="memdesc:ga48d4a142f3a1bb0fa4e88c9e427932a0"><td class="mdescLeft"> </td><td class="mdescRight">Offset of first data bit in slot (0..31); default=0; User Protocol only (ignored otherwise) <a href="#ga48d4a142f3a1bb0fa4e88c9e427932a0">More...</a><br/></td></tr>
<tr class="separator:ga48d4a142f3a1bb0fa4e88c9e427932a0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines data slots. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga8f2cf3a212ca7fe389e00b082efb5d0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_SLOT_COUNT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   ((((n)-1)&0x1FU) << ARM_SAI_SLOT_COUNT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of slots in frame (1..32); default=1; User Protocol only (ignored otherwise) </p>
</div>
</div>
<a class="anchor" id="gad77c6c0de2a4e7223a0c42e1594f0a2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_SLOT_SIZE_DEFAULT   (0U << ARM_SAI_SLOT_SIZE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Slot size is equal to data size (default) </p>
</div>
</div>
<a class="anchor" id="ga2bb9cf53b07cac81fb0fe71de6c97c83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_SLOT_SIZE_16   (1U << ARM_SAI_SLOT_SIZE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Slot size = 16 bits; User Protocol only (ignored otherwise) </p>
</div>
</div>
<a class="anchor" id="gaaa5c4cc18a0f5668bc9f117874cd83dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_SLOT_SIZE_32   (3U << ARM_SAI_SLOT_SIZE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Slot size = 32 bits; User Protocol only (ignored otherwise) </p>
</div>
</div>
<a class="anchor" id="ga48d4a142f3a1bb0fa4e88c9e427932a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_SLOT_OFFSET</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   (((n)&0x1FU) << ARM_SAI_SLOT_OFFSET_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Offset of first data bit in slot (0..31); default=0; User Protocol only (ignored otherwise) </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__slot__control.html | HTML | apache-2.0 | 12,672 |
var group__sai__slot__control =
[
[ "ARM_SAI_SLOT_COUNT", "group__sai__slot__control.html#ga8f2cf3a212ca7fe389e00b082efb5d0b", null ],
[ "ARM_SAI_SLOT_SIZE_DEFAULT", "group__sai__slot__control.html#gad77c6c0de2a4e7223a0c42e1594f0a2c", null ],
[ "ARM_SAI_SLOT_SIZE_16", "group__sai__slot__control.html#ga2bb9cf53b07cac81fb0fe71de6c97c83", null ],
[ "ARM_SAI_SLOT_SIZE_32", "group__sai__slot__control.html#gaaa5c4cc18a0f5668bc9f117874cd83dd", null ],
[ "ARM_SAI_SLOT_OFFSET", "group__sai__slot__control.html#ga48d4a142f3a1bb0fa4e88c9e427932a0", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__slot__control.js | JavaScript | apache-2.0 | 572 |
<!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 Synchronization</title>
<title>CMSIS-Driver: SAI Synchronization</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__sync__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">SAI Synchronization<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines Transmitter/Receiver synchronization.
<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:gad123537cb6ab9eefd6feab193ed74655"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__sync__control.html#gad123537cb6ab9eefd6feab193ed74655">ARM_SAI_ASYNCHRONOUS</a>   (0U << ARM_SAI_SYNCHRONIZATION_Pos)</td></tr>
<tr class="memdesc:gad123537cb6ab9eefd6feab193ed74655"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous (default) <a href="#gad123537cb6ab9eefd6feab193ed74655">More...</a><br/></td></tr>
<tr class="separator:gad123537cb6ab9eefd6feab193ed74655"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad2ad5406c30c353e80f54b40b3de5db8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__sync__control.html#gad2ad5406c30c353e80f54b40b3de5db8">ARM_SAI_SYNCHRONOUS</a>   (1U << ARM_SAI_SYNCHRONIZATION_Pos)</td></tr>
<tr class="memdesc:gad2ad5406c30c353e80f54b40b3de5db8"><td class="mdescLeft"> </td><td class="mdescRight">Synchronous. <a href="#gad2ad5406c30c353e80f54b40b3de5db8">More...</a><br/></td></tr>
<tr class="separator:gad2ad5406c30c353e80f54b40b3de5db8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines Transmitter/Receiver synchronization. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad123537cb6ab9eefd6feab193ed74655"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_ASYNCHRONOUS   (0U << ARM_SAI_SYNCHRONIZATION_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Asynchronous (default) </p>
</div>
</div>
<a class="anchor" id="gad2ad5406c30c353e80f54b40b3de5db8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SAI_SYNCHRONOUS   (1U << ARM_SAI_SYNCHRONIZATION_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronous. </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__sync__control.html | HTML | apache-2.0 | 8,879 |
var group__sai__sync__control =
[
[ "ARM_SAI_ASYNCHRONOUS", "group__sai__sync__control.html#gad123537cb6ab9eefd6feab193ed74655", null ],
[ "ARM_SAI_SYNCHRONOUS", "group__sai__sync__control.html#gad2ad5406c30c353e80f54b40b3de5db8", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__sai__sync__control.js | JavaScript | apache-2.0 | 248 |
<!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 Bit Order</title>
<title>CMSIS-Driver: SPI Bit Order</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__bit__order__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">SPI Bit Order<div class="ingroups"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the bit order.
<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:ga98228a708cbab6e214c7ac696f77dab6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__bit__order__ctrls.html#ga98228a708cbab6e214c7ac696f77dab6">ARM_SPI_MSB_LSB</a>   (0UL << ARM_SPI_BIT_ORDER_Pos)</td></tr>
<tr class="memdesc:ga98228a708cbab6e214c7ac696f77dab6"><td class="mdescLeft"> </td><td class="mdescRight">SPI Bit order from MSB to LSB (default) <a href="#ga98228a708cbab6e214c7ac696f77dab6">More...</a><br/></td></tr>
<tr class="separator:ga98228a708cbab6e214c7ac696f77dab6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga41c53c3b396a89ce78018467e561aaaf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__bit__order__ctrls.html#ga41c53c3b396a89ce78018467e561aaaf">ARM_SPI_LSB_MSB</a>   (1UL << ARM_SPI_BIT_ORDER_Pos)</td></tr>
<tr class="memdesc:ga41c53c3b396a89ce78018467e561aaaf"><td class="mdescLeft"> </td><td class="mdescRight">SPI Bit order from LSB to MSB. <a href="#ga41c53c3b396a89ce78018467e561aaaf">More...</a><br/></td></tr>
<tr class="separator:ga41c53c3b396a89ce78018467e561aaaf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the bit order. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga98228a708cbab6e214c7ac696f77dab6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MSB_LSB   (0UL << ARM_SPI_BIT_ORDER_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Bit order from MSB to LSB (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga41c53c3b396a89ce78018467e561aaaf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_LSB_MSB   (1UL << ARM_SPI_BIT_ORDER_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Bit order from LSB to MSB. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_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__spi__bit__order__ctrls.html | HTML | apache-2.0 | 9,238 |
var group__spi__bit__order__ctrls =
[
[ "ARM_SPI_MSB_LSB", "group__spi__bit__order__ctrls.html#ga98228a708cbab6e214c7ac696f77dab6", null ],
[ "ARM_SPI_LSB_MSB", "group__spi__bit__order__ctrls.html#ga41c53c3b396a89ce78018467e561aaaf", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__bit__order__ctrls.js | JavaScript | apache-2.0 | 251 |
<!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 Data Bits</title>
<title>CMSIS-Driver: SPI Data Bits</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__data__bits__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">SPI Data Bits<div class="ingroups"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the number of data bits.
<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:gaf6c099a1d67256a32010120c66c55250"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__data__bits__ctrls.html#gaf6c099a1d67256a32010120c66c55250">ARM_SPI_DATA_BITS</a>(n)   (((n) & 0x3F) << ARM_SPI_DATA_BITS_Pos)</td></tr>
<tr class="memdesc:gaf6c099a1d67256a32010120c66c55250"><td class="mdescLeft"> </td><td class="mdescRight">Number of Data bits. <a href="#gaf6c099a1d67256a32010120c66c55250">More...</a><br/></td></tr>
<tr class="separator:gaf6c099a1d67256a32010120c66c55250"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the number of data bits. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf6c099a1d67256a32010120c66c55250"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_DATA_BITS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n</td><td>)</td>
<td>   (((n) & 0x3F) << ARM_SPI_DATA_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of Data bits. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_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__spi__data__bits__ctrls.html | HTML | apache-2.0 | 8,150 |
var group__spi__data__bits__ctrls =
[
[ "ARM_SPI_DATA_BITS", "group__spi__data__bits__ctrls.html#gaf6c099a1d67256a32010120c66c55250", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__data__bits__ctrls.js | JavaScript | apache-2.0 | 147 |
<!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__spi__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__spi__interface__gr.html">SPI Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Negative values indicate errors (SPI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</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:ga273a55c5d19491c565e5f05d03d66f3f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#ga273a55c5d19491c565e5f05d03d66f3f">ARM_SPI_ERROR_MODE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
<tr class="memdesc:ga273a55c5d19491c565e5f05d03d66f3f"><td class="mdescLeft"> </td><td class="mdescRight">Specified Mode not supported. <a href="#ga273a55c5d19491c565e5f05d03d66f3f">More...</a><br/></td></tr>
<tr class="separator:ga273a55c5d19491c565e5f05d03d66f3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac47584fe5691889c056611bc589b25aa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#gac47584fe5691889c056611bc589b25aa">ARM_SPI_ERROR_FRAME_FORMAT</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td></tr>
<tr class="memdesc:gac47584fe5691889c056611bc589b25aa"><td class="mdescLeft"> </td><td class="mdescRight">Specified Frame Format not supported. <a href="#gac47584fe5691889c056611bc589b25aa">More...</a><br/></td></tr>
<tr class="separator:gac47584fe5691889c056611bc589b25aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga76f895d3380ca474124f83acbebc5651"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#ga76f895d3380ca474124f83acbebc5651">ARM_SPI_ERROR_DATA_BITS</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td></tr>
<tr class="memdesc:ga76f895d3380ca474124f83acbebc5651"><td class="mdescLeft"> </td><td class="mdescRight">Specified number of Data bits not supported. <a href="#ga76f895d3380ca474124f83acbebc5651">More...</a><br/></td></tr>
<tr class="separator:ga76f895d3380ca474124f83acbebc5651"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6b8ac31930ea6ca3a9635f2ac935466d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#ga6b8ac31930ea6ca3a9635f2ac935466d">ARM_SPI_ERROR_BIT_ORDER</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td></tr>
<tr class="memdesc:ga6b8ac31930ea6ca3a9635f2ac935466d"><td class="mdescLeft"> </td><td class="mdescRight">Specified Bit order not supported. <a href="#ga6b8ac31930ea6ca3a9635f2ac935466d">More...</a><br/></td></tr>
<tr class="separator:ga6b8ac31930ea6ca3a9635f2ac935466d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae7b1a1feb46faa1830c92b73bd775ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html#gaae7b1a1feb46faa1830c92b73bd775ad">ARM_SPI_ERROR_SS_MODE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td></tr>
<tr class="memdesc:gaae7b1a1feb46faa1830c92b73bd775ad"><td class="mdescLeft"> </td><td class="mdescRight">Specified Slave Select Mode not supported. <a href="#gaae7b1a1feb46faa1830c92b73bd775ad">More...</a><br/></td></tr>
<tr class="separator:gaae7b1a1feb46faa1830c92b73bd775ad"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Negative values indicate errors (SPI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). </p>
<p>The SPI driver has additional status error codes that are listed below. Note that the SPI driver also returns the comon <a class="el" href="group__execution__status.html">Status Error Codes</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga273a55c5d19491c565e5f05d03d66f3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_ERROR_MODE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Mode not supported. </p>
<p>The <b>mode</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gac47584fe5691889c056611bc589b25aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_ERROR_FRAME_FORMAT   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Frame Format not supported. </p>
<p>The <b>frame format</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="ga76f895d3380ca474124f83acbebc5651"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_ERROR_DATA_BITS   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified number of Data bits not supported. </p>
<p>The number of <b>data bits</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="ga6b8ac31930ea6ca3a9635f2ac935466d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_ERROR_BIT_ORDER   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Bit order not supported. </p>
<p>The <b>bit order</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gaae7b1a1feb46faa1830c92b73bd775ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_ERROR_SS_MODE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Slave Select Mode not supported. </p>
<p>The <b>slave select mode</b> requested with the function <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> is not supported by this driver. </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__execution__status.html | HTML | apache-2.0 | 14,433 |
var group__spi__execution__status =
[
[ "ARM_SPI_ERROR_MODE", "group__spi__execution__status.html#ga273a55c5d19491c565e5f05d03d66f3f", null ],
[ "ARM_SPI_ERROR_FRAME_FORMAT", "group__spi__execution__status.html#gac47584fe5691889c056611bc589b25aa", null ],
[ "ARM_SPI_ERROR_DATA_BITS", "group__spi__execution__status.html#ga76f895d3380ca474124f83acbebc5651", null ],
[ "ARM_SPI_ERROR_BIT_ORDER", "group__spi__execution__status.html#ga6b8ac31930ea6ca3a9635f2ac935466d", null ],
[ "ARM_SPI_ERROR_SS_MODE", "group__spi__execution__status.html#gaae7b1a1feb46faa1830c92b73bd775ad", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__execution__status.js | JavaScript | apache-2.0 | 605 |
<!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 Frame Format</title>
<title>CMSIS-Driver: SPI Frame Format</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__frame__format__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">SPI Frame Format<div class="ingroups"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the frame format.
<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:gab4ac9a609c078d1e8332cf95da34e50e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html#gab4ac9a609c078d1e8332cf95da34e50e">ARM_SPI_CPOL0_CPHA0</a>   (0UL << ARM_SPI_FRAME_FORMAT_Pos)</td></tr>
<tr class="memdesc:gab4ac9a609c078d1e8332cf95da34e50e"><td class="mdescLeft"> </td><td class="mdescRight">Clock Polarity 0, Clock Phase 0 (default) <a href="#gab4ac9a609c078d1e8332cf95da34e50e">More...</a><br/></td></tr>
<tr class="separator:gab4ac9a609c078d1e8332cf95da34e50e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5498eb08c2ba8de2e1c2801428e79d71"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html#ga5498eb08c2ba8de2e1c2801428e79d71">ARM_SPI_CPOL0_CPHA1</a>   (1UL << ARM_SPI_FRAME_FORMAT_Pos)</td></tr>
<tr class="memdesc:ga5498eb08c2ba8de2e1c2801428e79d71"><td class="mdescLeft"> </td><td class="mdescRight">Clock Polarity 0, Clock Phase 1. <a href="#ga5498eb08c2ba8de2e1c2801428e79d71">More...</a><br/></td></tr>
<tr class="separator:ga5498eb08c2ba8de2e1c2801428e79d71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga67193d9b5af1ec312a66d007c33b597f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html#ga67193d9b5af1ec312a66d007c33b597f">ARM_SPI_CPOL1_CPHA0</a>   (2UL << ARM_SPI_FRAME_FORMAT_Pos)</td></tr>
<tr class="memdesc:ga67193d9b5af1ec312a66d007c33b597f"><td class="mdescLeft"> </td><td class="mdescRight">Clock Polarity 1, Clock Phase 0. <a href="#ga67193d9b5af1ec312a66d007c33b597f">More...</a><br/></td></tr>
<tr class="separator:ga67193d9b5af1ec312a66d007c33b597f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7fab572b2fec303e979e47eb2d13ca74"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html#ga7fab572b2fec303e979e47eb2d13ca74">ARM_SPI_CPOL1_CPHA1</a>   (3UL << ARM_SPI_FRAME_FORMAT_Pos)</td></tr>
<tr class="memdesc:ga7fab572b2fec303e979e47eb2d13ca74"><td class="mdescLeft"> </td><td class="mdescRight">Clock Polarity 1, Clock Phase 1. <a href="#ga7fab572b2fec303e979e47eb2d13ca74">More...</a><br/></td></tr>
<tr class="separator:ga7fab572b2fec303e979e47eb2d13ca74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga225185710ba38848a489013ba4475915"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html#ga225185710ba38848a489013ba4475915">ARM_SPI_TI_SSI</a>   (4UL << ARM_SPI_FRAME_FORMAT_Pos)</td></tr>
<tr class="memdesc:ga225185710ba38848a489013ba4475915"><td class="mdescLeft"> </td><td class="mdescRight">Texas Instruments Frame Format. <a href="#ga225185710ba38848a489013ba4475915">More...</a><br/></td></tr>
<tr class="separator:ga225185710ba38848a489013ba4475915"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga44f481d32b9a9ea93673f05af82ccf86"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__frame__format__ctrls.html#ga44f481d32b9a9ea93673f05af82ccf86">ARM_SPI_MICROWIRE</a>   (5UL << ARM_SPI_FRAME_FORMAT_Pos)</td></tr>
<tr class="memdesc:ga44f481d32b9a9ea93673f05af82ccf86"><td class="mdescLeft"> </td><td class="mdescRight">National Microwire Frame Format. <a href="#ga44f481d32b9a9ea93673f05af82ccf86">More...</a><br/></td></tr>
<tr class="separator:ga44f481d32b9a9ea93673f05af82ccf86"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the frame format. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gab4ac9a609c078d1e8332cf95da34e50e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_CPOL0_CPHA0   (0UL << ARM_SPI_FRAME_FORMAT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clock Polarity 0, Clock Phase 0 (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5498eb08c2ba8de2e1c2801428e79d71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_CPOL0_CPHA1   (1UL << ARM_SPI_FRAME_FORMAT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clock Polarity 0, Clock Phase 1. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga67193d9b5af1ec312a66d007c33b597f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_CPOL1_CPHA0   (2UL << ARM_SPI_FRAME_FORMAT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clock Polarity 1, Clock Phase 0. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7fab572b2fec303e979e47eb2d13ca74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_CPOL1_CPHA1   (3UL << ARM_SPI_FRAME_FORMAT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clock Polarity 1, Clock Phase 1. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga225185710ba38848a489013ba4475915"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_TI_SSI   (4UL << ARM_SPI_FRAME_FORMAT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Texas Instruments Frame Format. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga44f481d32b9a9ea93673f05af82ccf86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MICROWIRE   (5UL << ARM_SPI_FRAME_FORMAT_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>National Microwire Frame Format. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_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__spi__frame__format__ctrls.html | HTML | apache-2.0 | 14,314 |
var group__spi__frame__format__ctrls =
[
[ "ARM_SPI_CPOL0_CPHA0", "group__spi__frame__format__ctrls.html#gab4ac9a609c078d1e8332cf95da34e50e", null ],
[ "ARM_SPI_CPOL0_CPHA1", "group__spi__frame__format__ctrls.html#ga5498eb08c2ba8de2e1c2801428e79d71", null ],
[ "ARM_SPI_CPOL1_CPHA0", "group__spi__frame__format__ctrls.html#ga67193d9b5af1ec312a66d007c33b597f", null ],
[ "ARM_SPI_CPOL1_CPHA1", "group__spi__frame__format__ctrls.html#ga7fab572b2fec303e979e47eb2d13ca74", null ],
[ "ARM_SPI_TI_SSI", "group__spi__frame__format__ctrls.html#ga225185710ba38848a489013ba4475915", null ],
[ "ARM_SPI_MICROWIRE", "group__spi__frame__format__ctrls.html#ga44f481d32b9a9ea93673f05af82ccf86", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__frame__format__ctrls.js | JavaScript | apache-2.0 | 713 |
<!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 Interface</title>
<title>CMSIS-Driver: SPI 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__spi__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">SPI Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for SPI Bus Peripheral (Driver_SPI.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__spi__execution__status"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__execution__status.html">Status Error Codes</a></td></tr>
<tr class="memdesc:group__spi__execution__status"><td class="mdescLeft"> </td><td class="mdescRight">Negative values indicate errors (SPI has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__SPI__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__events.html">SPI Events</a></td></tr>
<tr class="memdesc:group__SPI__events"><td class="mdescLeft"> </td><td class="mdescRight">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>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__SPI__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></td></tr>
<tr class="memdesc:group__SPI__control"><td class="mdescLeft"> </td><td class="mdescRight">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. <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__SPI"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a></td></tr>
<tr class="memdesc:structARM__DRIVER__SPI"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the SPI Driver. <a href="group__spi__interface__gr.html#structARM__DRIVER__SPI">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__SPI"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__SPI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__SPI__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">SPI Driver Capabilities. <a href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__SPI__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__SPI__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__STATUS">ARM_SPI_STATUS</a></td></tr>
<tr class="memdesc:structARM__SPI__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">SPI Status. <a href="group__spi__interface__gr.html#structARM__SPI__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__SPI__STATUS"><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:gafde9205364241ee81290adc0481c6640"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640">ARM_SPI_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:gafde9205364241ee81290adc0481c6640"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a> : Signal SPI Event. <a href="#gafde9205364241ee81290adc0481c6640">More...</a><br/></td></tr>
<tr class="separator:gafde9205364241ee81290adc0481c6640"><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:gad5db9209ef1d64a7915a7278d6a402c8"><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__spi__interface__gr.html#gad5db9209ef1d64a7915a7278d6a402c8">ARM_SPI_GetVersion</a> (void)</td></tr>
<tr class="memdesc:gad5db9209ef1d64a7915a7278d6a402c8"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#gad5db9209ef1d64a7915a7278d6a402c8">More...</a><br/></td></tr>
<tr class="separator:gad5db9209ef1d64a7915a7278d6a402c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf4823a11ab5efcd47c79b13801513ddc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#gaf4823a11ab5efcd47c79b13801513ddc">ARM_SPI_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:gaf4823a11ab5efcd47c79b13801513ddc"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#gaf4823a11ab5efcd47c79b13801513ddc">More...</a><br/></td></tr>
<tr class="separator:gaf4823a11ab5efcd47c79b13801513ddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1a3c11ed523a4355cd91069527945906"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906">ARM_SPI_Initialize</a> (<a class="el" href="group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640">ARM_SPI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ga1a3c11ed523a4355cd91069527945906"><td class="mdescLeft"> </td><td class="mdescRight">Initialize SPI Interface. <a href="#ga1a3c11ed523a4355cd91069527945906">More...</a><br/></td></tr>
<tr class="separator:ga1a3c11ed523a4355cd91069527945906"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0c480ee3eabb82fc746e89741ed2e03e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ga0c480ee3eabb82fc746e89741ed2e03e">ARM_SPI_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:ga0c480ee3eabb82fc746e89741ed2e03e"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize SPI Interface. <a href="#ga0c480ee3eabb82fc746e89741ed2e03e">More...</a><br/></td></tr>
<tr class="separator:ga0c480ee3eabb82fc746e89741ed2e03e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1a1e7e80ea32ae381b75213c32aa8067"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ga1a1e7e80ea32ae381b75213c32aa8067">ARM_SPI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga1a1e7e80ea32ae381b75213c32aa8067"><td class="mdescLeft"> </td><td class="mdescRight">Control SPI Interface Power. <a href="#ga1a1e7e80ea32ae381b75213c32aa8067">More...</a><br/></td></tr>
<tr class="separator:ga1a1e7e80ea32ae381b75213c32aa8067"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab2a303d1071e926280d50682f4808479"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479">ARM_SPI_Send</a> (const void *data, uint32_t num)</td></tr>
<tr class="memdesc:gab2a303d1071e926280d50682f4808479"><td class="mdescLeft"> </td><td class="mdescRight">Start sending data to SPI transmitter. <a href="#gab2a303d1071e926280d50682f4808479">More...</a><br/></td></tr>
<tr class="separator:gab2a303d1071e926280d50682f4808479"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga726aff54e782ed9b47f7ba1280a3d8f6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6">ARM_SPI_Receive</a> (void *data, uint32_t num)</td></tr>
<tr class="memdesc:ga726aff54e782ed9b47f7ba1280a3d8f6"><td class="mdescLeft"> </td><td class="mdescRight">Start receiving data from SPI receiver. <a href="#ga726aff54e782ed9b47f7ba1280a3d8f6">More...</a><br/></td></tr>
<tr class="separator:ga726aff54e782ed9b47f7ba1280a3d8f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa24026b3822c10272e301f1505136ec2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2">ARM_SPI_Transfer</a> (const void *data_out, void *data_in, uint32_t num)</td></tr>
<tr class="memdesc:gaa24026b3822c10272e301f1505136ec2"><td class="mdescLeft"> </td><td class="mdescRight">Start sending/receiving data to/from SPI transmitter/receiver. <a href="#gaa24026b3822c10272e301f1505136ec2">More...</a><br/></td></tr>
<tr class="separator:gaa24026b3822c10272e301f1505136ec2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaaecaaf4ec1922f22e7f9de63af5ccdb"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb">ARM_SPI_GetDataCount</a> (void)</td></tr>
<tr class="memdesc:gaaaecaaf4ec1922f22e7f9de63af5ccdb"><td class="mdescLeft"> </td><td class="mdescRight">Get transferred data count. <a href="#gaaaecaaf4ec1922f22e7f9de63af5ccdb">More...</a><br/></td></tr>
<tr class="separator:gaaaecaaf4ec1922f22e7f9de63af5ccdb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad18d229992598d6677bec250015e5d1a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> (uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:gad18d229992598d6677bec250015e5d1a"><td class="mdescLeft"> </td><td class="mdescRight">Control SPI Interface. <a href="#gad18d229992598d6677bec250015e5d1a">More...</a><br/></td></tr>
<tr class="separator:gad18d229992598d6677bec250015e5d1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60d33d8788a76c388cc36e066240b817"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__STATUS">ARM_SPI_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga60d33d8788a76c388cc36e066240b817"><td class="mdescLeft"> </td><td class="mdescRight">Get SPI status. <a href="#ga60d33d8788a76c388cc36e066240b817">More...</a><br/></td></tr>
<tr class="separator:ga60d33d8788a76c388cc36e066240b817"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga505b2d787348d51351d38fee98ccba7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:ga505b2d787348d51351d38fee98ccba7e"><td class="mdescLeft"> </td><td class="mdescRight">Signal SPI Events. <a href="#ga505b2d787348d51351d38fee98ccba7e">More...</a><br/></td></tr>
<tr class="separator:ga505b2d787348d51351d38fee98ccba7e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for SPI Bus Peripheral (Driver_SPI.h) </p>
<p>The <b>Serial Peripheral Interface Bus</b> (SPI) implements a synchronous serial bus for data exchange. In microcontroller (MCU) applications, the interface is often used to connect peripheral components at board (PCB) level. SPI devices can operate as Master (SCLK and SS are outputs) or Slave (SCLK and SS are inputs). Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus" target="_blank"><b>Serial Peripheral Interface Bus</b></a>.</p>
<p><b>Block Diagram</b></p>
<p>The SPI Driver API defines a <b>SPI</b> interface for middleware components. The SPI Driver supports multiple slaves, but if only one slave is connected, then the Slave Select signal can be omitted.</p>
<div class="image">
<img src="SPI_Master1Slaves.png" alt="SPI_Master1Slaves.png"/>
<div class="caption">
SPI Master connected to a single slave</div></div>
<p> </p>
<div class="image">
<img src="SPI_Master3Slaves.png" alt="SPI_Master3Slaves.png"/>
<div class="caption">
SPI Master connected to 3 slaves</div></div>
<p> The SPI Driver functions control the following SPI signal lines.</p>
<table class="doxtable">
<tr>
<th>Signal </th><th>Name </th><th>Description </th></tr>
<tr>
<td>SS </td><td>Slave Select (active low) </td><td>Selects the slave. This signal can be part of the SPI peripheral or implemented using a GPIO pin. </td></tr>
<tr>
<td>MOSI </td><td>Master Out, Slave In </td><td>MOSI output of the Master connects to MOSI input of the Slave. </td></tr>
<tr>
<td>SCLK </td><td>Serial Clock </td><td>Serial clock output from Master. Controls the transfer speed and when data are sent and read. </td></tr>
<tr>
<td>MISO </td><td>Master In, Slave Out </td><td>MISO input of the Master connects to MISO output of the Slave. </td></tr>
</table>
<p><b>SPI API</b></p>
<p>The following header files define the Application Programming Interface (API) for the SPI interface:</p>
<ul>
<li><b>Driver_SPI.h</b> : Driver API for SPI 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__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a> : access struct for SPI driver functions</li>
</ul>
<p><b>Example Code</b></p>
<p>The following example code shows the usage of the SPI interface.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__SPI_8h.html">Driver_SPI.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include "cmsis_os.h"</span> <span class="comment">// ARM::CMSIS:RTOS:Keil RTX</span></div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> mySPI_Thread(<span class="keywordtype">void</span> <span class="keyword">const</span> *argument);</div>
<div class="line">osThreadId tid_mySPI_Thread;</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="comment">/* SPI Driver */</span></div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a> Driver_SPI0;</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> mySPI_callback(uint32_t event)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">switch</span> (event)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a>:</div>
<div class="line"> <span class="comment">/* Success: Wakeup Thread */</span></div>
<div class="line"> osSignalSet(tid_mySPI_Thread, 0x01);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244">ARM_SPI_EVENT_DATA_LOST</a>:</div>
<div class="line"> <span class="comment">/* Occurs in slave mode when data is requested/sent by master</span></div>
<div class="line"><span class="comment"> but send/receive/transfer operation has not been started</span></div>
<div class="line"><span class="comment"> and indicates that data is lost. Occurs also in master mode</span></div>
<div class="line"><span class="comment"> when driver cannot transfer data fast enough. */</span></div>
<div class="line"> __breakpoint(0); <span class="comment">/* Error: Call debugger or replace with custom error handling */</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a>:</div>
<div class="line"> <span class="comment">/* Occurs in master mode when Slave Select is deactivated and</span></div>
<div class="line"><span class="comment"> indicates Master Mode Fault. */</span></div>
<div class="line"> __breakpoint(0); <span class="comment">/* Error: Call debugger or replace with custom error handling */</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Test data buffers */</span></div>
<div class="line"><span class="keyword">const</span> uint8_t testdata_out[8] = { 0, 1, 2, 3, 4, 5, 6, 7 }; </div>
<div class="line">uint8_t testdata_in [8];</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> mySPI_Thread(<span class="keywordtype">void</span> <span class="keyword">const</span>* arg)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a>* SPIdrv = &Driver_SPI0;</div>
<div class="line"> osEvent evt;</div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#ifdef DEBUG</span></div>
<div class="line"><span class="preprocessor"></span> <a class="code" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> version;</div>
<div class="line"> <a class="code" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> version = SPIdrv-><a class="code" href="group__spi__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> < 0x200) <span class="comment">/* requires at minimum API version 2.00 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 class="line"> drv_capabilities = SPIdrv-><a class="code" href="group__spi__interface__gr.html#a065b5fc24d0204692f0f95a44351ac1e">GetCapabilities</a>();</div>
<div class="line"> <span class="keywordflow">if</span> (drv_capabilities.<a class="code" href="group__spi__interface__gr.html#a309619714f0c4febaa497ebdb9b7e3ca">event_mode_fault</a> == 0)</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"><span class="preprocessor">#endif</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"> <span class="comment">/* Initialize the SPI driver */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#afac50d0b28860f7b569293e6b713f8a4">Initialize</a>(mySPI_callback);</div>
<div class="line"> <span class="comment">/* Power up the SPI peripheral */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a>(<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> <span class="comment">/* Configure the SPI to Master, 8-bit mode @10000 kBits/sec */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__mode__ctrls.html#ga3143ef07c1607b9bc57e29df35cf2fa8">ARM_SPI_MODE_MASTER</a> | <a class="code" href="group__spi__frame__format__ctrls.html#ga7fab572b2fec303e979e47eb2d13ca74">ARM_SPI_CPOL1_CPHA1</a> | <a class="code" href="group__spi__bit__order__ctrls.html#ga98228a708cbab6e214c7ac696f77dab6">ARM_SPI_MSB_LSB</a> | <a class="code" href="group__spi__slave__select__mode__ctrls.html#gab5e319aa3f9d4d8c9ed92f0fe865f624">ARM_SPI_SS_MASTER_SW</a> | <a class="code" href="group__spi__data__bits__ctrls.html#gaf6c099a1d67256a32010120c66c55250">ARM_SPI_DATA_BITS</a>(8), 10000000);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* SS line = INACTIVE = HIGH */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="code" href="Driver__SPI_8h.html#a335b448e07422e9c25616a693ec581cc">ARM_SPI_SS_INACTIVE</a>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* thread loop */</span></div>
<div class="line"> <span class="keywordflow">while</span> (1)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">/* SS line = ACTIVE = LOW */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="code" href="Driver__SPI_8h.html#a3f465cdbd1238ddd74f78e14457076c4">ARM_SPI_SS_ACTIVE</a>);</div>
<div class="line"> <span class="comment">/* Transmit some data */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922">Send</a>(testdata_out, <span class="keyword">sizeof</span>(testdata_out));</div>
<div class="line"> <span class="comment">/* Wait for completion */</span></div>
<div class="line"> evt = osSignalWait(0x01, 100);</div>
<div class="line"> <span class="keywordflow">if</span> (evt.status == osEventTimeout) {</div>
<div class="line"> __breakpoint(0); <span class="comment">/* Timeout error: Call debugger */</span></div>
<div class="line"> }</div>
<div class="line"> <span class="comment">/* SS line = INACTIVE = HIGH */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="code" href="Driver__SPI_8h.html#a335b448e07422e9c25616a693ec581cc">ARM_SPI_SS_INACTIVE</a>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* SS line = ACTIVE = LOW */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="code" href="Driver__SPI_8h.html#a3f465cdbd1238ddd74f78e14457076c4">ARM_SPI_SS_ACTIVE</a>);</div>
<div class="line"> <span class="comment">/* Receive 8 bytes of reply */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3">Receive</a>(testdata_in, 8);</div>
<div class="line"> evt = osSignalWait(0x01, 100);</div>
<div class="line"> <span class="keywordflow">if</span> (evt.status == osEventTimeout) {</div>
<div class="line"> __breakpoint(0); <span class="comment">/* Timeout error: Call debugger */</span></div>
<div class="line"> }</div>
<div class="line"> <span class="comment">/* SS line = INACTIVE = HIGH */</span></div>
<div class="line"> SPIdrv-><a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="code" href="Driver__SPI_8h.html#a335b448e07422e9c25616a693ec581cc">ARM_SPI_SS_INACTIVE</a>);</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__SPI" id="structARM__DRIVER__SPI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_SPI</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the SPI Driver. </p>
<p>The functions of the SPI driver 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 SPI interface 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_SPI0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_SPI1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_SPI<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__spi__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__spi__interface__gr.html#gad5db9209ef1d64a7915a7278d6a402c8">ARM_SPI_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:a065b5fc24d0204692f0f95a44351ac1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#a065b5fc24d0204692f0f95a44351ac1e">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a065b5fc24d0204692f0f95a44351ac1e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#gaf4823a11ab5efcd47c79b13801513ddc">ARM_SPI_GetCapabilities</a> : Get driver capabilities. <a href="#a065b5fc24d0204692f0f95a44351ac1e">More...</a><br/></td></tr>
<tr class="separator:a065b5fc24d0204692f0f95a44351ac1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afac50d0b28860f7b569293e6b713f8a4"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#afac50d0b28860f7b569293e6b713f8a4">Initialize</a> )(<a class="el" href="group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640">ARM_SPI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:afac50d0b28860f7b569293e6b713f8a4"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906">ARM_SPI_Initialize</a> : Initialize SPI Interface. <a href="#afac50d0b28860f7b569293e6b713f8a4">More...</a><br/></td></tr>
<tr class="separator:afac50d0b28860f7b569293e6b713f8a4"><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__spi__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__spi__interface__gr.html#ga0c480ee3eabb82fc746e89741ed2e03e">ARM_SPI_Uninitialize</a> : De-initialize SPI 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__spi__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__spi__interface__gr.html#ga1a1e7e80ea32ae381b75213c32aa8067">ARM_SPI_PowerControl</a> : Control SPI Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44eedddf4428cf4b98883b6c27d31922"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922">Send</a> )(const void *data, uint32_t num)</td></tr>
<tr class="memdesc:a44eedddf4428cf4b98883b6c27d31922"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479">ARM_SPI_Send</a> : Start sending data to SPI Interface. <a href="#a44eedddf4428cf4b98883b6c27d31922">More...</a><br/></td></tr>
<tr class="separator:a44eedddf4428cf4b98883b6c27d31922"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb9224a35fe16c92eb0dd103638e4cf3"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3">Receive</a> )(void *data, uint32_t num)</td></tr>
<tr class="memdesc:adb9224a35fe16c92eb0dd103638e4cf3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6">ARM_SPI_Receive</a> : Start receiving data from SPI Interface. <a href="#adb9224a35fe16c92eb0dd103638e4cf3">More...</a><br/></td></tr>
<tr class="separator:adb9224a35fe16c92eb0dd103638e4cf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad88b63ed74c03ba06b0599ab06ad4cf7"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ad88b63ed74c03ba06b0599ab06ad4cf7">Transfer</a> )(const void *data_out, void *data_in, uint32_t num)</td></tr>
<tr class="memdesc:ad88b63ed74c03ba06b0599ab06ad4cf7"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2">ARM_SPI_Transfer</a> : Start sending/receiving data to/from SPI. <a href="#ad88b63ed74c03ba06b0599ab06ad4cf7">More...</a><br/></td></tr>
<tr class="separator:ad88b63ed74c03ba06b0599ab06ad4cf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1d892ab3932f65cd7cdf2d0a91ae5da"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#ad1d892ab3932f65cd7cdf2d0a91ae5da">GetDataCount</a> )(void)</td></tr>
<tr class="memdesc:ad1d892ab3932f65cd7cdf2d0a91ae5da"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb">ARM_SPI_GetDataCount</a> : Get transferred data count. <a href="#ad1d892ab3932f65cd7cdf2d0a91ae5da">More...</a><br/></td></tr>
<tr class="separator:ad1d892ab3932f65cd7cdf2d0a91ae5da"><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__spi__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__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> : Control SPI Interface. <a href="#a6e0f47a92f626a971c5197fca6545505">More...</a><br/></td></tr>
<tr class="separator:a6e0f47a92f626a971c5197fca6545505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7305e7248420cdb4b02ceba87672178d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__STATUS">ARM_SPI_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__interface__gr.html#a7305e7248420cdb4b02ceba87672178d">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:a7305e7248420cdb4b02ceba87672178d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> : Get SPI status. <a href="#a7305e7248420cdb4b02ceba87672178d">More...</a><br/></td></tr>
<tr class="separator:a7305e7248420cdb4b02ceba87672178d"><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__spi__interface__gr.html#gad5db9209ef1d64a7915a7278d6a402c8">ARM_SPI_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a065b5fc24d0204692f0f95a44351ac1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#gaf4823a11ab5efcd47c79b13801513ddc">ARM_SPI_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="afac50d0b28860f7b569293e6b713f8a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640">ARM_SPI_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906">ARM_SPI_Initialize</a> : Initialize SPI 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__spi__interface__gr.html#ga0c480ee3eabb82fc746e89741ed2e03e">ARM_SPI_Uninitialize</a> : De-initialize SPI 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__spi__interface__gr.html#ga1a1e7e80ea32ae381b75213c32aa8067">ARM_SPI_PowerControl</a> : Control SPI Interface Power. </p>
</div>
</div>
<a class="anchor" id="a44eedddf4428cf4b98883b6c27d31922"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Send)(const void *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479">ARM_SPI_Send</a> : Start sending data to SPI Interface. </p>
</div>
</div>
<a class="anchor" id="adb9224a35fe16c92eb0dd103638e4cf3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Receive)(void *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6">ARM_SPI_Receive</a> : Start receiving data from SPI Interface. </p>
</div>
</div>
<a class="anchor" id="ad88b63ed74c03ba06b0599ab06ad4cf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Transfer)(const void *data_out, void *data_in, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2">ARM_SPI_Transfer</a> : Start sending/receiving data to/from SPI. </p>
</div>
</div>
<a class="anchor" id="ad1d892ab3932f65cd7cdf2d0a91ae5da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetDataCount)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb">ARM_SPI_GetDataCount</a> : Get transferred data count. </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__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> : Control SPI Interface. </p>
</div>
</div>
<a class="anchor" id="a7305e7248420cdb4b02ceba87672178d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__STATUS">ARM_SPI_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> : Get SPI status. </p>
</div>
</div>
</div>
</div>
<a name="structARM__SPI__CAPABILITIES" id="structARM__SPI__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_SPI_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>SPI Driver Capabilities. </p>
<p>A SPI driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__spi__interface__gr.html#gaf4823a11ab5efcd47c79b13801513ddc">ARM_SPI_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af244e2c2facf6414e3886495ee6b40bc"></a>uint32_t</td>
<td class="fieldname">
simplex: 1</td>
<td class="fielddoc">
supports Simplex Mode (Master and Slave) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a8053c540e5d531b692224bdc2463f36a"></a>uint32_t</td>
<td class="fieldname">
ti_ssi: 1</td>
<td class="fielddoc">
supports TI Synchronous Serial Interface </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9b4e858eb1d414128994742bf121f94c"></a>uint32_t</td>
<td class="fieldname">
microwire: 1</td>
<td class="fielddoc">
supports Microwire Interface </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a309619714f0c4febaa497ebdb9b7e3ca"></a>uint32_t</td>
<td class="fieldname">
event_mode_fault: 1</td>
<td class="fielddoc">
Signal Mode Fault event: <a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 28</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__SPI__STATUS" id="structARM__SPI__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_SPI_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>SPI Status. </p>
<p>Structure with information about the status of the SPI. The data fields encode busy flag and error flags.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a50c88f3c1d787773e2ac1b59533f034a"></a>uint32_t</td>
<td class="fieldname">
busy: 1</td>
<td class="fielddoc">
Transmitter/Receiver busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9675630df67587ecd171c7ef12b9d22a"></a>uint32_t</td>
<td class="fieldname">
data_lost: 1</td>
<td class="fielddoc">
Data lost: Receive overflow / Transmit underflow (cleared on start of transfer operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aeaf54ec655b7a64b9e88578c5f39d4e3"></a>uint32_t</td>
<td class="fieldname">
mode_fault: 1</td>
<td class="fielddoc">
Mode fault detected; optional (cleared on start of transfer operation) </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>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gafde9205364241ee81290adc0481c6640"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_SPI_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a> : Signal SPI Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906">ARM_SPI_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad5db9209ef1d64a7915a7278d6a402c8"></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_SPI_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_SPI_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__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a> Driver_SPI0;</div>
<div class="line"><a class="code" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_spi (<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_SPI0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__spi__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="gaf4823a11ab5efcd47c79b13801513ddc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a> ARM_SPI_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__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_SPI_GetCapabilities</b> returns information about the capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a> encode various capabilities, for example supported modes.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a> Driver_SPI0;</div>
<div class="line"><a class="code" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</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__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_SPI0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__spi__interface__gr.html#a065b5fc24d0204692f0f95a44351ac1e">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="ga1a3c11ed523a4355cd91069527945906"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640">ARM_SPI_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize SPI Interface. </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__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_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_SPI_Initialize</b> initializes the SPI interface.</p>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a> callback function; use a NULL pointer when no callback signals are required.</p>
<p>The function is called when the middleware component starts operation and performs the following:</p>
<ul>
<li>Initializes the resources needed for the SPI interface.</li>
<li>Registers the <a class="el" href="group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e">ARM_SPI_SignalEvent</a> callback function.</li>
</ul>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__spi__interface__gr.html">SPI Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="ga0c480ee3eabb82fc746e89741ed2e03e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_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 SPI 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_SPI_Uninitialize</b> de-initializes the resources of SPI 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="ga1a1e7e80ea32ae381b75213c32aa8067"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_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 SPI 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 </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_SPI_PowerControl</b> controls the power modes of the SPI 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>
</div>
</div>
<a class="anchor" id="gab2a303d1071e926280d50682f4808479"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_Send </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start sending data to SPI transmitter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to send to SPI transmitter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to send </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>This function <b>ARM_SPI_Send</b> is used to send data to the SPI transmitter (received data is ignored).</p>
<p>The parameter <em>data</em> specifies the data buffer. <br/>
The parameter <em>num</em> specifies the number of items to send. <br/>
The item size is defined by the data type, which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for 1..8 data bits</li>
<li><em>uint16_t</em> when configured for 9..16 data bits</li>
<li><em>uint32_t</em> when configured for 17..32 data bits</li>
</ul>
<p>Calling the function <b>ARM_SPI_Send</b> only starts the send operation. When in slave mode, the operation is only registered and started when the master starts the transfer. The function is non-blocking and returns as soon as the driver has started the operation (driver typically configures DMA or the interrupt system for continuous transfer). During the operation it is not allowed to call this function or any other data transfer function again. Also the data buffer must stay allocated and the contents of unsent data must not be modified. When send operation is completed (requested number of items sent), the <a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a> event is generated. Progress of send operation can also be monitored by reading the number of items already sent by calling <a class="el" href="group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb">ARM_SPI_GetDataCount</a>.</p>
<p>Status of the transmitter can also be monitored by calling the <a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> and checking the <em>busy</em> data field, which indicates if transmission is still in progress or pending.</p>
<p>When in master mode and configured to monitor slave select and the slave select gets deactivated during transfer, then the SPI mode changes to inactive and the <a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a> event is generated (instead of <a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a>).</p>
<p>When in slave mode but send/receive/transfer operation is not started and data is sent/requested by the master, then the <a class="el" href="group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244">ARM_SPI_EVENT_DATA_LOST</a> event is generated.</p>
<p>Send operation can be aborted by calling <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> with <a class="el" href="group__spi__misc__ctrls.html#ga44708b80e48984be099cd6eb11780dc3">ARM_SPI_ABORT_TRANSFER</a> as the control parameter. </p>
</div>
</div>
<a class="anchor" id="ga726aff54e782ed9b47f7ba1280a3d8f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_Receive </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start receiving data from SPI receiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to receive from SPI receiver </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to receive </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_SPI_Receive</b> is used to receive data (transmits the default value as specified by <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> with <a class="el" href="group__spi__misc__ctrls.html#gae9861221dee78d52bd1522b7846535ce">ARM_SPI_SET_DEFAULT_TX_VALUE</a> as control parameter).</p>
<p>The parameter <em>data</em> specifies the data buffer. <br/>
The parameter <em>num</em> specifies the number of items to receive. <br/>
The item size is defined by the data type, which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for 1..8 data bits</li>
<li><em>uint16_t</em> when configured for 9..16 data bits</li>
<li><em>uint32_t</em> when configured for 17..32 data bits</li>
</ul>
<p>Calling the function <b>ARM_SPI_Receive</b> only starts the receive operation. The function is non-blocking and returns as soon as the driver has started the operation (driver typically configures DMA or the interrupt system for continuous transfer). When in slave mode, the operation is only registered and started when the master starts the transfer. During the operation it is not allowed to call this function or any other data transfer function again. Also the data buffer must stay allocated. When receive operation is completed (requested number of items received), the <a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a> event is generated. Progress of receive operation can also be monitored by reading the number of items already received by calling <a class="el" href="group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb">ARM_SPI_GetDataCount</a>.</p>
<p>Status of the receiver can also be monitored by calling the <a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> and checking the <em>busy</em> data field, which indicates if reception is still in progress or pending.</p>
<p>When in master mode and configured to monitor slave select and the slave select gets deactivated during transfer, then the SPI mode changes to inactive and the <a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a> event is generated (instead of <a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a>).</p>
<p>When in slave mode but send/receive/transfer operation is not started and data is sent/requested by the master, then the <a class="el" href="group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244">ARM_SPI_EVENT_DATA_LOST</a> event is generated.</p>
<p>Receive operation can be aborted by calling <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> with <a class="el" href="group__spi__misc__ctrls.html#ga44708b80e48984be099cd6eb11780dc3">ARM_SPI_ABORT_TRANSFER</a> as the control parameter. </p>
</div>
</div>
<a class="anchor" id="gaa24026b3822c10272e301f1505136ec2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_Transfer </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start sending/receiving data to/from SPI transmitter/receiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data_out</td><td>Pointer to buffer with data to send to SPI transmitter </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data_in</td><td>Pointer to buffer for data to receive from SPI receiver </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to transfer </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_SPI_Transfer</b> transfers data via SPI. It synchronously sends data to the SPI transmitter and receives data from the SPI receiver.</p>
<p>The parameter <em>data_out</em> is a pointer to the buffer with data to send. <br/>
The parameter <em>data_in</em> is a pointer to the buffer which receives data. <br/>
The parameter <em>num</em> specifies the number of items to transfer. <br/>
The item size is defined by the data type which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for 1..8 data bits</li>
<li><em>uint16_t</em> when configured for 9..16 data bits</li>
<li><em>uint32_t</em> when configured for 17..32 data bits</li>
</ul>
<p>Calling the function <b>ARM_SPI_Transfer</b> only starts the transfer operation. The function is non-blocking and returns as soon as the driver has started the operation (driver typically configures DMA or the interrupt system for continuous transfer). When in slave mode, the operation is only registered and started when the master starts the transfer. During the operation it is not allowed to call this function or any other data transfer function again. Also the data buffers must stay allocated and the contents of unsent data must not be modified. When transfer operation is completed (requested number of items transferred), the <a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a> event is generated. Progress of transfer operation can also be monitored by reading the number of items already transferred by calling <a class="el" href="group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb">ARM_SPI_GetDataCount</a>.</p>
<p>Status of the transmitter and receiver can also be monitored by calling the <a class="el" href="group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817">ARM_SPI_GetStatus</a> and checking the <em>busy</em> flag.</p>
<p>When in master mode and configured to monitor slave select and the slave select gets deactivated during transfer, then the SPI mode changes to inactive and the <a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a> event is generated (instead of <a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a>).</p>
<p>When in slave mode but send/receive/transfer operation is not started and data is sent/requested by the master, then the <a class="el" href="group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244">ARM_SPI_EVENT_DATA_LOST</a> event is generated.</p>
<p>Transfer operation can also be aborted by calling <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> with <a class="el" href="group__spi__misc__ctrls.html#ga44708b80e48984be099cd6eb11780dc3">ARM_SPI_ABORT_TRANSFER</a> as the control parameter. </p>
</div>
</div>
<a class="anchor" id="gaaaecaaf4ec1922f22e7f9de63af5ccdb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_SPI_GetDataCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get transferred data count. </p>
<dl class="section return"><dt>Returns</dt><dd>number of data items transferred</dd></dl>
<p>The function <b>ARM_SPI_GetDataCount</b> returns the number of currently transferred data items during <a class="el" href="group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479">ARM_SPI_Send</a>, <a class="el" href="group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6">ARM_SPI_Receive</a> and <a class="el" href="group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2">ARM_SPI_Transfer</a> operation. </p>
</div>
</div>
<a class="anchor" id="gad18d229992598d6677bec250015e5d1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_SPI_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 SPI 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>common <a class="el" href="group__execution__status.html">Status Error Codes</a> and driver specific <a class="el" href="group__spi__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_SPI_Control</b> controls the SPI interface settings and executes various operations.</p>
<p>The parameter <em>control</em> is a bit mask that specifies various operations.</p>
<ul>
<li>Controls form different categories can be ORed.</li>
<li>If one control is omitted, then the default value of that category is used.</li>
<li>Miscellaneous controls cannot be combined.</li>
</ul>
<p>The parameter <em>arg</em> provides (depending on the parameter <em>control</em>) additional information, for example the Bus Speed.</p>
<table class="cmtable">
<tr>
<th>Parameter <em>control</em> </th><th style="text-align:right">Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__spi__mode__ctrls.html#ga974e3d7c178b76b0540d7644b977bff3">ARM_SPI_MODE_INACTIVE</a> </td><td rowspan="5" style="text-align:right">0..7 </td><td rowspan="5"><a class="anchor" id="spi_mode_tab"></a>Mode Controls </td><td>Set SPI to inactive. </td></tr>
<tr>
<td><a class="el" href="group__spi__mode__ctrls.html#ga3143ef07c1607b9bc57e29df35cf2fa8">ARM_SPI_MODE_MASTER</a> </td><td>Set the SPI Master (Output on MOSI, and the Input on MISO); <em>arg</em> = Bus Speed in <span class="XML-Token">bps</span> </td></tr>
<tr>
<td><a class="el" href="group__spi__mode__ctrls.html#gaf34d849c7cde1151a768887f154e19bd">ARM_SPI_MODE_MASTER_SIMPLEX</a> </td><td>Set the SPI Master (Output and Input on MOSI); <em>arg</em> = Bus Speed in <span class="XML-Token">bps</span> </td></tr>
<tr>
<td><a class="el" href="group__spi__mode__ctrls.html#ga382b394c5e68f7d1206b837843732a3e">ARM_SPI_MODE_SLAVE</a> </td><td>Set the SPI Slave (Output on MISO, and the Input on MOSI) </td></tr>
<tr>
<td><a class="el" href="group__spi__mode__ctrls.html#ga9b113d8b336047e1c22f73ad44851fdf">ARM_SPI_MODE_SLAVE_SIMPLEX</a> </td><td>Set the SPI Slave (Output and Input on MISO) </td></tr>
<tr>
<td><a class="el" href="group__spi__frame__format__ctrls.html#gab4ac9a609c078d1e8332cf95da34e50e">ARM_SPI_CPOL0_CPHA0</a> (default) </td><td rowspan="6" style="text-align:right">8..11 </td><td rowspan="6">Clock Polarity <br/>
(Frame Format) </td><td>CPOL=<span class="XML-Token">0</span> and CPHA=<span class="XML-Token">0</span>: Clock Polarity 0, Clock Phase 0 </td></tr>
<tr>
<td><a class="el" href="group__spi__frame__format__ctrls.html#ga5498eb08c2ba8de2e1c2801428e79d71">ARM_SPI_CPOL0_CPHA1</a> </td><td>CPOL=<span class="XML-Token">0</span> and CPHA=<span class="XML-Token">1</span>: Clock Polarity 0, Clock Phase 1 </td></tr>
<tr>
<td><a class="el" href="group__spi__frame__format__ctrls.html#ga67193d9b5af1ec312a66d007c33b597f">ARM_SPI_CPOL1_CPHA0</a> </td><td>CPOL=<span class="XML-Token">1</span> and CPHA=<span class="XML-Token">0</span>: Clock Polarity 1, Clock Phase 0 </td></tr>
<tr>
<td><a class="el" href="group__spi__frame__format__ctrls.html#ga7fab572b2fec303e979e47eb2d13ca74">ARM_SPI_CPOL1_CPHA1</a> </td><td>CPOL=<span class="XML-Token">1</span> and CPHA=<span class="XML-Token">1</span>: Clock Polarity 1, Clock Phase 1 </td></tr>
<tr>
<td><a class="el" href="group__spi__frame__format__ctrls.html#ga225185710ba38848a489013ba4475915">ARM_SPI_TI_SSI</a> </td><td>Specifies that the frame format corresponds to the Texas Instruments Frame Format </td></tr>
<tr>
<td><a class="el" href="group__spi__frame__format__ctrls.html#ga44f481d32b9a9ea93673f05af82ccf86">ARM_SPI_MICROWIRE</a> </td><td>Specifies that the frame format corresponds to the National Microwire Frame Format </td></tr>
<tr>
<td><a class="el" href="group__spi__data__bits__ctrls.html#gaf6c099a1d67256a32010120c66c55250">ARM_SPI_DATA_BITS(n)</a> </td><td style="text-align:right">12..17 </td><td>Data Bits </td><td>Set the number of bits per SPI frame; range for <em>n</em> = <span class="XML-Token">1..32</span>. This is the minimum required parameter. </td></tr>
<tr>
<td><a class="el" href="group__spi__bit__order__ctrls.html#ga98228a708cbab6e214c7ac696f77dab6">ARM_SPI_MSB_LSB</a> (default) </td><td rowspan="2" style="text-align:right">18 </td><td rowspan="2">Bit Order </td><td>Set the bit order from MSB to LSB </td></tr>
<tr>
<td><a class="el" href="group__spi__bit__order__ctrls.html#ga41c53c3b396a89ce78018467e561aaaf">ARM_SPI_LSB_MSB</a> </td><td>Set the bit order from LSB to MSB </td></tr>
<tr>
<td><a class="el" href="group__spi__slave__select__mode__ctrls.html#gae19343adc7bd71408b51733171f99dc7">ARM_SPI_SS_MASTER_UNUSED</a> (default) </td><td rowspan="6" style="text-align:right">19..21 </td><td rowspan="6">Slave Select <br/>
when Master <div style="min-height:200px"> </div> Must be used with the corresponding master or slave controls from category <a href="#spi_mode_tab"><b>Mode Controls</b></a>. <div style="min-height:200px"> </div> Slave Select <br/>
when Slave </td><td>Set the Slave Select mode for the master to <b>Not used</b>. Used with Mode Control ARM_SPI_MODE_MASTER. Master does not drive or monitor the SS line. For example, when connecting to a single slave, which has the SS line connected to a fixed low level. </td></tr>
<tr>
<td><a class="el" href="group__spi__slave__select__mode__ctrls.html#gab5e319aa3f9d4d8c9ed92f0fe865f624">ARM_SPI_SS_MASTER_SW</a> </td><td>Set the Slave Select mode for the master to <b>Software controlled</b>. Used with Mode Control ARM_SPI_MODE_MASTER. The Slave Select line is configured as output and controlled via the Miscellaneous Control <a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>. By default, the line it is not active (high), and is not affected by transfer-, send-, or receive functions. </td></tr>
<tr>
<td><a class="el" href="group__spi__slave__select__mode__ctrls.html#ga07762709a40dc90aca85553f500c8761">ARM_SPI_SS_MASTER_HW_OUTPUT</a> </td><td>Set the Slave Select mode for the master to <b>Hardware controlled Output</b>. Used with Mode Control ARM_SPI_MODE_MASTER. The Slave Select line is configured as output and controlled by hardware. The line gets activated or deactivated automatically by the hardware for transfers and is not controlled by the Miscellaneous Control <a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>. When exactly the line is activated or deactivated is hardware dependent. Typically, the hardware will activate the line before starting the transfer and deactivate it after the transfer completes. Some hardware will leave the line activated until the SPI stays master. <dl class="section note"><dt>Note</dt><dd>Some devices require that the SS signal is strictly defined regarding transfers. Refer to the documentaiton of your device. </dd></dl>
</td></tr>
<tr>
<td><a class="el" href="group__spi__slave__select__mode__ctrls.html#ga8561bd0cc25ab2bb02b138c1c6a586cd">ARM_SPI_SS_MASTER_HW_INPUT</a> </td><td>Set the Slave Select mode for the master to <b>Hardware monitored Input</b>. Used with Mode Control ARM_SPI_MODE_MASTER. Used in multi-master configuration where a master does not drive the Slave Select when driving the bus, but rather monitors it. When another master activates this line, the active master backs off. This is called Mode Fault. Slave Select is configured as input and hardware only monitors the line. When the line is deactivated externally while we are master, it presents a Mode Fault (<a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a>) and the SPI switches to inactive mode. </td></tr>
<tr>
<td><a class="el" href="group__spi__slave__select__mode__ctrls.html#ga2bd0d1f3ade2dc0cc48cc0593336ad70">ARM_SPI_SS_SLAVE_HW</a> (default) </td><td>Set the Slave Select mode for the slave to <b>Hardware monitored</b>. Used with Mode Control ARM_SPI_MODE_SLAVE. Hardware monitors the Slave Select line and accepts transfers only when the line is active. Transfers are ignored while the Slave Select line is inactive. </td></tr>
<tr>
<td><a class="el" href="group__spi__slave__select__mode__ctrls.html#gad371f6ba0d12a57bdcc3217c351abfb0">ARM_SPI_SS_SLAVE_SW</a> </td><td>Set the Slave Select mode for the slave to <b>Software controlled</b>. Used with Mode Control ARM_SPI_MODE_SLAVE. Used only when the Slave Select line is not used. For example, when a single master and slave are connected in the system then the Slave Select line is not needed. Software controls if the slave is responding or not (by default it is not responding). Software enables or disables transfers by using the Miscellaneous Control <a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>. </td></tr>
<tr>
<td><a class="el" href="group__spi__misc__ctrls.html#ga5ef3d114979f3fd6010d0df16c2bf5c1">ARM_SPI_SET_BUS_SPEED</a> </td><td rowspan="5" style="text-align:right">0..21 </td><td rowspan="5">Miscellaneous Controls <br/>
(cannot be ORed) </td><td>Set the bus speed; <em>arg=</em> Bus Speed in <span class="XML-Token">bps</span> </td></tr>
<tr>
<td><a class="el" href="group__spi__misc__ctrls.html#gafc00fe35bb4c89b076d014b43168b2b3">ARM_SPI_GET_BUS_SPEED</a> </td><td>Get the bus speed; Retrun values >= <span class="XML-Token">0</span> reperesent the bus speed in <span class="XML-Token">bps</span>. Negative values are <a class="el" href="group__spi__execution__status.html">Status Error Codes</a>. </td></tr>
<tr>
<td><a class="el" href="group__spi__misc__ctrls.html#gae9861221dee78d52bd1522b7846535ce">ARM_SPI_SET_DEFAULT_TX_VALUE</a> </td><td>Set the default transmission value; the parameter <em>arg</em> sets the value </td></tr>
<tr>
<td><a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a> </td><td>Control the Slave Select signal (SS); the values for the parameter <em>arg</em> are: <span class="XML-Token">ARM_SPI_SS_INACTIVE; ARM_SPI_SS_ACTIVE</span> </td></tr>
<tr>
<td><a class="el" href="group__spi__misc__ctrls.html#ga44708b80e48984be099cd6eb11780dc3">ARM_SPI_ABORT_TRANSFER</a> </td><td>Abort the current data transfer </td></tr>
</table>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__spi__interface__gr.html#structARM__DRIVER__SPI">ARM_DRIVER_SPI</a> Driver_SPI0;</div>
<div class="line"></div>
<div class="line"><span class="comment">// configure: SPI master | clock polarity=1, clock phase=1 | bits per frame=16 | bus speed : 1000000 </span></div>
<div class="line">status = Driver_SPI0.<a class="code" href="group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__spi__mode__ctrls.html#ga3143ef07c1607b9bc57e29df35cf2fa8">ARM_SPI_MODE_MASTER</a> | </div>
<div class="line"> <a class="code" href="group__spi__frame__format__ctrls.html#ga7fab572b2fec303e979e47eb2d13ca74">ARM_SPI_CPOL1_CPHA1</a> | </div>
<div class="line"> <a class="code" href="group__spi__data__bits__ctrls.html#gaf6c099a1d67256a32010120c66c55250">ARM_SPI_DATA_BITS</a>(16), 1000000);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga60d33d8788a76c388cc36e066240b817"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__spi__interface__gr.html#structARM__SPI__STATUS">ARM_SPI_STATUS</a> ARM_SPI_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 SPI status. </p>
<dl class="section return"><dt>Returns</dt><dd>SPI status <a class="el" href="group__spi__interface__gr.html#structARM__SPI__STATUS">ARM_SPI_STATUS</a></dd></dl>
<p>The function <b>ARM_SPI_GetStatus</b> returns the current SPI interface status. </p>
</div>
</div>
<a class="anchor" id="ga505b2d787348d51351d38fee98ccba7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_SPI_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>Signal SPI Events. </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__SPI__events.html">SPI Events</a> notification mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_SPI_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906">ARM_SPI_Initialize</a>.</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__spi__interface__gr.html#structARM__SPI__CAPABILITIES">ARM_SPI_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__spi__interface__gr.html#gaf4823a11ab5efcd47c79b13801513ddc">ARM_SPI_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="cmtable">
<tr>
<th>Parameter <em>event</em> </th><th>Bit </th><th>Description </th><th>supported when <a class="el" href="group__spi__interface__gr.html#structARM__SPI__CAPABILITIES" title="SPI Driver Capabilities. ">ARM_SPI_CAPABILITIES</a> </th></tr>
<tr>
<td><a class="el" href="group__SPI__events.html#gaabdfc9e17641144cd50d36d15511a1b8">ARM_SPI_EVENT_TRANSFER_COMPLETE</a> </td><td>0 </td><td>Occurs after call to <a class="el" href="group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479">ARM_SPI_Send</a>, <a class="el" href="group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6">ARM_SPI_Receive</a>, or <a class="el" href="group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2">ARM_SPI_Transfer</a> to indicate that all the data has been transferred. The driver is ready for the next transfer operation. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__SPI__events.html#ga8e63d99c80ea56de596a8d0a51fd8244">ARM_SPI_EVENT_DATA_LOST</a> </td><td>1 </td><td>Occurs in slave mode when data is requested/sent by master but send/receive/transfer operation has not been started and indicates that data is lost. Occurs also in master mode when driver cannot transfer data fast enough. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__SPI__events.html#ga7eaa229003689aa18598273490b3e630">ARM_SPI_EVENT_MODE_FAULT</a> </td><td>2 </td><td>Occurs in master mode when Slave Select is deactivated and indicates Master Mode Fault. The driver is ready for the next transfer operation. </td><td>data field <em>event_mode_fault</em> = <span class="XML-Token">1</span> </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__spi__interface__gr.html | HTML | apache-2.0 | 92,746 |
var group__spi__interface__gr =
[
[ "Status Error Codes", "group__spi__execution__status.html", "group__spi__execution__status" ],
[ "SPI Events", "group__SPI__events.html", "group__SPI__events" ],
[ "SPI Control Codes", "group__SPI__control.html", "group__SPI__control" ],
[ "ARM_DRIVER_SPI", "group__spi__interface__gr.html#structARM__DRIVER__SPI", [
[ "GetVersion", "group__spi__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__spi__interface__gr.html#a065b5fc24d0204692f0f95a44351ac1e", null ],
[ "Initialize", "group__spi__interface__gr.html#afac50d0b28860f7b569293e6b713f8a4", null ],
[ "Uninitialize", "group__spi__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__spi__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "Send", "group__spi__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922", null ],
[ "Receive", "group__spi__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3", null ],
[ "Transfer", "group__spi__interface__gr.html#ad88b63ed74c03ba06b0599ab06ad4cf7", null ],
[ "GetDataCount", "group__spi__interface__gr.html#ad1d892ab3932f65cd7cdf2d0a91ae5da", null ],
[ "Control", "group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__spi__interface__gr.html#a7305e7248420cdb4b02ceba87672178d", null ]
] ],
[ "ARM_SPI_CAPABILITIES", "group__spi__interface__gr.html#structARM__SPI__CAPABILITIES", [
[ "simplex", "group__spi__interface__gr.html#af244e2c2facf6414e3886495ee6b40bc", null ],
[ "ti_ssi", "group__spi__interface__gr.html#a8053c540e5d531b692224bdc2463f36a", null ],
[ "microwire", "group__spi__interface__gr.html#a9b4e858eb1d414128994742bf121f94c", null ],
[ "event_mode_fault", "group__spi__interface__gr.html#a309619714f0c4febaa497ebdb9b7e3ca", null ],
[ "reserved", "group__spi__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_SPI_STATUS", "group__spi__interface__gr.html#structARM__SPI__STATUS", [
[ "busy", "group__spi__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "data_lost", "group__spi__interface__gr.html#a9675630df67587ecd171c7ef12b9d22a", null ],
[ "mode_fault", "group__spi__interface__gr.html#aeaf54ec655b7a64b9e88578c5f39d4e3", null ],
[ "reserved", "group__spi__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_SPI_SignalEvent_t", "group__spi__interface__gr.html#gafde9205364241ee81290adc0481c6640", null ],
[ "ARM_SPI_GetVersion", "group__spi__interface__gr.html#gad5db9209ef1d64a7915a7278d6a402c8", null ],
[ "ARM_SPI_GetCapabilities", "group__spi__interface__gr.html#gaf4823a11ab5efcd47c79b13801513ddc", null ],
[ "ARM_SPI_Initialize", "group__spi__interface__gr.html#ga1a3c11ed523a4355cd91069527945906", null ],
[ "ARM_SPI_Uninitialize", "group__spi__interface__gr.html#ga0c480ee3eabb82fc746e89741ed2e03e", null ],
[ "ARM_SPI_PowerControl", "group__spi__interface__gr.html#ga1a1e7e80ea32ae381b75213c32aa8067", null ],
[ "ARM_SPI_Send", "group__spi__interface__gr.html#gab2a303d1071e926280d50682f4808479", null ],
[ "ARM_SPI_Receive", "group__spi__interface__gr.html#ga726aff54e782ed9b47f7ba1280a3d8f6", null ],
[ "ARM_SPI_Transfer", "group__spi__interface__gr.html#gaa24026b3822c10272e301f1505136ec2", null ],
[ "ARM_SPI_GetDataCount", "group__spi__interface__gr.html#gaaaecaaf4ec1922f22e7f9de63af5ccdb", null ],
[ "ARM_SPI_Control", "group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a", null ],
[ "ARM_SPI_GetStatus", "group__spi__interface__gr.html#ga60d33d8788a76c388cc36e066240b817", null ],
[ "ARM_SPI_SignalEvent", "group__spi__interface__gr.html#ga505b2d787348d51351d38fee98ccba7e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__interface__gr.js | JavaScript | apache-2.0 | 3,880 |
var group__spi__interface__gr_structARM__DRIVER__SPI =
[
[ "GetVersion", "group__spi__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__spi__interface__gr.html#a065b5fc24d0204692f0f95a44351ac1e", null ],
[ "Initialize", "group__spi__interface__gr.html#afac50d0b28860f7b569293e6b713f8a4", null ],
[ "Uninitialize", "group__spi__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__spi__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "Send", "group__spi__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922", null ],
[ "Receive", "group__spi__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3", null ],
[ "Transfer", "group__spi__interface__gr.html#ad88b63ed74c03ba06b0599ab06ad4cf7", null ],
[ "GetDataCount", "group__spi__interface__gr.html#ad1d892ab3932f65cd7cdf2d0a91ae5da", null ],
[ "Control", "group__spi__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__spi__interface__gr.html#a7305e7248420cdb4b02ceba87672178d", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__interface__gr_structARM__DRIVER__SPI.js | JavaScript | apache-2.0 | 1,110 |
var group__spi__interface__gr_structARM__SPI__CAPABILITIES =
[
[ "simplex", "group__spi__interface__gr.html#af244e2c2facf6414e3886495ee6b40bc", null ],
[ "ti_ssi", "group__spi__interface__gr.html#a8053c540e5d531b692224bdc2463f36a", null ],
[ "microwire", "group__spi__interface__gr.html#a9b4e858eb1d414128994742bf121f94c", null ],
[ "event_mode_fault", "group__spi__interface__gr.html#a309619714f0c4febaa497ebdb9b7e3ca", null ],
[ "reserved", "group__spi__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__interface__gr_structARM__SPI__CAPABILITIES.js | JavaScript | apache-2.0 | 540 |
var group__spi__interface__gr_structARM__SPI__STATUS =
[
[ "busy", "group__spi__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "data_lost", "group__spi__interface__gr.html#a9675630df67587ecd171c7ef12b9d22a", null ],
[ "mode_fault", "group__spi__interface__gr.html#aeaf54ec655b7a64b9e88578c5f39d4e3", null ],
[ "reserved", "group__spi__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__interface__gr_structARM__SPI__STATUS.js | JavaScript | apache-2.0 | 433 |
<!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 Miscellaneous Controls</title>
<title>CMSIS-Driver: SPI Miscellaneous 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__spi__misc__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">SPI Miscellaneous Controls<div class="ingroups"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies additional miscellaneous controls.
<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:ga5ef3d114979f3fd6010d0df16c2bf5c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__misc__ctrls.html#ga5ef3d114979f3fd6010d0df16c2bf5c1">ARM_SPI_SET_BUS_SPEED</a>   (0x10UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga5ef3d114979f3fd6010d0df16c2bf5c1"><td class="mdescLeft"> </td><td class="mdescRight">Set Bus Speed in bps; arg = value. <a href="#ga5ef3d114979f3fd6010d0df16c2bf5c1">More...</a><br/></td></tr>
<tr class="separator:ga5ef3d114979f3fd6010d0df16c2bf5c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc00fe35bb4c89b076d014b43168b2b3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__misc__ctrls.html#gafc00fe35bb4c89b076d014b43168b2b3">ARM_SPI_GET_BUS_SPEED</a>   (0x11UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:gafc00fe35bb4c89b076d014b43168b2b3"><td class="mdescLeft"> </td><td class="mdescRight">Get Bus Speed in bps. <a href="#gafc00fe35bb4c89b076d014b43168b2b3">More...</a><br/></td></tr>
<tr class="separator:gafc00fe35bb4c89b076d014b43168b2b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae9861221dee78d52bd1522b7846535ce"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__misc__ctrls.html#gae9861221dee78d52bd1522b7846535ce">ARM_SPI_SET_DEFAULT_TX_VALUE</a>   (0x12UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:gae9861221dee78d52bd1522b7846535ce"><td class="mdescLeft"> </td><td class="mdescRight">Set default Transmit value; arg = value. <a href="#gae9861221dee78d52bd1522b7846535ce">More...</a><br/></td></tr>
<tr class="separator:gae9861221dee78d52bd1522b7846535ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5776272b82decff92da003568540c92f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>   (0x13UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga5776272b82decff92da003568540c92f"><td class="mdescLeft"> </td><td class="mdescRight">Control Slave Select; arg: 0=inactive, 1=active. <a href="#ga5776272b82decff92da003568540c92f">More...</a><br/></td></tr>
<tr class="separator:ga5776272b82decff92da003568540c92f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga44708b80e48984be099cd6eb11780dc3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__misc__ctrls.html#ga44708b80e48984be099cd6eb11780dc3">ARM_SPI_ABORT_TRANSFER</a>   (0x14UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga44708b80e48984be099cd6eb11780dc3"><td class="mdescLeft"> </td><td class="mdescRight">Abort current data transfer. <a href="#ga44708b80e48984be099cd6eb11780dc3">More...</a><br/></td></tr>
<tr class="separator:ga44708b80e48984be099cd6eb11780dc3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies additional miscellaneous controls. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga5ef3d114979f3fd6010d0df16c2bf5c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SET_BUS_SPEED   (0x10UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Speed in bps; arg = value. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafc00fe35bb4c89b076d014b43168b2b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_GET_BUS_SPEED   (0x11UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Bus Speed in bps. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae9861221dee78d52bd1522b7846535ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SET_DEFAULT_TX_VALUE   (0x12UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set default Transmit value; arg = value. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5776272b82decff92da003568540c92f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_CONTROL_SS   (0x13UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control Slave Select; arg: 0=inactive, 1=active. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga44708b80e48984be099cd6eb11780dc3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_ABORT_TRANSFER   (0x14UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort current data transfer. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_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__spi__misc__ctrls.html | HTML | apache-2.0 | 13,100 |
var group__spi__misc__ctrls =
[
[ "ARM_SPI_SET_BUS_SPEED", "group__spi__misc__ctrls.html#ga5ef3d114979f3fd6010d0df16c2bf5c1", null ],
[ "ARM_SPI_GET_BUS_SPEED", "group__spi__misc__ctrls.html#gafc00fe35bb4c89b076d014b43168b2b3", null ],
[ "ARM_SPI_SET_DEFAULT_TX_VALUE", "group__spi__misc__ctrls.html#gae9861221dee78d52bd1522b7846535ce", null ],
[ "ARM_SPI_CONTROL_SS", "group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f", null ],
[ "ARM_SPI_ABORT_TRANSFER", "group__spi__misc__ctrls.html#ga44708b80e48984be099cd6eb11780dc3", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__misc__ctrls.js | JavaScript | apache-2.0 | 568 |
<!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 Mode Controls</title>
<title>CMSIS-Driver: SPI Mode 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__spi__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">SPI Mode Controls<div class="ingroups"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies SPI mode.
<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:ga974e3d7c178b76b0540d7644b977bff3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__mode__ctrls.html#ga974e3d7c178b76b0540d7644b977bff3">ARM_SPI_MODE_INACTIVE</a>   (0x00UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga974e3d7c178b76b0540d7644b977bff3"><td class="mdescLeft"> </td><td class="mdescRight">SPI Inactive. <a href="#ga974e3d7c178b76b0540d7644b977bff3">More...</a><br/></td></tr>
<tr class="separator:ga974e3d7c178b76b0540d7644b977bff3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3143ef07c1607b9bc57e29df35cf2fa8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__mode__ctrls.html#ga3143ef07c1607b9bc57e29df35cf2fa8">ARM_SPI_MODE_MASTER</a>   (0x01UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga3143ef07c1607b9bc57e29df35cf2fa8"><td class="mdescLeft"> </td><td class="mdescRight">SPI Master (Output on MOSI, Input on MISO); arg = Bus Speed in bps. <a href="#ga3143ef07c1607b9bc57e29df35cf2fa8">More...</a><br/></td></tr>
<tr class="separator:ga3143ef07c1607b9bc57e29df35cf2fa8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga382b394c5e68f7d1206b837843732a3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__mode__ctrls.html#ga382b394c5e68f7d1206b837843732a3e">ARM_SPI_MODE_SLAVE</a>   (0x02UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga382b394c5e68f7d1206b837843732a3e"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave (Output on MISO, Input on MOSI) <a href="#ga382b394c5e68f7d1206b837843732a3e">More...</a><br/></td></tr>
<tr class="separator:ga382b394c5e68f7d1206b837843732a3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf34d849c7cde1151a768887f154e19bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__mode__ctrls.html#gaf34d849c7cde1151a768887f154e19bd">ARM_SPI_MODE_MASTER_SIMPLEX</a>   (0x03UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:gaf34d849c7cde1151a768887f154e19bd"><td class="mdescLeft"> </td><td class="mdescRight">SPI Master (Output/Input on MOSI); arg = Bus Speed in bps. <a href="#gaf34d849c7cde1151a768887f154e19bd">More...</a><br/></td></tr>
<tr class="separator:gaf34d849c7cde1151a768887f154e19bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9b113d8b336047e1c22f73ad44851fdf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__mode__ctrls.html#ga9b113d8b336047e1c22f73ad44851fdf">ARM_SPI_MODE_SLAVE_SIMPLEX</a>   (0x04UL << ARM_SPI_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga9b113d8b336047e1c22f73ad44851fdf"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave (Output/Input on MISO) <a href="#ga9b113d8b336047e1c22f73ad44851fdf">More...</a><br/></td></tr>
<tr class="separator:ga9b113d8b336047e1c22f73ad44851fdf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies SPI mode. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga974e3d7c178b76b0540d7644b977bff3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MODE_INACTIVE   (0x00UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Inactive. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3143ef07c1607b9bc57e29df35cf2fa8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MODE_MASTER   (0x01UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Master (Output on MOSI, Input on MISO); arg = Bus Speed in bps. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga382b394c5e68f7d1206b837843732a3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MODE_SLAVE   (0x02UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave (Output on MISO, Input on MOSI) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf34d849c7cde1151a768887f154e19bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MODE_MASTER_SIMPLEX   (0x03UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Master (Output/Input on MOSI); arg = Bus Speed in bps. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9b113d8b336047e1c22f73ad44851fdf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_MODE_SLAVE_SIMPLEX   (0x04UL << ARM_SPI_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave (Output/Input on MISO) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_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__spi__mode__ctrls.html | HTML | apache-2.0 | 13,105 |
var group__spi__mode__ctrls =
[
[ "ARM_SPI_MODE_INACTIVE", "group__spi__mode__ctrls.html#ga974e3d7c178b76b0540d7644b977bff3", null ],
[ "ARM_SPI_MODE_MASTER", "group__spi__mode__ctrls.html#ga3143ef07c1607b9bc57e29df35cf2fa8", null ],
[ "ARM_SPI_MODE_SLAVE", "group__spi__mode__ctrls.html#ga382b394c5e68f7d1206b837843732a3e", null ],
[ "ARM_SPI_MODE_MASTER_SIMPLEX", "group__spi__mode__ctrls.html#gaf34d849c7cde1151a768887f154e19bd", null ],
[ "ARM_SPI_MODE_SLAVE_SIMPLEX", "group__spi__mode__ctrls.html#ga9b113d8b336047e1c22f73ad44851fdf", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__mode__ctrls.js | JavaScript | apache-2.0 | 569 |
<!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 Slave Select Mode</title>
<title>CMSIS-Driver: SPI Slave Select 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__spi__slave__select__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">SPI Slave Select Mode<div class="ingroups"><a class="el" href="group__SPI__control.html">SPI Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies SPI slave select mode.
<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:gae19343adc7bd71408b51733171f99dc7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html#gae19343adc7bd71408b51733171f99dc7">ARM_SPI_SS_MASTER_UNUSED</a>   (0UL << ARM_SPI_SS_MASTER_MODE_Pos)</td></tr>
<tr class="memdesc:gae19343adc7bd71408b51733171f99dc7"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave Select when Master: Not used (default) <a href="#gae19343adc7bd71408b51733171f99dc7">More...</a><br/></td></tr>
<tr class="separator:gae19343adc7bd71408b51733171f99dc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab5e319aa3f9d4d8c9ed92f0fe865f624"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html#gab5e319aa3f9d4d8c9ed92f0fe865f624">ARM_SPI_SS_MASTER_SW</a>   (1UL << ARM_SPI_SS_MASTER_MODE_Pos)</td></tr>
<tr class="memdesc:gab5e319aa3f9d4d8c9ed92f0fe865f624"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave Select when Master: Software controlled. <a href="#gab5e319aa3f9d4d8c9ed92f0fe865f624">More...</a><br/></td></tr>
<tr class="separator:gab5e319aa3f9d4d8c9ed92f0fe865f624"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga07762709a40dc90aca85553f500c8761"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html#ga07762709a40dc90aca85553f500c8761">ARM_SPI_SS_MASTER_HW_OUTPUT</a>   (2UL << ARM_SPI_SS_MASTER_MODE_Pos)</td></tr>
<tr class="memdesc:ga07762709a40dc90aca85553f500c8761"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave Select when Master: Hardware controlled Output. <a href="#ga07762709a40dc90aca85553f500c8761">More...</a><br/></td></tr>
<tr class="separator:ga07762709a40dc90aca85553f500c8761"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8561bd0cc25ab2bb02b138c1c6a586cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html#ga8561bd0cc25ab2bb02b138c1c6a586cd">ARM_SPI_SS_MASTER_HW_INPUT</a>   (3UL << ARM_SPI_SS_MASTER_MODE_Pos)</td></tr>
<tr class="memdesc:ga8561bd0cc25ab2bb02b138c1c6a586cd"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave Select when Master: Hardware monitored Input. <a href="#ga8561bd0cc25ab2bb02b138c1c6a586cd">More...</a><br/></td></tr>
<tr class="separator:ga8561bd0cc25ab2bb02b138c1c6a586cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2bd0d1f3ade2dc0cc48cc0593336ad70"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html#ga2bd0d1f3ade2dc0cc48cc0593336ad70">ARM_SPI_SS_SLAVE_HW</a>   (0UL << ARM_SPI_SS_SLAVE_MODE_Pos)</td></tr>
<tr class="memdesc:ga2bd0d1f3ade2dc0cc48cc0593336ad70"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave Select when Slave: Hardware monitored (default) <a href="#ga2bd0d1f3ade2dc0cc48cc0593336ad70">More...</a><br/></td></tr>
<tr class="separator:ga2bd0d1f3ade2dc0cc48cc0593336ad70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad371f6ba0d12a57bdcc3217c351abfb0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi__slave__select__mode__ctrls.html#gad371f6ba0d12a57bdcc3217c351abfb0">ARM_SPI_SS_SLAVE_SW</a>   (1UL << ARM_SPI_SS_SLAVE_MODE_Pos)</td></tr>
<tr class="memdesc:gad371f6ba0d12a57bdcc3217c351abfb0"><td class="mdescLeft"> </td><td class="mdescRight">SPI Slave Select when Slave: Software controlled. <a href="#gad371f6ba0d12a57bdcc3217c351abfb0">More...</a><br/></td></tr>
<tr class="separator:gad371f6ba0d12a57bdcc3217c351abfb0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies SPI slave select mode. </p>
<p><b>SPI</b> <b>Slave</b> <b>Select</b> <b>Mode</b> configures the behavior of the <b>Slave</b> <b>Select</b> <b></b>(SS) signal. The configuration is separate for <b>Master</b> (ARM_SPI_SS_MASTER_*) and for <b>Slave</b> (<a class="el" href="group__spi__slave__select__mode__ctrls.html#ga2bd0d1f3ade2dc0cc48cc0593336ad70">ARM_SPI_SS_SLAVE_HW</a>, <a class="el" href="group__spi__slave__select__mode__ctrls.html#gad371f6ba0d12a57bdcc3217c351abfb0">ARM_SPI_SS_SLAVE_SW</a>). The active configuration depends on the current state (Master/Slave). </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gae19343adc7bd71408b51733171f99dc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SS_MASTER_UNUSED   (0UL << ARM_SPI_SS_MASTER_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave Select when Master: Not used (default) </p>
<p>An SPI master does not drive or monitor the SS line. For example, when connecting to a single slave, the SS line can be connected to a fixed low level. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab5e319aa3f9d4d8c9ed92f0fe865f624"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SS_MASTER_SW   (1UL << ARM_SPI_SS_MASTER_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave Select when Master: Software controlled. </p>
<p>SS is configured as an output and controlled via <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> (<a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>). By default, it is not active (high). It is activated (low) by <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> (<a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="el" href="Driver__SPI_8h.html#a3f465cdbd1238ddd74f78e14457076c4">ARM_SPI_SS_ACTIVE</a>) and deactivated by <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> (<a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="el" href="Driver__SPI_8h.html#a335b448e07422e9c25616a693ec581cc">ARM_SPI_SS_INACTIVE</a>). It is not affected by transfer/send/receive functions. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga07762709a40dc90aca85553f500c8761"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SS_MASTER_HW_OUTPUT   (2UL << ARM_SPI_SS_MASTER_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave Select when Master: Hardware controlled Output. </p>
<p>Here, SS is configured as an output. It will be automatically activated/deactivated for the transfers by hardware (not controlled by <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> (<a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>)). The activation/deactivation of the line is completely hardware dependent. Typically, the hardware will activate it before starting a transfer and deactivate it after a transfer completes. Some hardware will leave it activated as long as the SPI stays master. Due to different hardware behavior, this mode is typically not useful because certain devices require that the SS signal is strictly defined with regards to transfers. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8561bd0cc25ab2bb02b138c1c6a586cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SS_MASTER_HW_INPUT   (3UL << ARM_SPI_SS_MASTER_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave Select when Master: Hardware monitored Input. </p>
<p>This is normally used in a multi-master configuration, where a master does not drive the SS line when driving the bus but only monitors it. When another master activates this line, the active master backs off. This is called <b>mode</b> <b>fault</b>. SS is configured as input and the hardware only monitors it. When it is externally deactivated while being the master, it presents a mode fault and the SPI switches to <b>inactive</b> mode. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2bd0d1f3ade2dc0cc48cc0593336ad70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SS_SLAVE_HW   (0UL << ARM_SPI_SS_SLAVE_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave Select when Slave: Hardware monitored (default) </p>
<p>Hardware monitors the SS line and accepts transfers only when SS line is activate. Transfers while SS is not active are ignored. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad371f6ba0d12a57bdcc3217c351abfb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SPI_SS_SLAVE_SW   (1UL << ARM_SPI_SS_SLAVE_MODE_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI Slave Select when Slave: Software controlled. </p>
<p>Used only when SS line is not used. For example, when a single master and slave are connected in a system, the SS line is not needed (reduces the number of lines and pins used). Slave responses are controlled by software (by default, it is not responding). Software enables/disables transfers by calling <a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a">ARM_SPI_Control</a> (<a class="el" href="group__spi__misc__ctrls.html#ga5776272b82decff92da003568540c92f">ARM_SPI_CONTROL_SS</a>, <a class="el" href="Driver__SPI_8h.html#a3f465cdbd1238ddd74f78e14457076c4">ARM_SPI_SS_ACTIVE</a> / <a class="el" href="Driver__SPI_8h.html#a335b448e07422e9c25616a693ec581cc">ARM_SPI_SS_INACTIVE</a>). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__spi__interface__gr.html#gad18d229992598d6677bec250015e5d1a" title="Control SPI Interface. ">ARM_SPI_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__spi__slave__select__mode__ctrls.html | HTML | apache-2.0 | 18,548 |
var group__spi__slave__select__mode__ctrls =
[
[ "ARM_SPI_SS_MASTER_UNUSED", "group__spi__slave__select__mode__ctrls.html#gae19343adc7bd71408b51733171f99dc7", null ],
[ "ARM_SPI_SS_MASTER_SW", "group__spi__slave__select__mode__ctrls.html#gab5e319aa3f9d4d8c9ed92f0fe865f624", null ],
[ "ARM_SPI_SS_MASTER_HW_OUTPUT", "group__spi__slave__select__mode__ctrls.html#ga07762709a40dc90aca85553f500c8761", null ],
[ "ARM_SPI_SS_MASTER_HW_INPUT", "group__spi__slave__select__mode__ctrls.html#ga8561bd0cc25ab2bb02b138c1c6a586cd", null ],
[ "ARM_SPI_SS_SLAVE_HW", "group__spi__slave__select__mode__ctrls.html#ga2bd0d1f3ade2dc0cc48cc0593336ad70", null ],
[ "ARM_SPI_SS_SLAVE_SW", "group__spi__slave__select__mode__ctrls.html#gad371f6ba0d12a57bdcc3217c351abfb0", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__spi__slave__select__mode__ctrls.js | JavaScript | apache-2.0 | 783 |
<!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>Storage Interface</title>
<title>CMSIS-Driver: Storage 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__storage__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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Storage Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Storage Device Interface (Driver_Storage.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__StorageDriverFunctions"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__StorageDriverFunctions.html">Use of Storage APIs</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__SampleUseOfStorageDriver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SampleUseOfStorageDriver.html">Sample Use of Storage Driver</a></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__STORAGE__BLOCK__ATTRIBUTES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES">ARM_STORAGE_BLOCK_ATTRIBUTES</a></td></tr>
<tr class="memdesc:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="mdescLeft"> </td><td class="mdescRight">Attributes of the storage range within a storage block. <a href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES">More...</a><br/></td></tr>
<tr class="separator:structARM__STORAGE__BLOCK__ATTRIBUTES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__BLOCK"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a></td></tr>
<tr class="memdesc:structARM__STORAGE__BLOCK"><td class="mdescLeft"> </td><td class="mdescRight">A storage block is a range of memory with uniform attributes. <a href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">More...</a><br/></td></tr>
<tr class="separator:structARM__STORAGE__BLOCK"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__INFO"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a></td></tr>
<tr class="separator:structARM__STORAGE__INFO"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__DRIVER__STORAGE"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a></td></tr>
<tr class="separator:structARM__DRIVER__STORAGE"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__STORAGE__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">Storage Driver API Capabilities. <a href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__STORAGE__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__STORAGE__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a></td></tr>
<tr class="memdesc:structARM__STORAGE__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">Operating status of the storage controller. <a href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__STORAGE__STATUS"><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:ga4b290224fea782e6d2ad06f541b28a98"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> )(int32_t status, <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> operation)</td></tr>
<tr class="separator:ga4b290224fea782e6d2ad06f541b28a98"><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:ga3a9277f89946d61c41b22da72e3eef7c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a> { <br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cac82e2ca0f9b7ec94e24ae56c45f12f8c">ARM_STORAGE_OPERATION_GET_VERSION</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca314621ae4384fef7094d8724d59b65c4">ARM_STORAGE_OPERATION_GET_CAPABILITIES</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971">ARM_STORAGE_OPERATION_INITIALIZE</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cab9488e567ad58b16c5df2637df3902e9">ARM_STORAGE_OPERATION_UNINITIALIZE</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca213a74ac5a692a80f17fd6d8e6565e05">ARM_STORAGE_OPERATION_POWER_CONTROL</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454">ARM_STORAGE_OPERATION_READ_DATA</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0">ARM_STORAGE_OPERATION_PROGRAM_DATA</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75">ARM_STORAGE_OPERATION_ERASE</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca60a0511bd5e32db2a22d3ab2023a601e">ARM_STORAGE_OPERATION_ERASE_ALL</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca7c595cd3c439753efe0a0b17efd7bb7f">ARM_STORAGE_OPERATION_GET_STATUS</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca0fe0ef7c0a9e69d053a0419282248f40">ARM_STORAGE_OPERATION_GET_INFO</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca3292512d0222e4119d0cdf77de1508df">ARM_STORAGE_OPERATION_RESOLVE_ADDRESS</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7ca9bfab6ee9caa3ace32338d4ef2d856f5">ARM_STORAGE_OPERATION_GET_NEXT_BLOCK</a>,
<br/>
  <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7cac75096931c3d29af1029f25fc44e7523">ARM_STORAGE_OPERATION_GET_BLOCK</a>
<br/>
}</td></tr>
<tr class="separator:ga3a9277f89946d61c41b22da72e3eef7c"><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:gaf28193431b1a2ee64b22bfb36aed27e3"><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__storage__interface__gr.html#gaf28193431b1a2ee64b22bfb36aed27e3">ARM_Storage_GetVersion</a> (void)</td></tr>
<tr class="memdesc:gaf28193431b1a2ee64b22bfb36aed27e3"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#gaf28193431b1a2ee64b22bfb36aed27e3">More...</a><br/></td></tr>
<tr class="separator:gaf28193431b1a2ee64b22bfb36aed27e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8378b3901dfe76d8f31728a50e10dae2"><td class="memItemLeft" align="right" valign="top">ARM_STOR_CAPABILITIES </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2">ARM_Storage_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga8378b3901dfe76d8f31728a50e10dae2"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga8378b3901dfe76d8f31728a50e10dae2">More...</a><br/></td></tr>
<tr class="separator:ga8378b3901dfe76d8f31728a50e10dae2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc5dc090a35ac16caff8957030eaa174"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174">ARM_Storage_Initialize</a> (<a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> callback)</td></tr>
<tr class="memdesc:gacc5dc090a35ac16caff8957030eaa174"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the Storage interface. <a href="#gacc5dc090a35ac16caff8957030eaa174">More...</a><br/></td></tr>
<tr class="separator:gacc5dc090a35ac16caff8957030eaa174"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d14b15ddcda2836c6e3c1d0b5e60dca"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca">ARM_Storage_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:ga1d14b15ddcda2836c6e3c1d0b5e60dca"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize the Storage Interface. <a href="#ga1d14b15ddcda2836c6e3c1d0b5e60dca">More...</a><br/></td></tr>
<tr class="separator:ga1d14b15ddcda2836c6e3c1d0b5e60dca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga979a2484bf05b2986de95a5d98307d54"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54">ARM_Storage_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga979a2484bf05b2986de95a5d98307d54"><td class="mdescLeft"> </td><td class="mdescRight">Control the Storage interface power. <a href="#ga979a2484bf05b2986de95a5d98307d54">More...</a><br/></td></tr>
<tr class="separator:ga979a2484bf05b2986de95a5d98307d54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabaa24553c165add98020434c980b3ab4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gabaa24553c165add98020434c980b3ab4">ARM_Storage_ReadData</a> (uint64_t addr, void *data, uint32_t size)</td></tr>
<tr class="memdesc:gabaa24553c165add98020434c980b3ab4"><td class="mdescLeft"> </td><td class="mdescRight">Read data from Storage. <a href="#gabaa24553c165add98020434c980b3ab4">More...</a><br/></td></tr>
<tr class="separator:gabaa24553c165add98020434c980b3ab4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd20d561854c06918b0515b6c1bba230"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230">ARM_Storage_ProgramData</a> (uint64_t addr, const void *data, uint32_t size)</td></tr>
<tr class="memdesc:gabd20d561854c06918b0515b6c1bba230"><td class="mdescLeft"> </td><td class="mdescRight">Program data to Storage. <a href="#gabd20d561854c06918b0515b6c1bba230">More...</a><br/></td></tr>
<tr class="separator:gabd20d561854c06918b0515b6c1bba230"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaceef4851d9181cce65c8b2d05f4429bc"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gaceef4851d9181cce65c8b2d05f4429bc">ARM_Storage_Erase</a> (uint64_t addr, uint32_t size)</td></tr>
<tr class="memdesc:gaceef4851d9181cce65c8b2d05f4429bc"><td class="mdescLeft"> </td><td class="mdescRight">Erase Storage range. <a href="#gaceef4851d9181cce65c8b2d05f4429bc">More...</a><br/></td></tr>
<tr class="separator:gaceef4851d9181cce65c8b2d05f4429bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04e77387a3c628d6fc661e82f7daddaa"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a> (void)</td></tr>
<tr class="memdesc:ga04e77387a3c628d6fc661e82f7daddaa"><td class="mdescLeft"> </td><td class="mdescRight">Erase complete Storage. <a href="#ga04e77387a3c628d6fc661e82f7daddaa">More...</a><br/></td></tr>
<tr class="separator:ga04e77387a3c628d6fc661e82f7daddaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29e7bfe78f41abb16973bdb4e0188a20"><td class="memItemLeft" align="right" valign="top">ARM_Storage_STATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20">ARM_Storage_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga29e7bfe78f41abb16973bdb4e0188a20"><td class="mdescLeft"> </td><td class="mdescRight">Get Storage status. <a href="#ga29e7bfe78f41abb16973bdb4e0188a20">More...</a><br/></td></tr>
<tr class="separator:ga29e7bfe78f41abb16973bdb4e0188a20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad557e8e6e33cd4528d398ecf4dddc747"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747">ARM_Storage_GetInfo</a> (<a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> *info)</td></tr>
<tr class="memdesc:gad557e8e6e33cd4528d398ecf4dddc747"><td class="mdescLeft"> </td><td class="mdescRight">Get Storage information. <a href="#gad557e8e6e33cd4528d398ecf4dddc747">More...</a><br/></td></tr>
<tr class="separator:gad557e8e6e33cd4528d398ecf4dddc747"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a1934750a51c74b8b0fea52588a3b9a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga5a1934750a51c74b8b0fea52588a3b9a">ARM_Storage_ResolveAddress</a> (uint64_t addr)</td></tr>
<tr class="memdesc:ga5a1934750a51c74b8b0fea52588a3b9a"><td class="mdescLeft"> </td><td class="mdescRight">Resolve an address relative to the storage controller into a memory address. <a href="#ga5a1934750a51c74b8b0fea52588a3b9a">More...</a><br/></td></tr>
<tr class="separator:ga5a1934750a51c74b8b0fea52588a3b9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad318f8cb38626cbeea1fcf36a0977c44"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#gad318f8cb38626cbeea1fcf36a0977c44">ARM_Storage_GetNextBlock</a> (const <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *prev_block, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *next_block)</td></tr>
<tr class="memdesc:gad318f8cb38626cbeea1fcf36a0977c44"><td class="mdescLeft"> </td><td class="mdescRight">Advance to the successor of the current block (iterator). <a href="#gad318f8cb38626cbeea1fcf36a0977c44">More...</a><br/></td></tr>
<tr class="separator:gad318f8cb38626cbeea1fcf36a0977c44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5fe9d27ce8afe65124dec62566114073"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ga5fe9d27ce8afe65124dec62566114073">ARM_Storage_GetBlock</a> (uint64_t addr, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *block)</td></tr>
<tr class="memdesc:ga5fe9d27ce8afe65124dec62566114073"><td class="mdescLeft"> </td><td class="mdescRight">Find the storage block (iterator) encompassing a given storage address. <a href="#ga5fe9d27ce8afe65124dec62566114073">More...</a><br/></td></tr>
<tr class="separator:ga5fe9d27ce8afe65124dec62566114073"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Storage Device Interface (Driver_Storage.h) </p>
<p>This is an abstraction for a storage controller. It offers an interface to access an address space of storage locations, comprising APIs for initialization, erase, access, program, and status-fetch operations. It also offers APIs to iterate over the available Storage Blocks (<a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a>), allowing the discovery of block attributes such as write/erase granularities. Using the Storage abstraction, it becomes possible to write generic algorithms, such as block copy, to operate on any conforming storage device.</p>
<dl class="section note"><dt>Note</dt><dd>The storage abstraction layer is not responsible for storage management. Algorithms such as block-allocation, wear-leveling, erase-before-write and other storage-management policies are the responsibility of modules external to the storage abstraction layer. In essence, the storage interface is the lowest abstraction upon which block management policies can be implemented.</dd></dl>
<p>Here's a picture to help locate the storage abstraction in the software stack. The part below the box labeled 'Storage abstraction layer' is implemented by a storage driver.</p>
<div class="image">
<img src="storage_sw_stack.png" alt="storage_sw_stack.png"/>
</div>
<p><b>Storage API</b></p>
<p>The following header files define the Application Programming Interface (API) for the Flash interface:</p>
<ul>
<li><b>Driver_Storage.h</b> : Driver API for Storage Device Interface</li>
</ul>
<p><b>Driver Functions</b></p>
<p>The driver functions are published in the access struct as explained in <a class="el" href="group__StorageDriverFunctions.html">Use of Storage APIs</a></p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> : access struct for Storage driver functions</li>
</ul>
<p>A sample use for the driver can be found at: <a class="el" href="group__SampleUseOfStorageDriver.html">Sample Use of Storage Driver</a> </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__STORAGE__BLOCK__ATTRIBUTES" id="structARM__STORAGE__BLOCK__ATTRIBUTES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_STORAGE_BLOCK_ATTRIBUTES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Attributes of the storage range within a storage block. </p>
<p><b>Contained in:</b></p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab350afb2119388ebd3f096bd24f019ef"></a>uint32_t</td>
<td class="fieldname">
erasable: 1</td>
<td class="fielddoc">
Erasing blocks is permitted with a minimum granularity of 'erase_unit'. <dl class="section note"><dt>Note</dt><dd>if 'erasable' is 0 (i.e. the 'erase' operation isn't available) then 'erase_unit' (see below) is immaterial and should be 0. </dd></dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7f4aebaeeb818b0e2a0592f96559fa1b"></a>uint32_t</td>
<td class="fieldname">
programmable: 1</td>
<td class="fielddoc">
Writing to ranges is permitted with a minimum granularity of 'program_unit'. Writes are typically achieved through the ProgramData operation (following an erase); if storage isn't erasable (see 'erasable' above) but is memory-mapped (i.e. 'memory_mapped'), it can be written directly using memory-store operations. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a910da8e2e909faab1d32cca7f8b05656"></a>uint32_t</td>
<td class="fieldname">
executable: 1</td>
<td class="fielddoc">
This storage block can hold program data; the processor can fetch and execute code sourced from it. Often this is accompanied with the device being 'memory_mapped' (see <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7c8899f46a471e1b7698a75a759e67c1"></a>uint32_t</td>
<td class="fieldname">
protectable: 1</td>
<td class="fielddoc">
The entire block can be protected from program and erase operations. Once protection is enabled for a block, its 'erasable' and 'programmable' bits are turned off. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 28</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aac21d3f798c9fcad415b99cf4157935a"></a>uint32_t</td>
<td class="fieldname">
erase_unit</td>
<td class="fielddoc">
Minimum erase size in bytes. The offset of the start of the erase-range should also be aligned with this value. Applicable if the 'erasable' attribute is set for the block. <dl class="section note"><dt>Note</dt><dd>if 'erasable' (see above) is 0 (i.e. the 'erase' operation isn't available) then 'erase_unit' is immaterial and should be 0. </dd></dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae319384dfb356cbb0b08ccbf8c04a590"></a>uint32_t</td>
<td class="fieldname">
protection_unit</td>
<td class="fielddoc">
Minimum protectable size in bytes. Applicable if the 'protectable' attribute is set for the block. This should be a divisor of the block's size. A block can be considered to be made up of consecutive, individually-protectable fragments. </td></tr>
</table>
</div>
</div>
<a name="structARM__STORAGE__BLOCK" id="structARM__STORAGE__BLOCK"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_STORAGE_BLOCK</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>A storage block is a range of memory with uniform attributes. </p>
<p>Storage blocks combine to make up the address map of a storage controller. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0e89cf6b9f6cd3125470b1bed2b823df"></a>uint64_t</td>
<td class="fieldname">
addr</td>
<td class="fielddoc">
This is the start address of the storage block. It is expressed as an offset from the start of the storage map maintained by the owning storage controller. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af931a8871310b4dad23f0f0b0f623560"></a>uint64_t</td>
<td class="fieldname">
size</td>
<td class="fielddoc">
This is the size of the storage block, in units of bytes. Together with addr, it describes a range [addr, addr+size). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ade62c905888479b4f6d078d45cec5830"></a><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES">ARM_STORAGE_BLOCK_ATTRIBUTES</a></td>
<td class="fieldname">
attributes</td>
<td class="fielddoc">
Attributes for this block. </td></tr>
</table>
</div>
</div>
<a name="structARM__STORAGE__INFO" id="structARM__STORAGE__INFO"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_STORAGE_INFO</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Device level metadata regarding the Storage implementation.</p>
<p>It describes the characteristics of a Storage device. This includes total storage, programming size, a default value for erased memory etc. This information can be obtained from the Storage device datasheet and is used by the middleware in order to properly interact with the Storage device.</p>
<p>Total available storage (in bytes) is contained in <em>total_storage</em>. Minimum programming size (in bytes) is described by <em>program_unit</em> (applicable only if the <em>programmable</em> attribute is set for a block). It defines the granularity for programming data. The offset of the start of a program-range and the size should also be aligned with <em>program_unit</em>. </p>
<dl class="section note"><dt>Note</dt><dd>: setting <em>program_unit</em> to 0 has the effect of disabling the size and alignment restrictions (setting it to 1 also has the same effect).</dd></dl>
<p>Optimal programming page-size (in bytes) is specified by <em>optimal_program_unit</em>. Some storage controllers have internal buffers into which to receive data. Writing in chunks of <em>optimal_program_unit</em> would achieve maximum programming speed. Like with <em>program_unit</em>, this is applicable only if the <em>programmable</em> attribute is set for the underlying storage block(s).</p>
<p><em>program_cycles</em> is a measure of endurance for reprogramming. A value of <em>ARM_STORAGE_PROGRAM_CYCLES_INFINITE</em> may be used to signify infinite or unknown endurance.</p>
<p>Contents of erased memory is specified by the <em>erased_value</em>. It is usually <span class="XML-Token">1</span> to indicate erased bytes with state 0xFF.</p>
<p><em>memory_mapped</em> can be set to <span class="XML-Token">1</span> to indicate that the storage device has a mapping onto the processor's memory address space. </p>
<dl class="section note"><dt>Note</dt><dd>: For a memory-mapped block which isn't erasable but is programmable, writes should be possible directly to the memory-mapped storage without going through the <a class="el" href="group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230">ARM_Storage_ProgramData</a> operation.</dd></dl>
<p>The field <em>programmability</em> holds a value to indicate storage programmability. Similarly, <em>retention_level</em> holds a for encoding data-retention levels for all storage blocks.</p>
<dl class="section note"><dt>Note</dt><dd>These fields serve a different purpose than the ones contained in <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a>, which is another structure containing device-level metadata. <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES" title="Storage Driver API Capabilities. ">ARM_STORAGE_CAPABILITIES</a> describes the API capabilities, whereas <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> describes the device. Furthermore <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES" title="Storage Driver API Capabilities. ">ARM_STORAGE_CAPABILITIES</a> fits within a single word, and is designed to be passed around by value; <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>, on the other hand, contains metadata which doesn't fit into a single word and requires the use of pointers to be moved around.</dd></dl>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747">ARM_Storage_GetInfo</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a4b14ce1ca2ceea5ce49e81348c5b38f6"></a>uint64_t</td>
<td class="fieldname">
total_storage</td>
<td class="fielddoc">
Total available storage, in bytes. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a483c41066757e2865bf3a27a2a627a54"></a>uint32_t</td>
<td class="fieldname">
program_unit</td>
<td class="fielddoc">
Minimum programming size in bytes. The offset of the start of the program-range should also be aligned with this value. Applicable only if the 'programmable' attribute is set for a block. <dl class="section note"><dt>Note</dt><dd>setting program_unit to 0 has the effect of disabling the size and alignment restrictions (setting it to 1 also has the same effect). </dd></dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a407e16dc7e4da08cea7785efeebd9b6d"></a>uint32_t</td>
<td class="fieldname">
optimal_program_unit</td>
<td class="fielddoc">
Optimal programming page-size in bytes. Some storage controllers have internal buffers into which to receive data. Writing in chunks of 'optimal_program_unit' would achieve maximum programming speed. Applicable only if the 'programmable' attribute is set for the underlying block(s). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac501623ba5adb4904cdd6c286e7388eb"></a>uint32_t</td>
<td class="fieldname">
program_cycles</td>
<td class="fielddoc">
A measure of endurance for reprogramming. Use ARM_STORAGE_PROGRAM_CYCLES_INFINITE for infinite or unknown endurance. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a902510dbedab116ab6a260a83fbd0f27"></a>uint32_t</td>
<td class="fieldname">
erased_value: 1</td>
<td class="fielddoc">
Contents of erased memory (usually 1 to indicate erased bytes with state 0xFF). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a616b41da466430ed481d791e63784f0c"></a>uint32_t</td>
<td class="fieldname">
memory_mapped: 1</td>
<td class="fielddoc">
This storage device has a mapping onto the processor's memory address space. <dl class="section note"><dt>Note</dt><dd>For a memory-mapped block which isn't erasable but is programmable (i.e. if 'erasable' is set to 0, but 'programmable' is 1), writes should be possible directly to the memory-mapped storage without going through the ProgramData operation. </dd></dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aac0da06bf0775bd9b877aafbc4bcad77"></a>uint32_t</td>
<td class="fieldname">
programmability: 4</td>
<td class="fielddoc">
A value to indicate storage programmability. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a16d1a2aead689ffa28fd89cb6779e5a7"></a>uint32_t</td>
<td class="fieldname">
retention_level: 4</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 22</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aee43dd20848f45fe05efc10a8198817a"></a><a class="el" href="Driver__Storage_8h.html#structARM__STORAGE__SECURITY__FEATURES">ARM_STORAGE_SECURITY_FEATURES</a></td>
<td class="fieldname">
security</td>
<td class="fielddoc">
<a class="el" href="Driver__Storage_8h.html#structARM__STORAGE__SECURITY__FEATURES">ARM_STORAGE_SECURITY_FEATURES</a> </td></tr>
</table>
</div>
</div>
<a name="structARM__DRIVER__STORAGE" id="structARM__DRIVER__STORAGE"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_STORAGE</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>The set of operations constituting the Storage driver.</p>
<p>This is the set of operations constituting the Storage driver. Their implementation is platform-specific, and needs to be supplied by the porting effort. The functions of the Storage driver are accessed by function pointers exposed by this structure. Refer to <a class="el" href="group__StorageDriverFunctions.html">Use of Storage APIs</a> for overview information.</p>
<p>Each instance of a Storage interface 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_Storage0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_Storage1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_Flash<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__storage__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__storage__interface__gr.html#gaf28193431b1a2ee64b22bfb36aed27e3">ARM_Storage_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:abbfb3aa4b6adb4407de79221bf12cc55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:abbfb3aa4b6adb4407de79221bf12cc55"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2">ARM_Storage_GetCapabilities</a> : Get driver capabilities. <a href="#abbfb3aa4b6adb4407de79221bf12cc55">More...</a><br/></td></tr>
<tr class="separator:abbfb3aa4b6adb4407de79221bf12cc55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a126668a113ce450b0d831c74199b23"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#a4a126668a113ce450b0d831c74199b23">Initialize</a> )(<a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> callback)</td></tr>
<tr class="memdesc:a4a126668a113ce450b0d831c74199b23"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174">ARM_Storage_Initialize</a> : Initialize the Storage Interface. <a href="#a4a126668a113ce450b0d831c74199b23">More...</a><br/></td></tr>
<tr class="separator:a4a126668a113ce450b0d831c74199b23"><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__storage__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__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca">ARM_Storage_Uninitialize</a> : De-initialize the Storage 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__storage__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__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54">ARM_Storage_PowerControl</a> : Control the Storage interface power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79b015933daca07a88f98a8f20e1144d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#a79b015933daca07a88f98a8f20e1144d">ReadData</a> )(uint64_t addr, void *data, uint32_t size)</td></tr>
<tr class="memdesc:a79b015933daca07a88f98a8f20e1144d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#gabaa24553c165add98020434c980b3ab4">ARM_Storage_ReadData</a> : Read data from Storage. <a href="#a79b015933daca07a88f98a8f20e1144d">More...</a><br/></td></tr>
<tr class="separator:a79b015933daca07a88f98a8f20e1144d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedda6cc77ea7c4ef2356c683f9013d8b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#aedda6cc77ea7c4ef2356c683f9013d8b">ProgramData</a> )(uint64_t addr, const void *data, uint32_t size)</td></tr>
<tr class="memdesc:aedda6cc77ea7c4ef2356c683f9013d8b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230">ARM_Storage_ProgramData</a> : Program data to Storage. <a href="#aedda6cc77ea7c4ef2356c683f9013d8b">More...</a><br/></td></tr>
<tr class="separator:aedda6cc77ea7c4ef2356c683f9013d8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb5018d1afb3ea4632e6e6006314f37f"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#abb5018d1afb3ea4632e6e6006314f37f">Erase</a> )(uint64_t addr, uint32_t size)</td></tr>
<tr class="memdesc:abb5018d1afb3ea4632e6e6006314f37f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#gaceef4851d9181cce65c8b2d05f4429bc">ARM_Storage_Erase</a> : Erase Storage range. <a href="#abb5018d1afb3ea4632e6e6006314f37f">More...</a><br/></td></tr>
<tr class="separator:abb5018d1afb3ea4632e6e6006314f37f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4dc5af362c0f2043138618aea9c6a73"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#ad4dc5af362c0f2043138618aea9c6a73">EraseAll</a> )(void)</td></tr>
<tr class="memdesc:ad4dc5af362c0f2043138618aea9c6a73"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a> : Erase complete Storage. <a href="#ad4dc5af362c0f2043138618aea9c6a73">More...</a><br/></td></tr>
<tr class="separator:ad4dc5af362c0f2043138618aea9c6a73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a820e9b9de75ebe93e64b067468b369af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#a820e9b9de75ebe93e64b067468b369af">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:a820e9b9de75ebe93e64b067468b369af"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20">ARM_Storage_GetStatus</a> : Get Storage status. <a href="#a820e9b9de75ebe93e64b067468b369af">More...</a><br/></td></tr>
<tr class="separator:a820e9b9de75ebe93e64b067468b369af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec80a5d1ccf1cd996f6e863ac8868d65"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#aec80a5d1ccf1cd996f6e863ac8868d65">GetInfo</a> )(<a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> *info)</td></tr>
<tr class="memdesc:aec80a5d1ccf1cd996f6e863ac8868d65"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747">ARM_Storage_GetInfo</a> : Get Storage information. <a href="#aec80a5d1ccf1cd996f6e863ac8868d65">More...</a><br/></td></tr>
<tr class="separator:aec80a5d1ccf1cd996f6e863ac8868d65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e1b3f9abb40bb5c70c6141587ee6e6a"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#a6e1b3f9abb40bb5c70c6141587ee6e6a">ResolveAddress</a> )(uint64_t addr)</td></tr>
<tr class="memdesc:a6e1b3f9abb40bb5c70c6141587ee6e6a"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#ga5a1934750a51c74b8b0fea52588a3b9a">ARM_Storage_ResolveAddress</a> : Resolve a storage address. <a href="#a6e1b3f9abb40bb5c70c6141587ee6e6a">More...</a><br/></td></tr>
<tr class="separator:a6e1b3f9abb40bb5c70c6141587ee6e6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adda93f4d74519247517f036c4551dd13"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#adda93f4d74519247517f036c4551dd13">GetNextBlock</a> )(const <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *prev, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *next)</td></tr>
<tr class="memdesc:adda93f4d74519247517f036c4551dd13"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#gad318f8cb38626cbeea1fcf36a0977c44">ARM_Storage_GetNextBlock</a> : fetch successor for current block. <a href="#adda93f4d74519247517f036c4551dd13">More...</a><br/></td></tr>
<tr class="separator:adda93f4d74519247517f036c4551dd13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af43edebfb5463d22ffeda6de20e1d1bd"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__storage__interface__gr.html#af43edebfb5463d22ffeda6de20e1d1bd">GetBlock</a> )(uint64_t addr, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *block)</td></tr>
<tr class="memdesc:af43edebfb5463d22ffeda6de20e1d1bd"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__storage__interface__gr.html#ga5fe9d27ce8afe65124dec62566114073">ARM_Storage_GetBlock</a> : <a href="#af43edebfb5463d22ffeda6de20e1d1bd">More...</a><br/></td></tr>
<tr class="separator:af43edebfb5463d22ffeda6de20e1d1bd"><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__storage__interface__gr.html#gaf28193431b1a2ee64b22bfb36aed27e3">ARM_Storage_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="abbfb3aa4b6adb4407de79221bf12cc55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2">ARM_Storage_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a4a126668a113ce450b0d831c74199b23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> callback)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174">ARM_Storage_Initialize</a> : Initialize the Storage 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__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca">ARM_Storage_Uninitialize</a> : De-initialize the Storage 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__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54">ARM_Storage_PowerControl</a> : Control the Storage interface power. </p>
</div>
</div>
<a class="anchor" id="a79b015933daca07a88f98a8f20e1144d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadData)(uint64_t addr, void *data, uint32_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#gabaa24553c165add98020434c980b3ab4">ARM_Storage_ReadData</a> : Read data from Storage. </p>
</div>
</div>
<a class="anchor" id="aedda6cc77ea7c4ef2356c683f9013d8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ProgramData)(uint64_t addr, const void *data, uint32_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230">ARM_Storage_ProgramData</a> : Program data to Storage. </p>
</div>
</div>
<a class="anchor" id="abb5018d1afb3ea4632e6e6006314f37f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Erase)(uint64_t addr, uint32_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#gaceef4851d9181cce65c8b2d05f4429bc">ARM_Storage_Erase</a> : Erase Storage range. </p>
</div>
</div>
<a class="anchor" id="ad4dc5af362c0f2043138618aea9c6a73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EraseAll)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a> : Erase complete Storage. </p>
</div>
</div>
<a class="anchor" id="a820e9b9de75ebe93e64b067468b369af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20">ARM_Storage_GetStatus</a> : Get Storage status. </p>
</div>
</div>
<a class="anchor" id="aec80a5d1ccf1cd996f6e863ac8868d65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetInfo)(<a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> *info)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747">ARM_Storage_GetInfo</a> : Get Storage information. </p>
</div>
</div>
<a class="anchor" id="a6e1b3f9abb40bb5c70c6141587ee6e6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* ResolveAddress)(uint64_t addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#ga5a1934750a51c74b8b0fea52588a3b9a">ARM_Storage_ResolveAddress</a> : Resolve a storage address. </p>
</div>
</div>
<a class="anchor" id="adda93f4d74519247517f036c4551dd13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetNextBlock)(const <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *prev, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *next)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#gad318f8cb38626cbeea1fcf36a0977c44">ARM_Storage_GetNextBlock</a> : fetch successor for current block. </p>
</div>
</div>
<a class="anchor" id="af43edebfb5463d22ffeda6de20e1d1bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetBlock)(uint64_t addr, <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> *block)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__storage__interface__gr.html#ga5fe9d27ce8afe65124dec62566114073">ARM_Storage_GetBlock</a> : </p>
</div>
</div>
</div>
</div>
<a name="structARM__STORAGE__CAPABILITIES" id="structARM__STORAGE__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_STORAGE_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Storage Driver API Capabilities. </p>
<p>A Storage driver can be implemented with different capabilities. The data fields of this struct encode the API capabilities implemented by this driver.</p>
<p>The element <em>asynchronous_ops</em> indicates if APIs like initialize, read, erase, program, etc. can operate in asynchronous mode. Having this bit set to 1 means that the driver is capable of launching asynchronous operations; command completion for asynchronous operations is signaled by the invocation of a completion callback. If set to 1, drivers may still complete asynchronous operations synchronously as necessary–in which case they return a positive error code to indicate synchronous completion. If <em>asynchronous_ops</em> 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>The element <em>erase_all</em> specifies that the <a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a> function is supported. Typically full chip erase is much faster than erasing the whole device using <em>ARM_Storage_Erase</em>.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2">ARM_Storage_GetCapabilities</a></li>
</ul>
<dl class="section note"><dt>Note</dt><dd>This data structure is designed to fit within a single word so that it can be fetched cheaply using a call to driver->GetCapabilities(). </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a15ade4ca762bc6ce72d435a16febb4cc"></a>uint32_t</td>
<td class="fieldname">
asynchronous_ops: 1</td>
<td class="fielddoc">
Used to indicate if APIs like initialize, read, erase, program, etc. can operate in asynchronous mode. Setting this bit to 1 means that the driver is capable of launching asynchronous operations; command completion is signaled by the invocation of a completion callback. If set to 1, drivers may still complete asynchronous operations synchronously as necessary (in which case they return a positive error code to indicate synchronous completion). </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a63882f6a571f20aad1b5b3542cdaafa1"></a>uint32_t</td>
<td class="fieldname">
erase_all: 1</td>
<td class="fielddoc">
Supports EraseAll operation. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 30</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__STORAGE__STATUS" id="structARM__STORAGE__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_STORAGE_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Operating status of the storage controller. </p>
<p>Structure with information about the status of the Storage device.</p>
<p>The flag <em>busy</em> indicates that the driver is busy executing read/program/erase operation.</p>
<p>The flag <em>error</em> flag is cleared on start of read/program/erase operation and is set at the end of the current operation in case of error.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20">ARM_Storage_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a50c88f3c1d787773e2ac1b59533f034a"></a>uint32_t</td>
<td class="fieldname">
busy: 1</td>
<td class="fielddoc">
Controller busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa8d183302fdfa4a6892f1d80300cdb32"></a>uint32_t</td>
<td class="fieldname">
error: 1</td>
<td class="fielddoc">
Read/Program/Erase error flag (cleared on start of next operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 30</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga4b290224fea782e6d2ad06f541b28a98"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_Storage_Callback_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the typedef for the callback function <a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a>.</p>
<p>Provides the typedef for the callback function <a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>A code to indicate the status of the completed operation. For data transfer operations, the status field is overloaded in case of success to return the count of bytes successfully transferred; this can be done safely because error codes are negative values.</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">operation</td><td>The command op-code. This value isn't essential, but it is expected that this information could be a quick and useful filter for the handler.</td></tr>
</table>
</dd>
</dl>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174">ARM_Storage_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c">ARM_STORAGE_OPERATION</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Command opcodes for Storage.</p>
<p>Command opcodes for the Storage interface. Completion callbacks use these codes to refer to completing commands. Refer to <a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7cac82e2ca0f9b7ec94e24ae56c45f12f8c"></a>ARM_STORAGE_OPERATION_GET_VERSION</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca314621ae4384fef7094d8724d59b65c4"></a>ARM_STORAGE_OPERATION_GET_CAPABILITIES</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971"></a>ARM_STORAGE_OPERATION_INITIALIZE</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7cab9488e567ad58b16c5df2637df3902e9"></a>ARM_STORAGE_OPERATION_UNINITIALIZE</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca213a74ac5a692a80f17fd6d8e6565e05"></a>ARM_STORAGE_OPERATION_POWER_CONTROL</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454"></a>ARM_STORAGE_OPERATION_READ_DATA</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0"></a>ARM_STORAGE_OPERATION_PROGRAM_DATA</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75"></a>ARM_STORAGE_OPERATION_ERASE</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca60a0511bd5e32db2a22d3ab2023a601e"></a>ARM_STORAGE_OPERATION_ERASE_ALL</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca7c595cd3c439753efe0a0b17efd7bb7f"></a>ARM_STORAGE_OPERATION_GET_STATUS</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca0fe0ef7c0a9e69d053a0419282248f40"></a>ARM_STORAGE_OPERATION_GET_INFO</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca3292512d0222e4119d0cdf77de1508df"></a>ARM_STORAGE_OPERATION_RESOLVE_ADDRESS</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7ca9bfab6ee9caa3ace32338d4ef2d856f5"></a>ARM_STORAGE_OPERATION_GET_NEXT_BLOCK</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga3a9277f89946d61c41b22da72e3eef7cac75096931c3d29af1029f25fc44e7523"></a>ARM_STORAGE_OPERATION_GET_BLOCK</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf28193431b1a2ee64b22bfb36aed27e3"></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_Storage_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_Storage_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__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> read_version (<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"> version = drv_info-><a class="code" href="group__storage__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 --><dl class="section note"><dt>Note</dt><dd>This API returns synchronously–it does not result in an invocation of a completion callback.</dd>
<dd>
The function GetVersion() can be called any time to obtain the required information from the driver (even before initialization). It always returns the same information. </dd></dl>
</div>
</div>
<a class="anchor" id="ga8378b3901dfe76d8f31728a50e10dae2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a> ARM_Storage_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__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_Storage_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the struct <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES" title="Storage Driver API Capabilities. ">ARM_STORAGE_CAPABILITIES</a> encode various capabilities, for example if the device is able to execute operations asynchronously.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__storage__interface__gr.html#structARM__DRIVER__STORAGE">ARM_DRIVER_STORAGE</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__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55">GetCapabilities</a> ();</div>
<div class="line"> <span class="comment">// interrogate capabilities</span></div>
<div class="line"></div>
<div class="line">}</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>This API returns synchronously–it does not result in an invocation of a completion callback.</dd>
<dd>
The function GetCapabilities() can be called any time to obtain the required information from the driver (even before initialization). It always returns the same information. </dd></dl>
</div>
</div>
<a class="anchor" id="gacc5dc090a35ac16caff8957030eaa174"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> </td>
<td class="paramname"><em>callback</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the Storage interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>Pointer to <a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a>. Caller-defined callback to be invoked upon command completion for asynchronous APIs (including the completion of initialization). Use a NULL pointer when no callback signals are required. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If asynchronous activity is launched, invocation ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with a status value of ARM_DRIVER_OK or an error-code. In the case of synchronous execution, control returns after completion with a value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>The function <b>ARM_Storage_Initialize</b> is called when the middleware component starts operation. In addition to bringing the controller to a ready state, Initialize() receives a callback handler to be invoked upon completion of asynchronous operations.</p>
<p><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174" title="Initialize the Storage interface. ">ARM_Storage_Initialize()</a> needs to be called explicitly before powering the peripheral using <a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54" title="Control the Storage interface power. ">ARM_Storage_PowerControl()</a>, and before initiating other accesses to the storage controller.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the Storage interface.</li>
<li>Registers the <a class="el" href="group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98">ARM_Storage_Callback_t</a> callback function.</li>
</ul>
<p>To start working with a peripheral the functions ARM_Storage_Initialize and <a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54" title="Control the Storage interface power. ">ARM_Storage_PowerControl()</a> need to be called in this order: </p>
<div class="fragment"><div class="line">drv-><a class="code" href="group__nand__interface__gr.html#a28b29ab7b6114bb97175bd40d18854ac">Initialize</a> (...); <span class="comment">// Allocate I/O pins</span></div>
<div class="line">drv-><a class="code" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>); <span class="comment">// Power up peripheral, setup IRQ/DMA</span></div>
</div><!-- fragment --><ul>
<li><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174" title="Initialize the Storage interface. ">ARM_Storage_Initialize()</a> typically allocates the I/O resources (pins) for the peripheral. The function can be called multiple times; if the I/O resources are already initialized it performs no operation and just returns with ARM_DRIVER_OK.</li>
<li>ARM_Storage_PowerControl (ARM_POWER_FULL) sets the peripheral registers including interrupt (NVIC) and optionally DMA. The function can be called multiple times; if the registers are already set it performs no operation and just returns with ARM_DRIVER_OK.</li>
</ul>
<p>To stop working with a peripheral the functions <a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54" title="Control the Storage interface power. ">ARM_Storage_PowerControl()</a> and <a class="el" href="group__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca" title="De-initialize the Storage Interface. ">ARM_Storage_Uninitialize()</a> need to be called in this order: </p>
<div class="fragment"><div class="line">drv-><a class="code" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>); <span class="comment">// Terminate any pending transfers, reset IRQ/DMA, power off peripheral</span></div>
<div class="line">drv-><a class="code" href="group__nand__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> (...); <span class="comment">// Release I/O pins</span></div>
</div><!-- fragment --><p>The functions <a class="el" href="group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54" title="Control the Storage interface power. ">ARM_Storage_PowerControl()</a> and <a class="el" href="group__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca" title="De-initialize the Storage Interface. ">ARM_Storage_Uninitialize()</a> always execute and can be used to put the peripheral into a Safe State, for example after any data transmission errors. To restart the peripheral in an error condition, you should first execute the Stop Sequence and then the Start Sequence.</p>
<dl class="section note"><dt>Note</dt><dd>This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1d14b15ddcda2836c6e3c1d0b5e60dca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_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 the Storage Interface. </p>
<dl class="section return"><dt>Returns</dt><dd>If asynchronous activity is launched, an invocation returns ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with a status value of ARM_DRIVER_OK or an error-code. In the case of synchronous execution, control returns after completion with a value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>It is called when the middleware component stops operation, and wishes to release the software resources used by the interface.</p>
<dl class="section note"><dt>Note</dt><dd>This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set. </dd></dl>
</div>
</div>
<a class="anchor" id="ga979a2484bf05b2986de95a5d98307d54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_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 the Storage 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 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If asynchronous activity is launched, an invocation returns ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with a status value of ARM_DRIVER_OK or an error-code. In the case of synchronous execution, control returns after completion with a value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>The function <b>ARM_Storage_PowerControl</b> operates the power modes of the Storage interface.</p>
<p>To start working with a peripheral the functions Initialize and PowerControl need to be called in this order: </p>
<div class="fragment"><div class="line">drv-><a class="code" href="group__nand__interface__gr.html#a28b29ab7b6114bb97175bd40d18854ac">Initialize</a> (...); <span class="comment">// Allocate I/O pins</span></div>
<div class="line">drv-><a class="code" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>); <span class="comment">// Power up peripheral, setup IRQ/DMA</span></div>
</div><!-- fragment --><ul>
<li><a class="el" href="group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174" title="Initialize the Storage interface. ">ARM_Storage_Initialize()</a> typically allocates the I/O resources (pins) for the peripheral. The function can be called multiple times; if the I/O resources are already initialized it performs no operation and just returns with ARM_DRIVER_OK.</li>
<li>PowerControl (ARM_POWER_FULL) sets the peripheral registers including interrupt (NVIC) and optionally DMA. The function can be called multiple times; if the registers are already set it performs no operation and just returns with ARM_DRIVER_OK.</li>
</ul>
<p>To stop working with a peripheral the functions PowerControl and Uninitialize need to be called in this order: </p>
<div class="fragment"><div class="line">drv-><a class="code" href="group__nand__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>); <span class="comment">// Terminate any pending transfers, reset IRQ/DMA, power off peripheral</span></div>
<div class="line">drv-><a class="code" href="group__nand__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> (...); <span class="comment">// Release I/O pins</span></div>
</div><!-- fragment --><p>The functions ARM_Storage_PowerControl and ARM_Storage_Uninitialize always execute and can be used to put the peripheral into a Safe State, for example after any data transmission errors. To restart the peripheral in an error condition, you should first execute the Stop Sequence and then the Start Sequence.</p>
<p>The parameter <em>state</em> can have the following values:</p>
<ul>
<li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up the Storage device for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the device is already in this mode, then 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>
<dl class="section note"><dt>Note</dt><dd>This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set. </dd></dl>
</div>
</div>
<a class="anchor" id="gabaa24553c165add98020434c980b3ab4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_ReadData </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_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 data from Storage. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Data address. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to a buffer storing the data read from Storage. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to read. The data buffer should be at least as large as this size. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If asynchronous activity is launched, an invocation returns ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with the number of successfully transferred bytes passed in as the 'status' parameter. In the case of synchronous execution, control returns after completion with a positive transfer-count. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>Read the contents of a range of storage memory into a buffer supplied by the caller. The buffer is owned by the caller and should remain accessible for the lifetime of this command.</p>
<dl class="section note"><dt>Note</dt><dd>This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set. </dd></dl>
</div>
</div>
<a class="anchor" id="gabd20d561854c06918b0515b6c1bba230"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_ProgramData </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_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>Program data to Storage. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>This is the start address of the range to be written into. It needs to be aligned to the device's <em>program_unit</em> specified in <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The source of the write operation. The buffer is owned by the caller and should remain accessible for the lifetime of this command. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The number of bytes requested to be written. The buffer should be at least as large as this size. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>'size' should be a multiple of the device's 'program_unit' (see <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>). </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>If asynchronous activity is launched, an invocation returns ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with the number of successfully transferred bytes passed in as the 'status' parameter. In the case of synchronous execution, control returns after completion with a positive transfer-count. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>Write the contents of a given memory buffer into a range of storage memory. In the case of flash memory, the destination range in storage memory typically has its contents in an erased state from a preceding erase operation. The source memory buffer is owned by the caller and should remain accessible for the lifetime of this command.</p>
<dl class="section note"><dt>Note</dt><dd>It is best for the middleware to write in units of 'optimal_program_unit' (<a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>) of the device.</dd>
<dd>
This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set. </dd></dl>
</div>
</div>
<a class="anchor" id="gaceef4851d9181cce65c8b2d05f4429bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_Erase </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_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>Erase Storage range. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>This is the start-address of the range to be erased. It must start at an 'erase_unit' boundary of the underlying block. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size (in bytes) of the range to be erased. 'addr + size' must be aligned with the 'erase_unit' of the underlying block. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the range to be erased doesn't align with the erase_units of the respective start and end blocks, ARM_DRIVER_ERROR_PARAMETER is returned. If any part of the range is protected, ARM_STORAGE_ERROR_PROTECTED is returned. If any part of the range is not erasable, ARM_STORAGE_ERROR_NOT_ERASABLE is returned. All such sanity-check failures result in the error code being returned synchronously and the storage bytes within the range remain unaffected. Otherwise the function executes in the following ways: If asynchronous activity is launched, an invocation returns ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with the number of successfully erased bytes passed in as the 'status' parameter. In the case of synchronous execution, control returns after completion with a positive erase-count. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>This function erases a range of storage specified by [addr, addr + size). Both 'addr' and 'addr + size' should align with the 'erase_unit'(s) of the respective owning storage block(s) (see <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> and <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES">ARM_STORAGE_BLOCK_ATTRIBUTES</a>). The range to be erased will have its contents returned to the un-programmed state– i.e. to <a class="el" href="group__storage__interface__gr.html#a902510dbedab116ab6a260a83fbd0f27">ARM_STORAGE_INFO::erased_value</a>, which is usually 1 to indicate the pattern of all ones: 0xFF.</p>
<dl class="section note"><dt>Note</dt><dd>This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set.</dd>
<dd>
Erase() may return a smaller (positive) value than the size of the requested range. The returned value indicates the actual number of bytes erased. It is the caller's responsibility to follow up with an appropriate request to complete the operation.</dd>
<dd>
in the case of a failed erase (except when ARM_DRIVER_ERROR_PARAMETER, ARM_STORAGE_ERROR_PROTECTED, or ARM_STORAGE_ERROR_NOT_ERASABLE is returned synchronously), the requested range should be assumed to be in an unknown state. The previous contents may not be retained. </dd></dl>
</div>
</div>
<a class="anchor" id="ga04e77387a3c628d6fc661e82f7daddaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_EraseAll </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erase complete Storage. </p>
<dl class="section return"><dt>Returns</dt><dd>If any part of the storage range is protected, ARM_STORAGE_ERROR_PROTECTED is returned. If any part of the storage range is not erasable, ARM_STORAGE_ERROR_NOT_ERASABLE is returned. All such sanity-check failures result in the error code being returned synchronously and the storage bytes within the range remain unaffected. Otherwise the function executes in the following ways: If asynchronous activity is launched, an invocation returns ARM_DRIVER_OK, and the caller can expect to receive a callback in the future with ARM_DRIVER_OK passed in as the 'status' parameter. In the case of synchronous execution, control returns after completion with a value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.</dd></dl>
<p>This optional function erases the complete device. If the device does not support global erase then the function returns the error value <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a>. The data field <em>'erase_all'</em> = <span class="XML-Token">1</span> of the structure <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES">ARM_STORAGE_CAPABILITIES</a> encodes that <a class="el" href="group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa">ARM_Storage_EraseAll</a> is supported.</p>
<dl class="section note"><dt>Note</dt><dd>This API may execute asynchronously 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. Asynchronous execution is optional even if 'asynchronous_ops' is set. </dd></dl>
</div>
</div>
<a class="anchor" id="ga29e7bfe78f41abb16973bdb4e0188a20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a> ARM_Storage_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 Storage status. </p>
<dl class="section return"><dt>Returns</dt><dd>Storage status <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a></dd></dl>
<p>Get the status of the current (or previous) command executed by the storage controller; stored in the structure <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__STATUS">ARM_STORAGE_STATUS</a>.</p>
<dl class="section note"><dt>Note</dt><dd>This API returns synchronously–it does not result in an invocation of a completion callback. </dd></dl>
</div>
</div>
<a class="anchor" id="gad557e8e6e33cd4528d398ecf4dddc747"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_GetInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> * </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Storage information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>A caller-supplied buffer capable of being filled in with an <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ARM_DRIVER_OK if a <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a> structure containing top level metadata about the storage controller is filled into the supplied buffer, else an appropriate error value.</dd></dl>
<p>Get information about the Storage device; stored in the structure <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>.</p>
<dl class="section note"><dt>Note</dt><dd>It is the caller's responsibility to ensure that the buffer passed in is able to be initialized with a <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__INFO">ARM_STORAGE_INFO</a>.</dd>
<dd>
This API returns synchronously–it does not result in an invocation of a completion callback. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5a1934750a51c74b8b0fea52588a3b9a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_Storage_ResolveAddress </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve an address relative to the storage controller into a memory address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>The address for which we want a resolution to the processor's physical address space. It is an offset from the start of the storage map maintained by the owning storage controller. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The resolved address in the processor's address space, else ARM_STORAGE_INVALID_ADDRESS.</dd></dl>
<p>Only applicable to devices with memory-mapped storage.</p>
<dl class="section note"><dt>Note</dt><dd>This API returns synchronously. The invocation should return quickly, and result in a resolved address. </dd></dl>
</div>
</div>
<a class="anchor" id="gad318f8cb38626cbeea1fcf36a0977c44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_GetNextBlock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> * </td>
<td class="paramname"><em>prev_block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> * </td>
<td class="paramname"><em>next_block</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance to the successor of the current block (iterator). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">prev_block</td><td>An existing block (iterator) within the same storage controller. The memory buffer holding this block is owned by the caller. This pointer may be NULL; if so, the invocation fills in the first block into the out parameter: 'next_block'. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">next_block</td><td>A caller-owned buffer large enough to be filled in with the following <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK" title="A storage block is a range of memory with uniform attributes. ">ARM_STORAGE_BLOCK</a>. It is legal to provide the same buffer using 'next_block' as was passed in with 'prev_block'. It is also legal to pass a NULL into this parameter if the caller isn't interested in populating a buffer with the next block, i.e. if the caller only wishes to establish the presence of a next block. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ARM_DRIVER_OK if a valid next block is found (or first block, if prev_block is passed as NULL); upon successful operation, the contents of the next (or first) block are filled into the buffer pointed to by the parameter 'next_block' and <a class="el" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK(next_block)</a> is guaranteed to be true. Upon reaching the end of the sequence of blocks (iterators), or in case the driver is unable to fetch information about the next (or first) block, an error (negative) value is returned and an invalid StorageBlock is populated into the supplied buffer. If prev_block is NULL, the first block is returned.</dd></dl>
<p>This helper function fetches (an iterator to) the next block (or the first block if 'prev_block' is passed in as NULL). In the failure case, a terminating, invalid block iterator is filled into the out parameter: 'next_block'. In combination with <a class="el" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>, it can be used to iterate over the sequence of blocks within the storage map:</p>
<div class="fragment"><div class="line"><a class="code" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> block;</div>
<div class="line"><span class="keywordflow">for</span> (drv->GetNextBlock(NULL, &block); <a class="code" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK</a>(&block); drv->GetNextBlock(&block, &block)) {</div>
<div class="line"> <span class="comment">// make use of block</span></div>
<div class="line">}</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>This API returns synchronously–it does not result in an invocation of a completion callback. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5fe9d27ce8afe65124dec62566114073"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_Storage_GetBlock </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK">ARM_STORAGE_BLOCK</a> * </td>
<td class="paramname"><em>block</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the storage block (iterator) encompassing a given storage address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>Storage address in bytes. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">block</td><td>A caller-owned buffer large enough to be filled in with the <a class="el" href="group__storage__interface__gr.html#structARM__STORAGE__BLOCK" title="A storage block is a range of memory with uniform attributes. ">ARM_STORAGE_BLOCK</a> encapsulating the given address. This value can also be passed in as NULL if the caller isn't interested in populating a buffer with the block, if the caller only wishes to establish the presence of a containing storage block. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ARM_DRIVER_OK if a containing storage-block is found. In this case, if block is non-NULL, the buffer pointed to by it is populated with the contents of the storage block, i.e. if block is valid and a block is found, <a class="el" href="Driver__Storage_8h.html#a955b1ca2ea24cfd3a8923731b581cfd4">ARM_STORAGE_VALID_BLOCK(block)</a> would return true following this call. If there is no storage block containing the given offset, or in case the driver is unable to resolve an address to a storage-block, an error (negative) value is returned and an invalid StorageBlock is populated into the supplied buffer.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API returns synchronously–it does not result in an invocation of a completion callback. </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__storage__interface__gr.html | HTML | apache-2.0 | 109,644 |
var group__storage__interface__gr =
[
[ "Use of Storage APIs", "group__StorageDriverFunctions.html", null ],
[ "Sample Use of Storage Driver", "group__SampleUseOfStorageDriver.html", null ],
[ "ARM_STORAGE_BLOCK_ATTRIBUTES", "group__storage__interface__gr.html#structARM__STORAGE__BLOCK__ATTRIBUTES", [
[ "erasable", "group__storage__interface__gr.html#ab350afb2119388ebd3f096bd24f019ef", null ],
[ "programmable", "group__storage__interface__gr.html#a7f4aebaeeb818b0e2a0592f96559fa1b", null ],
[ "executable", "group__storage__interface__gr.html#a910da8e2e909faab1d32cca7f8b05656", null ],
[ "protectable", "group__storage__interface__gr.html#a7c8899f46a471e1b7698a75a759e67c1", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ],
[ "erase_unit", "group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a", null ],
[ "protection_unit", "group__storage__interface__gr.html#ae319384dfb356cbb0b08ccbf8c04a590", null ]
] ],
[ "ARM_STORAGE_BLOCK", "group__storage__interface__gr.html#structARM__STORAGE__BLOCK", [
[ "addr", "group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df", null ],
[ "size", "group__storage__interface__gr.html#af931a8871310b4dad23f0f0b0f623560", null ],
[ "attributes", "group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830", null ]
] ],
[ "ARM_STORAGE_INFO", "group__storage__interface__gr.html#structARM__STORAGE__INFO", [
[ "total_storage", "group__storage__interface__gr.html#a4b14ce1ca2ceea5ce49e81348c5b38f6", null ],
[ "program_unit", "group__storage__interface__gr.html#a483c41066757e2865bf3a27a2a627a54", null ],
[ "optimal_program_unit", "group__storage__interface__gr.html#a407e16dc7e4da08cea7785efeebd9b6d", null ],
[ "program_cycles", "group__storage__interface__gr.html#ac501623ba5adb4904cdd6c286e7388eb", null ],
[ "erased_value", "group__storage__interface__gr.html#a902510dbedab116ab6a260a83fbd0f27", null ],
[ "memory_mapped", "group__storage__interface__gr.html#a616b41da466430ed481d791e63784f0c", null ],
[ "programmability", "group__storage__interface__gr.html#aac0da06bf0775bd9b877aafbc4bcad77", null ],
[ "retention_level", "group__storage__interface__gr.html#a16d1a2aead689ffa28fd89cb6779e5a7", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ],
[ "security", "group__storage__interface__gr.html#aee43dd20848f45fe05efc10a8198817a", null ]
] ],
[ "ARM_DRIVER_STORAGE", "group__storage__interface__gr.html#structARM__DRIVER__STORAGE", [
[ "GetVersion", "group__storage__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55", null ],
[ "Initialize", "group__storage__interface__gr.html#a4a126668a113ce450b0d831c74199b23", null ],
[ "Uninitialize", "group__storage__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__storage__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "ReadData", "group__storage__interface__gr.html#a79b015933daca07a88f98a8f20e1144d", null ],
[ "ProgramData", "group__storage__interface__gr.html#aedda6cc77ea7c4ef2356c683f9013d8b", null ],
[ "Erase", "group__storage__interface__gr.html#abb5018d1afb3ea4632e6e6006314f37f", null ],
[ "EraseAll", "group__storage__interface__gr.html#ad4dc5af362c0f2043138618aea9c6a73", null ],
[ "GetStatus", "group__storage__interface__gr.html#a820e9b9de75ebe93e64b067468b369af", null ],
[ "GetInfo", "group__storage__interface__gr.html#aec80a5d1ccf1cd996f6e863ac8868d65", null ],
[ "ResolveAddress", "group__storage__interface__gr.html#a6e1b3f9abb40bb5c70c6141587ee6e6a", null ],
[ "GetNextBlock", "group__storage__interface__gr.html#adda93f4d74519247517f036c4551dd13", null ],
[ "GetBlock", "group__storage__interface__gr.html#af43edebfb5463d22ffeda6de20e1d1bd", null ]
] ],
[ "ARM_STORAGE_CAPABILITIES", "group__storage__interface__gr.html#structARM__STORAGE__CAPABILITIES", [
[ "asynchronous_ops", "group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc", null ],
[ "erase_all", "group__storage__interface__gr.html#a63882f6a571f20aad1b5b3542cdaafa1", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_STORAGE_STATUS", "group__storage__interface__gr.html#structARM__STORAGE__STATUS", [
[ "busy", "group__storage__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "error", "group__storage__interface__gr.html#aa8d183302fdfa4a6892f1d80300cdb32", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_Storage_Callback_t", "group__storage__interface__gr.html#ga4b290224fea782e6d2ad06f541b28a98", null ],
[ "ARM_STORAGE_OPERATION", "group__storage__interface__gr.html#ga3a9277f89946d61c41b22da72e3eef7c", [
[ "ARM_STORAGE_OPERATION_GET_VERSION", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cac82e2ca0f9b7ec94e24ae56c45f12f8c", null ],
[ "ARM_STORAGE_OPERATION_GET_CAPABILITIES", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca314621ae4384fef7094d8724d59b65c4", null ],
[ "ARM_STORAGE_OPERATION_INITIALIZE", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7caca3985b874bf393dc2e448b339668971", null ],
[ "ARM_STORAGE_OPERATION_UNINITIALIZE", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cab9488e567ad58b16c5df2637df3902e9", null ],
[ "ARM_STORAGE_OPERATION_POWER_CONTROL", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca213a74ac5a692a80f17fd6d8e6565e05", null ],
[ "ARM_STORAGE_OPERATION_READ_DATA", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca177812f3cb27c413473d94ebe9480454", null ],
[ "ARM_STORAGE_OPERATION_PROGRAM_DATA", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca586b4774a7a092d1932d3415cc42abb0", null ],
[ "ARM_STORAGE_OPERATION_ERASE", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cab52a1d10b8087452fd97af8cdb9a6f75", null ],
[ "ARM_STORAGE_OPERATION_ERASE_ALL", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca60a0511bd5e32db2a22d3ab2023a601e", null ],
[ "ARM_STORAGE_OPERATION_GET_STATUS", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca7c595cd3c439753efe0a0b17efd7bb7f", null ],
[ "ARM_STORAGE_OPERATION_GET_INFO", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca0fe0ef7c0a9e69d053a0419282248f40", null ],
[ "ARM_STORAGE_OPERATION_RESOLVE_ADDRESS", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca3292512d0222e4119d0cdf77de1508df", null ],
[ "ARM_STORAGE_OPERATION_GET_NEXT_BLOCK", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7ca9bfab6ee9caa3ace32338d4ef2d856f5", null ],
[ "ARM_STORAGE_OPERATION_GET_BLOCK", "Driver__Storage_8h.html#ga3a9277f89946d61c41b22da72e3eef7cac75096931c3d29af1029f25fc44e7523", null ]
] ],
[ "ARM_Storage_GetVersion", "group__storage__interface__gr.html#gaf28193431b1a2ee64b22bfb36aed27e3", null ],
[ "ARM_Storage_GetCapabilities", "group__storage__interface__gr.html#ga8378b3901dfe76d8f31728a50e10dae2", null ],
[ "ARM_Storage_Initialize", "group__storage__interface__gr.html#gacc5dc090a35ac16caff8957030eaa174", null ],
[ "ARM_Storage_Uninitialize", "group__storage__interface__gr.html#ga1d14b15ddcda2836c6e3c1d0b5e60dca", null ],
[ "ARM_Storage_PowerControl", "group__storage__interface__gr.html#ga979a2484bf05b2986de95a5d98307d54", null ],
[ "ARM_Storage_ReadData", "group__storage__interface__gr.html#gabaa24553c165add98020434c980b3ab4", null ],
[ "ARM_Storage_ProgramData", "group__storage__interface__gr.html#gabd20d561854c06918b0515b6c1bba230", null ],
[ "ARM_Storage_Erase", "group__storage__interface__gr.html#gaceef4851d9181cce65c8b2d05f4429bc", null ],
[ "ARM_Storage_EraseAll", "group__storage__interface__gr.html#ga04e77387a3c628d6fc661e82f7daddaa", null ],
[ "ARM_Storage_GetStatus", "group__storage__interface__gr.html#ga29e7bfe78f41abb16973bdb4e0188a20", null ],
[ "ARM_Storage_GetInfo", "group__storage__interface__gr.html#gad557e8e6e33cd4528d398ecf4dddc747", null ],
[ "ARM_Storage_ResolveAddress", "group__storage__interface__gr.html#ga5a1934750a51c74b8b0fea52588a3b9a", null ],
[ "ARM_Storage_GetNextBlock", "group__storage__interface__gr.html#gad318f8cb38626cbeea1fcf36a0977c44", null ],
[ "ARM_Storage_GetBlock", "group__storage__interface__gr.html#ga5fe9d27ce8afe65124dec62566114073", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr.js | JavaScript | apache-2.0 | 8,819 |
var group__storage__interface__gr_structARM__DRIVER__STORAGE =
[
[ "GetVersion", "group__storage__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__storage__interface__gr.html#abbfb3aa4b6adb4407de79221bf12cc55", null ],
[ "Initialize", "group__storage__interface__gr.html#a4a126668a113ce450b0d831c74199b23", null ],
[ "Uninitialize", "group__storage__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__storage__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "ReadData", "group__storage__interface__gr.html#a79b015933daca07a88f98a8f20e1144d", null ],
[ "ProgramData", "group__storage__interface__gr.html#aedda6cc77ea7c4ef2356c683f9013d8b", null ],
[ "Erase", "group__storage__interface__gr.html#abb5018d1afb3ea4632e6e6006314f37f", null ],
[ "EraseAll", "group__storage__interface__gr.html#ad4dc5af362c0f2043138618aea9c6a73", null ],
[ "GetStatus", "group__storage__interface__gr.html#a820e9b9de75ebe93e64b067468b369af", null ],
[ "GetInfo", "group__storage__interface__gr.html#aec80a5d1ccf1cd996f6e863ac8868d65", null ],
[ "ResolveAddress", "group__storage__interface__gr.html#a6e1b3f9abb40bb5c70c6141587ee6e6a", null ],
[ "GetNextBlock", "group__storage__interface__gr.html#adda93f4d74519247517f036c4551dd13", null ],
[ "GetBlock", "group__storage__interface__gr.html#af43edebfb5463d22ffeda6de20e1d1bd", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr_structARM__DRIVER__STORAGE.js | JavaScript | apache-2.0 | 1,467 |
var group__storage__interface__gr_structARM__STORAGE__BLOCK =
[
[ "addr", "group__storage__interface__gr.html#a0e89cf6b9f6cd3125470b1bed2b823df", null ],
[ "size", "group__storage__interface__gr.html#af931a8871310b4dad23f0f0b0f623560", null ],
[ "attributes", "group__storage__interface__gr.html#ade62c905888479b4f6d078d45cec5830", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr_structARM__STORAGE__BLOCK.js | JavaScript | apache-2.0 | 353 |
var group__storage__interface__gr_structARM__STORAGE__BLOCK__ATTRIBUTES =
[
[ "erasable", "group__storage__interface__gr.html#ab350afb2119388ebd3f096bd24f019ef", null ],
[ "programmable", "group__storage__interface__gr.html#a7f4aebaeeb818b0e2a0592f96559fa1b", null ],
[ "executable", "group__storage__interface__gr.html#a910da8e2e909faab1d32cca7f8b05656", null ],
[ "protectable", "group__storage__interface__gr.html#a7c8899f46a471e1b7698a75a759e67c1", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ],
[ "erase_unit", "group__storage__interface__gr.html#aac21d3f798c9fcad415b99cf4157935a", null ],
[ "protection_unit", "group__storage__interface__gr.html#ae319384dfb356cbb0b08ccbf8c04a590", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr_structARM__STORAGE__BLOCK__ATTRIBUTES.js | JavaScript | apache-2.0 | 781 |
var group__storage__interface__gr_structARM__STORAGE__CAPABILITIES =
[
[ "asynchronous_ops", "group__storage__interface__gr.html#a15ade4ca762bc6ce72d435a16febb4cc", null ],
[ "erase_all", "group__storage__interface__gr.html#a63882f6a571f20aad1b5b3542cdaafa1", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr_structARM__STORAGE__CAPABILITIES.js | JavaScript | apache-2.0 | 375 |
var group__storage__interface__gr_structARM__STORAGE__INFO =
[
[ "total_storage", "group__storage__interface__gr.html#a4b14ce1ca2ceea5ce49e81348c5b38f6", null ],
[ "program_unit", "group__storage__interface__gr.html#a483c41066757e2865bf3a27a2a627a54", null ],
[ "optimal_program_unit", "group__storage__interface__gr.html#a407e16dc7e4da08cea7785efeebd9b6d", null ],
[ "program_cycles", "group__storage__interface__gr.html#ac501623ba5adb4904cdd6c286e7388eb", null ],
[ "erased_value", "group__storage__interface__gr.html#a902510dbedab116ab6a260a83fbd0f27", null ],
[ "memory_mapped", "group__storage__interface__gr.html#a616b41da466430ed481d791e63784f0c", null ],
[ "programmability", "group__storage__interface__gr.html#aac0da06bf0775bd9b877aafbc4bcad77", null ],
[ "retention_level", "group__storage__interface__gr.html#a16d1a2aead689ffa28fd89cb6779e5a7", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ],
[ "security", "group__storage__interface__gr.html#aee43dd20848f45fe05efc10a8198817a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr_structARM__STORAGE__INFO.js | JavaScript | apache-2.0 | 1,094 |
var group__storage__interface__gr_structARM__STORAGE__STATUS =
[
[ "busy", "group__storage__interface__gr.html#a50c88f3c1d787773e2ac1b59533f034a", null ],
[ "error", "group__storage__interface__gr.html#aa8d183302fdfa4a6892f1d80300cdb32", null ],
[ "reserved", "group__storage__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__storage__interface__gr_structARM__STORAGE__STATUS.js | JavaScript | apache-2.0 | 353 |
<!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 Clock Phase</title>
<title>CMSIS-Driver: USART Clock Phase</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__clock__phase.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 Clock Phase<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the clock phase for the synchronous mode.
<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:ga5eb27c2294b7d14a20d0c7e2ef0a47b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__clock__phase.html#ga5eb27c2294b7d14a20d0c7e2ef0a47b4">ARM_USART_CPHA0</a>   (0UL << ARM_USART_CPHA_Pos)</td></tr>
<tr class="memdesc:ga5eb27c2294b7d14a20d0c7e2ef0a47b4"><td class="mdescLeft"> </td><td class="mdescRight">CPHA = 0 (default) <a href="#ga5eb27c2294b7d14a20d0c7e2ef0a47b4">More...</a><br/></td></tr>
<tr class="separator:ga5eb27c2294b7d14a20d0c7e2ef0a47b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b9f16371870476739a198c52dba6862"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__clock__phase.html#ga4b9f16371870476739a198c52dba6862">ARM_USART_CPHA1</a>   (1UL << ARM_USART_CPHA_Pos)</td></tr>
<tr class="memdesc:ga4b9f16371870476739a198c52dba6862"><td class="mdescLeft"> </td><td class="mdescRight">CPHA = 1. <a href="#ga4b9f16371870476739a198c52dba6862">More...</a><br/></td></tr>
<tr class="separator:ga4b9f16371870476739a198c52dba6862"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the clock phase for the synchronous mode. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga5eb27c2294b7d14a20d0c7e2ef0a47b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CPHA0   (0UL << ARM_USART_CPHA_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CPHA = 0 (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803" title="Start receiving data from USART receiver. ">ARM_USART_Receive</a>; <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08" title="Start sending data to USART transmitter. ">ARM_USART_Send</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a" title="Start sending/receiving data to/from USART transmitter/receiver. ">ARM_USART_Transfer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4b9f16371870476739a198c52dba6862"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CPHA1   (1UL << ARM_USART_CPHA_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CPHA = 1. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803" title="Start receiving data from USART receiver. ">ARM_USART_Receive</a>; <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08" title="Start sending data to USART transmitter. ">ARM_USART_Send</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a" title="Start sending/receiving data to/from USART transmitter/receiver. ">ARM_USART_Transfer</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__usart__clock__phase.html | HTML | apache-2.0 | 10,233 |
var group__usart__clock__phase =
[
[ "ARM_USART_CPHA0", "group__usart__clock__phase.html#ga5eb27c2294b7d14a20d0c7e2ef0a47b4", null ],
[ "ARM_USART_CPHA1", "group__usart__clock__phase.html#ga4b9f16371870476739a198c52dba6862", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__clock__phase.js | JavaScript | apache-2.0 | 242 |
<!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 Clock Polarity</title>
<title>CMSIS-Driver: USART Clock Polarity</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__clock__polarity.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 Clock Polarity<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the clock polarity for the synchronous mode.
<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:ga472d459abb99f1caaff94fa0cdd2ad27"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__clock__polarity.html#ga472d459abb99f1caaff94fa0cdd2ad27">ARM_USART_CPOL0</a>   (0UL << ARM_USART_CPOL_Pos)</td></tr>
<tr class="memdesc:ga472d459abb99f1caaff94fa0cdd2ad27"><td class="mdescLeft"> </td><td class="mdescRight">CPOL = 0 (default) <a href="#ga472d459abb99f1caaff94fa0cdd2ad27">More...</a><br/></td></tr>
<tr class="separator:ga472d459abb99f1caaff94fa0cdd2ad27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9e5541d8937a9d92e42aeb273138592a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__clock__polarity.html#ga9e5541d8937a9d92e42aeb273138592a">ARM_USART_CPOL1</a>   (1UL << ARM_USART_CPOL_Pos)</td></tr>
<tr class="memdesc:ga9e5541d8937a9d92e42aeb273138592a"><td class="mdescLeft"> </td><td class="mdescRight">CPOL = 1. <a href="#ga9e5541d8937a9d92e42aeb273138592a">More...</a><br/></td></tr>
<tr class="separator:ga9e5541d8937a9d92e42aeb273138592a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the clock polarity for the synchronous mode. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga472d459abb99f1caaff94fa0cdd2ad27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CPOL0   (0UL << ARM_USART_CPOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CPOL = 0 (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803" title="Start receiving data from USART receiver. ">ARM_USART_Receive</a>; <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08" title="Start sending data to USART transmitter. ">ARM_USART_Send</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a" title="Start sending/receiving data to/from USART transmitter/receiver. ">ARM_USART_Transfer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9e5541d8937a9d92e42aeb273138592a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CPOL1   (1UL << ARM_USART_CPOL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CPOL = 1. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803" title="Start receiving data from USART receiver. ">ARM_USART_Receive</a>; <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08" title="Start sending data to USART transmitter. ">ARM_USART_Send</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a" title="Start sending/receiving data to/from USART transmitter/receiver. ">ARM_USART_Transfer</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__usart__clock__polarity.html | HTML | apache-2.0 | 10,257 |
var group__usart__clock__polarity =
[
[ "ARM_USART_CPOL0", "group__usart__clock__polarity.html#ga472d459abb99f1caaff94fa0cdd2ad27", null ],
[ "ARM_USART_CPOL1", "group__usart__clock__polarity.html#ga9e5541d8937a9d92e42aeb273138592a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__clock__polarity.js | JavaScript | apache-2.0 | 251 |
<!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 Data Bits</title>
<title>CMSIS-Driver: USART Data Bits</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__data__bits.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 Data Bits<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the number of data bits.
<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:ga981ff25b4ff806f743d1af4575b87339"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#ga981ff25b4ff806f743d1af4575b87339">ARM_USART_DATA_BITS_5</a>   (5UL << ARM_USART_DATA_BITS_Pos)</td></tr>
<tr class="memdesc:ga981ff25b4ff806f743d1af4575b87339"><td class="mdescLeft"> </td><td class="mdescRight">5 Data bits <a href="#ga981ff25b4ff806f743d1af4575b87339">More...</a><br/></td></tr>
<tr class="separator:ga981ff25b4ff806f743d1af4575b87339"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92ba3d6cea5cd5c0b661667539a9e43c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#ga92ba3d6cea5cd5c0b661667539a9e43c">ARM_USART_DATA_BITS_6</a>   (6UL << ARM_USART_DATA_BITS_Pos)</td></tr>
<tr class="memdesc:ga92ba3d6cea5cd5c0b661667539a9e43c"><td class="mdescLeft"> </td><td class="mdescRight">6 Data bit <a href="#ga92ba3d6cea5cd5c0b661667539a9e43c">More...</a><br/></td></tr>
<tr class="separator:ga92ba3d6cea5cd5c0b661667539a9e43c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad86a2d971ce521c6f6eda28d4f8786a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#gad86a2d971ce521c6f6eda28d4f8786a4">ARM_USART_DATA_BITS_7</a>   (7UL << ARM_USART_DATA_BITS_Pos)</td></tr>
<tr class="memdesc:gad86a2d971ce521c6f6eda28d4f8786a4"><td class="mdescLeft"> </td><td class="mdescRight">7 Data bits <a href="#gad86a2d971ce521c6f6eda28d4f8786a4">More...</a><br/></td></tr>
<tr class="separator:gad86a2d971ce521c6f6eda28d4f8786a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc5e8d17b5c69cd7f9135b849c2a4586"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a>   (0UL << ARM_USART_DATA_BITS_Pos)</td></tr>
<tr class="memdesc:gadc5e8d17b5c69cd7f9135b849c2a4586"><td class="mdescLeft"> </td><td class="mdescRight">8 Data bits (default) <a href="#gadc5e8d17b5c69cd7f9135b849c2a4586">More...</a><br/></td></tr>
<tr class="separator:gadc5e8d17b5c69cd7f9135b849c2a4586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae238a08198dc7ac6178ae0a2a95a2764"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__data__bits.html#gae238a08198dc7ac6178ae0a2a95a2764">ARM_USART_DATA_BITS_9</a>   (1UL << ARM_USART_DATA_BITS_Pos)</td></tr>
<tr class="memdesc:gae238a08198dc7ac6178ae0a2a95a2764"><td class="mdescLeft"> </td><td class="mdescRight">9 Data bits <a href="#gae238a08198dc7ac6178ae0a2a95a2764">More...</a><br/></td></tr>
<tr class="separator:gae238a08198dc7ac6178ae0a2a95a2764"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the number of data bits. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga981ff25b4ff806f743d1af4575b87339"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_DATA_BITS_5   (5UL << ARM_USART_DATA_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>5 Data bits </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga92ba3d6cea5cd5c0b661667539a9e43c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_DATA_BITS_6   (6UL << ARM_USART_DATA_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>6 Data bit </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad86a2d971ce521c6f6eda28d4f8786a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_DATA_BITS_7   (7UL << ARM_USART_DATA_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>7 Data bits </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gadc5e8d17b5c69cd7f9135b849c2a4586"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_DATA_BITS_8   (0UL << ARM_USART_DATA_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>8 Data bits (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae238a08198dc7ac6178ae0a2a95a2764"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_DATA_BITS_9   (1UL << ARM_USART_DATA_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>9 Data bits </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_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__usart__data__bits.html | HTML | apache-2.0 | 12,869 |
var group__usart__data__bits =
[
[ "ARM_USART_DATA_BITS_5", "group__usart__data__bits.html#ga981ff25b4ff806f743d1af4575b87339", null ],
[ "ARM_USART_DATA_BITS_6", "group__usart__data__bits.html#ga92ba3d6cea5cd5c0b661667539a9e43c", null ],
[ "ARM_USART_DATA_BITS_7", "group__usart__data__bits.html#gad86a2d971ce521c6f6eda28d4f8786a4", null ],
[ "ARM_USART_DATA_BITS_8", "group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586", null ],
[ "ARM_USART_DATA_BITS_9", "group__usart__data__bits.html#gae238a08198dc7ac6178ae0a2a95a2764", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__data__bits.js | JavaScript | apache-2.0 | 569 |
<!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__usart__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__usart__interface__gr.html">USART Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Negative values indicate errors (USART has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</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:gaa98f35611ec5bd7034f21cb47199322b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#gaa98f35611ec5bd7034f21cb47199322b">ARM_USART_ERROR_MODE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
<tr class="memdesc:gaa98f35611ec5bd7034f21cb47199322b"><td class="mdescLeft"> </td><td class="mdescRight">Specified Mode not supported. <a href="#gaa98f35611ec5bd7034f21cb47199322b">More...</a><br/></td></tr>
<tr class="separator:gaa98f35611ec5bd7034f21cb47199322b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab57c4e8d4cb3a4b73751a002f5ec4586"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#gab57c4e8d4cb3a4b73751a002f5ec4586">ARM_USART_ERROR_BAUDRATE</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td></tr>
<tr class="memdesc:gab57c4e8d4cb3a4b73751a002f5ec4586"><td class="mdescLeft"> </td><td class="mdescRight">Specified baudrate not supported. <a href="#gab57c4e8d4cb3a4b73751a002f5ec4586">More...</a><br/></td></tr>
<tr class="separator:gab57c4e8d4cb3a4b73751a002f5ec4586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaade95ddec6882e96c086dfe8e0ba9a4c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#gaade95ddec6882e96c086dfe8e0ba9a4c">ARM_USART_ERROR_DATA_BITS</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td></tr>
<tr class="memdesc:gaade95ddec6882e96c086dfe8e0ba9a4c"><td class="mdescLeft"> </td><td class="mdescRight">Specified number of Data bits not supported. <a href="#gaade95ddec6882e96c086dfe8e0ba9a4c">More...</a><br/></td></tr>
<tr class="separator:gaade95ddec6882e96c086dfe8e0ba9a4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaefabd886c586a45f4f7346c1f04392d0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#gaefabd886c586a45f4f7346c1f04392d0">ARM_USART_ERROR_PARITY</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td></tr>
<tr class="memdesc:gaefabd886c586a45f4f7346c1f04392d0"><td class="mdescLeft"> </td><td class="mdescRight">Specified Parity not supported. <a href="#gaefabd886c586a45f4f7346c1f04392d0">More...</a><br/></td></tr>
<tr class="separator:gaefabd886c586a45f4f7346c1f04392d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d699654fbbed3ca41c5ea10aac8f859"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#ga1d699654fbbed3ca41c5ea10aac8f859">ARM_USART_ERROR_STOP_BITS</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td></tr>
<tr class="memdesc:ga1d699654fbbed3ca41c5ea10aac8f859"><td class="mdescLeft"> </td><td class="mdescRight">Specified number of Stop bits not supported. <a href="#ga1d699654fbbed3ca41c5ea10aac8f859">More...</a><br/></td></tr>
<tr class="separator:ga1d699654fbbed3ca41c5ea10aac8f859"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf8fea8d43ff72c76434d8b5e9eebd890"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#gaf8fea8d43ff72c76434d8b5e9eebd890">ARM_USART_ERROR_FLOW_CONTROL</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 6)</td></tr>
<tr class="memdesc:gaf8fea8d43ff72c76434d8b5e9eebd890"><td class="mdescLeft"> </td><td class="mdescRight">Specified Flow Control not supported. <a href="#gaf8fea8d43ff72c76434d8b5e9eebd890">More...</a><br/></td></tr>
<tr class="separator:gaf8fea8d43ff72c76434d8b5e9eebd890"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2a1cd0a1e1bce9b545b0d7854a6fd6d6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#ga2a1cd0a1e1bce9b545b0d7854a6fd6d6">ARM_USART_ERROR_CPOL</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 7)</td></tr>
<tr class="memdesc:ga2a1cd0a1e1bce9b545b0d7854a6fd6d6"><td class="mdescLeft"> </td><td class="mdescRight">Specified Clock Polarity not supported. <a href="#ga2a1cd0a1e1bce9b545b0d7854a6fd6d6">More...</a><br/></td></tr>
<tr class="separator:ga2a1cd0a1e1bce9b545b0d7854a6fd6d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade1af23c4ed5409dacd99ab76dc2ff8b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html#gade1af23c4ed5409dacd99ab76dc2ff8b">ARM_USART_ERROR_CPHA</a>   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 8)</td></tr>
<tr class="memdesc:gade1af23c4ed5409dacd99ab76dc2ff8b"><td class="mdescLeft"> </td><td class="mdescRight">Specified Clock Phase not supported. <a href="#gade1af23c4ed5409dacd99ab76dc2ff8b">More...</a><br/></td></tr>
<tr class="separator:gade1af23c4ed5409dacd99ab76dc2ff8b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Negative values indicate errors (USART has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). </p>
<p>The USART driver has additional status error codes that are listed below. Note that the USART driver also returns the common <a class="el" href="group__execution__status.html">Status Error Codes</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaa98f35611ec5bd7034f21cb47199322b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_MODE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Mode not supported. </p>
<p>The <b>mode</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gab57c4e8d4cb3a4b73751a002f5ec4586"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_BAUDRATE   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified baudrate not supported. </p>
<p>The <b>baude rate</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gaade95ddec6882e96c086dfe8e0ba9a4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_DATA_BITS   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified number of Data bits not supported. </p>
<p>The number of <b>data bits</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gaefabd886c586a45f4f7346c1f04392d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_PARITY   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Parity not supported. </p>
<p>The <b>parity bit</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="ga1d699654fbbed3ca41c5ea10aac8f859"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_STOP_BITS   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified number of Stop bits not supported. </p>
<p>The <b>stop bit</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gaf8fea8d43ff72c76434d8b5e9eebd890"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_FLOW_CONTROL   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Flow Control not supported. </p>
<p>The <b>flow control</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="ga2a1cd0a1e1bce9b545b0d7854a6fd6d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_CPOL   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Clock Polarity not supported. </p>
<p>The <b>clock polarity</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </p>
</div>
</div>
<a class="anchor" id="gade1af23c4ed5409dacd99ab76dc2ff8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ERROR_CPHA   (<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specified Clock Phase not supported. </p>
<p>The <b>clock phase</b> requested with the function <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> is not supported by this driver. </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__execution__status.html | HTML | apache-2.0 | 18,813 |
var group__usart__execution__status =
[
[ "ARM_USART_ERROR_MODE", "group__usart__execution__status.html#gaa98f35611ec5bd7034f21cb47199322b", null ],
[ "ARM_USART_ERROR_BAUDRATE", "group__usart__execution__status.html#gab57c4e8d4cb3a4b73751a002f5ec4586", null ],
[ "ARM_USART_ERROR_DATA_BITS", "group__usart__execution__status.html#gaade95ddec6882e96c086dfe8e0ba9a4c", null ],
[ "ARM_USART_ERROR_PARITY", "group__usart__execution__status.html#gaefabd886c586a45f4f7346c1f04392d0", null ],
[ "ARM_USART_ERROR_STOP_BITS", "group__usart__execution__status.html#ga1d699654fbbed3ca41c5ea10aac8f859", null ],
[ "ARM_USART_ERROR_FLOW_CONTROL", "group__usart__execution__status.html#gaf8fea8d43ff72c76434d8b5e9eebd890", null ],
[ "ARM_USART_ERROR_CPOL", "group__usart__execution__status.html#ga2a1cd0a1e1bce9b545b0d7854a6fd6d6", null ],
[ "ARM_USART_ERROR_CPHA", "group__usart__execution__status.html#gade1af23c4ed5409dacd99ab76dc2ff8b", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__execution__status.js | JavaScript | apache-2.0 | 969 |
<!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 Flow Control</title>
<title>CMSIS-Driver: USART Flow Control</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__flow__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">USART Flow Control<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies RTS/CTS flow control.
<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:gad04aa3fe4ea4b7363aee4bdca2ed3764"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a>   (0UL << ARM_USART_FLOW_CONTROL_Pos)</td></tr>
<tr class="memdesc:gad04aa3fe4ea4b7363aee4bdca2ed3764"><td class="mdescLeft"> </td><td class="mdescRight">No Flow Control (default) <a href="#gad04aa3fe4ea4b7363aee4bdca2ed3764">More...</a><br/></td></tr>
<tr class="separator:gad04aa3fe4ea4b7363aee4bdca2ed3764"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80c8a78e8868165cfcc543105bfd9621"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#ga80c8a78e8868165cfcc543105bfd9621">ARM_USART_FLOW_CONTROL_RTS</a>   (1UL << ARM_USART_FLOW_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga80c8a78e8868165cfcc543105bfd9621"><td class="mdescLeft"> </td><td class="mdescRight">RTS Flow Control. <a href="#ga80c8a78e8868165cfcc543105bfd9621">More...</a><br/></td></tr>
<tr class="separator:ga80c8a78e8868165cfcc543105bfd9621"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7b38ebff1ce0f5c3e4479d22e66715f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#gaa7b38ebff1ce0f5c3e4479d22e66715f">ARM_USART_FLOW_CONTROL_CTS</a>   (2UL << ARM_USART_FLOW_CONTROL_Pos)</td></tr>
<tr class="memdesc:gaa7b38ebff1ce0f5c3e4479d22e66715f"><td class="mdescLeft"> </td><td class="mdescRight">CTS Flow Control. <a href="#gaa7b38ebff1ce0f5c3e4479d22e66715f">More...</a><br/></td></tr>
<tr class="separator:gaa7b38ebff1ce0f5c3e4479d22e66715f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab16151b5c376b41586faf033f4a42d02"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__flow__control.html#gab16151b5c376b41586faf033f4a42d02">ARM_USART_FLOW_CONTROL_RTS_CTS</a>   (3UL << ARM_USART_FLOW_CONTROL_Pos)</td></tr>
<tr class="memdesc:gab16151b5c376b41586faf033f4a42d02"><td class="mdescLeft"> </td><td class="mdescRight">RTS/CTS Flow Control. <a href="#gab16151b5c376b41586faf033f4a42d02">More...</a><br/></td></tr>
<tr class="separator:gab16151b5c376b41586faf033f4a42d02"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies RTS/CTS flow control. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad04aa3fe4ea4b7363aee4bdca2ed3764"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_FLOW_CONTROL_NONE   (0UL << ARM_USART_FLOW_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>No Flow Control (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga80c8a78e8868165cfcc543105bfd9621"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_FLOW_CONTROL_RTS   (1UL << ARM_USART_FLOW_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>RTS Flow Control. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa7b38ebff1ce0f5c3e4479d22e66715f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_FLOW_CONTROL_CTS   (2UL << ARM_USART_FLOW_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>CTS Flow Control. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab16151b5c376b41586faf033f4a42d02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_FLOW_CONTROL_RTS_CTS   (3UL << ARM_USART_FLOW_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>RTS/CTS Flow Control. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_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__usart__flow__control.html | HTML | apache-2.0 | 11,803 |
var group__usart__flow__control =
[
[ "ARM_USART_FLOW_CONTROL_NONE", "group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764", null ],
[ "ARM_USART_FLOW_CONTROL_RTS", "group__usart__flow__control.html#ga80c8a78e8868165cfcc543105bfd9621", null ],
[ "ARM_USART_FLOW_CONTROL_CTS", "group__usart__flow__control.html#gaa7b38ebff1ce0f5c3e4479d22e66715f", null ],
[ "ARM_USART_FLOW_CONTROL_RTS_CTS", "group__usart__flow__control.html#gab16151b5c376b41586faf033f4a42d02", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__flow__control.js | JavaScript | apache-2.0 | 502 |
<!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 Interface</title>
<title>CMSIS-Driver: USART 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__usart__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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">USART Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for Universal Synchronous Asynchronous Receiver/Transmitter (Driver_USART.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__usart__execution__status"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html">Status Error Codes</a></td></tr>
<tr class="memdesc:group__usart__execution__status"><td class="mdescLeft"> </td><td class="mdescRight">Negative values indicate errors (USART has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USART__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html">USART Events</a></td></tr>
<tr class="memdesc:group__USART__events"><td class="mdescLeft"> </td><td class="mdescRight">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>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USART__control"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__control.html">USART Control Codes</a></td></tr>
<tr class="memdesc:group__USART__control"><td class="mdescLeft"> </td><td class="mdescRight">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. <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__USART"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a></td></tr>
<tr class="memdesc:structARM__DRIVER__USART"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the USART Driver. <a href="group__usart__interface__gr.html#structARM__DRIVER__USART">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__USART"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USART__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__USART__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">USART Device Driver Capabilities. <a href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__USART__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USART__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a></td></tr>
<tr class="memdesc:structARM__USART__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">USART Status. <a href="group__usart__interface__gr.html#structARM__USART__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__USART__STATUS"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USART__MODEM__STATUS"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a></td></tr>
<tr class="memdesc:structARM__USART__MODEM__STATUS"><td class="mdescLeft"> </td><td class="mdescRight">USART Modem Status. <a href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">More...</a><br/></td></tr>
<tr class="separator:structARM__USART__MODEM__STATUS"><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:gaa578c3829eea207e9e48df6cb6f038a1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:gaa578c3829eea207e9e48df6cb6f038a1"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> : Signal USART Event. <a href="#gaa578c3829eea207e9e48df6cb6f038a1">More...</a><br/></td></tr>
<tr class="separator:gaa578c3829eea207e9e48df6cb6f038a1"><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:ga7b89d709f048b6a956aa211f63e75f6f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> { <br/>
  <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6">ARM_USART_RTS_CLEAR</a>,
<br/>
  <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434">ARM_USART_RTS_SET</a>,
<br/>
  <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c">ARM_USART_DTR_CLEAR</a>,
<br/>
  <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4">ARM_USART_DTR_SET</a>
<br/>
}</td></tr>
<tr class="memdesc:ga7b89d709f048b6a956aa211f63e75f6f"><td class="mdescLeft"> </td><td class="mdescRight">USART Modem Control. <a href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">More...</a><br/></td></tr>
<tr class="separator:ga7b89d709f048b6a956aa211f63e75f6f"><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:gabca6151cef47565832decaf484781b61"><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__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">ARM_USART_GetVersion</a> (void)</td></tr>
<tr class="memdesc:gabca6151cef47565832decaf484781b61"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#gabca6151cef47565832decaf484781b61">More...</a><br/></td></tr>
<tr class="separator:gabca6151cef47565832decaf484781b61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad2d3ace1fe7627bb72945efefaeddf0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:gad2d3ace1fe7627bb72945efefaeddf0a"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#gad2d3ace1fe7627bb72945efefaeddf0a">More...</a><br/></td></tr>
<tr class="separator:gad2d3ace1fe7627bb72945efefaeddf0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga51f06805e9a6197c553fa9513ac7b9d6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> (<a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:ga51f06805e9a6197c553fa9513ac7b9d6"><td class="mdescLeft"> </td><td class="mdescRight">Initialize USART Interface. <a href="#ga51f06805e9a6197c553fa9513ac7b9d6">More...</a><br/></td></tr>
<tr class="separator:ga51f06805e9a6197c553fa9513ac7b9d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96f31f07a6721cf75de2a7a0ab723d26"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:ga96f31f07a6721cf75de2a7a0ab723d26"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize USART Interface. <a href="#ga96f31f07a6721cf75de2a7a0ab723d26">More...</a><br/></td></tr>
<tr class="separator:ga96f31f07a6721cf75de2a7a0ab723d26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9bad012b28d544f3eeeea9c2f71a4086"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">ARM_USART_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga9bad012b28d544f3eeeea9c2f71a4086"><td class="mdescLeft"> </td><td class="mdescRight">Control USART Interface Power. <a href="#ga9bad012b28d544f3eeeea9c2f71a4086">More...</a><br/></td></tr>
<tr class="separator:ga9bad012b28d544f3eeeea9c2f71a4086"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5cf758b0b9d03dca68846962f73c0b08"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> (const void *data, uint32_t num)</td></tr>
<tr class="memdesc:ga5cf758b0b9d03dca68846962f73c0b08"><td class="mdescLeft"> </td><td class="mdescRight">Start sending data to USART transmitter. <a href="#ga5cf758b0b9d03dca68846962f73c0b08">More...</a><br/></td></tr>
<tr class="separator:ga5cf758b0b9d03dca68846962f73c0b08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae9efabdabb5aaa17bce83339f8a58803"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a> (void *data, uint32_t num)</td></tr>
<tr class="memdesc:gae9efabdabb5aaa17bce83339f8a58803"><td class="mdescLeft"> </td><td class="mdescRight">Start receiving data from USART receiver. <a href="#gae9efabdabb5aaa17bce83339f8a58803">More...</a><br/></td></tr>
<tr class="separator:gae9efabdabb5aaa17bce83339f8a58803"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga878899928d34a818edd3e97d67b65c2a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> (const void *data_out, void *data_in, uint32_t num)</td></tr>
<tr class="memdesc:ga878899928d34a818edd3e97d67b65c2a"><td class="mdescLeft"> </td><td class="mdescRight">Start sending/receiving data to/from USART transmitter/receiver. <a href="#ga878899928d34a818edd3e97d67b65c2a">More...</a><br/></td></tr>
<tr class="separator:ga878899928d34a818edd3e97d67b65c2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacb355584bcdf4ebd36f11d945800fa03"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> (void)</td></tr>
<tr class="memdesc:gacb355584bcdf4ebd36f11d945800fa03"><td class="mdescLeft"> </td><td class="mdescRight">Get transmitted data count. <a href="#gacb355584bcdf4ebd36f11d945800fa03">More...</a><br/></td></tr>
<tr class="separator:gacb355584bcdf4ebd36f11d945800fa03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1a8799aeeba1363a9e5d22bada715a29"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a> (void)</td></tr>
<tr class="memdesc:ga1a8799aeeba1363a9e5d22bada715a29"><td class="mdescLeft"> </td><td class="mdescRight">Get received data count. <a href="#ga1a8799aeeba1363a9e5d22bada715a29">More...</a><br/></td></tr>
<tr class="separator:ga1a8799aeeba1363a9e5d22bada715a29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8ffdde2123b5412de3005c456da677d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> (uint32_t control, uint32_t arg)</td></tr>
<tr class="memdesc:gad8ffdde2123b5412de3005c456da677d"><td class="mdescLeft"> </td><td class="mdescRight">Control USART Interface. <a href="#gad8ffdde2123b5412de3005c456da677d">More...</a><br/></td></tr>
<tr class="separator:gad8ffdde2123b5412de3005c456da677d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1e8fdd54294b587438b2b72f4dbde004"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> (void)</td></tr>
<tr class="memdesc:ga1e8fdd54294b587438b2b72f4dbde004"><td class="mdescLeft"> </td><td class="mdescRight">Get USART status. <a href="#ga1e8fdd54294b587438b2b72f4dbde004">More...</a><br/></td></tr>
<tr class="separator:ga1e8fdd54294b587438b2b72f4dbde004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8eb0eb1d1c24fc725584ab93214cfc7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> (<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> control)</td></tr>
<tr class="memdesc:gad8eb0eb1d1c24fc725584ab93214cfc7"><td class="mdescLeft"> </td><td class="mdescRight">Set USART Modem Control line state. <a href="#gad8eb0eb1d1c24fc725584ab93214cfc7">More...</a><br/></td></tr>
<tr class="separator:gad8eb0eb1d1c24fc725584ab93214cfc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga198af0d6a7c85b7c0b96f3d9db8c34e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> (void)</td></tr>
<tr class="memdesc:ga198af0d6a7c85b7c0b96f3d9db8c34e0"><td class="mdescLeft"> </td><td class="mdescRight">Get USART Modem Status lines state. <a href="#ga198af0d6a7c85b7c0b96f3d9db8c34e0">More...</a><br/></td></tr>
<tr class="separator:ga198af0d6a7c85b7c0b96f3d9db8c34e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad796cd023f8f6300a6caadcc39d43cbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:gad796cd023f8f6300a6caadcc39d43cbf"><td class="mdescLeft"> </td><td class="mdescRight">Signal USART Events. <a href="#gad796cd023f8f6300a6caadcc39d43cbf">More...</a><br/></td></tr>
<tr class="separator:gad796cd023f8f6300a6caadcc39d43cbf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for Universal Synchronous Asynchronous Receiver/Transmitter (Driver_USART.h) </p>
<p>The <b>Universal Synchronous Asynchronous Receiver/Transmitter</b> (USART) implements a synchronous and asynchronous serial bus for exchanging data. When only asynchronous mode is supported it is called Universal Asynchronous Receiver/Transmitter (UART). Almost all microcontrollers have a serial interface (UART/USART peripheral). A UART is a simple device to send data to a PC via a terminal emulation program (Hyperterm, TeraTerm) or to another microcontroller. A UART takes bytes of data and transmits the individual bits in a sequential mode. At the destination, a second UART reassembles the bits into complete bytes. Each UART contains a shift register for converting between serial and parallel transmission forms. Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter" target="_blank"><b>Universal asynchronous receiver/transmitter</b></a>.</p>
<p><b>USART API</b></p>
<p>The following header files define the Application Programming Interface (API) for the USART interface:</p>
<ul>
<li><b>Driver_USART.h</b> : Driver API for Universal Synchronous Asynchronous Receiver/Transmitter</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__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> : access struct for USART driver functions</li>
</ul>
<p><b>Example Code</b></p>
<p>The following example code shows the usage of the USART interface for asynchronous communication.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="Driver__USART_8h.html">Driver_USART.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include "cmsis_os.h"</span> <span class="comment">/* ARM::CMSIS:RTOS:Keil RTX */</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="keywordtype">void</span> myUART_Thread(<span class="keywordtype">void</span> <span class="keyword">const</span> *argument);</div>
<div class="line">osThreadId tid_myUART_Thread;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* USART Driver */</span></div>
<div class="line"><span class="keyword">extern</span> <a class="code" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART3;</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> myUSART_callback(uint32_t event)</div>
<div class="line">{</div>
<div class="line"> uint32_t mask;</div>
<div class="line"></div>
<div class="line"> mask = <a class="code" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a> |</div>
<div class="line"> <a class="code" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a> |</div>
<div class="line"> <a class="code" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a> |</div>
<div class="line"> <a class="code" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a> ;</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (event & mask) {</div>
<div class="line"> <span class="comment">/* Success: Wakeup Thread */</span></div>
<div class="line"> osSignalSet(tid_myUART_Thread, 0x01);</div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (event & <a class="code" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a>) {</div>
<div class="line"> __breakpoint(0); <span class="comment">/* Error: Call debugger or replace with custom error handling */</span></div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> <span class="keywordflow">if</span> (event & (<a class="code" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a> | <a class="code" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a>)) {</div>
<div class="line"> __breakpoint(0); <span class="comment">/* Error: Call debugger or replace with custom error handling */</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* CMSIS-RTOS Thread - UART command thread */</span></div>
<div class="line"><span class="keywordtype">void</span> myUART_Thread(<span class="keyword">const</span> <span class="keywordtype">void</span>* args)</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">static</span> <a class="code" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> * USARTdrv = &Driver_USART3;</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"> <a class="code" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> <span class="keywordtype">char</span> cmd;</div>
<div class="line"> </div>
<div class="line"><span class="preprocessor"> #ifdef DEBUG</span></div>
<div class="line"><span class="preprocessor"></span> version = USARTdrv-><a class="code" href="group__usart__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> < 0x200) <span class="comment">/* requires at minimum API version 2.00 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"> drv_capabilities = USARTdrv-><a class="code" href="group__usart__interface__gr.html#a9cec078ea816ece7b2d989f35caadb12">GetCapabilities</a>();</div>
<div class="line"> <span class="keywordflow">if</span> (drv_capabilities.<a class="code" href="group__usart__interface__gr.html#a0190aabe8d8f59176be8d693f8874fb3">event_tx_complete</a> == 0)</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"><span class="preprocessor"> #endif</span></div>
<div class="line"><span class="preprocessor"></span> </div>
<div class="line"> <span class="comment">/*Initialize the USART driver */</span></div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#a1a68601c09df8d37f3500ad373333962">Initialize</a>(myUSART_callback);</div>
<div class="line"> <span class="comment">/*Power up the USART peripheral */</span></div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a>(<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
<div class="line"> <span class="comment">/*Configure the USART to 4800 Bits/sec */</span></div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a> |</div>
<div class="line"> <a class="code" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a> |</div>
<div class="line"> <a class="code" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a> |</div>
<div class="line"> <a class="code" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a> |</div>
<div class="line"> <a class="code" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a>, 4800);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Enable Receiver and Transmitter lines */</span></div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a>, 1);</div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a> (<a class="code" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a>, 1);</div>
<div class="line"> </div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922">Send</a>(<span class="stringliteral">"\nPress Enter to receive a message"</span>, 34);</div>
<div class="line"> osSignalWait(0x01, osWaitForever);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">while</span> (1)</div>
<div class="line"> {</div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3">Receive</a>(&cmd, 1); <span class="comment">/* Get byte from UART */</span></div>
<div class="line"> osSignalWait(0x01, osWaitForever);</div>
<div class="line"> <span class="keywordflow">if</span> (cmd == 13) <span class="comment">/* CR, send greeting */</span></div>
<div class="line"> {</div>
<div class="line"> USARTdrv-><a class="code" href="group__usart__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922">Send</a>(<span class="stringliteral">"\nHello World!"</span>, 12);</div>
<div class="line"> osSignalWait(0x01, osWaitForever);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__USART" id="structARM__DRIVER__USART"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_USART</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the USART Driver. </p>
<p>The functions of the USART driver 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 USART interface 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_USART0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_USART1</b> is the name of the access struct of the second instance (no. 1).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_USART<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__usart__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__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">ARM_USART_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:a9cec078ea816ece7b2d989f35caadb12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a9cec078ea816ece7b2d989f35caadb12">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a9cec078ea816ece7b2d989f35caadb12"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> : Get driver capabilities. <a href="#a9cec078ea816ece7b2d989f35caadb12">More...</a><br/></td></tr>
<tr class="separator:a9cec078ea816ece7b2d989f35caadb12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a68601c09df8d37f3500ad373333962"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a1a68601c09df8d37f3500ad373333962">Initialize</a> )(<a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:a1a68601c09df8d37f3500ad373333962"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> : Initialize USART Interface. <a href="#a1a68601c09df8d37f3500ad373333962">More...</a><br/></td></tr>
<tr class="separator:a1a68601c09df8d37f3500ad373333962"><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__usart__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__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize</a> : De-initialize USART 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__usart__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__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">ARM_USART_PowerControl</a> : Control USART Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44eedddf4428cf4b98883b6c27d31922"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922">Send</a> )(const void *data, uint32_t num)</td></tr>
<tr class="memdesc:a44eedddf4428cf4b98883b6c27d31922"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> : Start sending data to USART transmitter. <a href="#a44eedddf4428cf4b98883b6c27d31922">More...</a><br/></td></tr>
<tr class="separator:a44eedddf4428cf4b98883b6c27d31922"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb9224a35fe16c92eb0dd103638e4cf3"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3">Receive</a> )(void *data, uint32_t num)</td></tr>
<tr class="memdesc:adb9224a35fe16c92eb0dd103638e4cf3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a> : Start receiving data from USART receiver. <a href="#adb9224a35fe16c92eb0dd103638e4cf3">More...</a><br/></td></tr>
<tr class="separator:adb9224a35fe16c92eb0dd103638e4cf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad88b63ed74c03ba06b0599ab06ad4cf7"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ad88b63ed74c03ba06b0599ab06ad4cf7">Transfer</a> )(const void *data_out, void *data_in, uint32_t num)</td></tr>
<tr class="memdesc:ad88b63ed74c03ba06b0599ab06ad4cf7"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> : Start sending/receiving data to/from USART. <a href="#ad88b63ed74c03ba06b0599ab06ad4cf7">More...</a><br/></td></tr>
<tr class="separator:ad88b63ed74c03ba06b0599ab06ad4cf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b28b2c21016702f50c28655653099df"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a0b28b2c21016702f50c28655653099df">GetTxCount</a> )(void)</td></tr>
<tr class="memdesc:a0b28b2c21016702f50c28655653099df"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> : Get transmitted data count. <a href="#a0b28b2c21016702f50c28655653099df">More...</a><br/></td></tr>
<tr class="separator:a0b28b2c21016702f50c28655653099df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a758c7822edf6ac18f82eb33c9dc09d71"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a758c7822edf6ac18f82eb33c9dc09d71">GetRxCount</a> )(void)</td></tr>
<tr class="memdesc:a758c7822edf6ac18f82eb33c9dc09d71"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a> : Get received data count. <a href="#a758c7822edf6ac18f82eb33c9dc09d71">More...</a><br/></td></tr>
<tr class="separator:a758c7822edf6ac18f82eb33c9dc09d71"><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__usart__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__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> : Control USART Interface. <a href="#a6e0f47a92f626a971c5197fca6545505">More...</a><br/></td></tr>
<tr class="separator:a6e0f47a92f626a971c5197fca6545505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a055ad4095356a022886828009a980316"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a055ad4095356a022886828009a980316">GetStatus</a> )(void)</td></tr>
<tr class="memdesc:a055ad4095356a022886828009a980316"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> : Get USART status. <a href="#a055ad4095356a022886828009a980316">More...</a><br/></td></tr>
<tr class="separator:a055ad4095356a022886828009a980316"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6703d4078818df27ab9f8a7a8ad7b7b"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#af6703d4078818df27ab9f8a7a8ad7b7b">SetModemControl</a> )(<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> control)</td></tr>
<tr class="memdesc:af6703d4078818df27ab9f8a7a8ad7b7b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> : Set USART Modem Control line state. <a href="#af6703d4078818df27ab9f8a7a8ad7b7b">More...</a><br/></td></tr>
<tr class="separator:af6703d4078818df27ab9f8a7a8ad7b7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a517a7a98a444126734782beb4951a9db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a517a7a98a444126734782beb4951a9db">GetModemStatus</a> )(void)</td></tr>
<tr class="memdesc:a517a7a98a444126734782beb4951a9db"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> : Get USART Modem Status lines state. <a href="#a517a7a98a444126734782beb4951a9db">More...</a><br/></td></tr>
<tr class="separator:a517a7a98a444126734782beb4951a9db"><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__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">ARM_USART_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a9cec078ea816ece7b2d989f35caadb12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a1a68601c09df8d37f3500ad373333962"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> : Initialize USART 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__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize</a> : De-initialize USART 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__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">ARM_USART_PowerControl</a> : Control USART Interface Power. </p>
</div>
</div>
<a class="anchor" id="a44eedddf4428cf4b98883b6c27d31922"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Send)(const void *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> : Start sending data to USART transmitter. </p>
</div>
</div>
<a class="anchor" id="adb9224a35fe16c92eb0dd103638e4cf3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Receive)(void *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a> : Start receiving data from USART receiver. </p>
</div>
</div>
<a class="anchor" id="ad88b63ed74c03ba06b0599ab06ad4cf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Transfer)(const void *data_out, void *data_in, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> : Start sending/receiving data to/from USART. </p>
</div>
</div>
<a class="anchor" id="a0b28b2c21016702f50c28655653099df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetTxCount)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> : Get transmitted data count. </p>
</div>
</div>
<a class="anchor" id="a758c7822edf6ac18f82eb33c9dc09d71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* GetRxCount)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a> : Get received data count. </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__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> : Control USART Interface. </p>
</div>
</div>
<a class="anchor" id="a055ad4095356a022886828009a980316"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>(* GetStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> : Get USART status. </p>
</div>
</div>
<a class="anchor" id="af6703d4078818df27ab9f8a7a8ad7b7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetModemControl)(<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> control)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> : Set USART Modem Control line state. </p>
</div>
</div>
<a class="anchor" id="a517a7a98a444126734782beb4951a9db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>(* GetModemStatus)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> : Get USART Modem Status lines state. </p>
</div>
</div>
</div>
</div>
<a name="structARM__USART__CAPABILITIES" id="structARM__USART__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USART_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USART Device Driver Capabilities. </p>
<p>An USART driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a75ba2507ea29601a309393e794f4413d"></a>uint32_t</td>
<td class="fieldname">
asynchronous: 1</td>
<td class="fielddoc">
supports UART (Asynchronous) mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afb385bfd9fb2d714bb58aa7d8d9d7d51"></a>uint32_t</td>
<td class="fieldname">
synchronous_master: 1</td>
<td class="fielddoc">
supports Synchronous Master mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a37dcd87df8762e2bc9af9fea368b1537"></a>uint32_t</td>
<td class="fieldname">
synchronous_slave: 1</td>
<td class="fielddoc">
supports Synchronous Slave mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ad1928b61021dd9ff689a3ccf9b8966a8"></a>uint32_t</td>
<td class="fieldname">
single_wire: 1</td>
<td class="fielddoc">
supports UART Single-wire mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9a72c5f0209a9ccf840fc196e9a9dffa"></a>uint32_t</td>
<td class="fieldname">
irda: 1</td>
<td class="fielddoc">
supports UART IrDA mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa78e1ee1726d1db2cfa83fd7b5acc8bd"></a>uint32_t</td>
<td class="fieldname">
smart_card: 1</td>
<td class="fielddoc">
supports UART Smart Card mode </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7b3c14ea1b5e9ba0a37ebc05fcfd51a6"></a>uint32_t</td>
<td class="fieldname">
smart_card_clock: 1</td>
<td class="fielddoc">
Smart Card Clock generator available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1d55dd339a08293018608775fc8b4859"></a>uint32_t</td>
<td class="fieldname">
flow_control_rts: 1</td>
<td class="fielddoc">
RTS Flow Control available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a287da15773bb24a301cbfd806975e1e9"></a>uint32_t</td>
<td class="fieldname">
flow_control_cts: 1</td>
<td class="fielddoc">
CTS Flow Control available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0190aabe8d8f59176be8d693f8874fb3"></a>uint32_t</td>
<td class="fieldname">
event_tx_complete: 1</td>
<td class="fielddoc">
Transmit completed event: <a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afe469796cfca4ea61bd6181afb4916be"></a>uint32_t</td>
<td class="fieldname">
event_rx_timeout: 1</td>
<td class="fielddoc">
Signal receive character timeout event: <a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afad044722f459552e9f0f602983659e9"></a>uint32_t</td>
<td class="fieldname">
rts: 1</td>
<td class="fielddoc">
RTS Line: 0=not available, 1=available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0a4ccfb729b3a40a5fd611021268c262"></a>uint32_t</td>
<td class="fieldname">
cts: 1</td>
<td class="fielddoc">
CTS Line: 0=not available, 1=available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa3cc092c82fdc3e5e6646460be6ae9fd"></a>uint32_t</td>
<td class="fieldname">
dtr: 1</td>
<td class="fielddoc">
DTR Line: 0=not available, 1=available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a437895b17519a16f920ae07461dd67d2"></a>uint32_t</td>
<td class="fieldname">
dsr: 1</td>
<td class="fielddoc">
DSR Line: 0=not available, 1=available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa56a9ad6e266df78157f0e04feb4b78c"></a>uint32_t</td>
<td class="fieldname">
dcd: 1</td>
<td class="fielddoc">
DCD Line: 0=not available, 1=available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa6cf03b82235bedc0acf00acb46130fb"></a>uint32_t</td>
<td class="fieldname">
ri: 1</td>
<td class="fielddoc">
RI Line: 0=not available, 1=available. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a4ebe5ddec8d99a63843f2a3c70ac85f9"></a>uint32_t</td>
<td class="fieldname">
event_cts: 1</td>
<td class="fielddoc">
Signal CTS change event: <a class="el" href="group__USART__events.html#ga4cd807ca131bdcb1a7eb4f223fa70476">ARM_USART_EVENT_CTS</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aefdb61f16498d650b5a7f5f9b62779df"></a>uint32_t</td>
<td class="fieldname">
event_dsr: 1</td>
<td class="fielddoc">
Signal DSR change event: <a class="el" href="group__USART__events.html#ga5afef591c2e8dd9bc4332b7bc8d96309">ARM_USART_EVENT_DSR</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7c1dd043d0db9738d6b5fa8d89211446"></a>uint32_t</td>
<td class="fieldname">
event_dcd: 1</td>
<td class="fielddoc">
Signal DCD change event: <a class="el" href="group__USART__events.html#ga1628b951feba1c851f424ce89da409a4">ARM_USART_EVENT_DCD</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab55f90aec5f909ff3a75bf36e61312ea"></a>uint32_t</td>
<td class="fieldname">
event_ri: 1</td>
<td class="fielddoc">
Signal RI change event: <a class="el" href="group__USART__events.html#gac17fe5723d4c5923656dadd9d1302154">ARM_USART_EVENT_RI</a>. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 11</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__USART__STATUS" id="structARM__USART__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USART_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USART Status. </p>
<p>Structure with information about the status of the USART. The data fields encode busy flags and error flags.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2c6d2b67fba3f3e084e96a6bc7fcac6b"></a>uint32_t</td>
<td class="fieldname">
tx_busy: 1</td>
<td class="fielddoc">
Transmitter busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9f5baee58ed41b382628a82a0b1cbcb4"></a>uint32_t</td>
<td class="fieldname">
rx_busy: 1</td>
<td class="fielddoc">
Receiver busy flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a048f45e9d2257a21821f81d9edd17b72"></a>uint32_t</td>
<td class="fieldname">
tx_underflow: 1</td>
<td class="fielddoc">
Transmit data underflow detected (cleared on start of next send operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac403aefd9bce8b0172e1996c0f3dd8aa"></a>uint32_t</td>
<td class="fieldname">
rx_overflow: 1</td>
<td class="fielddoc">
Receive data overflow detected (cleared on start of next receive operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa5e3fa74f444688f9e727ffc1e988e5d"></a>uint32_t</td>
<td class="fieldname">
rx_break: 1</td>
<td class="fielddoc">
Break detected on receive (cleared on start of next receive operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af1d1cfd8b231843d5cc23e6a2b1ca8d0"></a>uint32_t</td>
<td class="fieldname">
rx_framing_error: 1</td>
<td class="fielddoc">
Framing error detected on receive (cleared on start of next receive operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="affb21b610e2d0d71727702441c238f4f"></a>uint32_t</td>
<td class="fieldname">
rx_parity_error: 1</td>
<td class="fielddoc">
Parity error detected on receive (cleared on start of next receive operation) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 25</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structARM__USART__MODEM__STATUS" id="structARM__USART__MODEM__STATUS"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USART_MODEM_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USART Modem Status. </p>
<p>Structure with information about the status of modem lines. The data fields encode states of modem status lines.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a0a4ccfb729b3a40a5fd611021268c262"></a>uint32_t</td>
<td class="fieldname">
cts: 1</td>
<td class="fielddoc">
CTS state: 1=Active, 0=Inactive. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a437895b17519a16f920ae07461dd67d2"></a>uint32_t</td>
<td class="fieldname">
dsr: 1</td>
<td class="fielddoc">
DSR state: 1=Active, 0=Inactive. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa56a9ad6e266df78157f0e04feb4b78c"></a>uint32_t</td>
<td class="fieldname">
dcd: 1</td>
<td class="fielddoc">
DCD state: 1=Active, 0=Inactive. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa6cf03b82235bedc0acf00acb46130fb"></a>uint32_t</td>
<td class="fieldname">
ri: 1</td>
<td class="fielddoc">
RI state: 1=Active, 0=Inactive. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 28</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaa578c3829eea207e9e48df6cb6f038a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_USART_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> : Signal USART Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga7b89d709f048b6a956aa211f63e75f6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>USART Modem Control. </p>
<p>Specifies values for controlling the modem control lines.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> </li>
</ul>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6"></a>ARM_USART_RTS_CLEAR</em> </td><td class="fielddoc">
<p>Deactivate RTS. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434"></a>ARM_USART_RTS_SET</em> </td><td class="fielddoc">
<p>Activate RTS. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c"></a>ARM_USART_DTR_CLEAR</em> </td><td class="fielddoc">
<p>Deactivate DTR. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4"></a>ARM_USART_DTR_SET</em> </td><td class="fielddoc">
<p>Activate DTR. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gabca6151cef47565832decaf484781b61"></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_USART_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_USART_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__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART0;</div>
<div class="line"><a class="code" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_usart (<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_USART0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__usart__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="gad2d3ace1fe7627bb72945efefaeddf0a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> ARM_USART_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__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_USART_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> encode various capabilities, for example supported modes, if a hardware is capable to create signal events using the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> callback function ...</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART0;</div>
<div class="line"><a class="code" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</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__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_USART0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__usart__interface__gr.html#a9cec078ea816ece7b2d989f35caadb12">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="ga51f06805e9a6197c553fa9513ac7b9d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize USART Interface. </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__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_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_USART_Initialize</b> initializes the USART interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the USART interface.</li>
<li>Registers the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_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__usart__interface__gr.html">USART Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="ga96f31f07a6721cf75de2a7a0ab723d26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_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 USART 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_USART_Uninitialize</b> de-initializes the resources of USART 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="ga9bad012b28d544f3eeeea9c2f71a4086"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_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 USART 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 </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_USART_PowerControl</b> operates the power modes of the USART 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>
</div>
</div>
<a class="anchor" id="ga5cf758b0b9d03dca68846962f73c0b08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_Send </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start sending data to USART transmitter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to send to USART transmitter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to send </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>This functions <b>ARM_USART_Send</b> is used in asynchronous mode to send data to the USART transmitter. It can also be used in synchronous mode when sending data only (received data is ignored).</p>
<p>Transmitter needs to be enabled by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a> as the control parameter and <span class="XML-Token">1</span> as argument.</p>
<p>The function parameters specify the buffer with data and the number of items to send. The item size is defined by the data type which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for 5..8 data bits</li>
<li><em>uint16_t</em> when configured for 9 data bits</li>
</ul>
<p>Calling the function <b>ARM_USART_Send</b> only starts the send operation. The function is non-blocking and returns as soon as the driver has started the operation (driver typically configures DMA or the interrupt system for continuous transfer). When in synchronous slave mode the operation is only registered and started when the master starts the transfer. During the operation it is not allowed to call this function again or any other data transfer function when in synchronous mode. Also the data buffer must stay allocated and the contents of unsent data must not be modified. When send operation is completed (requested number of items sent) the <a class="el" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a> event is generated. Progress of send operation can also be monitored by reading the number of items already sent by calling <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a>.</p>
<p>After send operation has completed there might still be some data left in the driver's hardware buffer which is still being transmitted. When all data has been physically transmitted the <a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a> event is generated (if supported and reported by <em>event_tx_complete</em> in <a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a>). At that point also the <em>tx_busy</em> data field in <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a> is cleared.</p>
<p>Status of the transmitter can be monitored by calling the <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> and checking the <em>tx_busy</em> flag which indicates if transmission is still in progress.</p>
<p>When in synchronous slave mode and transmitter is enabled but send/receive/transfer operation is not started and data is requested by the master then the <a class="el" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a> event is generated.</p>
<p>Send operation can be aborted by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#ga54e88b32bc7368ff9c44613eae735c44">ARM_USART_ABORT_SEND</a> as the control parameter. </p>
</div>
</div>
<a class="anchor" id="gae9efabdabb5aaa17bce83339f8a58803"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_Receive </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start receiving data from USART receiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to receive from USART receiver </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to receive </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>This functions <b>ARM_USART_Receive</b> is used in asynchronous mode to receive data from the USART receiver. It can also be used in synchronous mode when receiving data only (transmits the default value as specified by <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#gacd6f060afd55ffa1422567c31ebad950">ARM_USART_SET_DEFAULT_TX_VALUE</a> as control parameter).</p>
<p>Receiver needs to be enabled by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a> as the control parameter and <span class="XML-Token">1</span> as argument.</p>
<p>The function parameters specify the buffer for data and the number of items to receive. The item size is defined by the data type which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for 5..8 data bits</li>
<li><em>uint16_t</em> when configured for 9 data bits</li>
</ul>
<p>Calling the function <b>ARM_USART_Receive</b> only starts the receive operation. The function is non-blocking and returns as soon as the driver has started the operation (driver typically configures DMA or the interrupt system for continuous transfer). When in synchronous slave mode the operation is only registered and started when the master starts the transfer. During the operation it is not allowed to call this function again or any other data transfer function when in synchronous mode. Also the data buffer must stay allocated. When receive operation is completed (requested number of items received) the <a class="el" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a> event is generated. Progress of receive operation can also be monitored by reading the number of items already received by calling <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a>.</p>
<p>Status of the receiver can be monitored by calling the <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> and checking the <em>rx_busy</em> flag which indicates if reception is still in progress.</p>
<p>During reception the following events can be generated (in asynchronous mode):</p>
<ul>
<li><a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a> : Receive timeout between consecutive characters detected (optional)</li>
<li><a class="el" href="group__USART__events.html#gaa1d19e48faf2bdc2a976de448928288e">ARM_USART_EVENT_RX_BREAK</a> : Break detected (Framing error is not generated for Break condition)</li>
<li><a class="el" href="group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127">ARM_USART_EVENT_RX_FRAMING_ERROR</a> : Framing error detected</li>
<li><a class="el" href="group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451">ARM_USART_EVENT_RX_PARITY_ERROR</a> : Parity error detected</li>
<li><a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a> : Data overflow detected (also in synchronous slave mode)</li>
</ul>
<p><a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a> event is also generated when receiver is enabled but data is lost because receive operation in asynchronous mode or receive/send/transfer operation in synchronous slave mode has not been started.</p>
<p>Receive operation can be aborted by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#ga3f57bcedf610dc844e6cc3a230dba5f7">ARM_USART_ABORT_RECEIVE</a> as the control parameter. </p>
</div>
</div>
<a class="anchor" id="ga878899928d34a818edd3e97d67b65c2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_Transfer </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start sending/receiving data to/from USART transmitter/receiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data_out</td><td>Pointer to buffer with data to send to USART transmitter </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data_in</td><td>Pointer to buffer for data to receive from USART receiver </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to transfer </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>This functions <b>ARM_USART_Transfer</b> is used in synchronous mode to transfer data via USART. It synchronously sends data to the USART transmitter and receives data from the USART receiver.</p>
<p>Transmitter needs to be enabled by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a> as the control parameter and <span class="XML-Token">1</span> as argument. Receiver needs to be enabled by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a> as the control parameter and <span class="XML-Token">1</span> as argument.</p>
<p>The function parameters specify the buffer with data to send, the buffer for data to receive and the number of items to transfer. The item size is defined by the data type which depends on the configured number of data bits.</p>
<p>Data type is:</p>
<ul>
<li><em>uint8_t</em> when configured for 5..8 data bits</li>
<li><em>uint16_t</em> when configured for 9 data bits</li>
</ul>
<p>Calling the function <b>ARM_USART_Transfer</b> only starts the transfer operation. The function is non-blocking and returns as soon as the driver has started the operation (driver typically configures DMA or the interrupt system for continuous transfer). When in synchronous slave mode the operation is only registered and started when the master starts the transfer. During the operation it is not allowed to call this function or any other data transfer function again. Also the data buffers must stay allocated and the contents of unsent data must not be modified. When transfer operation is completed (requested number of items transferred) the <a class="el" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a> event is generated. Progress of transfer operation can also be monitored by reading the number of items already transferred by calling <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> or <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a>.</p>
<p>Status of the transmitter or receiver can be monitored by calling the <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> and checking the <em>tx_busy</em> or <em>rx_busy</em> flag.</p>
<p>When in synchronous slave mode also the following events can be generated:</p>
<ul>
<li><a class="el" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a> : transmitter is enabled but transfer operation is not started and data is requested by the master</li>
<li><a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a> : data lost during transfer or because receiver is enabled but transfer operation has not been started</li>
</ul>
<p>Transfer operation can also be aborted by calling <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> with <a class="el" href="group__usart__misc__control.html#ga83d0ef402feb342f9939f0e4ffe26182">ARM_USART_ABORT_TRANSFER</a> as the control parameter. </p>
</div>
</div>
<a class="anchor" id="gacb355584bcdf4ebd36f11d945800fa03"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_USART_GetTxCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get transmitted data count. </p>
<dl class="section return"><dt>Returns</dt><dd>number of data items transmitted</dd></dl>
<p>The function <b>ARM_USART_GetTxCount</b> returns the number of the currently transmitted data items during <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> and <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> operation. </p>
</div>
</div>
<a class="anchor" id="ga1a8799aeeba1363a9e5d22bada715a29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_USART_GetRxCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get received data count. </p>
<dl class="section return"><dt>Returns</dt><dd>number of data items received</dd></dl>
<p>The function <b>ARM_USART_GetRxCount</b> returns the number of the currently received data items during <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a> and <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> operation. </p>
</div>
</div>
<a class="anchor" id="gad8ffdde2123b5412de3005c456da677d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_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 USART 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>common <a class="el" href="group__execution__status.html">Status Error Codes</a> and driver specific <a class="el" href="group__usart__execution__status.html">Status Error Codes</a></dd></dl>
<p>The function <b>ARM_USART_Control</b> control the USART interface settings and execute various operations.</p>
<p>The parameter <em>control</em> sets the operation and is explained in the table below. Values from different categories can be ORed with the exception of <a class="el" href="group__usart__interface__gr.html#usart_misc_tab">Miscellaneous Operations</a>.</p>
<p>The parameter <em>arg</em> provides, depending on the operation, additional information, for example the baudrate.</p>
<p>The table lists the available <em>control</em> operations.</p>
<table class="cmtable">
<tr>
<th>Parameter <em>control</em> </th><th style="text-align:right">Bit </th><th>Category </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a> </td><td rowspan="6" style="text-align:right">0..7 </td><td rowspan="6">Operation Mode </td><td>Set to asynchronous UART mode. <em>arg</em> specifies baudrate. </td></tr>
<tr>
<td><a class="el" href="group__usart__mode__control.html#ga7d3e9e0e838a3f15f8661983b9ac4573">ARM_USART_MODE_SYNCHRONOUS_MASTER</a> </td><td>Set to synchronous master mode with clock signal generation. <em>arg</em> specifies baudrate. </td></tr>
<tr>
<td><a class="el" href="group__usart__mode__control.html#gae78778475f3fab09a080c2279afc69fa">ARM_USART_MODE_SYNCHRONOUS_SLAVE</a> </td><td>Set to synchronous slave mode with external clock signal. </td></tr>
<tr>
<td><a class="el" href="group__usart__mode__control.html#ga4132136971d4f93f2e6a87c6775a9bb0">ARM_USART_MODE_SINGLE_WIRE</a> </td><td>Set to single-wire (half-duplex) mode. <em>arg</em> specifies baudrate. </td></tr>
<tr>
<td><a class="el" href="group__usart__mode__control.html#ga458f4f60d1d772cfd7567ae424d9aad9">ARM_USART_MODE_IRDA</a> </td><td>Set to Infra-red data mode. <em>arg</em> specifies baudrate. </td></tr>
<tr>
<td><a class="el" href="group__usart__mode__control.html#gade65a1c27d9097d9ef0e86c02b55cecd">ARM_USART_MODE_SMART_CARD</a> </td><td>Set to Smart Card mode. <em>arg</em> specifies baudrate. </td></tr>
<tr>
<td><a class="el" href="group__usart__data__bits.html#ga981ff25b4ff806f743d1af4575b87339">ARM_USART_DATA_BITS_5</a> </td><td rowspan="5" style="text-align:right">8..11 </td><td rowspan="5">Data Bits </td><td>Set to <span class="XML-Token">5</span> data bits </td></tr>
<tr>
<td><a class="el" href="group__usart__data__bits.html#ga92ba3d6cea5cd5c0b661667539a9e43c">ARM_USART_DATA_BITS_6</a> </td><td>Set to <span class="XML-Token">6</span> data bits </td></tr>
<tr>
<td><a class="el" href="group__usart__data__bits.html#gad86a2d971ce521c6f6eda28d4f8786a4">ARM_USART_DATA_BITS_7</a> </td><td>Set to <span class="XML-Token">7</span> data bits </td></tr>
<tr>
<td><a class="el" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a> </td><td>Set to <span class="XML-Token">8</span> data bits (default) </td></tr>
<tr>
<td><a class="el" href="group__usart__data__bits.html#gae238a08198dc7ac6178ae0a2a95a2764">ARM_USART_DATA_BITS_9</a> </td><td>Set to <span class="XML-Token">9</span> data bits </td></tr>
<tr>
<td><a class="el" href="group__usart__parity__bit.html#gabc35e8dd2cbebb730abf36959e87a207">ARM_USART_PARITY_EVEN</a> </td><td rowspan="3" style="text-align:right">12..13 </td><td rowspan="3">Parity Bit </td><td>Set to Even Parity </td></tr>
<tr>
<td><a class="el" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a> </td><td>Set to No Parity (default) </td></tr>
<tr>
<td><a class="el" href="group__usart__parity__bit.html#ga02f30181eedd3b04d650dd507bf40d6d">ARM_USART_PARITY_ODD</a> </td><td>Set to Odd Parity </td></tr>
<tr>
<td><a class="el" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a> </td><td rowspan="4" style="text-align:right">14..15 </td><td rowspan="4">Stop Bit </td><td>Set to <span class="XML-Token">1</span> Stop bit (default) </td></tr>
<tr>
<td><a class="el" href="group__usart__stop__bits.html#ga17f034b5f0d0328dc636b403d1954795">ARM_USART_STOP_BITS_2</a> </td><td>Set to <span class="XML-Token">2</span> Stop bits </td></tr>
<tr>
<td><a class="el" href="group__usart__stop__bits.html#gafc1d0f2c95a76ef4c5152792a619f136">ARM_USART_STOP_BITS_1_5</a> </td><td>Set to <span class="XML-Token">1.5</span> Stop bits </td></tr>
<tr>
<td><a class="el" href="group__usart__stop__bits.html#ga47f43cb83d9955a4c90d918acaaa44ba">ARM_USART_STOP_BITS_0_5</a> </td><td>Set to <span class="XML-Token">0.5</span> Stop bits </td></tr>
<tr>
<td><a class="el" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a> </td><td rowspan="4" style="text-align:right">16..17 </td><td rowspan="4">Flow Control </td><td>No flow control signal (default) </td></tr>
<tr>
<td><a class="el" href="group__usart__flow__control.html#gaa7b38ebff1ce0f5c3e4479d22e66715f">ARM_USART_FLOW_CONTROL_CTS</a> </td><td>Set to use the CTS flow control signal </td></tr>
<tr>
<td><a class="el" href="group__usart__flow__control.html#ga80c8a78e8868165cfcc543105bfd9621">ARM_USART_FLOW_CONTROL_RTS</a> </td><td>Set to use the RTS flow control signal </td></tr>
<tr>
<td><a class="el" href="group__usart__flow__control.html#gab16151b5c376b41586faf033f4a42d02">ARM_USART_FLOW_CONTROL_RTS_CTS</a> </td><td>Set to use the RTS and CTS flow control signal </td></tr>
<tr>
<td><a class="el" href="group__usart__clock__polarity.html#ga472d459abb99f1caaff94fa0cdd2ad27">ARM_USART_CPOL0</a> </td><td rowspan="2" style="text-align:right">18 </td><td rowspan="2">Clock Polarity </td><td>CPOL=<span class="XML-Token">0</span> (default) : data are captured on rising edge (low->high transition) </td></tr>
<tr>
<td><a class="el" href="group__usart__clock__polarity.html#ga9e5541d8937a9d92e42aeb273138592a">ARM_USART_CPOL1</a> </td><td>CPOL=<span class="XML-Token">1</span> : data are captured on falling edge (high->lowh transition) </td></tr>
<tr>
<td><a class="el" href="group__usart__clock__phase.html#ga5eb27c2294b7d14a20d0c7e2ef0a47b4">ARM_USART_CPHA0</a> </td><td rowspan="2" style="text-align:right">19 </td><td rowspan="2">Clock Phase </td><td>CPHA=<span class="XML-Token">0</span> (default) : sample on first (leading) edge </td></tr>
<tr>
<td><a class="el" href="group__usart__clock__phase.html#ga4b9f16371870476739a198c52dba6862">ARM_USART_CPHA1</a> </td><td>CPHA=<span class="XML-Token">1</span> : sample on second (trailing) edge </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#ga3f57bcedf610dc844e6cc3a230dba5f7">ARM_USART_ABORT_RECEIVE</a> </td><td rowspan="11" style="text-align:right">0..19 </td><td rowspan="11"><a class="anchor" id="usart_misc_tab"></a>Miscellaneous Operations <br/>
(cannot be ORed) </td><td>Abort receive operation (see also: <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a>) </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#ga54e88b32bc7368ff9c44613eae735c44">ARM_USART_ABORT_SEND</a> </td><td>Abort send operation (see also: <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a>) </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#ga83d0ef402feb342f9939f0e4ffe26182">ARM_USART_ABORT_TRANSFER</a> </td><td>Abort transfer operation (see also: <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>) </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#gab194a6f916e5b25e0262534c0cce54dc">ARM_USART_CONTROL_BREAK</a> </td><td>Enable or disable continuous Break transmission; <em>arg</em> : <span class="XML-Token">0=disabled; 1=enabled</span> </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a> </td><td>Enable or disable receiver; <em>arg</em> : <span class="XML-Token">0=disabled; 1=enabled</span> (see also: <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>) </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#ga4bb5374e7db308b6ff48aa13aa9c4b8a">ARM_USART_CONTROL_SMART_CARD_NACK</a> </td><td>Enable or disable Smart Card NACK generation; <em>arg</em> : <span class="XML-Token">0=disabled; 1=enabled</span> </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a> </td><td>Enable or disable transmitter; <em>arg</em> : <span class="XML-Token">0=disabled; 1=enabled</span> (see also: <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>) </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#gacd6f060afd55ffa1422567c31ebad950">ARM_USART_SET_DEFAULT_TX_VALUE</a> </td><td>Set the default transmit value (synchronous receive only); <em>arg</em> specifies the value. (see also: <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a>) </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#gab8565d1f26382e832327e4553d18eb02">ARM_USART_SET_IRDA_PULSE</a> </td><td>Set the IrDA pulse value in <span class="XML-Token">ns</span>; <em>arg</em> : <span class="XML-Token">0=3/16 of bit period</span> </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#ga79698a2bd564c1f5bb1829ea422e9d3d">ARM_USART_SET_SMART_CARD_CLOCK</a> </td><td>Set the Smart Card Clock in <span class="XML-Token">Hz</span>; <em>arg</em> : <span class="XML-Token">0=Clock not set</span> </td></tr>
<tr>
<td><a class="el" href="group__usart__misc__control.html#ga169be809adc186c131bb8b1618005b28">ARM_USART_SET_SMART_CARD_GUARD_TIME</a> </td><td>Set the Smart Card guard time; <em>arg</em> = number of bit periods </td></tr>
</table>
<p><b>Example</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART0;</div>
<div class="line"></div>
<div class="line"><span class="comment">// configure to UART mode: 8 bits, no parity, 1 stop bit, no flow control, 9600 bps</span></div>
<div class="line">status = Driver_USART0.<a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a> | </div>
<div class="line"> <a class="code" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a> | </div>
<div class="line"> <a class="code" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a> | </div>
<div class="line"> <a class="code" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a> | </div>
<div class="line"> <a class="code" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a>, 9600);</div>
<div class="line"></div>
<div class="line"><span class="comment">// identical with above settings (default settings removed)</span></div>
<div class="line"><span class="comment">// configure to UART mode: 8 bits, no parity, 1 stop bit, flow control, 9600 bps</span></div>
<div class="line">status = Driver_USART0.<a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a>, 9600);</div>
<div class="line"></div>
<div class="line"><span class="comment">// enable TX output</span></div>
<div class="line">status = Driver_USART0.<a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a>, 1);</div>
<div class="line"></div>
<div class="line"><span class="comment">// disable RX output</span></div>
<div class="line">status = Driver_USART0.<a class="code" href="group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505">Control</a>(<a class="code" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a>, 0);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga1e8fdd54294b587438b2b72f4dbde004"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a> ARM_USART_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 USART status. </p>
<dl class="section return"><dt>Returns</dt><dd>USART status <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a></dd></dl>
<p>The function <b>ARM_USART_GetStatus</b> retrieves the current USART interface status. </p>
</div>
</div>
<a class="anchor" id="gad8eb0eb1d1c24fc725584ab93214cfc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USART_SetModemControl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> </td>
<td class="paramname"><em>control</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set USART Modem Control line state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">control</td><td><a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</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_USART_SetModemControl</b> activates or deactivates the selected USART modem control line.</p>
<p>The function <a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> returns information about status of the modem lines. </p>
</div>
</div>
<a class="anchor" id="ga198af0d6a7c85b7c0b96f3d9db8c34e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a> ARM_USART_GetModemStatus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get USART Modem Status lines state. </p>
<dl class="section return"><dt>Returns</dt><dd>modem status <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a></dd></dl>
<p>The function <b>ARM_USART_GetModemStatus</b> returns the current USART Modem Status lines state.</p>
<p>The function <a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> sets the modem control lines of the USART. </p>
</div>
</div>
<a class="anchor" id="gad796cd023f8f6300a6caadcc39d43cbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_USART_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>Signal USART Events. </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__USART__events.html">USART Events</a> notification mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_USART_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a>.</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__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="cmtable">
<tr>
<th>Parameter <em>event</em> </th><th>Bit </th><th>Description </th><th>supported when <a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES" title="USART Device Driver Capabilities. ">ARM_USART_CAPABILITIES</a> </th></tr>
<tr>
<td><a class="el" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a> </td><td>0 </td><td>Occurs after call to <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> to indicate that all the data to be sent was processed by the driver. All the data might have been already transmitted or parts of it are still queued in transmit buffers. The driver is ready for the next call to <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a>; however USART may still transmit data. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a> </td><td>1 </td><td>Occurs after call to <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a> to indicate that all the data has been received. The driver is ready for the next call to <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a> </td><td>2 </td><td>Occurs after call to <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> to indicate that all the data has been transferred. The driver is ready for the next call to <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a> </td><td>3 </td><td>Occurs after call to <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a> to indicate that all the data has been transferred. The driver is ready for the next call to <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>. </td><td>data field <em>event_tx_complete</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a> </td><td>4 </td><td>Occurs in synchronous slave mode when data is requested by the master but send/receive/transfer operation has not been started. Data field <em>rx_underflow</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a> </td><td>5 </td><td>Occurs when data is lost during receive/transfer operation or when data is lost because receive operation in asynchronous mode or receive/send/transfer operation in synchronous slave mode has not been started. Data field <em>rx_overflow</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td>ARM_USART_EVENT_RX_TIMEOUT </td><td>6 </td><td>Occurs during receive when idle time is detected between consecutive characters (idle time is hardware dependent). </td><td>data field <em>event_rx_timeout</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#gaa1d19e48faf2bdc2a976de448928288e">ARM_USART_EVENT_RX_BREAK</a> </td><td>7 </td><td>Occurs when break is detected during receive. Data field <em>rx_break</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127">ARM_USART_EVENT_RX_FRAMING_ERROR</a> </td><td>8 </td><td>Occurs when framing error is detected during receive. Data field <em>rx_framing_error</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td><a class="el" href="group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451">ARM_USART_EVENT_RX_PARITY_ERROR</a> </td><td>9 </td><td>Occurs when parity error is detected during receive. Data field <em>rx_parity_error</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td>ARM_USART_EVENT_CTS </td><td>10 </td><td>Indicates that CTS modem line state has changed. Data field <em>cts</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>. </td><td>data field <em>event_cts</em> = <span class="XML-Token">1</span> and <br/>
data field <em>cts</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td>ARM_USART_EVENT_CTS </td><td>11 </td><td>Indicates that DSR modem line state has changed. Data field <em>dsr</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>. </td><td>data field <em>event_dsr</em> = <span class="XML-Token">1</span> and <br/>
data field <em>dsr</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td>ARM_USART_EVENT_DCD </td><td>12 </td><td>Indicates that DCD modem line state has changed. Data field <em>dcd</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>. </td><td>data field <em>event_dcd</em> = <span class="XML-Token">1</span> and <br/>
data field <em>dcd</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td>ARM_USART_EVENT_RI </td><td>13 </td><td>Indicates that RI modem line state has changed. Data field <em>ri</em> = <span class="XML-Token">1</span> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>. </td><td>data field <em>event_ri</em> = <span class="XML-Token">1</span> and <br/>
data field <em>ri</em> = <span class="XML-Token">1</span> </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__usart__interface__gr.html | HTML | apache-2.0 | 120,159 |
var group__usart__interface__gr =
[
[ "Status Error Codes", "group__usart__execution__status.html", "group__usart__execution__status" ],
[ "USART Events", "group__USART__events.html", "group__USART__events" ],
[ "USART Control Codes", "group__USART__control.html", "group__USART__control" ],
[ "ARM_DRIVER_USART", "group__usart__interface__gr.html#structARM__DRIVER__USART", [
[ "GetVersion", "group__usart__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usart__interface__gr.html#a9cec078ea816ece7b2d989f35caadb12", null ],
[ "Initialize", "group__usart__interface__gr.html#a1a68601c09df8d37f3500ad373333962", null ],
[ "Uninitialize", "group__usart__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usart__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "Send", "group__usart__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922", null ],
[ "Receive", "group__usart__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3", null ],
[ "Transfer", "group__usart__interface__gr.html#ad88b63ed74c03ba06b0599ab06ad4cf7", null ],
[ "GetTxCount", "group__usart__interface__gr.html#a0b28b2c21016702f50c28655653099df", null ],
[ "GetRxCount", "group__usart__interface__gr.html#a758c7822edf6ac18f82eb33c9dc09d71", null ],
[ "Control", "group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__usart__interface__gr.html#a055ad4095356a022886828009a980316", null ],
[ "SetModemControl", "group__usart__interface__gr.html#af6703d4078818df27ab9f8a7a8ad7b7b", null ],
[ "GetModemStatus", "group__usart__interface__gr.html#a517a7a98a444126734782beb4951a9db", null ]
] ],
[ "ARM_USART_CAPABILITIES", "group__usart__interface__gr.html#structARM__USART__CAPABILITIES", [
[ "asynchronous", "group__usart__interface__gr.html#a75ba2507ea29601a309393e794f4413d", null ],
[ "synchronous_master", "group__usart__interface__gr.html#afb385bfd9fb2d714bb58aa7d8d9d7d51", null ],
[ "synchronous_slave", "group__usart__interface__gr.html#a37dcd87df8762e2bc9af9fea368b1537", null ],
[ "single_wire", "group__usart__interface__gr.html#ad1928b61021dd9ff689a3ccf9b8966a8", null ],
[ "irda", "group__usart__interface__gr.html#a9a72c5f0209a9ccf840fc196e9a9dffa", null ],
[ "smart_card", "group__usart__interface__gr.html#aa78e1ee1726d1db2cfa83fd7b5acc8bd", null ],
[ "smart_card_clock", "group__usart__interface__gr.html#a7b3c14ea1b5e9ba0a37ebc05fcfd51a6", null ],
[ "flow_control_rts", "group__usart__interface__gr.html#a1d55dd339a08293018608775fc8b4859", null ],
[ "flow_control_cts", "group__usart__interface__gr.html#a287da15773bb24a301cbfd806975e1e9", null ],
[ "event_tx_complete", "group__usart__interface__gr.html#a0190aabe8d8f59176be8d693f8874fb3", null ],
[ "event_rx_timeout", "group__usart__interface__gr.html#afe469796cfca4ea61bd6181afb4916be", null ],
[ "rts", "group__usart__interface__gr.html#afad044722f459552e9f0f602983659e9", null ],
[ "cts", "group__usart__interface__gr.html#a0a4ccfb729b3a40a5fd611021268c262", null ],
[ "dtr", "group__usart__interface__gr.html#aa3cc092c82fdc3e5e6646460be6ae9fd", null ],
[ "dsr", "group__usart__interface__gr.html#a437895b17519a16f920ae07461dd67d2", null ],
[ "dcd", "group__usart__interface__gr.html#aa56a9ad6e266df78157f0e04feb4b78c", null ],
[ "ri", "group__usart__interface__gr.html#aa6cf03b82235bedc0acf00acb46130fb", null ],
[ "event_cts", "group__usart__interface__gr.html#a4ebe5ddec8d99a63843f2a3c70ac85f9", null ],
[ "event_dsr", "group__usart__interface__gr.html#aefdb61f16498d650b5a7f5f9b62779df", null ],
[ "event_dcd", "group__usart__interface__gr.html#a7c1dd043d0db9738d6b5fa8d89211446", null ],
[ "event_ri", "group__usart__interface__gr.html#ab55f90aec5f909ff3a75bf36e61312ea", null ],
[ "reserved", "group__usart__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USART_STATUS", "group__usart__interface__gr.html#structARM__USART__STATUS", [
[ "tx_busy", "group__usart__interface__gr.html#a2c6d2b67fba3f3e084e96a6bc7fcac6b", null ],
[ "rx_busy", "group__usart__interface__gr.html#a9f5baee58ed41b382628a82a0b1cbcb4", null ],
[ "tx_underflow", "group__usart__interface__gr.html#a048f45e9d2257a21821f81d9edd17b72", null ],
[ "rx_overflow", "group__usart__interface__gr.html#ac403aefd9bce8b0172e1996c0f3dd8aa", null ],
[ "rx_break", "group__usart__interface__gr.html#aa5e3fa74f444688f9e727ffc1e988e5d", null ],
[ "rx_framing_error", "group__usart__interface__gr.html#af1d1cfd8b231843d5cc23e6a2b1ca8d0", null ],
[ "rx_parity_error", "group__usart__interface__gr.html#affb21b610e2d0d71727702441c238f4f", null ],
[ "reserved", "group__usart__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USART_MODEM_STATUS", "group__usart__interface__gr.html#structARM__USART__MODEM__STATUS", [
[ "cts", "group__usart__interface__gr.html#a0a4ccfb729b3a40a5fd611021268c262", null ],
[ "dsr", "group__usart__interface__gr.html#a437895b17519a16f920ae07461dd67d2", null ],
[ "dcd", "group__usart__interface__gr.html#aa56a9ad6e266df78157f0e04feb4b78c", null ],
[ "ri", "group__usart__interface__gr.html#aa6cf03b82235bedc0acf00acb46130fb", null ],
[ "reserved", "group__usart__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USART_SignalEvent_t", "group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1", null ],
[ "ARM_USART_MODEM_CONTROL", "group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f", [
[ "ARM_USART_RTS_CLEAR", "Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6", null ],
[ "ARM_USART_RTS_SET", "Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434", null ],
[ "ARM_USART_DTR_CLEAR", "Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c", null ],
[ "ARM_USART_DTR_SET", "Driver__USART_8h.html#ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4", null ]
] ],
[ "ARM_USART_GetVersion", "group__usart__interface__gr.html#gabca6151cef47565832decaf484781b61", null ],
[ "ARM_USART_GetCapabilities", "group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a", null ],
[ "ARM_USART_Initialize", "group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6", null ],
[ "ARM_USART_Uninitialize", "group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26", null ],
[ "ARM_USART_PowerControl", "group__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086", null ],
[ "ARM_USART_Send", "group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08", null ],
[ "ARM_USART_Receive", "group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803", null ],
[ "ARM_USART_Transfer", "group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a", null ],
[ "ARM_USART_GetTxCount", "group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03", null ],
[ "ARM_USART_GetRxCount", "group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29", null ],
[ "ARM_USART_Control", "group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d", null ],
[ "ARM_USART_GetStatus", "group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004", null ],
[ "ARM_USART_SetModemControl", "group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7", null ],
[ "ARM_USART_GetModemStatus", "group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0", null ],
[ "ARM_USART_SignalEvent", "group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__interface__gr.js | JavaScript | apache-2.0 | 7,976 |
var group__usart__interface__gr_structARM__DRIVER__USART =
[
[ "GetVersion", "group__usart__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usart__interface__gr.html#a9cec078ea816ece7b2d989f35caadb12", null ],
[ "Initialize", "group__usart__interface__gr.html#a1a68601c09df8d37f3500ad373333962", null ],
[ "Uninitialize", "group__usart__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usart__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "Send", "group__usart__interface__gr.html#a44eedddf4428cf4b98883b6c27d31922", null ],
[ "Receive", "group__usart__interface__gr.html#adb9224a35fe16c92eb0dd103638e4cf3", null ],
[ "Transfer", "group__usart__interface__gr.html#ad88b63ed74c03ba06b0599ab06ad4cf7", null ],
[ "GetTxCount", "group__usart__interface__gr.html#a0b28b2c21016702f50c28655653099df", null ],
[ "GetRxCount", "group__usart__interface__gr.html#a758c7822edf6ac18f82eb33c9dc09d71", null ],
[ "Control", "group__usart__interface__gr.html#a6e0f47a92f626a971c5197fca6545505", null ],
[ "GetStatus", "group__usart__interface__gr.html#a055ad4095356a022886828009a980316", null ],
[ "SetModemControl", "group__usart__interface__gr.html#af6703d4078818df27ab9f8a7a8ad7b7b", null ],
[ "GetModemStatus", "group__usart__interface__gr.html#a517a7a98a444126734782beb4951a9db", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__interface__gr_structARM__DRIVER__USART.js | JavaScript | apache-2.0 | 1,437 |
var group__usart__interface__gr_structARM__USART__CAPABILITIES =
[
[ "asynchronous", "group__usart__interface__gr.html#a75ba2507ea29601a309393e794f4413d", null ],
[ "synchronous_master", "group__usart__interface__gr.html#afb385bfd9fb2d714bb58aa7d8d9d7d51", null ],
[ "synchronous_slave", "group__usart__interface__gr.html#a37dcd87df8762e2bc9af9fea368b1537", null ],
[ "single_wire", "group__usart__interface__gr.html#ad1928b61021dd9ff689a3ccf9b8966a8", null ],
[ "irda", "group__usart__interface__gr.html#a9a72c5f0209a9ccf840fc196e9a9dffa", null ],
[ "smart_card", "group__usart__interface__gr.html#aa78e1ee1726d1db2cfa83fd7b5acc8bd", null ],
[ "smart_card_clock", "group__usart__interface__gr.html#a7b3c14ea1b5e9ba0a37ebc05fcfd51a6", null ],
[ "flow_control_rts", "group__usart__interface__gr.html#a1d55dd339a08293018608775fc8b4859", null ],
[ "flow_control_cts", "group__usart__interface__gr.html#a287da15773bb24a301cbfd806975e1e9", null ],
[ "event_tx_complete", "group__usart__interface__gr.html#a0190aabe8d8f59176be8d693f8874fb3", null ],
[ "event_rx_timeout", "group__usart__interface__gr.html#afe469796cfca4ea61bd6181afb4916be", null ],
[ "rts", "group__usart__interface__gr.html#afad044722f459552e9f0f602983659e9", null ],
[ "cts", "group__usart__interface__gr.html#a0a4ccfb729b3a40a5fd611021268c262", null ],
[ "dtr", "group__usart__interface__gr.html#aa3cc092c82fdc3e5e6646460be6ae9fd", null ],
[ "dsr", "group__usart__interface__gr.html#a437895b17519a16f920ae07461dd67d2", null ],
[ "dcd", "group__usart__interface__gr.html#aa56a9ad6e266df78157f0e04feb4b78c", null ],
[ "ri", "group__usart__interface__gr.html#aa6cf03b82235bedc0acf00acb46130fb", null ],
[ "event_cts", "group__usart__interface__gr.html#a4ebe5ddec8d99a63843f2a3c70ac85f9", null ],
[ "event_dsr", "group__usart__interface__gr.html#aefdb61f16498d650b5a7f5f9b62779df", null ],
[ "event_dcd", "group__usart__interface__gr.html#a7c1dd043d0db9738d6b5fa8d89211446", null ],
[ "event_ri", "group__usart__interface__gr.html#ab55f90aec5f909ff3a75bf36e61312ea", null ],
[ "reserved", "group__usart__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__interface__gr_structARM__USART__CAPABILITIES.js | JavaScript | apache-2.0 | 2,217 |
var group__usart__interface__gr_structARM__USART__MODEM__STATUS =
[
[ "cts", "group__usart__interface__gr.html#a0a4ccfb729b3a40a5fd611021268c262", null ],
[ "dsr", "group__usart__interface__gr.html#a437895b17519a16f920ae07461dd67d2", null ],
[ "dcd", "group__usart__interface__gr.html#aa56a9ad6e266df78157f0e04feb4b78c", null ],
[ "ri", "group__usart__interface__gr.html#aa6cf03b82235bedc0acf00acb46130fb", null ],
[ "reserved", "group__usart__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__interface__gr_structARM__USART__MODEM__STATUS.js | JavaScript | apache-2.0 | 528 |
var group__usart__interface__gr_structARM__USART__STATUS =
[
[ "tx_busy", "group__usart__interface__gr.html#a2c6d2b67fba3f3e084e96a6bc7fcac6b", null ],
[ "rx_busy", "group__usart__interface__gr.html#a9f5baee58ed41b382628a82a0b1cbcb4", null ],
[ "tx_underflow", "group__usart__interface__gr.html#a048f45e9d2257a21821f81d9edd17b72", null ],
[ "rx_overflow", "group__usart__interface__gr.html#ac403aefd9bce8b0172e1996c0f3dd8aa", null ],
[ "rx_break", "group__usart__interface__gr.html#aa5e3fa74f444688f9e727ffc1e988e5d", null ],
[ "rx_framing_error", "group__usart__interface__gr.html#af1d1cfd8b231843d5cc23e6a2b1ca8d0", null ],
[ "rx_parity_error", "group__usart__interface__gr.html#affb21b610e2d0d71727702441c238f4f", null ],
[ "reserved", "group__usart__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__interface__gr_structARM__USART__STATUS.js | JavaScript | apache-2.0 | 850 |
<!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 Miscellaneous Control</title>
<title>CMSIS-Driver: USART Miscellaneous Control</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__misc__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">USART Miscellaneous Control<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies additional miscellaneous controls.
<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:gacd6f060afd55ffa1422567c31ebad950"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#gacd6f060afd55ffa1422567c31ebad950">ARM_USART_SET_DEFAULT_TX_VALUE</a>   (0x10UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gacd6f060afd55ffa1422567c31ebad950"><td class="mdescLeft"> </td><td class="mdescRight">Set default Transmit value (Synchronous Receive only); arg = value. <a href="#gacd6f060afd55ffa1422567c31ebad950">More...</a><br/></td></tr>
<tr class="separator:gacd6f060afd55ffa1422567c31ebad950"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab8565d1f26382e832327e4553d18eb02"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#gab8565d1f26382e832327e4553d18eb02">ARM_USART_SET_IRDA_PULSE</a>   (0x11UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gab8565d1f26382e832327e4553d18eb02"><td class="mdescLeft"> </td><td class="mdescRight">Set IrDA Pulse in ns; arg: 0=3/16 of bit period. <a href="#gab8565d1f26382e832327e4553d18eb02">More...</a><br/></td></tr>
<tr class="separator:gab8565d1f26382e832327e4553d18eb02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga169be809adc186c131bb8b1618005b28"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#ga169be809adc186c131bb8b1618005b28">ARM_USART_SET_SMART_CARD_GUARD_TIME</a>   (0x12UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga169be809adc186c131bb8b1618005b28"><td class="mdescLeft"> </td><td class="mdescRight">Set Smart Card Guard Time; arg = number of bit periods. <a href="#ga169be809adc186c131bb8b1618005b28">More...</a><br/></td></tr>
<tr class="separator:ga169be809adc186c131bb8b1618005b28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79698a2bd564c1f5bb1829ea422e9d3d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#ga79698a2bd564c1f5bb1829ea422e9d3d">ARM_USART_SET_SMART_CARD_CLOCK</a>   (0x13UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga79698a2bd564c1f5bb1829ea422e9d3d"><td class="mdescLeft"> </td><td class="mdescRight">Set Smart Card Clock in Hz; arg: 0=Clock not generated. <a href="#ga79698a2bd564c1f5bb1829ea422e9d3d">More...</a><br/></td></tr>
<tr class="separator:ga79698a2bd564c1f5bb1829ea422e9d3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4bb5374e7db308b6ff48aa13aa9c4b8a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#ga4bb5374e7db308b6ff48aa13aa9c4b8a">ARM_USART_CONTROL_SMART_CARD_NACK</a>   (0x14UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga4bb5374e7db308b6ff48aa13aa9c4b8a"><td class="mdescLeft"> </td><td class="mdescRight">Smart Card NACK generation; arg: 0=disabled, 1=enabled. <a href="#ga4bb5374e7db308b6ff48aa13aa9c4b8a">More...</a><br/></td></tr>
<tr class="separator:ga4bb5374e7db308b6ff48aa13aa9c4b8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad96ea1a80c97f968fbc0ae4c20e7fa6a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a>   (0x15UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gad96ea1a80c97f968fbc0ae4c20e7fa6a"><td class="mdescLeft"> </td><td class="mdescRight">Transmitter; arg: 0=disabled, 1=enabled. <a href="#gad96ea1a80c97f968fbc0ae4c20e7fa6a">More...</a><br/></td></tr>
<tr class="separator:gad96ea1a80c97f968fbc0ae4c20e7fa6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad52c08553ae203d4f7741404589b8169"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a>   (0x16UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gad52c08553ae203d4f7741404589b8169"><td class="mdescLeft"> </td><td class="mdescRight">Receiver; arg: 0=disabled, 1=enabled. <a href="#gad52c08553ae203d4f7741404589b8169">More...</a><br/></td></tr>
<tr class="separator:gad52c08553ae203d4f7741404589b8169"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab194a6f916e5b25e0262534c0cce54dc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#gab194a6f916e5b25e0262534c0cce54dc">ARM_USART_CONTROL_BREAK</a>   (0x17UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gab194a6f916e5b25e0262534c0cce54dc"><td class="mdescLeft"> </td><td class="mdescRight">Continuous Break transmission; arg: 0=disabled, 1=enabled. <a href="#gab194a6f916e5b25e0262534c0cce54dc">More...</a><br/></td></tr>
<tr class="separator:gab194a6f916e5b25e0262534c0cce54dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga54e88b32bc7368ff9c44613eae735c44"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#ga54e88b32bc7368ff9c44613eae735c44">ARM_USART_ABORT_SEND</a>   (0x18UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga54e88b32bc7368ff9c44613eae735c44"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a>. <a href="#ga54e88b32bc7368ff9c44613eae735c44">More...</a><br/></td></tr>
<tr class="separator:ga54e88b32bc7368ff9c44613eae735c44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f57bcedf610dc844e6cc3a230dba5f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#ga3f57bcedf610dc844e6cc3a230dba5f7">ARM_USART_ABORT_RECEIVE</a>   (0x19UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga3f57bcedf610dc844e6cc3a230dba5f7"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a>. <a href="#ga3f57bcedf610dc844e6cc3a230dba5f7">More...</a><br/></td></tr>
<tr class="separator:ga3f57bcedf610dc844e6cc3a230dba5f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga83d0ef402feb342f9939f0e4ffe26182"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__misc__control.html#ga83d0ef402feb342f9939f0e4ffe26182">ARM_USART_ABORT_TRANSFER</a>   (0x1AUL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga83d0ef402feb342f9939f0e4ffe26182"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>. <a href="#ga83d0ef402feb342f9939f0e4ffe26182">More...</a><br/></td></tr>
<tr class="separator:ga83d0ef402feb342f9939f0e4ffe26182"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies additional miscellaneous controls. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gacd6f060afd55ffa1422567c31ebad950"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_SET_DEFAULT_TX_VALUE   (0x10UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set default Transmit value (Synchronous Receive only); arg = value. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803" title="Start receiving data from USART receiver. ">ARM_USART_Receive</a>; </dd></dl>
</div>
</div>
<a class="anchor" id="gab8565d1f26382e832327e4553d18eb02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_SET_IRDA_PULSE   (0x11UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set IrDA Pulse in ns; arg: 0=3/16 of bit period. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga169be809adc186c131bb8b1618005b28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_SET_SMART_CARD_GUARD_TIME   (0x12UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Smart Card Guard Time; arg = number of bit periods. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga79698a2bd564c1f5bb1829ea422e9d3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_SET_SMART_CARD_CLOCK   (0x13UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Smart Card Clock in Hz; arg: 0=Clock not generated. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4bb5374e7db308b6ff48aa13aa9c4b8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CONTROL_SMART_CARD_NACK   (0x14UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Smart Card NACK generation; arg: 0=disabled, 1=enabled. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad96ea1a80c97f968fbc0ae4c20e7fa6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CONTROL_TX   (0x15UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmitter; arg: 0=disabled, 1=enabled. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08" title="Start sending data to USART transmitter. ">ARM_USART_Send</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a" title="Start sending/receiving data to/from USART transmitter/receiver. ">ARM_USART_Transfer</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad52c08553ae203d4f7741404589b8169"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CONTROL_RX   (0x16UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receiver; arg: 0=disabled, 1=enabled. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803" title="Start receiving data from USART receiver. ">ARM_USART_Receive</a>; <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a" title="Start sending/receiving data to/from USART transmitter/receiver. ">ARM_USART_Transfer</a>; </dd></dl>
</div>
</div>
<a class="anchor" id="gab194a6f916e5b25e0262534c0cce54dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_CONTROL_BREAK   (0x17UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Continuous Break transmission; arg: 0=disabled, 1=enabled. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga54e88b32bc7368ff9c44613eae735c44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ABORT_SEND   (0x18UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; </dd></dl>
</div>
</div>
<a class="anchor" id="ga3f57bcedf610dc844e6cc3a230dba5f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ABORT_RECEIVE   (0x19UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a>; </dd></dl>
</div>
</div>
<a class="anchor" id="ga83d0ef402feb342f9939f0e4ffe26182"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_ABORT_TRANSFER   (0x1AUL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort <a class="el" href="group__usart__interface__gr.html#ga878899928d34a818edd3e97d67b65c2a">ARM_USART_Transfer</a>. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_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__usart__misc__control.html | HTML | apache-2.0 | 22,517 |
var group__usart__misc__control =
[
[ "ARM_USART_SET_DEFAULT_TX_VALUE", "group__usart__misc__control.html#gacd6f060afd55ffa1422567c31ebad950", null ],
[ "ARM_USART_SET_IRDA_PULSE", "group__usart__misc__control.html#gab8565d1f26382e832327e4553d18eb02", null ],
[ "ARM_USART_SET_SMART_CARD_GUARD_TIME", "group__usart__misc__control.html#ga169be809adc186c131bb8b1618005b28", null ],
[ "ARM_USART_SET_SMART_CARD_CLOCK", "group__usart__misc__control.html#ga79698a2bd564c1f5bb1829ea422e9d3d", null ],
[ "ARM_USART_CONTROL_SMART_CARD_NACK", "group__usart__misc__control.html#ga4bb5374e7db308b6ff48aa13aa9c4b8a", null ],
[ "ARM_USART_CONTROL_TX", "group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a", null ],
[ "ARM_USART_CONTROL_RX", "group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169", null ],
[ "ARM_USART_CONTROL_BREAK", "group__usart__misc__control.html#gab194a6f916e5b25e0262534c0cce54dc", null ],
[ "ARM_USART_ABORT_SEND", "group__usart__misc__control.html#ga54e88b32bc7368ff9c44613eae735c44", null ],
[ "ARM_USART_ABORT_RECEIVE", "group__usart__misc__control.html#ga3f57bcedf610dc844e6cc3a230dba5f7", null ],
[ "ARM_USART_ABORT_TRANSFER", "group__usart__misc__control.html#ga83d0ef402feb342f9939f0e4ffe26182", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__misc__control.js | JavaScript | apache-2.0 | 1,298 |
<!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 Mode Control</title>
<title>CMSIS-Driver: USART Mode Control</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__mode__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">USART Mode Control<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify USART mode.
<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:gad85039731478c924d3b418ec00768388"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a>   (0x01UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gad85039731478c924d3b418ec00768388"><td class="mdescLeft"> </td><td class="mdescRight">UART (Asynchronous); arg = Baudrate. <a href="#gad85039731478c924d3b418ec00768388">More...</a><br/></td></tr>
<tr class="separator:gad85039731478c924d3b418ec00768388"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7d3e9e0e838a3f15f8661983b9ac4573"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#ga7d3e9e0e838a3f15f8661983b9ac4573">ARM_USART_MODE_SYNCHRONOUS_MASTER</a>   (0x02UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga7d3e9e0e838a3f15f8661983b9ac4573"><td class="mdescLeft"> </td><td class="mdescRight">Synchronous Master (generates clock signal); arg = Baudrate. <a href="#ga7d3e9e0e838a3f15f8661983b9ac4573">More...</a><br/></td></tr>
<tr class="separator:ga7d3e9e0e838a3f15f8661983b9ac4573"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae78778475f3fab09a080c2279afc69fa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#gae78778475f3fab09a080c2279afc69fa">ARM_USART_MODE_SYNCHRONOUS_SLAVE</a>   (0x03UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gae78778475f3fab09a080c2279afc69fa"><td class="mdescLeft"> </td><td class="mdescRight">Synchronous Slave (external clock signal) <a href="#gae78778475f3fab09a080c2279afc69fa">More...</a><br/></td></tr>
<tr class="separator:gae78778475f3fab09a080c2279afc69fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4132136971d4f93f2e6a87c6775a9bb0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#ga4132136971d4f93f2e6a87c6775a9bb0">ARM_USART_MODE_SINGLE_WIRE</a>   (0x04UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga4132136971d4f93f2e6a87c6775a9bb0"><td class="mdescLeft"> </td><td class="mdescRight">UART Single-wire (half-duplex); arg = Baudrate. <a href="#ga4132136971d4f93f2e6a87c6775a9bb0">More...</a><br/></td></tr>
<tr class="separator:ga4132136971d4f93f2e6a87c6775a9bb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga458f4f60d1d772cfd7567ae424d9aad9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#ga458f4f60d1d772cfd7567ae424d9aad9">ARM_USART_MODE_IRDA</a>   (0x05UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:ga458f4f60d1d772cfd7567ae424d9aad9"><td class="mdescLeft"> </td><td class="mdescRight">UART IrDA; arg = Baudrate. <a href="#ga458f4f60d1d772cfd7567ae424d9aad9">More...</a><br/></td></tr>
<tr class="separator:ga458f4f60d1d772cfd7567ae424d9aad9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade65a1c27d9097d9ef0e86c02b55cecd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__mode__control.html#gade65a1c27d9097d9ef0e86c02b55cecd">ARM_USART_MODE_SMART_CARD</a>   (0x06UL << ARM_USART_CONTROL_Pos)</td></tr>
<tr class="memdesc:gade65a1c27d9097d9ef0e86c02b55cecd"><td class="mdescLeft"> </td><td class="mdescRight">UART Smart Card; arg = Baudrate. <a href="#gade65a1c27d9097d9ef0e86c02b55cecd">More...</a><br/></td></tr>
<tr class="separator:gade65a1c27d9097d9ef0e86c02b55cecd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify USART mode. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad85039731478c924d3b418ec00768388"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_MODE_ASYNCHRONOUS   (0x01UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>UART (Asynchronous); arg = Baudrate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7d3e9e0e838a3f15f8661983b9ac4573"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_MODE_SYNCHRONOUS_MASTER   (0x02UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronous Master (generates clock signal); arg = Baudrate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae78778475f3fab09a080c2279afc69fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_MODE_SYNCHRONOUS_SLAVE   (0x03UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronous Slave (external clock signal) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4132136971d4f93f2e6a87c6775a9bb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_MODE_SINGLE_WIRE   (0x04UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>UART Single-wire (half-duplex); arg = Baudrate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga458f4f60d1d772cfd7567ae424d9aad9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_MODE_IRDA   (0x05UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>UART IrDA; arg = Baudrate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gade65a1c27d9097d9ef0e86c02b55cecd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_MODE_SMART_CARD   (0x06UL << ARM_USART_CONTROL_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>UART Smart Card; arg = Baudrate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_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__usart__mode__control.html | HTML | apache-2.0 | 14,507 |
var group__usart__mode__control =
[
[ "ARM_USART_MODE_ASYNCHRONOUS", "group__usart__mode__control.html#gad85039731478c924d3b418ec00768388", null ],
[ "ARM_USART_MODE_SYNCHRONOUS_MASTER", "group__usart__mode__control.html#ga7d3e9e0e838a3f15f8661983b9ac4573", null ],
[ "ARM_USART_MODE_SYNCHRONOUS_SLAVE", "group__usart__mode__control.html#gae78778475f3fab09a080c2279afc69fa", null ],
[ "ARM_USART_MODE_SINGLE_WIRE", "group__usart__mode__control.html#ga4132136971d4f93f2e6a87c6775a9bb0", null ],
[ "ARM_USART_MODE_IRDA", "group__usart__mode__control.html#ga458f4f60d1d772cfd7567ae424d9aad9", null ],
[ "ARM_USART_MODE_SMART_CARD", "group__usart__mode__control.html#gade65a1c27d9097d9ef0e86c02b55cecd", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__mode__control.js | JavaScript | apache-2.0 | 733 |
<!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 Parity Bit</title>
<title>CMSIS-Driver: USART Parity Bit</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__parity__bit.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 Parity Bit<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the parity bit.
<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:ga141a64650f99a1f642c3b3b6ced0eb8d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a>   (0UL << ARM_USART_PARITY_Pos)</td></tr>
<tr class="memdesc:ga141a64650f99a1f642c3b3b6ced0eb8d"><td class="mdescLeft"> </td><td class="mdescRight">No Parity (default) <a href="#ga141a64650f99a1f642c3b3b6ced0eb8d">More...</a><br/></td></tr>
<tr class="separator:ga141a64650f99a1f642c3b3b6ced0eb8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc35e8dd2cbebb730abf36959e87a207"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__parity__bit.html#gabc35e8dd2cbebb730abf36959e87a207">ARM_USART_PARITY_EVEN</a>   (1UL << ARM_USART_PARITY_Pos)</td></tr>
<tr class="memdesc:gabc35e8dd2cbebb730abf36959e87a207"><td class="mdescLeft"> </td><td class="mdescRight">Even Parity. <a href="#gabc35e8dd2cbebb730abf36959e87a207">More...</a><br/></td></tr>
<tr class="separator:gabc35e8dd2cbebb730abf36959e87a207"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga02f30181eedd3b04d650dd507bf40d6d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__parity__bit.html#ga02f30181eedd3b04d650dd507bf40d6d">ARM_USART_PARITY_ODD</a>   (2UL << ARM_USART_PARITY_Pos)</td></tr>
<tr class="memdesc:ga02f30181eedd3b04d650dd507bf40d6d"><td class="mdescLeft"> </td><td class="mdescRight">Odd Parity. <a href="#ga02f30181eedd3b04d650dd507bf40d6d">More...</a><br/></td></tr>
<tr class="separator:ga02f30181eedd3b04d650dd507bf40d6d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the parity bit. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga141a64650f99a1f642c3b3b6ced0eb8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_PARITY_NONE   (0UL << ARM_USART_PARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>No Parity (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gabc35e8dd2cbebb730abf36959e87a207"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_PARITY_EVEN   (1UL << ARM_USART_PARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Even Parity. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga02f30181eedd3b04d650dd507bf40d6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_PARITY_ODD   (2UL << ARM_USART_PARITY_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Odd Parity. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_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__usart__parity__bit.html | HTML | apache-2.0 | 10,406 |
var group__usart__parity__bit =
[
[ "ARM_USART_PARITY_NONE", "group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d", null ],
[ "ARM_USART_PARITY_EVEN", "group__usart__parity__bit.html#gabc35e8dd2cbebb730abf36959e87a207", null ],
[ "ARM_USART_PARITY_ODD", "group__usart__parity__bit.html#ga02f30181eedd3b04d650dd507bf40d6d", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__parity__bit.js | JavaScript | apache-2.0 | 358 |
<!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 Stop Bits</title>
<title>CMSIS-Driver: USART Stop Bits</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__stop__bits.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 Stop Bits<div class="ingroups"><a class="el" href="group__USART__control.html">USART Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines the number of stop bits.
<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:ga45f51a51e654b4753a538ed33f0d7d78"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a>   (0UL << ARM_USART_STOP_BITS_Pos)</td></tr>
<tr class="memdesc:ga45f51a51e654b4753a538ed33f0d7d78"><td class="mdescLeft"> </td><td class="mdescRight">1 Stop bit (default) <a href="#ga45f51a51e654b4753a538ed33f0d7d78">More...</a><br/></td></tr>
<tr class="separator:ga45f51a51e654b4753a538ed33f0d7d78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga17f034b5f0d0328dc636b403d1954795"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__stop__bits.html#ga17f034b5f0d0328dc636b403d1954795">ARM_USART_STOP_BITS_2</a>   (1UL << ARM_USART_STOP_BITS_Pos)</td></tr>
<tr class="memdesc:ga17f034b5f0d0328dc636b403d1954795"><td class="mdescLeft"> </td><td class="mdescRight">2 Stop bits <a href="#ga17f034b5f0d0328dc636b403d1954795">More...</a><br/></td></tr>
<tr class="separator:ga17f034b5f0d0328dc636b403d1954795"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc1d0f2c95a76ef4c5152792a619f136"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__stop__bits.html#gafc1d0f2c95a76ef4c5152792a619f136">ARM_USART_STOP_BITS_1_5</a>   (2UL << ARM_USART_STOP_BITS_Pos)</td></tr>
<tr class="memdesc:gafc1d0f2c95a76ef4c5152792a619f136"><td class="mdescLeft"> </td><td class="mdescRight">1.5 Stop bits <a href="#gafc1d0f2c95a76ef4c5152792a619f136">More...</a><br/></td></tr>
<tr class="separator:gafc1d0f2c95a76ef4c5152792a619f136"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga47f43cb83d9955a4c90d918acaaa44ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__stop__bits.html#ga47f43cb83d9955a4c90d918acaaa44ba">ARM_USART_STOP_BITS_0_5</a>   (3UL << ARM_USART_STOP_BITS_Pos)</td></tr>
<tr class="memdesc:ga47f43cb83d9955a4c90d918acaaa44ba"><td class="mdescLeft"> </td><td class="mdescRight">0.5 Stop bits <a href="#ga47f43cb83d9955a4c90d918acaaa44ba">More...</a><br/></td></tr>
<tr class="separator:ga47f43cb83d9955a4c90d918acaaa44ba"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Defines the number of stop bits. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga45f51a51e654b4753a538ed33f0d7d78"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_STOP_BITS_1   (0UL << ARM_USART_STOP_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 Stop bit (default) </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga17f034b5f0d0328dc636b403d1954795"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_STOP_BITS_2   (1UL << ARM_USART_STOP_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>2 Stop bits </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafc1d0f2c95a76ef4c5152792a619f136"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_STOP_BITS_1_5   (2UL << ARM_USART_STOP_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>1.5 Stop bits </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_Control</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga47f43cb83d9955a4c90d918acaaa44ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_USART_STOP_BITS_0_5   (3UL << ARM_USART_STOP_BITS_Pos)</td>
</tr>
</table>
</div><div class="memdoc">
<p>0.5 Stop bits </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d" title="Control USART Interface. ">ARM_USART_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__usart__stop__bits.html | HTML | apache-2.0 | 11,870 |
var group__usart__stop__bits =
[
[ "ARM_USART_STOP_BITS_1", "group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78", null ],
[ "ARM_USART_STOP_BITS_2", "group__usart__stop__bits.html#ga17f034b5f0d0328dc636b403d1954795", null ],
[ "ARM_USART_STOP_BITS_1_5", "group__usart__stop__bits.html#gafc1d0f2c95a76ef4c5152792a619f136", null ],
[ "ARM_USART_STOP_BITS_0_5", "group__usart__stop__bits.html#ga47f43cb83d9955a4c90d918acaaa44ba", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usart__stop__bits.js | JavaScript | apache-2.0 | 466 |
<!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 Interface</title>
<title>CMSIS-Driver: USB 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__usb__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> </div>
<div class="headertitle">
<div class="title">USB Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>USB common definitions (Driver_USB.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__usbd__interface__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a></td></tr>
<tr class="memdesc:group__usbd__interface__gr"><td class="mdescLeft"> </td><td class="mdescRight">Driver API for USB Device Peripheral (Driver_USBD.h) <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usbh__interface__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a></td></tr>
<tr class="memdesc:group__usbh__interface__gr"><td class="mdescLeft"> </td><td class="mdescRight">Driver API for USB Host Peripheral (Driver_USBH.h) <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USB__speed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__speed.html">USB Speed</a></td></tr>
<tr class="memdesc:group__USB__speed"><td class="mdescLeft"> </td><td class="mdescRight">USB Speed definitions. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USB__endpoint__type"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USB__endpoint__type.html">USB Endpoint Type</a></td></tr>
<tr class="memdesc:group__USB__endpoint__type"><td class="mdescLeft"> </td><td class="mdescRight">USB Endpoint Type definitions. <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>USB common definitions (Driver_USB.h) </p>
<p>The <b>Universal Serial Bus</b> (USB) implements a serial bus for data exchange. It is a host controlled, plug-and-play interface between a USB host and USB devices using a tiered star topology. In microcontroller (MCU) applications, the interface is often used to connect a device to a host for data exchange or control purposes.</p>
<ul>
<li>Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/Universal_Serial_Bus" target="_blank"><b>Universal Serial Bus</b></a>.</li>
<li>The USB Implementers Forum provides detailed documentation under <a href="http://www.usb.org"><b>www.usb.org</b></a>.</li>
</ul>
<p><b>Block Diagram</b></p>
<p>Typically only one USB Device is connected to a USB Host. If several USB devices must be connected to the same USB host, then the connection must be done via a USB hub.</p>
<div class="image">
<img src="USB_Schematics.png" alt="USB_Schematics.png"/>
<div class="caption">
Simplified USB Schema</div></div>
<p><b>USB API</b></p>
<p>The following header files define the Application Programming Interface (API) for the USB interface:</p>
<ul>
<li><b>Driver_USB.h</b> : Common definitions of the USBD and USBH interface</li>
<li><b>Driver_USBD.h</b> : Driver API for USB Device Peripheral</li>
<li><b>Driver_USBH.h</b> : Driver API for USB Host 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__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a> : access struct for USBD driver functions</li>
<li><a class="el" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> : access struct for USBH driver functions</li>
</ul>
<hr/>
</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__interface__gr.html | HTML | apache-2.0 | 10,436 |
var group__usb__interface__gr =
[
[ "USB Device Interface", "group__usbd__interface__gr.html", "group__usbd__interface__gr" ],
[ "USB Host Interface", "group__usbh__interface__gr.html", "group__usbh__interface__gr" ],
[ "USB Speed", "group__USB__speed.html", "group__USB__speed" ],
[ "USB Endpoint Type", "group__USB__endpoint__type.html", "group__USB__endpoint__type" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usb__interface__gr.js | JavaScript | apache-2.0 | 389 |
<!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 Device Interface</title>
<title>CMSIS-Driver: USB Device 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__usbd__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">USB Device Interface<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for USB Device Peripheral (Driver_USBD.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__USBD__dev__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html">USBD Device Events</a></td></tr>
<tr class="memdesc:group__USBD__dev__events"><td class="mdescLeft"> </td><td class="mdescRight">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>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USBD__ep__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html">USBD Endpoint Events</a></td></tr>
<tr class="memdesc:group__USBD__ep__events"><td class="mdescLeft"> </td><td class="mdescRight">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>. <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__USBD"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a></td></tr>
<tr class="memdesc:structARM__DRIVER__USBD"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the USB Device Driver. <a href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__USBD"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USBD__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__USBD__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">USB Device Driver Capabilities. <a href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__USBD__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USBD__STATE"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a></td></tr>
<tr class="memdesc:structARM__USBD__STATE"><td class="mdescLeft"> </td><td class="mdescRight">USB Device State. <a href="group__usbd__interface__gr.html#structARM__USBD__STATE">More...</a><br/></td></tr>
<tr class="separator:structARM__USBD__STATE"><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:ga7c1878799699ddd34cec696da499f7bd"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a> )(uint32_t event)</td></tr>
<tr class="memdesc:ga7c1878799699ddd34cec696da499f7bd"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> : Signal USB Device Event. <a href="#ga7c1878799699ddd34cec696da499f7bd">More...</a><br/></td></tr>
<tr class="separator:ga7c1878799699ddd34cec696da499f7bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae754763700fc5059a6bde57ea2d4e2c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a> )(uint8_t ep_addr, uint32_t event)</td></tr>
<tr class="memdesc:gaae754763700fc5059a6bde57ea2d4e2c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> : Signal USB Endpoint Event. <a href="#gaae754763700fc5059a6bde57ea2d4e2c">More...</a><br/></td></tr>
<tr class="separator:gaae754763700fc5059a6bde57ea2d4e2c"><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:ga1dcb8b7790f0e3613ee3da77e5fd18fc"><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__usbd__interface__gr.html#ga1dcb8b7790f0e3613ee3da77e5fd18fc">ARM_USBD_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga1dcb8b7790f0e3613ee3da77e5fd18fc"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#ga1dcb8b7790f0e3613ee3da77e5fd18fc">More...</a><br/></td></tr>
<tr class="separator:ga1dcb8b7790f0e3613ee3da77e5fd18fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga178d01ab7896e1c675b90bbccfe8ea7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d">ARM_USBD_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga178d01ab7896e1c675b90bbccfe8ea7d"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga178d01ab7896e1c675b90bbccfe8ea7d">More...</a><br/></td></tr>
<tr class="separator:ga178d01ab7896e1c675b90bbccfe8ea7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60b95c9c0c6767ff5938464cfd748f81"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a> (<a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a> cb_device_event, <a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a> cb_endpoint_event)</td></tr>
<tr class="memdesc:ga60b95c9c0c6767ff5938464cfd748f81"><td class="mdescLeft"> </td><td class="mdescRight">Initialize USB Device Interface. <a href="#ga60b95c9c0c6767ff5938464cfd748f81">More...</a><br/></td></tr>
<tr class="separator:ga60b95c9c0c6767ff5938464cfd748f81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafaead6713f141be1734de0110eda966b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b">ARM_USBD_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gafaead6713f141be1734de0110eda966b"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize USB Device Interface. <a href="#gafaead6713f141be1734de0110eda966b">More...</a><br/></td></tr>
<tr class="separator:gafaead6713f141be1734de0110eda966b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa5bdaac19f6df30c6e569abef17cdb42"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gaa5bdaac19f6df30c6e569abef17cdb42">ARM_USBD_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:gaa5bdaac19f6df30c6e569abef17cdb42"><td class="mdescLeft"> </td><td class="mdescRight">Control USB Device Interface Power. <a href="#gaa5bdaac19f6df30c6e569abef17cdb42">More...</a><br/></td></tr>
<tr class="separator:gaa5bdaac19f6df30c6e569abef17cdb42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga99207f7ff5e97a7f65754eab7f775fca"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca">ARM_USBD_DeviceConnect</a> (void)</td></tr>
<tr class="memdesc:ga99207f7ff5e97a7f65754eab7f775fca"><td class="mdescLeft"> </td><td class="mdescRight">Connect USB Device. <a href="#ga99207f7ff5e97a7f65754eab7f775fca">More...</a><br/></td></tr>
<tr class="separator:ga99207f7ff5e97a7f65754eab7f775fca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga37234abecbb63e4e739f9676e489d2d1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1">ARM_USBD_DeviceDisconnect</a> (void)</td></tr>
<tr class="memdesc:ga37234abecbb63e4e739f9676e489d2d1"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect USB Device. <a href="#ga37234abecbb63e4e739f9676e489d2d1">More...</a><br/></td></tr>
<tr class="separator:ga37234abecbb63e4e739f9676e489d2d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7624d6b2cbe5e6ab5016206ce641eee2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2">ARM_USBD_DeviceGetState</a> (void)</td></tr>
<tr class="memdesc:ga7624d6b2cbe5e6ab5016206ce641eee2"><td class="mdescLeft"> </td><td class="mdescRight">Get current USB Device State. <a href="#ga7624d6b2cbe5e6ab5016206ce641eee2">More...</a><br/></td></tr>
<tr class="separator:ga7624d6b2cbe5e6ab5016206ce641eee2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e149a4c6a0196da24a44f4fada75fb1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga7e149a4c6a0196da24a44f4fada75fb1">ARM_USBD_DeviceRemoteWakeup</a> (void)</td></tr>
<tr class="memdesc:ga7e149a4c6a0196da24a44f4fada75fb1"><td class="mdescLeft"> </td><td class="mdescRight">Trigger USB Remote Wakeup. <a href="#ga7e149a4c6a0196da24a44f4fada75fb1">More...</a><br/></td></tr>
<tr class="separator:ga7e149a4c6a0196da24a44f4fada75fb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae66f696584e25fb2ddabe9070fa38670"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gae66f696584e25fb2ddabe9070fa38670">ARM_USBD_DeviceSetAddress</a> (uint8_t dev_addr)</td></tr>
<tr class="memdesc:gae66f696584e25fb2ddabe9070fa38670"><td class="mdescLeft"> </td><td class="mdescRight">Set USB Device Address. <a href="#gae66f696584e25fb2ddabe9070fa38670">More...</a><br/></td></tr>
<tr class="separator:gae66f696584e25fb2ddabe9070fa38670"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6bc0ebf699a0f28330f21cab83f85e9e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga6bc0ebf699a0f28330f21cab83f85e9e">ARM_USBD_ReadSetupPacket</a> (uint8_t *setup)</td></tr>
<tr class="memdesc:ga6bc0ebf699a0f28330f21cab83f85e9e"><td class="mdescLeft"> </td><td class="mdescRight">Read setup packet received over Control Endpoint. <a href="#ga6bc0ebf699a0f28330f21cab83f85e9e">More...</a><br/></td></tr>
<tr class="separator:ga6bc0ebf699a0f28330f21cab83f85e9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga62d7d5bdcf9ca7bf7e6d8434368abad8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8">ARM_USBD_EndpointConfigure</a> (uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size)</td></tr>
<tr class="memdesc:ga62d7d5bdcf9ca7bf7e6d8434368abad8"><td class="mdescLeft"> </td><td class="mdescRight">Configure USB Endpoint. <a href="#ga62d7d5bdcf9ca7bf7e6d8434368abad8">More...</a><br/></td></tr>
<tr class="separator:ga62d7d5bdcf9ca7bf7e6d8434368abad8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca913df5188dc0f0c4f707b57c2a88fc"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gaca913df5188dc0f0c4f707b57c2a88fc">ARM_USBD_EndpointUnconfigure</a> (uint8_t ep_addr)</td></tr>
<tr class="memdesc:gaca913df5188dc0f0c4f707b57c2a88fc"><td class="mdescLeft"> </td><td class="mdescRight">Unconfigure USB Endpoint. <a href="#gaca913df5188dc0f0c4f707b57c2a88fc">More...</a><br/></td></tr>
<tr class="separator:gaca913df5188dc0f0c4f707b57c2a88fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9502cd7b8e4c583920fccadc4ccf7975"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga9502cd7b8e4c583920fccadc4ccf7975">ARM_USBD_EndpointStall</a> (uint8_t ep_addr, bool stall)</td></tr>
<tr class="memdesc:ga9502cd7b8e4c583920fccadc4ccf7975"><td class="mdescLeft"> </td><td class="mdescRight">Set/Clear Stall for USB Endpoint. <a href="#ga9502cd7b8e4c583920fccadc4ccf7975">More...</a><br/></td></tr>
<tr class="separator:ga9502cd7b8e4c583920fccadc4ccf7975"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e69ad097553125bb01a22dc719e0d30"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">ARM_USBD_EndpointTransfer</a> (uint8_t ep_addr, uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:ga6e69ad097553125bb01a22dc719e0d30"><td class="mdescLeft"> </td><td class="mdescRight">Read data from or Write data to USB Endpoint. <a href="#ga6e69ad097553125bb01a22dc719e0d30">More...</a><br/></td></tr>
<tr class="separator:ga6e69ad097553125bb01a22dc719e0d30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab81fac01522a4d504edcb7b7d3abba6c"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c">ARM_USBD_EndpointTransferGetResult</a> (uint8_t ep_addr)</td></tr>
<tr class="memdesc:gab81fac01522a4d504edcb7b7d3abba6c"><td class="mdescLeft"> </td><td class="mdescRight">Get result of USB Endpoint transfer. <a href="#gab81fac01522a4d504edcb7b7d3abba6c">More...</a><br/></td></tr>
<tr class="separator:gab81fac01522a4d504edcb7b7d3abba6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7cf3bcc105dbb8cbdc915e8caca8529e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e">ARM_USBD_EndpointTransferAbort</a> (uint8_t ep_addr)</td></tr>
<tr class="memdesc:ga7cf3bcc105dbb8cbdc915e8caca8529e"><td class="mdescLeft"> </td><td class="mdescRight">Abort current USB Endpoint transfer. <a href="#ga7cf3bcc105dbb8cbdc915e8caca8529e">More...</a><br/></td></tr>
<tr class="separator:ga7cf3bcc105dbb8cbdc915e8caca8529e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4cd050b8343407fe465a27ad1cb7c264"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga4cd050b8343407fe465a27ad1cb7c264">ARM_USBD_GetFrameNumber</a> (void)</td></tr>
<tr class="memdesc:ga4cd050b8343407fe465a27ad1cb7c264"><td class="mdescLeft"> </td><td class="mdescRight">Get current USB Frame Number. <a href="#ga4cd050b8343407fe465a27ad1cb7c264">More...</a><br/></td></tr>
<tr class="separator:ga4cd050b8343407fe465a27ad1cb7c264"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe58a4db1d26b21ca5d418ee49e103a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> (uint32_t event)</td></tr>
<tr class="memdesc:gafe58a4db1d26b21ca5d418ee49e103a5"><td class="mdescLeft"> </td><td class="mdescRight">Signal USB Device Event. <a href="#gafe58a4db1d26b21ca5d418ee49e103a5">More...</a><br/></td></tr>
<tr class="separator:gafe58a4db1d26b21ca5d418ee49e103a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9aa5bc5cb45084194a77fae1457f6575"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> (uint8_t ep_addr, uint32_t ep_event)</td></tr>
<tr class="memdesc:ga9aa5bc5cb45084194a77fae1457f6575"><td class="mdescLeft"> </td><td class="mdescRight">Signal USB Endpoint Event. <a href="#ga9aa5bc5cb45084194a77fae1457f6575">More...</a><br/></td></tr>
<tr class="separator:ga9aa5bc5cb45084194a77fae1457f6575"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for USB Device Peripheral (Driver_USBD.h) </p>
<p><b>USB Device API</b></p>
<p>The header file <b><a class="el" href="Driver__USBD_8h.html">Driver_USBD.h</a></b> defines the API for the <b>USB Device Driver</b> interface used by middleware components. The driver implementation itself is a typical part of the Device Family Pack, which provides entry points to the interface as function pointers in the struct <a class="el" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a>. This structure can be available several times in each interface to control multiple USBD interfaces.</p>
<p>Header file <b><a class="el" href="Driver__USBD_8h.html">Driver_USBD.h</a></b> also defines callback routines that can be categorized as <b>device event callbacks</b> and <b>endpoint event callbacks</b>. Callbacks are called by the driver, in interrupt context when an appropriate event occurs, to signal device related events (<a class="el" href="group__USBD__dev__events.html">USBD Device Events</a>) and endpoint related events (<a class="el" href="group__USBD__ep__events.html">USBD Endpoint Events</a>).</p>
<p><b>USB Device Function Call Sequence</b></p>
<p>To use the USBD driver invoke the API functions in the following order:</p>
<div align="center">
<img src="msc_inline_mscgraph_2.png" alt="msc_inline_mscgraph_2" border="0" usemap="#msc_inline_mscgraph_2.map"/>
<map name="msc_inline_mscgraph_2.map" id="msc_inline_mscgraph_2.map"><area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="244,58,357,71" alt=""/>
<area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="187,90,414,103" alt=""/>
<area href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca" shape="rect" coords="235,122,366,135" alt=""/>
<area href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5" shape="rect" coords="154,154,447,167" alt=""/>
<area href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2" shape="rect" coords="232,186,369,199" alt=""/>
<area href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8" shape="rect" coords="223,218,378,231" alt=""/>
<area href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30" shape="rect" coords="226,269,375,282" alt=""/>
<area href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575" shape="rect" coords="217,301,384,314" alt=""/>
<area href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c" shape="rect" coords="199,333,402,346" alt=""/>
<area href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1" shape="rect" coords="226,384,375,397" alt=""/>
<area href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81" shape="rect" coords="190,416,411,429" alt=""/>
<area href="group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b" shape="rect" coords="238,448,363,461" alt=""/>
</map>
</div>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__USBD" id="structARM__DRIVER__USBD"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_USBD</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the USB Device Driver. </p>
<p>The functions of the USB Device driver 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 USBD 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_USBD0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_USBD1</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_USBD<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>
<dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
</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__usbd__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__usbd__interface__gr.html#ga1dcb8b7790f0e3613ee3da77e5fd18fc">ARM_USBD_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:a52045edf0f555a0f0ecdf37a5e169f7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a52045edf0f555a0f0ecdf37a5e169f7a">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a52045edf0f555a0f0ecdf37a5e169f7a"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d">ARM_USBD_GetCapabilities</a> : Get driver capabilities. <a href="#a52045edf0f555a0f0ecdf37a5e169f7a">More...</a><br/></td></tr>
<tr class="separator:a52045edf0f555a0f0ecdf37a5e169f7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84439aa5677d330d257a4b43e48d6426"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a84439aa5677d330d257a4b43e48d6426">Initialize</a> )(<a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a> cb_device_event, <a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a> cb_endpoint_event)</td></tr>
<tr class="memdesc:a84439aa5677d330d257a4b43e48d6426"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a> : Initialize USB Device Interface. <a href="#a84439aa5677d330d257a4b43e48d6426">More...</a><br/></td></tr>
<tr class="separator:a84439aa5677d330d257a4b43e48d6426"><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__usbd__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__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b">ARM_USBD_Uninitialize</a> : De-initialize USB Device 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__usbd__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__usbd__interface__gr.html#gaa5bdaac19f6df30c6e569abef17cdb42">ARM_USBD_PowerControl</a> : Control USB Device Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71d312ce5c5335c6a035da55c25848e4"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a71d312ce5c5335c6a035da55c25848e4">DeviceConnect</a> )(void)</td></tr>
<tr class="memdesc:a71d312ce5c5335c6a035da55c25848e4"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca">ARM_USBD_DeviceConnect</a> : Connect USB Device. <a href="#a71d312ce5c5335c6a035da55c25848e4">More...</a><br/></td></tr>
<tr class="separator:a71d312ce5c5335c6a035da55c25848e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adff9dd8a0dc764e78b0271113ae3b0af"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#adff9dd8a0dc764e78b0271113ae3b0af">DeviceDisconnect</a> )(void)</td></tr>
<tr class="memdesc:adff9dd8a0dc764e78b0271113ae3b0af"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1">ARM_USBD_DeviceDisconnect</a> : Disconnect USB Device. <a href="#adff9dd8a0dc764e78b0271113ae3b0af">More...</a><br/></td></tr>
<tr class="separator:adff9dd8a0dc764e78b0271113ae3b0af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab906727173cbe8372bdc26ef20581baa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ab906727173cbe8372bdc26ef20581baa">DeviceGetState</a> )(void)</td></tr>
<tr class="memdesc:ab906727173cbe8372bdc26ef20581baa"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2">ARM_USBD_DeviceGetState</a> : Get current USB Device State. <a href="#ab906727173cbe8372bdc26ef20581baa">More...</a><br/></td></tr>
<tr class="separator:ab906727173cbe8372bdc26ef20581baa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a649343be3fcfc44431d19f51d13e03b3"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a649343be3fcfc44431d19f51d13e03b3">DeviceRemoteWakeup</a> )(void)</td></tr>
<tr class="memdesc:a649343be3fcfc44431d19f51d13e03b3"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga7e149a4c6a0196da24a44f4fada75fb1">ARM_USBD_DeviceRemoteWakeup</a> : Trigger USB Remote Wakeup. <a href="#a649343be3fcfc44431d19f51d13e03b3">More...</a><br/></td></tr>
<tr class="separator:a649343be3fcfc44431d19f51d13e03b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e927b5593f416a8641e12016208b5d5"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a4e927b5593f416a8641e12016208b5d5">DeviceSetAddress</a> )(uint8_t dev_addr)</td></tr>
<tr class="memdesc:a4e927b5593f416a8641e12016208b5d5"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#gae66f696584e25fb2ddabe9070fa38670">ARM_USBD_DeviceSetAddress</a> : Set USB Device Address. <a href="#a4e927b5593f416a8641e12016208b5d5">More...</a><br/></td></tr>
<tr class="separator:a4e927b5593f416a8641e12016208b5d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5593bf9bb516cc7b36c6072fc55260f"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ab5593bf9bb516cc7b36c6072fc55260f">ReadSetupPacket</a> )(uint8_t *setup)</td></tr>
<tr class="memdesc:ab5593bf9bb516cc7b36c6072fc55260f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga6bc0ebf699a0f28330f21cab83f85e9e">ARM_USBD_ReadSetupPacket</a> : Read setup packet received over Control Endpoint. <a href="#ab5593bf9bb516cc7b36c6072fc55260f">More...</a><br/></td></tr>
<tr class="separator:ab5593bf9bb516cc7b36c6072fc55260f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fcafd15149d35022b05cf3c396e714e"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a9fcafd15149d35022b05cf3c396e714e">EndpointConfigure</a> )(uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size)</td></tr>
<tr class="memdesc:a9fcafd15149d35022b05cf3c396e714e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8">ARM_USBD_EndpointConfigure</a> : Configure USB Endpoint. <a href="#a9fcafd15149d35022b05cf3c396e714e">More...</a><br/></td></tr>
<tr class="separator:a9fcafd15149d35022b05cf3c396e714e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad45578fffbd046231f69aa058d29bba5"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ad45578fffbd046231f69aa058d29bba5">EndpointUnconfigure</a> )(uint8_t ep_addr)</td></tr>
<tr class="memdesc:ad45578fffbd046231f69aa058d29bba5"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#gaca913df5188dc0f0c4f707b57c2a88fc">ARM_USBD_EndpointUnconfigure</a> : Unconfigure USB Endpoint. <a href="#ad45578fffbd046231f69aa058d29bba5">More...</a><br/></td></tr>
<tr class="separator:ad45578fffbd046231f69aa058d29bba5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fbcf63ac9f962787cddc8f11a44dccb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a6fbcf63ac9f962787cddc8f11a44dccb">EndpointStall</a> )(uint8_t ep_addr, bool stall)</td></tr>
<tr class="memdesc:a6fbcf63ac9f962787cddc8f11a44dccb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9502cd7b8e4c583920fccadc4ccf7975">ARM_USBD_EndpointStall</a> : Set/Clear Stall for USB Endpoint. <a href="#a6fbcf63ac9f962787cddc8f11a44dccb">More...</a><br/></td></tr>
<tr class="separator:a6fbcf63ac9f962787cddc8f11a44dccb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cc21434bc57e696fabf0207925fe5ff"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a0cc21434bc57e696fabf0207925fe5ff">EndpointTransfer</a> )(uint8_t ep_addr, uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:a0cc21434bc57e696fabf0207925fe5ff"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">ARM_USBD_EndpointTransfer</a> : Read data from or Write data to USB Endpoint. <a href="#a0cc21434bc57e696fabf0207925fe5ff">More...</a><br/></td></tr>
<tr class="separator:a0cc21434bc57e696fabf0207925fe5ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a217e38c26bbcdecbad8c984753b2597a"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a217e38c26bbcdecbad8c984753b2597a">EndpointTransferGetResult</a> )(uint8_t ep_addr)</td></tr>
<tr class="memdesc:a217e38c26bbcdecbad8c984753b2597a"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c">ARM_USBD_EndpointTransferGetResult</a> : Get result of USB Endpoint transfer. <a href="#a217e38c26bbcdecbad8c984753b2597a">More...</a><br/></td></tr>
<tr class="separator:a217e38c26bbcdecbad8c984753b2597a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e36fd46291f71e4a748264e2f6ae431"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a4e36fd46291f71e4a748264e2f6ae431">EndpointTransferAbort</a> )(uint8_t ep_addr)</td></tr>
<tr class="memdesc:a4e36fd46291f71e4a748264e2f6ae431"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e">ARM_USBD_EndpointTransferAbort</a> : Abort current USB Endpoint transfer. <a href="#a4e36fd46291f71e4a748264e2f6ae431">More...</a><br/></td></tr>
<tr class="separator:a4e36fd46291f71e4a748264e2f6ae431"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31d1785d6d46f75241ebbf6b5a6b4919"><td class="memItemLeft" align="right" valign="top">uint16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#a31d1785d6d46f75241ebbf6b5a6b4919">GetFrameNumber</a> )(void)</td></tr>
<tr class="memdesc:a31d1785d6d46f75241ebbf6b5a6b4919"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga4cd050b8343407fe465a27ad1cb7c264">ARM_USBD_GetFrameNumber</a> : Get current USB Frame Number. <a href="#a31d1785d6d46f75241ebbf6b5a6b4919">More...</a><br/></td></tr>
<tr class="separator:a31d1785d6d46f75241ebbf6b5a6b4919"><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__usbd__interface__gr.html#ga1dcb8b7790f0e3613ee3da77e5fd18fc">ARM_USBD_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="a52045edf0f555a0f0ecdf37a5e169f7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d">ARM_USBD_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a84439aa5677d330d257a4b43e48d6426"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a> cb_device_event, <a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a> cb_endpoint_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a> : Initialize USB Device 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__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b">ARM_USBD_Uninitialize</a> : De-initialize USB Device 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__usbd__interface__gr.html#gaa5bdaac19f6df30c6e569abef17cdb42">ARM_USBD_PowerControl</a> : Control USB Device Interface Power. </p>
</div>
</div>
<a class="anchor" id="a71d312ce5c5335c6a035da55c25848e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* DeviceConnect)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca">ARM_USBD_DeviceConnect</a> : Connect USB Device. </p>
</div>
</div>
<a class="anchor" id="adff9dd8a0dc764e78b0271113ae3b0af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* DeviceDisconnect)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1">ARM_USBD_DeviceDisconnect</a> : Disconnect USB Device. </p>
</div>
</div>
<a class="anchor" id="ab906727173cbe8372bdc26ef20581baa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a>(* DeviceGetState)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2">ARM_USBD_DeviceGetState</a> : Get current USB Device State. </p>
</div>
</div>
<a class="anchor" id="a649343be3fcfc44431d19f51d13e03b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* DeviceRemoteWakeup)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga7e149a4c6a0196da24a44f4fada75fb1">ARM_USBD_DeviceRemoteWakeup</a> : Trigger USB Remote Wakeup. </p>
</div>
</div>
<a class="anchor" id="a4e927b5593f416a8641e12016208b5d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* DeviceSetAddress)(uint8_t dev_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#gae66f696584e25fb2ddabe9070fa38670">ARM_USBD_DeviceSetAddress</a> : Set USB Device Address. </p>
</div>
</div>
<a class="anchor" id="ab5593bf9bb516cc7b36c6072fc55260f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* ReadSetupPacket)(uint8_t *setup)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga6bc0ebf699a0f28330f21cab83f85e9e">ARM_USBD_ReadSetupPacket</a> : Read setup packet received over Control Endpoint. </p>
</div>
</div>
<a class="anchor" id="a9fcafd15149d35022b05cf3c396e714e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EndpointConfigure)(uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8">ARM_USBD_EndpointConfigure</a> : Configure USB Endpoint. </p>
</div>
</div>
<a class="anchor" id="ad45578fffbd046231f69aa058d29bba5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EndpointUnconfigure)(uint8_t ep_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#gaca913df5188dc0f0c4f707b57c2a88fc">ARM_USBD_EndpointUnconfigure</a> : Unconfigure USB Endpoint. </p>
</div>
</div>
<a class="anchor" id="a6fbcf63ac9f962787cddc8f11a44dccb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EndpointStall)(uint8_t ep_addr, bool stall)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9502cd7b8e4c583920fccadc4ccf7975">ARM_USBD_EndpointStall</a> : Set/Clear Stall for USB Endpoint. </p>
</div>
</div>
<a class="anchor" id="a0cc21434bc57e696fabf0207925fe5ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EndpointTransfer)(uint8_t ep_addr, uint8_t *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">ARM_USBD_EndpointTransfer</a> : Read data from or Write data to USB Endpoint. </p>
</div>
</div>
<a class="anchor" id="a217e38c26bbcdecbad8c984753b2597a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* EndpointTransferGetResult)(uint8_t ep_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c">ARM_USBD_EndpointTransferGetResult</a> : Get result of USB Endpoint transfer. </p>
</div>
</div>
<a class="anchor" id="a4e36fd46291f71e4a748264e2f6ae431"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EndpointTransferAbort)(uint8_t ep_addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e">ARM_USBD_EndpointTransferAbort</a> : Abort current USB Endpoint transfer. </p>
</div>
</div>
<a class="anchor" id="a31d1785d6d46f75241ebbf6b5a6b4919"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t(* GetFrameNumber)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga4cd050b8343407fe465a27ad1cb7c264">ARM_USBD_GetFrameNumber</a> : Get current USB Frame Number. </p>
</div>
</div>
</div>
</div>
<a name="structARM__USBD__CAPABILITIES" id="structARM__USBD__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USBD_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USB Device Driver Capabilities. </p>
<p>A USB Device driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d">ARM_USBD_GetCapabilities</a></li>
</ul>
<dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a6673fc1aa13f62122ecf51e52a605c6e"></a>uint32_t</td>
<td class="fieldname">
vbus_detection: 1</td>
<td class="fielddoc">
VBUS detection. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a53f95b9ecb7c84197947e7542501c7d3"></a>uint32_t</td>
<td class="fieldname">
event_vbus_on: 1</td>
<td class="fielddoc">
Signal VBUS On event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a72d905bc20735bafda40d73c91829709"></a>uint32_t</td>
<td class="fieldname">
event_vbus_off: 1</td>
<td class="fielddoc">
Signal VBUS Off event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 29</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__USBD__STATE" id="structARM__USBD__STATE"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USBD_STATE</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USB Device State. </p>
<p>This structure stores information about the state of the USB Device. The data fields encode the established speed, whether the device is powered and active.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2">ARM_USBD_DeviceGetState</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa961d5fb2bd3d2960578f1ac3b903070"></a>uint32_t</td>
<td class="fieldname">
vbus: 1</td>
<td class="fielddoc">
USB Device VBUS flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a220859a8b5da0232739a11cbe7f79fc5"></a>uint32_t</td>
<td class="fieldname">
speed: 2</td>
<td class="fielddoc">
USB Device speed setting (ARM_USB_SPEED_xxx) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab22b96a3efad48f5a542f46c1b224800"></a>uint32_t</td>
<td class="fieldname">
active: 1</td>
<td class="fielddoc">
USB Device active flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 28</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga7c1878799699ddd34cec696da499f7bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_USBD_SignalDeviceEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> : Signal USB Device Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="gaae754763700fc5059a6bde57ea2d4e2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_USBD_SignalEndpointEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> : Signal USB Endpoint Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga1dcb8b7790f0e3613ee3da77e5fd18fc"></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_USBD_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_USBD_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__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a> Driver_USBD0;</div>
<div class="line"><a class="code" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_usbd (<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_USBD0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__usbd__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="ga178d01ab7896e1c675b90bbccfe8ea7d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a> ARM_USBD_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__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_USBD_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a> encode various capabilities, for example if the hardware can create signal events using the <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> callback function.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a> Driver_USBD0;</div>
<div class="line"><a class="code" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</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__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_USBD0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__usbd__interface__gr.html#a52045edf0f555a0f0ecdf37a5e169f7a">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="ga60b95c9c0c6767ff5938464cfd748f81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a> </td>
<td class="paramname"><em>cb_device_event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a> </td>
<td class="paramname"><em>cb_endpoint_event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize USB Device Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_device_event</td><td>Pointer to <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb_endpoint_event</td><td>Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</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_USBD_Initialize</b> initializes the USB Device interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the USBD interface.</li>
<li>Registers the <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> callback function.</li>
<li>Registers the <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_device_event</em> is a pointer to the <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> callback function; use a NULL pointer when no device callback signals are required. <br/>
The parameter <em>cb_endpoint_event</em> is a pointer to the <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> callback function.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gafaead6713f141be1734de0110eda966b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_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 USB Device 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_USBD_Uninitialize</b> de-initializes the resources of USBD 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="gaa5bdaac19f6df30c6e569abef17cdb42"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_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 USB Device 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 </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_USBD_PowerControl</b> operates the power modes of the USB Device 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>
</div>
</div>
<a class="anchor" id="ga99207f7ff5e97a7f65754eab7f775fca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_DeviceConnect </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect USB 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_USBD_DeviceConnect</b> signals to the host that the device is connected. </p>
</div>
</div>
<a class="anchor" id="ga37234abecbb63e4e739f9676e489d2d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_DeviceDisconnect </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnect USB 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_USBD_DeviceDisconnect</b> signals to the host that the device is disconnected. </p>
</div>
</div>
<a class="anchor" id="ga7624d6b2cbe5e6ab5016206ce641eee2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a> ARM_USBD_DeviceGetState </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current USB Device State. </p>
<dl class="section return"><dt>Returns</dt><dd>Device State <a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a></dd></dl>
<p>Retrieves the current USB device state. </p>
</div>
</div>
<a class="anchor" id="ga7e149a4c6a0196da24a44f4fada75fb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_DeviceRemoteWakeup </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Trigger USB Remote Wakeup. </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_USBD_DeviceRemoteWakeup</b> signals remote wakeup to the host. </p>
</div>
</div>
<a class="anchor" id="gae66f696584e25fb2ddabe9070fa38670"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_DeviceSetAddress </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>dev_addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set USB Device Address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Device 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>Assigns an address to the device. </p>
</div>
</div>
<a class="anchor" id="ga6bc0ebf699a0f28330f21cab83f85e9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_ReadSetupPacket </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>setup</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read setup packet received over Control Endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">setup</td><td>Pointer to buffer for setup packet </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_USBD_ReadSetupPacket</b> reads the last SETUP packet (8 bytes) that was received over Control Endpoint (Endpoint 0) which is indicated by <a class="el" href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">ARM_USBD_EVENT_SETUP</a> event.</p>
<p><b>See also:</b></p>
<ul>
<li><a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga62d7d5bdcf9ca7bf7e6d8434368abad8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_EndpointConfigure </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>ep_max_packet_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure USB Endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_type</td><td>Endpoint Type (ARM_USB_ENDPOINT_xxx) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_max_packet_size</td><td>Endpoint Maximum Packet Size </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_USBD_EndpointConfigure</b> configures an endpoint for transfers. </p>
</div>
</div>
<a class="anchor" id="gaca913df5188dc0f0c4f707b57c2a88fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_EndpointUnconfigure </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unconfigure USB Endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </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_USBD_EndpointUnconfigure</b> de-configures the specified endpoint.</p>
<p>The parameter <em>ep_addr</em> specifies the endpoint address. </p>
</div>
</div>
<a class="anchor" id="ga9502cd7b8e4c583920fccadc4ccf7975"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_EndpointStall </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>stall</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Clear Stall for USB Endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">stall</td><td>Operation<ul>
<li><b>false</b> Clear</li>
<li><b>true</b> Set </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_USBD_EndpointStall</b> sets or clears stall condition for the specified endpoint.</p>
<p>The parameter <em>ep_addr</em> specifies the endpoint address. <br/>
The parameter <em>stall</em> is a boolean parameter. </p>
</div>
</div>
<a class="anchor" id="ga6e69ad097553125bb01a22dc719e0d30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_EndpointTransfer </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</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">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from or Write data to USB Endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </li>
</ul>
</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to read or with data to write </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to transfer </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_USBD_EndpointTransfer</b> reads from or writes data to an USB Endpoint.</p>
<p>The parameter <em>ep_addr</em> specifies the endpoint address. <br/>
The parameter <em>data</em> is a buffer for data to read or data to write. <br/>
The parameter <em>num</em> is the number of bytes to transfer (must be multiple of endpoint maximum packet size for Read transfers).</p>
<p>The function is non-blocking and returns as soon as the driver starts the operation on the specified endpoint. During the operation it is not allowed to call this function again on the same endpoint. Also the data buffer must stay allocated and the contents of data must not be modified.</p>
<p>Direction in the endpoint address specifies the type of transfer:</p>
<ul>
<li>Endpoint Read for OUT endpoint (direction = 0)</li>
<li>Endpoint Write for IN endpoint (direction = 1)</li>
</ul>
<p>Endpoint Read is finished when the requested number of data bytes have been received or when a short packet or ZLP (Zero-Length Packet) has been received. Completion of operation is indicated by <a class="el" href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">ARM_USBD_EVENT_OUT</a> event. Number of successfully received data bytes can be retrieved by calling <a class="el" href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c">ARM_USBD_EndpointTransferGetResult</a>.</p>
<p>Endpoint Write is finished when the requested number of data bytes have been sent. Completion of operation is indicated by <a class="el" href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">ARM_USBD_EVENT_IN</a> event. Number of successfully sent data bytes can be retrieved by calling <a class="el" href="group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c">ARM_USBD_EndpointTransferGetResult</a>.</p>
<p>Transfer operation can be aborted by calling <a class="el" href="group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e">ARM_USBD_EndpointTransferAbort</a>. </p>
</div>
</div>
<a class="anchor" id="gab81fac01522a4d504edcb7b7d3abba6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_USBD_EndpointTransferGetResult </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get result of USB Endpoint transfer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of successfully transferred data bytes</dd></dl>
<p>The function <b>ARM_USBD_EndpointTransferGetResult</b> returns the number of successfully transferred data bytes started by <a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">ARM_USBD_EndpointTransfer</a>.</p>
<p>The parameter <em>ep_addr</em> specifies the endpoint address. </p>
</div>
</div>
<a class="anchor" id="ga7cf3bcc105dbb8cbdc915e8caca8529e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBD_EndpointTransferAbort </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort current USB Endpoint transfer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </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_USBD_EndpointTransferAbort</b> aborts the transfer to an endpoint started by <a class="el" href="group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30">ARM_USBD_EndpointTransfer</a>.</p>
<p>The parameter <em>ep_addr</em> specifies the endpoint address. </p>
</div>
</div>
<a class="anchor" id="ga4cd050b8343407fe465a27ad1cb7c264"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t ARM_USBD_GetFrameNumber </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current USB Frame Number. </p>
<dl class="section return"><dt>Returns</dt><dd>Frame Number</dd></dl>
<p>Retrieves the sequential 11-bit frame number of the last Start of Frame (SOF) packet. </p>
</div>
</div>
<a class="anchor" id="gafe58a4db1d26b21ca5d418ee49e103a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_USBD_SignalDeviceEvent </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 USB Device 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__USBD__dev__events.html">USBD Device Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_USBD_SignalDeviceEvent</b> is a callback function registered by the function <a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a>.</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__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d">ARM_USBD_GetCapabilities</a>.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Event </th><th align="right">Bit</th><th align="left">Description </th><th>supported when <a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a> </th></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045">ARM_USBD_EVENT_VBUS_ON</a> </td><td align="right">0 </td><td align="left">Occurs when valid VBUS voltage is detected. </td><td>data field <em>event_vbus_on</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec">ARM_USBD_EVENT_VBUS_OFF</a> </td><td align="right">1 </td><td align="left">Occurs when VBUS voltage is turned off. </td><td>data field <em>event_vbus_off</em> = <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a">ARM_USBD_EVENT_RESET</a> </td><td align="right">2 </td><td align="left">Occurs when USB Reset is detected. </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843">ARM_USBD_EVENT_HIGH_SPEED</a> </td><td align="right">3 </td><td align="left">Occurs when USB Device is switched to High-speed. </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653">ARM_USBD_EVENT_SUSPEND</a> </td><td align="right">4 </td><td align="left">Occurs when USB Suspend is detected. </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45">ARM_USBD_EVENT_RESUME</a> </td><td align="right">5 </td><td align="left">Occurs when USB Resume is detected. </td><td><em>always supported</em> </td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga9aa5bc5cb45084194a77fae1457f6575"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_USBD_SignalEndpointEvent </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</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 USB Endpoint Event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__USBD__ep__events.html">USBD Endpoint Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_USBD_SignalEndpointEvent</b> is a callback function registered by the function <a class="el" href="group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81">ARM_USBD_Initialize</a>.</p>
<p>The argument <em>ep_addr</em> specifies the endpoint. <br/>
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>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Event </th><th align="right">Bit </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">ARM_USBD_EVENT_SETUP</a> </td><td align="right">0 </td><td align="left">Occurs when SETUP packet is received over Control Endpoint. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">ARM_USBD_EVENT_OUT</a> </td><td align="right">1 </td><td align="left">Occurs when data is received over OUT Endpoint. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">ARM_USBD_EVENT_IN</a> </td><td align="right">2 </td><td align="left">Occurs when data is sent over IN Endpoint. </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: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__interface__gr.html | HTML | apache-2.0 | 90,953 |
var group__usbd__interface__gr =
[
[ "USBD Device Events", "group__USBD__dev__events.html", "group__USBD__dev__events" ],
[ "USBD Endpoint Events", "group__USBD__ep__events.html", "group__USBD__ep__events" ],
[ "ARM_DRIVER_USBD", "group__usbd__interface__gr.html#structARM__DRIVER__USBD", [
[ "GetVersion", "group__usbd__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usbd__interface__gr.html#a52045edf0f555a0f0ecdf37a5e169f7a", null ],
[ "Initialize", "group__usbd__interface__gr.html#a84439aa5677d330d257a4b43e48d6426", null ],
[ "Uninitialize", "group__usbd__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usbd__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "DeviceConnect", "group__usbd__interface__gr.html#a71d312ce5c5335c6a035da55c25848e4", null ],
[ "DeviceDisconnect", "group__usbd__interface__gr.html#adff9dd8a0dc764e78b0271113ae3b0af", null ],
[ "DeviceGetState", "group__usbd__interface__gr.html#ab906727173cbe8372bdc26ef20581baa", null ],
[ "DeviceRemoteWakeup", "group__usbd__interface__gr.html#a649343be3fcfc44431d19f51d13e03b3", null ],
[ "DeviceSetAddress", "group__usbd__interface__gr.html#a4e927b5593f416a8641e12016208b5d5", null ],
[ "ReadSetupPacket", "group__usbd__interface__gr.html#ab5593bf9bb516cc7b36c6072fc55260f", null ],
[ "EndpointConfigure", "group__usbd__interface__gr.html#a9fcafd15149d35022b05cf3c396e714e", null ],
[ "EndpointUnconfigure", "group__usbd__interface__gr.html#ad45578fffbd046231f69aa058d29bba5", null ],
[ "EndpointStall", "group__usbd__interface__gr.html#a6fbcf63ac9f962787cddc8f11a44dccb", null ],
[ "EndpointTransfer", "group__usbd__interface__gr.html#a0cc21434bc57e696fabf0207925fe5ff", null ],
[ "EndpointTransferGetResult", "group__usbd__interface__gr.html#a217e38c26bbcdecbad8c984753b2597a", null ],
[ "EndpointTransferAbort", "group__usbd__interface__gr.html#a4e36fd46291f71e4a748264e2f6ae431", null ],
[ "GetFrameNumber", "group__usbd__interface__gr.html#a31d1785d6d46f75241ebbf6b5a6b4919", null ]
] ],
[ "ARM_USBD_CAPABILITIES", "group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES", [
[ "vbus_detection", "group__usbd__interface__gr.html#a6673fc1aa13f62122ecf51e52a605c6e", null ],
[ "event_vbus_on", "group__usbd__interface__gr.html#a53f95b9ecb7c84197947e7542501c7d3", null ],
[ "event_vbus_off", "group__usbd__interface__gr.html#a72d905bc20735bafda40d73c91829709", null ],
[ "reserved", "group__usbd__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USBD_STATE", "group__usbd__interface__gr.html#structARM__USBD__STATE", [
[ "vbus", "group__usbd__interface__gr.html#aa961d5fb2bd3d2960578f1ac3b903070", null ],
[ "speed", "group__usbd__interface__gr.html#a220859a8b5da0232739a11cbe7f79fc5", null ],
[ "active", "group__usbd__interface__gr.html#ab22b96a3efad48f5a542f46c1b224800", null ],
[ "reserved", "group__usbd__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USBD_SignalDeviceEvent_t", "group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd", null ],
[ "ARM_USBD_SignalEndpointEvent_t", "group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c", null ],
[ "ARM_USBD_GetVersion", "group__usbd__interface__gr.html#ga1dcb8b7790f0e3613ee3da77e5fd18fc", null ],
[ "ARM_USBD_GetCapabilities", "group__usbd__interface__gr.html#ga178d01ab7896e1c675b90bbccfe8ea7d", null ],
[ "ARM_USBD_Initialize", "group__usbd__interface__gr.html#ga60b95c9c0c6767ff5938464cfd748f81", null ],
[ "ARM_USBD_Uninitialize", "group__usbd__interface__gr.html#gafaead6713f141be1734de0110eda966b", null ],
[ "ARM_USBD_PowerControl", "group__usbd__interface__gr.html#gaa5bdaac19f6df30c6e569abef17cdb42", null ],
[ "ARM_USBD_DeviceConnect", "group__usbd__interface__gr.html#ga99207f7ff5e97a7f65754eab7f775fca", null ],
[ "ARM_USBD_DeviceDisconnect", "group__usbd__interface__gr.html#ga37234abecbb63e4e739f9676e489d2d1", null ],
[ "ARM_USBD_DeviceGetState", "group__usbd__interface__gr.html#ga7624d6b2cbe5e6ab5016206ce641eee2", null ],
[ "ARM_USBD_DeviceRemoteWakeup", "group__usbd__interface__gr.html#ga7e149a4c6a0196da24a44f4fada75fb1", null ],
[ "ARM_USBD_DeviceSetAddress", "group__usbd__interface__gr.html#gae66f696584e25fb2ddabe9070fa38670", null ],
[ "ARM_USBD_ReadSetupPacket", "group__usbd__interface__gr.html#ga6bc0ebf699a0f28330f21cab83f85e9e", null ],
[ "ARM_USBD_EndpointConfigure", "group__usbd__interface__gr.html#ga62d7d5bdcf9ca7bf7e6d8434368abad8", null ],
[ "ARM_USBD_EndpointUnconfigure", "group__usbd__interface__gr.html#gaca913df5188dc0f0c4f707b57c2a88fc", null ],
[ "ARM_USBD_EndpointStall", "group__usbd__interface__gr.html#ga9502cd7b8e4c583920fccadc4ccf7975", null ],
[ "ARM_USBD_EndpointTransfer", "group__usbd__interface__gr.html#ga6e69ad097553125bb01a22dc719e0d30", null ],
[ "ARM_USBD_EndpointTransferGetResult", "group__usbd__interface__gr.html#gab81fac01522a4d504edcb7b7d3abba6c", null ],
[ "ARM_USBD_EndpointTransferAbort", "group__usbd__interface__gr.html#ga7cf3bcc105dbb8cbdc915e8caca8529e", null ],
[ "ARM_USBD_GetFrameNumber", "group__usbd__interface__gr.html#ga4cd050b8343407fe465a27ad1cb7c264", null ],
[ "ARM_USBD_SignalDeviceEvent", "group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5", null ],
[ "ARM_USBD_SignalEndpointEvent", "group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbd__interface__gr.js | JavaScript | apache-2.0 | 5,658 |
var group__usbd__interface__gr_structARM__DRIVER__USBD =
[
[ "GetVersion", "group__usbd__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usbd__interface__gr.html#a52045edf0f555a0f0ecdf37a5e169f7a", null ],
[ "Initialize", "group__usbd__interface__gr.html#a84439aa5677d330d257a4b43e48d6426", null ],
[ "Uninitialize", "group__usbd__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usbd__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "DeviceConnect", "group__usbd__interface__gr.html#a71d312ce5c5335c6a035da55c25848e4", null ],
[ "DeviceDisconnect", "group__usbd__interface__gr.html#adff9dd8a0dc764e78b0271113ae3b0af", null ],
[ "DeviceGetState", "group__usbd__interface__gr.html#ab906727173cbe8372bdc26ef20581baa", null ],
[ "DeviceRemoteWakeup", "group__usbd__interface__gr.html#a649343be3fcfc44431d19f51d13e03b3", null ],
[ "DeviceSetAddress", "group__usbd__interface__gr.html#a4e927b5593f416a8641e12016208b5d5", null ],
[ "ReadSetupPacket", "group__usbd__interface__gr.html#ab5593bf9bb516cc7b36c6072fc55260f", null ],
[ "EndpointConfigure", "group__usbd__interface__gr.html#a9fcafd15149d35022b05cf3c396e714e", null ],
[ "EndpointUnconfigure", "group__usbd__interface__gr.html#ad45578fffbd046231f69aa058d29bba5", null ],
[ "EndpointStall", "group__usbd__interface__gr.html#a6fbcf63ac9f962787cddc8f11a44dccb", null ],
[ "EndpointTransfer", "group__usbd__interface__gr.html#a0cc21434bc57e696fabf0207925fe5ff", null ],
[ "EndpointTransferGetResult", "group__usbd__interface__gr.html#a217e38c26bbcdecbad8c984753b2597a", null ],
[ "EndpointTransferAbort", "group__usbd__interface__gr.html#a4e36fd46291f71e4a748264e2f6ae431", null ],
[ "GetFrameNumber", "group__usbd__interface__gr.html#a31d1785d6d46f75241ebbf6b5a6b4919", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbd__interface__gr_structARM__DRIVER__USBD.js | JavaScript | apache-2.0 | 1,902 |
var group__usbd__interface__gr_structARM__USBD__CAPABILITIES =
[
[ "vbus_detection", "group__usbd__interface__gr.html#a6673fc1aa13f62122ecf51e52a605c6e", null ],
[ "event_vbus_on", "group__usbd__interface__gr.html#a53f95b9ecb7c84197947e7542501c7d3", null ],
[ "event_vbus_off", "group__usbd__interface__gr.html#a72d905bc20735bafda40d73c91829709", null ],
[ "reserved", "group__usbd__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbd__interface__gr_structARM__USBD__CAPABILITIES.js | JavaScript | apache-2.0 | 463 |
var group__usbd__interface__gr_structARM__USBD__STATE =
[
[ "vbus", "group__usbd__interface__gr.html#aa961d5fb2bd3d2960578f1ac3b903070", null ],
[ "speed", "group__usbd__interface__gr.html#a220859a8b5da0232739a11cbe7f79fc5", null ],
[ "active", "group__usbd__interface__gr.html#ab22b96a3efad48f5a542f46c1b224800", null ],
[ "reserved", "group__usbd__interface__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbd__interface__gr_structARM__USBD__STATE.js | JavaScript | apache-2.0 | 430 |
<!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 OHCI/EHCI</title>
<title>CMSIS-Driver: USB OHCI/EHCI</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__hci__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="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">USB OHCI/EHCI<div class="ingroups"><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for USB OHCI/EHCI.
<a href="#details">More...</a></p>
<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__USBH__HCI"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a></td></tr>
<tr class="memdesc:structARM__DRIVER__USBH__HCI"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of USB Host HCI (OHCI/EHCI) Driver. <a href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__USBH__HCI"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USBH__HCI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__USBH__HCI__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">USB Host HCI (OHCI/EHCI) Driver Capabilities. <a href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__USBH__HCI__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:gac60df9d1f2b3a769f2c30141800a9806"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> )(void)</td></tr>
<tr class="memdesc:gac60df9d1f2b3a769f2c30141800a9806"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to Interrupt Handler Routine. <a href="#gac60df9d1f2b3a769f2c30141800a9806">More...</a><br/></td></tr>
<tr class="separator:gac60df9d1f2b3a769f2c30141800a9806"><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:ga10109d0c2a9a128225b5e893d3f72d08"><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__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">ARM_USBH_HCI_GetVersion</a> (void)</td></tr>
<tr class="memdesc:ga10109d0c2a9a128225b5e893d3f72d08"><td class="mdescLeft"> </td><td class="mdescRight">Get USB Host HCI (OHCI/EHCI) driver version. <a href="#ga10109d0c2a9a128225b5e893d3f72d08">More...</a><br/></td></tr>
<tr class="separator:ga10109d0c2a9a128225b5e893d3f72d08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae607c49ca97202500631473a901e8c2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:gae607c49ca97202500631473a901e8c2b"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#gae607c49ca97202500631473a901e8c2b">More...</a><br/></td></tr>
<tr class="separator:gae607c49ca97202500631473a901e8c2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc1392a544cb64491b5ea5ce6590d832"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> (<a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> *cb_interrupt)</td></tr>
<tr class="memdesc:gabc1392a544cb64491b5ea5ce6590d832"><td class="mdescLeft"> </td><td class="mdescRight">Initialize USB Host HCI (OHCI/EHCI) Interface. <a href="#gabc1392a544cb64491b5ea5ce6590d832">More...</a><br/></td></tr>
<tr class="separator:gabc1392a544cb64491b5ea5ce6590d832"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaacb68fdf201cdb1846b31642a760f041"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gaacb68fdf201cdb1846b31642a760f041"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize USB Host HCI (OHCI/EHCI) Interface. <a href="#gaacb68fdf201cdb1846b31642a760f041">More...</a><br/></td></tr>
<tr class="separator:gaacb68fdf201cdb1846b31642a760f041"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga27fa5ec8854cd9877bbef4abffe9a12b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga27fa5ec8854cd9877bbef4abffe9a12b"><td class="mdescLeft"> </td><td class="mdescRight">Control USB Host HCI (OHCI/EHCI) Interface Power. <a href="#ga27fa5ec8854cd9877bbef4abffe9a12b">More...</a><br/></td></tr>
<tr class="separator:ga27fa5ec8854cd9877bbef4abffe9a12b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade1e83403c6ea965fe3e6c4c21fbbded"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff</a> (uint8_t port, bool vbus)</td></tr>
<tr class="memdesc:gade1e83403c6ea965fe3e6c4c21fbbded"><td class="mdescLeft"> </td><td class="mdescRight">USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. <a href="#gade1e83403c6ea965fe3e6c4c21fbbded">More...</a><br/></td></tr>
<tr class="separator:gade1e83403c6ea965fe3e6c4c21fbbded"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79d3c2509ed869c8d7d1485acad7b6c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">ARM_USBH_HCI_Interrupt</a> (void)</td></tr>
<tr class="memdesc:ga79d3c2509ed869c8d7d1485acad7b6c6"><td class="mdescLeft"> </td><td class="mdescRight">USB Host HCI Interrupt Handler. <a href="#ga79d3c2509ed869c8d7d1485acad7b6c6">More...</a><br/></td></tr>
<tr class="separator:ga79d3c2509ed869c8d7d1485acad7b6c6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for USB OHCI/EHCI. </p>
<p>OHCI and EHCI compliant interfaces have memory mapped registers that are used to control the USB host.</p>
<p>Only certain functionalities (interrupts, VBUS control, power control) require device specific interface which is provided through functions of the struct <a class="el" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a> (functionality accessed with the struct <a class="el" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> is not needed). </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__USBH__HCI" id="structARM__DRIVER__USBH__HCI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_USBH_HCI</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of USB Host HCI (OHCI/EHCI) Driver. </p>
<p>The functions of the USB Host HCI (OHCI/EHCI) driver 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 USBH 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_USBH0_HCI</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_USBH1_HCI</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_USBH<em>n</em>_HCI</b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver.</p>
<dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
</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__usbh__hci__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__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">ARM_USBH_HCI_GetVersion</a> : Get USB Host HCI (OHCI/EHCI) driver version. <a href="#a8834b281da48583845c044a81566c1b3">More...</a><br/></td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a41769405bb3bb4cc9eaba26cf220d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#a7a41769405bb3bb4cc9eaba26cf220d4">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:a7a41769405bb3bb4cc9eaba26cf220d4"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a> : Get driver capabilities. <a href="#a7a41769405bb3bb4cc9eaba26cf220d4">More...</a><br/></td></tr>
<tr class="separator:a7a41769405bb3bb4cc9eaba26cf220d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40cbaad9fd2458b1008d31e1469903bb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#a40cbaad9fd2458b1008d31e1469903bb">Initialize</a> )(<a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> cb_interrupt)</td></tr>
<tr class="memdesc:a40cbaad9fd2458b1008d31e1469903bb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> : Initialize USB Host HCI (OHCI/EHCI) Interface. <a href="#a40cbaad9fd2458b1008d31e1469903bb">More...</a><br/></td></tr>
<tr class="separator:a40cbaad9fd2458b1008d31e1469903bb"><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__usbh__hci__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__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> : De-initialize USB Host HCI (OHCI/EHCI) 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__usbh__hci__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__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl</a> : Control USB Host HCI (OHCI/EHCI) Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab859fb9f73a60ffa1ce71ed961d4744f"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#ab859fb9f73a60ffa1ce71ed961d4744f">PortVbusOnOff</a> )(uint8_t port, bool vbus)</td></tr>
<tr class="memdesc:ab859fb9f73a60ffa1ce71ed961d4744f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff</a> : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. <a href="#ab859fb9f73a60ffa1ce71ed961d4744f">More...</a><br/></td></tr>
<tr class="separator:ab859fb9f73a60ffa1ce71ed961d4744f"><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__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">ARM_USBH_HCI_GetVersion</a> : Get USB Host HCI (OHCI/EHCI) driver version. </p>
</div>
</div>
<a class="anchor" id="a7a41769405bb3bb4cc9eaba26cf220d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a40cbaad9fd2458b1008d31e1469903bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> cb_interrupt)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> : Initialize USB Host HCI (OHCI/EHCI) 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__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> : De-initialize USB Host HCI (OHCI/EHCI) 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__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl</a> : Control USB Host HCI (OHCI/EHCI) Interface Power. </p>
</div>
</div>
<a class="anchor" id="ab859fb9f73a60ffa1ce71ed961d4744f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PortVbusOnOff)(uint8_t port, bool vbus)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff</a> : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. </p>
</div>
</div>
</div>
</div>
<a name="structARM__USBH__HCI__CAPABILITIES" id="structARM__USBH__HCI__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USBH_HCI_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USB Host HCI (OHCI/EHCI) Driver Capabilities. </p>
<p>A USB Host HCI (OHCI/EHCI) driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a></li>
</ul>
<dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac37c09b54483c2a1e41fa8a976721fc4"></a>uint32_t</td>
<td class="fieldname">
port_mask: 15</td>
<td class="fielddoc">
Root HUB available Ports Mask. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 17</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gac60df9d1f2b3a769f2c30141800a9806"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_USBH_HCI_Interrupt_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to Interrupt Handler Routine. </p>
<p>Provides the typedef for the interrupt handler <a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">ARM_USBH_HCI_Interrupt</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga10109d0c2a9a128225b5e893d3f72d08"></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_USBH_HCI_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 USB Host HCI (OHCI/EHCI) 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_USBH_HCI_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__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> Driver_USBH0_HCI;</div>
<div class="line"><a class="code" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_usbh (<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_USBH0_HCI; </div>
<div class="line"> version = drv_info-><a class="code" href="group__usbh__host__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="gae607c49ca97202500631473a901e8c2b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> ARM_USBH_HCI_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__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_USBH_HCI_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> encode various capabilities, for example available HUB ports.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a> Driver_USBH0_HCI;</div>
<div class="line"><a class="code" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</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__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_USBH0_HCI; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__usbh__hci__gr.html#a7a41769405bb3bb4cc9eaba26cf220d4">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="gabc1392a544cb64491b5ea5ce6590d832"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_HCI_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> * </td>
<td class="paramname"><em>cb_interrupt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize USB Host HCI (OHCI/EHCI) Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_interrupt</td><td>Pointer to Interrupt Handler Routine </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_USBH_HCI_Initialize</b> initializes the USB Host HCI (OHCI/EHCI) interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the USBH interface.</li>
<li>Registers the <a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">ARM_USBH_HCI_Interrupt</a> interrupt handler.</li>
</ul>
<p>The parameter <em>cb_interrupt</em> is a pointer to the interrupt routine of the OHCI/EHCI peripheral that needs to be registered. This function is called as ECHI Interrupt Service Handler.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gaacb68fdf201cdb1846b31642a760f041"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_HCI_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 USB Host HCI (OHCI/EHCI) 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 <a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> de-initializes the resources of USB Host HCI (OHCI/EHCI) 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="ga27fa5ec8854cd9877bbef4abffe9a12b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_HCI_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 USB Host HCI (OHCI/EHCI) 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 </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_USBH_HCI_PowerControl</b> operates the power modes of the USB Host HCI (OHCI/EHCI) 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>
</div>
</div>
<a class="anchor" id="gade1e83403c6ea965fe3e6c4c21fbbded"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_HCI_PortVbusOnOff </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>vbus</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">vbus</td><td><ul>
<li><b>false</b> VBUS off</li>
<li><b>true</b> VBUS on </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_USBH_HCI_PortVbusOnOff</b> controls the VBUS signal of the specified port. Most HCI complained USB Host controllers do not require this optional function. It is only required when a external VBUS interface (for example via I/O pin) is required. </p>
</div>
</div>
<a class="anchor" id="ga79d3c2509ed869c8d7d1485acad7b6c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_USBH_HCI_Interrupt </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Host HCI Interrupt Handler. </p>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_USBH_HCI_Interrupt</b> is called from the USBH HCI Interrupt Handler. </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__hci__gr.html | HTML | apache-2.0 | 37,862 |
var group__usbh__hci__gr =
[
[ "ARM_DRIVER_USBH_HCI", "group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI", [
[ "GetVersion", "group__usbh__hci__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usbh__hci__gr.html#a7a41769405bb3bb4cc9eaba26cf220d4", null ],
[ "Initialize", "group__usbh__hci__gr.html#a40cbaad9fd2458b1008d31e1469903bb", null ],
[ "Uninitialize", "group__usbh__hci__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usbh__hci__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "PortVbusOnOff", "group__usbh__hci__gr.html#ab859fb9f73a60ffa1ce71ed961d4744f", null ]
] ],
[ "ARM_USBH_HCI_CAPABILITIES", "group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES", [
[ "port_mask", "group__usbh__hci__gr.html#ac37c09b54483c2a1e41fa8a976721fc4", null ],
[ "reserved", "group__usbh__hci__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USBH_HCI_Interrupt_t", "group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806", null ],
[ "ARM_USBH_HCI_GetVersion", "group__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08", null ],
[ "ARM_USBH_HCI_GetCapabilities", "group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b", null ],
[ "ARM_USBH_HCI_Initialize", "group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832", null ],
[ "ARM_USBH_HCI_Uninitialize", "group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041", null ],
[ "ARM_USBH_HCI_PowerControl", "group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b", null ],
[ "ARM_USBH_HCI_PortVbusOnOff", "group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded", null ],
[ "ARM_USBH_HCI_Interrupt", "group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__hci__gr.js | JavaScript | apache-2.0 | 1,841 |
var group__usbh__hci__gr_structARM__DRIVER__USBH__HCI =
[
[ "GetVersion", "group__usbh__hci__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usbh__hci__gr.html#a7a41769405bb3bb4cc9eaba26cf220d4", null ],
[ "Initialize", "group__usbh__hci__gr.html#a40cbaad9fd2458b1008d31e1469903bb", null ],
[ "Uninitialize", "group__usbh__hci__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usbh__hci__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "PortVbusOnOff", "group__usbh__hci__gr.html#ab859fb9f73a60ffa1ce71ed961d4744f", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__hci__gr_structARM__DRIVER__USBH__HCI.js | JavaScript | apache-2.0 | 617 |
var group__usbh__hci__gr_structARM__USBH__HCI__CAPABILITIES =
[
[ "port_mask", "group__usbh__hci__gr.html#ac37c09b54483c2a1e41fa8a976721fc4", null ],
[ "reserved", "group__usbh__hci__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__hci__gr_structARM__USBH__HCI__CAPABILITIES.js | JavaScript | apache-2.0 | 244 |
<!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 Host</title>
<title>CMSIS-Driver: USB Host</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__host__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">USB Host<div class="ingroups"><a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for USB Host.
<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__USBH__port__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html">USBH Port Events</a></td></tr>
<tr class="memdesc:group__USBH__port__events"><td class="mdescLeft"> </td><td class="mdescRight">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>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USBH__pipe__events"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html">USBH Pipe Events</a></td></tr>
<tr class="memdesc:group__USBH__pipe__events"><td class="mdescLeft"> </td><td class="mdescRight">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>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__USBH__packets"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html">USBH Packet Information</a></td></tr>
<tr class="memdesc:group__USBH__packets"><td class="mdescLeft"> </td><td class="mdescRight">Specify USB packet information used by the function <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>. <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__USBH"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a></td></tr>
<tr class="memdesc:structARM__DRIVER__USBH"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of USB Host Driver. <a href="group__usbh__host__gr.html#structARM__DRIVER__USBH">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__USBH"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USBH__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__USBH__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">USB Host Driver Capabilities. <a href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__USBH__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__USBH__PORT__STATE"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a></td></tr>
<tr class="memdesc:structARM__USBH__PORT__STATE"><td class="mdescLeft"> </td><td class="mdescRight">USB Host Port State. <a href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">More...</a><br/></td></tr>
<tr class="separator:structARM__USBH__PORT__STATE"><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:ga2e4d0ebd0851ba7bf364ae1d8948672c"><td class="memItemLeft" align="right" valign="top">typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a></td></tr>
<tr class="memdesc:ga2e4d0ebd0851ba7bf364ae1d8948672c"><td class="mdescLeft"> </td><td class="mdescRight">USB Host Pipe Handle. <a href="#ga2e4d0ebd0851ba7bf364ae1d8948672c">More...</a><br/></td></tr>
<tr class="separator:ga2e4d0ebd0851ba7bf364ae1d8948672c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61edcbb6ee863fe87abee488d78e1051"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> )(uint8_t port, uint32_t event)</td></tr>
<tr class="memdesc:ga61edcbb6ee863fe87abee488d78e1051"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> : Signal Root HUB Port Event. <a href="#ga61edcbb6ee863fe87abee488d78e1051">More...</a><br/></td></tr>
<tr class="separator:ga61edcbb6ee863fe87abee488d78e1051"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1a32ebfe0db4a002aae2b0c0f8ece30c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t event)</td></tr>
<tr class="memdesc:ga1a32ebfe0db4a002aae2b0c0f8ece30c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> : Signal Pipe Event. <a href="#ga1a32ebfe0db4a002aae2b0c0f8ece30c">More...</a><br/></td></tr>
<tr class="separator:ga1a32ebfe0db4a002aae2b0c0f8ece30c"><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:gab11e67e11e7a0edbc8a1afa86b971784"><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__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">ARM_USBH_GetVersion</a> (void)</td></tr>
<tr class="memdesc:gab11e67e11e7a0edbc8a1afa86b971784"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#gab11e67e11e7a0edbc8a1afa86b971784">More...</a><br/></td></tr>
<tr class="separator:gab11e67e11e7a0edbc8a1afa86b971784"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb509db50fdccfc7198dfd7ac54530d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:gadb509db50fdccfc7198dfd7ac54530d7"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#gadb509db50fdccfc7198dfd7ac54530d7">More...</a><br/></td></tr>
<tr class="separator:gadb509db50fdccfc7198dfd7ac54530d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad1e73f778c95dd46d4396e7741a97f0b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> (<a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> cb_port_event, <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> cb_pipe_event)</td></tr>
<tr class="memdesc:gad1e73f778c95dd46d4396e7741a97f0b"><td class="mdescLeft"> </td><td class="mdescRight">Initialize USB Host Interface. <a href="#gad1e73f778c95dd46d4396e7741a97f0b">More...</a><br/></td></tr>
<tr class="separator:gad1e73f778c95dd46d4396e7741a97f0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc2f18bc12bb0019f9cd1836dcca408d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gafc2f18bc12bb0019f9cd1836dcca408d"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize USB Host Interface. <a href="#gafc2f18bc12bb0019f9cd1836dcca408d">More...</a><br/></td></tr>
<tr class="separator:gafc2f18bc12bb0019f9cd1836dcca408d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga290a5e2e491da784e63be94699974d4a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga290a5e2e491da784e63be94699974d4a"><td class="mdescLeft"> </td><td class="mdescRight">Control USB Host Interface Power. <a href="#ga290a5e2e491da784e63be94699974d4a">More...</a><br/></td></tr>
<tr class="separator:ga290a5e2e491da784e63be94699974d4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaccca5ddd4a9d04388e7678a3aed3f6e4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff</a> (uint8_t port, bool vbus)</td></tr>
<tr class="memdesc:gaccca5ddd4a9d04388e7678a3aed3f6e4"><td class="mdescLeft"> </td><td class="mdescRight">Root HUB Port VBUS on/off. <a href="#gaccca5ddd4a9d04388e7678a3aed3f6e4">More...</a><br/></td></tr>
<tr class="separator:gaccca5ddd4a9d04388e7678a3aed3f6e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab99882e11ee03018da9ebe33797cc5ff"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a> (uint8_t port)</td></tr>
<tr class="memdesc:gab99882e11ee03018da9ebe33797cc5ff"><td class="mdescLeft"> </td><td class="mdescRight">Do Root HUB Port Reset. <a href="#gab99882e11ee03018da9ebe33797cc5ff">More...</a><br/></td></tr>
<tr class="separator:gab99882e11ee03018da9ebe33797cc5ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga620f8852a70a47a581001ed3050436d6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend</a> (uint8_t port)</td></tr>
<tr class="memdesc:ga620f8852a70a47a581001ed3050436d6"><td class="mdescLeft"> </td><td class="mdescRight">Suspend Root HUB Port (stop generating SOFs). <a href="#ga620f8852a70a47a581001ed3050436d6">More...</a><br/></td></tr>
<tr class="separator:ga620f8852a70a47a581001ed3050436d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab438b55ada37e2987e77e105f061f2de"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume</a> (uint8_t port)</td></tr>
<tr class="memdesc:gab438b55ada37e2987e77e105f061f2de"><td class="mdescLeft"> </td><td class="mdescRight">Resume Root HUB Port (start generating SOFs). <a href="#gab438b55ada37e2987e77e105f061f2de">More...</a><br/></td></tr>
<tr class="separator:gab438b55ada37e2987e77e105f061f2de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaea4ec5453c1d5fe37a2507d3cb4713bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> (uint8_t port)</td></tr>
<tr class="memdesc:gaea4ec5453c1d5fe37a2507d3cb4713bc"><td class="mdescLeft"> </td><td class="mdescRight">Get current Root HUB Port State. <a href="#gaea4ec5453c1d5fe37a2507d3cb4713bc">More...</a><br/></td></tr>
<tr class="separator:gaea4ec5453c1d5fe37a2507d3cb4713bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30dcc05151a98c5a8f6fe17e83777fe0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> (uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)</td></tr>
<tr class="memdesc:ga30dcc05151a98c5a8f6fe17e83777fe0"><td class="mdescLeft"> </td><td class="mdescRight">Create Pipe in System. <a href="#ga30dcc05151a98c5a8f6fe17e83777fe0">More...</a><br/></td></tr>
<tr class="separator:ga30dcc05151a98c5a8f6fe17e83777fe0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2076a7ae55f603859c726e57b061ac73"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)</td></tr>
<tr class="memdesc:ga2076a7ae55f603859c726e57b061ac73"><td class="mdescLeft"> </td><td class="mdescRight">Modify Pipe in System. <a href="#ga2076a7ae55f603859c726e57b061ac73">More...</a><br/></td></tr>
<tr class="separator:ga2076a7ae55f603859c726e57b061ac73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab2135041e6d481f186015f36fa0d0521"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:gab2135041e6d481f186015f36fa0d0521"><td class="mdescLeft"> </td><td class="mdescRight">Delete Pipe from System. <a href="#gab2135041e6d481f186015f36fa0d0521">More...</a><br/></td></tr>
<tr class="separator:gab2135041e6d481f186015f36fa0d0521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f5a605dbe98e450e6965d515fde65a7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:ga7f5a605dbe98e450e6965d515fde65a7"><td class="mdescLeft"> </td><td class="mdescRight">Reset Pipe. <a href="#ga7f5a605dbe98e450e6965d515fde65a7">More...</a><br/></td></tr>
<tr class="separator:ga7f5a605dbe98e450e6965d515fde65a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga817d503a24ad8927fa362c8f6394920d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:ga817d503a24ad8927fa362c8f6394920d"><td class="mdescLeft"> </td><td class="mdescRight">Transfer packets through USB Pipe. <a href="#ga817d503a24ad8927fa362c8f6394920d">More...</a><br/></td></tr>
<tr class="separator:ga817d503a24ad8927fa362c8f6394920d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85baa421345a5b92881ad190d72ca47f"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:ga85baa421345a5b92881ad190d72ca47f"><td class="mdescLeft"> </td><td class="mdescRight">Get result of USB Pipe transfer. <a href="#ga85baa421345a5b92881ad190d72ca47f">More...</a><br/></td></tr>
<tr class="separator:ga85baa421345a5b92881ad190d72ca47f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d4048a076aed71e585cea96a21f0afb"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:ga1d4048a076aed71e585cea96a21f0afb"><td class="mdescLeft"> </td><td class="mdescRight">Abort current USB Pipe transfer. <a href="#ga1d4048a076aed71e585cea96a21f0afb">More...</a><br/></td></tr>
<tr class="separator:ga1d4048a076aed71e585cea96a21f0afb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9dc305fc234c9987b9efd679b5042cc9"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">ARM_USBH_GetFrameNumber</a> (void)</td></tr>
<tr class="memdesc:ga9dc305fc234c9987b9efd679b5042cc9"><td class="mdescLeft"> </td><td class="mdescRight">Get current USB Frame Number. <a href="#ga9dc305fc234c9987b9efd679b5042cc9">More...</a><br/></td></tr>
<tr class="separator:ga9dc305fc234c9987b9efd679b5042cc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga53619da2a3d56934629084b0d5c4700c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> (uint8_t port, uint32_t event)</td></tr>
<tr class="memdesc:ga53619da2a3d56934629084b0d5c4700c"><td class="mdescLeft"> </td><td class="mdescRight">Signal Root HUB Port Event. <a href="#ga53619da2a3d56934629084b0d5c4700c">More...</a><br/></td></tr>
<tr class="separator:ga53619da2a3d56934629084b0d5c4700c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae58d36afd83a0e32b07e89fb7145c9de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t event)</td></tr>
<tr class="memdesc:gae58d36afd83a0e32b07e89fb7145c9de"><td class="mdescLeft"> </td><td class="mdescRight">Signal Pipe Event. <a href="#gae58d36afd83a0e32b07e89fb7145c9de">More...</a><br/></td></tr>
<tr class="separator:gae58d36afd83a0e32b07e89fb7145c9de"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for USB Host. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__USBH" id="structARM__DRIVER__USBH"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_USBH</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of USB Host Driver. </p>
<p>The functions of the USB Host driver 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 USBH 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_USBH0</b> is the name of the access struct of the first instance (no. 0).</li>
<li><b>Driver_USBH1</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_USBH<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>
<dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
</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__usbh__host__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__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">ARM_USBH_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:aaba1d9458e32389c21c3d899f9cb9313"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#aaba1d9458e32389c21c3d899f9cb9313">GetCapabilities</a> )(void)</td></tr>
<tr class="memdesc:aaba1d9458e32389c21c3d899f9cb9313"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a> : Get driver capabilities. <a href="#aaba1d9458e32389c21c3d899f9cb9313">More...</a><br/></td></tr>
<tr class="separator:aaba1d9458e32389c21c3d899f9cb9313"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bf141e46b7ced3abe3466cae4d811fb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a5bf141e46b7ced3abe3466cae4d811fb">Initialize</a> )(<a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> cb_port_event, <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> cb_pipe_event)</td></tr>
<tr class="memdesc:a5bf141e46b7ced3abe3466cae4d811fb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> : Initialize USB Host Interface. <a href="#a5bf141e46b7ced3abe3466cae4d811fb">More...</a><br/></td></tr>
<tr class="separator:a5bf141e46b7ced3abe3466cae4d811fb"><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__usbh__host__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__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize</a> : De-initialize USB Host 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__usbh__host__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__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl</a> : Control USB Host Interface Power. <a href="#aba8f1c8019af95ffe19c32403e3240ef">More...</a><br/></td></tr>
<tr class="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab859fb9f73a60ffa1ce71ed961d4744f"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ab859fb9f73a60ffa1ce71ed961d4744f">PortVbusOnOff</a> )(uint8_t port, bool vbus)</td></tr>
<tr class="memdesc:ab859fb9f73a60ffa1ce71ed961d4744f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff</a> : Root HUB Port VBUS on/off. <a href="#ab859fb9f73a60ffa1ce71ed961d4744f">More...</a><br/></td></tr>
<tr class="separator:ab859fb9f73a60ffa1ce71ed961d4744f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95125e80b07640860a7e16f510eca506"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a95125e80b07640860a7e16f510eca506">PortReset</a> )(uint8_t port)</td></tr>
<tr class="memdesc:a95125e80b07640860a7e16f510eca506"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a> : Do Root HUB Port Reset. <a href="#a95125e80b07640860a7e16f510eca506">More...</a><br/></td></tr>
<tr class="separator:a95125e80b07640860a7e16f510eca506"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8be30d2d44a6447c8c085439ef117fb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ab8be30d2d44a6447c8c085439ef117fb">PortSuspend</a> )(uint8_t port)</td></tr>
<tr class="memdesc:ab8be30d2d44a6447c8c085439ef117fb"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend</a> : Suspend Root HUB Port (stop generating SOFs). <a href="#ab8be30d2d44a6447c8c085439ef117fb">More...</a><br/></td></tr>
<tr class="separator:ab8be30d2d44a6447c8c085439ef117fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79126109256c1ccef901f22bc36ddc1d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a79126109256c1ccef901f22bc36ddc1d">PortResume</a> )(uint8_t port)</td></tr>
<tr class="memdesc:a79126109256c1ccef901f22bc36ddc1d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume</a> : Resume Root HUB Port (start generating SOFs). <a href="#a79126109256c1ccef901f22bc36ddc1d">More...</a><br/></td></tr>
<tr class="separator:a79126109256c1ccef901f22bc36ddc1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84c391c0db065fa27b672eef6002905b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a84c391c0db065fa27b672eef6002905b">PortGetState</a> )(uint8_t port)</td></tr>
<tr class="memdesc:a84c391c0db065fa27b672eef6002905b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> : Get current Root HUB Port State. <a href="#a84c391c0db065fa27b672eef6002905b">More...</a><br/></td></tr>
<tr class="separator:a84c391c0db065fa27b672eef6002905b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ce5ca579a8c535434187ad05f596fbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a7ce5ca579a8c535434187ad05f596fbd">PipeCreate</a> )(uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)</td></tr>
<tr class="memdesc:a7ce5ca579a8c535434187ad05f596fbd"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> : Create Pipe in System. <a href="#a7ce5ca579a8c535434187ad05f596fbd">More...</a><br/></td></tr>
<tr class="separator:a7ce5ca579a8c535434187ad05f596fbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3efae6fe31a53f7ecd765ba6db99992e"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a3efae6fe31a53f7ecd765ba6db99992e">PipeModify</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)</td></tr>
<tr class="memdesc:a3efae6fe31a53f7ecd765ba6db99992e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a> : Modify Pipe in System. <a href="#a3efae6fe31a53f7ecd765ba6db99992e">More...</a><br/></td></tr>
<tr class="separator:a3efae6fe31a53f7ecd765ba6db99992e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2f8047e89786bb7a459fb9c6c3f03d5"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ab2f8047e89786bb7a459fb9c6c3f03d5">PipeDelete</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:ab2f8047e89786bb7a459fb9c6c3f03d5"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a> : Delete Pipe from System. <a href="#ab2f8047e89786bb7a459fb9c6c3f03d5">More...</a><br/></td></tr>
<tr class="separator:ab2f8047e89786bb7a459fb9c6c3f03d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe91e3e22bc401546d033cb9554550b7"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#afe91e3e22bc401546d033cb9554550b7">PipeReset</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:afe91e3e22bc401546d033cb9554550b7"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a> : Reset Pipe. <a href="#afe91e3e22bc401546d033cb9554550b7">More...</a><br/></td></tr>
<tr class="separator:afe91e3e22bc401546d033cb9554550b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a495b069fadf5ba5b069bfdec6cda8b88"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a495b069fadf5ba5b069bfdec6cda8b88">PipeTransfer</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)</td></tr>
<tr class="memdesc:a495b069fadf5ba5b069bfdec6cda8b88"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> : Transfer packets through USB Pipe. <a href="#a495b069fadf5ba5b069bfdec6cda8b88">More...</a><br/></td></tr>
<tr class="separator:a495b069fadf5ba5b069bfdec6cda8b88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18369bada042ff5557ff919056636a62"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a18369bada042ff5557ff919056636a62">PipeTransferGetResult</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:a18369bada042ff5557ff919056636a62"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a> : Get result of USB Pipe transfer. <a href="#a18369bada042ff5557ff919056636a62">More...</a><br/></td></tr>
<tr class="separator:a18369bada042ff5557ff919056636a62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab82fb8b02ff81156098b8210c0344f5e"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ab82fb8b02ff81156098b8210c0344f5e">PipeTransferAbort</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
<tr class="memdesc:ab82fb8b02ff81156098b8210c0344f5e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a> : Abort current USB Pipe transfer. <a href="#ab82fb8b02ff81156098b8210c0344f5e">More...</a><br/></td></tr>
<tr class="separator:ab82fb8b02ff81156098b8210c0344f5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31d1785d6d46f75241ebbf6b5a6b4919"><td class="memItemLeft" align="right" valign="top">uint16_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a31d1785d6d46f75241ebbf6b5a6b4919">GetFrameNumber</a> )(void)</td></tr>
<tr class="memdesc:a31d1785d6d46f75241ebbf6b5a6b4919"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">ARM_USBH_GetFrameNumber</a> : Get current USB Frame Number. <a href="#a31d1785d6d46f75241ebbf6b5a6b4919">More...</a><br/></td></tr>
<tr class="separator:a31d1785d6d46f75241ebbf6b5a6b4919"><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__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">ARM_USBH_GetVersion</a> : Get driver version. </p>
</div>
</div>
<a class="anchor" id="aaba1d9458e32389c21c3d899f9cb9313"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a> : Get driver capabilities. </p>
</div>
</div>
<a class="anchor" id="a5bf141e46b7ced3abe3466cae4d811fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> cb_port_event, <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> cb_pipe_event)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> : Initialize USB Host 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__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize</a> : De-initialize USB Host 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__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl</a> : Control USB Host Interface Power. </p>
</div>
</div>
<a class="anchor" id="ab859fb9f73a60ffa1ce71ed961d4744f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PortVbusOnOff)(uint8_t port, bool vbus)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff</a> : Root HUB Port VBUS on/off. </p>
</div>
</div>
<a class="anchor" id="a95125e80b07640860a7e16f510eca506"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PortReset)(uint8_t port)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a> : Do Root HUB Port Reset. </p>
</div>
</div>
<a class="anchor" id="ab8be30d2d44a6447c8c085439ef117fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PortSuspend)(uint8_t port)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend</a> : Suspend Root HUB Port (stop generating SOFs). </p>
</div>
</div>
<a class="anchor" id="a79126109256c1ccef901f22bc36ddc1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PortResume)(uint8_t port)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume</a> : Resume Root HUB Port (start generating SOFs). </p>
</div>
</div>
<a class="anchor" id="a84c391c0db065fa27b672eef6002905b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a>(* PortGetState)(uint8_t port)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> : Get current Root HUB Port State. </p>
</div>
</div>
<a class="anchor" id="a7ce5ca579a8c535434187ad05f596fbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>(* PipeCreate)(uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> : Create Pipe in System. </p>
</div>
</div>
<a class="anchor" id="a3efae6fe31a53f7ecd765ba6db99992e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PipeModify)(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a> : Modify Pipe in System. </p>
</div>
</div>
<a class="anchor" id="ab2f8047e89786bb7a459fb9c6c3f03d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PipeDelete)(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a> : Delete Pipe from System. </p>
</div>
</div>
<a class="anchor" id="afe91e3e22bc401546d033cb9554550b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PipeReset)(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a> : Reset Pipe. </p>
</div>
</div>
<a class="anchor" id="a495b069fadf5ba5b069bfdec6cda8b88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PipeTransfer)(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> : Transfer packets through USB Pipe. </p>
</div>
</div>
<a class="anchor" id="a18369bada042ff5557ff919056636a62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* PipeTransferGetResult)(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a> : Get result of USB Pipe transfer. </p>
</div>
</div>
<a class="anchor" id="ab82fb8b02ff81156098b8210c0344f5e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* PipeTransferAbort)(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a> : Abort current USB Pipe transfer. </p>
</div>
</div>
<a class="anchor" id="a31d1785d6d46f75241ebbf6b5a6b4919"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t(* GetFrameNumber)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">ARM_USBH_GetFrameNumber</a> : Get current USB Frame Number. </p>
</div>
</div>
</div>
</div>
<a name="structARM__USBH__CAPABILITIES" id="structARM__USBH__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USBH_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USB Host Driver Capabilities. </p>
<p>A USB Host driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a></li>
</ul>
<dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac37c09b54483c2a1e41fa8a976721fc4"></a>uint32_t</td>
<td class="fieldname">
port_mask: 15</td>
<td class="fielddoc">
Root HUB available Ports Mask. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a37eab684b9a8aa496bfec9fede42fe27"></a>uint32_t</td>
<td class="fieldname">
auto_split: 1</td>
<td class="fielddoc">
Automatic SPLIT packet handling. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae76b779cb9fdf447b20c8b6beed2d534"></a>uint32_t</td>
<td class="fieldname">
event_connect: 1</td>
<td class="fielddoc">
Signal Connect event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ab83941051cac8e19807b887354dc42fc"></a>uint32_t</td>
<td class="fieldname">
event_disconnect: 1</td>
<td class="fielddoc">
Signal Disconnect event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acd3087b3a4a7691595dd75568c12d696"></a>uint32_t</td>
<td class="fieldname">
event_overcurrent: 1</td>
<td class="fielddoc">
Signal Overcurrent event. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 13</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<a name="structARM__USBH__PORT__STATE" id="structARM__USBH__PORT__STATE"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_USBH_PORT_STATE</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>USB Host Port State. </p>
<p>This structure stores information about the state of the USB Host Port. The data fields encode whether a device is connected to the port, if port overcurrent is detected, and the port speed.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="abf1a0792d6af28877b0abd141d5524ac"></a>uint32_t</td>
<td class="fieldname">
connected: 1</td>
<td class="fielddoc">
USB Host Port connected flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae4b5761b8d095bee008a94856ceca46b"></a>uint32_t</td>
<td class="fieldname">
overcurrent: 1</td>
<td class="fielddoc">
USB Host Port overcurrent flag. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a220859a8b5da0232739a11cbe7f79fc5"></a>uint32_t</td>
<td class="fieldname">
speed: 2</td>
<td class="fielddoc">
USB Host Port speed setting (ARM_USB_SPEED_xxx) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 28</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga2e4d0ebd0851ba7bf364ae1d8948672c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Host Pipe Handle. </p>
<p>Each pipe is identified through a unique number, which is created by the function <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a>, <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</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#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a>, <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a>, <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a></li>
</ul>
<p><b>Retruned by:</b></p>
<ul>
<li><a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga61edcbb6ee863fe87abee488d78e1051"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_USBH_SignalPortEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> : Signal Root HUB Port Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga1a32ebfe0db4a002aae2b0c0f8ece30c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_USBH_SignalPipeEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> : Signal Pipe Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab11e67e11e7a0edbc8a1afa86b971784"></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_USBH_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_USBH_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__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> Driver_USBH0;</div>
<div class="line"><a class="code" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> *drv_info;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> setup_usbh (<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_USBH0; </div>
<div class="line"> version = drv_info-><a class="code" href="group__usbh__host__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="gadb509db50fdccfc7198dfd7ac54530d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> ARM_USBH_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__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_USBH_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> encode various capabilities, for example available HUB ports or if the hardware can generate signal events using the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> Driver_USBH0;</div>
<div class="line"><a class="code" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</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__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> drv_capabilities;</div>
<div class="line"> </div>
<div class="line"> drv_info = &Driver_USBH0; </div>
<div class="line"> drv_capabilities = drv_info-><a class="code" href="group__usbh__host__gr.html#aaba1d9458e32389c21c3d899f9cb9313">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="gad1e73f778c95dd46d4396e7741a97f0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> </td>
<td class="paramname"><em>cb_port_event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> </td>
<td class="paramname"><em>cb_pipe_event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize USB Host Interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb_port_event</td><td>Pointer to <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb_pipe_event</td><td>Pointer to <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</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_USBH_Initialize</b> initializes the USB Host interface. It is called when the middleware component starts operation.</p>
<p>The function performs the following operations:</p>
<ul>
<li>Initializes the resources needed for the USBH interface.</li>
<li>Registers the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function.</li>
<li>Registers the <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_port_event</em> is a pointer to the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function; use a NULL pointer when no port callback signals are required.</p>
<p>The parameter <em>cb_pipe_event</em> is a pointer to the <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> callback function.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> - Driver Functions </li>
</ul>
</div>
</div>
<a class="anchor" id="gafc2f18bc12bb0019f9cd1836dcca408d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_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 USB Host 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_USBH_Uninitialize</b> de-initializes the resources of USB Host 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="ga290a5e2e491da784e63be94699974d4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_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 USB Host 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 </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_USBH_PowerControl</b> operates the power modes of the USB Host 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>
</div>
</div>
<a class="anchor" id="gaccca5ddd4a9d04388e7678a3aed3f6e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PortVbusOnOff </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>vbus</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Root HUB Port VBUS on/off. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">vbus</td><td><ul>
<li><b>false</b> VBUS off</li>
<li><b>true</b> VBUS on </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_USBH_PortVbusOnOff</b> controls the VBUS signal of the specified port. </p>
</div>
</div>
<a class="anchor" id="gab99882e11ee03018da9ebe33797cc5ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PortReset </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Do Root HUB Port Reset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </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>Executes reset signalling on the specified port. </p>
</div>
</div>
<a class="anchor" id="ga620f8852a70a47a581001ed3050436d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PortSuspend </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Suspend Root HUB Port (stop generating SOFs). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </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_USBH_PortSuspend</b> auspends USB signaling on the specified port. </p>
</div>
</div>
<a class="anchor" id="gab438b55ada37e2987e77e105f061f2de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PortResume </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resume Root HUB Port (start generating SOFs). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </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_USBH_PortResume</b> resumes USB signaling on the specified port. </p>
</div>
</div>
<a class="anchor" id="gaea4ec5453c1d5fe37a2507d3cb4713bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a> ARM_USBH_PortGetState </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current Root HUB Port State. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Port State <a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a></dd></dl>
<p>The function <b>ARM_USBH_PortGetState</b> returns the current state of the specified port. </p>
</div>
</div>
<a class="anchor" id="ga30dcc05151a98c5a8f6fe17e83777fe0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> ARM_USBH_PipeCreate </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>dev_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>dev_speed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>hub_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>hub_port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>ep_max_packet_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ep_interval</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create Pipe in System. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Device Address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dev_speed</td><td>Device Speed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hub_addr</td><td>Hub Address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hub_port</td><td>Hub Port </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
<li>ep_addr.0..3: Address</li>
<li>ep_addr.7: Direction </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_type</td><td>Endpoint Type (ARM_USB_ENDPOINT_xxx) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_max_packet_size</td><td>Endpoint Maximum Packet Size </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_interval</td><td>Endpoint Polling Interval </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pipe Handle <a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a></dd></dl>
<p>The function <b>ARM_USBH_PipeCreate</b> creates a pipe for transfers (allocates required resources and configures the pipe).</p>
<p>The parameters specify pipe information (connection between host and device endpoint):</p>
<ul>
<li>device: address and speed</li>
<li>hub (optional): hub address and number of the hub port to which the device is connected</li>
<li>endpoint: address, type, maximum packet size and polling interval</li>
</ul>
<p>The function returns an pipe handle that is used for all subsequent operations on that pipe. In case of errors an invalid handle (<em>NULL</em>) is returned. </p>
</div>
</div>
<a class="anchor" id="ga2076a7ae55f603859c726e57b061ac73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PipeModify </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>dev_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>dev_speed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>hub_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>hub_port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>ep_max_packet_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify Pipe in System. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Device Address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dev_speed</td><td>Device Speed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hub_addr</td><td>Hub Address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hub_port</td><td>Hub Port </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ep_max_packet_size</td><td>Endpoint Maximum Packet Size </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_USBH_PipeModify</b> modifies a pipe configuration that was created with <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a>. </p>
</div>
</div>
<a class="anchor" id="gab2135041e6d481f186015f36fa0d0521"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PipeDelete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete Pipe from System. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </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_USBH_PipeDelete</b> deletes a pipe that was created with <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> (deactivates the pipe and releases used resources). </p>
</div>
</div>
<a class="anchor" id="ga7f5a605dbe98e450e6965d515fde65a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PipeReset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset Pipe. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </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_USBH_PipeReset</b> clears Halt condition and resets data toggle on the specified pipe. </p>
</div>
</div>
<a class="anchor" id="ga817d503a24ad8927fa362c8f6394920d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PipeTransfer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>packet</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">uint32_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transfer packets through USB Pipe. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>Packet information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to send or for data to receive </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to transfer </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_USBH_PipeTransfer</b> generates packets for sending or receiving data from an USB Endpoint.</p>
<p>The function specifies the buffer with data to send or for data to receive and the number of bytes to transfer (must be multiple of device endpoint maximum packet size for receive). It also specifies <a class="el" href="group__USBH__packets.html">USBH Packet Information</a> with parameter <em>packet</em>.</p>
<p>The function is non-blocking and returns as soon as the driver starts the operation on the specified pipe. During the operation it is not allowed to call this function again on the same pipe. Also the data buffer must stay allocated and the contents of data must not be modified.</p>
<p>Operation is completed when the the requested number of data bytes have been transferred and is indicated with <a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a> event. It can also finish earlier on reception of different handshake tokens which are also indicated through <a class="el" href="group__USBH__pipe__events.html">USBH Pipe Events</a>.</p>
<p>Transfer operation can be aborted by calling <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a>. </p>
</div>
</div>
<a class="anchor" id="ga85baa421345a5b92881ad190d72ca47f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_USBH_PipeTransferGetResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get result of USB Pipe transfer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of successfully transferred data bytes</dd></dl>
<p>The function <b>ARM_USBH_PipeTransferGetResult</b> returns the number of successfully transferred data bytes started by <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> operation. </p>
</div>
</div>
<a class="anchor" id="ga1d4048a076aed71e585cea96a21f0afb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_USBH_PipeTransferAbort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort current USB Pipe transfer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </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_USBH_PipeTransferAbort</b> aborts an active pipe transfer started by <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>. </p>
</div>
</div>
<a class="anchor" id="ga9dc305fc234c9987b9efd679b5042cc9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t ARM_USBH_GetFrameNumber </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current USB Frame Number. </p>
<dl class="section return"><dt>Returns</dt><dd>Frame Number</dd></dl>
<p>The function <b>ARM_USBH_GetFrameNumber</b> returns the sequential 11-bit frame number of the last Start of Frame (SOF) packet. </p>
</div>
</div>
<a class="anchor" id="ga53619da2a3d56934629084b0d5c4700c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_USBH_SignalPortEvent </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>port</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 Root HUB Port Event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__USBH__port__events.html">USBH Port Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_USBH_SignalPortEvent</b> is a callback function registered by the function <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a>.</p>
<p>The parameter <em>port</em> specifies the root hub port number. <br/>
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__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_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><th>supported when <a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES" title="USB Host Driver Capabilities. ">ARM_USBH_CAPABILITIES</a> </th></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#ga71bfd8b8cd41b8aa6303d5d3a91597e6">ARM_USBH_EVENT_CONNECT</a> </td><td align="center">0 </td><td align="left">Occurs when USB Device connects to the Host. </td><td>data field <em>event_connect=</em> <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#gaba67919f64e9a08ba1264363b2710d20">ARM_USBH_EVENT_DISCONNECT</a> </td><td align="center">1 </td><td align="left">Occurs when USB Device disconnects from the Host. </td><td>data field <em>event_disconnect=</em> <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#ga0955fdc2aedd2c5aa2be6cd782b3f2a8">ARM_USBH_EVENT_OVERCURRENT</a> </td><td align="center">2 </td><td align="left">Occurs when USB Overcurrent it detected. </td><td>data field <em>event_overcurrent=</em> <span class="XML-Token">1</span> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#ga70ae1e0a7872556d302a7f7840843c4a">ARM_USBH_EVENT_RESET</a> </td><td align="center">3 </td><td align="left">Occurs when USB Reset is completed after calling <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a>. </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#gae1f91db7d31bcebbf60a23fb04cf7eb5">ARM_USBH_EVENT_SUSPEND</a> </td><td align="center">4 </td><td align="left">Occurs when USB Suspend is detected. </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#ga42f62bdf6dd639f9f3dffc6c127456e3">ARM_USBH_EVENT_RESUME</a> </td><td align="center">5 </td><td align="left">Occurs when USB Resume is detected. </td><td><em>always supported</em> </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__port__events.html#ga2b61e9df3c63fd78fc08f79280a7066e">ARM_USBH_EVENT_REMOTE_WAKEUP</a> </td><td align="center">6 </td><td align="left">Occurs when USB Remote wakeup is detected. </td><td><em>always supported</em> </td></tr>
</table>
</div>
</div>
<a class="anchor" id="gae58d36afd83a0e32b07e89fb7145c9de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_USBH_SignalPipeEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> </td>
<td class="paramname"><em>pipe_hndl</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 Pipe Event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__USBH__pipe__events.html">USBH Pipe Events</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_USBH_SignalPipeEvent</b> is a callback function registered by the function <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a>.</p>
<p>The parameter <em>pipe_hndl</em> specifies the pipe handle. <br/>
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>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="right">Bit</th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a> </td><td align="right">0 </td><td align="left">Occurs after all the data has been transferred without errors. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0">ARM_USBH_EVENT_HANDSHAKE_NAK</a> </td><td align="right">1 </td><td align="left">Occurs when NAK Handshake is received before all the data is transferred. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#ga62ae214576c923ce737a16098e9836e5">ARM_USBH_EVENT_HANDSHAKE_NYET</a> </td><td align="right">2 </td><td align="left">Occurs when NYET Handshake is received before all the data is transferred. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010">ARM_USBH_EVENT_HANDSHAKE_MDATA</a> </td><td align="right">3 </td><td align="left">Occurs when MDATA Handshake is received before all the data is transferred. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8">ARM_USBH_EVENT_HANDSHAKE_STALL</a> </td><td align="right">4 </td><td align="left">Occurs when STALL Handshake is received before all the data is transferred. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614">ARM_USBH_EVENT_HANDSHAKE_ERR</a> </td><td align="right">5 </td><td align="left">Occurs when ERR Handshake is received before all the data is transferred. </td></tr>
<tr>
<td align="left"><a class="el" href="group__USBH__pipe__events.html#ga7bd871b1e5c059bee398c32429370724">ARM_USBH_EVENT_BUS_ERROR</a> </td><td align="right">6 </td><td align="left">Occurs when bus error is detected before all the data is transferred. </td></tr>
</table>
<p><b>See also:</b></p>
<ul>
<li>ARM_USBH_PipeCreate </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: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__host__gr.html | HTML | apache-2.0 | 99,421 |
var group__usbh__host__gr =
[
[ "USBH Port Events", "group__USBH__port__events.html", "group__USBH__port__events" ],
[ "USBH Pipe Events", "group__USBH__pipe__events.html", "group__USBH__pipe__events" ],
[ "USBH Packet Information", "group__USBH__packets.html", "group__USBH__packets" ],
[ "ARM_DRIVER_USBH", "group__usbh__host__gr.html#structARM__DRIVER__USBH", [
[ "GetVersion", "group__usbh__host__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usbh__host__gr.html#aaba1d9458e32389c21c3d899f9cb9313", null ],
[ "Initialize", "group__usbh__host__gr.html#a5bf141e46b7ced3abe3466cae4d811fb", null ],
[ "Uninitialize", "group__usbh__host__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usbh__host__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "PortVbusOnOff", "group__usbh__host__gr.html#ab859fb9f73a60ffa1ce71ed961d4744f", null ],
[ "PortReset", "group__usbh__host__gr.html#a95125e80b07640860a7e16f510eca506", null ],
[ "PortSuspend", "group__usbh__host__gr.html#ab8be30d2d44a6447c8c085439ef117fb", null ],
[ "PortResume", "group__usbh__host__gr.html#a79126109256c1ccef901f22bc36ddc1d", null ],
[ "PortGetState", "group__usbh__host__gr.html#a84c391c0db065fa27b672eef6002905b", null ],
[ "PipeCreate", "group__usbh__host__gr.html#a7ce5ca579a8c535434187ad05f596fbd", null ],
[ "PipeModify", "group__usbh__host__gr.html#a3efae6fe31a53f7ecd765ba6db99992e", null ],
[ "PipeDelete", "group__usbh__host__gr.html#ab2f8047e89786bb7a459fb9c6c3f03d5", null ],
[ "PipeReset", "group__usbh__host__gr.html#afe91e3e22bc401546d033cb9554550b7", null ],
[ "PipeTransfer", "group__usbh__host__gr.html#a495b069fadf5ba5b069bfdec6cda8b88", null ],
[ "PipeTransferGetResult", "group__usbh__host__gr.html#a18369bada042ff5557ff919056636a62", null ],
[ "PipeTransferAbort", "group__usbh__host__gr.html#ab82fb8b02ff81156098b8210c0344f5e", null ],
[ "GetFrameNumber", "group__usbh__host__gr.html#a31d1785d6d46f75241ebbf6b5a6b4919", null ]
] ],
[ "ARM_USBH_CAPABILITIES", "group__usbh__host__gr.html#structARM__USBH__CAPABILITIES", [
[ "port_mask", "group__usbh__host__gr.html#ac37c09b54483c2a1e41fa8a976721fc4", null ],
[ "auto_split", "group__usbh__host__gr.html#a37eab684b9a8aa496bfec9fede42fe27", null ],
[ "event_connect", "group__usbh__host__gr.html#ae76b779cb9fdf447b20c8b6beed2d534", null ],
[ "event_disconnect", "group__usbh__host__gr.html#ab83941051cac8e19807b887354dc42fc", null ],
[ "event_overcurrent", "group__usbh__host__gr.html#acd3087b3a4a7691595dd75568c12d696", null ],
[ "reserved", "group__usbh__host__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USBH_PORT_STATE", "group__usbh__host__gr.html#structARM__USBH__PORT__STATE", [
[ "connected", "group__usbh__host__gr.html#abf1a0792d6af28877b0abd141d5524ac", null ],
[ "overcurrent", "group__usbh__host__gr.html#ae4b5761b8d095bee008a94856ceca46b", null ],
[ "speed", "group__usbh__host__gr.html#a220859a8b5da0232739a11cbe7f79fc5", null ],
[ "reserved", "group__usbh__host__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_USBH_PIPE_HANDLE", "group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c", null ],
[ "ARM_USBH_SignalPortEvent_t", "group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051", null ],
[ "ARM_USBH_SignalPipeEvent_t", "group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c", null ],
[ "ARM_USBH_GetVersion", "group__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784", null ],
[ "ARM_USBH_GetCapabilities", "group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7", null ],
[ "ARM_USBH_Initialize", "group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b", null ],
[ "ARM_USBH_Uninitialize", "group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d", null ],
[ "ARM_USBH_PowerControl", "group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a", null ],
[ "ARM_USBH_PortVbusOnOff", "group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4", null ],
[ "ARM_USBH_PortReset", "group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff", null ],
[ "ARM_USBH_PortSuspend", "group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6", null ],
[ "ARM_USBH_PortResume", "group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de", null ],
[ "ARM_USBH_PortGetState", "group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc", null ],
[ "ARM_USBH_PipeCreate", "group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0", null ],
[ "ARM_USBH_PipeModify", "group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73", null ],
[ "ARM_USBH_PipeDelete", "group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521", null ],
[ "ARM_USBH_PipeReset", "group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7", null ],
[ "ARM_USBH_PipeTransfer", "group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d", null ],
[ "ARM_USBH_PipeTransferGetResult", "group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f", null ],
[ "ARM_USBH_PipeTransferAbort", "group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb", null ],
[ "ARM_USBH_GetFrameNumber", "group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9", null ],
[ "ARM_USBH_SignalPortEvent", "group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c", null ],
[ "ARM_USBH_SignalPipeEvent", "group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__host__gr.js | JavaScript | apache-2.0 | 5,672 |
var group__usbh__host__gr_structARM__DRIVER__USBH =
[
[ "GetVersion", "group__usbh__host__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__usbh__host__gr.html#aaba1d9458e32389c21c3d899f9cb9313", null ],
[ "Initialize", "group__usbh__host__gr.html#a5bf141e46b7ced3abe3466cae4d811fb", null ],
[ "Uninitialize", "group__usbh__host__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__usbh__host__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "PortVbusOnOff", "group__usbh__host__gr.html#ab859fb9f73a60ffa1ce71ed961d4744f", null ],
[ "PortReset", "group__usbh__host__gr.html#a95125e80b07640860a7e16f510eca506", null ],
[ "PortSuspend", "group__usbh__host__gr.html#ab8be30d2d44a6447c8c085439ef117fb", null ],
[ "PortResume", "group__usbh__host__gr.html#a79126109256c1ccef901f22bc36ddc1d", null ],
[ "PortGetState", "group__usbh__host__gr.html#a84c391c0db065fa27b672eef6002905b", null ],
[ "PipeCreate", "group__usbh__host__gr.html#a7ce5ca579a8c535434187ad05f596fbd", null ],
[ "PipeModify", "group__usbh__host__gr.html#a3efae6fe31a53f7ecd765ba6db99992e", null ],
[ "PipeDelete", "group__usbh__host__gr.html#ab2f8047e89786bb7a459fb9c6c3f03d5", null ],
[ "PipeReset", "group__usbh__host__gr.html#afe91e3e22bc401546d033cb9554550b7", null ],
[ "PipeTransfer", "group__usbh__host__gr.html#a495b069fadf5ba5b069bfdec6cda8b88", null ],
[ "PipeTransferGetResult", "group__usbh__host__gr.html#a18369bada042ff5557ff919056636a62", null ],
[ "PipeTransferAbort", "group__usbh__host__gr.html#ab82fb8b02ff81156098b8210c0344f5e", null ],
[ "GetFrameNumber", "group__usbh__host__gr.html#a31d1785d6d46f75241ebbf6b5a6b4919", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__host__gr_structARM__DRIVER__USBH.js | JavaScript | apache-2.0 | 1,748 |
var group__usbh__host__gr_structARM__USBH__CAPABILITIES =
[
[ "port_mask", "group__usbh__host__gr.html#ac37c09b54483c2a1e41fa8a976721fc4", null ],
[ "auto_split", "group__usbh__host__gr.html#a37eab684b9a8aa496bfec9fede42fe27", null ],
[ "event_connect", "group__usbh__host__gr.html#ae76b779cb9fdf447b20c8b6beed2d534", null ],
[ "event_disconnect", "group__usbh__host__gr.html#ab83941051cac8e19807b887354dc42fc", null ],
[ "event_overcurrent", "group__usbh__host__gr.html#acd3087b3a4a7691595dd75568c12d696", null ],
[ "reserved", "group__usbh__host__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__host__gr_structARM__USBH__CAPABILITIES.js | JavaScript | apache-2.0 | 626 |
var group__usbh__host__gr_structARM__USBH__PORT__STATE =
[
[ "connected", "group__usbh__host__gr.html#abf1a0792d6af28877b0abd141d5524ac", null ],
[ "overcurrent", "group__usbh__host__gr.html#ae4b5761b8d095bee008a94856ceca46b", null ],
[ "speed", "group__usbh__host__gr.html#a220859a8b5da0232739a11cbe7f79fc5", null ],
[ "reserved", "group__usbh__host__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__host__gr_structARM__USBH__PORT__STATE.js | JavaScript | apache-2.0 | 421 |
<!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 Host Interface</title>
<title>CMSIS-Driver: USB Host 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__usbh__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> </div>
<div class="headertitle">
<div class="title">USB Host Interface<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for USB Host Peripheral (Driver_USBH.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__usbh__host__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html">USB Host</a></td></tr>
<tr class="memdesc:group__usbh__host__gr"><td class="mdescLeft"> </td><td class="mdescRight">Driver API for USB Host. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__usbh__hci__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html">USB OHCI/EHCI</a></td></tr>
<tr class="memdesc:group__usbh__hci__gr"><td class="mdescLeft"> </td><td class="mdescRight">Driver API for USB OHCI/EHCI. <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>Driver API for USB Host Peripheral (Driver_USBH.h) </p>
<p><b>USB Host API</b></p>
<p>The header file <b><a class="el" href="Driver__USBH_8h.html">Driver_USBH.h</a></b> defines the API for the <b>USB Host Driver</b> interface used by middleware components. The driver implementation itself is a typical part of the Device Family Pack, which provides entry points to the interface as function pointers in the struct <a class="el" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a>. This structure can be available several times in each interface to control multiple USBH interfaces.</p>
<p><b><a class="el" href="Driver__USBH_8h.html">Driver_USBH.h</a></b> also defines callback routines, which are categorized in <b>port event callbacks</b> and <b>pipe event callbacks</b>. Callbacks are called by the driver, in interrupt context when an appropriate event occurs, to signal port related events (<a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a>) and pipe related events (<a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</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: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__interface__gr.html | HTML | apache-2.0 | 8,737 |
var group__usbh__interface__gr =
[
[ "USB Host", "group__usbh__host__gr.html", "group__usbh__host__gr" ],
[ "USB OHCI/EHCI", "group__usbh__hci__gr.html", "group__usbh__hci__gr" ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__usbh__interface__gr.js | JavaScript | apache-2.0 | 189 |
<!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 Socket Address Family definitions</title>
<title>CMSIS-Driver: WiFi Socket Address Family 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__wifi__addr__family.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 Socket Address Family definitions<div class="ingroups"><a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>WiFi Socket Address Family 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:ga1a17023d92374b4f2d963aa7ac1c4e17"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__addr__family.html#ga1a17023d92374b4f2d963aa7ac1c4e17">ARM_SOCKET_AF_INET</a>   1</td></tr>
<tr class="memdesc:ga1a17023d92374b4f2d963aa7ac1c4e17"><td class="mdescLeft"> </td><td class="mdescRight">IPv4. <a href="#ga1a17023d92374b4f2d963aa7ac1c4e17">More...</a><br/></td></tr>
<tr class="separator:ga1a17023d92374b4f2d963aa7ac1c4e17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad50c95421ffbc6eec5f8458b2e170c26"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__addr__family.html#gad50c95421ffbc6eec5f8458b2e170c26">ARM_SOCKET_AF_INET6</a>   2</td></tr>
<tr class="memdesc:gad50c95421ffbc6eec5f8458b2e170c26"><td class="mdescLeft"> </td><td class="mdescRight">IPv6. <a href="#gad50c95421ffbc6eec5f8458b2e170c26">More...</a><br/></td></tr>
<tr class="separator:gad50c95421ffbc6eec5f8458b2e170c26"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>WiFi Socket Address Family definitions. </p>
<p>The WiFi Socket Address Family specifies the addressing scheme that an instance of the WiFi socket can use. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga1a17023d92374b4f2d963aa7ac1c4e17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_AF_INET   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>IPv4. </p>
<p>Internet Address Family version 4. </p>
</div>
</div>
<a class="anchor" id="gad50c95421ffbc6eec5f8458b2e170c26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_AF_INET6   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>IPv6. </p>
<p>Internet Address Family version 6. </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__wifi__addr__family.html | HTML | apache-2.0 | 8,901 |
var group__wifi__addr__family =
[
[ "ARM_SOCKET_AF_INET", "group__wifi__addr__family.html#ga1a17023d92374b4f2d963aa7ac1c4e17", null ],
[ "ARM_SOCKET_AF_INET6", "group__wifi__addr__family.html#gad50c95421ffbc6eec5f8458b2e170c26", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__addr__family.js | JavaScript | apache-2.0 | 246 |
<!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 Bypass Mode</title>
<title>CMSIS-Driver: WiFi Bypass 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__wifi__bypass__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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">WiFi Bypass Mode<div class="ingroups"><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Transfer Ethernet frames by WiFi module.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga678fa1aa06ca6aaa67c7eb7a7660730e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e">ARM_WIFI_BypassControl</a> (uint32_t interface, uint32_t mode)</td></tr>
<tr class="memdesc:ga678fa1aa06ca6aaa67c7eb7a7660730e"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable bypass (pass-through) mode. Transmit and receive Ethernet frames (IP layer bypassed and WiFi/Ethernet translation). <a href="#ga678fa1aa06ca6aaa67c7eb7a7660730e">More...</a><br/></td></tr>
<tr class="separator:ga678fa1aa06ca6aaa67c7eb7a7660730e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1da4619feaf62d0cc90cfe44642d16b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#gac1da4619feaf62d0cc90cfe44642d16b">ARM_WIFI_EthSendFrame</a> (uint32_t interface, const uint8_t *frame, uint32_t len)</td></tr>
<tr class="memdesc:gac1da4619feaf62d0cc90cfe44642d16b"><td class="mdescLeft"> </td><td class="mdescRight">Send Ethernet frame (in bypass mode only). <a href="#gac1da4619feaf62d0cc90cfe44642d16b">More...</a><br/></td></tr>
<tr class="separator:gac1da4619feaf62d0cc90cfe44642d16b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1dbeb5528095af31a60560e0c48321d4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> (uint32_t interface, uint8_t *frame, uint32_t len)</td></tr>
<tr class="memdesc:ga1dbeb5528095af31a60560e0c48321d4"><td class="mdescLeft"> </td><td class="mdescRight">Read data of received Ethernet frame (in bypass mode only). <a href="#ga1dbeb5528095af31a60560e0c48321d4">More...</a><br/></td></tr>
<tr class="separator:ga1dbeb5528095af31a60560e0c48321d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab67442ff061d0c4311a7046bce8d0cd1"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html#gab67442ff061d0c4311a7046bce8d0cd1">ARM_WIFI_EthGetRxFrameSize</a> (uint32_t interface)</td></tr>
<tr class="memdesc:gab67442ff061d0c4311a7046bce8d0cd1"><td class="mdescLeft"> </td><td class="mdescRight">Get size of received Ethernet frame (in bypass mode only). <a href="#gab67442ff061d0c4311a7046bce8d0cd1">More...</a><br/></td></tr>
<tr class="separator:gab67442ff061d0c4311a7046bce8d0cd1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Transfer Ethernet frames by WiFi module. </p>
<p>The <a class="el" href="group__wifi__bypass__gr.html">WiFi Bypass Mode</a> functions are an optional interface and enable the transmission of Ethernet frames with WiFi modules. The use of this interface requires that the IP stack is running on the microcontroller. The internal IP stack of the WiFi module is therefore not used, and this usually means that the <a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a> functions can not be used. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga678fa1aa06ca6aaa67c7eb7a7660730e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_BypassControl </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable or disable bypass (pass-through) mode. Transmit and receive Ethernet frames (IP layer bypassed and WiFi/Ethernet translation). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td><ul>
<li>value = 1: all packets bypass internal IP stack</li>
<li>value = 0: all packets processed by internal IP stack </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or mode)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_BypassControl</b> enables or disables the WiFi bypass mode.</p>
<p>The WiFi Bypass mode can only be enabled, if there is a bypass mode supported in the WiFi driver. You can check this by checking the driver's capabilities.</p>
<dl class="section note"><dt>Note</dt><dd>Bypass mode is enabled by default if the module does not support the Socket interface.</dd></dl>
<p>The argument <em>mode</em> specifies the desired state of the WiFi Bypass mode, which is enabled or disabled.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</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"> </div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> wifi_notify (uint32_t event, ,<span class="keywordtype">void</span> *arg) {</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"><span class="keywordtype">void</span> initialize_wifi_bypass (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a> capabilities;</div>
<div class="line"> </div>
<div class="line"> wifi = &Driver_WiFi0;</div>
<div class="line"> capabilities = wifi-><a class="code" href="group__wifi__interface__gr.html#a1ced805656e067b5635f1af2292b69e1">GetCapabilities</a> ();</div>
<div class="line"> <span class="keywordflow">if</span> (capabilities.<a class="code" href="group__wifi__control__gr.html#adbcc47408fb8c50d262a3be535108186">bypass_mode</a> == 0) {</div>
<div class="line"> <span class="comment">// error handling </span></div>
<div class="line"> } </div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize and Power-on WiFi Interface</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#a99e597db8e61d0ff834561cb710e61ad">Initialize</a> ((capabilities.eth_rx_frame_event) ? wifi_notify : NULL);</div>
<div class="line"> wifi-><a class="code" href="group__wifi__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="comment">// populate own_mac_address with the address to use for station</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#a6b5e1c7fcea96ff13f6fd16d57c8b68f">SetOption</a>(0U, <a class="code" href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">ARM_WIFI_MAC</a>, &own_mac_address, 6U);</div>
<div class="line"> </div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#a18c6762aa46cec65b65135eaeadebf23">BypassControl</a> (0U, 1U); <span class="comment">// Enable bypass mode for station</span></div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gac1da4619feaf62d0cc90cfe44642d16b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_EthSendFrame </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send Ethernet frame (in bypass mode only). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga13c1123319c7b9a4735d63447f35116b">ARM_DRIVER_ERROR_BUSY</a> : Driver is busy</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or NULL frame pointer)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_EthSendFrame</b> writes an <b>Ethernet frame</b> to the WiFi transmit buffer.</p>
<p>The WiFi bypass mode must be enabled by using the function <a class="el" href="group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e">ARM_WIFI_BypassControl</a> before a call to this function.</p>
<p>The frame data addressed by <em>frame</em> starts with MAC destination and ends with the last Payload data byte. The frame data is copied into the transmit buffer of the WiFi interface.</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><b>Example:</b> </p>
<div class="fragment"><div class="line">status = wifi-><a class="code" href="group__wifi__interface__gr.html#a2648d7e0d1c10c48923d8d20d99311ab">EthSendFrame</a> (0U, &frame_data[0], frame_length);</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="ga1dbeb5528095af31a60560e0c48321d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_EthReadFrame </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 (in bypass mode only). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
<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 error code<ul>
<li>value >= 0 : Number of data bytes read</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or NULL frame pointer)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_EthReadFrame</b> reads an <b>Ethernet frame</b> from the WiFi interface in the bypass mode.</p>
<p>The <em>len</em> of the Ethernet frame can be checked using the function <a class="el" href="group__wifi__bypass__gr.html#gab67442ff061d0c4311a7046bce8d0cd1">ARM_WIFI_EthGetRxFrameSize</a>.</p>
<p>The frame data addressed by <em>frame</em> starts with MAC destination and ends with the last Payload data byte. The frame data is read from the receive buffer of the WiFi interface and the number of bytes written into the memory addressed by <em>frame</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__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> may be called with <em>buf</em> = <span class="XML-Token">NULL</span> and <em>len</em> = <span class="XML-Token">0</span> to discard or release a 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 = wifi-><a class="code" href="group__wifi__interface__gr.html#af7ecc54209ce3725037cb5c9629151cf">EthGetRxFrameSize</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"> wifi-><a class="code" href="group__wifi__interface__gr.html#a544ca40b7157efce5000cd83aa92f8a0">EthReadFrame</a> (NULL, 0); <span class="comment">// Frame error, release it</span></div>
<div class="line">}</div>
<div class="line">len = wifi->ReadFrame (0U, &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="gab67442ff061d0c4311a7046bce8d0cd1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_WIFI_EthGetRxFrameSize </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>Get size of received Ethernet frame (in bypass mode only). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes in received frame</dd></dl>
<p>The function <b>ARM_WIFI_EthGetRxFrameSize</b> returns the size of a received <b>Ethernet frame</b> in the bypass mode. This function can be called before <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> and retrieves the value <em>len</em>.</p>
<p>The frame size includes MAC destination and ends with the last Payload data byte. Value <span class="XML-Token">0</span> 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__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a>.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4">ARM_WIFI_EthReadFrame</a> </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: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__bypass__gr.html | HTML | apache-2.0 | 24,919 |
var group__wifi__bypass__gr =
[
[ "ARM_WIFI_BypassControl", "group__wifi__bypass__gr.html#ga678fa1aa06ca6aaa67c7eb7a7660730e", null ],
[ "ARM_WIFI_EthSendFrame", "group__wifi__bypass__gr.html#gac1da4619feaf62d0cc90cfe44642d16b", null ],
[ "ARM_WIFI_EthReadFrame", "group__wifi__bypass__gr.html#ga1dbeb5528095af31a60560e0c48321d4", null ],
[ "ARM_WIFI_EthGetRxFrameSize", "group__wifi__bypass__gr.html#gab67442ff061d0c4311a7046bce8d0cd1", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__bypass__gr.js | JavaScript | apache-2.0 | 463 |
<!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 Control</title>
<title>CMSIS-Driver: WiFi Control</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__control__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">WiFi Control<div class="ingroups"><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Control functions for the WiFi module.
<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__wifi__event"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__event.html">WiFi Events</a></td></tr>
<tr class="memdesc:group__wifi__event"><td class="mdescLeft"> </td><td class="mdescRight">The WiFi driver generates call back events that are notified via the function <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a>. <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__WIFI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a></td></tr>
<tr class="memdesc:structARM__WIFI__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">WiFi Driver Capabilities. <a href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">More...</a><br/></td></tr>
<tr class="separator:structARM__WIFI__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:gac0f04bbdd431c87a680626154c3e0a41"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">ARM_WIFI_SignalEvent_t</a> )(uint32_t event, void *arg)</td></tr>
<tr class="memdesc:gac0f04bbdd431c87a680626154c3e0a41"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a> : Signal WiFi Event. <a href="#gac0f04bbdd431c87a680626154c3e0a41">More...</a><br/></td></tr>
<tr class="separator:gac0f04bbdd431c87a680626154c3e0a41"><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:gad349fb835926a508e2a33501c0dff6a2"><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__wifi__control__gr.html#gad349fb835926a508e2a33501c0dff6a2">ARM_WIFI_GetVersion</a> (void)</td></tr>
<tr class="memdesc:gad349fb835926a508e2a33501c0dff6a2"><td class="mdescLeft"> </td><td class="mdescRight">Get driver version. <a href="#gad349fb835926a508e2a33501c0dff6a2">More...</a><br/></td></tr>
<tr class="separator:gad349fb835926a508e2a33501c0dff6a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3496996799a4762e9958a8b6af683b4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#ga3496996799a4762e9958a8b6af683b4b">ARM_WIFI_GetCapabilities</a> (void)</td></tr>
<tr class="memdesc:ga3496996799a4762e9958a8b6af683b4b"><td class="mdescLeft"> </td><td class="mdescRight">Get driver capabilities. <a href="#ga3496996799a4762e9958a8b6af683b4b">More...</a><br/></td></tr>
<tr class="separator:ga3496996799a4762e9958a8b6af683b4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc4b9aaae0fdf7d489b1d81e3c2f3474"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">ARM_WIFI_Initialize</a> (<a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">ARM_WIFI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="memdesc:gadc4b9aaae0fdf7d489b1d81e3c2f3474"><td class="mdescLeft"> </td><td class="mdescRight">Initialize WiFi Module. <a href="#gadc4b9aaae0fdf7d489b1d81e3c2f3474">More...</a><br/></td></tr>
<tr class="separator:gadc4b9aaae0fdf7d489b1d81e3c2f3474"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1e488d4ecc365e30712e6b1711a9c5d"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#gae1e488d4ecc365e30712e6b1711a9c5d">ARM_WIFI_Uninitialize</a> (void)</td></tr>
<tr class="memdesc:gae1e488d4ecc365e30712e6b1711a9c5d"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize WiFi Module. <a href="#gae1e488d4ecc365e30712e6b1711a9c5d">More...</a><br/></td></tr>
<tr class="separator:gae1e488d4ecc365e30712e6b1711a9c5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48d4cb7c00e96d2b928cc4468d4e623b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#ga48d4cb7c00e96d2b928cc4468d4e623b">ARM_WIFI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
<tr class="memdesc:ga48d4cb7c00e96d2b928cc4468d4e623b"><td class="mdescLeft"> </td><td class="mdescRight">Control WiFi Module Power. <a href="#ga48d4cb7c00e96d2b928cc4468d4e623b">More...</a><br/></td></tr>
<tr class="separator:ga48d4cb7c00e96d2b928cc4468d4e623b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabdc4c9966a3f22ac6e53119e71e67579"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#gabdc4c9966a3f22ac6e53119e71e67579">ARM_WIFI_GetModuleInfo</a> (char *module_info, uint32_t max_len)</td></tr>
<tr class="memdesc:gabdc4c9966a3f22ac6e53119e71e67579"><td class="mdescLeft"> </td><td class="mdescRight">Get Module information. <a href="#gabdc4c9966a3f22ac6e53119e71e67579">More...</a><br/></td></tr>
<tr class="separator:gabdc4c9966a3f22ac6e53119e71e67579"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0c8243dee4bb161132692516f048bcec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a> (uint32_t event, void *arg)</td></tr>
<tr class="memdesc:ga0c8243dee4bb161132692516f048bcec"><td class="mdescLeft"> </td><td class="mdescRight">Signal WiFi Events. <a href="#ga0c8243dee4bb161132692516f048bcec">More...</a><br/></td></tr>
<tr class="separator:ga0c8243dee4bb161132692516f048bcec"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Control functions for the WiFi module. </p>
<p>The <a class="el" href="group__wifi__control__gr.html">WiFi Control</a> functions setup and control the WiFi module. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__WIFI__CAPABILITIES" id="structARM__WIFI__CAPABILITIES"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_WIFI_CAPABILITIES</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>WiFi Driver Capabilities. </p>
<p>A WiFi driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
<p><b>Returned by:</b></p>
<ul>
<li><a class="el" href="group__wifi__control__gr.html#ga3496996799a4762e9958a8b6af683b4b">ARM_WIFI_GetCapabilities</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3c9e76f6560429efd6dcc41ffd4b67b9"></a>uint32_t</td>
<td class="fieldname">
station: 1</td>
<td class="fielddoc">
Station. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae980bcb85233b9c5904072246ac71dd7"></a>uint32_t</td>
<td class="fieldname">
ap: 1</td>
<td class="fielddoc">
Access Point. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ad280904e2429375205c09e53fe8cdcb1"></a>uint32_t</td>
<td class="fieldname">
station_ap: 1</td>
<td class="fielddoc">
Concurrent Station and Access Point. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a87476544767703fc9f45f81b16cd4429"></a>uint32_t</td>
<td class="fieldname">
wps_station: 1</td>
<td class="fielddoc">
WiFi Protected Setup (WPS) for Station. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7689c7dd824016b1962854a86d23d141"></a>uint32_t</td>
<td class="fieldname">
wps_ap: 1</td>
<td class="fielddoc">
WiFi Protected Setup (WPS) for Access Point. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9fc191093a9bc356c3d85e9cbf185620"></a>uint32_t</td>
<td class="fieldname">
event_ap_connect: 1</td>
<td class="fielddoc">
Access Point: event generated on Station connect. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a18a7e7fe3a4f48548af6db6c825cc427"></a>uint32_t</td>
<td class="fieldname">
event_ap_disconnect: 1</td>
<td class="fielddoc">
Access Point: event generated on Station disconnect. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ac4c6eadec013cf8a11b8eca66b809431"></a>uint32_t</td>
<td class="fieldname">
event_eth_rx_frame: 1</td>
<td class="fielddoc">
Event generated on Ethernet frame reception in bypass mode. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="adbcc47408fb8c50d262a3be535108186"></a>uint32_t</td>
<td class="fieldname">
bypass_mode: 1</td>
<td class="fielddoc">
Bypass or pass-through mode (Ethernet interface) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a69ddb9c845da426f636d9dd0dbed4e7e"></a>uint32_t</td>
<td class="fieldname">
ip: 1</td>
<td class="fielddoc">
IP (UDP/TCP) (Socket interface) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aad13478539ad093fabafd1804acac4a2"></a>uint32_t</td>
<td class="fieldname">
ip6: 1</td>
<td class="fielddoc">
IPv6 (Socket interface) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aef01bbaa48bdb4fba71684d8f31eb0b1"></a>uint32_t</td>
<td class="fieldname">
ping: 1</td>
<td class="fielddoc">
Ping (ICMP) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
<td class="fieldname">
reserved: 20</td>
<td class="fielddoc">
Reserved (must be zero) </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gac0f04bbdd431c87a680626154c3e0a41"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ARM_WIFI_SignalEvent_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a> : Signal WiFi Event. </p>
<p>Provides the typedef for the callback function <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a>.</p>
<p><b>Parameter for:</b></p>
<ul>
<li><a class="el" href="group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">ARM_WIFI_Initialize</a> </li>
</ul>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad349fb835926a508e2a33501c0dff6a2"></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_WIFI_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_WIFI_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>
<p>API version is the version of the CMSIS-Driver specification used to implement this driver. Driver version is source code version of the actual driver implementation.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> get_wifi_version (<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"> wifi= &Driver_WiFi0; </div>
<div class="line"> version = wifi-><a class="code" href="group__wifi__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> < 0x100U) { <span class="comment">// requires at minimum API version 1.0 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="ga3496996799a4762e9958a8b6af683b4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a> ARM_WIFI_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__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a></dd></dl>
<p>The function <b>ARM_WIFI_GetCapabilities</b> retrieves information about capabilities in this driver implementation. The data fields of the struct <a class="el" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a> encode various capabilities, for example if a WiFi module supports the Access Point mode or the bypass mode, or is capable to signal events using the <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a> callback function.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> get_wifi_capabilities (<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a> capabilities;</div>
<div class="line"> </div>
<div class="line"> wifi = &Driver_WiFi0; </div>
<div class="line"> capabilities = wifi-><a class="code" href="group__wifi__interface__gr.html#a1ced805656e067b5635f1af2292b69e1">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="gadc4b9aaae0fdf7d489b1d81e3c2f3474"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">ARM_WIFI_SignalEvent_t</a> </td>
<td class="paramname"><em>cb_event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize WiFi Module. </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__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">ARM_WIFI_SignalEvent_t</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_Initialize</b> initializes the WiFi module.</p>
<p>It is called when the middleware component starts operation.</p>
<p>The <a class="el" href="group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">ARM_WIFI_Initialize</a> function performs the following operations:</p>
<ul>
<li>Initializes the resources and peripherals required for the WiFi module.</li>
<li>Registers the <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a> callback function.</li>
</ul>
<p>The parameter <em>cb_event</em> is a pointer to the <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a> callback function; use a <span class="XML-Token">NULL</span> pointer when no callback signals are required.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</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"> </div>
<div class="line"><span class="keywordtype">void</span> initialize_wifi (<span class="keywordtype">void</span>) {</div>
<div class="line"> wifi = &Driver_WiFi0;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize and Power-on WiFi Module</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#a99e597db8e61d0ff834561cb710e61ad">Initialize</a> (NULL);</div>
<div class="line"> wifi-><a class="code" href="group__wifi__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="comment">// Populate own_mac_address with the address to use</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#a6b5e1c7fcea96ff13f6fd16d57c8b68f">SetOption</a>(<a class="code" href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">ARM_WIFI_MAC</a>, &own_mac_address, 6U);</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gae1e488d4ecc365e30712e6b1711a9c5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_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 WiFi Module. </p>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_Uninitialize</b> de-initializes the resources of the WiFi module.</p>
<p>It is called when the middleware component stops operation and releases the software resources used by the module.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> uninitialize_wifi (<span class="keywordtype">void</span>) {</div>
<div class="line"> wifi = &Driver_WiFi0;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Power off and De-initialize WiFi Module</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef">PowerControl</a> (<a class="code" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a>);</div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> ();</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga48d4cb7c00e96d2b928cc4468d4e623b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_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 WiFi Module 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: sleep or deep-sleep depending on <a class="el" href="group__WiFi__option.html#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4">ARM_WIFI_LP_TIMER</a> option set</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>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid state)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_PowerControl</b> allows you to configure the power modes of the WiFi module.</p>
<p>The parameter <em>state</em> specifies the <a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>.</p>
<p>Low-power mode depends on additional options set by <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a> :</p>
<ul>
<li>Deep-sleep mode is entered when <a class="el" href="group__WiFi__option.html#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4">ARM_WIFI_LP_TIMER</a> option is set to a value different than 0</li>
<li>Sleep mode is entered otherwise</li>
</ul>
<p><b>Deep-sleep</b> mode (only for station): Module turns off the radio and also internal CPU thus reducing power consumption to minimum, only the timer is running that wakes-up the module after specified time. When timer expires the module reconnects to the access point.</p>
<p>This mode is used when power consumption is a priority (battery powered devices) and when WiFi is used in short intervals that do not occur very often (example: sending a temperature from a sensor to a cloud every 10 seconds).</p>
<p><b>Sleep</b> mode (only for station): Module reduces power consumption by going into sleep and waking up periodically to listen for beacons.</p>
<p>Delivery Traffic Indication Message (DTIM) interval can be configured with option <a class="el" href="group__WiFi__option.html#ga947c297f1364993524bf515beba296f1">ARM_WIFI_DTIM</a> (station and access point) and beacon interval with option <a class="el" href="group__WiFi__option.html#ga6171d24c661b54465ced2dae7980897c">ARM_WIFI_BEACON</a> (only for access point).</p>
<p>Default module intervals are used when those options are not explicitly set.</p>
<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__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">ARM_WIFI_Initialize</a></li>
<li>see <a class="el" href="group__wifi__control__gr.html#gae1e488d4ecc365e30712e6b1711a9c5d">ARM_WIFI_Uninitialize</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="gabdc4c9966a3f22ac6e53119e71e67579"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_GetModuleInfo </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>module_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>max_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Module information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">module_info</td><td>Pointer to character buffer were info string will be returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>Maximum length of string to return (including null terminator) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (NULL module_info pointer or max_len equals to 0)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_GetModuleInfo</b> retrieves string containing information about the WiFi module.</p>
<p>The information might include module name, firmware version, ...</p>
<dl class="section note"><dt>Note</dt><dd>Module must be initialized and powered before module information can be retrieved.</dd></dl>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> Driver_WiFi0;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> *wifi;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> initialize_wifi (<span class="keywordtype">void</span>) {</div>
<div class="line"> <span class="keywordtype">char</span> info[32];</div>
<div class="line"> </div>
<div class="line"> wifi = &Driver_WiFi0;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize and Power-on WiFi Module</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#a99e597db8e61d0ff834561cb710e61ad">Initialize</a> (NULL);</div>
<div class="line"> wifi-><a class="code" href="group__wifi__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="comment">// Retrieve module information</span></div>
<div class="line"> wifi-><a class="code" href="group__wifi__interface__gr.html#aa78e745bbf8257a3438700e4e6a8d222">GetModuleInfo</a>(&info, <span class="keyword">sizeof</span>(info));</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga0c8243dee4bb161132692516f048bcec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARM_WIFI_SignalEvent </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </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>Signal WiFi Events. </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__wifi__event.html">WiFi Events</a> notification mask </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Pointer to argument of signaled event </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function <b>ARM_WIFI_SignalEvent</b> is a callback function registered by the function <a class="el" href="group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474">ARM_WIFI_Initialize</a>. It is called by the WiFi driver to notify the application about WiFi Events occurred during operation.</p>
<p>The parameter <em>event</em> indicates the event that occurred during driver operation.</p>
<p>The parameter <em>arg</em> provides additional information about the event.</p>
<p>The following events can be generated:</p>
<table class="doxtable">
<tr>
<th align="left">Parameter <em>event</em> </th><th align="left">Description </th></tr>
<tr>
<td align="left"><a class="el" href="group__wifi__event.html#ga4a87b9a3c3a404e3917d54df98469a62">ARM_WIFI_EVENT_AP_CONNECT</a> </td><td align="left">Occurs in access point mode when a station has connected to the access point. </td></tr>
<tr>
<td align="left"><a class="el" href="group__wifi__event.html#ga271e73cda122e7ec3c5a5ca71d44eae3">ARM_WIFI_EVENT_AP_DISCONNECT</a> </td><td align="left">Occurs in access point mode when a station has disconnected from the access point. </td></tr>
<tr>
<td align="left"><a class="el" href="group__wifi__event.html#ga833f2c7a47bd2523d7a62ff6506a997f">ARM_WIFI_EVENT_ETH_RX_FRAME</a> </td><td align="left">Occurs in <a class="el" href="group__wifi__bypass__gr.html">WiFi Bypass Mode</a> when an ethernet frame is received. </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: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__control__gr.html | HTML | apache-2.0 | 40,344 |
var group__wifi__control__gr =
[
[ "WiFi Events", "group__wifi__event.html", "group__wifi__event" ],
[ "ARM_WIFI_CAPABILITIES", "group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES", [
[ "station", "group__wifi__control__gr.html#a3c9e76f6560429efd6dcc41ffd4b67b9", null ],
[ "ap", "group__wifi__control__gr.html#ae980bcb85233b9c5904072246ac71dd7", null ],
[ "station_ap", "group__wifi__control__gr.html#ad280904e2429375205c09e53fe8cdcb1", null ],
[ "wps_station", "group__wifi__control__gr.html#a87476544767703fc9f45f81b16cd4429", null ],
[ "wps_ap", "group__wifi__control__gr.html#a7689c7dd824016b1962854a86d23d141", null ],
[ "event_ap_connect", "group__wifi__control__gr.html#a9fc191093a9bc356c3d85e9cbf185620", null ],
[ "event_ap_disconnect", "group__wifi__control__gr.html#a18a7e7fe3a4f48548af6db6c825cc427", null ],
[ "event_eth_rx_frame", "group__wifi__control__gr.html#ac4c6eadec013cf8a11b8eca66b809431", null ],
[ "bypass_mode", "group__wifi__control__gr.html#adbcc47408fb8c50d262a3be535108186", null ],
[ "ip", "group__wifi__control__gr.html#a69ddb9c845da426f636d9dd0dbed4e7e", null ],
[ "ip6", "group__wifi__control__gr.html#aad13478539ad093fabafd1804acac4a2", null ],
[ "ping", "group__wifi__control__gr.html#aef01bbaa48bdb4fba71684d8f31eb0b1", null ],
[ "reserved", "group__wifi__control__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
] ],
[ "ARM_WIFI_SignalEvent_t", "group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41", null ],
[ "ARM_WIFI_GetVersion", "group__wifi__control__gr.html#gad349fb835926a508e2a33501c0dff6a2", null ],
[ "ARM_WIFI_GetCapabilities", "group__wifi__control__gr.html#ga3496996799a4762e9958a8b6af683b4b", null ],
[ "ARM_WIFI_Initialize", "group__wifi__control__gr.html#gadc4b9aaae0fdf7d489b1d81e3c2f3474", null ],
[ "ARM_WIFI_Uninitialize", "group__wifi__control__gr.html#gae1e488d4ecc365e30712e6b1711a9c5d", null ],
[ "ARM_WIFI_PowerControl", "group__wifi__control__gr.html#ga48d4cb7c00e96d2b928cc4468d4e623b", null ],
[ "ARM_WIFI_GetModuleInfo", "group__wifi__control__gr.html#gabdc4c9966a3f22ac6e53119e71e67579", null ],
[ "ARM_WIFI_SignalEvent", "group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__control__gr.js | JavaScript | apache-2.0 | 2,314 |
var group__wifi__control__gr_structARM__WIFI__CAPABILITIES =
[
[ "station", "group__wifi__control__gr.html#a3c9e76f6560429efd6dcc41ffd4b67b9", null ],
[ "ap", "group__wifi__control__gr.html#ae980bcb85233b9c5904072246ac71dd7", null ],
[ "station_ap", "group__wifi__control__gr.html#ad280904e2429375205c09e53fe8cdcb1", null ],
[ "wps_station", "group__wifi__control__gr.html#a87476544767703fc9f45f81b16cd4429", null ],
[ "wps_ap", "group__wifi__control__gr.html#a7689c7dd824016b1962854a86d23d141", null ],
[ "event_ap_connect", "group__wifi__control__gr.html#a9fc191093a9bc356c3d85e9cbf185620", null ],
[ "event_ap_disconnect", "group__wifi__control__gr.html#a18a7e7fe3a4f48548af6db6c825cc427", null ],
[ "event_eth_rx_frame", "group__wifi__control__gr.html#ac4c6eadec013cf8a11b8eca66b809431", null ],
[ "bypass_mode", "group__wifi__control__gr.html#adbcc47408fb8c50d262a3be535108186", null ],
[ "ip", "group__wifi__control__gr.html#a69ddb9c845da426f636d9dd0dbed4e7e", null ],
[ "ip6", "group__wifi__control__gr.html#aad13478539ad093fabafd1804acac4a2", null ],
[ "ping", "group__wifi__control__gr.html#aef01bbaa48bdb4fba71684d8f31eb0b1", null ],
[ "reserved", "group__wifi__control__gr.html#aa43c4c21b173ada1b6b7568956f0d650", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__control__gr_structARM__WIFI__CAPABILITIES.js | JavaScript | apache-2.0 | 1,286 |
<!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 DHCPv6 Mode</title>
<title>CMSIS-Driver: WiFi DHCPv6 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__wifi__dhcp__v6__mode.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 DHCPv6 Mode<div class="ingroups"><a class="el" href="group__wifi__management__gr.html">WiFi Management</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode.
<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:gaf200f735500dc647bc665f60a2df7552"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__dhcp__v6__mode.html#gaf200f735500dc647bc665f60a2df7552">ARM_WIFI_IP6_DHCP_OFF</a>   0U</td></tr>
<tr class="memdesc:gaf200f735500dc647bc665f60a2df7552"><td class="mdescLeft"> </td><td class="mdescRight">Static Host Configuration (default) <a href="#gaf200f735500dc647bc665f60a2df7552">More...</a><br/></td></tr>
<tr class="separator:gaf200f735500dc647bc665f60a2df7552"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d63d8029532c586703c77f1c8f990fc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__dhcp__v6__mode.html#ga9d63d8029532c586703c77f1c8f990fc">ARM_WIFI_IP6_DHCP_STATELESS</a>   1U</td></tr>
<tr class="memdesc:ga9d63d8029532c586703c77f1c8f990fc"><td class="mdescLeft"> </td><td class="mdescRight">Dynamic Host Configuration stateless DHCPv6. <a href="#ga9d63d8029532c586703c77f1c8f990fc">More...</a><br/></td></tr>
<tr class="separator:ga9d63d8029532c586703c77f1c8f990fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga205f9604967e290c053952cab850841a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__dhcp__v6__mode.html#ga205f9604967e290c053952cab850841a">ARM_WIFI_IP6_DHCP_STATEFULL</a>   2U</td></tr>
<tr class="memdesc:ga205f9604967e290c053952cab850841a"><td class="mdescLeft"> </td><td class="mdescRight">Dynamic Host Configuration statefull DHCPv6. <a href="#ga205f9604967e290c053952cab850841a">More...</a><br/></td></tr>
<tr class="separator:ga205f9604967e290c053952cab850841a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode. </p>
<p>The WiFi DHCPv6 mode defines the DHCP mode in IPv6. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf200f735500dc647bc665f60a2df7552"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_DHCP_OFF   0U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Static Host Configuration (default) </p>
<p>In the static host configuration mode, the IPv6 address, the default gateway address, and the addresses of DNS servers are statically configured from the preset values. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__dhcp__v6__mode.html" title="Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode. ">WiFi DHCPv6 Mode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9d63d8029532c586703c77f1c8f990fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_DHCP_STATELESS   1U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dynamic Host Configuration stateless DHCPv6. </p>
<p>In the stateless DHCP configuration mode, the client obtains only extended information from a DHCPv6 server, such as DNS server addresses. Stateless auto-configuration of IPv6 allows the client device to self configure it's IPv6 addresses and routing based on the router advertisements. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__dhcp__v6__mode.html" title="Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode. ">WiFi DHCPv6 Mode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga205f9604967e290c053952cab850841a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_IP6_DHCP_STATEFULL   2U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dynamic Host Configuration statefull DHCPv6. </p>
<p>In the stateful DHCP configuration mode, the client connects to a DHCPv6 server for a leased IPv6 address and DNS server addresses. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__dhcp__v6__mode.html" title="Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode. ">WiFi DHCPv6 Mode</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__dhcp__v6__mode.html | HTML | apache-2.0 | 11,167 |
var group__wifi__dhcp__v6__mode =
[
[ "ARM_WIFI_IP6_DHCP_OFF", "group__wifi__dhcp__v6__mode.html#gaf200f735500dc647bc665f60a2df7552", null ],
[ "ARM_WIFI_IP6_DHCP_STATELESS", "group__wifi__dhcp__v6__mode.html#ga9d63d8029532c586703c77f1c8f990fc", null ],
[ "ARM_WIFI_IP6_DHCP_STATEFULL", "group__wifi__dhcp__v6__mode.html#ga205f9604967e290c053952cab850841a", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__dhcp__v6__mode.js | JavaScript | apache-2.0 | 379 |
<!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 Events</title>
<title>CMSIS-Driver: WiFi 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__wifi__event.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 Events<div class="ingroups"><a class="el" href="group__wifi__control__gr.html">WiFi Control</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The WiFi driver generates call back events that are notified via the function <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_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:ga4a87b9a3c3a404e3917d54df98469a62"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__event.html#ga4a87b9a3c3a404e3917d54df98469a62">ARM_WIFI_EVENT_AP_CONNECT</a>   (1UL << 0)</td></tr>
<tr class="memdesc:ga4a87b9a3c3a404e3917d54df98469a62"><td class="mdescLeft"> </td><td class="mdescRight">Access Point: Station has connected; arg = &mac, mac (uint8_t[6]) <a href="#ga4a87b9a3c3a404e3917d54df98469a62">More...</a><br/></td></tr>
<tr class="separator:ga4a87b9a3c3a404e3917d54df98469a62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga271e73cda122e7ec3c5a5ca71d44eae3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__event.html#ga271e73cda122e7ec3c5a5ca71d44eae3">ARM_WIFI_EVENT_AP_DISCONNECT</a>   (1UL << 1)</td></tr>
<tr class="memdesc:ga271e73cda122e7ec3c5a5ca71d44eae3"><td class="mdescLeft"> </td><td class="mdescRight">Access Point: Station has disconnected; arg = &mac, mac (uint8_t[6]) <a href="#ga271e73cda122e7ec3c5a5ca71d44eae3">More...</a><br/></td></tr>
<tr class="separator:ga271e73cda122e7ec3c5a5ca71d44eae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga833f2c7a47bd2523d7a62ff6506a997f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__event.html#ga833f2c7a47bd2523d7a62ff6506a997f">ARM_WIFI_EVENT_ETH_RX_FRAME</a>   (1UL << 4)</td></tr>
<tr class="memdesc:ga833f2c7a47bd2523d7a62ff6506a997f"><td class="mdescLeft"> </td><td class="mdescRight">Ethernet Frame Received (in bypass mode only); arg = interface (0 = Station, 1 = Access Point) <a href="#ga833f2c7a47bd2523d7a62ff6506a997f">More...</a><br/></td></tr>
<tr class="separator:ga833f2c7a47bd2523d7a62ff6506a997f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>The WiFi driver generates call back events that are notified via the function <a class="el" href="group__wifi__control__gr.html#ga0c8243dee4bb161132692516f048bcec">ARM_WIFI_SignalEvent</a>. </p>
<p>The following call back notification events are generated: </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga4a87b9a3c3a404e3917d54df98469a62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_EVENT_AP_CONNECT   (1UL << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Access Point: Station has connected; arg = &mac, mac (uint8_t[6]) </p>
</div>
</div>
<a class="anchor" id="ga271e73cda122e7ec3c5a5ca71d44eae3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_EVENT_AP_DISCONNECT   (1UL << 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Access Point: Station has disconnected; arg = &mac, mac (uint8_t[6]) </p>
</div>
</div>
<a class="anchor" id="ga833f2c7a47bd2523d7a62ff6506a997f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_EVENT_ETH_RX_FRAME   (1UL << 4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ethernet Frame Received (in bypass mode only); arg = interface (0 = Station, 1 = Access Point) </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__wifi__event.html | HTML | apache-2.0 | 10,463 |
var group__wifi__event =
[
[ "ARM_WIFI_EVENT_AP_CONNECT", "group__wifi__event.html#ga4a87b9a3c3a404e3917d54df98469a62", null ],
[ "ARM_WIFI_EVENT_AP_DISCONNECT", "group__wifi__event.html#ga271e73cda122e7ec3c5a5ca71d44eae3", null ],
[ "ARM_WIFI_EVENT_ETH_RX_FRAME", "group__wifi__event.html#ga833f2c7a47bd2523d7a62ff6506a997f", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__event.js | JavaScript | apache-2.0 | 348 |
<!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 Interface</title>
<title>CMSIS-Driver: WiFi 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__wifi__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> </div>
<div class="headertitle">
<div class="title">WiFi Interface</div> </div>
</div><!--header-->
<div class="contents">
<p>Driver API for WiFi (Driver_WiFi.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__wifi__control__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__control__gr.html">WiFi Control</a></td></tr>
<tr class="memdesc:group__wifi__control__gr"><td class="mdescLeft"> </td><td class="mdescRight">Control functions for the WiFi module. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__wifi__management__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html">WiFi Management</a></td></tr>
<tr class="memdesc:group__wifi__management__gr"><td class="mdescLeft"> </td><td class="mdescRight">Configure and manage the connection to a WiFi access point (AP) or configure and manage the access point (AP). <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__wifi__bypass__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__bypass__gr.html">WiFi Bypass Mode</a></td></tr>
<tr class="memdesc:group__wifi__bypass__gr"><td class="mdescLeft"> </td><td class="mdescRight">Transfer Ethernet frames by WiFi module. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__wifi__socket__gr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a></td></tr>
<tr class="memdesc:group__wifi__socket__gr"><td class="mdescLeft"> </td><td class="mdescRight">Socket interface to IP stack running on WiFi module. <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__WIFI"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a></td></tr>
<tr class="memdesc:structARM__DRIVER__WIFI"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the WiFi Driver. <a href="group__wifi__interface__gr.html#structARM__DRIVER__WIFI">More...</a><br/></td></tr>
<tr class="separator:structARM__DRIVER__WIFI"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Driver API for WiFi (Driver_WiFi.h) </p>
<p>Wi-Fi is technology for radio wireless local area networking of devices. Wi-Fi compatible devices typically connect to the Internet via a WLAN and a wireless access point (AP) also called hotspot.</p>
<p>Wikipedia offers more information about the <a href="http://en.wikipedia.org/wiki/Ethernet" target="_blank"><b>WiFi</b></a>.</p>
<p><b>Driver Block Diagram</b></p>
<div class="image">
<img src="WiFi.png" alt="WiFi.png"/>
<div class="caption">
Block Diagram of the WiFi interface</div></div>
<p> <b>WiFi API</b></p>
<p>The following header files define the Application Programming Interface (API) for the WiFi interface:</p>
<ul>
<li><b>Driver_WiFi.h</b> : Driver API for WiFi</li>
</ul>
<p>The CMSIS-Driver WiFi provides access to the following interfaces:</p>
<ul>
<li><a class="el" href="group__wifi__control__gr.html">Control interface</a>: setup and control the WiFi module.</li>
<li><a class="el" href="group__wifi__management__gr.html">Management interface</a>: allows you to configure and manage the connection to the WiFi access point (AP) or configure and manage the access point (AP).</li>
<li><a class="el" href="group__wifi__socket__gr.html">Socket interface</a>: provides the interface to an IP stack that is running on the WiFi module. This IP stack handles data communication.</li>
<li><a class="el" href="group__wifi__bypass__gr.html">Bypass interface</a>: is an optional interface and enables the transmission of Ethernet frames with the WiFi module. Using this interface requires the IP stack running on the microcontroller.</li>
</ul>
<p>The WiFi interface usually requires CMSIS-RTOS features (i.e. mutex) and is often implemented with a peripheral device that is connected to the system using the SPI or UART interface. However, there are also some microcontroller devices with WiFi interface on the chip.</p>
<p>The implementation of the WiFi CMSIS-Driver is therefore generally provided as a separate software pack. It is often implemented as wrapper to the SDK (Software Development Kit) of the WiFi chipset.</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__wifi__interface__gr.html#structARM__DRIVER__WIFI">ARM_DRIVER_WIFI</a> : access struct for WiFi driver functions</li>
</ul>
<p><b>Example Code</b> </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__DRIVER__WIFI" id="structARM__DRIVER__WIFI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_DRIVER_WIFI</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Access structure of the WiFi Driver. </p>
<p>The functions of the WiFi driver 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 WiFi interface 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_WiFi0</b> is the name of the access struct of the first instance (no. <span class="XML-Token">0</span>).</li>
<li><b>Driver_WiFi1</b> is the name of the access struct of the second instance (no. <span class="XML-Token">1</span>).</li>
</ul>
<p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_WiFi<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__wifi__interface__gr.html#a8834b281da48583845c044a81566c1b3">GetVersion</a> )(void)</td></tr>
<tr class="separator:a8834b281da48583845c044a81566c1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ced805656e067b5635f1af2292b69e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a1ced805656e067b5635f1af2292b69e1">GetCapabilities</a> )(void)</td></tr>
<tr class="separator:a1ced805656e067b5635f1af2292b69e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99e597db8e61d0ff834561cb710e61ad"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a99e597db8e61d0ff834561cb710e61ad">Initialize</a> )(<a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">ARM_WIFI_SignalEvent_t</a> cb_event)</td></tr>
<tr class="separator:a99e597db8e61d0ff834561cb710e61ad"><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__wifi__interface__gr.html#adcf20681a1402869ecb5c6447fada17b">Uninitialize</a> )(void)</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__wifi__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="separator:aba8f1c8019af95ffe19c32403e3240ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa78e745bbf8257a3438700e4e6a8d222"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#aa78e745bbf8257a3438700e4e6a8d222">GetModuleInfo</a> )(char *module_info, uint32_t max_len)</td></tr>
<tr class="separator:aa78e745bbf8257a3438700e4e6a8d222"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b5e1c7fcea96ff13f6fd16d57c8b68f"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a6b5e1c7fcea96ff13f6fd16d57c8b68f">SetOption</a> )(uint32_t interface, uint32_t option, const void *data, uint32_t len)</td></tr>
<tr class="separator:a6b5e1c7fcea96ff13f6fd16d57c8b68f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af264a580d36c33a649b64be845458b03"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#af264a580d36c33a649b64be845458b03">GetOption</a> )(uint32_t interface, uint32_t option, void *data, uint32_t *len)</td></tr>
<tr class="separator:af264a580d36c33a649b64be845458b03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51d027ef7046c413372103aa952772fb"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a51d027ef7046c413372103aa952772fb">Scan</a> )(<a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">ARM_WIFI_SCAN_INFO_t</a> scan_info[], uint32_t max_num)</td></tr>
<tr class="separator:a51d027ef7046c413372103aa952772fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a444ea7bda2c45eab34050d2a895baeec"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a444ea7bda2c45eab34050d2a895baeec">Activate</a> )(uint32_t interface, const <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> *config)</td></tr>
<tr class="separator:a444ea7bda2c45eab34050d2a895baeec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9a38e69c7b7face914560e872378ed1"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#ae9a38e69c7b7face914560e872378ed1">Deactivate</a> )(uint32_t interface)</td></tr>
<tr class="separator:ae9a38e69c7b7face914560e872378ed1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9771e89a155d316e0b44d3ee89081d3"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#ab9771e89a155d316e0b44d3ee89081d3">IsConnected</a> )(void)</td></tr>
<tr class="separator:ab9771e89a155d316e0b44d3ee89081d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac17eb39c11b7797b88a1f6e0f8cc772d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#ac17eb39c11b7797b88a1f6e0f8cc772d">GetNetInfo</a> )(<a class="el" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">ARM_WIFI_NET_INFO_t</a> *net_info)</td></tr>
<tr class="separator:ac17eb39c11b7797b88a1f6e0f8cc772d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18c6762aa46cec65b65135eaeadebf23"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a18c6762aa46cec65b65135eaeadebf23">BypassControl</a> )(uint32_t interface, uint32_t mode)</td></tr>
<tr class="separator:a18c6762aa46cec65b65135eaeadebf23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2648d7e0d1c10c48923d8d20d99311ab"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a2648d7e0d1c10c48923d8d20d99311ab">EthSendFrame</a> )(uint32_t interface, const uint8_t *frame, uint32_t len)</td></tr>
<tr class="separator:a2648d7e0d1c10c48923d8d20d99311ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a544ca40b7157efce5000cd83aa92f8a0"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a544ca40b7157efce5000cd83aa92f8a0">EthReadFrame</a> )(uint32_t interface, uint8_t *frame, uint32_t len)</td></tr>
<tr class="separator:a544ca40b7157efce5000cd83aa92f8a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7ecc54209ce3725037cb5c9629151cf"><td class="memItemLeft" align="right" valign="top">uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#af7ecc54209ce3725037cb5c9629151cf">EthGetRxFrameSize</a> )(uint32_t interface)</td></tr>
<tr class="separator:af7ecc54209ce3725037cb5c9629151cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa26f0cefe99161484741977a5443e92c"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#aa26f0cefe99161484741977a5443e92c">SocketCreate</a> )(int32_t af, int32_t type, int32_t protocol)</td></tr>
<tr class="separator:aa26f0cefe99161484741977a5443e92c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcbc0c2bb3639584521ffeaaffc5a475"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#afcbc0c2bb3639584521ffeaaffc5a475">SocketBind</a> )(int32_t socket, const uint8_t *ip, uint32_t ip_len, uint16_t port)</td></tr>
<tr class="separator:afcbc0c2bb3639584521ffeaaffc5a475"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a628706c754e1793ec864453a5b517d5c"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a628706c754e1793ec864453a5b517d5c">SocketListen</a> )(int32_t socket, int32_t backlog)</td></tr>
<tr class="separator:a628706c754e1793ec864453a5b517d5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66bb43c1e713efe7758b6e100c13ed69"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a66bb43c1e713efe7758b6e100c13ed69">SocketAccept</a> )(int32_t socket, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td></tr>
<tr class="separator:a66bb43c1e713efe7758b6e100c13ed69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45cbca28d9866f2ec2ad9df830787dd7"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a45cbca28d9866f2ec2ad9df830787dd7">SocketConnect</a> )(int32_t socket, const uint8_t *ip, uint32_t ip_len, uint16_t port)</td></tr>
<tr class="separator:a45cbca28d9866f2ec2ad9df830787dd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaad6683992e76e3dd9a16eb6b7d43cf4"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#aaad6683992e76e3dd9a16eb6b7d43cf4">SocketRecv</a> )(int32_t socket, void *buf, uint32_t len)</td></tr>
<tr class="separator:aaad6683992e76e3dd9a16eb6b7d43cf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4343cf48bbcfb2101a422d90c34f84e6"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a4343cf48bbcfb2101a422d90c34f84e6">SocketRecvFrom</a> )(int32_t socket, void *buf, uint32_t len, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td></tr>
<tr class="separator:a4343cf48bbcfb2101a422d90c34f84e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ff47d391831d547d310dd66f22c2942"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a7ff47d391831d547d310dd66f22c2942">SocketSend</a> )(int32_t socket, const void *buf, uint32_t len)</td></tr>
<tr class="separator:a7ff47d391831d547d310dd66f22c2942"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a248a293faea6f6e1cb781b8153e468fa"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a248a293faea6f6e1cb781b8153e468fa">SocketSendTo</a> )(int32_t socket, const void *buf, uint32_t len, const uint8_t *ip, uint32_t ip_len, uint16_t port)</td></tr>
<tr class="separator:a248a293faea6f6e1cb781b8153e468fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7c3e0211c87bf99e9c42b17a2249f50"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#ab7c3e0211c87bf99e9c42b17a2249f50">SocketGetSockName</a> )(int32_t socket, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td></tr>
<tr class="separator:ab7c3e0211c87bf99e9c42b17a2249f50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac45fbc58fd00742cbe712bf26d857359"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#ac45fbc58fd00742cbe712bf26d857359">SocketGetPeerName</a> )(int32_t socket, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td></tr>
<tr class="separator:ac45fbc58fd00742cbe712bf26d857359"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4771324fb6f39fb2837e98d9f0ed48ed"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a4771324fb6f39fb2837e98d9f0ed48ed">SocketGetOpt</a> )(int32_t socket, int32_t opt_id, void *opt_val, uint32_t *opt_len)</td></tr>
<tr class="separator:a4771324fb6f39fb2837e98d9f0ed48ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7019060d0869a7dfae8e31aedb46815d"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a7019060d0869a7dfae8e31aedb46815d">SocketSetOpt</a> )(int32_t socket, int32_t opt_id, const void *opt_val, uint32_t opt_len)</td></tr>
<tr class="separator:a7019060d0869a7dfae8e31aedb46815d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a471a1be6d9adbccb83ca1f268643031c"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a471a1be6d9adbccb83ca1f268643031c">SocketClose</a> )(int32_t socket)</td></tr>
<tr class="separator:a471a1be6d9adbccb83ca1f268643031c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62b2512cbaef03d26eb9c1e3004c3364"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#a62b2512cbaef03d26eb9c1e3004c3364">SocketGetHostByName</a> )(const char *name, int32_t af, uint8_t *ip, uint32_t *ip_len)</td></tr>
<tr class="separator:a62b2512cbaef03d26eb9c1e3004c3364"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8f218e434e2f327335b16cdb4f21f65"><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__interface__gr.html#ad8f218e434e2f327335b16cdb4f21f65">Ping</a> )(const uint8_t *ip, uint32_t ip_len)</td></tr>
<tr class="separator:ad8f218e434e2f327335b16cdb4f21f65"><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">
</div>
</div>
<a class="anchor" id="a1ced805656e067b5635f1af2292b69e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__wifi__control__gr.html#structARM__WIFI__CAPABILITIES">ARM_WIFI_CAPABILITIES</a>(* GetCapabilities)(void)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a99e597db8e61d0ff834561cb710e61ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Initialize)(<a class="el" href="group__wifi__control__gr.html#gac0f04bbdd431c87a680626154c3e0a41">ARM_WIFI_SignalEvent_t</a> cb_event)</td>
</tr>
</table>
</div><div class="memdoc">
</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">
</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">
</div>
</div>
<a class="anchor" id="aa78e745bbf8257a3438700e4e6a8d222"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetModuleInfo)(char *module_info, uint32_t max_len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6b5e1c7fcea96ff13f6fd16d57c8b68f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SetOption)(uint32_t interface, uint32_t option, const void *data, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af264a580d36c33a649b64be845458b03"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetOption)(uint32_t interface, uint32_t option, void *data, uint32_t *len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a51d027ef7046c413372103aa952772fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Scan)(<a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">ARM_WIFI_SCAN_INFO_t</a> scan_info[], uint32_t max_num)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a444ea7bda2c45eab34050d2a895baeec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Activate)(uint32_t interface, const <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> *config)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae9a38e69c7b7face914560e872378ed1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Deactivate)(uint32_t interface)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab9771e89a155d316e0b44d3ee89081d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* IsConnected)(void)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac17eb39c11b7797b88a1f6e0f8cc772d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* GetNetInfo)(<a class="el" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">ARM_WIFI_NET_INFO_t</a> *net_info)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a18c6762aa46cec65b65135eaeadebf23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* BypassControl)(uint32_t interface, uint32_t mode)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2648d7e0d1c10c48923d8d20d99311ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EthSendFrame)(uint32_t interface, const uint8_t *frame, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a544ca40b7157efce5000cd83aa92f8a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* EthReadFrame)(uint32_t interface, uint8_t *frame, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af7ecc54209ce3725037cb5c9629151cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t(* EthGetRxFrameSize)(uint32_t interface)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa26f0cefe99161484741977a5443e92c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketCreate)(int32_t af, int32_t type, int32_t protocol)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afcbc0c2bb3639584521ffeaaffc5a475"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketBind)(int32_t socket, const uint8_t *ip, uint32_t ip_len, uint16_t port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a628706c754e1793ec864453a5b517d5c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketListen)(int32_t socket, int32_t backlog)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a66bb43c1e713efe7758b6e100c13ed69"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketAccept)(int32_t socket, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a45cbca28d9866f2ec2ad9df830787dd7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketConnect)(int32_t socket, const uint8_t *ip, uint32_t ip_len, uint16_t port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aaad6683992e76e3dd9a16eb6b7d43cf4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketRecv)(int32_t socket, void *buf, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4343cf48bbcfb2101a422d90c34f84e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketRecvFrom)(int32_t socket, void *buf, uint32_t len, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7ff47d391831d547d310dd66f22c2942"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketSend)(int32_t socket, const void *buf, uint32_t len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a248a293faea6f6e1cb781b8153e468fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketSendTo)(int32_t socket, const void *buf, uint32_t len, const uint8_t *ip, uint32_t ip_len, uint16_t port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab7c3e0211c87bf99e9c42b17a2249f50"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketGetSockName)(int32_t socket, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac45fbc58fd00742cbe712bf26d857359"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketGetPeerName)(int32_t socket, uint8_t *ip, uint32_t *ip_len, uint16_t *port)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4771324fb6f39fb2837e98d9f0ed48ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketGetOpt)(int32_t socket, int32_t opt_id, void *opt_val, uint32_t *opt_len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7019060d0869a7dfae8e31aedb46815d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketSetOpt)(int32_t socket, int32_t opt_id, const void *opt_val, uint32_t opt_len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a471a1be6d9adbccb83ca1f268643031c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketClose)(int32_t socket)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a62b2512cbaef03d26eb9c1e3004c3364"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* SocketGetHostByName)(const char *name, int32_t af, uint8_t *ip, uint32_t *ip_len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad8f218e434e2f327335b16cdb4f21f65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t(* Ping)(const uint8_t *ip, uint32_t ip_len)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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__interface__gr.html | HTML | apache-2.0 | 39,632 |
var group__wifi__interface__gr =
[
[ "WiFi Control", "group__wifi__control__gr.html", "group__wifi__control__gr" ],
[ "WiFi Management", "group__wifi__management__gr.html", "group__wifi__management__gr" ],
[ "WiFi Bypass Mode", "group__wifi__bypass__gr.html", "group__wifi__bypass__gr" ],
[ "WiFi Socket", "group__wifi__socket__gr.html", "group__wifi__socket__gr" ],
[ "ARM_DRIVER_WIFI", "group__wifi__interface__gr.html#structARM__DRIVER__WIFI", [
[ "GetVersion", "group__wifi__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__wifi__interface__gr.html#a1ced805656e067b5635f1af2292b69e1", null ],
[ "Initialize", "group__wifi__interface__gr.html#a99e597db8e61d0ff834561cb710e61ad", null ],
[ "Uninitialize", "group__wifi__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__wifi__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "GetModuleInfo", "group__wifi__interface__gr.html#aa78e745bbf8257a3438700e4e6a8d222", null ],
[ "SetOption", "group__wifi__interface__gr.html#a6b5e1c7fcea96ff13f6fd16d57c8b68f", null ],
[ "GetOption", "group__wifi__interface__gr.html#af264a580d36c33a649b64be845458b03", null ],
[ "Scan", "group__wifi__interface__gr.html#a51d027ef7046c413372103aa952772fb", null ],
[ "Activate", "group__wifi__interface__gr.html#a444ea7bda2c45eab34050d2a895baeec", null ],
[ "Deactivate", "group__wifi__interface__gr.html#ae9a38e69c7b7face914560e872378ed1", null ],
[ "IsConnected", "group__wifi__interface__gr.html#ab9771e89a155d316e0b44d3ee89081d3", null ],
[ "GetNetInfo", "group__wifi__interface__gr.html#ac17eb39c11b7797b88a1f6e0f8cc772d", null ],
[ "BypassControl", "group__wifi__interface__gr.html#a18c6762aa46cec65b65135eaeadebf23", null ],
[ "EthSendFrame", "group__wifi__interface__gr.html#a2648d7e0d1c10c48923d8d20d99311ab", null ],
[ "EthReadFrame", "group__wifi__interface__gr.html#a544ca40b7157efce5000cd83aa92f8a0", null ],
[ "EthGetRxFrameSize", "group__wifi__interface__gr.html#af7ecc54209ce3725037cb5c9629151cf", null ],
[ "SocketCreate", "group__wifi__interface__gr.html#aa26f0cefe99161484741977a5443e92c", null ],
[ "SocketBind", "group__wifi__interface__gr.html#afcbc0c2bb3639584521ffeaaffc5a475", null ],
[ "SocketListen", "group__wifi__interface__gr.html#a628706c754e1793ec864453a5b517d5c", null ],
[ "SocketAccept", "group__wifi__interface__gr.html#a66bb43c1e713efe7758b6e100c13ed69", null ],
[ "SocketConnect", "group__wifi__interface__gr.html#a45cbca28d9866f2ec2ad9df830787dd7", null ],
[ "SocketRecv", "group__wifi__interface__gr.html#aaad6683992e76e3dd9a16eb6b7d43cf4", null ],
[ "SocketRecvFrom", "group__wifi__interface__gr.html#a4343cf48bbcfb2101a422d90c34f84e6", null ],
[ "SocketSend", "group__wifi__interface__gr.html#a7ff47d391831d547d310dd66f22c2942", null ],
[ "SocketSendTo", "group__wifi__interface__gr.html#a248a293faea6f6e1cb781b8153e468fa", null ],
[ "SocketGetSockName", "group__wifi__interface__gr.html#ab7c3e0211c87bf99e9c42b17a2249f50", null ],
[ "SocketGetPeerName", "group__wifi__interface__gr.html#ac45fbc58fd00742cbe712bf26d857359", null ],
[ "SocketGetOpt", "group__wifi__interface__gr.html#a4771324fb6f39fb2837e98d9f0ed48ed", null ],
[ "SocketSetOpt", "group__wifi__interface__gr.html#a7019060d0869a7dfae8e31aedb46815d", null ],
[ "SocketClose", "group__wifi__interface__gr.html#a471a1be6d9adbccb83ca1f268643031c", null ],
[ "SocketGetHostByName", "group__wifi__interface__gr.html#a62b2512cbaef03d26eb9c1e3004c3364", null ],
[ "Ping", "group__wifi__interface__gr.html#ad8f218e434e2f327335b16cdb4f21f65", null ]
] ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__interface__gr.js | JavaScript | apache-2.0 | 3,799 |
var group__wifi__interface__gr_structARM__DRIVER__WIFI =
[
[ "GetVersion", "group__wifi__interface__gr.html#a8834b281da48583845c044a81566c1b3", null ],
[ "GetCapabilities", "group__wifi__interface__gr.html#a1ced805656e067b5635f1af2292b69e1", null ],
[ "Initialize", "group__wifi__interface__gr.html#a99e597db8e61d0ff834561cb710e61ad", null ],
[ "Uninitialize", "group__wifi__interface__gr.html#adcf20681a1402869ecb5c6447fada17b", null ],
[ "PowerControl", "group__wifi__interface__gr.html#aba8f1c8019af95ffe19c32403e3240ef", null ],
[ "GetModuleInfo", "group__wifi__interface__gr.html#aa78e745bbf8257a3438700e4e6a8d222", null ],
[ "SetOption", "group__wifi__interface__gr.html#a6b5e1c7fcea96ff13f6fd16d57c8b68f", null ],
[ "GetOption", "group__wifi__interface__gr.html#af264a580d36c33a649b64be845458b03", null ],
[ "Scan", "group__wifi__interface__gr.html#a51d027ef7046c413372103aa952772fb", null ],
[ "Activate", "group__wifi__interface__gr.html#a444ea7bda2c45eab34050d2a895baeec", null ],
[ "Deactivate", "group__wifi__interface__gr.html#ae9a38e69c7b7face914560e872378ed1", null ],
[ "IsConnected", "group__wifi__interface__gr.html#ab9771e89a155d316e0b44d3ee89081d3", null ],
[ "GetNetInfo", "group__wifi__interface__gr.html#ac17eb39c11b7797b88a1f6e0f8cc772d", null ],
[ "BypassControl", "group__wifi__interface__gr.html#a18c6762aa46cec65b65135eaeadebf23", null ],
[ "EthSendFrame", "group__wifi__interface__gr.html#a2648d7e0d1c10c48923d8d20d99311ab", null ],
[ "EthReadFrame", "group__wifi__interface__gr.html#a544ca40b7157efce5000cd83aa92f8a0", null ],
[ "EthGetRxFrameSize", "group__wifi__interface__gr.html#af7ecc54209ce3725037cb5c9629151cf", null ],
[ "SocketCreate", "group__wifi__interface__gr.html#aa26f0cefe99161484741977a5443e92c", null ],
[ "SocketBind", "group__wifi__interface__gr.html#afcbc0c2bb3639584521ffeaaffc5a475", null ],
[ "SocketListen", "group__wifi__interface__gr.html#a628706c754e1793ec864453a5b517d5c", null ],
[ "SocketAccept", "group__wifi__interface__gr.html#a66bb43c1e713efe7758b6e100c13ed69", null ],
[ "SocketConnect", "group__wifi__interface__gr.html#a45cbca28d9866f2ec2ad9df830787dd7", null ],
[ "SocketRecv", "group__wifi__interface__gr.html#aaad6683992e76e3dd9a16eb6b7d43cf4", null ],
[ "SocketRecvFrom", "group__wifi__interface__gr.html#a4343cf48bbcfb2101a422d90c34f84e6", null ],
[ "SocketSend", "group__wifi__interface__gr.html#a7ff47d391831d547d310dd66f22c2942", null ],
[ "SocketSendTo", "group__wifi__interface__gr.html#a248a293faea6f6e1cb781b8153e468fa", null ],
[ "SocketGetSockName", "group__wifi__interface__gr.html#ab7c3e0211c87bf99e9c42b17a2249f50", null ],
[ "SocketGetPeerName", "group__wifi__interface__gr.html#ac45fbc58fd00742cbe712bf26d857359", null ],
[ "SocketGetOpt", "group__wifi__interface__gr.html#a4771324fb6f39fb2837e98d9f0ed48ed", null ],
[ "SocketSetOpt", "group__wifi__interface__gr.html#a7019060d0869a7dfae8e31aedb46815d", null ],
[ "SocketClose", "group__wifi__interface__gr.html#a471a1be6d9adbccb83ca1f268643031c", null ],
[ "SocketGetHostByName", "group__wifi__interface__gr.html#a62b2512cbaef03d26eb9c1e3004c3364", null ],
[ "Ping", "group__wifi__interface__gr.html#ad8f218e434e2f327335b16cdb4f21f65", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__interface__gr_structARM__DRIVER__WIFI.js | JavaScript | apache-2.0 | 3,315 |
<!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 Management</title>
<title>CMSIS-Driver: WiFi Management</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__management__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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">WiFi Management<div class="ingroups"><a class="el" href="group__wifi__interface__gr.html">WiFi Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Configure and manage the connection to a WiFi access point (AP) or configure and manage the access point (AP).
<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__WiFi__option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__option.html">WiFi Option Codes</a></td></tr>
<tr class="memdesc:group__WiFi__option"><td class="mdescLeft"> </td><td class="mdescRight">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. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__wifi__sec__type"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sec__type.html">WiFi Security Type</a></td></tr>
<tr class="memdesc:group__wifi__sec__type"><td class="mdescLeft"> </td><td class="mdescRight">Specifies WiFi security type for <a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__wifi__wps__method"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__wps__method.html">WiFi Protected Setup (WPS) Method</a></td></tr>
<tr class="memdesc:group__wifi__wps__method"><td class="mdescLeft"> </td><td class="mdescRight">Specifies WiFi WPS method for <a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__wifi__dhcp__v6__mode"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__dhcp__v6__mode.html">WiFi DHCPv6 Mode</a></td></tr>
<tr class="memdesc:group__wifi__dhcp__v6__mode"><td class="mdescLeft"> </td><td class="mdescRight">Specifies IPv6 Dynamic Host Configuration Protocol (DHCP) Mode. <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__WIFI__CONFIG__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a></td></tr>
<tr class="memdesc:structARM__WIFI__CONFIG__t"><td class="mdescLeft"> </td><td class="mdescRight">WiFi Configuration. <a href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">More...</a><br/></td></tr>
<tr class="separator:structARM__WIFI__CONFIG__t"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__WIFI__SCAN__INFO__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">ARM_WIFI_SCAN_INFO_t</a></td></tr>
<tr class="memdesc:structARM__WIFI__SCAN__INFO__t"><td class="mdescLeft"> </td><td class="mdescRight">WiFi Scan Information. <a href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">More...</a><br/></td></tr>
<tr class="separator:structARM__WIFI__SCAN__INFO__t"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structARM__WIFI__NET__INFO__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">ARM_WIFI_NET_INFO_t</a></td></tr>
<tr class="memdesc:structARM__WIFI__NET__INFO__t"><td class="mdescLeft"> </td><td class="mdescRight">WiFi Network Information. <a href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">More...</a><br/></td></tr>
<tr class="separator:structARM__WIFI__NET__INFO__t"><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:gaf38a7aeb470eec596febc850c8b69ccf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a> (uint32_t interface, uint32_t option, const void *data, uint32_t len)</td></tr>
<tr class="memdesc:gaf38a7aeb470eec596febc850c8b69ccf"><td class="mdescLeft"> </td><td class="mdescRight">Set WiFi Module Options. <a href="#gaf38a7aeb470eec596febc850c8b69ccf">More...</a><br/></td></tr>
<tr class="separator:gaf38a7aeb470eec596febc850c8b69ccf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga56910984e5068f6502e12f72e1f80edf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf">ARM_WIFI_GetOption</a> (uint32_t interface, uint32_t option, void *data, uint32_t *len)</td></tr>
<tr class="memdesc:ga56910984e5068f6502e12f72e1f80edf"><td class="mdescLeft"> </td><td class="mdescRight">Get WiFi Module Options. <a href="#ga56910984e5068f6502e12f72e1f80edf">More...</a><br/></td></tr>
<tr class="separator:ga56910984e5068f6502e12f72e1f80edf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga856972af36e51cf0c4112029332d529f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f">ARM_WIFI_Scan</a> (<a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">ARM_WIFI_SCAN_INFO_t</a> scan_info[], uint32_t max_num)</td></tr>
<tr class="memdesc:ga856972af36e51cf0c4112029332d529f"><td class="mdescLeft"> </td><td class="mdescRight">Scan for available networks in range. <a href="#ga856972af36e51cf0c4112029332d529f">More...</a><br/></td></tr>
<tr class="separator:ga856972af36e51cf0c4112029332d529f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7d545744a848702d75043de30ea5260a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate</a> (uint32_t interface, <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> *config)</td></tr>
<tr class="memdesc:ga7d545744a848702d75043de30ea5260a"><td class="mdescLeft"> </td><td class="mdescRight">Activate interface (Connect to a wireless network or activate an access point). <a href="#ga7d545744a848702d75043de30ea5260a">More...</a><br/></td></tr>
<tr class="separator:ga7d545744a848702d75043de30ea5260a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1842127df60067481ac2f40d19153e3e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#ga1842127df60067481ac2f40d19153e3e">ARM_WIFI_Deactivate</a> (uint32_t interface)</td></tr>
<tr class="memdesc:ga1842127df60067481ac2f40d19153e3e"><td class="mdescLeft"> </td><td class="mdescRight">Deactivate interface (Disconnect from a wireless network or deactivate an access point). <a href="#ga1842127df60067481ac2f40d19153e3e">More...</a><br/></td></tr>
<tr class="separator:ga1842127df60067481ac2f40d19153e3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3d641222defb5f52f6dae4ce1d540d0f"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#ga3d641222defb5f52f6dae4ce1d540d0f">ARM_WIFI_IsConnected</a> (void)</td></tr>
<tr class="memdesc:ga3d641222defb5f52f6dae4ce1d540d0f"><td class="mdescLeft"> </td><td class="mdescRight">Get station connection status. <a href="#ga3d641222defb5f52f6dae4ce1d540d0f">More...</a><br/></td></tr>
<tr class="separator:ga3d641222defb5f52f6dae4ce1d540d0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29a5b0072470a8c56f0939f3c97ed08e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">ARM_WIFI_GetNetInfo</a> (<a class="el" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">ARM_WIFI_NET_INFO_t</a> *net_info)</td></tr>
<tr class="memdesc:ga29a5b0072470a8c56f0939f3c97ed08e"><td class="mdescLeft"> </td><td class="mdescRight">Get station Network Information. <a href="#ga29a5b0072470a8c56f0939f3c97ed08e">More...</a><br/></td></tr>
<tr class="separator:ga29a5b0072470a8c56f0939f3c97ed08e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Configure and manage the connection to a WiFi access point (AP) or configure and manage the access point (AP). </p>
<p>The <a class="el" href="group__wifi__management__gr.html">WiFi Management</a> functions are used to configure and manage the connection to a WiFi access point (AP) also called hotspot when in station mode. They are also used to configure and manage the access point (AP) itself when in access point mode. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structARM__WIFI__CONFIG__t" id="structARM__WIFI__CONFIG__t"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_WIFI_CONFIG_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>WiFi Configuration. </p>
<p>Provides information needed to connect to the WiFi network for station or how to configure the access point (AP).</p>
<p><b>Used in:</b></p>
<ul>
<li><a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a587ba0cb07f02913598610049a3bbb79"></a>const char *</td>
<td class="fieldname">
ssid</td>
<td class="fielddoc">
Pointer to Service Set Identifier (SSID) null-terminated string. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3bef28806edf8f4c8cb82584b7e8c3cb"></a>const char *</td>
<td class="fieldname">
pass</td>
<td class="fielddoc">
Pointer to Password null-terminated string. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5cd97d88131cf38bcc75189f9569f9b7"></a>uint8_t</td>
<td class="fieldname">
security</td>
<td class="fielddoc">
Security type (ARM_WIFI_SECURITY_xxx) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acbcf5f8de7895ca456bb39fbcccde1d1"></a>uint8_t</td>
<td class="fieldname">
ch</td>
<td class="fielddoc">
WiFi Channel (0 = auto, otherwise = exact channel) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acb7bc06bed6f6408d719334fc41698c7"></a>uint8_t</td>
<td class="fieldname">
reserved</td>
<td class="fielddoc">
Reserved. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5e263198499fb98f97d40a9b82579175"></a>uint8_t</td>
<td class="fieldname">
wps_method</td>
<td class="fielddoc">
WiFi Protected Setup (WPS) method (ARM_WIFI_WPS_METHOD_xxx) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a2047d60666390ea4755ce22603969c4c"></a>const char *</td>
<td class="fieldname">
wps_pin</td>
<td class="fielddoc">
Pointer to WiFi Protected Setup (WPS) PIN null-terminated string. </td></tr>
</table>
</div>
</div>
<a name="structARM__WIFI__SCAN__INFO__t" id="structARM__WIFI__SCAN__INFO__t"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_WIFI_SCAN_INFO_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>WiFi Scan Information. </p>
<p>Provides information about the wireless networks that were detected when searching for available WiFi networks. The structure contains the information needed to connect to the WiFi network. Of course, the access password is not included and must be provided separately.</p>
<p><b>Used in:</b></p>
<ul>
<li><a class="el" href="group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f">ARM_WIFI_Scan</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae7eccb3e4df8625b86b5572fc16c37c3"></a>char</td>
<td class="fieldname">
ssid[32+1]</td>
<td class="fielddoc">
Service Set Identifier (SSID) null-terminated string. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a19c52baafe5797c359c5e0f5776499d7"></a>uint8_t</td>
<td class="fieldname">
bssid[6]</td>
<td class="fielddoc">
Basic Service Set Identifier (BSSID) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5cd97d88131cf38bcc75189f9569f9b7"></a>uint8_t</td>
<td class="fieldname">
security</td>
<td class="fielddoc">
Security type (ARM_WIFI_SECURITY_xxx) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acbcf5f8de7895ca456bb39fbcccde1d1"></a>uint8_t</td>
<td class="fieldname">
ch</td>
<td class="fielddoc">
WiFi Channel. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afb67d818cd76cce8057affabcb1979a6"></a>uint8_t</td>
<td class="fieldname">
rssi</td>
<td class="fielddoc">
Received Signal Strength Indicator. </td></tr>
</table>
</div>
</div>
<a name="structARM__WIFI__NET__INFO__t" id="structARM__WIFI__NET__INFO__t"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ARM_WIFI_NET_INFO_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>WiFi Network Information. </p>
<p>Provides information about the network that the station is connected to.</p>
<p><b>Used in:</b></p>
<ul>
<li><a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">ARM_WIFI_GetNetInfo</a> </li>
</ul>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae7eccb3e4df8625b86b5572fc16c37c3"></a>char</td>
<td class="fieldname">
ssid[32+1]</td>
<td class="fielddoc">
Service Set Identifier (SSID) null-terminated string. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a97ae3ac37e362cf8e7e3a9e18b7c806f"></a>char</td>
<td class="fieldname">
pass[64+1]</td>
<td class="fielddoc">
Password null-terminated string. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5cd97d88131cf38bcc75189f9569f9b7"></a>uint8_t</td>
<td class="fieldname">
security</td>
<td class="fielddoc">
Security type (ARM_WIFI_SECURITY_xxx) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acbcf5f8de7895ca456bb39fbcccde1d1"></a>uint8_t</td>
<td class="fieldname">
ch</td>
<td class="fielddoc">
WiFi Channel. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afb67d818cd76cce8057affabcb1979a6"></a>uint8_t</td>
<td class="fieldname">
rssi</td>
<td class="fielddoc">
Received Signal Strength Indicator. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf38a7aeb470eec596febc850c8b69ccf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_SetOption </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</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>Set WiFi Module Options. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">option</td><td>Option to set </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to data relevant to selected option </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Length of data (in bytes) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface, NULL data pointer or len less than option specifies)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_SetOption</b> sets the value of the specified option of the WiFi module.</p>
<p>The argument <em>interface</em> specifies the interface (0 = Station, 1 = Access Point).</p>
<p>The argument <em>option</em> specifies the option that is to be set (see below).</p>
<p>The argument <em>data</em> points to a buffer containing the value of the option to be set and must be aligned to the data type of the corresponding option.</p>
<p>The argument <em>len</em> specifies the length of the buffer <em>data</em> and must be equal (or higher) to the length of the corresponding option.</p>
<table class="doxtable">
<tr>
<th align="left">Option </th><th align="left">Description </th><th align="left">Data </th><th align="left">Type/Length </th></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gae84cbf48cd5168371621fc5f78aac0a4">ARM_WIFI_BSSID</a> </td><td align="left">BSSID of AP to connect or AP </td><td align="left">bssid </td><td align="left">uint8_t[6] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga1fbda584fe5750db6a04b1ed27730d95">ARM_WIFI_TX_POWER</a> </td><td align="left">Transmit power </td><td align="left">power[dbm] </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga77e38a3d5d2fe8c04aebaf8d24e1b8d4">ARM_WIFI_LP_TIMER</a> </td><td align="left">Low-power deep-sleep time </td><td align="left">time[seconds] </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga947c297f1364993524bf515beba296f1">ARM_WIFI_DTIM</a> </td><td align="left">DTIM interval </td><td align="left">dtim[beacons] </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga6171d24c661b54465ced2dae7980897c">ARM_WIFI_BEACON</a> </td><td align="left">Beacon interval </td><td align="left">interval[ms] </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gafefb0fe1e5cdfb71f7f8cc7606840865">ARM_WIFI_MAC</a> </td><td align="left">MAC address </td><td align="left">mac </td><td align="left">uint8_t[6] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga50ee1ca627ebe536cae0ab7155ed1d17">ARM_WIFI_IP</a> </td><td align="left">IPv4 address </td><td align="left">ip </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gac2603479ebad0ed05413e1e01b8a649f">ARM_WIFI_IP_SUBNET_MASK</a> </td><td align="left">IPv4 subnet mask </td><td align="left">mask </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gad0c719fedd39d738ee7f6fd3c7317169">ARM_WIFI_IP_GATEWAY</a> </td><td align="left">IPv4 gateway address </td><td align="left">ip </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga657f5c6c504defe04422dbe468c6c134">ARM_WIFI_IP_DNS1</a> </td><td align="left">IPv4 primary DNS server address </td><td align="left">ip </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga5a5fa4c298b16d0acd0a71f873802d31">ARM_WIFI_IP_DNS2</a> </td><td align="left">IPv4 secondary DNS server address </td><td align="left">ip </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gad37e95b697872782973057ae94c085a9">ARM_WIFI_IP_DHCP</a> </td><td align="left">IPv4 DHCP client/server enable/disable </td><td align="left">dhcp (0, 1) </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga10065d0d9cb7530e0747be83ba9e4c35">ARM_WIFI_IP_DHCP_POOL_BEGIN</a> </td><td align="left">IPv4 DHCP server begin address </td><td align="left">ip </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga4054f0e4045a25928531be73fb9d6b45">ARM_WIFI_IP_DHCP_POOL_END</a> </td><td align="left">IPv4 DHCP server end address </td><td align="left">ip </td><td align="left">uint8_t[4] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga78ec2d08d4f1d3ce486b40a329bd8713">ARM_WIFI_IP_DHCP_LEASE_TIME</a> </td><td align="left">IPv4 DHCP server lease time </td><td align="left">time[seconds] </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gaeac3fc297297b9bf5f2b5cf84788d77f">ARM_WIFI_IP6_GLOBAL</a> </td><td align="left">IPv6 global address </td><td align="left">ip6 </td><td align="left">uint8_t[16] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga11fdcc3403a43187158434a87fdfb83c">ARM_WIFI_IP6_LINK_LOCAL</a> </td><td align="left">IPv6 link-local address </td><td align="left">ip6 </td><td align="left">uint8_t[16] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga545cb7e1da8715966bee7c7ff9d427d8">ARM_WIFI_IP6_SUBNET_PREFIX_LEN</a> </td><td align="left">IPv6 subnet prefix length </td><td align="left">len (1..127) </td><td align="left">uint32_t </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga218d49572adcac8d678f7a8ae2f0c67e">ARM_WIFI_IP6_GATEWAY</a> </td><td align="left">IPv6 gateway address </td><td align="left">ip6 </td><td align="left">uint8_t[16] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#gaeb86e25e3b7c6360c977b05b40ff7676">ARM_WIFI_IP6_DNS1</a> </td><td align="left">IPv6 primary DNS server address </td><td align="left">ip6 </td><td align="left">uint8_t[16] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga24dee294436d575b47c7a314cba1654d">ARM_WIFI_IP6_DNS2</a> </td><td align="left">IPv6 secondary DNS server address </td><td align="left">ip6 </td><td align="left">uint8_t[16] </td></tr>
<tr>
<td align="left"><a class="el" href="group__WiFi__option.html#ga6b864e923870ec473ee0c876d1a3b032">ARM_WIFI_IP6_DHCP_MODE</a> </td><td align="left">IPv6 DHCP client mode </td><td align="left">mode </td><td align="left">uint32_t </td></tr>
</table>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">uint8_t ip[4];</div>
<div class="line"> </div>
<div class="line">ip[0] = 192U;</div>
<div class="line">ip[1] = 168U;</div>
<div class="line">ip[2] = 0U;</div>
<div class="line">ip[3] = 1U;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set IP static address of the Station</span></div>
<div class="line">wifi-><a class="code" href="group__wifi__interface__gr.html#a6b5e1c7fcea96ff13f6fd16d57c8b68f">SetOption</a> (0U, <a class="code" href="group__WiFi__option.html#ga50ee1ca627ebe536cae0ab7155ed1d17">ARM_WIFI_IP</a>, &ip, <span class="keyword">sizeof</span>(ip));</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga56910984e5068f6502e12f72e1f80edf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_GetOption </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</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>Get WiFi Module Options. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">option</td><td>Option to get </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to memory where data for selected option will be returned </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">len</td><td>Pointer to length of data (input/output)<ul>
<li>input: maximum length of data that can be returned (in bytes)</li>
<li>output: length of returned data (in bytes) </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface, NULL data or len pointer, or *len less than option specifies)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_GetOption</b> retrieves the current value of the specified option of the WiFi module.</p>
<p>The argument <em>interface</em> specifies the interface (0 = Station, 1 = Access Point).</p>
<p>The argument <em>option</em> specifies the option that is to be retrieved (see <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a>).</p>
<p>The argument <em>data</em> points to a buffer that will be used to store the value of the <em>option</em> and must be aligned to the data type of the corresponding option.</p>
<p>The argument <em>len</em> is a pointer to the length of the buffer at input and returns the length of the option information on the output.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">uint8_t ip[4]; <span class="comment">// IP address</span></div>
<div class="line">uint8_t mask[4]; <span class="comment">// Subnet mask</span></div>
<div class="line">uint8_t gateway[4]; <span class="comment">// Gateway address</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// Get IP address, Subnet mask and Gateway address of the Station</span></div>
<div class="line">wifi-><a class="code" href="group__wifi__interface__gr.html#af264a580d36c33a649b64be845458b03">GetOption</a> (0U, <a class="code" href="group__WiFi__option.html#ga50ee1ca627ebe536cae0ab7155ed1d17">ARM_WIFI_IP</a>, &ip, <span class="keyword">sizeof</span>(ip));</div>
<div class="line">wifi-><a class="code" href="group__wifi__interface__gr.html#af264a580d36c33a649b64be845458b03">GetOption</a> (0U, <a class="code" href="group__WiFi__option.html#gac2603479ebad0ed05413e1e01b8a649f">ARM_WIFI_IP_SUBNET_MASK</a>, &mask, <span class="keyword">sizeof</span>(mask));</div>
<div class="line">wifi-><a class="code" href="group__wifi__interface__gr.html#af264a580d36c33a649b64be845458b03">GetOption</a> (0U, <a class="code" href="group__WiFi__option.html#gad0c719fedd39d738ee7f6fd3c7317169">ARM_WIFI_IP_GATEWAY</a>, &gateway, <span class="keyword">sizeof</span>(gateway));</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga856972af36e51cf0c4112029332d529f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_Scan </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">ARM_WIFI_SCAN_INFO_t</a> </td>
<td class="paramname"><em>scan_info</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>max_num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Scan for available networks in range. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">scan_info</td><td>Pointer to array of <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t" title="WiFi Scan Information. ">ARM_WIFI_SCAN_INFO_t</a> structures where available Scan Information will be returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_num</td><td>Maximum number of Network Information structures to return </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t" title="WiFi Scan Information. ">ARM_WIFI_SCAN_INFO_t</a> structures returned or error code<ul>
<li>value >= 0 : Number of <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t" title="WiFi Scan Information. ">ARM_WIFI_SCAN_INFO_t</a> structures returned</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (NULL scan_info pointer or max_num equal to 0)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_Scan</b> searches for available WiFi networks. Using this function, you can determine which wireless networks are available for the connection. If the network is secured, you must also know the password to connect.</p>
<p>The argument <em>scan_info</em> is a pointer to an array of network information structures, where the available network information will be returned.</p>
<p>The argument <em>max_num</em> specifies maximum number of network information structures, that can be stored to the <em>scan_info</em>.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><a class="code" href="group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t">ARM_WIFI_SCAN_INFO_t</a> scan_info[8];</div>
<div class="line"> </div>
<div class="line">num = wifi-><a class="code" href="group__wifi__interface__gr.html#a51d027ef7046c413372103aa952772fb">Scan</a> (scan_info, 8U);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Print SSIDs of available WiFi networks</span></div>
<div class="line"><span class="keywordflow">for</span> (i = 0; i < num; i++) {</div>
<div class="line"> printf (<span class="stringliteral">"%d. ssid=%s\n"</span>, i, scan_info[i].ssid);</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga7d545744a848702d75043de30ea5260a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_Activate </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate interface (Connect to a wireless network or activate an access point). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>Pointer to <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t" title="WiFi Configuration. ">ARM_WIFI_CONFIG_t</a> structure where Configuration parameters are located </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#ga0bac892205bb2d586b822e8b178ab310">ARM_DRIVER_ERROR_TIMEOUT</a> : Timeout occurred</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported (security type, channel autodetect or WPS not supported)</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface, NULL config pointer or invalid configuration)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_Activate</b> activates the specified interface.</p>
<p>The argument <em>interface</em> specifies the interface (0 = Station, 1 = Access Point).</p>
<p>When station interface is specified, the WiFi module connects to a wireless network.</p>
<p>The wireless network trying to connect to must be available, otherwise the operation will fail after a timeout.</p>
<p>Available wireless networks can be scanned by using the function <a class="el" href="group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f">ARM_WIFI_Scan</a>.</p>
<p>When access point interface is specified, the WiFi module creates a wireless network by activating the access point.</p>
<p>The argument <em>config</em> is a pointer to the configuration <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> which provides information needed to connect to a WiFi network for station interface or information used to configure the access point (AP) for access point interface.</p>
<p><em>ssid</em> specifies the name of the network to connect to or the network to create.</p>
<p><em>pass</em> specifies the password for accessing the wireless network.</p>
<p><em>security</em> specifies the security type which will be used for the connection.</p>
<p><em>ch</em> specifies the WiFi channel which will be used for the connection. Valid channels for 2.4 GHz frequency are from <span class="XML-Token">1</span> to <span class="XML-Token">13</span>. If the value for <em>ch</em> = <span class="XML-Token">0</span>, the system automatically selects the channel. For station interface the channel of the AP being connected to is used. For access point interface the module automatically selects the best channel for the WiFi connection.</p>
<dl class="section note"><dt>Note</dt><dd>Optionally BSSID parameter can be also set using <a class="el" href="group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf">ARM_WIFI_SetOption</a>. It allows connection to specific BSSID when connecting to an access point or specifies the BSSID of the access point.</dd></dl>
<p><em>wps_method</em> specifies if WiFi Protected Setup (WPS) is used and which method.</p>
<p><em>wps_pin</em> specifies the PIN used with WPS (<a class="el" href="group__wifi__wps__method.html#ga12a4e06347498f9765f339cdb5f391de">ARM_WIFI_WPS_METHOD_PIN</a>).</p>
<p>With the <b>push-button</b> method, you typically press the button, either real or virtual, both at the access point and the station. No credentials are needed.</p>
<p>With <b>PIN</b> method, you must provide the PIN code that you read from the label or screen on the wireless device.</p>
<p>WPS configuration for station is used when station connects to an access point. It enables to connect without specifying SSID, Password, Security Type or WiFi Channel. The actual network information can be retrieved once connected with <a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">ARM_WIFI_GetNetInfo</a>.</p>
<p>WPS configuration for access point is used when access point is activated. Subsequent activate calls re-trigger the WPS procedure.</p>
<dl class="section note"><dt>Note</dt><dd>WPS is typically activated by pressing the WPS button at the access point. During the discovery mode (usually 2 minutes or less) any wireless device may connect to the access point (PIN needs to match when PIN method is selected).</dd></dl>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><a class="code" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> wifi_config;</div>
<div class="line"> </div>
<div class="line">wifi_config.<a class="code" href="group__wifi__management__gr.html#a587ba0cb07f02913598610049a3bbb79">ssid</a> = <span class="stringliteral">"GuestAccess"</span>;</div>
<div class="line">wifi_config.<a class="code" href="group__wifi__management__gr.html#a3bef28806edf8f4c8cb82584b7e8c3cb">pass</a> = <span class="stringliteral">"guest"</span>;</div>
<div class="line">wifi_config.<a class="code" href="group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7">security</a> = <a class="code" href="group__wifi__sec__type.html#gab4622ed5c27f910299ed6c3997d14b66">ARM_WIFI_SECURITY_WPA2</a>;</div>
<div class="line">wifi_config.<a class="code" href="group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1">ch</a> = 0U;</div>
<div class="line">wifi_config.<a class="code" href="group__wifi__management__gr.html#a5e263198499fb98f97d40a9b82579175">wps_method</a> = <a class="code" href="group__wifi__wps__method.html#gaade5c0e07cfee79973643b9f98a73438">ARM_WIFI_WPS_METHOD_NONE</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Connect to wireless network</span></div>
<div class="line">status = wifi-><a class="code" href="group__wifi__interface__gr.html#a444ea7bda2c45eab34050d2a895baeec">Activate</a> (0U, &wifi_config);</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="ga1842127df60067481ac2f40d19153e3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_Deactivate </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>Deactivate interface (Disconnect from a wireless network or deactivate an access point). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface (0 = Station, 1 = Access Point) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_Deactivate</b> deactivates the specified interface.</p>
<p>The argument <em>interface</em> specifies the interface (0 = Station, 1 = Access Point).</p>
<p>When station interface is specified, the WiFi module disconnects from the wireless network.</p>
<p>When access point interface is specified, the WiFi module deactivates the access point.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">ARM_WIFI_GetNetInfo</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga3d641222defb5f52f6dae4ce1d540d0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARM_WIFI_IsConnected </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get station connection status. </p>
<dl class="section return"><dt>Returns</dt><dd>station connection status<ul>
<li>value != 0: Station connected</li>
<li>value = 0: Station not connected</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_IsConnected</b> checks if the station is connected to a wireless network and returns the connection status.</p>
<p>The function returns a <span class="XML-Token">non-zero</span> value, if the station is connected. If the station is not connected, the function returns <span class="XML-Token">0</span>.</p>
<p><b>Example:</b> </p>
<ul>
<li>see <a class="el" href="group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e">ARM_WIFI_GetNetInfo</a> </li>
</ul>
</div>
</div>
<a class="anchor" id="ga29a5b0072470a8c56f0939f3c97ed08e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ARM_WIFI_GetNetInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">ARM_WIFI_NET_INFO_t</a> * </td>
<td class="paramname"><em>net_info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get station Network Information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">net_info</td><td>Pointer to <a class="el" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t" title="WiFi Network Information. ">ARM_WIFI_NET_INFO_t</a> structure where station Network Information will be returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
<li><a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a> : Operation successful</li>
<li><a class="el" href="group__execution__status.html#ga2f627075447749bb368d3b768be107cb">ARM_DRIVER_ERROR</a> : Operation failed (station not connected)</li>
<li><a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> : Operation not supported</li>
<li><a class="el" href="group__execution__status.html#gac781d4b70ce17c4c2efe2db045be751c">ARM_DRIVER_ERROR_PARAMETER</a> : Parameter error (invalid interface or NULL net_info pointer)</li>
</ul>
</dd></dl>
<p>The function <b>ARM_WIFI_GetNetInfo</b> retrieves wireless network information of a connected station.</p>
<p>It can be used to retrieve network connection information for subsequent connections after initially connecting using WPS.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><a class="code" href="group__wifi__management__gr.html#structARM__WIFI__CONFIG__t">ARM_WIFI_CONFIG_t</a> wifi_config;</div>
<div class="line"><a class="code" href="group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t">ARM_WIFI_NET_INFO_t</a> net_info;</div>
<div class="line"> </div>
<div class="line">memset(&wifi_config, 0, <span class="keyword">sizeof</span>(wifi_config));</div>
<div class="line"> </div>
<div class="line">wifi_config.<a class="code" href="group__wifi__management__gr.html#a5e263198499fb98f97d40a9b82579175">wps_method</a> = <a class="code" href="group__wifi__wps__method.html#gafe4555319019fa722d2f2a8cc519af41">ARM_WIFI_WPS_METHOD_PBC</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Connect to wireless network (WPS)</span></div>
<div class="line">status = wifi-><a class="code" href="group__wifi__interface__gr.html#a444ea7bda2c45eab34050d2a895baeec">Activate</a> (0U, &wifi_config);</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 class="line"> </div>
<div class="line"><span class="comment">// Retrieve network information</span></div>
<div class="line"><span class="keywordflow">if</span> (wifi-><a class="code" href="group__wifi__interface__gr.html#ab9771e89a155d316e0b44d3ee89081d3">IsConnected</a> ()) {</div>
<div class="line"> status = wifi-><a class="code" href="group__wifi__interface__gr.html#ac17eb39c11b7797b88a1f6e0f8cc772d">GetNetInfo</a> (&net_info);</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 class="line"> printf(<span class="stringliteral">"SSID=%s, Password=%s"</span>,net_info.<a class="code" href="group__wifi__management__gr.html#ae7eccb3e4df8625b86b5572fc16c37c3">ssid</a>, net_info.<a class="code" href="group__wifi__management__gr.html#a97ae3ac37e362cf8e7e3a9e18b7c806f">pass</a>);</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Disconnect from wireless network</span></div>
<div class="line">wifi-><a class="code" href="group__wifi__interface__gr.html#ae9a38e69c7b7face914560e872378ed1">Deactivate</a> (0U);</div>
</div><!-- fragment -->
</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__management__gr.html | HTML | apache-2.0 | 55,319 |
var group__wifi__management__gr =
[
[ "WiFi Option Codes", "group__WiFi__option.html", "group__WiFi__option" ],
[ "WiFi Security Type", "group__wifi__sec__type.html", "group__wifi__sec__type" ],
[ "WiFi Protected Setup (WPS) Method", "group__wifi__wps__method.html", "group__wifi__wps__method" ],
[ "WiFi DHCPv6 Mode", "group__wifi__dhcp__v6__mode.html", "group__wifi__dhcp__v6__mode" ],
[ "ARM_WIFI_CONFIG_t", "group__wifi__management__gr.html#structARM__WIFI__CONFIG__t", [
[ "ssid", "group__wifi__management__gr.html#a587ba0cb07f02913598610049a3bbb79", null ],
[ "pass", "group__wifi__management__gr.html#a3bef28806edf8f4c8cb82584b7e8c3cb", null ],
[ "security", "group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7", null ],
[ "ch", "group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1", null ],
[ "reserved", "group__wifi__management__gr.html#acb7bc06bed6f6408d719334fc41698c7", null ],
[ "wps_method", "group__wifi__management__gr.html#a5e263198499fb98f97d40a9b82579175", null ],
[ "wps_pin", "group__wifi__management__gr.html#a2047d60666390ea4755ce22603969c4c", null ]
] ],
[ "ARM_WIFI_SCAN_INFO_t", "group__wifi__management__gr.html#structARM__WIFI__SCAN__INFO__t", [
[ "ssid", "group__wifi__management__gr.html#ae7eccb3e4df8625b86b5572fc16c37c3", null ],
[ "bssid", "group__wifi__management__gr.html#a19c52baafe5797c359c5e0f5776499d7", null ],
[ "security", "group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7", null ],
[ "ch", "group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1", null ],
[ "rssi", "group__wifi__management__gr.html#afb67d818cd76cce8057affabcb1979a6", null ]
] ],
[ "ARM_WIFI_NET_INFO_t", "group__wifi__management__gr.html#structARM__WIFI__NET__INFO__t", [
[ "ssid", "group__wifi__management__gr.html#ae7eccb3e4df8625b86b5572fc16c37c3", null ],
[ "pass", "group__wifi__management__gr.html#a97ae3ac37e362cf8e7e3a9e18b7c806f", null ],
[ "security", "group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7", null ],
[ "ch", "group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1", null ],
[ "rssi", "group__wifi__management__gr.html#afb67d818cd76cce8057affabcb1979a6", null ]
] ],
[ "ARM_WIFI_SetOption", "group__wifi__management__gr.html#gaf38a7aeb470eec596febc850c8b69ccf", null ],
[ "ARM_WIFI_GetOption", "group__wifi__management__gr.html#ga56910984e5068f6502e12f72e1f80edf", null ],
[ "ARM_WIFI_Scan", "group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f", null ],
[ "ARM_WIFI_Activate", "group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a", null ],
[ "ARM_WIFI_Deactivate", "group__wifi__management__gr.html#ga1842127df60067481ac2f40d19153e3e", null ],
[ "ARM_WIFI_IsConnected", "group__wifi__management__gr.html#ga3d641222defb5f52f6dae4ce1d540d0f", null ],
[ "ARM_WIFI_GetNetInfo", "group__wifi__management__gr.html#ga29a5b0072470a8c56f0939f3c97ed08e", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__management__gr.js | JavaScript | apache-2.0 | 3,082 |
var group__wifi__management__gr_structARM__WIFI__CONFIG__t =
[
[ "ssid", "group__wifi__management__gr.html#a587ba0cb07f02913598610049a3bbb79", null ],
[ "pass", "group__wifi__management__gr.html#a3bef28806edf8f4c8cb82584b7e8c3cb", null ],
[ "security", "group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7", null ],
[ "ch", "group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1", null ],
[ "reserved", "group__wifi__management__gr.html#acb7bc06bed6f6408d719334fc41698c7", null ],
[ "wps_method", "group__wifi__management__gr.html#a5e263198499fb98f97d40a9b82579175", null ],
[ "wps_pin", "group__wifi__management__gr.html#a2047d60666390ea4755ce22603969c4c", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__management__gr_structARM__WIFI__CONFIG__t.js | JavaScript | apache-2.0 | 723 |
var group__wifi__management__gr_structARM__WIFI__NET__INFO__t =
[
[ "ssid", "group__wifi__management__gr.html#ae7eccb3e4df8625b86b5572fc16c37c3", null ],
[ "pass", "group__wifi__management__gr.html#a97ae3ac37e362cf8e7e3a9e18b7c806f", null ],
[ "security", "group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7", null ],
[ "ch", "group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1", null ],
[ "rssi", "group__wifi__management__gr.html#afb67d818cd76cce8057affabcb1979a6", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__management__gr_structARM__WIFI__NET__INFO__t.js | JavaScript | apache-2.0 | 529 |
var group__wifi__management__gr_structARM__WIFI__SCAN__INFO__t =
[
[ "ssid", "group__wifi__management__gr.html#ae7eccb3e4df8625b86b5572fc16c37c3", null ],
[ "bssid", "group__wifi__management__gr.html#a19c52baafe5797c359c5e0f5776499d7", null ],
[ "security", "group__wifi__management__gr.html#a5cd97d88131cf38bcc75189f9569f9b7", null ],
[ "ch", "group__wifi__management__gr.html#acbcf5f8de7895ca456bb39fbcccde1d1", null ],
[ "rssi", "group__wifi__management__gr.html#afb67d818cd76cce8057affabcb1979a6", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__management__gr_structARM__WIFI__SCAN__INFO__t.js | JavaScript | apache-2.0 | 531 |
<!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 Socket Protocol definitions</title>
<title>CMSIS-Driver: WiFi Socket Protocol 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__wifi__protocol.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 Socket Protocol definitions<div class="ingroups"><a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>WiFi Socket Protocol 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:gaf07cfcf1b65ea6c6be0629459a2ba781"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__protocol.html#gaf07cfcf1b65ea6c6be0629459a2ba781">ARM_SOCKET_IPPROTO_TCP</a>   1</td></tr>
<tr class="memdesc:gaf07cfcf1b65ea6c6be0629459a2ba781"><td class="mdescLeft"> </td><td class="mdescRight">TCP. <a href="#gaf07cfcf1b65ea6c6be0629459a2ba781">More...</a><br/></td></tr>
<tr class="separator:gaf07cfcf1b65ea6c6be0629459a2ba781"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabacbead83c772f5737b25b4fc390e16d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__protocol.html#gabacbead83c772f5737b25b4fc390e16d">ARM_SOCKET_IPPROTO_UDP</a>   2</td></tr>
<tr class="memdesc:gabacbead83c772f5737b25b4fc390e16d"><td class="mdescLeft"> </td><td class="mdescRight">UDP. <a href="#gabacbead83c772f5737b25b4fc390e16d">More...</a><br/></td></tr>
<tr class="separator:gabacbead83c772f5737b25b4fc390e16d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>WiFi Socket Protocol definitions. </p>
<p>The WiFi Socket Protocol specifies the Internet Protocol Type that the socket is using. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf07cfcf1b65ea6c6be0629459a2ba781"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_IPPROTO_TCP   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>TCP. </p>
<p>Transmission Control Protocol. </p>
</div>
</div>
<a class="anchor" id="gabacbead83c772f5737b25b4fc390e16d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_IPPROTO_UDP   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>UDP. </p>
<p>User Datagram Protocol. </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__wifi__protocol.html | HTML | apache-2.0 | 8,834 |
var group__wifi__protocol =
[
[ "ARM_SOCKET_IPPROTO_TCP", "group__wifi__protocol.html#gaf07cfcf1b65ea6c6be0629459a2ba781", null ],
[ "ARM_SOCKET_IPPROTO_UDP", "group__wifi__protocol.html#gabacbead83c772f5737b25b4fc390e16d", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__protocol.js | JavaScript | apache-2.0 | 241 |
<!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 Security Type</title>
<title>CMSIS-Driver: WiFi Security 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__wifi__sec__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">WiFi Security Type<div class="ingroups"><a class="el" href="group__wifi__management__gr.html">WiFi Management</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies WiFi security type for <a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate</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:gab5b0d06b14b916c244c42ad8a3053d1d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sec__type.html#gab5b0d06b14b916c244c42ad8a3053d1d">ARM_WIFI_SECURITY_OPEN</a>   0U</td></tr>
<tr class="memdesc:gab5b0d06b14b916c244c42ad8a3053d1d"><td class="mdescLeft"> </td><td class="mdescRight">Open. <a href="#gab5b0d06b14b916c244c42ad8a3053d1d">More...</a><br/></td></tr>
<tr class="separator:gab5b0d06b14b916c244c42ad8a3053d1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75d8f1830db25a9f0b1390397186ddd5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sec__type.html#ga75d8f1830db25a9f0b1390397186ddd5">ARM_WIFI_SECURITY_WEP</a>   1U</td></tr>
<tr class="memdesc:ga75d8f1830db25a9f0b1390397186ddd5"><td class="mdescLeft"> </td><td class="mdescRight">Wired Equivalent Privacy (WEP) with Pre-Sheared Key (PSK) <a href="#ga75d8f1830db25a9f0b1390397186ddd5">More...</a><br/></td></tr>
<tr class="separator:ga75d8f1830db25a9f0b1390397186ddd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga40f2c6844d3d81bbfedaa96e72402b35"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sec__type.html#ga40f2c6844d3d81bbfedaa96e72402b35">ARM_WIFI_SECURITY_WPA</a>   2U</td></tr>
<tr class="memdesc:ga40f2c6844d3d81bbfedaa96e72402b35"><td class="mdescLeft"> </td><td class="mdescRight">WiFi Protected Access (WPA) with PSK. <a href="#ga40f2c6844d3d81bbfedaa96e72402b35">More...</a><br/></td></tr>
<tr class="separator:ga40f2c6844d3d81bbfedaa96e72402b35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4622ed5c27f910299ed6c3997d14b66"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sec__type.html#gab4622ed5c27f910299ed6c3997d14b66">ARM_WIFI_SECURITY_WPA2</a>   3U</td></tr>
<tr class="memdesc:gab4622ed5c27f910299ed6c3997d14b66"><td class="mdescLeft"> </td><td class="mdescRight">WiFi Protected Access II (WPA2) with PSK. <a href="#gab4622ed5c27f910299ed6c3997d14b66">More...</a><br/></td></tr>
<tr class="separator:gab4622ed5c27f910299ed6c3997d14b66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c0904e056c3f720fe38b903230d9f89"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__sec__type.html#ga1c0904e056c3f720fe38b903230d9f89">ARM_WIFI_SECURITY_UNKNOWN</a>   255U</td></tr>
<tr class="memdesc:ga1c0904e056c3f720fe38b903230d9f89"><td class="mdescLeft"> </td><td class="mdescRight">Unknown. <a href="#ga1c0904e056c3f720fe38b903230d9f89">More...</a><br/></td></tr>
<tr class="separator:ga1c0904e056c3f720fe38b903230d9f89"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies WiFi security type for <a class="el" href="group__wifi__management__gr.html#ga7d545744a848702d75043de30ea5260a">ARM_WIFI_Activate</a>. </p>
<p>The WiFi security type defines the standard used to protect the wireless network from unauthorized access. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gab5b0d06b14b916c244c42ad8a3053d1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_SECURITY_OPEN   0U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Open. </p>
<p>This is an open system which provides <b>no</b> security. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__sec__type.html" title="Specifies WiFi security type for ARM_WIFI_Activate. ">WiFi Security Type</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga75d8f1830db25a9f0b1390397186ddd5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_SECURITY_WEP   1U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Wired Equivalent Privacy (WEP) with Pre-Sheared Key (PSK) </p>
<p>This security standard provides <b>weak</b> level of security. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__sec__type.html" title="Specifies WiFi security type for ARM_WIFI_Activate. ">WiFi Security Type</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga40f2c6844d3d81bbfedaa96e72402b35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_SECURITY_WPA   2U</td>
</tr>
</table>
</div><div class="memdoc">
<p>WiFi Protected Access (WPA) with PSK. </p>
<p>This security standard provides <b>medium</b> level of security. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__sec__type.html" title="Specifies WiFi security type for ARM_WIFI_Activate. ">WiFi Security Type</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab4622ed5c27f910299ed6c3997d14b66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_SECURITY_WPA2   3U</td>
</tr>
</table>
</div><div class="memdoc">
<p>WiFi Protected Access II (WPA2) with PSK. </p>
<p>This security standard provides <b>strong</b> level of security. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__sec__type.html" title="Specifies WiFi security type for ARM_WIFI_Activate. ">WiFi Security Type</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga1c0904e056c3f720fe38b903230d9f89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_WIFI_SECURITY_UNKNOWN   255U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unknown. </p>
<p>Unknown security standard (reported by <a class="el" href="group__wifi__management__gr.html#ga856972af36e51cf0c4112029332d529f">ARM_WIFI_Scan</a>). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__sec__type.html" title="Specifies WiFi security type for ARM_WIFI_Activate. ">WiFi Security Type</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__sec__type.html | HTML | apache-2.0 | 13,410 |
var group__wifi__sec__type =
[
[ "ARM_WIFI_SECURITY_OPEN", "group__wifi__sec__type.html#gab5b0d06b14b916c244c42ad8a3053d1d", null ],
[ "ARM_WIFI_SECURITY_WEP", "group__wifi__sec__type.html#ga75d8f1830db25a9f0b1390397186ddd5", null ],
[ "ARM_WIFI_SECURITY_WPA", "group__wifi__sec__type.html#ga40f2c6844d3d81bbfedaa96e72402b35", null ],
[ "ARM_WIFI_SECURITY_WPA2", "group__wifi__sec__type.html#gab4622ed5c27f910299ed6c3997d14b66", null ],
[ "ARM_WIFI_SECURITY_UNKNOWN", "group__wifi__sec__type.html#ga1c0904e056c3f720fe38b903230d9f89", null ]
]; | YifuLiu/AliOS-Things | components/cmsis/docs/Driver/html/group__wifi__sec__type.js | JavaScript | apache-2.0 | 563 |
<!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 Socket Function return codes</title>
<title>CMSIS-Driver: WiFi Socket Function return 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__soc__func.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 Socket Function return codes<div class="ingroups"><a class="el" href="group__wifi__socket__gr.html">WiFi Socket</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>WiFi Socket Function return codes.
<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:ga2f3db9fdae2366238054ff8a8e8ef97c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga2f3db9fdae2366238054ff8a8e8ef97c">ARM_SOCKET_ERROR</a>   (-1)</td></tr>
<tr class="memdesc:ga2f3db9fdae2366238054ff8a8e8ef97c"><td class="mdescLeft"> </td><td class="mdescRight">Unspecified error. <a href="#ga2f3db9fdae2366238054ff8a8e8ef97c">More...</a><br/></td></tr>
<tr class="separator:ga2f3db9fdae2366238054ff8a8e8ef97c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga535e069b83aafcf70dd089e6097bceef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga535e069b83aafcf70dd089e6097bceef">ARM_SOCKET_ESOCK</a>   (-2)</td></tr>
<tr class="memdesc:ga535e069b83aafcf70dd089e6097bceef"><td class="mdescLeft"> </td><td class="mdescRight">Invalid socket. <a href="#ga535e069b83aafcf70dd089e6097bceef">More...</a><br/></td></tr>
<tr class="separator:ga535e069b83aafcf70dd089e6097bceef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga695aa5c5329602d9465fbc6c22fc9978"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga695aa5c5329602d9465fbc6c22fc9978">ARM_SOCKET_EINVAL</a>   (-3)</td></tr>
<tr class="memdesc:ga695aa5c5329602d9465fbc6c22fc9978"><td class="mdescLeft"> </td><td class="mdescRight">Invalid argument. <a href="#ga695aa5c5329602d9465fbc6c22fc9978">More...</a><br/></td></tr>
<tr class="separator:ga695aa5c5329602d9465fbc6c22fc9978"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga95ab80319bfbc5413fc5334e3d5ce5d2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga95ab80319bfbc5413fc5334e3d5ce5d2">ARM_SOCKET_ENOTSUP</a>   (-4)</td></tr>
<tr class="memdesc:ga95ab80319bfbc5413fc5334e3d5ce5d2"><td class="mdescLeft"> </td><td class="mdescRight">Operation not supported. <a href="#ga95ab80319bfbc5413fc5334e3d5ce5d2">More...</a><br/></td></tr>
<tr class="separator:ga95ab80319bfbc5413fc5334e3d5ce5d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68e88e80822f779361407d005659fc6c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga68e88e80822f779361407d005659fc6c">ARM_SOCKET_ENOMEM</a>   (-5)</td></tr>
<tr class="memdesc:ga68e88e80822f779361407d005659fc6c"><td class="mdescLeft"> </td><td class="mdescRight">Not enough memory. <a href="#ga68e88e80822f779361407d005659fc6c">More...</a><br/></td></tr>
<tr class="separator:ga68e88e80822f779361407d005659fc6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga699dbd55e543fd38d333cf1d4470d8db"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga699dbd55e543fd38d333cf1d4470d8db">ARM_SOCKET_EAGAIN</a>   (-6)</td></tr>
<tr class="memdesc:ga699dbd55e543fd38d333cf1d4470d8db"><td class="mdescLeft"> </td><td class="mdescRight">Operation would block or timed out. <a href="#ga699dbd55e543fd38d333cf1d4470d8db">More...</a><br/></td></tr>
<tr class="separator:ga699dbd55e543fd38d333cf1d4470d8db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad7f3e077f7721a202012378ddcefb83f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#gad7f3e077f7721a202012378ddcefb83f">ARM_SOCKET_EINPROGRESS</a>   (-7)</td></tr>
<tr class="memdesc:gad7f3e077f7721a202012378ddcefb83f"><td class="mdescLeft"> </td><td class="mdescRight">Operation in progress. <a href="#gad7f3e077f7721a202012378ddcefb83f">More...</a><br/></td></tr>
<tr class="separator:gad7f3e077f7721a202012378ddcefb83f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga320ffeeb44d583c0216b24d6e1009d9f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga320ffeeb44d583c0216b24d6e1009d9f">ARM_SOCKET_ETIMEDOUT</a>   (-8)</td></tr>
<tr class="memdesc:ga320ffeeb44d583c0216b24d6e1009d9f"><td class="mdescLeft"> </td><td class="mdescRight">Operation timed out. <a href="#ga320ffeeb44d583c0216b24d6e1009d9f">More...</a><br/></td></tr>
<tr class="separator:ga320ffeeb44d583c0216b24d6e1009d9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1e456c6cea2f6579158818387557f1a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#gaa1e456c6cea2f6579158818387557f1a">ARM_SOCKET_EISCONN</a>   (-9)</td></tr>
<tr class="memdesc:gaa1e456c6cea2f6579158818387557f1a"><td class="mdescLeft"> </td><td class="mdescRight">Socket is connected. <a href="#gaa1e456c6cea2f6579158818387557f1a">More...</a><br/></td></tr>
<tr class="separator:gaa1e456c6cea2f6579158818387557f1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0bde95e313d907032074583bc06b24a1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga0bde95e313d907032074583bc06b24a1">ARM_SOCKET_ENOTCONN</a>   (-10)</td></tr>
<tr class="memdesc:ga0bde95e313d907032074583bc06b24a1"><td class="mdescLeft"> </td><td class="mdescRight">Socket is not connected. <a href="#ga0bde95e313d907032074583bc06b24a1">More...</a><br/></td></tr>
<tr class="separator:ga0bde95e313d907032074583bc06b24a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf535c9d325172ff8ef02964af218cb0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#gaaf535c9d325172ff8ef02964af218cb0">ARM_SOCKET_ECONNREFUSED</a>   (-11)</td></tr>
<tr class="memdesc:gaaf535c9d325172ff8ef02964af218cb0"><td class="mdescLeft"> </td><td class="mdescRight">Connection rejected by the peer. <a href="#gaaf535c9d325172ff8ef02964af218cb0">More...</a><br/></td></tr>
<tr class="separator:gaaf535c9d325172ff8ef02964af218cb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga87fa238861921ba1b272019a83b04676"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga87fa238861921ba1b272019a83b04676">ARM_SOCKET_ECONNRESET</a>   (-12)</td></tr>
<tr class="memdesc:ga87fa238861921ba1b272019a83b04676"><td class="mdescLeft"> </td><td class="mdescRight">Connection reset by the peer. <a href="#ga87fa238861921ba1b272019a83b04676">More...</a><br/></td></tr>
<tr class="separator:ga87fa238861921ba1b272019a83b04676"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e64d6bd00a2f6e30ece3ff0f02b5b27"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga7e64d6bd00a2f6e30ece3ff0f02b5b27">ARM_SOCKET_ECONNABORTED</a>   (-13)</td></tr>
<tr class="memdesc:ga7e64d6bd00a2f6e30ece3ff0f02b5b27"><td class="mdescLeft"> </td><td class="mdescRight">Connection aborted locally. <a href="#ga7e64d6bd00a2f6e30ece3ff0f02b5b27">More...</a><br/></td></tr>
<tr class="separator:ga7e64d6bd00a2f6e30ece3ff0f02b5b27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9df0d5bd422102d9d4ebddc869d358e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga9df0d5bd422102d9d4ebddc869d358e0">ARM_SOCKET_EALREADY</a>   (-14)</td></tr>
<tr class="memdesc:ga9df0d5bd422102d9d4ebddc869d358e0"><td class="mdescLeft"> </td><td class="mdescRight">Connection already in progress. <a href="#ga9df0d5bd422102d9d4ebddc869d358e0">More...</a><br/></td></tr>
<tr class="separator:ga9df0d5bd422102d9d4ebddc869d358e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4fa475e41c3db0ada798249696e745a1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga4fa475e41c3db0ada798249696e745a1">ARM_SOCKET_EADDRINUSE</a>   (-15)</td></tr>
<tr class="memdesc:ga4fa475e41c3db0ada798249696e745a1"><td class="mdescLeft"> </td><td class="mdescRight">Address in use. <a href="#ga4fa475e41c3db0ada798249696e745a1">More...</a><br/></td></tr>
<tr class="separator:ga4fa475e41c3db0ada798249696e745a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d5d38e9a7d5907a3de4165476640cd4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifi__soc__func.html#ga4d5d38e9a7d5907a3de4165476640cd4">ARM_SOCKET_EHOSTNOTFOUND</a>   (-16)</td></tr>
<tr class="memdesc:ga4d5d38e9a7d5907a3de4165476640cd4"><td class="mdescLeft"> </td><td class="mdescRight">Host not found. <a href="#ga4d5d38e9a7d5907a3de4165476640cd4">More...</a><br/></td></tr>
<tr class="separator:ga4d5d38e9a7d5907a3de4165476640cd4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>WiFi Socket Function return codes. </p>
<p>This section lists all the return errors the WiFi socket functions will return. The error codes are negative. This makes it easy to check an error when the return code is less than <span class="XML-Token">0</span>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga2f3db9fdae2366238054ff8a8e8ef97c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ERROR   (-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unspecified error. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga535e069b83aafcf70dd089e6097bceef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ESOCK   (-2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalid socket. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga695aa5c5329602d9465fbc6c22fc9978"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EINVAL   (-3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalid argument. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga95ab80319bfbc5413fc5334e3d5ce5d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ENOTSUP   (-4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operation not supported. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga68e88e80822f779361407d005659fc6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ENOMEM   (-5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Not enough memory. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga699dbd55e543fd38d333cf1d4470d8db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EAGAIN   (-6)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operation would block or timed out. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad7f3e077f7721a202012378ddcefb83f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EINPROGRESS   (-7)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operation in progress. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga320ffeeb44d583c0216b24d6e1009d9f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ETIMEDOUT   (-8)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operation timed out. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa1e456c6cea2f6579158818387557f1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EISCONN   (-9)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Socket is connected. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0bde95e313d907032074583bc06b24a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ENOTCONN   (-10)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Socket is not connected. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaaf535c9d325172ff8ef02964af218cb0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ECONNREFUSED   (-11)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection rejected by the peer. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga87fa238861921ba1b272019a83b04676"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ECONNRESET   (-12)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection reset by the peer. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7e64d6bd00a2f6e30ece3ff0f02b5b27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_ECONNABORTED   (-13)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection aborted locally. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9df0d5bd422102d9d4ebddc869d358e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EALREADY   (-14)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection already in progress. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4fa475e41c3db0ada798249696e745a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EADDRINUSE   (-15)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Address in use. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return codes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4d5d38e9a7d5907a3de4165476640cd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_SOCKET_EHOSTNOTFOUND   (-16)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Host not found. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__wifi__soc__func.html" title="WiFi Socket Function return codes. ">WiFi Socket Function return 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__soc__func.html | HTML | apache-2.0 | 25,492 |