| Message ID | 20250318-dt-bindings-network-class-v3-1-4d8d04ddfb61@ixit.cz (mailing list archive) |
|---|---|
| State | New |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | dt-bindings: net: Add network-class.yaml schema | expand |
On Tue, Mar 18, 2025 at 08:56:44PM +0100, David Heidelberg wrote: > From: Janne Grunau <j@jannau.net> > > The ethernet-controller schema specifies "mac-address" and > "local-mac-address" but other network devices such as wireless network > adapters use mac addresses as well. > The Devicetree Specification, Release v0.3 specifies in section 4.3.1 > a generic "Network Class Binding" with "address-bits", "mac-address", > "local-mac-address" and "max-frame-size". This schema specifies the > "address-bits" property and moves the remaining properties over from > the ethernet-controller.yaml schema. > > The "max-frame-size" property is used to describe the maximal payload > size despite its name. Keep the description from ethernet-controller > specifying this property as MTU. The contradictory description in the > Devicetree Specification is ignored. > > Signed-off-by: Janne Grunau <j@jannau.net> > --- > .../bindings/net/ethernet-controller.yaml | 25 +----------- > .../devicetree/bindings/net/network-class.yaml | 44 ++++++++++++++++++++++ > 2 files changed, 45 insertions(+), 24 deletions(-) > > diff --git a/Documentation/devicetree/bindings/net/ethernet-controller.yaml b/Documentation/devicetree/bindings/net/ethernet-controller.yaml > index 45819b2358002bc75e876eddb4b2ca18017c04bd..c91b41b83d1dc1294e99ec72c7cdcc16550cb33e 100644 > --- a/Documentation/devicetree/bindings/net/ethernet-controller.yaml > +++ b/Documentation/devicetree/bindings/net/ethernet-controller.yaml > @@ -16,30 +16,6 @@ properties: > label: > description: Human readable label on a port of a box. > > - local-mac-address: > - description: > - Specifies the MAC address that was assigned to the network device. > - $ref: /schemas/types.yaml#/definitions/uint8-array > - minItems: 6 > - maxItems: 6 > - > - mac-address: > - description: > - Specifies the MAC address that was last used by the boot > - program; should be used in cases where the MAC address assigned > - to the device by the boot program is different from the > - local-mac-address property. > - $ref: /schemas/types.yaml#/definitions/uint8-array > - minItems: 6 > - maxItems: 6 > - > - max-frame-size: > - $ref: /schemas/types.yaml#/definitions/uint32 > - description: > - Maximum transfer unit (IEEE defined MTU), rather than the > - maximum frame size (there\'s contradiction in the Devicetree > - Specification). > - > max-speed: > $ref: /schemas/types.yaml#/definitions/uint32 > description: > @@ -262,6 +238,7 @@ dependencies: > pcs-handle-names: [pcs-handle] > > allOf: > + - $ref: /schemas/net/network-class.yaml# > - if: > properties: > phy-mode: > diff --git a/Documentation/devicetree/bindings/net/network-class.yaml b/Documentation/devicetree/bindings/net/network-class.yaml > new file mode 100644 > index 0000000000000000000000000000000000000000..e126a02193e8cfba24215d3c850fde1e1b26480e > --- /dev/null > +++ b/Documentation/devicetree/bindings/net/network-class.yaml > @@ -0,0 +1,44 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/net/network-class.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Network Class Common Properties > + > +maintainers: > + - Devicetree Specification Mailing List <devicetree-spec-u79uwXL29TY76Z2rM5mHXA@public.gmane.org> Just 'devicetree-spec@vger.kernel.org' > + > +properties: > + address-bits: > + description: > + Specifies number of address bits required to address the device described > + by this node. This property specifies number of bits in MAC address. > + default: 48 > + const: 48 > + > + local-mac-address: > + description: > + Specifies MAC address that was assigned to the network device described by > + the node containing this property. > + $ref: /schemas/types.yaml#/definitions/uint8-array > + minItems: 6 > + maxItems: 6 > + > + mac-address: > + description: > + Specifies the MAC address that was last used by the boot program. This > + property should be used in cases where the MAC address assigned to the > + device by the boot program is different from the > + local-mac-address property. This property shall be used only if the value > + differs from local-mac-address property value. > + $ref: /schemas/types.yaml#/definitions/uint8-array > + minItems: 6 > + maxItems: 6 > + > + max-frame-size: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: > + Maximum transfer unit (IEEE defined MTU). Can we keep the rest of the description about the contradiction? > + > +additionalProperties: true > > -- > 2.49.0 >
diff --git a/Documentation/devicetree/bindings/net/ethernet-controller.yaml b/Documentation/devicetree/bindings/net/ethernet-controller.yaml index 45819b2358002bc75e876eddb4b2ca18017c04bd..c91b41b83d1dc1294e99ec72c7cdcc16550cb33e 100644 --- a/Documentation/devicetree/bindings/net/ethernet-controller.yaml +++ b/Documentation/devicetree/bindings/net/ethernet-controller.yaml @@ -16,30 +16,6 @@ properties: label: description: Human readable label on a port of a box. - local-mac-address: - description: - Specifies the MAC address that was assigned to the network device. - $ref: /schemas/types.yaml#/definitions/uint8-array - minItems: 6 - maxItems: 6 - - mac-address: - description: - Specifies the MAC address that was last used by the boot - program; should be used in cases where the MAC address assigned - to the device by the boot program is different from the - local-mac-address property. - $ref: /schemas/types.yaml#/definitions/uint8-array - minItems: 6 - maxItems: 6 - - max-frame-size: - $ref: /schemas/types.yaml#/definitions/uint32 - description: - Maximum transfer unit (IEEE defined MTU), rather than the - maximum frame size (there\'s contradiction in the Devicetree - Specification). - max-speed: $ref: /schemas/types.yaml#/definitions/uint32 description: @@ -262,6 +238,7 @@ dependencies: pcs-handle-names: [pcs-handle] allOf: + - $ref: /schemas/net/network-class.yaml# - if: properties: phy-mode: diff --git a/Documentation/devicetree/bindings/net/network-class.yaml b/Documentation/devicetree/bindings/net/network-class.yaml new file mode 100644 index 0000000000000000000000000000000000000000..e126a02193e8cfba24215d3c850fde1e1b26480e --- /dev/null +++ b/Documentation/devicetree/bindings/net/network-class.yaml @@ -0,0 +1,44 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/net/network-class.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Network Class Common Properties + +maintainers: + - Devicetree Specification Mailing List <devicetree-spec-u79uwXL29TY76Z2rM5mHXA@public.gmane.org> + +properties: + address-bits: + description: + Specifies number of address bits required to address the device described + by this node. This property specifies number of bits in MAC address. + default: 48 + const: 48 + + local-mac-address: + description: + Specifies MAC address that was assigned to the network device described by + the node containing this property. + $ref: /schemas/types.yaml#/definitions/uint8-array + minItems: 6 + maxItems: 6 + + mac-address: + description: + Specifies the MAC address that was last used by the boot program. This + property should be used in cases where the MAC address assigned to the + device by the boot program is different from the + local-mac-address property. This property shall be used only if the value + differs from local-mac-address property value. + $ref: /schemas/types.yaml#/definitions/uint8-array + minItems: 6 + maxItems: 6 + + max-frame-size: + $ref: /schemas/types.yaml#/definitions/uint32 + description: + Maximum transfer unit (IEEE defined MTU). + +additionalProperties: true