[PATCH] dt-bindings: thermal: kirkwood-thermal: Convert to DT Schema

[PATCH] dt-bindings: thermal: kirkwood-thermal: Convert to DT Schema

[Shaunak Datar]

Convert the Kirkwood thermal binding from the legacy text format to YAML
schema to enable validation with dtbs_check.

Signed-off-by: Shaunak Datar <shaunakkdatar@gmail.com>
---
 .../bindings/thermal/kirkwood-thermal.txt     | 15 ---------
 .../bindings/thermal/kirkwood-thermal.yaml    | 32 +++++++++++++++++++
 2 files changed, 32 insertions(+), 15 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/thermal/kirkwood-thermal.txt
 create mode 100644 Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml

diff --git a/Documentation/devicetree/bindings/thermal/kirkwood-thermal.txt b/Documentation/devicetree/bindings/thermal/kirkwood-thermal.txt
deleted file mode 100644
index 8c0f5eb86da7..000000000000
--- a/Documentation/devicetree/bindings/thermal/kirkwood-thermal.txt
+++ /dev/null
@@ -1,15 +0,0 @@
-* Kirkwood Thermal
-
-This version is for Kirkwood 88F8262 & 88F6283 SoCs. Other kirkwoods
-don't contain a thermal sensor.
-
-Required properties:
-- compatible : "marvell,kirkwood-thermal"
-- reg : Address range of the thermal registers
-
-Example:
-
-	thermal@10078 {
-		compatible = "marvell,kirkwood-thermal";
-		reg = <0x10078 0x4>;
-	};
diff --git a/Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml b/Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml
new file mode 100644
index 000000000000..1f9b97bdd48f
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml
@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/kirkwood-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Kirkwood Thermal
+
+maintainers: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
+
+description:
+  Thermal sensor present in the Marvell Kirkwood 88F8262 and 88F6283 SoCs.
+
+properties:
+  compatible:
+    const: marvell,kirkwood-thermal
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    thermal@10078 {
+        compatible = "marvell,kirkwood-thermal";
+        reg = <0x10078 0x4>;
+    };
\ No newline at end of file
-- 
2.53.0

Re: [PATCH] dt-bindings: thermal: kirkwood-thermal: Convert to DT Schema

[sashiko-bot]

Thank you for your contribution! Sashiko AI review found 3 potential
issues to consider:
- [Medium] dt-bindings: thermal: scalar maintainers string breaks schema
  validation
- [Low] dt-bindings: thermal: missing newline at end of
  kirkwood-thermal.yaml
- [Low] dt-bindings: thermal: kirkwood-thermal.yaml filename omits
  vendor prefix
--

commit 70c9f13751a18e94c7372bae17a84a1ba365709a
Author: Shaunak Datar <shaunakkdatar@gmail.com>

dt-bindings: thermal: kirkwood-thermal: Convert to DT Schema

This commit converts the Marvell Kirkwood thermal sensor device tree
binding from plain text to a YAML schema.

> diff --git a/Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml b/Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml
> new file mode 100644
> index 0000000000000..1f9b97bdd48fa
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/kirkwood-thermal.yaml
> @@ -0,0 +1,32 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/kirkwood-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#

[Severity: Low]
Should this file and its $id URI be named marvell,kirkwood-thermal.yaml to
match the compatible string and the vendor,device.yaml convention used by
sibling Marvell thermal bindings?

> +
> +title: Kirkwood Thermal
> +
> +maintainers: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>

[Severity: Medium]
Does defining maintainers as a scalar string instead of a YAML list cause
make dt_binding_check to fail?  core.yaml requires maintainers to be an
array, so dt-doc-validate rejects this schema and dtbs_check skips it.

[ ... ]

> +examples:
> +  - |
> +    thermal@10078 {
> +        compatible = "marvell,kirkwood-thermal";
> +        reg = <0x10078 0x4>;
> +    };
> \ No newline at end of file

[Severity: Low]
Does the missing newline at the end of the file cause yamllint to fail
during make dt_binding_check?

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261112072925.22075-1-shaunakkdatar@gmail.com?part=1