1 /*
2  * processor_thermal_device.c
3  * Copyright (c) 2014, Intel Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms and conditions of the GNU General Public License,
7  * version 2, as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  */
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/pci.h>
19 #include <linux/interrupt.h>
20 #include <linux/platform_device.h>
21 #include <linux/acpi.h>
22 #include <linux/thermal.h>
23 #include "int340x_thermal_zone.h"
24 #include "../intel_soc_dts_iosf.h"
25 
26 /* Broadwell-U/HSB thermal reporting device */
27 #define PCI_DEVICE_ID_PROC_BDW_THERMAL	0x1603
28 #define PCI_DEVICE_ID_PROC_HSB_THERMAL	0x0A03
29 
30 /* Skylake thermal reporting device */
31 #define PCI_DEVICE_ID_PROC_SKL_THERMAL	0x1903
32 
33 /* CannonLake thermal reporting device */
34 #define PCI_DEVICE_ID_PROC_CNL_THERMAL	0x5a03
35 #define PCI_DEVICE_ID_PROC_CFL_THERMAL	0x3E83
36 
37 /* Braswell thermal reporting device */
38 #define PCI_DEVICE_ID_PROC_BSW_THERMAL	0x22DC
39 
40 /* Broxton thermal reporting device */
41 #define PCI_DEVICE_ID_PROC_BXT0_THERMAL  0x0A8C
42 #define PCI_DEVICE_ID_PROC_BXT1_THERMAL  0x1A8C
43 #define PCI_DEVICE_ID_PROC_BXTX_THERMAL  0x4A8C
44 #define PCI_DEVICE_ID_PROC_BXTP_THERMAL  0x5A8C
45 
46 /* GeminiLake thermal reporting device */
47 #define PCI_DEVICE_ID_PROC_GLK_THERMAL	0x318C
48 
49 struct power_config {
50 	u32	index;
51 	u32	min_uw;
52 	u32	max_uw;
53 	u32	tmin_us;
54 	u32	tmax_us;
55 	u32	step_uw;
56 };
57 
58 struct proc_thermal_device {
59 	struct device *dev;
60 	struct acpi_device *adev;
61 	struct power_config power_limits[2];
62 	struct int34x_thermal_zone *int340x_zone;
63 	struct intel_soc_dts_sensors *soc_dts;
64 };
65 
66 enum proc_thermal_emum_mode_type {
67 	PROC_THERMAL_NONE,
68 	PROC_THERMAL_PCI,
69 	PROC_THERMAL_PLATFORM_DEV
70 };
71 
72 /*
73  * We can have only one type of enumeration, PCI or Platform,
74  * not both. So we don't need instance specific data.
75  */
76 static enum proc_thermal_emum_mode_type proc_thermal_emum_mode =
77 							PROC_THERMAL_NONE;
78 
79 #define POWER_LIMIT_SHOW(index, suffix) \
80 static ssize_t power_limit_##index##_##suffix##_show(struct device *dev, \
81 					struct device_attribute *attr, \
82 					char *buf) \
83 { \
84 	struct pci_dev *pci_dev; \
85 	struct platform_device *pdev; \
86 	struct proc_thermal_device *proc_dev; \
87 	\
88 	if (proc_thermal_emum_mode == PROC_THERMAL_NONE) { \
89 		dev_warn(dev, "Attempted to get power limit before device was initialized!\n"); \
90 		return 0; \
91 	} \
92 	\
93 	if (proc_thermal_emum_mode == PROC_THERMAL_PLATFORM_DEV) { \
94 		pdev = to_platform_device(dev); \
95 		proc_dev = platform_get_drvdata(pdev); \
96 	} else { \
97 		pci_dev = to_pci_dev(dev); \
98 		proc_dev = pci_get_drvdata(pci_dev); \
99 	} \
100 	return sprintf(buf, "%lu\n",\
101 	(unsigned long)proc_dev->power_limits[index].suffix * 1000); \
102 }
103 
104 POWER_LIMIT_SHOW(0, min_uw)
105 POWER_LIMIT_SHOW(0, max_uw)
106 POWER_LIMIT_SHOW(0, step_uw)
107 POWER_LIMIT_SHOW(0, tmin_us)
108 POWER_LIMIT_SHOW(0, tmax_us)
109 
110 POWER_LIMIT_SHOW(1, min_uw)
111 POWER_LIMIT_SHOW(1, max_uw)
112 POWER_LIMIT_SHOW(1, step_uw)
113 POWER_LIMIT_SHOW(1, tmin_us)
114 POWER_LIMIT_SHOW(1, tmax_us)
115 
116 static DEVICE_ATTR_RO(power_limit_0_min_uw);
117 static DEVICE_ATTR_RO(power_limit_0_max_uw);
118 static DEVICE_ATTR_RO(power_limit_0_step_uw);
119 static DEVICE_ATTR_RO(power_limit_0_tmin_us);
120 static DEVICE_ATTR_RO(power_limit_0_tmax_us);
121 
122 static DEVICE_ATTR_RO(power_limit_1_min_uw);
123 static DEVICE_ATTR_RO(power_limit_1_max_uw);
124 static DEVICE_ATTR_RO(power_limit_1_step_uw);
125 static DEVICE_ATTR_RO(power_limit_1_tmin_us);
126 static DEVICE_ATTR_RO(power_limit_1_tmax_us);
127 
128 static struct attribute *power_limit_attrs[] = {
129 	&dev_attr_power_limit_0_min_uw.attr,
130 	&dev_attr_power_limit_1_min_uw.attr,
131 	&dev_attr_power_limit_0_max_uw.attr,
132 	&dev_attr_power_limit_1_max_uw.attr,
133 	&dev_attr_power_limit_0_step_uw.attr,
134 	&dev_attr_power_limit_1_step_uw.attr,
135 	&dev_attr_power_limit_0_tmin_us.attr,
136 	&dev_attr_power_limit_1_tmin_us.attr,
137 	&dev_attr_power_limit_0_tmax_us.attr,
138 	&dev_attr_power_limit_1_tmax_us.attr,
139 	NULL
140 };
141 
142 static const struct attribute_group power_limit_attribute_group = {
143 	.attrs = power_limit_attrs,
144 	.name = "power_limits"
145 };
146 
147 static int stored_tjmax; /* since it is fixed, we can have local storage */
148 
149 static int get_tjmax(void)
150 {
151 	u32 eax, edx;
152 	u32 val;
153 	int err;
154 
155 	err = rdmsr_safe(MSR_IA32_TEMPERATURE_TARGET, &eax, &edx);
156 	if (err)
157 		return err;
158 
159 	val = (eax >> 16) & 0xff;
160 	if (val)
161 		return val;
162 
163 	return -EINVAL;
164 }
165 
166 static int read_temp_msr(int *temp)
167 {
168 	int cpu;
169 	u32 eax, edx;
170 	int err;
171 	unsigned long curr_temp_off = 0;
172 
173 	*temp = 0;
174 
175 	for_each_online_cpu(cpu) {
176 		err = rdmsr_safe_on_cpu(cpu, MSR_IA32_THERM_STATUS, &eax,
177 					&edx);
178 		if (err)
179 			goto err_ret;
180 		else {
181 			if (eax & 0x80000000) {
182 				curr_temp_off = (eax >> 16) & 0x7f;
183 				if (!*temp || curr_temp_off < *temp)
184 					*temp = curr_temp_off;
185 			} else {
186 				err = -EINVAL;
187 				goto err_ret;
188 			}
189 		}
190 	}
191 
192 	return 0;
193 err_ret:
194 	return err;
195 }
196 
197 static int proc_thermal_get_zone_temp(struct thermal_zone_device *zone,
198 					 int *temp)
199 {
200 	int ret;
201 
202 	ret = read_temp_msr(temp);
203 	if (!ret)
204 		*temp = (stored_tjmax - *temp) * 1000;
205 
206 	return ret;
207 }
208 
209 static struct thermal_zone_device_ops proc_thermal_local_ops = {
210 	.get_temp       = proc_thermal_get_zone_temp,
211 };
212 
213 static int proc_thermal_read_ppcc(struct proc_thermal_device *proc_priv)
214 {
215 	int i;
216 	acpi_status status;
217 	struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
218 	union acpi_object *elements, *ppcc;
219 	union acpi_object *p;
220 	int ret = 0;
221 
222 	status = acpi_evaluate_object(proc_priv->adev->handle, "PPCC",
223 				      NULL, &buf);
224 	if (ACPI_FAILURE(status))
225 		return -ENODEV;
226 
227 	p = buf.pointer;
228 	if (!p || (p->type != ACPI_TYPE_PACKAGE)) {
229 		dev_err(proc_priv->dev, "Invalid PPCC data\n");
230 		ret = -EFAULT;
231 		goto free_buffer;
232 	}
233 
234 	if (!p->package.count) {
235 		dev_err(proc_priv->dev, "Invalid PPCC package size\n");
236 		ret = -EFAULT;
237 		goto free_buffer;
238 	}
239 
240 	for (i = 0; i < min((int)p->package.count - 1, 2); ++i) {
241 		elements = &(p->package.elements[i+1]);
242 		if (elements->type != ACPI_TYPE_PACKAGE ||
243 		    elements->package.count != 6) {
244 			ret = -EFAULT;
245 			goto free_buffer;
246 		}
247 		ppcc = elements->package.elements;
248 		proc_priv->power_limits[i].index = ppcc[0].integer.value;
249 		proc_priv->power_limits[i].min_uw = ppcc[1].integer.value;
250 		proc_priv->power_limits[i].max_uw = ppcc[2].integer.value;
251 		proc_priv->power_limits[i].tmin_us = ppcc[3].integer.value;
252 		proc_priv->power_limits[i].tmax_us = ppcc[4].integer.value;
253 		proc_priv->power_limits[i].step_uw = ppcc[5].integer.value;
254 	}
255 
256 free_buffer:
257 	kfree(buf.pointer);
258 
259 	return ret;
260 }
261 
262 #define PROC_POWER_CAPABILITY_CHANGED	0x83
263 static void proc_thermal_notify(acpi_handle handle, u32 event, void *data)
264 {
265 	struct proc_thermal_device *proc_priv = data;
266 
267 	if (!proc_priv)
268 		return;
269 
270 	switch (event) {
271 	case PROC_POWER_CAPABILITY_CHANGED:
272 		proc_thermal_read_ppcc(proc_priv);
273 		int340x_thermal_zone_device_update(proc_priv->int340x_zone,
274 				THERMAL_DEVICE_POWER_CAPABILITY_CHANGED);
275 		break;
276 	default:
277 		dev_err(proc_priv->dev, "Unsupported event [0x%x]\n", event);
278 		break;
279 	}
280 }
281 
282 
283 static int proc_thermal_add(struct device *dev,
284 			    struct proc_thermal_device **priv)
285 {
286 	struct proc_thermal_device *proc_priv;
287 	struct acpi_device *adev;
288 	acpi_status status;
289 	unsigned long long tmp;
290 	struct thermal_zone_device_ops *ops = NULL;
291 	int ret;
292 
293 	adev = ACPI_COMPANION(dev);
294 	if (!adev)
295 		return -ENODEV;
296 
297 	proc_priv = devm_kzalloc(dev, sizeof(*proc_priv), GFP_KERNEL);
298 	if (!proc_priv)
299 		return -ENOMEM;
300 
301 	proc_priv->dev = dev;
302 	proc_priv->adev = adev;
303 	*priv = proc_priv;
304 
305 	ret = proc_thermal_read_ppcc(proc_priv);
306 	if (ret)
307 		return ret;
308 
309 	status = acpi_evaluate_integer(adev->handle, "_TMP", NULL, &tmp);
310 	if (ACPI_FAILURE(status)) {
311 		/* there is no _TMP method, add local method */
312 		stored_tjmax = get_tjmax();
313 		if (stored_tjmax > 0)
314 			ops = &proc_thermal_local_ops;
315 	}
316 
317 	proc_priv->int340x_zone = int340x_thermal_zone_add(adev, ops);
318 	if (IS_ERR(proc_priv->int340x_zone)) {
319 		return PTR_ERR(proc_priv->int340x_zone);
320 	} else
321 		ret = 0;
322 
323 	ret = acpi_install_notify_handler(adev->handle, ACPI_DEVICE_NOTIFY,
324 					  proc_thermal_notify,
325 					  (void *)proc_priv);
326 	if (ret)
327 		goto remove_zone;
328 
329 	return 0;
330 
331 remove_zone:
332 	int340x_thermal_zone_remove(proc_priv->int340x_zone);
333 
334 	return ret;
335 }
336 
337 static void proc_thermal_remove(struct proc_thermal_device *proc_priv)
338 {
339 	acpi_remove_notify_handler(proc_priv->adev->handle,
340 				   ACPI_DEVICE_NOTIFY, proc_thermal_notify);
341 	int340x_thermal_zone_remove(proc_priv->int340x_zone);
342 	sysfs_remove_group(&proc_priv->dev->kobj,
343 			   &power_limit_attribute_group);
344 }
345 
346 static int int3401_add(struct platform_device *pdev)
347 {
348 	struct proc_thermal_device *proc_priv;
349 	int ret;
350 
351 	if (proc_thermal_emum_mode == PROC_THERMAL_PCI) {
352 		dev_err(&pdev->dev, "error: enumerated as PCI dev\n");
353 		return -ENODEV;
354 	}
355 
356 	ret = proc_thermal_add(&pdev->dev, &proc_priv);
357 	if (ret)
358 		return ret;
359 
360 	platform_set_drvdata(pdev, proc_priv);
361 	proc_thermal_emum_mode = PROC_THERMAL_PLATFORM_DEV;
362 
363 	dev_info(&pdev->dev, "Creating sysfs group for PROC_THERMAL_PLATFORM_DEV\n");
364 
365 	return sysfs_create_group(&pdev->dev.kobj,
366 					 &power_limit_attribute_group);
367 }
368 
369 static int int3401_remove(struct platform_device *pdev)
370 {
371 	proc_thermal_remove(platform_get_drvdata(pdev));
372 
373 	return 0;
374 }
375 
376 static irqreturn_t proc_thermal_pci_msi_irq(int irq, void *devid)
377 {
378 	struct proc_thermal_device *proc_priv;
379 	struct pci_dev *pdev = devid;
380 
381 	proc_priv = pci_get_drvdata(pdev);
382 
383 	intel_soc_dts_iosf_interrupt_handler(proc_priv->soc_dts);
384 
385 	return IRQ_HANDLED;
386 }
387 
388 static int  proc_thermal_pci_probe(struct pci_dev *pdev,
389 				   const struct pci_device_id *unused)
390 {
391 	struct proc_thermal_device *proc_priv;
392 	int ret;
393 
394 	if (proc_thermal_emum_mode == PROC_THERMAL_PLATFORM_DEV) {
395 		dev_err(&pdev->dev, "error: enumerated as platform dev\n");
396 		return -ENODEV;
397 	}
398 
399 	ret = pci_enable_device(pdev);
400 	if (ret < 0) {
401 		dev_err(&pdev->dev, "error: could not enable device\n");
402 		return ret;
403 	}
404 
405 	ret = proc_thermal_add(&pdev->dev, &proc_priv);
406 	if (ret) {
407 		pci_disable_device(pdev);
408 		return ret;
409 	}
410 
411 	pci_set_drvdata(pdev, proc_priv);
412 	proc_thermal_emum_mode = PROC_THERMAL_PCI;
413 
414 	if (pdev->device == PCI_DEVICE_ID_PROC_BSW_THERMAL) {
415 		/*
416 		 * Enumerate additional DTS sensors available via IOSF.
417 		 * But we are not treating as a failure condition, if
418 		 * there are no aux DTSs enabled or fails. This driver
419 		 * already exposes sensors, which can be accessed via
420 		 * ACPI/MSR. So we don't want to fail for auxiliary DTSs.
421 		 */
422 		proc_priv->soc_dts = intel_soc_dts_iosf_init(
423 					INTEL_SOC_DTS_INTERRUPT_MSI, 2, 0);
424 
425 		if (!IS_ERR(proc_priv->soc_dts) && pdev->irq) {
426 			ret = pci_enable_msi(pdev);
427 			if (!ret) {
428 				ret = request_threaded_irq(pdev->irq, NULL,
429 						proc_thermal_pci_msi_irq,
430 						IRQF_ONESHOT, "proc_thermal",
431 						pdev);
432 				if (ret) {
433 					intel_soc_dts_iosf_exit(
434 							proc_priv->soc_dts);
435 					pci_disable_msi(pdev);
436 					proc_priv->soc_dts = NULL;
437 				}
438 			}
439 		} else
440 			dev_err(&pdev->dev, "No auxiliary DTSs enabled\n");
441 	}
442 
443 	dev_info(&pdev->dev, "Creating sysfs group for PROC_THERMAL_PCI\n");
444 
445 	return sysfs_create_group(&pdev->dev.kobj,
446 					 &power_limit_attribute_group);
447 }
448 
449 static void  proc_thermal_pci_remove(struct pci_dev *pdev)
450 {
451 	struct proc_thermal_device *proc_priv = pci_get_drvdata(pdev);
452 
453 	if (proc_priv->soc_dts) {
454 		intel_soc_dts_iosf_exit(proc_priv->soc_dts);
455 		if (pdev->irq) {
456 			free_irq(pdev->irq, pdev);
457 			pci_disable_msi(pdev);
458 		}
459 	}
460 	proc_thermal_remove(proc_priv);
461 	pci_disable_device(pdev);
462 }
463 
464 static const struct pci_device_id proc_thermal_pci_ids[] = {
465 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_BDW_THERMAL)},
466 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_HSB_THERMAL)},
467 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_SKL_THERMAL)},
468 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_BSW_THERMAL)},
469 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_BXT0_THERMAL)},
470 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_BXT1_THERMAL)},
471 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_BXTX_THERMAL)},
472 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_BXTP_THERMAL)},
473 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_CNL_THERMAL)},
474 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_CFL_THERMAL)},
475 	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_PROC_GLK_THERMAL)},
476 	{ 0, },
477 };
478 
479 MODULE_DEVICE_TABLE(pci, proc_thermal_pci_ids);
480 
481 static struct pci_driver proc_thermal_pci_driver = {
482 	.name		= "proc_thermal",
483 	.probe		= proc_thermal_pci_probe,
484 	.remove		= proc_thermal_pci_remove,
485 	.id_table	= proc_thermal_pci_ids,
486 };
487 
488 static const struct acpi_device_id int3401_device_ids[] = {
489 	{"INT3401", 0},
490 	{"", 0},
491 };
492 MODULE_DEVICE_TABLE(acpi, int3401_device_ids);
493 
494 static struct platform_driver int3401_driver = {
495 	.probe = int3401_add,
496 	.remove = int3401_remove,
497 	.driver = {
498 		.name = "int3401 thermal",
499 		.acpi_match_table = int3401_device_ids,
500 	},
501 };
502 
503 static int __init proc_thermal_init(void)
504 {
505 	int ret;
506 
507 	ret = platform_driver_register(&int3401_driver);
508 	if (ret)
509 		return ret;
510 
511 	ret = pci_register_driver(&proc_thermal_pci_driver);
512 
513 	return ret;
514 }
515 
516 static void __exit proc_thermal_exit(void)
517 {
518 	platform_driver_unregister(&int3401_driver);
519 	pci_unregister_driver(&proc_thermal_pci_driver);
520 }
521 
522 module_init(proc_thermal_init);
523 module_exit(proc_thermal_exit);
524 
525 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
526 MODULE_DESCRIPTION("Processor Thermal Reporting Device Driver");
527 MODULE_LICENSE("GPL v2");
528