tisci_msg_rm_udmap_flow_cfg_req Struct Reference

Detailed Description

Configures a Navigator Subsystem UDMAP receive flow.

Configures a Navigator Subsystem UDMAP receive flow's registers. Configuration does not include the flow registers which handle size-based free descriptor queue routing. The tisci_msg_rm_udmap_flow_size_thresh_cfg_req message is used to configure register fields related to size based free descriptor queues.

The flow index must be assigned to the host defined in the TISCI header via the RM board configuration resource assignment range list.

It's the user's responsibility to make sure any receive channels using the flow are disabled when changing the receive flow configuration. Otherwise, unknown operation may occur.

Parameters

hdr	Standard TISCI header
valid_params	Bitfield defining validity of rx flow configuration parameters. The rx flow configuration fields are not valid, and will not be used for flow configuration, if their corresponding valid bit is zero. Valid bit usage: 0 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_einfo_present 1 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_psinfo_present 2 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_error_handling 3 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_desc_type 4 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_sop_offset 5 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_dest_qnum 6 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_hi 7 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_lo 8 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_hi 9 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_lo 10 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_hi_sel 11 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_lo_sel 12 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_hi_sel 13 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_lo_sel 14 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_fdq0_sz0_qnum 15 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_fdq1_qnum 16 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_fdq2_qnum 17 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_fdq3_qnum 18 - Valid bit for tisci_msg_rm_udmap_flow_cfg_req::rx_ps_location
nav_id	SoC device ID of Navigator Subsystem from which the receive flow is allocated
flow_index	UDMAP receive flow index for non-optional configuration.
rx_einfo_present	UDMAP receive flow extended packet info present configuration to be programmed into the rx_einfo_present field of the flow's RFLOW_RFA register. Can be set to: TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_EINFO_NOT_PRESENT TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_EINFO_PRESENT

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_EINFO_PRESENT_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_psinfo_present

UDMAP receive flow PS words present configuration to be programmed into the rx_psinfo_present field of the flow's RFLOW_RFA register. Can be set to: TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_PSINFO_NOT_PRESENT TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_PSINFO_PRESENT

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_PSINFO_PRESENT_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_error_handling

UDMAP receive flow error handling configuration to be programmed into the rx_error_handling field of the flow's RFLOW_RFA register. Can be set to: TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_ERR_DROP TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_ERR_RETRY

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_ERROR_HANDLING_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_desc_type

UDMAP receive flow descriptor type configuration to be programmed into the rx_desc_type field field of the flow's RFLOW_RFA register. Can be set to TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DESC_HOST TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DESC_MONO

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_DESC_TYPE_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_sop_offset

UDMAP receive flow start of packet offset configuration to be programmed into the rx_sop_offset field of the RFLOW_RFA register. See the UDMAP section of the TRM for more information on this setting. Valid values for this field are 0-255 bytes. The allocation request will be NACK'd if specified offset is greater than TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SOP_MAX.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_SOP_OFFSET_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_dest_qnum

UDMAP receive flow destination queue configuration to be programmed into the rx_dest_qnum field of the flow's RFLOW_RFA register. The specified destination queue must be valid within the Navigator Subsystem and must be owned by the host, or a subordinate of the host, requesting allocation and configuration of the receive flow.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_DEST_QNUM_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_src_tag_hi

UDMAP receive flow source tag high byte constant configuration to be programmed into the rx_src_tag_hi field of the flow's RFLOW_RFB register. See the UDMAP section of the TRM for more information on this setting.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_SRC_TAG_HI_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_src_tag_lo

UDMAP receive flow source tag low byte constant configuration to be programmed into the rx_src_tag_lo field of the flow's RFLOW_RFB register. See the UDMAP section of the TRM for more information on this setting.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_SRC_TAG_LO_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_dest_tag_hi

UDMAP receive flow destination tag high byte constant configuration to be programmed into the rx_dest_tag_hi field of the flow's RFLOW_RFB register. See the UDMAP section of the TRM for more information on this setting.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_DEST_TAG_HI_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_dest_tag_lo

UDMAP receive flow destination tag low byte constant configuration to be programmed into the rx_dest_tag_lo field of the flow's RFLOW_RFB register. See the UDMAP section of the TRM for more information on this setting.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_DEST_TAG_LO_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_src_tag_hi_sel

UDMAP receive flow source tag high byte selector configuration to be programmed into the rx_src_tag_hi_sel field of the RFLOW_RFC register. See the UDMAP section of the TRM for more information on this setting. Can be set to TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_NONE TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_CFG_TAG TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_FLOW_ID TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_SRC_TAG

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_SRC_TAG_HI_SEL_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_src_tag_lo_sel

UDMAP receive flow source tag low byte selector configuration to be programmed into the rx_src_tag_lo_sel field of the RFLOW_RFC register. See the UDMAP section of the TRM for more information on this setting. Can be set to TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_NONE TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_CFG_TAG TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_FLOW_ID TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_SRC_SELECT_SRC_TAG

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_SRC_TAG_LO_SEL_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_dest_tag_hi_sel

UDMAP receive flow destination tag high byte selector configuration to be programmed into the rx_dest_tag_hi_sel field of the RFLOW_RFC register. See the UDMAP section of the TRM for more information on this setting. Can be set to TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_NONE TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_CFG_TAG TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_FLOW_ID TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_DEST_TAG_LO TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_DEST_TAG_HI

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_DEST_TAG_HI_SEL_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_dest_tag_lo_sel

UDMAP receive flow destination tag low byte selector configuration to be programmed into the rx_dest_tag_lo_sel field of the RFLOW_RFC register. See the UDMAP section of the TRM for more information on this setting. Can be set to TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_NONE TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_CFG_TAG TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_FLOW_ID TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_DEST_TAG_LO TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_DEST_SELECT_DEST_TAG_HI

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_DEST_TAG_LO_SEL_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_fdq0_sz0_qnum

UDMAP receive flow free descriptor queue 0 configuration to be programmed into the rx_fdq0_sz0_qnum field of the flow's RFLOW_RFD register. See the UDMAP section of the TRM for more information on this setting. The specified free queue must be valid within the Navigator Subsystem and must be owned by the host, or a subordinate of the host, requesting allocation and configuration of the receive flow.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_FDQ0_SZ0_QNUM_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_fdq1_qnum

UDMAP receive flow free descriptor queue 1 configuration to be programmed into the rx_fdq1_qnum field of the flow's RFLOW_RFD register. See the UDMAP section of the TRM for more information on this setting. The specified free queue must be valid within the Navigator Subsystem and must be owned by the host, or a subordinate of the host, requesting allocation and configuration of the receive flow.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_FDQ1_QNUM_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_fdq2_qnum

UDMAP receive flow free descriptor queue 2 configuration to be programmed into the rx_fdq2_qnum field of the flow's RFLOW_RFE register. See the UDMAP section of the TRM for more information on this setting. The specified free queue must be valid within the Navigator Subsystem and must be owned by the host, or a subordinate of the host, requesting allocation and configuration of the receive flow.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_FDQ2_QNUM_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_fdq3_qnum

UDMAP receive flow free descriptor queue 3 configuration to be programmed into the rx_fdq3_qnum field of the flow's RFLOW_RFE register. See the UDMAP section of the TRM for more information on this setting. The specified free queue must be valid within the Navigator Subsystem and must be owned by the host, or a subordinate of the host, requesting allocation and configuration of the receive flow.

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_FDQ3_QNUM_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Parameters

rx_ps_location

UDMAP receive flow PS words location configuration to be programmed into the rx_ps_location field of the flow's RFLOW_RFA register. Can be set to: TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_PS_END_PD TISCI_MSG_VALUE_RM_UDMAP_RX_FLOW_PS_BEGIN_DB

This field is only valid if TISCI_MSG_VALUE_RM_UDMAP_FLOW_PS_LOCATION_VALID is set in tisci_msg_rm_udmap_flow_cfg_req::valid_params.

Data Fields
struct tisci_header	hdr
uint32_t	valid_params
uint16_t	nav_id
uint16_t	flow_index
uint8_t	rx_einfo_present
uint8_t	rx_psinfo_present
uint8_t	rx_error_handling
uint8_t	rx_desc_type
uint16_t	rx_sop_offset
uint16_t	rx_dest_qnum
uint8_t	rx_src_tag_hi
uint8_t	rx_src_tag_lo
uint8_t	rx_dest_tag_hi
uint8_t	rx_dest_tag_lo
uint8_t	rx_src_tag_hi_sel
uint8_t	rx_src_tag_lo_sel
uint8_t	rx_dest_tag_hi_sel
uint8_t	rx_dest_tag_lo_sel
uint16_t	rx_fdq0_sz0_qnum
uint16_t	rx_fdq1_qnum
uint16_t	rx_fdq2_qnum
uint16_t	rx_fdq3_qnum
uint8_t	rx_ps_location

Field Documentation

hdr

struct tisci_header tisci_msg_rm_udmap_flow_cfg_req::hdr

valid_params

uint32_t tisci_msg_rm_udmap_flow_cfg_req::valid_params

nav_id

uint16_t tisci_msg_rm_udmap_flow_cfg_req::nav_id

flow_index

uint16_t tisci_msg_rm_udmap_flow_cfg_req::flow_index

rx_einfo_present

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_einfo_present

rx_psinfo_present

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_psinfo_present

rx_error_handling

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_error_handling

rx_desc_type

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_desc_type

rx_sop_offset

uint16_t tisci_msg_rm_udmap_flow_cfg_req::rx_sop_offset

rx_dest_qnum

uint16_t tisci_msg_rm_udmap_flow_cfg_req::rx_dest_qnum

rx_src_tag_hi

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_hi

rx_src_tag_lo

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_lo

rx_dest_tag_hi

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_hi

rx_dest_tag_lo

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_lo

rx_src_tag_hi_sel

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_hi_sel

rx_src_tag_lo_sel

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_lo_sel

rx_dest_tag_hi_sel

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_hi_sel

rx_dest_tag_lo_sel

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_lo_sel

rx_fdq0_sz0_qnum

uint16_t tisci_msg_rm_udmap_flow_cfg_req::rx_fdq0_sz0_qnum

rx_fdq1_qnum

uint16_t tisci_msg_rm_udmap_flow_cfg_req::rx_fdq1_qnum

rx_fdq2_qnum

uint16_t tisci_msg_rm_udmap_flow_cfg_req::rx_fdq2_qnum

rx_fdq3_qnum

uint16_t tisci_msg_rm_udmap_flow_cfg_req::rx_fdq3_qnum

rx_ps_location

uint8_t tisci_msg_rm_udmap_flow_cfg_req::rx_ps_location