Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-rtos/rtos/Queue.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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