[dpdk-dev] [PATCH] doc: update new ethdev offload API description

[Patil, Harish]

-----Original Message-----
From: Ferruh Yigit <ferruh.yigit at intel.com>
Date: Friday, March 16, 2018 at 8:51 AM
To: John McNamara <john.mcnamara at intel.com>, Marko Kovacevic
<marko.kovacevic at intel.com>
Cc: "dev at dpdk.org" <dev at dpdk.org>, Ferruh Yigit <ferruh.yigit at intel.com>,
Thomas Monjalon <thomas at monjalon.net>, "shahafs at mellanox.com"
<shahafs at mellanox.com>, <Patil>, Harish Patil <Harish.Patil at cavium.com>
Subject: [PATCH] doc: update new ethdev offload API description

>Don't mandate API to pass port offload configuration during queue setup,
>this is unnecessary for devices that support only port level offloads.
>
>Fixes: 81ac560dc1b4 ("doc: add details on ethdev offloads API")
>Cc: shahafs at mellanox.com
>
>Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
>---
>Cc: Patil, Harish <harish.patil at cavium.com>
>
>Btw, this expectation from API should be clear from source code and API
>documentation (doxygen comments in header file) instead of
>documentation. Am I missing something or we are doing something wrong
>here?
>---
> doc/guides/prog_guide/poll_mode_drv.rst | 4 +---
> 1 file changed, 1 insertion(+), 3 deletions(-)
>
>diff --git a/doc/guides/prog_guide/poll_mode_drv.rst
>b/doc/guides/prog_guide/poll_mode_drv.rst
>index e5d01874e..3247f309f 100644
>--- a/doc/guides/prog_guide/poll_mode_drv.rst
>+++ b/doc/guides/prog_guide/poll_mode_drv.rst
>@@ -303,9 +303,7 @@ Supported offloads can be either per-port or
>per-queue.
> Offloads are enabled using the existing ``DEV_TX_OFFLOAD_*`` or
>``DEV_RX_OFFLOAD_*`` flags.
> Per-port offload configuration is set using ``rte_eth_dev_configure``.
> Per-queue offload configuration is set using ``rte_eth_rx_queue_setup``
>and ``rte_eth_tx_queue_setup``.
>-To enable per-port offload, the offload should be set on both device
>configuration and queue setup.
>-In case of a mixed configuration the queue setup shall return with an
>error.
>-To enable per-queue offload, the offload can be set only on the queue
>setup.
>+Per-port offloads should be set on the port configuration. Queue
>offloads should be set on the queue configuration.
> Offloads which are not enabled are disabled by default.
> 
> For an application to use the Tx offloads API it should set the
>``ETH_TXQ_FLAGS_IGNORE`` flag in the ``txq_flags`` field located in
>``rte_eth_txconf`` struct.
>-- 
>2.13.6
>
Acked-by: Harish Patil <harish.patil at cavium.com>

>