blob: 8292143a8585e026cbf69549b16b1622b82625a6 [file] [log] [blame]
#pragma once
#include <cstdint>
#include <span>
#include <vector>
namespace bios_bmc_smm_error_logger
{
/**
* Each data transport mechanism must implement the DataInterface.
*/
class DataInterface
{
public:
virtual ~DataInterface() = default;
/**
* Read bytes from shared buffer (blocking call).
*
* @param[in] offset - offset to read from relative to MMIO space
* @param[in] length - number of bytes to read
* @return the bytes read
*/
virtual std::vector<uint8_t> read(const uint32_t offset,
const uint32_t length) = 0;
/**
* Write bytes to shared buffer.
*
* @param[in] offset - offset to write to relative to MMIO space
* @param[in] bytes - byte vector of data.
* @return return the byte length written
*/
virtual uint32_t write(const uint32_t offset,
const std::span<const uint8_t> bytes) = 0;
/**
* Getter for Memory Region Size
*
* @return return Memory Region size allocated
*/
virtual uint32_t getMemoryRegionSize() = 0;
};
} // namespace bios_bmc_smm_error_logger