KrzysztofC/nRF52840_PTT
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
82622c49dbaab5e7e83f7411266dc486a003c295
nRF52840_PTT/power_8c.html
ci 82622c49db docs: c9320eb9db
2026-05-21 22:42:06 +00:00

231 lines
11 KiB
HTML
Raw Blame History

<!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>ptt-fhss: src/power.c File Reference</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">ptt-fhss
</div>
<div id="projectbrief">Bare-metal PTT firmware for nRF52840 with FHSS</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>
<!-- 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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">power.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Power management implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="power_8h_source.html">power.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="regs_8h_source.html">regs.h</a>&quot;</code><br />
<code>#include &lt;nrf52840.h&gt;</code><br />
<code>#include &lt;cmsis_gcc.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:abc2ad14f0789907024ac765711ffd3da" id="r_abc2ad14f0789907024ac765711ffd3da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="power_8c.html#abc2ad14f0789907024ac765711ffd3da">BUTTON_PIN</a>&#160;&#160;&#160;2u</td></tr>
<tr class="separator:abc2ad14f0789907024ac765711ffd3da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a87f76c63957bd0bdf5f7ca1d1bfe8c" id="r_a5a87f76c63957bd0bdf5f7ca1d1bfe8c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="power_8c.html#a5a87f76c63957bd0bdf5f7ca1d1bfe8c">BUTTON_ACTIVE_LOW</a>&#160;&#160;&#160;1u</td></tr>
<tr class="separator:a5a87f76c63957bd0bdf5f7ca1d1bfe8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1ca9d74e081ad1377b5c9b7773be973b" id="r_a1ca9d74e081ad1377b5c9b7773be973b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="power_8c.html#a1ca9d74e081ad1377b5c9b7773be973b">power_init</a> (void)</td></tr>
<tr class="memdesc:a1ca9d74e081ad1377b5c9b7773be973b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the DC/DC converter, configure GPIO input and GPIOTE wakeup on the PTT button. <br /></td></tr>
<tr class="separator:a1ca9d74e081ad1377b5c9b7773be973b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b84b3559a86acf1fef1fab03daded6b" id="r_a7b84b3559a86acf1fef1fab03daded6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="power_8c.html#a7b84b3559a86acf1fef1fab03daded6b">power_sleep_until_button</a> (void)</td></tr>
<tr class="memdesc:a7b84b3559a86acf1fef1fab03daded6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enter SYSTEM_ON low-power sleep and return on the next GPIOTE event. <br /></td></tr>
<tr class="separator:a7b84b3559a86acf1fef1fab03daded6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada513e112411aa36f06f4a36ccf6edb3" id="r_ada513e112411aa36f06f4a36ccf6edb3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="power_8c.html#ada513e112411aa36f06f4a36ccf6edb3">power_button_pressed</a> (void)</td></tr>
<tr class="memdesc:ada513e112411aa36f06f4a36ccf6edb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current state of the PTT button. <br /></td></tr>
<tr class="separator:ada513e112411aa36f06f4a36ccf6edb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26b108e2296d5514a2391960b4231d71" id="r_a26b108e2296d5514a2391960b4231d71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="power_8c.html#a26b108e2296d5514a2391960b4231d71">GPIOTE_IRQHandler</a> (void)</td></tr>
<tr class="separator:a26b108e2296d5514a2391960b4231d71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Power management implementation. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a5a87f76c63957bd0bdf5f7ca1d1bfe8c" name="a5a87f76c63957bd0bdf5f7ca1d1bfe8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a87f76c63957bd0bdf5f7ca1d1bfe8c">&#9670;&#160;</a></span>BUTTON_ACTIVE_LOW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BUTTON_ACTIVE_LOW&#160;&#160;&#160;1u</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abc2ad14f0789907024ac765711ffd3da" name="abc2ad14f0789907024ac765711ffd3da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc2ad14f0789907024ac765711ffd3da">&#9670;&#160;</a></span>BUTTON_PIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BUTTON_PIN&#160;&#160;&#160;2u</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a26b108e2296d5514a2391960b4231d71" name="a26b108e2296d5514a2391960b4231d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26b108e2296d5514a2391960b4231d71">&#9670;&#160;</a></span>GPIOTE_IRQHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GPIOTE_IRQHandler </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ada513e112411aa36f06f4a36ccf6edb3" name="ada513e112411aa36f06f4a36ccf6edb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada513e112411aa36f06f4a36ccf6edb3">&#9670;&#160;</a></span>power_button_pressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool power_button_pressed </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current state of the PTT button. </p>
<dl class="section return"><dt>Returns</dt><dd>true when the button is pressed. </dd></dl>
</div>
</div>
<a id="a1ca9d74e081ad1377b5c9b7773be973b" name="a1ca9d74e081ad1377b5c9b7773be973b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ca9d74e081ad1377b5c9b7773be973b">&#9670;&#160;</a></span>power_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void power_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable the DC/DC converter, configure GPIO input and GPIOTE wakeup on the PTT button. </p>
</div>
</div>
<a id="a7b84b3559a86acf1fef1fab03daded6b" name="a7b84b3559a86acf1fef1fab03daded6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b84b3559a86acf1fef1fab03daded6b">&#9670;&#160;</a></span>power_sleep_until_button()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void power_sleep_until_button </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enter SYSTEM_ON low-power sleep and return on the next GPIOTE event. </p>
<p>Sets TASKS_LOWPWR then executes WFI. The CPU wakes when the GPIOTE interrupt fires (button press) and resumes from here. </p>
</div>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink