add framework for selftests in devlink
Subsystems (5)
v5 cover add framework for selftests in devlink
Hi,
This patchset adds support for selftests in the devlink framework. It 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.
Suggested commands at user level would be as below:
changes from:v4->v5:
Addressed the changes requested by [email protected] in patch v4.
v3->v4:
Addressed the changes requested by [email protected] in patch v3.
v2->v3:
1)
After discussions with [email protected], passing a testmask from user to kernel is removed and a flag based arguments are adopted. This way we can have more than 32/64 selftests defined in the kernel.
Below is the format from user to kernel and vice-versa.
Kernel to user for show command . Users can know what all tests are supported by the driver. A return from kernel to user if driver supports TEST1, TEST4, and TEST7.
______
|NEST |
|_____ |TEST1|TEST4|TEST7|...
User to kernel to execute test: If user wants to execute test4, test8,
test1...
______
|NEST |
|_____ |TEST4|TEST8|TEST1|...
After executing the tests kernel return to user.
|NEST |
|_____ | NEST| |NEST| |NEST|
TEST4,RES4 TEST8,RES8 TEST1, RES1
2) Added dumpit in devlink for list/show command.v1->v2:
Addressed the changes requested by [email protected] in patch v1. Fixed the style issues.
Thanks,
Vikas
Vikas Gupta (2):
devlink: introduce framework for selftests
bnxt_en: implement callbacks for devlink selftests
.../networking/devlink/devlink-selftests.rst | 38 +++ .../net/ethernet/broadcom/bnxt/bnxt_devlink.c | 61 +++++ .../net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 24 +- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.h | 12 + include/net/devlink.h | 21 ++ include/uapi/linux/devlink.h | 32 +++ net/core/devlink.c | 223 ++++++++++++++++++ 7 files changed, 399 insertions(+), 12 deletions(-) create mode 100644 Documentation/networking/devlink/devlink-selftests.rst
Signature · 1 line
2.31.1
PATCH v5 1/2 devlink: introduce framework for selftests
Add a framework for running selftests.
Framework exposes devlink commands and test suite(s) to the user to execute and query the supported tests by the driver.
Below are new entries in devlink_nl_ops devlink_nl_cmd_selftests_show_doit/dumpit: To query the supported selftests by the drivers.devlink_nl_cmd_selftests_run: To execute selftests. Users can provide a test mask for executing group tests or standalone tests.
Documentation/networking/devlink/ path is already part of MAINTAINERS & the new files come under this path. Hence no update needed to the MAINTAINERS
--- .../networking/devlink/devlink-selftests.rst | 38 +++ include/net/devlink.h | 21 ++ include/uapi/linux/devlink.h | 32 +++ net/core/devlink.c | 223 ++++++++++++++++++ 4 files changed, 314 insertions(+) create mode 100644 Documentation/networking/devlink/devlink-selftests.rst
Documentation/networking/devlink/devlink-selftests.rst new file +38 -0
@@ -0,0 +1,38 @@ +.. 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 test flash
include/net/devlink.h +21 -0
@@ -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 +* @test_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 test_id, +struct netlink_ext_ack *extack); +/** +* selftest_run() - Runs a selftest +* @devlink: devlink instance +* @test_id: test index +* @extack: extack for reporting error messages +* +* Return: status of the test +*/ +enum devlink_selftest_test_status + (*selftest_run)(struct devlink *devlink,unsigned int test_id, +struct netlink_ext_ack *extack); };void *devlink_priv (struct devlink *devlink);
include/uapi/linux/devlink.h +32 -0
@@ -136,6 +136,9 @@ enum devlink_command {DEVLINK_CMD_LINECARD_NEW ,DEVLINK_CMD_LINECARD_DEL , +DEVLINK_CMD_SELFTESTS_GET ,/* can dump */ +DEVLINK_CMD_SELFTESTS_RUN , +/* add new commands above here */ __DEVLINK_CMD_MAX,DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX -1
@@ -276,6 +279,34 @@ enum {#define DEVLINK_SUPPORTED_FLASH_OVERWRITE_SECTIONS \ (_BITUL(__DEVLINK_FLASH_OVERWRITE_MAX_BIT) - 1) +enum devlink_attr_selftest_test_id { +DEVLINK_ATTR_SELFTEST_TEST_ID_UNSPEC , +DEVLINK_ATTR_SELFTEST_TEST_ID_FLASH ,/* flag */ + + __DEVLINK_ATTR_SELFTEST_TEST_ID_MAX, +DEVLINK_ATTR_SELFTEST_TEST_ID_MAX = __DEVLINK_ATTR_SELFTEST_TEST_ID_MAX -1 +}; + +enum devlink_selftest_test_status { +DEVLINK_SELFTEST_TEST_STATUS_SKIP , +DEVLINK_SELFTEST_TEST_STATUS_PASS , +DEVLINK_SELFTEST_TEST_STATUS_FAIL +}; + +enum devlink_attr_selftest_result { +DEVLINK_ATTR_SELFTEST_RESULT_UNSPEC , +DEVLINK_ATTR_SELFTEST_RESULT ,/* nested */ +DEVLINK_ATTR_SELFTEST_RESULT_TEST_ID ,/* u32, +* enum devlink_attr_selftest_test_id +*/ +DEVLINK_ATTR_SELFTEST_RESULT_TEST_STATUS ,/* u8, +* enum devlink_selftest_test_status +*/ + + __DEVLINK_ATTR_SELFTEST_RESULT_MAX, +DEVLINK_ATTR_SELFTEST_RESULT_MAX = __DEVLINK_ATTR_SELFTEST_RESULT_MAX -1 +}; +/** * enum devlink_trap_action - Packet trap action. * @DEVLINK_TRAP_ACTION_DROP: Packet is dropped by the device and a copy is not
@@ -576,6 +607,7 @@ enum devlink_attr {DEVLINK_ATTR_LINECARD_TYPE ,/* string */ DEVLINK_ATTR_LINECARD_SUPPORTED_TYPES ,/* nested */ +DEVLINK_ATTR_SELFTESTS_INFO ,/* nested */ /* add new attributes above here, update the policy in devlink.c */ __DEVLINK_ATTR_MAX,
net/core/devlink.c +223 -0
247 lines not on this page · raw message
Signature · 1 line
2.31.1
Re: [PATCH net-next v5 1/2] devlink: introduce framework for selftests
Quoted 10 lines · Fri, Jul 22, 2022 at 11:11:28AM CEST, [email protected] wrote:
Add a framework for running selftests.
Framework exposes devlink commands and test suite(s) to the user to execute and query the supported tests by the driver.Below are new entries in
devlink_nl_opsdevlink_nl_cmd_selftests_show_doit/dumpit: To query the supported selftests by the drivers.devlink_nl_cmd_selftests_run: To execute selftests. Users can provide a test mask for executing group tests or standalone tests.
Quoted 7 lines
Documentation/networking/devlink/path is already part ofMAINTAINERS& the new files come under this path. Hence no update needed to theMAINTAINERSSigned-off-by Vikas Gupta <[email protected]>Reviewed-by Michael Chan <[email protected]>Reviewed-by Andy Gospodarek <[email protected]>
Just a small note below. Take it or leave it, I don't mind that much.
Thanks!
Quoted 42 lines
---
.../networking/devlink/devlink-selftests.rst | 38 +++ include/net/devlink.h | 21 ++ include/uapi/linux/devlink.h | 32 +++ net/core/devlink.c | 223 ++++++++++++++++++ 4 files changed, 314 insertions(+)create mode 100644
Documentation/networking/devlink/devlink-selftests.rstDocumentation/networking/devlink/devlink-selftests.rst new file +28
-0@@ -0,0 +1,38 @@ +.. 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
Documentation/networking/devlink/devlink-selftests.rst line 38
Quoted 10 lines
Documentation/networking/devlink/devlink-selftests.rst new file +10
-0+------------- + +.. 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 test flash
s/test/test_id/
[...]
PATCH v5 2/2 bnxt_en: implement callbacks for devlink selftests
In reply to Vikas GuptaAdd callbacks
=============
.selftest_check: returns true for flash selftest. .selftest_run: runs a flash selftest.
Also, refactor NVM APIs so that they can be used with devlink and ethtool both.
--- .../net/ethernet/broadcom/bnxt/bnxt_devlink.c | 61 +++++++++++++++++++ .../net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 24 ++++---- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.h | 12 ++++ 3 files changed, 85 insertions(+), 12 deletions(-)
drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c +61 -0
@@ -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 actireturn 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 test_id, +struct netlink_ext_ack *extack) +{ +return test_id ==DEVLINK_ATTR_SELFTEST_TEST_ID_FLASH ; +} + +static enum devlink_selftest_test_status bnxt_dl_selftest_run (struct devlink *dl, +unsigned int test_id, +struct netlink_ext_ack *extack) +{ +struct bnxt *bp =bnxt_get_bp_from_dl (dl); + +if (test_id ==DEVLINK_ATTR_SELFTEST_TEST_ID_FLASH ) +return bnxt_nvm_test (bp, extack) ? +DEVLINK_SELFTEST_TEST_STATUS_PASS : +DEVLINK_SELFTEST_TEST_STATUS_FAIL ; + +return DEVLINK_SELFTEST_TEST_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
@@ -2176,14 +2176,14 @@ 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, -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); -static 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_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) {struct bnxt *bp =netdev_priv (dev);struct hwrm_nvm_write_input *req;
@@ -2836,8 +2836,8 @@ 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, -u32 length,u8 *data) +int bnxt_get_nvram_item (struct net_device *dev,u32 index,u32 offset, +u32 length,u8 *data) {struct bnxt *bp =netdev_priv (dev);int rc;
@@ -2871,9 +2871,9 @@ 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, -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) {struct hwrm_nvm_find_dir_entry_output *output;struct hwrm_nvm_find_dir_entry_input *req;
drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.h +12 -0
@@ -58,5 +58,17 @@ int bnxt_flash_package_from_fw_obj(struct net_device *dev, const struct firmwareint 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
Signature · 1 line
2.31.1
Re: [PATCH net-next v5 2/2] bnxt_en: implement callbacks for devlink selftests
Quoted 11 lines · Fri, Jul 22, 2022 at 11:11:29AM CEST, [email protected] wrote:
Add callbacks
=============
.selftest_check: returns true for flash selftest. .selftest_run: runs a flash selftest.Also, refactor NVM APIs so that they can be used with devlink and ethtool both.
Signed-off-by Vikas Gupta <[email protected]>Reviewed-by Michael Chan <[email protected]>Reviewed-by Andy Gospodarek <[email protected]>