datamover.hpp

/*
 * See LICENSE for more information about licensing
 *
 * Copyright 2023
 * Author: Luis G. Leon-Vega <luis.leon@ieee.org>
 *         Diego Arturo Avila Torres <diego.avila@uned.cr>
 *
 */
#pragma once
#include <cynq/execution-graph.hpp>
#include <memory>
 
#include "cynq/enums.hpp"
#include "cynq/memory.hpp"
#include "cynq/status.hpp"
 
namespace cynq {
 
struct HardwareParameters;
 
struct DataMoverParameters {
  std::shared_ptr<HardwareParameters> hw_params_;
  virtual ~DataMoverParameters() = default;
};
 
struct HardwareParameters;
 
class IDataMover {
 public:
  virtual ~IDataMover() = default;
  enum Type {
    None = 0,
    DMA,
    XRT
  };
  virtual std::shared_ptr<IMemory> GetBuffer(
      const size_t size, const int memory_bank = 0,
      const MemoryType type = MemoryType::Dual) = 0;
  virtual Status Upload(const std::shared_ptr<IMemory> mem, const size_t size,
                        const size_t offset, const ExecutionType exetype) = 0;
 
  virtual Status Upload(std::shared_ptr<IExecutionGraph> graph,
                        const std::shared_ptr<IMemory> mem, const size_t size,
                        const size_t offset, const ExecutionType exetype);
 
  virtual Status Download(const std::shared_ptr<IMemory> mem, const size_t size,
                          const size_t offset, const ExecutionType exetype) = 0;
 
  virtual Status Download(std::shared_ptr<IExecutionGraph> graph,
                          const std::shared_ptr<IMemory> mem, const size_t size,
                          const size_t offset, const ExecutionType exetype);
 
  virtual Status Sync(const SyncType type) = 0;
 
  virtual Status Sync(std::shared_ptr<IExecutionGraph> graph,
                      const SyncType type);
 
  virtual DeviceStatus GetStatus() = 0;
 
  static std::shared_ptr<IDataMover> Create(
      IDataMover::Type impl, const uint64_t addr,
      std::shared_ptr<HardwareParameters> hwparams);
};
}  // namespace cynq