xref: /freebsd/sys/contrib/device-tree/Bindings/power/supply/sc27xx-fg.yaml (revision 257e70f1d5ee61037c8c59b116538d3b6b1427a2)
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/power/supply/sc27xx-fg.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Spreadtrum SC27XX PMICs Fuel Gauge Unit Power Supply
8
9maintainers:
10  - Sebastian Reichel <sre@kernel.org>
11
12allOf:
13  - $ref: power-supply.yaml#
14
15properties:
16  compatible:
17    enum:
18      - sprd,sc2720-fgu
19      - sprd,sc2721-fgu
20      - sprd,sc2723-fgu
21      - sprd,sc2730-fgu
22      - sprd,sc2731-fgu
23
24  reg:
25    maxItems: 1
26
27  battery-detect-gpios:
28    maxItems: 1
29
30  io-channels:
31    items:
32      - description: Battery Temperature ADC
33      - description: Battery Charge Voltage ADC
34
35  io-channel-names:
36    items:
37      - const: bat-temp
38      - const: charge-vol
39
40  nvmem-cells:
41    maxItems: 1
42    description: Calibration cells provided by eFuse device
43
44  nvmem-cell-names:
45    const: fgu_calib
46
47  sprd,calib-resistance-micro-ohms:
48    description: real resistance of coulomb counter chip in micro Ohms
49
50  monitored-battery: true
51
52required:
53  - compatible
54  - reg
55  - battery-detect-gpios
56  - io-channels
57  - io-channel-names
58  - nvmem-cells
59  - nvmem-cell-names
60  - sprd,calib-resistance-micro-ohms
61  - monitored-battery
62
63additionalProperties: false
64
65examples:
66  - |
67    #include <dt-bindings/gpio/gpio.h>
68    bat: battery {
69      compatible = "simple-battery";
70      charge-full-design-microamp-hours = <1900000>;
71      constant-charge-voltage-max-microvolt = <4350000>;
72      ocv-capacity-celsius = <20>;
73      ocv-capacity-table-0 = <4185000 100>, <4113000 95>, <4066000 90>,
74                             <4022000 85>, <3983000 80>, <3949000 75>,
75                             <3917000 70>, <3889000 65>, <3864000 60>,
76                             <3835000 55>, <3805000 50>, <3787000 45>,
77                             <3777000 40>, <3773000 35>, <3770000 30>,
78                             <3765000 25>, <3752000 20>, <3724000 15>,
79                             <3680000 10>, <3605000 5>, <3400000 0>;
80                             // ...
81    };
82
83    pmic {
84      #address-cells = <1>;
85      #size-cells = <0>;
86
87      battery@a00 {
88        compatible = "sprd,sc2731-fgu";
89        reg = <0xa00>;
90        battery-detect-gpios = <&pmic_eic 9 GPIO_ACTIVE_HIGH>;
91        io-channels = <&pmic_adc 5>, <&pmic_adc 14>;
92        io-channel-names = "bat-temp", "charge-vol";
93        nvmem-cells = <&fgu_calib>;
94        nvmem-cell-names = "fgu_calib";
95        monitored-battery = <&bat>;
96        sprd,calib-resistance-micro-ohms = <21500>;
97      };
98    };
99