* [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name
@ 2024-04-30 18:04 Rob Herring (Arm)
2024-05-01 17:10 ` Conor Dooley
2024-05-04 0:57 ` Stephen Boyd
0 siblings, 2 replies; 3+ messages in thread
From: Rob Herring (Arm) @ 2024-04-30 18:04 UTC (permalink / raw
To: Michael Turquette, Stephen Boyd, Krzysztof Kozlowski,
Conor Dooley
Cc: linux-clk, devicetree, linux-kernel
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name
2024-04-30 18:04 [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name Rob Herring (Arm)
@ 2024-05-01 17:10 ` Conor Dooley
2024-05-04 0:57 ` Stephen Boyd
1 sibling, 0 replies; 3+ messages in thread
From: Conor Dooley @ 2024-05-01 17:10 UTC (permalink / raw
To: Rob Herring (Arm)
Cc: Michael Turquette, Stephen Boyd, Krzysztof Kozlowski,
Conor Dooley, linux-clk, devicetree, linux-kernel
[-- 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 --]
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name
2024-04-30 18:04 [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name Rob Herring (Arm)
2024-05-01 17:10 ` Conor Dooley
@ 2024-05-04 0:57 ` Stephen Boyd
1 sibling, 0 replies; 3+ messages in thread
From: Stephen Boyd @ 2024-05-04 0:57 UTC (permalink / raw
To: Conor Dooley, Krzysztof Kozlowski, Michael Turquette, Rob Herring
Cc: linux-clk, devicetree, linux-kernel
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-05-04 0:57 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-04-30 18:04 [PATCH v2] dt-bindings: clock: fixed: Define a preferred node name Rob Herring (Arm)
2024-05-01 17:10 ` Conor Dooley
2024-05-04 0:57 ` Stephen Boyd
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).