verif/model/pcie/pcie_common/packet_if.hpp

// ========== Copyright Header Begin ==========================================
//
// OpenSPARC T2 Processor File: packet_if.hpp
// Copyright (C) 1995-2007 Sun Microsystems, Inc. All Rights Reserved
// 4150 Network Circle, Santa Clara, California 95054, U.S.A.
//
// * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// For the avoidance of doubt, and except that if any non-GPL license
// choice is available it will apply instead, Sun elects to use only
// the General Public License version 2 (GPLv2) at this time for any
// software where a choice of GPL license versions is made
// available with the language indicating that GPLv2 or any later version
// may be used, or where a choice of which version of the GPL is applied is
// otherwise unspecified.
//
// Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
// CA 95054 USA or visit www.sun.com if you need additional information or
// have any questions.
//
// ========== Copyright Header End ============================================
#ifndef INC_packet_if_hpp__
#define INC_packet_if_hpp__

#include <systemc.h>

namespace pcie {
  template <typename PACKET>
  class packet_in_if : public virtual sc_interface
  {
  public:

        virtual int get_packet(PACKET &p) = 0;
        virtual bool get_packet_nb(PACKET &p) = 0;
        virtual bool is_packet_ready() = 0;

  };

  template <typename PACKET>
  class packet_out_if : public virtual sc_interface
  {
  public:

        virtual int send_packet(const PACKET &p) = 0;
        virtual void purge_channel() = 0;
  };

  template <typename PACKET>
  class packet_if :
        public virtual packet_in_if<PACKET> ,
        public virtual packet_out_if<PACKET>
  {  };

}; // namespace pcie

#endif //INC_packet_if_hpp__