From 1d89cb92b89742e612909ba283f69bb48e96524b Mon Sep 17 00:00:00 2001
From: Cole Poirier <colepoirier@gmail.com>
Date: Mon, 17 Aug 2020 16:44:55 -0700
Subject: [PATCH] Create file experiment/wb_types.py to mirror microwatt
 wishbone_types.vhdl

---
 src/soc/experiment/wb_types.py | 134 +++++++++++++++++++++++++++++++++
 1 file changed, 134 insertions(+)
 create mode 100644 src/soc/experiment/wb_types.py

diff --git a/src/soc/experiment/wb_types.py b/src/soc/experiment/wb_types.py
new file mode 100644
index 00000000..018a8daa
--- /dev/null
+++ b/src/soc/experiment/wb_types.py
@@ -0,0 +1,134 @@
+"""wb_types
+
+based on Anton Blanchard microwatt wishbone_types.vhdl
+
+"""
+
+from nmigen import Signal
+from nmigen.iocontrol import RecordObject
+
+
+# library ieee;
+# use ieee.std_logic_1164.all;
+#
+# package wishbone_types is
+#     --
+#     -- Main CPU bus. 32-bit address, 64-bit data
+#     --
+#     constant wishbone_addr_bits : integer := 32;
+#     constant wishbone_data_bits : integer := 64;
+#     constant wishbone_sel_bits : integer := wishbone_data_bits/8;
+
+# Main CPU bus. 32-bit address, 64-bit data
+WB_ADDR_BITS = 32
+WB_DATA_BITS = 64
+WB_SEL_BITS  = WB_DATA_BITS / 8
+
+# subtype wishbone_addr_type is
+#  std_ulogic_vector(wishbone_addr_bits-1 downto 0);
+# subtype wishbone_data_type is
+#  std_ulogic_vector(wishbone_data_bits-1 downto 0);
+# subtype wishbone_sel_type is
+#  std_ulogic_vector(wishbone_sel_bits-1  downto 0);
+
+def WBAddrType():
+    return Signal(WB_ADDR_BITS)
+
+def WBDataType():
+    return Signal(WB_DATA_BITS)
+
+def WBSelType():
+    return Signal(WB_SEL_BITS)
+
+# type wishbone_master_out is record
+#     adr : wishbone_addr_type;
+#     dat : wishbone_data_type;
+#     cyc : std_ulogic;
+#     stb : std_ulogic;
+#     sel : wishbone_sel_type;
+#     we  : std_ulogic;
+# end record;
+class WBMasterOut(RecordObject):
+    def __init__(self):
+        super().__init__()
+        self.adr = WBAddrType()
+        self.dat = WBDataType()
+        self.cyc = Signal()
+        self.stb = Signal()
+        self.sel = WBSelType()
+        self.we  = Signal()
+
+# constant wishbone_master_out_init : wishbone_master_out := (
+#  adr => (others => '0'), dat => (others => '0'), cyc => '0',
+#  stb => '0', sel => (others => '0'), we => '0'
+# );
+def WBMasterOutInit():
+    return WBMasterOut()
+
+# type wishbone_slave_out is record
+#     dat   : wishbone_data_type;
+#     ack   : std_ulogic;
+#     stall : std_ulogic;
+# end record;
+def class WBSlaveOut(RecordObject):
+    def __init__(self):
+        super().__init__()
+        self.dat   = WBDataType()
+        self.ack   = Signal()
+        self.stall = Signal()
+
+# constant wishbone_slave_out_init : wishbone_slave_out := (
+#  ack => '0', stall => '0', others => (others => '0')
+# );
+def WBSlaveOutInit():
+    return WBSlaveOut()
+
+# type wishbone_master_out_vector is array (natural range <>) of
+#  wishbone_master_out;
+def WBMasterOutVector():
+    return Array(WBMasterOut())
+
+# type wishbone_slave_out_vector is array (natural range <>) of
+#  wishbone_slave_out;
+def WBSlaveOutVector():
+    return Array(WBSlaveOut())
+
+# -- IO Bus to a device, 30-bit address, 32-bits data
+# type wb_io_master_out is record
+#     adr : std_ulogic_vector(29 downto 0);
+#     dat : std_ulogic_vector(31 downto 0);
+#     sel : std_ulogic_vector(3 downto 0);
+#     cyc : std_ulogic;
+#     stb : std_ulogic;
+#     we  : std_ulogic;
+# end record;
+# IO Bus to a device, 30-bit address, 32-bits data
+class WBIOMasterOut(RecordObject):
+    def __init__(self):
+        super().__init__()
+        self.adr = Signal(30)
+        self.dat = Signal(32)
+        self.sel = Signal(4)
+        self.cyc = Signal()
+        self.stb = Signal()
+        self.we  = Signal()
+
+# type wb_io_slave_out is record
+#     dat   : std_ulogic_vector(31 downto 0);
+#     ack   : std_ulogic;
+#     stall : std_ulogic;
+# end record;
+class WBIOSlaveOut(RecordObject):
+    def __init__(self):
+        super().__init__()
+        self.data  = Signal(32)
+        self.ack   = Signal()
+        self.stall = Signal()
+
+# constant wb_io_slave_out_init : wb_io_slave_out := (
+#  ack => '0', stall => '0', others => (others => '0')
+# );
+def WBIOSlaveOutInit():
+    return WBIOSlaveOut()
+
+# end package wishbone_types;
-- 
2.30.2