docs: ntb.txt: add blank lines to clean up some Sphinx warnings
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>hifive-unleashed-5.2
parent
cf566e1ee2
commit
59bc64f0d0
|
@ -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
|
As one can see the described scenarios can be combined in one portable
|
||||||
algorithm.
|
algorithm.
|
||||||
|
|
||||||
Local device:
|
Local device:
|
||||||
1) Allocate memory for a shared window
|
1) Allocate memory for a shared window
|
||||||
2) Initialize memory window by translated address of the allocated region
|
2) Initialize memory window by translated address of the allocated region
|
||||||
(it may fail if local memory window initialization is unsupported)
|
(it may fail if local memory window initialization is unsupported)
|
||||||
3) Send the translated address and memory window index to a peer device
|
3) Send the translated address and memory window index to a peer device
|
||||||
|
|
||||||
Peer device:
|
Peer device:
|
||||||
1) Initialize memory window with retrieved address of the allocated
|
1) Initialize memory window with retrieved address of the allocated
|
||||||
by another device memory region (it may fail if peer memory window
|
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
|
In accordance with this scenario, the NTB Memory Window API can be used as
|
||||||
follows:
|
follows:
|
||||||
|
|
||||||
Local device:
|
Local device:
|
||||||
1) ntb_mw_count(pidx) - retrieve number of memory ranges, which can
|
1) ntb_mw_count(pidx) - retrieve number of memory ranges, which can
|
||||||
be allocated for memory windows between local device and peer device
|
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
|
5) Send translated base address (usually together with memory window
|
||||||
number) to the peer device using, for instance, scratchpad or message
|
number) to the peer device using, for instance, scratchpad or message
|
||||||
registers.
|
registers.
|
||||||
|
|
||||||
Peer device:
|
Peer device:
|
||||||
1) ntb_peer_mw_set_trans(pidx, midx) - try to set received from other
|
1) ntb_peer_mw_set_trans(pidx, midx) - try to set received from other
|
||||||
device (related to pidx) translated address for specified memory
|
device (related to pidx) translated address for specified memory
|
||||||
|
|
Loading…
Reference in New Issue