Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

rtos/EventFlags.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2006-2019 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kenjiArai 0:5b88d5760320 5 * of this software and associated documentation files (the "Software"), to deal
kenjiArai 0:5b88d5760320 6 * in the Software without restriction, including without limitation the rights
kenjiArai 0:5b88d5760320 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kenjiArai 0:5b88d5760320 8 * copies of the Software, and to permit persons to whom the Software is
kenjiArai 0:5b88d5760320 9 * furnished to do so, subject to the following conditions:
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * The above copyright notice and this permission notice shall be included in
kenjiArai 0:5b88d5760320 12 * all copies or substantial portions of the Software.
kenjiArai 0:5b88d5760320 13 *
kenjiArai 0:5b88d5760320 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kenjiArai 0:5b88d5760320 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kenjiArai 0:5b88d5760320 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kenjiArai 0:5b88d5760320 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kenjiArai 0:5b88d5760320 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kenjiArai 0:5b88d5760320 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kenjiArai 0:5b88d5760320 20 * SOFTWARE.
kenjiArai 0:5b88d5760320 21 */
kenjiArai 0:5b88d5760320 22 #ifndef EVENT_FLAG_H
kenjiArai 0:5b88d5760320 23 #define EVENT_FLAG_H
kenjiArai 0:5b88d5760320 24
kenjiArai 1:9db0e321a9f4 25 #include <cstddef>
kenjiArai 0:5b88d5760320 26 #include <stdint.h>
kenjiArai 1:9db0e321a9f4 27 #include "rtos/mbed_rtos_types.h"
kenjiArai 1:9db0e321a9f4 28 #include "rtos/mbed_rtos1_types.h"
kenjiArai 1:9db0e321a9f4 29 #include "rtos/mbed_rtos_storage.h"
kenjiArai 0:5b88d5760320 30
kenjiArai 0:5b88d5760320 31 #include "platform/NonCopyable.h"
kenjiArai 0:5b88d5760320 32
kenjiArai 0:5b88d5760320 33 namespace rtos {
kenjiArai 1:9db0e321a9f4 34 /** \addtogroup rtos-public-api */
kenjiArai 0:5b88d5760320 35 /** @{*/
kenjiArai 1:9db0e321a9f4 36
kenjiArai 0:5b88d5760320 37 /**
kenjiArai 0:5b88d5760320 38 * \defgroup rtos_EventFlags EventFlags class
kenjiArai 0:5b88d5760320 39 * @{
kenjiArai 0:5b88d5760320 40 */
kenjiArai 0:5b88d5760320 41
kenjiArai 0:5b88d5760320 42 /** The EventFlags class is used to control event flags or wait for event flags other threads control.
kenjiArai 0:5b88d5760320 43
kenjiArai 0:5b88d5760320 44 @note
kenjiArai 0:5b88d5760320 45 EventFlags support 31 flags. The MSB flag is ignored. It is used to return an error code (@a osFlagsError).
kenjiArai 0:5b88d5760320 46
kenjiArai 0:5b88d5760320 47 @note
kenjiArai 0:5b88d5760320 48 Memory considerations: The EventFlags control structures will be created on the current thread's stack, both for the Mbed OS
kenjiArai 0:5b88d5760320 49 and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
kenjiArai 0:5b88d5760320 50 */
kenjiArai 0:5b88d5760320 51 class EventFlags : private mbed::NonCopyable<EventFlags> {
kenjiArai 0:5b88d5760320 52 public:
kenjiArai 0:5b88d5760320 53 /** Create and initialize an EventFlags object.
kenjiArai 0:5b88d5760320 54 *
kenjiArai 0:5b88d5760320 55 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 56 */
kenjiArai 0:5b88d5760320 57 EventFlags();
kenjiArai 0:5b88d5760320 58
kenjiArai 0:5b88d5760320 59 /** Create and initialize an EventFlags object.
kenjiArai 0:5b88d5760320 60
kenjiArai 0:5b88d5760320 61 @param name name to be used for this EventFlags. It has to stay allocated for the lifetime of the thread.
kenjiArai 0:5b88d5760320 62
kenjiArai 0:5b88d5760320 63 @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 64 */
kenjiArai 0:5b88d5760320 65 EventFlags(const char *name);
kenjiArai 0:5b88d5760320 66
kenjiArai 0:5b88d5760320 67 /** Set the specified event flags.
kenjiArai 0:5b88d5760320 68 @param flags the flags that will be set.
kenjiArai 0:5b88d5760320 69 @return event flags after setting or error code if highest bit set (see @a osFlagsError for details).
kenjiArai 0:5b88d5760320 70
kenjiArai 0:5b88d5760320 71 @note This function may be called from ISR context.
kenjiArai 0:5b88d5760320 72 */
kenjiArai 0:5b88d5760320 73 uint32_t set(uint32_t flags);
kenjiArai 0:5b88d5760320 74
kenjiArai 0:5b88d5760320 75 /** Clear the specified event flags.
kenjiArai 0:5b88d5760320 76 @param flags the flags that will be cleared (default: 0x7fffffff -- all flags).
kenjiArai 0:5b88d5760320 77 @return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
kenjiArai 0:5b88d5760320 78
kenjiArai 0:5b88d5760320 79 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 80 */
kenjiArai 0:5b88d5760320 81 uint32_t clear(uint32_t flags = 0x7fffffff);
kenjiArai 0:5b88d5760320 82
kenjiArai 0:5b88d5760320 83 /** Get the currently set event flags.
kenjiArai 0:5b88d5760320 84 @return current event flags.
kenjiArai 0:5b88d5760320 85
kenjiArai 0:5b88d5760320 86 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 87 */
kenjiArai 0:5b88d5760320 88 uint32_t get() const;
kenjiArai 0:5b88d5760320 89
kenjiArai 0:5b88d5760320 90 /** Wait for all of the specified event flags to become signaled.
kenjiArai 0:5b88d5760320 91 @param flags the flags to wait for (default: 0 -- no flags).
kenjiArai 0:5b88d5760320 92 @param millisec timeout value (default: osWaitForever).
kenjiArai 0:5b88d5760320 93 @param clear clear specified event flags after waiting for them (default: true).
kenjiArai 0:5b88d5760320 94 @return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
kenjiArai 0:5b88d5760320 95
kenjiArai 0:5b88d5760320 96 @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 97 */
kenjiArai 0:5b88d5760320 98 uint32_t wait_all(uint32_t flags = 0, uint32_t millisec = osWaitForever, bool clear = true);
kenjiArai 0:5b88d5760320 99
kenjiArai 0:5b88d5760320 100 /** Wait for any of the specified event flags to become signaled.
kenjiArai 0:5b88d5760320 101 @param flags the flags to wait for (default: 0 -- no flags).
kenjiArai 0:5b88d5760320 102 @param millisec timeout value (default: osWaitForever).
kenjiArai 0:5b88d5760320 103 @param clear clear specified event flags after waiting for them (default: true).
kenjiArai 0:5b88d5760320 104 @return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
kenjiArai 0:5b88d5760320 105
kenjiArai 0:5b88d5760320 106 @note This function may be called from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 107 */
kenjiArai 0:5b88d5760320 108 uint32_t wait_any(uint32_t flags = 0, uint32_t millisec = osWaitForever, bool clear = true);
kenjiArai 0:5b88d5760320 109
kenjiArai 0:5b88d5760320 110 /** EventFlags destructor.
kenjiArai 0:5b88d5760320 111
kenjiArai 0:5b88d5760320 112 @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 113 */
kenjiArai 0:5b88d5760320 114 ~EventFlags();
kenjiArai 0:5b88d5760320 115
kenjiArai 0:5b88d5760320 116 private:
kenjiArai 1:9db0e321a9f4 117 void constructor(const char *name = nullptr);
kenjiArai 0:5b88d5760320 118 uint32_t wait(uint32_t flags, uint32_t opt, uint32_t millisec, bool clear);
kenjiArai 1:9db0e321a9f4 119 #if MBED_CONF_RTOS_PRESENT
kenjiArai 0:5b88d5760320 120 osEventFlagsId_t _id;
kenjiArai 0:5b88d5760320 121 mbed_rtos_storage_event_flags_t _obj_mem;
kenjiArai 1:9db0e321a9f4 122 #else
kenjiArai 1:9db0e321a9f4 123 uint32_t _flags;
kenjiArai 1:9db0e321a9f4 124 #endif
kenjiArai 0:5b88d5760320 125 };
kenjiArai 0:5b88d5760320 126
kenjiArai 0:5b88d5760320 127 /** @}*/
kenjiArai 0:5b88d5760320 128 /** @}*/
kenjiArai 0:5b88d5760320 129
kenjiArai 0:5b88d5760320 130 }
kenjiArai 0:5b88d5760320 131 #endif