Generated from osm_helper.h with ROBODoc vunknown on Wed Aug 07 15:31:42 2002

TABLE OF CONTENTS

  1. OpenSM: Helper/ib_get_sm_attr_str
  2. OpenSM: Helper/osm_dump_port_info
  3. OpenSM: Helper/osm_dump_port_info
  4. OpenSM: Helper/osm_dump_switch_info
  5. IBA Base: Types/osm_get_disp_msg_str
  6. OpenSM: Base/osm_signal_t
  7. IBA Base: Types/osm_get_sm_signal_str

OpenSM: Helper/ib_get_sm_attr_str

NAME
    ib_get_sm_attr_str

DESCRIPTION
    Returns a string for the specified SM attribute value.

SYNOPSIS
 const char*
ib_get_sm_attr_str(
    IN ib_net16_t attr );
PARAMETERS
    attr
        [in] Network order attribute ID value.

RETURN VALUES
    Pointer to the attribute string.

NOTES

SEE ALSO

OpenSM: Helper/osm_dump_port_info

NAME
    osm_dump_port_info

DESCRIPTION
    Dumps the PortInfo attribute to the log.

SYNOPSIS
void osm_dump_port_info(
    IN osm_log_t* const p_log,
    IN const ib_net64_t node_guid,
    IN const ib_net64_t port_guid,
    IN const uint8_t port_num,
    IN const ib_port_info_t* const p_pi  );

PARAMETERS
    p_log
        [in] Pointer to the osm_log_t object

    node_guid
        [in] Node GUID that owns this port.

    port_guid
        [in] Port GUID for this port.

    port_num
        [in] Port number for this port.

    p_pi
        [in] Pointer to the PortInfo attribute

RETURN VALUES
    None.

NOTES

SEE ALSO

OpenSM: Helper/osm_dump_port_info

NAME
    osm_dump_port_info

DESCRIPTION
    Dumps the PortInfo attribute to the log.

SYNOPSIS
void osm_dump_node_info(
    IN osm_log_t* const p_log,
    IN const ib_node_info_t* const p_ni );

PARAMETERS
    p_log
        [in] Pointer to the osm_log_t object

    p_ni
        [in] Pointer to the NodeInfo attribute

RETURN VALUES
    None.

NOTES

SEE ALSO

OpenSM: Helper/osm_dump_switch_info

NAME
    osm_dump_switch_info

DESCRIPTION
    Dumps the SwitchInfo attribute to the log.

SYNOPSIS
void
osm_dump_switch_info(
    IN osm_log_t* const p_log,
    IN const ib_switch_info_t* const p_si );

PARAMETERS
    p_log
        [in] Pointer to the osm_log_t object

    p_si
        [in] Pointer to the SwitchInfo attribute

RETURN VALUES
    None.

NOTES

SEE ALSO

IBA Base: Types/osm_get_disp_msg_str

NAME
    osm_get_disp_msg_str

DESCRIPTION
    Returns a string for the specified Dispatcher message.

SYNOPSIS
 const char*
osm_get_disp_msg_str(
    IN cl_disp_msgid_t msg );
PARAMETERS
    msg
        [in] Dispatcher message ID value.

RETURN VALUES
    Pointer to the message discription string.

NOTES

SEE ALSO

OpenSM: Base/osm_signal_t

NAME
    osm_signal_t

DESCRIPTION
    Enumerates the possible return codes of the SM managers

SYNOPSIS
static const char* const __osm_sm_signal_str[] =
{
    "OSM_SIGNAL_NONE",                              /* 0 */
    "OSM_SIGNAL_SWEEP",                             /* 1 */
    "OSM_SIGNAL_CHANGE_DETECTED",                   /* 2 */
    "OSM_SIGNAL_NO_PENDING_TRANSACTIONS",           /* 3 */
    "OSM_SIGNAL_DONE",                              /* 4 */
    "OSM_SIGNAL_DONE_PENDING",                      /* 5 */
    "UNKNOWN SIGNAL!!"                              /* 6 */
};


IBA Base: Types/osm_get_sm_signal_str

NAME
    osm_get_sm_signal_str

DESCRIPTION
    Returns a string for the specified SM state.

SYNOPSIS
 const char*
osm_get_sm_signal_str(
    IN osm_signal_t signal );
PARAMETERS
    state
        [in] Signal value

RETURN VALUES
    Pointer to the signal discription string.

NOTES

SEE ALSO