From a763e82d861db9ae237eb8a7ae1da8f295f29ca9 Mon Sep 17 00:00:00 2001
From: Andrew Dennison <andrew@motec.com.au>
Date: Thu, 3 Aug 2023 16:24:06 +1000
Subject: [PATCH] soc/builder: add initialize_memory()

Allows the target soc to override memory initialization:
  rom and/or ram.
---
 litex/soc/integration/builder.py  |  5 +++-
 litex/soc/integration/soc_core.py | 42 +++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/litex/soc/integration/builder.py b/litex/soc/integration/builder.py
index dfe0fc7b7..d11e94bbb 100644
--- a/litex/soc/integration/builder.py
+++ b/litex/soc/integration/builder.py
@@ -388,8 +388,11 @@ class Builder:
                 self._prepare_rom_software()
                 self._generate_rom_software(compile_bios=use_bios)
 
+                # Allow soc to override the memory initialisation.
+                self.soc.initialize_memory(self.software_dir, **kwargs)
+
                 # Initialize ROM.
-                if use_bios and self.soc.integrated_rom_size:
+                if use_bios and self.soc.integrated_rom_size and not getattr(self.soc, "rom").mem.init:
                     self._initialize_rom_software()
 
         # Translate compile_gateware to run.
diff --git a/litex/soc/integration/soc_core.py b/litex/soc/integration/soc_core.py
index 28611d197..39477d3c1 100644
--- a/litex/soc/integration/soc_core.py
+++ b/litex/soc/integration/soc_core.py
@@ -282,6 +282,48 @@ class SoCCore(LiteXSoC):
     def add_csr_region(self, name, origin, busword, obj):
         self.csr_regions[name] = SoCCSRRegion(origin, busword, obj)
 
+    def initialize_memory(self, software_dir, **kwargs):
+        """initialize_memory
+        The target SoC can implement this function to override the memory initialisation
+        during the build to load a program or data to main_ram and/or rom.
+
+        Parameters
+        ----------
+        software_dir : str
+            Builder software_dir where the soc libs and bios are built.
+
+        kwargs
+            Builder kwargs for any additional context if required
+.
+        Example:
+
+        class MySoC(SoCCore):
+            def __init__(self,
+                ...
+                self.add_config("MAIN_RAM_INIT") # firmware is in ram
+
+            def initialize_memory(self, software_dir, **kwargs):
+                if self.cpu_type is None:
+                    return
+
+                filename  = os.path.join(software_dir, "firmware", "firmware.bin")
+                data = get_mem_data(filename, endianness=self.cpu.endianness)
+                self.init_rom(name="main_ram", contents=data, auto_size=False)
+
+        def main():
+            ...
+
+            builder = Builder(soc, **parser.builder_argdict)
+
+            # add custom firmware: compiled by connecting here and stored in initialize_memory()
+            src="firmware"
+            src_dir = os.path.join(os.path.abspath(os.path.dirname(__file__)), src)
+            builder.add_software_package(src, src_dir)
+
+            builder.build(**parser.toolchain_argdict)
+        """
+        pass
+
 # SoCCore arguments --------------------------------------------------------------------------------
 
 def soc_core_args(parser):