Music Visualizer / Mbed 2 deprecated 4180FinalProject

Music Visualizer

Dependencies:   mbed SDFileSystem NeoStrip PinDetect

mbed-rtos/rtos/Mutex.h@9:0e16d1e33c4b, 2020-04-30 (annotated)

Committer:
spatel465
Date:
Thu Apr 30 04:00:33 2020 +0000
Revision:
9:0e16d1e33c4b
Parent:
0:adce77867281 
cleaned up comments

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 MUTEX_H
spatel465 0:adce77867281 23 #define MUTEX_H
spatel465 0:adce77867281 24
spatel465 0:adce77867281 25 #include <stdint.h>
spatel465 0:adce77867281 26 #include "cmsis_os.h"
spatel465 0:adce77867281 27
spatel465 0:adce77867281 28 namespace rtos {
spatel465 0:adce77867281 29 /** \addtogroup rtos */
spatel465 0:adce77867281 30 /** @{*/
spatel465 0:adce77867281 31
spatel465 0:adce77867281 32 /** The Mutex class is used to synchronise the execution of threads.
spatel465 0:adce77867281 33 This is for example used to protect access to a shared resource.
spatel465 0:adce77867281 34 */
spatel465 0:adce77867281 35 class Mutex {
spatel465 0:adce77867281 36 public:
spatel465 0:adce77867281 37 /** Create and Initialize a Mutex object */
spatel465 0:adce77867281 38 Mutex();
spatel465 0:adce77867281 39
spatel465 0:adce77867281 40 /** Wait until a Mutex becomes available.
spatel465 0:adce77867281 41 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
spatel465 0:adce77867281 42 @return status code that indicates the execution status of the function.
spatel465 0:adce77867281 43 */
spatel465 0:adce77867281 44 osStatus lock(uint32_t millisec=osWaitForever);
spatel465 0:adce77867281 45
spatel465 0:adce77867281 46 /** Try to lock the mutex, and return immediately
spatel465 0:adce77867281 47 @return true if the mutex was acquired, false otherwise.
spatel465 0:adce77867281 48 */
spatel465 0:adce77867281 49 bool trylock();
spatel465 0:adce77867281 50
spatel465 0:adce77867281 51 /** Unlock the mutex that has previously been locked by the same thread
spatel465 0:adce77867281 52 @return status code that indicates the execution status of the function.
spatel465 0:adce77867281 53 */
spatel465 0:adce77867281 54 osStatus unlock();
spatel465 0:adce77867281 55
spatel465 0:adce77867281 56 ~Mutex();
spatel465 0:adce77867281 57
spatel465 0:adce77867281 58 private:
spatel465 0:adce77867281 59 osMutexId _osMutexId;
spatel465 0:adce77867281 60 osMutexDef_t _osMutexDef;
spatel465 0:adce77867281 61 #ifdef CMSIS_OS_RTX
spatel465 0:adce77867281 62 #if defined(__MBED_CMSIS_RTOS_CA9) || defined(__MBED_CMSIS_RTOS_CM)
spatel465 0:adce77867281 63 int32_t _mutex_data[4];
spatel465 0:adce77867281 64 #else
spatel465 0:adce77867281 65 int32_t _mutex_data[3];
spatel465 0:adce77867281 66 #endif
spatel465 0:adce77867281 67 #endif
spatel465 0:adce77867281 68 };
spatel465 0:adce77867281 69
spatel465 0:adce77867281 70 }
spatel465 0:adce77867281 71 #endif
spatel465 0:adce77867281 72
spatel465 0:adce77867281 73 /** @}*/