boot_recovery.c File Reference

CycloneBOOT standalone bootloader recovery. More...

#include "standalone/boot.h"
#include "standalone/boot_recovery.h"
#include "core/mailbox.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL   CBOOT_TRACE_LEVEL

Functions
cboot_error_t	bootRecoveryCheckBootFailures (bool_t *exhausted)
	Checks whether the boot attempt limit has been reached.
cboot_error_t	bootRecoveryGetAction (RecoveryReason reason, RecoveryAction *action)
	Selects the recovery action for a given reason. The hook decides, then any action the build cannot honour is refused.
__weak_func cboot_error_t	bootRecoveryHook (RecoveryReason reason, RecoveryAction *action)
	Recovery action callback. It is declared weak and may be replaced in the user code space. The default restores the factory image when the build provides one, and otherwise waits for a new image.

Detailed Description

CycloneBOOT standalone bootloader recovery.

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

bootRecoveryCheckBootFailures()

cboot_error_t bootRecoveryCheckBootFailures

(

bool_t *

exhausted

)

Checks whether the boot attempt limit has been reached.

Parameters

[out]

exhausted

TRUE when the limit is reached

Returns

Error code.

bootRecoveryGetAction()

cboot_error_t bootRecoveryGetAction	(	RecoveryReason	reason,
		RecoveryAction *	action
	)

Selects the recovery action for a given reason. The hook decides, then any action the build cannot honour is refused.

Parameters

[in]	reason	Reason recovery was entered
[out]	action	Action to be performed

Returns

Error code.

bootRecoveryHook()

__weak_func cboot_error_t bootRecoveryHook	(	RecoveryReason	reason,
		RecoveryAction *	action
	)

Recovery action callback. It is declared weak and may be replaced in the user code space. The default restores the factory image when the build provides one, and otherwise waits for a new image.

Parameters

[in]	reason	Reason recovery was entered
[out]	action	Action to be performed

Returns

Error code.