PCI/endpoint/pci-vntb-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-vntb function driver
13 Documentation/PCI/endpoint/pci-vntb-function.rst
15 Endpoint Device
18 Endpoint Controller Devices
19 ---------------------------
21 To find the list of endpoint controller devices in the system::
28         # ls /sys/kernel/config/pci_ep/controllers
31 Endpoint Function Drivers
32 -------------------------
34 To find the list of endpoint function drivers in the system::
36 	# ls /sys/bus/pci-epf/drivers
41 	# ls /sys/kernel/config/pci_ep/functions
45 Creating pci-epf-vntb Device
46 ----------------------------
48 PCI endpoint function device can be created using the configfs. To create
49 pci-epf-vntb device, the following commands can be used::
51 	# mount -t configfs none /sys/kernel/config
52 	# cd /sys/kernel/config/pci_ep/
55 The "mkdir func1" above creates the pci-epf-ntb function device that will
58 The PCI endpoint framework populates the directory with the following
62 	baseclass_code    deviceid          msi_interrupts    pci-epf-ntb.0
67 The PCI endpoint function driver populates these entries with default values
68 when the device is bound to the driver. The pci-epf-vntb driver populates
77 Configuring pci-epf-vntb Device
78 -------------------------------
80 The user can configure the pci-epf-vntb device using its configfs entry. In order
87 The PCI endpoint framework also automatically creates a sub-directory in the
88 function attribute directory. This sub-directory has the same name as the name
109 Binding pci-epf-ntb Device to EP Controller
110 --------------------------------------------
112 NTB function device should be attached to PCI endpoint controllers
115 	# ln -s controllers/5f010000.pcie_ep functions/pci-epf-ntb/func1/primary
117 Once the above step is completed, the PCI endpoint controllers are ready to
122 --------------
124 In order for the endpoint device to establish a link with the host, the _start_
125 field should be populated with '1'. For NTB, both the PCI endpoint controllers
134 -------------------------
137 "Creating pci-epf-ntb Device" section above::
143 Endpoint Device / Virtual PCI bus
147 -----------------------------------------
150 "Creating pci-epf-ntb Device" section above::
156 -----------------------
164 :doc:`Non-Transparent Bridge <../../driver-api/ntb>`