dt-bindings: mfd: rk808: Convert bindings to yaml

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +22 -0

new file mode 100644
index 000000000000..1b928b94fbfd
@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RK805 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD
+  that includes multiple switchable regulators.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk805
+
+  reg:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +25 -0

new file mode 100644
index 000000000000..f5908fa01a61
@@ -0,0 +1,257 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RK808 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD
+  that includes regulators, an RTC, and a power button.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk808
+
+  reg:
+    maxItems: 1
+
+  interrupts:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +71 -0

+    maxItems: 2
+
+  rockchip,system-power-controller:
+    type: boolean
+    description:
+      Telling whether or not this PMIC is controlling the system power.
+
+  wakeup-source:
+    type: boolean
+    description:
+      Device can be used as a wakeup source.
+
+  vcc1-supply:
+    description:
+      The input supply for DCDC_REG1.
+
+  vcc2-supply:
+    description:
+      The input supply for DCDC_REG2.
+
+  vcc3-supply:
+    description:
+      The input supply for DCDC_REG3.
+
+  vcc4-supply:
+    description:
+      The input supply for DCDC_REG4.
+
+  vcc6-supply:
+    description:
+      The input supply for LDO_REG1 and LDO_REG2.
+
+  vcc7-supply:
+    description:
+      The input supply for LDO_REG3 and LDO_REG7.
+
+  vcc8-supply:
+    description:
+      The input supply for SWITCH_REG1.
+
+  vcc9-supply:
+    description:
+      The input supply for LDO_REG4 and LDO_REG5.
+
+  vcc10-supply:
+    description:
+      The input supply for LDO_REG6.
+
+  vcc11-supply:
+    description:
+      The input supply for LDO_REG8.
+
+  vcc12-supply:
+    description:
+      The input supply for SWITCH_REG2.
+
+  vddio-supply:
+    description:
+      The input supply for digital IO.
+
+  dvs-gpios:
+    description: |
+      buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for
+      2 host gpio's used for dvs. The format of the gpio specifier
+      depends in the gpio controller. If DVS GPIOs aren't present,
+      voltage changes will happen very quickly with no slow ramp time.
+    maxItems: 2
+
+  regulators:
+    type: object
+    patternProperties:

On 2022-02-15 21:15, Chris Morgan wrote:
[...]

Quoted 33 lines

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +27 -0

new file mode 100644
index 000000000000..1b928b94fbfd
@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fschemas%2Fmfd%2Frockchip%2Crk805.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=C32SCbOML%2B29SpV3XPn6dfHnncMQpQtlNjeJmr46%2Ft0%3D&reserved=0
+$schema: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Z6bCBf7CzFrLyMwJY2FyGQn4LKP7X0U5qcVAJlIi0Ms%3D&reserved=0
+
+title: RK805 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD
+  that includes multiple switchable regulators.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk805
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml line 32

Quoted 5 lines

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +5 -0

+  '#clock-cells':
+    const: 1
+
+  clock-output-names:
+    maxItems: 2

I think this should be 1, since RK805 only has a single CLK32K output - ditto for RK817.

[...]

Quoted 38 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +32 -0

new file mode 100644
index 000000000000..f5908fa01a61
@@ -0,0 +1,257 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fschemas%2Fmfd%2Frockchip%2Crk808.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=JFsfLXHDw0y7KI4eAqx8wiOZGeq16Bq1LefNRhkidRo%3D&reserved=0
+$schema: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Z6bCBf7CzFrLyMwJY2FyGQn4LKP7X0U5qcVAJlIi0Ms%3D&reserved=0
+
+title: RK808 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD
+  that includes regulators, an RTC, and a power button.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk808
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  '#clock-cells':
+    description:
+      See <dt-bindings/clock/rockchip,rk808.h> for clock IDs.
+    const: 1
+

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 35

Quoted 3 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +3 -0

+  clock-output-names:
+    description:
+      From common clock binding to override the default output clock name.

minItems should be consistent across RK808/818/819 - when two clocks exist, either it's legitimate to rename only the first one, or it isn't. There shouldn't be an arbitrary difference just because of what existing DTs happen to use.

Quoted 72 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +71 -0

+    maxItems: 2
+
+  rockchip,system-power-controller:
+    type: boolean
+    description:
+      Telling whether or not this PMIC is controlling the system power.
+
+  wakeup-source:
+    type: boolean
+    description:
+      Device can be used as a wakeup source.
+
+  vcc1-supply:
+    description:
+      The input supply for DCDC_REG1.
+
+  vcc2-supply:
+    description:
+      The input supply for DCDC_REG2.
+
+  vcc3-supply:
+    description:
+      The input supply for DCDC_REG3.
+
+  vcc4-supply:
+    description:
+      The input supply for DCDC_REG4.
+
+  vcc6-supply:
+    description:
+      The input supply for LDO_REG1 and LDO_REG2.
+
+  vcc7-supply:
+    description:
+      The input supply for LDO_REG3 and LDO_REG7.
+
+  vcc8-supply:
+    description:
+      The input supply for SWITCH_REG1.
+
+  vcc9-supply:
+    description:
+      The input supply for LDO_REG4 and LDO_REG5.
+
+  vcc10-supply:
+    description:
+      The input supply for LDO_REG6.
+
+  vcc11-supply:
+    description:
+      The input supply for LDO_REG8.
+
+  vcc12-supply:
+    description:
+      The input supply for SWITCH_REG2.
+
+  vddio-supply:
+    description:
+      The input supply for digital IO.
+
+  dvs-gpios:
+    description: |
+      buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for
+      2 host gpio's used for dvs. The format of the gpio specifier
+      depends in the gpio controller. If DVS GPIOs aren't present,
+      voltage changes will happen very quickly with no slow ramp time.
+    maxItems: 2
+
+  regulators:
+    type: object
+    patternProperties:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 116

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +10 -0

+      "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$":
+        type: object
+        $ref: ../regulator/regulator.yaml#
+    unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"

Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that.

It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely.

Cheers,
Robin.

On 2022-02-15 21:15, Chris Morgan wrote:
[...]

Quoted 33 lines

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +27 -0

new file mode 100644
index 000000000000..1b928b94fbfd
@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RK805 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD
+  that includes multiple switchable regulators.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk805
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml line 32

Quoted 5 lines

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +5 -0

+  '#clock-cells':
+    const: 1
+
+  clock-output-names:
+    maxItems: 2

I think this should be 1, since RK805 only has a single CLK32K output - ditto for RK817.

[...]

Quoted 31 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +25 -0

new file mode 100644
index 000000000000..f5908fa01a61
@@ -0,0 +1,257 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RK808 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD
+  that includes regulators, an RTC, and a power button.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk808
+
+  reg:
+    maxItems: 1
+
+  interrupts:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 35

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +10 -0

+    maxItems: 1
+
+  '#clock-cells':
+    description:
+      See <dt-bindings/clock/rockchip,rk808.h> for clock IDs.
+    const: 1
+
+  clock-output-names:
+    description:
+      From common clock binding to override the default output clock name.

minItems should be consistent across RK808/818/819 - when two clocks exist, either it's legitimate to rename only the first one, or it isn't. There shouldn't be an arbitrary difference just because of what existing DTs happen to use.

Quoted 71 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +71 -0

+    maxItems: 2
+
+  rockchip,system-power-controller:
+    type: boolean
+    description:
+      Telling whether or not this PMIC is controlling the system power.
+
+  wakeup-source:
+    type: boolean
+    description:
+      Device can be used as a wakeup source.
+
+  vcc1-supply:
+    description:
+      The input supply for DCDC_REG1.
+
+  vcc2-supply:
+    description:
+      The input supply for DCDC_REG2.
+
+  vcc3-supply:
+    description:
+      The input supply for DCDC_REG3.
+
+  vcc4-supply:
+    description:
+      The input supply for DCDC_REG4.
+
+  vcc6-supply:
+    description:
+      The input supply for LDO_REG1 and LDO_REG2.
+
+  vcc7-supply:
+    description:
+      The input supply for LDO_REG3 and LDO_REG7.
+
+  vcc8-supply:
+    description:
+      The input supply for SWITCH_REG1.
+
+  vcc9-supply:
+    description:
+      The input supply for LDO_REG4 and LDO_REG5.
+
+  vcc10-supply:
+    description:
+      The input supply for LDO_REG6.
+
+  vcc11-supply:
+    description:
+      The input supply for LDO_REG8.
+
+  vcc12-supply:
+    description:
+      The input supply for SWITCH_REG2.
+
+  vddio-supply:
+    description:
+      The input supply for digital IO.
+
+  dvs-gpios:
+    description: |
+      buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for
+      2 host gpio's used for dvs. The format of the gpio specifier
+      depends in the gpio controller. If DVS GPIOs aren't present,
+      voltage changes will happen very quickly with no slow ramp time.
+    maxItems: 2
+
+  regulators:
+    type: object
+    patternProperties:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 116

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +10 -0

+      "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$":
+        type: object
+        $ref: ../regulator/regulator.yaml#
+    unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"

Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that.

It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely.

Cheers,
Robin.

On 2022-02-15 21:15, Chris Morgan wrote:
[...]

Quoted 28 lines

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +22 -0

new file mode 100644
index 000000000000..1b928b94fbfd
@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RK805 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD
+  that includes multiple switchable regulators.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk805
+
+  reg:

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml line 32

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file +10 -0

+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  '#clock-cells':
+    const: 1
+
+  clock-output-names:
+    maxItems: 2

I think this should be 1, since RK805 only has a single CLK32K output - ditto for RK817.

[...]

Quoted 31 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +25 -0

new file mode 100644
index 000000000000..f5908fa01a61
@@ -0,0 +1,257 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RK808 Power Management Integrated Circuit
+
+maintainers:
+  - Chris Zhong <[email protected]>
+  - Zhang Qing <[email protected]>
+
+description: |
+  Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD
+  that includes regulators, an RTC, and a power button.
+
+properties:
+  compatible:
+    enum:
+      - rockchip,rk808
+
+  reg:
+    maxItems: 1
+
+  interrupts:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 35

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +10 -0

+    maxItems: 1
+
+  '#clock-cells':
+    description:
+      See <dt-bindings/clock/rockchip,rk808.h> for clock IDs.
+    const: 1
+
+  clock-output-names:
+    description:
+      From common clock binding to override the default output clock name.

minItems should be consistent across RK808/818/819 - when two clocks exist, either it's legitimate to rename only the first one, or it isn't. There shouldn't be an arbitrary difference just because of what existing DTs happen to use.

Quoted 71 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +71 -0

+    maxItems: 2
+
+  rockchip,system-power-controller:
+    type: boolean
+    description:
+      Telling whether or not this PMIC is controlling the system power.
+
+  wakeup-source:
+    type: boolean
+    description:
+      Device can be used as a wakeup source.
+
+  vcc1-supply:
+    description:
+      The input supply for DCDC_REG1.
+
+  vcc2-supply:
+    description:
+      The input supply for DCDC_REG2.
+
+  vcc3-supply:
+    description:
+      The input supply for DCDC_REG3.
+
+  vcc4-supply:
+    description:
+      The input supply for DCDC_REG4.
+
+  vcc6-supply:
+    description:
+      The input supply for LDO_REG1 and LDO_REG2.
+
+  vcc7-supply:
+    description:
+      The input supply for LDO_REG3 and LDO_REG7.
+
+  vcc8-supply:
+    description:
+      The input supply for SWITCH_REG1.
+
+  vcc9-supply:
+    description:
+      The input supply for LDO_REG4 and LDO_REG5.
+
+  vcc10-supply:
+    description:
+      The input supply for LDO_REG6.
+
+  vcc11-supply:
+    description:
+      The input supply for LDO_REG8.
+
+  vcc12-supply:
+    description:
+      The input supply for SWITCH_REG2.
+
+  vddio-supply:
+    description:
+      The input supply for digital IO.
+
+  dvs-gpios:
+    description: |
+      buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for
+      2 host gpio's used for dvs. The format of the gpio specifier
+      depends in the gpio controller. If DVS GPIOs aren't present,
+      voltage changes will happen very quickly with no slow ramp time.
+    maxItems: 2
+
+  regulators:
+    type: object
+    patternProperties:

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 116

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +10 -0

+      "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$":
+        type: object
+        $ref: ../regulator/regulator.yaml#
+    unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"

Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that.

It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely.

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 116

Quoted 5 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +5 -0

+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"

Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that.

Quoted 6 lines

It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely.

Fair enough. However, if the consumer could be in an overlay, then I think we want it to be required and not make the overlay add the property. Properties just appearing within nodes at runtime is likely not well supported in OSs.

On 2022-02-24 19:30, Rob Herring wrote:
[...]

Quoted 17 lines

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 116

Quoted 5 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +5 -0

+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"

Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that.

Quoted 6 lines

It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely.

Quoted 4 lines

Fair enough. However, if the consumer could be in an overlay, then I think we want it to be required and not make the overlay add the property. Properties just appearing within nodes at runtime is likely not well supported in OSs.

Ah yes, that's an angle I hadn't considered, and I reckon it clearly answers my original question in the affirmative :)

Indeed these clock outputs are often hooked up to SDIO WiFi modules, and I'm sure I *have* seen boards which put such modules on pluggable daughterboards in a manner which could reasonably use overlays, so in principle it does seem like a realistic concern. I'm happy with setting a general principle that if a clock output is exposed on a physical pin, then at the DTS level we can't know for sure that it *won't* be consumed (even if the original board design didn't intend it), therefore the device is always a potential clock controller and "#clock-cells" should be required. In that case, the consistency argument would fall the other way, to enforcing it for RK805 as well.

Cheers,
Robin.

Quoted 27 lines · Robin Murphy

On 2022-02-24 19:30, Rob Herring wrote:
[...]

Quoted 17 lines

Quoted 10 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml line 116

Quoted 5 lines

Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file +5 -0

+required:
+  - compatible
+  - reg
+  - interrupts
+  - "#clock-cells"

Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that.

Quoted 6 lines

It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely.

Quoted 4 lines

Fair enough. However, if the consumer could be in an overlay, then I think we want it to be required and not make the overlay add the property. Properties just appearing within nodes at runtime is likely not well supported in OSs.

Ah yes, that's an angle I hadn't considered, and I reckon it clearly answers my original question in the affirmative :)

Quoted 10 lines

Indeed these clock outputs are often hooked up to SDIO WiFi modules, and I'm sure I *have* seen boards which put such modules on pluggable daughterboards in a manner which could reasonably use overlays, so in principle it does seem like a realistic concern. I'm happy with setting a general principle that if a clock output is exposed on a physical pin, then at the DTS level we can't know for sure that it *won't* be consumed (even if the original board design didn't intend it), therefore the device is always a potential clock controller and "#clock-cells" should be required. In that case, the consistency argument would fall the other way, to enforcing it for RK805 as well.

Okay. So the existing point of contentions are:

1) "#clock-cells" should always be required. This causes a few boards to fail to check properly, but I assume that can be easily remedied by adding the "#clock-cells" to the devicetree.

2) The rk805, rk809, and rk817 only have a single clock-out. To workaround a quirk in the driver some boards have 2 clock-output-names. To fix the devicetree to accurately describe the hardware, the driver will have to be updated along with many boards with these PMICs.

3) The rk808 has no vcc13 or vcc14 input, but at least 4 boards preport to use such a voltage input anyway.

Not a point of contention, but I need to add examples for the rk805, rk809, and rk818 which I will just pull from a popular devicetree.

I can solve the clock-cells issue by simply adding that to the correct devicetrees (though I have no devices to test those on I assume they should be benign changes?). Is that acceptable to fix that?

For the single clock out, I can't really fix it without updating the driver and modifying a large number of devicetrees. Should I just make it 1 min/2 max across all these YAML files and note for the rk805, rk809, and rk817 that there is only really one clock output?

What should I do for #3? I've checked the schematic for the Pinebook Pro (which is one of the 4 boards affected) and can confirm that VCC13 and VCC14 on these boards is literally just VCC1 and VCC2, respectively. I can't seem to find the schematics for the other 3 boards affected though, but I assume it's something similar.

Let me know, I'd like to get this finalized so I can get the battery code for the rk817 charger pushed too.

Thank you very much for all your help.