commit e3e570653471af3506846f06b5fe0421970adce4
author Karl Meakin <karl.meakin@arm.com> Thu Jan 18 14:28:36 2024 +0000
committer Karl Meakin <karl.meakin@arm.com> Fri Apr 12 17:16:00 2024 +0100
tree f1a6c8a23f0a06e442d058b2ad22034f6e0febb5
parent 52f0b0ac70de3701d642cd59044aa70ffa342e40

feat(ffa-svc): add `ffa_func_name` and `ffa_error_name`

Adds helper functions for getting string representations of function
identifiers and error codes. This makes debug logs more readable than
printing the integer value.

Change-Id: I9e74c197686dc08e0c71886f641c60829587bad6
Signed-off-by: Karl Meakin <karl.meakin@arm.com>

spm/cactus/cactus_main.c

diff --git a/spm/cactus/cactus_main.c b/spm/cactus/cactus_main.c
index b3f7451..141f1fe 100644
--- a/spm/cactus/cactus_main.c
+++ b/spm/cactus/cactus_main.c
@@ -61,10 +61,12 @@
 	ffa_ret = ffa_msg_wait();
 
 	for (;;) {
-		VERBOSE("Woke up with func id: %x\n", ffa_func_id(ffa_ret));
+		VERBOSE("Woke up with func id: %s\n",
+			ffa_func_name(ffa_func_id(ffa_ret)));
 
 		if (ffa_func_id(ffa_ret) == FFA_ERROR) {
-			ERROR("Error: %x\n", ffa_error_code(ffa_ret));
+			ERROR("Error: %s\n",
+			      ffa_error_name(ffa_error_code(ffa_ret)));
 			break;
 		}
 
@@ -72,8 +74,8 @@
 		    ffa_func_id(ffa_ret) != FFA_MSG_SEND_DIRECT_REQ_SMC64 &&
 		    ffa_func_id(ffa_ret) != FFA_INTERRUPT &&
 		    ffa_func_id(ffa_ret) != FFA_RUN) {
-			ERROR("%s(%u) unknown func id 0x%x\n",
-				__func__, vm_id, ffa_func_id(ffa_ret));
+			ERROR("%s(%u) unknown func id %s\n", __func__, vm_id,
+			      ffa_func_name(ffa_func_id(ffa_ret)));
 			break;
 		}
 
@@ -304,9 +306,8 @@
 		VERBOSE("Mapping RXTX Region\n");
 		CONFIGURE_AND_MAP_MAILBOX(mb, PAGE_SIZE, ret);
 		if (ffa_func_id(ret) != FFA_SUCCESS_SMC32) {
-			ERROR(
-			    "Failed to map RXTX buffers. Error: %x\n",
-			    ffa_error_code(ret));
+			ERROR("Failed to map RXTX buffers. Error: %s\n",
+			      ffa_error_name(ffa_error_code(ret)));
 			panic();
 		}
 	}

spm/common/sp_tests/sp_test_ffa.c

diff --git a/spm/common/sp_tests/sp_test_ffa.c b/spm/common/sp_tests/sp_test_ffa.c
index 219b149..63bf131 100644
--- a/spm/common/sp_tests/sp_test_ffa.c
+++ b/spm/common/sp_tests/sp_test_ffa.c
@@ -99,18 +99,20 @@
 				test_target.expected_ret : FFA_ERROR;
 
 		if (ffa_func_id(ffa_ret) != expected_ret) {
-			ERROR("Unexpected return: %x (expected %x)."
+			ERROR("Unexpected return: %s (expected %s)."
 			      " FFA_FEATURES test: %s.\n",
-			      ffa_func_id(ffa_ret), expected_ret,
+			      ffa_func_name(ffa_func_id(ffa_ret)),
+			      ffa_func_name(expected_ret),
 			      test_target.test_name);
 		}
 
 		if (expected_ret == FFA_ERROR) {
 			if (ffa_error_code(ffa_ret) !=
 			    FFA_ERROR_NOT_SUPPORTED) {
-				ERROR("Unexpected error code: %x (expected %x)."
+				ERROR("Unexpected error code: %s (expected %s)."
 				      " FFA_FEATURES test: %s.\n",
-				      ffa_error_code(ffa_ret), expected_ret,
+				      ffa_error_name(ffa_error_code(ffa_ret)),
+				      ffa_error_name(expected_ret),
 				      test_target.test_name);
 			}
 		}

spm/ivy/app/ivy_main.c

diff --git a/spm/ivy/app/ivy_main.c b/spm/ivy/app/ivy_main.c
index 1e2cd6a..861ef30 100644
--- a/spm/ivy/app/ivy_main.c
+++ b/spm/ivy/app/ivy_main.c
@@ -42,8 +42,8 @@
 	VERBOSE("Mapping RXTX Regions\n");
 	CONFIGURE_AND_MAP_MAILBOX(mb, PAGE_SIZE, ret);
 	if (ffa_func_id(ret) != FFA_SUCCESS_SMC32) {
-		ERROR("Failed to map RXTX buffers. Error %x\n",
-		      ffa_error_code(ret));
+		ERROR("Failed to map RXTX buffers. Error %s\n",
+		      ffa_error_name(ffa_error_code(ret)));
 		panic();
 	}
 
@@ -53,7 +53,8 @@
 
 	while (1) {
 		if (ffa_func_id(ret) != FFA_MSG_SEND_DIRECT_REQ_SMC32) {
-			ERROR("unknown FF-A request %x\n", ffa_func_id(ret));
+			ERROR("unknown FF-A request %s\n",
+			      ffa_func_name(ffa_func_id(ret)));
 			goto init;
 		}