tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Documentation: PCI: convert endpoint/pci-test-function.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>
authored by
Changbin Du
and committed by
Bjorn Helgaas
bf2c2658
d4518e4a
+50
-33
+1
Documentation/PCI/endpoint/index.rst
+1
Documentation/PCI/endpoint/index.rst
+49
-33
Documentation/PCI/endpoint/pci-test-function.txt
Documentation/PCI/endpoint/pci-test-function.rst
+49
-33
Documentation/PCI/endpoint/pci-test-function.txt
Documentation/PCI/endpoint/pci-test-function.rst
···
1
-
PCI TEST
2
-
Kishon Vijay Abraham I <kishon@ti.com>
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
=================
4
+
PCI Test Function
5
+
=================
6
+
7
+
:Author: Kishon Vijay Abraham I <kishon@ti.com>
3
8
4
9
Traditionally PCI RC has always been validated by using standard
5
10
PCI cards like ethernet PCI cards or USB PCI cards or SATA PCI cards.
···
28
23
8) PCI_ENDPOINT_TEST_IRQ_TYPE
29
24
9) PCI_ENDPOINT_TEST_IRQ_NUMBER
30
25
31
-
*) PCI_ENDPOINT_TEST_MAGIC
26
+
* PCI_ENDPOINT_TEST_MAGIC
32
27
33
28
This register will be used to test BAR0. A known pattern will be written
34
29
and read back from MAGIC register to verify BAR0.
35
30
36
-
*) PCI_ENDPOINT_TEST_COMMAND:
31
+
* PCI_ENDPOINT_TEST_COMMAND
37
32
38
33
This register will be used by the host driver to indicate the function
39
34
that the endpoint device must perform.
40
35
41
-
Bitfield Description:
42
-
Bit 0 : raise legacy IRQ
43
-
Bit 1 : raise MSI IRQ
44
-
Bit 2 : raise MSI-X IRQ
45
-
Bit 3 : read command (read data from RC buffer)
46
-
Bit 4 : write command (write data to RC buffer)
47
-
Bit 5 : copy command (copy data from one RC buffer to another
48
-
RC buffer)
36
+
======== ================================================================
37
+
Bitfield Description
38
+
======== ================================================================
39
+
Bit 0 raise legacy IRQ
40
+
Bit 1 raise MSI IRQ
41
+
Bit 2 raise MSI-X IRQ
42
+
Bit 3 read command (read data from RC buffer)
43
+
Bit 4 write command (write data to RC buffer)
44
+
Bit 5 copy command (copy data from one RC buffer to another RC buffer)
45
+
======== ================================================================
49
46
50
-
*) PCI_ENDPOINT_TEST_STATUS
47
+
* PCI_ENDPOINT_TEST_STATUS
51
48
52
49
This register reflects the status of the PCI endpoint device.
53
50
54
-
Bitfield Description:
55
-
Bit 0 : read success
56
-
Bit 1 : read fail
57
-
Bit 2 : write success
58
-
Bit 3 : write fail
59
-
Bit 4 : copy success
60
-
Bit 5 : copy fail
61
-
Bit 6 : IRQ raised
62
-
Bit 7 : source address is invalid
63
-
Bit 8 : destination address is invalid
51
+
======== ==============================
52
+
Bitfield Description
53
+
======== ==============================
54
+
Bit 0 read success
55
+
Bit 1 read fail
56
+
Bit 2 write success
57
+
Bit 3 write fail
58
+
Bit 4 copy success
59
+
Bit 5 copy fail
60
+
Bit 6 IRQ raised
61
+
Bit 7 source address is invalid
62
+
Bit 8 destination address is invalid
63
+
======== ==============================
64
64
65
-
*) PCI_ENDPOINT_TEST_SRC_ADDR
65
+
* PCI_ENDPOINT_TEST_SRC_ADDR
66
66
67
67
This register contains the source address (RC buffer address) for the
68
68
COPY/READ command.
69
69
70
-
*) PCI_ENDPOINT_TEST_DST_ADDR
70
+
* PCI_ENDPOINT_TEST_DST_ADDR
71
71
72
72
This register contains the destination address (RC buffer address) for
73
73
the COPY/WRITE command.
74
74
75
-
*) PCI_ENDPOINT_TEST_IRQ_TYPE
75
+
* PCI_ENDPOINT_TEST_IRQ_TYPE
76
76
77
77
This register contains the interrupt type (Legacy/MSI) triggered
78
78
for the READ/WRITE/COPY and raise IRQ (Legacy/MSI) commands.
79
79
80
80
Possible types:
81
-
- Legacy : 0
82
-
- MSI : 1
83
-
- MSI-X : 2
84
81
85
-
*) PCI_ENDPOINT_TEST_IRQ_NUMBER
82
+
====== ==
83
+
Legacy 0
84
+
MSI 1
85
+
MSI-X 2
86
+
====== ==
87
+
88
+
* PCI_ENDPOINT_TEST_IRQ_NUMBER
86
89
87
90
This register contains the triggered ID interrupt.
88
91
89
92
Admissible values:
90
-
- Legacy : 0
91
-
- MSI : [1 .. 32]
92
-
- MSI-X : [1 .. 2048]
93
+
94
+
====== ===========
95
+
Legacy 0
96
+
MSI [1 .. 32]
97
+
MSI-X [1 .. 2048]
98
+
====== ===========