aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
gh-pages
discoverpixy/group___f_s_m_c___group2.html
Timo Lang 57aa160278 Added doxygen output of current emulator branch.
2015-05-12 11:12:43 +02:00

383 lines
17 KiB
HTML
Raw Permalink Blame History

<!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: NAND Controller 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">NAND Controller 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___f_s_m_c.html">FSMC</a> &raquo; <a class="el" href="group___f_s_m_c___private___functions.html">FSMC_Private_Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>NAND Controller functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for NAND Controller functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___f_s_m_c___group2.png" border="0" alt="" usemap="#group______f__s__m__c______group2"/>
<map name="group______f__s__m__c______group2" id="group______f__s__m__c______group2">
<area shape="rect" id="node2" href="group___f_s_m_c___private___functions.html" title="FSMC_Private_Functions" alt="" coords="5,5,175,32"/></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:gafb749503293474a68555961bd8f120e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_s_m_c___group2.html#gafb749503293474a68555961bd8f120e1">FSMC_NANDDeInit</a> (uint32_t FSMC_Bank)</td></tr>
<tr class="memdesc:gafb749503293474a68555961bd8f120e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initializes the FSMC NAND Banks registers to their default reset values. <a href="#gafb749503293474a68555961bd8f120e1">More...</a><br /></td></tr>
<tr class="separator:gafb749503293474a68555961bd8f120e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f81ccc4e126c11f1eb33077b1a68e6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_s_m_c___group2.html#ga9f81ccc4e126c11f1eb33077b1a68e6f">FSMC_NANDInit</a> (<a class="el" href="struct_f_s_m_c___n_a_n_d_init_type_def.html">FSMC_NANDInitTypeDef</a> *FSMC_NANDInitStruct)</td></tr>
<tr class="memdesc:ga9f81ccc4e126c11f1eb33077b1a68e6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the FSMC NAND Banks according to the specified parameters in the FSMC_NANDInitStruct. <a href="#ga9f81ccc4e126c11f1eb33077b1a68e6f">More...</a><br /></td></tr>
<tr class="separator:ga9f81ccc4e126c11f1eb33077b1a68e6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8283ad94ad8e83d49d5b77d1c7e17862"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_s_m_c___group2.html#ga8283ad94ad8e83d49d5b77d1c7e17862">FSMC_NANDStructInit</a> (<a class="el" href="struct_f_s_m_c___n_a_n_d_init_type_def.html">FSMC_NANDInitTypeDef</a> *FSMC_NANDInitStruct)</td></tr>
<tr class="memdesc:ga8283ad94ad8e83d49d5b77d1c7e17862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each FSMC_NANDInitStruct member with its default value. <a href="#ga8283ad94ad8e83d49d5b77d1c7e17862">More...</a><br /></td></tr>
<tr class="separator:ga8283ad94ad8e83d49d5b77d1c7e17862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33ec7c39ea4d42e92c72c6e517d8235c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_s_m_c___group2.html#ga33ec7c39ea4d42e92c72c6e517d8235c">FSMC_NANDCmd</a> (uint32_t FSMC_Bank, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga33ec7c39ea4d42e92c72c6e517d8235c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the specified NAND Memory Bank. <a href="#ga33ec7c39ea4d42e92c72c6e517d8235c">More...</a><br /></td></tr>
<tr class="separator:ga33ec7c39ea4d42e92c72c6e517d8235c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5800301fc39bbe998a18ebd9ff191cdc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_s_m_c___group2.html#ga5800301fc39bbe998a18ebd9ff191cdc">FSMC_NANDECCCmd</a> (uint32_t FSMC_Bank, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga5800301fc39bbe998a18ebd9ff191cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the FSMC NAND ECC feature. <a href="#ga5800301fc39bbe998a18ebd9ff191cdc">More...</a><br /></td></tr>
<tr class="separator:ga5800301fc39bbe998a18ebd9ff191cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaad6d4f5b5a41684ce053fea55bdb98d8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_s_m_c___group2.html#gaad6d4f5b5a41684ce053fea55bdb98d8">FSMC_GetECC</a> (uint32_t FSMC_Bank)</td></tr>
<tr class="memdesc:gaad6d4f5b5a41684ce053fea55bdb98d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error correction code register value. <a href="#gaad6d4f5b5a41684ce053fea55bdb98d8">More...</a><br /></td></tr>
<tr class="separator:gaad6d4f5b5a41684ce053fea55bdb98d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>NAND Controller functions. </p>
<pre class="fragment"> ===============================================================================
##### NAND Controller functions #####
===============================================================================
[..] The following sequence should be followed to configure the FSMC to interface
with 8-bit or 16-bit NAND memory connected to the NAND Bank:
(#) Enable the clock for the FSMC and associated GPIOs using the following functions:
(++) RCC_AHB3PeriphClockCmd(RCC_AHB3Periph_FSMC, ENABLE);
(++) RCC_AHB1PeriphClockCmd(RCC_AHB1Periph_GPIOx, ENABLE);
(#) FSMC pins configuration
(++) Connect the involved FSMC pins to AF12 using the following function
GPIO_PinAFConfig(GPIOx, GPIO_PinSourcex, GPIO_AF_FSMC);
(++) Configure these FSMC pins in alternate function mode by calling the function
GPIO_Init();
(#) Declare a FSMC_NANDInitTypeDef structure, for example:
FSMC_NANDInitTypeDef FSMC_NANDInitStructure;
and fill the FSMC_NANDInitStructure variable with the allowed values of
the structure member.
(#) Initialize the NAND Controller by calling the function
FSMC_NANDInit(&amp;FSMC_NANDInitStructure);
(#) Then enable the NAND Bank, for example:
FSMC_NANDCmd(FSMC_Bank3_NAND, ENABLE);
(#) At this stage you can read/write from/to the memory connected to the NAND Bank.
[..]
(@) To enable the Error Correction Code (ECC), you have to use the function
FSMC_NANDECCCmd(FSMC_Bank3_NAND, ENABLE);
[..]
(@) and to get the current ECC value you have to use the function
ECCval = FSMC_GetECC(FSMC_Bank3_NAND); </pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaad6d4f5b5a41684ce053fea55bdb98d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FSMC_GetECC </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>FSMC_Bank</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the error correction code register value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FSMC_Bank</td><td>specifies the FSMC Bank to be used This parameter can be one of the following values: <ul>
<li>FSMC_Bank2_NAND: FSMC Bank2 NAND </li>
<li>FSMC_Bank3_NAND: FSMC Bank3 NAND </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">The</td><td>Error Correction Code (ECC) value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga33ec7c39ea4d42e92c72c6e517d8235c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FSMC_NANDCmd </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>FSMC_Bank</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 specified NAND Memory Bank. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FSMC_Bank</td><td>specifies the FSMC Bank to be used This parameter can be one of the following values: <ul>
<li>FSMC_Bank2_NAND: FSMC Bank2 NAND </li>
<li>FSMC_Bank3_NAND: FSMC Bank3 NAND </li>
</ul>
</td></tr>
<tr><td class="paramname">NewState</td><td>new state of the FSMC_Bank. 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="gafb749503293474a68555961bd8f120e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FSMC_NANDDeInit </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>FSMC_Bank</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initializes the FSMC NAND Banks registers to their default reset values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FSMC_Bank</td><td>specifies the FSMC Bank to be used This parameter can be one of the following values: <ul>
<li>FSMC_Bank2_NAND: FSMC Bank2 NAND </li>
<li>FSMC_Bank3_NAND: FSMC Bank3 NAND </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="ga5800301fc39bbe998a18ebd9ff191cdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FSMC_NANDECCCmd </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>FSMC_Bank</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 FSMC NAND ECC feature. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FSMC_Bank</td><td>specifies the FSMC Bank to be used This parameter can be one of the following values: <ul>
<li>FSMC_Bank2_NAND: FSMC Bank2 NAND </li>
<li>FSMC_Bank3_NAND: FSMC Bank3 NAND </li>
</ul>
</td></tr>
<tr><td class="paramname">NewState</td><td>new state of the FSMC NAND ECC feature. 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="ga9f81ccc4e126c11f1eb33077b1a68e6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FSMC_NANDInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_s_m_c___n_a_n_d_init_type_def.html">FSMC_NANDInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>FSMC_NANDInitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the FSMC NAND Banks according to the specified parameters in the FSMC_NANDInitStruct. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FSMC_NANDInitStruct</td><td>: pointer to a <a class="el" href="struct_f_s_m_c___n_a_n_d_init_type_def.html" title="FSMC NAND Init structure definition. ">FSMC_NANDInitTypeDef</a> structure that contains the configuration information for the FSMC NAND specified Banks. </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="ga8283ad94ad8e83d49d5b77d1c7e17862"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FSMC_NANDStructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_s_m_c___n_a_n_d_init_type_def.html">FSMC_NANDInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>FSMC_NANDInitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each FSMC_NANDInitStruct member with its default value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">FSMC_NANDInitStruct</td><td>pointer to a <a class="el" href="struct_f_s_m_c___n_a_n_d_init_type_def.html" title="FSMC NAND Init structure definition. ">FSMC_NANDInitTypeDef</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 &#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>
Reference in New Issue View Git Blame Copy Permalink