2022-01-04 02:58:52

by Li-hao Kuo

[permalink] [raw]
Subject: [PATCH v3 0/2] 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
devicetree: bindings THERMAL Add bindings doc for Sunplus SP7021

.../bindings/thermal/sunplus_thermal.yaml | 49 +++++++
MAINTAINERS | 7 +
drivers/thermal/Kconfig | 10 ++
drivers/thermal/Makefile | 1 +
drivers/thermal/sunplus_thermal.c | 161 +++++++++++++++++++++
5 files changed, 228 insertions(+)
create mode 100644 Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
create mode 100644 drivers/thermal/sunplus_thermal.c

--
2.7.4



2022-01-04 02:58:55

by Li-hao Kuo

[permalink] [raw]
Subject: [PATCH v3 1/2] THERMAL: Add THERMAL driver for Sunplus SP7021

Add THERMAL driver for Sunplus SP7021.

Signed-off-by: Li-hao Kuo <[email protected]>
---
Changes in v3:
- Modify Theraml driver

MAINTAINERS | 6 ++
drivers/thermal/Kconfig | 10 +++
drivers/thermal/Makefile | 1 +
drivers/thermal/sunplus_thermal.c | 161 ++++++++++++++++++++++++++++++++++++++
4 files changed, 178 insertions(+)
create mode 100644 drivers/thermal/sunplus_thermal.c

diff --git a/MAINTAINERS b/MAINTAINERS
index fb18ce7..4b02628 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18242,6 +18242,12 @@ L: [email protected]
S: Maintained
F: drivers/net/ethernet/dlink/sundance.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]>
diff --git a/drivers/thermal/Kconfig b/drivers/thermal/Kconfig
index d7f44de..6643a81 100644
--- a/drivers/thermal/Kconfig
+++ b/drivers/thermal/Kconfig
@@ -493,4 +493,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
diff --git a/drivers/thermal/Makefile b/drivers/thermal/Makefile
index 82fc3e6..23f8dce 100644
--- a/drivers/thermal/Makefile
+++ b/drivers/thermal/Makefile
@@ -60,3 +60,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
diff --git a/drivers/thermal/sunplus_thermal.c b/drivers/thermal/sunplus_thermal.c
new file mode 100644
index 0000000..35e68bc
--- /dev/null
+++ b/drivers/thermal/sunplus_thermal.c
@@ -0,0 +1,161 @@
+// 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/cpufreq.h>
+#include <linux/delay.h>
+#include <linux/err.h>
+#include <linux/interrupt.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/rtc.h>
+#include <linux/thermal.h>
+
+#define DISABLE_THREMAL (BIT(31) | BIT(15))
+#define ENABLE_THREMAL BIT(31)
+#define SP_THREMAL_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;
+ struct platform_device *pdev;
+ enum thermal_device_mode mode;
+ long sensor_temp;
+ void __iomem *regs;
+ int otp_temp0;
+ int otp_temp1;
+ u32 id;
+};
+
+char *sp7021_otp_coef_read(struct device *dev, ssize_t *len)
+{
+ char *ret = NULL;
+ struct nvmem_cell *c = nvmem_cell_get(dev, "therm_calib");
+
+ if (IS_ERR_OR_NULL(c)) {
+ dev_err(dev, "OTP read failure:%ld", PTR_ERR(c));
+ return NULL;
+ }
+ ret = nvmem_cell_read(c, len);
+ nvmem_cell_put(c);
+ dev_dbg(dev, "%d bytes read from OTP", *len);
+ return ret;
+}
+
+static void sp7021_get_otp_temp_coef(struct sp_thermal_data *sp_data, struct device *_d)
+{
+ ssize_t otp_l = 0;
+ char *otp_v;
+
+ otp_v = sp7021_otp_coef_read(_d, &otp_l);
+ if (otp_l < 3)
+ return;
+ if (IS_ERR_OR_NULL(otp_v))
+ return;
+ sp_data->otp_temp0 = otp_v[0] | (otp_v[1] << 8);
+ sp_data->otp_temp0 = otp_v[0] | (otp_v[1] << 8);
+ sp_data->otp_temp0 = FIELD_GET(SP_THREMAL_MASK, sp_data->otp_temp0);
+ sp_data->otp_temp1 = (otp_v[1] >> 3) | (otp_v[2] << 5);
+ sp_data->otp_temp1 = FIELD_GET(SP_THREMAL_MASK, sp_data->otp_temp1);
+ if (sp_data->otp_temp0 == 0)
+ sp_data->otp_temp0 = TEMP_OTP_BASE;
+}
+
+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_THREMAL_MASK, t_code);
+ *temp = ((sp_data->otp_temp0 - t_code) * 10000 / TEMP_RATE) + TEMP_BASE;
+ *temp *= 10;
+ dev_dbg(&(sp_data->pdev->dev), "tc:%d t:%d", t_code, *temp);
+ return 0;
+}
+
+static struct thermal_zone_of_device_ops sp_of_thermal_ops = {
+ .get_temp = sp_thermal_get_sensor_temp,
+};
+
+static int sp_thermal_register_sensor(struct platform_device *pdev, struct sp_thermal_data *data,
+ int index)
+{
+ int ret;
+
+ 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 0;
+ ret = PTR_ERR(data->pcb_tz);
+ data->pcb_tz = NULL;
+ dev_err(&pdev->dev, "sensor#%d reg fail: %d\n", index, ret);
+ return ret;
+}
+
+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);
+ 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");
+
+ writel(ENABLE_THREMAL, sp_data->regs + SP_THERMAL_CTL0_REG);
+
+ platform_set_drvdata(pdev, sp_data);
+ sp7021_get_otp_temp_coef(sp_data, &pdev->dev);
+ ret = sp_thermal_register_sensor(pdev, sp_data, 0);
+
+ return ret;
+}
+
+static int sp7021_thermal_remove(struct platform_device *_pd)
+{
+ return 0;
+}
+
+static const struct of_device_id of_sp7021_thermal_ids[] = {
+ { .compatible = "sunplus,sp7021-thermal" },
+ { /* 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),
+ },
+};
+module_platform_driver(sp7021_thermal_driver);
+
+MODULE_AUTHOR("Li-hao Kuo <[email protected]>");
+MODULE_DESCRIPTION("Thermal driver for SP7021 SoC");
+MODULE_LICENSE("GPL v2");
--
2.7.4


2022-01-04 02:58:56

by Li-hao Kuo

[permalink] [raw]
Subject: [PATCH v3 2/2] devicetree: bindings THERMAL Add bindings doc for Sunplus SP7021

Add devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

Signed-off-by: Li-hao Kuo <[email protected]>
---
Changes in v3:
- Modify Theraml driver

.../bindings/thermal/sunplus_thermal.yaml | 49 ++++++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 50 insertions(+)
create mode 100644 Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml

diff --git a/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml b/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
new file mode 100644
index 0000000..e0290fa
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
@@ -0,0 +1,49 @@
+# 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
+ - const: moon4
+
+ nvmem-cells:
+ maxItems: 1
+
+ nvmem-cell-names:
+ const: therm_calib
+
+required:
+ - compatible
+ - reg
+ - reg-names
+ - 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";
+ };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 4b02628..dd1b7bf 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18246,6 +18246,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
--
2.7.4


2022-01-11 23:09:30

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH v3 2/2] devicetree: bindings THERMAL Add bindings doc for Sunplus SP7021

On Tue, Jan 04, 2022 at 10:58:57AM +0800, Li-hao Kuo wrote:
> Add devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

Complete sentences please.

For the subject:

'dt-bindings: thermal: Add Sunplus SP7021 schema'

>
> Signed-off-by: Li-hao Kuo <[email protected]>
> ---
> Changes in v3:
> - Modify Theraml driver
>
> .../bindings/thermal/sunplus_thermal.yaml | 49 ++++++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 50 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
>
> diff --git a/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml b/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
> new file mode 100644
> index 0000000..e0290fa
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
> @@ -0,0 +1,49 @@
> +# 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
> + - const: moon4

Is it 1 entry or 2? reg and reg-names don't agree. If 1, drop
'reg-names'.

> +
> + nvmem-cells:
> + maxItems: 1
> +
> + nvmem-cell-names:
> + const: therm_calib

'therm_' is redundant.

> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - 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";
> + };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 4b02628..dd1b7bf 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -18246,6 +18246,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
> --
> 2.7.4
>
>