ABCC_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       ABCC_Base.h
//! @brief      ANYBUS module 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/Communication/ABCC/ABCC_Base.h $
//!             $Revision: 2870 $
//!             $Date: 2021-09-17 13:49:47 +0500 (Fr, 17 Sep 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.
//
//------------------------------------------------------------------------------
 
/*******************************************************************************
********************************************************************************
**                                                                            **
** ABCC Starter Kit version 3.04.01 (2018-01-23)                              **
**                                                                            **
** Delivered with:                                                            **
**    ABP            7.55.01 (2017-12-20)                                     **
**    ABCC Driver    5.04.01 (2017-12-18)                                     **
**                                                                            */
/*******************************************************************************
********************************************************************************
** COPYRIGHT NOTIFICATION (c) 2013 HMS Industrial Networks AB                 **
**                                                                            **
** This code is the property of HMS Industrial Networks AB.                   **
** The source code may not be reproduced, distributed, or used without        **
** permission. When used together with a product from HMS, permission is      **
** granted to modify, reproduce and distribute the code in binary form        **
** without any restrictions.                                                  **
**                                                                            **
** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT    **
** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR     **
** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR     **
** THAT DEFECTS IN IT CAN BE CORRECTED.                                       **
********************************************************************************
********************************************************************************
** This is an example implementation of an application handler to control the
** ABCC module. It has support to initialise, run and reset/shutdown the ABCC.
** The state machine shall be executed cyclically and it returns its current
** status after every execution.
********************************************************************************
********************************************************************************
**
** Services:
**
**  APPL_HandleAbcc()              - Runs the state machine controlling the ABCC module
**  APPL_RestoreToDefault()        - Restores any NVS parameter to its default value
**  APPL_GetCandidateFwAvailable() - Call to check if there is a firmware in the candidate area
**  APPL_SetCandidateFwAvailable() - Sets whether firmware is available in the candidate area
**  APPL_IsResetRequestAllowed()   - Check if a reset is allowed
**  APPL_SetHwSwitch1Value()       - Set switch 1 value
**
********************************************************************************
********************************************************************************
*/
 
#pragma once
 
//------------------------------------------------------------------------------
 
#include <string.h>
 
//------------------------------------------------------------------------------
 
#include "abcc_drv_cfg.h"
 
#include "abp.h"
#include "abcc.h"
 
//------------------------------------------------------------------------------
 
#include "SPI_Master_Base.h"
#include "Protocol_Base.h"
#include "Interval_Timer.h"
#include "Request_Synchroniser.h"
 
/*------------------------------------------------------------------------------
**  Error codes for example application:
**
**  APPL_NO_ERROR                  - No error
**  APPL_AD_PD_REDA_SIZE_ERR       - Total process data read size too large
**                                   Check ABCC_CFG_MAX_PROCESS_DATA_SIZE
**  APPL_AD_PD_WRITE_SIZE_ERR      - Total process data write too large
**                                   Check ABCC_CFG_MAX_PROCESS_DATA_SIZE
**  APPL_AD_TOO_MANY_READ_MAPPINGS - Read process data map has too many entries
**                                   Check AD_MAX_OF_READ_WRITE_TO_MAP.
**  APPL_AD_TOO_MANY_WRITE_MAPPINGS- Write process data map has too many entries
**                                   Check AD_MAX_OF_WRITE_WRITE_TO_MAP
**  APPL_AD_UNKNOWN_ADI            - Requested ADI could not be found
**------------------------------------------------------------------------------
*/
 
typedef enum APPL_ErrCode
{
   APPL_NO_ERROR                   = 0,
   APPL_AD_PD_READ_SIZE_ERR        = 1,
   APPL_AD_PD_WRITE_SIZE_ERR       = 2,
   APPL_AD_TOO_MANY_READ_MAPPINGS  = 3,
   APPL_AD_TOO_MANY_WRITE_MAPPINGS = 4,
   APPL_AD_UNKNOWN_ADI             = 5
}
APPL_ErrCodeType;
 
//------------------------------------------------------------------------------
/*
typedef enum appl_AbccHandlerState
{
  APPL_INIT,
  APPL_START_DRIVER,
  APPL_WAITCOM,
  APPL_SETUP,
  APPL_RUN,
  APPL_SHUTDOWN,
  APPL_ABCCRESET,
  APPL_DEVRESET,
  APPL_HALT
}
appl_AbccHandlerStateType;
*/
//------------------------------------------------------------------------------
/*
#define NUM_BYTES_2_WORDS( X ) ( ( ( X ) + 1 ) >> 1 )
 
#define SPI_DEFAULT_PD_LEN            ( 0 )
#define CRC_WORD_LEN_IN_WORDS         ( 2 )
#define SPI_FRAME_SIZE_EXCLUDING_DATA ( 7 )
#define SPI_BASE_FRAME_WORD_LEN       ( 5 ) //!< Frame length in words excluding MSG and PD data
 
#if ABCC_CFG_SPI_MSG_FRAG_LEN > ABCC_CFG_MAX_MSG_SIZE
#error  SPI fragmentation length cannot exceed maximal message size
#endif
 
#define MAX_PAYLOAD_WORD_LEN ( ( NUM_BYTES_2_WORDS( ABCC_CFG_SPI_MSG_FRAG_LEN ) ) + ( NUM_BYTES_2_WORDS( ABCC_CFG_MAX_PROCESS_DATA_SIZE ) ) + ( CRC_WORD_LEN_IN_WORDS ) )
*/
//------------------------------------------------------------------------------
 
#define ABCC_MESSAGE_DATA_BUFFER_SIZE ( 16 )
//#define ABCC_PROCESS_DATA_BUFFER_SIZE ( 16 )
#define ABCC_PROCESS_DATA_BUFFER_SIZE ( 128+64 )
 
// Maximal amount of the mappable process data parameters
#define ABCC_MAXIMAL_MAPPABLE_PROCESS_DATA_PARAMETERS   ( 128 )
 
//------------------------------------------------------------------------------
//  Class TABCC
//------------------------------------------------------------------------------
 
class TABCC_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TABCC_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TABCC_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     ABCC driver initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     ABCC driver Finaliseation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Assign SPI master hardware driver.
    //! @note      None
    //! @param     [in] *object_New_SPI_Master - Pointer to the SPI master hardware driver
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Assign_SPI_Master( TSPI_Master_Base *object_New_SPI_Master );
 
    //!-------------------------------------------------------------------------
    //! @brief     Unassign SPI master hardware driver.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Unassign_SPI_Master();
 
    //!-------------------------------------------------------------------------
    //! @brief     Activate process data processing.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Activate_Process_Data();
 
    //!-------------------------------------------------------------------------
    //! @brief     Deactivate process data processing.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Deactivate_Process_Data();
 
    VOID Execute(); //!<
    VOID Execute_System_Timer(); //!<
 
    VOID Map_Write_Parameter_To_Process_Data( TParameter_Base *object_Parameter ); //!< Map parameter to the write process data
    VOID Map_Read_Parameter_To_Process_Data( TParameter_Base *object_Parameter ); //!!< Map parameter to the read process data
 
    BOOL Is_Initialised(); //!< Get initialisation status
 
    VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information about object
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    virtual VOID Object_Command( ABP_MsgType* psNewMessage, ABP_MsgType *psResponceMessage ) = 0; //!< Object command processing method
    virtual VOID Instance_Command( ABP_MsgType* psNewMessage, ABP_MsgType *psResponceMessage ) = 0; //!< Instance command processing method
 
    U16 Get_Message_Data_Length( ABP_MsgType *struct_Message );
    VOID Set_Message_Data_Length( ABP_MsgType *struct_Message, U16 u16_Length );
 
    VOID Get_Message_Data_U8( ABP_MsgType* psMsg, U8 *u8_Data, U16 u16_Offset );
    VOID Set_Message_Data_U8( ABP_MsgType* psMsg, U8 u8_Data, U16 u16_Offset );
 
    VOID Get_Message_Data_U16( ABP_MsgType* psMsg, U16 *u16_Data, U16 u16_Offset );
    VOID Set_Message_Data_U16( ABP_MsgType* psMsg, U16 u16_Data, U16 u16_Offset );
 
//    VOID Get_Message_Data_U32( ABP_MsgType* psMsg, U32 *u32_Data, U16 u16_Offset );
//    VOID Set_Message_Data_U32( ABP_MsgType* psMsg, U32 u32_Data, U16 u16_Offset );
 
//    VOID Get_Message_Data_U64( ABP_MsgType* psMsg, U64 *u64_Data, U16 u16_Offset );
//    VOID Set_Message_Data_U64( ABP_MsgType* psMsg, U64 u64_Data, U16 u16_Offset );
 
//    VOID Get_Message_Data_String( ABP_MsgType* psMsg, const char* pcString, U16 iNumChar, U16 u16_Offset );
    VOID Set_Message_Data_String( ABP_MsgType* psMsg, const char* pcString, U16 iNumChar, U16 u16_Offset );
 
    VOID Set_Message_Map_ADI_Area( ABP_MsgType* psMsg, U8 u8_ADI_Data_Type, U8 u8_ADI_Elements_Number, U16 u16_ADI_Order_Number );
 
    VOID Set_Msg_Header( ABP_MsgType* psMsg, U8 bObject, U16 iInstance, U8 bAttribute, ABP_MsgCmdType eService, U16 iDataSize, U8 bSourceId );
    VOID Create_Responce_From_Request( ABP_MsgType* struct_Request_Message, ABP_MsgType* struct_Responce_Message );
    VOID Create_Error_Responce_From_Request( ABP_MsgType* struct_Request_Message, ABP_MsgType* struct_Responce_Message, ABP_MsgErrorCodeType enum_Error_Code );
    VOID Set_Message_Responce( ABP_MsgType* psMsg, U16 u16_Data_Size );
    VOID Set_Message_Error_Response( ABP_MsgType* psMsg, U16 iMsgDataSize, ABP_MsgErrorCodeType eErr );
 
    BOOL Is_Message_Command( ABP_MsgType *struct_Message );
 
    U16 Get_Message_Instance( ABP_MsgType *struct_Message );
    U8 Get_Message_Command_Code( ABP_MsgType *struct_Message );
    U8 Get_Message_Command_Extension_0( ABP_MsgType *struct_Message );
 
    VOID Get_Attribute( ABP_MsgType *psMsg, U8 bObject, U16 iInstance, U8 bAttribute, U8 bSourceId );
    VOID Set_Byte_Attribute( ABP_MsgType *psMsg, U8 bObject, U16 iInstance, U8 bAttribute, U8 bVal, U8 bSourceId );
 
    VOID Map_ADI_Write_Area( ABP_MsgType *psMsg, U8 bObject, U16 iInstance, U8 bSourceId, U16 u16_ADI_Instance_Number );
    VOID Map_ADI_Read_Area( ABP_MsgType *psMsg, U8 bObject, U16 iInstance, U8 bSourceId, U16 u16_ADI_Instance_Number );
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    typedef enum
    {
      enum_ABCC_Transfer_Frame,
      enum_ABCC_Error,
    } TABCC_FSM_State;
 
    //--------------------------------------------------------------------------
 
//    #pragma push
    #pragma pack(1)
 
    typedef struct TSPI_MOSI_Frame
    {
 
      union
      {
        struct
        {
          U8 bit_Write_Process_Data:1; // Bit 0 - WRPD VALID
          U8 bit_Command_Count:2;      // Bit 1-2 - CMDCNT
          U8 bit_Message:1;            // Bit 3 - M
          U8 bit_Last_Fragment:1;      // Bit 4 - LAST FRAG
          U8 :1;                       // Bit 5 - Not used, must be set to 0
          U8 :1;                       // Bit 6 - Not used, must be set to 0
          U8 bit_Toggle:1;             // Bit 7 - TOGGLE
        } u8_Bits;
        U8 u8_Byte;
      } u8_SPI_Control_Byte;           // Byte 0
      U8 u8_Reserved;                  // Byte 1
      U16 u16_Message_Length;          // Byte 2-3
      U16 u16_Process_Data_Length;     // Byte 4-5
      U8 u8_Application_Status;        // Byte 6
      U8 u8_Interrupt_Mask;            // Byte 7
      U8 u8_Message_Data[ ABCC_MESSAGE_DATA_BUFFER_SIZE ];
      U8 u8_Process_Data[ ABCC_PROCESS_DATA_BUFFER_SIZE ];
      U32 u32_CRC;
      U16 u16_Dummy;
 
    } TSPI_MOSI_Frame;
 
//    #pragma pop
    #pragma pack()
 
    //--------------------------------------------------------------------------
 
//    #pragma push
    #pragma pack(1)
 
    typedef struct TSPI_MISO_Frame
    {
 
      U16 u16_Reserved;         // Byte 0-1
      U16 u16_LED_Status;       // Byte 2-3
      union
      {
        struct
        {
          U8 bit_State:3;       // Bit 0-2 - State
          U8 bit_Supervised:1;  // Bit 3   - Supervised
          U8 :4;                // Bit 4-7 - Not used
        } u8_Bits;
        U8 u8_Byte;
      } u8_AnyBus_Status;      // Byte 4
      union
      {
        struct
        {
          U8 bit_Message_Buffer_Full:1; // Bit 0 - Message buffer full
          U8 bit_Command_Count:2;       // Bit 1-2 - Command count
          U8 bit_Message:1;             // Bit 3 - Message
          U8 bit_Last_Fragment:1;       // Bit 4 - Last message fragment
          U8 bit_New_Process_Data:1;    // Bit 5 - Process data
          U8 :1;                        // Bit 6 - Not used
          U8 :1;                        // Bit 7 - Not used
        } u8_Bits;
        U8 u8_Byte;
      } u8_SPI_Status;          // Byte 5
      U32 u32_NetTime;          // Byte 6-9
      U8 u8_Message_Data[ ABCC_MESSAGE_DATA_BUFFER_SIZE ];
      U8 u8_Process_Data[ ABCC_PROCESS_DATA_BUFFER_SIZE ];
      U32 u32_CRC;
//      U32 u32_Calculated_CRC;
    } TSPI_MISO_Frame;
 
//    #pragma pop
    #pragma pack()
 
    //--------------------------------------------------------------------------
 
    typedef struct TABBC_Process_Data
    {
//      U16 u16_Length;
      U8 u8_Data[ ABCC_PROCESS_DATA_BUFFER_SIZE ];
    } TABBC_Process_Data;
 
    //--------------------------------------------------------------------------
 
    typedef enum TData_Type
    {
 
      enum_BOOL = ABP_BOOL,     // Boolean
      enum_SINT8 = ABP_SINT8,   // Signed 8 bit integer
      enum_SINT16 = ABP_SINT16, // Signed 16 bit integer
      enum_SINT32 = ABP_SINT32, // Signed 32 bit integer
      enum_U8 = ABP_U8,   // Unsigned 8 bit integer
      enum_UINT16 = ABP_UINT16, // Unsigned 16 bit integer
      enum_UINT32 = ABP_UINT32, // Unsigned 32 bit integer
      enum_CHAR = ABP_CHAR,     // Character
      enum_ENUM = ABP_ENUM,     // Enumeration
      enum_BITS8 = ABP_BITS8,   // 8 bit bitfield (ABCC40)
      enum_BITS16 = ABP_BITS16, // 16 bit bitfield (ABCC40)
      enum_BITS32 = ABP_BITS32, // 32 bit bitfield (ABCC40)
      enum_OCTET = ABP_OCTET,   // 8 bit data (ABCC40)
 
      enum_SINT64 = ABP_SINT64, // Signed 64 bit integer
      enum_UINT64 = ABP_UINT64, // Unsigned 64 bit integer
      enum_FLOAT = ABP_FLOAT,   // Floating point/real number
 
      enum_PAD0 = ABP_PAD0,     // Padding bitfield (ABCC40)
      enum_PAD1 = ABP_PAD1,     // Padding bitfield (ABCC40)
      enum_PAD2 = ABP_PAD2,     // Padding bitfield (ABCC40)
      enum_PAD3 = ABP_PAD3,     // Padding bitfield (ABCC40)
      enum_PAD4 = ABP_PAD4,     // Padding bitfield (ABCC40)
      enum_PAD5 = ABP_PAD5,     // Padding bitfield (ABCC40)
      enum_PAD6 = ABP_PAD6,     // Padding bitfield (ABCC40)
      enum_PAD7 = ABP_PAD7,     // Padding bitfield (ABCC40)
      enum_PAD8 = ABP_PAD8,     // Padding bitfield (ABCC40)
      enum_PAD9 = ABP_PAD9,     // Padding bitfield (ABCC40)
      enum_PAD10 = ABP_PAD10,   // Padding bitfield (ABCC40)
      enum_PAD11 = ABP_PAD11,   // Padding bitfield (ABCC40)
      enum_PAD12 = ABP_PAD12,   // Padding bitfield (ABCC40)
      enum_PAD13 = ABP_PAD13,   // Padding bitfield (ABCC40)
      enum_PAD14 = ABP_PAD14,   // Padding bitfield (ABCC40)
      enum_PAD15 = ABP_PAD15,   // Padding bitfield (ABCC40)
      enum_PAD16 = ABP_PAD16,   // Padding bitfield (ABCC40)
 
      enum_BOOL1 = ABP_BOOL1,   // 1 bit boolean (ABCC40)
      enum_BIT1 = ABP_BIT1,     // 1 bit bitfield (ABCC40)
      enum_BIT2 = ABP_BIT2,     // 2 bit bitfield (ABCC40)
      enum_BIT3 = ABP_BIT3,     // 3 bit bitfield (ABCC40)
      enum_BIT4 = ABP_BIT4,     // 4 bit bitfield (ABCC40)
      enum_BIT5 = ABP_BIT5,     // 5 bit bitfield (ABCC40)
      enum_BIT6 = ABP_BIT6,     // 6 bit bitfield (ABCC40)
      enum_BIT7 = ABP_BIT7,     // 7 bit bitfield (ABCC40)
 
      enum_Unsupported = 255    // Unsupported data type
 
    } TData_Type;
 
    typedef struct TProcess_Data_Parameter_Record
    {
      TParameter_Base *object_Parameter; //!< Pointer to the parameter
      U16 u16_Offset; //!< Offset within process data buffer
      TRIL tril_Mapped; //!< Parameter mapped status flag
    } TProcess_Data_Parameter_Record;
 
    BOOL Module_Detect();
 
    VOID Activate_Hardware_Reset(); //!< Activate hardware reset
    VOID Deactivate_Hardware_Reset(); //!< Deactivate hardware reset
 
    BOOL Is_New_Firmware_Avaliable();
    BOOL Is_Hardware_Reset_State();
    BOOL Is_Interrupt_Line_Active();
 
    VOID Dummy_Command();
    VOID Get_Data_Format_Command();
    VOID Get_Parameter_Support_Command();
    VOID Get_Module_Type_Command();
    VOID Get_Network_Type_Command();
    VOID Get_Firmware_Version_Command();
    VOID Set_Node_Address();
//    VOID Prepare_Process_Data_Mapping();
    VOID Map_ADI_Write_Area_Command();
    VOID Map_ADI_Read_Area_Command();
    VOID Read_Process_Data_Size_Command();
    VOID Write_Process_Data_Size_Command();
    VOID Setup_Complete_Command();
 
    VOID Get_Exception_Command(); //!< Get exception command
    VOID Get_Exception_Info_Command();
 
    BOOL Is_New_RX_Message_Present();
    VOID Process_New_RX_Message();
    VOID RX_Message_Processed(); //!< RX message processed notification
 
    BOOL Is_New_Read_Process_Data_Present(); //!< Return new read process data status
    VOID New_Read_Process_Data_Processed();
    VOID Process_Read_Process_Data();
 
    BOOL Network_Setup(); //!< Network setup method
 
    TABCC_Base::TData_Type Get_Parameter_Data_Type( TParameter_Base *object_Parameter );
    U8 Get_Data_Type_Size_In_Bytes( TABCC_Base::TData_Type enum_Data_Type );
    BOOL Get_Parameter_Data_Type_Properties( TParameter_Base *object_Parameter, TABCC_Base::TData_Type *enum_Data_Type, U8 *u8_Data_Type_Size );
 
    U16 Get_Requered_Process_Data_Buffer_Size();
 
    VOID Bus_Transaction();
 
    U32 CRC32_ABCC( U8* pbBufferStart, U16 iLength );
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to the SPI master object
    TSPI_Master_Base *object_SPI_Master;
 
    //!< Initialisation error flag
    BOOL bool_Initialisation_Error;
 
    //!< ABCC module detection status flag
    TRIL tril_ABCC_Module_Detection_Status;
 
    //!< ABCC module reset status flag
    TRIL tril_ABCC_Module_Reset_Status;
 
    //!< ABCC module startup status flag
    TRIL tril_ABCC_Module_Startup_Status;
 
    //!< ABCC module setup status flag
    TRIL tril_ABCC_Module_Setup_Status;
 
    //!< ABCC network setup status flag
    TRIL tril_ABCC_Network_Setup_Status;
 
    //!< Module reset acceptance time
    U32 u32_Module_Reset_Acceptance_Time;
 
    //!< Module startup time
    U32 u32_Module_Startup_Time;
 
    //!< Module startup timeout
    U32 u32_Startup_Timeout;
 
    // ABCC finiti state machine
    TABCC_FSM_State fsm_ABCC;
 
    //!< APB message to the module
    ABP_MsgType struct_MOSI_Message;
 
    //!< APB message from the module
    ABP_MsgType struct_MISO_Message;
 
    //!< MOSI message frame buffer
    TSPI_MOSI_Frame struct_MOSI_Buffer;
 
    //!< MISO message frame buffer
    TSPI_MISO_Frame struct_MISO_Buffer;
 
    //!< Write process data structure
    TABBC_Process_Data struct_TX_Process_Data;
 
    //!< Read process data structure
    TABBC_Process_Data struct_RX_Process_Data;
 
    //!< Write proceess data parameter buffer index
    U32 u32_Write_Process_Data_Parameter_Buffer_Index;
 
    //!< Read proceess data parameter buffer index
    U32 u32_Read_Process_Data_Parameter_Buffer_Index;
 
    //!< Process data write parameter buffer
    TProcess_Data_Parameter_Record struct_Write_Process_Data_Parameter_Buffer[ ABCC_MAXIMAL_MAPPABLE_PROCESS_DATA_PARAMETERS ];
 
    //!< Process data read parameter buffer
    TProcess_Data_Parameter_Record struct_Read_Process_Data_Parameter_Buffer[ ABCC_MAXIMAL_MAPPABLE_PROCESS_DATA_PARAMETERS ];
 
    //!< First transfer after module reset flag
    BOOL bool_First_Transfer_After_Reset;
 
    //!< Toggle bit status flag
    BOOL bool_Toggle_Bit_Status;
 
    //!< Retransmit requered flag
    BOOL bool_Retransmit_Requered;
 
    //!< New transmit message present flag
    BOOL bool_New_TX_Message_Present;
//    BOOL bool_New_TX_Process_Data_Present;
 
    //!< New receive message present flag
    BOOL bool_New_RX_Message_Present;
 
    //!< Nre receive process data present flag
    BOOL bool_New_RX_Process_Data_Present;
 
    //!< Frame CRC error counter
    U32 u32_Frame_CRC_Error_Counter;
 
    //!< ABCC module error responce counter
    U32 u32_ABCC_Error_Responce_Counter;
 
    //!< ABCC module request counter
    U32 u32_ABCC_Request_Counter;
 
    U32 u32_Test_CRC;
 
    //!< Network data format
    NetFormatType enum_Net_Data_Format;
 
    //!< Parameter support flag
    ParameterSupportType enum_Parameter_Support;
 
    //!< ABCC module type
    U16 u16_ABCC_Module_Type;
 
    //!< ABCC network type
    U16 u16_ABCC_Network_Type;
 
    //!< ABCC firmware major version
    U8 u8_ABCC_Firmware_Version_Major;
 
    //!< ABCC firmware minor version
    U8 u8_ABCC_Firmware_Version_Minor;
 
    //!< ABCC module firmware version build
    U8 u8_ABCC_Firmware_Version_Build;
 
    //!< Process data read size
    U16 u16_Read_Process_Data_Size;
 
    //!< Process data write size
    U16 u16_Write_Process_Data_Size;
 
    //!< Exception code
    U8 u8_Exception_Code;
 
    //!< Exception info code
    U8 u8_Exception_Info_Code;
 
    //!< ABCC module LED status
    U16 u16_ABCC_LED_Status;
 
    //!< ABCC module state
    ABP_AnbStateType enum_ABCC_State;
 
    //!< Process data mapping error flag
    BOOL bool_Process_Data_Mapping_Error;
 
    //!< Message data buffer overflow flag
    BOOL bool_Message_Data_Buffer_Overflow;
 
    //!< Interval timer object for triggering write process data update
    TInterval_Timer object_Write_Process_Data_Timer;
 
    //!< Write process data request flag
    TRequest_Synchroniser object_Write_Process_Data_Request;
 
/*
00h No exception                              -
01h Application timeout                       The host application has not responded within the specified watchdog timeout period.
02h Invalid device address                    The selected device address is not valid for the actual network.
03h Invalid communication settings            The selected communication settings are not valid for the actual network.
04h Major unrecoverable app event             The host application has reported a major unrecoverable event to the Diagnostic object.
05h Wait for reset                            The module is waiting for the host application to execute a reset.
06h Invalid process data config               The Process Data configuration is invalid.
07h Invalid application response              The host application has provided an invalid response to a command.
08h Nonvolatile memory checksum error         At least one of the parameters stored in nonvolatile memory has been restored to its default value due to a checksum error.
09h ASM communication error                   Communication is lost between the Anybus CompactCom module and the attached Anybus safety module.
0Ah Insufficient application implementation   The application does not implement the functionality required for the Anybus module to continue its operation.
0Bh Missing serial number                     The module is missing a serial number. This might happen in product configurations which does not have an embedded serial number (e.g. Anybus IP), and the application fails to supply one.
0Ch Corrupt file system                       The file system is corrupt and must be formatted by user.
*/
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------