diff mbox series

[v2] dt-bindings: convert rockchip-drm.txt to rockchip-drm.yaml

Message ID 20200121123445.29774-1-dafna.hirschfeld@collabora.com (mailing list archive)
State New, archived
Headers show
Series [v2] dt-bindings: convert rockchip-drm.txt to rockchip-drm.yaml | expand

Commit Message

Dafna Hirschfeld Jan. 21, 2020, 12:34 p.m. UTC
convert the binding file rockchip-drm.txt to yaml format.
This was tested and verified with:
make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
---
Changes since v1:
- fixed worng sign-off
- fixed the path of the $id property to be the path of the yaml file

 .../display/rockchip/rockchip-drm.txt         | 19 ----------
 .../display/rockchip/rockchip-drm.yaml        | 38 +++++++++++++++++++
 2 files changed, 38 insertions(+), 19 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
 create mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

Comments

Johan Jonker Jan. 21, 2020, 1:11 p.m. UTC | #1
Hi Dafna,

You are checking at the wrong platforms.
Maintainers incomplete. ">" is missing.
Recheck please.

Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml:
ignoring, error in schema: maintainers: 0

make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- menuconfig
# change in menuconfig to Rockchip system

make ARCH=arm dt_binding_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

make ARCH=arm dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

make ARCH=arm64 defconfig

make ARCH=arm64 menuconfig
# change in menuconfig to Rockchip platform

make ARCH=arm64 dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

> From: Dafna Hirschfeld <dafna.hirschfeld at gmail.com>
> 
> convert the binding file rockchip-drm.txt to yaml format.
> This was tested and verified with:
> make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> 
> Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld at gmail.com>
> ---
>  .../display/rockchip/rockchip-drm.txt         | 19 ----------
>  .../display/rockchip/rockchip-drm.yaml        | 38 +++++++++++++++++++
>  2 files changed, 38 insertions(+), 19 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
>  create mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> 
> diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
> deleted file mode 100644
> index 5707af89319d..000000000000
> --- a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -Rockchip DRM master device
> -================================
> -
> -The Rockchip DRM master device is a virtual device needed to list all
> -vop devices or other display interface nodes that comprise the
> -graphics subsystem.
> -
> -Required properties:
> -- compatible: Should be "rockchip,display-subsystem"
> -- ports: Should contain a list of phandles pointing to display interface port
> -  of vop devices. vop definitions as defined in
> -  Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
> -
> -example:
> -
> -display-subsystem {
> -	compatible = "rockchip,display-subsystem";
> -	ports = <&vopl_out>, <&vopb_out>;
> -};
> diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> new file mode 100644
> index 000000000000..e4ef1a02196d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rockchip-drm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Rockchip DRM master device
> +
> +maintainers:

> +  - Sandy Huang <hjc at rock-chips.com

Add extra ">"

> +  - Heiko Stuebner <heiko at sntech.de>
> +
> +description: |
> +  The Rockchip DRM master device is a virtual device needed to list all
> +  vop devices or other display interface nodes that comprise the
> +  graphics subsystem.
> +
> +properties:
> +  compatible:
> +    const: rockchip,display-subsystem
> +
> +  ports:
> +    $ref: /schemas/types.yaml#/definitions/phandle-array
> +    description: |
> +      Should contain a list of phandles pointing to display interface port
> +      of vop devices. vop definitions as defined in
> +      Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
> +
> +required:
> +  - compatible
> +  - ports
> +
> +examples:
> +  - |
> +    display-subsystem {
> +        compatible = "rockchip,display-subsystem";
> +        ports = <&vopl_out>, <&vopb_out>;
> +    };
> -- 
> 2.17.1
Rob Herring Jan. 21, 2020, 2:03 p.m. UTC | #2
On Tue, Jan 21, 2020 at 6:35 AM Dafna Hirschfeld
<dafna.hirschfeld@collabora.com> wrote:
>
> convert the binding file rockchip-drm.txt to yaml format.
> This was tested and verified with:
> make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

Also, make sure just 'make dt_binding_check' passes as that checks the
example against all schemas.

> make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>
> Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
> ---
> Changes since v1:
> - fixed worng sign-off
> - fixed the path of the $id property to be the path of the yaml file
>
>  .../display/rockchip/rockchip-drm.txt         | 19 ----------
>  .../display/rockchip/rockchip-drm.yaml        | 38 +++++++++++++++++++
>  2 files changed, 38 insertions(+), 19 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
>  create mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>
> diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
> deleted file mode 100644
> index 5707af89319d..000000000000
> --- a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -Rockchip DRM master device
> -================================
> -
> -The Rockchip DRM master device is a virtual device needed to list all
> -vop devices or other display interface nodes that comprise the
> -graphics subsystem.
> -
> -Required properties:
> -- compatible: Should be "rockchip,display-subsystem"
> -- ports: Should contain a list of phandles pointing to display interface port
> -  of vop devices. vop definitions as defined in
> -  Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
> -
> -example:
> -
> -display-subsystem {
> -       compatible = "rockchip,display-subsystem";
> -       ports = <&vopl_out>, <&vopb_out>;
> -};
> diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> new file mode 100644
> index 000000000000..538898ada9d1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0+ OR MIT)

Do you have rights to change the license? The default is GPL-2.0-only.
Looks like Rockchip owns the copyright.

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/rockchip/rockchip-drm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Rockchip DRM master device
> +
> +maintainers:
> +  - Sandy Huang <hjc@rock-chips.com
> +  - Heiko Stuebner <heiko@sntech.de>
> +
> +description: |
> +  The Rockchip DRM master device is a virtual device needed to list all
> +  vop devices or other display interface nodes that comprise the
> +  graphics subsystem.
> +
> +properties:
> +  compatible:
> +    const: rockchip,display-subsystem
> +
> +  ports:
> +    $ref: /schemas/types.yaml#/definitions/phandle-array
> +    description: |
> +      Should contain a list of phandles pointing to display interface port
> +      of vop devices. vop definitions as defined in
> +      Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
> +
> +required:
> +  - compatible
> +  - ports

Add:

additionalProperties: false

> +
> +examples:
> +  - |
> +    display-subsystem {
> +        compatible = "rockchip,display-subsystem";
> +        ports = <&vopl_out>, <&vopb_out>;
> +    };
> --
> 2.17.1
>
Dafna Hirschfeld Jan. 21, 2020, 2:55 p.m. UTC | #3
On 21.01.20 15:03, Rob Herring wrote:
> On Tue, Jan 21, 2020 at 6:35 AM Dafna Hirschfeld
> <dafna.hirschfeld@collabora.com> wrote:
>>
>> convert the binding file rockchip-drm.txt to yaml format.
>> This was tested and verified with:
>> make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> 
> Also, make sure just 'make dt_binding_check' passes as that checks the
> example against all schemas.

But this also checks the other schemas in general, and when running it, 
it fails because of bugs in other schemas.
For example with arm=ARM I get:

   DTC     Documentation/devicetree/bindings/clock/qcom,gcc.example.dt.yaml
Error: 
Documentation/devicetree/bindings/clock/qcom,gcc.example.dts:111.28-29 
syntax error
FATAL ERROR: Unable to parse input tree

Dafna

> 
>> make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>
>> Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
>> ---
>> Changes since v1:
>> - fixed worng sign-off
>> - fixed the path of the $id property to be the path of the yaml file
>>
>>   .../display/rockchip/rockchip-drm.txt         | 19 ----------
>>   .../display/rockchip/rockchip-drm.yaml        | 38 +++++++++++++++++++
>>   2 files changed, 38 insertions(+), 19 deletions(-)
>>   delete mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
>>   create mode 100644 Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
>> deleted file mode 100644
>> index 5707af89319d..000000000000
>> --- a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
>> +++ /dev/null
>> @@ -1,19 +0,0 @@
>> -Rockchip DRM master device
>> -================================
>> -
>> -The Rockchip DRM master device is a virtual device needed to list all
>> -vop devices or other display interface nodes that comprise the
>> -graphics subsystem.
>> -
>> -Required properties:
>> -- compatible: Should be "rockchip,display-subsystem"
>> -- ports: Should contain a list of phandles pointing to display interface port
>> -  of vop devices. vop definitions as defined in
>> -  Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
>> -
>> -example:
>> -
>> -display-subsystem {
>> -       compatible = "rockchip,display-subsystem";
>> -       ports = <&vopl_out>, <&vopb_out>;
>> -};
>> diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>> new file mode 100644
>> index 000000000000..538898ada9d1
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>> @@ -0,0 +1,38 @@
>> +# SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> 
> Do you have rights to change the license? The default is GPL-2.0-only.
> Looks like Rockchip owns the copyright.
> 
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/display/rockchip/rockchip-drm.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Rockchip DRM master device
>> +
>> +maintainers:
>> +  - Sandy Huang <hjc@rock-chips.com
>> +  - Heiko Stuebner <heiko@sntech.de>
>> +
>> +description: |
>> +  The Rockchip DRM master device is a virtual device needed to list all
>> +  vop devices or other display interface nodes that comprise the
>> +  graphics subsystem.
>> +
>> +properties:
>> +  compatible:
>> +    const: rockchip,display-subsystem
>> +
>> +  ports:
>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>> +    description: |
>> +      Should contain a list of phandles pointing to display interface port
>> +      of vop devices. vop definitions as defined in
>> +      Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
>> +
>> +required:
>> +  - compatible
>> +  - ports
> 
> Add:
> 
> additionalProperties: false
> 
>> +
>> +examples:
>> +  - |
>> +    display-subsystem {
>> +        compatible = "rockchip,display-subsystem";
>> +        ports = <&vopl_out>, <&vopb_out>;
>> +    };
>> --
>> 2.17.1
>>
Johan Jonker Jan. 21, 2020, 3:11 p.m. UTC | #4
Hi Dafna,


> 
> 
> On 21.01.20 15:03, Rob Herring wrote:
>> On Tue, Jan 21, 2020 at 6:35 AM Dafna Hirschfeld
>> <dafna.hirschfeld@collabora.com> wrote:
>>>
>>> convert the binding file rockchip-drm.txt to yaml format.
>>> This was tested and verified with:
>>> make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>> 
>> Also, make sure just 'make dt_binding_check' passes as that checks the
>> example against all schemas.
> 
> But this also checks the other schemas in general, and when running it, 
> it fails because of bugs in other schemas.


> For example with arm=ARM I get:

Use:

# enable Rockchip arm in menuconfig
make ARCH=arm menuconfig

make ARCH=arm dt_binding_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

and not:
arm=ARM


> 
>    DTC     Documentation/devicetree/bindings/clock/qcom,gcc.example.dt.yaml
> Error: 
> Documentation/devicetree/bindings/clock/qcom,gcc.example.dts:111.28-29 
> syntax error
> FATAL ERROR: Unable to parse input tree
> 
> Dafna
> 
>> 
>>> make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>>
Dafna Hirschfeld Jan. 21, 2020, 3:26 p.m. UTC | #5
On 21.01.20 16:11, Johan Jonker wrote:
> Hi Dafna,
> 
> 
>>
>>
>> On 21.01.20 15:03, Rob Herring wrote:
>>> On Tue, Jan 21, 2020 at 6:35 AM Dafna Hirschfeld
>>> <dafna.hirschfeld@collabora.com> wrote:
>>>>
>>>> convert the binding file rockchip-drm.txt to yaml format.
>>>> This was tested and verified with:
>>>> make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>>
>>> Also, make sure just 'make dt_binding_check' passes as that checks the
>>> example against all schemas.
>>
>> But this also checks the other schemas in general, and when running it,
>> it fails because of bugs in other schemas.
> 
> 
>> For example with arm=ARM I get:
> 
> Use:
> 
> # enable Rockchip arm in menuconfig
> make ARCH=arm menuconfig
> 
> make ARCH=arm dt_binding_check
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
> 
> and not:
> arm=ARM
> 
yes, sorry, this is what I did. When running with the DT_SCHEMA_FILES 
set then it passes both on ARM and ARM64
but when this variable is not set I get the above error.

Dafna

> 
>>
>>     DTC     Documentation/devicetree/bindings/clock/qcom,gcc.example.dt.yaml
>> Error:
>> Documentation/devicetree/bindings/clock/qcom,gcc.example.dts:111.28-29
>> syntax error
>> FATAL ERROR: Unable to parse input tree
>>
>> Dafna
>>
>>>
>>>> make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>>>
>
Johan Jonker Jan. 21, 2020, 4 p.m. UTC | #6
Hi,

On 1/21/20 4:26 PM, Dafna Hirschfeld wrote:
> 
> 
> On 21.01.20 16:11, Johan Jonker wrote:
>> Hi Dafna,
>>
>>
>>>
>>>
>>> On 21.01.20 15:03, Rob Herring wrote:
>>>> On Tue, Jan 21, 2020 at 6:35 AM Dafna Hirschfeld
>>>> <dafna.hirschfeld@collabora.com> wrote:
>>>>>
>>>>> convert the binding file rockchip-drm.txt to yaml format.
>>>>> This was tested and verified with:
>>>>> make dt_binding_check
>>>>> DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>>>>
>>>>
>>>> Also, make sure just 'make dt_binding_check' passes as that checks the
>>>> example against all schemas.
>>>
>>> But this also checks the other schemas in general, and when running it,
>>> it fails because of bugs in other schemas.
>>
>>
>>> For example with arm=ARM I get:
>>
>> Use:
>>
>> # enable Rockchip arm in menuconfig
>> make ARCH=arm menuconfig
>>
>> make ARCH=arm dt_binding_check
>> DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>
>>
>> and not:
>> arm=ARM
>>
> yes, sorry, this is what I did. When running with the DT_SCHEMA_FILES
> set then it passes both on ARM and ARM64
> but when this variable is not set I get the above error.

# for Intel use:
make dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml


# for Rockchip use:
make ARCH=arm dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

make ARCH=arm64 dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml

Also change:

example:
  Reduce some spaces here.

Also remove "|" from description.

See:
description: |
  A more detailed multi-line description of the binding.

  Details about the hardware device and any links to datasheets can go here.

  Literal blocks are marked with the '|' at the beginning. The end is
marked by
  indentation less than the first line of the literal block. Lines also
cannot
  begin with a tab character.

> 
> Dafna
> 
>>
>>>
>>>     DTC    
>>> Documentation/devicetree/bindings/clock/qcom,gcc.example.dt.yaml
>>> Error:
>>> Documentation/devicetree/bindings/clock/qcom,gcc.example.dts:111.28-29
>>> syntax error
>>> FATAL ERROR: Unable to parse input tree
>>>
>>> Dafna
>>>
>>>>
>>>>> make dtbs_check
>>>>> DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
>>>>>
>>>>>
>>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
deleted file mode 100644
index 5707af89319d..000000000000
--- a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.txt
+++ /dev/null
@@ -1,19 +0,0 @@ 
-Rockchip DRM master device
-================================
-
-The Rockchip DRM master device is a virtual device needed to list all
-vop devices or other display interface nodes that comprise the
-graphics subsystem.
-
-Required properties:
-- compatible: Should be "rockchip,display-subsystem"
-- ports: Should contain a list of phandles pointing to display interface port
-  of vop devices. vop definitions as defined in
-  Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
-
-example:
-
-display-subsystem {
-	compatible = "rockchip,display-subsystem";
-	ports = <&vopl_out>, <&vopb_out>;
-};
diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
new file mode 100644
index 000000000000..538898ada9d1
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml
@@ -0,0 +1,38 @@ 
+# SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/rockchip/rockchip-drm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Rockchip DRM master device
+
+maintainers:
+  - Sandy Huang <hjc@rock-chips.com
+  - Heiko Stuebner <heiko@sntech.de>
+
+description: |
+  The Rockchip DRM master device is a virtual device needed to list all
+  vop devices or other display interface nodes that comprise the
+  graphics subsystem.
+
+properties:
+  compatible:
+    const: rockchip,display-subsystem
+
+  ports:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description: |
+      Should contain a list of phandles pointing to display interface port
+      of vop devices. vop definitions as defined in
+      Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt
+
+required:
+  - compatible
+  - ports
+
+examples:
+  - |
+    display-subsystem {
+        compatible = "rockchip,display-subsystem";
+        ports = <&vopl_out>, <&vopb_out>;
+    };