* [PATCH v2] docs: octeontx2: tune rst markup
@ 2021-01-06 16:17 Lukas Bulwahn
2021-01-06 16:41 ` Randy Dunlap
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Lukas Bulwahn @ 2021-01-06 16:17 UTC (permalink / raw)
To: George Cherian, Jonathan Corbet, Randy Dunlap, linux-doc
Cc: Sunil Goutham, Linu Cherian, Geetha Sowjanya, Jerin Jacob,
David S . Miller, Jakub Kicinski, Mauro Carvalho Chehab, netdev,
linux-kernel, Lukas Bulwahn
Commit 80b9414832a1 ("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>
---
v1 -> v2: minor stylistic tuning as suggested by Randy
applies cleanly on current master (v5.11-rc2) and next-20210106
George, please ack.
Jonathan, please pick this minor formatting clean-up patch.
.../ethernet/marvell/octeontx2.rst | 62 +++++++++++--------
1 file changed, 36 insertions(+), 26 deletions(-)
diff --git a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
index d3fcf536d14e..61e850460e18 100644
--- a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
+++ b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
@@ -164,46 +164,56 @@ 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
--------------
-~# devlink health
-pci/0002:01:00.0:
- 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
- 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
- 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
- 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
+Sample Output::
+
+ ~# devlink health
+ pci/0002:01:00.0:
+ 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
+ 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
+ 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
+ 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
Each reporter dumps the
+
- Error Type
- Error Register value
- Reason in words
-For eg:
-~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_gen
- NPA_AF_GENERAL:
- NPA General Interrupt Reg : 1
- NIX0: free disabled RX
-~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_intr
- NPA_AF_RVU:
- NPA RVU Interrupt Reg : 1
- Unmap Slot Error
-~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_err
- NPA_AF_ERR:
- NPA Error Interrupt Reg : 4096
- AQ Doorbell Error
+For example::
+
+ ~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_gen
+ NPA_AF_GENERAL:
+ NPA General Interrupt Reg : 1
+ NIX0: free disabled RX
+ ~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_intr
+ NPA_AF_RVU:
+ NPA RVU Interrupt Reg : 1
+ Unmap Slot Error
+ ~# devlink health dump show pci/0002:01:00.0 reporter hw_npa_err
+ NPA_AF_ERR:
+ NPA Error Interrupt Reg : 4096
+ AQ Doorbell Error
--
2.17.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs: octeontx2: tune rst markup
2021-01-06 16:17 [PATCH v2] docs: octeontx2: tune rst markup Lukas Bulwahn
@ 2021-01-06 16:41 ` Randy Dunlap
2021-01-07 3:21 ` George Cherian
2021-01-07 20:48 ` Jakub Kicinski
2 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2021-01-06 16:41 UTC (permalink / raw)
To: Lukas Bulwahn, George Cherian, Jonathan Corbet, linux-doc
Cc: Sunil Goutham, Linu Cherian, Geetha Sowjanya, Jerin Jacob,
David S . Miller, Jakub Kicinski, Mauro Carvalho Chehab, netdev,
linux-kernel
On 1/6/21 8:17 AM, Lukas Bulwahn wrote:
> Commit 80b9414832a1 ("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>
> ---
> v1 -> v2: minor stylistic tuning as suggested by Randy
>
> applies cleanly on current master (v5.11-rc2) and next-20210106
>
> George, please ack.
> Jonathan, please pick this minor formatting clean-up patch.
>
> .../ethernet/marvell/octeontx2.rst | 62 +++++++++++--------
> 1 file changed, 36 insertions(+), 26 deletions(-)
>
> diff --git a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
> index d3fcf536d14e..61e850460e18 100644
> --- a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
> +++ b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
--
~Randy
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs: octeontx2: tune rst markup
2021-01-06 16:17 [PATCH v2] docs: octeontx2: tune rst markup Lukas Bulwahn
2021-01-06 16:41 ` Randy Dunlap
@ 2021-01-07 3:21 ` George Cherian
2021-01-07 20:48 ` Jakub Kicinski
2 siblings, 0 replies; 4+ messages in thread
From: George Cherian @ 2021-01-07 3:21 UTC (permalink / raw)
To: Lukas Bulwahn
Cc: George Cherian, Jonathan Corbet, Randy Dunlap, linux-doc,
Sunil Goutham, Linu Cherian, Geetha Sowjanya, Jerin Jacob,
David S . Miller, Jakub Kicinski, Mauro Carvalho Chehab, netdev,
linux-kernel
On Wed, Jan 6, 2021 at 9:51 PM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
>
> Commit 80b9414832a1 ("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>
> ---
> v1 -> v2: minor stylistic tuning as suggested by Randy
>
> applies cleanly on current master (v5.11-rc2) and next-20210106
>
> George, please ack.
> Jonathan, please pick this minor formatting clean-up patch.
>
Acked-by: George Cherian <george.cherian@marvell.com>
Regards
-George
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs: octeontx2: tune rst markup
2021-01-06 16:17 [PATCH v2] docs: octeontx2: tune rst markup Lukas Bulwahn
2021-01-06 16:41 ` Randy Dunlap
2021-01-07 3:21 ` George Cherian
@ 2021-01-07 20:48 ` Jakub Kicinski
2 siblings, 0 replies; 4+ messages in thread
From: Jakub Kicinski @ 2021-01-07 20:48 UTC (permalink / raw)
To: Lukas Bulwahn
Cc: George Cherian, Jonathan Corbet, Randy Dunlap, linux-doc,
Sunil Goutham, Linu Cherian, Geetha Sowjanya, Jerin Jacob,
David S . Miller, Mauro Carvalho Chehab, netdev, linux-kernel
On Wed, 6 Jan 2021 17:17:35 +0100 Lukas Bulwahn wrote:
> Commit 80b9414832a1 ("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>
Applied to net, thanks everyone!
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-01-07 20:49 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-06 16:17 [PATCH v2] docs: octeontx2: tune rst markup Lukas Bulwahn
2021-01-06 16:41 ` Randy Dunlap
2021-01-07 3:21 ` George Cherian
2021-01-07 20:48 ` Jakub Kicinski
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).