[dpdk-dev,v2,1/3] doc: updated i40e enabling additonal fnct in gsg

Message ID 1419001728-7878-2-git-send-email-pablo.de.lara.guarch@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

De Lara Guarch, Pablo Dec. 19, 2014, 3:08 p.m. UTC
  From: Siobhan Butler <siobhan.a.butler@intel.com>

Updated the i40e Enabling Additional Functionality
section (5.7) of DPDK Getting Started Guide.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>

Signed-off-by: Helin Zhang <helin.zhang@intel.com>
---
 doc/guides/linux_gsg/enable_func.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
  

Comments

Iremonger, Bernard Dec. 19, 2014, 4 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Friday, December 19, 2014 3:09 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v2 1/3] doc: updated i40e enabling additonal fnct in gsg
> 
> From: Siobhan Butler <siobhan.a.butler@intel.com>
> 
> Updated the i40e Enabling Additional Functionality section (5.7) of DPDK Getting Started Guide.
> 
> Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
> 
> Signed-off-by: Helin Zhang <helin.zhang@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.
  
Thomas Monjalon Dec. 19, 2014, 9:42 p.m. UTC | #2
> --- a/doc/guides/linux_gsg/enable_func.rst
> +++ b/doc/guides/linux_gsg/enable_func.rst
> @@ -171,6 +171,10 @@ Please note that while using iommu=pt is compulsory for igb_uio driver, the vfio
>  High Performance of Small Packets on 40G NIC
>  --------------------------------------------
>  
> +As there might be firmware fixes for performance enhancement in latest version
> +of firmware image, the firmware update might be needed for getting high performance.
> +Check with the local Intel's Network Division application engineers for firmware updates.
> +
>  Enabling Extended Tag and Setting Max Read Request Size
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> @@ -198,3 +202,13 @@ Use 16 Bytes RX Descriptor Size
>  
>  As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets.
>  Configuration of CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC in config files can be changed to use 16 bytes size RX descriptors.
> +
> +High Performance and per Packet Latency Tradeoff
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Due to the hardware design, the interrupt signal inside NIC is needed for per
> +packet descriptor write-back. The minimum interval of interrupts could be set
> +at compile time by CONFIG_RTE_LIBRTE_I40E_ITR_INTERVAL in configuration files.
> +Though there is a default configuration, the interval could be tuned by the
> +users with that configuration item depends on what the user cares about more,
> +performance or per packet latency.

This kind of hardware information is not specific to Linux.
I think we should open some guides dedicated to drivers design.
Examples:
	- doc/guides/drivers/i40e/
	- doc/guides/drivers/enic/
	- etc
Any volunteer to start this new doc directory?
  

Patch

diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst
index ac12d51..00c6d9e 100644
--- a/doc/guides/linux_gsg/enable_func.rst
+++ b/doc/guides/linux_gsg/enable_func.rst
@@ -171,6 +171,10 @@  Please note that while using iommu=pt is compulsory for igb_uio driver, the vfio
 High Performance of Small Packets on 40G NIC
 --------------------------------------------
 
+As there might be firmware fixes for performance enhancement in latest version
+of firmware image, the firmware update might be needed for getting high performance.
+Check with the local Intel's Network Division application engineers for firmware updates.
+
 Enabling Extended Tag and Setting Max Read Request Size
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -198,3 +202,13 @@  Use 16 Bytes RX Descriptor Size
 
 As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets.
 Configuration of CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC in config files can be changed to use 16 bytes size RX descriptors.
+
+High Performance and per Packet Latency Tradeoff
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Due to the hardware design, the interrupt signal inside NIC is needed for per
+packet descriptor write-back. The minimum interval of interrupts could be set
+at compile time by CONFIG_RTE_LIBRTE_I40E_ITR_INTERVAL in configuration files.
+Though there is a default configuration, the interval could be tuned by the
+users with that configuration item depends on what the user cares about more,
+performance or per packet latency.