dt-bindings: i2c: cadence: Migrate i2c-cadence documentation to YAML
authorNobuhiro Iwamatsu <iwamatsu@nigauri.org>
Wed, 1 Apr 2020 13:42:22 +0000 (22:42 +0900)
committerRob Herring <robh@kernel.org>
Tue, 14 Apr 2020 16:36:09 +0000 (11:36 -0500)
The document was migrated to YAML format and renamed cdns,i2c-r1p10.yaml

Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml [new file with mode: 0644]
Documentation/devicetree/bindings/i2c/i2c-cadence.txt [deleted file]
MAINTAINERS

diff --git a/Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml b/Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml
new file mode 100644 (file)
index 0000000..dc0952f
--- /dev/null
@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/i2c/cdns,i2c-r1p10.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Cadence I2C controller Device Tree Bindings
+
+maintainers:
+  - Michal Simek <michal.simek@xilinx.com>
+
+allOf:
+  - $ref: /schemas/i2c/i2c-controller.yaml#
+
+properties:
+  compatible:
+    enum:
+      - cdns,i2c-r1p10 # cadence i2c controller version 1.0
+      - cdns,i2c-r1p14 # cadence i2c controller version 1.4
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    minItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clock-frequency:
+    minimum: 1
+    maximum: 400000
+    description: |
+      Desired operating frequency, in Hz, of the bus.
+
+  clock-name:
+    const: pclk
+    description: |
+      Input clock name.
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    i2c@e0004000 {
+        compatible = "cdns,i2c-r1p10";
+        clocks = <&clkc 38>;
+        interrupts = <GIC_SPI 25 IRQ_TYPE_LEVEL_HIGH>;
+        reg = <0xe0004000 0x1000>;
+        clock-frequency = <400000>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+    };
diff --git a/Documentation/devicetree/bindings/i2c/i2c-cadence.txt b/Documentation/devicetree/bindings/i2c/i2c-cadence.txt
deleted file mode 100644 (file)
index ebaa90c..0000000
+++ /dev/null
@@ -1,28 +0,0 @@
-Binding for the Cadence I2C controller
-
-Required properties:
-  - reg: Physical base address and size of the controller's register area.
-  - compatible: Should contain one of:
-               * "cdns,i2c-r1p10"
-               Note:   Use this when cadence i2c controller version 1.0 is used.
-               * "cdns,i2c-r1p14"
-               Note:   Use this when cadence i2c controller version 1.4 is used.
-  - clocks: Input clock specifier. Refer to common clock bindings.
-  - interrupts: Interrupt specifier. Refer to interrupt bindings.
-  - #address-cells: Should be 1.
-  - #size-cells: Should be 0.
-
-Optional properties:
-  - clock-frequency: Desired operating frequency, in Hz, of the bus.
-  - clock-names: Input clock name, should be 'pclk'.
-
-Example:
-       i2c@e0004000 {
-               compatible = "cdns,i2c-r1p10";
-               clocks = <&clkc 38>;
-               interrupts = <GIC_SPI 25 IRQ_TYPE_LEVEL_HIGH>;
-               reg = <0xe0004000 0x1000>;
-               clock-frequency = <400000>;
-               #address-cells = <1>;
-               #size-cells = <0>;
-       };
index e64e5db..d74ae2b 100644 (file)
@@ -2692,7 +2692,7 @@ L:        linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
 S:     Supported
 W:     http://wiki.xilinx.com
 T:     git https://github.com/Xilinx/linux-xlnx.git
-F:     Documentation/devicetree/bindings/i2c/i2c-cadence.txt
+F:     Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml
 F:     Documentation/devicetree/bindings/i2c/i2c-xiic.txt
 F:     arch/arm/mach-zynq/
 F:     drivers/block/xsysace.c