begriffs open source - cmsis/blob - main/Driver/html/group__usart__interface__gr.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: USART Interface</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__usart__interface__gr.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#groups">Content</a> &#124;
 132 <a href="#nested-classes">Data Structures</a> &#124;
 133 <a href="#typedef-members">Typedefs</a> &#124;
 134 <a href="#enum-members">Enumerations</a> &#124;
 135 <a href="#func-members">Functions</a>  </div>
 136   <div class="headertitle"><div class="title">USART Interface</div></div>
 137 </div><!--header-->
 138 <div class="contents">
 139
 140 <p>Driver API for Universal Synchronous Asynchronous Receiver/Transmitter (Driver_USART.h)
 141 <a href="#details">More...</a></p>
 142 <table class="memberdecls">
 143 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 144 Content</h2></td></tr>
 145 <tr class="memitem:group__usart__execution__status"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__execution__status.html">USART Status Error Codes</a></td></tr>
 146 <tr class="memdesc:group__usart__execution__status"><td class="mdescLeft">&#160;</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>
 147 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:group__USART__events"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html">USART Events</a></td></tr>
 149 <tr class="memdesc:group__USART__events"><td class="mdescLeft">&#160;</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>
 150 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:group__USART__control"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__control.html">USART Control Codes</a></td></tr>
 152 <tr class="memdesc:group__USART__control"><td class="mdescLeft">&#160;</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>
 153 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 </table><table class="memberdecls">
 155 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 156 Data Structures</h2></td></tr>
 157 <tr class="memitem:structARM__DRIVER__USART"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a></td></tr>
 158 <tr class="memdesc:structARM__DRIVER__USART"><td class="mdescLeft">&#160;</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>
 159 <tr class="separator:structARM__DRIVER__USART"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:structARM__USART__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a></td></tr>
 161 <tr class="memdesc:structARM__USART__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">USART Device Driver Capabilities.  <a href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">More...</a><br /></td></tr>
 162 <tr class="separator:structARM__USART__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:structARM__USART__STATUS"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a></td></tr>
 164 <tr class="memdesc:structARM__USART__STATUS"><td class="mdescLeft">&#160;</td><td class="mdescRight">USART Status.  <a href="group__usart__interface__gr.html#structARM__USART__STATUS">More...</a><br /></td></tr>
 165 <tr class="separator:structARM__USART__STATUS"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:structARM__USART__MODEM__STATUS"><td class="memItemLeft" align="right" valign="top">struct &#160;</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>
 167 <tr class="memdesc:structARM__USART__MODEM__STATUS"><td class="mdescLeft">&#160;</td><td class="mdescRight">USART Modem Status.  <a href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">More...</a><br /></td></tr>
 168 <tr class="separator:structARM__USART__MODEM__STATUS"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 </table><table class="memberdecls">
 170 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 171 Typedefs</h2></td></tr>
 172 <tr class="memitem:gaa578c3829eea207e9e48df6cb6f038a1"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</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>
 173 <tr class="memdesc:gaa578c3829eea207e9e48df6cb6f038a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> : Signal USART Event.  <br /></td></tr>
 174 <tr class="separator:gaa578c3829eea207e9e48df6cb6f038a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 </table><table class="memberdecls">
 176 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 177 Enumerations</h2></td></tr>
 178 <tr class="memitem:ga7b89d709f048b6a956aa211f63e75f6f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> { <br />
 179 &#160;&#160;<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6">ARM_USART_RTS_CLEAR</a>
 180 , <br />
 181 &#160;&#160;<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434">ARM_USART_RTS_SET</a>
 182 , <br />
 183 &#160;&#160;<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c">ARM_USART_DTR_CLEAR</a>
 184 , <br />
 185 &#160;&#160;<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4">ARM_USART_DTR_SET</a>
 186 <br />
 187  }</td></tr>
 188 <tr class="memdesc:ga7b89d709f048b6a956aa211f63e75f6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">USART Modem Control.  <a href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">More...</a><br /></td></tr>
 189 <tr class="separator:ga7b89d709f048b6a956aa211f63e75f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 190 </table><table class="memberdecls">
 191 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 192 Functions</h2></td></tr>
 193 <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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">ARM_USART_GetVersion</a> (void)</td></tr>
 194 <tr class="memdesc:gabca6151cef47565832decaf484781b61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver version.  <br /></td></tr>
 195 <tr class="separator:gabca6151cef47565832decaf484781b61"><td class="memSeparator" colspan="2">&#160;</td></tr>
 196 <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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> (void)</td></tr>
 197 <tr class="memdesc:gad2d3ace1fe7627bb72945efefaeddf0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver capabilities.  <br /></td></tr>
 198 <tr class="separator:gad2d3ace1fe7627bb72945efefaeddf0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 199 <tr class="memitem:ga51f06805e9a6197c553fa9513ac7b9d6"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 200 <tr class="memdesc:ga51f06805e9a6197c553fa9513ac7b9d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize USART Interface.  <br /></td></tr>
 201 <tr class="separator:ga51f06805e9a6197c553fa9513ac7b9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 202 <tr class="memitem:ga96f31f07a6721cf75de2a7a0ab723d26"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize</a> (void)</td></tr>
 203 <tr class="memdesc:ga96f31f07a6721cf75de2a7a0ab723d26"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize USART Interface.  <br /></td></tr>
 204 <tr class="separator:ga96f31f07a6721cf75de2a7a0ab723d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
 205 <tr class="memitem:ga9bad012b28d544f3eeeea9c2f71a4086"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 206 <tr class="memdesc:ga9bad012b28d544f3eeeea9c2f71a4086"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control USART Interface Power.  <br /></td></tr>
 207 <tr class="separator:ga9bad012b28d544f3eeeea9c2f71a4086"><td class="memSeparator" colspan="2">&#160;</td></tr>
 208 <tr class="memitem:ga5cf758b0b9d03dca68846962f73c0b08"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 209 <tr class="memdesc:ga5cf758b0b9d03dca68846962f73c0b08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start sending data to USART transmitter.  <br /></td></tr>
 210 <tr class="separator:ga5cf758b0b9d03dca68846962f73c0b08"><td class="memSeparator" colspan="2">&#160;</td></tr>
 211 <tr class="memitem:gae9efabdabb5aaa17bce83339f8a58803"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 212 <tr class="memdesc:gae9efabdabb5aaa17bce83339f8a58803"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start receiving data from USART receiver.  <br /></td></tr>
 213 <tr class="separator:gae9efabdabb5aaa17bce83339f8a58803"><td class="memSeparator" colspan="2">&#160;</td></tr>
 214 <tr class="memitem:ga878899928d34a818edd3e97d67b65c2a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 215 <tr class="memdesc:ga878899928d34a818edd3e97d67b65c2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start sending/receiving data to/from USART transmitter/receiver.  <br /></td></tr>
 216 <tr class="separator:ga878899928d34a818edd3e97d67b65c2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 217 <tr class="memitem:gacb355584bcdf4ebd36f11d945800fa03"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> (void)</td></tr>
 218 <tr class="memdesc:gacb355584bcdf4ebd36f11d945800fa03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get transmitted data count.  <br /></td></tr>
 219 <tr class="separator:gacb355584bcdf4ebd36f11d945800fa03"><td class="memSeparator" colspan="2">&#160;</td></tr>
 220 <tr class="memitem:ga1a8799aeeba1363a9e5d22bada715a29"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a> (void)</td></tr>
 221 <tr class="memdesc:ga1a8799aeeba1363a9e5d22bada715a29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get received data count.  <br /></td></tr>
 222 <tr class="separator:ga1a8799aeeba1363a9e5d22bada715a29"><td class="memSeparator" colspan="2">&#160;</td></tr>
 223 <tr class="memitem:gad8ffdde2123b5412de3005c456da677d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 224 <tr class="memdesc:gad8ffdde2123b5412de3005c456da677d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control USART Interface.  <br /></td></tr>
 225 <tr class="separator:gad8ffdde2123b5412de3005c456da677d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 226 <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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> (void)</td></tr>
 227 <tr class="memdesc:ga1e8fdd54294b587438b2b72f4dbde004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get USART status.  <br /></td></tr>
 228 <tr class="separator:ga1e8fdd54294b587438b2b72f4dbde004"><td class="memSeparator" colspan="2">&#160;</td></tr>
 229 <tr class="memitem:gad8eb0eb1d1c24fc725584ab93214cfc7"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</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>
 230 <tr class="memdesc:gad8eb0eb1d1c24fc725584ab93214cfc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set USART Modem Control line state.  <br /></td></tr>
 231 <tr class="separator:gad8eb0eb1d1c24fc725584ab93214cfc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 232 <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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> (void)</td></tr>
 233 <tr class="memdesc:ga198af0d6a7c85b7c0b96f3d9db8c34e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get USART Modem Status lines state.  <br /></td></tr>
 234 <tr class="separator:ga198af0d6a7c85b7c0b96f3d9db8c34e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 235 <tr class="memitem:gad796cd023f8f6300a6caadcc39d43cbf"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
 236 <tr class="memdesc:gad796cd023f8f6300a6caadcc39d43cbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal USART Events.  <br /></td></tr>
 237 <tr class="separator:gad796cd023f8f6300a6caadcc39d43cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 238 </table>
 239 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 240 <p>Driver API for Universal Synchronous Asynchronous Receiver/Transmitter (Driver_USART.h) </p>
 241 <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). <br  />
 242  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 <br  />
 243  the <a href="http://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter" target="_blank"><b>Universal asynchronous receiver/transmitter</b></a>.</p>
 244 <p><b>USART API</b></p>
 245 <p>The following header files define the Application Programming Interface (API) for the USART interface:</p><ul>
 246 <li><b>Driver_USART.h</b> : Driver API for Universal Synchronous Asynchronous Receiver/Transmitter</li>
 247 </ul>
 248 <p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
 249 <p><b>Driver Functions</b></p>
 250 <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>
 251 <li><a class="el" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> : access struct for USART driver functions</li>
 252 </ul>
 253 <p><b>Example Code</b></p>
 254 <p>The following example code shows the usage of the USART interface for asynchronous communication.</p>
 255 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Driver__USART_8h.html">Driver_USART.h</a>&quot;</span></div>
 256 <div class="line"><span class="preprocessor">#include &quot;cmsis_os.h&quot;</span>                   <span class="comment">/* ARM::CMSIS:RTOS:Keil RTX */</span></div>
 257 <div class="line"><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
 258 <div class="line"><span class="preprocessor">#include &lt;string.h&gt;</span></div>
 259 <div class="line"> </div>
 260 <div class="line"><span class="keywordtype">void</span> myUART_Thread(<span class="keywordtype">void</span> <span class="keyword">const</span> *argument);</div>
 261 <div class="line">osThreadId tid_myUART_Thread;</div>
 262 <div class="line"> </div>
 263 <div class="line"><span class="comment">/* USART Driver */</span></div>
 264 <div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART3;</div>
 265 <div class="line"> </div>
 266 <div class="line"> </div>
 267 <div class="line"><span class="keywordtype">void</span> myUSART_callback(uint32_t event)</div>
 268 <div class="line">{</div>
 269 <div class="line">  uint32_t mask;</div>
 270 <div class="line"> </div>
 271 <div class="line">  mask = <a class="code hl_define" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a>  |</div>
 272 <div class="line">         <a class="code hl_define" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a> |</div>
 273 <div class="line">         <a class="code hl_define" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a>     |</div>
 274 <div class="line">         <a class="code hl_define" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a>       ;</div>
 275 <div class="line"> </div>
 276 <div class="line">  <span class="keywordflow">if</span> (event &amp; mask) {</div>
 277 <div class="line">    <span class="comment">/* Success: Wakeup Thread */</span></div>
 278 <div class="line">    osSignalSet(tid_myUART_Thread, 0x01);</div>
 279 <div class="line">  }</div>
 280 <div class="line"> </div>
 281 <div class="line">  <span class="keywordflow">if</span> (event &amp; <a class="code hl_define" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a>) {</div>
 282 <div class="line">    __breakpoint(0);  <span class="comment">/* Error: Call debugger or replace with custom error handling */</span></div>
 283 <div class="line">  }</div>
 284 <div class="line"> </div>
 285 <div class="line">  <span class="keywordflow">if</span> (event &amp; (<a class="code hl_define" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a> | <a class="code hl_define" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a>)) {</div>
 286 <div class="line">    __breakpoint(0);  <span class="comment">/* Error: Call debugger or replace with custom error handling */</span></div>
 287 <div class="line">  }</div>
 288 <div class="line">}</div>
 289 <div class="line"> </div>
 290 <div class="line"> </div>
 291 <div class="line"><span class="comment">/* CMSIS-RTOS Thread - UART command thread */</span></div>
 292 <div class="line"><span class="keywordtype">void</span> myUART_Thread(<span class="keyword">const</span> <span class="keywordtype">void</span>* args)</div>
 293 <div class="line">{</div>
 294 <div class="line">    <span class="keyword">static</span> <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> * USARTdrv = &amp;Driver_USART3;</div>
 295 <div class="line">    <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>     version;</div>
 296 <div class="line">    <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> drv_capabilities;</div>
 297 <div class="line">    <span class="keywordtype">char</span>                   cmd;</div>
 298 <div class="line"> </div>
 299 <div class="line"><span class="preprocessor">  #ifdef DEBUG</span></div>
 300 <div class="line">    version = USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a>();</div>
 301 <div class="line">    <span class="keywordflow">if</span> (version.<a class="code hl_variable" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> &lt; 0x200)   <span class="comment">/* requires at minimum API version 2.00 or higher */</span></div>
 302 <div class="line">    {                          <span class="comment">/* error handling */</span></div>
 303 <div class="line">        <span class="keywordflow">return</span>;</div>
 304 <div class="line">    }</div>
 305 <div class="line">    drv_capabilities = USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#ae5d58954a010f48aea6c3333c52f3ec5">GetCapabilities</a>();</div>
 306 <div class="line">    <span class="keywordflow">if</span> (drv_capabilities.<a class="code hl_variable" href="group__usart__interface__gr.html#a0190aabe8d8f59176be8d693f8874fb3">event_tx_complete</a> == 0)</div>
 307 <div class="line">    {                          <span class="comment">/* error handling */</span></div>
 308 <div class="line">        <span class="keywordflow">return</span>;</div>
 309 <div class="line">    }</div>
 310 <div class="line"><span class="preprocessor">  #endif</span></div>
 311 <div class="line"> </div>
 312 <div class="line">    <span class="comment">/*Initialize the USART driver */</span></div>
 313 <div class="line">    USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a94bc477e7a6d1d30869980d7d8b8c310">Initialize</a>(myUSART_callback);</div>
 314 <div class="line">    <span class="comment">/*Power up the USART peripheral */</span></div>
 315 <div class="line">    USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a>(<a class="code hl_enumvalue" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a>);</div>
 316 <div class="line">    <span class="comment">/*Configure the USART to 4800 Bits/sec */</span></div>
 317 <div class="line">    USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a>(<a class="code hl_define" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a> |</div>
 318 <div class="line">                      <a class="code hl_define" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a> |</div>
 319 <div class="line">                      <a class="code hl_define" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a> |</div>
 320 <div class="line">                      <a class="code hl_define" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a> |</div>
 321 <div class="line">                      <a class="code hl_define" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a>, 4800);</div>
 322 <div class="line">     </div>
 323 <div class="line">    <span class="comment">/* Enable Receiver and Transmitter lines */</span></div>
 324 <div class="line">    USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a> (<a class="code hl_define" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a>, 1);</div>
 325 <div class="line">    USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a> (<a class="code hl_define" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a>, 1);</div>
 326 <div class="line"> </div>
 327 <div class="line">    USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a6e880dae8e9733a3c0f152a131076ca4">Send</a>(<span class="stringliteral">&quot;\nPress Enter to receive a message&quot;</span>, 34);</div>
 328 <div class="line">    osSignalWait(0x01, osWaitForever);</div>
 329 <div class="line">     </div>
 330 <div class="line">    <span class="keywordflow">while</span> (1)</div>
 331 <div class="line">    {</div>
 332 <div class="line">        USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a784cafe08ad8f9052dca8cd8071d2a9b">Receive</a>(&amp;cmd, 1);          <span class="comment">/* Get byte from UART */</span></div>
 333 <div class="line">        osSignalWait(0x01, osWaitForever);</div>
 334 <div class="line">        <span class="keywordflow">if</span> (cmd == 13)                       <span class="comment">/* CR, send greeting  */</span></div>
 335 <div class="line">        {</div>
 336 <div class="line">          USARTdrv-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a6e880dae8e9733a3c0f152a131076ca4">Send</a>(<span class="stringliteral">&quot;\nHello World!&quot;</span>, 12);</div>
 337 <div class="line">          osSignalWait(0x01, osWaitForever);</div>
 338 <div class="line">        }</div>
 339 <div class="line"> </div>
 340 <div class="line">    }</div>
 341 <div class="line">}</div>
 342 <div class="ttc" id="aDriver__Common_8h_html_ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e"><div class="ttname"><a href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a></div><div class="ttdeci">@ ARM_POWER_FULL</div><div class="ttdoc">Power on: full operation at maximum performance.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:66</div></div>
 343 <div class="ttc" id="aDriver__USART_8h_html"><div class="ttname"><a href="Driver__USART_8h.html">Driver_USART.h</a></div></div>
 344 <div class="ttc" id="agroup__USART__events_html_ga0599793e6aa531d56ff9f81ff12605d7"><div class="ttname"><a href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a></div><div class="ttdeci">#define ARM_USART_EVENT_TRANSFER_COMPLETE</div><div class="ttdoc">Transfer completed.</div></div>
 345 <div class="ttc" id="agroup__USART__events_html_ga08b165fd8525e44e3ce42ed6183cd30a"><div class="ttname"><a href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a></div><div class="ttdeci">#define ARM_USART_EVENT_RECEIVE_COMPLETE</div><div class="ttdoc">Receive completed.</div></div>
 346 <div class="ttc" id="agroup__USART__events_html_ga12872a3b04343f97d9535b5b0d37286d"><div class="ttname"><a href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a></div><div class="ttdeci">#define ARM_USART_EVENT_TX_COMPLETE</div><div class="ttdoc">Transmit completed (optional)</div></div>
 347 <div class="ttc" id="agroup__USART__events_html_ga43a0869daf83abb3fea96926a97047ad"><div class="ttname"><a href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a></div><div class="ttdeci">#define ARM_USART_EVENT_RX_OVERFLOW</div><div class="ttdoc">Receive data overflow.</div></div>
 348 <div class="ttc" id="agroup__USART__events_html_ga66ee2256571450a3fc3c530344ea9bd7"><div class="ttname"><a href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a></div><div class="ttdeci">#define ARM_USART_EVENT_RX_TIMEOUT</div><div class="ttdoc">Receive character timeout (optional)</div></div>
 349 <div class="ttc" id="agroup__USART__events_html_gaae1c626192b16ccace93f3546e7884bf"><div class="ttname"><a href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a></div><div class="ttdeci">#define ARM_USART_EVENT_SEND_COMPLETE</div><div class="ttdoc">Send completed; however USART may still transmit data.</div></div>
 350 <div class="ttc" id="agroup__USART__events_html_gae57b9977bd338bf8bef86978843fa443"><div class="ttname"><a href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a></div><div class="ttdeci">#define ARM_USART_EVENT_TX_UNDERFLOW</div><div class="ttdoc">Transmit data not available (Synchronous Slave)</div></div>
 351 <div class="ttc" id="agroup__common__drv__gr_html_ad180da20fbde1d3dafc074af87c19540"><div class="ttname"><a href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">ARM_DRIVER_VERSION::api</a></div><div class="ttdeci">uint16_t api</div><div class="ttdoc">API version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:47</div></div>
 352 <div class="ttc" id="agroup__common__drv__gr_html_structARM__DRIVER__VERSION"><div class="ttname"><a href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></div><div class="ttdoc">Driver Version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:46</div></div>
 353 <div class="ttc" id="agroup__usart__data__bits_html_gadc5e8d17b5c69cd7f9135b849c2a4586"><div class="ttname"><a href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a></div><div class="ttdeci">#define ARM_USART_DATA_BITS_8</div><div class="ttdoc">8 Data bits (default)</div></div>
 354 <div class="ttc" id="agroup__usart__flow__control_html_gad04aa3fe4ea4b7363aee4bdca2ed3764"><div class="ttname"><a href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a></div><div class="ttdeci">#define ARM_USART_FLOW_CONTROL_NONE</div><div class="ttdoc">No Flow Control (default)</div></div>
 355 <div class="ttc" id="agroup__usart__interface__gr_html_a0190aabe8d8f59176be8d693f8874fb3"><div class="ttname"><a href="group__usart__interface__gr.html#a0190aabe8d8f59176be8d693f8874fb3">ARM_USART_CAPABILITIES::event_tx_complete</a></div><div class="ttdeci">uint32_t event_tx_complete</div><div class="ttdoc">Transmit completed event: ARM_USART_EVENT_TX_COMPLETE.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:305</div></div>
 356 <div class="ttc" id="agroup__usart__interface__gr_html_a24ebae5c6011631f76027f9a16eaf5ce"><div class="ttname"><a href="group__usart__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">ARM_DRIVER_USART::PowerControl</a></div><div class="ttdeci">int32_t(* PowerControl)(ARM_POWER_STATE state)</div><div class="ttdoc">Pointer to ARM_USART_PowerControl : Control USART Interface Power.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:329</div></div>
 357 <div class="ttc" id="agroup__usart__interface__gr_html_a30afd9cb3113c037b5f1926f5ef93b59"><div class="ttname"><a href="group__usart__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">ARM_DRIVER_USART::GetVersion</a></div><div class="ttdeci">ARM_DRIVER_VERSION(* GetVersion)(void)</div><div class="ttdoc">Pointer to ARM_USART_GetVersion : Get driver version.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:325</div></div>
 358 <div class="ttc" id="agroup__usart__interface__gr_html_a5e96d73d3a3c366aba50bf5304edb029"><div class="ttname"><a href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">ARM_DRIVER_USART::Control</a></div><div class="ttdeci">int32_t(* Control)(uint32_t control, uint32_t arg)</div><div class="ttdoc">Pointer to ARM_USART_Control : Control USART Interface.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:337</div></div>
 359 <div class="ttc" id="agroup__usart__interface__gr_html_a6e880dae8e9733a3c0f152a131076ca4"><div class="ttname"><a href="group__usart__interface__gr.html#a6e880dae8e9733a3c0f152a131076ca4">ARM_DRIVER_USART::Send</a></div><div class="ttdeci">int32_t(* Send)(const void *data, uint32_t num)</div><div class="ttdoc">Pointer to ARM_USART_Send : Start sending data to USART transmitter.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:330</div></div>
 360 <div class="ttc" id="agroup__usart__interface__gr_html_a784cafe08ad8f9052dca8cd8071d2a9b"><div class="ttname"><a href="group__usart__interface__gr.html#a784cafe08ad8f9052dca8cd8071d2a9b">ARM_DRIVER_USART::Receive</a></div><div class="ttdeci">int32_t(* Receive)(void *data, uint32_t num)</div><div class="ttdoc">Pointer to ARM_USART_Receive : Start receiving data from USART receiver.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:331</div></div>
 361 <div class="ttc" id="agroup__usart__interface__gr_html_a94bc477e7a6d1d30869980d7d8b8c310"><div class="ttname"><a href="group__usart__interface__gr.html#a94bc477e7a6d1d30869980d7d8b8c310">ARM_DRIVER_USART::Initialize</a></div><div class="ttdeci">int32_t(* Initialize)(ARM_USART_SignalEvent_t cb_event)</div><div class="ttdoc">Pointer to ARM_USART_Initialize : Initialize USART Interface.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:327</div></div>
 362 <div class="ttc" id="agroup__usart__interface__gr_html_ae5d58954a010f48aea6c3333c52f3ec5"><div class="ttname"><a href="group__usart__interface__gr.html#ae5d58954a010f48aea6c3333c52f3ec5">ARM_DRIVER_USART::GetCapabilities</a></div><div class="ttdeci">ARM_USART_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdoc">Pointer to ARM_USART_GetCapabilities : Get driver capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:326</div></div>
 363 <div class="ttc" id="agroup__usart__interface__gr_html_structARM__DRIVER__USART"><div class="ttname"><a href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a></div><div class="ttdoc">Access structure of the USART Driver.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:324</div></div>
 364 <div class="ttc" id="agroup__usart__interface__gr_html_structARM__USART__CAPABILITIES"><div class="ttname"><a href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a></div><div class="ttdoc">USART Device Driver Capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_USART.h:295</div></div>
 365 <div class="ttc" id="agroup__usart__misc__control_html_gad52c08553ae203d4f7741404589b8169"><div class="ttname"><a href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a></div><div class="ttdeci">#define ARM_USART_CONTROL_RX</div><div class="ttdoc">Receiver; arg: 0=disabled, 1=enabled.</div></div>
 366 <div class="ttc" id="agroup__usart__misc__control_html_gad96ea1a80c97f968fbc0ae4c20e7fa6a"><div class="ttname"><a href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a></div><div class="ttdeci">#define ARM_USART_CONTROL_TX</div><div class="ttdoc">Transmitter; arg: 0=disabled, 1=enabled.</div></div>
 367 <div class="ttc" id="agroup__usart__mode__control_html_gad85039731478c924d3b418ec00768388"><div class="ttname"><a href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a></div><div class="ttdeci">#define ARM_USART_MODE_ASYNCHRONOUS</div><div class="ttdoc">UART (Asynchronous); arg = Baudrate.</div></div>
 368 <div class="ttc" id="agroup__usart__parity__bit_html_ga141a64650f99a1f642c3b3b6ced0eb8d"><div class="ttname"><a href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a></div><div class="ttdeci">#define ARM_USART_PARITY_NONE</div><div class="ttdoc">No Parity (default)</div></div>
 369 <div class="ttc" id="agroup__usart__stop__bits_html_ga45f51a51e654b4753a538ed33f0d7d78"><div class="ttname"><a href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a></div><div class="ttdeci">#define ARM_USART_STOP_BITS_1</div><div class="ttdoc">1 Stop bit (default)</div></div>
 370 </div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 371 <a name="structARM__DRIVER__USART" id="structARM__DRIVER__USART"></a>
 372 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__USART">&#9670;&#160;</a></span>ARM_DRIVER_USART</h2>
 373
 374 <div class="memitem">
 375 <div class="memproto">
 376       <table class="memname">
 377         <tr>
 378           <td class="memname">struct ARM_DRIVER_USART</td>
 379         </tr>
 380       </table>
 381 </div><div class="memdoc">
 382 <div class="textblock"><p>Access structure of the USART Driver. </p>
 383 <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>
 384 <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>
 385 <li><b>Driver_USART0</b> is the name of the access struct of the first instance (no. 0).</li>
 386 <li><b>Driver_USART1</b> is the name of the access struct of the second instance (no. 1).</li>
 387 </ul>
 388 <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>
 389 </div><table class="memberdecls">
 390 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
 391 <tr class="memitem:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
 392 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">ARM_USART_GetVersion</a> : Get driver version.  <br /></td></tr>
 393 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 394 <tr class="memitem:ae5d58954a010f48aea6c3333c52f3ec5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ae5d58954a010f48aea6c3333c52f3ec5">GetCapabilities</a> )(void)</td></tr>
 395 <tr class="memdesc:ae5d58954a010f48aea6c3333c52f3ec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> : Get driver capabilities.  <br /></td></tr>
 396 <tr class="separator:ae5d58954a010f48aea6c3333c52f3ec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 397 <tr class="memitem:a94bc477e7a6d1d30869980d7d8b8c310"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a94bc477e7a6d1d30869980d7d8b8c310">Initialize</a> )(<a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> cb_event)</td></tr>
 398 <tr class="memdesc:a94bc477e7a6d1d30869980d7d8b8c310"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> : Initialize USART Interface.  <br /></td></tr>
 399 <tr class="separator:a94bc477e7a6d1d30869980d7d8b8c310"><td class="memSeparator" colspan="2">&#160;</td></tr>
 400 <tr class="memitem:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
 401 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize</a> : De-initialize USART Interface.  <br /></td></tr>
 402 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 403 <tr class="memitem:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 404 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">ARM_USART_PowerControl</a> : Control USART Interface Power.  <br /></td></tr>
 405 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 406 <tr class="memitem:a6e880dae8e9733a3c0f152a131076ca4"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a6e880dae8e9733a3c0f152a131076ca4">Send</a> )(const void *data, uint32_t num)</td></tr>
 407 <tr class="memdesc:a6e880dae8e9733a3c0f152a131076ca4"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
 408 <tr class="separator:a6e880dae8e9733a3c0f152a131076ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 409 <tr class="memitem:a784cafe08ad8f9052dca8cd8071d2a9b"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a784cafe08ad8f9052dca8cd8071d2a9b">Receive</a> )(void *data, uint32_t num)</td></tr>
 410 <tr class="memdesc:a784cafe08ad8f9052dca8cd8071d2a9b"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
 411 <tr class="separator:a784cafe08ad8f9052dca8cd8071d2a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 412 <tr class="memitem:a777f1c8b5e51e4f524287e060a2d1f57"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a777f1c8b5e51e4f524287e060a2d1f57">Transfer</a> )(const void *data_out, void *data_in, uint32_t num)</td></tr>
 413 <tr class="memdesc:a777f1c8b5e51e4f524287e060a2d1f57"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
 414 <tr class="separator:a777f1c8b5e51e4f524287e060a2d1f57"><td class="memSeparator" colspan="2">&#160;</td></tr>
 415 <tr class="memitem:a8be5bd53b93a8ad35c20f11d50d5749d"><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a8be5bd53b93a8ad35c20f11d50d5749d">GetTxCount</a> )(void)</td></tr>
 416 <tr class="memdesc:a8be5bd53b93a8ad35c20f11d50d5749d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> : Get transmitted data count.  <br /></td></tr>
 417 <tr class="separator:a8be5bd53b93a8ad35c20f11d50d5749d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 418 <tr class="memitem:a988e8dd6906c765f26d038bb120dae94"><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a988e8dd6906c765f26d038bb120dae94">GetRxCount</a> )(void)</td></tr>
 419 <tr class="memdesc:a988e8dd6906c765f26d038bb120dae94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a> : Get received data count.  <br /></td></tr>
 420 <tr class="separator:a988e8dd6906c765f26d038bb120dae94"><td class="memSeparator" colspan="2">&#160;</td></tr>
 421 <tr class="memitem:a5e96d73d3a3c366aba50bf5304edb029"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a> )(uint32_t control, uint32_t arg)</td></tr>
 422 <tr class="memdesc:a5e96d73d3a3c366aba50bf5304edb029"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> : Control USART Interface.  <br /></td></tr>
 423 <tr class="separator:a5e96d73d3a3c366aba50bf5304edb029"><td class="memSeparator" colspan="2">&#160;</td></tr>
 424 <tr class="memitem:ac489edd76e61a7b3e036dda47c03e7de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#ac489edd76e61a7b3e036dda47c03e7de">GetStatus</a> )(void)</td></tr>
 425 <tr class="memdesc:ac489edd76e61a7b3e036dda47c03e7de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> : Get USART status.  <br /></td></tr>
 426 <tr class="separator:ac489edd76e61a7b3e036dda47c03e7de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 427 <tr class="memitem:a873ee1ba4f501f2a0323e370c112dd2e"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a873ee1ba4f501f2a0323e370c112dd2e">SetModemControl</a> )(<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> control)</td></tr>
 428 <tr class="memdesc:a873ee1ba4f501f2a0323e370c112dd2e"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
 429 <tr class="separator:a873ee1ba4f501f2a0323e370c112dd2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 430 <tr class="memitem:a4b6f0e1cf04ab1938c47e03be8e13f02"><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>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usart__interface__gr.html#a4b6f0e1cf04ab1938c47e03be8e13f02">GetModemStatus</a> )(void)</td></tr>
 431 <tr class="memdesc:a4b6f0e1cf04ab1938c47e03be8e13f02"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
 432 <tr class="separator:a4b6f0e1cf04ab1938c47e03be8e13f02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 433 </table>
 434 <h4 class="groupheader">Field Documentation</h4>
 435 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
 436 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">&#9670;&#160;</a></span>GetVersion</h2>
 437
 438 <div class="memitem">
 439 <div class="memproto">
 440       <table class="memname">
 441         <tr>
 442           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
 443         </tr>
 444       </table>
 445 </div><div class="memdoc">
 446
 447 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gabca6151cef47565832decaf484781b61">ARM_USART_GetVersion</a> : Get driver version. </p>
 448
 449 </div>
 450 </div>
 451 <a id="ae5d58954a010f48aea6c3333c52f3ec5" name="ae5d58954a010f48aea6c3333c52f3ec5"></a>
 452 <h2 class="memtitle"><span class="permalink"><a href="#ae5d58954a010f48aea6c3333c52f3ec5">&#9670;&#160;</a></span>GetCapabilities</h2>
 453
 454 <div class="memitem">
 455 <div class="memproto">
 456       <table class="memname">
 457         <tr>
 458           <td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a>(* GetCapabilities) (void)</td>
 459         </tr>
 460       </table>
 461 </div><div class="memdoc">
 462
 463 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> : Get driver capabilities. </p>
 464
 465 </div>
 466 </div>
 467 <a id="a94bc477e7a6d1d30869980d7d8b8c310" name="a94bc477e7a6d1d30869980d7d8b8c310"></a>
 468 <h2 class="memtitle"><span class="permalink"><a href="#a94bc477e7a6d1d30869980d7d8b8c310">&#9670;&#160;</a></span>Initialize</h2>
 469
 470 <div class="memitem">
 471 <div class="memproto">
 472       <table class="memname">
 473         <tr>
 474           <td class="memname">int32_t(* Initialize) (<a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a> cb_event)</td>
 475         </tr>
 476       </table>
 477 </div><div class="memdoc">
 478
 479 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> : Initialize USART Interface. </p>
 480
 481 </div>
 482 </div>
 483 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
 484 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">&#9670;&#160;</a></span>Uninitialize</h2>
 485
 486 <div class="memitem">
 487 <div class="memproto">
 488       <table class="memname">
 489         <tr>
 490           <td class="memname">int32_t(* Uninitialize) (void)</td>
 491         </tr>
 492       </table>
 493 </div><div class="memdoc">
 494
 495 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga96f31f07a6721cf75de2a7a0ab723d26">ARM_USART_Uninitialize</a> : De-initialize USART Interface. </p>
 496
 497 </div>
 498 </div>
 499 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
 500 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">&#9670;&#160;</a></span>PowerControl</h2>
 501
 502 <div class="memitem">
 503 <div class="memproto">
 504       <table class="memname">
 505         <tr>
 506           <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
 507         </tr>
 508       </table>
 509 </div><div class="memdoc">
 510
 511 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga9bad012b28d544f3eeeea9c2f71a4086">ARM_USART_PowerControl</a> : Control USART Interface Power. </p>
 512
 513 </div>
 514 </div>
 515 <a id="a6e880dae8e9733a3c0f152a131076ca4" name="a6e880dae8e9733a3c0f152a131076ca4"></a>
 516 <h2 class="memtitle"><span class="permalink"><a href="#a6e880dae8e9733a3c0f152a131076ca4">&#9670;&#160;</a></span>Send</h2>
 517
 518 <div class="memitem">
 519 <div class="memproto">
 520       <table class="memname">
 521         <tr>
 522           <td class="memname">int32_t(* Send) (const void *data, uint32_t num)</td>
 523         </tr>
 524       </table>
 525 </div><div class="memdoc">
 526
 527 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> : Start sending data to USART transmitter. </p>
 528
 529 </div>
 530 </div>
 531 <a id="a784cafe08ad8f9052dca8cd8071d2a9b" name="a784cafe08ad8f9052dca8cd8071d2a9b"></a>
 532 <h2 class="memtitle"><span class="permalink"><a href="#a784cafe08ad8f9052dca8cd8071d2a9b">&#9670;&#160;</a></span>Receive</h2>
 533
 534 <div class="memitem">
 535 <div class="memproto">
 536       <table class="memname">
 537         <tr>
 538           <td class="memname">int32_t(* Receive) (void *data, uint32_t num)</td>
 539         </tr>
 540       </table>
 541 </div><div class="memdoc">
 542
 543 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gae9efabdabb5aaa17bce83339f8a58803">ARM_USART_Receive</a> : Start receiving data from USART receiver. </p>
 544
 545 </div>
 546 </div>
 547 <a id="a777f1c8b5e51e4f524287e060a2d1f57" name="a777f1c8b5e51e4f524287e060a2d1f57"></a>
 548 <h2 class="memtitle"><span class="permalink"><a href="#a777f1c8b5e51e4f524287e060a2d1f57">&#9670;&#160;</a></span>Transfer</h2>
 549
 550 <div class="memitem">
 551 <div class="memproto">
 552       <table class="memname">
 553         <tr>
 554           <td class="memname">int32_t(* Transfer) (const void *data_out, void *data_in, uint32_t num)</td>
 555         </tr>
 556       </table>
 557 </div><div class="memdoc">
 558
 559 <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>
 560
 561 </div>
 562 </div>
 563 <a id="a8be5bd53b93a8ad35c20f11d50d5749d" name="a8be5bd53b93a8ad35c20f11d50d5749d"></a>
 564 <h2 class="memtitle"><span class="permalink"><a href="#a8be5bd53b93a8ad35c20f11d50d5749d">&#9670;&#160;</a></span>GetTxCount</h2>
 565
 566 <div class="memitem">
 567 <div class="memproto">
 568       <table class="memname">
 569         <tr>
 570           <td class="memname">uint32_t(* GetTxCount) (void)</td>
 571         </tr>
 572       </table>
 573 </div><div class="memdoc">
 574
 575 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gacb355584bcdf4ebd36f11d945800fa03">ARM_USART_GetTxCount</a> : Get transmitted data count. </p>
 576
 577 </div>
 578 </div>
 579 <a id="a988e8dd6906c765f26d038bb120dae94" name="a988e8dd6906c765f26d038bb120dae94"></a>
 580 <h2 class="memtitle"><span class="permalink"><a href="#a988e8dd6906c765f26d038bb120dae94">&#9670;&#160;</a></span>GetRxCount</h2>
 581
 582 <div class="memitem">
 583 <div class="memproto">
 584       <table class="memname">
 585         <tr>
 586           <td class="memname">uint32_t(* GetRxCount) (void)</td>
 587         </tr>
 588       </table>
 589 </div><div class="memdoc">
 590
 591 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga1a8799aeeba1363a9e5d22bada715a29">ARM_USART_GetRxCount</a> : Get received data count. </p>
 592
 593 </div>
 594 </div>
 595 <a id="a5e96d73d3a3c366aba50bf5304edb029" name="a5e96d73d3a3c366aba50bf5304edb029"></a>
 596 <h2 class="memtitle"><span class="permalink"><a href="#a5e96d73d3a3c366aba50bf5304edb029">&#9670;&#160;</a></span>Control</h2>
 597
 598 <div class="memitem">
 599 <div class="memproto">
 600       <table class="memname">
 601         <tr>
 602           <td class="memname">int32_t(* Control) (uint32_t control, uint32_t arg)</td>
 603         </tr>
 604       </table>
 605 </div><div class="memdoc">
 606
 607 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad8ffdde2123b5412de3005c456da677d">ARM_USART_Control</a> : Control USART Interface. </p>
 608
 609 </div>
 610 </div>
 611 <a id="ac489edd76e61a7b3e036dda47c03e7de" name="ac489edd76e61a7b3e036dda47c03e7de"></a>
 612 <h2 class="memtitle"><span class="permalink"><a href="#ac489edd76e61a7b3e036dda47c03e7de">&#9670;&#160;</a></span>GetStatus</h2>
 613
 614 <div class="memitem">
 615 <div class="memproto">
 616       <table class="memname">
 617         <tr>
 618           <td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a>(* GetStatus) (void)</td>
 619         </tr>
 620       </table>
 621 </div><div class="memdoc">
 622
 623 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> : Get USART status. </p>
 624
 625 </div>
 626 </div>
 627 <a id="a873ee1ba4f501f2a0323e370c112dd2e" name="a873ee1ba4f501f2a0323e370c112dd2e"></a>
 628 <h2 class="memtitle"><span class="permalink"><a href="#a873ee1ba4f501f2a0323e370c112dd2e">&#9670;&#160;</a></span>SetModemControl</h2>
 629
 630 <div class="memitem">
 631 <div class="memproto">
 632       <table class="memname">
 633         <tr>
 634           <td class="memname">int32_t(* SetModemControl) (<a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a> control)</td>
 635         </tr>
 636       </table>
 637 </div><div class="memdoc">
 638
 639 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> : Set USART Modem Control line state. </p>
 640
 641 </div>
 642 </div>
 643 <a id="a4b6f0e1cf04ab1938c47e03be8e13f02" name="a4b6f0e1cf04ab1938c47e03be8e13f02"></a>
 644 <h2 class="memtitle"><span class="permalink"><a href="#a4b6f0e1cf04ab1938c47e03be8e13f02">&#9670;&#160;</a></span>GetModemStatus</h2>
 645
 646 <div class="memitem">
 647 <div class="memproto">
 648       <table class="memname">
 649         <tr>
 650           <td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a>(* GetModemStatus) (void)</td>
 651         </tr>
 652       </table>
 653 </div><div class="memdoc">
 654
 655 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> : Get USART Modem Status lines state. </p>
 656
 657 </div>
 658 </div>
 659
 660 </div>
 661 </div>
 662 <a name="structARM__USART__CAPABILITIES" id="structARM__USART__CAPABILITIES"></a>
 663 <h2 class="memtitle"><span class="permalink"><a href="#structARM__USART__CAPABILITIES">&#9670;&#160;</a></span>ARM_USART_CAPABILITIES</h2>
 664
 665 <div class="memitem">
 666 <div class="memproto">
 667       <table class="memname">
 668         <tr>
 669           <td class="memname">struct ARM_USART_CAPABILITIES</td>
 670         </tr>
 671       </table>
 672 </div><div class="memdoc">
 673 <div class="textblock"><p>USART Device Driver Capabilities. </p>
 674 <p>An USART driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
 675 <p><b>Returned by:</b></p><ul>
 676 <li><a class="el" href="group__usart__interface__gr.html#gad2d3ace1fe7627bb72945efefaeddf0a">ARM_USART_GetCapabilities</a> </li>
 677 </ul>
 678 </div><table class="fieldtable">
 679 <tr><th colspan="3">Data Fields</th></tr>
 680 <tr><td class="fieldtype">
 681 <a id="a75ba2507ea29601a309393e794f4413d" name="a75ba2507ea29601a309393e794f4413d"></a>uint32_t</td>
 682 <td class="fieldname">
 683 asynchronous: 1</td>
 684 <td class="fielddoc">
 685 supports UART (Asynchronous) mode </td></tr>
 686 <tr><td class="fieldtype">
 687 <a id="afb385bfd9fb2d714bb58aa7d8d9d7d51" name="afb385bfd9fb2d714bb58aa7d8d9d7d51"></a>uint32_t</td>
 688 <td class="fieldname">
 689 synchronous_master: 1</td>
 690 <td class="fielddoc">
 691 supports Synchronous Master mode </td></tr>
 692 <tr><td class="fieldtype">
 693 <a id="a37dcd87df8762e2bc9af9fea368b1537" name="a37dcd87df8762e2bc9af9fea368b1537"></a>uint32_t</td>
 694 <td class="fieldname">
 695 synchronous_slave: 1</td>
 696 <td class="fielddoc">
 697 supports Synchronous Slave mode </td></tr>
 698 <tr><td class="fieldtype">
 699 <a id="ad1928b61021dd9ff689a3ccf9b8966a8" name="ad1928b61021dd9ff689a3ccf9b8966a8"></a>uint32_t</td>
 700 <td class="fieldname">
 701 single_wire: 1</td>
 702 <td class="fielddoc">
 703 supports UART Single-wire mode </td></tr>
 704 <tr><td class="fieldtype">
 705 <a id="a9a72c5f0209a9ccf840fc196e9a9dffa" name="a9a72c5f0209a9ccf840fc196e9a9dffa"></a>uint32_t</td>
 706 <td class="fieldname">
 707 irda: 1</td>
 708 <td class="fielddoc">
 709 supports UART IrDA mode </td></tr>
 710 <tr><td class="fieldtype">
 711 <a id="aa78e1ee1726d1db2cfa83fd7b5acc8bd" name="aa78e1ee1726d1db2cfa83fd7b5acc8bd"></a>uint32_t</td>
 712 <td class="fieldname">
 713 smart_card: 1</td>
 714 <td class="fielddoc">
 715 supports UART Smart Card mode </td></tr>
 716 <tr><td class="fieldtype">
 717 <a id="a7b3c14ea1b5e9ba0a37ebc05fcfd51a6" name="a7b3c14ea1b5e9ba0a37ebc05fcfd51a6"></a>uint32_t</td>
 718 <td class="fieldname">
 719 smart_card_clock: 1</td>
 720 <td class="fielddoc">
 721 Smart Card Clock generator available. </td></tr>
 722 <tr><td class="fieldtype">
 723 <a id="a1d55dd339a08293018608775fc8b4859" name="a1d55dd339a08293018608775fc8b4859"></a>uint32_t</td>
 724 <td class="fieldname">
 725 flow_control_rts: 1</td>
 726 <td class="fielddoc">
 727 RTS Flow Control available. </td></tr>
 728 <tr><td class="fieldtype">
 729 <a id="a287da15773bb24a301cbfd806975e1e9" name="a287da15773bb24a301cbfd806975e1e9"></a>uint32_t</td>
 730 <td class="fieldname">
 731 flow_control_cts: 1</td>
 732 <td class="fielddoc">
 733 CTS Flow Control available. </td></tr>
 734 <tr><td class="fieldtype">
 735 <a id="a0190aabe8d8f59176be8d693f8874fb3" name="a0190aabe8d8f59176be8d693f8874fb3"></a>uint32_t</td>
 736 <td class="fieldname">
 737 event_tx_complete: 1</td>
 738 <td class="fielddoc">
 739 Transmit completed event: <a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a>. </td></tr>
 740 <tr><td class="fieldtype">
 741 <a id="afe469796cfca4ea61bd6181afb4916be" name="afe469796cfca4ea61bd6181afb4916be"></a>uint32_t</td>
 742 <td class="fieldname">
 743 event_rx_timeout: 1</td>
 744 <td class="fielddoc">
 745 Signal receive character timeout event: <a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a>. </td></tr>
 746 <tr><td class="fieldtype">
 747 <a id="afad044722f459552e9f0f602983659e9" name="afad044722f459552e9f0f602983659e9"></a>uint32_t</td>
 748 <td class="fieldname">
 749 rts: 1</td>
 750 <td class="fielddoc">
 751 RTS Line: 0=not available, 1=available. </td></tr>
 752 <tr><td class="fieldtype">
 753 <a id="a0a4ccfb729b3a40a5fd611021268c262" name="a0a4ccfb729b3a40a5fd611021268c262"></a>uint32_t</td>
 754 <td class="fieldname">
 755 cts: 1</td>
 756 <td class="fielddoc">
 757 CTS Line: 0=not available, 1=available. </td></tr>
 758 <tr><td class="fieldtype">
 759 <a id="aa3cc092c82fdc3e5e6646460be6ae9fd" name="aa3cc092c82fdc3e5e6646460be6ae9fd"></a>uint32_t</td>
 760 <td class="fieldname">
 761 dtr: 1</td>
 762 <td class="fielddoc">
 763 DTR Line: 0=not available, 1=available. </td></tr>
 764 <tr><td class="fieldtype">
 765 <a id="a437895b17519a16f920ae07461dd67d2" name="a437895b17519a16f920ae07461dd67d2"></a>uint32_t</td>
 766 <td class="fieldname">
 767 dsr: 1</td>
 768 <td class="fielddoc">
 769 DSR Line: 0=not available, 1=available. </td></tr>
 770 <tr><td class="fieldtype">
 771 <a id="aa56a9ad6e266df78157f0e04feb4b78c" name="aa56a9ad6e266df78157f0e04feb4b78c"></a>uint32_t</td>
 772 <td class="fieldname">
 773 dcd: 1</td>
 774 <td class="fielddoc">
 775 DCD Line: 0=not available, 1=available. </td></tr>
 776 <tr><td class="fieldtype">
 777 <a id="aa6cf03b82235bedc0acf00acb46130fb" name="aa6cf03b82235bedc0acf00acb46130fb"></a>uint32_t</td>
 778 <td class="fieldname">
 779 ri: 1</td>
 780 <td class="fielddoc">
 781 RI Line: 0=not available, 1=available. </td></tr>
 782 <tr><td class="fieldtype">
 783 <a id="a4ebe5ddec8d99a63843f2a3c70ac85f9" name="a4ebe5ddec8d99a63843f2a3c70ac85f9"></a>uint32_t</td>
 784 <td class="fieldname">
 785 event_cts: 1</td>
 786 <td class="fielddoc">
 787 Signal CTS change event: <a class="el" href="group__USART__events.html#ga4cd807ca131bdcb1a7eb4f223fa70476">ARM_USART_EVENT_CTS</a>. </td></tr>
 788 <tr><td class="fieldtype">
 789 <a id="aefdb61f16498d650b5a7f5f9b62779df" name="aefdb61f16498d650b5a7f5f9b62779df"></a>uint32_t</td>
 790 <td class="fieldname">
 791 event_dsr: 1</td>
 792 <td class="fielddoc">
 793 Signal DSR change event: <a class="el" href="group__USART__events.html#ga5afef591c2e8dd9bc4332b7bc8d96309">ARM_USART_EVENT_DSR</a>. </td></tr>
 794 <tr><td class="fieldtype">
 795 <a id="a7c1dd043d0db9738d6b5fa8d89211446" name="a7c1dd043d0db9738d6b5fa8d89211446"></a>uint32_t</td>
 796 <td class="fieldname">
 797 event_dcd: 1</td>
 798 <td class="fielddoc">
 799 Signal DCD change event: <a class="el" href="group__USART__events.html#ga1628b951feba1c851f424ce89da409a4">ARM_USART_EVENT_DCD</a>. </td></tr>
 800 <tr><td class="fieldtype">
 801 <a id="ab55f90aec5f909ff3a75bf36e61312ea" name="ab55f90aec5f909ff3a75bf36e61312ea"></a>uint32_t</td>
 802 <td class="fieldname">
 803 event_ri: 1</td>
 804 <td class="fielddoc">
 805 Signal RI change event: <a class="el" href="group__USART__events.html#gac17fe5723d4c5923656dadd9d1302154">ARM_USART_EVENT_RI</a>. </td></tr>
 806 <tr><td class="fieldtype">
 807 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 808 <td class="fieldname">
 809 reserved: 11</td>
 810 <td class="fielddoc">
 811 Reserved (must be zero) </td></tr>
 812 </table>
 813
 814 </div>
 815 </div>
 816 <a name="structARM__USART__STATUS" id="structARM__USART__STATUS"></a>
 817 <h2 class="memtitle"><span class="permalink"><a href="#structARM__USART__STATUS">&#9670;&#160;</a></span>ARM_USART_STATUS</h2>
 818
 819 <div class="memitem">
 820 <div class="memproto">
 821       <table class="memname">
 822         <tr>
 823           <td class="memname">struct ARM_USART_STATUS</td>
 824         </tr>
 825       </table>
 826 </div><div class="memdoc">
 827 <div class="textblock"><p>USART Status. </p>
 828 <p>Structure with information about the status of the USART. The data fields encode busy flags and error flags.</p>
 829 <p><b>Returned by:</b></p><ul>
 830 <li><a class="el" href="group__usart__interface__gr.html#ga1e8fdd54294b587438b2b72f4dbde004">ARM_USART_GetStatus</a> </li>
 831 </ul>
 832 </div><table class="fieldtable">
 833 <tr><th colspan="3">Data Fields</th></tr>
 834 <tr><td class="fieldtype">
 835 <a id="a2c6d2b67fba3f3e084e96a6bc7fcac6b" name="a2c6d2b67fba3f3e084e96a6bc7fcac6b"></a>uint32_t</td>
 836 <td class="fieldname">
 837 tx_busy: 1</td>
 838 <td class="fielddoc">
 839 Transmitter busy flag. </td></tr>
 840 <tr><td class="fieldtype">
 841 <a id="a9f5baee58ed41b382628a82a0b1cbcb4" name="a9f5baee58ed41b382628a82a0b1cbcb4"></a>uint32_t</td>
 842 <td class="fieldname">
 843 rx_busy: 1</td>
 844 <td class="fielddoc">
 845 Receiver busy flag. </td></tr>
 846 <tr><td class="fieldtype">
 847 <a id="a048f45e9d2257a21821f81d9edd17b72" name="a048f45e9d2257a21821f81d9edd17b72"></a>uint32_t</td>
 848 <td class="fieldname">
 849 tx_underflow: 1</td>
 850 <td class="fielddoc">
 851 Transmit data underflow detected (cleared on start of next send operation) </td></tr>
 852 <tr><td class="fieldtype">
 853 <a id="ac403aefd9bce8b0172e1996c0f3dd8aa" name="ac403aefd9bce8b0172e1996c0f3dd8aa"></a>uint32_t</td>
 854 <td class="fieldname">
 855 rx_overflow: 1</td>
 856 <td class="fielddoc">
 857 Receive data overflow detected (cleared on start of next receive operation) </td></tr>
 858 <tr><td class="fieldtype">
 859 <a id="aa5e3fa74f444688f9e727ffc1e988e5d" name="aa5e3fa74f444688f9e727ffc1e988e5d"></a>uint32_t</td>
 860 <td class="fieldname">
 861 rx_break: 1</td>
 862 <td class="fielddoc">
 863 Break detected on receive (cleared on start of next receive operation) </td></tr>
 864 <tr><td class="fieldtype">
 865 <a id="af1d1cfd8b231843d5cc23e6a2b1ca8d0" name="af1d1cfd8b231843d5cc23e6a2b1ca8d0"></a>uint32_t</td>
 866 <td class="fieldname">
 867 rx_framing_error: 1</td>
 868 <td class="fielddoc">
 869 Framing error detected on receive (cleared on start of next receive operation) </td></tr>
 870 <tr><td class="fieldtype">
 871 <a id="affb21b610e2d0d71727702441c238f4f" name="affb21b610e2d0d71727702441c238f4f"></a>uint32_t</td>
 872 <td class="fieldname">
 873 rx_parity_error: 1</td>
 874 <td class="fielddoc">
 875 Parity error detected on receive (cleared on start of next receive operation) </td></tr>
 876 <tr><td class="fieldtype">
 877 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 878 <td class="fieldname">
 879 reserved: 25</td>
 880 <td class="fielddoc">
 881 </td></tr>
 882 </table>
 883
 884 </div>
 885 </div>
 886 <a name="structARM__USART__MODEM__STATUS" id="structARM__USART__MODEM__STATUS"></a>
 887 <h2 class="memtitle"><span class="permalink"><a href="#structARM__USART__MODEM__STATUS">&#9670;&#160;</a></span>ARM_USART_MODEM_STATUS</h2>
 888
 889 <div class="memitem">
 890 <div class="memproto">
 891       <table class="memname">
 892         <tr>
 893           <td class="memname">struct ARM_USART_MODEM_STATUS</td>
 894         </tr>
 895       </table>
 896 </div><div class="memdoc">
 897 <div class="textblock"><p>USART Modem Status. </p>
 898 <p>Structure with information about the status of modem lines. The data fields encode states of modem status lines.</p>
 899 <p><b>Returned by:</b></p><ul>
 900 <li><a class="el" href="group__usart__interface__gr.html#ga198af0d6a7c85b7c0b96f3d9db8c34e0">ARM_USART_GetModemStatus</a> </li>
 901 </ul>
 902 </div><table class="fieldtable">
 903 <tr><th colspan="3">Data Fields</th></tr>
 904 <tr><td class="fieldtype">
 905 <a id="a0a4ccfb729b3a40a5fd611021268c262" name="a0a4ccfb729b3a40a5fd611021268c262"></a>uint32_t</td>
 906 <td class="fieldname">
 907 cts: 1</td>
 908 <td class="fielddoc">
 909 CTS state: 1=Active, 0=Inactive. </td></tr>
 910 <tr><td class="fieldtype">
 911 <a id="a437895b17519a16f920ae07461dd67d2" name="a437895b17519a16f920ae07461dd67d2"></a>uint32_t</td>
 912 <td class="fieldname">
 913 dsr: 1</td>
 914 <td class="fielddoc">
 915 DSR state: 1=Active, 0=Inactive. </td></tr>
 916 <tr><td class="fieldtype">
 917 <a id="aa56a9ad6e266df78157f0e04feb4b78c" name="aa56a9ad6e266df78157f0e04feb4b78c"></a>uint32_t</td>
 918 <td class="fieldname">
 919 dcd: 1</td>
 920 <td class="fielddoc">
 921 DCD state: 1=Active, 0=Inactive. </td></tr>
 922 <tr><td class="fieldtype">
 923 <a id="aa6cf03b82235bedc0acf00acb46130fb" name="aa6cf03b82235bedc0acf00acb46130fb"></a>uint32_t</td>
 924 <td class="fieldname">
 925 ri: 1</td>
 926 <td class="fielddoc">
 927 RI state: 1=Active, 0=Inactive. </td></tr>
 928 <tr><td class="fieldtype">
 929 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 930 <td class="fieldname">
 931 reserved: 28</td>
 932 <td class="fielddoc">
 933 </td></tr>
 934 </table>
 935
 936 </div>
 937 </div>
 938 <h2 class="groupheader">Typedef Documentation</h2>
 939 <a id="gaa578c3829eea207e9e48df6cb6f038a1" name="gaa578c3829eea207e9e48df6cb6f038a1"></a>
 940 <h2 class="memtitle"><span class="permalink"><a href="#gaa578c3829eea207e9e48df6cb6f038a1">&#9670;&#160;</a></span>ARM_USART_SignalEvent_t</h2>
 941
 942 <div class="memitem">
 943 <div class="memproto">
 944       <table class="memname">
 945         <tr>
 946           <td class="memname">ARM_USART_SignalEvent_t</td>
 947         </tr>
 948       </table>
 949 </div><div class="memdoc">
 950
 951 <p>Pointer to <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> : Signal USART Event. </p>
 952 <p>Provides the typedef for the callback function <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a>.</p>
 953 <p><b>Parameter for:</b></p><ul>
 954 <li><a class="el" href="group__usart__interface__gr.html#ga51f06805e9a6197c553fa9513ac7b9d6">ARM_USART_Initialize</a> </li>
 955 </ul>
 956
 957 </div>
 958 </div>
 959 <h2 class="groupheader">Enumeration Type Documentation</h2>
 960 <a id="ga7b89d709f048b6a956aa211f63e75f6f" name="ga7b89d709f048b6a956aa211f63e75f6f"></a>
 961 <h2 class="memtitle"><span class="permalink"><a href="#ga7b89d709f048b6a956aa211f63e75f6f">&#9670;&#160;</a></span>ARM_USART_MODEM_CONTROL</h2>
 962
 963 <div class="memitem">
 964 <div class="memproto">
 965       <table class="memname">
 966         <tr>
 967           <td class="memname">enum <a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a></td>
 968         </tr>
 969       </table>
 970 </div><div class="memdoc">
 971
 972 <p>USART Modem Control. </p>
 973 <p>Specifies values for controlling the modem control lines.</p>
 974 <p><b>Parameter for:</b></p><ul>
 975 <li><a class="el" href="group__usart__interface__gr.html#gad8eb0eb1d1c24fc725584ab93214cfc7">ARM_USART_SetModemControl</a> </li>
 976 </ul>
 977 <table class="fieldtable">
 978 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6" name="ga7b89d709f048b6a956aa211f63e75f6fab4d04e682d04f70c6aeba130656d3ec6"></a>ARM_USART_RTS_CLEAR&#160;</td><td class="fielddoc"><p>Deactivate RTS. </p>
 979 </td></tr>
 980 <tr><td class="fieldname"><a id="ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434" name="ga7b89d709f048b6a956aa211f63e75f6fa7f9d445e6e56642c4c4251a00bfa7434"></a>ARM_USART_RTS_SET&#160;</td><td class="fielddoc"><p>Activate RTS. </p>
 981 </td></tr>
 982 <tr><td class="fieldname"><a id="ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c" name="ga7b89d709f048b6a956aa211f63e75f6fa3ad44ce9f16c136ccad45c09ec65cb4c"></a>ARM_USART_DTR_CLEAR&#160;</td><td class="fielddoc"><p>Deactivate DTR. </p>
 983 </td></tr>
 984 <tr><td class="fieldname"><a id="ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4" name="ga7b89d709f048b6a956aa211f63e75f6fab938a21e1b59a2b92424e2521b9469d4"></a>ARM_USART_DTR_SET&#160;</td><td class="fielddoc"><p>Activate DTR. </p>
 985 </td></tr>
 986 </table>
 987
 988 </div>
 989 </div>
 990 <h2 class="groupheader">Function Documentation</h2>
 991 <a id="gabca6151cef47565832decaf484781b61" name="gabca6151cef47565832decaf484781b61"></a>
 992 <h2 class="memtitle"><span class="permalink"><a href="#gabca6151cef47565832decaf484781b61">&#9670;&#160;</a></span>ARM_USART_GetVersion()</h2>
 993
 994 <div class="memitem">
 995 <div class="memproto">
 996       <table class="memname">
 997         <tr>
 998           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_USART_GetVersion </td>
 999           <td>(</td>
1000           <td class="paramtype">void&#160;</td>
1001           <td class="paramname"></td><td>)</td>
1002           <td></td>
1003         </tr>
1004       </table>
1005 </div><div class="memdoc">
1006
1007 <p>Get driver version. </p>
1008 <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>
1009 <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>
1010 <li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
1011 <li>Driver version is source code version of the actual driver implementation.</li>
1012 </ul>
1013 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART0;</div>
1014 <div class="line"><a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> *drv_info;</div>
1015 <div class="line"> </div>
1016 <div class="line"><span class="keywordtype">void</span> setup_usart (<span class="keywordtype">void</span>)  {</div>
1017 <div class="line">  <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>  version;</div>
1018 <div class="line"> </div>
1019 <div class="line">  drv_info = &amp;Driver_USART0;  </div>
1020 <div class="line">  version = drv_info-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> ();</div>
1021 <div class="line">  <span class="keywordflow">if</span> (version.<a class="code hl_variable" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> &lt; 0x10A)  {      <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
1022 <div class="line">    <span class="comment">// error handling</span></div>
1023 <div class="line">    <span class="keywordflow">return</span>;</div>
1024 <div class="line">  }</div>
1025 <div class="line">}</div>
1026 </div><!-- fragment -->
1027 </div>
1028 </div>
1029 <a id="gad2d3ace1fe7627bb72945efefaeddf0a" name="gad2d3ace1fe7627bb72945efefaeddf0a"></a>
1030 <h2 class="memtitle"><span class="permalink"><a href="#gad2d3ace1fe7627bb72945efefaeddf0a">&#9670;&#160;</a></span>ARM_USART_GetCapabilities()</h2>
1031
1032 <div class="memitem">
1033 <div class="memproto">
1034       <table class="memname">
1035         <tr>
1036           <td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> ARM_USART_GetCapabilities </td>
1037           <td>(</td>
1038           <td class="paramtype">void&#160;</td>
1039           <td class="paramname"></td><td>)</td>
1040           <td></td>
1041         </tr>
1042       </table>
1043 </div><div class="memdoc">
1044
1045 <p>Get driver capabilities. </p>
1046 <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>
1047 <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 hardware and driver are capable of signaling events using the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> callback function ...</p>
1048 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART0;</div>
1049 <div class="line"><a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> *drv_info;</div>
1050 <div class="line">  </div>
1051 <div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>)  {</div>
1052 <div class="line">  <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__USART__CAPABILITIES">ARM_USART_CAPABILITIES</a> drv_capabilities;</div>
1053 <div class="line"> </div>
1054 <div class="line">  drv_info = &amp;Driver_USART0;  </div>
1055 <div class="line">  drv_capabilities = drv_info-&gt;<a class="code hl_variable" href="group__usart__interface__gr.html#ae5d58954a010f48aea6c3333c52f3ec5">GetCapabilities</a> ();</div>
1056 <div class="line">  <span class="comment">// interrogate capabilities</span></div>
1057 <div class="line"> </div>
1058 <div class="line">}</div>
1059 </div><!-- fragment -->
1060 </div>
1061 </div>
1062 <a id="ga51f06805e9a6197c553fa9513ac7b9d6" name="ga51f06805e9a6197c553fa9513ac7b9d6"></a>
1063 <h2 class="memtitle"><span class="permalink"><a href="#ga51f06805e9a6197c553fa9513ac7b9d6">&#9670;&#160;</a></span>ARM_USART_Initialize()</h2>
1064
1065 <div class="memitem">
1066 <div class="memproto">
1067       <table class="memname">
1068         <tr>
1069           <td class="memname">int32_t ARM_USART_Initialize </td>
1070           <td>(</td>
1071           <td class="paramtype"><a class="el" href="group__usart__interface__gr.html#gaa578c3829eea207e9e48df6cb6f038a1">ARM_USART_SignalEvent_t</a>&#160;</td>
1072           <td class="paramname"><em>cb_event</em></td><td>)</td>
1073           <td></td>
1074         </tr>
1075       </table>
1076 </div><div class="memdoc">
1077
1078 <p>Initialize USART Interface. </p>
1079 <dl class="params"><dt>Parameters</dt><dd>
1080   <table class="params">
1081     <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>
1082   </table>
1083   </dd>
1084 </dl>
1085 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1086 <p>The function <b>ARM_USART_Initialize</b> initializes the USART interface. It is called when the middleware component starts operation.</p>
1087 <p>The function performs the following operations:</p><ul>
1088 <li>Initializes the resources needed for the USART interface.</li>
1089 <li>Registers the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> callback function.</li>
1090 </ul>
1091 <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>
1092 <p><b>Example:</b> </p><ul>
1093 <li>see <a class="el" href="group__usart__interface__gr.html">USART Interface</a> - Driver Functions </li>
1094 </ul>
1095
1096 </div>
1097 </div>
1098 <a id="ga96f31f07a6721cf75de2a7a0ab723d26" name="ga96f31f07a6721cf75de2a7a0ab723d26"></a>
1099 <h2 class="memtitle"><span class="permalink"><a href="#ga96f31f07a6721cf75de2a7a0ab723d26">&#9670;&#160;</a></span>ARM_USART_Uninitialize()</h2>
1100
1101 <div class="memitem">
1102 <div class="memproto">
1103       <table class="memname">
1104         <tr>
1105           <td class="memname">int32_t ARM_USART_Uninitialize </td>
1106           <td>(</td>
1107           <td class="paramtype">void&#160;</td>
1108           <td class="paramname"></td><td>)</td>
1109           <td></td>
1110         </tr>
1111       </table>
1112 </div><div class="memdoc">
1113
1114 <p>De-initialize USART Interface. </p>
1115 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1116 <p>The function <b>ARM_USART_Uninitialize</b> de-initializes the resources of USART interface.</p>
1117 <p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
1118
1119 </div>
1120 </div>
1121 <a id="ga9bad012b28d544f3eeeea9c2f71a4086" name="ga9bad012b28d544f3eeeea9c2f71a4086"></a>
1122 <h2 class="memtitle"><span class="permalink"><a href="#ga9bad012b28d544f3eeeea9c2f71a4086">&#9670;&#160;</a></span>ARM_USART_PowerControl()</h2>
1123
1124 <div class="memitem">
1125 <div class="memproto">
1126       <table class="memname">
1127         <tr>
1128           <td class="memname">int32_t ARM_USART_PowerControl </td>
1129           <td>(</td>
1130           <td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>&#160;</td>
1131           <td class="paramname"><em>state</em></td><td>)</td>
1132           <td></td>
1133         </tr>
1134       </table>
1135 </div><div class="memdoc">
1136
1137 <p>Control USART Interface Power. </p>
1138 <dl class="params"><dt>Parameters</dt><dd>
1139   <table class="params">
1140     <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
1141   </table>
1142   </dd>
1143 </dl>
1144 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1145 <p>The function <b>ARM_USART_PowerControl</b> operates the power modes of the USART interface. <br  />
1146 </p>
1147 <p>The parameter <em>state</em> sets the operation and can have the following values:</p><ul>
1148 <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>
1149 <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>
1150 <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>
1151 </ul>
1152 <p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
1153
1154 </div>
1155 </div>
1156 <a id="ga5cf758b0b9d03dca68846962f73c0b08" name="ga5cf758b0b9d03dca68846962f73c0b08"></a>
1157 <h2 class="memtitle"><span class="permalink"><a href="#ga5cf758b0b9d03dca68846962f73c0b08">&#9670;&#160;</a></span>ARM_USART_Send()</h2>
1158
1159 <div class="memitem">
1160 <div class="memproto">
1161       <table class="memname">
1162         <tr>
1163           <td class="memname">int32_t ARM_USART_Send </td>
1164           <td>(</td>
1165           <td class="paramtype">const void *&#160;</td>
1166           <td class="paramname"><em>data</em>, </td>
1167         </tr>
1168         <tr>
1169           <td class="paramkey"></td>
1170           <td></td>
1171           <td class="paramtype">uint32_t&#160;</td>
1172           <td class="paramname"><em>num</em>&#160;</td>
1173         </tr>
1174         <tr>
1175           <td></td>
1176           <td>)</td>
1177           <td></td><td></td>
1178         </tr>
1179       </table>
1180 </div><div class="memdoc">
1181
1182 <p>Start sending data to USART transmitter. </p>
1183 <dl class="params"><dt>Parameters</dt><dd>
1184   <table class="params">
1185     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to send to USART transmitter </td></tr>
1186     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to send </td></tr>
1187   </table>
1188   </dd>
1189 </dl>
1190 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1191 <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>
1192 <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>
1193 <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>
1194 <p>Data type is:</p><ul>
1195 <li><em>uint8_t</em> when configured for 5..8 data bits</li>
1196 <li><em>uint16_t</em> when configured for 9 data bits</li>
1197 </ul>
1198 <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>
1199 <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>
1200 <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>
1201 <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>
1202 <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>
1203
1204 </div>
1205 </div>
1206 <a id="gae9efabdabb5aaa17bce83339f8a58803" name="gae9efabdabb5aaa17bce83339f8a58803"></a>
1207 <h2 class="memtitle"><span class="permalink"><a href="#gae9efabdabb5aaa17bce83339f8a58803">&#9670;&#160;</a></span>ARM_USART_Receive()</h2>
1208
1209 <div class="memitem">
1210 <div class="memproto">
1211       <table class="memname">
1212         <tr>
1213           <td class="memname">int32_t ARM_USART_Receive </td>
1214           <td>(</td>
1215           <td class="paramtype">void *&#160;</td>
1216           <td class="paramname"><em>data</em>, </td>
1217         </tr>
1218         <tr>
1219           <td class="paramkey"></td>
1220           <td></td>
1221           <td class="paramtype">uint32_t&#160;</td>
1222           <td class="paramname"><em>num</em>&#160;</td>
1223         </tr>
1224         <tr>
1225           <td></td>
1226           <td>)</td>
1227           <td></td><td></td>
1228         </tr>
1229       </table>
1230 </div><div class="memdoc">
1231
1232 <p>Start receiving data from USART receiver. </p>
1233 <dl class="params"><dt>Parameters</dt><dd>
1234   <table class="params">
1235     <tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to buffer for data to receive from USART receiver </td></tr>
1236     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to receive </td></tr>
1237   </table>
1238   </dd>
1239 </dl>
1240 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1241 <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>
1242 <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>
1243 <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>
1244 <p>Data type is:</p><ul>
1245 <li><em>uint8_t</em> when configured for 5..8 data bits</li>
1246 <li><em>uint16_t</em> when configured for 9 data bits</li>
1247 </ul>
1248 <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>
1249 <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>
1250 <p>During reception the following events can be generated (in asynchronous mode):</p><ul>
1251 <li><a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a> : Receive timeout between consecutive characters detected (optional)</li>
1252 <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>
1253 <li><a class="el" href="group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127">ARM_USART_EVENT_RX_FRAMING_ERROR</a> : Framing error detected</li>
1254 <li><a class="el" href="group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451">ARM_USART_EVENT_RX_PARITY_ERROR</a> : Parity error detected</li>
1255 <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>
1256 </ul>
1257 <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>
1258 <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>
1259
1260 </div>
1261 </div>
1262 <a id="ga878899928d34a818edd3e97d67b65c2a" name="ga878899928d34a818edd3e97d67b65c2a"></a>
1263 <h2 class="memtitle"><span class="permalink"><a href="#ga878899928d34a818edd3e97d67b65c2a">&#9670;&#160;</a></span>ARM_USART_Transfer()</h2>
1264
1265 <div class="memitem">
1266 <div class="memproto">
1267       <table class="memname">
1268         <tr>
1269           <td class="memname">int32_t ARM_USART_Transfer </td>
1270           <td>(</td>
1271           <td class="paramtype">const void *&#160;</td>
1272           <td class="paramname"><em>data_out</em>, </td>
1273         </tr>
1274         <tr>
1275           <td class="paramkey"></td>
1276           <td></td>
1277           <td class="paramtype">void *&#160;</td>
1278           <td class="paramname"><em>data_in</em>, </td>
1279         </tr>
1280         <tr>
1281           <td class="paramkey"></td>
1282           <td></td>
1283           <td class="paramtype">uint32_t&#160;</td>
1284           <td class="paramname"><em>num</em>&#160;</td>
1285         </tr>
1286         <tr>
1287           <td></td>
1288           <td>)</td>
1289           <td></td><td></td>
1290         </tr>
1291       </table>
1292 </div><div class="memdoc">
1293
1294 <p>Start sending/receiving data to/from USART transmitter/receiver. </p>
1295 <dl class="params"><dt>Parameters</dt><dd>
1296   <table class="params">
1297     <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>
1298     <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>
1299     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data items to transfer </td></tr>
1300   </table>
1301   </dd>
1302 </dl>
1303 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1304 <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>
1305 <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>
1306 <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>
1307 <p>Data type is:</p><ul>
1308 <li><em>uint8_t</em> when configured for 5..8 data bits</li>
1309 <li><em>uint16_t</em> when configured for 9 data bits</li>
1310 </ul>
1311 <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>
1312 <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>
1313 <p>When in synchronous slave mode also the following events can be generated:</p><ul>
1314 <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>
1315 <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>
1316 </ul>
1317 <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>
1318
1319 </div>
1320 </div>
1321 <a id="gacb355584bcdf4ebd36f11d945800fa03" name="gacb355584bcdf4ebd36f11d945800fa03"></a>
1322 <h2 class="memtitle"><span class="permalink"><a href="#gacb355584bcdf4ebd36f11d945800fa03">&#9670;&#160;</a></span>ARM_USART_GetTxCount()</h2>
1323
1324 <div class="memitem">
1325 <div class="memproto">
1326       <table class="memname">
1327         <tr>
1328           <td class="memname">uint32_t ARM_USART_GetTxCount </td>
1329           <td>(</td>
1330           <td class="paramtype">void&#160;</td>
1331           <td class="paramname"></td><td>)</td>
1332           <td></td>
1333         </tr>
1334       </table>
1335 </div><div class="memdoc">
1336
1337 <p>Get transmitted data count. </p>
1338 <dl class="section return"><dt>Returns</dt><dd>number of data items transmitted</dd></dl>
1339 <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>
1340
1341 </div>
1342 </div>
1343 <a id="ga1a8799aeeba1363a9e5d22bada715a29" name="ga1a8799aeeba1363a9e5d22bada715a29"></a>
1344 <h2 class="memtitle"><span class="permalink"><a href="#ga1a8799aeeba1363a9e5d22bada715a29">&#9670;&#160;</a></span>ARM_USART_GetRxCount()</h2>
1345
1346 <div class="memitem">
1347 <div class="memproto">
1348       <table class="memname">
1349         <tr>
1350           <td class="memname">uint32_t ARM_USART_GetRxCount </td>
1351           <td>(</td>
1352           <td class="paramtype">void&#160;</td>
1353           <td class="paramname"></td><td>)</td>
1354           <td></td>
1355         </tr>
1356       </table>
1357 </div><div class="memdoc">
1358
1359 <p>Get received data count. </p>
1360 <dl class="section return"><dt>Returns</dt><dd>number of data items received</dd></dl>
1361 <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>
1362
1363 </div>
1364 </div>
1365 <a id="gad8ffdde2123b5412de3005c456da677d" name="gad8ffdde2123b5412de3005c456da677d"></a>
1366 <h2 class="memtitle"><span class="permalink"><a href="#gad8ffdde2123b5412de3005c456da677d">&#9670;&#160;</a></span>ARM_USART_Control()</h2>
1367
1368 <div class="memitem">
1369 <div class="memproto">
1370       <table class="memname">
1371         <tr>
1372           <td class="memname">int32_t ARM_USART_Control </td>
1373           <td>(</td>
1374           <td class="paramtype">uint32_t&#160;</td>
1375           <td class="paramname"><em>control</em>, </td>
1376         </tr>
1377         <tr>
1378           <td class="paramkey"></td>
1379           <td></td>
1380           <td class="paramtype">uint32_t&#160;</td>
1381           <td class="paramname"><em>arg</em>&#160;</td>
1382         </tr>
1383         <tr>
1384           <td></td>
1385           <td>)</td>
1386           <td></td><td></td>
1387         </tr>
1388       </table>
1389 </div><div class="memdoc">
1390
1391 <p>Control USART Interface. </p>
1392 <dl class="params"><dt>Parameters</dt><dd>
1393   <table class="params">
1394     <tr><td class="paramdir">[in]</td><td class="paramname">control</td><td>Operation </td></tr>
1395     <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument of operation (optional) </td></tr>
1396   </table>
1397   </dd>
1398 </dl>
1399 <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">USART Status Error Codes</a></dd></dl>
1400 <p>The function <b>ARM_USART_Control</b> control the USART interface settings and execute various operations.</p>
1401 <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>
1402 <p>The parameter <em>arg</em> provides, depending on the operation, additional information, for example the baudrate.</p>
1403 <p>The table lists the available <em>control</em> operations.</p>
1404 <table class="cmtable">
1405 <tr>
1406 <th>Parameter <em>control</em>  </th><th style="text-align:right">Bit  </th><th>Category  </th><th>Description  </th></tr>
1407 <tr>
1408 <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>
1409 <tr>
1410 <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>
1411 <tr>
1412 <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>
1413 <tr>
1414 <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>
1415 <tr>
1416 <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>
1417 <tr>
1418 <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>
1419 <tr>
1420 <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>
1421 <tr>
1422 <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>
1423 <tr>
1424 <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>
1425 <tr>
1426 <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>
1427 <tr>
1428 <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>
1429 <tr>
1430 <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>
1431 <tr>
1432 <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>
1433 <tr>
1434 <td><a class="el" href="group__usart__parity__bit.html#ga02f30181eedd3b04d650dd507bf40d6d">ARM_USART_PARITY_ODD</a> </td><td>Set to Odd Parity </td></tr>
1435 <tr>
1436 <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>
1437 <tr>
1438 <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>
1439 <tr>
1440 <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>
1441 <tr>
1442 <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>
1443 <tr>
1444 <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>
1445 <tr>
1446 <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>
1447 <tr>
1448 <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>
1449 <tr>
1450 <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>
1451 <tr>
1452 <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-&gt;high transition) </td></tr>
1453 <tr>
1454 <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-&gt;low transition) </td></tr>
1455 <tr>
1456 <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>
1457 <tr>
1458 <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>
1459 <tr>
1460 <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  />
1461 (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>
1462 <tr>
1463 <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>
1464 <tr>
1465 <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>
1466 <tr>
1467 <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>
1468 <tr>
1469 <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>
1470 <tr>
1471 <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>
1472 <tr>
1473 <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>
1474 <tr>
1475 <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>
1476 <tr>
1477 <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>
1478 <tr>
1479 <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>
1480 <tr>
1481 <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>
1482 </table>
1483 <p><b>Example</b> </p>
1484 <div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usart__interface__gr.html#structARM__DRIVER__USART">ARM_DRIVER_USART</a> Driver_USART0;</div>
1485 <div class="line"> </div>
1486 <div class="line"><span class="comment">// configure to UART mode: 8 bits, no parity, 1 stop bit, no flow control, 9600 bps</span></div>
1487 <div class="line">status = Driver_USART0.<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a>(<a class="code hl_define" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a> | </div>
1488 <div class="line">                               <a class="code hl_define" href="group__usart__data__bits.html#gadc5e8d17b5c69cd7f9135b849c2a4586">ARM_USART_DATA_BITS_8</a> | </div>
1489 <div class="line">                               <a class="code hl_define" href="group__usart__parity__bit.html#ga141a64650f99a1f642c3b3b6ced0eb8d">ARM_USART_PARITY_NONE</a> | </div>
1490 <div class="line">                               <a class="code hl_define" href="group__usart__stop__bits.html#ga45f51a51e654b4753a538ed33f0d7d78">ARM_USART_STOP_BITS_1</a> | </div>
1491 <div class="line">                               <a class="code hl_define" href="group__usart__flow__control.html#gad04aa3fe4ea4b7363aee4bdca2ed3764">ARM_USART_FLOW_CONTROL_NONE</a>, 9600);</div>
1492 <div class="line"> </div>
1493 <div class="line"><span class="comment">// identical with above settings (default settings removed)</span></div>
1494 <div class="line"><span class="comment">// configure to UART mode: 8 bits, no parity, 1 stop bit, flow control, 9600 bps</span></div>
1495 <div class="line">status = Driver_USART0.<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a>(<a class="code hl_define" href="group__usart__mode__control.html#gad85039731478c924d3b418ec00768388">ARM_USART_MODE_ASYNCHRONOUS</a>, 9600);</div>
1496 <div class="line"> </div>
1497 <div class="line"><span class="comment">// enable TX output</span></div>
1498 <div class="line">status = Driver_USART0.<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a>(<a class="code hl_define" href="group__usart__misc__control.html#gad96ea1a80c97f968fbc0ae4c20e7fa6a">ARM_USART_CONTROL_TX</a>, 1);</div>
1499 <div class="line"> </div>
1500 <div class="line"><span class="comment">// disable RX output</span></div>
1501 <div class="line">status = Driver_USART0.<a class="code hl_variable" href="group__usart__interface__gr.html#a5e96d73d3a3c366aba50bf5304edb029">Control</a>(<a class="code hl_define" href="group__usart__misc__control.html#gad52c08553ae203d4f7741404589b8169">ARM_USART_CONTROL_RX</a>, 0);</div>
1502 </div><!-- fragment -->
1503 </div>
1504 </div>
1505 <a id="ga1e8fdd54294b587438b2b72f4dbde004" name="ga1e8fdd54294b587438b2b72f4dbde004"></a>
1506 <h2 class="memtitle"><span class="permalink"><a href="#ga1e8fdd54294b587438b2b72f4dbde004">&#9670;&#160;</a></span>ARM_USART_GetStatus()</h2>
1507
1508 <div class="memitem">
1509 <div class="memproto">
1510       <table class="memname">
1511         <tr>
1512           <td class="memname"><a class="el" href="group__usart__interface__gr.html#structARM__USART__STATUS">ARM_USART_STATUS</a> ARM_USART_GetStatus </td>
1513           <td>(</td>
1514           <td class="paramtype">void&#160;</td>
1515           <td class="paramname"></td><td>)</td>
1516           <td></td>
1517         </tr>
1518       </table>
1519 </div><div class="memdoc">
1520
1521 <p>Get USART status. </p>
1522 <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>
1523 <p>The function <b>ARM_USART_GetStatus</b> retrieves the current USART interface status. </p>
1524
1525 </div>
1526 </div>
1527 <a id="gad8eb0eb1d1c24fc725584ab93214cfc7" name="gad8eb0eb1d1c24fc725584ab93214cfc7"></a>
1528 <h2 class="memtitle"><span class="permalink"><a href="#gad8eb0eb1d1c24fc725584ab93214cfc7">&#9670;&#160;</a></span>ARM_USART_SetModemControl()</h2>
1529
1530 <div class="memitem">
1531 <div class="memproto">
1532       <table class="memname">
1533         <tr>
1534           <td class="memname">int32_t ARM_USART_SetModemControl </td>
1535           <td>(</td>
1536           <td class="paramtype"><a class="el" href="group__usart__interface__gr.html#ga7b89d709f048b6a956aa211f63e75f6f">ARM_USART_MODEM_CONTROL</a>&#160;</td>
1537           <td class="paramname"><em>control</em></td><td>)</td>
1538           <td></td>
1539         </tr>
1540       </table>
1541 </div><div class="memdoc">
1542
1543 <p>Set USART Modem Control line state. </p>
1544 <dl class="params"><dt>Parameters</dt><dd>
1545   <table class="params">
1546     <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>
1547   </table>
1548   </dd>
1549 </dl>
1550 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1551 <p>The function <b>ARM_USART_SetModemControl</b> activates or deactivates the selected USART modem control line.</p>
1552 <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>
1553
1554 </div>
1555 </div>
1556 <a id="ga198af0d6a7c85b7c0b96f3d9db8c34e0" name="ga198af0d6a7c85b7c0b96f3d9db8c34e0"></a>
1557 <h2 class="memtitle"><span class="permalink"><a href="#ga198af0d6a7c85b7c0b96f3d9db8c34e0">&#9670;&#160;</a></span>ARM_USART_GetModemStatus()</h2>
1558
1559 <div class="memitem">
1560 <div class="memproto">
1561       <table class="memname">
1562         <tr>
1563           <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>
1564           <td>(</td>
1565           <td class="paramtype">void&#160;</td>
1566           <td class="paramname"></td><td>)</td>
1567           <td></td>
1568         </tr>
1569       </table>
1570 </div><div class="memdoc">
1571
1572 <p>Get USART Modem Status lines state. </p>
1573 <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>
1574 <p>The function <b>ARM_USART_GetModemStatus</b> returns the current USART Modem Status lines state.</p>
1575 <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>
1576
1577 </div>
1578 </div>
1579 <a id="gad796cd023f8f6300a6caadcc39d43cbf" name="gad796cd023f8f6300a6caadcc39d43cbf"></a>
1580 <h2 class="memtitle"><span class="permalink"><a href="#gad796cd023f8f6300a6caadcc39d43cbf">&#9670;&#160;</a></span>ARM_USART_SignalEvent()</h2>
1581
1582 <div class="memitem">
1583 <div class="memproto">
1584       <table class="memname">
1585         <tr>
1586           <td class="memname">void ARM_USART_SignalEvent </td>
1587           <td>(</td>
1588           <td class="paramtype">uint32_t&#160;</td>
1589           <td class="paramname"><em>event</em></td><td>)</td>
1590           <td></td>
1591         </tr>
1592       </table>
1593 </div><div class="memdoc">
1594
1595 <p>Signal USART Events. </p>
1596 <dl class="params"><dt>Parameters</dt><dd>
1597   <table class="params">
1598     <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>
1599   </table>
1600   </dd>
1601 </dl>
1602 <dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
1603 <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>
1604 <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>
1605 <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>
1606 <p>The following events can be generated:</p>
1607 <table class="cmtable">
1608 <tr>
1609 <th>Parameter <em>event</em> </th><th>Bit </th><th>Description  <br  />
1610  </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>
1611 <tr>
1612 <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.  <br  />
1613  </td><td><em>always supported</em>   </td></tr>
1614 <tr>
1615 <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>.  <br  />
1616  </td><td><em>always supported</em>   </td></tr>
1617 <tr>
1618 <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>.  <br  />
1619  </td><td><em>always supported</em>   </td></tr>
1620 <tr>
1621 <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#ga5cf758b0b9d03dca68846962f73c0b08">ARM_USART_Send</a> to indicate that all the data has been physically transmitted on the wires.  </td><td>data field <em>event_tx_complete</em> = <span class="XML-Token">1</span>   </td></tr>
1622 <tr>
1623 <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>.  <br  />
1624  </td><td><em>always supported</em>   </td></tr>
1625 <tr>
1626 <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>
1627 <tr>
1628 <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). <br  />
1629  </td><td>data field <em>event_rx_timeout</em> = <span class="XML-Token">1</span>   </td></tr>
1630 <tr>
1631 <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>.  <br  />
1632  </td><td><em>always supported</em>   </td></tr>
1633 <tr>
1634 <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>.  <br  />
1635  </td><td><em>always supported</em>   </td></tr>
1636 <tr>
1637 <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>.  <br  />
1638  </td><td><em>always supported</em>   </td></tr>
1639 <tr>
1640 <td>ARM_USART_EVENT_CTS </td><td>10 </td><td>Indicates that CTS modem line state has changed. Data field <em>cts</em> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a> has changed.  <br  />
1641  </td><td>data field <em>event_cts</em> = <span class="XML-Token">1</span> and <br  />
1642  data field <em>cts</em> = <span class="XML-Token">1</span>   </td></tr>
1643 <tr>
1644 <td>ARM_USART_EVENT_DSR </td><td>11 </td><td>Indicates that DSR modem line state has changed. Data field <em>dsr</em> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a> has changed.  <br  />
1645  </td><td>data field <em>event_dsr</em> = <span class="XML-Token">1</span> and <br  />
1646  data field <em>dsr</em> = <span class="XML-Token">1</span>   </td></tr>
1647 <tr>
1648 <td>ARM_USART_EVENT_DCD </td><td>12 </td><td>Indicates that DCD modem line state has changed. Data field <em>dcd</em> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a> has changed.  <br  />
1649  </td><td>data field <em>event_dcd</em> = <span class="XML-Token">1</span> and <br  />
1650  data field <em>dcd</em> = <span class="XML-Token">1</span>   </td></tr>
1651 <tr>
1652 <td>ARM_USART_EVENT_RI </td><td>13 </td><td>Indicates that RI modem line state has changed from active to inactive (trailing edge on RI). Data field <em>ri</em> of <a class="el" href="group__usart__interface__gr.html#structARM__USART__MODEM__STATUS">ARM_USART_MODEM_STATUS</a> has changed from <span class="XML-Token">1</span> to <span class="XML-Token">0</span>.  <br  />
1653  </td><td>data field <em>event_ri</em> = <span class="XML-Token">1</span> and <br  />
1654  data field <em>ri</em> = <span class="XML-Token">1</span>   </td></tr>
1655 </table>
1656
1657 </div>
1658 </div>
1659 </div><!-- contents -->
1660 </div><!-- doc-content -->
1661 <!-- start footer part -->
1662 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1663   <ul>
1664     <li class="footer">
1665       <script type="text/javascript">
1666         <!--
1667         writeFooter.call(this);
1668         //-->
1669       </script>
1670     </li>
1671   </ul>
1672 </div>
1673 </body>
1674 </html>