web/docs/group__pico__cyw43__driver.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_cyw43_driver</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__cyw43__driver.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="#groups">Modules</a> &#124;
 107 <a href="#files">Files</a> &#124;
 108 <a href="#func-members">Functions</a>  </div>
 109   <div class="headertitle"><div class="title">pico_cyw43_driver<div class="ingroups"><a class="el" href="group__networking.html">Networking Libraries</a></div></div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112
 113 <p>A wrapper around the lower level cyw43_driver, that integrates it with <a class="el" href="group__pico__async__context.html">pico_async_context</a> for handling background work.
 114 <a href="#details">More...</a></p>
 115 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 117 Modules</h2></td></tr>
 118 <tr class="memitem:group__pico__btstack__cyw43"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__btstack__cyw43.html">pico_btstack_cyw43</a></td></tr>
 119 <tr class="memdesc:group__pico__btstack__cyw43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low-level Bluetooth HCI support. <br /></td></tr>
 120 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 </table><table class="memberdecls">
 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="files" name="files"></a>
 123 Files</h2></td></tr>
 124 <tr class="memitem:btstack__hci__transport__cyw43_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="btstack__hci__transport__cyw43_8h.html">btstack_hci_transport_cyw43.h</a></td></tr>
 125 <tr class="memdesc:btstack__hci__transport__cyw43_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds low level Bluetooth HCI support. <br /></td></tr>
 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 </table><table class="memberdecls">
 128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 129 Functions</h2></td></tr>
 130 <tr class="memitem:ga340ac6ac087a90e610820fadc0a99206"><td class="memItemLeft" align="right" valign="top">const hci_transport_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__cyw43__driver.html#ga340ac6ac087a90e610820fadc0a99206">hci_transport_cyw43_instance</a> (void)</td></tr>
 131 <tr class="memdesc:ga340ac6ac087a90e610820fadc0a99206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Bluetooth HCI transport instance for cyw43.  <a href="group__pico__cyw43__driver.html#ga340ac6ac087a90e610820fadc0a99206">More...</a><br /></td></tr>
 132 <tr class="separator:ga340ac6ac087a90e610820fadc0a99206"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:ga24c12f6110969e420954356b104aaa07"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__cyw43__driver.html#ga24c12f6110969e420954356b104aaa07">cyw43_driver_init</a> (struct <a class="el" href="structasync__context.html">async_context</a> *context)</td></tr>
 134 <tr class="memdesc:ga24c12f6110969e420954356b104aaa07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the lower level cyw43_driver and integrates it with the provided <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>.  <a href="group__pico__cyw43__driver.html#ga24c12f6110969e420954356b104aaa07">More...</a><br /></td></tr>
 135 <tr class="separator:ga24c12f6110969e420954356b104aaa07"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:gaf7f9ad52479938f40ae6b1f8c9ef80c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__cyw43__driver.html#gaf7f9ad52479938f40ae6b1f8c9ef80c3">cyw43_driver_deinit</a> (struct <a class="el" href="structasync__context.html">async_context</a> *context)</td></tr>
 137 <tr class="memdesc:gaf7f9ad52479938f40ae6b1f8c9ef80c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize the lowever level cyw43_driver and unhooks it from the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>.  <a href="group__pico__cyw43__driver.html#gaf7f9ad52479938f40ae6b1f8c9ef80c3">More...</a><br /></td></tr>
 138 <tr class="separator:gaf7f9ad52479938f40ae6b1f8c9ef80c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 </table>
 140 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 141 <p >A wrapper around the lower level cyw43_driver, that integrates it with <a class="el" href="group__pico__async__context.html">pico_async_context</a> for handling background work. </p>
 142 <h2 class="groupheader">Function Documentation</h2>
 143 <a id="gaf7f9ad52479938f40ae6b1f8c9ef80c3" name="gaf7f9ad52479938f40ae6b1f8c9ef80c3"></a>
 144 <h2 class="memtitle"><span class="permalink"><a href="#gaf7f9ad52479938f40ae6b1f8c9ef80c3">&#9670;&nbsp;</a></span>cyw43_driver_deinit()</h2>
 145
 146 <div class="memitem">
 147 <div class="memproto">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname">void cyw43_driver_deinit </td>
 151           <td>(</td>
 152           <td class="paramtype">struct <a class="el" href="structasync__context.html">async_context</a> *&#160;</td>
 153           <td class="paramname"><em>context</em></td><td>)</td>
 154           <td></td>
 155         </tr>
 156       </table>
 157 </div><div class="memdoc">
 158
 159 <p>De-initialize the lowever level cyw43_driver and unhooks it from the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>. </p>
 160 <dl class="params"><dt>Parameters</dt><dd>
 161   <table class="params">
 162     <tr><td class="paramname">context</td><td>the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a> the cyw43_driver support was added to via <a class="el" href="group__pico__cyw43__driver.html#ga24c12f6110969e420954356b104aaa07">cyw43_driver_init</a> </td></tr>
 163   </table>
 164   </dd>
 165 </dl>
 166
 167 </div>
 168 </div>
 169 <a id="ga24c12f6110969e420954356b104aaa07" name="ga24c12f6110969e420954356b104aaa07"></a>
 170 <h2 class="memtitle"><span class="permalink"><a href="#ga24c12f6110969e420954356b104aaa07">&#9670;&nbsp;</a></span>cyw43_driver_init()</h2>
 171
 172 <div class="memitem">
 173 <div class="memproto">
 174       <table class="memname">
 175         <tr>
 176           <td class="memname">bool cyw43_driver_init </td>
 177           <td>(</td>
 178           <td class="paramtype">struct <a class="el" href="structasync__context.html">async_context</a> *&#160;</td>
 179           <td class="paramname"><em>context</em></td><td>)</td>
 180           <td></td>
 181         </tr>
 182       </table>
 183 </div><div class="memdoc">
 184
 185 <p>Initializes the lower level cyw43_driver and integrates it with the provided <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>. </p>
 186 <p >If the initialization succeeds, <a class="el" href="group__pico__lwip__nosys.html#ga783b38df62817e8ef97d7d7c48664057">lwip_nosys_deinit()</a> can be called to shutdown lwIP support</p>
 187 <dl class="params"><dt>Parameters</dt><dd>
 188   <table class="params">
 189     <tr><td class="paramname">context</td><td>the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a> instance that provides the abstraction for handling asynchronous work. </td></tr>
 190   </table>
 191   </dd>
 192 </dl>
 193 <dl class="section return"><dt>Returns</dt><dd>true if the initialization succeeded </dd></dl>
 194
 195 </div>
 196 </div>
 197 <a id="ga340ac6ac087a90e610820fadc0a99206" name="ga340ac6ac087a90e610820fadc0a99206"></a>
 198 <h2 class="memtitle"><span class="permalink"><a href="#ga340ac6ac087a90e610820fadc0a99206">&#9670;&nbsp;</a></span>hci_transport_cyw43_instance()</h2>
 199
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">const hci_transport_t * hci_transport_cyw43_instance </td>
 205           <td>(</td>
 206           <td class="paramtype">void&#160;</td>
 207           <td class="paramname"></td><td>)</td>
 208           <td></td>
 209         </tr>
 210       </table>
 211 </div><div class="memdoc">
 212
 213 <p>Get the Bluetooth HCI transport instance for cyw43. </p>
 214 <dl class="section return"><dt>Returns</dt><dd>An instantiation of the hci_transport_t interface for the cyw43 chipset </dd></dl>
 215
 216 </div>
 217 </div>
 218 </div><!-- contents -->
 219 </div><!-- doc-content -->
 220
 221         <script src="main.js"></script>
 222 </body>
 223 </html>