122 lines
9.8 KiB
HTML
122 lines
9.8 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>ptt-fhss: include/radio.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">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&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&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&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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">radio.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="radio_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="foldopen" id="foldopen00001" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00001" name="l00001"></a><span class="lineno"><a class="line" href="radio_8h.html#ab898071398b359603a35c202e9c65f3b"> 1</a></span> </div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <stdbool.h></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_function" href="radio_8h.html#ab898071398b359603a35c202e9c65f3b">__attribute__</a>((packed)) {</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> uint32_t <a class="code hl_variable" href="fhss_8c.html#a8da4ee0fe1f6d2dcab3b7562d79c10a1">slot</a>; </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> uint8_t flags; </div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="radio_8h.html#a0f54f3002fc4eaef20595ed5e64b35d7"> 18</a></span>} <a class="code hl_variable" href="radio_8h.html#a0f54f3002fc4eaef20595ed5e64b35d7">ptt_frame_t</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="radio_8h.html#a641b5c6f5b38da442b995f3d4f549e6f"> 20</a></span><span class="preprocessor">#define PTT_FLAG_ACTIVE 0x01u </span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keywordtype">void</span> <a class="code hl_function" href="radio_8h.html#acfb21351bb3f0146635745bfacfe26a8">radio_init</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="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keywordtype">void</span> <a class="code hl_function" href="radio_8h.html#a4508602c352170e18afc35ea773edb98">radio_set_channel</a>(uint8_t ch);</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keywordtype">void</span> <a class="code hl_function" href="radio_8h.html#aa98086e3cef509cbd1f899e79e62a39c">radio_tx</a>(<span class="keyword">const</span> uint8_t *data, uint8_t len);</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keywordtype">void</span> <a class="code hl_function" href="radio_8h.html#a797c6c01e1ad4076ab54412b8c116de2">radio_tx_burst</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keywordtype">bool</span> <a class="code hl_function" href="radio_8h.html#a93ad6d90796885b32326efe3b7c93b17">radio_rx_burst</a>(<a class="code hl_variable" href="radio_8h.html#a0f54f3002fc4eaef20595ed5e64b35d7">ptt_frame_t</a> *frame_out);</div>
|
|
<div class="ttc" id="afhss_8c_html_a8da4ee0fe1f6d2dcab3b7562d79c10a1"><div class="ttname"><a href="fhss_8c.html#a8da4ee0fe1f6d2dcab3b7562d79c10a1">slot</a></div><div class="ttdeci">static uint32_t slot</div><div class="ttdef"><b>Definition</b> fhss.c:15</div></div>
|
|
<div class="ttc" id="aradio_8h_html_a0f54f3002fc4eaef20595ed5e64b35d7"><div class="ttname"><a href="radio_8h.html#a0f54f3002fc4eaef20595ed5e64b35d7">ptt_frame_t</a></div><div class="ttdeci">ptt_frame_t</div><div class="ttdef"><b>Definition</b> radio.h:18</div></div>
|
|
<div class="ttc" id="aradio_8h_html_a4508602c352170e18afc35ea773edb98"><div class="ttname"><a href="radio_8h.html#a4508602c352170e18afc35ea773edb98">radio_set_channel</a></div><div class="ttdeci">void radio_set_channel(uint8_t ch)</div><div class="ttdoc">Set the RF channel.</div><div class="ttdef"><b>Definition</b> radio.c:101</div></div>
|
|
<div class="ttc" id="aradio_8h_html_a797c6c01e1ad4076ab54412b8c116de2"><div class="ttname"><a href="radio_8h.html#a797c6c01e1ad4076ab54412b8c116de2">radio_tx_burst</a></div><div class="ttdeci">void radio_tx_burst(void)</div><div class="ttdoc">Transmit one FHSS hop: advance channel, send PTT frame, hold dwell time.</div><div class="ttdef"><b>Definition</b> radio.c:126</div></div>
|
|
<div class="ttc" id="aradio_8h_html_a93ad6d90796885b32326efe3b7c93b17"><div class="ttname"><a href="radio_8h.html#a93ad6d90796885b32326efe3b7c93b17">radio_rx_burst</a></div><div class="ttdeci">bool radio_rx_burst(ptt_frame_t *frame_out)</div><div class="ttdoc">Receive one FHSS hop: advance channel, listen for FHSS_DWELL_MS ms.</div><div class="ttdef"><b>Definition</b> radio.c:142</div></div>
|
|
<div class="ttc" id="aradio_8h_html_aa98086e3cef509cbd1f899e79e62a39c"><div class="ttname"><a href="radio_8h.html#aa98086e3cef509cbd1f899e79e62a39c">radio_tx</a></div><div class="ttdeci">void radio_tx(const uint8_t *data, uint8_t len)</div><div class="ttdoc">Transmit one packet synchronously.</div><div class="ttdef"><b>Definition</b> radio.c:109</div></div>
|
|
<div class="ttc" id="aradio_8h_html_ab898071398b359603a35c202e9c65f3b"><div class="ttname"><a href="radio_8h.html#ab898071398b359603a35c202e9c65f3b">__attribute__</a></div><div class="ttdeci">struct __attribute__((packed))</div><div class="ttdoc">PTT packet transmitted on every FHSS hop.</div><div class="ttdef"><b>Definition</b> radio.h:15</div></div>
|
|
<div class="ttc" id="aradio_8h_html_acfb21351bb3f0146635745bfacfe26a8"><div class="ttname"><a href="radio_8h.html#acfb21351bb3f0146635745bfacfe26a8">radio_init</a></div><div class="ttdeci">void radio_init(void)</div><div class="ttdoc">Configure the RADIO peripheral (mode, packet format, address, CRC, power).</div><div class="ttdef"><b>Definition</b> radio.c:59</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|