winverbs: update uvp_if patch

Add documentation for get interface call by guid.

Signed-off-by: Sean Hefty <sean.hefty@intel.com>
git-svn-id: svn://openib.tc.cornell.edu/gen1@1333 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

diff --git a/branches/winverbs/patches/uvp_if.txt b/branches/winverbs/patches/uvp_if.txt
index 097fc40bf29703714ed2877c91cffdc315da6647..61d1e82c38dd9ee8ddf99321c0352a6de108d9c3 100644 (file)
--- a/branches/winverbs/patches/uvp_if.txt
+++ b/branches/winverbs/patches/uvp_if.txt
@@ -1,6 +1,6 @@
 diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/core/al/user/ual_ca.c branches\winverbs/core/al/user/ual_ca.c\r
---- trunk/core/al/user/ual_ca.c        2008-06-03 21:35:25.166625000 -0700\r
-+++ branches\winverbs/core/al/user/ual_ca.c    2008-06-03 21:24:28.322875000 -0700\r
+--- trunk/core/al/user/ual_ca.c        2008-06-30 12:51:02.617251300 -0700\r
++++ branches\winverbs/core/al/user/ual_ca.c    2008-07-03 10:59:46.593750000 -0700\r
 @@ -116,7 +116,8 @@ open_vendor_lib(\r
                return IB_SUCCESS;\r
        }\r
@@ -21,8 +21,8 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/core/al/user/ual_ca.c br
        AL_EXIT( AL_DBG_CA );\r
        return IB_SUCCESS;\r
 diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/core/al/user/ual_support.h branches\winverbs/core/al/user/ual_support.h\r
---- trunk/core/al/user/ual_support.h   2008-06-03 21:35:25.182250000 -0700\r
-+++ branches\winverbs/core/al/user/ual_support.h       2008-06-03 21:24:28.338500000 -0700\r
+--- trunk/core/al/user/ual_support.h   2008-06-30 12:51:02.632876600 -0700\r
++++ branches\winverbs/core/al/user/ual_support.h       2008-07-03 10:59:46.625000000 -0700\r
 @@ -80,14 +80,6 @@ al_unload_uvp(\r
        FreeLibrary( h_uvp_lib );\r
  }\r
@@ -39,8 +39,8 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/core/al/user/ual_support
  al_uvp_lib_err(\r
        IN                              uint32_t                                        dbg_lvl,\r
 diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/hw/mlx4/user/hca/mlx4.c branches\winverbs/hw/mlx4/user/hca/mlx4.c\r
---- trunk/hw/mlx4/user/hca/mlx4.c      2008-06-03 21:35:25.197875000 -0700\r
-+++ branches\winverbs/hw/mlx4/user/hca/mlx4.c  2008-06-03 21:24:28.354125000 -0700\r
+--- trunk/hw/mlx4/user/hca/mlx4.c      2008-07-03 11:11:44.984375000 -0700\r
++++ branches\winverbs/hw/mlx4/user/hca/mlx4.c  2008-07-03 10:59:46.656250000 -0700\r
 @@ -180,22 +180,8 @@ void mlx4_free_context(struct ibv_contex\r
        cl_free(context);\r
  }\r
@@ -124,8 +124,8 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/hw/mlx4/user/hca/mlx4.c
 +      return status;\r
 +}\r
 diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/hw/mthca/user/mlnx_ual_main.c branches\winverbs/hw/mthca/user/mlnx_ual_main.c\r
---- trunk/hw/mthca/user/mlnx_ual_main.c        2008-06-03 21:35:25.213500000 -0700\r
-+++ branches\winverbs/hw/mthca/user/mlnx_ual_main.c    2008-06-03 21:24:28.369750000 -0700\r
+--- trunk/hw/mthca/user/mlnx_ual_main.c        2008-06-30 12:51:02.711003100 -0700\r
++++ branches\winverbs/hw/mthca/user/mlnx_ual_main.c    2008-07-03 10:59:46.687500000 -0700\r
 @@ -135,70 +135,30 @@ uvp_init()\r
  \r
  __declspec(dllexport) ib_api_status_t\r
@@ -220,8 +220,8 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/hw/mthca/user/mlnx_ual_m
  }\r
 -\r
 diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/inc/user/iba/ib_uvp.h branches\winverbs/inc/user/iba/ib_uvp.h\r
---- trunk/inc/user/iba/ib_uvp.h        2008-06-03 21:35:25.229125000 -0700\r
-+++ branches\winverbs/inc/user/iba/ib_uvp.h    2008-06-03 21:24:28.385375000 -0700\r
+--- trunk/inc/user/iba/ib_uvp.h        2008-07-03 11:11:45.218750000 -0700\r
++++ branches\winverbs/inc/user/iba/ib_uvp.h    2008-07-03 11:22:27.734375000 -0700\r
 @@ -36,6 +36,7 @@\r
  #include <complib/cl_types.h>\r
  #include <iba/ib_types.h>\r
@@ -230,22 +230,17 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/inc/user/iba/ib_uvp.h br
  \r
  /****h* UAL_UVP_Interface/user-mode Verbs\r
  * NAME\r
-@@ -3342,121 +3343,61 @@ typedef void\r
+@@ -3342,8 +3343,6 @@ typedef void\r
  \r
  /********/\r
  \r
 -/********/\r
 -\r
--/****s* user-mode Verbs/uvp_interface_t\r
--* NAME\r
--*     uvp_interface_t -- Interface holding supported Vendor APIs\r
--*\r
--* PURPOSE\r
--*     The following structure is supplied by a Vendor library\r
--*     providing verbs functionality.\r
--*\r
--* SOURCE\r
--*/\r
+ /****s* user-mode Verbs/uvp_interface_t\r
+ * NAME\r
+ *     uvp_interface_t -- Interface holding supported Vendor APIs\r
+@@ -3356,107 +3355,59 @@ typedef void\r
+ */\r
  typedef struct _uvp_interface\r
  {\r
 -      ib_net64_t                                      guid;\r
@@ -356,7 +351,7 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/inc/user/iba/ib_uvp.h br
        uvp_pre_create_mw                       pre_create_mw;\r
        uvp_post_create_mw_t            post_create_mw;\r
        uvp_pre_query_mw                        pre_query_mw;\r
-@@ -3464,38 +3405,21 @@ typedef struct _uvp_interface\r
+@@ -3464,38 +3415,21 @@ typedef struct _uvp_interface\r
        uvp_pre_destroy_mw                      pre_destroy_mw;\r
        uvp_post_destroy_mw_t           post_destroy_mw;\r
  \r
@@ -395,54 +390,67 @@ diff -up -r -X trunk\docs\dontdiff.txt -I '\$Id:' trunk/inc/user/iba/ib_uvp.h br
        uvp_nd_modify_qp_t                      nd_modify_qp;\r
        uvp_nd_get_qp_state_t           nd_get_qp_state;\r
        uvp_wv_pre_create_qp            wv_pre_create_qp;\r
-@@ -3503,46 +3427,11 @@ typedef struct _uvp_interface\r
+@@ -3505,35 +3439,42 @@ typedef struct _uvp_interface\r
  \r
- } uvp_interface_t;\r
+ /********/\r
  \r
--/********/\r
 +// {A1F1EA66-4D17-4d04-B910-893F658241D0}\r
 +DEFINE_GUID(IID_UVP, \r
 +0xa1f1ea66, 0x4d17, 0x4d04, 0xb9, 0x10, 0x89, 0x3f, 0x65, 0x82, 0x41, 0xd0);\r
- \r
--/****f* user-mode Verbs/uvp_get_interface\r
--* NAME\r
++\r
+ /****f* user-mode Verbs/uvp_get_interface\r
+ * NAME\r
 -*     uvp_get_interface -- Get the Vendor's supported Verbs calls\r
--*\r
--* SYNOPSIS\r
--*/\r
++*     uvp_get_interface -- Get the Vendor's supported function calls\r
+ *\r
+ * SYNOPSIS\r
+ */\r
  typedef ib_api_status_t\r
--(AL_API *uvp_get_interface_t)(\r
+ (AL_API *uvp_get_interface_t)(\r
 -      IN      OUT                     uvp_interface_t*        const   p_uvp );\r
--/*\r
--* DESCRIPTION\r
++      IN                      GUID                            iid,\r
++      IN      OUT             void*                           pifc);\r
+ /*\r
+ * DESCRIPTION\r
 -*     This routine is called by UAL to get the functions supported by\r
 -*     a vendor's library. Upon discovering a new CA, UAL will look for\r
 -*     the appropriate vendor library, load the library and query using\r
 -*     this function to get the supported interfaces.\r
--*\r
++*     This routine is called to get the functions supported by\r
++*     a vendor's library.  It may be used to obtain the list of\r
++*     verb calls supported by a vendor.\r
+ *\r
 -*     If the vendor does not support an interface function, it should be\r
 -*     set to NULL in the interface structure returned.\r
--*\r
--* PARAMETERS\r
++*     If the vendor does not support an interface, it should returns\r
++*     IB_UNSUPPORTED.  The specific details of each interface returned\r
++*     is dependent upon the requested interface.\r
+ *\r
+ * PARAMETERS\r
 -*     p_uvp\r
 -*             [in out] Pointer to the uvp_interface_t structure that has the function\r
 -*             vector to support verbs functionality.\r
--*\r
--* RETURN VALUE\r
--*     IB_SUCCESS\r
++*     iid\r
++*             [in] GUID of the requested interface.\r
++*     pifc\r
++*             [in out] Pointer to the structure that that will receive the\r
++*             interface functions.\r
+ *\r
+ * RETURN VALUE\r
+ *     IB_SUCCESS\r
 -*             The registration is successful.\r
 -*     IB_INSUFFICIENT_MEMORY\r
 -*             Insufficient memory to satisfy request\r
--*\r
--* PORTABILITY\r
--*     User mode\r
--*\r
--* SEE ALSO\r
--*     uvp_interface_t\r
--*\r
--********/\r
--\r
--/********/\r
-+(AL_API *uvp_get_interface_t)(GUID iid, void* pifc);\r
++*             The interface was returned successfully.\r
++*     IB_UNSUPPORTED\r
++*             The requested interface isn't supported by the vendor's library.\r
+ *\r
+ * PORTABILITY\r
+ *     User mode\r
+@@ -3543,6 +3484,4 @@ typedef ib_api_status_t\r
+ *\r
+ ********/\r
  \r
+-/********/\r
+-\r
  #endif // __IB_UAL_UVP_H__\r