Skip to content

Commit

Permalink
docs: ntb.txt: use Sphinx notation for the two ascii figures
Browse files Browse the repository at this point in the history
In order to make it to build with Sphinx, we need to fix the
notation for two ascii artwork.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Apr 11, 2019
1 parent 26187d1 commit 3ac10b0
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions Documentation/ntb.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ mainly used to perform the proper memory window initialization. Typically
there are two types of memory window interfaces supported by the NTB API:
inbound translation configured on the local ntb port and outbound translation
configured by the peer, on the peer ntb port. The first type is
depicted on the next figure
depicted on the next figure::

Inbound translation:

Inbound translation:
Memory: Local NTB Port: Peer NTB Port: Peer MMIO:
____________
| dma-mapped |-ntb_mw_set_trans(addr) |
Expand All @@ -58,9 +59,10 @@ maps corresponding outbound memory window so to have access to the shared
memory region.

The second type of interface, that implies the shared windows being
initialized by a peer device, is depicted on the figure:
initialized by a peer device, is depicted on the figure::

Outbound translation:

Outbound translation:
Memory: Local NTB Port: Peer NTB Port: Peer MMIO:
____________ ______________
| dma-mapped | | | MW base addr |<== memory-mapped IO
Expand Down

0 comments on commit 3ac10b0

Please sign in to comment.