xref: /openbmc/linux/drivers/thermal/imx_thermal.c (revision 53c9ce497dd79fb567214452f4cea5bb4c541b5e)
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_set_trip_temp(struct thermal_zone_device *tz, int trip,
334 			     int temp)
335 {
336 	struct imx_thermal_data *data = thermal_zone_device_priv(tz);
337 	int ret;
338 
339 	ret = pm_runtime_resume_and_get(data->dev);
340 	if (ret < 0)
341 		return ret;
342 
343 	/* do not allow changing critical threshold */
344 	if (trip == IMX_TRIP_CRITICAL)
345 		return -EPERM;
346 
347 	/* do not allow passive to be set higher than critical */
348 	if (temp < 0 || temp > trips[IMX_TRIP_CRITICAL].temperature)
349 		return -EINVAL;
350 
351 	trips[IMX_TRIP_PASSIVE].temperature = temp;
352 
353 	imx_set_alarm_temp(data, temp);
354 
355 	pm_runtime_put(data->dev);
356 
357 	return 0;
358 }
359 
360 static int imx_bind(struct thermal_zone_device *tz,
361 		    struct thermal_cooling_device *cdev)
362 {
363 	return thermal_zone_bind_cooling_device(tz, IMX_TRIP_PASSIVE, cdev,
364 						THERMAL_NO_LIMIT,
365 						THERMAL_NO_LIMIT,
366 						THERMAL_WEIGHT_DEFAULT);
367 }
368 
369 static int imx_unbind(struct thermal_zone_device *tz,
370 		      struct thermal_cooling_device *cdev)
371 {
372 	return thermal_zone_unbind_cooling_device(tz, IMX_TRIP_PASSIVE, cdev);
373 }
374 
375 static struct thermal_zone_device_ops imx_tz_ops = {
376 	.bind = imx_bind,
377 	.unbind = imx_unbind,
378 	.get_temp = imx_get_temp,
379 	.change_mode = imx_change_mode,
380 	.set_trip_temp = imx_set_trip_temp,
381 };
382 
383 static int imx_init_calib(struct platform_device *pdev, u32 ocotp_ana1)
384 {
385 	struct imx_thermal_data *data = platform_get_drvdata(pdev);
386 	int n1;
387 	u64 temp64;
388 
389 	if (ocotp_ana1 == 0 || ocotp_ana1 == ~0) {
390 		dev_err(&pdev->dev, "invalid sensor calibration data\n");
391 		return -EINVAL;
392 	}
393 
394 	/*
395 	 * On i.MX7D, we only use the calibration data at 25C to get the temp,
396 	 * Tmeas = ( Nmeas - n1) + 25; n1 is the fuse value for 25C.
397 	 */
398 	if (data->socdata->version == TEMPMON_IMX7D) {
399 		data->c1 = (ocotp_ana1 >> 9) & 0x1ff;
400 		return 0;
401 	}
402 
403 	/*
404 	 * The sensor is calibrated at 25 °C (aka T1) and the value measured
405 	 * (aka N1) at this temperature is provided in bits [31:20] in the
406 	 * i.MX's OCOTP value ANA1.
407 	 * To find the actual temperature T, the following formula has to be used
408 	 * when reading value n from the sensor:
409 	 *
410 	 * T = T1 + (N - N1) / (0.4148468 - 0.0015423 * N1) °C + 3.580661 °C
411 	 *   = [T1' - N1 / (0.4148468 - 0.0015423 * N1) °C] + N / (0.4148468 - 0.0015423 * N1) °C
412 	 *   = [T1' + N1 / (0.0015423 * N1 - 0.4148468) °C] - N / (0.0015423 * N1 - 0.4148468) °C
413 	 *   = c2 - c1 * N
414 	 *
415 	 * with
416 	 *
417 	 *  T1' = 28.580661 °C
418 	 *   c1 = 1 / (0.0015423 * N1 - 0.4297157) °C
419 	 *   c2 = T1' + N1 / (0.0015423 * N1 - 0.4148468) °C
420 	 *      = T1' + N1 * c1
421 	 */
422 	n1 = ocotp_ana1 >> 20;
423 
424 	temp64 = 10000000; /* use 10^7 as fixed point constant for values in formula */
425 	temp64 *= 1000; /* to get result in °mC */
426 	do_div(temp64, 15423 * n1 - 4148468);
427 	data->c1 = temp64;
428 	data->c2 = n1 * data->c1 + 28581;
429 
430 	return 0;
431 }
432 
433 static void imx_init_temp_grade(struct platform_device *pdev, u32 ocotp_mem0)
434 {
435 	struct imx_thermal_data *data = platform_get_drvdata(pdev);
436 
437 	/* The maximum die temp is specified by the Temperature Grade */
438 	switch ((ocotp_mem0 >> 6) & 0x3) {
439 	case 0: /* Commercial (0 to 95 °C) */
440 		data->temp_grade = "Commercial";
441 		data->temp_max = 95000;
442 		break;
443 	case 1: /* Extended Commercial (-20 °C to 105 °C) */
444 		data->temp_grade = "Extended Commercial";
445 		data->temp_max = 105000;
446 		break;
447 	case 2: /* Industrial (-40 °C to 105 °C) */
448 		data->temp_grade = "Industrial";
449 		data->temp_max = 105000;
450 		break;
451 	case 3: /* Automotive (-40 °C to 125 °C) */
452 		data->temp_grade = "Automotive";
453 		data->temp_max = 125000;
454 		break;
455 	}
456 
457 	/*
458 	 * Set the critical trip point at 5 °C under max
459 	 * Set the passive trip point at 10 °C under max (changeable via sysfs)
460 	 */
461 	trips[IMX_TRIP_PASSIVE].temperature = data->temp_max - (1000 * 10);
462 	trips[IMX_TRIP_CRITICAL].temperature = data->temp_max - (1000 * 5);
463 }
464 
465 static int imx_init_from_tempmon_data(struct platform_device *pdev)
466 {
467 	struct regmap *map;
468 	int ret;
469 	u32 val;
470 
471 	map = syscon_regmap_lookup_by_phandle(pdev->dev.of_node,
472 					      "fsl,tempmon-data");
473 	if (IS_ERR(map)) {
474 		ret = PTR_ERR(map);
475 		dev_err(&pdev->dev, "failed to get sensor regmap: %d\n", ret);
476 		return ret;
477 	}
478 
479 	ret = regmap_read(map, OCOTP_ANA1, &val);
480 	if (ret) {
481 		dev_err(&pdev->dev, "failed to read sensor data: %d\n", ret);
482 		return ret;
483 	}
484 	ret = imx_init_calib(pdev, val);
485 	if (ret)
486 		return ret;
487 
488 	ret = regmap_read(map, OCOTP_MEM0, &val);
489 	if (ret) {
490 		dev_err(&pdev->dev, "failed to read sensor data: %d\n", ret);
491 		return ret;
492 	}
493 	imx_init_temp_grade(pdev, val);
494 
495 	return 0;
496 }
497 
498 static int imx_init_from_nvmem_cells(struct platform_device *pdev)
499 {
500 	int ret;
501 	u32 val;
502 
503 	ret = nvmem_cell_read_u32(&pdev->dev, "calib", &val);
504 	if (ret)
505 		return ret;
506 
507 	ret = imx_init_calib(pdev, val);
508 	if (ret)
509 		return ret;
510 
511 	ret = nvmem_cell_read_u32(&pdev->dev, "temp_grade", &val);
512 	if (ret)
513 		return ret;
514 	imx_init_temp_grade(pdev, val);
515 
516 	return 0;
517 }
518 
519 static irqreturn_t imx_thermal_alarm_irq(int irq, void *dev)
520 {
521 	struct imx_thermal_data *data = dev;
522 
523 	disable_irq_nosync(irq);
524 	data->irq_enabled = false;
525 
526 	return IRQ_WAKE_THREAD;
527 }
528 
529 static irqreturn_t imx_thermal_alarm_irq_thread(int irq, void *dev)
530 {
531 	struct imx_thermal_data *data = dev;
532 
533 	dev_dbg(data->dev, "THERMAL ALARM: T > %d\n", data->alarm_temp / 1000);
534 
535 	thermal_zone_device_update(data->tz, THERMAL_EVENT_UNSPECIFIED);
536 
537 	return IRQ_HANDLED;
538 }
539 
540 static const struct of_device_id of_imx_thermal_match[] = {
541 	{ .compatible = "fsl,imx6q-tempmon", .data = &thermal_imx6q_data, },
542 	{ .compatible = "fsl,imx6sx-tempmon", .data = &thermal_imx6sx_data, },
543 	{ .compatible = "fsl,imx7d-tempmon", .data = &thermal_imx7d_data, },
544 	{ /* end */ }
545 };
546 MODULE_DEVICE_TABLE(of, of_imx_thermal_match);
547 
548 #ifdef CONFIG_CPU_FREQ
549 /*
550  * Create cooling device in case no #cooling-cells property is available in
551  * CPU node
552  */
553 static int imx_thermal_register_legacy_cooling(struct imx_thermal_data *data)
554 {
555 	struct device_node *np;
556 	int ret = 0;
557 
558 	data->policy = cpufreq_cpu_get(0);
559 	if (!data->policy) {
560 		pr_debug("%s: CPUFreq policy not found\n", __func__);
561 		return -EPROBE_DEFER;
562 	}
563 
564 	np = of_get_cpu_node(data->policy->cpu, NULL);
565 
566 	if (!np || !of_find_property(np, "#cooling-cells", NULL)) {
567 		data->cdev = cpufreq_cooling_register(data->policy);
568 		if (IS_ERR(data->cdev)) {
569 			ret = PTR_ERR(data->cdev);
570 			cpufreq_cpu_put(data->policy);
571 		}
572 	}
573 
574 	of_node_put(np);
575 
576 	return ret;
577 }
578 
579 static void imx_thermal_unregister_legacy_cooling(struct imx_thermal_data *data)
580 {
581 	cpufreq_cooling_unregister(data->cdev);
582 	cpufreq_cpu_put(data->policy);
583 }
584 
585 #else
586 
587 static inline int imx_thermal_register_legacy_cooling(struct imx_thermal_data *data)
588 {
589 	return 0;
590 }
591 
592 static inline void imx_thermal_unregister_legacy_cooling(struct imx_thermal_data *data)
593 {
594 }
595 #endif
596 
597 static int imx_thermal_probe(struct platform_device *pdev)
598 {
599 	struct imx_thermal_data *data;
600 	struct regmap *map;
601 	int measure_freq;
602 	int ret;
603 
604 	data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
605 	if (!data)
606 		return -ENOMEM;
607 
608 	data->dev = &pdev->dev;
609 
610 	map = syscon_regmap_lookup_by_phandle(pdev->dev.of_node, "fsl,tempmon");
611 	if (IS_ERR(map)) {
612 		ret = PTR_ERR(map);
613 		dev_err(&pdev->dev, "failed to get tempmon regmap: %d\n", ret);
614 		return ret;
615 	}
616 	data->tempmon = map;
617 
618 	data->socdata = of_device_get_match_data(&pdev->dev);
619 	if (!data->socdata) {
620 		dev_err(&pdev->dev, "no device match found\n");
621 		return -ENODEV;
622 	}
623 
624 	/* make sure the IRQ flag is clear before enabling irq on i.MX6SX */
625 	if (data->socdata->version == TEMPMON_IMX6SX) {
626 		regmap_write(map, IMX6_MISC1 + REG_CLR,
627 			IMX6_MISC1_IRQ_TEMPHIGH | IMX6_MISC1_IRQ_TEMPLOW
628 			| IMX6_MISC1_IRQ_TEMPPANIC);
629 		/*
630 		 * reset value of LOW ALARM is incorrect, set it to lowest
631 		 * value to avoid false trigger of low alarm.
632 		 */
633 		regmap_write(map, data->socdata->low_alarm_ctrl + REG_SET,
634 			     data->socdata->low_alarm_mask);
635 	}
636 
637 	data->irq = platform_get_irq(pdev, 0);
638 	if (data->irq < 0)
639 		return data->irq;
640 
641 	platform_set_drvdata(pdev, data);
642 
643 	if (of_find_property(pdev->dev.of_node, "nvmem-cells", NULL)) {
644 		ret = imx_init_from_nvmem_cells(pdev);
645 		if (ret)
646 			return dev_err_probe(&pdev->dev, ret,
647 					     "failed to init from nvmem\n");
648 	} else {
649 		ret = imx_init_from_tempmon_data(pdev);
650 		if (ret) {
651 			dev_err(&pdev->dev, "failed to init from fsl,tempmon-data\n");
652 			return ret;
653 		}
654 	}
655 
656 	/* Make sure sensor is in known good state for measurements */
657 	regmap_write(map, data->socdata->sensor_ctrl + REG_CLR,
658 		     data->socdata->power_down_mask);
659 	regmap_write(map, data->socdata->sensor_ctrl + REG_CLR,
660 		     data->socdata->measure_temp_mask);
661 	regmap_write(map, data->socdata->measure_freq_ctrl + REG_CLR,
662 		     data->socdata->measure_freq_mask);
663 	if (data->socdata->version != TEMPMON_IMX7D)
664 		regmap_write(map, IMX6_MISC0 + REG_SET,
665 			IMX6_MISC0_REFTOP_SELBIASOFF);
666 	regmap_write(map, data->socdata->sensor_ctrl + REG_SET,
667 		     data->socdata->power_down_mask);
668 
669 	ret = imx_thermal_register_legacy_cooling(data);
670 	if (ret)
671 		return dev_err_probe(&pdev->dev, ret,
672 				     "failed to register cpufreq cooling device\n");
673 
674 	data->thermal_clk = devm_clk_get(&pdev->dev, NULL);
675 	if (IS_ERR(data->thermal_clk)) {
676 		ret = PTR_ERR(data->thermal_clk);
677 		if (ret != -EPROBE_DEFER)
678 			dev_err(&pdev->dev,
679 				"failed to get thermal clk: %d\n", ret);
680 		goto legacy_cleanup;
681 	}
682 
683 	/*
684 	 * Thermal sensor needs clk on to get correct value, normally
685 	 * we should enable its clk before taking measurement and disable
686 	 * clk after measurement is done, but if alarm function is enabled,
687 	 * hardware will auto measure the temperature periodically, so we
688 	 * need to keep the clk always on for alarm function.
689 	 */
690 	ret = clk_prepare_enable(data->thermal_clk);
691 	if (ret) {
692 		dev_err(&pdev->dev, "failed to enable thermal clk: %d\n", ret);
693 		goto legacy_cleanup;
694 	}
695 
696 	data->tz = thermal_zone_device_register_with_trips("imx_thermal_zone",
697 							   trips,
698 							   ARRAY_SIZE(trips),
699 							   BIT(IMX_TRIP_PASSIVE), data,
700 							   &imx_tz_ops, NULL,
701 							   IMX_PASSIVE_DELAY,
702 							   IMX_POLLING_DELAY);
703 	if (IS_ERR(data->tz)) {
704 		ret = PTR_ERR(data->tz);
705 		dev_err(&pdev->dev,
706 			"failed to register thermal zone device %d\n", ret);
707 		goto clk_disable;
708 	}
709 
710 	dev_info(&pdev->dev, "%s CPU temperature grade - max:%dC"
711 		 " critical:%dC passive:%dC\n", data->temp_grade,
712 		 data->temp_max / 1000, trips[IMX_TRIP_CRITICAL].temperature / 1000,
713 		 trips[IMX_TRIP_PASSIVE].temperature / 1000);
714 
715 	/* Enable measurements at ~ 10 Hz */
716 	regmap_write(map, data->socdata->measure_freq_ctrl + REG_CLR,
717 		     data->socdata->measure_freq_mask);
718 	measure_freq = DIV_ROUND_UP(32768, 10); /* 10 Hz */
719 	regmap_write(map, data->socdata->measure_freq_ctrl + REG_SET,
720 		     measure_freq << data->socdata->measure_freq_shift);
721 	imx_set_alarm_temp(data, trips[IMX_TRIP_PASSIVE].temperature);
722 
723 	if (data->socdata->version == TEMPMON_IMX6SX)
724 		imx_set_panic_temp(data, trips[IMX_TRIP_CRITICAL].temperature);
725 
726 	regmap_write(map, data->socdata->sensor_ctrl + REG_CLR,
727 		     data->socdata->power_down_mask);
728 	regmap_write(map, data->socdata->sensor_ctrl + REG_SET,
729 		     data->socdata->measure_temp_mask);
730 	/* After power up, we need a delay before first access can be done. */
731 	usleep_range(20, 50);
732 
733 	/* the core was configured and enabled just before */
734 	pm_runtime_set_active(&pdev->dev);
735 	pm_runtime_enable(data->dev);
736 
737 	ret = pm_runtime_resume_and_get(data->dev);
738 	if (ret < 0)
739 		goto disable_runtime_pm;
740 
741 	data->irq_enabled = true;
742 	ret = thermal_zone_device_enable(data->tz);
743 	if (ret)
744 		goto thermal_zone_unregister;
745 
746 	ret = devm_request_threaded_irq(&pdev->dev, data->irq,
747 			imx_thermal_alarm_irq, imx_thermal_alarm_irq_thread,
748 			0, "imx_thermal", data);
749 	if (ret < 0) {
750 		dev_err(&pdev->dev, "failed to request alarm irq: %d\n", ret);
751 		goto thermal_zone_unregister;
752 	}
753 
754 	pm_runtime_put(data->dev);
755 
756 	return 0;
757 
758 thermal_zone_unregister:
759 	thermal_zone_device_unregister(data->tz);
760 disable_runtime_pm:
761 	pm_runtime_put_noidle(data->dev);
762 	pm_runtime_disable(data->dev);
763 clk_disable:
764 	clk_disable_unprepare(data->thermal_clk);
765 legacy_cleanup:
766 	imx_thermal_unregister_legacy_cooling(data);
767 
768 	return ret;
769 }
770 
771 static int imx_thermal_remove(struct platform_device *pdev)
772 {
773 	struct imx_thermal_data *data = platform_get_drvdata(pdev);
774 
775 	pm_runtime_put_noidle(data->dev);
776 	pm_runtime_disable(data->dev);
777 
778 	thermal_zone_device_unregister(data->tz);
779 	imx_thermal_unregister_legacy_cooling(data);
780 
781 	return 0;
782 }
783 
784 static int __maybe_unused imx_thermal_suspend(struct device *dev)
785 {
786 	struct imx_thermal_data *data = dev_get_drvdata(dev);
787 	int ret;
788 
789 	/*
790 	 * Need to disable thermal sensor, otherwise, when thermal core
791 	 * try to get temperature before thermal sensor resume, a wrong
792 	 * temperature will be read as the thermal sensor is powered
793 	 * down. This is done in change_mode() operation called from
794 	 * thermal_zone_device_disable()
795 	 */
796 	ret = thermal_zone_device_disable(data->tz);
797 	if (ret)
798 		return ret;
799 
800 	return pm_runtime_force_suspend(data->dev);
801 }
802 
803 static int __maybe_unused imx_thermal_resume(struct device *dev)
804 {
805 	struct imx_thermal_data *data = dev_get_drvdata(dev);
806 	int ret;
807 
808 	ret = pm_runtime_force_resume(data->dev);
809 	if (ret)
810 		return ret;
811 	/* Enabled thermal sensor after resume */
812 	return thermal_zone_device_enable(data->tz);
813 }
814 
815 static int __maybe_unused imx_thermal_runtime_suspend(struct device *dev)
816 {
817 	struct imx_thermal_data *data = dev_get_drvdata(dev);
818 	const struct thermal_soc_data *socdata = data->socdata;
819 	struct regmap *map = data->tempmon;
820 	int ret;
821 
822 	ret = regmap_write(map, socdata->sensor_ctrl + REG_CLR,
823 			   socdata->measure_temp_mask);
824 	if (ret)
825 		return ret;
826 
827 	ret = regmap_write(map, socdata->sensor_ctrl + REG_SET,
828 			   socdata->power_down_mask);
829 	if (ret)
830 		return ret;
831 
832 	clk_disable_unprepare(data->thermal_clk);
833 
834 	return 0;
835 }
836 
837 static int __maybe_unused imx_thermal_runtime_resume(struct device *dev)
838 {
839 	struct imx_thermal_data *data = dev_get_drvdata(dev);
840 	const struct thermal_soc_data *socdata = data->socdata;
841 	struct regmap *map = data->tempmon;
842 	int ret;
843 
844 	ret = clk_prepare_enable(data->thermal_clk);
845 	if (ret)
846 		return ret;
847 
848 	ret = regmap_write(map, socdata->sensor_ctrl + REG_CLR,
849 			   socdata->power_down_mask);
850 	if (ret)
851 		return ret;
852 
853 	ret = regmap_write(map, socdata->sensor_ctrl + REG_SET,
854 			   socdata->measure_temp_mask);
855 	if (ret)
856 		return ret;
857 
858 	/*
859 	 * According to the temp sensor designers, it may require up to ~17us
860 	 * to complete a measurement.
861 	 */
862 	usleep_range(20, 50);
863 
864 	return 0;
865 }
866 
867 static const struct dev_pm_ops imx_thermal_pm_ops = {
868 	SET_SYSTEM_SLEEP_PM_OPS(imx_thermal_suspend, imx_thermal_resume)
869 	SET_RUNTIME_PM_OPS(imx_thermal_runtime_suspend,
870 			   imx_thermal_runtime_resume, NULL)
871 };
872 
873 static struct platform_driver imx_thermal = {
874 	.driver = {
875 		.name	= "imx_thermal",
876 		.pm	= &imx_thermal_pm_ops,
877 		.of_match_table = of_imx_thermal_match,
878 	},
879 	.probe		= imx_thermal_probe,
880 	.remove		= imx_thermal_remove,
881 };
882 module_platform_driver(imx_thermal);
883 
884 MODULE_AUTHOR("Freescale Semiconductor, Inc.");
885 MODULE_DESCRIPTION("Thermal driver for Freescale i.MX SoCs");
886 MODULE_LICENSE("GPL v2");
887 MODULE_ALIAS("platform:imx-thermal");
888