TIOVX User Guide

Command object descriptor. More...

#include <tivx_obj_desc_priv.h>

Data Fields

tivx_obj_desc_t base
 base object descriptor
 
volatile uint64_t ack_event_handle
 Handle of ACK event that is posted when ACK is received MUST be valid if flags TIVX_CMD_FLAG_SEND_ACK is set.
 
volatile uint32_t cmd_id
 command to execute
 
volatile uint16_t cmd_params_desc_id [TIVX_KERNEL_MAX_PARAMS]
 parameter object descriptors
 
volatile uint32_t num_cmd_params
 valid values in cmd_params_data_id
 
volatile uint32_t node_cmd_id
 Node command to execute.
 
volatile int32_t replicated_node_idx
 Id of the node, to which node_cmd_id to be sent, If set to TIVX_CONTROL_CMD_SEND_TO_ALL_REPLICATED_NODES, cmd is send to all replicated node Otherwise to specific node.
 
volatile uint32_t flags
 flags associated with this command, see TIVX_CMD_FLAG_xxx
 
volatile uint32_t dst_target_id
 
volatile uint32_t src_target_id
 
volatile uint32_t num_obj_desc
 Number of object descriptor parameters with this command.
 
volatile uint16_t obj_desc_id [TIVX_CMD_MAX_OBJ_DESCS]
 object descriptor ID's of parameters
 
volatile uint32_t cmd_status
 command execution status
 
volatile uint32_t timestamp_h
 time at which this command is sent
 
volatile uint32_t timestamp_l
 time at which this command is sent
 

Detailed Description

Command object descriptor.

Definition at line 153 of file tivx_obj_desc_priv.h.

Field Documentation

◆ dst_target_id

volatile uint32_t tivx_obj_desc_cmd_t::dst_target_id

target for which this command is directed

Definition at line 184 of file tivx_obj_desc_priv.h.

◆ src_target_id

volatile uint32_t tivx_obj_desc_cmd_t::src_target_id

source target ID to which ACK should be sent if ACK flag is not set then this field is not used and can be set to TIVX_TARGET_ID_INVALID

Definition at line 190 of file tivx_obj_desc_priv.h.


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