From: sleybo Date: Thu, 2 Nov 2006 11:13:46 +0000 (+0000) Subject: [INC] update cosmetics fixes to comments from Linux branch X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=1b52ceef16f5084fede84b34dcceacaf4a65205c;p=~shefty%2Frdma-win.git [INC] update cosmetics fixes to comments from Linux branch git-svn-id: svn://openib.tc.cornell.edu/gen1@537 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86 --- diff --git a/trunk/ulp/opensm/user/include/iba/ib_types.h b/trunk/ulp/opensm/user/include/iba/ib_types.h index 97dd8d99..136c673f 100644 --- a/trunk/ulp/opensm/user/include/iba/ib_types.h +++ b/trunk/ulp/opensm/user/include/iba/ib_types.h @@ -1,6 +1,6 @@ /* - * Copyright (c) 2004, 2005 Voltaire, Inc. All rights reserved. - * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved. + * Copyright (c) 2004-2006 Voltaire, Inc. All rights reserved. + * Copyright (c) 2002-2006 Mellanox Technologies LTD. All rights reserved. * Copyright (c) 1996-2003 Intel Corporation. All rights reserved. * * This software is available to you under a choice of one of two @@ -38,6 +38,7 @@ #if !defined(__IB_TYPES_H__) #define __IB_TYPES_H__ +#include #include #include #include @@ -85,7 +86,7 @@ BEGIN_C_DECLS * DESCRIPTION * The following constants are used throughout the IBA code base. * -* Definitions are from the InfiniBand Architecture Specification v1.1 +* Definitions are from the InfiniBand Architecture Specification v1.2 * *********/ @@ -570,7 +571,7 @@ BEGIN_C_DECLS * ib_class_is_vendor_specific_low * * DESCRIPTION -* Indicitates if the Class Code if a vendor specific class from +* Indicates if the Class Code if a vendor specific class from * the low range * * SYNOPSIS @@ -602,7 +603,7 @@ ib_class_is_vendor_specific_low( * ib_class_is_vendor_specific_high * * DESCRIPTION -* Indicitates if the Class Code if a vendor specific class from +* Indicates if the Class Code if a vendor specific class from * the high range * * SYNOPSIS @@ -635,7 +636,7 @@ ib_class_is_vendor_specific_high( * ib_class_is_vendor_specific * * DESCRIPTION -* Indicitates if the Class Code if a vendor specific class +* Indicates if the Class Code if a vendor specific class * * SYNOPSIS */ @@ -732,8 +733,8 @@ ib_class_is_vendor_specific( * SOURCE */ #define IB_MAD_METHOD_GETTABLE 0x12 - /**********/ + /****d* IBA Base: Constants/IB_MAD_METHOD_GETTABLE_RESP * NAME * IB_MAD_METHOD_GETTABLE_RESP @@ -1188,7 +1189,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_LFT_RECORD * * DESCRIPTION -* LinearForwardingRecord attribute (15.2.5.6) +* LinearForwardingTableRecord attribute (15.2.5.6) * * SOURCE */ @@ -1200,7 +1201,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_PKEYTBL_RECORD * * DESCRIPTION -* P-KEY table attribute (15.2.5) +* PKEY Table Record attribute (15.2.5) * * SOURCE */ @@ -1224,7 +1225,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_VLARB_RECORD * * DESCRIPTION -* VL Arbitration Table attribute (15.2.5) +* VL Arbitration Table Record attribute (15.2.5) * * SOURCE */ @@ -1236,7 +1237,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_SLVL_RECORD * * DESCRIPTION -* VSLtoL Map Table attribute (15.2.5) +* SLtoVL Mapping Table Record attribute (15.2.5) * * SOURCE */ @@ -1272,7 +1273,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_MULTIPATH_RECORD * * DESCRIPTION -* MultiPath attribute (15.2.5) +* MultiPathRecord attribute (15.2.5) * * SOURCE */ @@ -1284,7 +1285,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_SVC_ASSOCIATION_RECORD * * DESCRIPTION -* Service Association attribute (15.2.5) +* Service Association Record attribute (15.2.5) * * SOURCE */ @@ -1392,7 +1393,7 @@ ib_class_is_vendor_specific( * IB_MAD_ATTR_SVC_ASSOCIATION_RECORD * * DESCRIPTION -* Service Association attribute (15.2.5) +* Service Association Record attribute (15.2.5) * * SOURCE */ @@ -1517,10 +1518,10 @@ ib_class_is_vendor_specific( * * DESCRIPTION * Path selector. -* 0: greater than rate specified -* 1: less than rate specified -* 2: exactly the rate specified -* 3: largest rate available +* 0: greater than specified +* 1: less than specified +* 2: exactly the specified +* 3: largest available * * SOURCE */ @@ -1579,7 +1580,7 @@ ib_class_is_vendor_specific( * IB_PATH_REC_SELECTOR_MASK * * DESCRIPTION -* Mask for the selector field for path record MTU, rate +* Mask for the selector field for path record MTU, rate, * and packet lifetime. * * SOURCE @@ -1591,7 +1592,7 @@ ib_class_is_vendor_specific( * IB_PATH_REC_BASE_MASK * * DESCRIPTION -* Mask for the base value field for path record MTU, rate +* Mask for the base value field for path record MTU, rate, * and packet lifetime. * * SOURCE @@ -1604,7 +1605,7 @@ ib_class_is_vendor_specific( * Type Definitions * * DESCRIPTION -* Definitions are from the InfiniBand Architecture Specification v1.1 +* Definitions are from the InfiniBand Architecture Specification v1.2 * *********/ /****d* IBA Base: Types/ib_net16_t @@ -1837,7 +1838,7 @@ ib_pkey_get_base( * ib_pkey_is_full_member * * DESCRIPTION -* Indicitates if the port is a full member of the parition. +* Indicates if the port is a full member of the parition. * * SYNOPSIS */ @@ -2152,7 +2153,7 @@ typedef struct _ib_path_rec * * num_path * Reversible path - 1 bit to say if path is reversible. -* Num-Paths [6:0] In queries, maximum number of paths to return. +* num_path [6:0] In queries, maximum number of paths to return. * In responses, undefined. * * pkey @@ -2246,7 +2247,7 @@ typedef struct _ib_path_rec #define IB_NR_COMPMASK_VENDID (CL_HTON64(((uint64_t)1)<<13)) #define IB_NR_COMPMASK_NODEDESC (CL_HTON64(((uint64_t)1)<<14)) -/* Service Record Component Mask Sec 15.2.5.14 Ver 1.1*/ +/* Service Record Component Masks Sec 15.2.5.14 Ver 1.1*/ #define IB_SR_COMPMASK_SID (CL_HTON64(((uint64_t)1)<<0)) #define IB_SR_COMPMASK_SGID (CL_HTON64(((uint64_t)1)<<1)) #define IB_SR_COMPMASK_SPKEY (CL_HTON64(((uint64_t)1)<<2)) @@ -2441,7 +2442,7 @@ ib_path_rec_init_local( * * num_path * [in] Reversible path - 1 bit to say if path is reversible. -* Num-Paths [6:0] In queries, maximum number of paths to return. +* num_path [6:0] In queries, maximum number of paths to return. * In responses, undefined. * * pkey @@ -2531,13 +2532,7 @@ ib_path_rec_sl( * [in] Pointer to the path record object. * * RETURN VALUES -* Encoded path MTU. -* 1: 256 -* 2: 512 -* 3: 1024 -* 4: 2048 -* 5: 4096 -* others: reserved +* SL. * * NOTES * @@ -2638,6 +2633,12 @@ ib_path_rec_rate( * 2: 2.5 Gb/sec. * 3: 10 Gb/sec. * 4: 30 Gb/sec. +* 5: 5 Gb/sec. +* 6: 20 Gb/sec. +* 7: 40 Gb/sec. +* 8: 60 Gb/sec. +* 9: 80 Gb/sec. +* 10: 120 Gb/sec. * others: reserved * * NOTES @@ -2700,7 +2701,7 @@ ib_path_rec_pkt_life( * [in] Pointer to the path record object. * * RETURN VALUES -* Encoded path pkt_life = 4.096 µsec * 2 PacketLifeTime. +* Encoded path pkt_life = 4.096 µsec * 2 ** PacketLifeTime. * * NOTES * @@ -4258,7 +4259,7 @@ ib_port_info_get_port_phys_state( * SEE ALSO *********/ -/****f* IBA Base: Types/ib_port_info_set_port_phys_state. +/****f* IBA Base: Types/ib_port_info_set_port_phys_state * NAME * ib_port_info_set_port_phys_state * @@ -4781,7 +4782,7 @@ ib_port_info_set_client_rereg( * [in] Pointer to a PortInfo attribute. * * client_rereg -* [in] Client reregistration value to set either 1 or 0 +* [in] Client reregistration value to set (either 1 or 0). * * RETURN VALUES * None. @@ -4839,11 +4840,8 @@ ib_port_info_get_client_rereg( * p_pi * [in] Pointer to a PortInfo attribute. * -* client_rereg -* [in] Client reregistration value to get either 1 or 0 -* * RETURN VALUES -* None. +* Client reregistration value (either 1 or 0). * * NOTES * @@ -5527,6 +5525,7 @@ typedef struct _ib_pkey_table_record #include /************/ +#define IB_DROP_VL 15 #define IB_MAX_NUM_VLS 16 /****s* IBA Base: Types/ib_slvl_table_t * NAME @@ -5654,7 +5653,7 @@ ib_slvl_table_get( * [in] the sl index in the table whose value should be returned. * * RETURN VALUES -* vl that is updated for that sl. +* vl for the requested sl_index. * * NOTES * @@ -5914,7 +5913,7 @@ typedef struct _ib_member_rec * ib_member_get_sl_flow_hop * * DESCRIPTION -* Get encoded sl flow label and hop limit +* Get encoded sl, flow label, and hop limit * * SYNOPSIS */ @@ -5943,7 +5942,7 @@ ib_member_get_sl_flow_hop( /* * PARAMETERS * sl_flow_hop -* [in] the sl flow label and hop limit of MC Group +* [in] the sl, flow label, and hop limit of MC Group * * RETURN VALUES * p_sl @@ -5966,7 +5965,7 @@ ib_member_get_sl_flow_hop( * ib_member_set_sl_flow_hop * * DESCRIPTION -* Set encoded version, sl flow and hop +* Set encoded sl, flow label, and hop limit * * SYNOPSIS */ @@ -5998,7 +5997,7 @@ ib_member_set_sl_flow_hop( * * RETURN VALUES * sl_flow_hop -* [out] the sl flow label and hop limit +* [out] the encoded sl, flow label, and hop limit * * NOTES * @@ -7220,8 +7219,8 @@ typedef struct _ib_cq* __ptr64 ib_cq_handle_t; typedef struct _ib_av* __ptr64 ib_av_handle_t; typedef struct _ib_mcast* __ptr64 ib_mcast_handle_t; -/* Currently for windows branch we use the extended version of ib special verbs struct - in order to be compliant with Infinicon ib_types , later we'll change it to support +/* Currently for windows branch, use the extended version of ib special verbs struct + in order to be compliant with Infinicon ib_types; later we'll change it to support OpenSM ib_types.h */ #ifndef WIN32 @@ -8423,8 +8422,8 @@ typedef struct _ib_qp_mod struct _qp_reset { /* - * Time, in milliseconds, that the QP needs to spend in the - * time wait state before being reused. + * Time, in milliseconds, that the QP needs to spend in + * the time wait state before being reused. */ uint32_t timewait; @@ -8698,8 +8697,8 @@ typedef uint32_t ib_send_opt_t; * Send immediate data with the given request. * * IB_SEND_OPT_FENCE -* The operation is fenced. Complete all pending send operations before -* processing this request. +* The operation is fenced. Complete all pending send operations +* before processing this request. * * IB_SEND_OPT_SIGNALED * If the queue pair is configured for signaled completion, then @@ -9564,26 +9563,28 @@ typedef uint32_t ib_ca_mod_t; * Indicates if there is an SNMP agent accessible through the port. * * IB_CA_MOD_IS_DEV_MGMT_SUPPORTED -* Indicates if there is a device management agent accessible through -* the port. +* Indicates if there is a device management agent accessible +* through the port. * * IB_CA_MOD_IS_VEND_SUPPORTED -* Indicates if there is a vendor supported agent accessible through -* the port. +* Indicates if there is a vendor supported agent accessible +* through the port. * * IB_CA_MOD_IS_SM * Indicates if there is a subnet manager accessible through * the port. * * IB_CA_MOD_IS_SM_DISABLED -* Indicates if the port has been disabled for configuration by the subnet -* manager. +* Indicates if the port has been disabled for configuration by the +* subnet manager. * * IB_CA_MOD_QKEY_CTR -* Used to reset the qkey violation counter associated with the port. +* Used to reset the qkey violation counter associated with the +* port. * * IB_CA_MOD_PKEY_CTR -* Used to reset the pkey violation counter associated with the port. +* Used to reset the pkey violation counter associated with the +* port. * * IB_CA_MOD_IS_NOTICE_SUPPORTED * Indicates that this CA supports ability to generate Notices for @@ -9594,7 +9595,8 @@ typedef uint32_t ib_ca_mod_t; * trap messages. (only applicable to switches) * * IB_CA_MOD_IS_APM_SUPPORTED -* Indicates that this port is capable of performing Automatic Migration. +* Indicates that this port is capable of performing Automatic +* Path Migration. * * IB_CA_MOD_IS_SLMAP_SUPPORTED * Indicates this port supports SLMAP capability. @@ -9786,7 +9788,7 @@ typedef struct _ib_ci_op END_C_DECLS -#endif +#endif /* ndef WIN */ #if defined( __WIN__ ) #include #endif