/**********************************************************************
    The following code is derived, directly or indirectly, from the SystemC
    source code Copyright (c) 1996-2008 by all Contributors.
    All Rights reserved.
 
    The contents of this file are subject to the restrictions and limitations
    set forth in the SystemC Open Source License Version 3.0 (the "License");
    You may not use this file except in compliance with such restrictions and
    limitations. You may obtain instructions on how to receive a copy of the
    License at http://www.systemc.org/. Software distributed by Contributors
    under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
    ANY KIND, either express or implied. See the License for the specific
    language governing rights and limitations under the License.
**********************************************************************/
//=====================================================================
/// @file initiator_top.cpp
//
/// @brief Implements instantiation and interconnect of traffic_generator 
///        and an initiator via sc_fifos for at_1_phase_example
//
//=====================================================================
//  Original Authors:
//    Bill Bunton, ESLX
//    Charles Wilson, ESLX
//    Anna Keist, ESLX
//    Jack Donovan, ESLX
//=====================================================================


#include "initiator_top.h"                           // Top traffic generator & initiator
#include "reporting.h"                               // reporting macro helpers

static const char *filename = "initiator_top.cpp";  ///< filename for reporting

/// Constructor

initiator_top::initiator_top    		       
( sc_core::sc_module_name name                    
, const unsigned int    ID                        
, sc_dt::uint64         base_address_1            
, sc_dt::uint64         base_address_2
, unsigned int          active_txn_count  
) 
  :sc_module          (name) 	                // module name for top
  
  ,initiator_socket   ("at_initiator_socket") // TLM socket
  
  ,m_ID                (ID)                   // initiator ID
  
  ,m_initiator                                // Init initiator
    ("m_initiator_1_phase"                                            
    ,ID                                           
    ,sc_core::sc_time(7, sc_core::SC_NS)      // set initiator end rsp delay
    )
    
  ,m_traffic_gen                              // Init traffic Generator
    ("m_traffic_gen"                              
    ,ID
    ,base_address_1                           // first base address
    ,base_address_2                           // second base address
    ,active_txn_count                         // Max active transactions
    )

{
  /// Bind ports to m_request_fifo between m_initiator and m_traffic_gen
  m_traffic_gen.request_out_port  (m_request_fifo);
  m_initiator.request_in_port     (m_request_fifo);
  
  /// Bind ports to m_response_fifo between m_initiator and m_traffic_gen
  m_initiator.response_out_port   (m_response_fifo);
  m_traffic_gen.response_in_port  (m_response_fifo);

  /// Bind initiator-socket to initiator-socket hierarchical connection 
  m_initiator.initiator_socket(initiator_socket);
}

//=====================================================================
///  @fn initiator_top::invalidate_direct_mem_ptr
/// 	    
///  @brief Unused mandatory virtual implementation
///  
///  @details
///    No DMI is implemented in this example so unused
///
//===================================================================== 
  void												
  initiator_top::invalidate_direct_mem_ptr					
  ( sc_dt::uint64      start_range                        
  , sc_dt::uint64      end_range                 
  )
  {  
    std::ostringstream       msg;          // log message
    msg.str ("");
	
    msg << "Initiator: " << m_ID << " Not implemented";
    REPORT_ERROR(filename, __FUNCTION__, msg.str());	  
  } // end invalidate_direct_mem_ptr
  
 //=====================================================================
 ///  @fn initiator_top::nb_transport_bw
 //  	    
 ///  @brief Unused mandatory virtual implementation
 ///           	    
 ///  @details
 ///    Unused implementation from hierarchichal connectivity of
 ///    Initiator sockets.
 ///
 //===================================================================== 
tlm::tlm_sync_enum	 
initiator_top::nb_transport_bw								
( tlm::tlm_generic_payload  &payload
, tlm::tlm_phase            &phase
, sc_core::sc_time          &delta
)
{
  std::ostringstream       msg;                 // log message
  msg.str ("");
	  
  msg << "Initiator: " << m_ID 
      << " Not implemented, for hierachical connection of initiator socket";
  REPORT_ERROR(filename, __FUNCTION__, msg.str());
	  
  return tlm::TLM_COMPLETED;  

 } // end nb_transport_bw
