libnx/bpc_8h_source.html
2025-05-08 06:59:12 +00:00

126 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/services/bpc.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">bpc.h</div></div>
</div><!--header-->
<div class="contents">
<a href="bpc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file bpc.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Board power control (bpc) service IPC wrapper.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author XorTroll, SciresM</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../sf/service.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> BpcSleepButtonState_Held = 0,</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> BpcSleepButtonState_Released = 1,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>} BpcSleepButtonState;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/// Initialize bpc.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="bpc_8h.html#a90c7aeb7b27e69f2c87d95e52dc14758"> 17</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="bpc_8h.html#a90c7aeb7b27e69f2c87d95e52dc14758">bpcInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"></span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/// Exit bpc.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="bpc_8h.html#a08d7bf7fca4d07c052df44bc49265df7"> 20</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="bpc_8h.html#a08d7bf7fca4d07c052df44bc49265df7">bpcExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"></span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/// Gets the Service object for the actual bpc service session.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="bpc_8h.html#a005ff74c79ae508efa215708d7673855"> 23</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="bpc_8h.html#a005ff74c79ae508efa215708d7673855">bpcGetServiceSession</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> bpcShutdownSystem(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> bpcRebootSystem(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="bpc_8h.html#a34c8ecdb32df9f15519a8f9d56de9592"> 27</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="bpc_8h.html#a34c8ecdb32df9f15519a8f9d56de9592">bpcGetSleepButtonState</a>(BpcSleepButtonState *out); <span class="comment">///&lt; [2.0.0-13.2.1]</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="bpc_8h.html#adca0ab668dbef490ddb02b7574946db5"> 28</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="bpc_8h.html#adca0ab668dbef490ddb02b7574946db5">bpcGetPowerButton</a>(<span class="keywordtype">bool</span>* out_is_pushed); <span class="comment">///&lt; [6.0.0+]</span></div>
<div class="ttc" id="abpc_8h_html_a005ff74c79ae508efa215708d7673855"><div class="ttname"><a href="bpc_8h.html#a005ff74c79ae508efa215708d7673855">bpcGetServiceSession</a></div><div class="ttdeci">Service * bpcGetServiceSession(void)</div><div class="ttdoc">Gets the Service object for the actual bpc service session.</div></div>
<div class="ttc" id="abpc_8h_html_a08d7bf7fca4d07c052df44bc49265df7"><div class="ttname"><a href="bpc_8h.html#a08d7bf7fca4d07c052df44bc49265df7">bpcExit</a></div><div class="ttdeci">void bpcExit(void)</div><div class="ttdoc">Exit bpc.</div></div>
<div class="ttc" id="abpc_8h_html_a34c8ecdb32df9f15519a8f9d56de9592"><div class="ttname"><a href="bpc_8h.html#a34c8ecdb32df9f15519a8f9d56de9592">bpcGetSleepButtonState</a></div><div class="ttdeci">Result bpcGetSleepButtonState(BpcSleepButtonState *out)</div><div class="ttdoc">[2.0.0-13.2.1]</div></div>
<div class="ttc" id="abpc_8h_html_a90c7aeb7b27e69f2c87d95e52dc14758"><div class="ttname"><a href="bpc_8h.html#a90c7aeb7b27e69f2c87d95e52dc14758">bpcInitialize</a></div><div class="ttdeci">Result bpcInitialize(void)</div><div class="ttdoc">Initialize bpc.</div></div>
<div class="ttc" id="abpc_8h_html_adca0ab668dbef490ddb02b7574946db5"><div class="ttname"><a href="bpc_8h.html#adca0ab668dbef490ddb02b7574946db5">bpcGetPowerButton</a></div><div class="ttdeci">Result bpcGetPowerButton(bool *out_is_pushed)</div><div class="ttdoc">[6.0.0+]</div></div>
<div class="ttc" id="astructService_html"><div class="ttname"><a href="structService.html">Service</a></div><div class="ttdoc">Service object structure.</div><div class="ttdef"><b>Definition</b> service.h:14</div></div>
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>