2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: chqueues.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" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main 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 >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "headertitle" >
< h1 > chqueues.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "chqueues_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 >
2010-08-10 03:11:02 +00:00
< a name = "l00002" > < / a > 00002 < span class = "comment" > ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.< / span >
< a name = "l00003" > < / a > 00003 < span class = "comment" > < / span >
< a name = "l00004" > < / a > 00004 < span class = "comment" > This file is part of ChibiOS/RT.< / span >
< a name = "l00005" > < / a > 00005 < span class = "comment" > < / span >
< a name = "l00006" > < / a > 00006 < span class = "comment" > ChibiOS/RT is free software; you can redistribute it and/or modify< / span >
< a name = "l00007" > < / a > 00007 < span class = "comment" > it under the terms of the GNU General Public License as published by< / span >
< a name = "l00008" > < / a > 00008 < span class = "comment" > the Free Software Foundation; either version 3 of the License, or< / span >
< a name = "l00009" > < / a > 00009 < span class = "comment" > (at your option) any later version.< / span >
< a name = "l00010" > < / a > 00010 < span class = "comment" > < / span >
< a name = "l00011" > < / a > 00011 < span class = "comment" > ChibiOS/RT is distributed in the hope that it will be useful,< / span >
< a name = "l00012" > < / a > 00012 < span class = "comment" > but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< a name = "l00013" > < / a > 00013 < span class = "comment" > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< a name = "l00014" > < / a > 00014 < span class = "comment" > GNU General Public License for more details.< / span >
< a name = "l00015" > < / a > 00015 < span class = "comment" > < / span >
< a name = "l00016" > < / a > 00016 < span class = "comment" > You should have received a copy of the GNU General Public License< / span >
< a name = "l00017" > < / a > 00017 < span class = "comment" > along with this program. If not, see < 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.h I/O< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief Queues macros and structures.< / 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" > * @{< / span >
< a name = "l00033" > < / a > 00033 < span class = "comment" > */< / span >
< a name = "l00034" > < / a > 00034
< a name = "l00035" > < / a > 00035 < span class = "preprocessor" > #ifndef _CHQUEUES_H_< / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _CHQUEUES_H_< / span >
< a name = "l00037" > < / a > 00037 < span class = "preprocessor" > < / span >
< a name = "l00038" > < / a > 00038 < span class = "preprocessor" > #if CH_USE_QUEUES< / 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" > * Module dependencies check.< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > */< / span >
< a name = "l00043" > < / a > 00043 < span class = "preprocessor" > #if !CH_USE_SEMAPHORES< / span >
< a name = "l00044" > < / a > 00044 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #error " CH_USE_QUEUES requires CH_USE_SEMAPHORES" < / span >
< a name = "l00045" > < / a > 00045 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00046" > < / a > 00046 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00047" > < / a > 00047 < span class = "comment" > /** @brief Queue notification callback type.*/< / span >
< a name = "l00048" > < / a > < a class = "code" href = "group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" > 00048< / a > < span class = "keyword" > typedef< / span > void (*< a class = "code" href = "group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title = "Queue notification callback type." > qnotify_t< / a > )(void);
< a name = "l00049" > < / a > 00049 < span class = "comment" > < / span >
< a name = "l00050" > < / a > 00050 < span class = "comment" > /** @brief Returned by the queue functions if the operation is successful.*/< / span >
< a name = "l00051" > < / a > < a class = "code" href = "group__io__queues.html#gadfbe2a9b3e7477d3fd4026d61caf1fcd" > 00051< / a > < span class = "preprocessor" > #define Q_OK RDY_OK< / span >
< a name = "l00052" > < / a > 00052 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Returned by the queue functions if a timeout occurs.*/< / span >
< a name = "l00053" > < / a > < a class = "code" href = "group__io__queues.html#gaed5efaf47ab37022f69e8080610bcb8b" > 00053< / a > < span class = "preprocessor" > #define Q_TIMEOUT RDY_TIMEOUT< / span >
< a name = "l00054" > < / a > 00054 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Returned by the queue functions if the queue is reset.*/< / span >
< a name = "l00055" > < / a > < a class = "code" href = "group__io__queues.html#gaef6ed06ced720075658356892318f92d" > 00055< / a > < span class = "preprocessor" > #define Q_RESET RDY_RESET< / span >
< a name = "l00056" > < / a > 00056 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Returned by the queue functions if the queue is empty.*/< / span >
< a name = "l00057" > < / a > < a class = "code" href = "group__io__queues.html#ga9d3fcfacb433cb513882db4515ac348b" > 00057< / a > < span class = "preprocessor" > #define Q_EMPTY -3< / span >
< a name = "l00058" > < / a > 00058 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Returned by the queue functions if the queue is full.*/< / span >
< a name = "l00059" > < / a > < a class = "code" href = "group__io__queues.html#ga6c462ef0a5b01afbd0d94a8e1ac8575a" > 00059< / a > < span class = "preprocessor" > #define Q_FULL -4< / span >
< a name = "l00060" > < / a > 00060 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00061" > < / a > 00061 < span class = "comment" > /**< / span >
< a name = "l00062" > < / a > 00062 < span class = "comment" > * @brief Generic I/O queue structure.< / span >
< a name = "l00063" > < / a > 00063 < span class = "comment" > * @details This structure represents a generic Input or Output asymmetrical< / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > * queue. The queue is asymmetrical because one end is meant to be< / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > * accessed from a thread context, and thus can be blocking, the other< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > * end is accessible from interrupt handlers or from within a kernel< / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > * lock zone (see < b> I-Locked< /b> and < b> S-Locked< /b> states in< / span >
< a name = "l00068" > < / a > 00068 < span class = "comment" > * @ref system_states) and is non-blocking.< / span >
< a name = "l00069" > < / a > 00069 < span class = "comment" > */< / span >
< a name = "l00070" > < / a > < a class = "code" href = "struct_generic_queue.html" > 00070< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {
< a name = "l00071" > < / a > < a class = "code" href = "struct_generic_queue.html#a644ac8a420048012cf562a31e8c144c6" > 00071< / a > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > *q_buffer; < span class = "comment" > /**< @brief Pointer to the queue buffer.*/< / span >
< a name = "l00072" > < / a > < a class = "code" href = "struct_generic_queue.html#a2345976305f32ce54981ad1ee36e77be" > 00072< / a > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > *q_top; < span class = "comment" > /**< @brief Pointer to the first location< / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > after the buffer. */< / span >
< a name = "l00074" > < / a > < a class = "code" href = "struct_generic_queue.html#a5cf5a39a1a57b15d1a2491edcbd72442" > 00074< / a > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > *q_wrptr; < span class = "comment" > /**< @brief Write pointer. */< / span >
< a name = "l00075" > < / a > < a class = "code" href = "struct_generic_queue.html#acc1453d7bc5a4ceddba2166b72ba3b47" > 00075< / a > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > *q_rdptr; < span class = "comment" > /**< @brief Read pointer. */< / span >
< a name = "l00076" > < / a > < a class = "code" href = "struct_generic_queue.html#a21fa1b28fa19bbb1b036c396b44d9fd5" > 00076< / a > < a class = "code" href = "struct_semaphore.html" title = "Semaphore structure." > Semaphore< / a > q_sem; < span class = "comment" > /**< @brief Counter @p Semaphore. */< / span >
< a name = "l00077" > < / a > < a class = "code" href = "struct_generic_queue.html#ab8c8dc77de2c387f8a980a9c179388e1" > 00077< / a > < a class = "code" href = "group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title = "Queue notification callback type." > qnotify_t< / a > q_notify; < span class = "comment" > /**< @brief Data notification callback. */< / span >
< a name = "l00078" > < / a > 00078 } < a class = "code" href = "struct_generic_queue.html" title = "Generic I/O queue structure." > GenericQueue< / a > ;
< a name = "l00079" > < / a > 00079 < span class = "comment" > < / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > /**< / span >
< a name = "l00081" > < / a > 00081 < span class = "comment" > * @brief Returns the queue' s buffer size.< / span >
< a name = "l00082" > < / a > 00082 < span class = "comment" > */< / span >
< a name = "l00083" > < / a > < a class = "code" href = "group__io__queues.html#ga1d70b6f0faef169fd343806e4fd26f55" > 00083< / a > < span class = "preprocessor" > #define chQSize(q) ((q)-> q_top - (q)-> q_buffer)< / span >
< a name = "l00084" > < / a > 00084 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > /**< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > * @brief Queue space.< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > * @details Returns the used space if used on an Input Queue and the empty< / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > * space if used on an Output Queue.< / span >
< a name = "l00089" > < / a > 00089 < span class = "comment" > * @note The returned value can be less than zero when there are waiting< / span >
< a name = "l00090" > < / a > 00090 < span class = "comment" > * threads on the internal semaphore.< / span >
< a name = "l00091" > < / a > 00091 < span class = "comment" > */< / span >
< a name = "l00092" > < / a > < a class = "code" href = "group__io__queues.html#ga36b3ceeb9c971245fb5cd5bfdce29804" > 00092< / a > < span class = "preprocessor" > #define chQSpace(q) chSemGetCounterI(& (q)-> q_sem)< / span >
< a name = "l00093" > < / a > 00093 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > /**< / span >
< a name = "l00095" > < / a > 00095 < span class = "comment" > * @extends GenericQueue< / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > *< / span >
< a name = "l00097" > < / a > 00097 < span class = "comment" > * @brief Input queue structure.< / span >
< a name = "l00098" > < / a > 00098 < span class = "comment" > * @details This structure represents a generic asymmetrical input queue.< / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > * Writing in the queue is non-blocking and can be performed from< / span >
< a name = "l00100" > < / a > 00100 < span class = "comment" > * interrupt handlers or from within a kernel lock zone (see< / span >
< a name = "l00101" > < / a > 00101 < span class = "comment" > * < b> I-Locked< /b> and < b> S-Locked< /b> states in @ref system_states).< / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > * Reading the queue can be a blocking operation and is supposed to< / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > * be performed by a system thread.< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > */< / span >
< a name = "l00105" > < / a > < a class = "code" href = "group__io__queues.html#gab15bb5ea346b37cd021c6a658e86084b" > 00105< / a > < span class = "keyword" > typedef< / span > < a class = "code" href = "struct_generic_queue.html" title = "Generic I/O queue structure." > GenericQueue< / a > < a class = "code" href = "struct_generic_queue.html" title = "Generic I/O queue structure." > InputQueue< / a > ;
< a name = "l00106" > < / a > 00106 < span class = "comment" > < / span >
< a name = "l00107" > < / a > 00107 < span class = "comment" > /** @brief Evaluates to @p TRUE if the specified Input Queue is empty.*/< / span >
< a name = "l00108" > < / a > < a class = "code" href = "group__io__queues.html#ga01d87285eb173d213eb9849514969d7d" > 00108< / a > < span class = "preprocessor" > #define chIQIsEmpty(q) ((bool_t)(chQSpace(q) < = 0))< / span >
< a name = "l00109" > < / a > 00109 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00110" > < / a > 00110 < span class = "comment" > /** @brief Evaluates to @p TRUE if the specified Input Queue is full.*/< / span >
< a name = "l00111" > < / a > < a class = "code" href = "group__io__queues.html#ga3b87d6f7e4110c882b13870930db5cbb" > 00111< / a > < span class = "preprocessor" > #define chIQIsFull(q) ((bool_t)(chQSpace(q) > = chQSize(q)))< / span >
< a name = "l00112" > < / a > 00112 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00113" > < / a > 00113 < span class = "comment" > /**< / span >
< a name = "l00114" > < / a > 00114 < span class = "comment" > * @brief Input queue read.< / span >
< a name = "l00115" > < / a > 00115 < span class = "comment" > * @details This function reads a byte value from an input queue. If the queue< / span >
< a name = "l00116" > < / a > 00116 < span class = "comment" > * is empty then the calling thread is suspended until a byte arrives< / span >
< a name = "l00117" > < / a > 00117 < span class = "comment" > * in the queue.< / span >
< a name = "l00118" > < / a > 00118 < span class = "comment" > *< / span >
< a name = "l00119" > < / a > 00119 < span class = "comment" > * @param[in] iqp pointer to an @p InputQueue structure< / span >
< a name = "l00120" > < / a > 00120 < span class = "comment" > * @return A byte value from the queue or:< / span >
< a name = "l00121" > < / a > 00121 < span class = "comment" > * @retval Q_RESET if the queue was reset.< / span >
< a name = "l00122" > < / a > 00122 < span class = "comment" > */< / span >
< a name = "l00123" > < / a > < a class = "code" href = "group__io__queues.html#ga677247f42b796cedc0c0b58a15c11794" > 00123< / a > < span class = "preprocessor" > #define chIQGet(iqp) chIQGetTimeout(iqp, TIME_INFINITE)< / span >
< a name = "l00124" > < / a > 00124 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00125" > < / a > 00125 < span class = "comment" > /**< / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > * @brief Data part of a static input queue initializer.< / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > * @details This macro should be used when statically initializing an< / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > * input queue that is part of a bigger structure.< / span >
< a name = "l00129" > < / a > 00129 < span class = "comment" > *< / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > * @param[in] name the name of the input queue variable< / span >
< a name = "l00131" > < / a > 00131 < span class = "comment" > * @param[in] buffer pointer to the queue buffer area< / span >
< a name = "l00132" > < / a > 00132 < span class = "comment" > * @param[in] size size of the queue buffer area< / span >
< a name = "l00133" > < / a > 00133 < span class = "comment" > * @param[in] inotify input notification callback pointer< / span >
< a name = "l00134" > < / a > 00134 < span class = "comment" > */< / span >
< a name = "l00135" > < / a > < a class = "code" href = "group__io__queues.html#ga4103f441ac5c12c89180194b7a3044f2" > 00135< / a > < span class = "preprocessor" > #define _INPUTQUEUE_DATA(name, buffer, size, inotify) { \< / span >
< a name = "l00136" > < / a > 00136 < span class = "preprocessor" > (uint8_t *)(buffer), \< / span >
< a name = "l00137" > < / a > 00137 < span class = "preprocessor" > (uint8_t *)(buffer) + size, \< / span >
< a name = "l00138" > < / a > 00138 < span class = "preprocessor" > (uint8_t *)(buffer), \< / span >
< a name = "l00139" > < / a > 00139 < span class = "preprocessor" > (uint8_t *)(buffer), \< / span >
< a name = "l00140" > < / a > 00140 < span class = "preprocessor" > _SEMAPHORE_DATA(name.q_sem, 0), \< / span >
< a name = "l00141" > < / a > 00141 < span class = "preprocessor" > inotify \< / span >
< a name = "l00142" > < / a > 00142 < span class = "preprocessor" > }< / span >
< a name = "l00143" > < / a > 00143 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00144" > < / a > 00144 < span class = "comment" > /**< / span >
< a name = "l00145" > < / a > 00145 < span class = "comment" > * @brief Static input queue initializer.< / span >
< a name = "l00146" > < / a > 00146 < span class = "comment" > * @details Statically initialized input queues require no explicit< / span >
< a name = "l00147" > < / a > 00147 < span class = "comment" > * initialization using @p chIQInit().< / span >
< a name = "l00148" > < / a > 00148 < span class = "comment" > *< / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > * @param[in] name the name of the input queue variable< / span >
< a name = "l00150" > < / a > 00150 < span class = "comment" > * @param[in] buffer pointer to the queue buffer area< / span >
< a name = "l00151" > < / a > 00151 < span class = "comment" > * @param[in] size size of the queue buffer area< / span >
< a name = "l00152" > < / a > 00152 < span class = "comment" > * @param[in] inotify input notification callback pointer< / span >
< a name = "l00153" > < / a > 00153 < span class = "comment" > */< / span >
< a name = "l00154" > < / a > < a class = "code" href = "group__io__queues.html#ga49e3c172ebb6efca6579bf97ca82569d" > 00154< / a > < span class = "preprocessor" > #define INPUTQUEUE_DECL(name, buffer, size, inotify) \< / span >
< a name = "l00155" > < / a > 00155 < span class = "preprocessor" > InputQueue name = _INPUTQUEUE_DATA(name, buffer, size, inotify)< / span >
< a name = "l00156" > < / a > 00156 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00157" > < / a > 00157 < span class = "comment" > /**< / span >
< a name = "l00158" > < / a > 00158 < span class = "comment" > * @extends GenericQueue< / span >
< a name = "l00159" > < / a > 00159 < span class = "comment" > *< / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > * @brief Output queue structure.< / span >
< a name = "l00161" > < / a > 00161 < span class = "comment" > * @details This structure represents a generic asymmetrical output queue.< / span >
< a name = "l00162" > < / a > 00162 < span class = "comment" > * Reading from the queue is non-blocking and can be performed from< / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > * interrupt handlers or from within a kernel lock zone (see< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > * < b> I-Locked< /b> and < b> S-Locked< /b> states in @ref system_states).< / span >
< a name = "l00165" > < / a > 00165 < span class = "comment" > * Writing the queue can be a blocking operation and is supposed to< / span >
< a name = "l00166" > < / a > 00166 < span class = "comment" > * be performed by a system thread.< / span >
< a name = "l00167" > < / a > 00167 < span class = "comment" > */< / span >
< a name = "l00168" > < / a > < a class = "code" href = "group__io__queues.html#gac7723f9b71300f4231db2b6e502f23c9" > 00168< / a > < span class = "keyword" > typedef< / span > < a class = "code" href = "struct_generic_queue.html" title = "Generic I/O queue structure." > GenericQueue< / a > < a class = "code" href = "struct_generic_queue.html" title = "Generic I/O queue structure." > OutputQueue< / a > ;
< a name = "l00169" > < / a > 00169 < span class = "comment" > < / span >
< a name = "l00170" > < / a > 00170 < span class = "comment" > /**< / span >
< a name = "l00171" > < / a > 00171 < span class = "comment" > * @brief Evaluates to @p TRUE if the specified Output Queue is empty.< / span >
< a name = "l00172" > < / a > 00172 < span class = "comment" > */< / span >
< a name = "l00173" > < / a > < a class = "code" href = "group__io__queues.html#gabf0eb1ba20cde6d4d9afa1139eaac19d" > 00173< / a > < span class = "preprocessor" > #define chOQIsEmpty(q) ((bool_t)(chQSpace(q) > = chQSize(q)))< / span >
< a name = "l00174" > < / a > 00174 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00175" > < / a > 00175 < span class = "comment" > /**< / span >
< a name = "l00176" > < / a > 00176 < span class = "comment" > * @brief Evaluates to @p TRUE if the specified Output Queue is full.< / span >
< a name = "l00177" > < / a > 00177 < span class = "comment" > */< / span >
< a name = "l00178" > < / a > < a class = "code" href = "group__io__queues.html#gaca8b2bc8aae722ba9f47f21c358420f9" > 00178< / a > < span class = "preprocessor" > #define chOQIsFull(q) ((bool_t)(chQSpace(q) < = 0))< / span >
< a name = "l00179" > < / a > 00179 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00180" > < / a > 00180 < span class = "comment" > /**< / span >
< a name = "l00181" > < / a > 00181 < span class = "comment" > * @brief Output queue write.< / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > * @details This function writes a byte value to an output queue. If the queue< / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > * is full then the calling thread is suspended until there is space< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > * in the queue.< / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > *< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > * @param[in] oqp pointer to an @p OutputQueue structure< / span >
< a name = "l00187" > < / a > 00187 < span class = "comment" > * @param[in] b the byte value to be written in the queue< / span >
< a name = "l00188" > < / a > 00188 < span class = "comment" > * @return The operation status:< / span >
< a name = "l00189" > < / a > 00189 < span class = "comment" > * @retval Q_OK if the operation succeeded.< / span >
< a name = "l00190" > < / a > 00190 < span class = "comment" > * @retval Q_RESET if the queue was reset.< / span >
< a name = "l00191" > < / a > 00191 < span class = "comment" > */< / span >
< a name = "l00192" > < / a > < a class = "code" href = "group__io__queues.html#ga825aba08aea4a6ac97a763404265956b" > 00192< / a > < span class = "preprocessor" > #define chOQPut(oqp, b) chOQPutTimeout(oqp, b, TIME_INFINITE)< / span >
< a name = "l00193" > < / a > 00193 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00194" > < / a > 00194 < span class = "comment" > /**< / span >
< a name = "l00195" > < / a > 00195 < span class = "comment" > * @brief Data part of a static output queue initializer.< / span >
< a name = "l00196" > < / a > 00196 < span class = "comment" > * @details This macro should be used when statically initializing an< / span >
< a name = "l00197" > < / a > 00197 < span class = "comment" > * output queue that is part of a bigger structure.< / span >
< a name = "l00198" > < / a > 00198 < span class = "comment" > *< / span >
< a name = "l00199" > < / a > 00199 < span class = "comment" > * @param[in] name the name of the output queue variable.< / span >
< a name = "l00200" > < / a > 00200 < span class = "comment" > * @param[in] buffer pointer to the queue buffer area< / span >
< a name = "l00201" > < / a > 00201 < span class = "comment" > * @param[in] size size of the queue buffer area< / span >
< a name = "l00202" > < / a > 00202 < span class = "comment" > * @param[in] onotify output notification callback pointer< / span >
< a name = "l00203" > < / a > 00203 < span class = "comment" > */< / span >
< a name = "l00204" > < / a > < a class = "code" href = "group__io__queues.html#gafc29412cc872c152eadcb24183010a52" > 00204< / a > < span class = "preprocessor" > #define _OUTPUTQUEUE_DATA(name, buffer, size, onotify) { \< / span >
< a name = "l00205" > < / a > 00205 < span class = "preprocessor" > (uint8_t *)(buffer), \< / span >
< a name = "l00206" > < / a > 00206 < span class = "preprocessor" > (uint8_t *)(buffer) + size, \< / span >
< a name = "l00207" > < / a > 00207 < span class = "preprocessor" > (uint8_t *)(buffer), \< / span >
< a name = "l00208" > < / a > 00208 < span class = "preprocessor" > (uint8_t *)(buffer), \< / span >
< a name = "l00209" > < / a > 00209 < span class = "preprocessor" > _SEMAPHORE_DATA(name.q_sem, size), \< / span >
< a name = "l00210" > < / a > 00210 < span class = "preprocessor" > onotify \< / span >
< a name = "l00211" > < / a > 00211 < span class = "preprocessor" > }< / span >
< a name = "l00212" > < / a > 00212 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00213" > < / a > 00213 < span class = "comment" > /**< / span >
< a name = "l00214" > < / a > 00214 < span class = "comment" > * @brief Static output queue initializer.< / span >
< a name = "l00215" > < / a > 00215 < span class = "comment" > * @details Statically initialized output queues require no explicit< / span >
< a name = "l00216" > < / a > 00216 < span class = "comment" > * initialization using @p chOQInit().< / span >
< a name = "l00217" > < / a > 00217 < span class = "comment" > *< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * @param[in] name the name of the output queue variable< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > * @param[in] buffer pointer to the queue buffer area< / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > * @param[in] size size of the queue buffer area< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > * @param[in] onotify output notification callback pointer< / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > */< / span >
< a name = "l00223" > < / a > < a class = "code" href = "group__io__queues.html#ga9381af63d682d4e0883bc9336a2366eb" > 00223< / a > < span class = "preprocessor" > #define OUTPUTQUEUE_DECL(name, buffer, size, onotify) \< / span >
< a name = "l00224" > < / a > 00224 < span class = "preprocessor" > InputQueue name = _OUTPUTQUEUE_DATA(name, buffer, size, onotify)< / span >
< a name = "l00225" > < / a > 00225 < span class = "preprocessor" > < / span >
< a name = "l00226" > < / a > 00226 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00227" > < / a > 00227 < span class = "preprocessor" > < / span > < span class = "keyword" > extern< / span > < span class = "stringliteral" > " C" < / span > {
< a name = "l00228" > < / a > 00228 < span class = "preprocessor" > #endif< / span >
< a name = "l00229" > < / a > 00229 < span class = "preprocessor" > < / span > < 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 > *qp, < 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 = "l00230" > < / a > 00230 < 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 > *qp);
< a name = "l00231" > < / a > 00231 < 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 > *qp, < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > b);
< a name = "l00232" > < / a > 00232 < 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 > *qp, < a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00233" > < / a > 00233 < 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 > *qp, < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > *bp,
< a name = "l00234" > < / a > 00234 < 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 = "l00235" > < / a > 00235
< a name = "l00236" > < / a > 00236 < 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 > *queue, < 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 = "l00237" > < / a > 00237 < 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 > *queue);
< a name = "l00238" > < / a > 00238 < 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 > *queue, < 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 = "l00239" > < / a > 00239 < 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 > *queue);
< a name = "l00240" > < / a > 00240 < 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 > *queue, < 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 = "l00241" > < / a > 00241 < 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 = "l00242" > < / a > 00242 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00243" > < / a > 00243 < span class = "preprocessor" > < / span > }
< a name = "l00244" > < / a > 00244 < span class = "preprocessor" > #endif< / span >
< a name = "l00245" > < / a > 00245 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_QUEUES */< / span >
< a name = "l00246" > < / a > 00246
< a name = "l00247" > < / a > 00247 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _CHQUEUES_H_ */< / span >
< a name = "l00248" > < / a > 00248 < span class = "comment" > < / span >
< a name = "l00249" > < / a > 00249 < span class = "comment" > /** @} */< / span >
< / pre > < / div > < / div >
2010-11-22 05:53:37 +00:00
< / div >
2010-08-10 03:11:02 +00:00
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:48 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 >
2010-08-10 03:11:02 +00:00
< / body >
< / html >