Files
discoverpixy/group___l_t_d_c___group2.html
2015-05-12 11:12:43 +02:00

347 lines
16 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: 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___l_t_d_c.html">LTDC</a> &raquo; <a class="el" href="group___l_t_d_c___private___functions.html">LTDC_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___l_t_d_c___group2.png" border="0" alt="" usemap="#group______l__t__d__c______group2"/>
<map name="group______l__t__d__c______group2" id="group______l__t__d__c______group2">
<area shape="rect" id="node1" href="group___l_t_d_c___private___functions.html" title="LTDC_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:gacc0421b1cf7a18500533ae261c0ef678"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_t_d_c___group2.html#gacc0421b1cf7a18500533ae261c0ef678">LTDC_ITConfig</a> (uint32_t LTDC_IT, FunctionalState NewState)</td></tr>
<tr class="memdesc:gacc0421b1cf7a18500533ae261c0ef678"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the specified LTDC's interrupts. <a href="#gacc0421b1cf7a18500533ae261c0ef678">More...</a><br /></td></tr>
<tr class="separator:gacc0421b1cf7a18500533ae261c0ef678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f944f88b3be1aadbf8644dac420460d"><td class="memItemLeft" align="right" valign="top">FlagStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_t_d_c___group2.html#ga2f944f88b3be1aadbf8644dac420460d">LTDC_GetFlagStatus</a> (uint32_t LTDC_FLAG)</td></tr>
<tr class="memdesc:ga2f944f88b3be1aadbf8644dac420460d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the specified LTDC's flag is set or not. <a href="#ga2f944f88b3be1aadbf8644dac420460d">More...</a><br /></td></tr>
<tr class="separator:ga2f944f88b3be1aadbf8644dac420460d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab509e7312fda8fa91604e6c83c88d39f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_t_d_c___group2.html#gab509e7312fda8fa91604e6c83c88d39f">LTDC_ClearFlag</a> (uint32_t LTDC_FLAG)</td></tr>
<tr class="memdesc:gab509e7312fda8fa91604e6c83c88d39f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the LTDC's pending flags. <a href="#gab509e7312fda8fa91604e6c83c88d39f">More...</a><br /></td></tr>
<tr class="separator:gab509e7312fda8fa91604e6c83c88d39f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81c69fd7e796d1345507948788e98aac"><td class="memItemLeft" align="right" valign="top">ITStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_t_d_c___group2.html#ga81c69fd7e796d1345507948788e98aac">LTDC_GetITStatus</a> (uint32_t LTDC_IT)</td></tr>
<tr class="memdesc:ga81c69fd7e796d1345507948788e98aac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the specified LTDC's interrupt has occurred or not. <a href="#ga81c69fd7e796d1345507948788e98aac">More...</a><br /></td></tr>
<tr class="separator:ga81c69fd7e796d1345507948788e98aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2adba2161d29b7eca6123ae67a46c112"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_t_d_c___group2.html#ga2adba2161d29b7eca6123ae67a46c112">LTDC_ClearITPendingBit</a> (uint32_t LTDC_IT)</td></tr>
<tr class="memdesc:ga2adba2161d29b7eca6123ae67a46c112"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the LTDC's interrupt pending bits. <a href="#ga2adba2161d29b7eca6123ae67a46c112">More...</a><br /></td></tr>
<tr class="separator:ga2adba2161d29b7eca6123ae67a46c112"><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 #####
===============================================================================
[..] This section provides functions allowing to configure the LTDC Interrupts
and to get the status and clear flags and Interrupts pending bits.
[..] The LTDC provides 4 Interrupts sources and 4 Flags
*** Flags ***
=============
[..]
(+) LTDC_FLAG_LI: Line Interrupt flag.
(+) LTDC_FLAG_FU: FIFO Underrun Interrupt flag.
(+) LTDC_FLAG_TERR: Transfer Error Interrupt flag.
(+) LTDC_FLAG_RR: Register Reload interrupt flag.
*** Interrupts ***
==================
[..]
(+) LTDC_IT_LI: Line Interrupt is generated when a programmed line
is reached. The line interrupt position is programmed in
the LTDC_LIPR register.
(+) LTDC_IT_FU: FIFO Underrun interrupt is generated when a pixel is requested
from an empty layer FIFO
(+) LTDC_IT_TERR: Transfer Error interrupt is generated when an AHB bus
error occurs during data transfer.
(+) LTDC_IT_RR: Register Reload interrupt is generated when the shadow
registers reload was performed during the vertical blanking
period.</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab509e7312fda8fa91604e6c83c88d39f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LTDC_ClearFlag </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>LTDC_FLAG</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the LTDC's pending flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">LTDC_FLAG</td><td>specifies the flag to clear. This parameter can be any combination of the following values: <ul>
<li>LTDC_FLAG_LI: <a class="el" href="struct_line.html">Line</a> Interrupt flag. </li>
<li>LTDC_FLAG_FU: FIFO Underrun Interrupt flag. </li>
<li>LTDC_FLAG_TERR: Transfer Error Interrupt flag. </li>
<li>LTDC_FLAG_RR: Register Reload 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="ga2adba2161d29b7eca6123ae67a46c112"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LTDC_ClearITPendingBit </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>LTDC_IT</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the LTDC's interrupt pending bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">LTDC_IT</td><td>specifies the interrupt pending bit to clear. This parameter can be any combination of the following values: <ul>
<li>LTDC_IT_LIE: <a class="el" href="struct_line.html">Line</a> Interrupt. </li>
<li>LTDC_IT_FUIE: FIFO Underrun Interrupt. </li>
<li>LTDC_IT_TERRIE: Transfer Error Interrupt. </li>
<li>LTDC_IT_RRIE: Register Reload 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="ga2f944f88b3be1aadbf8644dac420460d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FlagStatus LTDC_GetFlagStatus </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>LTDC_FLAG</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the specified LTDC's flag is set or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">LTDC_FLAG</td><td>specifies the flag to check. This parameter can be one of the following values: <ul>
<li>LTDC_FLAG_LI: <a class="el" href="struct_line.html">Line</a> Interrupt flag. </li>
<li>LTDC_FLAG_FU: FIFO Underrun Interrupt flag. </li>
<li>LTDC_FLAG_TERR: Transfer Error Interrupt flag. </li>
<li>LTDC_FLAG_RR: Register Reload 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 LTDC_FLAG (SET or RESET). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga81c69fd7e796d1345507948788e98aac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ITStatus LTDC_GetITStatus </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>LTDC_IT</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the specified LTDC's interrupt has occurred or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">LTDC_IT</td><td>specifies the LTDC interrupts sources to check. This parameter can be one of the following values: <ul>
<li>LTDC_IT_LI: <a class="el" href="struct_line.html">Line</a> Interrupt Enable. </li>
<li>LTDC_IT_FU: FIFO Underrun Interrupt Enable. </li>
<li>LTDC_IT_TERR: Transfer Error Interrupt Enable. </li>
<li>LTDC_IT_RR: Register Reload 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 LTDC_IT (SET or RESET). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gacc0421b1cf7a18500533ae261c0ef678"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LTDC_ITConfig </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>LTDC_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 specified LTDC's interrupts. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">LTDC_IT</td><td>specifies the LTDC interrupts sources to be enabled or disabled. This parameter can be any combination of the following values: <ul>
<li>LTDC_IT_LI: <a class="el" href="struct_line.html">Line</a> Interrupt Enable. </li>
<li>LTDC_IT_FU: FIFO Underrun Interrupt Enable. </li>
<li>LTDC_IT_TERR: Transfer Error Interrupt Enable. </li>
<li>LTDC_IT_RR: Register Reload interrupt enable. </li>
</ul>
</td></tr>
<tr><td class="paramname">NewState</td><td>new state of the specified LTDC 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>