From 8e19164977b99c3bb9a5d3f582e2bc138e1b8332 Mon Sep 17 00:00:00 2001
From: Maxim Poliakovski <maximumspatium@googlemail.com>
Date: Mon, 25 Mar 2024 23:15:38 +0100
Subject: [PATCH] memctrlbase: introduce add_mem_mirror_common().

---
 devices/memctrl/memctrlbase.cpp | 34 +++++++++++++++++++++++++++------
 devices/memctrl/memctrlbase.h   |  5 +++++
 2 files changed, 33 insertions(+), 6 deletions(-)

diff --git a/devices/memctrl/memctrlbase.cpp b/devices/memctrl/memctrlbase.cpp
index 29c1371..0815d1b 100644
--- a/devices/memctrl/memctrlbase.cpp
+++ b/devices/memctrl/memctrlbase.cpp
@@ -165,7 +165,7 @@ bool MemCtrlBase::add_mem_region(uint32_t start_addr, uint32_t size,
     entry->end     = end;
     entry->mirror  = dest_addr;
     entry->type    = type;
-    entry->devobj  = 0;
+    entry->devobj  = nullptr;
     entry->mem_ptr = reg_content;
 
     this->address_map.push_back(entry);
@@ -192,7 +192,8 @@ bool MemCtrlBase::add_ram_region(uint32_t start_addr, uint32_t size) {
 }
 
 
-bool MemCtrlBase::add_mem_mirror(uint32_t start_addr, uint32_t dest_addr) {
+bool MemCtrlBase::add_mem_mirror_common(uint32_t start_addr, uint32_t dest_addr,
+                                        uint32_t offset, uint32_t size) {
     AddressMapEntry *entry, *ref_entry;
 
     ref_entry = find_range(dest_addr);
@@ -201,13 +202,23 @@ bool MemCtrlBase::add_mem_mirror(uint32_t start_addr, uint32_t dest_addr) {
 
     entry = new AddressMapEntry;
 
-    uint32_t end   = start_addr + (ref_entry->end - ref_entry->start);
+    // use origin's size if no size was specified
+    if (!size)
+        size = ref_entry->end - ref_entry->start + 1;
+
+    if (ref_entry->start + offset + size - 1 > ref_entry->end) {
+        LOG_F(ERROR, "Partial mirror outside the origin, offset=0x%X, size=0x%X",
+              offset, size);
+        return false;
+    }
+
+    uint32_t end   = start_addr + size - 1;
     entry->start   = start_addr;
     entry->end     = end;
     entry->mirror  = dest_addr;
     entry->type    = ref_entry->type | RT_MIRROR;
-    entry->devobj  = 0;
-    entry->mem_ptr = ref_entry->mem_ptr;
+    entry->devobj  = nullptr;
+    entry->mem_ptr = ref_entry->mem_ptr + offset;
 
     this->address_map.push_back(entry);
 
@@ -218,7 +229,7 @@ bool MemCtrlBase::add_mem_mirror(uint32_t start_addr, uint32_t dest_addr) {
         entry->type & RT_MMIO ? "MMIO," : "",
         entry->type & RT_MIRROR ? "MIRROR," : "",
         dest_addr,
-        ref_entry->start, ref_entry->end,
+        ref_entry->start + offset, ref_entry->end,
         ref_entry->devobj ? " (" : "",
             ref_entry->devobj ? ref_entry->devobj->get_name().c_str() : "",
             ref_entry->devobj ? ")"
@@ -229,6 +240,17 @@ bool MemCtrlBase::add_mem_mirror(uint32_t start_addr, uint32_t dest_addr) {
 }
 
 
+bool MemCtrlBase::add_mem_mirror(uint32_t start_addr, uint32_t dest_addr) {
+    return this->add_mem_mirror_common(start_addr, dest_addr);
+}
+
+
+bool MemCtrlBase::add_mem_mirror_partial(uint32_t start_addr, uint32_t dest_addr,
+                                         uint32_t offset, uint32_t size) {
+    return this->add_mem_mirror_common(start_addr, dest_addr, offset, size);
+}
+
+
 bool MemCtrlBase::set_data(uint32_t load_addr, const uint8_t* data, uint32_t size) {
     AddressMapEntry* ref_entry;
     uint32_t cpy_size;
diff --git a/devices/memctrl/memctrlbase.h b/devices/memctrl/memctrlbase.h
index 44e51e2..b1de008 100644
--- a/devices/memctrl/memctrlbase.h
+++ b/devices/memctrl/memctrlbase.h
@@ -66,6 +66,8 @@ public:
     virtual bool add_rom_region(uint32_t start_addr, uint32_t size);
     virtual bool add_ram_region(uint32_t start_addr, uint32_t size);
     virtual bool add_mem_mirror(uint32_t start_addr, uint32_t dest_addr);
+    virtual bool add_mem_mirror_partial(uint32_t start_addr, uint32_t dest_addr,
+                                        uint32_t offset, uint32_t size);
 
     virtual bool add_mmio_region(uint32_t start_addr, uint32_t size,
                                  MMIODevice* dev_instance);
@@ -89,6 +91,9 @@ protected:
         uint8_t init_val
     );
 
+    bool add_mem_mirror_common(uint32_t start_addr, uint32_t dest_addr,
+                               uint32_t offset=0, uint32_t size=0);
+
 private:
     std::vector<uint8_t*> mem_regions;
     std::vector<AddressMapEntry*> address_map;