takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/ScopedLock.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2018 ARM Limited
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 5 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 6 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 9 *
kadonotakashi 0:8fdf9a60065b 10 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 11 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 13 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 14 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 15 */
kadonotakashi 0:8fdf9a60065b 16 #ifndef MBED_SCOPEDLOCK_H
kadonotakashi 0:8fdf9a60065b 17 #define MBED_SCOPEDLOCK_H
kadonotakashi 0:8fdf9a60065b 18
kadonotakashi 0:8fdf9a60065b 19 #include "platform/NonCopyable.h"
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 namespace mbed {
kadonotakashi 0:8fdf9a60065b 22
kadonotakashi 0:8fdf9a60065b 23 /** \addtogroup platform */
kadonotakashi 0:8fdf9a60065b 24 /** @{*/
kadonotakashi 0:8fdf9a60065b 25 /**
kadonotakashi 0:8fdf9a60065b 26 * \defgroup platform_ScopedLock ScopedLock functions
kadonotakashi 0:8fdf9a60065b 27 * @{
kadonotakashi 0:8fdf9a60065b 28 */
kadonotakashi 0:8fdf9a60065b 29
kadonotakashi 0:8fdf9a60065b 30 /** RAII-style mechanism for owning a lock of Lockable object for the duration of a scoped block
kadonotakashi 0:8fdf9a60065b 31 *
kadonotakashi 0:8fdf9a60065b 32 * @tparam Lockable The type implementing BasicLockable concept
kadonotakashi 0:8fdf9a60065b 33 *
kadonotakashi 0:8fdf9a60065b 34 * @note For type Lockable to be BasicLockable, the following conditions have to be satisfied:
kadonotakashi 0:8fdf9a60065b 35 * - has public member function @a lock which blocks until a lock can be obtained for the current execution context
kadonotakashi 0:8fdf9a60065b 36 * - has public member function @a unlock which releases the lock
kadonotakashi 0:8fdf9a60065b 37 *
kadonotakashi 0:8fdf9a60065b 38 * Usage:
kadonotakashi 0:8fdf9a60065b 39 *
kadonotakashi 0:8fdf9a60065b 40 * Example with rtos::Mutex
kadonotakashi 0:8fdf9a60065b 41 *
kadonotakashi 0:8fdf9a60065b 42 * @code
kadonotakashi 0:8fdf9a60065b 43 * void foo(Mutex &m) {
kadonotakashi 0:8fdf9a60065b 44 * ScopedLock<Mutex> lock(m);
kadonotakashi 0:8fdf9a60065b 45 * // Mutex lock protects code in this block
kadonotakashi 0:8fdf9a60065b 46 * }
kadonotakashi 0:8fdf9a60065b 47 * @endcode
kadonotakashi 0:8fdf9a60065b 48 *
kadonotakashi 0:8fdf9a60065b 49 *
kadonotakashi 0:8fdf9a60065b 50 * More generic example
kadonotakashi 0:8fdf9a60065b 51 *
kadonotakashi 0:8fdf9a60065b 52 * @code
kadonotakashi 0:8fdf9a60065b 53 * template<typename Lockable>
kadonotakashi 0:8fdf9a60065b 54 * void foo(Lockable& lockable) {
kadonotakashi 0:8fdf9a60065b 55 * ScopedLock<Lockable> lock(lockable);
kadonotakashi 0:8fdf9a60065b 56 * // Code in this block runs under lock
kadonotakashi 0:8fdf9a60065b 57 * }
kadonotakashi 0:8fdf9a60065b 58 * @endcode
kadonotakashi 0:8fdf9a60065b 59 */
kadonotakashi 0:8fdf9a60065b 60 template <typename Lockable>
kadonotakashi 0:8fdf9a60065b 61 class ScopedLock : private NonCopyable<ScopedLock<Lockable> > {
kadonotakashi 0:8fdf9a60065b 62 public:
kadonotakashi 0:8fdf9a60065b 63 /** Locks given locable object
kadonotakashi 0:8fdf9a60065b 64 *
kadonotakashi 0:8fdf9a60065b 65 * @param lockable reference to the instance of Lockable object
kadonotakashi 0:8fdf9a60065b 66 * @note lockable object should outlive the ScopedLock object
kadonotakashi 0:8fdf9a60065b 67 */
kadonotakashi 0:8fdf9a60065b 68 ScopedLock(Lockable &lockable): _lockable(lockable)
kadonotakashi 0:8fdf9a60065b 69 {
kadonotakashi 0:8fdf9a60065b 70 _lockable.lock();
kadonotakashi 0:8fdf9a60065b 71 }
kadonotakashi 0:8fdf9a60065b 72
kadonotakashi 0:8fdf9a60065b 73 ~ScopedLock()
kadonotakashi 0:8fdf9a60065b 74 {
kadonotakashi 0:8fdf9a60065b 75 _lockable.unlock();
kadonotakashi 0:8fdf9a60065b 76 }
kadonotakashi 0:8fdf9a60065b 77 private:
kadonotakashi 0:8fdf9a60065b 78 Lockable &_lockable;
kadonotakashi 0:8fdf9a60065b 79 };
kadonotakashi 0:8fdf9a60065b 80
kadonotakashi 0:8fdf9a60065b 81 /**@}*/
kadonotakashi 0:8fdf9a60065b 82
kadonotakashi 0:8fdf9a60065b 83 /**@}*/
kadonotakashi 0:8fdf9a60065b 84
kadonotakashi 0:8fdf9a60065b 85 } // embed
kadonotakashi 0:8fdf9a60065b 86
kadonotakashi 0:8fdf9a60065b 87 #endif // MBED_SCOPEDLOCK_H