MemMap.cpp

Go to the documentation of this file.

 
#include "rogue/Directives.h"
 
#include "rogue/hardware/MemMap.h"
 
#include <fcntl.h>
#include <inttypes.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
 
#include <cstdio>
#include <cstring>
#include <memory>
#include <thread>
 
#include "rogue/GeneralError.h"
#include "rogue/GilRelease.h"
#include "rogue/interfaces/memory/Constants.h"
#include "rogue/interfaces/memory/Transaction.h"
#include "rogue/interfaces/memory/TransactionLock.h"
 
namespace rh  = rogue::hardware;
namespace rim = rogue::interfaces::memory;
 
#ifndef NO_PYTHON
    #include <boost/python.hpp>
namespace bp = boost::python;
#endif
 
rh::MemMapPtr rh::MemMap::create(uint64_t base, uint32_t size) {
    rh::MemMapPtr r = std::make_shared<rh::MemMap>(base, size);
    return (r);
}
 
rh::MemMap::MemMap(uint64_t base, uint32_t size) : rim::Slave(4, 0xFFFFFFFF) {
    log_ = rogue::Logging::create("MemMap");
 
    size_ = size;
 
    fd_ = ::open(MAP_DEVICE, O_RDWR);
 
    if (fd_ < 0) throw(rogue::GeneralError::create("MemMap::MemMap", "Failed to open device file: %s", MAP_DEVICE));
 
    if ((map_ = reinterpret_cast<uint8_t*>(mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd_, base))) ==
        reinterpret_cast<void*>(-1))
        throw(rogue::GeneralError::create("MemMap::MemMap", "Failed to map memory to user space."));
 
    log_->debug("Created map to 0x%" PRIx64 " with size 0x%" PRIx32, base, size);
 
    // Start read thread
    threadEn_ = true;
    thread_   = new std::thread(&rh::MemMap::runThread, this);
}
 
rh::MemMap::~MemMap() {
    this->stop();
}
 
void rh::MemMap::stop() {
    if (threadEn_) {
        rogue::GilRelease noGil;
        threadEn_ = false;
        queue_.stop();
        thread_->join();
        munmap(reinterpret_cast<void*>(const_cast<uint8_t*>(map_)), size_);
        ::close(fd_);
    }
}
 
void rh::MemMap::doTransaction(rim::TransactionPtr tran) {
    rogue::GilRelease noGil;
    queue_.push(tran);
}
 
void rh::MemMap::runThread() {
    rim::TransactionPtr tran;
 
    uint32_t* tPtr;
    uint32_t* mPtr;
    uint32_t count;
 
    log_->logThreadId();
 
    while (threadEn_) {
        if ((tran = queue_.pop()) != NULL) {
            count = 0;
 
            rim::TransactionLockPtr lock = tran->lock();
 
            if (tran->expired()) {
                log_->warning("Transaction expired. Id=%" PRIu32, tran->id());
                tran.reset();
                continue;
            }
 
            if ((tran->size() % 4) != 0) {
                tran->error("Invalid transaction size %" PRIu32 ", must be an integer number of 4 bytes", tran->size());
                tran.reset();
                continue;
            }
 
            // Check that the address is legal
            if ((tran->address() + tran->size()) > size_) {
                tran->error("Request transaction to address 0x%" PRIx64 " with size %" PRIu32 " is out of bounds",
                            tran->address(),
                            tran->size());
                tran.reset();
                continue;
            }
 
            tPtr = reinterpret_cast<uint32_t*>(tran->begin());
            mPtr = const_cast<uint32_t*>(reinterpret_cast<volatile uint32_t*>(map_ + tran->address()));
 
            while (count != tran->size()) {
                // Write or post
                if (tran->type() == rim::Write || tran->type() == rim::Post) *mPtr = *tPtr;
 
                // Read or verify
                else
                    *tPtr = *mPtr;
 
                ++mPtr;
                ++tPtr;
                count += 4;
            }
 
            log_->debug("Transaction id=%" PRIu32 ", addr 0x%08" PRIx64 ". Size=%" PRIu32 ", type=%" PRIu32,
                        tran->id(),
                        tran->address(),
                        tran->size(),
                        tran->type());
            tran->done();
        }
    }
}
 
void rh::MemMap::setup_python() {
#ifndef NO_PYTHON
 
    bp::class_<rh::MemMap, rh::MemMapPtr, bp::bases<rim::Slave>, boost::noncopyable>("MemMap",
                                                                                     bp::init<uint64_t, uint32_t>());
 
    bp::implicitly_convertible<rh::MemMapPtr, rim::SlavePtr>();
#endif
}