/* SPDX-License-Identifier: BSD-2-Clause */
/*
 * Copyright (c) 2015, Linaro Limited
 */
#ifndef __KERNEL_PSEUDO_TA_H
#define __KERNEL_PSEUDO_TA_H

#include <assert.h>
#include <compiler.h>
#include <config.h>
#include <kernel/tee_ta_manager.h>
#include <kernel/user_ta.h>
#include <scattered_array.h>
#include <tee_api_types.h>
#include <user_ta_header.h>
#include <util.h>

#define PTA_MANDATORY_FLAGS	(TA_FLAG_SINGLE_INSTANCE | \
				TA_FLAG_MULTI_SESSION | \
				TA_FLAG_INSTANCE_KEEP_ALIVE)

#define PTA_ALLOWED_FLAGS	(PTA_MANDATORY_FLAGS | \
				 TA_FLAG_SECURE_DATA_PATH | \
				 TA_FLAG_CONCURRENT | \
				 TA_FLAG_DEVICE_ENUM)

#define PTA_DEFAULT_FLAGS	PTA_MANDATORY_FLAGS

struct pseudo_ta_head {
	TEE_UUID uuid;
	const char *name;
	uint32_t flags;

	TEE_Result (*create_entry_point)(void);
	void (*destroy_entry_point)(void);
	TEE_Result (*open_session_entry_point)(uint32_t nParamTypes,
			TEE_Param pParams[TEE_NUM_PARAMS],
			void **ppSessionContext);
	void (*close_session_entry_point)(void *pSessionContext);
	TEE_Result (*invoke_command_entry_point)(void *pSessionContext,
			uint32_t nCommandID, uint32_t nParamTypes,
			TEE_Param pParams[TEE_NUM_PARAMS]);
};

#define pseudo_ta_register(...)	\
	SCATTERED_ARRAY_DEFINE_PG_ITEM(pseudo_tas, struct pseudo_ta_head) = \
		{ __VA_ARGS__ }

struct pseudo_ta_ctx {
	const struct pseudo_ta_head *pseudo_ta;
	struct tee_ta_ctx ctx;
};

bool is_pseudo_ta_ctx(struct ts_ctx *ctx);

static inline struct pseudo_ta_ctx *to_pseudo_ta_ctx(struct ts_ctx *ctx)
{
	assert(is_pseudo_ta_ctx(ctx));
	return container_of(ctx, struct pseudo_ta_ctx, ctx.ts_ctx);
}

/*
 * Setup session context for a pseudo TA
 * @uuid: Pseudo TA UUID
 * @s: Session for which to setup a pseudo TA context
 *
 * This function must be called with tee_ta_mutex locked.
 */
TEE_Result tee_ta_init_pseudo_ta_session(const TEE_UUID *uuid,
			struct tee_ta_session *s);

/*
 * Helper functions for PTAs to support calls from a TA when CFG_PAN=y
 */

static inline bool is_caller_ta_with_pan(void)
{
	struct ts_session *s = NULL;

	if (!IS_ENABLED(CFG_PAN))
		return false;
	s = ts_get_calling_session();
	return s && is_user_ta_ctx(s->ctx);
}

/*
 * If caller is a TA and PAN is enabled, allocate bounce buffers for each
 * memref in @params and build @bparams, then make *@oparams point to @bparams.
 * Otherwise just make *@oparams point to @params.
 */
TEE_Result to_bounce_params(uint32_t param_types,
			    TEE_Param params[TEE_NUM_PARAMS],
			    TEE_Param bparams[TEE_NUM_PARAMS],
			    TEE_Param **oparams);

/*
 * If @eparams == @bparams, copy data from @bparams to @params. Otherwise, do
 * nothing.
 */
TEE_Result from_bounce_params(uint32_t param_types,
			      TEE_Param params[TEE_NUM_PARAMS],
			      TEE_Param bparams[TEE_NUM_PARAMS],
			      TEE_Param *eparams);

#endif /* __KERNEL_PSEUDO_TA_H */