[PATCH] Documentation: PCI: endpoint: document BAR assignment

[PATCH] Documentation: PCI: endpoint: document BAR assignment

[Jerome Brunet]

It is now possible to assign BARs while creating a vNTB endpoint function.
Update the documentation accordingly.

Suggested-by: Bjorn Helgaas <helgaas@kernel.org>
Signed-off-by: Jerome Brunet <jbrunet@baylibre.com>
---
 Documentation/PCI/endpoint/pci-vntb-howto.rst | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/Documentation/PCI/endpoint/pci-vntb-howto.rst b/Documentation/PCI/endpoint/pci-vntb-howto.rst
index 70d3bc90893f3315a7dff394d57e45c8378e2a54..9a7a2f0a68498e8b4297f24261954558d45c43a9 100644
--- a/Documentation/PCI/endpoint/pci-vntb-howto.rst
+++ b/Documentation/PCI/endpoint/pci-vntb-howto.rst
@@ -90,8 +90,9 @@ of the function device and is populated with the following NTB specific
 attributes that can be configured by the user::
 
 	# ls functions/pci_epf_vntb/func1/pci_epf_vntb.0/
-	db_count    mw1         mw2         mw3         mw4         num_mws
-	spad_count
+	ctrl_bar  db_count  mw1_bar  mw2_bar  mw3_bar  mw4_bar	spad_count
+	db_bar	  mw1	    mw2      mw3      mw4      num_mws	vbus_number
+	vntb_vid  vntb_pid
 
 A sample configuration for NTB function is given below::
 
@@ -100,6 +101,10 @@ A sample configuration for NTB function is given below::
 	# echo 1 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/num_mws
 	# echo 0x100000 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/mw1
 
+By default, each construct is assigned a BAR, as needed and in order.
+Should a specific BAR setup be required by the platform, BAR may be assigned
+to each construct using the related ``XYZ_bar`` entry.
+
 A sample configuration for virtual NTB driver for virtual PCI bus::
 
 	# echo 0x1957 > functions/pci_epf_vntb/func1/pci_epf_vntb.0/vntb_vid

---
base-commit: e046b1731006b4c6c94bcb4ef1c6692a30014c43
change-id: 20250731-vntb-doc-cdeaabf61e84

Best regards,
-- 
Jerome

Re: [PATCH] Documentation: PCI: endpoint: document BAR assignment

[Manivannan Sadhasivam]

On Thu, 31 Jul 2025 14:49:01 +0200, Jerome Brunet wrote:
> It is now possible to assign BARs while creating a vNTB endpoint function.
> Update the documentation accordingly.
> 
> 

Applied, thanks!

[1/1] Documentation: PCI: endpoint: document BAR assignment
      commit: 5f523381fdd44bcc3210ec18653eccafe4c4bf94

Best regards,
-- 
Manivannan Sadhasivam <mani@kernel.org>