desp koval / mbed-rtos

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.

Dependents:   Mecatro_Filtre

rtos/Queue.h@0:4a2c9c1f5b9e, 2021-03-15 (annotated)

Committer:
mecatro_prod
Date:
Mon Mar 15 14:18:11 2021 +0000
Revision:
0:4a2c9c1f5b9e
Pas de changement

Who changed what in which revision?

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