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">
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"/>
27 <div class="navigation-mobile">
28 <div class="logo--mobile">
29 <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
31 <div class="navigation-toggle">
32 <span class="line-1"></span>
36 <span class="line-3"></span>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
42 <span style="display: inline-block; margin-top: 10px;">
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>
50 <!-- <div class="search">
52 <input type="search" name="search" id="search" placeholder="Search">
53 <input type="submit" value="Search">
56 <!-- Generated by Doxygen 1.9.4 -->
57 <script type="text/javascript">
58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
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&dn=expat.txt MIT */
67 initMenu('',true,false,'search.php','Search');
68 $(document).ready(function() { init_search(); });
72 <div id="main-nav"></div>
74 <div id="side-nav" class="ui-resizable side-nav-resizable">
76 <div id="nav-tree-contents">
77 <div id="nav-sync" class="sync"></div>
80 <div id="splitbar" style="-moz-user-select:none;"
81 class="ui-resizable-handle">
84 <script type="text/javascript">
85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
86 $(document).ready(function(){initNavTree('group__pico__cyw43__driver.html',''); initResizable(); });
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)">
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">
105 <div class="summary">
106 <a href="#groups">Modules</a> |
107 <a href="#files">Files</a> |
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>
111 <div class="contents">
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"> </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"> </td><td class="mdescRight">Low-level Bluetooth HCI support. <br /></td></tr>
120 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
121 </table><table class="memberdecls">
122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="files" name="files"></a>
124 <tr class="memitem:btstack__hci__transport__cyw43_8h"><td class="memItemLeft" align="right" valign="top">file  </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"> </td><td class="mdescRight">Adds low level Bluetooth HCI support. <br /></td></tr>
126 <tr class="separator:"><td class="memSeparator" colspan="2"> </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 * </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"> </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"> </td></tr>
133 <tr class="memitem:ga24c12f6110969e420954356b104aaa07"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
136 <tr class="memitem:gaf7f9ad52479938f40ae6b1f8c9ef80c3"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
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">◆ </a></span>cyw43_driver_deinit()</h2>
146 <div class="memitem">
147 <div class="memproto">
148 <table class="memname">
150 <td class="memname">void cyw43_driver_deinit </td>
152 <td class="paramtype">struct <a class="el" href="structasync__context.html">async_context</a> * </td>
153 <td class="paramname"><em>context</em></td><td>)</td>
157 </div><div class="memdoc">
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>
169 <a id="ga24c12f6110969e420954356b104aaa07" name="ga24c12f6110969e420954356b104aaa07"></a>
170 <h2 class="memtitle"><span class="permalink"><a href="#ga24c12f6110969e420954356b104aaa07">◆ </a></span>cyw43_driver_init()</h2>
172 <div class="memitem">
173 <div class="memproto">
174 <table class="memname">
176 <td class="memname">bool cyw43_driver_init </td>
178 <td class="paramtype">struct <a class="el" href="structasync__context.html">async_context</a> * </td>
179 <td class="paramname"><em>context</em></td><td>)</td>
183 </div><div class="memdoc">
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>
193 <dl class="section return"><dt>Returns</dt><dd>true if the initialization succeeded </dd></dl>
197 <a id="ga340ac6ac087a90e610820fadc0a99206" name="ga340ac6ac087a90e610820fadc0a99206"></a>
198 <h2 class="memtitle"><span class="permalink"><a href="#ga340ac6ac087a90e610820fadc0a99206">◆ </a></span>hci_transport_cyw43_instance()</h2>
200 <div class="memitem">
201 <div class="memproto">
202 <table class="memname">
204 <td class="memname">const hci_transport_t * hci_transport_cyw43_instance </td>
206 <td class="paramtype">void </td>
207 <td class="paramname"></td><td>)</td>
211 </div><div class="memdoc">
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>
218 </div><!-- contents -->
219 </div><!-- doc-content -->
221 <script src="main.js"></script>