From 1914bcbbf422a9616dd2c1d6906a8ced3548921d Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Wed, 16 Mar 2016 11:09:29 +0000 Subject: Removed I/O queues and streams from RT. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@9125 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/rt/include/ch.h | 2 - os/rt/include/chqueues.h | 437 --------------------------------------------- os/rt/include/chstreams.h | 146 --------------- os/rt/rt.mk | 4 - os/rt/src/chqueues.c | 446 ---------------------------------------------- os/rt/templates/chconf.h | 8 - 6 files changed, 1043 deletions(-) delete mode 100644 os/rt/include/chqueues.h delete mode 100644 os/rt/include/chstreams.h delete mode 100644 os/rt/src/chqueues.c (limited to 'os/rt') diff --git a/os/rt/include/ch.h b/os/rt/include/ch.h index 29b6c410a..10d4ddfd8 100644 --- a/os/rt/include/ch.h +++ b/os/rt/include/ch.h @@ -99,8 +99,6 @@ #include "chheap.h" #include "chmempools.h" #include "chdynamic.h" -#include "chqueues.h" -#include "chstreams.h" #if !defined(_CHIBIOS_RT_CONF_) #error "missing or wrong configuration file" diff --git a/os/rt/include/chqueues.h b/os/rt/include/chqueues.h deleted file mode 100644 index 3ab7087ca..000000000 --- a/os/rt/include/chqueues.h +++ /dev/null @@ -1,437 +0,0 @@ -/* - ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio. - - This file is part of ChibiOS. - - ChibiOS is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @file chqueues.h - * @brief I/O Queues macros and structures. - * - * @addtogroup io_queues - * @{ - */ - -#ifndef _CHQUEUES_H_ -#define _CHQUEUES_H_ - -#if (CH_CFG_USE_QUEUES == TRUE) || defined(__DOXYGEN__) - -/*===========================================================================*/ -/* Module constants. */ -/*===========================================================================*/ - -/** - * @name Queue functions returned status value - * @{ - */ -#define Q_OK MSG_OK /**< @brief Operation successful. */ -#define Q_TIMEOUT MSG_TIMEOUT /**< @brief Timeout condition. */ -#define Q_RESET MSG_RESET /**< @brief Queue has been reset. */ -#define Q_EMPTY (msg_t)-3 /**< @brief Queue empty. */ -#define Q_FULL (msg_t)-4 /**< @brief Queue full, */ -/** @} */ - -/*===========================================================================*/ -/* Module pre-compile time settings. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Derived constants and error checks. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module data structures and types. */ -/*===========================================================================*/ - -/** - * @brief Type of a generic I/O queue structure. - */ -typedef struct io_queue io_queue_t; - -/** @brief Queue notification callback type.*/ -typedef void (*qnotify_t)(io_queue_t *qp); - -/** - * @brief Generic I/O queue structure. - * @details This structure represents a generic Input or Output asymmetrical - * queue. The queue is asymmetrical because one end is meant to be - * accessed from a thread context, and thus can be blocking, the other - * end is accessible from interrupt handlers or from within a kernel - * lock zone (see I-Locked and S-Locked states in - * @ref system_states) and is non-blocking. - */ -struct io_queue { - threads_queue_t waiting; /**< @brief Queue of waiting threads. */ - volatile size_t counter; /**< @brief Resources counter. */ - uint8_t *buffer; /**< @brief Pointer to the queue buffer.*/ - uint8_t *top; /**< @brief Pointer to the first location - after the buffer. */ - uint8_t *wrptr; /**< @brief Write pointer. */ - uint8_t *rdptr; /**< @brief Read pointer. */ - qnotify_t notify; /**< @brief Data notification callback. */ - void *link; /**< @brief Application defined field. */ -}; - -/** - * @extends io_queue_t - * - * @brief Type of an input queue structure. - * @details This structure represents a generic asymmetrical input queue. - * Writing to the queue is non-blocking and can be performed from - * interrupt handlers or from within a kernel lock zone (see - * I-Locked and S-Locked states in @ref system_states). - * Reading the queue can be a blocking operation and is supposed to - * be performed by a system thread. - */ -typedef io_queue_t input_queue_t; - -/** - * @extends io_queue_t - * - * @brief Type of an output queue structure. - * @details This structure represents a generic asymmetrical output queue. - * Reading from the queue is non-blocking and can be performed from - * interrupt handlers or from within a kernel lock zone (see - * I-Locked and S-Locked states in @ref system_states). - * Writing the queue can be a blocking operation and is supposed to - * be performed by a system thread. - */ -typedef io_queue_t output_queue_t; - -/*===========================================================================*/ -/* Module macros. */ -/*===========================================================================*/ - -/** - * @brief Data part of a static input queue initializer. - * @details This macro should be used when statically initializing an - * input queue that is part of a bigger structure. - * - * @param[in] name the name of the input queue variable - * @param[in] buffer pointer to the queue buffer area - * @param[in] size size of the queue buffer area - * @param[in] inotify input notification callback pointer - * @param[in] link application defined pointer - */ -#define _INPUTQUEUE_DATA(name, buffer, size, inotify, link) { \ - _THREADS_QUEUE_DATA(name), \ - 0U, \ - (uint8_t *)(buffer), \ - (uint8_t *)(buffer) + (size), \ - (uint8_t *)(buffer), \ - (uint8_t *)(buffer), \ - (inotify), \ - (link) \ -} - -/** - * @brief Static input queue initializer. - * @details Statically initialized input queues require no explicit - * initialization using @p chIQInit(). - * - * @param[in] name the name of the input queue variable - * @param[in] buffer pointer to the queue buffer area - * @param[in] size size of the queue buffer area - * @param[in] inotify input notification callback pointer - * @param[in] link application defined pointer - */ -#define INPUTQUEUE_DECL(name, buffer, size, inotify, link) \ - input_queue_t name = _INPUTQUEUE_DATA(name, buffer, size, inotify, link) - -/** - * @brief Data part of a static output queue initializer. - * @details This macro should be used when statically initializing an - * output queue that is part of a bigger structure. - * - * @param[in] name the name of the output queue variable - * @param[in] buffer pointer to the queue buffer area - * @param[in] size size of the queue buffer area - * @param[in] onotify output notification callback pointer - * @param[in] link application defined pointer - */ -#define _OUTPUTQUEUE_DATA(name, buffer, size, onotify, link) { \ - _THREADS_QUEUE_DATA(name), \ - (size), \ - (uint8_t *)(buffer), \ - (uint8_t *)(buffer) + (size), \ - (uint8_t *)(buffer), \ - (uint8_t *)(buffer), \ - (onotify), \ - (link) \ -} - -/** - * @brief Static output queue initializer. - * @details Statically initialized output queues require no explicit - * initialization using @p chOQInit(). - * - * @param[in] name the name of the output queue variable - * @param[in] buffer pointer to the queue buffer area - * @param[in] size size of the queue buffer area - * @param[in] onotify output notification callback pointer - * @param[in] link application defined pointer - */ -#define OUTPUTQUEUE_DECL(name, buffer, size, onotify, link) \ - output_queue_t name = _OUTPUTQUEUE_DATA(name, buffer, size, onotify, link) - -/** - * @name Macro Functions - * @{ - */ -/** - * @brief Returns the queue's buffer size. - * - * @param[in] qp pointer to a @p io_queue_t structure - * @return The buffer size. - * - * @xclass - */ -#define chQSizeX(qp) \ - /*lint -save -e9033 [10.8] The cast is safe.*/ \ - ((size_t)((qp)->top - (qp)->buffer)) \ - /*lint -restore*/ - -/** - * @brief Queue space. - * @details Returns the used space if used on an input queue or the empty - * space if used on an output queue. - * - * @param[in] qp pointer to a @p io_queue_t structure - * @return The buffer space. - * - * @iclass - */ -#define chQSpaceI(qp) ((qp)->counter) - -/** - * @brief Returns the queue application-defined link. - * - * @param[in] qp pointer to a @p io_queue_t structure - * @return The application-defined link. - * - * @xclass - */ -#define chQGetLinkX(qp) ((qp)->link) -/** @} */ - -/*===========================================================================*/ -/* External declarations. */ -/*===========================================================================*/ - -#ifdef __cplusplus -extern "C" { -#endif - void chIQObjectInit(input_queue_t *iqp, uint8_t *bp, size_t size, - qnotify_t infy, void *link); - void chIQResetI(input_queue_t *iqp); - msg_t chIQPutI(input_queue_t *iqp, uint8_t b); - msg_t chIQGetTimeout(input_queue_t *iqp, systime_t timeout); - size_t chIQReadTimeout(input_queue_t *iqp, uint8_t *bp, - size_t n, systime_t timeout); - - void chOQObjectInit(output_queue_t *oqp, uint8_t *bp, size_t size, - qnotify_t onfy, void *link); - void chOQResetI(output_queue_t *oqp); - msg_t chOQPutTimeout(output_queue_t *oqp, uint8_t b, systime_t timeout); - msg_t chOQGetI(output_queue_t *oqp); - size_t chOQWriteTimeout(output_queue_t *oqp, const uint8_t *bp, - size_t n, systime_t timeout); -#ifdef __cplusplus -} -#endif - -/*===========================================================================*/ -/* Module inline functions. */ -/*===========================================================================*/ - -/** - * @brief Returns the filled space into an input queue. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @return The number of full bytes in the queue. - * @retval 0 if the queue is empty. - * - * @iclass - */ -static inline size_t chIQGetFullI(input_queue_t *iqp) { - - chDbgCheckClassI(); - - return (size_t)chQSpaceI(iqp); -} - -/** - * @brief Returns the empty space into an input queue. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @return The number of empty bytes in the queue. - * @retval 0 if the queue is full. - * - * @iclass - */ -static inline size_t chIQGetEmptyI(input_queue_t *iqp) { - - chDbgCheckClassI(); - - return (size_t)(chQSizeX(iqp) - chQSpaceI(iqp)); -} - -/** - * @brief Evaluates to @p true if the specified input queue is empty. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @return The queue status. - * @retval false if the queue is not empty. - * @retval true if the queue is empty. - * - * @iclass - */ -static inline bool chIQIsEmptyI(input_queue_t *iqp) { - - chDbgCheckClassI(); - - return (bool)(chQSpaceI(iqp) == 0U); -} - -/** - * @brief Evaluates to @p true if the specified input queue is full. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @return The queue status. - * @retval false if the queue is not full. - * @retval true if the queue is full. - * - * @iclass - */ -static inline bool chIQIsFullI(input_queue_t *iqp) { - - chDbgCheckClassI(); - - /*lint -save -e9007 [13.5] No side effects.*/ - return (bool)((iqp->wrptr == iqp->rdptr) && (iqp->counter != 0U)); - /*lint -restore*/ -} - -/** - * @brief Input queue read. - * @details This function reads a byte value from an input queue. If the queue - * is empty then the calling thread is suspended until a byte arrives - * in the queue. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @return A byte value from the queue. - * @retval Q_RESET if the queue has been reset. - * - * @api - */ -static inline msg_t chIQGet(input_queue_t *iqp) { - - return chIQGetTimeout(iqp, TIME_INFINITE); -} - -/** - * @brief Returns the filled space into an output queue. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @return The number of full bytes in the queue. - * @retval 0 if the queue is empty. - * - * @iclass - */ -static inline size_t chOQGetFullI(output_queue_t *oqp) { - - chDbgCheckClassI(); - - return (size_t)(chQSizeX(oqp) - chQSpaceI(oqp)); -} - -/** - * @brief Returns the empty space into an output queue. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @return The number of empty bytes in the queue. - * @retval 0 if the queue is full. - * - * @iclass - */ -static inline size_t chOQGetEmptyI(output_queue_t *oqp) { - - chDbgCheckClassI(); - - return (size_t)chQSpaceI(oqp); -} - -/** - * @brief Evaluates to @p true if the specified output queue is empty. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @return The queue status. - * @retval false if the queue is not empty. - * @retval true if the queue is empty. - * - * @iclass - */ -static inline bool chOQIsEmptyI(output_queue_t *oqp) { - - chDbgCheckClassI(); - - /*lint -save -e9007 [13.5] No side effects.*/ - return (bool)((oqp->wrptr == oqp->rdptr) && (oqp->counter != 0U)); - /*lint -restore*/ -} - -/** - * @brief Evaluates to @p true if the specified output queue is full. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @return The queue status. - * @retval false if the queue is not full. - * @retval true if the queue is full. - * - * @iclass - */ -static inline bool chOQIsFullI(output_queue_t *oqp) { - - chDbgCheckClassI(); - - return (bool)(chQSpaceI(oqp) == 0U); -} - -/** - * @brief Output queue write. - * @details This function writes a byte value to an output queue. If the queue - * is full then the calling thread is suspended until there is space - * in the queue. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @param[in] b the byte value to be written in the queue - * @return The operation status. - * @retval Q_OK if the operation succeeded. - * @retval Q_RESET if the queue has been reset. - * - * @api - */ -static inline msg_t chOQPut(output_queue_t *oqp, uint8_t b) { - - return chOQPutTimeout(oqp, b, TIME_INFINITE); -} - -#endif /* CH_CFG_USE_QUEUES == TRUE */ - -#endif /* _CHQUEUES_H_ */ - -/** @} */ diff --git a/os/rt/include/chstreams.h b/os/rt/include/chstreams.h deleted file mode 100644 index 3374a1275..000000000 --- a/os/rt/include/chstreams.h +++ /dev/null @@ -1,146 +0,0 @@ -/* - ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio. - - This file is part of ChibiOS. - - ChibiOS is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @file chstreams.h - * @brief Data streams. - * @details This header defines abstract interfaces useful to access generic - * data streams in a standardized way. - * - * @addtogroup data_streams - * @details This module define an abstract interface for generic data streams. - * Note that no code is present, just abstract interfaces-like - * structures, you should look at the system as to a set of - * abstract C++ classes (even if written in C). This system - * has then advantage to make the access to data streams - * independent from the implementation logic.
- * The stream interface can be used as base class for high level - * object types such as files, sockets, serial ports, pipes etc. - * @{ - */ - -#ifndef _CHSTREAMS_H_ -#define _CHSTREAMS_H_ - -/** - * @brief BaseSequentialStream specific methods. - */ -#define _base_sequential_stream_methods \ - /* Stream write buffer method.*/ \ - size_t (*write)(void *instance, const uint8_t *bp, size_t n); \ - /* Stream read buffer method.*/ \ - size_t (*read)(void *instance, uint8_t *bp, size_t n); \ - /* Channel put method, blocking.*/ \ - msg_t (*put)(void *instance, uint8_t b); \ - /* Channel get method, blocking.*/ \ - msg_t (*get)(void *instance); \ - -/** - * @brief @p BaseSequentialStream specific data. - * @note It is empty because @p BaseSequentialStream is only an interface - * without implementation. - */ -#define _base_sequential_stream_data - -/** - * @brief @p BaseSequentialStream virtual methods table. - */ -struct BaseSequentialStreamVMT { - _base_sequential_stream_methods -}; - -/** - * @brief Base stream class. - * @details This class represents a generic blocking unbuffered sequential - * data stream. - */ -typedef struct { - /** @brief Virtual Methods Table.*/ - const struct BaseSequentialStreamVMT *vmt; - _base_sequential_stream_data -} BaseSequentialStream; - -/** - * @name Macro Functions (BaseSequentialStream) - * @{ - */ -/** - * @brief Sequential Stream write. - * @details The function writes data from a buffer to a stream. - * - * @param[in] ip pointer to a @p BaseSequentialStream or derived class - * @param[in] bp pointer to the data buffer - * @param[in] n the maximum amount of data to be transferred - * @return The number of bytes transferred. The return value can - * be less than the specified number of bytes if an - * end-of-file condition has been met. - * - * @api - */ -#define chSequentialStreamWrite(ip, bp, n) ((ip)->vmt->write(ip, bp, n)) - -/** - * @brief Sequential Stream read. - * @details The function reads data from a stream into a buffer. - * - * @param[in] ip pointer to a @p BaseSequentialStream or derived class - * @param[out] bp pointer to the data buffer - * @param[in] n the maximum amount of data to be transferred - * @return The number of bytes transferred. The return value can - * be less than the specified number of bytes if an - * end-of-file condition has been met. - * - * @api - */ -#define chSequentialStreamRead(ip, bp, n) ((ip)->vmt->read(ip, bp, n)) - -/** - * @brief Sequential Stream blocking byte write. - * @details This function writes a byte value to a channel. If the channel - * is not ready to accept data then the calling thread is suspended. - * - * @param[in] ip pointer to a @p BaseSequentialStream or derived class - * @param[in] b the byte value to be written to the channel - * - * @return The operation status. - * @retval Q_OK if the operation succeeded. - * @retval Q_RESET if an end-of-file condition has been met. - * - * @api - */ -#define chSequentialStreamPut(ip, b) ((ip)->vmt->put(ip, b)) - -/** - * @brief Sequential Stream blocking byte read. - * @details This function reads a byte value from a channel. If the data - * is not available then the calling thread is suspended. - * - * @param[in] ip pointer to a @p BaseSequentialStream or derived class - * - * @return A byte value from the queue. - * @retval Q_RESET if an end-of-file condition has been met. - * - * @api - */ -#define chSequentialStreamGet(ip) ((ip)->vmt->get(ip)) -/** @} */ - -#endif /* _CHSTREAMS_H_ */ - -/** @} */ diff --git a/os/rt/rt.mk b/os/rt/rt.mk index cf92d654d..c445d305f 100644 --- a/os/rt/rt.mk +++ b/os/rt/rt.mk @@ -32,9 +32,6 @@ endif ifneq ($(findstring CH_CFG_USE_MESSAGES TRUE,$(CHCONF)),) KERNSRC += $(CHIBIOS)/os/rt/src/chmsg.c endif -ifneq ($(findstring CH_CFG_USE_QUEUES TRUE,$(CHCONF)),) -KERNSRC += $(CHIBIOS)/os/rt/src/chqueues.c -endif ifneq ($(findstring CH_CFG_USE_DYNAMIC TRUE,$(CHCONF)),) KERNSRC += $(CHIBIOS)/os/rt/src/chdynamic.c endif @@ -64,7 +61,6 @@ KERNSRC := $(CHIBIOS)/os/rt/src/chsys.c \ $(CHIBIOS)/os/rt/src/chcond.c \ $(CHIBIOS)/os/rt/src/chevents.c \ $(CHIBIOS)/os/rt/src/chmsg.c \ - $(CHIBIOS)/os/rt/src/chqueues.c \ $(CHIBIOS)/os/rt/src/chdynamic.c \ $(CHIBIOS)/os/common/oslib/src/chmboxes.c \ $(CHIBIOS)/os/common/oslib/src/chmemcore.c \ diff --git a/os/rt/src/chqueues.c b/os/rt/src/chqueues.c deleted file mode 100644 index 0eeaa3c0e..000000000 --- a/os/rt/src/chqueues.c +++ /dev/null @@ -1,446 +0,0 @@ -/* - ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio. - - This file is part of ChibiOS. - - ChibiOS is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @file chqueues.c - * @brief I/O Queues code. - * - * @addtogroup io_queues - * @details ChibiOS/RT queues are mostly used in serial-like device drivers. - * The device drivers are usually designed to have a lower side - * (lower driver, it is usually an interrupt service routine) and an - * upper side (upper driver, accessed by the application threads).
- * There are several kind of queues:
- * - Input queue, unidirectional queue where the writer is the - * lower side and the reader is the upper side. - * - Output queue, unidirectional queue where the writer is the - * upper side and the reader is the lower side. - * - Full duplex queue, bidirectional queue. Full duplex queues - * are implemented by pairing an input queue and an output queue - * together. - * . - * @pre In order to use the I/O queues the @p CH_CFG_USE_QUEUES option must - * be enabled in @p chconf.h. - * @{ - */ - -#include "ch.h" - -#if (CH_CFG_USE_QUEUES == TRUE) || defined(__DOXYGEN__) - -/*===========================================================================*/ -/* Module local definitions. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module exported variables. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module local types. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module local variables. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module local functions. */ -/*===========================================================================*/ - -/*===========================================================================*/ -/* Module exported functions. */ -/*===========================================================================*/ - -/** - * @brief Initializes an input queue. - * @details A Semaphore is internally initialized and works as a counter of - * the bytes contained in the queue. - * @note The callback is invoked from within the S-Locked system state, - * see @ref system_states. - * - * @param[out] iqp pointer to an @p input_queue_t structure - * @param[in] bp pointer to a memory area allocated as queue buffer - * @param[in] size size of the queue buffer - * @param[in] infy pointer to a callback function that is invoked when - * data is read from the queue. The value can be @p NULL. - * @param[in] link application defined pointer - * - * @init - */ -void chIQObjectInit(input_queue_t *iqp, uint8_t *bp, size_t size, - qnotify_t infy, void *link) { - - chThdQueueObjectInit(&iqp->waiting); - iqp->counter = 0; - iqp->buffer = bp; - iqp->rdptr = bp; - iqp->wrptr = bp; - iqp->top = bp + size; - iqp->notify = infy; - iqp->link = link; -} - -/** - * @brief Resets an input queue. - * @details All the data in the input queue is erased and lost, any waiting - * thread is resumed with status @p Q_RESET. - * @note A reset operation can be used by a low level driver in order to - * obtain immediate attention from the high level layers. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * - * @iclass - */ -void chIQResetI(input_queue_t *iqp) { - - chDbgCheckClassI(); - - iqp->rdptr = iqp->buffer; - iqp->wrptr = iqp->buffer; - iqp->counter = 0; - chThdDequeueAllI(&iqp->waiting, Q_RESET); -} - -/** - * @brief Input queue write. - * @details A byte value is written into the low end of an input queue. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @param[in] b the byte value to be written in the queue - * @return The operation status. - * @retval Q_OK if the operation has been completed with success. - * @retval Q_FULL if the queue is full and the operation cannot be - * completed. - * - * @iclass - */ -msg_t chIQPutI(input_queue_t *iqp, uint8_t b) { - - chDbgCheckClassI(); - - if (chIQIsFullI(iqp)) { - return Q_FULL; - } - - iqp->counter++; - *iqp->wrptr++ = b; - if (iqp->wrptr >= iqp->top) { - iqp->wrptr = iqp->buffer; - } - - chThdDequeueNextI(&iqp->waiting, Q_OK); - - return Q_OK; -} - -/** - * @brief Input queue read with timeout. - * @details This function reads a byte value from an input queue. If the queue - * is empty then the calling thread is suspended until a byte arrives - * in the queue or a timeout occurs. - * @note The callback is invoked before reading the character from the - * buffer or before entering the state @p CH_STATE_WTQUEUE. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @param[in] timeout the number of ticks before the operation timeouts, - * the following special values are allowed: - * - @a TIME_IMMEDIATE immediate timeout. - * - @a TIME_INFINITE no timeout. - * . - * @return A byte value from the queue. - * @retval Q_TIMEOUT if the specified time expired. - * @retval Q_RESET if the queue has been reset. - * - * @api - */ -msg_t chIQGetTimeout(input_queue_t *iqp, systime_t timeout) { - uint8_t b; - - chSysLock(); - if (iqp->notify != NULL) { - iqp->notify(iqp); - } - - while (chIQIsEmptyI(iqp)) { - msg_t msg = chThdEnqueueTimeoutS(&iqp->waiting, timeout); - if (msg < Q_OK) { - chSysUnlock(); - return msg; - } - } - - iqp->counter--; - b = *iqp->rdptr++; - if (iqp->rdptr >= iqp->top) { - iqp->rdptr = iqp->buffer; - } - chSysUnlock(); - - return (msg_t)b; -} - -/** - * @brief Input queue read with timeout. - * @details The function reads data from an input queue into a buffer. The - * operation completes when the specified amount of data has been - * transferred or after the specified timeout or if the queue has - * been reset. - * @note The function is not atomic, if you need atomicity it is suggested - * to use a semaphore or a mutex for mutual exclusion. - * @note The callback is invoked before reading each character from the - * buffer or before entering the state @p CH_STATE_WTQUEUE. - * - * @param[in] iqp pointer to an @p input_queue_t structure - * @param[out] bp pointer to the data buffer - * @param[in] n the maximum amount of data to be transferred, the - * value 0 is reserved - * @param[in] timeout the number of ticks before the operation timeouts, - * the following special values are allowed: - * - @a TIME_IMMEDIATE immediate timeout. - * - @a TIME_INFINITE no timeout. - * . - * @return The number of bytes effectively transferred. - * - * @api - */ -size_t chIQReadTimeout(input_queue_t *iqp, uint8_t *bp, - size_t n, systime_t timeout) { - qnotify_t nfy = iqp->notify; - size_t r = 0; - - chDbgCheck(n > 0U); - - chSysLock(); - while (true) { - if (nfy != NULL) { - nfy(iqp); - } - - while (chIQIsEmptyI(iqp)) { - if (chThdEnqueueTimeoutS(&iqp->waiting, timeout) != Q_OK) { - chSysUnlock(); - return r; - } - } - - iqp->counter--; - *bp++ = *iqp->rdptr++; - if (iqp->rdptr >= iqp->top) { - iqp->rdptr = iqp->buffer; - } - chSysUnlock(); /* Gives a preemption chance in a controlled point.*/ - - r++; - if (--n == 0U) { - return r; - } - - chSysLock(); - } -} - -/** - * @brief Initializes an output queue. - * @details A Semaphore is internally initialized and works as a counter of - * the free bytes in the queue. - * @note The callback is invoked from within the S-Locked system state, - * see @ref system_states. - * - * @param[out] oqp pointer to an @p output_queue_t structure - * @param[in] bp pointer to a memory area allocated as queue buffer - * @param[in] size size of the queue buffer - * @param[in] onfy pointer to a callback function that is invoked when - * data is written to the queue. The value can be @p NULL. - * @param[in] link application defined pointer - * - * @init - */ -void chOQObjectInit(output_queue_t *oqp, uint8_t *bp, size_t size, - qnotify_t onfy, void *link) { - - chThdQueueObjectInit(&oqp->waiting); - oqp->counter = size; - oqp->buffer = bp; - oqp->rdptr = bp; - oqp->wrptr = bp; - oqp->top = bp + size; - oqp->notify = onfy; - oqp->link = link; -} - -/** - * @brief Resets an output queue. - * @details All the data in the output queue is erased and lost, any waiting - * thread is resumed with status @p Q_RESET. - * @note A reset operation can be used by a low level driver in order to - * obtain immediate attention from the high level layers. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * - * @iclass - */ -void chOQResetI(output_queue_t *oqp) { - - chDbgCheckClassI(); - - oqp->rdptr = oqp->buffer; - oqp->wrptr = oqp->buffer; - oqp->counter = chQSizeX(oqp); - chThdDequeueAllI(&oqp->waiting, Q_RESET); -} - -/** - * @brief Output queue write with timeout. - * @details This function writes a byte value to an output queue. If the queue - * is full then the calling thread is suspended until there is space - * in the queue or a timeout occurs. - * @note The callback is invoked after writing the character into the - * buffer. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @param[in] b the byte value to be written in the queue - * @param[in] timeout the number of ticks before the operation timeouts, - * the following special values are allowed: - * - @a TIME_IMMEDIATE immediate timeout. - * - @a TIME_INFINITE no timeout. - * . - * @return The operation status. - * @retval Q_OK if the operation succeeded. - * @retval Q_TIMEOUT if the specified time expired. - * @retval Q_RESET if the queue has been reset. - * - * @api - */ -msg_t chOQPutTimeout(output_queue_t *oqp, uint8_t b, systime_t timeout) { - - chSysLock(); - while (chOQIsFullI(oqp)) { - msg_t msg = chThdEnqueueTimeoutS(&oqp->waiting, timeout); - if (msg < Q_OK) { - chSysUnlock(); - return msg; - } - } - - oqp->counter--; - *oqp->wrptr++ = b; - if (oqp->wrptr >= oqp->top) { - oqp->wrptr = oqp->buffer; - } - - if (oqp->notify != NULL) { - oqp->notify(oqp); - } - chSysUnlock(); - - return Q_OK; -} - -/** - * @brief Output queue read. - * @details A byte value is read from the low end of an output queue. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @return The byte value from the queue. - * @retval Q_EMPTY if the queue is empty. - * - * @iclass - */ -msg_t chOQGetI(output_queue_t *oqp) { - uint8_t b; - - chDbgCheckClassI(); - - if (chOQIsEmptyI(oqp)) { - return Q_EMPTY; - } - - oqp->counter++; - b = *oqp->rdptr++; - if (oqp->rdptr >= oqp->top) { - oqp->rdptr = oqp->buffer; - } - - chThdDequeueNextI(&oqp->waiting, Q_OK); - - return (msg_t)b; -} - -/** - * @brief Output queue write with timeout. - * @details The function writes data from a buffer to an output queue. The - * operation completes when the specified amount of data has been - * transferred or after the specified timeout or if the queue has - * been reset. - * @note The function is not atomic, if you need atomicity it is suggested - * to use a semaphore or a mutex for mutual exclusion. - * @note The callback is invoked after writing each character into the - * buffer. - * - * @param[in] oqp pointer to an @p output_queue_t structure - * @param[in] bp pointer to the data buffer - * @param[in] n the maximum amount of data to be transferred, the - * value 0 is reserved - * @param[in] timeout the number of ticks before the operation timeouts, - * the following special values are allowed: - * - @a TIME_IMMEDIATE immediate timeout. - * - @a TIME_INFINITE no timeout. - * . - * @return The number of bytes effectively transferred. - * - * @api - */ -size_t chOQWriteTimeout(output_queue_t *oqp, const uint8_t *bp, - size_t n, systime_t timeout) { - qnotify_t nfy = oqp->notify; - size_t w = 0; - - chDbgCheck(n > 0U); - - chSysLock(); - while (true) { - while (chOQIsFullI(oqp)) { - if (chThdEnqueueTimeoutS(&oqp->waiting, timeout) != Q_OK) { - chSysUnlock(); - return w; - } - } - - oqp->counter--; - *oqp->wrptr++ = *bp++; - if (oqp->wrptr >= oqp->top) { - oqp->wrptr = oqp->buffer; - } - - if (nfy != NULL) { - nfy(oqp); - } - chSysUnlock(); /* Gives a preemption chance in a controlled point.*/ - - w++; - if (--n == 0U) { - return w; - } - chSysLock(); - } -} -#endif /* CH_CFG_USE_QUEUES == TRUE */ - -/** @} */ diff --git a/os/rt/templates/chconf.h b/os/rt/templates/chconf.h index 9bf08a34d..0b74391a7 100644 --- a/os/rt/templates/chconf.h +++ b/os/rt/templates/chconf.h @@ -264,14 +264,6 @@ */ #define CH_CFG_USE_MAILBOXES TRUE -/** - * @brief I/O Queues APIs. - * @details If enabled then the I/O queues APIs are included in the kernel. - * - * @note The default is @p TRUE. - */ -#define CH_CFG_USE_QUEUES TRUE - /** * @brief Core Memory Manager APIs. * @details If enabled then the core memory manager APIs are included -- cgit v1.2.3