bootloader_soc.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-2024 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 BOOTLOADER_SOC_AM263X_H_
#define BOOTLOADER_SOC_AM263X_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
#include <drivers/hw_include/cslr_soc.h>
#include <security/security_common/drivers/hsmclient/hsmclient.h>
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define BOOTLOADER_APP_SEGMENT_CANBE_ENCRYPTED      (0xA5U)
 
#define BOOTLOADER_APP_SEGMENT_CANNOTBE_ENCRYPTED   (0x5AU)
 
#define BOOTLOADER_SOC_APP_CERT_SIZE (0x1000)
 
#define BOOTLOADER_DEVTYPE_HSSE         (0x0AU)
 
#define BOOTLOADER_DEVTYPE_HSFS         (0xAAU)
 
#define BOOTLOADER_DEVTYPE_GP           (0x03U)
 
#define BOOTLOADER_CLIENT_ID            (0x02)
 
#define BOOTLOADER_MAX_SBL_SIZE_IN_TCM_KB             (640U)
 
typedef struct
{
    uint32_t defaultClockHz;
    char coreName[8];
 
} Bootloader_CoreBootInfo;
 
typedef struct Bootloader_socCoreOpModeConfig_s
{
    uint32_t r5fss0_opMode;
    uint32_t r5fss1_opMode;
} Bootloader_socCoreOpModeConfig;
 
int32_t  Bootloader_socCpuRequest(uint32_t cpuId);
 
int32_t  Bootloader_socCpuRelease(uint32_t cpuId);
 
int32_t  Bootloader_socCpuSetClock(uint32_t cpuId, uint32_t cpuHz);
 
uint64_t Bootloader_socCpuGetClock(uint32_t cpuId);
 
uint32_t Bootloader_socCpuGetClkDefault(uint32_t cpuId);
 
int32_t  Bootloader_socCpuPowerOnReset(uint32_t cpuId,void *socCoreOpMode);
 
int32_t  Bootloader_socCpuResetRelease(uint32_t cpuId, uintptr_t entryPoint);
 
int32_t  Bootloader_socCpuResetReleaseSelf(void);
 
int32_t  Bootloader_socCpuSetEntryPoint(uint32_t cpuId, uintptr_t entryPoint);
 
uint32_t Bootloader_socTranslateSectionAddr(uint32_t cslCoreId, uint32_t addr);
 
uint32_t Bootloader_socRprcToCslCoreId(uint32_t rprcCoreId);
 
uint32_t* Bootloader_socGetSelfCpuList(void);
 
char* Bootloader_socGetCoreName(uint32_t cpuId);
 
int32_t Bootloader_socMemInitCpu(uint32_t cpuId);
 
int32_t Bootloader_socSecHandover(void);
 
void Bootloader_socConfigurePll(void);
 
void Bootloader_socInitL2MailBoxMemory(void);
 
int32_t Bootloader_socAuthImage(uint32_t certLoadAddr);
 
uint32_t Bootloader_socIsAuthRequired(void);
 
void Bootloader_socGetBootSeqOid(uint8_t* boot_seq_oid);
 
void Bootloader_socLoadHsmRtFw(HsmClient_t *gHSMClient, const uint8_t *HsmRtFw, uint32_t hsmRTSize);
 
void Bootloader_socLoadHsmRtFwNonBlocking(HsmClient_t *gHSMClient, const uint8_t *HsmRtFw, uint32_t hsmRTSize);
 
void Bootloader_socSetAutoClock();
 
int32_t Bootloader_socCpuSetAppEntryPoint(uint32_t cpuId, uintptr_t entryPoint);
 
int32_t Bootloader_authStart(uintptr_t startAddr, uint32_t size);
 
int32_t Bootloader_authUpdate(uintptr_t startAddr, uint32_t size, uint8_t enc);
 
int32_t Bootloader_authFinish(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BOOTLOADER_SOC_AM263X_H_ */