update_misc.h File Reference

CycloneBOOT IAP Miscellaneous Functions API. More...

#include "error.h"
#include "update/update.h"

Go to the source code of this file.

Functions
cboot_error_t	updateInitInputImage (UpdateSettings *settings, UpdateContext *context)
	Initialize input (update) image settings. It will setup all settings needed to process the input image, especially the cryptographic settings.
cboot_error_t	updateInitOutputImage (UpdateSettings *settings, UpdateContext *context, Slot *slot, uint32_t imageIdx)
	Initialize Output Image settings. It will setup all settings needed to generate the output image.
cboot_error_t	updateGetImageHeaderFromSlot (Slot *slot, ImageHeader *header)
	This function retrieves the header of the image contained in the given flash memory slot. The given slot can be an primary (internal) or secondary (external) flash slot.

Detailed Description

CycloneBOOT IAP Miscellaneous Functions API.

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

updateGetImageHeaderFromSlot()

cboot_error_t updateGetImageHeaderFromSlot	(	Slot *	slot,
		ImageHeader *	header
	)

This function retrieves the header of the image contained in the given flash memory slot. The given slot can be an primary (internal) or secondary (external) flash slot.

Parameters

[in]	slot	Pointer to given slot that contained the image header to be extracted.
[out]	header	Pointer to store the extracted image header.

Returns

Error code.

updateInitInputImage()

cboot_error_t updateInitInputImage	(	UpdateSettings *	settings,
		UpdateContext *	context
	)

Initialize input (update) image settings. It will setup all settings needed to process the input image, especially the cryptographic settings.

Parameters

[in,out]	settings	Pointer to the user IAP settings.
[in,out]	context	Pointer to the IAP context.

Returns

Error code

updateInitOutputImage()

cboot_error_t updateInitOutputImage	(	UpdateSettings *	settings,
		UpdateContext *	context,
		Slot *	slot,
		uint32_t	imageIdx
	)

Initialize Output Image settings. It will setup all settings needed to generate the output image.

• If CycloneBOOT IAP is configured in DUal bank mode then the output message will be the new application firmware binary that was contained inside the input (update) image.
• Else the output image will be:
  • an image with encrypted application binary and simple crc32 check (if encryption on external memory is activated)
  • or a simple image with non encrypted application binary and simple crc32

    Parameters

    [in,out]	settings	Pointer to the user IAP settings.
    [in,out]	context	Pointer to the IAP context.
    [in]	slot	Slot the output image is written to.
    [in]	imageIdx	Index given to the output image.

    Returns

    Error code