2019-10-18 09:56:47

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 0/6] dt-bindings: max77650: convert the device-tree bindings to yaml

From: Bartosz Golaszewski <[email protected]>

This series converts all DT binding documents for MAX77650 PMIC to YAML.

v1 -> v2:
- use upper case for abbreviations in commit messages

v2 -> v3:
- pull all example fragments into the binding document for the core MFD module
- fix all dt_binding_check errors
- add references to submodules to the main binding document
- drop the type for gpio-line-names
- drop the description for the interrupts property
- completely delete the previous txt files

Bartosz Golaszewski (6):
dt-bindings: mfd: max77650: convert the binding document to yaml
dt-bindings: input: max77650: convert the binding document to yaml
dt-bindings: regulator: max77650: convert the binding document to yaml
dt-bindings: power: max77650: convert the binding document to yaml
dt-bindings: leds: max77650: convert the binding document to yaml
MAINTAINERS: update the list of maintained files for max77650

.../bindings/input/max77650-onkey.txt | 26 ---
.../bindings/input/max77650-onkey.yaml | 35 ++++
.../bindings/leds/leds-max77650.txt | 57 -------
.../bindings/leds/leds-max77650.yaml | 58 +++++++
.../devicetree/bindings/mfd/max77650.txt | 46 ------
.../devicetree/bindings/mfd/max77650.yaml | 151 ++++++++++++++++++
.../power/supply/max77650-charger.txt | 28 ----
.../power/supply/max77650-charger.yaml | 34 ++++
.../bindings/regulator/max77650-regulator.txt | 41 -----
.../regulator/max77650-regulator.yaml | 31 ++++
MAINTAINERS | 4 +-
11 files changed, 311 insertions(+), 200 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/input/max77650-onkey.txt
create mode 100644 Documentation/devicetree/bindings/input/max77650-onkey.yaml
delete mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.txt
create mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.yaml
delete mode 100644 Documentation/devicetree/bindings/mfd/max77650.txt
create mode 100644 Documentation/devicetree/bindings/mfd/max77650.yaml
delete mode 100644 Documentation/devicetree/bindings/power/supply/max77650-charger.txt
create mode 100644 Documentation/devicetree/bindings/power/supply/max77650-charger.yaml
delete mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.txt
create mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.yaml

--
2.23.0


2019-10-18 09:57:40

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 1/6] dt-bindings: mfd: max77650: convert the binding document to yaml

From: Bartosz Golaszewski <[email protected]>

Convert the binding document for MAX77650 core MFD module to YAML.

Signed-off-by: Bartosz Golaszewski <[email protected]>
---
.../devicetree/bindings/mfd/max77650.txt | 46 ------
.../devicetree/bindings/mfd/max77650.yaml | 151 ++++++++++++++++++
2 files changed, 151 insertions(+), 46 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/mfd/max77650.txt
create mode 100644 Documentation/devicetree/bindings/mfd/max77650.yaml

diff --git a/Documentation/devicetree/bindings/mfd/max77650.txt b/Documentation/devicetree/bindings/mfd/max77650.txt
deleted file mode 100644
index b529d8d19335..000000000000
--- a/Documentation/devicetree/bindings/mfd/max77650.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-MAX77650 ultra low-power PMIC from Maxim Integrated.
-
-Required properties:
--------------------
-- compatible: Must be "maxim,max77650"
-- reg: I2C device address.
-- interrupts: The interrupt on the parent the controller is
- connected to.
-- interrupt-controller: Marks the device node as an interrupt controller.
-- #interrupt-cells: Must be <2>.
-
-- gpio-controller: Marks the device node as a gpio controller.
-- #gpio-cells: Must be <2>. The first cell is the pin number and
- the second cell is used to specify the gpio active
- state.
-
-Optional properties:
---------------------
-gpio-line-names: Single string containing the name of the GPIO line.
-
-The GPIO-controller module is represented as part of the top-level PMIC
-node. The device exposes a single GPIO line.
-
-For device-tree bindings of other sub-modules (regulator, power supply,
-LEDs and onkey) refer to the binding documents under the respective
-sub-system directories.
-
-For more details on GPIO bindings, please refer to the generic GPIO DT
-binding document <devicetree/bindings/gpio/gpio.txt>.
-
-Example:
---------
-
- pmic@48 {
- compatible = "maxim,max77650";
- reg = <0x48>;
-
- interrupt-controller;
- interrupt-parent = <&gpio2>;
- #interrupt-cells = <2>;
- interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
-
- gpio-controller;
- #gpio-cells = <2>;
- gpio-line-names = "max77650-charger";
- };
diff --git a/Documentation/devicetree/bindings/mfd/max77650.yaml b/Documentation/devicetree/bindings/mfd/max77650.yaml
new file mode 100644
index 000000000000..66a447e1cf56
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/max77650.yaml
@@ -0,0 +1,151 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/max77650.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MAX77650 ultra low-power PMIC from Maxim Integrated.
+
+maintainers:
+ - Bartosz Golaszewski <[email protected]>
+
+description: |
+ This document describes the DT properties of the core MFD controller.
+
+ The GPIO-controller module is represented as part of the top-level PMIC
+ node. The device exposes a single GPIO line.
+
+ For device-tree bindings of other sub-modules (regulator, power supply,
+ LEDs and onkey) refer to the binding documents under the respective
+ sub-system directories.
+
+ For more details on GPIO bindings, please refer to the generic GPIO DT
+ binding document <devicetree/bindings/gpio/gpio.txt>.
+
+properties:
+ compatible:
+ const: maxim,max77650
+
+ reg:
+ description:
+ I2C device address.
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ interrupt-controller: true
+
+ "#interrupt-cells":
+ const: 2
+ description:
+ The first cell is the IRQ number, the second cell is the trigger type.
+
+ gpio-controller: true
+
+ "#gpio-cells":
+ const: 2
+ description:
+ The first cell is the pin number and the second cell is used to specify
+ the gpio active state.
+
+ gpio-line-names:
+ maxItems: 1
+ description:
+ Single string containing the name of the GPIO line.
+
+ regulators:
+ $ref: ../regulator/max77650-regulator.yaml
+
+ charger:
+ $ref: ../power/supply/max77650-charger.yaml
+
+ leds:
+ $ref: ../leds/leds-max77650.yaml
+
+ onkey:
+ $ref: ../input/max77650-onkey.yaml
+
+required:
+ - compatible
+ - reg
+ - interrupts
+ - interrupt-controller
+ - "#interrupt-cells"
+ - gpio-controller
+ - "#gpio-cells"
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+ #include <dt-bindings/input/linux-event-codes.h>
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ pmic@48 {
+ compatible = "maxim,max77650";
+ reg = <0x48>;
+
+ interrupt-controller;
+ interrupt-parent = <&gpio2>;
+ #interrupt-cells = <2>;
+ interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
+
+ gpio-controller;
+ #gpio-cells = <2>;
+ gpio-line-names = "max77650-charger";
+
+ regulators {
+ compatible = "maxim,max77650-regulator";
+
+ max77650_ldo: regulator@0 {
+ regulator-compatible = "ldo";
+ regulator-name = "max77650-ldo";
+ regulator-min-microvolt = <1350000>;
+ regulator-max-microvolt = <2937500>;
+ };
+
+ max77650_sbb0: regulator@1 {
+ regulator-compatible = "sbb0";
+ regulator-name = "max77650-sbb0";
+ regulator-min-microvolt = <800000>;
+ regulator-max-microvolt = <1587500>;
+ };
+ };
+
+ charger {
+ compatible = "maxim,max77650-charger";
+ input-voltage-min-microvolt = <4200000>;
+ input-current-limit-microamp = <285000>;
+ };
+
+ leds {
+ compatible = "maxim,max77650-led";
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ led@0 {
+ reg = <0>;
+ label = "blue:usr0";
+ };
+
+ led@1 {
+ reg = <1>;
+ label = "red:usr1";
+ linux,default-trigger = "heartbeat";
+ };
+
+ led@2 {
+ reg = <2>;
+ label = "green:usr2";
+ };
+ };
+
+ onkey {
+ compatible = "maxim,max77650-onkey";
+ linux,code = <KEY_END>;
+ maxim,onkey-slide;
+ };
+ };
+ };
--
2.23.0

2019-10-18 09:58:27

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 5/6] dt-bindings: leds: max77650: convert the binding document to yaml

From: Bartosz Golaszewski <[email protected]>

Convert the binding document for MAX77650 LED module to YAML.

Signed-off-by: Bartosz Golaszewski <[email protected]>
---
.../bindings/leds/leds-max77650.txt | 57 ------------------
.../bindings/leds/leds-max77650.yaml | 58 +++++++++++++++++++
2 files changed, 58 insertions(+), 57 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.txt
create mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.yaml

diff --git a/Documentation/devicetree/bindings/leds/leds-max77650.txt b/Documentation/devicetree/bindings/leds/leds-max77650.txt
deleted file mode 100644
index 3a67115cc1da..000000000000
--- a/Documentation/devicetree/bindings/leds/leds-max77650.txt
+++ /dev/null
@@ -1,57 +0,0 @@
-LED driver for MAX77650 PMIC from Maxim Integrated.
-
-This module is part of the MAX77650 MFD device. For more details
-see Documentation/devicetree/bindings/mfd/max77650.txt.
-
-The LED controller is represented as a sub-node of the PMIC node on
-the device tree.
-
-This device has three current sinks.
-
-Required properties:
---------------------
-- compatible: Must be "maxim,max77650-led"
-- #address-cells: Must be <1>.
-- #size-cells: Must be <0>.
-
-Each LED is represented as a sub-node of the LED-controller node. Up to
-three sub-nodes can be defined.
-
-Required properties of the sub-node:
-------------------------------------
-
-- reg: Must be <0>, <1> or <2>.
-
-Optional properties of the sub-node:
-------------------------------------
-
-- label: See Documentation/devicetree/bindings/leds/common.txt
-- linux,default-trigger: See Documentation/devicetree/bindings/leds/common.txt
-
-For more details, please refer to the generic GPIO DT binding document
-<devicetree/bindings/gpio/gpio.txt>.
-
-Example:
---------
-
- leds {
- compatible = "maxim,max77650-led";
- #address-cells = <1>;
- #size-cells = <0>;
-
- led@0 {
- reg = <0>;
- label = "blue:usr0";
- };
-
- led@1 {
- reg = <1>;
- label = "red:usr1";
- linux,default-trigger = "heartbeat";
- };
-
- led@2 {
- reg = <2>;
- label = "green:usr2";
- };
- };
diff --git a/Documentation/devicetree/bindings/leds/leds-max77650.yaml b/Documentation/devicetree/bindings/leds/leds-max77650.yaml
new file mode 100644
index 000000000000..5a1e256185bd
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-max77650.yaml
@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-max77650.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LED driver for MAX77650 PMIC from Maxim Integrated.
+
+maintainers:
+ - Bartosz Golaszewski <[email protected]>
+
+description: |
+ This module is part of the MAX77650 MFD device. For more details
+ see Documentation/devicetree/bindings/mfd/max77650.txt.
+
+ The LED controller is represented as a sub-node of the PMIC node on
+ the device tree.
+
+ This device has three current sinks.
+
+properties:
+ compatible:
+ const: maxim,max77650-led
+
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 0
+
+patternProperties:
+ "^led@[0-2]$":
+ type: object
+ description: |
+ Properties for a single LED.
+
+ properties:
+ reg:
+ description:
+ Index of the LED.
+ maxItems: 1
+ minimum: 0
+ maximum: 2
+
+ label:
+ $ref: "/schemas/types.yaml#/definitions/string"
+ description:
+ The label of this LED.
+
+ linux,default-trigger:
+ $ref: "/schemas/types.yaml#/definitions/string"
+ description:
+ String defining the default trigger assigned to this LED.
+
+required:
+ - compatible
+ - "#address-cells"
+ - "#size-cells"
--
2.23.0

2019-10-18 09:59:42

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 6/6] MAINTAINERS: update the list of maintained files for max77650

From: Bartosz Golaszewski <[email protected]>

The DT bindings for MAX77650 MFD have now been converted to YAML.
Update the MAINTAINERS entry for this set of drivers.

Signed-off-by: Bartosz Golaszewski <[email protected]>
---
MAINTAINERS | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index a69e6db80c79..c05e6fd6aedb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9903,8 +9903,8 @@ MAXIM MAX77650 PMIC MFD DRIVER
M: Bartosz Golaszewski <[email protected]>
L: [email protected]
S: Maintained
-F: Documentation/devicetree/bindings/*/*max77650.txt
-F: Documentation/devicetree/bindings/*/max77650*.txt
+F: Documentation/devicetree/bindings/*/*max77650.yaml
+F: Documentation/devicetree/bindings/*/max77650*.yaml
F: include/linux/mfd/max77650.h
F: drivers/mfd/max77650.c
F: drivers/regulator/max77650-regulator.c
--
2.23.0

2019-10-18 10:00:13

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 4/6] dt-bindings: power: max77650: convert the binding document to yaml

From: Bartosz Golaszewski <[email protected]>

Convert the binding document for MAX77650 charger module to YAML.

Signed-off-by: Bartosz Golaszewski <[email protected]>
Acked-by: Sebastian Reichel <[email protected]>
---
.../power/supply/max77650-charger.txt | 28 ---------------
.../power/supply/max77650-charger.yaml | 34 +++++++++++++++++++
2 files changed, 34 insertions(+), 28 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/power/supply/max77650-charger.txt
create mode 100644 Documentation/devicetree/bindings/power/supply/max77650-charger.yaml

diff --git a/Documentation/devicetree/bindings/power/supply/max77650-charger.txt b/Documentation/devicetree/bindings/power/supply/max77650-charger.txt
deleted file mode 100644
index e6d0fb6ff94e..000000000000
--- a/Documentation/devicetree/bindings/power/supply/max77650-charger.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-Battery charger driver for MAX77650 PMIC from Maxim Integrated.
-
-This module is part of the MAX77650 MFD device. For more details
-see Documentation/devicetree/bindings/mfd/max77650.txt.
-
-The charger is represented as a sub-node of the PMIC node on the device tree.
-
-Required properties:
---------------------
-- compatible: Must be "maxim,max77650-charger"
-
-Optional properties:
---------------------
-- input-voltage-min-microvolt: Minimum CHGIN regulation voltage. Must be one
- of: 4000000, 4100000, 4200000, 4300000,
- 4400000, 4500000, 4600000, 4700000.
-- input-current-limit-microamp: CHGIN input current limit (in microamps). Must
- be one of: 95000, 190000, 285000, 380000,
- 475000.
-
-Example:
---------
-
- charger {
- compatible = "maxim,max77650-charger";
- input-voltage-min-microvolt = <4200000>;
- input-current-limit-microamp = <285000>;
- };
diff --git a/Documentation/devicetree/bindings/power/supply/max77650-charger.yaml b/Documentation/devicetree/bindings/power/supply/max77650-charger.yaml
new file mode 100644
index 000000000000..a48054cc87cb
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/max77650-charger.yaml
@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/supply/max77650-charger.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Battery charger driver for MAX77650 PMIC from Maxim Integrated.
+
+maintainers:
+ - Bartosz Golaszewski <[email protected]>
+
+description: |
+ This module is part of the MAX77650 MFD device. For more details
+ see Documentation/devicetree/bindings/mfd/max77650.txt.
+
+ The charger is represented as a sub-node of the PMIC node on the device tree.
+
+properties:
+ compatible:
+ const: maxim,max77650-charger
+
+ input-voltage-min-microvolt:
+ description:
+ Minimum CHGIN regulation voltage.
+ enum: [ 4000000, 4100000, 4200000, 4300000,
+ 4400000, 4500000, 4600000, 4700000 ]
+
+ input-current-limit-microamp:
+ description:
+ CHGIN input current limit (in microamps).
+ enum: [ 95000, 190000, 285000, 380000, 475000 ]
+
+required:
+ - compatible
--
2.23.0

2019-10-18 10:00:28

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 3/6] dt-bindings: regulator: max77650: convert the binding document to yaml

From: Bartosz Golaszewski <[email protected]>

Convert the binding document for MAX77650 regulator module to YAML.

Signed-off-by: Bartosz Golaszewski <[email protected]>
---
.../bindings/regulator/max77650-regulator.txt | 41 -------------------
.../regulator/max77650-regulator.yaml | 31 ++++++++++++++
2 files changed, 31 insertions(+), 41 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.txt
create mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.yaml

diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt b/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
deleted file mode 100644
index f1cbe813c30f..000000000000
--- a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-Regulator driver for MAX77650 PMIC from Maxim Integrated.
-
-This module is part of the MAX77650 MFD device. For more details
-see Documentation/devicetree/bindings/mfd/max77650.txt.
-
-The regulator controller is represented as a sub-node of the PMIC node
-on the device tree.
-
-The device has a single LDO regulator and a SIMO buck-boost regulator with
-three independent power rails.
-
-Required properties:
---------------------
-- compatible: Must be "maxim,max77650-regulator"
-
-Each rail must be instantiated under the regulators subnode of the top PMIC
-node. Up to four regulators can be defined. For standard regulator properties
-refer to Documentation/devicetree/bindings/regulator/regulator.txt.
-
-Available regulator compatible strings are: "ldo", "sbb0", "sbb1", "sbb2".
-
-Example:
---------
-
- regulators {
- compatible = "maxim,max77650-regulator";
-
- max77650_ldo: regulator@0 {
- regulator-compatible = "ldo";
- regulator-name = "max77650-ldo";
- regulator-min-microvolt = <1350000>;
- regulator-max-microvolt = <2937500>;
- };
-
- max77650_sbb0: regulator@1 {
- regulator-compatible = "sbb0";
- regulator-name = "max77650-sbb0";
- regulator-min-microvolt = <800000>;
- regulator-max-microvolt = <1587500>;
- };
- };
diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
new file mode 100644
index 000000000000..a8770742836d
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/max77650-regulator.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Regulator driver for MAX77650 PMIC from Maxim Integrated.
+
+maintainers:
+ - Bartosz Golaszewski <[email protected]>
+
+description: |
+ This module is part of the MAX77650 MFD device. For more details
+ see Documentation/devicetree/bindings/mfd/max77650.txt.
+
+ The regulator controller is represented as a sub-node of the PMIC node
+ on the device tree.
+
+ The device has a single LDO regulator and a SIMO buck-boost regulator with
+ three independent power rails.
+
+properties:
+ compatible:
+ const: maxim,max77650-regulator
+
+patternProperties:
+ "^regulator@[0-3]$":
+ $ref: "regulator.yaml#"
+
+required:
+ - compatible
--
2.23.0

2019-10-18 10:04:37

by Bartosz Golaszewski

[permalink] [raw]
Subject: [PATCH v3 2/6] dt-bindings: input: max77650: convert the binding document to yaml

From: Bartosz Golaszewski <[email protected]>

Convert the binding document for MAX77650 onkey module to YAML.

Signed-off-by: Bartosz Golaszewski <[email protected]>
---
.../bindings/input/max77650-onkey.txt | 26 --------------
.../bindings/input/max77650-onkey.yaml | 35 +++++++++++++++++++
2 files changed, 35 insertions(+), 26 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/input/max77650-onkey.txt
create mode 100644 Documentation/devicetree/bindings/input/max77650-onkey.yaml

diff --git a/Documentation/devicetree/bindings/input/max77650-onkey.txt b/Documentation/devicetree/bindings/input/max77650-onkey.txt
deleted file mode 100644
index 477dc74f452a..000000000000
--- a/Documentation/devicetree/bindings/input/max77650-onkey.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-Onkey driver for MAX77650 PMIC from Maxim Integrated.
-
-This module is part of the MAX77650 MFD device. For more details
-see Documentation/devicetree/bindings/mfd/max77650.txt.
-
-The onkey controller is represented as a sub-node of the PMIC node on
-the device tree.
-
-Required properties:
---------------------
-- compatible: Must be "maxim,max77650-onkey".
-
-Optional properties:
-- linux,code: The key-code to be reported when the key is pressed.
- Defaults to KEY_POWER.
-- maxim,onkey-slide: The system's button is a slide switch, not the default
- push button.
-
-Example:
---------
-
- onkey {
- compatible = "maxim,max77650-onkey";
- linux,code = <KEY_END>;
- maxim,onkey-slide;
- };
diff --git a/Documentation/devicetree/bindings/input/max77650-onkey.yaml b/Documentation/devicetree/bindings/input/max77650-onkey.yaml
new file mode 100644
index 000000000000..2f2e0b6ebbbd
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/max77650-onkey.yaml
@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/max77650-onkey.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Onkey driver for MAX77650 PMIC from Maxim Integrated.
+
+maintainers:
+ - Bartosz Golaszewski <[email protected]>
+
+description: |
+ This module is part of the MAX77650 MFD device. For more details
+ see Documentation/devicetree/bindings/mfd/max77650.yaml.
+
+ The onkey controller is represented as a sub-node of the PMIC node on
+ the device tree.
+
+properties:
+ compatible:
+ const: maxim,max77650-onkey
+
+ linux,code:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ The key-code to be reported when the key is pressed. Defaults
+ to KEY_POWER.
+
+ maxim,onkey-slide:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description:
+ The system's button is a slide switch, not the default push button.
+
+required:
+ - compatible
--
2.23.0

2019-10-18 22:13:59

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v3 1/6] dt-bindings: mfd: max77650: convert the binding document to yaml

On Thu, Oct 17, 2019 at 09:12:29AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <[email protected]>
>
> Convert the binding document for MAX77650 core MFD module to YAML.
>
> Signed-off-by: Bartosz Golaszewski <[email protected]>
> ---
> .../devicetree/bindings/mfd/max77650.txt | 46 ------
> .../devicetree/bindings/mfd/max77650.yaml | 151 ++++++++++++++++++
> 2 files changed, 151 insertions(+), 46 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/mfd/max77650.txt
> create mode 100644 Documentation/devicetree/bindings/mfd/max77650.yaml
>
> diff --git a/Documentation/devicetree/bindings/mfd/max77650.txt b/Documentation/devicetree/bindings/mfd/max77650.txt
> deleted file mode 100644
> index b529d8d19335..000000000000
> --- a/Documentation/devicetree/bindings/mfd/max77650.txt
> +++ /dev/null
> @@ -1,46 +0,0 @@
> -MAX77650 ultra low-power PMIC from Maxim Integrated.
> -
> -Required properties:
> --------------------
> -- compatible: Must be "maxim,max77650"
> -- reg: I2C device address.
> -- interrupts: The interrupt on the parent the controller is
> - connected to.
> -- interrupt-controller: Marks the device node as an interrupt controller.
> -- #interrupt-cells: Must be <2>.
> -
> -- gpio-controller: Marks the device node as a gpio controller.
> -- #gpio-cells: Must be <2>. The first cell is the pin number and
> - the second cell is used to specify the gpio active
> - state.
> -
> -Optional properties:
> ---------------------
> -gpio-line-names: Single string containing the name of the GPIO line.
> -
> -The GPIO-controller module is represented as part of the top-level PMIC
> -node. The device exposes a single GPIO line.
> -
> -For device-tree bindings of other sub-modules (regulator, power supply,
> -LEDs and onkey) refer to the binding documents under the respective
> -sub-system directories.
> -
> -For more details on GPIO bindings, please refer to the generic GPIO DT
> -binding document <devicetree/bindings/gpio/gpio.txt>.
> -
> -Example:
> ---------
> -
> - pmic@48 {
> - compatible = "maxim,max77650";
> - reg = <0x48>;
> -
> - interrupt-controller;
> - interrupt-parent = <&gpio2>;
> - #interrupt-cells = <2>;
> - interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
> -
> - gpio-controller;
> - #gpio-cells = <2>;
> - gpio-line-names = "max77650-charger";
> - };
> diff --git a/Documentation/devicetree/bindings/mfd/max77650.yaml b/Documentation/devicetree/bindings/mfd/max77650.yaml
> new file mode 100644
> index 000000000000..66a447e1cf56
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/max77650.yaml
> @@ -0,0 +1,151 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/max77650.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MAX77650 ultra low-power PMIC from Maxim Integrated.
> +
> +maintainers:
> + - Bartosz Golaszewski <[email protected]>
> +
> +description: |
> + This document describes the DT properties of the core MFD controller.

So does every file in this directory.

Describe what this chip is.

> +
> + The GPIO-controller module is represented as part of the top-level PMIC
> + node. The device exposes a single GPIO line.
> +
> + For device-tree bindings of other sub-modules (regulator, power supply,
> + LEDs and onkey) refer to the binding documents under the respective
> + sub-system directories.
> +
> + For more details on GPIO bindings, please refer to the generic GPIO DT
> + binding document <devicetree/bindings/gpio/gpio.txt>.

Also fairly useless and another reference to maintain...

> +
> +properties:
> + compatible:
> + const: maxim,max77650
> +
> + reg:
> + description:
> + I2C device address.
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + interrupt-controller: true
> +
> + "#interrupt-cells":
> + const: 2
> + description:
> + The first cell is the IRQ number, the second cell is the trigger type.
> +
> + gpio-controller: true
> +
> + "#gpio-cells":
> + const: 2
> + description:
> + The first cell is the pin number and the second cell is used to specify
> + the gpio active state.
> +
> + gpio-line-names:
> + maxItems: 1
> + description:
> + Single string containing the name of the GPIO line.
> +
> + regulators:
> + $ref: ../regulator/max77650-regulator.yaml

Not bisectable... This patch needs to come last.

> +
> + charger:
> + $ref: ../power/supply/max77650-charger.yaml
> +
> + leds:
> + $ref: ../leds/leds-max77650.yaml
> +
> + onkey:
> + $ref: ../input/max77650-onkey.yaml
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - interrupt-controller
> + - "#interrupt-cells"
> + - gpio-controller
> + - "#gpio-cells"

None of the child nodes are required?

> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/input/linux-event-codes.h>
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + pmic@48 {
> + compatible = "maxim,max77650";
> + reg = <0x48>;
> +
> + interrupt-controller;
> + interrupt-parent = <&gpio2>;
> + #interrupt-cells = <2>;
> + interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
> +
> + gpio-controller;
> + #gpio-cells = <2>;
> + gpio-line-names = "max77650-charger";
> +
> + regulators {
> + compatible = "maxim,max77650-regulator";
> +
> + max77650_ldo: regulator@0 {
> + regulator-compatible = "ldo";
> + regulator-name = "max77650-ldo";
> + regulator-min-microvolt = <1350000>;
> + regulator-max-microvolt = <2937500>;
> + };
> +
> + max77650_sbb0: regulator@1 {
> + regulator-compatible = "sbb0";
> + regulator-name = "max77650-sbb0";
> + regulator-min-microvolt = <800000>;
> + regulator-max-microvolt = <1587500>;
> + };
> + };
> +
> + charger {
> + compatible = "maxim,max77650-charger";
> + input-voltage-min-microvolt = <4200000>;
> + input-current-limit-microamp = <285000>;
> + };
> +
> + leds {
> + compatible = "maxim,max77650-led";
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + led@0 {
> + reg = <0>;
> + label = "blue:usr0";
> + };
> +
> + led@1 {
> + reg = <1>;
> + label = "red:usr1";
> + linux,default-trigger = "heartbeat";
> + };
> +
> + led@2 {
> + reg = <2>;
> + label = "green:usr2";
> + };
> + };
> +
> + onkey {
> + compatible = "maxim,max77650-onkey";
> + linux,code = <KEY_END>;
> + maxim,onkey-slide;
> + };
> + };
> + };
> --
> 2.23.0
>

2019-10-18 22:14:11

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v3 2/6] dt-bindings: input: max77650: convert the binding document to yaml

On Thu, 17 Oct 2019 09:12:30 +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <[email protected]>
>
> Convert the binding document for MAX77650 onkey module to YAML.
>
> Signed-off-by: Bartosz Golaszewski <[email protected]>
> ---
> .../bindings/input/max77650-onkey.txt | 26 --------------
> .../bindings/input/max77650-onkey.yaml | 35 +++++++++++++++++++
> 2 files changed, 35 insertions(+), 26 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/input/max77650-onkey.txt
> create mode 100644 Documentation/devicetree/bindings/input/max77650-onkey.yaml
>

Reviewed-by: Rob Herring <[email protected]>

2019-10-18 22:14:42

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v3 3/6] dt-bindings: regulator: max77650: convert the binding document to yaml

On Thu, Oct 17, 2019 at 09:12:31AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <[email protected]>
>
> Convert the binding document for MAX77650 regulator module to YAML.
>
> Signed-off-by: Bartosz Golaszewski <[email protected]>
> ---
> .../bindings/regulator/max77650-regulator.txt | 41 -------------------
> .../regulator/max77650-regulator.yaml | 31 ++++++++++++++
> 2 files changed, 31 insertions(+), 41 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> create mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
>
> diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt b/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> deleted file mode 100644
> index f1cbe813c30f..000000000000
> --- a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> +++ /dev/null
> @@ -1,41 +0,0 @@
> -Regulator driver for MAX77650 PMIC from Maxim Integrated.
> -
> -This module is part of the MAX77650 MFD device. For more details
> -see Documentation/devicetree/bindings/mfd/max77650.txt.
> -
> -The regulator controller is represented as a sub-node of the PMIC node
> -on the device tree.
> -
> -The device has a single LDO regulator and a SIMO buck-boost regulator with
> -three independent power rails.
> -
> -Required properties:
> ---------------------
> -- compatible: Must be "maxim,max77650-regulator"
> -
> -Each rail must be instantiated under the regulators subnode of the top PMIC
> -node. Up to four regulators can be defined. For standard regulator properties
> -refer to Documentation/devicetree/bindings/regulator/regulator.txt.
> -
> -Available regulator compatible strings are: "ldo", "sbb0", "sbb1", "sbb2".
> -
> -Example:
> ---------
> -
> - regulators {
> - compatible = "maxim,max77650-regulator";
> -
> - max77650_ldo: regulator@0 {
> - regulator-compatible = "ldo";
> - regulator-name = "max77650-ldo";
> - regulator-min-microvolt = <1350000>;
> - regulator-max-microvolt = <2937500>;
> - };
> -
> - max77650_sbb0: regulator@1 {
> - regulator-compatible = "sbb0";
> - regulator-name = "max77650-sbb0";
> - regulator-min-microvolt = <800000>;
> - regulator-max-microvolt = <1587500>;
> - };
> - };
> diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> new file mode 100644
> index 000000000000..a8770742836d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> @@ -0,0 +1,31 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/max77650-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Regulator driver for MAX77650 PMIC from Maxim Integrated.
> +
> +maintainers:
> + - Bartosz Golaszewski <[email protected]>
> +
> +description: |
> + This module is part of the MAX77650 MFD device. For more details
> + see Documentation/devicetree/bindings/mfd/max77650.txt.

.yaml?

> +
> + The regulator controller is represented as a sub-node of the PMIC node
> + on the device tree.
> +
> + The device has a single LDO regulator and a SIMO buck-boost regulator with
> + three independent power rails.
> +
> +properties:
> + compatible:
> + const: maxim,max77650-regulator
> +
> +patternProperties:
> + "^regulator@[0-3]$":
> + $ref: "regulator.yaml#"
> +
> +required:
> + - compatible
> --
> 2.23.0
>

2019-10-18 22:17:02

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v3 5/6] dt-bindings: leds: max77650: convert the binding document to yaml

On Thu, Oct 17, 2019 at 09:12:33AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <[email protected]>
>
> Convert the binding document for MAX77650 LED module to YAML.
>
> Signed-off-by: Bartosz Golaszewski <[email protected]>
> ---
> .../bindings/leds/leds-max77650.txt | 57 ------------------
> .../bindings/leds/leds-max77650.yaml | 58 +++++++++++++++++++
> 2 files changed, 58 insertions(+), 57 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.txt
> create mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.yaml
>
> diff --git a/Documentation/devicetree/bindings/leds/leds-max77650.txt b/Documentation/devicetree/bindings/leds/leds-max77650.txt
> deleted file mode 100644
> index 3a67115cc1da..000000000000
> --- a/Documentation/devicetree/bindings/leds/leds-max77650.txt
> +++ /dev/null
> @@ -1,57 +0,0 @@
> -LED driver for MAX77650 PMIC from Maxim Integrated.
> -
> -This module is part of the MAX77650 MFD device. For more details
> -see Documentation/devicetree/bindings/mfd/max77650.txt.
> -
> -The LED controller is represented as a sub-node of the PMIC node on
> -the device tree.
> -
> -This device has three current sinks.
> -
> -Required properties:
> ---------------------
> -- compatible: Must be "maxim,max77650-led"
> -- #address-cells: Must be <1>.
> -- #size-cells: Must be <0>.
> -
> -Each LED is represented as a sub-node of the LED-controller node. Up to
> -three sub-nodes can be defined.
> -
> -Required properties of the sub-node:
> -------------------------------------
> -
> -- reg: Must be <0>, <1> or <2>.
> -
> -Optional properties of the sub-node:
> -------------------------------------
> -
> -- label: See Documentation/devicetree/bindings/leds/common.txt
> -- linux,default-trigger: See Documentation/devicetree/bindings/leds/common.txt
> -
> -For more details, please refer to the generic GPIO DT binding document
> -<devicetree/bindings/gpio/gpio.txt>.
> -
> -Example:
> ---------
> -
> - leds {
> - compatible = "maxim,max77650-led";
> - #address-cells = <1>;
> - #size-cells = <0>;
> -
> - led@0 {
> - reg = <0>;
> - label = "blue:usr0";
> - };
> -
> - led@1 {
> - reg = <1>;
> - label = "red:usr1";
> - linux,default-trigger = "heartbeat";
> - };
> -
> - led@2 {
> - reg = <2>;
> - label = "green:usr2";
> - };
> - };
> diff --git a/Documentation/devicetree/bindings/leds/leds-max77650.yaml b/Documentation/devicetree/bindings/leds/leds-max77650.yaml
> new file mode 100644
> index 000000000000..5a1e256185bd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-max77650.yaml
> @@ -0,0 +1,58 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/leds-max77650.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LED driver for MAX77650 PMIC from Maxim Integrated.
> +
> +maintainers:
> + - Bartosz Golaszewski <[email protected]>
> +
> +description: |
> + This module is part of the MAX77650 MFD device. For more details
> + see Documentation/devicetree/bindings/mfd/max77650.txt.
> +
> + The LED controller is represented as a sub-node of the PMIC node on
> + the device tree.
> +
> + This device has three current sinks.
> +
> +properties:
> + compatible:
> + const: maxim,max77650-led
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> +patternProperties:
> + "^led@[0-2]$":
> + type: object
> + description: |
> + Properties for a single LED.
> +
> + properties:
> + reg:
> + description:
> + Index of the LED.
> + maxItems: 1
> + minimum: 0
> + maximum: 2

Mixing array and scalar constraints. Just need (dropping maxItems):

items:
- minimum: 0
maximum: 2

> +
> + label:
> + $ref: "/schemas/types.yaml#/definitions/string"

Globally defined as a string already.

> + description:
> + The label of this LED.
> +
> + linux,default-trigger:
> + $ref: "/schemas/types.yaml#/definitions/string"

Assume this gets a common binding.

So just 'true' is sufficient for both of these.

> + description:
> + String defining the default trigger assigned to this LED.
> +
> +required:
> + - compatible
> + - "#address-cells"
> + - "#size-cells"
> --
> 2.23.0
>

2019-10-18 23:33:52

by Bartosz Golaszewski

[permalink] [raw]
Subject: Re: [PATCH v3 1/6] dt-bindings: mfd: max77650: convert the binding document to yaml

czw., 17 paź 2019 o 20:31 Rob Herring <[email protected]> napisał(a):
>
> On Thu, Oct 17, 2019 at 09:12:29AM +0200, Bartosz Golaszewski wrote:
> > From: Bartosz Golaszewski <[email protected]>
> >
> > Convert the binding document for MAX77650 core MFD module to YAML.
> >
> > Signed-off-by: Bartosz Golaszewski <[email protected]>
> > ---
> > .../devicetree/bindings/mfd/max77650.txt | 46 ------
> > .../devicetree/bindings/mfd/max77650.yaml | 151 ++++++++++++++++++
> > 2 files changed, 151 insertions(+), 46 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/mfd/max77650.txt
> > create mode 100644 Documentation/devicetree/bindings/mfd/max77650.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/mfd/max77650.txt b/Documentation/devicetree/bindings/mfd/max77650.txt
> > deleted file mode 100644
> > index b529d8d19335..000000000000
> > --- a/Documentation/devicetree/bindings/mfd/max77650.txt
> > +++ /dev/null
> > @@ -1,46 +0,0 @@
> > -MAX77650 ultra low-power PMIC from Maxim Integrated.
> > -
> > -Required properties:
> > --------------------
> > -- compatible: Must be "maxim,max77650"
> > -- reg: I2C device address.
> > -- interrupts: The interrupt on the parent the controller is
> > - connected to.
> > -- interrupt-controller: Marks the device node as an interrupt controller.
> > -- #interrupt-cells: Must be <2>.
> > -
> > -- gpio-controller: Marks the device node as a gpio controller.
> > -- #gpio-cells: Must be <2>. The first cell is the pin number and
> > - the second cell is used to specify the gpio active
> > - state.
> > -
> > -Optional properties:
> > ---------------------
> > -gpio-line-names: Single string containing the name of the GPIO line.
> > -
> > -The GPIO-controller module is represented as part of the top-level PMIC
> > -node. The device exposes a single GPIO line.
> > -
> > -For device-tree bindings of other sub-modules (regulator, power supply,
> > -LEDs and onkey) refer to the binding documents under the respective
> > -sub-system directories.
> > -
> > -For more details on GPIO bindings, please refer to the generic GPIO DT
> > -binding document <devicetree/bindings/gpio/gpio.txt>.
> > -
> > -Example:
> > ---------
> > -
> > - pmic@48 {
> > - compatible = "maxim,max77650";
> > - reg = <0x48>;
> > -
> > - interrupt-controller;
> > - interrupt-parent = <&gpio2>;
> > - #interrupt-cells = <2>;
> > - interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
> > -
> > - gpio-controller;
> > - #gpio-cells = <2>;
> > - gpio-line-names = "max77650-charger";
> > - };
> > diff --git a/Documentation/devicetree/bindings/mfd/max77650.yaml b/Documentation/devicetree/bindings/mfd/max77650.yaml
> > new file mode 100644
> > index 000000000000..66a447e1cf56
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mfd/max77650.yaml
> > @@ -0,0 +1,151 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/mfd/max77650.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: MAX77650 ultra low-power PMIC from Maxim Integrated.
> > +
> > +maintainers:
> > + - Bartosz Golaszewski <[email protected]>
> > +
> > +description: |
> > + This document describes the DT properties of the core MFD controller.
>
> So does every file in this directory.
>
> Describe what this chip is.
>
> > +
> > + The GPIO-controller module is represented as part of the top-level PMIC
> > + node. The device exposes a single GPIO line.
> > +
> > + For device-tree bindings of other sub-modules (regulator, power supply,
> > + LEDs and onkey) refer to the binding documents under the respective
> > + sub-system directories.
> > +
> > + For more details on GPIO bindings, please refer to the generic GPIO DT
> > + binding document <devicetree/bindings/gpio/gpio.txt>.
>
> Also fairly useless and another reference to maintain...
>
> > +
> > +properties:
> > + compatible:
> > + const: maxim,max77650
> > +
> > + reg:
> > + description:
> > + I2C device address.
> > + maxItems: 1
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > + interrupt-controller: true
> > +
> > + "#interrupt-cells":
> > + const: 2
> > + description:
> > + The first cell is the IRQ number, the second cell is the trigger type.
> > +
> > + gpio-controller: true
> > +
> > + "#gpio-cells":
> > + const: 2
> > + description:
> > + The first cell is the pin number and the second cell is used to specify
> > + the gpio active state.
> > +
> > + gpio-line-names:
> > + maxItems: 1
> > + description:
> > + Single string containing the name of the GPIO line.
> > +
> > + regulators:
> > + $ref: ../regulator/max77650-regulator.yaml
>
> Not bisectable... This patch needs to come last.
>
> > +
> > + charger:
> > + $ref: ../power/supply/max77650-charger.yaml
> > +
> > + leds:
> > + $ref: ../leds/leds-max77650.yaml
> > +
> > + onkey:
> > + $ref: ../input/max77650-onkey.yaml
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - interrupts
> > + - interrupt-controller
> > + - "#interrupt-cells"
> > + - gpio-controller
> > + - "#gpio-cells"
>
> None of the child nodes are required?
>

Technically no, and now when I think about it, neither are the
following two properties really:

- gpio-controller
- "#gpio-cells"

You can define an empty device, it's just going to be useless. For
practical purposes you can use any combination of modules, so I
wouldn't make any of them required.

Bart

> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/interrupt-controller/irq.h>
> > + #include <dt-bindings/input/linux-event-codes.h>
> > + i2c {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + pmic@48 {
> > + compatible = "maxim,max77650";
> > + reg = <0x48>;
> > +
> > + interrupt-controller;
> > + interrupt-parent = <&gpio2>;
> > + #interrupt-cells = <2>;
> > + interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
> > +
> > + gpio-controller;
> > + #gpio-cells = <2>;
> > + gpio-line-names = "max77650-charger";
> > +
> > + regulators {
> > + compatible = "maxim,max77650-regulator";
> > +
> > + max77650_ldo: regulator@0 {
> > + regulator-compatible = "ldo";
> > + regulator-name = "max77650-ldo";
> > + regulator-min-microvolt = <1350000>;
> > + regulator-max-microvolt = <2937500>;
> > + };
> > +
> > + max77650_sbb0: regulator@1 {
> > + regulator-compatible = "sbb0";
> > + regulator-name = "max77650-sbb0";
> > + regulator-min-microvolt = <800000>;
> > + regulator-max-microvolt = <1587500>;
> > + };
> > + };
> > +
> > + charger {
> > + compatible = "maxim,max77650-charger";
> > + input-voltage-min-microvolt = <4200000>;
> > + input-current-limit-microamp = <285000>;
> > + };
> > +
> > + leds {
> > + compatible = "maxim,max77650-led";
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + led@0 {
> > + reg = <0>;
> > + label = "blue:usr0";
> > + };
> > +
> > + led@1 {
> > + reg = <1>;
> > + label = "red:usr1";
> > + linux,default-trigger = "heartbeat";
> > + };
> > +
> > + led@2 {
> > + reg = <2>;
> > + label = "green:usr2";
> > + };
> > + };
> > +
> > + onkey {
> > + compatible = "maxim,max77650-onkey";
> > + linux,code = <KEY_END>;
> > + maxim,onkey-slide;
> > + };
> > + };
> > + };
> > --
> > 2.23.0
> >

2019-10-18 23:33:57

by Bartosz Golaszewski

[permalink] [raw]
Subject: Re: [PATCH v3 3/6] dt-bindings: regulator: max77650: convert the binding document to yaml

czw., 17 paź 2019 o 20:35 Rob Herring <[email protected]> napisał(a):
>
> On Thu, Oct 17, 2019 at 09:12:31AM +0200, Bartosz Golaszewski wrote:
> > From: Bartosz Golaszewski <[email protected]>
> >
> > Convert the binding document for MAX77650 regulator module to YAML.
> >
> > Signed-off-by: Bartosz Golaszewski <[email protected]>
> > ---
> > .../bindings/regulator/max77650-regulator.txt | 41 -------------------
> > .../regulator/max77650-regulator.yaml | 31 ++++++++++++++
> > 2 files changed, 31 insertions(+), 41 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > create mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt b/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > deleted file mode 100644
> > index f1cbe813c30f..000000000000
> > --- a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > +++ /dev/null
> > @@ -1,41 +0,0 @@
> > -Regulator driver for MAX77650 PMIC from Maxim Integrated.
> > -
> > -This module is part of the MAX77650 MFD device. For more details
> > -see Documentation/devicetree/bindings/mfd/max77650.txt.
> > -
> > -The regulator controller is represented as a sub-node of the PMIC node
> > -on the device tree.
> > -
> > -The device has a single LDO regulator and a SIMO buck-boost regulator with
> > -three independent power rails.
> > -
> > -Required properties:
> > ---------------------
> > -- compatible: Must be "maxim,max77650-regulator"
> > -
> > -Each rail must be instantiated under the regulators subnode of the top PMIC
> > -node. Up to four regulators can be defined. For standard regulator properties
> > -refer to Documentation/devicetree/bindings/regulator/regulator.txt.
> > -
> > -Available regulator compatible strings are: "ldo", "sbb0", "sbb1", "sbb2".
> > -
> > -Example:
> > ---------
> > -
> > - regulators {
> > - compatible = "maxim,max77650-regulator";
> > -
> > - max77650_ldo: regulator@0 {
> > - regulator-compatible = "ldo";
> > - regulator-name = "max77650-ldo";
> > - regulator-min-microvolt = <1350000>;
> > - regulator-max-microvolt = <2937500>;
> > - };
> > -
> > - max77650_sbb0: regulator@1 {
> > - regulator-compatible = "sbb0";
> > - regulator-name = "max77650-sbb0";
> > - regulator-min-microvolt = <800000>;
> > - regulator-max-microvolt = <1587500>;
> > - };
> > - };
> > diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > new file mode 100644
> > index 000000000000..a8770742836d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > @@ -0,0 +1,31 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/regulator/max77650-regulator.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Regulator driver for MAX77650 PMIC from Maxim Integrated.
> > +
> > +maintainers:
> > + - Bartosz Golaszewski <[email protected]>
> > +
> > +description: |
> > + This module is part of the MAX77650 MFD device. For more details
> > + see Documentation/devicetree/bindings/mfd/max77650.txt.
>
> .yaml?
>

Is there any better way of referencing the main document than
mentioning it in the description?

Bart

> > +
> > + The regulator controller is represented as a sub-node of the PMIC node
> > + on the device tree.
> > +
> > + The device has a single LDO regulator and a SIMO buck-boost regulator with
> > + three independent power rails.
> > +
> > +properties:
> > + compatible:
> > + const: maxim,max77650-regulator
> > +
> > +patternProperties:
> > + "^regulator@[0-3]$":
> > + $ref: "regulator.yaml#"
> > +
> > +required:
> > + - compatible
> > --
> > 2.23.0
> >

2019-10-19 09:10:23

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v3 3/6] dt-bindings: regulator: max77650: convert the binding document to yaml

On Fri, Oct 18, 2019 at 1:45 AM Bartosz Golaszewski
<[email protected]> wrote:
>
> czw., 17 paź 2019 o 20:35 Rob Herring <[email protected]> napisał(a):
> >
> > On Thu, Oct 17, 2019 at 09:12:31AM +0200, Bartosz Golaszewski wrote:
> > > From: Bartosz Golaszewski <[email protected]>
> > >
> > > Convert the binding document for MAX77650 regulator module to YAML.
> > >
> > > Signed-off-by: Bartosz Golaszewski <[email protected]>
> > > ---
> > > .../bindings/regulator/max77650-regulator.txt | 41 -------------------
> > > .../regulator/max77650-regulator.yaml | 31 ++++++++++++++
> > > 2 files changed, 31 insertions(+), 41 deletions(-)
> > > delete mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > > create mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > >
> > > diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt b/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > > deleted file mode 100644
> > > index f1cbe813c30f..000000000000
> > > --- a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > > +++ /dev/null
> > > @@ -1,41 +0,0 @@
> > > -Regulator driver for MAX77650 PMIC from Maxim Integrated.
> > > -
> > > -This module is part of the MAX77650 MFD device. For more details
> > > -see Documentation/devicetree/bindings/mfd/max77650.txt.
> > > -
> > > -The regulator controller is represented as a sub-node of the PMIC node
> > > -on the device tree.
> > > -
> > > -The device has a single LDO regulator and a SIMO buck-boost regulator with
> > > -three independent power rails.
> > > -
> > > -Required properties:
> > > ---------------------
> > > -- compatible: Must be "maxim,max77650-regulator"
> > > -
> > > -Each rail must be instantiated under the regulators subnode of the top PMIC
> > > -node. Up to four regulators can be defined. For standard regulator properties
> > > -refer to Documentation/devicetree/bindings/regulator/regulator.txt.
> > > -
> > > -Available regulator compatible strings are: "ldo", "sbb0", "sbb1", "sbb2".
> > > -
> > > -Example:
> > > ---------
> > > -
> > > - regulators {
> > > - compatible = "maxim,max77650-regulator";
> > > -
> > > - max77650_ldo: regulator@0 {
> > > - regulator-compatible = "ldo";
> > > - regulator-name = "max77650-ldo";
> > > - regulator-min-microvolt = <1350000>;
> > > - regulator-max-microvolt = <2937500>;
> > > - };
> > > -
> > > - max77650_sbb0: regulator@1 {
> > > - regulator-compatible = "sbb0";
> > > - regulator-name = "max77650-sbb0";
> > > - regulator-min-microvolt = <800000>;
> > > - regulator-max-microvolt = <1587500>;
> > > - };
> > > - };
> > > diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > > new file mode 100644
> > > index 000000000000..a8770742836d
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > > @@ -0,0 +1,31 @@
> > > +# SPDX-License-Identifier: GPL-2.0
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/regulator/max77650-regulator.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Regulator driver for MAX77650 PMIC from Maxim Integrated.
> > > +
> > > +maintainers:
> > > + - Bartosz Golaszewski <[email protected]>
> > > +
> > > +description: |
> > > + This module is part of the MAX77650 MFD device. For more details
> > > + see Documentation/devicetree/bindings/mfd/max77650.txt.
> >
> > .yaml?
> >
>
> Is there any better way of referencing the main document than
> mentioning it in the description?

No.

Rob