[v1] dt-bindings: ethernet: eswin: fix yaml schema issues

[PATCH] dt-bindings: ethernet: eswin: fix yaml schema issues

Posted by weishangjuan@eswincomputing.com 3 months, 1 week ago

From: Shangjuan Wei <weishangjuan@eswincomputing.com>

Due to the detection of errors in the eswin mmc module
regarding the eswin,hsp-sp-csr attributes in the
eswin,eic7700-eth.yaml file, the link is as follows:
https://lore.kernel.org/all/176096011380.22917.1988679321096076522.robh@kernel.org/
Therefore, the eswin,hsp-sp-csr attributes of the eic7700-eth.yaml file
regarding eswin and hsp-sp-csr will be changed to the form of:
items:
  - items:
      - description: ...
      - description: ...
      - description: ...
      - description: ...

The MMC,Ethernet,and USB modules of eswin vendor have defined
eswin,hsp-sp-csr attribute in YAML. In order to be consistent
with the property description of MMC,USB, I have modified the
description content of eswin,hsp-sp-csr attribute in Ethernet YAML.

Fixes: 888bd0eca93c("dt-bindings: ethernet: eswin: Document for EIC7700 SoC")
Reported-by: Rob Herring (Arm) <robh@kernel.org>
Closes: https://lore.kernel.org/all/176096011380.22917.1988679321096076522.robh@kernel.org/
Signed-off-by: Shangjuan Wei <weishangjuan@eswincomputing.com>
---
 .../bindings/net/eswin,eic7700-eth.yaml       | 20 ++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/eswin,eic7700-eth.yaml b/Documentation/devicetree/bindings/net/eswin,eic7700-eth.yaml
index 9ddbfe219ae2..91e8cd1db67b 100644
--- a/Documentation/devicetree/bindings/net/eswin,eic7700-eth.yaml
+++ b/Documentation/devicetree/bindings/net/eswin,eic7700-eth.yaml
@@ -69,17 +69,19 @@ properties:
     enum: [0, 200, 600, 1200, 1600, 1800, 2000, 2200, 2400]

   eswin,hsp-sp-csr:
+    description:
+      HSP CSR is to control and get status of different high-speed peripherals
+      (such as Ethernet, USB, SATA, etc.) via register, which can tune
+      board-level's parameters of PHY, etc.
     $ref: /schemas/types.yaml#/definitions/phandle-array
     items:
-      - description: Phandle to HSP(High-Speed Peripheral) device
-      - description: Offset of phy control register for internal
-                     or external clock selection
-      - description: Offset of AXI clock controller Low-Power request
-                     register
-      - description: Offset of register controlling TX/RX clock delay
-    description: |
-      High-Speed Peripheral device needed to configure clock selection,
-      clock low-power mode and clock delay.
+      - items:
+          - description: Phandle to HSP(High-Speed Peripheral) device
+          - description: Offset of phy control register for internal
+                         or external clock selection
+          - description: Offset of AXI clock controller Low-Power request
+                         register
+          - description: Offset of register controlling TX/RX clock delay

 required:
   - compatible
--
2.17.1

Re: [PATCH] dt-bindings: ethernet: eswin: fix yaml schema issues

Posted by Krzysztof Kozlowski 3 months, 1 week ago

On Thu, Oct 30, 2025 at 04:50:01PM +0800, weishangjuan@eswincomputing.com wrote:
> From: Shangjuan Wei <weishangjuan@eswincomputing.com>
> 
> Due to the detection of errors in the eswin mmc module
> regarding the eswin,hsp-sp-csr attributes in the
> eswin,eic7700-eth.yaml file, the link is as follows:
> https://lore.kernel.org/all/176096011380.22917.1988679321096076522.robh@kernel.org/
> Therefore, the eswin,hsp-sp-csr attributes of the eic7700-eth.yaml file
> regarding eswin and hsp-sp-csr will be changed to the form of:

Ach, and you forgot net or net-next subject prefix, depending which
branch/cycle you target. See submitting patches and this subsystem
maintainer profile document.

Best regards,
Krzysztof

Re: [PATCH] dt-bindings: ethernet: eswin: fix yaml schema issues

Posted by Krzysztof Kozlowski 3 months, 1 week ago

On Thu, Oct 30, 2025 at 04:50:01PM +0800, weishangjuan@eswincomputing.com wrote:
> From: Shangjuan Wei <weishangjuan@eswincomputing.com>
> 
> Due to the detection of errors in the eswin mmc module
> regarding the eswin,hsp-sp-csr attributes in the
> eswin,eic7700-eth.yaml file, the link is as follows:
> https://lore.kernel.org/all/176096011380.22917.1988679321096076522.robh@kernel.org/

Drop, reported already says that.

Just say that this is one phandle with multiple arguments, so the syntax
should be in the form of:

> Therefore, the eswin,hsp-sp-csr attributes of the eic7700-eth.yaml file
> regarding eswin and hsp-sp-csr will be changed to the form of:

> items:
>   - items:
>       - description: ...
>       - description: ...
>       - description: ...
>       - description: ...
> 
> The MMC,Ethernet,and USB modules of eswin vendor have defined
> eswin,hsp-sp-csr attribute in YAML. In order to be consistent
> with the property description of MMC,USB, I have modified the
> description content of eswin,hsp-sp-csr attribute in Ethernet YAML.

That's redundant paragraph. Write concise messages describing the
problem, not some background or unrelated bindings. See also submitting
patches about preferred English form.

> 
> Fixes: 888bd0eca93c("dt-bindings: ethernet: eswin: Document for EIC7700 SoC")

Missing space, missing checkpatch.

Please run scripts/checkpatch.pl on the patches and fix reported
warnings. After that, run also 'scripts/checkpatch.pl --strict' on the
patches and (probably) fix more warnings. Some warnings can be ignored,
especially from --strict run, but the code here looks like it needs a
fix. Feel free to get in touch if the warning is not clear.

With first paragraph and fixes tag corrected:

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof