SSTIO.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef SSTIO_HPP_INCLUDE
#define SSTIO_HPP_INCLUDE
 
#include <cstdint>
 
#include <vector>
#include <memory>
 
namespace geopm
{
    class SSTIO
    {
        public:
            SSTIO() = default;
            virtual ~SSTIO() = default;
 
            virtual int add_mbox_read(uint32_t cpu_index, uint16_t command,
                                      uint16_t subcommand, uint32_t subcommand_arg) = 0;
 
            virtual int add_mbox_write(uint32_t cpu_index, uint16_t command,
                                       uint16_t subcommand, uint32_t interface_parameter,
                                       uint16_t read_subcommand,
                                       uint32_t read_interface_parameter,
                                       uint32_t read_mask) = 0;
 
            virtual int add_mmio_read(uint32_t cpu_index, uint16_t register_offset) = 0;
 
            virtual int add_mmio_write(uint32_t cpu_index, uint16_t register_offset,
                                       uint32_t register_value,
                                       uint32_t read_mask) = 0;
 
            virtual void read_batch(void) = 0;
 
            virtual uint64_t sample(int batch_idx) const = 0;
 
            virtual void write_batch(void) = 0;
 
            virtual uint32_t read_mbox_once(uint32_t cpu_index, uint16_t command,
                                            uint16_t subcommand, uint32_t subcommand_arg) = 0;
 
            virtual void write_mbox_once(uint32_t cpu_index, uint16_t command,
                                         uint16_t subcommand,
                                         uint32_t interface_parameter,
                                         uint16_t read_subcommand,
                                         uint32_t read_interface_parameter,
                                         uint32_t read_mask, uint64_t write_value,
                                         uint64_t write_mask) = 0;
 
            virtual uint32_t read_mmio_once(uint32_t cpu_index, uint16_t register_offset) = 0;
 
            virtual void write_mmio_once(uint32_t cpu_index, uint16_t register_offset,
                                         uint32_t register_value,
                                         uint32_t read_mask, uint64_t write_value,
                                         uint64_t write_mask) = 0;
 
            virtual void adjust(int batch_idx, uint64_t write_value, uint64_t write_mask) = 0;
 
            virtual uint32_t get_punit_from_cpu(uint32_t cpu_index) = 0;
 
            static std::shared_ptr<SSTIO> make_shared(uint32_t max_cpus);
    };
 
}
 
#endif