EventFlags.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2017 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef EVENT_FLAG_H
00023 #define EVENT_FLAG_H
00024 
00025 #include <stdint.h>
00026 #include "cmsis_os2.h"
00027 #include "mbed_rtos1_types.h"
00028 #include "mbed_rtos_storage.h"
00029 
00030 #include "platform/NonCopyable.h"
00031 
00032 namespace rtos {
00033 /** \addtogroup rtos */
00034 /** @{*/
00035 /**
00036  * \defgroup rtos_EventFlags EventFlags class
00037  * @{
00038  */
00039  
00040 /** The EventFlags class is used to signal or wait for an arbitrary event or events.
00041  @note 
00042  EventFlags support 31 flags so the MSB flag is ignored, it is used to return an error code (@a osFlagsError)
00043  @note
00044  Memory considerations: The EventFlags control structures will be created on current thread's stack, both for the mbed OS
00045  and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
00046 */
00047 class EventFlags : private mbed::NonCopyable<EventFlags> {
00048 public:
00049     /** Create and Initialize an EventFlags object
00050      *
00051      * @note You cannot call this function from ISR context.
00052     */
00053     EventFlags();
00054 
00055     /** Create and Initialize a EventFlags object
00056 
00057      @param name name to be used for this EventFlags. It has to stay allocated for the lifetime of the thread.
00058 
00059      @note You cannot call this function from ISR context.
00060     */
00061     EventFlags(const char *name);
00062 
00063     /** Set the specified Event Flags.
00064       @param   flags  specifies the flags that shall be set.
00065       @return  event flags after setting or error code if highest bit set (@a osFlagsError).
00066 
00067       @note This function may be called from ISR context.
00068      */
00069     uint32_t set(uint32_t flags);
00070 
00071     /** Clear the specified Event Flags.
00072       @param   flags  specifies the flags that shall be cleared. (default: 0x7fffffff - all flags)
00073       @return  event flags before clearing or error code if highest bit set (@a osFlagsError).
00074 
00075       @note You may call this function from ISR context.
00076      */
00077     uint32_t clear(uint32_t flags = 0x7fffffff);
00078 
00079     /** Get the currently set Event Flags.
00080       @return  set event flags.
00081 
00082       @note You may call this function from ISR context.
00083      */
00084     uint32_t get() const;
00085 
00086     /** Wait for all of the specified event flags to become signaled.
00087       @param   flags    specifies the flags to wait for.
00088       @param   timeout  timeout value or 0 in case of no time-out. (default: osWaitForever)
00089       @param   clear    specifies wether to clear the flags after waiting for them. (default: true)
00090       @return  event flags before clearing or error code if highest bit set (@a osFlagsError).
00091 
00092       @note You may call this function from ISR context if the timeout parameter is set to 0.
00093      */
00094     uint32_t wait_all(uint32_t flags = 0, uint32_t timeout = osWaitForever, bool clear = true);
00095 
00096     /** Wait for any of the specified event flags to become signaled.
00097       @param   flags    specifies the flags to wait for. (default: 0)
00098       @param   timeout  timeout value or 0 in case of no time-out. (default: osWaitForever)
00099       @param   clear    specifies wether to clear the flags after waiting for them. (default: true)
00100       @return  event flags before clearing or error code if highest bit set (@a osFlagsError).
00101 
00102       @note This function may be called from ISR context if the timeout parameter is set to 0.
00103      */
00104     uint32_t wait_any(uint32_t flags = 0, uint32_t timeout = osWaitForever, bool clear = true);
00105 
00106     /** Event flags destructor
00107 
00108       @note You cannot call this function from ISR context.
00109     */
00110     ~EventFlags();
00111 
00112 private:
00113     void constructor(const char *name = NULL);
00114     uint32_t wait(uint32_t flags, uint32_t opt, uint32_t timeout, bool clear);
00115     osEventFlagsId_t                _id;
00116     mbed_rtos_storage_event_flags_t _obj_mem;
00117 };
00118 
00119 /** @}*/
00120 /** @}*/
00121 
00122 }
00123 #endif
00124