[PATCH 0/2] Add THERMAL control driver for Sunplus SP7021 SoC

[PATCH 0/2] Add THERMAL control driver for Sunplus SP7021 SoC

[LH.Kuo]

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

LH.Kuo (2):
  THERMAL: Add THERMAL driver for Sunplus SP7021
  devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

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

-- 
2.7.4

[PATCH 1/2] THERMAL: Add THERMAL driver for Sunplus SP7021

[LH.Kuo]

Add THERMAL driver for Sunplus SP7021.

Signed-off-by: LH.Kuo <lh.kuo@sunplus.com>
---
 MAINTAINERS                       |   6 +
 drivers/thermal/Kconfig           |  10 ++
 drivers/thermal/Makefile          |   1 +
 drivers/thermal/sunplus_thermal.c | 287 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 304 insertions(+)
 create mode 100644 drivers/thermal/sunplus_thermal.c

diff --git a/MAINTAINERS b/MAINTAINERS
index 3b79fd4..dff822b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -17945,6 +17945,12 @@ L:	netdev@vger.kernel.org
 S:	Maintained
 F:	drivers/net/ethernet/dlink/sundance.c
 
+SUNPLUS THERMAL DRIVER
+M:	LH Kuo <lh.kuo@sunplus.com>
+L:	linux-pm@vger.kernel.org
+S:	Maintained
+F:	drivers/thermal/sunplus_thermal.c
+
 SUPERH
 M:	Yoshinori Sato <ysato@users.sourceforge.jp>
 M:	Rich Felker <dalias@libc.org>
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..ab17fd7
--- /dev/null
+++ b/drivers/thermal/sunplus_thermal.c
@@ -0,0 +1,287 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * SP7021 SoC thermal driver.
+ * Copyright (C) Sunplus Tech/Tibbo Tech. 2019
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <linux/cpufreq.h>
+#include <linux/delay.h>
+#include <linux/interrupt.h>
+#include <linux/io.h>
+
+#include <linux/module.h>
+#include <linux/err.h>
+#include <linux/rtc.h>
+#include <linux/platform_device.h>
+#include <linux/io.h>
+#include <linux/clk.h>
+#include <linux/reset.h>
+#include <linux/thermal.h>
+#include <linux/nvmem-consumer.h>
+
+#define DISABLE_THREMAL  (1<<31 | 1<<15)
+#define ENABLE_THREMAL  (1<<31)
+
+// thermal_sts_0 last 10 bits
+#define TEMP_MASK 0x7FF
+
+#define TEMP_RATE  608
+
+/* common data structures */
+struct sp_thermal_data {
+	struct thermal_zone_device *pcb_tz;
+	enum thermal_device_mode mode;
+	struct platform_device *pdev;
+	long sensor_temp;
+	uint32_t id;
+	void __iomem *regs;
+};
+
+struct sp_thermal_data sp_thermal;
+
+#define MOO5_REG_NAME "thermal_reg"
+#define MOO4_REG_NAME             "thermal_moon4"
+#define OTP_CALIB_REG "therm_calib"
+
+struct sp_thermal_reg {
+	unsigned int mo5_thermal_ctl0;
+	unsigned int mo5_thermal_ctl1;
+	unsigned int mo5_thermal_ctl2;
+	unsigned int mo5_thermal_ctl3;
+	unsigned int mo5_tmds_l2sw_ctl;
+	unsigned int mo5_l2sw_clksw_ctl;
+	unsigned int mo5_i2c2bus_ctl;
+	unsigned int mo5_pfcnt_ctl;
+	unsigned int mo5_pfcntl_sensor_ctl0;
+	unsigned int mo5_pfcntl_sensor_ctl1;
+	unsigned int mo5_pfcnt_sts0;
+	unsigned int mo5_pfcnt_sts1;
+	unsigned int mo5_thermal_sts0;
+	unsigned int mo5_thermal_sts1;
+	unsigned int mo5_rsv13;
+	unsigned int mo5_rsv14;
+	unsigned int mo5_rsv15;
+	unsigned int mo5_rsv16;
+	unsigned int mo5_rsv17;
+	unsigned int mo5_rsv18;
+	unsigned int mo5_rsv19;
+	unsigned int mo5_rsv20;
+	unsigned int mo5_rsv21;
+	unsigned int mo5_dc09_ctl0;
+	unsigned int mo5_dc09_ctl1;
+	unsigned int mo5_dc09_ctl2;
+	unsigned int mo5_dc12_ctl0;
+	unsigned int mo5_dc12_ctl1;
+	unsigned int mo5_dc12_ctl2;
+	unsigned int mo5_dc15_ctl0;
+	unsigned int mo5_dc15_ctl1;
+	unsigned int mo5_dc15_ctl2;
+};
+
+static struct sp_thermal_reg *thermal_reg_ptr;
+
+struct sp_ctl_reg {
+	unsigned int mo4_pllsp_ctl0;
+	unsigned int mo4_pllsp_ctl1;
+	unsigned int mo4_pllsp_ctl2;
+	unsigned int mo4_pllsp_ctl3;
+	unsigned int mo4_pllsp_ctl4;
+	unsigned int mo4_pllsp_ctl5;
+	unsigned int mo4_pllsp_ctl6;
+	unsigned int mo5_pfcnt_ctl;
+	unsigned int mo4_plla_ctl0;
+	unsigned int mo4_plla_ctl1;
+	unsigned int mo4_plla_ctl2;
+	unsigned int mo4_plla_ctl3;
+	unsigned int mo4_plla_ctl4;
+	unsigned int mo4_plle_ctl;
+	unsigned int mo4_pllf_ctl;
+	unsigned int mo4_plltv_ctl0;
+	unsigned int mo4_plltv_ctl1;
+	unsigned int mo4_plltv_ctl2;
+	unsigned int mo4_usbc_ctl;
+	unsigned int mo4_uphy0_ctl0;
+	unsigned int mo4_uphy0_ctl1;
+	unsigned int mo4_uphy0_ctl2;
+	unsigned int mo4_uphy1_ctl0;
+	unsigned int mo4_uphy1_ctl1;
+	unsigned int mo4_uphy1_ctl2;
+	unsigned int mo4_uphy1_ctl3;
+	unsigned int mo4_pllsys;
+	unsigned int mo_clk_sel0;
+	unsigned int mo_probe_sel;
+	unsigned int mo4_misc_ctl0;
+	unsigned int mo4_uphy0_sts;
+	unsigned int otp_st;
+};
+
+static struct sp_ctl_reg *sp_ctl_reg_ptr;
+
+int otp_thermal_t0;
+int otp_thermal_t1;
+
+char *sp7021_otp_coef_read(struct device *_d, ssize_t *_l)
+{
+	char *ret = NULL;
+	struct nvmem_cell *c = nvmem_cell_get(_d, OTP_CALIB_REG);
+
+	if (IS_ERR_OR_NULL(c)) {
+		dev_err(_d, "OTP read failure:%ld", PTR_ERR(c));
+		return NULL;
+	}
+	ret = nvmem_cell_read(c, _l);
+	nvmem_cell_put(c);
+	dev_dbg(_d, "%d bytes read from OTP", *_l);
+	return ret;
+}
+
+static void sp7021_get_otp_temp_coef(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;
+	dev_dbg(_d, "OTP: %d %d %d", otp_v[0], otp_v[1], otp_v[2]);
+
+	otp_thermal_t0 = otp_v[0] | (otp_v[1] << 8);
+	otp_thermal_t0 = otp_thermal_t0 & TEMP_MASK;
+	otp_thermal_t1 = (otp_v[1] >> 3) | (otp_v[2] << 5);
+	otp_thermal_t1 = otp_thermal_t1 & TEMP_MASK;
+	if (otp_thermal_t0 == 0)
+		otp_thermal_t0 = 1518;
+}
+
+static int sp_thermal_get_sensor_temp(void *_data, int *temp)
+{
+	struct sp_thermal_data *data = _data;
+	struct sp_thermal_reg *thermal_reg = data->regs;
+	int t_code;
+
+	t_code = (readl(&(thermal_reg->mo5_thermal_sts0)) & TEMP_MASK);
+	*temp = ((otp_thermal_t0 - t_code)*10000/TEMP_RATE)+3500;
+	*temp *= 10;   // milli means 10^-3!
+	dev_dbg(&(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 *_pd)
+{
+	struct sp_thermal_data *sp_data;
+	int ret;
+	struct resource *res;
+	void __iomem *reg_base;
+	void __iomem *ctl_base;
+	int ctl_code;
+
+	sp_data = devm_kzalloc(&(_pd->dev), sizeof(*sp_data), GFP_KERNEL);
+	if (!sp_data)
+		return -ENOMEM;
+
+	memset(&sp_thermal, 0, sizeof(sp_thermal));
+
+	res = platform_get_resource_byname(_pd, IORESOURCE_MEM, MOO5_REG_NAME);
+	if (IS_ERR(res)) {
+		dev_err(&(_pd->dev), "get_resource(%s) fail\n", MOO5_REG_NAME);
+		ret = PTR_ERR(res);
+		return ret;
+	}
+	reg_base = devm_ioremap(&(_pd->dev), res->start, resource_size(res));
+	if (IS_ERR(reg_base)) {
+		dev_err(&(_pd->dev), "ioremap_resource(%s) fail\n", MOO5_REG_NAME);
+		ret = PTR_ERR(res);
+		return ret;
+	}
+	sp_data->regs = reg_base;
+
+	res = platform_get_resource_byname(_pd, IORESOURCE_MEM, MOO4_REG_NAME);
+	if (IS_ERR(res)) {
+		dev_err(&(_pd->dev), "get_resource(%s) fail\n", MOO4_REG_NAME);
+		ret = PTR_ERR(res);
+		return ret;
+	}
+	ctl_base = devm_ioremap(&(_pd->dev), res->start, resource_size(res));
+	if (IS_ERR(reg_base)) {
+		dev_err(&(_pd->dev), "ioremap_resource(%s) fail\n", MOO4_REG_NAME);
+		ret = PTR_ERR(res);
+		return ret;
+	}
+
+	dev_dbg(&(_pd->dev), "reg:%p ctl:%p\n", reg_base, ctl_base);
+
+	thermal_reg_ptr = (struct sp_thermal_reg *)(reg_base);
+	sp_ctl_reg_ptr = (struct sp_ctl_reg *)(ctl_base);
+
+	// FIXME: enable thermal function - customize this part
+	writel(ENABLE_THREMAL, &(thermal_reg_ptr->mo5_thermal_ctl0));
+	// FIXME: it's just reg state. Clock enabled at different place
+	ctl_code = 0xFFFF & readl(&(sp_ctl_reg_ptr->mo_clk_sel0));
+	// writel(0x78F07810 , &sp_ctl_reg_ptr->mo_clk_sel0);  // enable thermal function
+	dev_dbg(&(_pd->dev), "ctl_code %x ", ctl_code);
+
+	platform_set_drvdata(_pd, sp_data);
+	sp7021_get_otp_temp_coef(&(_pd->dev));
+	ret = sp_thermal_register_sensor(_pd, sp_data, 0);
+	if (ret == 0)
+		dev_info(&(_pd->dev), "by Sunplus (C) 2020");
+	return ret;
+}
+
+static int sp7021_thermal_remove(struct platform_device *_pd)
+{
+	// nothing to do case devm_*
+	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("lH Kuo <lh.kuo@sunplus.com>");
+MODULE_DESCRIPTION("Thermal driver for SP7021 SoC");
+MODULE_LICENSE("GPL v2");
-- 
2.7.4

[PATCH 2/2] devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

[LH.Kuo]

Add devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

Signed-off-by: LH.Kuo <lh.kuo@sunplus.com>
---
 .../bindings/thermal/sunplus_thermal.yaml          | 52 ++++++++++++++++++++++
 MAINTAINERS                                        |  1 +
 2 files changed, 53 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..1875d04
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (C) Sunplus Co., Ltd. 2021
+%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:
+  - lh.kuo <lh.kuo@sunplus.com>
+
+properties:
+  compatible:
+    enum:
+      - sunplus,sp7021-thermal
+
+  reg:
+    items:
+      - description: Base address and length of the Thermal registers
+      - description: Base address and length of the Thermal calibration registers
+
+  reg-names:
+    items:
+      - const: thermal_reg
+      - const: thermal_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: serial@9c000280 {
+        compatible = "sunplus,sp7021-thermal";
+        reg = <0x9c000280 0x80>, <0x9c000200 0x80>;
+        reg-names = "thermal_reg", "thermal_moon4";
+        nvmem-cells = <&therm_calib>;
+        nvmem-cell-names = "therm_calib";
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index dff822b..2080b00 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -17949,6 +17949,7 @@ SUNPLUS THERMAL DRIVER
 M:	LH Kuo <lh.kuo@sunplus.com>
 L:	linux-pm@vger.kernel.org
 S:	Maintained
+F:	Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
 F:	drivers/thermal/sunplus_thermal.c
 
 SUPERH
-- 
2.7.4

Re: [PATCH 2/2] devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

[Rob Herring]

On Mon, Nov 01, 2021 at 04:45:10PM +0800, LH.Kuo wrote:
> Add devicetree bindings THERMAL Add bindings doc for Sunplus SP7021

Not a complete sentence.

Write subject lines matching 'git log --oneline' of the 
directory/subsystem your change is in.

> 
> Signed-off-by: LH.Kuo <lh.kuo@sunplus.com>
> ---
>  .../bindings/thermal/sunplus_thermal.yaml          | 52 ++++++++++++++++++++++
>  MAINTAINERS                                        |  1 +
>  2 files changed, 53 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..1875d04
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright (C) Sunplus Co., Ltd. 2021
> +%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:
> +  - lh.kuo <lh.kuo@sunplus.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sunplus,sp7021-thermal
> +
> +  reg:
> +    items:
> +      - description: Base address and length of the Thermal registers
> +      - description: Base address and length of the Thermal calibration registers
> +
> +  reg-names:
> +    items:
> +      - const: thermal_reg
> +      - const: thermal_moon4

thermal_ is redundant.

> +
> +  nvmem-cells:
> +    maxItems: 1
> +
> +  nvmem-cell-names:
> +    const: therm_calib
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - nvmem-cells
> +  - nvmem-cell-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    thermal: serial@9c000280 {

Drop unused labels.

> +        compatible = "sunplus,sp7021-thermal";
> +        reg = <0x9c000280 0x80>, <0x9c000200 0x80>;
> +        reg-names = "thermal_reg", "thermal_moon4";
> +        nvmem-cells = <&therm_calib>;
> +        nvmem-cell-names = "therm_calib";
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index dff822b..2080b00 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -17949,6 +17949,7 @@ SUNPLUS THERMAL DRIVER
>  M:	LH Kuo <lh.kuo@sunplus.com>
>  L:	linux-pm@vger.kernel.org
>  S:	Maintained
> +F:	Documentation/devicetree/bindings/thermal/sunplus_thermal.yaml
>  F:	drivers/thermal/sunplus_thermal.c
>  
>  SUPERH
> -- 
> 2.7.4
> 
>