TM Requirements Record. More...

#include <traffic_mngr.h>

Collaboration diagram for odp_tm_requirements_t:

Data Fields
uint32_t	max_tm_queues
	max_tm_queues specifies the maximum number of tm_queues that will be used for this TM System.

uint8_t	num_levels
	num_levels specifies that number of levels of hierarchical scheduling that will be used. More...

odp_bool_t	tm_queue_shaper_needed
	tm_queue_shaper_needed indicates that the tm_queues are expected to do TM shaping.

odp_bool_t	tm_queue_wred_needed
	tm_queue_wred_needed indicates that the tm_queues are expected to participate in some form of Random Early Detection.

odp_bool_t	tm_queue_dual_slope_needed
	tm_queue_dual_slope_needed indicates that the tm_queues are expected to use the dual slope WRED capability. More...

odp_bool_t	tm_queue_threshold_needed
	tm_queue_threshold_needed indicates that the tm_queues are expected to use threshold profile support

odp_bool_t	vlan_marking_needed
	vlan_marking_needed indicates that the ODP application expects to use some form of VLAN egress marking using the odp_tm_vlan_marking() function. More...

odp_bool_t	ecn_marking_needed
	ecn_marking_needed indicates that the ODP application expects to use some form of IPv4 TOS or IPv6 TC field egress marking by using the odp_tm_ecn_marking() function. More...

odp_bool_t	drop_prec_marking_needed
	drop_prec_marking_needed indicates that the ODP application expects to use some form of IPv4 TOS or IPv6 TC field egress marking by using the odp_tm_drop_prec_marking() function. More...

odp_bool_t	marking_colors_needed [ODP_NUM_PACKET_COLORS]
	The marking_colors_needed array is used to indicate which colors are expected to be used for marking. More...

odp_tm_pkt_prio_mode_t	pkt_prio_mode
	Packet priority mode. More...

odp_tm_level_requirements_t	per_level [ODP_TM_MAX_LEVELS]
	The per_level array specifies the TM system requirements that can vary based upon the tm_node level.

Detailed Description

TM Requirements Record.

The odp_tm_requirements_t record type is used to describe the minimum set of features and limits to be actually used by the application.

The default value of all boolean fields is false.

Examples: odp_traffic_mgmt.c.

Definition at line 636 of file api/spec/traffic_mngr.h.

Field Documentation

◆ num_levels

uint8_t odp_tm_requirements_t::num_levels

num_levels specifies that number of levels of hierarchical scheduling that will be used.

This is a count of the tm_node stages and does not include tm_queues or tm_egress objects. The default value is 0.

Examples: odp_traffic_mgmt.c.

Definition at line 645 of file api/spec/traffic_mngr.h.

◆ tm_queue_dual_slope_needed

odp_bool_t odp_tm_requirements_t::tm_queue_dual_slope_needed

tm_queue_dual_slope_needed indicates that the tm_queues are expected to use the dual slope WRED capability.

This field is ignored if tm_queue_wred_needed above is false.

Definition at line 658 of file api/spec/traffic_mngr.h.

◆ vlan_marking_needed

odp_bool_t odp_tm_requirements_t::vlan_marking_needed

vlan_marking_needed indicates that the ODP application expects to use some form of VLAN egress marking using the odp_tm_vlan_marking() function.

See also comments for vlan_marking_supported.

Definition at line 668 of file api/spec/traffic_mngr.h.

◆ ecn_marking_needed

odp_bool_t odp_tm_requirements_t::ecn_marking_needed

ecn_marking_needed indicates that the ODP application expects to use some form of IPv4 TOS or IPv6 TC field egress marking by using the odp_tm_ecn_marking() function.

See also comments for ecn_marking_supported.

Definition at line 674 of file api/spec/traffic_mngr.h.

◆ drop_prec_marking_needed

odp_bool_t odp_tm_requirements_t::drop_prec_marking_needed

drop_prec_marking_needed indicates that the ODP application expects to use some form of IPv4 TOS or IPv6 TC field egress marking by using the odp_tm_drop_prec_marking() function.

See also comments for drop_prec_marking_supported.

Definition at line 680 of file api/spec/traffic_mngr.h.

◆ marking_colors_needed

odp_bool_t odp_tm_requirements_t::marking_colors_needed[ODP_NUM_PACKET_COLORS]

The marking_colors_needed array is used to indicate which colors are expected to be used for marking.

A value of FALSE means that the application will not enable this color for vlan marking, ecn marking nor drop precedence marking. A value of TRUE means that the application expects to use this color in conjunction with one or more of the marking APIs.

Definition at line 688 of file api/spec/traffic_mngr.h.

◆ pkt_prio_mode

odp_tm_pkt_prio_mode_t odp_tm_requirements_t::pkt_prio_mode

Packet priority mode.

TM capabilities indicate which modes are supported. The default value is ODP_TM_PKT_PRIO_MODE_PRESERVE.

Definition at line 694 of file api/spec/traffic_mngr.h.

The documentation for this struct was generated from the following file:

api/spec/traffic_mngr.h

Data Fields