P015_09_V1_0_DIO.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P015_09_V1_0_DIO.h
//! @brief      Control board P015.09 digital I/O hardware driver header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P015_09_V1_0/P015_09_V1_0_DIO.h $
//!             $Revision: 2881 $
//!             $Date: 2021-11-04 17:20:08 +0500 (Do, 04 Nov 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// 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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definition
//------------------------------------------------------------------------------
 
//! @brief Digital I/O P015.09 V1 T1 board class
class TP015_09_V1_DIO_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public definies
    //--------------------------------------------------------------------------
 
    //! @brief Register structure for digital I/O access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification register
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Unit identification register
      U16 u16_Unit_ID_H;
 
      //! @brief 0x02 : Digital inputs
      U16 u16_Digital_Inputs;
      
      //! @brief 0x03 : Reserved
      U16 u16_Digital_Inputs_Reserve_1;
      
      //! @brief 0x04 : Reserved
      U16 u16_Digital_Inputs_Reserve_2;
      
      //! @brief 0x05 : Reserved
      U16 u16_Digital_Inputs_Reserve_3;
 
      //! @brief 0x06 : Digital outputs
      U16 u16_Digital_Outputs;
      
      //! @brief 0x07 : Set digital outputs
      U16 u16_Digital_Outputs_Set;
      
      //! @brief 0x08 : Reset digital outputs
      U16 u16_Digital_Outputs_Reset;
      
      //! @brief 0x09 : Toggle digital outputs
      U16 u16_Digital_Outputs_Toggle;
 
    } TP015_09_V1_DIO_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TP015_09_V1_DIO_T1();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP015_09_V1_DIO_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Pointer to mapped memory region
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP015_09_V1_DIO_Registers *struct_Registers_Base_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block inputs execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Inputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
        
    //!-------------------------------------------------------------------------
    //! @brief     Function block outputs execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Outputs();
    
    //!-------------------------------------------------------------------------
    //! @brief     Send function block diagnostic information method.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    //! @brief Digital output 1 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_1;
    
    //! @brief Digital output 2 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_2;
    
    //! @brief Digital output 3 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_3;
    
    //! @brief Digital output 4 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_4;
    
    //! @brief Digital output 5 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_5;
    
    //! @brief Digital output 6 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_6;
    
    //! @brief Digital output 7 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_7;
    
    //! @brief Digital output 8 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_8;
    
    //! @brief Digital output 9 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_9;
    
    //! @brief Digital output 10 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_10;
    
    //! @brief Digital output 11 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_11;
    
    //! @brief Digital output 12 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_12;
    
    //! @brief Digital output 13 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_13;
    
    //! @brief Digital output 14 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_14;
    
    //! @brief Digital output 15 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_15;
    
    //! @brief Digital output 16 signal connector
    TBlock_Input_Connector object_bool_Digital_Output_16;
    
    //! @brief Digital output signals connector
    TBlock_Input_Connector object_u16_Digital_Outputs;
 
    //! @brief Digital output test enable signal connector
    TBlock_Input_Connector object_bool_Digital_Output_Test_Enable;
    
    //! @brief Digital output test data signal connector
    TBlock_Input_Connector object_u16_Digital_Output_Test_Data;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
    //! @brief Digital input 1 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_1;
    
    //! @brief Digital input 2 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_2;
    
    //! @brief Digital input 3 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_3;
    
    //! @brief Digital input 4 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_4;
    
    //! @brief Digital input 5 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_5;
    
    //! @brief Digital input 6 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_6;
    
    //! @brief Digital input 7 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_7;
    
    //! @brief Digital input 8 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_8;
    
    //! @brief Digital input 9 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_9;
    
    //! @brief Digital input 10 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_10;
    
    //! @brief Digital input 11 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_11;
    
    //! @brief Digital input 12 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_12;
    
    //! @brief Digital input 13 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_13;
 
    //! @brief Digital input 14 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_14;
 
    //! @brief Digital input 15 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_15;
 
    //! @brief Digital input 16 signal connector
    TBlock_Output_Connector object_bool_Digital_Input_16;
 
    //! @brief Digital input signals connector
    TBlock_Output_Connector object_u16_Digital_Inputs_Status;
    
    //! @brief Digital output signals connector   
    TBlock_Output_Connector object_u16_Digital_Outputs_Status;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
    
    //! @brief Structure for digital inputs bit parsing
    typedef union
    {
      
      //! @brief Digital input data register as U16 raw data
      U16 u16_Digital_Inputs_Raw;
      
      //! @brief Digital input data as bits
      struct
      {
        
        //! @brief Bit 0 - Digital input channel 1
        U16 bit1_Channel_1:1;
          
        //! @brief Bit 1 - Digital input channel 2
        U16 bit1_Channel_2:1;
        
        //! @brief Bit 2 - Digital input channel 3
        U16 bit1_Channel_3:1;
        
        //! @brief Bit 3 - Digital input channel 4
        U16 bit1_Channel_4:1;
        
        //! @brief Bit 4 - Digital input channel 5
        U16 bit1_Channel_5:1;
        
        //! @brief Bit 5 - Digital input channel 6
        U16 bit1_Channel_6:1;
        
        //! @brief Bit 6 - Digital input channel 7
        U16 bit1_Channel_7:1;
        
        //! @brief Bit 7 - Digital input channel 8
        U16 bit1_Channel_8:1;
        
        //! @brief Bit 8 - Digital input channel 9
        U16 bit1_Channel_9:1;
        
        //! @brief Bit 9 - Digital input channel 10
        U16 bit1_Channel_10:1;
        
        //! @brief Bit 10 - Digital input channel 11
        U16 bit1_Channel_11:1;
        
        //! @brief Bit 11 - Digital input channel 12
        U16 bit1_Channel_12:1;
        
        //! @brief Bit 12 - Digital input channel 13
        U16 bit1_Channel_13:1;
        
        //! @brief Bit 13 - Digital input channel 14
        U16 bit1_Channel_14:1;
        
        //! @brief Bit 14 - Digital input channel 15
        U16 bit1_Channel_15:1;
        
        //! @brief Bit 15 - Digital input channel 16
        U16 bit1_Channel_16:1;
          
      };
      
    } TDigital_Inputs;
 
    //! @brief Structure for digital outputs bit parsing
    typedef union
    {
      
      //! @brief Digital output data register as U16 raw data
      U16 u16_Digital_Outputs_Raw;
      
      //! @brief Digital output data as bits
      struct
      {
        
        //! @brief Bit 0 - Digital output channel 1
        U16 bit1_Channel_1:1;
          
        //! @brief Bit 1 - Digital output channel 2
        U16 bit1_Channel_2:1;
        
        //! @brief Bit 2 - Digital output channel 3
        U16 bit1_Channel_3:1;
        
        //! @brief Bit 3 - Digital output channel 4
        U16 bit1_Channel_4:1;
        
        //! @brief Bit 4 - Digital output channel 5
        U16 bit1_Channel_5:1;
        
        //! @brief Bit 5 - Digital output channel 6
        U16 bit1_Channel_6:1;
        
        //! @brief Bit 6 - Digital output channel 7
        U16 bit1_Channel_7:1;
        
        //! @brief Bit 7 - Digital output channel 8
        U16 bit1_Channel_8:1;
        
        //! @brief Bit 8 - Digital output channel 9
        U16 bit1_Channel_9:1;
        
        //! @brief Bit 9 - Digital output channel 10
        U16 bit1_Channel_10:1;
        
        //! @brief Bit 10 - Digital output channel 11
        U16 bit1_Channel_11:1;
        
        //! @brief Bit 11 - Digital output channel 12
        U16 bit1_Channel_12:1;
        
        //! @brief Bit 12 - Digital output channel 13
        U16 bit1_Channel_13:1;
        
        //! @brief Bit 13 - Digital output channel 14
        U16 bit1_Channel_14:1;
        
        //! @brief Bit 14 - Digital output channel 15
        U16 bit1_Channel_15:1;
        
        //! @brief Bit 15 - Digital output channel 16
        U16 bit1_Channel_16:1;
          
      };
      
    } TDigital_Outputs;
    
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to the mapped hardware registers
    volatile TP015_09_V1_DIO_Registers *struct_Registers = (TP015_09_V1_DIO_Registers*)NULL;
 
};
 
//------------------------------------------------------------------------------
 
//! @brief Digital I/O P015.09 V1 T2 board class
class TP015_09_V1_DIO_T2 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public definies
    //--------------------------------------------------------------------------
 
    //! @brief Register structure for digital I/O access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification register
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Unit identification register
      U16 u16_Unit_ID_H;
 
      //! @brief 0x02 : Digital inputs
      U16 u16_Digital_Inputs;
      
      //! @brief 0x03 : Reserved
      U16 u16_Digital_Inputs_Reserve_1;
      
      //! @brief 0x04 : Reserved
      U16 u16_Digital_Inputs_Reserve_2;
      
      //! @brief 0x05 : Reserved
      U16 u16_Digital_Inputs_Reserve_3;
 
      //! @brief 0x06 : Digital outputs
      U16 u16_Digital_Outputs;
      
      //! @brief 0x07 : Set digital outputs
      U16 u16_Digital_Outputs_Set;
      
      //! @brief 0x08 : Reset digital outputs
      U16 u16_Digital_Outputs_Reset;
      
      //! @brief 0x09 : Toggle digital outputs
      U16 u16_Digital_Outputs_Toggle;
 
      //! @brief 0x0A : Digital inputs status register
      U16 u16_Digital_Inputs_Status;
      
      //! @brief 0x0B : Digital outputs status register
      U16 u16_Digital_Outputs_Status;
        
    } TP015_09_V1_DIO_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TP015_09_V1_DIO_T2();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP015_09_V1_DIO_T2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Pointer to mapped memory region
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP015_09_V1_DIO_Registers *struct_Registers_Base_Address );
    
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
    
    //!-------------------------------------------------------------------------
    //! @brief     Send function block diagnostic information method.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
    
    //! @brief Digital output signals connector
    TBlock_Input_Connector object_u16_Digital_Outputs;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
    //! @brief Digital input signals connector
    TBlock_Output_Connector object_u16_Digital_Inputs;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
        
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to the mapped hardware registers
    volatile TP015_09_V1_DIO_Registers *struct_Registers = (TP015_09_V1_DIO_Registers*)NULL;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------