aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added doxygen output of current emulator branch.

Browse Source
This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

339
group___t_i_m___group4.html Normal file
View File

@@ -0,0 +1,339 @@
<!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: Advanced-control timers (TIM1 and TIM8) specific features</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">Advanced-control timers (TIM1 and TIM8) specific features<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>Advanced-control timers (TIM1 and TIM8) specific features.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Advanced-control timers (TIM1 and TIM8) specific features:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___t_i_m___group4.png" border="0" alt="" usemap="#group______t__i__m______group4"/>
<map name="group______t__i__m______group4" id="group______t__i__m______group4">
<area shape="rect" id="node2" href="group___t_i_m___private___functions.html" title="TIM_Private_Functions" alt="" coords="5,20,159,47"/></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:ga3df4ba3f0727f63ce621e2b2e6035d4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group4.html#ga3df4ba3f0727f63ce621e2b2e6035d4f">TIM_BDTRConfig</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, <a class="el" href="struct_t_i_m___b_d_t_r_init_type_def.html">TIM_BDTRInitTypeDef</a> *TIM_BDTRInitStruct)</td></tr>
<tr class="memdesc:ga3df4ba3f0727f63ce621e2b2e6035d4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the Break feature, dead time, Lock level, OSSI/OSSR State and the AOE(automatic output enable). <a href="#ga3df4ba3f0727f63ce621e2b2e6035d4f">More...</a><br /></td></tr>
<tr class="separator:ga3df4ba3f0727f63ce621e2b2e6035d4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea0f49938cda8ae0738162194798afc6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group4.html#gaea0f49938cda8ae0738162194798afc6">TIM_BDTRStructInit</a> (<a class="el" href="struct_t_i_m___b_d_t_r_init_type_def.html">TIM_BDTRInitTypeDef</a> *TIM_BDTRInitStruct)</td></tr>
<tr class="memdesc:gaea0f49938cda8ae0738162194798afc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each TIM_BDTRInitStruct member with its default value. <a href="#gaea0f49938cda8ae0738162194798afc6">More...</a><br /></td></tr>
<tr class="separator:gaea0f49938cda8ae0738162194798afc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3e59ebced2ab8e0b817c460f1670e97d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group4.html#ga3e59ebced2ab8e0b817c460f1670e97d">TIM_CtrlPWMOutputs</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga3e59ebced2ab8e0b817c460f1670e97d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the TIM peripheral Main Outputs. <a href="#ga3e59ebced2ab8e0b817c460f1670e97d">More...</a><br /></td></tr>
<tr class="separator:ga3e59ebced2ab8e0b817c460f1670e97d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff2e7f9959b1b36e830df028c14accc8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group4.html#gaff2e7f9959b1b36e830df028c14accc8">TIM_SelectCOM</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, FunctionalState NewState)</td></tr>
<tr class="memdesc:gaff2e7f9959b1b36e830df028c14accc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the TIM peripheral Commutation event. <a href="#gaff2e7f9959b1b36e830df028c14accc8">More...</a><br /></td></tr>
<tr class="separator:gaff2e7f9959b1b36e830df028c14accc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0a935254e44312b1d78e8684a58db3c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_m___group4.html#ga0a935254e44312b1d78e8684a58db3c1">TIM_CCPreloadControl</a> (<a class="el" href="struct_t_i_m___type_def.html">TIM_TypeDef</a> *TIMx, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga0a935254e44312b1d78e8684a58db3c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or Resets the TIM peripheral Capture Compare Preload Control bit. <a href="#ga0a935254e44312b1d78e8684a58db3c1">More...</a><br /></td></tr>
<tr class="separator:ga0a935254e44312b1d78e8684a58db3c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Advanced-control timers (TIM1 and TIM8) specific features. </p>
<pre class="fragment"> ===============================================================================
##### Advanced-control timers (TIM1 and TIM8) specific features #####
===============================================================================
##### TIM Driver: how to use the Break feature #####
===============================================================================
[..]
After configuring the Timer channel(s) in the appropriate Output Compare mode:
(#) Fill the TIM_BDTRInitStruct with the desired parameters for the Timer
Break Polarity, dead time, Lock level, the OSSI/OSSR State and the
AOE(automatic output enable).
(#) Call TIM_BDTRConfig(TIMx, &amp;TIM_BDTRInitStruct) to configure the Timer
(#) Enable the Main Output using TIM_CtrlPWMOutputs(TIM1, ENABLE)
(#) Once the break even occurs, the Timer's output signals are put in reset
state or in a known state (according to the configuration made in
TIM_BDTRConfig() function).</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga3df4ba3f0727f63ce621e2b2e6035d4f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_BDTRConfig </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"><a class="el" href="struct_t_i_m___b_d_t_r_init_type_def.html">TIM_BDTRInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>TIM_BDTRInitStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the Break feature, dead time, Lock level, OSSI/OSSR State and the AOE(automatic output enable). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1 or 8 to select the TIM </td></tr>
<tr><td class="paramname">TIM_BDTRInitStruct</td><td>pointer to a <a class="el" href="struct_t_i_m___b_d_t_r_init_type_def.html" title="BDTR structure definition. ">TIM_BDTRInitTypeDef</a> structure that contains the BDTR Register configuration information for the TIM peripheral. </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="gaea0f49938cda8ae0738162194798afc6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_BDTRStructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_t_i_m___b_d_t_r_init_type_def.html">TIM_BDTRInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>TIM_BDTRInitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each TIM_BDTRInitStruct member with its default value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIM_BDTRInitStruct</td><td>pointer to a <a class="el" href="struct_t_i_m___b_d_t_r_init_type_def.html" title="BDTR structure definition. ">TIM_BDTRInitTypeDef</a> structure which will be initialized. </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="ga0a935254e44312b1d78e8684a58db3c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_CCPreloadControl </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">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets or Resets the TIM peripheral Capture Compare Preload Control bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1 or 8 to select the TIMx peripheral </td></tr>
<tr><td class="paramname">NewState</td><td>new state of the Capture Compare Preload Control bit This parameter can be: ENABLE or DISABLE. </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="ga3e59ebced2ab8e0b817c460f1670e97d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_CtrlPWMOutputs </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">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the TIM peripheral Main Outputs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1 or 8 to select the TIMx peripheral. </td></tr>
<tr><td class="paramname">NewState</td><td>new state of the TIM peripheral Main Outputs. This parameter can be: ENABLE or DISABLE. </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="gaff2e7f9959b1b36e830df028c14accc8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TIM_SelectCOM </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">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selects the TIM peripheral Commutation event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TIMx</td><td>where x can be 1 or 8 to select the TIMx peripheral </td></tr>
<tr><td class="paramname">NewState</td><td>new state of the Commutation event. This parameter can be: ENABLE or DISABLE. </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>