2022-12-10 03:40:27

by Colin Foster

[permalink] [raw]
Subject: [PATCH v5 net-next 02/10] dt-bindings: net: dsa: sf2: fix brcm,use-bcm-hdr documentation

The property use-bcm-hdr was documented as an entry under the ports node
for the bcm_sf2 DSA switch. This property is actually evaluated for each
port. Correct the documentation to match the actual behavior and properly
reference dsa-port.yaml for additional properties of the node.

Suggested-by: Rob Herring <[email protected]>
Signed-off-by: Colin Foster <[email protected]>
Acked-by: Florian Fainelli <[email protected]>
Reviewed-by: Rob Herring <[email protected]>
---

v4 -> v5
* No change

v3 -> v4
* Add Acked and Reviewed tags

v3
* New patch

---
.../devicetree/bindings/net/dsa/brcm,sf2.yaml | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/dsa/brcm,sf2.yaml b/Documentation/devicetree/bindings/net/dsa/brcm,sf2.yaml
index d159ac78cec1..eed16e216fb6 100644
--- a/Documentation/devicetree/bindings/net/dsa/brcm,sf2.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/brcm,sf2.yaml
@@ -85,11 +85,16 @@ properties:
ports:
type: object

- properties:
- brcm,use-bcm-hdr:
- description: if present, indicates that the switch port has Broadcom
- tags enabled (per-packet metadata)
- type: boolean
+ patternProperties:
+ '^port@[0-9a-f]$':
+ $ref: dsa-port.yaml#
+ unevaluatedProperties: false
+
+ properties:
+ brcm,use-bcm-hdr:
+ description: if present, indicates that the switch port has Broadcom
+ tags enabled (per-packet metadata)
+ type: boolean

required:
- reg
--
2.25.1


2022-12-12 18:52:14

by Vladimir Oltean

[permalink] [raw]
Subject: Re: [PATCH v5 net-next 02/10] dt-bindings: net: dsa: sf2: fix brcm,use-bcm-hdr documentation

On Fri, Dec 09, 2022 at 07:30:25PM -0800, Colin Foster wrote:
> The property use-bcm-hdr was documented as an entry under the ports node
> for the bcm_sf2 DSA switch. This property is actually evaluated for each
> port. Correct the documentation to match the actual behavior and properly
> reference dsa-port.yaml for additional properties of the node.
>
> Suggested-by: Rob Herring <[email protected]>
> Signed-off-by: Colin Foster <[email protected]>
> Acked-by: Florian Fainelli <[email protected]>
> Reviewed-by: Rob Herring <[email protected]>
> ---

Reviewed-by: Vladimir Oltean <[email protected]>