diff mbox series

[net-next,08/16] dt-bindings: net: dwmac: Drop prop names from snps,axi-config description

Message ID 20230313225103.30512-9-Sergey.Semin@baikalelectronics.ru
State Not Applicable, archived
Headers show
Series dt-bindings: net: dwmac: Extend clocks, props desc and constraints | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

Serge Semin March 13, 2023, 10:50 p.m. UTC
The property is supposed to contain a phandle reference to the DT-node
with the AXI-bus parameters. Such DT-node is described in the same
DT-bindings schema by means of the sub-node with the name
"stmmac-axi-config". Similarly to MTL Tx/Rx config phandle properties
let's drop the target DT-node properties list from the "snps,axi-config"
property description since having that duplicate is not only pointless,
but also worsens the bindings maintainability by causing a need to support
the two identical lists. Instead the reference to the target DT-node is
added to the description.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
---
 .../devicetree/bindings/net/snps,dwmac.yaml        | 14 +++-----------
 1 file changed, 3 insertions(+), 11 deletions(-)

Comments

Krzysztof Kozlowski March 16, 2023, 8:05 a.m. UTC | #1
On 13/03/2023 23:50, Serge Semin wrote:
> The property is supposed to contain a phandle reference to the DT-node
> with the AXI-bus parameters. Such DT-node is described in the same
> DT-bindings schema by means of the sub-node with the name
> "stmmac-axi-config". Similarly to MTL Tx/Rx config phandle properties
> let's drop the target DT-node properties list from the "snps,axi-config"
> property description since having that duplicate is not only pointless,
> but also worsens the bindings maintainability by causing a need to support
> the two identical lists. Instead the reference to the target DT-node is
> added to the description.
> 


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

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/snps,dwmac.yaml b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
index 01f385867c3a..89be67e55c3e 100644
--- a/Documentation/devicetree/bindings/net/snps,dwmac.yaml
+++ b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
@@ -98,17 +98,9 @@  properties:
   snps,axi-config:
     $ref: /schemas/types.yaml#/definitions/phandle
     description:
-      AXI BUS Mode parameters. Phandle to a node that can contain the
-      following properties
-        * snps,lpi_en, enable Low Power Interface
-        * snps,xit_frm, unlock on WoL
-        * snps,wr_osr_lmt, max write outstanding req. limit
-        * snps,rd_osr_lmt, max read outstanding req. limit
-        * snps,kbbe, do not cross 1KiB boundary.
-        * snps,blen, this is a vector of supported burst length.
-        * snps,fb, fixed-burst
-        * snps,mb, mixed-burst
-        * snps,rb, rebuild INCRx Burst
+      AXI BUS Mode parameters. Phandle to a node that
+      implements the 'stmmac-axi-config' object described in
+      this binding.
 
   snps,mtl-rx-config:
     $ref: /schemas/types.yaml#/definitions/phandle