xref: /freebsd/sys/contrib/device-tree/Bindings/power/supply/st,stc3117.yaml (revision 2846c90520eb4cc74e24d586a0ea0f4a0006bc73)
1*2846c905SEmmanuel Vadot# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2*2846c905SEmmanuel Vadot%YAML 1.2
3*2846c905SEmmanuel Vadot---
4*2846c905SEmmanuel Vadot$id: http://devicetree.org/schemas/power/supply/st,stc3117.yaml#
5*2846c905SEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6*2846c905SEmmanuel Vadot
7*2846c905SEmmanuel Vadottitle: STMicroelectronics STC3117 Fuel Gauge Unit Power Supply
8*2846c905SEmmanuel Vadot
9*2846c905SEmmanuel Vadotmaintainers:
10*2846c905SEmmanuel Vadot  - Hardevsinh Palaniya <hardevsinh.palaniya@siliconsignals.io>
11*2846c905SEmmanuel Vadot  - Bhavin Sharma <bhavin.sharma@siliconsignals.io>
12*2846c905SEmmanuel Vadot
13*2846c905SEmmanuel Vadotdescription: |
14*2846c905SEmmanuel Vadot  The STC3117 includes the STMicroelectronics OptimGauge algorithm.
15*2846c905SEmmanuel Vadot  It provides accurate battery state-of-charge (SOC) monitoring, tracks
16*2846c905SEmmanuel Vadot  battery parameter changes with operation conditions, temperature,
17*2846c905SEmmanuel Vadot  and aging, and allows the application to get a battery state-of-health
18*2846c905SEmmanuel Vadot  (SOH) indication.
19*2846c905SEmmanuel Vadot
20*2846c905SEmmanuel Vadot  An alarm output signals low SOC or low voltage conditions and also
21*2846c905SEmmanuel Vadot  indicates fault conditions like a missing or swapped battery.
22*2846c905SEmmanuel Vadot
23*2846c905SEmmanuel Vadot  Datasheet is available at
24*2846c905SEmmanuel Vadot  https://www.st.com/resource/en/datasheet/stc3117.pdf
25*2846c905SEmmanuel Vadot
26*2846c905SEmmanuel VadotallOf:
27*2846c905SEmmanuel Vadot  - $ref: power-supply.yaml#
28*2846c905SEmmanuel Vadot
29*2846c905SEmmanuel Vadotproperties:
30*2846c905SEmmanuel Vadot  compatible:
31*2846c905SEmmanuel Vadot    enum:
32*2846c905SEmmanuel Vadot      - st,stc3117
33*2846c905SEmmanuel Vadot
34*2846c905SEmmanuel Vadot  reg:
35*2846c905SEmmanuel Vadot    maxItems: 1
36*2846c905SEmmanuel Vadot
37*2846c905SEmmanuel Vadot  monitored-battery:
38*2846c905SEmmanuel Vadot    description: |
39*2846c905SEmmanuel Vadot      The fuel gauge uses the following battery properties:
40*2846c905SEmmanuel Vadot      - charge-full-design-microamp-hours
41*2846c905SEmmanuel Vadot      - voltage-min-design-microvolt
42*2846c905SEmmanuel Vadot      - voltage-max-design-microvolt
43*2846c905SEmmanuel Vadot
44*2846c905SEmmanuel Vadot  shunt-resistor-micro-ohms:
45*2846c905SEmmanuel Vadot    description: Current sense resistor
46*2846c905SEmmanuel Vadot
47*2846c905SEmmanuel Vadot  interrupts:
48*2846c905SEmmanuel Vadot    maxItems: 1
49*2846c905SEmmanuel Vadot
50*2846c905SEmmanuel Vadotrequired:
51*2846c905SEmmanuel Vadot  - compatible
52*2846c905SEmmanuel Vadot  - reg
53*2846c905SEmmanuel Vadot  - monitored-battery
54*2846c905SEmmanuel Vadot  - shunt-resistor-micro-ohms
55*2846c905SEmmanuel Vadot
56*2846c905SEmmanuel VadotunevaluatedProperties: false
57*2846c905SEmmanuel Vadot
58*2846c905SEmmanuel Vadotexamples:
59*2846c905SEmmanuel Vadot  - |
60*2846c905SEmmanuel Vadot    #include <dt-bindings/interrupt-controller/irq.h>
61*2846c905SEmmanuel Vadot
62*2846c905SEmmanuel Vadot    i2c {
63*2846c905SEmmanuel Vadot      #address-cells = <1>;
64*2846c905SEmmanuel Vadot      #size-cells = <0>;
65*2846c905SEmmanuel Vadot
66*2846c905SEmmanuel Vadot      battery@70 {
67*2846c905SEmmanuel Vadot        compatible = "st,stc3117";
68*2846c905SEmmanuel Vadot        reg = <0x70>;
69*2846c905SEmmanuel Vadot        interrupt-parent = <&gpio0>;
70*2846c905SEmmanuel Vadot        interrupts = <31 IRQ_TYPE_LEVEL_LOW>;
71*2846c905SEmmanuel Vadot        monitored-battery = <&bat>;
72*2846c905SEmmanuel Vadot        shunt-resistor-micro-ohms = <10000>;
73*2846c905SEmmanuel Vadot      };
74*2846c905SEmmanuel Vadot    };
75