Skip to content

Commit

Permalink
docs: ntb.txt: add blank lines to clean up some Sphinx warnings
Browse files Browse the repository at this point in the history
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Mauro Carvalho Chehab authored and Jonathan Corbet committed Apr 11, 2019
1 parent cf566e1 commit 59bc64f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Documentation/ntb.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 59bc64f

Please sign in to comment.