web/docs/group__hardware.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: Hardware 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__hardware.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">Hardware 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__hardware__adc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__adc.html">hardware_adc</a></td></tr>
 114 <tr class="memdesc:group__hardware__adc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analog to Digital Converter (ADC) API. <br /></td></tr>
 115 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 <tr class="memitem:group__hardware__base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__base.html">hardware_base</a></td></tr>
 117 <tr class="memdesc:group__hardware__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low-level types and (atomic) accessors for memory-mapped hardware registers. <br /></td></tr>
 118 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:group__hardware__claim"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__claim.html">hardware_claim</a></td></tr>
 120 <tr class="memdesc:group__hardware__claim"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lightweight hardware resource management API. <br /></td></tr>
 121 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:group__hardware__clocks"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__clocks.html">hardware_clocks</a></td></tr>
 123 <tr class="memdesc:group__hardware__clocks"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clock Management API. <br /></td></tr>
 124 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:group__hardware__divider"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__divider.html">hardware_divider</a></td></tr>
 126 <tr class="memdesc:group__hardware__divider"><td class="mdescLeft">&#160;</td><td class="mdescRight">RP2040 Low Low-level hardware-divider API. Non-RP2040 platforms provide software versions of all the functions. <br /></td></tr>
 127 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:group__hardware__dcp"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__dcp.html">hardware_dcp</a></td></tr>
 129 <tr class="memdesc:group__hardware__dcp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assembly macros for the Double Coprocessor. <br /></td></tr>
 130 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:group__hardware__dma"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__dma.html">hardware_dma</a></td></tr>
 132 <tr class="memdesc:group__hardware__dma"><td class="mdescLeft">&#160;</td><td class="mdescRight">DMA Controller API. <br /></td></tr>
 133 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:group__hardware__exception"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html">hardware_exception</a></td></tr>
 135 <tr class="memdesc:group__hardware__exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">Methods for setting processor exception handlers. <br /></td></tr>
 136 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:group__hardware__flash"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__flash.html">hardware_flash</a></td></tr>
 138 <tr class="memdesc:group__hardware__flash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low level flash programming and erase API. <br /></td></tr>
 139 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:group__hardware__gpio"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__gpio.html">hardware_gpio</a></td></tr>
 141 <tr class="memdesc:group__hardware__gpio"><td class="mdescLeft">&#160;</td><td class="mdescRight">General Purpose Input/Output (GPIO) API. <br /></td></tr>
 142 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:group__hardware__hazard3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__hazard3.html">hardware_hazard3</a></td></tr>
 144 <tr class="memdesc:group__hardware__hazard3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessors for Hazard3-specific RISC-V CSRs, and intrinsics for Hazard3 custom instructions. <br /></td></tr>
 145 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:group__hardware__i2c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__i2c.html">hardware_i2c</a></td></tr>
 147 <tr class="memdesc:group__hardware__i2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2C Controller API. <br /></td></tr>
 148 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:group__hardware__interp"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__interp.html">hardware_interp</a></td></tr>
 150 <tr class="memdesc:group__hardware__interp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware Interpolator API. <br /></td></tr>
 151 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:group__hardware__irq"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html">hardware_irq</a></td></tr>
 153 <tr class="memdesc:group__hardware__irq"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware interrupt handling API. <br /></td></tr>
 154 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:group__hardware__pio"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pio.html">hardware_pio</a></td></tr>
 156 <tr class="memdesc:group__hardware__pio"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programmable I/O (PIO) API. <br /></td></tr>
 157 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:group__hardware__pll"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pll.html">hardware_pll</a></td></tr>
 159 <tr class="memdesc:group__hardware__pll"><td class="mdescLeft">&#160;</td><td class="mdescRight">Phase Locked Loop control APIs. <br /></td></tr>
 160 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:group__hardware__powman"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__powman.html">hardware_powman</a></td></tr>
 162 <tr class="memdesc:group__hardware__powman"><td class="mdescLeft">&#160;</td><td class="mdescRight">Power Management API. <br /></td></tr>
 163 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:group__hardware__pwm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html">hardware_pwm</a></td></tr>
 165 <tr class="memdesc:group__hardware__pwm"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware Pulse Width Modulation (PWM) API. <br /></td></tr>
 166 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:group__hardware__resets"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__resets.html">hardware_resets</a></td></tr>
 168 <tr class="memdesc:group__hardware__resets"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware Reset API. <br /></td></tr>
 169 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:group__hardware__riscv"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__riscv.html">hardware_riscv</a></td></tr>
 171 <tr class="memdesc:group__hardware__riscv"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessors for standard RISC-V hardware (mainly CSRs) <br /></td></tr>
 172 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:group__hardware__riscv__platform__timer"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__riscv__platform__timer.html">hardware_riscv_platform_timer</a></td></tr>
 174 <tr class="memdesc:group__hardware__riscv__platform__timer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessors for standard RISC-V platform timer (mtime/mtimecmp), available on Raspberry Pi microcontrollers with RISC-V processors. <br /></td></tr>
 175 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:group__hardware__rtc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html">hardware_rtc</a></td></tr>
 177 <tr class="memdesc:group__hardware__rtc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware Real Time Clock API. <br /></td></tr>
 178 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <tr class="memitem:group__hardware__rcp"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rcp.html">hardware_rcp</a></td></tr>
 180 <tr class="memdesc:group__hardware__rcp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inline functions and assembly macros for the Redundancy Coprocessor. <br /></td></tr>
 181 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 <tr class="memitem:group__hardware__spi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__spi.html">hardware_spi</a></td></tr>
 183 <tr class="memdesc:group__hardware__spi"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware SPI API. <br /></td></tr>
 184 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <tr class="memitem:group__hardware__sha256"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__sha256.html">hardware_sha256</a></td></tr>
 186 <tr class="memdesc:group__hardware__sha256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware SHA-256 Accelerator API. <br /></td></tr>
 187 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 188 <tr class="memitem:group__hardware__sync"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__sync.html">hardware_sync</a></td></tr>
 189 <tr class="memdesc:group__hardware__sync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low level hardware spin locks, barrier and processor event APIs. <br /></td></tr>
 190 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 <tr class="memitem:group__hardware__ticks"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__ticks.html">hardware_ticks</a></td></tr>
 192 <tr class="memdesc:group__hardware__ticks"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware Tick API. <br /></td></tr>
 193 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 <tr class="memitem:group__hardware__timer"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__timer.html">hardware_timer</a></td></tr>
 195 <tr class="memdesc:group__hardware__timer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low-level hardware timer API. <br /></td></tr>
 196 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 197 <tr class="memitem:group__hardware__uart"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__uart.html">hardware_uart</a></td></tr>
 198 <tr class="memdesc:group__hardware__uart"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware UART API. <br /></td></tr>
 199 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 200 <tr class="memitem:group__hardware__vreg"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__vreg.html">hardware_vreg</a></td></tr>
 201 <tr class="memdesc:group__hardware__vreg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Voltage Regulation API. <br /></td></tr>
 202 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 203 <tr class="memitem:group__hardware__watchdog"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__watchdog.html">hardware_watchdog</a></td></tr>
 204 <tr class="memdesc:group__hardware__watchdog"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hardware Watchdog Timer API. <br /></td></tr>
 205 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 206 <tr class="memitem:group__hardware__xosc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xosc.html">hardware_xosc</a></td></tr>
 207 <tr class="memdesc:group__hardware__xosc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Crystal Oscillator (XOSC) API. <br /></td></tr>
 208 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 209 </table>
 210 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 211 <p >This group of libraries provides a thin and efficient C API / abstractions to access the RP-series microcontroller hardware without having to read and write hardware registers directly. </p>
 212 </div><!-- contents -->
 213 </div><!-- doc-content -->
 214
 215         <script src="main.js"></script>
 216 </body>
 217 </html>