Skip to contentSkip to conversation

spi: dt-bindings: octeon: Convert to DT schema

PATCH In review Ninad Naik 4 participants 4 messages Jun 18 – Jun 30

Subsystems (2)
lore
Share & tools
lore

Ninad Naik

author
#0 lore raw

PATCH v3 1/1 spi: dt-bindings: octeon: Convert to DT schema

Convert octeon-3010 to DT schema

---
Changes in v3:
- Change the maintainer from David Daney to Rob Herring

Changes in v2:
- Change the maintainer from Mark Brown to David Daney.
- Use soc node wrapper instead of root node in the example to handle address-cells and size-cells requirements.
- Remove interrupt controller provider from the example.

 .../bindings/spi/cavium,octeon-3010-spi.yaml  | 61 +++++++++++++++++++
 .../devicetree/bindings/spi/spi-octeon.txt    | 33 ----------
 2 files changed, 61 insertions(+), 33 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/spi/cavium,octeon-3010-spi.yaml
 delete mode 100644 Documentation/devicetree/bindings/spi/spi-octeon.txt
Documentation/devicetree/bindings/spi/cavium,octeon-3010-spi.yaml new file +61 -0
new file mode 100644
index 000000000000..f0b708e1ccbb
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/cavium,octeon-3010-spi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cavium, Inc. OCTEON SoC SPI master controller
+
+description:
+  The Cavium OCTEON SPI controller is an SPI master controller found in
+  OCTEON SoCs.
+
+maintainers:
+  - Rob Herring <[email protected]>
+
+allOf:
+  - $ref: spi-controller.yaml#
+
+properties:
+  compatible:
+    const: cavium,octeon-3010-spi
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        spi@1070000001000 {
+            compatible = "cavium,octeon-3010-spi";
+            reg = <0x10700 0x00001000 0x0 0x100>;
+            interrupts = <0 58>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            eeprom@0 {
+                compatible = "st,m95256", "atmel,at25";
+                reg = <0>;
+                spi-max-frequency = <5000000>;
+                spi-cpha;
+                spi-cpol;
+                pagesize = <64>;
+                size = <32768>;
+                address-width = <16>;
+            };
+        };
+    };
+...
Documentation/devicetree/bindings/spi/spi-octeon.txt deleted +0 -33
deleted file mode 100644
index 431add192342..000000000000
@@ -1,33 +0,0 @@
-Cavium, Inc. OCTEON SOC SPI master controller.
-
-Required properties:
-- compatible : "cavium,octeon-3010-spi"
-- reg : The register base for the controller.
-- interrupts : One interrupt, used by the controller.
-- #address-cells : <1>, as required by generic SPI binding.
-- #size-cells : <0>, also as required by generic SPI binding.
-
-Child nodes as per the generic SPI binding.
-
-Example:
-
-	spi@1070000001000 {
-		compatible = "cavium,octeon-3010-spi";
-		reg = <0x10700 0x00001000 0x0 0x100>;
-		interrupts = <0 58>;
-		#address-cells = <1>;
-		#size-cells = <0>;
-
-		eeprom@0 {
-			compatible = "st,m95256", "atmel,at25";
-			reg = <0>;
-			spi-max-frequency = <5000000>;
-			spi-cpha;
-			spi-cpol;
-
-			pagesize = <64>;
-			size = <32768>;
-			address-width = <16>;
-		};
-	};
-
Signature · 1 line
2.54.0
#1 lore raw
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Low] Incorrect maintainer attribution in the converted devicetree binding. --

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] Incorrect maintainer attribution in the converted devicetree binding. --

commit 4c13bfaa3139030f2d12bf30e37ab22833e428f3
Author: Ninad Naik <[email protected]>

spi: dt-bindings: octeon: Convert to DT schema

This commit converts the devicetree bindings for the Cavium OCTEON 3010 SPI controller from plain text format to YAML schema.

Quoted 6 lines
Documentation/devicetree/bindings/spi/cavium,octeon-3010-spi.yaml new file +0 -0
new file mode 100644
index 0000000000000..f0b708e1ccbbf
@@ -0,0 +1,61 @@

[ ... ]

Documentation/devicetree/bindings/spi/cavium,octeon-3010-spi.yaml line 14

Quoted 8 lines
Documentation/devicetree/bindings/spi/cavium,octeon-3010-spi.yaml new file +8 -0
+title: Cavium, Inc. OCTEON SoC SPI master controller
+
+description:
+  The Cavium OCTEON SPI controller is an SPI master controller found in
+  OCTEON SoCs.
+
+maintainers:
+  - Rob Herring <[email protected]>

[Severity: Low]
Is Rob Herring the intended maintainer for this specific hardware binding?

Typically during text-to-yaml conversions, it is preferred to list the actual hardware maintainer, platform maintainer, or the patch author here rather than the core devicetree maintainer. This ensures get_maintainer.pl routes future hardware-specific queries and patches correctly without sending unnecessary mail to the core devicetree maintainers.

Quoted 3 lines
Documentation/devicetree/bindings/spi/cavium,octeon-3010-spi.yaml new file +3 -0
+
+allOf:
+  - $ref: spi-controller.yaml#

[ ... ]

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
maintainer
#3 lore raw
In reply to Ninad Naik
Quoted 1 line · Ninad Naik

spi: dt-bindings: octeon: Convert to DT schema

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-7.3

Thanks!

[1/1] spi: dt-bindings: octeon: Convert to DT schema

      https://git.kernel.org/broonie/spi/c/cb8c374a632b

All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying to this mail.

Thanks,
Mark