CycloneBOOT 2.6.6
Secure Bootloader for ARM Cortex-M MCU
Loading...
Searching...
No Matches
header.h File Reference

Generate the header section of an update image. More...

#include <stdint.h>
#include <time.h>
#include "ImageBuilderConfig.h"
#include "core/crc32.h"
#include "main.h"
#include "image_format.h"

Go to the source code of this file.

Classes

struct  HeaderVersionEntry
 

Macros

#define STRINGIFY(x)   #x
 
#define TOSTRING(x)   STRINGIFY(x)
 
#define IMAGE_HEADER_VERSION   (((image_builder_HEADER_VERSION_MAJOR & 0xFF) << 16) | ((image_builder_HEADER_VERSION_MINOR & 0xFF) << 8) | (image_builder_HEADER_VERSION_PATCH & 0xFF))
 
#define IMAGE_HEADER_VERSION_STRING
 
#define IMAGE_TYPE_APP_HEADER_V1_1_0   1
 

Functions

int headerMake (ImageBuild *build, ImageHeader *header, struct builder_cli_configuration *cli_options, CipherInfo cipherInfo)
 Make the image header.
 

Detailed Description

Generate the header section of an update image.

License

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

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

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

Macro Definition Documentation

◆ IMAGE_HEADER_VERSION_STRING

#define IMAGE_HEADER_VERSION_STRING
Value:
TOSTRING(image_builder_HEADER_VERSION_MAJOR) "." \
TOSTRING(image_builder_HEADER_VERSION_MINOR) "." \
TOSTRING(image_builder_HEADER_VERSION_PATCH)

Function Documentation

◆ headerMake()

int headerMake ( ImageBuild *  build,
ImageHeader *  header,
struct builder_cli_configuration *  cli_options,
CipherInfo  cipher_info 
)

Make the image header.

Parameters
[in]headerPointer to the image header
cli_optionsPointer to CLI parameters
cipher_infoPointer to Crypto stuff
Returns
Status code