tisci_msg_rm_ring_mon_cfg_req Struct Reference

Detailed Description

Configures a Navigator Subsystem ring monitor. Configures the real-time registers of a Navigator Subsystem ring monitor. The ring monitor index must be assigned to the host defined in the TISCI header via the RM board configuration resource assignment range list. The channelized firewalls covering the ring monitor registers are configured to allow the host read-only access.

Parameters

hdr	Standard TISCI header
valid_params	Bitfield defining validity of ring monitor configuration parameters. The ring monitor configuration fields are not valid, and will not be used for ring monitor configuration, if their corresponding valid bit is zero. Valid bit usage: 0 - Valid bit for tisci_msg_rm_ring_mon_cfg_req::source 1 - Valid bit for tisci_msg_rm_ring_mon_cfg_req::mode 2 - Valid bit for tisci_msg_rm_ring_mon_cfg_req::queue 3 - Valid bit for tisci_msg_rm_ring_mon_cfg_req::data0_val 4 - Valid bit for tisci_msg_rm_ring_mon_cfg_req::data1_val
nav_id	SoC device ID of Navigator Subsystem where ring monitor is located
index	Ring monitor index.
source	Monitor source selection programmed into RINGACC_CONTROL register. Can be set to: TISCI_MSG_VALUE_RM_MON_SRC_ELEM_CNT TISCI_MSG_VALUE_RM_MON_SRC_HEAD_PKT_SIZE TISCI_MSG_VALUE_RM_MON_SRC_ACCUM_Q_SIZE This field is only valid if TISCI_MSG_VALUE_RM_MON_SOURCE_VALID is set in tisci_msg_rm_ring_mon_cfg_req::valid_params.
mode	Monitor mode programmed into RINGACC_CONTROL register. Can be set to: TISCI_MSG_VALUE_RM_MON_MODE_DISABLED TISCI_MSG_VALUE_RM_MON_MODE_PUSH_POP TISCI_MSG_VALUE_RM_MON_MODE_THRESHOLD TISCI_MSG_VALUE_RM_MON_MODE_WATERMARK TISCI_MSG_VALUE_RM_MON_MODE_STARVATION This field is only valid if TISCI_MSG_VALUE_RM_MON_MODE_VALID is set in tisci_msg_rm_ring_mon_cfg_req::valid_params.
queue	Queue, or ring, to monitor programmed into RINGACC_QUEUE register. The specified queue must be assigned to the host, or a subordinate of the host, requesting the ring monitor configuration. This field is only valid if TISCI_MSG_VALUE_RM_MON_QUEUE_VALID is set in tisci_msg_rm_ring_mon_cfg_req::valid_params.
data0_val	Low threshold value programmed into RINGACC_DATA0 register when the ring monitor mode is configured to low/high threshold checking. Values specified in this field are ignored for other monitor modes. This field is only valid if TISCI_MSG_VALUE_RM_MON_DATA0_VAL_VALID is set in tisci_msg_rm_ring_mon_cfg_req::valid_params.
data1_val	High threshold value programmed into RINGACC_DATA1 register when the ring monitor mode is configured to low/high threshold checking. Values specified in this field are ignored for other monitor modes. This field is only valid if TISCI_MSG_VALUE_RM_MON_DATA1_VAL_VALID is set in tisci_msg_rm_ring_mon_cfg_req::valid_params.

Data Fields
struct tisci_header	hdr
uint32_t	valid_params
uint16_t	nav_id
uint16_t	index
uint8_t	source
uint8_t	mode
uint16_t	queue
uint32_t	data0_val
uint32_t	data1_val

Field Documentation

hdr

struct tisci_header tisci_msg_rm_ring_mon_cfg_req::hdr

valid_params

uint32_t tisci_msg_rm_ring_mon_cfg_req::valid_params

nav_id

uint16_t tisci_msg_rm_ring_mon_cfg_req::nav_id

index

uint16_t tisci_msg_rm_ring_mon_cfg_req::index

source

uint8_t tisci_msg_rm_ring_mon_cfg_req::source

mode

uint8_t tisci_msg_rm_ring_mon_cfg_req::mode

queue

uint16_t tisci_msg_rm_ring_mon_cfg_req::queue

data0_val

uint32_t tisci_msg_rm_ring_mon_cfg_req::data0_val

data1_val

uint32_t tisci_msg_rm_ring_mon_cfg_req::data1_val