xref: /linux/Documentation/devicetree/bindings/power/supply/maxim,max17042.yaml (revision fc2d791a43d3880496d1c729b8bd74d2c19cb4e7) 
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
7title: Maxim 17042 fuel gauge series
8
9maintainers:
10  - Sebastian Reichel <sre@kernel.org>
11
12allOf:
13  - $ref: power-supply.yaml#
14
15properties:
16  compatible:
17    enum:
18      - maxim,max17042
19      - maxim,max17047
20      - maxim,max17050
21      - maxim,max17055
22      - maxim,max77705-battery
23      - maxim,max77759-fg
24      - maxim,max77849-battery
25
26  reg:
27    maxItems: 1
28
29  interrupts:
30    maxItems: 1
31    description:
32      The ALRT pin (or FG_INTB pin on MAX77759), an open-drain interrupt.
33
34  shunt-resistor-micro-ohms:
35    description:
36      Resistance of rsns resistor in micro Ohms (datasheet-recommended value is 10000).
37      Defining this property enables current-sense functionality.
38
39  maxim,rsns-microohm:
40    deprecated: true
41    $ref: /schemas/types.yaml#/definitions/uint32
42    description:
43      Resistance of rsns resistor in micro Ohms (datasheet-recommended value is 10000).
44      Defining this property enables current-sense functionality.
45
46  maxim,cold-temp:
47    $ref: /schemas/types.yaml#/definitions/uint32
48    description:
49      Temperature threshold to report battery as cold (in tenths of degree Celsius).
50      Default is not to report cold events.
51
52  maxim,over-heat-temp:
53    $ref: /schemas/types.yaml#/definitions/uint32
54    description:
55      Temperature threshold to report battery as over heated (in tenths of degree Celsius).
56      Default is not to report over heating events.
57
58  maxim,dead-volt:
59    $ref: /schemas/types.yaml#/definitions/uint32
60    description:
61      Voltage threshold to report battery as dead (in mV).
62      Default is not to report dead battery events.
63
64  maxim,over-volt:
65    $ref: /schemas/types.yaml#/definitions/uint32
66    description:
67      Voltage threshold to report battery as over voltage (in mV).
68      Default is not to report over-voltage events.
69
70  power-supplies: true
71
72required:
73  - compatible
74  - reg
75
76additionalProperties: false
77
78examples:
79  - |
80    i2c {
81      #address-cells = <1>;
82      #size-cells = <0>;
83
84      battery@36 {
85        compatible = "maxim,max17042";
86        reg = <0x36>;
87        maxim,rsns-microohm = <10000>;
88        maxim,over-heat-temp = <600>;
89        maxim,over-volt = <4300>;
90      };
91    };
92