AM62Ax MCU+ SDK  10.01.00
sciclient_fmwMsgParams.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022-24 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, SCICLIENT_PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 
48 #ifndef SCICLIENT_FMWMSGPARAMS_H_
49 #define SCICLIENT_FMWMSGPARAMS_H_
50 
51 /* ========================================================================== */
52 /* Include Files */
53 /* ========================================================================== */
54 
55 #include <stdint.h>
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 /* ========================================================================== */
62 /* Macros & Typedefs */
63 /* ========================================================================== */
64 
66 #define TISCI_PARAM_UNDEF (0xFFFFFFFFU)
67 
74 /* ABI Major revision - Major revision changes
75 * indicate backward compatibility breakage */
76 #define SCICLIENT_FIRMWARE_ABI_MAJOR (4U)
77 /* ABI Minor revision - Minor revision changes
78 * indicate backward compatibility is maintained,
79 * however, new messages OR extensions to existing
80 * messages might have been adde */
81 #define SCICLIENT_FIRMWARE_ABI_MINOR (0U)
82 
85 #define SCICLIENT_CONTEXT_C7X_NONSEC_0 (10U)
86 #define SCICLIENT_CONTEXT_C7X_SEC_0 (9U)
87 
88 #define SCICLIENT_C7X_NON_SECURE_INTERRUPT_NUM (9U)
89 #define SCICLIENT_C7X_SECURE_INTERRUPT_NUM (10U)
90 
97 #define SCICLIENT_CONTEXT_R5_SEC_0 (0U)
98 
99 #define SCICLIENT_CONTEXT_R5_NONSEC_0 (1U)
100 
101 #define SCICLIENT_CONTEXT_R5_SEC_1 (2U)
102 
103 #define SCICLIENT_CONTEXT_R5_NONSEC_1 (3U)
104 
105 #define SCICLIENT_CONTEXT_A53_SEC_0 (4U)
106 
107 #define SCICLIENT_CONTEXT_A53_SEC_1 (5U)
108 
109 #define SCICLIENT_CONTEXT_A53_NONSEC_1 (6U)
110 
111 #define SCICLIENT_CONTEXT_A53_NONSEC_2 (7U)
112 
113 #define SCICLIENT_CONTEXT_MCU_R5_0_NONSEC_0 (8U)
114 
115 #define SCICLIENT_CONTEXT_A53_NONSEC_3 (9U)
116 
117 #define SCICLIENT_CONTEXT_C7_NONSEC_0 (10U)
118 
119 #define SCICLIENT_CONTEXT_DM2TIFS (11U)
120 
122 #define SCICLIENT_CONTEXT_MAX_NUM (12U)
123 
135 #define SCICLIENT_PROC_ID_A53SS0_CORE_0 (0x20U)
136 
140 #define SCICLIENT_PROC_ID_A53SS0_CORE_1 (0x21U)
141 
145 #define SCICLIENT_PROC_ID_A53SS0_CORE_2 (0x22U)
146 
150 #define SCICLIENT_PROC_ID_A53SS0_CORE_3 (0x23U)
151 
155 #define SCICLIENT_PROC_ID_C7X256V0_C7XV_CORE_0 (0x04U)
156 
160 #define SCICLIENT_PROC_ID_MCU_R5FSS0_CORE0 (0x03U)
161 
165 #define SCICLIENT_PROC_ID_R5FSS0_CORE0 (0x01U)
166 
170 #define SCICLIENT_PROC_ID_HSM_M4FSS0_CORE0 (0x80U)
171 
175 #define SOC_NUM_SCICLIENT_PROCESSORS (0x08U)
176 
177 
181 #define TISCI_MSG_VALUE_RM_NULL_RING_TYPE (0xFFFFu)
182 #define TISCI_MSG_VALUE_RM_NULL_RING_INDEX (0xFFFFFFFFu)
183 #define TISCI_MSG_VALUE_RM_NULL_RING_ADDR (0xFFFFFFFFu)
184 #define TISCI_MSG_VALUE_RM_NULL_RING_COUNT (0xFFFFFFFFu)
185 
190 #define TISCI_MSG_VALUE_RM_NULL_RING_MODE (0xFFu)
191 #define TISCI_MSG_VALUE_RM_NULL_RING_SIZE (0xFFu)
192 #define TISCI_MSG_VALUE_RM_NULL_ORDER_ID (0xFFu)
193 #define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_TYPE (0xFFu)
194 #define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_INDEX (0xFFFFFFFFu)
195 
222 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE0 (TISCI_DEV_WKUP_R5FSS0_CORE0)
223 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE1 (TISCI_DEV_WKUP_R5FSS0_CORE0)
224 
229 #define TISCI_ISC_CC_ID (160U)
230 
231 
238 #define TISCI_RINGACC0_OES_IRQ_SRC_IDX_START (0U)
239 #define TISCI_RINGACC0_MON_IRQ_SRC_IDX_START (1024U)
240 #define TISCI_RINGACC0_EOES_IRQ_SRC_IDX_START (2048U)
241 #define TISCI_UDMAP0_TX_OES_IRQ_SRC_IDX_START (0U)
242 #define TISCI_UDMAP0_TX_EOES_IRQ_SRC_IDX_START (512U)
243 #define TISCI_UDMAP0_RX_OES_IRQ_SRC_IDX_START (1024U)
244 #define TISCI_UDMAP0_RX_EOES_IRQ_SRC_IDX_START (1280U)
245 #define TISCI_UDMAP0_RX_FLOW_EOES_IRQ_SRC_IDX_START (1536U)
246 #define TISCI_BCDMA0_BC_RC_OES_IRQ_SRC_IDX_START (9216U)
247 #define TISCI_BCDMA0_TX_RC_OES_IRQ_SRC_IDX_START (10752U)
248 #define TISCI_BCDMA0_RX_RC_OES_IRQ_SRC_IDX_START (12288U)
249 #define TISCI_BCDMA0_BC_DC_OES_IRQ_SRC_IDX_START (8704U)
250 #define TISCI_BCDMA0_TX_DC_OES_IRQ_SRC_IDX_START (10240U)
251 #define TISCI_BCDMA0_RX_DC_OES_IRQ_SRC_IDX_START (11776U)
252 #define TISCI_PKTDMA0_TX_FLOW_OES_IRQ_SRC_IDX_START (4608U)
253 #define TISCI_PKTDMA0_RX_FLOW_OES_IRQ_SRC_IDX_START (5632U)
254 
262 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE0_PROCID \
263  (SCICLIENT_PROC_ID_R5FSS0_CORE0)
264 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE1_PROCID \
265  (SCICLIENT_PROC_ID_R5FSS0_CORE0)
266 
269 #define SCICLIENT_ALLOWED_BOARDCFG_BASE_START 1U
270 
271 #define SCICLIENT_ALLOWED_BOARDCFG_BASE_END 0xFFFFFFFFU
272 
273 /* ========================================================================== */
274 /* Structure Declarations */
275 /* ========================================================================== */
276 
277 /* None */
278 
279 #ifdef __cplusplus
280 }
281 #endif
282 
283 #endif /* #ifndef SCICLIENT_FMWMSGPARAMS_H_ */
284 
tisci_clocks.h
tisci_devices.h