xref: /dpdk/doc/guides/nics/axgbe.rst (revision 8809f78c7dd9f33a44a4f89c58fc91ded34296ed)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright (c) 2018 Advanced Micro Devices, Inc. All rights reserved.
3
4AXGBE Poll Mode Driver
5======================
6
7The AXGBE poll mode driver library (**librte_net_axgbe**) implements support
8for AMD 10 Gbps family of adapters. It is compiled and tested in standard linux distro like Ubuntu.
9
10Detailed information about SoCs that use these devices can be found here:
11
12- `AMD EPYC™ EMBEDDED 3000 family <https://www.amd.com/en/products/embedded-epyc-3000-series>`_.
13
14
15Supported Features
16------------------
17
18AXGBE PMD has support for:
19
20- Base L2 features
21- TSS (Transmit Side Scaling)
22- Promiscuous mode
23- Port statistics
24- Multicast mode
25- RSS (Receive Side Scaling)
26- Checksum offload
27- Jumbo Frame up to 9K
28
29
30Building DPDK
31-------------
32
33See the :ref:`DPDK Getting Started Guide for Linux <linux_gsg>` for
34instructions on how to build DPDK.
35
36By default the AXGBE PMD library will be built into the DPDK library.
37
38For configuring and using UIO frameworks, please also refer :ref:`the
39documentation that comes with DPDK suite <linux_gsg>`.
40
41
42Prerequisites and Pre-conditions
43--------------------------------
44- Prepare the system as recommended by DPDK suite.
45
46- Bind the intended AMD device to ``igb_uio`` or ``vfio-pci`` module.
47
48Now system is ready to run DPDK application.
49
50
51Usage Example
52-------------
53
54Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
55for details.
56
57Example output:
58
59.. code-block:: console
60
61   [...]
62   EAL: PCI device 0000:02:00.4 on NUMA socket 0
63   EAL:   probe driver: 1022:1458 net_axgbe
64   Interactive-mode selected
65   USER1: create a new mbuf pool <mbuf_pool_socket_0>: n=171456, size=2176, socket=0
66   USER1: create a new mbuf pool <mbuf_pool_socket_1>: n=171456, size=2176, socket=1
67   USER1: create a new mbuf pool <mbuf_pool_socket_2>: n=171456, size=2176, socket=2
68   USER1: create a new mbuf pool <mbuf_pool_socket_3>: n=171456, size=2176, socket=3
69   Configuring Port 0 (socket 0)
70   Port 0: 00:00:1A:1C:6A:17
71   Checking link statuses...
72   Port 0 Link Up - speed 10000 Mbps - full-duplex
73   Done
74   testpmd>
75