API Reference Manual  1.45.0
odp_tm_level_capabilities_t Struct Reference

Per Level Capabilities. More...

#include <traffic_mngr.h>

Data Fields

uint32_t max_num_tm_nodes
 max_num_tm_nodes specifies the maximum number of tm_nodes allowed at this level.
 
uint32_t max_fanin_per_node
 max_fanin_per_level specifies the maximum number of fan_in links to any given scheduler (whether weighted or using fair queueing or round robin) belonging to tm_nodes at this level.
 
uint8_t max_priority
 max_priority specifies the maximum number of strict priority levels used by any tm_node at this level. More...
 
uint32_t min_weight
 min_weight only has significance when the weights_supported field below is true, in which case it specifies the smallest value of the weights allowed at this level.
 
uint32_t max_weight
 max_weight only has significance when the weights_supported field below is true, in which case it specifies the largest value of the weights allowed at this level.
 
uint32_t min_burst_packets
 Minimum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is true.
 
uint32_t max_burst_packets
 Maximum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is true.
 
uint64_t min_rate_packets
 Minimum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is true.
 
uint64_t max_rate_packets
 Maximum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is true.
 
uint32_t min_burst
 Minimum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is false.
 
uint32_t max_burst
 Maximum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is false.
 
uint64_t min_rate
 Minimum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is false.
 
uint64_t max_rate
 Maximum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is false.
 
odp_bool_t tm_node_shaper_supported
 Shaper is supported in rate shape mode.
 
odp_bool_t tm_node_rate_limiter_supported
 Shaper is supported in rate limit mode.
 
odp_bool_t tm_node_shaper_packet_mode
 tm_node_shaper_packet_mode indicates that tm_nodes at this level support shaper in packet mode
 
odp_bool_t tm_node_wred_supported
 tm_node_wred_supported indicates that the tm_nodes at this level support some form of Random Early Detection.
 
odp_bool_t tm_node_dual_slope_supported
 tm_node_dual_slope_supported indicates that the tm_nodes at this level support the dual slope WRED capability. More...
 
odp_bool_t fair_queuing_supported
 fair_queuing_supported indicates that the tm_node schedulers at this level can implement WFQ or FQ scheduling disciplines (otherwise these schedulers can only implement WRR or RR algorithms.
 
odp_bool_t weights_supported
 weights_supported indicates that the tm_node schedulers at this level can have their different weights for their different fanins. More...
 
struct {
   uint8_t   byte: 1
 Threshold given as bytes.
 
   uint8_t   packet: 1
 Threshold given as packets.
 
   uint8_t   byte_and_packet: 1
 Threshold given as bytes and packets simultaneously.
 
tm_node_threshold
 TM node threshold profile support.
 

Detailed Description

Per Level Capabilities.

The odp_tm_level_capabilities_t record is used to describe the capabilities that might vary based upon the tm_node level. It is always used as part of the odp_tm_capabilities record.

Examples
odp_traffic_mgmt.c.

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

Field Documentation

◆ max_priority

uint8_t odp_tm_level_capabilities_t::max_priority

max_priority specifies the maximum number of strict priority levels used by any tm_node at this level.

Note that lower numeric values represent higher (more important or time critical) priorities.

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

◆ tm_node_dual_slope_supported

odp_bool_t odp_tm_level_capabilities_t::tm_node_dual_slope_supported

tm_node_dual_slope_supported indicates that the tm_nodes at this level support the dual slope WRED capability.

This field is ignored if tm_node_wred_supported above is false.

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

◆ weights_supported

odp_bool_t odp_tm_level_capabilities_t::weights_supported

weights_supported indicates that the tm_node schedulers at this level can have their different weights for their different fanins.

When true the min_weight and max_weight fields above specify the legal range of such weights.

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


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