dt-bindings: net: ftgmac100: convert to yaml version from txt

# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/net/faraday,ftgmac100.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Faraday Technology FTGMAC100 gigabit ethernet controller

allOf:

  - $ref: ethernet-controller.yaml#

maintainers:

  - Po-Yu Chuang <ratbert@faraday-tech.com>

properties:

  compatible:

    oneOf:

      - const: faraday,ftgmac100

      - items:

          - enum:

              - aspeed,ast2400-mac

              - aspeed,ast2500-mac

              - aspeed,ast2600-mac

          - const: faraday,ftgmac100

  reg:

    maxItems: 1

  interrupts:

    maxItems: 1

  clocks:

    minItems: 1

    items:

      - description: MAC IP clock

      - description: RMII RCLK gate for AST2500/2600

  clock-names:

    minItems: 1

    items:

      - const: MACCLK

      - const: RCLK

  phy-mode:

    enum:

      - rgmii

      - rmii

  phy-handle: true

  use-ncsi:

    description:

      Use the NC-SI stack instead of an MDIO PHY. Currently assumes

      rmii (100bT) but kept as a separate property in case NC-SI grows support

      for a gigabit link.

    type: boolean

  no-hw-checksum:

    description:

      Used to disable HW checksum support. Here for backward

      compatibility as the driver now should have correct defaults based on

      the SoC.

    type: boolean

    deprecated: true

  mdio:

    $ref: /schemas/net/mdio.yaml#

required:

  - compatible

  - reg

  - interrupts

unevaluatedProperties: false

examples:

  - |

    ethernet@1e660000 {

        compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";

        reg = <0x1e660000 0x180>;

        interrupts = <2>;

        use-ncsi;

    };

    ethernet@1e680000 {

        compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";

        reg = <0x1e680000 0x180>;

        interrupts = <2>;

        phy-handle = <&phy>;

        phy-mode = "rgmii";

        mdio {

            #address-cells = <1>;

            #size-cells = <0>;

            phy: ethernet-phy@1 {

                compatible = "ethernet-phy-ieee802.3-c22";

                reg = <1>;

            };

        };

    };

* Faraday Technology FTGMAC100 gigabit ethernet controller

Required properties:

- compatible: "faraday,ftgmac100"

  Must also contain one of these if used as part of an Aspeed AST2400

  or 2500 family SoC as they have some subtle tweaks to the

  implementation:

     - "aspeed,ast2400-mac"

     - "aspeed,ast2500-mac"

     - "aspeed,ast2600-mac"

- reg: Address and length of the register set for the device

- interrupts: Should contain ethernet controller interrupt

Optional properties:

- phy-handle: See ethernet.txt file in the same directory.

- phy-mode: See ethernet.txt file in the same directory. If the property is

  absent, "rgmii" is assumed. Supported values are "rgmii*" and "rmii" for

  aspeed parts. Other (unknown) parts will accept any value.

- use-ncsi: Use the NC-SI stack instead of an MDIO PHY. Currently assumes

  rmii (100bT) but kept as a separate property in case NC-SI grows support

  for a gigabit link.

- no-hw-checksum: Used to disable HW checksum support. Here for backward

  compatibility as the driver now should have correct defaults based on

  the SoC.

- clocks: In accordance with the generic clock bindings. Must describe the MAC

  IP clock, and optionally an RMII RCLK gate for the AST2500/AST2600. The

  required MAC clock must be the first cell.

- clock-names:

      - "MACCLK": The MAC IP clock

      - "RCLK": Clock gate for the RMII RCLK

Optional subnodes:

- mdio: See mdio.txt file in the same directory.

Example:

	mac0: ethernet@1e660000 {

		compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";

		reg = <0x1e660000 0x180>;

		interrupts = <2>;

		use-ncsi;

	};

Example with phy-handle:

	mac1: ethernet@1e680000 {

		compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";

		reg = <0x1e680000 0x180>;

		interrupts = <2>;

		phy-handle = <&phy>;

		phy-mode = "rgmii";

		mdio {

			#address-cells = <1>;

			#size-cells = <0>;

			phy: ethernet-phy@1 {

				compatible = "ethernet-phy-ieee802.3-c22";

				reg = <1>;

			};

		};

	};