diff mbox series

[RFC,v1,02/14] dt-bindings: clock: thead,th1520: Rename header file

Message ID 20241203134137.2114847-3-m.wilczynski@samsung.com (mailing list archive)
State New
Headers show
Series [RFC,v1,01/14] clk: thead: Refactor TH1520 clock driver to share common code | expand

Checks

Context Check Description
conchuod/vmtest-fixes-PR fail merge-conflict

Commit Message

Michal Wilczynski Dec. 3, 2024, 1:41 p.m. UTC
As support for clocks from new subsystems is being added to the T-Head
TH1520 SoC, the header file name should reflect this broader scope. The
existing header file 'thead,th1520-clk-ap.h' includes the '-ap' suffix,
indicating it's specific to the Application Processor (AP) subsystem.

Rename the header file to 'thead,th1520-clk.h' to generalize it for all
subsystems.  Update all references to this header file accordingly.

Signed-off-by: Michal Wilczynski <m.wilczynski@samsung.com>
---
 .../devicetree/bindings/clock/thead,th1520-clk-ap.yaml        | 4 ++--
 .../devicetree/bindings/mailbox/thead,th1520-mbox.yaml        | 2 +-
 MAINTAINERS                                                   | 2 +-
 arch/riscv/boot/dts/thead/th1520.dtsi                         | 2 +-
 drivers/clk/thead/clk-th1520.h                                | 2 +-
 .../clock/{thead,th1520-clk-ap.h => thead,th1520-clk.h}       | 0
 6 files changed, 6 insertions(+), 6 deletions(-)
 rename include/dt-bindings/clock/{thead,th1520-clk-ap.h => thead,th1520-clk.h} (100%)

Comments

Rob Herring (Arm) Dec. 3, 2024, 2:24 p.m. UTC | #1
On Tue, 03 Dec 2024 14:41:25 +0100, Michal Wilczynski wrote:
> As support for clocks from new subsystems is being added to the T-Head
> TH1520 SoC, the header file name should reflect this broader scope. The
> existing header file 'thead,th1520-clk-ap.h' includes the '-ap' suffix,
> indicating it's specific to the Application Processor (AP) subsystem.
> 
> Rename the header file to 'thead,th1520-clk.h' to generalize it for all
> subsystems.  Update all references to this header file accordingly.
> 
> Signed-off-by: Michal Wilczynski <m.wilczynski@samsung.com>
> ---
>  .../devicetree/bindings/clock/thead,th1520-clk-ap.yaml        | 4 ++--
>  .../devicetree/bindings/mailbox/thead,th1520-mbox.yaml        | 2 +-
>  MAINTAINERS                                                   | 2 +-
>  arch/riscv/boot/dts/thead/th1520.dtsi                         | 2 +-
>  drivers/clk/thead/clk-th1520.h                                | 2 +-
>  .../clock/{thead,th1520-clk-ap.h => thead,th1520-clk.h}       | 0
>  6 files changed, 6 insertions(+), 6 deletions(-)
>  rename include/dt-bindings/clock/{thead,th1520-clk-ap.h => thead,th1520-clk.h} (100%)
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/mailbox/thead,th1520-mbox.example.dts:24:18: fatal error: dt-bindings/clock/thead,th1520-clk.h: No such file or directory
   24 |         #include <dt-bindings/clock/thead,th1520-clk.h>
      |                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[2]: *** [scripts/Makefile.dtbs:131: Documentation/devicetree/bindings/mailbox/thead,th1520-mbox.example.dtb] Error 1
make[2]: *** Waiting for unfinished jobs....
Documentation/devicetree/bindings/clock/thead,th1520-clk-ap.example.dts:18:18: fatal error: dt-bindings/clock/thead,th1520-clk.h: No such file or directory
   18 |         #include <dt-bindings/clock/thead,th1520-clk.h>
      |                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[2]: *** [scripts/Makefile.dtbs:131: Documentation/devicetree/bindings/clock/thead,th1520-clk-ap.example.dtb] Error 1
make[1]: *** [/builds/robherring/dt-review-ci/linux/Makefile:1506: dt_binding_check] Error 2
make: *** [Makefile:251: __sub-make] Error 2

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20241203134137.2114847-3-m.wilczynski@samsung.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Krzysztof Kozlowski Dec. 3, 2024, 3:41 p.m. UTC | #2
On 03/12/2024 14:41, Michal Wilczynski wrote:
> As support for clocks from new subsystems is being added to the T-Head
> TH1520 SoC, the header file name should reflect this broader scope. The

No, there is no such rule, so "should" is not appropriate.


> existing header file 'thead,th1520-clk-ap.h' includes the '-ap' suffix,
> indicating it's specific to the Application Processor (AP) subsystem.
> 
> Rename the header file to 'thead,th1520-clk.h' to generalize it for all
> subsystems.  Update all references to this header file accordingly.
> 
> Signed-off-by: Michal Wilczynski <m.wilczynski@samsung.com>
> ---
>  .../devicetree/bindings/clock/thead,th1520-clk-ap.yaml        | 4 ++--
>  .../devicetree/bindings/mailbox/thead,th1520-mbox.yaml        | 2 +-
>  MAINTAINERS                                                   | 2 +-
>  arch/riscv/boot/dts/thead/th1520.dtsi                         | 2 +-
>  drivers/clk/thead/clk-th1520.h                                | 2 +-
>  .../clock/{thead,th1520-clk-ap.h => thead,th1520-clk.h}       | 0

Don't mix driver, bindings and DTS. See checkpatch warning. Don't rename
files just because you prefer other names.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/thead,th1520-clk-ap.yaml b/Documentation/devicetree/bindings/clock/thead,th1520-clk-ap.yaml
index 0129bd0ba4b3..4a0806af2bf9 100644
--- a/Documentation/devicetree/bindings/clock/thead,th1520-clk-ap.yaml
+++ b/Documentation/devicetree/bindings/clock/thead,th1520-clk-ap.yaml
@@ -32,7 +32,7 @@  properties:
   "#clock-cells":
     const: 1
     description:
-      See <dt-bindings/clock/thead,th1520-clk-ap.h> for valid indices.
+      See <dt-bindings/clock/thead,th1520-clk.h> for valid indices.
 
 required:
   - compatible
@@ -44,7 +44,7 @@  additionalProperties: false
 
 examples:
   - |
-    #include <dt-bindings/clock/thead,th1520-clk-ap.h>
+    #include <dt-bindings/clock/thead,th1520-clk.h>
     clock-controller@ef010000 {
         compatible = "thead,th1520-clk-ap";
         reg = <0xef010000 0x1000>;
diff --git a/Documentation/devicetree/bindings/mailbox/thead,th1520-mbox.yaml b/Documentation/devicetree/bindings/mailbox/thead,th1520-mbox.yaml
index 0971fb97896e..0b58b8d0d351 100644
--- a/Documentation/devicetree/bindings/mailbox/thead,th1520-mbox.yaml
+++ b/Documentation/devicetree/bindings/mailbox/thead,th1520-mbox.yaml
@@ -68,7 +68,7 @@  additionalProperties: false
 
 examples:
   - |
-    #include <dt-bindings/clock/thead,th1520-clk-ap.h>
+    #include <dt-bindings/clock/thead,th1520-clk.h>
     soc {
       #address-cells = <2>;
       #size-cells = <2>;
diff --git a/MAINTAINERS b/MAINTAINERS
index 7c85abf1dd1e..bd4bbf07d588 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -20192,7 +20192,7 @@  F:	drivers/clk/thead/
 F:	drivers/mailbox/mailbox-th1520.c
 F:	drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c
 F:	drivers/pinctrl/pinctrl-th1520.c
-F:	include/dt-bindings/clock/thead,th1520-clk-ap.h
+F:	include/dt-bindings/clock/thead,th1520-clk.h
 
 RNBD BLOCK DRIVERS
 M:	Md. Haris Iqbal <haris.iqbal@ionos.com>
diff --git a/arch/riscv/boot/dts/thead/th1520.dtsi b/arch/riscv/boot/dts/thead/th1520.dtsi
index acfe030e803a..dc2d554b4a71 100644
--- a/arch/riscv/boot/dts/thead/th1520.dtsi
+++ b/arch/riscv/boot/dts/thead/th1520.dtsi
@@ -5,7 +5,7 @@ 
  */
 
 #include <dt-bindings/interrupt-controller/irq.h>
-#include <dt-bindings/clock/thead,th1520-clk-ap.h>
+#include <dt-bindings/clock/thead,th1520-clk.h>
 
 / {
 	compatible = "thead,th1520";
diff --git a/drivers/clk/thead/clk-th1520.h b/drivers/clk/thead/clk-th1520.h
index 285d41e65008..5d30f55e88a1 100644
--- a/drivers/clk/thead/clk-th1520.h
+++ b/drivers/clk/thead/clk-th1520.h
@@ -10,7 +10,7 @@ 
 #ifndef CLK_TH1520_H
 #define CLK_TH1520_H
 
-#include <dt-bindings/clock/thead,th1520-clk-ap.h>
+#include <dt-bindings/clock/thead,th1520-clk.h>
 #include <linux/bitfield.h>
 #include <linux/clk-provider.h>
 #include <linux/device.h>
diff --git a/include/dt-bindings/clock/thead,th1520-clk-ap.h b/include/dt-bindings/clock/thead,th1520-clk.h
similarity index 100%
rename from include/dt-bindings/clock/thead,th1520-clk-ap.h
rename to include/dt-bindings/clock/thead,th1520-clk.h