diff options
| author | Rob Herring (Arm) <robh@kernel.org> | 2024-04-30 21:04:14 +0300 |
|---|---|---|
| committer | Stephen Boyd <sboyd@kernel.org> | 2024-05-04 03:56:55 +0300 |
| commit | b3e991240ed39f8fa4f74d3a876b48ef80726f84 (patch) | |
| tree | c7e7ad29e27b8d6d15d5914ce03908a4e0b11cff /Documentation/devicetree/bindings/clock | |
| parent | 4cece764965020c22cff7665b18a012006359095 (diff) | |
| download | linux-b3e991240ed39f8fa4f74d3a876b48ef80726f84.tar.xz | |
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.
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
Link: https://lore.kernel.org/r/20240430180415.657067-1-robh@kernel.org
Acked-by: Conor Dooley <conor.dooley@microchip.com>
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
Diffstat (limited to 'Documentation/devicetree/bindings/clock')
| -rw-r--r-- | Documentation/devicetree/bindings/clock/fixed-clock.yaml | 9 | ||||
| -rw-r--r-- | Documentation/devicetree/bindings/clock/fixed-factor-clock.yaml | 9 |
2 files changed, 18 insertions, 0 deletions
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 |