Documentation/devicetree/bindings/power/supply/stericsson,ab8500-fg.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 # Copyright (C) 2021 Sebastian Reichel
   3 %YAML 1.2
   4 ---
   5 $id: http://devicetree.org/schemas/power/supply/stericsson,ab8500-fg.yaml#
   6 $schema: http://devicetree.org/meta-schemas/core.yaml#
   7
   8 title: AB8500 Fuel Gauge
   9
  10 maintainers:
  11   - Sebastian Reichel <sre@kernel.org>
  12
  13 allOf:
  14   - $ref: power-supply.yaml#
  15
  16 properties:
  17   compatible:
  18     const: stericsson,ab8500-fg
  19
  20   monitored-battery:
  21     $ref: /schemas/types.yaml#/definitions/phandle
  22     description: phandle to battery node
  23
  24   battery:
  25     $ref: /schemas/types.yaml#/definitions/phandle
  26     deprecated: true
  27
  28   line-impedance-micro-ohms:
  29     description: The line impedance between the battery and the
  30       AB8500 inputs, to compensate for this when determining internal
  31       resistance.
  32
  33   interrupts:
  34     maxItems: 5
  35
  36   interrupt-names:
  37     items:
  38       - const: NCONV_ACCU
  39       - const: BATT_OVV
  40       - const: LOW_BAT_F
  41       - const: CC_INT_CALIB
  42       - const: CCEOC
  43
  44   io-channels:
  45     maxItems: 1
  46
  47   io-channel-names:
  48     items:
  49       - const: main_bat_v
  50
  51 required:
  52   - compatible
  53   - monitored-battery
  54   - interrupts
  55   - interrupt-names
  56   - io-channels
  57   - io-channel-names
  58
  59 additionalProperties: false
  60
  61 examples:
  62   - |
  63     #include <dt-bindings/interrupt-controller/irq.h>
  64     pmic {
  65       fuel-gauge {
  66         compatible = "stericsson,ab8500-fg";
  67         monitored-battery = <&battery>;
  68         interrupts = <24 IRQ_TYPE_LEVEL_HIGH>,
  69                      <8 IRQ_TYPE_LEVEL_HIGH>,
  70                      <28 IRQ_TYPE_LEVEL_HIGH>,
  71                      <27 IRQ_TYPE_LEVEL_HIGH>,
  72                      <26 IRQ_TYPE_LEVEL_HIGH>;
  73         interrupt-names = "NCONV_ACCU",
  74                           "BATT_OVV",
  75                           "LOW_BAT_F",
  76                           "CC_INT_CALIB",
  77                           "CCEOC";
  78         io-channels = <&gpadc 0x08>;
  79         io-channel-names = "main_bat_v";
  80       };
  81     };