dt-bindings: clock: fixed: Define a preferred node name
Subsystems (2)
Rob Herring (Arm)
maintainerPATCH v2 1/1 dt-bindings: clock: fixed: Define a preferred node name
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.
--- Documentation/devicetree/bindings/clock/fixed-clock.yaml | 9 +++++++++ .../devicetree/bindings/clock/fixed-factor-clock.yaml | 9 +++++++++ 2 files changed, 18 insertions(+)
Documentation/devicetree/bindings/clock/fixed-clock.yaml +9 -0
@@ -11,6 +11,15 @@ maintainers: - Stephen Boyd <[email protected]> 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
Documentation/devicetree/bindings/clock/fixed-factor-clock.yaml +9 -0
@@ -11,6 +11,15 @@ maintainers: - Stephen Boyd <[email protected]> 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
Signature · 1 line
2.43.0
Quoted 8 lines · 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-'.
Quoted 6 lines
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) <[email protected]>
Cheers,
Conor.
Quoting Rob Herring (Arm) (2024-04-30 11:04:14)
Quoted 8 lines
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-'.
Quoted 7 lines
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) <[email protected]>---
Applied to clk-next