PDK API Guide for J721E
sciclient_fmwMsgParams.h File Reference

Introduction

This file contains the definition of all the parameter IDs for PM, RM, Security.

Go to the source code of this file.

Macros

#define TISCI_PARAM_UNDEF   (0xFFFFFFFFU)
 
#define TISCI_MSG_VALUE_RM_NULL_RING_TYPE   (0xFFFFu)
 
#define TISCI_MSG_VALUE_RM_NULL_RING_INDEX   (0xFFFFFFFFu)
 
#define TISCI_MSG_VALUE_RM_NULL_RING_ADDR   (0xFFFFFFFFu)
 
#define TISCI_MSG_VALUE_RM_NULL_RING_COUNT   (0xFFFFFFFFu)
 
#define TISCI_MSG_VALUE_RM_NULL_RING_MODE   (0xFFu)
 
#define TISCI_MSG_VALUE_RM_NULL_RING_SIZE   (0xFFu)
 
#define TISCI_MSG_VALUE_RM_NULL_ORDER_ID   (0xFFu)
 
#define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_TYPE   (0xFFu)
 
#define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_INDEX   (0xFFFFFFFFu)
 
#define TISCI_ISC_CC_ID   (160U)
 Special ISC ID to refer to compute cluster privid registers. More...
 
#define SCICLIENT_C7X_NON_SECURE_INTERRUPT_NUM   (9U)
 
#define SCICLIENT_C7X_SECURE_INTERRUPT_NUM   (10U)
 
#define SCICLIENT_ALLOWED_BOARDCFG_BASE_START   (CSL_MCU_MSRAM_1MB0_RAM_BASE)
 
#define SCICLIENT_ALLOWED_BOARDCFG_BASE_END   (CSL_MCU_MSRAM_1MB0_RAM_BASE + CSL_MCU_MSRAM_1MB0_RAM_SIZE)
 
Sciclient Firmware ABI revisions

ABI revisions for compatibility check.

#define SCICLIENT_FIRMWARE_ABI_MAJOR   (3U)
 
#define SCICLIENT_FIRMWARE_ABI_MINOR   (1U)
 
Sciclient Context Ids

Context IDs for Sciclient_ConfigPrms_t .

#define SCICLIENT_CONTEXT_R5_NONSEC_0   (0U)
 
#define SCICLIENT_CONTEXT_R5_SEC_0   (1U)
 
#define SCICLIENT_CONTEXT_R5_NONSEC_1   (2U)
 
#define SCICLIENT_CONTEXT_R5_SEC_1   (3U)
 
#define SCICLIENT_CONTEXT_A72_SEC_0   (4U)
 
#define SCICLIENT_CONTEXT_A72_SEC_1   (5U)
 
#define SCICLIENT_CONTEXT_A72_NONSEC_0   (6U)
 
#define SCICLIENT_CONTEXT_A72_NONSEC_1   (7U)
 
#define SCICLIENT_CONTEXT_A72_NONSEC_2   (8U)
 
#define SCICLIENT_CONTEXT_C7X_SEC_0   (9U)
 
#define SCICLIENT_CONTEXT_C7X_NONSEC_0   (10U)
 
#define SCICLIENT_CONTEXT_C6X_0_SEC_0   (11U)
 
#define SCICLIENT_CONTEXT_C6X_0_NONSEC_0   (12U)
 
#define SCICLIENT_CONTEXT_C6X_1_SEC_0   (13U)
 
#define SCICLIENT_CONTEXT_C6X_1_NONSEC_0   (14U)
 
#define SCICLIENT_CONTEXT_GPU_NONSEC_0   (15U)
 
#define SCICLIENT_CONTEXT_MAIN_0_R5_NONSEC_0   (16U)
 
#define SCICLIENT_CONTEXT_MAIN_0_R5_SEC_0   (17U)
 
#define SCICLIENT_CONTEXT_MAIN_0_R5_NONSEC_1   (18U)
 
#define SCICLIENT_CONTEXT_MAIN_0_R5_SEC_1   (19U)
 
#define SCICLIENT_CONTEXT_MAX_NUM   (20U)
 
Sciclient Processor Ids

Processor IDs for the Processor Boot Configuration APIs.

#define SCICLIENT_PROC_ID_A72SS0_CORE0   (0x20U)
 
#define SCICLIENT_PROC_ID_A72SS0_CORE1   (0x21U)
 
#define SCICLIENT_PROC_ID_C71SS0   (0x30U)
 
#define SCICLIENT_PROC_ID_C66SS0_CORE0   (0x03U)
 
#define SCICLIENT_PROC_ID_C66SS1_CORE0   (0x04U)
 
#define SCICLIENT_PROC_ID_R5FSS0_CORE0   (0x06U)
 
#define SCICLIENT_PROC_ID_R5FSS0_CORE1   (0x07U)
 
#define SCICLIENT_PROC_ID_R5FSS1_CORE0   (0x08U)
 
#define SCICLIENT_PROC_ID_R5FSS1_CORE1   (0x09U)
 
#define SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0   (0x01U)
 
#define SCICLIENT_PROC_ID_MCU_R5FSS0_CORE1   (0x02U)
 
#define SCICLIENT_SOC_NUM_PROCESSORS   (0x0BU)
 
IRQ source index start

Start offset of IRQ source index.

#define TISCI_RINGACC0_OES_IRQ_SRC_IDX_START   (0U)
 
#define TISCI_RINGACC0_MON_IRQ_SRC_IDX_START   (1024U)
 
#define TISCI_RINGACC0_EOES_IRQ_SRC_IDX_START   (2048U)
 
#define TISCI_UDMAP0_TX_OES_IRQ_SRC_IDX_START   (0U)
 
#define TISCI_UDMAP0_TX_EOES_IRQ_SRC_IDX_START   (512U)
 
#define TISCI_UDMAP0_RX_OES_IRQ_SRC_IDX_START   (1024U)
 
#define TISCI_UDMAP0_RX_EOES_IRQ_SRC_IDX_START   (1280U)
 
#define TISCI_UDMAP0_RX_FLOW_EOES_IRQ_SRC_IDX_START   (1536U)
 
MCU Pulsar IDs

MCU Device CPU IDs.

#define SCICLIENT_DEV_MCU_R5FSS0_CORE0   (TISCI_DEV_MCU_R5FSS0_CORE0)
 
#define SCICLIENT_DEV_MCU_R5FSS0_CORE1   (TISCI_DEV_MCU_R5FSS0_CORE1)
 
MCU Pulsar Processor IDs

MCU Device Processor IDs.

#define SCICLIENT_DEV_MCU_R5FSS0_CORE0_PROCID   (SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0)
 
#define SCICLIENT_DEV_MCU_R5FSS0_CORE1_PROCID   (SCICLIENT_PROC_ID_MCU_R5FSS0_CORE1)
 

Macro Definition Documentation

◆ TISCI_PARAM_UNDEF

#define TISCI_PARAM_UNDEF   (0xFFFFFFFFU)

Undefined Param Undefined

◆ SCICLIENT_FIRMWARE_ABI_MAJOR

#define SCICLIENT_FIRMWARE_ABI_MAJOR   (3U)

◆ SCICLIENT_FIRMWARE_ABI_MINOR

#define SCICLIENT_FIRMWARE_ABI_MINOR   (1U)

◆ SCICLIENT_CONTEXT_R5_NONSEC_0

#define SCICLIENT_CONTEXT_R5_NONSEC_0   (0U)

R5_0(Non Secure): Cortex R5 context 0 on MCU island

◆ SCICLIENT_CONTEXT_R5_SEC_0

#define SCICLIENT_CONTEXT_R5_SEC_0   (1U)

R5_1(Secure): Cortex R5 context 1 on MCU island(Boot)

◆ SCICLIENT_CONTEXT_R5_NONSEC_1

#define SCICLIENT_CONTEXT_R5_NONSEC_1   (2U)

R5_2(Non Secure): Cortex R5 context 2 on MCU island

◆ SCICLIENT_CONTEXT_R5_SEC_1

#define SCICLIENT_CONTEXT_R5_SEC_1   (3U)

R5_3(Secure): Cortex R5 context 3 on MCU island

◆ SCICLIENT_CONTEXT_A72_SEC_0

#define SCICLIENT_CONTEXT_A72_SEC_0   (4U)

A72_0(Secure): Cortex A72 context 0 on Main island

◆ SCICLIENT_CONTEXT_A72_SEC_1

#define SCICLIENT_CONTEXT_A72_SEC_1   (5U)

A72_1(Secure): Cortex A72 context 1 on Main island

◆ SCICLIENT_CONTEXT_A72_NONSEC_0

#define SCICLIENT_CONTEXT_A72_NONSEC_0   (6U)

A72_2(Non Secure): Cortex A72 context 2 on Main island

◆ SCICLIENT_CONTEXT_A72_NONSEC_1

#define SCICLIENT_CONTEXT_A72_NONSEC_1   (7U)

A72_3(Non Secure): Cortex A72 context 3 on Main island

◆ SCICLIENT_CONTEXT_A72_NONSEC_2

#define SCICLIENT_CONTEXT_A72_NONSEC_2   (8U)

A72_4(Non Secure): Cortex A72 context 4 on Main island

◆ SCICLIENT_CONTEXT_C7X_SEC_0

#define SCICLIENT_CONTEXT_C7X_SEC_0   (9U)

C7X_0(Secure): C7x Context 0 on Main island

◆ SCICLIENT_CONTEXT_C7X_NONSEC_0

#define SCICLIENT_CONTEXT_C7X_NONSEC_0   (10U)

C7X_1(Non Secure): C7x context 1 on Main island

◆ SCICLIENT_CONTEXT_C6X_0_SEC_0

#define SCICLIENT_CONTEXT_C6X_0_SEC_0   (11U)

C6X_0_0(Secure): C6x_0 Context 0 on Main island

◆ SCICLIENT_CONTEXT_C6X_0_NONSEC_0

#define SCICLIENT_CONTEXT_C6X_0_NONSEC_0   (12U)

C6X_0_1(Non Secure): C6x_0 context 1 on Main island

◆ SCICLIENT_CONTEXT_C6X_1_SEC_0

#define SCICLIENT_CONTEXT_C6X_1_SEC_0   (13U)

C6X_1_0(Secure): C6x_1 Context 0 on Main island

◆ SCICLIENT_CONTEXT_C6X_1_NONSEC_0

#define SCICLIENT_CONTEXT_C6X_1_NONSEC_0   (14U)

C6X_1_1(Non Secure): C6x_1 context 1 on Main island

◆ SCICLIENT_CONTEXT_GPU_NONSEC_0

#define SCICLIENT_CONTEXT_GPU_NONSEC_0   (15U)

GPU_0(Non Secure): RGX context 0 on Main island

◆ SCICLIENT_CONTEXT_MAIN_0_R5_NONSEC_0

#define SCICLIENT_CONTEXT_MAIN_0_R5_NONSEC_0   (16U)

MAIN_0_R5_0(Non Secure): Cortex R5_0 context 0 on Main island

◆ SCICLIENT_CONTEXT_MAIN_0_R5_SEC_0

#define SCICLIENT_CONTEXT_MAIN_0_R5_SEC_0   (17U)

MAIN_0_R5_1(Secure): Cortex R5_0 context 1 on Main island

◆ SCICLIENT_CONTEXT_MAIN_0_R5_NONSEC_1

#define SCICLIENT_CONTEXT_MAIN_0_R5_NONSEC_1   (18U)

MAIN_0_R5_2(Non Secure): Cortex R5_0 context 2 on Main island

◆ SCICLIENT_CONTEXT_MAIN_0_R5_SEC_1

#define SCICLIENT_CONTEXT_MAIN_0_R5_SEC_1   (19U)

MAIN_0_R5_3(Secure): Cortex R5_0 context 3 on MCU island

◆ SCICLIENT_CONTEXT_MAX_NUM

#define SCICLIENT_CONTEXT_MAX_NUM   (20U)

MAIN_1_R5_0(Non Secure): Cortex R5_1 context 0 on Main island

◆ SCICLIENT_PROC_ID_A72SS0_CORE0

#define SCICLIENT_PROC_ID_A72SS0_CORE0   (0x20U)

COMPUTE_CLUSTER_J7ES_TB_VDC_MAIN_0: (Cluster 0 Processor 0)

◆ SCICLIENT_PROC_ID_A72SS0_CORE1

#define SCICLIENT_PROC_ID_A72SS0_CORE1   (0x21U)

COMPUTE_CLUSTER_J7ES_TB_VDC_MAIN_0: (Cluster 0 Processor 1)

◆ SCICLIENT_PROC_ID_C71SS0

#define SCICLIENT_PROC_ID_C71SS0   (0x30U)

COMPUTE_CLUSTER_J7ES_TB_VDC_MAIN_0: (Cluster 4 Processor 0)

◆ SCICLIENT_PROC_ID_C66SS0_CORE0

#define SCICLIENT_PROC_ID_C66SS0_CORE0   (0x03U)

J7_MAIN_SEC_MMR_MAIN_0: (Cluster 2 Processor 0)

◆ SCICLIENT_PROC_ID_C66SS1_CORE0

#define SCICLIENT_PROC_ID_C66SS1_CORE0   (0x04U)

J7_MAIN_SEC_MMR_MAIN_0: (Cluster 3 Processor 0)

◆ SCICLIENT_PROC_ID_R5FSS0_CORE0

#define SCICLIENT_PROC_ID_R5FSS0_CORE0   (0x06U)

J7_MAIN_SEC_MMR_MAIN_0: (Cluster 0 Processor 0)

◆ SCICLIENT_PROC_ID_R5FSS0_CORE1

#define SCICLIENT_PROC_ID_R5FSS0_CORE1   (0x07U)

J7_MAIN_SEC_MMR_MAIN_0: (Cluster 0 Processor 1)

◆ SCICLIENT_PROC_ID_R5FSS1_CORE0

#define SCICLIENT_PROC_ID_R5FSS1_CORE0   (0x08U)

J7_MAIN_SEC_MMR_MAIN_0: (Cluster 1 Processor 0)

◆ SCICLIENT_PROC_ID_R5FSS1_CORE1

#define SCICLIENT_PROC_ID_R5FSS1_CORE1   (0x09U)

J7_MAIN_SEC_MMR_MAIN_0: (Cluster 1 Processor 1)

◆ SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0

#define SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0   (0x01U)

J7_MCU_SEC_MMR_MCU_0: (Cluster 0 Processor 0)

◆ SCICLIENT_PROC_ID_MCU_R5FSS0_CORE1

#define SCICLIENT_PROC_ID_MCU_R5FSS0_CORE1   (0x02U)

J7_MCU_SEC_MMR_MCU_0: (Cluster 0 Processor 1)

◆ SCICLIENT_SOC_NUM_PROCESSORS

#define SCICLIENT_SOC_NUM_PROCESSORS   (0x0BU)

Total Number of processors in J721E

◆ TISCI_MSG_VALUE_RM_NULL_RING_TYPE

#define TISCI_MSG_VALUE_RM_NULL_RING_TYPE   (0xFFFFu)

-----------------— Resource Management Parameters ------------------— Null Ring type

◆ TISCI_MSG_VALUE_RM_NULL_RING_INDEX

#define TISCI_MSG_VALUE_RM_NULL_RING_INDEX   (0xFFFFFFFFu)

Null Ring Index

◆ TISCI_MSG_VALUE_RM_NULL_RING_ADDR

#define TISCI_MSG_VALUE_RM_NULL_RING_ADDR   (0xFFFFFFFFu)

The ring base address register fields are not be modified if this value is used for: tisci_msg_rm_ring_cfg_req::addr_lo tisci_msg_rm_ring_cfg_req::addr_hi

◆ TISCI_MSG_VALUE_RM_NULL_RING_COUNT

#define TISCI_MSG_VALUE_RM_NULL_RING_COUNT   (0xFFFFFFFFu)

The ring size field of the RING_SIZE register is not modified if this value is used for: tisci_msg_rm_ring_cfg_req::count

◆ TISCI_MSG_VALUE_RM_NULL_RING_MODE

#define TISCI_MSG_VALUE_RM_NULL_RING_MODE   (0xFFu)

The ring mode field of the RING_SIZE register is not modified if this value is used for: tisci_msg_rm_ring_cfg_req::mode

◆ TISCI_MSG_VALUE_RM_NULL_RING_SIZE

#define TISCI_MSG_VALUE_RM_NULL_RING_SIZE   (0xFFu)

The ring elsize field of the RING_SIZE register is not modified if this value is used for: tisci_msg_rm_ring_cfg_req::size

◆ TISCI_MSG_VALUE_RM_NULL_ORDER_ID

#define TISCI_MSG_VALUE_RM_NULL_ORDER_ID   (0xFFu)

Default value for tisci_msg_rm_ring_cfg_req::order_id. No changes to the order ID field of the ring will take place if this value is used.

◆ TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_TYPE

#define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_TYPE   (0xFFu)

Value specified for tisci_msg_rm_udmap_tx_ch_cfg_req::tx_chan_type and tisci_msg_rm_udmap_rx_ch_cfg_req::rx_chan_type when an explicit channel index is provided. DMSC RM will return a NACK if a non-NULL channel type is passed along with an explicit channel index.

◆ TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_INDEX

#define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_INDEX   (0xFFFFFFFFu)

Value specified for tisci_msg_rm_udmap_tx_ch_cfg_req::index and tisci_msg_rm_udmap_rx_ch_cfg_req::index when the user wants to request DMSC RM allocate an unused UDMAP channel. When specified for the channel index a valid channel type must be provided.

◆ TISCI_ISC_CC_ID

#define TISCI_ISC_CC_ID   (160U)

Special ISC ID to refer to compute cluster privid registers.

◆ TISCI_RINGACC0_OES_IRQ_SRC_IDX_START

#define TISCI_RINGACC0_OES_IRQ_SRC_IDX_START   (0U)

◆ TISCI_RINGACC0_MON_IRQ_SRC_IDX_START

#define TISCI_RINGACC0_MON_IRQ_SRC_IDX_START   (1024U)

◆ TISCI_RINGACC0_EOES_IRQ_SRC_IDX_START

#define TISCI_RINGACC0_EOES_IRQ_SRC_IDX_START   (2048U)

◆ TISCI_UDMAP0_TX_OES_IRQ_SRC_IDX_START

#define TISCI_UDMAP0_TX_OES_IRQ_SRC_IDX_START   (0U)

◆ TISCI_UDMAP0_TX_EOES_IRQ_SRC_IDX_START

#define TISCI_UDMAP0_TX_EOES_IRQ_SRC_IDX_START   (512U)

◆ TISCI_UDMAP0_RX_OES_IRQ_SRC_IDX_START

#define TISCI_UDMAP0_RX_OES_IRQ_SRC_IDX_START   (1024U)

◆ TISCI_UDMAP0_RX_EOES_IRQ_SRC_IDX_START

#define TISCI_UDMAP0_RX_EOES_IRQ_SRC_IDX_START   (1280U)

◆ TISCI_UDMAP0_RX_FLOW_EOES_IRQ_SRC_IDX_START

#define TISCI_UDMAP0_RX_FLOW_EOES_IRQ_SRC_IDX_START   (1536U)

◆ SCICLIENT_C7X_NON_SECURE_INTERRUPT_NUM

#define SCICLIENT_C7X_NON_SECURE_INTERRUPT_NUM   (9U)

◆ SCICLIENT_C7X_SECURE_INTERRUPT_NUM

#define SCICLIENT_C7X_SECURE_INTERRUPT_NUM   (10U)

◆ SCICLIENT_DEV_MCU_R5FSS0_CORE0

#define SCICLIENT_DEV_MCU_R5FSS0_CORE0   (TISCI_DEV_MCU_R5FSS0_CORE0)

◆ SCICLIENT_DEV_MCU_R5FSS0_CORE1

#define SCICLIENT_DEV_MCU_R5FSS0_CORE1   (TISCI_DEV_MCU_R5FSS0_CORE1)

◆ SCICLIENT_DEV_MCU_R5FSS0_CORE0_PROCID

#define SCICLIENT_DEV_MCU_R5FSS0_CORE0_PROCID   (SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0)

◆ SCICLIENT_DEV_MCU_R5FSS0_CORE1_PROCID

#define SCICLIENT_DEV_MCU_R5FSS0_CORE1_PROCID   (SCICLIENT_PROC_ID_MCU_R5FSS0_CORE1)

◆ SCICLIENT_ALLOWED_BOARDCFG_BASE_START

#define SCICLIENT_ALLOWED_BOARDCFG_BASE_START   (CSL_MCU_MSRAM_1MB0_RAM_BASE)

Board config Base start address

◆ SCICLIENT_ALLOWED_BOARDCFG_BASE_END

#define SCICLIENT_ALLOWED_BOARDCFG_BASE_END   (CSL_MCU_MSRAM_1MB0_RAM_BASE + CSL_MCU_MSRAM_1MB0_RAM_SIZE)

Board config Base end address