[WinOF] IBSDK - document win32 DDK build and importance of calling convention declara...

git-svn-id: svn://openib.tc.cornell.edu/gen1@918 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

diff --git a/branches/WinOF/WIX/SDK_Samples/DDK/README.txt b/branches/WinOF/WIX/SDK_Samples/DDK/README.txt
index bfaea6ccac418fde27e114064d092907a60ab92f..d3f55feef260336df5aeca1e0b87db86e95a5401 100644 (file)
--- a/branches/WinOF/WIX/SDK_Samples/DDK/README.txt
+++ b/branches/WinOF/WIX/SDK_Samples/DDK/README.txt
@@ -2,12 +2,16 @@
 DDK (Driver Development Kit) Build Environment Example [12-06-07]\r
 -----------------------------------------------------------------\r
 \r
-Install the Windows Server 2003 (SP1) DDK see http://www.microsoft.com/whdc/devtools/ddk/default.mspx .\r
-Why use the DDK? Windows Server 2003 DDK (SP1) is what's used to build the WinOF distribution.\r
-Installing the DDK first requires burning a CD of what you have just downloaded - sigh...\r
+Install the Windows Server 2003 (SP1) DDK see\r
+http://www.microsoft.com/whdc/devtools/ddk/default.mspx .\r
 \r
-Due to the problematic nature of spaces in path names, Windows Server 2003 DDK does not allow spaces in\r
-pathnames; this is why IBSDK is not installed under WinOF.\r
+Why use the DDK? Windows Server 2003 DDK (SP1) is what's used to build the WinOF\r
+distribution.\r
+Installing the DDK first requires burning a CD of the downloaded DDK - sigh...\r
+\r
+Due to the problematic nature of spaces in path names, Windows Server 2003 DDK\r
+does not allow spaces in pathnames; this is why IBSDK is not installed under\r
+WinOF.\r
 \r
 \r
 Building CM test example\r
@@ -17,18 +21,37 @@ Start a 'Free/Release' type DDK command prompt for you respective architecture [
 \r
 cd to C:\IBAL\Sampes\DDK\r
 \r
+Set the 'OPENIB_REV' env variable to the svn version number.\r
+Hold the mouse-point over the file 'C:\Program Files (x86)\WinOF\opensm.exe'.\r
+The last field of the 'File Version' field is the svn revision number.\r
+\r
+set OPENIB_REV=917\r
+\r
+If building an 32-bit cmtest version on an x64 platform, edit Sources file by adding '32' to\r
+ibal.lib and complib.lib, resulting in 'ibal32.lib' and 'complib32.lib'.\r
+Note - executable will be appear as 'objfre_wnet_x86\i386\cmtest.exe'.\r
+\r
 build -wg\r
 \r
 The executable will be created in a processor specific directory:\r
-  x64 (Release/Free) example:  C:\IBAL\Sampes\DDK\objfre_wnet_amd64\amd64\cmtest.exe\r
-  x64 (Checked/Debug)) example:  C:\IBAL\Sampes\DDK\objchk_wnet_amd64\amd64\cmtest.exe\r
 \r
+  x64 (Release/Free) example:\r
+      C:\IBAL\Sampes\DDK\objfre_wnet_amd64\amd64\cmtest.exe\r
+\r
+  x64 (Checked/Debug)) example:\r
+      C:\IBAL\Sampes\DDK\objchk_wnet_amd64\amd64\cmtest.exe\r
+\r
+  x86 (Release/Free) example:\r
+      C:\IBAL\Sampes\DDK\objfre_wnet_x86\i386\cmtest.exe\r
 \r
 Executing cmtest.exe\r
 --------------------\r
 \r
-cmtest.exe passes messages between the server and client over a reliable IB queue-pair connection (RC).\r
-Connection end-points (hosts) are identified by IB port LID (hex integer, as displayed by the vstat command).\r
+cmtest.exe passes messages between the server and client over a reliable IB\r
+queue-pair connection (RC).\r
+Connection end-points (hosts) are identified by IB port LID (hex integer, as\r
+displayed by the vstat command).\r
+\r
 Note: <spaces> are not allowed between command line switch and it's argument.\r
 \r
 Server side:    cmtest -s -l0xlll -r0xrrr -m1024 -n100\r
@@ -37,8 +60,40 @@ Client side: cmtest.exe -l0xlll -r0xrrr -m1024 -n100
 \r
 where:\r
   lll == local port lid as displayed by vstat command.\r
-  rrr == Remote port lid as displayed by vstat; lll == rrr for local loopback operation.\r
+  rrr == Remote port lid as displayed by vstat command;\r
+           lll == rrr for local loopback operation.\r
   -m  == bytes per message\r
   -n  == number of messages to send.\r
   -c  == number of connections (default is -c1)\r
   cmtest -h reveals all...\r
+\r
+\r
+Example cmtest invocation\r
+-------------------------\r
+\r
+cmdWin> vstat\r
+\r
+        hca_idx=0\r
+        uplink={BUS=UNRECOGNIZED (33)}\r
+        vendor_id=0x02c9\r
+        vendor_part_id=0x6278\r
+        hw_ver=0xa0\r
+        fw_ver=4.08.0200\r
+        PSID=_00A0000001\r
+        node_guid=0002:c902:0020:1d74\r
+        num_phys_ports=2\r
+                port=1\r
+                port_state=PORT_ACTIVE (4)     <==== Must be active!\r
+                link_speed=2.5Gbps (1)\r
+                link_width=4x (2)\r
+                rate=10\r
+                sm_lid=0x0001\r
+                port_lid=0x0020                        <==== -l0x20\r
+                port_lmc=0x0\r
+                max_mtu=2048 (4)\r
+\r
+\r
+Separate processes for server & client (different cmd windows).\r
+\r
+server:    cmtest -s -l0x20 -r0x20 -m8192 -n400\r
+client:    cmtest    -l0x20 -r0x20 -m8192 -n400\r