Watchdog_Timer_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Watchdog_Timer_Base.h
//! @brief      Watchdog 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/Watchdog_Timer_Base.h $
//!             $Revision: 2076 $
//!             $Date: 2020-09-12 20:30:44 +0500 (Sa, 12 Sep 2020) $
//!             $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 System watchdog timer base class
class TWatchdog_Timer_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TWatchdog_Timer_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TWatchdog_Timer_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method description.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Finalisation method description.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Watchdog input clock frequency configuration method.
    //! @note      This methods configured input clock frequency of the watchdog timer.
    //! @param     [in] u32_Clock_Frequency - Input clock frequency in Hz
    //! @return    BOOL - Status
    //! @retval    false - Configuration failed
    //! @retval    true - Configuration successed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Configure_Clock( U32 u32_Clock_Frequency );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get watchdog timer counter resolution method.
    //! @note      This methods returns watchdog timer counter resolution in seconds.
    //! @return    F32 - Watchdog timer counter resolution in seconds
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Resolution();      //!< Get timer counter resolution in seconds
 
    //!-------------------------------------------------------------------------
    //! @brief     Set watchdog timer period method.
    //! @note      This methods sets watchdog timer period in seconds.
    //! @param     [in] f32_Period - Watchdog timer period in seconds
    //! @return    BOOL - Operation status
    //! @retval    false - Operation failed
    //! @retval    true - Operation successed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Set_Period( F32 f32_Period );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get watchdog timer period method.
    //! @note      This methods returns watchdog timer period in seconds.
    //! @return    F32 - Watchdog timer period in seconds
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Period();
 
    //!-------------------------------------------------------------------------
    //! @brief     Start watchdog timer counter operation
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop watchdog timer counter operation
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Stop() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Reset watchdog timer counter
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Reset() = 0;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //! @brief Watchdog timer input frequency in Hz
    F32 f32_Input_Clock_Frequency;
 
    //! @brief Watchdog timer resolution in seconds
    F32 f32_Resolution;
 
    //! @brief Counts for watchdog timer register initialisation
    U32 u32_Timer_Counts;
 
    //! @brief Frequency in Hz
    F32 f32_Frequency;
 
    //! @brief Period in seconds
    F32 f32_Period;
 
    //! @brief Timer configured flag
    BOOL bool_Timer_Configured;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------