From 0fa84bccc32f3bb3d0c367f96bd93d3d7b885b7e Mon Sep 17 00:00:00 2001 From: Sean Hefty Date: Thu, 21 Jan 2010 06:09:06 +0000 Subject: [PATCH] docs/interfaces.txt: add documentation to describe interface differences Provide a simple documentation that defines the main userspace verbs interfaces and the differences between them. Signed-off-by: Sean Hefty git-svn-id: svn://openib.tc.cornell.edu/gen1@2673 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86 --- trunk/docs/interfaces.txt | 40 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100755 trunk/docs/interfaces.txt diff --git a/trunk/docs/interfaces.txt b/trunk/docs/interfaces.txt new file mode 100755 index 00000000..66a80ec8 --- /dev/null +++ b/trunk/docs/interfaces.txt @@ -0,0 +1,40 @@ +WinOF provides several userspace interfaces. The main application +interfaces are given below, along with a brief description of each. + + +libibverbs +OFA interface available on windows and linux + This is the only linux verbs interface, which was ported to + windows to support portability. This sits over winverbs. + It provides low abstraction to the hardware, but does not + expose windows specific features, like overlapped operations + for asynchronous control. This is a good choice for low-level + access, with portability between windows and linux. + +WinVerbs +OFA windows interface + Lowest level windows verbs interface for applications. Most + of the other interfaces sit over this interface. This provides + the lowest abstraction to the hardware, while also exposing + windows specific features. This is a good choice for + low-level access on windows. + +DAPL (Direct Access Programming Library) +Industry standard RDMA interface for multiple OS's + Hardware providers may support this interface, even if not + part of OFA. This sits over libibverbs and ibal. This provides a + higher level of abstraction, but provides the most portability. + +Network Direct (ND) +Microsoft defined interface for windows + Hardware providers may support this interface, even if not + part of OFA. This sits over winverbs and ibal. This provides + a higher level of abstraction, but may provide access to the + most hardware on Windows platforms. + +IBAL (InfiniBand Access Layer) +OFA windows interface + Older windows interface. This is currently a peer to winverbs, + with a longer term goal of moving it over winverbs. The + interface will be supported going forward. This provides low + level abstraction, but does not expose windows specific features. -- 2.46.0