web/docs/vreg_8h.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: include/hardware/vreg.h File Reference</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('vreg_8h.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="#enum-members">Enumerations</a> &#124;
 107 <a href="#func-members">Functions</a>  </div>
 108   <div class="headertitle"><div class="title">vreg.h File Reference</div></div>
 109 </div><!--header-->
 110 <div class="contents">
 111 <div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
 112 <code>#include &quot;hardware/structs/vreg_and_chip_reset.h&quot;</code><br />
 113 </div><div class="textblock"><div class="dynheader">
 114 Include dependency graph for vreg.h:</div>
 115 <div class="dyncontent">
 116 <div class="center"><img src="vreg_8h__incl.png" border="0" usemap="#ainclude_2hardware_2vreg_8h" alt=""/></div>
 117 <map name="ainclude_2hardware_2vreg_8h" id="ainclude_2hardware_2vreg_8h">
 118 <area shape="rect" title=" " alt="" coords="661,5,839,32"/>
 119 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="649,259,710,285"/>
 120 <area shape="rect" href="vreg__and__chip__reset_8h_source.html" title=" " alt="" coords="740,80,904,121"/>
 121 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,483,259,509"/>
 122 <area shape="rect" title=" " alt="" coords="420,333,533,360"/>
 123 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="558,333,662,360"/>
 124 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="687,333,808,360"/>
 125 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="832,333,927,360"/>
 126 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,557,111,584"/>
 127 <area shape="rect" title=" " alt="" coords="74,632,157,659"/>
 128 <area shape="rect" title=" " alt="" coords="211,557,281,584"/>
 129 <area shape="rect" title=" " alt="" coords="306,557,381,584"/>
 130 <area shape="rect" title=" " alt="" coords="173,408,337,435"/>
 131 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,408,543,435"/>
 132 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,408,746,435"/>
 133 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,408,930,435"/>
 134 <area shape="rect" title=" " alt="" coords="1130,408,1341,435"/>
 135 <area shape="rect" title=" " alt="" coords="955,408,1105,435"/>
 136 <area shape="rect" title=" " alt="" coords="357,483,548,509"/>
 137 <area shape="rect" href="address__mapped_8h.html" title=" " alt="" coords="717,177,927,203"/>
 138 <area shape="rect" title=" " alt="" coords="951,169,1099,211"/>
 139 </map>
 140 </div>
 141 </div>
 142 <p><a href="vreg_8h_source.html">Go to the source code of this file.</a></p>
 143 <table class="memberdecls">
 144 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 145 Enumerations</h2></td></tr>
 146 <tr class="memitem:ab2019bc9d9ea4c0c02ba2a853ffcd0b0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0">vreg_voltage</a> { <br />
 147 &#160;&#160;<a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0ad25c8cbedfbcae1606f0797b3e5218ad">VREG_VOLTAGE_0_85</a> = 0b00110
 148 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0afc913d0bf679706ae7b56f0614ea7137">VREG_VOLTAGE_0_90</a> = 0b00111
 149 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0ad3ff4dfdcebac6a770e74890cf76617a">VREG_VOLTAGE_0_95</a> = 0b01000
 150 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0a2f526307c3cb045145d0bf5e8952d29d">VREG_VOLTAGE_1_00</a> = 0b01001
 151 , <br />
 152 &#160;&#160;<a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0ae051b5e73d436231166e9f685f232656">VREG_VOLTAGE_1_05</a> = 0b01010
 153 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0afd72673cd3a8d426dcd1c9b70e310c9a">VREG_VOLTAGE_1_10</a> = 0b01011
 154 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0a47fdbcfd8de6435983cb701881b0a228">VREG_VOLTAGE_1_15</a> = 0b01100
 155 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0a853c98c808b59f224e81599d1944dc30">VREG_VOLTAGE_1_20</a> = 0b01101
 156 , <br />
 157 &#160;&#160;<a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0a6adcd712d2022993ed6ebfcfa4199c33">VREG_VOLTAGE_1_25</a> = 0b01110
 158 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0a61684920a9b18f30d28c2c6ecfcb0d59">VREG_VOLTAGE_1_30</a> = 0b01111
 159 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0aaf7723eab97235298b913112c29c7e21">VREG_VOLTAGE_MIN</a> = VREG_VOLTAGE_0_85
 160 , <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0a67b3c8176289c56896430a44599d9910">VREG_VOLTAGE_DEFAULT</a> = VREG_VOLTAGE_1_10
 161 , <br />
 162 &#160;&#160;<a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0addc0833fc1d69fbec46dff9db1fa129f">VREG_VOLTAGE_MAX</a> = VREG_VOLTAGE_1_30
 163 <br />
 164  }</td></tr>
 165 <tr class="separator:ab2019bc9d9ea4c0c02ba2a853ffcd0b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 </table><table class="memberdecls">
 167 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 168 Functions</h2></td></tr>
 169 <tr class="memitem:ga9d129557bd02bef7facf45b05130e000"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__vreg.html#ga9d129557bd02bef7facf45b05130e000">vreg_set_voltage</a> (enum <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0">vreg_voltage</a> voltage)</td></tr>
 170 <tr class="memdesc:ga9d129557bd02bef7facf45b05130e000"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set voltage.  <a href="group__hardware__vreg.html#ga9d129557bd02bef7facf45b05130e000">More...</a><br /></td></tr>
 171 <tr class="separator:ga9d129557bd02bef7facf45b05130e000"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:gaa474bd6a5c0df05f9e4185a470dcd28f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__vreg.html#gaa474bd6a5c0df05f9e4185a470dcd28f">vreg_disable_voltage_limit</a> (void)</td></tr>
 173 <tr class="memdesc:gaa474bd6a5c0df05f9e4185a470dcd28f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable use of voltages beyond the safe range of operation.  <a href="group__hardware__vreg.html#gaa474bd6a5c0df05f9e4185a470dcd28f">More...</a><br /></td></tr>
 174 <tr class="separator:gaa474bd6a5c0df05f9e4185a470dcd28f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 </table>
 176 <h2 class="groupheader">Enumeration Type Documentation</h2>
 177 <a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0"></a>
 178 <h2 class="memtitle"><span class="permalink"><a href="#ab2019bc9d9ea4c0c02ba2a853ffcd0b0">&#9670;&nbsp;</a></span>vreg_voltage</h2>
 179
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">enum <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0">vreg_voltage</a></td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188 <p >Possible voltage values that can be applied to the regulator </p>
 189 <table class="fieldtable">
 190 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0ad25c8cbedfbcae1606f0797b3e5218ad" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0ad25c8cbedfbcae1606f0797b3e5218ad"></a>VREG_VOLTAGE_0_85&#160;</td><td class="fielddoc"><p >0.85 V </p>
 191 </td></tr>
 192 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0afc913d0bf679706ae7b56f0614ea7137" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0afc913d0bf679706ae7b56f0614ea7137"></a>VREG_VOLTAGE_0_90&#160;</td><td class="fielddoc"><p >0.90 V </p>
 193 </td></tr>
 194 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0ad3ff4dfdcebac6a770e74890cf76617a" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0ad3ff4dfdcebac6a770e74890cf76617a"></a>VREG_VOLTAGE_0_95&#160;</td><td class="fielddoc"><p >0.95 V </p>
 195 </td></tr>
 196 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a2f526307c3cb045145d0bf5e8952d29d" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a2f526307c3cb045145d0bf5e8952d29d"></a>VREG_VOLTAGE_1_00&#160;</td><td class="fielddoc"><p >1.00 V </p>
 197 </td></tr>
 198 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0ae051b5e73d436231166e9f685f232656" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0ae051b5e73d436231166e9f685f232656"></a>VREG_VOLTAGE_1_05&#160;</td><td class="fielddoc"><p >1.05 V </p>
 199 </td></tr>
 200 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0afd72673cd3a8d426dcd1c9b70e310c9a" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0afd72673cd3a8d426dcd1c9b70e310c9a"></a>VREG_VOLTAGE_1_10&#160;</td><td class="fielddoc"><p >1.10 V </p>
 201 </td></tr>
 202 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a47fdbcfd8de6435983cb701881b0a228" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a47fdbcfd8de6435983cb701881b0a228"></a>VREG_VOLTAGE_1_15&#160;</td><td class="fielddoc"><p >1.15 V </p>
 203 </td></tr>
 204 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a853c98c808b59f224e81599d1944dc30" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a853c98c808b59f224e81599d1944dc30"></a>VREG_VOLTAGE_1_20&#160;</td><td class="fielddoc"><p >1.20 V </p>
 205 </td></tr>
 206 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a6adcd712d2022993ed6ebfcfa4199c33" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a6adcd712d2022993ed6ebfcfa4199c33"></a>VREG_VOLTAGE_1_25&#160;</td><td class="fielddoc"><p >1.25 V </p>
 207 </td></tr>
 208 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a61684920a9b18f30d28c2c6ecfcb0d59" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a61684920a9b18f30d28c2c6ecfcb0d59"></a>VREG_VOLTAGE_1_30&#160;</td><td class="fielddoc"><p >1.30 V </p>
 209 </td></tr>
 210 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0aaf7723eab97235298b913112c29c7e21" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0aaf7723eab97235298b913112c29c7e21"></a>VREG_VOLTAGE_MIN&#160;</td><td class="fielddoc"><p >Always the minimum possible voltage. </p>
 211 </td></tr>
 212 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a67b3c8176289c56896430a44599d9910" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0a67b3c8176289c56896430a44599d9910"></a>VREG_VOLTAGE_DEFAULT&#160;</td><td class="fielddoc"><p >Default voltage on power up. </p>
 213 </td></tr>
 214 <tr><td class="fieldname"><a id="ab2019bc9d9ea4c0c02ba2a853ffcd0b0addc0833fc1d69fbec46dff9db1fa129f" name="ab2019bc9d9ea4c0c02ba2a853ffcd0b0addc0833fc1d69fbec46dff9db1fa129f"></a>VREG_VOLTAGE_MAX&#160;</td><td class="fielddoc"><p >Always the maximum possible voltage. </p>
 215 </td></tr>
 216 </table>
 217
 218 </div>
 219 </div>
 220 </div><!-- contents -->
 221 </div><!-- doc-content -->
 222
 223         <script src="main.js"></script>
 224 </body>
 225 </html>