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 v6 11/20] dt-bindings: i2c: i2c-fsi: Convert to json-schema
Date: Wed, 22 May 2024 14:25:15 -0500	[thread overview]
Message-ID: <20240522192524.3286237-12-eajames@linux.ibm.com> (raw)
In-Reply-To: <20240522192524.3286237-1-eajames@linux.ibm.com>

Convert to json-schema for the FSI-attached I2C controller.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
Changes since v5:
 - Use more specific regex for node names

 .../devicetree/bindings/i2c/i2c-fsi.txt       | 40 ----------
 .../devicetree/bindings/i2c/ibm,i2c-fsi.yaml  | 76 +++++++++++++++++++
 MAINTAINERS                                   |  2 +-
 3 files changed, 77 insertions(+), 41 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-fsi.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml

diff --git a/Documentation/devicetree/bindings/i2c/i2c-fsi.txt b/Documentation/devicetree/bindings/i2c/i2c-fsi.txt
deleted file mode 100644
index b1be2ceb7e696..0000000000000
--- a/Documentation/devicetree/bindings/i2c/i2c-fsi.txt
+++ /dev/null
@@ -1,40 +0,0 @@
-Device-tree bindings for FSI-attached I2C master and busses
------------------------------------------------------------
-
-Required properties:
- - compatible = "ibm,i2c-fsi";
- - reg = < address size >;		: The FSI CFAM address and address
-					  space size.
- - #address-cells = <1>;		: Number of address cells in child
-					  nodes.
- - #size-cells = <0>;			: Number of size cells in child nodes.
- - child nodes				: Nodes to describe busses off the I2C
-					  master.
-
-Child node required properties:
- - reg = < port number >		: The port number on the I2C master.
-
-Child node optional properties:
- - child nodes				: Nodes to describe devices on the I2C
-					  bus.
-
-Examples:
-
-    i2c at 1800 {
-        compatible = "ibm,i2c-fsi";
-        reg = < 0x1800 0x400 >;
-        #address-cells = <1>;
-        #size-cells = <0>;
-
-        i2c-bus at 0 {
-            reg = <0>;
-        };
-
-        i2c-bus at 1 {
-            reg = <1>;
-
-            eeprom at 50 {
-                compatible = "vendor,dev-name";
-            };
-        };
-    };
diff --git a/Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml b/Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml
new file mode 100644
index 0000000000000..40ea82942e4d4
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/ibm,i2c-fsi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: IBM FSI-attached I2C controller
+
+maintainers:
+  - Eddie James <eajames@linux.ibm.com>
+
+description:
+  This I2C controller is an FSI CFAM engine, providing access to a number of
+  I2C busses. Therefore this node will always be a child of an FSI CFAM node.
+
+properties:
+  compatible:
+    enum:
+      - ibm,i2c-fsi
+
+  reg:
+    items:
+      - description: FSI slave address
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+patternProperties:
+  "^i2c-bus@[0-9a-f]+$":
+    type: object
+    properties:
+      reg:
+        maxItems: 1
+
+    required:
+      - reg
+
+    allOf:
+      - $ref: /schemas/i2c/i2c-controller.yaml#
+
+    unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c at 1800 {
+        compatible = "ibm,i2c-fsi";
+        reg = <0x1800 0x400>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        i2c-bus at 0 {
+            reg = <0>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+        };
+
+        i2c-bus at 1 {
+            reg = <1>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            eeprom at 50 {
+                compatible = "atmel,24c64";
+                reg = <0x50>;
+            };
+        };
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index f0fe6b2032a21..7884dbe2374c7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8977,7 +8977,7 @@ M:	Eddie James <eajames@linux.ibm.com>
 L:	linux-i2c at vger.kernel.org
 L:	openbmc at lists.ozlabs.org (moderated for non-subscribers)
 S:	Maintained
-F:	Documentation/devicetree/bindings/i2c/i2c-fsi.txt
+F:	Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml
 F:	drivers/i2c/busses/i2c-fsi.c
 
 FSI-ATTACHED SPI DRIVER
-- 
2.39.3


WARNING: multiple messages have this Message-ID (diff)
From: Eddie James <eajames@linux.ibm.com>
To: linux-fsi@lists.ozlabs.org
Cc: eajames@linux.ibm.com, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, ninad@linux.ibm.com,
	lakshmiy@us.ibm.com, linux-i2c@vger.kernel.org,
	linux-spi@vger.kernel.org, linux-aspeed@lists.ozlabs.org,
	andrew@codeconstruct.com.au, joel@jms.id.au, robh@kernel.org,
	conor+dt@kernel.org, krzk+dt@kernel.org, andi.shyti@kernel.org,
	broonie@kernel.org
Subject: [PATCH v6 11/20] dt-bindings: i2c: i2c-fsi: Convert to json-schema
Date: Wed, 22 May 2024 14:25:15 -0500	[thread overview]
Message-ID: <20240522192524.3286237-12-eajames@linux.ibm.com> (raw)
In-Reply-To: <20240522192524.3286237-1-eajames@linux.ibm.com>

Convert to json-schema for the FSI-attached I2C controller.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
Changes since v5:
 - Use more specific regex for node names

 .../devicetree/bindings/i2c/i2c-fsi.txt       | 40 ----------
 .../devicetree/bindings/i2c/ibm,i2c-fsi.yaml  | 76 +++++++++++++++++++
 MAINTAINERS                                   |  2 +-
 3 files changed, 77 insertions(+), 41 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-fsi.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml

diff --git a/Documentation/devicetree/bindings/i2c/i2c-fsi.txt b/Documentation/devicetree/bindings/i2c/i2c-fsi.txt
deleted file mode 100644
index b1be2ceb7e696..0000000000000
--- a/Documentation/devicetree/bindings/i2c/i2c-fsi.txt
+++ /dev/null
@@ -1,40 +0,0 @@
-Device-tree bindings for FSI-attached I2C master and busses
------------------------------------------------------------
-
-Required properties:
- - compatible = "ibm,i2c-fsi";
- - reg = < address size >;		: The FSI CFAM address and address
-					  space size.
- - #address-cells = <1>;		: Number of address cells in child
-					  nodes.
- - #size-cells = <0>;			: Number of size cells in child nodes.
- - child nodes				: Nodes to describe busses off the I2C
-					  master.
-
-Child node required properties:
- - reg = < port number >		: The port number on the I2C master.
-
-Child node optional properties:
- - child nodes				: Nodes to describe devices on the I2C
-					  bus.
-
-Examples:
-
-    i2c@1800 {
-        compatible = "ibm,i2c-fsi";
-        reg = < 0x1800 0x400 >;
-        #address-cells = <1>;
-        #size-cells = <0>;
-
-        i2c-bus@0 {
-            reg = <0>;
-        };
-
-        i2c-bus@1 {
-            reg = <1>;
-
-            eeprom@50 {
-                compatible = "vendor,dev-name";
-            };
-        };
-    };
diff --git a/Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml b/Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml
new file mode 100644
index 0000000000000..40ea82942e4d4
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/ibm,i2c-fsi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: IBM FSI-attached I2C controller
+
+maintainers:
+  - Eddie James <eajames@linux.ibm.com>
+
+description:
+  This I2C controller is an FSI CFAM engine, providing access to a number of
+  I2C busses. Therefore this node will always be a child of an FSI CFAM node.
+
+properties:
+  compatible:
+    enum:
+      - ibm,i2c-fsi
+
+  reg:
+    items:
+      - description: FSI slave address
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+patternProperties:
+  "^i2c-bus@[0-9a-f]+$":
+    type: object
+    properties:
+      reg:
+        maxItems: 1
+
+    required:
+      - reg
+
+    allOf:
+      - $ref: /schemas/i2c/i2c-controller.yaml#
+
+    unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c@1800 {
+        compatible = "ibm,i2c-fsi";
+        reg = <0x1800 0x400>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        i2c-bus@0 {
+            reg = <0>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+        };
+
+        i2c-bus@1 {
+            reg = <1>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            eeprom@50 {
+                compatible = "atmel,24c64";
+                reg = <0x50>;
+            };
+        };
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index f0fe6b2032a21..7884dbe2374c7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8977,7 +8977,7 @@ M:	Eddie James <eajames@linux.ibm.com>
 L:	linux-i2c@vger.kernel.org
 L:	openbmc@lists.ozlabs.org (moderated for non-subscribers)
 S:	Maintained
-F:	Documentation/devicetree/bindings/i2c/i2c-fsi.txt
+F:	Documentation/devicetree/bindings/i2c/ibm,i2c-fsi.yaml
 F:	drivers/i2c/busses/i2c-fsi.c
 
 FSI-ATTACHED SPI DRIVER
-- 
2.39.3


  parent reply	other threads:[~2024-05-22 19:25 UTC|newest]

Thread overview: 106+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-22 19:25 [PATCH v6 00/20] ARM: dts: aspeed: Add IBM P11 BMC systems Eddie James
2024-05-22 19:25 ` Eddie James
2024-05-22 19:25 ` [PATCH v6 01/20] spi: dt-bindings: Document the IBM FSI-attached SPI controller Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-22 19:25 ` [PATCH v6 02/20] dt-bindings: fsi: fsi2spi: Document SPI controller child nodes Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-22 19:25 ` [PATCH v6 03/20] dt-bindings: fsi: Document the IBM SCOM engine Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23  9:28   ` Markus Elfring
2024-05-23  9:28     ` Markus Elfring
2024-05-23  9:43     ` Conor Dooley
2024-05-23  9:45       ` Conor Dooley
2024-05-23 11:05       ` [v6 " Markus Elfring
2024-05-23 11:05         ` Markus Elfring
2024-05-22 19:25 ` [PATCH v6 04/20] dt-bindings: fsi: p9-occ: Convert to json-schema Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23 15:37   ` Markus Elfring
2024-05-23 15:37     ` Markus Elfring
2024-05-22 19:25 ` [PATCH v6 05/20] dt-bindings: fsi: Document the IBM SBEFIFO engine Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23 15:55   ` Markus Elfring
2024-05-23 15:55     ` Markus Elfring
2024-05-22 19:25 ` [PATCH v6 06/20] dt-bindings: fsi: Document the FSI controller common properties Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23  6:57   ` Krzysztof Kozlowski
2024-05-23  6:57     ` Krzysztof Kozlowski
2024-05-22 19:25 ` [PATCH v6 07/20] dt-bindings: fsi: ibm,i2cr-fsi-master: Reference common FSI controller Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-22 19:25 ` [PATCH v6 08/20] dt-bindings: fsi: ast2600-fsi-master: Convert to json-schema Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-22 19:25 ` [PATCH v6 09/20] dt-bindings: fsi: Document the AST2700 FSI controller Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-22 19:25 ` [PATCH v6 10/20] dt-bindings: fsi: Document the FSI Hub Controller Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-28 14:58   ` Ninad Palsule
2024-05-22 19:25 ` Eddie James [this message]
2024-05-22 19:25   ` [PATCH v6 11/20] dt-bindings: i2c: i2c-fsi: Convert to json-schema Eddie James
2024-05-23  6:59   ` Krzysztof Kozlowski
2024-05-23  6:59     ` Krzysztof Kozlowski
2024-05-28 14:52   ` Ninad Palsule
2024-05-28 14:52     ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 12/20] dt-bindings: arm: aspeed: add IBM P11 BMC boards Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-28 14:24   ` Ninad Palsule
2024-05-28 14:24     ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 13/20] ARM: dts: aspeed: Add IBM P11 FSI devices Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-28 14:22   ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 14/20] ARM: dts: aspeed: Add IBM P11 Blueridge BMC system Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-24 22:47   ` Ninad Palsule
2024-05-28 14:50     ` Eddie James
2024-05-28 14:50       ` Eddie James
2024-05-22 19:25 ` [PATCH v6 15/20] ARM: dts: aspeed: Add IBM P11 Blueridge 4U " Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-24 22:27   ` Ninad Palsule
2024-05-24 22:27     ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 16/20] ARM: dts: aspeed: Add IBM P11 Fuji " Eddie James
2024-05-22 19:26   ` Eddie James
2024-05-28 14:08   ` Ninad Palsule
2024-05-28 14:47     ` Eddie James
2024-05-28 14:47       ` Eddie James
2024-05-22 19:25 ` [PATCH v6 17/20] ARM: dts: aspeed: Add IBM Huygens " Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23 12:48   ` kernel test robot
2024-05-23 12:48     ` kernel test robot
2024-05-23 19:07     ` Eddie James
2024-05-23 19:07       ` Eddie James
2024-05-23 18:45   ` Markus Elfring
2024-05-23 18:45     ` Markus Elfring
2024-05-23 19:00     ` Eddie James
2024-05-23 19:00       ` Eddie James
2024-05-23 19:30       ` [v6 " Markus Elfring
2024-05-23 19:30         ` Markus Elfring
2024-05-23 19:33         ` Conor Dooley
2024-05-23 19:33           ` Conor Dooley
2024-05-23 19:46           ` Markus Elfring
2024-05-23 19:46             ` Markus Elfring
2024-05-23 20:33             ` Al Viro
2024-05-23 20:33               ` Al Viro
2024-05-24  6:38               ` Markus Elfring
2024-05-24  6:38                 ` Markus Elfring
2024-05-23 20:24       ` [PATCH v6 " Krzysztof Kozlowski
2024-05-23 20:24         ` Krzysztof Kozlowski
2024-05-23 20:33         ` [v6 " Markus Elfring
2024-05-23 20:33           ` Markus Elfring
2024-05-23 21:38   ` [PATCH v6 " Ninad Palsule
2024-05-23 21:38     ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 18/20] fsi: occ: Get device number from FSI minor number API Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23 21:36   ` Ninad Palsule
2024-05-23 21:36     ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 19/20] fsi: occ: Find next available child rather than node name match Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-22 19:25 ` [PATCH v6 20/20] fsi: scom: Update compatible string to match documentation Eddie James
2024-05-22 19:25   ` Eddie James
2024-05-23 21:29   ` Ninad Palsule
2024-05-23 21:29     ` Ninad Palsule
2024-05-23 21:31   ` [PATCH v6 19/20] fsi: occ: Find next available child rather than node name match Ninad Palsule
2024-05-23 21:31     ` Ninad Palsule
2024-06-05 15:47 ` [PATCH v6 00/20] ARM: dts: aspeed: Add IBM P11 BMC systems Eddie James
2024-06-05 15:47   ` Eddie James
2024-06-06  1:31   ` Andrew Jeffery
2024-06-06  1:31     ` Andrew Jeffery
2024-07-08 13:47 ` Rob Herring
2024-07-08 13:47   ` 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=20240522192524.3286237-12-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.