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
  43 struct acpi_processor_cx;
  44
  45 struct 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
  55 struct acpi_processor_cx {
  56         u8 valid;
  57         u8 type;
  58         u32 address;
  59         u8 entry_method;
  60         u8 index;
  61         u32 latency;
  62         u32 power;
  63         u64 time;
  64         u8 bm_sts_skip;
  65         char desc[ACPI_CX_DESC_LEN];
  66 };
  67
  68 struct acpi_processor_power {
  69         struct cpuidle_device dev;
  70         struct acpi_processor_cx *state;
  71         unsigned long bm_check_timestamp;
  72         u32 default_state;
  73         int count;
  74         struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
  75         int timer_broadcast_on_state;
  76 };
  77
  78 /* Performance Management */
  79
  80 struct acpi_psd_package {
  81         u64 num_entries;
  82         u64 revision;
  83         u64 domain;
  84         u64 coord_type;
  85         u64 num_processors;
  86 } __attribute__ ((packed));
  87
  88 struct acpi_pct_register {
  89         u8 descriptor;
  90         u16 length;
  91         u8 space_id;
  92         u8 bit_width;
  93         u8 bit_offset;
  94         u8 reserved;
  95         u64 address;
  96 } __attribute__ ((packed));
  97
  98 struct acpi_processor_px {
  99         u64 core_frequency;     /* megahertz */
 100         u64 power;      /* milliWatts */
 101         u64 transition_latency; /* microseconds */
 102         u64 bus_master_latency; /* microseconds */
 103         u64 control;    /* control value */
 104         u64 status;     /* success indicator */
 105 };
 106
 107 struct acpi_processor_performance {
 108         unsigned int state;
 109         unsigned int platform_limit;
 110         struct acpi_pct_register control_register;
 111         struct acpi_pct_register status_register;
 112         unsigned int state_count;
 113         struct acpi_processor_px *states;
 114         struct acpi_psd_package domain_info;
 115         cpumask_var_t shared_cpu_map;
 116         unsigned int shared_type;
 117 };
 118
 119 /* Throttling Control */
 120
 121 struct acpi_tsd_package {
 122         u64 num_entries;
 123         u64 revision;
 124         u64 domain;
 125         u64 coord_type;
 126         u64 num_processors;
 127 } __attribute__ ((packed));
 128
 129 struct acpi_ptc_register {
 130         u8 descriptor;
 131         u16 length;
 132         u8 space_id;
 133         u8 bit_width;
 134         u8 bit_offset;
 135         u8 reserved;
 136         u64 address;
 137 } __attribute__ ((packed));
 138
 139 struct acpi_processor_tx_tss {
 140         u64 freqpercentage;     /* */
 141         u64 power;      /* milliWatts */
 142         u64 transition_latency; /* microseconds */
 143         u64 control;    /* control value */
 144         u64 status;     /* success indicator */
 145 };
 146 struct acpi_processor_tx {
 147         u16 power;
 148         u16 performance;
 149 };
 150
 151 struct acpi_processor;
 152 struct acpi_processor_throttling {
 153         unsigned int state;
 154         unsigned int platform_limit;
 155         struct acpi_pct_register control_register;
 156         struct acpi_pct_register status_register;
 157         unsigned int state_count;
 158         struct acpi_processor_tx_tss *states_tss;
 159         struct acpi_tsd_package domain_info;
 160         cpumask_var_t shared_cpu_map;
 161         int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
 162         int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
 163                                               int state, bool force);
 164
 165         u32 address;
 166         u8 duty_offset;
 167         u8 duty_width;
 168         u8 tsd_valid_flag;
 169         unsigned int shared_type;
 170         struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
 171 };
 172
 173 /* Limit Interface */
 174
 175 struct acpi_processor_lx {
 176         int px;                 /* performance state */
 177         int tx;                 /* throttle level */
 178 };
 179
 180 struct acpi_processor_limit {
 181         struct acpi_processor_lx state; /* current limit */
 182         struct acpi_processor_lx thermal;       /* thermal limit */
 183         struct acpi_processor_lx user;  /* user limit */
 184 };
 185
 186 struct acpi_processor_flags {
 187         u8 power:1;
 188         u8 performance:1;
 189         u8 throttling:1;
 190         u8 limit:1;
 191         u8 bm_control:1;
 192         u8 bm_check:1;
 193         u8 has_cst:1;
 194         u8 power_setup_done:1;
 195         u8 bm_rld_set:1;
 196         u8 need_hotplug_init:1;
 197 };
 198
 199 struct acpi_processor {
 200         acpi_handle handle;
 201         u32 acpi_id;
 202         u32 id;
 203         u32 pblk;
 204         int performance_platform_limit;
 205         int throttling_platform_limit;
 206         /* 0 - states 0..n-th state available */
 207
 208         struct acpi_processor_flags flags;
 209         struct acpi_processor_power power;
 210         struct acpi_processor_performance *performance;
 211         struct acpi_processor_throttling throttling;
 212         struct acpi_processor_limit limit;
 213         struct thermal_cooling_device *cdev;
 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 void acpi_processor_load_module(struct acpi_processor *pr);
 227 extern int acpi_processor_preregister_performance(struct
 228                                                   acpi_processor_performance
 229                                                   __percpu *performance);
 230
 231 extern int acpi_processor_register_performance(struct acpi_processor_performance
 232                                                *performance, unsigned int cpu);
 233 extern 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 */
 240 int acpi_processor_notify_smm(struct module *calling_module);
 241
 242 /* for communication between multiple parts of the processor kernel module */
 243 DECLARE_PER_CPU(struct acpi_processor *, processors);
 244 extern struct acpi_processor_errata errata;
 245
 246 #ifdef ARCH_HAS_POWER_INIT
 247 void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
 248                                         unsigned int cpu);
 249 int acpi_processor_ffh_cstate_probe(unsigned int cpu,
 250                                     struct acpi_processor_cx *cx,
 251                                     struct acpi_power_register *reg);
 252 void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
 253 #else
 254 static 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 }
 261 static 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 }
 268 static 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
 278 void acpi_processor_ppc_init(void);
 279 void acpi_processor_ppc_exit(void);
 280 int acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
 281 extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
 282 #else
 283 static inline void acpi_processor_ppc_init(void)
 284 {
 285         return;
 286 }
 287 static inline void acpi_processor_ppc_exit(void)
 288 {
 289         return;
 290 }
 291 static 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 }
 304 static 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 */
 312 void acpi_processor_set_pdc(acpi_handle handle);
 313 int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
 314
 315 /* in processor_throttling.c */
 316 int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
 317 int acpi_processor_get_throttling_info(struct acpi_processor *pr);
 318 extern int acpi_processor_set_throttling(struct acpi_processor *pr,
 319                                          int state, bool force);
 320 /*
 321  * Reevaluate whether the T-state is invalid after one cpu is
 322  * onlined/offlined. In such case the flags.throttling will be updated.
 323  */
 324 extern void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
 325                         unsigned long action);
 326 extern const struct file_operations acpi_processor_throttling_fops;
 327 extern void acpi_processor_throttling_init(void);
 328 /* in processor_idle.c */
 329 int acpi_processor_power_init(struct acpi_processor *pr,
 330                               struct acpi_device *device);
 331 int acpi_processor_cst_has_changed(struct acpi_processor *pr);
 332 int acpi_processor_hotplug(struct acpi_processor *pr);
 333 int acpi_processor_power_exit(struct acpi_processor *pr,
 334                               struct acpi_device *device);
 335 int acpi_processor_suspend(struct acpi_device * device, pm_message_t state);
 336 int acpi_processor_resume(struct acpi_device * device);
 337 extern struct cpuidle_driver acpi_idle_driver;
 338
 339 /* in processor_thermal.c */
 340 int acpi_processor_get_limit_info(struct acpi_processor *pr);
 341 extern const struct thermal_cooling_device_ops processor_cooling_ops;
 342 #ifdef CONFIG_CPU_FREQ
 343 void acpi_thermal_cpufreq_init(void);
 344 void acpi_thermal_cpufreq_exit(void);
 345 #else
 346 static inline void acpi_thermal_cpufreq_init(void)
 347 {
 348         return;
 349 }
 350 static inline void acpi_thermal_cpufreq_exit(void)
 351 {
 352         return;
 353 }
 354 #endif
 355
 356 #endif