Shoaib Ahmed / Mbed 2 deprecated uzairkhan

Final 350 project

Dependencies:   uzair Camera_LS_Y201 F7_Ethernet LCD_DISCO_F746NG NetworkAPI SDFileSystem mbed

mbed-rtos/rtos/Queue.h@0:791a779d6220, 2017-07-31 (annotated)

Committer:
shoaib_ahmed
Date:
Mon Jul 31 09:16:35 2017 +0000
Revision:
0:791a779d6220
final project;

Who changed what in which revision?

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