Mark all TEEC APIs as deprecated since Tizen 6.5tizen_8.0_m2_releasetizen_7.0_m2_releasetizen_6.5.m2_releasesubmit/tizen_6.5/20211028.161701submit/tizen/20210217.173827accepted/tizen/unified/20210219.040909accepted/tizen/8.0/unified/20231005.092715accepted/tizen/7.0/unified/hotfix/20221116.104702accepted/tizen/7.0/unified/20221110.061313accepted/tizen/6.5/unified/20211028.093753tizen_8.0tizen_7.0_hotfixtizen_7.0tizen_6.5tizenaccepted/tizen_unifiedaccepted/tizen_8.0_unifiedaccepted/tizen_7.0_unified_hotfixaccepted/tizen_7.0_unifiedaccepted/tizen_6.5_unified

Change-Id: I500ed4d332db6821a0221c14f7be1d44cc49b3ba

1 files changed, 73 insertions, 9 deletions

diff --git a/api/tef/tee_client_api.h b/api/tef/tee_client_api.h
index 7021b17..6afd051 100644
--- a/api/tef/tee_client_api.h
+++ b/api/tef/tee_client_api.h
@@ -27,6 +27,10 @@
 #include <stdint.h>
 #include <stddef.h>
 
+#ifndef TIZEN_DEPRECATED_API
+#define TIZEN_DEPRECATED_API __attribute__ ((__visibility__("default"), deprecated))
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -37,6 +41,8 @@ extern "C" {
  */
 
 /*
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Defines the number of available memory references in an open session or
  * invoke command operation payload.
  *
@@ -45,6 +51,8 @@ extern "C" {
 #define TEEC_CONFIG_PAYLOAD_REF_COUNT 4
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Defines the maximum size of a single shared memory block, in bytes, of both
  * API allocated and API registered memory. The size is currently set to
  * 512 * kB (512 * 1024).
@@ -54,6 +62,8 @@ extern "C" {
 #define TEEC_CONFIG_SHAREDMEM_MAX_SIZE 0x80000
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Flag constants indicating the type of parameters encoded inside the
  * operation payload (TEEC_Operation), Type is uint32_t.
  *
@@ -122,6 +132,8 @@ extern "C" {
 #define TEEC_MEMREF_PARTIAL_INOUT   0x0000000F
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Flag constants indicating the data transfer direction of memory in
  * TEEC_Parameter. TEEC_MEM_INPUT signifies data transfer direction from the
  * client application to the TEE. TEEC_MEM_OUTPUT signifies data transfer
@@ -139,6 +151,8 @@ extern "C" {
 #define TEEC_MEM_OUTPUT  0x00000002
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Return values. Type is TEEC_Result
  *
  * @since_tizen 4.0
@@ -194,6 +208,8 @@ extern "C" {
 #define TEEC_ERROR_TARGET_DEAD      0xFFFF3024
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Function error origins, of type TEEC_ErrorOrigin. These indicate where in
  * the software stack a particular return value originates from.
  *
@@ -214,6 +230,8 @@ extern "C" {
 #define TEEC_ORIGIN_TRUSTED_APP  0x00000004
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Session login methods, for use in TEEC_OpenSession() as parameter
  * connectionMethod. Type is uint32_t.
  *
@@ -239,6 +257,8 @@ extern "C" {
 #define TEEC_LOGIN_GROUP_APPLICATION  0x00000006
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Encode the paramTypes according to the supplied types.
  *
  * @since_tizen 4.0
@@ -252,6 +272,8 @@ extern "C" {
     ((p0) | ((p1) << 8) | ((p2) << 16) | ((p3) << 24))
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Get the i_th param type from the paramType.
  *
  * @since_tizen 4.0
@@ -262,11 +284,17 @@ extern "C" {
 #define TEEC_PARAM_TYPE_GET(p, i) (((p) >> (i * 8)) & 0xF)
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief This type is used to contain return codes which are the results of invoking TEE Client API functions.
+ *
+ * @since_tizen 4.0
  */
 typedef uint32_t TEEC_Result;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief This type contains a Universally Unique Resource Identifier (UUID) type as
  * defined in RFC4122. These UUID values are used to identify Trusted Applications.
  *
@@ -280,6 +308,8 @@ typedef struct {
 } TEEC_UUID;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Memory to transfer data between a client application and trusted code.
  *
  * @since_tizen 4.0
@@ -304,6 +334,8 @@ typedef struct {
 } TEEC_SharedMemory;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Temporary memory to transfer data between
  * a client application and trusted code, only used for the duration of the
  * operation.
@@ -321,6 +353,8 @@ typedef struct {
 } TEEC_TempMemoryReference;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Uses pre-registered or pre-allocated shared memory block of memory to transfer
  * data between a client application and trusted code.
  *
@@ -341,6 +375,8 @@ typedef struct {
 } TEEC_RegisteredMemoryReference;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Small raw data container
  *
  * @since_tizen 4.0
@@ -356,6 +392,8 @@ typedef struct {
 } TEEC_Value;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Memory container to be used when passing data between
  * client application and trusted code.
  *
@@ -374,6 +412,8 @@ typedef union {
 } TEEC_Parameter;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Represents a connection between a client application and a TEE.
  *
  * @since_tizen 4.0
@@ -384,6 +424,8 @@ typedef struct {
 } TEEC_Context;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Represents a connection between a client application
  * and a trusted application.
  *
@@ -395,6 +437,8 @@ typedef struct {
 } TEEC_Session;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Holds information and memory references used in TEEC_InvokeCommand().
  *
  * @since_tizen 4.0
@@ -412,6 +456,8 @@ typedef struct {
 } TEEC_Operation;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Initializes a context holding connection
  * information on the specific TEE, designated by the name string.
  *
@@ -425,9 +471,11 @@ typedef struct {
  *
  * @return TEEC_SUCCESS on success, or another Return Code on failure
  */
-TEEC_Result TEEC_InitializeContext(const char *name, TEEC_Context *context);
+TEEC_Result TEEC_InitializeContext(const char *name, TEEC_Context *context) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Destroys a context holding connection information
  * on the specific TEE.
  *
@@ -440,9 +488,11 @@ TEEC_Result TEEC_InitializeContext(const char *name, TEEC_Context *context);
  *
  * @param[in] context       The context to be destroyed.
  */
-void TEEC_FinalizeContext(TEEC_Context *context);
+void TEEC_FinalizeContext(TEEC_Context *context) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Opens a new session with the specified trusted application.
  *
  * @since_tizen 4.0
@@ -471,9 +521,11 @@ TEEC_Result TEEC_OpenSession(TEEC_Context *context,
                              uint32_t connectionMethod,
                              const void *connectionData,
                              TEEC_Operation *operation,
-                             uint32_t *returnOrigin);
+                             uint32_t *returnOrigin) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Closes the session which has been opened with the
  * specific trusted application.
  *
@@ -481,11 +533,15 @@ TEEC_Result TEEC_OpenSession(TEEC_Context *context,
  *
  * @param[in] session The opened session to close.
  */
-void TEEC_CloseSession(TEEC_Session *session);
+void TEEC_CloseSession(TEEC_Session *session) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Executes a command in the specified trusted application.
  *
+ * @since_tizen 4.0
+ *
  * @param[in] session        A handle to an open connection to the trusted application.
  * @param[in] commandID      Identifier of the command in the trusted application to invoke.
  * @param[in,out] operation  An operation structure to use in the invoke command.
@@ -499,9 +555,11 @@ void TEEC_CloseSession(TEEC_Session *session);
 TEEC_Result TEEC_InvokeCommand(TEEC_Session *session,
                                uint32_t commandID,
                                TEEC_Operation *operation,
-                               uint32_t *returnOrigin);
+                               uint32_t *returnOrigin) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Registers a block of existing memory as a
  * shared block within the scope of the specified context.
  *
@@ -515,9 +573,11 @@ TEEC_Result TEEC_InvokeCommand(TEEC_Session *session,
  * @retval TEEC_ERROR_OUT_OF_MEMORY  Memory exhaustion.
  */
 TEEC_Result TEEC_RegisterSharedMemory(TEEC_Context *context,
-                                      TEEC_SharedMemory *sharedMem);
+                                      TEEC_SharedMemory *sharedMem) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Allocates shared memory for TEE.
  *
  * @since_tizen 4.0
@@ -530,18 +590,22 @@ TEEC_Result TEEC_RegisterSharedMemory(TEEC_Context *context,
  * @retval TEEC_ERROR_OUT_OF_MEMORY  Memory exhaustion.
  */
 TEEC_Result TEEC_AllocateSharedMemory(TEEC_Context *context,
-                                      TEEC_SharedMemory *sharedMem);
+                                      TEEC_SharedMemory *sharedMem) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Frees or deregisters the shared memory.
  *
  * @since_tizen 4.0
  *
  * @param[in] sharedMem  Pointer to the shared memory to be freed.
  */
-void TEEC_ReleaseSharedMemory(TEEC_SharedMemory *sharedMemory);
+void TEEC_ReleaseSharedMemory(TEEC_SharedMemory *sharedMemory) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 6.5.
+ *
  * @brief Requests the cancellation of a pending open
  *        session or command invocation.
  *
@@ -550,7 +614,7 @@ void TEEC_ReleaseSharedMemory(TEEC_SharedMemory *sharedMemory);
  * @param[in] operation  Pointer to an operation previously passed to open session
  *                       or invoke.
  */
-void TEEC_RequestCancellation(TEEC_Operation *operation);
+void TEEC_RequestCancellation(TEEC_Operation *operation) TIZEN_DEPRECATED_API;
 
 /**
  * @}