diff mbox series

[v2,1/7] dt-bindings: regulator: Add bindings for MediaTek DVFSRC Regulators

Message ID 20240417091442.170505-2-angelogioacchino.delregno@collabora.com (mailing list archive)
State New
Headers show
Series MediaTek DVFSRC Bus Bandwidth and Regulator knobs | expand

Commit Message

AngeloGioacchino Del Regno April 17, 2024, 9:14 a.m. UTC
The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
are controlled with votes to the DVFSRC hardware.

This adds support for the regulators found in MT6873, MT8183, MT8192
and MT8195 SoCs.

Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
---
 .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml

Comments

Rob Herring (Arm) April 17, 2024, 2:46 p.m. UTC | #1
On Wed, 17 Apr 2024 11:14:36 +0200, AngeloGioacchino Del Regno wrote:
> The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
> are controlled with votes to the DVFSRC hardware.
> 
> This adds support for the regulators found in MT6873, MT8183, MT8192
> and MT8195 SoCs.
> 
> Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
> ---
>  .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.example.dtb: /example-0/soc/system-controller@10012000: failed to match any schema with compatible: ['mediatek,mt8195-dvfsrc']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240417091442.170505-2-angelogioacchino.delregno@collabora.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Rob Herring (Arm) April 17, 2024, 2:52 p.m. UTC | #2
On Wed, Apr 17, 2024 at 11:14:36AM +0200, AngeloGioacchino Del Regno wrote:
> The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
> are controlled with votes to the DVFSRC hardware.
> 
> This adds support for the regulators found in MT6873, MT8183, MT8192
> and MT8195 SoCs.
> 
> Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
> ---
>  .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> new file mode 100644
> index 000000000000..446f1dab4d2e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> @@ -0,0 +1,71 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/mediatek,mt6873-dvfsrc-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MediaTek DVFSRC-controlled Regulators
> +
> +description:
> +  The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
> +  are controlled with votes to the DVFSRC hardware.
> +
> +maintainers:
> +  - AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - mediatek,mt6873-dvfsrc-regulator
> +      - mediatek,mt8183-dvfsrc-regulator
> +      - mediatek,mt8192-dvfsrc-regulator
> +      - mediatek,mt8195-dvfsrc-regulator
> +
> +  reg:
> +    maxItems: 1
> +
> +  dvfsrc-vcore:
> +    description: DVFSRC-controlled SoC Vcore regulator
> +    $ref: regulator.yaml#

       unevaluatedProperties: false

> +
> +  dvfsrc-vscp:
> +    description: DVFSRC-controlled System Control Processor regulator
> +    $ref: regulator.yaml#

ditto

> +
> +required:
> +  - compatible

'reg' is never optional. And how is no regulators at all valid?

> +
> +additionalProperties: false
> +
> +examples:
> +  - |

Drop the example here. Just one complete example in the MFD doc.

> +    soc {
> +        #address-cells = <2>;
> +        #size-cells = <2>;
> +
> +        system-controller@10012000 {
> +            compatible = "mediatek,mt8195-dvfsrc";
> +            reg = <0 0x10012000 0 0x1000>;
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +
> +            regulators@0 {
> +                compatible = "mediatek,mt8195-dvfsrc-regulator";
> +                reg = <0>;

What does 'reg' value represent here? 0 and 1 seem pretty much made up.

> +
> +                dvfsrc_vcore: dvfsrc-vcore {
> +                        regulator-name = "dvfsrc-vcore";
> +                        regulator-min-microvolt = <550000>;
> +                        regulator-max-microvolt = <750000>;
> +                        regulator-always-on;
> +                };
> +
> +                dvfsrc_vscp: dvfsrc-vscp {
> +                        regulator-name = "dvfsrc-vscp";
> +                        regulator-min-microvolt = <550000>;
> +                        regulator-max-microvolt = <750000>;
> +                        regulator-always-on;
> +                };
> +            };
> +        };
> +    };
> -- 
> 2.44.0
>
AngeloGioacchino Del Regno April 17, 2024, 3:32 p.m. UTC | #3
Il 17/04/24 16:46, Rob Herring ha scritto:
> 
> On Wed, 17 Apr 2024 11:14:36 +0200, AngeloGioacchino Del Regno wrote:
>> The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
>> are controlled with votes to the DVFSRC hardware.
>>
>> This adds support for the regulators found in MT6873, MT8183, MT8192
>> and MT8195 SoCs.
>>
>> Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
>> ---
>>   .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
>>   1 file changed, 71 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>>
> 
> My bot found errors running 'make dt_binding_check' on your patch:
> 
> yamllint warnings/errors:
> 
> dtschema/dtc warnings/errors:
> Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.example.dtb: /example-0/soc/system-controller@10012000: failed to match any schema with compatible: ['mediatek,mt8195-dvfsrc']
> 

This is a circular dependency with patch [3/7], so I think that the bot complaining
is expected?


> doc reference errors (make refcheckdocs):
> 
> See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240417091442.170505-2-angelogioacchino.delregno@collabora.com
> 
> The base for the series is generally the latest rc1. A different dependency
> should be noted in *this* patch.
> 
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure 'yamllint' is installed and dt-schema is up to
> date:
> 
> pip3 install dtschema --upgrade
> 
> Please check and re-submit after running the above command yourself. Note
> that DT_SCHEMA_FILES can be set to your schema file to speed up checking
> your schema. However, it must be unset to test all examples with your schema.
>
AngeloGioacchino Del Regno April 17, 2024, 3:39 p.m. UTC | #4
Il 17/04/24 16:52, Rob Herring ha scritto:
> On Wed, Apr 17, 2024 at 11:14:36AM +0200, AngeloGioacchino Del Regno wrote:
>> The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
>> are controlled with votes to the DVFSRC hardware.
>>
>> This adds support for the regulators found in MT6873, MT8183, MT8192
>> and MT8195 SoCs.
>>
>> Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
>> ---
>>   .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
>>   1 file changed, 71 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>> new file mode 100644
>> index 000000000000..446f1dab4d2e
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>> @@ -0,0 +1,71 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/regulator/mediatek,mt6873-dvfsrc-regulator.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: MediaTek DVFSRC-controlled Regulators
>> +
>> +description:
>> +  The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
>> +  are controlled with votes to the DVFSRC hardware.
>> +
>> +maintainers:
>> +  - AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - mediatek,mt6873-dvfsrc-regulator
>> +      - mediatek,mt8183-dvfsrc-regulator
>> +      - mediatek,mt8192-dvfsrc-regulator
>> +      - mediatek,mt8195-dvfsrc-regulator
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  dvfsrc-vcore:
>> +    description: DVFSRC-controlled SoC Vcore regulator
>> +    $ref: regulator.yaml#
> 
>         unevaluatedProperties: false
> 

Will do!

>> +
>> +  dvfsrc-vscp:
>> +    description: DVFSRC-controlled System Control Processor regulator
>> +    $ref: regulator.yaml#
> 
> ditto
> 
>> +
>> +required:
>> +  - compatible
> 
> 'reg' is never optional. And how is no regulators at all valid?
> 

The two nodes that I'm adding with this series don't need reg, but others
that are not present in this do... but anyway, let's postpone that problem
for the future me, or the future-anyone-else implementing the rest, I will
remove the 'reg' property as it is indeed not needed for this node.

And yeah it's invalid to add that node without any regulator. Will check the
other regulator bindings on how they're doing it.


>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
> 
> Drop the example here. Just one complete example in the MFD doc.
> 

Oki, dropping in v3! That also resolves the circular dependency thing, so
that's even better.

>> +    soc {
>> +        #address-cells = <2>;
>> +        #size-cells = <2>;
>> +
>> +        system-controller@10012000 {
>> +            compatible = "mediatek,mt8195-dvfsrc";
>> +            reg = <0 0x10012000 0 0x1000>;
>> +            #address-cells = <1>;
>> +            #size-cells = <0>;
>> +
>> +            regulators@0 {
>> +                compatible = "mediatek,mt8195-dvfsrc-regulator";
>> +                reg = <0>;
> 
> What does 'reg' value represent here? 0 and 1 seem pretty much made up.
> 

Gets removed in v3, tomorrow.

Cheers,
Angelo
Rob Herring (Arm) April 17, 2024, 7:12 p.m. UTC | #5
On Wed, Apr 17, 2024 at 05:39:12PM +0200, AngeloGioacchino Del Regno wrote:
> Il 17/04/24 16:52, Rob Herring ha scritto:
> > On Wed, Apr 17, 2024 at 11:14:36AM +0200, AngeloGioacchino Del Regno wrote:
> > > The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
> > > are controlled with votes to the DVFSRC hardware.
> > > 
> > > This adds support for the regulators found in MT6873, MT8183, MT8192
> > > and MT8195 SoCs.
> > > 
> > > Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
> > > ---
> > >   .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
> > >   1 file changed, 71 insertions(+)
> > >   create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> > > 
> > > diff --git a/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> > > new file mode 100644
> > > index 000000000000..446f1dab4d2e
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
> > > @@ -0,0 +1,71 @@
> > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/regulator/mediatek,mt6873-dvfsrc-regulator.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: MediaTek DVFSRC-controlled Regulators
> > > +
> > > +description:
> > > +  The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
> > > +  are controlled with votes to the DVFSRC hardware.
> > > +
> > > +maintainers:
> > > +  - AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
> > > +
> > > +properties:
> > > +  compatible:
> > > +    enum:
> > > +      - mediatek,mt6873-dvfsrc-regulator
> > > +      - mediatek,mt8183-dvfsrc-regulator
> > > +      - mediatek,mt8192-dvfsrc-regulator
> > > +      - mediatek,mt8195-dvfsrc-regulator
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +
> > > +  dvfsrc-vcore:
> > > +    description: DVFSRC-controlled SoC Vcore regulator
> > > +    $ref: regulator.yaml#
> > 
> >         unevaluatedProperties: false
> > 
> 
> Will do!
> 
> > > +
> > > +  dvfsrc-vscp:
> > > +    description: DVFSRC-controlled System Control Processor regulator
> > > +    $ref: regulator.yaml#
> > 
> > ditto
> > 
> > > +
> > > +required:
> > > +  - compatible
> > 
> > 'reg' is never optional. And how is no regulators at all valid?
> > 
> 
> The two nodes that I'm adding with this series don't need reg, but others
> that are not present in this do... but anyway, let's postpone that problem
> for the future me, or the future-anyone-else implementing the rest, I will
> remove the 'reg' property as it is indeed not needed for this node.

That might have been fine, but now that I know you *will* need it, it 
isn't fine. You could wait 1 week to 6 months to repost and hope I 
forget...

The ideal for these cases is you put the actual sub-range of 
MMIO registers in the child nodes. But sometimes it is just bit soup in 
the register layout and that doesn't work.

> 
> And yeah it's invalid to add that node without any regulator. Will check the
> other regulator bindings on how they're doing it.

'required' or anyOf with a list of required entries.

Rob
AngeloGioacchino Del Regno April 18, 2024, 7:42 a.m. UTC | #6
Il 17/04/24 21:12, Rob Herring ha scritto:
> On Wed, Apr 17, 2024 at 05:39:12PM +0200, AngeloGioacchino Del Regno wrote:
>> Il 17/04/24 16:52, Rob Herring ha scritto:
>>> On Wed, Apr 17, 2024 at 11:14:36AM +0200, AngeloGioacchino Del Regno wrote:
>>>> The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
>>>> are controlled with votes to the DVFSRC hardware.
>>>>
>>>> This adds support for the regulators found in MT6873, MT8183, MT8192
>>>> and MT8195 SoCs.
>>>>
>>>> Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
>>>> ---
>>>>    .../mediatek,mt6873-dvfsrc-regulator.yaml     | 71 +++++++++++++++++++
>>>>    1 file changed, 71 insertions(+)
>>>>    create mode 100644 Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>>>> new file mode 100644
>>>> index 000000000000..446f1dab4d2e
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
>>>> @@ -0,0 +1,71 @@
>>>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: http://devicetree.org/schemas/regulator/mediatek,mt6873-dvfsrc-regulator.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: MediaTek DVFSRC-controlled Regulators
>>>> +
>>>> +description:
>>>> +  The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
>>>> +  are controlled with votes to the DVFSRC hardware.
>>>> +
>>>> +maintainers:
>>>> +  - AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    enum:
>>>> +      - mediatek,mt6873-dvfsrc-regulator
>>>> +      - mediatek,mt8183-dvfsrc-regulator
>>>> +      - mediatek,mt8192-dvfsrc-regulator
>>>> +      - mediatek,mt8195-dvfsrc-regulator
>>>> +
>>>> +  reg:
>>>> +    maxItems: 1
>>>> +
>>>> +  dvfsrc-vcore:
>>>> +    description: DVFSRC-controlled SoC Vcore regulator
>>>> +    $ref: regulator.yaml#
>>>
>>>          unevaluatedProperties: false
>>>
>>
>> Will do!
>>
>>>> +
>>>> +  dvfsrc-vscp:
>>>> +    description: DVFSRC-controlled System Control Processor regulator
>>>> +    $ref: regulator.yaml#
>>>
>>> ditto
>>>
>>>> +
>>>> +required:
>>>> +  - compatible
>>>
>>> 'reg' is never optional. And how is no regulators at all valid?
>>>
>>
>> The two nodes that I'm adding with this series don't need reg, but others
>> that are not present in this do... but anyway, let's postpone that problem
>> for the future me, or the future-anyone-else implementing the rest, I will
>> remove the 'reg' property as it is indeed not needed for this node.
> 
> That might have been fine, but now that I know you *will* need it, it
> isn't fine. You could wait 1 week to 6 months to repost and hope I
> forget...

My bad, I should've explained a bit better, that was referred to the DVFSRC
main node, not to the REGULATOR node: that one doesn't need it at all.

I get it as it's fine if I drop reg from all of them (here and icc, and the
size/address cells from the parent node) and send a v3.

Did I get that wrong?


> 
> The ideal for these cases is you put the actual sub-range of
> MMIO registers in the child nodes. But sometimes it is just bit soup in
> the register layout and that doesn't work.
> 

I can confirm that there's a bit soup situation on MediaTek - bits for different
devices scattered all around in one register "far away".

>>
>> And yeah it's invalid to add that node without any regulator. Will check the
>> other regulator bindings on how they're doing it.
> 
> 'required' or anyOf with a list of required entries.
> 

That saves me lookup time - greatly appreciated, thank you!

Cheers,
Angelo

> Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
new file mode 100644
index 000000000000..446f1dab4d2e
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/mediatek,mt6873-dvfsrc-regulator.yaml
@@ -0,0 +1,71 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/mediatek,mt6873-dvfsrc-regulator.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MediaTek DVFSRC-controlled Regulators
+
+description:
+  The Dynamic Voltage and Frequency Scaling Resource Collector Regulators
+  are controlled with votes to the DVFSRC hardware.
+
+maintainers:
+  - AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
+
+properties:
+  compatible:
+    enum:
+      - mediatek,mt6873-dvfsrc-regulator
+      - mediatek,mt8183-dvfsrc-regulator
+      - mediatek,mt8192-dvfsrc-regulator
+      - mediatek,mt8195-dvfsrc-regulator
+
+  reg:
+    maxItems: 1
+
+  dvfsrc-vcore:
+    description: DVFSRC-controlled SoC Vcore regulator
+    $ref: regulator.yaml#
+
+  dvfsrc-vscp:
+    description: DVFSRC-controlled System Control Processor regulator
+    $ref: regulator.yaml#
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        system-controller@10012000 {
+            compatible = "mediatek,mt8195-dvfsrc";
+            reg = <0 0x10012000 0 0x1000>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            regulators@0 {
+                compatible = "mediatek,mt8195-dvfsrc-regulator";
+                reg = <0>;
+
+                dvfsrc_vcore: dvfsrc-vcore {
+                        regulator-name = "dvfsrc-vcore";
+                        regulator-min-microvolt = <550000>;
+                        regulator-max-microvolt = <750000>;
+                        regulator-always-on;
+                };
+
+                dvfsrc_vscp: dvfsrc-vscp {
+                        regulator-name = "dvfsrc-vscp";
+                        regulator-min-microvolt = <550000>;
+                        regulator-max-microvolt = <750000>;
+                        regulator-always-on;
+                };
+            };
+        };
+    };