inc/saiipmcgroup.h

/**
 * Copyright (c) 2014 Microsoft Open Technologies, Inc.
 *
 *    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, MERCHANTABILITY OR NON-INFRINGEMENT.
 *
 *    See the Apache Version 2.0 License for specific language governing
 *    permissions and limitations under the License.
 *
 *    Microsoft would like to thank the following companies for their review and
 *    assistance with these files: Intel Corporation, Mellanox Technologies Ltd,
 *    Dell Products, L.P., Facebook, Inc., Marvell International Ltd.
 *
 * @file    saiipmcgroup.h
 *
 * @brief   This module defines SAI IPMC Group interface
 */

#if !defined (__SAIIPMCGROUP_H_)
#define __SAIIPMCGROUP_H_

#include <saitypes.h>

/**
 * @defgroup SAIIPMCGROUP SAI - IPMC group specific API definitions
 *
 * @{
 */

/**
 * @brief Attributes for IPMC group
 */
typedef enum _sai_ipmc_group_attr_t
{
    /**
     * @brief Start of attributes
     */
    SAI_IPMC_GROUP_ATTR_START,

    /**
     * @brief Number of IPMC interfaces in the group
     *
     * @type sai_uint32_t
     * @flags READ_ONLY
     */
    SAI_IPMC_GROUP_ATTR_IPMC_OUTPUT_COUNT = SAI_IPMC_GROUP_ATTR_START,

    /**
     * @brief IPMC member list
     *
     * @type sai_object_list_t
     * @flags READ_ONLY
     * @objects SAI_OBJECT_TYPE_IPMC_GROUP_MEMBER
     */
    SAI_IPMC_GROUP_ATTR_IPMC_MEMBER_LIST,

    /**
     * @brief End of attributes
     */
    SAI_IPMC_GROUP_ATTR_END,

    /** Custom range base value */
    SAI_IPMC_GROUP_ATTR_CUSTOM_RANGE_START = 0x10000000,

    /** End of custom range base */
    SAI_IPMC_GROUP_ATTR_CUSTOM_RANGE_END

} sai_ipmc_group_attr_t;

typedef enum _sai_ipmc_group_member_attr_t
{
    /**
     * @brief Start of attributes
     */
    SAI_IPMC_GROUP_MEMBER_ATTR_START,

    /**
     * @brief IPMC group id
     *
     * @type sai_object_id_t
     * @flags MANDATORY_ON_CREATE | CREATE_ONLY
     * @objects SAI_OBJECT_TYPE_IPMC_GROUP
     */
    SAI_IPMC_GROUP_MEMBER_ATTR_IPMC_GROUP_ID = SAI_IPMC_GROUP_MEMBER_ATTR_START,

    /**
     * @brief IPMC output id
     *
     * @type sai_object_id_t
     * @flags MANDATORY_ON_CREATE | CREATE_ONLY
     * @objects SAI_OBJECT_TYPE_ROUTER_INTERFACE, SAI_OBJECT_TYPE_TUNNEL, SAI_OBJECT_TYPE_NEXT_HOP
     */
    SAI_IPMC_GROUP_MEMBER_ATTR_IPMC_OUTPUT_ID,

    /**
     * @brief End of attributes
     */
    SAI_IPMC_GROUP_MEMBER_ATTR_END,

    /** Custom range base value */
    SAI_IPMC_GROUP_MEMBER_ATTR_CUSTOM_RANGE_START = 0x10000000,

    /** End of custom range base */
    SAI_IPMC_GROUP_MEMBER_ATTR_CUSTOM_RANGE_END

} sai_ipmc_group_member_attr_t;

/**
 * @brief Create IPMC group
 *
 * @param[out] ipmc_group_id IPMC group id
 * @param[in] switch_id Switch id
 * @param[in] attr_count Number of attributes
 * @param[in] attr_list Array of attributes
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_create_ipmc_group_fn)(
        _Out_ sai_object_id_t *ipmc_group_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);

/**
 * @brief Remove IPMC group
 *
 * @param[in] ipmc_group_id IPMC group id
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_remove_ipmc_group_fn)(
        _In_ sai_object_id_t ipmc_group_id);

/**
 * @brief Set IPMC Group attribute
 *
 * @param[in] ipmc_group_id IPMC group id
 * @param[in] attr Attribute
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_set_ipmc_group_attribute_fn)(
        _In_ sai_object_id_t ipmc_group_id,
        _In_ const sai_attribute_t *attr);

/**
 * @brief Get IPMC Group attribute
 *
 * @param[in] ipmc_group_id IPMC group id
 * @param[in] attr_count Number of attributes
 * @param[inout] attr_list Array of attributes
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_get_ipmc_group_attribute_fn)(
        _In_ sai_object_id_t ipmc_group_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);

/**
 * @brief Create IPMC group member
 *
 * @param[out] ipmc_group_member_id IPMC group member id
 * @param[in] switch_id Switch ID
 * @param[in] attr_count Number of attributes
 * @param[in] attr_list Array of attributes
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_create_ipmc_group_member_fn)(
        _Out_ sai_object_id_t *ipmc_group_member_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);

/**
 * @brief Remove IPMC group member
 *
 * @param[in] ipmc_group_member_id IPMC group member id
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_remove_ipmc_group_member_fn)(
        _In_ sai_object_id_t ipmc_group_member_id);

/**
 * @brief Set IPMC Group attribute
 *
 * @param[in] ipmc_group_member_id IPMC group member id
 * @param[in] attr Attribute
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_set_ipmc_group_member_attribute_fn)(
        _In_ sai_object_id_t ipmc_group_member_id,
        _In_ const sai_attribute_t *attr);

/**
 * @brief Get IPMC Group attribute
 *
 * @param[in] ipmc_group_member_id IPMC group member ID
 * @param[in] attr_count Number of attributes
 * @param[inout] attr_list Array of attributes
 *
 * @return #SAI_STATUS_SUCCESS on success, failure status code on error
 */
typedef sai_status_t (*sai_get_ipmc_group_member_attribute_fn)(
        _In_ sai_object_id_t ipmc_group_member_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);

/**
 * @brief IPMC group methods table retrieved with sai_api_query()
 */
typedef struct _sai_ipmc_group_api_t
{
    sai_create_ipmc_group_fn                    create_ipmc_group;
    sai_remove_ipmc_group_fn                    remove_ipmc_group;
    sai_set_ipmc_group_attribute_fn             set_ipmc_group_attribute;
    sai_get_ipmc_group_attribute_fn             get_ipmc_group_attribute;
    sai_create_ipmc_group_member_fn             create_ipmc_group_member;
    sai_remove_ipmc_group_member_fn             remove_ipmc_group_member;
    sai_set_ipmc_group_member_attribute_fn      set_ipmc_group_member_attribute;
    sai_get_ipmc_group_member_attribute_fn      get_ipmc_group_member_attribute;

} sai_ipmc_group_api_t;

/**
 * @}
 */
#endif /** __SAIIPMCGROUP_H_ */