From 6457d0ecc15f59db1add9661bb837dc9edf13c51 Mon Sep 17 00:00:00 2001 From: Asaf Penso Date: Tue, 24 Nov 2020 07:44:16 +0000 Subject: [PATCH] doc: add Rx functions limitations in mlx5 guide The mlx5 PMD supports various Rx burst functions. Each function is enabled differently and supports different features. Signed-off-by: Asaf Penso Signed-off-by: Thomas Monjalon --- doc/guides/nics/mlx5.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index e96aca21eb..6858e81f72 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -1345,6 +1345,29 @@ Performance tuning - Configure per-lcore cache when creating Mempools for packet buffer. - Refrain from dynamically allocating/freeing memory in run-time. +Rx burst functions +------------------ + +There are multiple Rx burst functions with different advantages and limitations. + +.. table:: Rx burst functions + + +-------------------+------------------------+---------+-----------------+------+-------+ + || Function Name || Enabler || Scatter|| Error Recovery || CQE || Large| + | | | | || comp|| MTU | + +===================+========================+=========+=================+======+=======+ + | rx_burst | rx_vec_en=0 | Yes | Yes | Yes | Yes | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_vec | rx_vec_en=1 (default) | No | if CQE comp off | Yes | No | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_mprq || mprq_en=1 | No | Yes | Yes | Yes | + | || RxQs >= rxqs_min_mprq | | | | | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_mprq_vec || rx_vec_en=1 (default) | No | if CQE comp off | Yes | Yes | + | || mprq_en=1 | | | | | + | || RxQs >= rxqs_min_mprq | | | | | + +-------------------+------------------------+---------+-----------------+------+-------+ + .. _mlx5_offloads_support: Supported hardware offloads -- 2.20.1