xref: /linux/tools/power/x86/intel-speed-select/isst.h (revision 1d1997db870f4058676439ef7014390ba9e24eb2)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Intel Speed Select -- Enumerate and control features
4  * Copyright (c) 2019 Intel Corporation.
5  */
6 
7 #ifndef _ISST_H_
8 #define _ISST_H_
9 
10 #include <stdio.h>
11 #include <unistd.h>
12 #include <sys/types.h>
13 #include <sched.h>
14 #include <sys/stat.h>
15 #include <sys/resource.h>
16 #include <getopt.h>
17 #include <err.h>
18 #include <fcntl.h>
19 #include <signal.h>
20 #include <sys/time.h>
21 #include <limits.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <cpuid.h>
25 #include <dirent.h>
26 #include <errno.h>
27 
28 #include <stdarg.h>
29 #include <sys/ioctl.h>
30 
31 #define BIT(x) (1 << (x))
32 #define GENMASK(h, l) (((~0UL) << (l)) & (~0UL >> (sizeof(long) * 8 - 1 - (h))))
33 #define GENMASK_ULL(h, l)                                                      \
34 	(((~0ULL) << (l)) & (~0ULL >> (sizeof(long long) * 8 - 1 - (h))))
35 
36 #define CONFIG_TDP				0x7f
37 #define CONFIG_TDP_GET_LEVELS_INFO		0x00
38 #define CONFIG_TDP_GET_TDP_CONTROL		0x01
39 #define CONFIG_TDP_SET_TDP_CONTROL		0x02
40 #define CONFIG_TDP_GET_TDP_INFO			0x03
41 #define CONFIG_TDP_GET_PWR_INFO			0x04
42 #define CONFIG_TDP_GET_TJMAX_INFO		0x05
43 #define CONFIG_TDP_GET_CORE_MASK		0x06
44 #define CONFIG_TDP_GET_TURBO_LIMIT_RATIOS	0x07
45 #define CONFIG_TDP_SET_LEVEL			0x08
46 #define CONFIG_TDP_GET_UNCORE_P0_P1_INFO	0X09
47 #define CONFIG_TDP_GET_P1_INFO			0x0a
48 #define CONFIG_TDP_GET_MEM_FREQ			0x0b
49 
50 #define CONFIG_TDP_GET_FACT_HP_TURBO_LIMIT_NUMCORES	0x10
51 #define CONFIG_TDP_GET_FACT_HP_TURBO_LIMIT_RATIOS	0x11
52 #define CONFIG_TDP_GET_FACT_LP_CLIPPING_RATIO		0x12
53 
54 #define CONFIG_TDP_PBF_GET_CORE_MASK_INFO	0x20
55 #define CONFIG_TDP_PBF_GET_P1HI_P1LO_INFO	0x21
56 #define CONFIG_TDP_PBF_GET_TJ_MAX_INFO		0x22
57 #define CONFIG_TDP_PBF_GET_TDP_INFO		0X23
58 
59 #define CONFIG_CLOS				0xd0
60 #define CLOS_PQR_ASSOC				0x00
61 #define CLOS_PM_CLOS				0x01
62 #define CLOS_PM_QOS_CONFIG			0x02
63 #define CLOS_STATUS				0x03
64 
65 #define MBOX_CMD_WRITE_BIT			0x08
66 
67 #define PM_QOS_INFO_OFFSET			0x00
68 #define PM_QOS_CONFIG_OFFSET			0x04
69 #define PM_CLOS_OFFSET				0x08
70 #define PQR_ASSOC_OFFSET			0x20
71 
72 #define DISP_FREQ_MULTIPLIER 100
73 
74 struct isst_clos_config {
75 	int pkg_id;
76 	int die_id;
77 	unsigned char epp;
78 	unsigned char clos_prop_prio;
79 	unsigned char clos_min;
80 	unsigned char clos_max;
81 	unsigned char clos_desired;
82 };
83 
84 struct isst_fact_bucket_info {
85 	int high_priority_cores_count;
86 	int sse_trl;
87 	int avx_trl;
88 	int avx512_trl;
89 };
90 
91 struct isst_pbf_info {
92 	int pbf_acticated;
93 	int pbf_available;
94 	size_t core_cpumask_size;
95 	cpu_set_t *core_cpumask;
96 	int p1_high;
97 	int p1_low;
98 	int t_control;
99 	int t_prochot;
100 	int tdp;
101 };
102 
103 #define ISST_TRL_MAX_ACTIVE_CORES	8
104 #define ISST_FACT_MAX_BUCKETS		8
105 struct isst_fact_info {
106 	int lp_clipping_ratio_license_sse;
107 	int lp_clipping_ratio_license_avx2;
108 	int lp_clipping_ratio_license_avx512;
109 	struct isst_fact_bucket_info bucket_info[ISST_FACT_MAX_BUCKETS];
110 };
111 
112 struct isst_pkg_ctdp_level_info {
113 	int processed;
114 	int control_cpu;
115 	int pkg_id;
116 	int die_id;
117 	int level;
118 	int fact_support;
119 	int pbf_support;
120 	int fact_enabled;
121 	int pbf_enabled;
122 	int tdp_ratio;
123 	int active;
124 	int tdp_control;
125 	int pkg_tdp;
126 	int pkg_min_power;
127 	int pkg_max_power;
128 	int fact;
129 	int t_proc_hot;
130 	int uncore_p0;
131 	int uncore_p1;
132 	int sse_p1;
133 	int avx2_p1;
134 	int avx512_p1;
135 	int mem_freq;
136 	size_t core_cpumask_size;
137 	cpu_set_t *core_cpumask;
138 	int cpu_count;
139 	unsigned long long buckets_info;
140 	int trl_sse_active_cores[ISST_TRL_MAX_ACTIVE_CORES];
141 	int trl_avx_active_cores[ISST_TRL_MAX_ACTIVE_CORES];
142 	int trl_avx_512_active_cores[ISST_TRL_MAX_ACTIVE_CORES];
143 	int kobj_bucket_index;
144 	int active_bucket;
145 	int fact_max_index;
146 	int fact_max_config;
147 	int pbf_found;
148 	int pbf_active;
149 	struct isst_pbf_info pbf_info;
150 	struct isst_fact_info fact_info;
151 };
152 
153 #define ISST_MAX_TDP_LEVELS	(4 + 1) /* +1 for base config */
154 struct isst_pkg_ctdp {
155 	int locked;
156 	int version;
157 	int processed;
158 	int levels;
159 	int current_level;
160 	int enabled;
161 	struct isst_pkg_ctdp_level_info ctdp_level[ISST_MAX_TDP_LEVELS];
162 };
163 
164 extern int get_topo_max_cpus(void);
165 extern int get_cpu_count(int pkg_id, int die_id);
166 extern int get_core_count(int pkg_id, int die_id);
167 
168 /* Common interfaces */
169 extern void debug_printf(const char *format, ...);
170 extern int out_format_is_json(void);
171 extern int get_physical_package_id(int cpu);
172 extern int get_physical_die_id(int cpu);
173 extern size_t alloc_cpu_set(cpu_set_t **cpu_set);
174 extern void free_cpu_set(cpu_set_t *cpu_set);
175 extern int find_logical_cpu(int pkg_id, int die_id, int phy_cpu);
176 extern int find_phy_cpu_num(int logical_cpu);
177 extern int find_phy_core_num(int logical_cpu);
178 extern void set_cpu_mask_from_punit_coremask(int cpu,
179 					     unsigned long long core_mask,
180 					     size_t core_cpumask_size,
181 					     cpu_set_t *core_cpumask,
182 					     int *cpu_cnt);
183 
184 extern int isst_send_mbox_command(unsigned int cpu, unsigned char command,
185 				  unsigned char sub_command,
186 				  unsigned int write,
187 				  unsigned int req_data, unsigned int *resp);
188 
189 extern int isst_send_msr_command(unsigned int cpu, unsigned int command,
190 				 int write, unsigned long long *req_resp);
191 
192 extern int isst_get_ctdp_levels(int cpu, struct isst_pkg_ctdp *pkg_dev);
193 extern int isst_get_coremask_info(int cpu, int config_index,
194 			   struct isst_pkg_ctdp_level_info *ctdp_level);
195 extern int isst_get_process_ctdp(int cpu, int tdp_level,
196 				 struct isst_pkg_ctdp *pkg_dev);
197 extern void isst_get_process_ctdp_complete(int cpu,
198 					   struct isst_pkg_ctdp *pkg_dev);
199 extern void isst_ctdp_display_information(int cpu, FILE *outf, int tdp_level,
200 					  struct isst_pkg_ctdp *pkg_dev);
201 extern void isst_ctdp_display_core_info(int cpu, FILE *outf, char *prefix,
202 					unsigned int val);
203 extern void isst_ctdp_display_information_start(FILE *outf);
204 extern void isst_ctdp_display_information_end(FILE *outf);
205 extern void isst_pbf_display_information(int cpu, FILE *outf, int level,
206 					 struct isst_pbf_info *info);
207 extern int isst_set_tdp_level(int cpu, int tdp_level);
208 extern int isst_set_tdp_level_msr(int cpu, int tdp_level);
209 extern int isst_set_pbf_fact_status(int cpu, int pbf, int enable);
210 extern int isst_get_pbf_info(int cpu, int level,
211 			     struct isst_pbf_info *pbf_info);
212 extern void isst_get_pbf_info_complete(struct isst_pbf_info *pbf_info);
213 extern int isst_get_fact_info(int cpu, int level,
214 			      struct isst_fact_info *fact_info);
215 extern int isst_get_fact_bucket_info(int cpu, int level,
216 				     struct isst_fact_bucket_info *bucket_info);
217 extern void isst_fact_display_information(int cpu, FILE *outf, int level,
218 					  int fact_bucket, int fact_avx,
219 					  struct isst_fact_info *fact_info);
220 extern int isst_set_trl(int cpu, unsigned long long trl);
221 extern int isst_set_trl_from_current_tdp(int cpu, unsigned long long trl);
222 extern int isst_get_config_tdp_lock_status(int cpu);
223 
224 extern int isst_pm_qos_config(int cpu, int enable_clos, int priority_type);
225 extern int isst_pm_get_clos(int cpu, int clos,
226 			    struct isst_clos_config *clos_config);
227 extern int isst_set_clos(int cpu, int clos,
228 			 struct isst_clos_config *clos_config);
229 extern int isst_clos_associate(int cpu, int clos);
230 extern int isst_clos_get_assoc_status(int cpu, int *clos_id);
231 extern void isst_clos_display_information(int cpu, FILE *outf, int clos,
232 					  struct isst_clos_config *clos_config);
233 extern void isst_clos_display_assoc_information(int cpu, FILE *outf, int clos);
234 extern int isst_read_reg(unsigned short reg, unsigned int *val);
235 extern int isst_write_reg(int reg, unsigned int val);
236 
237 extern void isst_display_result(int cpu, FILE *outf, char *feature, char *cmd,
238 				int result);
239 
240 extern int isst_clos_get_clos_information(int cpu, int *enable, int *type);
241 extern void isst_clos_display_clos_information(int cpu, FILE *outf,
242 					       int clos_enable, int type);
243 extern int is_clx_n_platform(void);
244 extern int get_cpufreq_base_freq(int cpu);
245 #endif
246