FPGA_P017_39_KG3_CB.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      FPGA_P017_39_KG3_CB.h
//! @brief     FPGA driver calss header file for P017_39_KG3_CB.
//! @copyright ANVILEX GmbH
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P017_39_KG3_CB/FPGA_P017_39_KG3_CB.h $
//!            $Revision: 2053 $
//!            $Date: 2020-09-06 02:16:27 +0500 (So, 06 Sep 2020) $
//!            $Author: minch $
//
// Copyright(C) 2004-2020 ANVILEX GmbH
//
// 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 standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "FPGA_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declaration
//------------------------------------------------------------------------------
 
//! @brief FPGA hardware dependent driver class for P017_39_KG3_CB
class TFPGA_P017_39_KG3_CB : public TFPGA_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public enumerators
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Public structures
    //--------------------------------------------------------------------------
  
    //!-------------------------------------------------------------------------
    //! @brief     FPGA base class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TFPGA_P017_39_KG3_CB();
    
    //!-------------------------------------------------------------------------
    //! @brief     FPGA base class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFPGA_P017_39_KG3_CB();
    
    //!-------------------------------------------------------------------------
    //! @brief     FPGA interrupt processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    VOID Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Configure FPGA method.
    //! @note      None
    //! @return    BOOL - Return FPGA present status
    //! @retval    false - Load FPGA configuration failed
    //! @retval    true - Load FPGA configuration sucessed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Configure();
    
    //!-------------------------------------------------------------------------
    //! @brief     Enable FPGA interrupt method.
    //! @note      None
    //! @param     [in] u32_TickPriority - Priority
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Interrupt_Enable( U32 u32_TickPriority );
    
    //!-------------------------------------------------------------------------
    //! @brief     Disable FPGA interrupt method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Interrupt_Disable();
    
    //!-------------------------------------------------------------------------
    //! @brief     Get FPGA PROG pin status method.
    //! @note      None
    //! @return    BOOL - Return FPGA PROG pin status
    //! @retval    false - FPGA PROG pin is low
    //! @retval    true - FPGA PROG pin is high
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL FPGA_PROG_Pin_Status();
    
    //!-------------------------------------------------------------------------
    //! @brief     Get FPGA DONE pin status method.
    //! @note      None
    //! @return    BOOL - Return FPGA DONE pin status
    //! @retval    false - FPGA DONE pin is low
    //! @retval    true - FPGA DONE pin is high
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual BOOL FPGA_DONE_Pin_Status();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send boot ststus information message about FPGA driver over communication link protocol
    //! @note      This method sends boot ststus information about FPGA driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Boot_Information( TProtocol_Base *object_Protocol );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected enumerators
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Public structures
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private enumerators
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Private structures
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------