Skip to content

Commit 0c84f5b

Browse files
kishonLorenzo Pieralisi
authored andcommitted
Documentation: PCI: endpoint/pci-endpoint-cfs: Guide to use SR-IOV
Add Documentation to help users use PCI endpoint to create virtual functions using configfs. An endpoint function is designated as a virtual endpoint function device when it is linked to a physical endpoint function device (instead of a endpoint controller). Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Kishon Vijay Abraham I <[email protected]> Signed-off-by: Lorenzo Pieralisi <[email protected]>
1 parent 489b1f4 commit 0c84f5b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

Documentation/PCI/endpoint/pci-endpoint-cfs.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ entries corresponding to EPF driver will be created by the EPF core.
4343
.. <EPF Driver1>/
4444
... <EPF Device 11>/
4545
... <EPF Device 21>/
46+
... <EPF Device 31>/
4647
.. <EPF Driver2>/
4748
... <EPF Device 12>/
4849
... <EPF Device 22>/
@@ -68,6 +69,7 @@ created)
6869
... subsys_vendor_id
6970
... subsys_id
7071
... interrupt_pin
72+
... <Symlink EPF Device 31>/
7173
... primary/
7274
... <Symlink EPC Device1>/
7375
... secondary/
@@ -79,6 +81,13 @@ interface should be added in 'primary' directory and symlink of endpoint
7981
controller connected to secondary interface should be added in 'secondary'
8082
directory.
8183

84+
The <EPF Device> directory can have a list of symbolic links
85+
(<Symlink EPF Device 31>) to other <EPF Device>. These symbolic links should
86+
be created by the user to represent the virtual functions that are bound to
87+
the physical function. In the above directory structure <EPF Device 11> is a
88+
physical function and <EPF Device 31> is a virtual function. An EPF device once
89+
it's linked to another EPF device, cannot be linked to a EPC device.
90+
8291
EPC Device
8392
==========
8493

@@ -98,7 +107,8 @@ entries corresponding to EPC device will be created by the EPC core.
98107

99108
The <EPC Device> directory will have a list of symbolic links to
100109
<EPF Device>. These symbolic links should be created by the user to
101-
represent the functions present in the endpoint device.
110+
represent the functions present in the endpoint device. Only <EPF Device>
111+
that represents a physical function can be linked to a EPC device.
102112

103113
The <EPC Device> directory will also have a *start* field. Once
104114
"1" is written to this field, the endpoint device will be ready to

0 commit comments

Comments
 (0)