projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 11fdf7f2 TL |
1 | .. SPDX-License-Identifier: BSD-3-Clause |
| 2 | Copyright (c) 2018 Advanced Micro Devices, Inc. All rights reserved. | |
| 3 | ||
| 4 | AXGBE Poll Mode Driver | |
| 5 | ====================== | |
| 6 | ||
| 7 | The AXGBE poll mode driver library (**librte_pmd_axgbe**) implements support | |
| 8 | for AMD 10 Gbps family of adapters. It is compiled and tested in standard linux distro like Ubuntu. | |
| 9 | ||
| 10 | Detailed 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 | ||
| 15 | Supported Features | |
| 16 | ------------------ | |
| 17 | ||
| 18 | AXGBE 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 | |
| 9f95a23c | 27 | - Jumbo Frame up to 9K |
| 11fdf7f2 TL |
28 | |
| 29 | ||
| 30 | Configuration Information | |
| 31 | ------------------------- | |
| 32 | ||
| 33 | The following options can be modified in the ``.config`` file. Please note that | |
| 34 | enabling debugging options may affect system performance. | |
| 35 | ||
| 36 | - ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **y**) | |
| 37 | ||
| 38 | Toggle compilation of axgbe PMD. | |
| 39 | ||
| 40 | - ``CONFIG_RTE_LIBRTE_AXGBE_PMD_DEBUG`` (default **n**) | |
| 41 | ||
| 42 | Toggle display for PMD debug related messages. | |
| 43 | ||
| 44 | ||
| 45 | Building DPDK | |
| 46 | ------------- | |
| 47 | ||
| 48 | See the :ref:`DPDK Getting Started Guide for Linux <linux_gsg>` for | |
| 49 | instructions on how to build DPDK. | |
| 50 | ||
| 51 | By default the AXGBE PMD library will be built into the DPDK library. | |
| 52 | ||
| 53 | For configuring and using UIO frameworks, please also refer :ref:`the | |
| 54 | documentation that comes with DPDK suite <linux_gsg>`. | |
| 55 | ||
| 56 | ||
| 57 | Prerequisites and Pre-conditions | |
| 58 | -------------------------------- | |
| 59 | - Prepare the system as recommended by DPDK suite. | |
| 60 | ||
| 61 | - Bind the intended AMD device to ``igb_uio`` or ``vfio-pci`` module. | |
| 62 | ||
| 63 | Now system is ready to run DPDK application. | |
| 64 | ||
| 65 | ||
| 66 | Usage Example | |
| 67 | ------------- | |
| 68 | ||
| 69 | Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` | |
| 70 | for details. | |
| 71 | ||
| 72 | Example output: | |
| 73 | ||
| 74 | .. code-block:: console | |
| 75 | ||
| 76 | [...] | |
| 77 | EAL: PCI device 0000:02:00.4 on NUMA socket 0 | |
| 78 | EAL: probe driver: 1022:1458 net_axgbe | |
| 79 | Interactive-mode selected | |
| 80 | USER1: create a new mbuf pool <mbuf_pool_socket_0>: n=171456, size=2176, socket=0 | |
| 81 | USER1: create a new mbuf pool <mbuf_pool_socket_1>: n=171456, size=2176, socket=1 | |
| 82 | USER1: create a new mbuf pool <mbuf_pool_socket_2>: n=171456, size=2176, socket=2 | |
| 83 | USER1: create a new mbuf pool <mbuf_pool_socket_3>: n=171456, size=2176, socket=3 | |
| 84 | Configuring Port 0 (socket 0) | |
| 85 | Port 0: 00:00:1A:1C:6A:17 | |
| 86 | Checking link statuses... | |
| 87 | Port 0 Link Up - speed 10000 Mbps - full-duplex | |
| 88 | Done | |
| 89 | testpmd> |