xref: /linux/Documentation/devicetree/bindings/power/supply/lego,ev3-battery.yaml (revision c55b44c9386f3ee1b08752638559f19deaf6040d) 
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: "http://devicetree.org/schemas/power/supply/lego,ev3-battery.yaml#"
5$schema: "http://devicetree.org/meta-schemas/core.yaml#"
6
7title: LEGO MINDSTORMS EV3 Battery
8
9maintainers:
10  - David Lechner <david@lechnology.com>
11  - Sebastian Reichel <sre@kernel.org>
12
13description: |
14  LEGO MINDSTORMS EV3 has some built-in capability for monitoring the battery.
15  It uses 6 AA batteries or a special Li-ion rechargeable battery pack that is
16  detected by a key switch in the battery compartment.
17
18allOf:
19  - $ref: power-supply.yaml#
20
21properties:
22  compatible:
23    const: lego,ev3-battery
24
25  io-channels:
26    items:
27      - description: ADC channel for battery voltage
28      - description: ADC channel for battery current
29
30  io-channel-names:
31    items:
32      - const: voltage
33      - const: current
34
35  rechargeable-gpios:
36    maxItems: 1
37    description: Rechargeable battery indication gpio
38
39required:
40  - compatible
41  - io-channels
42  - io-channel-names
43  - rechargeable-gpios
44
45additionalProperties: false
46
47examples:
48  - |
49    #include <dt-bindings/gpio/gpio.h>
50    battery {
51      compatible = "lego,ev3-battery";
52      io-channels = <&adc 4>, <&adc 3>;
53      io-channel-names = "voltage", "current";
54      rechargeable-gpios = <&gpio 136 GPIO_ACTIVE_LOW>;
55    };
56