boot.c File Reference

CycloneBOOT 2nd Stage Bootloader management. More...

#include "second_stage/boot.h"
#include "core/flash.h"
#include "image/image.h"
#include "second_stage/boot_common.h"
#include "second_stage/boot_fallback.h"
#include "core/mailbox.h"
#include "core/cboot_error.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL   CBOOT_TRACE_LEVEL

Functions
cboot_error_t	bootGetCipherKey (BootContext *context)
	Get PSK cipher key used to encrypt output image in external flash memory.
cboot_error_t	bootJumpToApp (BootContext *context)
	Jump to the application binary inside the current image in internal flash.
void	bootGetDefaultSettings (BootSettings *settings)
	Initialize bootloader settings with default values.
cboot_error_t	bootInit (BootContext *context, BootSettings *settings)
	Initialize bootloader context.
cboot_error_t	bootFsm (BootContext *context)
	Bootloader Task routine.

Detailed Description

CycloneBOOT 2nd Stage Bootloader management.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2021-2026 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneBOOT Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.6.6

Function Documentation

bootFsm()

cboot_error_t bootFsm

(

BootContext *

context

)

Bootloader Task routine.

Parameters

[in]

context

Pointer to Bootloader context

Returns

cboot_error_t

bootGetCipherKey()

cboot_error_t bootGetCipherKey

(

BootContext *

context

)

Get PSK cipher key used to encrypt output image in external flash memory.

Parameters

[in,out]

context

Pointer to the bootloader context

bootGetDefaultSettings()

void bootGetDefaultSettings

(

BootSettings *

settings

)

Initialize bootloader settings with default values.

Initialize first-stage bootloader settings with default values.

Parameters

[in,out]

settings

Structure that contains Bootloader settings

bootInit()

cboot_error_t bootInit	(	BootContext *	context,
		BootSettings *	settings
	)

Initialize bootloader context.

Initialize the first-stage bootloader context from user settings.

Parameters

[in,out]	context	Bootloader context
[in]	settings	Bootloader user settings

Returns

Status code

bootJumpToApp()

cboot_error_t bootJumpToApp

(

BootContext *

context

)

Jump to the application binary inside the current image in internal flash.

Parameters

[in]

context

Pointer to the bootloader context

Returns

Status code