gnuk/ChibiOS_2.0.6/docs/html/can_8c_source.html

323 lines
42 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.c 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">
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>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="headertitle">
<h1>can.c</h1> </div>
</div>
<div class="contents">
<a href="can_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
2010-08-10 03:11:02 +00:00
<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 &lt;http://www.gnu.org/licenses/&gt;.</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.c</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief CAN Driver code.</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">#include &quot;<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>&quot;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="hal_8h.html" title="HAL subsystem header.">hal.h</a>&quot;</span>
<a name="l00037"></a>00037
<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 exported variables. */</span>
<a name="l00042"></a>00042 <span class="comment">/*===========================================================================*/</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">/*===========================================================================*/</span>
<a name="l00045"></a>00045 <span class="comment">/* Driver local variables. */</span>
<a name="l00046"></a>00046 <span class="comment">/*===========================================================================*/</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/*===========================================================================*/</span>
<a name="l00049"></a>00049 <span class="comment">/* Driver local functions. */</span>
<a name="l00050"></a>00050 <span class="comment">/*===========================================================================*/</span>
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">/*===========================================================================*/</span>
<a name="l00053"></a>00053 <span class="comment">/* Driver exported functions. */</span>
<a name="l00054"></a>00054 <span class="comment">/*===========================================================================*/</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">/**</span>
<a name="l00057"></a>00057 <span class="comment"> * @brief CAN Driver initialization.</span>
<a name="l00058"></a>00058 <span class="comment"> */</span>
<a name="l00059"></a><a class="code" href="group___c_a_n.html#ga2d3efc34f7704ab23c293aac2be47764">00059</a> <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="l00060"></a>00060
<a name="l00061"></a>00061 <a class="code" href="group___c_a_n___l_l_d.html#gaa215539c505ce7099f30c0aace00bf25" title="Low level CAN driver initialization.">can_lld_init</a>();
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment">/**</span>
<a name="l00065"></a>00065 <span class="comment"> * @brief Initializes the standard part of a @p CANDriver structure.</span>
<a name="l00066"></a>00066 <span class="comment"> *</span>
<a name="l00067"></a>00067 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a><a class="code" href="group___c_a_n.html#gadf8c892ca4bd2544d03be8a690885aef">00069</a> <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="l00070"></a>00070
2010-11-22 05:53:37 +00:00
<a name="l00071"></a>00071 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> = CAN_STOP;
2010-08-10 03:11:02 +00:00
<a name="l00072"></a>00072 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a06a64e755c1b87bf9f8156d7d19a4e41" title="Current configuration data.">cd_config</a> = NULL;
<a name="l00073"></a>00073 <a class="code" href="group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title="Initializes a semaphore with the specified counter value.">chSemInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a2d4f41efdd17ff64233fd636873601c7" title="Transmission queue semaphore.">cd_txsem</a>, 0);
<a name="l00074"></a>00074 <a class="code" href="group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title="Initializes a semaphore with the specified counter value.">chSemInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#aae5656b95d7632b579d098e95c3c77d4" title="Receive queue semaphore.">cd_rxsem</a>, 0);
<a name="l00075"></a>00075 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#af26143d0b9fed9421e79fa4fcb7f3d4b" title="One or more frames become available.">cd_rxfull_event</a>);
<a name="l00076"></a>00076 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a39538106afd16adf6e1b2640458f5fa2" title="One or more transmission slots become available.">cd_txempty_event</a>);
<a name="l00077"></a>00077 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#aa4bc47b7806c2414382071f31b0cef89" title="A CAN bus error happened.">cd_error_event</a>);
<a name="l00078"></a>00078 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a149df5bb5907beae27b8623d432cb20a" title="Error flags set when an error event is broadcasted.">cd_status</a> = 0;
<a name="l00079"></a>00079 <span class="preprocessor">#if CAN_USE_SLEEP_MODE</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span> <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a424d4fd0c061b0237803c03c5815b450" title="Entering sleep state event.">cd_sleep_event</a>);
<a name="l00081"></a>00081 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#ab860f0342e594220bd9428bed397614e" title="Exiting sleep state event.">cd_wakeup_event</a>);
<a name="l00082"></a>00082 <span class="preprocessor">#endif </span><span class="comment">/* CAN_USE_SLEEP_MODE */</span>
<a name="l00083"></a>00083 }
<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"> * @brief Configures and activates the CAN peripheral.</span>
<a name="l00087"></a>00087 <span class="comment"> *</span>
<a name="l00088"></a>00088 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00089"></a>00089 <span class="comment"> * @param[in] config pointer to the @p CANConfig object</span>
<a name="l00090"></a>00090 <span class="comment"> */</span>
<a name="l00091"></a><a class="code" href="group___c_a_n.html#ga05d2448864b2cae4674ed7e6f3c576b8">00091</a> <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="l00092"></a>00092
<a name="l00093"></a>00093 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((canp != NULL) &amp;&amp; (config != NULL), <span class="stringliteral">&quot;canStart&quot;</span>);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00096"></a>00096 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea6ed84a3a97073b3e04918a90d90dd11e" title="Stopped.">CAN_STOP</a>) ||
<a name="l00097"></a>00097 (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf10eb7d86ea8728c90d931f34a432394" title="Starting.">CAN_STARTING</a>) ||
<a name="l00098"></a>00098 (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>),
<a name="l00099"></a>00099 <span class="stringliteral">&quot;canStart(), #1&quot;</span>,
<a name="l00100"></a>00100 <span class="stringliteral">&quot;invalid state&quot;</span>);
<a name="l00101"></a>00101 <span class="keywordflow">while</span> (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf10eb7d86ea8728c90d931f34a432394" title="Starting.">CAN_STARTING</a>)
<a name="l00102"></a>00102 <a class="code" href="group__threads.html#ga851dc0c4ac72885bf09feebdef4673ac" title="Suspends the invoking thread for the specified time.">chThdSleepS</a>(1);
<a name="l00103"></a>00103 <span class="keywordflow">if</span> (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea6ed84a3a97073b3e04918a90d90dd11e" title="Stopped.">CAN_STOP</a>) {
<a name="l00104"></a>00104 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a06a64e755c1b87bf9f8156d7d19a4e41" title="Current configuration data.">cd_config</a> = config;
<a name="l00105"></a>00105 <a class="code" href="group___c_a_n___l_l_d.html#gafae65e8b034b2c1cda8d46790eb2c3fb" title="Configures and activates the CAN peripheral.">can_lld_start</a>(canp);
2010-11-22 05:53:37 +00:00
<a name="l00106"></a>00106 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> = CAN_READY;
2010-08-10 03:11:02 +00:00
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment">/**</span>
<a name="l00112"></a>00112 <span class="comment"> * @brief Deactivates the CAN peripheral.</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a><a class="code" href="group___c_a_n.html#ga4e89a7d246119e077d27431a02586133">00116</a> <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="l00117"></a>00117
<a name="l00118"></a>00118 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(canp != NULL, <span class="stringliteral">&quot;canStop&quot;</span>);
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00121"></a>00121 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea6ed84a3a97073b3e04918a90d90dd11e" title="Stopped.">CAN_STOP</a>) || (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>),
<a name="l00122"></a>00122 <span class="stringliteral">&quot;canStop(), #1&quot;</span>,
<a name="l00123"></a>00123 <span class="stringliteral">&quot;invalid state&quot;</span>);
<a name="l00124"></a>00124 <a class="code" href="group___c_a_n___l_l_d.html#gad6fff809711eb161f9c53acf4f3f8470" title="Deactivates the CAN peripheral.">can_lld_stop</a>(canp);
<a name="l00125"></a>00125 <a class="code" href="group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title="Performs a reset operation on the semaphore.">chSemResetI</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#aae5656b95d7632b579d098e95c3c77d4" title="Receive queue semaphore.">cd_rxsem</a>, 0);
<a name="l00126"></a>00126 <a class="code" href="group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title="Performs a reset operation on the semaphore.">chSemResetI</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a2d4f41efdd17ff64233fd636873601c7" title="Transmission queue semaphore.">cd_txsem</a>, 0);
<a name="l00127"></a>00127 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
2010-11-22 05:53:37 +00:00
<a name="l00128"></a>00128 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> = CAN_STOP;
2010-08-10 03:11:02 +00:00
<a name="l00129"></a>00129 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a149df5bb5907beae27b8623d432cb20a" title="Error flags set when an error event is broadcasted.">cd_status</a> = 0;
<a name="l00130"></a>00130 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment">/**</span>
<a name="l00134"></a>00134 <span class="comment"> * @brief Can frame transmission.</span>
<a name="l00135"></a>00135 <span class="comment"> * @details The specified frame is queued for transmission, if the hardware</span>
<a name="l00136"></a>00136 <span class="comment"> * queue is full then the invoking thread is queued.</span>
<a name="l00137"></a>00137 <span class="comment"> * @note Trying to transmit while in sleep mode simply enqueues the thread.</span>
<a name="l00138"></a>00138 <span class="comment"> *</span>
<a name="l00139"></a>00139 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00140"></a>00140 <span class="comment"> * @param[in] ctfp pointer to the CAN frame to be transmitted</span>
<a name="l00141"></a>00141 <span class="comment"> * @param[in] timeout the number of ticks before the operation timeouts,</span>
<a name="l00142"></a>00142 <span class="comment"> * the following special values are allowed:</span>
<a name="l00143"></a>00143 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00144"></a>00144 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00145"></a>00145 <span class="comment"> * .</span>
<a name="l00146"></a>00146 <span class="comment"> * @return The operation result.</span>
<a name="l00147"></a>00147 <span class="comment"> * @retval RDY_OK the frame has been queued for transmission.</span>
<a name="l00148"></a>00148 <span class="comment"> * @retval RDY_TIMEOUT operation not finished within the specified time.</span>
<a name="l00149"></a>00149 <span class="comment"> * @retval RDY_RESET driver stopped while waiting.</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a><a class="code" href="group___c_a_n.html#gad9c686d19b4319ef586af3631b779c6c">00151</a> <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="l00152"></a>00152
<a name="l00153"></a>00153 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((canp != NULL) &amp;&amp; (ctfp != NULL), <span class="stringliteral">&quot;canTransmit&quot;</span>);
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00156"></a>00156 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>) || (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>),
<a name="l00157"></a>00157 <span class="stringliteral">&quot;canTransmit(), #1&quot;</span>,
<a name="l00158"></a>00158 <span class="stringliteral">&quot;invalid state&quot;</span>);
<a name="l00159"></a>00159 <span class="keywordflow">while</span> ((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>) || !<a class="code" href="group___c_a_n___l_l_d.html#ga81f2cbcb7b885628bdf54177375b7f9b" title="Determines whether a frame can be transmitted.">can_lld_can_transmit</a>(canp)) {
<a name="l00160"></a>00160 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a2d4f41efdd17ff64233fd636873601c7" title="Transmission queue semaphore.">cd_txsem</a>, timeout);
<a name="l00161"></a>00161 <span class="keywordflow">if</span> (msg != <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
<a name="l00162"></a>00162 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00163"></a>00163 <span class="keywordflow">return</span> msg;
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166 <a class="code" href="group___c_a_n___l_l_d.html#ga7117eccbe00b5524e55546a4aa688446" title="Inserts a frame into the transmit queue.">can_lld_transmit</a>(canp, ctfp);
<a name="l00167"></a>00167 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
2010-11-22 05:53:37 +00:00
<a name="l00168"></a>00168 <span class="keywordflow">return</span> RDY_OK;
2010-08-10 03:11:02 +00:00
<a name="l00169"></a>00169 }
<a name="l00170"></a>00170 <span class="comment"></span>
<a name="l00171"></a>00171 <span class="comment">/**</span>
<a name="l00172"></a>00172 <span class="comment"> * @brief Can frame receive.</span>
<a name="l00173"></a>00173 <span class="comment"> * @details The function waits until a frame is received.</span>
<a name="l00174"></a>00174 <span class="comment"> * @note Trying to receive while in sleep mode simply enqueues the thread.</span>
<a name="l00175"></a>00175 <span class="comment"> *</span>
<a name="l00176"></a>00176 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00177"></a>00177 <span class="comment"> * @param[out] crfp pointer to the buffer where the CAN frame is copied</span>
<a name="l00178"></a>00178 <span class="comment"> * @param[in] timeout the number of ticks before the operation timeouts,</span>
<a name="l00179"></a>00179 <span class="comment"> * the following special values are allowed:</span>
<a name="l00180"></a>00180 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout (useful in an</span>
<a name="l00181"></a>00181 <span class="comment"> * event driven scenario where a thread never blocks</span>
<a name="l00182"></a>00182 <span class="comment"> * for I/O).</span>
<a name="l00183"></a>00183 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00184"></a>00184 <span class="comment"> * .</span>
<a name="l00185"></a>00185 <span class="comment"> * @return The operation result.</span>
<a name="l00186"></a>00186 <span class="comment"> * @retval RDY_OK a frame has been received and placed in the buffer.</span>
<a name="l00187"></a>00187 <span class="comment"> * @retval RDY_TIMEOUT operation not finished within the specified time or</span>
<a name="l00188"></a>00188 <span class="comment"> * frame not immediately available if invoked using</span>
<a name="l00189"></a>00189 <span class="comment"> * @p TIME_IMMEDIATE.</span>
<a name="l00190"></a>00190 <span class="comment"> * @retval RDY_RESET driver stopped while waiting.</span>
<a name="l00191"></a>00191 <span class="comment"> */</span>
<a name="l00192"></a><a class="code" href="group___c_a_n.html#ga557d845167f6ab4f224b036860411db5">00192</a> <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="l00193"></a>00193
<a name="l00194"></a>00194 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((canp != NULL) &amp;&amp; (crfp != NULL), <span class="stringliteral">&quot;canReceive&quot;</span>);
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00197"></a>00197 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>) || (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>),
<a name="l00198"></a>00198 <span class="stringliteral">&quot;canReceive(), #1&quot;</span>,
<a name="l00199"></a>00199 <span class="stringliteral">&quot;invalid state&quot;</span>);
<a name="l00200"></a>00200 <span class="keywordflow">while</span> ((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>) || !<a class="code" href="group___c_a_n___l_l_d.html#ga27ca2bb8369163a8be3ebd020522f7b0" title="Determines whether a frame has been received.">can_lld_can_receive</a>(canp)) {
<a name="l00201"></a>00201 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#aae5656b95d7632b579d098e95c3c77d4" title="Receive queue semaphore.">cd_rxsem</a>, timeout);
<a name="l00202"></a>00202 <span class="keywordflow">if</span> (msg != <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
<a name="l00203"></a>00203 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00204"></a>00204 <span class="keywordflow">return</span> msg;
<a name="l00205"></a>00205 }
<a name="l00206"></a>00206 }
<a name="l00207"></a>00207 <a class="code" href="group___c_a_n___l_l_d.html#ga5c9d83ee107cfb59880c4bd19a7961bd" title="Receives a frame from the input queue.">can_lld_receive</a>(canp, crfp);
<a name="l00208"></a>00208 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
2010-11-22 05:53:37 +00:00
<a name="l00209"></a>00209 <span class="keywordflow">return</span> RDY_OK;
2010-08-10 03:11:02 +00:00
<a name="l00210"></a>00210 }
<a name="l00211"></a>00211 <span class="comment"></span>
<a name="l00212"></a>00212 <span class="comment">/**</span>
<a name="l00213"></a>00213 <span class="comment"> * @brief Returns the current status mask and clears it.</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00216"></a>00216 <span class="comment"> * @return The status flags mask.</span>
<a name="l00217"></a>00217 <span class="comment"> */</span>
<a name="l00218"></a><a class="code" href="group___c_a_n.html#ga377a78b04ad6733e24b31615b76cdada">00218</a> <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="l00219"></a>00219 <a class="code" href="group___c_a_n___l_l_d.html#ga4a6894bc11434dfa96263dcd72735330" title="CAN status flags.">canstatus_t</a> status;
<a name="l00220"></a>00220
<a name="l00221"></a>00221 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00222"></a>00222 status = canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a149df5bb5907beae27b8623d432cb20a" title="Error flags set when an error event is broadcasted.">cd_status</a>;
<a name="l00223"></a>00223 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a149df5bb5907beae27b8623d432cb20a" title="Error flags set when an error event is broadcasted.">cd_status</a> = 0;
<a name="l00224"></a>00224 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00225"></a>00225 <span class="keywordflow">return</span> status;
<a name="l00226"></a>00226 }
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="preprocessor">#if CAN_USE_SLEEP_MODE || defined(__DOXYGEN__)</span>
<a name="l00229"></a>00229 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00230"></a>00230 <span class="comment"> * @brief Enters the sleep mode.</span>
<a name="l00231"></a>00231 <span class="comment"> *</span>
<a name="l00232"></a>00232 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00233"></a>00233 <span class="comment"> */</span>
<a name="l00234"></a><a class="code" href="group___c_a_n.html#ga97caf4f277c09588c225ea2328a74cba">00234</a> <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="l00235"></a>00235
<a name="l00236"></a>00236 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(canp != NULL, <span class="stringliteral">&quot;canSleep&quot;</span>);
<a name="l00237"></a>00237
<a name="l00238"></a>00238 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00239"></a>00239 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>) || (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>),
<a name="l00240"></a>00240 <span class="stringliteral">&quot;canSleep(), #1&quot;</span>,
<a name="l00241"></a>00241 <span class="stringliteral">&quot;invalid state&quot;</span>);
<a name="l00242"></a>00242 <span class="keywordflow">if</span> (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>) {
<a name="l00243"></a>00243 <a class="code" href="group___c_a_n___l_l_d.html#ga90f2254324f338714bfe1663eb73a2ba" title="Enters the sleep mode.">can_lld_sleep</a>(canp);
2010-11-22 05:53:37 +00:00
<a name="l00244"></a>00244 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> = CAN_SLEEP;
2010-08-10 03:11:02 +00:00
<a name="l00245"></a>00245 <a class="code" href="group__events.html#gaa24d9bed5b676b577200c4a8ebe3b8a3" title="Signals all the Event Listeners registered on the specified Event Source.">chEvtBroadcastI</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a424d4fd0c061b0237803c03c5815b450" title="Entering sleep state event.">cd_sleep_event</a>);
<a name="l00246"></a>00246 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
<a name="l00247"></a>00247 }
<a name="l00248"></a>00248 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00249"></a>00249 }
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">/**</span>
<a name="l00252"></a>00252 <span class="comment"> * @brief Enforces leaving the sleep mode.</span>
<a name="l00253"></a>00253 <span class="comment"> * @note The sleep mode is supposed to be usually exited automatically by</span>
<a name="l00254"></a>00254 <span class="comment"> * an hardware event.</span>
<a name="l00255"></a>00255 <span class="comment"> *</span>
<a name="l00256"></a>00256 <span class="comment"> * @param[in] canp pointer to the @p CANDriver object</span>
<a name="l00257"></a>00257 <span class="comment"> */</span>
<a name="l00258"></a><a class="code" href="group___c_a_n.html#ga09737d4ae5be724bf791a309e8a28dff">00258</a> <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="l00259"></a>00259
<a name="l00260"></a>00260 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(canp != NULL, <span class="stringliteral">&quot;canWakeup&quot;</span>);
<a name="l00261"></a>00261
<a name="l00262"></a>00262 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00263"></a>00263 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" title="Ready.">CAN_READY</a>) || (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>),
<a name="l00264"></a>00264 <span class="stringliteral">&quot;canWakeup(), #1&quot;</span>,
<a name="l00265"></a>00265 <span class="stringliteral">&quot;invalid state&quot;</span>);
<a name="l00266"></a>00266 <span class="keywordflow">if</span> (canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> == <a class="code" href="group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" title="Sleep state.">CAN_SLEEP</a>) {
<a name="l00267"></a>00267 <a class="code" href="group___c_a_n___l_l_d.html#ga7a5e18d180ae064548783e6ac18903ba" title="Enforces leaving the sleep mode.">can_lld_wakeup</a>(canp);
2010-11-22 05:53:37 +00:00
<a name="l00268"></a>00268 canp-&gt;<a class="code" href="struct_c_a_n_driver.html#a5ed8f92d00941a212ad798e05c001dcb" title="Driver state.">cd_state</a> = CAN_READY;
2010-08-10 03:11:02 +00:00
<a name="l00269"></a>00269 <a class="code" href="group__events.html#gaa24d9bed5b676b577200c4a8ebe3b8a3" title="Signals all the Event Listeners registered on the specified Event Source.">chEvtBroadcastI</a>(&amp;canp-&gt;<a class="code" href="struct_c_a_n_driver.html#ab860f0342e594220bd9428bed397614e" title="Exiting sleep state event.">cd_wakeup_event</a>);
<a name="l00270"></a>00270 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
<a name="l00271"></a>00271 }
<a name="l00272"></a>00272 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00273"></a>00273 }
<a name="l00274"></a>00274 <span class="preprocessor">#endif </span><span class="comment">/* CAN_USE_SLEEP_MODE */</span>
<a name="l00275"></a>00275
<a name="l00276"></a>00276 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_CAN */</span>
<a name="l00277"></a>00277 <span class="comment"></span>
<a name="l00278"></a>00278 <span class="comment">/** @} */</span>
</pre></div></div>
2010-11-22 05:53:37 +00:00
</div>
2010-08-10 03:11:02 +00:00
<hr size="1"><address style="text-align: right;"><small>
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:36 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>