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
12 configuration and internals of NTB using configurable endpoints see
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 ----------------------------
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
63 configurable fields::
66 	baseclass_code    deviceid          msi_interrupts    pci-epf-ntb.0
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 --------------------------------------------
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
125 --------------
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::
150 -----------------------
158 :doc:`Non-Transparent Bridge <../../driver-api/ntb>`