processor.h 12 KB

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