Dream team / mbed-rtos

Official mbed Real Time Operating System based on the RTX implementation of the CMSIS-RTOS API open standard.

Fork of mbed-rtos by mbed official

rtos/Mutex.h@111:de54bc598ef1, 2016-04-29 (annotated)

Committer:
acarter2
Date:
Fri Apr 29 14:04:02 2016 +0000
Revision:
111:de54bc598ef1
current code 2;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
acarter2 111:de54bc598ef1 1 /* mbed Microcontroller Library
acarter2 111:de54bc598ef1 2 * Copyright (c) 2006-2012 ARM Limited
acarter2 111:de54bc598ef1 3 *
acarter2 111:de54bc598ef1 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
acarter2 111:de54bc598ef1 5 * of this software and associated documentation files (the "Software"), to deal
acarter2 111:de54bc598ef1 6 * in the Software without restriction, including without limitation the rights
acarter2 111:de54bc598ef1 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
acarter2 111:de54bc598ef1 8 * copies of the Software, and to permit persons to whom the Software is
acarter2 111:de54bc598ef1 9 * furnished to do so, subject to the following conditions:
acarter2 111:de54bc598ef1 10 *
acarter2 111:de54bc598ef1 11 * The above copyright notice and this permission notice shall be included in
acarter2 111:de54bc598ef1 12 * all copies or substantial portions of the Software.
acarter2 111:de54bc598ef1 13 *
acarter2 111:de54bc598ef1 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
acarter2 111:de54bc598ef1 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
acarter2 111:de54bc598ef1 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
acarter2 111:de54bc598ef1 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
acarter2 111:de54bc598ef1 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
acarter2 111:de54bc598ef1 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
acarter2 111:de54bc598ef1 20 * SOFTWARE.
acarter2 111:de54bc598ef1 21 */
acarter2 111:de54bc598ef1 22 #ifndef MUTEX_H
acarter2 111:de54bc598ef1 23 #define MUTEX_H
acarter2 111:de54bc598ef1 24
acarter2 111:de54bc598ef1 25 #include <stdint.h>
acarter2 111:de54bc598ef1 26 #include "cmsis_os.h"
acarter2 111:de54bc598ef1 27
acarter2 111:de54bc598ef1 28 namespace rtos {
acarter2 111:de54bc598ef1 29
acarter2 111:de54bc598ef1 30 /** The Mutex class is used to synchronise the execution of threads.
acarter2 111:de54bc598ef1 31 This is for example used to protect access to a shared resource.
acarter2 111:de54bc598ef1 32 */
acarter2 111:de54bc598ef1 33 class Mutex {
acarter2 111:de54bc598ef1 34 public:
acarter2 111:de54bc598ef1 35 /** Create and Initialize a Mutex object */
acarter2 111:de54bc598ef1 36 Mutex();
acarter2 111:de54bc598ef1 37
acarter2 111:de54bc598ef1 38 /** Wait until a Mutex becomes available.
acarter2 111:de54bc598ef1 39 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
acarter2 111:de54bc598ef1 40 @return status code that indicates the execution status of the function.
acarter2 111:de54bc598ef1 41 */
acarter2 111:de54bc598ef1 42 osStatus lock(uint32_t millisec=osWaitForever);
acarter2 111:de54bc598ef1 43
acarter2 111:de54bc598ef1 44 /** Try to lock the mutex, and return immediately
acarter2 111:de54bc598ef1 45 @return true if the mutex was acquired, false otherwise.
acarter2 111:de54bc598ef1 46 */
acarter2 111:de54bc598ef1 47 bool trylock();
acarter2 111:de54bc598ef1 48
acarter2 111:de54bc598ef1 49 /** Unlock the mutex that has previously been locked by the same thread
acarter2 111:de54bc598ef1 50 @return status code that indicates the execution status of the function.
acarter2 111:de54bc598ef1 51 */
acarter2 111:de54bc598ef1 52 osStatus unlock();
acarter2 111:de54bc598ef1 53
acarter2 111:de54bc598ef1 54 ~Mutex();
acarter2 111:de54bc598ef1 55
acarter2 111:de54bc598ef1 56 private:
acarter2 111:de54bc598ef1 57 osMutexId _osMutexId;
acarter2 111:de54bc598ef1 58 osMutexDef_t _osMutexDef;
acarter2 111:de54bc598ef1 59 #ifdef CMSIS_OS_RTX
acarter2 111:de54bc598ef1 60 #ifdef __MBED_CMSIS_RTOS_CA9
acarter2 111:de54bc598ef1 61 int32_t _mutex_data[4];
acarter2 111:de54bc598ef1 62 #else
acarter2 111:de54bc598ef1 63 int32_t _mutex_data[3];
acarter2 111:de54bc598ef1 64 #endif
acarter2 111:de54bc598ef1 65 #endif
acarter2 111:de54bc598ef1 66 };
acarter2 111:de54bc598ef1 67
acarter2 111:de54bc598ef1 68 }
acarter2 111:de54bc598ef1 69 #endif