cebri alyac / mbed-rtos

Yes

Dependents:   Asservissement_Gyro

rtos/Mutex.h@0:77205fc699b9, 2022-05-08 (annotated)

Committer:
braichi13
Date:
Sun May 08 14:39:47 2022 +0000
Revision:
0:77205fc699b9
Programme du Gyropode

Who changed what in which revision?

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