poll_event.hpp

Go to the documentation of this file.

//
// Copyright (c) 2019 Erwin Rol <erwin@erwinrol.com>
//
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef ZPP_INCLUDE_ZPP_POLL_EVENT_HPP
#define ZPP_INCLUDE_ZPP_POLL_EVENT_HPP
 
#ifdef CONFIG_POLL
 
#include <zephyr/kernel.h>
#include <zephyr/sys/__assert.h>
 
#include <chrono>
#include <limits>
#include <optional>
#include <array>
 
#include <zpp/sem.hpp>
#include <zpp/fifo.hpp>
#include <zpp/poll_signal.hpp>
 
namespace zpp {
 
class poll_event {
public:
  enum class type_tag : uint8_t {
    type_unknown,
    type_sem,
    type_fifo,
    type_signal,
    type_ignore,
  };
 
  poll_event(k_poll_event* event) noexcept
    : m_event(event)
  {
    __ASSERT_NO_MSG(m_event != nullptr);
  }
 
  void assign(std::nullptr_t) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
 
    m_event->obj = nullptr;
    m_event->state = K_POLL_STATE_NOT_READY;
    m_event->mode = K_POLL_MODE_NOTIFY_ONLY;
    m_event->type = K_POLL_TYPE_IGNORE;
    m_event->tag = (int)type_tag::type_ignore;
  }
 
  void assign(sem& s) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SEM_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_sem;
  }
 
  void assign(sem_ref& s) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SEM_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_sem;
  }
 
  template<typename T_FifoItem>
  void assign(fifo<T_FifoItem>& f) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_FIFO_DATA_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      f.native_handle());
    m_event->tag = (int)type_tag::type_fifo;
  }
 
  template<typename T_FifoItem>
  void assign(fifo_ref<T_FifoItem>& f) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_FIFO_DATA_AVAILABLE,
      K_POLL_MODE_NOTIFY_ONLY,
      f.native_handle());
    m_event->tag = (int)type_tag::type_fifo;
  }
 
  void assign(poll_signal& s) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SIGNAL,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_signal;
  }
 
  void assign(poll_signal_ref& s) noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    k_poll_event_init(m_event,
      K_POLL_TYPE_SIGNAL,
      K_POLL_MODE_NOTIFY_ONLY,
      s.native_handle());
    m_event->tag = (int)type_tag::type_signal;
  }
 
 
  bool is_ready() noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag != (int)type_tag::type_unknown);
 
    switch((type_tag)m_event->tag) {
    case type_tag::type_unknown:
      return false;
    case type_tag::type_sem:
      return (m_event->state & K_POLL_STATE_SEM_AVAILABLE);
    case type_tag::type_fifo:
      return (m_event->state & K_POLL_STATE_FIFO_DATA_AVAILABLE);
    case type_tag::type_signal:
      return (m_event->state & K_POLL_STATE_SIGNALED);
    case type_tag::type_ignore:
      return false;
    }
 
    return false;
  }
 
  void reset() noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
 
    m_event->state = K_POLL_STATE_NOT_READY;
  }
 
  bool is_cancelled() noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag != (int)type_tag::type_unknown);
 
    if (m_event->state & K_POLL_STATE_CANCELLED) {
      return true;
    } else {
      return false;
    }
  }
 
  template<typename T_FifoItemType>
  auto fifo() noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag == (int)type_tag::type_fifo);
    __ASSERT_NO_MSG(m_event->fifo != nullptr);
 
    return fifo_ref<T_FifoItemType>(m_event->fifo);
  }
 
  auto sem() noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag == (int)type_tag::type_sem);
    __ASSERT_NO_MSG(m_event->sem != nullptr);
 
    return sem_ref(m_event->sem);
  }
 
  auto signal() noexcept
  {
    __ASSERT_NO_MSG(m_event != nullptr);
    __ASSERT_NO_MSG(m_event->tag == (int)type_tag::type_signal);
    __ASSERT_NO_MSG(m_event->signal != nullptr);
 
    return poll_signal_ref(m_event->signal);
  }
private:
  k_poll_event* m_event{ nullptr };
public:
  poll_event(const poll_event&) = delete;
  poll_event(poll_event&&) = delete;
  poll_event& operator=(const poll_event&) = delete;
  poll_event& operator=(poll_event&&) = delete;
};
 
} // namespace zpp
 
#endif // CONFIG_POLL
 
#endif // ZPP_INCLUDE_ZPP_POLL_EVENT_HPP