[19/20] docs: update ENA PMD documentation and features
diff mbox series

Message ID 20181214131846.22439-20-mk@semihalf.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • net/ena: ENAv2 release
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Michał Krawczyk Dec. 14, 2018, 1:18 p.m. UTC
Previously, the features list was indicating unsupported ENA PMD
features and were missing few ones, that were actually supported.

The features file was updated, so it is now reflecting current driver
state.

The documentation was updated with the more actual example and features,
especially ones which are ENA and not listed in the features file.

Signed-off-by: Michal Krawczyk <mk@semihalf.com>
---
 doc/guides/nics/ena.rst          | 31 ++++++++++++++++---------------
 doc/guides/nics/features/ena.ini | 12 ++++--------
 2 files changed, 20 insertions(+), 23 deletions(-)

Patch
diff mbox series

diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst
index 34c48575b..9f0a6509f 100644
--- a/doc/guides/nics/ena.rst
+++ b/doc/guides/nics/ena.rst
@@ -1,6 +1,6 @@ 
 .. BSD LICENSE
 
-    Copyright (c) 2015-2016 Amazon.com, Inc. or its affiliates.
+    Copyright (c) 2015-2018 Amazon.com, Inc. or its affiliates.
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without
@@ -164,20 +164,18 @@  section of :ref:`the DPDK documentation <linux_gsg>` or refer to *DPDK Release N
 Supported features
 ------------------
 
+* MTU configuration
 * Jumbo frames up to 9K
-* Port Hardware Statistics
 * IPv4/TCP/UDP checksum offload
 * TSO offload
 * Multiple receive and transmit queues
-* RSS
+* RSS hash
+* RSS indirection table configuration
 * Low Latency Queue for Tx
-
-Unsupported features
---------------------
-
-The features supported by the device and not yet supported by this PMD include:
-
-* Asynchronous Event Notification Queue (AENQ)
+* Basic and extended statistics
+* LSC event notification
+* Watchdog (requires handling of timers in the application)
+* Device reset upon failure
 
 Prerequisites
 -------------
@@ -214,14 +212,17 @@  Example output:
 .. code-block:: console
 
    [...]
-   EAL: PCI device 0000:02:00.1 on NUMA socket -1
-   EAL:   probe driver: 1d0f:ec20 rte_ena_pmd
-   EAL:   PCI memory mapped at 0x7f9b6c400000
-   PMD: eth_ena_dev_init(): Initializing 0:2:0.1
+   EAL: PCI device 0000:00:06.0 on NUMA socket -1
+   EAL:   Invalid NUMA socket, default to 0
+   EAL:   probe driver: 1d0f:ec20 net_ena
+
    Interactive-mode selected
+   testpmd: create a new mbuf pool <mbuf_pool_socket_0>: n=171456, size=2176, socket=0
+   testpmd: preferred mempool ops selected: ring_mp_mc
+   Warning! port-topology=paired and odd forward ports number, the last port will pair with itself.
    Configuring Port 0 (socket 0)
    Port 0: 00:00:00:11:00:01
    Checking link statuses...
-   Port 0 Link Up - speed 10000 Mbps - full-duplex
+
    Done
    testpmd>
diff --git a/doc/guides/nics/features/ena.ini b/doc/guides/nics/features/ena.ini
index aa6f05a71..4300dd012 100644
--- a/doc/guides/nics/features/ena.ini
+++ b/doc/guides/nics/features/ena.ini
@@ -4,25 +4,21 @@ 
 ; Refer to default.ini for the full list of available PMD features.
 ;
 [Features]
-Speed capabilities   = P
-Queue start/stop     = Y
+Link status          = Y
+Link status event    = Y
 MTU update           = Y
 Jumbo frame          = Y
 Scattered Rx         = Y
 TSO                  = Y
 RSS hash             = Y
-RSS key update       = Y
 RSS reta update      = Y
-SR-IOV               = Y
-CRC offload          = Y
-VLAN offload         = Y
 L3 checksum offload  = Y
 L4 checksum offload  = Y
-Inner L3 checksum    = Y
-Inner L4 checksum    = Y
 Basic stats          = Y
 Extended stats       = Y
 Linux UIO            = Y
 Linux VFIO           = Y
 x86-32               = Y
 x86-64               = Y
+Usage doc            = Y
+Design doc           = Y