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