Skip to content

Commit 54716b4

Browse files
author
Kelvin Cao
committed
Misc updates to NTB driver part of README
1) Change ntb hardware driver name to ntb_hw_switchtec 2) Update the description of 2 partitions limit 3) Add reference to Linux Documentation/ntb.txt
1 parent 8930642 commit 54716b4

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,20 @@ The following IOCTLs are also supported by the device:
8383
Non-Transparent Bridge (NTB) Driver
8484
===================================
8585

86-
An NTB driver is provided for the switchtec hardware in switchtec_ntb.
87-
Currently, it only supports switches configured with exactly 2
88-
partitions. It also requires the following configuration settings:
86+
An NTB hardware driver is provided for the switchtec hardware in
87+
ntb_hw_switchtec. Currently, it only supports switches configured with
88+
exactly 2 NT partitions and zero or more non-NT partitions. It also requires
89+
the following configuration settings:
8990

90-
* Both partitions must be able to access each other's GAS spaces.
91+
* Both NT partitions must be able to access each other's GAS spaces.
9192
Thus, the bits in the GAS Access Vector under Management Settings
9293
must be set to support this.
93-
* NT EP BAR 2 will be dynamically configured as a Direct Window
94-
(configuration file does not need to configure explicitly)
95-
* Kernel configuration MUST include support for NTB (CONFIG_NTB needs to be set)
94+
* Kernel configuration MUST include support for NTB (CONFIG_NTB needs
95+
to be set)
9696

97-
The NTB driver offers a virtual NIC interface between two hosts
98-
connected to one switch with two partitions (each with an NT EP).
97+
NT EP BAR 2 will be dynamically configured as a Direct Window, and
98+
the configuration file does not need to configure it explicitly.
99+
100+
Please refer to Documentation/ntb.txt in Linux source tree for an overall
101+
understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB
102+
Hardware Driver in this stack.

0 commit comments

Comments
 (0)