Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/rtos/Mutex.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
marcozecchini 0:9fca2b23d0ba 1 /* mbed Microcontroller Library
marcozecchini 0:9fca2b23d0ba 2 * Copyright (c) 2006-2012 ARM Limited
marcozecchini 0:9fca2b23d0ba 3 *
marcozecchini 0:9fca2b23d0ba 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
marcozecchini 0:9fca2b23d0ba 5 * of this software and associated documentation files (the "Software"), to deal
marcozecchini 0:9fca2b23d0ba 6 * in the Software without restriction, including without limitation the rights
marcozecchini 0:9fca2b23d0ba 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
marcozecchini 0:9fca2b23d0ba 8 * copies of the Software, and to permit persons to whom the Software is
marcozecchini 0:9fca2b23d0ba 9 * furnished to do so, subject to the following conditions:
marcozecchini 0:9fca2b23d0ba 10 *
marcozecchini 0:9fca2b23d0ba 11 * The above copyright notice and this permission notice shall be included in
marcozecchini 0:9fca2b23d0ba 12 * all copies or substantial portions of the Software.
marcozecchini 0:9fca2b23d0ba 13 *
marcozecchini 0:9fca2b23d0ba 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
marcozecchini 0:9fca2b23d0ba 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
marcozecchini 0:9fca2b23d0ba 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
marcozecchini 0:9fca2b23d0ba 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
marcozecchini 0:9fca2b23d0ba 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
marcozecchini 0:9fca2b23d0ba 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
marcozecchini 0:9fca2b23d0ba 20 * SOFTWARE.
marcozecchini 0:9fca2b23d0ba 21 */
marcozecchini 0:9fca2b23d0ba 22 #ifndef MUTEX_H
marcozecchini 0:9fca2b23d0ba 23 #define MUTEX_H
marcozecchini 0:9fca2b23d0ba 24
marcozecchini 0:9fca2b23d0ba 25 #include <stdint.h>
marcozecchini 0:9fca2b23d0ba 26 #include "cmsis_os2.h"
marcozecchini 0:9fca2b23d0ba 27 #include "mbed_rtos1_types.h"
marcozecchini 0:9fca2b23d0ba 28 #include "mbed_rtos_storage.h"
marcozecchini 0:9fca2b23d0ba 29
marcozecchini 0:9fca2b23d0ba 30 #include "platform/NonCopyable.h"
marcozecchini 0:9fca2b23d0ba 31
marcozecchini 0:9fca2b23d0ba 32 namespace rtos {
marcozecchini 0:9fca2b23d0ba 33 /** \addtogroup rtos */
marcozecchini 0:9fca2b23d0ba 34 /** @{*/
marcozecchini 0:9fca2b23d0ba 35 /**
marcozecchini 0:9fca2b23d0ba 36 * \defgroup rtos_Mutex Mutex class
marcozecchini 0:9fca2b23d0ba 37 * @{
marcozecchini 0:9fca2b23d0ba 38 */
marcozecchini 0:9fca2b23d0ba 39
marcozecchini 0:9fca2b23d0ba 40 /** The Mutex class is used to synchronize the execution of threads.
marcozecchini 0:9fca2b23d0ba 41 This is for example used to protect access to a shared resource.
marcozecchini 0:9fca2b23d0ba 42
marcozecchini 0:9fca2b23d0ba 43 @note
marcozecchini 0:9fca2b23d0ba 44 Memory considerations: The mutex control structures will be created on current thread's stack, both for the mbed OS
marcozecchini 0:9fca2b23d0ba 45 and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
marcozecchini 0:9fca2b23d0ba 46 */
marcozecchini 0:9fca2b23d0ba 47 class Mutex : private mbed::NonCopyable<Mutex> {
marcozecchini 0:9fca2b23d0ba 48 public:
marcozecchini 0:9fca2b23d0ba 49 /** Create and Initialize a Mutex object */
marcozecchini 0:9fca2b23d0ba 50 Mutex();
marcozecchini 0:9fca2b23d0ba 51
marcozecchini 0:9fca2b23d0ba 52 /** Create and Initialize a Mutex object
marcozecchini 0:9fca2b23d0ba 53
marcozecchini 0:9fca2b23d0ba 54 @param name name to be used for this mutex. It has to stay allocated for the lifetime of the thread.
marcozecchini 0:9fca2b23d0ba 55 */
marcozecchini 0:9fca2b23d0ba 56 Mutex(const char *name);
marcozecchini 0:9fca2b23d0ba 57
marcozecchini 0:9fca2b23d0ba 58 /** Wait until a Mutex becomes available.
marcozecchini 0:9fca2b23d0ba 59 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
marcozecchini 0:9fca2b23d0ba 60 @return status code that indicates the execution status of the function:
marcozecchini 0:9fca2b23d0ba 61 @a osOK the mutex has been obtained.
marcozecchini 0:9fca2b23d0ba 62 @a osErrorTimeout the mutex could not be obtained in the given time.
marcozecchini 0:9fca2b23d0ba 63 @a osErrorParameter internal error.
marcozecchini 0:9fca2b23d0ba 64 @a osErrorResource the mutex could not be obtained when no timeout was specified.
marcozecchini 0:9fca2b23d0ba 65 @a osErrorISR this function cannot be called from the interrupt service routine.
marcozecchini 0:9fca2b23d0ba 66 */
marcozecchini 0:9fca2b23d0ba 67 osStatus lock(uint32_t millisec=osWaitForever);
marcozecchini 0:9fca2b23d0ba 68
marcozecchini 0:9fca2b23d0ba 69 /** Try to lock the mutex, and return immediately
marcozecchini 0:9fca2b23d0ba 70 @return true if the mutex was acquired, false otherwise.
marcozecchini 0:9fca2b23d0ba 71 */
marcozecchini 0:9fca2b23d0ba 72 bool trylock();
marcozecchini 0:9fca2b23d0ba 73
marcozecchini 0:9fca2b23d0ba 74 /** Unlock the mutex that has previously been locked by the same thread
marcozecchini 0:9fca2b23d0ba 75 @return status code that indicates the execution status of the function:
marcozecchini 0:9fca2b23d0ba 76 @a osOK the mutex has been released.
marcozecchini 0:9fca2b23d0ba 77 @a osErrorParameter internal error.
marcozecchini 0:9fca2b23d0ba 78 @a osErrorResource the mutex was not locked or the current thread wasn't the owner.
marcozecchini 0:9fca2b23d0ba 79 @a osErrorISR this function cannot be called from the interrupt service routine.
marcozecchini 0:9fca2b23d0ba 80 */
marcozecchini 0:9fca2b23d0ba 81 osStatus unlock();
marcozecchini 0:9fca2b23d0ba 82
marcozecchini 0:9fca2b23d0ba 83 /** Get the owner the this mutex
marcozecchini 0:9fca2b23d0ba 84 @return the current owner of this mutex.
marcozecchini 0:9fca2b23d0ba 85 */
marcozecchini 0:9fca2b23d0ba 86 osThreadId get_owner();
marcozecchini 0:9fca2b23d0ba 87
marcozecchini 0:9fca2b23d0ba 88 ~Mutex();
marcozecchini 0:9fca2b23d0ba 89
marcozecchini 0:9fca2b23d0ba 90 private:
marcozecchini 0:9fca2b23d0ba 91 void constructor(const char *name = NULL);
marcozecchini 0:9fca2b23d0ba 92 friend class ConditionVariable;
marcozecchini 0:9fca2b23d0ba 93
marcozecchini 0:9fca2b23d0ba 94 osMutexId_t _id;
marcozecchini 0:9fca2b23d0ba 95 mbed_rtos_storage_mutex_t _obj_mem;
marcozecchini 0:9fca2b23d0ba 96 uint32_t _count;
marcozecchini 0:9fca2b23d0ba 97 };
marcozecchini 0:9fca2b23d0ba 98 /** @}*/
marcozecchini 0:9fca2b23d0ba 99 /** @}*/
marcozecchini 0:9fca2b23d0ba 100 }
marcozecchini 0:9fca2b23d0ba 101 #endif
marcozecchini 0:9fca2b23d0ba 102
marcozecchini 0:9fca2b23d0ba 103