gnuk/ChibiOS_2.0.8/docs/html/templates_2can__lld_8h.html

99 lines
9.3 KiB
HTML
Raw Normal View History

2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ChibiOS/RT: can_lld.h File Reference</title>
<link href="custom.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table style="text-align: center; width: 100%;" border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
<td style="width: 80px;"></td>
</tr>
</tbody>
</table>
<hr size="1">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>can_lld.h File Reference</h1> </div>
</div>
2010-08-10 03:11:02 +00:00
<div class="contents">
2010-11-22 05:53:37 +00:00
2010-08-10 03:11:02 +00:00
<p>CAN Driver subsystem low level driver header template.
<a href="#_details">More...</a></p>
<p><a href="templates_2can__lld_8h_source.html">Go to the source code of this file.</a></p>
2010-11-22 05:53:37 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_c_a_n_tx_frame.html">CANTxFrame</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">CAN transmission frame. <a href="struct_c_a_n_tx_frame.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_c_a_n_rx_frame.html">CANRxFrame</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">CAN received frame. <a href="struct_c_a_n_rx_frame.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_c_a_n_filter.html">CANFilter</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">CAN filter. <a href="struct_c_a_n_filter.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_c_a_n_config.html">CANConfig</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Driver configuration structure. <a href="struct_c_a_n_config.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_c_a_n_driver.html">CANDriver</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Structure representing an CAN driver. <a href="struct_c_a_n_driver.html#_details">More...</a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#gaa9218b87c481680e99f7ffe90b7bad82">CAN_SUPPORTS_SLEEP</a>&nbsp;&nbsp;&nbsp;TRUE</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This switch defines whether the driver implementation supports a low power switch mode with automatic an wakeup feature. <a href="group___c_a_n___l_l_d.html#gaa9218b87c481680e99f7ffe90b7bad82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#ga5294d9d12e4186c781df3b2f1d8bd80b">CAN_USE_SLEEP_MODE</a>&nbsp;&nbsp;&nbsp;TRUE</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sleep mode related APIs inclusion switch. <a href="group___c_a_n___l_l_d.html#ga5294d9d12e4186c781df3b2f1d8bd80b"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#ga4a6894bc11434dfa96263dcd72735330">canstatus_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">CAN status flags. <a href="group___c_a_n___l_l_d.html#ga4a6894bc11434dfa96263dcd72735330"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#gaa215539c505ce7099f30c0aace00bf25">can_lld_init</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Low level CAN driver initialization. <a href="group___c_a_n___l_l_d.html#gaa215539c505ce7099f30c0aace00bf25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#gafae65e8b034b2c1cda8d46790eb2c3fb">can_lld_start</a> (<a class="el" href="struct_c_a_n_driver.html">CANDriver</a> *canp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configures and activates the CAN peripheral. <a href="group___c_a_n___l_l_d.html#gafae65e8b034b2c1cda8d46790eb2c3fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#gad6fff809711eb161f9c53acf4f3f8470">can_lld_stop</a> (<a class="el" href="struct_c_a_n_driver.html">CANDriver</a> *canp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deactivates the CAN peripheral. <a href="group___c_a_n___l_l_d.html#gad6fff809711eb161f9c53acf4f3f8470"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#ga81f2cbcb7b885628bdf54177375b7f9b">can_lld_can_transmit</a> (<a class="el" href="struct_c_a_n_driver.html">CANDriver</a> *canp)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines whether a frame can be transmitted. <a href="group___c_a_n___l_l_d.html#ga81f2cbcb7b885628bdf54177375b7f9b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#ga7117eccbe00b5524e55546a4aa688446">can_lld_transmit</a> (<a class="el" href="struct_c_a_n_driver.html">CANDriver</a> *canp, const <a class="el" href="struct_c_a_n_tx_frame.html">CANTxFrame</a> *ctfp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inserts a frame into the transmit queue. <a href="group___c_a_n___l_l_d.html#ga7117eccbe00b5524e55546a4aa688446"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#ga27ca2bb8369163a8be3ebd020522f7b0">can_lld_can_receive</a> (<a class="el" href="struct_c_a_n_driver.html">CANDriver</a> *canp)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines whether a frame has been received. <a href="group___c_a_n___l_l_d.html#ga27ca2bb8369163a8be3ebd020522f7b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_a_n___l_l_d.html#ga5c9d83ee107cfb59880c4bd19a7961bd">can_lld_receive</a> (<a class="el" href="struct_c_a_n_driver.html">CANDriver</a> *canp, <a class="el" href="struct_c_a_n_rx_frame.html">CANRxFrame</a> *crfp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Receives a frame from the input queue. <a href="group___c_a_n___l_l_d.html#ga5c9d83ee107cfb59880c4bd19a7961bd"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>CAN Driver subsystem low level driver header template. </p>
<p>Definition in file <a class="el" href="templates_2can__lld_8h_source.html">templates/can_lld.h</a>.</p>
</div>
<hr size="1"><address style="text-align: right;"><small>
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:49 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
2010-08-10 03:11:02 +00:00
</body>
</html>