2020-06-04 02:04:22

by Anson Huang

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

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

Signed-off-by: Anson Huang <[email protected]>
---
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 <[email protected]>
+
+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

2020-06-15 17:16:14

by Rob Herring (Arm)

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

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 <[email protected]>
> ---
> 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 <[email protected]>
> +
> +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
>