Heap_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       HEAP_STM32F429.h
//! @brief      STM32F429 heap 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/HEAP_STM32F429.h $
//!             $Revision: 2081 $
//!             $Date: 2020-09-13 15:34:05 +0500 (Вс, 13 сен 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 "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Heap base class
class THeap_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    THeap_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~THeap_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap base address method.
    //! @note      None
    //! @return    U32 - CPU heap base address
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual U32 Get_Bottom_Address();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap end address method.
    //! @note      None
    //! @return    U32 - CPU heap end address
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual U32 Get_Top_Address();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap size method.
    //! @note      None
    //! @return    U32 - CPU heap size in byts
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual U32 Get_Size();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap dont usage space method.
    //! @note      None
    //! @return    U32 - CPU heap dont usage in byts
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U32 Get_Not_Usage_Space();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return CPU heap usage space method.
    //! @note      None
    //! @return    U32 - CPU heap usage space in byts
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual U32 Get_Usage_Space();
 
    //!-------------------------------------------------------------------------
    //! @brief     Stack excution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return warning level stack status method.
    //! @note      None
    //! @return    BOOL - Stack warning flag status
    //! @retval    false - Stack overflow warning flag is low
    //! @retval    true - Stack overflow warning flag is set
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    BOOL Get_Warning_Overflow_Flag();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return trip level stack status method.
    //! @note      None
    //! @return    BOOL - Stack trip flag status
    //! @retval    false - Stack overflow trip flag is low
    //! @retval    true - Stack overflow trip flag is set
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    BOOL Get_Trip_Overflow_Flag();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Stack warning level overflow
    BOOL bool_Warning_Overflow = (BOOL)false;
  
    //! @brief Stack trip level overflow
    BOOL bool_Trip_Overflow = (BOOL)false;
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------