Move Makefiles rules around, improve verilog IPC

scopeInfinity · scopeInfinity · commit 186f92fba42a · 2025-01-25T01:29:45.000-08:00
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@ SRC_DIR=.
 BUILD_DIR=build
 OUTPUT_DIR=output
 
-.PHONY: clean test all run_ping_pong all_programs_binary all_programs_resolved
+.PHONY: clean test all run_verilog_io run_ping_pong all_programs_binary all_programs_resolved output_rom_binaries
 
 all: all_programs_binary all_programs_resolved verilog_modules
 
@@ -19,6 +19,8 @@ test: pytest test_verilog_modules
 
 all_programs_binary: $(patsubst programs/%.asm, $(OUTPUT_DIR)/programs/%.bin, $(shell find programs/ -name '*.asm'))
 
+output_rom_binaries: $(OUTPUT_DIR)/programs/boot_sequence.bin $(OUTPUT_DIR)/programs/ping_pong.bin
+
 $(OUTPUT_DIR)/programs/%.bin: programs/%.asm
 	mkdir -p $(dir $@)
 	python3 -m planner asm -b $^ > $@
@@ -31,3 +33,6 @@ $(OUTPUT_DIR)/programs/%_resolved.asm: programs/%.asm
 
 run_ping_pong:
 	python3 -m planner compile_and_execute ping_pong
+
+run_verilog_io:
+	python3 -m planner verilog_io
diff --git a/emulator/Makefile.mk b/emulator/Makefile.mk
@@ -1,26 +1,25 @@
 BUILD_EMULATOR = $(BUILD_DIR)/emulator
 SRC_EMULATOR = $(SRC_DIR)/emulator
 
-.PHONY: verilog_modules test_verilog_modules
+.PHONY: verilog_modules test_verilog_modules verilog_data_prerequisites verilog_simulate
 
 $(BUILD_EMULATOR)/%_test: $(SRC_EMULATOR)/%_test.v
 	mkdir -p $(dir $@)
 	iverilog -o $@ $^
 
-verilog_modules: $(patsubst $(SRC_EMULATOR)/%_test.v, $(BUILD_EMULATOR)/%_test, $(shell find $(SRC_EMULATOR) -name '*_test.v'))
+verilog_modules: $(BUILD_EMULATOR)/executable_chipset $(patsubst $(SRC_EMULATOR)/%_test.v, $(BUILD_EMULATOR)/%_test, $(shell find $(SRC_EMULATOR) -name '*_test.v'))
 	mkdir -p $(BUILD_EMULATOR)/io
 
+verilog_data_prerequisites: output_rom_binaries
+
 test_verilog_modules: $(patsubst $(SRC_EMULATOR)/%_test.v, $(BUILD_EMULATOR)/%_test, $(shell find $(SRC_EMULATOR) -name '*_test.v'))
+	$(MAKE) verilog_data_prerequisites
 	$(foreach test_name, $^, echo "Executing $(test_name)" && ./$(test_name))
 
-$(BUILD_EMULATOR)/module/libipc.so: $(SRC_EMULATOR)/module/ipc.cpp
-	mkdir -p $(dir $@)
-	g++ -shared -Wl,-soname,libipc.so -o $@ -fPIC $^
-
-$(BUILD_EMULATOR)/module/ipc.py: $(SRC_EMULATOR)/module/ipc.py $(BUILD_EMULATOR)/module/libipc.so
+$(BUILD_EMULATOR)/executable_chipset: $(SRC_EMULATOR)/executable_chipset.v
+	$(MAKE) verilog_data_prerequisites
 	mkdir -p $(dir $@)
-	cp -f $< $@
+	iverilog -o $@ $^
 
-$(BUILD_EMULATOR)/module/ipc.o: $(SRC_EMULATOR)/module/ipc.cpp
-	mkdir -p $(dir $@)
-	g++ -o $@ $^
+verilog_simulate: $(BUILD_EMULATOR)/executable_chipset
+	./$^ | $(MAKE) run_verilog_io
diff --git a/emulator/executable_chipset.v b/emulator/executable_chipset.v
@@ -23,6 +23,5 @@ module chipset_test;
             $error("chipset failed");
             $fatal(1);
         end
-        // $finish();
     end
 endmodule
diff --git a/emulator/module/ipc.v b/emulator/module/ipc.v
@@ -1,11 +1,31 @@
+`define INPUT_FILE "/tmp/ourpc_input"
+
 // Handle Inter Process Communication
-// We were not able to figure out simpler way to do so.
+// We weren't able to figure out simpler way to do so.
 module IPCOut(
-    input[15:0] process_id,
+    input[7:0] device_id,
     input[31:0] value
     );
 
     always @(value) begin
-        $display("IPC %x %x", process_id, value);
+        $display("IPC %x %x", device_id, value);
+    end
+endmodule
+
+module IPCIn(
+    output[31:0] value,
+    input[7:0] device_id,
+    input clk);
+
+    // device_id to value
+    reg[31:0] _ipc_input[0:7];
+    always @(posedge clk) begin
+        // At some random interval
+        $readmemb(`INPUT_FILE, _ipc_input);
+    end
+    reg[31:0] _value;
+    always @(*) begin
+        _value <= _ipc_input[device_id];
     end
+    assign value = _value;
 endmodule
diff --git a/emulator/module/ipc_test.v b/emulator/module/ipc_test.v
@@ -1,20 +1,57 @@
 `include "emulator/module/ipc.v"
 
-module ipc_test;
-    reg[15:0] process_id;
+module ipc_out_test;
+    reg[7:0] device_id;
     reg[31:0] value;
 
-    IPCOut dut(.process_id(process_id[15:0]), .value(value[31:0]));
+    IPCOut dut(.device_id(device_id[7:0]), .value(value[31:0]));
 
     initial begin
         # 5
-        process_id = 10;
+        device_id = 10;
         # 1
         value = 20;
+        // Not test here, output goes to stdout.
+    end
+endmodule
+
+module ipc_in_test;
+    reg[7:0] device_id;
+    reg clk;
+    output[31:0] value;
+
+    IPCIn dut(.value(value[31:0]), .device_id(device_id[7:0]), .clk(clk));
+
+    integer f;
+    initial begin
+        # 5
+        f = $fopen("/tmp/ourpc_input", "w");
+        $fwrite(f,"00000000000000000000000000000001\n");
+        $fwrite(f,"11111111111111111111111111111111\n");
+        $fwrite(f,"01010101010101010101010101010101\n");
+        $fwrite(f,"10101010101010101010101010101010\n");
+        $fwrite(f,"00000000000000000000000011111111\n");
+        $fwrite(f,"11111111000000000000000000000000\n");
+        $fwrite(f,"01010101101010100101010110101010\n");
+        $fwrite(f,"10101010010101011010101001010101\n");
+        $fclose(f);
+
+        device_id = 1;
+        clk = 0;
+        # 5
+        clk = 1;
+        # 5
+        if (value !== 32'b11111111111111111111111111111111) begin
+            $error("ipc input failed, got: %b", value);
+            $fatal(1);
+        end
+        device_id = 6;
         # 1
-        value = 25;
-        # 1
-        value = 30;
+        if (value !== 32'b01010101101010100101010110101010) begin
+            $error("ipc input failed, got: %b", value);
+            $fatal(1);
+        end
+
     end
 endmodule
 
diff --git a/emulator/seq/io.c b/emulator/seq/io.c
diff --git a/emulator/seq/io_devices.v b/emulator/seq/io_devices.v
@@ -3,10 +3,6 @@
 `define CONSDEV_ID 3
 `define PROM_ID 2
 
-`define IO_DIR "build/emulator/io"
-
-// Import the function called "system_init" implemented in C code
-
 module IODevices(
     output[31:0] value_out,
     input[7:0] device_id,
@@ -16,55 +12,34 @@ module IODevices(
 
     integer fio;
 
-    reg[31:0] _data [255:0];
-    initial begin
-        // $fseek(fio, 0, 0);
-        // system_init();
-    end
-    reg[15:0] process_id;
-    // assign
     reg[31:0] value;
-    IPCOut ipcout(.process_id(process_id[15:0]), .value(value[31:0]));
+    output[31:0] value_ipc_in;
+
+    IPCOut ipcout(.device_id(device_id[7:0]), .value(value[31:0]));
+    IPCIn ipcin(.value(value_ipc_in[31:0]), .device_id(device_id[7:0]), .clk(clk));
 
     always @(negedge clk) begin
         // Write are triggered at negedge
         if (is_write) begin
-            _data[device_id] <= value_in;
-            process_id <= {8'b00000000, device_id};
             value <= value_in;
-
-
-            // fio = $fopen("build/emulator/io/output.txt","w");
-            // $fseek(fio, 0, 0);
-            // $fwrite(fio, "%b\n", value_in);
-            // $fflush(fio);
-            // $fclose(fio);
             $display("IO:output[%x] <= %x", device_id, value_in);
         end
     end
 
-    reg[31:0] _ipc_input[0:15];
-    // integer i;
-    always @(posedge clk) begin
-        // At some random interval
-        $readmemb("/tmp/ourpc_input.txt", _ipc_input);
-        // for (i=0; i<16; i=i+1) begin
-        //     $display("INPUT[%d]: %x", i, _ipc_input[i]);
-        // end
-    end
-
     // PROM
     wire[31:0] prom_value;
-    ROM_PINGPONG prom(.out(prom_value), .address(_data[`PROM_ID][15:0]));
+    ROM_PINGPONG prom(.out(prom_value), .address(value_in[15:0]));
 
     reg[31:0] _value;
     always @(device_id) begin
         case (device_id)
+            // TODO: Is it ok to use continous circuit with value_in as address?
             `PROM_ID: _value <= prom_value;
+            `CONSDEV_ID: _value <= value_in;
             default:
+                // Goes via IPC
                 begin
-                _value <= _ipc_input[device_id];
-                // $display("IO:input[%x] <= %x", device_id, _value);
+                _value <= value_ipc_in;
                 end
         endcase
     end
diff --git a/emulator/seq/io_devices_test.v b/emulator/seq/io_devices_test.v
@@ -20,25 +20,38 @@ module IODevices_test;
 
     initial begin
         device_id = 1;
-        is_write = 1;
+        is_write = 0;
         value_in = INPUT1;
         clk = 1;
         # 10
         clk = 0;
         # 10
-        device_id = 0;
+        device_id = 3;  // const
+        # 5
         $display("IO_DEVICES_TEST: device_id=%b value_out=%b", device_id, value_out);
-        if (value_out === INPUT1) begin
+        if (value_out !== INPUT1) begin
             $error("io failed");
             $fatal(1);
         end
         # 10
-        device_id = 1;
+        device_id = 2;  // PROM
+        value_in = 0;
         # 10
         $display("IO_DEVICES_TEST: device_id=%b value_out=%b", device_id, value_out);
-        if (value_out !== INPUT1) begin
+        if (value_out === INPUT1) begin
+            // not a great test but ok.
             $error("io failed");
             $fatal(1);
         end
+        # 10
+        device_id = 5;  // IPC
+        value_in = 10;
+        is_write = 1;
+        # 10
+        clk = 0;
+        # 10
+        clk = 1;
+        // trigger write
+        // no verification, but it should generate logs.
     end
 endmodule
diff --git a/emulator/specs.py b/emulator/specs.py
