suit_get_install_candidate_info()

suit_ssf_err_t suit_get_install_candidate_info	(	suit_manifest_class_id_t *	manifest_class_id,
		unsigned int *	seq_num,
		suit_semver_raw_t *	version,
		int *	alg_id,
		suit_plat_mreg_t *	digest )

Check validity and read information about the update candidate.

In the SUIT-based system, the firmware is identified by its digest. This function allows to inform an application about the revision and digest of the update candidate.

Parameters

[out]	manifest_class_id	Manifest class ID.
[out]	seq_num	Pointer to the memory to store the current root manifest sequence number value.
[out]	version	Manifest semantic version.
[out]	alg_id	ID of an algorithm that was used to calculate the digest.
[out]	digest	Pointer to the memory to store the digest of the current root manifest value.

Return values

SUIT_PLAT_SUCCESS	if successful.
SUIT_PLAT_ERR_INVAL	if input parameters are invalid.
SUIT_PLAT_ERR_SIZE	if the manifest version output buffer is too small.
SUIT_PLAT_ERR_NOMEM	if the manifest digest or class ID is invalid.
SUIT_PLAT_ERR_HW_NOT_READY	if device manging SUIT storage is not initialized.
SUIT_PLAT_ERR_BUSY	if SUIT decoder is currently busy.
SUIT_PLAT_ERR_NOT_FOUND	if SUIT storage does not contain information about the update candidate.
SUIT_PLAT_ERR_IPC	in case of SSF protocol error.