web/docs/group__hardware__vreg.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_vreg</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__vreg.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">hardware_vreg<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>Voltage Regulation API.
 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: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>
 117 <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>
 118 <tr class="separator:ga9d129557bd02bef7facf45b05130e000"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <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>
 120 <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>
 121 <tr class="separator:gaa474bd6a5c0df05f9e4185a470dcd28f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 </table>
 123 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 124 <p >Voltage Regulation API. </p>
 125 <h2 class="groupheader">Function Documentation</h2>
 126 <a id="gaa474bd6a5c0df05f9e4185a470dcd28f" name="gaa474bd6a5c0df05f9e4185a470dcd28f"></a>
 127 <h2 class="memtitle"><span class="permalink"><a href="#gaa474bd6a5c0df05f9e4185a470dcd28f">&#9670;&nbsp;</a></span>vreg_disable_voltage_limit()</h2>
 128
 129 <div class="memitem">
 130 <div class="memproto">
 131       <table class="memname">
 132         <tr>
 133           <td class="memname">void vreg_disable_voltage_limit </td>
 134           <td>(</td>
 135           <td class="paramtype">void&#160;</td>
 136           <td class="paramname"></td><td>)</td>
 137           <td></td>
 138         </tr>
 139       </table>
 140 </div><div class="memdoc">
 141
 142 <p>Enable use of voltages beyond the safe range of operation. </p>
 143 <p >This allows voltages beyond VREG_VOLTAGE_MAX to be used, on platforms where they are available (e.g. RP2350). Attempting to set a higher voltage without first calling this function will result in a voltage of VREG_VOLTAGE_MAX. </p>
 144
 145 </div>
 146 </div>
 147 <a id="ga9d129557bd02bef7facf45b05130e000" name="ga9d129557bd02bef7facf45b05130e000"></a>
 148 <h2 class="memtitle"><span class="permalink"><a href="#ga9d129557bd02bef7facf45b05130e000">&#9670;&nbsp;</a></span>vreg_set_voltage()</h2>
 149
 150 <div class="memitem">
 151 <div class="memproto">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">void vreg_set_voltage </td>
 155           <td>(</td>
 156           <td class="paramtype">enum <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0">vreg_voltage</a>&#160;</td>
 157           <td class="paramname"><em>voltage</em></td><td>)</td>
 158           <td></td>
 159         </tr>
 160       </table>
 161 </div><div class="memdoc">
 162
 163 <p>Set voltage. </p>
 164 <dl class="params"><dt>Parameters</dt><dd>
 165   <table class="params">
 166     <tr><td class="paramname">voltage</td><td>The voltage (from enumeration <a class="el" href="vreg_8h.html#ab2019bc9d9ea4c0c02ba2a853ffcd0b0">vreg_voltage</a>) to apply to the voltage regulator </td></tr>
 167   </table>
 168   </dd>
 169 </dl>
 170
 171 </div>
 172 </div>
 173 </div><!-- contents -->
 174 </div><!-- doc-content -->
 175
 176         <script src="main.js"></script>
 177 </body>
 178 </html>