BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/rtos/Mutex.h@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

UserRevisionLine numberNew contents of line
borlanic 0:380207fcb5c1 1 /* mbed Microcontroller Library
borlanic 0:380207fcb5c1 2 * Copyright (c) 2006-2012 ARM Limited
borlanic 0:380207fcb5c1 3 *
borlanic 0:380207fcb5c1 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
borlanic 0:380207fcb5c1 5 * of this software and associated documentation files (the "Software"), to deal
borlanic 0:380207fcb5c1 6 * in the Software without restriction, including without limitation the rights
borlanic 0:380207fcb5c1 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
borlanic 0:380207fcb5c1 8 * copies of the Software, and to permit persons to whom the Software is
borlanic 0:380207fcb5c1 9 * furnished to do so, subject to the following conditions:
borlanic 0:380207fcb5c1 10 *
borlanic 0:380207fcb5c1 11 * The above copyright notice and this permission notice shall be included in
borlanic 0:380207fcb5c1 12 * all copies or substantial portions of the Software.
borlanic 0:380207fcb5c1 13 *
borlanic 0:380207fcb5c1 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
borlanic 0:380207fcb5c1 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
borlanic 0:380207fcb5c1 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
borlanic 0:380207fcb5c1 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
borlanic 0:380207fcb5c1 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
borlanic 0:380207fcb5c1 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
borlanic 0:380207fcb5c1 20 * SOFTWARE.
borlanic 0:380207fcb5c1 21 */
borlanic 0:380207fcb5c1 22 #ifndef MUTEX_H
borlanic 0:380207fcb5c1 23 #define MUTEX_H
borlanic 0:380207fcb5c1 24
borlanic 0:380207fcb5c1 25 #include <stdint.h>
borlanic 0:380207fcb5c1 26 #include "cmsis_os2.h"
borlanic 0:380207fcb5c1 27 #include "mbed_rtos1_types.h"
borlanic 0:380207fcb5c1 28 #include "mbed_rtos_storage.h"
borlanic 0:380207fcb5c1 29
borlanic 0:380207fcb5c1 30 #include "platform/NonCopyable.h"
borlanic 0:380207fcb5c1 31 #include "platform/ScopedLock.h"
borlanic 0:380207fcb5c1 32
borlanic 0:380207fcb5c1 33 namespace rtos {
borlanic 0:380207fcb5c1 34 /** \addtogroup rtos */
borlanic 0:380207fcb5c1 35 /** @{*/
borlanic 0:380207fcb5c1 36
borlanic 0:380207fcb5c1 37 class Mutex;
borlanic 0:380207fcb5c1 38 /** Typedef for the mutex lock
borlanic 0:380207fcb5c1 39 *
borlanic 0:380207fcb5c1 40 * Usage:
borlanic 0:380207fcb5c1 41 * @code
borlanic 0:380207fcb5c1 42 * void foo(Mutex &m) {
borlanic 0:380207fcb5c1 43 * ScopedMutexLock lock(m);
borlanic 0:380207fcb5c1 44 * // Mutex lock protects code in this block
borlanic 0:380207fcb5c1 45 * }
borlanic 0:380207fcb5c1 46 * @endcode
borlanic 0:380207fcb5c1 47 */
borlanic 0:380207fcb5c1 48 typedef mbed::ScopedLock<Mutex> ScopedMutexLock;
borlanic 0:380207fcb5c1 49
borlanic 0:380207fcb5c1 50 /**
borlanic 0:380207fcb5c1 51 * \defgroup rtos_Mutex Mutex class
borlanic 0:380207fcb5c1 52 * @{
borlanic 0:380207fcb5c1 53 */
borlanic 0:380207fcb5c1 54
borlanic 0:380207fcb5c1 55 /** The Mutex class is used to synchronize the execution of threads.
borlanic 0:380207fcb5c1 56 This is for example used to protect access to a shared resource.
borlanic 0:380207fcb5c1 57
borlanic 0:380207fcb5c1 58 @note You cannot use member functions of this class in ISR context. If you require Mutex functionality within
borlanic 0:380207fcb5c1 59 ISR handler, consider using @a Semaphore.
borlanic 0:380207fcb5c1 60
borlanic 0:380207fcb5c1 61 @note
borlanic 0:380207fcb5c1 62 Memory considerations: The mutex control structures will be created on current thread's stack, both for the Mbed OS
borlanic 0:380207fcb5c1 63 and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
borlanic 0:380207fcb5c1 64 */
borlanic 0:380207fcb5c1 65 class Mutex : private mbed::NonCopyable<Mutex> {
borlanic 0:380207fcb5c1 66 public:
borlanic 0:380207fcb5c1 67 /** Create and Initialize a Mutex object
borlanic 0:380207fcb5c1 68 *
borlanic 0:380207fcb5c1 69 * @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 70 */
borlanic 0:380207fcb5c1 71 Mutex();
borlanic 0:380207fcb5c1 72
borlanic 0:380207fcb5c1 73 /** Create and Initialize a Mutex object
borlanic 0:380207fcb5c1 74
borlanic 0:380207fcb5c1 75 @param name name to be used for this mutex. It has to stay allocated for the lifetime of the thread.
borlanic 0:380207fcb5c1 76
borlanic 0:380207fcb5c1 77 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 78 */
borlanic 0:380207fcb5c1 79 Mutex(const char *name);
borlanic 0:380207fcb5c1 80
borlanic 0:380207fcb5c1 81 /** Wait until a Mutex becomes available.
borlanic 0:380207fcb5c1 82 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
borlanic 0:380207fcb5c1 83 @return status code that indicates the execution status of the function:
borlanic 0:380207fcb5c1 84 @a osOK the mutex has been obtained.
borlanic 0:380207fcb5c1 85 @a osErrorTimeout the mutex could not be obtained in the given time.
borlanic 0:380207fcb5c1 86 @a osErrorParameter internal error.
borlanic 0:380207fcb5c1 87 @a osErrorResource the mutex could not be obtained when no timeout was specified.
borlanic 0:380207fcb5c1 88 @a osErrorISR this function cannot be called from the interrupt service routine.
borlanic 0:380207fcb5c1 89
borlanic 0:380207fcb5c1 90 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 91 */
borlanic 0:380207fcb5c1 92 osStatus lock(uint32_t millisec=osWaitForever);
borlanic 0:380207fcb5c1 93
borlanic 0:380207fcb5c1 94 /** Try to lock the mutex, and return immediately
borlanic 0:380207fcb5c1 95 @return true if the mutex was acquired, false otherwise.
borlanic 0:380207fcb5c1 96 @note equivalent to trylock_for(0)
borlanic 0:380207fcb5c1 97
borlanic 0:380207fcb5c1 98 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 99 */
borlanic 0:380207fcb5c1 100 bool trylock();
borlanic 0:380207fcb5c1 101
borlanic 0:380207fcb5c1 102 /** Try to lock the mutex for a specified time
borlanic 0:380207fcb5c1 103 @param millisec timeout value or 0 in case of no time-out.
borlanic 0:380207fcb5c1 104 @return true if the mutex was acquired, false otherwise.
borlanic 0:380207fcb5c1 105 @note the underlying RTOS may have a limit to the maximum wait time
borlanic 0:380207fcb5c1 106 due to internal 32-bit computations, but this is guaranteed to work if the
borlanic 0:380207fcb5c1 107 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
borlanic 0:380207fcb5c1 108 the lock attempt will time out earlier than specified.
borlanic 0:380207fcb5c1 109
borlanic 0:380207fcb5c1 110 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 111 */
borlanic 0:380207fcb5c1 112 bool trylock_for(uint32_t millisec);
borlanic 0:380207fcb5c1 113
borlanic 0:380207fcb5c1 114 /** Try to lock the mutex until specified time
borlanic 0:380207fcb5c1 115 @param millisec absolute timeout time, referenced to Kernel::get_ms_count()
borlanic 0:380207fcb5c1 116 @return true if the mutex was acquired, false otherwise.
borlanic 0:380207fcb5c1 117 @note the underlying RTOS may have a limit to the maximum wait time
borlanic 0:380207fcb5c1 118 due to internal 32-bit computations, but this is guaranteed to work if the
borlanic 0:380207fcb5c1 119 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
borlanic 0:380207fcb5c1 120 the lock attempt will time out earlier than specified.
borlanic 0:380207fcb5c1 121
borlanic 0:380207fcb5c1 122 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 123 */
borlanic 0:380207fcb5c1 124 bool trylock_until(uint64_t millisec);
borlanic 0:380207fcb5c1 125
borlanic 0:380207fcb5c1 126 /** Unlock the mutex that has previously been locked by the same thread
borlanic 0:380207fcb5c1 127 @return status code that indicates the execution status of the function:
borlanic 0:380207fcb5c1 128 @a osOK the mutex has been released.
borlanic 0:380207fcb5c1 129 @a osErrorParameter internal error.
borlanic 0:380207fcb5c1 130 @a osErrorResource the mutex was not locked or the current thread wasn't the owner.
borlanic 0:380207fcb5c1 131 @a osErrorISR this function cannot be called from the interrupt service routine.
borlanic 0:380207fcb5c1 132
borlanic 0:380207fcb5c1 133 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 134 */
borlanic 0:380207fcb5c1 135 osStatus unlock();
borlanic 0:380207fcb5c1 136
borlanic 0:380207fcb5c1 137 /** Get the owner the this mutex
borlanic 0:380207fcb5c1 138 @return the current owner of this mutex.
borlanic 0:380207fcb5c1 139
borlanic 0:380207fcb5c1 140 @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 141 */
borlanic 0:380207fcb5c1 142 osThreadId get_owner();
borlanic 0:380207fcb5c1 143
borlanic 0:380207fcb5c1 144 /** Mutex destructor
borlanic 0:380207fcb5c1 145 *
borlanic 0:380207fcb5c1 146 * @note You cannot call this function from ISR context.
borlanic 0:380207fcb5c1 147 */
borlanic 0:380207fcb5c1 148 ~Mutex();
borlanic 0:380207fcb5c1 149
borlanic 0:380207fcb5c1 150 private:
borlanic 0:380207fcb5c1 151 void constructor(const char *name = NULL);
borlanic 0:380207fcb5c1 152 friend class ConditionVariable;
borlanic 0:380207fcb5c1 153
borlanic 0:380207fcb5c1 154 osMutexId_t _id;
borlanic 0:380207fcb5c1 155 mbed_rtos_storage_mutex_t _obj_mem;
borlanic 0:380207fcb5c1 156 uint32_t _count;
borlanic 0:380207fcb5c1 157 };
borlanic 0:380207fcb5c1 158 /** @}*/
borlanic 0:380207fcb5c1 159 /** @}*/
borlanic 0:380207fcb5c1 160 }
borlanic 0:380207fcb5c1 161 #endif
borlanic 0:380207fcb5c1 162
borlanic 0:380207fcb5c1 163