401 lines
30 KiB
HTML
401 lines
30 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.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RP2040-Decoder: core0.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>
|
|
<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.10.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" 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');
|
|
$(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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">core0.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="shared_8h_source.html">shared.h</a>"</code><br />
|
|
<code>#include "CV.h"</code><br />
|
|
</div>
|
|
<p><a href="core0_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:a8cbe85a94beae30d747e6a6e85d1ae77" id="r_a8cbe85a94beae30d747e6a6e85d1ae77"><td class="memItemLeft" align="right" valign="top"><a id="a8cbe85a94beae30d747e6a6e85d1ae77" name="a8cbe85a94beae30d747e6a6e85d1ae77"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>SIZE_BYTE_ARRAY</b>   5</td></tr>
|
|
<tr class="separator:a8cbe85a94beae30d747e6a6e85d1ae77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a9a8f8772123235b03debb48fa8a973" id="r_a8a9a8f8772123235b03debb48fa8a973"><td class="memItemLeft" align="right" valign="top"><a id="a8a9a8f8772123235b03debb48fa8a973" name="a8a9a8f8772123235b03debb48fa8a973"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MESSAGE_3_BYTES</b>   0b11111111110000000000000000000000000001</td></tr>
|
|
<tr class="separator:a8a9a8f8772123235b03debb48fa8a973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf2f95404177396e3c93496d3b1d709d" id="r_acf2f95404177396e3c93496d3b1d709d"><td class="memItemLeft" align="right" valign="top"><a id="acf2f95404177396e3c93496d3b1d709d" name="acf2f95404177396e3c93496d3b1d709d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MESSAGE_MASK_3_BYTES</b>   0b11111111111000000001000000001000000001</td></tr>
|
|
<tr class="separator:acf2f95404177396e3c93496d3b1d709d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a884ecc75183e104a60d283a494d163b6" id="r_a884ecc75183e104a60d283a494d163b6"><td class="memItemLeft" align="right" valign="top"><a id="a884ecc75183e104a60d283a494d163b6" name="a884ecc75183e104a60d283a494d163b6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MESSAGE_4_BYTES</b>   0b11111111110000000000000000000000000000000000001</td></tr>
|
|
<tr class="separator:a884ecc75183e104a60d283a494d163b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf19b4efd2b349355d55755444620350" id="r_adf19b4efd2b349355d55755444620350"><td class="memItemLeft" align="right" valign="top"><a id="adf19b4efd2b349355d55755444620350" name="adf19b4efd2b349355d55755444620350"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MESSAGE_MASK_4_BYTES</b>   0b11111111111000000001000000001000000001000000001</td></tr>
|
|
<tr class="separator:adf19b4efd2b349355d55755444620350"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ea7db2e0ad13e6cd1cf221d72d86bb1" id="r_a1ea7db2e0ad13e6cd1cf221d72d86bb1"><td class="memItemLeft" align="right" valign="top"><a id="a1ea7db2e0ad13e6cd1cf221d72d86bb1" name="a1ea7db2e0ad13e6cd1cf221d72d86bb1"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MESSAGE_5_BYTES</b>   0b11111111110000000000000000000000000000000000000000000001</td></tr>
|
|
<tr class="separator:a1ea7db2e0ad13e6cd1cf221d72d86bb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdd45d7e2d818186f88953c361831b55" id="r_acdd45d7e2d818186f88953c361831b55"><td class="memItemLeft" align="right" valign="top"><a id="acdd45d7e2d818186f88953c361831b55" name="acdd45d7e2d818186f88953c361831b55"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MESSAGE_MASK_5_BYTES</b>   0b11111111111000000001000000001000000001000000001000000001</td></tr>
|
|
<tr class="separator:acdd45d7e2d818186f88953c361831b55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7e019af7c87ab5b4921a34a69a492e4" id="r_ad7e019af7c87ab5b4921a34a69a492e4"><td class="memItemLeft" align="right" valign="top"><a id="ad7e019af7c87ab5b4921a34a69a492e4" name="ad7e019af7c87ab5b4921a34a69a492e4"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>ProgramInstrVerifyBit</b>   0b10</td></tr>
|
|
<tr class="separator:ad7e019af7c87ab5b4921a34a69a492e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc11566d5e50efd3460af5f3d44e1b55" id="r_abc11566d5e50efd3460af5f3d44e1b55"><td class="memItemLeft" align="right" valign="top"><a id="abc11566d5e50efd3460af5f3d44e1b55" name="abc11566d5e50efd3460af5f3d44e1b55"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>ProgramInstrVerifyByte</b>   0b01</td></tr>
|
|
<tr class="separator:abc11566d5e50efd3460af5f3d44e1b55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53dc68777633668edaa727468e284957" id="r_a53dc68777633668edaa727468e284957"><td class="memItemLeft" align="right" valign="top"><a id="a53dc68777633668edaa727468e284957" name="a53dc68777633668edaa727468e284957"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>ProgramInstrWriteByte</b>   0b11</td></tr>
|
|
<tr class="separator:a53dc68777633668edaa727468e284957"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec939c48b644ea5430553e2aa14966f9" id="r_aec939c48b644ea5430553e2aa14966f9"><td class="memItemLeft" align="right" valign="top"><a id="aec939c48b644ea5430553e2aa14966f9" name="aec939c48b644ea5430553e2aa14966f9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>ProgramCmd</b>(instr, adrmsbits)   ((instr<<2) | (adrmsbits))</td></tr>
|
|
<tr class="separator:aec939c48b644ea5430553e2aa14966f9"><td class="memSeparator" colspan="2"> </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:a8db7b95e52c5a24409a057b5354aacac" id="r_a8db7b95e52c5a24409a057b5354aacac"><td class="memItemLeft" align="right" valign="top"><a id="a8db7b95e52c5a24409a057b5354aacac" name="a8db7b95e52c5a24409a057b5354aacac"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><b>two_std_dev</b> (const float arr[], uint32_t length)</td></tr>
|
|
<tr class="separator:a8db7b95e52c5a24409a057b5354aacac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a051fb7971eec35125457b7b6ff5d0c59" id="r_a051fb7971eec35125457b7b6ff5d0c59"><td class="memItemLeft" align="right" valign="top"><a id="a051fb7971eec35125457b7b6ff5d0c59" name="a051fb7971eec35125457b7b6ff5d0c59"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>adc_offset_adjustment</b> (uint32_t length)</td></tr>
|
|
<tr class="separator:a051fb7971eec35125457b7b6ff5d0c59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac87bd6623f47a32e08278afe923477fd" id="r_ac87bd6623f47a32e08278afe923477fd"><td class="memItemLeft" align="right" valign="top"><a id="ac87bd6623f47a32e08278afe923477fd" name="ac87bd6623f47a32e08278afe923477fd"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>acknowledge</b> ()</td></tr>
|
|
<tr class="separator:ac87bd6623f47a32e08278afe923477fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc9694833148886687130bfc41c0278b" id="r_afc9694833148886687130bfc41c0278b"><td class="memItemLeft" align="right" valign="top"><a id="afc9694833148886687130bfc41c0278b" name="afc9694833148886687130bfc41c0278b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>verify_cv_bit</b> (uint16_t cv_address, bool bit_val, uint8_t bit_pos)</td></tr>
|
|
<tr class="separator:afc9694833148886687130bfc41c0278b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28319b022b8ee5ff0a38ef2581a4967e" id="r_a28319b022b8ee5ff0a38ef2581a4967e"><td class="memItemLeft" align="right" valign="top"><a id="a28319b022b8ee5ff0a38ef2581a4967e" name="a28319b022b8ee5ff0a38ef2581a4967e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>verify_cv_byte</b> (uint16_t cv_address, uint8_t cv_data)</td></tr>
|
|
<tr class="separator:a28319b022b8ee5ff0a38ef2581a4967e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48e55d64ba5153b8e12190e3a85c7d94" id="r_a48e55d64ba5153b8e12190e3a85c7d94"><td class="memItemLeft" align="right" valign="top"><a id="a48e55d64ba5153b8e12190e3a85c7d94" name="a48e55d64ba5153b8e12190e3a85c7d94"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>regular_cv_write</b> (uint16_t cv_index, uint8_t cv_data)</td></tr>
|
|
<tr class="separator:a48e55d64ba5153b8e12190e3a85c7d94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5036684f11eb837835390659f9e0c4a9" id="r_a5036684f11eb837835390659f9e0c4a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5036684f11eb837835390659f9e0c4a9">program_mode</a> (uint8_t number_of_bytes, const uint8_t byte_array[])</td></tr>
|
|
<tr class="memdesc:a5036684f11eb837835390659f9e0c4a9"><td class="mdescLeft"> </td><td class="mdescRight">CV Programming mode function Used on entering programming mode in order to write CV values to persistent flash memory or verify/read bits/bytes from flash. <br />
|
|
Refers to NMRA Standard 9.2.3 ("Service Mode Programming") or RCN-216<br />
|
|
<br /></td></tr>
|
|
<tr class="separator:a5036684f11eb837835390659f9e0c4a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a278792ebcab284a57b088283d570957e" id="r_a278792ebcab284a57b088283d570957e"><td class="memItemLeft" align="right" valign="top"><a id="a278792ebcab284a57b088283d570957e" name="a278792ebcab284a57b088283d570957e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>set_outputs</b> (uint32_t functions_to_set_bitmask)</td></tr>
|
|
<tr class="separator:a278792ebcab284a57b088283d570957e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38173806a6d7c084467c72ce23cc47a2" id="r_a38173806a6d7c084467c72ce23cc47a2"><td class="memItemLeft" align="right" valign="top"><a id="a38173806a6d7c084467c72ce23cc47a2" name="a38173806a6d7c084467c72ce23cc47a2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>update_active_functions</b> (uint32_t new_function_bitmask, uint8_t clr_bit_ind, bool direction_change)</td></tr>
|
|
<tr class="separator:a38173806a6d7c084467c72ce23cc47a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ac1fe49e3a7374fa60cdf3996138b2c" id="r_a9ac1fe49e3a7374fa60cdf3996138b2c"><td class="memItemLeft" align="right" valign="top"><a id="a9ac1fe49e3a7374fa60cdf3996138b2c" name="a9ac1fe49e3a7374fa60cdf3996138b2c"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>error_detection</b> (int8_t number_of_bytes, const uint8_t *byte_array)</td></tr>
|
|
<tr class="separator:a9ac1fe49e3a7374fa60cdf3996138b2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c3523e21bb4baefbe045caa9e35c2d7" id="r_a0c3523e21bb4baefbe045caa9e35c2d7"><td class="memItemLeft" align="right" valign="top"><a id="a0c3523e21bb4baefbe045caa9e35c2d7" name="a0c3523e21bb4baefbe045caa9e35c2d7"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>is_long_address</b> (uint8_t number_of_bytes, const uint8_t byte_array[])</td></tr>
|
|
<tr class="separator:a0c3523e21bb4baefbe045caa9e35c2d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88ebfc9c05785e606880d290dee9216d" id="r_a88ebfc9c05785e606880d290dee9216d"><td class="memItemLeft" align="right" valign="top"><a id="a88ebfc9c05785e606880d290dee9216d" name="a88ebfc9c05785e606880d290dee9216d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>address_evaluation</b> (uint8_t number_of_bytes, const uint8_t byte_array[])</td></tr>
|
|
<tr class="separator:a88ebfc9c05785e606880d290dee9216d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab7c4b425f063f7945344c8209a097eca" id="r_ab7c4b425f063f7945344c8209a097eca"><td class="memItemLeft" align="right" valign="top"><a id="ab7c4b425f063f7945344c8209a097eca" name="ab7c4b425f063f7945344c8209a097eca"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>instruction_evaluation</b> (uint8_t number_of_bytes, const uint8_t byte_array[])</td></tr>
|
|
<tr class="separator:ab7c4b425f063f7945344c8209a097eca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ba04419ee6b760e8a19868d3fffc0be" id="r_a0ba04419ee6b760e8a19868d3fffc0be"><td class="memItemLeft" align="right" valign="top"><a id="a0ba04419ee6b760e8a19868d3fffc0be" name="a0ba04419ee6b760e8a19868d3fffc0be"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>reset_message_check</b> (uint8_t number_of_bytes, const uint8_t *const byte_array)</td></tr>
|
|
<tr class="separator:a0ba04419ee6b760e8a19868d3fffc0be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe010c2c968965623f9a7409a997b1a8" id="r_afe010c2c968965623f9a7409a997b1a8"><td class="memItemLeft" align="right" valign="top"><a id="afe010c2c968965623f9a7409a997b1a8" name="afe010c2c968965623f9a7409a997b1a8"></a>
|
|
int8_t </td><td class="memItemRight" valign="bottom"><b>verify_dcc_message</b> ()</td></tr>
|
|
<tr class="separator:afe010c2c968965623f9a7409a997b1a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac801d52a750572fda6908c63ab265571" id="r_ac801d52a750572fda6908c63ab265571"><td class="memItemLeft" align="right" valign="top"><a id="ac801d52a750572fda6908c63ab265571" name="ac801d52a750572fda6908c63ab265571"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>bits_to_byte_array</b> (int8_t number_of_bytes, uint8_t byte_array[])</td></tr>
|
|
<tr class="separator:ac801d52a750572fda6908c63ab265571"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fc8afa31d573a86427f7e73bdb8a07c" id="r_a0fc8afa31d573a86427f7e73bdb8a07c"><td class="memItemLeft" align="right" valign="top"><a id="a0fc8afa31d573a86427f7e73bdb8a07c" name="a0fc8afa31d573a86427f7e73bdb8a07c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>evaluate_message</b> ()</td></tr>
|
|
<tr class="separator:a0fc8afa31d573a86427f7e73bdb8a07c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e63f26cc0e48c67410c6729a3798126" id="r_a9e63f26cc0e48c67410c6729a3798126"><td class="memItemLeft" align="right" valign="top"><a id="a9e63f26cc0e48c67410c6729a3798126" name="a9e63f26cc0e48c67410c6729a3798126"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>track_signal_rise</b> (unsigned int gpio, long unsigned int events)</td></tr>
|
|
<tr class="separator:a9e63f26cc0e48c67410c6729a3798126"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8ee69201d93bb812e1fe4f5feadbfdf" id="r_aa8ee69201d93bb812e1fe4f5feadbfdf"><td class="memItemLeft" align="right" valign="top"><a id="aa8ee69201d93bb812e1fe4f5feadbfdf" name="aa8ee69201d93bb812e1fe4f5feadbfdf"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>track_signal_fall</b> (unsigned int gpio, long unsigned int events)</td></tr>
|
|
<tr class="separator:aa8ee69201d93bb812e1fe4f5feadbfdf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10e6b83317f9b22b5264200049a77138" id="r_a10e6b83317f9b22b5264200049a77138"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a10e6b83317f9b22b5264200049a77138">init_outputs</a> ()</td></tr>
|
|
<tr class="memdesc:a10e6b83317f9b22b5264200049a77138"><td class="mdescLeft"> </td><td class="mdescRight">Output initialization function. <br /></td></tr>
|
|
<tr class="separator:a10e6b83317f9b22b5264200049a77138"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6682cbc69c5c3fa424609b6f15f3a9fa" id="r_a6682cbc69c5c3fa424609b6f15f3a9fa"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6682cbc69c5c3fa424609b6f15f3a9fa">measure_base_pwm</a> (bool direction, uint8_t iterations)</td></tr>
|
|
<tr class="memdesc:a6682cbc69c5c3fa424609b6f15f3a9fa"><td class="mdescLeft"> </td><td class="mdescRight">Measures base pwm duty cycles at which the motor barely starts moving. <br /></td></tr>
|
|
<tr class="separator:a6682cbc69c5c3fa424609b6f15f3a9fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdf05cec06f673d2763ab0631cbe62f8" id="r_afdf05cec06f673d2763ab0631cbe62f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#afdf05cec06f673d2763ab0631cbe62f8">cv_setup_check</a> ()</td></tr>
|
|
<tr class="memdesc:afdf05cec06f673d2763ab0631cbe62f8"><td class="mdescLeft"> </td><td class="mdescRight">Checks various CV values in order to detect factory condition or pending calibrations. <br /></td></tr>
|
|
<tr class="separator:afdf05cec06f673d2763ab0631cbe62f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebc81e473ba119c0ce42cacb4efeec69" id="r_aebc81e473ba119c0ce42cacb4efeec69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aebc81e473ba119c0ce42cacb4efeec69">init_motor_pwm</a> (uint8_t gpio)</td></tr>
|
|
<tr class="memdesc:aebc81e473ba119c0ce42cacb4efeec69"><td class="mdescLeft"> </td><td class="mdescRight">Function initializes motor PWM for pin specified. <br /></td></tr>
|
|
<tr class="separator:aebc81e473ba119c0ce42cacb4efeec69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d55adaff96e84bf99460f7c9d24f7a4" id="r_a2d55adaff96e84bf99460f7c9d24f7a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d55adaff96e84bf99460f7c9d24f7a4">init_adc</a> ()</td></tr>
|
|
<tr class="memdesc:a2d55adaff96e84bf99460f7c9d24f7a4"><td class="mdescLeft"> </td><td class="mdescRight">Initializes ADC. <br /></td></tr>
|
|
<tr class="separator:a2d55adaff96e84bf99460f7c9d24f7a4"><td class="memSeparator" colspan="2"> </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:a3cb7d222f559f6157b67e5b778b3752d" id="r_a3cb7d222f559f6157b67e5b778b3752d"><td class="memItemLeft" align="right" valign="top">const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cb7d222f559f6157b67e5b778b3752d">clr_bit_arr</a> [6]</td></tr>
|
|
<tr class="separator:a3cb7d222f559f6157b67e5b778b3752d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Used exclusively by core0 </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="afdf05cec06f673d2763ab0631cbe62f8" name="afdf05cec06f673d2763ab0631cbe62f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdf05cec06f673d2763ab0631cbe62f8">◆ </a></span>cv_setup_check()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void cv_setup_check </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks various CV values in order to detect factory condition or pending calibrations. </p>
|
|
<p>Procedure:</p><ol type="1">
|
|
<li>Check for flash memory factory condition when found write default values specified in <a class="el" href="CV_8h_source.html">CV.h</a> to flash memory</li>
|
|
<li>Check for existing ADC offset setup when not found write 7 to read-only CV_7 in order to trigger a ADC offset measurement/calibration</li>
|
|
<li>Check for base PWM configuration/calibration, run calibration when none is found </li>
|
|
</ol>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2d55adaff96e84bf99460f7c9d24f7a4" name="a2d55adaff96e84bf99460f7c9d24f7a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d55adaff96e84bf99460f7c9d24f7a4">◆ </a></span>init_adc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void init_adc </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes ADC. </p>
|
|
<p>Function initializes ADC, corresponding GPIO pins and ADC FIFO </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebc81e473ba119c0ce42cacb4efeec69" name="aebc81e473ba119c0ce42cacb4efeec69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebc81e473ba119c0ce42cacb4efeec69">◆ </a></span>init_motor_pwm()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void init_motor_pwm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>gpio</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function initializes motor PWM for pin specified. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gpio</td><td>GPIO pin </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a10e6b83317f9b22b5264200049a77138" name="a10e6b83317f9b22b5264200049a77138"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10e6b83317f9b22b5264200049a77138">◆ </a></span>init_outputs()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void init_outputs </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Output initialization function. </p>
|
|
<p>Initializes all allowed GPIO outputs as outputs <br />
|
|
Sets PWM functionality for GPIOs configured as PWM pins CV_112 - CV_115 (see <a class="el" href="CV_8h_source.html">CV.h</a> for reference) <br />
|
|
PWM frequency and clock divider are configured according to CV_116 - CV_171 (see <a class="el" href="CV_8h_source.html">CV.h</a> for reference) <br />
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6682cbc69c5c3fa424609b6f15f3a9fa" name="a6682cbc69c5c3fa424609b6f15f3a9fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6682cbc69c5c3fa424609b6f15f3a9fa">◆ </a></span>measure_base_pwm()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t measure_base_pwm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>direction</em>, </span></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>iterations</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Measures base pwm duty cycles at which the motor barely starts moving. </p>
|
|
<p>Function starts with 1/20 of the maximum duty cycle then increases the duty cycle by 1/500 of the maximum until the motor movement can be measured. This is done for the specified amount of iterations. The array with raw measurements values is then passed to two_std_dev() in order to detect outliers and calculate the average.An additional correction factor is applied and the overall measurement result is then returned. In case no motor movement could be measured a value of 0 is returned and normally written to flash, indicating a pending calibration next time the decoder starts, rerunning the calibration. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">direction</td><td>Specifies direction which is to be measured </td></tr>
|
|
<tr><td class="paramname">iterations</td><td>Specifies the amount of iterations the measurement is to be repeated and averaged out over </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Measurement </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5036684f11eb837835390659f9e0c4a9" name="a5036684f11eb837835390659f9e0c4a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5036684f11eb837835390659f9e0c4a9">◆ </a></span>program_mode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void program_mode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>number_of_bytes</em>, </span></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>byte_array</em>[]</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>CV Programming mode function Used on entering programming mode in order to write CV values to persistent flash memory or verify/read bits/bytes from flash. <br />
|
|
Refers to NMRA Standard 9.2.3 ("Service Mode Programming") or RCN-216<br />
|
|
</p>
|
|
<p>Procedure:</p><ol type="1">
|
|
<li>Checks for valid programming command</li>
|
|
<li>Disables core1 timers</li>
|
|
<li>Resets core1</li>
|
|
<li>Saves interrupts</li>
|
|
<li>Evaluates the type of programming instruction Write byte / Verify byte / Verify bit and runs corresponding function</li>
|
|
<li>Restores interrupts</li>
|
|
<li>Launch core1</li>
|
|
</ol>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">number_of_bytes</td><td>Number of bytes in byte_array[] </td></tr>
|
|
<tr><td class="paramname">byte_array</td><td>Pointer to byte_array[] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a3cb7d222f559f6157b67e5b778b3752d" name="a3cb7d222f559f6157b67e5b778b3752d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3cb7d222f559f6157b67e5b778b3752d">◆ </a></span>clr_bit_arr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint32_t clr_bit_arr[6]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
|
|
<div class="line"> 0b11111111111111111111111111100000, </div>
|
|
<div class="line"> 0b11111111111111111111111000011111, </div>
|
|
<div class="line"> 0b11111111111111111110000111111111, </div>
|
|
<div class="line"> 0b11111111111000000001111111111111, </div>
|
|
<div class="line"> 0b11100000000111111111111111111111, </div>
|
|
<div class="line"> 0b00011111111111111111111111111111, </div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</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.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|