leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: net: tweak devlink health documentation

Browse Source 
Minor tweaks and improvement of wording about the diagnose callback.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Jakub Kicinski 2021-03-12 16:30:25 -08:00 committed by David S. Miller
parent e127906b68
commit 3cc9b29ac0
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/networking/devlink/devlink-health.rst
View File

@ -24,7 +24,7 @@ attributes of the health reporting and recovery procedures.
The ``devlink`` health reporter: The ``devlink`` health reporter:
Device driver creates a "health reporter" per each error/health type. Device driver creates a "health reporter" per each error/health type.
Error/Health type can be a known/generic (eg pci error, fw error, rx/tx error) Error/Health type can be a known/generic (e.g. PCI error, fw error, rx/tx error)
or unknown (driver specific). or unknown (driver specific).
For each registered health reporter a driver can issue error/health reports For each registered health reporter a driver can issue error/health reports
asynchronously. All health reports handling is done by ``devlink``. asynchronously. All health reports handling is done by ``devlink``.
@ -48,6 +48,7 @@ Once an error is reported, devlink health will perform the following actions:
* Object dump is being taken and saved at the reporter instance (as long as * Object dump is being taken and saved at the reporter instance (as long as
there is no other dump which is already stored) there is no other dump which is already stored)
* Auto recovery attempt is being done. Depends on: * Auto recovery attempt is being done. Depends on:
- Auto-recovery configuration - Auto-recovery configuration
- Grace period vs. time passed since last recover - Grace period vs. time passed since last recover
@ -72,14 +73,14 @@ via ``devlink``, e.g per error type (per health reporter):
* - ``DEVLINK_CMD_HEALTH_REPORTER_SET`` * - ``DEVLINK_CMD_HEALTH_REPORTER_SET``
- Allows reporter-related configuration setting. - Allows reporter-related configuration setting.
* - ``DEVLINK_CMD_HEALTH_REPORTER_RECOVER`` * - ``DEVLINK_CMD_HEALTH_REPORTER_RECOVER``
- Triggers a reporter's recovery procedure. - Triggers reporter's recovery procedure.
* - ``DEVLINK_CMD_HEALTH_REPORTER_DIAGNOSE`` * - ``DEVLINK_CMD_HEALTH_REPORTER_DIAGNOSE``
- Retrieves diagnostics data from a reporter on a device. - Retrieves current device state related to the reporter.
* - ``DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET`` * - ``DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET``
- Retrieves the last stored dump. Devlink health - Retrieves the last stored dump. Devlink health
saves a single dump. If an dump is not already stored by the devlink saves a single dump. If an dump is not already stored by devlink
for this reporter, devlink generates a new dump. for this reporter, devlink generates a new dump.
dump output is defined by the reporter. Dump output is defined by the reporter.
* - ``DEVLINK_CMD_HEALTH_REPORTER_DUMP_CLEAR`` * - ``DEVLINK_CMD_HEALTH_REPORTER_DUMP_CLEAR``
- Clears the last saved dump file for the specified reporter. - Clears the last saved dump file for the specified reporter.
@ -93,7 +94,7 @@ The following diagram provides a general overview of ``devlink-health``::
+--------------------------+ +--------------------------+
|request for ops |request for ops
|(diagnose, |(diagnose,
mlx5_core devlink |recover, driver devlink |recover,
|dump) |dump)
+--------+ +--------------------------+ +--------+ +--------------------------+
| | | reporter| | | | | reporter| |