Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
359
group___d_m_a2_d___group2.html
Normal file
359
group___d_m_a2_d___group2.html
Normal file
@@ -0,0 +1,359 @@
|
||||
<!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 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">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> » <a class="el" href="group___d_m_a2_d.html">DMA2D</a> » <a class="el" href="group___d_m_a2_d___private___functions.html">DMA2D_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___d_m_a2_d___group2.png" border="0" alt="" usemap="#group______d__m__a2__d______group2"/>
|
||||
<map name="group______d__m__a2__d______group2" id="group______d__m__a2__d______group2">
|
||||
<area shape="rect" id="node1" href="group___d_m_a2_d___private___functions.html" title="DMA2D_Private_Functions" alt="" coords="5,13,183,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:ga3fc15435114e68309ef68f27601e6380"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_m_a2_d___group2.html#ga3fc15435114e68309ef68f27601e6380">DMA2D_ITConfig</a> (uint32_t DMA2D_IT, FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga3fc15435114e68309ef68f27601e6380"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the specified DMA2D's interrupts. <a href="#ga3fc15435114e68309ef68f27601e6380">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga3fc15435114e68309ef68f27601e6380"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae1483989ec0d10770d675be1d5685ee5"><td class="memItemLeft" align="right" valign="top">FlagStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_m_a2_d___group2.html#gae1483989ec0d10770d675be1d5685ee5">DMA2D_GetFlagStatus</a> (uint32_t DMA2D_FLAG)</td></tr>
|
||||
<tr class="memdesc:gae1483989ec0d10770d675be1d5685ee5"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified DMA2D's flag is set or not. <a href="#gae1483989ec0d10770d675be1d5685ee5">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae1483989ec0d10770d675be1d5685ee5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga410d57eea7e439c14b2d9769f1d20331"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_m_a2_d___group2.html#ga410d57eea7e439c14b2d9769f1d20331">DMA2D_ClearFlag</a> (uint32_t DMA2D_FLAG)</td></tr>
|
||||
<tr class="memdesc:ga410d57eea7e439c14b2d9769f1d20331"><td class="mdescLeft"> </td><td class="mdescRight">Clears the DMA2D's pending flags. <a href="#ga410d57eea7e439c14b2d9769f1d20331">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga410d57eea7e439c14b2d9769f1d20331"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga01ae939d3f2c4209130d1b080c081635"><td class="memItemLeft" align="right" valign="top">ITStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_m_a2_d___group2.html#ga01ae939d3f2c4209130d1b080c081635">DMA2D_GetITStatus</a> (uint32_t DMA2D_IT)</td></tr>
|
||||
<tr class="memdesc:ga01ae939d3f2c4209130d1b080c081635"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified DMA2D's interrupt has occurred or not. <a href="#ga01ae939d3f2c4209130d1b080c081635">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga01ae939d3f2c4209130d1b080c081635"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2c88bd36b0d89abd8ba6d4f34eb8b701"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_m_a2_d___group2.html#ga2c88bd36b0d89abd8ba6d4f34eb8b701">DMA2D_ClearITPendingBit</a> (uint32_t DMA2D_IT)</td></tr>
|
||||
<tr class="memdesc:ga2c88bd36b0d89abd8ba6d4f34eb8b701"><td class="mdescLeft"> </td><td class="mdescRight">Clears the DMA2D's interrupt pending bits. <a href="#ga2c88bd36b0d89abd8ba6d4f34eb8b701">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2c88bd36b0d89abd8ba6d4f34eb8b701"><td class="memSeparator" colspan="2"> </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 #####
|
||||
===============================================================================
|
||||
|
||||
[..] This section provides functions allowing to configure the DMA2D
|
||||
Interrupts and to get the status and clear flags and Interrupts
|
||||
pending bits.
|
||||
[..] The DMA2D provides 6 Interrupts sources and 6 Flags
|
||||
|
||||
*** Flags ***
|
||||
=============
|
||||
[..]
|
||||
(+) DMA2D_FLAG_CE : Configuration Error Interrupt flag
|
||||
(+) DMA2D_FLAG_CAE: CLUT Access Error Interrupt flag
|
||||
(+) DMA2D_FLAG_TW: Transfer Watermark Interrupt flag
|
||||
(+) DMA2D_FLAG_TC: Transfer Complete interrupt flag
|
||||
(+) DMA2D_FLAG_TE: Transfer Error interrupt flag
|
||||
(+) DMA2D_FLAG_CTC: CLUT Transfer Complete Interrupt flag
|
||||
|
||||
*** Interrupts ***
|
||||
==================
|
||||
[..]
|
||||
(+) DMA2D_IT_CE: Configuration Error Interrupt is generated when a wrong
|
||||
configuration is detected
|
||||
(+) DMA2D_IT_CAE: CLUT Access Error Interrupt
|
||||
(+) DMA2D_IT_TW: Transfer Watermark Interrupt is generated when
|
||||
the programmed watermark is reached
|
||||
(+) DMA2D_IT_TE: Transfer Error interrupt is generated when the CPU trying
|
||||
to access the CLUT while a CLUT loading or a DMA2D1 transfer
|
||||
is on going
|
||||
(+) DMA2D_IT_CTC: CLUT Transfer Complete Interrupt
|
||||
(+) DMA2D_IT_TC: Transfer Complete interrupt
|
||||
</pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga410d57eea7e439c14b2d9769f1d20331"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void DMA2D_ClearFlag </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>DMA2D_FLAG</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Clears the DMA2D's pending flags. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">DMA2D_FLAG</td><td>specifies the flag to clear. This parameter can be any combination of the following values: <ul>
|
||||
<li>DMA2D_FLAG_CE: Configuration Error Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_CTC: CLUT Transfer Complete Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_CAE: CLUT Access Error Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_TW: Transfer Watermark Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_TC: Transfer Complete interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_TE: Transfer Error interrupt flag. </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="ga2c88bd36b0d89abd8ba6d4f34eb8b701"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void DMA2D_ClearITPendingBit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>DMA2D_IT</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Clears the DMA2D's interrupt pending bits. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">DMA2D_IT</td><td>specifies the interrupt pending bit to clear. This parameter can be any combination of the following values: <ul>
|
||||
<li>DMA2D_IT_CE: Configuration Error Interrupt. </li>
|
||||
<li>DMA2D_IT_CTC: CLUT Transfer Complete Interrupt. </li>
|
||||
<li>DMA2D_IT_CAE: CLUT Access Error Interrupt. </li>
|
||||
<li>DMA2D_IT_TW: Transfer Watermark Interrupt. </li>
|
||||
<li>DMA2D_IT_TC: Transfer Complete interrupt. </li>
|
||||
<li>DMA2D_IT_TE: Transfer Error interrupt. </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="gae1483989ec0d10770d675be1d5685ee5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">FlagStatus DMA2D_GetFlagStatus </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>DMA2D_FLAG</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks whether the specified DMA2D's flag is set or not. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">DMA2D_FLAG</td><td>specifies the flag to check. This parameter can be one of the following values: <ul>
|
||||
<li>DMA2D_FLAG_CE: Configuration Error Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_CTC: CLUT Transfer Complete Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_CAE: CLUT Access Error Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_TW: Transfer Watermark Interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_TC: Transfer Complete interrupt flag. </li>
|
||||
<li>DMA2D_FLAG_TE: Transfer Error interrupt flag. </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 DMA2D_FLAG (SET or RESET). </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga01ae939d3f2c4209130d1b080c081635"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ITStatus DMA2D_GetITStatus </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>DMA2D_IT</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks whether the specified DMA2D's interrupt has occurred or not. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">DMA2D_IT</td><td>specifies the DMA2D interrupts sources to check. This parameter can be one of the following values: <ul>
|
||||
<li>DMA2D_IT_CE: Configuration Error Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_CTC: CLUT Transfer Complete Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_CAE: CLUT Access Error Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_TW: Transfer Watermark Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_TC: Transfer Complete interrupt enable. </li>
|
||||
<li>DMA2D_IT_TE: Transfer Error interrupt enable. </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 the DMA2D_IT (SET or RESET). </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga3fc15435114e68309ef68f27601e6380"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void DMA2D_ITConfig </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>DMA2D_IT</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 DMA2D's interrupts. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">DMA2D_IT</td><td>specifies the DMA2D interrupts sources to be enabled or disabled. This parameter can be any combination of the following values: <ul>
|
||||
<li>DMA2D_IT_CE: Configuration Error Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_CTC: CLUT Transfer Complete Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_CAE: CLUT Access Error Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_TW: Transfer Watermark Interrupt Enable. </li>
|
||||
<li>DMA2D_IT_TC: Transfer Complete interrupt enable. </li>
|
||||
<li>DMA2D_IT_TE: Transfer Error interrupt enable. </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">NewState</td><td>new state of the specified DMA2D 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: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>
|
||||
Reference in New Issue
Block a user