blob: 2354e2b2974ac50cd784d6927b8b74877d526287 [file] [log] [blame]
/*
* Copyright (c) 2018-2022, Arm Limited. All rights reserved.
* Copyright (c) 2021-2022 Cypress Semiconductor Corporation (an Infineon
* company) or an affiliate of Cypress Semiconductor Corporation. All rights
* reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
*/
#include <inttypes.h>
#include <stdbool.h>
#include <stdint.h>
#include "bitops.h"
#include "config_impl.h"
#include "config_spm.h"
#include "critical_section.h"
#include "current.h"
#include "fih.h"
#include "psa/client.h"
#include "psa/service.h"
#include "thread.h"
#include "internal_errors.h"
#include "tfm_api.h"
#include "tfm_arch.h"
#include "tfm_hal_defs.h"
#include "tfm_hal_interrupt.h"
#include "tfm_hal_isolation.h"
#include "spm_ipc.h"
#include "tfm_peripherals_def.h"
#include "tfm_nspm.h"
#include "tfm_rpc.h"
#include "tfm_core_trustzone.h"
#include "lists.h"
#include "tfm_pools.h"
#include "region.h"
#include "psa_manifest/pid.h"
#include "ffm/backend.h"
#include "load/partition_defs.h"
#include "load/service_defs.h"
#include "load/asset_defs.h"
#include "load/spm_load_api.h"
#include "tfm_nspm.h"
#if !(defined CONFIG_TFM_CONN_HANDLE_MAX_NUM) || (CONFIG_TFM_CONN_HANDLE_MAX_NUM == 0)
#error "CONFIG_TFM_CONN_HANDLE_MAX_NUM must be defined and not zero."
#endif
/* Partition and service runtime data list head/runtime data table */
static struct service_head_t services_listhead;
struct service_t *stateless_services_ref_tbl[STATIC_HANDLE_NUM_LIMIT];
/* Pools */
TFM_POOL_DECLARE(conn_handle_pool, sizeof(struct conn_handle_t),
CONFIG_TFM_CONN_HANDLE_MAX_NUM);
/*********************** Connection handle conversion APIs *******************/
#define CONVERSION_FACTOR_BITOFFSET 3
#define CONVERSION_FACTOR_VALUE (1 << CONVERSION_FACTOR_BITOFFSET)
/* Set 32 as the maximum */
#define CONVERSION_FACTOR_VALUE_MAX 0x20
#if CONVERSION_FACTOR_VALUE > CONVERSION_FACTOR_VALUE_MAX
#error "CONVERSION FACTOR OUT OF RANGE"
#endif
static uint32_t loop_index;
/*
* A handle instance psa_handle_t allocated inside SPM is actually a memory
* address among the handle pool. Return this handle to the client directly
* exposes information of secure memory address. In this case, converting the
* handle into another value does not represent the memory address to avoid
* exposing secure memory directly to clients.
*
* This function converts the handle instance into another value by scaling the
* handle in pool offset, the converted value is named as a user handle.
*
* The formula:
* user_handle = (handle_instance - POOL_START) * CONVERSION_FACTOR_VALUE +
* CLIENT_HANDLE_VALUE_MIN + loop_index
* where:
* CONVERSION_FACTOR_VALUE = 1 << CONVERSION_FACTOR_BITOFFSET, and should not
* exceed CONVERSION_FACTOR_VALUE_MAX.
*
* handle_instance in RANGE[POOL_START, POOL_END]
* user_handle in RANGE[CLIENT_HANDLE_VALUE_MIN, 0x3FFFFFFF]
* loop_index in RANGE[0, CONVERSION_FACTOR_VALUE - 1]
*
* note:
* loop_index is used to promise same handle instance is converted into
* different user handles in short time.
*/
psa_handle_t tfm_spm_to_user_handle(struct conn_handle_t *handle_instance)
{
psa_handle_t user_handle;
loop_index = (loop_index + 1) % CONVERSION_FACTOR_VALUE;
user_handle = (psa_handle_t)((((uintptr_t)handle_instance -
(uintptr_t)conn_handle_pool) << CONVERSION_FACTOR_BITOFFSET) +
CLIENT_HANDLE_VALUE_MIN + loop_index);
return user_handle;
}
/*
* This function converts a user handle into a corresponded handle instance.
* The converted value is validated before returning, an invalid handle instance
* is returned as NULL.
*
* The formula:
* handle_instance = ((user_handle - CLIENT_HANDLE_VALUE_MIN) /
* CONVERSION_FACTOR_VALUE) + POOL_START
* where:
* CONVERSION_FACTOR_VALUE = 1 << CONVERSION_FACTOR_BITOFFSET, and should not
* exceed CONVERSION_FACTOR_VALUE_MAX.
*
* handle_instance in RANGE[POOL_START, POOL_END]
* user_handle in RANGE[CLIENT_HANDLE_VALUE_MIN, 0x3FFFFFFF]
* loop_index in RANGE[0, CONVERSION_FACTOR_VALUE - 1]
*/
struct conn_handle_t *tfm_spm_to_handle_instance(psa_handle_t user_handle)
{
struct conn_handle_t *handle_instance;
if (user_handle == PSA_NULL_HANDLE) {
return NULL;
}
handle_instance = (struct conn_handle_t *)((((uintptr_t)user_handle -
CLIENT_HANDLE_VALUE_MIN) >> CONVERSION_FACTOR_BITOFFSET) +
(uintptr_t)conn_handle_pool);
return handle_instance;
}
/* Service handle management functions */
struct conn_handle_t *tfm_spm_create_conn_handle(void)
{
struct conn_handle_t *p_handle;
/* Get buffer for handle list structure from handle pool */
p_handle = (struct conn_handle_t *)tfm_pool_alloc(conn_handle_pool);
if (!p_handle) {
return NULL;
}
spm_memset(p_handle, 0, sizeof(*p_handle));
p_handle->status = TFM_HANDLE_STATUS_IDLE;
return p_handle;
}
psa_status_t tfm_spm_validate_conn_handle(const struct conn_handle_t *handle)
{
/* Check the handle address is valid */
if (is_valid_chunk_data_in_pool(conn_handle_pool,
(uint8_t *)handle) != true) {
return SPM_ERROR_GENERIC;
}
return PSA_SUCCESS;
}
void tfm_spm_free_conn_handle(struct conn_handle_t *conn_handle)
{
struct critical_section_t cs_assert = CRITICAL_SECTION_STATIC_INIT;
SPM_ASSERT(conn_handle != NULL);
CRITICAL_SECTION_ENTER(cs_assert);
/* Back handle buffer to pool */
tfm_pool_free(conn_handle_pool, conn_handle);
CRITICAL_SECTION_LEAVE(cs_assert);
}
/* Partition management functions */
/* This API is only used in IPC backend. */
#if CONFIG_TFM_SPM_BACKEND_IPC == 1
struct conn_handle_t *spm_get_handle_by_signal(struct partition_t *p_ptn,
psa_signal_t signal)
{
struct conn_handle_t *p_handle_iter;
struct conn_handle_t **pr_handle_iter, **last_found_handle_holder = NULL;
struct critical_section_t cs_assert = CRITICAL_SECTION_STATIC_INIT;
uint32_t nr_found_msgs = 0;
CRITICAL_SECTION_ENTER(cs_assert);
/* Return the last found message which applies a FIFO mechanism. */
UNI_LIST_FOREACH_NODE_PNODE(pr_handle_iter, p_handle_iter,
p_ptn, p_handles) {
if (p_handle_iter->service->p_ldinf->signal == signal) {
last_found_handle_holder = pr_handle_iter;
nr_found_msgs++;
}
}
if (last_found_handle_holder) {
p_handle_iter = *last_found_handle_holder;
UNI_LIST_REMOVE_NODE_BY_PNODE(last_found_handle_holder, p_handles);
if (nr_found_msgs == 1) {
p_ptn->signals_asserted &= ~signal;
}
}
CRITICAL_SECTION_LEAVE(cs_assert);
return p_handle_iter;
}
#endif /* CONFIG_TFM_SPM_BACKEND_IPC == 1 */
struct service_t *tfm_spm_get_service_by_sid(uint32_t sid)
{
struct service_t *p_prev, *p_curr;
UNI_LIST_FOREACH_NODE_PREV(p_prev, p_curr, &services_listhead, next) {
if (p_curr->p_ldinf->sid == sid) {
UNI_LIST_MOVE_AFTER(&services_listhead, p_prev, p_curr, next);
return p_curr;
}
}
return NULL;
}
#if CONFIG_TFM_DOORBELL_API == 1
/**
* \brief Get the partition context by partition ID.
*
* \param[in] partition_id Partition identity
*
* \retval NULL Failed
* \retval "Not NULL" Target partition context pointer,
* \ref partition_t structures
*/
struct partition_t *tfm_spm_get_partition_by_id(int32_t partition_id)
{
struct partition_t *p_part;
UNI_LIST_FOREACH(p_part, PARTITION_LIST_ADDR, next) {
if (p_part->p_ldinf->pid == partition_id) {
return p_part;
}
}
return NULL;
}
#endif /* CONFIG_TFM_DOORBELL_API == 1 */
int32_t tfm_spm_check_client_version(struct service_t *service,
uint32_t version)
{
SPM_ASSERT(service);
switch (SERVICE_GET_VERSION_POLICY(service->p_ldinf->flags)) {
case SERVICE_VERSION_POLICY_RELAXED:
if (version > service->p_ldinf->version) {
return SPM_ERROR_VERSION;
}
break;
case SERVICE_VERSION_POLICY_STRICT:
if (version != service->p_ldinf->version) {
return SPM_ERROR_VERSION;
}
break;
default:
return SPM_ERROR_VERSION;
}
return PSA_SUCCESS;
}
int32_t tfm_spm_check_authorization(uint32_t sid,
struct service_t *service,
bool ns_caller)
{
struct partition_t *partition = NULL;
const uint32_t *dep;
int32_t i;
SPM_ASSERT(service);
if (ns_caller) {
if (!SERVICE_IS_NS_ACCESSIBLE(service->p_ldinf->flags)) {
return SPM_ERROR_GENERIC;
}
} else {
partition = GET_CURRENT_COMPONENT();
if (!partition) {
tfm_core_panic();
}
dep = LOAD_INFO_DEPS(partition->p_ldinf);
for (i = 0; i < partition->p_ldinf->ndeps; i++) {
if (dep[i] == sid) {
break;
}
}
if (i == partition->p_ldinf->ndeps) {
return SPM_ERROR_GENERIC;
}
}
return PSA_SUCCESS;
}
/* Message functions */
#if CONFIG_TFM_CONNECTION_BASED_SERVICE_API == 1
struct conn_handle_t *spm_get_handle_by_client_handle(psa_handle_t handle,
int32_t client_id)
{
struct conn_handle_t *p_conn_handle = tfm_spm_to_handle_instance(handle);
if (tfm_spm_validate_conn_handle(p_conn_handle) != PSA_SUCCESS) {
return NULL;
}
/* Validate the caller id in the connection handle equals client_id. */
if (p_conn_handle->msg.client_id != client_id) {
return NULL;
}
return p_conn_handle;
}
#endif
struct conn_handle_t *spm_get_handle_by_msg_handle(psa_handle_t msg_handle)
{
/*
* The message handler passed by the caller is considered invalid in the
* following cases:
* 1. Not a valid message handle. (The address of a message is not the
* address of a possible handle from the pool
* 2. Handle not belongs to the caller partition (The handle is either
* unused, or owned by another partition)
* Check the conditions above
*/
int32_t partition_id;
struct conn_handle_t *p_conn_handle =
tfm_spm_to_handle_instance(msg_handle);
if (tfm_spm_validate_conn_handle(p_conn_handle) != PSA_SUCCESS) {
return NULL;
}
/* Check that the running partition owns the message */
partition_id = tfm_spm_partition_get_running_partition_id();
if (partition_id != p_conn_handle->service->partition->p_ldinf->pid) {
return NULL;
}
return p_conn_handle;
}
void spm_fill_message(struct conn_handle_t *conn_handle,
struct service_t *service,
psa_handle_t handle,
int32_t type, int32_t client_id,
psa_invec *invec, size_t in_len,
psa_outvec *outvec, size_t out_len,
psa_outvec *caller_outvec)
{
uint32_t i;
SPM_ASSERT(conn_handle);
SPM_ASSERT(service);
SPM_ASSERT(!(invec == NULL && in_len != 0));
SPM_ASSERT(!(outvec == NULL && out_len != 0));
SPM_ASSERT(in_len <= SIZE_MAX - out_len);
SPM_ASSERT(in_len + out_len <= PSA_MAX_IOVEC);
/* Clear message buffer before using it */
spm_memset(&conn_handle->msg, 0, sizeof(psa_msg_t));
THRD_SYNC_INIT(&conn_handle->ack_evnt);
conn_handle->service = service;
conn_handle->p_client = GET_CURRENT_COMPONENT();
conn_handle->caller_outvec = caller_outvec;
conn_handle->msg.client_id = client_id;
/* Copy contents */
conn_handle->msg.type = type;
for (i = 0; i < in_len; i++) {
conn_handle->msg.in_size[i] = invec[i].len;
conn_handle->invec[i].base = invec[i].base;
}
for (i = 0; i < out_len; i++) {
conn_handle->msg.out_size[i] = outvec[i].len;
conn_handle->outvec[i].base = outvec[i].base;
/* Out len is used to record the wrote number, set 0 here again */
conn_handle->outvec[i].len = 0;
}
/* Use the user connect handle as the message handle */
conn_handle->msg.handle = handle;
conn_handle->msg.rhandle = conn_handle->rhandle;
/* Set the private data of NSPE client caller in multi-core topology */
if (TFM_CLIENT_ID_IS_NS(client_id)) {
tfm_rpc_set_caller_data(conn_handle, client_id);
}
}
int32_t tfm_spm_partition_get_running_partition_id(void)
{
struct partition_t *partition;
partition = GET_CURRENT_COMPONENT();
if (partition && partition->p_ldinf) {
return partition->p_ldinf->pid;
} else {
return INVALID_PARTITION_ID;
}
}
bool tfm_spm_is_ns_caller(void)
{
struct partition_t *partition = GET_CURRENT_COMPONENT();
if (!partition) {
tfm_core_panic();
}
return IS_PARTITION_NS_AGENT(partition->p_ldinf);
}
int32_t tfm_spm_get_client_id(bool ns_caller)
{
int32_t client_id;
if (ns_caller) {
client_id = tfm_nspm_get_current_client_id();
} else {
client_id = tfm_spm_partition_get_running_partition_id();
}
if (ns_caller != (client_id < 0)) {
/* NS client ID must be negative and Secure ID must >= 0 */
tfm_core_panic();
}
return client_id;
}
uint32_t tfm_spm_init(void)
{
struct partition_t *partition;
uint32_t service_setting;
fih_int fih_rc = FIH_FAILURE;
tfm_pool_init(conn_handle_pool,
POOL_BUFFER_SIZE(conn_handle_pool),
sizeof(struct conn_handle_t),
CONFIG_TFM_CONN_HANDLE_MAX_NUM);
UNI_LISI_INIT_NODE(PARTITION_LIST_ADDR, next);
UNI_LISI_INIT_NODE(&services_listhead, next);
/* Init the nonsecure context. */
tfm_nspm_ctx_init();
while (1) {
partition = load_a_partition_assuredly(PARTITION_LIST_ADDR);
if (partition == NO_MORE_PARTITION) {
break;
}
service_setting = load_services_assuredly(
partition,
&services_listhead,
stateless_services_ref_tbl,
sizeof(stateless_services_ref_tbl));
load_irqs_assuredly(partition);
/* Bind the partition with platform. */
FIH_CALL(tfm_hal_bind_boundary, fih_rc, partition->p_ldinf,
&partition->boundary);
if (fih_not_eq(fih_rc, fih_int_encode(TFM_HAL_SUCCESS))) {
tfm_core_panic();
}
backend_init_comp_assuredly(partition, service_setting);
}
return backend_system_run();
}
void update_caller_outvec_len(struct conn_handle_t *handle)
{
uint32_t i;
/*
* FixeMe: abstract these part into dedicated functions to avoid
* accessing thread context in psa layer
*/
/*
* If it is a NS request via RPC, the owner of this message is not set.
* Or if it is a SFN message, it does not have owner thread state either.
*/
if ((!is_tfm_rpc_msg(handle)) && (handle->sfn_magic != TFM_MSG_MAGIC_SFN)) {
SPM_ASSERT(handle->ack_evnt.owner->state == THRD_STATE_BLOCK);
}
for (i = 0; i < PSA_MAX_IOVEC; i++) {
if (handle->msg.out_size[i] == 0) {
continue;
}
SPM_ASSERT(handle->caller_outvec[i].base == handle->outvec[i].base);
handle->caller_outvec[i].len = handle->outvec[i].len;
}
}
void spm_assert_signal(void *p_pt, psa_signal_t signal)
{
struct critical_section_t cs_assert = CRITICAL_SECTION_STATIC_INIT;
struct partition_t *partition = (struct partition_t *)p_pt;
if (!partition) {
tfm_core_panic();
}
CRITICAL_SECTION_ENTER(cs_assert);
partition->signals_asserted |= signal;
if (partition->signals_waiting & signal) {
backend_wake_up(partition);
}
CRITICAL_SECTION_LEAVE(cs_assert);
}