tmk_core/tool/mbed/mbed-sdk/libraries/rtos/rtos/Mutex.h

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