360 lines
18 KiB
HTML
360 lines
18 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: Initialization and Configuration 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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">Initialization and Configuration functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> » <a class="el" href="group___a_d_c.html">ADC</a> » <a class="el" href="group___a_d_c___private___functions.html">ADC_Private_Functions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Initialization and Configuration functions.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Initialization and Configuration functions:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group___a_d_c___group1.png" border="0" alt="" usemap="#group______a__d__c______group1"/>
|
|
<map name="group______a__d__c______group1" id="group______a__d__c______group1">
|
|
<area shape="rect" id="node1" href="group___a_d_c___private___functions.html" title="ADC_Private_Functions" alt="" coords="5,13,164,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:ga1962afdd9eebe5c896bbba2e4f26fe09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group1.html#ga1962afdd9eebe5c896bbba2e4f26fe09">ADC_DeInit</a> (void)</td></tr>
|
|
<tr class="memdesc:ga1962afdd9eebe5c896bbba2e4f26fe09"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes all ADCs peripherals registers to their default reset values. <a href="#ga1962afdd9eebe5c896bbba2e4f26fe09">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1962afdd9eebe5c896bbba2e4f26fe09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabbab6038cf8691404350625e477254f9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group1.html#gabbab6038cf8691404350625e477254f9">ADC_Init</a> (<a class="el" href="struct_a_d_c___type_def.html">ADC_TypeDef</a> *ADCx, <a class="el" href="struct_a_d_c___init_type_def.html">ADC_InitTypeDef</a> *ADC_InitStruct)</td></tr>
|
|
<tr class="memdesc:gabbab6038cf8691404350625e477254f9"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the ADCx peripheral according to the specified parameters in the ADC_InitStruct. <a href="#gabbab6038cf8691404350625e477254f9">More...</a><br /></td></tr>
|
|
<tr class="separator:gabbab6038cf8691404350625e477254f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6c6e754d1d0a98d56e465efaf73272ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group1.html#ga6c6e754d1d0a98d56e465efaf73272ec">ADC_StructInit</a> (<a class="el" href="struct_a_d_c___init_type_def.html">ADC_InitTypeDef</a> *ADC_InitStruct)</td></tr>
|
|
<tr class="memdesc:ga6c6e754d1d0a98d56e465efaf73272ec"><td class="mdescLeft"> </td><td class="mdescRight">Fills each ADC_InitStruct member with its default value. <a href="#ga6c6e754d1d0a98d56e465efaf73272ec">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6c6e754d1d0a98d56e465efaf73272ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5803f6581a9cd7e90b6e637067102d94"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group1.html#ga5803f6581a9cd7e90b6e637067102d94">ADC_CommonInit</a> (<a class="el" href="struct_a_d_c___common_init_type_def.html">ADC_CommonInitTypeDef</a> *ADC_CommonInitStruct)</td></tr>
|
|
<tr class="memdesc:ga5803f6581a9cd7e90b6e637067102d94"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the ADCs peripherals according to the specified parameters in the ADC_CommonInitStruct. <a href="#ga5803f6581a9cd7e90b6e637067102d94">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5803f6581a9cd7e90b6e637067102d94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad60a6414b4932c704f6f7a7c2963fa2a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group1.html#gad60a6414b4932c704f6f7a7c2963fa2a">ADC_CommonStructInit</a> (<a class="el" href="struct_a_d_c___common_init_type_def.html">ADC_CommonInitTypeDef</a> *ADC_CommonInitStruct)</td></tr>
|
|
<tr class="memdesc:gad60a6414b4932c704f6f7a7c2963fa2a"><td class="mdescLeft"> </td><td class="mdescRight">Fills each ADC_CommonInitStruct member with its default value. <a href="#gad60a6414b4932c704f6f7a7c2963fa2a">More...</a><br /></td></tr>
|
|
<tr class="separator:gad60a6414b4932c704f6f7a7c2963fa2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga40882d399e3371755ed610c1134e634e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_d_c___group1.html#ga40882d399e3371755ed610c1134e634e">ADC_Cmd</a> (<a class="el" href="struct_a_d_c___type_def.html">ADC_TypeDef</a> *ADCx, FunctionalState NewState)</td></tr>
|
|
<tr class="memdesc:ga40882d399e3371755ed610c1134e634e"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the specified ADC peripheral. <a href="#ga40882d399e3371755ed610c1134e634e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga40882d399e3371755ed610c1134e634e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Initialization and Configuration functions. </p>
|
|
<pre class="fragment"> ===============================================================================
|
|
##### Initialization and Configuration functions #####
|
|
===============================================================================
|
|
[..] This section provides functions allowing to:
|
|
(+) Initialize and configure the ADC Prescaler
|
|
(+) ADC Conversion Resolution (12bit..6bit)
|
|
(+) Scan Conversion Mode (multichannel or one channel) for regular group
|
|
(+) ADC Continuous Conversion Mode (Continuous or Single conversion) for
|
|
regular group
|
|
(+) External trigger Edge and source of regular group,
|
|
(+) Converted data alignment (left or right)
|
|
(+) The number of ADC conversions that will be done using the sequencer for
|
|
regular channel group
|
|
(+) Multi ADC mode selection
|
|
(+) Direct memory access mode selection for multi ADC mode
|
|
(+) Delay between 2 sampling phases (used in dual or triple interleaved modes)
|
|
(+) Enable or disable the ADC peripheral
|
|
</pre> <h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga40882d399e3371755ed610c1134e634e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADC_Cmd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_a_d_c___type_def.html">ADC_TypeDef</a> * </td>
|
|
<td class="paramname"><em>ADCx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FunctionalState </td>
|
|
<td class="paramname"><em>NewState</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables or disables the specified ADC peripheral. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ADCx</td><td>where x can be 1, 2 or 3 to select the ADC peripheral. </td></tr>
|
|
<tr><td class="paramname">NewState</td><td>new state of the ADCx peripheral. 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="ga5803f6581a9cd7e90b6e637067102d94"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADC_CommonInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_a_d_c___common_init_type_def.html">ADC_CommonInitTypeDef</a> * </td>
|
|
<td class="paramname"><em>ADC_CommonInitStruct</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the ADCs peripherals according to the specified parameters in the ADC_CommonInitStruct. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ADC_CommonInitStruct</td><td>pointer to an <a class="el" href="struct_a_d_c___common_init_type_def.html" title="ADC Common Init structure definition. ">ADC_CommonInitTypeDef</a> structure that contains the configuration information for All ADCs peripherals. </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="gad60a6414b4932c704f6f7a7c2963fa2a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADC_CommonStructInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_a_d_c___common_init_type_def.html">ADC_CommonInitTypeDef</a> * </td>
|
|
<td class="paramname"><em>ADC_CommonInitStruct</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fills each ADC_CommonInitStruct member with its default value. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ADC_CommonInitStruct</td><td>pointer to an <a class="el" href="struct_a_d_c___common_init_type_def.html" title="ADC Common Init structure definition. ">ADC_CommonInitTypeDef</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="ga1962afdd9eebe5c896bbba2e4f26fe09"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADC_DeInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deinitializes all ADCs peripherals registers to their default reset values. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">None</td><td></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 call graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group___a_d_c___group1_ga1962afdd9eebe5c896bbba2e4f26fe09_cgraph.png" border="0" usemap="#group___a_d_c___group1_ga1962afdd9eebe5c896bbba2e4f26fe09_cgraph" alt=""/></div>
|
|
<map name="group___a_d_c___group1_ga1962afdd9eebe5c896bbba2e4f26fe09_cgraph" id="group___a_d_c___group1_ga1962afdd9eebe5c896bbba2e4f26fe09_cgraph">
|
|
<area shape="rect" id="node2" href="group___r_c_c.html#gad94553850ac07106a27ee85fec37efdf" title="Forces or releases High Speed APB (APB2) peripheral reset. " alt="" coords="143,5,331,32"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabbab6038cf8691404350625e477254f9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADC_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_a_d_c___type_def.html">ADC_TypeDef</a> * </td>
|
|
<td class="paramname"><em>ADCx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_a_d_c___init_type_def.html">ADC_InitTypeDef</a> * </td>
|
|
<td class="paramname"><em>ADC_InitStruct</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the ADCx peripheral according to the specified parameters in the ADC_InitStruct. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is used to configure the global features of the ADC ( Resolution and Data Alignment), however, the rest of the configuration parameters are specific to the regular channels group (scan mode activation, continuous mode activation, External trigger source and edge, number of conversion in the regular channels group sequencer). </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ADCx</td><td>where x can be 1, 2 or 3 to select the ADC peripheral. </td></tr>
|
|
<tr><td class="paramname">ADC_InitStruct</td><td>pointer to an <a class="el" href="struct_a_d_c___init_type_def.html" title="ADC Init structure definition. ">ADC_InitTypeDef</a> structure that contains the configuration information for the specified ADC 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="ga6c6e754d1d0a98d56e465efaf73272ec"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADC_StructInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_a_d_c___init_type_def.html">ADC_InitTypeDef</a> * </td>
|
|
<td class="paramname"><em>ADC_InitStruct</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fills each ADC_InitStruct member with its default value. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is used to initialize the global features of the ADC ( Resolution and Data Alignment), however, the rest of the configuration parameters are specific to the regular channels group (scan mode activation, continuous mode activation, External trigger source and edge, number of conversion in the regular channels group sequencer). </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ADC_InitStruct</td><td>pointer to an <a class="el" href="struct_a_d_c___init_type_def.html" title="ADC Init structure definition. ">ADC_InitTypeDef</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>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun May 10 2015 15:15:19 for discoverpixy by  <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>
|