AM64x MCU+ SDK  08.02.00
tisci_boardcfg.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017-2022 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 TISCI_BOARD_CFG_H
55 #define TISCI_BOARD_CFG_H
56 
57 
58 
59 #define TISCI_BOARDCFG_ABI_MAJ_VALUE 0x00
60 #define TISCI_BOARDCFG_ABI_MIN_VALUE 0x01
61 
62 #define TISCI_BOARDCFG_SEC_ABI_MAJ_VALUE 0x00
63 #define TISCI_BOARDCFG_SEC_ABI_MIN_VALUE 0x01
64 
75  uint16_t magic;
76  uint16_t size;
77 } __attribute__((__packed__));
78 
88 } __attribute__((__packed__));
89 
105 } __attribute__((__packed__));
106 
127  uint8_t scaling_factor;
130 } __attribute__((__packed__));
131 
144 } __attribute__((__packed__));
145 
146 /* \brief How many masters that are permitted in proc acl for access */
147 #define PROCESSOR_ACL_SECONDARY_MASTERS_MAX (3U)
148 
157  uint8_t processor_id;
160 } __attribute__((__packed__));
161 
162 /* \brief How many access control list entries for processors */
163 #define PROCESSOR_ACL_ENTRIES (32U)
164 
174 } __attribute__((__packed__));
175 
184  uint8_t host_id;
186 } __attribute__((__packed__));
187 
189 #define HOST_HIERARCHY_ENTRIES (32U)
190 
200 } __attribute__((__packed__));
201 
212  uint8_t host_id;
213  uint8_t host_perms;
214 } __attribute__((__packed__));
215 
219 #define MAX_NUM_EXT_OTP_MMRS (32U)
220 
230  uint8_t write_host_id;
231 } __attribute__((__packed__));
232 
233 
234 #define MAX_NUM_DKEK_ALLOWED_HOSTS (4U)
235 
247  uint8_t rsvd[3];
248 } __attribute__((__packed__));
249 
261  uint8_t rsvd[3];
262 };
263 
264 
294  uint8_t rsvd;
295  uint32_t min_cert_rev;
297 } __attribute__((__packed__));
298 
313  uint8_t rsvd[4];
314 };
315 
337 } __attribute__((__packed__));
338 
349 #define TISCI_BOARDCFG_TRACE_DST_UART0 TISCI_BIT(0)
350 #define TISCI_BOARDCFG_TRACE_DST_ITM TISCI_BIT(2)
351 #define TISCI_BOARDCFG_TRACE_DST_MEM TISCI_BIT(3)
352 
372 #define TISCI_BOARDCFG_TRACE_SRC_PM TISCI_BIT(0)
373 #define TISCI_BOARDCFG_TRACE_SRC_RM TISCI_BIT(1)
374 #define TISCI_BOARDCFG_TRACE_SRC_SEC TISCI_BIT(2)
375 #define TISCI_BOARDCFG_TRACE_SRC_BASE TISCI_BIT(3)
376 #define TISCI_BOARDCFG_TRACE_SRC_USER TISCI_BIT(4)
377 #define TISCI_BOARDCFG_TRACE_SRC_SUPR TISCI_BIT(5)
378 
390 } __attribute__((__packed__));
391 
405  struct tisci_boardcfg_msmc msmc;
407 } __attribute__((__packed__));
408 
409 
432  uint8_t sec_bcfg_ver;
435 };
436 #endif /* TISCI_BOARD_CFG_H */
437 
PROCESSOR_ACL_ENTRIES
#define PROCESSOR_ACL_ENTRIES
Definition: tisci_boardcfg.h:163
tisci_boardcfg_secproxy
Secure proxy configuration.
Definition: tisci_boardcfg.h:125
PROCESSOR_ACL_SECONDARY_MASTERS_MAX
#define PROCESSOR_ACL_SECONDARY_MASTERS_MAX
Definition: tisci_boardcfg.h:147
tisci_boardcfg_hashes_data::hashes_received
uint8_t hashes_received
Definition: tisci_boardcfg.h:434
tisci_boardcfg_sec_handover
Configuration of security handover.
Definition: tisci_boardcfg.h:309
tisci_boardcfg_sec_handover::handover_to_host_id
uint8_t handover_to_host_id
Definition: tisci_boardcfg.h:312
tisci_boardcfg_hashes_data::core_bcfg_hash
uint8_t core_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES]
Definition: tisci_boardcfg.h:429
tisci_boardcfg_extended_otp_entry::host_perms
uint8_t host_perms
Definition: tisci_boardcfg.h:213
TISCI_BOARDCFG_HASH_LEN_BYTES
#define TISCI_BOARDCFG_HASH_LEN_BYTES
This file contains:
Definition: tisci_boardcfg_macros.h:57
tisci_boardcfg::rev
struct tisci_boardcfg_abi_rev rev
Definition: tisci_boardcfg.h:402
TISCI_BOARDCFG_SEC_IV_LEN
#define TISCI_BOARDCFG_SEC_IV_LEN
Definition: tisci_boardcfg_macros.h:60
tisci_boardcfg::debug_cfg
struct tisci_boardcfg_dbg_cfg debug_cfg
Definition: tisci_boardcfg.h:406
tisci_boardcfg_dbg_cfg
Debug console configuration.
Definition: tisci_boardcfg.h:386
tisci_boardcfg_secproxy::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:126
tisci_boardcfg_secure_debug_config::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:290
tisci_boardcfg_extended_otp_entry
access configuration for one OTP MMR. Each MMR is 32 bit wide.
Definition: tisci_boardcfg.h:211
tisci_boardcfg_hashes_data::rm_bcfg_hash
uint8_t rm_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES]
Definition: tisci_boardcfg.h:427
tisci_boardcfg_proc_acl::proc_acl_entries
struct tisci_boardcfg_proc_acl_entry proc_acl_entries[PROCESSOR_ACL_ENTRIES]
Definition: tisci_boardcfg.h:172
tisci_boardcfg_sec::rev
struct tisci_boardcfg_abi_rev rev
Definition: tisci_boardcfg.h:329
tisci_boardcfg_hashes_data::sec_bcfg_iv
uint8_t sec_bcfg_iv[TISCI_BOARDCFG_SEC_IV_LEN]
Definition: tisci_boardcfg.h:430
tisci_boardcfg_hashes_data::pm_bcfg_hash
uint8_t pm_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES]
Definition: tisci_boardcfg.h:428
tisci_boardcfg_proc_acl_entry
A single entry of Processor Access Control List.
Definition: tisci_boardcfg.h:156
tisci_boardcfg_sec::sec_handover_cfg
struct tisci_boardcfg_sec_handover sec_handover_cfg
Definition: tisci_boardcfg.h:336
tisci_boardcfg_sec::sec_dbg_config
struct tisci_boardcfg_secure_debug_config sec_dbg_config
Definition: tisci_boardcfg.h:335
tisci_boardcfg_dbg_cfg::trace_src_enables
uint16_t trace_src_enables
Definition: tisci_boardcfg.h:389
tisci_boardcfg_sec::sa2ul_auth_cfg
struct tisci_boardcfg_sa2ul_cfg sa2ul_auth_cfg
Definition: tisci_boardcfg.h:334
tisci_boardcfg_sec_handover::rsvd
uint8_t rsvd[4]
Definition: tisci_boardcfg.h:313
tisci_boardcfg_msmc
Cache configuration so that MSMC can be used for main secure proxy backing memory and ring memory.
Definition: tisci_boardcfg.h:141
tisci_boardcfg_secure_debug_config::allow_jtag_unlock
uint8_t allow_jtag_unlock
Definition: tisci_boardcfg.h:291
TISCI_BOARDCFG_SEC_MAX_NUM_JTAG_UNLOCK_HOSTS
#define TISCI_BOARDCFG_SEC_MAX_NUM_JTAG_UNLOCK_HOSTS
Definition: tisci_boardcfg_macros.h:66
tisci_boardcfg_sa2ul_cfg::auth_resource_owner
uint8_t auth_resource_owner
Definition: tisci_boardcfg.h:260
tisci_boardcfg_sec::otp_config
struct tisci_boardcfg_extended_otp otp_config
Definition: tisci_boardcfg.h:332
tisci_boardcfg_extended_otp::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:228
tisci_boardcfg_dkek::rsvd
uint8_t rsvd[3]
Definition: tisci_boardcfg.h:247
tisci_boardcfg_control::main_isolation_enable
uint8_t main_isolation_enable
Definition: tisci_boardcfg.h:103
tisci_boardcfg_sec_handover::handover_msg_sender
uint8_t handover_msg_sender
Definition: tisci_boardcfg.h:311
tisci_boardcfg_control
Used to enable/disable features in DMSC based on usecase.
Definition: tisci_boardcfg.h:101
tisci_boardcfg_dbg_cfg::trace_dst_enables
uint16_t trace_dst_enables
Definition: tisci_boardcfg.h:388
tisci_boardcfg_hashes_data
structure to hold the board configuration hashes received via X509 certificate
Definition: tisci_boardcfg.h:425
tisci_boardcfg_extended_otp
Access configuration for each OTP row.
Definition: tisci_boardcfg.h:227
tisci_boardcfg_hashes_data::sec_bcfg_hash
uint8_t sec_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES]
Definition: tisci_boardcfg.h:426
tisci_boardcfg_dkek::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:244
tisci_boardcfg
Format of the complete board configuration.
Definition: tisci_boardcfg.h:401
tisci_boardcfg_msmc::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:142
tisci_boardcfg_dkek::allow_dkek_export_tisci
uint8_t allow_dkek_export_tisci
Definition: tisci_boardcfg.h:246
tisci_boardcfg_proc_acl::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:171
tisci_boardcfg::secproxy
struct tisci_boardcfg_secproxy secproxy
Definition: tisci_boardcfg.h:404
tisci_boardcfg_proc_acl_entry::proc_access_master
uint8_t proc_access_master
Definition: tisci_boardcfg.h:158
tisci_boardcfg_host_hierarchy_entry::host_id
uint8_t host_id
Definition: tisci_boardcfg.h:184
tisci_boardcfg_msmc::msmc_cache_size
uint8_t msmc_cache_size
Definition: tisci_boardcfg.h:143
tisci_boardcfg_secure_debug_config::allowed_debug_level_rsvd
uint8_t allowed_debug_level_rsvd
Definition: tisci_boardcfg.h:293
tisci_boardcfg_control::main_isolation_hostid
uint16_t main_isolation_hostid
Definition: tisci_boardcfg.h:104
tisci_boardcfg_secproxy::scaling_profile
uint8_t scaling_profile
Definition: tisci_boardcfg.h:128
tisci_boardcfg_proc_acl_entry::processor_id
uint8_t processor_id
Definition: tisci_boardcfg.h:157
tisci_boardcfg_sec_handover::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:310
tisci_boardcfg_secure_debug_config::min_cert_rev
uint32_t min_cert_rev
Definition: tisci_boardcfg.h:295
tisci_boardcfg_host_hierarchy_entry
A single entry of Host hierarchy List.
Definition: tisci_boardcfg.h:183
tisci_boardcfg_sec::host_hierarchy
struct tisci_boardcfg_host_hierarchy host_hierarchy
Definition: tisci_boardcfg.h:331
MAX_NUM_DKEK_ALLOWED_HOSTS
#define MAX_NUM_DKEK_ALLOWED_HOSTS
Definition: tisci_boardcfg.h:234
tisci_boardcfg_substructure_header::magic
uint16_t magic
Definition: tisci_boardcfg.h:75
tisci_boardcfg_sec
Format of the complete board configuration.
Definition: tisci_boardcfg.h:328
tisci_boardcfg_host_hierarchy
List of SoC hosts and their supervising hosts.
Definition: tisci_boardcfg.h:197
tisci_boardcfg_secure_debug_config::rsvd
uint8_t rsvd
Definition: tisci_boardcfg.h:294
tisci_boardcfg_sec::dkek_config
struct tisci_boardcfg_dkek dkek_config
Definition: tisci_boardcfg.h:333
tisci_boardcfg_control::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:102
tisci_boardcfg_sa2ul_cfg
Configuration of SA2UL resources.
Definition: tisci_boardcfg.h:258
MAX_NUM_EXT_OTP_MMRS
#define MAX_NUM_EXT_OTP_MMRS
Maximum number of OTP rows allowed by design.
Definition: tisci_boardcfg.h:219
tisci_boardcfg_proc_acl_entry::proc_access_secondary
uint8_t proc_access_secondary[PROCESSOR_ACL_SECONDARY_MASTERS_MAX]
Definition: tisci_boardcfg.h:159
tisci_boardcfg_abi_rev::tisci_boardcfg_abi_maj
uint8_t tisci_boardcfg_abi_maj
Definition: tisci_boardcfg.h:86
tisci_boardcfg_host_hierarchy::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:198
tisci_boardcfg_hashes_data::sec_bcfg_ver
uint8_t sec_bcfg_ver
Definition: tisci_boardcfg.h:432
tisci_boardcfg_abi_rev::tisci_boardcfg_abi_min
uint8_t tisci_boardcfg_abi_min
Definition: tisci_boardcfg.h:87
__attribute__
struct tisci_boardcfg_sa2ul_cfg __attribute__
tisci_boardcfg_hashes_data::sec_bcfg_rs
uint8_t sec_bcfg_rs[TISCI_BOARDCFG_SEC_RS_LEN]
Definition: tisci_boardcfg.h:431
tisci_boardcfg_substructure_header::size
uint16_t size
Definition: tisci_boardcfg.h:76
tisci_boardcfg_dbg_cfg::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:387
TISCI_BOARDCFG_SEC_RS_LEN
#define TISCI_BOARDCFG_SEC_RS_LEN
Definition: tisci_boardcfg_macros.h:63
tisci_boardcfg_host_hierarchy_entry::supervisor_host_id
uint8_t supervisor_host_id
Definition: tisci_boardcfg.h:185
tisci_boardcfg_proc_acl
Control list for which hosts can control which processors.
Definition: tisci_boardcfg.h:170
HOST_HIERARCHY_ENTRIES
#define HOST_HIERARCHY_ENTRIES
How many host hierarchy list entries for hosts.
Definition: tisci_boardcfg.h:189
tisci_boardcfg_extended_otp_entry::host_id
uint8_t host_id
Definition: tisci_boardcfg.h:212
tisci_boardcfg_extended_otp::write_host_id
uint8_t write_host_id
Definition: tisci_boardcfg.h:230
tisci_boardcfg_hashes_data::sec_bcfg_num_iter
uint8_t sec_bcfg_num_iter
Definition: tisci_boardcfg.h:433
tisci_boardcfg_sa2ul_cfg::subhdr
struct tisci_boardcfg_substructure_header subhdr
Definition: tisci_boardcfg.h:259
tisci_boardcfg_substructure_header
Contains a unique magic number for each substructure and the size of the associated superstructure fo...
Definition: tisci_boardcfg.h:74
tisci_boardcfg::msmc
struct tisci_boardcfg_msmc msmc
Definition: tisci_boardcfg.h:405
tisci_boardcfg_dkek
Access configuration for DKEK.
Definition: tisci_boardcfg.h:243
tisci_boardcfg_secproxy::disable_main_nav_secure_proxy
uint8_t disable_main_nav_secure_proxy
Definition: tisci_boardcfg.h:129
tisci_boardcfg_sa2ul_cfg::rsvd
uint8_t rsvd[3]
Definition: tisci_boardcfg.h:261
tisci_boardcfg_dkek::allowed_hosts
uint8_t allowed_hosts[MAX_NUM_DKEK_ALLOWED_HOSTS]
Definition: tisci_boardcfg.h:245
tisci_boardcfg_abi_rev
Board Config data ABI version.
Definition: tisci_boardcfg.h:85
tisci_boardcfg_sec::processor_acl_list
struct tisci_boardcfg_proc_acl processor_acl_list
Definition: tisci_boardcfg.h:330
tisci_boardcfg_secure_debug_config::jtag_unlock_hosts
uint8_t jtag_unlock_hosts[TISCI_BOARDCFG_SEC_MAX_NUM_JTAG_UNLOCK_HOSTS]
Definition: tisci_boardcfg.h:296
tisci_boardcfg_extended_otp::otp_entry
struct tisci_boardcfg_extended_otp_entry otp_entry[MAX_NUM_EXT_OTP_MMRS]
Definition: tisci_boardcfg.h:229
tisci_boardcfg_host_hierarchy::host_hierarchy_entries
struct tisci_boardcfg_host_hierarchy_entry host_hierarchy_entries[HOST_HIERARCHY_ENTRIES]
Definition: tisci_boardcfg.h:199
tisci_boardcfg_secure_debug_config
Secure debug control.
Definition: tisci_boardcfg.h:289
tisci_boardcfg_secure_debug_config::allow_wildcard_unlock
uint8_t allow_wildcard_unlock
Definition: tisci_boardcfg.h:292
tisci_boardcfg_secproxy::scaling_factor
uint8_t scaling_factor
Definition: tisci_boardcfg.h:127
tisci_boardcfg::control
struct tisci_boardcfg_control control
Definition: tisci_boardcfg.h:403