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