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

docs: octeontx2: tune rst markup

Browse Source 
Commit 80b9414832 ("docs: octeontx2: Add Documentation for NPA health
reporters") added new documentation with improper formatting for rst, and
caused a few new warnings for make htmldocs in octeontx2.rst:169--202.

Tune markup and formatting for better presentation in the HTML view.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: George Cherian <george.cherian@marvell.com>
Link: https://lore.kernel.org/r/20210106161735.21751-1-lukas.bulwahn@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Lukas Bulwahn 2021-01-06 17:17:35 +01:00 committed by Jakub Kicinski
parent 5316a7c013
commit f3562f5e00
1 changed files with 36 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
View File

@ -164,46 +164,56 @@ Devlink health reporters
NPA Reporters NPA Reporters
------------- -------------
The NPA reporters are responsible for reporting and recovering the following group of errors The NPA reporters are responsible for reporting and recovering the following group of errors:
1. GENERAL events 1. GENERAL events
- Error due to operation of unmapped PF. - Error due to operation of unmapped PF.
- Error due to disabled alloc/free for other HW blocks (NIX, SSO, TIM, DPI and AURA). - Error due to disabled alloc/free for other HW blocks (NIX, SSO, TIM, DPI and AURA).
2. ERROR events 2. ERROR events
- Fault due to NPA_AQ_INST_S read or NPA_AQ_RES_S write. - Fault due to NPA_AQ_INST_S read or NPA_AQ_RES_S write.
- AQ Doorbell Error. - AQ Doorbell Error.
3. RAS events 3. RAS events
- RAS Error Reporting for NPA_AQ_INST_S/NPA_AQ_RES_S. - RAS Error Reporting for NPA_AQ_INST_S/NPA_AQ_RES_S.
4. RVU events 4. RVU events
- Error due to unmapped slot. - Error due to unmapped slot.
Sample Output Sample Output::
-------------
~# devlink health ~# devlink health
pci/0002:01:00.0: pci/0002:01:00.0:
reporter hw_npa_intr reporter hw_npa_intr
state healthy error 2872 recover 2872 last_dump_date 2020-12-10 last_dump_time 09:39:09 grace_period 0 auto_recover true auto_dump true state healthy error 2872 recover 2872 last_dump_date 2020-12-10 last_dump_time 09:39:09 grace_period 0 auto_recover true auto_dump true
reporter hw_npa_gen reporter hw_npa_gen
state healthy error 2872 recover 2872 last_dump_date 2020-12-11 last_dump_time 04:43:04 grace_period 0 auto_recover true auto_dump true state healthy error 2872 recover 2872 last_dump_date 2020-12-11 last_dump_time 04:43:04 grace_period 0 auto_recover true auto_dump true
reporter hw_npa_err reporter hw_npa_err
state healthy error 2871 recover 2871 last_dump_date 2020-12-10 last_dump_time 09:39:17 grace_period 0 auto_recover true auto_dump true state healthy error 2871 recover 2871 last_dump_date 2020-12-10 last_dump_time 09:39:17 grace_period 0 auto_recover true auto_dump true
reporter hw_npa_ras reporter hw_npa_ras
state healthy error 0 recover 0 last_dump_date 2020-12-10 last_dump_time 09:32:40 grace_period 0 auto_recover true auto_dump true state healthy error 0 recover 0 last_dump_date 2020-12-10 last_dump_time 09:32:40 grace_period 0 auto_recover true auto_dump true
Each reporter dumps the Each reporter dumps the
- Error Type - Error Type
- Error Register value - Error Register value
- Reason in words - Reason in words
For eg: For example::
~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_gen
NPA_AF_GENERAL: ~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_gen
NPA General Interrupt Reg : 1 NPA_AF_GENERAL:
NIX0: free disabled RX NPA General Interrupt Reg : 1
~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_intr NIX0: free disabled RX
NPA_AF_RVU: ~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_intr
NPA RVU Interrupt Reg : 1 NPA_AF_RVU:
Unmap Slot Error NPA RVU Interrupt Reg : 1
~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_err Unmap Slot Error
NPA_AF_ERR: ~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_err
NPA Error Interrupt Reg : 4096 NPA_AF_ERR:
AQ Doorbell Error NPA Error Interrupt Reg : 4096
AQ Doorbell Error