LXR linux/include/acpi/processor.h

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