bootloader_mcelf.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-2023 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_MCELF_H_
#define BOOTLOADER_MCELF_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/soc.h>
#include <drivers/hw_include/csl_types.h>
#include <drivers/hw_include/cslr_soc.h>
#include <drivers/hw_include/soc_config.h>
#include <drivers/bootloader/soc/bootloader_soc.h>
#include <drivers/bootloader/bootloader_profile.h>
#include <drivers/bootloader/bootloader_elf.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define BOOTLOADER_INVALID_ID      ((uint32_t)0xDEADBABE)
 
#define BOOTLOADER_OPMODE_LOCKSTEP   (0U)
#define BOOTLOADER_OPMODE_STANDALONE (1U)
 
#define BOOTLOADER_MEDIA_MEM       ((uint32_t)0xB0070001U)
#define BOOTLOADER_MEDIA_FLASH     ((uint32_t)0xB0070002U)
#define BOOTLOADER_MEDIA_EMMC      ((uint32_t)0xB0070003U)
#define BOOTLOADER_MEDIA_SD        ((uint32_t)0xB0070004U)
#define BOOTLOADER_MEDIA_BUFIO     ((uint32_t)0xB0070005U)
#define BOOTLOADER_MEDIA_UART      ((uint32_t)0xB0070006U)
 
typedef void* Bootloader_Handle;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct Bootloader_Params_s
{
    uint32_t memArgsAppImageBaseAddr;
    /* Base address of the appimage in case of a memory bootloader */
 
    uint8_t *bufIoTempBuf;
    /* Temporary buffer to be used if the boot media is a buffered IO */
 
    uint32_t bufIoTempBufSize;
    /* Size of the temporary buffer to be used if the boot media is a buffered IO */
 
    char* fileName;
    /*Pointer to the C string that hold name of file to be opened if the boot media is SD*/
 
    uint32_t bufIoDeviceIndex;
    /* Instance index of the IO device driver (UART) */
 
} Bootloader_Params;
 
typedef int32_t (*Bootloader_imgOpenFxn)(void *args, Bootloader_Params *params);
 
typedef int32_t (*Bootloader_imgReadFxn)(void *dstAddr, uint32_t length, void *args);
 
typedef uint32_t (*Bootloader_imgOffsetFxn)(void *args);
 
typedef void (*Bootloader_imgSeekFxn)(uint32_t location, void *args);
 
typedef void (*Bootloader_imgCloseFxn)(void* handle, void *args);
 
typedef int32_t (*Bootloader_imgCustomFxn)(void *args);
 
typedef struct Bootloader_Fxns_s
{
    Bootloader_imgOpenFxn   imgOpenFxn;
    Bootloader_imgReadFxn   imgReadFxn;
    Bootloader_imgOffsetFxn imgOffsetFxn;
    Bootloader_imgSeekFxn   imgSeekFxn;
    Bootloader_imgCloseFxn  imgCloseFxn;
    Bootloader_imgCustomFxn imgCustomFxn;
 
} Bootloader_Fxns;
 
typedef struct Bootloader_Config_s
{
    Bootloader_Fxns *fxns;
    void *args;
    uint32_t bootMedia;
    uint32_t bootImageSize;
    uint32_t coresPresentMap;
    uint8_t *scratchMemPtr;
    void *socCoreOpMode;
    uint32_t enableDma;
} Bootloader_Config;
 
#include <drivers/bootloader/bootloader_flash.h>
#include <drivers/bootloader/bootloader_mem.h>
#include <drivers/bootloader/bootloader_buf_io.h>
#include <drivers/bootloader/bootloader_sd.h>
#include <drivers/bootloader/bootloader_uart.h>
 
typedef struct Bootloader_CpuInfo_s
{
    uint32_t  cpuId;
    uint32_t  clkHz;
    uintptr_t entryPoint;
    bool      smpEnable;
 
} Bootloader_CpuInfo;
 
typedef struct Bootloader_BootImageInfo_s
{
    Bootloader_CpuInfo cpuInfo[CSL_CORE_ID_MAX];
 
} Bootloader_BootImageInfo;
 
typedef enum
{
    BOOTLOADER_IMAGE_NOT_LOADED,
    BOOTLOADER_IMAGE_LOADED
}Bootloader_AppImageLoadStatus;
 
typedef struct
{
    Bootloader_BootImageInfo bootImageInfo;
    Bootloader_Params bootParams;
    Bootloader_Handle bootHandle;
    uint8_t coreId;
    Bootloader_AppImageLoadStatus loadStatus;
}Bootloader_LoadImageParams;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Bootloader_Params_init(Bootloader_Params *params);
 
void Bootloader_BootImageInfo_init(Bootloader_BootImageInfo *bootImageInfo);
 
void Bootloader_CpuInfo_init(Bootloader_CpuInfo *cpuInfo);
 
Bootloader_Handle Bootloader_open(uint32_t instanceNum, Bootloader_Params *openParams);
 
void Bootloader_close(Bootloader_Handle handle);
 
int32_t Bootloader_runCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo);
 
int32_t Bootloader_runSelfCpu(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo);
 
void Bootloader_JumpSelfCpu(void);
 
int32_t Bootloader_bootCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo);
 
int32_t Bootloader_runSelfCpuWithLinux();
 
uint32_t Bootloader_getMulticoreImageSize(Bootloader_Handle handle);
 
uint32_t Bootloader_isCorePresent(Bootloader_Handle handle, uint32_t cslCoreId);
 
uint32_t Bootloader_getBootMedia(Bootloader_Handle handle);
 
void Bootloader_ReservedMemInit(uint32_t startAddress, uint32_t regionlength);
 
void Bootloader_powerOffCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo);
 
int32_t Bootloader_parseAndLoadMultiCoreELF(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo);
 
int32_t Bootloader_UartParseAndLoadMultiCoreELF(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo);
 
void Bootloader_openDma();
 
void Bootloader_closeDma();
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef BOOTLOADER_MCELF_H_ */