Timer_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Timer_Base.h
//! @brief      Timer base class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Timer_Base.h $
//!             $Revision: 2760 $
//!             $Date: 2021-07-03 05:48:40 +0500 (Sa, 03 Jul 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief User timer base class
class TTimer_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     User timer class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TTimer_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     User timer class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TTimer_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     User timer interrupt method.
    //! @note      This method should be called from hardware interrupt service routine.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set user timer input clock frequency method.
    //! @note      None
    //! @param     [in] u32_Clock - Timer input clock in herz
    //! @return    BOOL - Execution status
    //! @retval    false - Execution without errors
    //! @retval    true - Execution without any errors
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Configure_Clock( U32 u32_Clock );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set user timer interrupt frequency method.
    //! @note      None
    //! @param     [in] f32_Frequency - Timer inperrupt frequency in herz
    //! @return    BOOL - Execution status
    //! @retval    false - Execution without errors
    //! @retval    true - Execution without any errors
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Set_Interrupt_Frequency( F32 f32_Frequency );
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable interrupt method.
    //! @note      None
    //! @param     [in] u32_Interrupt_Priority - Timer inperrupt priority
    //! @return    None
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Interrupt_Enable( U32 u32_Interrupt_Priority ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable interrupt method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Interrupt_Disable() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Start timer operation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start() = 0;  
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop timer operation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Stop() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Get timer resolution in seconds.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Resolution_s();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get timer resolution in miliseconds.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Resolution_ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get timer resolution in microseconds.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Resolution_us();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get timer resolution in nanoseconds.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Resolution_ns();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get Get interrupt frequency in herz.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Interrupt_Frequency();  
 
    //!-------------------------------------------------------------------------
    //! @brief     Get interrupt period in seconds.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Interrupt_Period();     
 
    //!-------------------------------------------------------------------------
    //! @brief     Convert time to interrupt loops method.
    //! @note      None
    //! @param     [in] f32_Time_Span - Time span value in seconds for convertion to interrupt loops.
    //! @return    U32 - Interrupt loop count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Time_To_Execution_Loops( F32 f32_Time_Span );
 
    //!-------------------------------------------------------------------------
    //! @brief     User timer initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     User timer finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
 
    //! @brief Initialisation error
    BOOL bool_Initialisation_Error = (BOOL)false;
 
    //! @brief Timer input frequency in Hz
    F32 f32_Input_Clock = (F32)0.0f;  
 
    //! @brief Timer clock in herz
    U32 u32_Timer_Clock = (U32)0;
  
    //! @brief Timer counter preset value
    U32 u32_Timer_Counts = (U32)0; 
  
    //! @brief Timer resolution in seconds
    F32 f32_Resolution_s = (F32)0.0f;
 
    //! @brief Timer resolution in miliseconds
    F32 f32_Resolution_ms = (F32)0.0f;
 
    //! @brief Timer resolution in microseconds
    F32 f32_Resolution_us = (F32)0.0f;
 
    //! @brief Timer resolution in nanoseconds
    F32 f32_Resolution_ns = (F32)0.0f;
 
    //! @brief Interrupt frequency in herz
    F32 f32_Interrupt_Frequency = (F32)0.0f;
  
    //! @brief Interrupt period in seconds
    F32 f32_Interrupt_Period = (F32)0.0f;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------