gnuk/ChibiOS_2.0.8/docs/html/struct_p_w_m_config.html

181 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: PWMConfig 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>PWMConfig 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="PWMConfig" -->
2010-08-10 03:11:02 +00:00
<p>Driver configuration structure.
<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 PWMConfig:</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_config__coll__graph.png" border="0" usemap="#_p_w_m_config_coll__map" alt="Collaboration graph"/></div>
<map name="_p_w_m_config_coll__map" id="_p_w_m_config_coll__map">
2010-11-22 05:53:37 +00:00
<area shape="rect" id="node2" href="struct_p_w_m_channel_config.html" title="PWM driver channel configuration structure." alt="" coords="5,6,120,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-11-30 04:54:43 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_w_m.html#ga77de6597901387b5b6ecb58613b09b56">pwmcallback_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_config.html#a5543b74e75ec8598f0bc5878fdcfacf2">pc_callback</a></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Periodic callback pointer. <a href="#a5543b74e75ec8598f0bc5878fdcfacf2"></a><br/></td></tr>
2010-11-30 04:54:43 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_p_w_m_channel_config.html">PWMChannelConfig</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_config.html#aede2520d01a1a34146ab2356c764cbf2">pc_channels</a> [PWM_CHANNELS]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channels configurations. <a href="#aede2520d01a1a34146ab2356c764cbf2"></a><br/></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><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="struct_p_w_m_config.html#ac393e708ea08dc7d5c9714be8fef35db">pc_psc</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TIM PSC (pre-scaler) register initialization data. <a href="#ac393e708ea08dc7d5c9714be8fef35db"></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#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_config.html#a883f1938e1e6af6759a7a7e9f459a8ca">pc_arr</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TIM ARR (auto-reload) register initialization data. <a href="#a883f1938e1e6af6759a7a7e9f459a8ca"></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#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_w_m_config.html#ad505b6cbea937cc878584f50875437d7">pc_cr2</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TIM CR2 register initialization data. <a href="#ad505b6cbea937cc878584f50875437d7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Driver configuration structure. </p>
<p>PWM driver configuration structure.</p>
2010-11-30 04:54:43 +00:00
<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#l00109">109</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="a5543b74e75ec8598f0bc5878fdcfacf2"></a><!-- doxytag: member="PWMConfig::pc_callback" ref="a5543b74e75ec8598f0bc5878fdcfacf2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2010-11-30 04:54:43 +00:00
<td class="memname"><a class="el" href="group___p_w_m.html#ga77de6597901387b5b6ecb58613b09b56">pwmcallback_t</a> <a class="el" href="struct_p_w_m_config.html#a5543b74e75ec8598f0bc5878fdcfacf2">PWMConfig::pc_callback</a></td>
2010-08-10 03:11:02 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Periodic callback pointer. </p>
2010-11-30 04:54:43 +00:00
<dl class="note"><dt><b>Note:</b></dt><dd>This callback is invoked on PWM counter reset. If set to <code>NULL</code> then the callback is disabled. </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#l00115">115</a> of file <a class="el" href="templates_2pwm__lld_8h_source.html">templates/pwm_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___p_w_m.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
2010-11-30 04:54:43 +00:00
<a class="anchor" id="aede2520d01a1a34146ab2356c764cbf2"></a><!-- doxytag: member="PWMConfig::pc_channels" ref="aede2520d01a1a34146ab2356c764cbf2" args="[PWM_CHANNELS]" -->
2010-08-10 03:11:02 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2010-11-30 04:54:43 +00:00
<td class="memname"><a class="el" href="struct_p_w_m_channel_config.html">PWMChannelConfig</a> <a class="el" href="struct_p_w_m_config.html#aede2520d01a1a34146ab2356c764cbf2">PWMConfig::pc_channels</a></td>
2010-08-10 03:11:02 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Channels configurations. </p>
2010-11-30 04:54:43 +00:00
<p>Definition at line <a class="el" href="templates_2pwm__lld_8h_source.html#l00119">119</a> of file <a class="el" href="templates_2pwm__lld_8h_source.html">templates/pwm_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___p_w_m.html#ga8c6320208680a823925d2816856437cc">pwm_lld_enable_channel()</a>, and <a class="el" href="group___p_w_m.html#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
<a class="anchor" id="ac393e708ea08dc7d5c9714be8fef35db"></a><!-- doxytag: member="PWMConfig::pc_psc" ref="ac393e708ea08dc7d5c9714be8fef35db" 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#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> <a class="el" href="struct_p_w_m_config.html#ac393e708ea08dc7d5c9714be8fef35db">PWMConfig::pc_psc</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TIM PSC (pre-scaler) register initialization data. </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#l00184">184</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#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
<a class="anchor" id="a883f1938e1e6af6759a7a7e9f459a8ca"></a><!-- doxytag: member="PWMConfig::pc_arr" ref="a883f1938e1e6af6759a7a7e9f459a8ca" 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#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> <a class="el" href="struct_p_w_m_config.html#a883f1938e1e6af6759a7a7e9f459a8ca">PWMConfig::pc_arr</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TIM ARR (auto-reload) register initialization data. </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#l00188">188</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#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</a>.</p>
2010-08-10 03:11:02 +00:00
</div>
</div>
<a class="anchor" id="ad505b6cbea937cc878584f50875437d7"></a><!-- doxytag: member="PWMConfig::pc_cr2" ref="ad505b6cbea937cc878584f50875437d7" 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#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> <a class="el" href="struct_p_w_m_config.html#ad505b6cbea937cc878584f50875437d7">PWMConfig::pc_cr2</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TIM CR2 register initialization data. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The value of this field should normally be equal to zero. </dd></dl>
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#l00193">193</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#ga8a4d803d25a5326b48b3713ffd5fce53">pwm_lld_start()</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>