freertos_task_notification.hpp

Go to the documentation of this file.

 
#ifndef ELEC_C7222_UTILS_FREERTOS_TASK_NOTIFICATION_HPP
#define ELEC_C7222_UTILS_FREERTOS_TASK_NOTIFICATION_HPP
 
#include <cstdint>
 
namespace c7222 {
 
class FreeRtosTaskNotification final {
  public:
    using TaskHandle = void*;
 
    enum class Action : std::uint8_t {
        kNoAction = 0,
        kSetBits,
        kIncrement,
        kSetValueWithOverwrite,
        kSetValueWithoutOverwrite
    };
 
    static bool Notify(TaskHandle task_handle, std::uint32_t value, Action action);
    static bool NotifyFromISR(TaskHandle task_handle, std::uint32_t value, Action action);
    static bool NotifyIndexed(TaskHandle task_handle,
                             std::uint32_t index,
                             std::uint32_t value,
                             Action action);
    static bool NotifyIndexedFromISR(TaskHandle task_handle,
                                 std::uint32_t index,
                                 std::uint32_t value,
                                 Action action);
    static bool Wait(std::uint32_t bits_to_clear_on_entry,
                     std::uint32_t bits_to_clear_on_exit,
                     std::uint32_t* out_value,
                     std::uint32_t ticks_to_wait);
    static bool WaitIndexed(std::uint32_t index,
                         std::uint32_t bits_to_clear_on_entry,
                         std::uint32_t bits_to_clear_on_exit,
                         std::uint32_t* out_value,
                         std::uint32_t ticks_to_wait);
    static std::uint32_t Take(bool clear_count_on_exit, std::uint32_t ticks_to_wait);
    static std::uint32_t TakeIndexed(std::uint32_t index,
                             bool clear_count_on_exit,
                             std::uint32_t ticks_to_wait);
};
 
} // namespace c7222
 
#endif // ELEC_C7222_UTILS_FREERTOS_TASK_NOTIFICATION_HPP