WIP -- Modernize platforms + target files

.gitmodules

@@ -37,3 +37,6 @@
 [submodule "third_party/nmigen"]
 	path = third_party/nmigen
 	url = https://github.com/m-labs/nmigen.git
+[submodule "third_party/litex-boards"]
+	path = third_party/litex-boards
+	url = https://github.com/litex-hub/litex-boards

Makefile

@@ -203,9 +203,14 @@ ifeq ($(FIRMWARE),none)
 OVERRIDE_FIRMWARE=--override-firmware=none
 FIRMWARE_FBI=
 else
+ifeq ($(FIRMWARE),clear)
+OVERRIDE_FIRMWARE=--override-firmware=clear
+FIRMWARE_FBI=
+else
 OVERRIDE_FIRMWARE=--override-firmware=$(FIRMWARE_FILEBASE).fbi
 FIRMWARE_FBI=$(FIRMWARE_FILEBASE).fbi
 endif
+endif
 
 $(IMAGE_FILE): $(GATEWARE_FILEBASE).bin $(BIOS_FILE) $(FIRMWARE_FBI)
 	$(PYTHON) mkimage.py \

gateware/info/__init__.py

@@ -14,11 +14,12 @@
 
 class Info(Module, AutoCSR):
     def __init__(self, platform, target_name):
-        self.submodules.dna = dna.DNA()
         self.submodules.git = git.GitInfo()
         target = target_name.lower()[:-3]
         self.submodules.platform = platform_info.PlatformInfo(platform.name, target)
 
+        if "xc" in platform.device:
+            self.submodules.dna = dna.DNA()
         if "xc7" in platform.device:
             self.submodules.xadc = xadc.XADC()
 

mkimage.py

@@ -8,6 +8,102 @@
 
 import make
 
+from collections import namedtuple
+
+
+def round(i):
+    return int(i / 4) * 4
+
+
+_Region = namedtuple("Region", ["name", "desc", "start", "size"])
+class Region(_Region):
+    def __init__(self, name, desc, start, size):
+        #_Region.__init__(self, name, start, size, desc)
+        assert round(start) == start, (
+            "Start invalid {} != {}".format(start, round(start)))
+        assert round(size) == size, (
+            "Size invalid {} != {}".format(size, round(size)))
+
+    def __str__(self):
+        return "Region(0x{:06x}, 0x{:06x}, {:10s}, {})".format(
+            self.start, self.end, repr(self.name), repr(self.desc))
+
+    @property
+    def end(self):
+        return self.start + self.size
+
+
+def get_regions(size_gw, size_bios, size_flash):
+    """
+
+    >>> regions = get_regions(256, 128, 1000)
+    >>> for r in regions:
+    ...     print(r)
+    Region(0x000000, 0x000100, 'Gateware', 'FPGA bitstream')
+    Region(0x000100, 0x000180, 'BIOS'    , 'LiteX BIOS with CRC')
+    Region(0x000180, 0x0003e8, 'Firmware', 'Firmware in FBI format')
+
+    """
+    region_gw = Region(
+        "Gateware",
+        "FPGA bitstream",
+        0,
+        round(size_gw),
+    )
+    region_bios = Region(
+        "BIOS",
+        "LiteX BIOS with CRC",
+        region_gw.end,
+        size_bios,
+    )
+    size_fw = round(size_flash - region_bios.end)
+    region_fw = Region(
+        "Firmware",
+        "Firmware in FBI format",
+        region_bios.end,
+        size_fw,
+    )
+    return [region_gw, region_bios, region_fw]
+
+
+def fill_region(image_fileobj, region, input_filename, fill_zero=False):
+    """
+
+    Output;
+    -----
+    Gateware @ 0x00000000 (using      135100 bytes of     163840 bytes) build/ice40_hx8k_b_evn_base_vexriscv.minimal+debug//gateware/top.bin - FPGA Bitstream
+    ff 00 00 ff 7e aa 99 7e 51 00 01 05 92 00 21 62 03 67 72 01 10 82 00 00 11 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+    -----
+
+    {name  } @ {start   } (using {input_len} bytes of {length  } bytes) {input_fn} - {desc}
+    {hex file data}
+    """
+
+    if inputfile:
+        input_data   = open(input_filename, "rb").read()
+        input_size   = len(input_data)
+        input_result = "Loaded from {}".format(input_filename)
+    else:
+        input_data   = b""
+        input_size   = len(input_data)
+        input_result = "Skipped"
+
+    #   "{name:08s} @ 0x{start:08x} "
+    #   "(using {input_size:10} bytes of {:10} bytes - {:02.2)%) {:60s} - {}"
+
+    #print(
+    #    "{:08s} @ 0x{:08x} (using {:10} bytes of {:10} bytes - {:02.2)% {:60s} - {}"
+    #).format()
+
+    print(" ".join("{:02x}".format(i) for i in input_data[:64]))
+    assert input_size < region.size
+    assert f.tell() < region.start, "{} < {}".format(f.tell(), region.start)
+    f.seek(region.start)
+    f.write(input_data)
+    if fill_zero:
+        while f.tell() < region.end:
+            f.write('\0')
+
 
 def main():
     parser = argparse.ArgumentParser(description=__doc__)
@@ -56,8 +152,9 @@ def main():
 
     firmware = make.get_firmware(builddir, "flash")
     if args.override_firmware:
-        if args.override_firmware.lower() == "none":
+        if args.override_firmware.lower() in ("none", "clear"):
             firmware = None
+            args.firmware_name = args.override_firmware
         else:
             firmware = args.override_firmware
     if firmware:
@@ -75,6 +172,10 @@ def main():
     bios_pos = platform.gateware_size
     firmware_pos = platform.gateware_size + bios_size
 
+    flash_size = platform.spiflash_total_size
+    if args.force_image_size and args.force_image_size.lower() not in ("true", "1"):
+            flash_size = int(args.force_image_size)
+
     print()
     with open(output_file, "wb") as f:
         # FPGA gateware
@@ -84,9 +185,13 @@ def main():
             gateware_data = b""
             gateware = "Skipped"
 
-        print(("Gateware @ 0x{:08x} ({:10} bytes) {:60}"
+        print(("Gateware @ 0x{:08x} (using {:10} bytes of {:10} bytes) {:60}"
                " - FPGA Bitstream"
-               ).format(gateware_pos, len(gateware_data), gateware))
+               ).format(
+                   gateware_pos,
+                   len(gateware_data),
+                   bios_pos - gateware_pos,
+                   gateware))
         print(" ".join("{:02x}".format(i) for i in gateware_data[:64]))
         assert len(gateware_data) < platform.gateware_size
         f.seek(0)
@@ -102,22 +207,31 @@ def main():
         assert len(bios_data) < bios_size
         f.seek(bios_pos)
         f.write(bios_data)
-        print(("    BIOS @ 0x{:08x} ({:10} bytes) {:60}"
+        print(("    BIOS @ 0x{:08x} (using {:10} bytes of {:10} bytes) {:60}"
                " - LiteX BIOS with CRC"
-               ).format(bios_pos, len(bios_data), bios))
+               ).format(
+                   bios_pos,
+                   len(bios_data),
+                   firmware_pos - bios_pos,
+                   bios))
         print(" ".join("{:02x}".format(i) for i in bios_data[:64]))
 
         if firmware:
             firmware_data = open(firmware, "rb").read()
         else:
-            firmware_data = b""
-            firmware = "Skipped"
+            firmware_data = b"\xff\xff\xff\xff"
+            firmware = "Cleared"
+            #firmware_data = b""
+            #firmware = "Skipped"
 
         # SoftCPU firmware
-        print(("Firmware @ 0x{:08x} ({:10} bytes) {:60}"
+        print(("Firmware @ 0x{:08x} (using {:10} bytes of {:10} bytes) {:60}"
                " - {} Firmware in FBI format (loaded into DRAM)"
                ).format(
-                   firmware_pos, len(firmware_data), firmware,
+                   firmware_pos,
+                   len(firmware_data),
+                   flash_size - firmware_pos,
+                   firmware,
                    args.firmware_name))
         print(" ".join("{:02x}".format(i) for i in firmware_data[:64]))
         f.seek(firmware_pos)
@@ -136,10 +250,6 @@ def main():
                ).format(total, int(total*8/1024/1024), total/1024/1024))
 
         if args.force_image_size:
-            if args.force_image_size.lower() in ("true", "1"):
-                flash_size = platform.spiflash_total_size
-            else:
-                flash_size = int(args.force_image_size)
             f.write(b'\xff' * (flash_size - f.tell()))
 
     print()
@@ -149,4 +259,6 @@ def main():
 
 
 if __name__ == "__main__":
+    import doctest
+    doctest.testmod()
     main()

scripts/download-env.sh

@@ -655,13 +655,14 @@ echo "-----------------------"
 # lite
 for LITE in $LITE_REPOS; do
 	LITE_DIR=$THIRD_DIR/$LITE
+	LITE_MOD=$(echo $LITE | sed -e's/-/_/g')
 	(
 		echo
 		cd $LITE_DIR
 		echo "Installing $LITE from $LITE_DIR (local python module)"
 		python setup.py develop
 	)
-	check_import $LITE
+	check_import $LITE_MOD
 done
 
 echo "-----------------------"

scripts/enter-env.sh

@@ -567,14 +567,15 @@ echo "-----------------------"
 
 # lite
 for LITE in $LITE_REPOS; do
+	LITE_DIR=$THIRD_DIR/$LITE
+	LITE_MOD=$(echo $LITE | sed -e's/-/_/g')
 
 
 
 
 
 
-
-	check_import $LITE || return 1
+	check_import $LITE_MOD || return 1
 done
 
 echo "-----------------------"

scripts/settings.sh

@@ -27,6 +27,7 @@ LITE_REPOS="
 	migen
 	nmigen
 	litex
+	litex-boards
 	litedram
 	liteeth
 	litepcie