patch.h

Go to the documentation of this file.

 
#ifndef INFUSE_SDK_INCLUDE_INFUSE_PATCH_BINARY_H_
#define INFUSE_SDK_INCLUDE_INFUSE_PATCH_BINARY_H_
 
#include <stdint.h>
 
#include <zephyr/storage/flash_map.h>
#include <zephyr/storage/stream_flash.h>
#include <zephyr/toolchain.h>
 
#include <infuse/util/progress_cb.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define CPATCH_MAGIC_NUMBER 0xBA854092

struct cpatch_array_validation {
        /* Length of the memory region in bytes */
        uint32_t length;
        /* CRC32-IEEE of the memory region */
        uint32_t crc;
} __packed;

struct cpatch_header {
        /* Expected to match @ref CPATCH_MAGIC_NUMBER */
        uint32_t magic_value;
        /* Major version number of CPatch algorithm this file was generated for */
        uint8_t version_major;
        /* Minor version number of CPatch algorithm this file was generated for */
        uint8_t version_minor;
        /* Input file validation */
        struct cpatch_array_validation input_file;
        /* Output file validation */
        struct cpatch_array_validation output_file;
        /* Patch data validation */
        struct cpatch_array_validation patch_file;
        /* CRC32-IEEE of the preceding data in the header */
        uint32_t header_crc;
} __packed;

typedef void (*cpatch_progress_cb_t)(size_t output_offset);

int cpatch_patch_start(const struct flash_area *input, const struct flash_area *patch,
                       struct cpatch_header *header);

int cpatch_patch_apply(const struct flash_area *input, const struct flash_area *patch,
                       struct stream_flash_ctx *output, struct cpatch_header *header,
                       infuse_progress_cb_t progress_cb);

 
#ifdef __cplusplus
}
#endif
 
#endif /* INFUSE_SDK_INCLUDE_INFUSE_PATCH_BINARY_H_ */