web/docs/i2c__slave_8h.html

   1 <!-- HTML header for doxygen 1.8.20-->
   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">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/pico/i2c_slave.h File Reference</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.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="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('i2c__slave_8h.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#typedef-members">Typedefs</a> &#124;
 107 <a href="#enum-members">Enumerations</a> &#124;
 108 <a href="#func-members">Functions</a>  </div>
 109   <div class="headertitle"><div class="title">i2c_slave.h File Reference</div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112 <div class="textblock"><code>#include &quot;<a class="el" href="rp2__common_2hardware__i2c_2include_2hardware_2i2c_8h_source.html">hardware/i2c.h</a>&quot;</code><br />
 113 </div><div class="textblock"><div class="dynheader">
 114 Include dependency graph for i2c_slave.h:</div>
 115 <div class="dyncontent">
 116 <div class="center"><img src="i2c__slave_8h__incl.png" border="0" usemap="#ainclude_2pico_2i2c__slave_8h" alt=""/></div>
 117 <map name="ainclude_2pico_2i2c__slave_8h" id="ainclude_2pico_2i2c__slave_8h">
 118 <area shape="rect" title=" " alt="" coords="507,5,684,32"/>
 119 <area shape="rect" href="rp2__common_2hardware__i2c_2include_2hardware_2i2c_8h.html" title=" " alt="" coords="536,80,655,107"/>
 120 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="411,304,473,331"/>
 121 <area shape="rect" href="common_2pico__time_2include_2pico_2time_8h.html" title=" " alt="" coords="471,155,565,181"/>
 122 <area shape="rect" title=" " alt="" coords="589,155,756,181"/>
 123 <area shape="rect" title=" " alt="" coords="781,155,941,181"/>
 124 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,528,259,555"/>
 125 <area shape="rect" title=" " alt="" coords="252,379,365,405"/>
 126 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="390,379,494,405"/>
 127 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="596,379,717,405"/>
 128 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="741,379,836,405"/>
 129 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,603,111,629"/>
 130 <area shape="rect" title=" " alt="" coords="74,677,157,704"/>
 131 <area shape="rect" title=" " alt="" coords="211,603,281,629"/>
 132 <area shape="rect" title=" " alt="" coords="306,603,381,629"/>
 133 <area shape="rect" title=" " alt="" coords="173,453,337,480"/>
 134 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,453,543,480"/>
 135 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,453,746,480"/>
 136 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,453,930,480"/>
 137 <area shape="rect" title=" " alt="" coords="954,453,1165,480"/>
 138 <area shape="rect" title=" " alt="" coords="1189,453,1340,480"/>
 139 <area shape="rect" title=" " alt="" coords="357,528,548,555"/>
 140 <area shape="rect" href="rp2__common_2hardware__timer_2include_2hardware_2timer_8h.html" title=" " alt="" coords="521,229,654,256"/>
 141 <area shape="rect" title=" " alt="" coords="497,304,678,331"/>
 142 <area shape="rect" title=" " alt="" coords="703,304,872,331"/>
 143 </map>
 144 </div>
 145 </div>
 146 <p><a href="i2c__slave_8h_source.html">Go to the source code of this file.</a></p>
 147 <table class="memberdecls">
 148 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 149 Typedefs</h2></td></tr>
 150 <tr class="memitem:ga8d4821831a9a533b701eca1016021c33"><td class="memItemLeft" align="right" valign="top">
 151 typedef enum <a class="el" href="group__pico__i2c__slave.html#gad8b613f0d4e9d1b9511ca0b6d6ab7e8c">i2c_slave_event_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>i2c_slave_event_t</b></td></tr>
 152 <tr class="memdesc:ga8d4821831a9a533b701eca1016021c33"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2C slave event types. <br /></td></tr>
 153 <tr class="separator:ga8d4821831a9a533b701eca1016021c33"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:gaf1bb7bb1e79c309b290bf0e8ccd57dff"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__i2c__slave.html#gaf1bb7bb1e79c309b290bf0e8ccd57dff">i2c_slave_handler_t</a>) (<a class="el" href="structi2c__inst.html">i2c_inst_t</a> *i2c, <a class="el" href="group__pico__i2c__slave.html#gad8b613f0d4e9d1b9511ca0b6d6ab7e8c">i2c_slave_event_t</a> event)</td></tr>
 155 <tr class="memdesc:gaf1bb7bb1e79c309b290bf0e8ccd57dff"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2C slave event handler.  <a href="group__pico__i2c__slave.html#gaf1bb7bb1e79c309b290bf0e8ccd57dff">More...</a><br /></td></tr>
 156 <tr class="separator:gaf1bb7bb1e79c309b290bf0e8ccd57dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 </table><table class="memberdecls">
 158 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 159 Enumerations</h2></td></tr>
 160 <tr class="memitem:gad8b613f0d4e9d1b9511ca0b6d6ab7e8c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__i2c__slave.html#gad8b613f0d4e9d1b9511ca0b6d6ab7e8c">i2c_slave_event_t</a> { <a class="el" href="group__pico__i2c__slave.html#ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca7bc1a9bb9db707479c140a49c4d62a51">I2C_SLAVE_RECEIVE</a>
 161 , <a class="el" href="group__pico__i2c__slave.html#ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca495a6f0ce75738519ac201349ac38c22">I2C_SLAVE_REQUEST</a>
 162 , <a class="el" href="group__pico__i2c__slave.html#ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca857dc8c139941a8f8bb6888a84e4b83f">I2C_SLAVE_FINISH</a>
 163  }</td></tr>
 164 <tr class="memdesc:gad8b613f0d4e9d1b9511ca0b6d6ab7e8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2C slave event types.  <a href="group__pico__i2c__slave.html#gad8b613f0d4e9d1b9511ca0b6d6ab7e8c">More...</a><br /></td></tr>
 165 <tr class="separator:gad8b613f0d4e9d1b9511ca0b6d6ab7e8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 </table><table class="memberdecls">
 167 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 168 Functions</h2></td></tr>
 169 <tr class="memitem:ga2ecc43ff4a3c673a704d0c7bd7d91db4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__i2c__slave.html#ga2ecc43ff4a3c673a704d0c7bd7d91db4">i2c_slave_init</a> (<a class="el" href="structi2c__inst.html">i2c_inst_t</a> *i2c, uint8_t address, <a class="el" href="group__pico__i2c__slave.html#gaf1bb7bb1e79c309b290bf0e8ccd57dff">i2c_slave_handler_t</a> handler)</td></tr>
 170 <tr class="memdesc:ga2ecc43ff4a3c673a704d0c7bd7d91db4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure an I2C instance for slave mode.  <a href="group__pico__i2c__slave.html#ga2ecc43ff4a3c673a704d0c7bd7d91db4">More...</a><br /></td></tr>
 171 <tr class="separator:ga2ecc43ff4a3c673a704d0c7bd7d91db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:gaebbea8f5a707f23750ba3e0c8b5eb6ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__i2c__slave.html#gaebbea8f5a707f23750ba3e0c8b5eb6ee">i2c_slave_deinit</a> (<a class="el" href="structi2c__inst.html">i2c_inst_t</a> *i2c)</td></tr>
 173 <tr class="memdesc:gaebbea8f5a707f23750ba3e0c8b5eb6ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore an I2C instance to master mode.  <a href="group__pico__i2c__slave.html#gaebbea8f5a707f23750ba3e0c8b5eb6ee">More...</a><br /></td></tr>
 174 <tr class="separator:gaebbea8f5a707f23750ba3e0c8b5eb6ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 </table>
 176 </div><!-- contents -->
 177 </div><!-- doc-content -->
 178
 179         <script src="main.js"></script>
 180 </body>
 181 </html>