From 3d0ba881367409a0062d40651fee6c9bc0a50c67 Mon Sep 17 00:00:00 2001
From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Sat, 28 Jul 2018 05:50:49 +0100
Subject: [PATCH] add tuple2 templates

---
 src/bsv/bsv_lib/fast_tuple2_template.bsv | 79 ++++++++++++++++++++++++
 src/bsv/bsv_lib/slow_tuple2_template.bsv | 34 ++++++++++
 2 files changed, 113 insertions(+)
 create mode 100644 src/bsv/bsv_lib/fast_tuple2_template.bsv
 create mode 100644 src/bsv/bsv_lib/slow_tuple2_template.bsv

diff --git a/src/bsv/bsv_lib/fast_tuple2_template.bsv b/src/bsv/bsv_lib/fast_tuple2_template.bsv
new file mode 100644
index 0000000..0ee905f
--- /dev/null
+++ b/src/bsv/bsv_lib/fast_tuple2_template.bsv
@@ -0,0 +1,79 @@
+/*
+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 fast_memory_map;
+    /*====== Package imports === */
+    `include "instance_defines.bsv"
+    `include "core_parameters.bsv"
+
+    /*====== Fast peripherals Memory Map ======= */
+{0}
+
+    /*====== AXI4 slave declarations =======*/
+{1}
+
+    /*====== AXI4 Master declarations =======*/
+{2}
+
+
+
+function FastTuple2 #(Bool, Bit#(TLog#(Num_Slaves)))
+                fn_addr_to_slave_num  (Bit#(`PADDR) addr);
+
+    if(addr>=`SDRAMMemBase && addr<=`SDRAMMemEnd)
+        return tuple2(True,fromInteger(valueOf(Sdram_slave_num)));
+    else if(addr>=`DebugBase && addr<=`DebugEnd)
+        return tuple2(True,fromInteger(valueOf(Debug_slave_num)));
+    `ifdef SDRAM
+        else if(addr>=`SDRAMCfgBase && addr<=`SDRAMCfgEnd )
+            return tuple2(True,fromInteger(valueOf(Sdram_cfg_slave_num)));
+    `endif
+    `ifdef BOOTROM
+        else if(addr>=`BootRomBase && addr<=`BootRomEnd)
+            return tuple2(True,fromInteger(valueOf(BootRom_slave_num)));
+    `endif
+    `ifdef DMA
+        else if(addr>=`DMABase && addr<=`DMAEnd)
+            return tuple2(True,fromInteger(valueOf(Dma_slave_num)));
+    `endif
+    `ifdef VME
+        else if(addr>=`VMEBase && addr<=`VMEEnd)
+            return tuple2(True,fromInteger(valueOf(VME_slave_num)));
+    `endif
+    `ifdef TCMemory
+        else if(addr>=`TCMBase && addr<=`TCMEnd)
+            return tuple2(True,fromInteger(valueOf(TCM_slave_num)));
+    `endif
+        else 
+{3}
+            return tuple2(False,?);
+endfunction
+
+endpackage
diff --git a/src/bsv/bsv_lib/slow_tuple2_template.bsv b/src/bsv/bsv_lib/slow_tuple2_template.bsv
new file mode 100644
index 0000000..a3d92c4
--- /dev/null
+++ b/src/bsv/bsv_lib/slow_tuple2_template.bsv
@@ -0,0 +1,34 @@
+package slow_memory_map;
+	/*===== Project imports =====*/
+	import defined_types::*;
+	`include "instance_defines.bsv"
+    /* ==== define the AXI Addresses ==== */
+{0}
+
+    /* ==== define the AXI slave numbering ===== */
+{1}
+
+    /* ==== define the number of slow peripheral irqs ==== */
+
+	function SlowTuple2#(Bool, Bit#(TLog#(Num_Slow_Slaves)))
+                     fn_address_mapping (Bit#(`ADDR) addr);
+        `ifdef CLINT
+            if(addr>=`ClintBase && addr<=`ClintEnd)
+                return tuple2(True,fromInteger(valueOf(CLINT_slave_num)));
+            else
+        `endif
+        `ifdef PLIC
+            if(addr>=`PLICBase && addr<=`PLICEnd)
+                return tuple2(True,fromInteger(valueOf(Plic_slave_num)));
+            else
+        `endif
+        `ifdef AXIEXP
+            if(addr>=`AxiExp1Base && addr<=`AxiExp1End)
+                return tuple2(True,fromInteger(valueOf(AxiExp1_slave_num)));
+            else
+        `endif
+{2}
+        return tuple2(False,?);
+	endfunction
+
+endpackage
-- 
2.30.2