[v4,07/10] dt-bindings: soc: rockchip: Convert grf.txt to YAML

Message ID 20210429081321.17855-1-cl@rock-chips.com
State New
Headers show
Series
  • arm64: dts: rockchip: add basic dtsi/dts files for RK3568 SoC
Related show

Commit Message

陈亮 April 29, 2021, 8:13 a.m.
From: Liang Chen <cl@rock-chips.com>

Current dts files with 'grf' nodes are manually verified. In order to
automate this process grf.txt has to be converted to YAML.

Add new descriptions for:
"rockchip,rk3568-grf", "syscon", "simple-mfd"
"rockchip,rk3568-pmugrf", "syscon", "simple-mfd"

Signed-off-by: Liang Chen <cl@rock-chips.com>
---
 .../devicetree/bindings/soc/rockchip/grf.txt  | 61 -------------------
 .../devicetree/bindings/soc/rockchip/grf.yaml | 60 ++++++++++++++++++
 2 files changed, 60 insertions(+), 61 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/soc/rockchip/grf.txt
 create mode 100644 Documentation/devicetree/bindings/soc/rockchip/grf.yaml

Comments

陈亮 April 30, 2021, 12:47 a.m. | #1
在 2021/4/30 上午5:24, Rob Herring 写道:
> On Thu, Apr 29, 2021 at 04:13:21PM +0800, cl@rock-chips.com wrote:

>> From: Liang Chen <cl@rock-chips.com>

>>

>> Current dts files with 'grf' nodes are manually verified. In order to

>> automate this process grf.txt has to be converted to YAML.

>>

>> Add new descriptions for:

>> "rockchip,rk3568-grf", "syscon", "simple-mfd"

>> "rockchip,rk3568-pmugrf", "syscon", "simple-mfd"

>>

>> Signed-off-by: Liang Chen <cl@rock-chips.com>

>> ---

>>   .../devicetree/bindings/soc/rockchip/grf.txt  | 61 -------------------

>>   .../devicetree/bindings/soc/rockchip/grf.yaml | 60 ++++++++++++++++++

>>   2 files changed, 60 insertions(+), 61 deletions(-)

>>   delete mode 100644 Documentation/devicetree/bindings/soc/rockchip/grf.txt

>>   create mode 100644 Documentation/devicetree/bindings/soc/rockchip/grf.yaml

>>

>> diff --git a/Documentation/devicetree/bindings/soc/rockchip/grf.txt b/Documentation/devicetree/bindings/soc/rockchip/grf.txt

>> deleted file mode 100644

>> index f96511aa3897..000000000000

>> --- a/Documentation/devicetree/bindings/soc/rockchip/grf.txt

>> +++ /dev/null

>> @@ -1,61 +0,0 @@

>> -* Rockchip General Register Files (GRF)

>> -

>> -The general register file will be used to do static set by software, which

>> -is composed of many registers for system control.

>> -

>> -From RK3368 SoCs, the GRF is divided into two sections,

>> -- GRF, used for general non-secure system,

>> -- SGRF, used for general secure system,

>> -- PMUGRF, used for always on system

>> -

>> -On RK3328 SoCs, the GRF adds a section for USB2PHYGRF,

>> -

>> -ON RK3308 SoC, the GRF is divided into four sections:

>> -- GRF, used for general non-secure system,

>> -- SGRF, used for general secure system,

>> -- DETECTGRF, used for audio codec system,

>> -- COREGRF, used for pvtm,

>> -

>> -Required Properties:

>> -

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

>> -   - "rockchip,px30-grf", "syscon": for px30

>> -   - "rockchip,rk3036-grf", "syscon": for rk3036

>> -   - "rockchip,rk3066-grf", "syscon": for rk3066

>> -   - "rockchip,rk3188-grf", "syscon": for rk3188

>> -   - "rockchip,rk3228-grf", "syscon": for rk3228

>> -   - "rockchip,rk3288-grf", "syscon": for rk3288

>> -   - "rockchip,rk3308-grf", "syscon": for rk3308

>> -   - "rockchip,rk3328-grf", "syscon": for rk3328

>> -   - "rockchip,rk3368-grf", "syscon": for rk3368

>> -   - "rockchip,rk3399-grf", "syscon": for rk3399

>> -   - "rockchip,rv1108-grf", "syscon": for rv1108

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

>> -   - "rockchip,rk3308-detect-grf", "syscon": for rk3308

>> -- compatilbe: COREGRF should be one of the following:

>> -   - "rockchip,rk3308-core-grf", "syscon": for rk3308

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

>> -   - "rockchip,px30-pmugrf", "syscon": for px30

>> -   - "rockchip,rk3368-pmugrf", "syscon": for rk3368

>> -   - "rockchip,rk3399-pmugrf", "syscon": for rk3399

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

>> -   - "rockchip,rk3288-sgrf", "syscon": for rk3288

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

>> -   - "rockchip,px30-usb2phy-grf", "syscon": for px30

>> -   - "rockchip,rk3328-usb2phy-grf", "syscon": for rk3328

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

>> -   - "rockchip,rv1108-usbgrf", "syscon": for rv1108

>> -- reg: physical base address of the controller and length of memory mapped

>> -  region.

>> -

>> -Example: GRF and PMUGRF of RK3399 SoCs

>> -

>> -	pmugrf: syscon@ff320000 {

>> -		compatible = "rockchip,rk3399-pmugrf", "syscon";

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

>> -	};

>> -

>> -	grf: syscon@ff770000 {

>> -		compatible = "rockchip,rk3399-grf", "syscon";

>> -		reg = <0x0 0xff770000 0x0 0x10000>;

>> -	};

>> diff --git a/Documentation/devicetree/bindings/soc/rockchip/grf.yaml b/Documentation/devicetree/bindings/soc/rockchip/grf.yaml

>> new file mode 100644

>> index 000000000000..93231b95554b

>> --- /dev/null

>> +++ b/Documentation/devicetree/bindings/soc/rockchip/grf.yaml

>> @@ -0,0 +1,60 @@

>> +# SPDX-License-Identifier: GPL-2.0

>> +%YAML 1.2

>> +---

>> +$id: http://devicetree.org/schemas/soc/rockchip/grf.yaml#

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

>> +

>> +title: Rockchip General Register Files

>> +

>> +maintainers:

>> +  - Heiko Stuebner <heiko@sntech.de>

>> +

>> +properties:

>> +  compatible:

>> +    - items:

> The '-' is the source of your error.

Thanks.
>

>> +        - enum:

>> +            - rockchip,px30-grf

>> +            - rockchip,px30-pmugrf

>> +            - rockchip,px30-usb2phy-grf

>> +            - rockchip,rk3036-grf

>> +            - rockchip,rk3066-grf

>> +            - rockchip,rk3188-grf

>> +            - rockchip,rk3228-grf

>> +            - rockchip,rk3288-grf

>> +            - rockchip,rk3288-sgrf

>> +            - rockchip,rk3308-core-grf

>> +            - rockchip,rk3308-detect-grf

>> +            - rockchip,rk3308-grf

>> +            - rockchip,rk3328-grf

>> +            - rockchip,rk3328-usb2phy-grf

>> +            - rockchip,rk3368-grf

>> +            - rockchip,rk3368-pmugrf

>> +            - rockchip,rk3399-grf

>> +            - rockchip,rk3399-pmugrf

>> +            - rockchip,rk3568-grf

>> +            - rockchip,rk3568-pmugrf

>> +            - rockchip,rv1108-grf

>> +            - rockchip,rv1108-usbgrf

>> +        - const: syscon

>> +        - const: simple-mfd

> 'simple-mfd' was not in the old binding. That implies you have child

> nodes, and if so, they need to be documented. I imagine that will mean

> splitting this into multiple schemas if that's the case.

Maybe add the child nodes and document in a new submit.
>> documented

>> +

>> +  reg:

>> +    maxItems: 1

>> +

>> +required:

>> +  - compatible

>> +  - reg

>> +

>> +additionalProperties: false

>> +

>> +examples:

>> +  - |

>> +    pmugrf: syscon@ff320000 {

>> +       compatible = "rockchip,rk3399-pmugrf", "syscon", "simple-mfd";

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

>> +    };

>> +

>> +    grf: syscon@ff770000 {

>> +       compatible = "rockchip,rk3399-grf", "syscon", "simple-mfd";

>> +       reg = <0xff770000 0x10000>;

>> +    };

>> -- 

>> 2.17.1

>>

>>

>>

>

>
Johan Jonker April 30, 2021, 8:29 p.m. | #2
On 4/29/21 11:24 PM, Rob Herring wrote:
> On Thu, Apr 29, 2021 at 04:13:21PM +0800, cl@rock-chips.com wrote:
>> From: Liang Chen <cl@rock-chips.com>
>>
>> Current dts files with 'grf' nodes are manually verified. In order to
>> automate this process grf.txt has to be converted to YAML.
>>
>> Add new descriptions for:
>> "rockchip,rk3568-grf", "syscon", "simple-mfd"
>> "rockchip,rk3568-pmugrf", "syscon", "simple-mfd"
>>
>> Signed-off-by: Liang Chen <cl@rock-chips.com>
>> ---

[..]

>> +properties:
>> +  compatible:
>> +    - items:
> 
> The '-' is the source of your error.
> 
>> +        - enum:
>> +            - rockchip,px30-grf
>> +            - rockchip,px30-pmugrf
>> +            - rockchip,px30-usb2phy-grf
>> +            - rockchip,rk3036-grf
>> +            - rockchip,rk3066-grf
>> +            - rockchip,rk3188-grf
>> +            - rockchip,rk3228-grf
>> +            - rockchip,rk3288-grf
>> +            - rockchip,rk3288-sgrf
>> +            - rockchip,rk3308-core-grf
>> +            - rockchip,rk3308-detect-grf
>> +            - rockchip,rk3308-grf
>> +            - rockchip,rk3328-grf
>> +            - rockchip,rk3328-usb2phy-grf
>> +            - rockchip,rk3368-grf
>> +            - rockchip,rk3368-pmugrf
>> +            - rockchip,rk3399-grf
>> +            - rockchip,rk3399-pmugrf
>> +            - rockchip,rk3568-grf
>> +            - rockchip,rk3568-pmugrf
>> +            - rockchip,rv1108-grf
>> +            - rockchip,rv1108-usbgrf
>> +        - const: syscon
>> +        - const: simple-mfd
> 

> 'simple-mfd' was not in the old binding. That implies you have child 
> nodes, and if so, they need to be documented. I imagine that will mean 
> splitting this into multiple schemas if that's the case.
> 

Hi,

Question for rob+dt:

Given that a number of txt documents still are in need for YAML
conversion. Which is a bit beyond the author of this serie.
The core rk3568.dtsi is needed for other series to base on.

To speed things up a bit and reduce the work load:
Is it possible to add the grf compatibles in use first and do the rest
of the subnodes for various SoCs later?

Is it possible to add for now to reduce notification output:

additionalProperties: true

and then later:

additionalProperties: false


===

Patch

diff --git a/Documentation/devicetree/bindings/soc/rockchip/grf.txt b/Documentation/devicetree/bindings/soc/rockchip/grf.txt
deleted file mode 100644
index f96511aa3897..000000000000
--- a/Documentation/devicetree/bindings/soc/rockchip/grf.txt
+++ /dev/null
@@ -1,61 +0,0 @@ 
-* Rockchip General Register Files (GRF)
-
-The general register file will be used to do static set by software, which
-is composed of many registers for system control.
-
-From RK3368 SoCs, the GRF is divided into two sections,
-- GRF, used for general non-secure system,
-- SGRF, used for general secure system,
-- PMUGRF, used for always on system
-
-On RK3328 SoCs, the GRF adds a section for USB2PHYGRF,
-
-ON RK3308 SoC, the GRF is divided into four sections:
-- GRF, used for general non-secure system,
-- SGRF, used for general secure system,
-- DETECTGRF, used for audio codec system,
-- COREGRF, used for pvtm,
-
-Required Properties:
-
-- compatible: GRF should be one of the following:
-   - "rockchip,px30-grf", "syscon": for px30
-   - "rockchip,rk3036-grf", "syscon": for rk3036
-   - "rockchip,rk3066-grf", "syscon": for rk3066
-   - "rockchip,rk3188-grf", "syscon": for rk3188
-   - "rockchip,rk3228-grf", "syscon": for rk3228
-   - "rockchip,rk3288-grf", "syscon": for rk3288
-   - "rockchip,rk3308-grf", "syscon": for rk3308
-   - "rockchip,rk3328-grf", "syscon": for rk3328
-   - "rockchip,rk3368-grf", "syscon": for rk3368
-   - "rockchip,rk3399-grf", "syscon": for rk3399
-   - "rockchip,rv1108-grf", "syscon": for rv1108
-- compatible: DETECTGRF should be one of the following:
-   - "rockchip,rk3308-detect-grf", "syscon": for rk3308
-- compatilbe: COREGRF should be one of the following:
-   - "rockchip,rk3308-core-grf", "syscon": for rk3308
-- compatible: PMUGRF should be one of the following:
-   - "rockchip,px30-pmugrf", "syscon": for px30
-   - "rockchip,rk3368-pmugrf", "syscon": for rk3368
-   - "rockchip,rk3399-pmugrf", "syscon": for rk3399
-- compatible: SGRF should be one of the following:
-   - "rockchip,rk3288-sgrf", "syscon": for rk3288
-- compatible: USB2PHYGRF should be one of the following:
-   - "rockchip,px30-usb2phy-grf", "syscon": for px30
-   - "rockchip,rk3328-usb2phy-grf", "syscon": for rk3328
-- compatible: USBGRF should be one of the following:
-   - "rockchip,rv1108-usbgrf", "syscon": for rv1108
-- reg: physical base address of the controller and length of memory mapped
-  region.
-
-Example: GRF and PMUGRF of RK3399 SoCs
-
-	pmugrf: syscon@ff320000 {
-		compatible = "rockchip,rk3399-pmugrf", "syscon";
-		reg = <0x0 0xff320000 0x0 0x1000>;
-	};
-
-	grf: syscon@ff770000 {
-		compatible = "rockchip,rk3399-grf", "syscon";
-		reg = <0x0 0xff770000 0x0 0x10000>;
-	};
diff --git a/Documentation/devicetree/bindings/soc/rockchip/grf.yaml b/Documentation/devicetree/bindings/soc/rockchip/grf.yaml
new file mode 100644
index 000000000000..93231b95554b
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/rockchip/grf.yaml
@@ -0,0 +1,60 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/soc/rockchip/grf.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Rockchip General Register Files
+
+maintainers:
+  - Heiko Stuebner <heiko@sntech.de>
+
+properties:
+  compatible:
+    - items:
+        - enum:
+            - rockchip,px30-grf
+            - rockchip,px30-pmugrf
+            - rockchip,px30-usb2phy-grf
+            - rockchip,rk3036-grf
+            - rockchip,rk3066-grf
+            - rockchip,rk3188-grf
+            - rockchip,rk3228-grf
+            - rockchip,rk3288-grf
+            - rockchip,rk3288-sgrf
+            - rockchip,rk3308-core-grf
+            - rockchip,rk3308-detect-grf
+            - rockchip,rk3308-grf
+            - rockchip,rk3328-grf
+            - rockchip,rk3328-usb2phy-grf
+            - rockchip,rk3368-grf
+            - rockchip,rk3368-pmugrf
+            - rockchip,rk3399-grf
+            - rockchip,rk3399-pmugrf
+            - rockchip,rk3568-grf
+            - rockchip,rk3568-pmugrf
+            - rockchip,rv1108-grf
+            - rockchip,rv1108-usbgrf
+        - const: syscon
+        - const: simple-mfd
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    pmugrf: syscon@ff320000 {
+       compatible = "rockchip,rk3399-pmugrf", "syscon", "simple-mfd";
+       reg = <0xff320000 0x1000>;
+    };
+
+    grf: syscon@ff770000 {
+       compatible = "rockchip,rk3399-grf", "syscon", "simple-mfd";
+       reg = <0xff770000 0x10000>;
+    };