PCI/endpoint/pci-ntb-howto.rst

1 .. SPDX-License-Identifier: GPL-2.0
4 PCI Non-Transparent Bridge (NTB) Endpoint Function (EPF) User Guide
9 This document is a guide to help users use pci-epf-ntb function driver
11 be followed in the host side and EP side is given below. For the hardware
13 Documentation/PCI/endpoint/pci-ntb-function.rst
19 ---------------------------
27 	2900000.pcie-ep  2910000.pcie-ep
32 	2900000.pcie-ep  2910000.pcie-ep
36 -------------------------
40 	# ls /sys/bus/pci-epf/drivers
49 Creating pci-epf-ntb Device
50 ----------------------------
52 PCI endpoint function device can be created using the configfs. To create
53 pci-epf-ntb device, the following commands can be used::
55 	# mount -t configfs none /sys/kernel/config
59 The "mkdir func1" above creates the pci-epf-ntb function device that will
62 The PCI endpoint framework populates the directory with the following
66 	baseclass_code    deviceid          msi_interrupts    pci-epf-ntb.0
71 The PCI endpoint function driver populates these entries with default values
72 when the device is bound to the driver. The pci-epf-ntb driver populates
81 Configuring pci-epf-ntb Device
82 -------------------------------
84 The user can configure the pci-epf-ntb device using its configfs entry. In order
91 The PCI endpoint framework also automatically creates a sub-directory in the
92 function attribute directory. This sub-directory has the same name as the name
108 Binding pci-epf-ntb Device to EP Controller
109 --------------------------------------------
111 NTB function device should be attached to two PCI endpoint controllers
113 inside NTB function device to attach one PCI endpoint controller to
114 primary interface and the other PCI endpoint controller to the secondary
117 	# ln -s controllers/2900000.pcie-ep/ functions/pci-epf-ntb/func1/primary
118 	# ln -s controllers/2910000.pcie-ep/ functions/pci-epf-ntb/func1/secondary
120 Once the above step is completed, both the PCI endpoint controllers are ready to
125 --------------
128 field should be populated with '1'. For NTB, both the PCI endpoint controllers
131 	# echo 1 > controllers/2900000.pcie-ep/start
132 	# echo 1 > controllers/2910000.pcie-ep/start
139 ------------
142 "Creating pci-epf-ntb Device" section above::
145 	0000:00:00.0 PCI bridge: Texas Instruments Device b00d
150 -----------------------
158 :doc:`Non-Transparent Bridge <../../driver-api/ntb>`