Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-rtos/rtos/Mutex.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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