Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH v4 2/4] dt-bindings: power: rockchip: Convert to
 json-schema
From:   Enric Balletbo i Serra <enric.balletbo@collabora.com>
To:     "elaine.zhang" <zhangqing@rock-chips.com>, robh+dt@kernel.org,
        heiko@sntech.de
Cc:     devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-rockchip@lists.infradead.org, linux-kernel@vger.kernel.org,
        cl@rock-chips.com, huangtao@rock-chips.com,
        kever.yang@rock-chips.com, tony.xie@rock-chips.com,
        finley.xiao@rock-chips.com
References: <20210324071609.7531-1-zhangqing@rock-chips.com>
 <20210324071609.7531-3-zhangqing@rock-chips.com>
 <7ffdf0ca-1f7c-c135-086a-08e982e6cb41@collabora.com>
 <43f230a3-072a-f41d-5f69-5e61201e52b2@rock-chips.com>
 <40a7fad3-17bb-9275-ed4a-2e3d526d05a1@collabora.com>
Message-ID: <f1323618-7990-9bb7-a8c2-a7321a4034f8@collabora.com>
Date:   Wed, 24 Mar 2021 11:32:42 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.8.0
MIME-Version: 1.0
In-Reply-To: <40a7fad3-17bb-9275-ed4a-2e3d526d05a1@collabora.com>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Precedence: bulk


On 24/3/21 11:25, Enric Balletbo i Serra wrote:
> Hi Elaine,
> 
> On 24/3/21 11:18, elaine.zhang wrote:
>> Hi,  Enric
>>
>> 在 2021/3/24 下午5:56, Enric Balletbo i Serra 写道:
>>> Hi Elaine,
>>>
>>> This is not the exact version I sent, and you reintroduced a "problem" that were
>>> already solved/discussed on previous versions. See below:
>>>
>>> On 24/3/21 8:16, Elaine Zhang wrote:
>>>> Convert the soc/rockchip/power_domain.txt binding document to
>>>> json-schema and move to the power bindings directory.
>>>>
>>>> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
>>> If you do significant is a good practice shortly describe them within [] here.
>>>
>>>> Signed-off-by: Elaine Zhang <zhangqing@rock-chips.com>
>>> Note that my last version already had the
>>>
>>> Reviewed-by: Rob Herring <robh@kernel.org>
>>>
>>> Which should be fine for merging (with probably only minor changes) and you
>>> could maintain if you don't do significant changes, but that's not the case, as
>>> I said, you are reintroducing one problem. Please review the comments already
>>> received on this patchset or similar patchsets to avoid this.
>>>
>>>> ---
>>>>   .../power/rockchip,power-controller.yaml      | 284 ++++++++++++++++++
>>>>   .../bindings/soc/rockchip/power_domain.txt    | 136 ---------
>>>>   2 files changed, 284 insertions(+), 136 deletions(-)
>>>>   create mode 100644
>>>> Documentation/devicetree/bindings/power/rockchip,power-controller.yaml
>>>>   delete mode 100644
>>>> Documentation/devicetree/bindings/soc/rockchip/power_domain.txt
>>>>
>>>> diff --git
>>>> a/Documentation/devicetree/bindings/power/rockchip,power-controller.yaml
>>>> b/Documentation/devicetree/bindings/power/rockchip,power-controller.yaml
>>>> new file mode 100644
>>>> index 000000000000..a220322c5139
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/power/rockchip,power-controller.yaml
>>>> @@ -0,0 +1,284 @@
>>>> +# SPDX-License-Identifier: GPL-2.0-only
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: http://devicetree.org/schemas/power/rockchip,power-controller.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: Rockchip Power Domains
>>>> +
>>>> +maintainers:
>>>> +  - Elaine Zhang <zhangqing@rock-chips.com>
>>>> +  - Rob Herring <robh+dt@kernel.org>
>>> Up to Rob, but I don't think Rob would like to be the maintainer. I think you
>>> can only include yourself and Heiko.
>>>
>>>
>>>> +  - Heiko Stuebner <heiko@sntech.de>
>>>> +
>>>> +description: |
>>>> +  Rockchip processors include support for multiple power domains which can be
>>>> +  powered up/down by software based on different application scenarios to
>>>> save power.
>>>> +
>>>> +  Power domains contained within power-controller node are generic power domain
>>>> +  providers documented in
>>>> Documentation/devicetree/bindings/power/power-domain.yaml.
>>>> +
>>>> +  IP cores belonging to a power domain should contain a "power-domains"
>>>> +  property that is a phandle for the power domain node representing the domain.
>>>> +
>>>> +properties:
>>>> +  $nodename:
>>>> +    const: power-controller
>>>> +
>>>> +  compatible:
>>>> +    enum:
>>>> +      - rockchip,px30-power-controller
>>>> +      - rockchip,rk3036-power-controller
>>>> +      - rockchip,rk3066-power-controller
>>>> +      - rockchip,rk3128-power-controller
>>>> +      - rockchip,rk3188-power-controller
>>>> +      - rockchip,rk3228-power-controller
>>>> +      - rockchip,rk3288-power-controller
>>>> +      - rockchip,rk3328-power-controller
>>>> +      - rockchip,rk3366-power-controller
>>>> +      - rockchip,rk3368-power-controller
>>>> +      - rockchip,rk3399-power-controller
>>>> +
>>>> +  "#power-domain-cells":
>>>> +    const: 1
>>>> +
>>>> +  "#address-cells":
>>>> +    const: 1
>>>> +
>>>> +  "#size-cells":
>>>> +    const: 0
>>>> +
>>>> +patternProperties:
>>>> +  "^pd_[0-9a-z_]{2,10}@[0-9a-f]+$":
>>>> +    type: object
>>>> +    description: |
>>>> +      Represents the power domains within the power controller node as
>>>> documented
>>>> +      in Documentation/devicetree/bindings/power/power-domain.yaml.
>>>> +
>>> The node names must be generic, as this is power-domain must be in the form:
>>>
>>> +patternProperties:
>>> +  "^power-domain@[0-9a-f]+$":
>> In this way, dtbs_check cannot be passed, and all the usage methods in dts of
>> Rockchip need to be corrected, which I think is a bigger change.
> 
> Well, the problem is in the Rockchip dtbs, so needs to be fixed there. The
> bindings must describe hardware in a generic way, not describe the actual dtbs
> to not report errors.
> 

FWIW I remember I did something regarding this but never sent to upstream, feel
free to pick if you find useful.

*
https://gitlab.collabora.com/eballetbo/linux/-/commit/12499f223e3d33602449b9102404fe573fb804f5
*
https://gitlab.collabora.com/eballetbo/linux/-/commit/12499f223e3d33602449b9102404fe573fb804f5
*
https://gitlab.collabora.com/eballetbo/linux/-/commit/492bf2213c341152a1c2423242c5634b9e53ff27

> Thanks,
>  Enric
> 
>>>
>>>
>>>> +    properties:
>>>> +
>>>> +      "#power-domain-cells":
>>>> +        description:
>>>> +          Must be 0 for nodes representing a single PM domain and 1 for nodes
>>>> +          providing multiple PM domains.
>>>> +
>>>> +      "#address-cells":
>>>> +        const: 1
>>>> +
>>>> +      "#size-cells":
>>>> +        const: 0
>>>> +
>>>> +      reg:
>>>> +        maxItems: 1
>>>> +        description: |
>>>> +          Power domain index. Valid values are defined in
>>>> +          "include/dt-bindings/power/px30-power.h"
>>>> +          "include/dt-bindings/power/rk3036-power.h"
>>>> +          "include/dt-bindings/power/rk3066-power.h"
>>>> +          "include/dt-bindings/power/rk3128-power.h"
>>>> +          "include/dt-bindings/power/rk3188-power.h"
>>>> +          "include/dt-bindings/power/rk3228-power.h"
>>>> +          "include/dt-bindings/power/rk3288-power.h"
>>>> +          "include/dt-bindings/power/rk3328-power.h"
>>>> +          "include/dt-bindings/power/rk3366-power.h"
>>>> +          "include/dt-bindings/power/rk3368-power.h"
>>>> +          "include/dt-bindings/power/rk3399-power.h"
>>>> +
>>>> +      clocks:
>>>> +        description: |
>>>> +          A number of phandles to clocks that need to be enabled while power
>>>> domain
>>>> +          switches state.
>>>> +
>>>> +      pm_qos:
>>>> +        description: |
>>>> +          A number of phandles to qos blocks which need to be saved and
>>>> restored
>>>> +          while power domain switches state.
>>>> +
>>>> +    patternProperties:
>>>> +      "^pd_[0-9a-z_]{2,10}@[0-9a-f]+$":
>>> The same here:
>>>
>>> +patternProperties:
>>> +  "^power-domain@[0-9a-f]+$":
>>>
>>>
>>>
>>>> +        type: object
>>>> +        description: |
>>>> +          Represents a power domain child within a power domain parent node.
>>>> +
>>>> +        properties:
>>>> +
>>>> +          "#power-domain-cells":
>>>> +            description:
>>>> +              Must be 0 for nodes representing a single PM domain and 1 for
>>>> nodes
>>>> +              providing multiple PM domains.
>>>> +
>>>> +          "#address-cells":
>>>> +            const: 1
>>>> +
>>>> +          "#size-cells":
>>>> +            const: 0
>>>> +
>>>> +          reg:
>>>> +            maxItems: 1
>>>> +
>>>> +          clocks:
>>>> +            description: |
>>>> +              A number of phandles to clocks that need to be enabled while
>>>> power domain
>>>> +              switches state.
>>>> +
>>>> +          pm_qos:
>>>> +            description: |
>>>> +              A number of phandles to qos blocks which need to be saved and
>>>> restored
>>>> +              while power domain switches state.
>>>> +
>>>> +        patternProperties:
>>>> +          "^pd_[0-9a-z_]{2,10}@[0-9a-f]+$":
>>> And here:
>>>
>>>> +            type: object
>>>> +            description: |
>>>> +              Represents a power domain child within a power domain parent
>>>> node.
>>>> +
>>>> +            properties:
>>>> +
>>>> +              "#power-domain-cells":
>>>> +                description:
>>>> +                  Must be 0 for nodes representing a single PM domain and 1
>>>> for nodes
>>>> +                  providing multiple PM domains.
>>>> +
>>>> +              "#address-cells":
>>>> +                const: 1
>>>> +
>>>> +              "#size-cells":
>>>> +                const: 0
>>>> +
>>>> +              reg:
>>>> +                maxItems: 1
>>>> +
>>>> +              clocks:
>>>> +                description: |
>>>> +                  A number of phandles to clocks that need to be enabled
>>>> while power domain
>>>> +                  switches state.
>>>> +
>>>> +              pm_qos:
>>>> +                description: |
>>>> +                  A number of phandles to qos blocks which need to be saved
>>>> and restored
>>>> +                  while power domain switches state.
>>>> +
>>>> +            required:
>>>> +              - reg
>>>> +
>>>> +            additionalProperties: false
>>>> +
>>>> +        required:
>>>> +          - reg
>>>> +
>>>> +        additionalProperties: false
>>>> +
>>>> +    required:
>>>> +      - reg
>>>> +
>>>> +    additionalProperties: false
>>>> +
>>>> +required:
>>>> +  - compatible
>>>> +  - "#power-domain-cells"
>>>> +
>>>> +additionalProperties: false
>>>> +
>>>> +examples:
>>>> +  - |
>>>> +    #include <dt-bindings/clock/rk3399-cru.h>
>>>> +    #include <dt-bindings/power/rk3399-power.h>
>>>> +
>>>> +    soc {
>>>> +        #address-cells = <2>;
>>>> +        #size-cells = <2>;
>>>> +
>>>> +        qos_hdcp: qos@ffa90000 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffa90000 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        qos_iep: qos@ffa98000 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffa98000 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        qos_rga_r: qos@ffab0000 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffab0000 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        qos_rga_w: qos@ffab0080 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffab0080 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        qos_video_m0: qos@ffab8000 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffab8000 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        qos_video_m1_r: qos@ffac0000 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffac0000 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        qos_video_m1_w: qos@ffac0080 {
>>>> +            compatible = "rockchip,rk3399-qos", "syscon";
>>>> +            reg = <0x0 0xffac0080 0x0 0x20>;
>>>> +        };
>>>> +
>>>> +        power-management@ff310000 {
>>>> +            compatible = "rockchip,rk3399-pmu", "syscon", "simple-mfd";
>>>> +            reg = <0x0 0xff310000 0x0 0x1000>;
>>>> +
>>>> +            power-controller {
>>>> +                compatible = "rockchip,rk3399-power-controller";
>>>> +                #power-domain-cells = <1>;
>>>> +                #address-cells = <1>;
>>>> +                #size-cells = <0>;
>>>> +
>>>> +                /* These power domains are grouped by VD_CENTER */
>>>> +                pd_iep@RK3399_PD_IEP {
>>> Here and below must be generic power-domain@RK3399_PD_IEP
>>>
>>>
>>>> +                    reg = <RK3399_PD_IEP>;
>>>> +                    clocks = <&cru ACLK_IEP>,
>>>> +                             <&cru HCLK_IEP>;
>>>> +                    pm_qos = <&qos_iep>;
>>>> +                    #power-domain-cells = <0>;
>>>> +                };
>>>> +                pd_rga@RK3399_PD_RGA {
>>>> +                    reg = <RK3399_PD_RGA>;
>>>> +                    clocks = <&cru ACLK_RGA>,
>>>> +                             <&cru HCLK_RGA>;
>>>> +                    pm_qos = <&qos_rga_r>,
>>>> +                             <&qos_rga_w>;
>>>> +                    #power-domain-cells = <0>;
>>>> +                };
>>>> +                pd_vcodec@RK3399_PD_VCODEC {
>>>> +                    reg = <RK3399_PD_VCODEC>;
>>>> +                    clocks = <&cru ACLK_VCODEC>,
>>>> +                             <&cru HCLK_VCODEC>;
>>>> +                    pm_qos = <&qos_video_m0>;
>>>> +                    #power-domain-cells = <0>;
>>>> +                };
>>>> +                pd_vdu@RK3399_PD_VDU {
>>>> +                    reg = <RK3399_PD_VDU>;
>>>> +                    clocks = <&cru ACLK_VDU>,
>>>> +                             <&cru HCLK_VDU>;
>>>> +                    pm_qos = <&qos_video_m1_r>,
>>>> +                             <&qos_video_m1_w>;
>>>> +                    #power-domain-cells = <0>;
>>>> +                };
>>>> +                pd_vio@RK3399_PD_VIO {
>>>> +                    reg = <RK3399_PD_VIO>;
>>>> +                    #power-domain-cells = <1>;
>>>> +                    #address-cells = <1>;
>>>> +                    #size-cells = <0>;
>>>> +
>>>> +                    pd_hdcp@RK3399_PD_HDCP {
>>>> +                        reg = <RK3399_PD_HDCP>;
>>>> +                        clocks = <&cru ACLK_HDCP>,
>>>> +                                 <&cru HCLK_HDCP>,
>>>> +                                 <&cru PCLK_HDCP>;
>>>> +                        pm_qos = <&qos_hdcp>;
>>>> +                        #power-domain-cells = <0>;
>>>> +                    };
>>>> +                };
>>>> +            };
>>>> +        };
>>>> +    };
>>>> diff --git a/Documentation/devicetree/bindings/soc/rockchip/power_domain.txt
>>>> b/Documentation/devicetree/bindings/soc/rockchip/power_domain.txt
>>>> deleted file mode 100644
>>>> index 8304eceb62e4..000000000000
>>>> --- a/Documentation/devicetree/bindings/soc/rockchip/power_domain.txt
>>>> +++ /dev/null
>>>> @@ -1,136 +0,0 @@
>>>> -* Rockchip Power Domains
>>>> -
>>>> -Rockchip processors include support for multiple power domains which can be
>>>> -powered up/down by software based on different application scenes to save
>>>> power.
>>>> -
>>>> -Required properties for power domain controller:
>>>> -- compatible: Should be one of the following.
>>>> -    "rockchip,px30-power-controller" - for PX30 SoCs.
>>>> -    "rockchip,rk3036-power-controller" - for RK3036 SoCs.
>>>> -    "rockchip,rk3066-power-controller" - for RK3066 SoCs.
>>>> -    "rockchip,rk3128-power-controller" - for RK3128 SoCs.
>>>> -    "rockchip,rk3188-power-controller" - for RK3188 SoCs.
>>>> -    "rockchip,rk3228-power-controller" - for RK3228 SoCs.
>>>> -    "rockchip,rk3288-power-controller" - for RK3288 SoCs.
>>>> -    "rockchip,rk3328-power-controller" - for RK3328 SoCs.
>>>> -    "rockchip,rk3366-power-controller" - for RK3366 SoCs.
>>>> -    "rockchip,rk3368-power-controller" - for RK3368 SoCs.
>>>> -    "rockchip,rk3399-power-controller" - for RK3399 SoCs.
>>>> -- #power-domain-cells: Number of cells in a power-domain specifier.
>>>> -    Should be 1 for multiple PM domains.
>>>> -- #address-cells: Should be 1.
>>>> -- #size-cells: Should be 0.
>>>> -
>>>> -Required properties for power domain sub nodes:
>>>> -- reg: index of the power domain, should use macros in:
>>>> -    "include/dt-bindings/power/px30-power.h" - for PX30 type power domain.
>>>> -    "include/dt-bindings/power/rk3036-power.h" - for RK3036 type power domain.
>>>> -    "include/dt-bindings/power/rk3066-power.h" - for RK3066 type power domain.
>>>> -    "include/dt-bindings/power/rk3128-power.h" - for RK3128 type power domain.
>>>> -    "include/dt-bindings/power/rk3188-power.h" - for RK3188 type power domain.
>>>> -    "include/dt-bindings/power/rk3228-power.h" - for RK3228 type power domain.
>>>> -    "include/dt-bindings/power/rk3288-power.h" - for RK3288 type power domain.
>>>> -    "include/dt-bindings/power/rk3328-power.h" - for RK3328 type power domain.
>>>> -    "include/dt-bindings/power/rk3366-power.h" - for RK3366 type power domain.
>>>> -    "include/dt-bindings/power/rk3368-power.h" - for RK3368 type power domain.
>>>> -    "include/dt-bindings/power/rk3399-power.h" - for RK3399 type power domain.
>>>> -- clocks (optional): phandles to clocks which need to be enabled while power
>>>> domain
>>>> -    switches state.
>>>> -- pm_qos (optional): phandles to qos blocks which need to be saved and restored
>>>> -    while power domain switches state.
>>>> -
>>>> -Qos Example:
>>>> -
>>>> -    qos_gpu: qos_gpu@ffaf0000 {
>>>> -        compatible ="syscon";
>>>> -        reg = <0x0 0xffaf0000 0x0 0x20>;
>>>> -    };
>>>> -
>>>> -Example:
>>>> -
>>>> -    power: power-controller {
>>>> -        compatible = "rockchip,rk3288-power-controller";
>>>> -        #power-domain-cells = <1>;
>>>> -        #address-cells = <1>;
>>>> -        #size-cells = <0>;
>>>> -
>>>> -        pd_gpu {
>>>> -            reg = <RK3288_PD_GPU>;
>>>> -            clocks = <&cru ACLK_GPU>;
>>>> -            pm_qos = <&qos_gpu>;
>>>> -        };
>>>> -    };
>>>> -
>>>> -     power: power-controller {
>>>> -                compatible = "rockchip,rk3368-power-controller";
>>>> -                #power-domain-cells = <1>;
>>>> -                #address-cells = <1>;
>>>> -                #size-cells = <0>;
>>>> -
>>>> -                pd_gpu_1 {
>>>> -                        reg = <RK3368_PD_GPU_1>;
>>>> -                        clocks = <&cru ACLK_GPU_CFG>;
>>>> -                };
>>>> -        };
>>>> -
>>>> -Example 2:
>>>> -        power: power-controller {
>>>> -            compatible = "rockchip,rk3399-power-controller";
>>>> -            #power-domain-cells = <1>;
>>>> -            #address-cells = <1>;
>>>> -            #size-cells = <0>;
>>>> -
>>>> -            pd_vio {
>>>> -                #address-cells = <1>;
>>>> -                #size-cells = <0>;
>>>> -                reg = <RK3399_PD_VIO>;
>>>> -
>>>> -                pd_vo {
>>>> -                    #address-cells = <1>;
>>>> -                    #size-cells = <0>;
>>>> -                    reg = <RK3399_PD_VO>;
>>>> -
>>>> -                    pd_vopb {
>>>> -                        reg = <RK3399_PD_VOPB>;
>>>> -                    };
>>>> -
>>>> -                    pd_vopl {
>>>> -                        reg = <RK3399_PD_VOPL>;
>>>> -                    };
>>>> -                };
>>>> -            };
>>>> -        };
>>>> -
>>>> -Node of a device using power domains must have a power-domains property,
>>>> -containing a phandle to the power device node and an index specifying which
>>>> -power domain to use.
>>>> -The index should use macros in:
>>>> -    "include/dt-bindings/power/px30-power.h" - for px30 type power domain.
>>>> -    "include/dt-bindings/power/rk3036-power.h" - for rk3036 type power domain.
>>>> -    "include/dt-bindings/power/rk3128-power.h" - for rk3128 type power domain.
>>>> -    "include/dt-bindings/power/rk3128-power.h" - for rk3228 type power domain.
>>>> -    "include/dt-bindings/power/rk3288-power.h" - for rk3288 type power domain.
>>>> -    "include/dt-bindings/power/rk3328-power.h" - for rk3328 type power domain.
>>>> -    "include/dt-bindings/power/rk3366-power.h" - for rk3366 type power domain.
>>>> -    "include/dt-bindings/power/rk3368-power.h" - for rk3368 type power domain.
>>>> -    "include/dt-bindings/power/rk3399-power.h" - for rk3399 type power domain.
>>>> -
>>>> -Example of the node using power domain:
>>>> -
>>>> -    node {
>>>> -        /* ... */
>>>> -        power-domains = <&power RK3288_PD_GPU>;
>>>> -        /* ... */
>>>> -    };
>>>> -
>>>> -    node {
>>>> -                /* ... */
>>>> -                power-domains = <&power RK3368_PD_GPU_1>;
>>>> -                /* ... */
>>>> -        };
>>>> -
>>>> -    node {
>>>> -        /* ... */
>>>> -        power-domains = <&power RK3399_PD_VOPB>;
>>>> -        /* ... */
>>>> -    };
>>>>
>>>
>>>
>>
>>