GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / misc-devices / pci-endpoint-test.txt
1 Driver for PCI Endpoint Test Function
2
3 This driver should be used as a host side driver if the root complex is
4 connected to a configurable PCI endpoint running *pci_epf_test* function
5 driver configured according to [1].
6
7 The "pci_endpoint_test" driver can be used to perform the following tests.
8
9 The PCI driver for the test device performs the following tests
10         *) verifying addresses programmed in BAR
11         *) raise legacy IRQ
12         *) raise MSI IRQ
13         *) read data
14         *) write data
15         *) copy data
16
17 This misc driver creates /dev/pci-endpoint-test.<num> for every
18 *pci_epf_test* function connected to the root complex and "ioctls"
19 should be used to perform the above tests.
20
21 ioctl
22 -----
23  PCITEST_BAR: Tests the BAR. The number of the BAR to be tested
24               should be passed as argument.
25  PCITEST_LEGACY_IRQ: Tests legacy IRQ
26  PCITEST_MSI: Tests message signalled interrupts. The MSI number
27               to be tested should be passed as argument.
28  PCITEST_WRITE: Perform write tests. The size of the buffer should be passed
29                 as argument.
30  PCITEST_READ: Perform read tests. The size of the buffer should be passed
31                as argument.
32  PCITEST_COPY: Perform read tests. The size of the buffer should be passed
33                as argument.
34
35 [1] -> Documentation/PCI/endpoint/function/binding/pci-test.txt