Commit 2a8aa18c authored by Douglas Anderson's avatar Douglas Anderson Committed by Stephen Boyd
Browse files

dt-bindings: clk: qcom: Fix self-validation, split, and clean cruft 

The 'qcom,gcc.yaml' file failed self-validation (dt_binding_check)
because it required a property to be either (3 entries big),
(3 entries big), or (7 entries big), but not more than one of those
things.  That didn't make a ton of sense.

This patch splits all of the exceptional device trees (AKA those that
would have needed if/then/else rules) from qcom,gcc.yaml.  It also
cleans up some cruft found while doing that.

After this lands, this worked for me atop clk-next with just the known
error about msm8998:
  for f in \
    Documentation/devicetree/bindings/clock/qcom,gcc-apq8064.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc-ipq8074.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc-msm8996.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc-msm8998.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc-qcs404.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc-sc7180.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc-sm8150.yaml \
    Documentation/devicetree/bindings/clock/qcom,gcc.yaml; do \
      ARCH=arm64 make dtbs_check DT_SCHEMA_FILES=$f; \
  done

I then picked this patch atop linux-next (next-20200129) and ran:
  # Delete broken yaml:
  rm Documentation/devicetree/bindings/pci/intel-gw-pcie.yaml
  ARCH=arm64 make dt_binding_check | grep 'clock/qcom'
...and that didn't seem to indicate problems.

Arbitrary decisions made (yell if you want changed):
- Left all the older devices (where clocks / clock-names weren't
  specified) in a single file.
- Didn't make clocks "required" for msm8996 but left them as listed.
  This seems a little weird but it matches the old binding.

Misc cleanups as part of this patch:
- Fixed schema id to not have "bindings/" as per Rob [1].
- Listed include files as per Stephen.
- sm8150 was claimed to be same set of clocks as sc7180, but driver
  and dts appear to say that "bi_tcxo_ao" doesn't exist.  Fixed.
- In "apq8064", "#thermal-sensor-cells" was missing the "#".
- Got rid of "|" at the end of top description since spacing doesn't
  matter.
- Changed indentation to consistently 2 spaces (it was 3 in some
  places).
- Added period at the end of protected-clocks description.
- No space before ":".
- Updated sc7180/sm8150 example to use the 'qcom,rpmh.h' include.
- Updated sc7180/sm8150 example to use larger address/size cells as
  per reality.
- Updated sc7180/sm8150 example to point to the sleep_clk rather than
  <0>.
- Made it so that gcc-ipq8074 didn't require #power-domain-cells since
  actual dts didn't have it and I got no hits from:
    git grep _GDSC include/dt-bindings/clock/qcom,gcc-ipq8074.h
- Made it so that gcc-qcs404 didn't require #power-domain-cells since
  actual dts didn't have it and I got no hits from:
    git grep _GDSC include/dt-bindings/clock/qcom,gcc-qcs404.h

Noticed, but not done in this patch (volunteers needed):
- Add "aud_ref_clk" to sm8150 bindings / dts even though I found a
  reference to it in "gcc-sm8150.c".
- Fix node name in actual ipq8074 to be "clock-controller" (it's gcc).
- Since the example doesn't need phandes to exist, in msm8998 could
  just make up places providing some of the clocks currently bogused
  out with <0>.
- On msm8998 clocks are listed as required but current dts doesn't
  have them.

[1] https://lore.kernel.org/r/CAL_Jsq+_2E-bAbP9F6VYkWRp0crEyRGa5peuwP58-PZniVny7w@mail.gmail.com



Fixes: ab91f72e ("clk: qcom: gcc-msm8996: Fix parent for CLKREF clocks")
Signed-off-by: default avatarDouglas Anderson <dianders@chromium.org>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Reviewed-by: default avatarJeffrey Hugo <jeffrey.l.hugo@gmail.com>
Link: https://lkml.kernel.org/r/20200203094843.v3.1.I4452dc951d7556ede422835268742b25a18b356b@changeid


Signed-off-by: default avatarStephen Boyd <sboyd@kernel.org>
parent 21e157c6

Documentation/devicetree/bindings/clock/qcom,gcc-apq8064.yaml

0 → 100644
+83 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

%YAML 1.2

---

$id: http://devicetree.org/schemas/clock/qcom,gcc-apq8064.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm Global Clock & Reset Controller Binding for APQ8064



maintainers:

  - Stephen Boyd <sboyd@kernel.org>

  - Taniya Das <tdas@codeaurora.org>



description: |

  Qualcomm global clock control module which supports the clocks, resets and

  power domains on APQ8064.



  See also:

  - dt-bindings/clock/qcom,gcc-msm8960.h

  - dt-bindings/reset/qcom,gcc-msm8960.h



properties:

  compatible:

    const: qcom,gcc-apq8064



  '#clock-cells':

    const: 1



  '#reset-cells':

    const: 1



  '#power-domain-cells':

    const: 1



  reg:

    maxItems: 1



  nvmem-cells:

    minItems: 1

    maxItems: 2

    description:

      Qualcomm TSENS (thermal sensor device) on some devices can

      be part of GCC and hence the TSENS properties can also be part

      of the GCC/clock-controller node.

      For more details on the TSENS properties please refer

      Documentation/devicetree/bindings/thermal/qcom-tsens.txt



  nvmem-cell-names:

    minItems: 1

    maxItems: 2

    items:

      - const: calib

      - const: calib_backup



  '#thermal-sensor-cells':

    const: 1



  protected-clocks:

    description:

      Protected clock specifier list as per common clock binding.



required:

  - compatible

  - reg

  - '#clock-cells'

  - '#reset-cells'

  - '#power-domain-cells'

  - nvmem-cells

  - nvmem-cell-names

  - '#thermal-sensor-cells'



examples:

  - |

    clock-controller@900000 {

      compatible = "qcom,gcc-apq8064";

      reg = <0x00900000 0x4000>;

      nvmem-cells = <&tsens_calib>, <&tsens_backup>;

      nvmem-cell-names = "calib", "calib_backup";

      #clock-cells = <1>;

      #reset-cells = <1>;

      #power-domain-cells = <1>;

      #thermal-sensor-cells = <1>;

    };

...

Documentation/devicetree/bindings/clock/qcom,gcc-ipq8074.yaml

0 → 100644
+51 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

%YAML 1.2

---

$id: http://devicetree.org/schemas/clock/qcom,gcc-ipq8074.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm Global Clock & Reset Controller Bindingfor IPQ8074



maintainers:

  - Stephen Boyd <sboyd@kernel.org>

  - Taniya Das <tdas@codeaurora.org>



description: |

  Qualcomm global clock control module which supports the clocks, resets and

  power domains on IPQ8074.



  See also:

  - dt-bindings/clock/qcom,gcc-ipq8074.h



properties:

  compatible:

    const: qcom,gcc-ipq8074



  '#clock-cells':

    const: 1



  '#reset-cells':

    const: 1



  reg:

    maxItems: 1



  protected-clocks:

    description:

      Protected clock specifier list as per common clock binding.



required:

  - compatible

  - reg

  - '#clock-cells'

  - '#reset-cells'



examples:

  - |

    clock-controller@1800000 {

      compatible = "qcom,gcc-ipq8074";

      reg = <0x01800000 0x80000>;

      #clock-cells = <1>;

      #reset-cells = <1>;

    };

...

Documentation/devicetree/bindings/clock/qcom,gcc-msm8996.yaml

0 → 100644
+68 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

%YAML 1.2

---

$id: http://devicetree.org/schemas/clock/qcom,gcc-msm8996.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm Global Clock & Reset Controller Binding for MSM8996



maintainers:

  - Stephen Boyd <sboyd@kernel.org>

  - Taniya Das <tdas@codeaurora.org>



description: |

  Qualcomm global clock control module which supports the clocks, resets and

  power domains on MSM8996.



  See also:

  - dt-bindings/clock/qcom,gcc-msm8996.h



properties:

  compatible:

    const: qcom,gcc-msm8996



  clocks:

    items:

      - description: XO source

      - description: Second XO source

      - description: Sleep clock source



  clock-names:

    items:

      - const: cxo

      - const: cxo2

      - const: sleep_clk



  '#clock-cells':

    const: 1



  '#reset-cells':

    const: 1



  '#power-domain-cells':

    const: 1



  reg:

    maxItems: 1



  protected-clocks:

    description:

      Protected clock specifier list as per common clock binding.



required:

  - compatible

  - reg

  - '#clock-cells'

  - '#reset-cells'

  - '#power-domain-cells'



examples:

  - |

    clock-controller@300000 {

      compatible = "qcom,gcc-msm8996";

      #clock-cells = <1>;

      #reset-cells = <1>;

      #power-domain-cells = <1>;

      reg = <0x300000 0x90000>;

    };

...

Documentation/devicetree/bindings/clock/qcom,gcc-msm8998.yaml

0 → 100644
+93 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

%YAML 1.2

---

$id: http://devicetree.org/schemas/clock/qcom,gcc-msm8998.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm Global Clock & Reset Controller Binding for MSM8998



maintainers:

  - Stephen Boyd <sboyd@kernel.org>

  - Taniya Das <tdas@codeaurora.org>



description: |

  Qualcomm global clock control module which supports the clocks, resets and

  power domains on MSM8998.



  See also:

  - dt-bindings/clock/qcom,gcc-msm8998.h



properties:

  compatible:

    const: qcom,gcc-msm8998



  clocks:

    items:

      - description: Board XO source

      - description: Sleep clock source

      - description: USB 3.0 phy pipe clock

      - description: UFS phy rx symbol clock for pipe 0

      - description: UFS phy rx symbol clock for pipe 1

      - description: UFS phy tx symbol clock

      - description: PCIE phy pipe clock



  clock-names:

    items:

      - const: xo

      - const: sleep_clk

      - const: usb3_pipe

      - const: ufs_rx_symbol0

      - const: ufs_rx_symbol1

      - const: ufs_tx_symbol0

      - const: pcie0_pipe



  '#clock-cells':

    const: 1



  '#reset-cells':

    const: 1



  '#power-domain-cells':

    const: 1



  reg:

    maxItems: 1



  protected-clocks:

    description:

      Protected clock specifier list as per common clock binding.



required:

  - compatible

  - clocks

  - clock-names

  - reg

  - '#clock-cells'

  - '#reset-cells'

  - '#power-domain-cells'



examples:

  - |

    #include <dt-bindings/clock/qcom,rpmcc.h>

    clock-controller@100000 {

      compatible = "qcom,gcc-msm8998";

      #clock-cells = <1>;

      #reset-cells = <1>;

      #power-domain-cells = <1>;

      reg = <0x00100000 0xb0000>;

      clocks = <&rpmcc RPM_SMD_XO_CLK_SRC>,

               <&sleep>,

               <0>,

               <0>,

               <0>,

               <0>,

               <0>;

      clock-names = "xo",

                    "sleep_clk",

                    "usb3_pipe",

                    "ufs_rx_symbol0",

                    "ufs_rx_symbol1",

                    "ufs_tx_symbol0",

                    "pcie0_pipe";

    };

...

Documentation/devicetree/bindings/clock/qcom,gcc-qcs404.yaml

0 → 100644
+51 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

%YAML 1.2

---

$id: http://devicetree.org/schemas/clock/qcom,gcc-qcs404.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Qualcomm Global Clock & Reset Controller Bindingfor QCS404



maintainers:

  - Stephen Boyd <sboyd@kernel.org>

  - Taniya Das <tdas@codeaurora.org>



description: |

  Qualcomm global clock control module which supports the clocks, resets and

  power domains on QCS404.



  See also:

  - dt-bindings/clock/qcom,gcc-qcs404.h



properties:

  compatible:

    const: qcom,gcc-qcs404



  '#clock-cells':

    const: 1



  '#reset-cells':

    const: 1



  reg:

    maxItems: 1



  protected-clocks:

    description:

      Protected clock specifier list as per common clock binding.



required:

  - compatible

  - reg

  - '#clock-cells'

  - '#reset-cells'



examples:

  - |

    clock-controller@1800000 {

      compatible = "qcom,gcc-qcs404";

      reg = <0x01800000 0x80000>;

      #clock-cells = <1>;

      #reset-cells = <1>;

    };

...