| Message ID | 20200926173529.25238-1-contact@artur-rojek.eu (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
| Series | [v3,1/2] dt-bindings: power: Convert ingenic,battery.txt to YAML | expand |
On Sat, 26 Sep 2020 19:35:28 +0200, Artur Rojek wrote: > 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> > --- > > Changes: > v2: move introduction of new compatibles into a separate patch > > v3: - drop description of `io-channels` property and set its maxItems, > - remove redundant quotes in `io-channel-names` property, > - drop `items` for `monitored-battery` property > > .../bindings/power/supply/ingenic,battery.txt | 31 ----------- > .../power/supply/ingenic,battery.yaml | 55 +++++++++++++++++++ > 2 files changed, 55 insertions(+), 31 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.txt > create mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml > Reviewed-by: Rob Herring <robh@kernel.org>
Hi, On Sat, Sep 26, 2020 at 07:35:28PM +0200, Artur Rojek wrote: > 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> > --- Thanks, queued (both patches). -- Sebastian > > Changes: > v2: move introduction of new compatibles into a separate patch > > v3: - drop description of `io-channels` property and set its maxItems, > - remove redundant quotes in `io-channel-names` property, > - drop `items` for `monitored-battery` property > > .../bindings/power/supply/ingenic,battery.txt | 31 ----------- > .../power/supply/ingenic,battery.yaml | 55 +++++++++++++++++++ > 2 files changed, 55 insertions(+), 31 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.txt > create mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml > > diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt b/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt > deleted file mode 100644 > index 66430bf73815..000000000000 > --- a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt > +++ /dev/null > @@ -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>; > -}; > diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml > new file mode 100644 > index 000000000000..658ef92a5b82 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml > @@ -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.txt, 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>; > + }; > -- > 2.28.0 >
diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt b/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt deleted file mode 100644 index 66430bf73815..000000000000 --- a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt +++ /dev/null @@ -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>; -}; diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml new file mode 100644 index 000000000000..658ef92a5b82 --- /dev/null +++ b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml @@ -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.txt, 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>; + };
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> --- Changes: v2: move introduction of new compatibles into a separate patch v3: - drop description of `io-channels` property and set its maxItems, - remove redundant quotes in `io-channel-names` property, - drop `items` for `monitored-battery` property .../bindings/power/supply/ingenic,battery.txt | 31 ----------- .../power/supply/ingenic,battery.yaml | 55 +++++++++++++++++++ 2 files changed, 55 insertions(+), 31 deletions(-) delete mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.txt create mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml