sx_lib_adviser.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2010-2019. Mellanox Technologies, Ltd. ALL RIGHTS RESERVED.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License"); you may
 *    not use this file except in compliance with the License. You may obtain
 *    a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 *    THIS CODE IS PROVIDED ON AN  *AS IS* BASIS, WITHOUT WARRANTIES OR
 *    CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
 *    LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
 *    FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
 *
 *    See the Apache Version 2.0 License for specific language governing
 *    permissions and limitations under the License.
 *
 */
 
 
#ifndef __SX_LIB_ADVISER_H__
#define __SX_LIB_ADVISER_H__
 
#include "sx/sdk/sx_types.h"
 
 
/************************************************
 *  Type definitions
 ***********************************************/
#define SX_GENERATE_ENUM(ENUM, STR) ENUM,
 
 
#define FOREACH_SX_LIB_ADVISER_EVENT_TYPE(F)                             \
    F(SX_LIB_ADVISER_EVENT_NONE_E = 0, "N/A")                            \
    F(SX_LIB_ADVISER_PORT_ADDED_E = 1, "Port Added")                     \
    F(SX_LIB_ADVISER_PORT_DELETED_E = 2, "Port Deleted")                 \
    F(SX_LIB_ADVISER_PORT_ADDED_TO_LAG = 3, "Port Added to LAG")         \
    F(SX_LIB_ADVISER_PORT_DELETED_FROM_LAG = 4, "Port Deleted from LAG") \
    F(SX_LIB_ADVISER_EVENT_TYPE_MIN_E = SX_LIB_ADVISER_PORT_ADDED_E, "") \
    F(SX_LIB_ADVISER_EVENT_TYPE_MAX_E = SX_LIB_ADVISER_PORT_DELETED_FROM_LAG, "")
 
typedef enum sx_lib_adviser_event_type {
    FOREACH_SX_LIB_ADVISER_EVENT_TYPE(SX_GENERATE_ENUM)
} sx_lib_adviser_event_type_e;
 
#define SX_LIB_ADVISER_EVENT_TYPE_NUM (SX_LIB_ADVISER_EVENT_TYPE_MAX_E + 1)
 
#define SX_LIB_ADVISER_EVENT_TYPE_CHECK_RANGE(TYPE) \
    (SX_CHECK_RANGE(SX_LIB_ADVISER_EVENT_TYPE_MIN_E, (TYPE), SX_LIB_ADVISER_EVENT_TYPE_MAX_E))
 
 
typedef sx_event_port_lag_changes_t sx_lib_adviser_event_lag_changes_t;
typedef sx_event_port_added_deleted_t sx_lib_adviser_event_port_added_deleted_t;
 
typedef struct sx_lib_adviser_event_info {
    sx_lib_adviser_event_type_e type;
    union {
        sx_lib_adviser_event_lag_changes_t        lag_changes;
        sx_lib_adviser_event_port_added_deleted_t port_added_deleted;
    } info;
} sx_lib_adviser_event_info_t;
 
typedef sx_status_t (*sx_lib_adviser_cb_t)(const sx_lib_adviser_event_info_t event_info, const void *context);
 
typedef struct sx_lib_adviser_event_registration_params {
    sx_lib_adviser_event_type_e event_type;
    sx_lib_adviser_cb_t         callback; 
    void                       *context; 
    sx_port_log_id_t           *excluded_ports_p; 
    uint32_t                    excluded_ports_cnt; 
} sx_lib_adviser_event_registration_params_t;
 
typedef struct sx_lib_adviser_init_params {
    sx_log_cb_t          logging_cb;
    sx_verbosity_level_t verbosity_level;
} sx_lib_adviser_init_params_t;
 
 
/************************************************
 *  API functions
 ***********************************************/
 
sx_status_t sx_lib_adviser_init(const sx_lib_adviser_init_params_t init_params);
 
sx_status_t sx_lib_adviser_deinit(void);
 
 
sx_status_t sx_lib_adviser_event_register(const sx_lib_adviser_event_registration_params_t event_register_params);
 
sx_status_t sx_lib_adviser_event_deregister(const sx_lib_adviser_event_registration_params_t event_register_params);
 
 
#endif /* __SX_LIB_ADVISER_H__ */