xref: /openbmc/linux/drivers/thermal/imx_thermal.c (revision 065ca2a8c6ee601d990ea10efc71b861c5afc4fd)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Copyright 2013 Freescale Semiconductor, Inc.
4 
5 #include <linux/clk.h>
6 #include <linux/cpufreq.h>
7 #include <linux/cpu_cooling.h>
8 #include <linux/delay.h>
9 #include <linux/interrupt.h>
10 #include <linux/io.h>
11 #include <linux/mfd/syscon.h>
12 #include <linux/module.h>
13 #include <linux/of.h>
14 #include <linux/of_device.h>
15 #include <linux/regmap.h>
16 #include <linux/thermal.h>
17 #include <linux/nvmem-consumer.h>
18 #include <linux/pm_runtime.h>
19 
20 #define REG_SET		0x4
21 #define REG_CLR		0x8
22 #define REG_TOG		0xc
23 
24 /* i.MX6 specific */
25 #define IMX6_MISC0				0x0150
26 #define IMX6_MISC0_REFTOP_SELBIASOFF		(1 << 3)
27 #define IMX6_MISC1				0x0160
28 #define IMX6_MISC1_IRQ_TEMPHIGH			(1 << 29)
29 /* Below LOW and PANIC bits are only for TEMPMON_IMX6SX */
30 #define IMX6_MISC1_IRQ_TEMPLOW			(1 << 28)
31 #define IMX6_MISC1_IRQ_TEMPPANIC		(1 << 27)
32 
33 #define IMX6_TEMPSENSE0				0x0180
34 #define IMX6_TEMPSENSE0_ALARM_VALUE_SHIFT	20
35 #define IMX6_TEMPSENSE0_ALARM_VALUE_MASK	(0xfff << 20)
36 #define IMX6_TEMPSENSE0_TEMP_CNT_SHIFT		8
37 #define IMX6_TEMPSENSE0_TEMP_CNT_MASK		(0xfff << 8)
38 #define IMX6_TEMPSENSE0_FINISHED		(1 << 2)
39 #define IMX6_TEMPSENSE0_MEASURE_TEMP		(1 << 1)
40 #define IMX6_TEMPSENSE0_POWER_DOWN		(1 << 0)
41 
42 #define IMX6_TEMPSENSE1				0x0190
43 #define IMX6_TEMPSENSE1_MEASURE_FREQ		0xffff
44 #define IMX6_TEMPSENSE1_MEASURE_FREQ_SHIFT	0
45 
46 #define OCOTP_MEM0			0x0480
47 #define OCOTP_ANA1			0x04e0
48 
49 /* Below TEMPSENSE2 is only for TEMPMON_IMX6SX */
50 #define IMX6_TEMPSENSE2				0x0290
51 #define IMX6_TEMPSENSE2_LOW_VALUE_SHIFT		0
52 #define IMX6_TEMPSENSE2_LOW_VALUE_MASK		0xfff
53 #define IMX6_TEMPSENSE2_PANIC_VALUE_SHIFT	16
54 #define IMX6_TEMPSENSE2_PANIC_VALUE_MASK	0xfff0000
55 
56 /* i.MX7 specific */
57 #define IMX7_ANADIG_DIGPROG			0x800
58 #define IMX7_TEMPSENSE0				0x300
59 #define IMX7_TEMPSENSE0_PANIC_ALARM_SHIFT	18
60 #define IMX7_TEMPSENSE0_PANIC_ALARM_MASK	(0x1ff << 18)
61 #define IMX7_TEMPSENSE0_HIGH_ALARM_SHIFT	9
62 #define IMX7_TEMPSENSE0_HIGH_ALARM_MASK		(0x1ff << 9)
63 #define IMX7_TEMPSENSE0_LOW_ALARM_SHIFT		0
64 #define IMX7_TEMPSENSE0_LOW_ALARM_MASK		0x1ff
65 
66 #define IMX7_TEMPSENSE1				0x310
67 #define IMX7_TEMPSENSE1_MEASURE_FREQ_SHIFT	16
68 #define IMX7_TEMPSENSE1_MEASURE_FREQ_MASK	(0xffff << 16)
69 #define IMX7_TEMPSENSE1_FINISHED		(1 << 11)
70 #define IMX7_TEMPSENSE1_MEASURE_TEMP		(1 << 10)
71 #define IMX7_TEMPSENSE1_POWER_DOWN		(1 << 9)
72 #define IMX7_TEMPSENSE1_TEMP_VALUE_SHIFT	0
73 #define IMX7_TEMPSENSE1_TEMP_VALUE_MASK		0x1ff
74 
75 /* The driver supports 1 passive trip point and 1 critical trip point */
76 enum imx_thermal_trip {
77 	IMX_TRIP_PASSIVE,
78 	IMX_TRIP_CRITICAL,
79 };
80 
81 #define IMX_POLLING_DELAY		2000 /* millisecond */
82 #define IMX_PASSIVE_DELAY		1000
83 
84 #define TEMPMON_IMX6Q			1
85 #define TEMPMON_IMX6SX			2
86 #define TEMPMON_IMX7D			3
87 
88 struct thermal_soc_data {
89 	u32 version;
90 
91 	u32 sensor_ctrl;
92 	u32 power_down_mask;
93 	u32 measure_temp_mask;
94 
95 	u32 measure_freq_ctrl;
96 	u32 measure_freq_mask;
97 	u32 measure_freq_shift;
98 
99 	u32 temp_data;
100 	u32 temp_value_mask;
101 	u32 temp_value_shift;
102 	u32 temp_valid_mask;
103 
104 	u32 panic_alarm_ctrl;
105 	u32 panic_alarm_mask;
106 	u32 panic_alarm_shift;
107 
108 	u32 high_alarm_ctrl;
109 	u32 high_alarm_mask;
110 	u32 high_alarm_shift;
111 
112 	u32 low_alarm_ctrl;
113 	u32 low_alarm_mask;
114 	u32 low_alarm_shift;
115 };
116 
117 static struct thermal_trip trips[] = {
118 	[IMX_TRIP_PASSIVE]  = { .type = THERMAL_TRIP_PASSIVE  },
119 	[IMX_TRIP_CRITICAL] = { .type = THERMAL_TRIP_CRITICAL },
120 };
121 
122 static struct thermal_soc_data thermal_imx6q_data = {
123 	.version = TEMPMON_IMX6Q,
124 
125 	.sensor_ctrl = IMX6_TEMPSENSE0,
126 	.power_down_mask = IMX6_TEMPSENSE0_POWER_DOWN,
127 	.measure_temp_mask = IMX6_TEMPSENSE0_MEASURE_TEMP,
128 
129 	.measure_freq_ctrl = IMX6_TEMPSENSE1,
130 	.measure_freq_shift = IMX6_TEMPSENSE1_MEASURE_FREQ_SHIFT,
131 	.measure_freq_mask = IMX6_TEMPSENSE1_MEASURE_FREQ,
132 
133 	.temp_data = IMX6_TEMPSENSE0,
134 	.temp_value_mask = IMX6_TEMPSENSE0_TEMP_CNT_MASK,
135 	.temp_value_shift = IMX6_TEMPSENSE0_TEMP_CNT_SHIFT,
136 	.temp_valid_mask = IMX6_TEMPSENSE0_FINISHED,
137 
138 	.high_alarm_ctrl = IMX6_TEMPSENSE0,
139 	.high_alarm_mask = IMX6_TEMPSENSE0_ALARM_VALUE_MASK,
140 	.high_alarm_shift = IMX6_TEMPSENSE0_ALARM_VALUE_SHIFT,
141 };
142 
143 static struct thermal_soc_data thermal_imx6sx_data = {
144 	.version = TEMPMON_IMX6SX,
145 
146 	.sensor_ctrl = IMX6_TEMPSENSE0,
147 	.power_down_mask = IMX6_TEMPSENSE0_POWER_DOWN,
148 	.measure_temp_mask = IMX6_TEMPSENSE0_MEASURE_TEMP,
149 
150 	.measure_freq_ctrl = IMX6_TEMPSENSE1,
151 	.measure_freq_shift = IMX6_TEMPSENSE1_MEASURE_FREQ_SHIFT,
152 	.measure_freq_mask = IMX6_TEMPSENSE1_MEASURE_FREQ,
153 
154 	.temp_data = IMX6_TEMPSENSE0,
155 	.temp_value_mask = IMX6_TEMPSENSE0_TEMP_CNT_MASK,
156 	.temp_value_shift = IMX6_TEMPSENSE0_TEMP_CNT_SHIFT,
157 	.temp_valid_mask = IMX6_TEMPSENSE0_FINISHED,
158 
159 	.high_alarm_ctrl = IMX6_TEMPSENSE0,
160 	.high_alarm_mask = IMX6_TEMPSENSE0_ALARM_VALUE_MASK,
161 	.high_alarm_shift = IMX6_TEMPSENSE0_ALARM_VALUE_SHIFT,
162 
163 	.panic_alarm_ctrl = IMX6_TEMPSENSE2,
164 	.panic_alarm_mask = IMX6_TEMPSENSE2_PANIC_VALUE_MASK,
165 	.panic_alarm_shift = IMX6_TEMPSENSE2_PANIC_VALUE_SHIFT,
166 
167 	.low_alarm_ctrl = IMX6_TEMPSENSE2,
168 	.low_alarm_mask = IMX6_TEMPSENSE2_LOW_VALUE_MASK,
169 	.low_alarm_shift = IMX6_TEMPSENSE2_LOW_VALUE_SHIFT,
170 };
171 
172 static struct thermal_soc_data thermal_imx7d_data = {
173 	.version = TEMPMON_IMX7D,
174 
175 	.sensor_ctrl = IMX7_TEMPSENSE1,
176 	.power_down_mask = IMX7_TEMPSENSE1_POWER_DOWN,
177 	.measure_temp_mask = IMX7_TEMPSENSE1_MEASURE_TEMP,
178 
179 	.measure_freq_ctrl = IMX7_TEMPSENSE1,
180 	.measure_freq_shift = IMX7_TEMPSENSE1_MEASURE_FREQ_SHIFT,
181 	.measure_freq_mask = IMX7_TEMPSENSE1_MEASURE_FREQ_MASK,
182 
183 	.temp_data = IMX7_TEMPSENSE1,
184 	.temp_value_mask = IMX7_TEMPSENSE1_TEMP_VALUE_MASK,
185 	.temp_value_shift = IMX7_TEMPSENSE1_TEMP_VALUE_SHIFT,
186 	.temp_valid_mask = IMX7_TEMPSENSE1_FINISHED,
187 
188 	.panic_alarm_ctrl = IMX7_TEMPSENSE1,
189 	.panic_alarm_mask = IMX7_TEMPSENSE0_PANIC_ALARM_MASK,
190 	.panic_alarm_shift = IMX7_TEMPSENSE0_PANIC_ALARM_SHIFT,
191 
192 	.high_alarm_ctrl = IMX7_TEMPSENSE0,
193 	.high_alarm_mask = IMX7_TEMPSENSE0_HIGH_ALARM_MASK,
194 	.high_alarm_shift = IMX7_TEMPSENSE0_HIGH_ALARM_SHIFT,
195 
196 	.low_alarm_ctrl = IMX7_TEMPSENSE0,
197 	.low_alarm_mask = IMX7_TEMPSENSE0_LOW_ALARM_MASK,
198 	.low_alarm_shift = IMX7_TEMPSENSE0_LOW_ALARM_SHIFT,
199 };
200 
201 struct imx_thermal_data {
202 	struct device *dev;
203 	struct cpufreq_policy *policy;
204 	struct thermal_zone_device *tz;
205 	struct thermal_cooling_device *cdev;
206 	struct regmap *tempmon;
207 	u32 c1, c2; /* See formula in imx_init_calib() */
208 	int temp_max;
209 	int alarm_temp;
210 	int last_temp;
211 	bool irq_enabled;
212 	int irq;
213 	struct clk *thermal_clk;
214 	const struct thermal_soc_data *socdata;
215 	const char *temp_grade;
216 };
217 
218 static void imx_set_panic_temp(struct imx_thermal_data *data,
219 			       int panic_temp)
220 {
221 	const struct thermal_soc_data *soc_data = data->socdata;
222 	struct regmap *map = data->tempmon;
223 	int critical_value;
224 
225 	critical_value = (data->c2 - panic_temp) / data->c1;
226 
227 	regmap_write(map, soc_data->panic_alarm_ctrl + REG_CLR,
228 		     soc_data->panic_alarm_mask);
229 	regmap_write(map, soc_data->panic_alarm_ctrl + REG_SET,
230 		     critical_value << soc_data->panic_alarm_shift);
231 }
232 
233 static void imx_set_alarm_temp(struct imx_thermal_data *data,
234 			       int alarm_temp)
235 {
236 	struct regmap *map = data->tempmon;
237 	const struct thermal_soc_data *soc_data = data->socdata;
238 	int alarm_value;
239 
240 	data->alarm_temp = alarm_temp;
241 
242 	if (data->socdata->version == TEMPMON_IMX7D)
243 		alarm_value = alarm_temp / 1000 + data->c1 - 25;
244 	else
245 		alarm_value = (data->c2 - alarm_temp) / data->c1;
246 
247 	regmap_write(map, soc_data->high_alarm_ctrl + REG_CLR,
248 		     soc_data->high_alarm_mask);
249 	regmap_write(map, soc_data->high_alarm_ctrl + REG_SET,
250 		     alarm_value << soc_data->high_alarm_shift);
251 }
252 
253 static int imx_get_temp(struct thermal_zone_device *tz, int *temp)
254 {
255 	struct imx_thermal_data *data = thermal_zone_device_priv(tz);
256 	const struct thermal_soc_data *soc_data = data->socdata;
257 	struct regmap *map = data->tempmon;
258 	unsigned int n_meas;
259 	u32 val;
260 	int ret;
261 
262 	ret = pm_runtime_resume_and_get(data->dev);
263 	if (ret < 0)
264 		return ret;
265 
266 	regmap_read(map, soc_data->temp_data, &val);
267 
268 	if ((val & soc_data->temp_valid_mask) == 0)
269 		return -EAGAIN;
270 
271 	n_meas = (val & soc_data->temp_value_mask)
272 		>> soc_data->temp_value_shift;
273 
274 	/* See imx_init_calib() for formula derivation */
275 	if (data->socdata->version == TEMPMON_IMX7D)
276 		*temp = (n_meas - data->c1 + 25) * 1000;
277 	else
278 		*temp = data->c2 - n_meas * data->c1;
279 
280 	/* Update alarm value to next higher trip point for TEMPMON_IMX6Q */
281 	if (data->socdata->version == TEMPMON_IMX6Q) {
282 		if (data->alarm_temp == trips[IMX_TRIP_PASSIVE].temperature &&
283 			*temp >= trips[IMX_TRIP_PASSIVE].temperature)
284 			imx_set_alarm_temp(data, trips[IMX_TRIP_CRITICAL].temperature);
285 		if (data->alarm_temp == trips[IMX_TRIP_CRITICAL].temperature &&
286 			*temp < trips[IMX_TRIP_PASSIVE].temperature) {
287 			imx_set_alarm_temp(data, trips[IMX_TRIP_PASSIVE].temperature);
288 			dev_dbg(data->dev, "thermal alarm off: T < %d\n",
289 				data->alarm_temp / 1000);
290 		}
291 	}
292 
293 	if (*temp != data->last_temp) {
294 		dev_dbg(data->dev, "millicelsius: %d\n", *temp);
295 		data->last_temp = *temp;
296 	}
297 
298 	/* Reenable alarm IRQ if temperature below alarm temperature */
299 	if (!data->irq_enabled && *temp < data->alarm_temp) {
300 		data->irq_enabled = true;
301 		enable_irq(data->irq);
302 	}
303 
304 	pm_runtime_put(data->dev);
305 
306 	return 0;
307 }
308 
309 static int imx_change_mode(struct thermal_zone_device *tz,
310 			   enum thermal_device_mode mode)
311 {
312 	struct imx_thermal_data *data = thermal_zone_device_priv(tz);
313 
314 	if (mode == THERMAL_DEVICE_ENABLED) {
315 		pm_runtime_get(data->dev);
316 
317 		if (!data->irq_enabled) {
318 			data->irq_enabled = true;
319 			enable_irq(data->irq);
320 		}
321 	} else {
322 		pm_runtime_put(data->dev);
323 
324 		if (data->irq_enabled) {
325 			disable_irq(data->irq);
326 			data->irq_enabled = false;
327 		}
328 	}
329 
330 	return 0;
331 }
332 
333 static int imx_get_crit_temp(struct thermal_zone_device *tz, int *temp)
334 {
335 	*temp = trips[IMX_TRIP_CRITICAL].temperature;
336 
337 	return 0;
338 }
339 
340 static int imx_set_trip_temp(struct thermal_zone_device *tz, int trip,
341 			     int temp)
342 {
343 	struct imx_thermal_data *data = thermal_zone_device_priv(tz);
344 	int ret;
345 
346 	ret = pm_runtime_resume_and_get(data->dev);
347 	if (ret < 0)
348 		return ret;
349 
350 	/* do not allow changing critical threshold */
351 	if (trip == IMX_TRIP_CRITICAL)
352 		return -EPERM;
353 
354 	/* do not allow passive to be set higher than critical */
355 	if (temp < 0 || temp > trips[IMX_TRIP_CRITICAL].temperature)
356 		return -EINVAL;
357 
358 	trips[IMX_TRIP_PASSIVE].temperature = temp;
359 
360 	imx_set_alarm_temp(data, temp);
361 
362 	pm_runtime_put(data->dev);
363 
364 	return 0;
365 }
366 
367 static int imx_bind(struct thermal_zone_device *tz,
368 		    struct thermal_cooling_device *cdev)
369 {
370 	return thermal_zone_bind_cooling_device(tz, IMX_TRIP_PASSIVE, cdev,
371 						THERMAL_NO_LIMIT,
372 						THERMAL_NO_LIMIT,
373 						THERMAL_WEIGHT_DEFAULT);
374 }
375 
376 static int imx_unbind(struct thermal_zone_device *tz,
377 		      struct thermal_cooling_device *cdev)
378 {
379 	return thermal_zone_unbind_cooling_device(tz, IMX_TRIP_PASSIVE, cdev);
380 }
381 
382 static struct thermal_zone_device_ops imx_tz_ops = {
383 	.bind = imx_bind,
384 	.unbind = imx_unbind,
385 	.get_temp = imx_get_temp,
386 	.change_mode = imx_change_mode,
387 	.get_crit_temp = imx_get_crit_temp,
388 	.set_trip_temp = imx_set_trip_temp,
389 };
390 
391 static int imx_init_calib(struct platform_device *pdev, u32 ocotp_ana1)
392 {
393 	struct imx_thermal_data *data = platform_get_drvdata(pdev);
394 	int n1;
395 	u64 temp64;
396 
397 	if (ocotp_ana1 == 0 || ocotp_ana1 == ~0) {
398 		dev_err(&pdev->dev, "invalid sensor calibration data\n");
399 		return -EINVAL;
400 	}
401 
402 	/*
403 	 * On i.MX7D, we only use the calibration data at 25C to get the temp,
404 	 * Tmeas = ( Nmeas - n1) + 25; n1 is the fuse value for 25C.
405 	 */
406 	if (data->socdata->version == TEMPMON_IMX7D) {
407 		data->c1 = (ocotp_ana1 >> 9) & 0x1ff;
408 		return 0;
409 	}
410 
411 	/*
412 	 * The sensor is calibrated at 25 °C (aka T1) and the value measured
413 	 * (aka N1) at this temperature is provided in bits [31:20] in the
414 	 * i.MX's OCOTP value ANA1.
415 	 * To find the actual temperature T, the following formula has to be used
416 	 * when reading value n from the sensor:
417 	 *
418 	 * T = T1 + (N - N1) / (0.4148468 - 0.0015423 * N1) °C + 3.580661 °C
419 	 *   = [T1' - N1 / (0.4148468 - 0.0015423 * N1) °C] + N / (0.4148468 - 0.0015423 * N1) °C
420 	 *   = [T1' + N1 / (0.0015423 * N1 - 0.4148468) °C] - N / (0.0015423 * N1 - 0.4148468) °C
421 	 *   = c2 - c1 * N
422 	 *
423 	 * with
424 	 *
425 	 *  T1' = 28.580661 °C
426 	 *   c1 = 1 / (0.0015423 * N1 - 0.4297157) °C
427 	 *   c2 = T1' + N1 / (0.0015423 * N1 - 0.4148468) °C
428 	 *      = T1' + N1 * c1
429 	 */
430 	n1 = ocotp_ana1 >> 20;
431 
432 	temp64 = 10000000; /* use 10^7 as fixed point constant for values in formula */
433 	temp64 *= 1000; /* to get result in °mC */
434 	do_div(temp64, 15423 * n1 - 4148468);
435 	data->c1 = temp64;
436 	data->c2 = n1 * data->c1 + 28581;
437 
438 	return 0;
439 }
440 
441 static void imx_init_temp_grade(struct platform_device *pdev, u32 ocotp_mem0)
442 {
443 	struct imx_thermal_data *data = platform_get_drvdata(pdev);
444 
445 	/* The maximum die temp is specified by the Temperature Grade */
446 	switch ((ocotp_mem0 >> 6) & 0x3) {
447 	case 0: /* Commercial (0 to 95 °C) */
448 		data->temp_grade = "Commercial";
449 		data->temp_max = 95000;
450 		break;
451 	case 1: /* Extended Commercial (-20 °C to 105 °C) */
452 		data->temp_grade = "Extended Commercial";
453 		data->temp_max = 105000;
454 		break;
455 	case 2: /* Industrial (-40 °C to 105 °C) */
456 		data->temp_grade = "Industrial";
457 		data->temp_max = 105000;
458 		break;
459 	case 3: /* Automotive (-40 °C to 125 °C) */
460 		data->temp_grade = "Automotive";
461 		data->temp_max = 125000;
462 		break;
463 	}
464 
465 	/*
466 	 * Set the critical trip point at 5 °C under max
467 	 * Set the passive trip point at 10 °C under max (changeable via sysfs)
468 	 */
469 	trips[IMX_TRIP_PASSIVE].temperature = data->temp_max - (1000 * 10);
470 	trips[IMX_TRIP_CRITICAL].temperature = data->temp_max - (1000 * 5);
471 }
472 
473 static int imx_init_from_tempmon_data(struct platform_device *pdev)
474 {
475 	struct regmap *map;
476 	int ret;
477 	u32 val;
478 
479 	map = syscon_regmap_lookup_by_phandle(pdev->dev.of_node,
480 					      "fsl,tempmon-data");
481 	if (IS_ERR(map)) {
482 		ret = PTR_ERR(map);
483 		dev_err(&pdev->dev, "failed to get sensor regmap: %d\n", ret);
484 		return ret;
485 	}
486 
487 	ret = regmap_read(map, OCOTP_ANA1, &val);
488 	if (ret) {
489 		dev_err(&pdev->dev, "failed to read sensor data: %d\n", ret);
490 		return ret;
491 	}
492 	ret = imx_init_calib(pdev, val);
493 	if (ret)
494 		return ret;
495 
496 	ret = regmap_read(map, OCOTP_MEM0, &val);
497 	if (ret) {
498 		dev_err(&pdev->dev, "failed to read sensor data: %d\n", ret);
499 		return ret;
500 	}
501 	imx_init_temp_grade(pdev, val);
502 
503 	return 0;
504 }
505 
506 static int imx_init_from_nvmem_cells(struct platform_device *pdev)
507 {
508 	int ret;
509 	u32 val;
510 
511 	ret = nvmem_cell_read_u32(&pdev->dev, "calib", &val);
512 	if (ret)
513 		return ret;
514 
515 	ret = imx_init_calib(pdev, val);
516 	if (ret)
517 		return ret;
518 
519 	ret = nvmem_cell_read_u32(&pdev->dev, "temp_grade", &val);
520 	if (ret)
521 		return ret;
522 	imx_init_temp_grade(pdev, val);
523 
524 	return 0;
525 }
526 
527 static irqreturn_t imx_thermal_alarm_irq(int irq, void *dev)
528 {
529 	struct imx_thermal_data *data = dev;
530 
531 	disable_irq_nosync(irq);
532 	data->irq_enabled = false;
533 
534 	return IRQ_WAKE_THREAD;
535 }
536 
537 static irqreturn_t imx_thermal_alarm_irq_thread(int irq, void *dev)
538 {
539 	struct imx_thermal_data *data = dev;
540 
541 	dev_dbg(data->dev, "THERMAL ALARM: T > %d\n", data->alarm_temp / 1000);
542 
543 	thermal_zone_device_update(data->tz, THERMAL_EVENT_UNSPECIFIED);
544 
545 	return IRQ_HANDLED;
546 }
547 
548 static const struct of_device_id of_imx_thermal_match[] = {
549 	{ .compatible = "fsl,imx6q-tempmon", .data = &thermal_imx6q_data, },
550 	{ .compatible = "fsl,imx6sx-tempmon", .data = &thermal_imx6sx_data, },
551 	{ .compatible = "fsl,imx7d-tempmon", .data = &thermal_imx7d_data, },
552 	{ /* end */ }
553 };
554 MODULE_DEVICE_TABLE(of, of_imx_thermal_match);
555 
556 #ifdef CONFIG_CPU_FREQ
557 /*
558  * Create cooling device in case no #cooling-cells property is available in
559  * CPU node
560  */
561 static int imx_thermal_register_legacy_cooling(struct imx_thermal_data *data)
562 {
563 	struct device_node *np;
564 	int ret = 0;
565 
566 	data->policy = cpufreq_cpu_get(0);
567 	if (!data->policy) {
568 		pr_debug("%s: CPUFreq policy not found\n", __func__);
569 		return -EPROBE_DEFER;
570 	}
571 
572 	np = of_get_cpu_node(data->policy->cpu, NULL);
573 
574 	if (!np || !of_find_property(np, "#cooling-cells", NULL)) {
575 		data->cdev = cpufreq_cooling_register(data->policy);
576 		if (IS_ERR(data->cdev)) {
577 			ret = PTR_ERR(data->cdev);
578 			cpufreq_cpu_put(data->policy);
579 		}
580 	}
581 
582 	of_node_put(np);
583 
584 	return ret;
585 }
586 
587 static void imx_thermal_unregister_legacy_cooling(struct imx_thermal_data *data)
588 {
589 	cpufreq_cooling_unregister(data->cdev);
590 	cpufreq_cpu_put(data->policy);
591 }
592 
593 #else
594 
595 static inline int imx_thermal_register_legacy_cooling(struct imx_thermal_data *data)
596 {
597 	return 0;
598 }
599 
600 static inline void imx_thermal_unregister_legacy_cooling(struct imx_thermal_data *data)
601 {
602 }
603 #endif
604 
605 static int imx_thermal_probe(struct platform_device *pdev)
606 {
607 	struct imx_thermal_data *data;
608 	struct regmap *map;
609 	int measure_freq;
610 	int ret;
611 
612 	data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
613 	if (!data)
614 		return -ENOMEM;
615 
616 	data->dev = &pdev->dev;
617 
618 	map = syscon_regmap_lookup_by_phandle(pdev->dev.of_node, "fsl,tempmon");
619 	if (IS_ERR(map)) {
620 		ret = PTR_ERR(map);
621 		dev_err(&pdev->dev, "failed to get tempmon regmap: %d\n", ret);
622 		return ret;
623 	}
624 	data->tempmon = map;
625 
626 	data->socdata = of_device_get_match_data(&pdev->dev);
627 	if (!data->socdata) {
628 		dev_err(&pdev->dev, "no device match found\n");
629 		return -ENODEV;
630 	}
631 
632 	/* make sure the IRQ flag is clear before enabling irq on i.MX6SX */
633 	if (data->socdata->version == TEMPMON_IMX6SX) {
634 		regmap_write(map, IMX6_MISC1 + REG_CLR,
635 			IMX6_MISC1_IRQ_TEMPHIGH | IMX6_MISC1_IRQ_TEMPLOW
636 			| IMX6_MISC1_IRQ_TEMPPANIC);
637 		/*
638 		 * reset value of LOW ALARM is incorrect, set it to lowest
639 		 * value to avoid false trigger of low alarm.
640 		 */
641 		regmap_write(map, data->socdata->low_alarm_ctrl + REG_SET,
642 			     data->socdata->low_alarm_mask);
643 	}
644 
645 	data->irq = platform_get_irq(pdev, 0);
646 	if (data->irq < 0)
647 		return data->irq;
648 
649 	platform_set_drvdata(pdev, data);
650 
651 	if (of_find_property(pdev->dev.of_node, "nvmem-cells", NULL)) {
652 		ret = imx_init_from_nvmem_cells(pdev);
653 		if (ret)
654 			return dev_err_probe(&pdev->dev, ret,
655 					     "failed to init from nvmem\n");
656 	} else {
657 		ret = imx_init_from_tempmon_data(pdev);
658 		if (ret) {
659 			dev_err(&pdev->dev, "failed to init from fsl,tempmon-data\n");
660 			return ret;
661 		}
662 	}
663 
664 	/* Make sure sensor is in known good state for measurements */
665 	regmap_write(map, data->socdata->sensor_ctrl + REG_CLR,
666 		     data->socdata->power_down_mask);
667 	regmap_write(map, data->socdata->sensor_ctrl + REG_CLR,
668 		     data->socdata->measure_temp_mask);
669 	regmap_write(map, data->socdata->measure_freq_ctrl + REG_CLR,
670 		     data->socdata->measure_freq_mask);
671 	if (data->socdata->version != TEMPMON_IMX7D)
672 		regmap_write(map, IMX6_MISC0 + REG_SET,
673 			IMX6_MISC0_REFTOP_SELBIASOFF);
674 	regmap_write(map, data->socdata->sensor_ctrl + REG_SET,
675 		     data->socdata->power_down_mask);
676 
677 	ret = imx_thermal_register_legacy_cooling(data);
678 	if (ret)
679 		return dev_err_probe(&pdev->dev, ret,
680 				     "failed to register cpufreq cooling device\n");
681 
682 	data->thermal_clk = devm_clk_get(&pdev->dev, NULL);
683 	if (IS_ERR(data->thermal_clk)) {
684 		ret = PTR_ERR(data->thermal_clk);
685 		if (ret != -EPROBE_DEFER)
686 			dev_err(&pdev->dev,
687 				"failed to get thermal clk: %d\n", ret);
688 		goto legacy_cleanup;
689 	}
690 
691 	/*
692 	 * Thermal sensor needs clk on to get correct value, normally
693 	 * we should enable its clk before taking measurement and disable
694 	 * clk after measurement is done, but if alarm function is enabled,
695 	 * hardware will auto measure the temperature periodically, so we
696 	 * need to keep the clk always on for alarm function.
697 	 */
698 	ret = clk_prepare_enable(data->thermal_clk);
699 	if (ret) {
700 		dev_err(&pdev->dev, "failed to enable thermal clk: %d\n", ret);
701 		goto legacy_cleanup;
702 	}
703 
704 	data->tz = thermal_zone_device_register_with_trips("imx_thermal_zone",
705 							   trips,
706 							   ARRAY_SIZE(trips),
707 							   BIT(IMX_TRIP_PASSIVE), data,
708 							   &imx_tz_ops, NULL,
709 							   IMX_PASSIVE_DELAY,
710 							   IMX_POLLING_DELAY);
711 	if (IS_ERR(data->tz)) {
712 		ret = PTR_ERR(data->tz);
713 		dev_err(&pdev->dev,
714 			"failed to register thermal zone device %d\n", ret);
715 		goto clk_disable;
716 	}
717 
718 	dev_info(&pdev->dev, "%s CPU temperature grade - max:%dC"
719 		 " critical:%dC passive:%dC\n", data->temp_grade,
720 		 data->temp_max / 1000, trips[IMX_TRIP_CRITICAL].temperature / 1000,
721 		 trips[IMX_TRIP_PASSIVE].temperature / 1000);
722 
723 	/* Enable measurements at ~ 10 Hz */
724 	regmap_write(map, data->socdata->measure_freq_ctrl + REG_CLR,
725 		     data->socdata->measure_freq_mask);
726 	measure_freq = DIV_ROUND_UP(32768, 10); /* 10 Hz */
727 	regmap_write(map, data->socdata->measure_freq_ctrl + REG_SET,
728 		     measure_freq << data->socdata->measure_freq_shift);
729 	imx_set_alarm_temp(data, trips[IMX_TRIP_PASSIVE].temperature);
730 
731 	if (data->socdata->version == TEMPMON_IMX6SX)
732 		imx_set_panic_temp(data, trips[IMX_TRIP_CRITICAL].temperature);
733 
734 	regmap_write(map, data->socdata->sensor_ctrl + REG_CLR,
735 		     data->socdata->power_down_mask);
736 	regmap_write(map, data->socdata->sensor_ctrl + REG_SET,
737 		     data->socdata->measure_temp_mask);
738 	/* After power up, we need a delay before first access can be done. */
739 	usleep_range(20, 50);
740 
741 	/* the core was configured and enabled just before */
742 	pm_runtime_set_active(&pdev->dev);
743 	pm_runtime_enable(data->dev);
744 
745 	ret = pm_runtime_resume_and_get(data->dev);
746 	if (ret < 0)
747 		goto disable_runtime_pm;
748 
749 	data->irq_enabled = true;
750 	ret = thermal_zone_device_enable(data->tz);
751 	if (ret)
752 		goto thermal_zone_unregister;
753 
754 	ret = devm_request_threaded_irq(&pdev->dev, data->irq,
755 			imx_thermal_alarm_irq, imx_thermal_alarm_irq_thread,
756 			0, "imx_thermal", data);
757 	if (ret < 0) {
758 		dev_err(&pdev->dev, "failed to request alarm irq: %d\n", ret);
759 		goto thermal_zone_unregister;
760 	}
761 
762 	pm_runtime_put(data->dev);
763 
764 	return 0;
765 
766 thermal_zone_unregister:
767 	thermal_zone_device_unregister(data->tz);
768 disable_runtime_pm:
769 	pm_runtime_put_noidle(data->dev);
770 	pm_runtime_disable(data->dev);
771 clk_disable:
772 	clk_disable_unprepare(data->thermal_clk);
773 legacy_cleanup:
774 	imx_thermal_unregister_legacy_cooling(data);
775 
776 	return ret;
777 }
778 
779 static int imx_thermal_remove(struct platform_device *pdev)
780 {
781 	struct imx_thermal_data *data = platform_get_drvdata(pdev);
782 
783 	pm_runtime_put_noidle(data->dev);
784 	pm_runtime_disable(data->dev);
785 
786 	thermal_zone_device_unregister(data->tz);
787 	imx_thermal_unregister_legacy_cooling(data);
788 
789 	return 0;
790 }
791 
792 static int __maybe_unused imx_thermal_suspend(struct device *dev)
793 {
794 	struct imx_thermal_data *data = dev_get_drvdata(dev);
795 	int ret;
796 
797 	/*
798 	 * Need to disable thermal sensor, otherwise, when thermal core
799 	 * try to get temperature before thermal sensor resume, a wrong
800 	 * temperature will be read as the thermal sensor is powered
801 	 * down. This is done in change_mode() operation called from
802 	 * thermal_zone_device_disable()
803 	 */
804 	ret = thermal_zone_device_disable(data->tz);
805 	if (ret)
806 		return ret;
807 
808 	return pm_runtime_force_suspend(data->dev);
809 }
810 
811 static int __maybe_unused imx_thermal_resume(struct device *dev)
812 {
813 	struct imx_thermal_data *data = dev_get_drvdata(dev);
814 	int ret;
815 
816 	ret = pm_runtime_force_resume(data->dev);
817 	if (ret)
818 		return ret;
819 	/* Enabled thermal sensor after resume */
820 	return thermal_zone_device_enable(data->tz);
821 }
822 
823 static int __maybe_unused imx_thermal_runtime_suspend(struct device *dev)
824 {
825 	struct imx_thermal_data *data = dev_get_drvdata(dev);
826 	const struct thermal_soc_data *socdata = data->socdata;
827 	struct regmap *map = data->tempmon;
828 	int ret;
829 
830 	ret = regmap_write(map, socdata->sensor_ctrl + REG_CLR,
831 			   socdata->measure_temp_mask);
832 	if (ret)
833 		return ret;
834 
835 	ret = regmap_write(map, socdata->sensor_ctrl + REG_SET,
836 			   socdata->power_down_mask);
837 	if (ret)
838 		return ret;
839 
840 	clk_disable_unprepare(data->thermal_clk);
841 
842 	return 0;
843 }
844 
845 static int __maybe_unused imx_thermal_runtime_resume(struct device *dev)
846 {
847 	struct imx_thermal_data *data = dev_get_drvdata(dev);
848 	const struct thermal_soc_data *socdata = data->socdata;
849 	struct regmap *map = data->tempmon;
850 	int ret;
851 
852 	ret = clk_prepare_enable(data->thermal_clk);
853 	if (ret)
854 		return ret;
855 
856 	ret = regmap_write(map, socdata->sensor_ctrl + REG_CLR,
857 			   socdata->power_down_mask);
858 	if (ret)
859 		return ret;
860 
861 	ret = regmap_write(map, socdata->sensor_ctrl + REG_SET,
862 			   socdata->measure_temp_mask);
863 	if (ret)
864 		return ret;
865 
866 	/*
867 	 * According to the temp sensor designers, it may require up to ~17us
868 	 * to complete a measurement.
869 	 */
870 	usleep_range(20, 50);
871 
872 	return 0;
873 }
874 
875 static const struct dev_pm_ops imx_thermal_pm_ops = {
876 	SET_SYSTEM_SLEEP_PM_OPS(imx_thermal_suspend, imx_thermal_resume)
877 	SET_RUNTIME_PM_OPS(imx_thermal_runtime_suspend,
878 			   imx_thermal_runtime_resume, NULL)
879 };
880 
881 static struct platform_driver imx_thermal = {
882 	.driver = {
883 		.name	= "imx_thermal",
884 		.pm	= &imx_thermal_pm_ops,
885 		.of_match_table = of_imx_thermal_match,
886 	},
887 	.probe		= imx_thermal_probe,
888 	.remove		= imx_thermal_remove,
889 };
890 module_platform_driver(imx_thermal);
891 
892 MODULE_AUTHOR("Freescale Semiconductor, Inc.");
893 MODULE_DESCRIPTION("Thermal driver for Freescale i.MX SoCs");
894 MODULE_LICENSE("GPL v2");
895 MODULE_ALIAS("platform:imx-thermal");
896