Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/rtos/EventFlags.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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