Event_Manager.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Event_Manager.h
//! @brief      Event manager 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/Event_Manager.h $
//!             $Revision: 2795 $
//!             $Date: 2021-07-11 22:03:14 +0500 (So, 11 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 "Application_Resource_Configuration.h"
#include "System_Date.h"
#include "Protocol_Base.h"
#include "SPI_Memory_Base.h"
#include "Event_Database.h"
#include "S25FL512.h"
#include "Event_Manager_Base.h"
 
//------------------------------------------------------------------------------
// Event manager buffer defines
//------------------------------------------------------------------------------
 
// ANVILEX KM: Moved to event manager base
//#define RECORD_SIZE                 64
//#define EVENT_MANAGER_BUFFER_SIZE   32
//#define EVENT_MANAGER_BUFFERS_COUNT 2
//#define GLOBAL_INDEX_BYTES_NUMBER   8
 
//-------------------------------------------------------------------------------
// Class definitions
//-------------------------------------------------------------------------------
 
//! @brief Event manager class
class TEvent_Manager/*: public TEvent_Manager_Base*/
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
/*    
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TEvent_Manager();
*/
/*
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TEvent_Manager();
*/
    //!-------------------------------------------------------------------------
    //! @brief     Event manager initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Event manager finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Event manager background execution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Memory type assignment method.
    //! @note      Assign SPI memory
    //! @param     [in] *object_Memory_Pointer - Pointer to object of memory class
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
//    BOOL Assign_Memory( TSPI_Memory_Base *object_Memory_Pointer );
    BOOL Assign_Memory( TS25FL512 *object_Memory_Pointer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Verify database method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Verify_Database();
 
    //!-------------------------------------------------------------------------
    //! @brief     Erasing flash memory.
    //! @note      Erase only good blocks
    //! @return    BOOL - Erasing status
    //! @retval    false - Erasing failed
    //! @retval    true - Erasing successfully done
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Format_Event_Storage();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method for creating event with determine event index.
    //! @note      None
    //! @param     [in] u32_Event_ID - Event index
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Create( U32 u32_Event_ID );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method for creating event by given event descriptor
    //! @note      None
    //! @param     [in] &struct_Event_Descriptor - Event descriptor
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Create( const TEvent_Descriptor &struct_Event_Descriptor );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method for creating event header
    //! @note      None
    //! @param     [out] **struct_Event_Record - Pointer to getting event
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Create_Header_Event( TEvent_Manager_Base::TEvent_Header_Record **struct_Event_Record );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method for creating event header
    //! @note      Data events are connected to the event header.
    //! @param     [in] u64_Relative_Event_Index - Relative event index
    //! @param     [out] **struct_Event_Record - Pointer to getting event
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Create_Data_Event( U64 u64_Relative_Event_Index, TEvent_Manager_Base::TEvent_Payload_Record **struct_Event_Record );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get event database descriptor hash
    //! @note      None
    //! @return    Event database descriptor hash
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Database_Hash();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get event database descriptor hash
    //! @note      None
    //! @return    Databse record count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Database_Record_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get event buffer size
    //! @note      None
    //! @return    Event buffer size
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Event_Buffer_Size();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get event buffer size
    //! @note      None
    //! @return    Event buffer size
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Event_Record_Size();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get current buffer index
    //! @note      None
    //! @return    Current buffer index
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Current_Buffer_Index();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method search event record by event index
    //! @note      None
    //! @param     [in] u64_Event_Index - Event index
    //! @param     [out] **struct_Event_Record - Pointer to event
    //! @return    BOOL - Searching status
    //! @retval    false - Searching failed
    //! @retval    true - Searching successfully done
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Event_Record_By_Index( U64 u64_Event_Index, TEvent_Manager_Base::TEvent_Generic_Record **struct_Event_Record );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get index of the first event record
    //! @note      None
    //! @return    U64 - Event index for first record
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 Get_First_Event_Index();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get index of the last event record
    //! @note      None
    //! @return    U64 - Event index for last record
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 Get_Last_Event_Index();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get index of the currently selected event
    //! @note      None
    //! @return    U64 - index of the currently selected event
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U64 Get_Selected_Event_Index();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method set index of the currently selected even
    //! @note      None
    //! @return    BOOL - Operation status
    //! @retval    false - Index dont set
    //! @retval    true - Index set successfully
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Set_Selected_Event_Index( U64 u64_Selected_Event_New_Index );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get selected event
    //! @note      None
    //! @param     [out] **struct_Event_Record - Pointer to event
    //! @return    BOOL - Operation status
    //! @retval    false - Event not getting
    //! @retval    true - Event successfully getting
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Selected_Event( TEvent_Manager_Base::TEvent_Generic_Record **struct_Event_Record );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method show boot information message method
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Show_Boot_Information( TProtocol_Base *object_Protocol );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method send diagnostic information about event manager
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method send event desctiption over protocol
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! @param     [in] enum_Event_ID - Event index
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Send_Event_Description( TProtocol_Base *object_Protocol, U32 enum_Event_ID );
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get pointer to event description by given event ID
    //! @note      None
    //! @param     [in] u32_Event_ID - Event index
    //! @param     [out] **c8_Event_Description - Pointer to event description
    //! @return    BOOL - Operation status
    //! @retval    false - Operation falled
    //! @retval    true - Operation successfully done
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Event_Description_By_Event_ID( U32 u32_Event_ID, C8 **c8_Event_Description );
 
    //!-------------------------------------------------------------------------
    //! @brief     This method return OS status
    //! @note      None
    //! @return    U32 - OS status
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_OS_Status();
 
    //!-------------------------------------------------------------------------
    //! @brief     This method set module in operation mode
    //! @note      None
    //! @return    BOOL - Module status
    //! @retval    false - Module in error mode
    //! @retval    true - Module ready to operations
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Start_Operation();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
  
    //! @brief Event data flush FSM state definition
    typedef enum
    {
 
      //! @brief Idle state
      enum_Idle,
 
      //! @brief Data flish state
      enum_Flush_Buffer,
 
      //! @brief Looking for next good block stete
      enum_Search_Good_Block,
 
      //! @brief Testing for block is empty state
      enum_Empty_Block_Test,
 
      //! @brief Erase block state
      enum_Erase_Block
 
    } TData_Flush_FSM;
 
    //! @brief Event buffer structure definition
    typedef struct
    {
 
      //! @brief Event buffer
      TEvent_Manager_Base::TEvent_Generic_Record struct_Buffer[ EVENT_MANAGER_BUFFER_SIZE ];
 
      //! @brief Data buffer flush request
      BOOL bool_Flush_Request;
 
    } TEvent_Buffer;
 
    //--------------------------------------------------------------------------
    // Private methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Verify event desriptor database method
    //! @note      This method verify consistency of the event descriptor database.
    //! @return    BOOL - verification status
    //! @retval    false - Verification failed due one or multiple errors
    //! @retval    true - Verification successed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Verify_Event_Descriptor_Database();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get event database size in bytes method.
    //! @note      None
    //! @return    U32 - Event database in bytes
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Database_Size_In_Bytes();
 
    //!-------------------------------------------------------------------------
    //! @brief     Calculate event descriptor database hash description.
    //! @note      None
    //! @return    U32 - Event database hash value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Calculate_Database_Hash();
 
    //!-------------------------------------------------------------------------
    //! @brief     Increment event buffer method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Increment_Buffer_Index();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get previous buffer index.
    //! @note      None
    //! @param     [in] u32_Buffer_Index - Buffer index
    //! @return    U32 - Previous buffer index value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Previous_Buffer_Index( U32 u32_Buffer_Index );
 
    //!-------------------------------------------------------------------------
    //! @brief     Half division method event searching.
    //! @note      None
    //! @param     [in] u64_Event_Index - Index of the event to search
    //! @param     [out] **struct_Event_Record - Pointer to returned event record
    //! @return    BOOL - Searching status
    //! @retval    false - Searching for event record failed
    //! @retval    true - Event record successfully getted
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Half_Devision_Method_Searching( U64 u64_Event_Index, TEvent_Manager_Base::TEvent_Generic_Record **struct_Event_Record );
 
    //!-------------------------------------------------------------------------
    //! @brief     Search first and last event index in flash
    //! @note      None
    //! @return    BOOL - Searching status
    //! @retval    false - Searching failed
    //! @retval    true - Params successfully determined
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Min_Max_Flash_Index();
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Pointer to event memory object
//    TSPI_Memory_Base *object_SPI_Memory = (TSPI_Memory_Base*)NULL;
    TS25FL512 *object_SPI_Memory = (TS25FL512*)NULL;
    
    //! @brief Event buffers
    TEvent_Buffer struct_Event_Buffer[ EVENT_MANAGER_BUFFERS_COUNT ];
 
    //! @brief Last flushed buffer index
    U32 u32_Last_Flushed_Buffer_Index = (U32)0;
 
    //! @brief  Last global event index detected in the Flash
    U64 u64_Last_Flushed_Event_Index = (U64)0;
 
    //! @brief Event manager database derscriptor hash
    U32 u32_Database_Hash = (U32)0x00000000;
 
    //! @brief Event data flish FSM state variable
    TData_Flush_FSM enum_Data_Flush_FSM_State = enum_Idle;
 
    //! @brief Storage block index variable, used to store actual block index by data flush FSM
    U16 u16_Storage_Block_Index = (U16)0;
 
    //! @brief Storage page index variable, used to store actual page index by data flush FSM
    U16 u16_Page_Index_With_Max_Event_Index = (U16)0;
 
    //! @brief Storage page index with manimal event index in flash
    U16 u16_Page_Index_With_Min_Event_Index = (U16)0;
 
    //! @brief Storage page index with maximal event index in flash
    U16 u16_Offset_For_Max_Event_Index = (U16)0;
 
    //! @brief Storage Current buffer index
    U32 u32_Current_Buffer_Index = (U32)0;
 
    //! @brief Storage current number of buffer index
    U32 u32_Current_Number_Buffer_Index = (U32)0;
 
    //! @brief First global event index detected in the system
    U64 u64_First_Global_Event_Index = (U64)0;
 
    //! @brief Last global event index detected in the system
    U64 u64_Last_Global_Event_Index = (U64)0;
 
    //! @brief Current global event index detected in the system
    U64 u64_Current_Global_Event_Index = (U64)0;
 
    //! @brief Actual selected event index
    U64 u64_Selected_Event_Index = (U64)0;
 
    //! @brief Current event record. Store current event data for VDC tool functionality.
    TEvent_Manager_Base::TEvent_Generic_Record struct_Selected_Event_Record;
 
    //! @brief Selected event validity flag
    BOOL bool_Selected_Event_Valid = (BOOL)false;
 
    //! @brief Flash data record storage
    TEvent_Manager_Base::TEvent_Generic_Record struct_Flash_Event_Record;
 
    //! @brief Current address for programing
    U64 u64_Current_Program_Page_Address = (U64)0;
 
    //! @brief Last event index in flash memory
    U64 u64_Current_Event_Index_In_Flash = (U64)0;
 
    //! @brief Event descriptors list storage mapped directly to the section
    TEvent_Descriptor *struct_Event_Descriptors_List = (TEvent_Descriptor*)NULL;
 
    //! @brief Container for OS status
    TOS_Status_Structure struct_OS_Status;
 
    //! @brief Duplicated event descriptor record counter
    U32 u32_Duplicated_Event_Descriptor_Record_Counter = (U32)0;
 
    //! @brief Counter for requested events
    U32 u32_Requested_Event_Counter = (U32)0;
 
    //! @brief Counter of dropped events caused by buffer overflow
    U32 u32_Dropped_Event_Counter = (U32)0;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------