mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
91 lines
2.1 KiB
C
91 lines
2.1 KiB
C
/*
|
|
* Copyright (C) 2018 Kaspar Schleiser <kaspar@schleiser.de>
|
|
* 2018 Inria
|
|
* 2018 Freie Universität Berlin
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup sys_riotboot_hdr RIOT header helpers and tools
|
|
* @ingroup sys
|
|
* @{
|
|
*
|
|
* The header contains
|
|
*
|
|
* - "RIOT" as magic number
|
|
* - the application version
|
|
* - the address where the RIOT firmware is found
|
|
* - the checksum of the three previous fields
|
|
*
|
|
* @file
|
|
* @brief RIOT "partition" header and tools
|
|
*
|
|
* @author Kaspar Schleiser <kaspar@schleiser.de>
|
|
* @author Francisco Acosta <francisco.acosta@inria.fr>
|
|
*
|
|
* @}
|
|
*/
|
|
|
|
#ifndef RIOTBOOT_HDR_H
|
|
#define RIOTBOOT_HDR_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* @brief Magic number for riotboot_hdr
|
|
*
|
|
*/
|
|
#define RIOTBOOT_MAGIC 0x544f4952 /* "RIOT" */
|
|
|
|
/**
|
|
* @brief Structure to store image header - All members are little endian
|
|
* @{
|
|
*/
|
|
typedef struct {
|
|
uint32_t magic_number; /**< Header magic number (always "RIOT") */
|
|
uint32_t version; /**< Integer representing the partition version */
|
|
uint32_t start_addr; /**< Address after the allocated space for the header */
|
|
uint32_t chksum; /**< Checksum of riotboot_hdr */
|
|
} riotboot_hdr_t;
|
|
/** @} */
|
|
|
|
/**
|
|
* @brief Print formatted riotboot_hdr_t to STDIO
|
|
*
|
|
* @param[in] riotboot_hdr ptr to image header
|
|
*
|
|
*/
|
|
void riotboot_hdr_print(const riotboot_hdr_t *riotboot_hdr);
|
|
|
|
/**
|
|
* @brief Validate image header
|
|
*
|
|
* @param[in] riotboot_hdr ptr to image header
|
|
*
|
|
* @returns 0 if OK
|
|
* @returns -1 if not OK
|
|
*/
|
|
int riotboot_hdr_validate(const riotboot_hdr_t *riotboot_hdr);
|
|
|
|
/**
|
|
* @brief Calculate header checksum
|
|
*
|
|
* @param[in] riotboot_hdr ptr to image header
|
|
*
|
|
* @returns the checksum of the given riotboot_hdr
|
|
*/
|
|
uint32_t riotboot_hdr_checksum(const riotboot_hdr_t *riotboot_hdr);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* RIOTBOOT_HDR_H */
|