mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-24 19:35:58 +00:00
Documentation: PCI: convert endpoint/pci-test-howto.txt to reST
Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Changbin Du <changbin.du@gmail.com> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
parent
bf2c2658d4
commit
9595aee2a3
2 changed files with 56 additions and 26 deletions
|
@ -10,3 +10,4 @@ PCI Endpoint Framework
|
||||||
pci-endpoint
|
pci-endpoint
|
||||||
pci-endpoint-cfs
|
pci-endpoint-cfs
|
||||||
pci-test-function
|
pci-test-function
|
||||||
|
pci-test-howto
|
||||||
|
|
|
@ -1,38 +1,51 @@
|
||||||
PCI TEST USERGUIDE
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
Kishon Vijay Abraham I <kishon@ti.com>
|
|
||||||
|
===================
|
||||||
|
PCI Test User Guide
|
||||||
|
===================
|
||||||
|
|
||||||
|
:Author: Kishon Vijay Abraham I <kishon@ti.com>
|
||||||
|
|
||||||
This document is a guide to help users use pci-epf-test function driver
|
This document is a guide to help users use pci-epf-test function driver
|
||||||
and pci_endpoint_test host driver for testing PCI. The list of steps to
|
and pci_endpoint_test host driver for testing PCI. The list of steps to
|
||||||
be followed in the host side and EP side is given below.
|
be followed in the host side and EP side is given below.
|
||||||
|
|
||||||
1. Endpoint Device
|
Endpoint Device
|
||||||
|
===============
|
||||||
|
|
||||||
1.1 Endpoint Controller Devices
|
Endpoint Controller Devices
|
||||||
|
---------------------------
|
||||||
|
|
||||||
To find the list of endpoint controller devices in the system:
|
To find the list of endpoint controller devices in the system::
|
||||||
|
|
||||||
# ls /sys/class/pci_epc/
|
# ls /sys/class/pci_epc/
|
||||||
51000000.pcie_ep
|
51000000.pcie_ep
|
||||||
|
|
||||||
If PCI_ENDPOINT_CONFIGFS is enabled
|
If PCI_ENDPOINT_CONFIGFS is enabled::
|
||||||
|
|
||||||
# ls /sys/kernel/config/pci_ep/controllers
|
# ls /sys/kernel/config/pci_ep/controllers
|
||||||
51000000.pcie_ep
|
51000000.pcie_ep
|
||||||
|
|
||||||
1.2 Endpoint Function Drivers
|
|
||||||
|
|
||||||
To find the list of endpoint function drivers in the system:
|
Endpoint Function Drivers
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
To find the list of endpoint function drivers in the system::
|
||||||
|
|
||||||
# ls /sys/bus/pci-epf/drivers
|
# ls /sys/bus/pci-epf/drivers
|
||||||
pci_epf_test
|
pci_epf_test
|
||||||
|
|
||||||
If PCI_ENDPOINT_CONFIGFS is enabled
|
If PCI_ENDPOINT_CONFIGFS is enabled::
|
||||||
|
|
||||||
# ls /sys/kernel/config/pci_ep/functions
|
# ls /sys/kernel/config/pci_ep/functions
|
||||||
pci_epf_test
|
pci_epf_test
|
||||||
|
|
||||||
1.3 Creating pci-epf-test Device
|
|
||||||
|
Creating pci-epf-test Device
|
||||||
|
----------------------------
|
||||||
|
|
||||||
PCI endpoint function device can be created using the configfs. To create
|
PCI endpoint function device can be created using the configfs. To create
|
||||||
pci-epf-test device, the following commands can be used
|
pci-epf-test device, the following commands can be used::
|
||||||
|
|
||||||
# mount -t configfs none /sys/kernel/config
|
# mount -t configfs none /sys/kernel/config
|
||||||
# cd /sys/kernel/config/pci_ep/
|
# cd /sys/kernel/config/pci_ep/
|
||||||
|
@ -42,7 +55,7 @@ The "mkdir func1" above creates the pci-epf-test function device that will
|
||||||
be probed by pci_epf_test driver.
|
be probed by pci_epf_test driver.
|
||||||
|
|
||||||
The PCI endpoint framework populates the directory with the following
|
The PCI endpoint framework populates the directory with the following
|
||||||
configurable fields.
|
configurable fields::
|
||||||
|
|
||||||
# ls functions/pci_epf_test/func1
|
# ls functions/pci_epf_test/func1
|
||||||
baseclass_code interrupt_pin progif_code subsys_id
|
baseclass_code interrupt_pin progif_code subsys_id
|
||||||
|
@ -51,67 +64,83 @@ configurable fields.
|
||||||
|
|
||||||
The PCI endpoint function driver populates these entries with default values
|
The PCI endpoint function driver populates these entries with default values
|
||||||
when the device is bound to the driver. The pci-epf-test driver populates
|
when the device is bound to the driver. The pci-epf-test driver populates
|
||||||
vendorid with 0xffff and interrupt_pin with 0x0001
|
vendorid with 0xffff and interrupt_pin with 0x0001::
|
||||||
|
|
||||||
# cat functions/pci_epf_test/func1/vendorid
|
# cat functions/pci_epf_test/func1/vendorid
|
||||||
0xffff
|
0xffff
|
||||||
# cat functions/pci_epf_test/func1/interrupt_pin
|
# cat functions/pci_epf_test/func1/interrupt_pin
|
||||||
0x0001
|
0x0001
|
||||||
|
|
||||||
1.4 Configuring pci-epf-test Device
|
|
||||||
|
Configuring pci-epf-test Device
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
The user can configure the pci-epf-test device using configfs entry. In order
|
The user can configure the pci-epf-test device using configfs entry. In order
|
||||||
to change the vendorid and the number of MSI interrupts used by the function
|
to change the vendorid and the number of MSI interrupts used by the function
|
||||||
device, the following commands can be used.
|
device, the following commands can be used::
|
||||||
|
|
||||||
# echo 0x104c > functions/pci_epf_test/func1/vendorid
|
# echo 0x104c > functions/pci_epf_test/func1/vendorid
|
||||||
# echo 0xb500 > functions/pci_epf_test/func1/deviceid
|
# echo 0xb500 > functions/pci_epf_test/func1/deviceid
|
||||||
# echo 16 > functions/pci_epf_test/func1/msi_interrupts
|
# echo 16 > functions/pci_epf_test/func1/msi_interrupts
|
||||||
# echo 8 > functions/pci_epf_test/func1/msix_interrupts
|
# echo 8 > functions/pci_epf_test/func1/msix_interrupts
|
||||||
|
|
||||||
1.5 Binding pci-epf-test Device to EP Controller
|
|
||||||
|
Binding pci-epf-test Device to EP Controller
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
In order for the endpoint function device to be useful, it has to be bound to
|
In order for the endpoint function device to be useful, it has to be bound to
|
||||||
a PCI endpoint controller driver. Use the configfs to bind the function
|
a PCI endpoint controller driver. Use the configfs to bind the function
|
||||||
device to one of the controller driver present in the system.
|
device to one of the controller driver present in the system::
|
||||||
|
|
||||||
# ln -s functions/pci_epf_test/func1 controllers/51000000.pcie_ep/
|
# ln -s functions/pci_epf_test/func1 controllers/51000000.pcie_ep/
|
||||||
|
|
||||||
Once the above step is completed, the PCI endpoint is ready to establish a link
|
Once the above step is completed, the PCI endpoint is ready to establish a link
|
||||||
with the host.
|
with the host.
|
||||||
|
|
||||||
1.6 Start the Link
|
|
||||||
|
Start the Link
|
||||||
|
--------------
|
||||||
|
|
||||||
In order for the endpoint device to establish a link with the host, the _start_
|
In order for the endpoint device to establish a link with the host, the _start_
|
||||||
field should be populated with '1'.
|
field should be populated with '1'::
|
||||||
|
|
||||||
# echo 1 > controllers/51000000.pcie_ep/start
|
# echo 1 > controllers/51000000.pcie_ep/start
|
||||||
|
|
||||||
2. RootComplex Device
|
|
||||||
|
|
||||||
2.1 lspci Output
|
RootComplex Device
|
||||||
|
==================
|
||||||
|
|
||||||
Note that the devices listed here correspond to the value populated in 1.4 above
|
lspci Output
|
||||||
|
------------
|
||||||
|
|
||||||
|
Note that the devices listed here correspond to the value populated in 1.4
|
||||||
|
above::
|
||||||
|
|
||||||
00:00.0 PCI bridge: Texas Instruments Device 8888 (rev 01)
|
00:00.0 PCI bridge: Texas Instruments Device 8888 (rev 01)
|
||||||
01:00.0 Unassigned class [ff00]: Texas Instruments Device b500
|
01:00.0 Unassigned class [ff00]: Texas Instruments Device b500
|
||||||
|
|
||||||
2.2 Using Endpoint Test function Device
|
|
||||||
|
Using Endpoint Test function Device
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
pcitest.sh added in tools/pci/ can be used to run all the default PCI endpoint
|
pcitest.sh added in tools/pci/ can be used to run all the default PCI endpoint
|
||||||
tests. To compile this tool the following commands should be used:
|
tests. To compile this tool the following commands should be used::
|
||||||
|
|
||||||
# cd <kernel-dir>
|
# cd <kernel-dir>
|
||||||
# make -C tools/pci
|
# make -C tools/pci
|
||||||
|
|
||||||
or if you desire to compile and install in your system:
|
or if you desire to compile and install in your system::
|
||||||
|
|
||||||
# cd <kernel-dir>
|
# cd <kernel-dir>
|
||||||
# make -C tools/pci install
|
# make -C tools/pci install
|
||||||
|
|
||||||
The tool and script will be located in <rootfs>/usr/bin/
|
The tool and script will be located in <rootfs>/usr/bin/
|
||||||
|
|
||||||
2.2.1 pcitest.sh Output
|
|
||||||
|
pcitest.sh Output
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
::
|
||||||
|
|
||||||
# pcitest.sh
|
# pcitest.sh
|
||||||
BAR tests
|
BAR tests
|
||||||
|
|
Loading…
Reference in a new issue