web/docs/group__pico__btstack.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_btstack</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__btstack.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="#func-members">Functions</a>  </div>
 107   <div class="headertitle"><div class="title">pico_btstack<div class="ingroups"><a class="el" href="group__networking.html">Networking Libraries</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>Integration/wrapper libraries for <a href="https://github.com/bluekitchen/btstack">BTstack</a> the documentation for which is <a href="https://bluekitchen-gmbh.com/btstack/">here</a>.
 112 <a href="#details">More...</a></p>
 113 <table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 115 Functions</h2></td></tr>
 116 <tr class="memitem:ga88f89a9b3339ebb3c570db896b66d65a"><td class="memItemLeft" align="right" valign="top">const hal_flash_bank_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__btstack.html#ga88f89a9b3339ebb3c570db896b66d65a">pico_flash_bank_instance</a> (void)</td></tr>
 117 <tr class="memdesc:ga88f89a9b3339ebb3c570db896b66d65a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the singleton BTstack HAL flash instance, used for non-volatile storage.  <a href="group__pico__btstack.html#ga88f89a9b3339ebb3c570db896b66d65a">More...</a><br /></td></tr>
 118 <tr class="separator:ga88f89a9b3339ebb3c570db896b66d65a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:ga9aa9b63d7b500add5590ea2d8a4347ed"><td class="memItemLeft" align="right" valign="top">const btstack_run_loop_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__btstack.html#ga9aa9b63d7b500add5590ea2d8a4347ed">btstack_run_loop_async_context_get_instance</a> (<a class="el" href="structasync__context.html">async_context_t</a> *context)</td></tr>
 120 <tr class="memdesc:ga9aa9b63d7b500add5590ea2d8a4347ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize and return the singleton BTstack run loop instance that integrates with 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> API.  <a href="group__pico__btstack.html#ga9aa9b63d7b500add5590ea2d8a4347ed">More...</a><br /></td></tr>
 121 <tr class="separator:ga9aa9b63d7b500add5590ea2d8a4347ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:ga739fcedddb9214a7c86995677b31c09a"><td class="memItemLeft" align="right" valign="top"><a id="ga739fcedddb9214a7c86995677b31c09a" name="ga739fcedddb9214a7c86995677b31c09a"></a>
 123 const btstack_chipset_t *&#160;</td><td class="memItemRight" valign="bottom"><b>btstack_chipset_cyw43_instance</b> (void)</td></tr>
 124 <tr class="memdesc:ga739fcedddb9214a7c86995677b31c09a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the singleton BTstack chipset CY43 API instance. <br /></td></tr>
 125 <tr class="separator:ga739fcedddb9214a7c86995677b31c09a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 </table>
 127 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 128 <p >Integration/wrapper libraries for <a href="https://github.com/bluekitchen/btstack">BTstack</a> the documentation for which is <a href="https://bluekitchen-gmbh.com/btstack/">here</a>. </p>
 129 <p >A supplemental license for BTstack (in addition to the stock BTstack licensing terms) is provided <a href="https://github.com/raspberrypi/pico-sdk/blob/master/src/rp2_common/pico_btstack/LICENSE.RP">here</a>.</p>
 130 <p >The <code><b>pico_btstack_ble</b> library</code> adds the support needed for Bluetooth Low Energy (BLE). The <code><b>pico_btstack_classic</b> library</code> adds the support needed for Bluetooth Classic. You can link to either library individually, or to both libraries thus enabling dual-mode support provided by BTstack.</p>
 131 <p >To use BTstack you need to provide a <code>btstack_config.h</code> file in your source tree and add its location to your include path. The BTstack configuration macros <code>ENABLE_CLASSIC</code> and <code>ENABLE_BLE</code> are defined for you when you link the <code>pico_btstack_classic</code> and <code>pico_btstack_ble</code> libraries respectively, so you should not define them yourself.</p>
 132 <p >For more details, see <a href="https://bluekitchen-gmbh.com/btstack/develop/#how_to/">How to configure BTstack</a> and the relevant <a href="https://github.com/raspberrypi/pico-examples#pico-w-bluetooth">pico-examples</a>.</p>
 133 <p >The follow libraries are provided for you to link.</p><ul>
 134 <li><code><b>pico_btstack_ble</b> -</code> Adds Bluetooth Low Energy (LE) support.</li>
 135 <li><code><b>pico_btstack_classic</b> -</code> Adds Bluetooth Classic support.</li>
 136 <li><code><b>pico_btstack_sbc_encoder</b> -</code> Adds Bluetooth Sub Band Coding (SBC) encoder support.</li>
 137 <li><code><b>pico_btstack_sbc_decoder</b> -</code> Adds Bluetooth Sub Band Coding (SBC) decoder support.</li>
 138 <li><code><b>pico_btstack_bnep_lwip</b> -</code> Adds Bluetooth Network Encapsulation Protocol (BNEP) support using LwIP.</li>
 139 <li><code><b>pico_btstack_bnep_lwip_sys_freertos</b> -</code> Adds Bluetooth Network Encapsulation Protocol (BNEP) support using LwIP with FreeRTOS for NO_SYS=0.</li>
 140 </ul>
 141 <dl class="section note"><dt>Note</dt><dd>The CMake function pico_btstack_make_gatt_header can be used to run the BTstack compile_gatt tool to make a GATT header file from a BTstack GATT file.</dd></dl>
 142 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pico__btstack__cyw43.html" title="Low-level Bluetooth HCI support.">pico_btstack_cyw43</a> in <a class="el" href="group__pico__cyw43__driver.html" title="A wrapper around the lower level cyw43_driver, that integrates it with pico_async_context for handlin...">pico_cyw43_driver</a>, which adds the cyw43 driver support needed for BTstack including BTstack run loop support. </dd></dl>
 143 <h2 class="groupheader">Function Documentation</h2>
 144 <a id="ga9aa9b63d7b500add5590ea2d8a4347ed" name="ga9aa9b63d7b500add5590ea2d8a4347ed"></a>
 145 <h2 class="memtitle"><span class="permalink"><a href="#ga9aa9b63d7b500add5590ea2d8a4347ed">&#9670;&nbsp;</a></span>btstack_run_loop_async_context_get_instance()</h2>
 146
 147 <div class="memitem">
 148 <div class="memproto">
 149       <table class="memname">
 150         <tr>
 151           <td class="memname">const btstack_run_loop_t * btstack_run_loop_async_context_get_instance </td>
 152           <td>(</td>
 153           <td class="paramtype"><a class="el" href="structasync__context.html">async_context_t</a> *&#160;</td>
 154           <td class="paramname"><em>context</em></td><td>)</td>
 155           <td></td>
 156         </tr>
 157       </table>
 158 </div><div class="memdoc">
 159
 160 <p>Initialize and return the singleton BTstack run loop instance that integrates with 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> API. </p>
 161 <dl class="params"><dt>Parameters</dt><dd>
 162   <table class="params">
 163     <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>
 164   </table>
 165   </dd>
 166 </dl>
 167 <dl class="section return"><dt>Returns</dt><dd>the BTstack run loop instance </dd></dl>
 168
 169 </div>
 170 </div>
 171 <a id="ga88f89a9b3339ebb3c570db896b66d65a" name="ga88f89a9b3339ebb3c570db896b66d65a"></a>
 172 <h2 class="memtitle"><span class="permalink"><a href="#ga88f89a9b3339ebb3c570db896b66d65a">&#9670;&nbsp;</a></span>pico_flash_bank_instance()</h2>
 173
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname">const hal_flash_bank_t * pico_flash_bank_instance </td>
 179           <td>(</td>
 180           <td class="paramtype">void&#160;</td>
 181           <td class="paramname"></td><td>)</td>
 182           <td></td>
 183         </tr>
 184       </table>
 185 </div><div class="memdoc">
 186
 187 <p>Return the singleton BTstack HAL flash instance, used for non-volatile storage. </p>
 188 <dl class="section note"><dt>Note</dt><dd>By default two sectors at the end of flash are used (see <code>PICO_FLASH_BANK_STORAGE_OFFSET</code> and <code>PICO_FLASH_BANK_TOTAL_SIZE</code>) </dd></dl>
 189
 190 </div>
 191 </div>
 192 </div><!-- contents -->
 193 </div><!-- doc-content -->
 194
 195         <script src="main.js"></script>
 196 </body>
 197 </html>