Convert the binding to DT schema format.
The sub-functions of this MFD device do not have their own compatible
string and are thus described directly in the MFD binding document
after being converted to YAML.
Signed-off-by: Sebastian Reichel <[email protected]>
---
Changes since PATCHv2:
* https://lore.kernel.org/all/[email protected]/
* Add unevaluatedProperties: false to regulators subnode (Krzysztof Kozlowski)
* Use "pmic" for nodename (Krzysztof Kozlowski)
Changes since PATCHv1:
* https://lore.kernel.org/all/[email protected]/
* Update License to GPL OR BSD
* Add missing type references pointed out by Rob
---
.../leds/backlight/max8925-backlight.txt | 10 --
.../devicetree/bindings/mfd/max8925.txt | 64 --------
.../bindings/mfd/maxim,max8925.yaml | 145 ++++++++++++++++++
.../bindings/power/supply/max8925_battery.txt | 18 ---
4 files changed, 145 insertions(+), 92 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt
delete mode 100644 Documentation/devicetree/bindings/mfd/max8925.txt
create mode 100644 Documentation/devicetree/bindings/mfd/maxim,max8925.yaml
delete mode 100644 Documentation/devicetree/bindings/power/supply/max8925_battery.txt
diff --git a/Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt b/Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt
deleted file mode 100644
index b4cffdaa4137..000000000000
--- a/Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-88pm860x-backlight bindings
-
-Optional properties:
- - maxim,max8925-dual-string: whether support dual string
-
-Example:
-
- backlights {
- maxim,max8925-dual-string = <0>;
- };
diff --git a/Documentation/devicetree/bindings/mfd/max8925.txt b/Documentation/devicetree/bindings/mfd/max8925.txt
deleted file mode 100644
index 4f0dc6638e5e..000000000000
--- a/Documentation/devicetree/bindings/mfd/max8925.txt
+++ /dev/null
@@ -1,64 +0,0 @@
-* Maxim max8925 Power Management IC
-
-Required parent device properties:
-- compatible : "maxim,max8925"
-- reg : the I2C slave address for the max8925 chip
-- interrupts : IRQ line for the max8925 chip
-- interrupt-controller: describes the max8925 as an interrupt
- controller (has its own domain)
-- #interrupt-cells : should be 1.
- - The cell is the max8925 local IRQ number
-
-Optional parent device properties:
-- maxim,tsc-irq: there are 2 IRQ lines for max8925, one is indicated in
- interrupts property, the other is indicated here.
-
-max8925 consists of a large and varied group of sub-devices:
-
-Device Supply Names Description
------- ------------ -----------
-max8925-onkey : : On key
-max8925-rtc : : RTC
-max8925-regulator : : Regulators
-max8925-backlight : : Backlight
-max8925-touch : : Touchscreen
-max8925-power : : Charger
-
-Example:
-
- pmic: max8925@3c {
- compatible = "maxim,max8925";
- reg = <0x3c>;
- interrupts = <1>;
- interrupt-parent = <&intcmux4>;
- interrupt-controller;
- #interrupt-cells = <1>;
- maxim,tsc-irq = <0>;
-
- regulators {
- SDV1 {
- regulator-min-microvolt = <637500>;
- regulator-max-microvolt = <1425000>;
- regulator-boot-on;
- regulator-always-on;
- };
-
- LDO1 {
- regulator-min-microvolt = <750000>;
- regulator-max-microvolt = <3900000>;
- regulator-boot-on;
- regulator-always-on;
- };
-
- };
- backlight {
- maxim,max8925-dual-string = <0>;
- };
- charger {
- batt-detect = <0>;
- topoff-threshold = <1>;
- fast-charge = <7>;
- no-temp-support = <0>;
- no-insert-detect = <0>;
- };
- };
diff --git a/Documentation/devicetree/bindings/mfd/maxim,max8925.yaml b/Documentation/devicetree/bindings/mfd/maxim,max8925.yaml
new file mode 100644
index 000000000000..bcb76aae5f5a
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/maxim,max8925.yaml
@@ -0,0 +1,145 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/maxim,max8925.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MAX8925 PMIC from Maxim Integrated.
+
+maintainers:
+ - Lee Jones <[email protected]>
+
+properties:
+ compatible:
+ const: maxim,max8925
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ interrupt-controller: true
+
+ "#interrupt-cells":
+ const: 1
+ description:
+ The cell is the IRQ number
+
+ maxim,tsc-irq:
+ description: second interrupt from max8925
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ regulators:
+ type: object
+
+ patternProperties:
+ "^SDV[1-3]$|^LDO[1-9]$|^LDO1[0-9]$|^LDO20$":
+ description: regulator configuration for SDV1-3 and LDO1-20
+ $ref: /schemas/regulator/regulator.yaml
+ unevaluatedProperties: false
+
+ additionalProperties: false
+
+ backlight:
+ type: object
+ properties:
+ maxim,max8925-dual-string:
+ description: set to 1 to support dual string
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+ default: 0
+
+ additionalProperties: false
+
+ charger:
+ type: object
+ properties:
+ batt-detect:
+ description: set to 1 if battery detection via ID pin is supported
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+ default: 0
+
+ topoff-threshold:
+ description: charging current in topoff mode, configures bits 5-6 in CHG_CNTL1
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 0
+ maximum: 3
+ default: 0
+
+ fast-charge:
+ description: set charging current in fast mode, configures bits 0-3 in CHG_CNTL1
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 0
+ maximum: 7
+ default: 0
+
+ no-temp-support:
+ description: set to 1 if temperature sensing is not supported
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+ default: 0
+
+ no-insert-detect:
+ description: set to 1 if AC detection is not supported
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+ default: 0
+
+ additionalProperties: false
+
+required:
+ - compatible
+ - reg
+ - interrupts
+ - interrupt-controller
+ - "#interrupt-cells"
+ - regulators
+
+additionalProperties: false
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ pmic@3c {
+ compatible = "maxim,max8925";
+ reg = <0x3c>;
+ interrupts = <1>;
+ interrupt-parent = <&intcmux4>;
+ interrupt-controller;
+ #interrupt-cells = <1>;
+ maxim,tsc-irq = <0>;
+
+ regulators {
+ SDV1 {
+ regulator-min-microvolt = <637500>;
+ regulator-max-microvolt = <1425000>;
+ regulator-boot-on;
+ regulator-always-on;
+ };
+
+ LDO1 {
+ regulator-min-microvolt = <750000>;
+ regulator-max-microvolt = <3900000>;
+ regulator-boot-on;
+ regulator-always-on;
+ };
+ };
+
+ backlight {
+ maxim,max8925-dual-string = <0>;
+ };
+
+ charger {
+ batt-detect = <0>;
+ topoff-threshold = <1>;
+ fast-charge = <7>;
+ no-temp-support = <0>;
+ no-insert-detect = <0>;
+ };
+ };
+ };
diff --git a/Documentation/devicetree/bindings/power/supply/max8925_battery.txt b/Documentation/devicetree/bindings/power/supply/max8925_battery.txt
deleted file mode 100644
index d7e3e0c0f71d..000000000000
--- a/Documentation/devicetree/bindings/power/supply/max8925_battery.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-max8925-battery bindings
-~~~~~~~~~~~~~~~~
-
-Optional properties :
- - batt-detect: whether support battery detect
- - topoff-threshold: set charging current in topoff mode
- - fast-charge: set charging current in fast mode
- - no-temp-support: whether support temperature protection detect
- - no-insert-detect: whether support insert detect
-
-Example:
- charger {
- batt-detect = <0>;
- topoff-threshold = <1>;
- fast-charge = <7>;
- no-temp-support = <0>;
- no-insert-detect = <0>;
- };
--
2.40.1
On Sat, 30 Sep 2023 22:27:43 +0200, Sebastian Reichel wrote:
> Convert the binding to DT schema format.
>
> The sub-functions of this MFD device do not have their own compatible
> string and are thus described directly in the MFD binding document
> after being converted to YAML.
>
> Signed-off-by: Sebastian Reichel <[email protected]>
> ---
> Changes since PATCHv2:
> * https://lore.kernel.org/all/[email protected]/
> * Add unevaluatedProperties: false to regulators subnode (Krzysztof Kozlowski)
> * Use "pmic" for nodename (Krzysztof Kozlowski)
>
> Changes since PATCHv1:
> * https://lore.kernel.org/all/[email protected]/
> * Update License to GPL OR BSD
> * Add missing type references pointed out by Rob
> ---
> .../leds/backlight/max8925-backlight.txt | 10 --
> .../devicetree/bindings/mfd/max8925.txt | 64 --------
> .../bindings/mfd/maxim,max8925.yaml | 145 ++++++++++++++++++
> .../bindings/power/supply/max8925_battery.txt | 18 ---
> 4 files changed, 145 insertions(+), 92 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt
> delete mode 100644 Documentation/devicetree/bindings/mfd/max8925.txt
> create mode 100644 Documentation/devicetree/bindings/mfd/maxim,max8925.yaml
> delete mode 100644 Documentation/devicetree/bindings/power/supply/max8925_battery.txt
>
Reviewed-by: Rob Herring <[email protected]>
Hi Lee,
On Mon, Oct 02, 2023 at 02:26:17PM -0500, Rob Herring wrote:
> On Sat, 30 Sep 2023 22:27:43 +0200, Sebastian Reichel wrote:
> > Convert the binding to DT schema format.
> >
> > The sub-functions of this MFD device do not have their own compatible
> > string and are thus described directly in the MFD binding document
> > after being converted to YAML.
> >
> > Signed-off-by: Sebastian Reichel <[email protected]>
> > ---
> > Changes since PATCHv2:
> > * https://lore.kernel.org/all/[email protected]/
> > * Add unevaluatedProperties: false to regulators subnode (Krzysztof Kozlowski)
> > * Use "pmic" for nodename (Krzysztof Kozlowski)
> >
> > Changes since PATCHv1:
> > * https://lore.kernel.org/all/[email protected]/
> > * Update License to GPL OR BSD
> > * Add missing type references pointed out by Rob
> > ---
> > .../leds/backlight/max8925-backlight.txt | 10 --
> > .../devicetree/bindings/mfd/max8925.txt | 64 --------
> > .../bindings/mfd/maxim,max8925.yaml | 145 ++++++++++++++++++
> > .../bindings/power/supply/max8925_battery.txt | 18 ---
> > 4 files changed, 145 insertions(+), 92 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt
> > delete mode 100644 Documentation/devicetree/bindings/mfd/max8925.txt
> > create mode 100644 Documentation/devicetree/bindings/mfd/maxim,max8925.yaml
> > delete mode 100644 Documentation/devicetree/bindings/power/supply/max8925_battery.txt
>
> Reviewed-by: Rob Herring <[email protected]>
I expect this will go through your tree and I don't need an
immutable branch, since all further fixes on the binding would
go into your tree anyways.
Also please note, that I put you in as maintainer, since the
original people working on max8925 long vanished and you are the
maintainer of MFD (and backlight). Please tell me if you have a
better suggestion.
Greetings,
-- Sebastian
On Sat, 21 Oct 2023, Sebastian Reichel wrote:
> Hi Lee,
>
> On Mon, Oct 02, 2023 at 02:26:17PM -0500, Rob Herring wrote:
> > On Sat, 30 Sep 2023 22:27:43 +0200, Sebastian Reichel wrote:
> > > Convert the binding to DT schema format.
> > >
> > > The sub-functions of this MFD device do not have their own compatible
> > > string and are thus described directly in the MFD binding document
> > > after being converted to YAML.
> > >
> > > Signed-off-by: Sebastian Reichel <[email protected]>
> > > ---
> > > Changes since PATCHv2:
> > > * https://lore.kernel.org/all/[email protected]/
> > > * Add unevaluatedProperties: false to regulators subnode (Krzysztof Kozlowski)
> > > * Use "pmic" for nodename (Krzysztof Kozlowski)
> > >
> > > Changes since PATCHv1:
> > > * https://lore.kernel.org/all/[email protected]/
> > > * Update License to GPL OR BSD
> > > * Add missing type references pointed out by Rob
> > > ---
> > > .../leds/backlight/max8925-backlight.txt | 10 --
> > > .../devicetree/bindings/mfd/max8925.txt | 64 --------
> > > .../bindings/mfd/maxim,max8925.yaml | 145 ++++++++++++++++++
> > > .../bindings/power/supply/max8925_battery.txt | 18 ---
> > > 4 files changed, 145 insertions(+), 92 deletions(-)
> > > delete mode 100644 Documentation/devicetree/bindings/leds/backlight/max8925-backlight.txt
> > > delete mode 100644 Documentation/devicetree/bindings/mfd/max8925.txt
> > > create mode 100644 Documentation/devicetree/bindings/mfd/maxim,max8925.yaml
> > > delete mode 100644 Documentation/devicetree/bindings/power/supply/max8925_battery.txt
> >
> > Reviewed-by: Rob Herring <[email protected]>
>
> I expect this will go through your tree and I don't need an
> immutable branch, since all further fixes on the binding would
> go into your tree anyways.
>
> Also please note, that I put you in as maintainer, since the
> original people working on max8925 long vanished and you are the
> maintainer of MFD (and backlight). Please tell me if you have a
> better suggestion.
That's not my email address. :)
--
Lee Jones [李琼斯]