mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
308 lines
36 KiB
HTML
308 lines
36 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: serial.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">
|
|
<!-- 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>serial.c</h1><a href="serial_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>
|
|
<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 serial.c</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Serial Driver code.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup SERIAL</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 "<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>"</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="hal_8h.html" title="HAL subsystem header.">hal.h</a>"</span>
|
|
<a name="l00037"></a>00037
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_HAL_USE_SERIAL || 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"> * Interface implementation, the following functions just invoke the equivalent</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> * queue-level function or macro.</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> */</span>
|
|
<a name="l00056"></a>00056
|
|
<a name="l00057"></a>00057 <span class="keyword">static</span> <span class="keywordtype">size_t</span> writes(<span class="keywordtype">void</span> *ip, <span class="keyword">const</span> <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp, <span class="keywordtype">size_t</span> n) {
|
|
<a name="l00058"></a>00058
|
|
<a name="l00059"></a>00059 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga1e90d41fa021107d72b1bed81186aae8" title="Output queue write with timeout.">chOQWriteTimeout</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->oqueue, bp,
|
|
<a name="l00060"></a>00060 n, <a class="code" href="group__scheduler.html#gae1568cf3090c973c3bc47f86ae2f5afb" title="Infinite time specification for all the syscalls with a timeout specification.">TIME_INFINITE</a>);
|
|
<a name="l00061"></a>00061 }
|
|
<a name="l00062"></a>00062
|
|
<a name="l00063"></a>00063 <span class="keyword">static</span> <span class="keywordtype">size_t</span> reads(<span class="keywordtype">void</span> *ip, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp, <span class="keywordtype">size_t</span> n) {
|
|
<a name="l00064"></a>00064
|
|
<a name="l00065"></a>00065 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#gaddf6fc39af7d905c9f23afde14d8d764" title="Input queue read with timeout.">chIQReadTimeout</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->iqueue, bp,
|
|
<a name="l00066"></a>00066 n, <a class="code" href="group__scheduler.html#gae1568cf3090c973c3bc47f86ae2f5afb" title="Infinite time specification for all the syscalls with a timeout specification.">TIME_INFINITE</a>);
|
|
<a name="l00067"></a>00067 }
|
|
<a name="l00068"></a>00068
|
|
<a name="l00069"></a>00069 <span class="keyword">static</span> <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> putwouldblock(<span class="keywordtype">void</span> *ip) {
|
|
<a name="l00070"></a>00070
|
|
<a name="l00071"></a>00071 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#gaca8b2bc8aae722ba9f47f21c358420f9" title="Evaluates to TRUE if the specified Output Queue is full.">chOQIsFull</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->oqueue);
|
|
<a name="l00072"></a>00072 }
|
|
<a name="l00073"></a>00073
|
|
<a name="l00074"></a>00074 <span class="keyword">static</span> <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> getwouldblock(<span class="keywordtype">void</span> *ip) {
|
|
<a name="l00075"></a>00075
|
|
<a name="l00076"></a>00076 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga01d87285eb173d213eb9849514969d7d" title="Evaluates to TRUE if the specified Input Queue is empty.">chIQIsEmpty</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->iqueue);
|
|
<a name="l00077"></a>00077 }
|
|
<a name="l00078"></a>00078
|
|
<a name="l00079"></a>00079 <span class="keyword">static</span> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> putt(<span class="keywordtype">void</span> *ip, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> b, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout) {
|
|
<a name="l00080"></a>00080
|
|
<a name="l00081"></a>00081 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga3df1926602eb698119990b311b097ad9" title="Output queue write with timeout.">chOQPutTimeout</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->oqueue, b, timeout);
|
|
<a name="l00082"></a>00082 }
|
|
<a name="l00083"></a>00083
|
|
<a name="l00084"></a>00084 <span class="keyword">static</span> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> gett(<span class="keywordtype">void</span> *ip, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout) {
|
|
<a name="l00085"></a>00085
|
|
<a name="l00086"></a>00086 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga142d0e885ac3a695f5f033a65f49abd0" title="Input queue read with timeout.">chIQGetTimeout</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->iqueue, timeout);
|
|
<a name="l00087"></a>00087 }
|
|
<a name="l00088"></a>00088
|
|
<a name="l00089"></a>00089 <span class="keyword">static</span> <span class="keywordtype">size_t</span> writet(<span class="keywordtype">void</span> *ip, <span class="keyword">const</span> <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp, <span class="keywordtype">size_t</span> n, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time) {
|
|
<a name="l00090"></a>00090
|
|
<a name="l00091"></a>00091 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga1e90d41fa021107d72b1bed81186aae8" title="Output queue write with timeout.">chOQWriteTimeout</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->oqueue, bp, n, time);
|
|
<a name="l00092"></a>00092 }
|
|
<a name="l00093"></a>00093
|
|
<a name="l00094"></a>00094 <span class="keyword">static</span> <span class="keywordtype">size_t</span> readt(<span class="keywordtype">void</span> *ip, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp, <span class="keywordtype">size_t</span> n, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time) {
|
|
<a name="l00095"></a>00095
|
|
<a name="l00096"></a>00096 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#gaddf6fc39af7d905c9f23afde14d8d764" title="Input queue read with timeout.">chIQReadTimeout</a>(&((<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *)ip)->iqueue, bp, n, time);
|
|
<a name="l00097"></a>00097 }
|
|
<a name="l00098"></a>00098
|
|
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_serial_driver_v_m_t.html" title="SerialDriver virtual methods table.">SerialDriverVMT</a> vmt = {
|
|
<a name="l00100"></a>00100 writes, reads, putwouldblock, getwouldblock, putt, gett, writet, readt
|
|
<a name="l00101"></a>00101 };
|
|
<a name="l00102"></a>00102
|
|
<a name="l00103"></a>00103 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00104"></a>00104 <span class="comment">/* Driver exported functions. */</span>
|
|
<a name="l00105"></a>00105 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00106"></a>00106 <span class="comment"></span>
|
|
<a name="l00107"></a>00107 <span class="comment">/**</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> * @brief Serial Driver initialization.</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> */</span>
|
|
<a name="l00110"></a><a class="code" href="group___s_e_r_i_a_l.html#gaced9c1cfde941c7614183b1c887e862b">00110</a> <span class="keywordtype">void</span> <a class="code" href="group___s_e_r_i_a_l.html#gaced9c1cfde941c7614183b1c887e862b" title="Serial Driver initialization.">sdInit</a>(<span class="keywordtype">void</span>) {
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a>00112 <a class="code" href="group___s_e_r_i_a_l___l_l_d.html#gad05320e8f231f3e092b7042c574da015" title="Low level serial driver initialization.">sd_lld_init</a>();
|
|
<a name="l00113"></a>00113 }
|
|
<a name="l00114"></a>00114 <span class="comment"></span>
|
|
<a name="l00115"></a>00115 <span class="comment">/**</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> * @brief Initializes a generic full duplex driver object.</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> * @details The HW dependent part of the initialization has to be performed</span>
|
|
<a name="l00118"></a>00118 <span class="comment"> * outside, usually in the hardware initialization code.</span>
|
|
<a name="l00119"></a>00119 <span class="comment"> *</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> * @param[out] sdp pointer to a @p SerialDriver structure</span>
|
|
<a name="l00121"></a>00121 <span class="comment"> * @param[in] inotify pointer to a callback function that is invoked when</span>
|
|
<a name="l00122"></a>00122 <span class="comment"> * some data is read from the Queue. The value can be</span>
|
|
<a name="l00123"></a>00123 <span class="comment"> * @p NULL.</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> * @param[in] onotify pointer to a callback function that is invoked when</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> * some data is written in the Queue. The value can be</span>
|
|
<a name="l00126"></a>00126 <span class="comment"> * @p NULL.</span>
|
|
<a name="l00127"></a>00127 <span class="comment"> */</span>
|
|
<a name="l00128"></a><a class="code" href="group___s_e_r_i_a_l.html#gacb9838adcf51106f4e481f41a851cc34">00128</a> <span class="keywordtype">void</span> <a class="code" href="group___s_e_r_i_a_l.html#gacb9838adcf51106f4e481f41a851cc34" title="Initializes a generic full duplex driver object.">sdObjectInit</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp, <a class="code" href="group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title="Queue notification callback type.">qnotify_t</a> inotify, <a class="code" href="group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title="Queue notification callback type.">qnotify_t</a> onotify) {
|
|
<a name="l00129"></a>00129
|
|
<a name="l00130"></a>00130 sdp-><a class="code" href="struct___serial_driver.html#ae654d641d6bfa9caeac49628d6df7c13" title="Virtual Methods Table.">vmt</a> = &vmt;
|
|
<a name="l00131"></a>00131 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&sdp->ievent);
|
|
<a name="l00132"></a>00132 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&sdp->oevent);
|
|
<a name="l00133"></a>00133 <a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&sdp->sevent);
|
|
<a name="l00134"></a>00134 sdp->state = <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a24eb3687f039e6d59fae930b4ae5ae3b" title="Stopped.">SD_STOP</a>;
|
|
<a name="l00135"></a>00135 sdp->flags = <a class="code" href="group___s_e_r_i_a_l.html#ga56fc0a34c0ee335a69d11fe30ed8a2e0" title="No pending conditions.">SD_NO_ERROR</a>;
|
|
<a name="l00136"></a>00136 <a class="code" href="group__io__queues.html#ga0d3a250e6572526b165d2c61f69230e5" title="Initializes an input queue.">chIQInit</a>(&sdp->iqueue, sdp->ib, <a class="code" href="group___s_e_r_i_a_l.html#ga81a9fb00c7a1ce0fe70f263d8fd820e8" title="Serial buffers size.">SERIAL_BUFFERS_SIZE</a>, inotify);
|
|
<a name="l00137"></a>00137 <a class="code" href="group__io__queues.html#gae2a5a0ef7c488ac02762e76933baa7b1" title="Initializes an output queue.">chOQInit</a>(&sdp->oqueue, sdp->ob, <a class="code" href="group___s_e_r_i_a_l.html#ga81a9fb00c7a1ce0fe70f263d8fd820e8" title="Serial buffers size.">SERIAL_BUFFERS_SIZE</a>, onotify);
|
|
<a name="l00138"></a>00138 }
|
|
<a name="l00139"></a>00139 <span class="comment"></span>
|
|
<a name="l00140"></a>00140 <span class="comment">/**</span>
|
|
<a name="l00141"></a>00141 <span class="comment"> * @brief Configures and starts the driver.</span>
|
|
<a name="l00142"></a>00142 <span class="comment"> *</span>
|
|
<a name="l00143"></a>00143 <span class="comment"> * @param[in] sdp pointer to a @p SerialDriver object</span>
|
|
<a name="l00144"></a>00144 <span class="comment"> * @param[in] config the architecture-dependent serial driver configuration.</span>
|
|
<a name="l00145"></a>00145 <span class="comment"> * If this parameter is set to @p NULL then a default</span>
|
|
<a name="l00146"></a>00146 <span class="comment"> * configuration is used.</span>
|
|
<a name="l00147"></a>00147 <span class="comment"> */</span>
|
|
<a name="l00148"></a><a class="code" href="group___s_e_r_i_a_l.html#ga5e77658b4f3b559927705dc8fbfbdfad">00148</a> <span class="keywordtype">void</span> <a class="code" href="group___s_e_r_i_a_l.html#ga5e77658b4f3b559927705dc8fbfbdfad" title="Configures and starts the driver.">sdStart</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp, <span class="keyword">const</span> <a class="code" href="struct_serial_config.html" title="Generic Serial Driver configuration structure.">SerialConfig</a> *config) {
|
|
<a name="l00149"></a>00149
|
|
<a name="l00150"></a>00150 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(sdp != NULL, <span class="stringliteral">"sdStart"</span>);
|
|
<a name="l00151"></a>00151
|
|
<a name="l00152"></a>00152 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00153"></a>00153 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((sdp->state == <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a24eb3687f039e6d59fae930b4ae5ae3b" title="Stopped.">SD_STOP</a>) || (sdp->state == <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a5fa247b8f9749cc93f07a385b6ab580d" title="Ready.">SD_READY</a>),
|
|
<a name="l00154"></a>00154 <span class="stringliteral">"sdStart(), #1"</span>,
|
|
<a name="l00155"></a>00155 <span class="stringliteral">"invalid state"</span>);
|
|
<a name="l00156"></a>00156 <a class="code" href="group___s_e_r_i_a_l___l_l_d.html#gacc3752a7b00b668a651ab76902074e92" title="Low level serial driver configuration and (re)start.">sd_lld_start</a>(sdp, config);
|
|
<a name="l00157"></a>00157 sdp->state = <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a5fa247b8f9749cc93f07a385b6ab580d" title="Ready.">SD_READY</a>;
|
|
<a name="l00158"></a>00158 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00159"></a>00159 }
|
|
<a name="l00160"></a>00160 <span class="comment"></span>
|
|
<a name="l00161"></a>00161 <span class="comment">/**</span>
|
|
<a name="l00162"></a>00162 <span class="comment"> * @brief Stops the driver.</span>
|
|
<a name="l00163"></a>00163 <span class="comment"> * @details Any thread waiting on the driver's queues will be awakened with</span>
|
|
<a name="l00164"></a>00164 <span class="comment"> * the message @p Q_RESET.</span>
|
|
<a name="l00165"></a>00165 <span class="comment"> *</span>
|
|
<a name="l00166"></a>00166 <span class="comment"> * @param[in] sdp pointer to a @p SerialDrive object</span>
|
|
<a name="l00167"></a>00167 <span class="comment"> */</span>
|
|
<a name="l00168"></a><a class="code" href="group___s_e_r_i_a_l.html#gacb106a30f8007afdf9eeaf8681dbd3cf">00168</a> <span class="keywordtype">void</span> <a class="code" href="group___s_e_r_i_a_l.html#gacb106a30f8007afdf9eeaf8681dbd3cf" title="Stops the driver.">sdStop</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp) {
|
|
<a name="l00169"></a>00169
|
|
<a name="l00170"></a>00170 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(sdp != NULL, <span class="stringliteral">"sdStop"</span>);
|
|
<a name="l00171"></a>00171
|
|
<a name="l00172"></a>00172 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00173"></a>00173 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>((sdp->state == <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a24eb3687f039e6d59fae930b4ae5ae3b" title="Stopped.">SD_STOP</a>) || (sdp->state == <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a5fa247b8f9749cc93f07a385b6ab580d" title="Ready.">SD_READY</a>),
|
|
<a name="l00174"></a>00174 <span class="stringliteral">"sdStop(), #1"</span>,
|
|
<a name="l00175"></a>00175 <span class="stringliteral">"invalid state"</span>);
|
|
<a name="l00176"></a>00176 <a class="code" href="group___s_e_r_i_a_l___l_l_d.html#gae6846b20159e89464b61665f50468d8f" title="Low level serial driver stop.">sd_lld_stop</a>(sdp);
|
|
<a name="l00177"></a>00177 sdp->state = <a class="code" href="group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a24eb3687f039e6d59fae930b4ae5ae3b" title="Stopped.">SD_STOP</a>;
|
|
<a name="l00178"></a>00178 <a class="code" href="group__io__queues.html#ga0a35a7de945e4b56b5fb5f5c8567e296" title="Resets an output queue.">chOQResetI</a>(&sdp->oqueue);
|
|
<a name="l00179"></a>00179 <a class="code" href="group__io__queues.html#ga2252ca3e5d6ee6d8d323d025365aee59" title="Resets an input queue.">chIQResetI</a>(&sdp->iqueue);
|
|
<a name="l00180"></a>00180 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
|
|
<a name="l00181"></a>00181 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00182"></a>00182 }
|
|
<a name="l00183"></a>00183 <span class="comment"></span>
|
|
<a name="l00184"></a>00184 <span class="comment">/**</span>
|
|
<a name="l00185"></a>00185 <span class="comment"> * @brief Handles incoming data.</span>
|
|
<a name="l00186"></a>00186 <span class="comment"> * @details This function must be called from the input interrupt service</span>
|
|
<a name="l00187"></a>00187 <span class="comment"> * routine in order to enqueue incoming data and generate the</span>
|
|
<a name="l00188"></a>00188 <span class="comment"> * related events.</span>
|
|
<a name="l00189"></a>00189 <span class="comment"> * @note The incoming data event is only generated when the input queue</span>
|
|
<a name="l00190"></a>00190 <span class="comment"> * becomes non-empty.</span>
|
|
<a name="l00191"></a>00191 <span class="comment"> * @note In order to gain some performance it is suggested to not use</span>
|
|
<a name="l00192"></a>00192 <span class="comment"> * this function directly but copy this code directly into the</span>
|
|
<a name="l00193"></a>00193 <span class="comment"> * interrupt service routine.</span>
|
|
<a name="l00194"></a>00194 <span class="comment"> *</span>
|
|
<a name="l00195"></a>00195 <span class="comment"> * @param[in] sdp pointer to a @p SerialDriver structure</span>
|
|
<a name="l00196"></a>00196 <span class="comment"> * @param[in] b the byte to be written in the driver's Input Queue</span>
|
|
<a name="l00197"></a>00197 <span class="comment"> */</span>
|
|
<a name="l00198"></a><a class="code" href="group___s_e_r_i_a_l.html#gac94544bc991e2b85a601459463604346">00198</a> <span class="keywordtype">void</span> <a class="code" href="group___s_e_r_i_a_l.html#gac94544bc991e2b85a601459463604346" title="Handles incoming data.">sdIncomingDataI</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> b) {
|
|
<a name="l00199"></a>00199
|
|
<a name="l00200"></a>00200 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(sdp != NULL, <span class="stringliteral">"sdIncomingDataI"</span>);
|
|
<a name="l00201"></a>00201
|
|
<a name="l00202"></a>00202 <span class="keywordflow">if</span> (<a class="code" href="group__io__queues.html#ga01d87285eb173d213eb9849514969d7d" title="Evaluates to TRUE if the specified Input Queue is empty.">chIQIsEmpty</a>(&sdp->iqueue))
|
|
<a name="l00203"></a>00203 <a class="code" href="group__events.html#gaa24d9bed5b676b577200c4a8ebe3b8a3" title="Signals all the Event Listeners registered on the specified Event Source.">chEvtBroadcastI</a>(&sdp->ievent);
|
|
<a name="l00204"></a>00204 <span class="keywordflow">if</span> (<a class="code" href="group__io__queues.html#ga23b72ba9803de5a20caa84ffd0c193fc" title="Input queue write.">chIQPutI</a>(&sdp->iqueue, b) < <a class="code" href="group__io__queues.html#gadfbe2a9b3e7477d3fd4026d61caf1fcd" title="Returned by the queue functions if the operation is successful.">Q_OK</a>)
|
|
<a name="l00205"></a>00205 <a class="code" href="group___s_e_r_i_a_l.html#ga6c0462b840ea6364ca266a8d3fcb0945" title="Handles communication events/errors.">sdAddFlagsI</a>(sdp, <a class="code" href="group___s_e_r_i_a_l.html#ga81b11923717a67da5a0b8177821fcad2" title="Overflow happened.">SD_OVERRUN_ERROR</a>);
|
|
<a name="l00206"></a>00206 }
|
|
<a name="l00207"></a>00207 <span class="comment"></span>
|
|
<a name="l00208"></a>00208 <span class="comment">/**</span>
|
|
<a name="l00209"></a>00209 <span class="comment"> * @brief Handles outgoing data.</span>
|
|
<a name="l00210"></a>00210 <span class="comment"> * @details Must be called from the output interrupt service routine in order</span>
|
|
<a name="l00211"></a>00211 <span class="comment"> * to get the next byte to be transmitted.</span>
|
|
<a name="l00212"></a>00212 <span class="comment"> * @note In order to gain some performance it is suggested to not use</span>
|
|
<a name="l00213"></a>00213 <span class="comment"> * this function directly but copy this code directly into the</span>
|
|
<a name="l00214"></a>00214 <span class="comment"> * interrupt service routine.</span>
|
|
<a name="l00215"></a>00215 <span class="comment"> *</span>
|
|
<a name="l00216"></a>00216 <span class="comment"> * @param[in] sdp pointer to a @p SerialDriver structure</span>
|
|
<a name="l00217"></a>00217 <span class="comment"> * @return The byte value read from the driver's output queue.</span>
|
|
<a name="l00218"></a>00218 <span class="comment"> * @retval Q_EMPTY if the queue is empty (the lower driver usually</span>
|
|
<a name="l00219"></a>00219 <span class="comment"> * disables the interrupt source when this happens).</span>
|
|
<a name="l00220"></a>00220 <span class="comment"> */</span>
|
|
<a name="l00221"></a><a class="code" href="group___s_e_r_i_a_l.html#gafa1753aa30a6b79cc7e6de3e8a156fdc">00221</a> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group___s_e_r_i_a_l.html#gafa1753aa30a6b79cc7e6de3e8a156fdc" title="Handles outgoing data.">sdRequestDataI</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp) {
|
|
<a name="l00222"></a>00222 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> b;
|
|
<a name="l00223"></a>00223
|
|
<a name="l00224"></a>00224 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(sdp != NULL, <span class="stringliteral">"sdRequestDataI"</span>);
|
|
<a name="l00225"></a>00225
|
|
<a name="l00226"></a>00226 b = <a class="code" href="group__io__queues.html#ga34a5a71f39e94fcfdd88935da92a8ce9" title="Output queue read.">chOQGetI</a>(&sdp->oqueue);
|
|
<a name="l00227"></a>00227 <span class="keywordflow">if</span> (b < <a class="code" href="group__io__queues.html#gadfbe2a9b3e7477d3fd4026d61caf1fcd" title="Returned by the queue functions if the operation is successful.">Q_OK</a>)
|
|
<a name="l00228"></a>00228 <a class="code" href="group__events.html#gaa24d9bed5b676b577200c4a8ebe3b8a3" title="Signals all the Event Listeners registered on the specified Event Source.">chEvtBroadcastI</a>(&sdp->oevent);
|
|
<a name="l00229"></a>00229 <span class="keywordflow">return</span> b;
|
|
<a name="l00230"></a>00230 }
|
|
<a name="l00231"></a>00231 <span class="comment"></span>
|
|
<a name="l00232"></a>00232 <span class="comment">/**</span>
|
|
<a name="l00233"></a>00233 <span class="comment"> * @brief Handles communication events/errors.</span>
|
|
<a name="l00234"></a>00234 <span class="comment"> * @details Must be called from the I/O interrupt service routine in order to</span>
|
|
<a name="l00235"></a>00235 <span class="comment"> * notify I/O conditions as errors, signals change etc.</span>
|
|
<a name="l00236"></a>00236 <span class="comment"> *</span>
|
|
<a name="l00237"></a>00237 <span class="comment"> * @param[in] sdp pointer to a @p SerialDriver structure</span>
|
|
<a name="l00238"></a>00238 <span class="comment"> * @param[in] mask condition flags to be added to the mask</span>
|
|
<a name="l00239"></a>00239 <span class="comment"> */</span>
|
|
<a name="l00240"></a><a class="code" href="group___s_e_r_i_a_l.html#ga6c0462b840ea6364ca266a8d3fcb0945">00240</a> <span class="keywordtype">void</span> <a class="code" href="group___s_e_r_i_a_l.html#ga6c0462b840ea6364ca266a8d3fcb0945" title="Handles communication events/errors.">sdAddFlagsI</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp, <a class="code" href="group___s_e_r_i_a_l___l_l_d.html#gaf851732a0f47524edd346fe8ce24dcb8" title="Serial Driver condition flags type.">sdflags_t</a> mask) {
|
|
<a name="l00241"></a>00241
|
|
<a name="l00242"></a>00242 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(sdp != NULL, <span class="stringliteral">"sdAddFlagsI"</span>);
|
|
<a name="l00243"></a>00243
|
|
<a name="l00244"></a>00244 sdp->flags |= mask;
|
|
<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>(&sdp->sevent);
|
|
<a name="l00246"></a>00246 }
|
|
<a name="l00247"></a>00247 <span class="comment"></span>
|
|
<a name="l00248"></a>00248 <span class="comment">/**</span>
|
|
<a name="l00249"></a>00249 <span class="comment"> * @brief Returns and clears the errors mask associated to the driver.</span>
|
|
<a name="l00250"></a>00250 <span class="comment"> *</span>
|
|
<a name="l00251"></a>00251 <span class="comment"> * @param[in] sdp pointer to a @p SerialDriver structure</span>
|
|
<a name="l00252"></a>00252 <span class="comment"> * @return The condition flags modified since last time this</span>
|
|
<a name="l00253"></a>00253 <span class="comment"> * function was invoked.</span>
|
|
<a name="l00254"></a>00254 <span class="comment"> */</span>
|
|
<a name="l00255"></a><a class="code" href="group___s_e_r_i_a_l.html#gaa83db03502662f959e29b9fae964512d">00255</a> <a class="code" href="group___s_e_r_i_a_l___l_l_d.html#gaf851732a0f47524edd346fe8ce24dcb8" title="Serial Driver condition flags type.">sdflags_t</a> <a class="code" href="group___s_e_r_i_a_l.html#gaa83db03502662f959e29b9fae964512d" title="Returns and clears the errors mask associated to the driver.">sdGetAndClearFlags</a>(<a class="code" href="struct___serial_driver.html" title="Full duplex serial driver class.">SerialDriver</a> *sdp) {
|
|
<a name="l00256"></a>00256 <a class="code" href="group___s_e_r_i_a_l___l_l_d.html#gaf851732a0f47524edd346fe8ce24dcb8" title="Serial Driver condition flags type.">sdflags_t</a> mask;
|
|
<a name="l00257"></a>00257
|
|
<a name="l00258"></a>00258 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(sdp != NULL, <span class="stringliteral">"sdGetAndClearFlags"</span>);
|
|
<a name="l00259"></a>00259
|
|
<a name="l00260"></a>00260 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00261"></a>00261 mask = sdp->flags;
|
|
<a name="l00262"></a>00262 sdp->flags = <a class="code" href="group___s_e_r_i_a_l.html#ga56fc0a34c0ee335a69d11fe30ed8a2e0" title="No pending conditions.">SD_NO_ERROR</a>;
|
|
<a name="l00263"></a>00263 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00264"></a>00264 <span class="keywordflow">return</span> mask;
|
|
<a name="l00265"></a>00265 }
|
|
<a name="l00266"></a>00266
|
|
<a name="l00267"></a>00267 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_SERIAL */</span>
|
|
<a name="l00268"></a>00268 <span class="comment"></span>
|
|
<a name="l00269"></a>00269 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Jul 11 13:13:01 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>
|