Add thermal driver for Sunplus.
Signed-off-by: Li-hao Kuo <[email protected]>
---
Changes in v10:
- Change the setting of compatible
- Mosdify the setting of remove funciton.
MAINTAINERS | 6 ++
drivers/thermal/Kconfig | 10 +++
drivers/thermal/Makefile | 1 +
drivers/thermal/sunplus_thermal.c | 139 ++++++++++++++++++++++++++++++++++++++
4 files changed, 156 insertions(+)
create mode 100644 drivers/thermal/sunplus_thermal.c
diff --git a/MAINTAINERS b/MAINTAINERS
index a6d3bd9..23bde07 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -19103,6 +19103,12 @@ S: Maintained
F: Documentation/devicetree/bindings/spi/spi-sunplus-sp7021.yaml
F: drivers/spi/spi-sunplus-sp7021.c
+SUNPLUS THERMAL DRIVER
+M: Li-hao Kuo <[email protected]>
+L: [email protected]
+S: Maintained
+F: drivers/thermal/sunplus_thermal.c
+
SUNPLUS UART DRIVER
M: Hammer Hsieh <[email protected]>
S: Maintained
diff --git a/drivers/thermal/Kconfig b/drivers/thermal/Kconfig
index 0e5cc94..c85e668 100644
--- a/drivers/thermal/Kconfig
+++ b/drivers/thermal/Kconfig
@@ -504,4 +504,14 @@ config KHADAS_MCU_FAN_THERMAL
If you say yes here you get support for the FAN controlled
by the Microcontroller found on the Khadas VIM boards.
+config SUNPLUS_THERMAL
+ tristate "Sunplus thermal drivers"
+ depends on SOC_SP7021 || COMPILE_TEST
+ help
+ This enable the Sunplus SP7021 thermal driver, which supports the primitive
+ temperature sensor embedded in Sunplus SP7021 SoC.
+
+ If you have a Sunplus SP7021 platform say Y here and enable this option
+ to have support for thermal management.
+
endif
diff --git a/drivers/thermal/Makefile b/drivers/thermal/Makefile
index def8e1a..b603730 100644
--- a/drivers/thermal/Makefile
+++ b/drivers/thermal/Makefile
@@ -61,3 +61,4 @@ obj-$(CONFIG_UNIPHIER_THERMAL) += uniphier_thermal.o
obj-$(CONFIG_AMLOGIC_THERMAL) += amlogic_thermal.o
obj-$(CONFIG_SPRD_THERMAL) += sprd_thermal.o
obj-$(CONFIG_KHADAS_MCU_FAN_THERMAL) += khadas_mcu_fan.o
+obj-$(CONFIG_SUNPLUS_THERMAL) += sunplus_thermal.o
diff --git a/drivers/thermal/sunplus_thermal.c b/drivers/thermal/sunplus_thermal.c
new file mode 100644
index 0000000..ed73a15
--- /dev/null
+++ b/drivers/thermal/sunplus_thermal.c
@@ -0,0 +1,139 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright (c) Sunplus Inc.
+ * Author: Li-hao Kuo <[email protected]>
+ */
+
+#include <linux/bitfield.h>
+#include <linux/clk.h>
+#include <linux/delay.h>
+#include <linux/io.h>
+#include <linux/module.h>
+#include <linux/nvmem-consumer.h>
+#include <linux/platform_device.h>
+#include <linux/reset.h>
+#include <linux/thermal.h>
+
+#define ENABLE_THERMAL BIT(31)
+#define SP_THERMAL_MASK GENMASK(10, 0)
+
+#define TEMP_RATE 608
+#define TEMP_BASE 3500
+#define TEMP_OTP_BASE 1518
+
+#define SP_THERMAL_CTL0_REG 0x0000
+#define SP_THERMAL_STS0_REG 0x0030
+
+/* common data structures */
+struct sp_thermal_data {
+ struct thermal_zone_device *pcb_tz;
+ void __iomem *regs;
+ int *otp_temp0;
+};
+
+static int sunplus_get_otp_temp_coef(struct sp_thermal_data *sp_data, struct device *dev)
+{
+ struct nvmem_cell *cell;
+ ssize_t otp_l;
+
+ cell = nvmem_cell_get(dev, "calib");
+ if (IS_ERR(cell))
+ return PTR_ERR(cell);
+
+ sp_data->otp_temp0 = nvmem_cell_read(cell, &otp_l);
+ nvmem_cell_put(cell);
+
+ if (*sp_data->otp_temp0 == 0)
+ *sp_data->otp_temp0 = TEMP_OTP_BASE;
+
+ return 0;
+}
+
+/*
+ * There is a thermal sensor instance for Sunplus Soc
+ * T_CODE is the ADC of the thermal sensor
+ * T_CODE : 11 digits in total
+ * When remanufacturing, the 35 degree T_CODE will be read and stored in nvcell.
+ * otp_temp0 is the 35 degree T_CODE obtained from nvcell
+ * The function will get 35 degree T_CODE for thermal calibration.
+ * TEMP_RATE is the Sunplus thermal temperature slope.
+ */
+
+static int sp_thermal_get_sensor_temp(void *data, int *temp)
+{
+ struct sp_thermal_data *sp_data = data;
+ int t_code;
+
+ t_code = readl(sp_data->regs + SP_THERMAL_STS0_REG);
+ t_code = FIELD_GET(SP_THERMAL_MASK, t_code);
+ *temp = ((*sp_data->otp_temp0 - t_code) * 10000 / TEMP_RATE) + TEMP_BASE;
+ *temp *= 10;
+ return 0;
+}
+
+static const struct thermal_zone_of_device_ops sp_of_thermal_ops = {
+ .get_temp = sp_thermal_get_sensor_temp,
+};
+
+static int sunplus_thermal_probe(struct platform_device *pdev)
+{
+ struct sp_thermal_data *sp_data;
+ int ret;
+
+ sp_data = devm_kzalloc(&pdev->dev, sizeof(*sp_data), GFP_KERNEL);
+ if (!sp_data)
+ return -ENOMEM;
+
+ sp_data->regs = devm_platform_ioremap_resource(pdev, 0);
+ if (IS_ERR(sp_data->regs)) {
+ dev_err(&pdev->dev, "resource get fail\n");
+ return PTR_ERR(sp_data->regs);
+ }
+
+ writel(ENABLE_THERMAL, sp_data->regs + SP_THERMAL_CTL0_REG);
+
+ platform_set_drvdata(pdev, sp_data);
+ ret = sunplus_get_otp_temp_coef(sp_data, &pdev->dev);
+ if (ret)
+ return ret;
+
+ sp_data->pcb_tz = devm_thermal_zone_of_sensor_register(&pdev->dev,
+ 0,
+ sp_data, &sp_of_thermal_ops);
+
+ if (IS_ERR(sp_data->pcb_tz)) {
+ ret = PTR_ERR(sp_data->pcb_tz);
+ dev_err(dev, "Failed to register tsensor: %d\n", ret);
+ return ret;
+ }
+
+ return ret;
+}
+
+static int sunplus_thermal_remove(struct platform_device *pdev)
+{
+ struct sp_thermal_data *sp_data = platform_get_drvdata(pdev);
+
+ thermal_zone_of_sensor_unregister(&pdev->dev, sp_data->pcb_tz);
+ return 0;
+}
+
+static const struct of_device_id of_sunplus_thermal_ids[] = {
+ { .compatible = "sunplus,sp7021-thermal" },
+ { /* sentinel */ }
+};
+MODULE_DEVICE_TABLE(of, of_sunplus_thermal_ids);
+
+static struct platform_driver sunplus_thermal_driver = {
+ .probe = sunplus_thermal_probe,
+ .remove = sunplus_thermal_remove,
+ .driver = {
+ .name = "sunplus-thermal",
+ .of_match_table = of_sunplus_thermal_ids,
+ },
+};
+module_platform_driver(sunplus_thermal_driver);
+
+MODULE_AUTHOR("Li-hao Kuo <[email protected]>");
+MODULE_DESCRIPTION("Thermal driver for Sunplus SoC");
+MODULE_LICENSE("GPL");
--
2.7.4
On 12/07/2022 09:30, Li-hao Kuo wrote:
> Add thermal driver for Sunplus.
>
> Signed-off-by: Li-hao Kuo <[email protected]>
Thank you for your patch. There is something to discuss/improve.
_data);
> + ret = sunplus_get_otp_temp_coef(sp_data, &pdev->dev);
> + if (ret)
> + return ret;
> +
> + sp_data->pcb_tz = devm_thermal_zone_of_sensor_register(&pdev->dev,
> + 0,
> + sp_data, &sp_of_thermal_ops);
> +
> + if (IS_ERR(sp_data->pcb_tz)) {
> + ret = PTR_ERR(sp_data->pcb_tz);
> + dev_err(dev, "Failed to register tsensor: %d\n", ret);
> + return ret;
> + }
> +
> + return ret;
> +}
> +
> +static int sunplus_thermal_remove(struct platform_device *pdev)
> +{
> + struct sp_thermal_data *sp_data = platform_get_drvdata(pdev);
> +
> + thermal_zone_of_sensor_unregister(&pdev->dev, sp_data->pcb_tz);
You used devm to register, so this looks wrong and will lead to double free.
Best regards,
Krzysztof
> > +}
> > +
> > +static int sunplus_thermal_remove(struct platform_device *pdev) {
> > + struct sp_thermal_data *sp_data = platform_get_drvdata(pdev);
> > +
> > + thermal_zone_of_sensor_unregister(&pdev->dev, sp_data->pcb_tz);
>
> You used devm to register, so this looks wrong and will lead to double free.
>
>
You mean the remove function is not needed. ??
On 14/07/2022 07:32, Lh Kuo 郭力豪 wrote:
>>> +}
>>> +
>>> +static int sunplus_thermal_remove(struct platform_device *pdev) {
>>> + struct sp_thermal_data *sp_data = platform_get_drvdata(pdev);
>>> +
>>> + thermal_zone_of_sensor_unregister(&pdev->dev, sp_data->pcb_tz);
>>
>> You used devm to register, so this looks wrong and will lead to double free.
>>
>>
>
> You mean the remove function is not needed. ??
At least this call but after its removal the entire function would be
empty, I think.
Best regards,
Krzysztof
Hi Li-hao,
I love your patch! Yet something to improve:
[auto build test ERROR on rafael-pm/thermal]
[also build test ERROR on krzk-dt/for-next linus/master v5.19-rc7 next-20220720]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Li-hao-Kuo/Add-thermal-control-driver-for-Sunplus-SoC/20220712-153158
base: https://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git thermal
config: sh-randconfig-s042-20220715 (https://download.01.org/0day-ci/archive/20220721/[email protected]/config)
compiler: sh4-linux-gcc (GCC) 12.1.0
reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.4-39-gce1a6720-dirty
# https://github.com/intel-lab-lkp/linux/commit/328f3fe3eb3d1984a68c51c4a413821bd4b397b6
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Li-hao-Kuo/Add-thermal-control-driver-for-Sunplus-SoC/20220712-153158
git checkout 328f3fe3eb3d1984a68c51c4a413821bd4b397b6
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' O=build_dir ARCH=sh SHELL=/bin/bash .// drivers/
If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <[email protected]>
All errors (new ones prefixed by >>):
In file included from include/linux/device.h:15,
from include/linux/platform_device.h:13,
from drivers/thermal/sunplus_thermal.c:13:
drivers/thermal/sunplus_thermal.c: In function 'sunplus_thermal_probe':
>> drivers/thermal/sunplus_thermal.c:106:25: error: 'dev' undeclared (first use in this function); did you mean 'pdev'?
106 | dev_err(dev, "Failed to register tsensor: %d\n", ret);
| ^~~
include/linux/dev_printk.h:110:25: note: in definition of macro 'dev_printk_index_wrap'
110 | _p_func(dev, fmt, ##__VA_ARGS__); \
| ^~~
drivers/thermal/sunplus_thermal.c:106:17: note: in expansion of macro 'dev_err'
106 | dev_err(dev, "Failed to register tsensor: %d\n", ret);
| ^~~~~~~
drivers/thermal/sunplus_thermal.c:106:25: note: each undeclared identifier is reported only once for each function it appears in
106 | dev_err(dev, "Failed to register tsensor: %d\n", ret);
| ^~~
include/linux/dev_printk.h:110:25: note: in definition of macro 'dev_printk_index_wrap'
110 | _p_func(dev, fmt, ##__VA_ARGS__); \
| ^~~
drivers/thermal/sunplus_thermal.c:106:17: note: in expansion of macro 'dev_err'
106 | dev_err(dev, "Failed to register tsensor: %d\n", ret);
| ^~~~~~~
vim +106 drivers/thermal/sunplus_thermal.c
> 13 #include <linux/platform_device.h>
14 #include <linux/reset.h>
15 #include <linux/thermal.h>
16
17 #define ENABLE_THERMAL BIT(31)
18 #define SP_THERMAL_MASK GENMASK(10, 0)
19
20 #define TEMP_RATE 608
21 #define TEMP_BASE 3500
22 #define TEMP_OTP_BASE 1518
23
24 #define SP_THERMAL_CTL0_REG 0x0000
25 #define SP_THERMAL_STS0_REG 0x0030
26
27 /* common data structures */
28 struct sp_thermal_data {
29 struct thermal_zone_device *pcb_tz;
30 void __iomem *regs;
31 int *otp_temp0;
32 };
33
34 static int sunplus_get_otp_temp_coef(struct sp_thermal_data *sp_data, struct device *dev)
35 {
36 struct nvmem_cell *cell;
37 ssize_t otp_l;
38
39 cell = nvmem_cell_get(dev, "calib");
40 if (IS_ERR(cell))
41 return PTR_ERR(cell);
42
43 sp_data->otp_temp0 = nvmem_cell_read(cell, &otp_l);
44 nvmem_cell_put(cell);
45
46 if (*sp_data->otp_temp0 == 0)
47 *sp_data->otp_temp0 = TEMP_OTP_BASE;
48
49 return 0;
50 }
51
52 /*
53 * There is a thermal sensor instance for Sunplus Soc
54 * T_CODE is the ADC of the thermal sensor
55 * T_CODE : 11 digits in total
56 * When remanufacturing, the 35 degree T_CODE will be read and stored in nvcell.
57 * otp_temp0 is the 35 degree T_CODE obtained from nvcell
58 * The function will get 35 degree T_CODE for thermal calibration.
59 * TEMP_RATE is the Sunplus thermal temperature slope.
60 */
61
62 static int sp_thermal_get_sensor_temp(void *data, int *temp)
63 {
64 struct sp_thermal_data *sp_data = data;
65 int t_code;
66
67 t_code = readl(sp_data->regs + SP_THERMAL_STS0_REG);
68 t_code = FIELD_GET(SP_THERMAL_MASK, t_code);
69 *temp = ((*sp_data->otp_temp0 - t_code) * 10000 / TEMP_RATE) + TEMP_BASE;
70 *temp *= 10;
71 return 0;
72 }
73
74 static const struct thermal_zone_of_device_ops sp_of_thermal_ops = {
75 .get_temp = sp_thermal_get_sensor_temp,
76 };
77
78 static int sunplus_thermal_probe(struct platform_device *pdev)
79 {
80 struct sp_thermal_data *sp_data;
81 int ret;
82
83 sp_data = devm_kzalloc(&pdev->dev, sizeof(*sp_data), GFP_KERNEL);
84 if (!sp_data)
85 return -ENOMEM;
86
87 sp_data->regs = devm_platform_ioremap_resource(pdev, 0);
88 if (IS_ERR(sp_data->regs)) {
89 dev_err(&pdev->dev, "resource get fail\n");
90 return PTR_ERR(sp_data->regs);
91 }
92
93 writel(ENABLE_THERMAL, sp_data->regs + SP_THERMAL_CTL0_REG);
94
95 platform_set_drvdata(pdev, sp_data);
96 ret = sunplus_get_otp_temp_coef(sp_data, &pdev->dev);
97 if (ret)
98 return ret;
99
100 sp_data->pcb_tz = devm_thermal_zone_of_sensor_register(&pdev->dev,
101 0,
102 sp_data, &sp_of_thermal_ops);
103
104 if (IS_ERR(sp_data->pcb_tz)) {
105 ret = PTR_ERR(sp_data->pcb_tz);
> 106 dev_err(dev, "Failed to register tsensor: %d\n", ret);
107 return ret;
108 }
109
110 return ret;
111 }
112
--
0-DAY CI Kernel Test Service
https://01.org/lkp
On 12/07/2022 09:30, Li-hao Kuo wrote:
> Add thermal driver for Sunplus.
>
> Signed-off-by: Li-hao Kuo <[email protected]>
> ---
> Changes in v10:
> - Change the setting of compatible
> - Mosdify the setting of remove funciton.
This driver was never compiled :(
Best regards,
Krzysztof