rte_mtr_driver.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 Intel Corporation
 */

#ifndef __INCLUDE_RTE_MTR_DRIVER_H__
#define __INCLUDE_RTE_MTR_DRIVER_H__

#include <stdint.h>

#include <rte_errno.h>
#include "rte_ethdev.h"
#include "ethdev_driver.h"
#include "rte_mtr.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
    struct rte_mtr_capabilities *cap,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
    uint32_t meter_profile_id,
    struct rte_mtr_meter_profile *profile,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
    uint32_t meter_profile_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_policy_validate_t)(struct rte_eth_dev *dev,
    struct rte_mtr_meter_policy_params *policy,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_policy_add_t)(struct rte_eth_dev *dev,
    uint32_t policy_id,
    struct rte_mtr_meter_policy_params *policy,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_policy_delete_t)(struct rte_eth_dev *dev,
    uint32_t policy_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_params *params,
    int shared,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint32_t meter_profile_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_policy_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint32_t meter_policy_id,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    enum rte_color *dscp_table,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_vlan_table_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    enum rte_color *vlan_table,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_color_in_proto_set_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    enum rte_mtr_color_in_protocol proto,
    uint32_t priority,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_color_in_proto_get_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint64_t *proto_mask,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_meter_color_in_proto_prio_get_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    enum rte_mtr_color_in_protocol proto,
    uint32_t *priority,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    uint64_t stats_mask,
    struct rte_mtr_error *error);

typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
    uint32_t mtr_id,
    struct rte_mtr_stats *stats,
    uint64_t *stats_mask,
    int clear,
    struct rte_mtr_error *error);

struct rte_mtr_ops {
    rte_mtr_capabilities_get_t capabilities_get;

    rte_mtr_meter_profile_add_t meter_profile_add;

    rte_mtr_meter_profile_delete_t meter_profile_delete;

    rte_mtr_create_t create;

    rte_mtr_destroy_t destroy;

    rte_mtr_meter_enable_t meter_enable;

    rte_mtr_meter_disable_t meter_disable;

    rte_mtr_meter_profile_update_t meter_profile_update;

    rte_mtr_meter_dscp_table_update_t meter_dscp_table_update;

    rte_mtr_meter_vlan_table_update_t meter_vlan_table_update;

    rte_mtr_meter_color_in_proto_set_t in_proto_set;

    rte_mtr_meter_color_in_proto_get_t in_proto_get;

    rte_mtr_meter_color_in_proto_prio_get_t in_proto_prio_get;

    rte_mtr_stats_update_t stats_update;

    rte_mtr_stats_read_t stats_read;

    rte_mtr_meter_policy_validate_t meter_policy_validate;

    rte_mtr_meter_policy_add_t meter_policy_add;

    rte_mtr_meter_policy_delete_t meter_policy_delete;

    rte_mtr_meter_policy_update_t meter_policy_update;
};

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

const struct rte_mtr_ops *
rte_mtr_ops_get(uint16_t port_id, struct rte_mtr_error *error);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_MTR_DRIVER_H__ */