helpers.h

  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/*
  3 *  (C) 2010,2011       Thomas Renninger <trenn@suse.de>, Novell Inc.
  4 *
  5 * Miscellaneous helpers which do not fit or are worth
  6 * to put into separate headers
  7 */
  8
  9#ifndef __CPUPOWERUTILS_HELPERS__
 10#define __CPUPOWERUTILS_HELPERS__
 11
 12#include <libintl.h>
 13#include <locale.h>
 14#include <stdbool.h>
 15
 16#include "helpers/bitmask.h"
 17#include <cpupower.h>
 18
 19/* Internationalization ****************************/
 20#ifdef NLS
 21
 22#define _(String) gettext(String)
 23#ifndef gettext_noop
 24#define gettext_noop(String) String
 25#endif
 26#define N_(String) gettext_noop(String)
 27
 28#else /* !NLS */
 29
 30#define _(String) String
 31#define N_(String) String
 32
 33#endif
 34/* Internationalization ****************************/
 35
 36extern int run_as_root;
 37extern int base_cpu;
 38extern struct bitmask *cpus_chosen;
 39
 40/* Global verbose (-d) stuff *********************************/
 41/*
 42 * define DEBUG via global Makefile variable
 43 * Debug output is sent to stderr, do:
 44 * cpupower monitor 2>/tmp/debug
 45 * to split debug output away from normal output
 46*/
 47#ifdef DEBUG
 48extern int be_verbose;
 49
 50#define dprint(fmt, ...) {					\
 51		if (be_verbose) {				\
 52			fprintf(stderr, "%s: " fmt,		\
 53				__func__, ##__VA_ARGS__);	\
 54		}						\
 55	}
 56#else
 57static inline void dprint(const char *fmt, ...) { }
 58#endif
 59extern int be_verbose;
 60/* Global verbose (-v) stuff *********************************/
 61
 62/* cpuid and cpuinfo helpers  **************************/
 63enum cpupower_cpu_vendor {X86_VENDOR_UNKNOWN = 0, X86_VENDOR_INTEL,
 64			  X86_VENDOR_AMD, X86_VENDOR_HYGON, X86_VENDOR_MAX};
 65
 66#define CPUPOWER_CAP_INV_TSC		0x00000001
 67#define CPUPOWER_CAP_APERF		0x00000002
 68#define CPUPOWER_CAP_AMD_CPB		0x00000004
 69#define CPUPOWER_CAP_PERF_BIAS		0x00000008
 70#define CPUPOWER_CAP_HAS_TURBO_RATIO	0x00000010
 71#define CPUPOWER_CAP_IS_SNB		0x00000020
 72#define CPUPOWER_CAP_INTEL_IDA		0x00000040
 73#define CPUPOWER_CAP_AMD_RDPRU		0x00000080
 74#define CPUPOWER_CAP_AMD_HW_PSTATE	0x00000100
 75#define CPUPOWER_CAP_AMD_PSTATEDEF	0x00000200
 76#define CPUPOWER_CAP_AMD_CPB_MSR	0x00000400
 77#define CPUPOWER_CAP_AMD_PSTATE		0x00000800
 78
 79#define CPUPOWER_AMD_CPBDIS		0x02000000
 80
 81#define MAX_HW_PSTATES 10
 82
 83struct cpupower_cpu_info {
 84	enum cpupower_cpu_vendor vendor;
 85	unsigned int family;
 86	unsigned int model;
 87	unsigned int stepping;
 88	/* CPU capabilities read out from cpuid */
 89	unsigned long long caps;
 90};
 91
 92/* get_cpu_info
 93 *
 94 * Extract CPU vendor, family, model, stepping info from /proc/cpuinfo
 95 *
 96 * Returns 0 on success or a negative error code
 97 * Only used on x86, below global's struct values are zero/unknown on
 98 * other archs
 99 */
100extern int get_cpu_info(struct cpupower_cpu_info *cpu_info);
101extern struct cpupower_cpu_info cpupower_cpu_info;
102
103
104/* cpuid and cpuinfo helpers  **************************/
105
106int cpufreq_has_generic_boost_support(bool *active);
107int cpupower_set_turbo_boost(int turbo_boost);
108
109/* X86 ONLY ****************************************/
110#if defined(__i386__) || defined(__x86_64__)
111
112#include <pci/pci.h>
113
114/* Read/Write msr ****************************/
115extern int read_msr(int cpu, unsigned int idx, unsigned long long *val);
116extern int write_msr(int cpu, unsigned int idx, unsigned long long val);
117
118extern int cpupower_intel_set_perf_bias(unsigned int cpu, unsigned int val);
119extern int cpupower_intel_get_perf_bias(unsigned int cpu);
120extern unsigned long long msr_intel_get_turbo_ratio(unsigned int cpu);
121
122extern int cpupower_set_epp(unsigned int cpu, char *epp);
123extern int cpupower_set_amd_pstate_mode(char *mode);
124
125/* Read/Write msr ****************************/
126
127/* PCI stuff ****************************/
128extern int amd_pci_get_num_boost_states(int *active, int *states);
129extern struct pci_dev *pci_acc_init(struct pci_access **pacc, int domain,
130				    int bus, int slot, int func, int vendor,
131				    int dev);
132extern struct pci_dev *pci_slot_func_init(struct pci_access **pacc,
133					      int slot, int func);
134
135/* PCI stuff ****************************/
136
137/* AMD HW pstate decoding **************************/
138
139extern int decode_pstates(unsigned int cpu, int boost_states,
140			  unsigned long *pstates, int *no);
141
142/* AMD HW pstate decoding **************************/
143
144int cpufreq_has_x86_boost_support(unsigned int cpu, int *support,
145				  int *active, int *states);
146
147/* AMD P-State stuff **************************/
148bool cpupower_amd_pstate_enabled(void);
149void amd_pstate_boost_init(unsigned int cpu,
150			   int *support, int *active);
151void amd_pstate_show_perf_and_freq(unsigned int cpu,
152				   int no_rounding);
153
154/* AMD P-State stuff **************************/
155
156/*
157 * CPUID functions returning a single datum
158 */
159unsigned int cpuid_eax(unsigned int op);
160unsigned int cpuid_ebx(unsigned int op);
161unsigned int cpuid_ecx(unsigned int op);
162unsigned int cpuid_edx(unsigned int op);
163
164/* cpuid and cpuinfo helpers  **************************/
165/* X86 ONLY ********************************************/
166#else
167static inline int decode_pstates(unsigned int cpu, int boost_states,
168				 unsigned long *pstates, int *no)
169{ return -1; };
170
171static inline int read_msr(int cpu, unsigned int idx, unsigned long long *val)
172{ return -1; };
173static inline int write_msr(int cpu, unsigned int idx, unsigned long long val)
174{ return -1; };
175static inline int cpupower_intel_set_perf_bias(unsigned int cpu, unsigned int val)
176{ return -1; };
177static inline int cpupower_intel_get_perf_bias(unsigned int cpu)
178{ return -1; };
179static inline unsigned long long msr_intel_get_turbo_ratio(unsigned int cpu)
180{ return 0; };
181
182static inline int cpupower_set_epp(unsigned int cpu, char *epp)
183{ return -1; };
184static inline int cpupower_set_amd_pstate_mode(char *mode)
185{ return -1; };
186
187/* Read/Write msr ****************************/
188
189static inline int cpufreq_has_x86_boost_support(unsigned int cpu, int *support,
190						int *active, int *states)
191{ return -1; }
192
193static inline bool cpupower_amd_pstate_enabled(void)
194{ return false; }
195static inline void amd_pstate_boost_init(unsigned int cpu, int *support,
196					 int *active)
197{}
198static inline void amd_pstate_show_perf_and_freq(unsigned int cpu,
199						 int no_rounding)
200{}
201
202/* cpuid and cpuinfo helpers  **************************/
203
204static inline unsigned int cpuid_eax(unsigned int op) { return 0; };
205static inline unsigned int cpuid_ebx(unsigned int op) { return 0; };
206static inline unsigned int cpuid_ecx(unsigned int op) { return 0; };
207static inline unsigned int cpuid_edx(unsigned int op) { return 0; };
208#endif /* defined(__i386__) || defined(__x86_64__) */
209
210/*
211 * CPU State related functions
212 */
213extern struct bitmask *online_cpus;
214extern struct bitmask *offline_cpus;
215
216void get_cpustate(void);
217void print_online_cpus(void);
218void print_offline_cpus(void);
219void print_speed(unsigned long speed, int no_rounding);
220
221#endif /* __CPUPOWERUTILS_HELPERS__ */