desp koval / mbed-rtos

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Mecatro_Filtre

rtos/Mutex.h@0:4a2c9c1f5b9e, 2021-03-15 (annotated)

Committer:
mecatro_prod
Date:
Mon Mar 15 14:18:11 2021 +0000
Revision:
0:4a2c9c1f5b9e
Pas de changement

Who changed what in which revision?

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