1 /* 2 * Copyright (c) 2018-2021, Arm Limited. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 * 6 */ 7 8 #ifndef __PSA_CLIENT_H__ 9 #define __PSA_CLIENT_H__ 10 11 #include <stddef.h> 12 #include <stdint.h> 13 14 #include "psa/error.h" 15 16 #ifdef __cplusplus 17 extern "C" { 18 #endif 19 20 #ifndef IOVEC_LEN 21 #define IOVEC_LEN(arr) ((uint32_t)(sizeof(arr)/sizeof(arr[0]))) 22 #endif 23 24 /*********************** PSA Client Macros and Types *************************/ 25 26 /** 27 * The version of the PSA Framework API that is being used to build the calling 28 * firmware. Only part of features of FF-M v1.1 have been implemented. FF-M v1.1 29 * is compatible with v1.0. 30 */ 31 #define PSA_FRAMEWORK_VERSION (0x0101u) 32 33 /** 34 * Return value from psa_version() if the requested RoT Service is not present 35 * in the system. 36 */ 37 #define PSA_VERSION_NONE (0u) 38 39 /** 40 * The zero-value null handle can be assigned to variables used in clients and 41 * RoT Services, indicating that there is no current connection or message. 42 */ 43 #define PSA_NULL_HANDLE ((psa_handle_t)0) 44 45 /** 46 * Tests whether a handle value returned by psa_connect() is valid. 47 */ 48 #define PSA_HANDLE_IS_VALID(handle) ((psa_handle_t)(handle) > 0) 49 50 /** 51 * Converts the handle value returned from a failed call psa_connect() into 52 * an error code. 53 */ 54 #define PSA_HANDLE_TO_ERROR(handle) ((psa_status_t)(handle)) 55 56 /** 57 * Maximum number of input and output vectors for a request to psa_call(). 58 */ 59 #define PSA_MAX_IOVEC (4u) 60 61 62 /** 63 * The minimum and maximum value in THIS implementation that can be passed 64 * as the type parameter in a call to psa_call(). 65 */ 66 67 #define PSA_CALL_TYPE_MIN (0) 68 #define PSA_CALL_TYPE_MAX (INT16_MAX) 69 70 /** 71 * An IPC message type that indicates a generic client request. 72 */ 73 #define PSA_IPC_CALL (0) 74 75 typedef int32_t psa_handle_t; 76 77 /** 78 * A read-only input memory region provided to an RoT Service. 79 */ 80 typedef struct psa_invec { 81 const void *base; /*!< the start address of the memory buffer */ 82 size_t len; /*!< the size in bytes */ 83 } psa_invec; 84 85 /** 86 * A writable output memory region provided to an RoT Service. 87 */ 88 typedef struct psa_outvec { 89 void *base; /*!< the start address of the memory buffer */ 90 size_t len; /*!< the size in bytes */ 91 } psa_outvec; 92 93 /*************************** PSA Client API **********************************/ 94 95 /** 96 * \brief Retrieve the version of the PSA Framework API that is implemented. 97 * 98 * \return version The version of the PSA Framework implementation 99 * that is providing the runtime services to the 100 * caller. The major and minor version are encoded 101 * as follows: 102 * \arg version[15:8] -- major version number. 103 * \arg version[7:0] -- minor version number. 104 */ 105 uint32_t psa_framework_version(void); 106 107 /** 108 * \brief Retrieve the version of an RoT Service or indicate that it is not 109 * present on this system. 110 * 111 * \param[in] sid ID of the RoT Service to query. 112 * 113 * \retval PSA_VERSION_NONE The RoT Service is not implemented, or the 114 * caller is not permitted to access the service. 115 * \retval > 0 The version of the implemented RoT Service. 116 */ 117 uint32_t psa_version(uint32_t sid); 118 119 /** 120 * \brief Connect to an RoT Service by its SID. 121 * 122 * \param[in] sid ID of the RoT Service to connect to. 123 * \param[in] version Requested version of the RoT Service. 124 * 125 * \retval > 0 A handle for the connection. 126 * \retval PSA_ERROR_CONNECTION_REFUSED The SPM or RoT Service has refused the 127 * connection. 128 * \retval PSA_ERROR_CONNECTION_BUSY The SPM or RoT Service cannot make the 129 * connection at the moment. 130 * \retval "PROGRAMMER ERROR" The call is a PROGRAMMER ERROR if one or more 131 * of the following are true: 132 * \arg The RoT Service ID is not present. 133 * \arg The RoT Service version is not supported. 134 * \arg The caller is not allowed to access the RoT 135 * service. 136 */ 137 psa_handle_t psa_connect(uint32_t sid, uint32_t version); 138 139 /** 140 * \brief Call an RoT Service on an established connection. 141 * 142 * \note FF-M 1.0 proposes 6 parameters for psa_call but the secure gateway ABI 143 * support at most 4 parameters. TF-M chooses to encode 'in_len', 144 * 'out_len', and 'type' into a 32-bit integer to improve efficiency. 145 * Compared with struct-based encoding, this method saves extra memory 146 * check and memory copy operation. The disadvantage is that the 'type' 147 * range has to be reduced into a 16-bit integer. So with this encoding, 148 * the valid range for 'type' is 0-32767. 149 * 150 * \param[in] handle A handle to an established connection. 151 * \param[in] type The request type. 152 * Must be zero( \ref PSA_IPC_CALL) or positive. 153 * \param[in] in_vec Array of input \ref psa_invec structures. 154 * \param[in] in_len Number of input \ref psa_invec structures. 155 * \param[in,out] out_vec Array of output \ref psa_outvec structures. 156 * \param[in] out_len Number of output \ref psa_outvec structures. 157 * 158 * \retval >=0 RoT Service-specific status value. 159 * \retval <0 RoT Service-specific error code. 160 * \retval PSA_ERROR_PROGRAMMER_ERROR The connection has been terminated by the 161 * RoT Service. The call is a PROGRAMMER ERROR if 162 * one or more of the following are true: 163 * \arg An invalid handle was passed. 164 * \arg The connection is already handling a request. 165 * \arg type < 0. 166 * \arg An invalid memory reference was provided. 167 * \arg in_len + out_len > PSA_MAX_IOVEC. 168 * \arg The message is unrecognized by the RoT 169 * Service or incorrectly formatted. 170 */ 171 psa_status_t psa_call(psa_handle_t handle, int32_t type, 172 const psa_invec *in_vec, 173 size_t in_len, 174 psa_outvec *out_vec, 175 size_t out_len); 176 177 /** 178 * \brief Close a connection to an RoT Service. 179 * 180 * \param[in] handle A handle to an established connection, or the 181 * null handle. 182 * 183 * \retval void Success. 184 * \retval "PROGRAMMER ERROR" The call is a PROGRAMMER ERROR if one or more 185 * of the following are true: 186 * \arg An invalid handle was provided that is not 187 * the null handle. 188 * \arg The connection is currently handling a 189 * request. 190 */ 191 void psa_close(psa_handle_t handle); 192 193 #ifdef __cplusplus 194 } 195 #endif 196 197 #endif /* __PSA_CLIENT_H__ */ 198
