Re: [PATCH net-next] i40e: Align devlink info versions with ice driver and add docs

[Jacob Keller <jacob.e.keller@intel.com>]

On 10/18/2023 5:35 AM, Ivan Vecera wrote:
> Align devlink info versions with ice driver so change 'fw.mgmt'
> version to be 2-digit version [major.minor], add 'fw.mgmt.build'
> that reports mgmt firmware build number and use '"fw.psid.api'
> for NVM format version instead of incorrect '"fw.psid'.
> Additionally add missing i40e devlink documentation.
> 
> Fixes: 5a423552e0d9 ("i40e: Add handler for devlink .info_get")
> Cc: Jacob Keller <jacob.e.keller@intel.com>
> Signed-off-by: Ivan Vecera <ivecera@redhat.com>
> ---

Great, thanks for cleaning this up.

Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>

I'm happy for this to go straight to net-next without queuing in
iwl-next since the relevant i40e series also just merged there last
weekend :)

Thanks,
Jake

>  Documentation/networking/devlink/i40e.rst     | 59 +++++++++++++++++++
>  Documentation/networking/devlink/index.rst    |  1 +
>  .../net/ethernet/intel/i40e/i40e_devlink.c    | 18 +++++-
>  3 files changed, 75 insertions(+), 3 deletions(-)
>  create mode 100644 Documentation/networking/devlink/i40e.rst
> 
> diff --git a/Documentation/networking/devlink/i40e.rst b/Documentation/networking/devlink/i40e.rst
> new file mode 100644
> index 000000000000..d3cb5bb5197e
> --- /dev/null
> +++ b/Documentation/networking/devlink/i40e.rst
> @@ -0,0 +1,59 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +====================
> +i40e devlink support
> +====================
> +
> +This document describes the devlink features implemented by the ``i40e``
> +device driver.
> +
> +Info versions
> +=============
> +
> +The ``i40e`` driver reports the following versions
> +
> +.. list-table:: devlink info versions implemented
> +    :widths: 5 5 5 90
> +
> +    * - Name
> +      - Type
> +      - Example
> +      - Description
> +    * - ``board.id``
> +      - fixed
> +      - K15190-000
> +      - The Product Board Assembly (PBA) identifier of the board.
> +    * - ``fw.mgmt``
> +      - running
> +      - 9.130
> +      - 2-digit version number of the management firmware that controls the
> +        PHY, link, etc.
> +    * - ``fw.mgmt.api``
> +      - running
> +      - 1.15
> +      - 2-digit version number of the API exported over the AdminQ by the
> +        management firmware. Used by the driver to identify what commands
> +        are supported.
> +    * - ``fw.mgmt.build``
> +      - running
> +      - 73618
> +      - Build number of the source for the management firmware.
> +    * - ``fw.undi``
> +      - running
> +      - 1.3429.0
> +      - Version of the Option ROM containing the UEFI driver. The version is
> +        reported in ``major.minor.patch`` format. The major version is
> +        incremented whenever a major breaking change occurs, or when the
> +        minor version would overflow. The minor version is incremented for
> +        non-breaking changes and reset to 1 when the major version is
> +        incremented. The patch version is normally 0 but is incremented when
> +        a fix is delivered as a patch against an older base Option ROM.
> +    * - ``fw.psid.api``
> +      - running
> +      - 9.30
> +      - Version defining the format of the flash contents.
> +    * - ``fw.bundle_id``
> +      - running
> +      - 0x8000e5f3
> +      - Unique identifier of the firmware image file that was loaded onto
> +        the device. Also referred to as the EETRACK identifier of the NVM.
> diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
> index b49749e2b9a6..2b78060aaa58 100644
> --- a/Documentation/networking/devlink/index.rst
> +++ b/Documentation/networking/devlink/index.rst
> @@ -52,6 +52,7 @@ parameters, info versions, and other features it supports.
>     bnxt
>     etas_es58x
>     hns3
> +   i40e
>     ionic
>     ice
>     mlx4
> diff --git a/drivers/net/ethernet/intel/i40e/i40e_devlink.c b/drivers/net/ethernet/intel/i40e/i40e_devlink.c
> index 9168ade8da47..74bc111b4849 100644
> --- a/drivers/net/ethernet/intel/i40e/i40e_devlink.c
> +++ b/drivers/net/ethernet/intel/i40e/i40e_devlink.c
> @@ -18,8 +18,14 @@ static void i40e_info_fw_mgmt(struct i40e_hw *hw, char *buf, size_t len)
>  {
>  	struct i40e_adminq_info *aq = &hw->aq;
>  
> -	snprintf(buf, len, "%u.%u.%05d",
> -		 aq->fw_maj_ver, aq->fw_min_ver, aq->fw_build);
> +	snprintf(buf, len, "%u.%u", aq->fw_maj_ver, aq->fw_min_ver);
> +}
> +
> +static void i40e_info_fw_mgmt_build(struct i40e_hw *hw, char *buf, size_t len)
> +{
> +	struct i40e_adminq_info *aq = &hw->aq;
> +
> +	snprintf(buf, len, "%05d", aq->fw_build);
>  }
>  
>  static void i40e_info_fw_api(struct i40e_hw *hw, char *buf, size_t len)
> @@ -77,6 +83,12 @@ static int i40e_devlink_info_get(struct devlink *dl,
>  	if (err)
>  		return err;
>  
> +	i40e_info_fw_mgmt_build(hw, buf, sizeof(buf));
> +	err = i40e_devlink_info_put(req, I40E_DL_VERSION_RUNNING,
> +				    "fw.mgmt.build", buf);
> +	if (err)
> +		return err;
> +
>  	i40e_info_fw_api(hw, buf, sizeof(buf));
>  	err = i40e_devlink_info_put(req, I40E_DL_VERSION_RUNNING,
>  				    DEVLINK_INFO_VERSION_GENERIC_FW_MGMT_API,
> @@ -86,7 +98,7 @@ static int i40e_devlink_info_get(struct devlink *dl,
>  
>  	i40e_info_nvm_ver(hw, buf, sizeof(buf));
>  	err = i40e_devlink_info_put(req, I40E_DL_VERSION_RUNNING,
> -				    DEVLINK_INFO_VERSION_GENERIC_FW_PSID, buf);
> +				    "fw.psid.api", buf);
>  	if (err)
>  		return err;
>