CPU_STM32F410CBU6.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       CPU_STM32F410CBU6.h
//! @brief      STM32F410CBU6 CPU 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/CPU_STM32F410CBU6.h $
//!             $Revision: 2269 $
//!             $Date: 2020-12-06 19:46:20 +0500 (So, 06 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 standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "CPU_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
#include "Application_Task_Base.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief STM32F410CBU6 CPU hardware class
class TCPU_STM32F410CBU6: public TCPU_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     STM32F410CBU6 CPU class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TCPU_STM32F410CBU6();
    
    //!-------------------------------------------------------------------------
    //! @brief     STM32F410CBU6 CPU class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TCPU_STM32F410CBU6();
    
    //!-------------------------------------------------------------------------
    //! @brief     CPU object initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     CPU object finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Done();
        
    //!-------------------------------------------------------------------------
    //! @brief     Return reset source of CPU method.
    //! @note      None
    //! @return    TReset_Source - Type og the CPU reset
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    TReset_Source Get_Reset_Source();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU reset source register method.
    //! @note      None
    //! @return    U32 - Reset source register
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Reset_Source();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU device ID method.
    //! @note      None
    //! @return    U32 - CPU device ID
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Device_ID();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU revision ID method.
    //! @note      None
    //! @return    U32 - CPU revision ID
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Revision();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return unique CPU ID method.
    //! @note      None
    //! @return    U32 - Unique CPU ID
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Unique_Device_ID( U32 u32_Index );
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU FLASH memory size method.
    //! @note      None
    //! @return    U32 - CPU FLASH memory size in bytes
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Flash_Size();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU RAM size method.
    //! @note      None
    //! @return    U32 - CPU RAM size in bytes
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_RAM_Size();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return executable image base address method.
    //! @note      None
    //! @return    U32 - Executable image base address
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Image_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return executable image end address method.
    //! @note      None
    //! @return    U32 - Executable image end address
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Image_End();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return executable image size method.
    //! @note      None
    //! @return    U32 - Executable image size in byts
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Image_Size();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return executable image hash method.
    //! @note      None
    //! @return    U32 - Executable image hash in byts
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Image_Hash();
 
    //!-------------------------------------------------------------------------
    //! @brief     Calculate executable image hash method.
    //! @note      None
    //! @return    U32 - Executable image hash value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Calculate_Image_Hash();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU stack base address method.
    //! @note      None
    //! @return    U32 - CPU stack base address
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Stack_Base();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU stack size method.
    //! @note      None
    //! @return    U32 - CPU stack size in byts
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Stack_Size();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap base address method.
    //! @note      None
    //! @return    U32 - CPU heap base address
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_CPU_Heap_Base();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap size method.
    //! @note      None
    //! @return    U32 - CPU heap size in bytes
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_CPU_Heap_Size();
 
    //!-------------------------------------------------------------------------
    //! @brief     Update core clock value method.
    //! @note      None
    //! @return    U32 - CPU heap size
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID System_Core_Clock_Update();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return SYSCLK frequency method.
    //! @note      None
    //! @return    U32 - SYSCLK frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_SYSCLK_Frequency();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return HCLK frequency method.
    //! @note      Each time HCLK changes, this function must be called to update the
    //             right HCLK value. Otherwise, any configuration based on this function will be incorrect.
    //! @return    U32 - HCLK frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_HCLK_Frequency();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return PCLK1 frequency method.
    //! @note      Each time PCLK1 changes, this function must be called to update the
    //!            right PCLK1 value. Otherwise, any configuration based on this function will be incorrect.
    //! @return    U32 - PCLK1 frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_PCLK1_Frequency();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return PCLK2 frequency method.
    //! @note      Each time PCLK2 changes, this function must be called to update the
    //!            right PCLK2 value. Otherwise, any configuration based on this function will be incorrect.
    //! @return    U32 - PCLK2 frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
        
    U32 Get_PCLK2_Frequency();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return TCLK1 frequency method.
    //! @note      Each time PCLK1 changes, this function must be called to update the
    //!            right TCLK1 value. Otherwise, any configuration based on this function will be incorrect.
    //! @return    U32 - TCLK1 frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_TCLK1_Frequency();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return TCLK2 frequency method.
    //! @note      None
    //! @return    U32 - TCLK2 frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_TCLK2_Frequency();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return IWDG frequency method.
    //! @note      Each time PCLK2 changes, this function must be called to update the
    //!            right TCLK2 value. Otherwise, any configuration based on this function will be incorrect.
    //! @return    U32 - IWDG frequency
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_IWDG_Frequency();
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
    
  protected:
  
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
    
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief System CPU core clock frequency in Hz
    U32 u32_SYSCLK;
    
    //! @brief System HCLK bus clock frequency in Hz
    U32 u32_HCLK;
    
    //! @brief System PCLK1 bus clock frequency in Hz
    U32 u32_PCLK1;
    
    //! @brief System PCLK2 bus clock frequency in Hz
    U32 u32_PCLK2;
    
    //! @brief System TCLK1 bus clock frequency in Hz
    U32 u32_TCLK1;
    
    //! @brief System TCLK2 bus clock frequency in Hz
    U32 u32_TCLK2;
    
    //! @brief System IWDG bus clock frequency in Hz
    U32 u32_IWDG;
  
    //! @brief Application executable image hash value
    U32 u32_Application_Image_Hash;
 
};
 
//------------------------------------------------------------------------------
// End of file 
//------------------------------------------------------------------------------