xref: /dpdk/doc/guides/nics/axgbe.rst (revision 8809f78c7dd9f33a44a4f89c58fc91ded34296ed)
14d60f2d0SRavi Kumar..  SPDX-License-Identifier: BSD-3-Clause
24d60f2d0SRavi Kumar    Copyright (c) 2018 Advanced Micro Devices, Inc. All rights reserved.
34d60f2d0SRavi Kumar
44d60f2d0SRavi KumarAXGBE Poll Mode Driver
54d60f2d0SRavi Kumar======================
64d60f2d0SRavi Kumar
7*8809f78cSBruce RichardsonThe AXGBE poll mode driver library (**librte_net_axgbe**) implements support
84d60f2d0SRavi Kumarfor AMD 10 Gbps family of adapters. It is compiled and tested in standard linux distro like Ubuntu.
94d60f2d0SRavi Kumar
104d60f2d0SRavi KumarDetailed information about SoCs that use these devices can be found here:
114d60f2d0SRavi Kumar
124d60f2d0SRavi Kumar- `AMD EPYC™ EMBEDDED 3000 family <https://www.amd.com/en/products/embedded-epyc-3000-series>`_.
134d60f2d0SRavi Kumar
144d60f2d0SRavi Kumar
154d60f2d0SRavi KumarSupported Features
164d60f2d0SRavi Kumar------------------
174d60f2d0SRavi Kumar
184d60f2d0SRavi KumarAXGBE PMD has support for:
194d60f2d0SRavi Kumar
204d60f2d0SRavi Kumar- Base L2 features
214d60f2d0SRavi Kumar- TSS (Transmit Side Scaling)
22fa3e0440SRavi Kumar- Promiscuous mode
233e730511SRavi Kumar- Port statistics
24fa3e0440SRavi Kumar- Multicast mode
254d60f2d0SRavi Kumar- RSS (Receive Side Scaling)
264d60f2d0SRavi Kumar- Checksum offload
274d60f2d0SRavi Kumar- Jumbo Frame up to 9K
284d60f2d0SRavi Kumar
294d60f2d0SRavi Kumar
304d60f2d0SRavi KumarBuilding DPDK
314d60f2d0SRavi Kumar-------------
324d60f2d0SRavi Kumar
334d60f2d0SRavi KumarSee the :ref:`DPDK Getting Started Guide for Linux <linux_gsg>` for
344d60f2d0SRavi Kumarinstructions on how to build DPDK.
354d60f2d0SRavi Kumar
364d60f2d0SRavi KumarBy default the AXGBE PMD library will be built into the DPDK library.
374d60f2d0SRavi Kumar
384d60f2d0SRavi KumarFor configuring and using UIO frameworks, please also refer :ref:`the
394d60f2d0SRavi Kumardocumentation that comes with DPDK suite <linux_gsg>`.
404d60f2d0SRavi Kumar
414d60f2d0SRavi Kumar
424d60f2d0SRavi KumarPrerequisites and Pre-conditions
434d60f2d0SRavi Kumar--------------------------------
444d60f2d0SRavi Kumar- Prepare the system as recommended by DPDK suite.
454d60f2d0SRavi Kumar
464d60f2d0SRavi Kumar- Bind the intended AMD device to ``igb_uio`` or ``vfio-pci`` module.
474d60f2d0SRavi Kumar
484d60f2d0SRavi KumarNow system is ready to run DPDK application.
494d60f2d0SRavi Kumar
504d60f2d0SRavi Kumar
514d60f2d0SRavi KumarUsage Example
524d60f2d0SRavi Kumar-------------
534d60f2d0SRavi Kumar
544d60f2d0SRavi KumarRefer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
554d60f2d0SRavi Kumarfor details.
564d60f2d0SRavi Kumar
574d60f2d0SRavi KumarExample output:
584d60f2d0SRavi Kumar
594d60f2d0SRavi Kumar.. code-block:: console
604d60f2d0SRavi Kumar
614d60f2d0SRavi Kumar   [...]
624d60f2d0SRavi Kumar   EAL: PCI device 0000:02:00.4 on NUMA socket 0
634d60f2d0SRavi Kumar   EAL:   probe driver: 1022:1458 net_axgbe
644d60f2d0SRavi Kumar   Interactive-mode selected
654d60f2d0SRavi Kumar   USER1: create a new mbuf pool <mbuf_pool_socket_0>: n=171456, size=2176, socket=0
664d60f2d0SRavi Kumar   USER1: create a new mbuf pool <mbuf_pool_socket_1>: n=171456, size=2176, socket=1
674d60f2d0SRavi Kumar   USER1: create a new mbuf pool <mbuf_pool_socket_2>: n=171456, size=2176, socket=2
684d60f2d0SRavi Kumar   USER1: create a new mbuf pool <mbuf_pool_socket_3>: n=171456, size=2176, socket=3
694d60f2d0SRavi Kumar   Configuring Port 0 (socket 0)
704d60f2d0SRavi Kumar   Port 0: 00:00:1A:1C:6A:17
714d60f2d0SRavi Kumar   Checking link statuses...
724d60f2d0SRavi Kumar   Port 0 Link Up - speed 10000 Mbps - full-duplex
734d60f2d0SRavi Kumar   Done
744d60f2d0SRavi Kumar   testpmd>
75