Bootloader base class. More...

#include <Bootloader_Base.h>

Collaboration diagram for TBootloader_Base:

Public Member Functions
	TBootloader_Base ()
	Class constructor method. More...

	~TBootloader_Base ()
	Application destructor method. More...

VOID	Init ()
	Application initialisation method. More...

VOID	Run ()
	Application run method. More...

VOID	Done ()
	Application finalisation method. More...

BOOL	Set_Bootloader_Shutdown_Request ()
	Set bootloader shutdown request method. More...

BOOL	Is_Bootloader_Shutdown_Request ()
	Get bootloader shutdown request method. More...

virtual VOID	Register_Commands ()=0
	User application timer initialisation method. More...

virtual VOID	Register_Parameters ()=0
	User command registration method. More...

VOID	Process_Application_LEDs ()
	User application LEDs processing method. More...

Private Attributes
BOOL	bool_Bootloader_Shutdown = (BOOL)false
	Bootloader shutdown request flag. More...

Detailed Description

Bootloader base class.

With this class, following functions can be done:

Register application commands
Register application parameters

Constructor & Destructor Documentation

◆ TBootloader_Base()

TBootloader_Base::TBootloader_Base ( )

Class constructor method.

Note: The method create application object.

Returns: None

Override: Not allowed

Attention: Don't call this method directly.

◆ ~TBootloader_Base()

TBootloader_Base::~TBootloader_Base ( )

Application destructor method.

Note: The method destroys application object.

Returns: None

Override: Not allowed

Attention: Don't call this method directly.

Member Function Documentation

◆ Done()

VOID TBootloader_Base::Done ( )

Application finalisation method.

Note: The method prepare hardware and system objects for the system shutdown.

Returns: None

Override: Allowed

Attention: Don't call this method directly.

◆ Init()

VOID TBootloader_Base::Init ( )

Application initialisation method.

Note: The method initialise hardware and system objects.

Returns: None

Override: Allowed

Attention: Don't call this method directly.

ANVILEX KM: ???

References TParameter_Manager::Assign_Media(), TParameter_Manager::Assign_Protocol(), TSPI_Memory_Base::Assign_SPI_Master(), TParameter_Manager::Clear_Quasivolatile_Parameter_Values(), TTimer_Base::Configure_Clock(), TTIMER2_STM32F429::Configure_Clock(), TWatchdog_Timer_Base::Configure_Clock(), TCommunication_Data_Link::Connect_Data_Link(), TSystem_Interrupt_Manager::Enable_Interrupt(), TCPU_Base::enum_Power_On, TCPU_Base::enum_Undefined, TCPU_Base::enum_Unknown, TCPU_Base::enum_Watchdog, event_APPLICATION_RESET_SOURCE_POWER_ON, event_APPLICATION_RESET_SOURCE_UNDEFINED, event_APPLICATION_RESET_SOURCE_UNKNOWN, event_APPLICATION_RESET_SOURCE_WATCHDOG, FPGA_BASE, TCPU_STM32F429::Get_HCLK_Frequency(), TCPU_STM32F429::Get_IWDG_Frequency(), TCPU_STM32F429::Get_PCLK2_Frequency(), TCPU_STM32F429::Get_Reset_Source(), TCommand_Manager::Init(), TProtocol_IP_Over_ETHERNET::Init(), TProtocol_PLUG_Over_UART::Init(), TWatchdog_Timer_Base::Init(), TLED_P014_51_CB::Init(), TTarget_P014_51_CB::Init(), TParameter_Manager::Init(), TFM25V02::Init(), TSystem_Interrupt_Manager::Init(), TRTC_STM32F429::Init(), TSPI4_STM32F429::Init(), TSPI5_STM32F429::Init(), TSPI_Master_Base::Init(), TSYSTICK_STM32F429::Interrupt_Enable(), object_Command_Manager, object_Delay_Timer, object_FM25V02, object_Parameter_Manager, object_Protocol_Over_COM0, object_Protocol_Over_ETHERNET, object_System_CPU, object_System_Interrupt_Manager, object_System_LED, object_System_RTC, object_System_SPI1, object_System_SPI2, object_System_SPI3, object_System_Terminal, object_System_Timer, object_System_Watchdog_Timer, object_Target, Register_Commands(), Register_Parameters(), TParameter_Manager::Restore_Nonvolatile_Parameter_Values(), TTarget_P014_51_CB::Send_Boot_Information(), TSYSTICK_STM32F429::Set_Interrupt_Frequency(), TWDT_STM32F429::Set_Period(), TCommand_Manager::Show_Boot_Information(), TParameter_Manager::Show_Boot_Information(), TProtocol_Base::Show_System_Ready_Message_Disable(), TProtocol_Base::Show_System_Ready_Message_Enable(), TProtocol_Base::Show_System_Welcome_Message_Disable(), TProtocol_Base::Show_System_Welcome_Message_Enable(), TFM25V02::Start(), TSYSTICK_STM32F429::Start(), TTIMER2_STM32F429::Start(), TWDT_STM32F429::Start(), TCommand_Manager::Start_Operation(), TParameter_Manager::Start_Operation(), tcp_setup(), TProtocol_Base::Transmit_Boot_Welcome_Message(), TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_System_Ready_Message(), and TParameter_Manager::Verify_Database().

Here is the call graph for this function:

◆ Is_Bootloader_Shutdown_Request()

BOOL TBootloader_Base::Is_Bootloader_Shutdown_Request ( )

Get bootloader shutdown request method.

Note: The method returns bootloader shutdown request status.

Returns: BOOL - Shutdown request status

Return values

false	- Shutdown not requested
true	- Shutdown requested

Override: Not allowed

Attention: None

Referenced by Run().

Here is the caller graph for this function:

◆ Process_Application_LEDs()

VOID TBootloader_Base::Process_Application_LEDs ( )

User application LEDs processing method.

Note: The method implements user application LEDs functionality.

Returns: None

Override: Optional

Attention: This method is depricated. Don't use it for new applications.

Referenced by Run().

Here is the caller graph for this function:

◆ Register_Commands()

virtual VOID TBootloader_Base::Register_Commands ( )

pure virtual

User application timer initialisation method.

Note: The method implements user timer initialiseation.

Returns: None

Override: Optional

Attention: Don't call this method directly.

User command registration method

Note: The method register user defined commands by command manager system.

Returns: None

Override: Requered

Attention: Don't call this method directly

Referenced by Init().

Here is the caller graph for this function:

◆ Register_Parameters()

virtual VOID TBootloader_Base::Register_Parameters ( )

pure virtual

User command registration method.

Note: The method register user parameters commands by parameter manager system.

Returns: None

Override: Requered

Attention: Don't call this method directly.

Referenced by Init().

Here is the caller graph for this function:

◆ Run()

VOID TBootloader_Base::Run ( )

Application run method.

Note: The method runs main system functionality.

Returns: None

Override: Allowed

Attention: Don't call this method directly.

References TSystem_LED_Base::bool_Start_Procesing, TSystem_Interrupt_Manager::Disable_Interrupt(), TParameter_Manager::Execute(), TRTC_STM32F429::Execute_Background(), TSYSTICK_STM32F429::Interrupt_Disable(), Is_Bootloader_Shutdown_Request(), object_Parameter_Manager, object_System_Interrupt_Manager, object_System_LED, object_System_RTC, object_System_Timer, object_System_Watchdog_Timer, Process_Application_LEDs(), TWDT_STM32F429::Reset(), and TWDT_STM32F429::Stop().

Here is the call graph for this function:

◆ Set_Bootloader_Shutdown_Request()

BOOL TBootloader_Base::Set_Bootloader_Shutdown_Request ( )

Set bootloader shutdown request method.

Note: The method set bootloader shutdown request.

Returns: BOOL - Bootloader shutdown request status

Return values

false	- Bootloader shutdown not requested
true	- Bootloader shutdown requested

Override: Not allowed

Attention: None

Member Data Documentation

◆ bool_Bootloader_Shutdown

BOOL TBootloader_Base::bool_Bootloader_Shutdown = (BOOL)false

private

Bootloader shutdown request flag.

The documentation for this class was generated from the following files:

ConOpSys/Engine/Bootloader/Bootloader_Base.h
ConOpSys/Engine/Bootloader/Bootloader_Base.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TBootloader_Base()

◆ ~TBootloader_Base()

Member Function Documentation

◆ Done()

◆ Init()

◆ Is_Bootloader_Shutdown_Request()

◆ Process_Application_LEDs()

◆ Register_Commands()

◆ Register_Parameters()

◆ Run()

◆ Set_Bootloader_Shutdown_Request()

Member Data Documentation

◆ bool_Bootloader_Shutdown