Documentation/devicetree/bindings/power/supply/richtek,rt9455.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/power/supply/richtek,rt9455.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Richtek rt9455 battery charger
   8
   9 maintainers:
  10   - Sebastian Reichel <sre@kernel.org>
  11
  12 allOf:
  13   - $ref: power-supply.yaml#
  14
  15 properties:
  16   compatible:
  17     const: richtek,rt9455
  18
  19   reg:
  20     maxItems: 1
  21
  22   interrupts:
  23     maxItems: 1
  24
  25   richtek,output-charge-current:
  26     $ref: /schemas/types.yaml#/definitions/uint32
  27     description: output current from the charger to the battery, in uA.
  28
  29   richtek,end-of-charge-percentage:
  30     $ref: /schemas/types.yaml#/definitions/uint32
  31     description: |
  32       percent of the output charge current. When the current in constant-voltage phase drops
  33       below output_charge_current x end-of-charge-percentage, charge is terminated.
  34
  35   richtek,battery-regulation-voltage:
  36     $ref: /schemas/types.yaml#/definitions/uint32
  37     description: maximum battery voltage in uV.
  38
  39   richtek,boost-output-voltage:
  40     $ref: /schemas/types.yaml#/definitions/uint32
  41     description: |
  42       maximum voltage provided to consumer devices, when the charger is in boost mode, in uV.
  43
  44   richtek,min-input-voltage-regulation:
  45     $ref: /schemas/types.yaml#/definitions/uint32
  46     description: |
  47       input voltage level in uV, used to decrease voltage level when the over current of the
  48       input power source occurs. This prevents input voltage drop due to insufficient
  49       current provided by the power source. Defaults to 4500000 uV (4.5V).
  50
  51   richtek,avg-input-current-regulation:
  52     $ref: /schemas/types.yaml#/definitions/uint32
  53     description: |
  54       input current value in uA drained by the charger from the power source.
  55       Defaults to 500000 uA (500mA).
  56
  57 required:
  58   - compatible
  59   - reg
  60   - interrupts
  61   - richtek,output-charge-current
  62   - richtek,end-of-charge-percentage
  63   - richtek,battery-regulation-voltage
  64   - richtek,boost-output-voltage
  65
  66 additionalProperties: false
  67
  68 examples:
  69   - |
  70     #include <dt-bindings/interrupt-controller/irq.h>
  71     i2c {
  72       #address-cells = <1>;
  73       #size-cells = <0>;
  74
  75       charger@22 {
  76         compatible = "richtek,rt9455";
  77         reg = <0x22>;
  78
  79         interrupt-parent = <&gpio1>;
  80         interrupts = <0 IRQ_TYPE_LEVEL_LOW>;
  81
  82         richtek,output-charge-current = <500000>;
  83         richtek,end-of-charge-percentage = <10>;
  84         richtek,battery-regulation-voltage = <4200000>;
  85         richtek,boost-output-voltage = <5050000>;
  86
  87         richtek,min-input-voltage-regulation = <4500000>;
  88         richtek,avg-input-current-regulation = <500000>;
  89       };
  90     };