RTC_STM32F429.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       RTC_STM32F429.h
//! @brief      STM32F429 on-chip RTC 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/RTC_STM32F429.h $
//!             $Revision: 2944 $
//!             $Date: 2022-02-26 10:45:42 +0500 (Sa, 26 Feb 2022) $
//!             $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 "System_Date.h"
#include "Protocol_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F429 RTC class
class TRTC_STM32F429
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TRTC_STM32F429();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TRTC_STM32F429();
 
    //!-------------------------------------------------------------------------
    //! @brief     RTC initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     RTC finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     RTC 1ms cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Execute_1ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     RTC background cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Execute_Background();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set date time method.
    //! @note      None
    //! @param     [in] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_DateTime( TDate_Time::TDate_Time_Structure *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get date time method.
    //! @note      None
    //! @param     [out] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Get_DateTime( TDate_Time::TDate_Time_Structure *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set Hardware RTC method.
    //! @note      None
    //! @param     [in] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Hardware_RTC( TDate_Time::TDate_Time_Structure *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get Hardware RTC method.
    //! @note      None
    //! @param     [out] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Hardware_RTC( TDate_Time::TDate_Time_Structure *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get Hardware RTC method.
    //! @note      None
    //! @param     [out] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Hardware_RTC( TDate_Time *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set Software RTC method.
    //! @note      None
    //! @param     [in] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Software_RTC( TDate_Time::TDate_Time_Structure *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get Software RTC method.
    //! @note      None
    //! @param     [out] object_DateTime - object date struct
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Get_Software_RTC( TDate_Time::TDate_Time_Structure *object_DateTime );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get last system shootdown duration time in miliseconds method.
    //! @note      None
    //! @return    U64 - Last system shootdown duration time in miliseconds 
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 Get_Last_System_Shootdown_Duration_in_ms();
    
    //!-------------------------------------------------------------------------
    //! @brief     Get last system shootdown duration time in seconds method.
    //! @note      None
    //! @return    U64 - Last system shootdown duration time in seconds 
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 Get_Last_System_Shootdown_Duration_in_s();
    
    //!-------------------------------------------------------------------------
    //! @brief     Get actual system runtime duration time in miliseconds method.
    //! @note      None
    //! @return    U64 - Actual system runtime duration time in miliseconds
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U64 Get_Actual_System_Runtime_Duration_in_ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method for calculating the amount of time elapsed since the beginning of time (01.01.0001)
    //! @note      None
    //! @return    U64 - Elapsed time since the beginning of time in miliseconds
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 RND( TDate_Time::TDate_Time_Structure *object_DateTime );
    
    //!-------------------------------------------------------------------------
    //! @brief     Method for calculating the amount of time elapsed since the beginning of time (01.01.0001)
    //! @note      None
    //! @return    U64 - Elapsed time since the beginning of time in miliseconds
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U64 RND( U32 y, U32 m, U32 d );
 
    //!-------------------------------------------------------------------------
    //! @brief     Synchronise virtual RTC method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Sync_Virtual_RTC();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about RTC hardware driver over communication link protocol
    //! @note      This method sends information about RTC hardware driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Send_Information( TProtocol_Base *object_Protocol );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment hardware RTC read data ready error counter method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_RTC_Data_Read_Ready_Error_Counter();
 
    //!-------------------------------------------------------------------------
    //! @brief     Take runtime date ant time snapshoot method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Take_Runtime_Snapshoot();
 
    //!-------------------------------------------------------------------------
    //! @brief     Recall last runtime date and time snapshoot method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Recall_Runtime_Snapshoot();
 
    //!-------------------------------------------------------------------------
    //! @brief     Take system startup date and time snapshoot method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Take_Startup_Snapshoot();
 
    //!-------------------------------------------------------------------------
    //! @brief     Debug method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 RND();
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Virtual software RTC
    TDate_Time object_Software_RTC_DateTime;
 
    //! @brief System startup data and time snapshoot
    U64 u64_Startup_Snapshoot;
 
    //! @brief Last runtime data and time snapshoot
    U64 u64_Last_Runtime_Snapshoot;
 
    //! @brief Actual runtime data and time snapshoot
    U64 u64_Actual_Runtime_Snapshoot;
 
    //! @brief Virtual RTC synchronisation request
    BOOL bool_Vitrual_RTC_Sync_Request;
 
    //! @brief Software RTC update locked
    BOOL bool_Software_RTC_Update_Locked;
 
    //! @brief RTC initialisation error flag
    BOOL bool_Initialisation_Error;
 
    //! @brief Hardware RTC data lost error flag
    BOOL bool_Hardware_RTC_Data_Lost_Error;
 
    //! @brief RTC data read ready error counter
    U32 u32_RTC_Data_Read_Ready_Error_Counter;
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------