AM62x MCU+ SDK  12.00.00
sciclient_fmwMsgParams.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022-26 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, 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 
91 #define SCICLIENT_CONTEXT_R5_SEC_0 (0U)
92 
93 #define SCICLIENT_CONTEXT_R5_NONSEC_0 (1U)
94 
95 #define SCICLIENT_CONTEXT_R5_SEC_1 (2U)
96 
97 #define SCICLIENT_CONTEXT_R5_NONSEC_1 (3U)
98 
99 #define SCICLIENT_CONTEXT_A53_SEC_0 (4U)
100 
101 #define SCICLIENT_CONTEXT_A53_SEC_1 (5U)
102 
103 #define SCICLIENT_CONTEXT_A53_NONSEC_0 (6U)
104 
105 #define SCICLIENT_CONTEXT_A53_NONSEC_1 (7U)
106 
107 #define SCICLIENT_CONTEXT_M4_NONSEC_0 (8U)
108 
109 #define SCICLIENT_CONTEXT_GPU_NONSEC_0 (9U)
110 
111 #define SCICLIENT_CONTEXT_A53_NONSEC_2 (10U)
112 
117 #define SCICLIENT_CONTEXT_DM2TIFS (11U)
118 
120 #define SCICLIENT_CONTEXT_MAX_NUM (12U)
121 
131 #define SCICLIENT_PROC_ID_A53SS0_CORE_0 (0x20U)
132 
133 #define SCICLIENT_PROC_ID_A53SS0_CORE_1 (0x21U)
134 
135 #define SCICLIENT_PROC_ID_A53SS0_CORE_2 (0x22U)
136 
137 #define SCICLIENT_PROC_ID_A53SS0_CORE_3 (0x23U)
138 
139 #define SCICLIENT_PROC_ID_R5FSS0_CORE0 (0x01U)
140 /*** AM62_MAIN_SEC_MMR_MAIN_0: (Cluster 16 Processor 0) */
141 #define SCICLIENT_PROC_ID_MCU_M4FSS0_CORE0 (0x18U)
142 /*** AM62A_HSM_SEC_MMR_0: (Cluster 28 Processor 0) */
143 #define SCICLIENT_PROC_ID_HSM_M4FSS0_CORE0 (0x80U)
144 
146 #define SOC_NUM_SCICLIENT_PROCESSORS (0x07U)
147 
148 
149 
153 #define TISCI_MSG_VALUE_RM_NULL_RING_TYPE (0xFFFFu)
154 #define TISCI_MSG_VALUE_RM_NULL_RING_INDEX (0xFFFFFFFFu)
155 #define TISCI_MSG_VALUE_RM_NULL_RING_ADDR (0xFFFFFFFFu)
156 #define TISCI_MSG_VALUE_RM_NULL_RING_COUNT (0xFFFFFFFFu)
157 
162 #define TISCI_MSG_VALUE_RM_NULL_RING_MODE (0xFFu)
163 #define TISCI_MSG_VALUE_RM_NULL_RING_SIZE (0xFFu)
164 #define TISCI_MSG_VALUE_RM_NULL_ORDER_ID (0xFFu)
165 #define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_TYPE (0xFFu)
166 #define TISCI_MSG_VALUE_RM_UDMAP_NULL_CH_INDEX (0xFFFFFFFFu)
167 
194 #define TISCI_RINGACC0_OES_IRQ_SRC_IDX_START (20U)
195 #define TISCI_RINGACC0_EOES_IRQ_SRC_IDX_START (32U)
196 #define TISCI_TIMERMGR_OES_IRQ_SRC_IDX_START (0U)
197 #define TISCI_PKTDMA0_TX_EOES_IRQ_SRC_IDX_START (4096U)
198 #define TISCI_PKTDMA0_TX_FLOW_OES_IRQ_SRC_IDX_START (4608U)
199 #define TISCI_PKTDMA0_RX_EOES_IRQ_SRC_IDX_START (5120U)
200 #define TISCI_PKTDMA0_RX_FLOW_OES_IRQ_SRC_IDX_START (5632U)
201 #define TISCI_PKTDMA0_RX_FLOW_SOES_IRQ_SRC_IDX_START (6144U)
202 #define TISCI_PKTDMA0_RX_FLOW_FOES_IRQ_SRC_IDX_START (6656U)
203 #define TISCI_BCDMA0_BC_EOES_IRQ_SRC_IDX_START (8192U)
204 #define TISCI_BCDMA0_BC_DC_OES_IRQ_SRC_IDX_START (8704U)
205 #define TISCI_BCDMA0_BC_RC_OES_IRQ_SRC_IDX_START (9216U)
206 #define TISCI_BCDMA0_TX_EOES_IRQ_SRC_IDX_START (9728U)
207 #define TISCI_BCDMA0_TX_DC_OES_IRQ_SRC_IDX_START (10240U)
208 #define TISCI_BCDMA0_TX_RC_OES_IRQ_SRC_IDX_START (10752U)
209 #define TISCI_BCDMA0_RX_EOES_IRQ_SRC_IDX_START (11264U)
210 #define TISCI_BCDMA0_RX_DC_OES_IRQ_SRC_IDX_START (11776U)
211 #define TISCI_BCDMA0_RX_RC_OES_IRQ_SRC_IDX_START (12288U)
212 
221 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE0 (TISCI_DEV_WKUP_R5FSS0_CORE0)
222 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE1 (TISCI_DEV_WKUP_R5FSS0_CORE0)
223 
231 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE0_PROCID \
232  (SCICLIENT_PROC_ID_R5FSS0_CORE0)
233 #define SCICLIENT_DEV_WKUP_R5FSS0_CORE1_PROCID \
234  (SCICLIENT_PROC_ID_R5FSS0_CORE0)
235 
238 #define SCICLIENT_ALLOWED_BOARDCFG_BASE_START 1U
239 
240 #define SCICLIENT_ALLOWED_BOARDCFG_BASE_END 0xFFFFFFFFU
241 
242 /* ========================================================================== */
243 /* Structure Declarations */
244 /* ========================================================================== */
245 
246 /* None */
247 
248 #ifdef __cplusplus
249 }
250 #endif
251 
252 #endif /* #ifndef SCICLIENT_FMWMSGPARAMS_H_ */
253 
tisci_clocks.h
tisci_devices.h