mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
329 lines
32 KiB
HTML
329 lines
32 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: chioch.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.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<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="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<h1>chioch.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chioch_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 chioch.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief I/O channels.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> * @details This header defines abstract interfaces useful to access generic</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * I/O resources in a standardized way.</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> *</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * @addtogroup io_channels</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> * @details This module defines an abstract interface for I/O channels by</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * extending the @p BaseSequentialStream interface. Note that no code</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * is present, I/O channels are just abstract interface like</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * structures, you should look at the systems as to a set of abstract</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * C++ classes (even if written in C). Specific device drivers can</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * use/extend the interface and implement them.<br></span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * This system has the advantage to make the access to channels</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * independent from the implementation logic.</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * @{</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> */</span>
|
|
<a name="l00044"></a>00044
|
|
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef _CHIOCH_H_</span>
|
|
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#define _CHIOCH_H_</span>
|
|
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00048"></a>00048 <span class="comment">/**</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * @brief @p BaseChannel specific methods.</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> */</span>
|
|
<a name="l00051"></a><a class="code" href="group__io__channels.html#gaf5bd1e46b2d488dca8f3793b52a4c5f8">00051</a> <span class="preprocessor">#define _base_channel_methods \</span>
|
|
<a name="l00052"></a>00052 <span class="preprocessor"> _base_sequential_stream_methods \</span>
|
|
<a name="l00053"></a>00053 <span class="preprocessor"> </span><span class="comment">/* Channel output check.*/</span> \
|
|
<a name="l00054"></a>00054 bool_t (*putwouldblock)(void *instance); \
|
|
<a name="l00055"></a>00055 <span class="comment">/* Channel input check.*/</span> \
|
|
<a name="l00056"></a>00056 bool_t (*getwouldblock)(void *instance); \
|
|
<a name="l00057"></a>00057 <span class="comment">/* Channel put method with timeout specification.*/</span> \
|
|
<a name="l00058"></a>00058 msg_t (*put)(void *instance, uint8_t b, systime_t time); \
|
|
<a name="l00059"></a>00059 <span class="comment">/* Channel get method with timeout specification.*/</span> \
|
|
<a name="l00060"></a>00060 msg_t (*get)(void *instance, systime_t time); \
|
|
<a name="l00061"></a>00061 <span class="comment">/* Channel write method with timeout specification.*/</span> \
|
|
<a name="l00062"></a>00062 size_t (*writet)(void *instance, const uint8_t *bp, \
|
|
<a name="l00063"></a>00063 size_t n, systime_t time); \
|
|
<a name="l00064"></a>00064 <span class="comment">/* Channel read method with timeout specification.*/</span> \
|
|
<a name="l00065"></a>00065 size_t (*readt)(void *instance, uint8_t *bp, size_t n, systime_t time);
|
|
<a name="l00066"></a>00066 <span class="comment"></span>
|
|
<a name="l00067"></a>00067 <span class="comment">/**</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * @brief @p BaseChannel specific data.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> * @note It is empty because @p BaseChannel is only an interface without</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> * implementation.</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> */</span>
|
|
<a name="l00072"></a><a class="code" href="group__io__channels.html#gad2be0fba8350d51490b557900062a949">00072</a> <span class="preprocessor">#define _base_channel_data \</span>
|
|
<a name="l00073"></a>00073 <span class="preprocessor"> _base_sequential_stream_data</span>
|
|
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00075"></a>00075 <span class="comment">/**</span>
|
|
<a name="l00076"></a>00076 <span class="comment"> * @brief @p BaseChannel virtual methods table.</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> */</span>
|
|
<a name="l00078"></a><a class="code" href="struct_base_channel_v_m_t.html">00078</a> <span class="keyword">struct </span><a class="code" href="struct_base_channel_v_m_t.html" title="BaseChannel virtual methods table.">BaseChannelVMT</a> { \
|
|
<a name="l00079"></a>00079 <a class="code" href="group__io__channels.html#gaf5bd1e46b2d488dca8f3793b52a4c5f8" title="BaseChannel specific methods.">_base_channel_methods</a> \
|
|
<a name="l00080"></a>00080 };
|
|
<a name="l00081"></a>00081 <span class="comment"></span>
|
|
<a name="l00082"></a>00082 <span class="comment">/**</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> * @extends BaseSequentialStream</span>
|
|
<a name="l00084"></a>00084 <span class="comment"> *</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * @brief Base channel class.</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> * @details This class represents a generic, byte-wide, I/O channel. This class</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * introduces generic I/O primitives with timeout specification.</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> */</span>
|
|
<a name="l00089"></a><a class="code" href="struct_base_channel.html">00089</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span>
|
|
<a name="l00090"></a>00090 <span class="comment"> /** @brief Virtual Methods Table.*/</span>
|
|
<a name="l00091"></a><a class="code" href="struct_base_channel.html#a6ef2ba909e7957df35d2122266e2ac71">00091</a> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_base_channel_v_m_t.html" title="BaseChannel virtual methods table.">BaseChannelVMT</a> *vmt;
|
|
<a name="l00092"></a>00092 <a class="code" href="group__io__channels.html#gad2be0fba8350d51490b557900062a949" title="BaseChannel specific data.">_base_channel_data</a>
|
|
<a name="l00093"></a>00093 } <a class="code" href="struct_base_channel.html" title="Base channel class.">BaseChannel</a>;
|
|
<a name="l00094"></a>00094 <span class="comment"></span>
|
|
<a name="l00095"></a>00095 <span class="comment">/**</span>
|
|
<a name="l00096"></a>00096 <span class="comment"> * @brief Channel output check.</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * @details This function verifies if a subsequent put/write operation would</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> * block.</span>
|
|
<a name="l00099"></a>00099 <span class="comment"> *</span>
|
|
<a name="l00100"></a>00100 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00101"></a>00101 <span class="comment"> * @return The output queue status:</span>
|
|
<a name="l00102"></a>00102 <span class="comment"> * @retval FALSE if the output queue has space and would not block a</span>
|
|
<a name="l00103"></a>00103 <span class="comment"> * write operation.</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * @retval TRUE if the output queue is full and would block a write</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> * operation.</span>
|
|
<a name="l00106"></a>00106 <span class="comment"> */</span>
|
|
<a name="l00107"></a><a class="code" href="group__io__channels.html#ga248725580f06efca2b9222ac1780bdee">00107</a> <span class="preprocessor">#define chIOPutWouldBlock(ip) ((ip)->vmt->putwouldblock(ip))</span>
|
|
<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00109"></a>00109 <span class="comment">/**</span>
|
|
<a name="l00110"></a>00110 <span class="comment"> * @brief Channel input check.</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> * @details This function verifies if a subsequent get/read operation would</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * block.</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> *</span>
|
|
<a name="l00114"></a>00114 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00115"></a>00115 <span class="comment"> * @return The input queue status:</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> * @retval FALSE if the input queue contains data and would not block a</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> * read operation.</span>
|
|
<a name="l00118"></a>00118 <span class="comment"> * @retval TRUE if the input queue is empty and would block a read</span>
|
|
<a name="l00119"></a>00119 <span class="comment"> * operation.</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> */</span>
|
|
<a name="l00121"></a><a class="code" href="group__io__channels.html#ga389778a4742ae65edbfb7b1a7f8f832b">00121</a> <span class="preprocessor">#define chIOGetWouldBlock(ip) ((ip)->vmt->getwouldblock(ip))</span>
|
|
<a name="l00122"></a>00122 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00123"></a>00123 <span class="comment">/**</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> * @brief Channel blocking byte write.</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> * @details This function writes a byte value to a channel. If the channel</span>
|
|
<a name="l00126"></a>00126 <span class="comment"> * is not ready to accept data then the calling thread is suspended.</span>
|
|
<a name="l00127"></a>00127 <span class="comment"> *</span>
|
|
<a name="l00128"></a>00128 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00129"></a>00129 <span class="comment"> * @param[in] b the byte value to be written to the channel</span>
|
|
<a name="l00130"></a>00130 <span class="comment"> * @return The operation status:</span>
|
|
<a name="l00131"></a>00131 <span class="comment"> * @retval Q_OK if the operation succeeded.</span>
|
|
<a name="l00132"></a>00132 <span class="comment"> * @retval Q_RESET if the channel associated queue (if any) was reset.</span>
|
|
<a name="l00133"></a>00133 <span class="comment"> */</span>
|
|
<a name="l00134"></a><a class="code" href="group__io__channels.html#ga5b8537016d3027eedd3e63b708b57bf7">00134</a> <span class="preprocessor">#define chIOPut(ip, b) ((ip)->vmt->put(ip, b, TIME_INFINITE))</span>
|
|
<a name="l00135"></a>00135 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00136"></a>00136 <span class="comment">/**</span>
|
|
<a name="l00137"></a>00137 <span class="comment"> * @brief Channel blocking byte write with timeout.</span>
|
|
<a name="l00138"></a>00138 <span class="comment"> * @details This function writes a byte value to a channel. If the channel</span>
|
|
<a name="l00139"></a>00139 <span class="comment"> * is not ready to accept data then the calling thread is suspended.</span>
|
|
<a name="l00140"></a>00140 <span class="comment"> *</span>
|
|
<a name="l00141"></a>00141 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00142"></a>00142 <span class="comment"> * @param[in] b the byte value to be written to the channel</span>
|
|
<a name="l00143"></a>00143 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
|
<a name="l00144"></a>00144 <span class="comment"> * the following special values are allowed:</span>
|
|
<a name="l00145"></a>00145 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
|
<a name="l00146"></a>00146 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
|
<a name="l00147"></a>00147 <span class="comment"> * .</span>
|
|
<a name="l00148"></a>00148 <span class="comment"> * @return The operation status:</span>
|
|
<a name="l00149"></a>00149 <span class="comment"> * @retval Q_OK if the operation succeeded.</span>
|
|
<a name="l00150"></a>00150 <span class="comment"> * @retval Q_TIMEOUT if the specified time expired.</span>
|
|
<a name="l00151"></a>00151 <span class="comment"> * @retval Q_RESET if the channel associated queue (if any) was reset.</span>
|
|
<a name="l00152"></a>00152 <span class="comment"> */</span>
|
|
<a name="l00153"></a><a class="code" href="group__io__channels.html#gac0117cf153fb3e08743aa8fe1b5487da">00153</a> <span class="preprocessor">#define chIOPutTimeout(ip, b, time) ((ip)->vmt->put(ip, b, time))</span>
|
|
<a name="l00154"></a>00154 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00155"></a>00155 <span class="comment">/**</span>
|
|
<a name="l00156"></a>00156 <span class="comment"> * @brief Channel blocking byte read.</span>
|
|
<a name="l00157"></a>00157 <span class="comment"> * @details This function reads a byte value from a channel. If the data</span>
|
|
<a name="l00158"></a>00158 <span class="comment"> * is not available then the calling thread is suspended.</span>
|
|
<a name="l00159"></a>00159 <span class="comment"> *</span>
|
|
<a name="l00160"></a>00160 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00161"></a>00161 <span class="comment"> * @return A byte value from the queue or:</span>
|
|
<a name="l00162"></a>00162 <span class="comment"> * @retval Q_RESET if the channel associated queue (if any) was reset.</span>
|
|
<a name="l00163"></a>00163 <span class="comment"> */</span>
|
|
<a name="l00164"></a><a class="code" href="group__io__channels.html#ga9ebccb48ead8398cf97ca7a564fe0a25">00164</a> <span class="preprocessor">#define chIOGet(ip) ((ip)->vmt->get(ip, TIME_INFINITE))</span>
|
|
<a name="l00165"></a>00165 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00166"></a>00166 <span class="comment">/**</span>
|
|
<a name="l00167"></a>00167 <span class="comment"> * @brief Channel blocking byte read with timeout.</span>
|
|
<a name="l00168"></a>00168 <span class="comment"> * @details This function reads a byte value from a channel. If the data</span>
|
|
<a name="l00169"></a>00169 <span class="comment"> * is not available then the calling thread is suspended.</span>
|
|
<a name="l00170"></a>00170 <span class="comment"> *</span>
|
|
<a name="l00171"></a>00171 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00172"></a>00172 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
|
<a name="l00173"></a>00173 <span class="comment"> * the following special values are allowed:</span>
|
|
<a name="l00174"></a>00174 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
|
<a name="l00175"></a>00175 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
|
<a name="l00176"></a>00176 <span class="comment"> * .</span>
|
|
<a name="l00177"></a>00177 <span class="comment"> * @return A byte value from the queue or:</span>
|
|
<a name="l00178"></a>00178 <span class="comment"> * @retval Q_TIMEOUT if the specified time expired.</span>
|
|
<a name="l00179"></a>00179 <span class="comment"> * @retval Q_RESET if the channel associated queue (if any) was reset.</span>
|
|
<a name="l00180"></a>00180 <span class="comment"> */</span>
|
|
<a name="l00181"></a><a class="code" href="group__io__channels.html#gace21d03c2ffbae1bf56b8a0b612421ba">00181</a> <span class="preprocessor">#define chIOGetTimeout(ip, time) ((ip)->vmt->get(ip, time))</span>
|
|
<a name="l00182"></a>00182 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00183"></a>00183 <span class="comment">/**</span>
|
|
<a name="l00184"></a>00184 <span class="comment"> * @brief Channel blocking write with timeout.</span>
|
|
<a name="l00185"></a>00185 <span class="comment"> * @details The function writes data from a buffer to a channel. If the channel</span>
|
|
<a name="l00186"></a>00186 <span class="comment"> * is not ready to accept data then the calling thread is suspended.</span>
|
|
<a name="l00187"></a>00187 <span class="comment"> *</span>
|
|
<a name="l00188"></a>00188 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00189"></a>00189 <span class="comment"> * @param[out] bp pointer to the data buffer</span>
|
|
<a name="l00190"></a>00190 <span class="comment"> * @param[in] n the maximum amount of data to be transferred</span>
|
|
<a name="l00191"></a>00191 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
|
<a name="l00192"></a>00192 <span class="comment"> * the following special values are allowed:</span>
|
|
<a name="l00193"></a>00193 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
|
<a name="l00194"></a>00194 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
|
<a name="l00195"></a>00195 <span class="comment"> * .</span>
|
|
<a name="l00196"></a>00196 <span class="comment"> * @return The number of bytes transferred.</span>
|
|
<a name="l00197"></a>00197 <span class="comment"> */</span>
|
|
<a name="l00198"></a><a class="code" href="group__io__channels.html#ga432c7fbf8b1109bba566986143e9da21">00198</a> <span class="preprocessor">#define chIOWriteTimeout(ip, bp, n, time) \</span>
|
|
<a name="l00199"></a>00199 <span class="preprocessor"> ((ip)->vmt->writet(ip, bp, n, time))</span>
|
|
<a name="l00200"></a>00200 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00201"></a>00201 <span class="comment">/**</span>
|
|
<a name="l00202"></a>00202 <span class="comment"> * @brief Channel blocking read with timeout.</span>
|
|
<a name="l00203"></a>00203 <span class="comment"> * @details The function reads data from a channel into a buffer. If the data</span>
|
|
<a name="l00204"></a>00204 <span class="comment"> * is not available then the calling thread is suspended.</span>
|
|
<a name="l00205"></a>00205 <span class="comment"> *</span>
|
|
<a name="l00206"></a>00206 <span class="comment"> * @param[in] ip pointer to a @p BaseChannel or derived class</span>
|
|
<a name="l00207"></a>00207 <span class="comment"> * @param[in] bp pointer to the data buffer</span>
|
|
<a name="l00208"></a>00208 <span class="comment"> * @param[in] n the maximum amount of data to be transferred</span>
|
|
<a name="l00209"></a>00209 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
|
<a name="l00210"></a>00210 <span class="comment"> * the following special values are allowed:</span>
|
|
<a name="l00211"></a>00211 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
|
<a name="l00212"></a>00212 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
|
<a name="l00213"></a>00213 <span class="comment"> * .</span>
|
|
<a name="l00214"></a>00214 <span class="comment"> * @return The number of bytes transferred.</span>
|
|
<a name="l00215"></a>00215 <span class="comment"> */</span>
|
|
<a name="l00216"></a><a class="code" href="group__io__channels.html#ga98c9dc44ce78e6ac026235eea93b6911">00216</a> <span class="preprocessor">#define chIOReadTimeout(ip, bp, n, time) \</span>
|
|
<a name="l00217"></a>00217 <span class="preprocessor"> ((ip)->vmt->readt(ip, bp, n, time))</span>
|
|
<a name="l00218"></a>00218 <span class="preprocessor"></span>
|
|
<a name="l00219"></a>00219 <span class="preprocessor">#if CH_USE_EVENTS</span>
|
|
<a name="l00220"></a>00220 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00221"></a>00221 <span class="comment"> * @brief @p BaseAsynchronousChannel specific methods.</span>
|
|
<a name="l00222"></a>00222 <span class="comment"> */</span>
|
|
<a name="l00223"></a><a class="code" href="group__io__channels.html#gaf23d5351675080d08be4cac30c5de151">00223</a> <span class="preprocessor">#define _base_asynchronous_channel_methods \</span>
|
|
<a name="l00224"></a>00224 <span class="preprocessor"> _base_channel_methods</span>
|
|
<a name="l00225"></a>00225 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00226"></a>00226 <span class="comment">/**</span>
|
|
<a name="l00227"></a>00227 <span class="comment"> * @brief @p BaseAsynchronousChannel specific data.</span>
|
|
<a name="l00228"></a>00228 <span class="comment"> */</span>
|
|
<a name="l00229"></a><a class="code" href="group__io__channels.html#ga6c1762f0b3873dd09f9e655c951b9300">00229</a> <span class="preprocessor">#define _base_asynchronous_channel_data \</span>
|
|
<a name="l00230"></a>00230 <span class="preprocessor"> _base_channel_data \</span>
|
|
<a name="l00231"></a>00231 <span class="preprocessor"> </span><span class="comment">/* Data Available EventSource.*/</span> \
|
|
<a name="l00232"></a>00232 EventSource ievent; \
|
|
<a name="l00233"></a>00233 <span class="comment">/* Data Transmitted EventSource.*/</span> \
|
|
<a name="l00234"></a>00234 EventSource oevent;
|
|
<a name="l00235"></a>00235 <span class="comment"></span>
|
|
<a name="l00236"></a>00236 <span class="comment">/**</span>
|
|
<a name="l00237"></a>00237 <span class="comment"> * @brief @p BaseAsynchronousChannel virtual methods table.</span>
|
|
<a name="l00238"></a>00238 <span class="comment"> */</span>
|
|
<a name="l00239"></a><a class="code" href="struct_base_asynchronous_channel_v_m_t.html">00239</a> <span class="keyword">struct </span><a class="code" href="struct_base_asynchronous_channel_v_m_t.html" title="BaseAsynchronousChannel virtual methods table.">BaseAsynchronousChannelVMT</a> {
|
|
<a name="l00240"></a>00240 <a class="code" href="group__io__channels.html#gaf23d5351675080d08be4cac30c5de151" title="BaseAsynchronousChannel specific methods.">_base_asynchronous_channel_methods</a>
|
|
<a name="l00241"></a>00241 };
|
|
<a name="l00242"></a>00242 <span class="comment"></span>
|
|
<a name="l00243"></a>00243 <span class="comment">/**</span>
|
|
<a name="l00244"></a>00244 <span class="comment"> * @extends BaseChannel</span>
|
|
<a name="l00245"></a>00245 <span class="comment"> *</span>
|
|
<a name="l00246"></a>00246 <span class="comment"> * @brief Base asynchronous channel class.</span>
|
|
<a name="l00247"></a>00247 <span class="comment"> * @details This class extends @p BaseChannel by adding event sources fields</span>
|
|
<a name="l00248"></a>00248 <span class="comment"> * for asynchronous I/O for use in an event-driven environment.</span>
|
|
<a name="l00249"></a>00249 <span class="comment"> */</span>
|
|
<a name="l00250"></a><a class="code" href="struct_base_asynchronous_channel.html">00250</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span>
|
|
<a name="l00251"></a>00251 <span class="comment"> /** @brief Virtual Methods Table.*/</span>
|
|
<a name="l00252"></a><a class="code" href="struct_base_asynchronous_channel.html#a9165d22a9bcd6f02796f360fb7dd7fe9">00252</a> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_base_asynchronous_channel_v_m_t.html" title="BaseAsynchronousChannel virtual methods table.">BaseAsynchronousChannelVMT</a> *vmt;
|
|
<a name="l00253"></a>00253 <a class="code" href="group__io__channels.html#ga6c1762f0b3873dd09f9e655c951b9300" title="BaseAsynchronousChannel specific data.">_base_asynchronous_channel_data</a>
|
|
<a name="l00254"></a>00254 } <a class="code" href="struct_base_asynchronous_channel.html" title="Base asynchronous channel class.">BaseAsynchronousChannel</a>;
|
|
<a name="l00255"></a>00255 <span class="comment"></span>
|
|
<a name="l00256"></a>00256 <span class="comment">/**</span>
|
|
<a name="l00257"></a>00257 <span class="comment"> * @brief Returns the write event source.</span>
|
|
<a name="l00258"></a>00258 <span class="comment"> * @details The write event source is broadcasted when the channel is ready</span>
|
|
<a name="l00259"></a>00259 <span class="comment"> * for write operations. This usually happens when the internal</span>
|
|
<a name="l00260"></a>00260 <span class="comment"> * output queue becomes empty.</span>
|
|
<a name="l00261"></a>00261 <span class="comment"> *</span>
|
|
<a name="l00262"></a>00262 <span class="comment"> * @param[in] ip pointer to a @p BaseAsynchronousChannel or derived</span>
|
|
<a name="l00263"></a>00263 <span class="comment"> * class</span>
|
|
<a name="l00264"></a>00264 <span class="comment"> * @return A pointer to an @p EventSource object.</span>
|
|
<a name="l00265"></a>00265 <span class="comment"> */</span>
|
|
<a name="l00266"></a><a class="code" href="group__io__channels.html#ga1cdb36c296d20ee411fcf041a1ad80d1">00266</a> <span class="preprocessor">#define chIOGetWriteEventSource(ip) (&((ip)->vmt->oevent))</span>
|
|
<a name="l00267"></a>00267 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00268"></a>00268 <span class="comment">/**</span>
|
|
<a name="l00269"></a>00269 <span class="comment"> * @brief Returns the read event source.</span>
|
|
<a name="l00270"></a>00270 <span class="comment"> * @details The read event source is broadcasted when the channel is ready</span>
|
|
<a name="l00271"></a>00271 <span class="comment"> * for read operations. This usually happens when the internal</span>
|
|
<a name="l00272"></a>00272 <span class="comment"> * input queue becomes non-empty.</span>
|
|
<a name="l00273"></a>00273 <span class="comment"> *</span>
|
|
<a name="l00274"></a>00274 <span class="comment"> * @param[in] ip pointer to a @p BaseAsynchronousChannel or derived</span>
|
|
<a name="l00275"></a>00275 <span class="comment"> * class</span>
|
|
<a name="l00276"></a>00276 <span class="comment"> * @return A pointer to an @p EventSource object.</span>
|
|
<a name="l00277"></a>00277 <span class="comment"> */</span>
|
|
<a name="l00278"></a><a class="code" href="group__io__channels.html#ga763229d3f6ded408f4126dcf121f0baf">00278</a> <span class="preprocessor">#define chIOGetReadEventSource(ip) (&((ip)->vmt->ievent))</span>
|
|
<a name="l00279"></a>00279 <span class="preprocessor"></span>
|
|
<a name="l00280"></a>00280 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_EVENTS */</span>
|
|
<a name="l00281"></a>00281
|
|
<a name="l00282"></a>00282 <span class="preprocessor">#endif </span><span class="comment">/* _CHIOCH_H_ */</span>
|
|
<a name="l00283"></a>00283 <span class="comment"></span>
|
|
<a name="l00284"></a>00284 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|