Shoaib Ahmed / Mbed 2 deprecated uzairkhan

Final 350 project

Dependencies:   uzair Camera_LS_Y201 F7_Ethernet LCD_DISCO_F746NG NetworkAPI SDFileSystem mbed

mbed-rtos/rtos/Mutex.h@0:791a779d6220, 2017-07-31 (annotated)

Committer:
shoaib_ahmed
Date:
Mon Jul 31 09:16:35 2017 +0000
Revision:
0:791a779d6220
final project;

Who changed what in which revision?

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