| Message ID | 20221005-mt6357-support-v4-4-5d2bb58e6087@baylibre.com |
|---|---|
| State | Handled Elsewhere |
| Headers | show |
| Series | Add MediaTek MT6357 PMIC support | expand |
On Tue, 08 Nov 2022 19:43:39 +0100, Alexandre Mergnat wrote: > Currently, almost all MT63XX PMIC are documented mfd/mt6397.txt. > Unfortunately, the PMICs haven't always similar HW sub-features. > To have a better human readable schema, I chose to make one PMIC schema > to match the exact HW capabilities instead of convert mt6397.txt to > mediatek,mt63xx.yaml and put a bunch of properties behind > "if contain ... then ..." > > - add interrupt property > - change property refs to match with new yaml documentation > > Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com> > --- > .../devicetree/bindings/mfd/mediatek,mt6357.yaml | 102 +++++++++++++++++++++ > 1 file changed, 102 insertions(+) > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13): yamllint warnings/errors: dtschema/dtc warnings/errors: ./Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml: Unable to find schema file matching $id: http://devicetree.org/schemas/rtc/mediatek,mt6397-rtc.yaml Error: Documentation/devicetree/bindings/mfd/mediatek,mt6357.example.dts:26.35-36 syntax error FATAL ERROR: Unable to parse input tree make[1]: *** [scripts/Makefile.lib:406: Documentation/devicetree/bindings/mfd/mediatek,mt6357.example.dtb] Error 1 make[1]: *** Waiting for unfinished jobs.... make: *** [Makefile:1492: dt_binding_check] Error 2 doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/patch/ 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 08/11/2022 19:43, Alexandre Mergnat wrote: > Currently, almost all MT63XX PMIC are documented mfd/mt6397.txt. > Unfortunately, the PMICs haven't always similar HW sub-features. > To have a better human readable schema, I chose to make one PMIC schema > to match the exact HW capabilities instead of convert mt6397.txt to > mediatek,mt63xx.yaml and put a bunch of properties behind > "if contain ... then ..." > > - add interrupt property > - change property refs to match with new yaml documentation > > Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com> > --- > .../devicetree/bindings/mfd/mediatek,mt6357.yaml | 102 +++++++++++++++++++++ > 1 file changed, 102 insertions(+) > > diff --git a/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml b/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml > new file mode 100644 > index 000000000000..7b421f21d3f5 > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml > @@ -0,0 +1,102 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mfd/mediatek,mt6357.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: MediaTek MT6357 Multifunction Device Driver Multifunction Device is Linux specific, drop. Driver is not hardware related, drop. Instead describe the hardware. It's PMIC right? So call it a PMIC. > + > +maintainers: > + - Alexandre Mergnat <amergnat@baylibre.com> > + > +description: | > + MT6357 is a power management system chip containing 5 buck > + converters and 29 LDOs. Supported features are audio codec, > + USB battery charging, fuel gauge, RTC > + > + This is a multifunction device with the following sub modules: > + - Regulator > + - RTC > + - Keys > + > + It is interfaced to host controller using SPI interface by a proprietary hardware > + called PMIC wrapper or pwrap. This MFD is a child device of pwrap. > + See the following for pwrap node definitions: > + ../soc/mediatek/mediatek,pwrap.yaml > + > +properties: > + compatible: > + const: mediatek,mt6357 > + > + interrupts: > + maxItems: 1 > + > + interrupt-controller: true > + > + "#interrupt-cells": > + const: 2 > + > + regulators: > + type: object > + $ref: ../regulator/mediatek,mt6357-regulator.yaml Full path, so /schemas/regulator/...... > + description: > + Child node that specify the regulator. Improve your descriptions. "Child node" - it is obvious, it's an object. "Specify" - no need. "the regulator" one regulator? > + > + rtc: > + type: object > + $ref: ../rtc/mediatek,mt6397-rtc.yaml Ditto > + description: > + Child node that specify the RTC. MT6357 Real Time Clock > + > + keys: > + type: object > + $ref: ../input/mediatek,pmic-keys.yaml ditto > + description: > + Child node that specify the keys. MT6357 ... > + > +required: > + - compatible > + - regulators > + Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml b/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml new file mode 100644 index 000000000000..7b421f21d3f5 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml @@ -0,0 +1,102 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/mediatek,mt6357.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: MediaTek MT6357 Multifunction Device Driver + +maintainers: + - Alexandre Mergnat <amergnat@baylibre.com> + +description: | + MT6357 is a power management system chip containing 5 buck + converters and 29 LDOs. Supported features are audio codec, + USB battery charging, fuel gauge, RTC + + This is a multifunction device with the following sub modules: + - Regulator + - RTC + - Keys + + It is interfaced to host controller using SPI interface by a proprietary hardware + called PMIC wrapper or pwrap. This MFD is a child device of pwrap. + See the following for pwrap node definitions: + ../soc/mediatek/mediatek,pwrap.yaml + +properties: + compatible: + const: mediatek,mt6357 + + interrupts: + maxItems: 1 + + interrupt-controller: true + + "#interrupt-cells": + const: 2 + + regulators: + type: object + $ref: ../regulator/mediatek,mt6357-regulator.yaml + description: + Child node that specify the regulator. + + rtc: + type: object + $ref: ../rtc/mediatek,mt6397-rtc.yaml + description: + Child node that specify the RTC. + + keys: + type: object + $ref: ../input/mediatek,pmic-keys.yaml + description: + Child node that specify the keys. + +required: + - compatible + - regulators + +additionalProperties: false + +examples: + - | + pwrap { + pmic { + compatible = "mediatek,mt6357"; + + interrupt-parent = <&pio>; + interrupts = <145 IRQ_TYPE_LEVEL_HIGH>; + interrupt-controller; + #interrupt-cells = <2>; + + regulators { + mt6357_vproc_reg: buck-vproc { + regulator-name = "vproc"; + regulator-min-microvolt = <518750>; + regulator-max-microvolt = <1312500>; + regulator-ramp-delay = <6250>; + regulator-enable-ramp-delay = <220>; + regulator-always-on; + }; + + // ... + + mt6357_vusb33_reg: ldo-vusb33 { + regulator-name = "vusb33"; + regulator-min-microvolt = <3000000>; + regulator-max-microvolt = <3100000>; + regulator-enable-ramp-delay = <264>; + }; + }; + + rtc { + compatible = "mediatek,mt6357-rtc"; + }; + + keys { + compatible = "mediatek,mt6357-keys"; + }; + }; + };
Currently, almost all MT63XX PMIC are documented mfd/mt6397.txt. Unfortunately, the PMICs haven't always similar HW sub-features. To have a better human readable schema, I chose to make one PMIC schema to match the exact HW capabilities instead of convert mt6397.txt to mediatek,mt63xx.yaml and put a bunch of properties behind "if contain ... then ..." - add interrupt property - change property refs to match with new yaml documentation Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com> --- .../devicetree/bindings/mfd/mediatek,mt6357.yaml | 102 +++++++++++++++++++++ 1 file changed, 102 insertions(+)