* [PATCH net-next 0/2] net/mlx5e: Fix mlx5e counters documentation errors
@ 2026-11-20 8:30 Tariq Toukan
2026-11-20 8:30 ` [PATCH net-next 1/2] net/mlx5e: Remove documentation of nonexistent counters Tariq Toukan
2026-11-20 8:30 ` [PATCH net-next 2/2] net/mlx5e: Fix incorrect name of rx_symbol_err_phy counter in documentation Tariq Toukan
0 siblings, 2 replies; 5+ messages in thread
From: Tariq Toukan @ 2026-11-20 8:30 UTC (permalink / raw)
To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
netdev, Paolo Abeni
Cc: Gal Pressman, Jonathan Corbet, Leon Romanovsky, linux-doc,
linux-rdma, Mark Bloch, Nimrod Oren, Rahul Rameshbabu,
Randy Dunlap, Saeed Mahameed, Shuah Khan, Simon Horman,
Tariq Toukan
Hi,
This series by Gal fixes errors in the mlx5e counters documentation.
Commit 8ce3b586faa4 ("net/mlx5: Add counter information to mlx5 driver
documentation") added descriptions for counters that do not exist, and
referenced one counter by a wrong name.
Patch 1 removes the documentation of counters that do not exist:
rx_bits_phy never existed, rx_mpwqe_frag was removed by commit
7e426671704d ("net/mlx5e: Single flow order-0 pages for Striding RQ"),
and dev_out_of_buffer never existed and looks like a duplicate of
dev_internal_queue_oob.
Patch 2 fixes the name of the rx_symbol_err_phy counter, which was
referenced as rx_symbol_error_phy in the rx_crc_errors_phy description.
Regards,
Tariq
Gal Pressman (2):
net/mlx5e: Remove documentation of nonexistent counters
net/mlx5e: Fix incorrect name of rx_symbol_err_phy counter in
documentation
.../ethernet/mellanox/mlx5/counters.rst | 30 ++-----------------
1 file changed, 3 insertions(+), 27 deletions(-)
base-commit: 2208ab00f4f213ade91ab775e7f8c4dacdcc856e
--
2.44.0
^ permalink raw reply [flat|nested] 5+ messages in thread* [PATCH net-next 1/2] net/mlx5e: Remove documentation of nonexistent counters
2026-11-20 8:30 [PATCH net-next 0/2] net/mlx5e: Fix mlx5e counters documentation errors Tariq Toukan
@ 2026-11-20 8:30 ` Tariq Toukan
2026-11-20 8:34 ` sashiko-bot
2026-11-20 8:30 ` [PATCH net-next 2/2] net/mlx5e: Fix incorrect name of rx_symbol_err_phy counter in documentation Tariq Toukan
1 sibling, 1 reply; 5+ messages in thread
From: Tariq Toukan @ 2026-11-20 8:30 UTC (permalink / raw)
To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
netdev, Paolo Abeni
Cc: Gal Pressman, Jonathan Corbet, Leon Romanovsky, linux-doc,
linux-rdma, Mark Bloch, Nimrod Oren, Rahul Rameshbabu,
Randy Dunlap, Saeed Mahameed, Shuah Khan, Simon Horman,
Tariq Toukan
From: Gal Pressman <gal@nvidia.com>
- rx_bits_phy never existed.
- rx_mpwqe_frag was removed by [1].
- dev_out_of_buffer never existed, and looks like a duplicate of
dev_internal_queue_oob.
[1] Commit 7e426671704d ("net/mlx5e: Single flow order-0 pages for
Striding RQ")
Fixes: 8ce3b586faa4 ("net/mlx5: Add counter information to mlx5 driver documentation")
Signed-off-by: Gal Pressman <gal@nvidia.com>
Reviewed-by: Nimrod Oren <noren@nvidia.com>
Signed-off-by: Tariq Toukan <tariqt@nvidia.com>
---
.../ethernet/mellanox/mlx5/counters.rst | 28 ++-----------------
1 file changed, 2 insertions(+), 26 deletions(-)
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
index cc498895f92e..026259ae383c 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
@@ -341,14 +341,6 @@ the software port.
- The number of wrong opcodes received on ring i.
- Error
- * - `rx[i]_mpwqe_frag`
- - The number of WQEs that failed to allocate compound page and hence
- fragmented MPWQE’s (Multi Packet WQEs) were used on ring i. If this
- counter raise, it may suggest that there is no enough memory for large
- pages, the driver allocated fragmented pages. This is not abnormal
- condition.
- - Informative
-
* - `rx[i]_mpwqe_filler_cqes`
- The number of filler CQEs events that were issued on ring i.
- Informative
@@ -1132,29 +1124,18 @@ like flow control, FEC and more.
- Failed to allocate a buffer to received packet (or SKB) on ring i.
- Error
- * - `rx_bits_phy`
- - This counter provides information on the total amount of traffic that
- could have been received and can be used as a guideline to measure the
- ratio of errored traffic in `rx_pcs_symbol_err_phy` and
- `rx_corrected_bits_phy`.
- - Informative
-
* - `rx_pcs_symbol_err_phy`
- This counter counts the number of symbol errors that wasn’t corrected by
FEC correction algorithm or that FEC algorithm was not active on this
interface. If this counter is increasing, it implies that the link
between the NIC and the network is suffering from high BER, and that
- traffic is lost. You may need to replace the cable/transceiver. The error
- rate is the number of `rx_pcs_symbol_err_phy` divided by the number of
- `rx_bits_phy` on a specific time frame.
+ traffic is lost. You may need to replace the cable/transceiver.
- Error
* - `rx_corrected_bits_phy`
- The number of corrected bits on this port according to active FEC
(RS/FC). If this counter is increasing, it implies that the link between
- the NIC and the network is suffering from high BER. The corrected bit
- rate is the number of `rx_corrected_bits_phy` divided by the number of
- `rx_bits_phy` on a specific time frame.
+ the NIC and the network is suffering from high BER.
- Error
* - `rx_err_lane_[l]_phy`
@@ -1337,11 +1318,6 @@ Device Counters
- The number of seconds where `outbound_pci_stalled_wr` was above 30%.
- Informative
- * - `dev_out_of_buffer`
- - The number of times the device owned queue had not enough buffers
- allocated.
- - Error
-
* - `pci_bw_inbound_high`
- The number of times the device crossed the high inbound pcie bandwidth
threshold. To be compared to pci_bw_inbound_low to check if the device
--
2.44.0
^ permalink raw reply related [flat|nested] 5+ messages in thread* [PATCH net-next 2/2] net/mlx5e: Fix incorrect name of rx_symbol_err_phy counter in documentation
2026-11-20 8:30 [PATCH net-next 0/2] net/mlx5e: Fix mlx5e counters documentation errors Tariq Toukan
2026-11-20 8:30 ` [PATCH net-next 1/2] net/mlx5e: Remove documentation of nonexistent counters Tariq Toukan
@ 2026-11-20 8:30 ` Tariq Toukan
2026-11-20 8:34 ` sashiko-bot
1 sibling, 1 reply; 5+ messages in thread
From: Tariq Toukan @ 2026-11-20 8:30 UTC (permalink / raw)
To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
netdev, Paolo Abeni
Cc: Gal Pressman, Jonathan Corbet, Leon Romanovsky, linux-doc,
linux-rdma, Mark Bloch, Nimrod Oren, Rahul Rameshbabu,
Randy Dunlap, Saeed Mahameed, Shuah Khan, Simon Horman,
Tariq Toukan
From: Gal Pressman <gal@nvidia.com>
rx_symbol_err_phy was incorrectly referenced as rx_symbol_error_phy in
the rx_crc_errors_phy description, fix it.
Fixes: 8ce3b586faa4 ("net/mlx5: Add counter information to mlx5 driver documentation")
Signed-off-by: Gal Pressman <gal@nvidia.com>
Reviewed-by: Nimrod Oren <noren@nvidia.com>
Signed-off-by: Tariq Toukan <tariqt@nvidia.com>
---
.../device_drivers/ethernet/mellanox/mlx5/counters.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
index 026259ae383c..de8d1a2bcdbe 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/counters.rst
@@ -930,7 +930,7 @@ like flow control, FEC and more.
* - `rx_crc_errors_phy`
- The number of dropped received packets due to FCS (Frame Check Sequence)
error on the physical port. If this counter is increased in high rate,
- check the link quality using `rx_symbol_error_phy` and
+ check the link quality using `rx_symbol_err_phy` and
`rx_corrected_bits_phy` counters below.
- Error
--
2.44.0
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2026-11-20 8:34 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-20 8:30 [PATCH net-next 0/2] net/mlx5e: Fix mlx5e counters documentation errors Tariq Toukan
2026-11-20 8:30 ` [PATCH net-next 1/2] net/mlx5e: Remove documentation of nonexistent counters Tariq Toukan
2026-11-20 8:34 ` sashiko-bot
2026-11-20 8:30 ` [PATCH net-next 2/2] net/mlx5e: Fix incorrect name of rx_symbol_err_phy counter in documentation Tariq Toukan
2026-11-20 8:34 ` sashiko-bot
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox