numam-dpdk/doc/guides/nics/atlantic.rst

..  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

More information can be found at `Aquantia Official Website
<https://www.aquantia.com/products/client-connectivity/>`_.

Supported features
^^^^^^^^^^^^^^^^^^

- Base L2 features
- Promiscuous mode
- Multicast mode
- Port statistics
- RSS (Receive Side Scaling)
- Checksum offload
- Jumbo Frame up to 16K
- MACSEC offload

Experimental API features
^^^^^^^^^^^^^^^^^^^^^^^^^

- MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases.

Configuration Information
^^^^^^^^^^^^^^^^^^^^^^^^^

- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``)

Application Programming Interface
---------------------------------

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
net/atlantic: add PMD driver skeleton Makefile/meson build infrastructure, atl_ethdev minimal skeleton, header with aquantia aQtion NIC device and vendor IDs. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:03 +00:00			`.. 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`

			More information can be found at `Aquantia Official Website
			<https://www.aquantia.com/products/client-connectivity/>`_.

			`Supported features`
			`^^^^^^^^^^^^^^^^^^`

net/atlantic: implement Rx path Add implementation for RX datapath. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:25 +00:00			`- Base L2 features`
net/atlantic: implement promisc and allmulti modes Add support for promiscuous/allmulticast modes configuration. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:36 +00:00			`- Promiscuous mode`
			`- Multicast mode`
net/atlantic: implement device statistics Add support for device stats, xstats and queue stats Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:31 +00:00			`- Port statistics`
net/atlantic: implement RSS and RETA manipulation API Add support for Receive Side Scaling feature. RSS hash and reta table configuration. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:38 +00:00			`- RSS (Receive Side Scaling)`
net/atlantic: implement Rx path Add implementation for RX datapath. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:25 +00:00			`- Checksum offload`
doc: fix spelling reported by aspell in guides Fix spelling errors in the guide docs. Signed-off-by: John McNamara <john.mcnamara@intel.com> Acked-by: Rami Rosen <ramirose@gmail.com> 2019-04-26 15:14:21 +00:00			`- Jumbo Frame up to 16K`
net/atlantic: enable MACsec configuration These are driver MACsec configuration routines. They fill in config structures and prepare these to be send to FW. Actual configuration will happen in link interrupt handler. We declare MACsec offload bits in DPDK offload capabilities and provide external experimental MACsec API wrappers. Also update documentation with feature matrix for the enabled feature. Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> 2019-04-18 11:39:51 +00:00			`- MACSEC offload`

			`Experimental API features`
			`^^^^^^^^^^^^^^^^^^^^^^^^^`

			`- MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases.`
net/atlantic: implement Rx path Add implementation for RX datapath. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:25 +00:00
net/atlantic: add PMD driver skeleton Makefile/meson build infrastructure, atl_ethdev minimal skeleton, header with aquantia aQtion NIC device and vendor IDs. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:03 +00:00			`Configuration Information`
			`^^^^^^^^^^^^^^^^^^^^^^^^^`

			- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``)

			`Application Programming Interface`
			`---------------------------------`

			`Limitations or Known issues`
			`---------------------------`

			`Statistics`
			`~~~~~~~~~~`

			`MTU setting`
			`~~~~~~~~~~~`

net/atlantic: implement Rx path Add implementation for RX datapath. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:25 +00:00			`Atlantic NIC supports up to 16K jumbo frame size`

net/atlantic: add PMD driver skeleton Makefile/meson build infrastructure, atl_ethdev minimal skeleton, header with aquantia aQtion NIC device and vendor IDs. Signed-off-by: Igor Russkikh <igor.russkikh@aquantia.com> Signed-off-by: Pavel Belous <pavel.belous@aquantia.com> 2018-10-12 11:09:03 +00:00			`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`