blob: 527a433b8acdc7bd562ade235a13f9769a724c5c [file] [log] [blame]
Ashutosh Singhf4d88672017-11-29 13:35:43 +00001/*
Mate Toth-Pal7de74b52018-02-23 15:46:47 +01002 * Copyright (c) 2017-2018, Arm Limited. All rights reserved.
Ashutosh Singhf4d88672017-11-29 13:35:43 +00003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 *
6 */
7
8#ifndef __TFM_API_H__
9#define __TFM_API_H__
10
11#ifdef __cplusplus
12extern "C" {
13#endif
14
Mate Toth-Palce61afa2018-08-03 13:51:01 +020015#include <stdint.h>
Miklos Balint87da2512018-04-19 13:45:50 +020016#include "interface/include/psa_client.h"
Mate Toth-Palce61afa2018-08-03 13:51:01 +020017
Mate Toth-Pal261df462018-08-07 12:02:42 +020018#define TFM_INVALID_CLIENT_ID 0
19
20/**
21 * \brief Checks if the provided client ID is a secure client ID.
22 *
23 * \param[in] client_id Client ID to check
24 *
25 * \return Returns 1 if the client Id is secure. Otherwise, returns 0.
26 */
27#define TFM_CLIENT_ID_IS_S(client_id) ((client_id)>0)
28
29/**
30 * \brief Checks if the provided client ID is a non-secure client ID.
31 *
32 * \param[in] client_id Client ID to check
33 *
34 * \return Returns 1 if the client Id is non-secure. Otherwise, returns 0.
35 */
36#define TFM_CLIENT_ID_IS_NS(client_id) ((client_id)<0)
37
Ashutosh Singhf4d88672017-11-29 13:35:43 +000038/* FixMe: sort out DEBUG compile option and limit return value options
39 * on external interfaces */
40/* Note:
41 * TFM will only return values recognized and parsed by TFM core.
42 * Service return codes are not automatically passed on to REE.
43 * Any non-zero return value is interpreted as an error that may trigger
44 * TEE error handling flow.
45 */
46enum tfm_status_e
47{
48 TFM_SUCCESS = 0,
Mate Toth-Pal7de74b52018-02-23 15:46:47 +010049 TFM_PARTITION_BUSY,
Ashutosh Singhf4d88672017-11-29 13:35:43 +000050 TFM_ERROR_SECURE_DOMAIN_LOCKED,
51 TFM_ERROR_INVALID_PARAMETER,
Mate Toth-Pal7de74b52018-02-23 15:46:47 +010052 TFM_ERROR_PARTITION_NON_REENTRANT,
Ashutosh Singhf4d88672017-11-29 13:35:43 +000053 TFM_ERROR_NS_THREAD_MODE_CALL,
Miklos Balint1fdb12f2018-09-11 11:30:30 +020054 TFM_ERROR_NOT_INITIALIZED,
55 TFM_ERROR_NO_ACTIVE_PARTITION,
Ashutosh Singhf4d88672017-11-29 13:35:43 +000056 TFM_ERROR_INVALID_EXC_MODE,
57 TFM_SECURE_LOCK_FAILED,
58 TFM_SECURE_UNLOCK_FAILED,
59 TFM_ERROR_GENERIC = 0x1F,
Mate Toth-Pal7de74b52018-02-23 15:46:47 +010060 TFM_PARTITION_SPECIFIC_ERROR_MIN,
Ashutosh Singhf4d88672017-11-29 13:35:43 +000061};
62
63//==================== Secure function declarations ==========================//
64
Mate Toth-Palce61afa2018-08-03 13:51:01 +020065/**
66 * \brief Assign client ID to the current TZ context
67 *
68 * \param[in] ns_client_id The client ID to be assigned to the current
69 * context
70 * \return TFM_SUCCESS if the client ID assigned successfully, an error code
71 * according to \ref tfm_status_e in case of error.
72 *
73 * \note This function have to be called from handler mode.
74 */
75enum tfm_status_e tfm_register_client_id (int32_t ns_client_id);
Ashutosh Singhf4d88672017-11-29 13:35:43 +000076
Miklos Balint87da2512018-04-19 13:45:50 +020077/**
78 * \brief Return version of secure function provided by secure binary
79 *
80 * \param[in] sid ID of secure service
81 *
82 * \return Version number of secure function
83 */
84uint32_t tfm_psa_version_veneer(uint32_t sid);
85
86/**
87 * \brief Connect to secure function
88 *
89 * \param[in] sid ID of secure service
90 * \param[in] minor_version Minor version of SF requested by client
91 *
92 * \return Returns handle to connection
93 */
94psa_handle_t tfm_psa_connect_veneer(uint32_t sid, uint32_t minor_version);
95
96/**
97 * \brief Call a secure function referenced by a connection handle
98 *
99 * \param[in] handle Handle to connection
100 * \param[in] in_vecs invec containing pointer/count of input vectors
101 * \param[in] out_vecs invec containing pointer/count of output vectors
102 *
103 * \return Returns \ref psa_error_t error code
104 */
105psa_error_t tfm_psa_call_veneer(psa_handle_t handle,
106 const psa_invec *in_vecs,
107 const psa_invec *out_vecs);
108
109/**
110 * \brief Close connection to secure function referenced by a connection handle
111 *
112 * \param[in] handle Handle to connection
113 *
114 * \return Returns \ref psa_error_t error code
115 */
116psa_error_t tfm_psa_close_veneer(psa_handle_t handle);
117
Ashutosh Singhf4d88672017-11-29 13:35:43 +0000118//================ End Secure function declarations ==========================//
119
120#ifdef __cplusplus
121}
122#endif
123
124#endif /* __TFM_API_H__ */