os-timer.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016 Liviu Ionescu.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef CMSIS_PLUS_RTOS_OS_TIMER_H_
#define CMSIS_PLUS_RTOS_OS_TIMER_H_

// ----------------------------------------------------------------------------

#if defined(__cplusplus)

#include <cmsis-plus/rtos/os-decls.h>

// ----------------------------------------------------------------------------

namespace os
{
  namespace rtos
  {
    // ========================================================================

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"

    class timer : public internal::object_named_system
    {
    public:

      using func_args_t = void*;

      using func_t = void (*) (func_args_t args);

      using type_t = uint8_t;

      struct run
      {
        enum
          : type_t
            {
              once = 0,

              periodic = 1      //
        };
      };

      using state_t = uint8_t;

      struct state
      {
        enum
          : state_t
            {
              undefined = 0,
          initialized = 1,
          running = 2,
          completed = 3,
          stopped = 4,
          destroyed = 5
        };
      };

      // ======================================================================

      class attributes : public internal::attributes_clocked
      {
      public:

        constexpr
        attributes ();

      protected:

        constexpr
        attributes (type_t type);

      public:

        // The rule of five.
        attributes (const attributes&) = default;
        attributes (attributes&&) = default;
        attributes&
        operator= (const attributes&) = default;
        attributes&
        operator= (attributes&&) = default;

        ~attributes () = default;

      public:

        // Public members; no accessors and mutators required.
        // Warning: must match the type & order of the C file header.
        type_t tm_type = run::once;

        // Add more attributes.

      }; /* class attributes */

      static const attributes once_initializer;

      class attributes_periodic : public attributes
      {
      public:

        constexpr
        attributes_periodic ();

        // The rule of five.
        attributes_periodic (const attributes_periodic&) = default;
        attributes_periodic (attributes_periodic&&) = default;
        attributes_periodic&
        operator= (const attributes_periodic&) = default;
        attributes_periodic&
        operator= (attributes_periodic&&) = default;

        ~attributes_periodic () = default;

      }; /* class attributes_periodic */

      static const attributes_periodic periodic_initializer;

      timer (func_t function, func_args_t args, const attributes& attr =
                 once_initializer);

      timer (const char* name, func_t function, func_args_t args,
             const attributes& attr = once_initializer);

      timer (const timer&) = delete;
      timer (timer&&) = delete;
      timer&
      operator= (const timer&) = delete;
      timer&
      operator= (timer&&) = delete;

      ~timer ();

      bool
      operator== (const timer& rhs) const;

    public:

      result_t
      start (clock::duration_t period);

      result_t
      stop (void);

    protected:

      friend class internal::timer_node;

    protected:

#if !defined(OS_USE_RTOS_PORT_TIMER)

      void
      internal_interrupt_service_routine (void);

#endif

    protected:

      func_t func_;
      func_args_t func_args_;

#if !defined(OS_USE_RTOS_PORT_TIMER)
      clock* clock_ = nullptr;
      internal::timer_node timer_node_
        { 0, *this };
      clock::duration_t period_ = 0;
#endif

#if defined(OS_USE_RTOS_PORT_TIMER)
      friend class port::timer;
      os_timer_port_data_t port_;
#endif

      type_t type_ = run::once;
      state_t state_ = state::undefined;

      // Add more internal data.

    };

#pragma GCC diagnostic pop

  } /* namespace rtos */
} /* namespace os */

// ===== Inline & template implementations ====================================

namespace os
{
  namespace rtos
  {
    // ========================================================================

    constexpr
    timer::attributes::attributes ()
    {
      ;
    }

    constexpr
    timer::attributes::attributes (type_t type) :
        tm_type (type)
    {
      ;
    }

    // ========================================================================
    constexpr
    timer::attributes_periodic::attributes_periodic () :
        attributes
          { run::periodic }
    {
      ;
    }

    inline bool
    timer::operator== (const timer& rhs) const
    {
      return this == &rhs;
    }

  } /* namespace rtos */
} /* namespace os */

// ----------------------------------------------------------------------------

#endif /* __cplusplus */

#endif /* CMSIS_PLUS_RTOS_OS_TIMER_H_ */