diff mbox series

[net-next,15/16] dt-bindings: net: dwmac: Simplify MTL queue props dependencies

Message ID 20230313225103.30512-16-Sergey.Semin@baikalelectronics.ru (mailing list archive)
State New, archived
Headers show
Series dt-bindings: net: dwmac: Extend clocks, props desc and constraints | expand

Commit Message

Serge Semin March 13, 2023, 10:51 p.m. UTC 
Currently the Tx/Rx queues properties interdependencies are described by
means of the pattern: "if: required: X, then: properties: Y: false, Z:
false, etc". Due to very unfortunate MTL Tx/Rx queue DT-node design the
resultant sub-nodes schemas look very bulky and thus hard to read. The
situation can be improved by using the "allOf:/oneOf: required: X,
required: Y, etc" pattern instead thus getting shorter and a bit easier to
comprehend constructions.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>

---

Note the solution can be shortened out a bit further by replacing the
single-entry allOf statements with just the "not: required: etc" pattern.
But in order to do that the DT-schema validation tool must be fixed like
this:

Comments

Rob Herring March 17, 2023, 8:56 p.m. UTC | #1 
On Tue, Mar 14, 2023 at 01:51:02AM +0300, Serge Semin wrote:
> Currently the Tx/Rx queues properties interdependencies are described by
> means of the pattern: "if: required: X, then: properties: Y: false, Z:
> false, etc". Due to very unfortunate MTL Tx/Rx queue DT-node design the
> resultant sub-nodes schemas look very bulky and thus hard to read. The
> situation can be improved by using the "allOf:/oneOf: required: X,
> required: Y, etc" pattern instead thus getting shorter and a bit easier to
> comprehend constructions.
> 
> Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> 
> ---

Reviewed-by: Rob Herring <robh@kernel.org>

> 
> Note the solution can be shortened out a bit further by replacing the
> single-entry allOf statements with just the "not: required: etc" pattern.
> But in order to do that the DT-schema validation tool must be fixed like
> this:
> 
> --- a/meta-schemas/nodes.yaml	2021-02-08 14:20:56.732447780 +0300
> +++ b/meta-schemas/nodes.yaml	2021-02-08 14:21:00.736492245 +0300
> @@ -22,6 +22,7 @@
>      - unevaluatedProperties
>      - deprecated
>      - required
> +    - not
>      - allOf
>      - anyOf
>      - oneOf

This should be added regardless. Can you send a patch to devicetree-spec 
or a GH PR. But I'd skip using that here for now because then we require 
a new version of dtschema.

Rob
Serge Semin March 23, 2023, 3:10 p.m. UTC | #2 
On Fri, Mar 17, 2023 at 03:56:04PM -0500, Rob Herring wrote:
> On Tue, Mar 14, 2023 at 01:51:02AM +0300, Serge Semin wrote:
> > Currently the Tx/Rx queues properties interdependencies are described by
> > means of the pattern: "if: required: X, then: properties: Y: false, Z:
> > false, etc". Due to very unfortunate MTL Tx/Rx queue DT-node design the
> > resultant sub-nodes schemas look very bulky and thus hard to read. The
> > situation can be improved by using the "allOf:/oneOf: required: X,
> > required: Y, etc" pattern instead thus getting shorter and a bit easier to
> > comprehend constructions.
> > 
> > Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> > 
> > ---
> 
> Reviewed-by: Rob Herring <robh@kernel.org>
> 
> > 
> > Note the solution can be shortened out a bit further by replacing the
> > single-entry allOf statements with just the "not: required: etc" pattern.
> > But in order to do that the DT-schema validation tool must be fixed like
> > this:
> > 
> > --- a/meta-schemas/nodes.yaml	2021-02-08 14:20:56.732447780 +0300
> > +++ b/meta-schemas/nodes.yaml	2021-02-08 14:21:00.736492245 +0300
> > @@ -22,6 +22,7 @@
> >      - unevaluatedProperties
> >      - deprecated
> >      - required
> > +    - not
> >      - allOf
> >      - anyOf
> >      - oneOf
> 

> This should be added regardless. Can you send a patch to devicetree-spec 
> or a GH PR. But I'd skip using that here for now because then we require 
> a new version of dtschema.

Ok. I'll send the patch to the devicetree-spec mailing list.

* Note meta-schemas/base.yaml will be fixed in the similar way.

-Serge(y)

> 
> Rob
diff mbox series

Patch

--- a/meta-schemas/nodes.yaml	2021-02-08 14:20:56.732447780 +0300
+++ b/meta-schemas/nodes.yaml	2021-02-08 14:21:00.736492245 +0300
@@ -22,6 +22,7 @@ 
     - unevaluatedProperties
     - deprecated
     - required
+    - not
     - allOf
     - anyOf
     - oneOf

Thus all the patterns like
allOf:
  - not:
      required:
        - X
could be replaced with just
not:
  required:
    - X
---
 .../devicetree/bindings/net/snps,dwmac.yaml   | 175 +++++++-----------
 1 file changed, 63 insertions(+), 112 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/snps,dwmac.yaml b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
index a863b5860566..9df301cf674e 100644
--- a/Documentation/devicetree/bindings/net/snps,dwmac.yaml
+++ b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
@@ -127,19 +127,6 @@  properties:
         $ref: /schemas/types.yaml#/definitions/flag
         description: Weighted Strict priority
 
-    allOf:
-      - if:
-          required:
-            - snps,rx-sched-sp
-        then:
-          properties:
-            snps,rx-sched-wsp: false
-      - if:
-          required:
-            - snps,rx-sched-wsp
-        then:
-          properties:
-            snps,rx-sched-sp: false
     patternProperties:
       "^queue([0-9]|1[0-1])$":
         description: Each subnode represents a queue.
@@ -185,67 +172,46 @@  properties:
             minimum: 0
             maximum: 0xFF
 
+        additionalProperties: false
+
+        # Choose only one of the bridging algorithm and the packets routing
         allOf:
-          - if:
+          - not:
               required:
                 - snps,dcb-algorithm
-            then:
-              properties:
-                snps,avb-algorithm: false
-          - if:
-              required:
                 - snps,avb-algorithm
-            then:
-              properties:
-                snps,dcb-algorithm: false
-          - if:
-              required:
-                - snps,route-avcp
-            then:
-              properties:
-                snps,route-ptp: false
-                snps,route-dcbcp: false
-                snps,route-up: false
-                snps,route-multi-broad: false
-          - if:
-              required:
-                - snps,route-ptp
-            then:
-              properties:
-                snps,route-avcp: false
-                snps,route-dcbcp: false
-                snps,route-up: false
-                snps,route-multi-broad: false
-          - if:
-              required:
-                - snps,route-dcbcp
-            then:
-              properties:
-                snps,route-avcp: false
-                snps,route-ptp: false
-                snps,route-up: false
-                snps,route-multi-broad: false
-          - if:
-              required:
-                - snps,route-up
-            then:
-              properties:
-                snps,route-avcp: false
-                snps,route-ptp: false
-                snps,route-dcbcp: false
-                snps,route-multi-broad: false
-          - if:
-              required:
-                - snps,route-multi-broad
-            then:
-              properties:
-                snps,route-avcp: false
-                snps,route-ptp: false
-                snps,route-dcbcp: false
-                snps,route-up: false
-        additionalProperties: false
+          - oneOf:
+              - required:
+                  - snps,route-avcp
+              - required:
+                  - snps,route-ptp
+              - required:
+                  - snps,route-dcbcp
+              - required:
+                  - snps,route-up
+              - required:
+                  - snps,route-multi-broad
+              - not:
+                  anyOf:
+                    - required:
+                        - snps,route-avcp
+                    - required:
+                        - snps,route-ptp
+                    - required:
+                        - snps,route-dcbcp
+                    - required:
+                        - snps,route-up
+                    - required:
+                        - snps,route-multi-broad
+
     additionalProperties: false
 
+    allOf:
+      - not:
+          required:
+            - snps,rx-sched-sp
+            - snps,rx-sched-wsp
+
   snps,mtl-tx-config:
     $ref: /schemas/types.yaml#/definitions/phandle
     description:
@@ -279,39 +245,6 @@  properties:
         $ref: /schemas/types.yaml#/definitions/flag
         description: Strict priority
 
-    allOf:
-      - if:
-          required:
-            - snps,tx-sched-wrr
-        then:
-          properties:
-            snps,tx-sched-wfq: false
-            snps,tx-sched-dwrr: false
-            snps,tx-sched-sp: false
-      - if:
-          required:
-            - snps,tx-sched-wfq
-        then:
-          properties:
-            snps,tx-sched-wrr: false
-            snps,tx-sched-dwrr: false
-            snps,tx-sched-sp: false
-      - if:
-          required:
-            - snps,tx-sched-dwrr
-        then:
-          properties:
-            snps,tx-sched-wrr: false
-            snps,tx-sched-wfq: false
-            snps,tx-sched-sp: false
-      - if:
-          required:
-            - snps,tx-sched-sp
-        then:
-          properties:
-            snps,tx-sched-wrr: false
-            snps,tx-sched-wfq: false
-            snps,tx-sched-dwrr: false
     patternProperties:
       "^queue([0-9]|1[0-5])$":
         description: Each subnode represents a queue.
@@ -380,23 +313,41 @@  properties:
             minimum: 0
             maximum: 0xFF
 
+        additionalProperties: false
+
+        # Choose only one of the Queue TC algo
         allOf:
-          - if:
+          - not:
               required:
                 - snps,dcb-algorithm
-            then:
-              properties:
-                snps,avb-algorithm: false
-          - if:
-              required:
                 - snps,avb-algorithm
-            then:
-              properties:
-                snps,dcb-algorithm: false
-                snps,weight: false
-        additionalProperties: false
+
+        dependencies:
+          snps,weight: ["snps,dcb-algorithm"]
+
     additionalProperties: false
 
+    # Choose one of the TX scheduling algorithms
+    oneOf:
+      - required:
+          - snps,tx-sched-wrr
+      - required:
+          - snps,tx-sched-wfq
+      - required:
+          - snps,tx-sched-dwrr
+      - required:
+          - snps,tx-sched-sp
+      - not:
+          anyOf:
+            - required:
+                - snps,tx-sched-wrr
+            - required:
+                - snps,tx-sched-wfq
+            - required:
+                - snps,tx-sched-dwrr
+            - required:
+                - snps,tx-sched-sp
+
   snps,reset-gpio:
     deprecated: true
     maxItems: 1