ELEC2645 (2018/19) / Mbed 2 deprecated el17dg

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Fork of el17dg by Dmitrijs Griskovs

mbed-rtos/rtos/Queue.h@1:5aa2312d3e94, 2019-02-26 (annotated)

Committer:
Noximilien
Date:
Tue Feb 26 14:24:01 2019 +0000
Revision:
1:5aa2312d3e94
have made a pointer and basic menu

Who changed what in which revision?

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