Files
TweinStein/Documentation/html/group___p_w_m_a0.html

377 lines
18 KiB
HTML
Raw Permalink Normal View History

2026-06-12 02:55:04 -07:00
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RTOS_MSPM0: PWMA0</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>
<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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="RobotSensors.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">RTOS_MSPM0
&#160;<span id="projectnumber">1.1</span>
</div>
<div id="projectbrief">ECE445M starter code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#files">Files</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">PWMA0</div> </div>
</div><!--header-->
<div class="contents">
<p>Pulse width modulation.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:_p_w_m_a0_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_p_w_m_a0_8h.html">PWMA0.h</a></td></tr>
<tr class="memdesc:_p_w_m_a0_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pulse width modulation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga7497b42df7df560ce90e9b40508a5036"><td class="memItemLeft" align="right" valign="top"><a id="ga7497b42df7df560ce90e9b40508a5036"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#ga7497b42df7df560ce90e9b40508a5036">PWMUSELFCLK</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:ga7497b42df7df560ce90e9b40508a5036"><td class="mdescLeft">&#160;</td><td class="mdescRight">use PWMUSELFCLK to select LFCLK <br /></td></tr>
<tr class="separator:ga7497b42df7df560ce90e9b40508a5036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5bc0918f95e19ab8f7c11d2b850331d8"><td class="memItemLeft" align="right" valign="top"><a id="ga5bc0918f95e19ab8f7c11d2b850331d8"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#ga5bc0918f95e19ab8f7c11d2b850331d8">PWMUSEMFCLK</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:ga5bc0918f95e19ab8f7c11d2b850331d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">use PWMUSEMFCLK to select MFCLK <br /></td></tr>
<tr class="separator:ga5bc0918f95e19ab8f7c11d2b850331d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a97982467a525ef6074c48f5841efdd"><td class="memItemLeft" align="right" valign="top"><a id="ga5a97982467a525ef6074c48f5841efdd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#ga5a97982467a525ef6074c48f5841efdd">PWMUSEBUSCLK</a>&#160;&#160;&#160;8</td></tr>
<tr class="memdesc:ga5a97982467a525ef6074c48f5841efdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">use PWMUSEBUSCLK to select bus CLK <br /></td></tr>
<tr class="separator:ga5a97982467a525ef6074c48f5841efdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadbe2bda0c1f3d3088d485411358314bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#gadbe2bda0c1f3d3088d485411358314bc">PWMA0_Init</a> (uint32_t timerClkSrc, uint32_t timerClkPrescale, uint32_t period, uint32_t duty0, uint32_t duty1)</td></tr>
<tr class="memdesc:gadbe2bda0c1f3d3088d485411358314bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize PWMA0. <a href="group___p_w_m_a0.html#gadbe2bda0c1f3d3088d485411358314bc">More...</a><br /></td></tr>
<tr class="separator:gadbe2bda0c1f3d3088d485411358314bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga328ebf693fe2ed39f1796f73be153499"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#ga328ebf693fe2ed39f1796f73be153499">PWMA0_SetDuty</a> (uint32_t duty0, uint32_t duty1)</td></tr>
<tr class="memdesc:ga328ebf693fe2ed39f1796f73be153499"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set duty cycles. <a href="group___p_w_m_a0.html#ga328ebf693fe2ed39f1796f73be153499">More...</a><br /></td></tr>
<tr class="separator:ga328ebf693fe2ed39f1796f73be153499"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa30201d0dbd0bfb46e0f1c0eaccd947a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#gaa30201d0dbd0bfb46e0f1c0eaccd947a">PWMA0_Forward</a> (uint32_t duty0)</td></tr>
<tr class="memdesc:gaa30201d0dbd0bfb46e0f1c0eaccd947a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Motor forward. <a href="group___p_w_m_a0.html#gaa30201d0dbd0bfb46e0f1c0eaccd947a">More...</a><br /></td></tr>
<tr class="separator:gaa30201d0dbd0bfb46e0f1c0eaccd947a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d497017d72d7c7afc0a08750cff9095"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#ga9d497017d72d7c7afc0a08750cff9095">PWMA0_Backward</a> (uint32_t duty1)</td></tr>
<tr class="memdesc:ga9d497017d72d7c7afc0a08750cff9095"><td class="mdescLeft">&#160;</td><td class="mdescRight">Motor backward. <a href="group___p_w_m_a0.html#ga9d497017d72d7c7afc0a08750cff9095">More...</a><br /></td></tr>
<tr class="separator:ga9d497017d72d7c7afc0a08750cff9095"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga03d9522aca0fdc602a51139894915121"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#ga03d9522aca0fdc602a51139894915121">PWMA0_Break</a> (void)</td></tr>
<tr class="memdesc:ga03d9522aca0fdc602a51139894915121"><td class="mdescLeft">&#160;</td><td class="mdescRight">Motor break. <a href="group___p_w_m_a0.html#ga03d9522aca0fdc602a51139894915121">More...</a><br /></td></tr>
<tr class="separator:ga03d9522aca0fdc602a51139894915121"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadaed68c7fefab9f58467fda5fee31436"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m_a0.html#gadaed68c7fefab9f58467fda5fee31436">PWMA0_Coast</a> (void)</td></tr>
<tr class="memdesc:gadaed68c7fefab9f58467fda5fee31436"><td class="mdescLeft">&#160;</td><td class="mdescRight">Motor coast. <a href="group___p_w_m_a0.html#gadaed68c7fefab9f58467fda5fee31436">More...</a><br /></td></tr>
<tr class="separator:gadaed68c7fefab9f58467fda5fee31436"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Pulse width modulation. </p>
<a class="anchor" id="PWMA0pins2"></a>
<table class="doxtable">
<caption>PWM pins on the MSPM0G3507</caption>
<tr>
<th>Pin </th><th>Description </th></tr>
<tr>
<td>PB8 </td><td>CCP0 PWM output </td></tr>
<tr>
<td>PB9 </td><td>CCP1 PWM output </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9d497017d72d7c7afc0a08750cff9095"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d497017d72d7c7afc0a08750cff9095">&#9670;&nbsp;</a></span>PWMA0_Backward()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PWMA0_Backward </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duty1</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Motor backward. </p>
<p>Set duty cycle on PB9, and set PB8 high. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duty1</td><td>sets the duty cycle on PB9 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section note"><dt>Note</dt><dd>assumes PWMA0_Init was called </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_w_m_a0.html#gadbe2bda0c1f3d3088d485411358314bc" title="Initialize PWMA0.">PWMA0_Init</a> </dd></dl>
</div>
</div>
<a id="ga03d9522aca0fdc602a51139894915121"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03d9522aca0fdc602a51139894915121">&#9670;&nbsp;</a></span>PWMA0_Break()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PWMA0_Break </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Motor break. </p>
<p>Set PB8 high, and set PB9 high. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">none</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section note"><dt>Note</dt><dd>assumes PWMA0_Init was called </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_w_m_a0.html#gadbe2bda0c1f3d3088d485411358314bc" title="Initialize PWMA0.">PWMA0_Init</a> </dd></dl>
</div>
</div>
<a id="gadaed68c7fefab9f58467fda5fee31436"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadaed68c7fefab9f58467fda5fee31436">&#9670;&nbsp;</a></span>PWMA0_Coast()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PWMA0_Coast </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Motor coast. </p>
<p>Set PB8 low, and set PB9 low. Goes into sleep mode </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">none</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section note"><dt>Note</dt><dd>assumes PWMA0_Init was called </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_w_m_a0.html#gadbe2bda0c1f3d3088d485411358314bc" title="Initialize PWMA0.">PWMA0_Init</a> </dd></dl>
</div>
</div>
<a id="gaa30201d0dbd0bfb46e0f1c0eaccd947a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa30201d0dbd0bfb46e0f1c0eaccd947a">&#9670;&nbsp;</a></span>PWMA0_Forward()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PWMA0_Forward </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duty0</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Motor forward. </p>
<p>Set duty cycle on PB8, and set PB9 high. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duty0</td><td>sets the duty cycle on PB8 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section note"><dt>Note</dt><dd>assumes PWMA0_Init was called </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_w_m_a0.html#gadbe2bda0c1f3d3088d485411358314bc" title="Initialize PWMA0.">PWMA0_Init</a> </dd></dl>
</div>
</div>
<a id="gadbe2bda0c1f3d3088d485411358314bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadbe2bda0c1f3d3088d485411358314bc">&#9670;&nbsp;</a></span>PWMA0_Init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PWMA0_Init </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timerClkSrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timerClkPrescale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>period</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duty0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duty1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize PWMA0. </p>
<p>Initialize PWMA0 outputs on PB8, PB9. Rising edge synchronized. timerClkDivRatio = 1. Once started, hardware will continuously output the waves.</p><ul>
<li>timerClkSrc =<ul>
<li>2 for 32768 Hz LFCLK</li>
<li>4 for 4MHz MFCLK (not tested)</li>
<li>8 for 80/32/4 BUSCLK</li>
</ul>
</li>
<li>G0/G8 is on Power domain PD0<ul>
<li>32MHz bus clock, BUSCLK clock is 32MHz</li>
<li>40MHz bus clock, BUSCLK clock is ULPCLK 20MHz</li>
<li>80MHz bus clock, BUSCLK clock is ULPCLK 40MHz</li>
</ul>
</li>
<li>PWMFreq = (timerClkSrc / (timerClkDivRatio * (timerClkPrescale + 1) * period))<ul>
<li>For example, source=LFCLK, prescale = 0, period = 1000, PWM frequency = 32.768 Hz</li>
<li>For example, source=BUSCLK, bus=40MHz, prescale=19, period = 10000, PWM frequency = 10kHz</li>
</ul>
</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timerClkSrc</td><td>is 2 4 or 8 </td></tr>
<tr><td class="paramname">timerClkPrescale</td><td>divide clock by timerClkPrescale+1, 0 to 255 </td></tr>
<tr><td class="paramname">period</td><td>sets the PWMA0 period </td></tr>
<tr><td class="paramname">duty0</td><td>sets the duty cycle on PB8 </td></tr>
<tr><td class="paramname">duty1</td><td>sets the duty cycle on PB9 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Will call LaunchPad_Init to reset and activate power </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_w_m_a0.html#ga328ebf693fe2ed39f1796f73be153499" title="Set duty cycles.">PWMA0_SetDuty</a> </dd></dl>
</div>
</div>
<a id="ga328ebf693fe2ed39f1796f73be153499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga328ebf693fe2ed39f1796f73be153499">&#9670;&nbsp;</a></span>PWMA0_SetDuty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PWMA0_SetDuty </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duty0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>duty1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set duty cycles. </p>
<p>Set duty cycles on PB8, PB9. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duty0</td><td>sets the duty cycle on PB8 </td></tr>
<tr><td class="paramname">duty1</td><td>sets the duty cycle on PB9 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section note"><dt>Note</dt><dd>assumes PWMA0_Init was called </dd></dl>
<dl class="section see"><dt>See also</dt><dd>PWM_Init </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.9.1
</small></address>
</body>
</html>