Commit 1515a1b8 authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'add-framework-for-selftests-in-devlink' 

Vikas Gupta says:

====================
add framework for selftests in devlink

Add support for selftests in the devlink framework.
Adds a callback .selftests_check and .selftests_run in devlink_ops.
User can add test(s) suite which is subsequently passed to the driver
and driver can opt for running particular tests based on its capabilities.

Patchset adds a flash based test for the bnxt_en driver.
====================

Link: https://lore.kernel.org/r/20220727165721.37959-1-vikas.gupta@broadcom.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents 68be7b82 5b6ff128

Documentation/networking/devlink/devlink-selftests.rst

0 → 100644
+38 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)



=================

Devlink Selftests

=================



The ``devlink-selftests`` API allows executing selftests on the device.



Tests Mask

==========

The ``devlink-selftests`` command should be run with a mask indicating

the tests to be executed.



Tests Description

=================

The following is a list of tests that drivers may execute.



.. list-table:: List of tests

   :widths: 5 90



   * - Name

     - Description

   * - ``DEVLINK_SELFTEST_FLASH``

     - Devices may have the firmware on non-volatile memory on the board, e.g.

       flash. This particular test helps to run a flash selftest on the device.

       Implementation of the test is left to the driver/firmware.



example usage

-------------



.. code:: shell



    # Query selftests supported on the devlink device

    $ devlink dev selftests show DEV

    # Query selftests supported on all devlink devices

    $ devlink dev selftests show

    # Executes selftests on the device

    $ devlink dev selftests run DEV id flash

drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c

+61 −0
Original line number Diff line number Diff line
@@ -20,6 +20,8 @@ 
#include "bnxt_ulp.h"

#include "bnxt_ptp.h"

#include "bnxt_coredump.h"

#include "bnxt_nvm_defs.h"

#include "bnxt_ethtool.h"



static void __bnxt_fw_recover(struct bnxt *bp)

{
@@ -610,6 +612,63 @@ static int bnxt_dl_reload_up(struct devlink *dl, enum devlink_reload_action acti 
	return rc;

}



static bool bnxt_nvm_test(struct bnxt *bp, struct netlink_ext_ack *extack)

{

	u32 datalen;

	u16 index;

	u8 *buf;



	if (bnxt_find_nvram_item(bp->dev, BNX_DIR_TYPE_VPD,

				 BNX_DIR_ORDINAL_FIRST, BNX_DIR_EXT_NONE,

				 &index, NULL, &datalen) || !datalen) {

		NL_SET_ERR_MSG_MOD(extack, "nvm test vpd entry error");

		return false;

	}



	buf = kzalloc(datalen, GFP_KERNEL);

	if (!buf) {

		NL_SET_ERR_MSG_MOD(extack, "insufficient memory for nvm test");

		return false;

	}



	if (bnxt_get_nvram_item(bp->dev, index, 0, datalen, buf)) {

		NL_SET_ERR_MSG_MOD(extack, "nvm test vpd read error");

		goto err;

	}



	if (bnxt_flash_nvram(bp->dev, BNX_DIR_TYPE_VPD, BNX_DIR_ORDINAL_FIRST,

			     BNX_DIR_EXT_NONE, 0, 0, buf, datalen)) {

		NL_SET_ERR_MSG_MOD(extack, "nvm test vpd write error");

		goto err;

	}



	return true;



err:

	kfree(buf);

	return false;

}



static bool bnxt_dl_selftest_check(struct devlink *dl, unsigned int id,

				   struct netlink_ext_ack *extack)

{

	return id == DEVLINK_ATTR_SELFTEST_ID_FLASH;

}



static enum devlink_selftest_status bnxt_dl_selftest_run(struct devlink *dl,

							 unsigned int id,

							 struct netlink_ext_ack *extack)

{

	struct bnxt *bp = bnxt_get_bp_from_dl(dl);



	if (id == DEVLINK_ATTR_SELFTEST_ID_FLASH)

		return bnxt_nvm_test(bp, extack) ?

				DEVLINK_SELFTEST_STATUS_PASS :

				DEVLINK_SELFTEST_STATUS_FAIL;



	return DEVLINK_SELFTEST_STATUS_SKIP;

}



static const struct devlink_ops bnxt_dl_ops = {

#ifdef CONFIG_BNXT_SRIOV

	.eswitch_mode_set = bnxt_dl_eswitch_mode_set,
@@ -622,6 +681,8 @@ static const struct devlink_ops bnxt_dl_ops = { 
	.reload_limits	  = BIT(DEVLINK_RELOAD_LIMIT_NO_RESET),

	.reload_down	  = bnxt_dl_reload_down,

	.reload_up	  = bnxt_dl_reload_up,

	.selftest_check	  = bnxt_dl_selftest_check,

	.selftest_run	  = bnxt_dl_selftest_run,

};



static const struct devlink_ops bnxt_vf_dl_ops;

drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c

+12 −12
Original line number Diff line number Diff line
@@ -2176,11 +2176,11 @@ static void bnxt_print_admin_err(struct bnxt *bp) 
	netdev_info(bp->dev, "PF does not have admin privileges to flash or reset the device\n");

}



static int bnxt_find_nvram_item(struct net_device *dev, u16 type, u16 ordinal,

int bnxt_find_nvram_item(struct net_device *dev, u16 type, u16 ordinal,

			 u16 ext, u16 *index, u32 *item_length,

			 u32 *data_length);



static int bnxt_flash_nvram(struct net_device *dev, u16 dir_type,

int bnxt_flash_nvram(struct net_device *dev, u16 dir_type,

		     u16 dir_ordinal, u16 dir_ext, u16 dir_attr,

		     u32 dir_item_len, const u8 *data,

		     size_t data_len)
@@ -2836,7 +2836,7 @@ static int bnxt_get_nvram_directory(struct net_device *dev, u32 len, u8 *data) 
	return rc;

}



static int bnxt_get_nvram_item(struct net_device *dev, u32 index, u32 offset,

int bnxt_get_nvram_item(struct net_device *dev, u32 index, u32 offset,

			u32 length, u8 *data)

{

	struct bnxt *bp = netdev_priv(dev);
@@ -2871,7 +2871,7 @@ static int bnxt_get_nvram_item(struct net_device *dev, u32 index, u32 offset, 
	return rc;

}



static int bnxt_find_nvram_item(struct net_device *dev, u16 type, u16 ordinal,

int bnxt_find_nvram_item(struct net_device *dev, u16 type, u16 ordinal,

			 u16 ext, u16 *index, u32 *item_length,

			 u32 *data_length)

{

drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.h

+12 −0
Original line number Diff line number Diff line
@@ -58,5 +58,17 @@ int bnxt_flash_package_from_fw_obj(struct net_device *dev, const struct firmware 
int bnxt_get_pkginfo(struct net_device *dev, char *ver, int size);

void bnxt_ethtool_init(struct bnxt *bp);

void bnxt_ethtool_free(struct bnxt *bp);

int bnxt_find_nvram_item(struct net_device *dev, u16 type, u16 ordinal,

			 u16 ext, u16 *index, u32 *item_length,

			 u32 *data_length);

int bnxt_find_nvram_item(struct net_device *dev, u16 type, u16 ordinal,

			 u16 ext, u16 *index, u32 *item_length,

			 u32 *data_length);

int bnxt_flash_nvram(struct net_device *dev, u16 dir_type,

		     u16 dir_ordinal, u16 dir_ext, u16 dir_attr,

		     u32 dir_item_len, const u8 *data,

		     size_t data_len);

int bnxt_get_nvram_item(struct net_device *dev, u32 index, u32 offset,

			u32 length, u8 *data);



#endif

include/net/devlink.h

+21 −0
Original line number Diff line number Diff line
@@ -1509,6 +1509,27 @@ struct devlink_ops { 
				    struct devlink_rate *parent,

				    void *priv_child, void *priv_parent,

				    struct netlink_ext_ack *extack);

	/**

	 * selftests_check() - queries if selftest is supported

	 * @devlink: devlink instance

	 * @id: test index

	 * @extack: extack for reporting error messages

	 *

	 * Return: true if test is supported by the driver

	 */

	bool (*selftest_check)(struct devlink *devlink, unsigned int id,

			       struct netlink_ext_ack *extack);

	/**

	 * selftest_run() - Runs a selftest

	 * @devlink: devlink instance

	 * @id: test index

	 * @extack: extack for reporting error messages

	 *

	 * Return: status of the test

	 */

	enum devlink_selftest_status

	(*selftest_run)(struct devlink *devlink, unsigned int id,

			struct netlink_ext_ack *extack);

};



void *devlink_priv(struct devlink *devlink);