Signed-off-by: Igor Russkikh <igor.russk...@aquantia.com> --- doc/guides/nics/atlantic.rst | 59 ++++++++++++++++++++++++++++++++++ doc/guides/nics/features/atlantic.ini | 37 +++++++++++++++++++++ doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_18_11.rst | 5 +++ 4 files changed, 102 insertions(+) create mode 100644 doc/guides/nics/atlantic.rst create mode 100644 doc/guides/nics/features/atlantic.ini
diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst new file mode 100644 index 000000000..b65916fea --- /dev/null +++ b/doc/guides/nics/atlantic.rst @@ -0,0 +1,59 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Aquantia Corporation. + +Aquantia Atlantic DPDK Driver +============================= + +Atlantic DPDK driver provides DPDK support for Aquantia's AQtion family of chipsets: AQC107/AQC108/AQC109 + +Supported features +^^^^^^^^^^^^^^^^^^ + + +- Base L2 features +- Promiscuous mode +- Port statistics +- Multicast mode +- RSS (Receive Side Scaling) +- Checksum offload +- Jumbo Frame upto 16K + +Configuration Information +^^^^^^^^^^^^^^^^^^^^^^^^^ + +- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``) + +- Various debug (default ``n``): + - ``CONFIG_RTE_LIBRTE_ATLANTIC_DEBUG`` + - ``CONFIG_RTE_LIBRTE_ATLANTIC_DEBUG_RX`` + - ``CONFIG_RTE_LIBRTE_ATLANTIC_DEBUG_TX`` + - ``CONFIG_RTE_LIBRTE_ATLANTIC_DEBUG_TX_FREE`` + +Not yet supported features +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +NOP + +Application Programming Interface +--------------------------------- + +Atlantic NIC supports custom LED pin configuration interface. +For details, refer rte_pmd_atlantic.h header file + +Limitations or Known issues +--------------------------- + +Statistics +~~~~~~~~~~ + +MTU setting +~~~~~~~~~~~ + +Atlantic NIC supports up to 16K jumbo frame size + +Supported Chipsets and NICs +--------------------------- + +- Aquantia AQtion AQC107 10 Gigabit Ethernet Controller +- Aquantia AQtion AQC108 5 Gigabit Ethernet Controller +- Aquantia AQtion AQC109 2.5 Gigabit Ethernet Controller diff --git a/doc/guides/nics/features/atlantic.ini b/doc/guides/nics/features/atlantic.ini new file mode 100644 index 000000000..2d943ce13 --- /dev/null +++ b/doc/guides/nics/features/atlantic.ini @@ -0,0 +1,37 @@ +; +; Supported features of the 'atlantic' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Speed capabilities = Y +Link status = Y +Link status event = Y +MTU update = Y +Jumbo frame = Y +Promiscuous mode = Y +Allmulticast mode = Y +Unicast MAC filter = Y +VLAN filter = Y +Flow control = Y +CRC offload = Y +VLAN offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Rx descriptor status = Y +Tx descriptor status = Y +Basic stats = Y +Extended stats = Y +Stats per queue = Y +Linux UIO = Y +x86-32 = Y +x86-64 = Y +Queue start/stop = Y +RSS hash = Y +RSS key update = Y +RSS reta update = Y +Packet type parsing = Y +FW version = Y +EEPROM dump = Y +Registers dump = Y +LED = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 59f6063dc..7925c2bd8 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -12,6 +12,7 @@ Network Interface Controller Drivers features build_and_test ark + atlantic avp axgbe bnx2x diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst index 3ae6b3f58..5a68ff8c3 100644 --- a/doc/guides/rel_notes/release_18_11.rst +++ b/doc/guides/rel_notes/release_18_11.rst @@ -54,6 +54,11 @@ New Features Also, make sure to start the actual text at the margin. ========================================================= +* **Added Ethernet poll mode driver for Aquantia aQtion family of 10G devices.** + + Added the new ``atlantic`` ethernet poll mode driver for Aquantia XGBE devices. + See the :doc:`../nics/atlantic` nic driver guide for more details on this + driver. API Changes ----------- -- 2.13.3.windows.1