PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/rtos/EventFlags.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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