SPM: Rename 'spm/common' into 'spm/ffm'

The name 'common' confused a bit, as its real purpose is for general
FF-M API implementation. Rename this folder as the first step for
re-structure patches.

There are some 'common' folder legacies still in the renamed 'ffm'
folder. They will be updated in the following patches.

Change-Id: Ic72fcf9ecf47f2185a82761edfdcbcd3c4569421
Signed-off-by: Ken Liu <Ken.Liu@arm.com>
diff --git a/docs/contributing/code_review_guide.rst b/docs/contributing/code_review_guide.rst
index e9470e6..8bbf33a 100644
--- a/docs/contributing/code_review_guide.rst
+++ b/docs/contributing/code_review_guide.rst
@@ -78,7 +78,7 @@
 
 .. code-block:: c
 
-  /* R3.1 FILE: s/spm/common/psa_client.c */
+  /* R3.1 FILE: s/spm/ffm/psa_client.c */
 
   /* R3.2 FILE: s/spm/cmsis_psa/tfm_secure_context.c */
 
@@ -86,10 +86,10 @@
 
   /* R3.4 FILE: s/spm/cmsis_psa/main.c, 'main' is a good entry name. */
   void main(void);
-  /* R3.4 FILE: s/spm/common/spm.c, 'spm\_' as the namespace */
+  /* R3.4 FILE: s/spm/ffm/spm.c, 'spm\_' as the namespace */
   void spm_init(void);
 
-  /* R3.5 FILE: s/spm/common/main.c */
+  /* R3.5 FILE: s/spm/ffm/main.c */
   static void init_functions(void);
 
   /* R3.6 Not permitted: */
@@ -105,7 +105,7 @@
     external MACRO wrapped assembler code is allowed. Here is one example of the
     logic folder:
 
-    - 'secure_fw/spm/common'.
+    - 'secure_fw/spm/ffm'.
 
 Examples:
 
@@ -113,7 +113,7 @@
 
   /*
    * R4.1 The following MACRO is allowed to be referenced under
-   * 'secure_fw/spm/common'
+   * 'secure_fw/spm/ffm'
    */
   #define SVC(code) __asm volatile("svc  %0", ::"I"(code))
 
diff --git a/docs/design_documents/source_structure.rst b/docs/design_documents/source_structure.rst
index 208c7bf..a549bf7 100644
--- a/docs/design_documents/source_structure.rst
+++ b/docs/design_documents/source_structure.rst
@@ -145,7 +145,7 @@
 Folder name                         Purpose
 =================================== ===========================================
 include/\*                          SPM public headers.
-common/\*                           SPM common logic complies with PSA-FF-M and
+ffm/\*                              SPM logic complies with PSA-FF-M and
                                     its necessary supporting functionalities,
                                     such as the runtime API and the thread
                                     operation, etc.
diff --git a/secure_fw/spm/CMakeLists.txt b/secure_fw/spm/CMakeLists.txt
index a3bb541..8427180 100755
--- a/secure_fw/spm/CMakeLists.txt
+++ b/secure_fw/spm/CMakeLists.txt
@@ -1,5 +1,5 @@
 #-------------------------------------------------------------------------------
-# Copyright (c) 2020, Arm Limited. All rights reserved.
+# Copyright (c) 2020-2021, Arm Limited. All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 #
@@ -31,20 +31,20 @@
 
 target_sources(tfm_spm
     PRIVATE
-        common/tfm_boot_data.c
-        common/tfm_core_utils.c
-        common/utilities.c
-        $<$<NOT:$<STREQUAL:${TFM_SPM_LOG_LEVEL},${TFM_SPM_LOG_LEVEL_SILENCE}>>:common/spm_log.c>
+        ffm/tfm_boot_data.c
+        ffm/tfm_core_utils.c
+        ffm/utilities.c
+        $<$<NOT:$<STREQUAL:${TFM_SPM_LOG_LEVEL},${TFM_SPM_LOG_LEVEL_SILENCE}>>:ffm/spm_log.c>
         $<$<BOOL:${TFM_MULTI_CORE_TOPOLOGY}>:cmsis_psa/tfm_multi_core.c>
         $<$<BOOL:${TFM_MULTI_CORE_TOPOLOGY}>:cmsis_psa/tfm_multi_core_mem_check.c>
         $<$<BOOL:${TFM_MULTI_CORE_TOPOLOGY}>:cmsis_psa/tfm_rpc.c>
         $<$<BOOL:${TFM_MULTI_CORE_TOPOLOGY}>:cmsis_psa/tfm_spe_mailbox.c>
-        $<$<NOT:$<BOOL:${TFM_PSA_API}>>:common/tfm_core_mem_check.c>
+        $<$<NOT:$<BOOL:${TFM_PSA_API}>>:ffm/tfm_core_mem_check.c>
         $<$<BOOL:${TFM_PSA_API}>:cmsis_psa/arch/tfm_arch.c>
         $<$<BOOL:${TFM_PSA_API}>:cmsis_psa/main.c>
         $<$<BOOL:${TFM_PSA_API}>:cmsis_psa/spm_ipc.c>
-        $<$<BOOL:${TFM_PSA_API}>:common/spm_psa_client_call.c>
-        $<$<BOOL:${TFM_PSA_API}>:common/psa_client_service_apis.c>
+        $<$<BOOL:${TFM_PSA_API}>:ffm/spm_psa_client_call.c>
+        $<$<BOOL:${TFM_PSA_API}>:ffm/psa_client_service_apis.c>
         $<$<BOOL:${TFM_PSA_API}>:cmsis_psa/tfm_core_svcalls_ipc.c>
         $<$<AND:$<BOOL:${TFM_PSA_API}>,$<NOT:$<BOOL:${TFM_MULTI_CORE_TOPOLOGY}>>>:cmsis_psa/tfm_nspm_ipc.c>
         $<$<BOOL:${TFM_PSA_API}>:cmsis_psa/tfm_pools.c>
diff --git a/secure_fw/spm/cmsis_func/main.c b/secure_fw/spm/cmsis_func/main.c
index 2dde940..259293b 100644
--- a/secure_fw/spm/cmsis_func/main.c
+++ b/secure_fw/spm/cmsis_func/main.c
@@ -1,12 +1,12 @@
 /*
- * Copyright (c) 2017-2020, Arm Limited. All rights reserved.
+ * Copyright (c) 2017-2021, Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: BSD-3-Clause
  *
  */
 
 #include "arch.h"
-#include "common/tfm_boot_data.h"
+#include "ffm/tfm_boot_data.h"
 #include "region.h"
 #include "spm_func.h"
 #include "tfm_hal_defs.h"
diff --git a/secure_fw/spm/cmsis_func/tfm_core_svcalls_func.c b/secure_fw/spm/cmsis_func/tfm_core_svcalls_func.c
index e7fb2db..95a95ae 100644
--- a/secure_fw/spm/cmsis_func/tfm_core_svcalls_func.c
+++ b/secure_fw/spm/cmsis_func/tfm_core_svcalls_func.c
@@ -17,7 +17,7 @@
 #include "tfm_arch.h"
 #include "tfm_peripherals_def.h"
 #include "tfm_irq_list.h"
-#include "common/tfm_boot_data.h"
+#include "ffm/tfm_boot_data.h"
 
 #ifdef PLATFORM_SVC_HANDLERS
 extern int32_t platform_svc_handlers(tfm_svc_number_t svc_num,
diff --git a/secure_fw/spm/cmsis_psa/main.c b/secure_fw/spm/cmsis_psa/main.c
index 8826a73..7b8cb0c 100644
--- a/secure_fw/spm/cmsis_psa/main.c
+++ b/secure_fw/spm/cmsis_psa/main.c
@@ -5,7 +5,7 @@
  *
  */
 
-#include "common/tfm_boot_data.h"
+#include "ffm/tfm_boot_data.h"
 #include "region.h"
 #include "spm_ipc.h"
 #include "tfm_hal_platform.h"
diff --git a/secure_fw/spm/cmsis_psa/tfm_core_svcalls_ipc.c b/secure_fw/spm/cmsis_psa/tfm_core_svcalls_ipc.c
index 8b3b004..39afae1 100644
--- a/secure_fw/spm/cmsis_psa/tfm_core_svcalls_ipc.c
+++ b/secure_fw/spm/cmsis_psa/tfm_core_svcalls_ipc.c
@@ -14,8 +14,8 @@
 #include "tfm_svcalls.h"
 #include "utilities.h"
 #include "tfm/tfm_core_svc.h"
-#include "common/tfm_boot_data.h"
-#include "common/psa_client_service_apis.h"
+#include "ffm/tfm_boot_data.h"
+#include "ffm/psa_client_service_apis.h"
 #include "tfm_hal_spm_logdev.h"
 
 /* The section names come from the scatter file */
diff --git a/secure_fw/spm/cmsis_psa/tfm_rpc.c b/secure_fw/spm/cmsis_psa/tfm_rpc.c
index 08b4bd4..ac2de38 100644
--- a/secure_fw/spm/cmsis_psa/tfm_rpc.c
+++ b/secure_fw/spm/cmsis_psa/tfm_rpc.c
@@ -6,7 +6,7 @@
  */
 
 #include "spm_ipc.h"
-#include "common/spm_psa_client_call.h"
+#include "ffm/spm_psa_client_call.h"
 #include "tfm_rpc.h"
 #include "utilities.h"
 
diff --git a/secure_fw/spm/common/psa_client_service_apis.c b/secure_fw/spm/ffm/psa_client_service_apis.c
similarity index 99%
rename from secure_fw/spm/common/psa_client_service_apis.c
rename to secure_fw/spm/ffm/psa_client_service_apis.c
index 93ffbcb..be24561 100644
--- a/secure_fw/spm/common/psa_client_service_apis.c
+++ b/secure_fw/spm/ffm/psa_client_service_apis.c
@@ -6,7 +6,7 @@
  */
 
 #include <stdint.h>
-#include "common/spm_psa_client_call.h"
+#include "spm_psa_client_call.h"
 #include "psa/lifecycle.h"
 #ifdef TFM_PSA_API
 #include "spm_ipc.h"
diff --git a/secure_fw/spm/common/psa_client_service_apis.h b/secure_fw/spm/ffm/psa_client_service_apis.h
similarity index 100%
rename from secure_fw/spm/common/psa_client_service_apis.h
rename to secure_fw/spm/ffm/psa_client_service_apis.h
diff --git a/secure_fw/spm/common/spm_log.c b/secure_fw/spm/ffm/spm_log.c
similarity index 100%
rename from secure_fw/spm/common/spm_log.c
rename to secure_fw/spm/ffm/spm_log.c
diff --git a/secure_fw/spm/common/spm_psa_client_call.c b/secure_fw/spm/ffm/spm_psa_client_call.c
similarity index 99%
rename from secure_fw/spm/common/spm_psa_client_call.c
rename to secure_fw/spm/ffm/spm_psa_client_call.c
index d94a13d..d054705 100644
--- a/secure_fw/spm/common/spm_psa_client_call.c
+++ b/secure_fw/spm/ffm/spm_psa_client_call.c
@@ -10,7 +10,7 @@
 #include "tfm_core_utils.h"
 #include "tfm_internal_defines.h"
 #include "tfm_memory_utils.h"
-#include "common/spm_psa_client_call.h"
+#include "spm_psa_client_call.h"
 #include "utilities.h"
 #include "tfm_wait.h"
 #include "tfm_nspm.h"
diff --git a/secure_fw/spm/common/spm_psa_client_call.h b/secure_fw/spm/ffm/spm_psa_client_call.h
similarity index 100%
rename from secure_fw/spm/common/spm_psa_client_call.h
rename to secure_fw/spm/ffm/spm_psa_client_call.h
diff --git a/secure_fw/spm/common/tfm_boot_data.c b/secure_fw/spm/ffm/tfm_boot_data.c
similarity index 100%
rename from secure_fw/spm/common/tfm_boot_data.c
rename to secure_fw/spm/ffm/tfm_boot_data.c
diff --git a/secure_fw/spm/common/tfm_boot_data.h b/secure_fw/spm/ffm/tfm_boot_data.h
similarity index 100%
rename from secure_fw/spm/common/tfm_boot_data.h
rename to secure_fw/spm/ffm/tfm_boot_data.h
diff --git a/secure_fw/spm/common/tfm_core_mem_check.c b/secure_fw/spm/ffm/tfm_core_mem_check.c
similarity index 100%
rename from secure_fw/spm/common/tfm_core_mem_check.c
rename to secure_fw/spm/ffm/tfm_core_mem_check.c
diff --git a/secure_fw/spm/common/tfm_core_utils.c b/secure_fw/spm/ffm/tfm_core_utils.c
similarity index 100%
rename from secure_fw/spm/common/tfm_core_utils.c
rename to secure_fw/spm/ffm/tfm_core_utils.c
diff --git a/secure_fw/spm/common/utilities.c b/secure_fw/spm/ffm/utilities.c
similarity index 100%
rename from secure_fw/spm/common/utilities.c
rename to secure_fw/spm/ffm/utilities.c