GNU Linux-libre 6.9-gnu
[releases.git] / Documentation / networking / devlink / devlink-selftests.rst
1 .. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
3 =================
4 Devlink Selftests
5 =================
6
7 The ``devlink-selftests`` API allows executing selftests on the device.
8
9 Tests Mask
10 ==========
11 The ``devlink-selftests`` command should be run with a mask indicating
12 the tests to be executed.
13
14 Tests Description
15 =================
16 The following is a list of tests that drivers may execute.
17
18 .. list-table:: List of tests
19    :widths: 5 90
20
21    * - Name
22      - Description
23    * - ``DEVLINK_SELFTEST_FLASH``
24      - Devices may have the firmware on non-volatile memory on the board, e.g.
25        flash. This particular test helps to run a flash selftest on the device.
26        Implementation of the test is left to the driver/firmware.
27
28 example usage
29 -------------
30
31 .. code:: shell
32
33     # Query selftests supported on the devlink device
34     $ devlink dev selftests show DEV
35     # Query selftests supported on all devlink devices
36     $ devlink dev selftests show
37     # Executes selftests on the device
38     $ devlink dev selftests run DEV id flash