begriffs open source - cmsis/blob - v6.1.0-rc0/Driver/group__SAI__events.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: SAI Events</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__SAI__events.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a>  </div>
 129   <div class="headertitle"><div class="title">SAI Events<div class="ingroups"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>The SAI driver generates call back events that are notified via the function <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a>.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 137 Macros</h2></td></tr>
 138 <tr class="memitem:ga3dfa64375859f40d157c224187d2885e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga3dfa64375859f40d157c224187d2885e">ARM_SAI_EVENT_SEND_COMPLETE</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
 139 <tr class="memdesc:ga3dfa64375859f40d157c224187d2885e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send completed.  <br /></td></tr>
 140 <tr class="separator:ga3dfa64375859f40d157c224187d2885e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga5a9bde0b096aafe53279529a0adbef55"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga5a9bde0b096aafe53279529a0adbef55">ARM_SAI_EVENT_RECEIVE_COMPLETE</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
 142 <tr class="memdesc:ga5a9bde0b096aafe53279529a0adbef55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive completed.  <br /></td></tr>
 143 <tr class="separator:ga5a9bde0b096aafe53279529a0adbef55"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga6a0be7aaf9d700e5259f741641bc37ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga6a0be7aaf9d700e5259f741641bc37ca">ARM_SAI_EVENT_TX_UNDERFLOW</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
 145 <tr class="memdesc:ga6a0be7aaf9d700e5259f741641bc37ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit data not available.  <br /></td></tr>
 146 <tr class="separator:ga6a0be7aaf9d700e5259f741641bc37ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gac83e9df0238803ef2c88f16605f73bf5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#gac83e9df0238803ef2c88f16605f73bf5">ARM_SAI_EVENT_RX_OVERFLOW</a>&#160;&#160;&#160;(1UL &lt;&lt; 3)</td></tr>
 148 <tr class="memdesc:gac83e9df0238803ef2c88f16605f73bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive data overflow.  <br /></td></tr>
 149 <tr class="separator:gac83e9df0238803ef2c88f16605f73bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga6ffcf96fe404b48421a57fbd122b26bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SAI__events.html#ga6ffcf96fe404b48421a57fbd122b26bc">ARM_SAI_EVENT_FRAME_ERROR</a>&#160;&#160;&#160;(1UL &lt;&lt; 4)</td></tr>
 151 <tr class="memdesc:ga6ffcf96fe404b48421a57fbd122b26bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sync Frame error in Slave mode (optional)  <br /></td></tr>
 152 <tr class="separator:ga6ffcf96fe404b48421a57fbd122b26bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <p>The SAI driver generates call back events that are notified via the function <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a>. </p>
 156 <p>This section provides the event values for the <a class="el" href="group__sai__interface__gr.html#gaedf3347cb25d6bf2faad1bbb35ad79f4">ARM_SAI_SignalEvent</a> callback function.</p>
 157 <p>The following call back notification events are generated: </p>
 158 <h2 class="groupheader">Macro Definition Documentation</h2>
 159 <a id="ga3dfa64375859f40d157c224187d2885e" name="ga3dfa64375859f40d157c224187d2885e"></a>
 160 <h2 class="memtitle"><span class="permalink"><a href="#ga3dfa64375859f40d157c224187d2885e">&#9670;&#160;</a></span>ARM_SAI_EVENT_SEND_COMPLETE</h2>
 161
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">#define ARM_SAI_EVENT_SEND_COMPLETE&#160;&#160;&#160;(1UL &lt;&lt; 0)</td>
 167         </tr>
 168       </table>
 169 </div><div class="memdoc">
 170
 171 <p>Send completed. </p>
 172
 173 </div>
 174 </div>
 175 <a id="ga5a9bde0b096aafe53279529a0adbef55" name="ga5a9bde0b096aafe53279529a0adbef55"></a>
 176 <h2 class="memtitle"><span class="permalink"><a href="#ga5a9bde0b096aafe53279529a0adbef55">&#9670;&#160;</a></span>ARM_SAI_EVENT_RECEIVE_COMPLETE</h2>
 177
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">#define ARM_SAI_EVENT_RECEIVE_COMPLETE&#160;&#160;&#160;(1UL &lt;&lt; 1)</td>
 183         </tr>
 184       </table>
 185 </div><div class="memdoc">
 186
 187 <p>Receive completed. </p>
 188
 189 </div>
 190 </div>
 191 <a id="ga6a0be7aaf9d700e5259f741641bc37ca" name="ga6a0be7aaf9d700e5259f741641bc37ca"></a>
 192 <h2 class="memtitle"><span class="permalink"><a href="#ga6a0be7aaf9d700e5259f741641bc37ca">&#9670;&#160;</a></span>ARM_SAI_EVENT_TX_UNDERFLOW</h2>
 193
 194 <div class="memitem">
 195 <div class="memproto">
 196       <table class="memname">
 197         <tr>
 198           <td class="memname">#define ARM_SAI_EVENT_TX_UNDERFLOW&#160;&#160;&#160;(1UL &lt;&lt; 2)</td>
 199         </tr>
 200       </table>
 201 </div><div class="memdoc">
 202
 203 <p>Transmit data not available. </p>
 204
 205 </div>
 206 </div>
 207 <a id="gac83e9df0238803ef2c88f16605f73bf5" name="gac83e9df0238803ef2c88f16605f73bf5"></a>
 208 <h2 class="memtitle"><span class="permalink"><a href="#gac83e9df0238803ef2c88f16605f73bf5">&#9670;&#160;</a></span>ARM_SAI_EVENT_RX_OVERFLOW</h2>
 209
 210 <div class="memitem">
 211 <div class="memproto">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname">#define ARM_SAI_EVENT_RX_OVERFLOW&#160;&#160;&#160;(1UL &lt;&lt; 3)</td>
 215         </tr>
 216       </table>
 217 </div><div class="memdoc">
 218
 219 <p>Receive data overflow. </p>
 220
 221 </div>
 222 </div>
 223 <a id="ga6ffcf96fe404b48421a57fbd122b26bc" name="ga6ffcf96fe404b48421a57fbd122b26bc"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#ga6ffcf96fe404b48421a57fbd122b26bc">&#9670;&#160;</a></span>ARM_SAI_EVENT_FRAME_ERROR</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">#define ARM_SAI_EVENT_FRAME_ERROR&#160;&#160;&#160;(1UL &lt;&lt; 4)</td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234
 235 <p>Sync Frame error in Slave mode (optional) </p>
 236
 237 </div>
 238 </div>
 239 </div><!-- contents -->
 240 </div><!-- doc-content -->
 241 <!-- start footer part -->
 242 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 243   <ul>
 244     <li class="footer">
 245       <script type="text/javascript">
 246         <!--
 247         writeFooter.call(this);
 248         //-->
 249       </script>
 250     </li>
 251   </ul>
 252 </div>
 253 </body>
 254 </html>