AM62x MCU+ SDK  10.01.00
tisci_core.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017-2024 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 
83  struct tisci_header hdr;
84 } __attribute__((__packed__));
85 
98  struct tisci_header hdr;
99  char str[32];
100  uint16_t version;
101  uint8_t abi_major;
102  uint8_t abi_minor;
103  uint8_t sub_version;
104  uint8_t patch_version;
105 } __attribute__((__packed__));
106 
114  struct tisci_header hdr;
115  uint32_t extboot_status;
116 } __attribute__((__packed__));
117 
127  struct tisci_header hdr;
128 } __attribute__((__packed__));
129 
143  struct tisci_header hdr;
148 } __attribute__((__packed__));
149 
159  struct tisci_header hdr;
160 } __attribute__((__packed__));
161 
171  struct tisci_header hdr;
172 } __attribute__((__packed__));
173 
186  struct tisci_header hdr;
191 } __attribute__((__packed__));
192 
202  struct tisci_header hdr;
203 } __attribute__((__packed__));
204 
219  struct tisci_header hdr;
224 } __attribute__((__packed__));
225 
235  struct tisci_header hdr;
236 } __attribute__((__packed__));
237 
252  struct tisci_header hdr;
257 } __attribute__((__packed__));
258 
268  struct tisci_header hdr;
269 } __attribute__((__packed__));
270 
271 
282  struct tisci_header hdr;
283 } __attribute__((__packed__));
284 
298  struct tisci_header hdr;
299  uint32_t msmc_start_low;
300  uint32_t msmc_start_high;
301  uint32_t msmc_end_low;
302  uint32_t msmc_end_high;
303 } __attribute__((__packed__));
304 
315  struct tisci_header hdr;
316 } __attribute__((__packed__));
317 
327  struct tisci_header hdr;
330 } __attribute__((__packed__));
331 
341  struct tisci_header hdr;
342 } __attribute__((__packed__));
343 
353  struct tisci_header hdr;
354  uint64_t fw_caps;
355 } __attribute__((__packed__));
356 
357 
358 #ifdef __cplusplus
359 }
360 #endif
361 
362 #endif /* MESSAGES_CORE_H */
363 
tisci_query_msmc_resp
TISCI_MSG_QUERY_MSMC request response providing currently available MSMC memory if present in the SoC...
Definition: tisci_core.h:297
tisci_msg_board_config_pm_resp
Empty response for TISCI_MSG_BOARD_CONFIG_PM.
Definition: tisci_core.h:267
tisci_msg_version_resp
TISCI_MSG_VERSION request to provide version info about currently running firmware.
Definition: tisci_core.h:97
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:314
tisci_msg_board_config_rm_req::tisci_boardcfg_rmp_high
uint32_t tisci_boardcfg_rmp_high
Definition: tisci_core.h:145
tisci_msg_version_resp::abi_major
uint8_t abi_major
Definition: tisci_core.h:101
tisci_query_fw_caps_resp::fw_caps
uint64_t fw_caps
Definition: tisci_core.h:354
tisci_query_msmc_resp::msmc_end_low
uint32_t msmc_end_low
Definition: tisci_core.h:301
tisci_msg_board_config_pm_req::tisci_boardcfg_pmp_low
uint32_t tisci_boardcfg_pmp_low
Definition: tisci_core.h:253
tisci_query_msmc_req
TISCI_MSG_QUERY_MSMC request to provide currently available MSMC memory if present in the SoC.
Definition: tisci_core.h:281
tisci_query_msmc_resp::msmc_start_low
uint32_t msmc_start_low
Definition: tisci_core.h:299
tisci_msg_board_config_req::tisci_boardcfgp_high
uint32_t tisci_boardcfgp_high
Definition: tisci_core.h:188
tisci_msg_board_config_resasg_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:171
tisci_msg_boot_notification_req::extboot_status
uint32_t extboot_status
Definition: tisci_core.h:115
tisci_query_msmc_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:298
tisci_msg_board_config_resasg_resp
Empty response for TISCI_MSG_BOARD_CONFIG_RESASG.
Definition: tisci_core.h:170
tisci_msg_version_resp::abi_minor
uint8_t abi_minor
Definition: tisci_core.h:102
tisci_query_msmc_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:282
tisci_msg_version_resp::str
char str[32]
Definition: tisci_core.h:99
tisci_msg_version_resp::patch_version
uint8_t patch_version
Definition: tisci_core.h:104
tisci_msg_board_config_resp
Empty response for TISCI_MSG_BOARD_CONFIG.
Definition: tisci_core.h:201
tisci_msg_version_resp::version
uint16_t version
Definition: tisci_core.h:100
tisci_msg_board_config_rm_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:159
tisci_msg_board_config_security_req::tisci_boardcfg_security_size
uint16_t tisci_boardcfg_security_size
Definition: tisci_core.h:222
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:185
tisci_msg_board_config_rm_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:143
tisci_msg_board_config_security_resp
Empty response for TISCI_MSG_BOARD_CONFIG_SECURITY.
Definition: tisci_core.h:234
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:353
tisci_msg_board_config_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:202
tisci_msg_board_config_req::tisci_boardcfg_size
uint16_t tisci_boardcfg_size
Definition: tisci_core.h:189
tisci_msg_boot_notification_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:127
tisci_msg_board_config_security_req::tisci_boardcfg_securityp_high
uint32_t tisci_boardcfg_securityp_high
Definition: tisci_core.h:221
tisci_msg_version_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:98
tisci_msg_boot_notification_req
Notification message to indicate the DMSC is available.
Definition: tisci_core.h:113
tisci_get_trace_config_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:327
tisci_msg_board_config_pm_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:268
tisci_msg_board_config_rm_req::tisci_boardcfg_rmp_low
uint32_t tisci_boardcfg_rmp_low
Definition: tisci_core.h:144
tisci_msg_board_config_pm_req::tisci_boardcfg_pmp_high
uint32_t tisci_boardcfg_pmp_high
Definition: tisci_core.h:254
tisci_msg_board_config_pm_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:252
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:147
tisci_msg_board_config_pm_req::tisci_boardcfg_pm_devgrp
devgrp_t tisci_boardcfg_pm_devgrp
Definition: tisci_core.h:256
tisci_msg_board_config_security_resp::hdr
struct tisci_header hdr
Definition: tisci_core.h:235
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:142
tisci_msg_board_config_rm_resp
Empty response for TISCI_MSG_BOARD_CONFIG_RM.
Definition: tisci_core.h:158
tisci_msg_version_req
Notification message to indicate the DMSC is available.
Definition: tisci_core.h:82
tisci_query_fw_caps_resp
TISCI_MSG_QUERY_FW_CAPS request response providing currently available SOC/firmware capabilities.
Definition: tisci_core.h:352
tisci_msg_board_config_security_req::tisci_boardcfg_securityp_low
uint32_t tisci_boardcfg_securityp_low
Definition: tisci_core.h:220
tisci_msg_boot_notification_resp
Response to notification message about firmware availability.
Definition: tisci_core.h:126
tisci_msg_board_config_rm_req::tisci_boardcfg_rm_size
uint16_t tisci_boardcfg_rm_size
Definition: tisci_core.h:146
tisci_msg_board_config_security_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:219
tisci_msg_board_config_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:186
tisci_query_msmc_resp::msmc_end_high
uint32_t msmc_end_high
Definition: tisci_core.h:302
tisci_msg_board_config_req::tisci_boardcfgp_low
uint32_t tisci_boardcfgp_low
Definition: tisci_core.h:187
tisci_msg_board_config_pm_req::tisci_boardcfg_pm_size
uint16_t tisci_boardcfg_pm_size
Definition: tisci_core.h:255
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:251
tisci_msg_board_config_req::tisci_boardcfg_devgrp
devgrp_t tisci_boardcfg_devgrp
Definition: tisci_core.h:190
__attribute__
struct tisci_msg_version_req __attribute__((__packed__))
tisci_msg_version_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:83
tisci_get_trace_config_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:315
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:218
tisci_msg_version_resp::sub_version
uint8_t sub_version
Definition: tisci_core.h:103
tisci_get_trace_config_resp::trace_dst_enables
uint16_t trace_dst_enables
Definition: tisci_core.h:328
tisci_msg_board_config_security_req::tisci_boardcfg_security_devgrp
devgrp_t tisci_boardcfg_security_devgrp
Definition: tisci_core.h:223
tisci_query_fw_caps_req
TISCI_MSG_QUERY_FW_CAPS request to provide the firmware/SOC capabilities.
Definition: tisci_core.h:340
tisci_msg_boot_notification_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:114
tisci_get_trace_config_resp::trace_src_enables
uint16_t trace_src_enables
Definition: tisci_core.h:329
tisci_query_msmc_resp::msmc_start_high
uint32_t msmc_start_high
Definition: tisci_core.h:300
tisci_get_trace_config_resp
TISCI_MSG_GET_TRACE_CONFIG request response providing the debug config from base board config.
Definition: tisci_core.h:326
tisci_query_fw_caps_req::hdr
struct tisci_header hdr
Definition: tisci_core.h:341