SSTIoctl.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef SSTIOCTL_HPP_INCLUDE
#define SSTIOCTL_HPP_INCLUDE
 
#include <cstdint>
 
#include <memory>
#include <vector>
 
namespace geopm
{
    struct sst_version_s {
        uint16_t interface_version;
        uint16_t driver_version;
        uint16_t batch_command_limit;
        uint8_t is_mbox_supported;
        uint8_t is_mmio_supported;
    };
 
    struct sst_cpu_map_interface_s {
        uint32_t cpu_index;
        uint32_t punit_cpu;
    };
 
    struct sst_cpu_map_interface_batch_s {
        uint32_t num_entries;
        sst_cpu_map_interface_s interfaces[1];
    };
 
    struct sst_mmio_interface_s {
        uint32_t is_write;
        uint32_t cpu_index;
        uint32_t register_offset;
        uint32_t value;
    };
 
    struct sst_mmio_interface_batch_s {
        uint32_t num_entries;
        sst_mmio_interface_s interfaces[1];
    };
 
    struct sst_mbox_interface_s {
        uint32_t cpu_index;
        uint32_t mbox_interface_param; // Parameter to the mbox interface
                                       // itself
        uint32_t write_value; // Mailbox data, or input parameter for a read
        uint32_t read_value;  // Mailbox data (read-only)
        uint16_t command;
        uint16_t subcommand;
        uint32_t reserved;
    };
 
    struct sst_mbox_interface_batch_s {
        uint32_t num_entries;
        sst_mbox_interface_s interfaces[1];
    };
 
    class SSTIoctl
    {
        public:
            virtual ~SSTIoctl() = default;
 
            virtual int version(sst_version_s *version) = 0;
 
            virtual int get_cpu_id(sst_cpu_map_interface_batch_s *cpu_batch) = 0;
 
            virtual int mbox(sst_mbox_interface_batch_s *mbox_batch) = 0;
 
            virtual int mmio(sst_mmio_interface_batch_s *mmio_batch) = 0;
 
            static std::shared_ptr<SSTIoctl> make_shared(const std::string &path);
    };
}
#endif