os-timer.cpp

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2016-2025 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit.
 */
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#include <cmsis-plus/rtos/os.h>
 
// ----------------------------------------------------------------------------
 
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace rtos
  {
    // ------------------------------------------------------------------------
 
    const timer::attributes timer::once_initializer;
 
    const timer::attributes_periodic timer::periodic_initializer;
 
    // ------------------------------------------------------------------------
 
    // ========================================================================
    timer::timer (func_t function, func_args_t args, const attributes& attr)
        : timer{ nullptr, function, args, attr }
    {
    }
 
    timer::timer (const char* name, func_t function, func_args_t args,
                  const attributes& attr)
        : object_named_system{ name }
    {
#if defined(OS_TRACE_RTOS_TIMER)
      trace::printf ("%s() @%p %s\n", __func__, this, this->name ());
#endif
 
      // Don't call this from interrupt handlers.
      os_assert_throw (!interrupts::in_handler_mode (), EPERM);
      // Don't call this from critical regions.
      os_assert_throw (function != nullptr, EINVAL);
 
      type_ = attr.tm_type;
      func_ = function;
      func_args_ = args;
 
#if !defined(OS_USE_RTOS_PORT_TIMER)
      clock_ = attr.clock != nullptr ? attr.clock : &sysclock;
#endif
 
#if defined(OS_USE_RTOS_PORT_TIMER)
 
      port::timer::create (this, function, args);
 
#else
 
      period_ = 0;
 
#endif
      state_ = state::initialized;
    }
 
    timer::~timer ()
    {
#if defined(OS_TRACE_RTOS_TIMER)
      trace::printf ("%s() @%p %s\n", __func__, this, name ());
#endif
 
#if defined(OS_USE_RTOS_PORT_TIMER)
 
      port::timer::destroy (this);
 
#else
 
      {
        // ----- Enter critical section ---------------------------------------
        interrupts::critical_section ics;
 
        if (state_ == state::running)
          {
            timer_node_.unlink ();
          }
        // ----- Exit critical section ----------------------------------------
      }
 
#endif
      state_ = state::destroyed;
    }
 
    result_t
    timer::start (clock::duration_t period)
    {
#if defined(OS_TRACE_RTOS_TIMER)
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wuseless-cast"
#endif
      trace::printf ("%s(%u) @%p %s\n", __func__,
                     static_cast<unsigned int> (period), this, name ());
#pragma GCC diagnostic pop
#endif
 
      // Don't call this from interrupt handlers.
      os_assert_err (!interrupts::in_handler_mode (), EPERM);
 
      if (period == 0)
        {
          period = 1;
        }
 
      result_t res;
 
#if defined(OS_USE_RTOS_PORT_TIMER)
 
      res = port::timer::start (this, period);
 
#else
 
      period_ = period;
 
      timer_node_.timestamp = clock_->steady_now () + period;
 
      {
        // ----- Enter critical section ---------------------------------------
        interrupts::critical_section ics;
 
        // If started, stop.
        timer_node_.unlink ();
 
        clock_->steady_list ().link (timer_node_);
        // ----- Exit critical section ----------------------------------------
      }
      res = result::ok;
 
#endif
 
      if (res == result::ok)
        {
          state_ = state::running;
        }
      return res;
    }
 
    result_t
    timer::stop (void)
    {
#if defined(OS_TRACE_RTOS_TIMER)
      trace::printf ("%s() @%p %s\n", __func__, this, name ());
#endif
 
      // Don't call this from interrupt handlers.
      os_assert_err (!interrupts::in_handler_mode (), EPERM);
 
      if (state_ != state::running)
        {
          return EAGAIN;
        }
 
      result_t res;
 
#if defined(OS_USE_RTOS_PORT_TIMER)
 
      res = port::timer::stop (this);
 
#else
 
      {
        // ----- Enter critical section ---------------------------------------
        interrupts::critical_section ics;
 
        timer_node_.unlink ();
        // ----- Exit critical section ----------------------------------------
      }
      res = result::ok;
 
#endif
 
      state_ = state::stopped;
      return res;
    }
 
#if !defined(OS_USE_RTOS_PORT_TIMER)
 
    void
    timer::internal_interrupt_service_routine (void)
    {
 
      if (type_ == run::periodic)
        {
          // Re-arm the timer for the next period.
          timer_node_.timestamp += period_;
 
          // No need for critical section in ISR.
          clock_->steady_list ().link (timer_node_);
        }
      else
        {
          state_ = state::completed;
        }
 
#if defined(OS_USE_RTOS_PORT_TIMER)
      trace::puts (name ());
#endif
 
      // Call the user function.
      func_ (func_args_);
    }
 
#endif
 
    // ------------------------------------------------------------------------
 
  } /* namespace rtos */
} /* namespace os */
 
// ----------------------------------------------------------------------------