Added doxygen output of current emulator branch.
This commit is contained in:
569
group___c_a_n___group6.html
Normal file
569
group___c_a_n___group6.html
Normal file
@@ -0,0 +1,569 @@
|
||||
<!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___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>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___c_a_n___group6.png" border="0" alt="" usemap="#group______c__a__n______group6"/>
|
||||
<map name="group______c__a__n______group6" id="group______c__a__n______group6">
|
||||
<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:gad1a8b2499a780b5bfa4accb3597b02f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group6.html#gad1a8b2499a780b5bfa4accb3597b02f4">CAN_ITConfig</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, uint32_t CAN_IT, FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:gad1a8b2499a780b5bfa4accb3597b02f4"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the specified CANx interrupts. <a href="#gad1a8b2499a780b5bfa4accb3597b02f4">More...</a><br /></td></tr>
|
||||
<tr class="separator:gad1a8b2499a780b5bfa4accb3597b02f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2faad96caf823ef463cc5b5b25c480bb"><td class="memItemLeft" align="right" valign="top">FlagStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group6.html#ga2faad96caf823ef463cc5b5b25c480bb">CAN_GetFlagStatus</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, uint32_t CAN_FLAG)</td></tr>
|
||||
<tr class="memdesc:ga2faad96caf823ef463cc5b5b25c480bb"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified CAN flag is set or not. <a href="#ga2faad96caf823ef463cc5b5b25c480bb">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2faad96caf823ef463cc5b5b25c480bb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2c01646d5d3a2d7045e8dd71f58f8742"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group6.html#ga2c01646d5d3a2d7045e8dd71f58f8742">CAN_ClearFlag</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, uint32_t CAN_FLAG)</td></tr>
|
||||
<tr class="memdesc:ga2c01646d5d3a2d7045e8dd71f58f8742"><td class="mdescLeft"> </td><td class="mdescRight">Clears the CAN's pending flags. <a href="#ga2c01646d5d3a2d7045e8dd71f58f8742">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2c01646d5d3a2d7045e8dd71f58f8742"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9aca05b3013e1b3438f3559f80b33c82"><td class="memItemLeft" align="right" valign="top">ITStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group6.html#ga9aca05b3013e1b3438f3559f80b33c82">CAN_GetITStatus</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, uint32_t CAN_IT)</td></tr>
|
||||
<tr class="memdesc:ga9aca05b3013e1b3438f3559f80b33c82"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified CANx interrupt has occurred or not. <a href="#ga9aca05b3013e1b3438f3559f80b33c82">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9aca05b3013e1b3438f3559f80b33c82"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga30bf7ac0c1793f6622a4a1adbb7dbc8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___group6.html#ga30bf7ac0c1793f6622a4a1adbb7dbc8a">CAN_ClearITPendingBit</a> (<a class="el" href="struct_c_a_n___type_def.html">CAN_TypeDef</a> *CANx, uint32_t CAN_IT)</td></tr>
|
||||
<tr class="memdesc:ga30bf7ac0c1793f6622a4a1adbb7dbc8a"><td class="mdescLeft"> </td><td class="mdescRight">Clears the CANx's interrupt pending bits. <a href="#ga30bf7ac0c1793f6622a4a1adbb7dbc8a">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga30bf7ac0c1793f6622a4a1adbb7dbc8a"><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 CAN Interrupts
|
||||
and to get the status and clear flags and Interrupts pending bits.
|
||||
|
||||
The CAN provides 14 Interrupts sources and 15 Flags:
|
||||
|
||||
|
||||
*** Flags ***
|
||||
=============
|
||||
[..] The 15 flags can be divided on 4 groups:
|
||||
|
||||
(+) Transmit Flags
|
||||
(++) CAN_FLAG_RQCP0,
|
||||
(++) CAN_FLAG_RQCP1,
|
||||
(++) CAN_FLAG_RQCP2 : Request completed MailBoxes 0, 1 and 2 Flags
|
||||
Set when when the last request (transmit or abort)
|
||||
has been performed.
|
||||
|
||||
(+) Receive Flags
|
||||
|
||||
|
||||
(++) CAN_FLAG_FMP0,
|
||||
(++) CAN_FLAG_FMP1 : FIFO 0 and 1 Message Pending Flags
|
||||
set to signal that messages are pending in the receive
|
||||
FIFO.
|
||||
These Flags are cleared only by hardware.
|
||||
|
||||
(++) CAN_FLAG_FF0,
|
||||
(++) CAN_FLAG_FF1 : FIFO 0 and 1 Full Flags
|
||||
set when three messages are stored in the selected
|
||||
FIFO.
|
||||
|
||||
(++) CAN_FLAG_FOV0
|
||||
(++) CAN_FLAG_FOV1 : FIFO 0 and 1 Overrun Flags
|
||||
set when a new message has been received and passed
|
||||
the filter while the FIFO was full.
|
||||
|
||||
(+) Operating Mode Flags
|
||||
|
||||
(++) CAN_FLAG_WKU : Wake up Flag
|
||||
set to signal that a SOF bit has been detected while
|
||||
the CAN hardware was in Sleep mode.
|
||||
|
||||
(++) CAN_FLAG_SLAK : Sleep acknowledge Flag
|
||||
Set to signal that the CAN has entered Sleep Mode.
|
||||
|
||||
(+) Error Flags
|
||||
|
||||
(++) CAN_FLAG_EWG : Error Warning Flag
|
||||
Set when the warning limit has been reached (Receive
|
||||
Error Counter or Transmit Error Counter greater than 96).
|
||||
This Flag is cleared only by hardware.
|
||||
|
||||
(++) CAN_FLAG_EPV : Error Passive Flag
|
||||
Set when the Error Passive limit has been reached
|
||||
(Receive Error Counter or Transmit Error Counter
|
||||
greater than 127).
|
||||
This Flag is cleared only by hardware.
|
||||
|
||||
(++) CAN_FLAG_BOF : Bus-Off Flag
|
||||
set when CAN enters the bus-off state. The bus-off
|
||||
state is entered on TEC overflow, greater than 255.
|
||||
This Flag is cleared only by hardware.
|
||||
|
||||
(++) CAN_FLAG_LEC : Last error code Flag
|
||||
set If a message has been transferred (reception or
|
||||
transmission) with error, and the error code is hold.
|
||||
|
||||
*** Interrupts ***
|
||||
==================
|
||||
[..] The 14 interrupts can be divided on 4 groups:
|
||||
|
||||
(+) Transmit interrupt
|
||||
|
||||
(++) CAN_IT_TME : Transmit mailbox empty Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
no transmit request are pending for Tx mailboxes.
|
||||
|
||||
(+) Receive Interrupts
|
||||
|
||||
(++) CAN_IT_FMP0,
|
||||
(++) CAN_IT_FMP1 : FIFO 0 and FIFO1 message pending Interrupts
|
||||
if enabled, these interrupt sources are pending
|
||||
when messages are pending in the receive FIFO.
|
||||
The corresponding interrupt pending bits are cleared
|
||||
only by hardware.
|
||||
|
||||
(++) CAN_IT_FF0,
|
||||
(++) CAN_IT_FF1 : FIFO 0 and FIFO1 full Interrupts
|
||||
if enabled, these interrupt sources are pending
|
||||
when three messages are stored in the selected FIFO.
|
||||
|
||||
(++) CAN_IT_FOV0,
|
||||
(++) CAN_IT_FOV1 : FIFO 0 and FIFO1 overrun Interrupts
|
||||
if enabled, these interrupt sources are pending
|
||||
when a new message has been received and passed
|
||||
the filter while the FIFO was full.
|
||||
|
||||
(+) Operating Mode Interrupts
|
||||
|
||||
(++) CAN_IT_WKU : Wake-up Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
a SOF bit has been detected while the CAN hardware
|
||||
was in Sleep mode.
|
||||
|
||||
(++) CAN_IT_SLK : Sleep acknowledge Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
the CAN has entered Sleep Mode.
|
||||
|
||||
(+) Error Interrupts
|
||||
|
||||
(++) CAN_IT_EWG : Error warning Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
the warning limit has been reached (Receive Error
|
||||
Counter or Transmit Error Counter=96).
|
||||
|
||||
(++) CAN_IT_EPV : Error passive Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
the Error Passive limit has been reached (Receive
|
||||
Error Counter or Transmit Error Counter>127).
|
||||
|
||||
(++) CAN_IT_BOF : Bus-off Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
CAN enters the bus-off state. The bus-off state is
|
||||
entered on TEC overflow, greater than 255.
|
||||
This Flag is cleared only by hardware.
|
||||
|
||||
(++) CAN_IT_LEC : Last error code Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
a message has been transferred (reception or
|
||||
transmission) with error, and the error code is hold.
|
||||
|
||||
(++) CAN_IT_ERR : Error Interrupt
|
||||
if enabled, this interrupt source is pending when
|
||||
an error condition is pending.
|
||||
|
||||
[..] Managing the CAN controller events :
|
||||
|
||||
The user should identify which mode will be used in his application to
|
||||
manage the CAN controller events: Polling mode or Interrupt mode.
|
||||
|
||||
(#) In the Polling Mode it is advised to use the following functions:
|
||||
(++) CAN_GetFlagStatus() : to check if flags events occur.
|
||||
(++) CAN_ClearFlag() : to clear the flags events.
|
||||
|
||||
|
||||
|
||||
(#) In the Interrupt Mode it is advised to use the following functions:
|
||||
(++) CAN_ITConfig() : to enable or disable the interrupt source.
|
||||
(++) CAN_GetITStatus() : to check if Interrupt occurs.
|
||||
(++) CAN_ClearITPendingBit() : to clear the Interrupt pending Bit
|
||||
(corresponding Flag).
|
||||
-@@- This function has no impact on CAN_IT_FMP0 and CAN_IT_FMP1 Interrupts
|
||||
pending bits since there are cleared only by hardware. </pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga2c01646d5d3a2d7045e8dd71f58f8742"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void CAN_ClearFlag </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">uint32_t </td>
|
||||
<td class="paramname"><em>CAN_FLAG</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Clears the CAN's pending flags. </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">CAN_FLAG</td><td>specifies the flag to clear. This parameter can be one of the following values: <ul>
|
||||
<li>CAN_FLAG_RQCP0: Request MailBox0 Flag </li>
|
||||
<li>CAN_FLAG_RQCP1: Request MailBox1 Flag </li>
|
||||
<li>CAN_FLAG_RQCP2: Request MailBox2 Flag </li>
|
||||
<li>CAN_FLAG_FF0: FIFO 0 Full Flag </li>
|
||||
<li>CAN_FLAG_FOV0: FIFO 0 Overrun Flag </li>
|
||||
<li>CAN_FLAG_FF1: FIFO 1 Full Flag </li>
|
||||
<li>CAN_FLAG_FOV1: FIFO 1 Overrun Flag </li>
|
||||
<li>CAN_FLAG_WKU: Wake up Flag </li>
|
||||
<li>CAN_FLAG_SLAK: Sleep acknowledge Flag </li>
|
||||
<li>CAN_FLAG_LEC: Last error code 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="ga30bf7ac0c1793f6622a4a1adbb7dbc8a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void CAN_ClearITPendingBit </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">uint32_t </td>
|
||||
<td class="paramname"><em>CAN_IT</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Clears the CANx's interrupt pending bits. </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">CAN_IT</td><td>specifies the interrupt pending bit to clear. This parameter can be one of the following values: <ul>
|
||||
<li>CAN_IT_TME: Transmit mailbox empty Interrupt </li>
|
||||
<li>CAN_IT_FF0: FIFO 0 full Interrupt </li>
|
||||
<li>CAN_IT_FOV0: FIFO 0 overrun Interrupt </li>
|
||||
<li>CAN_IT_FF1: FIFO 1 full Interrupt </li>
|
||||
<li>CAN_IT_FOV1: FIFO 1 overrun Interrupt </li>
|
||||
<li>CAN_IT_WKU: Wake-up Interrupt </li>
|
||||
<li>CAN_IT_SLK: Sleep acknowledge Interrupt </li>
|
||||
<li>CAN_IT_EWG: Error warning Interrupt </li>
|
||||
<li>CAN_IT_EPV: Error passive Interrupt </li>
|
||||
<li>CAN_IT_BOF: Bus-off Interrupt </li>
|
||||
<li>CAN_IT_LEC: Last error code Interrupt </li>
|
||||
<li>CAN_IT_ERR: 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="ga2faad96caf823ef463cc5b5b25c480bb"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">FlagStatus CAN_GetFlagStatus </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">uint32_t </td>
|
||||
<td class="paramname"><em>CAN_FLAG</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks whether the specified CAN flag is set or not. </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">CAN_FLAG</td><td>specifies the flag to check. This parameter can be one of the following values: <ul>
|
||||
<li>CAN_FLAG_RQCP0: Request MailBox0 Flag </li>
|
||||
<li>CAN_FLAG_RQCP1: Request MailBox1 Flag </li>
|
||||
<li>CAN_FLAG_RQCP2: Request MailBox2 Flag </li>
|
||||
<li>CAN_FLAG_FMP0: FIFO 0 Message Pending Flag </li>
|
||||
<li>CAN_FLAG_FF0: FIFO 0 Full Flag </li>
|
||||
<li>CAN_FLAG_FOV0: FIFO 0 Overrun Flag </li>
|
||||
<li>CAN_FLAG_FMP1: FIFO 1 Message Pending Flag </li>
|
||||
<li>CAN_FLAG_FF1: FIFO 1 Full Flag </li>
|
||||
<li>CAN_FLAG_FOV1: FIFO 1 Overrun Flag </li>
|
||||
<li>CAN_FLAG_WKU: Wake up Flag </li>
|
||||
<li>CAN_FLAG_SLAK: Sleep acknowledge Flag </li>
|
||||
<li>CAN_FLAG_EWG: Error Warning Flag </li>
|
||||
<li>CAN_FLAG_EPV: Error Passive Flag </li>
|
||||
<li>CAN_FLAG_BOF: Bus-Off Flag </li>
|
||||
<li>CAN_FLAG_LEC: Last error code 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 CAN_FLAG (SET or RESET). </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga9aca05b3013e1b3438f3559f80b33c82"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ITStatus CAN_GetITStatus </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">uint32_t </td>
|
||||
<td class="paramname"><em>CAN_IT</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks whether the specified CANx interrupt has occurred or not. </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">CAN_IT</td><td>specifies the CAN interrupt source to check. This parameter can be one of the following values: <ul>
|
||||
<li>CAN_IT_TME: Transmit mailbox empty Interrupt </li>
|
||||
<li>CAN_IT_FMP0: FIFO 0 message pending Interrupt </li>
|
||||
<li>CAN_IT_FF0: FIFO 0 full Interrupt </li>
|
||||
<li>CAN_IT_FOV0: FIFO 0 overrun Interrupt </li>
|
||||
<li>CAN_IT_FMP1: FIFO 1 message pending Interrupt </li>
|
||||
<li>CAN_IT_FF1: FIFO 1 full Interrupt </li>
|
||||
<li>CAN_IT_FOV1: FIFO 1 overrun Interrupt </li>
|
||||
<li>CAN_IT_WKU: Wake-up Interrupt </li>
|
||||
<li>CAN_IT_SLK: Sleep acknowledge Interrupt </li>
|
||||
<li>CAN_IT_EWG: Error warning Interrupt </li>
|
||||
<li>CAN_IT_EPV: Error passive Interrupt </li>
|
||||
<li>CAN_IT_BOF: Bus-off Interrupt </li>
|
||||
<li>CAN_IT_LEC: Last error code Interrupt </li>
|
||||
<li>CAN_IT_ERR: Error Interrupt </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>current state of CAN_IT (SET or RESET). </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gad1a8b2499a780b5bfa4accb3597b02f4"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void CAN_ITConfig </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">uint32_t </td>
|
||||
<td class="paramname"><em>CAN_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 CANx interrupts. </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">CAN_IT</td><td>specifies the CAN interrupt sources to be enabled or disabled. This parameter can be: <ul>
|
||||
<li>CAN_IT_TME: Transmit mailbox empty Interrupt </li>
|
||||
<li>CAN_IT_FMP0: FIFO 0 message pending Interrupt </li>
|
||||
<li>CAN_IT_FF0: FIFO 0 full Interrupt </li>
|
||||
<li>CAN_IT_FOV0: FIFO 0 overrun Interrupt </li>
|
||||
<li>CAN_IT_FMP1: FIFO 1 message pending Interrupt </li>
|
||||
<li>CAN_IT_FF1: FIFO 1 full Interrupt </li>
|
||||
<li>CAN_IT_FOV1: FIFO 1 overrun Interrupt </li>
|
||||
<li>CAN_IT_WKU: Wake-up Interrupt </li>
|
||||
<li>CAN_IT_SLK: Sleep acknowledge Interrupt </li>
|
||||
<li>CAN_IT_EWG: Error warning Interrupt </li>
|
||||
<li>CAN_IT_EPV: Error passive Interrupt </li>
|
||||
<li>CAN_IT_BOF: Bus-off Interrupt </li>
|
||||
<li>CAN_IT_LEC: Last error code Interrupt </li>
|
||||
<li>CAN_IT_ERR: Error Interrupt </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">NewState</td><td>new state of the CAN 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