mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-27 19:29:37 +00:00
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: Artur Rojek <contact@artur-rojek.eu> Reviewed-by: Rob Herring <robh@kernel.org> Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
This commit is contained in:
parent
d8483f3148
commit
8d58ca2754
2 changed files with 55 additions and 31 deletions
|
@ -1,31 +0,0 @@
|
||||||
* 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>;
|
|
||||||
};
|
|
|
@ -0,0 +1,55 @@
|
||||||
|
# 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>;
|
||||||
|
};
|
Loading…
Reference in a new issue