Event_Manager_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Event_Manager_Base.h
//! @brief      Event manager 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/Event_Manager_Base.h $
//!             $Revision: 2582 $
//!             $Date: 2021-04-11 19:40:47 +0500 (So, 11 Apr 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"
 
//------------------------------------------------------------------------------
// Event manager buffer size
//------------------------------------------------------------------------------
 
#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_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
 
    //! @brief Event header data record, 64 bytes
    typedef union
    {
 
      //! @brief Raw data representation
      U8 u8_Raw_Data[ 64 ];
 
      //! @brief Structured data representation
      struct
      {
 
        //! @brief Global event index union
        union
        {
 
          //! @brief Global event index, 8 bytes
          U64 u64_Global_Event_Index;
 
          
          struct
          {
 
            //! @brief Event index bits, 48 bits
            U64 event_Index:48;
 
            //! @brief Event followed data block counts, 16 bits
            U16 block_Block_Numbers:16;
 
          } Bits;
 
        };
 
        //! @brief Event absolute timestamp information, 8 x 2 = 16 bytes
        TDate_Time::TDate_Time_Structure struct_Absolute_Timestamp;
 
        //! @brief Event relative timestamp, 8 bytes
        U64 u64_Relative_Timestamp;
 
        //! @brief Task iteration since system power up, 8 bytes
        U64 u64_Task_Iteration;
 
        //! @brief Event header union
        union
        {
 
          //! @brief Event header, 4 byte
          U32 u32_Event_Header;
 
          //! @brief Event identifier
          U32 u32_Event_ID;
 
        };
 
        //! @brief Event data, 4 bytes
        U32 u32_Event_Data;
 
        //! @brief OS Version, 4 bytes
        U32 u32_OS_Version;
 
        //! @brief Application ID, 4 bytes
        U32 u32_App_ID;
 
        //! @brief Application version, 4 bytes
        U32 u32_App_Version;
 
        //! @brief CRC32, 4 bytes
        U32 u32_CRC;
 
      };
 
    } TEvent_Header_Record;
 
    //! @brief Event payload data record, 64 bytes
    typedef union
    {
 
      //! @brief Raw data representation
      U8 u8_Raw_Data[ 64 ];
 
      //! @brief Structured data representation
      struct
      {
 
        //! @brief Global event index, 8 bytes
        U64 u64_Global_Event_Index;
 
        //! @brief Relative event information, 8 bytes
        U64 u64_Relative_Event_Index;
 
        //! @brief Data block index, 4 bytes
        U32 u32_Data_Block_Index;
 
        //! @brief CRC32, 4 bytes
        U32 u32_CRC;
 
        //! @brief Event data union
        union
        {
 
          //! @brief Event data as raw data array
          U8 u8_Data[ 40 ];
 
          //! @brief Event data as variant
          TConOpSys_Variant_Data Data[ 4 ];
 
        };
 
      };
 
    } TEvent_Payload_Record;
 
    //! @brief Consolidated generic event data record
    typedef union
    {
 
      //! @brief Raw data representation
      U8 u8_Raw_Data[ 64 ];
 
      //! @brief Structured data representation
      union
      {
 
        //! @brief Event header record
        TEvent_Header_Record Event_Header;
 
        //! @brief Event payload record
        TEvent_Payload_Record Event_Data;
 
      };
 
    } TEvent_Generic_Record;
 
    //--------------------------------------------------------------------------
    // 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
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Event manager finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Event manager background execution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
//    VOID Assign_Memory( TSPI_Memory_Base *object_Memory_Pointer );
    virtual VOID Assign_Memory( TS25FL512 *object_Memory_Pointer );
 
    //!-------------------------------------------------------------------------
    //! @brief     Verify database method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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_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_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
    //--------------------------------------------------------------------------
 
    virtual U32 Get_Database_Hash();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method get event database descriptor hash
    //! @note      None
    //! @return    Databse record count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual 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_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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Selected_Event( 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual 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
    //--------------------------------------------------------------------------
 
    virtual BOOL Start_Operation();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------