Eric Patterson / mbed-rtos

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

Dependents:   Final_Coffee_Roaster

Fork of mbed-rtos by mbed official

rtos/Mutex.h@31:015df9e602b6, 2014-06-03 (annotated)

Committer:
mbed_official
Date:
Tue Jun 03 11:30:14 2014 +0100
Revision:
31:015df9e602b6
Parent:
8:88a1a9c26ae3 
Synchronized with git revision bcacbb9fbf3432829227430830cca4315b57c1b9



Full URL: https://github.com/mbedmicro/mbed/commit/bcacbb9fbf3432829227430830cca4315b57c1b9/

Who changed what in which revision?

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