geopm_pio.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef GEOPM_PIO_H_INCLUDE
#define GEOPM_PIO_H_INCLUDE
 
#include <stddef.h>
#include <limits.h>
#include "geopm_public.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define GEOPM_NAME_MAX 255ULL
 
int GEOPM_PUBLIC
    geopm_pio_num_signal_name(void);
 
int GEOPM_PUBLIC
    geopm_pio_signal_name(int name_idx, size_t result_max, char *result);
 
int GEOPM_PUBLIC
    geopm_pio_num_control_name(void);
 
int GEOPM_PUBLIC
    geopm_pio_control_name(int name_index, size_t result_max, char *result);
 
int GEOPM_PUBLIC
    geopm_pio_signal_domain_type(const char *signal_name);
 
int GEOPM_PUBLIC
    geopm_pio_control_domain_type(const char *control_name);
 
int GEOPM_PUBLIC
    geopm_pio_read_signal(const char *signal_name, int domain_type,
                          int domain_idx, double *result);
 
int GEOPM_PUBLIC
    geopm_pio_write_control(const char *control_name, int domain_type,
                            int domain_idx, double setting);
 
int GEOPM_PUBLIC
    geopm_pio_push_signal(const char *signal_name, int domain_type, int domain_idx);
 
int GEOPM_PUBLIC
    geopm_pio_push_control(const char *control_name, int domain_type, int domain_idx);
 
int GEOPM_PUBLIC
    geopm_pio_sample(int signal_idx, double *result);
 
int GEOPM_PUBLIC
    geopm_pio_adjust(int control_idx, double setting);
 
int GEOPM_PUBLIC
    geopm_pio_read_batch(void);
 
int GEOPM_PUBLIC
    geopm_pio_write_batch(void);
 
int GEOPM_PUBLIC
    geopm_pio_save_control(void);
 
int GEOPM_PUBLIC
    geopm_pio_save_control_dir(const char *save_dir);
 
int GEOPM_PUBLIC
    geopm_pio_restore_control(void);
 
int GEOPM_PUBLIC
    geopm_pio_restore_control_dir(const char *save_dir);
 
int GEOPM_PUBLIC
    geopm_pio_signal_description(const char *signal_name, size_t description_max,
                                 char *description);
 
int GEOPM_PUBLIC
    geopm_pio_control_description(const char *control_name, size_t description_max,
                                  char *description);
 
int GEOPM_PUBLIC
    geopm_pio_signal_info(const char *signal_name, int *aggregation_type,
                          int *format_type, int *behavior_type);
 
struct GEOPM_PUBLIC geopm_request_s {
    int domain_type;
    int domain_idx;
    char name[GEOPM_NAME_MAX];
};
 
int GEOPM_PUBLIC
    geopm_pio_start_batch_server(int client_pid, int num_signal,
                                 const struct geopm_request_s *signal_config,
                                 int num_control,
                                 const struct geopm_request_s *control_config,
                                 int *server_pid, int key_size, char *server_key);
 
int GEOPM_PUBLIC
    geopm_pio_stop_batch_server(int server_pid);
 
int GEOPM_PUBLIC
    geopm_pio_format_signal(double signal, int format_type, size_t result_max,
                            char *result);
 
void GEOPM_PUBLIC
    geopm_pio_reset(void);
 
int GEOPM_PUBLIC
    geopm_pio_check_valid_value(double value);
 
int GEOPM_PUBLIC
    geopm_pio_profile_pids(const char *profile_name, int max_num_pid, int *num_pid, int *pid);
 
#ifdef __cplusplus
}
#endif
#endif