From e035224754ff5a0f6bd90b6c2f7821db42d53bdb Mon Sep 17 00:00:00 2001
From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Sun, 22 Jul 2018 10:02:38 +0100
Subject: [PATCH] add soc_template.bsv, remove unneeded files

---
 src/bsv/bsv_lib/gpio.bsv         | 264 ------------------------
 src/bsv/bsv_lib/mux.bsv          |  97 ---------
 src/bsv/bsv_lib/soc_template.bsv | 331 +++++++++++++++++++++++++++++++
 3 files changed, 331 insertions(+), 361 deletions(-)
 delete mode 100644 src/bsv/bsv_lib/gpio.bsv
 delete mode 100644 src/bsv/bsv_lib/mux.bsv
 create mode 100644 src/bsv/bsv_lib/soc_template.bsv

diff --git a/src/bsv/bsv_lib/gpio.bsv b/src/bsv/bsv_lib/gpio.bsv
deleted file mode 100644
index 3ac83ba..0000000
--- a/src/bsv/bsv_lib/gpio.bsv
+++ /dev/null
@@ -1,264 +0,0 @@
-/*
-Copyright (c) 2013, IIT Madras
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-*  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-*  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.
-*  Neither the name of IIT Madras  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. 
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-*/
-package gpio;
-	/*==== Package imports ==== */
-	import TriState          ::*;
-	import Vector				 ::*;
-	import BUtils::*;
-	import ConfigReg			::*;
-	/*============================ */
-	/*===== Project Imports ===== */
-	import Semi_FIFOF        :: *;
-	import AXI4_Lite_Types   :: *;
-	/*============================ */
-	`include "instance_defines.bsv"
-
-	interface GPIO_func#(numeric type ionum);
-		(*always_ready,always_enabled*)
-		method Action gpio_in (Vector#(ionum,Bit#(1)) inp);
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_out;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_out_en;
-  endinterface
-	interface GPIO_config#(numeric type ionum);
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_DRV0;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_DRV1;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_DRV2;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_PD;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_PPEN;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_PRG_SLEW;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_PUQ;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_PWRUPZHL;
-		(*always_ready*)
-		method Vector#(ionum,Bit#(1))   gpio_PWRUP_PULL_EN;
-  endinterface
-  interface GPIO#(numeric type ionum);
-    interface GPIO_config#(ionum) pad_config;
-    interface GPIO_func#(ionum) func;
-		interface AXI4_Lite_Slave_IFC#(`ADDR,`DATA,`USERSPACE) axi_slave;
-	endinterface
-
-	module mkgpio(GPIO#(ionum_));
-    let ionum = valueOf(ionum_);
-		Vector#(ionum_,ConfigReg#(Bool)) direction_reg			<-replicateM(mkConfigReg(False));
-		Vector#(ionum_,ConfigReg#(Bit#(1))) dataout_register	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) datain_register	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) drv0_reg	<-replicateM(mkConfigReg(1'b1));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) drv1_reg	<-replicateM(mkConfigReg(1'b1));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) drv2_reg	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) pd_reg	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) ppen_reg	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) prg_slew_reg	<-replicateM(mkConfigReg(1'b1));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) puq_reg	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) pwrupzhl_reg	<-replicateM(mkConfigReg(0));	
-		Vector#(ionum_,ConfigReg#(Bit#(1))) pwrup_pull_en_reg	<-replicateM(mkConfigReg(0));	
-		
-		AXI4_Lite_Slave_Xactor_IFC #(`ADDR, `DATA, `USERSPACE)  s_xactor <- mkAXI4_Lite_Slave_Xactor;
-		rule rl_wr_respond;
-			// Get the wr request
-      	let aw <- pop_o (s_xactor.o_wr_addr);
-      	let w  <- pop_o (s_xactor.o_wr_data);
-	   	let b = AXI4_Lite_Wr_Resp {bresp: AXI4_LITE_OKAY, buser: aw.awuser};
-			if(aw.awaddr[5:0]=='h0)
-				for(Integer i=0;i<ionum;i=i+1)
-					direction_reg[i]<=unpack(w.wdata[i]);
-			else if(aw.awaddr[5:0]=='h4)
-				for(Integer i=0;i<ionum;i=i+1)
-					dataout_register[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h8)
-				for(Integer i=0;i<ionum;i=i+1)
-					drv0_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='hC)
-				for(Integer i=0;i<ionum;i=i+1)
-					drv1_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h10)
-				for(Integer i=0;i<ionum;i=i+1)
-					drv2_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h14)
-				for(Integer i=0;i<ionum;i=i+1)
-					pd_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h18)
-				for(Integer i=0;i<ionum;i=i+1)
-					ppen_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h1C)
-				for(Integer i=0;i<ionum;i=i+1)
-					prg_slew_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h20)
-				for(Integer i=0;i<ionum;i=i+1)
-					puq_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h24)
-				for(Integer i=0;i<ionum;i=i+1)
-					pwrupzhl_reg[i]<=w.wdata[i];
-			else if(aw.awaddr[5:0]=='h28)
-				for(Integer i=0;i<ionum;i=i+1)
-					pwrup_pull_en_reg[i]<=w.wdata[i];
-			else
-				b.bresp=AXI4_LITE_SLVERR;
-				
-      	s_xactor.i_wr_resp.enq (b);
-		endrule
-
-		rule rl_rd_respond;
-			let ar<- pop_o(s_xactor.o_rd_addr);
-			Bit#(32) temp=0;
-			AXI4_Lite_Rd_Data#(`DATA,`USERSPACE) r = AXI4_Lite_Rd_Data {rresp: AXI4_LITE_OKAY, rdata: ?, ruser: 0};
-			if(ar.araddr[5:0]=='h0)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=pack(direction_reg[i]);
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h4)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=datain_register[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h8)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=drv0_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='hC)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=drv1_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h10)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=drv2_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h14)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=pd_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h18)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=ppen_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h1C)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=prg_slew_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h20)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=puq_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h24)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=pwrupzhl_reg[i];
-				r.rdata=duplicate(temp);
-			end
-			else if(ar.araddr[5:0]=='h28)begin
-				for(Integer i=0;i<ionum;i=i+1)
-					temp[i]=pwrup_pull_en_reg[i];
-				r.rdata=duplicate(temp);
-      end
-			else
-				r.rresp=AXI4_LITE_SLVERR;
-				
-			s_xactor.i_rd_data.enq(r);
-		endrule
-
-		interface axi_slave= s_xactor.axi_side;
-    interface func=interface GPIO_func
-    	method Action gpio_in (Vector#(ionum,Bit#(1)) inp);
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			datain_register[i]<=inp[i];
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_out;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=dataout_register[i];
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_out_en;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(direction_reg[i]);
-	  		return temp;
-	  	endmethod
-    endinterface;
-    interface pad_config=interface GPIO_config
-	  	method Vector#(ionum,Bit#(1))   gpio_DRV0;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(drv0_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_DRV1;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(drv1_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_DRV2;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(drv2_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_PD;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(pd_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_PPEN;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(ppen_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_PRG_SLEW;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(prg_slew_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_PUQ;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(puq_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_PWRUPZHL;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(pwrupzhl_reg[i]);
-	  		return temp;
-	  	endmethod
-	  	method Vector#(ionum,Bit#(1))   gpio_PWRUP_PULL_EN;
-	  		Vector#(ionum,Bit#(1)) temp;
-	  		for(Integer i=0;i<ionum;i=i+1)
-	  			temp[i]=pack(pwrup_pull_en_reg[i]);
-	  		return temp;
-	  	endmethod
-    endinterface;
-	endmodule
-
-endpackage
-
diff --git a/src/bsv/bsv_lib/mux.bsv b/src/bsv/bsv_lib/mux.bsv
deleted file mode 100644
index cb67458..0000000
--- a/src/bsv/bsv_lib/mux.bsv
+++ /dev/null
@@ -1,97 +0,0 @@
-/*
-Copyright (c) 2013, IIT Madras
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-*  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-*  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.
-*  Neither the name of IIT Madras  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. 
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-*/
-package mux;
-	/*==== Package imports ==== */
-	import TriState          ::*;
-	import Vector				 ::*;
-	import BUtils::*;
-	import ConfigReg			::*;
-	/*============================ */
-	/*===== Project Imports ===== */
-	import Semi_FIFOF        :: *;
-	import AXI4_Lite_Types   :: *;
-	/*============================ */
-    `include "instance_defines.bsv"
-
-    interface MUX_config#(numeric type ionum);
-		(*always_ready,always_enabled*)
-		method Vector#(ionum,Bit#(2))   mux;
-    endinterface
-
-	interface MUX#(numeric type ionum);
-        interface MUX_config#(ionum) mux_config;
-            interface AXI4_Lite_Slave_IFC#(`ADDR,`DATA,`USERSPACE) axi_slave;
-	endinterface
-
-//	(*synthesize*)
-	module mkmux(MUX#(ionum_));
-	  Vector#(ionum_,ConfigReg#(Bit#(2))) muxer_reg 				<-replicateM(mkConfigReg(0));
-		
-		AXI4_Lite_Slave_Xactor_IFC #(`ADDR, `DATA, `USERSPACE)  s_xactor <- mkAXI4_Lite_Slave_Xactor;
-    let ionum=valueOf(ionum_);
-		rule rl_wr_respond;
-			// Get the wr request
-            //aw is write address, w is write data
-      let aw <- pop_o (s_xactor.o_wr_addr);
-      let w  <- pop_o (s_xactor.o_wr_data);
-	   	let b = AXI4_Lite_Wr_Resp {bresp: AXI4_LITE_OKAY, buser: aw.awuser};
-		  if(aw.awaddr[5:0]=='h0)
-		    for(Integer i=0;i<min(ionum, 16);i=i+1) begin
-          muxer_reg[i]<= w.wdata[i*2+1:i*2];
-		  	end
-		  else if(aw.awaddr[5:0]=='h4 && ionum>=16)
-		  	for(Integer i=0;i<ionum-16;i=i+1) begin
-          muxer_reg[i+16]<= w.wdata[i*2+1:i*2];
-		  	end
-			else
-				b.bresp=AXI4_LITE_SLVERR;
-      	s_xactor.i_wr_resp.enq (b);
-		endrule
-
-		rule rl_rd_respond;
-            // Get the read request
-            //ar is read address, r is read data
-			let ar<- pop_o(s_xactor.o_rd_addr);
-			Bit#(32) temp=0;
-			AXI4_Lite_Rd_Data#(`DATA,`USERSPACE) r = AXI4_Lite_Rd_Data {rresp: AXI4_LITE_OKAY, rdata: ?, ruser: 0};
-		  if(ar.araddr[5:0]=='h0)begin
-		  	for(Integer i=0;i<min(ionum, 16);i=i+1) begin
-          temp[i*2+ 1:i*2]=muxer_reg[i];
-		  	end
-        r.rdata=duplicate(temp);
-      end
-		  else if(ar.araddr[5:0]=='h4 && ionum>=16)begin
-		  	for(Integer i=0;i<ionum-16;i=i+1) begin
-          temp[i*2+ 1:i*2]=muxer_reg[i+ 16];
-		  	end
-        r.rdata=duplicate(temp);
-      end
-			else
-				r.rresp=AXI4_LITE_SLVERR;
-			s_xactor.i_rd_data.enq(r);
-		endrule
-
-		interface axi_slave= s_xactor.axi_side;
-    interface mux_config=interface MUX_config
-		method Vector#(ionum,Bit#(2))   mux;
-			Vector#(ionum,Bit#(2)) temp;
-			for(Integer i=0;i<ionum;i=i+1)
-				temp[i]=pack(muxer_reg[i]);
-			return temp;
-		endmethod
-    endinterface;
-	endmodule
-
-endpackage
-
diff --git a/src/bsv/bsv_lib/soc_template.bsv b/src/bsv/bsv_lib/soc_template.bsv
new file mode 100644
index 0000000..e7915c0
--- /dev/null
+++ b/src/bsv/bsv_lib/soc_template.bsv
@@ -0,0 +1,331 @@
+/*
+Copyright (c) 2013, IIT Madras
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+*  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+*  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.
+*  Neither the name of IIT Madras  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. 
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+*/
+package Soc;
+	/*====== Package imports === */
+	import FIFO::*;
+	import FIFOF::*;
+	import SpecialFIFOs::*;
+	import GetPut::*;
+	import ClientServer::*;
+	import Vector::*;
+	import Connectable::*;
+	import Clocks::*;
+	/*========================== */
+	/*=== Project imports === */
+	import ConcatReg::*;
+	import AXI4_Types::*;
+	import AXI4_Fabric::*;
+	import defined_types::*;
+	import MemoryMap		 :: *;
+	import slow_peripherals::*;
+	`include "defines.bsv"
+	`include "instance_defines.bsv"
+
+		`ifdef DMA
+			import DMA				 :: *;
+		`endif
+		`ifdef BOOTROM
+			import BootRom			::*;
+		`endif
+		`ifdef SDRAM
+			import sdr_top			 :: *;
+    `endif
+		`ifdef BRAM
+			import Memory_AXI4	::*;
+		`endif
+		`ifdef TCMemory
+			import TCM::*;
+		`endif
+		`ifdef Debug
+			import jtagdtm::*;
+			import DebugModule::*;
+		`else
+			import core::*;
+		`endif
+`ifdef  VME
+			import vme_top ::*;
+`endif
+
+`ifdef VME
+			import vme_master::*;
+`endif
+`ifdef FlexBus
+            import FlexBus_Types::*;
+`endif
+
+	/*========================= */
+	interface Ifc_Soc;
+		interface SP_ios slow_ios;
+		(*always_ready,always_enabled*)
+		method Action boot_sequence(Bit#(1) bootseq);
+		
+		  `ifdef SDRAM 
+	  		(*always_ready*) interface Ifc_sdram_out sdram_out; 
+  		`endif
+      `ifdef DDR
+        (*prefix="M_AXI"*) interface AXI4_Master_IFC#(`PADDR, `Reg_width, `USERSPACE) master;
+      `endif
+      `ifdef Debug
+			(*always_ready,always_enabled*)
+			method Action tms_i(Bit#(1) tms);
+			(*always_ready,always_enabled*)
+			method Action tdi_i(Bit#(1) tdi);
+			(*always_ready,always_enabled*)
+			method Action bs_chain_i(Bit#(1) bs_chain);
+			(*always_ready,always_enabled*)
+			method Bit#(1) shiftBscan2Edge;
+			(*always_ready,always_enabled*)
+			method Bit#(1) selectJtagInput;
+			(*always_ready,always_enabled*)
+			method Bit#(1) selectJtagOutput;
+			(*always_ready,always_enabled*)
+			method Bit#(1) updateBscan;
+			(*always_ready,always_enabled*)
+			method Bit#(1) bscan_in;
+			(*always_ready,always_enabled*)
+			method Bit#(1) scan_shift_en;
+			(*always_ready,always_enabled*)
+			method Bit#(1) tdo;
+			(*always_ready,always_enabled*)
+			method Bit#(1) tdo_oe;
+		`endif
+		`ifdef HYPER
+			(*always_ready,always_enabled*)	
+		   interface Ifc_flash ifc_flash;
+		`endif
+	/*=============================================== */
+	   `ifdef VME
+        		interface Vme_out  proc_ifc;
+			interface Data_bus_inf proc_dbus;
+		`endif
+        `ifdef FlexBus
+            interface FlexBus_Master_IFC flexbus_out;
+        `endif
+
+	endinterface
+	(*synthesize*)
+	module mkSoc #(Bit#(`VADDR) reset_vector, Clock slow_clock, Reset slow_reset, Clock uart_clock, 
+                 Reset uart_reset, Clock clk0, Clock tck, Reset trst
+                 `ifdef PWM_AXI4Lite ,Clock ext_pwm_clock `endif )(Ifc_Soc);
+		Clock core_clock <-exposeCurrentClock; // slow peripheral clock
+		Reset core_reset <-exposeCurrentReset; // slow peripheral reset
+      `ifdef Debug 
+			Ifc_jtagdtm tap <-mkjtagdtm(clocked_by tck, reset_by trst);
+         rule drive_tmp_scan_outs;
+             tap.scan_out_1_i(1'b0);
+             tap.scan_out_2_i(1'b0);
+             tap.scan_out_3_i(1'b0);
+             tap.scan_out_4_i(1'b0);
+             tap.scan_out_5_i(1'b0);
+         endrule
+			Ifc_DebugModule core<-mkDebugModule(reset_vector);
+		`else
+			Ifc_core_AXI4 core <-mkcore_AXI4(reset_vector);
+		`endif
+		`ifdef BOOTROM
+			BootRom_IFC bootrom <-mkBootRom;
+		`endif
+		`ifdef SDRAM
+			Ifc_sdr_slave			sdram				<- mksdr_axi4_slave(clk0);
+		`endif
+    `ifdef BRAM
+			Memory_IFC#(`SDRAMMemBase,`Addr_space) main_memory <- mkMemory("code.mem.MSB","code.mem.LSB","MainMEM");
+		`endif
+		`ifdef TCMemory
+			Ifc_TCM					tcm				<- mkTCM;	
+		`endif
+		`ifdef DMA
+			DmaC#(7,12)				dma				<- mkDMA();
+		`endif
+			`ifdef VME
+			Ifc_vme_top             vme             <-mkvme_top();
+			`endif	
+        `ifdef FlexBus
+            AXI4_Slave_to_FlexBus_Master_Xactor_IFC #(32, 64,0)
+                                            flexbus <- mkAXI4_Slave_to_FlexBus_Master_Xactor;
+        `endif
+		Ifc_slow_peripherals slow_peripherals <-mkslow_peripherals(core_clock, core_reset, uart_clock, 
+          uart_reset, clocked_by slow_clock , reset_by slow_reset 
+          `ifdef PWM_AXI4Lite , ext_pwm_clock `endif );	
+
+   	// Fabric
+   	AXI4_Fabric_IFC #(Num_Masters, Num_Slaves, `PADDR, `Reg_width,`USERSPACE)
+		 		fabric <- mkAXI4_Fabric(fn_addr_to_slave_num);
+
+   	// Connect traffic generators to fabric
+   	mkConnection (core.dmem_master,	fabric.v_from_masters [fromInteger(valueOf(Dmem_master_num))]);
+   	mkConnection (core.imem_master,	fabric.v_from_masters [fromInteger(valueOf(Imem_master_num))]);
+		`ifdef Debug
+			mkConnection (core.debug_master, fabric.v_from_masters [fromInteger(valueOf(Debug_master_num))]);
+		`endif
+		`ifdef DMA
+         mkConnection (dma.mmu, fabric.v_from_masters[fromInteger(valueOf(DMA_master_num))]);
+		`endif
+
+
+		// Connect fabric to memory slaves
+			`ifdef Debug
+				mkConnection (fabric.v_to_slaves [fromInteger(valueOf(Debug_slave_num))],core.debug_slave);
+			`endif
+			`ifdef SDRAM	
+				mkConnection (fabric.v_to_slaves [fromInteger(valueOf(Sdram_slave_num))],	sdram.axi4_slave_sdram); // 
+	   		mkConnection (fabric.v_to_slaves [fromInteger(valueOf(Sdram_cfg_slave_num))],	sdram.axi4_slave_cntrl_reg); // 
+      `endif
+      `ifdef BRAM
+				mkConnection(fabric.v_to_slaves[fromInteger(valueOf(Sdram_slave_num))],main_memory.axi_slave);
+			`endif
+			`ifdef BOOTROM
+				mkConnection (fabric.v_to_slaves [fromInteger(valueOf(BootRom_slave_num))],bootrom.axi_slave);
+			`endif
+			`ifdef DMA
+   			mkConnection (fabric.v_to_slaves [fromInteger(valueOf(Dma_slave_num))],	dma.cfg); //DMA slave
+			`endif
+			`ifdef TCMemory
+				mkConnection (fabric.v_to_slaves [fromInteger(valueOf(TCM_slave_num))],tcm.axi_slave);
+			`endif
+			mkConnection(fabric.v_to_slaves [fromInteger(valueOf(SlowPeripheral_slave_num))],slow_peripherals.axi_slave);
+			`ifdef VME
+				mkConnection (fabric.v_to_slaves[fromInteger(valueOf(VME_slave_num))],vme.slave_axi_vme);
+			`endif
+			`ifdef FlexBus
+				mkConnection (fabric.v_to_slaves[fromInteger(valueOf(FlexBus_slave_num))],flexbus.axi_side);
+			`endif
+			`ifdef DMA
+			//rule to connect all interrupt lines to the DMA
+			//All the interrupt lines to DMA are active HIGH. For peripherals that are not connected, or those which do not
+			//generate an interrupt (like TCM), drive a constant 1 on the corresponding interrupt line.
+				`ifdef I2C1 SyncBitIfc#(Bit#(1)) i2c1_interrupt <-mkSyncBitToCC(slow_clock,slow_reset); `endif
+				`ifdef I2C0 SyncBitIfc#(Bit#(1)) i2c0_interrupt <-mkSyncBitToCC(slow_clock,slow_reset); `endif
+				`ifdef QSPI1 SyncBitIfc#(Bit#(1)) qspi1_interrupt <-mkSyncBitToCC(slow_clock,slow_reset); `endif
+				`ifdef QSPI0 SyncBitIfc#(Bit#(1)) qspi0_interrupt <-mkSyncBitToCC(slow_clock,slow_reset); `endif
+				`ifdef UART0 SyncBitIfc#(Bit#(1)) uart0_interrupt <-mkSyncBitToCC(uart_clock,uart_reset); `endif
+				rule synchronize_i2c_interrupts;
+					`ifdef I2C1 i2c1_interrupt.send(slow_peripherals.i2c1_isint); `endif
+					`ifdef I2C0 i2c0_interrupt.send(slow_peripherals.i2c0_isint); `endif
+				endrule
+				rule synchronize_qspi_interrupts;
+					`ifdef QSPI0 qspi0_interrupt.send(slow_peripherals.qspi0_isint); `endif
+					`ifdef QSPI1 qspi1_interrupt.send(slow_peripherals.qspi1_isint); `endif
+				endrule
+				rule synchronize_uart0_interrupt;
+					`ifdef UART0 uart0_interrupt.send(slow_peripherals.uart0_intr); `endif
+				endrule
+				rule rl_connect_interrupt_to_DMA;
+					Bit#(12) lv_interrupt_to_DMA= {'d-1, 
+															`ifdef I2C1 i2c1_interrupt.read `else 1'b1 `endif , 
+															`ifdef I2C0 i2c0_interrupt.read `else 1'b1 `endif , 
+															`ifdef QSPI1 qspi1_interrupt.read `else 1'b1 `endif ,
+															1'b1, 
+															`ifdef QSPI0 qspi0_interrupt.read `else 1'b1 `endif , 
+															1'b1,1'b0, 
+															`ifdef UART0 uart0_interrupt.read `else 1'b1 `endif };
+					dma.interrupt_from_peripherals(lv_interrupt_to_DMA);
+				endrule
+			`endif
+
+
+		/*======= Synchornization between the JTAG and the Debug Module ========= */
+		`ifdef Debug
+			SyncFIFOIfc#(Bit#(40)) sync_request_to_dm <-mkSyncFIFOToCC(1,tck,trst);
+			SyncFIFOIfc#(Bit#(34)) sync_response_from_dm <-mkSyncFIFOFromCC(1,tck);
+			rule connect_tap_request_to_syncfifo;
+				let x<-tap.request_to_dm;
+				sync_request_to_dm.enq(x);
+			endrule
+			rule read_synced_request_to_dm;
+				sync_request_to_dm.deq;
+				core.request_from_dtm(sync_request_to_dm.first);
+			endrule
+
+			rule connect_debug_response_to_syncfifo;
+				let x<-core.response_to_dtm;
+				sync_response_from_dm.enq(x);
+			endrule
+			rule read_synced_response_from_dm;
+				sync_response_from_dm.deq;
+				tap.response_from_dm(sync_response_from_dm.first);
+			endrule
+		`endif
+		/*======================================================================= */
+	
+        `ifdef FlexBus
+            //rule drive_flexbus_inputs;
+               //flexbus.flexbus_side.m_TAn(1'b1);
+               //flexbus.flexbus_side.m_din(32'haaaaaaaa);
+            //endrule
+         `endif
+
+		`ifdef CLINT
+			SyncBitIfc#(Bit#(1)) clint_mtip_int <-mkSyncBitToCC(slow_clock,slow_reset);
+			SyncBitIfc#(Bit#(1)) clint_msip_int <-mkSyncBitToCC(slow_clock,slow_reset);
+			Reg#(Bit#(`Reg_width)) clint_mtime_value <-mkSyncRegToCC(0,slow_clock,slow_reset);
+			rule synchronize_clint_data;
+				clint_mtip_int.send(slow_peripherals.mtip_int);
+				clint_msip_int.send(slow_peripherals.msip_int);
+				clint_mtime_value<=slow_peripherals.mtime;
+			endrule
+			rule connect_msip_mtip_from_clint;
+				core.clint_msip(clint_msip_int.read);
+				core.clint_mtip(clint_mtip_int.read);
+            core.clint_mtime(clint_mtime_value);
+			endrule
+		`endif
+		`ifdef PLIC
+			Reg#(Tuple2#(Bool,Bool)) plic_interrupt_note <-mkSyncRegToCC(tuple2(False,False),slow_clock,slow_reset);
+			rule synchronize_interrupts;
+				let note <- slow_peripherals.intrpt_note;
+				plic_interrupt_note<=note;
+			endrule
+         rule rl_send_external_interrupt_to_csr;
+				core.set_external_interrupt(plic_interrupt_note);
+			endrule
+		`endif
+
+		`ifdef VME
+			interface  proc_ifc = vme.proc_ifc;
+			interface   proc_dbus = vme.proc_dbus;
+		`endif 
+		`ifdef FlexBus
+            interface flexbus_out = flexbus.flexbus_side;
+		`endif 
+      method Action boot_sequence(Bit#(1) bootseq) = core.boot_sequence(bootseq);
+		`ifdef SDRAM
+			interface sdram_out=sdram.ifc_sdram_out;
+		`endif
+    `ifdef DDR
+      interface master=fabric.v_to_slaves[fromInteger(valueOf(Sdram_slave_num))];
+    `endif
+		`ifdef Debug
+			method Action tms_i(Bit#(1) tms);
+				tap.tms_i(tms);
+			endmethod
+			method Action tdi_i(Bit#(1) tdi);
+				tap.tdi_i(tdi);
+			endmethod
+			method Action bs_chain_i(Bit#(1) bs_chain);
+				tap.bs_chain_i(bs_chain);
+			endmethod
+			method Bit#(1) shiftBscan2Edge=tap.shiftBscan2Edge;
+			method Bit#(1) selectJtagInput=tap.selectJtagInput;
+			method Bit#(1) selectJtagOutput=tap.selectJtagOutput;
+			method Bit#(1) updateBscan=tap.updateBscan;
+			method Bit#(1) bscan_in=tap.bscan_in;
+            method Bit#(1) scan_shift_en=tap.scan_shift_en;
+			method Bit#(1) tdo=tap.tdo;
+			method Bit#(1) tdo_oe=tap.tdo_oe;
+		`endif
+		interface slow_ios=slow_peripherals.slow_ios;
+
+	endmodule
+endpackage
-- 
2.30.2