All of lore.kernel.org
 help / color / mirror / Atom feed
From: Eddie James <eajames@linux.ibm.com>
To: linux-aspeed@lists.ozlabs.org
Subject: [PATCH v3 08/14] dt-bindings: fsi: ast2600-fsi-master: Switch to yaml format
Date: Thu, 25 Apr 2024 16:36:55 -0500	[thread overview]
Message-ID: <20240425213701.655540-9-eajames@linux.ibm.com> (raw)
In-Reply-To: <20240425213701.655540-1-eajames@linux.ibm.com>

Switch to yaml for the AST2600 FSI master documentation.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
 .../fsi/aspeed,ast2600-fsi-master.yaml        | 72 +++++++++++++++++++
 .../bindings/fsi/fsi-master-aspeed.txt        | 36 ----------
 2 files changed, 72 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..f053e3e1d259
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/aspeed,ast2600-fsi-master.yaml
@@ -0,0 +1,72 @@
+# 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
+
+allOf:
+  - $ref: fsi-controller.yaml#
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+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 at 1e79b000 {
+        compatible = "aspeed,ast2600-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>;
+    };
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


WARNING: multiple messages have this Message-ID (diff)
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
Subject: [PATCH v3 08/14] dt-bindings: fsi: ast2600-fsi-master: Switch to yaml format
Date: Thu, 25 Apr 2024 16:36:55 -0500	[thread overview]
Message-ID: <20240425213701.655540-9-eajames@linux.ibm.com> (raw)
In-Reply-To: <20240425213701.655540-1-eajames@linux.ibm.com>

Switch to yaml for the AST2600 FSI master documentation.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
 .../fsi/aspeed,ast2600-fsi-master.yaml        | 72 +++++++++++++++++++
 .../bindings/fsi/fsi-master-aspeed.txt        | 36 ----------
 2 files changed, 72 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..f053e3e1d259
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/aspeed,ast2600-fsi-master.yaml
@@ -0,0 +1,72 @@
+# 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
+
+allOf:
+  - $ref: fsi-controller.yaml#
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+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>;
+        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>;
+    };
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-25 21:36 UTC|newest]

Thread overview: 98+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-25 21:36 [PATCH v3 00/14] ARM: dts: aspeed: Add IBM P11 BMC Boards Eddie James
2024-04-25 21:36 ` Eddie James
2024-04-25 21:36 ` [PATCH v3 01/14] dt-bindings: spi: Document the IBM Power SPI controller Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-25 23:39   ` Rob Herring
2024-04-25 23:39     ` Rob Herring
2024-04-26  6:15   ` Krzysztof Kozlowski
2024-04-26  6:15     ` Krzysztof Kozlowski
2024-04-26 14:49     ` Eddie James
2024-04-26 14:49       ` Eddie James
2024-04-28 16:39       ` Krzysztof Kozlowski
2024-04-28 16:39         ` Krzysztof Kozlowski
2024-04-29 14:38         ` Eddie James
2024-04-29 14:38           ` Eddie James
2024-04-29 18:17           ` Krzysztof Kozlowski
2024-04-29 18:17             ` Krzysztof Kozlowski
2024-04-25 21:36 ` [PATCH v3 02/14] dt-bindings: fsi: fsi2spi: Document SPI controller child nodes Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-25 21:36 ` [PATCH v3 03/14] dt-bindings: fsi: Document the FSI2PIB engine Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-26  6:17   ` Krzysztof Kozlowski
2024-04-26  6:17     ` Krzysztof Kozlowski
2024-04-26  6:18   ` Krzysztof Kozlowski
2024-04-26  6:18     ` Krzysztof Kozlowski
2024-04-26 15:00     ` Eddie James
2024-04-26 15:00       ` Eddie James
2024-04-28 16:41       ` Krzysztof Kozlowski
2024-04-28 16:41         ` Krzysztof Kozlowski
2024-04-29 14:42         ` Eddie James
2024-04-29 14:42           ` Eddie James
2024-04-25 21:36 ` [PATCH v3 04/14] dt-bindings: fsi: p9-occ: Switch to yaml format Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-26  6:19   ` Krzysztof Kozlowski
2024-04-26  6:19     ` Krzysztof Kozlowski
2024-04-26 15:05     ` Eddie James
2024-04-26 15:05       ` Eddie James
2024-04-25 21:36 ` [PATCH v3 05/14] dt-bindings: fsi: Document the IBM SBEFIFO engine Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-26  6:20   ` Krzysztof Kozlowski
2024-04-26  6:20     ` Krzysztof Kozlowski
2024-04-26 15:09     ` Eddie James
2024-04-26 15:09       ` Eddie James
2024-04-25 21:36 ` [PATCH v3 06/14] dt-bindings: fsi: Document the FSI controller common properties Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-25 23:40   ` Rob Herring
2024-04-25 23:40     ` Rob Herring
2024-04-26  6:23   ` Krzysztof Kozlowski
2024-04-26  6:23     ` Krzysztof Kozlowski
2024-04-26 15:11     ` Eddie James
2024-04-26 15:11       ` Eddie James
2024-04-25 21:36 ` [PATCH v3 07/14] dt-bindings: fsi: ibm,i2cr-fsi-master: Reference common FSI controller Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-25 21:36 ` Eddie James [this message]
2024-04-25 21:36   ` [PATCH v3 08/14] dt-bindings: fsi: ast2600-fsi-master: Switch to yaml format Eddie James
2024-04-26  6:25   ` Krzysztof Kozlowski
2024-04-26  6:25     ` Krzysztof Kozlowski
2024-04-26 15:13     ` Eddie James
2024-04-26 15:13       ` Eddie James
2024-04-26 18:43       ` Rob Herring
2024-04-26 18:43         ` Rob Herring
2024-04-25 21:36 ` [PATCH v3 09/14] dt-bindings: fsi: Document the FSI Hub Controller Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-26  6:26   ` Krzysztof Kozlowski
2024-04-26  6:26     ` Krzysztof Kozlowski
2024-04-26 15:19     ` Eddie James
2024-04-26 15:19       ` Eddie James
2024-04-28 16:43       ` Krzysztof Kozlowski
2024-04-28 16:43         ` Krzysztof Kozlowski
2024-04-25 21:36 ` [PATCH v3 10/14] dt-bindings: i2c: i2c-fsi: Switch to yaml format Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-26  0:21   ` kernel test robot
2024-04-26  0:21     ` kernel test robot
2024-04-26  6:29   ` Krzysztof Kozlowski
2024-04-26  6:29     ` Krzysztof Kozlowski
2024-04-26 15:23     ` Eddie James
2024-04-26 15:23       ` Eddie James
2024-04-25 21:36 ` [PATCH v3 11/14] dt-bindings: arm: aspeed: add IBM P11 BMC boards Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-25 21:36 ` [PATCH v3 12/14] ARM: dts: aspeed: Add IBM P11 FSI devices Eddie James
2024-04-25 21:36   ` Eddie James
2024-04-26  6:31   ` Krzysztof Kozlowski
2024-04-26  6:31     ` Krzysztof Kozlowski
2024-04-26 13:18     ` Eddie James
2024-04-26 13:18       ` Eddie James
2024-04-28 16:39       ` Krzysztof Kozlowski
2024-04-28 16:39         ` Krzysztof Kozlowski
2024-04-25 21:37 ` [PATCH v3 13/14] ARM: dts: aspeed: Add IBM P11 Blueridge BMC system Eddie James
2024-04-25 21:37   ` Eddie James
2024-04-26  6:35   ` Krzysztof Kozlowski
2024-04-26  6:35     ` Krzysztof Kozlowski
2024-04-26 13:22     ` Eddie James
2024-04-26 13:22       ` Eddie James
2024-04-25 21:37 ` [PATCH v3 14/14] ARM: dts: aspeed: Add IBM P11 Fuji " Eddie James
2024-04-25 21:37   ` Eddie James
2024-04-26  6:36   ` Krzysztof Kozlowski
2024-04-26  6:36     ` Krzysztof Kozlowski
2024-04-26 14:22 ` [PATCH v3 00/14] ARM: dts: aspeed: Add IBM P11 BMC Boards Rob Herring
2024-04-26 14:22   ` Rob Herring

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=20240425213701.655540-9-eajames@linux.ibm.com \
    --to=eajames@linux.ibm.com \
    --cc=linux-aspeed@lists.ozlabs.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.