bq27xxx.yaml

  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
 19properties:
 20  compatible:
 21    enum:
 22      - ti,bq27200
 23      - ti,bq27210
 24      - ti,bq27500 # deprecated, use revision specific property below
 25      - ti,bq27510 # deprecated, use revision specific property below
 26      - ti,bq27520 # deprecated, use revision specific property below
 27      - ti,bq27500-1
 28      - ti,bq27510g1
 29      - ti,bq27510g2
 30      - ti,bq27510g3
 31      - ti,bq27520g1
 32      - ti,bq27520g2
 33      - ti,bq27520g3
 34      - ti,bq27520g4
 35      - ti,bq27521
 36      - ti,bq27530
 37      - ti,bq27531
 38      - ti,bq27541
 39      - ti,bq27542
 40      - ti,bq27546
 41      - ti,bq27742
 42      - ti,bq27545
 43      - ti,bq27411
 44      - ti,bq27421
 45      - ti,bq27425
 46      - ti,bq27426
 47      - ti,bq27441
 48      - ti,bq27621
 49      - ti,bq27z561
 50      - ti,bq28z610
 51      - ti,bq34z100
 52      - ti,bq78z100
 53
 54  reg:
 55    maxItems: 1
 56    description: integer, I2C address of the fuel gauge.
 57
 58  interrupts:
 59    maxItems: 1
 60    description: the SOC_INT or GPOUT pin
 61
 62  monitored-battery:
 63    description: |
 64       The fuel gauge uses the following battery properties:
 65       - energy-full-design-microwatt-hours
 66       - charge-full-design-microamp-hours
 67       - voltage-min-design-microvolt
 68       Both or neither of the *-full-design-*-hours properties must be set.
 69
 70  power-supplies: true
 71
 72allOf:
 73  - $ref: power-supply.yaml#
 74  - if:
 75      properties:
 76        compatible:
 77          contains:
 78            enum:
 79              - ti,bq27200
 80              - ti,bq27210
 81              - ti,bq27500 # deprecated, use revision specific property below
 82              - ti,bq27510 # deprecated, use revision specific property below
 83              - ti,bq27520 # deprecated, use revision specific property below
 84              - ti,bq27500-1
 85              - ti,bq27510g1
 86              - ti,bq27510g2
 87              - ti,bq27521
 88              - ti,bq27541
 89              - ti,bq27542
 90              - ti,bq27546
 91              - ti,bq27742
 92              - ti,bq27545
 93              - ti,bq27411
 94              - ti,bq27z561
 95              - ti,bq28z610
 96              - ti,bq34z100
 97              - ti,bq78z100
 98    then:
 99      properties:
100        interrupts: false
101
102required:
103  - compatible
104  - reg
105additionalProperties: false
106
107examples:
108  - |
109    bat: battery {
110      compatible = "simple-battery";
111      voltage-min-design-microvolt = <3200000>;
112      energy-full-design-microwatt-hours = <5290000>;
113      charge-full-design-microamp-hours = <1430000>;
114    };
115
116    i2c {
117      #address-cells = <1>;
118      #size-cells = <0>;
119
120      bq27510g3: fuel-gauge@55 {
121        compatible = "ti,bq27510g3";
122        reg = <0x55>;
123        monitored-battery = <&bat>;
124      };
125    };