tftf/tests/runtime_services/lfa/test_lfa_single_cpu.c

/*
 * Copyright (c) 2025, Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#include <debug.h>
#include <lfa.h>
#include <test_helpers.h>
#include <tftf_lib.h>

#define LFA_GET_INVENTORY_RESP_X1	UL(0x4698fe4c6d08d447)
#define LFA_GET_INVENTORY_RESP_X2	UL(0x005abdcb5029959b)

static uint64_t num_components;
static uint64_t fw_id;

/*
 * @Test_Aim@ Simple surface tests for Live Firmware Activation.
 *
 * This test checks the version number. It runs on the lead CPU.
 */
test_result_t test_lfa_version(void)
{
	smc_args args = { LFA_VERSION };
	uint32_t major, minor;
	smc_ret_values ret = tftf_smc(&args);

	major = (uint32_t)((ret.ret0 >> LFA_VERSION_MAJOR_SHIFT) & LFA_VERSION_MAJOR_MASK);
	minor = (uint32_t)((ret.ret0 >> LFA_VERSION_MINOR_SHIFT) & LFA_VERSION_MINOR_MASK);

	VERBOSE("%s LFA API Version : %d.%d\n", __func__, major, minor);

	if ((major != LFA_VERSION_MAJOR) || (minor != LFA_VERSION_MINOR)) {
		return TEST_RESULT_FAIL;
	}

	return TEST_RESULT_SUCCESS;
}

/*
 * @Test_Aim@ Test for LFA_FEATURES.
 *
 * This test checks LFA_FEATURES for the two extreme FID values and then does
 * one negative test.
 */
test_result_t test_lfa_features(void)
{
	smc_args args = { .fid = LFA_FEATURES, .arg1 = LFA_VERSION };
	smc_ret_values ret = tftf_smc(&args);

	if (ret.ret0 != SMC_OK) {
		tftf_testcase_printf("%s: Features for FID=0x%08lx returned %08lx\n",
				     __func__, args.arg1, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	args.arg1 = LFA_CANCEL;
	ret = tftf_smc(&args);
	if (ret.ret0 != SMC_OK) {
		tftf_testcase_printf("%s: Features for FID=0x%08lx returned %08lx\n",
				     __func__, args.arg1, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	args.arg1 = LFA_INVALID;
	ret = tftf_smc(&args);
	if (ret.ret0 == SMC_OK) {
		tftf_testcase_printf("%s: Features for FID=0x%08lx returned %08lx\n",
				     __func__, args.arg1, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	return TEST_RESULT_SUCCESS;
}

/*
 * @Test_Aim@ Test for LFA_GET_INFO.
 *
 * This test checks that LFA_GET_INFO returns successfully and the proper
 * error if an invalid lfa_selector is provided.
 */
test_result_t test_lfa_get_info(void)
{
	smc_args args = { .fid = LFA_GET_INFO, .arg1 = 0U };
	smc_ret_values ret = tftf_smc(&args);

	if (ret.ret0 != SMC_OK) {
		tftf_testcase_printf("%s: Unexpected error: 0x%08lx\n",
				     __func__, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	num_components = ret.ret1;

	/* Try giving invalid argument and expect Failure from SMC */
	args.arg1 = 1U;
	ret = tftf_smc(&args);
	if (ret.ret0 == SMC_OK) {
		tftf_testcase_printf("%s: Unexpected success\n", __func__);
		return TEST_RESULT_FAIL;
	}

	return TEST_RESULT_SUCCESS;
}

/*
 * @Test_Aim@ Test for LFA_GET_INVENTORY.
 */
test_result_t test_lfa_get_inventory(void)
{
	smc_args args = { .fid = LFA_GET_INVENTORY, .arg1 = 0U };
	smc_ret_values ret;

	for (uint64_t i = 0U; i < num_components; i++) {
		args.arg1 = i;

		ret = tftf_smc(&args);
		if (ret.ret0 != SMC_OK) {
			tftf_testcase_printf("%s: Unexpected error: 0x%08lx\n",
					     __func__, ret.ret0);
			return TEST_RESULT_FAIL;
		}

		if ((ret.ret1 == LFA_GET_INVENTORY_RESP_X1) &&
		    (ret.ret2 == LFA_GET_INVENTORY_RESP_X2)) {
			fw_id = i;
		}
	}

	return TEST_RESULT_SUCCESS;
}

/*
 * @Test_Aim@ Test for LFA_PRIME.
 */
test_result_t test_lfa_prime(void)
{
	smc_args args = { .fid = LFA_PRIME, .arg1 = fw_id };
	smc_ret_values ret = tftf_smc(&args);

	if (ret.ret0 == SMC_OK) {
		/*
		 * TODO: currently expected to be failed as BL31 prime
		 * is not present. This is added to exercise negative
		 * scenario.
		 */
		tftf_testcase_printf("%s: Unexpected error: 0x%08lx\n",
				     __func__, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	return TEST_RESULT_SUCCESS;
}

/*
 * @Test_Aim@ Test for LFA_ACTIVATE.
 */
test_result_t test_lfa_activate(void)
{
	smc_args args = { .fid = LFA_ACTIVATE, .arg1 = fw_id };
	smc_ret_values ret = tftf_smc(&args);

	if (ret.ret0 == SMC_OK) {
		/*
		 * TODO: currently expected to be failed as BL31 activate
		 * is not present. This is added to exercise negative
		 * scenario.
		 */
		tftf_testcase_printf("%s: Unexpected error: 0x%08lx\n",
				     __func__, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	return TEST_RESULT_SUCCESS;
}

/*
 * @Test_Aim@ Test for LFA_CANCEL.
 */
test_result_t test_lfa_cancel(void)
{
	smc_args args = { .fid = LFA_CANCEL, .arg1 = fw_id };
	smc_ret_values ret;

	ret = tftf_smc(&args);
	/*
	 * TODO: currently expected to be failed as BL31 cancel
	 * is not present. This is added to exercise negative
	 * scenario.
	 */
	if (ret.ret0 == SMC_OK) {
		tftf_testcase_printf("%s: Unexpected error: 0x%08lx\n",
				     __func__, ret.ret0);
		return TEST_RESULT_FAIL;
	}

	return TEST_RESULT_SUCCESS;
}