netdev - Re: [PATCH net-next 04/10] Documentation: networking: ethtool-netlink: Add link extended state

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200624203117.m5wnove437p775mb@lion.mk-sys.cz>
Date:   Wed, 24 Jun 2020 22:31:17 +0200
From:   Michal Kubecek <mkubecek@...e.cz>
To:     netdev@...r.kernel.org
Cc:     Ido Schimmel <idosch@...sch.org>, davem@...emloft.net,
        kuba@...nel.org, jiri@...lanox.com, petrm@...lanox.com,
        amitc@...lanox.com, mlxsw@...lanox.com, jacob.e.keller@...el.com,
        andrew@...n.ch, f.fainelli@...il.com, linux@...pel-privat.de,
        Ido Schimmel <idosch@...lanox.com>
Subject: Re: [PATCH net-next 04/10] Documentation: networking:
 ethtool-netlink: Add link extended state

On Wed, Jun 24, 2020 at 11:19:17AM +0300, Ido Schimmel wrote:
> From: Amit Cohen <amitc@...lanox.com>
> 
> Add link extended state attributes.
> 
> Signed-off-by: Amit Cohen <amitc@...lanox.com>
> Reviewed-by: Petr Machata <petrm@...lanox.com>
> Reviewed-by: Jiri Pirko <jiri@...lanox.com>
> Signed-off-by: Ido Schimmel <idosch@...lanox.com>
> ---
>  Documentation/networking/ethtool-netlink.rst | 110 ++++++++++++++++++-
>  1 file changed, 106 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
> index 82470c36c27a..a7cc53f905f5 100644
> --- a/Documentation/networking/ethtool-netlink.rst
> +++ b/Documentation/networking/ethtool-netlink.rst
> @@ -443,10 +443,11 @@ supports.
>  LINKSTATE_GET
>  =============
>  
> -Requests link state information. At the moment, only link up/down flag (as
> -provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future
> -extensions are planned (e.g. link down reason). This request does not have any
> -attributes.
> +Requests link state information. Link up/down flag (as provided by
> +``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
> +be provided as well. In general, extended state describes reasons for why a port
> +is down, or why it operates in some non-obvious mode. This request does not have
> +any attributes.
>  
>  Request contents:
>  
> @@ -461,16 +462,117 @@ Kernel response contents:
>    ``ETHTOOL_A_LINKSTATE_LINK``          bool    link state (up/down)
>    ``ETHTOOL_A_LINKSTATE_SQI``           u32     Current Signal Quality Index
>    ``ETHTOOL_A_LINKSTATE_SQI_MAX``       u32     Max support SQI value
> +  ``ETHTOOL_A_LINKSTATE_EXT_STATE``     u8      link extended state
> +  ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``  u8      link extended substate
>    ====================================  ======  ============================
>  
>  For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
>  carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
>  define their own handler.
>  
> +``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
> +optional values. ethtool core can provide either both
> +``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
> +or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
> +
>  ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
>  devices supporting the request).
>  
>  
> +Link extended states:
> +
> +  ============================    =============================================
> +  ``Autoneg``                     States relating to the autonegotiation or
> +                                  issues therein
> +
> +  ``Link training failure``       Failure during link training
> +
> +  ``Link logical mismatch``       Logical mismatch in physical coding sublayer
> +                                  or forward error correction sublayer
> +
> +  ``Bad signal integrity``        Signal integrity issues
> +
> +  ``No cable``                    No cable connected
> +
> +  ``Cable issue``                 Failure is related to cable,
> +                                  e.g., unsupported cable
> +
> +  ``EEPROM issue``                Failure is related to EEPROM, e.g., failure
> +                                  during reading or parsing the data
> +
> +  ``Calibration failure``         Failure during calibration algorithm
> +
> +  ``Power budget exceeded``       The hardware is not able to provide the
> +                                  power required from cable or module
> +
> +  ``Overheat``                    The module is overheated
> +  ============================    =============================================

This file's primary purpose is to serve as kernel-userspace API
documentation so the table should IMHO show the ETHTOOL_LINK_EXT_STATE_*
constants. (And so should the substates tables below.)

Michal