| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295 |
- <!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>I2C Events</title>
- <title>CMSIS-Driver: I2C 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.8.0</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__I2C__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">I2C Events<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <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>.
- <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:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga5992dc0f6e839c4d066cfa83d535f30d">ARM_I2C_EVENT_TRANSFER_DONE</a>   (1UL << 0)</td></tr>
- <tr class="memdesc:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="mdescLeft"> </td><td class="mdescRight">Master/Slave Transmit/Receive finished. <a href="#ga5992dc0f6e839c4d066cfa83d535f30d">More...</a><br/></td></tr>
- <tr class="separator:ga5992dc0f6e839c4d066cfa83d535f30d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gafac3989c7b57727e1bed4ee9f2496ac9">ARM_I2C_EVENT_TRANSFER_INCOMPLETE</a>   (1UL << 1)</td></tr>
- <tr class="memdesc:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="mdescLeft"> </td><td class="mdescRight">Master/Slave Transmit/Receive incomplete transfer. <a href="#gafac3989c7b57727e1bed4ee9f2496ac9">More...</a><br/></td></tr>
- <tr class="separator:gafac3989c7b57727e1bed4ee9f2496ac9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gacfbbec9af083d35e8ea87ad16e9c6ec2">ARM_I2C_EVENT_SLAVE_TRANSMIT</a>   (1UL << 2)</td></tr>
- <tr class="memdesc:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="mdescLeft"> </td><td class="mdescRight">Addressed as Slave Transmitter but transmit operation is not set. <a href="#gacfbbec9af083d35e8ea87ad16e9c6ec2">More...</a><br/></td></tr>
- <tr class="separator:gacfbbec9af083d35e8ea87ad16e9c6ec2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gabd875b57ce39dadd849c53b885ad6661"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gabd875b57ce39dadd849c53b885ad6661">ARM_I2C_EVENT_SLAVE_RECEIVE</a>   (1UL << 3)</td></tr>
- <tr class="memdesc:gabd875b57ce39dadd849c53b885ad6661"><td class="mdescLeft"> </td><td class="mdescRight">Addressed as Slave Receiver but receive operation is not set. <a href="#gabd875b57ce39dadd849c53b885ad6661">More...</a><br/></td></tr>
- <tr class="separator:gabd875b57ce39dadd849c53b885ad6661"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga98b815769634d9578526b43589caa017"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga98b815769634d9578526b43589caa017">ARM_I2C_EVENT_ADDRESS_NACK</a>   (1UL << 4)</td></tr>
- <tr class="memdesc:ga98b815769634d9578526b43589caa017"><td class="mdescLeft"> </td><td class="mdescRight">Address not acknowledged from Slave. <a href="#ga98b815769634d9578526b43589caa017">More...</a><br/></td></tr>
- <tr class="separator:ga98b815769634d9578526b43589caa017"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga3ab54410b6410ed3a58762ff0c0d68b9">ARM_I2C_EVENT_GENERAL_CALL</a>   (1UL << 5)</td></tr>
- <tr class="memdesc:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="mdescLeft"> </td><td class="mdescRight">Slave addressed with general call address. <a href="#ga3ab54410b6410ed3a58762ff0c0d68b9">More...</a><br/></td></tr>
- <tr class="separator:ga3ab54410b6410ed3a58762ff0c0d68b9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac9000f44a578e2117d64dbc2093cec6d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gac9000f44a578e2117d64dbc2093cec6d">ARM_I2C_EVENT_ARBITRATION_LOST</a>   (1UL << 6)</td></tr>
- <tr class="memdesc:gac9000f44a578e2117d64dbc2093cec6d"><td class="mdescLeft"> </td><td class="mdescRight">Master lost arbitration. <a href="#gac9000f44a578e2117d64dbc2093cec6d">More...</a><br/></td></tr>
- <tr class="separator:gac9000f44a578e2117d64dbc2093cec6d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaeef542840355131c18b53fd9ed1904a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#gaeef542840355131c18b53fd9ed1904a8">ARM_I2C_EVENT_BUS_ERROR</a>   (1UL << 7)</td></tr>
- <tr class="memdesc:gaeef542840355131c18b53fd9ed1904a8"><td class="mdescLeft"> </td><td class="mdescRight">Bus error detected (START/STOP at illegal position) <a href="#gaeef542840355131c18b53fd9ed1904a8">More...</a><br/></td></tr>
- <tr class="separator:gaeef542840355131c18b53fd9ed1904a8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__I2C__events.html#ga81ca21fad73dac1ffaff58921f848ea9">ARM_I2C_EVENT_BUS_CLEAR</a>   (1UL << 8)</td></tr>
- <tr class="memdesc:ga81ca21fad73dac1ffaff58921f848ea9"><td class="mdescLeft"> </td><td class="mdescRight">Bus clear finished. <a href="#ga81ca21fad73dac1ffaff58921f848ea9">More...</a><br/></td></tr>
- <tr class="separator:ga81ca21fad73dac1ffaff58921f848ea9"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
- <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>
- <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>
- <p>The following call back notification events are generated: </p>
- <h2 class="groupheader">Macro Definition Documentation</h2>
- <a class="anchor" id="ga5992dc0f6e839c4d066cfa83d535f30d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_TRANSFER_DONE   (1UL << 0)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Master/Slave Transmit/Receive finished. </p>
- </div>
- </div>
- <a class="anchor" id="gafac3989c7b57727e1bed4ee9f2496ac9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_TRANSFER_INCOMPLETE   (1UL << 1)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Master/Slave Transmit/Receive incomplete transfer. </p>
- </div>
- </div>
- <a class="anchor" id="gacfbbec9af083d35e8ea87ad16e9c6ec2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_SLAVE_TRANSMIT   (1UL << 2)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Addressed as Slave Transmitter but transmit operation is not set. </p>
- </div>
- </div>
- <a class="anchor" id="gabd875b57ce39dadd849c53b885ad6661"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_SLAVE_RECEIVE   (1UL << 3)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Addressed as Slave Receiver but receive operation is not set. </p>
- </div>
- </div>
- <a class="anchor" id="ga98b815769634d9578526b43589caa017"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_ADDRESS_NACK   (1UL << 4)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Address not acknowledged from Slave. </p>
- </div>
- </div>
- <a class="anchor" id="ga3ab54410b6410ed3a58762ff0c0d68b9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_GENERAL_CALL   (1UL << 5)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Slave addressed with general call address. </p>
- </div>
- </div>
- <a class="anchor" id="gac9000f44a578e2117d64dbc2093cec6d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_ARBITRATION_LOST   (1UL << 6)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Master lost arbitration. </p>
- </div>
- </div>
- <a class="anchor" id="gaeef542840355131c18b53fd9ed1904a8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_BUS_ERROR   (1UL << 7)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Bus error detected (START/STOP at illegal position) </p>
- </div>
- </div>
- <a class="anchor" id="ga81ca21fad73dac1ffaff58921f848ea9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define ARM_I2C_EVENT_BUS_CLEAR   (1UL << 8)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Bus clear finished. </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 Thu Apr 9 2020 15:49:15 for CMSIS-Driver Version 2.8.0 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>
|