x86/intel-speed-select/isst.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * Intel Speed Select -- Enumerate and control features
0004  * Copyright (c) 2019 Intel Corporation.
0005  */
0006
0007 #ifndef _ISST_H_
0008 #define _ISST_H_
0009
0010 #include <stdio.h>
0011 #include <unistd.h>
0012 #include <sys/types.h>
0013 #include <sched.h>
0014 #include <sys/stat.h>
0015 #include <sys/resource.h>
0016 #include <getopt.h>
0017 #include <err.h>
0018 #include <fcntl.h>
0019 #include <signal.h>
0020 #include <sys/time.h>
0021 #include <limits.h>
0022 #include <stdlib.h>
0023 #include <string.h>
0024 #include <cpuid.h>
0025 #include <dirent.h>
0026 #include <errno.h>
0027
0028 #include <stdarg.h>
0029 #include <sys/ioctl.h>
0030
0031 #define BIT(x) (1 << (x))
0032 #define BIT_ULL(nr) (1ULL << (nr))
0033 #define GENMASK(h, l) (((~0UL) << (l)) & (~0UL >> (sizeof(long) * 8 - 1 - (h))))
0034 #define GENMASK_ULL(h, l)                                                      \
0035     (((~0ULL) << (l)) & (~0ULL >> (sizeof(long long) * 8 - 1 - (h))))
0036
0037 #define CONFIG_TDP              0x7f
0038 #define CONFIG_TDP_GET_LEVELS_INFO      0x00
0039 #define CONFIG_TDP_GET_TDP_CONTROL      0x01
0040 #define CONFIG_TDP_SET_TDP_CONTROL      0x02
0041 #define CONFIG_TDP_GET_TDP_INFO         0x03
0042 #define CONFIG_TDP_GET_PWR_INFO         0x04
0043 #define CONFIG_TDP_GET_TJMAX_INFO       0x05
0044 #define CONFIG_TDP_GET_CORE_MASK        0x06
0045 #define CONFIG_TDP_GET_TURBO_LIMIT_RATIOS   0x07
0046 #define CONFIG_TDP_SET_LEVEL            0x08
0047 #define CONFIG_TDP_GET_UNCORE_P0_P1_INFO    0X09
0048 #define CONFIG_TDP_GET_P1_INFO          0x0a
0049 #define CONFIG_TDP_GET_MEM_FREQ         0x0b
0050
0051 #define CONFIG_TDP_GET_FACT_HP_TURBO_LIMIT_NUMCORES 0x10
0052 #define CONFIG_TDP_GET_FACT_HP_TURBO_LIMIT_RATIOS   0x11
0053 #define CONFIG_TDP_GET_FACT_LP_CLIPPING_RATIO       0x12
0054
0055 #define CONFIG_TDP_PBF_GET_CORE_MASK_INFO   0x20
0056 #define CONFIG_TDP_PBF_GET_P1HI_P1LO_INFO   0x21
0057 #define CONFIG_TDP_PBF_GET_TJ_MAX_INFO      0x22
0058 #define CONFIG_TDP_PBF_GET_TDP_INFO     0X23
0059
0060 #define CONFIG_CLOS             0xd0
0061 #define CLOS_PQR_ASSOC              0x00
0062 #define CLOS_PM_CLOS                0x01
0063 #define CLOS_PM_QOS_CONFIG          0x02
0064 #define CLOS_STATUS             0x03
0065
0066 #define MBOX_CMD_WRITE_BIT          0x08
0067
0068 #define PM_QOS_INFO_OFFSET          0x00
0069 #define PM_QOS_CONFIG_OFFSET            0x04
0070 #define PM_CLOS_OFFSET              0x08
0071 #define PQR_ASSOC_OFFSET            0x20
0072
0073 #define READ_PM_CONFIG              0x94
0074 #define WRITE_PM_CONFIG             0x95
0075 #define PM_FEATURE              0x03
0076
0077 #define DISP_FREQ_MULTIPLIER 100
0078
0079 #define MAX_PACKAGE_COUNT 8
0080 #define MAX_DIE_PER_PACKAGE 2
0081
0082 struct isst_clos_config {
0083     int pkg_id;
0084     int die_id;
0085     unsigned char epp;
0086     unsigned char clos_prop_prio;
0087     unsigned char clos_min;
0088     unsigned char clos_max;
0089     unsigned char clos_desired;
0090 };
0091
0092 struct isst_fact_bucket_info {
0093     int high_priority_cores_count;
0094     int sse_trl;
0095     int avx_trl;
0096     int avx512_trl;
0097 };
0098
0099 struct isst_pbf_info {
0100     int pbf_acticated;
0101     int pbf_available;
0102     size_t core_cpumask_size;
0103     cpu_set_t *core_cpumask;
0104     int p1_high;
0105     int p1_low;
0106     int t_control;
0107     int t_prochot;
0108     int tdp;
0109 };
0110
0111 #define ISST_TRL_MAX_ACTIVE_CORES   8
0112 #define ISST_FACT_MAX_BUCKETS       8
0113 struct isst_fact_info {
0114     int lp_clipping_ratio_license_sse;
0115     int lp_clipping_ratio_license_avx2;
0116     int lp_clipping_ratio_license_avx512;
0117     struct isst_fact_bucket_info bucket_info[ISST_FACT_MAX_BUCKETS];
0118 };
0119
0120 struct isst_pkg_ctdp_level_info {
0121     int processed;
0122     int control_cpu;
0123     int pkg_id;
0124     int die_id;
0125     int level;
0126     int fact_support;
0127     int pbf_support;
0128     int fact_enabled;
0129     int pbf_enabled;
0130     int sst_cp_support;
0131     int sst_cp_enabled;
0132     int tdp_ratio;
0133     int active;
0134     int tdp_control;
0135     int pkg_tdp;
0136     int pkg_min_power;
0137     int pkg_max_power;
0138     int fact;
0139     int t_proc_hot;
0140     int uncore_p0;
0141     int uncore_p1;
0142     int sse_p1;
0143     int avx2_p1;
0144     int avx512_p1;
0145     int mem_freq;
0146     size_t core_cpumask_size;
0147     cpu_set_t *core_cpumask;
0148     int cpu_count;
0149     unsigned long long buckets_info;
0150     int trl_sse_active_cores[ISST_TRL_MAX_ACTIVE_CORES];
0151     int trl_avx_active_cores[ISST_TRL_MAX_ACTIVE_CORES];
0152     int trl_avx_512_active_cores[ISST_TRL_MAX_ACTIVE_CORES];
0153     int kobj_bucket_index;
0154     int active_bucket;
0155     int fact_max_index;
0156     int fact_max_config;
0157     int pbf_found;
0158     int pbf_active;
0159     struct isst_pbf_info pbf_info;
0160     struct isst_fact_info fact_info;
0161 };
0162
0163 #define ISST_MAX_TDP_LEVELS (4 + 1) /* +1 for base config */
0164 struct isst_pkg_ctdp {
0165     int locked;
0166     int version;
0167     int processed;
0168     int levels;
0169     int current_level;
0170     int enabled;
0171     struct isst_pkg_ctdp_level_info ctdp_level[ISST_MAX_TDP_LEVELS];
0172 };
0173
0174 extern int get_topo_max_cpus(void);
0175 extern int get_cpu_count(int pkg_id, int die_id);
0176 extern int get_max_punit_core_id(int pkg_id, int die_id);
0177
0178 /* Common interfaces */
0179 FILE *get_output_file(void);
0180 extern void debug_printf(const char *format, ...);
0181 extern int out_format_is_json(void);
0182 extern int get_physical_package_id(int cpu);
0183 extern int get_physical_die_id(int cpu);
0184 extern size_t alloc_cpu_set(cpu_set_t **cpu_set);
0185 extern void free_cpu_set(cpu_set_t *cpu_set);
0186 extern int find_logical_cpu(int pkg_id, int die_id, int phy_cpu);
0187 extern int find_phy_cpu_num(int logical_cpu);
0188 extern int find_phy_core_num(int logical_cpu);
0189 extern void set_cpu_mask_from_punit_coremask(int cpu,
0190                          unsigned long long core_mask,
0191                          size_t core_cpumask_size,
0192                          cpu_set_t *core_cpumask,
0193                          int *cpu_cnt);
0194
0195 extern int isst_send_mbox_command(unsigned int cpu, unsigned char command,
0196                   unsigned char sub_command,
0197                   unsigned int write,
0198                   unsigned int req_data, unsigned int *resp);
0199
0200 extern int isst_send_msr_command(unsigned int cpu, unsigned int command,
0201                  int write, unsigned long long *req_resp);
0202
0203 extern int isst_get_ctdp_levels(int cpu, struct isst_pkg_ctdp *pkg_dev);
0204 extern int isst_get_ctdp_control(int cpu, int config_index,
0205                  struct isst_pkg_ctdp_level_info *ctdp_level);
0206 extern int isst_get_coremask_info(int cpu, int config_index,
0207                struct isst_pkg_ctdp_level_info *ctdp_level);
0208 extern int isst_get_process_ctdp(int cpu, int tdp_level,
0209                  struct isst_pkg_ctdp *pkg_dev);
0210 extern void isst_get_process_ctdp_complete(int cpu,
0211                        struct isst_pkg_ctdp *pkg_dev);
0212 extern void isst_ctdp_display_information(int cpu, FILE *outf, int tdp_level,
0213                       struct isst_pkg_ctdp *pkg_dev);
0214 extern void isst_ctdp_display_core_info(int cpu, FILE *outf, char *prefix,
0215                     unsigned int val, char *str0, char *str1);
0216 extern void isst_ctdp_display_information_start(FILE *outf);
0217 extern void isst_ctdp_display_information_end(FILE *outf);
0218 extern void isst_pbf_display_information(int cpu, FILE *outf, int level,
0219                      struct isst_pbf_info *info);
0220 extern int isst_set_tdp_level(int cpu, int tdp_level);
0221 extern int isst_set_tdp_level_msr(int cpu, int tdp_level);
0222 extern int isst_set_pbf_fact_status(int cpu, int pbf, int enable);
0223 extern int isst_get_pbf_info(int cpu, int level,
0224                  struct isst_pbf_info *pbf_info);
0225 extern void isst_get_pbf_info_complete(struct isst_pbf_info *pbf_info);
0226 extern int isst_get_fact_info(int cpu, int level, int fact_bucket,
0227                   struct isst_fact_info *fact_info);
0228 extern int isst_get_fact_bucket_info(int cpu, int level,
0229                      struct isst_fact_bucket_info *bucket_info);
0230 extern void isst_fact_display_information(int cpu, FILE *outf, int level,
0231                       int fact_bucket, int fact_avx,
0232                       struct isst_fact_info *fact_info);
0233 extern int isst_set_trl(int cpu, unsigned long long trl);
0234 extern int isst_get_trl(int cpu, unsigned long long *trl);
0235 extern int isst_set_trl_from_current_tdp(int cpu, unsigned long long trl);
0236 extern int isst_get_config_tdp_lock_status(int cpu);
0237
0238 extern int isst_pm_qos_config(int cpu, int enable_clos, int priority_type);
0239 extern int isst_pm_get_clos(int cpu, int clos,
0240                 struct isst_clos_config *clos_config);
0241 extern int isst_set_clos(int cpu, int clos,
0242              struct isst_clos_config *clos_config);
0243 extern int isst_clos_associate(int cpu, int clos);
0244 extern int isst_clos_get_assoc_status(int cpu, int *clos_id);
0245 extern void isst_clos_display_information(int cpu, FILE *outf, int clos,
0246                       struct isst_clos_config *clos_config);
0247 extern void isst_clos_display_assoc_information(int cpu, FILE *outf, int clos);
0248 extern int isst_read_reg(unsigned short reg, unsigned int *val);
0249 extern int isst_write_reg(int reg, unsigned int val);
0250
0251 extern void isst_display_result(int cpu, FILE *outf, char *feature, char *cmd,
0252                 int result);
0253
0254 extern int isst_clos_get_clos_information(int cpu, int *enable, int *type);
0255 extern void isst_clos_display_clos_information(int cpu, FILE *outf,
0256                            int clos_enable, int type,
0257                            int state, int cap);
0258 extern int is_clx_n_platform(void);
0259 extern int get_cpufreq_base_freq(int cpu);
0260 extern int isst_read_pm_config(int cpu, int *cp_state, int *cp_cap);
0261 extern void isst_display_error_info_message(int error, char *msg, int arg_valid, int arg);
0262 extern int is_skx_based_platform(void);
0263 extern int is_spr_platform(void);
0264 extern int is_icx_platform(void);
0265 extern void isst_trl_display_information(int cpu, FILE *outf, unsigned long long trl);
0266
0267 extern void set_cpu_online_offline(int cpu, int state);
0268 extern void for_each_online_package_in_set(void (*callback)(int, void *, void *,
0269                                 void *, void *),
0270                        void *arg1, void *arg2, void *arg3,
0271                        void *arg4);
0272 extern int isst_daemon(int debug_mode, int poll_interval, int no_daemon);
0273 extern void process_level_change(int cpu);
0274 extern int hfi_main(void);
0275 extern void hfi_exit(void);
0276 #endif