William/Senior-Design-Project_WMU-Sunseeker_Altium-Designer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation for boost

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

37
Generated Documentation/html/comp__b_8c_source.html
View File

@@ -110,7 +110,7 @@ $(document).ready(function(){initNavTree('comp__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">bool</span> Comp_B_init(uint16_t baseAddress, Comp_B_initParam *param)</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keywordtype">bool</span> Comp_B_init(uint16_t baseAddress, Comp_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="keywordtype">bool</span> retVal = <a class="code" href="hw__memmap_8h.html#ae56fdb340b23940f7a64ed2e37c1774a">STATUS_SUCCESS</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
@@ -125,12 +125,12 @@ $(document).ready(function(){initNavTree('comp__b_8c_source.html',''); initResiz
<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_CBCTL2) &amp;= ~(CBRS_3 | CBREFL_3);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">//Set the Positive Terminal</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">if</span>(COMP_B_VREF != param-&gt;positiveTerminalInput) {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">if</span>(COMP_B_VREF != <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;positiveTerminalInput) {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">//Enable Positive Terminal Input Mux and Set it to the appropriate input</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL0) |= CBIPEN + param-&gt;positiveTerminalInput;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL0) |= CBIPEN + <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;positiveTerminalInput;</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; <span class="comment">//Disable the input buffer</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL3) |= (1 &lt;&lt; param-&gt;positiveTerminalInput);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL3) |= (1 &lt;&lt; <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;positiveTerminalInput);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">//Reset and Set COMPB Control 2 Register</span></div>
@@ -139,12 +139,12 @@ $(document).ready(function(){initNavTree('comp__b_8c_source.html',''); initResiz
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</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; <span class="comment">//Set the Negative Terminal</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">if</span> (COMP_B_VREF != param-&gt;negativeTerminalInput) {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">if</span> (COMP_B_VREF != <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;negativeTerminalInput) {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">//Enable Negative Terminal Input Mux and Set it to the appropriate input</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL0) |= CBIMEN + (param-&gt;negativeTerminalInput &lt;&lt; 8);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL0) |= CBIMEN + (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;negativeTerminalInput &lt;&lt; 8);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">//Disable the input buffer</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL3) |= (1 &lt;&lt; param-&gt;negativeTerminalInput);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL3) |= (1 &lt;&lt; <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;negativeTerminalInput);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">//Reset and Set COMPB Control 2 Register</span></div>
@@ -154,15 +154,15 @@ $(document).ready(function(){initNavTree('comp__b_8c_source.html',''); initResiz
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">//Reset and Set COMPB Control 1 Register</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL1) =</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; param-&gt;powerModeSelect <span class="comment">//Set the power mode</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; + param-&gt;outputFilterEnableAndDelayLevel <span class="comment">//Set the filter enable bit and delay</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; + param-&gt;invertedOutputPolarity; <span class="comment">//Set the polarity of the output</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;powerModeSelect <span class="comment">//Set the power mode</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; + <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;outputFilterEnableAndDelayLevel <span class="comment">//Set the filter enable bit and delay</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; + <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;invertedOutputPolarity; <span class="comment">//Set the polarity of the output</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">return</span> (retVal);</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; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keywordtype">void</span> Comp_B_configureReferenceVoltage(uint16_t baseAddress,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; Comp_B_configureReferenceVoltageParam *param)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; Comp_B_configureReferenceVoltageParam *<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="l00074"></a><span class="lineno"> 74</span>&#160;{</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">//Set to VREF0</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL1) &amp;= ~(CBMRVS);</div>
@@ -171,10 +171,10 @@ $(document).ready(function(){initNavTree('comp__b_8c_source.html',''); initResiz
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL2) &amp;= CBRSEL;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">//Set Voltage Source (Vcc | Vref, resistor ladder or not)</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">if</span> (COMP_B_VREFBASE_VCC == param-&gt;supplyVoltageReferenceBase) {</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">if</span> (COMP_B_VREFBASE_VCC == <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;supplyVoltageReferenceBase) {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL2) |= CBRS_1; <span class="comment">//Vcc with resistor ladder</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (param-&gt;lowerLimitSupplyVoltageFractionOf32 == 32) {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;lowerLimitSupplyVoltageFractionOf32 == 32) {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="comment">//If the lower limit is 32, then the upper limit has to be 32 due to the</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">//assertion that upper must be &gt;= to the lower limit. If the numerator is</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="comment">//equal to 32, then the equation would be 32/32 == 1, therefore no resistor</span></div>
@@ -187,12 +187,12 @@ $(document).ready(function(){initNavTree('comp__b_8c_source.html',''); initResiz
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">//Set COMPD Control 2 Register</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL2) |=</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; param-&gt;supplyVoltageReferenceBase <span class="comment">//Set Supply Voltage Base</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; + ((param-&gt;upperLimitSupplyVoltageFractionOf32 - 1) &lt;&lt; 8) <span class="comment">//Set Supply Voltage Num.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; + (param-&gt;lowerLimitSupplyVoltageFractionOf32 - 1);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;supplyVoltageReferenceBase <span class="comment">//Set Supply Voltage Base</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; + ((<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;upperLimitSupplyVoltageFractionOf32 - 1) &lt;&lt; 8) <span class="comment">//Set Supply Voltage Num.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; + (<a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;lowerLimitSupplyVoltageFractionOf32 - 1);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL2) &amp;= ~(CBREFACC);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL2) |= param-&gt;referenceAccuracy;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="hw__memmap_8h.html#a7bb830016238e9f911612eddc5e58143">HWREG16</a>(baseAddress + OFS_CBCTL2) |= <a class="code" href="_m_s_p430_f_r57xx_2mpu_2mpu__ex3__system_pre_init_8c.html#a95ea9afb900e6437e2aa85f3578289b7">param</a>-&gt;referenceAccuracy;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;}</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="keywordtype">void</span> Comp_B_enableInterrupt(uint16_t baseAddress,</div>
@@ -298,6 +298,7 @@ $(document).ready(function(){initNavTree('comp__b_8c_source.html',''); initResiz
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="comment"></span><span class="comment">//</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</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="acomp__b_8h_html"><div class="ttname"><a href="comp__b_8h.html">comp_b.h</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_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>
@@ -308,7 +309,7 @@ $(document).ready(function(){initNavTree('comp__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="comp__b_8c.html">comp_b.c</a></li>
<li class="footer">Generated on Mon Feb 22 2021 20:33:17 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>