xref: /linux/drivers/thermal/intel/intel_tcc_cooling.c (revision 4b99990cdf9560e8a071640baf19f312e6ae02f4)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * cooling device driver that activates the processor throttling by
4  * programming the TCC Offset register.
5  * Copyright (c) 2021, Intel Corporation.
6  */
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8 
9 #include <linux/device.h>
10 #include <linux/intel_tcc.h>
11 #include <linux/module.h>
12 #include <linux/thermal.h>
13 #include <asm/cpu_device_id.h>
14 #include <asm/msr.h>
15 
16 #define TCC_PROGRAMMABLE	BIT(30)
17 #define TCC_LOCKED		BIT(31)
18 
19 static struct thermal_cooling_device *tcc_cdev;
20 
21 static int tcc_get_max_state(struct thermal_cooling_device *cdev, unsigned long
22 			     *state)
23 {
24 	*state = intel_tcc_get_offset_mask();
25 	return 0;
26 }
27 
28 static int tcc_get_cur_state(struct thermal_cooling_device *cdev, unsigned long
29 			     *state)
30 {
31 	int offset = intel_tcc_get_offset(-1);
32 
33 	if (offset < 0)
34 		return offset;
35 
36 	*state = offset;
37 	return 0;
38 }
39 
40 static int tcc_set_cur_state(struct thermal_cooling_device *cdev, unsigned long
41 			     state)
42 {
43 	return intel_tcc_set_offset(-1, (int)state);
44 }
45 
46 static const struct thermal_cooling_device_ops tcc_cooling_ops = {
47 	.get_max_state = tcc_get_max_state,
48 	.get_cur_state = tcc_get_cur_state,
49 	.set_cur_state = tcc_set_cur_state,
50 };
51 
52 static const struct x86_cpu_id tcc_ids[] __initconst = {
53 	X86_MATCH_VFM(INTEL_SKYLAKE, NULL),
54 	X86_MATCH_VFM(INTEL_SKYLAKE_L, NULL),
55 	X86_MATCH_VFM(INTEL_KABYLAKE, NULL),
56 	X86_MATCH_VFM(INTEL_KABYLAKE_L, NULL),
57 	X86_MATCH_VFM(INTEL_ICELAKE, NULL),
58 	X86_MATCH_VFM(INTEL_ICELAKE_L, NULL),
59 	X86_MATCH_VFM(INTEL_TIGERLAKE, NULL),
60 	X86_MATCH_VFM(INTEL_TIGERLAKE_L, NULL),
61 	X86_MATCH_VFM(INTEL_COMETLAKE, NULL),
62 	X86_MATCH_VFM(INTEL_ALDERLAKE, NULL),
63 	X86_MATCH_VFM(INTEL_ALDERLAKE_L, NULL),
64 	X86_MATCH_VFM(INTEL_ATOM_GRACEMONT, NULL),
65 	X86_MATCH_VFM(INTEL_RAPTORLAKE, NULL),
66 	X86_MATCH_VFM(INTEL_RAPTORLAKE_P, NULL),
67 	X86_MATCH_VFM(INTEL_RAPTORLAKE_S, NULL),
68 	X86_MATCH_VFM(INTEL_ARROWLAKE, NULL),
69 	X86_MATCH_VFM(INTEL_ARROWLAKE_U, NULL),
70 	X86_MATCH_VFM(INTEL_ARROWLAKE_H, NULL),
71 	X86_MATCH_VFM(INTEL_PANTHERLAKE_L, NULL),
72 	X86_MATCH_VFM(INTEL_WILDCATLAKE_L, NULL),
73 	X86_MATCH_VFM(INTEL_NOVALAKE, NULL),
74 	X86_MATCH_VFM(INTEL_NOVALAKE_L, NULL),
75 	{}
76 };
77 
78 MODULE_DEVICE_TABLE(x86cpu, tcc_ids);
79 
80 static int __init tcc_cooling_init(void)
81 {
82 	u64 val;
83 	const struct x86_cpu_id *id;
84 	int err;
85 
86 	id = x86_match_cpu(tcc_ids);
87 	if (!id)
88 		return -ENODEV;
89 
90 	err = rdmsrq_safe(MSR_PLATFORM_INFO, &val);
91 	if (err)
92 		return err;
93 
94 	if (!(val & TCC_PROGRAMMABLE))
95 		return -ENODEV;
96 
97 	err = rdmsrq_safe(MSR_IA32_TEMPERATURE_TARGET, &val);
98 	if (err)
99 		return err;
100 
101 	if (val & TCC_LOCKED) {
102 		pr_info("TCC Offset locked\n");
103 		return -ENODEV;
104 	}
105 
106 	pr_info("Programmable TCC Offset detected\n");
107 
108 	tcc_cdev =
109 	    thermal_cooling_device_register("TCC Offset", NULL,
110 					    &tcc_cooling_ops);
111 	if (IS_ERR(tcc_cdev))
112 		return PTR_ERR(tcc_cdev);
113 
114 	return 0;
115 }
116 
117 module_init(tcc_cooling_init)
118 
119 static void __exit tcc_cooling_exit(void)
120 {
121 	thermal_cooling_device_unregister(tcc_cdev);
122 }
123 
124 module_exit(tcc_cooling_exit)
125 
126 MODULE_IMPORT_NS("INTEL_TCC");
127 MODULE_DESCRIPTION("TCC offset cooling device Driver");
128 MODULE_AUTHOR("Zhang Rui <rui.zhang@intel.com>");
129 MODULE_LICENSE("GPL v2");
130