tools/power/cpupower/utils/helpers/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
  15 #include "helpers/bitmask.h"
  16 #include <cpupower.h>
  17
  18 /* Internationalization ****************************/
  19 #ifdef NLS
  20
  21 #define _(String) gettext(String)
  22 #ifndef gettext_noop
  23 #define gettext_noop(String) String
  24 #endif
  25 #define N_(String) gettext_noop(String)
  26
  27 #else /* !NLS */
  28
  29 #define _(String) String
  30 #define N_(String) String
  31
  32 #endif
  33 /* Internationalization ****************************/
  34
  35 extern int run_as_root;
  36 extern int base_cpu;
  37 extern struct bitmask *cpus_chosen;
  38
  39 /* Global verbose (-d) stuff *********************************/
  40 /*
  41  * define DEBUG via global Makefile variable
  42  * Debug output is sent to stderr, do:
  43  * cpupower monitor 2>/tmp/debug
  44  * to split debug output away from normal output
  45 */
  46 #ifdef DEBUG
  47 extern int be_verbose;
  48
  49 #define dprint(fmt, ...) {                                      \
  50                 if (be_verbose) {                               \
  51                         fprintf(stderr, "%s: " fmt,             \
  52                                 __func__, ##__VA_ARGS__);       \
  53                 }                                               \
  54         }
  55 #else
  56 static inline void dprint(const char *fmt, ...) { }
  57 #endif
  58 extern int be_verbose;
  59 /* Global verbose (-v) stuff *********************************/
  60
  61 /* cpuid and cpuinfo helpers  **************************/
  62 enum cpupower_cpu_vendor {X86_VENDOR_UNKNOWN = 0, X86_VENDOR_INTEL,
  63                           X86_VENDOR_AMD, X86_VENDOR_HYGON, X86_VENDOR_MAX};
  64
  65 #define CPUPOWER_CAP_INV_TSC            0x00000001
  66 #define CPUPOWER_CAP_APERF              0x00000002
  67 #define CPUPOWER_CAP_AMD_CBP            0x00000004
  68 #define CPUPOWER_CAP_PERF_BIAS          0x00000008
  69 #define CPUPOWER_CAP_HAS_TURBO_RATIO    0x00000010
  70 #define CPUPOWER_CAP_IS_SNB             0x00000020
  71 #define CPUPOWER_CAP_INTEL_IDA          0x00000040
  72 #define CPUPOWER_CAP_AMD_RDPRU          0x00000080
  73
  74 #define CPUPOWER_AMD_CPBDIS             0x02000000
  75
  76 #define MAX_HW_PSTATES 10
  77
  78 struct cpupower_cpu_info {
  79         enum cpupower_cpu_vendor vendor;
  80         unsigned int family;
  81         unsigned int model;
  82         unsigned int stepping;
  83         /* CPU capabilities read out from cpuid */
  84         unsigned long long caps;
  85 };
  86
  87 /* get_cpu_info
  88  *
  89  * Extract CPU vendor, family, model, stepping info from /proc/cpuinfo
  90  *
  91  * Returns 0 on success or a negative error code
  92  * Only used on x86, below global's struct values are zero/unknown on
  93  * other archs
  94  */
  95 extern int get_cpu_info(struct cpupower_cpu_info *cpu_info);
  96 extern struct cpupower_cpu_info cpupower_cpu_info;
  97
  98
  99 /* cpuid and cpuinfo helpers  **************************/
 100
 101 /* X86 ONLY ****************************************/
 102 #if defined(__i386__) || defined(__x86_64__)
 103
 104 #include <pci/pci.h>
 105
 106 /* Read/Write msr ****************************/
 107 extern int read_msr(int cpu, unsigned int idx, unsigned long long *val);
 108 extern int write_msr(int cpu, unsigned int idx, unsigned long long val);
 109
 110 extern int cpupower_intel_set_perf_bias(unsigned int cpu, unsigned int val);
 111 extern int cpupower_intel_get_perf_bias(unsigned int cpu);
 112 extern unsigned long long msr_intel_get_turbo_ratio(unsigned int cpu);
 113
 114 /* Read/Write msr ****************************/
 115
 116 /* PCI stuff ****************************/
 117 extern int amd_pci_get_num_boost_states(int *active, int *states);
 118 extern struct pci_dev *pci_acc_init(struct pci_access **pacc, int domain,
 119                                     int bus, int slot, int func, int vendor,
 120                                     int dev);
 121 extern struct pci_dev *pci_slot_func_init(struct pci_access **pacc,
 122                                               int slot, int func);
 123
 124 /* PCI stuff ****************************/
 125
 126 /* AMD HW pstate decoding **************************/
 127
 128 extern int decode_pstates(unsigned int cpu, unsigned int cpu_family,
 129                           int boost_states, unsigned long *pstates, int *no);
 130
 131 /* AMD HW pstate decoding **************************/
 132
 133 extern int cpufreq_has_boost_support(unsigned int cpu, int *support,
 134                                      int *active, int * states);
 135 /*
 136  * CPUID functions returning a single datum
 137  */
 138 unsigned int cpuid_eax(unsigned int op);
 139 unsigned int cpuid_ebx(unsigned int op);
 140 unsigned int cpuid_ecx(unsigned int op);
 141 unsigned int cpuid_edx(unsigned int op);
 142
 143 /* cpuid and cpuinfo helpers  **************************/
 144 /* X86 ONLY ********************************************/
 145 #else
 146 static inline int decode_pstates(unsigned int cpu, unsigned int cpu_family,
 147                                  int boost_states, unsigned long *pstates,
 148                                  int *no)
 149 { return -1; };
 150
 151 static inline int read_msr(int cpu, unsigned int idx, unsigned long long *val)
 152 { return -1; };
 153 static inline int write_msr(int cpu, unsigned int idx, unsigned long long val)
 154 { return -1; };
 155 static inline int cpupower_intel_set_perf_bias(unsigned int cpu, unsigned int val)
 156 { return -1; };
 157 static inline int cpupower_intel_get_perf_bias(unsigned int cpu)
 158 { return -1; };
 159 static inline unsigned long long msr_intel_get_turbo_ratio(unsigned int cpu)
 160 { return 0; };
 161
 162 /* Read/Write msr ****************************/
 163
 164 static inline int cpufreq_has_boost_support(unsigned int cpu, int *support,
 165                                             int *active, int * states)
 166 { return -1; }
 167
 168 /* cpuid and cpuinfo helpers  **************************/
 169
 170 static inline unsigned int cpuid_eax(unsigned int op) { return 0; };
 171 static inline unsigned int cpuid_ebx(unsigned int op) { return 0; };
 172 static inline unsigned int cpuid_ecx(unsigned int op) { return 0; };
 173 static inline unsigned int cpuid_edx(unsigned int op) { return 0; };
 174 #endif /* defined(__i386__) || defined(__x86_64__) */
 175
 176 /*
 177  * CPU State related functions
 178  */
 179 extern struct bitmask *online_cpus;
 180 extern struct bitmask *offline_cpus;
 181
 182 void get_cpustate(void);
 183 void print_online_cpus(void);
 184 void print_offline_cpus(void);
 185
 186 #endif /* __CPUPOWERUTILS_HELPERS__ */