tisci_boardcfg.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2026 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
#ifndef TISCI_BOARD_CFG_H
#define TISCI_BOARD_CFG_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
 
 
#define TISCI_BOARDCFG_ABI_MAJ_VALUE                  0x00
#define TISCI_BOARDCFG_ABI_MIN_VALUE                  0x01
 
#define TISCI_BOARDCFG_SEC_ABI_MAJ_VALUE               0x00
#define TISCI_BOARDCFG_SEC_ABI_MIN_VALUE               0x01
 
#ifdef CONFIG_SMS_LITE_COPROCESSOR
/* Size of reserved 0 substructure in sms-lite secure boardconfig */
#define TISCI_BOARDCFG_SEC_RESV0_SIZE (8U)
/* Size of reserved 1 substructure in sms-lite secure baordconfig */
#define TISCI_BOARDCFG_SEC_RESV1_SIZE (10U)
#endif
 
struct tisci_boardcfg_substructure_header {
    uint16_t    magic;
    uint16_t    size;
} __attribute__((__packed__));
 
struct tisci_boardcfg_abi_rev {
    uint8_t    tisci_boardcfg_abi_maj;
    uint8_t    tisci_boardcfg_abi_min;
} __attribute__((__packed__));
 
struct tisci_boardcfg_control {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    main_isolation_enable;
    uint16_t                    main_isolation_hostid;
} __attribute__((__packed__));
 
struct tisci_boardcfg_secproxy {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    scaling_factor;
    uint8_t                    scaling_profile;
    uint8_t                    disable_main_nav_secure_proxy;
} __attribute__((__packed__));
 
struct tisci_boardcfg_msmc {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    msmc_cache_size;
} __attribute__((__packed__));
 
/* \brief How many masters that are permitted in proc acl for access */
#define PROCESSOR_ACL_SECONDARY_MASTERS_MAX (3U)
 
struct tisci_boardcfg_proc_acl_entry {
    uint8_t    processor_id;
    uint8_t    proc_access_master;
    uint8_t    proc_access_secondary[PROCESSOR_ACL_SECONDARY_MASTERS_MAX];
} __attribute__((__packed__));
 
/* \brief How many access control list entries for processors */
#define PROCESSOR_ACL_ENTRIES (32U)
 
struct tisci_boardcfg_proc_acl {
    struct tisci_boardcfg_substructure_header    subhdr;
    struct tisci_boardcfg_proc_acl_entry        proc_acl_entries[
        PROCESSOR_ACL_ENTRIES];
} __attribute__((__packed__));
 
struct tisci_boardcfg_host_hierarchy_entry {
    uint8_t    host_id;
    uint8_t    supervisor_host_id;
} __attribute__((__packed__));
 
#define HOST_HIERARCHY_ENTRIES (32U)
 
struct tisci_boardcfg_host_hierarchy {
    struct tisci_boardcfg_substructure_header    subhdr;
    struct tisci_boardcfg_host_hierarchy_entry    host_hierarchy_entries[HOST_HIERARCHY_ENTRIES];
} __attribute__((__packed__));
 
struct tisci_boardcfg_extended_otp_entry {
    uint8_t    host_id;
    uint8_t    host_perms;
} __attribute__((__packed__));
 
#define MAX_NUM_EXT_OTP_MMRS (32U)
 
struct tisci_boardcfg_extended_otp {
    struct tisci_boardcfg_substructure_header    subhdr;
    struct tisci_boardcfg_extended_otp_entry    otp_entry[MAX_NUM_EXT_OTP_MMRS];
    uint8_t                    write_host_id;
} __attribute__((__packed__));
 
 
#define MAX_NUM_DKEK_ALLOWED_HOSTS (4U)
 
#ifdef CONFIG_ENABLE_FWL_DEVGRP_REINIT
 
struct tisci_boardcfg_dkek {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    allowed_hosts[MAX_NUM_DKEK_ALLOWED_HOSTS];
    uint8_t                    allow_dkek_export_tisci;
    uint8_t                    fwl_reinit_devgrp_opt;
    uint8_t                    rsvd[2];
} __attribute__((__packed__));
#else
 
struct tisci_boardcfg_dkek {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    allowed_hosts[MAX_NUM_DKEK_ALLOWED_HOSTS];
    uint8_t                    allow_dkek_export_tisci;
    uint8_t                    rsvd[3];
} __attribute__((__packed__));
#endif
 
struct tisci_boardcfg_sa2ul_cfg {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    auth_resource_owner;
    uint8_t                    enable_saul_psil_global_config_writes;
    uint8_t                    safety_host_present;
    uint8_t                    safety_host;
};
 
 
struct tisci_boardcfg_secure_debug_config {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    allow_jtag_unlock;
    uint8_t                    allow_wildcard_unlock;
    uint8_t                    allowed_debug_level_rsvd;
    uint8_t                    rsvd;
    uint32_t                    min_cert_rev;
    uint8_t                    jtag_unlock_hosts[TISCI_BOARDCFG_SEC_MAX_NUM_JTAG_UNLOCK_HOSTS];
} __attribute__((__packed__));
 
struct tisci_boardcfg_sec_handover {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    handover_msg_sender;
    uint8_t                    handover_to_host_id;
    uint8_t                    rsvd[4];
};
 
#ifdef CONFIG_SMS_LITE_COPROCESSOR
 
struct tisci_boardcfg_sec_resv0 {
    uint8_t resv[TISCI_BOARDCFG_SEC_RESV0_SIZE];
};
 
struct tisci_boardcfg_sec_resv1 {
    uint8_t resv[TISCI_BOARDCFG_SEC_RESV1_SIZE];
};
 
struct tisci_boardcfg_sec {
    struct tisci_boardcfg_abi_rev            rev;
    struct tisci_boardcfg_proc_acl        processor_acl_list;
    struct tisci_boardcfg_host_hierarchy        host_hierarchy;
    struct tisci_boardcfg_extended_otp        otp_config;
    struct tisci_boardcfg_dkek            dkek_config;
    struct tisci_boardcfg_sec_resv0        resv0;
    struct tisci_boardcfg_secure_debug_config    sec_dbg_config;
    struct tisci_boardcfg_sec_resv1        resv1;
} __attribute__((__packed__));
 
#else
 
struct tisci_boardcfg_sec {
    struct tisci_boardcfg_abi_rev            rev;
    struct tisci_boardcfg_proc_acl        processor_acl_list;
    struct tisci_boardcfg_host_hierarchy        host_hierarchy;
    struct tisci_boardcfg_extended_otp        otp_config;
    struct tisci_boardcfg_dkek            dkek_config;
    struct tisci_boardcfg_sa2ul_cfg        sa2ul_auth_cfg;
    struct tisci_boardcfg_secure_debug_config    sec_dbg_config;
    struct tisci_boardcfg_sec_handover        sec_handover_cfg;
} __attribute__((__packed__));
 
#endif
 
#define TISCI_BOARDCFG_TRACE_DST_UART0                TISCI_BIT(0)
#define TISCI_BOARDCFG_TRACE_DST_ITM                  TISCI_BIT(2)
#define TISCI_BOARDCFG_TRACE_DST_MEM                  TISCI_BIT(3)
 
#define TISCI_BOARDCFG_TRACE_SRC_PM                   TISCI_BIT(0)
#define TISCI_BOARDCFG_TRACE_SRC_RM                   TISCI_BIT(1)
#define TISCI_BOARDCFG_TRACE_SRC_SEC                  TISCI_BIT(2)
#define TISCI_BOARDCFG_TRACE_SRC_BASE                 TISCI_BIT(3)
#define TISCI_BOARDCFG_TRACE_SRC_USER                 TISCI_BIT(4)
#define TISCI_BOARDCFG_TRACE_SRC_SUPR                 TISCI_BIT(5)
#define TISCI_BOARDCFG_TRACE_SRC_LPM                  TISCI_BIT(6)
 
struct tisci_boardcfg_dbg_cfg {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint16_t                    trace_dst_enables;
    uint16_t                    trace_src_enables;
} __attribute__((__packed__));
 
#ifdef CONFIG_SMS_LITE_COPROCESSOR
 
struct tisci_boardcfg_boot_mode_cfg {
    struct tisci_boardcfg_substructure_header    subhdr;
    uint8_t                    allowed_host;
};
 
struct tisci_boardcfg_resv {
    uint8_t resv[7];
} __attribute__((__packed__));
 
struct tisci_boardcfg {
    struct tisci_boardcfg_abi_rev        rev;
    struct tisci_boardcfg_control        control;
    struct tisci_boardcfg_boot_mode_cfg    bm_writer_cfg;
    struct tisci_boardcfg_resv        resv;
    struct tisci_boardcfg_dbg_cfg        debug_cfg;
} __attribute__((__packed__));
 
#else
 
struct tisci_boardcfg {
    struct tisci_boardcfg_abi_rev        rev;
    struct tisci_boardcfg_control        control;
    struct tisci_boardcfg_secproxy    secproxy;
    struct tisci_boardcfg_msmc        msmc;
    struct tisci_boardcfg_dbg_cfg        debug_cfg;
} __attribute__((__packed__));
 
#endif
 
struct tisci_boardcfg_hashes_data {
    uint8_t    sec_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES];
    uint8_t    rm_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES];
    uint8_t    pm_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES];
    uint8_t    core_bcfg_hash[TISCI_BOARDCFG_HASH_LEN_BYTES];
    uint8_t    sec_bcfg_iv[TISCI_BOARDCFG_SEC_IV_LEN];
    uint8_t    sec_bcfg_rs[TISCI_BOARDCFG_SEC_RS_LEN];
    uint8_t    sec_bcfg_ver;
    uint8_t    sec_bcfg_num_iter;
    uint8_t    hashes_received;
};
 
#ifdef __cplusplus
}
#endif
 
#endif          /* TISCI_BOARD_CFG_H */