refactor: use UioRegion instead of phys_addr/size

Author: patrislav1

.gitignore

@@ -2,6 +2,7 @@
 /pyudmaio/build*
 /pyudmaio/pyudmaio/*.so
 /.vscode
+/.cache
 *.pyc
 *.egg-info
 

inc/udmaio/DmaBufferAbstract.hpp

@@ -26,13 +26,9 @@ class DmaBufferAbstract : private boost::noncopyable {
     virtual void copy_from_buf(uint8_t* dest, const UioRegion& buf_info) const = 0;
 
   public:
-    /// @brief Get physical address
-    /// @return Physical address of DMA data buffer
-    virtual uintptr_t get_phys_addr() const = 0;
-
-    /// @brief Get buffer size
-    /// @return Size of DMA data buffer
-    virtual uintptr_t get_phys_size() const = 0;
+    /// @brief Get physical region
+    /// @return Physical address and size of DMA data buffer
+    virtual UioRegion get_phys_region() const = 0;
 
     /// @brief Append received DMA data to vector
     /// @param buf_info Memory region of DMA buffer

inc/udmaio/FpgaMemBufferOverAxi.hpp

@@ -25,11 +25,9 @@ namespace udmaio {
 /// DMA data buffer accessed over AXI/UIO, described w/ explicit address & size
 class FpgaMemBufferOverAxi : public DmaBufferAbstract, public UioIf {
   public:
-    FpgaMemBufferOverAxi(UioDeviceLocation dev_loc) : UioIf("FpgaMemBufferOverAxi", hw) {}
+    FpgaMemBufferOverAxi(UioDeviceLocation dev_loc) : UioIf("FpgaMemBufferOverAxi", dev_loc) {}
 
-    uintptr_t get_phys_addr() const override { return _region.addr; }
-
-    uintptr_t get_phys_size() const override { return _region.size; }
+    UioRegion get_phys_region() const override { return _hw->get_phys_region(); }
 
   protected:
     void copy_from_buf(uint8_t* dest, const UioRegion& buf_info) const override {
@@ -38,8 +36,8 @@ class FpgaMemBufferOverAxi : public DmaBufferAbstract, public UioIf {
             << buf_info.addr << std::dec;
         BOOST_LOG_SEV(_lg, bls::trace)
             << "FpgaMemBufferOverAxi: append_from_buf: buf_info.size = " << buf_info.size;
-        uintptr_t mmap_addr = buf_info.addr - _region.addr;
-        std::memcpy(dest, static_cast<uint8_t*>(_mem) + mmap_addr, buf_info.size);
+        uintptr_t mmap_addr = buf_info.addr - get_phys_region().addr;
+        std::memcpy(dest, static_cast<uint8_t*>(_hw->get_virt_mem()) + mmap_addr, buf_info.size);
     }
 };
 

inc/udmaio/FpgaMemBufferOverXdma.hpp

@@ -22,14 +22,14 @@ namespace udmaio {
 /// DMA data buffer accessed over XDMA using the xdma c2h0 stream channel
 class FpgaMemBufferOverXdma : public DmaBufferAbstract {
     int _dma_fd;
-    uintptr_t _phys_addr;
+    UioRegion _phys_region;
 
   public:
     /// @brief Constructs a DMA data buffer
     /// @param path Base path of XDMA instance in `/dev`
     /// @param phys_addr Physical address of DMA data buffer
     explicit FpgaMemBufferOverXdma(const std::string& path, uintptr_t phys_addr)
-        : _phys_addr{phys_addr} {
+        : _phys_region{phys_addr, 0} {  // FIXME: can we get the memory size?
         const std::string dev_path{path + "/c2h0"};
         _dma_fd = open(dev_path.c_str(), O_RDWR);
         if (_dma_fd < 0) {
@@ -38,12 +38,7 @@ class FpgaMemBufferOverXdma : public DmaBufferAbstract {
     }
     virtual ~FpgaMemBufferOverXdma() { close(_dma_fd); }
 
-    uintptr_t get_phys_addr() const override { return _phys_addr; }
-
-    uintptr_t get_phys_size() const override {
-        // there is no way to get the size over the Xdma, return 0 and let the user handle it
-        return 0;
-    }
+    UioRegion get_phys_region() const override { return _phys_region; }
 
   protected:
     void copy_from_buf(uint8_t* dest, const UioRegion& buf_info) const override {

inc/udmaio/HwAccessor.hpp

@@ -109,7 +109,8 @@ class HwAccessor : public Logger, private boost::noncopyable {
     virtual void arm_interrupt();
     virtual uint32_t wait_for_interrupt();
     virtual int get_fd_int() const { return -1; }
-    virtual uintptr_t get_phys_addr() const { return 0; }
+    virtual UioRegion get_phys_region() const { return {0, 0}; }
+    virtual void* get_virt_mem() const { return nullptr; }
 };
 
 // Base class for mmap'ed hardware access
@@ -216,7 +217,8 @@ class HwAccessorMmap : public HwAccessor {
     }
 
   public:
-    uintptr_t get_phys_addr() const final override { return _region.addr; }
+    UioRegion get_phys_region() const final override { return _region; }
+    void* get_virt_mem() const final override { return _mem; }
 };
 
 // Hardware accessor for XDMA. Can support either 32 or 64 bit access

inc/udmaio/UDmaBuf.hpp

@@ -13,6 +13,7 @@
 
 #include "DmaBufferAbstract.hpp"
 #include "Logging.hpp"
+#include "udmaio/UioConfig.hpp"
 
 namespace udmaio {
 
@@ -34,8 +35,7 @@ class UDmaBuf : public DmaBufferAbstract, public Logger {
 
     virtual ~UDmaBuf();
 
-    uintptr_t get_phys_addr() const override;
-    uintptr_t get_phys_size() const override;
+    UioRegion get_phys_region() const override;
 };
 
 }  // namespace udmaio

src/UDmaBuf.cpp

@@ -68,12 +68,8 @@ UDmaBuf::~UDmaBuf() {
     ::close(_fd);
 }
 
-uintptr_t UDmaBuf::get_phys_addr() const {
-    return _phys.addr;
-}
-
-uintptr_t UDmaBuf::get_phys_size() const {
-    return _phys.size;
+UioRegion UDmaBuf::get_phys_region() const {
+    return _phys;
 }
 
 void UDmaBuf::copy_from_buf(uint8_t* dest, const UioRegion& buf_info) const {

src/UioMemSgdma.cpp

@@ -11,19 +11,20 @@
 
 #include "udmaio/UioMemSgdma.hpp"
 
-#include <bitset>
+#include <cstdint>
 
 namespace udmaio {
 
 void UioMemSgdma::write_cyc_mode(const std::vector<UioRegion>& dst_bufs) {
     _nr_cyc_desc = dst_bufs.size();
     _next_readable_buf = 0;
     size_t i = 0;
+
     for (auto dst_buf : dst_bufs) {
         BOOST_LOG_SEV(_lg, bls::trace)
             << "dest buf addr = 0x" << std::hex << dst_buf.addr << std::dec;
 
-        uintptr_t nxtdesc = _hw->get_phys_addr() + ((i + 1) % _nr_cyc_desc) * DESC_ADDR_STEP;
+        uintptr_t nxtdesc = get_first_desc_addr() + ((i + 1) % _nr_cyc_desc) * DESC_ADDR_STEP;
 
         S2mmDesc desc{
             .nxtdesc = nxtdesc,
@@ -47,7 +48,7 @@ void UioMemSgdma::init_buffers(DmaBufferAbstract& mem, size_t num_buffers, size_
     std::vector<UioRegion> dst_bufs;
     for (size_t i = 0; i < num_buffers; i++) {
         dst_bufs.push_back({
-            .addr = mem.get_phys_addr() + i * buf_size,
+            .addr = mem.get_phys_region().addr + i * buf_size,
             .size = buf_size,
         });
     };
@@ -84,7 +85,7 @@ void UioMemSgdma::print_descs() const {
 }
 
 uintptr_t UioMemSgdma::get_first_desc_addr() const {
-    return _hw->get_phys_addr();
+    return _hw->get_phys_region().addr;
 }
 
 std::ostream& operator<<(std::ostream& os, const UioRegion& buf_info) {