System_Timer_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       System_Timer_Base.h
//! @brief      System 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/System_Timer_Base.h $
//!             $Revision: 2871 $
//!             $Date: 2021-09-17 14:54:52 +0500 (Fr, 17 Sep 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// 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 "Timer_Base.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief System timer base class
class TSystem_Timer_Base : public TTimer_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
  
    //!-------------------------------------------------------------------------
    //! @brief     System timer class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
//    TSystem_Timer_Base();
    
    //!-------------------------------------------------------------------------
    //! @brief     System timer class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
//    virtual ~TSystem_Timer_Base();
    
    //!-------------------------------------------------------------------------
    //! @brief     Provides a system timer tick value in timer ticks as U32
    //! @note      None
    //! @return    U32 - Actual timer tick value
    //! \par       Override
    //!            Not allowed
    //! @attention This method requered only for compatibility.
    //--------------------------------------------------------------------------
 
    U32 Get_Tick();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get actual system time in timer ticks.
    //! @note      Replacement for function Get_System_Time()
    //! @param     None
    //! @return    U32 - Actual time in timer ticks.
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U32 Get_Actual_Time();
 
    //!-------------------------------------------------------------------------
    //! @brief     System timer interrupt method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Perform blocked delay given in ms.
    //! @note      None
    //! @param     [in] u32_Delay_Value - Blocked delay time in milliseconds.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't use this function within 1 ms task.
    //--------------------------------------------------------------------------
 
    VOID Delay_ms( U32 u32_Delay_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get delta time in seconds.
    //! @note      None
    //! @param     [in] u32_Start_Timestamp - Timer start timestamp.
    //! @param     [in] u32_End_Timestamp - Timer end timestamp.
    //! @return    F32 - Time span in seconds.
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Delta_Time( U32 u32_Start_Timestamp, U32 u32_End_Timestamp );
 
    //!-------------------------------------------------------------------------
    //! @brief     Return statis of the timeout.
    //! @note      None
    //! @param     [in] u32_Start_Timestamp - Timer start timestamp.
    //! @param     [in] u32_Timeout - Timeout value in millisecconds.
    //! @return    BOOL - Timeout status
    //! @retval    false - Timeout elapsed
    //! @retval    true - Timeout in profress
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Timeout_ms( U32 u32_Start_Timestamp, U32 u32_Timeout );
 
    //!-------------------------------------------------------------------------
    //! @brief     Return timespan in milliseconds.
    //! @note      None
    //! @param     [in] u32_Start_Timestamp - Timer start timestamp.
    //! @return    U32 - Actual timespan in milliseconds
    //! @retval    false - Timeout elapsed
    //! @retval    true - Timeout in profress
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Timespan_ms( U32 u32_Start_Timestamp );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
 
    //! @brief Timer tick counter
    volatile U32 u32_Tick_Counter = (U32)0;                
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------