Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
314
group___s_d_i_o___group3.html
Normal file
314
group___s_d_i_o___group3.html
Normal file
@@ -0,0 +1,314 @@
|
||||
<!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: Data path state machine (DPSM) 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 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">Data path state machine (DPSM) management 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___s_d_i_o.html">SDIO</a> » <a class="el" href="group___s_d_i_o___private___functions.html">SDIO_Private_Functions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Data path state machine (DPSM) management functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for Data path state machine (DPSM) management functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___s_d_i_o___group3.png" border="0" alt="" usemap="#group______s__d__i__o______group3"/>
|
||||
<map name="group______s__d__i__o______group3" id="group______s__d__i__o______group3">
|
||||
<area shape="rect" id="node1" href="group___s_d_i_o___private___functions.html" title="SDIO_Private_Functions" alt="" coords="5,13,168,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:gad65d896ae919683585bda44a1e2afae4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group3.html#gad65d896ae919683585bda44a1e2afae4">SDIO_DataConfig</a> (<a class="el" href="struct_s_d_i_o___data_init_type_def.html">SDIO_DataInitTypeDef</a> *SDIO_DataInitStruct)</td></tr>
|
||||
<tr class="memdesc:gad65d896ae919683585bda44a1e2afae4"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the SDIO data path according to the specified parameters in the SDIO_DataInitStruct. <a href="#gad65d896ae919683585bda44a1e2afae4">More...</a><br /></td></tr>
|
||||
<tr class="separator:gad65d896ae919683585bda44a1e2afae4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa83209c09e921521aca2587fb5b22ea2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group3.html#gaa83209c09e921521aca2587fb5b22ea2">SDIO_DataStructInit</a> (<a class="el" href="struct_s_d_i_o___data_init_type_def.html">SDIO_DataInitTypeDef</a> *SDIO_DataInitStruct)</td></tr>
|
||||
<tr class="memdesc:gaa83209c09e921521aca2587fb5b22ea2"><td class="mdescLeft"> </td><td class="mdescRight">Fills each SDIO_DataInitStruct member with its default value. <a href="#gaa83209c09e921521aca2587fb5b22ea2">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa83209c09e921521aca2587fb5b22ea2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7a28aaa2c25a9a5a8db1f49b0e8c9d0a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group3.html#ga7a28aaa2c25a9a5a8db1f49b0e8c9d0a">SDIO_GetDataCounter</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga7a28aaa2c25a9a5a8db1f49b0e8c9d0a"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of remaining data bytes to be transferred. <a href="#ga7a28aaa2c25a9a5a8db1f49b0e8c9d0a">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga7a28aaa2c25a9a5a8db1f49b0e8c9d0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga4e8ac755ef3c31ecd4ed2708df19187e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group3.html#ga4e8ac755ef3c31ecd4ed2708df19187e">SDIO_ReadData</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga4e8ac755ef3c31ecd4ed2708df19187e"><td class="mdescLeft"> </td><td class="mdescRight">Read one data word from Rx FIFO. <a href="#ga4e8ac755ef3c31ecd4ed2708df19187e">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga4e8ac755ef3c31ecd4ed2708df19187e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga361008b5252aa33b5f2b5823ee3d7240"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group3.html#ga361008b5252aa33b5f2b5823ee3d7240">SDIO_WriteData</a> (uint32_t Data)</td></tr>
|
||||
<tr class="memdesc:ga361008b5252aa33b5f2b5823ee3d7240"><td class="mdescLeft"> </td><td class="mdescRight">Write one data word to Tx FIFO. <a href="#ga361008b5252aa33b5f2b5823ee3d7240">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga361008b5252aa33b5f2b5823ee3d7240"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9a3343983a2d68b5164a1c89797d2dd6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group3.html#ga9a3343983a2d68b5164a1c89797d2dd6">SDIO_GetFIFOCount</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga9a3343983a2d68b5164a1c89797d2dd6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of words left to be written to or read from FIFO. <a href="#ga9a3343983a2d68b5164a1c89797d2dd6">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9a3343983a2d68b5164a1c89797d2dd6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Data path state machine (DPSM) management functions. </p>
|
||||
<pre class="fragment"> ===============================================================================
|
||||
##### Data path state machine (DPSM) management functions #####
|
||||
===============================================================================
|
||||
|
||||
This section provide functions allowing to program and read the Data path
|
||||
state machine (DPSM).</pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gad65d896ae919683585bda44a1e2afae4"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SDIO_DataConfig </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="struct_s_d_i_o___data_init_type_def.html">SDIO_DataInitTypeDef</a> * </td>
|
||||
<td class="paramname"><em>SDIO_DataInitStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initializes the SDIO data path according to the specified parameters in the SDIO_DataInitStruct. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">SDIO_DataInitStruct</td><td>: pointer to a <a class="el" href="struct_s_d_i_o___data_init_type_def.html">SDIO_DataInitTypeDef</a> structure that contains the configuration information for the SDIO command. </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="gaa83209c09e921521aca2587fb5b22ea2"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SDIO_DataStructInit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="struct_s_d_i_o___data_init_type_def.html">SDIO_DataInitTypeDef</a> * </td>
|
||||
<td class="paramname"><em>SDIO_DataInitStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Fills each SDIO_DataInitStruct member with its default value. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">SDIO_DataInitStruct</td><td>pointer to an <a class="el" href="struct_s_d_i_o___data_init_type_def.html">SDIO_DataInitTypeDef</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="ga7a28aaa2c25a9a5a8db1f49b0e8c9d0a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t SDIO_GetDataCounter </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns number of remaining data bytes to be transferred. </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">Number</td><td>of remaining data bytes to be transferred </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga9a3343983a2d68b5164a1c89797d2dd6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t SDIO_GetFIFOCount </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the number of words left to be written to or read from FIFO. </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">Remaining</td><td>number of words. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga4e8ac755ef3c31ecd4ed2708df19187e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t SDIO_ReadData </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Read one data word from Rx FIFO. </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">Data</td><td>received </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga361008b5252aa33b5f2b5823ee3d7240"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SDIO_WriteData </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>Data</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Write one data word to Tx FIFO. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Data</td><td>32-bit data word to write. </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  <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
Block a user