[INC] Fix/add comments plus whitespace: alignment and trailing whitespace removal...

No functionality change!

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

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

diff --git a/trunk/inc/iba/ib_types.h b/trunk/inc/iba/ib_types.h
index 56a7b404260e3d8353e162bfec7f06a2b2bed323..a5eb217372697acf4552d1439c754e671ca9836d 100644 (file)
--- a/trunk/inc/iba/ib_types.h
+++ b/trunk/inc/iba/ib_types.h
@@ -904,7 +904,7 @@ ib_class_is_rmpp(
 *\r
 * SOURCE\r
 */\r
-#define IB_MAD_STATUS_BUSY                                     (CL_HTON16(0x0001))\r
+#define IB_MAD_STATUS_BUSY                             (CL_HTON16(0x0001))\r
 /**********/\r
 \r
 /****d* IBA Base: Constants/IB_MAD_STATUS_REDIRECT\r
@@ -2470,8 +2470,8 @@ typedef __declspec(align(8)) struct _ib_path_rec
 #include <complib/cl_packoff.h>\r
 /*\r
 * FIELDS\r
-*      resv0\r
-*              Reserved bytes.\r
+*      service_id\r
+*              Service ID for QoS.\r
 *\r
 *      dgid\r
 *              GID of destination port.\r
@@ -2499,11 +2499,8 @@ typedef __declspec(align(8)) struct _ib_path_rec
 *      pkey\r
 *              Partition key (P_Key) to use on this path.\r
 *\r
-*      resv1\r
-*              Reserved byte.\r
-*\r
-*      sl\r
-*              Service level to use on this path.\r
+*      qos_class_sl\r
+*              QoS class and service level to use on this path.\r
 *\r
 *      mtu\r
 *              MTU and MTU selector fields to use on this path\r
@@ -2858,6 +2855,9 @@ ib_path_rec_init_local(
 *      pkey\r
 *              [in] Partition key (P_Key) to use on this path.\r
 *\r
+*      qos_class\r
+*              [in] QoS class to use on this path.  Lower 12-bits are valid.\r
+*\r
 *      sl\r
 *              [in] Service level to use on this path.  Lower 4-bits are valid.\r
 *\r
@@ -3420,8 +3420,9 @@ typedef struct _ib_class_port_info
 *      cap_mask\r
 *              Supported capabilities of this management class.\r
 *\r
-*      resp_time_value\r
-*              Maximum expected response time.\r
+*      cap_mask2_resp_time\r
+*              Maximum expected response time and additional\r
+*              supported capabilities of this management class.\r
 *\r
 *      redr_gid\r
 *              GID to use for redirection, or zero\r
@@ -3890,7 +3891,8 @@ ib_mad_init_response(
 *      ib_mad_is_response\r
 *\r
 * DESCRIPTION\r
-*      Returns TRUE if the MAD is a response ('R' bit set),\r
+*      Returns TRUE if the MAD is a response ('R' bit set)\r
+*      or if the MAD is a TRAP REPRESS,\r
 *      FALSE otherwise.\r
 *\r
 * SYNOPSIS\r
@@ -4208,7 +4210,7 @@ ib_smp_is_d(
 *\r
 * TODO\r
 *      This is too big for inlining, but leave it here for now\r
-*      since there is not yet another convient spot.\r
+*      since there is not yet another convenient spot.\r
 *\r
 * SYNOPSIS\r
 */\r
@@ -4429,7 +4431,7 @@ ib_sa_mad_get_payload_ptr(
 }\r
 /*\r
 * PARAMETERS\r
-*      p_smp\r
+*      p_sa_mad\r
 *              [in] Pointer to the SA MAD packet.\r
 *\r
 * RETURN VALUES\r
@@ -4586,24 +4588,24 @@ typedef struct _ib_port_info
 \r
 #define IB_PORT_STATE_MASK                                                     0x0F\r
 #define IB_PORT_LMC_MASK                                                       0x07\r
-#define IB_PORT_LMC_MAX                                0x07\r
+#define IB_PORT_LMC_MAX                                                                0x07\r
 #define IB_PORT_MPB_MASK                                                       0xC0\r
 #define IB_PORT_MPB_SHIFT                                                      6\r
 #define IB_PORT_LINK_SPEED_SHIFT                                       4\r
 #define IB_PORT_LINK_SPEED_SUPPORTED_MASK                      0xF0\r
 #define IB_PORT_LINK_SPEED_ACTIVE_MASK                         0xF0\r
 #define IB_PORT_LINK_SPEED_ENABLED_MASK                                0x0F\r
-#define IB_PORT_PHYS_STATE_MASK                        0xF0\r
-#define IB_PORT_PHYS_STATE_SHIFT               4\r
-#define IB_PORT_PHYS_STATE_NO_CHANGE            0\r
-#define IB_PORT_PHYS_STATE_SLEEP                1\r
-#define IB_PORT_PHYS_STATE_POLLING              2\r
-#define IB_PORT_PHYS_STATE_DISABLED             3\r
-#define IB_PORT_PHYS_STATE_PORTCONFTRAIN        4\r
-#define IB_PORT_PHYS_STATE_LINKUP               5\r
-#define IB_PORT_PHYS_STATE_LINKERRRECOVER       6\r
-#define IB_PORT_PHYS_STATE_PHYTEST              7\r
-#define IB_PORT_LNKDWNDFTSTATE_MASK            0x0F\r
+#define IB_PORT_PHYS_STATE_MASK                                                0xF0\r
+#define IB_PORT_PHYS_STATE_SHIFT                                       4\r
+#define IB_PORT_PHYS_STATE_NO_CHANGE                0\r
+#define IB_PORT_PHYS_STATE_SLEEP                    1\r
+#define IB_PORT_PHYS_STATE_POLLING                  2\r
+#define IB_PORT_PHYS_STATE_DISABLED                 3\r
+#define IB_PORT_PHYS_STATE_PORTCONFTRAIN            4\r
+#define IB_PORT_PHYS_STATE_LINKUP                   5\r
+#define IB_PORT_PHYS_STATE_LINKERRRECOVER           6\r
+#define IB_PORT_PHYS_STATE_PHYTEST                  7\r
+#define IB_PORT_LNKDWNDFTSTATE_MASK                                    0x0F\r
 \r
 #define IB_PORT_CAP_RESV0                      (CL_NTOH32(0x00000001))\r
 #define IB_PORT_CAP_IS_SM                      (CL_NTOH32(0x00000002))\r
@@ -5661,7 +5663,7 @@ ib_port_info_get_client_rereg(
 *      ib_port_info_set_hoq_lifetime\r
 *\r
 * DESCRIPTION\r
-*      Sets the Head of Queue Lifetime for which a packet can live in the head \r
+*      Sets the Head of Queue Lifetime for which a packet can live in the head\r
 *  of VL queue\r
 *\r
 * SYNOPSIS\r
@@ -5695,7 +5697,7 @@ ib_port_info_set_hoq_lifetime(
 *      ib_port_info_get_hoq_lifetime\r
 *\r
 * DESCRIPTION\r
-*      Gets the Head of Queue Lifetime for which a packet can live in the head \r
+*      Gets the Head of Queue Lifetime for which a packet can live in the head\r
 *  of VL queue\r
 *\r
 * SYNOPSIS\r
@@ -5743,7 +5745,7 @@ ib_port_info_set_vl_stall_count(
 *      p_pi\r
 *              [in] Pointer to a PortInfo attribute.\r
 *\r
-*      vl_stall_count \r
+*      vl_stall_count\r
 *              [in] value to set\r
 *\r
 * RETURN VALUES\r
@@ -5759,7 +5761,7 @@ ib_port_info_set_vl_stall_count(
 *      ib_port_info_get_vl_stall_count\r
 *\r
 * DESCRIPTION\r
-*      Gets the VL Stall Count which define the number of contiguous \r
+*      Gets the VL Stall Count which define the number of contiguous\r
 *  HLL (hoq) drops that will put the VL into stalled mode\r
 *\r
 * SYNOPSIS\r
@@ -6046,10 +6048,10 @@ ib_port_info_set_phy_and_overrun_err_thd(
 *              [in] Pointer to a PortInfo attribute.\r
 *\r
 *      phy_threshold\r
-*              [in] Physical Link Errors Threshold above which Trap 129 is generated \r
+*              [in] Physical Link Errors Threshold above which Trap 129 is generated\r
 *\r
 *  overrun_threshold\r
-*     [in] Credits overrun Errors Threshold above which Trap 129 is generated \r
+*     [in] Credits overrun Errors Threshold above which Trap 129 is generated\r
 *\r
 * RETURN VALUES\r
 *      None.\r
@@ -6242,11 +6244,11 @@ ib_switch_info_clear_state_change(
 }\r
 /*\r
 * PARAMETERS\r
-*      p_ni\r
-*              [in] Pointer to a PortInfo attribute.\r
+*      p_si\r
+*              [in] Pointer to a SwitchInfo attribute.\r
 *\r
 * RETURN VALUES\r
-*      Returns the LMC value assigned to this port.\r
+*      None\r
 *\r
 * NOTES\r
 *\r
@@ -6351,8 +6353,8 @@ typedef struct _ib_multipath_rec_t
 *       pkey\r
 *               Partition key (P_Key) to use on this path.\r
 *\r
-*       sl\r
-*               Service level to use on this path.\r
+*       qos_class_sl\r
+*               QoS class and service level to use on this path.\r
 *\r
 *       mtu\r
 *               MTU and MTU selector fields to use on this path\r
@@ -6362,6 +6364,12 @@ typedef struct _ib_multipath_rec_t
 *       pkt_life\r
 *               Packet lifetime\r
 *\r
+*      service_id_8msb\r
+*              8 most significant bits of Service ID\r
+*\r
+*      service_id_56lsb\r
+*              56 least significant bits of Service ID\r
+*\r
 *       preference\r
 *               Indicates the relative merit of this path versus other path\r
 *               records returned from the SA.  Lower numbers are better.\r
@@ -6446,7 +6454,7 @@ AL_INLINE uint8_t AL_API
 ib_multipath_rec_sl(\r
        IN      const   ib_multipath_rec_t* const       p_rec )\r
 {\r
-       return ((uint8_t) ((cl_ntoh16(p_rec->qos_class_sl)) & IB_MULTIPATH_REC_SL_MASK));       \r
+       return ((uint8_t) ((cl_ntoh16(p_rec->qos_class_sl)) & IB_MULTIPATH_REC_SL_MASK));\r
 }\r
 /*\r
 * PARAMETERS\r
@@ -7207,9 +7215,6 @@ typedef struct _ib_member_rec
 *      port_gid\r
 *              Valid GID of the endpoint joining this multicast group.\r
 *\r
-*      requestor_gid\r
-*              GID of the endpoint making this request on hehave of port_gid.\r
-*\r
 *      qkey\r
 *              Q_Key to be used by this multicast group.\r
 *\r