image_process.c File Reference

CycloneBOOT Image Process routines. More...

#include "debug.h"
#include "image/image.h"
#include "image/image_utils.h"

Macros
#define	TRACE_LEVEL   CBOOT_TRACE_LEVEL

Functions
cboot_error_t	imageProcessOutputBinary (Image *image, uint8_t *data, size_t length)
	Process parsed image input data to generate output binary. It means that we will keep only the binary part of the input image.
cboot_error_t	imageProcessOutputImage (Image *image, uint8_t *data, size_t length)
	Process parsed image input data to generate output image. The output image will can be either:
cboot_error_t	imageProcessInputImage (ImageProcessContext *context)
	Process parsed image input data.
cboot_error_t	imageProcessOutput (ImageProcessContext *context, uint8_t *data, size_t length)
	Process parsed image input data to generate the output image which can either a simple binary (no header and check information) or an image. The image can optionnaly be encrypted and/or bootable (padding added).

Detailed Description

CycloneBOOT Image Process routines.

CycloneBOOT Image Utils routines.

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

imageProcessInputImage()

cboot_error_t imageProcessInputImage

(

ImageProcessContext *

context

)

Process parsed image input data.

Parameters

[in,out]

context

Pointer to the ImageProcess context

Returns

Status code

imageProcessOutput()

cboot_error_t imageProcessOutput	(	ImageProcessContext *	context,
		uint8_t *	data,
		size_t	length
	)

Process parsed image input data to generate the output image which can either a simple binary (no header and check information) or an image. The image can optionnaly be encrypted and/or bootable (padding added).

Parameters

[in,out]	context	Pointer to the ImageProcess context
[in]	data	Output image data chunk to be processed
[in]	length	Length of the output data chunk.

Returns

Status code

imageProcessOutputBinary()

cboot_error_t imageProcessOutputBinary	(	Image *	image,
		uint8_t *	data,
		size_t	length
	)

Process parsed image input data to generate output binary. It means that we will keep only the binary part of the input image.

Parameters

[in,out]	context	Pointer to the output image context
[in]	data	Output image data chunk to be processed (comming from Input image)
[in]	length	Length of the output data chunk.

Returns

Status code

imageProcessOutputImage()

cboot_error_t imageProcessOutputImage	(	Image *	image,
		uint8_t *	data,
		size_t	length
	)

Process parsed image input data to generate output image. The output image will can be either:

• a simple image with unencrypted firmware binary and CRC32 integrity tag
• a cipher image with encrypted firmware binary and CRC32 integrity tag Also the output image can be bootable (padding added).

  Parameters

  [in,out]	context	Pointer to the output image context
  [in]	data	Output image data chunk to be processed (comming from the input image)
  [in]	length	Length of the output data chunk.

  Returns

  Status code