[INC] Correct spelling, white-space alignment, remove trailing white-space, add comments.

Generally make ib_types.h more compatible with OFED for Linux version in order to make comparisions easier.

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

diff --git a/trunk/inc/iba/ib_types.h b/trunk/inc/iba/ib_types.h
index e5dee9e7cf6b1b98a7dd15da76047c67c8e6b996..14256d5ad0d66b7ddf5f130cec48ee205dd00853 100644 (file)
--- a/trunk/inc/iba/ib_types.h
+++ b/trunk/inc/iba/ib_types.h
@@ -280,8 +280,6 @@ extern "C"
 * SOURCE\r
 */\r
 #define IB_HOPLIMIT_MAX                                        255\r
-/*********/\r
-\r
 /*********/\r
 /****d* IBA Base: Constants/IB_MC_SCOPE_*\r
 * NAME\r
@@ -634,7 +632,7 @@ ib_class_is_vendor_specific_low(
 *              [in] The Management Datagram Class Code\r
 *\r
 * RETURN VALUE\r
-*      TRUE if the class is in the Low range of Vendor Specific MADs \r
+*      TRUE if the class is in the Low range of Vendor Specific MADs\r
 *      FALSE otherwise.\r
 *\r
 * NOTES\r
@@ -666,7 +664,7 @@ ib_class_is_vendor_specific_high(
 *              [in] The Management Datagram Class Code\r
 *\r
 * RETURN VALUE\r
-*      TRUE if the class is in the High range of Vendor Specific MADs \r
+*      TRUE if the class is in the High range of Vendor Specific MADs\r
 *      FALSE otherwise.\r
 *\r
 * NOTES\r
@@ -1033,7 +1031,7 @@ ib_class_is_rmpp(
 *      IB_MAD_ATTR_PORT_SMPL_CTRL\r
 *\r
 * DESCRIPTION\r
-*      NodeDescription attribute (16.1.2)\r
+*      PortSamplesControl attribute (16.1.3)\r
 *\r
 * SOURCE\r
 */\r
@@ -1057,7 +1055,7 @@ ib_class_is_rmpp(
 *      IB_MAD_ATTR_PORT_SMPL_RSLT\r
 *\r
 * DESCRIPTION\r
-*      NodeInfo attribute (16.1.2)\r
+*      PortSamplesResult attribute (16.1.3)\r
 *\r
 * SOURCE\r
 */\r
@@ -1081,7 +1079,7 @@ ib_class_is_rmpp(
 *      IB_MAD_ATTR_PORT_CNTRS\r
 *\r
 * DESCRIPTION\r
-*      SwitchInfo attribute (16.1.2)\r
+*      PortCounters attribute (16.1.3)\r
 *\r
 * SOURCE\r
 */\r
@@ -2492,7 +2490,7 @@ typedef __declspec(align(8)) struct _ib_path_rec
 *              Another global routing parameter.\r
 *\r
 *      num_path\r
-*     Reversible path - 1 bit to say if path is reversible.\r
+*              Reversible path - 1 bit to say if path is reversible.\r
 *              num_path [6:0] In queries, maximum number of paths to return.\r
 *              In responses, undefined.\r
 *\r
@@ -2848,7 +2846,7 @@ ib_path_rec_init_local(
 *              [in] LID of source port.\r
 *\r
 *      num_path\r
-*     [in] Reversible path - 1 bit to say if path is reversible.\r
+*              [in] Reversible path - 1 bit to say if path is reversible.\r
 *              num_path [6:0] In queries, maximum number of paths to return.\r
 *              In responses, undefined.\r
 *\r
@@ -2937,6 +2935,22 @@ ib_path_rec_set_sl(IN ib_path_rec_t * const p_rec, IN const uint8_t sl)
            (p_rec->qos_class_sl & CL_HTON16(IB_PATH_REC_QOS_CLASS_MASK)) |\r
            cl_hton16(sl & IB_PATH_REC_SL_MASK);\r
 }\r
+/*\r
+* PARAMETERS\r
+*      p_rec\r
+*              [in] Pointer to the path record object.\r
+*\r
+*      sl\r
+*              [in] Service level to set.\r
+*\r
+* RETURN VALUES\r
+*      None\r
+*\r
+* NOTES\r
+*\r
+* SEE ALSO\r
+*      ib_path_rec_t\r
+*********/\r
 \r
 /****f* IBA Base: Types/ib_path_rec_sl\r
 * NAME\r
@@ -3424,10 +3438,10 @@ typedef struct _ib_class_port_info
 *              Maximum expected response time and additional\r
 *              supported capabilities of this management class.\r
 *\r
-*      redr_gid\r
+*      redir_gid\r
 *              GID to use for redirection, or zero\r
 *\r
-*      recdir_tc_sl_fl\r
+*      redir_tc_sl_fl\r
 *              Traffic class, service level and flow label the requester\r
 *              should use if the service is redirected.\r
 *\r
@@ -4454,7 +4468,7 @@ ib_sa_mad_get_payload_ptr(
 *      ib_node_info_get_local_port_num\r
 *\r
 * DESCRIPTION\r
-*      Gets a the local port number from the NodeInfo attribute.\r
+*      Get the local port number from the NodeInfo attribute.\r
 *\r
 * SYNOPSIS\r
 */\r
@@ -5085,7 +5099,7 @@ ib_port_info_get_link_speed_active(
 #define IB_PATH_RECORD_RATE_120_GBS            10\r
 \r
 #define IB_MIN_RATE    IB_PATH_RECORD_RATE_2_5_GBS\r
-#define IB_MAX_RATE    IB_PATH_RECORD_RATE_120_GBS \r
+#define IB_MAX_RATE    IB_PATH_RECORD_RATE_120_GBS\r
 \r
 /****f* IBA Base: Types/ib_port_info_compute_rate\r
 * NAME\r
@@ -5276,7 +5290,7 @@ ib_port_info_get_mtu_cap(
 *              [in] Pointer to a PortInfo attribute.\r
 *\r
 * RETURN VALUES\r
-*      Returns the LMC value assigned to this port.\r
+*      Returns the encoded value for the maximum MTU supported by this port.\r
 *\r
 * NOTES\r
 *\r