xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2*4882a593Smuzhiyun# Copyright 2019-2020 Artur Rojek
3*4882a593Smuzhiyun%YAML 1.2
4*4882a593Smuzhiyun---
5*4882a593Smuzhiyun$id: "http://devicetree.org/schemas/power/supply/ingenic,battery.yaml#"
6*4882a593Smuzhiyun$schema: "http://devicetree.org/meta-schemas/core.yaml#"
7*4882a593Smuzhiyun
8*4882a593Smuzhiyuntitle: Ingenic JZ47xx battery bindings
9*4882a593Smuzhiyun
10*4882a593Smuzhiyunmaintainers:
11*4882a593Smuzhiyun  - Artur Rojek <contact@artur-rojek.eu>
12*4882a593Smuzhiyun
13*4882a593Smuzhiyunproperties:
14*4882a593Smuzhiyun  compatible:
15*4882a593Smuzhiyun    oneOf:
16*4882a593Smuzhiyun      - const: ingenic,jz4740-battery
17*4882a593Smuzhiyun      - items:
18*4882a593Smuzhiyun          - enum:
19*4882a593Smuzhiyun              - ingenic,jz4725b-battery
20*4882a593Smuzhiyun              - ingenic,jz4770-battery
21*4882a593Smuzhiyun          - const: ingenic,jz4740-battery
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun  io-channels:
24*4882a593Smuzhiyun    maxItems: 1
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun  io-channel-names:
27*4882a593Smuzhiyun    const: battery
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun  monitored-battery:
30*4882a593Smuzhiyun    description: >
31*4882a593Smuzhiyun      phandle to a "simple-battery" compatible node.
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun      This property must be a phandle to a node using the format described
34*4882a593Smuzhiyun      in battery.yaml, with the following properties being required:
35*4882a593Smuzhiyun      - voltage-min-design-microvolt: drained battery voltage,
36*4882a593Smuzhiyun      - voltage-max-design-microvolt: fully charged battery voltage.
37*4882a593Smuzhiyun
38*4882a593Smuzhiyunrequired:
39*4882a593Smuzhiyun  - compatible
40*4882a593Smuzhiyun  - io-channels
41*4882a593Smuzhiyun  - io-channel-names
42*4882a593Smuzhiyun  - monitored-battery
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunadditionalProperties: false
45*4882a593Smuzhiyun
46*4882a593Smuzhiyunexamples:
47*4882a593Smuzhiyun  - |
48*4882a593Smuzhiyun    #include <dt-bindings/iio/adc/ingenic,adc.h>
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun    simple_battery: battery {
51*4882a593Smuzhiyun            compatible = "simple-battery";
52*4882a593Smuzhiyun            voltage-min-design-microvolt = <3600000>;
53*4882a593Smuzhiyun            voltage-max-design-microvolt = <4200000>;
54*4882a593Smuzhiyun    };
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun    ingenic-battery {
57*4882a593Smuzhiyun            compatible = "ingenic,jz4740-battery";
58*4882a593Smuzhiyun            io-channels = <&adc INGENIC_ADC_BATTERY>;
59*4882a593Smuzhiyun            io-channel-names = "battery";
60*4882a593Smuzhiyun            monitored-battery = <&simple_battery>;
61*4882a593Smuzhiyun    };
62