162 lines
16 KiB
HTML
162 lines
16 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.12.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RP2040-Decoder: core0.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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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">RP2040-Decoder
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @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 class="header">
|
|
<div class="headertitle"><div class="title">core0.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="core0_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> </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 "<a class="code" href="shared_8h.html">shared.h</a>"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "CV.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#define SIZE_BYTE_ARRAY 5</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define MESSAGE_3_BYTES 0b11111111110000000000000000000000000001</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define MESSAGE_MASK_3_BYTES 0b11111111111000000001000000001000000001</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#define MESSAGE_4_BYTES 0b11111111110000000000000000000000000000000000001</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#define MESSAGE_MASK_4_BYTES 0b11111111111000000001000000001000000001000000001</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define MESSAGE_5_BYTES 0b11111111110000000000000000000000000000000000000000000001</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#define MESSAGE_MASK_5_BYTES 0b11111111111000000001000000001000000001000000001000000001</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">const</span> uint32_t clr_bit_arr[6] = {</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> 0b11111111111111111111111111100000, <span class="comment">// Clear Bits 0-4 (F0-F4)</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> 0b11111111111111111111111000011111, <span class="comment">// Clear Bits 5-8 (F5-F8)</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> 0b11111111111111111110000111111111, <span class="comment">// Clear Bits 9-12 (F9-F12)</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> 0b11111111111000000001111111111111, <span class="comment">// Clear Bits 13-20 (F13-F20)</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> 0b11100000000111111111111111111111, <span class="comment">// Clear Bits 21-28 (F21-F28)</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> 0b00011111111111111111111111111111, <span class="comment">// Clear Bits 29-31 (F29-F31)</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> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keywordtype">float</span> two_std_dev(<span class="keyword">const</span> <span class="keywordtype">float</span> arr[], uint32_t length);</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keywordtype">void</span> adc_offset_adjustment(uint32_t length);</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keywordtype">void</span> acknowledge();</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keywordtype">void</span> verify_cv_bit(uint16_t cv_address,<span class="keywordtype">bool</span> bit_val, uint8_t bit_pos);</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keywordtype">void</span> verify_cv_byte(uint16_t cv_address, uint8_t cv_data);</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keywordtype">void</span> regular_cv_write(uint16_t cv_index, uint8_t cv_data);</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">//void write_cv_handler(uint16_t cv_index, uint8_t cv_data);</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#define ProgramInstrVerifyBit 0b10</span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#define ProgramInstrVerifyByte 0b01</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#define ProgramInstrWriteByte 0b11</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#define ProgramCmd(instr, adrmsbits) ((instr<<2) | (adrmsbits))</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="core0_8h.html#a5036684f11eb837835390659f9e0c4a9"> 57</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="core0_8h.html#a5036684f11eb837835390659f9e0c4a9">program_mode</a>(uint8_t number_of_bytes, <span class="keyword">const</span> uint8_t byte_array[]);</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keywordtype">void</span> set_outputs(uint32_t functions_to_set_bitmask);</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keywordtype">void</span> update_active_functions(uint32_t new_function_bitmask, uint8_t clr_bit_ind, <span class="keywordtype">bool</span> direction_change);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="keywordtype">bool</span> error_detection(int8_t number_of_bytes, <span class="keyword">const</span> uint8_t * byte_array);</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keywordtype">bool</span> is_long_address(uint8_t number_of_bytes, <span class="keyword">const</span> uint8_t byte_array[]);</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keywordtype">bool</span> address_evaluation(uint8_t number_of_bytes,<span class="keyword">const</span> uint8_t byte_array[]);</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="keywordtype">void</span> instruction_evaluation(uint8_t number_of_bytes,<span class="keyword">const</span> uint8_t byte_array[]);</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keywordtype">bool</span> reset_message_check(uint8_t number_of_bytes, <span class="keyword">const</span> uint8_t *<span class="keyword">const</span> byte_array);</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>int8_t verify_dcc_message();</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="keywordtype">void</span> bits_to_byte_array(int8_t number_of_bytes,uint8_t byte_array[]);</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keywordtype">void</span> evaluate_message();</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keywordtype">void</span> track_signal_rise(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> gpio, <span class="keywordtype">long</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> events);</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="keywordtype">void</span> track_signal_fall(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> gpio, <span class="keywordtype">long</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> events);</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="keywordtype">void</span> <a class="code hl_function" href="core0_8h.html#a10e6b83317f9b22b5264200049a77138">init_outputs</a>();</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>uint16_t <a class="code hl_function" href="core0_8h.html#a6682cbc69c5c3fa424609b6f15f3a9fa">measure_base_pwm</a>(<span class="keywordtype">bool</span> direction, uint8_t iterations);</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="keywordtype">void</span> <a class="code hl_function" href="core0_8h.html#afdf05cec06f673d2763ab0631cbe62f8">cv_setup_check</a>();</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="keywordtype">void</span> <a class="code hl_function" href="core0_8h.html#aebc81e473ba119c0ce42cacb4efeec69">init_motor_pwm</a>(uint8_t gpio);</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="keywordtype">void</span> <a class="code hl_function" href="core0_8h.html#a2d55adaff96e84bf99460f7c9d24f7a4">init_adc</a>();</div>
|
|
<div class="ttc" id="acore0_8h_html_a10e6b83317f9b22b5264200049a77138"><div class="ttname"><a href="core0_8h.html#a10e6b83317f9b22b5264200049a77138">init_outputs</a></div><div class="ttdeci">void init_outputs()</div><div class="ttdoc">Output initialization function.</div><div class="ttdef"><b>Definition</b> core0.c:518</div></div>
|
|
<div class="ttc" id="acore0_8h_html_a2d55adaff96e84bf99460f7c9d24f7a4"><div class="ttname"><a href="core0_8h.html#a2d55adaff96e84bf99460f7c9d24f7a4">init_adc</a></div><div class="ttdeci">void init_adc()</div><div class="ttdoc">Initializes ADC.</div><div class="ttdef"><b>Definition</b> core0.c:639</div></div>
|
|
<div class="ttc" id="acore0_8h_html_a5036684f11eb837835390659f9e0c4a9"><div class="ttname"><a href="core0_8h.html#a5036684f11eb837835390659f9e0c4a9">program_mode</a></div><div class="ttdeci">void program_mode(uint8_t number_of_bytes, const uint8_t byte_array[])</div><div class="ttdoc">CV Programming mode function Used on entering programming mode in order to write CV values to persist...</div></div>
|
|
<div class="ttc" id="acore0_8h_html_a6682cbc69c5c3fa424609b6f15f3a9fa"><div class="ttname"><a href="core0_8h.html#a6682cbc69c5c3fa424609b6f15f3a9fa">measure_base_pwm</a></div><div class="ttdeci">uint16_t measure_base_pwm(bool direction, uint8_t iterations)</div><div class="ttdoc">Measures base pwm duty cycles at which the motor barely starts moving.</div><div class="ttdef"><b>Definition</b> core0.c:541</div></div>
|
|
<div class="ttc" id="acore0_8h_html_aebc81e473ba119c0ce42cacb4efeec69"><div class="ttname"><a href="core0_8h.html#aebc81e473ba119c0ce42cacb4efeec69">init_motor_pwm</a></div><div class="ttdeci">void init_motor_pwm(uint8_t gpio)</div><div class="ttdoc">Function initializes motor PWM for pin specified.</div><div class="ttdef"><b>Definition</b> core0.c:624</div></div>
|
|
<div class="ttc" id="acore0_8h_html_afdf05cec06f673d2763ab0631cbe62f8"><div class="ttname"><a href="core0_8h.html#afdf05cec06f673d2763ab0631cbe62f8">cv_setup_check</a></div><div class="ttdeci">void cv_setup_check()</div><div class="ttdoc">Checks various CV values in order to detect factory condition or pending calibrations.</div><div class="ttdef"><b>Definition</b> core0.c:579</div></div>
|
|
<div class="ttc" id="ashared_8h_html"><div class="ttname"><a href="shared_8h.html">shared.h</a></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.12.0
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|