WDT_STM32F429.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       WDT_STM32F429.h
//! @brief      STM32F429 on-chip WTD module 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/Targets/STM32F429/WDT_STM32F429.h $
//!             $Revision: 2831 $
//!             $Date: 2021-08-01 02:23:07 +0500 (So, 01 Aug 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 "Watchdog_Timer_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F429 on-chip WDT module class.
class TWDT_STM32F429: public TWatchdog_Timer_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Set period of watchdog timer method.
    //! @note      None
    //! @param     [in] f32_New_Period - WDT period in seconds.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    BOOL Set_Period( F32 f32_New_Period );
 
    //!-------------------------------------------------------------------------
    //! @brief     Start watchdog timer operation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start();
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop watchdog timer operation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Stop();
 
    //!-------------------------------------------------------------------------
    //! @brief     Reset watchdog timer counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Reset();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return maximum time for WDT reset method.
    //! @note      None
    //! @return    U64 - Maximum time for WDT reset
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U64 Get_Max_WDT_Reset_Time();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @bref previous time stamp for reset time
    U64 u64_Previous_Time_Stamp = (U64)0;
   
    //! @bref Maximum time for WDT reset
    U64 u64_Max_WDT_Reset_Time = (U64)0;
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------