gnuk/ChibiOS_2.0.8/docs/html/struct_p_w_m_driver.html

159 lines
10 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: PWMDriver Struct 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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><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="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
2010-08-10 03:11:02 +00:00
<h1>PWMDriver Struct Reference<br/>
<small>
2010-11-30 04:54:43 +00:00
[<a class="el" href="group___p_w_m___l_l_d.html">PWM Low Level Driver</a>,&nbsp;<a class="el" href="group___p_w_m.html">PWM Driver</a>]</small>
2010-11-22 05:53:37 +00:00
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="PWMDriver" -->
2010-08-10 03:11:02 +00:00
<p>Structure representing an PWM driver.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="templates_2pwm__lld_8h_source.html">pwm_lld.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PWMDriver:</div>
2010-11-22 05:53:37 +00:00
<div class="dyncontent">
2010-08-10 03:11:02 +00:00
<div class="center"><img src="struct_p_w_m_driver__coll__graph.png" border="0" usemap="#_p_w_m_driver_coll__map" alt="Collaboration graph"/></div>
<map name="_p_w_m_driver_coll__map" id="_p_w_m_driver_coll__map">
2010-11-22 05:53:37 +00:00
<area shape="rect" id="node2" href="struct_p_w_m_config.html" title="Driver configuration structure." alt="" coords="27,163,120,299"/> <area shape="rect" id="node4" href="struct_p_w_m_channel_config.html" title="PWM driver channel configuration structure." alt="" coords="16,6,131,98"/> </map>
2010-08-10 03:11:02 +00:00
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
2010-11-22 05:53:37 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_w_m.html#ga9b63d6f4d51e8ca9ee1fce2a1bc86bc5">pwmstate_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_driver.html#a773d182992e086ff89dd85d2f5e17dea">pd_state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Driver state. <a href="#a773d182992e086ff89dd85d2f5e17dea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_p_w_m_config.html">PWMConfig</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_driver.html#a45bb852cfb3b30143315632e74703cb8">pd_config</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current configuration data. <a href="#a45bb852cfb3b30143315632e74703cb8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_driver.html#a2301452c1ee3ef218ff2d3cd8305913b">pd_enabled_channels</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Bit mask of the enabled channels. <a href="#a2301452c1ee3ef218ff2d3cd8305913b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TIM_TypeDef *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_driver.html#a166b96927bbe9f85015a7ca390c668a7">pd_tim</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the TIMx registers block. <a href="#a166b96927bbe9f85015a7ca390c668a7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Structure representing an PWM driver. </p>
2010-11-30 04:54:43 +00:00
<p>Structure representing a PWM driver.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Implementations may extend this structure to contain more, architecture dependent, fields. </dd></dl>
2010-08-10 03:11:02 +00:00
2010-11-30 04:54:43 +00:00
<p>Definition at line <a class="el" href="templates_2pwm__lld_8h_source.html#l00128">128</a> of file <a class="el" href="templates_2pwm__lld_8h_source.html">templates/pwm_lld.h</a>.</p>
2010-08-10 03:11:02 +00:00
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a773d182992e086ff89dd85d2f5e17dea"></a><!-- doxytag: member="PWMDriver::pd_state" ref="a773d182992e086ff89dd85d2f5e17dea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_w_m.html#ga9b63d6f4d51e8ca9ee1fce2a1bc86bc5">pwmstate_t</a> <a class="el" href="struct_p_w_m_driver.html#a773d182992e086ff89dd85d2f5e17dea">PWMDriver::pd_state</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Driver state. </p>
2010-11-30 04:54:43 +00:00
<p>Definition at line <a class="el" href="templates_2pwm__lld_8h_source.html#l00132">132</a> of file <a class="el" href="templates_2pwm__lld_8h_source.html">templates/pwm_lld.h</a>.</p>
2010-08-10 03:11:02 +00:00
2010-11-30 04:54:43 +00:00
<p>Referenced by <a class="el" href="group___p_w_m.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>, <a class="el" href="group___p_w_m.html#ga48b759363af69a6aaee37a362ed5bfd2">pwm_lld_stop()</a>, <a class="el" href="group___p_w_m.html#gac2679d11833a4ea9df5a9ed2e4a2c2e7">pwmDisableChannel()</a>, <a class="el" href="group___p_w_m.html#gafd6c45693467da77ab13edca8420620d">pwmEnableChannel()</a>, <a class="el" href="group___p_w_m.html#ga4dbf1fded2984ff6dc240afd2e1fcd74">pwmObjectInit()</a>, <a class="el" href="group___p_w_m.html#ga9c14dc1b026c78809440281786aceda3">pwmStart()</a>, and <a class="el" href="group___p_w_m.html#ga8a4d0d8a47883efe286a332cade14080">pwmStop()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
<a class="anchor" id="a45bb852cfb3b30143315632e74703cb8"></a><!-- doxytag: member="PWMDriver::pd_config" ref="a45bb852cfb3b30143315632e74703cb8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_p_w_m_config.html">PWMConfig</a> * <a class="el" href="struct_p_w_m_driver.html#a45bb852cfb3b30143315632e74703cb8">PWMDriver::pd_config</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current configuration data. </p>
<p>Current driver configuration data. </p>
2010-11-30 04:54:43 +00:00
<p>Definition at line <a class="el" href="templates_2pwm__lld_8h_source.html#l00136">136</a> of file <a class="el" href="templates_2pwm__lld_8h_source.html">templates/pwm_lld.h</a>.</p>
2010-08-10 03:11:02 +00:00
2010-11-30 04:54:43 +00:00
<p>Referenced by <a class="el" href="group___p_w_m.html#ga8c6320208680a823925d2816856437cc">pwm_lld_enable_channel()</a>, <a class="el" href="group___p_w_m.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>, <a class="el" href="group___p_w_m.html#ga4dbf1fded2984ff6dc240afd2e1fcd74">pwmObjectInit()</a>, and <a class="el" href="group___p_w_m.html#ga9c14dc1b026c78809440281786aceda3">pwmStart()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
<a class="anchor" id="a2301452c1ee3ef218ff2d3cd8305913b"></a><!-- doxytag: member="PWMDriver::pd_enabled_channels" ref="a2301452c1ee3ef218ff2d3cd8305913b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="el" href="struct_p_w_m_driver.html#a2301452c1ee3ef218ff2d3cd8305913b">PWMDriver::pd_enabled_channels</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Bit mask of the enabled channels. </p>
2010-11-30 04:54:43 +00:00
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2pwm__lld_8h_source.html#l00215">215</a> of file <a class="el" href="platforms_2_s_t_m32_2pwm__lld_8h_source.html">platforms/STM32/pwm_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___p_w_m.html#ga78cb61d7ea9fc996e3c2adec3f37cfd8">pwm_lld_disable_channel()</a>, <a class="el" href="group___p_w_m.html#ga8c6320208680a823925d2816856437cc">pwm_lld_enable_channel()</a>, <a class="el" href="group___p_w_m.html#ga7cb5729a65c0996584808e4f93b28a0d">pwm_lld_init()</a>, <a class="el" href="group___p_w_m.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>, and <a class="el" href="group___p_w_m.html#ga48b759363af69a6aaee37a362ed5bfd2">pwm_lld_stop()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
<a class="anchor" id="a166b96927bbe9f85015a7ca390c668a7"></a><!-- doxytag: member="PWMDriver::pd_tim" ref="a166b96927bbe9f85015a7ca390c668a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TIM_TypeDef* <a class="el" href="struct_p_w_m_driver.html#a166b96927bbe9f85015a7ca390c668a7">PWMDriver::pd_tim</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the TIMx registers block. </p>
2010-11-30 04:54:43 +00:00
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2pwm__lld_8h_source.html#l00219">219</a> of file <a class="el" href="platforms_2_s_t_m32_2pwm__lld_8h_source.html">platforms/STM32/pwm_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___p_w_m.html#ga78cb61d7ea9fc996e3c2adec3f37cfd8">pwm_lld_disable_channel()</a>, <a class="el" href="group___p_w_m.html#ga8c6320208680a823925d2816856437cc">pwm_lld_enable_channel()</a>, <a class="el" href="group___p_w_m.html#ga7cb5729a65c0996584808e4f93b28a0d">pwm_lld_init()</a>, <a class="el" href="group___p_w_m.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>, and <a class="el" href="group___p_w_m.html#ga48b759363af69a6aaee37a362ed5bfd2">pwm_lld_stop()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
</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:59 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>