summaryrefslogtreecommitdiffstats
path: root/Documentation/ntb.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/ntb.txt')
-rw-r--r--Documentation/ntb.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/Documentation/ntb.txt b/Documentation/ntb.txt
index 9d46dc9712a8..725ba1e6c127 100644
--- a/Documentation/ntb.txt
+++ b/Documentation/ntb.txt
@@ -26,7 +26,33 @@ as ntb hardware, or hardware drivers, are inserted and removed. The
26registration uses the Linux Device framework, so it should feel familiar to 26registration uses the Linux Device framework, so it should feel familiar to
27anyone who has written a pci driver. 27anyone who has written a pci driver.
28 28
29### NTB Transport Client (ntb\_transport) and NTB Netdev (ntb\_netdev)
30
31The primary client for NTB is the Transport client, used in tandem with NTB
32Netdev. These drivers function together to create a logical link to the peer,
33across the ntb, to exchange packets of network data. The Transport client
34establishes a logical link to the peer, and creates queue pairs to exchange
35messages and data. The NTB Netdev then creates an ethernet device using a
36Transport queue pair. Network data is copied between socket buffers and the
37Transport queue pair buffer. The Transport client may be used for other things
38besides Netdev, however no other applications have yet been written.
39
29## NTB Hardware Drivers 40## NTB Hardware Drivers
30 41
31NTB hardware drivers should register devices with the NTB core driver. After 42NTB hardware drivers should register devices with the NTB core driver. After
32registering, clients probe and remove functions will be called. 43registering, clients probe and remove functions will be called.
44
45### NTB Intel Hardware Driver (ntb\_hw\_intel)
46
47The Intel hardware driver supports NTB on Xeon and Atom CPUs.
48
49Module Parameters:
50
51* b2b\_mw\_idx - If the peer ntb is to be accessed via a memory window, then use
52 this memory window to access the peer ntb. A value of zero or positive
53 starts from the first mw idx, and a negative value starts from the last
54 mw idx. Both sides MUST set the same value here! The default value is
55 `-1`.
56* b2b\_mw\_share - If the peer ntb is to be accessed via a memory window, and if
57 the memory window is large enough, still allow the client to use the
58 second half of the memory window for address translation to the peer.