tfm_platform_system.c

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA.
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */

#include <platform/include/tfm_platform_system.h>
#include <cmsis.h>
#include <stdio.h>
#include <tfm_ioctl_api.h>
#include <string.h>
#include <arm_cmse.h>

#include "tfm_ioctl_api.h"
#include "tfm_platform_hal_ioctl.h"
#include <tfm_hal_isolation.h>

#include <hal/nrf_gpio.h>
#include <hal/nrf_regulators.h>
#include <helpers/nrfx_ram_ctrl.h>

#include "handle_attr.h"

#if NRF_ALLOW_NON_SECURE_FAULT_HANDLING
#include "ns_fault_service.h"
#endif /* CONFIG_TFM_ALLOW_NON_SECURE_FAULT_HANDLING */

void tfm_platform_hal_system_reset(void)
{
	/* Reset the system */
	NVIC_SystemReset();
}

#if TFM_NRF_SYSTEM_OFF_SERVICE
enum tfm_platform_err_t tfm_platform_hal_system_off(void)
{
	__disable_irq();

	nrfx_ram_ctrl_retention_enable_all_set(false);

	nrf_regulators_system_off(NRF_REGULATORS);

	/* This should be unreachable */
	return TFM_PLATFORM_ERR_SYSTEM_ERROR;
}
#endif /* TFM_NRF_SYSTEM_OFF_SERVICE */

#if CONFIG_FW_INFO
static enum tfm_platform_err_t tfm_platform_hal_fw_info_service(psa_invec *in_vec,
								psa_outvec *out_vec)
{
	const struct fw_info *tfm_info;
	struct tfm_fw_info_args_t *args;
	struct tfm_fw_info_out_t *out;
	enum tfm_hal_status_t status;
	enum tfm_platform_err_t err;
	uint32_t attr = TFM_HAL_ACCESS_WRITABLE | TFM_HAL_ACCESS_READABLE | TFM_HAL_ACCESS_NS;
	uintptr_t boundary = (1 << HANDLE_ATTR_NS_POS) & HANDLE_ATTR_NS_MASK;

	if (in_vec->len != sizeof(struct tfm_fw_info_args_t) ||
	    out_vec->len != sizeof(struct tfm_fw_info_out_t)) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	args = (struct tfm_fw_info_args_t *)in_vec->base;
	out = (struct tfm_fw_info_out_t *)out_vec->base;

	/* Assume failure, unless valid region is hit in the loop */
	out->result = -1;
	err = TFM_PLATFORM_ERR_INVALID_PARAM;

	if (args->info == NULL) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	status =
		tfm_hal_memory_check(boundary, (uintptr_t)args->info, sizeof(struct fw_info), attr);
	if (status != TFM_HAL_SUCCESS) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	tfm_info = fw_info_find((uintptr_t)args->fw_address);
	if (tfm_info != NULL) {
		memcpy(args->info, tfm_info, sizeof(struct fw_info));
		out->result = 0;
		err = TFM_PLATFORM_ERR_SUCCESS;
	}

	return err;
}
#endif

#if NRF_ALLOW_NON_SECURE_FAULT_HANDLING
static enum tfm_platform_err_t tfm_platform_hal_ns_fault_service(const psa_invec *in_vec,
								 const psa_outvec *out_vec)
{
	struct tfm_ns_fault_service_args *args;
	struct tfm_ns_fault_service_out *out;
	enum tfm_hal_status_t status;

	uint32_t attr_context =
		TFM_HAL_ACCESS_WRITABLE | TFM_HAL_ACCESS_READABLE | TFM_HAL_ACCESS_NS;

	uint32_t attr_callback =
		TFM_HAL_ACCESS_EXECUTABLE | TFM_HAL_ACCESS_READABLE | TFM_HAL_ACCESS_NS;

	uintptr_t boundary = (1 << HANDLE_ATTR_NS_POS) & HANDLE_ATTR_NS_MASK;

	if (in_vec->len != sizeof(struct tfm_ns_fault_service_args) ||
	    out_vec->len != sizeof(struct tfm_ns_fault_service_out)) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	args = (struct tfm_ns_fault_service_args *)in_vec->base;
	out = (struct tfm_ns_fault_service_out *)out_vec->base;
	out->result = -1;

	if (args->context == NULL || args->callback == NULL) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	status = tfm_hal_memory_check(boundary, (uintptr_t)args->context,
				      sizeof(struct tfm_ns_fault_service_handler_context),
				      attr_context);
	if (status != TFM_HAL_SUCCESS) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	status = tfm_hal_memory_check(boundary, (uintptr_t)args->callback,
				      sizeof(tfm_ns_fault_service_handler_callback), attr_callback);
	if (status != TFM_HAL_SUCCESS) {
		return TFM_PLATFORM_ERR_INVALID_PARAM;
	}

	out->result = ns_fault_service_set_handler(args->context, args->callback);

	return TFM_PLATFORM_ERR_SUCCESS;
}
#endif /* NRF_ALLOW_NON_SECURE_FAULT_HANDLING */

enum tfm_platform_err_t tfm_platform_hal_ioctl(tfm_platform_ioctl_req_t request, psa_invec *in_vec,
					       psa_outvec *out_vec)
{
	/* Core IOCTL services */
	switch (request) {
	case TFM_PLATFORM_IOCTL_READ_SERVICE:
		return tfm_platform_hal_read_service(in_vec, out_vec);
	case TFM_PLATFORM_IOCTL_WRITE32_SERVICE:
		return tfm_platform_hal_write32_service(in_vec, out_vec);
#if defined(GPIO_PIN_CNF_MCUSEL_Msk)
	case TFM_PLATFORM_IOCTL_GPIO_SERVICE:
		return tfm_platform_hal_gpio_service(in_vec, out_vec);
#endif /* defined(GPIO_PIN_CNF_MCUSEL_Msk) */
#if TFM_NRF_MRAMC_SERVICE
	case TFM_PLATFORM_IOCTL_MRAMC_INIT_SERVICE:
		return tfm_platform_hal_mramc_init_service();
	case TFM_PLATFORM_IOCTL_MRAMC_SET_WEN_SERVICE:
		return tfm_platform_hal_mramc_set_wen_service(in_vec);
#endif

		/* Board specific IOCTL services */
#if CONFIG_FW_INFO
	case TFM_PLATFORM_IOCTL_FW_INFO:
		return tfm_platform_hal_fw_info_service(in_vec, out_vec);
#endif
#if NRF_ALLOW_NON_SECURE_FAULT_HANDLING
	case TFM_PLATFORM_IOCTL_NS_FAULT:
		return tfm_platform_hal_ns_fault_service(in_vec, out_vec);
#endif
	/* Not a supported IOCTL service.*/
	default:
		return TFM_PLATFORM_ERR_NOT_SUPPORTED;
	}
}