<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>USART Events</title> <title>CMSIS-Driver: USART Events</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="cmsis.css" rel="stylesheet" type="text/css" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <script type="text/javascript" src="printComponentTabs.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 46px;"> <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Driver  <span id="projectnumber">Version 2.05</span> </div> <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <div id="CMSISnav" class="tabs1"> <ul class="tablist"> <script type="text/javascript"> <!-- writeComponentTabs.call(this); //--> </script> </ul> </div> <!-- Generated by Doxygen 1.8.6 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Usage and Description</span></a></li> <li><a href="modules.html"><span>Reference</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('group__USART__events.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> </div> <div class="headertitle"> <div class="title">USART Events<div class="ingroups"><a class="el" href="group__usart__interface__gr.html">USART Interface</a></div></div> </div> </div><!--header--> <div class="contents"> <p>The USART driver generates call back events that are notified via the function <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a>. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:gaae1c626192b16ccace93f3546e7884bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gaae1c626192b16ccace93f3546e7884bf">ARM_USART_EVENT_SEND_COMPLETE</a>   (1UL << 0)</td></tr> <tr class="memdesc:gaae1c626192b16ccace93f3546e7884bf"><td class="mdescLeft"> </td><td class="mdescRight">Send completed; however USART may still transmit data. <a href="#gaae1c626192b16ccace93f3546e7884bf">More...</a><br/></td></tr> <tr class="separator:gaae1c626192b16ccace93f3546e7884bf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga08b165fd8525e44e3ce42ed6183cd30a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga08b165fd8525e44e3ce42ed6183cd30a">ARM_USART_EVENT_RECEIVE_COMPLETE</a>   (1UL << 1)</td></tr> <tr class="memdesc:ga08b165fd8525e44e3ce42ed6183cd30a"><td class="mdescLeft"> </td><td class="mdescRight">Receive completed. <a href="#ga08b165fd8525e44e3ce42ed6183cd30a">More...</a><br/></td></tr> <tr class="separator:ga08b165fd8525e44e3ce42ed6183cd30a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0599793e6aa531d56ff9f81ff12605d7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga0599793e6aa531d56ff9f81ff12605d7">ARM_USART_EVENT_TRANSFER_COMPLETE</a>   (1UL << 2)</td></tr> <tr class="memdesc:ga0599793e6aa531d56ff9f81ff12605d7"><td class="mdescLeft"> </td><td class="mdescRight">Transfer completed. <a href="#ga0599793e6aa531d56ff9f81ff12605d7">More...</a><br/></td></tr> <tr class="separator:ga0599793e6aa531d56ff9f81ff12605d7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga12872a3b04343f97d9535b5b0d37286d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga12872a3b04343f97d9535b5b0d37286d">ARM_USART_EVENT_TX_COMPLETE</a>   (1UL << 3)</td></tr> <tr class="memdesc:ga12872a3b04343f97d9535b5b0d37286d"><td class="mdescLeft"> </td><td class="mdescRight">Transmit completed (optional) <a href="#ga12872a3b04343f97d9535b5b0d37286d">More...</a><br/></td></tr> <tr class="separator:ga12872a3b04343f97d9535b5b0d37286d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae57b9977bd338bf8bef86978843fa443"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gae57b9977bd338bf8bef86978843fa443">ARM_USART_EVENT_TX_UNDERFLOW</a>   (1UL << 4)</td></tr> <tr class="memdesc:gae57b9977bd338bf8bef86978843fa443"><td class="mdescLeft"> </td><td class="mdescRight">Transmit data not available (Synchronous Slave) <a href="#gae57b9977bd338bf8bef86978843fa443">More...</a><br/></td></tr> <tr class="separator:gae57b9977bd338bf8bef86978843fa443"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga43a0869daf83abb3fea96926a97047ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga43a0869daf83abb3fea96926a97047ad">ARM_USART_EVENT_RX_OVERFLOW</a>   (1UL << 5)</td></tr> <tr class="memdesc:ga43a0869daf83abb3fea96926a97047ad"><td class="mdescLeft"> </td><td class="mdescRight">Receive data overflow. <a href="#ga43a0869daf83abb3fea96926a97047ad">More...</a><br/></td></tr> <tr class="separator:ga43a0869daf83abb3fea96926a97047ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga66ee2256571450a3fc3c530344ea9bd7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga66ee2256571450a3fc3c530344ea9bd7">ARM_USART_EVENT_RX_TIMEOUT</a>   (1UL << 6)</td></tr> <tr class="memdesc:ga66ee2256571450a3fc3c530344ea9bd7"><td class="mdescLeft"> </td><td class="mdescRight">Receive character timeout (optional) <a href="#ga66ee2256571450a3fc3c530344ea9bd7">More...</a><br/></td></tr> <tr class="separator:ga66ee2256571450a3fc3c530344ea9bd7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa1d19e48faf2bdc2a976de448928288e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gaa1d19e48faf2bdc2a976de448928288e">ARM_USART_EVENT_RX_BREAK</a>   (1UL << 7)</td></tr> <tr class="memdesc:gaa1d19e48faf2bdc2a976de448928288e"><td class="mdescLeft"> </td><td class="mdescRight">Break detected on receive. <a href="#gaa1d19e48faf2bdc2a976de448928288e">More...</a><br/></td></tr> <tr class="separator:gaa1d19e48faf2bdc2a976de448928288e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2d97495c650220fbfe9d6977d0953127"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga2d97495c650220fbfe9d6977d0953127">ARM_USART_EVENT_RX_FRAMING_ERROR</a>   (1UL << 8)</td></tr> <tr class="memdesc:ga2d97495c650220fbfe9d6977d0953127"><td class="mdescLeft"> </td><td class="mdescRight">Framing error detected on receive. <a href="#ga2d97495c650220fbfe9d6977d0953127">More...</a><br/></td></tr> <tr class="separator:ga2d97495c650220fbfe9d6977d0953127"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadb4fec2530fc5ae3ad2b056741883451"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gadb4fec2530fc5ae3ad2b056741883451">ARM_USART_EVENT_RX_PARITY_ERROR</a>   (1UL << 9)</td></tr> <tr class="memdesc:gadb4fec2530fc5ae3ad2b056741883451"><td class="mdescLeft"> </td><td class="mdescRight">Parity error detected on receive. <a href="#gadb4fec2530fc5ae3ad2b056741883451">More...</a><br/></td></tr> <tr class="separator:gadb4fec2530fc5ae3ad2b056741883451"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4cd807ca131bdcb1a7eb4f223fa70476"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga4cd807ca131bdcb1a7eb4f223fa70476">ARM_USART_EVENT_CTS</a>   (1UL << 10)</td></tr> <tr class="memdesc:ga4cd807ca131bdcb1a7eb4f223fa70476"><td class="mdescLeft"> </td><td class="mdescRight">CTS state changed (optional) <a href="#ga4cd807ca131bdcb1a7eb4f223fa70476">More...</a><br/></td></tr> <tr class="separator:ga4cd807ca131bdcb1a7eb4f223fa70476"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5afef591c2e8dd9bc4332b7bc8d96309"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga5afef591c2e8dd9bc4332b7bc8d96309">ARM_USART_EVENT_DSR</a>   (1UL << 11)</td></tr> <tr class="memdesc:ga5afef591c2e8dd9bc4332b7bc8d96309"><td class="mdescLeft"> </td><td class="mdescRight">DSR state changed (optional) <a href="#ga5afef591c2e8dd9bc4332b7bc8d96309">More...</a><br/></td></tr> <tr class="separator:ga5afef591c2e8dd9bc4332b7bc8d96309"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1628b951feba1c851f424ce89da409a4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#ga1628b951feba1c851f424ce89da409a4">ARM_USART_EVENT_DCD</a>   (1UL << 12)</td></tr> <tr class="memdesc:ga1628b951feba1c851f424ce89da409a4"><td class="mdescLeft"> </td><td class="mdescRight">DCD state changed (optional) <a href="#ga1628b951feba1c851f424ce89da409a4">More...</a><br/></td></tr> <tr class="separator:ga1628b951feba1c851f424ce89da409a4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac17fe5723d4c5923656dadd9d1302154"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USART__events.html#gac17fe5723d4c5923656dadd9d1302154">ARM_USART_EVENT_RI</a>   (1UL << 13)</td></tr> <tr class="memdesc:gac17fe5723d4c5923656dadd9d1302154"><td class="mdescLeft"> </td><td class="mdescRight">RI state changed (optional) <a href="#gac17fe5723d4c5923656dadd9d1302154">More...</a><br/></td></tr> <tr class="separator:gac17fe5723d4c5923656dadd9d1302154"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>The USART driver generates call back events that are notified via the function <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a>. </p> <p>This section provides the event values for the <a class="el" href="group__usart__interface__gr.html#gad796cd023f8f6300a6caadcc39d43cbf">ARM_USART_SignalEvent</a> callback function.</p> <p>The following call back notification events are generated: </p> <h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="gaae1c626192b16ccace93f3546e7884bf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_SEND_COMPLETE   (1UL << 0)</td> </tr> </table> </div><div class="memdoc"> <p>Send completed; however USART may still transmit data. </p> </div> </div> <a class="anchor" id="ga08b165fd8525e44e3ce42ed6183cd30a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RECEIVE_COMPLETE   (1UL << 1)</td> </tr> </table> </div><div class="memdoc"> <p>Receive completed. </p> </div> </div> <a class="anchor" id="ga0599793e6aa531d56ff9f81ff12605d7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_TRANSFER_COMPLETE   (1UL << 2)</td> </tr> </table> </div><div class="memdoc"> <p>Transfer completed. </p> </div> </div> <a class="anchor" id="ga12872a3b04343f97d9535b5b0d37286d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_TX_COMPLETE   (1UL << 3)</td> </tr> </table> </div><div class="memdoc"> <p>Transmit completed (optional) </p> </div> </div> <a class="anchor" id="gae57b9977bd338bf8bef86978843fa443"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_TX_UNDERFLOW   (1UL << 4)</td> </tr> </table> </div><div class="memdoc"> <p>Transmit data not available (Synchronous Slave) </p> </div> </div> <a class="anchor" id="ga43a0869daf83abb3fea96926a97047ad"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RX_OVERFLOW   (1UL << 5)</td> </tr> </table> </div><div class="memdoc"> <p>Receive data overflow. </p> </div> </div> <a class="anchor" id="ga66ee2256571450a3fc3c530344ea9bd7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RX_TIMEOUT   (1UL << 6)</td> </tr> </table> </div><div class="memdoc"> <p>Receive character timeout (optional) </p> </div> </div> <a class="anchor" id="gaa1d19e48faf2bdc2a976de448928288e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RX_BREAK   (1UL << 7)</td> </tr> </table> </div><div class="memdoc"> <p>Break detected on receive. </p> </div> </div> <a class="anchor" id="ga2d97495c650220fbfe9d6977d0953127"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RX_FRAMING_ERROR   (1UL << 8)</td> </tr> </table> </div><div class="memdoc"> <p>Framing error detected on receive. </p> </div> </div> <a class="anchor" id="gadb4fec2530fc5ae3ad2b056741883451"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RX_PARITY_ERROR   (1UL << 9)</td> </tr> </table> </div><div class="memdoc"> <p>Parity error detected on receive. </p> </div> </div> <a class="anchor" id="ga4cd807ca131bdcb1a7eb4f223fa70476"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_CTS   (1UL << 10)</td> </tr> </table> </div><div class="memdoc"> <p>CTS state changed (optional) </p> </div> </div> <a class="anchor" id="ga5afef591c2e8dd9bc4332b7bc8d96309"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_DSR   (1UL << 11)</td> </tr> </table> </div><div class="memdoc"> <p>DSR state changed (optional) </p> </div> </div> <a class="anchor" id="ga1628b951feba1c851f424ce89da409a4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_DCD   (1UL << 12)</td> </tr> </table> </div><div class="memdoc"> <p>DCD state changed (optional) </p> </div> </div> <a class="anchor" id="gac17fe5723d4c5923656dadd9d1302154"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ARM_USART_EVENT_RI   (1UL << 13)</td> </tr> </table> </div><div class="memdoc"> <p>RI state changed (optional) </p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">Generated on Wed Feb 8 2017 10:20:44 for CMSIS-Driver by ARM Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 --> </li> </ul> </div> </body> </html>