Daoyu_Sofiane Yao_Belouka / 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_Gyro_Programme_Codeur_HC06

rtos/Queue.h@0:a8ed743bc1e1, 2021-04-16 (annotated)

Committer:
daoyu_sofiane
Date:
Fri Apr 16 09:25:33 2021 +0000
Revision:
0:a8ed743bc1e1
Projet Gyropode

Who changed what in which revision?

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