Linux-SPI Archive mirror
 help / color / mirror / Atom feed
From: Eddie James <eajames@linux.ibm.com>
To: linux-aspeed@lists.ozlabs.org
Cc: eajames@linux.ibm.com, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-fsi@lists.ozlabs.org,
	linux-spi@vger.kernel.org, linux-i2c@vger.kernel.org,
	lakshmiy@us.ibm.com, robh@kernel.org, krzk+dt@kernel.org,
	conor+dt@kernel.org, joel@jms.id.au, andrew@codeconstruct.com.au,
	andi.shyti@kernel.org
Subject: [PATCH v4 08/17] dt-bindings: fsi: ast2600-fsi-master: Convert to json-schema
Date: Mon, 29 Apr 2024 16:01:22 -0500	[thread overview]
Message-ID: <20240429210131.373487-9-eajames@linux.ibm.com> (raw)
In-Reply-To: <20240429210131.373487-1-eajames@linux.ibm.com>

Convert to json-schema for the AST2600 FSI master documentation.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
Changes since v3:
 - Remove quotes around compatible strings
 - Re-order allOf to below required
 - Add child node in the example
 - Change commit message to match similar commits

 .../fsi/aspeed,ast2600-fsi-master.yaml        | 81 +++++++++++++++++++
 .../bindings/fsi/fsi-master-aspeed.txt        | 36 ---------
 2 files changed, 81 insertions(+), 36 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/fsi/aspeed,ast2600-fsi-master.yaml
 delete mode 100644 Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt

diff --git a/Documentation/devicetree/bindings/fsi/aspeed,ast2600-fsi-master.yaml b/Documentation/devicetree/bindings/fsi/aspeed,ast2600-fsi-master.yaml
new file mode 100644
index 000000000000..fcf7c4b93b78
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/aspeed,ast2600-fsi-master.yaml
@@ -0,0 +1,81 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fsi/aspeed,ast2600-fsi-master.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Aspeed FSI master
+
+maintainers:
+  - Eddie James <eajames@linux.ibm.com>
+
+description:
+  The AST2600 and later contain two identical FSI masters. They share a
+  clock and have a separate interrupt line and output pins.
+
+properties:
+  compatible:
+    enum:
+      - aspeed,ast2600-fsi-master
+      - aspeed,ast2700-fsi-master
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  cfam-reset-gpios:
+    maxItems: 1
+    description:
+      Output GPIO pin for CFAM reset
+
+  fsi-routing-gpios:
+    maxItems: 1
+    description:
+      Output GPIO pin for setting the FSI mux (internal or cabled)
+
+  fsi-mux-gpios:
+    maxItems: 1
+    description:
+      Input GPIO pin for detecting the desired FSI mux state
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+allOf:
+  - $ref: fsi-controller.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/ast2600-clock.h>
+    #include <dt-bindings/gpio/aspeed-gpio.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    fsi-master@1e79b000 {
+        compatible = "aspeed,ast2600-fsi-master";
+        reg = <0x1e79b000 0x94>;
+        #address-cells = <2>;
+        #size-cells = <0>;
+        interrupts = <GIC_SPI 100 IRQ_TYPE_LEVEL_HIGH>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_fsi1_default>;
+        clocks = <&syscon ASPEED_CLK_GATE_FSICLK>;
+        fsi-routing-gpios = <&gpio0 ASPEED_GPIO(Q, 7) GPIO_ACTIVE_HIGH>;
+        fsi-mux-gpios = <&gpio0 ASPEED_GPIO(B, 0) GPIO_ACTIVE_HIGH>;
+        cfam-reset-gpios = <&gpio0 ASPEED_GPIO(Q, 0) GPIO_ACTIVE_LOW>;
+
+        cfam@0,0 {
+            reg = <0 0>;
+            #address-cells = <1>;
+            #size-cells = <1>;
+            chip-id = <0>;
+        };
+    };
diff --git a/Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt b/Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt
deleted file mode 100644
index 9853fefff5d8..000000000000
--- a/Documentation/devicetree/bindings/fsi/fsi-master-aspeed.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-Device-tree bindings for AST2600 FSI master
--------------------------------------------
-
-The AST2600 contains two identical FSI masters. They share a clock and have a
-separate interrupt line and output pins.
-
-Required properties:
- - compatible: "aspeed,ast2600-fsi-master"
- - reg: base address and length
- - clocks: phandle and clock number
- - interrupts: platform dependent interrupt description
- - pinctrl-0: phandle to pinctrl node
- - pinctrl-names: pinctrl state
-
-Optional properties:
- - cfam-reset-gpios: GPIO for CFAM reset
-
- - fsi-routing-gpios: GPIO for setting the FSI mux (internal or cabled)
- - fsi-mux-gpios: GPIO for detecting the desired FSI mux state
-
-
-Examples:
-
-    fsi-master {
-        compatible = "aspeed,ast2600-fsi-master", "fsi-master";
-        reg = <0x1e79b000 0x94>;
-	interrupts = <GIC_SPI 100 IRQ_TYPE_LEVEL_HIGH>;
-	pinctrl-names = "default";
-	pinctrl-0 = <&pinctrl_fsi1_default>;
-	clocks = <&syscon ASPEED_CLK_GATE_FSICLK>;
-
-	fsi-routing-gpios = <&gpio0 ASPEED_GPIO(Q, 7) GPIO_ACTIVE_HIGH>;
-	fsi-mux-gpios = <&gpio0 ASPEED_GPIO(B, 0) GPIO_ACTIVE_HIGH>;
-
-	cfam-reset-gpios = <&gpio0 ASPEED_GPIO(Q, 0) GPIO_ACTIVE_LOW>;
-    };
-- 
2.39.3


  parent reply	other threads:[~2024-04-29 21:01 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-29 21:01 [PATCH v4 00/17] ARM: dts: aspeed: Add IBM P11 BMC Boards Eddie James
2024-04-29 21:01 ` [PATCH v4 01/17] spi: dt-bindings: Document the IBM FSI-attached SPI controller Eddie James
2024-04-30  6:50   ` Krzysztof Kozlowski
2024-04-29 21:01 ` [PATCH v4 02/17] dt-bindings: fsi: fsi2spi: Document SPI controller child nodes Eddie James
2024-04-30  6:51   ` Krzysztof Kozlowski
2024-04-29 21:01 ` [PATCH v4 03/17] dt-bindings: fsi: Document the IBM SCOM engine Eddie James
2024-04-29 21:01 ` [PATCH v4 04/17] dt-bindings: fsi: p9-occ: Convert to json-schema Eddie James
2024-04-30  6:53   ` Krzysztof Kozlowski
2024-05-01 15:59     ` Eddie James
2024-05-04 11:50       ` Krzysztof Kozlowski
2024-04-29 21:01 ` [PATCH v4 05/17] dt-bindings: fsi: Document the IBM SBEFIFO engine Eddie James
2024-04-30  6:54   ` Krzysztof Kozlowski
2024-05-01 16:03     ` Eddie James
2024-04-29 21:01 ` [PATCH v4 06/17] dt-bindings: fsi: Document the FSI controller common properties Eddie James
2024-04-30  7:01   ` Krzysztof Kozlowski
2024-05-01 16:06     ` Eddie James
2024-04-29 21:01 ` [PATCH v4 07/17] dt-bindings: fsi: ibm,i2cr-fsi-master: Reference common FSI controller Eddie James
2024-04-30  7:02   ` Krzysztof Kozlowski
2024-04-29 21:01 ` Eddie James [this message]
2024-04-30  7:04   ` [PATCH v4 08/17] dt-bindings: fsi: ast2600-fsi-master: Convert to json-schema Krzysztof Kozlowski
2024-05-01 16:12     ` Eddie James
2024-05-04 11:55       ` Krzysztof Kozlowski
2024-05-14 15:38         ` Eddie James
2024-04-29 21:01 ` [PATCH v4 09/17] dt-bindings: fsi: Document the FSI Hub Controller Eddie James
2024-04-30  7:31   ` Krzysztof Kozlowski
2024-04-29 21:01 ` [PATCH v4 10/17] dt-bindings: i2c: i2c-fsi: Convert to json-schema Eddie James
2024-04-30  7:35   ` Krzysztof Kozlowski
2024-05-01 16:16     ` Eddie James
2024-05-02 12:58       ` Krzysztof Kozlowski
2024-04-29 21:01 ` [PATCH v4 11/17] dt-bindings: arm: aspeed: add IBM P11 BMC boards Eddie James
2024-04-30  7:35   ` Krzysztof Kozlowski
2024-04-29 21:01 ` [PATCH v4 12/17] ARM: dts: aspeed: Add IBM P11 FSI devices Eddie James
2024-04-29 21:01 ` [PATCH v4 13/17] ARM: dts: aspeed: Add IBM P11 Blueridge BMC system Eddie James
2024-04-29 21:01 ` [PATCH v4 14/17] ARM: dts: aspeed: Add IBM P11 Fuji " Eddie James
2024-04-29 21:01 ` [PATCH v4 15/17] fsi: occ: Get device number from FSI minor number API Eddie James
2024-04-29 21:01 ` [PATCH v4 16/17] fsi: occ: Find next available child rather than node name match Eddie James
2024-04-29 21:01 ` [PATCH v4 17/17] fsi: scom: Update compatible string to match documentation Eddie James
2024-04-30  7:37   ` Krzysztof Kozlowski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240429210131.373487-9-eajames@linux.ibm.com \
    --to=eajames@linux.ibm.com \
    --cc=andi.shyti@kernel.org \
    --cc=andrew@codeconstruct.com.au \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=joel@jms.id.au \
    --cc=krzk+dt@kernel.org \
    --cc=lakshmiy@us.ibm.com \
    --cc=linux-aspeed@lists.ozlabs.org \
    --cc=linux-fsi@lists.ozlabs.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-spi@vger.kernel.org \
    --cc=robh@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).