group__I2C__events.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>I2C Events</title>
  7. <title>CMSIS-Driver: I2C Events</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Driver
  35. &#160;<span id="projectnumber">Version 2.8.0</span>
  36. </div>
  37. <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__I2C__events.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#define-members">Macros</a> </div>
  110. <div class="headertitle">
  111. <div class="title">I2C Events<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <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>.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  118. Macros</h2></td></tr>
  119. <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>
  120. <tr class="memdesc:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Master/Slave Transmit/Receive finished. <a href="#ga5992dc0f6e839c4d066cfa83d535f30d">More...</a><br/></td></tr>
  121. <tr class="separator:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="memdesc:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Master/Slave Transmit/Receive incomplete transfer. <a href="#gafac3989c7b57727e1bed4ee9f2496ac9">More...</a><br/></td></tr>
  124. <tr class="separator:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="memdesc:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Addressed as Slave Transmitter but transmit operation is not set. <a href="#gacfbbec9af083d35e8ea87ad16e9c6ec2">More...</a><br/></td></tr>
  127. <tr class="separator:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="memdesc:gabd875b57ce39dadd849c53b885ad6661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Addressed as Slave Receiver but receive operation is not set. <a href="#gabd875b57ce39dadd849c53b885ad6661">More...</a><br/></td></tr>
  130. <tr class="separator:gabd875b57ce39dadd849c53b885ad6661"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="memdesc:ga98b815769634d9578526b43589caa017"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address not acknowledged from Slave. <a href="#ga98b815769634d9578526b43589caa017">More...</a><br/></td></tr>
  133. <tr class="separator:ga98b815769634d9578526b43589caa017"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="memdesc:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slave addressed with general call address. <a href="#ga3ab54410b6410ed3a58762ff0c0d68b9">More...</a><br/></td></tr>
  136. <tr class="separator:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="memdesc:gac9000f44a578e2117d64dbc2093cec6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Master lost arbitration. <a href="#gac9000f44a578e2117d64dbc2093cec6d">More...</a><br/></td></tr>
  139. <tr class="separator:gac9000f44a578e2117d64dbc2093cec6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="memdesc:gaeef542840355131c18b53fd9ed1904a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus error detected (START/STOP at illegal position) <a href="#gaeef542840355131c18b53fd9ed1904a8">More...</a><br/></td></tr>
  142. <tr class="separator:gaeef542840355131c18b53fd9ed1904a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="memdesc:ga81ca21fad73dac1ffaff58921f848ea9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus clear finished. <a href="#ga81ca21fad73dac1ffaff58921f848ea9">More...</a><br/></td></tr>
  145. <tr class="separator:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  148. <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>
  149. <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>
  150. <p>The following call back notification events are generated: </p>
  151. <h2 class="groupheader">Macro Definition Documentation</h2>
  152. <a class="anchor" id="ga5992dc0f6e839c4d066cfa83d535f30d"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">#define ARM_I2C_EVENT_TRANSFER_DONE&#160;&#160;&#160;(1UL &lt;&lt; 0)</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Master/Slave Transmit/Receive finished. </p>
  162. </div>
  163. </div>
  164. <a class="anchor" id="gafac3989c7b57727e1bed4ee9f2496ac9"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">#define ARM_I2C_EVENT_TRANSFER_INCOMPLETE&#160;&#160;&#160;(1UL &lt;&lt; 1)</td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Master/Slave Transmit/Receive incomplete transfer. </p>
  174. </div>
  175. </div>
  176. <a class="anchor" id="gacfbbec9af083d35e8ea87ad16e9c6ec2"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">#define ARM_I2C_EVENT_SLAVE_TRANSMIT&#160;&#160;&#160;(1UL &lt;&lt; 2)</td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Addressed as Slave Transmitter but transmit operation is not set. </p>
  186. </div>
  187. </div>
  188. <a class="anchor" id="gabd875b57ce39dadd849c53b885ad6661"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">#define ARM_I2C_EVENT_SLAVE_RECEIVE&#160;&#160;&#160;(1UL &lt;&lt; 3)</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Addressed as Slave Receiver but receive operation is not set. </p>
  198. </div>
  199. </div>
  200. <a class="anchor" id="ga98b815769634d9578526b43589caa017"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">#define ARM_I2C_EVENT_ADDRESS_NACK&#160;&#160;&#160;(1UL &lt;&lt; 4)</td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Address not acknowledged from Slave. </p>
  210. </div>
  211. </div>
  212. <a class="anchor" id="ga3ab54410b6410ed3a58762ff0c0d68b9"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">#define ARM_I2C_EVENT_GENERAL_CALL&#160;&#160;&#160;(1UL &lt;&lt; 5)</td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Slave addressed with general call address. </p>
  222. </div>
  223. </div>
  224. <a class="anchor" id="gac9000f44a578e2117d64dbc2093cec6d"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">#define ARM_I2C_EVENT_ARBITRATION_LOST&#160;&#160;&#160;(1UL &lt;&lt; 6)</td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Master lost arbitration. </p>
  234. </div>
  235. </div>
  236. <a class="anchor" id="gaeef542840355131c18b53fd9ed1904a8"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">#define ARM_I2C_EVENT_BUS_ERROR&#160;&#160;&#160;(1UL &lt;&lt; 7)</td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Bus error detected (START/STOP at illegal position) </p>
  246. </div>
  247. </div>
  248. <a class="anchor" id="ga81ca21fad73dac1ffaff58921f848ea9"></a>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">#define ARM_I2C_EVENT_BUS_CLEAR&#160;&#160;&#160;(1UL &lt;&lt; 8)</td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Bus clear finished. </p>
  258. </div>
  259. </div>
  260. </div><!-- contents -->
  261. </div><!-- doc-content -->
  262. <!-- start footer part -->
  263. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  264. <ul>
  265. <li class="footer">Generated on Thu Apr 9 2020 15:49:15 for CMSIS-Driver Version 2.8.0 by Arm Ltd. All rights reserved.
  266. <!--
  267. <a href="http://www.doxygen.org/index.html">
  268. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  269. -->
  270. </li>
  271. </ul>
  272. </div>
  273. </body>
  274. </html>