Skip to contentSkip to conversation

Add thermal control driver for Sunplus SP7021 SoC

PATCH Superseded Li-hao Kuo 4 participants 7 messages Mar 16, 2022 – Mar 22, 2022

Subsystems (2)

v5 of 11 Superseded Latest is v11 →

lore
Share & tools
lore

Li-hao Kuo

author
#0 lore raw

v5 cover Add thermal control driver for Sunplus SP7021 SoC

This is a patch series for thermal driver for Sunplus SP7021 SoC.

Sunplus SP7021 is an ARM Cortex A7 (4 cores) based SoC. It integrates many peripherals (ex: UART, I2C, SPI, SDIO, eMMC, USB, SD card and etc.) into a single chip. It is designed for industrial control.

Refer to:
https://sunplus-tibbo.atlassian.net/wiki/spaces/doc/overview
https://tibbo.com/store/plus1.html

Li-hao Kuo (2):
thermal: Add thermal driver for Sunplus SP7021
dt-bindings:thermal: Add Sunplus SP7021 schema

 .../bindings/thermal/sunplus_thermal.yaml          |  47 +++++++
 MAINTAINERS                                        |   7 ++
 drivers/thermal/Kconfig                            |  10 ++
 drivers/thermal/Makefile                           |   1 +
 drivers/thermal/sunplus_thermal.c                  | 140 +++++++++++++++++++++
 5 files changed, 205 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
 create mode 100644 drivers/thermal/sunplus_thermal.c
Signature · 1 line
2.7.4
author
#1 lore raw

PATCH v5 1/2 thermal: Add thermal driver for Sunplus SP7021

Add thermal driver for Sunplus SP7021.

---
Changes in v5:
- Modify yaml file remove reg name and change nvmem name
- Addressed comments from Mr. Daniel Lezcano

 MAINTAINERS                       |   6 ++
 drivers/thermal/Kconfig           |  10 +++
 drivers/thermal/Makefile          |   1 +
 drivers/thermal/sunplus_thermal.c | 140 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 157 insertions(+)
 create mode 100644 drivers/thermal/sunplus_thermal.c
MAINTAINERS +6 -0
index e127c2f..96d5218 100644
@@ -18542,6 +18542,12 @@ S:	Maintained
 F:	Documentation/devicetree/bindings/rtc/sunplus,sp7021-rtc.yaml
 F:	drivers/rtc/rtc-sunplus.c
 
+SUNPLUS THERMAL DRIVER
+M:	Li-hao Kuo <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/thermal/sunplus_thermal.c
+
 SUPERH
 M:	Yoshinori Sato <[email protected]>
 M:	Rich Felker <[email protected]>
drivers/thermal/Kconfig +10 -0
index e37691e..98647c7 100644
@@ -502,4 +502,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
+	help
+	  This 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
drivers/thermal/Makefile +1 -0
index f0c36a1..2f7417a 100644
@@ -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
\ No newline at end of file
drivers/thermal/sunplus_thermal.c new file +140 -0

140 lines not on this page · raw message

Signature · 1 line
2.7.4
#2 lore raw

Re: [PATCH v5 1/2] thermal: Add thermal driver for Sunplus SP7021

Quoted 37 lines · Li-hao Kuo

Add thermal driver for Sunplus SP7021.

---
Changes in v5:
- Modify yaml file remove reg name and change nvmem name
- Addressed comments from Mr. Daniel Lezcano

 MAINTAINERS                       |   6 ++
 drivers/thermal/Kconfig           |  10 +++
 drivers/thermal/Makefile          |   1 +
 drivers/thermal/sunplus_thermal.c | 140 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 157 insertions(+)
 create mode 100644 drivers/thermal/sunplus_thermal.c
MAINTAINERS +6 -0
index e127c2f..96d5218 100644
@@ -18542,6 +18542,12 @@ S:	Maintained
 F:	Documentation/devicetree/bindings/rtc/sunplus,sp7021-rtc.yaml
 F:	drivers/rtc/rtc-sunplus.c
 
+SUNPLUS THERMAL DRIVER
+M:	Li-hao Kuo <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/thermal/sunplus_thermal.c
+
 SUPERH
 M:	Yoshinori Sato <[email protected]>
 M:	Rich Felker <[email protected]>
drivers/thermal/Kconfig +0 -0
index e37691e..98647c7 100644

drivers/thermal/Kconfig config KHADAS_MCU_FAN_THERMAL · line 507

Quoted 6 lines
drivers/thermal/Kconfig +3 -0
@@ -502,4 +502,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
(and test if it compiles on other archs)

Quoted 13 lines
drivers/thermal/Kconfig +7 -0
+	help
+	  This 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
drivers/thermal/Makefile +0 -0
index f0c36a1..2f7417a 100644

drivers/thermal/Makefile obj-$(CONFIG_UNIPHIER_THERMAL) += uniphier_thermal.o · line 64

Quoted 5 lines
drivers/thermal/Makefile +1 -0
@@ -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
\ No newline at end of file

Patch error here.

Quoted 36 lines
drivers/thermal/sunplus_thermal.c new file +30 -0
new file mode 100644
index 0000000..e2e955e
@@ -0,0 +1,140 @@
+// 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 DISABLE_THERMAL		(BIT(31) | BIT(15))
+#define ENABLE_THERMAL		BIT(31)
+#define SP_THERMAL_MASK		GENMASK(10, 0)
+#define SP_TCODE_HIGH_MASK	GENMASK(10, 8)
+#define SP_TCODE_LOW_MASK	GENMASK(7, 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 */

drivers/thermal/sunplus_thermal.c line 40

Quoted 10 lines
drivers/thermal/sunplus_thermal.c new file +10 -0
+struct sp_thermal_data {
+	struct thermal_zone_device *pcb_tz;
+	struct platform_device *pdev;
+	enum thermal_device_mode mode;
+	void __iomem *regs;
+	int otp_temp0;
+	u32 id;
+};
+
+static char sp7021_get_otp_temp_coef(struct sp_thermal_data *sp_data, struct device *dev)

Why does it return char?

Quoted 24 lines
drivers/thermal/sunplus_thermal.c new file +24 -0
+{
+	struct nvmem_cell *cell;
+	ssize_t otp_l;
+	char *otp_v;
+
+	cell = nvmem_cell_get(dev, "calib");
+	if (IS_ERR(cell))
+		return ERR_CAST(cell);
+
+	otp_v = nvmem_cell_read(cell, &otp_l);
+	nvmem_cell_put(cell);
+
+	if (otp_l < 3)
+		return -EINVAL;
+	sp_data->otp_temp0 = FIELD_PREP(SP_TCODE_LOW_MASK, otp_v[0]) |
+			     FIELD_PREP(SP_TCODE_HIGH_MASK, otp_v[1]);
+	if (sp_data->otp_temp0 == 0)
+		sp_data->otp_temp0 = TEMP_OTP_BASE;
+	return 0;
+}
+
+static int sp_thermal_get_sensor_temp(void *data, int *temp)
+{
+	struct sp_thermal_data *sp_data = data;

drivers/thermal/sunplus_thermal.c line 74

Quoted 10 lines
drivers/thermal/sunplus_thermal.c new file +10 -0
+	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 struct thermal_zone_of_device_ops sp_of_thermal_ops = {

This should be const.

Quoted 22 lines
drivers/thermal/sunplus_thermal.c new file +22 -0
+	.get_temp = sp_thermal_get_sensor_temp,
+};
+
+static int sp_thermal_register_sensor(struct platform_device *pdev,
+				      struct sp_thermal_data *data, int index)
+{
+	data->id = index;
+	data->pcb_tz = devm_thermal_zone_of_sensor_register(&pdev->dev,
+							    data->id,
+							    data, &sp_of_thermal_ops);
+	if (IS_ERR_OR_NULL(data->pcb_tz))
+		return PTR_ERR(data->pcb_tz);
+	return 0;
+}
+
+static int sp7021_thermal_probe(struct platform_device *pdev)
+{
+	struct sp_thermal_data *sp_data;
+	struct resource *res;
+	int ret;
+
+	sp_data = devm_kzalloc(&pdev->dev, sizeof(*sp_data), GFP_KERNEL);

drivers/thermal/sunplus_thermal.c line 106

Quoted 10 lines
drivers/thermal/sunplus_thermal.c new file +10 -0
+	if (!sp_data)
+		return -ENOMEM;
+
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	if (IS_ERR(res))
+		return dev_err_probe(&pdev->dev, PTR_ERR(res), "resource get fail\n");
+
+	sp_data->regs = devm_ioremap(&pdev->dev, res->start, resource_size(res));
+	if (IS_ERR(sp_data->regs))
+		return dev_err_probe(&pdev->dev, PTR_ERR(sp_data->regs), "mas_base get fail\n");

Use devm_platform_ioremap_resource() instead.

drivers/thermal/sunplus_thermal.c line 111

Quoted 5 lines
drivers/thermal/sunplus_thermal.c new file +5 -0
+
+	writel(ENABLE_THERMAL, sp_data->regs + SP_THERMAL_CTL0_REG);
+
+	platform_set_drvdata(pdev, sp_data);
+	ret = sp7021_get_otp_temp_coef(sp_data, &pdev->dev);

Ignored return code.

drivers/thermal/sunplus_thermal.c line 119

Quoted 8 lines
drivers/thermal/sunplus_thermal.c new file +8 -0
+	ret = sp_thermal_register_sensor(pdev, sp_data, 0);
+
+	return ret;
+}
+
+static int sp7021_thermal_remove(struct platform_device *pdev)
+{
+	return 0;

No need for empty code.

Quoted 4 lines
drivers/thermal/sunplus_thermal.c new file +4 -0
+}
+
+static const struct of_device_id of_sp7021_thermal_ids[] = {
+	{ .compatible = "sunplus,sp7021-thermal" },

drivers/thermal/sunplus_thermal.c line 133

Quoted 10 lines
drivers/thermal/sunplus_thermal.c new file +10 -0
+	{ /* sentinel */ }
+};
+MODULE_DEVICE_TABLE(of, of_sp7021_thermal_ids);
+
+static struct platform_driver sp7021_thermal_driver = {
+	.probe	= sp7021_thermal_probe,
+	.remove	= sp7021_thermal_remove,
+	.driver	= {
+		.name	= "sp7021-thermal",
+		.of_match_table = of_match_ptr(of_sp7021_thermal_ids),

of_match_ptr looks incorrect - of_device_id is always present. If you want to handle such case - build !OF - then you need maybe_unused to of_device_id.

Best regards,
Best regards,
Krzysztof

#3 lore raw

RE: [PATCH v5 1/2] thermal: Add thermal driver for Sunplus SP7021

Quoted 12 lines

drivers/thermal/sunplus_thermal.c

Quoted 9 lines
drivers/thermal/sunplus_thermal.c new file +9 -0
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	if (IS_ERR(res))
+		return dev_err_probe(&pdev->dev, PTR_ERR(res), "resource get
+fail\n");
+
+	sp_data->regs = devm_ioremap(&pdev->dev, res->start, resource_size(res));
+	if (IS_ERR(sp_data->regs))
+		return dev_err_probe(&pdev->dev, PTR_ERR(sp_data->regs), "mas_base
+get fail\n");

Use devm_platform_ioremap_resource() instead.

Other drivers must also access these registers.
Warning when using devm_platform_ioremap_resource
Can I keep the original settings?

#4 lore raw

Re: [PATCH v5 1/2] thermal: Add thermal driver for Sunplus SP7021

Quoted 13 lines · Lh Kuo 郭力豪
Quoted 12 lines

drivers/thermal/sunplus_thermal.c

Quoted 9 lines
drivers/thermal/sunplus_thermal.c new file +9 -0
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	if (IS_ERR(res))
+		return dev_err_probe(&pdev->dev, PTR_ERR(res), "resource get
+fail\n");
+
+	sp_data->regs = devm_ioremap(&pdev->dev, res->start, resource_size(res));
+	if (IS_ERR(sp_data->regs))
+		return dev_err_probe(&pdev->dev, PTR_ERR(sp_data->regs), "mas_base
+get fail\n");

Use devm_platform_ioremap_resource() instead.

Quoted 3 lines

Other drivers must also access these registers.
Warning when using devm_platform_ioremap_resource
Can I keep the original settings?

You should not map one region twice. How do you guarantee synchronization during for example updates of specific registers? In such case you need to use regmap and share it via syscon (although this does not solve synchronization on higher level - avoiding conflicting changes to same registers)

Best regards,
Krzysztof

author
#5 lore raw

PATCH v5 2/2 dt-bindings:thermal: Add Sunplus SP7021 schema

In reply to Li-hao Kuo

Add bindings for Sunplus SP7021 thermal driver

---
Changes in v5:
- Modify yaml file remove reg name and change nvmem name
- Addressed comments from Mr. Daniel Lezcano

 .../bindings/thermal/sunplus_thermal.yaml          | 47 ++++++++++++++++++++++
 MAINTAINERS                                        |  1 +
 2 files changed, 48 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml new file +47 -0
new file mode 100644
index 0000000..176bc07
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (C) Sunplus Co., Ltd.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/sunplus_thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sunplus Thermal controller
+
+maintainers:
+  - Li-hao Kuo <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - sunplus,sp7021-thermal
+
+  reg:
+    maxItems: 1
+
+  reg-names:
+    items:
+      - const: reg
+
+  nvmem-cells:
+    maxItems: 1
+
+  nvmem-cell-names:
+    const: therm_calib
+
+required:
+  - compatible
+  - reg
+  - nvmem-cells
+  - nvmem-cell-names
+
+additionalProperties: false
+
+examples:
+  - |
+    thermal@9c000280 {
+        compatible = "sunplus,sp7021-thermal";
+        reg = <0x9c000280 0x80>;
+        nvmem-cells = <&therm_calib>;
+        nvmem-cell-names = "therm_calib";
+    };
+...
MAINTAINERS +1 -0
index 96d5218..5000b8a 100644
@@ -18546,6 +18546,7 @@ SUNPLUS THERMAL DRIVER
 M:	Li-hao Kuo <[email protected]>
 L:	[email protected]
 S:	Maintained
+F:	Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
 F:	drivers/thermal/sunplus_thermal.c
 
 SUPERH
Signature · 1 line
2.7.4
#6 lore raw

Re: [PATCH v5 2/2] dt-bindings:thermal: Add Sunplus SP7021 schema

Quoted 19 lines · Li-hao Kuo

Add bindings for Sunplus SP7021 thermal driver

---
Changes in v5:
- Modify yaml file remove reg name and change nvmem name
- Addressed comments from Mr. Daniel Lezcano

 .../bindings/thermal/sunplus_thermal.yaml          | 47 ++++++++++++++++++++++
 MAINTAINERS                                        |  1 +
 2 files changed, 48 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml new file +0 -0
new file mode 100644
index 0000000..176bc07

Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml line 5

Quoted 5 lines
Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml new file +5 -0
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (C) Sunplus Co., Ltd.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/sunplus_thermal.yaml#

File name with vendor prefix and comma, so one of:
sunplus,thermal
sunplus,sp7021-thermal

Best regards,
Krzysztof