xref: /freebsd/sys/contrib/device-tree/Bindings/power/supply/bq27xxx.yaml (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a) 
1# SPDX-License-Identifier: GPL-2.0
2# Copyright (C) 2020 Texas Instruments Incorporated
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/power/supply/bq27xxx.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: TI BQ27XXX fuel gauge family
9
10maintainers:
11  - Pali Rohár <pali@kernel.org>
12  - Andrew F. Davis <afd@ti.com>
13  - Sebastian Reichel <sre@kernel.org>
14
15description: |
16  Support various Texas Instruments fuel gauge devices that share similar
17  register maps and power supply properties
18
19allOf:
20  - $ref: power-supply.yaml#
21
22properties:
23  compatible:
24    enum:
25      - ti,bq27200
26      - ti,bq27210
27      - ti,bq27500 # deprecated, use revision specific property below
28      - ti,bq27510 # deprecated, use revision specific property below
29      - ti,bq27520 # deprecated, use revision specific property below
30      - ti,bq27500-1
31      - ti,bq27510g1
32      - ti,bq27510g2
33      - ti,bq27510g3
34      - ti,bq27520g1
35      - ti,bq27520g2
36      - ti,bq27520g3
37      - ti,bq27520g4
38      - ti,bq27521
39      - ti,bq27530
40      - ti,bq27531
41      - ti,bq27541
42      - ti,bq27542
43      - ti,bq27546
44      - ti,bq27742
45      - ti,bq27545
46      - ti,bq27411
47      - ti,bq27421
48      - ti,bq27425
49      - ti,bq27426
50      - ti,bq27441
51      - ti,bq27621
52      - ti,bq27z561
53      - ti,bq28z610
54      - ti,bq34z100
55      - ti,bq78z100
56
57  reg:
58    maxItems: 1
59    description: integer, I2C address of the fuel gauge.
60
61  monitored-battery:
62    description: |
63       The fuel gauge uses the following battery properties:
64       - energy-full-design-microwatt-hours
65       - charge-full-design-microamp-hours
66       - voltage-min-design-microvolt
67       Both or neither of the *-full-design-*-hours properties must be set.
68
69  power-supplies: true
70
71required:
72  - compatible
73  - reg
74additionalProperties: false
75
76examples:
77  - |
78    bat: battery {
79      compatible = "simple-battery";
80      voltage-min-design-microvolt = <3200000>;
81      energy-full-design-microwatt-hours = <5290000>;
82      charge-full-design-microamp-hours = <1430000>;
83    };
84
85    i2c {
86      #address-cells = <1>;
87      #size-cells = <0>;
88
89      bq27510g3: fuel-gauge@55 {
90        compatible = "ti,bq27510g3";
91        reg = <0x55>;
92        monitored-battery = <&bat>;
93      };
94    };
95