Trace_Recorder.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Trace_Recorder.h
//! @brief      Trace recorder class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2020-2021 ANVILEX LLC
//!             $HeadURL: $
//!             $Revision: $
//!             $Date: $
//!             $Author: $
//------------------------------------------------------------------------------
//
// 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 project files
//------------------------------------------------------------------------------
 
//#include "Defines.h"
#include "Application_Resource_Configuration.h"
//#include "System_Date.h"
//#include "Protocol_Base.h"
#include "SPI_Memory_Base.h"
#include "S25FL512.h"
 
//------------------------------------------------------------------------------
// Trace recorder buffer defines
//------------------------------------------------------------------------------
 
#define TRACE_RECORDER_BUFFER_SIZE   512
#define TRACE_RECORDER_BUFFERS_COUNT 2
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Trace recorder class
class TTrace_Recorder
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TTrace_Recorder();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TTrace_Recorder();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class finalisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @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     Frame create method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Frame_Create();
 
    //!-------------------------------------------------------------------------
    //! @brief     Frame close method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Frame_Close();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    //! @brief Trace buffer structure definition
    typedef struct
    {
 
      //! @brief Event buffer
//      TEvent_Manager_Base::TEvent_Generic_Record struct_Buffer[ TRACE_RECORDER_BUFFER_SIZE ];
      U8 struct_Buffer[ TRACE_RECORDER_BUFFER_SIZE ];
 
      //! @brief Data buffer flush request
      BOOL bool_Flush_Request;
 
    } TTrace_Buffer;
 
    //--------------------------------------------------------------------------
    // 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 Trace buffers
    TTrace_Buffer struct_Trace_Buffer[ TRACE_RECORDER_BUFFERS_COUNT ] = { .bool_Flush_Request = (BOOL)false, .struct_Buffer = { (U8)0x00 } };
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------