net/igc: add skeleton
[dpdk.git] / doc / guides / nics / igc.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2020 Intel Corporation.
3
4 IGC Poll Mode Driver
5 ======================
6
7 The IGC PMD (librte_pmd_igc) provides poll mode driver support for Foxville
8 I225 Series Network Adapters.
9
10 - For information about I225, please refer to:
11   `https://ark.intel.com/content/www/us/en/ark/products/series/184686/
12   intel-ethernet-controller-i225-series.html`
13
14 Config File Options
15 ~~~~~~~~~~~~~~~~~~~
16
17 The following options can be modified in the ``config`` file.
18 Please note that enabling debugging options may affect system performance.
19
20 - ``CONFIG_RTE_LIBRTE_IGC_PMD`` (default ``y``)
21
22   Toggle compilation of the ``librte_pmd_igc`` driver.
23
24 - ``CONFIG_RTE_LIBRTE_IGC_DEBUG_*`` (default ``n``)
25
26   Toggle display of generic debugging messages.
27
28
29 Driver compilation and testing
30 ------------------------------
31
32 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
33 for details.
34
35
36 Supported Chipsets and NICs
37 ---------------------------
38
39 Foxville LM (I225 LM): Client 2.5G LAN vPro Corporate
40 Foxville V (I225 V): Client 2.5G LAN Consumer
41 Foxville I (I225 I): Client 2.5G Industrial Temp
42 Foxville V (I225 K): Client 2.5G LAN Consumer