From: Kishon Vijay Abraham I <kishon@ti.com>
To: Bjorn Helgaas <bhelgaas@google.com>,
Jonathan Corbet <corbet@lwn.net>,
Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
Jon Mason <jdmason@kudzu.us>, Dave Jiang <dave.jiang@intel.com>,
Allen Hubbe <allenbh@gmail.com>, Rob Herring <robh@kernel.org>
Cc: Arnd Bergmann <arnd@arndb.de>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Tom Joseph <tjoseph@cadence.com>, <linux-pci@vger.kernel.org>,
<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<linux-ntb@googlegroups.com>,
Kishon Vijay Abraham I <kishon@ti.com>
Subject: [PATCH v3 16/17] Documentation: PCI: Add binding documentation for pci-ntb endpoint function
Date: Fri, 4 Sep 2020 13:20:51 +0530 [thread overview]
Message-ID: <20200904075052.8911-17-kishon@ti.com> (raw)
In-Reply-To: <20200904075052.8911-1-kishon@ti.com>
Add binding documentation for pci-ntb endpoint function that helps in
adding and configuring pci-ntb endpoint function.
Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>
---
.../PCI/endpoint/function/binding/pci-ntb.rst | 38 +++++++++++++++++++
Documentation/PCI/endpoint/index.rst | 1 +
2 files changed, 39 insertions(+)
create mode 100644 Documentation/PCI/endpoint/function/binding/pci-ntb.rst
diff --git a/Documentation/PCI/endpoint/function/binding/pci-ntb.rst b/Documentation/PCI/endpoint/function/binding/pci-ntb.rst
new file mode 100644
index 000000000000..40253d3d5163
--- /dev/null
+++ b/Documentation/PCI/endpoint/function/binding/pci-ntb.rst
@@ -0,0 +1,38 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+PCI NTB Endpoint Function
+==========================
+
+1) Create a subdirectory to pci_epf_ntb directory in configfs.
+
+Standard EPF Configurable Fields:
+
+================ ===========================================================
+vendorid should be 0x104c
+deviceid should be 0xb00d for TI's J721E SoC
+revid don't care
+progif_code don't care
+subclass_code should be 0x00
+baseclass_code should be 0x5
+cache_line_size don't care
+subsys_vendor_id don't care
+subsys_id don't care
+interrupt_pin don't care
+msi_interrupts don't care
+msix_interrupts don't care
+================ ===========================================================
+
+2) Create a subdirectory to directory created in 1
+
+NTB EPF specific configurable fields:
+
+================ ===========================================================
+db_count Number of doorbells; default = 4
+mw1 size of memory window1
+mw2 size of memory window2
+mw3 size of memory window3
+mw4 size of memory window4
+num_mws Number of memory windows; max = 4
+spad_count Number of scratchpad registers; default = 64
+================ ===========================================================
diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst
index ef6861128506..9cb6e5f3c4d5 100644
--- a/Documentation/PCI/endpoint/index.rst
+++ b/Documentation/PCI/endpoint/index.rst
@@ -14,3 +14,4 @@ PCI Endpoint Framework
pci-ntb-function
function/binding/pci-test
+ function/binding/pci-ntb
--
2.17.1
WARNING: multiple messages have this Message-ID (diff)
From: Kishon Vijay Abraham I <kishon@ti.com>
To: Bjorn Helgaas <bhelgaas@google.com>,
Jonathan Corbet <corbet@lwn.net>,
Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
Jon Mason <jdmason@kudzu.us>, Dave Jiang <dave.jiang@intel.com>,
Allen Hubbe <allenbh@gmail.com>, Rob Herring <robh@kernel.org>
Cc: Arnd Bergmann <arnd@arndb.de>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Tom Joseph <tjoseph@cadence.com>,
linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-ntb@googlegroups.com,
Kishon Vijay Abraham I <kishon@ti.com>
Subject: [PATCH v3 16/17] Documentation: PCI: Add binding documentation for pci-ntb endpoint function
Date: Fri, 4 Sep 2020 13:20:51 +0530 [thread overview]
Message-ID: <20200904075052.8911-17-kishon@ti.com> (raw)
In-Reply-To: <20200904075052.8911-1-kishon@ti.com>
Add binding documentation for pci-ntb endpoint function that helps in
adding and configuring pci-ntb endpoint function.
Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>
---
.../PCI/endpoint/function/binding/pci-ntb.rst | 38 +++++++++++++++++++
Documentation/PCI/endpoint/index.rst | 1 +
2 files changed, 39 insertions(+)
create mode 100644 Documentation/PCI/endpoint/function/binding/pci-ntb.rst
diff --git a/Documentation/PCI/endpoint/function/binding/pci-ntb.rst b/Documentation/PCI/endpoint/function/binding/pci-ntb.rst
new file mode 100644
index 000000000000..40253d3d5163
--- /dev/null
+++ b/Documentation/PCI/endpoint/function/binding/pci-ntb.rst
@@ -0,0 +1,38 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+PCI NTB Endpoint Function
+==========================
+
+1) Create a subdirectory to pci_epf_ntb directory in configfs.
+
+Standard EPF Configurable Fields:
+
+================ ===========================================================
+vendorid should be 0x104c
+deviceid should be 0xb00d for TI's J721E SoC
+revid don't care
+progif_code don't care
+subclass_code should be 0x00
+baseclass_code should be 0x5
+cache_line_size don't care
+subsys_vendor_id don't care
+subsys_id don't care
+interrupt_pin don't care
+msi_interrupts don't care
+msix_interrupts don't care
+================ ===========================================================
+
+2) Create a subdirectory to directory created in 1
+
+NTB EPF specific configurable fields:
+
+================ ===========================================================
+db_count Number of doorbells; default = 4
+mw1 size of memory window1
+mw2 size of memory window2
+mw3 size of memory window3
+mw4 size of memory window4
+num_mws Number of memory windows; max = 4
+spad_count Number of scratchpad registers; default = 64
+================ ===========================================================
diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst
index ef6861128506..9cb6e5f3c4d5 100644
--- a/Documentation/PCI/endpoint/index.rst
+++ b/Documentation/PCI/endpoint/index.rst
@@ -14,3 +14,4 @@ PCI Endpoint Framework
pci-ntb-function
function/binding/pci-test
+ function/binding/pci-ntb
--
2.17.1
next prev parent reply other threads:[~2020-09-04 7:52 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-04 7:50 [PATCH v3 00/17] Implement NTB Controller using multiple PCI EP Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 01/17] Documentation: PCI: Add specification for the *PCI NTB* function device Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 02/17] PCI: endpoint: Make *_get_first_free_bar() take into account 64 bit BAR Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 03/17] PCI: endpoint: Add helper API to get the 'next' unreserved BAR Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 04/17] PCI: endpoint: Make *_free_bar() to return error codes on failure Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 05/17] PCI: endpoint: Remove unused pci_epf_match_device() Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 06/17] PCI: endpoint: Add support to associate secondary EPC with EPF Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 07/17] PCI: endpoint: Add support in configfs to associate two EPCs " Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 08/17] PCI: endpoint: Add pci_epc_ops to map MSI irq Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 09/17] PCI: endpoint: Add pci_epf_ops for epf drivers to expose function specific attrs Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 10/17] PCI: endpoint: Allow user to create sub-directory of 'EPF Device' directory Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 11/17] PCI: cadence: Implement ->msi_map_irq() ops Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 12/17] PCI: endpoint: Add EP function driver to provide NTB functionality Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 13/17] PCI: Add TI J721E device to pci ids Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 14/17] NTB: Add support for EPF PCI-Express Non-Transparent Bridge Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 15/17] NTB: tool: Enable the NTB/PCIe link on the local or remote side of bridge Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I [this message]
2020-09-04 7:50 ` [PATCH v3 16/17] Documentation: PCI: Add binding documentation for pci-ntb endpoint function Kishon Vijay Abraham I
2020-09-04 7:50 ` [PATCH v3 17/17] Documentation: PCI: Add userguide for PCI endpoint NTB function Kishon Vijay Abraham I
2020-09-04 7:50 ` Kishon Vijay Abraham I
2020-09-05 22:08 ` Randy Dunlap
2020-09-14 15:36 ` Kishon Vijay Abraham I
2020-09-14 15:36 ` Kishon Vijay Abraham I
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200904075052.8911-17-kishon@ti.com \
--to=kishon@ti.com \
--cc=allenbh@gmail.com \
--cc=arnd@arndb.de \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=dave.jiang@intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=jdmason@kudzu.us \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-ntb@googlegroups.com \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=robh@kernel.org \
--cc=tjoseph@cadence.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.