[PATCH 1/2] thermal: imx_sc: add i.MX system controller thermal support

[PATCH 1/2] thermal: imx_sc: add i.MX system controller thermal support

[Anson Huang]

i.MX8QXP is an ARMv8 SoC which has a Cortex-M4 system controller
inside, the system controller is in charge of controlling power,
clock and thermal sensors etc..

This patch adds i.MX system controller thermal driver support,
Linux kernel has to communicate with system controller via MU
(message unit) IPC to get each thermal sensor's temperature,
it supports multiple sensors which are passed from device tree,
please see the binding doc for details.

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
 drivers/thermal/Kconfig          |  11 ++
 drivers/thermal/Makefile         |   1 +
 drivers/thermal/imx_sc_thermal.c | 221 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 233 insertions(+)
 create mode 100644 drivers/thermal/imx_sc_thermal.c

diff --git a/drivers/thermal/Kconfig b/drivers/thermal/Kconfig
index 0e69edc..84e850c 100644
--- a/drivers/thermal/Kconfig
+++ b/drivers/thermal/Kconfig
@@ -222,6 +222,17 @@ config IMX_THERMAL
 	  cpufreq is used as the cooling device to throttle CPUs when the
 	  passive trip is crossed.
 
+config IMX_SC_THERMAL
+	tristate "Temperature sensor driver for NXP i.MX SoCs with System Controller"
+	depends on ARCH_MXC || COMPILE_TEST
+	depends on OF
+	help
+	  Support for Temperature Monitor (TEMPMON) found on NXP i.MX SoCs with
+	  system controller inside, Linux kernel has to communicate with system
+	  controller via MU (message unit) IPC to get temperature from thermal
+	  sensor. It supports one critical trip point and one
+	  passive trip point for each thermal sensor.
+
 config MAX77620_THERMAL
 	tristate "Temperature sensor driver for Maxim MAX77620 PMIC"
 	depends on MFD_MAX77620
diff --git a/drivers/thermal/Makefile b/drivers/thermal/Makefile
index 610344e..1b13f6a 100644
--- a/drivers/thermal/Makefile
+++ b/drivers/thermal/Makefile
@@ -41,6 +41,7 @@ obj-$(CONFIG_DB8500_THERMAL)	+= db8500_thermal.o
 obj-$(CONFIG_ARMADA_THERMAL)	+= armada_thermal.o
 obj-$(CONFIG_TANGO_THERMAL)	+= tango_thermal.o
 obj-$(CONFIG_IMX_THERMAL)	+= imx_thermal.o
+obj-$(CONFIG_IMX_SC_THERMAL)	+= imx_sc_thermal.o
 obj-$(CONFIG_MAX77620_THERMAL)	+= max77620_thermal.o
 obj-$(CONFIG_QORIQ_THERMAL)	+= qoriq_thermal.o
 obj-$(CONFIG_DA9062_THERMAL)	+= da9062-thermal.o
diff --git a/drivers/thermal/imx_sc_thermal.c b/drivers/thermal/imx_sc_thermal.c
new file mode 100644
index 0000000..2b34ce2
--- /dev/null
+++ b/drivers/thermal/imx_sc_thermal.c
@@ -0,0 +1,221 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright 2018 NXP.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ */
+
+#include <linux/err.h>
+#include <linux/firmware/imx/sci.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/of_device.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <linux/thermal.h>
+
+#include "thermal_core.h"
+
+#define IMX_SC_MISC_FUNC_GET_TEMP	13
+#define IMX_SC_C_TEMP			0
+
+struct imx_sc_ipc *thermal_ipc_handle;
+
+struct imx_sc_sensor {
+	struct thermal_zone_device *tzd;
+	unsigned int resource_id;
+};
+
+struct imx_sc_thermal_data {
+	struct imx_sc_sensor *sensor;
+};
+
+struct imx_sc_msg_req_misc_get_temp {
+	struct imx_sc_rpc_msg hdr;
+	u16 resource_id;
+	u8 type;
+} __packed;
+
+struct imx_sc_msg_resp_misc_get_temp {
+	struct imx_sc_rpc_msg hdr;
+	u16 celsius;
+	u8 tenths;
+} __packed;
+
+static int imx_sc_thermal_get_temp(void *data, int *temp)
+{
+	struct imx_sc_msg_resp_misc_get_temp *resp;
+	struct imx_sc_msg_req_misc_get_temp msg;
+	struct imx_sc_rpc_msg *hdr = &msg.hdr;
+	struct imx_sc_sensor *sensor = data;
+	int ret;
+
+	msg.resource_id = sensor->resource_id;
+	msg.type = IMX_SC_C_TEMP;
+
+	hdr->ver = IMX_SC_RPC_VERSION;
+	hdr->svc = IMX_SC_RPC_SVC_MISC;
+	hdr->func = IMX_SC_MISC_FUNC_GET_TEMP;
+	hdr->size = 2;
+
+	ret = imx_scu_call_rpc(thermal_ipc_handle, &msg, true);
+	if (ret) {
+		pr_err("read temp sensor %d failed, ret %d\n",
+			sensor->resource_id, ret);
+		return ret;
+	}
+
+	resp = (struct imx_sc_msg_resp_misc_get_temp *)&msg;
+	*temp = resp->celsius * 1000 + resp->tenths * 100;
+
+	return 0;
+}
+
+static const struct thermal_zone_of_device_ops imx_sc_thermal_ops = {
+	.get_temp = imx_sc_thermal_get_temp,
+};
+
+static int imx_sc_thermal_register_sensor(struct platform_device *pdev,
+					  struct imx_sc_sensor *sensor)
+{
+	struct thermal_zone_device *tzd;
+
+	tzd = devm_thermal_zone_of_sensor_register(&pdev->dev,
+						   sensor->resource_id,
+						   sensor,
+						   &imx_sc_thermal_ops);
+	if (IS_ERR(tzd)) {
+		dev_err(&pdev->dev, "failed to register sensor: %d\n",
+			sensor->resource_id);
+		return -EINVAL;
+	}
+
+	sensor->tzd = tzd;
+
+	return 0;
+}
+
+static int imx_sc_thermal_get_sensor_id(struct device_node *sensor_np)
+{
+	struct of_phandle_args sensor_specs;
+	int ret;
+
+	ret = of_parse_phandle_with_args(sensor_np, "thermal-sensors",
+			"#thermal-sensor-cells",
+			0, &sensor_specs);
+	if (ret)
+		return ret;
+
+	if (sensor_specs.args_count >= 1) {
+		ret = sensor_specs.args[0];
+		WARN(sensor_specs.args_count > 1,
+				"%pOFn: too many cells in sensor specifier %d\n",
+				sensor_specs.np, sensor_specs.args_count);
+	} else {
+		ret = 0;
+	}
+
+	return ret;
+}
+
+static int imx_sc_thermal_probe(struct platform_device *pdev)
+{
+	struct device_node *np = pdev->dev.of_node;
+	struct device_node *sensor_np = NULL;
+	struct imx_sc_thermal_data *data;
+	struct imx_sc_sensor *sensors;
+	u32 sensor_num;
+	int ret, i;
+
+	ret = imx_scu_get_handle(&thermal_ipc_handle);
+	if (ret) {
+		if (ret == -EPROBE_DEFER)
+			return ret;
+
+		dev_err(&pdev->dev, "failed to get ipc handle: %d!\n", ret);
+		return ret;
+	}
+
+	data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
+	if (!data)
+		return -ENOMEM;
+
+	ret = of_property_read_u32(np, "tsens-num", &sensor_num);
+	if (ret || !sensor_num) {
+		dev_err(&pdev->dev, "failed to get valid temp sensor number!\n");
+		ret = -EINVAL;
+		goto free_data;
+	}
+
+	sensors = devm_kzalloc(&pdev->dev, sizeof(*data->sensor) * sensor_num,
+			       GFP_KERNEL);
+	if (!sensors) {
+		ret = -ENOMEM;
+		goto free_data;
+	}
+
+	data->sensor = sensors;
+
+	np = of_find_node_by_name(NULL, "thermal-zones");
+	if (!np) {
+		ret = -ENODEV;
+		goto free_sensors;
+	}
+
+	for (i = 0; i < sensor_num; i++) {
+		struct imx_sc_sensor *sensor = &data->sensor[i];
+
+		sensor_np = of_get_next_child(np, sensor_np);
+		sensor->resource_id = imx_sc_thermal_get_sensor_id(sensor_np);
+		if (sensor->resource_id < 0) {
+			dev_err(&pdev->dev, "invalid sensor resource id: %d\n",
+				sensor->resource_id);
+			ret = sensor->resource_id;
+			goto put_node;
+		}
+
+		ret = imx_sc_thermal_register_sensor(pdev, sensor);
+		if (ret) {
+			dev_err(&pdev->dev, "failed to register thermal sensor: %d\n",
+				ret);
+			goto put_node;
+		}
+	}
+
+	of_node_put(sensor_np);
+	of_node_put(np);
+
+	return 0;
+
+put_node:
+	of_node_put(np);
+	of_node_put(sensor_np);
+free_sensors:
+	kfree(sensors);
+free_data:
+	kfree(data);
+
+	return ret;
+}
+
+static const struct of_device_id imx_sc_thermal_table[] = {
+	{ .compatible = "nxp,imx8qxp-sc-thermal", },
+	{},
+};
+MODULE_DEVICE_TABLE(of, imx_sc_thermal_table);
+
+static struct platform_driver imx_sc_thermal_driver = {
+		.probe = imx_sc_thermal_probe,
+		.driver = {
+			.name = "imx-sc-thermal",
+			.of_match_table = imx_sc_thermal_table,
+		},
+};
+module_platform_driver(imx_sc_thermal_driver);
+
+MODULE_AUTHOR("Anson Huang <Anson.Huang@nxp.com>");
+MODULE_DESCRIPTION("Thermal driver for NXP i.MX SoCs with system controller");
+MODULE_LICENSE("GPL v2");
-- 
2.7.4

[PATCH 2/2] dt-bindings: thermal: add binding doc for i.MX system controller thermal driver

[Anson Huang]

NXP i.MX8QXP is an ARMv8 SoC with a Cortex-M4 core inside as
system controller, the system controller is in charge of system
power, clock and thermal sensors etc. management, Linux kernel
has to communicate with system controller via MU (message unit)
IPC to get temperature from thermal sensors, this patch adds
binding doc for i.MX system controller thermal driver.

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
 .../devicetree/bindings/thermal/imx-sc-thermal.txt | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/imx-sc-thermal.txt

diff --git a/Documentation/devicetree/bindings/thermal/imx-sc-thermal.txt b/Documentation/devicetree/bindings/thermal/imx-sc-thermal.txt
new file mode 100644
index 0000000..2f5b0a2
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/imx-sc-thermal.txt
@@ -0,0 +1,33 @@
+* Temperature Monitor (TEMPMON) on NXP i.MX SoCs with System Controller
+
+Required properties:
+- compatible : Must be "nxp,imx8qxp-sc-thermal";
+- tsens-num : Total number of thermal sensors supported;
+- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description.
+
+Example:
+tsens: thermal-sensor {
+	compatible = "nxp,imx8qxp-sc-thermal";
+	tsens-num = <1>;
+	#thermal-sensor-cells = <1>;
+};
+
+thermal_zones: thermal-zones {
+	cpu-thermal0 {
+		polling-delay-passive = <250>;
+		polling-delay = <2000>;
+		thermal-sensors = <&tsens 355>;
+		trips {
+			cpu_alert0: trip0 {
+				temperature = <107000>;
+				hysteresis = <2000>;
+				type = "passive";
+			};
+			cpu_crit0: trip1 {
+				temperature = <127000>;
+				hysteresis = <2000>;
+				type = "critical";
+			};
+		};
+	};
+};
-- 
2.7.4

Re: [PATCH 1/2] thermal: imx_sc: add i.MX system controller thermal support

[kbuild test robot]

[-- Attachment #1: Type: text/plain, Size: 7008 bytes --]

Hi Anson,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on soc-thermal/next]
[also build test ERROR on v4.20-rc4 next-20181126]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]

url:    https://github.com/0day-ci/linux/commits/Anson-Huang/thermal-imx_sc-add-i-MX-system-controller-thermal-support/20181127-141933
base:   https://git.kernel.org/pub/scm/linux/kernel/git/evalenti/linux-soc-thermal.git next
config: i386-allmodconfig (attached as .config)
compiler: gcc-7 (Debian 7.3.0-1) 7.3.0
reproduce:
        # save the attached .config to linux build tree
        make ARCH=i386 

All errors (new ones prefixed by >>):

>> drivers/thermal/imx_sc_thermal.c:12:10: fatal error: linux/firmware/imx/sci.h: No such file or directory
    #include <linux/firmware/imx/sci.h>
             ^~~~~~~~~~~~~~~~~~~~~~~~~~
   compilation terminated.

coccinelle warnings: (new ones prefixed by >>)

>> drivers/thermal/imx_sc_thermal.c:197:1-6: WARNING: invalid free of devm_ allocated data
   drivers/thermal/imx_sc_thermal.c:199:1-6: WARNING: invalid free of devm_ allocated data
--
>> drivers/thermal/imx_sc_thermal.c:173:6-25: WARNING: Unsigned expression compared with zero: sensor -> resource_id < 0

vim +12 drivers/thermal/imx_sc_thermal.c

  > 12	#include <linux/firmware/imx/sci.h>
    13	#include <linux/module.h>
    14	#include <linux/of.h>
    15	#include <linux/of_device.h>
    16	#include <linux/platform_device.h>
    17	#include <linux/slab.h>
    18	#include <linux/thermal.h>
    19	
    20	#include "thermal_core.h"
    21	
    22	#define IMX_SC_MISC_FUNC_GET_TEMP	13
    23	#define IMX_SC_C_TEMP			0
    24	
    25	struct imx_sc_ipc *thermal_ipc_handle;
    26	
    27	struct imx_sc_sensor {
    28		struct thermal_zone_device *tzd;
    29		unsigned int resource_id;
    30	};
    31	
    32	struct imx_sc_thermal_data {
    33		struct imx_sc_sensor *sensor;
    34	};
    35	
    36	struct imx_sc_msg_req_misc_get_temp {
    37		struct imx_sc_rpc_msg hdr;
    38		u16 resource_id;
    39		u8 type;
    40	} __packed;
    41	
    42	struct imx_sc_msg_resp_misc_get_temp {
    43		struct imx_sc_rpc_msg hdr;
    44		u16 celsius;
    45		u8 tenths;
    46	} __packed;
    47	
    48	static int imx_sc_thermal_get_temp(void *data, int *temp)
    49	{
    50		struct imx_sc_msg_resp_misc_get_temp *resp;
    51		struct imx_sc_msg_req_misc_get_temp msg;
    52		struct imx_sc_rpc_msg *hdr = &msg.hdr;
    53		struct imx_sc_sensor *sensor = data;
    54		int ret;
    55	
    56		msg.resource_id = sensor->resource_id;
    57		msg.type = IMX_SC_C_TEMP;
    58	
    59		hdr->ver = IMX_SC_RPC_VERSION;
    60		hdr->svc = IMX_SC_RPC_SVC_MISC;
    61		hdr->func = IMX_SC_MISC_FUNC_GET_TEMP;
    62		hdr->size = 2;
    63	
    64		ret = imx_scu_call_rpc(thermal_ipc_handle, &msg, true);
    65		if (ret) {
    66			pr_err("read temp sensor %d failed, ret %d\n",
    67				sensor->resource_id, ret);
    68			return ret;
    69		}
    70	
    71		resp = (struct imx_sc_msg_resp_misc_get_temp *)&msg;
    72		*temp = resp->celsius * 1000 + resp->tenths * 100;
    73	
    74		return 0;
    75	}
    76	
    77	static const struct thermal_zone_of_device_ops imx_sc_thermal_ops = {
    78		.get_temp = imx_sc_thermal_get_temp,
    79	};
    80	
    81	static int imx_sc_thermal_register_sensor(struct platform_device *pdev,
    82						  struct imx_sc_sensor *sensor)
    83	{
    84		struct thermal_zone_device *tzd;
    85	
    86		tzd = devm_thermal_zone_of_sensor_register(&pdev->dev,
    87							   sensor->resource_id,
    88							   sensor,
    89							   &imx_sc_thermal_ops);
    90		if (IS_ERR(tzd)) {
    91			dev_err(&pdev->dev, "failed to register sensor: %d\n",
    92				sensor->resource_id);
    93			return -EINVAL;
    94		}
    95	
    96		sensor->tzd = tzd;
    97	
    98		return 0;
    99	}
   100	
   101	static int imx_sc_thermal_get_sensor_id(struct device_node *sensor_np)
   102	{
   103		struct of_phandle_args sensor_specs;
   104		int ret;
   105	
   106		ret = of_parse_phandle_with_args(sensor_np, "thermal-sensors",
   107				"#thermal-sensor-cells",
   108				0, &sensor_specs);
   109		if (ret)
   110			return ret;
   111	
   112		if (sensor_specs.args_count >= 1) {
   113			ret = sensor_specs.args[0];
   114			WARN(sensor_specs.args_count > 1,
   115					"%pOFn: too many cells in sensor specifier %d\n",
   116					sensor_specs.np, sensor_specs.args_count);
   117		} else {
   118			ret = 0;
   119		}
   120	
   121		return ret;
   122	}
   123	
   124	static int imx_sc_thermal_probe(struct platform_device *pdev)
   125	{
   126		struct device_node *np = pdev->dev.of_node;
   127		struct device_node *sensor_np = NULL;
   128		struct imx_sc_thermal_data *data;
   129		struct imx_sc_sensor *sensors;
   130		u32 sensor_num;
   131		int ret, i;
   132	
   133		ret = imx_scu_get_handle(&thermal_ipc_handle);
   134		if (ret) {
   135			if (ret == -EPROBE_DEFER)
   136				return ret;
   137	
   138			dev_err(&pdev->dev, "failed to get ipc handle: %d!\n", ret);
   139			return ret;
   140		}
   141	
   142		data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
   143		if (!data)
   144			return -ENOMEM;
   145	
   146		ret = of_property_read_u32(np, "tsens-num", &sensor_num);
   147		if (ret || !sensor_num) {
   148			dev_err(&pdev->dev, "failed to get valid temp sensor number!\n");
   149			ret = -EINVAL;
   150			goto free_data;
   151		}
   152	
   153		sensors = devm_kzalloc(&pdev->dev, sizeof(*data->sensor) * sensor_num,
   154				       GFP_KERNEL);
   155		if (!sensors) {
   156			ret = -ENOMEM;
   157			goto free_data;
   158		}
   159	
   160		data->sensor = sensors;
   161	
   162		np = of_find_node_by_name(NULL, "thermal-zones");
   163		if (!np) {
   164			ret = -ENODEV;
   165			goto free_sensors;
   166		}
   167	
   168		for (i = 0; i < sensor_num; i++) {
   169			struct imx_sc_sensor *sensor = &data->sensor[i];
   170	
   171			sensor_np = of_get_next_child(np, sensor_np);
   172			sensor->resource_id = imx_sc_thermal_get_sensor_id(sensor_np);
 > 173			if (sensor->resource_id < 0) {
   174				dev_err(&pdev->dev, "invalid sensor resource id: %d\n",
   175					sensor->resource_id);
   176				ret = sensor->resource_id;
   177				goto put_node;
   178			}
   179	
   180			ret = imx_sc_thermal_register_sensor(pdev, sensor);
   181			if (ret) {
   182				dev_err(&pdev->dev, "failed to register thermal sensor: %d\n",
   183					ret);
   184				goto put_node;
   185			}
   186		}
   187	
   188		of_node_put(sensor_np);
   189		of_node_put(np);
   190	
   191		return 0;
   192	
   193	put_node:
   194		of_node_put(np);
   195		of_node_put(sensor_np);
   196	free_sensors:
 > 197		kfree(sensors);
   198	free_data:
   199		kfree(data);
   200	
   201		return ret;
   202	}
   203	

---
0-DAY kernel test infrastructure                Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all                   Intel Corporation

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 64928 bytes --]