[v4,22/22] net/atlantic: documentation and rel notes
Checks
Commit Message
Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com>
Signed-off-by: Pavel Belous <Pavel.Belous@aquantia.com>
---
doc/guides/nics/atlantic.rst | 53 ++++++++++++++++++++++++++++++++++
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, 96 insertions(+)
create mode 100644 doc/guides/nics/atlantic.rst
create mode 100644 doc/guides/nics/features/atlantic.ini
Comments
On 10/9/2018 10:32 AM, Igor Russkikh wrote:
> Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com>
> Signed-off-by: Pavel Belous <Pavel.Belous@aquantia.com>
<...>
> @@ -0,0 +1,53 @@
> +.. 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
Can you please provide links to the devices mentioned?
<...>
> @@ -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
Can you please distribute this file to the patchset, update the relevant item in
the patch that enables this feature, so that it becomes kind of documentation
and help to track the code which enabled a feature.
And please keep the order of the default.ini
new file mode 100644
@@ -0,0 +1,53 @@
+.. 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``)
+
+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
new file mode 100644
@@ -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
@@ -12,6 +12,7 @@ Network Interface Controller Drivers
features
build_and_test
ark
+ atlantic
avp
axgbe
bnx2x
@@ -104,6 +104,11 @@ New Features
the specified port. The port must be stopped before the command call in order
to reconfigure queues.
+* **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
-----------