[PATCH V2 0/3] Convert i.MX/MXS I2C/LPI2C binding doc to json-schema

[PATCH V2 0/3] Convert i.MX/MXS I2C/LPI2C binding doc to json-schema

[Anson Huang]

Coverts i.MX/MXS I2C/LPI2C binding doc to json-schema, some examples are too old,
update them based on latest DT file, also add more compatible based on supported SoCs.

Compated to V1, this patch series adds "additionalProperties: false" for each
binding doc.

Anson Huang (3):
  dt-bindings: i2c: Convert imx lpi2c to json-schema
  dt-bindings: i2c: Convert mxs i2c to json-schema
  dt-bindings: i2c: Convert imx i2c to json-schema

 .../devicetree/bindings/i2c/i2c-imx-lpi2c.txt      |  20 ----
 .../devicetree/bindings/i2c/i2c-imx-lpi2c.yaml     |  47 ++++++++
 Documentation/devicetree/bindings/i2c/i2c-imx.txt  |  49 ---------
 Documentation/devicetree/bindings/i2c/i2c-imx.yaml | 119 +++++++++++++++++++++
 Documentation/devicetree/bindings/i2c/i2c-mxs.txt  |  25 -----
 Documentation/devicetree/bindings/i2c/i2c-mxs.yaml |  55 ++++++++++
 6 files changed, 221 insertions(+), 94 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.yaml
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-mxs.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-mxs.yaml

-- 
2.7.4

[PATCH V2 1/3] dt-bindings: i2c: Convert imx lpi2c to json-schema

[Anson Huang]

Convert the i.MX LPI2C binding to DT schema format using json-schema

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
Changes since V1:
	- add "additionalProperties: false".
---
 .../devicetree/bindings/i2c/i2c-imx-lpi2c.txt      | 20 ---------
 .../devicetree/bindings/i2c/i2c-imx-lpi2c.yaml     | 47 ++++++++++++++++++++++
 2 files changed, 47 insertions(+), 20 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml

diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt b/Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt
deleted file mode 100644
index f0c072f..0000000
--- a/Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-* Freescale Low Power Inter IC (LPI2C) for i.MX
-
-Required properties:
-- compatible :
-  - "fsl,imx7ulp-lpi2c" for LPI2C compatible with the one integrated on i.MX7ULP soc
-  - "fsl,imx8qxp-lpi2c" for LPI2C compatible with the one integrated on i.MX8QXP soc
-  - "fsl,imx8qm-lpi2c" for LPI2C compatible with the one integrated on i.MX8QM soc
-- reg : address and length of the lpi2c master registers
-- interrupts : lpi2c interrupt
-- clocks : lpi2c clock specifier
-
-Examples:
-
-lpi2c7: lpi2c7@40a50000 {
-	compatible = "fsl,imx7ulp-lpi2c";
-	reg = <0x40A50000 0x10000>;
-	interrupt-parent = <&intc>;
-	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
-	clocks = <&clks IMX7ULP_CLK_LPI2C7>;
-};
diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml b/Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml
new file mode 100644
index 0000000..ac0bc5d
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/i2c-imx-lpi2c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale Low Power Inter IC (LPI2C) for i.MX
+
+maintainers:
+  - Anson Huang <Anson.Huang@nxp.com>
+
+properties:
+  compatible:
+    enum:
+      - fsl,imx7ulp-lpi2c
+      - fsl,imx8qxp-lpi2c
+      - fsl,imx8qm-lpi2c
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/imx7ulp-clock.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    lpi2c7@40a50000 {
+        compatible = "fsl,imx7ulp-lpi2c";
+        reg = <0x40A50000 0x10000>;
+        interrupt-parent = <&intc>;
+        interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clks IMX7ULP_CLK_LPI2C7>;
+    };
-- 
2.7.4

[PATCH V2 2/3] dt-bindings: i2c: Convert mxs i2c to json-schema

[Anson Huang]

Convert the MXS I2C binding to DT schema format using json-schema

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
Changes since V1:
	- add "additionalProperties: false".
---
 Documentation/devicetree/bindings/i2c/i2c-mxs.txt  | 25 ----------
 Documentation/devicetree/bindings/i2c/i2c-mxs.yaml | 55 ++++++++++++++++++++++
 2 files changed, 55 insertions(+), 25 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-mxs.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-mxs.yaml

diff --git a/Documentation/devicetree/bindings/i2c/i2c-mxs.txt b/Documentation/devicetree/bindings/i2c/i2c-mxs.txt
deleted file mode 100644
index 4e1c8ac..0000000
--- a/Documentation/devicetree/bindings/i2c/i2c-mxs.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-* Freescale MXS Inter IC (I2C) Controller
-
-Required properties:
-- compatible: Should be "fsl,<chip>-i2c"
-- reg: Should contain registers location and length
-- interrupts: Should contain ERROR interrupt number
-- clock-frequency: Desired I2C bus clock frequency in Hz.
-                   Only 100000Hz and 400000Hz modes are supported.
-- dmas: DMA specifier, consisting of a phandle to DMA controller node
-  and I2C DMA channel ID.
-  Refer to dma.txt and fsl-mxs-dma.txt for details.
-- dma-names: Must be "rx-tx".
-
-Examples:
-
-i2c0: i2c@80058000 {
-	#address-cells = <1>;
-	#size-cells = <0>;
-	compatible = "fsl,imx28-i2c";
-	reg = <0x80058000 2000>;
-	interrupts = <111>;
-	clock-frequency = <100000>;
-	dmas = <&dma_apbx 6>;
-	dma-names = "rx-tx";
-};
diff --git a/Documentation/devicetree/bindings/i2c/i2c-mxs.yaml b/Documentation/devicetree/bindings/i2c/i2c-mxs.yaml
new file mode 100644
index 0000000..3bc14bb
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/i2c-mxs.yaml
@@ -0,0 +1,55 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/i2c-mxs.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale MXS Inter IC (I2C) Controller
+
+maintainers:
+  - Shawn Guo <shawn.guo@linaro.org>
+
+properties:
+  compatible:
+    enum:
+      - fsl,imx23-i2c
+      - fsl,imx28-i2c
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clock-frequency:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      Desired I2C bus clock frequency in Hz, only 100000Hz and 400000Hz
+      modes are supported.
+    default: 100000
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    const: rx-tx
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - dmas
+  - dma-names
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c@80058000 {
+        compatible = "fsl,imx28-i2c";
+        reg = <0x80058000 2000>;
+        interrupts = <111>;
+        clock-frequency = <100000>;
+        dmas = <&dma_apbx 6>;
+        dma-names = "rx-tx";
+    };
-- 
2.7.4

[PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-schema

[Anson Huang]

Convert the i.MX I2C binding to DT schema format using json-schema,
some improvements applied, such as update example based on latest DT
file, add more compatible for existing SoCs, and remove unnecessary
common property "pinctrl".

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
---
Changes since V1:
	- add "additionalProperties: false".
---
 Documentation/devicetree/bindings/i2c/i2c-imx.txt  |  49 ---------
 Documentation/devicetree/bindings/i2c/i2c-imx.yaml | 119 +++++++++++++++++++++
 2 files changed, 119 insertions(+), 49 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.yaml

diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.txt b/Documentation/devicetree/bindings/i2c/i2c-imx.txt
deleted file mode 100644
index b967544..0000000
--- a/Documentation/devicetree/bindings/i2c/i2c-imx.txt
+++ /dev/null
@@ -1,49 +0,0 @@
-* Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for i.MX
-
-Required properties:
-- compatible :
-  - "fsl,imx1-i2c" for I2C compatible with the one integrated on i.MX1 SoC
-  - "fsl,imx21-i2c" for I2C compatible with the one integrated on i.MX21 SoC
-  - "fsl,vf610-i2c" for I2C compatible with the one integrated on Vybrid vf610 SoC
-- reg : Should contain I2C/HS-I2C registers location and length
-- interrupts : Should contain I2C/HS-I2C interrupt
-- clocks : Should contain the I2C/HS-I2C clock specifier
-
-Optional properties:
-- clock-frequency : Constains desired I2C/HS-I2C bus clock frequency in Hz.
-  The absence of the property indicates the default frequency 100 kHz.
-- dmas: A list of two dma specifiers, one for each entry in dma-names.
-- dma-names: should contain "tx" and "rx".
-- scl-gpios: specify the gpio related to SCL pin
-- sda-gpios: specify the gpio related to SDA pin
-- pinctrl: add extra pinctrl to configure i2c pins to gpio function for i2c
-  bus recovery, call it "gpio" state
-
-Examples:
-
-i2c@83fc4000 { /* I2C2 on i.MX51 */
-	compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
-	reg = <0x83fc4000 0x4000>;
-	interrupts = <63>;
-};
-
-i2c@70038000 { /* HS-I2C on i.MX51 */
-	compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
-	reg = <0x70038000 0x4000>;
-	interrupts = <64>;
-	clock-frequency = <400000>;
-};
-
-i2c0: i2c@40066000 { /* i2c0 on vf610 */
-	compatible = "fsl,vf610-i2c";
-	reg = <0x40066000 0x1000>;
-	interrupts =<0 71 0x04>;
-	dmas = <&edma0 0 50>,
-		<&edma0 0 51>;
-	dma-names = "rx","tx";
-	pinctrl-names = "default", "gpio";
-	pinctrl-0 = <&pinctrl_i2c1>;
-	pinctrl-1 = <&pinctrl_i2c1_gpio>;
-	scl-gpios = <&gpio5 26 GPIO_ACTIVE_HIGH>;
-	sda-gpios = <&gpio5 27 GPIO_ACTIVE_HIGH>;
-};
diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.yaml b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
new file mode 100644
index 0000000..63cceab
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
@@ -0,0 +1,119 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/i2c-imx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for i.MX
+
+maintainers:
+  - Wolfram Sang <wolfram@the-dreams.de>
+
+properties:
+  compatible:
+    oneOf:
+      - const: fsl,imx1-i2c
+      - const: fsl,imx21-i2c
+      - const: fsl,vf610-i2c
+      - items:
+          - const: fsl,imx35-i2c
+          - const: fsl,imx1-i2c
+      - items:
+          - enum:
+            - fsl,imx25-i2c
+            - fsl,imx27-i2c
+            - fsl,imx31-i2c
+            - fsl,imx50-i2c
+            - fsl,imx51-i2c
+            - fsl,imx53-i2c
+            - fsl,imx6q-i2c
+            - fsl,imx6sl-i2c
+            - fsl,imx6sx-i2c
+            - fsl,imx6sll-i2c
+            - fsl,imx6ul-i2c
+            - fsl,imx7s-i2c
+            - fsl,imx8mq-i2c
+            - fsl,imx8mm-i2c
+            - fsl,imx8mn-i2c
+            - fsl,imx8mp-i2c
+          - const: fsl,imx21-i2c
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: ipg
+
+  clock-frequency:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      Constains desired I2C/HS-I2C bus clock frequency in Hz.
+      The absence of the property indicates the default frequency 100 kHz.
+    default: 100000
+
+  dmas:
+    items:
+      - description: DMA controller phandle and request line for RX
+      - description: DMA controller phandle and request line for TX
+
+  dma-names:
+    items:
+      - const: rx
+      - const: tx
+
+  sda-gpios:
+    $ref: '/schemas/types.yaml#/definitions/phandle'
+    description: |
+      gpio used for the sda signal, this should be flagged as
+      active high using open drain with (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
+      from <dt-bindings/gpio/gpio.h> since the signal is by definition
+      open drain.
+    maxItems: 1
+
+  scl-gpios:
+    $ref: '/schemas/types.yaml#/definitions/phandle'
+    description: |
+      gpio used for the scl signal, this should be flagged as
+      active high using open drain with (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
+      from <dt-bindings/gpio/gpio.h> since the signal is by definition
+      open drain.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/imx5-clock.h>
+    #include <dt-bindings/clock/vf610-clock.h>
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    i2c@83fc4000 {
+        compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
+        reg = <0x83fc4000 0x4000>;
+        interrupts = <63>;
+        clocks = <&clks IMX5_CLK_I2C2_GATE>;
+    };
+
+    i2c@40066000 {
+        compatible = "fsl,vf610-i2c";
+        reg = <0x40066000 0x1000>;
+        interrupts = <71 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clks VF610_CLK_I2C0>;
+        clock-names = "ipg";
+        dmas = <&edma0 0 50>,
+               <&edma0 0 51>;
+        dma-names = "rx","tx";
+    };
-- 
2.7.4

Re: [PATCH V2 1/3] dt-bindings: i2c: Convert imx lpi2c to json-schema

[Rob Herring]

On Thu, 04 Jun 2020 09:49:16 +0800, Anson Huang wrote:
> Convert the i.MX LPI2C binding to DT schema format using json-schema
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> ---
> Changes since V1:
> 	- add "additionalProperties: false".
> ---
>  .../devicetree/bindings/i2c/i2c-imx-lpi2c.txt      | 20 ---------
>  .../devicetree/bindings/i2c/i2c-imx-lpi2c.yaml     | 47 ++++++++++++++++++++++
>  2 files changed, 47 insertions(+), 20 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt
>  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml
> 

Applied, thanks!

Re: [PATCH V2 2/3] dt-bindings: i2c: Convert mxs i2c to json-schema

[Rob Herring]

On Thu, Jun 04, 2020 at 09:49:17AM +0800, Anson Huang wrote:
> Convert the MXS I2C binding to DT schema format using json-schema
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> ---
> Changes since V1:
> 	- add "additionalProperties: false".
> ---
>  Documentation/devicetree/bindings/i2c/i2c-mxs.txt  | 25 ----------
>  Documentation/devicetree/bindings/i2c/i2c-mxs.yaml | 55 ++++++++++++++++++++++
>  2 files changed, 55 insertions(+), 25 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-mxs.txt
>  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-mxs.yaml
> 
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-mxs.txt b/Documentation/devicetree/bindings/i2c/i2c-mxs.txt
> deleted file mode 100644
> index 4e1c8ac..0000000
> --- a/Documentation/devicetree/bindings/i2c/i2c-mxs.txt
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -* Freescale MXS Inter IC (I2C) Controller
> -
> -Required properties:
> -- compatible: Should be "fsl,<chip>-i2c"
> -- reg: Should contain registers location and length
> -- interrupts: Should contain ERROR interrupt number
> -- clock-frequency: Desired I2C bus clock frequency in Hz.
> -                   Only 100000Hz and 400000Hz modes are supported.
> -- dmas: DMA specifier, consisting of a phandle to DMA controller node
> -  and I2C DMA channel ID.
> -  Refer to dma.txt and fsl-mxs-dma.txt for details.
> -- dma-names: Must be "rx-tx".
> -
> -Examples:
> -
> -i2c0: i2c@80058000 {
> -	#address-cells = <1>;
> -	#size-cells = <0>;
> -	compatible = "fsl,imx28-i2c";
> -	reg = <0x80058000 2000>;
> -	interrupts = <111>;
> -	clock-frequency = <100000>;
> -	dmas = <&dma_apbx 6>;
> -	dma-names = "rx-tx";
> -};
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-mxs.yaml b/Documentation/devicetree/bindings/i2c/i2c-mxs.yaml
> new file mode 100644
> index 0000000..3bc14bb
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/i2c-mxs.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/i2c/i2c-mxs.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale MXS Inter IC (I2C) Controller
> +
> +maintainers:
> +  - Shawn Guo <shawn.guo@linaro.org>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - fsl,imx23-i2c
> +      - fsl,imx28-i2c
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clock-frequency:
> +    $ref: /schemas/types.yaml#/definitions/uint32

'clock-frequency' already has a type.

> +    description: |
> +      Desired I2C bus clock frequency in Hz, only 100000Hz and 400000Hz
> +      modes are supported.

Sounds like constraints.

> +    default: 100000
> +
> +  dmas:
> +    maxItems: 1
> +
> +  dma-names:
> +    const: rx-tx
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - dmas
> +  - dma-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c@80058000 {
> +        compatible = "fsl,imx28-i2c";
> +        reg = <0x80058000 2000>;
> +        interrupts = <111>;
> +        clock-frequency = <100000>;
> +        dmas = <&dma_apbx 6>;
> +        dma-names = "rx-tx";
> +    };
> -- 
> 2.7.4
> 

Re: [PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-schema

[Rob Herring]

On Thu, Jun 04, 2020 at 09:49:18AM +0800, Anson Huang wrote:
> Convert the i.MX I2C binding to DT schema format using json-schema,
> some improvements applied, such as update example based on latest DT
> file, add more compatible for existing SoCs, and remove unnecessary
> common property "pinctrl".
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> ---
> Changes since V1:
> 	- add "additionalProperties: false".
> ---
>  Documentation/devicetree/bindings/i2c/i2c-imx.txt  |  49 ---------
>  Documentation/devicetree/bindings/i2c/i2c-imx.yaml | 119 +++++++++++++++++++++
>  2 files changed, 119 insertions(+), 49 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.txt
>  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> 
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.txt b/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> deleted file mode 100644
> index b967544..0000000
> --- a/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> +++ /dev/null
> @@ -1,49 +0,0 @@
> -* Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for i.MX
> -
> -Required properties:
> -- compatible :
> -  - "fsl,imx1-i2c" for I2C compatible with the one integrated on i.MX1 SoC
> -  - "fsl,imx21-i2c" for I2C compatible with the one integrated on i.MX21 SoC
> -  - "fsl,vf610-i2c" for I2C compatible with the one integrated on Vybrid vf610 SoC
> -- reg : Should contain I2C/HS-I2C registers location and length
> -- interrupts : Should contain I2C/HS-I2C interrupt
> -- clocks : Should contain the I2C/HS-I2C clock specifier
> -
> -Optional properties:
> -- clock-frequency : Constains desired I2C/HS-I2C bus clock frequency in Hz.
> -  The absence of the property indicates the default frequency 100 kHz.
> -- dmas: A list of two dma specifiers, one for each entry in dma-names.
> -- dma-names: should contain "tx" and "rx".
> -- scl-gpios: specify the gpio related to SCL pin
> -- sda-gpios: specify the gpio related to SDA pin
> -- pinctrl: add extra pinctrl to configure i2c pins to gpio function for i2c
> -  bus recovery, call it "gpio" state
> -
> -Examples:
> -
> -i2c@83fc4000 { /* I2C2 on i.MX51 */
> -	compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
> -	reg = <0x83fc4000 0x4000>;
> -	interrupts = <63>;
> -};
> -
> -i2c@70038000 { /* HS-I2C on i.MX51 */
> -	compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
> -	reg = <0x70038000 0x4000>;
> -	interrupts = <64>;
> -	clock-frequency = <400000>;
> -};
> -
> -i2c0: i2c@40066000 { /* i2c0 on vf610 */
> -	compatible = "fsl,vf610-i2c";
> -	reg = <0x40066000 0x1000>;
> -	interrupts =<0 71 0x04>;
> -	dmas = <&edma0 0 50>,
> -		<&edma0 0 51>;
> -	dma-names = "rx","tx";
> -	pinctrl-names = "default", "gpio";
> -	pinctrl-0 = <&pinctrl_i2c1>;
> -	pinctrl-1 = <&pinctrl_i2c1_gpio>;
> -	scl-gpios = <&gpio5 26 GPIO_ACTIVE_HIGH>;
> -	sda-gpios = <&gpio5 27 GPIO_ACTIVE_HIGH>;
> -};
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.yaml b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> new file mode 100644
> index 0000000..63cceab
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> @@ -0,0 +1,119 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/i2c/i2c-imx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for i.MX
> +
> +maintainers:
> +  - Wolfram Sang <wolfram@the-dreams.de>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: fsl,imx1-i2c
> +      - const: fsl,imx21-i2c
> +      - const: fsl,vf610-i2c
> +      - items:
> +          - const: fsl,imx35-i2c
> +          - const: fsl,imx1-i2c
> +      - items:
> +          - enum:
> +            - fsl,imx25-i2c
> +            - fsl,imx27-i2c
> +            - fsl,imx31-i2c
> +            - fsl,imx50-i2c
> +            - fsl,imx51-i2c
> +            - fsl,imx53-i2c
> +            - fsl,imx6q-i2c
> +            - fsl,imx6sl-i2c
> +            - fsl,imx6sx-i2c
> +            - fsl,imx6sll-i2c
> +            - fsl,imx6ul-i2c
> +            - fsl,imx7s-i2c
> +            - fsl,imx8mq-i2c
> +            - fsl,imx8mm-i2c
> +            - fsl,imx8mn-i2c
> +            - fsl,imx8mp-i2c
> +          - const: fsl,imx21-i2c
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    const: ipg
> +
> +  clock-frequency:
> +    $ref: /schemas/types.yaml#/definitions/uint32

Already has a type.

> +    description: |
> +      Constains desired I2C/HS-I2C bus clock frequency in Hz.
> +      The absence of the property indicates the default frequency 100 kHz.
> +    default: 100000

The bus default is up to 3MHz. Is that valid here?

> +
> +  dmas:
> +    items:
> +      - description: DMA controller phandle and request line for RX
> +      - description: DMA controller phandle and request line for TX
> +
> +  dma-names:
> +    items:
> +      - const: rx
> +      - const: tx
> +
> +  sda-gpios:
> +    $ref: '/schemas/types.yaml#/definitions/phandle'

*-gpios already has a type

> +    description: |
> +      gpio used for the sda signal, this should be flagged as
> +      active high using open drain with (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
> +      from <dt-bindings/gpio/gpio.h> since the signal is by definition
> +      open drain.
> +    maxItems: 1
> +
> +  scl-gpios:
> +    $ref: '/schemas/types.yaml#/definitions/phandle'
> +    description: |
> +      gpio used for the scl signal, this should be flagged as
> +      active high using open drain with (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
> +      from <dt-bindings/gpio/gpio.h> since the signal is by definition
> +      open drain.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/imx5-clock.h>
> +    #include <dt-bindings/clock/vf610-clock.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    i2c@83fc4000 {
> +        compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
> +        reg = <0x83fc4000 0x4000>;
> +        interrupts = <63>;
> +        clocks = <&clks IMX5_CLK_I2C2_GATE>;
> +    };
> +
> +    i2c@40066000 {
> +        compatible = "fsl,vf610-i2c";
> +        reg = <0x40066000 0x1000>;
> +        interrupts = <71 IRQ_TYPE_LEVEL_HIGH>;
> +        clocks = <&clks VF610_CLK_I2C0>;
> +        clock-names = "ipg";
> +        dmas = <&edma0 0 50>,
> +               <&edma0 0 51>;
> +        dma-names = "rx","tx";

space                       ^

> +    };
> -- 
> 2.7.4
> 

RE: [PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-schema

[Anson Huang]

Hi, Rob


> Subject: Re: [PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-schema
> 
> On Thu, Jun 04, 2020 at 09:49:18AM +0800, Anson Huang wrote:
> > Convert the i.MX I2C binding to DT schema format using json-schema,
> > some improvements applied, such as update example based on latest DT
> > file, add more compatible for existing SoCs, and remove unnecessary
> > common property "pinctrl".
> >
> > Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> > ---
> > Changes since V1:
> > 	- add "additionalProperties: false".
> > ---
> >  Documentation/devicetree/bindings/i2c/i2c-imx.txt  |  49 ---------
> > Documentation/devicetree/bindings/i2c/i2c-imx.yaml | 119
> > +++++++++++++++++++++
> >  2 files changed, 119 insertions(+), 49 deletions(-)  delete mode
> > 100644 Documentation/devicetree/bindings/i2c/i2c-imx.txt
> >  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> > b/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> > deleted file mode 100644
> > index b967544..0000000
> > --- a/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> > +++ /dev/null
> > @@ -1,49 +0,0 @@
> > -* Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for i.MX
> > -
> > -Required properties:
> > -- compatible :
> > -  - "fsl,imx1-i2c" for I2C compatible with the one integrated on
> > i.MX1 SoC
> > -  - "fsl,imx21-i2c" for I2C compatible with the one integrated on
> > i.MX21 SoC
> > -  - "fsl,vf610-i2c" for I2C compatible with the one integrated on
> > Vybrid vf610 SoC
> > -- reg : Should contain I2C/HS-I2C registers location and length
> > -- interrupts : Should contain I2C/HS-I2C interrupt
> > -- clocks : Should contain the I2C/HS-I2C clock specifier
> > -
> > -Optional properties:
> > -- clock-frequency : Constains desired I2C/HS-I2C bus clock frequency in Hz.
> > -  The absence of the property indicates the default frequency 100 kHz.
> > -- dmas: A list of two dma specifiers, one for each entry in dma-names.
> > -- dma-names: should contain "tx" and "rx".
> > -- scl-gpios: specify the gpio related to SCL pin
> > -- sda-gpios: specify the gpio related to SDA pin
> > -- pinctrl: add extra pinctrl to configure i2c pins to gpio function
> > for i2c
> > -  bus recovery, call it "gpio" state
> > -
> > -Examples:
> > -
> > -i2c@83fc4000 { /* I2C2 on i.MX51 */
> > -	compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
> > -	reg = <0x83fc4000 0x4000>;
> > -	interrupts = <63>;
> > -};
> > -
> > -i2c@70038000 { /* HS-I2C on i.MX51 */
> > -	compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
> > -	reg = <0x70038000 0x4000>;
> > -	interrupts = <64>;
> > -	clock-frequency = <400000>;
> > -};
> > -
> > -i2c0: i2c@40066000 { /* i2c0 on vf610 */
> > -	compatible = "fsl,vf610-i2c";
> > -	reg = <0x40066000 0x1000>;
> > -	interrupts =<0 71 0x04>;
> > -	dmas = <&edma0 0 50>,
> > -		<&edma0 0 51>;
> > -	dma-names = "rx","tx";
> > -	pinctrl-names = "default", "gpio";
> > -	pinctrl-0 = <&pinctrl_i2c1>;
> > -	pinctrl-1 = <&pinctrl_i2c1_gpio>;
> > -	scl-gpios = <&gpio5 26 GPIO_ACTIVE_HIGH>;
> > -	sda-gpios = <&gpio5 27 GPIO_ACTIVE_HIGH>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> > b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> > new file mode 100644
> > index 0000000..63cceab
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> > @@ -0,0 +1,119 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> >
> +cetree.org%2Fschemas%2Fi2c%2Fi2c-imx.yaml%23&amp;data=02%7C01%7C
> Anson
> >
> +.Huang%40nxp.com%7C943043d1a28548a7fd3308d8114efd9d%7C686ea1d
> 3bc2b4c6
> >
> +fa92cd99c5c301635%7C0%7C0%7C637278378260012996&amp;sdata=VZfJ
> %2BLVtuB
> > +JOWy0e9riauncrE5UNozko4iP6tYm9y80%3D&amp;reserved=0
> > +$schema:
> > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> >
> +cetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=02%7C01%7CAns
> on.Hua
> >
> +ng%40nxp.com%7C943043d1a28548a7fd3308d8114efd9d%7C686ea1d3bc2
> b4c6fa92
> >
> +cd99c5c301635%7C0%7C0%7C637278378260012996&amp;sdata=ABISCsw
> dkJMA4ECe
> > +JE7wKsgzcwZYQS1dfVrxCAecLlY%3D&amp;reserved=0
> > +
> > +title: Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for
> > +i.MX
> > +
> > +maintainers:
> > +  - Wolfram Sang <wolfram@the-dreams.de>
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - const: fsl,imx1-i2c
> > +      - const: fsl,imx21-i2c
> > +      - const: fsl,vf610-i2c
> > +      - items:
> > +          - const: fsl,imx35-i2c
> > +          - const: fsl,imx1-i2c
> > +      - items:
> > +          - enum:
> > +            - fsl,imx25-i2c
> > +            - fsl,imx27-i2c
> > +            - fsl,imx31-i2c
> > +            - fsl,imx50-i2c
> > +            - fsl,imx51-i2c
> > +            - fsl,imx53-i2c
> > +            - fsl,imx6q-i2c
> > +            - fsl,imx6sl-i2c
> > +            - fsl,imx6sx-i2c
> > +            - fsl,imx6sll-i2c
> > +            - fsl,imx6ul-i2c
> > +            - fsl,imx7s-i2c
> > +            - fsl,imx8mq-i2c
> > +            - fsl,imx8mm-i2c
> > +            - fsl,imx8mn-i2c
> > +            - fsl,imx8mp-i2c
> > +          - const: fsl,imx21-i2c
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  clock-names:
> > +    const: ipg
> > +
> > +  clock-frequency:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> 
> Already has a type.

Will remove the type and just use enum for it, it ONLY supports 100KHz/400KHz.

> 
> > +    description: |
> > +      Constains desired I2C/HS-I2C bus clock frequency in Hz.
> > +      The absence of the property indicates the default frequency 100 kHz.
> > +    default: 100000
> 
> The bus default is up to 3MHz. Is that valid here?

No, it should be either 100KHz or 400KHz, so far on i.MX I2C, ONLY 100KHz/400KHz are
supported/tested. 

> 
> > +
> > +  dmas:
> > +    items:
> > +      - description: DMA controller phandle and request line for RX
> > +      - description: DMA controller phandle and request line for TX
> > +
> > +  dma-names:
> > +    items:
> > +      - const: rx
> > +      - const: tx
> > +
> > +  sda-gpios:
> > +    $ref: '/schemas/types.yaml#/definitions/phandle'
> 
> *-gpios already has a type

Will remove -gpios' type/description as it is already defined in i2c-gpio.yaml.

> 
> > +    description: |
> > +      gpio used for the sda signal, this should be flagged as
> > +      active high using open drain with
> (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
> > +      from <dt-bindings/gpio/gpio.h> since the signal is by definition
> > +      open drain.
> > +    maxItems: 1
> > +
> > +  scl-gpios:
> > +    $ref: '/schemas/types.yaml#/definitions/phandle'
> > +    description: |
> > +      gpio used for the scl signal, this should be flagged as
> > +      active high using open drain with
> (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
> > +      from <dt-bindings/gpio/gpio.h> since the signal is by definition
> > +      open drain.
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - clocks
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/clock/imx5-clock.h>
> > +    #include <dt-bindings/clock/vf610-clock.h>
> > +    #include <dt-bindings/gpio/gpio.h>
> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> > +
> > +    i2c@83fc4000 {
> > +        compatible = "fsl,imx51-i2c", "fsl,imx21-i2c";
> > +        reg = <0x83fc4000 0x4000>;
> > +        interrupts = <63>;
> > +        clocks = <&clks IMX5_CLK_I2C2_GATE>;
> > +    };
> > +
> > +    i2c@40066000 {
> > +        compatible = "fsl,vf610-i2c";
> > +        reg = <0x40066000 0x1000>;
> > +        interrupts = <71 IRQ_TYPE_LEVEL_HIGH>;
> > +        clocks = <&clks VF610_CLK_I2C0>;
> > +        clock-names = "ipg";
> > +        dmas = <&edma0 0 50>,
> > +               <&edma0 0 51>;
> > +        dma-names = "rx","tx";
> 
> space                       ^

Will fix it in V3.

Thanks,
Anson