web/docs/group__pico__i2c__slave.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: pico_i2c_slave</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('group__pico__i2c__slave.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">pico_i2c_slave<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a></div></div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112
 113 <p>Functions providing an interrupt driven I2C slave interface.
 114 <a href="#details">More...</a></p>
 115 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 117 Typedefs</h2></td></tr>
 118 <tr class="memitem:ga8d4821831a9a533b701eca1016021c33"><td class="memItemLeft" align="right" valign="top"><a id="ga8d4821831a9a533b701eca1016021c33" name="ga8d4821831a9a533b701eca1016021c33"></a>
 119 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>
 120 <tr class="memdesc:ga8d4821831a9a533b701eca1016021c33"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2C slave event types. <br /></td></tr>
 121 <tr class="separator:ga8d4821831a9a533b701eca1016021c33"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <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>
 123 <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>
 124 <tr class="separator:gaf1bb7bb1e79c309b290bf0e8ccd57dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 </table><table class="memberdecls">
 126 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 127 Enumerations</h2></td></tr>
 128 <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>
 129 , <a class="el" href="group__pico__i2c__slave.html#ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca495a6f0ce75738519ac201349ac38c22">I2C_SLAVE_REQUEST</a>
 130 , <a class="el" href="group__pico__i2c__slave.html#ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca857dc8c139941a8f8bb6888a84e4b83f">I2C_SLAVE_FINISH</a>
 131  }</td></tr>
 132 <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>
 133 <tr class="separator:gad8b613f0d4e9d1b9511ca0b6d6ab7e8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 </table><table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 136 Functions</h2></td></tr>
 137 <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>
 138 <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>
 139 <tr class="separator:ga2ecc43ff4a3c673a704d0c7bd7d91db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:gaebbea8f5a707f23750ba3e0c8b5eb6ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table>
 144 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 145 <p >Functions providing an interrupt driven I2C slave interface. </p>
 146 <p >This I2C slave helper library configures slave mode and hooks the relevant I2C IRQ so that a user supplied handler is called with enumerated I2C events.</p>
 147 <p >An example application <code>slave_mem_i2c</code>, which makes use of this library, can be found in <a href="https://github.com/raspberrypi/pico-examples/blob/master/i2c/slave_mem_i2c/slave_mem_i2c.c">pico_examples</a>. </p>
 148 <h2 class="groupheader">Typedef Documentation</h2>
 149 <a id="gaf1bb7bb1e79c309b290bf0e8ccd57dff" name="gaf1bb7bb1e79c309b290bf0e8ccd57dff"></a>
 150 <h2 class="memtitle"><span class="permalink"><a href="#gaf1bb7bb1e79c309b290bf0e8ccd57dff">&#9670;&nbsp;</a></span>i2c_slave_handler_t</h2>
 151
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">typedef void(* i2c_slave_handler_t) (<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>
 157         </tr>
 158       </table>
 159 </div><div class="memdoc">
 160
 161 <p>I2C slave event handler. </p>
 162 <p >The event handler will run from the I2C ISR, so it should return quickly (under 25 us at 400 kb/s). Avoid blocking inside the handler and split large data transfers across multiple calls for best results. When sending data to master, up to <a class="el" href="group__hardware__i2c.html#ga93f40022189e591521dd0ae5e29708ff">i2c_get_write_available()</a> bytes can be written without blocking. When receiving data from master, up to <a class="el" href="group__hardware__i2c.html#ga5df361f77f110bbc2b63baa999507bde">i2c_get_read_available()</a> bytes can be read without blocking.</p>
 163 <dl class="params"><dt>Parameters</dt><dd>
 164   <table class="params">
 165     <tr><td class="paramname">i2c</td><td>Either <a class="el" href="rp2__common_2hardware__i2c_2include_2hardware_2i2c_8h.html#a46204d38a512926541fd8bac2b62c720">i2c0</a> or <a class="el" href="rp2__common_2hardware__i2c_2include_2hardware_2i2c_8h.html#a87659b485d9e76dfc3bcef208ac4b573">i2c1</a> </td></tr>
 166     <tr><td class="paramname">event</td><td>Event type. </td></tr>
 167   </table>
 168   </dd>
 169 </dl>
 170
 171 </div>
 172 </div>
 173 <h2 class="groupheader">Enumeration Type Documentation</h2>
 174 <a id="gad8b613f0d4e9d1b9511ca0b6d6ab7e8c" name="gad8b613f0d4e9d1b9511ca0b6d6ab7e8c"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#gad8b613f0d4e9d1b9511ca0b6d6ab7e8c">&#9670;&nbsp;</a></span>i2c_slave_event_t</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">enum <a class="el" href="group__pico__i2c__slave.html#gad8b613f0d4e9d1b9511ca0b6d6ab7e8c">i2c_slave_event_t</a></td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 <p>I2C slave event types. </p>
 187 <table class="fieldtable">
 188 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca7bc1a9bb9db707479c140a49c4d62a51" name="ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca7bc1a9bb9db707479c140a49c4d62a51"></a>I2C_SLAVE_RECEIVE&#160;</td><td class="fielddoc"><p >Data from master is available for reading. Slave must read from Rx FIFO. </p>
 189 </td></tr>
 190 <tr><td class="fieldname"><a id="ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca495a6f0ce75738519ac201349ac38c22" name="ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca495a6f0ce75738519ac201349ac38c22"></a>I2C_SLAVE_REQUEST&#160;</td><td class="fielddoc"><p >Master is requesting data. Slave must write into Tx FIFO. </p>
 191 </td></tr>
 192 <tr><td class="fieldname"><a id="ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca857dc8c139941a8f8bb6888a84e4b83f" name="ggad8b613f0d4e9d1b9511ca0b6d6ab7e8ca857dc8c139941a8f8bb6888a84e4b83f"></a>I2C_SLAVE_FINISH&#160;</td><td class="fielddoc"><p >Master has sent a Stop or Restart signal. Slave may prepare for the next transfer. </p>
 193 </td></tr>
 194 </table>
 195
 196 </div>
 197 </div>
 198 <h2 class="groupheader">Function Documentation</h2>
 199 <a id="gaebbea8f5a707f23750ba3e0c8b5eb6ee" name="gaebbea8f5a707f23750ba3e0c8b5eb6ee"></a>
 200 <h2 class="memtitle"><span class="permalink"><a href="#gaebbea8f5a707f23750ba3e0c8b5eb6ee">&#9670;&nbsp;</a></span>i2c_slave_deinit()</h2>
 201
 202 <div class="memitem">
 203 <div class="memproto">
 204       <table class="memname">
 205         <tr>
 206           <td class="memname">void i2c_slave_deinit </td>
 207           <td>(</td>
 208           <td class="paramtype"><a class="el" href="structi2c__inst.html">i2c_inst_t</a> *&#160;</td>
 209           <td class="paramname"><em>i2c</em></td><td>)</td>
 210           <td></td>
 211         </tr>
 212       </table>
 213 </div><div class="memdoc">
 214
 215 <p>Restore an I2C instance to master mode. </p>
 216 <dl class="params"><dt>Parameters</dt><dd>
 217   <table class="params">
 218     <tr><td class="paramname">i2c</td><td>Either <a class="el" href="rp2__common_2hardware__i2c_2include_2hardware_2i2c_8h.html#a46204d38a512926541fd8bac2b62c720">i2c0</a> or <a class="el" href="rp2__common_2hardware__i2c_2include_2hardware_2i2c_8h.html#a87659b485d9e76dfc3bcef208ac4b573">i2c1</a> </td></tr>
 219   </table>
 220   </dd>
 221 </dl>
 222
 223 </div>
 224 </div>
 225 <a id="ga2ecc43ff4a3c673a704d0c7bd7d91db4" name="ga2ecc43ff4a3c673a704d0c7bd7d91db4"></a>
 226 <h2 class="memtitle"><span class="permalink"><a href="#ga2ecc43ff4a3c673a704d0c7bd7d91db4">&#9670;&nbsp;</a></span>i2c_slave_init()</h2>
 227
 228 <div class="memitem">
 229 <div class="memproto">
 230       <table class="memname">
 231         <tr>
 232           <td class="memname">void i2c_slave_init </td>
 233           <td>(</td>
 234           <td class="paramtype"><a class="el" href="structi2c__inst.html">i2c_inst_t</a> *&#160;</td>
 235           <td class="paramname"><em>i2c</em>, </td>
 236         </tr>
 237         <tr>
 238           <td class="paramkey"></td>
 239           <td></td>
 240           <td class="paramtype">uint8_t&#160;</td>
 241           <td class="paramname"><em>address</em>, </td>
 242         </tr>
 243         <tr>
 244           <td class="paramkey"></td>
 245           <td></td>
 246           <td class="paramtype"><a class="el" href="group__pico__i2c__slave.html#gaf1bb7bb1e79c309b290bf0e8ccd57dff">i2c_slave_handler_t</a>&#160;</td>
 247           <td class="paramname"><em>handler</em>&#160;</td>
 248         </tr>
 249         <tr>
 250           <td></td>
 251           <td>)</td>
 252           <td></td><td></td>
 253         </tr>
 254       </table>
 255 </div><div class="memdoc">
 256
 257 <p>Configure an I2C instance for slave mode. </p>
 258 <dl class="params"><dt>Parameters</dt><dd>
 259   <table class="params">
 260     <tr><td class="paramname">i2c</td><td>I2C instance. </td></tr>
 261     <tr><td class="paramname">address</td><td>7-bit slave address. </td></tr>
 262     <tr><td class="paramname">handler</td><td>Callback for events from I2C master. It will run from the I2C ISR, on the CPU core where the slave was initialised. </td></tr>
 263   </table>
 264   </dd>
 265 </dl>
 266
 267 </div>
 268 </div>
 269 </div><!-- contents -->
 270 </div><!-- doc-content -->
 271
 272         <script src="main.js"></script>
 273 </body>
 274 </html>