AM64x MCU+ SDK  11.00.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 
84  struct tisci_header hdr;
85 } __attribute__((__packed__));
86 
99  struct tisci_header hdr;
100  char str[32];
101  uint16_t version;
102  uint8_t abi_major;
103  uint8_t abi_minor;
104  uint8_t sub_version;
105  uint8_t patch_version;
106 } __attribute__((__packed__));
107 
117  struct tisci_header hdr;
118 } __attribute__((__packed__));
119 
133  struct tisci_header hdr;
134  uint16_t version;
135  uint8_t sub_version;
136  uint8_t patch_version;
137  uint8_t abi_major;
138  uint8_t abi_minor;
141 } __attribute__((__packed__));
142 
150  struct tisci_header hdr;
151  uint32_t extboot_status;
152 } __attribute__((__packed__));
153 
163  struct tisci_header hdr;
164 } __attribute__((__packed__));
165 
179  struct tisci_header hdr;
184 } __attribute__((__packed__));
185 
195  struct tisci_header hdr;
196 } __attribute__((__packed__));
197 
207  struct tisci_header hdr;
208 } __attribute__((__packed__));
209 
222  struct tisci_header hdr;
227 } __attribute__((__packed__));
228 
238  struct tisci_header hdr;
239 } __attribute__((__packed__));
240 
255  struct tisci_header hdr;
260 } __attribute__((__packed__));
261 
271  struct tisci_header hdr;
272 } __attribute__((__packed__));
273 
288  struct tisci_header hdr;
293 } __attribute__((__packed__));
294 
304  struct tisci_header hdr;
305 } __attribute__((__packed__));
306 
307 
318  struct tisci_header hdr;
319 } __attribute__((__packed__));
320 
334  struct tisci_header hdr;
335  uint32_t msmc_start_low;
336  uint32_t msmc_start_high;
337  uint32_t msmc_end_low;
338  uint32_t msmc_end_high;
339 } __attribute__((__packed__));
340 
351  struct tisci_header hdr;
352 } __attribute__((__packed__));
353 
363  struct tisci_header hdr;
366 } __attribute__((__packed__));
367 
377  struct tisci_header hdr;
378 } __attribute__((__packed__));
379 
389  struct tisci_header hdr;
390  uint64_t fw_caps;
391 } __attribute__((__packed__));
392 
393 
394 #ifdef __cplusplus
395 }
396 #endif
397 
398 #endif /* MESSAGES_CORE_H */
399 
tisci_query_msmc_resp
TISCI_MSG_QUERY_MSMC request response providing currently available MSMC memory if present in the SoC...
Definition: tisci_core.h:333
tisci_msg_board_config_pm_resp
Empty response for TISCI_MSG_BOARD_CONFIG_PM.
Definition: tisci_core.h:303
tisci_msg_version_resp
TISCI_MSG_VERSION request to provide version info about currently running firmware.
Definition: tisci_core.h:98
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:350
tisci_msg_board_config_rm_req::tisci_boardcfg_rmp_high
uint32_t tisci_boardcfg_rmp_high
Definition: tisci_core.h:181
tisci_msg_dm_version_resp
TISCI_MSG_DM_VERSION response struct to provide version info about currently running DM firmware.
Definition: tisci_core.h:132
tisci_msg_version_resp::abi_major
uint8_t abi_major
Definition: tisci_core.h:102
tisci_msg_dm_version_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:133
tisci_query_fw_caps_resp::fw_caps
uint64_t fw_caps
Definition: tisci_core.h:390
tisci_query_msmc_resp::msmc_end_low
uint32_t msmc_end_low
Definition: tisci_core.h:337
tisci_msg_board_config_pm_req::tisci_boardcfg_pmp_low
uint32_t tisci_boardcfg_pmp_low
Definition: tisci_core.h:289
tisci_query_msmc_req
TISCI_MSG_QUERY_MSMC request to provide currently available MSMC memory if present in the SoC.
Definition: tisci_core.h:317
tisci_query_msmc_resp::msmc_start_low
uint32_t msmc_start_low
Definition: tisci_core.h:335
tisci_msg_board_config_req::tisci_boardcfgp_high
uint32_t tisci_boardcfgp_high
Definition: tisci_core.h:224
tisci_msg_board_config_resasg_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:207
tisci_msg_boot_notification_req::extboot_status
uint32_t extboot_status
Definition: tisci_core.h:151
tisci_query_msmc_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:334
tisci_msg_board_config_resasg_resp
Empty response for TISCI_MSG_BOARD_CONFIG_RESASG.
Definition: tisci_core.h:206
tisci_msg_version_resp::abi_minor
uint8_t abi_minor
Definition: tisci_core.h:103
tisci_query_msmc_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:318
tisci_msg_version_resp::str
char str[32]
Definition: tisci_core.h:100
tisci_msg_version_resp::patch_version
uint8_t patch_version
Definition: tisci_core.h:105
tisci_msg_board_config_resp
Empty response for TISCI_MSG_BOARD_CONFIG.
Definition: tisci_core.h:237
tisci_msg_version_resp::version
uint16_t version
Definition: tisci_core.h:101
tisci_msg_board_config_rm_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:195
tisci_msg_board_config_security_req::tisci_boardcfg_security_size
uint16_t tisci_boardcfg_security_size
Definition: tisci_core.h:258
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:221
tisci_msg_board_config_rm_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:179
tisci_msg_board_config_security_resp
Empty response for TISCI_MSG_BOARD_CONFIG_SECURITY.
Definition: tisci_core.h:270
tisci_header
Header that prefixes all TISCI messages.
Definition: tisci_protocol.h:94
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:237
tisci_query_fw_caps_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:389
tisci_msg_dm_version_resp::sub_version
uint8_t sub_version
Definition: tisci_core.h:135
tisci_msg_board_config_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:238
tisci_msg_board_config_req::tisci_boardcfg_size
uint16_t tisci_boardcfg_size
Definition: tisci_core.h:225
tisci_msg_boot_notification_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:163
tisci_msg_board_config_security_req::tisci_boardcfg_securityp_high
uint32_t tisci_boardcfg_securityp_high
Definition: tisci_core.h:257
tisci_msg_version_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:99
tisci_msg_boot_notification_req
Notification message to indicate the DMSC is available.
Definition: tisci_core.h:149
tisci_msg_dm_version_resp::patch_version
uint8_t patch_version
Definition: tisci_core.h:136
tisci_get_trace_config_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:363
tisci_msg_board_config_pm_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:304
tisci_msg_board_config_rm_req::tisci_boardcfg_rmp_low
uint32_t tisci_boardcfg_rmp_low
Definition: tisci_core.h:180
tisci_msg_board_config_pm_req::tisci_boardcfg_pmp_high
uint32_t tisci_boardcfg_pmp_high
Definition: tisci_core.h:290
tisci_msg_dm_version_resp::abi_minor
uint8_t abi_minor
Definition: tisci_core.h:138
tisci_msg_board_config_pm_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:288
tisci_msg_board_config_rm_req::tisci_boardcfg_rm_devgrp
devgrp_t tisci_boardcfg_rm_devgrp
Definition: tisci_core.h:183
tisci_msg_board_config_pm_req::tisci_boardcfg_pm_devgrp
devgrp_t tisci_boardcfg_pm_devgrp
Definition: tisci_core.h:292
tisci_msg_dm_version_req
Notification message to get DM version.
Definition: tisci_core.h:116
tisci_msg_board_config_security_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:271
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:178
tisci_msg_board_config_rm_resp
Empty response for TISCI_MSG_BOARD_CONFIG_RM.
Definition: tisci_core.h:194
tisci_msg_version_req
Notification message to indicate the DMSC is available.
Definition: tisci_core.h:83
tisci_query_fw_caps_resp
TISCI_MSG_QUERY_FW_CAPS request response providing currently available SOC/firmware capabilities.
Definition: tisci_core.h:388
tisci_msg_board_config_security_req::tisci_boardcfg_securityp_low
uint32_t tisci_boardcfg_securityp_low
Definition: tisci_core.h:256
tisci_msg_boot_notification_resp
Response to notification message about firmware availability.
Definition: tisci_core.h:162
tisci_msg_board_config_rm_req::tisci_boardcfg_rm_size
uint16_t tisci_boardcfg_rm_size
Definition: tisci_core.h:182
tisci_msg_board_config_security_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:255
tisci_msg_board_config_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:222
tisci_query_msmc_resp::msmc_end_high
uint32_t msmc_end_high
Definition: tisci_core.h:338
tisci_msg_dm_version_resp::sciserver_version
char sciserver_version[26]
Definition: tisci_core.h:140
tisci_msg_dm_version_resp::abi_major
uint8_t abi_major
Definition: tisci_core.h:137
tisci_msg_board_config_req::tisci_boardcfgp_low
uint32_t tisci_boardcfgp_low
Definition: tisci_core.h:223
tisci_msg_dm_version_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:117
tisci_msg_board_config_pm_req::tisci_boardcfg_pm_size
uint16_t tisci_boardcfg_pm_size
Definition: tisci_core.h:291
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:287
tisci_msg_board_config_req::tisci_boardcfg_devgrp
devgrp_t tisci_boardcfg_devgrp
Definition: tisci_core.h:226
__attribute__
struct tisci_msg_version_req __attribute__((__packed__))
tisci_msg_version_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:84
tisci_get_trace_config_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:351
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:254
tisci_msg_version_resp::sub_version
uint8_t sub_version
Definition: tisci_core.h:104
tisci_get_trace_config_resp::trace_dst_enables
uint16_t trace_dst_enables
Definition: tisci_core.h:364
tisci_msg_board_config_security_req::tisci_boardcfg_security_devgrp
devgrp_t tisci_boardcfg_security_devgrp
Definition: tisci_core.h:259
tisci_query_fw_caps_req
TISCI_MSG_QUERY_FW_CAPS request to provide the firmware/SOC capabilities.
Definition: tisci_core.h:376
tisci_msg_boot_notification_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:150
tisci_get_trace_config_resp::trace_src_enables
uint16_t trace_src_enables
Definition: tisci_core.h:365
tisci_query_msmc_resp::msmc_start_high
uint32_t msmc_start_high
Definition: tisci_core.h:336
tisci_get_trace_config_resp
TISCI_MSG_GET_TRACE_CONFIG request response providing the debug config from base board config.
Definition: tisci_core.h:362
tisci_msg_dm_version_resp::version
uint16_t version
Definition: tisci_core.h:134
tisci_query_fw_caps_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:377
tisci_msg_dm_version_resp::rm_pm_hal_version
char rm_pm_hal_version[12]
Definition: tisci_core.h:139