Added doxygen output of current emulator branch.

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

View File

@@ -0,0 +1,396 @@
<!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: Interrupts and flags 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&#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">Interrupts and flags management 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___s_d_i_o.html">SDIO</a> &raquo; <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>Interrupts and flags management functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Interrupts and flags management functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___s_d_i_o___group7.png" border="0" alt="" usemap="#group______s__d__i__o______group7"/>
<map name="group______s__d__i__o______group7" id="group______s__d__i__o______group7">
<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:ga208f51237ef43288735829dbaed37f00"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group7.html#ga208f51237ef43288735829dbaed37f00">SDIO_ITConfig</a> (uint32_t SDIO_IT, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga208f51237ef43288735829dbaed37f00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the SDIO interrupts. <a href="#ga208f51237ef43288735829dbaed37f00">More...</a><br /></td></tr>
<tr class="separator:ga208f51237ef43288735829dbaed37f00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga644514b4b3c95c5c4326d99cd166f6f9"><td class="memItemLeft" align="right" valign="top">FlagStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group7.html#ga644514b4b3c95c5c4326d99cd166f6f9">SDIO_GetFlagStatus</a> (uint32_t SDIO_FLAG)</td></tr>
<tr class="memdesc:ga644514b4b3c95c5c4326d99cd166f6f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the specified SDIO flag is set or not. <a href="#ga644514b4b3c95c5c4326d99cd166f6f9">More...</a><br /></td></tr>
<tr class="separator:ga644514b4b3c95c5c4326d99cd166f6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7aff4efdeb528229135f9f285e53518a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group7.html#ga7aff4efdeb528229135f9f285e53518a">SDIO_ClearFlag</a> (uint32_t SDIO_FLAG)</td></tr>
<tr class="memdesc:ga7aff4efdeb528229135f9f285e53518a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the SDIO's pending flags. <a href="#ga7aff4efdeb528229135f9f285e53518a">More...</a><br /></td></tr>
<tr class="separator:ga7aff4efdeb528229135f9f285e53518a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d64af1f3df0f99cb518f9a89bbd02ac"><td class="memItemLeft" align="right" valign="top">ITStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group7.html#ga2d64af1f3df0f99cb518f9a89bbd02ac">SDIO_GetITStatus</a> (uint32_t SDIO_IT)</td></tr>
<tr class="memdesc:ga2d64af1f3df0f99cb518f9a89bbd02ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the specified SDIO interrupt has occurred or not. <a href="#ga2d64af1f3df0f99cb518f9a89bbd02ac">More...</a><br /></td></tr>
<tr class="separator:ga2d64af1f3df0f99cb518f9a89bbd02ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga048e07fd86321cd01b2a22c071c3149b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_d_i_o___group7.html#ga048e07fd86321cd01b2a22c071c3149b">SDIO_ClearITPendingBit</a> (uint32_t SDIO_IT)</td></tr>
<tr class="memdesc:ga048e07fd86321cd01b2a22c071c3149b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the SDIO's interrupt pending bits. <a href="#ga048e07fd86321cd01b2a22c071c3149b">More...</a><br /></td></tr>
<tr class="separator:ga048e07fd86321cd01b2a22c071c3149b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Interrupts and flags management functions. </p>
<pre class="fragment"> ===============================================================================
##### Interrupts and flags management functions #####
=============================================================================== </pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga7aff4efdeb528229135f9f285e53518a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SDIO_ClearFlag </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>SDIO_FLAG</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the SDIO's pending flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">SDIO_FLAG</td><td>specifies the flag to clear. This parameter can be one or a combination of the following values: <ul>
<li>SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed) </li>
<li>SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed) </li>
<li>SDIO_FLAG_CTIMEOUT: Command response timeout </li>
<li>SDIO_FLAG_DTIMEOUT: Data timeout </li>
<li>SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error </li>
<li>SDIO_FLAG_RXOVERR: Received FIFO overrun error </li>
<li>SDIO_FLAG_CMDREND: Command response received (CRC check passed) </li>
<li>SDIO_FLAG_CMDSENT: Command sent (no response required) </li>
<li>SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero) </li>
<li>SDIO_FLAG_STBITERR: Start bit not detected on all data signals in wide bus mode </li>
<li>SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed) </li>
<li>SDIO_FLAG_SDIOIT: SD I/O interrupt received </li>
<li>SDIO_FLAG_CEATAEND: CE-ATA command completion signal received for CMD61 </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="ga048e07fd86321cd01b2a22c071c3149b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SDIO_ClearITPendingBit </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>SDIO_IT</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the SDIO's interrupt pending bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">SDIO_IT</td><td>specifies the interrupt pending bit to clear. This parameter can be one or a combination of the following values: <ul>
<li>SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt </li>
<li>SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt </li>
<li>SDIO_IT_CTIMEOUT: Command response timeout interrupt </li>
<li>SDIO_IT_DTIMEOUT: Data timeout interrupt </li>
<li>SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt </li>
<li>SDIO_IT_RXOVERR: Received FIFO overrun error interrupt </li>
<li>SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt </li>
<li>SDIO_IT_CMDSENT: Command sent (no response required) interrupt </li>
<li>SDIO_IT_DATAEND: Data end (data counter, SDIO_DCOUNT, is zero) interrupt </li>
<li>SDIO_IT_STBITERR: Start bit not detected on all data signals in wide bus mode interrupt </li>
<li>SDIO_IT_SDIOIT: SD I/O interrupt received interrupt </li>
<li>SDIO_IT_CEATAEND: CE-ATA command completion signal received for CMD61 </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="ga644514b4b3c95c5c4326d99cd166f6f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FlagStatus SDIO_GetFlagStatus </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>SDIO_FLAG</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the specified SDIO flag is set or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">SDIO_FLAG</td><td>specifies the flag to check. This parameter can be one of the following values: <ul>
<li>SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed) </li>
<li>SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed) </li>
<li>SDIO_FLAG_CTIMEOUT: Command response timeout </li>
<li>SDIO_FLAG_DTIMEOUT: Data timeout </li>
<li>SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error </li>
<li>SDIO_FLAG_RXOVERR: Received FIFO overrun error </li>
<li>SDIO_FLAG_CMDREND: Command response received (CRC check passed) </li>
<li>SDIO_FLAG_CMDSENT: Command sent (no response required) </li>
<li>SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero) </li>
<li>SDIO_FLAG_STBITERR: Start bit not detected on all data signals in wide bus mode. </li>
<li>SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed) </li>
<li>SDIO_FLAG_CMDACT: Command transfer in progress </li>
<li>SDIO_FLAG_TXACT: Data transmit in progress </li>
<li>SDIO_FLAG_RXACT: Data receive in progress </li>
<li>SDIO_FLAG_TXFIFOHE: Transmit FIFO Half Empty </li>
<li>SDIO_FLAG_RXFIFOHF: Receive FIFO Half Full </li>
<li>SDIO_FLAG_TXFIFOF: Transmit FIFO full </li>
<li>SDIO_FLAG_RXFIFOF: Receive FIFO full </li>
<li>SDIO_FLAG_TXFIFOE: Transmit FIFO empty </li>
<li>SDIO_FLAG_RXFIFOE: Receive FIFO empty </li>
<li>SDIO_FLAG_TXDAVL: Data available in transmit FIFO </li>
<li>SDIO_FLAG_RXDAVL: Data available in receive FIFO </li>
<li>SDIO_FLAG_SDIOIT: SD I/O interrupt received </li>
<li>SDIO_FLAG_CEATAEND: CE-ATA command completion signal received for CMD61 </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>new state of SDIO_FLAG (SET or RESET). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga2d64af1f3df0f99cb518f9a89bbd02ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ITStatus SDIO_GetITStatus </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>SDIO_IT</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the specified SDIO interrupt has occurred or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">SDIO_IT</td><td>specifies the SDIO interrupt source to check. This parameter can be one of the following values: <ul>
<li>SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt </li>
<li>SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt </li>
<li>SDIO_IT_CTIMEOUT: Command response timeout interrupt </li>
<li>SDIO_IT_DTIMEOUT: Data timeout interrupt </li>
<li>SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt </li>
<li>SDIO_IT_RXOVERR: Received FIFO overrun error interrupt </li>
<li>SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt </li>
<li>SDIO_IT_CMDSENT: Command sent (no response required) interrupt </li>
<li>SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt </li>
<li>SDIO_IT_STBITERR: Start bit not detected on all data signals in wide bus mode interrupt </li>
<li>SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt </li>
<li>SDIO_IT_CMDACT: Command transfer in progress interrupt </li>
<li>SDIO_IT_TXACT: Data transmit in progress interrupt </li>
<li>SDIO_IT_RXACT: Data receive in progress interrupt </li>
<li>SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt </li>
<li>SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt </li>
<li>SDIO_IT_TXFIFOF: Transmit FIFO full interrupt </li>
<li>SDIO_IT_RXFIFOF: Receive FIFO full interrupt </li>
<li>SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt </li>
<li>SDIO_IT_RXFIFOE: Receive FIFO empty interrupt </li>
<li>SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt </li>
<li>SDIO_IT_RXDAVL: Data available in receive FIFO interrupt </li>
<li>SDIO_IT_SDIOIT: SD I/O interrupt received interrupt </li>
<li>SDIO_IT_CEATAEND: CE-ATA command completion signal received for CMD61 interrupt </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>new state of SDIO_IT (SET or RESET). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga208f51237ef43288735829dbaed37f00"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SDIO_ITConfig </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>SDIO_IT</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 SDIO interrupts. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">SDIO_IT</td><td>specifies the SDIO interrupt sources to be enabled or disabled. This parameter can be one or a combination of the following values: <ul>
<li>SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt </li>
<li>SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt </li>
<li>SDIO_IT_CTIMEOUT: Command response timeout interrupt </li>
<li>SDIO_IT_DTIMEOUT: Data timeout interrupt </li>
<li>SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt </li>
<li>SDIO_IT_RXOVERR: Received FIFO overrun error interrupt </li>
<li>SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt </li>
<li>SDIO_IT_CMDSENT: Command sent (no response required) interrupt </li>
<li>SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt </li>
<li>SDIO_IT_STBITERR: Start bit not detected on all data signals in wide bus mode interrupt </li>
<li>SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt </li>
<li>SDIO_IT_CMDACT: Command transfer in progress interrupt </li>
<li>SDIO_IT_TXACT: Data transmit in progress interrupt </li>
<li>SDIO_IT_RXACT: Data receive in progress interrupt </li>
<li>SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt </li>
<li>SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt </li>
<li>SDIO_IT_TXFIFOF: Transmit FIFO full interrupt </li>
<li>SDIO_IT_RXFIFOF: Receive FIFO full interrupt </li>
<li>SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt </li>
<li>SDIO_IT_RXFIFOE: Receive FIFO empty interrupt </li>
<li>SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt </li>
<li>SDIO_IT_RXDAVL: Data available in receive FIFO interrupt </li>
<li>SDIO_IT_SDIOIT: SD I/O interrupt received interrupt </li>
<li>SDIO_IT_CEATAEND: CE-ATA command completion signal received for CMD61 interrupt </li>
</ul>
</td></tr>
<tr><td class="paramname">NewState</td><td>new state of the specified SDIO interrupts. 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>