lib/magma/src/magma_util/register_io.h

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef REGISTER_IO_H
#define REGISTER_IO_H

#include "magma_util/dlog.h"
#include "platform_mmio.h"
#include <memory>

namespace magma {

// RegisterIo wraps mmio access.
class RegisterIo {
public:
    RegisterIo(std::unique_ptr<magma::PlatformMmio> mmio);

    void Write32(uint32_t offset, uint32_t val)
    {
        mmio_->Write32(offset, val);
        if (hook_)
            hook_->Write32(offset, val);
    }

    uint32_t Read32(uint32_t offset)
    {
        uint32_t val = mmio_->Read32(offset);
        if (hook_)
            hook_->Read32(offset, val);
        return val;
    }

    uint64_t Read64(uint32_t offset)
    {
        uint64_t val = mmio_->Read64(offset);
        if (hook_)
            hook_->Read64(offset, val);
        return val;
    }

    magma::PlatformMmio* mmio() { return mmio_.get(); }

    class Hook {
    public:
        virtual ~Hook() = 0;
        virtual void Write32(uint32_t offset, uint32_t val) = 0;
        virtual void Read32(uint32_t offset, uint32_t val) = 0;
        virtual void Read64(uint32_t offset, uint64_t val) = 0;
    };

    void InstallHook(std::unique_ptr<Hook> hook)
    {
        DASSERT(!hook_);
        hook_ = std::move(hook);
    }

    Hook* hook() { return hook_.get(); }

private:
    std::unique_ptr<magma::PlatformMmio> mmio_;
    std::unique_ptr<Hook> hook_;
};

} // namespace magma

#endif // REGISTER_IO_H