P014_47_V1_0_PFOTX.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P014_47_V1_0_PFOTX.h
//! @brief      Plastic fiber optic TX board P014.47 V1.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/P014_47_V1_0_PFOTX/P014_47_V1_0_PFOTX.h $
//!             $Revision: 2262 $
//!             $Date: 2020-12-05 07:20:48 +0500 (Sa, 05 Dez 2020) $
//!             $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 "Functional_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Plastic fiber optic TX board P014.47 V1.0 class
//------------------------------------------------------------------------------
 
class TP014_47_V1_0_PFOTX : public TFunctional_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type definitions
    //--------------------------------------------------------------------------
 
    // Register structure for generic access
    typedef struct
    {
 
      union
      {
        U16 u16_TX_Channels_Status;   //!< Fiber optic transmitter status signal
        U16 u16_TX_Channels_Write;    //!< Write fiber optic channels test register
      };
      
      U16 u16_TX_Channel_Set;         //!< Set fiber optic channels test register
      U16 u16_TX_Channel_Clear;       //!< Clear fiber optic channels test register
      U16 u16_TX_Channel_Toggle;      //!< Toggle fiber optic channels test register
 
    } TP014_47_V1_0_PFOTX_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP014_47_V1_0_PFOTX(); //!< Constructor method
    ~TP014_47_V1_0_PFOTX(); //!< Destructor method
 
    VOID Map( TP014_47_V1_0_PFOTX_Registers *struct_Registers_Base_Address );
    virtual VOID Init();
    virtual VOID Execute();
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
    
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
    
    TBlock_Output_Connector object_u16_Channels_Status;
    TBlock_Output_Connector object_bool_Channel_1_Status;
    TBlock_Output_Connector object_bool_Channel_2_Status;
    TBlock_Output_Connector object_bool_Channel_3_Status;
    TBlock_Output_Connector object_bool_Channel_4_Status;
    TBlock_Output_Connector object_bool_Channel_5_Status;
    TBlock_Output_Connector object_bool_Channel_6_Status;
    TBlock_Output_Connector object_bool_Channel_7_Status;
    TBlock_Output_Connector object_bool_Channel_8_Status;
    TBlock_Output_Connector object_bool_Channel_9_Status;
    TBlock_Output_Connector object_bool_Channel_10_Status;
    TBlock_Output_Connector object_bool_Channel_11_Status;
    TBlock_Output_Connector object_bool_Channel_12_Status;
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
    
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
  
    typedef union
    {
      U16 u16_Channels;
      struct
      {
        U16 u16_Channel_1:1;
        U16 u16_Channel_2:1;
        U16 u16_Channel_3:1;
        U16 u16_Channel_4:1;
        U16 u16_Channel_5:1;
        U16 u16_Channel_6:1;
        U16 u16_Channel_7:1;        
        U16 u16_Channel_8:1;
        U16 u16_Channel_9:1;
        U16 u16_Channel_10:1;
        U16 u16_Channel_11:1;
        U16 u16_Channel_12:1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;       
      };
    } TStatus;
 
    volatile TP014_47_V1_0_PFOTX_Registers *struct_Registers;
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------