docs: c9320eb9db

2026-05-21 22:42:06 +00:00
commit 82622c49db
138 changed files with 11505 additions and 0 deletions
--- a/fhss_8c.html
+++ b/fhss_8c.html
@@ -0,0 +1,278 @@
+<!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/fhss.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="#func-members">Functions</a> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle"><div class="title">fhss.c File Reference</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p>FHSS channel sequencer implementation.  
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &quot;<a class="el" href="fhss_8h_source.html">fhss.h</a>&quot;</code><br />
+<code>#include &lt;aes.h&gt;</code><br />
+</div><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:a44cfe02274ceefa5de0fed51e1c4e741" id="r_a44cfe02274ceefa5de0fed51e1c4e741"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#a44cfe02274ceefa5de0fed51e1c4e741">fhss_init</a> (void)</td></tr>
+<tr class="memdesc:a44cfe02274ceefa5de0fed51e1c4e741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the slot counter to zero.  <br /></td></tr>
+<tr class="separator:a44cfe02274ceefa5de0fed51e1c4e741"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a28190a786a8da0f56bfbe8261dfc359a" id="r_a28190a786a8da0f56bfbe8261dfc359a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#a28190a786a8da0f56bfbe8261dfc359a">fhss_next_channel</a> (void)</td></tr>
+<tr class="memdesc:a28190a786a8da0f56bfbe8261dfc359a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the next channel in the hopping sequence and advance the slot.  <br /></td></tr>
+<tr class="separator:a28190a786a8da0f56bfbe8261dfc359a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa254dd2e4da40c6ac7f1d1b189666eca" id="r_aa254dd2e4da40c6ac7f1d1b189666eca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#aa254dd2e4da40c6ac7f1d1b189666eca">fhss_sync_tick</a> (void)</td></tr>
+<tr class="memdesc:aa254dd2e4da40c6ac7f1d1b189666eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the slot counter by one (receiver side, no packet received).  <br /></td></tr>
+<tr class="separator:aa254dd2e4da40c6ac7f1d1b189666eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4db6a04939b3d885681ebd1bbab03cb2" id="r_a4db6a04939b3d885681ebd1bbab03cb2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#a4db6a04939b3d885681ebd1bbab03cb2">fhss_set_slot</a> (uint32_t s)</td></tr>
+<tr class="memdesc:a4db6a04939b3d885681ebd1bbab03cb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force the slot counter to a specific value for RX synchronisation.  <br /></td></tr>
+<tr class="separator:a4db6a04939b3d885681ebd1bbab03cb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7c45cff675465f11798eaf0a0e0b8d0e" id="r_a7c45cff675465f11798eaf0a0e0b8d0e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#a7c45cff675465f11798eaf0a0e0b8d0e">fhss_get_slot</a> (void)</td></tr>
+<tr class="memdesc:a7c45cff675465f11798eaf0a0e0b8d0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current slot counter value.  <br /></td></tr>
+<tr class="separator:a7c45cff675465f11798eaf0a0e0b8d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
+Variables</h2></td></tr>
+<tr class="memitem:aefc147b3b6fc7be18cbeabfa8babaacc" id="r_aefc147b3b6fc7be18cbeabfa8babaacc"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#aefc147b3b6fc7be18cbeabfa8babaacc">shared_key</a> [16]</td></tr>
+<tr class="separator:aefc147b3b6fc7be18cbeabfa8babaacc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8da4ee0fe1f6d2dcab3b7562d79c10a1" id="r_a8da4ee0fe1f6d2dcab3b7562d79c10a1"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8c.html#a8da4ee0fe1f6d2dcab3b7562d79c10a1">slot</a></td></tr>
+<tr class="separator:a8da4ee0fe1f6d2dcab3b7562d79c10a1"><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>FHSS channel sequencer implementation. </p>
+</div><h2 class="groupheader">Function Documentation</h2>
+<a id="a7c45cff675465f11798eaf0a0e0b8d0e" name="a7c45cff675465f11798eaf0a0e0b8d0e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7c45cff675465f11798eaf0a0e0b8d0e">&#9670;&#160;</a></span>fhss_get_slot()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t fhss_get_slot </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 slot counter value. </p>
+
+</div>
+</div>
+<a id="a44cfe02274ceefa5de0fed51e1c4e741" name="a44cfe02274ceefa5de0fed51e1c4e741"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a44cfe02274ceefa5de0fed51e1c4e741">&#9670;&#160;</a></span>fhss_init()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void fhss_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>Reset the slot counter to zero. </p>
+
+</div>
+</div>
+<a id="a28190a786a8da0f56bfbe8261dfc359a" name="a28190a786a8da0f56bfbe8261dfc359a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a28190a786a8da0f56bfbe8261dfc359a">&#9670;&#160;</a></span>fhss_next_channel()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t fhss_next_channel </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 next channel in the hopping sequence and advance the slot. </p>
+<dl class="section return"><dt>Returns</dt><dd>Channel index in [0, 39]. </dd></dl>
+
+</div>
+</div>
+<a id="a4db6a04939b3d885681ebd1bbab03cb2" name="a4db6a04939b3d885681ebd1bbab03cb2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4db6a04939b3d885681ebd1bbab03cb2">&#9670;&#160;</a></span>fhss_set_slot()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void fhss_set_slot </td>
+          <td>(</td>
+          <td class="paramtype">uint32_t&#160;</td>
+          <td class="paramname"><em>s</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Force the slot counter to a specific value for RX synchronisation. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">s</td><td>New slot value. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a id="aa254dd2e4da40c6ac7f1d1b189666eca" name="aa254dd2e4da40c6ac7f1d1b189666eca"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa254dd2e4da40c6ac7f1d1b189666eca">&#9670;&#160;</a></span>fhss_sync_tick()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void fhss_sync_tick </td>
+          <td>(</td>
+          <td class="paramtype">void&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Advance the slot counter by one (receiver side, no packet received). </p>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="aefc147b3b6fc7be18cbeabfa8babaacc" name="aefc147b3b6fc7be18cbeabfa8babaacc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aefc147b3b6fc7be18cbeabfa8babaacc">&#9670;&#160;</a></span>shared_key</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">const uint8_t shared_key[16]</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">static</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
+<div class="line">    0xA3, 0x4F, 0x2C, 0x8B, 0xE1, 0x76, 0x0D, 0x95, 0x4A, 0xB8, 0x3E, 0x72, 0x1F, 0xC9, 0x56, 0x0A,</div>
+<div class="line">}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a8da4ee0fe1f6d2dcab3b7562d79c10a1" name="a8da4ee0fe1f6d2dcab3b7562d79c10a1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8da4ee0fe1f6d2dcab3b7562d79c10a1">&#9670;&#160;</a></span>slot</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t slot</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">static</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</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>