mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
402 lines
51 KiB
HTML
402 lines
51 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: chqueues.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>chqueues.c</h1><a href="chqueues_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 chqueues.c</span>
|
||
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief I/O Queues code.</span>
|
||
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
||
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup io_queues</span>
|
||
|
|
<a name="l00032"></a>00032 <span class="comment"> * @details ChibiOS/RT queues are mostly used in serial-like device drivers.</span>
|
||
|
|
<a name="l00033"></a>00033 <span class="comment"> * The device drivers are usually designed to have a lower side</span>
|
||
|
|
<a name="l00034"></a>00034 <span class="comment"> * (lower driver, it is usually an interrupt service routine) and an</span>
|
||
|
|
<a name="l00035"></a>00035 <span class="comment"> * upper side (upper driver, accessed by the application threads).<br></span>
|
||
|
|
<a name="l00036"></a>00036 <span class="comment"> * There are several kind of queues:<br></span>
|
||
|
|
<a name="l00037"></a>00037 <span class="comment"> * - <b>Input queue</b>, unidirectional queue where the writer is the</span>
|
||
|
|
<a name="l00038"></a>00038 <span class="comment"> * lower side and the reader is the upper side.</span>
|
||
|
|
<a name="l00039"></a>00039 <span class="comment"> * - <b>Output queue</b>, unidirectional queue where the writer is the</span>
|
||
|
|
<a name="l00040"></a>00040 <span class="comment"> * upper side and the reader is the lower side.</span>
|
||
|
|
<a name="l00041"></a>00041 <span class="comment"> * - <b>Full duplex queue</b>, bidirectional queue. Full duplex queues</span>
|
||
|
|
<a name="l00042"></a>00042 <span class="comment"> * are implemented by pairing an input queue and an output queue</span>
|
||
|
|
<a name="l00043"></a>00043 <span class="comment"> * together.</span>
|
||
|
|
<a name="l00044"></a>00044 <span class="comment"> * .</span>
|
||
|
|
<a name="l00045"></a>00045 <span class="comment"> * In order to use the I/O queues the @p CH_USE_QUEUES option must</span>
|
||
|
|
<a name="l00046"></a>00046 <span class="comment"> * be enabled in @p chconf.h.<br></span>
|
||
|
|
<a name="l00047"></a>00047 <span class="comment"> * I/O queues are usually used as an implementation layer for the I/O</span>
|
||
|
|
<a name="l00048"></a>00048 <span class="comment"> * channels interface, also see @ref io_channels.</span>
|
||
|
|
<a name="l00049"></a>00049 <span class="comment"> * @{</span>
|
||
|
|
<a name="l00050"></a>00050 <span class="comment"> */</span>
|
||
|
|
<a name="l00051"></a>00051
|
||
|
|
<a name="l00052"></a>00052 <span class="preprocessor">#include "<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>"</span>
|
||
|
|
<a name="l00053"></a>00053
|
||
|
|
<a name="l00054"></a>00054 <span class="preprocessor">#if CH_USE_QUEUES</span>
|
||
|
|
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="comment"></span>
|
||
|
|
<a name="l00056"></a>00056 <span class="comment">/**</span>
|
||
|
|
<a name="l00057"></a>00057 <span class="comment"> * @brief Initializes an input queue.</span>
|
||
|
|
<a name="l00058"></a>00058 <span class="comment"> * @details A Semaphore is internally initialized and works as a counter of</span>
|
||
|
|
<a name="l00059"></a>00059 <span class="comment"> * the bytes contained in the queue.</span>
|
||
|
|
<a name="l00060"></a>00060 <span class="comment"> * @note The callback is invoked from within the S-Locked system state,</span>
|
||
|
|
<a name="l00061"></a>00061 <span class="comment"> * see @ref system_states.</span>
|
||
|
|
<a name="l00062"></a>00062 <span class="comment"> *</span>
|
||
|
|
<a name="l00063"></a>00063 <span class="comment"> * @param[out] iqp pointer to an @p InputQueue structure</span>
|
||
|
|
<a name="l00064"></a>00064 <span class="comment"> * @param[in] bp pointer to a memory area allocated as queue buffer</span>
|
||
|
|
<a name="l00065"></a>00065 <span class="comment"> * @param[in] size size of the queue buffer</span>
|
||
|
|
<a name="l00066"></a>00066 <span class="comment"> * @param[in] infy pointer to a callback function that is invoked when</span>
|
||
|
|
<a name="l00067"></a>00067 <span class="comment"> * data is read from the queue. The value can be @p NULL.</span>
|
||
|
|
<a name="l00068"></a>00068 <span class="comment"> */</span>
|
||
|
|
<a name="l00069"></a><a class="code" href="group__io__queues.html#ga0d3a250e6572526b165d2c61f69230e5">00069</a> <span class="keywordtype">void</span> <a class="code" href="group__io__queues.html#ga0d3a250e6572526b165d2c61f69230e5" title="Initializes an input queue.">chIQInit</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">InputQueue</a> *iqp, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp, <span class="keywordtype">size_t</span> size, <a class="code" href="group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title="Queue notification callback type.">qnotify_t</a> infy) {
|
||
|
|
<a name="l00070"></a>00070
|
||
|
|
<a name="l00071"></a>00071 iqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a> = iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = iqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = bp;
|
||
|
|
<a name="l00072"></a>00072 iqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a> = bp + size;
|
||
|
|
<a name="l00073"></a>00073 iqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a> = infy;
|
||
|
|
<a name="l00074"></a>00074 <a class="code" href="group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title="Initializes a semaphore with the specified counter value.">chSemInit</a>(&iqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, 0);
|
||
|
|
<a name="l00075"></a>00075 }
|
||
|
|
<a name="l00076"></a>00076 <span class="comment"></span>
|
||
|
|
<a name="l00077"></a>00077 <span class="comment">/**</span>
|
||
|
|
<a name="l00078"></a>00078 <span class="comment"> * @brief Resets an input queue.</span>
|
||
|
|
<a name="l00079"></a>00079 <span class="comment"> * @details All the data in the input queue is erased and lost, any waiting</span>
|
||
|
|
<a name="l00080"></a>00080 <span class="comment"> * thread is resumed with status @p Q_RESET.</span>
|
||
|
|
<a name="l00081"></a>00081 <span class="comment"> * @note A reset operation can be used by a low level driver in order to</span>
|
||
|
|
<a name="l00082"></a>00082 <span class="comment"> * obtain immediate attention from the high level layers.</span>
|
||
|
|
<a name="l00083"></a>00083 <span class="comment"> *</span>
|
||
|
|
<a name="l00084"></a>00084 <span class="comment"> * @param[in] iqp pointer to an @p InputQueue structure</span>
|
||
|
|
<a name="l00085"></a>00085 <span class="comment"> */</span>
|
||
|
|
<a name="l00086"></a><a class="code" href="group__io__queues.html#ga2252ca3e5d6ee6d8d323d025365aee59">00086</a> <span class="keywordtype">void</span> <a class="code" href="group__io__queues.html#ga2252ca3e5d6ee6d8d323d025365aee59" title="Resets an input queue.">chIQResetI</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">InputQueue</a> *iqp) {
|
||
|
|
<a name="l00087"></a>00087
|
||
|
|
<a name="l00088"></a>00088 iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = iqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = iqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00089"></a>00089 <a class="code" href="group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title="Performs a reset operation on the semaphore.">chSemResetI</a>(&iqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, 0);
|
||
|
|
<a name="l00090"></a>00090 }
|
||
|
|
<a name="l00091"></a>00091 <span class="comment"></span>
|
||
|
|
<a name="l00092"></a>00092 <span class="comment">/**</span>
|
||
|
|
<a name="l00093"></a>00093 <span class="comment"> * @brief Input queue write.</span>
|
||
|
|
<a name="l00094"></a>00094 <span class="comment"> * @details A byte value is written into the low end of an input queue.</span>
|
||
|
|
<a name="l00095"></a>00095 <span class="comment"> *</span>
|
||
|
|
<a name="l00096"></a>00096 <span class="comment"> * @param[in] iqp pointer to an @p InputQueue structure</span>
|
||
|
|
<a name="l00097"></a>00097 <span class="comment"> * @param[in] b the byte value to be written in the queue</span>
|
||
|
|
<a name="l00098"></a>00098 <span class="comment"> * @return The operation status, it can be one of:</span>
|
||
|
|
<a name="l00099"></a>00099 <span class="comment"> * @retval Q_OK if the operation has been completed with success.</span>
|
||
|
|
<a name="l00100"></a>00100 <span class="comment"> * @retval Q_FULL if the queue is full and the operation cannot be</span>
|
||
|
|
<a name="l00101"></a>00101 <span class="comment"> * completed.</span>
|
||
|
|
<a name="l00102"></a>00102 <span class="comment"> */</span>
|
||
|
|
<a name="l00103"></a><a class="code" href="group__io__queues.html#ga23b72ba9803de5a20caa84ffd0c193fc">00103</a> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__io__queues.html#ga23b72ba9803de5a20caa84ffd0c193fc" title="Input queue write.">chIQPutI</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">InputQueue</a> *iqp, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> b) {
|
||
|
|
<a name="l00104"></a>00104
|
||
|
|
<a name="l00105"></a>00105 <span class="keywordflow">if</span> (<a class="code" href="group__io__queues.html#ga3b87d6f7e4110c882b13870930db5cbb" title="Evaluates to TRUE if the specified Input Queue is full.">chIQIsFull</a>(iqp))
|
||
|
|
<a name="l00106"></a>00106 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga6c462ef0a5b01afbd0d94a8e1ac8575a" title="Returned by the queue functions if the queue is full.">Q_FULL</a>;
|
||
|
|
<a name="l00107"></a>00107
|
||
|
|
<a name="l00108"></a>00108 *iqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a>++ = b;
|
||
|
|
<a name="l00109"></a>00109 <span class="keywordflow">if</span> (iqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> >= iqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a>)
|
||
|
|
<a name="l00110"></a>00110 iqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = iqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00111"></a>00111 <a class="code" href="group__semaphores.html#gaca0b70cf495a9cb7569e1cf5b07e2b3d" title="Performs a signal operation on a semaphore.">chSemSignalI</a>(&iqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>);
|
||
|
|
<a name="l00112"></a>00112 <span class="keywordflow">return</span> <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="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 Input queue read with timeout.</span>
|
||
|
|
<a name="l00117"></a>00117 <span class="comment"> * @details This function reads a byte value from an input queue. If the queue</span>
|
||
|
|
<a name="l00118"></a>00118 <span class="comment"> * is empty then the calling thread is suspended until a byte arrives</span>
|
||
|
|
<a name="l00119"></a>00119 <span class="comment"> * in the queue or a timeout occurs.</span>
|
||
|
|
<a name="l00120"></a>00120 <span class="comment"> *</span>
|
||
|
|
<a name="l00121"></a>00121 <span class="comment"> * @param[in] iqp pointer to an @p InputQueue structure</span>
|
||
|
|
<a name="l00122"></a>00122 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
||
|
|
<a name="l00123"></a>00123 <span class="comment"> * the following special values are allowed:</span>
|
||
|
|
<a name="l00124"></a>00124 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
||
|
|
<a name="l00125"></a>00125 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
||
|
|
<a name="l00126"></a>00126 <span class="comment"> * .</span>
|
||
|
|
<a name="l00127"></a>00127 <span class="comment"> * @return A byte value from the queue or:</span>
|
||
|
|
<a name="l00128"></a>00128 <span class="comment"> * @retval Q_TIMEOUT if the specified time expired.</span>
|
||
|
|
<a name="l00129"></a>00129 <span class="comment"> * @retval Q_RESET if the queue was reset.</span>
|
||
|
|
<a name="l00130"></a>00130 <span class="comment"> */</span>
|
||
|
|
<a name="l00131"></a><a class="code" href="group__io__queues.html#ga142d0e885ac3a695f5f033a65f49abd0">00131</a> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__io__queues.html#ga142d0e885ac3a695f5f033a65f49abd0" title="Input queue read with timeout.">chIQGetTimeout</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">InputQueue</a> *iqp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time) {
|
||
|
|
<a name="l00132"></a>00132 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> b;
|
||
|
|
<a name="l00133"></a>00133 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg;
|
||
|
|
<a name="l00134"></a>00134
|
||
|
|
<a name="l00135"></a>00135 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00136"></a>00136
|
||
|
|
<a name="l00137"></a>00137 <span class="keywordflow">if</span> (iqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a>)
|
||
|
|
<a name="l00138"></a>00138 iqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a>();
|
||
|
|
<a name="l00139"></a>00139
|
||
|
|
<a name="l00140"></a>00140 <span class="keywordflow">if</span> ((msg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&iqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, time)) < <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
|
||
|
|
<a name="l00141"></a>00141 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00142"></a>00142 <span class="keywordflow">return</span> msg;
|
||
|
|
<a name="l00143"></a>00143 }
|
||
|
|
<a name="l00144"></a>00144 b = *iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a>++;
|
||
|
|
<a name="l00145"></a>00145 <span class="keywordflow">if</span> (iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> >= iqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a>)
|
||
|
|
<a name="l00146"></a>00146 iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = iqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00147"></a>00147
|
||
|
|
<a name="l00148"></a>00148 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00149"></a>00149 <span class="keywordflow">return</span> b;
|
||
|
|
<a name="l00150"></a>00150 }
|
||
|
|
<a name="l00151"></a>00151 <span class="comment"></span>
|
||
|
|
<a name="l00152"></a>00152 <span class="comment">/**</span>
|
||
|
|
<a name="l00153"></a>00153 <span class="comment"> * @brief Input queue read with timeout.</span>
|
||
|
|
<a name="l00154"></a>00154 <span class="comment"> * @details The function reads data from an input queue into a buffer. The</span>
|
||
|
|
<a name="l00155"></a>00155 <span class="comment"> * operation completes when the specified amount of data has been</span>
|
||
|
|
<a name="l00156"></a>00156 <span class="comment"> * transferred or after the specified timeout or if the queue has</span>
|
||
|
|
<a name="l00157"></a>00157 <span class="comment"> * been reset.</span>
|
||
|
|
<a name="l00158"></a>00158 <span class="comment"> * @note The function is not atomic, if you need atomicity it is suggested</span>
|
||
|
|
<a name="l00159"></a>00159 <span class="comment"> * to use a semaphore or a mutex for mutual exclusion.</span>
|
||
|
|
<a name="l00160"></a>00160 <span class="comment"> * @note The queue callback is invoked before entering a sleep state and at</span>
|
||
|
|
<a name="l00161"></a>00161 <span class="comment"> * the end of the transfer.</span>
|
||
|
|
<a name="l00162"></a>00162 <span class="comment"> *</span>
|
||
|
|
<a name="l00163"></a>00163 <span class="comment"> * @param[in] iqp pointer to an @p InputQueue structure</span>
|
||
|
|
<a name="l00164"></a>00164 <span class="comment"> * @param[out] bp pointer to the data buffer</span>
|
||
|
|
<a name="l00165"></a>00165 <span class="comment"> * @param[in] n the maximum amount of data to be transferred, the</span>
|
||
|
|
<a name="l00166"></a>00166 <span class="comment"> * value 0 is reserved</span>
|
||
|
|
<a name="l00167"></a>00167 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
||
|
|
<a name="l00168"></a>00168 <span class="comment"> * the following special values are allowed:</span>
|
||
|
|
<a name="l00169"></a>00169 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
||
|
|
<a name="l00170"></a>00170 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
||
|
|
<a name="l00171"></a>00171 <span class="comment"> * .</span>
|
||
|
|
<a name="l00172"></a>00172 <span class="comment"> * @return The number of bytes effectively transferred.</span>
|
||
|
|
<a name="l00173"></a>00173 <span class="comment"> */</span>
|
||
|
|
<a name="l00174"></a><a class="code" href="group__io__queues.html#gaddf6fc39af7d905c9f23afde14d8d764">00174</a> <span class="keywordtype">size_t</span> <a class="code" href="group__io__queues.html#gaddf6fc39af7d905c9f23afde14d8d764" title="Input queue read with timeout.">chIQReadTimeout</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">InputQueue</a> *iqp, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp,
|
||
|
|
<a name="l00175"></a>00175 <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="l00176"></a>00176 <a class="code" href="group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title="Queue notification callback type.">qnotify_t</a> nfy = iqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a>;
|
||
|
|
<a name="l00177"></a>00177 <span class="keywordtype">size_t</span> r = 0;
|
||
|
|
<a name="l00178"></a>00178
|
||
|
|
<a name="l00179"></a>00179 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(n > 0, <span class="stringliteral">"chIQReadTimeout"</span>);
|
||
|
|
<a name="l00180"></a>00180
|
||
|
|
<a name="l00181"></a>00181 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00182"></a>00182 <span class="keywordflow">while</span> (TRUE) {
|
||
|
|
<a name="l00183"></a>00183 <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>(iqp)) {
|
||
|
|
<a name="l00184"></a>00184 <span class="keywordflow">if</span> (nfy)
|
||
|
|
<a name="l00185"></a>00185 nfy();
|
||
|
|
<a name="l00186"></a>00186 <span class="keywordflow">if</span> ((<a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&iqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, time) != <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>)) {
|
||
|
|
<a name="l00187"></a>00187 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00188"></a>00188 <span class="keywordflow">return</span> r;
|
||
|
|
<a name="l00189"></a>00189 }
|
||
|
|
<a name="l00190"></a>00190 }
|
||
|
|
<a name="l00191"></a>00191 <span class="keywordflow">else</span>
|
||
|
|
<a name="l00192"></a>00192 <a class="code" href="group__semaphores.html#ga748b56bc2be187e316496d7b6e748f89" title="Decreases the semaphore counter.">chSemFastWaitI</a>(&iqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>);
|
||
|
|
<a name="l00193"></a>00193 *bp++ = *iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a>++;
|
||
|
|
<a name="l00194"></a>00194 <span class="keywordflow">if</span> (iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> >= iqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a>)
|
||
|
|
<a name="l00195"></a>00195 iqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = iqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00196"></a>00196 <span class="keywordflow">if</span> (nfy)
|
||
|
|
<a name="l00197"></a>00197 nfy();
|
||
|
|
<a name="l00198"></a>00198 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>(); <span class="comment">/* Gives a preemption chance in a controlled point.*/</span>
|
||
|
|
<a name="l00199"></a>00199 r++;
|
||
|
|
<a name="l00200"></a>00200 <span class="keywordflow">if</span> (--n == 0) {
|
||
|
|
<a name="l00201"></a>00201 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00202"></a>00202 <span class="keywordflow">if</span> (nfy)
|
||
|
|
<a name="l00203"></a>00203 nfy();
|
||
|
|
<a name="l00204"></a>00204 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00205"></a>00205 <span class="keywordflow">return</span> r;
|
||
|
|
<a name="l00206"></a>00206 }
|
||
|
|
<a name="l00207"></a>00207 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00208"></a>00208 }
|
||
|
|
<a name="l00209"></a>00209 }
|
||
|
|
<a name="l00210"></a>00210 <span class="comment"></span>
|
||
|
|
<a name="l00211"></a>00211 <span class="comment">/**</span>
|
||
|
|
<a name="l00212"></a>00212 <span class="comment"> * @brief Initializes an output queue.</span>
|
||
|
|
<a name="l00213"></a>00213 <span class="comment"> * @details A Semaphore is internally initialized and works as a counter of</span>
|
||
|
|
<a name="l00214"></a>00214 <span class="comment"> * the free bytes in the queue.</span>
|
||
|
|
<a name="l00215"></a>00215 <span class="comment"> * @note The callback is invoked from within the S-Locked system state,</span>
|
||
|
|
<a name="l00216"></a>00216 <span class="comment"> * see @ref system_states.</span>
|
||
|
|
<a name="l00217"></a>00217 <span class="comment"> *</span>
|
||
|
|
<a name="l00218"></a>00218 <span class="comment"> * @param[out] oqp pointer to an @p OutputQueue structure</span>
|
||
|
|
<a name="l00219"></a>00219 <span class="comment"> * @param[in] bp pointer to a memory area allocated as queue buffer</span>
|
||
|
|
<a name="l00220"></a>00220 <span class="comment"> * @param[in] size size of the queue buffer</span>
|
||
|
|
<a name="l00221"></a>00221 <span class="comment"> * @param[in] onfy pointer to a callback function that is invoked when</span>
|
||
|
|
<a name="l00222"></a>00222 <span class="comment"> * data is written to the queue. The value can be @p NULL.</span>
|
||
|
|
<a name="l00223"></a>00223 <span class="comment"> */</span>
|
||
|
|
<a name="l00224"></a><a class="code" href="group__io__queues.html#gae2a5a0ef7c488ac02762e76933baa7b1">00224</a> <span class="keywordtype">void</span> <a class="code" href="group__io__queues.html#gae2a5a0ef7c488ac02762e76933baa7b1" title="Initializes an output queue.">chOQInit</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">OutputQueue</a> *oqp, <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp, <span class="keywordtype">size_t</span> size, <a class="code" href="group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title="Queue notification callback type.">qnotify_t</a> onfy) {
|
||
|
|
<a name="l00225"></a>00225
|
||
|
|
<a name="l00226"></a>00226 oqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a> = oqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = bp;
|
||
|
|
<a name="l00227"></a>00227 oqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a> = bp + size;
|
||
|
|
<a name="l00228"></a>00228 oqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a> = onfy;
|
||
|
|
<a name="l00229"></a>00229 <a class="code" href="group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title="Initializes a semaphore with the specified counter value.">chSemInit</a>(&oqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, (<a class="code" href="group__types.html#ga090b3bab5602157ebf706a44041dc05e" title="Counter, recommended fastest signed.">cnt_t</a>)size);
|
||
|
|
<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 Resets an output queue.</span>
|
||
|
|
<a name="l00234"></a>00234 <span class="comment"> * @details All the data in the output queue is erased and lost, any waiting</span>
|
||
|
|
<a name="l00235"></a>00235 <span class="comment"> * thread is resumed with status @p Q_RESET.</span>
|
||
|
|
<a name="l00236"></a>00236 <span class="comment"> * @note A reset operation can be used by a low level driver in order to</span>
|
||
|
|
<a name="l00237"></a>00237 <span class="comment"> * obtain immediate attention from the high level layers.</span>
|
||
|
|
<a name="l00238"></a>00238 <span class="comment"> *</span>
|
||
|
|
<a name="l00239"></a>00239 <span class="comment"> * @param[in] oqp pointer to an @p OutputQueue structure</span>
|
||
|
|
<a name="l00240"></a>00240 <span class="comment"> */</span>
|
||
|
|
<a name="l00241"></a><a class="code" href="group__io__queues.html#ga0a35a7de945e4b56b5fb5f5c8567e296">00241</a> <span class="keywordtype">void</span> <a class="code" href="group__io__queues.html#ga0a35a7de945e4b56b5fb5f5c8567e296" title="Resets an output queue.">chOQResetI</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">OutputQueue</a> *oqp) {
|
||
|
|
<a name="l00242"></a>00242
|
||
|
|
<a name="l00243"></a>00243 oqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = oqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00244"></a>00244 <a class="code" href="group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title="Performs a reset operation on the semaphore.">chSemResetI</a>(&oqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, (<a class="code" href="group__types.html#ga090b3bab5602157ebf706a44041dc05e" title="Counter, recommended fastest signed.">cnt_t</a>)(oqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a> - oqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>));
|
||
|
|
<a name="l00245"></a>00245 }
|
||
|
|
<a name="l00246"></a>00246 <span class="comment"></span>
|
||
|
|
<a name="l00247"></a>00247 <span class="comment">/**</span>
|
||
|
|
<a name="l00248"></a>00248 <span class="comment"> * @brief Output queue write with timeout.</span>
|
||
|
|
<a name="l00249"></a>00249 <span class="comment"> * @details This function writes a byte value to an output queue. If the queue</span>
|
||
|
|
<a name="l00250"></a>00250 <span class="comment"> * is full then the calling thread is suspended until there is space</span>
|
||
|
|
<a name="l00251"></a>00251 <span class="comment"> * in the queue or a timeout occurs.</span>
|
||
|
|
<a name="l00252"></a>00252 <span class="comment"> *</span>
|
||
|
|
<a name="l00253"></a>00253 <span class="comment"> * @param[in] oqp pointer to an @p OutputQueue structure</span>
|
||
|
|
<a name="l00254"></a>00254 <span class="comment"> * @param[in] b the byte value to be written in the queue</span>
|
||
|
|
<a name="l00255"></a>00255 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
||
|
|
<a name="l00256"></a>00256 <span class="comment"> * the following special values are allowed:</span>
|
||
|
|
<a name="l00257"></a>00257 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
||
|
|
<a name="l00258"></a>00258 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
||
|
|
<a name="l00259"></a>00259 <span class="comment"> * .</span>
|
||
|
|
<a name="l00260"></a>00260 <span class="comment"> * @return The operation status:</span>
|
||
|
|
<a name="l00261"></a>00261 <span class="comment"> * @retval Q_OK if the operation succeeded.</span>
|
||
|
|
<a name="l00262"></a>00262 <span class="comment"> * @retval Q_TIMEOUT if the specified time expired.</span>
|
||
|
|
<a name="l00263"></a>00263 <span class="comment"> * @retval Q_RESET if the queue was reset.</span>
|
||
|
|
<a name="l00264"></a>00264 <span class="comment"> */</span>
|
||
|
|
<a name="l00265"></a><a class="code" href="group__io__queues.html#ga3df1926602eb698119990b311b097ad9">00265</a> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__io__queues.html#ga3df1926602eb698119990b311b097ad9" title="Output queue write with timeout.">chOQPutTimeout</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">OutputQueue</a> *oqp, <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> time) {
|
||
|
|
<a name="l00266"></a>00266 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg;
|
||
|
|
<a name="l00267"></a>00267
|
||
|
|
<a name="l00268"></a>00268 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00269"></a>00269 <span class="keywordflow">if</span> ((msg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&oqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, time)) < <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
|
||
|
|
<a name="l00270"></a>00270 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00271"></a>00271 <span class="keywordflow">return</span> msg;
|
||
|
|
<a name="l00272"></a>00272 }
|
||
|
|
<a name="l00273"></a>00273 *oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a>++ = b;
|
||
|
|
<a name="l00274"></a>00274 <span class="keywordflow">if</span> (oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> >= oqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a>)
|
||
|
|
<a name="l00275"></a>00275 oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = oqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00276"></a>00276
|
||
|
|
<a name="l00277"></a>00277 <span class="keywordflow">if</span> (oqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a>)
|
||
|
|
<a name="l00278"></a>00278 oqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a>();
|
||
|
|
<a name="l00279"></a>00279
|
||
|
|
<a name="l00280"></a>00280 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00281"></a>00281 <span class="keywordflow">return</span> <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="l00282"></a>00282 }
|
||
|
|
<a name="l00283"></a>00283 <span class="comment"></span>
|
||
|
|
<a name="l00284"></a>00284 <span class="comment">/**</span>
|
||
|
|
<a name="l00285"></a>00285 <span class="comment"> * @brief Output queue read.</span>
|
||
|
|
<a name="l00286"></a>00286 <span class="comment"> * @details A byte value is read from the low end of an output queue.</span>
|
||
|
|
<a name="l00287"></a>00287 <span class="comment"> *</span>
|
||
|
|
<a name="l00288"></a>00288 <span class="comment"> * @param[in] oqp pointer to an @p OutputQueue structure</span>
|
||
|
|
<a name="l00289"></a>00289 <span class="comment"> * @return The byte value from the queue or:</span>
|
||
|
|
<a name="l00290"></a>00290 <span class="comment"> * @retval Q_EMPTY if the queue is empty.</span>
|
||
|
|
<a name="l00291"></a>00291 <span class="comment"> */</span>
|
||
|
|
<a name="l00292"></a><a class="code" href="group__io__queues.html#ga34a5a71f39e94fcfdd88935da92a8ce9">00292</a> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__io__queues.html#ga34a5a71f39e94fcfdd88935da92a8ce9" title="Output queue read.">chOQGetI</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">OutputQueue</a> *oqp) {
|
||
|
|
<a name="l00293"></a>00293 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> b;
|
||
|
|
<a name="l00294"></a>00294
|
||
|
|
<a name="l00295"></a>00295 <span class="keywordflow">if</span> (<a class="code" href="group__io__queues.html#gabf0eb1ba20cde6d4d9afa1139eaac19d" title="Evaluates to TRUE if the specified Output Queue is empty.">chOQIsEmpty</a>(oqp))
|
||
|
|
<a name="l00296"></a>00296 <span class="keywordflow">return</span> <a class="code" href="group__io__queues.html#ga9d3fcfacb433cb513882db4515ac348b" title="Returned by the queue functions if the queue is empty.">Q_EMPTY</a>;
|
||
|
|
<a name="l00297"></a>00297
|
||
|
|
<a name="l00298"></a>00298 b = *oqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a>++;
|
||
|
|
<a name="l00299"></a>00299 <span class="keywordflow">if</span> (oqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> >= oqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a>)
|
||
|
|
<a name="l00300"></a>00300 oqp-><a class="code" href="struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" title="Read pointer.">q_rdptr</a> = oqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00301"></a>00301 <a class="code" href="group__semaphores.html#gaca0b70cf495a9cb7569e1cf5b07e2b3d" title="Performs a signal operation on a semaphore.">chSemSignalI</a>(&oqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>);
|
||
|
|
<a name="l00302"></a>00302 <span class="keywordflow">return</span> b;
|
||
|
|
<a name="l00303"></a>00303 }
|
||
|
|
<a name="l00304"></a>00304 <span class="comment"></span>
|
||
|
|
<a name="l00305"></a>00305 <span class="comment">/**</span>
|
||
|
|
<a name="l00306"></a>00306 <span class="comment"> * @brief Output queue write with timeout.</span>
|
||
|
|
<a name="l00307"></a>00307 <span class="comment"> * @details The function writes data from a buffer to an output queue. The</span>
|
||
|
|
<a name="l00308"></a>00308 <span class="comment"> * operation completes when the specified amount of data has been</span>
|
||
|
|
<a name="l00309"></a>00309 <span class="comment"> * transferred or after the specified timeout or if the queue has</span>
|
||
|
|
<a name="l00310"></a>00310 <span class="comment"> * been reset.</span>
|
||
|
|
<a name="l00311"></a>00311 <span class="comment"> * @note The function is not atomic, if you need atomicity it is suggested</span>
|
||
|
|
<a name="l00312"></a>00312 <span class="comment"> * to use a semaphore or a mutex for mutual exclusion.</span>
|
||
|
|
<a name="l00313"></a>00313 <span class="comment"> * @note The queue callback is invoked before entering a sleep state and at</span>
|
||
|
|
<a name="l00314"></a>00314 <span class="comment"> * the end of the transfer.</span>
|
||
|
|
<a name="l00315"></a>00315 <span class="comment"> *</span>
|
||
|
|
<a name="l00316"></a>00316 <span class="comment"> * @param[in] oqp pointer to an @p OutputQueue structure</span>
|
||
|
|
<a name="l00317"></a>00317 <span class="comment"> * @param[out] bp pointer to the data buffer</span>
|
||
|
|
<a name="l00318"></a>00318 <span class="comment"> * @param[in] n the maximum amount of data to be transferred, the</span>
|
||
|
|
<a name="l00319"></a>00319 <span class="comment"> * value 0 is reserved</span>
|
||
|
|
<a name="l00320"></a>00320 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
||
|
|
<a name="l00321"></a>00321 <span class="comment"> * the following special values are allowed:</span>
|
||
|
|
<a name="l00322"></a>00322 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
|
||
|
|
<a name="l00323"></a>00323 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
|
||
|
|
<a name="l00324"></a>00324 <span class="comment"> * .</span>
|
||
|
|
<a name="l00325"></a>00325 <span class="comment"> * @return The number of bytes effectively transferred.</span>
|
||
|
|
<a name="l00326"></a>00326 <span class="comment"> */</span>
|
||
|
|
<a name="l00327"></a><a class="code" href="group__io__queues.html#ga1e90d41fa021107d72b1bed81186aae8">00327</a> <span class="keywordtype">size_t</span> <a class="code" href="group__io__queues.html#ga1e90d41fa021107d72b1bed81186aae8" title="Output queue write with timeout.">chOQWriteTimeout</a>(<a class="code" href="struct_generic_queue.html" title="Generic I/O queue structure.">OutputQueue</a> *oqp, <span class="keyword">const</span> <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *bp,
|
||
|
|
<a name="l00328"></a>00328 <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="l00329"></a>00329 <a class="code" href="group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title="Queue notification callback type.">qnotify_t</a> nfy = oqp-><a class="code" href="struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" title="Data notification callback.">q_notify</a>;
|
||
|
|
<a name="l00330"></a>00330 <span class="keywordtype">size_t</span> w = 0;
|
||
|
|
<a name="l00331"></a>00331
|
||
|
|
<a name="l00332"></a>00332 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(n > 0, <span class="stringliteral">"chOQWriteTimeout"</span>);
|
||
|
|
<a name="l00333"></a>00333
|
||
|
|
<a name="l00334"></a>00334 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00335"></a>00335 <span class="keywordflow">while</span> (TRUE) {
|
||
|
|
<a name="l00336"></a>00336 <span class="keywordflow">if</span> (<a class="code" href="group__io__queues.html#gaca8b2bc8aae722ba9f47f21c358420f9" title="Evaluates to TRUE if the specified Output Queue is full.">chOQIsFull</a>(oqp)) {
|
||
|
|
<a name="l00337"></a>00337 <span class="keywordflow">if</span> (nfy)
|
||
|
|
<a name="l00338"></a>00338 nfy();
|
||
|
|
<a name="l00339"></a>00339 <span class="keywordflow">if</span> ((<a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&oqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>, time) != <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>)) {
|
||
|
|
<a name="l00340"></a>00340 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00341"></a>00341 <span class="keywordflow">return</span> w;
|
||
|
|
<a name="l00342"></a>00342 }
|
||
|
|
<a name="l00343"></a>00343 }
|
||
|
|
<a name="l00344"></a>00344 <span class="keywordflow">else</span>
|
||
|
|
<a name="l00345"></a>00345 <a class="code" href="group__semaphores.html#ga748b56bc2be187e316496d7b6e748f89" title="Decreases the semaphore counter.">chSemFastWaitI</a>(&oqp-><a class="code" href="struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" title="Counter Semaphore.">q_sem</a>);
|
||
|
|
<a name="l00346"></a>00346 *oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a>++ = *bp++;
|
||
|
|
<a name="l00347"></a>00347 <span class="keywordflow">if</span> (oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> >= oqp-><a class="code" href="struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" title="Pointer to the first location after the buffer.">q_top</a>)
|
||
|
|
<a name="l00348"></a>00348 oqp-><a class="code" href="struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" title="Write pointer.">q_wrptr</a> = oqp-><a class="code" href="struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" title="Pointer to the queue buffer.">q_buffer</a>;
|
||
|
|
<a name="l00349"></a>00349 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>(); <span class="comment">/* Gives a preemption chance in a controlled point.*/</span>
|
||
|
|
<a name="l00350"></a>00350 w++;
|
||
|
|
<a name="l00351"></a>00351 <span class="keywordflow">if</span> (--n == 0) {
|
||
|
|
<a name="l00352"></a>00352 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00353"></a>00353 <span class="keywordflow">if</span> (nfy)
|
||
|
|
<a name="l00354"></a>00354 nfy();
|
||
|
|
<a name="l00355"></a>00355 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
||
|
|
<a name="l00356"></a>00356 <span class="keywordflow">return</span> w;
|
||
|
|
<a name="l00357"></a>00357 }
|
||
|
|
<a name="l00358"></a>00358 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
||
|
|
<a name="l00359"></a>00359 }
|
||
|
|
<a name="l00360"></a>00360 }
|
||
|
|
<a name="l00361"></a>00361 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_QUEUES */</span>
|
||
|
|
<a name="l00362"></a>00362 <span class="comment"></span>
|
||
|
|
<a name="l00363"></a>00363 <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>
|