MemMap.h

Go to the documentation of this file.

 
#ifndef __ROGUE_HARDWARE_MEM_MAP_H__
#define __ROGUE_HARDWARE_MEM_MAP_H__
#include "rogue/Directives.h"
 
#include <stdint.h>
 
#include <atomic>
#include <memory>
#include <mutex>
#include <thread>
 
#include "rogue/Logging.h"
#include "rogue/Queue.h"
#include "rogue/interfaces/memory/Slave.h"
#include "rogue/interfaces/memory/Transaction.h"
 
#define MAP_DEVICE "/dev/mem"
 
namespace rogue {
namespace hardware {
 
class MemMap : public rogue::interfaces::memory::Slave {
    // `/dev/mem` file descriptor.
    int32_t fd_;
 
    // Mapped region size in bytes.
    uint64_t size_;
 
    // Base pointer of mapped memory region.
    volatile uint8_t* map_;
 
    // Logging
    std::shared_ptr<rogue::Logging> log_;
 
  protected:
    std::unique_ptr<std::thread> thread_;
    std::atomic<bool> threadEn_{false};
 
  private:
    // Background worker thread entry point.
    void runThread();
 
    // Queue
    rogue::Queue<std::shared_ptr<rogue::interfaces::memory::Transaction>> queue_;
 
  public:
    static std::shared_ptr<rogue::hardware::MemMap> create(uint64_t base, uint32_t size);
 
    static void setup_python();
 
    MemMap(uint64_t base, uint32_t size);
 
    ~MemMap();
 
    void stop();
 
    void doTransaction(std::shared_ptr<rogue::interfaces::memory::Transaction> tran);
};
 
typedef std::shared_ptr<rogue::hardware::MemMap> MemMapPtr;
 
}  // namespace hardware
};  // namespace rogue
 
#endif