net/hinic3: add huawei/hinic3 driver (dcb286ce) · Commits · EulixOS / Software / Kernel

Documentation/networking/hinic3.rst

0 → 100644

+128 −0

Original line number	Diff line number	Diff line
		.. SPDX-License-Identifier: GPL-2.0

		============================================================
		Linux Kernel Driver for Huawei Intelligent NIC(HiNIC3) family
		============================================================

		Overview:
		=========
		HiNIC3 is a network interface card for the Data Center Area.

		The driver supports a range of link-speed devices (10GbE, 25GbE, 40GbE, etc.).
		The driver supports also a negotiated and extendable feature set.

		Some HiNIC3 devices support SR-IOV. This driver is used for Physical Function
		(PF).

		HiNIC3 devices support MSI-X interrupt vector for each Tx/Rx queue and
		adaptive interrupt moderation.

		HiNIC3 devices support also various offload features such as checksum offload,
		TCP Transmit Segmentation Offload(TSO), Receive-Side Scaling(RSS) and
		LRO(Large Receive Offload).


		Supported PCI vendor ID/device IDs:
		===================================

		19e5:1822 - HiNIC3 PF


		Driver Architecture and Source Code:
		====================================

		hinic3_dev - Implement a Logical Network device that is independent from
		specific HW details about HW data structure formats.

		hinic3_hwdev - Implement the HW details of the device and include the components
		for accessing the PCI NIC.

		hinic3_hwdev contains the following components:
		===============================================

		HW Interface:
		=============

		The interface for accessing the pci device (DMA memory and PCI BARs).
		(hinic3_hw_if.c, hinic3_hw_if.h)

		Configuration Status Registers Area that describes the HW Registers on the
		configuration and status BAR0. (hinic3_hw_csr.h)

		MGMT components:
		================

		Asynchronous Event Queues(AEQs) - The event queues for receiving messages from
		the MGMT modules on the cards. (hinic3_hw_eqs.c, hinic3_hw_eqs.h)

		Application Programmable Interface commands(API CMD) - Interface for sending
		MGMT commands to the card. (hinic3_hw_api_cmd.c, hinic3_hw_api_cmd.h)

		Management (MGMT) - the PF to MGMT channel that uses API CMD for sending MGMT
		commands to the card and receives notifications from the MGMT modules on the
		card by AEQs. Also set the addresses of the IO CMDQs in HW.
		(hinic3_hw_mgmt.c, hinic3_hw_mgmt.h)

		IO components:
		==============

		Completion Event Queues(CEQs) - The completion Event Queues that describe IO
		tasks that are finished. (hinic3_hw_eqs.c, hinic3_hw_eqs.h)

		Work Queues(WQ) - Contain the memory and operations for use by CMD queues and
		the Queue Pairs. The WQ is a Memory Block in a Page. The Block contains
		pointers to Memory Areas that are the Memory for the Work Queue Elements(WQEs).
		(hinic3_hw_wq.c, hinic3_hw_wq.h)

		Command Queues(CMDQ) - The queues for sending commands for IO management and is
		used to set the QPs addresses in HW. The commands completion events are
		accumulated on the CEQ that is configured to receive the CMDQ completion events.
		(hinic3_hw_cmdq.c, hinic3_hw_cmdq.h)

		Queue Pairs(QPs) - The HW Receive and Send queues for Receiving and Transmitting
		Data. (hinic3_hw_qp.c, hinic3_hw_qp.h, hinic3_hw_qp_ctxt.h)

		IO - de/constructs all the IO components. (hinic3_hw_io.c, hinic3_hw_io.h)

		HW device:
		==========

		HW device - de/constructs the HW Interface, the MGMT components on the
		initialization of the driver and the IO components on the case of Interface
		UP/DOWN Events. (hinic3_hw_dev.c, hinic3_hw_dev.h)


		hinic3_dev contains the following components:
		===============================================

		PCI ID table - Contains the supported PCI Vendor/Device IDs.
		(hinic3_pci_tbl.h)

		Port Commands - Send commands to the HW device for port management
		(MAC, Vlan, MTU, ...). (hinic3_port.c, hinic3_port.h)

		Tx Queues - Logical Tx Queues that use the HW Send Queues for transmit.
		The Logical Tx queue is not dependent on the format of the HW Send Queue.
		(hinic3_tx.c, hinic3_tx.h)

		Rx Queues - Logical Rx Queues that use the HW Receive Queues for receive.
		The Logical Rx queue is not dependent on the format of the HW Receive Queue.
		(hinic3_rx.c, hinic3_rx.h)

		hinic_dev - de/constructs the Logical Tx and Rx Queues.
		(hinic3_main.c, hinic3_dev.h)


		Miscellaneous:
		=============

		Common functions that are used by HW and Logical Device.
		(hinic3_common.c, hinic3_common.h)


		Support
		=======

		If an issue is identified with the released source code on the supported kernel
		with a supported adapter, email the specific information related to the issue to
		wulike1@huawei.com.

MAINTAINERS

+7 −0

Original line number	Diff line number	Diff line
		@@ -9654,6 +9654,13 @@ S: Maintained
		F: Documentation/networking/device_drivers/ethernet/huawei/hinic.rst
		F: drivers/net/ethernet/huawei/hinic/

		HUAWEI ETHERNET DRIVER
		M: Wulike(Collin) <wulike1@huawei.com>
		L: netdev@vger.kernel.org
		S: Supported
		F: Documentation/networking/hinic3.rst
		F: drivers/net/ethernet/huawei/hinic3/

		HUGETLB SUBSYSTEM
		M: Mike Kravetz <mike.kravetz@oracle.com>
		M: Muchun Song <muchun.song@linux.dev>

arch/arm64/configs/openeuler_defconfig

+1 −0

Original line number	Diff line number	Diff line
		@@ -2890,6 +2890,7 @@ CONFIG_HNS3_HCLGEVF=m
		CONFIG_HNS3_ENET=m
		CONFIG_NET_VENDOR_HUAWEI=y
		CONFIG_HINIC=m
		CONFIG_HINIC3=m
		# CONFIG_NET_VENDOR_I825XX is not set
		CONFIG_NET_VENDOR_INTEL=y
		# CONFIG_E100 is not set

arch/x86/configs/openeuler_defconfig

+1 −0

Original line number	Diff line number	Diff line
		@@ -2890,6 +2890,7 @@ CONFIG_NET_VENDOR_GOOGLE=y
		# CONFIG_GVE is not set
		CONFIG_NET_VENDOR_HUAWEI=y
		CONFIG_HINIC=m
		CONFIG_HINIC3=m
		# CONFIG_NET_VENDOR_I825XX is not set
		CONFIG_NET_VENDOR_INTEL=y
		# CONFIG_E100 is not set

drivers/net/ethernet/huawei/Kconfig

+1 −0

Original line number	Diff line number	Diff line
		@@ -16,5 +16,6 @@ config NET_VENDOR_HUAWEI
		if NET_VENDOR_HUAWEI

		source "drivers/net/ethernet/huawei/hinic/Kconfig"
		source "drivers/net/ethernet/huawei/hinic3/Kconfig"

		endif # NET_VENDOR_HUAWEI