[PATCH v2] dt-bindings: clock: fixed: Define a preferred node name

[PATCH v2] dt-bindings: clock: fixed: Define a preferred node name

[Rob Herring (Arm)]

Define "clock-<freq>" as the preferred node name for fixed-clock and
fixed-factor-clock where <freq> is the output frequency of the clock.
There isn't much of an existing pattern for names of these nodes. The
most frequent patterns are a prefix or suffix of "clk", but there's a
bunch that don't follow any sort of pattern. We could use
"clock-controller-.*", but these nodes aren't really a controller in any
way. So let's at least align with part of that and use 'clock-'.

For now this only serves as documentation as the schema still allows
anything to avoid lots of additional warnings for something low priority
to fix. Once a "no deprecated" mode is added to the tools, warnings can
be enabled selectively.

Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
---
 Documentation/devicetree/bindings/clock/fixed-clock.yaml | 9 +++++++++
 .../devicetree/bindings/clock/fixed-factor-clock.yaml    | 9 +++++++++
 2 files changed, 18 insertions(+)

diff --git a/Documentation/devicetree/bindings/clock/fixed-clock.yaml b/Documentation/devicetree/bindings/clock/fixed-clock.yaml
index b0a4fb8256e2..90fb10660684 100644
--- a/Documentation/devicetree/bindings/clock/fixed-clock.yaml
+++ b/Documentation/devicetree/bindings/clock/fixed-clock.yaml
@@ -11,6 +11,15 @@ maintainers:
   - Stephen Boyd <sboyd@kernel.org>
 
 properties:
+  $nodename:
+    anyOf:
+      - description:
+          Preferred name is 'clock-<freq>' with <freq> being the output
+          frequency as defined in the 'clock-frequency' property.
+        pattern: "^clock-([0-9]+|[a-z0-9-]+)$"
+      - description: Any name allowed
+        deprecated: true
+
   compatible:
     const: fixed-clock
 
diff --git a/Documentation/devicetree/bindings/clock/fixed-factor-clock.yaml b/Documentation/devicetree/bindings/clock/fixed-factor-clock.yaml
index 8f71ab300470..4afdb1c98f5f 100644
--- a/Documentation/devicetree/bindings/clock/fixed-factor-clock.yaml
+++ b/Documentation/devicetree/bindings/clock/fixed-factor-clock.yaml
@@ -11,6 +11,15 @@ maintainers:
   - Stephen Boyd <sboyd@kernel.org>
 
 properties:
+  $nodename:
+    anyOf:
+      - description:
+          If the frequency is fixed, the preferred name is 'clock-<freq>' with
+          <freq> being the output frequency.
+        pattern: "^clock-([0-9]+|[0-9a-z-]+)$"
+      - description: Any name allowed
+        deprecated: true
+
   compatible:
     enum:
       - fixed-factor-clock
-- 
2.43.0

Re: [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 950 bytes --]

On Tue, Apr 30, 2024 at 01:04:14PM -0500, Rob Herring (Arm) wrote:
> Define "clock-<freq>" as the preferred node name for fixed-clock and
> fixed-factor-clock where <freq> is the output frequency of the clock.
> There isn't much of an existing pattern for names of these nodes. The
> most frequent patterns are a prefix or suffix of "clk", but there's a
> bunch that don't follow any sort of pattern. We could use
> "clock-controller-.*", but these nodes aren't really a controller in any
> way. So let's at least align with part of that and use 'clock-'.
> 
> For now this only serves as documentation as the schema still allows
> anything to avoid lots of additional warnings for something low priority
> to fix. Once a "no deprecated" mode is added to the tools, warnings can
> be enabled selectively.
> 
> Signed-off-by: Rob Herring (Arm) <robh@kernel.org>

Acked-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name

[Stephen Boyd]

Quoting Rob Herring (Arm) (2024-04-30 11:04:14)
> Define "clock-<freq>" as the preferred node name for fixed-clock and
> fixed-factor-clock where <freq> is the output frequency of the clock.
> There isn't much of an existing pattern for names of these nodes. The
> most frequent patterns are a prefix or suffix of "clk", but there's a
> bunch that don't follow any sort of pattern. We could use
> "clock-controller-.*", but these nodes aren't really a controller in any
> way. So let's at least align with part of that and use 'clock-'.
> 
> For now this only serves as documentation as the schema still allows
> anything to avoid lots of additional warnings for something low priority
> to fix. Once a "no deprecated" mode is added to the tools, warnings can
> be enabled selectively.
> 
> Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
> ---

Applied to clk-next