Message ID | 1614155592-14060-2-git-send-email-skakit@codeaurora.org (mailing list archive) |
---|---|
State | Superseded |
Headers | show |
Series | Add PM7325/PM8350C/PMR735A regulator support | expand |
On Wed, Feb 24, 2021 at 02:03:06PM +0530, satya priya wrote:
> Convert regulator bindings from .txt to .yaml format.
Please place any conversions of DT bindings to YAML at the end of patch
serieses, there is frequently a backlog on review of these conversions
which can hold everything else up.
On Wed, 24 Feb 2021 14:03:06 +0530, satya priya wrote: > Convert regulator bindings from .txt to .yaml format. > > Signed-off-by: satya priya <skakit@codeaurora.org> > --- > .../bindings/regulator/qcom,rpmh-regulator.txt | 180 --------------------- > .../bindings/regulator/qcom,rpmh-regulator.yaml | 147 +++++++++++++++++ > 2 files changed, 147 insertions(+), 180 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt > create mode 100644 Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:13:5: [warning] wrong indentation: expected 2 but found 4 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:48:5: [warning] wrong indentation: expected 2 but found 4 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:49:9: [warning] wrong indentation: expected 6 but found 8 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:50:13: [warning] wrong indentation: expected 10 but found 12 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:64:9: [warning] wrong indentation: expected 6 but found 8 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:69:9: [warning] wrong indentation: expected 6 but found 8 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:83:6: [warning] wrong indentation: expected 6 but found 5 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:89:6: [warning] wrong indentation: expected 6 but found 5 (indentation) ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:95:2: [warning] wrong indentation: expected 2 but found 1 (indentation) dtschema/dtc warnings/errors: See https://patchwork.ozlabs.org/patch/1443748 This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1. 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.
On Wed, Feb 24, 2021 at 2:34 AM satya priya <skakit@codeaurora.org> wrote: > > Convert regulator bindings from .txt to .yaml format. > > Signed-off-by: satya priya <skakit@codeaurora.org> > --- > .../bindings/regulator/qcom,rpmh-regulator.txt | 180 --------------------- > .../bindings/regulator/qcom,rpmh-regulator.yaml | 147 +++++++++++++++++ > 2 files changed, 147 insertions(+), 180 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt > create mode 100644 Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml > > diff --git a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt > deleted file mode 100644 > index ce1e043..0000000 > --- a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt > +++ /dev/null > @@ -1,180 +0,0 @@ > -Qualcomm Technologies, Inc. RPMh Regulators > - > -rpmh-regulator devices support PMIC regulator management via the Voltage > -Regulator Manager (VRM) and Oscillator Buffer (XOB) RPMh accelerators. The APPS > -processor communicates with these hardware blocks via a Resource State > -Coordinator (RSC) using command packets. The VRM allows changing three > -parameters for a given regulator: enable state, output voltage, and operating > -mode. The XOB allows changing only a single parameter for a given regulator: > -its enable state. Despite its name, the XOB is capable of controlling the > -enable state of any PMIC peripheral. It is used for clock buffers, low-voltage > -switches, and LDO/SMPS regulators which have a fixed voltage and mode. > - > -======================= > -Required Node Structure > -======================= > - > -RPMh regulators must be described in two levels of device nodes. The first > -level describes the PMIC containing the regulators and must reside within an > -RPMh device node. The second level describes each regulator within the PMIC > -which is to be used on the board. Each of these regulators maps to a single > -RPMh resource. > - > -The names used for regulator nodes must match those supported by a given PMIC. > -Supported regulator node names: > - PM8005: smps1 - smps4 > - PM8009: smps1 - smps2, ldo1 - ldo7 > - PM8150: smps1 - smps10, ldo1 - ldo18 > - PM8150L: smps1 - smps8, ldo1 - ldo11, bob, flash, rgb > - PM8350: smps1 - smps12, ldo1 - ldo10, > - PM8350C: smps1 - smps10, ldo1 - ldo13, bob > - PM8998: smps1 - smps13, ldo1 - ldo28, lvs1 - lvs2 > - PMI8998: bob > - PM6150: smps1 - smps5, ldo1 - ldo19 > - PM6150L: smps1 - smps8, ldo1 - ldo11, bob > - PMX55: smps1 - smps7, ldo1 - ldo16 > - > -======================== > -First Level Nodes - PMIC > -======================== > - > -- compatible > - Usage: required > - Value type: <string> > - Definition: Must be one of below: > - "qcom,pm8005-rpmh-regulators" > - "qcom,pm8009-rpmh-regulators" > - "qcom,pm8009-1-rpmh-regulators" > - "qcom,pm8150-rpmh-regulators" > - "qcom,pm8150l-rpmh-regulators" > - "qcom,pm8350-rpmh-regulators" > - "qcom,pm8350c-rpmh-regulators" > - "qcom,pm8998-rpmh-regulators" > - "qcom,pmc8180-rpmh-regulators" > - "qcom,pmc8180c-rpmh-regulators" > - "qcom,pmi8998-rpmh-regulators" > - "qcom,pm6150-rpmh-regulators" > - "qcom,pm6150l-rpmh-regulators" > - "qcom,pmx55-rpmh-regulators" > - > -- qcom,pmic-id > - Usage: required > - Value type: <string> > - Definition: RPMh resource name suffix used for the regulators found on > - this PMIC. Typical values: "a", "b", "c", "d", "e", "f". > - > -- vdd-s1-supply > -- vdd-s2-supply > -- vdd-s3-supply > -- vdd-s4-supply > - Usage: optional (PM8998 and PM8005 only) > - Value type: <phandle> > - Definition: phandle of the parent supply regulator of one or more of the > - regulators for this PMIC. > - > -- vdd-s5-supply > -- vdd-s6-supply > -- vdd-s7-supply > -- vdd-s8-supply > -- vdd-s9-supply > -- vdd-s10-supply > -- vdd-s11-supply > -- vdd-s12-supply > -- vdd-s13-supply > -- vdd-l1-l27-supply > -- vdd-l2-l8-l17-supply > -- vdd-l3-l11-supply > -- vdd-l4-l5-supply > -- vdd-l6-supply > -- vdd-l7-l12-l14-l15-supply > -- vdd-l9-supply > -- vdd-l10-l23-l25-supply > -- vdd-l13-l19-l21-supply > -- vdd-l16-l28-supply > -- vdd-l18-l22-supply > -- vdd-l20-l24-supply > -- vdd-l26-supply > -- vin-lvs-1-2-supply > - Usage: optional (PM8998 only) > - Value type: <phandle> > - Definition: phandle of the parent supply regulator of one or more of the > - regulators for this PMIC. > - > -- vdd-bob-supply > - Usage: optional (PMI8998 only) > - Value type: <phandle> > - Definition: BOB regulator parent supply phandle > - > -=============================== > -Second Level Nodes - Regulators > -=============================== > - > -- qcom,always-wait-for-ack > - Usage: optional > - Value type: <empty> > - Definition: Boolean flag which indicates that the application processor > - must wait for an ACK or a NACK from RPMh for every request > - sent for this regulator including those which are for a > - strictly lower power state. > - > -Other properties defined in Documentation/devicetree/bindings/regulator/regulator.txt > -may also be used. regulator-initial-mode and regulator-allowed-modes may be > -specified for VRM regulators using mode values from > -include/dt-bindings/regulator/qcom,rpmh-regulator.h. regulator-allow-bypass > -may be specified for BOB type regulators managed via VRM. > -regulator-allow-set-load may be specified for LDO type regulators managed via > -VRM. > - > -======== > -Examples > -======== > - > -#include <dt-bindings/regulator/qcom,rpmh-regulator.h> > - > -&apps_rsc { > - pm8998-rpmh-regulators { > - compatible = "qcom,pm8998-rpmh-regulators"; > - qcom,pmic-id = "a"; > - > - vdd-l7-l12-l14-l15-supply = <&pm8998_s5>; > - > - smps2 { > - regulator-min-microvolt = <1100000>; > - regulator-max-microvolt = <1100000>; > - }; > - > - pm8998_s5: smps5 { > - regulator-min-microvolt = <1904000>; > - regulator-max-microvolt = <2040000>; > - }; > - > - ldo7 { > - regulator-min-microvolt = <1800000>; > - regulator-max-microvolt = <1800000>; > - regulator-initial-mode = <RPMH_REGULATOR_MODE_HPM>; > - regulator-allowed-modes = > - <RPMH_REGULATOR_MODE_LPM > - RPMH_REGULATOR_MODE_HPM>; > - regulator-allow-set-load; > - }; > - > - lvs1 { > - regulator-min-microvolt = <1800000>; > - regulator-max-microvolt = <1800000>; > - }; > - }; > - > - pmi8998-rpmh-regulators { > - compatible = "qcom,pmi8998-rpmh-regulators"; > - qcom,pmic-id = "b"; > - > - bob { > - regulator-min-microvolt = <3312000>; > - regulator-max-microvolt = <3600000>; > - regulator-allowed-modes = > - <RPMH_REGULATOR_MODE_AUTO > - RPMH_REGULATOR_MODE_HPM>; > - regulator-initial-mode = <RPMH_REGULATOR_MODE_AUTO>; > - }; > - }; > -}; > diff --git a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml > new file mode 100644 > index 0000000..c14baf8 > --- /dev/null > +++ b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml > @@ -0,0 +1,147 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/regulator/qcom,rpmh-regulator.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Qualcomm Technologies, Inc. RPMh Regulators > + > +maintainers: > + - David Collins <collinsd@codeaurora.org> > + > +description: I assume you want the formatting here maintained, so you need a '|' at the end. > + rpmh-regulator devices support PMIC regulator management via the Voltage > + Regulator Manager (VRM) and Oscillator Buffer (XOB) RPMh accelerators. The APPS > + processor communicates with these hardware blocks via a Resource State > + Coordinator (RSC) using command packets. The VRM allows changing three > + parameters for a given regulator, enable state, output voltage, and operating > + mode. The XOB allows changing only a single parameter for a given regulator, > + its enable state. Despite its name, the XOB is capable of controlling the > + enable state of any PMIC peripheral. It is used for clock buffers, low-voltage > + switches, and LDO/SMPS regulators which have a fixed voltage and mode. > + > + ======================= > + Required Node Structure > + ======================= > + > + RPMh regulators must be described in two levels of device nodes. The first > + level describes the PMIC containing the regulators and must reside within an > + RPMh device node. The second level describes each regulator within the PMIC > + which is to be used on the board. Each of these regulators maps to a single > + RPMh resource. > + > + The names used for regulator nodes must match those supported by a given PMIC. > + Supported regulator node names are > + For PM8005, smps1 - smps4 > + For PM8009, smps1 - smps2, ldo1 - ldo7 > + For PM8150, smps1 - smps10, ldo1 - ldo18 > + For PM8150L, smps1 - smps8, ldo1 - ldo11, bob, flash, rgb flash and rgb aren't documented. > + For PM8350, smps1 - smps12, ldo1 - ldo10 > + For PM8350C, smps1 - smps10, ldo1 - ldo13, bob > + For PM8998, smps1 - smps13, ldo1 - ldo28, lvs1 - lvs2 > + For PMI8998, bob > + For PM6150, smps1 - smps5, ldo1 - ldo19 > + For PM6150L, smps1 - smps8, ldo1 - ldo11, bob > + For PMX55, smps1 - smps7, ldo1 - ldo16 > + > +properties: > + compatible: > + enum: > + - qcom,pm8005-rpmh-regulators > + - qcom,pm8009-rpmh-regulators > + - qcom,pm8009-1-rpmh-regulators > + - qcom,pm8150-rpmh-regulators > + - qcom,pm8150l-rpmh-regulators > + - qcom,pm8350-rpmh-regulators > + - qcom,pm8350c-rpmh-regulators > + - qcom,pm8998-rpmh-regulators > + - qcom,pmi8998-rpmh-regulators > + - qcom,pm6150-rpmh-regulators > + - qcom,pm6150l-rpmh-regulators > + - qcom,pmx55-rpmh-regulators > + > + qcom,pmic-id: > + description: RPMh resource name suffix used for the regulators found on > + this PMIC. Typical values are "a", "b", "c", "d", "e", "f". Sounds like constraints. Make the values a schema. > + $ref: /schemas/types.yaml#/definitions/string > + > + qcom,always-wait-for-ack: > + description: Boolean flag which indicates that the application processor > + must wait for an ACK or a NACK from RPMh for every request > + sent for this regulator including those which are for a > + strictly lower power state. > + $ref: /schemas/types.yaml#/definitions/string Boolean or string? > + > +patternProperties: > + ".*-supply$": You can drop '.*'. That's already the case without '^'. The supply names need to be defined. > + description: phandle of the parent supply regulator of one or more of the > + regulators for this PMIC. > + > + "^((smps|ldo|lvs)[0-9]*)$": s/*/+/ as 1 digit is always required, right? > + type: object > + allOf: Don't need allOf. > + - $ref: "regulator.yaml#" > + description: List of regulator parent supply phandles This is a node, not a list of phandles. > + > + "bob$": 'foobob' is okay as that would be allowed? If a fixed string, put under 'properties'. > + type: object > + allOf: > + - $ref: "regulator.yaml#" > + description: BOB regulator parent supply phandle > + > +additionalProperties: false > + > +required: > + - compatible > + - qcom,pmic-id > + > +examples: > + - | > + #include <dt-bindings/regulator/qcom,rpmh-regulator.h> > + > + pm8998-rpmh-regulators { > + compatible = "qcom,pm8998-rpmh-regulators"; > + qcom,pmic-id = "a"; > + > + vdd-l7-l12-l14-l15-supply = <&pm8998_s5>; > + > + smps2 { > + regulator-min-microvolt = <1100000>; > + regulator-max-microvolt = <1100000>; > + }; > + > + pm8998_s5: smps5 { Drop unused labels. > + regulator-min-microvolt = <1904000>; > + regulator-max-microvolt = <2040000>; > + }; > + > + ldo7 { > + regulator-min-microvolt = <1800000>; > + regulator-max-microvolt = <1800000>; > + regulator-initial-mode = <RPMH_REGULATOR_MODE_HPM>; > + regulator-allowed-modes = > + <RPMH_REGULATOR_MODE_LPM > + RPMH_REGULATOR_MODE_HPM>; > + regulator-allow-set-load; > + }; > + > + lvs1 { > + regulator-min-microvolt = <1800000>; > + regulator-max-microvolt = <1800000>; > + }; > + }; > + > + pmi8998-rpmh-regulators { > + compatible = "qcom,pmi8998-rpmh-regulators"; > + qcom,pmic-id = "b"; > + > + bob { > + regulator-min-microvolt = <3312000>; > + regulator-max-microvolt = <3600000>; > + regulator-allowed-modes = > + <RPMH_REGULATOR_MODE_AUTO > + RPMH_REGULATOR_MODE_HPM>; > + regulator-initial-mode = <RPMH_REGULATOR_MODE_AUTO>; > + }; > + }; > +... > -- > QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member > of Code Aurora Forum, hosted by The Linux Foundation >
Hi Rob, Thanks for reviewing the patch! >> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) >> +%YAML 1.2 >> +--- >> +$id: >> http://devicetree.org/schemas/regulator/qcom,rpmh-regulator.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Qualcomm Technologies, Inc. RPMh Regulators >> + >> +maintainers: >> + - David Collins <collinsd@codeaurora.org> >> + >> +description: > > I assume you want the formatting here maintained, so you need a '|' at > the end. > Ok. >> + rpmh-regulator devices support PMIC regulator management via the >> Voltage >> + Regulator Manager (VRM) and Oscillator Buffer (XOB) RPMh >> accelerators. The APPS >> + processor communicates with these hardware blocks via a Resource >> State >> + Coordinator (RSC) using command packets. The VRM allows changing >> three >> + parameters for a given regulator, enable state, output voltage, >> and operating >> + mode. The XOB allows changing only a single parameter for a >> given regulator, >> + its enable state. Despite its name, the XOB is capable of >> controlling the >> + enable state of any PMIC peripheral. It is used for clock >> buffers, low-voltage >> + switches, and LDO/SMPS regulators which have a fixed voltage and >> mode. >> + >> + ======================= >> + Required Node Structure >> + ======================= >> + >> + RPMh regulators must be described in two levels of device nodes. >> The first >> + level describes the PMIC containing the regulators and must >> reside within an >> + RPMh device node. The second level describes each regulator >> within the PMIC >> + which is to be used on the board. Each of these regulators maps >> to a single >> + RPMh resource. >> + >> + The names used for regulator nodes must match those supported by >> a given PMIC. >> + Supported regulator node names are >> + For PM8005, smps1 - smps4 >> + For PM8009, smps1 - smps2, ldo1 - ldo7 >> + For PM8150, smps1 - smps10, ldo1 - ldo18 >> + For PM8150L, smps1 - smps8, ldo1 - ldo11, bob, flash, rgb > > flash and rgb aren't documented. > Ok will add them. >> + For PM8350, smps1 - smps12, ldo1 - ldo10 >> + For PM8350C, smps1 - smps10, ldo1 - ldo13, bob >> + For PM8998, smps1 - smps13, ldo1 - ldo28, lvs1 - lvs2 >> + For PMI8998, bob >> + For PM6150, smps1 - smps5, ldo1 - ldo19 >> + For PM6150L, smps1 - smps8, ldo1 - ldo11, bob >> + For PMX55, smps1 - smps7, ldo1 - ldo16 >> + >> +properties: >> + compatible: >> + enum: >> + - qcom,pm8005-rpmh-regulators >> + - qcom,pm8009-rpmh-regulators >> + - qcom,pm8009-1-rpmh-regulators >> + - qcom,pm8150-rpmh-regulators >> + - qcom,pm8150l-rpmh-regulators >> + - qcom,pm8350-rpmh-regulators >> + - qcom,pm8350c-rpmh-regulators >> + - qcom,pm8998-rpmh-regulators >> + - qcom,pmi8998-rpmh-regulators >> + - qcom,pm6150-rpmh-regulators >> + - qcom,pm6150l-rpmh-regulators >> + - qcom,pmx55-rpmh-regulators >> + >> + qcom,pmic-id: >> + description: RPMh resource name suffix used for the >> regulators found on >> + this PMIC. Typical values are "a", "b", "c", >> "d", "e", "f". > > Sounds like constraints. Make the values a schema. > Ok >> + $ref: /schemas/types.yaml#/definitions/string >> + >> + qcom,always-wait-for-ack: >> + description: Boolean flag which indicates that the >> application processor >> + must wait for an ACK or a NACK from RPMh for >> every request >> + sent for this regulator including those which >> are for a >> + strictly lower power state. >> + $ref: /schemas/types.yaml#/definitions/string > > Boolean or string? > Ok, will change it to /schemas/types.yaml#/definitions/flag >> + >> +patternProperties: >> + ".*-supply$": > > You can drop '.*'. That's already the case without '^'. > Ok. > The supply names need to be defined. > you mean I should define like this "^vdd-s|l([0-9]+)-supply$": ? >> + description: phandle of the parent supply regulator of one or >> more of the >> + regulators for this PMIC. >> + >> + "^((smps|ldo|lvs)[0-9]*)$": > > s/*/+/ as 1 digit is always required, right? > ok >> + type: object >> + allOf: > > Don't need allOf. > ok, will drop this. >> + - $ref: "regulator.yaml#" >> + description: List of regulator parent supply phandles > > This is a node, not a list of phandles. > Okay. >> + >> + "bob$": > > 'foobob' is okay as that would be allowed? If a fixed string, put > under 'properties'. > It is fixed string, will move it to properties. >> + type: object >> + allOf: >> + - $ref: "regulator.yaml#" >> + description: BOB regulator parent supply phandle >> + >> +additionalProperties: false >> + >> +required: >> + - compatible >> + - qcom,pmic-id >> + >> +examples: >> + - | >> + #include <dt-bindings/regulator/qcom,rpmh-regulator.h> >> + >> + pm8998-rpmh-regulators { >> + compatible = "qcom,pm8998-rpmh-regulators"; >> + qcom,pmic-id = "a"; >> + >> + vdd-l7-l12-l14-l15-supply = <&pm8998_s5>; >> + >> + smps2 { >> + regulator-min-microvolt = <1100000>; >> + regulator-max-microvolt = <1100000>; >> + }; >> + >> + pm8998_s5: smps5 { > > Drop unused labels. > Okay. >> + regulator-min-microvolt = <1904000>; >> + regulator-max-microvolt = <2040000>; >> + }; >> + >> + ldo7 { >> + regulator-min-microvolt = <1800000>; >> + regulator-max-microvolt = <1800000>; >> + regulator-initial-mode = <RPMH_REGULATOR_MODE_HPM>; >> + regulator-allowed-modes = >> + <RPMH_REGULATOR_MODE_LPM >> + RPMH_REGULATOR_MODE_HPM>; >> + regulator-allow-set-load; >> + }; >> + >> + lvs1 { >> + regulator-min-microvolt = <1800000>; >> + regulator-max-microvolt = <1800000>; >> + }; >> + }; >> + >> + pmi8998-rpmh-regulators { >> + compatible = "qcom,pmi8998-rpmh-regulators"; >> + qcom,pmic-id = "b"; >> + >> + bob { >> + regulator-min-microvolt = <3312000>; >> + regulator-max-microvolt = <3600000>; >> + regulator-allowed-modes = >> + <RPMH_REGULATOR_MODE_AUTO >> + RPMH_REGULATOR_MODE_HPM>; >> + regulator-initial-mode = <RPMH_REGULATOR_MODE_AUTO>; >> + }; >> + }; >> +... >> -- >> QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a >> member >> of Code Aurora Forum, hosted by The Linux Foundation >> Thanks, Satya Priya
On 2021-03-01 20:14, Rob Herring wrote: > On Wed, 24 Feb 2021 14:03:06 +0530, satya priya wrote: >> Convert regulator bindings from .txt to .yaml format. >> >> Signed-off-by: satya priya <skakit@codeaurora.org> >> --- >> .../bindings/regulator/qcom,rpmh-regulator.txt | 180 >> --------------------- >> .../bindings/regulator/qcom,rpmh-regulator.yaml | 147 >> +++++++++++++++++ >> 2 files changed, 147 insertions(+), 180 deletions(-) >> delete mode 100644 >> Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt >> create mode 100644 >> Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml >> > > My bot found errors running 'make dt_binding_check' on your patch: > > yamllint warnings/errors: > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:13:5: > [warning] wrong indentation: expected 2 but found 4 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:48:5: > [warning] wrong indentation: expected 2 but found 4 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:49:9: > [warning] wrong indentation: expected 6 but found 8 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:50:13: > [warning] wrong indentation: expected 10 but found 12 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:64:9: > [warning] wrong indentation: expected 6 but found 8 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:69:9: > [warning] wrong indentation: expected 6 but found 8 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:83:6: > [warning] wrong indentation: expected 6 but found 5 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:89:6: > [warning] wrong indentation: expected 6 but found 5 (indentation) > ./Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml:95:2: > [warning] wrong indentation: expected 2 but found 1 (indentation) > > dtschema/dtc warnings/errors: > > See https://patchwork.ozlabs.org/patch/1443748 > > This check can fail if there are any dependencies. The base for a patch > series is generally the most recent rc1. > > 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. I've updated dt-schema, and also installed yamllint but I am not seeing these errors, could you please let me know if I am missing anything here. Thanks, Satya Priya
diff --git a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt deleted file mode 100644 index ce1e043..0000000 --- a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt +++ /dev/null @@ -1,180 +0,0 @@ -Qualcomm Technologies, Inc. RPMh Regulators - -rpmh-regulator devices support PMIC regulator management via the Voltage -Regulator Manager (VRM) and Oscillator Buffer (XOB) RPMh accelerators. The APPS -processor communicates with these hardware blocks via a Resource State -Coordinator (RSC) using command packets. The VRM allows changing three -parameters for a given regulator: enable state, output voltage, and operating -mode. The XOB allows changing only a single parameter for a given regulator: -its enable state. Despite its name, the XOB is capable of controlling the -enable state of any PMIC peripheral. It is used for clock buffers, low-voltage -switches, and LDO/SMPS regulators which have a fixed voltage and mode. - -======================= -Required Node Structure -======================= - -RPMh regulators must be described in two levels of device nodes. The first -level describes the PMIC containing the regulators and must reside within an -RPMh device node. The second level describes each regulator within the PMIC -which is to be used on the board. Each of these regulators maps to a single -RPMh resource. - -The names used for regulator nodes must match those supported by a given PMIC. -Supported regulator node names: - PM8005: smps1 - smps4 - PM8009: smps1 - smps2, ldo1 - ldo7 - PM8150: smps1 - smps10, ldo1 - ldo18 - PM8150L: smps1 - smps8, ldo1 - ldo11, bob, flash, rgb - PM8350: smps1 - smps12, ldo1 - ldo10, - PM8350C: smps1 - smps10, ldo1 - ldo13, bob - PM8998: smps1 - smps13, ldo1 - ldo28, lvs1 - lvs2 - PMI8998: bob - PM6150: smps1 - smps5, ldo1 - ldo19 - PM6150L: smps1 - smps8, ldo1 - ldo11, bob - PMX55: smps1 - smps7, ldo1 - ldo16 - -======================== -First Level Nodes - PMIC -======================== - -- compatible - Usage: required - Value type: <string> - Definition: Must be one of below: - "qcom,pm8005-rpmh-regulators" - "qcom,pm8009-rpmh-regulators" - "qcom,pm8009-1-rpmh-regulators" - "qcom,pm8150-rpmh-regulators" - "qcom,pm8150l-rpmh-regulators" - "qcom,pm8350-rpmh-regulators" - "qcom,pm8350c-rpmh-regulators" - "qcom,pm8998-rpmh-regulators" - "qcom,pmc8180-rpmh-regulators" - "qcom,pmc8180c-rpmh-regulators" - "qcom,pmi8998-rpmh-regulators" - "qcom,pm6150-rpmh-regulators" - "qcom,pm6150l-rpmh-regulators" - "qcom,pmx55-rpmh-regulators" - -- qcom,pmic-id - Usage: required - Value type: <string> - Definition: RPMh resource name suffix used for the regulators found on - this PMIC. Typical values: "a", "b", "c", "d", "e", "f". - -- vdd-s1-supply -- vdd-s2-supply -- vdd-s3-supply -- vdd-s4-supply - Usage: optional (PM8998 and PM8005 only) - Value type: <phandle> - Definition: phandle of the parent supply regulator of one or more of the - regulators for this PMIC. - -- vdd-s5-supply -- vdd-s6-supply -- vdd-s7-supply -- vdd-s8-supply -- vdd-s9-supply -- vdd-s10-supply -- vdd-s11-supply -- vdd-s12-supply -- vdd-s13-supply -- vdd-l1-l27-supply -- vdd-l2-l8-l17-supply -- vdd-l3-l11-supply -- vdd-l4-l5-supply -- vdd-l6-supply -- vdd-l7-l12-l14-l15-supply -- vdd-l9-supply -- vdd-l10-l23-l25-supply -- vdd-l13-l19-l21-supply -- vdd-l16-l28-supply -- vdd-l18-l22-supply -- vdd-l20-l24-supply -- vdd-l26-supply -- vin-lvs-1-2-supply - Usage: optional (PM8998 only) - Value type: <phandle> - Definition: phandle of the parent supply regulator of one or more of the - regulators for this PMIC. - -- vdd-bob-supply - Usage: optional (PMI8998 only) - Value type: <phandle> - Definition: BOB regulator parent supply phandle - -=============================== -Second Level Nodes - Regulators -=============================== - -- qcom,always-wait-for-ack - Usage: optional - Value type: <empty> - Definition: Boolean flag which indicates that the application processor - must wait for an ACK or a NACK from RPMh for every request - sent for this regulator including those which are for a - strictly lower power state. - -Other properties defined in Documentation/devicetree/bindings/regulator/regulator.txt -may also be used. regulator-initial-mode and regulator-allowed-modes may be -specified for VRM regulators using mode values from -include/dt-bindings/regulator/qcom,rpmh-regulator.h. regulator-allow-bypass -may be specified for BOB type regulators managed via VRM. -regulator-allow-set-load may be specified for LDO type regulators managed via -VRM. - -======== -Examples -======== - -#include <dt-bindings/regulator/qcom,rpmh-regulator.h> - -&apps_rsc { - pm8998-rpmh-regulators { - compatible = "qcom,pm8998-rpmh-regulators"; - qcom,pmic-id = "a"; - - vdd-l7-l12-l14-l15-supply = <&pm8998_s5>; - - smps2 { - regulator-min-microvolt = <1100000>; - regulator-max-microvolt = <1100000>; - }; - - pm8998_s5: smps5 { - regulator-min-microvolt = <1904000>; - regulator-max-microvolt = <2040000>; - }; - - ldo7 { - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <1800000>; - regulator-initial-mode = <RPMH_REGULATOR_MODE_HPM>; - regulator-allowed-modes = - <RPMH_REGULATOR_MODE_LPM - RPMH_REGULATOR_MODE_HPM>; - regulator-allow-set-load; - }; - - lvs1 { - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <1800000>; - }; - }; - - pmi8998-rpmh-regulators { - compatible = "qcom,pmi8998-rpmh-regulators"; - qcom,pmic-id = "b"; - - bob { - regulator-min-microvolt = <3312000>; - regulator-max-microvolt = <3600000>; - regulator-allowed-modes = - <RPMH_REGULATOR_MODE_AUTO - RPMH_REGULATOR_MODE_HPM>; - regulator-initial-mode = <RPMH_REGULATOR_MODE_AUTO>; - }; - }; -}; diff --git a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml new file mode 100644 index 0000000..c14baf8 --- /dev/null +++ b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml @@ -0,0 +1,147 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/regulator/qcom,rpmh-regulator.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Qualcomm Technologies, Inc. RPMh Regulators + +maintainers: + - David Collins <collinsd@codeaurora.org> + +description: + rpmh-regulator devices support PMIC regulator management via the Voltage + Regulator Manager (VRM) and Oscillator Buffer (XOB) RPMh accelerators. The APPS + processor communicates with these hardware blocks via a Resource State + Coordinator (RSC) using command packets. The VRM allows changing three + parameters for a given regulator, enable state, output voltage, and operating + mode. The XOB allows changing only a single parameter for a given regulator, + its enable state. Despite its name, the XOB is capable of controlling the + enable state of any PMIC peripheral. It is used for clock buffers, low-voltage + switches, and LDO/SMPS regulators which have a fixed voltage and mode. + + ======================= + Required Node Structure + ======================= + + RPMh regulators must be described in two levels of device nodes. The first + level describes the PMIC containing the regulators and must reside within an + RPMh device node. The second level describes each regulator within the PMIC + which is to be used on the board. Each of these regulators maps to a single + RPMh resource. + + The names used for regulator nodes must match those supported by a given PMIC. + Supported regulator node names are + For PM8005, smps1 - smps4 + For PM8009, smps1 - smps2, ldo1 - ldo7 + For PM8150, smps1 - smps10, ldo1 - ldo18 + For PM8150L, smps1 - smps8, ldo1 - ldo11, bob, flash, rgb + For PM8350, smps1 - smps12, ldo1 - ldo10 + For PM8350C, smps1 - smps10, ldo1 - ldo13, bob + For PM8998, smps1 - smps13, ldo1 - ldo28, lvs1 - lvs2 + For PMI8998, bob + For PM6150, smps1 - smps5, ldo1 - ldo19 + For PM6150L, smps1 - smps8, ldo1 - ldo11, bob + For PMX55, smps1 - smps7, ldo1 - ldo16 + +properties: + compatible: + enum: + - qcom,pm8005-rpmh-regulators + - qcom,pm8009-rpmh-regulators + - qcom,pm8009-1-rpmh-regulators + - qcom,pm8150-rpmh-regulators + - qcom,pm8150l-rpmh-regulators + - qcom,pm8350-rpmh-regulators + - qcom,pm8350c-rpmh-regulators + - qcom,pm8998-rpmh-regulators + - qcom,pmi8998-rpmh-regulators + - qcom,pm6150-rpmh-regulators + - qcom,pm6150l-rpmh-regulators + - qcom,pmx55-rpmh-regulators + + qcom,pmic-id: + description: RPMh resource name suffix used for the regulators found on + this PMIC. Typical values are "a", "b", "c", "d", "e", "f". + $ref: /schemas/types.yaml#/definitions/string + + qcom,always-wait-for-ack: + description: Boolean flag which indicates that the application processor + must wait for an ACK or a NACK from RPMh for every request + sent for this regulator including those which are for a + strictly lower power state. + $ref: /schemas/types.yaml#/definitions/string + +patternProperties: + ".*-supply$": + description: phandle of the parent supply regulator of one or more of the + regulators for this PMIC. + + "^((smps|ldo|lvs)[0-9]*)$": + type: object + allOf: + - $ref: "regulator.yaml#" + description: List of regulator parent supply phandles + + "bob$": + type: object + allOf: + - $ref: "regulator.yaml#" + description: BOB regulator parent supply phandle + +additionalProperties: false + +required: + - compatible + - qcom,pmic-id + +examples: + - | + #include <dt-bindings/regulator/qcom,rpmh-regulator.h> + + pm8998-rpmh-regulators { + compatible = "qcom,pm8998-rpmh-regulators"; + qcom,pmic-id = "a"; + + vdd-l7-l12-l14-l15-supply = <&pm8998_s5>; + + smps2 { + regulator-min-microvolt = <1100000>; + regulator-max-microvolt = <1100000>; + }; + + pm8998_s5: smps5 { + regulator-min-microvolt = <1904000>; + regulator-max-microvolt = <2040000>; + }; + + ldo7 { + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <1800000>; + regulator-initial-mode = <RPMH_REGULATOR_MODE_HPM>; + regulator-allowed-modes = + <RPMH_REGULATOR_MODE_LPM + RPMH_REGULATOR_MODE_HPM>; + regulator-allow-set-load; + }; + + lvs1 { + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <1800000>; + }; + }; + + pmi8998-rpmh-regulators { + compatible = "qcom,pmi8998-rpmh-regulators"; + qcom,pmic-id = "b"; + + bob { + regulator-min-microvolt = <3312000>; + regulator-max-microvolt = <3600000>; + regulator-allowed-modes = + <RPMH_REGULATOR_MODE_AUTO + RPMH_REGULATOR_MODE_HPM>; + regulator-initial-mode = <RPMH_REGULATOR_MODE_AUTO>; + }; + }; +...
Convert regulator bindings from .txt to .yaml format. Signed-off-by: satya priya <skakit@codeaurora.org> --- .../bindings/regulator/qcom,rpmh-regulator.txt | 180 --------------------- .../bindings/regulator/qcom,rpmh-regulator.yaml | 147 +++++++++++++++++ 2 files changed, 147 insertions(+), 180 deletions(-) delete mode 100644 Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt create mode 100644 Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.yaml