Files
discoverpixy/group___t_i_m___group7.html
2015-05-12 11:12:43 +02:00

436 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.9.1"/>
<title>discoverpixy: Synchronization management functions</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Synchronization management functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> &raquo; <a class="el" href="group___t_i_m.html">TIM</a> &raquo; <a class="el" href="group___t_i_m___private___functions.html">TIM_Private_Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Synchronization management functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Synchronization management functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___t_i_m___group7.png" border="0" alt="" usemap="#group______t__i__m______group7"/>
<map name="group______t__i__m______group7" id="group______t__i__m______group7">
<area shape="rect" id="node2" href="group___t_i_m___private___functions.html" title="TIM_Private_Functions" alt="" coords="5,13,159,39"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4252583c6ae8a73d6fc66f7e951dbc35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group7.html#ga4252583c6ae8a73d6fc66f7e951dbc35">TIM_SelectInputTrigger</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, uint16_t TIM_InputTriggerSource)</td></tr>
<tr class="memdesc:ga4252583c6ae8a73d6fc66f7e951dbc35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the Input Trigger source. <a href="#ga4252583c6ae8a73d6fc66f7e951dbc35">More...</a><br /></td></tr>
<tr class="separator:ga4252583c6ae8a73d6fc66f7e951dbc35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28745aaa549e2067e42c19569209e6c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group7.html#ga28745aaa549e2067e42c19569209e6c6">TIM_SelectOutputTrigger</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, uint16_t TIM_TRGOSource)</td></tr>
<tr class="memdesc:ga28745aaa549e2067e42c19569209e6c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the TIMx Trigger Output Mode. <a href="#ga28745aaa549e2067e42c19569209e6c6">More...</a><br /></td></tr>
<tr class="separator:ga28745aaa549e2067e42c19569209e6c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f19ce1d90990691cf037e419ba08003"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group7.html#ga2f19ce1d90990691cf037e419ba08003">TIM_SelectSlaveMode</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, uint16_t TIM_SlaveMode)</td></tr>
<tr class="memdesc:ga2f19ce1d90990691cf037e419ba08003"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the TIMx Slave Mode. <a href="#ga2f19ce1d90990691cf037e419ba08003">More...</a><br /></td></tr>
<tr class="separator:ga2f19ce1d90990691cf037e419ba08003"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4dcc3d11b670c381d0ff9cb7e9fd01e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group7.html#ga4dcc3d11b670c381d0ff9cb7e9fd01e2">TIM_SelectMasterSlaveMode</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, uint16_t TIM_MasterSlaveMode)</td></tr>
<tr class="memdesc:ga4dcc3d11b670c381d0ff9cb7e9fd01e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or Resets the TIMx Master/Slave Mode. <a href="#ga4dcc3d11b670c381d0ff9cb7e9fd01e2">More...</a><br /></td></tr>
<tr class="separator:ga4dcc3d11b670c381d0ff9cb7e9fd01e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8bdde400b7a30f3e747fe8e4962c0abe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group7.html#ga8bdde400b7a30f3e747fe8e4962c0abe">TIM_ETRConfig</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, uint16_t TIM_ExtTRGPrescaler, uint16_t TIM_ExtTRGPolarity, uint16_t ExtTRGFilter)</td></tr>
<tr class="memdesc:ga8bdde400b7a30f3e747fe8e4962c0abe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the TIMx External Trigger (ETR). <a href="#ga8bdde400b7a30f3e747fe8e4962c0abe">More...</a><br /></td></tr>
<tr class="separator:ga8bdde400b7a30f3e747fe8e4962c0abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Synchronization management functions. </p>
<pre class="fragment"> ===============================================================================
##### Synchronization management functions #####
===============================================================================
##### TIM Driver: how to use it in synchronization Mode #####
===============================================================================
[..]
*** Case of two/several Timers ***
==================================
[..]
(#) Configure the Master Timers using the following functions:
(++) void TIM_SelectOutputTrigger(TIM_TypeDef* TIMx, uint16_t TIM_TRGOSource);
(++) void TIM_SelectMasterSlaveMode(TIM_TypeDef* TIMx, uint16_t TIM_MasterSlaveMode);
(#) Configure the Slave Timers using the following functions:
(++) void TIM_SelectInputTrigger(TIM_TypeDef* TIMx, uint16_t TIM_InputTriggerSource);
(++) void TIM_SelectSlaveMode(TIM_TypeDef* TIMx, uint16_t TIM_SlaveMode);
*** Case of Timers and external trigger(ETR pin) ***
====================================================
[..]
(#) Configure the External trigger using this function:
(++) void TIM_ETRConfig(TIM_TypeDef* TIMx, uint16_t TIM_ExtTRGPrescaler, uint16_t TIM_ExtTRGPolarity,
uint16_t ExtTRGFilter);
(#) Configure the Slave Timers using the following functions:
(++) void TIM_SelectInputTrigger(TIM_TypeDef* TIMx, uint16_t TIM_InputTriggerSource);
(++) void TIM_SelectSlaveMode(TIM_TypeDef* TIMx, uint16_t TIM_SlaveMode); </pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8bdde400b7a30f3e747fe8e4962c0abe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_ETRConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *&#160;</td>
<td class="paramname"><em>TIMx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>TIM_ExtTRGPrescaler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>TIM_ExtTRGPolarity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>ExtTRGFilter</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the TIMx External Trigger (ETR). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1, 2, 3, 4, 5 or 8 to select the TIM peripheral. </td></tr>
<tr><td class="paramname">TIM_ExtTRGPrescaler</td><td>The external Trigger Prescaler. This parameter can be one of the following values: <ul>
<li>TIM_ExtTRGPSC_OFF: ETRP Prescaler OFF. </li>
<li>TIM_ExtTRGPSC_DIV2: ETRP frequency divided by 2. </li>
<li>TIM_ExtTRGPSC_DIV4: ETRP frequency divided by 4. </li>
<li>TIM_ExtTRGPSC_DIV8: ETRP frequency divided by 8. </li>
</ul>
</td></tr>
<tr><td class="paramname">TIM_ExtTRGPolarity</td><td>The external Trigger Polarity. This parameter can be one of the following values: <ul>
<li>TIM_ExtTRGPolarity_Inverted: active low or falling edge active. </li>
<li>TIM_ExtTRGPolarity_NonInverted: active high or rising edge active. </li>
</ul>
</td></tr>
<tr><td class="paramname">ExtTRGFilter</td><td>External Trigger Filter. This parameter must be a value between 0x00 and 0x0F </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___t_i_m___group7_ga8bdde400b7a30f3e747fe8e4962c0abe_icgraph.png" border="0" usemap="#group___t_i_m___group7_ga8bdde400b7a30f3e747fe8e4962c0abe_icgraph" alt=""/></div>
<map name="group___t_i_m___group7_ga8bdde400b7a30f3e747fe8e4962c0abe_icgraph" id="group___t_i_m___group7_ga8bdde400b7a30f3e747fe8e4962c0abe_icgraph">
<area shape="rect" id="node2" href="group___t_i_m___group6.html#ga47c05638b93aabcd641dbc8859e1b2df" title="Configures the External clock Mode1. " alt="" coords="164,5,347,32"/><area shape="rect" id="node3" href="group___t_i_m___group6.html#ga0a9cbcbab32326cbbdaf4c111f59ec20" title="Configures the External clock Mode2. " alt="" coords="164,56,347,83"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga4252583c6ae8a73d6fc66f7e951dbc35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_SelectInputTrigger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *&#160;</td>
<td class="paramname"><em>TIMx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>TIM_InputTriggerSource</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selects the Input Trigger source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1, 2, 3, 4, 5, 8, 9, 10, 11, 12, 13 or 14 to select the TIM peripheral. </td></tr>
<tr><td class="paramname">TIM_InputTriggerSource</td><td>The Input Trigger source. This parameter can be one of the following values: <ul>
<li>TIM_TS_ITR0: Internal Trigger 0 </li>
<li>TIM_TS_ITR1: Internal Trigger 1 </li>
<li>TIM_TS_ITR2: Internal Trigger 2 </li>
<li>TIM_TS_ITR3: Internal Trigger 3 </li>
<li>TIM_TS_TI1F_ED: TI1 Edge Detector </li>
<li>TIM_TS_TI1FP1: Filtered Timer Input 1 </li>
<li>TIM_TS_TI2FP2: Filtered Timer Input 2 </li>
<li>TIM_TS_ETRF: External Trigger input </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___t_i_m___group7_ga4252583c6ae8a73d6fc66f7e951dbc35_icgraph.png" border="0" usemap="#group___t_i_m___group7_ga4252583c6ae8a73d6fc66f7e951dbc35_icgraph" alt=""/></div>
<map name="group___t_i_m___group7_ga4252583c6ae8a73d6fc66f7e951dbc35_icgraph" id="group___t_i_m___group7_ga4252583c6ae8a73d6fc66f7e951dbc35_icgraph">
<area shape="rect" id="node2" href="group___t_i_m___group6.html#gabef227d21d9e121e6a4ec5ab6223f5a9" title="Configures the TIMx Internal Trigger as External Clock. " alt="" coords="208,5,401,32"/><area shape="rect" id="node3" href="group___t_i_m___group6.html#gaf460e7d9c9969044e364130e209937fc" title="Configures the TIMx Trigger as External Clock. " alt="" coords="213,56,397,83"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga4dcc3d11b670c381d0ff9cb7e9fd01e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_SelectMasterSlaveMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *&#160;</td>
<td class="paramname"><em>TIMx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>TIM_MasterSlaveMode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets or Resets the TIMx Master/Slave Mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1, 2, 3, 4, 5, 8, 9 or 12 to select the TIM peripheral. </td></tr>
<tr><td class="paramname">TIM_MasterSlaveMode</td><td>specifies the Timer Master Slave Mode. This parameter can be one of the following values: <ul>
<li>TIM_MasterSlaveMode_Enable: synchronization between the current timer and its slaves (through TRGO) </li>
<li>TIM_MasterSlaveMode_Disable: No action </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga28745aaa549e2067e42c19569209e6c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_SelectOutputTrigger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *&#160;</td>
<td class="paramname"><em>TIMx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>TIM_TRGOSource</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selects the TIMx Trigger Output Mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1, 2, 3, 4, 5, 6, 7 or 8 to select the TIM peripheral.</td></tr>
<tr><td class="paramname">TIM_TRGOSource</td><td>specifies the Trigger Output source. This parameter can be one of the following values:</td></tr>
</table>
</dd>
</dl>
<ul>
<li>For all TIMx <ul>
<li>TIM_TRGOSource_Reset: The UG bit in the TIM_EGR register is used as the trigger output(TRGO) </li>
<li>TIM_TRGOSource_Enable: The Counter Enable CEN is used as the trigger output(TRGO) </li>
<li>TIM_TRGOSource_Update: The update event is selected as the trigger output(TRGO)</li>
</ul>
</li>
<li>For all TIMx except TIM6 and TIM7 <ul>
<li>TIM_TRGOSource_OC1: The trigger output sends a positive pulse when the CC1IF flag is to be set, as soon as a capture or compare match occurs(TRGO) </li>
<li>TIM_TRGOSource_OC1Ref: OC1REF signal is used as the trigger output(TRGO) </li>
<li>TIM_TRGOSource_OC2Ref: OC2REF signal is used as the trigger output(TRGO) </li>
<li>TIM_TRGOSource_OC3Ref: OC3REF signal is used as the trigger output(TRGO) </li>
<li>TIM_TRGOSource_OC4Ref: OC4REF signal is used as the trigger output(TRGO)</li>
</ul>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</li>
</ul>
</div>
</div>
<a class="anchor" id="ga2f19ce1d90990691cf037e419ba08003"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_SelectSlaveMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *&#160;</td>
<td class="paramname"><em>TIMx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>TIM_SlaveMode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selects the TIMx Slave Mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1, 2, 3, 4, 5, 8, 9 or 12 to select the TIM peripheral. </td></tr>
<tr><td class="paramname">TIM_SlaveMode</td><td>specifies the Timer Slave Mode. This parameter can be one of the following values: <ul>
<li>TIM_SlaveMode_Reset: Rising edge of the selected trigger signal(TRGI) reinitialize the counter and triggers an update of the registers </li>
<li>TIM_SlaveMode_Gated: The counter clock is enabled when the trigger signal (TRGI) is high </li>
<li>TIM_SlaveMode_Trigger: The counter starts at a rising edge of the trigger TRGI </li>
<li>TIM_SlaveMode_External1: Rising edges of the selected trigger (TRGI) clock the counter </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:20 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>