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

397 lines
20 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: Initialization and Configuration 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">Initialization and Configuration 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___c_a_n.html">CAN</a> &raquo; <a class="el" href="group___c_a_n___private___functions.html">CAN_Private_Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Initialization and Configuration functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Initialization and Configuration functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___c_a_n___group1.png" border="0" alt="" usemap="#group______c__a__n______group1"/>
<map name="group______c__a__n______group1" id="group______c__a__n______group1">
<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:ga002b74cd69574a14b17ad445090245cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#ga002b74cd69574a14b17ad445090245cd">CAN_DeInit</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx)</td></tr>
<tr class="memdesc:ga002b74cd69574a14b17ad445090245cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitializes the CAN peripheral registers to their default reset values. <a href="#ga002b74cd69574a14b17ad445090245cd">More...</a><br /></td></tr>
<tr class="separator:ga002b74cd69574a14b17ad445090245cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9023c35a9ab931ad4513fc5d19b4bd6c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#ga9023c35a9ab931ad4513fc5d19b4bd6c">CAN_Init</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, <a class="el" href="struct_c_a_n___init_type_def.html">CAN_InitTypeDef</a> *CAN_InitStruct)</td></tr>
<tr class="memdesc:ga9023c35a9ab931ad4513fc5d19b4bd6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the CAN peripheral according to the specified parameters in the CAN_InitStruct. <a href="#ga9023c35a9ab931ad4513fc5d19b4bd6c">More...</a><br /></td></tr>
<tr class="separator:ga9023c35a9ab931ad4513fc5d19b4bd6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39476830280340363c51041be6b12647"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#ga39476830280340363c51041be6b12647">CAN_FilterInit</a> (<a class="el" href="struct_c_a_n___filter_init_type_def.html">CAN_FilterInitTypeDef</a> *CAN_FilterInitStruct)</td></tr>
<tr class="memdesc:ga39476830280340363c51041be6b12647"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the CAN reception filter according to the specified parameters in the CAN_FilterInitStruct. <a href="#ga39476830280340363c51041be6b12647">More...</a><br /></td></tr>
<tr class="separator:ga39476830280340363c51041be6b12647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad77ad810868ed111755fc9e8ae0c7646"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#gad77ad810868ed111755fc9e8ae0c7646">CAN_StructInit</a> (<a class="el" href="struct_c_a_n___init_type_def.html">CAN_InitTypeDef</a> *CAN_InitStruct)</td></tr>
<tr class="memdesc:gad77ad810868ed111755fc9e8ae0c7646"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each CAN_InitStruct member with its default value. <a href="#gad77ad810868ed111755fc9e8ae0c7646">More...</a><br /></td></tr>
<tr class="separator:gad77ad810868ed111755fc9e8ae0c7646"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga109ff8960bc59f44b984c9646f17b3c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#ga109ff8960bc59f44b984c9646f17b3c0">CAN_SlaveStartBank</a> (uint8_t CAN_BankNumber)</td></tr>
<tr class="memdesc:ga109ff8960bc59f44b984c9646f17b3c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select the start bank filter for slave CAN. <a href="#ga109ff8960bc59f44b984c9646f17b3c0">More...</a><br /></td></tr>
<tr class="separator:ga109ff8960bc59f44b984c9646f17b3c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0e2d33e08caf49d1f1251f0dcc20213"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#gac0e2d33e08caf49d1f1251f0dcc20213">CAN_DBGFreeze</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, FunctionalState NewState)</td></tr>
<tr class="memdesc:gac0e2d33e08caf49d1f1251f0dcc20213"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the DBG Freeze for CAN. <a href="#gac0e2d33e08caf49d1f1251f0dcc20213">More...</a><br /></td></tr>
<tr class="separator:gac0e2d33e08caf49d1f1251f0dcc20213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94740177bab153ca5b102d122f9a8cca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group1.html#ga94740177bab153ca5b102d122f9a8cca">CAN_TTComModeCmd</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, FunctionalState NewState)</td></tr>
<tr class="memdesc:ga94740177bab153ca5b102d122f9a8cca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the CAN Time TriggerOperation communication mode. <a href="#ga94740177bab153ca5b102d122f9a8cca">More...</a><br /></td></tr>
<tr class="separator:ga94740177bab153ca5b102d122f9a8cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Initialization and Configuration functions. </p>
<pre class="fragment"> ===============================================================================
##### Initialization and Configuration functions #####
===============================================================================
[..] This section provides functions allowing to
(+) Initialize the CAN peripherals : Prescaler, operating mode, the maximum
number of time quanta to perform resynchronization, the number of time
quanta in Bit Segment 1 and 2 and many other modes.
Refer to @ref CAN_InitTypeDef for more details.
(+) Configures the CAN reception filter.
(+) Select the start bank filter for slave CAN.
(+) Enables or disables the Debug Freeze mode for CAN
(+)Enables or disables the CAN Time Trigger Operation communication mode</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gac0e2d33e08caf49d1f1251f0dcc20213"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAN_DBGFreeze </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *&#160;</td>
<td class="paramname"><em>CANx</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 DBG Freeze for CAN. </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 to select the CAN peripheral. </td></tr>
<tr><td class="paramname">NewState</td><td>new state of the CAN peripheral. This parameter can be: ENABLE (CAN reception/transmission is frozen during debug. Reception FIFOs can still be accessed/controlled normally) or DISABLE (CAN is working during debug). </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="ga002b74cd69574a14b17ad445090245cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAN_DeInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *&#160;</td>
<td class="paramname"><em>CANx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitializes the CAN peripheral registers to their default reset values. </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">None.</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___c_a_n___group1_ga002b74cd69574a14b17ad445090245cd_cgraph.png" border="0" usemap="#group___c_a_n___group1_ga002b74cd69574a14b17ad445090245cd_cgraph" alt=""/></div>
<map name="group___c_a_n___group1_ga002b74cd69574a14b17ad445090245cd_cgraph" id="group___c_a_n___group1_ga002b74cd69574a14b17ad445090245cd_cgraph">
<area shape="rect" id="node2" href="group___r_c_c.html#gab197ae4369c10b92640a733b40ed2801" title="Forces or releases Low Speed APB (APB1) peripheral reset. " alt="" coords="143,5,331,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga39476830280340363c51041be6b12647"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAN_FilterInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_c_a_n___filter_init_type_def.html">CAN_FilterInitTypeDef</a> *&#160;</td>
<td class="paramname"><em>CAN_FilterInitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the CAN reception filter according to the specified parameters in the CAN_FilterInitStruct. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">CAN_FilterInitStruct</td><td>pointer to a <a class="el" href="struct_c_a_n___filter_init_type_def.html" title="CAN filter init structure definition. ">CAN_FilterInitTypeDef</a> structure that contains the configuration information. </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="ga9023c35a9ab931ad4513fc5d19b4bd6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CAN_Init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *&#160;</td>
<td class="paramname"><em>CANx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_c_a_n___init_type_def.html">CAN_InitTypeDef</a> *&#160;</td>
<td class="paramname"><em>CAN_InitStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the CAN peripheral according to the specified parameters in the CAN_InitStruct. </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>
<tr><td class="paramname">CAN_InitStruct</td><td>pointer to a <a class="el" href="struct_c_a_n___init_type_def.html" title="CAN init structure definition. ">CAN_InitTypeDef</a> structure that contains the configuration information for the CAN peripheral. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">Constant</td><td>indicates initialization succeed which will be CAN_InitStatus_Failed or CAN_InitStatus_Success. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga109ff8960bc59f44b984c9646f17b3c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAN_SlaveStartBank </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>CAN_BankNumber</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Select the start bank filter for slave CAN. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">CAN_BankNumber</td><td>Select the start slave bank filter from 1..27. </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="gad77ad810868ed111755fc9e8ae0c7646"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAN_StructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_c_a_n___init_type_def.html">CAN_InitTypeDef</a> *&#160;</td>
<td class="paramname"><em>CAN_InitStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each CAN_InitStruct member with its default value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">CAN_InitStruct</td><td>pointer to a <a class="el" href="struct_c_a_n___init_type_def.html" title="CAN init structure definition. ">CAN_InitTypeDef</a> structure which ill be initialized. </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="ga94740177bab153ca5b102d122f9a8cca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAN_TTComModeCmd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *&#160;</td>
<td class="paramname"><em>CANx</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 CAN Time TriggerOperation communication mode. </p>
<dl class="section note"><dt>Note</dt><dd>DLC must be programmed as 8 in order Time Stamp (2 bytes) to be sent over the CAN bus. </dd></dl>
<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 to select the CAN peripheral. </td></tr>
<tr><td class="paramname">NewState</td><td>Mode new state. This parameter can be: ENABLE or DISABLE. When enabled, Time stamp (TIME[15:0]) value is sent in the last two data bytes of the 8-byte message: TIME[7:0] in data byte 6 and TIME[15:8] in data byte 7. </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 &#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>