Add scripts to auto-configure Linux builds based on system configuration.

.github/workflows/ci.yml

@@ -71,7 +71,7 @@ jobs:
         run: nix-shell --run "make -C ../iob_soc_o* sim-run SIMULATOR=verilator"
 
 
-  cyclonev-baremetal:
+  cyclonev:
     runs-on: self-hosted
     timeout-minutes: 60
     # run even if previous job failed
@@ -83,10 +83,12 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: 'recursive'
-      - name: cyclonev test
-        run: make fpga-run RUN_LINUX=0 INIT_MEM=0 BOARD=CYCLONEV-GT-DK
+      - name: test baremetal
+        run: make fpga-run RUN_LINUX=0 BOARD=CYCLONEV-GT-DK
+          #      - name: test linux
+          #        run: make fpga-linux-test RUN_LINUX=1 BOARD=CYCLONEV-GT-DK
 
-  aes-ku040-baremetal:
+  aes-ku040:
     runs-on: self-hosted
     timeout-minutes: 90
     # run even if previous job failed
@@ -98,14 +100,16 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: 'recursive'
-      - name: ku040 test
-        run: make fpga-run RUN_LINUX=0 INIT_MEM=0 BOARD=AES-KU040-DB-G
+      - name: test baremetal
+        run: make fpga-run RUN_LINUX=0 BOARD=AES-KU040-DB-G
+          #      - name: test linux
+          #        run: make fpga-linux-test RUN_LINUX=1 BOARD=AES-KU040-DB-G
 
 ##  doc:
 ##    runs-on: self-hosted
 ##    timeout-minutes: 60
 ##    if: ${{ !cancelled() }}
-##    needs: [ cyclonev-baremetal, aes-ku040-baremetal ]
+##    needs: [ cyclonev, aes-ku040 ]
 ##  
 ##    steps:
 ##      - uses: actions/checkout@v3

Makefile

@@ -17,10 +17,6 @@ ifeq ($(INIT_MEM),1)
 SETUP_ARGS += INIT_MEM
 endif
 
-ifeq ($(RUN_LINUX),1)
-SETUP_ARGS += RUN_LINUX
-endif
-
 setup:
 	make build-setup SETUP_ARGS="$(SETUP_ARGS)"
 
@@ -51,10 +47,16 @@ fpga-test:
 	# IOb-SoC-Opencryptolinux always uses external memory
 	make clean setup fpga-run INIT_MEM=0
 
+fpga-linux-test:
+	cat | make fpga-connect | tee test.log & program_pid=$$! && \
+		while true; do grep --quiet login: test.log && break; done && \
+		echo -e "root\nuname -a\n" > /proc/$$program_pid/fd/0 && \
+		sleep 10 && grep --quiet "Linux buildroot" test.log && echo Test passed! || echo Test failed!; kill $$program_pid
+
 test-all:
 	make sim-test
 	make fpga-test BOARD=CYCLONEV-GT-DK
 	make fpga-test BOARD=AES-KU040-DB-G
 	make clean && make setup && make -C ../iob_soc_opencryptolinux_V*/ doc-test
 
-.PHONY: sim-test fpga-test test-all
+.PHONY: sim-test fpga-test fpga-linux-test test-all

hardware/fpga/quartus/CYCLONEV-GT-DK/linux_build_macros.txt

@@ -0,0 +1,6 @@
+UART0_ADDR f2000000
+ETH0_ADDR f4000000
+CLINT0_ADDR f6000000
+PLIC0_ADDR f8000000
+FREQ 50000000
+BAUD 115200

hardware/fpga/vivado/AES-KU040-DB-G/linux_build_macros.txt

@@ -0,0 +1,6 @@
+UART0_ADDR f2000000
+ETH0_ADDR f4000000
+CLINT0_ADDR f6000000
+PLIC0_ADDR f8000000
+FREQ 100000000
+BAUD 115200

hardware/simulation/linux_build_macros.txt

@@ -0,0 +1,6 @@
+UART0_ADDR f2000000
+ETH0_ADDR f4000000
+CLINT0_ADDR f6000000
+PLIC0_ADDR f8000000
+FREQ 100000000
+BAUD 3000000

iob_soc_opencryptolinux.py

@@ -1,12 +1,12 @@
 #!/usr/bin/env python3
 import os
-import sys
 import shutil
 import math
 
-from mk_configuration import update_define
-from verilog_tools import inplace_change
-from iob_soc_opencryptolinux_create_periphs_tmp import create_periphs_tmp
+from iob_soc_opencryptolinux_create_periphs_tmp import (
+    create_periphs_tmp,
+    check_linux_build_macros,
+)
 from mk_configuration import append_str_config_build_mk
 
 from iob_soc import iob_soc
@@ -123,7 +123,7 @@ def _post_setup(cls):
         super()._post_setup()
         dst = f"{cls.build_dir}/software/src"
         src = f"{__class__.setup_dir}/submodules/OS/software/OS_build"
-        files = os.listdir(src)
+        files = ["rootfs.cpio.gz", "Image"]
         for fname in files:
             src_file = os.path.join(src, fname)
             if os.path.isfile(src_file):
@@ -143,6 +143,7 @@ def _post_setup(cls):
             cls.peripherals,
             f"{cls.build_dir}/software/{cls.name}_periphs.h",
         )
+        check_linux_build_macros(cls, f"{__class__.setup_dir}/submodules/OS")
 
         if cls.is_top_module:
             # Set ethernet MAC address
@@ -171,14 +172,6 @@ def _setup_confs(cls, extra_confs=[]):
         # Append confs or override them if they exist
         super()._setup_confs(
             [
-                {
-                    "name": "RUN_LINUX",
-                    "type": "M",
-                    "val": False,
-                    "min": "0",
-                    "max": "1",
-                    "descr": "Used to select running linux.",
-                },
                 {
                     "name": "INIT_MEM",
                     "type": "M",
@@ -211,14 +204,6 @@ def _setup_confs(cls, extra_confs=[]):
                     "max": "32",
                     "descr": "Boot ROM address width",
                 },
-                {
-                    "name": "SRAM_ADDR_W",
-                    "type": "P",
-                    "val": "15",
-                    "min": "1",
-                    "max": "32",
-                    "descr": "SRAM address width",
-                },
                 {
                     "name": "MEM_ADDR_W",
                     "type": "P",
@@ -526,12 +511,3 @@ def _setup_portmap(cls):
                     },
                 ),
             ]
-
-    @classmethod
-    def _custom_setup(cls):
-        super()._custom_setup()
-        # Add the following arguments:
-        # "RUN_LINUX": if should setup with init_mem or not
-        for arg in sys.argv[1:]:
-            if arg == "RUN_LINUX":
-                update_define(cls.confs, "RUN_LINUX", True)

scripts/check_if_run_linux.py

@@ -9,6 +9,23 @@
 else:
     RUN_LINUX = "0"
 
+
+# If line contains "line_content", replace entire line with "new_line_content"
+# If "line_content" is empty, append "new_line_content" to end of file
+def replace_line(filename, line_content, new_line_content):
+    with open(filename, "r") as file:
+        lines = file.readlines()
+    if line_content:
+        for i in range(len(lines)):
+            if line_content in lines[i]:
+                lines[i] = new_line_content
+    else:
+        lines.append(new_line_content)
+
+    with open(filename, "w") as file:
+        file.writelines(lines)
+
+
 # Generate "iob_mem.config" according to which binary firmware the SoC should load to RAM
 
 iob_mem_file = f"{ROOT_DIR}/hardware/{SOC_NAME}_mem.config"
@@ -29,26 +46,30 @@
 
 if "define SIMULATION 1" in content:
     if RUN_LINUX == "1":
-        bsp_file = f"{ROOT_DIR}/hardware/simulation/src/bsp.vh"
-        with open(bsp_file, "w") as file:
-            file.write(
-                "`define BAUD 115200\n`define FREQ 100000000\n`define DDR_DATA_W 32\n`define DDR_ADDR_W 26\n`define SIMULATION 1"
-            )
-
-        bsp_file = f"{ROOT_DIR}/software/src/bsp.h"
-        with open(bsp_file, "w") as file:
-            file.write(
-                "#define BAUD 115200\n#define FREQ 100000000\n#define DDR_DATA_W 32\n#define DDR_ADDR_W 26\n#define SIMULATION 1"
-            )
+        # bsp_file = f"{ROOT_DIR}/hardware/simulation/src/bsp.vh"
+        # replace_line(bsp_file, "`define BAUD", "`define BAUD 115200\n")
+
+        # bsp_file = f"{ROOT_DIR}/software/src/bsp.h"
+        # replace_line(bsp_file, "#define BAUD", "#define BAUD 115200\n")
+
+        conf_file = f"{ROOT_DIR}/hardware/src/{SOC_NAME}_conf.vh"
+        replace_line(conf_file, "", "`define IOB_SOC_OPENCRYPTOLINUX_RUN_LINUX 1\n")
+
+        conf_file = f"{ROOT_DIR}/software/src/{SOC_NAME}_conf.h"
+        replace_line(
+            conf_file,
+            "#define H_IOB_SOC_OPENCRYPTOLINUX_CONF_H",
+            "#define H_IOB_SOC_OPENCRYPTOLINUX_CONF_H\n#define IOB_SOC_OPENCRYPTOLINUX_RUN_LINUX 1\n",
+        )
     else:
-        bsp_file = f"{ROOT_DIR}/hardware/simulation/src/bsp.vh"
-        with open(bsp_file, "w") as file:
-            file.write(
-                "`define BAUD 3000000\n`define FREQ 100000000\n`define DDR_DATA_W 32\n`define DDR_ADDR_W 26\n`define SIMULATION 1"
-            )
-
-        bsp_file = f"{ROOT_DIR}/software/src/bsp.h"
-        with open(bsp_file, "w") as file:
-            file.write(
-                "#define BAUD 3000000\n#define FREQ 100000000\n#define DDR_DATA_W 32\n#define DDR_ADDR_W 26\n#define SIMULATION 1"
-            )
+        # bsp_file = f"{ROOT_DIR}/hardware/simulation/src/bsp.vh"
+        # replace_line(bsp_file, "`define BAUD", "`define BAUD 3000000\n")
+
+        # bsp_file = f"{ROOT_DIR}/software/src/bsp.h"
+        # replace_line(bsp_file, "#define BAUD", "#define BAUD 3000000\n")
+
+        conf_file = f"{ROOT_DIR}/hardware/src/{SOC_NAME}_conf.vh"
+        replace_line(conf_file, "`define IOB_SOC_OPENCRYPTOLINUX_RUN_LINUX", "")
+
+        conf_file = f"{ROOT_DIR}/software/src/{SOC_NAME}_conf.h"
+        replace_line(conf_file, "#define IOB_SOC_OPENCRYPTOLINUX_RUN_LINUX", "")