From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 08/10] docs: ntb.rst: add blank lines to clean up some Sphinx warnings
Date: Mon, 8 Apr 2019 13:58:24 -0300 [thread overview]
Message-ID: <e2c2fafcce7fd5d631e5f187a3a05a7bfd73c98e.1554742526.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1554742526.git.mchehab+samsung@kernel.org>
In order to make it easier to parse and produce the right output,
add some extra blank lines.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/other/ntb.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/Documentation/other/ntb.rst b/Documentation/other/ntb.rst
index 344a075f81f5..074a423c853c 100644
--- a/Documentation/other/ntb.rst
+++ b/Documentation/other/ntb.rst
@@ -77,11 +77,13 @@ outbound memory window so to have access to the shared memory region.
As one can see the described scenarios can be combined in one portable
algorithm.
+
Local device:
1) Allocate memory for a shared window
2) Initialize memory window by translated address of the allocated region
(it may fail if local memory window initialization is unsupported)
3) Send the translated address and memory window index to a peer device
+
Peer device:
1) Initialize memory window with retrieved address of the allocated
by another device memory region (it may fail if peer memory window
@@ -90,6 +92,7 @@ algorithm.
In accordance with this scenario, the NTB Memory Window API can be used as
follows:
+
Local device:
1) ntb_mw_count(pidx) - retrieve number of memory ranges, which can
be allocated for memory windows between local device and peer device
@@ -105,6 +108,7 @@ follows:
5) Send translated base address (usually together with memory window
number) to the peer device using, for instance, scratchpad or message
registers.
+
Peer device:
1) ntb_peer_mw_set_trans(pidx, midx) - try to set received from other
device (related to pidx) translated address for specified memory
--
2.20.1
next prev parent reply other threads:[~2019-04-08 16:59 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-08 16:58 [PATCH 00/10] Add all documentation files to an html/pdf produced book Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 01/10] docs: DMA-API-HOWTO: add a missing "=" Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 02/10] docs: atomic_bitops.txt: add a title for this document Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 03/10] docs: clearing-warn-once.txt: " Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 04/10] docs: ntb.txt: use Sphinx notation for the two ascii figures Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 05/10] docs: unaligned-memory-access.txt: use a lowercase title Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 06/10] docs: video-output.txt: convert it to ReST format Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 07/10] docs: Add all txt files to documentation Mauro Carvalho Chehab
2019-04-09 16:47 ` Joe Perches
2019-04-08 16:58 ` Mauro Carvalho Chehab [this message]
2019-04-08 16:58 ` [PATCH 09/10] docs: speculation.rst: mark example blocks as such Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 10/10] docs: add plain text files to ReST output from subdirs Mauro Carvalho Chehab
2019-04-08 22:18 ` [PATCH 00/10] Add all documentation files to an html/pdf produced book Jonathan Corbet
2019-04-10 9:49 ` Mauro Carvalho Chehab
2019-04-11 18:49 ` Jonathan Corbet
2019-04-12 9:28 ` Mauro Carvalho Chehab
2019-04-13 0:30 ` Mauro Carvalho Chehab
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=e2c2fafcce7fd5d631e5f187a3a05a7bfd73c98e.1554742526.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).