On 06/05/2023 17:54, Jakob Hauser wrote: > Add device tree binding documentation for rt5033 multifunction device, voltage > regulator and battery charger. > > Cc: Beomho Seo <beomho.seo@xxxxxxxxxxx> > Cc: Chanwoo Choi <cw00.choi@xxxxxxxxxxx> > Signed-off-by: Jakob Hauser <jahau@xxxxxxxxxxxxxx> > Reviewed-by: Linus Walleij <linus.walleij@xxxxxxxxxx> > --- > The patch is based on next-20230505. > > The drivers for rt5033 (mfd) and rt5033-regulator are existing. Whereas the > the driver rt5033-charger is new in this patchset. > > .../bindings/mfd/richtek,rt5033.yaml | 113 ++++++++++++++++++ > .../power/supply/richtek,rt5033-charger.yaml | 64 ++++++++++ > 2 files changed, 177 insertions(+) > create mode 100644 Documentation/devicetree/bindings/mfd/richtek,rt5033.yaml > create mode 100644 Documentation/devicetree/bindings/power/supply/richtek,rt5033-charger.yaml > > diff --git a/Documentation/devicetree/bindings/mfd/richtek,rt5033.yaml b/Documentation/devicetree/bindings/mfd/richtek,rt5033.yaml > new file mode 100644 > index 000000000000..0aa0a556b50f > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/richtek,rt5033.yaml > @@ -0,0 +1,113 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mfd/richtek,rt5033.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Richtek RT5033 Power Management Integrated Circuit > + > +maintainers: > + - Jakob Hauser <jahau@xxxxxxxxxxxxxx> > + > +description: > + RT5033 is a multifunction device which includes battery charger, fuel gauge, > + flash LED current source, LDO and synchronous Buck converter for portable > + applications. It is interfaced to host controller using I2C interface. The > + battery fuel gauge uses a separate I2C bus. > + > +properties: > + compatible: > + const: richtek,rt5033 > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + regulators: > + description: > + The regulators of RT5033 have to be instantiated under a sub-node named > + "regulators". For SAFE_LDO voltage there is only one value of 4.9 V. LDO > + voltage ranges from 1.2 V to 3.0 V in 0.1 V steps. BUCK voltage ranges > + from 1.0 V to 3.0 V in 0.1 V steps. > + type: object > + patternProperties: > + "^(SAFE_LDO|LDO|BUCK)$": > + type: object > + $ref: /schemas/regulator/regulator.yaml# > + unevaluatedProperties: false > + additionalProperties: false > + > + charger: > + type: object > + $ref: /schemas/power/supply/richtek,rt5033-charger.yaml# > + > +required: > + - compatible > + - reg > + - interrupts > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + > + battery: battery { > + compatible = "simple-battery"; > + precharge-current-microamp = <450000>; > + constant-charge-current-max-microamp = <1000000>; > + charge-term-current-microamp = <150000>; > + precharge-upper-limit-microvolt = <3500000>; > + constant-charge-voltage-max-microvolt = <4350000>; > + }; > + > + extcon { > + usb_con: connector { > + compatible = "usb-b-connector"; > + label = "micro-USB"; > + type = "micro"; > + }; > + }; > + > + i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + > + pmic@34 { > + compatible = "richtek,rt5033"; > + reg = <0x34>; > + > + interrupt-parent = <&msmgpio>; > + interrupts = <62 IRQ_TYPE_EDGE_FALLING>; > + > + pinctrl-names = "default"; > + pinctrl-0 = <&pmic_int_default>; > + > + regulators { > + safe_ldo_reg: SAFE_LDO { > + regulator-name = "SAFE_LDO"; > + regulator-min-microvolt = <4900000>; > + regulator-max-microvolt = <4900000>; > + regulator-always-on; > + }; > + ldo_reg: LDO { > + regulator-name = "LDO"; > + regulator-min-microvolt = <2800000>; > + regulator-max-microvolt = <2800000>; > + }; > + buck_reg: BUCK { > + regulator-name = "BUCK"; > + regulator-min-microvolt = <1200000>; > + regulator-max-microvolt = <1200000>; > + }; > + }; > + > + charger { > + compatible = "richtek,rt5033-charger"; > + monitored-battery = <&battery>; > + connector = <&usb_con>; > + }; > + }; > + }; > diff --git a/Documentation/devicetree/bindings/power/supply/richtek,rt5033-charger.yaml b/Documentation/devicetree/bindings/power/supply/richtek,rt5033-charger.yaml > new file mode 100644 > index 000000000000..b8607cc6ec63 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/supply/richtek,rt5033-charger.yaml > @@ -0,0 +1,64 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/power/supply/richtek,rt5033-charger.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Richtek RT5033 PIMC Battery Charger PMIC > + > +maintainers: > + - Jakob Hauser <jahau@xxxxxxxxxxxxxx> > + > +description: > + The battery charger of the multifunction device RT5033 has to be instantiated > + under sub-node named "charger" using the following format. > + > +properties: > + compatible: > + const: richtek,rt5033-charger > + > + monitored-battery: > + description: | > + Phandle to the monitored battery according to battery.yaml. The battery > + node needs to contain five parameters. > + > + precharge-current-microamp: > + Current of pre-charge mode. The pre-charge current levels are 350 mA > + to 650 mA programmed by I2C per 100 mA. > + > + constant-charge-current-max-microamp: > + Current of fast-charge mode. The fast-charge current levels are 700 mA > + to 2000 mA programmed by I2C per 100 mA. > + > + charge-term-current-microamp: > + This property is end of charge current. Its level ranges from 150 mA > + to 600 mA. Between 150 mA and 300 mA in 50 mA steps, between 300 mA and > + 600 mA in 100 mA steps. > + > + precharge-upper-limit-microvolt: > + Voltage of pre-charge mode. If the battery voltage is below the pre-charge > + threshold voltage, the charger is in pre-charge mode with pre-charge > + current. Its levels are 2.3 V to 3.8 V programmed by I2C per 0.1 V. > + > + constant-charge-voltage-max-microvolt: > + Battery regulation voltage of constant voltage mode. This voltage levels > + from 3.65 V to 4.4 V by I2C per 0.025 V. > + > + connector: > + description: > + Phandle to a USB connector according to usb-connector.yaml. The connector > + should be a child of the extcon device. > + maxItems: 1 Missing type/ref... but then you will notice you have conflicting ref with existing connector. connector is usb-connector.yaml, not phandle. I am not sure if we need generic property, so let's go with device specific - richtek,usb-connector > + > +required: > + - monitored-battery Best regards, Krzysztof
