[PATCH 05/20] dt-bindings: net: Add the old DT bindings for "fixed-link"

[Ramon Fried]

On Tue, Mar 2, 2021 at 5:36 PM Bin Meng <bmeng.cn at gmail.com> wrote:
>
> Per the upstream Linux kernel doc:
>
>   Documentation/devicetree/bindings/net/ethernet-controller.yaml
>
> There are two ways to describe a fixed PHY attached to an Ethernet
> device. This updates our dt-bindings doc to add the old DT bindings.
>
> Signed-off-by: Bin Meng <bmeng.cn at gmail.com>
> ---
>
>  doc/device-tree-bindings/net/fixed-link.txt | 47 +++++++++++++++------
>  1 file changed, 35 insertions(+), 12 deletions(-)
>
> diff --git a/doc/device-tree-bindings/net/fixed-link.txt b/doc/device-tree-bindings/net/fixed-link.txt
> index 5829bd81a2..71ab480701 100644
> --- a/doc/device-tree-bindings/net/fixed-link.txt
> +++ b/doc/device-tree-bindings/net/fixed-link.txt
> @@ -5,21 +5,36 @@ Some Ethernet MACs have a "fixed link", and are not connected to a
>  normal MDIO-managed PHY device. For those situations, a Device Tree
>  binding allows to describe a "fixed link".
>
> -Such a fixed link situation is described by creating a 'fixed-link'
> -sub-node of the Ethernet MAC device node, with the following
> -properties:
> -
> -* 'speed' (integer, mandatory), to indicate the link speed. Accepted
> -  values are 10, 100 and 1000
> -* 'full-duplex' (boolean, optional), to indicate that full duplex is
> -  used. When absent, half duplex is assumed.
> -* 'pause' (boolean, optional), to indicate that pause should be
> -  enabled.
> -* 'asym-pause' (boolean, optional), to indicate that asym_pause should
> -  be enabled.
> +Note there are two ways to describe a fixed PHY attached to an
> +Ethernet device:
> +
> +- The new DT binding, where 'fixed-link' is a sub-node of the Ethernet
> +  MAC device node, with the following properties:
> +
> +  * 'speed' (integer, mandatory), to indicate the link speed. Accepted
> +    values are 10, 100 and 1000
> +  * 'full-duplex' (boolean, optional), to indicate that full duplex is
> +    used. When absent, half duplex is assumed.
> +  * 'pause' (boolean, optional), to indicate that pause should be
> +    enabled.
> +  * 'asym-pause' (boolean, optional), to indicate that asym_pause should
> +    be enabled.
> +
> +- The old DT binding, where 'fixed-link' is a property with 5 cells
> +  encoding various information about the fixed PHY, in the form of
> +  <phy_id, full-duplex, speed, pause, asym-pause>.
> +
> +  * 'phy_id', emulated PHY ID, choose any but unique to the all specified
> +    fixed-links
> +  * 'full-duplex', 0 for half duplex or 1 for full duplex
> +  * 'speed', link speed in Mbits/sec, accepts only 10, 100 and 1000
> +  * 'pause', 0 for no pause, 1 for pause
> +  * 'asym-pause', 0 for no asymmetric pause, 1 for asymmetric pause
>
>  Examples:
>
> +The new binding:
> +
>  ethernet at 0 {
>         ...
>         fixed-link {
> @@ -28,3 +43,11 @@ ethernet at 0 {
>         };
>         ...
>  };
> +
> +The old binding:
> +
> +ethernet at 0 {
> +       ...
> +       fixed-link = <0 1 1000 0 0>;
> +       ...
> +};
> --
> 2.25.1
>
Reviewed-By: Ramon Fried <rfried.dev at gmail.com>