1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2018 Intel Corporation.
7 The ice PMD (librte_pmd_ice) provides poll mode driver support for
8 10/25 Gbps IntelĀ® Ethernet 810 Series Network Adapters based on
9 the Intel Ethernet Controller E810.
15 - Identifying your adapter using `Intel Support
16 <http://www.intel.com/support>`_ and get the latest NVM/FW images.
18 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
20 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
21 section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
24 Pre-Installation Configuration
25 ------------------------------
30 The following options can be modified in the ``config`` file.
31 Please note that enabling debugging options may affect system performance.
33 - ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
35 Toggle compilation of the ``librte_pmd_ice`` driver.
37 - ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
39 Toggle display of generic debugging messages.
41 - ``CONFIG_RTE_LIBRTE_ICE_RX_ALLOW_BULK_ALLOC`` (default ``y``)
43 Toggle bulk allocation for RX.
45 - ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
47 Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
49 Runtime Config Options
50 ~~~~~~~~~~~~~~~~~~~~~~
52 - ``Maximum Number of Queue Pairs``
54 The maximum number of queue pairs is decided by HW. If not configured, APP
55 uses the number from HW. Users can check the number by calling the API
56 ``rte_eth_dev_info_get``.
57 If users want to limit the number of queues, they can set a smaller number
58 using EAL parameter like ``max_queue_pair_num=n``.
61 Driver compilation and testing
62 ------------------------------
64 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
67 Sample Application Notes
68 ------------------------
73 Vlan filter only works when Promiscuous mode is off.
75 To start ``testpmd``, and add vlan 10 to port 0:
77 .. code-block:: console
79 ./app/testpmd -l 0-15 -n 4 -- -i
82 testpmd> rx_vlan add 10 0
84 Limitations or Known issues
85 ---------------------------
90 Ice code released in 19.02 is for evaluation only.