Skip to contentSkip to conversation

dt-bindings: spi: Update clocks property for ARM pl022

PATCH In review Kuldeep Singh 3 participants 9 messages Mar 8, 2022 – Mar 11, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 dt-bindings: spi: Update clocks property for ARM pl022

Add missing minItems property to clocks in ARM pl022 bindings.

This helps in resolving below warnings:
clocks: [[4]] is too short
clock-names: ['apb_pclk'] is too short

---
v2:
- Keep actual warning and remove path to file
- Reword commit message a bit

 Documentation/devicetree/bindings/spi/spi-pl022.yaml | 1 +
 1 file changed, 1 insertion(+)
Documentation/devicetree/bindings/spi/spi-pl022.yaml +1 -0
index 6d633728fc2b..7d36e15db5b3 100644
@@ -34,6 +34,7 @@ properties:
     maxItems: 1
 
   clocks:
+    minItems: 1
     maxItems: 2
 
   clock-names:
Signature · 1 line
2.25.1
#1 lore raw

PATCH v2 2/2 dt-bindings: spi: Update clock-names property for ARM pl022

Pl022 clock-names can be one of following:
['apb_pclk'] or ['sspclk', 'apb_pclk']

The current schema refers to second case only. Make necessary changes to incorporate both the cases and resolve below dtc warning:
clock-names: 'apb_pclk' is not one of ['sspclk']

---
v2:
- Reword commit message
- Drop SSPCLK

 Documentation/devicetree/bindings/spi/spi-pl022.yaml | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
Documentation/devicetree/bindings/spi/spi-pl022.yaml +6 -4
index 7d36e15db5b3..6cfab948624e 100644
@@ -38,11 +38,13 @@ properties:
     maxItems: 2
 
   clock-names:
-    items:
+    oneOf:
       - enum:
-          - SSPCLK
-          - sspclk
-      - const: apb_pclk
+          - apb_pclk
+      - items:
+          - enum:
+              - sspclk
+          - const: apb_pclk
 
   pl022,autosuspend-delay:
     description: delay in ms following transfer completion before the
Signature · 1 line
2.25.1
maintainer
#2 lore raw

Re: [PATCH v2 2/2] dt-bindings: spi: Update clock-names property for ARM pl022

Quoted 21 lines · Kuldeep Singh

Pl022 clock-names can be one of following:
['apb_pclk'] or ['sspclk', 'apb_pclk']

The current schema refers to second case only. Make necessary changes to incorporate both the cases and resolve below dtc warning:
clock-names: 'apb_pclk' is not one of ['sspclk']

---
v2:
- Reword commit message
- Drop SSPCLK

 Documentation/devicetree/bindings/spi/spi-pl022.yaml | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
Documentation/devicetree/bindings/spi/spi-pl022.yaml +0 -0
index 7d36e15db5b3..6cfab948624e 100644

Documentation/devicetree/bindings/spi/spi-pl022.yaml properties: · line 43

Quoted 10 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +2 -4
@@ -38,11 +38,13 @@ properties:
     maxItems: 2
 
   clock-names:
-    items:
+    oneOf:
       - enum:
-          - SSPCLK
-          - sspclk
-      - const: apb_pclk
+          - apb_pclk

Are you going to make the driver work with no SPI clock? Because this change is saying that it is valid to have the APB bus clock and no SPI clock.

Rob

Quoted 11 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +4 -0
+      - items:
+          - enum:
+              - sspclk
+          - const: apb_pclk
 
   pl022,autosuspend-delay:
     description: delay in ms following transfer completion before the
Signature · 1 line
2.25.1
#3 lore raw

Re: [PATCH v2 2/2] dt-bindings: spi: Update clock-names property for ARM pl022

Quoted 24 lines · Rob Herring
Quoted 23 lines · Kuldeep Singh

Pl022 clock-names can be one of following:
['apb_pclk'] or ['sspclk', 'apb_pclk']

The current schema refers to second case only. Make necessary changes to incorporate both the cases and resolve below dtc warning:
clock-names: 'apb_pclk' is not one of ['sspclk']

---
v2:
- Reword commit message
- Drop SSPCLK

 Documentation/devicetree/bindings/spi/spi-pl022.yaml | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
Documentation/devicetree/bindings/spi/spi-pl022.yaml +0 -0
index 7d36e15db5b3..6cfab948624e 100644
@@ -38,11 +38,13 @@ properties:
     maxItems: 2
 
Quoted 12 lines

Documentation/devicetree/bindings/spi/spi-pl022.yaml properties: · line 43

Quoted 8 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +2 -4
   clock-names:
-    items:
+    oneOf:
       - enum:
-          - SSPCLK
-          - sspclk
-      - const: apb_pclk
+          - apb_pclk

Are you going to make the driver work with no SPI clock? Because this change is saying that it is valid to have the APB bus clock and no SPI clock.

Kindly take a loot at newer version to this series as this one is deprecated.

https://lore.kernel.org/linux-spi/[email protected]/

- Kuldeep

Quoted 14 lines

Rob

Quoted 11 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +4 -0
+      - items:
+          - enum:
+              - sspclk
+          - const: apb_pclk
 
   pl022,autosuspend-delay:
     description: delay in ms following transfer completion before the
Signature · 1 line
2.25.1
#4 lore raw
In reply to Kuldeep Singh
Quoted 11 lines · Kuldeep Singh

Add missing minItems property to clocks in ARM pl022 bindings.

This helps in resolving below warnings:
clocks: [[4]] is too short
clock-names: ['apb_pclk'] is too short

---
v2:
- Keep actual warning and remove path to file
- Reword commit message a bit

It still misses information whether it is actually correct from PL022 point of view to have just one clock.

If the DTS are wrong, do not change the bindings to match such wrong DTS. If the DTS is correct, please explain why bindings are wrong.

Quoted 9 lines
 Documentation/devicetree/bindings/spi/spi-pl022.yaml | 1 +
 1 file changed, 1 insertion(+)
Documentation/devicetree/bindings/spi/spi-pl022.yaml +0 -0
index 6d633728fc2b..7d36e15db5b3 100644

Documentation/devicetree/bindings/spi/spi-pl022.yaml properties: · line 38

Quoted 5 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +1 -0
@@ -34,6 +34,7 @@ properties:
     maxItems: 1
 
   clocks:
+    minItems: 1
     maxItems: 2

This does not match clock-names which requires two clocks. It's not correct now.

Documentation/devicetree/bindings/spi/spi-pl022.yaml properties: · line 40

Quoted 2 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +0 -0
   clock-names:

Best regards,
Krzysztof

#5 lore raw
Quoted 13 lines · Krzysztof Kozlowski
Quoted 11 lines · Kuldeep Singh

Add missing minItems property to clocks in ARM pl022 bindings.

This helps in resolving below warnings:
clocks: [[4]] is too short
clock-names: ['apb_pclk'] is too short

---
v2:
- Keep actual warning and remove path to file
- Reword commit message a bit

Quoted 5 lines

It still misses information whether it is actually correct from PL022 point of view to have just one clock.

If the DTS are wrong, do not change the bindings to match such wrong DTS. If the DTS is correct, please explain why bindings are wrong.

Thanks Krzysztof for pointing it out.
So far I was wondering spiclk clock-name was the only culprit there and had different perception w.r.t number of clocks.

Anyway, below reference is from pl022 point of view:
https://documentation-service.arm.com/static/5e8e3bc7fd977155116a936d?token=
https://developer.arm.com/documentation/ddi0194/h/functional-overview/primecell-ssp-operation/clock-ratios

The reference no where mention that single clock can exist. So far Amd seattle and LG platforms don't comply with binding and define single clock which require updations.

So now from bindings perspective, I am looking forward to keep only one notation of sspclk and will respin a patch. Kindly provide comments on the same.

Regards
Kuldeep

Quoted 24 lines
Quoted 9 lines
 Documentation/devicetree/bindings/spi/spi-pl022.yaml | 1 +
 1 file changed, 1 insertion(+)
Documentation/devicetree/bindings/spi/spi-pl022.yaml +0 -0
index 6d633728fc2b..7d36e15db5b3 100644

Documentation/devicetree/bindings/spi/spi-pl022.yaml properties: · line 38

Quoted 5 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +1 -0
@@ -34,6 +34,7 @@ properties:
     maxItems: 1
 
   clocks:
+    minItems: 1
     maxItems: 2

This does not match clock-names which requires two clocks. It's not correct now.

Documentation/devicetree/bindings/spi/spi-pl022.yaml properties: · line 40

Quoted 2 lines
Documentation/devicetree/bindings/spi/spi-pl022.yaml +0 -0
   clock-names:

Best regards,
Krzysztof

maintainer
#6 lore raw
In reply to Kuldeep Singh
Quoted 5 lines · Kuldeep Singh

Add missing minItems property to clocks in ARM pl022 bindings.

This helps in resolving below warnings:
clocks: [[4]] is too short
clock-names: ['apb_pclk'] is too short

Again, the error is in the dts files, not the schema.

There's 2 possible answers. First, both clock inputs use the same source clock. That's an easy fix. List the clock twice. Second, one clock is not described in DT or visible to s/w. It still has to be in the h/w and could be described as a 'fixed-clock'. A DT should either be all in with clocks or not use the clock binding IMO. Describing some clocks and not others is not a good solution.

For example, let's look at bcm-cygnus as one of the single clock examples. The first thing I notice is there is a apb_pclk already defined. The pl330 uses it. The watchdog (also Primecell) lists the source clock twice. So what should pl022 be? IDK, ask the Broadcom folks. If they don't know, then list the source clock twice. That's effectively no change from what we have now.

The other issue with allowing a single clock is then any new user can just repeat this mistake.

Rob

#7 lore raw
Quoted 8 lines · Rob Herring
Quoted 5 lines · Kuldeep Singh

Add missing minItems property to clocks in ARM pl022 bindings.

This helps in resolving below warnings:
clocks: [[4]] is too short
clock-names: ['apb_pclk'] is too short

Again, the error is in the dts files, not the schema.

Rob, kindly note this series number is deprecated and I have sent v3 version some time back. Here's the link:

https://lore.kernel.org/linux-spi/[email protected]/T/#u

Quoted 9 lines

There's 2 possible answers. First, both clock inputs use the same source clock. That's an easy fix. List the clock twice. Second, one clock is not described in DT or visible to s/w. It still has to be in the h/w and could be described as a 'fixed-clock'. A DT should either be all in with clocks or not use the clock binding IMO. Describing some clocks and not others is not a good solution.

Quoted 6 lines

For example, let's look at bcm-cygnus as one of the single clock examples. The first thing I notice is there is a apb_pclk already defined. The pl330 uses it. The watchdog (also Primecell) lists the source clock twice. So what should pl022 be? IDK, ask the Broadcom folks. If they don't know, then list the source clock twice. That's effectively no change from what we have now.

Yes, I took motivation from sp805 watchdog(primecell) while resolving DT conflicts. I found LG and amd seattle platform with single clock in DT for which I have sent patches. Link is below:

https://lore.kernel.org/linux-devicetree/CAL_Jsq+k+ridWTkdy4xwTC7VxUTU8tu+Q2BA9kbQVA222PWvZw@mail.gmail.com/

Moreover, I observed that clocks and clock-names are not required properties for pl022. I am wondering reason behind the same when you first made changes. Any specific reason not adding them which I am not aware of or it just got missed?

- Kuldeep

#8 lore raw
Quoted 8 lines · Kuldeep Singh
Quoted 7 lines · Rob Herring
Quoted 5 lines · Kuldeep Singh

Add missing minItems property to clocks in ARM pl022 bindings.

This helps in resolving below warnings:
clocks: [[4]] is too short
clock-names: ['apb_pclk'] is too short

Quoted 22 lines
Quoted 1 line

Again, the error is in the dts files, not the schema.

Rob, kindly note this series number is deprecated and I have sent v3 version some time back. Here's the link:

https://lore.kernel.org/linux-spi/[email protected]/T/#u

Quoted 15 lines

There's 2 possible answers. First, both clock inputs use the same source clock. That's an easy fix. List the clock twice. Second, one clock is not described in DT or visible to s/w. It still has to be in the h/w and could be described as a 'fixed-clock'. A DT should either be all in with clocks or not use the clock binding IMO. Describing some clocks and not others is not a good solution.

For example, let's look at bcm-cygnus as one of the single clock examples. The first thing I notice is there is a apb_pclk already defined. The pl330 uses it. The watchdog (also Primecell) lists the source clock twice. So what should pl022 be? IDK, ask the Broadcom folks. If they don't know, then list the source clock twice. That's effectively no change from what we have now.

I just noticed not all platforms possessing single clock are raising 'dtbs_check' warning. For example, bcm-cygnus and lpc32xx passes check even though their DT clock entry has just "apb_pclk".

Any reason why they pass successfully through checks?

Quoted 13 lines

Yes, I took motivation from sp805 watchdog(primecell) while resolving DT conflicts. I found LG and amd seattle platform with single clock in DT for which I have sent patches. Link is below:

https://lore.kernel.org/linux-devicetree/CAL_Jsq+k+ridWTkdy4xwTC7VxUTU8tu+Q2BA9kbQVA222PWvZw@mail.gmail.com/

Moreover, I observed that clocks and clock-names are not required properties for pl022. I am wondering reason behind the same when you first made changes. Any specific reason not adding them which I am not aware of or it just got missed?

- Kuldeep