LXR linux/include/acpi/processor.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef __ACPI_PROCESSOR_H
   3#define __ACPI_PROCESSOR_H
   4
   5#include <linux/kernel.h>
   6#include <linux/cpu.h>
   7#include <linux/cpufreq.h>
   8#include <linux/pm_qos.h>
   9#include <linux/thermal.h>
  10#include <asm/acpi.h>
  11
  12#define ACPI_PROCESSOR_CLASS            "processor"
  13#define ACPI_PROCESSOR_DEVICE_NAME      "Processor"
  14#define ACPI_PROCESSOR_DEVICE_HID       "ACPI0007"
  15#define ACPI_PROCESSOR_CONTAINER_HID    "ACPI0010"
  16
  17#define ACPI_PROCESSOR_BUSY_METRIC      10
  18
  19#define ACPI_PROCESSOR_MAX_POWER        8
  20#define ACPI_PROCESSOR_MAX_C2_LATENCY   100
  21#define ACPI_PROCESSOR_MAX_C3_LATENCY   1000
  22
  23#define ACPI_PROCESSOR_MAX_THROTTLING   16
  24#define ACPI_PROCESSOR_MAX_THROTTLE     250     /* 25% */
  25#define ACPI_PROCESSOR_MAX_DUTY_WIDTH   4
  26
  27#define ACPI_PDC_REVISION_ID            0x1
  28
  29#define ACPI_PSD_REV0_REVISION          0       /* Support for _PSD as in ACPI 3.0 */
  30#define ACPI_PSD_REV0_ENTRIES           5
  31
  32#define ACPI_TSD_REV0_REVISION          0       /* Support for _PSD as in ACPI 3.0 */
  33#define ACPI_TSD_REV0_ENTRIES           5
  34/*
  35 * Types of coordination defined in ACPI 3.0. Same macros can be used across
  36 * P, C and T states
  37 */
  38#define DOMAIN_COORD_TYPE_SW_ALL        0xfc
  39#define DOMAIN_COORD_TYPE_SW_ANY        0xfd
  40#define DOMAIN_COORD_TYPE_HW_ALL        0xfe
  41
  42#define ACPI_CSTATE_SYSTEMIO    0
  43#define ACPI_CSTATE_FFH         1
  44#define ACPI_CSTATE_HALT        2
  45#define ACPI_CSTATE_INTEGER     3
  46
  47#define ACPI_CX_DESC_LEN        32
  48
  49/* Power Management */
  50
  51struct acpi_processor_cx;
  52
  53struct acpi_power_register {
  54        u8 descriptor;
  55        u16 length;
  56        u8 space_id;
  57        u8 bit_width;
  58        u8 bit_offset;
  59        u8 access_size;
  60        u64 address;
  61} __packed;
  62
  63struct acpi_processor_cx {
  64        u8 valid;
  65        u8 type;
  66        u32 address;
  67        u8 entry_method;
  68        u8 index;
  69        u32 latency;
  70        u8 bm_sts_skip;
  71        char desc[ACPI_CX_DESC_LEN];
  72};
  73
  74struct acpi_lpi_state {
  75        u32 min_residency;
  76        u32 wake_latency; /* worst case */
  77        u32 flags;
  78        u32 arch_flags;
  79        u32 res_cnt_freq;
  80        u32 enable_parent_state;
  81        u64 address;
  82        u8 index;
  83        u8 entry_method;
  84        char desc[ACPI_CX_DESC_LEN];
  85};
  86
  87struct acpi_processor_power {
  88        int count;
  89        union {
  90                struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
  91                struct acpi_lpi_state lpi_states[ACPI_PROCESSOR_MAX_POWER];
  92        };
  93        int timer_broadcast_on_state;
  94};
  95
  96/* Performance Management */
  97
  98struct acpi_psd_package {
  99        u64 num_entries;
 100        u64 revision;
 101        u64 domain;
 102        u64 coord_type;
 103        u64 num_processors;
 104} __packed;
 105
 106struct acpi_pct_register {
 107        u8 descriptor;
 108        u16 length;
 109        u8 space_id;
 110        u8 bit_width;
 111        u8 bit_offset;
 112        u8 reserved;
 113        u64 address;
 114} __packed;
 115
 116struct acpi_processor_px {
 117        u64 core_frequency;     /* megahertz */
 118        u64 power;      /* milliWatts */
 119        u64 transition_latency; /* microseconds */
 120        u64 bus_master_latency; /* microseconds */
 121        u64 control;    /* control value */
 122        u64 status;     /* success indicator */
 123};
 124
 125struct acpi_processor_performance {
 126        unsigned int state;
 127        unsigned int platform_limit;
 128        struct acpi_pct_register control_register;
 129        struct acpi_pct_register status_register;
 130        unsigned int state_count;
 131        struct acpi_processor_px *states;
 132        struct acpi_psd_package domain_info;
 133        cpumask_var_t shared_cpu_map;
 134        unsigned int shared_type;
 135};
 136
 137/* Throttling Control */
 138
 139struct acpi_tsd_package {
 140        u64 num_entries;
 141        u64 revision;
 142        u64 domain;
 143        u64 coord_type;
 144        u64 num_processors;
 145} __packed;
 146
 147struct acpi_ptc_register {
 148        u8 descriptor;
 149        u16 length;
 150        u8 space_id;
 151        u8 bit_width;
 152        u8 bit_offset;
 153        u8 reserved;
 154        u64 address;
 155} __packed;
 156
 157struct acpi_processor_tx_tss {
 158        u64 freqpercentage;     /* */
 159        u64 power;      /* milliWatts */
 160        u64 transition_latency; /* microseconds */
 161        u64 control;    /* control value */
 162        u64 status;     /* success indicator */
 163};
 164struct acpi_processor_tx {
 165        u16 power;
 166        u16 performance;
 167};
 168
 169struct acpi_processor;
 170struct acpi_processor_throttling {
 171        unsigned int state;
 172        unsigned int platform_limit;
 173        struct acpi_pct_register control_register;
 174        struct acpi_pct_register status_register;
 175        unsigned int state_count;
 176        struct acpi_processor_tx_tss *states_tss;
 177        struct acpi_tsd_package domain_info;
 178        cpumask_var_t shared_cpu_map;
 179        int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
 180        int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
 181                                              int state, bool force);
 182
 183        u32 address;
 184        u8 duty_offset;
 185        u8 duty_width;
 186        u8 tsd_valid_flag;
 187        unsigned int shared_type;
 188        struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
 189};
 190
 191/* Limit Interface */
 192
 193struct acpi_processor_lx {
 194        int px;                 /* performance state */
 195        int tx;                 /* throttle level */
 196};
 197
 198struct acpi_processor_limit {
 199        struct acpi_processor_lx state; /* current limit */
 200        struct acpi_processor_lx thermal;       /* thermal limit */
 201        struct acpi_processor_lx user;  /* user limit */
 202};
 203
 204struct acpi_processor_flags {
 205        u8 power:1;
 206        u8 performance:1;
 207        u8 throttling:1;
 208        u8 limit:1;
 209        u8 bm_control:1;
 210        u8 bm_check:1;
 211        u8 has_cst:1;
 212        u8 has_lpi:1;
 213        u8 power_setup_done:1;
 214        u8 bm_rld_set:1;
 215        u8 need_hotplug_init:1;
 216};
 217
 218struct acpi_processor {
 219        acpi_handle handle;
 220        u32 acpi_id;
 221        phys_cpuid_t phys_id;   /* CPU hardware ID such as APIC ID for x86 */
 222        u32 id;         /* CPU logical ID allocated by OS */
 223        u32 pblk;
 224        int performance_platform_limit;
 225        int throttling_platform_limit;
 226        /* 0 - states 0..n-th state available */
 227
 228        struct acpi_processor_flags flags;
 229        struct acpi_processor_power power;
 230        struct acpi_processor_performance *performance;
 231        struct acpi_processor_throttling throttling;
 232        struct acpi_processor_limit limit;
 233        struct thermal_cooling_device *cdev;
 234        struct device *dev; /* Processor device. */
 235        struct freq_qos_request perflib_req;
 236        struct freq_qos_request thermal_req;
 237};
 238
 239struct acpi_processor_errata {
 240        u8 smp;
 241        struct {
 242                u8 throttle:1;
 243                u8 fdma:1;
 244                u8 reserved:6;
 245                u32 bmisx;
 246        } piix4;
 247};
 248
 249extern int acpi_processor_preregister_performance(struct
 250                                                  acpi_processor_performance
 251                                                  __percpu *performance);
 252
 253extern int acpi_processor_register_performance(struct acpi_processor_performance
 254                                               *performance, unsigned int cpu);
 255extern void acpi_processor_unregister_performance(unsigned int cpu);
 256
 257int acpi_processor_pstate_control(void);
 258/* note: this locks both the calling module and the processor module
 259         if a _PPC object exists, rmmod is disallowed then */
 260int acpi_processor_notify_smm(struct module *calling_module);
 261int acpi_processor_get_psd(acpi_handle handle,
 262                           struct acpi_psd_package *pdomain);
 263
 264/* parsing the _P* objects. */
 265extern int acpi_processor_get_performance_info(struct acpi_processor *pr);
 266
 267/* for communication between multiple parts of the processor kernel module */
 268DECLARE_PER_CPU(struct acpi_processor *, processors);
 269extern struct acpi_processor_errata errata;
 270
 271#if defined(ARCH_HAS_POWER_INIT) && defined(CONFIG_ACPI_PROCESSOR_CSTATE)
 272void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
 273                                        unsigned int cpu);
 274int acpi_processor_ffh_cstate_probe(unsigned int cpu,
 275                                    struct acpi_processor_cx *cx,
 276                                    struct acpi_power_register *reg);
 277void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
 278#else
 279static inline void acpi_processor_power_init_bm_check(struct
 280                                                      acpi_processor_flags
 281                                                      *flags, unsigned int cpu)
 282{
 283        flags->bm_check = 1;
 284        return;
 285}
 286static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
 287                                                  struct acpi_processor_cx *cx,
 288                                                  struct acpi_power_register
 289                                                  *reg)
 290{
 291        return -1;
 292}
 293static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
 294                                                   *cstate)
 295{
 296        return;
 297}
 298#endif
 299
 300static inline int call_on_cpu(int cpu, long (*fn)(void *), void *arg,
 301                              bool direct)
 302{
 303        if (direct || (is_percpu_thread() && cpu == smp_processor_id()))
 304                return fn(arg);
 305        return work_on_cpu(cpu, fn, arg);
 306}
 307
 308/* in processor_perflib.c */
 309
 310#ifdef CONFIG_CPU_FREQ
 311extern bool acpi_processor_cpufreq_init;
 312void acpi_processor_ignore_ppc_init(void);
 313void acpi_processor_ppc_init(struct cpufreq_policy *policy);
 314void acpi_processor_ppc_exit(struct cpufreq_policy *policy);
 315void acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
 316extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
 317#else
 318static inline void acpi_processor_ignore_ppc_init(void)
 319{
 320        return;
 321}
 322static inline void acpi_processor_ppc_init(struct cpufreq_policy *policy)
 323{
 324        return;
 325}
 326static inline void acpi_processor_ppc_exit(struct cpufreq_policy *policy)
 327{
 328        return;
 329}
 330static inline void acpi_processor_ppc_has_changed(struct acpi_processor *pr,
 331                                                                int event_flag)
 332{
 333        static unsigned int printout = 1;
 334        if (printout) {
 335                printk(KERN_WARNING
 336                       "Warning: Processor Platform Limit event detected, but not handled.\n");
 337                printk(KERN_WARNING
 338                       "Consider compiling CPUfreq support into your kernel.\n");
 339                printout = 0;
 340        }
 341}
 342static inline int acpi_processor_get_bios_limit(int cpu, unsigned int *limit)
 343{
 344        return -ENODEV;
 345}
 346
 347#endif                          /* CONFIG_CPU_FREQ */
 348
 349/* in processor_core.c */
 350phys_cpuid_t acpi_get_phys_id(acpi_handle, int type, u32 acpi_id);
 351phys_cpuid_t acpi_map_madt_entry(u32 acpi_id);
 352int acpi_map_cpuid(phys_cpuid_t phys_id, u32 acpi_id);
 353int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
 354
 355#ifdef CONFIG_ACPI_CPPC_LIB
 356extern int acpi_cppc_processor_probe(struct acpi_processor *pr);
 357extern void acpi_cppc_processor_exit(struct acpi_processor *pr);
 358#else
 359static inline int acpi_cppc_processor_probe(struct acpi_processor *pr)
 360{
 361        return 0;
 362}
 363static inline void acpi_cppc_processor_exit(struct acpi_processor *pr)
 364{
 365        return;
 366}
 367#endif  /* CONFIG_ACPI_CPPC_LIB */
 368
 369/* in processor_pdc.c */
 370void acpi_processor_set_pdc(acpi_handle handle);
 371
 372/* in processor_throttling.c */
 373#ifdef CONFIG_ACPI_CPU_FREQ_PSS
 374int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
 375int acpi_processor_get_throttling_info(struct acpi_processor *pr);
 376extern int acpi_processor_set_throttling(struct acpi_processor *pr,
 377                                         int state, bool force);
 378/*
 379 * Reevaluate whether the T-state is invalid after one cpu is
 380 * onlined/offlined. In such case the flags.throttling will be updated.
 381 */
 382extern void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
 383                        bool is_dead);
 384extern const struct file_operations acpi_processor_throttling_fops;
 385extern void acpi_processor_throttling_init(void);
 386#else
 387static inline int acpi_processor_tstate_has_changed(struct acpi_processor *pr)
 388{
 389        return 0;
 390}
 391
 392static inline int acpi_processor_get_throttling_info(struct acpi_processor *pr)
 393{
 394        return -ENODEV;
 395}
 396
 397static inline int acpi_processor_set_throttling(struct acpi_processor *pr,
 398                                         int state, bool force)
 399{
 400        return -ENODEV;
 401}
 402
 403static inline void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
 404                        bool is_dead) {}
 405
 406static inline void acpi_processor_throttling_init(void) {}
 407#endif  /* CONFIG_ACPI_CPU_FREQ_PSS */
 408
 409/* in processor_idle.c */
 410extern struct cpuidle_driver acpi_idle_driver;
 411#ifdef CONFIG_ACPI_PROCESSOR_IDLE
 412int acpi_processor_power_init(struct acpi_processor *pr);
 413int acpi_processor_power_exit(struct acpi_processor *pr);
 414int acpi_processor_power_state_has_changed(struct acpi_processor *pr);
 415int acpi_processor_hotplug(struct acpi_processor *pr);
 416#else
 417static inline int acpi_processor_power_init(struct acpi_processor *pr)
 418{
 419        return -ENODEV;
 420}
 421
 422static inline int acpi_processor_power_exit(struct acpi_processor *pr)
 423{
 424        return -ENODEV;
 425}
 426
 427static inline int acpi_processor_power_state_has_changed(struct acpi_processor *pr)
 428{
 429        return -ENODEV;
 430}
 431
 432static inline int acpi_processor_hotplug(struct acpi_processor *pr)
 433{
 434        return -ENODEV;
 435}
 436#endif /* CONFIG_ACPI_PROCESSOR_IDLE */
 437
 438/* in processor_thermal.c */
 439int acpi_processor_get_limit_info(struct acpi_processor *pr);
 440extern const struct thermal_cooling_device_ops processor_cooling_ops;
 441#if defined(CONFIG_ACPI_CPU_FREQ_PSS) & defined(CONFIG_CPU_FREQ)
 442void acpi_thermal_cpufreq_init(struct cpufreq_policy *policy);
 443void acpi_thermal_cpufreq_exit(struct cpufreq_policy *policy);
 444#else
 445static inline void acpi_thermal_cpufreq_init(struct cpufreq_policy *policy)
 446{
 447        return;
 448}
 449static inline void acpi_thermal_cpufreq_exit(struct cpufreq_policy *policy)
 450{
 451        return;
 452}
 453#endif  /* CONFIG_ACPI_CPU_FREQ_PSS */
 454
 455#endif
 456