36372 mbed / Mbed 2 deprecated SP14P1_skeleton

skeleton for lab1

Dependencies:   AvailableMemory mbed-rtos mbed

Fork of helloaabbc by 32314 mbed

mbed-rtos/rtos/Queue.h@1:55e99f6e2aa5, 2014-04-04 (annotated)

Committer:
mbed36372
Date:
Fri Apr 04 21:31:22 2014 +0000
Revision:
1:55e99f6e2aa5
Parent:
0:1c8f2727e9f5 
SP14_lab1

Who changed what in which revision?

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