update.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_UPDATE_H_
#define ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_UPDATE_H_
 
#include <stdint.h>
#include <stddef.h>
 
#define IRONSIDE_UPDATE_ERROR_NOT_PERMITTED     (1)
#define IRONSIDE_UPDATE_ERROR_SICR_WRITE_FAILED (2)
 
#define IRONSIDE_UPDATE_MANIFEST_LENGTH  (256)
#define IRONSIDE_UPDATE_PUBKEY_LENGTH    (32)
#define IRONSIDE_UPDATE_SIGNATURE_LENGTH (64)
 
/* IRONside call identifiers with implicit versions.
 *
 * With the initial "version 0", the service ABI is allowed to break until the
 * first production release of IRONside SE.
 */
#define IRONSIDE_CALL_ID_UPDATE_SERVICE_V0 1
 
/* Index of the update blob pointer within the service buffer. */
#define IRONSIDE_UPDATE_SERVICE_UPDATE_PTR_IDX (0)
/* Index of the return code within the service buffer. */
#define IRONSIDE_UPDATE_SERVICE_RETCODE_IDX (0)
 
struct ironside_update_blob {
        uint8_t manifest[IRONSIDE_UPDATE_MANIFEST_LENGTH];
        uint8_t pubkey[IRONSIDE_UPDATE_PUBKEY_LENGTH];
        uint8_t signature[IRONSIDE_UPDATE_SIGNATURE_LENGTH];
        uint32_t firmware[];
};
 
int ironside_update(const struct ironside_update_blob *update);
 
#endif /* ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_UPDATE_H_ */