mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
176 lines
19 KiB
HTML
176 lines
19 KiB
HTML
<!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.h Source File</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">
|
|
<!-- Generated by Doxygen 1.6.3 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>can.h</h1><a href="can_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"></span>
|
|
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
|
|
<a name="l00005"></a>00005 <span class="comment"></span>
|
|
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
|
|
<a name="l00010"></a>00010 <span class="comment"></span>
|
|
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"></span>
|
|
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"></span>
|
|
<a name="l00019"></a>00019 <span class="comment"> ---</span>
|
|
<a name="l00020"></a>00020 <span class="comment"></span>
|
|
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
|
|
<a name="l00025"></a>00025 <span class="comment">*/</span>
|
|
<a name="l00026"></a>00026 <span class="comment"></span>
|
|
<a name="l00027"></a>00027 <span class="comment">/**</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @file can.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief CAN Driver macros and structures.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup CAN</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> */</span>
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _CAN_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CAN_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_HAL_USE_CAN || defined(__DOXYGEN__)</span>
|
|
<a name="l00039"></a>00039 <span class="preprocessor"></span>
|
|
<a name="l00040"></a>00040 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00041"></a>00041 <span class="comment">/* Driver constants. */</span>
|
|
<a name="l00042"></a>00042 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00043"></a>00043 <span class="comment"></span>
|
|
<a name="l00044"></a>00044 <span class="comment">/**</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> * @brief Errors rate warning.</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> */</span>
|
|
<a name="l00047"></a><a class="code" href="group___c_a_n.html#ga9e84b4cbbb9eb88519aa922ae9c33f09">00047</a> <span class="preprocessor">#define CAN_LIMIT_WARNING 1</span>
|
|
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * @brief Errors rate error.</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> */</span>
|
|
<a name="l00051"></a><a class="code" href="group___c_a_n.html#ga50706597b6872fbf90222fede47d1f54">00051</a> <span class="preprocessor">#define CAN_LIMIT_ERROR 2</span>
|
|
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> * @brief Bus off condition reached.</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> */</span>
|
|
<a name="l00055"></a><a class="code" href="group___c_a_n.html#gaaa317e7894d81461722dfeb4aa2c14dd">00055</a> <span class="preprocessor">#define CAN_BUS_OFF_ERROR 4</span>
|
|
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * @brief Framing error of some kind on the CAN bus.</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> */</span>
|
|
<a name="l00059"></a><a class="code" href="group___c_a_n.html#ga76f084f2cf0c2088ed0d8948e6075709">00059</a> <span class="preprocessor">#define CAN_FRAMING_ERROR 8</span>
|
|
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * @brief Overflow in receive queue.</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> */</span>
|
|
<a name="l00063"></a><a class="code" href="group___c_a_n.html#ga8da95bff65bea0790d564841895c42d0">00063</a> <span class="preprocessor">#define CAN_OVERFLOW_ERROR 16</span>
|
|
<a name="l00064"></a>00064 <span class="preprocessor"></span>
|
|
<a name="l00065"></a>00065 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00066"></a>00066 <span class="comment">/* Driver pre-compile time settings. */</span>
|
|
<a name="l00067"></a>00067 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00068"></a>00068 <span class="comment"></span>
|
|
<a name="l00069"></a>00069 <span class="comment">/**</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> * @brief Sleep mode related APIs inclusion switch.</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> */</span>
|
|
<a name="l00072"></a><a class="code" href="group___c_a_n.html#ga5294d9d12e4186c781df3b2f1d8bd80b">00072</a> <span class="preprocessor">#define CAN_USE_SLEEP_MODE TRUE</span>
|
|
<a name="l00073"></a>00073 <span class="preprocessor"></span>
|
|
<a name="l00074"></a>00074 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00075"></a>00075 <span class="comment">/* Derived constants and error checks. */</span>
|
|
<a name="l00076"></a>00076 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00077"></a>00077
|
|
<a name="l00078"></a>00078 <span class="preprocessor">#if !CH_USE_SEMAPHORES || !CH_USE_EVENTS</span>
|
|
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#error "CAN driver requires CH_USE_SEMAPHORES and CH_USE_EVENTS"</span>
|
|
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00081"></a>00081 <span class="preprocessor"></span>
|
|
<a name="l00082"></a>00082 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00083"></a>00083 <span class="comment">/* Driver data structures and types. */</span>
|
|
<a name="l00084"></a>00084 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00085"></a>00085 <span class="comment"></span>
|
|
<a name="l00086"></a>00086 <span class="comment">/**</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * @brief Driver state machine possible states.</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> */</span>
|
|
<a name="l00089"></a><a class="code" href="group___c_a_n.html#gaca62464ffdcedae03d49adf3f6ce870e">00089</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
|
|
<a name="l00090"></a><a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea91fe9adee6b7f27be97e8b59439774cc">00090</a> <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea91fe9adee6b7f27be97e8b59439774cc" title="Not initialized.">CAN_UNINIT</a> = 0, <span class="comment">/**< @brief Not initialized. */</span>
|
|
<a name="l00091"></a><a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea6ed84a3a97073b3e04918a90d90dd11e">00091</a> <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea6ed84a3a97073b3e04918a90d90dd11e" title="Stopped.">CAN_STOP</a> = 1, <span class="comment">/**< @brief Stopped. */</span>
|
|
<a name="l00092"></a><a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf10eb7d86ea8728c90d931f34a432394">00092</a> <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf10eb7d86ea8728c90d931f34a432394" title="Starting.">CAN_STARTING</a> = 2, <span class="comment">/**< @brief Starting. */</span>
|
|
<a name="l00093"></a><a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610">00093</a> <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a> = 3, <span class="comment">/**< @brief Ready. */</span>
|
|
<a name="l00094"></a><a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa">00094</a> <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a> = 4 <span class="comment">/**< @brief Sleep state. */</span>
|
|
<a name="l00095"></a>00095 } <a class="code" href="group___c_a_n.html#gaca62464ffdcedae03d49adf3f6ce870e" title="Driver state machine possible states.">canstate_t</a>;
|
|
<a name="l00096"></a>00096
|
|
<a name="l00097"></a>00097 <span class="preprocessor">#include "<a class="code" href="platforms_2_s_t_m32_2can__lld_8h.html" title="STM32 CAN subsystem low level driver header.">can_lld.h</a>"</span>
|
|
<a name="l00098"></a>00098
|
|
<a name="l00099"></a>00099 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00100"></a>00100 <span class="comment">/* Driver macros. */</span>
|
|
<a name="l00101"></a>00101 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00102"></a>00102 <span class="comment"></span>
|
|
<a name="l00103"></a>00103 <span class="comment">/**</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * @brief Adds some flags to the CAN status mask.</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> *</span>
|
|
<a name="l00106"></a>00106 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
|
|
<a name="l00107"></a>00107 <span class="comment"> * @param[in] mask flags to be added to the status mask</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> */</span>
|
|
<a name="l00109"></a><a class="code" href="group___c_a_n.html#ga41491eed34c87bf9b8f225a007266e58">00109</a> <span class="preprocessor">#define canAddFlagsI(canp, mask) ((canp)->cd_status |= (mask))</span>
|
|
<a name="l00110"></a>00110 <span class="preprocessor"></span>
|
|
<a name="l00111"></a>00111 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00112"></a>00112 <span class="comment">/* External declarations. */</span>
|
|
<a name="l00113"></a>00113 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00114"></a>00114
|
|
<a name="l00115"></a>00115 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00117"></a>00117 <span class="preprocessor">#endif</span>
|
|
<a name="l00118"></a>00118 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group___c_a_n.html#ga2d3efc34f7704ab23c293aac2be47764" title="CAN Driver initialization.">canInit</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00119"></a>00119 <span class="keywordtype">void</span> <a class="code" href="group___c_a_n.html#gadf8c892ca4bd2544d03be8a690885aef" title="Initializes the standard part of a CANDriver structure.">canObjectInit</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp);
|
|
<a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="group___c_a_n.html#ga05d2448864b2cae4674ed7e6f3c576b8" title="Configures and activates the CAN peripheral.">canStart</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp, <span class="keyword">const</span> <a class="code" href="struct_c_a_n_config.html" title="Driver configuration structure.">CANConfig</a> *config);
|
|
<a name="l00121"></a>00121 <span class="keywordtype">void</span> <a class="code" href="group___c_a_n.html#ga4e89a7d246119e077d27431a02586133" title="Deactivates the CAN peripheral.">canStop</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp);
|
|
<a name="l00122"></a>00122 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group___c_a_n.html#gad9c686d19b4319ef586af3631b779c6c" title="Can frame transmission.">canTransmit</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp, <span class="keyword">const</span> <a class="code" href="struct_c_a_n_tx_frame.html" title="CAN transmission frame.">CANTxFrame</a> *ctfp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<a name="l00123"></a>00123 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group___c_a_n.html#ga557d845167f6ab4f224b036860411db5" title="Can frame receive.">canReceive</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp, <a class="code" href="struct_c_a_n_rx_frame.html" title="CAN received frame.">CANRxFrame</a> *crfp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<a name="l00124"></a>00124 <a class="code" href="group___c_a_n___l_l_d.html#ga4a6894bc11434dfa96263dcd72735330" title="CAN status flags.">canstatus_t</a> <a class="code" href="group___c_a_n.html#ga377a78b04ad6733e24b31615b76cdada" title="Returns the current status mask and clears it.">canGetAndClearFlags</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp);
|
|
<a name="l00125"></a>00125 <span class="preprocessor">#if CAN_USE_SLEEP_MODE</span>
|
|
<a name="l00126"></a>00126 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group___c_a_n.html#ga97caf4f277c09588c225ea2328a74cba" title="Enters the sleep mode.">canSleep</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp);
|
|
<a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="group___c_a_n.html#ga09737d4ae5be724bf791a309e8a28dff" title="Enforces leaving the sleep mode.">canWakeup</a>(<a class="code" href="struct_c_a_n_driver.html" title="Structure representing an CAN driver.">CANDriver</a> *canp);
|
|
<a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/* CAN_USE_SLEEP_MODE */</span>
|
|
<a name="l00129"></a>00129 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00130"></a>00130 <span class="preprocessor"></span>}
|
|
<a name="l00131"></a>00131 <span class="preprocessor">#endif</span>
|
|
<a name="l00132"></a>00132 <span class="preprocessor"></span>
|
|
<a name="l00133"></a>00133 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_CAN */</span>
|
|
<a name="l00134"></a>00134
|
|
<a name="l00135"></a>00135 <span class="preprocessor">#endif </span><span class="comment">/* _CAN_H_ */</span>
|
|
<a name="l00136"></a>00136 <span class="comment"></span>
|
|
<a name="l00137"></a>00137 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Jul 11 13:13:00 2010 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.3</small></address>
|
|
</body>
|
|
</html>
|