AM62D FreeRTOS SDK  11.01.00
bootloader_rprc.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021-2023 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 
39 #ifndef BOOTLOADER_RPRC_H_
40 #define BOOTLOADER_RPRC_H_
41 
42 /* ========================================================================== */
43 /* Include Files */
44 /* ========================================================================== */
45 
46 #include <stdint.h>
47 #include <kernel/dpl/SystemP.h>
48 #include <drivers/soc.h>
49 #include <drivers/hw_include/csl_types.h>
50 #include <drivers/hw_include/cslr_soc.h>
51 #include <drivers/hw_include/soc_config.h>
52 #include <drivers/bootloader/soc/bootloader_soc.h>
53 #include <drivers/bootloader/bootloader_profile.h>
54 
55 #ifdef __cplusplus
56 extern "C"
57 {
58 #endif
59 
69 /* ========================================================================== */
70 /* Macros & Typedefs */
71 /* ========================================================================== */
72 
76 #define BOOTLOADER_INVALID_ID ((uint32_t)0xDEADBABE)
77 
81 #define BOOTLOADER_OPMODE_LOCKSTEP (0U)
82 #define BOOTLOADER_OPMODE_STANDALONE (1U)
83 
87 #define BOOTLOADER_MEDIA_MEM ((uint32_t)0xB0070001)
88 #define BOOTLOADER_MEDIA_FLASH ((uint32_t)0xB0070002)
89 #define BOOTLOADER_MEDIA_EMMC ((uint32_t)0xB0070003)
90 #define BOOTLOADER_MEDIA_SD ((uint32_t)0xB0070004)
91 #define BOOTLOADER_MEDIA_BUFIO ((uint32_t)0xB0070005)
92 #define BOOTLOADER_MEDIA_UART ((uint32_t)0xB0070006)
93 
97 typedef void* Bootloader_Handle;
98 
99 /* ========================================================================== */
100 /* Structure Declarations */
101 /* ========================================================================== */
102 
106 typedef struct Bootloader_Params_s
107 {
109  /* Base address of the appimage in case of a memory bootloader */
110 
111  uint8_t *bufIoTempBuf;
112  /* Temporary buffer to be used if the boot media is a buffered IO */
113 
115  /* Size of the temporary buffer to be used if the boot media is a buffered IO */
116 
118  /* Instance index of the IO device driver (UART) */
119 
121 
139 typedef int32_t (*Bootloader_imgOpenFxn)(void *args, Bootloader_Params *params);
140 
153 typedef int32_t (*Bootloader_imgReadFxn)(void *dstAddr, uint32_t length, void *args);
154 
165 typedef uint32_t (*Bootloader_imgOffsetFxn)(void *args);
166 
179 typedef void (*Bootloader_imgSeekFxn)(uint32_t location, void *args);
180 
192 typedef void (*Bootloader_imgCloseFxn)(void* handle, void *args);
193 
204 typedef int32_t (*Bootloader_imgCustomFxn)(void *args);
205 
211 typedef struct Bootloader_Fxns_s
212 {
219 
221 
225 typedef struct Bootloader_Config_s
226 {
228  void *args;
229  uint32_t bootMedia;
230  uint32_t bootImageSize;
231  uint32_t coresPresentMap;
232  uint8_t *scratchMemPtr;
234  uint32_t enableDma;
236 
237 #include <drivers/bootloader/bootloader_flash.h>
238 #include <drivers/bootloader/bootloader_mem.h>
239 #include <drivers/bootloader/bootloader_buf_io.h>
240 
244 typedef struct Bootloader_CpuInfo_s
245 {
246  uint32_t cpuId;
247  uint32_t clkHz;
248  uint32_t rprcOffset;
249  uintptr_t entryPoint;
250  bool smpEnable;
251 
253 
257 typedef struct Bootloader_BootImageInfo_s
258 {
260 
262 
266 typedef enum
267 {
271 
275 typedef struct
276 {
280  uint8_t coreId;
283 
284 /* ========================================================================== */
285 /* Function Declarations */
286 /* ========================================================================== */
287 
294 
301 
308 
324 Bootloader_Handle Bootloader_open(uint32_t instanceNum, Bootloader_Params *openParams);
325 
332 
349 
365 
380 
394 
403 
418 
431 
446 
453 
460 
470 
482 
495 uint32_t Bootloader_isCorePresent(Bootloader_Handle handle, uint32_t cslCoreId);
496 
507 
508 
518 void Bootloader_ReservedMemInit(uint32_t startAddress, uint32_t regionlength);
519 
529 
543 
548 
555 #ifdef __cplusplus
556 }
557 #endif
558 
559 #endif /* #ifndef BOOTLOADER_RPRC_H_ */
CSL_CORE_ID_MAX
#define CSL_CORE_ID_MAX
Definition: cslr_soc_defines.h:79
Bootloader_Config::coresPresentMap
uint32_t coresPresentMap
Definition: bootloader_rprc.h:231
Bootloader_Config::fxns
Bootloader_Fxns * fxns
Definition: bootloader_rprc.h:227
Bootloader_isCorePresent
uint32_t Bootloader_isCorePresent(Bootloader_Handle handle, uint32_t cslCoreId)
API to check if a particular core's RPRC image is present in the multicore image.
Bootloader_Params::memArgsAppImageBaseAddr
uint32_t memArgsAppImageBaseAddr
Definition: bootloader_rprc.h:108
Bootloader_LoadImageParams::bootImageInfo
Bootloader_BootImageInfo bootImageInfo
Definition: bootloader_rprc.h:277
Bootloader_ReservedMemInit
void Bootloader_ReservedMemInit(uint32_t startAddress, uint32_t regionlength)
API to set the memory region of bootloader.
SystemP.h
Bootloader_bootSelfCpu
int32_t Bootloader_bootSelfCpu(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo)
API to boot self CPU.
Bootloader_imgCloseFxn
void(* Bootloader_imgCloseFxn)(void *handle, void *args)
Driver implementation to close a specific bootloader driver - Memory, OSPI, UART, MMCSD etc.
Definition: bootloader_rprc.h:192
Bootloader_rprcImageParseEntryPoint
int32_t Bootloader_rprcImageParseEntryPoint(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
Parse entrypoint from RPRC.
Bootloader_getBootMedia
uint32_t Bootloader_getBootMedia(Bootloader_Handle handle)
API to get the selected boot media in the bootloader instance.
Bootloader_Fxns::imgOpenFxn
Bootloader_imgOpenFxn imgOpenFxn
Definition: bootloader_rprc.h:213
Bootloader_BootImageInfo_init
void Bootloader_BootImageInfo_init(Bootloader_BootImageInfo *bootImageInfo)
Initialize BootImage info.
BOOTLOADER_IMAGE_NOT_LOADED
@ BOOTLOADER_IMAGE_NOT_LOADED
Definition: bootloader_rprc.h:268
Bootloader_LoadImageParams::loadStatus
Bootloader_AppImageLoadStatus loadStatus
Definition: bootloader_rprc.h:281
Bootloader_Params::bufIoDeviceIndex
uint32_t bufIoDeviceIndex
Definition: bootloader_rprc.h:117
Bootloader_Params_init
void Bootloader_Params_init(Bootloader_Params *params)
Initialize Bootloader params.
Bootloader_getMulticoreImageSize
uint32_t Bootloader_getMulticoreImageSize(Bootloader_Handle handle)
API to fetch the size of the multicore image.
Bootloader_LoadImageParams::bootParams
Bootloader_Params bootParams
Definition: bootloader_rprc.h:278
Bootloader_JumpSelfCpu
void Bootloader_JumpSelfCpu(void)
API to jump self CPU.
Bootloader_CpuInfo::rprcOffset
uint32_t rprcOffset
Definition: bootloader_rprc.h:248
Bootloader_Config::args
void * args
Definition: bootloader_rprc.h:228
Bootloader_Fxns::imgSeekFxn
Bootloader_imgSeekFxn imgSeekFxn
Definition: bootloader_rprc.h:216
Bootloader_Params::bufIoTempBuf
uint8_t * bufIoTempBuf
Definition: bootloader_rprc.h:111
Bootloader_parseMultiCoreAppImage
int32_t Bootloader_parseMultiCoreAppImage(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo)
Parse Multicore Appimage.
Bootloader_Config
Bootloader driver configuration, these are filled by SysCfg based on the boot media selected.
Definition: bootloader_rprc.h:226
Bootloader_LoadImageParams::coreId
uint8_t coreId
Definition: bootloader_rprc.h:280
Bootloader_imgCustomFxn
int32_t(* Bootloader_imgCustomFxn)(void *args)
Driver implementation to enable a custom function for a specific bootloader driver - Memory,...
Definition: bootloader_rprc.h:204
Bootloader_imgOffsetFxn
uint32_t(* Bootloader_imgOffsetFxn)(void *args)
Driver implementation to get the current offset in the boot media.
Definition: bootloader_rprc.h:165
Bootloader_Fxns::imgOffsetFxn
Bootloader_imgOffsetFxn imgOffsetFxn
Definition: bootloader_rprc.h:215
Bootloader_close
void Bootloader_close(Bootloader_Handle handle)
Close bootloader driver.
Bootloader_Config::socCoreOpMode
void * socCoreOpMode
Definition: bootloader_rprc.h:233
Bootloader_bootCpu
int32_t Bootloader_bootCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
API to boot a non-self CPU.
Bootloader_runCpu
int32_t Bootloader_runCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
API to run a non-self CPU.
Bootloader_Config::bootImageSize
uint32_t bootImageSize
Definition: bootloader_rprc.h:230
Bootloader_AppImageLoadStatus
Bootloader_AppImageLoadStatus
AppImage load status.
Definition: bootloader_rprc.h:267
Bootloader_runSelfCpuWithLinux
int32_t Bootloader_runSelfCpuWithLinux()
API to boot self CPU with Linux.
Bootloader_Params::bufIoTempBufSize
uint32_t bufIoTempBufSize
Definition: bootloader_rprc.h:114
Bootloader_CpuInfo::clkHz
uint32_t clkHz
Definition: bootloader_rprc.h:247
Bootloader_CpuInfo::cpuId
uint32_t cpuId
Definition: bootloader_rprc.h:246
Bootloader_CpuInfo
Data structure containing information related to a particular CPU, required for RPRC loading.
Definition: bootloader_rprc.h:245
Bootloader_loadSelfCpu
int32_t Bootloader_loadSelfCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
API to load self CPU.
Bootloader_imgOpenFxn
int32_t(* Bootloader_imgOpenFxn)(void *args, Bootloader_Params *params)
Driver implementation to open a specific bootloader driver - Memory, OSPI, UART, MMCSD etc.
Definition: bootloader_rprc.h:139
Bootloader_powerOffCpu
void Bootloader_powerOffCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
API to power off a core.
Bootloader_BootImageInfo
Data structure containing information related all CPUs, this will be filled by Bootloader_parseMultiC...
Definition: bootloader_rprc.h:258
Bootloader_Config::bootMedia
uint32_t bootMedia
Definition: bootloader_rprc.h:229
Bootloader_runSelfCpu
int32_t Bootloader_runSelfCpu(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo)
API to boot self CPU.
Bootloader_Fxns::imgCustomFxn
Bootloader_imgCustomFxn imgCustomFxn
Definition: bootloader_rprc.h:218
Bootloader_rprcImageLoad
int32_t Bootloader_rprcImageLoad(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
Load application binaries into SOC memory.
Bootloader_imgSeekFxn
void(* Bootloader_imgSeekFxn)(uint32_t location, void *args)
Driver implementation to move read offset on boot media using a specific bootloader driver - Memory,...
Definition: bootloader_rprc.h:179
Bootloader_CpuInfo::smpEnable
bool smpEnable
Definition: bootloader_rprc.h:250
Bootloader_Fxns::imgCloseFxn
Bootloader_imgCloseFxn imgCloseFxn
Definition: bootloader_rprc.h:217
Bootloader_Fxns
Driver implementation callbacks.
Definition: bootloader_rprc.h:212
Bootloader_openDma
void Bootloader_openDma()
API to open DMA channel.
Bootloader_LoadImageParams::bootHandle
Bootloader_Handle bootHandle
Definition: bootloader_rprc.h:279
Bootloader_parseAppImage
int32_t Bootloader_parseAppImage(Bootloader_Handle handle, Bootloader_BootImageInfo *bootImageInfo)
API to Parse Multicore Appimage.
Bootloader_imgReadFxn
int32_t(* Bootloader_imgReadFxn)(void *dstAddr, uint32_t length, void *args)
Driver implementation to read from boot media using a specific bootloader driver - Memory,...
Definition: bootloader_rprc.h:153
Bootloader_Handle
void * Bootloader_Handle
Handle to the Bootloader driver returned by Bootloader_open()
Definition: bootloader_rprc.h:97
Bootloader_Config::enableDma
uint32_t enableDma
Definition: bootloader_rprc.h:234
Bootloader_CpuInfo_init
void Bootloader_CpuInfo_init(Bootloader_CpuInfo *cpuInfo)
Initialize CPU info.
Bootloader_closeDma
void Bootloader_closeDma()
API to close DMA channel.
Bootloader_Params
Parameters passed during Bootloader_open()
Definition: bootloader_rprc.h:107
Bootloader_open
Bootloader_Handle Bootloader_open(uint32_t instanceNum, Bootloader_Params *openParams)
Open bootloader driver.
Bootloader_loadCpu
int32_t Bootloader_loadCpu(Bootloader_Handle handle, Bootloader_CpuInfo *cpuInfo)
API to load a non-self CPU.
Bootloader_Config::scratchMemPtr
uint8_t * scratchMemPtr
Definition: bootloader_rprc.h:232
Bootloader_CpuInfo::entryPoint
uintptr_t entryPoint
Definition: bootloader_rprc.h:249
BOOTLOADER_IMAGE_LOADED
@ BOOTLOADER_IMAGE_LOADED
Definition: bootloader_rprc.h:269
Bootloader_LoadImageParams
Data structure containing necessary structs to load AppImage on different CPUs.
Definition: bootloader_rprc.h:276
Bootloader_Fxns::imgReadFxn
Bootloader_imgReadFxn imgReadFxn
Definition: bootloader_rprc.h:214