uio_device.h

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-or-later
// Commercial license available
// © Concepts 1996–2026 Miroslav Šotek. All rights reserved.
// © Code 2020–2026 Miroslav Šotek. All rights reserved.
// ORCID: 0009-0009-3560-0851
// Contact: www.anulum.li | protoscience@anulum.li
// Loop Timing Witness — Linux UIO ownership and ordered register access

 
#ifndef WITNESS_UIO_DEVICE_H
#define WITNESS_UIO_DEVICE_H
 
#include "../process_protocol.h"
#include <cstddef>
 
namespace witness {
struct UioIdentity {
    std::string device, name, version;
    std::uint32_t map;
    std::uint64_t physical_address;
};

class UioDevice {
    int descriptor = -1;
    void *mapping = nullptr;
    std::size_t mapping_size = 0;
    std::size_t register_offset = 0;
    std::uint32_t interrupt_count = 0;
    bool irq_managed = false;

    void close() noexcept;
    void irq_control(std::int32_t enabled);
 
  public:
    explicit UioDevice(const UioIdentity &identity);
    ~UioDevice();
    UioDevice(const UioDevice &) = delete;
    UioDevice &operator=(const UioDevice &) = delete;

    std::uint64_t time() const;
    ProtocolReply read(std::uint8_t address);
    ProtocolReply write(std::uint8_t address, std::uint32_t data, std::uint8_t strobes);
    void advance(std::uint64_t nanoseconds);
    bool wait_interrupt(std::uint64_t nanoseconds);
    std::uint32_t last_interrupt_count() const { return interrupt_count; }
};
} // namespace witness
 
#endif