SysfsDriver.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2025 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef SYSFSDRIVER_HPP_INCLUDE
#define SYSFSDRIVER_HPP_INCLUDE
 
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <vector>
 
namespace geopm
{
    class SysfsDriver
    {
        public:
            static constexpr size_t M_IO_BUFFER_SIZE = 128;
            struct properties_s {
                std::string name; // The full low level PlatformIO name
                bool is_writable; // True if this is a control property
                std::string attribute; // sysfs attribute name
                std::string description; // Long description for documentation
                double scaling_factor; // SI unit conversion factor
                int units; // IOGroup::m_units_e
                std::function<double(const std::vector<double> &)> aggregation_function;
                int behavior; // IOGroup::m_signal_behavior_e
                std::function<std::string(double)> format_function;
                std::string alias; // Either empty string or name of high level alias
            };
            struct derived_signal_info_s {
                properties_s properties;
                std::string source_signal; // Canonical name of the backing signal
                std::string source_alias; // Preferred alias to request backing signal
            };
            SysfsDriver() = default;
            virtual ~SysfsDriver() = default;
            virtual int domain_type(const std::string &name) const = 0;
            virtual std::string attribute_path(const std::string &name,
                                               int domain_idx) = 0;
            virtual std::function<double(const std::string&)> signal_parse(const std::string &signal_name) const = 0;
            virtual std::function<std::string(double)> control_gen(const std::string &control_name) const = 0;
            virtual std::string driver(void) const = 0;
            virtual std::map<std::string, SysfsDriver::properties_s> properties(void) const = 0;
            virtual std::map<std::string, derived_signal_info_s> derived_signals(void) const;
            static std::map<std::string, SysfsDriver::properties_s> parse_properties_json(const std::string &iogroup_name, const std::string &properties_json);
    };
}
 
#endif