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