TABLE OF CONTENTS

1. OpenSM/SA MAD Controller
2. OpenSM: SA MAD Controller/osm_sa_mad_ctrl_t
3. OpenSM: SA MAD Controller/osm_sa_mad_ctrl_construct
4. OpenSM: SA MAD Controller/osm_sa_mad_ctrl_destroy
5. OpenSM: SA MAD Controller/osm_sa_mad_ctrl_init
6. OpenSM: SA/osm_sa_mad_ctrl_bind
7. OpenSM: SA/osm_sa_mad_ctrl_get_bind_handle

OpenSM/SA MAD Controller

    SA MAD Controller

    The SA MAD Controller object encapsulates
    the information needed to receive MADs from the transport layer.

    The SA MAD Controller object is thread safe.

    This object should be treated as opaque and should be
    manipulated only through the provided functions.

    Ranjit Pandit, Intel

OpenSM: SA MAD Controller/osm_sa_mad_ctrl_t

    osm_sa_mad_ctrl_t

    SA MAD Controller structure.

    This object should be treated as opaque and should
    be manipulated only through the provided functions.

typedef struct _osm_sa_mad_ctrl
{
    osm_log_t                   *p_log;
    osm_mad_pool_t              *p_mad_pool;
    osm_vendor_t                *p_vendor;
    osm_bind_handle_t           h_bind;
    cl_dispatcher_t             *p_disp;
    cl_disp_reg_handle_t        h_disp;
    osm_stats_t                 *p_stats;

} osm_sa_mad_ctrl_t;

    p_log
        Pointer to the log object.

    p_mad_pool
        Pointer to the MAD pool.

    p_vendor
        Pointer to the vendor specific interfaces object.

    h_bind
        Bind handle returned by the transport layer.

    p_disp
        Pointer to the Dispatcher.

    h_disp
        Handle returned from dispatcher registration.

    p_stats
        Pointer to the OpenSM statistics block.

    SA MAD Controller object
    SA MADr object

OpenSM: SA MAD Controller/osm_sa_mad_ctrl_construct

    osm_sa_mad_ctrl_construct

    This function constructs a SA MAD Controller object.

void osm_sa_mad_ctrl_construct(
    IN osm_sa_mad_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to a SA MAD Controller
        object to construct.

    This function does not return a value.

    Allows calling osm_sa_mad_ctrl_init, osm_sa_mad_ctrl_destroy,
    and osm_sa_mad_ctrl_is_inited.

    Calling osm_sa_mad_ctrl_construct is a prerequisite to calling any other
    method except osm_sa_mad_ctrl_init.

    SA MAD Controller object, osm_sa_mad_ctrl_init,
    osm_sa_mad_ctrl_destroy, osm_sa_mad_ctrl_is_inited

OpenSM: SA MAD Controller/osm_sa_mad_ctrl_destroy

    osm_sa_mad_ctrl_destroy

    The osm_sa_mad_ctrl_destroy function destroys the object, releasing
    all resources.

void osm_sa_mad_ctrl_destroy(
    IN osm_sa_mad_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to the object to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified
    SA MAD Controller object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_sa_mad_ctrl_construct or osm_sa_mad_ctrl_init.

    SA MAD Controller object, osm_sa_mad_ctrl_construct,
    osm_sa_mad_ctrl_init

OpenSM: SA MAD Controller/osm_sa_mad_ctrl_init

    osm_sa_mad_ctrl_init

    The osm_sa_mad_ctrl_init function initializes a
    SA MAD Controller object for use.

ib_api_status_t osm_sa_mad_ctrl_init(
    IN osm_sa_mad_ctrl_t* const p_ctrl,
    IN osm_mad_pool_t* const p_mad_pool,
    IN osm_vendor_t* const p_vendor,
    IN osm_log_t* const p_log,
    IN osm_stats_t* const p_stats,
    IN cl_dispatcher_t* const p_disp );

    p_ctrl
        [in] Pointer to an osm_sa_mad_ctrl_t object to initialize.

    p_mad_pool
        [in] Pointer to the MAD pool.

    p_vendor
        [in] Pointer to the vendor specific interfaces object.

    p_log
        [in] Pointer to the log object.

    p_stats
        [in] Pointer to the OpenSM stastics block.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    IB_SUCCESS if the SA MAD Controller object was initialized
    successfully.

    Allows calling other SA MAD Controller methods.

    SA MAD Controller object, osm_sa_mad_ctrl_construct,
    osm_sa_mad_ctrl_destroy, osm_sa_mad_ctrl_is_inited

OpenSM: SA/osm_sa_mad_ctrl_bind

    osm_sa_mad_ctrl_bind

    Binds the SA MAD Controller object to a port guid.

ib_api_status_t
osm_sa_mad_ctrl_bind(
    IN osm_sa_mad_ctrl_t* const p_ctrl,
    IN const ib_net64_t port_guid );

    p_ctrl
        [in] Pointer to an osm_sa_mad_ctrl_t object to initialize.

    port_guid
        [in] Local port GUID with which to bind.

    None

    A given SA MAD Controller object can only be bound to one
    port at a time.

OpenSM: SA/osm_sa_mad_ctrl_get_bind_handle

    osm_sa_mad_ctrl_get_bind_handle

    Returns the bind handle.

 osm_bind_handle_t
osm_sa_mad_ctrl_get_bind_handle(
    IN const osm_sa_mad_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to an osm_sa_mad_ctrl_t object.

    Returns the bind handle, which may be OSM_BIND_INVALID_HANDLE
    if no port has been bound.

    A given SA MAD Controller object can only be bound to one
    port at a time.