From: alvinx.zhang@intel.com
To: haiyue.wang@intel.com, qi.z.zhang@intel.com,
beilei.xing@intel.com, xiaolong.ye@intel.com
Cc: dev@dpdk.org, Alvin Zhang <alvinx.zhang@intel.com>
Subject: [dpdk-dev] [RFC 7/7] doc: add igc guide and feature list
Date: Fri, 10 Jan 2020 11:00:25 +0800 [thread overview]
Message-ID: <1578625225-110361-7-git-send-email-alvinx.zhang@intel.com> (raw)
In-Reply-To: <1578625225-110361-1-git-send-email-alvinx.zhang@intel.com>
From: Alvin Zhang <alvinx.zhang@intel.com>
Add igc.rst and igc.ini files.
Signed-off-by: Alvin Zhang <alvinx.zhang@intel.com>
---
doc/guides/nics/features/igc.ini | 36 ++++++++++++++++++++++
doc/guides/nics/igc.rst | 65 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 101 insertions(+)
create mode 100644 doc/guides/nics/features/igc.ini
create mode 100644 doc/guides/nics/igc.rst
diff --git a/doc/guides/nics/features/igc.ini b/doc/guides/nics/features/igc.ini
new file mode 100644
index 0000000..453ca39
--- /dev/null
+++ b/doc/guides/nics/features/igc.ini
@@ -0,0 +1,36 @@
+;
+; Supported features of the 'igc' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Speed capabilities = P
+Link status = Y
+Link status event = Y
+Rx interrupt = Y
+MTU update = Y
+Jumbo frame = Y
+Scattered Rx = Y
+TSO = Y
+Promiscuous mode = Y
+Allmulticast mode = Y
+Unicast MAC filter = Y
+RSS hash = Y
+RSS key update = Y
+RSS reta update = Y
+VLAN filter = Y
+Flow control = Y
+CRC offload = Y
+VLAN offload = Y
+QinQ offload = Y
+L3 checksum offload = Y
+L4 checksum offload = Y
+Packet type parsing = Y
+Basic stats = Y
+Extended stats = Y
+Stats per queue = P
+BSD nic_uio = Y
+Linux UIO = Y
+Linux VFIO = Y
+x86-32 = Y
+x86-64 = Y
diff --git a/doc/guides/nics/igc.rst b/doc/guides/nics/igc.rst
new file mode 100644
index 0000000..b063f8c
--- /dev/null
+++ b/doc/guides/nics/igc.rst
@@ -0,0 +1,65 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Intel Corporation.
+
+IGC Poll Mode Driver
+======================
+
+The IGC PMD (librte_pmd_igc) provides poll mode driver support for
+Foxville and Greenvile I225 Series Network Adapters.
+
+
+Features
+--------
+
+Features of the IGC PMD are:
+
+- Multiple queues for TX and RX
+- Receiver Side Scaling (RSS)
+- MAC/VLAN filtering
+- Packet type information
+- Checksum offload
+- VLAN/QinQ stripping and inserting
+- TSO offload
+- Promiscuous mode
+- Multicast mode
+- Port hardware statistics
+- Jumbo frames
+- Link state information
+- Link flow control
+- Interrupt mode for RX
+- Scattered for RX
+
+
+Config File Options
+~~~~~~~~~~~~~~~~~~~
+
+The following options can be modified in the ``config`` file.
+Please note that enabling debugging options may affect system performance.
+
+- ``CONFIG_RTE_LIBRTE_IGC_PMD`` (default ``y``)
+
+ Toggle compilation of the ``librte_pmd_igc`` driver.
+
+- ``CONFIG_RTE_LIBRTE_IGC_DEBUG_*`` (default ``n``)
+
+ Toggle display of generic debugging messages.
+
+
+Driver compilation and testing
+------------------------------
+
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
+
+
+Limitations or Known issues
+---------------------------
+
+
+Supported Chipsets and NICs
+---------------------------
+
+Foxville LM (I225 LM): Client 2.5G LAN vPro Corporate
+Greenville (I220 V): Client 1G LAN Consumer
+Foxville V (I225 V): Client 2.5G LAN Consumer
+Foxville I (I225 I): Client 2.5G Industrial Temp
--
1.8.3.1
next prev parent reply other threads:[~2020-01-10 3:03 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-10 3:00 [dpdk-dev] [RFC 1/7] net/igc: base driver alvinx.zhang
2020-01-10 3:00 ` [dpdk-dev] [RFC 2/7] net/igc: igc poll mode driver alvinx.zhang
2020-01-10 3:00 ` [dpdk-dev] [RFC 3/7] drivers/net: add igc make alvinx.zhang
2020-01-21 16:43 ` Ferruh Yigit
2020-02-24 4:06 ` Zhang, AlvinX
2020-01-10 3:00 ` [dpdk-dev] [RFC 4/7] igc: add igc library alvinx.zhang
2020-01-10 3:00 ` [dpdk-dev] [RFC 5/7] drivers/net: add meson build for igc alvinx.zhang
2020-01-10 3:00 ` [dpdk-dev] [RFC 6/7] config/common_base: add igc PMD flags alvinx.zhang
2020-01-10 3:00 ` alvinx.zhang [this message]
2020-01-21 16:27 ` [dpdk-dev] [RFC 1/7] net/igc: base driver Ferruh Yigit
2020-02-24 3:58 ` Zhang, AlvinX
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1578625225-110361-7-git-send-email-alvinx.zhang@intel.com \
--to=alvinx.zhang@intel.com \
--cc=beilei.xing@intel.com \
--cc=dev@dpdk.org \
--cc=haiyue.wang@intel.com \
--cc=qi.z.zhang@intel.com \
--cc=xiaolong.ye@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).