1 /* intel_pch_thermal.c - Intel PCH Thermal driver
3 * Copyright (c) 2015, Intel Corporation.
6 * Tushar Dave <tushar.n.dave@intel.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms and conditions of the GNU General Public License,
10 * version 2, as published by the Free Software Foundation.
12 * This program is distributed in the hope it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
19 #include <linux/module.h>
20 #include <linux/types.h>
21 #include <linux/init.h>
22 #include <linux/pci.h>
23 #include <linux/acpi.h>
24 #include <linux/thermal.h>
27 /* Intel PCH thermal Device IDs */
28 #define PCH_THERMAL_DID_HSW_1 0x9C24 /* Haswell PCH */
29 #define PCH_THERMAL_DID_HSW_2 0x8C24 /* Haswell PCH */
30 #define PCH_THERMAL_DID_WPT 0x9CA4 /* Wildcat Point */
31 #define PCH_THERMAL_DID_SKL 0x9D31 /* Skylake PCH */
32 #define PCH_THERMAL_DID_SKL_H 0xA131 /* Skylake PCH 100 series */
34 /* Wildcat Point-LP PCH Thermal registers */
35 #define WPT_TEMP 0x0000 /* Temperature */
36 #define WPT_TSC 0x04 /* Thermal Sensor Control */
37 #define WPT_TSS 0x06 /* Thermal Sensor Status */
38 #define WPT_TSEL 0x08 /* Thermal Sensor Enable and Lock */
39 #define WPT_TSREL 0x0A /* Thermal Sensor Report Enable and Lock */
40 #define WPT_TSMIC 0x0C /* Thermal Sensor SMI Control */
41 #define WPT_CTT 0x0010 /* Catastrophic Trip Point */
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 */
51 /* Wildcat Point-LP PCH Thermal Register bit definitions */
52 #define WPT_TEMP_TSR 0x00ff /* 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 */
62 static char driver_name[] = "Intel PCH thermal driver";
64 struct pch_thermal_device {
65 void __iomem *hw_base;
66 const struct pch_dev_ops *ops;
68 struct thermal_zone_device *tzd;
70 unsigned long crt_temp;
72 unsigned long hot_temp;
74 unsigned long psv_temp;
81 * On some platforms, there is a companion ACPI device, which adds
82 * passive trip temperature using _PSV method. There is no specific
83 * passive temperature setting in MMIO interface of this PCI device.
85 static void pch_wpt_add_acpi_psv_trip(struct pch_thermal_device *ptd,
88 struct acpi_device *adev;
90 ptd->psv_trip_id = -1;
92 adev = ACPI_COMPANION(&ptd->pdev->dev);
97 status = acpi_evaluate_integer(adev->handle, "_PSV", NULL,
99 if (ACPI_SUCCESS(status)) {
100 unsigned long trip_temp;
102 trip_temp = DECI_KELVIN_TO_MILLICELSIUS(r);
104 ptd->psv_temp = trip_temp;
105 ptd->psv_trip_id = *nr_trips;
112 static void pch_wpt_add_acpi_psv_trip(struct pch_thermal_device *ptd,
115 ptd->psv_trip_id = -1;
120 static int pch_wpt_init(struct pch_thermal_device *ptd, int *nr_trips)
127 /* Check if BIOS has already enabled thermal sensor */
128 if (WPT_TSS_TSDSS & readb(ptd->hw_base + WPT_TSS)) {
129 ptd->bios_enabled = true;
133 tsel = readb(ptd->hw_base + WPT_TSEL);
135 * When TSEL's Policy Lock-Down bit is 1, TSEL become RO.
136 * If so, thermal sensor cannot enable. Bail out.
138 if (tsel & WPT_TSEL_PLDB) {
139 dev_err(&ptd->pdev->dev, "Sensor can't be enabled\n");
143 writeb(tsel|WPT_TSEL_ETS, ptd->hw_base + WPT_TSEL);
144 if (!(WPT_TSS_TSDSS & readb(ptd->hw_base + WPT_TSS))) {
145 dev_err(&ptd->pdev->dev, "Sensor can't be enabled\n");
150 ptd->crt_trip_id = -1;
151 trip_temp = readw(ptd->hw_base + WPT_CTT);
154 /* Resolution of 1/2 degree C and an offset of -50C */
155 ptd->crt_temp = trip_temp * 1000 / 2 - 50000;
156 ptd->crt_trip_id = 0;
160 ptd->hot_trip_id = -1;
161 trip_temp = readw(ptd->hw_base + WPT_PHL);
164 /* Resolution of 1/2 degree C and an offset of -50C */
165 ptd->hot_temp = trip_temp * 1000 / 2 - 50000;
166 ptd->hot_trip_id = *nr_trips;
170 pch_wpt_add_acpi_psv_trip(ptd, nr_trips);
175 static int pch_wpt_get_temp(struct pch_thermal_device *ptd, int *temp)
179 wpt_temp = WPT_TEMP_TSR & readl(ptd->hw_base + WPT_TEMP);
181 /* Resolution of 1/2 degree C and an offset of -50C */
182 *temp = (wpt_temp * 1000 / 2 - 50000);
187 static int pch_wpt_suspend(struct pch_thermal_device *ptd)
191 if (ptd->bios_enabled)
194 tsel = readb(ptd->hw_base + WPT_TSEL);
196 writeb(tsel & 0xFE, ptd->hw_base + WPT_TSEL);
201 static int pch_wpt_resume(struct pch_thermal_device *ptd)
205 if (ptd->bios_enabled)
208 tsel = readb(ptd->hw_base + WPT_TSEL);
210 writeb(tsel | WPT_TSEL_ETS, ptd->hw_base + WPT_TSEL);
216 int (*hw_init)(struct pch_thermal_device *ptd, int *nr_trips);
217 int (*get_temp)(struct pch_thermal_device *ptd, int *temp);
218 int (*suspend)(struct pch_thermal_device *ptd);
219 int (*resume)(struct pch_thermal_device *ptd);
223 /* dev ops for Wildcat Point */
224 static const struct pch_dev_ops pch_dev_ops_wpt = {
225 .hw_init = pch_wpt_init,
226 .get_temp = pch_wpt_get_temp,
227 .suspend = pch_wpt_suspend,
228 .resume = pch_wpt_resume,
231 static int pch_thermal_get_temp(struct thermal_zone_device *tzd, int *temp)
233 struct pch_thermal_device *ptd = tzd->devdata;
235 return ptd->ops->get_temp(ptd, temp);
238 static int pch_get_trip_type(struct thermal_zone_device *tzd, int trip,
239 enum thermal_trip_type *type)
241 struct pch_thermal_device *ptd = tzd->devdata;
243 if (ptd->crt_trip_id == trip)
244 *type = THERMAL_TRIP_CRITICAL;
245 else if (ptd->hot_trip_id == trip)
246 *type = THERMAL_TRIP_HOT;
247 else if (ptd->psv_trip_id == trip)
248 *type = THERMAL_TRIP_PASSIVE;
255 static int pch_get_trip_temp(struct thermal_zone_device *tzd, int trip, int *temp)
257 struct pch_thermal_device *ptd = tzd->devdata;
259 if (ptd->crt_trip_id == trip)
260 *temp = ptd->crt_temp;
261 else if (ptd->hot_trip_id == trip)
262 *temp = ptd->hot_temp;
263 else if (ptd->psv_trip_id == trip)
264 *temp = ptd->psv_temp;
271 static struct thermal_zone_device_ops tzd_ops = {
272 .get_temp = pch_thermal_get_temp,
273 .get_trip_type = pch_get_trip_type,
274 .get_trip_temp = pch_get_trip_temp,
283 static const struct board_info {
285 const struct pch_dev_ops *ops;
288 .name = "pch_haswell",
289 .ops = &pch_dev_ops_wpt,
292 .name = "pch_wildcat_point",
293 .ops = &pch_dev_ops_wpt,
296 .name = "pch_skylake",
297 .ops = &pch_dev_ops_wpt,
301 static int intel_pch_thermal_probe(struct pci_dev *pdev,
302 const struct pci_device_id *id)
304 enum board_ids board_id = id->driver_data;
305 const struct board_info *bi = &board_info[board_id];
306 struct pch_thermal_device *ptd;
310 ptd = devm_kzalloc(&pdev->dev, sizeof(*ptd), GFP_KERNEL);
316 pci_set_drvdata(pdev, ptd);
319 err = pci_enable_device(pdev);
321 dev_err(&pdev->dev, "failed to enable pci device\n");
325 err = pci_request_regions(pdev, driver_name);
327 dev_err(&pdev->dev, "failed to request pci region\n");
331 ptd->hw_base = pci_ioremap_bar(pdev, 0);
334 dev_err(&pdev->dev, "failed to map mem base\n");
338 err = ptd->ops->hw_init(ptd, &nr_trips);
342 ptd->tzd = thermal_zone_device_register(bi->name, nr_trips, 0, ptd,
343 &tzd_ops, NULL, 0, 0);
344 if (IS_ERR(ptd->tzd)) {
345 dev_err(&pdev->dev, "Failed to register thermal zone %s\n",
347 err = PTR_ERR(ptd->tzd);
354 iounmap(ptd->hw_base);
356 pci_release_regions(pdev);
358 pci_disable_device(pdev);
359 dev_err(&pdev->dev, "pci device failed to probe\n");
363 static void intel_pch_thermal_remove(struct pci_dev *pdev)
365 struct pch_thermal_device *ptd = pci_get_drvdata(pdev);
367 thermal_zone_device_unregister(ptd->tzd);
368 iounmap(ptd->hw_base);
369 pci_set_drvdata(pdev, NULL);
370 pci_release_region(pdev, 0);
371 pci_disable_device(pdev);
374 static int intel_pch_thermal_suspend(struct device *device)
376 struct pci_dev *pdev = to_pci_dev(device);
377 struct pch_thermal_device *ptd = pci_get_drvdata(pdev);
379 return ptd->ops->suspend(ptd);
382 static int intel_pch_thermal_resume(struct device *device)
384 struct pci_dev *pdev = to_pci_dev(device);
385 struct pch_thermal_device *ptd = pci_get_drvdata(pdev);
387 return ptd->ops->resume(ptd);
390 static struct pci_device_id intel_pch_thermal_id[] = {
391 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_HSW_1),
392 .driver_data = board_hsw, },
393 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_HSW_2),
394 .driver_data = board_hsw, },
395 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_WPT),
396 .driver_data = board_wpt, },
397 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_SKL),
398 .driver_data = board_skl, },
399 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCH_THERMAL_DID_SKL_H),
400 .driver_data = board_skl, },
403 MODULE_DEVICE_TABLE(pci, intel_pch_thermal_id);
405 static const struct dev_pm_ops intel_pch_pm_ops = {
406 .suspend = intel_pch_thermal_suspend,
407 .resume = intel_pch_thermal_resume,
410 static struct pci_driver intel_pch_thermal_driver = {
411 .name = "intel_pch_thermal",
412 .id_table = intel_pch_thermal_id,
413 .probe = intel_pch_thermal_probe,
414 .remove = intel_pch_thermal_remove,
415 .driver.pm = &intel_pch_pm_ops,
418 module_pci_driver(intel_pch_thermal_driver);
420 MODULE_LICENSE("GPL v2");
421 MODULE_DESCRIPTION("Intel PCH Thermal driver");