begriffs open source - cmsis/blob - main/Driver/html/group__I2C__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: I2C Events</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__I2C__events.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="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">I2C Events<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>The I2C driver generates call back events that are notified via the function <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a>.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
 142 <tr class="memdesc:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Master/Slave Transmit/Receive finished.  <br /></td></tr>
 143 <tr class="separator:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
 145 <tr class="memdesc:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Master/Slave Transmit/Receive incomplete transfer.  <br /></td></tr>
 146 <tr class="separator:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
 148 <tr class="memdesc:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Addressed as Slave Transmitter but transmit operation is not set.  <br /></td></tr>
 149 <tr class="separator:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gabd875b57ce39dadd849c53b885ad6661"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a>&#160;&#160;&#160;(1UL &lt;&lt; 3)</td></tr>
 151 <tr class="memdesc:gabd875b57ce39dadd849c53b885ad6661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Addressed as Slave Receiver but receive operation is not set.  <br /></td></tr>
 152 <tr class="separator:gabd875b57ce39dadd849c53b885ad6661"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga98b815769634d9578526b43589caa017"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a>&#160;&#160;&#160;(1UL &lt;&lt; 4)</td></tr>
 154 <tr class="memdesc:ga98b815769634d9578526b43589caa017"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address not acknowledged from Slave.  <br /></td></tr>
 155 <tr class="separator:ga98b815769634d9578526b43589caa017"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a>&#160;&#160;&#160;(1UL &lt;&lt; 5)</td></tr>
 157 <tr class="memdesc:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slave addressed with general call address.  <br /></td></tr>
 158 <tr class="separator:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:gac9000f44a578e2117d64dbc2093cec6d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a>&#160;&#160;&#160;(1UL &lt;&lt; 6)</td></tr>
 160 <tr class="memdesc:gac9000f44a578e2117d64dbc2093cec6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Master lost arbitration.  <br /></td></tr>
 161 <tr class="separator:gac9000f44a578e2117d64dbc2093cec6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:gaeef542840355131c18b53fd9ed1904a8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a>&#160;&#160;&#160;(1UL &lt;&lt; 7)</td></tr>
 163 <tr class="memdesc:gaeef542840355131c18b53fd9ed1904a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus error detected (START/STOP at illegal position)  <br /></td></tr>
 164 <tr class="separator:gaeef542840355131c18b53fd9ed1904a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga81ca21fad73dac1ffaff58921f848ea9">ARM_I2C_EVENT_BUS_CLEAR</a>&#160;&#160;&#160;(1UL &lt;&lt; 8)</td></tr>
 166 <tr class="memdesc:ga81ca21fad73dac1ffaff58921f848ea9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus clear finished.  <br /></td></tr>
 167 <tr class="separator:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 </table>
 169 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 170 <p>The I2C driver generates call back events that are notified via the function <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a>. </p>
 171 <p>This section provides the event values for the <a class="el" href="group__i2c__interface__gr.html#gad4f93d2895794b416dc8d8e9de91c05e">ARM_I2C_SignalEvent</a> callback function.</p>
 172 <p>The following call back notification events are generated: </p>
 173 <h2 class="groupheader">Macro Definition Documentation</h2>
 174 <a id="ga5992dc0f6e839c4d066cfa83d535f30d" name="ga5992dc0f6e839c4d066cfa83d535f30d"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#ga5992dc0f6e839c4d066cfa83d535f30d">&#9670;&#160;</a></span>ARM_I2C_EVENT_TRANSFER_DONE</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">#define ARM_I2C_EVENT_TRANSFER_DONE&#160;&#160;&#160;(1UL &lt;&lt; 0)</td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 <p>Master/Slave Transmit/Receive finished. </p>
 187
 188 </div>
 189 </div>
 190 <a id="gafac3989c7b57727e1bed4ee9f2496ac9" name="gafac3989c7b57727e1bed4ee9f2496ac9"></a>
 191 <h2 class="memtitle"><span class="permalink"><a href="#gafac3989c7b57727e1bed4ee9f2496ac9">&#9670;&#160;</a></span>ARM_I2C_EVENT_TRANSFER_INCOMPLETE</h2>
 192
 193 <div class="memitem">
 194 <div class="memproto">
 195       <table class="memname">
 196         <tr>
 197           <td class="memname">#define ARM_I2C_EVENT_TRANSFER_INCOMPLETE&#160;&#160;&#160;(1UL &lt;&lt; 1)</td>
 198         </tr>
 199       </table>
 200 </div><div class="memdoc">
 201
 202 <p>Master/Slave Transmit/Receive incomplete transfer. </p>
 203
 204 </div>
 205 </div>
 206 <a id="gacfbbec9af083d35e8ea87ad16e9c6ec2" name="gacfbbec9af083d35e8ea87ad16e9c6ec2"></a>
 207 <h2 class="memtitle"><span class="permalink"><a href="#gacfbbec9af083d35e8ea87ad16e9c6ec2">&#9670;&#160;</a></span>ARM_I2C_EVENT_SLAVE_TRANSMIT</h2>
 208
 209 <div class="memitem">
 210 <div class="memproto">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname">#define ARM_I2C_EVENT_SLAVE_TRANSMIT&#160;&#160;&#160;(1UL &lt;&lt; 2)</td>
 214         </tr>
 215       </table>
 216 </div><div class="memdoc">
 217
 218 <p>Addressed as Slave Transmitter but transmit operation is not set. </p>
 219
 220 </div>
 221 </div>
 222 <a id="gabd875b57ce39dadd849c53b885ad6661" name="gabd875b57ce39dadd849c53b885ad6661"></a>
 223 <h2 class="memtitle"><span class="permalink"><a href="#gabd875b57ce39dadd849c53b885ad6661">&#9670;&#160;</a></span>ARM_I2C_EVENT_SLAVE_RECEIVE</h2>
 224
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname">#define ARM_I2C_EVENT_SLAVE_RECEIVE&#160;&#160;&#160;(1UL &lt;&lt; 3)</td>
 230         </tr>
 231       </table>
 232 </div><div class="memdoc">
 233
 234 <p>Addressed as Slave Receiver but receive operation is not set. </p>
 235
 236 </div>
 237 </div>
 238 <a id="ga98b815769634d9578526b43589caa017" name="ga98b815769634d9578526b43589caa017"></a>
 239 <h2 class="memtitle"><span class="permalink"><a href="#ga98b815769634d9578526b43589caa017">&#9670;&#160;</a></span>ARM_I2C_EVENT_ADDRESS_NACK</h2>
 240
 241 <div class="memitem">
 242 <div class="memproto">
 243       <table class="memname">
 244         <tr>
 245           <td class="memname">#define ARM_I2C_EVENT_ADDRESS_NACK&#160;&#160;&#160;(1UL &lt;&lt; 4)</td>
 246         </tr>
 247       </table>
 248 </div><div class="memdoc">
 249
 250 <p>Address not acknowledged from Slave. </p>
 251
 252 </div>
 253 </div>
 254 <a id="ga3ab54410b6410ed3a58762ff0c0d68b9" name="ga3ab54410b6410ed3a58762ff0c0d68b9"></a>
 255 <h2 class="memtitle"><span class="permalink"><a href="#ga3ab54410b6410ed3a58762ff0c0d68b9">&#9670;&#160;</a></span>ARM_I2C_EVENT_GENERAL_CALL</h2>
 256
 257 <div class="memitem">
 258 <div class="memproto">
 259       <table class="memname">
 260         <tr>
 261           <td class="memname">#define ARM_I2C_EVENT_GENERAL_CALL&#160;&#160;&#160;(1UL &lt;&lt; 5)</td>
 262         </tr>
 263       </table>
 264 </div><div class="memdoc">
 265
 266 <p>Slave addressed with general call address. </p>
 267
 268 </div>
 269 </div>
 270 <a id="gac9000f44a578e2117d64dbc2093cec6d" name="gac9000f44a578e2117d64dbc2093cec6d"></a>
 271 <h2 class="memtitle"><span class="permalink"><a href="#gac9000f44a578e2117d64dbc2093cec6d">&#9670;&#160;</a></span>ARM_I2C_EVENT_ARBITRATION_LOST</h2>
 272
 273 <div class="memitem">
 274 <div class="memproto">
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">#define ARM_I2C_EVENT_ARBITRATION_LOST&#160;&#160;&#160;(1UL &lt;&lt; 6)</td>
 278         </tr>
 279       </table>
 280 </div><div class="memdoc">
 281
 282 <p>Master lost arbitration. </p>
 283
 284 </div>
 285 </div>
 286 <a id="gaeef542840355131c18b53fd9ed1904a8" name="gaeef542840355131c18b53fd9ed1904a8"></a>
 287 <h2 class="memtitle"><span class="permalink"><a href="#gaeef542840355131c18b53fd9ed1904a8">&#9670;&#160;</a></span>ARM_I2C_EVENT_BUS_ERROR</h2>
 288
 289 <div class="memitem">
 290 <div class="memproto">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname">#define ARM_I2C_EVENT_BUS_ERROR&#160;&#160;&#160;(1UL &lt;&lt; 7)</td>
 294         </tr>
 295       </table>
 296 </div><div class="memdoc">
 297
 298 <p>Bus error detected (START/STOP at illegal position) </p>
 299
 300 </div>
 301 </div>
 302 <a id="ga81ca21fad73dac1ffaff58921f848ea9" name="ga81ca21fad73dac1ffaff58921f848ea9"></a>
 303 <h2 class="memtitle"><span class="permalink"><a href="#ga81ca21fad73dac1ffaff58921f848ea9">&#9670;&#160;</a></span>ARM_I2C_EVENT_BUS_CLEAR</h2>
 304
 305 <div class="memitem">
 306 <div class="memproto">
 307       <table class="memname">
 308         <tr>
 309           <td class="memname">#define ARM_I2C_EVENT_BUS_CLEAR&#160;&#160;&#160;(1UL &lt;&lt; 8)</td>
 310         </tr>
 311       </table>
 312 </div><div class="memdoc">
 313
 314 <p>Bus clear finished. </p>
 315
 316 </div>
 317 </div>
 318 </div><!-- contents -->
 319 </div><!-- doc-content -->
 320 <!-- start footer part -->
 321 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 322   <ul>
 323     <li class="footer">
 324       <script type="text/javascript">
 325         <!--
 326         writeFooter.call(this);
 327         //-->
 328       </script>
 329     </li>
 330   </ul>
 331 </div>
 332 </body>
 333 </html>