Added doxygen output of current emulator branch.

This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions

222
struct_can_rx_msg.html Normal file
View File

@@ -0,0 +1,222 @@
<!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: CanRxMsg Struct Reference</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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_can_rx_msg-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CanRxMsg Struct Reference<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></div></div> </div>
</div><!--header-->
<div class="contents">
<p>CAN Rx message structure definition.
<a href="struct_can_rx_msg.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="stm32f4xx__can_8h_source.html">stm32f4xx_can.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a62769e18836146f71238bee6b43b531e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#a62769e18836146f71238bee6b43b531e">StdId</a></td></tr>
<tr class="separator:a62769e18836146f71238bee6b43b531e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fdca10d31c81eea2ccef41d2aced562"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#a1fdca10d31c81eea2ccef41d2aced562">ExtId</a></td></tr>
<tr class="separator:a1fdca10d31c81eea2ccef41d2aced562"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83a67d1a709cc01570ce956e5adc811f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#a83a67d1a709cc01570ce956e5adc811f">IDE</a></td></tr>
<tr class="separator:a83a67d1a709cc01570ce956e5adc811f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a183149a391a24f86da2ce895f0f1c9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#a9a183149a391a24f86da2ce895f0f1c9">RTR</a></td></tr>
<tr class="separator:a9a183149a391a24f86da2ce895f0f1c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf77d3abf9ad290c08cdfd5d99ebc745"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#abf77d3abf9ad290c08cdfd5d99ebc745">DLC</a></td></tr>
<tr class="separator:abf77d3abf9ad290c08cdfd5d99ebc745"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8ecbad16622db30d63fda08bc478649"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#ae8ecbad16622db30d63fda08bc478649">Data</a> [8]</td></tr>
<tr class="separator:ae8ecbad16622db30d63fda08bc478649"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5afe39d8e295659eeb3030593828b96a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_can_rx_msg.html#a5afe39d8e295659eeb3030593828b96a">FMI</a></td></tr>
<tr class="separator:a5afe39d8e295659eeb3030593828b96a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>CAN Rx message structure definition. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ae8ecbad16622db30d63fda08bc478649"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CanRxMsg::Data[8]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Contains the data to be received. It ranges from 0 to 0xFF. </p>
</div>
</div>
<a class="anchor" id="abf77d3abf9ad290c08cdfd5d99ebc745"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CanRxMsg::DLC</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the length of the frame that will be received. This parameter can be a value between 0 to 8 </p>
</div>
</div>
<a class="anchor" id="a1fdca10d31c81eea2ccef41d2aced562"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t CanRxMsg::ExtId</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the extended identifier. This parameter can be a value between 0 to 0x1FFFFFFF. </p>
</div>
</div>
<a class="anchor" id="a5afe39d8e295659eeb3030593828b96a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CanRxMsg::FMI</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the index of the filter the message stored in the mailbox passes through. This parameter can be a value between 0 to 0xFF </p>
</div>
</div>
<a class="anchor" id="a83a67d1a709cc01570ce956e5adc811f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CanRxMsg::IDE</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the type of identifier for the message that will be received. This parameter can be a value of <a class="el" href="group___c_a_n__identifier__type.html">CAN_identifier_type</a> </p>
</div>
</div>
<a class="anchor" id="a9a183149a391a24f86da2ce895f0f1c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t CanRxMsg::RTR</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the type of frame for the received message. This parameter can be a value of <a class="el" href="group___c_a_n__remote__transmission__request.html">CAN_remote_transmission_request</a> </p>
</div>
</div>
<a class="anchor" id="a62769e18836146f71238bee6b43b531e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t CanRxMsg::StdId</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the standard identifier. This parameter can be a value between 0 to 0x7FF. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>discovery/libs/StmCoreNPheriph/inc/<a class="el" href="stm32f4xx__can_8h_source.html">stm32f4xx_can.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:21 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>