1 // SPDX-License-Identifier: GPL-2.0-only
2 /* intel_pch_thermal.c - Intel PCH Thermal driver
3  *
4  * Copyright (c) 2015, Intel Corporation.
5  *
6  * Authors:
7  *     Tushar Dave <tushar.n.dave@intel.com>
8  */
9 
10 #include <linux/acpi.h>
11 #include <linux/delay.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/pci.h>
15 #include <linux/pm.h>
16 #include <linux/suspend.h>
17 #include <linux/thermal.h>
18 #include <linux/types.h>
19 #include <linux/units.h>
20 
21 /* Intel PCH thermal Device IDs */
22 #define PCH_THERMAL_DID_HSW_1	0x9C24 /* Haswell PCH */
23 #define PCH_THERMAL_DID_HSW_2	0x8C24 /* Haswell PCH */
24 #define PCH_THERMAL_DID_WPT	0x9CA4 /* Wildcat Point */
25 #define PCH_THERMAL_DID_SKL	0x9D31 /* Skylake PCH */
26 #define PCH_THERMAL_DID_SKL_H	0xA131 /* Skylake PCH 100 series */
27 #define PCH_THERMAL_DID_CNL	0x9Df9 /* CNL PCH */
28 #define PCH_THERMAL_DID_CNL_H	0xA379 /* CNL-H PCH */
29 #define PCH_THERMAL_DID_CNL_LP	0x02F9 /* CNL-LP PCH */
30 #define PCH_THERMAL_DID_CML_H	0X06F9 /* CML-H PCH */
31 #define PCH_THERMAL_DID_LWB	0xA1B1 /* Lewisburg PCH */
32 
33 /* Wildcat Point-LP  PCH Thermal registers */
34 #define WPT_TEMP	0x0000	/* Temperature */
35 #define WPT_TSC	0x04	/* Thermal Sensor Control */
36 #define WPT_TSS	0x06	/* Thermal Sensor Status */
37 #define WPT_TSEL	0x08	/* Thermal Sensor Enable and Lock */
38 #define WPT_TSREL	0x0A	/* Thermal Sensor Report Enable and Lock */
39 #define WPT_TSMIC	0x0C	/* Thermal Sensor SMI Control */
40 #define WPT_CTT	0x0010	/* Catastrophic Trip Point */
41 #define WPT_TSPM	0x001C	/* Thermal Sensor Power Management */
42 #define WPT_TAHV	0x0014	/* Thermal Alert High Value */
43 #define WPT_TALV	0x0018	/* Thermal Alert Low Value */
44 #define WPT_TL		0x00000040	/* Throttle Value */
45 #define WPT_PHL	0x0060	/* PCH Hot Level */
46 #define WPT_PHLC	0x62	/* PHL Control */
47 #define WPT_TAS	0x80	/* Thermal Alert Status */
48 #define WPT_TSPIEN	0x82	/* PCI Interrupt Event Enables */
49 #define WPT_TSGPEN	0x84	/* General Purpose Event Enables */
50 
51 /*  Wildcat Point-LP  PCH Thermal Register bit definitions */
52 #define WPT_TEMP_TSR	0x01ff	/* Temp TS Reading */
53 #define WPT_TSC_CPDE	0x01	/* Catastrophic Power-Down Enable */
54 #define WPT_TSS_TSDSS	0x10	/* Thermal Sensor Dynamic Shutdown Status */
55 #define WPT_TSS_GPES	0x08	/* GPE status */
56 #define WPT_TSEL_ETS	0x01    /* Enable TS */
57 #define WPT_TSEL_PLDB	0x80	/* TSEL Policy Lock-Down Bit */
58 #define WPT_TL_TOL	0x000001FF	/* T0 Level */
59 #define WPT_TL_T1L	0x1ff00000	/* T1 Level */
60 #define WPT_TL_TTEN	0x20000000	/* TT Enable */
61 
62 /* Resolution of 1/2 degree C and an offset of -50C */
63 #define PCH_TEMP_OFFSET	(-50)
64 #define GET_WPT_TEMP(x)	((x) * MILLIDEGREE_PER_DEGREE / 2 + WPT_TEMP_OFFSET)
65 #define WPT_TEMP_OFFSET	(PCH_TEMP_OFFSET * MILLIDEGREE_PER_DEGREE)
66 #define GET_PCH_TEMP(x)	(((x) / 2) + PCH_TEMP_OFFSET)
67 
68 /* Amount of time for each cooling delay, 100ms by default for now */
69 static unsigned int delay_timeout = 100;
70 module_param(delay_timeout, int, 0644);
71 MODULE_PARM_DESC(delay_timeout, "amount of time delay for each iteration.");
72 
73 /* Number of iterations for cooling delay, 600 counts by default for now */
74 static unsigned int delay_cnt = 600;
75 module_param(delay_cnt, int, 0644);
76 MODULE_PARM_DESC(delay_cnt, "total number of iterations for time delay.");
77 
78 static char driver_name[] = "Intel PCH thermal driver";
79 
80 struct pch_thermal_device {
81 	void __iomem *hw_base;
82 	const struct pch_dev_ops *ops;
83 	struct pci_dev *pdev;
84 	struct thermal_zone_device *tzd;
85 	int crt_trip_id;
86 	unsigned long crt_temp;
87 	int hot_trip_id;
88 	unsigned long hot_temp;
89 	int psv_trip_id;
90 	unsigned long psv_temp;
91 	bool bios_enabled;
92 };
93 
94 #ifdef CONFIG_ACPI
95 
96 /*
97  * On some platforms, there is a companion ACPI device, which adds
98  * passive trip temperature using _PSV method. There is no specific
99  * passive temperature setting in MMIO interface of this PCI device.
100  */
101 static void pch_wpt_add_acpi_psv_trip(struct pch_thermal_device *ptd,
102 				      int *nr_trips)
103 {
104 	struct acpi_device *adev;
105 
106 	ptd->psv_trip_id = -1;
107 
108 	adev = ACPI_COMPANION(&ptd->pdev->dev);
109 	if (adev) {
110 		unsigned long long r;
111 		acpi_status status;
112 
113 		status = acpi_evaluate_integer(adev->handle, "_PSV", NULL,
114 					       &r);
115 		if (ACPI_SUCCESS(status)) {
116 			unsigned long trip_temp;
117 
118 			trip_temp = deci_kelvin_to_millicelsius(r);
119 			if (trip_temp) {
120 				ptd->psv_temp = trip_temp;
121 				ptd->psv_trip_id = *nr_trips;
122 				++(*nr_trips);
123 			}
124 		}
125 	}
126 }
127 #else
128 static void pch_wpt_add_acpi_psv_trip(struct pch_thermal_device *ptd,
129 				      int *nr_trips)
130 {
131 	ptd->psv_trip_id = -1;
132 
133 }
134 #endif
135 
136 static int pch_wpt_init(struct pch_thermal_device *ptd, int *nr_trips)
137 {
138 	u8 tsel;
139 	u16 trip_temp;
140 
141 	*nr_trips = 0;
142 
143 	/* Check if BIOS has already enabled thermal sensor */
144 	if (WPT_TSEL_ETS & readb(ptd->hw_base + WPT_TSEL)) {
145 		ptd->bios_enabled = true;
146 		goto read_trips;
147 	}
148 
149 	tsel = readb(ptd->hw_base + WPT_TSEL);
150 	/*
151 	 * When TSEL's Policy Lock-Down bit is 1, TSEL become RO.
152 	 * If so, thermal sensor cannot enable. Bail out.
153 	 */
154 	if (tsel & WPT_TSEL_PLDB) {
155 		dev_err(&ptd->pdev->dev, "Sensor can't be enabled\n");
156 		return -ENODEV;
157 	}
158 
159 	writeb(tsel|WPT_TSEL_ETS, ptd->hw_base + WPT_TSEL);
160 	if (!(WPT_TSEL_ETS & readb(ptd->hw_base + WPT_TSEL))) {
161 		dev_err(&ptd->pdev->dev, "Sensor can't be enabled\n");
162 		return -ENODEV;
163 	}
164 
165 read_trips:
166 	ptd->crt_trip_id = -1;
167 	trip_temp = readw(ptd->hw_base + WPT_CTT);
168 	trip_temp &= 0x1FF;
169 	if (trip_temp) {
170 		ptd->crt_temp = GET_WPT_TEMP(trip_temp);
171 		ptd->crt_trip_id = 0;
172 		++(*nr_trips);
173 	}
174 
175 	ptd->hot_trip_id = -1;
176 	trip_temp = readw(ptd->hw_base + WPT_PHL);
177 	trip_temp &= 0x1FF;
178 	if (trip_temp) {
179 		ptd->hot_temp = GET_WPT_TEMP(trip_temp);
180 		ptd->hot_trip_id = *nr_trips;
181 		++(*nr_trips);
182 	}
183 
184 	pch_wpt_add_acpi_psv_trip(ptd, nr_trips);
185 
186 	return 0;
187 }
188 
189 static int pch_wpt_get_temp(struct pch_thermal_device *ptd, int *temp)
190 {
191 	*temp = GET_WPT_TEMP(WPT_TEMP_TSR & readw(ptd->hw_base + WPT_TEMP));
192 
193 	return 0;
194 }
195 
196 /* Cool the PCH when it's overheat in .suspend_noirq phase */
197 static int pch_wpt_suspend(struct pch_thermal_device *ptd)
198 {
199 	u8 tsel;
200 	int pch_delay_cnt = 0;
201 	u16 pch_thr_temp, pch_cur_temp;
202 
203 	/* Shutdown the thermal sensor if it is not enabled by BIOS */
204 	if (!ptd->bios_enabled) {
205 		tsel = readb(ptd->hw_base + WPT_TSEL);
206 		writeb(tsel & 0xFE, ptd->hw_base + WPT_TSEL);
207 		return 0;
208 	}
209 
210 	/* Do not check temperature if it is not s2idle */
211 	if (pm_suspend_via_firmware())
212 		return 0;
213 
214 	/* Get the PCH temperature threshold value */
215 	pch_thr_temp = GET_PCH_TEMP(WPT_TEMP_TSR & readw(ptd->hw_base + WPT_TSPM));
216 
217 	/* Get the PCH current temperature value */
218 	pch_cur_temp = GET_PCH_TEMP(WPT_TEMP_TSR & readw(ptd->hw_base + WPT_TEMP));
219 
220 	/*
221 	 * If current PCH temperature is higher than configured PCH threshold
222 	 * value, run some delay loop with sleep to let the current temperature
223 	 * go down below the threshold value which helps to allow system enter
224 	 * lower power S0ix suspend state. Even after delay loop if PCH current
225 	 * temperature stays above threshold, notify the warning message
226 	 * which helps to indentify the reason why S0ix entry was rejected.
227 	 */
228 	while (pch_delay_cnt < delay_cnt) {
229 		if (pch_cur_temp < pch_thr_temp)
230 			break;
231 
232 		if (pm_wakeup_pending()) {
233 			dev_warn(&ptd->pdev->dev, "Wakeup event detected, abort cooling\n");
234 			return 0;
235 		}
236 
237 		pch_delay_cnt++;
238 		dev_dbg(&ptd->pdev->dev,
239 			"CPU-PCH current temp [%dC] higher than the threshold temp [%dC], sleep %d times for %d ms duration\n",
240 			pch_cur_temp, pch_thr_temp, pch_delay_cnt, delay_timeout);
241 		msleep(delay_timeout);
242 		/* Read the PCH current temperature for next cycle. */
243 		pch_cur_temp = GET_PCH_TEMP(WPT_TEMP_TSR & readw(ptd->hw_base + WPT_TEMP));
244 	}
245 
246 	if (pch_cur_temp >= pch_thr_temp)
247 		dev_warn(&ptd->pdev->dev,
248 			"CPU-PCH is hot [%dC] after %d ms delay. S0ix might fail\n",
249 			pch_cur_temp, pch_delay_cnt * delay_timeout);
250 	else {
251 		if (pch_delay_cnt)
252 			dev_info(&ptd->pdev->dev,
253 				"CPU-PCH is cool [%dC] after %d ms delay\n",
254 				pch_cur_temp, pch_delay_cnt * delay_timeout);
255 		else
256 			dev_info(&ptd->pdev->dev,
257 				"CPU-PCH is cool [%dC]\n",
258 				pch_cur_temp);
259 	}
260 
261 	return 0;
262 }
263 
264 static int pch_wpt_resume(struct pch_thermal_device *ptd)
265 {
266 	u8 tsel;
267 
268 	if (ptd->bios_enabled)
269 		return 0;
270 
271 	tsel = readb(ptd->hw_base + WPT_TSEL);
272 
273 	writeb(tsel | WPT_TSEL_ETS, ptd->hw_base + WPT_TSEL);
274 
275 	return 0;
276 }
277 
278 struct pch_dev_ops {
279 	int (*hw_init)(struct pch_thermal_device *ptd, int *nr_trips);
280 	int (*get_temp)(struct pch_thermal_device *ptd, int *temp);
281 	int (*suspend)(struct pch_thermal_device *ptd);
282 	int (*resume)(struct pch_thermal_device *ptd);
283 };
284 
285 
286 /* dev ops for Wildcat Point */
287 static const struct pch_dev_ops pch_dev_ops_wpt = {
288 	.hw_init = pch_wpt_init,
289 	.get_temp = pch_wpt_get_temp,
290 	.suspend = pch_wpt_suspend,
291 	.resume = pch_wpt_resume,
292 };
293 
294 static int pch_thermal_get_temp(struct thermal_zone_device *tzd, int *temp)
295 {
296 	struct pch_thermal_device *ptd = tzd->devdata;
297 
298 	return	ptd->ops->get_temp(ptd, temp);
299 }
300 
301 static int pch_get_trip_type(struct thermal_zone_device *tzd, int trip,
302 			     enum thermal_trip_type *type)
303 {
304 	struct pch_thermal_device *ptd = tzd->devdata;
305 
306 	if (ptd->crt_trip_id == trip)
307 		*type = THERMAL_TRIP_CRITICAL;
308 	else if (ptd->hot_trip_id == trip)
309 		*type = THERMAL_TRIP_HOT;
310 	else if (ptd->psv_trip_id == trip)
311 		*type = THERMAL_TRIP_PASSIVE;
312 	else
313 		return -EINVAL;
314 
315 	return 0;
316 }
317 
318 static int pch_get_trip_temp(struct thermal_zone_device *tzd, int trip, int *temp)
319 {
320 	struct pch_thermal_device *ptd = tzd->devdata;
321 
322 	if (ptd->crt_trip_id == trip)
323 		*temp = ptd->crt_temp;
324 	else if (ptd->hot_trip_id == trip)
325 		*temp = ptd->hot_temp;
326 	else if (ptd->psv_trip_id == trip)
327 		*temp = ptd->psv_temp;
328 	else
329 		return -EINVAL;
330 
331 	return 0;
332 }
333 
334 static void pch_critical(struct thermal_zone_device *tzd)
335 {
336 	dev_dbg(&tzd->device, "%s: critical temperature reached\n", tzd->type);
337 }
338 
339 static struct thermal_zone_device_ops tzd_ops = {
340 	.get_temp = pch_thermal_get_temp,
341 	.get_trip_type = pch_get_trip_type,
342 	.get_trip_temp = pch_get_trip_temp,
343 	.critical = pch_critical,
344 };
345 
346 enum board_ids {
347 	board_hsw,
348 	board_wpt,
349 	board_skl,
350 	board_cnl,
351 	board_cml,
352 	board_lwb,
353 };
354 
355 static const struct board_info {
356 	const char *name;
357 	const struct pch_dev_ops *ops;
358 } board_info[] = {
359 	[board_hsw] = {
360 		.name = "pch_haswell",
361 		.ops = &pch_dev_ops_wpt,
362 	},
363 	[board_wpt] = {
364 		.name = "pch_wildcat_point",
365 		.ops = &pch_dev_ops_wpt,
366 	},
367 	[board_skl] = {
368 		.name = "pch_skylake",
369 		.ops = &pch_dev_ops_wpt,
370 	},
371 	[board_cnl] = {
372 		.name = "pch_cannonlake",
373 		.ops = &pch_dev_ops_wpt,
374 	},
375 	[board_cml] = {
376 		.name = "pch_cometlake",
377 		.ops = &pch_dev_ops_wpt,
378 	},
379 	[board_lwb] = {
380 		.name = "pch_lewisburg",
381 		.ops = &pch_dev_ops_wpt,
382 	},
383 };
384 
385 static int intel_pch_thermal_probe(struct pci_dev *pdev,
386 				   const struct pci_device_id *id)
387 {
388 	enum board_ids board_id = id->driver_data;
389 	const struct board_info *bi = &board_info[board_id];
390 	struct pch_thermal_device *ptd;
391 	int err;
392 	int nr_trips;
393 
394 	ptd = devm_kzalloc(&pdev->dev, sizeof(*ptd), GFP_KERNEL);
395 	if (!ptd)
396 		return -ENOMEM;
397 
398 	ptd->ops = bi->ops;
399 
400 	pci_set_drvdata(pdev, ptd);
401 	ptd->pdev = pdev;
402 
403 	err = pci_enable_device(pdev);
404 	if (err) {
405 		dev_err(&pdev->dev, "failed to enable pci device\n");
406 		return err;
407 	}
408 
409 	err = pci_request_regions(pdev, driver_name);
410 	if (err) {
411 		dev_err(&pdev->dev, "failed to request pci region\n");
412 		goto error_disable;
413 	}
414 
415 	ptd->hw_base = pci_ioremap_bar(pdev, 0);
416 	if (!ptd->hw_base) {
417 		err = -ENOMEM;
418 		dev_err(&pdev->dev, "failed to map mem base\n");
419 		goto error_release;
420 	}
421 
422 	err = ptd->ops->hw_init(ptd, &nr_trips);
423 	if (err)
424 		goto error_cleanup;
425 
426 	ptd->tzd = thermal_zone_device_register(bi->name, nr_trips, 0, ptd,
427 						&tzd_ops, NULL, 0, 0);
428 	if (IS_ERR(ptd->tzd)) {
429 		dev_err(&pdev->dev, "Failed to register thermal zone %s\n",
430 			bi->name);
431 		err = PTR_ERR(ptd->tzd);
432 		goto error_cleanup;
433 	}
434 	err = thermal_zone_device_enable(ptd->tzd);
435 	if (err)
436 		goto err_unregister;
437 
438 	return 0;
439 
440 err_unregister:
441 	thermal_zone_device_unregister(ptd->tzd);
442 error_cleanup:
443 	iounmap(ptd->hw_base);
444 error_release:
445 	pci_release_regions(pdev);
446 error_disable:
447 	pci_disable_device(pdev);
448 	dev_err(&pdev->dev, "pci device failed to probe\n");
449 	return err;
450 }
451 
452 static void intel_pch_thermal_remove(struct pci_dev *pdev)
453 {
454 	struct pch_thermal_device *ptd = pci_get_drvdata(pdev);
455 
456 	thermal_zone_device_unregister(ptd->tzd);
457 	iounmap(ptd->hw_base);
458 	pci_set_drvdata(pdev, NULL);
459 	pci_release_regions(pdev);
460 	pci_disable_device(pdev);
461 }
462 
463 static int intel_pch_thermal_suspend_noirq(struct device *device)
464 {
465 	struct pch_thermal_device *ptd = dev_get_drvdata(device);
466 
467 	return ptd->ops->suspend(ptd);
468 }
469 
470 static int intel_pch_thermal_resume(struct device *device)
471 {
472 	struct pch_thermal_device *ptd = dev_get_drvdata(device);
473 
474 	return ptd->ops->resume(ptd);
475 }
476 
477 static const struct pci_device_id intel_pch_thermal_id[] = {
478 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_HSW_1),
479 		.driver_data = board_hsw, },
480 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_HSW_2),
481 		.driver_data = board_hsw, },
482 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_WPT),
483 		.driver_data = board_wpt, },
484 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_SKL),
485 		.driver_data = board_skl, },
486 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_SKL_H),
487 		.driver_data = board_skl, },
488 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_CNL),
489 		.driver_data = board_cnl, },
490 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_CNL_H),
491 		.driver_data = board_cnl, },
492 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_CNL_LP),
493 		.driver_data = board_cnl, },
494 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_CML_H),
495 		.driver_data = board_cml, },
496 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_LWB),
497 		.driver_data = board_lwb, },
498 	{ 0, },
499 };
500 MODULE_DEVICE_TABLE(pci, intel_pch_thermal_id);
501 
502 static const struct dev_pm_ops intel_pch_pm_ops = {
503 	.suspend_noirq = intel_pch_thermal_suspend_noirq,
504 	.resume = intel_pch_thermal_resume,
505 };
506 
507 static struct pci_driver intel_pch_thermal_driver = {
508 	.name		= "intel_pch_thermal",
509 	.id_table	= intel_pch_thermal_id,
510 	.probe		= intel_pch_thermal_probe,
511 	.remove		= intel_pch_thermal_remove,
512 	.driver.pm	= &intel_pch_pm_ops,
513 };
514 
515 module_pci_driver(intel_pch_thermal_driver);
516 
517 MODULE_LICENSE("GPL v2");
518 MODULE_DESCRIPTION("Intel PCH Thermal driver");
519