Documentation/devicetree/bindings/power/supply/maxim,max17042.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: "http://devicetree.org/schemas/power/supply/maxim,max17042.yaml#"
   5 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   6
   7 title: Maxim 17042 fuel gauge series
   8
   9 maintainers:
  10   - Sebastian Reichel <sre@kernel.org>
  11
  12 allOf:
  13   - $ref: power-supply.yaml#
  14
  15 properties:
  16   compatible:
  17     enum:
  18       - maxim,max17042
  19       - maxim,max17047
  20       - maxim,max17050
  21       - maxim,max17055
  22       - maxim,max77849-battery
  23
  24   reg:
  25     maxItems: 1
  26
  27   interrupts:
  28     maxItems: 1
  29     description: |
  30       The ALRT pin, an open-drain interrupt.
  31
  32   maxim,rsns-microohm:
  33     $ref: /schemas/types.yaml#/definitions/uint32
  34     description: |
  35       Resistance of rsns resistor in micro Ohms (datasheet-recommended value is 10000).
  36       Defining this property enables current-sense functionality.
  37
  38   maxim,cold-temp:
  39     $ref: /schemas/types.yaml#/definitions/uint32
  40     description: |
  41       Temperature threshold to report battery as cold (in tenths of degree Celsius).
  42       Default is not to report cold events.
  43
  44   maxim,over-heat-temp:
  45     $ref: /schemas/types.yaml#/definitions/uint32
  46     description: |
  47       Temperature threshold to report battery as over heated (in tenths of degree Celsius).
  48       Default is not to report over heating events.
  49
  50   maxim,dead-volt:
  51     $ref: /schemas/types.yaml#/definitions/uint32
  52     description: |
  53       Voltage threshold to report battery as dead (in mV).
  54       Default is not to report dead battery events.
  55
  56   maxim,over-volt:
  57     $ref: /schemas/types.yaml#/definitions/uint32
  58     description: |
  59       Voltage threshold to report battery as over voltage (in mV).
  60       Default is not to report over-voltage events.
  61
  62 required:
  63   - compatible
  64   - reg
  65
  66 additionalProperties: false
  67
  68 examples:
  69   - |
  70     i2c0 {
  71       #address-cells = <1>;
  72       #size-cells = <0>;
  73
  74       battery@36 {
  75         compatible = "maxim,max17042";
  76         reg = <0x36>;
  77         maxim,rsns-microohm = <10000>;
  78         maxim,over-heat-temp = <600>;
  79         maxim,over-volt = <4300>;
  80       };
  81     };