Music Visualizer / Mbed 2 deprecated 4180FinalProject

Music Visualizer

Dependencies:   mbed SDFileSystem NeoStrip PinDetect

mbed-rtos/rtos/Queue.h@0:adce77867281, 2020-04-30 (annotated)

Committer:
spatel465
Date:
Thu Apr 30 01:45:25 2020 +0000
Revision:
0:adce77867281
test

Who changed what in which revision?

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