P005_06_V2_0_DIO.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P005_06_V2_0_DIO.h
//! @brief      Digital I/O board P005.06 V2.0 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/P005_06_V2_0_DIO/P005_06_V2_0_DIO.h $
//!             $Revision: 2931 $
//!             $Date: 2022-02-13 10:39:30 +0500 (So, 13 Feb 2022) $
//!             $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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//! @brief Digital I/O P005.06 V2.0 board TP005_06_V2_0_DIO class
class TP005_06_V2_0_DIO : public TFunction_Block_Base
{
 
  //--------------------------------------------------------------------------
  // Public methods and variables
  //--------------------------------------------------------------------------
 
  public:
 
    //! @brief Register structure for digital I/O access
    typedef struct
    {
 
      // Digital inputs
      U16 u16_Digital_Inputs;
      U16 u16_Digital_Inputs_Reserve_1;
      U16 u16_Digital_Inputs_Reserve_2;
      U16 u16_Digital_Inputs_Reserve_3;
 
      // Digital outputs
      U16 u16_Digital_Outputs;
      U16 u16_Digital_Outputs_Reserve_1;
      U16 u16_Digital_Outputs_Reserve_2;
      U16 u16_Digital_Outputs_Reserve_3;
 
    } TP005_06_V2_0_DIO_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP005_06_V2_0_DIO(); //!< Constrructor method
    ~TP005_06_V2_0_DIO(); //!< Destructor method
 
    VOID Map( TP005_06_V2_0_DIO_Registers *struct_Registers_Base_Address ); //!< Map method
    virtual VOID Init(); //!< Block initialization method
    virtual VOID Execute(); //!< Block execution method
    VOID Execute_Inputs();
    VOID Execute_Outputs();
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    // Input signals
 
    TBlock_Output_Connector object_bool_Digital_Input_1;
    TBlock_Output_Connector object_bool_Digital_Input_2;
    TBlock_Output_Connector object_bool_Digital_Input_3;
    TBlock_Output_Connector object_bool_Digital_Input_4;
    TBlock_Output_Connector object_bool_Digital_Input_5;
    TBlock_Output_Connector object_bool_Digital_Input_6;
    TBlock_Output_Connector object_bool_Digital_Input_7;
    TBlock_Output_Connector object_bool_Digital_Input_8;
 
    // Output signals
 
    TBlock_Input_Connector object_bool_Digital_Output_1;
    TBlock_Input_Connector object_bool_Digital_Output_2;
    TBlock_Input_Connector object_bool_Digital_Output_3;
    TBlock_Input_Connector object_bool_Digital_Output_4;
    TBlock_Input_Connector object_bool_Digital_Output_5;
    TBlock_Input_Connector object_bool_Digital_Output_6;
    TBlock_Input_Connector object_bool_Digital_Output_7;
    TBlock_Input_Connector object_bool_Digital_Output_8;
    TBlock_Input_Connector object_bool_Digital_Output_9;
 
    TBlock_Output_Connector object_u16_Digital_Inputs_Status;
    TBlock_Output_Connector object_u16_Digital_Outputs_Status;
 
  //--------------------------------------------------------------------------
  // Protected mathods and variables
  //--------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private mathods and variables
  //--------------------------------------------------------------------------
 
  private:
 
    // Structure for bit parsing
    typedef union
    {
      U16 u16_Channels;
      struct
      {
        U16 bool_Channel_1:1;
        U16 bool_Channel_2:1;
        U16 bool_Channel_3:1;
        U16 bool_Channel_4:1;
        U16 bool_Channel_5:1;
        U16 bool_Channel_6:1;
        U16 bool_Channel_7:1;
        U16 bool_Channel_8:1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;
      };
    } TChannels;
 
    volatile TP005_06_V2_0_DIO_Registers *struct_Registers;
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------