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