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
11 be followed in the host side and EP side is given below. For the hardware
13 Documentation/PCI/endpoint/pci-vntb-function.rst
19 ---------------------------
21 To find the list of endpoint controller devices in the system::
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 ----------------------------
49 pci-epf-vntb device, the following commands can be used::
51 	# mount -t configfs none /sys/kernel/config
53 	# mkdir functions/pci_epf_vntb/func1
55 The "mkdir func1" above creates the pci-epf-ntb function device that will
61 	# ls functions/pci_epf_ntb/func1
62 	baseclass_code    deviceid          msi_interrupts    pci-epf-ntb.0
68 when the device is bound to the driver. The pci-epf-vntb driver populates
71 	# cat functions/pci_epf_vntb/func1/vendorid
73 	# cat functions/pci_epf_vntb/func1/interrupt_pin
77 Configuring pci-epf-vntb Device
78 -------------------------------
80 The user can configure the pci-epf-vntb device using its configfs entry. In order
84 	# echo 0x1957 > functions/pci_epf_vntb/func1/vendorid
85 	# echo 0x0809 > functions/pci_epf_vntb/func1/deviceid
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
92 	# ls functions/pci_epf_vntb/func1/pci_epf_vntb.0/
98 	# echo 4 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/db_count
99 	# echo 128 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/spad_count
100 	# echo 1 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/num_mws
101 	# echo 0x100000 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/mw1
105 	# echo 0x1957 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/vntb_vid
106 	# echo 0x080A > functions/pci_epf_vntb/func1/pci_epf_vntb.0/vntb_pid
107 	# echo 0x10 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/vbus_number
109 Binding pci-epf-ntb Device to EP Controller
110 --------------------------------------------
115 	# ln -s controllers/5f010000.pcie_ep functions/pci-epf-ntb/func1/primary
122 --------------
124 In order for the endpoint device to establish a link with the host, the _start_
134 -------------------------
136 Note that the devices listed here correspond to the values populated in
137 "Creating pci-epf-ntb Device" section above::
147 -----------------------------------------
149 Note that the devices listed here correspond to the values populated in
150 "Creating pci-epf-ntb Device" section above::
156 -----------------------
158 The host side software follows the standard NTB software architecture in Linux.
164 :doc:`Non-Transparent Bridge <../../driver-api/ntb>`