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