TIMER5_STM32F410CBU6.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       TIMER5_STM32F410CBU6.h
//! @brief      STM32F410CBU6 on-chip TIMER5 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/STM32F410CBU6/TIMER2_STM32F410CBU6.h $
//!             $Revision: 2279 $
//!             $Date: 2020-12-12 15:14:34 +0500 (Sa, 12 Dez 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include project files
//------------------------------------------------------------------------------
 
#include "High_Precision_Timer_Base.h"
 
//------------------------------------------------------------------------------
// Class drfinitions
//------------------------------------------------------------------------------
 
//! @brief System timer class
//! @details High resolution timer is used for implementing of the diverse delays and time intervals.
class TTIMER5_STM32F410CBU6 : public THigh_Precision_Timer_Base
{
 
  //----------------------------------------------------------------------------
  // Public methods, variables and definitions
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Set 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     Enable interrupt method.
    //! @note      None
    //! @param     [in] u32_Interrupt_Priority - Timer inperrupt priority
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Interrupt_Enable( U32 u32_Interrupt_Priority );
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable interrupt method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Interrupt_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Start timer operation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Start();  
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop timer operation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Stop();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get actual time in counts method
    //! @note      None
    //! @return    U32 - Actual time in counts.
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U32 Get_Actual_Time();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get actual time in counts method
    //! @note      None
    //! @return    U64 - Actual time in counts.
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U64 Get_Actual_Time_U64();
 
  //----------------------------------------------------------------------------
  // Protected methods, variables and definitions
  //----------------------------------------------------------------------------
    
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods, variables and definitions
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------