Files
RP2040-Decoder/html/shared_8h.html
T
2024-11-26 16:38:51 +00:00

269 lines
19 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: shared.h 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>
<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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(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 */
$(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><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">shared.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;string.h&quot;</code><br />
<code>#include &quot;pico/float.h&quot;</code><br />
<code>#include &quot;pico/stdlib.h&quot;</code><br />
<code>#include &quot;pico/multicore.h&quot;</code><br />
<code>#include &quot;pico/printf.h&quot;</code><br />
<code>#include &quot;hardware/pwm.h&quot;</code><br />
<code>#include &quot;hardware/adc.h&quot;</code><br />
<code>#include &quot;hardware/flash.h&quot;</code><br />
</div>
<p><a href="shared_8h_source.html">Go to the source code of this file.</a></p>
<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:a6c6fd5e242df15a7a42e9b75d55d5d3c" id="r_a6c6fd5e242df15a7a42e9b75d55d5d3c"><td class="memItemLeft" align="right" valign="top"><a id="a6c6fd5e242df15a7a42e9b75d55d5d3c" name="a6c6fd5e242df15a7a42e9b75d55d5d3c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>LOGLEVEL</b>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a6c6fd5e242df15a7a42e9b75d55d5d3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaa1c3fa56061380a29889d703236251" id="r_acaa1c3fa56061380a29889d703236251"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acaa1c3fa56061380a29889d703236251">LOG</a>(level, ...)</td></tr>
<tr class="separator:acaa1c3fa56061380a29889d703236251"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11ae1c54493c00fc571ead5bca55d269" id="r_a11ae1c54493c00fc571ead5bca55d269"><td class="memItemLeft" align="right" valign="top"><a id="a11ae1c54493c00fc571ead5bca55d269" name="a11ae1c54493c00fc571ead5bca55d269"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>_125M</b>&#160;&#160;&#160;125000000</td></tr>
<tr class="separator:a11ae1c54493c00fc571ead5bca55d269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71e492f5f272f07b812ebe18757a2f4" id="r_ac71e492f5f272f07b812ebe18757a2f4"><td class="memItemLeft" align="right" valign="top"><a id="ac71e492f5f272f07b812ebe18757a2f4" name="ac71e492f5f272f07b812ebe18757a2f4"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>DCC_INPUT_PIN</b>&#160;&#160;&#160;21u</td></tr>
<tr class="separator:ac71e492f5f272f07b812ebe18757a2f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a480d8c98b645b4e4f17d894f550c3626" id="r_a480d8c98b645b4e4f17d894f550c3626"><td class="memItemLeft" align="right" valign="top"><a id="a480d8c98b645b4e4f17d894f550c3626" name="a480d8c98b645b4e4f17d894f550c3626"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOTOR_FWD_PIN</b>&#160;&#160;&#160;23u</td></tr>
<tr class="separator:a480d8c98b645b4e4f17d894f550c3626"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a313656e92150fc5f9203726df3a8a68c" id="r_a313656e92150fc5f9203726df3a8a68c"><td class="memItemLeft" align="right" valign="top"><a id="a313656e92150fc5f9203726df3a8a68c" name="a313656e92150fc5f9203726df3a8a68c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MOTOR_REV_PIN</b>&#160;&#160;&#160;22u</td></tr>
<tr class="separator:a313656e92150fc5f9203726df3a8a68c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbc76b66e92d86f9cfe27f51253a5038" id="r_adbc76b66e92d86f9cfe27f51253a5038"><td class="memItemLeft" align="right" valign="top"><a id="adbc76b66e92d86f9cfe27f51253a5038" name="adbc76b66e92d86f9cfe27f51253a5038"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FWD_V_EMF_ADC_PIN</b>&#160;&#160;&#160;28u</td></tr>
<tr class="separator:adbc76b66e92d86f9cfe27f51253a5038"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7c9c4bc8bfd08aa5169978af9bf17c9" id="r_af7c9c4bc8bfd08aa5169978af9bf17c9"><td class="memItemLeft" align="right" valign="top"><a id="af7c9c4bc8bfd08aa5169978af9bf17c9" name="af7c9c4bc8bfd08aa5169978af9bf17c9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>REV_V_EMF_ADC_PIN</b>&#160;&#160;&#160;29u</td></tr>
<tr class="separator:af7c9c4bc8bfd08aa5169978af9bf17c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a613516de560d9a5355520b76b256a58d" id="r_a613516de560d9a5355520b76b256a58d"><td class="memItemLeft" align="right" valign="top"><a id="a613516de560d9a5355520b76b256a58d" name="a613516de560d9a5355520b76b256a58d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GPIO_OUTPUT_PIN_MASK</b>&#160;&#160;&#160;(1u&lt;&lt;24) | (1u&lt;&lt;25) | (1u&lt;&lt;26) | (1u&lt;&lt;27) | (1u&lt;&lt;5) | (1u&lt;&lt;4) | (1u&lt;&lt;3) | (1u&lt;&lt;2) | (1u&lt;&lt;1) | (1u&lt;&lt;0)</td></tr>
<tr class="separator:a613516de560d9a5355520b76b256a58d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a544001c09a62a396743e564a9e0bd9d4" id="r_a544001c09a62a396743e564a9e0bd9d4"><td class="memItemLeft" align="right" valign="top"><a id="a544001c09a62a396743e564a9e0bd9d4" name="a544001c09a62a396743e564a9e0bd9d4"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GPIO_ILLEGAL_MASK</b>&#160;&#160;&#160;(1u&lt;&lt;DCC_INPUT_PIN) | (1u&lt;&lt;MOTOR_FWD_PIN) | (1u&lt;&lt;MOTOR_REV_PIN) | (1u&lt;&lt;FWD_V_EMF_ADC_PIN) | (1u&lt;&lt;REV_V_EMF_ADC_PIN)</td></tr>
<tr class="separator:a544001c09a62a396743e564a9e0bd9d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4b0910bc8b035c26ded8b9498bf4f50" id="r_ae4b0910bc8b035c26ded8b9498bf4f50"><td class="memItemLeft" align="right" valign="top"><a id="ae4b0910bc8b035c26ded8b9498bf4f50" name="ae4b0910bc8b035c26ded8b9498bf4f50"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GPIO_ALLOWED_OUTPUTS</b>&#160;&#160;&#160;(GPIO_OUTPUT_PIN_MASK) &amp; ~(GPIO_ILLEGAL_MASK)</td></tr>
<tr class="separator:ae4b0910bc8b035c26ded8b9498bf4f50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21df7978a7e635eaa5037d4c853cd15d" id="r_a21df7978a7e635eaa5037d4c853cd15d"><td class="memItemLeft" align="right" valign="top"><a id="a21df7978a7e635eaa5037d4c853cd15d" name="a21df7978a7e635eaa5037d4c853cd15d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FLASH_TARGET_OFFSET</b>&#160;&#160;&#160;(PICO_FLASH_SIZE_BYTES-FLASH_SECTOR_SIZE)</td></tr>
<tr class="separator:a21df7978a7e635eaa5037d4c853cd15d"><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:a9f153132b8b4afad133b952111e18bd9" id="r_a9f153132b8b4afad133b952111e18bd9"><td class="memItemLeft" align="right" valign="top"><a id="a9f153132b8b4afad133b952111e18bd9" name="a9f153132b8b4afad133b952111e18bd9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>core1_entry</b> ()</td></tr>
<tr class="separator:a9f153132b8b4afad133b952111e18bd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58018bb4ac50fbe1d7df43baa1decc82" id="r_a58018bb4ac50fbe1d7df43baa1decc82"><td class="memItemLeft" align="right" valign="top"><a id="a58018bb4ac50fbe1d7df43baa1decc82" name="a58018bb4ac50fbe1d7df43baa1decc82"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>write_cv_handler</b> (uint16_t cv_index, uint8_t cv_data)</td></tr>
<tr class="separator:a58018bb4ac50fbe1d7df43baa1decc82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10fb56d0c68ae9f38512204e089fe026" id="r_a10fb56d0c68ae9f38512204e089fe026"><td class="memItemLeft" align="right" valign="top"><a id="a10fb56d0c68ae9f38512204e089fe026" name="a10fb56d0c68ae9f38512204e089fe026"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>measure</b> (uint8_t total_iterations, uint8_t measurement_delay_us, uint8_t l_side_arr_cutoff, uint8_t r_side_arr_cutoff, bool direction)</td></tr>
<tr class="separator:a10fb56d0c68ae9f38512204e089fe026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affc14a889b226b8ebcbf64774a5e1c53" id="r_affc14a889b226b8ebcbf64774a5e1c53"><td class="memItemLeft" align="right" valign="top"><a id="affc14a889b226b8ebcbf64774a5e1c53" name="affc14a889b226b8ebcbf64774a5e1c53"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>get_32bit_CV</b> (uint16_t CV_start_index)</td></tr>
<tr class="separator:affc14a889b226b8ebcbf64774a5e1c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32beddf80bbca0e114f8d72ed3937889" id="r_a32beddf80bbca0e114f8d72ed3937889"><td class="memItemLeft" align="right" valign="top"><a id="a32beddf80bbca0e114f8d72ed3937889" name="a32beddf80bbca0e114f8d72ed3937889"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>get_16bit_CV</b> (uint16_t CV_start_index)</td></tr>
<tr class="separator:a32beddf80bbca0e114f8d72ed3937889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed72641466dd9da550e446ad104607d0" id="r_aed72641466dd9da550e446ad104607d0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed72641466dd9da550e446ad104607d0">get_direction_of_speed_step</a> (uint8_t speed_step)</td></tr>
<tr class="memdesc:aed72641466dd9da550e446ad104607d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get direction Function calculates direction.Direction is based on speed_step byte. <br />
Refers to "128 Speed Control" - NMRA Standard 9.2.1 section 2.3.2.1 or RCN-212 section 2.2.2. <br />
<br /></td></tr>
<tr class="separator:aed72641466dd9da550e446ad104607d0"><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:acb0acf1449e6540098ea12180e946d48" id="r_acb0acf1449e6540098ea12180e946d48"><td class="memItemLeft" align="right" valign="top"><a id="acb0acf1449e6540098ea12180e946d48" name="acb0acf1449e6540098ea12180e946d48"></a>
repeating_timer_t&#160;</td><td class="memItemRight" valign="bottom"><b>pid_control_timer</b></td></tr>
<tr class="separator:acb0acf1449e6540098ea12180e946d48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a997c9c1785ccb1f19d61d96ddb9c6d1a" id="r_a997c9c1785ccb1f19d61d96ddb9c6d1a"><td class="memItemLeft" align="right" valign="top"><a id="a997c9c1785ccb1f19d61d96ddb9c6d1a" name="a997c9c1785ccb1f19d61d96ddb9c6d1a"></a>
repeating_timer_t&#160;</td><td class="memItemRight" valign="bottom"><b>speed_helper_timer</b></td></tr>
<tr class="separator:a997c9c1785ccb1f19d61d96ddb9c6d1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1d1205049d95e5b1789bbabe78375df" id="r_ac1d1205049d95e5b1789bbabe78375df"><td class="memItemLeft" align="right" valign="top"><a id="ac1d1205049d95e5b1789bbabe78375df" name="ac1d1205049d95e5b1789bbabe78375df"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>CV_ARRAY_FLASH</b></td></tr>
<tr class="separator:ac1d1205049d95e5b1789bbabe78375df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe526de436479f50bbbf21d68b132b5c" id="r_afe526de436479f50bbbf21d68b132b5c"><td class="memItemLeft" align="right" valign="top"><a id="afe526de436479f50bbbf21d68b132b5c" name="afe526de436479f50bbbf21d68b132b5c"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>speed_step_target</b></td></tr>
<tr class="separator:afe526de436479f50bbbf21d68b132b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3e1c0713b69e9c5b7c71a01d4e5475c" id="r_af3e1c0713b69e9c5b7c71a01d4e5475c"><td class="memItemLeft" align="right" valign="top"><a id="af3e1c0713b69e9c5b7c71a01d4e5475c" name="af3e1c0713b69e9c5b7c71a01d4e5475c"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>speed_step_target_prev</b></td></tr>
<tr class="separator:af3e1c0713b69e9c5b7c71a01d4e5475c"><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>Used by both cores </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="acaa1c3fa56061380a29889d703236251" name="acaa1c3fa56061380a29889d703236251"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaa1c3fa56061380a29889d703236251">&#9670;&#160;</a></span>LOG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LOG</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>level</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ <span class="keywordflow">if</span>(level &lt;= LOGLEVEL) {printf(__VA_ARGS__);}}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aed72641466dd9da550e446ad104607d0" name="aed72641466dd9da550e446ad104607d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed72641466dd9da550e446ad104607d0">&#9670;&#160;</a></span>get_direction_of_speed_step()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool get_direction_of_speed_step </td>
<td>(</td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>speed_step</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get direction Function calculates direction.Direction is based on speed_step byte. <br />
Refers to "128 Speed Control" - NMRA Standard 9.2.1 section 2.3.2.1 or RCN-212 section 2.2.2. <br />
</p>
<p>The following speed steps exist:</p><ul>
<li>DEC | BIN | DIRECTION | DEFINITION</li>
<li>000 | 0000 0000 | Reverse | STOP</li>
<li>001 | 0000 0001 | Reverse | EMERGENCY STOP</li>
<li>002 | 0000 0010 | Reverse | Speed step 001 (Lowest speed)</li>
<li>003 | 0000 0011 | Reverse | Speed step 002</li>
<li>004 | 0000 0100 | Reverse | Speed step 003</li>
<li>... | .... .... | Reverse | .....</li>
<li>... | .... .... | Reverse | .....</li>
<li>... | .... .... | Reverse | .....</li>
<li>126 | 0111 1110 | Reverse | Speed step 125</li>
<li>127 | 0111 1111 | Reverse | Speed step 126 (Full speed)</li>
<li>128 | 1000 0000 | Forward | STOP</li>
<li>129 | 1000 0001 | Forward | EMERGENCY STOP</li>
<li>130 | 1000 0010 | Forward | Speed step 001 (Lowest speed)</li>
<li>131 | 1000 0011 | Forward | Speed step 002</li>
<li>132 | 1000 0100 | Forward | Speed step 003</li>
<li>... | .... .... | Forward | .....</li>
<li>... | .... .... | Forward | .....</li>
<li>... | .... .... | Forward | .....</li>
<li>254 | 1111 1110 | Forward | Speed step 125</li>
<li>255 | 1111 1111 | Forward | Speed step 126 (Full speed)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">speed_step</td><td>speed step byte </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>direction; false for reverse; true for forward; </dd></dl>
</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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>