Krait Documentation conversion

Convert qcom,krait-cc to yaml Documentation.

Signed-off-by Christian Marangi <[email protected]>

Reviewed-by Krzysztof Kozlowski <[email protected]>

Acked-by Rob Herring <[email protected]>

---
 .../bindings/clock/qcom,krait-cc.txt          | 34 -----------
 .../bindings/clock/qcom,krait-cc.yaml         | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 34 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.txt
 create mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml

Documentation/devicetree/bindings/clock/qcom,krait-cc.txt deleted +0 -34

deleted file mode 100644
index 030ba60dab08..000000000000
@@ -1,34 +0,0 @@
-Krait Clock Controller
-
-PROPERTIES
-
-- compatible:
-       Usage: required
-       Value type: <string>
-       Definition: must be one of:
-                       "qcom,krait-cc-v1"
-                       "qcom,krait-cc-v2"
-
-- #clock-cells:
-       Usage: required
-       Value type: <u32>
-       Definition: must be 1
-
-- clocks:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: reference to the clock parents of hfpll, secondary muxes.
-
-- clock-names:
-       Usage: required
-       Value type: <stringlist>
-       Definition: must be "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb".
-
-Example:
-
-       kraitcc: clock-controller {
-               compatible = "qcom,krait-cc-v1";
-               clocks = <&hfpll0>, <&hfpll1>, <&acpu0_aux>, <&acpu1_aux>, <qsb>;
-               clock-names = "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb";
-               #clock-cells = <1>;
-       };

Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml new file +59 -1

new file mode 100644
index 000000000000..8caa5a677394
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/qcom,krait-cc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Krait Clock Controller
+
+maintainers:
+  - Christian Marangi <[email protected]>
+
+description: |
+  Qualcomm Krait Clock Controller used to correctly scale the CPU and the L2
+  rates.
+
+properties:
+  compatible:
+    enum:
+      - qcom,krait-cc-v1
+      - qcom,krait-cc-v2
+
+  clocks:
+    items:
+      - description: phandle to hfpll for CPU0 mux
+      - description: phandle to hfpll for CPU1 mux
+      - description: phandle to CPU0 aux clock
+      - description: phandle to CPU1 aux clock
+      - description: phandle to QSB fixed clk
+
+  clock-names:
+    items:
+      - const: hfpll0
+      - const: hfpll1
+      - const: acpu0_aux
+      - const: acpu1_aux
+      - const: qsb
+
+  '#clock-cells':
+    const: 1
+
+required:
+  - compatible
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-controller {
+      compatible = "qcom,krait-cc-v1";
+      clocks = <&hfpll0>, <&hfpll1>,
+               <&acpu0_aux>, <&acpu1_aux>, <&qsb>;
+      clock-names = "hfpll0", "hfpll1",
+                    "acpu0_aux", "acpu1_aux", "qsb";
+      #clock-cells = <1>;
+    };
+...
--

2.37.2

Quoted 6 lines · Christian Marangi

Convert qcom,krait-cc to yaml Documentation.

Signed-off-by Christian Marangi <[email protected]>

Reviewed-by Krzysztof Kozlowski <[email protected]>

Acked-by Rob Herring <[email protected]>

I know this has been reviewed already. I checked again my apq8064 branch and noticed that the bindings are not compatible with the apq8064. The SoC in question is a 4-core device, so this is what I had in mind:

       kraitcc: clock-controller {
               compatible = "qcom,krait-cc-v1";
               clocks = <&gcc PLL9>, /* hfpll0 */
                        <&gcc PLL10>, /* hfpll1 */
                        <&gcc PLL16>, /* hfpll2 */
                        <&gcc PLL17>, /* hfpll3 */
                        <&gcc PLL12>, /* hfpll_l2 */
                        <&acc0>,
                        <&acc1>,
                        <&acc2>,
                        <&acc3>,
                        <&l2cc>;
               clock-names = "hfpll0",
                             "hfpll1",
                             "hfpll2",
                             "hfpll3",

                             "hfpll_l2",
                             "acpu0_aux",
                             "acpu1_aux",
                             "acpu2_aux",
                             "acpu3_aux",
                             "acpu_l2_aux";
               #clock-cells = <1>;
       };

Quoted 115 lines

---
 .../bindings/clock/qcom,krait-cc.txt          | 34 -----------
 .../bindings/clock/qcom,krait-cc.yaml         | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 34 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.txt
 create mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml

Documentation/devicetree/bindings/clock/qcom,krait-cc.txt deleted +0 -34

deleted file mode 100644
index 030ba60dab08..000000000000
@@ -1,34 +0,0 @@
-Krait Clock Controller
-
-PROPERTIES
-
-- compatible:
-       Usage: required
-       Value type: <string>
-       Definition: must be one of:
-                       "qcom,krait-cc-v1"
-                       "qcom,krait-cc-v2"
-
-- #clock-cells:
-       Usage: required
-       Value type: <u32>
-       Definition: must be 1
-
-- clocks:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: reference to the clock parents of hfpll, secondary muxes.
-
-- clock-names:
-       Usage: required
-       Value type: <stringlist>
-       Definition: must be "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb".
-
-Example:
-
-       kraitcc: clock-controller {
-               compatible = "qcom,krait-cc-v1";
-               clocks = <&hfpll0>, <&hfpll1>, <&acpu0_aux>, <&acpu1_aux>, <qsb>;
-               clock-names = "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb";
-               #clock-cells = <1>;
-       };

Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml new file +59 -1

new file mode 100644
index 000000000000..8caa5a677394
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/qcom,krait-cc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Krait Clock Controller
+
+maintainers:
+  - Christian Marangi <[email protected]>
+
+description: |
+  Qualcomm Krait Clock Controller used to correctly scale the CPU and the L2
+  rates.
+
+properties:
+  compatible:
+    enum:
+      - qcom,krait-cc-v1
+      - qcom,krait-cc-v2
+
+  clocks:
+    items:
+      - description: phandle to hfpll for CPU0 mux
+      - description: phandle to hfpll for CPU1 mux
+      - description: phandle to CPU0 aux clock
+      - description: phandle to CPU1 aux clock
+      - description: phandle to QSB fixed clk
+
+  clock-names:
+    items:
+      - const: hfpll0
+      - const: hfpll1
+      - const: acpu0_aux
+      - const: acpu1_aux
+      - const: qsb
+
+  '#clock-cells':
+    const: 1
+
+required:
+  - compatible
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-controller {
+      compatible = "qcom,krait-cc-v1";
+      clocks = <&hfpll0>, <&hfpll1>,
+               <&acpu0_aux>, <&acpu1_aux>, <&qsb>;
+      clock-names = "hfpll0", "hfpll1",
+                    "acpu0_aux", "acpu1_aux", "qsb";
+      #clock-cells = <1>;
+    };
+...
--

2.37.2

Signature · 2 lines

With best wishes
Dmitry

Quoted 29 lines · Christian Marangi

Quoted 6 lines

Convert qcom,krait-cc to yaml Documentation.

Signed-off-by Christian Marangi <[email protected]>

Reviewed-by Krzysztof Kozlowski <[email protected]>

Acked-by Rob Herring <[email protected]>

I know this has been reviewed already. I checked again my apq8064 branch and noticed that the bindings are not compatible with the apq8064. The SoC in question is a 4-core device, so this is what I had in mind:

       kraitcc: clock-controller {
               compatible = "qcom,krait-cc-v1";
               clocks = <&gcc PLL9>, /* hfpll0 */
                        <&gcc PLL10>, /* hfpll1 */
                        <&gcc PLL16>, /* hfpll2 */
                        <&gcc PLL17>, /* hfpll3 */
                        <&gcc PLL12>, /* hfpll_l2 */
                        <&acc0>,
                        <&acc1>,
                        <&acc2>,
                        <&acc3>,
                        <&l2cc>;
               clock-names = "hfpll0",
                             "hfpll1",
                             "hfpll2",
                             "hfpll3",

Quoted 9 lines

                             "hfpll_l2",
                             "acpu0_aux",
                             "acpu1_aux",
                             "acpu2_aux",
                             "acpu3_aux",
                             "acpu_l2_aux";
               #clock-cells = <1>;
       };

Oh wow... Wasn't aware, but I wonder if a good idea would be to patch the yaml if and when this series is merged? This is a direct conversion of the krait-cc txt...

If we really want I can send a v8 with adding these extra stuff to the just converted yaml in a different commit? (afaik conversion should not add more info if the documentation is not broken enough and can be converted)

Quoted 121 lines

Quoted 116 lines

---
 .../bindings/clock/qcom,krait-cc.txt          | 34 -----------
 .../bindings/clock/qcom,krait-cc.yaml         | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 34 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.txt
 create mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml

Documentation/devicetree/bindings/clock/qcom,krait-cc.txt deleted +0 -34

deleted file mode 100644
index 030ba60dab08..000000000000
@@ -1,34 +0,0 @@
-Krait Clock Controller
-
-PROPERTIES
-
-- compatible:
-       Usage: required
-       Value type: <string>
-       Definition: must be one of:
-                       "qcom,krait-cc-v1"
-                       "qcom,krait-cc-v2"
-
-- #clock-cells:
-       Usage: required
-       Value type: <u32>
-       Definition: must be 1
-
-- clocks:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: reference to the clock parents of hfpll, secondary muxes.
-
-- clock-names:
-       Usage: required
-       Value type: <stringlist>
-       Definition: must be "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb".
-
-Example:
-
-       kraitcc: clock-controller {
-               compatible = "qcom,krait-cc-v1";
-               clocks = <&hfpll0>, <&hfpll1>, <&acpu0_aux>, <&acpu1_aux>, <qsb>;
-               clock-names = "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb";
-               #clock-cells = <1>;
-       };

Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml new file +59 -1

new file mode 100644
index 000000000000..8caa5a677394
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/qcom,krait-cc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Krait Clock Controller
+
+maintainers:
+  - Christian Marangi <[email protected]>
+
+description: |
+  Qualcomm Krait Clock Controller used to correctly scale the CPU and the L2
+  rates.
+
+properties:
+  compatible:
+    enum:
+      - qcom,krait-cc-v1
+      - qcom,krait-cc-v2
+
+  clocks:
+    items:
+      - description: phandle to hfpll for CPU0 mux
+      - description: phandle to hfpll for CPU1 mux
+      - description: phandle to CPU0 aux clock
+      - description: phandle to CPU1 aux clock
+      - description: phandle to QSB fixed clk
+
+  clock-names:
+    items:
+      - const: hfpll0
+      - const: hfpll1
+      - const: acpu0_aux
+      - const: acpu1_aux
+      - const: qsb
+
+  '#clock-cells':
+    const: 1
+
+required:
+  - compatible
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-controller {
+      compatible = "qcom,krait-cc-v1";
+      clocks = <&hfpll0>, <&hfpll1>,
+               <&acpu0_aux>, <&acpu1_aux>, <&qsb>;
+      clock-names = "hfpll0", "hfpll1",
+                    "acpu0_aux", "acpu1_aux", "qsb";
+      #clock-cells = <1>;
+    };
+...
--

2.37.2

Signature · 2 lines

With best wishes
Dmitry

16 января 2023 г. 23:20:17 GMT+02:00, Christian Marangi <[email protected]> пишет:

Quoted 44 lines · Dmitry Baryshkov

Quoted 29 lines · Christian Marangi

Quoted 6 lines

Convert qcom,krait-cc to yaml Documentation.

Signed-off-by Christian Marangi <[email protected]>

Reviewed-by Krzysztof Kozlowski <[email protected]>

Acked-by Rob Herring <[email protected]>

I know this has been reviewed already. I checked again my apq8064 branch and noticed that the bindings are not compatible with the apq8064. The SoC in question is a 4-core device, so this is what I had in mind:

       kraitcc: clock-controller {
               compatible = "qcom,krait-cc-v1";
               clocks = <&gcc PLL9>, /* hfpll0 */
                        <&gcc PLL10>, /* hfpll1 */
                        <&gcc PLL16>, /* hfpll2 */
                        <&gcc PLL17>, /* hfpll3 */
                        <&gcc PLL12>, /* hfpll_l2 */
                        <&acc0>,
                        <&acc1>,
                        <&acc2>,
                        <&acc3>,
                        <&l2cc>;
               clock-names = "hfpll0",
                             "hfpll1",
                             "hfpll2",
                             "hfpll3",

Quoted 9 lines

                             "hfpll_l2",
                             "acpu0_aux",
                             "acpu1_aux",
                             "acpu2_aux",
                             "acpu3_aux",
                             "acpu_l2_aux";
               #clock-cells = <1>;
       };

Oh wow... Wasn't aware, but I wonder if a good idea would be to patch the yaml if and when this series is merged? This is a direct conversion of the krait-cc txt...

Quoted 4 lines

If we really want I can send a v8 with adding these extra stuff to the just converted yaml in a different commit? (afaik conversion should not add more info if the documentation is not broken enough and can be converted)

I think we can ask Bjorn to pick the rest of the patches (if they are acked/reviewed, they look good to me) and work on this one. It might make sense to add per-SoC compatibles. Also note, the qsb clock. Which block generates it on ipq8064?

Quoted 122 lines

Quoted 121 lines

Quoted 116 lines

---
 .../bindings/clock/qcom,krait-cc.txt          | 34 -----------
 .../bindings/clock/qcom,krait-cc.yaml         | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 34 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.txt
 create mode 100644 Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml

Documentation/devicetree/bindings/clock/qcom,krait-cc.txt deleted +0 -34

deleted file mode 100644
index 030ba60dab08..000000000000
@@ -1,34 +0,0 @@
-Krait Clock Controller
-
-PROPERTIES
-
-- compatible:
-       Usage: required
-       Value type: <string>
-       Definition: must be one of:
-                       "qcom,krait-cc-v1"
-                       "qcom,krait-cc-v2"
-
-- #clock-cells:
-       Usage: required
-       Value type: <u32>
-       Definition: must be 1
-
-- clocks:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: reference to the clock parents of hfpll, secondary muxes.
-
-- clock-names:
-       Usage: required
-       Value type: <stringlist>
-       Definition: must be "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb".
-
-Example:
-
-       kraitcc: clock-controller {
-               compatible = "qcom,krait-cc-v1";
-               clocks = <&hfpll0>, <&hfpll1>, <&acpu0_aux>, <&acpu1_aux>, <qsb>;
-               clock-names = "hfpll0", "hfpll1", "acpu0_aux", "acpu1_aux", "qsb";
-               #clock-cells = <1>;
-       };

Documentation/devicetree/bindings/clock/qcom,krait-cc.yaml new file +59 -1

new file mode 100644
index 000000000000..8caa5a677394
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/qcom,krait-cc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Krait Clock Controller
+
+maintainers:
+  - Christian Marangi <[email protected]>
+
+description: |
+  Qualcomm Krait Clock Controller used to correctly scale the CPU and the L2
+  rates.
+
+properties:
+  compatible:
+    enum:
+      - qcom,krait-cc-v1
+      - qcom,krait-cc-v2
+
+  clocks:
+    items:
+      - description: phandle to hfpll for CPU0 mux
+      - description: phandle to hfpll for CPU1 mux
+      - description: phandle to CPU0 aux clock
+      - description: phandle to CPU1 aux clock
+      - description: phandle to QSB fixed clk
+
+  clock-names:
+    items:
+      - const: hfpll0
+      - const: hfpll1
+      - const: acpu0_aux
+      - const: acpu1_aux
+      - const: qsb
+
+  '#clock-cells':
+    const: 1
+
+required:
+  - compatible
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-controller {
+      compatible = "qcom,krait-cc-v1";
+      clocks = <&hfpll0>, <&hfpll1>,
+               <&acpu0_aux>, <&acpu1_aux>, <&qsb>;
+      clock-names = "hfpll0", "hfpll1",
+                    "acpu0_aux", "acpu1_aux", "qsb";
+      #clock-cells = <1>;
+    };
+...
--

2.37.2

Signature · 2 lines

With best wishes
Dmitry

Convert kpss-acc driver Documentation to yaml.
The original Documentation was wrong all along. Fix it while we are converting it.
The example was wrong as kpss-acc-v2 should only expose the regs but we don't have any driver that expose additional clocks. The kpss-acc driver is only specific to v1. For this exact reason, split the Documentation to 2 different schema, v1 as clock-controller and v2 for power-manager as per msm-3.10 specification, the exposed regs handle power manager.

Signed-off-by Christian Marangi <[email protected]>

---
 .../bindings/arm/msm/qcom,kpss-acc.txt        | 49 -------------
 .../bindings/clock/qcom,kpss-acc-v1.yaml      | 72 +++++++++++++++++++
 .../bindings/power/qcom,kpss-acc-v2.yaml      | 42 +++++++++++
 3 files changed, 114 insertions(+), 49 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,kpss-acc.txt
 create mode 100644 Documentation/devicetree/bindings/clock/qcom,kpss-acc-v1.yaml
 create mode 100644 Documentation/devicetree/bindings/power/qcom,kpss-acc-v2.yaml

Add missing clock configuration by adding clocks, clock-names and #clock-cells bindings for each kpss-acc-v1 clock-controller node for apq8064 and msm8960 to reflect Documentation schema. Add missing #clock-cells binding and remove useless clock-output-names for ipq806x dtsi.

Signed-off-by Christian Marangi <[email protected]>

Change kpss-acc-v2 nodes naming to power-manager to reflect Documentation schema.

Signed-off-by Christian Marangi <[email protected]>

---
 arch/arm/boot/dts/qcom-apq8084.dtsi | 8 ++++----
 arch/arm/boot/dts/qcom-ipq4019.dtsi | 8 ++++----
 arch/arm/boot/dts/qcom-msm8974.dtsi | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

This series convert the krait-cc and the kpps-acc/gcc Documentation to yaml.

This series comes form a split of a bigger series that got too big and now hard to review.

While they are still more or less wrong and doesn't really reflect real driver implementation, they are converted to prepare for a fixup later when dts and driver are finally fixed.

[...]