234 lines
11 KiB
HTML
234 lines
11 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: IrDA mode 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">IrDA mode 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___u_s_a_r_t.html">USART</a> » <a class="el" href="group___u_s_a_r_t___private___functions.html">USART_Private_Functions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>IrDA mode functions.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for IrDA mode functions:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group___u_s_a_r_t___group7.png" border="0" alt="" usemap="#group______u__s__a__r__t______group7"/>
|
|
<map name="group______u__s__a__r__t______group7" id="group______u__s__a__r__t______group7">
|
|
<area shape="rect" id="node2" href="group___u_s_a_r_t___private___functions.html" title="USART_Private_Functions" alt="" coords="5,5,180,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:ga81a0cd36199040bf6d266b57babd678e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_a_r_t___group7.html#ga81a0cd36199040bf6d266b57babd678e">USART_IrDAConfig</a> (<a class="el" href="struct_u_s_a_r_t___type_def.html">USART_TypeDef</a> *USARTx, uint16_t USART_IrDAMode)</td></tr>
|
|
<tr class="memdesc:ga81a0cd36199040bf6d266b57babd678e"><td class="mdescLeft"> </td><td class="mdescRight">Configures the USART's IrDA interface. <a href="#ga81a0cd36199040bf6d266b57babd678e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga81a0cd36199040bf6d266b57babd678e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabff56ebb494fdfadcc6ef4fe9ac8dd24"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_a_r_t___group7.html#gabff56ebb494fdfadcc6ef4fe9ac8dd24">USART_IrDACmd</a> (<a class="el" href="struct_u_s_a_r_t___type_def.html">USART_TypeDef</a> *USARTx, FunctionalState NewState)</td></tr>
|
|
<tr class="memdesc:gabff56ebb494fdfadcc6ef4fe9ac8dd24"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the USART's IrDA interface. <a href="#gabff56ebb494fdfadcc6ef4fe9ac8dd24">More...</a><br /></td></tr>
|
|
<tr class="separator:gabff56ebb494fdfadcc6ef4fe9ac8dd24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>IrDA mode functions. </p>
|
|
<pre class="fragment"> ===============================================================================
|
|
##### IrDA mode functions #####
|
|
===============================================================================
|
|
[..]
|
|
This subsection provides a set of functions allowing to manage the USART
|
|
IrDA communication.
|
|
[..]
|
|
IrDA is a half duplex communication protocol. If the Transmitter is busy, any data
|
|
on the IrDA receive line will be ignored by the IrDA decoder and if the Receiver
|
|
is busy, data on the TX from the USART to IrDA will not be encoded by IrDA.
|
|
While receiving data, transmission should be avoided as the data to be transmitted
|
|
could be corrupted.
|
|
[..]
|
|
IrDA communication is possible through the following procedure:
|
|
(#) Program the Baud rate, Word length = 8 bits, Stop bits, Parity, Transmitter/Receiver
|
|
modes and hardware flow control values using the USART_Init() function.
|
|
(#) Enable the USART using the USART_Cmd() function.
|
|
(#) Configures the IrDA pulse width by configuring the prescaler using
|
|
the USART_SetPrescaler() function.
|
|
(#) Configures the IrDA USART_IrDAMode_LowPower or USART_IrDAMode_Normal mode
|
|
using the USART_IrDAConfig() function.
|
|
(#) Enable the IrDA using the USART_IrDACmd() function.
|
|
|
|
-@- A pulse of width less than two and greater than one PSC period(s) may or may
|
|
not be rejected.
|
|
-@- The receiver set up time should be managed by software. The IrDA physical layer
|
|
specification specifies a minimum of 10 ms delay between transmission and
|
|
reception (IrDA is a half duplex protocol).
|
|
-@- In IrDA mode, the following bits must be kept cleared:
|
|
(+@) LINEN, STOP and CLKEN bits in the USART_CR2 register.
|
|
(+@) SCEN and HDSEL bits in the USART_CR3 register.</pre> <h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gabff56ebb494fdfadcc6ef4fe9ac8dd24"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART_IrDACmd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_u_s_a_r_t___type_def.html">USART_TypeDef</a> * </td>
|
|
<td class="paramname"><em>USARTx</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 USART's IrDA interface. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">USARTx</td><td>where x can be 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or UART peripheral. </td></tr>
|
|
<tr><td class="paramname">NewState</td><td>new state of the IrDA mode. 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="ga81a0cd36199040bf6d266b57babd678e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART_IrDAConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_u_s_a_r_t___type_def.html">USART_TypeDef</a> * </td>
|
|
<td class="paramname"><em>USARTx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>USART_IrDAMode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures the USART's IrDA interface. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">USARTx</td><td>where x can be 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or UART peripheral. </td></tr>
|
|
<tr><td class="paramname">USART_IrDAMode</td><td>specifies the IrDA mode. This parameter can be one of the following values: <ul>
|
|
<li>USART_IrDAMode_LowPower </li>
|
|
<li>USART_IrDAMode_Normal </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>
|
|
</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>
|