1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef __INCLUDE_RTE_MTR_DRIVER_H__
6 #define __INCLUDE_RTE_MTR_DRIVER_H__
10 * RTE Generic Traffic Metering and Policing API (Driver Side)
12 * This file provides implementation helpers for internal use by PMDs, they
13 * are not intended to be exposed to applications and are not subject to ABI
19 #include <rte_errno.h>
20 #include "rte_ethdev.h"
21 #include "ethdev_driver.h"
28 typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
29 struct rte_mtr_capabilities *cap,
30 struct rte_mtr_error *error);
31 /**< @internal MTR capabilities get */
33 typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
34 uint32_t meter_profile_id,
35 struct rte_mtr_meter_profile *profile,
36 struct rte_mtr_error *error);
37 /**< @internal MTR meter profile add */
39 typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
40 uint32_t meter_profile_id,
41 struct rte_mtr_error *error);
42 /**< @internal MTR meter profile delete */
44 typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
46 struct rte_mtr_params *params,
48 struct rte_mtr_error *error);
49 /**< @internal MTR object create */
51 typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
53 struct rte_mtr_error *error);
54 /**< @internal MTR object destroy */
56 typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
58 struct rte_mtr_error *error);
59 /**< @internal MTR object meter enable */
61 typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
63 struct rte_mtr_error *error);
64 /**< @internal MTR object meter disable */
66 typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
68 uint32_t meter_profile_id,
69 struct rte_mtr_error *error);
70 /**< @internal MTR object meter profile update */
72 typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
74 enum rte_color *dscp_table,
75 struct rte_mtr_error *error);
76 /**< @internal MTR object meter DSCP table update */
78 typedef int (*rte_mtr_policer_actions_update_t)(struct rte_eth_dev *dev,
81 enum rte_mtr_policer_action *actions,
82 struct rte_mtr_error *error);
83 /**< @internal MTR object policer action update*/
85 typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
88 struct rte_mtr_error *error);
89 /**< @internal MTR object enabled stats update */
91 typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
93 struct rte_mtr_stats *stats,
96 struct rte_mtr_error *error);
97 /**< @internal MTR object stats read */
100 /** MTR capabilities get */
101 rte_mtr_capabilities_get_t capabilities_get;
103 /** MTR meter profile add */
104 rte_mtr_meter_profile_add_t meter_profile_add;
106 /** MTR meter profile delete */
107 rte_mtr_meter_profile_delete_t meter_profile_delete;
109 /** MTR object create */
110 rte_mtr_create_t create;
112 /** MTR object destroy */
113 rte_mtr_destroy_t destroy;
115 /** MTR object meter enable */
116 rte_mtr_meter_enable_t meter_enable;
118 /** MTR object meter disable */
119 rte_mtr_meter_disable_t meter_disable;
121 /** MTR object meter profile update */
122 rte_mtr_meter_profile_update_t meter_profile_update;
124 /** MTR object meter DSCP table update */
125 rte_mtr_meter_dscp_table_update_t meter_dscp_table_update;
127 /** MTR object policer action update */
128 rte_mtr_policer_actions_update_t policer_actions_update;
130 /** MTR object enabled stats update */
131 rte_mtr_stats_update_t stats_update;
133 /** MTR object stats read */
134 rte_mtr_stats_read_t stats_read;
138 * Initialize generic error structure.
140 * This function also sets rte_errno to a given value.
143 * Pointer to error structure (may be NULL).
145 * Related error code (rte_errno).
147 * Cause field and error type.
149 * Object responsible for the error.
151 * Human-readable error message.
157 rte_mtr_error_set(struct rte_mtr_error *error,
159 enum rte_mtr_error_type type,
164 *error = (struct rte_mtr_error){
175 * Get generic traffic metering and policing operations structure from a port
178 * The port identifier of the Ethernet device.
183 * The traffic metering and policing operations structure associated with
184 * port_id on success, NULL otherwise.
186 const struct rte_mtr_ops *
187 rte_mtr_ops_get(uint16_t port_id, struct rte_mtr_error *error);
193 #endif /* __INCLUDE_RTE_MTR_DRIVER_H__ */