register-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_IFACE_REGISTER_INTERFACE_H
#define SIMICS_IFACE_REGISTER_INTERFACE_H
 
#include <string_view>
#include <string>
#include <vector>
#include <cstdint>
 
#include "../conf-object.h"
#include "value-accessor-interface.h"
#include "value-mutator-interface.h"
#include "../type/field-type.h"
#include "../type/register-type.h"
 
namespace simics {
 
class MappableConfObject;
class BankInterface;
 
class RegisterInterface : public ValueAccessorInterface,
                          public ValueMutatorInterface {
  public:
    virtual ~RegisterInterface() = default;
 
    // @return the register name without level delimiter
    virtual std::string_view name() const = 0;
 
    // @return the hierarchical name for the register including the bank name
    virtual const std::string &hierarchical_name() const = 0;
 
    // @return the description string
    virtual const std::string &description() const = 0;
 
    // @return the device object holds the register
    virtual MappableConfObject *dev_obj() const = 0;
 
    virtual ConfObjectRef bank_obj_ref() const = 0;
 
    // @return the register size in bytes
    virtual unsigned number_of_bytes() const = 0;
 
    /*
     *Initialize the register with a description, size in bytes and an initial
     * value. Typically called after the register is instantiated.
     */
    virtual void init(std::string_view desc, unsigned number_of_bytes,
                      uint64_t init_val) = 0;
 
    // Reset to the initial value
    virtual void reset() = 0;
 
    // @return if the register is read-only
    virtual bool is_read_only() const = 0;
 
    // @return if the register is mapped
    virtual bool is_mapped() const = 0;
 
    /*
     * Parse the field information, add the field or field array into
     * the resource map. The field reuses the memory allocated for the
     * enclosing register.
     * offset 0 is always the least significant bit regardless of bit order
     * e.g.  2 bytes value 0b10100111
     *                       |      |
     *                  offset:7  offset:0  => width = 8
     */
    virtual void parse_field(const field_t &f) = 0;
 
    // @return information of fields in the register
    virtual std::vector<field_t> fields_info() const = 0;
 
    // @return the parent bank interface
    virtual BankInterface *parent() const = 0;
 
    virtual void set_byte_pointers(
            const register_memory_t &byte_pointers) = 0;
};
 
}  // namespace simics
 
#endif