gnuk/ChibiOS_2.0.8/docs/html/templates_2pwm__lld_8h.html

103 lines
11 KiB
HTML
Raw Normal View History

2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ChibiOS/RT: pwm_lld.h File Reference</title>
<link href="custom.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table style="text-align: center; width: 100%;" border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
<td style="width: 80px;"></td>
</tr>
</tbody>
</table>
<hr size="1">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>pwm_lld.h File Reference</h1> </div>
</div>
2010-08-10 03:11:02 +00:00
<div class="contents">
2010-11-22 05:53:37 +00:00
2010-08-10 03:11:02 +00:00
<p>PWM Driver subsystem low level driver header template.
<a href="#_details">More...</a></p>
<p><a href="templates_2pwm__lld_8h_source.html">Go to the source code of this file.</a></p>
2010-11-22 05:53:37 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
2010-11-30 04:54:43 +00:00
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_channel_config.html">PWMChannelConfig</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PWM driver channel configuration structure. <a href="struct_p_w_m_channel_config.html#_details">More...</a><br/></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_config.html">PWMConfig</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Driver configuration structure. <a href="struct_p_w_m_config.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_driver.html">PWMDriver</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Structure representing an PWM driver. <a href="struct_p_w_m_driver.html#_details">More...</a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga312588cf680d50931666643dea45bb13">PWM_CHANNELS</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of PWM channels per PWM driver. <a href="group___p_w_m___l_l_d.html#ga312588cf680d50931666643dea45bb13"></a><br/></td></tr>
2010-11-30 04:54:43 +00:00
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#gaaefdcc19e16b2b3d8fad6fbe338e4b02">PWM_FRACTION_TO_WIDTH</a>(pwmp, numerator, denominator)&nbsp;&nbsp;&nbsp;0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts from fraction to pulse width. <a href="group___p_w_m___l_l_d.html#gaaefdcc19e16b2b3d8fad6fbe338e4b02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga650e63fde12b02b59a459dbfe7427334">PWM_DEGREES_TO_WIDTH</a>(pwmp, degrees)&nbsp;&nbsp;&nbsp;PWM_FRACTION_TO_WIDTH(pwmp, 36000, degrees)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts from degrees to pulse width. <a href="group___p_w_m___l_l_d.html#ga650e63fde12b02b59a459dbfe7427334"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga4e74ac1c2befb11ff66d218ca8d49531">PWM_PERCENTAGE_TO_WIDTH</a>(pwmp, percentage)&nbsp;&nbsp;&nbsp;PWM_FRACTION_TO_WIDTH(pwmp, 10000, percentage)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts from percentage to pulse width. <a href="group___p_w_m___l_l_d.html#ga4e74ac1c2befb11ff66d218ca8d49531"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5">pwmchannel_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PWM channel type. <a href="group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group___s_t_m8___c_o_r_e.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#gaef1826611f5a65369e9e02d04e81ed61">pwmcnt_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PWM counter type. <a href="group___p_w_m___l_l_d.html#gaef1826611f5a65369e9e02d04e81ed61"></a><br/></td></tr>
2010-11-30 04:54:43 +00:00
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_p_w_m_driver.html">PWMDriver</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#gaa3b607ac7aca4dc59345f779667c74e1">PWMDriver</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of a structure representing an PWM driver. <a href="group___p_w_m___l_l_d.html#gaa3b607ac7aca4dc59345f779667c74e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga77de6597901387b5b6ecb58613b09b56">pwmcallback_t</a> )(<a class="el" href="struct_p_w_m_driver.html">PWMDriver</a> *pwmp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PWM notification callback type. <a href="group___p_w_m___l_l_d.html#ga77de6597901387b5b6ecb58613b09b56"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga7cb5729a65c0996584808e4f93b28a0d">pwm_lld_init</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Low level PWM driver initialization. <a href="group___p_w_m___l_l_d.html#ga7cb5729a65c0996584808e4f93b28a0d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start</a> (<a class="el" href="struct_p_w_m_driver.html">PWMDriver</a> *pwmp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configures and activates the PWM peripheral. <a href="group___p_w_m___l_l_d.html#ga8a4d803d25a5326b48b3713ffd5fce53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga48b759363af69a6aaee37a362ed5bfd2">pwm_lld_stop</a> (<a class="el" href="struct_p_w_m_driver.html">PWMDriver</a> *pwmp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deactivates the PWM peripheral. <a href="group___p_w_m___l_l_d.html#ga48b759363af69a6aaee37a362ed5bfd2"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga4249803bf9606fa509379004dbd291bb">pwm_lld_is_enabled</a> (<a class="el" href="struct_p_w_m_driver.html">PWMDriver</a> *pwmp, <a class="el" href="group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5">pwmchannel_t</a> channel)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines whatever the PWM channel is already enabled. <a href="group___p_w_m___l_l_d.html#ga4249803bf9606fa509379004dbd291bb"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga8c6320208680a823925d2816856437cc">pwm_lld_enable_channel</a> (<a class="el" href="struct_p_w_m_driver.html">PWMDriver</a> *pwmp, <a class="el" href="group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5">pwmchannel_t</a> channel, <a class="el" href="group___p_w_m___l_l_d.html#gaef1826611f5a65369e9e02d04e81ed61">pwmcnt_t</a> width)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables a PWM channel. <a href="group___p_w_m___l_l_d.html#ga8c6320208680a823925d2816856437cc"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_w_m___l_l_d.html#ga78cb61d7ea9fc996e3c2adec3f37cfd8">pwm_lld_disable_channel</a> (<a class="el" href="struct_p_w_m_driver.html">PWMDriver</a> *pwmp, <a class="el" href="group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5">pwmchannel_t</a> channel)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disables a PWM channel. <a href="group___p_w_m___l_l_d.html#ga78cb61d7ea9fc996e3c2adec3f37cfd8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>PWM Driver subsystem low level driver header template. </p>
<p>Definition in file <a class="el" href="templates_2pwm__lld_8h_source.html">templates/pwm_lld.h</a>.</p>
</div>
<hr size="1"><address style="text-align: right;"><small>
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:50 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
2010-08-10 03:11:02 +00:00
</body>
</html>