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