231 lines
10 KiB
HTML
231 lines
10 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: CAN Operation modes 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">CAN Operation modes 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___c_a_n.html">CAN</a> » <a class="el" href="group___c_a_n___private___functions.html">CAN_Private_Functions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>CAN Operation modes functions.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for CAN Operation modes functions:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group___c_a_n___group4.png" border="0" alt="" usemap="#group______c__a__n______group4"/>
|
|
<map name="group______c__a__n______group4" id="group______c__a__n______group4">
|
|
<area shape="rect" id="node1" href="group___c_a_n___private___functions.html" title="CAN_Private_Functions" alt="" coords="5,13,164,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:gab2a3630e9e3024114eb117d14e514208"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group4.html#gab2a3630e9e3024114eb117d14e514208">CAN_OperatingModeRequest</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, uint8_t CAN_OperatingMode)</td></tr>
|
|
<tr class="memdesc:gab2a3630e9e3024114eb117d14e514208"><td class="mdescLeft"> </td><td class="mdescRight">Selects the CAN Operation mode. <a href="#gab2a3630e9e3024114eb117d14e514208">More...</a><br /></td></tr>
|
|
<tr class="separator:gab2a3630e9e3024114eb117d14e514208"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga640215e38765759d7eceb8a039046667"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group4.html#ga640215e38765759d7eceb8a039046667">CAN_Sleep</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx)</td></tr>
|
|
<tr class="memdesc:ga640215e38765759d7eceb8a039046667"><td class="mdescLeft"> </td><td class="mdescRight">Enters the Sleep (low power) mode. <a href="#ga640215e38765759d7eceb8a039046667">More...</a><br /></td></tr>
|
|
<tr class="separator:ga640215e38765759d7eceb8a039046667"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga78cdfbf1884b9e33c552bcbca15bed10"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group4.html#ga78cdfbf1884b9e33c552bcbca15bed10">CAN_WakeUp</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx)</td></tr>
|
|
<tr class="memdesc:ga78cdfbf1884b9e33c552bcbca15bed10"><td class="mdescLeft"> </td><td class="mdescRight">Wakes up the CAN peripheral from sleep mode . <a href="#ga78cdfbf1884b9e33c552bcbca15bed10">More...</a><br /></td></tr>
|
|
<tr class="separator:ga78cdfbf1884b9e33c552bcbca15bed10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>CAN Operation modes functions. </p>
|
|
<pre class="fragment"> ===============================================================================
|
|
##### CAN Operation modes functions #####
|
|
===============================================================================
|
|
[..] This section provides functions allowing to select the CAN Operation modes
|
|
(+) sleep mode
|
|
(+) normal mode
|
|
(+) initialization mode</pre> <h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gab2a3630e9e3024114eb117d14e514208"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t CAN_OperatingModeRequest </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> * </td>
|
|
<td class="paramname"><em>CANx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>CAN_OperatingMode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Selects the CAN Operation mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">CAN_OperatingMode</td><td>CAN Operating Mode. This parameter can be one of CAN_OperatingMode_TypeDef enumeration. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">status</td><td>of the requested mode which can be<ul>
|
|
<li>CAN_ModeStatus_Failed: CAN failed entering the specific mode</li>
|
|
<li>CAN_ModeStatus_Success: CAN Succeed entering the specific mode </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga640215e38765759d7eceb8a039046667"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t CAN_Sleep </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> * </td>
|
|
<td class="paramname"><em>CANx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enters the Sleep (low power) mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">CANx</td><td>where x can be 1 or 2 to select the CAN peripheral. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">CAN_Sleep_Ok</td><td>if sleep entered, CAN_Sleep_Failed otherwise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga78cdfbf1884b9e33c552bcbca15bed10"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t CAN_WakeUp </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> * </td>
|
|
<td class="paramname"><em>CANx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Wakes up the CAN peripheral from sleep mode . </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">CANx</td><td>where x can be 1 or 2 to select the CAN peripheral. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">CAN_WakeUp_Ok</td><td>if sleep mode left, CAN_WakeUp_Failed otherwise. </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>
|