[ofw] [PATCH] ib_types.h - more cleanup

[Smith, Stan]

signed-off-by: stan smith <stan.smith at intel.com>

Revision: 2811
Author: stansmith
Date: 4:43:04 PM, Tuesday, May 25, 2010
Message:
[INC] Correct spelling, white-space alignment, remove trailing white-space, add comments.
Generally make ib_types.h more compatible with OFED for Linux ib_types.h in order to make comparisons easier.
----
Modified : /gen1/trunk/inc/iba/ib_types.h

--- A/inc/iba/ib_types.h        Tue May 25 16:37:49 2010
+++ B/inc/iba/ib_types.h        Tue May 25 16:37:30 2010
@@ -281,8 +281,6 @@
 */
 #define IB_HOPLIMIT_MAX                                        255
 /*********/
-
-/*********/
 /****d* IBA Base: Constants/IB_MC_SCOPE_*
 * NAME
 *      IB_MC_SCOPE_*
@@ -634,7 +632,7 @@
 *              [in] The Management Datagram Class Code
 *
 * RETURN VALUE
-*      TRUE if the class is in the Low range of Vendor Specific MADs
+*      TRUE if the class is in the Low range of Vendor Specific MADs
 *      FALSE otherwise.
 *
 * NOTES
@@ -666,7 +664,7 @@
 *              [in] The Management Datagram Class Code
 *
 * RETURN VALUE
-*      TRUE if the class is in the High range of Vendor Specific MADs
+*      TRUE if the class is in the High range of Vendor Specific MADs
 *      FALSE otherwise.
 *
 * NOTES
@@ -1033,7 +1031,7 @@
 *      IB_MAD_ATTR_PORT_SMPL_CTRL
 *
 * DESCRIPTION
-*      NodeDescription attribute (16.1.2)
+*      PortSamplesControl attribute (16.1.3)
 *
 * SOURCE
 */
@@ -1057,7 +1055,7 @@
 *      IB_MAD_ATTR_PORT_SMPL_RSLT
 *
 * DESCRIPTION
-*      NodeInfo attribute (16.1.2)
+*      PortSamplesResult attribute (16.1.3)
 *
 * SOURCE
 */
@@ -1081,7 +1079,7 @@
 *      IB_MAD_ATTR_PORT_CNTRS
 *
 * DESCRIPTION
-*      SwitchInfo attribute (16.1.2)
+*      PortCounters attribute (16.1.3)
 *
 * SOURCE
 */
@@ -2492,7 +2490,7 @@
 *              Another global routing parameter.
 *
 *      num_path
-*     Reversible path - 1 bit to say if path is reversible.
+*              Reversible path - 1 bit to say if path is reversible.
 *              num_path [6:0] In queries, maximum number of paths to return.
 *              In responses, undefined.
 *
@@ -2848,7 +2846,7 @@
 *              [in] LID of source port.
 *
 *      num_path
-*     [in] Reversible path - 1 bit to say if path is reversible.
+*              [in] Reversible path - 1 bit to say if path is reversible.
 *              num_path [6:0] In queries, maximum number of paths to return.
 *              In responses, undefined.
 *
@@ -2937,6 +2935,22 @@
            (p_rec->qos_class_sl & CL_HTON16(IB_PATH_REC_QOS_CLASS_MASK)) |
            cl_hton16(sl & IB_PATH_REC_SL_MASK);
 }
+/*
+* PARAMETERS
+*      p_rec
+*              [in] Pointer to the path record object.
+*
+*      sl
+*              [in] Service level to set.
+*
+* RETURN VALUES
+*      None
+*
+* NOTES
+*
+* SEE ALSO
+*      ib_path_rec_t
+*********/

 /****f* IBA Base: Types/ib_path_rec_sl
 * NAME
@@ -3424,10 +3438,10 @@
 *              Maximum expected response time and additional
 *              supported capabilities of this management class.
 *
-*      redr_gid
+*      redir_gid
 *              GID to use for redirection, or zero
 *
-*      recdir_tc_sl_fl
+*      redir_tc_sl_fl
 *              Traffic class, service level and flow label the requester
 *              should use if the service is redirected.
 *
@@ -4454,7 +4468,7 @@
 *      ib_node_info_get_local_port_num
 *
 * DESCRIPTION
-*      Gets a the local port number from the NodeInfo attribute.
+*      Get the local port number from the NodeInfo attribute.
 *
 * SYNOPSIS
 */
@@ -5085,7 +5099,7 @@
 #define IB_PATH_RECORD_RATE_120_GBS            10

 #define IB_MIN_RATE    IB_PATH_RECORD_RATE_2_5_GBS
-#define IB_MAX_RATE    IB_PATH_RECORD_RATE_120_GBS
+#define IB_MAX_RATE    IB_PATH_RECORD_RATE_120_GBS

 /****f* IBA Base: Types/ib_port_info_compute_rate
 * NAME
@@ -5276,7 +5290,7 @@
 *              [in] Pointer to a PortInfo attribute.
 *
 * RETURN VALUES
-*      Returns the LMC value assigned to this port.
+*      Returns the encoded value for the maximum MTU supported by this port.
 *
 * NOTES
 *