lpc_handler.hpp

#pragma once

#include "data_handler.hpp"
#include "lpc_interface.hpp"

#include <cstdint>
#include <memory>
#include <vector>

namespace blobs
{

struct LpcRegion
{
    /* Host LPC address where the chunk is to be mapped. */
    std::uint32_t address;

    /* Size of the chunk to be mapped. */
    std::uint32_t length;
} __attribute__((packed));

/**
 * Data Handler for configuration the ASPEED LPC memory region, reading and
 * writing data.
 */
class LpcDataHandler : public DataInterface
{
  public:
    /**
     * Create an LpcDataHandler.
     *
     * @param[in] regionAddress - BMC address to point the map for the LPC
     * memory region.
     * @param[in] mapper - pointer to a mapper implementation to use.
     */
    LpcDataHandler(std::uint32_t regionAddress,
                   std::unique_ptr<LpcMapperInterface> mapper) :
        regionAddress(regionAddress),
        mapper(std::move(mapper)), initialized(false)
    {
    }

    bool open() override;
    bool close() override;
    std::vector<std::uint8_t> copyFrom(std::uint32_t length) override;
    bool write(const std::vector<std::uint8_t>& configuration) override;
    std::vector<std::uint8_t> read() override;

  private:
    bool setInitializedAndReturn(bool value)
    {
        initialized = value;
        return value;
    }

    std::uint32_t regionAddress;
    std::unique_ptr<LpcMapperInterface> mapper;
    bool initialized;
};

} // namespace blobs