web/docs/group__high__level.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: High Level APIs</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__high__level.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>  </div>
 107   <div class="headertitle"><div class="title">High Level APIs</div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110 <table class="memberdecls">
 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 112 Modules</h2></td></tr>
 113 <tr class="memitem:group__pico__aon__timer"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html">pico_aon_timer</a></td></tr>
 114 <tr class="memdesc:group__pico__aon__timer"><td class="mdescLeft">&#160;</td><td class="mdescRight">High Level "Always on Timer" Abstraction. <br /></td></tr>
 115 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 <tr class="memitem:group__pico__async__context"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__async__context.html">pico_async_context</a></td></tr>
 117 <tr class="memdesc:group__pico__async__context"><td class="mdescLeft">&#160;</td><td class="mdescRight">An <a class="el" href="structasync__context.html">async_context</a> provides a logically single-threaded context for performing work, and responding to asynchronous events. Thus an <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 is suitable for servicing third-party libraries that are not re-entrant. <br /></td></tr>
 118 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:group__pico__bootsel__via__double__reset"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__bootsel__via__double__reset.html">pico_bootsel_via_double_reset</a></td></tr>
 120 <tr class="memdesc:group__pico__bootsel__via__double__reset"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional support to make fast double reset of the system enter BOOTSEL mode. <br /></td></tr>
 121 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:group__pico__flash"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__flash.html">pico_flash</a></td></tr>
 123 <tr class="memdesc:group__pico__flash"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level flash API. <br /></td></tr>
 124 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:group__pico__i2c__slave"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__i2c__slave.html">pico_i2c_slave</a></td></tr>
 126 <tr class="memdesc:group__pico__i2c__slave"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions providing an interrupt driven I2C slave interface. <br /></td></tr>
 127 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:group__pico__multicore"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__multicore.html">pico_multicore</a></td></tr>
 129 <tr class="memdesc:group__pico__multicore"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds support for running code on, and interacting with the second processor core (core 1). <br /></td></tr>
 130 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:group__pico__rand"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__rand.html">pico_rand</a></td></tr>
 132 <tr class="memdesc:group__pico__rand"><td class="mdescLeft">&#160;</td><td class="mdescRight">Random Number Generator API. <br /></td></tr>
 133 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:group__pico__sha256"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html">pico_sha256</a></td></tr>
 135 <tr class="memdesc:group__pico__sha256"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-256 Hardware Accelerated implementation. <br /></td></tr>
 136 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:group__pico__stdlib"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__stdlib.html">pico_stdlib</a></td></tr>
 138 <tr class="memdesc:group__pico__stdlib"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aggregation of a core subset of Raspberry Pi Pico SDK libraries used by most executables along with some additional utility methods. <br /></td></tr>
 139 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:group__pico__sync"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sync.html">pico_sync</a></td></tr>
 141 <tr class="memdesc:group__pico__sync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Synchronization primitives and mutual exclusion. <br /></td></tr>
 142 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:group__pico__time"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__time.html">pico_time</a></td></tr>
 144 <tr class="memdesc:group__pico__time"><td class="mdescLeft">&#160;</td><td class="mdescRight">API for accurate timestamps, sleeping, and time based callbacks. <br /></td></tr>
 145 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:group__pico__unique__id"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__unique__id.html">pico_unique_id</a></td></tr>
 147 <tr class="memdesc:group__pico__unique__id"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique device ID access API. <br /></td></tr>
 148 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:group__pico__util"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__util.html">pico_util</a></td></tr>
 150 <tr class="memdesc:group__pico__util"><td class="mdescLeft">&#160;</td><td class="mdescRight">Useful data structures and utility functions. <br /></td></tr>
 151 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 </table>
 153 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 154 <p >This group of libraries provide higher level functionality that isn't hardware related or provides a richer set of functionality above the basic hardware interfaces </p>
 155 </div><!-- contents -->
 156 </div><!-- doc-content -->
 157
 158         <script src="main.js"></script>
 159 </body>
 160 </html>