TABLE OF CONTENTS

1. OpenSM/SA
2. OpenSM: SA/osm_sa_state_t
3. OpenSM: SM/osm_sa_t
4. OpenSM: SA/osm_sa_construct
5. OpenSM: SA/osm_sa_destroy
6. OpenSM: SA/osm_sa_init
7. OpenSM: SA/osm_sa_is_inited
8. OpenSM: SA/osm_sa_sweep
9. OpenSM: SA/osm_sa_bind

OpenSM/SA

    SA

    The SM object encapsulates the information needed by the
    OpenSM to instantiate a subnet manager.  The OpenSM allocates
    one SM object per subnet manager.

    The SM 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/osm_sa_state_t

    osm_sa_state_t

    Enumerates the possible states of SM object.

typedef enum _osm_sa_state
{
    OSM_SA_STATE_INIT = 0,
    OSM_SA_STATE_READY

} osm_sa_state_t;

OpenSM: SM/osm_sa_t

    osm_sa_t

    Subnet Manager structure.

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

typedef struct _osm_sa
{
    //osm_thread_state_t            thread_state;
    osm_sa_state_t              state;
    //cl_event_t                    signal;
    osm_subn_t                  *p_subn;
    osm_vendor_t                *p_vendor;
    osm_log_t                   *p_log;
    osm_mad_pool_t              *p_mad_pool;
    cl_dispatcher_t             *p_disp;
    cl_plock_t                  *p_lock;
    atomic32_t                  sa_trans_id;
    osm_sa_mad_ctrl_t           mad_ctrl;
    osm_sa_resp_t               resp;
    osm_nr_t                    nr;
    osm_nr_ctrl_t               nr_ctrl;
    //osm_pir_rcv_t             pir_rcv;
    //osm_pir_rcv_ctrl_t        pir_rcv_ctrl;
    //osm_sr_rcv_t              sr_rcv;
    //osm_sr_rcv_ctrl_t         sr_rcv_ctrl;
    //osm_pr_rcv_t              pr_rcv;
    //osm_pr_rcv_ctrl_t         pr_rcv_ctrl;
    //osm_mcmr_rcv_t                mcmr_rcv;
    //osm_mcmr_rcv_ctrl_t           mcmr_rcv_ctrl;
    
    Commented pending implementation...
    osm_sminfo_t                sm_info;


} osm_sa_t;

    p_subn
        Pointer to the Subnet object for this subnet.

    p_vendor
        Pointer to the vendor specific interfaces object.

    p_log
        Pointer to the log object.

    p_mad_pool
        Pointer to the MAD pool.

    p_vl15
        Pointer to the VL15 interface.

    gen_req
        Generic MAD attribute requester.

    gen_req_ctrl
        Controller for the generic requester.

    nd_rcv_ctrl
        Node Description Receive Controller.

    ni_rcv_ctrl
        Node Info Receive Controller.

    pi_rcv_ctrl
        Port Info Receive Controller.

    si_rcv_ctrl
        Switch Info Receive Controller.

    nd_rcv_ctrl
        Node Description Receive Controller.

    mad_ctrl
        MAD Controller.

    smi_get_ctrl
        SM Info Get Controller.

    p_disp
        Pointer to the Dispatcher.

    p_lock
        Pointer to the serializing lock.

    SM object

OpenSM: SA/osm_sa_construct

    osm_sa_construct

    This function constructs an SA object.

void osm_sa_construct(
    IN osm_sa_t* const p_sa );

    p_sa
        [in] Pointer to a SA object to construct.

    This function does not return a value.

    Allows calling osm_sa_init, osm_sa_destroy, and osm_sa_is_inited.

    Calling osm_sa_construct is a prerequisite to calling any other
    method except osm_sa_init.

    SA object, osm_sa_init, osm_sa_destroy, osm_sa_is_inited

OpenSM: SA/osm_sa_destroy

    osm_sa_destroy

    The osm_sa_destroy function destroys an SA, releasing
    all resources.

void osm_sa_destroy(
    IN osm_sa_t* const p_sa );

    p_sa
        [in] Pointer to a SA object to destroy.

    This function does not return a value.

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

    SA object, osm_sa_construct, osm_sa_init

OpenSM: SA/osm_sa_init

    osm_sa_init

    The osm_sa_init function initializes a SA object for use.

ib_api_status_t osm_sa_init(
    IN osm_sa_t* const p_sa,
    IN osm_subn_t* const p_subn,
    IN osm_vendor_t* const p_vendor,
    IN osm_mad_pool_t* const p_mad_pool,
    IN osm_log_t* const p_log,
    IN osm_stats_t* const p_stats,
    IN cl_dispatcher_t* const p_disp,
    IN cl_plock_t* const p_lock );

    p_sa
        [in] Pointer to an osm_sa_t object to initialize.

    p_subn
        [in] Pointer to the Subnet object for this subnet.

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

    p_mad_pool
        [in] Pointer to the MAD pool.

    p_vl15
        [in] Pointer to the VL15 interface.

    p_log
        [in] Pointer to the log object.

    p_stats
        [in] Pointer to the statistics object.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    p_lock
        [in] Pointer to the OpenSM serializing lock.

    CL_SUCCESS if the SA object was initialized successfully.

    Allows calling other SA methods.

    SA object, osm_sa_construct, osm_sa_destroy,
    osm_sa_is_inited

OpenSM: SA/osm_sa_is_inited

    osm_sa_is_inited

    Indicates if the object has been initialized with osm_sa_init.

boolean_t osm_sa_is_inited(
    IN const osm_sa_t* const p_sa );

    p_sa
        [in] Pointer to an osm_sa_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_sa_construct or osm_sa_init must be called before using
    this function.

    SA object, osm_sa_construct, osm_sa_init

OpenSM: SA/osm_sa_sweep

    osm_sa_sweep

    Initiates a subnet sweep.

void
osm_sa_sweep(
    IN osm_sa_t* const p_sa );

    p_sa
        [in] Pointer to an osm_sa_t object.

    CL_SUCCESS if the sweep completed successfully.

    SA object

OpenSM: SA/osm_sa_bind

    osm_sa_bind

    Binds the sm object to a port guid.

ib_api_status_t
osm_sa_bind(
    IN osm_sa_t* const p_sa,
    IN const ib_net64_t port_guid );

    p_sa
        [in] Pointer to an osm_sa_t object to bind.

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

    None

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