2024-03-01 11:00:28

by Alexander Stein

[permalink] [raw]
Subject: [PATCH 1/1] Documentation: PCI: pci-endpoint: Fix EPF ops list

With commit 5779dd0a7dbd7 ("PCI: endpoint: Use notification chain
mechanism to notify EPC events to EPF") the linkup callback has been
removed and replaced by EPC event notifications.
With commit 256ae475201b1 ("PCI: endpoint: Add pci_epf_ops to expose
function-specific attrs") a new (optional) add_cfs callback was added.
Update documentation accordingly.

Signed-off-by: Alexander Stein <[email protected]>
---
Documentation/PCI/endpoint/pci-endpoint.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/PCI/endpoint/pci-endpoint.rst b/Documentation/PCI/endpoint/pci-endpoint.rst
index 4f5622a655557..3961ff4e5bebf 100644
--- a/Documentation/PCI/endpoint/pci-endpoint.rst
+++ b/Documentation/PCI/endpoint/pci-endpoint.rst
@@ -172,8 +172,7 @@ by the PCI endpoint function driver.
* bind: ops to perform when a EPC device has been bound to EPF device
* unbind: ops to perform when a binding has been lost between a EPC
device and EPF device
- * linkup: ops to perform when the EPC device has established a
- connection with a host system
+ * add_cfs: optional ops to create function specific config attributes

The PCI Function driver can then register the PCI EPF driver by using
pci_epf_register_driver().
--
2.34.1



2024-03-01 22:00:03

by Bjorn Helgaas

[permalink] [raw]
Subject: Re: [PATCH 1/1] Documentation: PCI: pci-endpoint: Fix EPF ops list

On Fri, Mar 01, 2024 at 11:59:50AM +0100, Alexander Stein wrote:
> With commit 5779dd0a7dbd7 ("PCI: endpoint: Use notification chain
> mechanism to notify EPC events to EPF") the linkup callback has been
> removed and replaced by EPC event notifications.
> With commit 256ae475201b1 ("PCI: endpoint: Add pci_epf_ops to expose
> function-specific attrs") a new (optional) add_cfs callback was added.
> Update documentation accordingly.

Add blank lines between paragraphs or rewrap if you intend a single
paragraph.

> Signed-off-by: Alexander Stein <[email protected]>
> ---
> Documentation/PCI/endpoint/pci-endpoint.rst | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/PCI/endpoint/pci-endpoint.rst b/Documentation/PCI/endpoint/pci-endpoint.rst
> index 4f5622a655557..3961ff4e5bebf 100644
> --- a/Documentation/PCI/endpoint/pci-endpoint.rst
> +++ b/Documentation/PCI/endpoint/pci-endpoint.rst
> @@ -172,8 +172,7 @@ by the PCI endpoint function driver.
> * bind: ops to perform when a EPC device has been bound to EPF device
> * unbind: ops to perform when a binding has been lost between a EPC
> device and EPF device
> - * linkup: ops to perform when the EPC device has established a
> - connection with a host system
> + * add_cfs: optional ops to create function specific config attributes
>
> The PCI Function driver can then register the PCI EPF driver by using
> pci_epf_register_driver().
> --
> 2.34.1
>