Commit f3562f5e authored by Lukas Bulwahn's avatar Lukas Bulwahn Committed by Jakub Kicinski
Browse files

docs: octeontx2: tune rst markup 



Commit 80b94148 ("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: default avatarLukas Bulwahn <lukas.bulwahn@gmail.com>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Acked-by: default avatarGeorge Cherian <george.cherian@marvell.com>
Link: https://lore.kernel.org/r/20210106161735.21751-1-lukas.bulwahn@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 5316a7c0

Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst

+36 −26
Original line number Diff line number Diff line
@@ -164,20 +164,28 @@ Devlink health 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



   - Error due to operation of unmapped PF.

   - Error due to disabled alloc/free for other HW blocks (NIX, SSO, TIM, DPI and AURA).



2. ERROR events



   - Fault due to NPA_AQ_INST_S read or NPA_AQ_RES_S write.

   - AQ Doorbell Error.



3. RAS events



   - RAS Error Reporting for NPA_AQ_INST_S/NPA_AQ_RES_S.



4. RVU events



   - Error due to unmapped slot.



Sample Output

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

Sample Output::



	~# devlink health

	pci/0002:01:00.0:

	  reporter hw_npa_intr
@@ -190,11 +198,13 @@ pci/0002:01:00.0: 
	      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



 - Error Type

 - Error Register value

 - Reason in words



For eg:

For example::



	~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_gen

	 NPA_AF_GENERAL:

	         NPA General Interrupt Reg : 1