AM62D FreeRTOS SDK  11.02.00
tisci_core.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017-2025 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  */
54 #ifndef MESSAGES_CORE_H
55 #define MESSAGES_CORE_H
56 
57 #ifdef __cplusplus
58 extern "C"
59 {
60 #endif
61 
62 
63 
65 #define TISCI_MSG_FLAG_FW_CAP_GENERIC_CAP TISCI_BIT(0)
66 #define TISCI_MSG_FLAG_FW_CAP_LPM_DEEP_SLEEP TISCI_BIT(1)
67 #define TISCI_MSG_FLAG_FW_CAP_LPM_MCU_ONLY TISCI_BIT(2)
68 #define TISCI_MSG_FLAG_FW_CAP_LPM_STANDBY TISCI_BIT(3)
69 #define TISCI_MSG_FLAG_FW_CAP_LPM_PARTIAL_IO_ON TISCI_BIT(4)
70 #define TISCI_MSG_FLAG_FW_CAP_LPM_DM_MANAGED TISCI_BIT(5)
71 #define TISCI_MSG_FLAG_FW_CAP_LPM_IO_ONLY_PLUS_DDR TISCI_BIT(6)
72 #define TISCI_MSG_FLAG_FW_CAP_IO_ISOLATION TISCI_BIT(7)
73 #define TISCI_MSG_FLAG_FW_CAP_DM TISCI_BIT(8)
74 #define TISCI_MSG_FLAG_FW_CAP_LPM_ABORT TISCI_BIT(9)
75 #define TISCI_MSG_FLAG_FW_CAP_CLOCK_SSC TISCI_BIT(10)
76 #define TISCI_MSG_FLAG_FW_CAP_LPM_ENCRYPT_IMAGE TISCI_BIT(11)
77 #define TISCI_MSG_FLAG_FW_CAP_LPM_BOARDCFG_MANAGED TISCI_BIT(12)
78 
88  struct tisci_header hdr;
89 } __attribute__((__packed__));
90 
103  struct tisci_header hdr;
104  char str[32];
105  uint16_t version;
106  uint8_t abi_major;
107  uint8_t abi_minor;
108  uint8_t sub_version;
109  uint8_t patch_version;
110 } __attribute__((__packed__));
111 
121  struct tisci_header hdr;
122 } __attribute__((__packed__));
123 
137  struct tisci_header hdr;
138  uint16_t version;
139  uint8_t sub_version;
140  uint8_t patch_version;
141  uint8_t abi_major;
142  uint8_t abi_minor;
145 } __attribute__((__packed__));
146 
154  struct tisci_header hdr;
155  uint32_t extboot_status;
156 } __attribute__((__packed__));
157 
167  struct tisci_header hdr;
168 } __attribute__((__packed__));
169 
183  struct tisci_header hdr;
188 } __attribute__((__packed__));
189 
199  struct tisci_header hdr;
200 } __attribute__((__packed__));
201 
211  struct tisci_header hdr;
212 } __attribute__((__packed__));
213 
226  struct tisci_header hdr;
231 } __attribute__((__packed__));
232 
242  struct tisci_header hdr;
243 } __attribute__((__packed__));
244 
259  struct tisci_header hdr;
264 } __attribute__((__packed__));
265 
275  struct tisci_header hdr;
276 } __attribute__((__packed__));
277 
292  struct tisci_header hdr;
297 } __attribute__((__packed__));
298 
308  struct tisci_header hdr;
309 } __attribute__((__packed__));
310 
311 
322  struct tisci_header hdr;
323 } __attribute__((__packed__));
324 
338  struct tisci_header hdr;
339  uint32_t msmc_start_low;
340  uint32_t msmc_start_high;
341  uint32_t msmc_end_low;
342  uint32_t msmc_end_high;
343 } __attribute__((__packed__));
344 
355  struct tisci_header hdr;
356 } __attribute__((__packed__));
357 
367  struct tisci_header hdr;
370 } __attribute__((__packed__));
371 
381  struct tisci_header hdr;
382 } __attribute__((__packed__));
383 
393  struct tisci_header hdr;
394  uint64_t fw_caps;
395 } __attribute__((__packed__));
396 
397 
398 #ifdef __cplusplus
399 }
400 #endif
401 
402 #endif /* MESSAGES_CORE_H */
403 
tisci_query_msmc_resp
TISCI_MSG_QUERY_MSMC request response providing currently available MSMC memory if present in the SoC...
Definition: tisci_core.h:337
tisci_msg_board_config_pm_resp
Empty response for TISCI_MSG_BOARD_CONFIG_PM.
Definition: tisci_core.h:307
tisci_msg_version_resp
TISCI_MSG_VERSION request to provide version info about currently running firmware.
Definition: tisci_core.h:102
tisci_get_trace_config_req
TISCI_MSG_GET_TRACE_CONFIG request to get the debug trace config from base board config.
Definition: tisci_core.h:354
tisci_msg_board_config_rm_req::tisci_boardcfg_rmp_high
uint32_t tisci_boardcfg_rmp_high
Definition: tisci_core.h:185
tisci_msg_dm_version_resp
TISCI_MSG_DM_VERSION response struct to provide version info about currently running DM firmware.
Definition: tisci_core.h:136
tisci_msg_version_resp::abi_major
uint8_t abi_major
Definition: tisci_core.h:106
tisci_msg_dm_version_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:137
tisci_query_fw_caps_resp::fw_caps
uint64_t fw_caps
Definition: tisci_core.h:394
tisci_query_msmc_resp::msmc_end_low
uint32_t msmc_end_low
Definition: tisci_core.h:341
tisci_msg_board_config_pm_req::tisci_boardcfg_pmp_low
uint32_t tisci_boardcfg_pmp_low
Definition: tisci_core.h:293
tisci_query_msmc_req
TISCI_MSG_QUERY_MSMC request to provide currently available MSMC memory if present in the SoC.
Definition: tisci_core.h:321
tisci_query_msmc_resp::msmc_start_low
uint32_t msmc_start_low
Definition: tisci_core.h:339
tisci_msg_board_config_req::tisci_boardcfgp_high
uint32_t tisci_boardcfgp_high
Definition: tisci_core.h:228
tisci_msg_board_config_resasg_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:211
tisci_msg_boot_notification_req::extboot_status
uint32_t extboot_status
Definition: tisci_core.h:155
tisci_query_msmc_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:338
tisci_msg_board_config_resasg_resp
Empty response for TISCI_MSG_BOARD_CONFIG_RESASG.
Definition: tisci_core.h:210
tisci_msg_version_resp::abi_minor
uint8_t abi_minor
Definition: tisci_core.h:107
tisci_query_msmc_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:322
tisci_msg_version_resp::str
char str[32]
Definition: tisci_core.h:104
tisci_msg_version_resp::patch_version
uint8_t patch_version
Definition: tisci_core.h:109
tisci_msg_board_config_resp
Empty response for TISCI_MSG_BOARD_CONFIG.
Definition: tisci_core.h:241
tisci_msg_version_resp::version
uint16_t version
Definition: tisci_core.h:105
tisci_msg_board_config_rm_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:199
tisci_msg_board_config_security_req::tisci_boardcfg_security_size
uint16_t tisci_boardcfg_security_size
Definition: tisci_core.h:262
tisci_msg_board_config_req
TISCI_MSG_BOARD_CONFIG request to provide the location and size of the tisci_boardcfg structure.
Definition: tisci_core.h:225
tisci_msg_board_config_rm_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:183
tisci_msg_board_config_security_resp
Empty response for TISCI_MSG_BOARD_CONFIG_SECURITY.
Definition: tisci_core.h:274
tisci_header
Header that prefixes all TISCI messages.
Definition: tisci_protocol.h:94
tisci_query_fw_caps_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:393
tisci_msg_dm_version_resp::sub_version
uint8_t sub_version
Definition: tisci_core.h:139
tisci_msg_board_config_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:242
tisci_msg_board_config_req::tisci_boardcfg_size
uint16_t tisci_boardcfg_size
Definition: tisci_core.h:229
tisci_msg_boot_notification_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:167
tisci_msg_board_config_security_req::tisci_boardcfg_securityp_high
uint32_t tisci_boardcfg_securityp_high
Definition: tisci_core.h:261
tisci_msg_version_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:103
tisci_msg_boot_notification_req
Notification message to indicate the DMSC is available.
Definition: tisci_core.h:153
tisci_msg_dm_version_resp::patch_version
uint8_t patch_version
Definition: tisci_core.h:140
tisci_get_trace_config_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:367
tisci_msg_board_config_pm_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:308
tisci_msg_board_config_rm_req::tisci_boardcfg_rmp_low
uint32_t tisci_boardcfg_rmp_low
Definition: tisci_core.h:184
tisci_msg_board_config_pm_req::tisci_boardcfg_pmp_high
uint32_t tisci_boardcfg_pmp_high
Definition: tisci_core.h:294
tisci_msg_dm_version_resp::abi_minor
uint8_t abi_minor
Definition: tisci_core.h:142
tisci_msg_board_config_pm_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:292
devgrp_t
uint8_t devgrp_t
Defines the sysfw DEVGRP type. This is meant to be used in code or data structures that require disti...
Definition: sciclient.h:347
tisci_msg_board_config_rm_req::tisci_boardcfg_rm_devgrp
devgrp_t tisci_boardcfg_rm_devgrp
Definition: tisci_core.h:187
tisci_msg_board_config_pm_req::tisci_boardcfg_pm_devgrp
devgrp_t tisci_boardcfg_pm_devgrp
Definition: tisci_core.h:296
tisci_msg_dm_version_req
Notification message to get DM version.
Definition: tisci_core.h:120
tisci_msg_board_config_security_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:275
tisci_msg_board_config_rm_req
TISCI_MSG_BOARD_CONFIG_RM request to provide the location and size of the tisci_boardcfg Resource Man...
Definition: tisci_core.h:182
tisci_msg_board_config_rm_resp
Empty response for TISCI_MSG_BOARD_CONFIG_RM.
Definition: tisci_core.h:198
tisci_msg_version_req
Notification message to indicate the DMSC is available.
Definition: tisci_core.h:87
tisci_query_fw_caps_resp
TISCI_MSG_QUERY_FW_CAPS request response providing currently available SOC/firmware capabilities.
Definition: tisci_core.h:392
tisci_msg_board_config_security_req::tisci_boardcfg_securityp_low
uint32_t tisci_boardcfg_securityp_low
Definition: tisci_core.h:260
tisci_msg_boot_notification_resp
Response to notification message about firmware availability.
Definition: tisci_core.h:166
tisci_msg_board_config_rm_req::tisci_boardcfg_rm_size
uint16_t tisci_boardcfg_rm_size
Definition: tisci_core.h:186
tisci_msg_board_config_security_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:259
tisci_msg_board_config_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:226
tisci_query_msmc_resp::msmc_end_high
uint32_t msmc_end_high
Definition: tisci_core.h:342
tisci_msg_dm_version_resp::sciserver_version
char sciserver_version[26]
Definition: tisci_core.h:144
tisci_msg_dm_version_resp::abi_major
uint8_t abi_major
Definition: tisci_core.h:141
tisci_msg_board_config_req::tisci_boardcfgp_low
uint32_t tisci_boardcfgp_low
Definition: tisci_core.h:227
tisci_msg_dm_version_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:121
tisci_msg_board_config_pm_req::tisci_boardcfg_pm_size
uint16_t tisci_boardcfg_pm_size
Definition: tisci_core.h:295
tisci_msg_board_config_pm_req
TISCI_MSG_BOARD_CONFIG_PM request to provide the location and size of the tisci_boardcfg Power Manage...
Definition: tisci_core.h:291
tisci_msg_board_config_req::tisci_boardcfg_devgrp
devgrp_t tisci_boardcfg_devgrp
Definition: tisci_core.h:230
__attribute__
struct tisci_msg_version_req __attribute__((__packed__))
tisci_msg_version_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:88
tisci_get_trace_config_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:355
tisci_msg_board_config_security_req
TISCI_MSG_BOARD_CONFIG_SECURITY request to provide the location and size of the tisci_boardcfg securi...
Definition: tisci_core.h:258
tisci_msg_version_resp::sub_version
uint8_t sub_version
Definition: tisci_core.h:108
tisci_get_trace_config_resp::trace_dst_enables
uint16_t trace_dst_enables
Definition: tisci_core.h:368
tisci_msg_board_config_security_req::tisci_boardcfg_security_devgrp
devgrp_t tisci_boardcfg_security_devgrp
Definition: tisci_core.h:263
tisci_query_fw_caps_req
TISCI_MSG_QUERY_FW_CAPS request to provide the firmware/SOC capabilities.
Definition: tisci_core.h:380
tisci_msg_boot_notification_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:154
tisci_get_trace_config_resp::trace_src_enables
uint16_t trace_src_enables
Definition: tisci_core.h:369
tisci_query_msmc_resp::msmc_start_high
uint32_t msmc_start_high
Definition: tisci_core.h:340
tisci_get_trace_config_resp
TISCI_MSG_GET_TRACE_CONFIG request response providing the debug config from base board config.
Definition: tisci_core.h:366
tisci_msg_dm_version_resp::version
uint16_t version
Definition: tisci_core.h:138
tisci_query_fw_caps_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:381
tisci_msg_dm_version_resp::rm_pm_hal_version
char rm_pm_hal_version[12]
Definition: tisci_core.h:143