Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

rtos/Queue.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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