field-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_FIELD_INTERFACE_H
#define SIMICS_IFACE_FIELD_INTERFACE_H
 
#include <string_view>
#include <vector>
#include <string>
#include <utility>  // pair
#include <cstdint>
 
#include "value-accessor-interface.h"
#include "value-mutator-interface.h"
 
namespace simics {
// Byte pointer and bits mask
using bits_type = std::vector<std::pair<uint8_t *, uint8_t>>;
class RegisterInterface;
 
class FieldInterface : public ValueAccessorInterface,
                       public ValueMutatorInterface {
  public:
    virtual ~FieldInterface() = default;
 
    // @return the field name without level delimiter
    virtual std::string_view name() const = 0;
 
    // @return the description string
    virtual const std::string &description() const = 0;
 
    // @return the number of bits for this field
    virtual unsigned number_of_bits() const = 0;
 
    // Initialize the field
    // @param offset is the offset of the first bit in the containing register
    virtual void init(std::string_view desc, const bits_type &bits,
                      int8_t offset) = 0;
 
    // @return the parent register interface
    virtual RegisterInterface *parent() const = 0;
};
 
}  // namespace simics
 
#endif