Dream team / mbed-rtos

Official mbed Real Time Operating System based on the RTX implementation of the CMSIS-RTOS API open standard.

Fork of mbed-rtos by mbed official

rtos/Queue.h@111:de54bc598ef1, 2016-04-29 (annotated)

Committer:
acarter2
Date:
Fri Apr 29 14:04:02 2016 +0000
Revision:
111:de54bc598ef1
current code 2;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
acarter2 111:de54bc598ef1 1 /* mbed Microcontroller Library
acarter2 111:de54bc598ef1 2 * Copyright (c) 2006-2012 ARM Limited
acarter2 111:de54bc598ef1 3 *
acarter2 111:de54bc598ef1 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
acarter2 111:de54bc598ef1 5 * of this software and associated documentation files (the "Software"), to deal
acarter2 111:de54bc598ef1 6 * in the Software without restriction, including without limitation the rights
acarter2 111:de54bc598ef1 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
acarter2 111:de54bc598ef1 8 * copies of the Software, and to permit persons to whom the Software is
acarter2 111:de54bc598ef1 9 * furnished to do so, subject to the following conditions:
acarter2 111:de54bc598ef1 10 *
acarter2 111:de54bc598ef1 11 * The above copyright notice and this permission notice shall be included in
acarter2 111:de54bc598ef1 12 * all copies or substantial portions of the Software.
acarter2 111:de54bc598ef1 13 *
acarter2 111:de54bc598ef1 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
acarter2 111:de54bc598ef1 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
acarter2 111:de54bc598ef1 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
acarter2 111:de54bc598ef1 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
acarter2 111:de54bc598ef1 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
acarter2 111:de54bc598ef1 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
acarter2 111:de54bc598ef1 20 * SOFTWARE.
acarter2 111:de54bc598ef1 21 */
acarter2 111:de54bc598ef1 22 #ifndef QUEUE_H
acarter2 111:de54bc598ef1 23 #define QUEUE_H
acarter2 111:de54bc598ef1 24
acarter2 111:de54bc598ef1 25 #include <stdint.h>
acarter2 111:de54bc598ef1 26 #include <string.h>
acarter2 111:de54bc598ef1 27
acarter2 111:de54bc598ef1 28 #include "cmsis_os.h"
acarter2 111:de54bc598ef1 29 #include "mbed_error.h"
acarter2 111:de54bc598ef1 30
acarter2 111:de54bc598ef1 31 namespace rtos {
acarter2 111:de54bc598ef1 32
acarter2 111:de54bc598ef1 33 /** The Queue class allow to control, send, receive, or wait for messages.
acarter2 111:de54bc598ef1 34 A message can be a integer or pointer value to a certain type T that is send
acarter2 111:de54bc598ef1 35 to a thread or interrupt service routine.
acarter2 111:de54bc598ef1 36 @tparam T data type of a single message element.
acarter2 111:de54bc598ef1 37 @tparam queue_sz maximum number of messages in queue.
acarter2 111:de54bc598ef1 38 */
acarter2 111:de54bc598ef1 39 template<typename T, uint32_t queue_sz>
acarter2 111:de54bc598ef1 40 class Queue {
acarter2 111:de54bc598ef1 41 public:
acarter2 111:de54bc598ef1 42 /** Create and initialise a message Queue. */
acarter2 111:de54bc598ef1 43 Queue() {
acarter2 111:de54bc598ef1 44 #ifdef CMSIS_OS_RTX
acarter2 111:de54bc598ef1 45 memset(_queue_q, 0, sizeof(_queue_q));
acarter2 111:de54bc598ef1 46 _queue_def.pool = _queue_q;
acarter2 111:de54bc598ef1 47 _queue_def.queue_sz = queue_sz;
acarter2 111:de54bc598ef1 48 #endif
acarter2 111:de54bc598ef1 49 _queue_id = osMessageCreate(&_queue_def, NULL);
acarter2 111:de54bc598ef1 50 if (_queue_id == NULL) {
acarter2 111:de54bc598ef1 51 error("Error initialising the queue object\n");
acarter2 111:de54bc598ef1 52 }
acarter2 111:de54bc598ef1 53 }
acarter2 111:de54bc598ef1 54
acarter2 111:de54bc598ef1 55 /** Put a message in a Queue.
acarter2 111:de54bc598ef1 56 @param data message pointer.
acarter2 111:de54bc598ef1 57 @param millisec timeout value or 0 in case of no time-out. (default: 0)
acarter2 111:de54bc598ef1 58 @return status code that indicates the execution status of the function.
acarter2 111:de54bc598ef1 59 */
acarter2 111:de54bc598ef1 60 osStatus put(T* data, uint32_t millisec=0) {
acarter2 111:de54bc598ef1 61 return osMessagePut(_queue_id, (uint32_t)data, millisec);
acarter2 111:de54bc598ef1 62 }
acarter2 111:de54bc598ef1 63
acarter2 111:de54bc598ef1 64 /** Get a message or Wait for a message from a Queue.
acarter2 111:de54bc598ef1 65 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
acarter2 111:de54bc598ef1 66 @return event information that includes the message and the status code.
acarter2 111:de54bc598ef1 67 */
acarter2 111:de54bc598ef1 68 osEvent get(uint32_t millisec=osWaitForever) {
acarter2 111:de54bc598ef1 69 return osMessageGet(_queue_id, millisec);
acarter2 111:de54bc598ef1 70 }
acarter2 111:de54bc598ef1 71
acarter2 111:de54bc598ef1 72 private:
acarter2 111:de54bc598ef1 73 osMessageQId _queue_id;
acarter2 111:de54bc598ef1 74 osMessageQDef_t _queue_def;
acarter2 111:de54bc598ef1 75 #ifdef CMSIS_OS_RTX
acarter2 111:de54bc598ef1 76 uint32_t _queue_q[4+(queue_sz)];
acarter2 111:de54bc598ef1 77 #endif
acarter2 111:de54bc598ef1 78 };
acarter2 111:de54bc598ef1 79
acarter2 111:de54bc598ef1 80 }
acarter2 111:de54bc598ef1 81 #endif