MODBUS_PDU.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       MODBUS_PDU.h
//! @brief      Communication protocol MODBUS over UART class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2021 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/MODBUS_PDU.h $
//!             $Revision: 2826 $
//!             $Date: 2021-07-28 13:46:37 +0500 (Mi, 28 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
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Modbus responce code definition
//------------------------------------------------------------------------------
 
#define MODBUS_RESPONCE_CODE_ILLEGAL_FUNCTION                        ( (U8)0x01 )
#define MODBUS_RESPONCE_CODE_ILLEGAL_DATA_ADDRESS                    ( (U8)0x02 )
#define MODBUS_RESPONCE_CODE_ILLEGAL_DATA_VALUE                      ( (U8)0x03 )
#define MODBUS_RESPONCE_CODE_SERVER_DEVICE_FAILURE                   ( (U8)0x04 )
#define MODBUS_RESPONCE_CODE_ACKNOWLEDGE                             ( (U8)0x05 )
#define MODBUS_RESPONCE_CODE_SERVER_DEVICE_BUSY                      ( (U8)0x06 )
#define MODBUS_RESPONCE_CODE_MEMORY_PARITY_ERROR                     ( (U8)0x07 )
#define MODBUS_RESPONCE_CODE_GATEWAY_PATH_UNAVAILABLE                ( (U8)0x0A )
#define MODBUS_RESPONCE_CODE_GATAWAY_TARGET_DEVICE_FAILED_TO_RESPOND ( (U8)0x0B )
 
//------------------------------------------------------------------------------
// Modbus function code definition
//------------------------------------------------------------------------------
 
#define MODBUS_FC_0x01_READ_COILS                       ( (U8)0x01 )
#define MODBUS_FC_0x02_READ_DISCRETE_INPUTS             ( (U8)0x02 )
#define MODBUS_FC_0x03_READ_HOLDING_REGISTERS           ( (U8)0x03 )
#define MODBUS_FC_0x04_READ_INPUT_REGISTER              ( (U8)0x04 )
#define MODBUS_FC_0x05_WRITE_SINGLE_COIL                ( (U8)0x05 )
#define MODBUS_FC_0x06_WRITE_SINGLE_REGISTER            ( (U8)0x06 )
#define MODBUS_FC_0x07_READ_EXCEPTION_STATUS            ( (U8)0x07 )
#define MODBUS_FC_0x08_DIAGNOSTIC                       ( (U8)0x08 )
#define MODBUS_FC_0x0B_GET_COMMUNICATION_EVENT_COUNTER  ( (U8)0x0B )
#define MODBUS_FC_0x0C_GET_COMMUNICATION_EVENT_LOG      ( (U8)0x0C )
#define MODBUS_FC_0x0F_WRITE_MULTIPLE_COILS             ( (U8)0x0F )
#define MODBUS_FC_0x10_WRITE_MULTIPLE_REGISTERS         ( (U8)0x10 )
#define MODBUS_FC_0x11_REPORT_SERVER_ID                 ( (U8)0x11 )
#define MODBUS_FC_0x14_READ_FILE_RECORD                 ( (U8)0x14 )
#define MODBUS_FC_0x15_WRITE_FILE_RECORD                ( (U8)0x15 )
#define MODBUS_FC_0x16_MASK_WRITE_REGISTER              ( (U8)0x16 )
#define MODBUS_FC_0x17_READ_WRITE_MULTIPLE_REGISTERS    ( (U8)0x17 )
#define MODBUS_FC_0x18_READ_FIFO_QUEUE                  ( (U8)0x18 )
#define MODBUS_FC_0x2B_ENCAPSULATED_INTERFACE_TRANSPORT ( (U8)0x2B )
 
#define MODBUS_MEI_0x0D_CANOPEN_GENERAL_REFERENCE       ( (U8)0x0D )
#define MODBUS_MEI_0x0E_READ_DEVICE_IDENTEFICATION      ( (U8)0x0E )
 
//------------------------------------------------------------------------------
 
//! @brief MODBUS PDU buffer side definition
#define MODBUS_PDU_BUFFER_SIZE  (0x100)
 
//------------------------------------------------------------------------------
// Class fefinitions
//------------------------------------------------------------------------------
 
//! @brief MODBUS generic PDU base class
class TMODBUS_PDU_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.
    //--------------------------------------------------------------------------
 
    TMODBUS_PDU_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TMODBUS_PDU_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Returns PDU buffer empty status
    //! @note      This function is not implemented
    //! @return    BOOL - PDU buffer status
    //! @retval    false - PDU buffer is not empty
    //! @retval    true - PDU buffer is empty
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Empty();
    
    //!-------------------------------------------------------------------------
    //! @brief     Returns PDU buffer size
    //! @note      None
    //! @return    U32 - PDU buffer size
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_Size();
    
    //!-------------------------------------------------------------------------
    //! @brief     Returns actual PDU buffer index
    //! @note      None
    //! @return    U32 - Actual PDU buffer index
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_Index();
    
    //!-------------------------------------------------------------------------
    //! @brief     Set PDU buffer index
    //! @note      None
    //! @param     [in] u32_New_Index - New PDU buffer index
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Set_Index( U32 u32_New_Index );
    
    //!-------------------------------------------------------------------------
    //! @brief     Returns pointer to PDU buffer
    //! @note      None
    //! @return    U8* - Pointer to PDU buffer
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U8* Get_Buffer_Pointer();
 
    //!-------------------------------------------------------------------------
    //! @brief     PDU initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     PDU initialisation with specifird slave address
    //! @note      None
    //! @param     [in] u8_Slave_Address - New slave address
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Init( U8 u8_Slave_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     PDU finalization method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL Done() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Set slave address
    //! @note      None
    //! @param     [in] u8_Slave_Address - New slave address
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Slave_Address( U8 u8_Slave_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Returns actual slave address
    //! @note      None
    //! @return    U8 - Actual slave address
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U8 Get_Slave_Address();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set function code method
    //! @note      None
    //! @param     [in] u8_Function_Code - Function code
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Function_Code( U8 u8_Function_Code );
    
    //!-------------------------------------------------------------------------
    //! @brief     Get function code method
    //! @note      None
    //! @return    U8 - Function code
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U8 Get_Function_Code();
 
    //!-------------------------------------------------------------------------
    //! @brief     Read U8 value at actual address method
    //! @note      None
    //! @return    U8 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U8 Read_U8_Value();
    
    //!-------------------------------------------------------------------------
    //! @brief     Read U8 value at specifird address method
    //! @note      None
    //! @param     [in] u32_Address - Address for reading
    //! @return    U8 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U8 Read_U8_Value( U32 u32_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Append U8 value at the buffer end method
    //! @note      None
    //! @param     [in] u8_Value - Append velue
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Append_U8_Value( U8 u8_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read U16 value at specifird address method
    //! @note      None
    //! @return    U16 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U16 Read_U16_Value();
    
    //!-------------------------------------------------------------------------
    //! @brief     Read U16 value at specifird address method
    //! @note      None
    //! @param     [in] u32_Address - Address for reading
    //! @return    U16 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U16 Read_U16_Value( U32 u32_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Append U16 value at the buffer end method
    //! @note      None
    //! @param     [in] u16_Value - Append velue
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Append_U16_Value( U16 u16_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read U32 value at specifird address method
    //! @note      None
    //! @return    U32 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Read_U32_Value();
    
    //!-------------------------------------------------------------------------
    //! @brief     Read U32 value at specifird address method
    //! @note      None
    //! @param     [in] u32_Address - Address for reading
    //! @return    U32 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Read_U32_Value( U32 u32_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Append U32 value at the buffer end method
    //! @note      None
    //! @param     [in] u32_Value - Append velue
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Append_U32_Value( U32 u32_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Read F32 value at specifird address method
    //! @note      None
    //! @return    F32 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Read_F32_Value();
    
    //!-------------------------------------------------------------------------
    //! @brief     Read F32 value at specifird address method
    //! @note      None
    //! @param     [in] u32_Address - Address for reading
    //! @return    F32 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    F32 Read_F32_Value( U32 u32_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Append F32 value at the buffer end method
    //! @note      None
    //! @param     [in] f32_Value - Append velue
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Append_F32_Value( F32 f32_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get cyclic redundancy check method
    //! @note      None
    //! @return    U16 - Read value
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U16 Get_CRC();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return PDU overrun status method
    //! @note      None
    //! @return    BOOL - PDU overrun status
    //! @retval    false - PDU is not overrun
    //! @retval    true - PDU is overrun
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Overrun();
    
    //!-------------------------------------------------------------------------
    //! @brief     Return PDU size valid status method
    //! @note      None
    //! @return    BOOL - PDU size valid status
    //! @retval    false - PDU size invalid
    //! @retval    true - PDU size valid
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    BOOL Is_Size_Valid();
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //! @brief PDU received CRC
    U16 u16_Received_CRC = (U16)0x0000;
 
  //----------------------------------------------------------------------------
  // Protected definies, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // protected variables
    //--------------------------------------------------------------------------
 
    //! @brief PDU buffer data field
    U8 u8_Buffer[ MODBUS_PDU_BUFFER_SIZE ] = { (U8)0x00 };
 
    //! @brief PDU buffer size in byte
    U32 u32_PDU_Size = (U32)0;
 
    //! @brief PDU buffer index
    U32 u32_PDU_Index = (U32)0;
 
    //! @brief PDU buffer CRC
    U16 u16_PDU_CRC = (U32)0x0000;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------