Michael Kuchnik / mbed-rtos

First Commit

Dependents:   uLCD_Multiscreen

rtos/Queue.h@0:8b4ab67d92b2, 2015-03-11 (annotated)

Committer:
Mkuchnik3
Date:
Wed Mar 11 21:31:16 2015 +0000
Revision:
0:8b4ab67d92b2
First Commit

Who changed what in which revision?

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