net/hinic: get firmware version
[dpdk.git] / doc / guides / nics / hinic.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2017 Huawei Technologies Co., Ltd
3
4
5 HINIC Poll Mode Driver
6 ======================
7
8 The hinic PMD (librte_pmd_hinic) provides poll mode driver support
9 for 25Gbps Huawei Intelligent PCIE Network Adapters based on the
10 Huawei Ethernet Controller Hi1822.
11
12
13 Features
14 --------
15
16 - Multi arch support: x86_64, ARMv8.
17 - Multiple queues for TX and RX
18 - Receiver Side Scaling (RSS)
19 - MAC/VLAN filtering
20 - Checksum offload
21 - TSO offload
22 - Promiscuous mode
23 - Port hardware statistics
24 - Link state information
25 - Link flow control
26 - Scattered and gather for TX and RX
27 - SR-IOV - Partially supported at this point, VFIO only
28 - VLAN filter and VLAN offload
29 - Allmulticast mode
30 - MTU update
31 - Unicast MAC filter
32 - Multicast MAC filter
33 - Flow director
34 - Set Link down or up
35 - FW version
36
37 Prerequisites
38 -------------
39
40 - Learning about Huawei Hi1822 IN200 Series Intelligent NICs using
41   `<https://e.huawei.com/en/products/cloud-computing-dc/servers/pcie-ssd/in-card>`_.
42
43 - Getting the latest product documents and software supports using
44   `<https://support.huawei.com/enterprise/en/intelligent-accelerator-components/in500-solution-pid-23507369>`_.
45
46 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
47
48 Pre-Installation Configuration
49 ------------------------------
50
51 Config File Options
52 ~~~~~~~~~~~~~~~~~~~
53
54 The following options can be modified in the ``config`` file.
55
56 - ``CONFIG_RTE_LIBRTE_HINIC_PMD`` (default ``y``)
57
58 Driver compilation and testing
59 ------------------------------
60
61 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
62 for details.
63
64 Limitations or Known issues
65 ---------------------------
66 Build with ICC is not supported yet.
67 X86-32, Power8, ARMv7 and BSD are not supported yet.