Added documentation for boost

This commit is contained in:
Stephen
2021-04-06 20:46:33 -04:00
parent 66dd4f80ea
commit 8a613ad2a9
2594 changed files with 248861 additions and 1726 deletions

View File

@@ -110,7 +110,7 @@ $(document).ready(function(){initNavTree('sd24__b_8c_source.html',''); initResiz
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;assert.h&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keywordtype">void</span> SD24_B_init(uint16_t baseAddress, SD24_B_initParam *param)</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keywordtype">void</span> SD24_B_init(uint16_t baseAddress, SD24_B_initParam *<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>)</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// Reset all interrupts and flags</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_SD24BIE) &amp;= 0x0000; <span class="comment">//Reset ALL interrupt enables</span></div>
@@ -124,52 +124,52 @@ $(document).ready(function(){initNavTree('sd24__b_8c_source.html',''); initResiz
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// Configure SD24_B</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_SD24BCTL0) &amp;= ~((SD24DIV4 | SD24DIV3 | SD24DIV2</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; | SD24DIV1 | SD24DIV0) | SD24PDIV_7 | SD24SSEL_3 | SD24REFS);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_SD24BCTL0) |= (param-&gt;clockSourceSelect |</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; param-&gt;clockPreDivider | param-&gt;clockDivider | param-&gt;referenceSelect);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_SD24BCTL0) |= (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;clockSourceSelect |</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;clockPreDivider | <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;clockDivider | <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;referenceSelect);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;}</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keywordtype">void</span> SD24_B_initConverter(uint16_t baseAddress,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; SD24_B_initConverterParam *param)</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; SD24_B_initConverterParam *<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>)</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; uint16_t address = baseAddress + (OFS_SD24BCCTL0 + (param-&gt;converter * 0x08));</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; uint16_t address = baseAddress + (OFS_SD24BCCTL0 + (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;converter * 0x08));</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// Clearing previous settings for configuration</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) &amp;= ~(SD24ALGN | SD24SNGL | SD24SCS__GROUP3);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= (param-&gt;alignment | param-&gt;startSelect |</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; (((uint16_t) param-&gt;conversionMode) &lt;&lt; 8));</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;alignment | <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;startSelect |</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; (((uint16_t) <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;conversionMode) &lt;&lt; 8));</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keywordtype">void</span> SD24_B_initConverterAdvanced(uint16_t baseAddress,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; SD24_B_initConverterAdvancedParam *param)</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; SD24_B_initConverterAdvancedParam *<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>)</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Getting correct SD24BCCTLx register</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint16_t address = baseAddress + (OFS_SD24BCCTL0 + (param-&gt;converter * 0x08));</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint16_t address = baseAddress + (OFS_SD24BCCTL0 + (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;converter * 0x08));</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// Clearing previous settings for configuration</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) &amp;= ~(SD24ALGN | SD24SNGL | SD24DF1 | SD24DF0 | SD24SCS__GROUP3 );</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= (param-&gt;alignment | param-&gt;startSelect | param-&gt;dataFormat |</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; (((uint16_t) param-&gt;conversionMode) &lt;&lt; 8));</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;alignment | <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;startSelect | <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;dataFormat |</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; (((uint16_t) <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;conversionMode) &lt;&lt; 8));</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// Getting correct SDBINTCTLx register</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; address = baseAddress + (OFS_SD24BINCTL0 + (param-&gt;converter * 0x08));</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; address = baseAddress + (OFS_SD24BINCTL0 + (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;converter * 0x08));</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">// Clearing previous settings for configuration</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) &amp;= ~(SD24GAIN_128 | SD24INTDLY_3);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= (param-&gt;gain | param-&gt;sampleDelay);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;gain | <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;sampleDelay);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">// Getting correct SDBOSRx register</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; address = baseAddress + (OFS_SD24BOSR0 + (param-&gt;converter * 0x08));</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; address = baseAddress + (OFS_SD24BOSR0 + (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;converter * 0x08));</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">// Clearing previous settings for configuration</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) &amp;= ~(OSR10 | OSR9 | OSR8 | OSR7 | OSR6 | OSR5 | OSR4 |</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; OSR3 | OSR2 | OSR1 | OSR0);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= param-&gt;oversampleRatio;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(address) |= <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;oversampleRatio;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="keywordtype">void</span> SD24_B_setConverterDataFormat(uint16_t baseAddress,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; uint8_t converter,</div>
@@ -358,6 +358,7 @@ $(document).ready(function(){initNavTree('sd24__b_8c_source.html',''); initResiz
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;<span class="comment"></span><span class="comment">//</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;<span class="comment">//*****************************************************************************</span></div>
<div class="ttc" id="a_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c_html_a95ea9afb900e6437e2aa85f3578289b7"><div class="ttname"><a href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a></div><div class="ttdeci">MPU_initThreeSegmentsParam param</div><div class="ttdef"><b>Definition:</b> <a href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c_source.html#l00075">mpu_ex3_systemPreInit.c:75</a></div></div>
<div class="ttc" id="ahw__memmap_8h_html"><div class="ttname"><a href="hw__memmap_8h.html">hw_memmap.h</a></div></div>
<div class="ttc" id="ahw__memmap_8h_html_a437bba8c6aaa7542f8d7522146157b42"><div class="ttname"><a href="hw__memmap_8h.html#a437bba8c6aaa7542f8d7522146157b42">HWREG8</a></div><div class="ttdeci">#define HWREG8(x)</div><div class="ttdef"><b>Definition:</b> <a href="hw__memmap_8h_source.html#l00041">hw_memmap.h:41</a></div></div>
<div class="ttc" id="ahw__memmap_8h_html_a7bb830016238e9f911612eddc5e58143"><div class="ttname"><a href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a></div><div class="ttdeci">#define HWREG16(x)</div><div class="ttdef"><b>Definition:</b> <a href="hw__memmap_8h_source.html#l00039">hw_memmap.h:39</a></div></div>
@@ -368,7 +369,7 @@ $(document).ready(function(){initNavTree('sd24__b_8c_source.html',''); initResiz
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4e9c05acfa2c3671b8618fcb95d57d96.html">Software</a></li><li class="navelem"><a class="el" href="dir_70428d3c5958c16802133545478a5cfb.html">Code Composer Studio Workspace</a></li><li class="navelem"><a class="el" href="dir_ef94255a62432ae865475b379d8bd501.html">SunseekerTelemetryAndLightingSystem</a></li><li class="navelem"><a class="el" href="dir_0201fb0a75bfb001181cd762468718da.html">Libraries</a></li><li class="navelem"><a class="el" href="dir_c161f571c8319861135bb5a2c903edf9.html">driverlib</a></li><li class="navelem"><a class="el" href="dir_46b95d24c0abe1f4457728e63ee00541.html">MSP430F5xx_6xx</a></li><li class="navelem"><a class="el" href="sd24__b_8c.html">sd24_b.c</a></li>
<li class="footer">Generated on Mon Feb 22 2021 20:33:18 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated on Tue Apr 6 2021 20:40:57 for 2020-2021 Sunseeker Telemetry and Lighting System by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>