Bootloader_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Bootloader_Base.h
//! @brief      Bootloader base 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/Engine/Application/Application_Base.h $
//!             $Revision: 2765 $
//!             $Date: 2021-07-04 04:32:25 +0500 (So, 04 Jul 2021) $
//!             $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
 
//------------------------------------------------------------------------------
// System includes
//------------------------------------------------------------------------------
 
#include "System_Resource.h"
 
//!-----------------------------------------------------------------------------
//! @brief Bootloader base class
//!
//! With this class, following functions can be done:
//! - Register application commands
//! - Register application parameters
//------------------------------------------------------------------------------
 
class TBootloader_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      The method create application object.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TBootloader_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application destructor method
    //! @note      The method destroys application object.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TBootloader_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application initialisation method
    //! @note      The method initialise hardware and system objects.
    //! @return    None
    //! \par       Override
    //!            Allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application run method
    //! @note      The method runs main system functionality.
    //! @return    None
    //! \par       Override
    //!            Allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Run();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application finalisation method
    //! @note      The method prepare hardware and system objects for the system shutdown.
    //! @return    None
    //! \par       Override
    //!            Allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set bootloader shutdown request method
    //! @note      The method set bootloader shutdown request.
    //! @return    BOOL - Bootloader shutdown request status
    //! @retval    false - Bootloader shutdown not requested
    //! @retval    true - Bootloader shutdown requested
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Set_Bootloader_Shutdown_Request();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get bootloader shutdown request method
    //! @note      The method returns bootloader shutdown request status.
    //! @return    BOOL - Shutdown request status
    //! @retval    false - Shutdown not requested
    //! @retval    true - Shutdown requested
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Bootloader_Shutdown_Request();
 
    //!-------------------------------------------------------------------------
    //! @brief     User application timer initialisation method
    //! @note      The method implements user timer initialiseation.
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     User command registration method
    //! @note      The method register user defined commands by command manager system.
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention Don't call this method directly
    //--------------------------------------------------------------------------
 
    virtual VOID Register_Commands() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     User command registration method
    //! @note      The method register user parameters commands by parameter manager system.
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Register_Parameters() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     User application LEDs processing method
    //! @note      The method implements user application LEDs functionality.
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention This method is depricated. Don't use it for new applications.
    //--------------------------------------------------------------------------
 
    VOID Process_Application_LEDs();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
      
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Bootloader shutdown request flag
    BOOL bool_Bootloader_Shutdown = (BOOL)false;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------