Commit 8d58ca27 authored by Artur Rojek's avatar Artur Rojek Committed by Sebastian Reichel
Browse files

dt-bindings: power: Convert ingenic,battery.txt to YAML 



Convert the textual documentation of Device Tree bindings for the
Ingenic JZ47xx SoCs battery to YAML.

Signed-off-by: default avatarArtur Rojek <contact@artur-rojek.eu>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarSebastian Reichel <sebastian.reichel@collabora.com>
parent d8483f31

Documentation/devicetree/bindings/power/supply/ingenic,battery.txt

deleted100644 → 0
+0 −31
Original line number Diff line number Diff line 
* Ingenic JZ47xx battery bindings



Required properties:



- compatible: Must be "ingenic,jz4740-battery".

- io-channels: phandle and IIO specifier pair to the IIO device.

  Format described in iio-bindings.txt.

- monitored-battery: phandle to a "simple-battery" compatible node.



The "monitored-battery" property must be a phandle to a node using the format

described in battery.txt, with the following properties being required:



- voltage-min-design-microvolt: Drained battery voltage.

- voltage-max-design-microvolt: Fully charged battery voltage.



Example:



#include <dt-bindings/iio/adc/ingenic,adc.h>



simple_battery: battery {

	compatible = "simple-battery";

	voltage-min-design-microvolt = <3600000>;

	voltage-max-design-microvolt = <4200000>;

};



ingenic_battery {

	compatible = "ingenic,jz4740-battery";

	io-channels = <&adc INGENIC_ADC_BATTERY>;

	io-channel-names = "battery";

	monitored-battery = <&simple_battery>;

};

Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml

0 → 100644
+55 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

# Copyright 2019-2020 Artur Rojek

%YAML 1.2

---

$id: "http://devicetree.org/schemas/power/supply/ingenic,battery.yaml#"

$schema: "http://devicetree.org/meta-schemas/core.yaml#"



title: Ingenic JZ47xx battery bindings



maintainers:

  - Artur Rojek <contact@artur-rojek.eu>



properties:

  compatible:

    const: ingenic,jz4740-battery



  io-channels:

    maxItems: 1



  io-channel-names:

    const: battery



  monitored-battery:

    description: >

      phandle to a "simple-battery" compatible node.



      This property must be a phandle to a node using the format described

      in battery.yaml, with the following properties being required:

      - voltage-min-design-microvolt: drained battery voltage,

      - voltage-max-design-microvolt: fully charged battery voltage.



required:

  - compatible

  - io-channels

  - io-channel-names

  - monitored-battery



additionalProperties: false



examples:

  - |

    #include <dt-bindings/iio/adc/ingenic,adc.h>



    simple_battery: battery {

            compatible = "simple-battery";

            voltage-min-design-microvolt = <3600000>;

            voltage-max-design-microvolt = <4200000>;

    };



    ingenic-battery {

            compatible = "ingenic,jz4740-battery";

            io-channels = <&adc INGENIC_ADC_BATTERY>;

            io-channel-names = "battery";

            monitored-battery = <&simple_battery>;

    };