rte_tm_driver.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2017 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __INCLUDE_RTE_TM_DRIVER_H__
#define __INCLUDE_RTE_TM_DRIVER_H__

#include <stdint.h>

#include <rte_errno.h>
#include "rte_ethdev.h"
#include "rte_tm.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int (*rte_tm_node_type_get_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    int *is_leaf,
    struct rte_tm_error *error);

typedef int (*rte_tm_capabilities_get_t)(struct rte_eth_dev *dev,
    struct rte_tm_capabilities *cap,
    struct rte_tm_error *error);

typedef int (*rte_tm_level_capabilities_get_t)(struct rte_eth_dev *dev,
    uint32_t level_id,
    struct rte_tm_level_capabilities *cap,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_capabilities_get_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    struct rte_tm_node_capabilities *cap,
    struct rte_tm_error *error);

typedef int (*rte_tm_wred_profile_add_t)(struct rte_eth_dev *dev,
    uint32_t wred_profile_id,
    struct rte_tm_wred_params *profile,
    struct rte_tm_error *error);

typedef int (*rte_tm_wred_profile_delete_t)(struct rte_eth_dev *dev,
    uint32_t wred_profile_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_shared_wred_context_add_update_t)(
    struct rte_eth_dev *dev,
    uint32_t shared_wred_context_id,
    uint32_t wred_profile_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_shared_wred_context_delete_t)(
    struct rte_eth_dev *dev,
    uint32_t shared_wred_context_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_shaper_profile_add_t)(struct rte_eth_dev *dev,
    uint32_t shaper_profile_id,
    struct rte_tm_shaper_params *profile,
    struct rte_tm_error *error);

typedef int (*rte_tm_shaper_profile_delete_t)(struct rte_eth_dev *dev,
    uint32_t shaper_profile_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_shared_shaper_add_update_t)(struct rte_eth_dev *dev,
    uint32_t shared_shaper_id,
    uint32_t shaper_profile_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_shared_shaper_delete_t)(struct rte_eth_dev *dev,
    uint32_t shared_shaper_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_add_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    uint32_t parent_node_id,
    uint32_t priority,
    uint32_t weight,
    uint32_t level_id,
    struct rte_tm_node_params *params,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_delete_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_suspend_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_resume_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_hierarchy_commit_t)(struct rte_eth_dev *dev,
    int clear_on_fail,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_parent_update_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    uint32_t parent_node_id,
    uint32_t priority,
    uint32_t weight,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_shaper_update_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    uint32_t shaper_profile_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_shared_shaper_update_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    uint32_t shared_shaper_id,
    int32_t add,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_stats_update_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    uint64_t stats_mask,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_wfq_weight_mode_update_t)(
    struct rte_eth_dev *dev,
    uint32_t node_id,
    int *wfq_weight_mode,
    uint32_t n_sp_priorities,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_cman_update_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    enum rte_tm_cman_mode cman,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_wred_context_update_t)(
    struct rte_eth_dev *dev,
    uint32_t node_id,
    uint32_t wred_profile_id,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_shared_wred_context_update_t)(
    struct rte_eth_dev *dev,
    uint32_t node_id,
    uint32_t shared_wred_context_id,
    int add,
    struct rte_tm_error *error);

typedef int (*rte_tm_node_stats_read_t)(struct rte_eth_dev *dev,
    uint32_t node_id,
    struct rte_tm_node_stats *stats,
    uint64_t *stats_mask,
    int clear,
    struct rte_tm_error *error);

typedef int (*rte_tm_mark_vlan_dei_t)(struct rte_eth_dev *dev,
    int mark_green,
    int mark_yellow,
    int mark_red,
    struct rte_tm_error *error);

typedef int (*rte_tm_mark_ip_ecn_t)(struct rte_eth_dev *dev,
    int mark_green,
    int mark_yellow,
    int mark_red,
    struct rte_tm_error *error);

typedef int (*rte_tm_mark_ip_dscp_t)(struct rte_eth_dev *dev,
    int mark_green,
    int mark_yellow,
    int mark_red,
    struct rte_tm_error *error);

struct rte_tm_ops {
    rte_tm_node_type_get_t node_type_get;

    rte_tm_capabilities_get_t capabilities_get;
    rte_tm_level_capabilities_get_t level_capabilities_get;
    rte_tm_node_capabilities_get_t node_capabilities_get;

    rte_tm_wred_profile_add_t wred_profile_add;
    rte_tm_wred_profile_delete_t wred_profile_delete;
    rte_tm_shared_wred_context_add_update_t
        shared_wred_context_add_update;
    rte_tm_shared_wred_context_delete_t
        shared_wred_context_delete;

    rte_tm_shaper_profile_add_t shaper_profile_add;
    rte_tm_shaper_profile_delete_t shaper_profile_delete;
    rte_tm_shared_shaper_add_update_t shared_shaper_add_update;
    rte_tm_shared_shaper_delete_t shared_shaper_delete;

    rte_tm_node_add_t node_add;
    rte_tm_node_delete_t node_delete;
    rte_tm_node_suspend_t node_suspend;
    rte_tm_node_resume_t node_resume;
    rte_tm_hierarchy_commit_t hierarchy_commit;

    rte_tm_node_parent_update_t node_parent_update;
    rte_tm_node_shaper_update_t node_shaper_update;
    rte_tm_node_shared_shaper_update_t node_shared_shaper_update;
    rte_tm_node_stats_update_t node_stats_update;
    rte_tm_node_wfq_weight_mode_update_t node_wfq_weight_mode_update;
    rte_tm_node_cman_update_t node_cman_update;
    rte_tm_node_wred_context_update_t node_wred_context_update;
    rte_tm_node_shared_wred_context_update_t
        node_shared_wred_context_update;
    rte_tm_node_stats_read_t node_stats_read;

    rte_tm_mark_vlan_dei_t mark_vlan_dei;
    rte_tm_mark_ip_ecn_t mark_ip_ecn;
    rte_tm_mark_ip_dscp_t mark_ip_dscp;
};

static inline int
rte_tm_error_set(struct rte_tm_error *error,
           int code,
           enum rte_tm_error_type type,
           const void *cause,
           const char *message)
{
    if (error) {
        *error = (struct rte_tm_error){
            .type = type,
            .cause = cause,
            .message = message,
        };
    }
    rte_errno = code;
    return code;
}

const struct rte_tm_ops *
rte_tm_ops_get(uint16_t port_id, struct rte_tm_error *error);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_TM_DRIVER_H__ */