Documentation/devicetree/bindings/net/ethernet-phy-package.yaml

# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/net/ethernet-phy-package.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Ethernet PHY Package Common Properties

maintainers:
  - Christian Marangi <ansuelsmth@gmail.com>

description:
  PHY packages are multi-port Ethernet PHY of the same family
  and each Ethernet PHY is affected by the global configuration
  of the PHY package.

  Each reg of the PHYs defined in the PHY package node is
  absolute and describe the real address of the Ethernet PHY on
  the MDIO bus.

properties:
  $nodename:
    pattern: "^ethernet-phy-package@[a-f0-9]+$"

  reg:
    minimum: 0
    maximum: 31
    description:
      The base ID number for the PHY package.
      Commonly the ID of the first PHY in the PHY package.

      Some PHY in the PHY package might be not defined but
      still occupy ID on the device (just not attached to
      anything) hence the PHY package reg might correspond
      to a not attached PHY (offset 0).

  '#address-cells':
    const: 1

  '#size-cells':
    const: 0

patternProperties:
  ^ethernet-phy@[a-f0-9]+$:
    $ref: ethernet-phy.yaml#

required:
  - reg
  - '#address-cells'
  - '#size-cells'

additionalProperties: true