Skip to contentSkip to conversation

dt-bindings: fpga: altr,socfpga-fpga-mgr: convert to DT schema

PATCH Superseded Manish Baing 3 participants 3 messages May 12 – May 13

Subsystems (2)
Device tree bindings FPGA manager framework

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Manish Baing

author
#0 lore raw

PATCH 1/1 dt-bindings: fpga: altr,socfpga-fpga-mgr: convert to DT schema

Convert the Altera SoCFPGA FPGA Manager bindings from text format to YAML schema.

Signed-off-by Manish Baing <[email protected]>
---
 .../bindings/fpga/altera-socfpga-fpga-mgr.txt | 17 --------
 .../bindings/fpga/altr,socfpga-fpga-mgr.yaml  | 39 +++++++++++++++++++
 2 files changed, 39 insertions(+), 17 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/fpga/altera-socfpga-fpga-mgr.txt
 create mode 100644 Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml
Documentation/devicetree/bindings/fpga/altera-socfpga-fpga-mgr.txt deleted +0 -17
deleted file mode 100644
index d52f3340414d..000000000000
@@ -1,17 +0,0 @@
-Altera SOCFPGA FPGA Manager
-
-Required properties:
-- compatible : should contain "altr,socfpga-fpga-mgr"
-- reg        : base address and size for memory mapped io.
-               - The first index is for FPGA manager register access.
-               - The second index is for writing FPGA configuration data.
-- interrupts : interrupt for the FPGA Manager device.
-
-Example:
-
-	hps_0_fpgamgr: fpgamgr@ff706000 {
-		compatible = "altr,socfpga-fpga-mgr";
-		reg = <0xFF706000 0x1000
-		       0xFFB90000 0x1000>;
-		interrupts = <0 175 4>;
-	};
Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml new file +39 -0
new file mode 100644
index 000000000000..d09d552dde5e
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fpga/altr,socfpga-fpga-mgr.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Altera SOCFPGA FPGA Manager
+
+maintainers:
+  - Steffen Trumtrar <[email protected]>
+  - Rob Herring <[email protected]>
+
+properties:
+  compatible:
+    const: altr,socfpga-fpga-mgr
+
+  reg:
+    items:
+      - description: FPGA manager register access
+      - description: Writing FPGA configuration data
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    fpgamgr@ff706000 {
+        compatible = "altr,socfpga-fpga-mgr";
+        reg = <0xff706000 0x1000>,
+              <0xffb90000 0x1000>;
+        interrupts = <0 175 4>;
+    };
Signature · 1 line
2.43.0
#1 lore raw
Quoted 41 lines · Manish Baing

Convert the Altera SoCFPGA FPGA Manager bindings from text format to YAML schema.

Signed-off-by Manish Baing <[email protected]>
---
 .../bindings/fpga/altera-socfpga-fpga-mgr.txt | 17 --------
 .../bindings/fpga/altr,socfpga-fpga-mgr.yaml  | 39 +++++++++++++++++++
 2 files changed, 39 insertions(+), 17 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/fpga/altera-socfpga-fpga-mgr.txt
 create mode 100644 Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml
Documentation/devicetree/bindings/fpga/altera-socfpga-fpga-mgr.txt deleted +0 -17
deleted file mode 100644
index d52f3340414d..000000000000
@@ -1,17 +0,0 @@
-Altera SOCFPGA FPGA Manager
-
-Required properties:
-- compatible : should contain "altr,socfpga-fpga-mgr"
-- reg        : base address and size for memory mapped io.
-               - The first index is for FPGA manager register access.
-               - The second index is for writing FPGA configuration data.
-- interrupts : interrupt for the FPGA Manager device.
-
-Example:
-
-	hps_0_fpgamgr: fpgamgr@ff706000 {
-		compatible = "altr,socfpga-fpga-mgr";
-		reg = <0xFF706000 0x1000
-		       0xFFB90000 0x1000>;
-		interrupts = <0 175 4>;
-	};
Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml new file +1 -0
new file mode 100644
index 000000000000..d09d552dde5e
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml line 11

Quoted 10 lines
Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml new file +10 -0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fpga/altr,socfpga-fpga-mgr.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Altera SOCFPGA FPGA Manager
+
+maintainers:
+  - Steffen Trumtrar <[email protected]>
+  - Rob Herring <[email protected]>

Why's Rob a maintainer here? Doubt he cares about this device.

Otherwise this looks okay.

Quoted 31 lines
Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml new file +28 -0
+
+properties:
+  compatible:
+    const: altr,socfpga-fpga-mgr
+
+  reg:
+    items:
+      - description: FPGA manager register access
+      - description: Writing FPGA configuration data
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    fpgamgr@ff706000 {
+        compatible = "altr,socfpga-fpga-mgr";
+        reg = <0xff706000 0x1000>,
+              <0xffb90000 0x1000>;
+        interrupts = <0 175 4>;
+    };
Signature · 1 line
2.43.0
AI review
#2 lore raw
In reply to Manish Baing
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Low] The 'maintainers' list incorrectly includes Steffen Trumtrar and Rob Herring. --

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The 'maintainers' list incorrectly includes Steffen Trumtrar and Rob Herring. --

commit be1c0ecc6a9857f9aa82bd84bf85fccfa1cb035c
Author: Manish Baing <[email protected]>

dt-bindings: fpga: altr,socfpga-fpga-mgr: convert to DT schema

This commit converts the Altera SoCFPGA FPGA Manager bindings from the legacy text format to a YAML schema.

[ ... ]

Quoted 7 lines
Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml new file +1 -0
new file mode 100644
index 0000000000000..d09d552dde5e9
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml line 11

Quoted 10 lines
Documentation/devicetree/bindings/fpga/altr,socfpga-fpga-mgr.yaml new file +10 -0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fpga/altr,socfpga-fpga-mgr.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Altera SOCFPGA FPGA Manager
+
+maintainers:
+  - Steffen Trumtrar <[email protected]>
+  - Rob Herring <[email protected]>

Are these the intended maintainers for this specific binding?

Steffen Trumtrar does not appear to be the original author of the text binding, and is not listed in the MAINTAINERS file for the FPGA manager framework or the Altera SOCFPGA architecture.

Additionally, while Rob Herring is the general Devicetree maintainer, the general guidance is to avoid listing him as the dedicated maintainer for specific vendor schemas unless he authored them.

Would it be better to list the FPGA subsystem maintainers (such as Moritz Fischer or Xu Yilun) or the original author of the text binding here so the get_maintainer.pl script routes queries to the right people?

[ ... ]

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1