208 lines
20 KiB
HTML
208 lines
20 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: discovery/libs/StmCoreNPheriph/src/stm32f4xx_iwdg.c File Reference</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 class="current"><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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_84db96586f7d962b526d6d9627d831c2.html">discovery</a></li><li class="navelem"><a class="el" href="dir_07523c13f04fd35d8848cb17a371cb5b.html">libs</a></li><li class="navelem"><a class="el" href="dir_1d60ba7d807ff336a2be2f2de640bf2b.html">StmCoreNPheriph</a></li><li class="navelem"><a class="el" href="dir_12f7a99b9d2a0e5955a2ac990af20021.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">stm32f4xx_iwdg.c File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This file provides firmware functions to manage the following functionalities of the Independent watchdog (IWDG) peripheral:
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="stm32f4xx__iwdg_8h_source.html">stm32f4xx_iwdg.h</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for stm32f4xx_iwdg.c:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="stm32f4xx__iwdg_8c__incl.png" border="0" usemap="#discovery_2libs_2_stm_core_n_pheriph_2src_2stm32f4xx__iwdg_8c" alt=""/></div>
|
|
<map name="discovery_2libs_2_stm_core_n_pheriph_2src_2stm32f4xx__iwdg_8c" id="discovery_2libs_2_stm_core_n_pheriph_2src_2stm32f4xx__iwdg_8c">
|
|
<area shape="rect" id="node2" href="stm32f4xx__iwdg_8h.html" title="This file contains all the functions prototypes for the IWDG firmware library. " alt="" coords="2197,95,2323,121"/><area shape="rect" id="node3" href="stm32f4xx_8h.html" title="CMSIS Cortex-M4 Device Peripheral Access Layer Header File. This file contains all the peripheral reg..." alt="" coords="2155,169,2248,196"/><area shape="rect" id="node4" href="core__cm4_8h.html" title="CMSIS Cortex-M4 Core Peripheral Access Layer Header File. " alt="" coords="349,244,440,271"/><area shape="rect" id="node9" href="system__stm32f4xx_8h.html" title="CMSIS Cortex-M4 Device System Source File for STM32F4xx devices. " alt="" coords="182,244,325,271"/><area shape="rect" id="node10" href="stm32f4xx__conf_8h_source.html" title="stm32f4xx_conf.h" alt="" coords="2274,244,2398,271"/><area shape="rect" id="node6" href="core__cm_instr_8h.html" title="CMSIS Cortex-M Core Instruction Access Header File. " alt="" coords="5,319,112,345"/><area shape="rect" id="node7" href="core__cm_func_8h.html" title="CMSIS Cortex-M Core Function Access Header File. " alt="" coords="136,319,248,345"/><area shape="rect" id="node8" href="core__cm4__simd_8h.html" title="CMSIS Cortex-M4 SIMD Header File. " alt="" coords="272,319,397,345"/><area shape="rect" id="node11" href="stm32f4xx__adc_8h.html" title="This file contains all the functions prototypes for the ADC firmware library. " alt="" coords="511,319,633,345"/><area shape="rect" id="node12" href="stm32f4xx__crc_8h.html" title="This file contains all the functions prototypes for the CRC firmware library. " alt="" coords="657,319,775,345"/><area shape="rect" id="node13" href="stm32f4xx__dbgmcu_8h.html" title="This file contains all the functions prototypes for the DBGMCU firmware library. " alt="" coords="800,319,947,345"/><area shape="rect" id="node14" href="stm32f4xx__dma_8h.html" title="This file contains all the functions prototypes for the DMA firmware library. " alt="" coords="971,319,1096,345"/><area shape="rect" id="node15" href="stm32f4xx__exti_8h.html" title="This file contains all the functions prototypes for the EXTI firmware library. " alt="" coords="1121,319,1242,345"/><area shape="rect" id="node16" href="stm32f4xx__flash_8h.html" title="This file contains all the functions prototypes for the FLASH firmware library. " alt="" coords="1266,319,1393,345"/><area shape="rect" id="node17" href="stm32f4xx__gpio_8h.html" title="This file contains all the functions prototypes for the GPIO firmware library. " alt="" coords="1417,319,1541,345"/><area shape="rect" id="node18" href="stm32f4xx__i2c_8h.html" title="This file contains all the functions prototypes for the I2C firmware library. " alt="" coords="1564,319,1681,345"/><area shape="rect" id="node19" href="stm32f4xx__pwr_8h.html" title="This file contains all the functions prototypes for the PWR firmware library. " alt="" coords="1705,319,1823,345"/><area shape="rect" id="node20" href="stm32f4xx__rcc_8h.html" title="This file contains all the functions prototypes for the RCC firmware library. " alt="" coords="1847,319,1966,345"/><area shape="rect" id="node21" href="stm32f4xx__rtc_8h.html" title="This file contains all the functions prototypes for the RTC firmware library. " alt="" coords="1991,319,2105,345"/><area shape="rect" id="node22" href="stm32f4xx__sdio_8h.html" title="This file contains all the functions prototypes for the SDIO firmware library. " alt="" coords="2130,319,2254,345"/><area shape="rect" id="node23" href="stm32f4xx__spi_8h.html" title="This file contains all the functions prototypes for the SPI firmware library. " alt="" coords="2277,319,2395,345"/><area shape="rect" id="node24" href="stm32f4xx__syscfg_8h.html" title="This file contains all the functions prototypes for the SYSCFG firmware library. " alt="" coords="2419,319,2557,345"/><area shape="rect" id="node25" href="stm32f4xx__tim_8h.html" title="This file contains all the functions prototypes for the TIM firmware library. " alt="" coords="2582,319,2701,345"/><area shape="rect" id="node26" href="stm32f4xx__usart_8h.html" title="This file contains all the functions prototypes for the USART firmware library. " alt="" coords="2725,319,2854,345"/><area shape="rect" id="node27" href="stm32f4xx__wwdg_8h.html" title="This file contains all the functions prototypes for the WWDG firmware library. " alt="" coords="2878,319,3010,345"/><area shape="rect" id="node28" href="misc_8h.html" title="This file contains all the functions prototypes for the miscellaneous firmware library functions (add..." alt="" coords="3035,319,3096,345"/><area shape="rect" id="node29" href="stm32f4xx__cryp_8h.html" title="This file contains all the functions prototypes for the Cryptographic processor(CRYP) firmware librar..." alt="" coords="3120,319,3245,345"/><area shape="rect" id="node30" href="stm32f4xx__hash_8h.html" title="This file contains all the functions prototypes for the HASH firmware library. " alt="" coords="3269,319,3397,345"/><area shape="rect" id="node31" href="stm32f4xx__rng_8h.html" title="This file contains all the functions prototypes for the Random Number Generator(RNG) firmware library..." alt="" coords="3422,319,3541,345"/><area shape="rect" id="node32" href="stm32f4xx__can_8h.html" title="This file contains all the functions prototypes for the CAN firmware library. " alt="" coords="3565,319,3686,345"/><area shape="rect" id="node33" href="stm32f4xx__dac_8h.html" title="This file contains all the functions prototypes for the DAC firmware library. " alt="" coords="3710,319,3831,345"/><area shape="rect" id="node34" href="stm32f4xx__dcmi_8h.html" title="This file contains all the functions prototypes for the DCMI firmware library. " alt="" coords="3856,319,3984,345"/><area shape="rect" id="node35" href="stm32f4xx__fsmc_8h.html" title="This file contains all the functions prototypes for the FSMC firmware library. " alt="" coords="4008,319,4136,345"/></map>
|
|
</div>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga830a9a1bad16c7043c86545f4c159a50"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga830a9a1bad16c7043c86545f4c159a50"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>KR_KEY_RELOAD</b>   ((uint16_t)0xAAAA)</td></tr>
|
|
<tr class="separator:ga830a9a1bad16c7043c86545f4c159a50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeaa0dd2da3f9d0cce0d708cfff1df545"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeaa0dd2da3f9d0cce0d708cfff1df545"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>KR_KEY_ENABLE</b>   ((uint16_t)0xCCCC)</td></tr>
|
|
<tr class="separator:gaeaa0dd2da3f9d0cce0d708cfff1df545"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gae466681e5bdc11b353c508b89d75ca05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_w_d_g___group1.html#gae466681e5bdc11b353c508b89d75ca05">IWDG_WriteAccessCmd</a> (uint16_t IWDG_WriteAccess)</td></tr>
|
|
<tr class="memdesc:gae466681e5bdc11b353c508b89d75ca05"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables write access to IWDG_PR and IWDG_RLR registers. <a href="group___i_w_d_g___group1.html#gae466681e5bdc11b353c508b89d75ca05">More...</a><br /></td></tr>
|
|
<tr class="separator:gae466681e5bdc11b353c508b89d75ca05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4fa7f1cd690533a35ad9e4729c0450a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_w_d_g___group1.html#ga4fa7f1cd690533a35ad9e4729c0450a3">IWDG_SetPrescaler</a> (uint8_t IWDG_Prescaler)</td></tr>
|
|
<tr class="memdesc:ga4fa7f1cd690533a35ad9e4729c0450a3"><td class="mdescLeft"> </td><td class="mdescRight">Sets IWDG Prescaler value. <a href="group___i_w_d_g___group1.html#ga4fa7f1cd690533a35ad9e4729c0450a3">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4fa7f1cd690533a35ad9e4729c0450a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae2a14752a0431f23cb80cebf202ac365"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_w_d_g___group1.html#gae2a14752a0431f23cb80cebf202ac365">IWDG_SetReload</a> (uint16_t Reload)</td></tr>
|
|
<tr class="memdesc:gae2a14752a0431f23cb80cebf202ac365"><td class="mdescLeft"> </td><td class="mdescRight">Sets IWDG Reload value. <a href="group___i_w_d_g___group1.html#gae2a14752a0431f23cb80cebf202ac365">More...</a><br /></td></tr>
|
|
<tr class="separator:gae2a14752a0431f23cb80cebf202ac365"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7147ebabdc3fef97f532b171a4e70d49"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_w_d_g___group1.html#ga7147ebabdc3fef97f532b171a4e70d49">IWDG_ReloadCounter</a> (void)</td></tr>
|
|
<tr class="memdesc:ga7147ebabdc3fef97f532b171a4e70d49"><td class="mdescLeft"> </td><td class="mdescRight">Reloads IWDG counter with value defined in the reload register (write access to IWDG_PR and IWDG_RLR registers disabled). <a href="group___i_w_d_g___group1.html#ga7147ebabdc3fef97f532b171a4e70d49">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7147ebabdc3fef97f532b171a4e70d49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga479b2921c86f8c67b819f5c4bea6bdb6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_w_d_g___group2.html#ga479b2921c86f8c67b819f5c4bea6bdb6">IWDG_Enable</a> (void)</td></tr>
|
|
<tr class="memdesc:ga479b2921c86f8c67b819f5c4bea6bdb6"><td class="mdescLeft"> </td><td class="mdescRight">Enables IWDG (write access to IWDG_PR and IWDG_RLR registers disabled). <a href="group___i_w_d_g___group2.html#ga479b2921c86f8c67b819f5c4bea6bdb6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga479b2921c86f8c67b819f5c4bea6bdb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga37f050cfbedc0c15f9e0816c0b22011e"><td class="memItemLeft" align="right" valign="top">FlagStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_w_d_g___group3.html#ga37f050cfbedc0c15f9e0816c0b22011e">IWDG_GetFlagStatus</a> (uint16_t IWDG_FLAG)</td></tr>
|
|
<tr class="memdesc:ga37f050cfbedc0c15f9e0816c0b22011e"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified IWDG flag is set or not. <a href="group___i_w_d_g___group3.html#ga37f050cfbedc0c15f9e0816c0b22011e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga37f050cfbedc0c15f9e0816c0b22011e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This file provides firmware functions to manage the following functionalities of the Independent watchdog (IWDG) peripheral: </p>
|
|
<dl class="section author"><dt>Author</dt><dd>MCD Application Team </dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>V1.4.0 </dd></dl>
|
|
<dl class="section date"><dt>Date</dt><dd>04-August-2014<ul>
|
|
<li>Prescaler and Counter configuration</li>
|
|
<li>IWDG activation</li>
|
|
<li>Flag management</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<pre class="fragment">===============================================================================
|
|
##### IWDG features #####
|
|
===============================================================================
|
|
[..]
|
|
The IWDG can be started by either software or hardware (configurable
|
|
through option byte).
|
|
|
|
The IWDG is clocked by its own dedicated low-speed clock (LSI) and
|
|
thus stays active even if the main clock fails.
|
|
Once the IWDG is started, the LSI is forced ON and cannot be disabled
|
|
(LSI cannot be disabled too), and the counter starts counting down from
|
|
the reset value of 0xFFF. When it reaches the end of count value (0x000)
|
|
a system reset is generated.
|
|
The IWDG counter should be reloaded at regular intervals to prevent
|
|
an MCU reset.
|
|
|
|
The IWDG is implemented in the VDD voltage domain that is still functional
|
|
in STOP and STANDBY mode (IWDG reset can wake-up from STANDBY).
|
|
|
|
IWDGRST flag in RCC_CSR register can be used to inform when a IWDG
|
|
reset occurs.
|
|
|
|
Min-max timeout value @32KHz (LSI): ~125us / ~32.7s
|
|
The IWDG timeout may vary due to LSI frequency dispersion. STM32F4xx
|
|
devices provide the capability to measure the LSI frequency (LSI clock
|
|
connected internally to TIM5 CH4 input capture). The measured value
|
|
can be used to have an IWDG timeout with an acceptable accuracy.
|
|
For more information, please refer to the STM32F4xx Reference manual
|
|
|
|
##### How to use this driver #####
|
|
===============================================================================
|
|
[..]
|
|
(#) Enable write access to IWDG_PR and IWDG_RLR registers using
|
|
IWDG_WriteAccessCmd(IWDG_WriteAccess_Enable) function
|
|
|
|
(#) Configure the IWDG prescaler using IWDG_SetPrescaler() function
|
|
|
|
(#) Configure the IWDG counter value using IWDG_SetReload() function.
|
|
This value will be loaded in the IWDG counter each time the counter
|
|
is reloaded, then the IWDG will start counting down from this value.
|
|
|
|
(#) Start the IWDG using IWDG_Enable() function, when the IWDG is used
|
|
in software mode (no need to enable the LSI, it will be enabled
|
|
by hardware)
|
|
|
|
(#) Then the application program must reload the IWDG counter at regular
|
|
intervals during normal operation to prevent an MCU reset, using
|
|
IWDG_ReloadCounter() function. </pre><dl class="section attention"><dt>Attention</dt><dd></dd></dl>
|
|
<h2><center>© COPYRIGHT 2014 STMicroelectronics</center></h2>
|
|
<p>Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at: </p><pre class="fragment"> http://www.st.com/software_license_agreement_liberty_v2
|
|
</pre><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </p>
|
|
</div></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun May 10 2015 15:15:18 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>
|