Documentation/devicetree/bindings/phy/brcm,cygnus-pcie-phy.yaml

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

title: Broadcom Cygnus PCIe PHY

maintainers:
  - Ray Jui <ray.jui@broadcom.com>
  - Scott Branden <scott.branden@broadcom.com>

properties:
  $nodename:
    pattern: "^pcie[-|_]phy(@.*)?$"

  compatible:
    items:
      - const: brcm,cygnus-pcie-phy

  reg:
    maxItems: 1
    description: >
      Base address and length of the PCIe PHY block

  "#address-cells":
    const: 1

  "#size-cells":
    const: 0

patternProperties:
  "^pcie-phy@[0-9]+$":
    type: object
    additionalProperties: false
    description: >
      PCIe PHY child nodes

    properties:
      reg:
        maxItems: 1
        description: >
          The PCIe PHY port number

      "#phy-cells":
        const: 0

    required:
      - reg
      - "#phy-cells"

required:
  - compatible
  - reg
  - "#address-cells"
  - "#size-cells"

additionalProperties: false

examples:
  - |
    pcie_phy: pcie_phy@301d0a0 {
      compatible = "brcm,cygnus-pcie-phy";
      reg = <0x0301d0a0 0x14>;
      #address-cells = <1>;
      #size-cells = <0>;

      pcie0_phy: pcie-phy@0 {
          reg = <0>;
          #phy-cells = <0>;
      };

      pcie1_phy: pcie-phy@1 {
          reg = <1>;
          #phy-cells = <0>;
      };
    };