Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml

   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 # Copyright 2019-2020 Artur Rojek
   3 %YAML 1.2
   4 ---
   5 $id: "http://devicetree.org/schemas/power/supply/ingenic,battery.yaml#"
   6 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   7
   8 title: Ingenic JZ47xx battery bindings
   9
  10 maintainers:
  11   - Artur Rojek <contact@artur-rojek.eu>
  12
  13 properties:
  14   compatible:
  15     oneOf:
  16       - const: ingenic,jz4740-battery
  17       - items:
  18           - enum:
  19               - ingenic,jz4725b-battery
  20               - ingenic,jz4770-battery
  21           - const: ingenic,jz4740-battery
  22
  23   io-channels:
  24     maxItems: 1
  25
  26   io-channel-names:
  27     const: battery
  28
  29   monitored-battery:
  30     description: >
  31       phandle to a "simple-battery" compatible node.
  32
  33       This property must be a phandle to a node using the format described
  34       in battery.yaml, with the following properties being required:
  35       - voltage-min-design-microvolt: drained battery voltage,
  36       - voltage-max-design-microvolt: fully charged battery voltage.
  37
  38 required:
  39   - compatible
  40   - io-channels
  41   - io-channel-names
  42   - monitored-battery
  43
  44 additionalProperties: false
  45
  46 examples:
  47   - |
  48     #include <dt-bindings/iio/adc/ingenic,adc.h>
  49
  50     simple_battery: battery {
  51             compatible = "simple-battery";
  52             voltage-min-design-microvolt = <3600000>;
  53             voltage-max-design-microvolt = <4200000>;
  54     };
  55
  56     ingenic-battery {
  57             compatible = "ingenic,jz4740-battery";
  58             io-channels = <&adc INGENIC_ADC_BATTERY>;
  59             io-channel-names = "battery";
  60             monitored-battery = <&simple_battery>;
  61     };