bank-interface.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "virtutech-c++" -*-
 
/*
  © 2022 Intel Corporation
 
  This software and the related documents are Intel copyrighted materials, and
  your use of them is governed by the express license under which they were
  provided to you ("License"). Unless the License provides otherwise, you may
  not use, modify, copy, publish, distribute, disclose or transmit this software
  or the related documents without Intel's prior written permission.
 
  This software and the related documents are provided as is, with no express or
  implied warranties, other than those that are expressly stated in the License.
*/
 
#ifndef SIMICS_BANK_INTERFACE_H
#define SIMICS_BANK_INTERFACE_H
 
#include <simics/base/memory.h>  // exception_type_t
#include <simics/base/transaction.h>  // transaction_t
 
#include <cstdint>
#include <map>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
#include "simics/type/register-type.h"
 
namespace simics {
 
enum class ByteOrder {
    BE, LE,
};
 
class MappableConfObject;
class RegisterInterface;
class BankIssueCallbacksInterface;
 
class BankInterface {
  public:
    virtual ~BankInterface() = default;
 
    virtual std::string_view name() const = 0;
 
    virtual MappableConfObject *dev_obj() const = 0;
 
    virtual const std::string &description() const = 0;
 
    virtual void set_description(std::string_view desc) = 0;
 
    virtual void add_register(const register_t &reg) = 0;
 
    virtual void add_register(std::string_view name, std::string_view desc,
                              Offset offset, ByteSize number_of_bytes,
                              InitValue init_value,
                              const std::vector<field_t> &fields) = 0;
 
    virtual unsigned number_of_registers() const = 0;
 
    virtual std::pair<size_t, RegisterInterface *> register_at_index(
            unsigned index) const = 0;
 
    virtual const std::map<size_t, RegisterInterface *> &
    mapped_registers() const = 0;
 
    virtual void set_callbacks(BankIssueCallbacksInterface *callbacks) = 0;
 
    virtual ByteOrder get_byte_order() const = 0;
 
    virtual void set_miss_pattern(uint8_t miss_pattern) = 0;
 
    virtual exception_type_t transaction_access(transaction_t *t,
                                                uint64_t offset) = 0;
};
 
}  // namespace simics
 
#endif