diff mbox series

[v2,3/3] dt-bindings: reset: convert Hisilicon reset controller bindings to json-schema

Message ID 20201204014236.1158-4-thunder.leizhen@huawei.com
State Superseded
Headers show
Series dt-bindings: reset: convert Hisilicon reset controller bindings to json-schema | expand

Commit Message

Leizhen (ThunderTown) Dec. 4, 2020, 1:42 a.m. UTC
Convert the Hisilicon reset controller binding to DT schema format using
json-schema.

Signed-off-by: Zhen Lei <thunder.leizhen@huawei.com>

---
 .../bindings/reset/hisilicon,hi3660-reset.txt      | 44 -------------
 .../bindings/reset/hisilicon,hi3660-reset.yaml     | 77 ++++++++++++++++++++++
 2 files changed, 77 insertions(+), 44 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt
 create mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

-- 
1.8.3

Comments

Rob Herring (Arm) Dec. 7, 2020, 11:10 p.m. UTC | #1
On Fri, Dec 04, 2020 at 09:42:36AM +0800, Zhen Lei wrote:
> Convert the Hisilicon reset controller binding to DT schema format using

> json-schema.

> 

> Signed-off-by: Zhen Lei <thunder.leizhen@huawei.com>

> ---

>  .../bindings/reset/hisilicon,hi3660-reset.txt      | 44 -------------

>  .../bindings/reset/hisilicon,hi3660-reset.yaml     | 77 ++++++++++++++++++++++

>  2 files changed, 77 insertions(+), 44 deletions(-)

>  delete mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt

>  create mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

> 

> diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt

> deleted file mode 100644

> index aefd26710f9e87d..000000000000000

> --- a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt

> +++ /dev/null

> @@ -1,44 +0,0 @@

> -Hisilicon System Reset Controller

> -======================================

> -

> -Please also refer to reset.txt in this directory for common reset

> -controller binding usage.

> -

> -The reset controller registers are part of the system-ctl block on

> -hi3660 and hi3670 SoCs.

> -

> -Required properties:

> -- compatible: should be one of the following:

> -		 "hisilicon,hi3660-reset" for HI3660

> -		 "hisilicon,hi3670-reset", "hisilicon,hi3660-reset" for HI3670

> -- hisilicon,rst-syscon: phandle of the reset's syscon.

> -- #reset-cells : Specifies the number of cells needed to encode a

> -  reset source.  The type shall be a <u32> and the value shall be 2.

> -

> -	 Cell #1 : offset of the reset assert control

> -	           register from the syscon register base

> -		   offset + 4: deassert control register

> -		   offset + 8: status control register

> -	 Cell #2 : bit position of the reset in the reset control register

> -

> -Example:

> -	iomcu: iomcu@ffd7e000 {

> -		compatible = "hisilicon,hi3660-iomcu", "syscon";

> -		reg = <0x0 0xffd7e000 0x0 0x1000>;

> -	};

> -

> -	iomcu_rst: iomcu_rst_controller {

> -		compatible = "hisilicon,hi3660-reset";

> -		hisilicon,rst-syscon = <&iomcu>;

> -		#reset-cells = <2>;

> -	};

> -

> -Specifying reset lines connected to IP modules

> -==============================================

> -example:

> -

> -        i2c0: i2c@..... {

> -                ...

> -		resets = <&iomcu_rst 0x20 3>; /* offset: 0x20; bit: 3 */

> -                ...

> -        };

> diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

> new file mode 100644

> index 000000000000000..9bf40952e5b7d28

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

> @@ -0,0 +1,77 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/reset/hisilicon,hi3660-reset.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Hisilicon System Reset Controller

> +

> +maintainers:

> +  - Wei Xu <xuwei5@hisilicon.com>

> +

> +description: |

> +  Please also refer to reset.txt in this directory for common reset

> +  controller binding usage.

> +  The reset controller registers are part of the system-ctl block on

> +  hi3660 and hi3670 SoCs.

> +

> +properties:

> +  compatible:

> +    oneOf:

> +      - items:

> +          - const: hisilicon,hi3660-reset

> +      - items:

> +          - const: hisilicon,hi3670-reset

> +          - const: hisilicon,hi3660-reset

> +

> +  hisilicon,rst-syscon:

> +    description: phandle of the reset's syscon.

> +    $ref: /schemas/types.yaml#/definitions/phandle

> +

> +  '#reset-cells':

> +    description: |

> +      Specifies the number of cells needed to encode a reset source.

> +      Cell #1 : offset of the reset assert control register from the syscon

> +                register base

> +                offset + 4: deassert control register

> +                offset + 8: status control register

> +      Cell #2 : bit position of the reset in the reset control register

> +    const: 2

> +

> +required:

> +  - compatible

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    #include <dt-bindings/interrupt-controller/irq.h>

> +    #include <dt-bindings/interrupt-controller/arm-gic.h>

> +    #include <dt-bindings/clock/hi3660-clock.h>

> +

> +    iomcu: iomcu@ffd7e000 {

> +        compatible = "hisilicon,hi3660-iomcu", "syscon";

> +        reg = <0xffd7e000 0x1000>;

> +    };

> +

> +    iomcu_rst: iomcu_rst_controller {

> +        compatible = "hisilicon,hi3660-reset";

> +        hisilicon,rst-syscon = <&iomcu>;


Really, if you are going to break things, this node should be a child of 
iomcu instead and you don't need this property (just get the parent). Or 
just add '#reset-cells' to iomcu.

> +        #reset-cells = <2>;

> +    };

> +

> +    /* Specifying reset lines connected to IP modules */

> +    i2c@ffd71000 {

> +        compatible = "snps,designware-i2c";

> +        reg = <0xffd71000 0x1000>;

> +        interrupts = <GIC_SPI 118 IRQ_TYPE_LEVEL_HIGH>;

> +        #address-cells = <1>;

> +        #size-cells = <0>;

> +        clock-frequency = <400000>;

> +        clocks = <&crg_ctrl HI3660_CLK_GATE_I2C0>;

> +        resets = <&iomcu_rst 0x20 3>;

> +        pinctrl-names = "default";

> +        pinctrl-0 = <&i2c0_pmx_func &i2c0_cfg_func>;

> +        status = "disabled";

> +    };

> +...

> -- 

> 1.8.3

> 

>
Leizhen (ThunderTown) Dec. 8, 2020, 3:07 a.m. UTC | #2
On 2020/12/8 7:10, Rob Herring wrote:
> On Fri, Dec 04, 2020 at 09:42:36AM +0800, Zhen Lei wrote:

>> Convert the Hisilicon reset controller binding to DT schema format using

>> json-schema.

>>

>> Signed-off-by: Zhen Lei <thunder.leizhen@huawei.com>

>> ---

>>  .../bindings/reset/hisilicon,hi3660-reset.txt      | 44 -------------

>>  .../bindings/reset/hisilicon,hi3660-reset.yaml     | 77 ++++++++++++++++++++++

>>  2 files changed, 77 insertions(+), 44 deletions(-)

>>  delete mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt

>>  create mode 100644 Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

>>

>> diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt

>> deleted file mode 100644

>> index aefd26710f9e87d..000000000000000

>> --- a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt

>> +++ /dev/null

>> @@ -1,44 +0,0 @@

>> -Hisilicon System Reset Controller

>> -======================================

>> -

>> -Please also refer to reset.txt in this directory for common reset

>> -controller binding usage.

>> -

>> -The reset controller registers are part of the system-ctl block on

>> -hi3660 and hi3670 SoCs.

>> -

>> -Required properties:

>> -- compatible: should be one of the following:

>> -		 "hisilicon,hi3660-reset" for HI3660

>> -		 "hisilicon,hi3670-reset", "hisilicon,hi3660-reset" for HI3670

>> -- hisilicon,rst-syscon: phandle of the reset's syscon.

>> -- #reset-cells : Specifies the number of cells needed to encode a

>> -  reset source.  The type shall be a <u32> and the value shall be 2.

>> -

>> -	 Cell #1 : offset of the reset assert control

>> -	           register from the syscon register base

>> -		   offset + 4: deassert control register

>> -		   offset + 8: status control register

>> -	 Cell #2 : bit position of the reset in the reset control register

>> -

>> -Example:

>> -	iomcu: iomcu@ffd7e000 {

>> -		compatible = "hisilicon,hi3660-iomcu", "syscon";

>> -		reg = <0x0 0xffd7e000 0x0 0x1000>;

>> -	};

>> -

>> -	iomcu_rst: iomcu_rst_controller {

>> -		compatible = "hisilicon,hi3660-reset";

>> -		hisilicon,rst-syscon = <&iomcu>;

>> -		#reset-cells = <2>;

>> -	};

>> -

>> -Specifying reset lines connected to IP modules

>> -==============================================

>> -example:

>> -

>> -        i2c0: i2c@..... {

>> -                ...

>> -		resets = <&iomcu_rst 0x20 3>; /* offset: 0x20; bit: 3 */

>> -                ...

>> -        };

>> diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

>> new file mode 100644

>> index 000000000000000..9bf40952e5b7d28

>> --- /dev/null

>> +++ b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml

>> @@ -0,0 +1,77 @@

>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

>> +%YAML 1.2

>> +---

>> +$id: http://devicetree.org/schemas/reset/hisilicon,hi3660-reset.yaml#

>> +$schema: http://devicetree.org/meta-schemas/core.yaml#

>> +

>> +title: Hisilicon System Reset Controller

>> +

>> +maintainers:

>> +  - Wei Xu <xuwei5@hisilicon.com>

>> +

>> +description: |

>> +  Please also refer to reset.txt in this directory for common reset

>> +  controller binding usage.

>> +  The reset controller registers are part of the system-ctl block on

>> +  hi3660 and hi3670 SoCs.

>> +

>> +properties:

>> +  compatible:

>> +    oneOf:

>> +      - items:

>> +          - const: hisilicon,hi3660-reset

>> +      - items:

>> +          - const: hisilicon,hi3670-reset

>> +          - const: hisilicon,hi3660-reset

>> +

>> +  hisilicon,rst-syscon:

>> +    description: phandle of the reset's syscon.

>> +    $ref: /schemas/types.yaml#/definitions/phandle

>> +

>> +  '#reset-cells':

>> +    description: |

>> +      Specifies the number of cells needed to encode a reset source.

>> +      Cell #1 : offset of the reset assert control register from the syscon

>> +                register base

>> +                offset + 4: deassert control register

>> +                offset + 8: status control register

>> +      Cell #2 : bit position of the reset in the reset control register

>> +    const: 2

>> +

>> +required:

>> +  - compatible

>> +

>> +additionalProperties: false

>> +

>> +examples:

>> +  - |

>> +    #include <dt-bindings/interrupt-controller/irq.h>

>> +    #include <dt-bindings/interrupt-controller/arm-gic.h>

>> +    #include <dt-bindings/clock/hi3660-clock.h>

>> +

>> +    iomcu: iomcu@ffd7e000 {

>> +        compatible = "hisilicon,hi3660-iomcu", "syscon";

>> +        reg = <0xffd7e000 0x1000>;

>> +    };

>> +

>> +    iomcu_rst: iomcu_rst_controller {

>> +        compatible = "hisilicon,hi3660-reset";

>> +        hisilicon,rst-syscon = <&iomcu>;

> 

> Really, if you are going to break things, this node should be a child of 

> iomcu instead and you don't need this property (just get the parent). Or 

> just add '#reset-cells' to iomcu.


There are two compatible strings, which belong to two different functional
modules. This should be done to keep the code architecture clear.

drivers/clk/hisilicon/clk-hi3660.c		//compatible = "hisilicon,hi3660-iomcu"
drivers/reset/hisilicon/reset-hi3660.c		//compatible = "hisilicon,hi3660-reset"

> 

>> +        #reset-cells = <2>;

>> +    };

>> +

>> +    /* Specifying reset lines connected to IP modules */

>> +    i2c@ffd71000 {

>> +        compatible = "snps,designware-i2c";

>> +        reg = <0xffd71000 0x1000>;

>> +        interrupts = <GIC_SPI 118 IRQ_TYPE_LEVEL_HIGH>;

>> +        #address-cells = <1>;

>> +        #size-cells = <0>;

>> +        clock-frequency = <400000>;

>> +        clocks = <&crg_ctrl HI3660_CLK_GATE_I2C0>;

>> +        resets = <&iomcu_rst 0x20 3>;

>> +        pinctrl-names = "default";

>> +        pinctrl-0 = <&i2c0_pmx_func &i2c0_cfg_func>;

>> +        status = "disabled";

>> +    };

>> +...

>> -- 

>> 1.8.3

>>

>>

> 

> .

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt
deleted file mode 100644
index aefd26710f9e87d..000000000000000
--- a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.txt
+++ /dev/null
@@ -1,44 +0,0 @@ 
-Hisilicon System Reset Controller
-======================================
-
-Please also refer to reset.txt in this directory for common reset
-controller binding usage.
-
-The reset controller registers are part of the system-ctl block on
-hi3660 and hi3670 SoCs.
-
-Required properties:
-- compatible: should be one of the following:
-		 "hisilicon,hi3660-reset" for HI3660
-		 "hisilicon,hi3670-reset", "hisilicon,hi3660-reset" for HI3670
-- hisilicon,rst-syscon: phandle of the reset's syscon.
-- #reset-cells : Specifies the number of cells needed to encode a
-  reset source.  The type shall be a <u32> and the value shall be 2.
-
-	 Cell #1 : offset of the reset assert control
-	           register from the syscon register base
-		   offset + 4: deassert control register
-		   offset + 8: status control register
-	 Cell #2 : bit position of the reset in the reset control register
-
-Example:
-	iomcu: iomcu@ffd7e000 {
-		compatible = "hisilicon,hi3660-iomcu", "syscon";
-		reg = <0x0 0xffd7e000 0x0 0x1000>;
-	};
-
-	iomcu_rst: iomcu_rst_controller {
-		compatible = "hisilicon,hi3660-reset";
-		hisilicon,rst-syscon = <&iomcu>;
-		#reset-cells = <2>;
-	};
-
-Specifying reset lines connected to IP modules
-==============================================
-example:
-
-        i2c0: i2c@..... {
-                ...
-		resets = <&iomcu_rst 0x20 3>; /* offset: 0x20; bit: 3 */
-                ...
-        };
diff --git a/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml
new file mode 100644
index 000000000000000..9bf40952e5b7d28
--- /dev/null
+++ b/Documentation/devicetree/bindings/reset/hisilicon,hi3660-reset.yaml
@@ -0,0 +1,77 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/reset/hisilicon,hi3660-reset.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Hisilicon System Reset Controller
+
+maintainers:
+  - Wei Xu <xuwei5@hisilicon.com>
+
+description: |
+  Please also refer to reset.txt in this directory for common reset
+  controller binding usage.
+  The reset controller registers are part of the system-ctl block on
+  hi3660 and hi3670 SoCs.
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - const: hisilicon,hi3660-reset
+      - items:
+          - const: hisilicon,hi3670-reset
+          - const: hisilicon,hi3660-reset
+
+  hisilicon,rst-syscon:
+    description: phandle of the reset's syscon.
+    $ref: /schemas/types.yaml#/definitions/phandle
+
+  '#reset-cells':
+    description: |
+      Specifies the number of cells needed to encode a reset source.
+      Cell #1 : offset of the reset assert control register from the syscon
+                register base
+                offset + 4: deassert control register
+                offset + 8: status control register
+      Cell #2 : bit position of the reset in the reset control register
+    const: 2
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/hi3660-clock.h>
+
+    iomcu: iomcu@ffd7e000 {
+        compatible = "hisilicon,hi3660-iomcu", "syscon";
+        reg = <0xffd7e000 0x1000>;
+    };
+
+    iomcu_rst: iomcu_rst_controller {
+        compatible = "hisilicon,hi3660-reset";
+        hisilicon,rst-syscon = <&iomcu>;
+        #reset-cells = <2>;
+    };
+
+    /* Specifying reset lines connected to IP modules */
+    i2c@ffd71000 {
+        compatible = "snps,designware-i2c";
+        reg = <0xffd71000 0x1000>;
+        interrupts = <GIC_SPI 118 IRQ_TYPE_LEVEL_HIGH>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+        clock-frequency = <400000>;
+        clocks = <&crg_ctrl HI3660_CLK_GATE_I2C0>;
+        resets = <&iomcu_rst 0x20 3>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&i2c0_pmx_func &i2c0_cfg_func>;
+        status = "disabled";
+    };
+...